From 02d38f9136c6353d2a7e2f70c87a26cb6b7d5609 Mon Sep 17 00:00:00 2001 From: Florian Bernd Date: Fri, 9 Aug 2024 14:32:05 +0200 Subject: [PATCH] Improve generated XmlDoc --- .../AsyncSearch/AsyncSearchStatusRequest.g.cs | 18 +- .../AsyncSearchStatusResponse.g.cs | 34 +- .../AsyncSearch/DeleteAsyncSearchRequest.g.cs | 21 +- .../DeleteAsyncSearchResponse.g.cs | 4 +- .../AsyncSearch/GetAsyncSearchRequest.g.cs | 51 +- .../AsyncSearch/GetAsyncSearchResponse.g.cs | 19 +- .../AsyncSearch/SubmitAsyncSearchRequest.g.cs | 595 +- .../SubmitAsyncSearchResponse.g.cs | 19 +- .../_Generated/Api/BulkRequest.g.cs | 98 +- .../_Generated/Api/ClearScrollRequest.g.cs | 18 +- .../Api/ClosePointInTimeRequest.g.cs | 16 +- .../Api/Cluster/AllocationExplainRequest.g.cs | 56 +- .../Api/Cluster/ClusterInfoRequest.g.cs | 10 +- .../Api/Cluster/ClusterStatsRequest.g.cs | 30 +- .../Api/Cluster/ClusterStatsResponse.g.cs | 28 +- .../DeleteComponentTemplateRequest.g.cs | 32 +- .../DeleteComponentTemplateResponse.g.cs | 4 +- .../ExistsComponentTemplateRequest.g.cs | 32 +- .../Cluster/GetClusterSettingsRequest.g.cs | 46 +- .../Cluster/GetComponentTemplateRequest.g.cs | 46 +- .../_Generated/Api/Cluster/HealthRequest.g.cs | 103 +- .../Api/Cluster/HealthResponse.g.cs | 60 +- .../Api/Cluster/PendingTasksRequest.g.cs | 34 +- .../Cluster/PutComponentTemplateRequest.g.cs | 165 +- .../Cluster/PutComponentTemplateResponse.g.cs | 4 +- .../_Generated/Api/CountRequest.g.cs | 156 +- .../_Generated/Api/CreateRequest.g.cs | 78 +- .../_Generated/Api/DeleteByQueryRequest.g.cs | 305 +- .../Api/DeleteByQueryRethrottleRequest.g.cs | 16 +- .../Api/DeleteByQueryRethrottleResponse.g.cs | 9 +- .../_Generated/Api/DeleteRequest.g.cs | 85 +- .../_Generated/Api/DeleteScriptRequest.g.cs | 35 +- .../_Generated/Api/DeleteScriptResponse.g.cs | 4 +- .../Api/Enrich/DeletePolicyRequest.g.cs | 10 +- .../Api/Enrich/DeletePolicyResponse.g.cs | 4 +- .../Api/Enrich/EnrichStatsRequest.g.cs | 10 +- .../Api/Enrich/EnrichStatsResponse.g.cs | 12 +- .../Api/Enrich/ExecutePolicyRequest.g.cs | 16 +- .../Api/Enrich/GetPolicyRequest.g.cs | 10 +- .../Api/Enrich/PutPolicyRequest.g.cs | 51 +- .../Api/Enrich/PutPolicyResponse.g.cs | 4 +- .../_Generated/Api/Eql/EqlDeleteRequest.g.cs | 15 +- .../_Generated/Api/Eql/EqlDeleteResponse.g.cs | 4 +- .../_Generated/Api/Eql/EqlGetRequest.g.cs | 32 +- .../_Generated/Api/Eql/EqlGetResponse.g.cs | 24 +- .../_Generated/Api/Eql/EqlSearchRequest.g.cs | 164 +- .../_Generated/Api/Eql/EqlSearchResponse.g.cs | 24 +- .../Api/Eql/GetEqlStatusRequest.g.cs | 12 +- .../Api/Eql/GetEqlStatusResponse.g.cs | 24 +- .../_Generated/Api/Esql/EsqlQueryRequest.g.cs | 107 +- .../_Generated/Api/ExistsRequest.g.cs | 103 +- .../_Generated/Api/ExistsSourceRequest.g.cs | 91 +- .../_Generated/Api/ExplainRequest.g.cs | 127 +- .../_Generated/Api/FieldCapsRequest.g.cs | 117 +- .../_Generated/Api/GetRequest.g.cs | 99 +- .../_Generated/Api/GetScriptRequest.g.cs | 23 +- .../_Generated/Api/GetSourceRequest.g.cs | 87 +- .../_Generated/Api/Graph/ExploreRequest.g.cs | 80 +- .../_Generated/Api/HealthReportRequest.g.cs | 32 +- .../IndexManagement/AnalyzeIndexRequest.g.cs | 156 +- .../IndexManagement/ClearCacheRequest.g.cs | 81 +- .../IndexManagement/CloseIndexRequest.g.cs | 74 +- .../CreateDataStreamRequest.g.cs | 44 +- .../CreateDataStreamResponse.g.cs | 4 +- .../IndexManagement/CreateIndexRequest.g.cs | 132 +- .../DataStreamsStatsRequest.g.cs | 20 +- .../DataStreamsStatsResponse.g.cs | 25 +- .../IndexManagement/DeleteAliasRequest.g.cs | 35 +- .../IndexManagement/DeleteAliasResponse.g.cs | 4 +- .../DeleteDataLifecycleRequest.g.cs | 34 +- .../DeleteDataLifecycleResponse.g.cs | 4 +- .../DeleteDataStreamRequest.g.cs | 34 +- .../DeleteDataStreamResponse.g.cs | 4 +- .../IndexManagement/DeleteIndexRequest.g.cs | 67 +- .../IndexManagement/DeleteIndexResponse.g.cs | 4 +- .../DeleteIndexTemplateRequest.g.cs | 30 +- .../DeleteIndexTemplateResponse.g.cs | 4 +- .../IndexManagement/ExistsAliasRequest.g.cs | 55 +- .../ExistsIndexTemplateRequest.g.cs | 16 +- .../Api/IndexManagement/ExistsRequest.g.cs | 71 +- .../ExplainDataLifecycleRequest.g.cs | 31 +- .../Api/IndexManagement/FlushRequest.g.cs | 62 +- .../IndexManagement/ForcemergeRequest.g.cs | 68 +- .../IndexManagement/ForcemergeResponse.g.cs | 5 +- .../Api/IndexManagement/GetAliasRequest.g.cs | 55 +- .../GetDataLifecycleRequest.g.cs | 46 +- .../IndexManagement/GetDataStreamRequest.g.cs | 44 +- .../Api/IndexManagement/GetIndexRequest.g.cs | 90 +- .../GetIndexTemplateRequest.g.cs | 42 +- .../GetIndicesSettingsRequest.g.cs | 92 +- .../IndexManagement/GetMappingRequest.g.cs | 68 +- .../IndexManagement/IndicesStatsRequest.g.cs | 91 +- .../MigrateToDataStreamRequest.g.cs | 60 +- .../MigrateToDataStreamResponse.g.cs | 4 +- .../ModifyDataStreamRequest.g.cs | 18 +- .../ModifyDataStreamResponse.g.cs | 4 +- .../Api/IndexManagement/OpenIndexRequest.g.cs | 77 +- .../Api/IndexManagement/PutAliasRequest.g.cs | 119 +- .../Api/IndexManagement/PutAliasResponse.g.cs | 4 +- .../PutDataLifecycleRequest.g.cs | 66 +- .../PutDataLifecycleResponse.g.cs | 4 +- .../PutIndexTemplateRequest.g.cs | 203 +- .../PutIndexTemplateResponse.g.cs | 4 +- .../PutIndicesSettingsRequest.g.cs | 94 +- .../PutIndicesSettingsResponse.g.cs | 4 +- .../IndexManagement/PutMappingRequest.g.cs | 279 +- .../IndexManagement/PutMappingResponse.g.cs | 4 +- .../IndexManagement/PutTemplateRequest.g.cs | 129 +- .../IndexManagement/PutTemplateResponse.g.cs | 4 +- .../Api/IndexManagement/RecoveryRequest.g.cs | 31 +- .../Api/IndexManagement/RefreshRequest.g.cs | 50 +- .../IndexManagement/ResolveIndexRequest.g.cs | 24 +- .../Api/IndexManagement/RolloverRequest.g.cs | 122 +- .../Api/IndexManagement/SegmentsRequest.g.cs | 55 +- .../SimulateIndexTemplateRequest.g.cs | 26 +- .../SimulateTemplateRequest.g.cs | 201 +- .../IndexManagement/UpdateAliasesRequest.g.cs | 47 +- .../UpdateAliasesResponse.g.cs | 4 +- .../IndexManagement/ValidateQueryRequest.g.cs | 135 +- .../_Generated/Api/IndexRequest.g.cs | 120 +- .../_Generated/Api/InfoRequest.g.cs | 10 +- .../Api/Ingest/DeletePipelineRequest.g.cs | 32 +- .../Api/Ingest/DeletePipelineResponse.g.cs | 4 +- .../Api/Ingest/GeoIpStatsRequest.g.cs | 8 +- .../Api/Ingest/GeoIpStatsResponse.g.cs | 8 +- .../Api/Ingest/GetPipelineRequest.g.cs | 33 +- .../Api/Ingest/ProcessorGrokRequest.g.cs | 12 +- .../Api/Ingest/PutPipelineRequest.g.cs | 99 +- .../Api/Ingest/PutPipelineResponse.g.cs | 4 +- .../Api/Ingest/SimulateRequest.g.cs | 50 +- .../LicenseManagement/GetLicenseRequest.g.cs | 20 +- ...earTrainedModelDeploymentCacheRequest.g.cs | 16 +- .../Api/MachineLearning/CloseJobRequest.g.cs | 40 +- .../DeleteCalendarEventRequest.g.cs | 8 +- .../DeleteCalendarEventResponse.g.cs | 4 +- .../DeleteCalendarJobRequest.g.cs | 8 +- .../DeleteCalendarJobResponse.g.cs | 12 +- .../DeleteCalendarRequest.g.cs | 10 +- .../DeleteCalendarResponse.g.cs | 4 +- .../DeleteDataFrameAnalyticsRequest.g.cs | 28 +- .../DeleteDataFrameAnalyticsResponse.g.cs | 4 +- .../DeleteDatafeedRequest.g.cs | 18 +- .../DeleteDatafeedResponse.g.cs | 4 +- .../DeleteExpiredDataRequest.g.cs | 42 +- .../MachineLearning/DeleteFilterRequest.g.cs | 12 +- .../MachineLearning/DeleteFilterResponse.g.cs | 4 +- .../DeleteForecastRequest.g.cs | 42 +- .../DeleteForecastResponse.g.cs | 4 +- .../Api/MachineLearning/DeleteJobRequest.g.cs | 52 +- .../MachineLearning/DeleteJobResponse.g.cs | 4 +- .../DeleteModelSnapshotRequest.g.cs | 14 +- .../DeleteModelSnapshotResponse.g.cs | 4 +- .../DeleteTrainedModelAliasRequest.g.cs | 14 +- .../DeleteTrainedModelAliasResponse.g.cs | 4 +- .../DeleteTrainedModelRequest.g.cs | 18 +- .../DeleteTrainedModelResponse.g.cs | 4 +- .../EstimateModelMemoryRequest.g.cs | 90 +- .../EvaluateDataFrameRequest.g.cs | 60 +- .../ExplainDataFrameAnalyticsRequest.g.cs | 204 +- .../ExplainDataFrameAnalyticsResponse.g.cs | 8 +- .../Api/MachineLearning/FlushJobRequest.g.cs | 64 +- .../Api/MachineLearning/FlushJobResponse.g.cs | 5 +- .../Api/MachineLearning/ForecastRequest.g.cs | 46 +- .../MachineLearning/GetBucketsRequest.g.cs | 131 +- .../GetCalendarEventsRequest.g.cs | 48 +- .../MachineLearning/GetCalendarsRequest.g.cs | 32 +- .../MachineLearning/GetCategoriesRequest.g.cs | 42 +- .../GetDataFrameAnalyticsRequest.g.cs | 109 +- .../GetDataFrameAnalyticsResponse.g.cs | 4 +- .../GetDataFrameAnalyticsStatsRequest.g.cs | 96 +- .../GetDataFrameAnalyticsStatsResponse.g.cs | 4 +- .../GetDatafeedStatsRequest.g.cs | 78 +- .../MachineLearning/GetDatafeedsRequest.g.cs | 88 +- .../MachineLearning/GetFiltersRequest.g.cs | 26 +- .../GetInfluencersRequest.g.cs | 112 +- .../GetInfluencersResponse.g.cs | 4 +- .../MachineLearning/GetJobStatsRequest.g.cs | 66 +- .../Api/MachineLearning/GetJobsRequest.g.cs | 86 +- .../GetMemoryStatsRequest.g.cs | 30 +- .../GetModelSnapshotUpgradeStatsRequest.g.cs | 64 +- .../GetModelSnapshotsRequest.g.cs | 92 +- .../GetOverallBucketsRequest.g.cs | 100 +- .../GetOverallBucketsResponse.g.cs | 4 +- .../MachineLearning/GetRecordsRequest.g.cs | 146 +- .../GetTrainedModelsRequest.g.cs | 122 +- .../GetTrainedModelsResponse.g.cs | 4 +- .../GetTrainedModelsStatsRequest.g.cs | 80 +- .../GetTrainedModelsStatsResponse.g.cs | 8 +- .../InferTrainedModelRequest.g.cs | 50 +- .../Api/MachineLearning/MlInfoRequest.g.cs | 20 +- .../Api/MachineLearning/OpenJobRequest.g.cs | 30 +- .../Api/MachineLearning/OpenJobResponse.g.cs | 5 +- .../PostCalendarEventsRequest.g.cs | 16 +- .../PreviewDataFrameAnalyticsRequest.g.cs | 30 +- .../PreviewDataFrameAnalyticsResponse.g.cs | 4 +- .../PutCalendarJobRequest.g.cs | 8 +- .../PutCalendarJobResponse.g.cs | 12 +- .../MachineLearning/PutCalendarRequest.g.cs | 24 +- .../MachineLearning/PutCalendarResponse.g.cs | 12 +- .../PutDataFrameAnalyticsRequest.g.cs | 243 +- .../MachineLearning/PutDatafeedRequest.g.cs | 277 +- .../Api/MachineLearning/PutFilterRequest.g.cs | 30 +- .../Api/MachineLearning/PutJobRequest.g.cs | 195 +- .../PutTrainedModelAliasRequest.g.cs | 50 +- .../PutTrainedModelAliasResponse.g.cs | 4 +- .../PutTrainedModelDefinitionPartRequest.g.cs | 32 +- ...PutTrainedModelDefinitionPartResponse.g.cs | 4 +- .../PutTrainedModelRequest.g.cs | 208 +- .../PutTrainedModelResponse.g.cs | 60 +- .../PutTrainedModelVocabularyRequest.g.cs | 36 +- .../PutTrainedModelVocabularyResponse.g.cs | 4 +- .../Api/MachineLearning/ResetJobRequest.g.cs | 38 +- .../Api/MachineLearning/ResetJobResponse.g.cs | 4 +- .../RevertModelSnapshotRequest.g.cs | 30 +- .../SetUpgradeModeRequest.g.cs | 50 +- .../SetUpgradeModeResponse.g.cs | 4 +- .../StartDataFrameAnalyticsRequest.g.cs | 55 +- .../StartDataFrameAnalyticsResponse.g.cs | 8 +- .../MachineLearning/StartDatafeedRequest.g.cs | 72 +- .../StartDatafeedResponse.g.cs | 9 +- .../StartTrainedModelDeploymentRequest.g.cs | 88 +- .../StopDataFrameAnalyticsRequest.g.cs | 96 +- .../MachineLearning/StopDatafeedRequest.g.cs | 36 +- .../StopTrainedModelDeploymentRequest.g.cs | 32 +- .../UpdateDataFrameAnalyticsRequest.g.cs | 84 +- .../UpdateDatafeedRequest.g.cs | 330 +- .../MachineLearning/UpdateFilterRequest.g.cs | 32 +- .../Api/MachineLearning/UpdateJobRequest.g.cs | 246 +- .../UpdateModelSnapshotRequest.g.cs | 28 +- .../UpgradeJobSnapshotRequest.g.cs | 42 +- .../UpgradeJobSnapshotResponse.g.cs | 8 +- .../ValidateDetectorRequest.g.cs | 12 +- .../ValidateDetectorResponse.g.cs | 4 +- .../Api/MachineLearning/ValidateRequest.g.cs | 12 +- .../Api/MachineLearning/ValidateResponse.g.cs | 4 +- .../_Generated/Api/MultiGetRequest.g.cs | 106 +- .../_Generated/Api/MultiSearchRequest.g.cs | 108 +- .../Api/MultiSearchTemplateRequest.g.cs | 56 +- .../Api/MultiTermVectorsRequest.g.cs | 128 +- .../Api/Nodes/HotThreadsRequest.g.cs | 82 +- .../Api/Nodes/NodesInfoRequest.g.cs | 32 +- .../Api/Nodes/NodesInfoResponse.g.cs | 4 +- .../Api/Nodes/NodesStatsRequest.g.cs | 92 +- .../Api/Nodes/NodesStatsResponse.g.cs | 4 +- .../Api/Nodes/NodesUsageRequest.g.cs | 18 +- .../Api/Nodes/NodesUsageResponse.g.cs | 4 +- .../Api/OpenPointInTimeRequest.g.cs | 73 +- .../_Generated/Api/PingRequest.g.cs | 10 +- .../_Generated/Api/PutScriptRequest.g.cs | 47 +- .../_Generated/Api/PutScriptResponse.g.cs | 4 +- .../Api/QueryRules/DeleteRuleRequest.g.cs | 8 +- .../Api/QueryRules/DeleteRuleResponse.g.cs | 4 +- .../Api/QueryRules/DeleteRulesetRequest.g.cs | 8 +- .../Api/QueryRules/DeleteRulesetResponse.g.cs | 4 +- .../Api/QueryRules/GetRuleRequest.g.cs | 8 +- .../Api/QueryRules/GetRulesetRequest.g.cs | 8 +- .../Api/QueryRules/GetRulesetResponse.g.cs | 8 +- .../Api/QueryRules/ListRulesetsRequest.g.cs | 24 +- .../Api/QueryRules/PutRuleRequest.g.cs | 8 +- .../Api/QueryRules/PutRulesetRequest.g.cs | 8 +- .../_Generated/Api/RankEvalRequest.g.cs | 68 +- .../_Generated/Api/RankEvalResponse.g.cs | 8 +- .../_Generated/Api/ReindexRequest.g.cs | 145 +- .../Api/ReindexRethrottleRequest.g.cs | 16 +- .../Api/RenderSearchTemplateRequest.g.cs | 51 +- .../_Generated/Api/ScrollRequest.g.cs | 32 +- .../_Generated/Api/SearchMvtRequest.g.cs | 333 +- .../_Generated/Api/SearchRequest.g.cs | 820 ++- .../_Generated/Api/SearchTemplateRequest.g.cs | 189 +- .../Snapshot/CleanupRepositoryRequest.g.cs | 24 +- .../Snapshot/CleanupRepositoryResponse.g.cs | 4 +- .../Api/Snapshot/CloneSnapshotRequest.g.cs | 16 +- .../Api/Snapshot/CloneSnapshotResponse.g.cs | 4 +- .../Api/Snapshot/CreateRepositoryRequest.g.cs | 32 +- .../Snapshot/CreateRepositoryResponse.g.cs | 4 +- .../Api/Snapshot/CreateSnapshotRequest.g.cs | 72 +- .../Api/Snapshot/CreateSnapshotResponse.g.cs | 8 +- .../Api/Snapshot/DeleteRepositoryRequest.g.cs | 24 +- .../Snapshot/DeleteRepositoryResponse.g.cs | 4 +- .../Api/Snapshot/DeleteSnapshotRequest.g.cs | 16 +- .../Api/Snapshot/DeleteSnapshotResponse.g.cs | 4 +- .../Api/Snapshot/GetRepositoryRequest.g.cs | 24 +- .../Api/Snapshot/GetSnapshotRequest.g.cs | 112 +- .../Api/Snapshot/GetSnapshotResponse.g.cs | 8 +- .../Api/Snapshot/RestoreRequest.g.cs | 28 +- .../Api/Snapshot/SnapshotStatusRequest.g.cs | 24 +- .../Api/Snapshot/VerifyRepositoryRequest.g.cs | 24 +- .../DeleteLifecycleRequest.g.cs | 8 +- .../DeleteLifecycleResponse.g.cs | 4 +- .../ExecuteLifecycleRequest.g.cs | 8 +- .../ExecuteRetentionRequest.g.cs | 8 +- .../ExecuteRetentionResponse.g.cs | 4 +- .../GetLifecycleRequest.g.cs | 8 +- .../GetSlmStatusRequest.g.cs | 8 +- .../GetStatsRequest.g.cs | 8 +- .../PutLifecycleRequest.g.cs | 64 +- .../PutLifecycleResponse.g.cs | 4 +- .../StartSlmRequest.g.cs | 8 +- .../StartSlmResponse.g.cs | 4 +- .../StopSlmRequest.g.cs | 8 +- .../StopSlmResponse.g.cs | 4 +- .../Api/Sql/ClearCursorRequest.g.cs | 16 +- .../Api/Sql/DeleteAsyncRequest.g.cs | 12 +- .../Api/Sql/DeleteAsyncResponse.g.cs | 4 +- .../_Generated/Api/Sql/GetAsyncRequest.g.cs | 50 +- .../_Generated/Api/Sql/GetAsyncResponse.g.cs | 30 +- .../Api/Sql/GetAsyncStatusRequest.g.cs | 12 +- .../Api/Sql/GetAsyncStatusResponse.g.cs | 29 +- .../_Generated/Api/Sql/QueryRequest.g.cs | 221 +- .../_Generated/Api/Sql/QueryResponse.g.cs | 30 +- .../_Generated/Api/Sql/TranslateRequest.g.cs | 60 +- .../Api/Synonyms/DeleteSynonymRequest.g.cs | 12 +- .../Api/Synonyms/DeleteSynonymResponse.g.cs | 4 +- .../Synonyms/DeleteSynonymRuleRequest.g.cs | 8 +- .../Synonyms/DeleteSynonymRuleResponse.g.cs | 9 +- .../Api/Synonyms/GetSynonymRequest.g.cs | 28 +- .../Api/Synonyms/GetSynonymRuleRequest.g.cs | 8 +- .../Api/Synonyms/GetSynonymRuleResponse.g.cs | 8 +- .../Api/Synonyms/GetSynonymsSetsRequest.g.cs | 24 +- .../Api/Synonyms/PutSynonymRequest.g.cs | 24 +- .../Api/Synonyms/PutSynonymRuleRequest.g.cs | 8 +- .../Api/Synonyms/PutSynonymRuleResponse.g.cs | 9 +- .../_Generated/Api/TermVectorsRequest.g.cs | 126 +- .../_Generated/Api/TermsEnumRequest.g.cs | 100 +- .../TextStructure/TestGrokPatternRequest.g.cs | 32 +- .../DeleteTransformRequest.g.cs | 38 +- .../DeleteTransformResponse.g.cs | 4 +- .../GetTransformRequest.g.cs | 92 +- .../GetTransformStatsRequest.g.cs | 88 +- .../PreviewTransformRequest.g.cs | 172 +- .../PutTransformRequest.g.cs | 255 +- .../PutTransformResponse.g.cs | 4 +- .../ResetTransformRequest.g.cs | 24 +- .../ResetTransformResponse.g.cs | 4 +- .../ScheduleNowTransformRequest.g.cs | 32 +- .../ScheduleNowTransformResponse.g.cs | 4 +- .../StartTransformRequest.g.cs | 64 +- .../StartTransformResponse.g.cs | 4 +- .../StopTransformRequest.g.cs | 80 +- .../StopTransformResponse.g.cs | 4 +- .../UpdateTransformRequest.g.cs | 169 +- .../UpgradeTransformsRequest.g.cs | 36 +- .../UpgradeTransformsResponse.g.cs | 12 +- .../_Generated/Api/UpdateByQueryRequest.g.cs | 332 +- .../Api/UpdateByQueryRethrottleRequest.g.cs | 16 +- .../_Generated/Api/UpdateRequest.g.cs | 172 +- .../Api/Xpack/XpackInfoRequest.g.cs | 24 +- .../Api/Xpack/XpackUsageRequest.g.cs | 16 +- .../ElasticsearchClient.AsyncSearch.g.cs | 163 +- .../Client/ElasticsearchClient.Cluster.g.cs | 436 +- .../Client/ElasticsearchClient.Enrich.g.cs | 125 +- .../Client/ElasticsearchClient.Eql.g.cs | 107 +- .../Client/ElasticsearchClient.Esql.g.cs | 32 +- .../Client/ElasticsearchClient.Graph.g.cs | 40 +- .../Client/ElasticsearchClient.Indices.g.cs | 1822 +++++- .../Client/ElasticsearchClient.Ingest.g.cs | 206 +- .../Client/ElasticsearchClient.License.g.cs | 28 +- .../Client/ElasticsearchClient.Ml.g.cs | 2864 ++++++-- .../Client/ElasticsearchClient.Nodes.g.cs | 126 +- .../ElasticsearchClient.QueryRules.g.cs | 116 +- .../Client/ElasticsearchClient.Slm.g.cs | 156 +- .../Client/ElasticsearchClient.Snapshot.g.cs | 208 +- .../Client/ElasticsearchClient.Sql.g.cs | 160 +- .../Client/ElasticsearchClient.Synonyms.g.cs | 152 +- .../ElasticsearchClient.TextStructure.g.cs | 20 +- .../Client/ElasticsearchClient.Transform.g.cs | 690 +- .../Client/ElasticsearchClient.Xpack.g.cs | 36 +- .../Client/ElasticsearchClient.g.cs | 1664 ++++- .../AdjacencyMatrixAggregation.g.cs | 27 +- .../Aggregations/AdjacencyMatrixBucket.g.cs | 4 +- .../Types/Aggregations/Aggregation.g.cs | 15 +- .../Types/Aggregations/AggregationRange.g.cs | 24 +- .../AutoDateHistogramAggregation.g.cs | 109 +- .../Types/Aggregations/AverageAggregate.g.cs | 5 +- .../Aggregations/AverageAggregation.g.cs | 43 +- .../AverageBucketAggregation.g.cs | 26 +- .../Aggregations/BoxplotAggregation.g.cs | 55 +- .../BucketMetricValueAggregate.g.cs | 5 +- .../Aggregations/BucketScriptAggregation.g.cs | 34 +- .../BucketSelectorAggregation.g.cs | 34 +- .../Aggregations/BucketSortAggregation.g.cs | 51 +- .../Types/Aggregations/Buckets.g.cs | 5 +- .../Aggregations/CardinalityAggregation.g.cs | 70 +- .../Aggregations/ChiSquareHeuristic.g.cs | 16 +- .../Types/Aggregations/ChildrenAggregate.g.cs | 4 +- .../Aggregations/ChildrenAggregation.g.cs | 8 +- .../Aggregations/CompositeAggregation.g.cs | 39 +- .../CompositeAggregationSource.g.cs | 48 +- .../Types/Aggregations/CompositeBucket.g.cs | 4 +- .../CompositeDateHistogramAggregation.g.cs | 64 +- .../CompositeGeoTileGridAggregation.g.cs | 40 +- .../CompositeHistogramAggregation.g.cs | 40 +- .../CompositeTermsAggregation.g.cs | 40 +- .../CumulativeCardinalityAggregate.g.cs | 4 +- .../CumulativeCardinalityAggregation.g.cs | 26 +- .../CumulativeSumAggregation.g.cs | 26 +- .../DateHistogramAggregation.g.cs | 163 +- .../Aggregations/DateHistogramBucket.g.cs | 4 +- .../Aggregations/DateRangeAggregate.g.cs | 5 +- .../Aggregations/DateRangeAggregation.g.cs | 79 +- .../Aggregations/DateRangeExpression.g.cs | 24 +- .../Aggregations/DerivativeAggregate.g.cs | 5 +- .../Aggregations/DerivativeAggregation.g.cs | 26 +- .../DiversifiedSamplerAggregation.g.cs | 64 +- .../Aggregations/DoubleTermsAggregate.g.cs | 4 +- .../Types/Aggregations/DoubleTermsBucket.g.cs | 4 +- .../Aggregations/ExtendedBoundsDate.g.cs | 16 +- .../Aggregations/ExtendedBoundsFloat.g.cs | 16 +- .../ExtendedStatsAggregation.g.cs | 55 +- .../ExtendedStatsBucketAggregation.g.cs | 34 +- .../Types/Aggregations/FieldDateMath.g.cs | 5 +- .../Types/Aggregations/FilterAggregate.g.cs | 4 +- .../Aggregations/FiltersAggregation.g.cs | 36 +- .../Types/Aggregations/FiltersBucket.g.cs | 4 +- .../FrequentItemSetsAggregation.g.cs | 60 +- .../Aggregations/FrequentItemSetsBucket.g.cs | 4 +- .../Aggregations/FrequentItemSetsField.g.cs | 30 +- .../Aggregations/GeoBoundsAggregation.g.cs | 55 +- .../Aggregations/GeoCentroidAggregation.g.cs | 43 +- .../Aggregations/GeoDistanceAggregate.g.cs | 4 +- .../Aggregations/GeoDistanceAggregation.g.cs | 76 +- .../Aggregations/GeoLineAggregation.g.cs | 66 +- .../Types/Aggregations/GeoLinePoint.g.cs | 28 +- .../Types/Aggregations/GeoLineSort.g.cs | 28 +- .../Aggregations/GeohashGridAggregation.g.cs | 86 +- .../Types/Aggregations/GeohashGridBucket.g.cs | 4 +- .../Aggregations/GeohexGridAggregation.g.cs | 86 +- .../Types/Aggregations/GeohexGridBucket.g.cs | 4 +- .../Aggregations/GeotileGridAggregation.g.cs | 89 +- .../Types/Aggregations/GeotileGridBucket.g.cs | 4 +- .../Types/Aggregations/GlobalAggregate.g.cs | 4 +- .../GoogleNormalizedDistanceHeuristic.g.cs | 8 +- .../Types/Aggregations/HdrMethod.g.cs | 8 +- .../Aggregations/HistogramAggregation.g.cs | 130 +- .../Types/Aggregations/HistogramBucket.g.cs | 4 +- .../Aggregations/InferenceAggregate.g.cs | 4 +- .../Aggregations/InferenceAggregation.g.cs | 63 +- .../Aggregations/IpPrefixAggregation.g.cs | 79 +- .../Types/Aggregations/IpPrefixBucket.g.cs | 4 +- .../Aggregations/IpRangeAggregation.g.cs | 40 +- .../Aggregations/IpRangeAggregationRange.g.cs | 24 +- .../Types/Aggregations/IpRangeBucket.g.cs | 4 +- .../Aggregations/LongRareTermsAggregate.g.cs | 4 +- .../Aggregations/LongRareTermsBucket.g.cs | 4 +- .../Aggregations/LongTermsAggregate.g.cs | 4 +- .../Types/Aggregations/LongTermsBucket.g.cs | 4 +- .../Aggregations/MatrixStatsAggregation.g.cs | 39 +- .../Types/Aggregations/MaxAggregate.g.cs | 5 +- .../Types/Aggregations/MaxAggregation.g.cs | 43 +- .../Aggregations/MaxBucketAggregation.g.cs | 26 +- .../MedianAbsoluteDeviationAggregate.g.cs | 5 +- .../MedianAbsoluteDeviationAggregation.g.cs | 55 +- .../Types/Aggregations/MinAggregate.g.cs | 5 +- .../Types/Aggregations/MinAggregation.g.cs | 43 +- .../Aggregations/MinBucketAggregation.g.cs | 26 +- .../Types/Aggregations/MissingAggregate.g.cs | 4 +- .../Aggregations/MissingAggregation.g.cs | 28 +- .../MovingFunctionAggregation.g.cs | 52 +- .../MovingPercentilesAggregation.g.cs | 44 +- .../Types/Aggregations/MultiTermLookup.g.cs | 43 +- .../Aggregations/MultiTermsAggregation.g.cs | 102 +- .../Types/Aggregations/MultiTermsBucket.g.cs | 4 +- .../MutualInformationHeuristic.g.cs | 16 +- .../Types/Aggregations/NestedAggregate.g.cs | 4 +- .../Types/Aggregations/NestedAggregation.g.cs | 28 +- .../Aggregations/NormalizeAggregation.g.cs | 34 +- .../Types/Aggregations/ParentAggregate.g.cs | 4 +- .../Types/Aggregations/ParentAggregation.g.cs | 8 +- .../PercentileRanksAggregation.g.cs | 79 +- .../Aggregations/PercentilesAggregation.g.cs | 79 +- .../PercentilesBucketAggregation.g.cs | 34 +- .../Types/Aggregations/RangeAggregation.g.cs | 55 +- .../Types/Aggregations/RangeBucket.g.cs | 8 +- .../Aggregations/RareTermsAggregation.g.cs | 94 +- .../Types/Aggregations/RateAggregation.g.cs | 70 +- .../Aggregations/ReverseNestedAggregate.g.cs | 4 +- .../ReverseNestedAggregation.g.cs | 35 +- .../Types/Aggregations/SamplerAggregate.g.cs | 4 +- .../Aggregations/SamplerAggregation.g.cs | 8 +- .../ScriptedMetricAggregation.g.cs | 118 +- .../SerialDifferencingAggregation.g.cs | 36 +- .../SignificantLongTermsBucket.g.cs | 4 +- .../SignificantStringTermsBucket.g.cs | 4 +- .../SignificantTermsAggregation.g.cs | 202 +- .../SignificantTextAggregation.g.cs | 226 +- .../Aggregations/SimpleValueAggregate.g.cs | 5 +- .../Types/Aggregations/StatsAggregate.g.cs | 5 +- .../Types/Aggregations/StatsAggregation.g.cs | 43 +- .../Aggregations/StatsBucketAggregation.g.cs | 26 +- .../StringRareTermsAggregate.g.cs | 4 +- .../Aggregations/StringRareTermsBucket.g.cs | 4 +- .../Aggregations/StringStatsAggregation.g.cs | 55 +- .../Aggregations/StringTermsAggregate.g.cs | 4 +- .../Types/Aggregations/StringTermsBucket.g.cs | 4 +- .../Types/Aggregations/SumAggregate.g.cs | 9 +- .../Types/Aggregations/SumAggregation.g.cs | 43 +- .../Aggregations/SumBucketAggregation.g.cs | 26 +- .../Types/Aggregations/TDigest.g.cs | 8 +- .../Types/Aggregations/TTestAggregation.g.cs | 36 +- .../Types/Aggregations/TermsAggregation.g.cs | 190 +- .../Types/Aggregations/TestPopulation.g.cs | 40 +- .../Aggregations/TopHitsAggregation.g.cs | 205 +- .../Aggregations/TopMetricsAggregation.g.cs | 79 +- .../Types/Aggregations/TopMetricsValue.g.cs | 28 +- .../UnmappedRareTermsAggregate.g.cs | 4 +- .../UnmappedSamplerAggregate.g.cs | 4 +- .../UnmappedSignificantTermsAggregate.g.cs | 4 +- .../Aggregations/UnmappedTermsAggregate.g.cs | 4 +- .../Aggregations/ValueCountAggregate.g.cs | 9 +- .../Aggregations/ValueCountAggregation.g.cs | 43 +- .../VariableWidthHistogramAggregation.g.cs | 70 +- .../VariableWidthHistogramBucket.g.cs | 4 +- .../WeightedAverageAggregate.g.cs | 9 +- .../WeightedAverageAggregation.g.cs | 36 +- .../Aggregations/WeightedAverageValue.g.cs | 40 +- .../Types/AsyncSearch/AsyncSearch.g.cs | 14 +- .../Types/Cluster/CharFilterTypes.g.cs | 32 +- .../Types/Cluster/ClusterFileSystem.g.cs | 14 +- .../Types/Cluster/ClusterIndices.g.cs | 44 +- .../Types/Cluster/ClusterIndicesShards.g.cs | 20 +- .../Cluster/ClusterIndicesShardsIndex.g.cs | 12 +- .../_Generated/Types/Cluster/ClusterJvm.g.cs | 16 +- .../Types/Cluster/ClusterJvmMemory.g.cs | 8 +- .../Types/Cluster/ClusterJvmVersion.g.cs | 29 +- .../Types/Cluster/ClusterNetworkTypes.g.cs | 8 +- .../Types/Cluster/ClusterNodes.g.cs | 41 +- .../Types/Cluster/ClusterOperatingSystem.g.cs | 26 +- .../ClusterOperatingSystemArchitecture.g.cs | 8 +- .../Cluster/ClusterOperatingSystemName.g.cs | 8 +- .../ClusterOperatingSystemPrettyName.g.cs | 8 +- .../Types/Cluster/ClusterProcess.g.cs | 8 +- .../Types/Cluster/ClusterProcessCpu.g.cs | 5 +- .../ClusterProcessOpenFileDescriptors.g.cs | 15 +- .../Types/Cluster/ClusterShardMetrics.g.cs | 12 +- .../_Generated/Types/Cluster/FieldTypes.g.cs | 28 +- .../Types/Cluster/FieldTypesMappings.g.cs | 24 +- .../Types/Cluster/NodePackagingType.g.cs | 12 +- .../Cluster/OperatingSystemMemoryInfo.g.cs | 24 +- .../_Generated/Types/Cluster/PendingTask.g.cs | 25 +- .../Types/Cluster/RuntimeFieldTypes.g.cs | 56 +- .../_Generated/Types/CompletionStats.g.cs | 8 +- .../Types/Core/Bulk/ResponseItem.g.cs | 41 +- .../_Generated/Types/Core/Context.g.cs | 4 +- .../Types/Core/FieldCaps/FieldCapability.g.cs | 28 +- .../Core/HealthReport/DiskIndicator.g.cs | 4 +- .../Types/Core/HealthReport/IlmIndicator.g.cs | 4 +- .../HealthReport/MasterIsStableIndicator.g.cs | 4 +- .../RepositoryIntegrityIndicator.g.cs | 4 +- .../ShardsAvailabilityIndicator.g.cs | 4 +- .../HealthReport/ShardsCapacityIndicator.g.cs | 4 +- .../Types/Core/HealthReport/SlmIndicator.g.cs | 4 +- .../Types/Core/MGet/MultiGetOperation.g.cs | 60 +- .../Types/Core/MSearch/MultisearchBody.g.cs | 333 +- .../Types/Core/MSearch/MultisearchHeader.g.cs | 8 +- .../Core/MSearchTemplate/TemplateConfig.g.cs | 25 +- .../MultiTermVectorsOperation.g.cs | 159 +- .../Types/Core/RankEval/DocumentRating.g.cs | 24 +- .../Core/RankEval/RankEvalMetricDetail.g.cs | 16 +- ...ankEvalMetricDiscountedCumulativeGain.g.cs | 24 +- .../RankEvalMetricExpectedReciprocalRank.g.cs | 24 +- .../RankEvalMetricMeanReciprocalRank.g.cs | 24 +- .../RankEval/RankEvalMetricPrecision.g.cs | 32 +- .../Core/RankEval/RankEvalMetricRecall.g.cs | 24 +- .../Core/RankEval/RankEvalRequestItem.g.cs | 60 +- .../Types/Core/Reindex/Destination.g.cs | 44 +- .../Types/Core/Reindex/RemoteSource.g.cs | 50 +- .../_Generated/Types/Core/Reindex/Source.g.cs | 81 +- .../Core/ReindexRethrottle/ReindexStatus.g.cs | 45 +- .../Types/Core/Search/CompletionContext.g.cs | 50 +- .../Core/Search/CompletionSuggester.g.cs | 110 +- .../Types/Core/Search/DirectGenerator.g.cs | 185 +- .../Types/Core/Search/FieldCollapse.g.cs | 52 +- .../Types/Core/Search/FieldSuggester.g.cs | 39 +- .../Types/Core/Search/Highlight.g.cs | 252 +- .../Types/Core/Search/HighlightField.g.cs | 252 +- .../Types/Core/Search/HitsMetadata.g.cs | 4 +- .../Types/Core/Search/InnerHits.g.cs | 54 +- .../Core/Search/LaplaceSmoothingModel.g.cs | 8 +- .../Types/Core/Search/LearningToRank.g.cs | 16 +- .../Core/Search/PhraseSuggestCollate.g.cs | 24 +- .../Search/PhraseSuggestCollateQuery.g.cs | 16 +- .../Core/Search/PhraseSuggestHighlight.g.cs | 16 +- .../Types/Core/Search/PhraseSuggester.g.cs | 215 +- .../Types/Core/Search/RegexOptions.g.cs | 16 +- .../Types/Core/Search/RescoreQuery.g.cs | 51 +- .../Search/StupidBackoffSmoothingModel.g.cs | 8 +- .../Types/Core/Search/SuggestFuzziness.g.cs | 42 +- .../Types/Core/Search/Suggester.g.cs | 24 +- .../Types/Core/Search/TermSuggester.g.cs | 221 +- .../_Generated/Types/Core/SourceConfig.g.cs | 4 +- .../Types/Core/SourceConfigParam.g.cs | 5 +- .../Types/Core/TermVectors/Filter.g.cs | 62 +- .../_Generated/Types/Core/TrackHits.g.cs | 7 +- .../_Generated/Types/DocStats.g.cs | 11 +- .../_Generated/Types/EmptyObject.g.cs | 8 +- .../Types/Enums/Enums.Aggregations.g.cs | 98 +- .../Types/Enums/Enums.Core.Search.g.cs | 87 +- .../_Generated/Types/Enums/Enums.Eql.g.cs | 8 +- .../Types/Enums/Enums.IndexManagement.g.cs | 34 +- .../_Generated/Types/Enums/Enums.Ingest.g.cs | 8 +- .../Types/Enums/Enums.MachineLearning.g.cs | 113 +- .../_Generated/Types/Enums/Enums.Mapping.g.cs | 5 +- .../Types/Enums/Enums.NoNamespace.g.cs | 127 +- .../Types/Enums/Enums.QueryDsl.g.cs | 222 +- .../Types/Enums/Enums.Snapshot.g.cs | 20 +- .../_Generated/Types/Eql/EqlHits.g.cs | 12 +- .../_Generated/Types/Eql/HitsEvent.g.cs | 16 +- .../_Generated/Types/Eql/HitsSequence.g.cs | 8 +- .../_Generated/Types/ErrorCause.g.cs | 21 +- .../_Generated/Types/ErrorResponseBase.g.cs | 4 +- .../_Generated/Types/GeoBounds.g.cs | 26 +- .../_Generated/Types/GeoLine.g.cs | 12 +- .../_Generated/Types/GeoLocation.g.cs | 26 +- .../_Generated/Types/GeohashPrecision.g.cs | 4 +- .../Types/Graph/ExploreControls.g.cs | 66 +- .../_Generated/Types/Graph/Hop.g.cs | 36 +- .../Types/Graph/VertexDefinition.g.cs | 91 +- .../IndexLifecycleManagement/Actions.g.cs | 48 +- .../Types/IndexManagement/AddAction.g.cs | 159 +- .../Types/IndexManagement/Alias.g.cs | 81 +- .../IndexManagement/AliasDefinition.g.cs | 27 +- .../Types/IndexManagement/DataStream.g.cs | 67 +- .../IndexManagement/DataStreamIndex.g.cs | 20 +- .../IndexManagement/DataStreamLifecycle.g.cs | 8 +- .../DataStreamLifecycleDownsampling.g.cs | 8 +- .../DataStreamLifecycleWithRollover.g.cs | 21 +- .../DataStreamTimestampField.g.cs | 4 +- .../IndexManagement/DataStreamsStatsItem.g.cs | 25 +- .../IndexManagement/DownsampleConfig.g.cs | 8 +- .../IndexManagement/DownsamplingRound.g.cs | 16 +- .../IndexManagement/ExplainAnalyzeToken.g.cs | 4 +- .../IndexAndDataStreamAction.g.cs | 16 +- .../Types/IndexManagement/IndexSettings.g.cs | 72 +- .../IndexSettingsLifecycle.g.cs | 56 +- .../IndexSettingsLifecycleStep.g.cs | 10 +- .../Types/IndexManagement/IndexState.g.cs | 24 +- .../Types/IndexManagement/IndexStats.g.cs | 68 +- .../Types/IndexManagement/IndexTemplate.g.cs | 37 +- .../IndexTemplateDataStreamConfiguration.g.cs | 8 +- .../IndexManagement/IndexTemplateMapping.g.cs | 48 +- .../IndexManagement/IndexTemplateSummary.g.cs | 16 +- .../IndexingPressureMemory.g.cs | 12 +- .../IndexingSlowlogTresholds.g.cs | 10 +- .../IndexManagement/MappingLimitSettings.g.cs | 8 +- .../MappingLimitSettingsDepth.g.cs | 10 +- .../MappingLimitSettingsDimensionFields.g.cs | 10 +- .../MappingLimitSettingsFieldNameLength.g.cs | 12 +- .../MappingLimitSettingsNestedFields.g.cs | 12 +- .../MappingLimitSettingsNestedObjects.g.cs | 10 +- .../MappingLimitSettingsTotalFields.g.cs | 28 +- .../Types/IndexManagement/RemoveAction.g.cs | 48 +- .../IndexManagement/RemoveIndexAction.g.cs | 28 +- .../Types/IndexManagement/SoftDeletes.g.cs | 22 +- .../Types/IndexManagement/Storage.g.cs | 14 +- .../Types/IndexManagement/Translog.g.cs | 34 +- .../IndexManagement/TranslogRetention.g.cs | 32 +- .../_Generated/Types/IndicesOptions.g.cs | 50 +- .../Types/Ingest/AppendProcessor.g.cs | 125 +- .../Types/Ingest/AttachmentProcessor.g.cs | 219 +- .../Types/Ingest/BytesProcessor.g.cs | 141 +- .../Types/Ingest/CircleProcessor.g.cs | 165 +- .../Types/Ingest/ConvertProcessor.g.cs | 153 +- .../_Generated/Types/Ingest/CsvProcessor.g.cs | 172 +- .../Types/Ingest/DateIndexNameProcessor.g.cs | 184 +- .../Types/Ingest/DateProcessor.g.cs | 167 +- .../Types/Ingest/DissectProcessor.g.cs | 130 +- .../_Generated/Types/Ingest/Document.g.cs | 26 +- .../Types/Ingest/DocumentSimulation.g.cs | 24 +- .../Types/Ingest/DotExpanderProcessor.g.cs | 116 +- .../Types/Ingest/DropProcessor.g.cs | 66 +- .../Types/Ingest/EnrichProcessor.g.cs | 208 +- .../Types/Ingest/FailProcessor.g.cs | 81 +- .../Types/Ingest/ForeachProcessor.g.cs | 118 +- .../Types/Ingest/GeoIpDownloadStatistics.g.cs | 20 +- .../Types/Ingest/GeoIpNodeDatabaseName.g.cs | 4 +- .../Types/Ingest/GeoIpNodeDatabases.g.cs | 12 +- .../Types/Ingest/GeoIpProcessor.g.cs | 170 +- .../Types/Ingest/GrokProcessor.g.cs | 148 +- .../Types/Ingest/GsubProcessor.g.cs | 165 +- .../Ingest/InferenceConfigClassification.g.cs | 95 +- .../Ingest/InferenceConfigRegression.g.cs | 40 +- .../Types/Ingest/InferenceProcessor.g.cs | 133 +- .../Types/Ingest/JoinProcessor.g.cs | 141 +- .../Types/Ingest/JsonProcessor.g.cs | 177 +- .../Types/Ingest/KeyValueProcessor.g.cs | 254 +- .../Types/Ingest/LowercaseProcessor.g.cs | 141 +- .../_Generated/Types/Ingest/Pipeline.g.cs | 63 +- .../Types/Ingest/PipelineProcessor.g.cs | 93 +- .../Types/Ingest/RemoveProcessor.g.cs | 102 +- .../Types/Ingest/RenameProcessor.g.cs | 148 +- .../Types/Ingest/RerouteProcessor.g.cs | 171 +- .../Types/Ingest/ScriptProcessor.g.cs | 120 +- .../_Generated/Types/Ingest/SetProcessor.g.cs | 199 +- .../Ingest/SetSecurityUserProcessor.g.cs | 106 +- .../Types/Ingest/SortProcessor.g.cs | 144 +- .../Types/Ingest/SplitProcessor.g.cs | 165 +- .../Types/Ingest/TrimProcessor.g.cs | 141 +- .../Types/Ingest/UppercaseProcessor.g.cs | 141 +- .../Types/Ingest/UrlDecodeProcessor.g.cs | 141 +- .../Types/Ingest/UserAgentProcessor.g.cs | 146 +- .../_Generated/Types/InlineGet.g.cs | 4 +- .../_Generated/Types/KnnQuery.g.cs | 109 +- .../_Generated/Types/KnnRetriever.g.cs | 84 +- .../_Generated/Types/KnnSearch.g.cs | 124 +- .../_Generated/Types/LatLonGeoLocation.g.cs | 16 +- .../Types/MachineLearning/AnalysisConfig.g.cs | 167 +- .../MachineLearning/AnalysisConfigRead.g.cs | 67 +- .../Types/MachineLearning/AnalysisLimits.g.cs | 16 +- .../MachineLearning/AnalysisMemoryLimit.g.cs | 8 +- .../Types/MachineLearning/Anomaly.g.cs | 96 +- .../MachineLearning/AnomalyExplanation.g.cs | 40 +- .../MachineLearning/ApiKeyAuthorization.g.cs | 8 +- .../MachineLearning/BucketInfluencer.g.cs | 48 +- .../Types/MachineLearning/BucketSummary.g.cs | 45 +- .../Types/MachineLearning/Calendar.g.cs | 12 +- .../Types/MachineLearning/CalendarEvent.g.cs | 32 +- .../CategorizationAnalyzerDefinition.g.cs | 24 +- .../Types/MachineLearning/Category.g.cs | 44 +- .../Types/MachineLearning/ChunkingConfig.g.cs | 22 +- .../ClassificationInferenceOptions.g.cs | 40 +- .../ConfusionMatrixThreshold.g.cs | 16 +- .../MachineLearning/DataDescription.g.cs | 52 +- .../Types/MachineLearning/Datafeed.g.cs | 4 +- .../DatafeedAuthorization.g.cs | 12 +- .../Types/MachineLearning/DatafeedConfig.g.cs | 156 +- .../MachineLearning/DatafeedRunningState.g.cs | 13 +- .../Types/MachineLearning/DatafeedStats.g.cs | 23 +- .../MachineLearning/DatafeedTimingStats.g.cs | 24 +- .../DataframeAnalysisAnalyzedFields.g.cs | 16 +- .../DataframeAnalysisClassification.g.cs | 250 +- ...ysisFeatureProcessorFrequencyEncoding.g.cs | 24 +- ...AnalysisFeatureProcessorMultiEncoding.g.cs | 8 +- ...AnalysisFeatureProcessorNGramEncoding.g.cs | 76 +- ...nalysisFeatureProcessorOneHotEncoding.g.cs | 40 +- ...sisFeatureProcessorTargetMeanEncoding.g.cs | 64 +- .../DataframeAnalysisOutlierDetection.g.cs | 48 +- .../DataframeAnalysisRegression.g.cs | 262 +- .../MachineLearning/DataframeAnalytics.g.cs | 24 +- .../DataframeAnalyticsAuthorization.g.cs | 12 +- .../DataframeAnalyticsDestination.g.cs | 40 +- .../DataframeAnalyticsFieldSelection.g.cs | 24 +- .../DataframeAnalyticsMemoryEstimation.g.cs | 8 +- .../DataframeAnalyticsSource.g.cs | 48 +- .../DataframeAnalyticsStatsDataCounts.g.cs | 12 +- .../DataframeAnalyticsStatsMemoryUsage.g.cs | 16 +- .../DataframeAnalyticsStatsProgress.g.cs | 8 +- .../DataframeAnalyticsSummary.g.cs | 4 +- .../DataframeClassificationSummary.g.cs | 21 +- .../DataframeEvaluationClassification.g.cs | 96 +- ...aframeEvaluationClassificationMetrics.g.cs | 40 +- ...EvaluationClassificationMetricsAucRoc.g.cs | 16 +- .../DataframeEvaluationOutlierDetection.g.cs | 68 +- ...rameEvaluationOutlierDetectionMetrics.g.cs | 32 +- .../DataframeEvaluationRegression.g.cs | 68 +- .../DataframeEvaluationRegressionMetrics.g.cs | 32 +- ...frameEvaluationRegressionMetricsHuber.g.cs | 8 +- ...aframeEvaluationRegressionMetricsMsle.g.cs | 8 +- .../DataframeOutlierDetectionSummary.g.cs | 16 +- .../DataframeRegressionSummary.g.cs | 16 +- .../Types/MachineLearning/Definition.g.cs | 16 +- .../DelayedDataCheckConfig.g.cs | 20 +- .../Types/MachineLearning/DetectionRule.g.cs | 36 +- .../Types/MachineLearning/Detector.g.cs | 184 +- .../Types/MachineLearning/DetectorRead.g.cs | 53 +- .../FillMaskInferenceOptions.g.cs | 48 +- .../FillMaskInferenceUpdateOptions.g.cs | 24 +- .../Types/MachineLearning/Filter.g.cs | 12 +- .../Types/MachineLearning/FilterRef.g.cs | 16 +- .../Types/MachineLearning/GeoResults.g.cs | 8 +- .../Types/MachineLearning/Hyperparameter.g.cs | 20 +- .../InferenceConfigCreate.g.cs | 4 +- .../InferenceResponseResult.g.cs | 46 +- .../Types/MachineLearning/Influencer.g.cs | 51 +- .../_Generated/Types/MachineLearning/Job.g.cs | 114 +- .../Types/MachineLearning/JobStats.g.cs | 39 +- .../Types/MachineLearning/JvmStats.g.cs | 24 +- .../Types/MachineLearning/MemMlStats.g.cs | 40 +- .../Types/MachineLearning/MemStats.g.cs | 22 +- .../Types/MachineLearning/Memory.g.cs | 20 +- .../MachineLearning/ModelPlotConfig.g.cs | 52 +- .../Types/MachineLearning/ModelSnapshot.g.cs | 40 +- .../MachineLearning/NerInferenceOptions.g.cs | 32 +- .../NerInferenceUpdateOptions.g.cs | 16 +- .../NlpBertTokenizationConfig.g.cs | 48 +- .../NlpRobertaTokenizationConfig.g.cs | 48 +- .../NlpTokenizationUpdateOptions.g.cs | 16 +- .../Types/MachineLearning/OverallBucket.g.cs | 28 +- .../Types/MachineLearning/Page.g.cs | 16 +- .../PassThroughInferenceOptions.g.cs | 24 +- .../PassThroughInferenceUpdateOptions.g.cs | 16 +- .../PerPartitionCategorization.g.cs | 16 +- .../QuestionAnsweringInferenceOptions.g.cs | 40 +- ...estionAnsweringInferenceUpdateOptions.g.cs | 40 +- .../RegressionInferenceOptions.g.cs | 40 +- .../Types/MachineLearning/RuleCondition.g.cs | 24 +- .../RunningStateSearchInterval.g.cs | 16 +- .../TextClassificationInferenceOptions.g.cs | 40 +- ...tClassificationInferenceUpdateOptions.g.cs | 32 +- .../TextEmbeddingInferenceOptions.g.cs | 32 +- .../TextEmbeddingInferenceUpdateOptions.g.cs | 8 +- .../TextExpansionInferenceOptions.g.cs | 24 +- .../TextExpansionInferenceUpdateOptions.g.cs | 8 +- .../MachineLearning/TokenizationConfig.g.cs | 4 +- .../TotalFeatureImportance.g.cs | 12 +- .../TotalFeatureImportanceClass.g.cs | 8 +- .../TotalFeatureImportanceStatistics.g.cs | 12 +- .../Types/MachineLearning/TrainedModel.g.cs | 50 +- .../TrainedModelAssignment.g.cs | 12 +- .../TrainedModelAssignmentRoutingTable.g.cs | 17 +- .../TrainedModelAssignmentTaskParameters.g.cs | 28 +- .../MachineLearning/TrainedModelConfig.g.cs | 60 +- .../TrainedModelConfigInput.g.cs | 4 +- .../TrainedModelConfigMetadata.g.cs | 12 +- ...rainedModelDeploymentAllocationStatus.g.cs | 12 +- .../TrainedModelDeploymentNodesStats.g.cs | 44 +- .../TrainedModelDeploymentStats.g.cs | 61 +- .../TrainedModelInferenceStats.g.cs | 24 +- .../TrainedModelPrefixStrings.g.cs | 16 +- .../TrainedModelSizeStats.g.cs | 8 +- .../MachineLearning/TrainedModelStats.g.cs | 26 +- .../TransformAuthorization.g.cs | 12 +- ...eroShotClassificationInferenceOptions.g.cs | 58 +- ...tClassificationInferenceUpdateOptions.g.cs | 32 +- .../AggregateMetricDoubleProperty.g.cs | 12 +- .../Types/Mapping/BinaryProperty.g.cs | 12 +- .../Types/Mapping/BooleanProperty.g.cs | 12 +- .../Types/Mapping/ByteNumberProperty.g.cs | 12 +- .../Types/Mapping/CompletionProperty.g.cs | 12 +- .../Mapping/ConstantKeywordProperty.g.cs | 12 +- .../Types/Mapping/DateNanosProperty.g.cs | 12 +- .../Types/Mapping/DateProperty.g.cs | 12 +- .../Types/Mapping/DateRangeProperty.g.cs | 12 +- .../Types/Mapping/DenseVectorProperty.g.cs | 12 +- .../Types/Mapping/DoubleNumberProperty.g.cs | 12 +- .../Types/Mapping/DoubleRangeProperty.g.cs | 12 +- .../Types/Mapping/DynamicProperty.g.cs | 12 +- .../Types/Mapping/FieldAliasProperty.g.cs | 12 +- .../Types/Mapping/FlattenedProperty.g.cs | 12 +- .../Types/Mapping/FloatNumberProperty.g.cs | 12 +- .../Types/Mapping/FloatRangeProperty.g.cs | 12 +- .../Types/Mapping/GeoPointProperty.g.cs | 12 +- .../Types/Mapping/GeoShapeProperty.g.cs | 27 +- .../Mapping/HalfFloatNumberProperty.g.cs | 12 +- .../Types/Mapping/HistogramProperty.g.cs | 12 +- .../Types/Mapping/IcuCollationProperty.g.cs | 36 +- .../Types/Mapping/IntegerNumberProperty.g.cs | 12 +- .../Types/Mapping/IntegerRangeProperty.g.cs | 12 +- .../_Generated/Types/Mapping/IpProperty.g.cs | 12 +- .../Types/Mapping/IpRangeProperty.g.cs | 12 +- .../Types/Mapping/JoinProperty.g.cs | 12 +- .../Types/Mapping/KeywordProperty.g.cs | 12 +- .../Types/Mapping/LongNumberProperty.g.cs | 12 +- .../Types/Mapping/LongRangeProperty.g.cs | 12 +- .../Types/Mapping/MatchOnlyTextProperty.g.cs | 66 +- .../Types/Mapping/Murmur3HashProperty.g.cs | 12 +- .../Types/Mapping/NestedProperty.g.cs | 12 +- .../Types/Mapping/ObjectProperty.g.cs | 12 +- .../Types/Mapping/PercolatorProperty.g.cs | 12 +- .../Types/Mapping/PointProperty.g.cs | 12 +- .../Types/Mapping/RankFeatureProperty.g.cs | 12 +- .../Types/Mapping/RankFeaturesProperty.g.cs | 12 +- .../Types/Mapping/RuntimeField.g.cs | 116 +- .../Mapping/ScaledFloatNumberProperty.g.cs | 12 +- .../Mapping/SearchAsYouTypeProperty.g.cs | 12 +- .../Types/Mapping/ShapeProperty.g.cs | 27 +- .../Types/Mapping/ShortNumberProperty.g.cs | 12 +- .../Types/Mapping/SparseVectorProperty.g.cs | 12 +- .../Types/Mapping/TextProperty.g.cs | 12 +- .../Types/Mapping/TokenCountProperty.g.cs | 12 +- .../Mapping/UnsignedLongNumberProperty.g.cs | 12 +- .../Types/Mapping/VersionProperty.g.cs | 12 +- .../Types/Mapping/WildcardProperty.g.cs | 12 +- .../_Generated/Types/NodeStatistics.g.cs | 16 +- .../Types/Nodes/AdaptiveSelection.g.cs | 28 +- .../_Generated/Types/Nodes/Breaker.g.cs | 24 +- .../_Generated/Types/Nodes/Cgroup.g.cs | 12 +- .../_Generated/Types/Nodes/CgroupCpu.g.cs | 16 +- .../_Generated/Types/Nodes/CgroupCpuStat.g.cs | 12 +- .../_Generated/Types/Nodes/CgroupMemory.g.cs | 15 +- .../_Generated/Types/Nodes/Client.g.cs | 46 +- .../Types/Nodes/ClusterStateQueue.g.cs | 12 +- .../Types/Nodes/ClusterStateUpdate.g.cs | 64 +- .../_Generated/Types/Nodes/CpuAcct.g.cs | 8 +- .../_Generated/Types/Nodes/DataPathStats.g.cs | 36 +- .../_Generated/Types/Nodes/Discovery.g.cs | 15 +- .../Types/Nodes/ExtendedMemoryStats.g.cs | 25 +- .../_Generated/Types/Nodes/FileSystem.g.cs | 17 +- .../Types/Nodes/FileSystemTotal.g.cs | 28 +- .../Types/Nodes/GarbageCollector.g.cs | 4 +- .../Types/Nodes/GarbageCollectorTotal.g.cs | 12 +- .../_Generated/Types/Nodes/Http.g.cs | 13 +- .../Types/Nodes/IndexingPressure.g.cs | 4 +- .../Types/Nodes/IndexingPressureMemory.g.cs | 18 +- .../_Generated/Types/Nodes/Ingest.g.cs | 8 +- .../_Generated/Types/Nodes/IngestTotal.g.cs | 20 +- .../_Generated/Types/Nodes/IoStatDevice.g.cs | 24 +- .../_Generated/Types/Nodes/IoStats.g.cs | 9 +- .../_Generated/Types/Nodes/Jvm.g.cs | 33 +- .../_Generated/Types/Nodes/JvmClasses.g.cs | 12 +- .../Types/Nodes/JvmMemoryStats.g.cs | 28 +- .../_Generated/Types/Nodes/JvmThreads.g.cs | 8 +- .../_Generated/Types/Nodes/MemoryStats.g.cs | 17 +- .../Types/Nodes/NodeBufferPool.g.cs | 20 +- .../_Generated/Types/Nodes/NodeInfo.g.cs | 32 +- .../Types/Nodes/NodeInfoDiscover.g.cs | 4 +- .../Types/Nodes/NodeOperatingSystemInfo.g.cs | 24 +- .../Types/Nodes/NodeProcessInfo.g.cs | 12 +- .../_Generated/Types/Nodes/Pool.g.cs | 16 +- .../Types/Nodes/PressureMemory.g.cs | 54 +- .../_Generated/Types/Nodes/Process.g.cs | 21 +- .../_Generated/Types/Nodes/Processor.g.cs | 16 +- .../Types/Nodes/PublishedClusterStates.g.cs | 12 +- .../_Generated/Types/Nodes/ScriptCache.g.cs | 12 +- .../_Generated/Types/Nodes/Scripting.g.cs | 16 +- .../Types/Nodes/SerializedClusterState.g.cs | 4 +- .../_Generated/Types/Nodes/Stats.g.cs | 81 +- .../_Generated/Types/Nodes/ThreadCount.g.cs | 24 +- .../_Generated/Types/Nodes/Transport.g.cs | 42 +- .../Types/Nodes/TransportHistogram.g.cs | 13 +- .../_Generated/Types/QueryCacheStats.g.cs | 33 +- .../_Generated/Types/QueryDsl/BoolQuery.g.cs | 87 +- .../Types/QueryDsl/BoostingQuery.g.cs | 57 +- .../Types/QueryDsl/CombinedFieldsQuery.g.cs | 96 +- .../Types/QueryDsl/ConstantScoreQuery.g.cs | 39 +- .../Types/QueryDsl/DateDecayFunction.g.cs | 12 +- .../QueryDsl/DateDistanceFeatureQuery.g.cs | 106 +- .../Types/QueryDsl/DateRangeQuery.g.cs | 105 +- .../Types/QueryDsl/DecayPlacement.g.cs | 16 +- .../Types/QueryDsl/DisMaxQuery.g.cs | 51 +- .../Types/QueryDsl/ExistsQuery.g.cs | 49 +- .../Types/QueryDsl/FieldAndFormat.g.cs | 52 +- .../Types/QueryDsl/FieldLookup.g.cs | 64 +- .../FieldValueFactorScoreFunction.g.cs | 67 +- .../Types/QueryDsl/FunctionScoreQuery.g.cs | 93 +- .../_Generated/Types/QueryDsl/FuzzyQuery.g.cs | 93 +- .../Types/QueryDsl/GeoBoundingBoxQuery.g.cs | 51 +- .../Types/QueryDsl/GeoDecayFunction.g.cs | 12 +- .../QueryDsl/GeoDistanceFeatureQuery.g.cs | 106 +- .../Types/QueryDsl/GeoDistanceQuery.g.cs | 81 +- .../Types/QueryDsl/GeoShapeFieldQuery.g.cs | 24 +- .../Types/QueryDsl/GeoShapeQuery.g.cs | 36 +- .../Types/QueryDsl/HasChildQuery.g.cs | 114 +- .../Types/QueryDsl/HasParentQuery.g.cs | 87 +- .../_Generated/Types/QueryDsl/IdsQuery.g.cs | 22 +- .../Types/QueryDsl/IntervalsAllOf.g.cs | 51 +- .../Types/QueryDsl/IntervalsAnyOf.g.cs | 24 +- .../Types/QueryDsl/IntervalsFuzzy.g.cs | 95 +- .../Types/QueryDsl/IntervalsMatch.g.cs | 98 +- .../Types/QueryDsl/IntervalsPrefix.g.cs | 59 +- .../Types/QueryDsl/IntervalsQuery.g.cs | 21 +- .../Types/QueryDsl/IntervalsWildcard.g.cs | 62 +- .../_Generated/Types/QueryDsl/Like.g.cs | 4 +- .../Types/QueryDsl/LikeDocument.g.cs | 48 +- .../Types/QueryDsl/MatchAllQuery.g.cs | 14 +- .../Types/QueryDsl/MatchBoolPrefixQuery.g.cs | 153 +- .../Types/QueryDsl/MatchNoneQuery.g.cs | 14 +- .../QueryDsl/MatchPhrasePrefixQuery.g.cs | 81 +- .../Types/QueryDsl/MatchPhraseQuery.g.cs | 69 +- .../_Generated/Types/QueryDsl/MatchQuery.g.cs | 165 +- .../Types/QueryDsl/MoreLikeThisQuery.g.cs | 219 +- .../Types/QueryDsl/MultiMatchQuery.g.cs | 219 +- .../Types/QueryDsl/NestedQuery.g.cs | 97 +- .../Types/QueryDsl/NumberRangeQuery.g.cs | 81 +- .../Types/QueryDsl/NumericDecayFunction.g.cs | 12 +- .../Types/QueryDsl/ParentIdQuery.g.cs | 38 +- .../Types/QueryDsl/PercolateQuery.g.cs | 145 +- .../_Generated/Types/QueryDsl/PinnedDoc.g.cs | 16 +- .../Types/QueryDsl/PinnedQuery.g.cs | 33 +- .../Types/QueryDsl/PrefixQuery.g.cs | 60 +- .../Types/QueryDsl/QueryStringQuery.g.cs | 345 +- .../RankFeatureFunctionLogarithm.g.cs | 8 +- .../RankFeatureFunctionSaturation.g.cs | 8 +- .../QueryDsl/RankFeatureFunctionSigmoid.g.cs | 16 +- .../Types/QueryDsl/RankFeatureQuery.g.cs | 97 +- .../Types/QueryDsl/RegexpQuery.g.cs | 84 +- .../_Generated/Types/QueryDsl/RuleQuery.g.cs | 21 +- .../Types/QueryDsl/ScriptQuery.g.cs | 24 +- .../Types/QueryDsl/ScriptScoreFunction.g.cs | 8 +- .../Types/QueryDsl/ScriptScoreQuery.g.cs | 60 +- .../Types/QueryDsl/SemanticQuery.g.cs | 30 +- .../Types/QueryDsl/ShapeFieldQuery.g.cs | 36 +- .../_Generated/Types/QueryDsl/ShapeQuery.g.cs | 33 +- .../QueryDsl/SimpleQueryStringQuery.g.cs | 186 +- .../Types/QueryDsl/SpanContainingQuery.g.cs | 51 +- .../Types/QueryDsl/SpanFieldMaskingQuery.g.cs | 21 +- .../Types/QueryDsl/SpanFirstQuery.g.cs | 45 +- .../Types/QueryDsl/SpanMultiTermQuery.g.cs | 33 +- .../Types/QueryDsl/SpanNearQuery.g.cs | 57 +- .../Types/QueryDsl/SpanNotQuery.g.cs | 84 +- .../Types/QueryDsl/SpanOrQuery.g.cs | 33 +- .../Types/QueryDsl/SpanTermQuery.g.cs | 21 +- .../Types/QueryDsl/SpanWithinQuery.g.cs | 51 +- .../Types/QueryDsl/SparseVectorQuery.g.cs | 71 +- .../_Generated/Types/QueryDsl/TermQuery.g.cs | 48 +- .../Types/QueryDsl/TermRangeQuery.g.cs | 81 +- .../_Generated/Types/QueryDsl/TermsQuery.g.cs | 21 +- .../Types/QueryDsl/TermsSetQuery.g.cs | 73 +- .../Types/QueryDsl/TextExpansionQuery.g.cs | 45 +- .../Types/QueryDsl/TokenPruningConfig.g.cs | 24 +- .../Types/QueryDsl/UntypedDecayFunction.g.cs | 12 +- .../QueryDsl/UntypedDistanceFeatureQuery.g.cs | 106 +- .../Types/QueryDsl/UntypedRangeQuery.g.cs | 105 +- .../Types/QueryDsl/WeightedTokensQuery.g.cs | 45 +- .../Types/QueryDsl/WildcardQuery.g.cs | 69 +- .../Types/QueryDsl/WrapperQuery.g.cs | 24 +- .../QueryRules/QueryRulesetListItem.g.cs | 12 +- .../_Generated/Types/RRFRetriever.g.cs | 48 +- .../_Generated/Types/RrfRank.g.cs | 16 +- .../_Generated/Types/Script.g.cs | 34 +- .../_Generated/Types/SegmentsStats.g.cs | 90 +- .../_Generated/Types/ShardStatistics.g.cs | 8 +- .../_Generated/Types/Slices.g.cs | 4 +- .../Snapshot/CleanupRepositoryResults.g.cs | 8 +- .../Retention.g.cs | 24 +- .../SlmConfiguration.g.cs | 52 +- .../Types/SpecUtils/OverloadOf.g.cs | 6 +- .../_Generated/Types/StandardRetriever.g.cs | 84 +- .../_Generated/Types/StoreStats.g.cs | 26 +- .../_Generated/Types/StoredScript.g.cs | 16 +- .../Types/Synonyms/SynonymRule.g.cs | 16 +- .../Types/Synonyms/SynonymRuleRead.g.cs | 8 +- .../Types/Synonyms/SynonymsSetItem.g.cs | 8 +- .../Types/Tasks/ParentTaskInfo.g.cs | 4 +- .../_Generated/Types/Tasks/TaskInfo.g.cs | 4 +- .../TransformManagement/Destination.g.cs | 20 +- .../Types/TransformManagement/Latest.g.cs | 40 +- .../Types/TransformManagement/Pivot.g.cs | 36 +- .../Types/TransformManagement/Settings.g.cs | 74 +- .../Types/TransformManagement/Source.g.cs | 48 +- .../TimeRetentionPolicy.g.cs | 43 +- .../Types/TransformManagement/TimeSync.g.cs | 54 +- .../TransformManagement/TransformSummary.g.cs | 36 +- .../Types/Xpack/MachineLearning.g.cs | 4 +- .../AsyncSearch/AsyncSearchStatusRequest.g.cs | 18 +- .../AsyncSearchStatusResponse.g.cs | 34 +- .../AsyncSearch/DeleteAsyncSearchRequest.g.cs | 21 +- .../DeleteAsyncSearchResponse.g.cs | 4 +- .../AsyncSearch/GetAsyncSearchRequest.g.cs | 51 +- .../AsyncSearch/GetAsyncSearchResponse.g.cs | 19 +- .../AsyncSearch/SubmitAsyncSearchRequest.g.cs | 595 +- .../SubmitAsyncSearchResponse.g.cs | 19 +- .../_Generated/Api/BulkRequest.g.cs | 98 +- .../_Generated/Api/ClearScrollRequest.g.cs | 18 +- .../Api/ClosePointInTimeRequest.g.cs | 16 +- .../Api/Cluster/AllocationExplainRequest.g.cs | 56 +- .../Api/Cluster/ClusterInfoRequest.g.cs | 10 +- .../Api/Cluster/ClusterStatsRequest.g.cs | 30 +- .../Api/Cluster/ClusterStatsResponse.g.cs | 28 +- .../DeleteComponentTemplateRequest.g.cs | 32 +- .../DeleteComponentTemplateResponse.g.cs | 4 +- .../DeleteVotingConfigExclusionsRequest.g.cs | 26 +- .../ExistsComponentTemplateRequest.g.cs | 32 +- .../Cluster/GetClusterSettingsRequest.g.cs | 46 +- .../Cluster/GetComponentTemplateRequest.g.cs | 46 +- .../_Generated/Api/Cluster/HealthRequest.g.cs | 103 +- .../Api/Cluster/HealthResponse.g.cs | 60 +- .../Api/Cluster/PendingTasksRequest.g.cs | 34 +- .../PostVotingConfigExclusionsRequest.g.cs | 42 +- .../Cluster/PutComponentTemplateRequest.g.cs | 165 +- .../Cluster/PutComponentTemplateResponse.g.cs | 4 +- .../_Generated/Api/CountRequest.g.cs | 156 +- .../_Generated/Api/CreateRequest.g.cs | 78 +- .../CcrStatsRequest.g.cs | 8 +- .../DeleteAutoFollowPatternRequest.g.cs | 8 +- .../DeleteAutoFollowPatternResponse.g.cs | 4 +- .../FollowInfoRequest.g.cs | 12 +- .../FollowRequest.g.cs | 20 +- .../FollowStatsRequest.g.cs | 12 +- .../ForgetFollowerRequest.g.cs | 12 +- .../GetAutoFollowPatternRequest.g.cs | 8 +- .../PauseAutoFollowPatternRequest.g.cs | 8 +- .../PauseAutoFollowPatternResponse.g.cs | 4 +- .../PauseFollowRequest.g.cs | 12 +- .../PauseFollowResponse.g.cs | 4 +- .../PutAutoFollowPatternRequest.g.cs | 128 +- .../PutAutoFollowPatternResponse.g.cs | 4 +- .../ResumeAutoFollowPatternRequest.g.cs | 8 +- .../ResumeAutoFollowPatternResponse.g.cs | 4 +- .../ResumeFollowRequest.g.cs | 12 +- .../ResumeFollowResponse.g.cs | 4 +- .../UnfollowRequest.g.cs | 12 +- .../UnfollowResponse.g.cs | 4 +- .../ListDanglingIndicesRequest.g.cs | 8 +- .../_Generated/Api/DeleteByQueryRequest.g.cs | 305 +- .../Api/DeleteByQueryRethrottleRequest.g.cs | 16 +- .../Api/DeleteByQueryRethrottleResponse.g.cs | 9 +- .../_Generated/Api/DeleteRequest.g.cs | 85 +- .../_Generated/Api/DeleteScriptRequest.g.cs | 35 +- .../_Generated/Api/DeleteScriptResponse.g.cs | 4 +- .../Api/Enrich/DeletePolicyRequest.g.cs | 10 +- .../Api/Enrich/DeletePolicyResponse.g.cs | 4 +- .../Api/Enrich/EnrichStatsRequest.g.cs | 10 +- .../Api/Enrich/EnrichStatsResponse.g.cs | 12 +- .../Api/Enrich/ExecutePolicyRequest.g.cs | 16 +- .../Api/Enrich/GetPolicyRequest.g.cs | 10 +- .../Api/Enrich/PutPolicyRequest.g.cs | 51 +- .../Api/Enrich/PutPolicyResponse.g.cs | 4 +- .../_Generated/Api/Eql/EqlDeleteRequest.g.cs | 15 +- .../_Generated/Api/Eql/EqlDeleteResponse.g.cs | 4 +- .../_Generated/Api/Eql/EqlGetRequest.g.cs | 32 +- .../_Generated/Api/Eql/EqlGetResponse.g.cs | 24 +- .../_Generated/Api/Eql/EqlSearchRequest.g.cs | 164 +- .../_Generated/Api/Eql/EqlSearchResponse.g.cs | 24 +- .../Api/Eql/GetEqlStatusRequest.g.cs | 12 +- .../Api/Eql/GetEqlStatusResponse.g.cs | 24 +- .../_Generated/Api/Esql/EsqlQueryRequest.g.cs | 107 +- .../_Generated/Api/ExistsRequest.g.cs | 103 +- .../_Generated/Api/ExistsSourceRequest.g.cs | 91 +- .../_Generated/Api/ExplainRequest.g.cs | 127 +- .../Api/Features/GetFeaturesRequest.g.cs | 8 +- .../Api/Features/ResetFeaturesRequest.g.cs | 8 +- .../_Generated/Api/FieldCapsRequest.g.cs | 117 +- .../_Generated/Api/GetRequest.g.cs | 111 +- .../Api/GetScriptContextRequest.g.cs | 8 +- .../Api/GetScriptLanguagesRequest.g.cs | 8 +- .../_Generated/Api/GetScriptRequest.g.cs | 23 +- .../_Generated/Api/GetSourceRequest.g.cs | 87 +- .../_Generated/Api/Graph/ExploreRequest.g.cs | 80 +- .../_Generated/Api/HealthReportRequest.g.cs | 32 +- .../DeleteLifecycleRequest.g.cs | 24 +- .../DeleteLifecycleResponse.g.cs | 4 +- .../GetIlmStatusRequest.g.cs | 8 +- .../GetLifecycleRequest.g.cs | 24 +- .../MigrateToDataTiersRequest.g.cs | 22 +- .../MoveToStepRequest.g.cs | 12 +- .../MoveToStepResponse.g.cs | 4 +- .../PutLifecycleRequest.g.cs | 24 +- .../PutLifecycleResponse.g.cs | 4 +- .../RemovePolicyRequest.g.cs | 12 +- .../RetryRequest.g.cs | 12 +- .../RetryResponse.g.cs | 4 +- .../StartIlmRequest.g.cs | 8 +- .../StartIlmResponse.g.cs | 4 +- .../StopIlmRequest.g.cs | 8 +- .../StopIlmResponse.g.cs | 4 +- .../IndexManagement/AnalyzeIndexRequest.g.cs | 156 +- .../IndexManagement/ClearCacheRequest.g.cs | 81 +- .../IndexManagement/CloneIndexRequest.g.cs | 66 +- .../IndexManagement/CloseIndexRequest.g.cs | 74 +- .../CreateDataStreamRequest.g.cs | 44 +- .../CreateDataStreamResponse.g.cs | 4 +- .../IndexManagement/CreateIndexRequest.g.cs | 132 +- .../DataStreamsStatsRequest.g.cs | 20 +- .../DataStreamsStatsResponse.g.cs | 25 +- .../IndexManagement/DeleteAliasRequest.g.cs | 35 +- .../IndexManagement/DeleteAliasResponse.g.cs | 4 +- .../DeleteDataLifecycleRequest.g.cs | 34 +- .../DeleteDataLifecycleResponse.g.cs | 4 +- .../DeleteDataStreamRequest.g.cs | 34 +- .../DeleteDataStreamResponse.g.cs | 4 +- .../IndexManagement/DeleteIndexRequest.g.cs | 67 +- .../IndexManagement/DeleteIndexResponse.g.cs | 4 +- .../DeleteIndexTemplateRequest.g.cs | 30 +- .../DeleteIndexTemplateResponse.g.cs | 4 +- .../DeleteTemplateRequest.g.cs | 28 +- .../DeleteTemplateResponse.g.cs | 4 +- .../Api/IndexManagement/DiskUsageRequest.g.cs | 64 +- .../IndexManagement/DownsampleRequest.g.cs | 12 +- .../IndexManagement/ExistsAliasRequest.g.cs | 55 +- .../ExistsIndexTemplateRequest.g.cs | 16 +- .../Api/IndexManagement/ExistsRequest.g.cs | 71 +- .../ExistsTemplateRequest.g.cs | 34 +- .../ExplainDataLifecycleRequest.g.cs | 31 +- .../FieldUsageStatsRequest.g.cs | 82 +- .../Api/IndexManagement/FlushRequest.g.cs | 62 +- .../IndexManagement/ForcemergeRequest.g.cs | 68 +- .../IndexManagement/ForcemergeResponse.g.cs | 5 +- .../Api/IndexManagement/GetAliasRequest.g.cs | 55 +- .../GetDataLifecycleRequest.g.cs | 46 +- .../IndexManagement/GetDataStreamRequest.g.cs | 44 +- .../GetFieldMappingRequest.g.cs | 66 +- .../Api/IndexManagement/GetIndexRequest.g.cs | 90 +- .../GetIndexTemplateRequest.g.cs | 42 +- .../GetIndicesSettingsRequest.g.cs | 92 +- .../IndexManagement/GetMappingRequest.g.cs | 68 +- .../IndexManagement/GetTemplateRequest.g.cs | 36 +- .../IndexManagement/IndicesStatsRequest.g.cs | 91 +- .../MigrateToDataStreamRequest.g.cs | 60 +- .../MigrateToDataStreamResponse.g.cs | 4 +- .../ModifyDataStreamRequest.g.cs | 18 +- .../ModifyDataStreamResponse.g.cs | 4 +- .../Api/IndexManagement/OpenIndexRequest.g.cs | 77 +- .../PromoteDataStreamRequest.g.cs | 24 +- .../Api/IndexManagement/PutAliasRequest.g.cs | 119 +- .../Api/IndexManagement/PutAliasResponse.g.cs | 4 +- .../PutDataLifecycleRequest.g.cs | 66 +- .../PutDataLifecycleResponse.g.cs | 4 +- .../PutIndexTemplateRequest.g.cs | 203 +- .../PutIndexTemplateResponse.g.cs | 4 +- .../PutIndicesSettingsRequest.g.cs | 94 +- .../PutIndicesSettingsResponse.g.cs | 4 +- .../IndexManagement/PutMappingRequest.g.cs | 279 +- .../IndexManagement/PutMappingResponse.g.cs | 4 +- .../IndexManagement/PutTemplateRequest.g.cs | 129 +- .../IndexManagement/PutTemplateResponse.g.cs | 4 +- .../Api/IndexManagement/RecoveryRequest.g.cs | 31 +- .../Api/IndexManagement/RefreshRequest.g.cs | 50 +- .../ReloadSearchAnalyzersRequest.g.cs | 36 +- .../ResolveClusterRequest.g.cs | 54 +- .../IndexManagement/ResolveIndexRequest.g.cs | 24 +- .../Api/IndexManagement/RolloverRequest.g.cs | 122 +- .../Api/IndexManagement/SegmentsRequest.g.cs | 55 +- .../IndexManagement/ShardStoresRequest.g.cs | 53 +- .../IndexManagement/ShrinkIndexRequest.g.cs | 69 +- .../SimulateIndexTemplateRequest.g.cs | 26 +- .../SimulateTemplateRequest.g.cs | 201 +- .../IndexManagement/SplitIndexRequest.g.cs | 66 +- .../IndexManagement/UpdateAliasesRequest.g.cs | 47 +- .../UpdateAliasesResponse.g.cs | 4 +- .../IndexManagement/ValidateQueryRequest.g.cs | 135 +- .../_Generated/Api/IndexRequest.g.cs | 120 +- .../Api/Inference/DeleteInferenceRequest.g.cs | 24 +- .../Inference/DeleteInferenceResponse.g.cs | 4 +- .../Api/Inference/GetInferenceRequest.g.cs | 8 +- .../Api/Inference/InferenceRequest.g.cs | 44 +- .../Api/Inference/PutInferenceRequest.g.cs | 8 +- .../Api/Inference/PutInferenceResponse.g.cs | 20 +- .../_Generated/Api/InfoRequest.g.cs | 10 +- .../Api/Ingest/DeletePipelineRequest.g.cs | 32 +- .../Api/Ingest/DeletePipelineResponse.g.cs | 4 +- .../Api/Ingest/GeoIpStatsRequest.g.cs | 8 +- .../Api/Ingest/GeoIpStatsResponse.g.cs | 8 +- .../Api/Ingest/GetPipelineRequest.g.cs | 33 +- .../Api/Ingest/ProcessorGrokRequest.g.cs | 12 +- .../Api/Ingest/PutPipelineRequest.g.cs | 99 +- .../Api/Ingest/PutPipelineResponse.g.cs | 4 +- .../Api/Ingest/SimulateRequest.g.cs | 50 +- .../DeleteLicenseRequest.g.cs | 8 +- .../DeleteLicenseResponse.g.cs | 4 +- .../GetBasicStatusRequest.g.cs | 8 +- .../LicenseManagement/GetLicenseRequest.g.cs | 20 +- .../GetTrialStatusRequest.g.cs | 8 +- .../Api/LicenseManagement/PostRequest.g.cs | 24 +- .../PostStartBasicRequest.g.cs | 18 +- .../PostStartTrialRequest.g.cs | 16 +- ...earTrainedModelDeploymentCacheRequest.g.cs | 16 +- .../Api/MachineLearning/CloseJobRequest.g.cs | 40 +- .../DeleteCalendarEventRequest.g.cs | 8 +- .../DeleteCalendarEventResponse.g.cs | 4 +- .../DeleteCalendarJobRequest.g.cs | 8 +- .../DeleteCalendarJobResponse.g.cs | 12 +- .../DeleteCalendarRequest.g.cs | 10 +- .../DeleteCalendarResponse.g.cs | 4 +- .../DeleteDataFrameAnalyticsRequest.g.cs | 28 +- .../DeleteDataFrameAnalyticsResponse.g.cs | 4 +- .../DeleteDatafeedRequest.g.cs | 18 +- .../DeleteDatafeedResponse.g.cs | 4 +- .../DeleteExpiredDataRequest.g.cs | 42 +- .../MachineLearning/DeleteFilterRequest.g.cs | 12 +- .../MachineLearning/DeleteFilterResponse.g.cs | 4 +- .../DeleteForecastRequest.g.cs | 42 +- .../DeleteForecastResponse.g.cs | 4 +- .../Api/MachineLearning/DeleteJobRequest.g.cs | 52 +- .../MachineLearning/DeleteJobResponse.g.cs | 4 +- .../DeleteModelSnapshotRequest.g.cs | 14 +- .../DeleteModelSnapshotResponse.g.cs | 4 +- .../DeleteTrainedModelAliasRequest.g.cs | 14 +- .../DeleteTrainedModelAliasResponse.g.cs | 4 +- .../DeleteTrainedModelRequest.g.cs | 18 +- .../DeleteTrainedModelResponse.g.cs | 4 +- .../EstimateModelMemoryRequest.g.cs | 90 +- .../EvaluateDataFrameRequest.g.cs | 60 +- .../ExplainDataFrameAnalyticsRequest.g.cs | 204 +- .../ExplainDataFrameAnalyticsResponse.g.cs | 8 +- .../Api/MachineLearning/FlushJobRequest.g.cs | 64 +- .../Api/MachineLearning/FlushJobResponse.g.cs | 5 +- .../Api/MachineLearning/ForecastRequest.g.cs | 46 +- .../MachineLearning/GetBucketsRequest.g.cs | 131 +- .../GetCalendarEventsRequest.g.cs | 48 +- .../MachineLearning/GetCalendarsRequest.g.cs | 32 +- .../MachineLearning/GetCategoriesRequest.g.cs | 42 +- .../GetDataFrameAnalyticsRequest.g.cs | 109 +- .../GetDataFrameAnalyticsResponse.g.cs | 4 +- .../GetDataFrameAnalyticsStatsRequest.g.cs | 96 +- .../GetDataFrameAnalyticsStatsResponse.g.cs | 4 +- .../GetDatafeedStatsRequest.g.cs | 78 +- .../MachineLearning/GetDatafeedsRequest.g.cs | 88 +- .../MachineLearning/GetFiltersRequest.g.cs | 26 +- .../GetInfluencersRequest.g.cs | 112 +- .../GetInfluencersResponse.g.cs | 4 +- .../MachineLearning/GetJobStatsRequest.g.cs | 66 +- .../Api/MachineLearning/GetJobsRequest.g.cs | 86 +- .../GetMemoryStatsRequest.g.cs | 30 +- .../GetModelSnapshotUpgradeStatsRequest.g.cs | 64 +- .../GetModelSnapshotsRequest.g.cs | 92 +- .../GetOverallBucketsRequest.g.cs | 100 +- .../GetOverallBucketsResponse.g.cs | 4 +- .../MachineLearning/GetRecordsRequest.g.cs | 146 +- .../GetTrainedModelsRequest.g.cs | 122 +- .../GetTrainedModelsResponse.g.cs | 4 +- .../GetTrainedModelsStatsRequest.g.cs | 80 +- .../GetTrainedModelsStatsResponse.g.cs | 8 +- .../InferTrainedModelRequest.g.cs | 50 +- .../Api/MachineLearning/MlInfoRequest.g.cs | 20 +- .../Api/MachineLearning/OpenJobRequest.g.cs | 30 +- .../Api/MachineLearning/OpenJobResponse.g.cs | 5 +- .../PostCalendarEventsRequest.g.cs | 16 +- .../PreviewDataFrameAnalyticsRequest.g.cs | 30 +- .../PreviewDataFrameAnalyticsResponse.g.cs | 4 +- .../PutCalendarJobRequest.g.cs | 8 +- .../PutCalendarJobResponse.g.cs | 12 +- .../MachineLearning/PutCalendarRequest.g.cs | 24 +- .../MachineLearning/PutCalendarResponse.g.cs | 12 +- .../PutDataFrameAnalyticsRequest.g.cs | 243 +- .../MachineLearning/PutDatafeedRequest.g.cs | 277 +- .../Api/MachineLearning/PutFilterRequest.g.cs | 30 +- .../Api/MachineLearning/PutJobRequest.g.cs | 195 +- .../PutTrainedModelAliasRequest.g.cs | 50 +- .../PutTrainedModelAliasResponse.g.cs | 4 +- .../PutTrainedModelDefinitionPartRequest.g.cs | 32 +- ...PutTrainedModelDefinitionPartResponse.g.cs | 4 +- .../PutTrainedModelRequest.g.cs | 208 +- .../PutTrainedModelResponse.g.cs | 60 +- .../PutTrainedModelVocabularyRequest.g.cs | 36 +- .../PutTrainedModelVocabularyResponse.g.cs | 4 +- .../Api/MachineLearning/ResetJobRequest.g.cs | 38 +- .../Api/MachineLearning/ResetJobResponse.g.cs | 4 +- .../RevertModelSnapshotRequest.g.cs | 30 +- .../SetUpgradeModeRequest.g.cs | 50 +- .../SetUpgradeModeResponse.g.cs | 4 +- .../StartDataFrameAnalyticsRequest.g.cs | 55 +- .../StartDataFrameAnalyticsResponse.g.cs | 8 +- .../MachineLearning/StartDatafeedRequest.g.cs | 72 +- .../StartDatafeedResponse.g.cs | 9 +- .../StartTrainedModelDeploymentRequest.g.cs | 96 +- .../StopDataFrameAnalyticsRequest.g.cs | 96 +- .../MachineLearning/StopDatafeedRequest.g.cs | 36 +- .../StopTrainedModelDeploymentRequest.g.cs | 32 +- .../UpdateDataFrameAnalyticsRequest.g.cs | 84 +- .../UpdateDatafeedRequest.g.cs | 330 +- .../MachineLearning/UpdateFilterRequest.g.cs | 32 +- .../Api/MachineLearning/UpdateJobRequest.g.cs | 246 +- .../UpdateModelSnapshotRequest.g.cs | 28 +- .../UpdateTrainedModelDeploymentRequest.g.cs | 26 +- .../UpgradeJobSnapshotRequest.g.cs | 42 +- .../UpgradeJobSnapshotResponse.g.cs | 8 +- .../ValidateDetectorRequest.g.cs | 12 +- .../ValidateDetectorResponse.g.cs | 4 +- .../Api/MachineLearning/ValidateRequest.g.cs | 12 +- .../Api/MachineLearning/ValidateResponse.g.cs | 4 +- .../_Generated/Api/MultiGetRequest.g.cs | 118 +- .../_Generated/Api/MultiSearchRequest.g.cs | 108 +- .../Api/MultiSearchTemplateRequest.g.cs | 56 +- .../Api/MultiTermVectorsRequest.g.cs | 128 +- ...earRepositoriesMeteringArchiveRequest.g.cs | 8 +- ...arRepositoriesMeteringArchiveResponse.g.cs | 12 +- .../GetRepositoriesMeteringInfoRequest.g.cs | 14 +- .../GetRepositoriesMeteringInfoResponse.g.cs | 12 +- .../Api/Nodes/HotThreadsRequest.g.cs | 82 +- .../Api/Nodes/NodesInfoRequest.g.cs | 32 +- .../Api/Nodes/NodesInfoResponse.g.cs | 4 +- .../Api/Nodes/NodesStatsRequest.g.cs | 92 +- .../Api/Nodes/NodesStatsResponse.g.cs | 4 +- .../Api/Nodes/NodesUsageRequest.g.cs | 18 +- .../Api/Nodes/NodesUsageResponse.g.cs | 4 +- .../Nodes/ReloadSecureSettingsRequest.g.cs | 26 +- .../Nodes/ReloadSecureSettingsResponse.g.cs | 4 +- .../Api/OpenPointInTimeRequest.g.cs | 73 +- .../_Generated/Api/PingRequest.g.cs | 10 +- .../_Generated/Api/PutScriptRequest.g.cs | 47 +- .../_Generated/Api/PutScriptResponse.g.cs | 4 +- .../Api/QueryRules/DeleteRulesetRequest.g.cs | 8 +- .../Api/QueryRules/DeleteRulesetResponse.g.cs | 4 +- .../Api/QueryRules/GetRulesetRequest.g.cs | 8 +- .../Api/QueryRules/GetRulesetResponse.g.cs | 8 +- .../Api/QueryRules/ListRulesetsRequest.g.cs | 24 +- .../Api/QueryRules/PutRulesetRequest.g.cs | 8 +- .../_Generated/Api/RankEvalRequest.g.cs | 68 +- .../_Generated/Api/RankEvalResponse.g.cs | 8 +- .../_Generated/Api/ReindexRequest.g.cs | 145 +- .../Api/ReindexRethrottleRequest.g.cs | 16 +- .../Api/RenderSearchTemplateRequest.g.cs | 51 +- .../Api/Rollup/DeleteJobRequest.g.cs | 12 +- .../_Generated/Api/Rollup/GetJobsRequest.g.cs | 12 +- .../Api/Rollup/GetRollupCapsRequest.g.cs | 12 +- .../Api/Rollup/GetRollupIndexCapsRequest.g.cs | 12 +- .../_Generated/Api/Rollup/PutJobRequest.g.cs | 135 +- .../_Generated/Api/Rollup/PutJobResponse.g.cs | 4 +- .../Api/Rollup/RollupSearchRequest.g.cs | 64 +- .../Api/Rollup/StartJobRequest.g.cs | 12 +- .../_Generated/Api/Rollup/StopJobRequest.g.cs | 32 +- .../Api/ScriptsPainlessExecuteRequest.g.cs | 51 +- .../_Generated/Api/ScrollRequest.g.cs | 32 +- .../DeleteBehavioralAnalyticsRequest.g.cs | 8 +- .../DeleteBehavioralAnalyticsResponse.g.cs | 4 +- .../DeleteSearchApplicationRequest.g.cs | 8 +- .../DeleteSearchApplicationResponse.g.cs | 4 +- .../GetBehavioralAnalyticsRequest.g.cs | 8 +- .../GetSearchApplicationRequest.g.cs | 8 +- .../GetSearchApplicationResponse.g.cs | 20 +- .../Api/SearchApplication/ListRequest.g.cs | 32 +- .../PutBehavioralAnalyticsRequest.g.cs | 8 +- .../PutBehavioralAnalyticsResponse.g.cs | 8 +- .../PutSearchApplicationRequest.g.cs | 16 +- .../SearchApplicationSearchRequest.g.cs | 24 +- .../_Generated/Api/SearchMvtRequest.g.cs | 333 +- .../_Generated/Api/SearchRequest.g.cs | 832 ++- .../_Generated/Api/SearchShardsRequest.g.cs | 72 +- .../_Generated/Api/SearchTemplateRequest.g.cs | 189 +- .../CacheStatsRequest.g.cs | 8 +- .../ClearCacheRequest.g.cs | 36 +- .../Api/SearchableSnapshots/MountRequest.g.cs | 32 +- .../SearchableSnapshotsStatsRequest.g.cs | 20 +- .../Snapshot/CleanupRepositoryRequest.g.cs | 24 +- .../Snapshot/CleanupRepositoryResponse.g.cs | 4 +- .../Api/Snapshot/CloneSnapshotRequest.g.cs | 16 +- .../Api/Snapshot/CloneSnapshotResponse.g.cs | 4 +- .../Api/Snapshot/CreateRepositoryRequest.g.cs | 32 +- .../Snapshot/CreateRepositoryResponse.g.cs | 4 +- .../Api/Snapshot/CreateSnapshotRequest.g.cs | 72 +- .../Api/Snapshot/CreateSnapshotResponse.g.cs | 8 +- .../Api/Snapshot/DeleteRepositoryRequest.g.cs | 24 +- .../Snapshot/DeleteRepositoryResponse.g.cs | 4 +- .../Api/Snapshot/DeleteSnapshotRequest.g.cs | 16 +- .../Api/Snapshot/DeleteSnapshotResponse.g.cs | 4 +- .../Api/Snapshot/GetRepositoryRequest.g.cs | 24 +- .../Api/Snapshot/GetSnapshotRequest.g.cs | 112 +- .../Api/Snapshot/GetSnapshotResponse.g.cs | 8 +- .../Api/Snapshot/RestoreRequest.g.cs | 28 +- .../Api/Snapshot/SnapshotStatusRequest.g.cs | 24 +- .../Api/Snapshot/VerifyRepositoryRequest.g.cs | 24 +- .../DeleteLifecycleRequest.g.cs | 8 +- .../DeleteLifecycleResponse.g.cs | 4 +- .../ExecuteLifecycleRequest.g.cs | 8 +- .../ExecuteRetentionRequest.g.cs | 8 +- .../ExecuteRetentionResponse.g.cs | 4 +- .../GetLifecycleRequest.g.cs | 8 +- .../GetSlmStatusRequest.g.cs | 8 +- .../GetStatsRequest.g.cs | 8 +- .../PutLifecycleRequest.g.cs | 64 +- .../PutLifecycleResponse.g.cs | 4 +- .../StartSlmRequest.g.cs | 8 +- .../StartSlmResponse.g.cs | 4 +- .../StopSlmRequest.g.cs | 8 +- .../StopSlmResponse.g.cs | 4 +- .../Api/Sql/ClearCursorRequest.g.cs | 16 +- .../Api/Sql/DeleteAsyncRequest.g.cs | 12 +- .../Api/Sql/DeleteAsyncResponse.g.cs | 4 +- .../_Generated/Api/Sql/GetAsyncRequest.g.cs | 50 +- .../_Generated/Api/Sql/GetAsyncResponse.g.cs | 30 +- .../Api/Sql/GetAsyncStatusRequest.g.cs | 12 +- .../Api/Sql/GetAsyncStatusResponse.g.cs | 29 +- .../_Generated/Api/Sql/QueryRequest.g.cs | 221 +- .../_Generated/Api/Sql/QueryResponse.g.cs | 30 +- .../_Generated/Api/Sql/TranslateRequest.g.cs | 60 +- .../Api/Synonyms/DeleteSynonymRequest.g.cs | 12 +- .../Api/Synonyms/DeleteSynonymResponse.g.cs | 4 +- .../Synonyms/DeleteSynonymRuleRequest.g.cs | 8 +- .../Synonyms/DeleteSynonymRuleResponse.g.cs | 9 +- .../Api/Synonyms/GetSynonymRequest.g.cs | 28 +- .../Api/Synonyms/GetSynonymRuleRequest.g.cs | 8 +- .../Api/Synonyms/GetSynonymRuleResponse.g.cs | 8 +- .../Api/Synonyms/GetSynonymsSetsRequest.g.cs | 24 +- .../Api/Synonyms/PutSynonymRequest.g.cs | 24 +- .../Api/Synonyms/PutSynonymRuleRequest.g.cs | 8 +- .../Api/Synonyms/PutSynonymRuleResponse.g.cs | 9 +- .../_Generated/Api/Tasks/CancelRequest.g.cs | 40 +- .../_Generated/Api/Tasks/CancelResponse.g.cs | 9 +- .../_Generated/Api/Tasks/GetTasksRequest.g.cs | 28 +- .../_Generated/Api/Tasks/ListRequest.g.cs | 72 +- .../_Generated/Api/Tasks/ListResponse.g.cs | 9 +- .../_Generated/Api/TermVectorsRequest.g.cs | 126 +- .../_Generated/Api/TermsEnumRequest.g.cs | 100 +- .../TextStructure/TestGrokPatternRequest.g.cs | 32 +- .../DeleteTransformRequest.g.cs | 38 +- .../DeleteTransformResponse.g.cs | 4 +- .../GetTransformRequest.g.cs | 92 +- .../GetTransformStatsRequest.g.cs | 88 +- .../PreviewTransformRequest.g.cs | 172 +- .../PutTransformRequest.g.cs | 255 +- .../PutTransformResponse.g.cs | 4 +- .../ResetTransformRequest.g.cs | 24 +- .../ResetTransformResponse.g.cs | 4 +- .../ScheduleNowTransformRequest.g.cs | 32 +- .../ScheduleNowTransformResponse.g.cs | 4 +- .../StartTransformRequest.g.cs | 64 +- .../StartTransformResponse.g.cs | 4 +- .../StopTransformRequest.g.cs | 80 +- .../StopTransformResponse.g.cs | 4 +- .../UpdateTransformRequest.g.cs | 169 +- .../UpgradeTransformsRequest.g.cs | 36 +- .../UpgradeTransformsResponse.g.cs | 12 +- .../_Generated/Api/UpdateByQueryRequest.g.cs | 332 +- .../Api/UpdateByQueryRethrottleRequest.g.cs | 16 +- .../_Generated/Api/UpdateRequest.g.cs | 172 +- .../Api/Xpack/XpackInfoRequest.g.cs | 24 +- .../Api/Xpack/XpackUsageRequest.g.cs | 16 +- .../ElasticsearchClient.AsyncSearch.g.cs | 322 +- .../Client/ElasticsearchClient.Ccr.g.cs | 716 +- .../Client/ElasticsearchClient.Cluster.g.cs | 932 ++- .../ElasticsearchClient.DanglingIndices.g.cs | 36 +- .../Client/ElasticsearchClient.Enrich.g.cs | 246 +- .../Client/ElasticsearchClient.Eql.g.cs | 210 +- .../Client/ElasticsearchClient.Esql.g.cs | 60 +- .../Client/ElasticsearchClient.Features.g.cs | 68 +- .../Client/ElasticsearchClient.Graph.g.cs | 76 +- .../Client/ElasticsearchClient.Ilm.g.cs | 476 +- .../Client/ElasticsearchClient.Indices.g.cs | 4550 ++++++++++--- .../Client/ElasticsearchClient.Inference.g.cs | 196 +- .../Client/ElasticsearchClient.Ingest.g.cs | 408 +- .../Client/ElasticsearchClient.License.g.cs | 252 +- .../Client/ElasticsearchClient.Ml.g.cs | 5756 ++++++++++++++--- .../Client/ElasticsearchClient.Nodes.g.cs | 384 +- .../ElasticsearchClient.QueryRules.g.cs | 132 +- .../Client/ElasticsearchClient.Rollup.g.cs | 508 +- ...ElasticsearchClient.SearchApplication.g.cs | 252 +- ...asticsearchClient.SearchableSnapshots.g.cs | 260 +- .../Client/ElasticsearchClient.Slm.g.cs | 308 +- .../Client/ElasticsearchClient.Snapshot.g.cs | 412 +- .../Client/ElasticsearchClient.Sql.g.cs | 316 +- .../Client/ElasticsearchClient.Synonyms.g.cs | 300 +- .../Client/ElasticsearchClient.Tasks.g.cs | 124 +- .../ElasticsearchClient.TextStructure.g.cs | 36 +- .../Client/ElasticsearchClient.Transform.g.cs | 1376 +++- .../Client/ElasticsearchClient.Xpack.g.cs | 68 +- .../Client/ElasticsearchClient.g.cs | 3520 ++++++++-- .../AdjacencyMatrixAggregation.g.cs | 27 +- .../Aggregations/AdjacencyMatrixBucket.g.cs | 4 +- .../Types/Aggregations/Aggregation.g.cs | 15 +- .../Types/Aggregations/AggregationRange.g.cs | 24 +- .../AutoDateHistogramAggregation.g.cs | 109 +- .../Types/Aggregations/AverageAggregate.g.cs | 5 +- .../Aggregations/AverageAggregation.g.cs | 43 +- .../AverageBucketAggregation.g.cs | 26 +- .../Aggregations/BoxplotAggregation.g.cs | 55 +- .../BucketCorrelationAggregation.g.cs | 24 +- .../BucketCorrelationFunction.g.cs | 8 +- ...etCorrelationFunctionCountCorrelation.g.cs | 8 +- ...tionFunctionCountCorrelationIndicator.g.cs | 34 +- .../Aggregations/BucketKsAggregation.g.cs | 74 +- .../BucketMetricValueAggregate.g.cs | 5 +- .../Aggregations/BucketScriptAggregation.g.cs | 34 +- .../BucketSelectorAggregation.g.cs | 34 +- .../Aggregations/BucketSortAggregation.g.cs | 51 +- .../Types/Aggregations/Buckets.g.cs | 5 +- .../Aggregations/CardinalityAggregation.g.cs | 70 +- .../CategorizeTextAggregation.g.cs | 196 +- .../Aggregations/ChiSquareHeuristic.g.cs | 16 +- .../Types/Aggregations/ChildrenAggregate.g.cs | 4 +- .../Aggregations/ChildrenAggregation.g.cs | 8 +- .../Aggregations/CompositeAggregation.g.cs | 39 +- .../CompositeAggregationSource.g.cs | 48 +- .../Types/Aggregations/CompositeBucket.g.cs | 4 +- .../CompositeDateHistogramAggregation.g.cs | 64 +- .../CompositeGeoTileGridAggregation.g.cs | 40 +- .../CompositeHistogramAggregation.g.cs | 40 +- .../CompositeTermsAggregation.g.cs | 40 +- .../CumulativeCardinalityAggregate.g.cs | 4 +- .../CumulativeCardinalityAggregation.g.cs | 26 +- .../CumulativeSumAggregation.g.cs | 26 +- .../DateHistogramAggregation.g.cs | 163 +- .../Aggregations/DateHistogramBucket.g.cs | 4 +- .../Aggregations/DateRangeAggregate.g.cs | 5 +- .../Aggregations/DateRangeAggregation.g.cs | 79 +- .../Aggregations/DateRangeExpression.g.cs | 24 +- .../Aggregations/DerivativeAggregate.g.cs | 5 +- .../Aggregations/DerivativeAggregation.g.cs | 26 +- .../DiversifiedSamplerAggregation.g.cs | 64 +- .../Aggregations/DoubleTermsAggregate.g.cs | 4 +- .../Types/Aggregations/DoubleTermsBucket.g.cs | 4 +- .../Aggregations/ExtendedBoundsDate.g.cs | 16 +- .../Aggregations/ExtendedBoundsFloat.g.cs | 16 +- .../ExtendedStatsAggregation.g.cs | 55 +- .../ExtendedStatsBucketAggregation.g.cs | 34 +- .../Types/Aggregations/FieldDateMath.g.cs | 5 +- .../Types/Aggregations/FilterAggregate.g.cs | 4 +- .../Aggregations/FiltersAggregation.g.cs | 36 +- .../Types/Aggregations/FiltersBucket.g.cs | 4 +- .../FrequentItemSetsAggregation.g.cs | 60 +- .../Aggregations/FrequentItemSetsBucket.g.cs | 4 +- .../Aggregations/FrequentItemSetsField.g.cs | 30 +- .../Aggregations/GeoBoundsAggregation.g.cs | 55 +- .../Aggregations/GeoCentroidAggregation.g.cs | 43 +- .../Aggregations/GeoDistanceAggregate.g.cs | 4 +- .../Aggregations/GeoDistanceAggregation.g.cs | 76 +- .../Aggregations/GeoLineAggregation.g.cs | 66 +- .../Types/Aggregations/GeoLinePoint.g.cs | 28 +- .../Types/Aggregations/GeoLineSort.g.cs | 28 +- .../Aggregations/GeohashGridAggregation.g.cs | 86 +- .../Types/Aggregations/GeohashGridBucket.g.cs | 4 +- .../Aggregations/GeohexGridAggregation.g.cs | 86 +- .../Types/Aggregations/GeohexGridBucket.g.cs | 4 +- .../Aggregations/GeotileGridAggregation.g.cs | 89 +- .../Types/Aggregations/GeotileGridBucket.g.cs | 4 +- .../Types/Aggregations/GlobalAggregate.g.cs | 4 +- .../GoogleNormalizedDistanceHeuristic.g.cs | 8 +- .../Types/Aggregations/HdrMethod.g.cs | 8 +- .../Aggregations/HistogramAggregation.g.cs | 130 +- .../Types/Aggregations/HistogramBucket.g.cs | 4 +- .../Aggregations/InferenceAggregate.g.cs | 4 +- .../Aggregations/InferenceAggregation.g.cs | 63 +- .../Aggregations/IpPrefixAggregation.g.cs | 79 +- .../Types/Aggregations/IpPrefixBucket.g.cs | 4 +- .../Aggregations/IpRangeAggregation.g.cs | 40 +- .../Aggregations/IpRangeAggregationRange.g.cs | 24 +- .../Types/Aggregations/IpRangeBucket.g.cs | 4 +- .../Aggregations/LongRareTermsAggregate.g.cs | 4 +- .../Aggregations/LongRareTermsBucket.g.cs | 4 +- .../Aggregations/LongTermsAggregate.g.cs | 4 +- .../Types/Aggregations/LongTermsBucket.g.cs | 4 +- .../Aggregations/MatrixStatsAggregation.g.cs | 39 +- .../Types/Aggregations/MaxAggregate.g.cs | 5 +- .../Types/Aggregations/MaxAggregation.g.cs | 43 +- .../Aggregations/MaxBucketAggregation.g.cs | 26 +- .../MedianAbsoluteDeviationAggregate.g.cs | 5 +- .../MedianAbsoluteDeviationAggregation.g.cs | 55 +- .../Types/Aggregations/MinAggregate.g.cs | 5 +- .../Types/Aggregations/MinAggregation.g.cs | 43 +- .../Aggregations/MinBucketAggregation.g.cs | 26 +- .../Types/Aggregations/MissingAggregate.g.cs | 4 +- .../Aggregations/MissingAggregation.g.cs | 28 +- .../MovingFunctionAggregation.g.cs | 52 +- .../MovingPercentilesAggregation.g.cs | 44 +- .../Types/Aggregations/MultiTermLookup.g.cs | 43 +- .../Aggregations/MultiTermsAggregation.g.cs | 102 +- .../Types/Aggregations/MultiTermsBucket.g.cs | 4 +- .../MutualInformationHeuristic.g.cs | 16 +- .../Types/Aggregations/NestedAggregate.g.cs | 4 +- .../Types/Aggregations/NestedAggregation.g.cs | 28 +- .../Aggregations/NormalizeAggregation.g.cs | 34 +- .../Types/Aggregations/ParentAggregate.g.cs | 4 +- .../Types/Aggregations/ParentAggregation.g.cs | 8 +- .../PercentileRanksAggregation.g.cs | 79 +- .../Aggregations/PercentilesAggregation.g.cs | 79 +- .../PercentilesBucketAggregation.g.cs | 34 +- .../Types/Aggregations/RangeAggregation.g.cs | 55 +- .../Types/Aggregations/RangeBucket.g.cs | 8 +- .../Aggregations/RareTermsAggregation.g.cs | 94 +- .../Types/Aggregations/RateAggregation.g.cs | 70 +- .../Aggregations/ReverseNestedAggregate.g.cs | 4 +- .../ReverseNestedAggregation.g.cs | 35 +- .../Types/Aggregations/SamplerAggregate.g.cs | 4 +- .../Aggregations/SamplerAggregation.g.cs | 8 +- .../ScriptedMetricAggregation.g.cs | 118 +- .../SerialDifferencingAggregation.g.cs | 36 +- .../SignificantLongTermsBucket.g.cs | 4 +- .../SignificantStringTermsBucket.g.cs | 4 +- .../SignificantTermsAggregation.g.cs | 202 +- .../SignificantTextAggregation.g.cs | 226 +- .../Aggregations/SimpleValueAggregate.g.cs | 5 +- .../Types/Aggregations/StatsAggregate.g.cs | 5 +- .../Types/Aggregations/StatsAggregation.g.cs | 43 +- .../Aggregations/StatsBucketAggregation.g.cs | 26 +- .../StringRareTermsAggregate.g.cs | 4 +- .../Aggregations/StringRareTermsBucket.g.cs | 4 +- .../Aggregations/StringStatsAggregation.g.cs | 55 +- .../Aggregations/StringTermsAggregate.g.cs | 4 +- .../Types/Aggregations/StringTermsBucket.g.cs | 4 +- .../Types/Aggregations/SumAggregate.g.cs | 9 +- .../Types/Aggregations/SumAggregation.g.cs | 43 +- .../Aggregations/SumBucketAggregation.g.cs | 26 +- .../Types/Aggregations/TDigest.g.cs | 8 +- .../Types/Aggregations/TTestAggregation.g.cs | 36 +- .../Types/Aggregations/TermsAggregation.g.cs | 190 +- .../Types/Aggregations/TestPopulation.g.cs | 40 +- .../Aggregations/TopHitsAggregation.g.cs | 205 +- .../Aggregations/TopMetricsAggregation.g.cs | 79 +- .../Types/Aggregations/TopMetricsValue.g.cs | 28 +- .../UnmappedRareTermsAggregate.g.cs | 4 +- .../UnmappedSamplerAggregate.g.cs | 4 +- .../UnmappedSignificantTermsAggregate.g.cs | 4 +- .../Aggregations/UnmappedTermsAggregate.g.cs | 4 +- .../Aggregations/ValueCountAggregate.g.cs | 9 +- .../Aggregations/ValueCountAggregation.g.cs | 43 +- .../VariableWidthHistogramAggregation.g.cs | 70 +- .../VariableWidthHistogramBucket.g.cs | 4 +- .../WeightedAverageAggregate.g.cs | 9 +- .../WeightedAverageAggregation.g.cs | 36 +- .../Aggregations/WeightedAverageValue.g.cs | 40 +- .../Types/AsyncSearch/AsyncSearch.g.cs | 14 +- .../Types/Cluster/CharFilterTypes.g.cs | 32 +- .../Types/Cluster/ClusterFileSystem.g.cs | 14 +- .../Types/Cluster/ClusterIndices.g.cs | 44 +- .../Types/Cluster/ClusterIndicesShards.g.cs | 20 +- .../Cluster/ClusterIndicesShardsIndex.g.cs | 12 +- .../_Generated/Types/Cluster/ClusterJvm.g.cs | 16 +- .../Types/Cluster/ClusterJvmMemory.g.cs | 8 +- .../Types/Cluster/ClusterJvmVersion.g.cs | 29 +- .../Types/Cluster/ClusterNetworkTypes.g.cs | 8 +- .../Types/Cluster/ClusterNodes.g.cs | 41 +- .../Types/Cluster/ClusterOperatingSystem.g.cs | 26 +- .../ClusterOperatingSystemArchitecture.g.cs | 8 +- .../Cluster/ClusterOperatingSystemName.g.cs | 8 +- .../ClusterOperatingSystemPrettyName.g.cs | 8 +- .../Types/Cluster/ClusterProcess.g.cs | 8 +- .../Types/Cluster/ClusterProcessCpu.g.cs | 5 +- .../ClusterProcessOpenFileDescriptors.g.cs | 15 +- .../Types/Cluster/ClusterShardMetrics.g.cs | 12 +- .../_Generated/Types/Cluster/FieldTypes.g.cs | 28 +- .../Types/Cluster/FieldTypesMappings.g.cs | 24 +- .../Types/Cluster/NodePackagingType.g.cs | 12 +- .../Cluster/OperatingSystemMemoryInfo.g.cs | 24 +- .../_Generated/Types/Cluster/PendingTask.g.cs | 25 +- .../Types/Cluster/RuntimeFieldTypes.g.cs | 56 +- .../_Generated/Types/CompletionStats.g.cs | 8 +- .../Types/Core/Bulk/ResponseItem.g.cs | 41 +- .../_Generated/Types/Core/Context.g.cs | 4 +- .../Types/Core/FieldCaps/FieldCapability.g.cs | 47 +- .../Core/HealthReport/DiskIndicator.g.cs | 4 +- .../Types/Core/HealthReport/IlmIndicator.g.cs | 4 +- .../HealthReport/MasterIsStableIndicator.g.cs | 4 +- .../RepositoryIntegrityIndicator.g.cs | 4 +- .../ShardsAvailabilityIndicator.g.cs | 4 +- .../HealthReport/ShardsCapacityIndicator.g.cs | 4 +- .../Types/Core/HealthReport/SlmIndicator.g.cs | 4 +- .../Types/Core/MGet/MultiGetOperation.g.cs | 60 +- .../Types/Core/MSearch/MultisearchBody.g.cs | 333 +- .../Types/Core/MSearch/MultisearchHeader.g.cs | 8 +- .../Core/MSearchTemplate/TemplateConfig.g.cs | 25 +- .../MultiTermVectorsOperation.g.cs | 159 +- .../Types/Core/RankEval/DocumentRating.g.cs | 24 +- .../Core/RankEval/RankEvalMetricDetail.g.cs | 16 +- ...ankEvalMetricDiscountedCumulativeGain.g.cs | 24 +- .../RankEvalMetricExpectedReciprocalRank.g.cs | 24 +- .../RankEvalMetricMeanReciprocalRank.g.cs | 24 +- .../RankEval/RankEvalMetricPrecision.g.cs | 32 +- .../Core/RankEval/RankEvalMetricRecall.g.cs | 24 +- .../Core/RankEval/RankEvalRequestItem.g.cs | 60 +- .../Types/Core/Reindex/Destination.g.cs | 44 +- .../Types/Core/Reindex/RemoteSource.g.cs | 50 +- .../_Generated/Types/Core/Reindex/Source.g.cs | 81 +- .../Core/ReindexRethrottle/ReindexStatus.g.cs | 45 +- .../PainlessContextSetup.g.cs | 39 +- .../Types/Core/Search/CompletionContext.g.cs | 50 +- .../Core/Search/CompletionSuggester.g.cs | 110 +- .../Types/Core/Search/DirectGenerator.g.cs | 185 +- .../Types/Core/Search/FieldCollapse.g.cs | 52 +- .../Types/Core/Search/FieldSuggester.g.cs | 39 +- .../Types/Core/Search/Highlight.g.cs | 252 +- .../Types/Core/Search/HighlightField.g.cs | 252 +- .../Types/Core/Search/HitsMetadata.g.cs | 4 +- .../Types/Core/Search/InnerHits.g.cs | 54 +- .../Core/Search/LaplaceSmoothingModel.g.cs | 8 +- .../Types/Core/Search/LearningToRank.g.cs | 16 +- .../Core/Search/PhraseSuggestCollate.g.cs | 24 +- .../Search/PhraseSuggestCollateQuery.g.cs | 16 +- .../Core/Search/PhraseSuggestHighlight.g.cs | 16 +- .../Types/Core/Search/PhraseSuggester.g.cs | 215 +- .../Types/Core/Search/RegexOptions.g.cs | 16 +- .../Types/Core/Search/RescoreQuery.g.cs | 51 +- .../Search/StupidBackoffSmoothingModel.g.cs | 8 +- .../Types/Core/Search/SuggestFuzziness.g.cs | 42 +- .../Types/Core/Search/Suggester.g.cs | 24 +- .../Types/Core/Search/TermSuggester.g.cs | 221 +- .../_Generated/Types/Core/SourceConfig.g.cs | 4 +- .../Types/Core/SourceConfigParam.g.cs | 5 +- .../Types/Core/TermVectors/Filter.g.cs | 62 +- .../_Generated/Types/Core/TrackHits.g.cs | 7 +- .../AutoFollowPatternSummary.g.cs | 20 +- .../_Generated/Types/DocStats.g.cs | 11 +- .../Types/ElasticsearchVersionMinInfo.g.cs | 4 +- .../_Generated/Types/EmptyObject.g.cs | 8 +- .../Types/Enums/Enums.Aggregations.g.cs | 98 +- .../Types/Enums/Enums.Core.Search.g.cs | 87 +- .../_Generated/Types/Enums/Enums.Eql.g.cs | 8 +- .../Types/Enums/Enums.IndexManagement.g.cs | 50 +- .../_Generated/Types/Enums/Enums.Ingest.g.cs | 8 +- .../Types/Enums/Enums.MachineLearning.g.cs | 113 +- .../_Generated/Types/Enums/Enums.Mapping.g.cs | 5 +- .../Types/Enums/Enums.NoNamespace.g.cs | 127 +- .../Types/Enums/Enums.QueryDsl.g.cs | 222 +- .../Types/Enums/Enums.Snapshot.g.cs | 20 +- .../_Generated/Types/Enums/Enums.Tasks.g.cs | 12 +- .../_Generated/Types/Eql/EqlHits.g.cs | 12 +- .../_Generated/Types/Eql/HitsEvent.g.cs | 16 +- .../_Generated/Types/Eql/HitsSequence.g.cs | 8 +- .../_Generated/Types/ErrorCause.g.cs | 21 +- .../_Generated/Types/ErrorResponseBase.g.cs | 4 +- .../_Generated/Types/GeoBounds.g.cs | 26 +- .../_Generated/Types/GeoLine.g.cs | 12 +- .../_Generated/Types/GeoLocation.g.cs | 26 +- .../_Generated/Types/GeohashPrecision.g.cs | 4 +- .../Types/Graph/ExploreControls.g.cs | 66 +- .../_Generated/Types/Graph/Hop.g.cs | 36 +- .../Types/Graph/VertexDefinition.g.cs | 91 +- .../IndexLifecycleManagement/Actions.g.cs | 96 +- .../Types/IndexManagement/AddAction.g.cs | 159 +- .../Types/IndexManagement/Alias.g.cs | 81 +- .../IndexManagement/AliasDefinition.g.cs | 27 +- .../Types/IndexManagement/DataStream.g.cs | 67 +- .../IndexManagement/DataStreamIndex.g.cs | 20 +- .../IndexManagement/DataStreamLifecycle.g.cs | 8 +- .../DataStreamLifecycleDownsampling.g.cs | 8 +- .../DataStreamLifecycleWithRollover.g.cs | 21 +- .../DataStreamTimestampField.g.cs | 4 +- .../IndexManagement/DataStreamsStatsItem.g.cs | 25 +- .../IndexManagement/DownsampleConfig.g.cs | 8 +- .../IndexManagement/DownsamplingRound.g.cs | 16 +- .../IndexManagement/ExplainAnalyzeToken.g.cs | 4 +- .../IndexAndDataStreamAction.g.cs | 16 +- .../Types/IndexManagement/IndexSettings.g.cs | 72 +- .../IndexSettingsLifecycle.g.cs | 56 +- .../IndexSettingsLifecycleStep.g.cs | 10 +- .../Types/IndexManagement/IndexState.g.cs | 24 +- .../Types/IndexManagement/IndexStats.g.cs | 68 +- .../Types/IndexManagement/IndexTemplate.g.cs | 37 +- .../IndexTemplateDataStreamConfiguration.g.cs | 8 +- .../IndexManagement/IndexTemplateMapping.g.cs | 48 +- .../IndexManagement/IndexTemplateSummary.g.cs | 16 +- .../IndexingPressureMemory.g.cs | 12 +- .../IndexingSlowlogTresholds.g.cs | 10 +- .../IndexManagement/MappingLimitSettings.g.cs | 8 +- .../MappingLimitSettingsDepth.g.cs | 10 +- .../MappingLimitSettingsDimensionFields.g.cs | 10 +- .../MappingLimitSettingsFieldNameLength.g.cs | 12 +- .../MappingLimitSettingsNestedFields.g.cs | 12 +- .../MappingLimitSettingsNestedObjects.g.cs | 10 +- .../MappingLimitSettingsTotalFields.g.cs | 28 +- .../Types/IndexManagement/RemoveAction.g.cs | 48 +- .../IndexManagement/RemoveIndexAction.g.cs | 28 +- .../IndexManagement/ResolveClusterInfo.g.cs | 26 +- .../Types/IndexManagement/SoftDeletes.g.cs | 22 +- .../Types/IndexManagement/Storage.g.cs | 14 +- .../Types/IndexManagement/Translog.g.cs | 34 +- .../IndexManagement/TranslogRetention.g.cs | 32 +- .../_Generated/Types/IndicesOptions.g.cs | 50 +- .../Types/Inference/InferenceEndpoint.g.cs | 32 +- .../Inference/InferenceEndpointInfo.g.cs | 24 +- .../Types/Ingest/AppendProcessor.g.cs | 125 +- .../Types/Ingest/AttachmentProcessor.g.cs | 219 +- .../Types/Ingest/BytesProcessor.g.cs | 141 +- .../Types/Ingest/CircleProcessor.g.cs | 165 +- .../Types/Ingest/ConvertProcessor.g.cs | 153 +- .../_Generated/Types/Ingest/CsvProcessor.g.cs | 172 +- .../Types/Ingest/DateIndexNameProcessor.g.cs | 184 +- .../Types/Ingest/DateProcessor.g.cs | 167 +- .../Types/Ingest/DissectProcessor.g.cs | 130 +- .../_Generated/Types/Ingest/Document.g.cs | 26 +- .../Types/Ingest/DocumentSimulation.g.cs | 24 +- .../Types/Ingest/DotExpanderProcessor.g.cs | 116 +- .../Types/Ingest/DropProcessor.g.cs | 66 +- .../Types/Ingest/EnrichProcessor.g.cs | 208 +- .../Types/Ingest/FailProcessor.g.cs | 81 +- .../Types/Ingest/ForeachProcessor.g.cs | 118 +- .../Types/Ingest/GeoIpDownloadStatistics.g.cs | 20 +- .../Types/Ingest/GeoIpNodeDatabaseName.g.cs | 4 +- .../Types/Ingest/GeoIpNodeDatabases.g.cs | 12 +- .../Types/Ingest/GeoIpProcessor.g.cs | 170 +- .../Types/Ingest/GrokProcessor.g.cs | 148 +- .../Types/Ingest/GsubProcessor.g.cs | 165 +- .../Ingest/InferenceConfigClassification.g.cs | 95 +- .../Ingest/InferenceConfigRegression.g.cs | 40 +- .../Types/Ingest/InferenceProcessor.g.cs | 133 +- .../Types/Ingest/JoinProcessor.g.cs | 141 +- .../Types/Ingest/JsonProcessor.g.cs | 177 +- .../Types/Ingest/KeyValueProcessor.g.cs | 254 +- .../Types/Ingest/LowercaseProcessor.g.cs | 141 +- .../_Generated/Types/Ingest/Pipeline.g.cs | 63 +- .../Types/Ingest/PipelineProcessor.g.cs | 93 +- .../Types/Ingest/RemoveProcessor.g.cs | 102 +- .../Types/Ingest/RenameProcessor.g.cs | 148 +- .../Types/Ingest/RerouteProcessor.g.cs | 171 +- .../Types/Ingest/ScriptProcessor.g.cs | 120 +- .../_Generated/Types/Ingest/SetProcessor.g.cs | 199 +- .../Ingest/SetSecurityUserProcessor.g.cs | 106 +- .../Types/Ingest/SortProcessor.g.cs | 144 +- .../Types/Ingest/SplitProcessor.g.cs | 165 +- .../Types/Ingest/TrimProcessor.g.cs | 141 +- .../Types/Ingest/UppercaseProcessor.g.cs | 141 +- .../Types/Ingest/UrlDecodeProcessor.g.cs | 141 +- .../Types/Ingest/UserAgentProcessor.g.cs | 146 +- .../_Generated/Types/InlineGet.g.cs | 4 +- .../_Generated/Types/KnnQuery.g.cs | 109 +- .../_Generated/Types/KnnRetriever.g.cs | 84 +- .../_Generated/Types/KnnSearch.g.cs | 124 +- .../_Generated/Types/LatLonGeoLocation.g.cs | 16 +- .../Types/MachineLearning/AnalysisConfig.g.cs | 167 +- .../MachineLearning/AnalysisConfigRead.g.cs | 67 +- .../Types/MachineLearning/AnalysisLimits.g.cs | 16 +- .../MachineLearning/AnalysisMemoryLimit.g.cs | 8 +- .../Types/MachineLearning/Anomaly.g.cs | 96 +- .../MachineLearning/AnomalyExplanation.g.cs | 40 +- .../MachineLearning/ApiKeyAuthorization.g.cs | 8 +- .../MachineLearning/BucketInfluencer.g.cs | 48 +- .../Types/MachineLearning/BucketSummary.g.cs | 45 +- .../Types/MachineLearning/Calendar.g.cs | 12 +- .../Types/MachineLearning/CalendarEvent.g.cs | 32 +- .../CategorizationAnalyzerDefinition.g.cs | 24 +- .../Types/MachineLearning/Category.g.cs | 44 +- .../Types/MachineLearning/ChunkingConfig.g.cs | 22 +- .../ClassificationInferenceOptions.g.cs | 40 +- .../ConfusionMatrixThreshold.g.cs | 16 +- .../MachineLearning/DataDescription.g.cs | 52 +- .../Types/MachineLearning/Datafeed.g.cs | 4 +- .../DatafeedAuthorization.g.cs | 12 +- .../Types/MachineLearning/DatafeedConfig.g.cs | 156 +- .../MachineLearning/DatafeedRunningState.g.cs | 13 +- .../Types/MachineLearning/DatafeedStats.g.cs | 27 +- .../MachineLearning/DatafeedTimingStats.g.cs | 24 +- .../DataframeAnalysisAnalyzedFields.g.cs | 16 +- .../DataframeAnalysisClassification.g.cs | 250 +- ...ysisFeatureProcessorFrequencyEncoding.g.cs | 24 +- ...AnalysisFeatureProcessorMultiEncoding.g.cs | 8 +- ...AnalysisFeatureProcessorNGramEncoding.g.cs | 76 +- ...nalysisFeatureProcessorOneHotEncoding.g.cs | 40 +- ...sisFeatureProcessorTargetMeanEncoding.g.cs | 64 +- .../DataframeAnalysisOutlierDetection.g.cs | 48 +- .../DataframeAnalysisRegression.g.cs | 262 +- .../MachineLearning/DataframeAnalytics.g.cs | 28 +- .../DataframeAnalyticsAuthorization.g.cs | 12 +- .../DataframeAnalyticsDestination.g.cs | 40 +- .../DataframeAnalyticsFieldSelection.g.cs | 24 +- .../DataframeAnalyticsMemoryEstimation.g.cs | 8 +- .../DataframeAnalyticsSource.g.cs | 48 +- .../DataframeAnalyticsStatsDataCounts.g.cs | 12 +- .../DataframeAnalyticsStatsMemoryUsage.g.cs | 16 +- .../DataframeAnalyticsStatsProgress.g.cs | 8 +- .../DataframeAnalyticsSummary.g.cs | 4 +- .../DataframeClassificationSummary.g.cs | 21 +- .../DataframeEvaluationClassification.g.cs | 96 +- ...aframeEvaluationClassificationMetrics.g.cs | 40 +- ...EvaluationClassificationMetricsAucRoc.g.cs | 16 +- .../DataframeEvaluationOutlierDetection.g.cs | 68 +- ...rameEvaluationOutlierDetectionMetrics.g.cs | 32 +- .../DataframeEvaluationRegression.g.cs | 68 +- .../DataframeEvaluationRegressionMetrics.g.cs | 32 +- ...frameEvaluationRegressionMetricsHuber.g.cs | 8 +- ...aframeEvaluationRegressionMetricsMsle.g.cs | 8 +- .../DataframeOutlierDetectionSummary.g.cs | 16 +- .../DataframeRegressionSummary.g.cs | 16 +- .../Types/MachineLearning/Definition.g.cs | 16 +- .../DelayedDataCheckConfig.g.cs | 20 +- .../Types/MachineLearning/DetectionRule.g.cs | 36 +- .../Types/MachineLearning/Detector.g.cs | 184 +- .../Types/MachineLearning/DetectorRead.g.cs | 53 +- .../FillMaskInferenceOptions.g.cs | 48 +- .../FillMaskInferenceUpdateOptions.g.cs | 24 +- .../Types/MachineLearning/Filter.g.cs | 12 +- .../Types/MachineLearning/FilterRef.g.cs | 16 +- .../Types/MachineLearning/GeoResults.g.cs | 8 +- .../Types/MachineLearning/Hyperparameter.g.cs | 20 +- .../InferenceConfigCreate.g.cs | 4 +- .../InferenceResponseResult.g.cs | 46 +- .../Types/MachineLearning/Influencer.g.cs | 51 +- .../_Generated/Types/MachineLearning/Job.g.cs | 114 +- .../Types/MachineLearning/JobStats.g.cs | 44 +- .../Types/MachineLearning/JvmStats.g.cs | 24 +- .../Types/MachineLearning/MemMlStats.g.cs | 40 +- .../Types/MachineLearning/MemStats.g.cs | 22 +- .../Types/MachineLearning/Memory.g.cs | 20 +- .../MachineLearning/ModelPlotConfig.g.cs | 52 +- .../Types/MachineLearning/ModelSnapshot.g.cs | 40 +- .../MachineLearning/NerInferenceOptions.g.cs | 32 +- .../NerInferenceUpdateOptions.g.cs | 16 +- .../NlpBertTokenizationConfig.g.cs | 48 +- .../NlpRobertaTokenizationConfig.g.cs | 48 +- .../NlpTokenizationUpdateOptions.g.cs | 16 +- .../Types/MachineLearning/OverallBucket.g.cs | 28 +- .../Types/MachineLearning/Page.g.cs | 16 +- .../PassThroughInferenceOptions.g.cs | 24 +- .../PassThroughInferenceUpdateOptions.g.cs | 16 +- .../PerPartitionCategorization.g.cs | 16 +- .../QuestionAnsweringInferenceOptions.g.cs | 40 +- ...estionAnsweringInferenceUpdateOptions.g.cs | 40 +- .../RegressionInferenceOptions.g.cs | 40 +- .../Types/MachineLearning/RuleCondition.g.cs | 24 +- .../RunningStateSearchInterval.g.cs | 16 +- .../TextClassificationInferenceOptions.g.cs | 40 +- ...tClassificationInferenceUpdateOptions.g.cs | 32 +- .../TextEmbeddingInferenceOptions.g.cs | 32 +- .../TextEmbeddingInferenceUpdateOptions.g.cs | 8 +- .../TextExpansionInferenceOptions.g.cs | 24 +- .../TextExpansionInferenceUpdateOptions.g.cs | 8 +- .../MachineLearning/TokenizationConfig.g.cs | 4 +- .../TotalFeatureImportance.g.cs | 12 +- .../TotalFeatureImportanceClass.g.cs | 8 +- .../TotalFeatureImportanceStatistics.g.cs | 12 +- .../Types/MachineLearning/TrainedModel.g.cs | 50 +- .../TrainedModelAssignment.g.cs | 12 +- .../TrainedModelAssignmentRoutingTable.g.cs | 17 +- .../TrainedModelAssignmentTaskParameters.g.cs | 28 +- .../MachineLearning/TrainedModelConfig.g.cs | 60 +- .../TrainedModelConfigInput.g.cs | 4 +- .../TrainedModelConfigMetadata.g.cs | 12 +- ...rainedModelDeploymentAllocationStatus.g.cs | 12 +- .../TrainedModelDeploymentNodesStats.g.cs | 48 +- .../TrainedModelDeploymentStats.g.cs | 61 +- .../TrainedModelInferenceStats.g.cs | 24 +- .../TrainedModelPrefixStrings.g.cs | 16 +- .../TrainedModelSizeStats.g.cs | 8 +- .../MachineLearning/TrainedModelStats.g.cs | 26 +- .../TransformAuthorization.g.cs | 12 +- ...eroShotClassificationInferenceOptions.g.cs | 58 +- ...tClassificationInferenceUpdateOptions.g.cs | 32 +- .../AggregateMetricDoubleProperty.g.cs | 12 +- .../Types/Mapping/BinaryProperty.g.cs | 12 +- .../Types/Mapping/BooleanProperty.g.cs | 12 +- .../Types/Mapping/ByteNumberProperty.g.cs | 36 +- .../Types/Mapping/CompletionProperty.g.cs | 12 +- .../Mapping/ConstantKeywordProperty.g.cs | 12 +- .../Types/Mapping/DateNanosProperty.g.cs | 12 +- .../Types/Mapping/DateProperty.g.cs | 12 +- .../Types/Mapping/DateRangeProperty.g.cs | 12 +- .../Types/Mapping/DenseVectorProperty.g.cs | 12 +- .../Types/Mapping/DoubleNumberProperty.g.cs | 36 +- .../Types/Mapping/DoubleRangeProperty.g.cs | 12 +- .../Types/Mapping/DynamicProperty.g.cs | 12 +- .../Types/Mapping/FieldAliasProperty.g.cs | 12 +- .../Types/Mapping/FlattenedProperty.g.cs | 12 +- .../Types/Mapping/FloatNumberProperty.g.cs | 36 +- .../Types/Mapping/FloatRangeProperty.g.cs | 12 +- .../Types/Mapping/GeoPointProperty.g.cs | 12 +- .../Types/Mapping/GeoShapeProperty.g.cs | 27 +- .../Mapping/HalfFloatNumberProperty.g.cs | 36 +- .../Types/Mapping/HistogramProperty.g.cs | 12 +- .../Types/Mapping/IcuCollationProperty.g.cs | 36 +- .../Types/Mapping/IntegerNumberProperty.g.cs | 36 +- .../Types/Mapping/IntegerRangeProperty.g.cs | 12 +- .../_Generated/Types/Mapping/IpProperty.g.cs | 24 +- .../Types/Mapping/IpRangeProperty.g.cs | 12 +- .../Types/Mapping/JoinProperty.g.cs | 12 +- .../Types/Mapping/KeywordProperty.g.cs | 24 +- .../Types/Mapping/LongNumberProperty.g.cs | 36 +- .../Types/Mapping/LongRangeProperty.g.cs | 12 +- .../Types/Mapping/MatchOnlyTextProperty.g.cs | 66 +- .../Types/Mapping/Murmur3HashProperty.g.cs | 12 +- .../Types/Mapping/NestedProperty.g.cs | 12 +- .../Types/Mapping/ObjectProperty.g.cs | 12 +- .../Types/Mapping/PercolatorProperty.g.cs | 12 +- .../Types/Mapping/PointProperty.g.cs | 12 +- .../Types/Mapping/RankFeatureProperty.g.cs | 12 +- .../Types/Mapping/RankFeaturesProperty.g.cs | 12 +- .../Types/Mapping/RuntimeField.g.cs | 116 +- .../Mapping/ScaledFloatNumberProperty.g.cs | 36 +- .../Mapping/SearchAsYouTypeProperty.g.cs | 12 +- .../Types/Mapping/ShapeProperty.g.cs | 27 +- .../Types/Mapping/ShortNumberProperty.g.cs | 36 +- .../Types/Mapping/SparseVectorProperty.g.cs | 12 +- .../Types/Mapping/TextProperty.g.cs | 12 +- .../Types/Mapping/TokenCountProperty.g.cs | 12 +- .../Mapping/UnsignedLongNumberProperty.g.cs | 36 +- .../Types/Mapping/VersionProperty.g.cs | 12 +- .../Types/Mapping/WildcardProperty.g.cs | 12 +- .../_Generated/Types/NodeAttributes.g.cs | 20 +- .../_Generated/Types/NodeStatistics.g.cs | 16 +- .../Types/Nodes/AdaptiveSelection.g.cs | 28 +- .../_Generated/Types/Nodes/Breaker.g.cs | 24 +- .../_Generated/Types/Nodes/Cgroup.g.cs | 12 +- .../_Generated/Types/Nodes/CgroupCpu.g.cs | 16 +- .../_Generated/Types/Nodes/CgroupCpuStat.g.cs | 12 +- .../_Generated/Types/Nodes/CgroupMemory.g.cs | 15 +- .../_Generated/Types/Nodes/Client.g.cs | 46 +- .../Types/Nodes/ClusterStateQueue.g.cs | 12 +- .../Types/Nodes/ClusterStateUpdate.g.cs | 64 +- .../_Generated/Types/Nodes/CpuAcct.g.cs | 8 +- .../_Generated/Types/Nodes/DataPathStats.g.cs | 36 +- .../_Generated/Types/Nodes/Discovery.g.cs | 15 +- .../Types/Nodes/ExtendedMemoryStats.g.cs | 25 +- .../_Generated/Types/Nodes/FileSystem.g.cs | 17 +- .../Types/Nodes/FileSystemTotal.g.cs | 28 +- .../Types/Nodes/GarbageCollector.g.cs | 4 +- .../Types/Nodes/GarbageCollectorTotal.g.cs | 12 +- .../_Generated/Types/Nodes/Http.g.cs | 13 +- .../Types/Nodes/IndexingPressure.g.cs | 4 +- .../Types/Nodes/IndexingPressureMemory.g.cs | 18 +- .../_Generated/Types/Nodes/Ingest.g.cs | 8 +- .../_Generated/Types/Nodes/IngestTotal.g.cs | 20 +- .../_Generated/Types/Nodes/IoStatDevice.g.cs | 24 +- .../_Generated/Types/Nodes/IoStats.g.cs | 9 +- .../_Generated/Types/Nodes/Jvm.g.cs | 33 +- .../_Generated/Types/Nodes/JvmClasses.g.cs | 12 +- .../Types/Nodes/JvmMemoryStats.g.cs | 28 +- .../_Generated/Types/Nodes/JvmThreads.g.cs | 8 +- .../_Generated/Types/Nodes/MemoryStats.g.cs | 17 +- .../Types/Nodes/NodeBufferPool.g.cs | 20 +- .../_Generated/Types/Nodes/NodeInfo.g.cs | 32 +- .../Types/Nodes/NodeInfoDiscover.g.cs | 4 +- .../Types/Nodes/NodeOperatingSystemInfo.g.cs | 24 +- .../Types/Nodes/NodeProcessInfo.g.cs | 12 +- .../_Generated/Types/Nodes/Pool.g.cs | 16 +- .../Types/Nodes/PressureMemory.g.cs | 54 +- .../_Generated/Types/Nodes/Process.g.cs | 21 +- .../_Generated/Types/Nodes/Processor.g.cs | 16 +- .../Types/Nodes/PublishedClusterStates.g.cs | 12 +- .../Types/Nodes/RepositoryLocation.g.cs | 8 +- .../Nodes/RepositoryMeteringInformation.g.cs | 41 +- .../_Generated/Types/Nodes/RequestCounts.g.cs | 46 +- .../_Generated/Types/Nodes/ScriptCache.g.cs | 12 +- .../_Generated/Types/Nodes/Scripting.g.cs | 16 +- .../Types/Nodes/SerializedClusterState.g.cs | 4 +- .../_Generated/Types/Nodes/Stats.g.cs | 81 +- .../_Generated/Types/Nodes/ThreadCount.g.cs | 24 +- .../_Generated/Types/Nodes/Transport.g.cs | 42 +- .../Types/Nodes/TransportHistogram.g.cs | 13 +- .../_Generated/Types/QueryCacheStats.g.cs | 33 +- .../_Generated/Types/QueryDsl/BoolQuery.g.cs | 87 +- .../Types/QueryDsl/BoostingQuery.g.cs | 57 +- .../Types/QueryDsl/CombinedFieldsQuery.g.cs | 96 +- .../Types/QueryDsl/ConstantScoreQuery.g.cs | 39 +- .../Types/QueryDsl/DateDecayFunction.g.cs | 12 +- .../QueryDsl/DateDistanceFeatureQuery.g.cs | 106 +- .../Types/QueryDsl/DateRangeQuery.g.cs | 105 +- .../Types/QueryDsl/DecayPlacement.g.cs | 16 +- .../Types/QueryDsl/DisMaxQuery.g.cs | 51 +- .../Types/QueryDsl/ExistsQuery.g.cs | 49 +- .../Types/QueryDsl/FieldAndFormat.g.cs | 52 +- .../Types/QueryDsl/FieldLookup.g.cs | 64 +- .../FieldValueFactorScoreFunction.g.cs | 67 +- .../Types/QueryDsl/FunctionScoreQuery.g.cs | 93 +- .../_Generated/Types/QueryDsl/FuzzyQuery.g.cs | 93 +- .../Types/QueryDsl/GeoBoundingBoxQuery.g.cs | 51 +- .../Types/QueryDsl/GeoDecayFunction.g.cs | 12 +- .../QueryDsl/GeoDistanceFeatureQuery.g.cs | 106 +- .../Types/QueryDsl/GeoDistanceQuery.g.cs | 81 +- .../Types/QueryDsl/GeoShapeFieldQuery.g.cs | 24 +- .../Types/QueryDsl/GeoShapeQuery.g.cs | 36 +- .../Types/QueryDsl/HasChildQuery.g.cs | 114 +- .../Types/QueryDsl/HasParentQuery.g.cs | 87 +- .../_Generated/Types/QueryDsl/IdsQuery.g.cs | 22 +- .../Types/QueryDsl/IntervalsAllOf.g.cs | 51 +- .../Types/QueryDsl/IntervalsAnyOf.g.cs | 24 +- .../Types/QueryDsl/IntervalsFuzzy.g.cs | 95 +- .../Types/QueryDsl/IntervalsMatch.g.cs | 98 +- .../Types/QueryDsl/IntervalsPrefix.g.cs | 59 +- .../Types/QueryDsl/IntervalsQuery.g.cs | 21 +- .../Types/QueryDsl/IntervalsWildcard.g.cs | 62 +- .../_Generated/Types/QueryDsl/Like.g.cs | 4 +- .../Types/QueryDsl/LikeDocument.g.cs | 48 +- .../Types/QueryDsl/MatchAllQuery.g.cs | 14 +- .../Types/QueryDsl/MatchBoolPrefixQuery.g.cs | 153 +- .../Types/QueryDsl/MatchNoneQuery.g.cs | 14 +- .../QueryDsl/MatchPhrasePrefixQuery.g.cs | 81 +- .../Types/QueryDsl/MatchPhraseQuery.g.cs | 69 +- .../_Generated/Types/QueryDsl/MatchQuery.g.cs | 165 +- .../Types/QueryDsl/MoreLikeThisQuery.g.cs | 219 +- .../Types/QueryDsl/MultiMatchQuery.g.cs | 219 +- .../Types/QueryDsl/NestedQuery.g.cs | 97 +- .../Types/QueryDsl/NumberRangeQuery.g.cs | 81 +- .../Types/QueryDsl/NumericDecayFunction.g.cs | 12 +- .../Types/QueryDsl/ParentIdQuery.g.cs | 38 +- .../Types/QueryDsl/PercolateQuery.g.cs | 145 +- .../_Generated/Types/QueryDsl/PinnedDoc.g.cs | 16 +- .../Types/QueryDsl/PinnedQuery.g.cs | 33 +- .../Types/QueryDsl/PrefixQuery.g.cs | 60 +- .../Types/QueryDsl/QueryStringQuery.g.cs | 345 +- .../RankFeatureFunctionLogarithm.g.cs | 8 +- .../RankFeatureFunctionSaturation.g.cs | 8 +- .../QueryDsl/RankFeatureFunctionSigmoid.g.cs | 16 +- .../Types/QueryDsl/RankFeatureQuery.g.cs | 97 +- .../Types/QueryDsl/RegexpQuery.g.cs | 84 +- .../_Generated/Types/QueryDsl/RuleQuery.g.cs | 21 +- .../Types/QueryDsl/ScriptQuery.g.cs | 24 +- .../Types/QueryDsl/ScriptScoreFunction.g.cs | 8 +- .../Types/QueryDsl/ScriptScoreQuery.g.cs | 60 +- .../Types/QueryDsl/ShapeFieldQuery.g.cs | 36 +- .../_Generated/Types/QueryDsl/ShapeQuery.g.cs | 33 +- .../QueryDsl/SimpleQueryStringQuery.g.cs | 186 +- .../Types/QueryDsl/SpanContainingQuery.g.cs | 51 +- .../Types/QueryDsl/SpanFieldMaskingQuery.g.cs | 21 +- .../Types/QueryDsl/SpanFirstQuery.g.cs | 45 +- .../Types/QueryDsl/SpanMultiTermQuery.g.cs | 33 +- .../Types/QueryDsl/SpanNearQuery.g.cs | 57 +- .../Types/QueryDsl/SpanNotQuery.g.cs | 84 +- .../Types/QueryDsl/SpanOrQuery.g.cs | 33 +- .../Types/QueryDsl/SpanTermQuery.g.cs | 21 +- .../Types/QueryDsl/SpanWithinQuery.g.cs | 51 +- .../_Generated/Types/QueryDsl/TermQuery.g.cs | 48 +- .../Types/QueryDsl/TermRangeQuery.g.cs | 81 +- .../_Generated/Types/QueryDsl/TermsQuery.g.cs | 21 +- .../Types/QueryDsl/TermsSetQuery.g.cs | 73 +- .../Types/QueryDsl/TextExpansionQuery.g.cs | 57 +- .../Types/QueryDsl/TokenPruningConfig.g.cs | 24 +- .../Types/QueryDsl/UntypedDecayFunction.g.cs | 12 +- .../QueryDsl/UntypedDistanceFeatureQuery.g.cs | 106 +- .../Types/QueryDsl/UntypedRangeQuery.g.cs | 105 +- .../Types/QueryDsl/WeightedTokensQuery.g.cs | 45 +- .../Types/QueryDsl/WildcardQuery.g.cs | 69 +- .../Types/QueryDsl/WrapperQuery.g.cs | 24 +- .../QueryRules/QueryRulesetListItem.g.cs | 12 +- .../_Generated/Types/RRFRetriever.g.cs | 48 +- .../Types/Rollup/DateHistogramGrouping.g.cs | 94 +- .../_Generated/Types/Rollup/FieldMetric.g.cs | 40 +- .../_Generated/Types/Rollup/Groupings.g.cs | 45 +- .../Types/Rollup/HistogramGrouping.g.cs | 36 +- .../Types/Rollup/TermsGrouping.g.cs | 18 +- .../_Generated/Types/RrfRank.g.cs | 16 +- .../_Generated/Types/Script.g.cs | 34 +- .../AnalyticsCollection.g.cs | 4 +- .../SearchApplication/SearchApplication.g.cs | 40 +- .../SearchApplicationListItem.g.cs | 16 +- .../SearchApplicationTemplate.g.cs | 8 +- .../_Generated/Types/SegmentsStats.g.cs | 90 +- .../_Generated/Types/ShardStatistics.g.cs | 8 +- .../_Generated/Types/Slices.g.cs | 4 +- .../Snapshot/CleanupRepositoryResults.g.cs | 8 +- .../Retention.g.cs | 24 +- .../SlmConfiguration.g.cs | 52 +- .../Types/SpecUtils/OverloadOf.g.cs | 6 +- .../_Generated/Types/StandardRetriever.g.cs | 84 +- .../_Generated/Types/StoreStats.g.cs | 26 +- .../_Generated/Types/StoredScript.g.cs | 16 +- .../Types/Synonyms/SynonymRule.g.cs | 16 +- .../Types/Synonyms/SynonymRuleRead.g.cs | 8 +- .../Types/Synonyms/SynonymsSetItem.g.cs | 8 +- .../Types/Tasks/ParentTaskInfo.g.cs | 4 +- .../_Generated/Types/Tasks/TaskInfo.g.cs | 4 +- .../TransformManagement/Destination.g.cs | 20 +- .../Types/TransformManagement/Latest.g.cs | 40 +- .../Types/TransformManagement/Pivot.g.cs | 36 +- .../Types/TransformManagement/Settings.g.cs | 74 +- .../Types/TransformManagement/Source.g.cs | 48 +- .../TimeRetentionPolicy.g.cs | 43 +- .../Types/TransformManagement/TimeSync.g.cs | 54 +- .../TransformManagement/TransformSummary.g.cs | 36 +- .../Types/Xpack/MachineLearning.g.cs | 4 +- 2205 files changed, 101926 insertions(+), 27237 deletions(-) diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/AsyncSearchStatusRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/AsyncSearchStatusRequest.g.cs index e38a5bb49b7..06fbaa3a2ea 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/AsyncSearchStatusRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/AsyncSearchStatusRequest.g.cs @@ -34,7 +34,11 @@ public sealed partial class AsyncSearchStatusRequestParameters : RequestParamete } /// -/// Get async search status
Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. +/// +/// Get async search status +/// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. +/// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. +/// /// public sealed partial class AsyncSearchStatusRequest : PlainRequest { @@ -52,7 +56,11 @@ public AsyncSearchStatusRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) } /// -/// Get async search status
Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. +/// +/// Get async search status +/// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. +/// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. +/// /// public sealed partial class AsyncSearchStatusRequestDescriptor : RequestDescriptor, AsyncSearchStatusRequestParameters> { @@ -82,7 +90,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Get async search status
Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. +/// +/// Get async search status +/// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. +/// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. +/// /// public sealed partial class AsyncSearchStatusRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/AsyncSearchStatusResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/AsyncSearchStatusResponse.g.cs index 73cf40f7f45..ac935fb70ef 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/AsyncSearchStatusResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/AsyncSearchStatusResponse.g.cs @@ -29,19 +29,29 @@ namespace Elastic.Clients.Elasticsearch.Serverless.AsyncSearch; public sealed partial class AsyncSearchStatusResponse : ElasticsearchResponse { /// - /// Metadata about clusters involved in the cross-cluster search.
Not shown for local-only searches. + /// + /// Metadata about clusters involved in the cross-cluster search. + /// Not shown for local-only searches. + /// /// [JsonInclude, JsonPropertyName("_clusters")] public Elastic.Clients.Elasticsearch.Serverless.ClusterStatistics? Clusters { get; init; } /// - /// If the async search completed, this field shows the status code of the search.
For example, 200 indicates that the async search was successfully completed.
503 indicates that the async search was completed with an error. + /// + /// If the async search completed, this field shows the status code of the search. + /// For example, 200 indicates that the async search was successfully completed. + /// 503 indicates that the async search was completed with an error. + /// /// [JsonInclude, JsonPropertyName("completion_status")] public int? CompletionStatus { get; init; } /// - /// Indicates when the async search completed. Only present
when the search has completed. + /// + /// Indicates when the async search completed. Only present + /// when the search has completed. + /// /// [JsonInclude, JsonPropertyName("completion_time")] public DateTimeOffset? CompletionTime { get; init; } @@ -49,7 +59,9 @@ public sealed partial class AsyncSearchStatusResponse : ElasticsearchResponse public long? CompletionTimeInMillis { get; init; } /// - /// Indicates when the async search will expire. + /// + /// Indicates when the async search will expire. + /// /// [JsonInclude, JsonPropertyName("expiration_time")] public DateTimeOffset? ExpirationTime { get; init; } @@ -59,19 +71,27 @@ public sealed partial class AsyncSearchStatusResponse : ElasticsearchResponse public string? Id { get; init; } /// - /// When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards.
While the query is running, `is_partial` is always set to `true`. + /// + /// When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards. + /// While the query is running, is_partial is always set to true. + /// /// [JsonInclude, JsonPropertyName("is_partial")] public bool IsPartial { get; init; } /// - /// Indicates whether the search is still running or has completed.
NOTE: If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though `is_running` is `false`. + /// + /// Indicates whether the search is still running or has completed. + /// NOTE: If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though is_running is false. + /// /// [JsonInclude, JsonPropertyName("is_running")] public bool IsRunning { get; init; } /// - /// Indicates how many shards have run the query so far. + /// + /// Indicates how many shards have run the query so far. + /// /// [JsonInclude, JsonPropertyName("_shards")] public Elastic.Clients.Elasticsearch.Serverless.ShardStatistics Shards { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/DeleteAsyncSearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/DeleteAsyncSearchRequest.g.cs index 34e6fd301fa..4b524cfa19b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/DeleteAsyncSearchRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/DeleteAsyncSearchRequest.g.cs @@ -34,7 +34,12 @@ public sealed partial class DeleteAsyncSearchRequestParameters : RequestParamete } /// -/// Deletes an async search by identifier.
If the search is still running, the search request will be cancelled.
Otherwise, the saved search results are deleted.
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. +/// +/// Deletes an async search by identifier. +/// If the search is still running, the search request will be cancelled. +/// Otherwise, the saved search results are deleted. +/// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. +/// /// public sealed partial class DeleteAsyncSearchRequest : PlainRequest { @@ -52,7 +57,12 @@ public DeleteAsyncSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) } /// -/// Deletes an async search by identifier.
If the search is still running, the search request will be cancelled.
Otherwise, the saved search results are deleted.
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. +/// +/// Deletes an async search by identifier. +/// If the search is still running, the search request will be cancelled. +/// Otherwise, the saved search results are deleted. +/// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. +/// /// public sealed partial class DeleteAsyncSearchRequestDescriptor : RequestDescriptor, DeleteAsyncSearchRequestParameters> { @@ -82,7 +92,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Deletes an async search by identifier.
If the search is still running, the search request will be cancelled.
Otherwise, the saved search results are deleted.
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. +/// +/// Deletes an async search by identifier. +/// If the search is still running, the search request will be cancelled. +/// Otherwise, the saved search results are deleted. +/// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. +/// /// public sealed partial class DeleteAsyncSearchRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/DeleteAsyncSearchResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/DeleteAsyncSearchResponse.g.cs index dd2b08c8d8d..66a78fb63cb 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/DeleteAsyncSearchResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/DeleteAsyncSearchResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.AsyncSearch; public sealed partial class DeleteAsyncSearchResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/GetAsyncSearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/GetAsyncSearchRequest.g.cs index 05c81be7421..6952b0ab921 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/GetAsyncSearchRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/GetAsyncSearchRequest.g.cs @@ -32,23 +32,38 @@ namespace Elastic.Clients.Elasticsearch.Serverless.AsyncSearch; public sealed partial class GetAsyncSearchRequestParameters : RequestParameters { /// - /// Specifies how long the async search should be available in the cluster.
When not specified, the `keep_alive` set with the corresponding submit async request will be used.
Otherwise, it is possible to override the value and extend the validity of the request.
When this period expires, the search, if still running, is cancelled.
If the search is completed, its saved results are deleted. + /// + /// Specifies how long the async search should be available in the cluster. + /// When not specified, the keep_alive set with the corresponding submit async request will be used. + /// Otherwise, it is possible to override the value and extend the validity of the request. + /// When this period expires, the search, if still running, is cancelled. + /// If the search is completed, its saved results are deleted. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); } /// - /// Specify whether aggregation and suggester names should be prefixed by their respective types in the response + /// + /// Specify whether aggregation and suggester names should be prefixed by their respective types in the response + /// /// public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } /// - /// Specifies to wait for the search to be completed up until the provided timeout.
Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires.
By default no timeout is set meaning that the currently available results will be returned without any additional wait. + /// + /// Specifies to wait for the search to be completed up until the provided timeout. + /// Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires. + /// By default no timeout is set meaning that the currently available results will be returned without any additional wait. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? WaitForCompletionTimeout { get => Q("wait_for_completion_timeout"); set => Q("wait_for_completion_timeout", value); } } /// -/// Retrieves the results of a previously submitted async search request given its identifier.
If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. +/// +/// Retrieves the results of a previously submitted async search request given its identifier. +/// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. +/// /// public sealed partial class GetAsyncSearchRequest : PlainRequest { @@ -65,26 +80,41 @@ public GetAsyncSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : b internal override string OperationName => "async_search.get"; /// - /// Specifies how long the async search should be available in the cluster.
When not specified, the `keep_alive` set with the corresponding submit async request will be used.
Otherwise, it is possible to override the value and extend the validity of the request.
When this period expires, the search, if still running, is cancelled.
If the search is completed, its saved results are deleted. + /// + /// Specifies how long the async search should be available in the cluster. + /// When not specified, the keep_alive set with the corresponding submit async request will be used. + /// Otherwise, it is possible to override the value and extend the validity of the request. + /// When this period expires, the search, if still running, is cancelled. + /// If the search is completed, its saved results are deleted. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); } /// - /// Specify whether aggregation and suggester names should be prefixed by their respective types in the response + /// + /// Specify whether aggregation and suggester names should be prefixed by their respective types in the response + /// /// [JsonIgnore] public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } /// - /// Specifies to wait for the search to be completed up until the provided timeout.
Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires.
By default no timeout is set meaning that the currently available results will be returned without any additional wait. + /// + /// Specifies to wait for the search to be completed up until the provided timeout. + /// Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires. + /// By default no timeout is set meaning that the currently available results will be returned without any additional wait. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? WaitForCompletionTimeout { get => Q("wait_for_completion_timeout"); set => Q("wait_for_completion_timeout", value); } } /// -/// Retrieves the results of a previously submitted async search request given its identifier.
If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. +/// +/// Retrieves the results of a previously submitted async search request given its identifier. +/// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. +/// /// public sealed partial class GetAsyncSearchRequestDescriptor : RequestDescriptor, GetAsyncSearchRequestParameters> { @@ -118,7 +148,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Retrieves the results of a previously submitted async search request given its identifier.
If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. +/// +/// Retrieves the results of a previously submitted async search request given its identifier. +/// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. +/// /// public sealed partial class GetAsyncSearchRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/GetAsyncSearchResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/GetAsyncSearchResponse.g.cs index 6242022d095..a7fd20fd67d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/GetAsyncSearchResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/GetAsyncSearchResponse.g.cs @@ -29,7 +29,10 @@ namespace Elastic.Clients.Elasticsearch.Serverless.AsyncSearch; public sealed partial class GetAsyncSearchResponse : ElasticsearchResponse { /// - /// Indicates when the async search completed. Only present
when the search has completed. + /// + /// Indicates when the async search completed. Only present + /// when the search has completed. + /// /// [JsonInclude, JsonPropertyName("completion_time")] public DateTimeOffset? CompletionTime { get; init; } @@ -37,7 +40,9 @@ public sealed partial class GetAsyncSearchResponse : ElasticsearchRes public long? CompletionTimeInMillis { get; init; } /// - /// Indicates when the async search will expire. + /// + /// Indicates when the async search will expire. + /// /// [JsonInclude, JsonPropertyName("expiration_time")] public DateTimeOffset? ExpirationTime { get; init; } @@ -47,13 +52,19 @@ public sealed partial class GetAsyncSearchResponse : ElasticsearchRes public string? Id { get; init; } /// - /// When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards.
While the query is running, `is_partial` is always set to `true`. + /// + /// When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards. + /// While the query is running, is_partial is always set to true. + /// /// [JsonInclude, JsonPropertyName("is_partial")] public bool IsPartial { get; init; } /// - /// Indicates whether the search is still running or has completed.
NOTE: If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though `is_running` is `false`. + /// + /// Indicates whether the search is still running or has completed. + /// NOTE: If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though is_running is false. + /// /// [JsonInclude, JsonPropertyName("is_running")] public bool IsRunning { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/SubmitAsyncSearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/SubmitAsyncSearchRequest.g.cs index a9b2ed28aae..eaa612fb23a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/SubmitAsyncSearchRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/SubmitAsyncSearchRequest.g.cs @@ -32,150 +32,211 @@ namespace Elastic.Clients.Elasticsearch.Serverless.AsyncSearch; public sealed partial class SubmitAsyncSearchRequestParameters : RequestParameters { /// - /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + /// + /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified) + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Indicate if an error should be returned if there is a partial search failure or timeout + /// + /// Indicate if an error should be returned if there is a partial search failure or timeout + /// /// public bool? AllowPartialSearchResults { get => Q("allow_partial_search_results"); set => Q("allow_partial_search_results", value); } /// - /// The analyzer to use for the query string + /// + /// The analyzer to use for the query string + /// /// public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// - /// Specify whether wildcard and prefix queries should be analyzed (default: false) + /// + /// Specify whether wildcard and prefix queries should be analyzed (default: false) + /// /// public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } /// - /// Affects how often partial results become available, which happens whenever shard results are reduced.
A partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default). + /// + /// Affects how often partial results become available, which happens whenever shard results are reduced. + /// A partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default). + /// /// public long? BatchedReduceSize { get => Q("batched_reduce_size"); set => Q("batched_reduce_size", value); } /// - /// The default value is the only supported value. + /// + /// The default value is the only supported value. + /// /// public bool? CcsMinimizeRoundtrips { get => Q("ccs_minimize_roundtrips"); set => Q("ccs_minimize_roundtrips", value); } /// - /// The default operator for query string query (AND or OR) + /// + /// The default operator for query string query (AND or OR) + /// /// public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } /// - /// The field to use as default where no field prefix is given in the query string + /// + /// The field to use as default where no field prefix is given in the query string + /// /// public string? Df { get => Q("df"); set => Q("df", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// + /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Whether specified concrete, expanded or aliased indices should be ignored when throttled + /// + /// Whether specified concrete, expanded or aliased indices should be ignored when throttled + /// /// public bool? IgnoreThrottled { get => Q("ignore_throttled"); set => Q("ignore_throttled", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// + /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Specifies how long the async search needs to be available.
Ongoing async searches and any saved search results are deleted after this period. + /// + /// Specifies how long the async search needs to be available. + /// Ongoing async searches and any saved search results are deleted after this period. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); } /// - /// If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`. + /// + /// If true, results are stored for later retrieval when the search completes within the wait_for_completion_timeout. + /// /// public bool? KeepOnCompletion { get => Q("keep_on_completion"); set => Q("keep_on_completion", value); } /// - /// Specify whether format-based query failures (such as providing text to a numeric field) should be ignored + /// + /// Specify whether format-based query failures (such as providing text to a numeric field) should be ignored + /// /// public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// - /// The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests + /// + /// The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests + /// /// public long? MaxConcurrentShardRequests { get => Q("max_concurrent_shard_requests"); set => Q("max_concurrent_shard_requests", value); } public string? MinCompatibleShardNode { get => Q("min_compatible_shard_node"); set => Q("min_compatible_shard_node", value); } /// - /// Specify the node or shard the operation should be performed on (default: random) + /// + /// Specify the node or shard the operation should be performed on (default: random) + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped. + /// + /// The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped. + /// /// public long? PreFilterShardSize { get => Q("pre_filter_shard_size"); set => Q("pre_filter_shard_size", value); } /// - /// Query in the Lucene query string syntax + /// + /// Query in the Lucene query string syntax + /// /// public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } /// - /// Specify if request cache should be used for this request or not, defaults to true + /// + /// Specify if request cache should be used for this request or not, defaults to true + /// /// public bool? RequestCache { get => Q("request_cache"); set => Q("request_cache", value); } public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } /// - /// A comma-separated list of specific routing values + /// + /// A comma-separated list of specific routing values + /// /// public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } public Elastic.Clients.Elasticsearch.Serverless.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); } /// - /// Search operation type + /// + /// Search operation type + /// /// public Elastic.Clients.Elasticsearch.Serverless.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } /// - /// A list of fields to exclude from the returned _source field + /// + /// A list of fields to exclude from the returned _source field + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A list of fields to extract and return from the _source field + /// + /// A list of fields to extract and return from the _source field + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// Specifies which field to use for suggestions. + /// + /// Specifies which field to use for suggestions. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Field? SuggestField { get => Q("suggest_field"); set => Q("suggest_field", value); } /// - /// Specify suggest mode + /// + /// Specify suggest mode + /// /// public Elastic.Clients.Elasticsearch.Serverless.SuggestMode? SuggestMode { get => Q("suggest_mode"); set => Q("suggest_mode", value); } /// - /// How many suggestions to return in response + /// + /// How many suggestions to return in response + /// /// public long? SuggestSize { get => Q("suggest_size"); set => Q("suggest_size", value); } /// - /// The source text for which the suggestions should be returned. + /// + /// The source text for which the suggestions should be returned. + /// /// public string? SuggestText { get => Q("suggest_text"); set => Q("suggest_text", value); } /// - /// Specify whether aggregation and suggester names should be prefixed by their respective types in the response + /// + /// Specify whether aggregation and suggester names should be prefixed by their respective types in the response + /// /// public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } /// - /// Blocks and waits until the search is completed up to a certain timeout.
When the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster. + /// + /// Blocks and waits until the search is completed up to a certain timeout. + /// When the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? WaitForCompletionTimeout { get => Q("wait_for_completion_timeout"); set => Q("wait_for_completion_timeout", value); } } @@ -589,7 +650,13 @@ public override void Write(Utf8JsonWriter writer, SubmitAsyncSearchRequest value } /// -/// Runs a search request asynchronously.
When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.
Warning: Async search does not support scroll nor search requests that only include the suggest section.
By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. +/// +/// Runs a search request asynchronously. +/// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. +/// Warning: Async search does not support scroll nor search requests that only include the suggest section. +/// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. +/// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. +/// /// [JsonConverter(typeof(SubmitAsyncSearchRequestConverter))] public sealed partial class SubmitAsyncSearchRequest : PlainRequest @@ -611,91 +678,123 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Indices internal override string OperationName => "async_search.submit"; /// - /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + /// + /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified) + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Indicate if an error should be returned if there is a partial search failure or timeout + /// + /// Indicate if an error should be returned if there is a partial search failure or timeout + /// /// [JsonIgnore] public bool? AllowPartialSearchResults { get => Q("allow_partial_search_results"); set => Q("allow_partial_search_results", value); } /// - /// The analyzer to use for the query string + /// + /// The analyzer to use for the query string + /// /// [JsonIgnore] public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// - /// Specify whether wildcard and prefix queries should be analyzed (default: false) + /// + /// Specify whether wildcard and prefix queries should be analyzed (default: false) + /// /// [JsonIgnore] public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } /// - /// Affects how often partial results become available, which happens whenever shard results are reduced.
A partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default). + /// + /// Affects how often partial results become available, which happens whenever shard results are reduced. + /// A partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default). + /// /// [JsonIgnore] public long? BatchedReduceSize { get => Q("batched_reduce_size"); set => Q("batched_reduce_size", value); } /// - /// The default value is the only supported value. + /// + /// The default value is the only supported value. + /// /// [JsonIgnore] public bool? CcsMinimizeRoundtrips { get => Q("ccs_minimize_roundtrips"); set => Q("ccs_minimize_roundtrips", value); } /// - /// The default operator for query string query (AND or OR) + /// + /// The default operator for query string query (AND or OR) + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } /// - /// The field to use as default where no field prefix is given in the query string + /// + /// The field to use as default where no field prefix is given in the query string + /// /// [JsonIgnore] public string? Df { get => Q("df"); set => Q("df", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// + /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Whether specified concrete, expanded or aliased indices should be ignored when throttled + /// + /// Whether specified concrete, expanded or aliased indices should be ignored when throttled + /// /// [JsonIgnore] public bool? IgnoreThrottled { get => Q("ignore_throttled"); set => Q("ignore_throttled", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// + /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Specifies how long the async search needs to be available.
Ongoing async searches and any saved search results are deleted after this period. + /// + /// Specifies how long the async search needs to be available. + /// Ongoing async searches and any saved search results are deleted after this period. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); } /// - /// If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`. + /// + /// If true, results are stored for later retrieval when the search completes within the wait_for_completion_timeout. + /// /// [JsonIgnore] public bool? KeepOnCompletion { get => Q("keep_on_completion"); set => Q("keep_on_completion", value); } /// - /// Specify whether format-based query failures (such as providing text to a numeric field) should be ignored + /// + /// Specify whether format-based query failures (such as providing text to a numeric field) should be ignored + /// /// [JsonIgnore] public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// - /// The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests + /// + /// The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests + /// /// [JsonIgnore] public long? MaxConcurrentShardRequests { get => Q("max_concurrent_shard_requests"); set => Q("max_concurrent_shard_requests", value); } @@ -703,25 +802,33 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Indices public string? MinCompatibleShardNode { get => Q("min_compatible_shard_node"); set => Q("min_compatible_shard_node", value); } /// - /// Specify the node or shard the operation should be performed on (default: random) + /// + /// Specify the node or shard the operation should be performed on (default: random) + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped. + /// + /// The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped. + /// /// [JsonIgnore] public long? PreFilterShardSize { get => Q("pre_filter_shard_size"); set => Q("pre_filter_shard_size", value); } /// - /// Query in the Lucene query string syntax + /// + /// Query in the Lucene query string syntax + /// /// [JsonIgnore] public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } /// - /// Specify if request cache should be used for this request or not, defaults to true + /// + /// Specify if request cache should be used for this request or not, defaults to true + /// /// [JsonIgnore] public bool? RequestCache { get => Q("request_cache"); set => Q("request_cache", value); } @@ -729,7 +836,9 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Indices public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } /// - /// A comma-separated list of specific routing values + /// + /// A comma-separated list of specific routing values + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } @@ -737,55 +846,74 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Indices public Elastic.Clients.Elasticsearch.Serverless.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); } /// - /// Search operation type + /// + /// Search operation type + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } /// - /// A list of fields to exclude from the returned _source field + /// + /// A list of fields to exclude from the returned _source field + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A list of fields to extract and return from the _source field + /// + /// A list of fields to extract and return from the _source field + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// Specifies which field to use for suggestions. + /// + /// Specifies which field to use for suggestions. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Field? SuggestField { get => Q("suggest_field"); set => Q("suggest_field", value); } /// - /// Specify suggest mode + /// + /// Specify suggest mode + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.SuggestMode? SuggestMode { get => Q("suggest_mode"); set => Q("suggest_mode", value); } /// - /// How many suggestions to return in response + /// + /// How many suggestions to return in response + /// /// [JsonIgnore] public long? SuggestSize { get => Q("suggest_size"); set => Q("suggest_size", value); } /// - /// The source text for which the suggestions should be returned. + /// + /// The source text for which the suggestions should be returned. + /// /// [JsonIgnore] public string? SuggestText { get => Q("suggest_text"); set => Q("suggest_text", value); } /// - /// Specify whether aggregation and suggester names should be prefixed by their respective types in the response + /// + /// Specify whether aggregation and suggester names should be prefixed by their respective types in the response + /// /// [JsonIgnore] public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } /// - /// Blocks and waits until the search is completed up to a certain timeout.
When the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster. + /// + /// Blocks and waits until the search is completed up to a certain timeout. + /// When the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? WaitForCompletionTimeout { get => Q("wait_for_completion_timeout"); set => Q("wait_for_completion_timeout", value); } @@ -795,31 +923,45 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Indices public Elastic.Clients.Elasticsearch.Serverless.Core.Search.FieldCollapse? Collapse { get; set; } /// - /// Array of wildcard (*) patterns. The request returns doc values for field
names matching these patterns in the hits.fields property of the response. + /// + /// Array of wildcard (*) patterns. The request returns doc values for field + /// names matching these patterns in the hits.fields property of the response. + /// /// [JsonInclude, JsonPropertyName("docvalue_fields")] public ICollection? DocvalueFields { get; set; } /// - /// If true, returns detailed information about score computation as part of a hit. + /// + /// If true, returns detailed information about score computation as part of a hit. + /// /// [JsonInclude, JsonPropertyName("explain")] public bool? Explain { get; set; } /// - /// Configuration of search extensions defined by Elasticsearch plugins. + /// + /// Configuration of search extensions defined by Elasticsearch plugins. + /// /// [JsonInclude, JsonPropertyName("ext")] public IDictionary? Ext { get; set; } /// - /// Array of wildcard (*) patterns. The request returns values for field names
matching these patterns in the hits.fields property of the response. + /// + /// Array of wildcard (*) patterns. The request returns values for field names + /// matching these patterns in the hits.fields property of the response. + /// /// [JsonInclude, JsonPropertyName("fields")] public ICollection? Fields { get; set; } /// - /// Starting document offset. By default, you cannot page through more than 10,000
hits using the from and size parameters. To page through more hits, use the
search_after parameter. + /// + /// Starting document offset. By default, you cannot page through more than 10,000 + /// hits using the from and size parameters. To page through more hits, use the + /// search_after parameter. + /// /// [JsonInclude, JsonPropertyName("from")] public int? From { get; set; } @@ -827,26 +969,36 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Indices public Elastic.Clients.Elasticsearch.Serverless.Core.Search.Highlight? Highlight { get; set; } /// - /// Boosts the _score of documents from specified indices. + /// + /// Boosts the _score of documents from specified indices. + /// /// [JsonInclude, JsonPropertyName("indices_boost")] public ICollection>? IndicesBoost { get; set; } /// - /// Defines the approximate kNN search to run. + /// + /// Defines the approximate kNN search to run. + /// /// [JsonInclude, JsonPropertyName("knn")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.KnnSearch))] public ICollection? Knn { get; set; } /// - /// Minimum _score for matching documents. Documents with a lower _score are
not included in the search results. + /// + /// Minimum _score for matching documents. Documents with a lower _score are + /// not included in the search results. + /// /// [JsonInclude, JsonPropertyName("min_score")] public double? MinScore { get; set; } /// - /// Limits the search to a point in time (PIT). If you provide a PIT, you
cannot specify an in the request path. + /// + /// Limits the search to a point in time (PIT). If you provide a PIT, you + /// cannot specify an <index> in the request path. + /// /// [JsonInclude, JsonPropertyName("pit")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.PointInTimeReference? Pit { get; set; } @@ -856,7 +1008,9 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Indices public bool? Profile { get; set; } /// - /// Defines the search definition using the Query DSL. + /// + /// Defines the search definition using the Query DSL. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? Query { get; set; } @@ -865,13 +1019,18 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Indices public ICollection? Rescore { get; set; } /// - /// Defines one or more runtime fields in the search request. These fields take
precedence over mapped fields with the same name. + /// + /// Defines one or more runtime fields in the search request. These fields take + /// precedence over mapped fields with the same name. + /// /// [JsonInclude, JsonPropertyName("runtime_mappings")] public IDictionary? RuntimeMappings { get; set; } /// - /// Retrieve a script evaluation (based on different fields) for each hit. + /// + /// Retrieve a script evaluation (based on different fields) for each hit. + /// /// [JsonInclude, JsonPropertyName("script_fields")] public IDictionary? ScriptFields { get; set; } @@ -879,13 +1038,20 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Indices public ICollection? SearchAfter { get; set; } /// - /// If true, returns sequence number and primary term of the last modification
of each hit. See Optimistic concurrency control. + /// + /// If true, returns sequence number and primary term of the last modification + /// of each hit. See Optimistic concurrency control. + /// /// [JsonInclude, JsonPropertyName("seq_no_primary_term")] public bool? SeqNoPrimaryTerm { get; set; } /// - /// The number of hits to return. By default, you cannot page through more
than 10,000 hits using the from and size parameters. To page through more
hits, use the search_after parameter. + /// + /// The number of hits to return. By default, you cannot page through more + /// than 10,000 hits using the from and size parameters. To page through more + /// hits, use the search_after parameter. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } @@ -896,19 +1062,31 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Indices public ICollection? Sort { get; set; } /// - /// Indicates which source fields are returned for matching documents. These
fields are returned in the hits._source property of the search response. + /// + /// Indicates which source fields are returned for matching documents. These + /// fields are returned in the hits._source property of the search response. + /// /// [JsonInclude, JsonPropertyName("_source")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfig? Source { get; set; } /// - /// Stats groups to associate with the search. Each group maintains a statistics
aggregation for its associated searches. You can retrieve these stats using
the indices stats API. + /// + /// Stats groups to associate with the search. Each group maintains a statistics + /// aggregation for its associated searches. You can retrieve these stats using + /// the indices stats API. + /// /// [JsonInclude, JsonPropertyName("stats")] public ICollection? Stats { get; set; } /// - /// List of stored fields to return as part of a hit. If no fields are specified,
no stored fields are included in the response. If this field is specified, the _source
parameter defaults to false. You can pass _source: true to return both source fields
and stored fields in the search response. + /// + /// List of stored fields to return as part of a hit. If no fields are specified, + /// no stored fields are included in the response. If this field is specified, the _source + /// parameter defaults to false. You can pass _source: true to return both source fields + /// and stored fields in the search response. + /// /// [JsonInclude, JsonPropertyName("stored_fields")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] @@ -917,38 +1095,61 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Indices public Elastic.Clients.Elasticsearch.Serverless.Core.Search.Suggester? Suggest { get; set; } /// - /// Maximum number of documents to collect for each shard. If a query reaches this
limit, Elasticsearch terminates the query early. Elasticsearch collects documents
before sorting. Defaults to 0, which does not terminate query execution early. + /// + /// Maximum number of documents to collect for each shard. If a query reaches this + /// limit, Elasticsearch terminates the query early. Elasticsearch collects documents + /// before sorting. Defaults to 0, which does not terminate query execution early. + /// /// [JsonInclude, JsonPropertyName("terminate_after")] public long? TerminateAfter { get; set; } /// - /// Specifies the period of time to wait for a response from each shard. If no response
is received before the timeout expires, the request fails and returns an error.
Defaults to no timeout. + /// + /// Specifies the period of time to wait for a response from each shard. If no response + /// is received before the timeout expires, the request fails and returns an error. + /// Defaults to no timeout. + /// /// [JsonInclude, JsonPropertyName("timeout")] public string? Timeout { get; set; } /// - /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// + /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// /// [JsonInclude, JsonPropertyName("track_scores")] public bool? TrackScores { get; set; } /// - /// Number of hits matching the query to count accurately. If true, the exact
number of hits is returned at the cost of some performance. If false, the
response does not include the total number of hits matching the query.
Defaults to 10,000 hits. + /// + /// Number of hits matching the query to count accurately. If true, the exact + /// number of hits is returned at the cost of some performance. If false, the + /// response does not include the total number of hits matching the query. + /// Defaults to 10,000 hits. + /// /// [JsonInclude, JsonPropertyName("track_total_hits")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.TrackHits? TrackTotalHits { get; set; } /// - /// If true, returns document version as part of a hit. + /// + /// If true, returns document version as part of a hit. + /// /// [JsonInclude, JsonPropertyName("version")] public bool? Version { get; set; } } /// -/// Runs a search request asynchronously.
When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.
Warning: Async search does not support scroll nor search requests that only include the suggest section.
By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. +/// +/// Runs a search request asynchronously. +/// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. +/// Warning: Async search does not support scroll nor search requests that only include the suggest section. +/// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. +/// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. +/// /// public sealed partial class SubmitAsyncSearchRequestDescriptor : RequestDescriptor, SubmitAsyncSearchRequestParameters> { @@ -1102,7 +1303,10 @@ public SubmitAsyncSearchRequestDescriptor Collapse(Action - /// Array of wildcard (*) patterns. The request returns doc values for field
names matching these patterns in the hits.fields property of the response. + /// + /// Array of wildcard (*) patterns. The request returns doc values for field + /// names matching these patterns in the hits.fields property of the response. + /// /// public SubmitAsyncSearchRequestDescriptor DocvalueFields(ICollection? docvalueFields) { @@ -1141,7 +1345,9 @@ public SubmitAsyncSearchRequestDescriptor DocvalueFields(params Actio } /// - /// If true, returns detailed information about score computation as part of a hit. + /// + /// If true, returns detailed information about score computation as part of a hit. + /// /// public SubmitAsyncSearchRequestDescriptor Explain(bool? explain = true) { @@ -1150,7 +1356,9 @@ public SubmitAsyncSearchRequestDescriptor Explain(bool? explain = tru } /// - /// Configuration of search extensions defined by Elasticsearch plugins. + /// + /// Configuration of search extensions defined by Elasticsearch plugins. + /// /// public SubmitAsyncSearchRequestDescriptor Ext(Func, FluentDictionary> selector) { @@ -1159,7 +1367,10 @@ public SubmitAsyncSearchRequestDescriptor Ext(Func - /// Array of wildcard (*) patterns. The request returns values for field names
matching these patterns in the hits.fields property of the response. + /// + /// Array of wildcard (*) patterns. The request returns values for field names + /// matching these patterns in the hits.fields property of the response. + /// /// public SubmitAsyncSearchRequestDescriptor Fields(ICollection? fields) { @@ -1198,7 +1409,11 @@ public SubmitAsyncSearchRequestDescriptor Fields(params Action - /// Starting document offset. By default, you cannot page through more than 10,000
hits using the from and size parameters. To page through more hits, use the
search_after parameter. + /// + /// Starting document offset. By default, you cannot page through more than 10,000 + /// hits using the from and size parameters. To page through more hits, use the + /// search_after parameter. + /// /// public SubmitAsyncSearchRequestDescriptor From(int? from) { @@ -1231,7 +1446,9 @@ public SubmitAsyncSearchRequestDescriptor Highlight(Action - /// Boosts the _score of documents from specified indices. + /// + /// Boosts the _score of documents from specified indices. + /// /// public SubmitAsyncSearchRequestDescriptor IndicesBoost(ICollection>? indicesBoost) { @@ -1240,7 +1457,9 @@ public SubmitAsyncSearchRequestDescriptor IndicesBoost(ICollection - /// Defines the approximate kNN search to run. + /// + /// Defines the approximate kNN search to run. + /// /// public SubmitAsyncSearchRequestDescriptor Knn(ICollection? knn) { @@ -1279,7 +1498,10 @@ public SubmitAsyncSearchRequestDescriptor Knn(params Action - /// Minimum _score for matching documents. Documents with a lower _score are
not included in the search results. + /// + /// Minimum _score for matching documents. Documents with a lower _score are + /// not included in the search results. + /// /// public SubmitAsyncSearchRequestDescriptor MinScore(double? minScore) { @@ -1288,7 +1510,10 @@ public SubmitAsyncSearchRequestDescriptor MinScore(double? minScore) } /// - /// Limits the search to a point in time (PIT). If you provide a PIT, you
cannot specify an in the request path. + /// + /// Limits the search to a point in time (PIT). If you provide a PIT, you + /// cannot specify an <index> in the request path. + /// /// public SubmitAsyncSearchRequestDescriptor Pit(Elastic.Clients.Elasticsearch.Serverless.Core.Search.PointInTimeReference? pit) { @@ -1345,7 +1570,9 @@ public SubmitAsyncSearchRequestDescriptor Profile(bool? profile = tru } /// - /// Defines the search definition using the Query DSL. + /// + /// Defines the search definition using the Query DSL. + /// /// public SubmitAsyncSearchRequestDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -1408,7 +1635,10 @@ public SubmitAsyncSearchRequestDescriptor Rescore(params Action - /// Defines one or more runtime fields in the search request. These fields take
precedence over mapped fields with the same name. + /// + /// Defines one or more runtime fields in the search request. These fields take + /// precedence over mapped fields with the same name. + /// /// public SubmitAsyncSearchRequestDescriptor RuntimeMappings(Func>, FluentDescriptorDictionary>> selector) { @@ -1417,7 +1647,9 @@ public SubmitAsyncSearchRequestDescriptor RuntimeMappings(Func - /// Retrieve a script evaluation (based on different fields) for each hit. + /// + /// Retrieve a script evaluation (based on different fields) for each hit. + /// /// public SubmitAsyncSearchRequestDescriptor ScriptFields(Func, FluentDescriptorDictionary> selector) { @@ -1432,7 +1664,10 @@ public SubmitAsyncSearchRequestDescriptor SearchAfter(ICollection - /// If true, returns sequence number and primary term of the last modification
of each hit. See Optimistic concurrency control. + /// + /// If true, returns sequence number and primary term of the last modification + /// of each hit. See Optimistic concurrency control. + /// /// public SubmitAsyncSearchRequestDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = true) { @@ -1441,7 +1676,11 @@ public SubmitAsyncSearchRequestDescriptor SeqNoPrimaryTerm(bool? seqN } /// - /// The number of hits to return. By default, you cannot page through more
than 10,000 hits using the from and size parameters. To page through more
hits, use the search_after parameter. + /// + /// The number of hits to return. By default, you cannot page through more + /// than 10,000 hits using the from and size parameters. To page through more + /// hits, use the search_after parameter. + /// /// public SubmitAsyncSearchRequestDescriptor Size(int? size) { @@ -1510,7 +1749,10 @@ public SubmitAsyncSearchRequestDescriptor Sort(params Action - /// Indicates which source fields are returned for matching documents. These
fields are returned in the hits._source property of the search response. + /// + /// Indicates which source fields are returned for matching documents. These + /// fields are returned in the hits._source property of the search response. + /// /// public SubmitAsyncSearchRequestDescriptor Source(Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfig? source) { @@ -1519,7 +1761,11 @@ public SubmitAsyncSearchRequestDescriptor Source(Elastic.Clients.Elas } /// - /// Stats groups to associate with the search. Each group maintains a statistics
aggregation for its associated searches. You can retrieve these stats using
the indices stats API. + /// + /// Stats groups to associate with the search. Each group maintains a statistics + /// aggregation for its associated searches. You can retrieve these stats using + /// the indices stats API. + /// /// public SubmitAsyncSearchRequestDescriptor Stats(ICollection? stats) { @@ -1528,7 +1774,12 @@ public SubmitAsyncSearchRequestDescriptor Stats(ICollection? } /// - /// List of stored fields to return as part of a hit. If no fields are specified,
no stored fields are included in the response. If this field is specified, the _source
parameter defaults to false. You can pass _source: true to return both source fields
and stored fields in the search response. + /// + /// List of stored fields to return as part of a hit. If no fields are specified, + /// no stored fields are included in the response. If this field is specified, the _source + /// parameter defaults to false. You can pass _source: true to return both source fields + /// and stored fields in the search response. + /// /// public SubmitAsyncSearchRequestDescriptor StoredFields(Elastic.Clients.Elasticsearch.Serverless.Fields? storedFields) { @@ -1561,7 +1812,11 @@ public SubmitAsyncSearchRequestDescriptor Suggest(Action - /// Maximum number of documents to collect for each shard. If a query reaches this
limit, Elasticsearch terminates the query early. Elasticsearch collects documents
before sorting. Defaults to 0, which does not terminate query execution early. + /// + /// Maximum number of documents to collect for each shard. If a query reaches this + /// limit, Elasticsearch terminates the query early. Elasticsearch collects documents + /// before sorting. Defaults to 0, which does not terminate query execution early. + /// /// public SubmitAsyncSearchRequestDescriptor TerminateAfter(long? terminateAfter) { @@ -1570,7 +1825,11 @@ public SubmitAsyncSearchRequestDescriptor TerminateAfter(long? termin } /// - /// Specifies the period of time to wait for a response from each shard. If no response
is received before the timeout expires, the request fails and returns an error.
Defaults to no timeout. + /// + /// Specifies the period of time to wait for a response from each shard. If no response + /// is received before the timeout expires, the request fails and returns an error. + /// Defaults to no timeout. + /// /// public SubmitAsyncSearchRequestDescriptor Timeout(string? timeout) { @@ -1579,7 +1838,9 @@ public SubmitAsyncSearchRequestDescriptor Timeout(string? timeout) } /// - /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// + /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// /// public SubmitAsyncSearchRequestDescriptor TrackScores(bool? trackScores = true) { @@ -1588,7 +1849,12 @@ public SubmitAsyncSearchRequestDescriptor TrackScores(bool? trackScor } /// - /// Number of hits matching the query to count accurately. If true, the exact
number of hits is returned at the cost of some performance. If false, the
response does not include the total number of hits matching the query.
Defaults to 10,000 hits. + /// + /// Number of hits matching the query to count accurately. If true, the exact + /// number of hits is returned at the cost of some performance. If false, the + /// response does not include the total number of hits matching the query. + /// Defaults to 10,000 hits. + /// /// public SubmitAsyncSearchRequestDescriptor TrackTotalHits(Elastic.Clients.Elasticsearch.Serverless.Core.Search.TrackHits? trackTotalHits) { @@ -1597,7 +1863,9 @@ public SubmitAsyncSearchRequestDescriptor TrackTotalHits(Elastic.Clie } /// - /// If true, returns document version as part of a hit. + /// + /// If true, returns document version as part of a hit. + /// /// public SubmitAsyncSearchRequestDescriptor Version(bool? version = true) { @@ -1994,7 +2262,13 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Runs a search request asynchronously.
When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.
Warning: Async search does not support scroll nor search requests that only include the suggest section.
By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. +/// +/// Runs a search request asynchronously. +/// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. +/// Warning: Async search does not support scroll nor search requests that only include the suggest section. +/// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. +/// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. +/// /// public sealed partial class SubmitAsyncSearchRequestDescriptor : RequestDescriptor { @@ -2148,7 +2422,10 @@ public SubmitAsyncSearchRequestDescriptor Collapse(Action - /// Array of wildcard (*) patterns. The request returns doc values for field
names matching these patterns in the hits.fields property of the response. + /// + /// Array of wildcard (*) patterns. The request returns doc values for field + /// names matching these patterns in the hits.fields property of the response. + /// /// public SubmitAsyncSearchRequestDescriptor DocvalueFields(ICollection? docvalueFields) { @@ -2187,7 +2464,9 @@ public SubmitAsyncSearchRequestDescriptor DocvalueFields(params Action - /// If true, returns detailed information about score computation as part of a hit. + /// + /// If true, returns detailed information about score computation as part of a hit. + /// /// public SubmitAsyncSearchRequestDescriptor Explain(bool? explain = true) { @@ -2196,7 +2475,9 @@ public SubmitAsyncSearchRequestDescriptor Explain(bool? explain = true) } /// - /// Configuration of search extensions defined by Elasticsearch plugins. + /// + /// Configuration of search extensions defined by Elasticsearch plugins. + /// /// public SubmitAsyncSearchRequestDescriptor Ext(Func, FluentDictionary> selector) { @@ -2205,7 +2486,10 @@ public SubmitAsyncSearchRequestDescriptor Ext(Func - /// Array of wildcard (*) patterns. The request returns values for field names
matching these patterns in the hits.fields property of the response. + /// + /// Array of wildcard (*) patterns. The request returns values for field names + /// matching these patterns in the hits.fields property of the response. + /// /// public SubmitAsyncSearchRequestDescriptor Fields(ICollection? fields) { @@ -2244,7 +2528,11 @@ public SubmitAsyncSearchRequestDescriptor Fields(params Action - /// Starting document offset. By default, you cannot page through more than 10,000
hits using the from and size parameters. To page through more hits, use the
search_after parameter. + /// + /// Starting document offset. By default, you cannot page through more than 10,000 + /// hits using the from and size parameters. To page through more hits, use the + /// search_after parameter. + /// /// public SubmitAsyncSearchRequestDescriptor From(int? from) { @@ -2277,7 +2565,9 @@ public SubmitAsyncSearchRequestDescriptor Highlight(Action - /// Boosts the _score of documents from specified indices. + /// + /// Boosts the _score of documents from specified indices. + /// /// public SubmitAsyncSearchRequestDescriptor IndicesBoost(ICollection>? indicesBoost) { @@ -2286,7 +2576,9 @@ public SubmitAsyncSearchRequestDescriptor IndicesBoost(ICollection - /// Defines the approximate kNN search to run. + /// + /// Defines the approximate kNN search to run. + /// /// public SubmitAsyncSearchRequestDescriptor Knn(ICollection? knn) { @@ -2325,7 +2617,10 @@ public SubmitAsyncSearchRequestDescriptor Knn(params Action - /// Minimum _score for matching documents. Documents with a lower _score are
not included in the search results. + /// + /// Minimum _score for matching documents. Documents with a lower _score are + /// not included in the search results. + /// /// public SubmitAsyncSearchRequestDescriptor MinScore(double? minScore) { @@ -2334,7 +2629,10 @@ public SubmitAsyncSearchRequestDescriptor MinScore(double? minScore) } /// - /// Limits the search to a point in time (PIT). If you provide a PIT, you
cannot specify an in the request path. + /// + /// Limits the search to a point in time (PIT). If you provide a PIT, you + /// cannot specify an <index> in the request path. + /// /// public SubmitAsyncSearchRequestDescriptor Pit(Elastic.Clients.Elasticsearch.Serverless.Core.Search.PointInTimeReference? pit) { @@ -2391,7 +2689,9 @@ public SubmitAsyncSearchRequestDescriptor Profile(bool? profile = true) } /// - /// Defines the search definition using the Query DSL. + /// + /// Defines the search definition using the Query DSL. + /// /// public SubmitAsyncSearchRequestDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -2454,7 +2754,10 @@ public SubmitAsyncSearchRequestDescriptor Rescore(params Action - /// Defines one or more runtime fields in the search request. These fields take
precedence over mapped fields with the same name. + /// + /// Defines one or more runtime fields in the search request. These fields take + /// precedence over mapped fields with the same name. + /// /// public SubmitAsyncSearchRequestDescriptor RuntimeMappings(Func, FluentDescriptorDictionary> selector) { @@ -2463,7 +2766,9 @@ public SubmitAsyncSearchRequestDescriptor RuntimeMappings(Func - /// Retrieve a script evaluation (based on different fields) for each hit. + /// + /// Retrieve a script evaluation (based on different fields) for each hit. + /// /// public SubmitAsyncSearchRequestDescriptor ScriptFields(Func, FluentDescriptorDictionary> selector) { @@ -2478,7 +2783,10 @@ public SubmitAsyncSearchRequestDescriptor SearchAfter(ICollection - /// If true, returns sequence number and primary term of the last modification
of each hit. See Optimistic concurrency control. + /// + /// If true, returns sequence number and primary term of the last modification + /// of each hit. See Optimistic concurrency control. + /// /// public SubmitAsyncSearchRequestDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = true) { @@ -2487,7 +2795,11 @@ public SubmitAsyncSearchRequestDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTer } /// - /// The number of hits to return. By default, you cannot page through more
than 10,000 hits using the from and size parameters. To page through more
hits, use the search_after parameter. + /// + /// The number of hits to return. By default, you cannot page through more + /// than 10,000 hits using the from and size parameters. To page through more + /// hits, use the search_after parameter. + /// /// public SubmitAsyncSearchRequestDescriptor Size(int? size) { @@ -2556,7 +2868,10 @@ public SubmitAsyncSearchRequestDescriptor Sort(params Action - /// Indicates which source fields are returned for matching documents. These
fields are returned in the hits._source property of the search response. + /// + /// Indicates which source fields are returned for matching documents. These + /// fields are returned in the hits._source property of the search response. + /// /// public SubmitAsyncSearchRequestDescriptor Source(Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfig? source) { @@ -2565,7 +2880,11 @@ public SubmitAsyncSearchRequestDescriptor Source(Elastic.Clients.Elasticsearch.S } /// - /// Stats groups to associate with the search. Each group maintains a statistics
aggregation for its associated searches. You can retrieve these stats using
the indices stats API. + /// + /// Stats groups to associate with the search. Each group maintains a statistics + /// aggregation for its associated searches. You can retrieve these stats using + /// the indices stats API. + /// /// public SubmitAsyncSearchRequestDescriptor Stats(ICollection? stats) { @@ -2574,7 +2893,12 @@ public SubmitAsyncSearchRequestDescriptor Stats(ICollection? stats) } /// - /// List of stored fields to return as part of a hit. If no fields are specified,
no stored fields are included in the response. If this field is specified, the _source
parameter defaults to false. You can pass _source: true to return both source fields
and stored fields in the search response. + /// + /// List of stored fields to return as part of a hit. If no fields are specified, + /// no stored fields are included in the response. If this field is specified, the _source + /// parameter defaults to false. You can pass _source: true to return both source fields + /// and stored fields in the search response. + /// /// public SubmitAsyncSearchRequestDescriptor StoredFields(Elastic.Clients.Elasticsearch.Serverless.Fields? storedFields) { @@ -2607,7 +2931,11 @@ public SubmitAsyncSearchRequestDescriptor Suggest(Action - /// Maximum number of documents to collect for each shard. If a query reaches this
limit, Elasticsearch terminates the query early. Elasticsearch collects documents
before sorting. Defaults to 0, which does not terminate query execution early. + /// + /// Maximum number of documents to collect for each shard. If a query reaches this + /// limit, Elasticsearch terminates the query early. Elasticsearch collects documents + /// before sorting. Defaults to 0, which does not terminate query execution early. + /// /// public SubmitAsyncSearchRequestDescriptor TerminateAfter(long? terminateAfter) { @@ -2616,7 +2944,11 @@ public SubmitAsyncSearchRequestDescriptor TerminateAfter(long? terminateAfter) } /// - /// Specifies the period of time to wait for a response from each shard. If no response
is received before the timeout expires, the request fails and returns an error.
Defaults to no timeout. + /// + /// Specifies the period of time to wait for a response from each shard. If no response + /// is received before the timeout expires, the request fails and returns an error. + /// Defaults to no timeout. + /// /// public SubmitAsyncSearchRequestDescriptor Timeout(string? timeout) { @@ -2625,7 +2957,9 @@ public SubmitAsyncSearchRequestDescriptor Timeout(string? timeout) } /// - /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// + /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// /// public SubmitAsyncSearchRequestDescriptor TrackScores(bool? trackScores = true) { @@ -2634,7 +2968,12 @@ public SubmitAsyncSearchRequestDescriptor TrackScores(bool? trackScores = true) } /// - /// Number of hits matching the query to count accurately. If true, the exact
number of hits is returned at the cost of some performance. If false, the
response does not include the total number of hits matching the query.
Defaults to 10,000 hits. + /// + /// Number of hits matching the query to count accurately. If true, the exact + /// number of hits is returned at the cost of some performance. If false, the + /// response does not include the total number of hits matching the query. + /// Defaults to 10,000 hits. + /// /// public SubmitAsyncSearchRequestDescriptor TrackTotalHits(Elastic.Clients.Elasticsearch.Serverless.Core.Search.TrackHits? trackTotalHits) { @@ -2643,7 +2982,9 @@ public SubmitAsyncSearchRequestDescriptor TrackTotalHits(Elastic.Clients.Elastic } /// - /// If true, returns document version as part of a hit. + /// + /// If true, returns document version as part of a hit. + /// /// public SubmitAsyncSearchRequestDescriptor Version(bool? version = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/SubmitAsyncSearchResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/SubmitAsyncSearchResponse.g.cs index d3f0f0c91d8..2aa8d3f0afe 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/SubmitAsyncSearchResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/SubmitAsyncSearchResponse.g.cs @@ -29,7 +29,10 @@ namespace Elastic.Clients.Elasticsearch.Serverless.AsyncSearch; public sealed partial class SubmitAsyncSearchResponse : ElasticsearchResponse { /// - /// Indicates when the async search completed. Only present
when the search has completed. + /// + /// Indicates when the async search completed. Only present + /// when the search has completed. + /// /// [JsonInclude, JsonPropertyName("completion_time")] public DateTimeOffset? CompletionTime { get; init; } @@ -37,7 +40,9 @@ public sealed partial class SubmitAsyncSearchResponse : Elasticsearch public long? CompletionTimeInMillis { get; init; } /// - /// Indicates when the async search will expire. + /// + /// Indicates when the async search will expire. + /// /// [JsonInclude, JsonPropertyName("expiration_time")] public DateTimeOffset? ExpirationTime { get; init; } @@ -47,13 +52,19 @@ public sealed partial class SubmitAsyncSearchResponse : Elasticsearch public string? Id { get; init; } /// - /// When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards.
While the query is running, `is_partial` is always set to `true`. + /// + /// When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards. + /// While the query is running, is_partial is always set to true. + /// /// [JsonInclude, JsonPropertyName("is_partial")] public bool IsPartial { get; init; } /// - /// Indicates whether the search is still running or has completed.
NOTE: If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though `is_running` is `false`. + /// + /// Indicates whether the search is still running or has completed. + /// NOTE: If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though is_running is false. + /// /// [JsonInclude, JsonPropertyName("is_running")] public bool IsRunning { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/BulkRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/BulkRequest.g.cs index 505857eaf9a..65263841972 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/BulkRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/BulkRequest.g.cs @@ -32,53 +32,79 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class BulkRequestParameters : RequestParameters { /// - /// ID of the pipeline to use to preprocess incoming documents.
If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.
If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// + /// ID of the pipeline to use to preprocess incoming documents. + /// If the index has a default ingest pipeline specified, then setting the value to _none disables the default ingest pipeline for this request. + /// If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// /// public string? Pipeline { get => Q("pipeline"); set => Q("pipeline", value); } /// - /// If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.
Valid values: `true`, `false`, `wait_for`. + /// + /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false do nothing with refreshes. + /// Valid values: true, false, wait_for. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Refresh? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// If `true`, the request’s actions must target an index alias. + /// + /// If true, the request’s actions must target an index alias. + /// /// public bool? RequireAlias { get => Q("require_alias"); set => Q("require_alias", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// `true` or `false` to return the `_source` field or not, or a list of fields to return. + /// + /// true or false to return the _source field or not, or a list of fields to return. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfigParam? Source { get => Q("_source"); set => Q("_source", value); } /// - /// A comma-separated list of source fields to exclude from the response. + /// + /// A comma-separated list of source fields to exclude from the response. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response. + /// + /// A comma-separated list of source fields to include in the response. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// Period each action waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. + /// + /// Period each action waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// public Elastic.Clients.Elasticsearch.Serverless.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. +/// +/// Bulk index or delete documents. +/// Performs multiple indexing or delete operations in a single API call. +/// This reduces overhead and can greatly increase indexing speed. +/// /// public sealed partial class BulkRequest : PlainRequest { @@ -99,62 +125,88 @@ public BulkRequest(Elastic.Clients.Elasticsearch.Serverless.IndexName? index) : internal override string OperationName => "bulk"; /// - /// ID of the pipeline to use to preprocess incoming documents.
If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.
If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// + /// ID of the pipeline to use to preprocess incoming documents. + /// If the index has a default ingest pipeline specified, then setting the value to _none disables the default ingest pipeline for this request. + /// If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// /// [JsonIgnore] public string? Pipeline { get => Q("pipeline"); set => Q("pipeline", value); } /// - /// If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.
Valid values: `true`, `false`, `wait_for`. + /// + /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false do nothing with refreshes. + /// Valid values: true, false, wait_for. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Refresh? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// If `true`, the request’s actions must target an index alias. + /// + /// If true, the request’s actions must target an index alias. + /// /// [JsonIgnore] public bool? RequireAlias { get => Q("require_alias"); set => Q("require_alias", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// `true` or `false` to return the `_source` field or not, or a list of fields to return. + /// + /// true or false to return the _source field or not, or a list of fields to return. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfigParam? Source { get => Q("_source"); set => Q("_source", value); } /// - /// A comma-separated list of source fields to exclude from the response. + /// + /// A comma-separated list of source fields to exclude from the response. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response. + /// + /// A comma-separated list of source fields to include in the response. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// Period each action waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. + /// + /// Period each action waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. +/// +/// Bulk index or delete documents. +/// Performs multiple indexing or delete operations in a single API call. +/// This reduces overhead and can greatly increase indexing speed. +/// /// public sealed partial class BulkRequestDescriptor : RequestDescriptor, BulkRequestParameters> { @@ -200,7 +252,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. +/// +/// Bulk index or delete documents. +/// Performs multiple indexing or delete operations in a single API call. +/// This reduces overhead and can greatly increase indexing speed. +/// /// public sealed partial class BulkRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ClearScrollRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ClearScrollRequest.g.cs index 5405011e488..7fcb74ce47c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ClearScrollRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ClearScrollRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class ClearScrollRequestParameters : RequestParameters } /// -/// Clears the search context and results for a scrolling search. +/// +/// Clears the search context and results for a scrolling search. +/// /// public sealed partial class ClearScrollRequest : PlainRequest { @@ -47,14 +49,19 @@ public sealed partial class ClearScrollRequest : PlainRequest "clear_scroll"; /// - /// Scroll IDs to clear.
To clear all scroll IDs, use `_all`. + /// + /// Scroll IDs to clear. + /// To clear all scroll IDs, use _all. + /// /// [JsonInclude, JsonPropertyName("scroll_id")] public Elastic.Clients.Elasticsearch.Serverless.ScrollIds? ScrollId { get; set; } } /// -/// Clears the search context and results for a scrolling search. +/// +/// Clears the search context and results for a scrolling search. +/// /// public sealed partial class ClearScrollRequestDescriptor : RequestDescriptor { @@ -75,7 +82,10 @@ public ClearScrollRequestDescriptor() private Elastic.Clients.Elasticsearch.Serverless.ScrollIds? ScrollIdValue { get; set; } /// - /// Scroll IDs to clear.
To clear all scroll IDs, use `_all`. + /// + /// Scroll IDs to clear. + /// To clear all scroll IDs, use _all. + /// /// public ClearScrollRequestDescriptor ScrollId(Elastic.Clients.Elasticsearch.Serverless.ScrollIds? scrollId) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ClosePointInTimeRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ClosePointInTimeRequest.g.cs index ce718f1935e..b8a16c05cd3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ClosePointInTimeRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ClosePointInTimeRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class ClosePointInTimeRequestParameters : RequestParameter } /// -/// Closes a point-in-time. +/// +/// Closes a point-in-time. +/// /// public sealed partial class ClosePointInTimeRequest : PlainRequest { @@ -47,14 +49,18 @@ public sealed partial class ClosePointInTimeRequest : PlainRequest "close_point_in_time"; /// - /// The ID of the point-in-time. + /// + /// The ID of the point-in-time. + /// /// [JsonInclude, JsonPropertyName("id")] public Elastic.Clients.Elasticsearch.Serverless.Id Id { get; set; } } /// -/// Closes a point-in-time. +/// +/// Closes a point-in-time. +/// /// public sealed partial class ClosePointInTimeRequestDescriptor : RequestDescriptor { @@ -75,7 +81,9 @@ public ClosePointInTimeRequestDescriptor() private Elastic.Clients.Elasticsearch.Serverless.Id IdValue { get; set; } /// - /// The ID of the point-in-time. + /// + /// The ID of the point-in-time. + /// /// public ClosePointInTimeRequestDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id id) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/AllocationExplainRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/AllocationExplainRequest.g.cs index 2c7a8b971c0..47b3e3d5d75 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/AllocationExplainRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/AllocationExplainRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class AllocationExplainRequestParameters : RequestParameters { /// - /// If true, returns information about disk usage and shard sizes. + /// + /// If true, returns information about disk usage and shard sizes. + /// /// public bool? IncludeDiskInfo { get => Q("include_disk_info"); set => Q("include_disk_info", value); } /// - /// If true, returns YES decisions in explanation. + /// + /// If true, returns YES decisions in explanation. + /// /// public bool? IncludeYesDecisions { get => Q("include_yes_decisions"); set => Q("include_yes_decisions", value); } } /// -/// Provides explanations for shard allocations in the cluster. +/// +/// Provides explanations for shard allocations in the cluster. +/// /// public sealed partial class AllocationExplainRequest : PlainRequest { @@ -56,44 +62,58 @@ public sealed partial class AllocationExplainRequest : PlainRequest "cluster.allocation_explain"; /// - /// If true, returns information about disk usage and shard sizes. + /// + /// If true, returns information about disk usage and shard sizes. + /// /// [JsonIgnore] public bool? IncludeDiskInfo { get => Q("include_disk_info"); set => Q("include_disk_info", value); } /// - /// If true, returns YES decisions in explanation. + /// + /// If true, returns YES decisions in explanation. + /// /// [JsonIgnore] public bool? IncludeYesDecisions { get => Q("include_yes_decisions"); set => Q("include_yes_decisions", value); } /// - /// Specifies the node ID or the name of the node to only explain a shard that is currently located on the specified node. + /// + /// Specifies the node ID or the name of the node to only explain a shard that is currently located on the specified node. + /// /// [JsonInclude, JsonPropertyName("current_node")] public string? CurrentNode { get; set; } /// - /// Specifies the name of the index that you would like an explanation for. + /// + /// Specifies the name of the index that you would like an explanation for. + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.Serverless.IndexName? Index { get; set; } /// - /// If true, returns explanation for the primary shard for the given shard ID. + /// + /// If true, returns explanation for the primary shard for the given shard ID. + /// /// [JsonInclude, JsonPropertyName("primary")] public bool? Primary { get; set; } /// - /// Specifies the ID of the shard that you would like an explanation for. + /// + /// Specifies the ID of the shard that you would like an explanation for. + /// /// [JsonInclude, JsonPropertyName("shard")] public int? Shard { get; set; } } /// -/// Provides explanations for shard allocations in the cluster. +/// +/// Provides explanations for shard allocations in the cluster. +/// /// public sealed partial class AllocationExplainRequestDescriptor : RequestDescriptor { @@ -120,7 +140,9 @@ public AllocationExplainRequestDescriptor() private int? ShardValue { get; set; } /// - /// Specifies the node ID or the name of the node to only explain a shard that is currently located on the specified node. + /// + /// Specifies the node ID or the name of the node to only explain a shard that is currently located on the specified node. + /// /// public AllocationExplainRequestDescriptor CurrentNode(string? currentNode) { @@ -129,7 +151,9 @@ public AllocationExplainRequestDescriptor CurrentNode(string? currentNode) } /// - /// Specifies the name of the index that you would like an explanation for. + /// + /// Specifies the name of the index that you would like an explanation for. + /// /// public AllocationExplainRequestDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.IndexName? index) { @@ -138,7 +162,9 @@ public AllocationExplainRequestDescriptor Index(Elastic.Clients.Elasticsearch.Se } /// - /// If true, returns explanation for the primary shard for the given shard ID. + /// + /// If true, returns explanation for the primary shard for the given shard ID. + /// /// public AllocationExplainRequestDescriptor Primary(bool? primary = true) { @@ -147,7 +173,9 @@ public AllocationExplainRequestDescriptor Primary(bool? primary = true) } /// - /// Specifies the ID of the shard that you would like an explanation for. + /// + /// Specifies the ID of the shard that you would like an explanation for. + /// /// public AllocationExplainRequestDescriptor Shard(int? shard) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/ClusterInfoRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/ClusterInfoRequest.g.cs index 5b0d61c446b..170fa7a9c24 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/ClusterInfoRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/ClusterInfoRequest.g.cs @@ -34,7 +34,10 @@ public sealed partial class ClusterInfoRequestParameters : RequestParameters } /// -/// Get cluster info.
Returns basic information about the cluster. +/// +/// Get cluster info. +/// Returns basic information about the cluster. +/// /// public sealed partial class ClusterInfoRequest : PlainRequest { @@ -52,7 +55,10 @@ public ClusterInfoRequest(IReadOnlyCollection -/// Get cluster info.
Returns basic information about the cluster. +/// +/// Get cluster info. +/// Returns basic information about the cluster. +/// /// public sealed partial class ClusterInfoRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/ClusterStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/ClusterStatsRequest.g.cs index 50695cbe5a7..f3ac2f6392f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/ClusterStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/ClusterStatsRequest.g.cs @@ -32,18 +32,27 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class ClusterStatsRequestParameters : RequestParameters { /// - /// If `true`, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// Period to wait for each node to respond.
If a node does not respond before its timeout expires, the response does not include its stats.
However, timed out nodes are included in the response’s `_nodes.failed` property. Defaults to no timeout. + /// + /// Period to wait for each node to respond. + /// If a node does not respond before its timeout expires, the response does not include its stats. + /// However, timed out nodes are included in the response’s _nodes.failed property. Defaults to no timeout. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Returns cluster statistics.
It returns 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). +/// +/// Returns cluster statistics. +/// It returns 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). +/// /// public sealed partial class ClusterStatsRequest : PlainRequest { @@ -64,20 +73,29 @@ public ClusterStatsRequest(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nod internal override string OperationName => "cluster.stats"; /// - /// If `true`, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// [JsonIgnore] public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// Period to wait for each node to respond.
If a node does not respond before its timeout expires, the response does not include its stats.
However, timed out nodes are included in the response’s `_nodes.failed` property. Defaults to no timeout. + /// + /// Period to wait for each node to respond. + /// If a node does not respond before its timeout expires, the response does not include its stats. + /// However, timed out nodes are included in the response’s _nodes.failed property. Defaults to no timeout. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Returns cluster statistics.
It returns 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). +/// +/// Returns cluster statistics. +/// It returns 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). +/// /// public sealed partial class ClusterStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/ClusterStatsResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/ClusterStatsResponse.g.cs index 119e9127b3f..12d77b02a34 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/ClusterStatsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/ClusterStatsResponse.g.cs @@ -29,43 +29,57 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class ClusterStatsResponse : ElasticsearchResponse { /// - /// Name of the cluster, based on the cluster name setting. + /// + /// Name of the cluster, based on the cluster name setting. + /// /// [JsonInclude, JsonPropertyName("cluster_name")] public string ClusterName { get; init; } /// - /// Unique identifier for the cluster. + /// + /// Unique identifier for the cluster. + /// /// [JsonInclude, JsonPropertyName("cluster_uuid")] public string ClusterUuid { get; init; } /// - /// Contains statistics about indices with shards assigned to selected nodes. + /// + /// Contains statistics about indices with shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("indices")] public Elastic.Clients.Elasticsearch.Serverless.Cluster.ClusterIndices Indices { get; init; } /// - /// Contains statistics about nodes selected by the request’s node filters. + /// + /// Contains statistics about nodes selected by the request’s node filters. + /// /// [JsonInclude, JsonPropertyName("nodes")] public Elastic.Clients.Elasticsearch.Serverless.Cluster.ClusterNodes Nodes { get; init; } /// - /// Contains statistics about the number of nodes selected by the request’s node filters. + /// + /// Contains statistics about the number of nodes selected by the request’s node filters. + /// /// [JsonInclude, JsonPropertyName("_nodes")] public Elastic.Clients.Elasticsearch.Serverless.NodeStatistics? NodeStats { get; init; } /// - /// Health status of the cluster, based on the state of its primary and replica shards. + /// + /// Health status of the cluster, based on the state of its primary and replica shards. + /// /// [JsonInclude, JsonPropertyName("status")] public Elastic.Clients.Elasticsearch.Serverless.HealthStatus Status { get; init; } /// - /// Unix timestamp, in milliseconds, for the last time the cluster statistics were refreshed. + /// + /// Unix timestamp, in milliseconds, for the last time the cluster statistics were refreshed. + /// /// [JsonInclude, JsonPropertyName("timestamp")] public long Timestamp { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/DeleteComponentTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/DeleteComponentTemplateRequest.g.cs index 03baac488c0..d4196ab4fe1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/DeleteComponentTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/DeleteComponentTemplateRequest.g.cs @@ -32,18 +32,28 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class DeleteComponentTemplateRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete component templates.
Deletes component templates.
Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. +/// +/// Delete component templates. +/// Deletes component templates. +/// Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. +/// /// public sealed partial class DeleteComponentTemplateRequest : PlainRequest { @@ -60,20 +70,30 @@ public DeleteComponentTemplateRequest(Elastic.Clients.Elasticsearch.Serverless.N internal override string OperationName => "cluster.delete_component_template"; /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete component templates.
Deletes component templates.
Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. +/// +/// Delete component templates. +/// Deletes component templates. +/// Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. +/// /// public sealed partial class DeleteComponentTemplateRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/DeleteComponentTemplateResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/DeleteComponentTemplateResponse.g.cs index 2feae02a660..e0f3c244fef 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/DeleteComponentTemplateResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/DeleteComponentTemplateResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class DeleteComponentTemplateResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/ExistsComponentTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/ExistsComponentTemplateRequest.g.cs index f2b2db58bf3..56298476081 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/ExistsComponentTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/ExistsComponentTemplateRequest.g.cs @@ -32,18 +32,28 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class ExistsComponentTemplateRequestParameters : RequestParameters { /// - /// If true, the request retrieves information from the local node only.
Defaults to false, which means information is retrieved from the master node. + /// + /// If true, the request retrieves information from the local node only. + /// Defaults to false, which means information is retrieved from the master node. + /// /// public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node. If no response is
received before the timeout expires, the request fails and returns an
error. + /// + /// Period to wait for a connection to the master node. If no response is + /// received before the timeout expires, the request fails and returns an + /// error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Check component templates.
Returns information about whether a particular component template exists. +/// +/// Check component templates. +/// Returns information about whether a particular component template exists. +/// /// public sealed partial class ExistsComponentTemplateRequest : PlainRequest { @@ -60,20 +70,30 @@ public ExistsComponentTemplateRequest(Elastic.Clients.Elasticsearch.Serverless.N internal override string OperationName => "cluster.exists_component_template"; /// - /// If true, the request retrieves information from the local node only.
Defaults to false, which means information is retrieved from the master node. + /// + /// If true, the request retrieves information from the local node only. + /// Defaults to false, which means information is retrieved from the master node. + /// /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node. If no response is
received before the timeout expires, the request fails and returns an
error. + /// + /// Period to wait for a connection to the master node. If no response is + /// received before the timeout expires, the request fails and returns an + /// error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Check component templates.
Returns information about whether a particular component template exists. +/// +/// Check component templates. +/// Returns information about whether a particular component template exists. +/// /// public sealed partial class ExistsComponentTemplateRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/GetClusterSettingsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/GetClusterSettingsRequest.g.cs index 375cb6fb3ca..90cc00b8be0 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/GetClusterSettingsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/GetClusterSettingsRequest.g.cs @@ -32,28 +32,41 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class GetClusterSettingsRequestParameters : RequestParameters { /// - /// If `true`, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// If `true`, returns default cluster settings from the local node. + /// + /// If true, returns default cluster settings from the local node. + /// /// public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Returns cluster-wide settings.
By default, it returns only settings that have been explicitly defined. +/// +/// Returns cluster-wide settings. +/// By default, it returns only settings that have been explicitly defined. +/// /// public sealed partial class GetClusterSettingsRequest : PlainRequest { @@ -66,32 +79,45 @@ public sealed partial class GetClusterSettingsRequest : PlainRequest "cluster.get_settings"; /// - /// If `true`, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// [JsonIgnore] public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// If `true`, returns default cluster settings from the local node. + /// + /// If true, returns default cluster settings from the local node. + /// /// [JsonIgnore] public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Returns cluster-wide settings.
By default, it returns only settings that have been explicitly defined. +/// +/// Returns cluster-wide settings. +/// By default, it returns only settings that have been explicitly defined. +/// /// public sealed partial class GetClusterSettingsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/GetComponentTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/GetComponentTemplateRequest.g.cs index 1012b6d0fe0..952edd6d748 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/GetComponentTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/GetComponentTemplateRequest.g.cs @@ -32,28 +32,41 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class GetComponentTemplateRequestParameters : RequestParameters { /// - /// If `true`, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// Return all default configurations for the component template (default: false) + /// + /// Return all default configurations for the component template (default: false) + /// /// public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// If `true`, the request retrieves information from the local node only.
If `false`, information is retrieved from the master node. + /// + /// If true, the request retrieves information from the local node only. + /// If false, information is retrieved from the master node. + /// /// public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get component templates.
Retrieves information about component templates. +/// +/// Get component templates. +/// Retrieves information about component templates. +/// /// public sealed partial class GetComponentTemplateRequest : PlainRequest { @@ -74,32 +87,45 @@ public GetComponentTemplateRequest(Elastic.Clients.Elasticsearch.Serverless.Name internal override string OperationName => "cluster.get_component_template"; /// - /// If `true`, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// [JsonIgnore] public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// Return all default configurations for the component template (default: false) + /// + /// Return all default configurations for the component template (default: false) + /// /// [JsonIgnore] public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// If `true`, the request retrieves information from the local node only.
If `false`, information is retrieved from the master node. + /// + /// If true, the request retrieves information from the local node only. + /// If false, information is retrieved from the master node. + /// /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get component templates.
Retrieves information about component templates. +/// +/// Get component templates. +/// Retrieves information about component templates. +/// /// public sealed partial class GetComponentTemplateRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/HealthRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/HealthRequest.g.cs index 9d9bd0502bb..c1acf1cbf5a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/HealthRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/HealthRequest.g.cs @@ -32,63 +32,88 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class HealthRequestParameters : RequestParameters { /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// + /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Can be one of cluster, indices or shards. Controls the details level of the health information returned. + /// + /// Can be one of cluster, indices or shards. Controls the details level of the health information returned. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Level? Level { get => Q("level"); set => Q("level", value); } /// - /// If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + /// + /// If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + /// /// public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait. + /// + /// A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait. + /// /// public Elastic.Clients.Elasticsearch.Serverless.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } /// - /// Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed. + /// + /// Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed. + /// /// public Elastic.Clients.Elasticsearch.Serverless.WaitForEvents? WaitForEvents { get => Q("wait_for_events"); set => Q("wait_for_events", value); } /// - /// The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and + /// + /// The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and <N. Alternatively, it is possible to use ge(N), le(N), gt(N) and lt(N) notation. + /// /// public object? WaitForNodes { get => Q("wait_for_nodes"); set => Q("wait_for_nodes", value); } /// - /// A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards. + /// + /// A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards. + /// /// public bool? WaitForNoInitializingShards { get => Q("wait_for_no_initializing_shards"); set => Q("wait_for_no_initializing_shards", value); } /// - /// A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards. + /// + /// A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards. + /// /// public bool? WaitForNoRelocatingShards { get => Q("wait_for_no_relocating_shards"); set => Q("wait_for_no_relocating_shards", value); } /// - /// One of green, yellow or red. Will wait (until the timeout provided) until the status of the cluster changes to the one provided or better, i.e. green > yellow > red. By default, will not wait for any status. + /// + /// One of green, yellow or red. Will wait (until the timeout provided) until the status of the cluster changes to the one provided or better, i.e. green > yellow > red. By default, will not wait for any status. + /// /// public Elastic.Clients.Elasticsearch.Serverless.HealthStatus? WaitForStatus { get => Q("wait_for_status"); set => Q("wait_for_status", value); } } /// -/// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. +/// +/// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. +/// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. +/// /// public sealed partial class HealthRequest : PlainRequest { @@ -109,74 +134,99 @@ public HealthRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? indices) internal override string OperationName => "cluster.health"; /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// + /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Can be one of cluster, indices or shards. Controls the details level of the health information returned. + /// + /// Can be one of cluster, indices or shards. Controls the details level of the health information returned. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Level? Level { get => Q("level"); set => Q("level", value); } /// - /// If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + /// + /// If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + /// /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait. + /// + /// A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } /// - /// Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed. + /// + /// Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.WaitForEvents? WaitForEvents { get => Q("wait_for_events"); set => Q("wait_for_events", value); } /// - /// The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and + /// + /// The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and <N. Alternatively, it is possible to use ge(N), le(N), gt(N) and lt(N) notation. + /// /// [JsonIgnore] public object? WaitForNodes { get => Q("wait_for_nodes"); set => Q("wait_for_nodes", value); } /// - /// A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards. + /// + /// A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards. + /// /// [JsonIgnore] public bool? WaitForNoInitializingShards { get => Q("wait_for_no_initializing_shards"); set => Q("wait_for_no_initializing_shards", value); } /// - /// A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards. + /// + /// A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards. + /// /// [JsonIgnore] public bool? WaitForNoRelocatingShards { get => Q("wait_for_no_relocating_shards"); set => Q("wait_for_no_relocating_shards", value); } /// - /// One of green, yellow or red. Will wait (until the timeout provided) until the status of the cluster changes to the one provided or better, i.e. green > yellow > red. By default, will not wait for any status. + /// + /// One of green, yellow or red. Will wait (until the timeout provided) until the status of the cluster changes to the one provided or better, i.e. green > yellow > red. By default, will not wait for any status. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.HealthStatus? WaitForStatus { get => Q("wait_for_status"); set => Q("wait_for_status", value); } } /// -/// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. +/// +/// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. +/// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. +/// /// public sealed partial class HealthRequestDescriptor : RequestDescriptor, HealthRequestParameters> { @@ -222,7 +272,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. +/// +/// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. +/// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. +/// /// public sealed partial class HealthRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/HealthResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/HealthResponse.g.cs index 2e3d68fe7d0..a3fac39235a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/HealthResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/HealthResponse.g.cs @@ -29,31 +29,41 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class HealthResponse : ElasticsearchResponse { /// - /// The number of active primary shards. + /// + /// The number of active primary shards. + /// /// [JsonInclude, JsonPropertyName("active_primary_shards")] public int ActivePrimaryShards { get; init; } /// - /// The total number of active primary and replica shards. + /// + /// The total number of active primary and replica shards. + /// /// [JsonInclude, JsonPropertyName("active_shards")] public int ActiveShards { get; init; } /// - /// The ratio of active shards in the cluster expressed as a percentage. + /// + /// The ratio of active shards in the cluster expressed as a percentage. + /// /// [JsonInclude, JsonPropertyName("active_shards_percent_as_number")] public double ActiveShardsPercentAsNumber { get; init; } /// - /// The name of the cluster. + /// + /// The name of the cluster. + /// /// [JsonInclude, JsonPropertyName("cluster_name")] public string ClusterName { get; init; } /// - /// The number of shards whose allocation has been delayed by the timeout settings. + /// + /// The number of shards whose allocation has been delayed by the timeout settings. + /// /// [JsonInclude, JsonPropertyName("delayed_unassigned_shards")] public int DelayedUnassignedShards { get; init; } @@ -62,37 +72,49 @@ public sealed partial class HealthResponse : ElasticsearchResponse public IReadOnlyDictionary? Indices { get; init; } /// - /// The number of shards that are under initialization. + /// + /// The number of shards that are under initialization. + /// /// [JsonInclude, JsonPropertyName("initializing_shards")] public int InitializingShards { get; init; } /// - /// The number of nodes that are dedicated data nodes. + /// + /// The number of nodes that are dedicated data nodes. + /// /// [JsonInclude, JsonPropertyName("number_of_data_nodes")] public int NumberOfDataNodes { get; init; } /// - /// The number of unfinished fetches. + /// + /// The number of unfinished fetches. + /// /// [JsonInclude, JsonPropertyName("number_of_in_flight_fetch")] public int NumberOfInFlightFetch { get; init; } /// - /// The number of nodes within the cluster. + /// + /// The number of nodes within the cluster. + /// /// [JsonInclude, JsonPropertyName("number_of_nodes")] public int NumberOfNodes { get; init; } /// - /// The number of cluster-level changes that have not yet been executed. + /// + /// The number of cluster-level changes that have not yet been executed. + /// /// [JsonInclude, JsonPropertyName("number_of_pending_tasks")] public int NumberOfPendingTasks { get; init; } /// - /// The number of shards that are under relocation. + /// + /// The number of shards that are under relocation. + /// /// [JsonInclude, JsonPropertyName("relocating_shards")] public int RelocatingShards { get; init; } @@ -100,25 +122,33 @@ public sealed partial class HealthResponse : ElasticsearchResponse public Elastic.Clients.Elasticsearch.Serverless.HealthStatus Status { get; init; } /// - /// The time since the earliest initiated task is waiting for being performed. + /// + /// The time since the earliest initiated task is waiting for being performed. + /// /// [JsonInclude, JsonPropertyName("task_max_waiting_in_queue")] public Elastic.Clients.Elasticsearch.Serverless.Duration? TaskMaxWaitingInQueue { get; init; } /// - /// The time expressed in milliseconds since the earliest initiated task is waiting for being performed. + /// + /// The time expressed in milliseconds since the earliest initiated task is waiting for being performed. + /// /// [JsonInclude, JsonPropertyName("task_max_waiting_in_queue_millis")] public long TaskMaxWaitingInQueueMillis { get; init; } /// - /// If false the response returned within the period of time that is specified by the timeout parameter (30s by default) + /// + /// If false the response returned within the period of time that is specified by the timeout parameter (30s by default) + /// /// [JsonInclude, JsonPropertyName("timed_out")] public bool TimedOut { get; init; } /// - /// The number of shards that are not allocated. + /// + /// The number of shards that are not allocated. + /// /// [JsonInclude, JsonPropertyName("unassigned_shards")] public int UnassignedShards { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/PendingTasksRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/PendingTasksRequest.g.cs index 456b0887841..82887bf785b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/PendingTasksRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/PendingTasksRequest.g.cs @@ -32,18 +32,29 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class PendingTasksRequestParameters : RequestParameters { /// - /// If `true`, the request retrieves information from the local node only.
If `false`, information is retrieved from the master node. + /// + /// If true, the request retrieves information from the local node only. + /// If false, information is retrieved from the master node. + /// /// public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed.
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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests.
However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. +/// +/// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. +/// 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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. +/// However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. +/// /// public sealed partial class PendingTasksRequest : PlainRequest { @@ -56,20 +67,31 @@ public sealed partial class PendingTasksRequest : PlainRequest "cluster.pending_tasks"; /// - /// If `true`, the request retrieves information from the local node only.
If `false`, information is retrieved from the master node. + /// + /// If true, the request retrieves information from the local node only. + /// If false, information is retrieved from the master node. + /// /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed.
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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests.
However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. +/// +/// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. +/// 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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. +/// However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. +/// /// public sealed partial class PendingTasksRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/PutComponentTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/PutComponentTemplateRequest.g.cs index ff4bc7a9f89..ef662199d23 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/PutComponentTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/PutComponentTemplateRequest.g.cs @@ -32,22 +32,44 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class PutComponentTemplateRequestParameters : RequestParameters { /// - /// If `true`, this request cannot replace or update existing component templates. + /// + /// If true, this request cannot replace or update existing component templates. + /// /// public bool? Create { get => Q("create"); set => Q("create", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Create or update a component template.
Creates or updates 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 `composed_of` list.
Component templates are only applied to new data streams and indices as part of a matching index template. -/// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. -/// Component templates are only used during index creation.
For data streams, this includes data stream creation and the creation of a stream’s backing indices.
Changes to component templates do not affect existing indices, including a stream’s backing indices. -/// You can use C-style `/* *\/` block comments in component templates.
You can include comments anywhere in the request body except before the opening curly bracket. +/// +/// Create or update a component template. +/// Creates or updates 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 composed_of list. +/// Component templates are only applied to new data streams and indices as part of a matching index template. +/// +/// +/// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. +/// +/// +/// Component templates are only used during index creation. +/// For data streams, this includes data stream creation and the creation of a stream’s backing indices. +/// Changes to component templates do not affect existing indices, including a stream’s backing indices. +/// +/// +/// You can use C-style /* *\/ block comments in component templates. +/// You can include comments anywhere in the request body except before the opening curly bracket. +/// /// public sealed partial class PutComponentTemplateRequest : PlainRequest { @@ -64,48 +86,84 @@ public PutComponentTemplateRequest(Elastic.Clients.Elasticsearch.Serverless.Name internal override string OperationName => "cluster.put_component_template"; /// - /// If `true`, this request cannot replace or update existing component templates. + /// + /// If true, this request cannot replace or update existing component templates. + /// /// [JsonIgnore] public bool? Create { get => Q("create"); set => Q("create", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Marks this index template as deprecated. When creating or updating a non-deprecated index template
that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// + /// Marks this index template as deprecated. When creating or updating a non-deprecated index template + /// that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// /// [JsonInclude, JsonPropertyName("deprecated")] public bool? Deprecated { get; set; } /// - /// Optional user metadata about the component template.
May have any contents. This map is not automatically generated by Elasticsearch.
This information is stored in the cluster state, so keeping it short is preferable.
To unset `_meta`, replace the template without specifying this information. + /// + /// Optional user metadata about the component template. + /// May have any contents. This map is not automatically generated by Elasticsearch. + /// This information is stored in the cluster state, so keeping it short is preferable. + /// To unset _meta, replace the template without specifying this information. + /// /// [JsonInclude, JsonPropertyName("_meta")] public IDictionary? Meta { get; set; } /// - /// The template to be applied which includes mappings, settings, or aliases configuration. + /// + /// The template to be applied which includes mappings, settings, or aliases configuration. + /// /// [JsonInclude, JsonPropertyName("template")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexState Template { get; set; } /// - /// Version number used to manage component templates externally.
This number isn't automatically generated or incremented by Elasticsearch.
To unset a version, replace the template without specifying a version. + /// + /// Version number used to manage component templates externally. + /// This number isn't automatically generated or incremented by Elasticsearch. + /// To unset a version, replace the template without specifying a version. + /// /// [JsonInclude, JsonPropertyName("version")] public long? Version { get; set; } } /// -/// Create or update a component template.
Creates or updates 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 `composed_of` list.
Component templates are only applied to new data streams and indices as part of a matching index template. -/// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. -/// Component templates are only used during index creation.
For data streams, this includes data stream creation and the creation of a stream’s backing indices.
Changes to component templates do not affect existing indices, including a stream’s backing indices. -/// You can use C-style `/* *\/` block comments in component templates.
You can include comments anywhere in the request body except before the opening curly bracket. +/// +/// Create or update a component template. +/// Creates or updates 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 composed_of list. +/// Component templates are only applied to new data streams and indices as part of a matching index template. +/// +/// +/// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. +/// +/// +/// Component templates are only used during index creation. +/// For data streams, this includes data stream creation and the creation of a stream’s backing indices. +/// Changes to component templates do not affect existing indices, including a stream’s backing indices. +/// +/// +/// You can use C-style /* *\/ block comments in component templates. +/// You can include comments anywhere in the request body except before the opening curly bracket. +/// /// public sealed partial class PutComponentTemplateRequestDescriptor : RequestDescriptor, PutComponentTemplateRequestParameters> { @@ -140,7 +198,10 @@ public PutComponentTemplateRequestDescriptor Name(Elastic.Clients.Ela private long? VersionValue { get; set; } /// - /// Marks this index template as deprecated. When creating or updating a non-deprecated index template
that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// + /// Marks this index template as deprecated. When creating or updating a non-deprecated index template + /// that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// /// public PutComponentTemplateRequestDescriptor Deprecated(bool? deprecated = true) { @@ -149,7 +210,12 @@ public PutComponentTemplateRequestDescriptor Deprecated(bool? depreca } /// - /// Optional user metadata about the component template.
May have any contents. This map is not automatically generated by Elasticsearch.
This information is stored in the cluster state, so keeping it short is preferable.
To unset `_meta`, replace the template without specifying this information. + /// + /// Optional user metadata about the component template. + /// May have any contents. This map is not automatically generated by Elasticsearch. + /// This information is stored in the cluster state, so keeping it short is preferable. + /// To unset _meta, replace the template without specifying this information. + /// /// public PutComponentTemplateRequestDescriptor Meta(Func, FluentDictionary> selector) { @@ -158,7 +224,9 @@ public PutComponentTemplateRequestDescriptor Meta(Func - /// The template to be applied which includes mappings, settings, or aliases configuration. + /// + /// The template to be applied which includes mappings, settings, or aliases configuration. + /// /// public PutComponentTemplateRequestDescriptor Template(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexState template) { @@ -185,7 +253,11 @@ public PutComponentTemplateRequestDescriptor Template(Action - /// Version number used to manage component templates externally.
This number isn't automatically generated or incremented by Elasticsearch.
To unset a version, replace the template without specifying a version. + /// + /// Version number used to manage component templates externally. + /// This number isn't automatically generated or incremented by Elasticsearch. + /// To unset a version, replace the template without specifying a version. + /// /// public PutComponentTemplateRequestDescriptor Version(long? version) { @@ -235,11 +307,28 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Create or update a component template.
Creates or updates 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 `composed_of` list.
Component templates are only applied to new data streams and indices as part of a matching index template. -/// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. -/// Component templates are only used during index creation.
For data streams, this includes data stream creation and the creation of a stream’s backing indices.
Changes to component templates do not affect existing indices, including a stream’s backing indices. -/// You can use C-style `/* *\/` block comments in component templates.
You can include comments anywhere in the request body except before the opening curly bracket. +/// +/// Create or update a component template. +/// Creates or updates 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 composed_of list. +/// Component templates are only applied to new data streams and indices as part of a matching index template. +/// +/// +/// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. +/// +/// +/// Component templates are only used during index creation. +/// For data streams, this includes data stream creation and the creation of a stream’s backing indices. +/// Changes to component templates do not affect existing indices, including a stream’s backing indices. +/// +/// +/// You can use C-style /* *\/ block comments in component templates. +/// You can include comments anywhere in the request body except before the opening curly bracket. +/// /// public sealed partial class PutComponentTemplateRequestDescriptor : RequestDescriptor { @@ -274,7 +363,10 @@ public PutComponentTemplateRequestDescriptor Name(Elastic.Clients.Elasticsearch. private long? VersionValue { get; set; } /// - /// Marks this index template as deprecated. When creating or updating a non-deprecated index template
that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// + /// Marks this index template as deprecated. When creating or updating a non-deprecated index template + /// that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// /// public PutComponentTemplateRequestDescriptor Deprecated(bool? deprecated = true) { @@ -283,7 +375,12 @@ public PutComponentTemplateRequestDescriptor Deprecated(bool? deprecated = true) } /// - /// Optional user metadata about the component template.
May have any contents. This map is not automatically generated by Elasticsearch.
This information is stored in the cluster state, so keeping it short is preferable.
To unset `_meta`, replace the template without specifying this information. + /// + /// Optional user metadata about the component template. + /// May have any contents. This map is not automatically generated by Elasticsearch. + /// This information is stored in the cluster state, so keeping it short is preferable. + /// To unset _meta, replace the template without specifying this information. + /// /// public PutComponentTemplateRequestDescriptor Meta(Func, FluentDictionary> selector) { @@ -292,7 +389,9 @@ public PutComponentTemplateRequestDescriptor Meta(Func - /// The template to be applied which includes mappings, settings, or aliases configuration. + /// + /// The template to be applied which includes mappings, settings, or aliases configuration. + /// /// public PutComponentTemplateRequestDescriptor Template(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexState template) { @@ -319,7 +418,11 @@ public PutComponentTemplateRequestDescriptor Template(Action - /// Version number used to manage component templates externally.
This number isn't automatically generated or incremented by Elasticsearch.
To unset a version, replace the template without specifying a version. + /// + /// Version number used to manage component templates externally. + /// This number isn't automatically generated or incremented by Elasticsearch. + /// To unset a version, replace the template without specifying a version. + /// /// public PutComponentTemplateRequestDescriptor Version(long? version) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/PutComponentTemplateResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/PutComponentTemplateResponse.g.cs index e19c2d37da1..6b23a00a031 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/PutComponentTemplateResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/PutComponentTemplateResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class PutComponentTemplateResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/CountRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/CountRequest.g.cs index d6fc6a99e76..75b17d65999 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/CountRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/CountRequest.g.cs @@ -32,78 +32,118 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class CountRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Analyzer to use for the query string.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// Analyzer to use for the query string. + /// This parameter can only be used when the q query string parameter is specified. + /// /// public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// - /// If `true`, wildcard and prefix queries are analyzed.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// If true, wildcard and prefix queries are analyzed. + /// This parameter can only be used when the q query string parameter is specified. + /// /// public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } /// - /// The default operator for query string query: `AND` or `OR`.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// The default operator for query string query: AND or OR. + /// This parameter can only be used when the q query string parameter is specified. + /// /// public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } /// - /// Field to use as default where no field prefix is given in the query string.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// Field to use as default where no field prefix is given in the query string. + /// This parameter can only be used when the q query string parameter is specified. + /// /// public string? Df { get => Q("df"); set => Q("df", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, concrete, expanded or aliased indices are ignored when frozen. + /// + /// If true, concrete, expanded or aliased indices are ignored when frozen. + /// /// public bool? IgnoreThrottled { get => Q("ignore_throttled"); set => Q("ignore_throttled", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// + /// If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// /// public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// - /// Sets the minimum `_score` value that documents must have to be included in the result. + /// + /// Sets the minimum _score value that documents must have to be included in the result. + /// /// public double? MinScore { get => Q("min_score"); set => Q("min_score", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// Query in the Lucene query string syntax. + /// + /// Query in the Lucene query string syntax. + /// /// public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Maximum number of documents to collect for each shard.
If a query reaches this limit, Elasticsearch terminates the query early.
Elasticsearch collects documents before sorting. + /// + /// Maximum number of documents to collect for each shard. + /// If a query reaches this limit, Elasticsearch terminates the query early. + /// Elasticsearch collects documents before sorting. + /// /// public long? TerminateAfter { get => Q("terminate_after"); set => Q("terminate_after", value); } } /// -/// Returns number of documents matching a query. +/// +/// Returns number of documents matching a query. +/// /// public partial class CountRequest : PlainRequest { @@ -124,98 +164,140 @@ public CountRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? indices) : internal override string OperationName => "count"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Analyzer to use for the query string.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// Analyzer to use for the query string. + /// This parameter can only be used when the q query string parameter is specified. + /// /// [JsonIgnore] public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// - /// If `true`, wildcard and prefix queries are analyzed.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// If true, wildcard and prefix queries are analyzed. + /// This parameter can only be used when the q query string parameter is specified. + /// /// [JsonIgnore] public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } /// - /// The default operator for query string query: `AND` or `OR`.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// The default operator for query string query: AND or OR. + /// This parameter can only be used when the q query string parameter is specified. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } /// - /// Field to use as default where no field prefix is given in the query string.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// Field to use as default where no field prefix is given in the query string. + /// This parameter can only be used when the q query string parameter is specified. + /// /// [JsonIgnore] public string? Df { get => Q("df"); set => Q("df", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, concrete, expanded or aliased indices are ignored when frozen. + /// + /// If true, concrete, expanded or aliased indices are ignored when frozen. + /// /// [JsonIgnore] public bool? IgnoreThrottled { get => Q("ignore_throttled"); set => Q("ignore_throttled", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// + /// If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// /// [JsonIgnore] public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// - /// Sets the minimum `_score` value that documents must have to be included in the result. + /// + /// Sets the minimum _score value that documents must have to be included in the result. + /// /// [JsonIgnore] public double? MinScore { get => Q("min_score"); set => Q("min_score", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// Query in the Lucene query string syntax. + /// + /// Query in the Lucene query string syntax. + /// /// [JsonIgnore] public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Maximum number of documents to collect for each shard.
If a query reaches this limit, Elasticsearch terminates the query early.
Elasticsearch collects documents before sorting. + /// + /// Maximum number of documents to collect for each shard. + /// If a query reaches this limit, Elasticsearch terminates the query early. + /// Elasticsearch collects documents before sorting. + /// /// [JsonIgnore] public long? TerminateAfter { get => Q("terminate_after"); set => Q("terminate_after", value); } /// - /// Defines the search definition using the Query DSL. + /// + /// Defines the search definition using the Query DSL. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? Query { get; set; } } /// -/// Returns number of documents matching a query. +/// +/// Returns number of documents matching a query. +/// /// public sealed partial class CountRequestDescriptor : RequestDescriptor, CountRequestParameters> { @@ -263,7 +345,9 @@ public CountRequestDescriptor Indices(Elastic.Clients.Elasticsearch.S private Action> QueryDescriptorAction { get; set; } /// - /// Defines the search definition using the Query DSL. + /// + /// Defines the search definition using the Query DSL. + /// /// public CountRequestDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -313,7 +397,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns number of documents matching a query. +/// +/// Returns number of documents matching a query. +/// /// public sealed partial class CountRequestDescriptor : RequestDescriptor { @@ -361,7 +447,9 @@ public CountRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.I private Action QueryDescriptorAction { get; set; } /// - /// Defines the search definition using the Query DSL. + /// + /// Defines the search definition using the Query DSL. + /// /// public CountRequestDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/CreateRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/CreateRequest.g.cs index 16c7d5db0f6..5b089946b08 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/CreateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/CreateRequest.g.cs @@ -32,43 +32,66 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class CreateRequestParameters : RequestParameters { /// - /// ID of the pipeline to use to preprocess incoming documents.
If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.
If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// + /// ID of the pipeline to use to preprocess incoming documents. + /// If the index has a default ingest pipeline specified, then setting the value to _none disables the default ingest pipeline for this request. + /// If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// /// public string? Pipeline { get => Q("pipeline"); set => Q("pipeline", value); } /// - /// If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.
Valid values: `true`, `false`, `wait_for`. + /// + /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false do nothing with refreshes. + /// Valid values: true, false, wait_for. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Refresh? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. + /// + /// Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Explicit version number for concurrency control.
The specified version must match the current version of the document for the request to succeed. + /// + /// Explicit version number for concurrency control. + /// The specified version must match the current version of the document for the request to succeed. + /// /// public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type: `external`, `external_gte`. + /// + /// Specific version type: external, external_gte. + /// /// public Elastic.Clients.Elasticsearch.Serverless.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// public Elastic.Clients.Elasticsearch.Serverless.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. +/// +/// Index a document. +/// Adds a JSON document to the specified data stream or index and makes it searchable. +/// If the target is an index and the document already exists, the request updates the document and increments its version. +/// /// public sealed partial class CreateRequest : PlainRequest, ISelfSerializable { @@ -85,43 +108,62 @@ public CreateRequest(Elastic.Clients.Elasticsearch.Serverless.IndexName index, E internal override string OperationName => "create"; /// - /// ID of the pipeline to use to preprocess incoming documents.
If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.
If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// + /// ID of the pipeline to use to preprocess incoming documents. + /// If the index has a default ingest pipeline specified, then setting the value to _none disables the default ingest pipeline for this request. + /// If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// /// [JsonIgnore] public string? Pipeline { get => Q("pipeline"); set => Q("pipeline", value); } /// - /// If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.
Valid values: `true`, `false`, `wait_for`. + /// + /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false do nothing with refreshes. + /// Valid values: true, false, wait_for. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Refresh? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. + /// + /// Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Explicit version number for concurrency control.
The specified version must match the current version of the document for the request to succeed. + /// + /// Explicit version number for concurrency control. + /// The specified version must match the current version of the document for the request to succeed. + /// /// [JsonIgnore] public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type: `external`, `external_gte`. + /// + /// Specific version type: external, external_gte. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } @@ -135,7 +177,11 @@ void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions op } /// -/// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. +/// +/// Index a document. +/// Adds a JSON document to the specified data stream or index and makes it searchable. +/// If the target is an index and the document already exists, the request updates the document and increments its version. +/// /// public sealed partial class CreateRequestDescriptor : RequestDescriptor, CreateRequestParameters> { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/DeleteByQueryRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/DeleteByQueryRequest.g.cs index 4ac3e38419d..debf47d9556 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/DeleteByQueryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/DeleteByQueryRequest.g.cs @@ -32,148 +32,222 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class DeleteByQueryRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices.
For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Analyzer to use for the query string. + /// + /// Analyzer to use for the query string. + /// /// public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// - /// If `true`, wildcard and prefix queries are analyzed. + /// + /// If true, wildcard and prefix queries are analyzed. + /// /// public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } /// - /// What to do if delete by query hits version conflicts: `abort` or `proceed`. + /// + /// What to do if delete by query hits version conflicts: abort or proceed. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Conflicts? Conflicts { get => Q("conflicts"); set => Q("conflicts", value); } /// - /// The default operator for query string query: `AND` or `OR`. + /// + /// The default operator for query string query: AND or OR. + /// /// public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } /// - /// Field to use as default where no field prefix is given in the query string. + /// + /// Field to use as default where no field prefix is given in the query string. + /// /// public string? Df { get => Q("df"); set => Q("df", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Starting offset (default: 0) + /// + /// Starting offset (default: 0) + /// /// public long? From { get => Q("from"); set => Q("from", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// + /// If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// /// public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// Query in the Lucene query string syntax. + /// + /// Query in the Lucene query string syntax. + /// /// public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } /// - /// If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes. + /// + /// If true, Elasticsearch refreshes all shards involved in the delete by query after the request completes. + /// /// public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// If `true`, the request cache is used for this request.
Defaults to the index-level setting. + /// + /// If true, the request cache is used for this request. + /// Defaults to the index-level setting. + /// /// public bool? RequestCache { get => Q("request_cache"); set => Q("request_cache", value); } /// - /// The throttle for this request in sub-requests per second. + /// + /// The throttle for this request in sub-requests per second. + /// /// public float? RequestsPerSecond { get => Q("requests_per_second"); set => Q("requests_per_second", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Period to retain the search context for scrolling. + /// + /// Period to retain the search context for scrolling. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); } /// - /// Size of the scroll request that powers the operation. + /// + /// Size of the scroll request that powers the operation. + /// /// public long? ScrollSize { get => Q("scroll_size"); set => Q("scroll_size", value); } /// - /// Explicit timeout for each search request.
Defaults to no timeout. + /// + /// Explicit timeout for each search request. + /// Defaults to no timeout. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? SearchTimeout { get => Q("search_timeout"); set => Q("search_timeout", value); } /// - /// The type of the search operation.
Available options: `query_then_fetch`, `dfs_query_then_fetch`. + /// + /// The type of the search operation. + /// Available options: query_then_fetch, dfs_query_then_fetch. + /// /// public Elastic.Clients.Elasticsearch.Serverless.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } /// - /// The number of slices this task should be divided into. + /// + /// The number of slices this task should be divided into. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Slices? Slices { get => Q("slices"); set => Q("slices", value); } /// - /// A comma-separated list of : pairs. + /// + /// A comma-separated list of <field>:<direction> pairs. + /// /// public ICollection? Sort { get => Q?>("sort"); set => Q("sort", value); } /// - /// Specific `tag` of the request for logging and statistical purposes. + /// + /// Specific tag of the request for logging and statistical purposes. + /// /// public ICollection? Stats { get => Q?>("stats"); set => Q("stats", value); } /// - /// Maximum number of documents to collect for each shard.
If a query reaches this limit, Elasticsearch terminates the query early.
Elasticsearch collects documents before sorting.
Use with caution.
Elasticsearch applies this parameter to each shard handling the request.
When possible, let Elasticsearch perform early termination automatically.
Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + /// + /// Maximum number of documents to collect for each shard. + /// If a query reaches this limit, Elasticsearch terminates the query early. + /// Elasticsearch collects documents before sorting. + /// Use with caution. + /// Elasticsearch applies this parameter to each shard handling the request. + /// When possible, let Elasticsearch perform early termination automatically. + /// Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + /// /// public long? TerminateAfter { get => Q("terminate_after"); set => Q("terminate_after", value); } /// - /// Period each deletion request waits for active shards. + /// + /// Period each deletion request waits for active shards. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// If `true`, returns the document version as part of a hit. + /// + /// If true, returns the document version as part of a hit. + /// /// public bool? Version { get => Q("version"); set => Q("version", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// public Elastic.Clients.Elasticsearch.Serverless.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } /// - /// If `true`, the request blocks until the operation is complete. + /// + /// If true, the request blocks until the operation is complete. + /// /// public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Delete documents.
Deletes documents that match the specified query. +/// +/// Delete documents. +/// Deletes documents that match the specified query. +/// /// public sealed partial class DeleteByQueryRequest : PlainRequest { @@ -190,194 +264,274 @@ public DeleteByQueryRequest(Elastic.Clients.Elasticsearch.Serverless.Indices ind internal override string OperationName => "delete_by_query"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices.
For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Analyzer to use for the query string. + /// + /// Analyzer to use for the query string. + /// /// [JsonIgnore] public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// - /// If `true`, wildcard and prefix queries are analyzed. + /// + /// If true, wildcard and prefix queries are analyzed. + /// /// [JsonIgnore] public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } /// - /// What to do if delete by query hits version conflicts: `abort` or `proceed`. + /// + /// What to do if delete by query hits version conflicts: abort or proceed. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Conflicts? Conflicts { get => Q("conflicts"); set => Q("conflicts", value); } /// - /// The default operator for query string query: `AND` or `OR`. + /// + /// The default operator for query string query: AND or OR. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } /// - /// Field to use as default where no field prefix is given in the query string. + /// + /// Field to use as default where no field prefix is given in the query string. + /// /// [JsonIgnore] public string? Df { get => Q("df"); set => Q("df", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Starting offset (default: 0) + /// + /// Starting offset (default: 0) + /// /// [JsonIgnore] public long? From { get => Q("from"); set => Q("from", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// + /// If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// /// [JsonIgnore] public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// Query in the Lucene query string syntax. + /// + /// Query in the Lucene query string syntax. + /// /// [JsonIgnore] public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } /// - /// If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes. + /// + /// If true, Elasticsearch refreshes all shards involved in the delete by query after the request completes. + /// /// [JsonIgnore] public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// If `true`, the request cache is used for this request.
Defaults to the index-level setting. + /// + /// If true, the request cache is used for this request. + /// Defaults to the index-level setting. + /// /// [JsonIgnore] public bool? RequestCache { get => Q("request_cache"); set => Q("request_cache", value); } /// - /// The throttle for this request in sub-requests per second. + /// + /// The throttle for this request in sub-requests per second. + /// /// [JsonIgnore] public float? RequestsPerSecond { get => Q("requests_per_second"); set => Q("requests_per_second", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Period to retain the search context for scrolling. + /// + /// Period to retain the search context for scrolling. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); } /// - /// Size of the scroll request that powers the operation. + /// + /// Size of the scroll request that powers the operation. + /// /// [JsonIgnore] public long? ScrollSize { get => Q("scroll_size"); set => Q("scroll_size", value); } /// - /// Explicit timeout for each search request.
Defaults to no timeout. + /// + /// Explicit timeout for each search request. + /// Defaults to no timeout. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? SearchTimeout { get => Q("search_timeout"); set => Q("search_timeout", value); } /// - /// The type of the search operation.
Available options: `query_then_fetch`, `dfs_query_then_fetch`. + /// + /// The type of the search operation. + /// Available options: query_then_fetch, dfs_query_then_fetch. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } /// - /// The number of slices this task should be divided into. + /// + /// The number of slices this task should be divided into. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Slices? Slices { get => Q("slices"); set => Q("slices", value); } /// - /// A comma-separated list of : pairs. + /// + /// A comma-separated list of <field>:<direction> pairs. + /// /// [JsonIgnore] public ICollection? Sort { get => Q?>("sort"); set => Q("sort", value); } /// - /// Specific `tag` of the request for logging and statistical purposes. + /// + /// Specific tag of the request for logging and statistical purposes. + /// /// [JsonIgnore] public ICollection? Stats { get => Q?>("stats"); set => Q("stats", value); } /// - /// Maximum number of documents to collect for each shard.
If a query reaches this limit, Elasticsearch terminates the query early.
Elasticsearch collects documents before sorting.
Use with caution.
Elasticsearch applies this parameter to each shard handling the request.
When possible, let Elasticsearch perform early termination automatically.
Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + /// + /// Maximum number of documents to collect for each shard. + /// If a query reaches this limit, Elasticsearch terminates the query early. + /// Elasticsearch collects documents before sorting. + /// Use with caution. + /// Elasticsearch applies this parameter to each shard handling the request. + /// When possible, let Elasticsearch perform early termination automatically. + /// Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + /// /// [JsonIgnore] public long? TerminateAfter { get => Q("terminate_after"); set => Q("terminate_after", value); } /// - /// Period each deletion request waits for active shards. + /// + /// Period each deletion request waits for active shards. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// If `true`, returns the document version as part of a hit. + /// + /// If true, returns the document version as part of a hit. + /// /// [JsonIgnore] public bool? Version { get => Q("version"); set => Q("version", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } /// - /// If `true`, the request blocks until the operation is complete. + /// + /// If true, the request blocks until the operation is complete. + /// /// [JsonIgnore] public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } /// - /// The maximum number of documents to delete. + /// + /// The maximum number of documents to delete. + /// /// [JsonInclude, JsonPropertyName("max_docs")] public long? MaxDocs { get; set; } /// - /// Specifies the documents to delete using the Query DSL. + /// + /// Specifies the documents to delete using the Query DSL. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? Query { get; set; } /// - /// Slice the request manually using the provided slice ID and total number of slices. + /// + /// Slice the request manually using the provided slice ID and total number of slices. + /// /// [JsonInclude, JsonPropertyName("slice")] public Elastic.Clients.Elasticsearch.Serverless.SlicedScroll? Slice { get; set; } } /// -/// Delete documents.
Deletes documents that match the specified query. +/// +/// Delete documents. +/// Deletes documents that match the specified query. +/// /// public sealed partial class DeleteByQueryRequestDescriptor : RequestDescriptor, DeleteByQueryRequestParameters> { @@ -443,7 +597,9 @@ public DeleteByQueryRequestDescriptor Indices(Elastic.Clients.Elastic private Action> SliceDescriptorAction { get; set; } /// - /// The maximum number of documents to delete. + /// + /// The maximum number of documents to delete. + /// /// public DeleteByQueryRequestDescriptor MaxDocs(long? maxDocs) { @@ -452,7 +608,9 @@ public DeleteByQueryRequestDescriptor MaxDocs(long? maxDocs) } /// - /// Specifies the documents to delete using the Query DSL. + /// + /// Specifies the documents to delete using the Query DSL. + /// /// public DeleteByQueryRequestDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -479,7 +637,9 @@ public DeleteByQueryRequestDescriptor Query(Action - /// Slice the request manually using the provided slice ID and total number of slices. + /// + /// Slice the request manually using the provided slice ID and total number of slices. + /// /// public DeleteByQueryRequestDescriptor Slice(Elastic.Clients.Elasticsearch.Serverless.SlicedScroll? slice) { @@ -551,7 +711,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Delete documents.
Deletes documents that match the specified query. +/// +/// Delete documents. +/// Deletes documents that match the specified query. +/// /// public sealed partial class DeleteByQueryRequestDescriptor : RequestDescriptor { @@ -613,7 +776,9 @@ public DeleteByQueryRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Serv private Action SliceDescriptorAction { get; set; } /// - /// The maximum number of documents to delete. + /// + /// The maximum number of documents to delete. + /// /// public DeleteByQueryRequestDescriptor MaxDocs(long? maxDocs) { @@ -622,7 +787,9 @@ public DeleteByQueryRequestDescriptor MaxDocs(long? maxDocs) } /// - /// Specifies the documents to delete using the Query DSL. + /// + /// Specifies the documents to delete using the Query DSL. + /// /// public DeleteByQueryRequestDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -649,7 +816,9 @@ public DeleteByQueryRequestDescriptor Query(Action - /// Slice the request manually using the provided slice ID and total number of slices. + /// + /// Slice the request manually using the provided slice ID and total number of slices. + /// /// public DeleteByQueryRequestDescriptor Slice(Elastic.Clients.Elasticsearch.Serverless.SlicedScroll? slice) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/DeleteByQueryRethrottleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/DeleteByQueryRethrottleRequest.g.cs index 629011d8581..cfa4ef28582 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/DeleteByQueryRethrottleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/DeleteByQueryRethrottleRequest.g.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class DeleteByQueryRethrottleRequestParameters : RequestParameters { /// - /// The throttle for this request in sub-requests per second. + /// + /// The throttle for this request in sub-requests per second. + /// /// public float? RequestsPerSecond { get => Q("requests_per_second"); set => Q("requests_per_second", value); } } /// -/// Changes the number of requests per second for a particular Delete By Query operation. +/// +/// Changes the number of requests per second for a particular Delete By Query operation. +/// /// public sealed partial class DeleteByQueryRethrottleRequest : PlainRequest { @@ -55,14 +59,18 @@ public DeleteByQueryRethrottleRequest(Elastic.Clients.Elasticsearch.Serverless.T internal override string OperationName => "delete_by_query_rethrottle"; /// - /// The throttle for this request in sub-requests per second. + /// + /// The throttle for this request in sub-requests per second. + /// /// [JsonIgnore] public float? RequestsPerSecond { get => Q("requests_per_second"); set => Q("requests_per_second", value); } } /// -/// Changes the number of requests per second for a particular Delete By Query operation. +/// +/// Changes the number of requests per second for a particular Delete By Query operation. +/// /// public sealed partial class DeleteByQueryRethrottleRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/DeleteByQueryRethrottleResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/DeleteByQueryRethrottleResponse.g.cs index a6edfad65d3..8873be7f541 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/DeleteByQueryRethrottleResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/DeleteByQueryRethrottleResponse.g.cs @@ -32,7 +32,9 @@ public sealed partial class DeleteByQueryRethrottleResponse : ElasticsearchRespo public IReadOnlyCollection? NodeFailures { get; init; } /// - /// Task information grouped by node, if `group_by` was set to `node` (the default). + /// + /// Task information grouped by node, if group_by was set to node (the default). + /// /// [JsonInclude, JsonPropertyName("nodes")] public IReadOnlyDictionary? Nodes { get; init; } @@ -40,7 +42,10 @@ public sealed partial class DeleteByQueryRethrottleResponse : ElasticsearchRespo public IReadOnlyCollection? TaskFailures { get; init; } /// - /// Either a flat list of tasks if `group_by` was set to `none`, or grouped by parents if
`group_by` was set to `parents`. + /// + /// Either a flat list of tasks if group_by was set to none, or grouped by parents if + /// group_by was set to parents. + /// /// [JsonInclude, JsonPropertyName("tasks")] public Elastic.Clients.Elasticsearch.Serverless.Tasks.TaskInfos? Tasks { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/DeleteRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/DeleteRequest.g.cs index 43ed10a80c9..cb8667dabf2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/DeleteRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/DeleteRequest.g.cs @@ -32,48 +32,70 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class DeleteRequestParameters : RequestParameters { /// - /// Only perform the operation if the document has this primary term. + /// + /// Only perform the operation if the document has this primary term. + /// /// public long? IfPrimaryTerm { get => Q("if_primary_term"); set => Q("if_primary_term", value); } /// - /// Only perform the operation if the document has this sequence number. + /// + /// Only perform the operation if the document has this sequence number. + /// /// public long? IfSeqNo { get => Q("if_seq_no"); set => Q("if_seq_no", value); } /// - /// If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.
Valid values: `true`, `false`, `wait_for`. + /// + /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false do nothing with refreshes. + /// Valid values: true, false, wait_for. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Refresh? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Period to wait for active shards. + /// + /// Period to wait for active shards. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Explicit version number for concurrency control.
The specified version must match the current version of the document for the request to succeed. + /// + /// Explicit version number for concurrency control. + /// The specified version must match the current version of the document for the request to succeed. + /// /// public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type: `external`, `external_gte`. + /// + /// Specific version type: external, external_gte. + /// /// public Elastic.Clients.Elasticsearch.Serverless.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// public Elastic.Clients.Elasticsearch.Serverless.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Delete a document.
Removes a JSON document from the specified index. +/// +/// Delete a document. +/// Removes a JSON document from the specified index. +/// /// public partial class DeleteRequest : PlainRequest { @@ -90,56 +112,78 @@ public DeleteRequest(Elastic.Clients.Elasticsearch.Serverless.IndexName index, E internal override string OperationName => "delete"; /// - /// Only perform the operation if the document has this primary term. + /// + /// Only perform the operation if the document has this primary term. + /// /// [JsonIgnore] public long? IfPrimaryTerm { get => Q("if_primary_term"); set => Q("if_primary_term", value); } /// - /// Only perform the operation if the document has this sequence number. + /// + /// Only perform the operation if the document has this sequence number. + /// /// [JsonIgnore] public long? IfSeqNo { get => Q("if_seq_no"); set => Q("if_seq_no", value); } /// - /// If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.
Valid values: `true`, `false`, `wait_for`. + /// + /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false do nothing with refreshes. + /// Valid values: true, false, wait_for. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Refresh? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Period to wait for active shards. + /// + /// Period to wait for active shards. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Explicit version number for concurrency control.
The specified version must match the current version of the document for the request to succeed. + /// + /// Explicit version number for concurrency control. + /// The specified version must match the current version of the document for the request to succeed. + /// /// [JsonIgnore] public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type: `external`, `external_gte`. + /// + /// Specific version type: external, external_gte. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Delete a document.
Removes a JSON document from the specified index. +/// +/// Delete a document. +/// Removes a JSON document from the specified index. +/// /// public sealed partial class DeleteRequestDescriptor : RequestDescriptor, DeleteRequestParameters> { @@ -200,7 +244,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Delete a document.
Removes a JSON document from the specified index. +/// +/// Delete a document. +/// Removes a JSON document from the specified index. +/// /// public sealed partial class DeleteRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/DeleteScriptRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/DeleteScriptRequest.g.cs index d10e1a4199e..111b0c8bda6 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/DeleteScriptRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/DeleteScriptRequest.g.cs @@ -32,18 +32,27 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class DeleteScriptRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// 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. +/// /// public sealed partial class DeleteScriptRequest : PlainRequest { @@ -60,20 +69,29 @@ public DeleteScriptRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : bas internal override string OperationName => "delete_script"; /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// 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. +/// /// public sealed partial class DeleteScriptRequestDescriptor : RequestDescriptor, DeleteScriptRequestParameters> { @@ -106,7 +124,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// 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. +/// /// public sealed partial class DeleteScriptRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/DeleteScriptResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/DeleteScriptResponse.g.cs index 783d9e7f8d0..a12cef4ef93 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/DeleteScriptResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/DeleteScriptResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class DeleteScriptResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/DeletePolicyRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/DeletePolicyRequest.g.cs index 568ba5e4db9..208da72b44b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/DeletePolicyRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/DeletePolicyRequest.g.cs @@ -34,7 +34,10 @@ public sealed partial class DeletePolicyRequestParameters : RequestParameters } /// -/// Delete an enrich policy.
Deletes an existing enrich policy and its enrich index. +/// +/// Delete an enrich policy. +/// Deletes an existing enrich policy and its enrich index. +/// /// public sealed partial class DeletePolicyRequest : PlainRequest { @@ -52,7 +55,10 @@ public DeletePolicyRequest(Elastic.Clients.Elasticsearch.Serverless.Name name) : } /// -/// Delete an enrich policy.
Deletes an existing enrich policy and its enrich index. +/// +/// Delete an enrich policy. +/// Deletes an existing enrich policy and its enrich index. +/// /// public sealed partial class DeletePolicyRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/DeletePolicyResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/DeletePolicyResponse.g.cs index 0a8878f34a0..ddcc0a34a0c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/DeletePolicyResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/DeletePolicyResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Enrich; public sealed partial class DeletePolicyResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/EnrichStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/EnrichStatsRequest.g.cs index cc7061ea803..28a5d38229d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/EnrichStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/EnrichStatsRequest.g.cs @@ -34,7 +34,10 @@ public sealed partial class EnrichStatsRequestParameters : RequestParameters } /// -/// Get enrich stats.
Returns enrich coordinator statistics and information about enrich policies that are currently executing. +/// +/// Get enrich stats. +/// Returns enrich coordinator statistics and information about enrich policies that are currently executing. +/// /// public sealed partial class EnrichStatsRequest : PlainRequest { @@ -48,7 +51,10 @@ public sealed partial class EnrichStatsRequest : PlainRequest -/// Get enrich stats.
Returns enrich coordinator statistics and information about enrich policies that are currently executing. +/// +/// Get enrich stats. +/// Returns enrich coordinator statistics and information about enrich policies that are currently executing. +/// /// public sealed partial class EnrichStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/EnrichStatsResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/EnrichStatsResponse.g.cs index 9a6bed4109a..8bfd8cf71e0 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/EnrichStatsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/EnrichStatsResponse.g.cs @@ -29,19 +29,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Enrich; public sealed partial class EnrichStatsResponse : ElasticsearchResponse { /// - /// Objects containing information about the enrich cache stats on each ingest node. + /// + /// Objects containing information about the enrich cache stats on each ingest node. + /// /// [JsonInclude, JsonPropertyName("cache_stats")] public IReadOnlyCollection? CacheStats { get; init; } /// - /// Objects containing information about each coordinating ingest node for configured enrich processors. + /// + /// Objects containing information about each coordinating ingest node for configured enrich processors. + /// /// [JsonInclude, JsonPropertyName("coordinator_stats")] public IReadOnlyCollection CoordinatorStats { get; init; } /// - /// Objects containing information about each enrich policy that is currently executing. + /// + /// Objects containing information about each enrich policy that is currently executing. + /// /// [JsonInclude, JsonPropertyName("executing_policies")] public IReadOnlyCollection ExecutingPolicies { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/ExecutePolicyRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/ExecutePolicyRequest.g.cs index 20767adaa5c..341956997e7 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/ExecutePolicyRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/ExecutePolicyRequest.g.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Enrich; public sealed partial class ExecutePolicyRequestParameters : RequestParameters { /// - /// If `true`, the request blocks other enrich policy execution requests until complete. + /// + /// If true, the request blocks other enrich policy execution requests until complete. + /// /// public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Creates the enrich index for an existing enrich policy. +/// +/// Creates the enrich index for an existing enrich policy. +/// /// public sealed partial class ExecutePolicyRequest : PlainRequest { @@ -55,14 +59,18 @@ public ExecutePolicyRequest(Elastic.Clients.Elasticsearch.Serverless.Name name) internal override string OperationName => "enrich.execute_policy"; /// - /// If `true`, the request blocks other enrich policy execution requests until complete. + /// + /// If true, the request blocks other enrich policy execution requests until complete. + /// /// [JsonIgnore] public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Creates the enrich index for an existing enrich policy. +/// +/// Creates the enrich index for an existing enrich policy. +/// /// public sealed partial class ExecutePolicyRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/GetPolicyRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/GetPolicyRequest.g.cs index 288ca6e771d..8bdf06568c5 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/GetPolicyRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/GetPolicyRequest.g.cs @@ -34,7 +34,10 @@ public sealed partial class GetPolicyRequestParameters : RequestParameters } /// -/// Get an enrich policy.
Returns information about an enrich policy. +/// +/// Get an enrich policy. +/// Returns information about an enrich policy. +/// /// public sealed partial class GetPolicyRequest : PlainRequest { @@ -56,7 +59,10 @@ public GetPolicyRequest(Elastic.Clients.Elasticsearch.Serverless.Names? name) : } /// -/// Get an enrich policy.
Returns information about an enrich policy. +/// +/// Get an enrich policy. +/// Returns information about an enrich policy. +/// /// public sealed partial class GetPolicyRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/PutPolicyRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/PutPolicyRequest.g.cs index ee573088708..52d73b69b22 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/PutPolicyRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/PutPolicyRequest.g.cs @@ -34,7 +34,10 @@ public sealed partial class PutPolicyRequestParameters : RequestParameters } /// -/// Create an enrich policy.
Creates an enrich policy. +/// +/// Create an enrich policy. +/// Creates an enrich policy. +/// /// public sealed partial class PutPolicyRequest : PlainRequest { @@ -51,26 +54,35 @@ public PutPolicyRequest(Elastic.Clients.Elasticsearch.Serverless.Name name) : ba internal override string OperationName => "enrich.put_policy"; /// - /// Matches enrich data to incoming documents based on a `geo_shape` query. + /// + /// Matches enrich data to incoming documents based on a geo_shape query. + /// /// [JsonInclude, JsonPropertyName("geo_match")] public Elastic.Clients.Elasticsearch.Serverless.Enrich.EnrichPolicy? GeoMatch { get; set; } /// - /// Matches enrich data to incoming documents based on a `term` query. + /// + /// Matches enrich data to incoming documents based on a term query. + /// /// [JsonInclude, JsonPropertyName("match")] public Elastic.Clients.Elasticsearch.Serverless.Enrich.EnrichPolicy? Match { get; set; } /// - /// Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a `term` query. + /// + /// Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a term query. + /// /// [JsonInclude, JsonPropertyName("range")] public Elastic.Clients.Elasticsearch.Serverless.Enrich.EnrichPolicy? Range { get; set; } } /// -/// Create an enrich policy.
Creates an enrich policy. +/// +/// Create an enrich policy. +/// Creates an enrich policy. +/// /// public sealed partial class PutPolicyRequestDescriptor : RequestDescriptor, PutPolicyRequestParameters> { @@ -105,7 +117,9 @@ public PutPolicyRequestDescriptor Name(Elastic.Clients.Elasticsearch. private Action> RangeDescriptorAction { get; set; } /// - /// Matches enrich data to incoming documents based on a `geo_shape` query. + /// + /// Matches enrich data to incoming documents based on a geo_shape query. + /// /// public PutPolicyRequestDescriptor GeoMatch(Elastic.Clients.Elasticsearch.Serverless.Enrich.EnrichPolicy? geoMatch) { @@ -132,7 +146,9 @@ public PutPolicyRequestDescriptor GeoMatch(Action - /// Matches enrich data to incoming documents based on a `term` query. + /// + /// Matches enrich data to incoming documents based on a term query. + /// /// public PutPolicyRequestDescriptor Match(Elastic.Clients.Elasticsearch.Serverless.Enrich.EnrichPolicy? match) { @@ -159,7 +175,9 @@ public PutPolicyRequestDescriptor Match(Action - /// Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a `term` query. + /// + /// Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a term query. + /// /// public PutPolicyRequestDescriptor Range(Elastic.Clients.Elasticsearch.Serverless.Enrich.EnrichPolicy? range) { @@ -241,7 +259,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Create an enrich policy.
Creates an enrich policy. +/// +/// Create an enrich policy. +/// Creates an enrich policy. +/// /// public sealed partial class PutPolicyRequestDescriptor : RequestDescriptor { @@ -276,7 +297,9 @@ public PutPolicyRequestDescriptor Name(Elastic.Clients.Elasticsearch.Serverless. private Action RangeDescriptorAction { get; set; } /// - /// Matches enrich data to incoming documents based on a `geo_shape` query. + /// + /// Matches enrich data to incoming documents based on a geo_shape query. + /// /// public PutPolicyRequestDescriptor GeoMatch(Elastic.Clients.Elasticsearch.Serverless.Enrich.EnrichPolicy? geoMatch) { @@ -303,7 +326,9 @@ public PutPolicyRequestDescriptor GeoMatch(Action - /// Matches enrich data to incoming documents based on a `term` query. + /// + /// Matches enrich data to incoming documents based on a term query. + /// /// public PutPolicyRequestDescriptor Match(Elastic.Clients.Elasticsearch.Serverless.Enrich.EnrichPolicy? match) { @@ -330,7 +355,9 @@ public PutPolicyRequestDescriptor Match(Action - /// Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a `term` query. + /// + /// Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a term query. + /// /// public PutPolicyRequestDescriptor Range(Elastic.Clients.Elasticsearch.Serverless.Enrich.EnrichPolicy? range) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/PutPolicyResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/PutPolicyResponse.g.cs index b30cc44ce09..b139f4781c1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/PutPolicyResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/PutPolicyResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Enrich; public sealed partial class PutPolicyResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlDeleteRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlDeleteRequest.g.cs index de26b15c866..f908eea90e5 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlDeleteRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlDeleteRequest.g.cs @@ -34,7 +34,10 @@ public sealed partial class EqlDeleteRequestParameters : RequestParameters } /// -/// Deletes an async EQL search or a stored synchronous EQL search.
The API also deletes results for the search. +/// +/// Deletes an async EQL search or a stored synchronous EQL search. +/// The API also deletes results for the search. +/// /// public sealed partial class EqlDeleteRequest : PlainRequest { @@ -52,7 +55,10 @@ public EqlDeleteRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : base(r } /// -/// Deletes an async EQL search or a stored synchronous EQL search.
The API also deletes results for the search. +/// +/// Deletes an async EQL search or a stored synchronous EQL search. +/// The API also deletes results for the search. +/// /// public sealed partial class EqlDeleteRequestDescriptor : RequestDescriptor, EqlDeleteRequestParameters> { @@ -82,7 +88,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Deletes an async EQL search or a stored synchronous EQL search.
The API also deletes results for the search. +/// +/// Deletes an async EQL search or a stored synchronous EQL search. +/// The API also deletes results for the search. +/// /// public sealed partial class EqlDeleteRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlDeleteResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlDeleteResponse.g.cs index 353ef60d960..38f55f2b5cc 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlDeleteResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlDeleteResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Eql; public sealed partial class EqlDeleteResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlGetRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlGetRequest.g.cs index 5c52a2926f1..0bbd65326c0 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlGetRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlGetRequest.g.cs @@ -32,18 +32,26 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Eql; public sealed partial class EqlGetRequestParameters : RequestParameters { /// - /// Period for which the search and its results are stored on the cluster.
Defaults to the keep_alive value set by the search’s EQL search API request. + /// + /// Period for which the search and its results are stored on the cluster. + /// Defaults to the keep_alive value set by the search’s EQL search API request. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); } /// - /// Timeout duration to wait for the request to finish.
Defaults to no timeout, meaning the request waits for complete search results. + /// + /// Timeout duration to wait for the request to finish. + /// Defaults to no timeout, meaning the request waits for complete search results. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? WaitForCompletionTimeout { get => Q("wait_for_completion_timeout"); set => Q("wait_for_completion_timeout", value); } } /// -/// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. +/// +/// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. +/// /// public sealed partial class EqlGetRequest : PlainRequest { @@ -60,20 +68,28 @@ public EqlGetRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : base(r => internal override string OperationName => "eql.get"; /// - /// Period for which the search and its results are stored on the cluster.
Defaults to the keep_alive value set by the search’s EQL search API request. + /// + /// Period for which the search and its results are stored on the cluster. + /// Defaults to the keep_alive value set by the search’s EQL search API request. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); } /// - /// Timeout duration to wait for the request to finish.
Defaults to no timeout, meaning the request waits for complete search results. + /// + /// Timeout duration to wait for the request to finish. + /// Defaults to no timeout, meaning the request waits for complete search results. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? WaitForCompletionTimeout { get => Q("wait_for_completion_timeout"); set => Q("wait_for_completion_timeout", value); } } /// -/// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. +/// +/// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. +/// /// public sealed partial class EqlGetRequestDescriptor : RequestDescriptor, EqlGetRequestParameters> { @@ -106,7 +122,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. +/// +/// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. +/// /// public sealed partial class EqlGetRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlGetResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlGetResponse.g.cs index 1cd4a0bb275..da48b383e07 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlGetResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlGetResponse.g.cs @@ -29,37 +29,49 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Eql; public sealed partial class EqlGetResponse : ElasticsearchResponse { /// - /// Contains matching events and sequences. Also contains related metadata. + /// + /// Contains matching events and sequences. Also contains related metadata. + /// /// [JsonInclude, JsonPropertyName("hits")] public Elastic.Clients.Elasticsearch.Serverless.Eql.EqlHits Hits { get; init; } /// - /// Identifier for the search. + /// + /// Identifier for the search. + /// /// [JsonInclude, JsonPropertyName("id")] public string? Id { get; init; } /// - /// If true, the response does not contain complete search results. + /// + /// If true, the response does not contain complete search results. + /// /// [JsonInclude, JsonPropertyName("is_partial")] public bool? IsPartial { get; init; } /// - /// If true, the search request is still executing. + /// + /// If true, the search request is still executing. + /// /// [JsonInclude, JsonPropertyName("is_running")] public bool? IsRunning { get; init; } /// - /// If true, the request timed out before completion. + /// + /// If true, the request timed out before completion. + /// /// [JsonInclude, JsonPropertyName("timed_out")] public bool? TimedOut { get; init; } /// - /// Milliseconds it took Elasticsearch to execute the request. + /// + /// Milliseconds it took Elasticsearch to execute the request. + /// /// [JsonInclude, JsonPropertyName("took")] public long? Took { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlSearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlSearchRequest.g.cs index bf8bb920c7a..086ac9ef3c4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlSearchRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlSearchRequest.g.cs @@ -35,13 +35,17 @@ public sealed partial class EqlSearchRequestParameters : RequestParameters public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If true, missing or closed indices are not included in the response. + /// + /// If true, missing or closed indices are not included in the response. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } } /// -/// Returns results matching a query expressed in Event Query Language (EQL) +/// +/// Returns results matching a query expressed in Event Query Language (EQL) +/// /// public sealed partial class EqlSearchRequest : PlainRequest { @@ -63,7 +67,9 @@ public EqlSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Indices indices public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If true, missing or closed indices are not included in the response. + /// + /// If true, missing or closed indices are not included in the response. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } @@ -71,26 +77,34 @@ public EqlSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Indices indices public bool? CaseSensitive { get; set; } /// - /// Field containing the event classification, such as process, file, or network. + /// + /// Field containing the event classification, such as process, file, or network. + /// /// [JsonInclude, JsonPropertyName("event_category_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? EventCategoryField { get; set; } /// - /// Maximum number of events to search at a time for sequence queries. + /// + /// Maximum number of events to search at a time for sequence queries. + /// /// [JsonInclude, JsonPropertyName("fetch_size")] public int? FetchSize { get; set; } /// - /// Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit. + /// + /// Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit. + /// /// [JsonInclude, JsonPropertyName("fields")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.FieldAndFormat))] public ICollection? Fields { get; set; } /// - /// Query, written in Query DSL, used to filter the events on which the EQL query runs. + /// + /// Query, written in Query DSL, used to filter the events on which the EQL query runs. + /// /// [JsonInclude, JsonPropertyName("filter")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query))] @@ -101,7 +115,9 @@ public EqlSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Indices indices public bool? KeepOnCompletion { get; set; } /// - /// EQL query you wish to run. + /// + /// EQL query you wish to run. + /// /// [JsonInclude, JsonPropertyName("query")] public string Query { get; set; } @@ -111,19 +127,25 @@ public EqlSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Indices indices public IDictionary? RuntimeMappings { get; set; } /// - /// For basic queries, the maximum number of matching events to return. Defaults to 10 + /// + /// For basic queries, the maximum number of matching events to return. Defaults to 10 + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// Field used to sort hits with the same timestamp in ascending order + /// + /// Field used to sort hits with the same timestamp in ascending order + /// /// [JsonInclude, JsonPropertyName("tiebreaker_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? TiebreakerField { get; set; } /// - /// Field containing event timestamp. Default "@timestamp" + /// + /// Field containing event timestamp. Default "@timestamp" + /// /// [JsonInclude, JsonPropertyName("timestamp_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? TimestampField { get; set; } @@ -132,7 +154,9 @@ public EqlSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Indices indices } /// -/// Returns results matching a query expressed in Event Query Language (EQL) +/// +/// Returns results matching a query expressed in Event Query Language (EQL) +/// /// public sealed partial class EqlSearchRequestDescriptor : RequestDescriptor, EqlSearchRequestParameters> { @@ -192,7 +216,9 @@ public EqlSearchRequestDescriptor CaseSensitive(bool? caseSensitive = } /// - /// Field containing the event classification, such as process, file, or network. + /// + /// Field containing the event classification, such as process, file, or network. + /// /// public EqlSearchRequestDescriptor EventCategoryField(Elastic.Clients.Elasticsearch.Serverless.Field? eventCategoryField) { @@ -201,7 +227,9 @@ public EqlSearchRequestDescriptor EventCategoryField(Elastic.Clients. } /// - /// Field containing the event classification, such as process, file, or network. + /// + /// Field containing the event classification, such as process, file, or network. + /// /// public EqlSearchRequestDescriptor EventCategoryField(Expression> eventCategoryField) { @@ -210,7 +238,9 @@ public EqlSearchRequestDescriptor EventCategoryField(Expressi } /// - /// Field containing the event classification, such as process, file, or network. + /// + /// Field containing the event classification, such as process, file, or network. + /// /// public EqlSearchRequestDescriptor EventCategoryField(Expression> eventCategoryField) { @@ -219,7 +249,9 @@ public EqlSearchRequestDescriptor EventCategoryField(Expression - /// Maximum number of events to search at a time for sequence queries. + /// + /// Maximum number of events to search at a time for sequence queries. + /// /// public EqlSearchRequestDescriptor FetchSize(int? fetchSize) { @@ -228,7 +260,9 @@ public EqlSearchRequestDescriptor FetchSize(int? fetchSize) } /// - /// Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit. + /// + /// Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit. + /// /// public EqlSearchRequestDescriptor Fields(ICollection? fields) { @@ -267,7 +301,9 @@ public EqlSearchRequestDescriptor Fields(params Action - /// Query, written in Query DSL, used to filter the events on which the EQL query runs. + /// + /// Query, written in Query DSL, used to filter the events on which the EQL query runs. + /// /// public EqlSearchRequestDescriptor Filter(ICollection? filter) { @@ -318,7 +354,9 @@ public EqlSearchRequestDescriptor KeepOnCompletion(bool? keepOnComple } /// - /// EQL query you wish to run. + /// + /// EQL query you wish to run. + /// /// public EqlSearchRequestDescriptor Query(string query) { @@ -339,7 +377,9 @@ public EqlSearchRequestDescriptor RuntimeMappings(Func - /// For basic queries, the maximum number of matching events to return. Defaults to 10 + /// + /// For basic queries, the maximum number of matching events to return. Defaults to 10 + /// /// public EqlSearchRequestDescriptor Size(int? size) { @@ -348,7 +388,9 @@ public EqlSearchRequestDescriptor Size(int? size) } /// - /// Field used to sort hits with the same timestamp in ascending order + /// + /// Field used to sort hits with the same timestamp in ascending order + /// /// public EqlSearchRequestDescriptor TiebreakerField(Elastic.Clients.Elasticsearch.Serverless.Field? tiebreakerField) { @@ -357,7 +399,9 @@ public EqlSearchRequestDescriptor TiebreakerField(Elastic.Clients.Ela } /// - /// Field used to sort hits with the same timestamp in ascending order + /// + /// Field used to sort hits with the same timestamp in ascending order + /// /// public EqlSearchRequestDescriptor TiebreakerField(Expression> tiebreakerField) { @@ -366,7 +410,9 @@ public EqlSearchRequestDescriptor TiebreakerField(Expression< } /// - /// Field used to sort hits with the same timestamp in ascending order + /// + /// Field used to sort hits with the same timestamp in ascending order + /// /// public EqlSearchRequestDescriptor TiebreakerField(Expression> tiebreakerField) { @@ -375,7 +421,9 @@ public EqlSearchRequestDescriptor TiebreakerField(Expression - /// Field containing event timestamp. Default "@timestamp" + /// + /// Field containing event timestamp. Default "@timestamp" + /// /// public EqlSearchRequestDescriptor TimestampField(Elastic.Clients.Elasticsearch.Serverless.Field? timestampField) { @@ -384,7 +432,9 @@ public EqlSearchRequestDescriptor TimestampField(Elastic.Clients.Elas } /// - /// Field containing event timestamp. Default "@timestamp" + /// + /// Field containing event timestamp. Default "@timestamp" + /// /// public EqlSearchRequestDescriptor TimestampField(Expression> timestampField) { @@ -393,7 +443,9 @@ public EqlSearchRequestDescriptor TimestampField(Expression - /// Field containing event timestamp. Default "@timestamp" + /// + /// Field containing event timestamp. Default "@timestamp" + /// /// public EqlSearchRequestDescriptor TimestampField(Expression> timestampField) { @@ -541,7 +593,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns results matching a query expressed in Event Query Language (EQL) +/// +/// Returns results matching a query expressed in Event Query Language (EQL) +/// /// public sealed partial class EqlSearchRequestDescriptor : RequestDescriptor { @@ -597,7 +651,9 @@ public EqlSearchRequestDescriptor CaseSensitive(bool? caseSensitive = true) } /// - /// Field containing the event classification, such as process, file, or network. + /// + /// Field containing the event classification, such as process, file, or network. + /// /// public EqlSearchRequestDescriptor EventCategoryField(Elastic.Clients.Elasticsearch.Serverless.Field? eventCategoryField) { @@ -606,7 +662,9 @@ public EqlSearchRequestDescriptor EventCategoryField(Elastic.Clients.Elasticsear } /// - /// Field containing the event classification, such as process, file, or network. + /// + /// Field containing the event classification, such as process, file, or network. + /// /// public EqlSearchRequestDescriptor EventCategoryField(Expression> eventCategoryField) { @@ -615,7 +673,9 @@ public EqlSearchRequestDescriptor EventCategoryField(Expressi } /// - /// Field containing the event classification, such as process, file, or network. + /// + /// Field containing the event classification, such as process, file, or network. + /// /// public EqlSearchRequestDescriptor EventCategoryField(Expression> eventCategoryField) { @@ -624,7 +684,9 @@ public EqlSearchRequestDescriptor EventCategoryField(Expression - /// Maximum number of events to search at a time for sequence queries. + /// + /// Maximum number of events to search at a time for sequence queries. + /// /// public EqlSearchRequestDescriptor FetchSize(int? fetchSize) { @@ -633,7 +695,9 @@ public EqlSearchRequestDescriptor FetchSize(int? fetchSize) } /// - /// Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit. + /// + /// Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit. + /// /// public EqlSearchRequestDescriptor Fields(ICollection? fields) { @@ -672,7 +736,9 @@ public EqlSearchRequestDescriptor Fields(params Action - /// Query, written in Query DSL, used to filter the events on which the EQL query runs. + /// + /// Query, written in Query DSL, used to filter the events on which the EQL query runs. + /// /// public EqlSearchRequestDescriptor Filter(ICollection? filter) { @@ -723,7 +789,9 @@ public EqlSearchRequestDescriptor KeepOnCompletion(bool? keepOnCompletion = true } /// - /// EQL query you wish to run. + /// + /// EQL query you wish to run. + /// /// public EqlSearchRequestDescriptor Query(string query) { @@ -744,7 +812,9 @@ public EqlSearchRequestDescriptor RuntimeMappings(Func - /// For basic queries, the maximum number of matching events to return. Defaults to 10 + /// + /// For basic queries, the maximum number of matching events to return. Defaults to 10 + /// /// public EqlSearchRequestDescriptor Size(int? size) { @@ -753,7 +823,9 @@ public EqlSearchRequestDescriptor Size(int? size) } /// - /// Field used to sort hits with the same timestamp in ascending order + /// + /// Field used to sort hits with the same timestamp in ascending order + /// /// public EqlSearchRequestDescriptor TiebreakerField(Elastic.Clients.Elasticsearch.Serverless.Field? tiebreakerField) { @@ -762,7 +834,9 @@ public EqlSearchRequestDescriptor TiebreakerField(Elastic.Clients.Elasticsearch. } /// - /// Field used to sort hits with the same timestamp in ascending order + /// + /// Field used to sort hits with the same timestamp in ascending order + /// /// public EqlSearchRequestDescriptor TiebreakerField(Expression> tiebreakerField) { @@ -771,7 +845,9 @@ public EqlSearchRequestDescriptor TiebreakerField(Expression< } /// - /// Field used to sort hits with the same timestamp in ascending order + /// + /// Field used to sort hits with the same timestamp in ascending order + /// /// public EqlSearchRequestDescriptor TiebreakerField(Expression> tiebreakerField) { @@ -780,7 +856,9 @@ public EqlSearchRequestDescriptor TiebreakerField(Expression - /// Field containing event timestamp. Default "@timestamp" + /// + /// Field containing event timestamp. Default "@timestamp" + /// /// public EqlSearchRequestDescriptor TimestampField(Elastic.Clients.Elasticsearch.Serverless.Field? timestampField) { @@ -789,7 +867,9 @@ public EqlSearchRequestDescriptor TimestampField(Elastic.Clients.Elasticsearch.S } /// - /// Field containing event timestamp. Default "@timestamp" + /// + /// Field containing event timestamp. Default "@timestamp" + /// /// public EqlSearchRequestDescriptor TimestampField(Expression> timestampField) { @@ -798,7 +878,9 @@ public EqlSearchRequestDescriptor TimestampField(Expression - /// Field containing event timestamp. Default "@timestamp" + /// + /// Field containing event timestamp. Default "@timestamp" + /// /// public EqlSearchRequestDescriptor TimestampField(Expression> timestampField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlSearchResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlSearchResponse.g.cs index 0e6dec8a0b4..17919854cf6 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlSearchResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlSearchResponse.g.cs @@ -29,37 +29,49 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Eql; public sealed partial class EqlSearchResponse : ElasticsearchResponse { /// - /// Contains matching events and sequences. Also contains related metadata. + /// + /// Contains matching events and sequences. Also contains related metadata. + /// /// [JsonInclude, JsonPropertyName("hits")] public Elastic.Clients.Elasticsearch.Serverless.Eql.EqlHits Hits { get; init; } /// - /// Identifier for the search. + /// + /// Identifier for the search. + /// /// [JsonInclude, JsonPropertyName("id")] public string? Id { get; init; } /// - /// If true, the response does not contain complete search results. + /// + /// If true, the response does not contain complete search results. + /// /// [JsonInclude, JsonPropertyName("is_partial")] public bool? IsPartial { get; init; } /// - /// If true, the search request is still executing. + /// + /// If true, the search request is still executing. + /// /// [JsonInclude, JsonPropertyName("is_running")] public bool? IsRunning { get; init; } /// - /// If true, the request timed out before completion. + /// + /// If true, the request timed out before completion. + /// /// [JsonInclude, JsonPropertyName("timed_out")] public bool? TimedOut { get; init; } /// - /// Milliseconds it took Elasticsearch to execute the request. + /// + /// Milliseconds it took Elasticsearch to execute the request. + /// /// [JsonInclude, JsonPropertyName("took")] public long? Took { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/GetEqlStatusRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/GetEqlStatusRequest.g.cs index 40b291526ef..d88d22c56bb 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/GetEqlStatusRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/GetEqlStatusRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class GetEqlStatusRequestParameters : RequestParameters } /// -/// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. +/// +/// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. +/// /// public sealed partial class GetEqlStatusRequest : PlainRequest { @@ -52,7 +54,9 @@ public GetEqlStatusRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : bas } /// -/// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. +/// +/// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. +/// /// public sealed partial class GetEqlStatusRequestDescriptor : RequestDescriptor, GetEqlStatusRequestParameters> { @@ -82,7 +86,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. +/// +/// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. +/// /// public sealed partial class GetEqlStatusRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/GetEqlStatusResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/GetEqlStatusResponse.g.cs index 37717c5af18..5112f40661b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/GetEqlStatusResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/GetEqlStatusResponse.g.cs @@ -29,37 +29,49 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Eql; public sealed partial class GetEqlStatusResponse : ElasticsearchResponse { /// - /// For a completed search shows the http status code of the completed search. + /// + /// For a completed search shows the http status code of the completed search. + /// /// [JsonInclude, JsonPropertyName("completion_status")] public int? CompletionStatus { get; init; } /// - /// Shows a timestamp when the eql search will be expired, in milliseconds since the Unix epoch. When this time is reached, the search and its results are deleted, even if the search is still ongoing. + /// + /// Shows a timestamp when the eql search will be expired, in milliseconds since the Unix epoch. When this time is reached, the search and its results are deleted, even if the search is still ongoing. + /// /// [JsonInclude, JsonPropertyName("expiration_time_in_millis")] public long? ExpirationTimeInMillis { get; init; } /// - /// Identifier for the search. + /// + /// Identifier for the search. + /// /// [JsonInclude, JsonPropertyName("id")] public string Id { get; init; } /// - /// If true, the search request is still executing. If false, the search is completed. + /// + /// If true, the search request is still executing. If false, the search is completed. + /// /// [JsonInclude, JsonPropertyName("is_partial")] public bool IsPartial { get; init; } /// - /// If true, the response does not contain complete search results. This could be because either the search is still running (is_running status is false), or because it is already completed (is_running status is true) and results are partial due to failures or timeouts. + /// + /// If true, the response does not contain complete search results. This could be because either the search is still running (is_running status is false), or because it is already completed (is_running status is true) and results are partial due to failures or timeouts. + /// /// [JsonInclude, JsonPropertyName("is_running")] public bool IsRunning { get; init; } /// - /// For a running search shows a timestamp when the eql search started, in milliseconds since the Unix epoch. + /// + /// For a running search shows a timestamp when the eql search started, in milliseconds since the Unix epoch. + /// /// [JsonInclude, JsonPropertyName("start_time_in_millis")] public long? StartTimeInMillis { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Esql/EsqlQueryRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Esql/EsqlQueryRequest.g.cs index 96f064dcdcf..69b18ee8d0e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Esql/EsqlQueryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Esql/EsqlQueryRequest.g.cs @@ -32,23 +32,32 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Esql; public sealed partial class EsqlQueryRequestParameters : RequestParameters { /// - /// The character to use between values within a CSV row. Only valid for the CSV format. + /// + /// The character to use between values within a CSV row. Only valid for the CSV format. + /// /// public string? Delimiter { get => Q("delimiter"); set => Q("delimiter", value); } /// - /// Should columns that are entirely `null` be removed from the `columns` and `values` portion of the results?
Defaults to `false`. If `true` then the response will include an extra section under the name `all_columns` which has the name of all columns. + /// + /// Should columns that are entirely null be removed from the columns and values portion of the results? + /// Defaults to false. If true then the response will include an extra section under the name all_columns which has the name of all columns. + /// /// public bool? DropNullColumns { get => Q("drop_null_columns"); set => Q("drop_null_columns", value); } /// - /// A short version of the Accept header, e.g. json, yaml. + /// + /// A short version of the Accept header, e.g. json, yaml. + /// /// public string? Format { get => Q("format"); set => Q("format", value); } } /// -/// Executes an ES|QL request +/// +/// Executes an ES|QL request +/// /// public sealed partial class EsqlQueryRequest : PlainRequest { @@ -61,31 +70,42 @@ public sealed partial class EsqlQueryRequest : PlainRequest "esql.query"; /// - /// The character to use between values within a CSV row. Only valid for the CSV format. + /// + /// The character to use between values within a CSV row. Only valid for the CSV format. + /// /// [JsonIgnore] public string? Delimiter { get => Q("delimiter"); set => Q("delimiter", value); } /// - /// Should columns that are entirely `null` be removed from the `columns` and `values` portion of the results?
Defaults to `false`. If `true` then the response will include an extra section under the name `all_columns` which has the name of all columns. + /// + /// Should columns that are entirely null be removed from the columns and values portion of the results? + /// Defaults to false. If true then the response will include an extra section under the name all_columns which has the name of all columns. + /// /// [JsonIgnore] public bool? DropNullColumns { get => Q("drop_null_columns"); set => Q("drop_null_columns", value); } /// - /// A short version of the Accept header, e.g. json, yaml. + /// + /// A short version of the Accept header, e.g. json, yaml. + /// /// [JsonIgnore] public string? Format { get => Q("format"); set => Q("format", value); } /// - /// By default, ES|QL returns results as rows. For example, FROM returns each individual document as one row. For the JSON, YAML, CBOR and smile formats, ES|QL can return the results in a columnar fashion where one row represents all the values of a certain column in the results. + /// + /// By default, ES|QL returns results as rows. For example, FROM returns each individual document as one row. For the JSON, YAML, CBOR and smile formats, ES|QL can return the results in a columnar fashion where one row represents all the values of a certain column in the results. + /// /// [JsonInclude, JsonPropertyName("columnar")] public bool? Columnar { get; set; } /// - /// Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on. + /// + /// Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on. + /// /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? Filter { get; set; } @@ -93,26 +113,37 @@ public sealed partial class EsqlQueryRequest : PlainRequest - /// To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters. + /// + /// To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters. + /// /// [JsonInclude, JsonPropertyName("params")] public ICollection? Params { get; set; } /// - /// If provided and `true` the response will include an extra `profile` object
with information on how the query was executed. This information is for human debugging
and its format can change at any time but it can give some insight into the performance
of each part of the query. + /// + /// If provided and true the response will include an extra profile object + /// with information on how the query was executed. This information is for human debugging + /// and its format can change at any time but it can give some insight into the performance + /// of each part of the query. + /// /// [JsonInclude, JsonPropertyName("profile")] public bool? Profile { get; set; } /// - /// The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results. + /// + /// The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results. + /// /// [JsonInclude, JsonPropertyName("query")] public string Query { get; set; } } /// -/// Executes an ES|QL request +/// +/// Executes an ES|QL request +/// /// public sealed partial class EsqlQueryRequestDescriptor : RequestDescriptor, EsqlQueryRequestParameters> { @@ -144,7 +175,9 @@ public EsqlQueryRequestDescriptor() private string QueryValue { get; set; } /// - /// By default, ES|QL returns results as rows. For example, FROM returns each individual document as one row. For the JSON, YAML, CBOR and smile formats, ES|QL can return the results in a columnar fashion where one row represents all the values of a certain column in the results. + /// + /// By default, ES|QL returns results as rows. For example, FROM returns each individual document as one row. For the JSON, YAML, CBOR and smile formats, ES|QL can return the results in a columnar fashion where one row represents all the values of a certain column in the results. + /// /// public EsqlQueryRequestDescriptor Columnar(bool? columnar = true) { @@ -153,7 +186,9 @@ public EsqlQueryRequestDescriptor Columnar(bool? columnar = true) } /// - /// Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on. + /// + /// Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on. + /// /// public EsqlQueryRequestDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? filter) { @@ -186,7 +221,9 @@ public EsqlQueryRequestDescriptor Locale(string? locale) } /// - /// To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters. + /// + /// To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters. + /// /// public EsqlQueryRequestDescriptor Params(ICollection? value) { @@ -195,7 +232,12 @@ public EsqlQueryRequestDescriptor Params(ICollection - /// If provided and `true` the response will include an extra `profile` object
with information on how the query was executed. This information is for human debugging
and its format can change at any time but it can give some insight into the performance
of each part of the query. + /// + /// If provided and true the response will include an extra profile object + /// with information on how the query was executed. This information is for human debugging + /// and its format can change at any time but it can give some insight into the performance + /// of each part of the query. + /// /// public EsqlQueryRequestDescriptor Profile(bool? profile = true) { @@ -204,7 +246,9 @@ public EsqlQueryRequestDescriptor Profile(bool? profile = true) } /// - /// The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results. + /// + /// The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results. + /// /// public EsqlQueryRequestDescriptor Query(string query) { @@ -262,7 +306,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Executes an ES|QL request +/// +/// Executes an ES|QL request +/// /// public sealed partial class EsqlQueryRequestDescriptor : RequestDescriptor { @@ -294,7 +340,9 @@ public EsqlQueryRequestDescriptor() private string QueryValue { get; set; } /// - /// By default, ES|QL returns results as rows. For example, FROM returns each individual document as one row. For the JSON, YAML, CBOR and smile formats, ES|QL can return the results in a columnar fashion where one row represents all the values of a certain column in the results. + /// + /// By default, ES|QL returns results as rows. For example, FROM returns each individual document as one row. For the JSON, YAML, CBOR and smile formats, ES|QL can return the results in a columnar fashion where one row represents all the values of a certain column in the results. + /// /// public EsqlQueryRequestDescriptor Columnar(bool? columnar = true) { @@ -303,7 +351,9 @@ public EsqlQueryRequestDescriptor Columnar(bool? columnar = true) } /// - /// Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on. + /// + /// Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on. + /// /// public EsqlQueryRequestDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? filter) { @@ -336,7 +386,9 @@ public EsqlQueryRequestDescriptor Locale(string? locale) } /// - /// To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters. + /// + /// To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters. + /// /// public EsqlQueryRequestDescriptor Params(ICollection? value) { @@ -345,7 +397,12 @@ public EsqlQueryRequestDescriptor Params(ICollection - /// If provided and `true` the response will include an extra `profile` object
with information on how the query was executed. This information is for human debugging
and its format can change at any time but it can give some insight into the performance
of each part of the query. + /// + /// If provided and true the response will include an extra profile object + /// with information on how the query was executed. This information is for human debugging + /// and its format can change at any time but it can give some insight into the performance + /// of each part of the query. + /// /// public EsqlQueryRequestDescriptor Profile(bool? profile = true) { @@ -354,7 +411,9 @@ public EsqlQueryRequestDescriptor Profile(bool? profile = true) } /// - /// The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results. + /// + /// The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results. + /// /// public EsqlQueryRequestDescriptor Query(string query) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ExistsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ExistsRequest.g.cs index bf5938c0b8b..e24bcb41a50 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ExistsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ExistsRequest.g.cs @@ -32,58 +32,85 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class ExistsRequestParameters : RequestParameters { /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If `true`, the request is real-time as opposed to near-real-time. + /// + /// If true, the request is real-time as opposed to near-real-time. + /// /// public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } /// - /// If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes. + /// + /// If true, Elasticsearch refreshes all shards involved in the delete by query after the request completes. + /// /// public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// Target the specified primary shard. + /// + /// Target the specified primary shard. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// `true` or `false` to return the `_source` field or not, or a list of fields to return. + /// + /// true or false to return the _source field or not, or a list of fields to return. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfigParam? Source { get => Q("_source"); set => Q("_source", value); } /// - /// A comma-separated list of source fields to exclude in the response. + /// + /// A comma-separated list of source fields to exclude in the response. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response. + /// + /// A comma-separated list of source fields to include in the response. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// List of stored fields to return as part of a hit.
If no fields are specified, no stored fields are included in the response.
If this field is specified, the `_source` parameter defaults to false. + /// + /// List of stored fields to return as part of a hit. + /// If no fields are specified, no stored fields are included in the response. + /// If this field is specified, the _source parameter defaults to false. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? StoredFields { get => Q("stored_fields"); set => Q("stored_fields", value); } /// - /// Explicit version number for concurrency control.
The specified version must match the current version of the document for the request to succeed. + /// + /// Explicit version number for concurrency control. + /// The specified version must match the current version of the document for the request to succeed. + /// /// public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type: `external`, `external_gte`. + /// + /// Specific version type: external, external_gte. + /// /// public Elastic.Clients.Elasticsearch.Serverless.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } } /// -/// Check a document.
Checks if a specified document exists. +/// +/// Check a document. +/// Checks if a specified document exists. +/// /// public sealed partial class ExistsRequest : PlainRequest { @@ -100,68 +127,95 @@ public ExistsRequest(Elastic.Clients.Elasticsearch.Serverless.IndexName index, E internal override string OperationName => "exists"; /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If `true`, the request is real-time as opposed to near-real-time. + /// + /// If true, the request is real-time as opposed to near-real-time. + /// /// [JsonIgnore] public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } /// - /// If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes. + /// + /// If true, Elasticsearch refreshes all shards involved in the delete by query after the request completes. + /// /// [JsonIgnore] public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// Target the specified primary shard. + /// + /// Target the specified primary shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// `true` or `false` to return the `_source` field or not, or a list of fields to return. + /// + /// true or false to return the _source field or not, or a list of fields to return. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfigParam? Source { get => Q("_source"); set => Q("_source", value); } /// - /// A comma-separated list of source fields to exclude in the response. + /// + /// A comma-separated list of source fields to exclude in the response. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response. + /// + /// A comma-separated list of source fields to include in the response. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// List of stored fields to return as part of a hit.
If no fields are specified, no stored fields are included in the response.
If this field is specified, the `_source` parameter defaults to false. + /// + /// List of stored fields to return as part of a hit. + /// If no fields are specified, no stored fields are included in the response. + /// If this field is specified, the _source parameter defaults to false. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? StoredFields { get => Q("stored_fields"); set => Q("stored_fields", value); } /// - /// Explicit version number for concurrency control.
The specified version must match the current version of the document for the request to succeed. + /// + /// Explicit version number for concurrency control. + /// The specified version must match the current version of the document for the request to succeed. + /// /// [JsonIgnore] public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type: `external`, `external_gte`. + /// + /// Specific version type: external, external_gte. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } } /// -/// Check a document.
Checks if a specified document exists. +/// +/// Check a document. +/// Checks if a specified document exists. +/// /// public sealed partial class ExistsRequestDescriptor : RequestDescriptor, ExistsRequestParameters> { @@ -224,7 +278,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Check a document.
Checks if a specified document exists. +/// +/// Check a document. +/// Checks if a specified document exists. +/// /// public sealed partial class ExistsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ExistsSourceRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ExistsSourceRequest.g.cs index 1ab11b6d071..19dbbc8c024 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ExistsSourceRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ExistsSourceRequest.g.cs @@ -32,53 +32,76 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class ExistsSourceRequestParameters : RequestParameters { /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If true, the request is real-time as opposed to near-real-time. + /// + /// If true, the request is real-time as opposed to near-real-time. + /// /// public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } /// - /// If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes. + /// + /// If true, Elasticsearch refreshes all shards involved in the delete by query after the request completes. + /// /// public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// Target the specified primary shard. + /// + /// Target the specified primary shard. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// `true` or `false` to return the `_source` field or not, or a list of fields to return. + /// + /// true or false to return the _source field or not, or a list of fields to return. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfigParam? Source { get => Q("_source"); set => Q("_source", value); } /// - /// A comma-separated list of source fields to exclude in the response. + /// + /// A comma-separated list of source fields to exclude in the response. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response. + /// + /// A comma-separated list of source fields to include in the response. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// Explicit version number for concurrency control.
The specified version must match the current version of the document for the request to succeed. + /// + /// Explicit version number for concurrency control. + /// The specified version must match the current version of the document for the request to succeed. + /// /// public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type: `external`, `external_gte`. + /// + /// Specific version type: external, external_gte. + /// /// public Elastic.Clients.Elasticsearch.Serverless.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } } /// -/// Check for a document source.
Checks if a document's `_source` is stored. +/// +/// Check for a document source. +/// Checks if a document's _source is stored. +/// /// public sealed partial class ExistsSourceRequest : PlainRequest { @@ -95,62 +118,85 @@ public ExistsSourceRequest(Elastic.Clients.Elasticsearch.Serverless.IndexName in internal override string OperationName => "exists_source"; /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If true, the request is real-time as opposed to near-real-time. + /// + /// If true, the request is real-time as opposed to near-real-time. + /// /// [JsonIgnore] public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } /// - /// If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes. + /// + /// If true, Elasticsearch refreshes all shards involved in the delete by query after the request completes. + /// /// [JsonIgnore] public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// Target the specified primary shard. + /// + /// Target the specified primary shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// `true` or `false` to return the `_source` field or not, or a list of fields to return. + /// + /// true or false to return the _source field or not, or a list of fields to return. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfigParam? Source { get => Q("_source"); set => Q("_source", value); } /// - /// A comma-separated list of source fields to exclude in the response. + /// + /// A comma-separated list of source fields to exclude in the response. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response. + /// + /// A comma-separated list of source fields to include in the response. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// Explicit version number for concurrency control.
The specified version must match the current version of the document for the request to succeed. + /// + /// Explicit version number for concurrency control. + /// The specified version must match the current version of the document for the request to succeed. + /// /// [JsonIgnore] public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type: `external`, `external_gte`. + /// + /// Specific version type: external, external_gte. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } } /// -/// Check for a document source.
Checks if a document's `_source` is stored. +/// +/// Check for a document source. +/// Checks if a document's _source is stored. +/// /// public sealed partial class ExistsSourceRequestDescriptor : RequestDescriptor, ExistsSourceRequestParameters> { @@ -212,7 +258,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Check for a document source.
Checks if a document's `_source` is stored. +/// +/// Check for a document source. +/// Checks if a document's _source is stored. +/// /// public sealed partial class ExistsSourceRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ExplainRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ExplainRequest.g.cs index e9f5ca5b2c9..28d5e4b07a8 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ExplainRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ExplainRequest.g.cs @@ -32,68 +32,97 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class ExplainRequestParameters : RequestParameters { /// - /// Analyzer to use for the query string.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// Analyzer to use for the query string. + /// This parameter can only be used when the q query string parameter is specified. + /// /// public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// - /// If `true`, wildcard and prefix queries are analyzed. + /// + /// If true, wildcard and prefix queries are analyzed. + /// /// public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } /// - /// The default operator for query string query: `AND` or `OR`. + /// + /// The default operator for query string query: AND or OR. + /// /// public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } /// - /// Field to use as default where no field prefix is given in the query string. + /// + /// Field to use as default where no field prefix is given in the query string. + /// /// public string? Df { get => Q("df"); set => Q("df", value); } /// - /// If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// + /// If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// /// public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// Query in the Lucene query string syntax. + /// + /// Query in the Lucene query string syntax. + /// /// public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// True or false to return the `_source` field or not, or a list of fields to return. + /// + /// True or false to return the _source field or not, or a list of fields to return. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfigParam? Source { get => Q("_source"); set => Q("_source", value); } /// - /// A comma-separated list of source fields to exclude from the response. + /// + /// A comma-separated list of source fields to exclude from the response. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response. + /// + /// A comma-separated list of source fields to include in the response. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// A comma-separated list of stored fields to return in the response. + /// + /// A comma-separated list of stored fields to return in the response. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? StoredFields { get => Q("stored_fields"); set => Q("stored_fields", value); } } /// -/// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. +/// +/// Explain a document match result. +/// Returns information about why a specific document matches, or doesn’t match, a query. +/// /// public sealed partial class ExplainRequest : PlainRequest { @@ -110,86 +139,117 @@ public ExplainRequest(Elastic.Clients.Elasticsearch.Serverless.IndexName index, internal override string OperationName => "explain"; /// - /// Analyzer to use for the query string.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// Analyzer to use for the query string. + /// This parameter can only be used when the q query string parameter is specified. + /// /// [JsonIgnore] public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// - /// If `true`, wildcard and prefix queries are analyzed. + /// + /// If true, wildcard and prefix queries are analyzed. + /// /// [JsonIgnore] public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } /// - /// The default operator for query string query: `AND` or `OR`. + /// + /// The default operator for query string query: AND or OR. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } /// - /// Field to use as default where no field prefix is given in the query string. + /// + /// Field to use as default where no field prefix is given in the query string. + /// /// [JsonIgnore] public string? Df { get => Q("df"); set => Q("df", value); } /// - /// If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// + /// If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// /// [JsonIgnore] public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// Query in the Lucene query string syntax. + /// + /// Query in the Lucene query string syntax. + /// /// [JsonIgnore] public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// True or false to return the `_source` field or not, or a list of fields to return. + /// + /// True or false to return the _source field or not, or a list of fields to return. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfigParam? Source { get => Q("_source"); set => Q("_source", value); } /// - /// A comma-separated list of source fields to exclude from the response. + /// + /// A comma-separated list of source fields to exclude from the response. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response. + /// + /// A comma-separated list of source fields to include in the response. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// A comma-separated list of stored fields to return in the response. + /// + /// A comma-separated list of stored fields to return in the response. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? StoredFields { get => Q("stored_fields"); set => Q("stored_fields", value); } /// - /// Defines the search definition using the Query DSL. + /// + /// Defines the search definition using the Query DSL. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? Query { get; set; } } /// -/// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. +/// +/// Explain a document match result. +/// Returns information about why a specific document matches, or doesn’t match, a query. +/// /// public sealed partial class ExplainRequestDescriptor : RequestDescriptor, ExplainRequestParameters> { @@ -253,7 +313,9 @@ public ExplainRequestDescriptor Index(Elastic.Clients.Elasticsearch.S private Action> QueryDescriptorAction { get; set; } /// - /// Defines the search definition using the Query DSL. + /// + /// Defines the search definition using the Query DSL. + /// /// public ExplainRequestDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -303,7 +365,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. +/// +/// Explain a document match result. +/// Returns information about why a specific document matches, or doesn’t match, a query. +/// /// public sealed partial class ExplainRequestDescriptor : RequestDescriptor { @@ -351,7 +416,9 @@ public ExplainRequestDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.I private Action QueryDescriptorAction { get; set; } /// - /// Defines the search definition using the Query DSL. + /// + /// Defines the search definition using the Query DSL. + /// /// public ExplainRequestDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/FieldCapsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/FieldCapsRequest.g.cs index 3e095a8a945..293d92123dd 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/FieldCapsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/FieldCapsRequest.g.cs @@ -32,43 +32,63 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class FieldCapsRequestParameters : RequestParameters { /// - /// If false, the request returns an error if any wildcard expression, index alias,
or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request
targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with bar. + /// + /// If false, the request returns an error if any wildcard expression, index alias, + /// or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request + /// targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. + /// + /// Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// An optional set of filters: can include +metadata,-metadata,-nested,-multifield,-parent + /// + /// An optional set of filters: can include +metadata,-metadata,-nested,-multifield,-parent + /// /// public string? Filters { get => Q("filters"); set => Q("filters", value); } /// - /// If `true`, missing or closed indices are not included in the response. + /// + /// If true, missing or closed indices are not included in the response. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If false, empty fields are not included in the response. + /// + /// If false, empty fields are not included in the response. + /// /// public bool? IncludeEmptyFields { get => Q("include_empty_fields"); set => Q("include_empty_fields", value); } /// - /// If true, unmapped fields are included in the response. + /// + /// If true, unmapped fields are included in the response. + /// /// public bool? IncludeUnmapped { get => Q("include_unmapped"); set => Q("include_unmapped", value); } /// - /// Only return results for fields that have one of the types in the list + /// + /// Only return results for fields that have one of the types in the list + /// /// public ICollection? Types { get => Q?>("types"); set => Q("types", value); } } /// -/// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. +/// +/// The field capabilities API returns the information about the capabilities of fields among multiple indices. +/// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type +/// of keyword is returned as any other field that belongs to the keyword family. +/// /// public sealed partial class FieldCapsRequest : PlainRequest { @@ -89,69 +109,96 @@ public FieldCapsRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? indice internal override string OperationName => "field_caps"; /// - /// If false, the request returns an error if any wildcard expression, index alias,
or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request
targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with bar. + /// + /// If false, the request returns an error if any wildcard expression, index alias, + /// or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request + /// targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. + /// + /// Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// An optional set of filters: can include +metadata,-metadata,-nested,-multifield,-parent + /// + /// An optional set of filters: can include +metadata,-metadata,-nested,-multifield,-parent + /// /// [JsonIgnore] public string? Filters { get => Q("filters"); set => Q("filters", value); } /// - /// If `true`, missing or closed indices are not included in the response. + /// + /// If true, missing or closed indices are not included in the response. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If false, empty fields are not included in the response. + /// + /// If false, empty fields are not included in the response. + /// /// [JsonIgnore] public bool? IncludeEmptyFields { get => Q("include_empty_fields"); set => Q("include_empty_fields", value); } /// - /// If true, unmapped fields are included in the response. + /// + /// If true, unmapped fields are included in the response. + /// /// [JsonIgnore] public bool? IncludeUnmapped { get => Q("include_unmapped"); set => Q("include_unmapped", value); } /// - /// Only return results for fields that have one of the types in the list + /// + /// Only return results for fields that have one of the types in the list + /// /// [JsonIgnore] public ICollection? Types { get => Q?>("types"); set => Q("types", value); } /// - /// List of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported. + /// + /// List of fields to retrieve capabilities for. Wildcard (*) expressions are supported. + /// /// [JsonInclude, JsonPropertyName("fields")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] public Elastic.Clients.Elasticsearch.Serverless.Fields? Fields { get; set; } /// - /// Allows to filter indices if the provided query rewrites to match_none on every shard. + /// + /// Allows to filter indices if the provided query rewrites to match_none on every shard. + /// /// [JsonInclude, JsonPropertyName("index_filter")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? IndexFilter { get; set; } /// - /// Defines ad-hoc runtime fields in the request similar to the way it is done in search requests.
These fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings. + /// + /// Defines ad-hoc runtime fields in the request similar to the way it is done in search requests. + /// These fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings. + /// /// [JsonInclude, JsonPropertyName("runtime_mappings")] public IDictionary? RuntimeMappings { get; set; } } /// -/// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. +/// +/// The field capabilities API returns the information about the capabilities of fields among multiple indices. +/// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type +/// of keyword is returned as any other field that belongs to the keyword family. +/// /// public sealed partial class FieldCapsRequestDescriptor : RequestDescriptor, FieldCapsRequestParameters> { @@ -194,7 +241,9 @@ public FieldCapsRequestDescriptor Indices(Elastic.Clients.Elasticsear private IDictionary> RuntimeMappingsValue { get; set; } /// - /// List of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported. + /// + /// List of fields to retrieve capabilities for. Wildcard (*) expressions are supported. + /// /// public FieldCapsRequestDescriptor Fields(Elastic.Clients.Elasticsearch.Serverless.Fields? fields) { @@ -203,7 +252,9 @@ public FieldCapsRequestDescriptor Fields(Elastic.Clients.Elasticsearc } /// - /// Allows to filter indices if the provided query rewrites to match_none on every shard. + /// + /// Allows to filter indices if the provided query rewrites to match_none on every shard. + /// /// public FieldCapsRequestDescriptor IndexFilter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? indexFilter) { @@ -230,7 +281,10 @@ public FieldCapsRequestDescriptor IndexFilter(Action - /// Defines ad-hoc runtime fields in the request similar to the way it is done in search requests.
These fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings. + /// + /// Defines ad-hoc runtime fields in the request similar to the way it is done in search requests. + /// These fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings. + /// /// public FieldCapsRequestDescriptor RuntimeMappings(Func>, FluentDescriptorDictionary>> selector) { @@ -274,7 +328,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. +/// +/// The field capabilities API returns the information about the capabilities of fields among multiple indices. +/// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type +/// of keyword is returned as any other field that belongs to the keyword family. +/// /// public sealed partial class FieldCapsRequestDescriptor : RequestDescriptor { @@ -317,7 +375,9 @@ public FieldCapsRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Serverle private IDictionary RuntimeMappingsValue { get; set; } /// - /// List of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported. + /// + /// List of fields to retrieve capabilities for. Wildcard (*) expressions are supported. + /// /// public FieldCapsRequestDescriptor Fields(Elastic.Clients.Elasticsearch.Serverless.Fields? fields) { @@ -326,7 +386,9 @@ public FieldCapsRequestDescriptor Fields(Elastic.Clients.Elasticsearch.Serverles } /// - /// Allows to filter indices if the provided query rewrites to match_none on every shard. + /// + /// Allows to filter indices if the provided query rewrites to match_none on every shard. + /// /// public FieldCapsRequestDescriptor IndexFilter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? indexFilter) { @@ -353,7 +415,10 @@ public FieldCapsRequestDescriptor IndexFilter(Action - /// Defines ad-hoc runtime fields in the request similar to the way it is done in search requests.
These fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings. + /// + /// Defines ad-hoc runtime fields in the request similar to the way it is done in search requests. + /// These fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings. + /// /// public FieldCapsRequestDescriptor RuntimeMappings(Func, FluentDescriptorDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/GetRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/GetRequest.g.cs index 348c15507ef..e63379bc27d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/GetRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/GetRequest.g.cs @@ -32,58 +32,83 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class GetRequestParameters : RequestParameters { /// - /// Specifies the node or shard the operation should be performed on. Random by default. + /// + /// Specifies the node or shard the operation should be performed on. Random by default. + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If `true`, the request is real-time as opposed to near-real-time. + /// + /// If true, the request is real-time as opposed to near-real-time. + /// /// public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } /// - /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. + /// + /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. + /// /// public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// Target the specified primary shard. + /// + /// Target the specified primary shard. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// True or false to return the _source field or not, or a list of fields to return. + /// + /// True or false to return the _source field or not, or a list of fields to return. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfigParam? Source { get => Q("_source"); set => Q("_source", value); } /// - /// A comma-separated list of source fields to exclude in the response. + /// + /// A comma-separated list of source fields to exclude in the response. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response. + /// + /// A comma-separated list of source fields to include in the response. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// List of stored fields to return as part of a hit.
If no fields are specified, no stored fields are included in the response.
If this field is specified, the `_source` parameter defaults to false. + /// + /// List of stored fields to return as part of a hit. + /// If no fields are specified, no stored fields are included in the response. + /// If this field is specified, the _source parameter defaults to false. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? StoredFields { get => Q("stored_fields"); set => Q("stored_fields", value); } /// - /// Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. + /// + /// Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. + /// /// public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type: internal, external, external_gte. + /// + /// Specific version type: internal, external, external_gte. + /// /// public Elastic.Clients.Elasticsearch.Serverless.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } } /// -/// Get a document by its ID.
Retrieves the document with the specified ID from an index. +/// +/// Get a document by its ID. +/// Retrieves the document with the specified ID from an index. +/// /// public sealed partial class GetRequest : PlainRequest { @@ -100,68 +125,93 @@ public GetRequest(Elastic.Clients.Elasticsearch.Serverless.IndexName index, Elas internal override string OperationName => "get"; /// - /// Specifies the node or shard the operation should be performed on. Random by default. + /// + /// Specifies the node or shard the operation should be performed on. Random by default. + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If `true`, the request is real-time as opposed to near-real-time. + /// + /// If true, the request is real-time as opposed to near-real-time. + /// /// [JsonIgnore] public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } /// - /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. + /// + /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. + /// /// [JsonIgnore] public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// Target the specified primary shard. + /// + /// Target the specified primary shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// True or false to return the _source field or not, or a list of fields to return. + /// + /// True or false to return the _source field or not, or a list of fields to return. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfigParam? Source { get => Q("_source"); set => Q("_source", value); } /// - /// A comma-separated list of source fields to exclude in the response. + /// + /// A comma-separated list of source fields to exclude in the response. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response. + /// + /// A comma-separated list of source fields to include in the response. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// List of stored fields to return as part of a hit.
If no fields are specified, no stored fields are included in the response.
If this field is specified, the `_source` parameter defaults to false. + /// + /// List of stored fields to return as part of a hit. + /// If no fields are specified, no stored fields are included in the response. + /// If this field is specified, the _source parameter defaults to false. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? StoredFields { get => Q("stored_fields"); set => Q("stored_fields", value); } /// - /// Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. + /// + /// Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. + /// /// [JsonIgnore] public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type: internal, external, external_gte. + /// + /// Specific version type: internal, external, external_gte. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } } /// -/// Get a document by its ID.
Retrieves the document with the specified ID from an index. +/// +/// Get a document by its ID. +/// Retrieves the document with the specified ID from an index. +/// /// public sealed partial class GetRequestDescriptor : RequestDescriptor, GetRequestParameters> { @@ -224,7 +274,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Get a document by its ID.
Retrieves the document with the specified ID from an index. +/// +/// Get a document by its ID. +/// Retrieves the document with the specified ID from an index. +/// /// public sealed partial class GetRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/GetScriptRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/GetScriptRequest.g.cs index e55395d21b3..1895448bcf2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/GetScriptRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/GetScriptRequest.g.cs @@ -32,13 +32,18 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class GetScriptRequestParameters : RequestParameters { /// - /// Specify timeout for connection to master + /// + /// Specify timeout for connection to master + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// 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. +/// /// public sealed partial class GetScriptRequest : PlainRequest { @@ -55,14 +60,19 @@ public GetScriptRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : base(r internal override string OperationName => "get_script"; /// - /// Specify timeout for connection to master + /// + /// Specify timeout for connection to master + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// 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. +/// /// public sealed partial class GetScriptRequestDescriptor : RequestDescriptor, GetScriptRequestParameters> { @@ -94,7 +104,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// 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. +/// /// public sealed partial class GetScriptRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/GetSourceRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/GetSourceRequest.g.cs index 279d55dcf45..28f508e3429 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/GetSourceRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/GetSourceRequest.g.cs @@ -32,54 +32,75 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class GetSourceRequestParameters : RequestParameters { /// - /// Specifies the node or shard the operation should be performed on. Random by default. + /// + /// Specifies the node or shard the operation should be performed on. Random by default. + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// Boolean) If true, the request is real-time as opposed to near-real-time. + /// + /// Boolean) If true, the request is real-time as opposed to near-real-time. + /// /// public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } /// - /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. + /// + /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. + /// /// public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// Target the specified primary shard. + /// + /// Target the specified primary shard. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// True or false to return the _source field or not, or a list of fields to return. + /// + /// True or false to return the _source field or not, or a list of fields to return. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfigParam? Source { get => Q("_source"); set => Q("_source", value); } /// - /// A comma-separated list of source fields to exclude in the response. + /// + /// A comma-separated list of source fields to exclude in the response. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response. + /// + /// A comma-separated list of source fields to include in the response. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } public Elastic.Clients.Elasticsearch.Serverless.Fields? StoredFields { get => Q("stored_fields"); set => Q("stored_fields", value); } /// - /// Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. + /// + /// Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. + /// /// public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type: internal, external, external_gte. + /// + /// Specific version type: internal, external, external_gte. + /// /// public Elastic.Clients.Elasticsearch.Serverless.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } } /// -/// Get a document's source.
Returns the source of a document. +/// +/// Get a document's source. +/// Returns the source of a document. +/// /// public sealed partial class GetSourceRequest : PlainRequest { @@ -96,43 +117,57 @@ public GetSourceRequest(Elastic.Clients.Elasticsearch.Serverless.IndexName index internal override string OperationName => "get_source"; /// - /// Specifies the node or shard the operation should be performed on. Random by default. + /// + /// Specifies the node or shard the operation should be performed on. Random by default. + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// Boolean) If true, the request is real-time as opposed to near-real-time. + /// + /// Boolean) If true, the request is real-time as opposed to near-real-time. + /// /// [JsonIgnore] public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } /// - /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. + /// + /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. + /// /// [JsonIgnore] public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// Target the specified primary shard. + /// + /// Target the specified primary shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// True or false to return the _source field or not, or a list of fields to return. + /// + /// True or false to return the _source field or not, or a list of fields to return. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfigParam? Source { get => Q("_source"); set => Q("_source", value); } /// - /// A comma-separated list of source fields to exclude in the response. + /// + /// A comma-separated list of source fields to exclude in the response. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response. + /// + /// A comma-separated list of source fields to include in the response. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } @@ -140,20 +175,27 @@ public GetSourceRequest(Elastic.Clients.Elasticsearch.Serverless.IndexName index public Elastic.Clients.Elasticsearch.Serverless.Fields? StoredFields { get => Q("stored_fields"); set => Q("stored_fields", value); } /// - /// Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. + /// + /// Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. + /// /// [JsonIgnore] public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type: internal, external, external_gte. + /// + /// Specific version type: internal, external, external_gte. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } } /// -/// Get a document's source.
Returns the source of a document. +/// +/// Get a document's source. +/// Returns the source of a document. +/// /// public sealed partial class GetSourceRequestDescriptor : RequestDescriptor, GetSourceRequestParameters> { @@ -216,7 +258,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Get a document's source.
Returns the source of a document. +/// +/// Get a document's source. +/// Returns the source of a document. +/// /// public sealed partial class GetSourceRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Graph/ExploreRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Graph/ExploreRequest.g.cs index 32d1b7d67bf..919bd54cfd5 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Graph/ExploreRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Graph/ExploreRequest.g.cs @@ -32,18 +32,26 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Graph; public sealed partial class ExploreRequestParameters : RequestParameters { /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Specifies the period of time to wait for a response from each shard.
If no response is received before the timeout expires, the request fails and returns an error.
Defaults to no timeout. + /// + /// Specifies the period of time to wait for a response from each shard. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// Defaults to no timeout. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. +/// +/// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. +/// /// public sealed partial class ExploreRequest : PlainRequest { @@ -60,44 +68,60 @@ public ExploreRequest(Elastic.Clients.Elasticsearch.Serverless.Indices indices) internal override string OperationName => "graph.explore"; /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Specifies the period of time to wait for a response from each shard.
If no response is received before the timeout expires, the request fails and returns an error.
Defaults to no timeout. + /// + /// Specifies the period of time to wait for a response from each shard. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// Defaults to no timeout. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Specifies or more fields from which you want to extract terms that are associated with the specified vertices. + /// + /// Specifies or more fields from which you want to extract terms that are associated with the specified vertices. + /// /// [JsonInclude, JsonPropertyName("connections")] public Elastic.Clients.Elasticsearch.Serverless.Graph.Hop? Connections { get; set; } /// - /// Direct the Graph API how to build the graph. + /// + /// Direct the Graph API how to build the graph. + /// /// [JsonInclude, JsonPropertyName("controls")] public Elastic.Clients.Elasticsearch.Serverless.Graph.ExploreControls? Controls { get; set; } /// - /// A seed query that identifies the documents of interest. Can be any valid Elasticsearch query. + /// + /// A seed query that identifies the documents of interest. Can be any valid Elasticsearch query. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? Query { get; set; } /// - /// Specifies one or more fields that contain the terms you want to include in the graph as vertices. + /// + /// Specifies one or more fields that contain the terms you want to include in the graph as vertices. + /// /// [JsonInclude, JsonPropertyName("vertices")] public ICollection? Vertices { get; set; } } /// -/// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. +/// +/// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. +/// /// public sealed partial class ExploreRequestDescriptor : RequestDescriptor, ExploreRequestParameters> { @@ -143,7 +167,9 @@ public ExploreRequestDescriptor Indices(Elastic.Clients.Elasticsearch private Action>[] VerticesDescriptorActions { get; set; } /// - /// Specifies or more fields from which you want to extract terms that are associated with the specified vertices. + /// + /// Specifies or more fields from which you want to extract terms that are associated with the specified vertices. + /// /// public ExploreRequestDescriptor Connections(Elastic.Clients.Elasticsearch.Serverless.Graph.Hop? connections) { @@ -170,7 +196,9 @@ public ExploreRequestDescriptor Connections(Action - /// Direct the Graph API how to build the graph. + /// + /// Direct the Graph API how to build the graph. + /// /// public ExploreRequestDescriptor Controls(Elastic.Clients.Elasticsearch.Serverless.Graph.ExploreControls? controls) { @@ -197,7 +225,9 @@ public ExploreRequestDescriptor Controls(Action - /// A seed query that identifies the documents of interest. Can be any valid Elasticsearch query. + /// + /// A seed query that identifies the documents of interest. Can be any valid Elasticsearch query. + /// /// public ExploreRequestDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -224,7 +254,9 @@ public ExploreRequestDescriptor Query(Action - /// Specifies one or more fields that contain the terms you want to include in the graph as vertices. + /// + /// Specifies one or more fields that contain the terms you want to include in the graph as vertices. + /// /// public ExploreRequestDescriptor Vertices(ICollection? vertices) { @@ -349,7 +381,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. +/// +/// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. +/// /// public sealed partial class ExploreRequestDescriptor : RequestDescriptor { @@ -391,7 +425,9 @@ public ExploreRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless private Action[] VerticesDescriptorActions { get; set; } /// - /// Specifies or more fields from which you want to extract terms that are associated with the specified vertices. + /// + /// Specifies or more fields from which you want to extract terms that are associated with the specified vertices. + /// /// public ExploreRequestDescriptor Connections(Elastic.Clients.Elasticsearch.Serverless.Graph.Hop? connections) { @@ -418,7 +454,9 @@ public ExploreRequestDescriptor Connections(Action - /// Direct the Graph API how to build the graph. + /// + /// Direct the Graph API how to build the graph. + /// /// public ExploreRequestDescriptor Controls(Elastic.Clients.Elasticsearch.Serverless.Graph.ExploreControls? controls) { @@ -445,7 +483,9 @@ public ExploreRequestDescriptor Controls(Action - /// A seed query that identifies the documents of interest. Can be any valid Elasticsearch query. + /// + /// A seed query that identifies the documents of interest. Can be any valid Elasticsearch query. + /// /// public ExploreRequestDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -472,7 +512,9 @@ public ExploreRequestDescriptor Query(Action - /// Specifies one or more fields that contain the terms you want to include in the graph as vertices. + /// + /// Specifies one or more fields that contain the terms you want to include in the graph as vertices. + /// /// public ExploreRequestDescriptor Vertices(ICollection? vertices) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/HealthReportRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/HealthReportRequest.g.cs index b3ae1e6b331..a50ae8b7405 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/HealthReportRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/HealthReportRequest.g.cs @@ -32,23 +32,31 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class HealthReportRequestParameters : RequestParameters { /// - /// Limit the number of affected resources the health report API returns. + /// + /// Limit the number of affected resources the health report API returns. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } /// - /// Explicit operation timeout. + /// + /// Explicit operation timeout. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Opt-in for more information about the health of the system. + /// + /// Opt-in for more information about the health of the system. + /// /// public bool? Verbose { get => Q("verbose"); set => Q("verbose", value); } } /// -/// Returns the health of the cluster. +/// +/// Returns the health of the cluster. +/// /// public sealed partial class HealthReportRequest : PlainRequest { @@ -69,26 +77,34 @@ public HealthReportRequest(IReadOnlyCollection? feature) : base(r => r.O internal override string OperationName => "health_report"; /// - /// Limit the number of affected resources the health report API returns. + /// + /// Limit the number of affected resources the health report API returns. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } /// - /// Explicit operation timeout. + /// + /// Explicit operation timeout. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Opt-in for more information about the health of the system. + /// + /// Opt-in for more information about the health of the system. + /// /// [JsonIgnore] public bool? Verbose { get => Q("verbose"); set => Q("verbose", value); } } /// -/// Returns the health of the cluster. +/// +/// Returns the health of the cluster. +/// /// public sealed partial class HealthReportRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/AnalyzeIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/AnalyzeIndexRequest.g.cs index ca723c7de05..e340047680c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/AnalyzeIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/AnalyzeIndexRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class AnalyzeIndexRequestParameters : RequestParameters } /// -/// Performs analysis on a text string and returns the resulting tokens. +/// +/// Performs analysis on a text string and returns the resulting tokens. +/// /// public sealed partial class AnalyzeIndexRequest : PlainRequest { @@ -55,63 +57,87 @@ public AnalyzeIndexRequest(Elastic.Clients.Elasticsearch.Serverless.IndexName? i internal override string OperationName => "indices.analyze"; /// - /// The name of the analyzer that should be applied to the provided `text`.
This could be a built-in analyzer, or an analyzer that’s been configured in the index. + /// + /// The name of the analyzer that should be applied to the provided text. + /// This could be a built-in analyzer, or an analyzer that’s been configured in the index. + /// /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } /// - /// Array of token attributes used to filter the output of the `explain` parameter. + /// + /// Array of token attributes used to filter the output of the explain parameter. + /// /// [JsonInclude, JsonPropertyName("attributes")] public ICollection? Attributes { get; set; } /// - /// Array of character filters used to preprocess characters before the tokenizer. + /// + /// Array of character filters used to preprocess characters before the tokenizer. + /// /// [JsonInclude, JsonPropertyName("char_filter")] public ICollection? CharFilter { get; set; } /// - /// If `true`, the response includes token attributes and additional details. + /// + /// If true, the response includes token attributes and additional details. + /// /// [JsonInclude, JsonPropertyName("explain")] public bool? Explain { get; set; } /// - /// Field used to derive the analyzer.
To use this parameter, you must specify an index.
If specified, the `analyzer` parameter overrides this value. + /// + /// Field used to derive the analyzer. + /// To use this parameter, you must specify an index. + /// If specified, the analyzer parameter overrides this value. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } /// - /// Array of token filters used to apply after the tokenizer. + /// + /// Array of token filters used to apply after the tokenizer. + /// /// [JsonInclude, JsonPropertyName("filter")] public ICollection? Filter { get; set; } /// - /// Normalizer to use to convert text into a single token. + /// + /// Normalizer to use to convert text into a single token. + /// /// [JsonInclude, JsonPropertyName("normalizer")] public string? Normalizer { get; set; } /// - /// Text to analyze.
If an array of strings is provided, it is analyzed as a multi-value field. + /// + /// Text to analyze. + /// If an array of strings is provided, it is analyzed as a multi-value field. + /// /// [JsonInclude, JsonPropertyName("text")] [SingleOrManyCollectionConverter(typeof(string))] public ICollection? Text { get; set; } /// - /// Tokenizer to use to convert text into tokens. + /// + /// Tokenizer to use to convert text into tokens. + /// /// [JsonInclude, JsonPropertyName("tokenizer")] public Elastic.Clients.Elasticsearch.Serverless.Analysis.ITokenizer? Tokenizer { get; set; } } /// -/// Performs analysis on a text string and returns the resulting tokens. +/// +/// Performs analysis on a text string and returns the resulting tokens. +/// /// public sealed partial class AnalyzeIndexRequestDescriptor : RequestDescriptor, AnalyzeIndexRequestParameters> { @@ -150,7 +176,10 @@ public AnalyzeIndexRequestDescriptor Index(Elastic.Clients.Elasticsea private Elastic.Clients.Elasticsearch.Serverless.Analysis.ITokenizer? TokenizerValue { get; set; } /// - /// The name of the analyzer that should be applied to the provided `text`.
This could be a built-in analyzer, or an analyzer that’s been configured in the index. + /// + /// The name of the analyzer that should be applied to the provided text. + /// This could be a built-in analyzer, or an analyzer that’s been configured in the index. + /// /// public AnalyzeIndexRequestDescriptor Analyzer(string? analyzer) { @@ -159,7 +188,9 @@ public AnalyzeIndexRequestDescriptor Analyzer(string? analyzer) } /// - /// Array of token attributes used to filter the output of the `explain` parameter. + /// + /// Array of token attributes used to filter the output of the explain parameter. + /// /// public AnalyzeIndexRequestDescriptor Attributes(ICollection? attributes) { @@ -168,7 +199,9 @@ public AnalyzeIndexRequestDescriptor Attributes(ICollection? } /// - /// Array of character filters used to preprocess characters before the tokenizer. + /// + /// Array of character filters used to preprocess characters before the tokenizer. + /// /// public AnalyzeIndexRequestDescriptor CharFilter(ICollection? charFilter) { @@ -177,7 +210,9 @@ public AnalyzeIndexRequestDescriptor CharFilter(ICollection - /// If `true`, the response includes token attributes and additional details. + /// + /// If true, the response includes token attributes and additional details. + /// /// public AnalyzeIndexRequestDescriptor Explain(bool? explain = true) { @@ -186,7 +221,11 @@ public AnalyzeIndexRequestDescriptor Explain(bool? explain = true) } /// - /// Field used to derive the analyzer.
To use this parameter, you must specify an index.
If specified, the `analyzer` parameter overrides this value. + /// + /// Field used to derive the analyzer. + /// To use this parameter, you must specify an index. + /// If specified, the analyzer parameter overrides this value. + /// /// public AnalyzeIndexRequestDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -195,7 +234,11 @@ public AnalyzeIndexRequestDescriptor Field(Elastic.Clients.Elasticsea } /// - /// Field used to derive the analyzer.
To use this parameter, you must specify an index.
If specified, the `analyzer` parameter overrides this value. + /// + /// Field used to derive the analyzer. + /// To use this parameter, you must specify an index. + /// If specified, the analyzer parameter overrides this value. + /// /// public AnalyzeIndexRequestDescriptor Field(Expression> field) { @@ -204,7 +247,11 @@ public AnalyzeIndexRequestDescriptor Field(Expression - /// Field used to derive the analyzer.
To use this parameter, you must specify an index.
If specified, the `analyzer` parameter overrides this value. + /// + /// Field used to derive the analyzer. + /// To use this parameter, you must specify an index. + /// If specified, the analyzer parameter overrides this value. + /// /// public AnalyzeIndexRequestDescriptor Field(Expression> field) { @@ -213,7 +260,9 @@ public AnalyzeIndexRequestDescriptor Field(Expression - /// Array of token filters used to apply after the tokenizer. + /// + /// Array of token filters used to apply after the tokenizer. + /// /// public AnalyzeIndexRequestDescriptor Filter(ICollection? filter) { @@ -222,7 +271,9 @@ public AnalyzeIndexRequestDescriptor Filter(ICollection - /// Normalizer to use to convert text into a single token. + /// + /// Normalizer to use to convert text into a single token. + /// /// public AnalyzeIndexRequestDescriptor Normalizer(string? normalizer) { @@ -231,7 +282,10 @@ public AnalyzeIndexRequestDescriptor Normalizer(string? normalizer) } /// - /// Text to analyze.
If an array of strings is provided, it is analyzed as a multi-value field. + /// + /// Text to analyze. + /// If an array of strings is provided, it is analyzed as a multi-value field. + /// /// public AnalyzeIndexRequestDescriptor Text(ICollection? text) { @@ -240,7 +294,9 @@ public AnalyzeIndexRequestDescriptor Text(ICollection? text) } /// - /// Tokenizer to use to convert text into tokens. + /// + /// Tokenizer to use to convert text into tokens. + /// /// public AnalyzeIndexRequestDescriptor Tokenizer(Elastic.Clients.Elasticsearch.Serverless.Analysis.ITokenizer? tokenizer) { @@ -310,7 +366,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Performs analysis on a text string and returns the resulting tokens. +/// +/// Performs analysis on a text string and returns the resulting tokens. +/// /// public sealed partial class AnalyzeIndexRequestDescriptor : RequestDescriptor { @@ -349,7 +407,10 @@ public AnalyzeIndexRequestDescriptor Index(Elastic.Clients.Elasticsearch.Serverl private Elastic.Clients.Elasticsearch.Serverless.Analysis.ITokenizer? TokenizerValue { get; set; } /// - /// The name of the analyzer that should be applied to the provided `text`.
This could be a built-in analyzer, or an analyzer that’s been configured in the index. + /// + /// The name of the analyzer that should be applied to the provided text. + /// This could be a built-in analyzer, or an analyzer that’s been configured in the index. + /// /// public AnalyzeIndexRequestDescriptor Analyzer(string? analyzer) { @@ -358,7 +419,9 @@ public AnalyzeIndexRequestDescriptor Analyzer(string? analyzer) } /// - /// Array of token attributes used to filter the output of the `explain` parameter. + /// + /// Array of token attributes used to filter the output of the explain parameter. + /// /// public AnalyzeIndexRequestDescriptor Attributes(ICollection? attributes) { @@ -367,7 +430,9 @@ public AnalyzeIndexRequestDescriptor Attributes(ICollection? attributes) } /// - /// Array of character filters used to preprocess characters before the tokenizer. + /// + /// Array of character filters used to preprocess characters before the tokenizer. + /// /// public AnalyzeIndexRequestDescriptor CharFilter(ICollection? charFilter) { @@ -376,7 +441,9 @@ public AnalyzeIndexRequestDescriptor CharFilter(ICollection - /// If `true`, the response includes token attributes and additional details. + /// + /// If true, the response includes token attributes and additional details. + /// /// public AnalyzeIndexRequestDescriptor Explain(bool? explain = true) { @@ -385,7 +452,11 @@ public AnalyzeIndexRequestDescriptor Explain(bool? explain = true) } /// - /// Field used to derive the analyzer.
To use this parameter, you must specify an index.
If specified, the `analyzer` parameter overrides this value. + /// + /// Field used to derive the analyzer. + /// To use this parameter, you must specify an index. + /// If specified, the analyzer parameter overrides this value. + /// /// public AnalyzeIndexRequestDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -394,7 +465,11 @@ public AnalyzeIndexRequestDescriptor Field(Elastic.Clients.Elasticsearch.Serverl } /// - /// Field used to derive the analyzer.
To use this parameter, you must specify an index.
If specified, the `analyzer` parameter overrides this value. + /// + /// Field used to derive the analyzer. + /// To use this parameter, you must specify an index. + /// If specified, the analyzer parameter overrides this value. + /// /// public AnalyzeIndexRequestDescriptor Field(Expression> field) { @@ -403,7 +478,11 @@ public AnalyzeIndexRequestDescriptor Field(Expression - /// Field used to derive the analyzer.
To use this parameter, you must specify an index.
If specified, the `analyzer` parameter overrides this value. + /// + /// Field used to derive the analyzer. + /// To use this parameter, you must specify an index. + /// If specified, the analyzer parameter overrides this value. + /// /// public AnalyzeIndexRequestDescriptor Field(Expression> field) { @@ -412,7 +491,9 @@ public AnalyzeIndexRequestDescriptor Field(Expression - /// Array of token filters used to apply after the tokenizer. + /// + /// Array of token filters used to apply after the tokenizer. + /// /// public AnalyzeIndexRequestDescriptor Filter(ICollection? filter) { @@ -421,7 +502,9 @@ public AnalyzeIndexRequestDescriptor Filter(ICollection - /// Normalizer to use to convert text into a single token. + /// + /// Normalizer to use to convert text into a single token. + /// /// public AnalyzeIndexRequestDescriptor Normalizer(string? normalizer) { @@ -430,7 +513,10 @@ public AnalyzeIndexRequestDescriptor Normalizer(string? normalizer) } /// - /// Text to analyze.
If an array of strings is provided, it is analyzed as a multi-value field. + /// + /// Text to analyze. + /// If an array of strings is provided, it is analyzed as a multi-value field. + /// /// public AnalyzeIndexRequestDescriptor Text(ICollection? text) { @@ -439,7 +525,9 @@ public AnalyzeIndexRequestDescriptor Text(ICollection? text) } /// - /// Tokenizer to use to convert text into tokens. + /// + /// Tokenizer to use to convert text into tokens. + /// /// public AnalyzeIndexRequestDescriptor Tokenizer(Elastic.Clients.Elasticsearch.Serverless.Analysis.ITokenizer? tokenizer) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ClearCacheRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ClearCacheRequest.g.cs index b4bbee1e867..f5c44eb2b8d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ClearCacheRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ClearCacheRequest.g.cs @@ -32,43 +32,65 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class ClearCacheRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, clears the fields cache.
Use the `fields` parameter to clear the cache of specific fields only. + /// + /// If true, clears the fields cache. + /// Use the fields parameter to clear the cache of specific fields only. + /// /// public bool? Fielddata { get => Q("fielddata"); set => Q("fielddata", value); } /// - /// Comma-separated list of field names used to limit the `fielddata` parameter. + /// + /// Comma-separated list of field names used to limit the fielddata parameter. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? Fields { get => Q("fields"); set => Q("fields", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, clears the query cache. + /// + /// If true, clears the query cache. + /// /// public bool? Query { get => Q("query"); set => Q("query", value); } /// - /// If `true`, clears the request cache. + /// + /// If true, clears the request cache. + /// /// public bool? Request { get => Q("request"); set => Q("request", value); } } /// -/// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. +/// +/// Clears the caches of one or more indices. +/// For data streams, the API clears the caches of the stream’s backing indices. +/// /// public sealed partial class ClearCacheRequest : PlainRequest { @@ -89,50 +111,72 @@ public ClearCacheRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? indic internal override string OperationName => "indices.clear_cache"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, clears the fields cache.
Use the `fields` parameter to clear the cache of specific fields only. + /// + /// If true, clears the fields cache. + /// Use the fields parameter to clear the cache of specific fields only. + /// /// [JsonIgnore] public bool? Fielddata { get => Q("fielddata"); set => Q("fielddata", value); } /// - /// Comma-separated list of field names used to limit the `fielddata` parameter. + /// + /// Comma-separated list of field names used to limit the fielddata parameter. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? Fields { get => Q("fields"); set => Q("fields", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, clears the query cache. + /// + /// If true, clears the query cache. + /// /// [JsonIgnore] public bool? Query { get => Q("query"); set => Q("query", value); } /// - /// If `true`, clears the request cache. + /// + /// If true, clears the request cache. + /// /// [JsonIgnore] public bool? Request { get => Q("request"); set => Q("request", value); } } /// -/// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. +/// +/// Clears the caches of one or more indices. +/// For data streams, the API clears the caches of the stream’s backing indices. +/// /// public sealed partial class ClearCacheRequestDescriptor : RequestDescriptor, ClearCacheRequestParameters> { @@ -174,7 +218,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. +/// +/// Clears the caches of one or more indices. +/// For data streams, the API clears the caches of the stream’s backing indices. +/// /// public sealed partial class ClearCacheRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/CloseIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/CloseIndexRequest.g.cs index 6f6a974b22b..b2b1457b415 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/CloseIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/CloseIndexRequest.g.cs @@ -32,38 +32,59 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class CloseIndexRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// public Elastic.Clients.Elasticsearch.Serverless.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Closes an index. +/// +/// Closes an index. +/// /// public sealed partial class CloseIndexRequest : PlainRequest { @@ -80,44 +101,65 @@ public CloseIndexRequest(Elastic.Clients.Elasticsearch.Serverless.Indices indice internal override string OperationName => "indices.close"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Closes an index. +/// +/// Closes an index. +/// /// public sealed partial class CloseIndexRequestDescriptor : RequestDescriptor, CloseIndexRequestParameters> { @@ -158,7 +200,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Closes an index. +/// +/// Closes an index. +/// /// public sealed partial class CloseIndexRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/CreateDataStreamRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/CreateDataStreamRequest.g.cs index 607ed216a2e..5183e7d899e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/CreateDataStreamRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/CreateDataStreamRequest.g.cs @@ -31,10 +31,27 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class CreateDataStreamRequestParameters : RequestParameters { + /// + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// + public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } + + /// + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// + public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Create a data stream.
Creates a data stream.
You must have a matching index template with data stream enabled. +/// +/// Create a data stream. +/// Creates a data stream. +/// You must have a matching index template with data stream enabled. +/// /// public sealed partial class CreateDataStreamRequest : PlainRequest { @@ -49,10 +66,30 @@ public CreateDataStreamRequest(Elastic.Clients.Elasticsearch.Serverless.DataStre internal override bool SupportsBody => false; internal override string OperationName => "indices.create_data_stream"; + + /// + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } + + /// + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Create a data stream.
Creates a data stream.
You must have a matching index template with data stream enabled. +/// +/// Create a data stream. +/// Creates a data stream. +/// You must have a matching index template with data stream enabled. +/// /// public sealed partial class CreateDataStreamRequestDescriptor : RequestDescriptor { @@ -70,6 +107,9 @@ public CreateDataStreamRequestDescriptor(Elastic.Clients.Elasticsearch.Serverles internal override string OperationName => "indices.create_data_stream"; + public CreateDataStreamRequestDescriptor MasterTimeout(Elastic.Clients.Elasticsearch.Serverless.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); + public CreateDataStreamRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Serverless.Duration? timeout) => Qs("timeout", timeout); + public CreateDataStreamRequestDescriptor Name(Elastic.Clients.Elasticsearch.Serverless.DataStreamName name) { RouteValues.Required("name", name); diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/CreateDataStreamResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/CreateDataStreamResponse.g.cs index 27c278f250f..a52e895259d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/CreateDataStreamResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/CreateDataStreamResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class CreateDataStreamResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/CreateIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/CreateIndexRequest.g.cs index 1de2243d839..3cb5cfa008b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/CreateIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/CreateIndexRequest.g.cs @@ -32,23 +32,35 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class CreateIndexRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// public Elastic.Clients.Elasticsearch.Serverless.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Create an index.
Creates a new index. +/// +/// Create an index. +/// Creates a new index. +/// /// public sealed partial class CreateIndexRequest : PlainRequest { @@ -65,44 +77,79 @@ public CreateIndexRequest(Elastic.Clients.Elasticsearch.Serverless.IndexName ind internal override string OperationName => "indices.create"; /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } /// - /// Aliases for the index. + /// + /// Aliases for the index. + /// /// [JsonInclude, JsonPropertyName("aliases")] public IDictionary? Aliases { get; set; } /// - /// Mapping for fields in the index. If specified, this mapping can include:
- Field names
- Field data types
- Mapping parameters + /// + /// Mapping for fields in the index. If specified, this mapping can include: + /// + /// + /// + /// + /// Field names + /// + /// + /// + /// + /// Field data types + /// + /// + /// + /// + /// Mapping parameters + /// + /// + /// /// [JsonInclude, JsonPropertyName("mappings")] public Elastic.Clients.Elasticsearch.Serverless.Mapping.TypeMapping? Mappings { get; set; } /// - /// Configuration options for the index. + /// + /// Configuration options for the index. + /// /// [JsonInclude, JsonPropertyName("settings")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexSettings? Settings { get; set; } } /// -/// Create an index.
Creates a new index. +/// +/// Create an index. +/// Creates a new index. +/// /// public sealed partial class CreateIndexRequestDescriptor : RequestDescriptor, CreateIndexRequestParameters> { @@ -143,7 +190,9 @@ public CreateIndexRequestDescriptor Index(Elastic.Clients.Elasticsear private Action> SettingsDescriptorAction { get; set; } /// - /// Aliases for the index. + /// + /// Aliases for the index. + /// /// public CreateIndexRequestDescriptor Aliases(Func>, FluentDescriptorDictionary>> selector) { @@ -152,7 +201,26 @@ public CreateIndexRequestDescriptor Aliases(Func - /// Mapping for fields in the index. If specified, this mapping can include:
- Field names
- Field data types
- Mapping parameters + /// + /// Mapping for fields in the index. If specified, this mapping can include: + /// + /// + /// + /// + /// Field names + /// + /// + /// + /// + /// Field data types + /// + /// + /// + /// + /// Mapping parameters + /// + /// + /// /// public CreateIndexRequestDescriptor Mappings(Elastic.Clients.Elasticsearch.Serverless.Mapping.TypeMapping? mappings) { @@ -179,7 +247,9 @@ public CreateIndexRequestDescriptor Mappings(Action - /// Configuration options for the index. + /// + /// Configuration options for the index. + /// /// public CreateIndexRequestDescriptor Settings(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexSettings? settings) { @@ -251,7 +321,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Create an index.
Creates a new index. +/// +/// Create an index. +/// Creates a new index. +/// /// public sealed partial class CreateIndexRequestDescriptor : RequestDescriptor { @@ -288,7 +361,9 @@ public CreateIndexRequestDescriptor Index(Elastic.Clients.Elasticsearch.Serverle private Action SettingsDescriptorAction { get; set; } /// - /// Aliases for the index. + /// + /// Aliases for the index. + /// /// public CreateIndexRequestDescriptor Aliases(Func, FluentDescriptorDictionary> selector) { @@ -297,7 +372,26 @@ public CreateIndexRequestDescriptor Aliases(Func - /// Mapping for fields in the index. If specified, this mapping can include:
- Field names
- Field data types
- Mapping parameters + /// + /// Mapping for fields in the index. If specified, this mapping can include: + /// + /// + /// + /// + /// Field names + /// + /// + /// + /// + /// Field data types + /// + /// + /// + /// + /// Mapping parameters + /// + /// + /// /// public CreateIndexRequestDescriptor Mappings(Elastic.Clients.Elasticsearch.Serverless.Mapping.TypeMapping? mappings) { @@ -324,7 +418,9 @@ public CreateIndexRequestDescriptor Mappings(Action - /// Configuration options for the index. + /// + /// Configuration options for the index. + /// /// public CreateIndexRequestDescriptor Settings(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexSettings? settings) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DataStreamsStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DataStreamsStatsRequest.g.cs index 008c844030b..23ca7d0e743 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DataStreamsStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DataStreamsStatsRequest.g.cs @@ -32,13 +32,19 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class DataStreamsStatsRequestParameters : RequestParameters { /// - /// Type of data stream that wildcard patterns can match.
Supports comma-separated values, such as `open,hidden`. + /// + /// Type of data stream that wildcard patterns can match. + /// Supports comma-separated values, such as open,hidden. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } } /// -/// Get data stream stats.
Retrieves statistics for one or more data streams. +/// +/// Get data stream stats. +/// Retrieves statistics for one or more data streams. +/// /// public sealed partial class DataStreamsStatsRequest : PlainRequest { @@ -59,14 +65,20 @@ public DataStreamsStatsRequest(Elastic.Clients.Elasticsearch.Serverless.IndexNam internal override string OperationName => "indices.data_streams_stats"; /// - /// Type of data stream that wildcard patterns can match.
Supports comma-separated values, such as `open,hidden`. + /// + /// Type of data stream that wildcard patterns can match. + /// Supports comma-separated values, such as open,hidden. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } } /// -/// Get data stream stats.
Retrieves statistics for one or more data streams. +/// +/// Get data stream stats. +/// Retrieves statistics for one or more data streams. +/// /// public sealed partial class DataStreamsStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DataStreamsStatsResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DataStreamsStatsResponse.g.cs index babbfbe9a96..138befc6cfe 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DataStreamsStatsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DataStreamsStatsResponse.g.cs @@ -29,37 +29,50 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class DataStreamsStatsResponse : ElasticsearchResponse { /// - /// Total number of backing indices for the selected data streams. + /// + /// Total number of backing indices for the selected data streams. + /// /// [JsonInclude, JsonPropertyName("backing_indices")] public int BackingIndices { get; init; } /// - /// Total number of selected data streams. + /// + /// Total number of selected data streams. + /// /// [JsonInclude, JsonPropertyName("data_stream_count")] public int DataStreamCount { get; init; } /// - /// Contains statistics for the selected data streams. + /// + /// Contains statistics for the selected data streams. + /// /// [JsonInclude, JsonPropertyName("data_streams")] public IReadOnlyCollection DataStreams { get; init; } /// - /// Contains information about shards that attempted to execute the request. + /// + /// Contains information about shards that attempted to execute the request. + /// /// [JsonInclude, JsonPropertyName("_shards")] public Elastic.Clients.Elasticsearch.Serverless.ShardStatistics Shards { get; init; } /// - /// Total size, in bytes, of all shards for the selected data streams. + /// + /// Total size, in bytes, of all shards for the selected data streams. + /// /// [JsonInclude, JsonPropertyName("total_store_size_bytes")] public long TotalStoreSizeBytes { get; init; } /// - /// Total size of all shards for the selected data streams.
This property is included only if the `human` query parameter is `true` + /// + /// Total size of all shards for the selected data streams. + /// This property is included only if the human query parameter is true + /// /// [JsonInclude, JsonPropertyName("total_store_sizes")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? TotalStoreSizes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteAliasRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteAliasRequest.g.cs index d6fb2d6ea7f..79e974c5971 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteAliasRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteAliasRequest.g.cs @@ -32,18 +32,27 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class DeleteAliasRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete an alias.
Removes a data stream or index from an alias. +/// +/// Delete an alias. +/// Removes a data stream or index from an alias. +/// /// public sealed partial class DeleteAliasRequest : PlainRequest { @@ -60,20 +69,29 @@ public DeleteAliasRequest(Elastic.Clients.Elasticsearch.Serverless.Indices indic internal override string OperationName => "indices.delete_alias"; /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete an alias.
Removes a data stream or index from an alias. +/// +/// Delete an alias. +/// Removes a data stream or index from an alias. +/// /// public sealed partial class DeleteAliasRequestDescriptor : RequestDescriptor, DeleteAliasRequestParameters> { @@ -116,7 +134,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Delete an alias.
Removes a data stream or index from an alias. +/// +/// Delete an alias. +/// Removes a data stream or index from an alias. +/// /// public sealed partial class DeleteAliasRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteAliasResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteAliasResponse.g.cs index 6e9e71494a1..befb38314ab 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteAliasResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteAliasResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class DeleteAliasResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteDataLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteDataLifecycleRequest.g.cs index d5846d83d45..5c7353df9c6 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteDataLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteDataLifecycleRequest.g.cs @@ -32,23 +32,32 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class DeleteDataLifecycleRequestParameters : RequestParameters { /// - /// Whether wildcard expressions should get expanded to open or closed indices (default: open) + /// + /// Whether wildcard expressions should get expanded to open or closed indices (default: open) + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Specify timeout for connection to master + /// + /// Specify timeout for connection to master + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit timestamp for the document + /// + /// Explicit timestamp for the document + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete data stream lifecycles.
Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. +/// +/// Delete data stream lifecycles. +/// Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. +/// /// public sealed partial class DeleteDataLifecycleRequest : PlainRequest { @@ -65,26 +74,35 @@ public DeleteDataLifecycleRequest(Elastic.Clients.Elasticsearch.Serverless.DataS internal override string OperationName => "indices.delete_data_lifecycle"; /// - /// Whether wildcard expressions should get expanded to open or closed indices (default: open) + /// + /// Whether wildcard expressions should get expanded to open or closed indices (default: open) + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Specify timeout for connection to master + /// + /// Specify timeout for connection to master + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit timestamp for the document + /// + /// Explicit timestamp for the document + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete data stream lifecycles.
Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. +/// +/// Delete data stream lifecycles. +/// Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. +/// /// public sealed partial class DeleteDataLifecycleRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteDataLifecycleResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteDataLifecycleResponse.g.cs index 5ede64d0ba8..eae7ae00e1b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteDataLifecycleResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteDataLifecycleResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class DeleteDataLifecycleResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteDataStreamRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteDataStreamRequest.g.cs index 51a15edd8f7..e178b78aa84 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteDataStreamRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteDataStreamRequest.g.cs @@ -32,13 +32,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class DeleteDataStreamRequestParameters : RequestParameters { /// - /// Type of data stream that wildcard patterns can match. Supports comma-separated values,such as `open,hidden`. + /// + /// Type of data stream that wildcard patterns can match. Supports comma-separated values,such as open,hidden. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } + + /// + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// + public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Delete data streams.
Deletes one or more data streams and their backing indices. +/// +/// Delete data streams. +/// Deletes one or more data streams and their backing indices. +/// /// public sealed partial class DeleteDataStreamRequest : PlainRequest { @@ -55,14 +67,27 @@ public DeleteDataStreamRequest(Elastic.Clients.Elasticsearch.Serverless.DataStre internal override string OperationName => "indices.delete_data_stream"; /// - /// Type of data stream that wildcard patterns can match. Supports comma-separated values,such as `open,hidden`. + /// + /// Type of data stream that wildcard patterns can match. Supports comma-separated values,such as open,hidden. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } + + /// + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Delete data streams.
Deletes one or more data streams and their backing indices. +/// +/// Delete data streams. +/// Deletes one or more data streams and their backing indices. +/// /// public sealed partial class DeleteDataStreamRequestDescriptor : RequestDescriptor { @@ -81,6 +106,7 @@ public DeleteDataStreamRequestDescriptor(Elastic.Clients.Elasticsearch.Serverles internal override string OperationName => "indices.delete_data_stream"; public DeleteDataStreamRequestDescriptor ExpandWildcards(ICollection? expandWildcards) => Qs("expand_wildcards", expandWildcards); + public DeleteDataStreamRequestDescriptor MasterTimeout(Elastic.Clients.Elasticsearch.Serverless.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); public DeleteDataStreamRequestDescriptor Name(Elastic.Clients.Elasticsearch.Serverless.DataStreamNames name) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteDataStreamResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteDataStreamResponse.g.cs index bc97eed9dc1..74b889a2db1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteDataStreamResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteDataStreamResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class DeleteDataStreamResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteIndexRequest.g.cs index c5157858428..3e2f89fd832 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteIndexRequest.g.cs @@ -32,33 +32,52 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class DeleteIndexRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete indices.
Deletes one or more indices. +/// +/// Delete indices. +/// Deletes one or more indices. +/// /// public sealed partial class DeleteIndexRequest : PlainRequest { @@ -75,38 +94,57 @@ public DeleteIndexRequest(Elastic.Clients.Elasticsearch.Serverless.Indices indic internal override string OperationName => "indices.delete"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete indices.
Deletes one or more indices. +/// +/// Delete indices. +/// Deletes one or more indices. +/// /// public sealed partial class DeleteIndexRequestDescriptor : RequestDescriptor, DeleteIndexRequestParameters> { @@ -146,7 +184,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Delete indices.
Deletes one or more indices. +/// +/// Delete indices. +/// Deletes one or more indices. +/// /// public sealed partial class DeleteIndexRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteIndexResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteIndexResponse.g.cs index cc5024e04b2..b0aee2bc50b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteIndexResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteIndexResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class DeleteIndexResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteIndexTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteIndexTemplateRequest.g.cs index 80f171d1634..32f44bf2b47 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteIndexTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteIndexTemplateRequest.g.cs @@ -32,18 +32,27 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class DeleteIndexTemplateRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete an index template.
The provided may contain multiple template names separated by a comma. If multiple template
names are specified then there is no wildcard support and the provided names should match completely with
existing templates. +/// +/// Delete an index template. +/// The provided <index-template> may contain multiple template names separated by a comma. If multiple template +/// names are specified then there is no wildcard support and the provided names should match completely with +/// existing templates. +/// /// public sealed partial class DeleteIndexTemplateRequest : PlainRequest { @@ -60,20 +69,29 @@ public DeleteIndexTemplateRequest(Elastic.Clients.Elasticsearch.Serverless.Names internal override string OperationName => "indices.delete_index_template"; /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete an index template.
The provided may contain multiple template names separated by a comma. If multiple template
names are specified then there is no wildcard support and the provided names should match completely with
existing templates. +/// +/// Delete an index template. +/// The provided <index-template> may contain multiple template names separated by a comma. If multiple template +/// names are specified then there is no wildcard support and the provided names should match completely with +/// existing templates. +/// /// public sealed partial class DeleteIndexTemplateRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteIndexTemplateResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteIndexTemplateResponse.g.cs index 8703cab35dc..f90d768e4c0 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteIndexTemplateResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/DeleteIndexTemplateResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class DeleteIndexTemplateResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ExistsAliasRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ExistsAliasRequest.g.cs index f787c028cc2..a622fae0b98 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ExistsAliasRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ExistsAliasRequest.g.cs @@ -32,28 +32,43 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class ExistsAliasRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, requests that include a missing data stream or index in the target indices or data streams return an error. + /// + /// If false, requests that include a missing data stream or index in the target indices or data streams return an error. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, the request retrieves information from the local node only. + /// + /// If true, the request retrieves information from the local node only. + /// /// public bool? Local { get => Q("local"); set => Q("local", value); } } /// -/// Check aliases.
Checks if one or more data stream or index aliases exist. +/// +/// Check aliases. +/// Checks if one or more data stream or index aliases exist. +/// /// public sealed partial class ExistsAliasRequest : PlainRequest { @@ -74,32 +89,47 @@ public ExistsAliasRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? indi internal override string OperationName => "indices.exists_alias"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, requests that include a missing data stream or index in the target indices or data streams return an error. + /// + /// If false, requests that include a missing data stream or index in the target indices or data streams return an error. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, the request retrieves information from the local node only. + /// + /// If true, the request retrieves information from the local node only. + /// /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } } /// -/// Check aliases.
Checks if one or more data stream or index aliases exist. +/// +/// Check aliases. +/// Checks if one or more data stream or index aliases exist. +/// /// public sealed partial class ExistsAliasRequestDescriptor : RequestDescriptor, ExistsAliasRequestParameters> { @@ -144,7 +174,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Check aliases.
Checks if one or more data stream or index aliases exist. +/// +/// Check aliases. +/// Checks if one or more data stream or index aliases exist. +/// /// public sealed partial class ExistsAliasRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ExistsIndexTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ExistsIndexTemplateRequest.g.cs index edbbdaa0cc8..d7979515bbc 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ExistsIndexTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ExistsIndexTemplateRequest.g.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class ExistsIndexTemplateRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Returns information about whether a particular index template exists. +/// +/// Returns information about whether a particular index template exists. +/// /// public sealed partial class ExistsIndexTemplateRequest : PlainRequest { @@ -55,14 +59,18 @@ public ExistsIndexTemplateRequest(Elastic.Clients.Elasticsearch.Serverless.Name internal override string OperationName => "indices.exists_index_template"; /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Returns information about whether a particular index template exists. +/// +/// Returns information about whether a particular index template exists. +/// /// public sealed partial class ExistsIndexTemplateRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ExistsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ExistsRequest.g.cs index 23bcd2aa688..ff4cda826be 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ExistsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ExistsRequest.g.cs @@ -32,38 +32,57 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class ExistsRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, return all default settings in the response. + /// + /// If true, return all default settings in the response. + /// /// public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// If `true`, the request retrieves information from the local node only. + /// + /// If true, the request retrieves information from the local node only. + /// /// public bool? Local { get => Q("local"); set => Q("local", value); } } /// -/// Check indices.
Checks if one or more indices, index aliases, or data streams exist. +/// +/// Check indices. +/// Checks if one or more indices, index aliases, or data streams exist. +/// /// public sealed partial class ExistsRequest : PlainRequest { @@ -80,44 +99,63 @@ public ExistsRequest(Elastic.Clients.Elasticsearch.Serverless.Indices indices) : internal override string OperationName => "indices.exists"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// [JsonIgnore] public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, return all default settings in the response. + /// + /// If true, return all default settings in the response. + /// /// [JsonIgnore] public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// If `true`, the request retrieves information from the local node only. + /// + /// If true, the request retrieves information from the local node only. + /// /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } } /// -/// Check indices.
Checks if one or more indices, index aliases, or data streams exist. +/// +/// Check indices. +/// Checks if one or more indices, index aliases, or data streams exist. +/// /// public sealed partial class ExistsRequestDescriptor : RequestDescriptor, ExistsRequestParameters> { @@ -158,7 +196,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Check indices.
Checks if one or more indices, index aliases, or data streams exist. +/// +/// Check indices. +/// Checks if one or more indices, index aliases, or data streams exist. +/// /// public sealed partial class ExistsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ExplainDataLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ExplainDataLifecycleRequest.g.cs index ea3157d7aaa..9c6b9667348 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ExplainDataLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ExplainDataLifecycleRequest.g.cs @@ -32,18 +32,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class ExplainDataLifecycleRequestParameters : RequestParameters { /// - /// indicates if the API should return the default values the system uses for the index's lifecycle + /// + /// indicates if the API should return the default values the system uses for the index's lifecycle + /// /// public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// Specify timeout for connection to master + /// + /// Specify timeout for connection to master + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. +/// +/// Get the status for a data stream lifecycle. +/// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. +/// /// public sealed partial class ExplainDataLifecycleRequest : PlainRequest { @@ -60,20 +67,27 @@ public ExplainDataLifecycleRequest(Elastic.Clients.Elasticsearch.Serverless.Indi internal override string OperationName => "indices.explain_data_lifecycle"; /// - /// indicates if the API should return the default values the system uses for the index's lifecycle + /// + /// indicates if the API should return the default values the system uses for the index's lifecycle + /// /// [JsonIgnore] public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// Specify timeout for connection to master + /// + /// Specify timeout for connection to master + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. +/// +/// Get the status for a data stream lifecycle. +/// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. +/// /// public sealed partial class ExplainDataLifecycleRequestDescriptor : RequestDescriptor, ExplainDataLifecycleRequestParameters> { @@ -110,7 +124,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. +/// +/// Get the status for a data stream lifecycle. +/// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. +/// /// public sealed partial class ExplainDataLifecycleRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/FlushRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/FlushRequest.g.cs index fd5bad0326b..aa4e5d9d7da 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/FlushRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/FlushRequest.g.cs @@ -32,33 +32,50 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class FlushRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, the request forces a flush even if there are no changes to commit to the index. + /// + /// If true, the request forces a flush even if there are no changes to commit to the index. + /// /// public bool? Force { get => Q("force"); set => Q("force", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, the flush operation blocks until execution when another flush operation is running.
If `false`, Elasticsearch returns an error if you request a flush when another flush operation is running. + /// + /// If true, the flush operation blocks until execution when another flush operation is running. + /// If false, Elasticsearch returns an error if you request a flush when another flush operation is running. + /// /// public bool? WaitIfOngoing { get => Q("wait_if_ongoing"); set => Q("wait_if_ongoing", value); } } /// -/// Flushes one or more data streams or indices. +/// +/// Flushes one or more data streams or indices. +/// /// public sealed partial class FlushRequest : PlainRequest { @@ -79,38 +96,55 @@ public FlushRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? indices) : internal override string OperationName => "indices.flush"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, the request forces a flush even if there are no changes to commit to the index. + /// + /// If true, the request forces a flush even if there are no changes to commit to the index. + /// /// [JsonIgnore] public bool? Force { get => Q("force"); set => Q("force", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, the flush operation blocks until execution when another flush operation is running.
If `false`, Elasticsearch returns an error if you request a flush when another flush operation is running. + /// + /// If true, the flush operation blocks until execution when another flush operation is running. + /// If false, Elasticsearch returns an error if you request a flush when another flush operation is running. + /// /// [JsonIgnore] public bool? WaitIfOngoing { get => Q("wait_if_ongoing"); set => Q("wait_if_ongoing", value); } } /// -/// Flushes one or more data streams or indices. +/// +/// Flushes one or more data streams or indices. +/// /// public sealed partial class FlushRequestDescriptor : RequestDescriptor, FlushRequestParameters> { @@ -150,7 +184,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Flushes one or more data streams or indices. +/// +/// Flushes one or more data streams or indices. +/// /// public sealed partial class FlushRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ForcemergeRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ForcemergeRequest.g.cs index 8a03b2d3300..64f8ea4330c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ForcemergeRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ForcemergeRequest.g.cs @@ -32,43 +32,59 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class ForcemergeRequestParameters : RequestParameters { /// - /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + /// + /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified) + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// + /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Specify whether the index should be flushed after performing the operation (default: true) + /// + /// Specify whether the index should be flushed after performing the operation (default: true) + /// /// public bool? Flush { get => Q("flush"); set => Q("flush", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// + /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// The number of segments the index should be merged into (default: dynamic) + /// + /// The number of segments the index should be merged into (default: dynamic) + /// /// public long? MaxNumSegments { get => Q("max_num_segments"); set => Q("max_num_segments", value); } /// - /// Specify whether the operation should only expunge deleted documents + /// + /// Specify whether the operation should only expunge deleted documents + /// /// public bool? OnlyExpungeDeletes { get => Q("only_expunge_deletes"); set => Q("only_expunge_deletes", value); } /// - /// Should the request wait until the force merge is completed. + /// + /// Should the request wait until the force merge is completed. + /// /// public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Performs the force merge operation on one or more indices. +/// +/// Performs the force merge operation on one or more indices. +/// /// public sealed partial class ForcemergeRequest : PlainRequest { @@ -89,50 +105,66 @@ public ForcemergeRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? indic internal override string OperationName => "indices.forcemerge"; /// - /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + /// + /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified) + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// + /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Specify whether the index should be flushed after performing the operation (default: true) + /// + /// Specify whether the index should be flushed after performing the operation (default: true) + /// /// [JsonIgnore] public bool? Flush { get => Q("flush"); set => Q("flush", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// + /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// The number of segments the index should be merged into (default: dynamic) + /// + /// The number of segments the index should be merged into (default: dynamic) + /// /// [JsonIgnore] public long? MaxNumSegments { get => Q("max_num_segments"); set => Q("max_num_segments", value); } /// - /// Specify whether the operation should only expunge deleted documents + /// + /// Specify whether the operation should only expunge deleted documents + /// /// [JsonIgnore] public bool? OnlyExpungeDeletes { get => Q("only_expunge_deletes"); set => Q("only_expunge_deletes", value); } /// - /// Should the request wait until the force merge is completed. + /// + /// Should the request wait until the force merge is completed. + /// /// [JsonIgnore] public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Performs the force merge operation on one or more indices. +/// +/// Performs the force merge operation on one or more indices. +/// /// public sealed partial class ForcemergeRequestDescriptor : RequestDescriptor, ForcemergeRequestParameters> { @@ -174,7 +206,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Performs the force merge operation on one or more indices. +/// +/// Performs the force merge operation on one or more indices. +/// /// public sealed partial class ForcemergeRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ForcemergeResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ForcemergeResponse.g.cs index e1098739709..c2c25ee1c05 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ForcemergeResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ForcemergeResponse.g.cs @@ -32,7 +32,10 @@ public sealed partial class ForcemergeResponse : ElasticsearchResponse public Elastic.Clients.Elasticsearch.Serverless.ShardStatistics Shards { get; init; } /// - /// task contains a task id returned when wait_for_completion=false,
you can use the task_id to get the status of the task at _tasks/ + /// + /// task contains a task id returned when wait_for_completion=false, + /// you can use the task_id to get the status of the task at _tasks/<task_id> + /// /// [JsonInclude, JsonPropertyName("task")] public string? Task { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetAliasRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetAliasRequest.g.cs index e23d3e2db03..e9b58304329 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetAliasRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetAliasRequest.g.cs @@ -32,28 +32,43 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class GetAliasRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, the request retrieves information from the local node only. + /// + /// If true, the request retrieves information from the local node only. + /// /// public bool? Local { get => Q("local"); set => Q("local", value); } } /// -/// Get aliases.
Retrieves information for one or more data stream or index aliases. +/// +/// Get aliases. +/// Retrieves information for one or more data stream or index aliases. +/// /// public sealed partial class GetAliasRequest : PlainRequest { @@ -82,32 +97,47 @@ public GetAliasRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? indices internal override string OperationName => "indices.get_alias"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, the request retrieves information from the local node only. + /// + /// If true, the request retrieves information from the local node only. + /// /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } } /// -/// Get aliases.
Retrieves information for one or more data stream or index aliases. +/// +/// Get aliases. +/// Retrieves information for one or more data stream or index aliases. +/// /// public sealed partial class GetAliasRequestDescriptor : RequestDescriptor, GetAliasRequestParameters> { @@ -152,7 +182,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Get aliases.
Retrieves information for one or more data stream or index aliases. +/// +/// Get aliases. +/// Retrieves information for one or more data stream or index aliases. +/// /// public sealed partial class GetAliasRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetDataLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetDataLifecycleRequest.g.cs index f65a86c9bf9..c16e10b2327 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetDataLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetDataLifecycleRequest.g.cs @@ -32,18 +32,34 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class GetDataLifecycleRequestParameters : RequestParameters { /// - /// Type of data stream that wildcard patterns can match.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of data stream that wildcard patterns can match. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, return all default settings in the response. + /// + /// If true, return all default settings in the response. + /// /// public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } + + /// + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// + public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get data stream lifecycles.
Retrieves the data stream lifecycle configuration of one or more data streams. +/// +/// Get data stream lifecycles. +/// Retrieves the data stream lifecycle configuration of one or more data streams. +/// /// public sealed partial class GetDataLifecycleRequest : PlainRequest { @@ -60,20 +76,37 @@ public GetDataLifecycleRequest(Elastic.Clients.Elasticsearch.Serverless.DataStre internal override string OperationName => "indices.get_data_lifecycle"; /// - /// Type of data stream that wildcard patterns can match.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of data stream that wildcard patterns can match. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, return all default settings in the response. + /// + /// If true, return all default settings in the response. + /// /// [JsonIgnore] public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } + + /// + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get data stream lifecycles.
Retrieves the data stream lifecycle configuration of one or more data streams. +/// +/// Get data stream lifecycles. +/// Retrieves the data stream lifecycle configuration of one or more data streams. +/// /// public sealed partial class GetDataLifecycleRequestDescriptor : RequestDescriptor { @@ -93,6 +126,7 @@ public GetDataLifecycleRequestDescriptor(Elastic.Clients.Elasticsearch.Serverles public GetDataLifecycleRequestDescriptor ExpandWildcards(ICollection? expandWildcards) => Qs("expand_wildcards", expandWildcards); public GetDataLifecycleRequestDescriptor IncludeDefaults(bool? includeDefaults = true) => Qs("include_defaults", includeDefaults); + public GetDataLifecycleRequestDescriptor MasterTimeout(Elastic.Clients.Elasticsearch.Serverless.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); public GetDataLifecycleRequestDescriptor Name(Elastic.Clients.Elasticsearch.Serverless.DataStreamNames name) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetDataStreamRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetDataStreamRequest.g.cs index a3a475b6fb0..3a26e483e8b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetDataStreamRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetDataStreamRequest.g.cs @@ -32,18 +32,33 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class GetDataStreamRequestParameters : RequestParameters { /// - /// Type of data stream that wildcard patterns can match.
Supports comma-separated values, such as `open,hidden`. + /// + /// Type of data stream that wildcard patterns can match. + /// Supports comma-separated values, such as open,hidden. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If true, returns all relevant default configurations for the index template. + /// + /// If true, returns all relevant default configurations for the index template. + /// /// public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } + + /// + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// + public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get data streams.
Retrieves information about one or more data streams. +/// +/// Get data streams. +/// Retrieves information about one or more data streams. +/// /// public sealed partial class GetDataStreamRequest : PlainRequest { @@ -64,20 +79,36 @@ public GetDataStreamRequest(Elastic.Clients.Elasticsearch.Serverless.DataStreamN internal override string OperationName => "indices.get_data_stream"; /// - /// Type of data stream that wildcard patterns can match.
Supports comma-separated values, such as `open,hidden`. + /// + /// Type of data stream that wildcard patterns can match. + /// Supports comma-separated values, such as open,hidden. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If true, returns all relevant default configurations for the index template. + /// + /// If true, returns all relevant default configurations for the index template. + /// /// [JsonIgnore] public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } + + /// + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get data streams.
Retrieves information about one or more data streams. +/// +/// Get data streams. +/// Retrieves information about one or more data streams. +/// /// public sealed partial class GetDataStreamRequestDescriptor : RequestDescriptor { @@ -101,6 +132,7 @@ public GetDataStreamRequestDescriptor() public GetDataStreamRequestDescriptor ExpandWildcards(ICollection? expandWildcards) => Qs("expand_wildcards", expandWildcards); public GetDataStreamRequestDescriptor IncludeDefaults(bool? includeDefaults = true) => Qs("include_defaults", includeDefaults); + public GetDataStreamRequestDescriptor MasterTimeout(Elastic.Clients.Elasticsearch.Serverless.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); public GetDataStreamRequestDescriptor Name(Elastic.Clients.Elasticsearch.Serverless.DataStreamNames? name) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetIndexRequest.g.cs index c677a8a7692..42c8a75f74d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetIndexRequest.g.cs @@ -32,48 +32,72 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class GetIndexRequestParameters : RequestParameters { /// - /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only
missing or closed indices. This behavior applies even if the request targets other open indices. For example,
a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only + /// missing or closed indices. This behavior applies even if the request targets other open indices. For example, + /// a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard expressions can match. If the request can target data streams, this argument
determines whether wildcard expressions match hidden data streams. Supports comma-separated values,
such as open,hidden. + /// + /// Type of index that wildcard expressions can match. If the request can target data streams, this argument + /// determines whether wildcard expressions match hidden data streams. Supports comma-separated values, + /// such as open,hidden. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Return only information on specified index features + /// + /// Return only information on specified index features + /// /// public ICollection? Features { get => Q?>("features"); set => Q("features", value); } /// - /// If true, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// If false, requests that target a missing index return an error. + /// + /// If false, requests that target a missing index return an error. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If true, return all default settings in the response. + /// + /// If true, return all default settings in the response. + /// /// public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + /// + /// If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + /// /// public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. +/// +/// Get index information. +/// Returns information about one or more indices. For data streams, the API returns information about the +/// stream’s backing indices. +/// /// public sealed partial class GetIndexRequest : PlainRequest { @@ -90,56 +114,80 @@ public GetIndexRequest(Elastic.Clients.Elasticsearch.Serverless.Indices indices) internal override string OperationName => "indices.get"; /// - /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only
missing or closed indices. This behavior applies even if the request targets other open indices. For example,
a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only + /// missing or closed indices. This behavior applies even if the request targets other open indices. For example, + /// a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard expressions can match. If the request can target data streams, this argument
determines whether wildcard expressions match hidden data streams. Supports comma-separated values,
such as open,hidden. + /// + /// Type of index that wildcard expressions can match. If the request can target data streams, this argument + /// determines whether wildcard expressions match hidden data streams. Supports comma-separated values, + /// such as open,hidden. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Return only information on specified index features + /// + /// Return only information on specified index features + /// /// [JsonIgnore] public ICollection? Features { get => Q?>("features"); set => Q("features", value); } /// - /// If true, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// [JsonIgnore] public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// If false, requests that target a missing index return an error. + /// + /// If false, requests that target a missing index return an error. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If true, return all default settings in the response. + /// + /// If true, return all default settings in the response. + /// /// [JsonIgnore] public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + /// + /// If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + /// /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. +/// +/// Get index information. +/// Returns information about one or more indices. For data streams, the API returns information about the +/// stream’s backing indices. +/// /// public sealed partial class GetIndexRequestDescriptor : RequestDescriptor, GetIndexRequestParameters> { @@ -182,7 +230,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. +/// +/// Get index information. +/// Returns information about one or more indices. For data streams, the API returns information about the +/// stream’s backing indices. +/// /// public sealed partial class GetIndexRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetIndexTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetIndexTemplateRequest.g.cs index d30ca99d99a..134c2334a9a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetIndexTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetIndexTemplateRequest.g.cs @@ -32,28 +32,39 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class GetIndexTemplateRequestParameters : RequestParameters { /// - /// If true, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// If true, returns all relevant default configurations for the index template. + /// + /// If true, returns all relevant default configurations for the index template. + /// /// public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + /// + /// If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + /// /// public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get index templates.
Returns information about one or more index templates. +/// +/// Get index templates. +/// Returns information about one or more index templates. +/// /// public sealed partial class GetIndexTemplateRequest : PlainRequest { @@ -74,32 +85,43 @@ public GetIndexTemplateRequest(Elastic.Clients.Elasticsearch.Serverless.Name? na internal override string OperationName => "indices.get_index_template"; /// - /// If true, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// [JsonIgnore] public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// If true, returns all relevant default configurations for the index template. + /// + /// If true, returns all relevant default configurations for the index template. + /// /// [JsonIgnore] public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + /// + /// If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + /// /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get index templates.
Returns information about one or more index templates. +/// +/// Get index templates. +/// Returns information about one or more index templates. +/// /// public sealed partial class GetIndexTemplateRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetIndicesSettingsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetIndicesSettingsRequest.g.cs index f28e0273e20..e1453114ad2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetIndicesSettingsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetIndicesSettingsRequest.g.cs @@ -32,43 +32,70 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class GetIndicesSettingsRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index
alias, or `_all` value targets only missing or closed indices. This
behavior applies even if the request targets other open indices. For
example, a request targeting `foo*,bar*` returns an error if an index
starts with foo but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index + /// alias, or _all value targets only missing or closed indices. This + /// behavior applies even if the request targets other open indices. For + /// example, a request targeting foo*,bar* returns an error if an index + /// starts with foo but no index starts with bar. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, return all default settings in the response. + /// + /// If true, return all default settings in the response. + /// /// public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// If `true`, the request retrieves information from the local node only. If
`false`, information is retrieved from the master node. + /// + /// If true, the request retrieves information from the local node only. If + /// false, information is retrieved from the master node. + /// /// public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node. If no response is
received before the timeout expires, the request fails and returns an
error. + /// + /// Period to wait for a connection to the master node. If no response is + /// received before the timeout expires, the request fails and returns an + /// error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. +/// +/// Get index settings. +/// Returns setting information for one or more indices. For data streams, +/// returns setting information for the stream’s backing indices. +/// /// public sealed partial class GetIndicesSettingsRequest : PlainRequest { @@ -97,50 +124,77 @@ public GetIndicesSettingsRequest(Elastic.Clients.Elasticsearch.Serverless.Names? internal override string OperationName => "indices.get_settings"; /// - /// If `false`, the request returns an error if any wildcard expression, index
alias, or `_all` value targets only missing or closed indices. This
behavior applies even if the request targets other open indices. For
example, a request targeting `foo*,bar*` returns an error if an index
starts with foo but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index + /// alias, or _all value targets only missing or closed indices. This + /// behavior applies even if the request targets other open indices. For + /// example, a request targeting foo*,bar* returns an error if an index + /// starts with foo but no index starts with bar. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// [JsonIgnore] public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, return all default settings in the response. + /// + /// If true, return all default settings in the response. + /// /// [JsonIgnore] public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// If `true`, the request retrieves information from the local node only. If
`false`, information is retrieved from the master node. + /// + /// If true, the request retrieves information from the local node only. If + /// false, information is retrieved from the master node. + /// /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node. If no response is
received before the timeout expires, the request fails and returns an
error. + /// + /// Period to wait for a connection to the master node. If no response is + /// received before the timeout expires, the request fails and returns an + /// error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. +/// +/// Get index settings. +/// Returns setting information for one or more indices. For data streams, +/// returns setting information for the stream’s backing indices. +/// /// public sealed partial class GetIndicesSettingsRequestDescriptor : RequestDescriptor, GetIndicesSettingsRequestParameters> { @@ -188,7 +242,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. +/// +/// Get index settings. +/// Returns setting information for one or more indices. For data streams, +/// returns setting information for the stream’s backing indices. +/// /// public sealed partial class GetIndicesSettingsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetMappingRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetMappingRequest.g.cs index 9fd5421f9c1..11da64b673d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetMappingRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetMappingRequest.g.cs @@ -32,33 +32,52 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class GetMappingRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, the request retrieves information from the local node only. + /// + /// If true, the request retrieves information from the local node only. + /// /// public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. +/// +/// Get mapping definitions. +/// Retrieves mapping definitions for one or more indices. +/// For data streams, the API retrieves mappings for the stream’s backing indices. +/// /// public sealed partial class GetMappingRequest : PlainRequest { @@ -79,38 +98,57 @@ public GetMappingRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? indic internal override string OperationName => "indices.get_mapping"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, the request retrieves information from the local node only. + /// + /// If true, the request retrieves information from the local node only. + /// /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. +/// +/// Get mapping definitions. +/// Retrieves mapping definitions for one or more indices. +/// For data streams, the API retrieves mappings for the stream’s backing indices. +/// /// public sealed partial class GetMappingRequestDescriptor : RequestDescriptor, GetMappingRequestParameters> { @@ -150,7 +188,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. +/// +/// Get mapping definitions. +/// Retrieves mapping definitions for one or more indices. +/// For data streams, the API retrieves mappings for the stream’s backing indices. +/// /// public sealed partial class GetMappingRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/IndicesStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/IndicesStatsRequest.g.cs index 1f5b8b33c89..9ad8458a9a6 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/IndicesStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/IndicesStatsRequest.g.cs @@ -32,53 +32,76 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class IndicesStatsRequestParameters : RequestParameters { /// - /// Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + /// + /// Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? CompletionFields { get => Q("completion_fields"); set => Q("completion_fields", value); } /// - /// Type of index that wildcard patterns can match. If the request can target data streams, this argument
determines whether wildcard expressions match hidden data streams. Supports comma-separated values,
such as `open,hidden`. + /// + /// Type of index that wildcard patterns can match. If the request can target data streams, this argument + /// determines whether wildcard expressions match hidden data streams. Supports comma-separated values, + /// such as open,hidden. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + /// + /// Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? FielddataFields { get => Q("fielddata_fields"); set => Q("fielddata_fields", value); } /// - /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// + /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? Fields { get => Q("fields"); set => Q("fields", value); } /// - /// If true, statistics are not collected from closed indices. + /// + /// If true, statistics are not collected from closed indices. + /// /// public bool? ForbidClosedIndices { get => Q("forbid_closed_indices"); set => Q("forbid_closed_indices", value); } /// - /// Comma-separated list of search groups to include in the search statistics. + /// + /// Comma-separated list of search groups to include in the search statistics. + /// /// public ICollection? Groups { get => Q?>("groups"); set => Q("groups", value); } /// - /// If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + /// + /// If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + /// /// public bool? IncludeSegmentFileSizes { get => Q("include_segment_file_sizes"); set => Q("include_segment_file_sizes", value); } /// - /// If true, the response includes information from segments that are not loaded into memory. + /// + /// If true, the response includes information from segments that are not loaded into memory. + /// /// public bool? IncludeUnloadedSegments { get => Q("include_unloaded_segments"); set => Q("include_unloaded_segments", value); } /// - /// Indicates whether statistics are aggregated at the cluster, index, or shard level. + /// + /// Indicates whether statistics are aggregated at the cluster, index, or shard level. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Level? Level { get => Q("level"); set => Q("level", value); } } /// -/// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. +/// +/// Returns statistics for one or more indices. +/// For data streams, the API retrieves statistics for the stream’s backing indices. +/// /// public sealed partial class IndicesStatsRequest : PlainRequest { @@ -107,62 +130,85 @@ public IndicesStatsRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? ind internal override string OperationName => "indices.stats"; /// - /// Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + /// + /// Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? CompletionFields { get => Q("completion_fields"); set => Q("completion_fields", value); } /// - /// Type of index that wildcard patterns can match. If the request can target data streams, this argument
determines whether wildcard expressions match hidden data streams. Supports comma-separated values,
such as `open,hidden`. + /// + /// Type of index that wildcard patterns can match. If the request can target data streams, this argument + /// determines whether wildcard expressions match hidden data streams. Supports comma-separated values, + /// such as open,hidden. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + /// + /// Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? FielddataFields { get => Q("fielddata_fields"); set => Q("fielddata_fields", value); } /// - /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// + /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? Fields { get => Q("fields"); set => Q("fields", value); } /// - /// If true, statistics are not collected from closed indices. + /// + /// If true, statistics are not collected from closed indices. + /// /// [JsonIgnore] public bool? ForbidClosedIndices { get => Q("forbid_closed_indices"); set => Q("forbid_closed_indices", value); } /// - /// Comma-separated list of search groups to include in the search statistics. + /// + /// Comma-separated list of search groups to include in the search statistics. + /// /// [JsonIgnore] public ICollection? Groups { get => Q?>("groups"); set => Q("groups", value); } /// - /// If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + /// + /// If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + /// /// [JsonIgnore] public bool? IncludeSegmentFileSizes { get => Q("include_segment_file_sizes"); set => Q("include_segment_file_sizes", value); } /// - /// If true, the response includes information from segments that are not loaded into memory. + /// + /// If true, the response includes information from segments that are not loaded into memory. + /// /// [JsonIgnore] public bool? IncludeUnloadedSegments { get => Q("include_unloaded_segments"); set => Q("include_unloaded_segments", value); } /// - /// Indicates whether statistics are aggregated at the cluster, index, or shard level. + /// + /// Indicates whether statistics are aggregated at the cluster, index, or shard level. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Level? Level { get => Q("level"); set => Q("level", value); } } /// -/// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. +/// +/// Returns statistics for one or more indices. +/// For data streams, the API retrieves statistics for the stream’s backing indices. +/// /// public sealed partial class IndicesStatsRequestDescriptor : RequestDescriptor, IndicesStatsRequestParameters> { @@ -212,7 +258,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. +/// +/// Returns statistics for one or more indices. +/// For data streams, the API retrieves statistics for the stream’s backing indices. +/// /// public sealed partial class IndicesStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/MigrateToDataStreamRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/MigrateToDataStreamRequest.g.cs index e526110034e..c492fe65fb7 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/MigrateToDataStreamRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/MigrateToDataStreamRequest.g.cs @@ -31,10 +31,35 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class MigrateToDataStreamRequestParameters : RequestParameters { + /// + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// + public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } + + /// + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// + public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Convert an index alias to a data stream.
Converts an index alias to a data stream.
You must have a matching index template that is data stream enabled.
The alias must meet the following criteria:
The alias must have a write index;
All indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;
The alias must not have any filters;
The alias must not use custom routing.
If successful, the request removes the alias and creates a data stream with the same name.
The indices for the alias become hidden backing indices for the stream.
The write index for the alias becomes the write index for the stream. +/// +/// Convert an index alias to a data stream. +/// Converts an index alias to a data stream. +/// You must have a matching index template that is data stream enabled. +/// The alias must meet the following criteria: +/// The alias must have a write index; +/// All indices for the alias must have a @timestamp field mapping of a date or date_nanos field type; +/// The alias must not have any filters; +/// The alias must not use custom routing. +/// If successful, the request removes the alias and creates a data stream with the same name. +/// The indices for the alias become hidden backing indices for the stream. +/// The write index for the alias becomes the write index for the stream. +/// /// public sealed partial class MigrateToDataStreamRequest : PlainRequest { @@ -49,10 +74,38 @@ public MigrateToDataStreamRequest(Elastic.Clients.Elasticsearch.Serverless.Index internal override bool SupportsBody => false; internal override string OperationName => "indices.migrate_to_data_stream"; + + /// + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } + + /// + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Convert an index alias to a data stream.
Converts an index alias to a data stream.
You must have a matching index template that is data stream enabled.
The alias must meet the following criteria:
The alias must have a write index;
All indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;
The alias must not have any filters;
The alias must not use custom routing.
If successful, the request removes the alias and creates a data stream with the same name.
The indices for the alias become hidden backing indices for the stream.
The write index for the alias becomes the write index for the stream. +/// +/// Convert an index alias to a data stream. +/// Converts an index alias to a data stream. +/// You must have a matching index template that is data stream enabled. +/// The alias must meet the following criteria: +/// The alias must have a write index; +/// All indices for the alias must have a @timestamp field mapping of a date or date_nanos field type; +/// The alias must not have any filters; +/// The alias must not use custom routing. +/// If successful, the request removes the alias and creates a data stream with the same name. +/// The indices for the alias become hidden backing indices for the stream. +/// The write index for the alias becomes the write index for the stream. +/// /// public sealed partial class MigrateToDataStreamRequestDescriptor : RequestDescriptor { @@ -70,6 +123,9 @@ public MigrateToDataStreamRequestDescriptor(Elastic.Clients.Elasticsearch.Server internal override string OperationName => "indices.migrate_to_data_stream"; + public MigrateToDataStreamRequestDescriptor MasterTimeout(Elastic.Clients.Elasticsearch.Serverless.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); + public MigrateToDataStreamRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Serverless.Duration? timeout) => Qs("timeout", timeout); + public MigrateToDataStreamRequestDescriptor Name(Elastic.Clients.Elasticsearch.Serverless.IndexName name) { RouteValues.Required("name", name); diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/MigrateToDataStreamResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/MigrateToDataStreamResponse.g.cs index 57a8369d5d9..5e5077e08bd 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/MigrateToDataStreamResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/MigrateToDataStreamResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class MigrateToDataStreamResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ModifyDataStreamRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ModifyDataStreamRequest.g.cs index b4ff90d55a1..1145204f2c7 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ModifyDataStreamRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ModifyDataStreamRequest.g.cs @@ -34,7 +34,10 @@ public sealed partial class ModifyDataStreamRequestParameters : RequestParameter } /// -/// Update data streams.
Performs one or more data stream modification actions in a single atomic operation. +/// +/// Update data streams. +/// Performs one or more data stream modification actions in a single atomic operation. +/// /// public sealed partial class ModifyDataStreamRequest : PlainRequest { @@ -47,14 +50,19 @@ public sealed partial class ModifyDataStreamRequest : PlainRequest "indices.modify_data_stream"; /// - /// Actions to perform. + /// + /// Actions to perform. + /// /// [JsonInclude, JsonPropertyName("actions")] public ICollection Actions { get; set; } } /// -/// Update data streams.
Performs one or more data stream modification actions in a single atomic operation. +/// +/// Update data streams. +/// Performs one or more data stream modification actions in a single atomic operation. +/// /// public sealed partial class ModifyDataStreamRequestDescriptor : RequestDescriptor { @@ -78,7 +86,9 @@ public ModifyDataStreamRequestDescriptor() private Action[] ActionsDescriptorActions { get; set; } /// - /// Actions to perform. + /// + /// Actions to perform. + /// /// public ModifyDataStreamRequestDescriptor Actions(ICollection actions) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ModifyDataStreamResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ModifyDataStreamResponse.g.cs index 0e06a1f331a..70e5ef0f6a2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ModifyDataStreamResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ModifyDataStreamResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class ModifyDataStreamResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/OpenIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/OpenIndexRequest.g.cs index b01a01fb481..ac21682f415 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/OpenIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/OpenIndexRequest.g.cs @@ -32,38 +32,60 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class OpenIndexRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// public Elastic.Clients.Elasticsearch.Serverless.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Opens a closed index.
For data streams, the API opens any closed backing indices. +/// +/// Opens a closed index. +/// For data streams, the API opens any closed backing indices. +/// /// public sealed partial class OpenIndexRequest : PlainRequest { @@ -80,44 +102,66 @@ public OpenIndexRequest(Elastic.Clients.Elasticsearch.Serverless.Indices indices internal override string OperationName => "indices.open"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Opens a closed index.
For data streams, the API opens any closed backing indices. +/// +/// Opens a closed index. +/// For data streams, the API opens any closed backing indices. +/// /// public sealed partial class OpenIndexRequestDescriptor : RequestDescriptor, OpenIndexRequestParameters> { @@ -158,7 +202,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Opens a closed index.
For data streams, the API opens any closed backing indices. +/// +/// Opens a closed index. +/// For data streams, the API opens any closed backing indices. +/// /// public sealed partial class OpenIndexRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutAliasRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutAliasRequest.g.cs index c44ec7b217b..36431fcb415 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutAliasRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutAliasRequest.g.cs @@ -32,18 +32,27 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class PutAliasRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Create or update an alias.
Adds a data stream or index to an alias. +/// +/// Create or update an alias. +/// Adds a data stream or index to an alias. +/// /// public sealed partial class PutAliasRequest : PlainRequest { @@ -60,50 +69,77 @@ public PutAliasRequest(Elastic.Clients.Elasticsearch.Serverless.Indices indices, internal override string OperationName => "indices.put_alias"; /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Query used to limit documents the alias can access. + /// + /// Query used to limit documents the alias can access. + /// /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? Filter { get; set; } /// - /// Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations.
Data stream aliases don’t support this parameter. + /// + /// Value used to route indexing operations to a specific shard. + /// If specified, this overwrites the routing value for indexing operations. + /// Data stream aliases don’t support this parameter. + /// /// [JsonInclude, JsonPropertyName("index_routing")] public Elastic.Clients.Elasticsearch.Serverless.Routing? IndexRouting { get; set; } /// - /// If `true`, sets the write index or data stream for the alias.
If an alias points to multiple indices or data streams and `is_write_index` isn’t set, the alias rejects write requests.
If an index alias points to one index and `is_write_index` isn’t set, the index automatically acts as the write index.
Data stream aliases don’t automatically set a write data stream, even if the alias points to one data stream. + /// + /// If true, sets the write index or data stream for the alias. + /// If an alias points to multiple indices or data streams and is_write_index isn’t set, the alias rejects write requests. + /// If an index alias points to one index and is_write_index isn’t set, the index automatically acts as the write index. + /// Data stream aliases don’t automatically set a write data stream, even if the alias points to one data stream. + /// /// [JsonInclude, JsonPropertyName("is_write_index")] public bool? IsWriteIndex { get; set; } /// - /// Value used to route indexing and search operations to a specific shard.
Data stream aliases don’t support this parameter. + /// + /// Value used to route indexing and search operations to a specific shard. + /// Data stream aliases don’t support this parameter. + /// /// [JsonInclude, JsonPropertyName("routing")] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get; set; } /// - /// Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations.
Data stream aliases don’t support this parameter. + /// + /// Value used to route search operations to a specific shard. + /// If specified, this overwrites the routing value for search operations. + /// Data stream aliases don’t support this parameter. + /// /// [JsonInclude, JsonPropertyName("search_routing")] public Elastic.Clients.Elasticsearch.Serverless.Routing? SearchRouting { get; set; } } /// -/// Create or update an alias.
Adds a data stream or index to an alias. +/// +/// Create or update an alias. +/// Adds a data stream or index to an alias. +/// /// public sealed partial class PutAliasRequestDescriptor : RequestDescriptor, PutAliasRequestParameters> { @@ -149,7 +185,9 @@ public PutAliasRequestDescriptor Name(Elastic.Clients.Elasticsearch.S private Elastic.Clients.Elasticsearch.Serverless.Routing? SearchRoutingValue { get; set; } /// - /// Query used to limit documents the alias can access. + /// + /// Query used to limit documents the alias can access. + /// /// public PutAliasRequestDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? filter) { @@ -176,7 +214,11 @@ public PutAliasRequestDescriptor Filter(Action - /// Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations.
Data stream aliases don’t support this parameter. + /// + /// Value used to route indexing operations to a specific shard. + /// If specified, this overwrites the routing value for indexing operations. + /// Data stream aliases don’t support this parameter. + /// /// public PutAliasRequestDescriptor IndexRouting(Elastic.Clients.Elasticsearch.Serverless.Routing? indexRouting) { @@ -185,7 +227,12 @@ public PutAliasRequestDescriptor IndexRouting(Elastic.Clients.Elastic } /// - /// If `true`, sets the write index or data stream for the alias.
If an alias points to multiple indices or data streams and `is_write_index` isn’t set, the alias rejects write requests.
If an index alias points to one index and `is_write_index` isn’t set, the index automatically acts as the write index.
Data stream aliases don’t automatically set a write data stream, even if the alias points to one data stream. + /// + /// If true, sets the write index or data stream for the alias. + /// If an alias points to multiple indices or data streams and is_write_index isn’t set, the alias rejects write requests. + /// If an index alias points to one index and is_write_index isn’t set, the index automatically acts as the write index. + /// Data stream aliases don’t automatically set a write data stream, even if the alias points to one data stream. + /// /// public PutAliasRequestDescriptor IsWriteIndex(bool? isWriteIndex = true) { @@ -194,7 +241,10 @@ public PutAliasRequestDescriptor IsWriteIndex(bool? isWriteIndex = tr } /// - /// Value used to route indexing and search operations to a specific shard.
Data stream aliases don’t support this parameter. + /// + /// Value used to route indexing and search operations to a specific shard. + /// Data stream aliases don’t support this parameter. + /// /// public PutAliasRequestDescriptor Routing(Elastic.Clients.Elasticsearch.Serverless.Routing? routing) { @@ -203,7 +253,11 @@ public PutAliasRequestDescriptor Routing(Elastic.Clients.Elasticsearc } /// - /// Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations.
Data stream aliases don’t support this parameter. + /// + /// Value used to route search operations to a specific shard. + /// If specified, this overwrites the routing value for search operations. + /// Data stream aliases don’t support this parameter. + /// /// public PutAliasRequestDescriptor SearchRouting(Elastic.Clients.Elasticsearch.Serverless.Routing? searchRouting) { @@ -259,7 +313,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Create or update an alias.
Adds a data stream or index to an alias. +/// +/// Create or update an alias. +/// Adds a data stream or index to an alias. +/// /// public sealed partial class PutAliasRequestDescriptor : RequestDescriptor { @@ -301,7 +358,9 @@ public PutAliasRequestDescriptor Name(Elastic.Clients.Elasticsearch.Serverless.N private Elastic.Clients.Elasticsearch.Serverless.Routing? SearchRoutingValue { get; set; } /// - /// Query used to limit documents the alias can access. + /// + /// Query used to limit documents the alias can access. + /// /// public PutAliasRequestDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? filter) { @@ -328,7 +387,11 @@ public PutAliasRequestDescriptor Filter(Action - /// Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations.
Data stream aliases don’t support this parameter. + /// + /// Value used to route indexing operations to a specific shard. + /// If specified, this overwrites the routing value for indexing operations. + /// Data stream aliases don’t support this parameter. + /// /// public PutAliasRequestDescriptor IndexRouting(Elastic.Clients.Elasticsearch.Serverless.Routing? indexRouting) { @@ -337,7 +400,12 @@ public PutAliasRequestDescriptor IndexRouting(Elastic.Clients.Elasticsearch.Serv } /// - /// If `true`, sets the write index or data stream for the alias.
If an alias points to multiple indices or data streams and `is_write_index` isn’t set, the alias rejects write requests.
If an index alias points to one index and `is_write_index` isn’t set, the index automatically acts as the write index.
Data stream aliases don’t automatically set a write data stream, even if the alias points to one data stream. + /// + /// If true, sets the write index or data stream for the alias. + /// If an alias points to multiple indices or data streams and is_write_index isn’t set, the alias rejects write requests. + /// If an index alias points to one index and is_write_index isn’t set, the index automatically acts as the write index. + /// Data stream aliases don’t automatically set a write data stream, even if the alias points to one data stream. + /// /// public PutAliasRequestDescriptor IsWriteIndex(bool? isWriteIndex = true) { @@ -346,7 +414,10 @@ public PutAliasRequestDescriptor IsWriteIndex(bool? isWriteIndex = true) } /// - /// Value used to route indexing and search operations to a specific shard.
Data stream aliases don’t support this parameter. + /// + /// Value used to route indexing and search operations to a specific shard. + /// Data stream aliases don’t support this parameter. + /// /// public PutAliasRequestDescriptor Routing(Elastic.Clients.Elasticsearch.Serverless.Routing? routing) { @@ -355,7 +426,11 @@ public PutAliasRequestDescriptor Routing(Elastic.Clients.Elasticsearch.Serverles } /// - /// Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations.
Data stream aliases don’t support this parameter. + /// + /// Value used to route search operations to a specific shard. + /// If specified, this overwrites the routing value for search operations. + /// Data stream aliases don’t support this parameter. + /// /// public PutAliasRequestDescriptor SearchRouting(Elastic.Clients.Elasticsearch.Serverless.Routing? searchRouting) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutAliasResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutAliasResponse.g.cs index f34988a0278..f22ac858682 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutAliasResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutAliasResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class PutAliasResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutDataLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutDataLifecycleRequest.g.cs index fc9cb489b30..439d6377046 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutDataLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutDataLifecycleRequest.g.cs @@ -32,23 +32,37 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class PutDataLifecycleRequestParameters : RequestParameters { /// - /// Type of data stream that wildcard patterns can match.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `hidden`, `open`, `closed`, `none`. + /// + /// Type of data stream that wildcard patterns can match. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, hidden, open, closed, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Period to wait for a connection to the master node. If no response is
received before the timeout expires, the request fails and returns an
error. + /// + /// Period to wait for a connection to the master node. If no response is + /// received before the timeout expires, the request fails and returns an + /// error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Update data stream lifecycles.
Update the data stream lifecycle of the specified data streams. +/// +/// Update data stream lifecycles. +/// Update the data stream lifecycle of the specified data streams. +/// /// public sealed partial class PutDataLifecycleRequest : PlainRequest { @@ -65,38 +79,59 @@ public PutDataLifecycleRequest(Elastic.Clients.Elasticsearch.Serverless.DataStre internal override string OperationName => "indices.put_data_lifecycle"; /// - /// Type of data stream that wildcard patterns can match.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `hidden`, `open`, `closed`, `none`. + /// + /// Type of data stream that wildcard patterns can match. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, hidden, open, closed, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Period to wait for a connection to the master node. If no response is
received before the timeout expires, the request fails and returns an
error. + /// + /// Period to wait for a connection to the master node. If no response is + /// received before the timeout expires, the request fails and returns an + /// error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// If defined, every document added to this data stream will be stored at least for this time frame.
Any time after this duration the document could be deleted.
When empty, every document in this data stream will be stored indefinitely. + /// + /// If defined, every document added to this data stream will be stored at least for this time frame. + /// Any time after this duration the document could be deleted. + /// When empty, every document in this data stream will be stored indefinitely. + /// /// [JsonInclude, JsonPropertyName("data_retention")] public Elastic.Clients.Elasticsearch.Serverless.Duration? DataRetention { get; set; } /// - /// If defined, every backing index will execute the configured downsampling configuration after the backing
index is not the data stream write index anymore. + /// + /// If defined, every backing index will execute the configured downsampling configuration after the backing + /// index is not the data stream write index anymore. + /// /// [JsonInclude, JsonPropertyName("downsampling")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycleDownsampling? Downsampling { get; set; } } /// -/// Update data stream lifecycles.
Update the data stream lifecycle of the specified data streams. +/// +/// Update data stream lifecycles. +/// Update the data stream lifecycle of the specified data streams. +/// /// public sealed partial class PutDataLifecycleRequestDescriptor : RequestDescriptor { @@ -130,7 +165,11 @@ public PutDataLifecycleRequestDescriptor Name(Elastic.Clients.Elasticsearch.Serv private Action DownsamplingDescriptorAction { get; set; } /// - /// If defined, every document added to this data stream will be stored at least for this time frame.
Any time after this duration the document could be deleted.
When empty, every document in this data stream will be stored indefinitely. + /// + /// If defined, every document added to this data stream will be stored at least for this time frame. + /// Any time after this duration the document could be deleted. + /// When empty, every document in this data stream will be stored indefinitely. + /// /// public PutDataLifecycleRequestDescriptor DataRetention(Elastic.Clients.Elasticsearch.Serverless.Duration? dataRetention) { @@ -139,7 +178,10 @@ public PutDataLifecycleRequestDescriptor DataRetention(Elastic.Clients.Elasticse } /// - /// If defined, every backing index will execute the configured downsampling configuration after the backing
index is not the data stream write index anymore. + /// + /// If defined, every backing index will execute the configured downsampling configuration after the backing + /// index is not the data stream write index anymore. + /// /// public PutDataLifecycleRequestDescriptor Downsampling(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycleDownsampling? downsampling) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutDataLifecycleResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutDataLifecycleResponse.g.cs index 613899cb1b9..633a0f789a7 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutDataLifecycleResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutDataLifecycleResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class PutDataLifecycleResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutIndexTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutIndexTemplateRequest.g.cs index 5382446ebe4..0bb21806f9b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutIndexTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutIndexTemplateRequest.g.cs @@ -32,23 +32,33 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class PutIndexTemplateRequestParameters : RequestParameters { /// - /// User defined reason for creating/updating the index template + /// + /// User defined reason for creating/updating the index template + /// /// public string? Cause { get => Q("cause"); set => Q("cause", value); } /// - /// If `true`, this request cannot replace or update existing index templates. + /// + /// If true, this request cannot replace or update existing index templates. + /// /// public bool? Create { get => Q("create"); set => Q("create", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. +/// +/// Create or update an index template. +/// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. +/// /// public sealed partial class PutIndexTemplateRequest : PlainRequest { @@ -65,86 +75,130 @@ public PutIndexTemplateRequest(Elastic.Clients.Elasticsearch.Serverless.Name nam internal override string OperationName => "indices.put_index_template"; /// - /// User defined reason for creating/updating the index template + /// + /// User defined reason for creating/updating the index template + /// /// [JsonIgnore] public string? Cause { get => Q("cause"); set => Q("cause", value); } /// - /// If `true`, this request cannot replace or update existing index templates. + /// + /// If true, this request cannot replace or update existing index templates. + /// /// [JsonIgnore] public bool? Create { get => Q("create"); set => Q("create", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// This setting overrides the value of the `action.auto_create_index` cluster setting.
If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.
If set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + /// + /// This setting overrides the value of the action.auto_create_index cluster setting. + /// If set to true in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via actions.auto_create_index. + /// If set to false, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + /// /// [JsonInclude, JsonPropertyName("allow_auto_create")] public bool? AllowAutoCreate { get; set; } /// - /// An ordered list of component template names.
Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// + /// An ordered list of component template names. + /// Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// /// [JsonInclude, JsonPropertyName("composed_of")] public ICollection? ComposedOf { get; set; } /// - /// If this object is included, the template is used to create data streams and their backing indices.
Supports an empty object.
Data streams require a matching index template with a `data_stream` object. + /// + /// If this object is included, the template is used to create data streams and their backing indices. + /// Supports an empty object. + /// Data streams require a matching index template with a data_stream object. + /// /// [JsonInclude, JsonPropertyName("data_stream")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamVisibility? DataStream { get; set; } /// - /// Marks this index template as deprecated. When creating or updating a non-deprecated index template
that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// + /// Marks this index template as deprecated. When creating or updating a non-deprecated index template + /// that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// /// [JsonInclude, JsonPropertyName("deprecated")] public bool? Deprecated { get; set; } /// - /// The configuration option ignore_missing_component_templates can be used when an index template
references a component template that might not exist + /// + /// The configuration option ignore_missing_component_templates can be used when an index template + /// references a component template that might not exist + /// /// [JsonInclude, JsonPropertyName("ignore_missing_component_templates")] public ICollection? IgnoreMissingComponentTemplates { get; set; } /// - /// Name of the index template to create. + /// + /// Name of the index template to create. + /// /// [JsonInclude, JsonPropertyName("index_patterns")] public Elastic.Clients.Elasticsearch.Serverless.Indices? IndexPatterns { get; set; } /// - /// Optional user metadata about the index template.
May have any contents.
This map is not automatically generated by Elasticsearch. + /// + /// Optional user metadata about the index template. + /// May have any contents. + /// This map is not automatically generated by Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("_meta")] public IDictionary? Meta { get; set; } /// - /// Priority to determine index template precedence when a new data stream or index is created.
The index template with the highest priority is chosen.
If no priority is specified the template is treated as though it is of priority 0 (lowest priority).
This number is not automatically generated by Elasticsearch. + /// + /// Priority to determine index template precedence when a new data stream or index is created. + /// The index template with the highest priority is chosen. + /// If no priority is specified the template is treated as though it is of priority 0 (lowest priority). + /// This number is not automatically generated by Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("priority")] public long? Priority { get; set; } /// - /// Template to be applied.
It may optionally include an `aliases`, `mappings`, or `settings` configuration. + /// + /// Template to be applied. + /// It may optionally include an aliases, mappings, or settings configuration. + /// /// [JsonInclude, JsonPropertyName("template")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexTemplateMapping? Template { get; set; } /// - /// Version number used to manage index templates externally.
This number is not automatically generated by Elasticsearch. + /// + /// Version number used to manage index templates externally. + /// This number is not automatically generated by Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("version")] public long? Version { get; set; } } /// -/// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. +/// +/// Create or update an index template. +/// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. +/// /// public sealed partial class PutIndexTemplateRequestDescriptor : RequestDescriptor, PutIndexTemplateRequestParameters> { @@ -188,7 +242,11 @@ public PutIndexTemplateRequestDescriptor Name(Elastic.Clients.Elastic private long? VersionValue { get; set; } /// - /// This setting overrides the value of the `action.auto_create_index` cluster setting.
If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.
If set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + /// + /// This setting overrides the value of the action.auto_create_index cluster setting. + /// If set to true in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via actions.auto_create_index. + /// If set to false, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + /// /// public PutIndexTemplateRequestDescriptor AllowAutoCreate(bool? allowAutoCreate = true) { @@ -197,7 +255,10 @@ public PutIndexTemplateRequestDescriptor AllowAutoCreate(bool? allowA } /// - /// An ordered list of component template names.
Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// + /// An ordered list of component template names. + /// Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// /// public PutIndexTemplateRequestDescriptor ComposedOf(ICollection? composedOf) { @@ -206,7 +267,11 @@ public PutIndexTemplateRequestDescriptor ComposedOf(ICollection - /// If this object is included, the template is used to create data streams and their backing indices.
Supports an empty object.
Data streams require a matching index template with a `data_stream` object. + /// + /// If this object is included, the template is used to create data streams and their backing indices. + /// Supports an empty object. + /// Data streams require a matching index template with a data_stream object. + /// /// public PutIndexTemplateRequestDescriptor DataStream(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamVisibility? dataStream) { @@ -233,7 +298,10 @@ public PutIndexTemplateRequestDescriptor DataStream(Action - /// Marks this index template as deprecated. When creating or updating a non-deprecated index template
that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// + /// Marks this index template as deprecated. When creating or updating a non-deprecated index template + /// that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// /// public PutIndexTemplateRequestDescriptor Deprecated(bool? deprecated = true) { @@ -242,7 +310,10 @@ public PutIndexTemplateRequestDescriptor Deprecated(bool? deprecated } /// - /// The configuration option ignore_missing_component_templates can be used when an index template
references a component template that might not exist + /// + /// The configuration option ignore_missing_component_templates can be used when an index template + /// references a component template that might not exist + /// /// public PutIndexTemplateRequestDescriptor IgnoreMissingComponentTemplates(ICollection? ignoreMissingComponentTemplates) { @@ -251,7 +322,9 @@ public PutIndexTemplateRequestDescriptor IgnoreMissingComponentTempla } /// - /// Name of the index template to create. + /// + /// Name of the index template to create. + /// /// public PutIndexTemplateRequestDescriptor IndexPatterns(Elastic.Clients.Elasticsearch.Serverless.Indices? indexPatterns) { @@ -260,7 +333,11 @@ public PutIndexTemplateRequestDescriptor IndexPatterns(Elastic.Client } /// - /// Optional user metadata about the index template.
May have any contents.
This map is not automatically generated by Elasticsearch. + /// + /// Optional user metadata about the index template. + /// May have any contents. + /// This map is not automatically generated by Elasticsearch. + /// /// public PutIndexTemplateRequestDescriptor Meta(Func, FluentDictionary> selector) { @@ -269,7 +346,12 @@ public PutIndexTemplateRequestDescriptor Meta(Func - /// Priority to determine index template precedence when a new data stream or index is created.
The index template with the highest priority is chosen.
If no priority is specified the template is treated as though it is of priority 0 (lowest priority).
This number is not automatically generated by Elasticsearch. + /// + /// Priority to determine index template precedence when a new data stream or index is created. + /// The index template with the highest priority is chosen. + /// If no priority is specified the template is treated as though it is of priority 0 (lowest priority). + /// This number is not automatically generated by Elasticsearch. + /// /// public PutIndexTemplateRequestDescriptor Priority(long? priority) { @@ -278,7 +360,10 @@ public PutIndexTemplateRequestDescriptor Priority(long? priority) } /// - /// Template to be applied.
It may optionally include an `aliases`, `mappings`, or `settings` configuration. + /// + /// Template to be applied. + /// It may optionally include an aliases, mappings, or settings configuration. + /// /// public PutIndexTemplateRequestDescriptor Template(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexTemplateMapping? template) { @@ -305,7 +390,10 @@ public PutIndexTemplateRequestDescriptor Template(Action - /// Version number used to manage index templates externally.
This number is not automatically generated by Elasticsearch. + /// + /// Version number used to manage index templates externally. + /// This number is not automatically generated by Elasticsearch. + /// /// public PutIndexTemplateRequestDescriptor Version(long? version) { @@ -401,7 +489,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. +/// +/// Create or update an index template. +/// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. +/// /// public sealed partial class PutIndexTemplateRequestDescriptor : RequestDescriptor { @@ -445,7 +536,11 @@ public PutIndexTemplateRequestDescriptor Name(Elastic.Clients.Elasticsearch.Serv private long? VersionValue { get; set; } /// - /// This setting overrides the value of the `action.auto_create_index` cluster setting.
If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.
If set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + /// + /// This setting overrides the value of the action.auto_create_index cluster setting. + /// If set to true in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via actions.auto_create_index. + /// If set to false, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + /// /// public PutIndexTemplateRequestDescriptor AllowAutoCreate(bool? allowAutoCreate = true) { @@ -454,7 +549,10 @@ public PutIndexTemplateRequestDescriptor AllowAutoCreate(bool? allowAutoCreate = } /// - /// An ordered list of component template names.
Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// + /// An ordered list of component template names. + /// Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// /// public PutIndexTemplateRequestDescriptor ComposedOf(ICollection? composedOf) { @@ -463,7 +561,11 @@ public PutIndexTemplateRequestDescriptor ComposedOf(ICollection - /// If this object is included, the template is used to create data streams and their backing indices.
Supports an empty object.
Data streams require a matching index template with a `data_stream` object. + /// + /// If this object is included, the template is used to create data streams and their backing indices. + /// Supports an empty object. + /// Data streams require a matching index template with a data_stream object. + /// /// public PutIndexTemplateRequestDescriptor DataStream(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamVisibility? dataStream) { @@ -490,7 +592,10 @@ public PutIndexTemplateRequestDescriptor DataStream(Action - /// Marks this index template as deprecated. When creating or updating a non-deprecated index template
that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// + /// Marks this index template as deprecated. When creating or updating a non-deprecated index template + /// that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// /// public PutIndexTemplateRequestDescriptor Deprecated(bool? deprecated = true) { @@ -499,7 +604,10 @@ public PutIndexTemplateRequestDescriptor Deprecated(bool? deprecated = true) } /// - /// The configuration option ignore_missing_component_templates can be used when an index template
references a component template that might not exist + /// + /// The configuration option ignore_missing_component_templates can be used when an index template + /// references a component template that might not exist + /// /// public PutIndexTemplateRequestDescriptor IgnoreMissingComponentTemplates(ICollection? ignoreMissingComponentTemplates) { @@ -508,7 +616,9 @@ public PutIndexTemplateRequestDescriptor IgnoreMissingComponentTemplates(ICollec } /// - /// Name of the index template to create. + /// + /// Name of the index template to create. + /// /// public PutIndexTemplateRequestDescriptor IndexPatterns(Elastic.Clients.Elasticsearch.Serverless.Indices? indexPatterns) { @@ -517,7 +627,11 @@ public PutIndexTemplateRequestDescriptor IndexPatterns(Elastic.Clients.Elasticse } /// - /// Optional user metadata about the index template.
May have any contents.
This map is not automatically generated by Elasticsearch. + /// + /// Optional user metadata about the index template. + /// May have any contents. + /// This map is not automatically generated by Elasticsearch. + /// /// public PutIndexTemplateRequestDescriptor Meta(Func, FluentDictionary> selector) { @@ -526,7 +640,12 @@ public PutIndexTemplateRequestDescriptor Meta(Func - /// Priority to determine index template precedence when a new data stream or index is created.
The index template with the highest priority is chosen.
If no priority is specified the template is treated as though it is of priority 0 (lowest priority).
This number is not automatically generated by Elasticsearch. + /// + /// Priority to determine index template precedence when a new data stream or index is created. + /// The index template with the highest priority is chosen. + /// If no priority is specified the template is treated as though it is of priority 0 (lowest priority). + /// This number is not automatically generated by Elasticsearch. + /// /// public PutIndexTemplateRequestDescriptor Priority(long? priority) { @@ -535,7 +654,10 @@ public PutIndexTemplateRequestDescriptor Priority(long? priority) } /// - /// Template to be applied.
It may optionally include an `aliases`, `mappings`, or `settings` configuration. + /// + /// Template to be applied. + /// It may optionally include an aliases, mappings, or settings configuration. + /// /// public PutIndexTemplateRequestDescriptor Template(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexTemplateMapping? template) { @@ -562,7 +684,10 @@ public PutIndexTemplateRequestDescriptor Template(Action - /// Version number used to manage index templates externally.
This number is not automatically generated by Elasticsearch. + /// + /// Version number used to manage index templates externally. + /// This number is not automatically generated by Elasticsearch. + /// /// public PutIndexTemplateRequestDescriptor Version(long? version) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutIndexTemplateResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutIndexTemplateResponse.g.cs index b247f6a858d..0296d8cd3c5 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutIndexTemplateResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutIndexTemplateResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class PutIndexTemplateResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutIndicesSettingsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutIndicesSettingsRequest.g.cs index 3bd0d0eee7e..658feafaeb0 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutIndicesSettingsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutIndicesSettingsRequest.g.cs @@ -32,43 +32,71 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class PutIndicesSettingsRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index
alias, or `_all` value targets only missing or closed indices. This
behavior applies even if the request targets other open indices. For
example, a request targeting `foo*,bar*` returns an error if an index
starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index + /// alias, or _all value targets only missing or closed indices. This + /// behavior applies even if the request targets other open indices. For + /// example, a request targeting foo*,bar* returns an error if an index + /// starts with foo but no index starts with bar. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match. If the request can target
data streams, this argument determines whether wildcard expressions match
hidden data streams. Supports comma-separated values, such as
`open,hidden`. + /// + /// Type of index that wildcard patterns can match. If the request can target + /// data streams, this argument determines whether wildcard expressions match + /// hidden data streams. Supports comma-separated values, such as + /// open,hidden. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// If `true`, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Period to wait for a connection to the master node. If no response is
received before the timeout expires, the request fails and returns an
error. + /// + /// Period to wait for a connection to the master node. If no response is + /// received before the timeout expires, the request fails and returns an + /// error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// If `true`, existing index settings remain unchanged. + /// + /// If true, existing index settings remain unchanged. + /// /// public bool? PreserveExisting { get => Q("preserve_existing"); set => Q("preserve_existing", value); } /// - /// Period to wait for a response. If no response is received before the
timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the + /// timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. +/// +/// Update index settings. +/// Changes dynamic index settings in real time. For data streams, index setting +/// changes are applied to all backing indices by default. +/// /// public sealed partial class PutIndicesSettingsRequest : PlainRequest, ISelfSerializable { @@ -89,43 +117,67 @@ public PutIndicesSettingsRequest(Elastic.Clients.Elasticsearch.Serverless.Indice internal override string OperationName => "indices.put_settings"; /// - /// If `false`, the request returns an error if any wildcard expression, index
alias, or `_all` value targets only missing or closed indices. This
behavior applies even if the request targets other open indices. For
example, a request targeting `foo*,bar*` returns an error if an index
starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index + /// alias, or _all value targets only missing or closed indices. This + /// behavior applies even if the request targets other open indices. For + /// example, a request targeting foo*,bar* returns an error if an index + /// starts with foo but no index starts with bar. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match. If the request can target
data streams, this argument determines whether wildcard expressions match
hidden data streams. Supports comma-separated values, such as
`open,hidden`. + /// + /// Type of index that wildcard patterns can match. If the request can target + /// data streams, this argument determines whether wildcard expressions match + /// hidden data streams. Supports comma-separated values, such as + /// open,hidden. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// [JsonIgnore] public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// If `true`, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Period to wait for a connection to the master node. If no response is
received before the timeout expires, the request fails and returns an
error. + /// + /// Period to wait for a connection to the master node. If no response is + /// received before the timeout expires, the request fails and returns an + /// error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// If `true`, existing index settings remain unchanged. + /// + /// If true, existing index settings remain unchanged. + /// /// [JsonIgnore] public bool? PreserveExisting { get => Q("preserve_existing"); set => Q("preserve_existing", value); } /// - /// Period to wait for a response. If no response is received before the
timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the + /// timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } @@ -139,7 +191,11 @@ void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions op } /// -/// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. +/// +/// Update index settings. +/// Changes dynamic index settings in real time. For data streams, index setting +/// changes are applied to all backing indices by default. +/// /// public sealed partial class PutIndicesSettingsRequestDescriptor : RequestDescriptor, PutIndicesSettingsRequestParameters> { @@ -204,7 +260,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. +/// +/// Update index settings. +/// Changes dynamic index settings in real time. For data streams, index setting +/// changes are applied to all backing indices by default. +/// /// public sealed partial class PutIndicesSettingsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutIndicesSettingsResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutIndicesSettingsResponse.g.cs index 7cb2c84a174..bf6e6f4e7ae 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutIndicesSettingsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutIndicesSettingsResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class PutIndicesSettingsResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutMappingRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutMappingRequest.g.cs index 700028cb5e8..e59d8c3dddc 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutMappingRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutMappingRequest.g.cs @@ -32,38 +32,61 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class PutMappingRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// If `true`, the mappings are applied only to the current write index for the target. + /// + /// If true, the mappings are applied only to the current write index for the target. + /// /// public bool? WriteIndexOnly { get => Q("write_index_only"); set => Q("write_index_only", value); } } /// -/// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. +/// +/// Update field mappings. +/// Adds new fields to an existing data stream or index. +/// You can also use this API to change the search settings of existing fields. +/// For data streams, these changes are applied to all backing indices by default. +/// /// public sealed partial class PutMappingRequest : PlainRequest { @@ -80,112 +103,177 @@ public PutMappingRequest(Elastic.Clients.Elasticsearch.Serverless.Indices indice internal override string OperationName => "indices.put_mapping"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// If `true`, the mappings are applied only to the current write index for the target. + /// + /// If true, the mappings are applied only to the current write index for the target. + /// /// [JsonIgnore] public bool? WriteIndexOnly { get => Q("write_index_only"); set => Q("write_index_only", value); } /// - /// Controls whether dynamic date detection is enabled. + /// + /// Controls whether dynamic date detection is enabled. + /// /// [JsonInclude, JsonPropertyName("date_detection")] public bool? DateDetection { get; set; } /// - /// Controls whether new fields are added dynamically. + /// + /// Controls whether new fields are added dynamically. + /// /// [JsonInclude, JsonPropertyName("dynamic")] public Elastic.Clients.Elasticsearch.Serverless.Mapping.DynamicMapping? Dynamic { get; set; } /// - /// If date detection is enabled then new string fields are checked
against 'dynamic_date_formats' and if the value matches then
a new date field is added instead of string. + /// + /// If date detection is enabled then new string fields are checked + /// against 'dynamic_date_formats' and if the value matches then + /// a new date field is added instead of string. + /// /// [JsonInclude, JsonPropertyName("dynamic_date_formats")] public ICollection? DynamicDateFormats { get; set; } /// - /// Specify dynamic templates for the mapping. + /// + /// Specify dynamic templates for the mapping. + /// /// [JsonInclude, JsonPropertyName("dynamic_templates")] [SingleOrManyCollectionConverter(typeof(IReadOnlyDictionary))] public ICollection>? DynamicTemplates { get; set; } /// - /// Control whether field names are enabled for the index. + /// + /// Control whether field names are enabled for the index. + /// /// [JsonInclude, JsonPropertyName("_field_names")] public Elastic.Clients.Elasticsearch.Serverless.Mapping.FieldNamesField? FieldNames { get; set; } /// - /// A mapping type can have custom meta data associated with it. These are
not used at all by Elasticsearch, but can be used to store
application-specific metadata. + /// + /// A mapping type can have custom meta data associated with it. These are + /// not used at all by Elasticsearch, but can be used to store + /// application-specific metadata. + /// /// [JsonInclude, JsonPropertyName("_meta")] public IDictionary? Meta { get; set; } /// - /// Automatically map strings into numeric data types for all fields. + /// + /// Automatically map strings into numeric data types for all fields. + /// /// [JsonInclude, JsonPropertyName("numeric_detection")] public bool? NumericDetection { get; set; } /// - /// Mapping for a field. For new fields, this mapping can include: - /// - Field name
- Field data type
- Mapping parameters + /// + /// Mapping for a field. For new fields, this mapping can include: + /// + /// + /// + /// + /// Field name + /// + /// + /// + /// + /// Field data type + /// + /// + /// + /// + /// Mapping parameters + /// + /// + /// /// [JsonInclude, JsonPropertyName("properties")] public Elastic.Clients.Elasticsearch.Serverless.Mapping.Properties? Properties { get; set; } /// - /// Enable making a routing value required on indexed documents. + /// + /// Enable making a routing value required on indexed documents. + /// /// [JsonInclude, JsonPropertyName("_routing")] public Elastic.Clients.Elasticsearch.Serverless.Mapping.RoutingField? Routing { get; set; } /// - /// Mapping of runtime fields for the index. + /// + /// Mapping of runtime fields for the index. + /// /// [JsonInclude, JsonPropertyName("runtime")] public IDictionary? Runtime { get; set; } /// - /// Control whether the _source field is enabled on the index. + /// + /// Control whether the _source field is enabled on the index. + /// /// [JsonInclude, JsonPropertyName("_source")] public Elastic.Clients.Elasticsearch.Serverless.Mapping.SourceField? Source { get; set; } } /// -/// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. +/// +/// Update field mappings. +/// Adds new fields to an existing data stream or index. +/// You can also use this API to change the search settings of existing fields. +/// For data streams, these changes are applied to all backing indices by default. +/// /// public sealed partial class PutMappingRequestDescriptor : RequestDescriptor, PutMappingRequestParameters> { @@ -239,7 +327,9 @@ public PutMappingRequestDescriptor Indices(Elastic.Clients.Elasticsea private Action SourceDescriptorAction { get; set; } /// - /// Controls whether dynamic date detection is enabled. + /// + /// Controls whether dynamic date detection is enabled. + /// /// public PutMappingRequestDescriptor DateDetection(bool? dateDetection = true) { @@ -248,7 +338,9 @@ public PutMappingRequestDescriptor DateDetection(bool? dateDetection } /// - /// Controls whether new fields are added dynamically. + /// + /// Controls whether new fields are added dynamically. + /// /// public PutMappingRequestDescriptor Dynamic(Elastic.Clients.Elasticsearch.Serverless.Mapping.DynamicMapping? dynamic) { @@ -257,7 +349,11 @@ public PutMappingRequestDescriptor Dynamic(Elastic.Clients.Elasticsea } /// - /// If date detection is enabled then new string fields are checked
against 'dynamic_date_formats' and if the value matches then
a new date field is added instead of string. + /// + /// If date detection is enabled then new string fields are checked + /// against 'dynamic_date_formats' and if the value matches then + /// a new date field is added instead of string. + /// /// public PutMappingRequestDescriptor DynamicDateFormats(ICollection? dynamicDateFormats) { @@ -266,7 +362,9 @@ public PutMappingRequestDescriptor DynamicDateFormats(ICollection - /// Specify dynamic templates for the mapping. + /// + /// Specify dynamic templates for the mapping. + /// /// public PutMappingRequestDescriptor DynamicTemplates(ICollection>? dynamicTemplates) { @@ -275,7 +373,9 @@ public PutMappingRequestDescriptor DynamicTemplates(ICollection - /// Control whether field names are enabled for the index. + /// + /// Control whether field names are enabled for the index. + /// /// public PutMappingRequestDescriptor FieldNames(Elastic.Clients.Elasticsearch.Serverless.Mapping.FieldNamesField? fieldNames) { @@ -302,7 +402,11 @@ public PutMappingRequestDescriptor FieldNames(Action - /// A mapping type can have custom meta data associated with it. These are
not used at all by Elasticsearch, but can be used to store
application-specific metadata. + /// + /// A mapping type can have custom meta data associated with it. These are + /// not used at all by Elasticsearch, but can be used to store + /// application-specific metadata. + /// /// public PutMappingRequestDescriptor Meta(Func, FluentDictionary> selector) { @@ -311,7 +415,9 @@ public PutMappingRequestDescriptor Meta(Func - /// Automatically map strings into numeric data types for all fields. + /// + /// Automatically map strings into numeric data types for all fields. + /// /// public PutMappingRequestDescriptor NumericDetection(bool? numericDetection = true) { @@ -320,8 +426,26 @@ public PutMappingRequestDescriptor NumericDetection(bool? numericDete } /// - /// Mapping for a field. For new fields, this mapping can include: - /// - Field name
- Field data type
- Mapping parameters + /// + /// Mapping for a field. For new fields, this mapping can include: + /// + /// + /// + /// + /// Field name + /// + /// + /// + /// + /// Field data type + /// + /// + /// + /// + /// Mapping parameters + /// + /// + /// /// public PutMappingRequestDescriptor Properties(Elastic.Clients.Elasticsearch.Serverless.Mapping.Properties? properties) { @@ -344,7 +468,9 @@ public PutMappingRequestDescriptor Properties(Action - /// Enable making a routing value required on indexed documents. + /// + /// Enable making a routing value required on indexed documents. + /// /// public PutMappingRequestDescriptor Routing(Elastic.Clients.Elasticsearch.Serverless.Mapping.RoutingField? routing) { @@ -371,7 +497,9 @@ public PutMappingRequestDescriptor Routing(Action - /// Mapping of runtime fields for the index. + /// + /// Mapping of runtime fields for the index. + /// /// public PutMappingRequestDescriptor Runtime(Func>, FluentDescriptorDictionary>> selector) { @@ -380,7 +508,9 @@ public PutMappingRequestDescriptor Runtime(Func - /// Control whether the _source field is enabled on the index. + /// + /// Control whether the _source field is enabled on the index. + /// /// public PutMappingRequestDescriptor Source(Elastic.Clients.Elasticsearch.Serverless.Mapping.SourceField? source) { @@ -510,7 +640,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. +/// +/// Update field mappings. +/// Adds new fields to an existing data stream or index. +/// You can also use this API to change the search settings of existing fields. +/// For data streams, these changes are applied to all backing indices by default. +/// /// public sealed partial class PutMappingRequestDescriptor : RequestDescriptor { @@ -560,7 +695,9 @@ public PutMappingRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Serverl private Action SourceDescriptorAction { get; set; } /// - /// Controls whether dynamic date detection is enabled. + /// + /// Controls whether dynamic date detection is enabled. + /// /// public PutMappingRequestDescriptor DateDetection(bool? dateDetection = true) { @@ -569,7 +706,9 @@ public PutMappingRequestDescriptor DateDetection(bool? dateDetection = true) } /// - /// Controls whether new fields are added dynamically. + /// + /// Controls whether new fields are added dynamically. + /// /// public PutMappingRequestDescriptor Dynamic(Elastic.Clients.Elasticsearch.Serverless.Mapping.DynamicMapping? dynamic) { @@ -578,7 +717,11 @@ public PutMappingRequestDescriptor Dynamic(Elastic.Clients.Elasticsearch.Serverl } /// - /// If date detection is enabled then new string fields are checked
against 'dynamic_date_formats' and if the value matches then
a new date field is added instead of string. + /// + /// If date detection is enabled then new string fields are checked + /// against 'dynamic_date_formats' and if the value matches then + /// a new date field is added instead of string. + /// /// public PutMappingRequestDescriptor DynamicDateFormats(ICollection? dynamicDateFormats) { @@ -587,7 +730,9 @@ public PutMappingRequestDescriptor DynamicDateFormats(ICollection? dynam } /// - /// Specify dynamic templates for the mapping. + /// + /// Specify dynamic templates for the mapping. + /// /// public PutMappingRequestDescriptor DynamicTemplates(ICollection>? dynamicTemplates) { @@ -596,7 +741,9 @@ public PutMappingRequestDescriptor DynamicTemplates(ICollection - /// Control whether field names are enabled for the index. + /// + /// Control whether field names are enabled for the index. + /// /// public PutMappingRequestDescriptor FieldNames(Elastic.Clients.Elasticsearch.Serverless.Mapping.FieldNamesField? fieldNames) { @@ -623,7 +770,11 @@ public PutMappingRequestDescriptor FieldNames(Action - /// A mapping type can have custom meta data associated with it. These are
not used at all by Elasticsearch, but can be used to store
application-specific metadata. + /// + /// A mapping type can have custom meta data associated with it. These are + /// not used at all by Elasticsearch, but can be used to store + /// application-specific metadata. + /// /// public PutMappingRequestDescriptor Meta(Func, FluentDictionary> selector) { @@ -632,7 +783,9 @@ public PutMappingRequestDescriptor Meta(Func, F } /// - /// Automatically map strings into numeric data types for all fields. + /// + /// Automatically map strings into numeric data types for all fields. + /// /// public PutMappingRequestDescriptor NumericDetection(bool? numericDetection = true) { @@ -641,8 +794,26 @@ public PutMappingRequestDescriptor NumericDetection(bool? numericDetection = tru } /// - /// Mapping for a field. For new fields, this mapping can include: - /// - Field name
- Field data type
- Mapping parameters + /// + /// Mapping for a field. For new fields, this mapping can include: + /// + /// + /// + /// + /// Field name + /// + /// + /// + /// + /// Field data type + /// + /// + /// + /// + /// Mapping parameters + /// + /// + /// /// public PutMappingRequestDescriptor Properties(Elastic.Clients.Elasticsearch.Serverless.Mapping.Properties? properties) { @@ -665,7 +836,9 @@ public PutMappingRequestDescriptor Properties(Action - /// Enable making a routing value required on indexed documents. + /// + /// Enable making a routing value required on indexed documents. + /// /// public PutMappingRequestDescriptor Routing(Elastic.Clients.Elasticsearch.Serverless.Mapping.RoutingField? routing) { @@ -692,7 +865,9 @@ public PutMappingRequestDescriptor Routing(Action - /// Mapping of runtime fields for the index. + /// + /// Mapping of runtime fields for the index. + /// /// public PutMappingRequestDescriptor Runtime(Func, FluentDescriptorDictionary> selector) { @@ -701,7 +876,9 @@ public PutMappingRequestDescriptor Runtime(Func - /// Control whether the _source field is enabled on the index. + /// + /// Control whether the _source field is enabled on the index. + /// /// public PutMappingRequestDescriptor Source(Elastic.Clients.Elasticsearch.Serverless.Mapping.SourceField? source) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutMappingResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutMappingResponse.g.cs index 95bcf98b310..3e6986a7ede 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutMappingResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutMappingResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class PutMappingResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutTemplateRequest.g.cs index eb6c337cfb0..f1bc42f7dbe 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutTemplateRequest.g.cs @@ -34,18 +34,26 @@ public sealed partial class PutTemplateRequestParameters : RequestParameters public string? Cause { get => Q("cause"); set => Q("cause", value); } /// - /// If true, this request cannot replace or update existing index templates. + /// + /// If true, this request cannot replace or update existing index templates. + /// /// public bool? Create { get => Q("create"); set => Q("create", value); } /// - /// Period to wait for a connection to the master node. If no response is
received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is + /// received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. +/// +/// Create or update an index template. +/// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. +/// /// public sealed partial class PutTemplateRequest : PlainRequest { @@ -65,58 +73,84 @@ public PutTemplateRequest(Elastic.Clients.Elasticsearch.Serverless.Name name) : public string? Cause { get => Q("cause"); set => Q("cause", value); } /// - /// If true, this request cannot replace or update existing index templates. + /// + /// If true, this request cannot replace or update existing index templates. + /// /// [JsonIgnore] public bool? Create { get => Q("create"); set => Q("create", value); } /// - /// Period to wait for a connection to the master node. If no response is
received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is + /// received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Aliases for the index. + /// + /// Aliases for the index. + /// /// [JsonInclude, JsonPropertyName("aliases")] public IDictionary? Aliases { get; set; } /// - /// Array of wildcard expressions used to match the names
of indices during creation. + /// + /// Array of wildcard expressions used to match the names + /// of indices during creation. + /// /// [JsonInclude, JsonPropertyName("index_patterns")] [SingleOrManyCollectionConverter(typeof(string))] public ICollection? IndexPatterns { get; set; } /// - /// Mapping for fields in the index. + /// + /// Mapping for fields in the index. + /// /// [JsonInclude, JsonPropertyName("mappings")] public Elastic.Clients.Elasticsearch.Serverless.Mapping.TypeMapping? Mappings { get; set; } /// - /// Order in which Elasticsearch applies this template if index
matches multiple templates. - /// Templates with lower 'order' values are merged first. Templates with higher
'order' values are merged later, overriding templates with lower values. + /// + /// Order in which Elasticsearch applies this template if index + /// matches multiple templates. + /// + /// + /// Templates with lower 'order' values are merged first. Templates with higher + /// 'order' values are merged later, overriding templates with lower values. + /// /// [JsonInclude, JsonPropertyName("order")] public int? Order { get; set; } /// - /// Configuration options for the index. + /// + /// Configuration options for the index. + /// /// [JsonInclude, JsonPropertyName("settings")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexSettings? Settings { get; set; } /// - /// Version number used to manage index templates externally. This number
is not automatically generated by Elasticsearch. + /// + /// Version number used to manage index templates externally. This number + /// is not automatically generated by Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("version")] public long? Version { get; set; } } /// -/// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. +/// +/// Create or update an index template. +/// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. +/// /// public sealed partial class PutTemplateRequestDescriptor : RequestDescriptor, PutTemplateRequestParameters> { @@ -156,7 +190,9 @@ public PutTemplateRequestDescriptor Name(Elastic.Clients.Elasticsearc private long? VersionValue { get; set; } /// - /// Aliases for the index. + /// + /// Aliases for the index. + /// /// public PutTemplateRequestDescriptor Aliases(Func>, FluentDescriptorDictionary>> selector) { @@ -165,7 +201,10 @@ public PutTemplateRequestDescriptor Aliases(Func - /// Array of wildcard expressions used to match the names
of indices during creation. + /// + /// Array of wildcard expressions used to match the names + /// of indices during creation. + /// /// public PutTemplateRequestDescriptor IndexPatterns(ICollection? indexPatterns) { @@ -174,7 +213,9 @@ public PutTemplateRequestDescriptor IndexPatterns(ICollection } /// - /// Mapping for fields in the index. + /// + /// Mapping for fields in the index. + /// /// public PutTemplateRequestDescriptor Mappings(Elastic.Clients.Elasticsearch.Serverless.Mapping.TypeMapping? mappings) { @@ -201,8 +242,14 @@ public PutTemplateRequestDescriptor Mappings(Action - /// Order in which Elasticsearch applies this template if index
matches multiple templates. - /// Templates with lower 'order' values are merged first. Templates with higher
'order' values are merged later, overriding templates with lower values. + /// + /// Order in which Elasticsearch applies this template if index + /// matches multiple templates. + /// + /// + /// Templates with lower 'order' values are merged first. Templates with higher + /// 'order' values are merged later, overriding templates with lower values. + /// /// public PutTemplateRequestDescriptor Order(int? order) { @@ -211,7 +258,9 @@ public PutTemplateRequestDescriptor Order(int? order) } /// - /// Configuration options for the index. + /// + /// Configuration options for the index. + /// /// public PutTemplateRequestDescriptor Settings(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexSettings? settings) { @@ -238,7 +287,10 @@ public PutTemplateRequestDescriptor Settings(Action - /// Version number used to manage index templates externally. This number
is not automatically generated by Elasticsearch. + /// + /// Version number used to manage index templates externally. This number + /// is not automatically generated by Elasticsearch. + /// /// public PutTemplateRequestDescriptor Version(long? version) { @@ -310,7 +362,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. +/// +/// Create or update an index template. +/// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. +/// /// public sealed partial class PutTemplateRequestDescriptor : RequestDescriptor { @@ -350,7 +405,9 @@ public PutTemplateRequestDescriptor Name(Elastic.Clients.Elasticsearch.Serverles private long? VersionValue { get; set; } /// - /// Aliases for the index. + /// + /// Aliases for the index. + /// /// public PutTemplateRequestDescriptor Aliases(Func, FluentDescriptorDictionary> selector) { @@ -359,7 +416,10 @@ public PutTemplateRequestDescriptor Aliases(Func - /// Array of wildcard expressions used to match the names
of indices during creation. + /// + /// Array of wildcard expressions used to match the names + /// of indices during creation. + /// /// public PutTemplateRequestDescriptor IndexPatterns(ICollection? indexPatterns) { @@ -368,7 +428,9 @@ public PutTemplateRequestDescriptor IndexPatterns(ICollection? indexPatt } /// - /// Mapping for fields in the index. + /// + /// Mapping for fields in the index. + /// /// public PutTemplateRequestDescriptor Mappings(Elastic.Clients.Elasticsearch.Serverless.Mapping.TypeMapping? mappings) { @@ -395,8 +457,14 @@ public PutTemplateRequestDescriptor Mappings(Action - /// Order in which Elasticsearch applies this template if index
matches multiple templates. - /// Templates with lower 'order' values are merged first. Templates with higher
'order' values are merged later, overriding templates with lower values. + /// + /// Order in which Elasticsearch applies this template if index + /// matches multiple templates. + /// + /// + /// Templates with lower 'order' values are merged first. Templates with higher + /// 'order' values are merged later, overriding templates with lower values. + /// /// public PutTemplateRequestDescriptor Order(int? order) { @@ -405,7 +473,9 @@ public PutTemplateRequestDescriptor Order(int? order) } /// - /// Configuration options for the index. + /// + /// Configuration options for the index. + /// /// public PutTemplateRequestDescriptor Settings(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexSettings? settings) { @@ -432,7 +502,10 @@ public PutTemplateRequestDescriptor Settings(Action - /// Version number used to manage index templates externally. This number
is not automatically generated by Elasticsearch. + /// + /// Version number used to manage index templates externally. This number + /// is not automatically generated by Elasticsearch. + /// /// public PutTemplateRequestDescriptor Version(long? version) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutTemplateResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutTemplateResponse.g.cs index 92074809589..569d178560f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutTemplateResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutTemplateResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class PutTemplateResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/RecoveryRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/RecoveryRequest.g.cs index cb122588f09..40b9b4b55d0 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/RecoveryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/RecoveryRequest.g.cs @@ -32,18 +32,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class RecoveryRequestParameters : RequestParameters { /// - /// If `true`, the response only includes ongoing shard recoveries. + /// + /// If true, the response only includes ongoing shard recoveries. + /// /// public bool? ActiveOnly { get => Q("active_only"); set => Q("active_only", value); } /// - /// If `true`, the response includes detailed information about shard recoveries. + /// + /// If true, the response includes detailed information about shard recoveries. + /// /// public bool? Detailed { get => Q("detailed"); set => Q("detailed", value); } } /// -/// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. +/// +/// Returns information about ongoing and completed shard recoveries for one or more indices. +/// For data streams, the API returns information for the stream’s backing indices. +/// /// public sealed partial class RecoveryRequest : PlainRequest { @@ -64,20 +71,27 @@ public RecoveryRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? indices internal override string OperationName => "indices.recovery"; /// - /// If `true`, the response only includes ongoing shard recoveries. + /// + /// If true, the response only includes ongoing shard recoveries. + /// /// [JsonIgnore] public bool? ActiveOnly { get => Q("active_only"); set => Q("active_only", value); } /// - /// If `true`, the response includes detailed information about shard recoveries. + /// + /// If true, the response includes detailed information about shard recoveries. + /// /// [JsonIgnore] public bool? Detailed { get => Q("detailed"); set => Q("detailed", value); } } /// -/// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. +/// +/// Returns information about ongoing and completed shard recoveries for one or more indices. +/// For data streams, the API returns information for the stream’s backing indices. +/// /// public sealed partial class RecoveryRequestDescriptor : RequestDescriptor, RecoveryRequestParameters> { @@ -114,7 +128,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. +/// +/// Returns information about ongoing and completed shard recoveries for one or more indices. +/// For data streams, the API returns information for the stream’s backing indices. +/// /// public sealed partial class RecoveryRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/RefreshRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/RefreshRequest.g.cs index a5d2df75a4a..3bdb87f8baf 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/RefreshRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/RefreshRequest.g.cs @@ -32,23 +32,37 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class RefreshRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } } /// -/// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. +/// +/// Refresh an index. +/// A refresh makes recent operations performed on one or more indices available for search. +/// For data streams, the API runs the refresh operation on the stream’s backing indices. +/// /// public sealed partial class RefreshRequest : PlainRequest { @@ -69,26 +83,40 @@ public RefreshRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? indices) internal override string OperationName => "indices.refresh"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } } /// -/// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. +/// +/// Refresh an index. +/// A refresh makes recent operations performed on one or more indices available for search. +/// For data streams, the API runs the refresh operation on the stream’s backing indices. +/// /// public sealed partial class RefreshRequestDescriptor : RequestDescriptor, RefreshRequestParameters> { @@ -126,7 +154,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. +/// +/// Refresh an index. +/// A refresh makes recent operations performed on one or more indices available for search. +/// For data streams, the API runs the refresh operation on the stream’s backing indices. +/// /// public sealed partial class RefreshRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ResolveIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ResolveIndexRequest.g.cs index 985b8aee8b4..c18ffe5c104 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ResolveIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ResolveIndexRequest.g.cs @@ -32,13 +32,21 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class ResolveIndexRequestParameters : RequestParameters { /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } } /// -/// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams.
Multiple patterns and remote clusters are supported. +/// +/// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. +/// Multiple patterns and remote clusters are supported. +/// /// public sealed partial class ResolveIndexRequest : PlainRequest { @@ -55,14 +63,22 @@ public ResolveIndexRequest(Elastic.Clients.Elasticsearch.Serverless.Names name) internal override string OperationName => "indices.resolve_index"; /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } } /// -/// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams.
Multiple patterns and remote clusters are supported. +/// +/// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. +/// Multiple patterns and remote clusters are supported. +/// /// public sealed partial class ResolveIndexRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/RolloverRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/RolloverRequest.g.cs index d352fa58d37..0121d53bc30 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/RolloverRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/RolloverRequest.g.cs @@ -32,28 +32,42 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class RolloverRequestParameters : RequestParameters { /// - /// If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover. + /// + /// If true, checks whether the current index satisfies the specified conditions but does not perform a rollover. + /// /// public bool? DryRun { get => Q("dry_run"); set => Q("dry_run", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// public Elastic.Clients.Elasticsearch.Serverless.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Roll over to a new index.
Creates a new index for a data stream or index alias. +/// +/// Roll over to a new index. +/// Creates a new index for a data stream or index alias. +/// /// public sealed partial class RolloverRequest : PlainRequest { @@ -74,56 +88,85 @@ public RolloverRequest(Elastic.Clients.Elasticsearch.Serverless.IndexAlias alias internal override string OperationName => "indices.rollover"; /// - /// If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover. + /// + /// If true, checks whether the current index satisfies the specified conditions but does not perform a rollover. + /// /// [JsonIgnore] public bool? DryRun { get => Q("dry_run"); set => Q("dry_run", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } /// - /// Aliases for the target index.
Data streams do not support this parameter. + /// + /// Aliases for the target index. + /// Data streams do not support this parameter. + /// /// [JsonInclude, JsonPropertyName("aliases")] public IDictionary? Aliases { get; set; } /// - /// Conditions for the rollover.
If specified, Elasticsearch only performs the rollover if the current index satisfies these conditions.
If this parameter is not specified, Elasticsearch performs the rollover unconditionally.
If conditions are specified, at least one of them must be a `max_*` condition.
The index will rollover if any `max_*` condition is satisfied and all `min_*` conditions are satisfied. + /// + /// Conditions for the rollover. + /// If specified, Elasticsearch only performs the rollover if the current index satisfies these conditions. + /// If this parameter is not specified, Elasticsearch performs the rollover unconditionally. + /// If conditions are specified, at least one of them must be a max_* condition. + /// The index will rollover if any max_* condition is satisfied and all min_* conditions are satisfied. + /// /// [JsonInclude, JsonPropertyName("conditions")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.RolloverConditions? Conditions { get; set; } /// - /// Mapping for fields in the index.
If specified, this mapping can include field names, field data types, and mapping paramaters. + /// + /// Mapping for fields in the index. + /// If specified, this mapping can include field names, field data types, and mapping paramaters. + /// /// [JsonInclude, JsonPropertyName("mappings")] public Elastic.Clients.Elasticsearch.Serverless.Mapping.TypeMapping? Mappings { get; set; } /// - /// Configuration options for the index.
Data streams do not support this parameter. + /// + /// Configuration options for the index. + /// Data streams do not support this parameter. + /// /// [JsonInclude, JsonPropertyName("settings")] public IDictionary? Settings { get; set; } } /// -/// Roll over to a new index.
Creates a new index for a data stream or index alias. +/// +/// Roll over to a new index. +/// Creates a new index for a data stream or index alias. +/// /// public sealed partial class RolloverRequestDescriptor : RequestDescriptor, RolloverRequestParameters> { @@ -172,7 +215,10 @@ public RolloverRequestDescriptor NewIndex(Elastic.Clients.Elasticsear private IDictionary? SettingsValue { get; set; } /// - /// Aliases for the target index.
Data streams do not support this parameter. + /// + /// Aliases for the target index. + /// Data streams do not support this parameter. + /// /// public RolloverRequestDescriptor Aliases(Func>, FluentDescriptorDictionary>> selector) { @@ -181,7 +227,13 @@ public RolloverRequestDescriptor Aliases(Func - /// Conditions for the rollover.
If specified, Elasticsearch only performs the rollover if the current index satisfies these conditions.
If this parameter is not specified, Elasticsearch performs the rollover unconditionally.
If conditions are specified, at least one of them must be a `max_*` condition.
The index will rollover if any `max_*` condition is satisfied and all `min_*` conditions are satisfied. + /// + /// Conditions for the rollover. + /// If specified, Elasticsearch only performs the rollover if the current index satisfies these conditions. + /// If this parameter is not specified, Elasticsearch performs the rollover unconditionally. + /// If conditions are specified, at least one of them must be a max_* condition. + /// The index will rollover if any max_* condition is satisfied and all min_* conditions are satisfied. + /// /// public RolloverRequestDescriptor Conditions(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.RolloverConditions? conditions) { @@ -208,7 +260,10 @@ public RolloverRequestDescriptor Conditions(Action - /// Mapping for fields in the index.
If specified, this mapping can include field names, field data types, and mapping paramaters. + /// + /// Mapping for fields in the index. + /// If specified, this mapping can include field names, field data types, and mapping paramaters. + /// /// public RolloverRequestDescriptor Mappings(Elastic.Clients.Elasticsearch.Serverless.Mapping.TypeMapping? mappings) { @@ -235,7 +290,10 @@ public RolloverRequestDescriptor Mappings(Action - /// Configuration options for the index.
Data streams do not support this parameter. + /// + /// Configuration options for the index. + /// Data streams do not support this parameter. + /// /// public RolloverRequestDescriptor Settings(Func, FluentDictionary> selector) { @@ -295,7 +353,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Roll over to a new index.
Creates a new index for a data stream or index alias. +/// +/// Roll over to a new index. +/// Creates a new index for a data stream or index alias. +/// /// public sealed partial class RolloverRequestDescriptor : RequestDescriptor { @@ -344,7 +405,10 @@ public RolloverRequestDescriptor NewIndex(Elastic.Clients.Elasticsearch.Serverle private IDictionary? SettingsValue { get; set; } /// - /// Aliases for the target index.
Data streams do not support this parameter. + /// + /// Aliases for the target index. + /// Data streams do not support this parameter. + /// /// public RolloverRequestDescriptor Aliases(Func, FluentDescriptorDictionary> selector) { @@ -353,7 +417,13 @@ public RolloverRequestDescriptor Aliases(Func - /// Conditions for the rollover.
If specified, Elasticsearch only performs the rollover if the current index satisfies these conditions.
If this parameter is not specified, Elasticsearch performs the rollover unconditionally.
If conditions are specified, at least one of them must be a `max_*` condition.
The index will rollover if any `max_*` condition is satisfied and all `min_*` conditions are satisfied. + /// + /// Conditions for the rollover. + /// If specified, Elasticsearch only performs the rollover if the current index satisfies these conditions. + /// If this parameter is not specified, Elasticsearch performs the rollover unconditionally. + /// If conditions are specified, at least one of them must be a max_* condition. + /// The index will rollover if any max_* condition is satisfied and all min_* conditions are satisfied. + /// /// public RolloverRequestDescriptor Conditions(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.RolloverConditions? conditions) { @@ -380,7 +450,10 @@ public RolloverRequestDescriptor Conditions(Action - /// Mapping for fields in the index.
If specified, this mapping can include field names, field data types, and mapping paramaters. + /// + /// Mapping for fields in the index. + /// If specified, this mapping can include field names, field data types, and mapping paramaters. + /// /// public RolloverRequestDescriptor Mappings(Elastic.Clients.Elasticsearch.Serverless.Mapping.TypeMapping? mappings) { @@ -407,7 +480,10 @@ public RolloverRequestDescriptor Mappings(Action - /// Configuration options for the index.
Data streams do not support this parameter. + /// + /// Configuration options for the index. + /// Data streams do not support this parameter. + /// /// public RolloverRequestDescriptor Settings(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/SegmentsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/SegmentsRequest.g.cs index 08d029c66c8..2f68f3a4ec4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/SegmentsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/SegmentsRequest.g.cs @@ -32,28 +32,43 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class SegmentsRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, the request returns a verbose response. + /// + /// If true, the request returns a verbose response. + /// /// public bool? Verbose { get => Q("verbose"); set => Q("verbose", value); } } /// -/// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. +/// +/// Returns low-level information about the Lucene segments in index shards. +/// For data streams, the API returns information about the stream’s backing indices. +/// /// public sealed partial class SegmentsRequest : PlainRequest { @@ -74,32 +89,47 @@ public SegmentsRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? indices internal override string OperationName => "indices.segments"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, the request returns a verbose response. + /// + /// If true, the request returns a verbose response. + /// /// [JsonIgnore] public bool? Verbose { get => Q("verbose"); set => Q("verbose", value); } } /// -/// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. +/// +/// Returns low-level information about the Lucene segments in index shards. +/// For data streams, the API returns information about the stream’s backing indices. +/// /// public sealed partial class SegmentsRequestDescriptor : RequestDescriptor, SegmentsRequestParameters> { @@ -138,7 +168,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. +/// +/// Returns low-level information about the Lucene segments in index shards. +/// For data streams, the API returns information about the stream’s backing indices. +/// /// public sealed partial class SegmentsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/SimulateIndexTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/SimulateIndexTemplateRequest.g.cs index 671fac8b7f5..7e77705f613 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/SimulateIndexTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/SimulateIndexTemplateRequest.g.cs @@ -32,18 +32,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class SimulateIndexTemplateRequestParameters : RequestParameters { /// - /// If true, returns all relevant default configurations for the index template. + /// + /// If true, returns all relevant default configurations for the index template. + /// /// public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Simulate an index.
Returns the index configuration that would be applied to the specified index from an existing index template. +/// +/// Simulate an index. +/// Returns the index configuration that would be applied to the specified index from an existing index template. +/// /// public sealed partial class SimulateIndexTemplateRequest : PlainRequest { @@ -60,20 +67,27 @@ public SimulateIndexTemplateRequest(Elastic.Clients.Elasticsearch.Serverless.Nam internal override string OperationName => "indices.simulate_index_template"; /// - /// If true, returns all relevant default configurations for the index template. + /// + /// If true, returns all relevant default configurations for the index template. + /// /// [JsonIgnore] public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Simulate an index.
Returns the index configuration that would be applied to the specified index from an existing index template. +/// +/// Simulate an index. +/// Returns the index configuration that would be applied to the specified index from an existing index template. +/// /// public sealed partial class SimulateIndexTemplateRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/SimulateTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/SimulateTemplateRequest.g.cs index 149b96a6610..d2221056b69 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/SimulateTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/SimulateTemplateRequest.g.cs @@ -32,23 +32,32 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class SimulateTemplateRequestParameters : RequestParameters { /// - /// If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation. + /// + /// If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation. + /// /// public bool? Create { get => Q("create"); set => Q("create", value); } /// - /// If true, returns all relevant default configurations for the index template. + /// + /// If true, returns all relevant default configurations for the index template. + /// /// public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. +/// +/// Simulate an index template. +/// Returns the index configuration that would be applied by a particular index template. +/// /// public sealed partial class SimulateTemplateRequest : PlainRequest { @@ -69,86 +78,129 @@ public SimulateTemplateRequest(Elastic.Clients.Elasticsearch.Serverless.Name? na internal override string OperationName => "indices.simulate_template"; /// - /// If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation. + /// + /// If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation. + /// /// [JsonIgnore] public bool? Create { get => Q("create"); set => Q("create", value); } /// - /// If true, returns all relevant default configurations for the index template. + /// + /// If true, returns all relevant default configurations for the index template. + /// /// [JsonIgnore] public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// This setting overrides the value of the `action.auto_create_index` cluster setting.
If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.
If set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + /// + /// This setting overrides the value of the action.auto_create_index cluster setting. + /// If set to true in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via actions.auto_create_index. + /// If set to false, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + /// /// [JsonInclude, JsonPropertyName("allow_auto_create")] public bool? AllowAutoCreate { get; set; } /// - /// An ordered list of component template names.
Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// + /// An ordered list of component template names. + /// Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// /// [JsonInclude, JsonPropertyName("composed_of")] public ICollection? ComposedOf { get; set; } /// - /// If this object is included, the template is used to create data streams and their backing indices.
Supports an empty object.
Data streams require a matching index template with a `data_stream` object. + /// + /// If this object is included, the template is used to create data streams and their backing indices. + /// Supports an empty object. + /// Data streams require a matching index template with a data_stream object. + /// /// [JsonInclude, JsonPropertyName("data_stream")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamVisibility? DataStream { get; set; } /// - /// Marks this index template as deprecated. When creating or updating a non-deprecated index template
that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// + /// Marks this index template as deprecated. When creating or updating a non-deprecated index template + /// that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// /// [JsonInclude, JsonPropertyName("deprecated")] public bool? Deprecated { get; set; } /// - /// The configuration option ignore_missing_component_templates can be used when an index template
references a component template that might not exist + /// + /// The configuration option ignore_missing_component_templates can be used when an index template + /// references a component template that might not exist + /// /// [JsonInclude, JsonPropertyName("ignore_missing_component_templates")] public ICollection? IgnoreMissingComponentTemplates { get; set; } /// - /// Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation. + /// + /// Array of wildcard (*) expressions used to match the names of data streams and indices during creation. + /// /// [JsonInclude, JsonPropertyName("index_patterns")] public Elastic.Clients.Elasticsearch.Serverless.Indices? IndexPatterns { get; set; } /// - /// Optional user metadata about the index template.
May have any contents.
This map is not automatically generated by Elasticsearch. + /// + /// Optional user metadata about the index template. + /// May have any contents. + /// This map is not automatically generated by Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("_meta")] public IDictionary? Meta { get; set; } /// - /// Priority to determine index template precedence when a new data stream or index is created.
The index template with the highest priority is chosen.
If no priority is specified the template is treated as though it is of priority 0 (lowest priority).
This number is not automatically generated by Elasticsearch. + /// + /// Priority to determine index template precedence when a new data stream or index is created. + /// The index template with the highest priority is chosen. + /// If no priority is specified the template is treated as though it is of priority 0 (lowest priority). + /// This number is not automatically generated by Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("priority")] public long? Priority { get; set; } /// - /// Template to be applied.
It may optionally include an `aliases`, `mappings`, or `settings` configuration. + /// + /// Template to be applied. + /// It may optionally include an aliases, mappings, or settings configuration. + /// /// [JsonInclude, JsonPropertyName("template")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexTemplateMapping? Template { get; set; } /// - /// Version number used to manage index templates externally.
This number is not automatically generated by Elasticsearch. + /// + /// Version number used to manage index templates externally. + /// This number is not automatically generated by Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("version")] public long? Version { get; set; } } /// -/// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. +/// +/// Simulate an index template. +/// Returns the index configuration that would be applied by a particular index template. +/// /// public sealed partial class SimulateTemplateRequestDescriptor : RequestDescriptor, SimulateTemplateRequestParameters> { @@ -196,7 +248,11 @@ public SimulateTemplateRequestDescriptor Name(Elastic.Clients.Elastic private long? VersionValue { get; set; } /// - /// This setting overrides the value of the `action.auto_create_index` cluster setting.
If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.
If set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + /// + /// This setting overrides the value of the action.auto_create_index cluster setting. + /// If set to true in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via actions.auto_create_index. + /// If set to false, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + /// /// public SimulateTemplateRequestDescriptor AllowAutoCreate(bool? allowAutoCreate = true) { @@ -205,7 +261,10 @@ public SimulateTemplateRequestDescriptor AllowAutoCreate(bool? allowA } /// - /// An ordered list of component template names.
Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// + /// An ordered list of component template names. + /// Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// /// public SimulateTemplateRequestDescriptor ComposedOf(ICollection? composedOf) { @@ -214,7 +273,11 @@ public SimulateTemplateRequestDescriptor ComposedOf(ICollection - /// If this object is included, the template is used to create data streams and their backing indices.
Supports an empty object.
Data streams require a matching index template with a `data_stream` object. + /// + /// If this object is included, the template is used to create data streams and their backing indices. + /// Supports an empty object. + /// Data streams require a matching index template with a data_stream object. + /// /// public SimulateTemplateRequestDescriptor DataStream(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamVisibility? dataStream) { @@ -241,7 +304,10 @@ public SimulateTemplateRequestDescriptor DataStream(Action - /// Marks this index template as deprecated. When creating or updating a non-deprecated index template
that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// + /// Marks this index template as deprecated. When creating or updating a non-deprecated index template + /// that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// /// public SimulateTemplateRequestDescriptor Deprecated(bool? deprecated = true) { @@ -250,7 +316,10 @@ public SimulateTemplateRequestDescriptor Deprecated(bool? deprecated } /// - /// The configuration option ignore_missing_component_templates can be used when an index template
references a component template that might not exist + /// + /// The configuration option ignore_missing_component_templates can be used when an index template + /// references a component template that might not exist + /// /// public SimulateTemplateRequestDescriptor IgnoreMissingComponentTemplates(ICollection? ignoreMissingComponentTemplates) { @@ -259,7 +328,9 @@ public SimulateTemplateRequestDescriptor IgnoreMissingComponentTempla } /// - /// Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation. + /// + /// Array of wildcard (*) expressions used to match the names of data streams and indices during creation. + /// /// public SimulateTemplateRequestDescriptor IndexPatterns(Elastic.Clients.Elasticsearch.Serverless.Indices? indexPatterns) { @@ -268,7 +339,11 @@ public SimulateTemplateRequestDescriptor IndexPatterns(Elastic.Client } /// - /// Optional user metadata about the index template.
May have any contents.
This map is not automatically generated by Elasticsearch. + /// + /// Optional user metadata about the index template. + /// May have any contents. + /// This map is not automatically generated by Elasticsearch. + /// /// public SimulateTemplateRequestDescriptor Meta(Func, FluentDictionary> selector) { @@ -277,7 +352,12 @@ public SimulateTemplateRequestDescriptor Meta(Func - /// Priority to determine index template precedence when a new data stream or index is created.
The index template with the highest priority is chosen.
If no priority is specified the template is treated as though it is of priority 0 (lowest priority).
This number is not automatically generated by Elasticsearch. + /// + /// Priority to determine index template precedence when a new data stream or index is created. + /// The index template with the highest priority is chosen. + /// If no priority is specified the template is treated as though it is of priority 0 (lowest priority). + /// This number is not automatically generated by Elasticsearch. + /// /// public SimulateTemplateRequestDescriptor Priority(long? priority) { @@ -286,7 +366,10 @@ public SimulateTemplateRequestDescriptor Priority(long? priority) } /// - /// Template to be applied.
It may optionally include an `aliases`, `mappings`, or `settings` configuration. + /// + /// Template to be applied. + /// It may optionally include an aliases, mappings, or settings configuration. + /// /// public SimulateTemplateRequestDescriptor Template(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexTemplateMapping? template) { @@ -313,7 +396,10 @@ public SimulateTemplateRequestDescriptor Template(Action - /// Version number used to manage index templates externally.
This number is not automatically generated by Elasticsearch. + /// + /// Version number used to manage index templates externally. + /// This number is not automatically generated by Elasticsearch. + /// /// public SimulateTemplateRequestDescriptor Version(long? version) { @@ -409,7 +495,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. +/// +/// Simulate an index template. +/// Returns the index configuration that would be applied by a particular index template. +/// /// public sealed partial class SimulateTemplateRequestDescriptor : RequestDescriptor { @@ -457,7 +546,11 @@ public SimulateTemplateRequestDescriptor Name(Elastic.Clients.Elasticsearch.Serv private long? VersionValue { get; set; } /// - /// This setting overrides the value of the `action.auto_create_index` cluster setting.
If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.
If set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + /// + /// This setting overrides the value of the action.auto_create_index cluster setting. + /// If set to true in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via actions.auto_create_index. + /// If set to false, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + /// /// public SimulateTemplateRequestDescriptor AllowAutoCreate(bool? allowAutoCreate = true) { @@ -466,7 +559,10 @@ public SimulateTemplateRequestDescriptor AllowAutoCreate(bool? allowAutoCreate = } /// - /// An ordered list of component template names.
Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// + /// An ordered list of component template names. + /// Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// /// public SimulateTemplateRequestDescriptor ComposedOf(ICollection? composedOf) { @@ -475,7 +571,11 @@ public SimulateTemplateRequestDescriptor ComposedOf(ICollection - /// If this object is included, the template is used to create data streams and their backing indices.
Supports an empty object.
Data streams require a matching index template with a `data_stream` object. + /// + /// If this object is included, the template is used to create data streams and their backing indices. + /// Supports an empty object. + /// Data streams require a matching index template with a data_stream object. + /// /// public SimulateTemplateRequestDescriptor DataStream(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamVisibility? dataStream) { @@ -502,7 +602,10 @@ public SimulateTemplateRequestDescriptor DataStream(Action - /// Marks this index template as deprecated. When creating or updating a non-deprecated index template
that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// + /// Marks this index template as deprecated. When creating or updating a non-deprecated index template + /// that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// /// public SimulateTemplateRequestDescriptor Deprecated(bool? deprecated = true) { @@ -511,7 +614,10 @@ public SimulateTemplateRequestDescriptor Deprecated(bool? deprecated = true) } /// - /// The configuration option ignore_missing_component_templates can be used when an index template
references a component template that might not exist + /// + /// The configuration option ignore_missing_component_templates can be used when an index template + /// references a component template that might not exist + /// /// public SimulateTemplateRequestDescriptor IgnoreMissingComponentTemplates(ICollection? ignoreMissingComponentTemplates) { @@ -520,7 +626,9 @@ public SimulateTemplateRequestDescriptor IgnoreMissingComponentTemplates(ICollec } /// - /// Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation. + /// + /// Array of wildcard (*) expressions used to match the names of data streams and indices during creation. + /// /// public SimulateTemplateRequestDescriptor IndexPatterns(Elastic.Clients.Elasticsearch.Serverless.Indices? indexPatterns) { @@ -529,7 +637,11 @@ public SimulateTemplateRequestDescriptor IndexPatterns(Elastic.Clients.Elasticse } /// - /// Optional user metadata about the index template.
May have any contents.
This map is not automatically generated by Elasticsearch. + /// + /// Optional user metadata about the index template. + /// May have any contents. + /// This map is not automatically generated by Elasticsearch. + /// /// public SimulateTemplateRequestDescriptor Meta(Func, FluentDictionary> selector) { @@ -538,7 +650,12 @@ public SimulateTemplateRequestDescriptor Meta(Func - /// Priority to determine index template precedence when a new data stream or index is created.
The index template with the highest priority is chosen.
If no priority is specified the template is treated as though it is of priority 0 (lowest priority).
This number is not automatically generated by Elasticsearch. + /// + /// Priority to determine index template precedence when a new data stream or index is created. + /// The index template with the highest priority is chosen. + /// If no priority is specified the template is treated as though it is of priority 0 (lowest priority). + /// This number is not automatically generated by Elasticsearch. + /// /// public SimulateTemplateRequestDescriptor Priority(long? priority) { @@ -547,7 +664,10 @@ public SimulateTemplateRequestDescriptor Priority(long? priority) } /// - /// Template to be applied.
It may optionally include an `aliases`, `mappings`, or `settings` configuration. + /// + /// Template to be applied. + /// It may optionally include an aliases, mappings, or settings configuration. + /// /// public SimulateTemplateRequestDescriptor Template(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexTemplateMapping? template) { @@ -574,7 +694,10 @@ public SimulateTemplateRequestDescriptor Template(Action - /// Version number used to manage index templates externally.
This number is not automatically generated by Elasticsearch. + /// + /// Version number used to manage index templates externally. + /// This number is not automatically generated by Elasticsearch. + /// /// public SimulateTemplateRequestDescriptor Version(long? version) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/UpdateAliasesRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/UpdateAliasesRequest.g.cs index 4354468d5b7..5a97ea06129 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/UpdateAliasesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/UpdateAliasesRequest.g.cs @@ -32,18 +32,27 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class UpdateAliasesRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Create or update an alias.
Adds a data stream or index to an alias. +/// +/// Create or update an alias. +/// Adds a data stream or index to an alias. +/// /// public sealed partial class UpdateAliasesRequest : PlainRequest { @@ -56,26 +65,37 @@ public sealed partial class UpdateAliasesRequest : PlainRequest "indices.update_aliases"; /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Actions to perform. + /// + /// Actions to perform. + /// /// [JsonInclude, JsonPropertyName("actions")] public ICollection? Actions { get; set; } } /// -/// Create or update an alias.
Adds a data stream or index to an alias. +/// +/// Create or update an alias. +/// Adds a data stream or index to an alias. +/// /// public sealed partial class UpdateAliasesRequestDescriptor : RequestDescriptor, UpdateAliasesRequestParameters> { @@ -102,7 +122,9 @@ public UpdateAliasesRequestDescriptor() private Action>[] ActionsDescriptorActions { get; set; } /// - /// Actions to perform. + /// + /// Actions to perform. + /// /// public UpdateAliasesRequestDescriptor Actions(ICollection? actions) { @@ -179,7 +201,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Create or update an alias.
Adds a data stream or index to an alias. +/// +/// Create or update an alias. +/// Adds a data stream or index to an alias. +/// /// public sealed partial class UpdateAliasesRequestDescriptor : RequestDescriptor { @@ -206,7 +231,9 @@ public UpdateAliasesRequestDescriptor() private Action[] ActionsDescriptorActions { get; set; } /// - /// Actions to perform. + /// + /// Actions to perform. + /// /// public UpdateAliasesRequestDescriptor Actions(ICollection? actions) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/UpdateAliasesResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/UpdateAliasesResponse.g.cs index 123fd553f85..cca0075dcba 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/UpdateAliasesResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/UpdateAliasesResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class UpdateAliasesResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ValidateQueryRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ValidateQueryRequest.g.cs index aacb946b0e4..fab104b5d0b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ValidateQueryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ValidateQueryRequest.g.cs @@ -32,68 +32,101 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class ValidateQueryRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// If `true`, the validation is executed on all shards instead of one random shard per index. + /// + /// If true, the validation is executed on all shards instead of one random shard per index. + /// /// public bool? AllShards { get => Q("all_shards"); set => Q("all_shards", value); } /// - /// Analyzer to use for the query string.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// Analyzer to use for the query string. + /// This parameter can only be used when the q query string parameter is specified. + /// /// public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// - /// If `true`, wildcard and prefix queries are analyzed. + /// + /// If true, wildcard and prefix queries are analyzed. + /// /// public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } /// - /// The default operator for query string query: `AND` or `OR`. + /// + /// The default operator for query string query: AND or OR. + /// /// public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } /// - /// Field to use as default where no field prefix is given in the query string.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// Field to use as default where no field prefix is given in the query string. + /// This parameter can only be used when the q query string parameter is specified. + /// /// public string? Df { get => Q("df"); set => Q("df", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, the response returns detailed information if an error has occurred. + /// + /// If true, the response returns detailed information if an error has occurred. + /// /// public bool? Explain { get => Q("explain"); set => Q("explain", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// + /// If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// /// public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// - /// Query in the Lucene query string syntax. + /// + /// Query in the Lucene query string syntax. + /// /// public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } /// - /// If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed. + /// + /// If true, returns a more detailed explanation showing the actual Lucene query that will be executed. + /// /// public bool? Rewrite { get => Q("rewrite"); set => Q("rewrite", value); } } /// -/// Validate a query.
Validates a query without running it. +/// +/// Validate a query. +/// Validates a query without running it. +/// /// public sealed partial class ValidateQueryRequest : PlainRequest { @@ -114,86 +147,121 @@ public ValidateQueryRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? in internal override string OperationName => "indices.validate_query"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// If `true`, the validation is executed on all shards instead of one random shard per index. + /// + /// If true, the validation is executed on all shards instead of one random shard per index. + /// /// [JsonIgnore] public bool? AllShards { get => Q("all_shards"); set => Q("all_shards", value); } /// - /// Analyzer to use for the query string.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// Analyzer to use for the query string. + /// This parameter can only be used when the q query string parameter is specified. + /// /// [JsonIgnore] public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// - /// If `true`, wildcard and prefix queries are analyzed. + /// + /// If true, wildcard and prefix queries are analyzed. + /// /// [JsonIgnore] public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } /// - /// The default operator for query string query: `AND` or `OR`. + /// + /// The default operator for query string query: AND or OR. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } /// - /// Field to use as default where no field prefix is given in the query string.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// Field to use as default where no field prefix is given in the query string. + /// This parameter can only be used when the q query string parameter is specified. + /// /// [JsonIgnore] public string? Df { get => Q("df"); set => Q("df", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, the response returns detailed information if an error has occurred. + /// + /// If true, the response returns detailed information if an error has occurred. + /// /// [JsonIgnore] public bool? Explain { get => Q("explain"); set => Q("explain", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// + /// If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// /// [JsonIgnore] public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// - /// Query in the Lucene query string syntax. + /// + /// Query in the Lucene query string syntax. + /// /// [JsonIgnore] public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } /// - /// If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed. + /// + /// If true, returns a more detailed explanation showing the actual Lucene query that will be executed. + /// /// [JsonIgnore] public bool? Rewrite { get => Q("rewrite"); set => Q("rewrite", value); } /// - /// Query in the Lucene query string syntax. + /// + /// Query in the Lucene query string syntax. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? Query { get; set; } } /// -/// Validate a query.
Validates a query without running it. +/// +/// Validate a query. +/// Validates a query without running it. +/// /// public sealed partial class ValidateQueryRequestDescriptor : RequestDescriptor, ValidateQueryRequestParameters> { @@ -239,7 +307,9 @@ public ValidateQueryRequestDescriptor Indices(Elastic.Clients.Elastic private Action> QueryDescriptorAction { get; set; } /// - /// Query in the Lucene query string syntax. + /// + /// Query in the Lucene query string syntax. + /// /// public ValidateQueryRequestDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -289,7 +359,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Validate a query.
Validates a query without running it. +/// +/// Validate a query. +/// Validates a query without running it. +/// /// public sealed partial class ValidateQueryRequestDescriptor : RequestDescriptor { @@ -335,7 +408,9 @@ public ValidateQueryRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Serv private Action QueryDescriptorAction { get; set; } /// - /// Query in the Lucene query string syntax. + /// + /// Query in the Lucene query string syntax. + /// /// public ValidateQueryRequestDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexRequest.g.cs index 92cde6906fd..b4a45e8a2a4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexRequest.g.cs @@ -32,63 +32,99 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class IndexRequestParameters : RequestParameters { /// - /// Only perform the operation if the document has this primary term. + /// + /// Only perform the operation if the document has this primary term. + /// /// public long? IfPrimaryTerm { get => Q("if_primary_term"); set => Q("if_primary_term", value); } /// - /// Only perform the operation if the document has this sequence number. + /// + /// Only perform the operation if the document has this sequence number. + /// /// public long? IfSeqNo { get => Q("if_seq_no"); set => Q("if_seq_no", value); } /// - /// Set to create to only index the document if it does not already exist (put if absent).
If a document with the specified `_id` already exists, the indexing operation will fail.
Same as using the `/_create` endpoint.
Valid values: `index`, `create`.
If document id is specified, it defaults to `index`.
Otherwise, it defaults to `create`. + /// + /// Set to create to only index the document if it does not already exist (put if absent). + /// If a document with the specified _id already exists, the indexing operation will fail. + /// Same as using the <index>/_create endpoint. + /// Valid values: index, create. + /// If document id is specified, it defaults to index. + /// Otherwise, it defaults to create. + /// /// public Elastic.Clients.Elasticsearch.Serverless.OpType? OpType { get => Q("op_type"); set => Q("op_type", value); } /// - /// ID of the pipeline to use to preprocess incoming documents.
If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.
If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// + /// ID of the pipeline to use to preprocess incoming documents. + /// If the index has a default ingest pipeline specified, then setting the value to _none disables the default ingest pipeline for this request. + /// If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// /// public string? Pipeline { get => Q("pipeline"); set => Q("pipeline", value); } /// - /// If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.
Valid values: `true`, `false`, `wait_for`. + /// + /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false do nothing with refreshes. + /// Valid values: true, false, wait_for. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Refresh? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// If `true`, the destination must be an index alias. + /// + /// If true, the destination must be an index alias. + /// /// public bool? RequireAlias { get => Q("require_alias"); set => Q("require_alias", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. + /// + /// Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Explicit version number for concurrency control.
The specified version must match the current version of the document for the request to succeed. + /// + /// Explicit version number for concurrency control. + /// The specified version must match the current version of the document for the request to succeed. + /// /// public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type: `external`, `external_gte`. + /// + /// Specific version type: external, external_gte. + /// /// public Elastic.Clients.Elasticsearch.Serverless.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// public Elastic.Clients.Elasticsearch.Serverless.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. +/// +/// Index a document. +/// Adds a JSON document to the specified data stream or index and makes it searchable. +/// If the target is an index and the document already exists, the request updates the document and increments its version. +/// /// public sealed partial class IndexRequest : PlainRequest, ISelfSerializable { @@ -109,67 +145,99 @@ public IndexRequest(Elastic.Clients.Elasticsearch.Serverless.IndexName index) : internal override string OperationName => "index"; /// - /// Only perform the operation if the document has this primary term. + /// + /// Only perform the operation if the document has this primary term. + /// /// [JsonIgnore] public long? IfPrimaryTerm { get => Q("if_primary_term"); set => Q("if_primary_term", value); } /// - /// Only perform the operation if the document has this sequence number. + /// + /// Only perform the operation if the document has this sequence number. + /// /// [JsonIgnore] public long? IfSeqNo { get => Q("if_seq_no"); set => Q("if_seq_no", value); } /// - /// Set to create to only index the document if it does not already exist (put if absent).
If a document with the specified `_id` already exists, the indexing operation will fail.
Same as using the `/_create` endpoint.
Valid values: `index`, `create`.
If document id is specified, it defaults to `index`.
Otherwise, it defaults to `create`. + /// + /// Set to create to only index the document if it does not already exist (put if absent). + /// If a document with the specified _id already exists, the indexing operation will fail. + /// Same as using the <index>/_create endpoint. + /// Valid values: index, create. + /// If document id is specified, it defaults to index. + /// Otherwise, it defaults to create. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.OpType? OpType { get => Q("op_type"); set => Q("op_type", value); } /// - /// ID of the pipeline to use to preprocess incoming documents.
If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.
If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// + /// ID of the pipeline to use to preprocess incoming documents. + /// If the index has a default ingest pipeline specified, then setting the value to _none disables the default ingest pipeline for this request. + /// If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// /// [JsonIgnore] public string? Pipeline { get => Q("pipeline"); set => Q("pipeline", value); } /// - /// If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.
Valid values: `true`, `false`, `wait_for`. + /// + /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false do nothing with refreshes. + /// Valid values: true, false, wait_for. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Refresh? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// If `true`, the destination must be an index alias. + /// + /// If true, the destination must be an index alias. + /// /// [JsonIgnore] public bool? RequireAlias { get => Q("require_alias"); set => Q("require_alias", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. + /// + /// Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Explicit version number for concurrency control.
The specified version must match the current version of the document for the request to succeed. + /// + /// Explicit version number for concurrency control. + /// The specified version must match the current version of the document for the request to succeed. + /// /// [JsonIgnore] public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type: `external`, `external_gte`. + /// + /// Specific version type: external, external_gte. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } @@ -183,7 +251,11 @@ void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions op } /// -/// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. +/// +/// Index a document. +/// Adds a JSON document to the specified data stream or index and makes it searchable. +/// If the target is an index and the document already exists, the request updates the document and increments its version. +/// /// public sealed partial class IndexRequestDescriptor : RequestDescriptor, IndexRequestParameters> { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/InfoRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/InfoRequest.g.cs index ec0ac8abe93..5f2c5c58308 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/InfoRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/InfoRequest.g.cs @@ -34,7 +34,10 @@ public sealed partial class InfoRequestParameters : RequestParameters } /// -/// Get cluster info.
Returns basic information about the cluster. +/// +/// Get cluster info. +/// Returns basic information about the cluster. +/// /// public sealed partial class InfoRequest : PlainRequest { @@ -48,7 +51,10 @@ public sealed partial class InfoRequest : PlainRequest } /// -/// Get cluster info.
Returns basic information about the cluster. +/// +/// Get cluster info. +/// Returns basic information about the cluster. +/// /// public sealed partial class InfoRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/DeletePipelineRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/DeletePipelineRequest.g.cs index 465021f8ed6..ce25577c563 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/DeletePipelineRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/DeletePipelineRequest.g.cs @@ -32,18 +32,26 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class DeletePipelineRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Deletes one or more existing ingest pipeline. +/// +/// Deletes one or more existing ingest pipeline. +/// /// public sealed partial class DeletePipelineRequest : PlainRequest { @@ -60,20 +68,28 @@ public DeletePipelineRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : b internal override string OperationName => "ingest.delete_pipeline"; /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Deletes one or more existing ingest pipeline. +/// +/// Deletes one or more existing ingest pipeline. +/// /// public sealed partial class DeletePipelineRequestDescriptor : RequestDescriptor, DeletePipelineRequestParameters> { @@ -106,7 +122,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Deletes one or more existing ingest pipeline. +/// +/// Deletes one or more existing ingest pipeline. +/// /// public sealed partial class DeletePipelineRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/DeletePipelineResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/DeletePipelineResponse.g.cs index 88713347b96..a607d2fedf7 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/DeletePipelineResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/DeletePipelineResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class DeletePipelineResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/GeoIpStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/GeoIpStatsRequest.g.cs index b55ef74a491..5c504e1a06a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/GeoIpStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/GeoIpStatsRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class GeoIpStatsRequestParameters : RequestParameters } /// -/// Gets download statistics for GeoIP2 databases used with the geoip processor. +/// +/// Gets download statistics for GeoIP2 databases used with the geoip processor. +/// /// public sealed partial class GeoIpStatsRequest : PlainRequest { @@ -48,7 +50,9 @@ public sealed partial class GeoIpStatsRequest : PlainRequest -/// Gets download statistics for GeoIP2 databases used with the geoip processor. +/// +/// Gets download statistics for GeoIP2 databases used with the geoip processor. +/// /// public sealed partial class GeoIpStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/GeoIpStatsResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/GeoIpStatsResponse.g.cs index 07620f34dcf..cf6f1342cd0 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/GeoIpStatsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/GeoIpStatsResponse.g.cs @@ -29,13 +29,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class GeoIpStatsResponse : ElasticsearchResponse { /// - /// Downloaded GeoIP2 databases for each node. + /// + /// Downloaded GeoIP2 databases for each node. + /// /// [JsonInclude, JsonPropertyName("nodes")] public IReadOnlyDictionary Nodes { get; init; } /// - /// Download statistics for all GeoIP2 databases. + /// + /// Download statistics for all GeoIP2 databases. + /// /// [JsonInclude, JsonPropertyName("stats")] public Elastic.Clients.Elasticsearch.Serverless.Ingest.GeoIpDownloadStatistics Stats { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/GetPipelineRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/GetPipelineRequest.g.cs index fbc44a5ba26..1eaa9de7745 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/GetPipelineRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/GetPipelineRequest.g.cs @@ -32,18 +32,26 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class GetPipelineRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Return pipelines without their definitions (default: false) + /// + /// Return pipelines without their definitions (default: false) + /// /// public bool? Summary { get => Q("summary"); set => Q("summary", value); } } /// -/// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. +/// +/// Returns information about one or more ingest pipelines. +/// This API returns a local reference of the pipeline. +/// /// public sealed partial class GetPipelineRequest : PlainRequest { @@ -64,20 +72,28 @@ public GetPipelineRequest(Elastic.Clients.Elasticsearch.Serverless.Id? id) : bas internal override string OperationName => "ingest.get_pipeline"; /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Return pipelines without their definitions (default: false) + /// + /// Return pipelines without their definitions (default: false) + /// /// [JsonIgnore] public bool? Summary { get => Q("summary"); set => Q("summary", value); } } /// -/// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. +/// +/// Returns information about one or more ingest pipelines. +/// This API returns a local reference of the pipeline. +/// /// public sealed partial class GetPipelineRequestDescriptor : RequestDescriptor, GetPipelineRequestParameters> { @@ -114,7 +130,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. +/// +/// Returns information about one or more ingest pipelines. +/// This API returns a local reference of the pipeline. +/// /// public sealed partial class GetPipelineRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/ProcessorGrokRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/ProcessorGrokRequest.g.cs index 4ca0d681e12..40ea0fdd310 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/ProcessorGrokRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/ProcessorGrokRequest.g.cs @@ -34,7 +34,11 @@ public sealed partial class ProcessorGrokRequestParameters : RequestParameters } /// -/// Extracts structured fields out of a single text field within a document.
You choose which field to extract matched fields from, as well as the grok pattern you expect will match.
A grok pattern is like a regular expression that supports aliased expressions that can be reused. +/// +/// Extracts structured fields out of a single text field within a document. +/// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. +/// A grok pattern is like a regular expression that supports aliased expressions that can be reused. +/// /// public sealed partial class ProcessorGrokRequest : PlainRequest { @@ -48,7 +52,11 @@ public sealed partial class ProcessorGrokRequest : PlainRequest -/// Extracts structured fields out of a single text field within a document.
You choose which field to extract matched fields from, as well as the grok pattern you expect will match.
A grok pattern is like a regular expression that supports aliased expressions that can be reused. +/// +/// Extracts structured fields out of a single text field within a document. +/// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. +/// A grok pattern is like a regular expression that supports aliased expressions that can be reused. +/// /// public sealed partial class ProcessorGrokRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/PutPipelineRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/PutPipelineRequest.g.cs index 18ca0dfa72c..f4488ec31d1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/PutPipelineRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/PutPipelineRequest.g.cs @@ -32,23 +32,32 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class PutPipelineRequestParameters : RequestParameters { /// - /// Required version for optimistic concurrency control for pipeline updates + /// + /// Required version for optimistic concurrency control for pipeline updates + /// /// public long? IfVersion { get => Q("if_version"); set => Q("if_version", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Creates or updates an ingest pipeline.
Changes made using this API take effect immediately. +/// +/// Creates or updates an ingest pipeline. +/// Changes made using this API take effect immediately. +/// /// public sealed partial class PutPipelineRequest : PlainRequest { @@ -65,56 +74,75 @@ public PutPipelineRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : base internal override string OperationName => "ingest.put_pipeline"; /// - /// Required version for optimistic concurrency control for pipeline updates + /// + /// Required version for optimistic concurrency control for pipeline updates + /// /// [JsonIgnore] public long? IfVersion { get => Q("if_version"); set => Q("if_version", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Description of the ingest pipeline. + /// + /// Description of the ingest pipeline. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch. + /// + /// Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("_meta")] public IDictionary? Meta { get; set; } /// - /// Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors. + /// + /// Processors to run immediately after a processor failure. Each processor supports a processor-level on_failure value. If a processor without an on_failure value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. + /// + /// Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. + /// /// [JsonInclude, JsonPropertyName("processors")] public ICollection? Processors { get; set; } /// - /// Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers. + /// + /// Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers. + /// /// [JsonInclude, JsonPropertyName("version")] public long? Version { get; set; } } /// -/// Creates or updates an ingest pipeline.
Changes made using this API take effect immediately. +/// +/// Creates or updates an ingest pipeline. +/// Changes made using this API take effect immediately. +/// /// public sealed partial class PutPipelineRequestDescriptor : RequestDescriptor, PutPipelineRequestParameters> { @@ -155,7 +183,9 @@ public PutPipelineRequestDescriptor Id(Elastic.Clients.Elasticsearch. private long? VersionValue { get; set; } /// - /// Description of the ingest pipeline. + /// + /// Description of the ingest pipeline. + /// /// public PutPipelineRequestDescriptor Description(string? description) { @@ -164,7 +194,9 @@ public PutPipelineRequestDescriptor Description(string? description) } /// - /// Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch. + /// + /// Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch. + /// /// public PutPipelineRequestDescriptor Meta(Func, FluentDictionary> selector) { @@ -173,7 +205,9 @@ public PutPipelineRequestDescriptor Meta(Func - /// Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors. + /// + /// Processors to run immediately after a processor failure. Each processor supports a processor-level on_failure value. If a processor without an on_failure value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors. + /// /// public PutPipelineRequestDescriptor OnFailure(ICollection? onFailure) { @@ -212,7 +246,9 @@ public PutPipelineRequestDescriptor OnFailure(params Action - /// Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. + /// + /// Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. + /// /// public PutPipelineRequestDescriptor Processors(ICollection? processors) { @@ -251,7 +287,9 @@ public PutPipelineRequestDescriptor Processors(params Action - /// Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers. + /// + /// Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers. + /// /// public PutPipelineRequestDescriptor Version(long? version) { @@ -347,7 +385,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Creates or updates an ingest pipeline.
Changes made using this API take effect immediately. +/// +/// Creates or updates an ingest pipeline. +/// Changes made using this API take effect immediately. +/// /// public sealed partial class PutPipelineRequestDescriptor : RequestDescriptor { @@ -388,7 +429,9 @@ public PutPipelineRequestDescriptor Id(Elastic.Clients.Elasticsearch.Serverless. private long? VersionValue { get; set; } /// - /// Description of the ingest pipeline. + /// + /// Description of the ingest pipeline. + /// /// public PutPipelineRequestDescriptor Description(string? description) { @@ -397,7 +440,9 @@ public PutPipelineRequestDescriptor Description(string? description) } /// - /// Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch. + /// + /// Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch. + /// /// public PutPipelineRequestDescriptor Meta(Func, FluentDictionary> selector) { @@ -406,7 +451,9 @@ public PutPipelineRequestDescriptor Meta(Func, } /// - /// Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors. + /// + /// Processors to run immediately after a processor failure. Each processor supports a processor-level on_failure value. If a processor without an on_failure value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors. + /// /// public PutPipelineRequestDescriptor OnFailure(ICollection? onFailure) { @@ -445,7 +492,9 @@ public PutPipelineRequestDescriptor OnFailure(params Action - /// Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. + /// + /// Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. + /// /// public PutPipelineRequestDescriptor Processors(ICollection? processors) { @@ -484,7 +533,9 @@ public PutPipelineRequestDescriptor Processors(params Action - /// Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers. + /// + /// Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers. + /// /// public PutPipelineRequestDescriptor Version(long? version) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/PutPipelineResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/PutPipelineResponse.g.cs index 35ad144f489..1e248573d0c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/PutPipelineResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/PutPipelineResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class PutPipelineResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/SimulateRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/SimulateRequest.g.cs index 8ca79dd6b5b..0d7136e3177 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/SimulateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/SimulateRequest.g.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class SimulateRequestParameters : RequestParameters { /// - /// If `true`, the response includes output data for each processor in the executed pipeline. + /// + /// If true, the response includes output data for each processor in the executed pipeline. + /// /// public bool? Verbose { get => Q("verbose"); set => Q("verbose", value); } } /// -/// Executes an ingest pipeline against a set of provided documents. +/// +/// Executes an ingest pipeline against a set of provided documents. +/// /// public sealed partial class SimulateRequest : PlainRequest { @@ -59,26 +63,36 @@ public SimulateRequest(Elastic.Clients.Elasticsearch.Serverless.Id? id) : base(r internal override string OperationName => "ingest.simulate"; /// - /// If `true`, the response includes output data for each processor in the executed pipeline. + /// + /// If true, the response includes output data for each processor in the executed pipeline. + /// /// [JsonIgnore] public bool? Verbose { get => Q("verbose"); set => Q("verbose", value); } /// - /// Sample documents to test in the pipeline. + /// + /// Sample documents to test in the pipeline. + /// /// [JsonInclude, JsonPropertyName("docs")] public ICollection? Docs { get; set; } /// - /// Pipeline to test.
If you don’t specify the `pipeline` request path parameter, this parameter is required.
If you specify both this and the request path parameter, the API only uses the request path parameter. + /// + /// Pipeline to test. + /// If you don’t specify the pipeline request path parameter, this parameter is required. + /// If you specify both this and the request path parameter, the API only uses the request path parameter. + /// /// [JsonInclude, JsonPropertyName("pipeline")] public Elastic.Clients.Elasticsearch.Serverless.Ingest.Pipeline? Pipeline { get; set; } } /// -/// Executes an ingest pipeline against a set of provided documents. +/// +/// Executes an ingest pipeline against a set of provided documents. +/// /// public sealed partial class SimulateRequestDescriptor : RequestDescriptor, SimulateRequestParameters> { @@ -117,7 +131,9 @@ public SimulateRequestDescriptor Id(Elastic.Clients.Elasticsearch.Ser private Action> PipelineDescriptorAction { get; set; } /// - /// Sample documents to test in the pipeline. + /// + /// Sample documents to test in the pipeline. + /// /// public SimulateRequestDescriptor Docs(ICollection? docs) { @@ -156,7 +172,11 @@ public SimulateRequestDescriptor Docs(params Action - /// Pipeline to test.
If you don’t specify the `pipeline` request path parameter, this parameter is required.
If you specify both this and the request path parameter, the API only uses the request path parameter. + /// + /// Pipeline to test. + /// If you don’t specify the pipeline request path parameter, this parameter is required. + /// If you specify both this and the request path parameter, the API only uses the request path parameter. + /// /// public SimulateRequestDescriptor Pipeline(Elastic.Clients.Elasticsearch.Serverless.Ingest.Pipeline? pipeline) { @@ -237,7 +257,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Executes an ingest pipeline against a set of provided documents. +/// +/// Executes an ingest pipeline against a set of provided documents. +/// /// public sealed partial class SimulateRequestDescriptor : RequestDescriptor { @@ -276,7 +298,9 @@ public SimulateRequestDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id? private Action PipelineDescriptorAction { get; set; } /// - /// Sample documents to test in the pipeline. + /// + /// Sample documents to test in the pipeline. + /// /// public SimulateRequestDescriptor Docs(ICollection? docs) { @@ -315,7 +339,11 @@ public SimulateRequestDescriptor Docs(params Action - /// Pipeline to test.
If you don’t specify the `pipeline` request path parameter, this parameter is required.
If you specify both this and the request path parameter, the API only uses the request path parameter. + /// + /// Pipeline to test. + /// If you don’t specify the pipeline request path parameter, this parameter is required. + /// If you specify both this and the request path parameter, the API only uses the request path parameter. + /// /// public SimulateRequestDescriptor Pipeline(Elastic.Clients.Elasticsearch.Serverless.Ingest.Pipeline? pipeline) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/LicenseManagement/GetLicenseRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/LicenseManagement/GetLicenseRequest.g.cs index 2ab1d4db9eb..8b2735c6601 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/LicenseManagement/GetLicenseRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/LicenseManagement/GetLicenseRequest.g.cs @@ -32,13 +32,19 @@ namespace Elastic.Clients.Elasticsearch.Serverless.LicenseManagement; public sealed partial class GetLicenseRequestParameters : RequestParameters { /// - /// Specifies whether to retrieve local information. The default value is `false`, which means the information is retrieved from the master node. + /// + /// Specifies whether to retrieve local information. The default value is false, which means the information is retrieved from the master node. + /// /// public bool? Local { get => Q("local"); set => Q("local", value); } } /// -/// Get license information.
Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires.
For more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions). +/// +/// Get license information. +/// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. +/// For more information about the different types of licenses, refer to Elastic Stack subscriptions. +/// /// public sealed partial class GetLicenseRequest : PlainRequest { @@ -51,14 +57,20 @@ public sealed partial class GetLicenseRequest : PlainRequest "license.get"; /// - /// Specifies whether to retrieve local information. The default value is `false`, which means the information is retrieved from the master node. + /// + /// Specifies whether to retrieve local information. The default value is false, which means the information is retrieved from the master node. + /// /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } } /// -/// Get license information.
Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires.
For more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions). +/// +/// Get license information. +/// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. +/// For more information about the different types of licenses, refer to Elastic Stack subscriptions. +/// /// public sealed partial class GetLicenseRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ClearTrainedModelDeploymentCacheRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ClearTrainedModelDeploymentCacheRequest.g.cs index 36a51c7cd41..db0df6d163d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ClearTrainedModelDeploymentCacheRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ClearTrainedModelDeploymentCacheRequest.g.cs @@ -34,7 +34,13 @@ public sealed partial class ClearTrainedModelDeploymentCacheRequestParameters : } /// -/// Clear trained model deployment cache.
Cache will be cleared on all nodes where the trained model is assigned.
A trained model deployment may have an inference cache enabled.
As requests are handled by each allocated node, their responses may be cached on that individual node.
Calling this API clears the caches without restarting the deployment. +/// +/// Clear trained model deployment cache. +/// Cache will be cleared on all nodes where the trained model is assigned. +/// A trained model deployment may have an inference cache enabled. +/// As requests are handled by each allocated node, their responses may be cached on that individual node. +/// Calling this API clears the caches without restarting the deployment. +/// /// public sealed partial class ClearTrainedModelDeploymentCacheRequest : PlainRequest { @@ -52,7 +58,13 @@ public ClearTrainedModelDeploymentCacheRequest(Elastic.Clients.Elasticsearch.Ser } /// -/// Clear trained model deployment cache.
Cache will be cleared on all nodes where the trained model is assigned.
A trained model deployment may have an inference cache enabled.
As requests are handled by each allocated node, their responses may be cached on that individual node.
Calling this API clears the caches without restarting the deployment. +/// +/// Clear trained model deployment cache. +/// Cache will be cleared on all nodes where the trained model is assigned. +/// A trained model deployment may have an inference cache enabled. +/// As requests are handled by each allocated node, their responses may be cached on that individual node. +/// Calling this API clears the caches without restarting the deployment. +/// /// public sealed partial class ClearTrainedModelDeploymentCacheRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/CloseJobRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/CloseJobRequest.g.cs index ef5d3dae8ae..9f2c6d30fc3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/CloseJobRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/CloseJobRequest.g.cs @@ -34,7 +34,13 @@ public sealed partial class CloseJobRequestParameters : RequestParameters } /// -/// Close anomaly detection jobs.
A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.
When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.
If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.
When a datafeed that has a specified end date stops, it automatically closes its associated job. +/// +/// Close anomaly detection jobs. +/// A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results. +/// When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data. +/// If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. +/// When a datafeed that has a specified end date stops, it automatically closes its associated job. +/// /// public sealed partial class CloseJobRequest : PlainRequest { @@ -51,26 +57,38 @@ public CloseJobRequest(Elastic.Clients.Elasticsearch.Serverless.Id jobId) : base internal override string OperationName => "ml.close_job"; /// - /// Refer to the description for the `allow_no_match` query parameter. + /// + /// Refer to the description for the allow_no_match query parameter. + /// /// [JsonInclude, JsonPropertyName("allow_no_match")] public bool? AllowNoMatch { get; set; } /// - /// Refer to the descriptiion for the `force` query parameter. + /// + /// Refer to the descriptiion for the force query parameter. + /// /// [JsonInclude, JsonPropertyName("force")] public bool? Force { get; set; } /// - /// Refer to the description for the `timeout` query parameter. + /// + /// Refer to the description for the timeout query parameter. + /// /// [JsonInclude, JsonPropertyName("timeout")] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get; set; } } /// -/// Close anomaly detection jobs.
A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.
When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.
If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.
When a datafeed that has a specified end date stops, it automatically closes its associated job. +/// +/// Close anomaly detection jobs. +/// A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results. +/// When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data. +/// If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. +/// When a datafeed that has a specified end date stops, it automatically closes its associated job. +/// /// public sealed partial class CloseJobRequestDescriptor : RequestDescriptor { @@ -99,7 +117,9 @@ public CloseJobRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Serverless. private Elastic.Clients.Elasticsearch.Serverless.Duration? TimeoutValue { get; set; } /// - /// Refer to the description for the `allow_no_match` query parameter. + /// + /// Refer to the description for the allow_no_match query parameter. + /// /// public CloseJobRequestDescriptor AllowNoMatch(bool? allowNoMatch = true) { @@ -108,7 +128,9 @@ public CloseJobRequestDescriptor AllowNoMatch(bool? allowNoMatch = true) } /// - /// Refer to the descriptiion for the `force` query parameter. + /// + /// Refer to the descriptiion for the force query parameter. + /// /// public CloseJobRequestDescriptor Force(bool? force = true) { @@ -117,7 +139,9 @@ public CloseJobRequestDescriptor Force(bool? force = true) } /// - /// Refer to the description for the `timeout` query parameter. + /// + /// Refer to the description for the timeout query parameter. + /// /// public CloseJobRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Serverless.Duration? timeout) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteCalendarEventRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteCalendarEventRequest.g.cs index 9b49e8b415c..8c19f7e7fa3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteCalendarEventRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteCalendarEventRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class DeleteCalendarEventRequestParameters : RequestParame } /// -/// Delete events from a calendar. +/// +/// Delete events from a calendar. +/// /// public sealed partial class DeleteCalendarEventRequest : PlainRequest { @@ -52,7 +54,9 @@ public DeleteCalendarEventRequest(Elastic.Clients.Elasticsearch.Serverless.Id ca } /// -/// Delete events from a calendar. +/// +/// Delete events from a calendar. +/// /// public sealed partial class DeleteCalendarEventRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteCalendarEventResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteCalendarEventResponse.g.cs index f735a8211b4..f71ba556930 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteCalendarEventResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteCalendarEventResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DeleteCalendarEventResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteCalendarJobRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteCalendarJobRequest.g.cs index 6a5666bcc9b..54ca856ea5f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteCalendarJobRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteCalendarJobRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class DeleteCalendarJobRequestParameters : RequestParamete } /// -/// Delete anomaly jobs from a calendar. +/// +/// Delete anomaly jobs from a calendar. +/// /// public sealed partial class DeleteCalendarJobRequest : PlainRequest { @@ -52,7 +54,9 @@ public DeleteCalendarJobRequest(Elastic.Clients.Elasticsearch.Serverless.Id cale } /// -/// Delete anomaly jobs from a calendar. +/// +/// Delete anomaly jobs from a calendar. +/// /// public sealed partial class DeleteCalendarJobRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteCalendarJobResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteCalendarJobResponse.g.cs index a82844c284f..93f5a7e4768 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteCalendarJobResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteCalendarJobResponse.g.cs @@ -29,19 +29,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DeleteCalendarJobResponse : ElasticsearchResponse { /// - /// A string that uniquely identifies a calendar. + /// + /// A string that uniquely identifies a calendar. + /// /// [JsonInclude, JsonPropertyName("calendar_id")] public string CalendarId { get; init; } /// - /// A description of the calendar. + /// + /// A description of the calendar. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; init; } /// - /// A list of anomaly detection job identifiers or group names. + /// + /// A list of anomaly detection job identifiers or group names. + /// /// [JsonInclude, JsonPropertyName("job_ids")] [SingleOrManyCollectionConverter(typeof(string))] diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteCalendarRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteCalendarRequest.g.cs index 9be1d1f2e82..ce43b27a948 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteCalendarRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteCalendarRequest.g.cs @@ -34,7 +34,10 @@ public sealed partial class DeleteCalendarRequestParameters : RequestParameters } /// -/// Delete a calendar.
Removes all scheduled events from a calendar, then deletes it. +/// +/// Delete a calendar. +/// Removes all scheduled events from a calendar, then deletes it. +/// /// public sealed partial class DeleteCalendarRequest : PlainRequest { @@ -52,7 +55,10 @@ public DeleteCalendarRequest(Elastic.Clients.Elasticsearch.Serverless.Id calenda } /// -/// Delete a calendar.
Removes all scheduled events from a calendar, then deletes it. +/// +/// Delete a calendar. +/// Removes all scheduled events from a calendar, then deletes it. +/// /// public sealed partial class DeleteCalendarRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteCalendarResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteCalendarResponse.g.cs index 5c002b69dd5..e52c9343723 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteCalendarResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteCalendarResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DeleteCalendarResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteDataFrameAnalyticsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteDataFrameAnalyticsRequest.g.cs index 5fc67a67cce..610d57b513c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteDataFrameAnalyticsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteDataFrameAnalyticsRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DeleteDataFrameAnalyticsRequestParameters : RequestParameters { /// - /// If `true`, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job. + /// + /// If true, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job. + /// /// public bool? Force { get => Q("force"); set => Q("force", value); } /// - /// The time to wait for the job to be deleted. + /// + /// The time to wait for the job to be deleted. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete a data frame analytics job. +/// +/// Delete a data frame analytics job. +/// /// public sealed partial class DeleteDataFrameAnalyticsRequest : PlainRequest { @@ -60,20 +66,26 @@ public DeleteDataFrameAnalyticsRequest(Elastic.Clients.Elasticsearch.Serverless. internal override string OperationName => "ml.delete_data_frame_analytics"; /// - /// If `true`, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job. + /// + /// If true, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job. + /// /// [JsonIgnore] public bool? Force { get => Q("force"); set => Q("force", value); } /// - /// The time to wait for the job to be deleted. + /// + /// The time to wait for the job to be deleted. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete a data frame analytics job. +/// +/// Delete a data frame analytics job. +/// /// public sealed partial class DeleteDataFrameAnalyticsRequestDescriptor : RequestDescriptor, DeleteDataFrameAnalyticsRequestParameters> { @@ -106,7 +118,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Delete a data frame analytics job. +/// +/// Delete a data frame analytics job. +/// /// public sealed partial class DeleteDataFrameAnalyticsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteDataFrameAnalyticsResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteDataFrameAnalyticsResponse.g.cs index 84ad7bbb9ad..25d09960c32 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteDataFrameAnalyticsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteDataFrameAnalyticsResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DeleteDataFrameAnalyticsResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteDatafeedRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteDatafeedRequest.g.cs index 68d45eb6a23..14213fd405f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteDatafeedRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteDatafeedRequest.g.cs @@ -32,13 +32,18 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DeleteDatafeedRequestParameters : RequestParameters { /// - /// Use to forcefully delete a started datafeed; this method is quicker than
stopping and deleting the datafeed. + /// + /// Use to forcefully delete a started datafeed; this method is quicker than + /// stopping and deleting the datafeed. + /// /// public bool? Force { get => Q("force"); set => Q("force", value); } } /// -/// Delete a datafeed. +/// +/// Delete a datafeed. +/// /// public sealed partial class DeleteDatafeedRequest : PlainRequest { @@ -55,14 +60,19 @@ public DeleteDatafeedRequest(Elastic.Clients.Elasticsearch.Serverless.Id datafee internal override string OperationName => "ml.delete_datafeed"; /// - /// Use to forcefully delete a started datafeed; this method is quicker than
stopping and deleting the datafeed. + /// + /// Use to forcefully delete a started datafeed; this method is quicker than + /// stopping and deleting the datafeed. + /// /// [JsonIgnore] public bool? Force { get => Q("force"); set => Q("force", value); } } /// -/// Delete a datafeed. +/// +/// Delete a datafeed. +/// /// public sealed partial class DeleteDatafeedRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteDatafeedResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteDatafeedResponse.g.cs index 90ec4a7e54f..82dcab69bde 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteDatafeedResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteDatafeedResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DeleteDatafeedResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteExpiredDataRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteExpiredDataRequest.g.cs index 893d8ff8f50..8fc811170f4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteExpiredDataRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteExpiredDataRequest.g.cs @@ -34,7 +34,17 @@ public sealed partial class DeleteExpiredDataRequestParameters : RequestParamete } /// -/// Delete expired ML data.
Deletes all job results, model snapshots and forecast data that have exceeded
their retention days period. Machine learning state documents that are not
associated with any job are also deleted.
You can limit the request to a single or set of anomaly detection jobs by
using a job identifier, a group name, a comma-separated list of jobs, or a
wildcard expression. You can delete expired data for all anomaly detection
jobs by using _all, by specifying * as the , or by omitting the
. +/// +/// Delete expired ML data. +/// Deletes all job results, model snapshots and forecast data that have exceeded +/// their retention days period. Machine learning state documents that are not +/// associated with any job are also deleted. +/// You can limit the request to a single or set of anomaly detection jobs by +/// using a job identifier, a group name, a comma-separated list of jobs, or a +/// wildcard expression. You can delete expired data for all anomaly detection +/// jobs by using _all, by specifying * as the <job_id>, or by omitting the +/// <job_id>. +/// /// public sealed partial class DeleteExpiredDataRequest : PlainRequest { @@ -55,20 +65,35 @@ public DeleteExpiredDataRequest(Elastic.Clients.Elasticsearch.Serverless.Id? job internal override string OperationName => "ml.delete_expired_data"; /// - /// The desired requests per second for the deletion processes. The default
behavior is no throttling. + /// + /// The desired requests per second for the deletion processes. The default + /// behavior is no throttling. + /// /// [JsonInclude, JsonPropertyName("requests_per_second")] public float? RequestsPerSecond { get; set; } /// - /// How long can the underlying delete processes run until they are canceled. + /// + /// How long can the underlying delete processes run until they are canceled. + /// /// [JsonInclude, JsonPropertyName("timeout")] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get; set; } } /// -/// Delete expired ML data.
Deletes all job results, model snapshots and forecast data that have exceeded
their retention days period. Machine learning state documents that are not
associated with any job are also deleted.
You can limit the request to a single or set of anomaly detection jobs by
using a job identifier, a group name, a comma-separated list of jobs, or a
wildcard expression. You can delete expired data for all anomaly detection
jobs by using _all, by specifying * as the , or by omitting the
. +/// +/// Delete expired ML data. +/// Deletes all job results, model snapshots and forecast data that have exceeded +/// their retention days period. Machine learning state documents that are not +/// associated with any job are also deleted. +/// You can limit the request to a single or set of anomaly detection jobs by +/// using a job identifier, a group name, a comma-separated list of jobs, or a +/// wildcard expression. You can delete expired data for all anomaly detection +/// jobs by using _all, by specifying * as the <job_id>, or by omitting the +/// <job_id>. +/// /// public sealed partial class DeleteExpiredDataRequestDescriptor : RequestDescriptor { @@ -100,7 +125,10 @@ public DeleteExpiredDataRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Se private Elastic.Clients.Elasticsearch.Serverless.Duration? TimeoutValue { get; set; } /// - /// The desired requests per second for the deletion processes. The default
behavior is no throttling. + /// + /// The desired requests per second for the deletion processes. The default + /// behavior is no throttling. + /// /// public DeleteExpiredDataRequestDescriptor RequestsPerSecond(float? requestsPerSecond) { @@ -109,7 +137,9 @@ public DeleteExpiredDataRequestDescriptor RequestsPerSecond(float? requestsPerSe } /// - /// How long can the underlying delete processes run until they are canceled. + /// + /// How long can the underlying delete processes run until they are canceled. + /// /// public DeleteExpiredDataRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Serverless.Duration? timeout) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteFilterRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteFilterRequest.g.cs index 35aa833ceb2..7bf228c64b8 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteFilterRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteFilterRequest.g.cs @@ -34,7 +34,11 @@ public sealed partial class DeleteFilterRequestParameters : RequestParameters } /// -/// Delete a filter.
If an anomaly detection job references the filter, you cannot delete the
filter. You must update or delete the job before you can delete the filter. +/// +/// Delete a filter. +/// If an anomaly detection job references the filter, you cannot delete the +/// filter. You must update or delete the job before you can delete the filter. +/// /// public sealed partial class DeleteFilterRequest : PlainRequest { @@ -52,7 +56,11 @@ public DeleteFilterRequest(Elastic.Clients.Elasticsearch.Serverless.Id filterId) } /// -/// Delete a filter.
If an anomaly detection job references the filter, you cannot delete the
filter. You must update or delete the job before you can delete the filter. +/// +/// Delete a filter. +/// If an anomaly detection job references the filter, you cannot delete the +/// filter. You must update or delete the job before you can delete the filter. +/// /// public sealed partial class DeleteFilterRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteFilterResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteFilterResponse.g.cs index fc7f0dd4325..1cfbc6d6b8b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteFilterResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteFilterResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DeleteFilterResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteForecastRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteForecastRequest.g.cs index 6d2ea2dc85c..3316c5ce8aa 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteForecastRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteForecastRequest.g.cs @@ -32,18 +32,33 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DeleteForecastRequestParameters : RequestParameters { /// - /// Specifies whether an error occurs when there are no forecasts. In
particular, if this parameter is set to `false` and there are no
forecasts associated with the job, attempts to delete all forecasts
return an error. + /// + /// Specifies whether an error occurs when there are no forecasts. In + /// particular, if this parameter is set to false and there are no + /// forecasts associated with the job, attempts to delete all forecasts + /// return an error. + /// /// public bool? AllowNoForecasts { get => Q("allow_no_forecasts"); set => Q("allow_no_forecasts", value); } /// - /// Specifies the period of time to wait for the completion of the delete
operation. When this period of time elapses, the API fails and returns an
error. + /// + /// Specifies the period of time to wait for the completion of the delete + /// operation. When this period of time elapses, the API fails and returns an + /// error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete forecasts from a job.
By default, forecasts are retained for 14 days. You can specify a
different retention period with the `expires_in` parameter in the forecast
jobs API. The delete forecast API enables you to delete one or more
forecasts before they expire. +/// +/// Delete forecasts from a job. +/// By default, forecasts are retained for 14 days. You can specify a +/// different retention period with the expires_in parameter in the forecast +/// jobs API. The delete forecast API enables you to delete one or more +/// forecasts before they expire. +/// /// public sealed partial class DeleteForecastRequest : PlainRequest { @@ -64,20 +79,35 @@ public DeleteForecastRequest(Elastic.Clients.Elasticsearch.Serverless.Id jobId, internal override string OperationName => "ml.delete_forecast"; /// - /// Specifies whether an error occurs when there are no forecasts. In
particular, if this parameter is set to `false` and there are no
forecasts associated with the job, attempts to delete all forecasts
return an error. + /// + /// Specifies whether an error occurs when there are no forecasts. In + /// particular, if this parameter is set to false and there are no + /// forecasts associated with the job, attempts to delete all forecasts + /// return an error. + /// /// [JsonIgnore] public bool? AllowNoForecasts { get => Q("allow_no_forecasts"); set => Q("allow_no_forecasts", value); } /// - /// Specifies the period of time to wait for the completion of the delete
operation. When this period of time elapses, the API fails and returns an
error. + /// + /// Specifies the period of time to wait for the completion of the delete + /// operation. When this period of time elapses, the API fails and returns an + /// error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete forecasts from a job.
By default, forecasts are retained for 14 days. You can specify a
different retention period with the `expires_in` parameter in the forecast
jobs API. The delete forecast API enables you to delete one or more
forecasts before they expire. +/// +/// Delete forecasts from a job. +/// By default, forecasts are retained for 14 days. You can specify a +/// different retention period with the expires_in parameter in the forecast +/// jobs API. The delete forecast API enables you to delete one or more +/// forecasts before they expire. +/// /// public sealed partial class DeleteForecastRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteForecastResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteForecastResponse.g.cs index 6e9d770317f..f2d0e1be4df 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteForecastResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteForecastResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DeleteForecastResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteJobRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteJobRequest.g.cs index adfc2070885..d80fc5507b8 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteJobRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteJobRequest.g.cs @@ -32,23 +32,41 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DeleteJobRequestParameters : RequestParameters { /// - /// Specifies whether annotations that have been added by the
user should be deleted along with any auto-generated annotations when the job is
reset. + /// + /// Specifies whether annotations that have been added by the + /// user should be deleted along with any auto-generated annotations when the job is + /// reset. + /// /// public bool? DeleteUserAnnotations { get => Q("delete_user_annotations"); set => Q("delete_user_annotations", value); } /// - /// Use to forcefully delete an opened job; this method is quicker than
closing and deleting the job. + /// + /// Use to forcefully delete an opened job; this method is quicker than + /// closing and deleting the job. + /// /// public bool? Force { get => Q("force"); set => Q("force", value); } /// - /// Specifies whether the request should return immediately or wait until the
job deletion completes. + /// + /// Specifies whether the request should return immediately or wait until the + /// job deletion completes. + /// /// public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Delete an anomaly detection job.
All job configuration, model state and results are deleted.
It is not currently possible to delete multiple jobs using wildcards or a
comma separated list. If you delete a job that has a datafeed, the request
first tries to delete the datafeed. This behavior is equivalent to calling
the delete datafeed API with the same timeout and force parameters as the
delete job request. +/// +/// Delete an anomaly detection job. +/// All job configuration, model state and results are deleted. +/// It is not currently possible to delete multiple jobs using wildcards or a +/// comma separated list. If you delete a job that has a datafeed, the request +/// first tries to delete the datafeed. This behavior is equivalent to calling +/// the delete datafeed API with the same timeout and force parameters as the +/// delete job request. +/// /// public sealed partial class DeleteJobRequest : PlainRequest { @@ -65,26 +83,44 @@ public DeleteJobRequest(Elastic.Clients.Elasticsearch.Serverless.Id jobId) : bas internal override string OperationName => "ml.delete_job"; /// - /// Specifies whether annotations that have been added by the
user should be deleted along with any auto-generated annotations when the job is
reset. + /// + /// Specifies whether annotations that have been added by the + /// user should be deleted along with any auto-generated annotations when the job is + /// reset. + /// /// [JsonIgnore] public bool? DeleteUserAnnotations { get => Q("delete_user_annotations"); set => Q("delete_user_annotations", value); } /// - /// Use to forcefully delete an opened job; this method is quicker than
closing and deleting the job. + /// + /// Use to forcefully delete an opened job; this method is quicker than + /// closing and deleting the job. + /// /// [JsonIgnore] public bool? Force { get => Q("force"); set => Q("force", value); } /// - /// Specifies whether the request should return immediately or wait until the
job deletion completes. + /// + /// Specifies whether the request should return immediately or wait until the + /// job deletion completes. + /// /// [JsonIgnore] public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Delete an anomaly detection job.
All job configuration, model state and results are deleted.
It is not currently possible to delete multiple jobs using wildcards or a
comma separated list. If you delete a job that has a datafeed, the request
first tries to delete the datafeed. This behavior is equivalent to calling
the delete datafeed API with the same timeout and force parameters as the
delete job request. +/// +/// Delete an anomaly detection job. +/// All job configuration, model state and results are deleted. +/// It is not currently possible to delete multiple jobs using wildcards or a +/// comma separated list. If you delete a job that has a datafeed, the request +/// first tries to delete the datafeed. This behavior is equivalent to calling +/// the delete datafeed API with the same timeout and force parameters as the +/// delete job request. +/// /// public sealed partial class DeleteJobRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteJobResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteJobResponse.g.cs index 4eb74ad477f..eaba9314e44 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteJobResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteJobResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DeleteJobResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteModelSnapshotRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteModelSnapshotRequest.g.cs index eedd1e2c08d..b9668f74c3f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteModelSnapshotRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteModelSnapshotRequest.g.cs @@ -34,7 +34,12 @@ public sealed partial class DeleteModelSnapshotRequestParameters : RequestParame } /// -/// Delete a model snapshot.
You cannot delete the active model snapshot. To delete that snapshot, first
revert to a different one. To identify the active model snapshot, refer to
the `model_snapshot_id` in the results from the get jobs API. +/// +/// Delete a model snapshot. +/// You cannot delete the active model snapshot. To delete that snapshot, first +/// revert to a different one. To identify the active model snapshot, refer to +/// the model_snapshot_id in the results from the get jobs API. +/// /// public sealed partial class DeleteModelSnapshotRequest : PlainRequest { @@ -52,7 +57,12 @@ public DeleteModelSnapshotRequest(Elastic.Clients.Elasticsearch.Serverless.Id jo } /// -/// Delete a model snapshot.
You cannot delete the active model snapshot. To delete that snapshot, first
revert to a different one. To identify the active model snapshot, refer to
the `model_snapshot_id` in the results from the get jobs API. +/// +/// Delete a model snapshot. +/// You cannot delete the active model snapshot. To delete that snapshot, first +/// revert to a different one. To identify the active model snapshot, refer to +/// the model_snapshot_id in the results from the get jobs API. +/// /// public sealed partial class DeleteModelSnapshotRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteModelSnapshotResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteModelSnapshotResponse.g.cs index e96b54fe6cb..4dcd0a28b87 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteModelSnapshotResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteModelSnapshotResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DeleteModelSnapshotResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteTrainedModelAliasRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteTrainedModelAliasRequest.g.cs index aebee3831f2..129416bc867 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteTrainedModelAliasRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteTrainedModelAliasRequest.g.cs @@ -34,7 +34,12 @@ public sealed partial class DeleteTrainedModelAliasRequestParameters : RequestPa } /// -/// Delete a trained model alias.
This API deletes an existing model alias that refers to a trained model. If
the model alias is missing or refers to a model other than the one identified
by the `model_id`, this API returns an error. +/// +/// Delete a trained model alias. +/// This API deletes an existing model alias that refers to a trained model. If +/// the model alias is missing or refers to a model other than the one identified +/// by the model_id, this API returns an error. +/// /// public sealed partial class DeleteTrainedModelAliasRequest : PlainRequest { @@ -52,7 +57,12 @@ public DeleteTrainedModelAliasRequest(Elastic.Clients.Elasticsearch.Serverless.I } /// -/// Delete a trained model alias.
This API deletes an existing model alias that refers to a trained model. If
the model alias is missing or refers to a model other than the one identified
by the `model_id`, this API returns an error. +/// +/// Delete a trained model alias. +/// This API deletes an existing model alias that refers to a trained model. If +/// the model alias is missing or refers to a model other than the one identified +/// by the model_id, this API returns an error. +/// /// public sealed partial class DeleteTrainedModelAliasRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteTrainedModelAliasResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteTrainedModelAliasResponse.g.cs index d2a780e8327..77efa89d63c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteTrainedModelAliasResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteTrainedModelAliasResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DeleteTrainedModelAliasResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteTrainedModelRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteTrainedModelRequest.g.cs index 1ea4ab36782..2f389266385 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteTrainedModelRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteTrainedModelRequest.g.cs @@ -32,13 +32,18 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DeleteTrainedModelRequestParameters : RequestParameters { /// - /// Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment. + /// + /// Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment. + /// /// public bool? Force { get => Q("force"); set => Q("force", value); } } /// -/// Delete an unreferenced trained model.
The request deletes a trained inference model that is not referenced by an ingest pipeline. +/// +/// Delete an unreferenced trained model. +/// The request deletes a trained inference model that is not referenced by an ingest pipeline. +/// /// public sealed partial class DeleteTrainedModelRequest : PlainRequest { @@ -55,14 +60,19 @@ public DeleteTrainedModelRequest(Elastic.Clients.Elasticsearch.Serverless.Id mod internal override string OperationName => "ml.delete_trained_model"; /// - /// Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment. + /// + /// Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment. + /// /// [JsonIgnore] public bool? Force { get => Q("force"); set => Q("force", value); } } /// -/// Delete an unreferenced trained model.
The request deletes a trained inference model that is not referenced by an ingest pipeline. +/// +/// Delete an unreferenced trained model. +/// The request deletes a trained inference model that is not referenced by an ingest pipeline. +/// /// public sealed partial class DeleteTrainedModelRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteTrainedModelResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteTrainedModelResponse.g.cs index 1a66b2256b2..6afafbd30f8 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteTrainedModelResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/DeleteTrainedModelResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DeleteTrainedModelResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/EstimateModelMemoryRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/EstimateModelMemoryRequest.g.cs index 4ae9f1c96b8..61cd20f930b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/EstimateModelMemoryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/EstimateModelMemoryRequest.g.cs @@ -34,7 +34,12 @@ public sealed partial class EstimateModelMemoryRequestParameters : RequestParame } /// -/// Estimate job model memory usage.
Makes an estimation of the memory usage for an anomaly detection job model.
It is based on analysis configuration details for the job and cardinality
estimates for the fields it references. +/// +/// Estimate job model memory usage. +/// Makes an estimation of the memory usage for an anomaly detection job model. +/// It is based on analysis configuration details for the job and cardinality +/// estimates for the fields it references. +/// /// public sealed partial class EstimateModelMemoryRequest : PlainRequest { @@ -47,26 +52,48 @@ public sealed partial class EstimateModelMemoryRequest : PlainRequest "ml.estimate_model_memory"; /// - /// For a list of the properties that you can specify in the
`analysis_config` component of the body of this API. + /// + /// For a list of the properties that you can specify in the + /// analysis_config component of the body of this API. + /// /// [JsonInclude, JsonPropertyName("analysis_config")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.AnalysisConfig? AnalysisConfig { get; set; } /// - /// Estimates of the highest cardinality in a single bucket that is observed
for influencer fields over the time period that the job analyzes data.
To produce a good answer, values must be provided for all influencer
fields. Providing values for fields that are not listed as `influencers`
has no effect on the estimation. + /// + /// Estimates of the highest cardinality in a single bucket that is observed + /// for influencer fields over the time period that the job analyzes data. + /// To produce a good answer, values must be provided for all influencer + /// fields. Providing values for fields that are not listed as influencers + /// has no effect on the estimation. + /// /// [JsonInclude, JsonPropertyName("max_bucket_cardinality")] public IDictionary? MaxBucketCardinality { get; set; } /// - /// Estimates of the cardinality that is observed for fields over the whole
time period that the job analyzes data. To produce a good answer, values
must be provided for fields referenced in the `by_field_name`,
`over_field_name` and `partition_field_name` of any detectors. Providing
values for other fields has no effect on the estimation. It can be
omitted from the request if no detectors have a `by_field_name`,
`over_field_name` or `partition_field_name`. + /// + /// Estimates of the cardinality that is observed for fields over the whole + /// time period that the job analyzes data. To produce a good answer, values + /// must be provided for fields referenced in the by_field_name, + /// over_field_name and partition_field_name of any detectors. Providing + /// values for other fields has no effect on the estimation. It can be + /// omitted from the request if no detectors have a by_field_name, + /// over_field_name or partition_field_name. + /// /// [JsonInclude, JsonPropertyName("overall_cardinality")] public IDictionary? OverallCardinality { get; set; } } /// -/// Estimate job model memory usage.
Makes an estimation of the memory usage for an anomaly detection job model.
It is based on analysis configuration details for the job and cardinality
estimates for the fields it references. +/// +/// Estimate job model memory usage. +/// Makes an estimation of the memory usage for an anomaly detection job model. +/// It is based on analysis configuration details for the job and cardinality +/// estimates for the fields it references. +/// /// public sealed partial class EstimateModelMemoryRequestDescriptor : RequestDescriptor, EstimateModelMemoryRequestParameters> { @@ -91,7 +118,10 @@ public EstimateModelMemoryRequestDescriptor() private IDictionary? OverallCardinalityValue { get; set; } /// - /// For a list of the properties that you can specify in the
`analysis_config` component of the body of this API. + /// + /// For a list of the properties that you can specify in the + /// analysis_config component of the body of this API. + /// /// public EstimateModelMemoryRequestDescriptor AnalysisConfig(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.AnalysisConfig? analysisConfig) { @@ -118,7 +148,13 @@ public EstimateModelMemoryRequestDescriptor AnalysisConfig(Action - /// Estimates of the highest cardinality in a single bucket that is observed
for influencer fields over the time period that the job analyzes data.
To produce a good answer, values must be provided for all influencer
fields. Providing values for fields that are not listed as `influencers`
has no effect on the estimation. + /// + /// Estimates of the highest cardinality in a single bucket that is observed + /// for influencer fields over the time period that the job analyzes data. + /// To produce a good answer, values must be provided for all influencer + /// fields. Providing values for fields that are not listed as influencers + /// has no effect on the estimation. + /// /// public EstimateModelMemoryRequestDescriptor MaxBucketCardinality(Func, FluentDictionary> selector) { @@ -127,7 +163,15 @@ public EstimateModelMemoryRequestDescriptor MaxBucketCardinality(Func } /// - /// Estimates of the cardinality that is observed for fields over the whole
time period that the job analyzes data. To produce a good answer, values
must be provided for fields referenced in the `by_field_name`,
`over_field_name` and `partition_field_name` of any detectors. Providing
values for other fields has no effect on the estimation. It can be
omitted from the request if no detectors have a `by_field_name`,
`over_field_name` or `partition_field_name`. + /// + /// Estimates of the cardinality that is observed for fields over the whole + /// time period that the job analyzes data. To produce a good answer, values + /// must be provided for fields referenced in the by_field_name, + /// over_field_name and partition_field_name of any detectors. Providing + /// values for other fields has no effect on the estimation. It can be + /// omitted from the request if no detectors have a by_field_name, + /// over_field_name or partition_field_name. + /// /// public EstimateModelMemoryRequestDescriptor OverallCardinality(Func, FluentDictionary> selector) { @@ -171,7 +215,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Estimate job model memory usage.
Makes an estimation of the memory usage for an anomaly detection job model.
It is based on analysis configuration details for the job and cardinality
estimates for the fields it references. +/// +/// Estimate job model memory usage. +/// Makes an estimation of the memory usage for an anomaly detection job model. +/// It is based on analysis configuration details for the job and cardinality +/// estimates for the fields it references. +/// /// public sealed partial class EstimateModelMemoryRequestDescriptor : RequestDescriptor { @@ -196,7 +245,10 @@ public EstimateModelMemoryRequestDescriptor() private IDictionary? OverallCardinalityValue { get; set; } /// - /// For a list of the properties that you can specify in the
`analysis_config` component of the body of this API. + /// + /// For a list of the properties that you can specify in the + /// analysis_config component of the body of this API. + /// /// public EstimateModelMemoryRequestDescriptor AnalysisConfig(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.AnalysisConfig? analysisConfig) { @@ -223,7 +275,13 @@ public EstimateModelMemoryRequestDescriptor AnalysisConfig(Action - /// Estimates of the highest cardinality in a single bucket that is observed
for influencer fields over the time period that the job analyzes data.
To produce a good answer, values must be provided for all influencer
fields. Providing values for fields that are not listed as `influencers`
has no effect on the estimation. + /// + /// Estimates of the highest cardinality in a single bucket that is observed + /// for influencer fields over the time period that the job analyzes data. + /// To produce a good answer, values must be provided for all influencer + /// fields. Providing values for fields that are not listed as influencers + /// has no effect on the estimation. + /// /// public EstimateModelMemoryRequestDescriptor MaxBucketCardinality(Func, FluentDictionary> selector) { @@ -232,7 +290,15 @@ public EstimateModelMemoryRequestDescriptor MaxBucketCardinality(Func - /// Estimates of the cardinality that is observed for fields over the whole
time period that the job analyzes data. To produce a good answer, values
must be provided for fields referenced in the `by_field_name`,
`over_field_name` and `partition_field_name` of any detectors. Providing
values for other fields has no effect on the estimation. It can be
omitted from the request if no detectors have a `by_field_name`,
`over_field_name` or `partition_field_name`. + /// + /// Estimates of the cardinality that is observed for fields over the whole + /// time period that the job analyzes data. To produce a good answer, values + /// must be provided for fields referenced in the by_field_name, + /// over_field_name and partition_field_name of any detectors. Providing + /// values for other fields has no effect on the estimation. It can be + /// omitted from the request if no detectors have a by_field_name, + /// over_field_name or partition_field_name. + /// /// public EstimateModelMemoryRequestDescriptor OverallCardinality(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/EvaluateDataFrameRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/EvaluateDataFrameRequest.g.cs index 6b85f377ba1..31bba7175d0 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/EvaluateDataFrameRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/EvaluateDataFrameRequest.g.cs @@ -34,7 +34,13 @@ public sealed partial class EvaluateDataFrameRequestParameters : RequestParamete } /// -/// Evaluate data frame analytics.
The API packages together commonly used evaluation metrics for various types
of machine learning features. This has been designed for use on indexes
created by data frame analytics. Evaluation requires both a ground truth
field and an analytics result field to be present. +/// +/// Evaluate data frame analytics. +/// The API packages together commonly used evaluation metrics for various types +/// of machine learning features. This has been designed for use on indexes +/// created by data frame analytics. Evaluation requires both a ground truth +/// field and an analytics result field to be present. +/// /// public sealed partial class EvaluateDataFrameRequest : PlainRequest { @@ -47,26 +53,38 @@ public sealed partial class EvaluateDataFrameRequest : PlainRequest "ml.evaluate_data_frame"; /// - /// Defines the type of evaluation you want to perform. + /// + /// Defines the type of evaluation you want to perform. + /// /// [JsonInclude, JsonPropertyName("evaluation")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeEvaluation Evaluation { get; set; } /// - /// Defines the `index` in which the evaluation will be performed. + /// + /// Defines the index in which the evaluation will be performed. + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.Serverless.IndexName Index { get; set; } /// - /// A query clause that retrieves a subset of data from the source index. + /// + /// A query clause that retrieves a subset of data from the source index. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? Query { get; set; } } /// -/// Evaluate data frame analytics.
The API packages together commonly used evaluation metrics for various types
of machine learning features. This has been designed for use on indexes
created by data frame analytics. Evaluation requires both a ground truth
field and an analytics result field to be present. +/// +/// Evaluate data frame analytics. +/// The API packages together commonly used evaluation metrics for various types +/// of machine learning features. This has been designed for use on indexes +/// created by data frame analytics. Evaluation requires both a ground truth +/// field and an analytics result field to be present. +/// /// public sealed partial class EvaluateDataFrameRequestDescriptor : RequestDescriptor, EvaluateDataFrameRequestParameters> { @@ -93,7 +111,9 @@ public EvaluateDataFrameRequestDescriptor() private Action> QueryDescriptorAction { get; set; } /// - /// Defines the type of evaluation you want to perform. + /// + /// Defines the type of evaluation you want to perform. + /// /// public EvaluateDataFrameRequestDescriptor Evaluation(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeEvaluation evaluation) { @@ -120,7 +140,9 @@ public EvaluateDataFrameRequestDescriptor Evaluation(Action - /// Defines the `index` in which the evaluation will be performed. + /// + /// Defines the index in which the evaluation will be performed. + /// /// public EvaluateDataFrameRequestDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.IndexName index) { @@ -129,7 +151,9 @@ public EvaluateDataFrameRequestDescriptor Index(Elastic.Clients.Elast } /// - /// A query clause that retrieves a subset of data from the source index. + /// + /// A query clause that retrieves a subset of data from the source index. + /// /// public EvaluateDataFrameRequestDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -197,7 +221,13 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Evaluate data frame analytics.
The API packages together commonly used evaluation metrics for various types
of machine learning features. This has been designed for use on indexes
created by data frame analytics. Evaluation requires both a ground truth
field and an analytics result field to be present. +/// +/// Evaluate data frame analytics. +/// The API packages together commonly used evaluation metrics for various types +/// of machine learning features. This has been designed for use on indexes +/// created by data frame analytics. Evaluation requires both a ground truth +/// field and an analytics result field to be present. +/// /// public sealed partial class EvaluateDataFrameRequestDescriptor : RequestDescriptor { @@ -224,7 +254,9 @@ public EvaluateDataFrameRequestDescriptor() private Action QueryDescriptorAction { get; set; } /// - /// Defines the type of evaluation you want to perform. + /// + /// Defines the type of evaluation you want to perform. + /// /// public EvaluateDataFrameRequestDescriptor Evaluation(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeEvaluation evaluation) { @@ -251,7 +283,9 @@ public EvaluateDataFrameRequestDescriptor Evaluation(Action - /// Defines the `index` in which the evaluation will be performed. + /// + /// Defines the index in which the evaluation will be performed. + /// /// public EvaluateDataFrameRequestDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.IndexName index) { @@ -260,7 +294,9 @@ public EvaluateDataFrameRequestDescriptor Index(Elastic.Clients.Elasticsearch.Se } /// - /// A query clause that retrieves a subset of data from the source index. + /// + /// A query clause that retrieves a subset of data from the source index. + /// /// public EvaluateDataFrameRequestDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ExplainDataFrameAnalyticsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ExplainDataFrameAnalyticsRequest.g.cs index ecacb9e9139..d3ba88414e2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ExplainDataFrameAnalyticsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ExplainDataFrameAnalyticsRequest.g.cs @@ -34,7 +34,25 @@ public sealed partial class ExplainDataFrameAnalyticsRequestParameters : Request } /// -/// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. +/// +/// Explain data frame analytics config. +/// This API provides explanations for a data frame analytics config that either +/// exists already or one that has not been created yet. The following +/// explanations are provided: +/// +/// +/// +/// +/// which fields are included or not in the analysis and why, +/// +/// +/// +/// +/// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. +/// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. +/// +/// +/// /// public sealed partial class ExplainDataFrameAnalyticsRequest : PlainRequest { @@ -55,56 +73,106 @@ public ExplainDataFrameAnalyticsRequest(Elastic.Clients.Elasticsearch.Serverless internal override string OperationName => "ml.explain_data_frame_analytics"; /// - /// Specifies whether this job can start when there is insufficient machine
learning node capacity for it to be immediately assigned to a node. + /// + /// Specifies whether this job can start when there is insufficient machine + /// learning node capacity for it to be immediately assigned to a node. + /// /// [JsonInclude, JsonPropertyName("allow_lazy_start")] public bool? AllowLazyStart { get; set; } /// - /// The analysis configuration, which contains the information necessary to
perform one of the following types of analysis: classification, outlier
detection, or regression. + /// + /// The analysis configuration, which contains the information necessary to + /// perform one of the following types of analysis: classification, outlier + /// detection, or regression. + /// /// [JsonInclude, JsonPropertyName("analysis")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalysis? Analysis { get; set; } /// - /// Specify includes and/or excludes patterns to select which fields will be
included in the analysis. The patterns specified in excludes are applied
last, therefore excludes takes precedence. In other words, if the same
field is specified in both includes and excludes, then the field will not
be included in the analysis. + /// + /// Specify includes and/or excludes patterns to select which fields will be + /// included in the analysis. The patterns specified in excludes are applied + /// last, therefore excludes takes precedence. In other words, if the same + /// field is specified in both includes and excludes, then the field will not + /// be included in the analysis. + /// /// [JsonInclude, JsonPropertyName("analyzed_fields")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalysisAnalyzedFields? AnalyzedFields { get; set; } /// - /// A description of the job. + /// + /// A description of the job. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The destination configuration, consisting of index and optionally
results_field (ml by default). + /// + /// The destination configuration, consisting of index and optionally + /// results_field (ml by default). + /// /// [JsonInclude, JsonPropertyName("dest")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalyticsDestination? Dest { get; set; } /// - /// The maximum number of threads to be used by the analysis. Using more
threads may decrease the time necessary to complete the analysis at the
cost of using more CPU. Note that the process may use additional threads
for operational functionality other than the analysis itself. + /// + /// The maximum number of threads to be used by the analysis. Using more + /// threads may decrease the time necessary to complete the analysis at the + /// cost of using more CPU. Note that the process may use additional threads + /// for operational functionality other than the analysis itself. + /// /// [JsonInclude, JsonPropertyName("max_num_threads")] public int? MaxNumThreads { get; set; } /// - /// The approximate maximum amount of memory resources that are permitted for
analytical processing. If your `elasticsearch.yml` file contains an
`xpack.ml.max_model_memory_limit` setting, an error occurs when you try to
create data frame analytics jobs that have `model_memory_limit` values
greater than that setting. + /// + /// The approximate maximum amount of memory resources that are permitted for + /// analytical processing. If your elasticsearch.yml file contains an + /// xpack.ml.max_model_memory_limit setting, an error occurs when you try to + /// create data frame analytics jobs that have model_memory_limit values + /// greater than that setting. + /// /// [JsonInclude, JsonPropertyName("model_memory_limit")] public string? ModelMemoryLimit { get; set; } /// - /// The configuration of how to source the analysis data. It requires an
index. Optionally, query and _source may be specified. + /// + /// The configuration of how to source the analysis data. It requires an + /// index. Optionally, query and _source may be specified. + /// /// [JsonInclude, JsonPropertyName("source")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalyticsSource? Source { get; set; } } /// -/// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. +/// +/// Explain data frame analytics config. +/// This API provides explanations for a data frame analytics config that either +/// exists already or one that has not been created yet. The following +/// explanations are provided: +/// +/// +/// +/// +/// which fields are included or not in the analysis and why, +/// +/// +/// +/// +/// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. +/// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. +/// +/// +/// /// public sealed partial class ExplainDataFrameAnalyticsRequestDescriptor : RequestDescriptor, ExplainDataFrameAnalyticsRequestParameters> { @@ -150,7 +218,10 @@ public ExplainDataFrameAnalyticsRequestDescriptor Id(Elastic.Clients. private Action> SourceDescriptorAction { get; set; } /// - /// Specifies whether this job can start when there is insufficient machine
learning node capacity for it to be immediately assigned to a node. + /// + /// Specifies whether this job can start when there is insufficient machine + /// learning node capacity for it to be immediately assigned to a node. + /// /// public ExplainDataFrameAnalyticsRequestDescriptor AllowLazyStart(bool? allowLazyStart = true) { @@ -159,7 +230,11 @@ public ExplainDataFrameAnalyticsRequestDescriptor AllowLazyStart(bool } /// - /// The analysis configuration, which contains the information necessary to
perform one of the following types of analysis: classification, outlier
detection, or regression. + /// + /// The analysis configuration, which contains the information necessary to + /// perform one of the following types of analysis: classification, outlier + /// detection, or regression. + /// /// public ExplainDataFrameAnalyticsRequestDescriptor Analysis(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalysis? analysis) { @@ -186,7 +261,13 @@ public ExplainDataFrameAnalyticsRequestDescriptor Analysis(Action - /// Specify includes and/or excludes patterns to select which fields will be
included in the analysis. The patterns specified in excludes are applied
last, therefore excludes takes precedence. In other words, if the same
field is specified in both includes and excludes, then the field will not
be included in the analysis. + /// + /// Specify includes and/or excludes patterns to select which fields will be + /// included in the analysis. The patterns specified in excludes are applied + /// last, therefore excludes takes precedence. In other words, if the same + /// field is specified in both includes and excludes, then the field will not + /// be included in the analysis. + /// /// public ExplainDataFrameAnalyticsRequestDescriptor AnalyzedFields(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalysisAnalyzedFields? analyzedFields) { @@ -213,7 +294,9 @@ public ExplainDataFrameAnalyticsRequestDescriptor AnalyzedFields(Acti } /// - /// A description of the job. + /// + /// A description of the job. + /// /// public ExplainDataFrameAnalyticsRequestDescriptor Description(string? description) { @@ -222,7 +305,10 @@ public ExplainDataFrameAnalyticsRequestDescriptor Description(string? } /// - /// The destination configuration, consisting of index and optionally
results_field (ml by default). + /// + /// The destination configuration, consisting of index and optionally + /// results_field (ml by default). + /// /// public ExplainDataFrameAnalyticsRequestDescriptor Dest(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalyticsDestination? dest) { @@ -249,7 +335,12 @@ public ExplainDataFrameAnalyticsRequestDescriptor Dest(Action - /// The maximum number of threads to be used by the analysis. Using more
threads may decrease the time necessary to complete the analysis at the
cost of using more CPU. Note that the process may use additional threads
for operational functionality other than the analysis itself. + /// + /// The maximum number of threads to be used by the analysis. Using more + /// threads may decrease the time necessary to complete the analysis at the + /// cost of using more CPU. Note that the process may use additional threads + /// for operational functionality other than the analysis itself. + /// /// public ExplainDataFrameAnalyticsRequestDescriptor MaxNumThreads(int? maxNumThreads) { @@ -258,7 +349,13 @@ public ExplainDataFrameAnalyticsRequestDescriptor MaxNumThreads(int? } /// - /// The approximate maximum amount of memory resources that are permitted for
analytical processing. If your `elasticsearch.yml` file contains an
`xpack.ml.max_model_memory_limit` setting, an error occurs when you try to
create data frame analytics jobs that have `model_memory_limit` values
greater than that setting. + /// + /// The approximate maximum amount of memory resources that are permitted for + /// analytical processing. If your elasticsearch.yml file contains an + /// xpack.ml.max_model_memory_limit setting, an error occurs when you try to + /// create data frame analytics jobs that have model_memory_limit values + /// greater than that setting. + /// /// public ExplainDataFrameAnalyticsRequestDescriptor ModelMemoryLimit(string? modelMemoryLimit) { @@ -267,7 +364,10 @@ public ExplainDataFrameAnalyticsRequestDescriptor ModelMemoryLimit(st } /// - /// The configuration of how to source the analysis data. It requires an
index. Optionally, query and _source may be specified. + /// + /// The configuration of how to source the analysis data. It requires an + /// index. Optionally, query and _source may be specified. + /// /// public ExplainDataFrameAnalyticsRequestDescriptor Source(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalyticsSource? source) { @@ -389,7 +489,25 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. +/// +/// Explain data frame analytics config. +/// This API provides explanations for a data frame analytics config that either +/// exists already or one that has not been created yet. The following +/// explanations are provided: +/// +/// +/// +/// +/// which fields are included or not in the analysis and why, +/// +/// +/// +/// +/// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. +/// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. +/// +/// +/// /// public sealed partial class ExplainDataFrameAnalyticsRequestDescriptor : RequestDescriptor { @@ -435,7 +553,10 @@ public ExplainDataFrameAnalyticsRequestDescriptor Id(Elastic.Clients.Elasticsear private Action SourceDescriptorAction { get; set; } /// - /// Specifies whether this job can start when there is insufficient machine
learning node capacity for it to be immediately assigned to a node. + /// + /// Specifies whether this job can start when there is insufficient machine + /// learning node capacity for it to be immediately assigned to a node. + /// /// public ExplainDataFrameAnalyticsRequestDescriptor AllowLazyStart(bool? allowLazyStart = true) { @@ -444,7 +565,11 @@ public ExplainDataFrameAnalyticsRequestDescriptor AllowLazyStart(bool? allowLazy } /// - /// The analysis configuration, which contains the information necessary to
perform one of the following types of analysis: classification, outlier
detection, or regression. + /// + /// The analysis configuration, which contains the information necessary to + /// perform one of the following types of analysis: classification, outlier + /// detection, or regression. + /// /// public ExplainDataFrameAnalyticsRequestDescriptor Analysis(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalysis? analysis) { @@ -471,7 +596,13 @@ public ExplainDataFrameAnalyticsRequestDescriptor Analysis(Action - /// Specify includes and/or excludes patterns to select which fields will be
included in the analysis. The patterns specified in excludes are applied
last, therefore excludes takes precedence. In other words, if the same
field is specified in both includes and excludes, then the field will not
be included in the analysis. + /// + /// Specify includes and/or excludes patterns to select which fields will be + /// included in the analysis. The patterns specified in excludes are applied + /// last, therefore excludes takes precedence. In other words, if the same + /// field is specified in both includes and excludes, then the field will not + /// be included in the analysis. + /// /// public ExplainDataFrameAnalyticsRequestDescriptor AnalyzedFields(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalysisAnalyzedFields? analyzedFields) { @@ -498,7 +629,9 @@ public ExplainDataFrameAnalyticsRequestDescriptor AnalyzedFields(Action - /// A description of the job. + /// + /// A description of the job. + /// /// public ExplainDataFrameAnalyticsRequestDescriptor Description(string? description) { @@ -507,7 +640,10 @@ public ExplainDataFrameAnalyticsRequestDescriptor Description(string? descriptio } /// - /// The destination configuration, consisting of index and optionally
results_field (ml by default). + /// + /// The destination configuration, consisting of index and optionally + /// results_field (ml by default). + /// /// public ExplainDataFrameAnalyticsRequestDescriptor Dest(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalyticsDestination? dest) { @@ -534,7 +670,12 @@ public ExplainDataFrameAnalyticsRequestDescriptor Dest(Action - /// The maximum number of threads to be used by the analysis. Using more
threads may decrease the time necessary to complete the analysis at the
cost of using more CPU. Note that the process may use additional threads
for operational functionality other than the analysis itself. + /// + /// The maximum number of threads to be used by the analysis. Using more + /// threads may decrease the time necessary to complete the analysis at the + /// cost of using more CPU. Note that the process may use additional threads + /// for operational functionality other than the analysis itself. + /// /// public ExplainDataFrameAnalyticsRequestDescriptor MaxNumThreads(int? maxNumThreads) { @@ -543,7 +684,13 @@ public ExplainDataFrameAnalyticsRequestDescriptor MaxNumThreads(int? maxNumThrea } /// - /// The approximate maximum amount of memory resources that are permitted for
analytical processing. If your `elasticsearch.yml` file contains an
`xpack.ml.max_model_memory_limit` setting, an error occurs when you try to
create data frame analytics jobs that have `model_memory_limit` values
greater than that setting. + /// + /// The approximate maximum amount of memory resources that are permitted for + /// analytical processing. If your elasticsearch.yml file contains an + /// xpack.ml.max_model_memory_limit setting, an error occurs when you try to + /// create data frame analytics jobs that have model_memory_limit values + /// greater than that setting. + /// /// public ExplainDataFrameAnalyticsRequestDescriptor ModelMemoryLimit(string? modelMemoryLimit) { @@ -552,7 +699,10 @@ public ExplainDataFrameAnalyticsRequestDescriptor ModelMemoryLimit(string? model } /// - /// The configuration of how to source the analysis data. It requires an
index. Optionally, query and _source may be specified. + /// + /// The configuration of how to source the analysis data. It requires an + /// index. Optionally, query and _source may be specified. + /// /// public ExplainDataFrameAnalyticsRequestDescriptor Source(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalyticsSource? source) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ExplainDataFrameAnalyticsResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ExplainDataFrameAnalyticsResponse.g.cs index 9c3180f4131..a6c84a58c69 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ExplainDataFrameAnalyticsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ExplainDataFrameAnalyticsResponse.g.cs @@ -29,13 +29,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class ExplainDataFrameAnalyticsResponse : ElasticsearchResponse { /// - /// An array of objects that explain selection for each field, sorted by the field names. + /// + /// An array of objects that explain selection for each field, sorted by the field names. + /// /// [JsonInclude, JsonPropertyName("field_selection")] public IReadOnlyCollection FieldSelection { get; init; } /// - /// An array of objects that explain selection for each field, sorted by the field names. + /// + /// An array of objects that explain selection for each field, sorted by the field names. + /// /// [JsonInclude, JsonPropertyName("memory_estimation")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalyticsMemoryEstimation MemoryEstimation { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/FlushJobRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/FlushJobRequest.g.cs index c86ba901022..db6e917f983 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/FlushJobRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/FlushJobRequest.g.cs @@ -34,7 +34,17 @@ public sealed partial class FlushJobRequestParameters : RequestParameters } /// -/// Forces any buffered data to be processed by the job.
The flush jobs API is only applicable when sending data for analysis using
the post data API. Depending on the content of the buffer, then it might
additionally calculate new results. Both flush and close operations are
similar, however the flush is more efficient if you are expecting to send
more data for analysis. When flushing, the job remains open and is available
to continue analyzing data. A close operation additionally prunes and
persists the model state to disk and the job must be opened again before
analyzing further data. +/// +/// Forces any buffered data to be processed by the job. +/// The flush jobs API is only applicable when sending data for analysis using +/// the post data API. Depending on the content of the buffer, then it might +/// additionally calculate new results. Both flush and close operations are +/// similar, however the flush is more efficient if you are expecting to send +/// more data for analysis. When flushing, the job remains open and is available +/// to continue analyzing data. A close operation additionally prunes and +/// persists the model state to disk and the job must be opened again before +/// analyzing further data. +/// /// public sealed partial class FlushJobRequest : PlainRequest { @@ -51,38 +61,58 @@ public FlushJobRequest(Elastic.Clients.Elasticsearch.Serverless.Id jobId) : base internal override string OperationName => "ml.flush_job"; /// - /// Refer to the description for the `advance_time` query parameter. + /// + /// Refer to the description for the advance_time query parameter. + /// /// [JsonInclude, JsonPropertyName("advance_time")] public DateTimeOffset? AdvanceTime { get; set; } /// - /// Refer to the description for the `calc_interim` query parameter. + /// + /// Refer to the description for the calc_interim query parameter. + /// /// [JsonInclude, JsonPropertyName("calc_interim")] public bool? CalcInterim { get; set; } /// - /// Refer to the description for the `end` query parameter. + /// + /// Refer to the description for the end query parameter. + /// /// [JsonInclude, JsonPropertyName("end")] public DateTimeOffset? End { get; set; } /// - /// Refer to the description for the `skip_time` query parameter. + /// + /// Refer to the description for the skip_time query parameter. + /// /// [JsonInclude, JsonPropertyName("skip_time")] public DateTimeOffset? SkipTime { get; set; } /// - /// Refer to the description for the `start` query parameter. + /// + /// Refer to the description for the start query parameter. + /// /// [JsonInclude, JsonPropertyName("start")] public DateTimeOffset? Start { get; set; } } /// -/// Forces any buffered data to be processed by the job.
The flush jobs API is only applicable when sending data for analysis using
the post data API. Depending on the content of the buffer, then it might
additionally calculate new results. Both flush and close operations are
similar, however the flush is more efficient if you are expecting to send
more data for analysis. When flushing, the job remains open and is available
to continue analyzing data. A close operation additionally prunes and
persists the model state to disk and the job must be opened again before
analyzing further data. +/// +/// Forces any buffered data to be processed by the job. +/// The flush jobs API is only applicable when sending data for analysis using +/// the post data API. Depending on the content of the buffer, then it might +/// additionally calculate new results. Both flush and close operations are +/// similar, however the flush is more efficient if you are expecting to send +/// more data for analysis. When flushing, the job remains open and is available +/// to continue analyzing data. A close operation additionally prunes and +/// persists the model state to disk and the job must be opened again before +/// analyzing further data. +/// /// public sealed partial class FlushJobRequestDescriptor : RequestDescriptor { @@ -113,7 +143,9 @@ public FlushJobRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Serverless. private DateTimeOffset? StartValue { get; set; } /// - /// Refer to the description for the `advance_time` query parameter. + /// + /// Refer to the description for the advance_time query parameter. + /// /// public FlushJobRequestDescriptor AdvanceTime(DateTimeOffset? advanceTime) { @@ -122,7 +154,9 @@ public FlushJobRequestDescriptor AdvanceTime(DateTimeOffset? advanceTime) } /// - /// Refer to the description for the `calc_interim` query parameter. + /// + /// Refer to the description for the calc_interim query parameter. + /// /// public FlushJobRequestDescriptor CalcInterim(bool? calcInterim = true) { @@ -131,7 +165,9 @@ public FlushJobRequestDescriptor CalcInterim(bool? calcInterim = true) } /// - /// Refer to the description for the `end` query parameter. + /// + /// Refer to the description for the end query parameter. + /// /// public FlushJobRequestDescriptor End(DateTimeOffset? end) { @@ -140,7 +176,9 @@ public FlushJobRequestDescriptor End(DateTimeOffset? end) } /// - /// Refer to the description for the `skip_time` query parameter. + /// + /// Refer to the description for the skip_time query parameter. + /// /// public FlushJobRequestDescriptor SkipTime(DateTimeOffset? skipTime) { @@ -149,7 +187,9 @@ public FlushJobRequestDescriptor SkipTime(DateTimeOffset? skipTime) } /// - /// Refer to the description for the `start` query parameter. + /// + /// Refer to the description for the start query parameter. + /// /// public FlushJobRequestDescriptor Start(DateTimeOffset? start) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/FlushJobResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/FlushJobResponse.g.cs index 19500b55ae4..153a31d6ccb 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/FlushJobResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/FlushJobResponse.g.cs @@ -32,7 +32,10 @@ public sealed partial class FlushJobResponse : ElasticsearchResponse public bool Flushed { get; init; } /// - /// Provides the timestamp (in milliseconds since the epoch) of the end of
the last bucket that was processed. + /// + /// Provides the timestamp (in milliseconds since the epoch) of the end of + /// the last bucket that was processed. + /// /// [JsonInclude, JsonPropertyName("last_finalized_bucket_end")] public int? LastFinalizedBucketEnd { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ForecastRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ForecastRequest.g.cs index 74690d7a614..b306197bff8 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ForecastRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ForecastRequest.g.cs @@ -34,8 +34,15 @@ public sealed partial class ForecastRequestParameters : RequestParameters } /// -/// Predicts the future behavior of a time series by using its historical
behavior. -/// Forecasts are not supported for jobs that perform population analysis; an
error occurs if you try to create a forecast for a job that has an
`over_field_name` in its configuration. +/// +/// Predicts the future behavior of a time series by using its historical +/// behavior. +/// +/// +/// Forecasts are not supported for jobs that perform population analysis; an +/// error occurs if you try to create a forecast for a job that has an +/// over_field_name in its configuration. +/// /// public sealed partial class ForecastRequest : PlainRequest { @@ -52,27 +59,40 @@ public ForecastRequest(Elastic.Clients.Elasticsearch.Serverless.Id jobId) : base internal override string OperationName => "ml.forecast"; /// - /// Refer to the description for the `duration` query parameter. + /// + /// Refer to the description for the duration query parameter. + /// /// [JsonInclude, JsonPropertyName("duration")] public Elastic.Clients.Elasticsearch.Serverless.Duration? Duration { get; set; } /// - /// Refer to the description for the `expires_in` query parameter. + /// + /// Refer to the description for the expires_in query parameter. + /// /// [JsonInclude, JsonPropertyName("expires_in")] public Elastic.Clients.Elasticsearch.Serverless.Duration? ExpiresIn { get; set; } /// - /// Refer to the description for the `max_model_memory` query parameter. + /// + /// Refer to the description for the max_model_memory query parameter. + /// /// [JsonInclude, JsonPropertyName("max_model_memory")] public string? MaxModelMemory { get; set; } } /// -/// Predicts the future behavior of a time series by using its historical
behavior. -/// Forecasts are not supported for jobs that perform population analysis; an
error occurs if you try to create a forecast for a job that has an
`over_field_name` in its configuration. +/// +/// Predicts the future behavior of a time series by using its historical +/// behavior. +/// +/// +/// Forecasts are not supported for jobs that perform population analysis; an +/// error occurs if you try to create a forecast for a job that has an +/// over_field_name in its configuration. +/// /// public sealed partial class ForecastRequestDescriptor : RequestDescriptor { @@ -101,7 +121,9 @@ public ForecastRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Serverless. private string? MaxModelMemoryValue { get; set; } /// - /// Refer to the description for the `duration` query parameter. + /// + /// Refer to the description for the duration query parameter. + /// /// public ForecastRequestDescriptor Duration(Elastic.Clients.Elasticsearch.Serverless.Duration? duration) { @@ -110,7 +132,9 @@ public ForecastRequestDescriptor Duration(Elastic.Clients.Elasticsearch.Serverle } /// - /// Refer to the description for the `expires_in` query parameter. + /// + /// Refer to the description for the expires_in query parameter. + /// /// public ForecastRequestDescriptor ExpiresIn(Elastic.Clients.Elasticsearch.Serverless.Duration? expiresIn) { @@ -119,7 +143,9 @@ public ForecastRequestDescriptor ExpiresIn(Elastic.Clients.Elasticsearch.Serverl } /// - /// Refer to the description for the `max_model_memory` query parameter. + /// + /// Refer to the description for the max_model_memory query parameter. + /// /// public ForecastRequestDescriptor MaxModelMemory(string? maxModelMemory) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetBucketsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetBucketsRequest.g.cs index c6613e39a3d..3be3bf6bc17 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetBucketsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetBucketsRequest.g.cs @@ -32,18 +32,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class GetBucketsRequestParameters : RequestParameters { /// - /// Skips the specified number of buckets. + /// + /// Skips the specified number of buckets. + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of buckets to obtain. + /// + /// Specifies the maximum number of buckets to obtain. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. +/// +/// Retrieves anomaly detection job results for one or more buckets. +/// The API presents a chronological view of the records, grouped by bucket. +/// /// public sealed partial class GetBucketsRequest : PlainRequest { @@ -64,43 +71,57 @@ public GetBucketsRequest(Elastic.Clients.Elasticsearch.Serverless.Id jobId) : ba internal override string OperationName => "ml.get_buckets"; /// - /// Skips the specified number of buckets. + /// + /// Skips the specified number of buckets. + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of buckets to obtain. + /// + /// Specifies the maximum number of buckets to obtain. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } /// - /// Refer to the description for the `anomaly_score` query parameter. + /// + /// Refer to the description for the anomaly_score query parameter. + /// /// [JsonInclude, JsonPropertyName("anomaly_score")] public double? AnomalyScore { get; set; } /// - /// Refer to the description for the `desc` query parameter. + /// + /// Refer to the description for the desc query parameter. + /// /// [JsonInclude, JsonPropertyName("desc")] public bool? Desc { get; set; } /// - /// Refer to the description for the `end` query parameter. + /// + /// Refer to the description for the end query parameter. + /// /// [JsonInclude, JsonPropertyName("end")] public DateTimeOffset? End { get; set; } /// - /// Refer to the description for the `exclude_interim` query parameter. + /// + /// Refer to the description for the exclude_interim query parameter. + /// /// [JsonInclude, JsonPropertyName("exclude_interim")] public bool? ExcludeInterim { get; set; } /// - /// Refer to the description for the `expand` query parameter. + /// + /// Refer to the description for the expand query parameter. + /// /// [JsonInclude, JsonPropertyName("expand")] public bool? Expand { get; set; } @@ -108,20 +129,27 @@ public GetBucketsRequest(Elastic.Clients.Elasticsearch.Serverless.Id jobId) : ba public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Page? Page { get; set; } /// - /// Refer to the desription for the `sort` query parameter. + /// + /// Refer to the desription for the sort query parameter. + /// /// [JsonInclude, JsonPropertyName("sort")] public Elastic.Clients.Elasticsearch.Serverless.Field? Sort { get; set; } /// - /// Refer to the description for the `start` query parameter. + /// + /// Refer to the description for the start query parameter. + /// /// [JsonInclude, JsonPropertyName("start")] public DateTimeOffset? Start { get; set; } } /// -/// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. +/// +/// Retrieves anomaly detection job results for one or more buckets. +/// The API presents a chronological view of the records, grouped by bucket. +/// /// public sealed partial class GetBucketsRequestDescriptor : RequestDescriptor, GetBucketsRequestParameters> { @@ -170,7 +198,9 @@ public GetBucketsRequestDescriptor Timestamp(DateTimeOffset? timestam private DateTimeOffset? StartValue { get; set; } /// - /// Refer to the description for the `anomaly_score` query parameter. + /// + /// Refer to the description for the anomaly_score query parameter. + /// /// public GetBucketsRequestDescriptor AnomalyScore(double? anomalyScore) { @@ -179,7 +209,9 @@ public GetBucketsRequestDescriptor AnomalyScore(double? anomalyScore) } /// - /// Refer to the description for the `desc` query parameter. + /// + /// Refer to the description for the desc query parameter. + /// /// public GetBucketsRequestDescriptor Desc(bool? desc = true) { @@ -188,7 +220,9 @@ public GetBucketsRequestDescriptor Desc(bool? desc = true) } /// - /// Refer to the description for the `end` query parameter. + /// + /// Refer to the description for the end query parameter. + /// /// public GetBucketsRequestDescriptor End(DateTimeOffset? end) { @@ -197,7 +231,9 @@ public GetBucketsRequestDescriptor End(DateTimeOffset? end) } /// - /// Refer to the description for the `exclude_interim` query parameter. + /// + /// Refer to the description for the exclude_interim query parameter. + /// /// public GetBucketsRequestDescriptor ExcludeInterim(bool? excludeInterim = true) { @@ -206,7 +242,9 @@ public GetBucketsRequestDescriptor ExcludeInterim(bool? excludeInteri } /// - /// Refer to the description for the `expand` query parameter. + /// + /// Refer to the description for the expand query parameter. + /// /// public GetBucketsRequestDescriptor Expand(bool? expand = true) { @@ -239,7 +277,9 @@ public GetBucketsRequestDescriptor Page(Action - /// Refer to the desription for the `sort` query parameter. + /// + /// Refer to the desription for the sort query parameter. + /// /// public GetBucketsRequestDescriptor Sort(Elastic.Clients.Elasticsearch.Serverless.Field? sort) { @@ -248,7 +288,9 @@ public GetBucketsRequestDescriptor Sort(Elastic.Clients.Elasticsearch } /// - /// Refer to the desription for the `sort` query parameter. + /// + /// Refer to the desription for the sort query parameter. + /// /// public GetBucketsRequestDescriptor Sort(Expression> sort) { @@ -257,7 +299,9 @@ public GetBucketsRequestDescriptor Sort(Expression - /// Refer to the desription for the `sort` query parameter. + /// + /// Refer to the desription for the sort query parameter. + /// /// public GetBucketsRequestDescriptor Sort(Expression> sort) { @@ -266,7 +310,9 @@ public GetBucketsRequestDescriptor Sort(Expression - /// Refer to the description for the `start` query parameter. + /// + /// Refer to the description for the start query parameter. + /// /// public GetBucketsRequestDescriptor Start(DateTimeOffset? start) { @@ -340,7 +386,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. +/// +/// Retrieves anomaly detection job results for one or more buckets. +/// The API presents a chronological view of the records, grouped by bucket. +/// /// public sealed partial class GetBucketsRequestDescriptor : RequestDescriptor { @@ -389,7 +438,9 @@ public GetBucketsRequestDescriptor Timestamp(DateTimeOffset? timestamp) private DateTimeOffset? StartValue { get; set; } /// - /// Refer to the description for the `anomaly_score` query parameter. + /// + /// Refer to the description for the anomaly_score query parameter. + /// /// public GetBucketsRequestDescriptor AnomalyScore(double? anomalyScore) { @@ -398,7 +449,9 @@ public GetBucketsRequestDescriptor AnomalyScore(double? anomalyScore) } /// - /// Refer to the description for the `desc` query parameter. + /// + /// Refer to the description for the desc query parameter. + /// /// public GetBucketsRequestDescriptor Desc(bool? desc = true) { @@ -407,7 +460,9 @@ public GetBucketsRequestDescriptor Desc(bool? desc = true) } /// - /// Refer to the description for the `end` query parameter. + /// + /// Refer to the description for the end query parameter. + /// /// public GetBucketsRequestDescriptor End(DateTimeOffset? end) { @@ -416,7 +471,9 @@ public GetBucketsRequestDescriptor End(DateTimeOffset? end) } /// - /// Refer to the description for the `exclude_interim` query parameter. + /// + /// Refer to the description for the exclude_interim query parameter. + /// /// public GetBucketsRequestDescriptor ExcludeInterim(bool? excludeInterim = true) { @@ -425,7 +482,9 @@ public GetBucketsRequestDescriptor ExcludeInterim(bool? excludeInterim = true) } /// - /// Refer to the description for the `expand` query parameter. + /// + /// Refer to the description for the expand query parameter. + /// /// public GetBucketsRequestDescriptor Expand(bool? expand = true) { @@ -458,7 +517,9 @@ public GetBucketsRequestDescriptor Page(Action - /// Refer to the desription for the `sort` query parameter. + /// + /// Refer to the desription for the sort query parameter. + /// /// public GetBucketsRequestDescriptor Sort(Elastic.Clients.Elasticsearch.Serverless.Field? sort) { @@ -467,7 +528,9 @@ public GetBucketsRequestDescriptor Sort(Elastic.Clients.Elasticsearch.Serverless } /// - /// Refer to the desription for the `sort` query parameter. + /// + /// Refer to the desription for the sort query parameter. + /// /// public GetBucketsRequestDescriptor Sort(Expression> sort) { @@ -476,7 +539,9 @@ public GetBucketsRequestDescriptor Sort(Expression - /// Refer to the desription for the `sort` query parameter. + /// + /// Refer to the desription for the sort query parameter. + /// /// public GetBucketsRequestDescriptor Sort(Expression> sort) { @@ -485,7 +550,9 @@ public GetBucketsRequestDescriptor Sort(Expression - /// Refer to the description for the `start` query parameter. + /// + /// Refer to the description for the start query parameter. + /// /// public GetBucketsRequestDescriptor Start(DateTimeOffset? start) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetCalendarEventsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetCalendarEventsRequest.g.cs index f6ba0d764ca..867d5aa5499 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetCalendarEventsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetCalendarEventsRequest.g.cs @@ -32,33 +32,45 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class GetCalendarEventsRequestParameters : RequestParameters { /// - /// Specifies to get events with timestamps earlier than this time. + /// + /// Specifies to get events with timestamps earlier than this time. + /// /// public DateTimeOffset? End { get => Q("end"); set => Q("end", value); } /// - /// Skips the specified number of events. + /// + /// Skips the specified number of events. + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies to get events for a specific anomaly detection job identifier or job group. It must be used with a calendar identifier of `_all` or `*`. + /// + /// Specifies to get events for a specific anomaly detection job identifier or job group. It must be used with a calendar identifier of _all or *. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Id? JobId { get => Q("job_id"); set => Q("job_id", value); } /// - /// Specifies the maximum number of events to obtain. + /// + /// Specifies the maximum number of events to obtain. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } /// - /// Specifies to get events with timestamps after this time. + /// + /// Specifies to get events with timestamps after this time. + /// /// public DateTimeOffset? Start { get => Q("start"); set => Q("start", value); } } /// -/// Retrieves information about the scheduled events in calendars. +/// +/// Retrieves information about the scheduled events in calendars. +/// /// public sealed partial class GetCalendarEventsRequest : PlainRequest { @@ -75,38 +87,50 @@ public GetCalendarEventsRequest(Elastic.Clients.Elasticsearch.Serverless.Id cale internal override string OperationName => "ml.get_calendar_events"; /// - /// Specifies to get events with timestamps earlier than this time. + /// + /// Specifies to get events with timestamps earlier than this time. + /// /// [JsonIgnore] public DateTimeOffset? End { get => Q("end"); set => Q("end", value); } /// - /// Skips the specified number of events. + /// + /// Skips the specified number of events. + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies to get events for a specific anomaly detection job identifier or job group. It must be used with a calendar identifier of `_all` or `*`. + /// + /// Specifies to get events for a specific anomaly detection job identifier or job group. It must be used with a calendar identifier of _all or *. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Id? JobId { get => Q("job_id"); set => Q("job_id", value); } /// - /// Specifies the maximum number of events to obtain. + /// + /// Specifies the maximum number of events to obtain. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } /// - /// Specifies to get events with timestamps after this time. + /// + /// Specifies to get events with timestamps after this time. + /// /// [JsonIgnore] public DateTimeOffset? Start { get => Q("start"); set => Q("start", value); } } /// -/// Retrieves information about the scheduled events in calendars. +/// +/// Retrieves information about the scheduled events in calendars. +/// /// public sealed partial class GetCalendarEventsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetCalendarsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetCalendarsRequest.g.cs index caae5056ccc..865ce98991b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetCalendarsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetCalendarsRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class GetCalendarsRequestParameters : RequestParameters { /// - /// Skips the specified number of calendars. This parameter is supported only when you omit the calendar identifier. + /// + /// Skips the specified number of calendars. This parameter is supported only when you omit the calendar identifier. + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the calendar identifier. + /// + /// Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the calendar identifier. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Retrieves configuration information for calendars. +/// +/// Retrieves configuration information for calendars. +/// /// public sealed partial class GetCalendarsRequest : PlainRequest { @@ -64,26 +70,34 @@ public GetCalendarsRequest(Elastic.Clients.Elasticsearch.Serverless.Id? calendar internal override string OperationName => "ml.get_calendars"; /// - /// Skips the specified number of calendars. This parameter is supported only when you omit the calendar identifier. + /// + /// Skips the specified number of calendars. This parameter is supported only when you omit the calendar identifier. + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the calendar identifier. + /// + /// Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the calendar identifier. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } /// - /// This object is supported only when you omit the calendar identifier. + /// + /// This object is supported only when you omit the calendar identifier. + /// /// [JsonInclude, JsonPropertyName("page")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Page? Page { get; set; } } /// -/// Retrieves configuration information for calendars. +/// +/// Retrieves configuration information for calendars. +/// /// public sealed partial class GetCalendarsRequestDescriptor : RequestDescriptor { @@ -119,7 +133,9 @@ public GetCalendarsRequestDescriptor CalendarId(Elastic.Clients.Elasticsearch.Se private Action PageDescriptorAction { get; set; } /// - /// This object is supported only when you omit the calendar identifier. + /// + /// This object is supported only when you omit the calendar identifier. + /// /// public GetCalendarsRequestDescriptor Page(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Page? page) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetCategoriesRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetCategoriesRequest.g.cs index ba229b71162..a3dac582230 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetCategoriesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetCategoriesRequest.g.cs @@ -32,23 +32,31 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class GetCategoriesRequestParameters : RequestParameters { /// - /// Skips the specified number of categories. + /// + /// Skips the specified number of categories. + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// Only return categories for the specified partition. + /// + /// Only return categories for the specified partition. + /// /// public string? PartitionFieldValue { get => Q("partition_field_value"); set => Q("partition_field_value", value); } /// - /// Specifies the maximum number of categories to obtain. + /// + /// Specifies the maximum number of categories to obtain. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Retrieves anomaly detection job results for one or more categories. +/// +/// Retrieves anomaly detection job results for one or more categories. +/// /// public sealed partial class GetCategoriesRequest : PlainRequest { @@ -69,32 +77,43 @@ public GetCategoriesRequest(Elastic.Clients.Elasticsearch.Serverless.Id jobId) : internal override string OperationName => "ml.get_categories"; /// - /// Skips the specified number of categories. + /// + /// Skips the specified number of categories. + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// Only return categories for the specified partition. + /// + /// Only return categories for the specified partition. + /// /// [JsonIgnore] public string? PartitionFieldValue { get => Q("partition_field_value"); set => Q("partition_field_value", value); } /// - /// Specifies the maximum number of categories to obtain. + /// + /// Specifies the maximum number of categories to obtain. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } /// - /// Configures pagination.
This parameter has the `from` and `size` properties. + /// + /// Configures pagination. + /// This parameter has the from and size properties. + /// /// [JsonInclude, JsonPropertyName("page")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Page? Page { get; set; } } /// -/// Retrieves anomaly detection job results for one or more categories. +/// +/// Retrieves anomaly detection job results for one or more categories. +/// /// public sealed partial class GetCategoriesRequestDescriptor : RequestDescriptor { @@ -137,7 +156,10 @@ public GetCategoriesRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Server private Action PageDescriptorAction { get; set; } /// - /// Configures pagination.
This parameter has the `from` and `size` properties. + /// + /// Configures pagination. + /// This parameter has the from and size properties. + /// /// public GetCategoriesRequestDescriptor Page(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Page? page) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetDataFrameAnalyticsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetDataFrameAnalyticsRequest.g.cs index b8ea46835d0..48de22a2ac8 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetDataFrameAnalyticsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetDataFrameAnalyticsRequest.g.cs @@ -32,30 +32,67 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class GetDataFrameAnalyticsRequestParameters : RequestParameters { /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no data frame analytics
jobs that match.
2. Contains the `_all` string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// The default value returns an empty data_frame_analytics array when there
are no matches and the subset of results when there are partial matches.
If this parameter is `false`, the request returns a 404 status code when
there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no data frame analytics + /// jobs that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// The default value returns an empty data_frame_analytics array when there + /// are no matches and the subset of results when there are partial matches. + /// If this parameter is false, the request returns a 404 status code when + /// there are no matches or only partial matches. + /// /// public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Indicates if certain fields should be removed from the configuration on
retrieval. This allows the configuration to be in an acceptable format to
be retrieved and then added to another cluster. + /// + /// Indicates if certain fields should be removed from the configuration on + /// retrieval. This allows the configuration to be in an acceptable format to + /// be retrieved and then added to another cluster. + /// /// public bool? ExcludeGenerated { get => Q("exclude_generated"); set => Q("exclude_generated", value); } /// - /// Skips the specified number of data frame analytics jobs. + /// + /// Skips the specified number of data frame analytics jobs. + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of data frame analytics jobs to obtain. + /// + /// Specifies the maximum number of data frame analytics jobs to obtain. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. +/// +/// Retrieves configuration information for data frame analytics jobs. +/// You can get information for multiple data frame analytics jobs in a single +/// API request by using a comma-separated list of data frame analytics jobs or a +/// wildcard expression. +/// /// public sealed partial class GetDataFrameAnalyticsRequest : PlainRequest { @@ -76,34 +113,71 @@ public GetDataFrameAnalyticsRequest(Elastic.Clients.Elasticsearch.Serverless.Id? internal override string OperationName => "ml.get_data_frame_analytics"; /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no data frame analytics
jobs that match.
2. Contains the `_all` string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// The default value returns an empty data_frame_analytics array when there
are no matches and the subset of results when there are partial matches.
If this parameter is `false`, the request returns a 404 status code when
there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no data frame analytics + /// jobs that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// The default value returns an empty data_frame_analytics array when there + /// are no matches and the subset of results when there are partial matches. + /// If this parameter is false, the request returns a 404 status code when + /// there are no matches or only partial matches. + /// /// [JsonIgnore] public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Indicates if certain fields should be removed from the configuration on
retrieval. This allows the configuration to be in an acceptable format to
be retrieved and then added to another cluster. + /// + /// Indicates if certain fields should be removed from the configuration on + /// retrieval. This allows the configuration to be in an acceptable format to + /// be retrieved and then added to another cluster. + /// /// [JsonIgnore] public bool? ExcludeGenerated { get => Q("exclude_generated"); set => Q("exclude_generated", value); } /// - /// Skips the specified number of data frame analytics jobs. + /// + /// Skips the specified number of data frame analytics jobs. + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of data frame analytics jobs to obtain. + /// + /// Specifies the maximum number of data frame analytics jobs to obtain. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. +/// +/// Retrieves configuration information for data frame analytics jobs. +/// You can get information for multiple data frame analytics jobs in a single +/// API request by using a comma-separated list of data frame analytics jobs or a +/// wildcard expression. +/// /// public sealed partial class GetDataFrameAnalyticsRequestDescriptor : RequestDescriptor, GetDataFrameAnalyticsRequestParameters> { @@ -142,7 +216,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. +/// +/// Retrieves configuration information for data frame analytics jobs. +/// You can get information for multiple data frame analytics jobs in a single +/// API request by using a comma-separated list of data frame analytics jobs or a +/// wildcard expression. +/// /// public sealed partial class GetDataFrameAnalyticsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetDataFrameAnalyticsResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetDataFrameAnalyticsResponse.g.cs index 62d0b94ac6e..42dc76a3e59 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetDataFrameAnalyticsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetDataFrameAnalyticsResponse.g.cs @@ -32,7 +32,9 @@ public sealed partial class GetDataFrameAnalyticsResponse : ElasticsearchRespons public int Count { get; init; } /// - /// An array of data frame analytics job resources, which are sorted by the id value in ascending order. + /// + /// An array of data frame analytics job resources, which are sorted by the id value in ascending order. + /// /// [JsonInclude, JsonPropertyName("data_frame_analytics")] public IReadOnlyCollection DataFrameAnalytics { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetDataFrameAnalyticsStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetDataFrameAnalyticsStatsRequest.g.cs index 283e758f281..08b44bf5330 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetDataFrameAnalyticsStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetDataFrameAnalyticsStatsRequest.g.cs @@ -32,30 +32,62 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class GetDataFrameAnalyticsStatsRequestParameters : RequestParameters { /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no data frame analytics
jobs that match.
2. Contains the `_all` string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// The default value returns an empty data_frame_analytics array when there
are no matches and the subset of results when there are partial matches.
If this parameter is `false`, the request returns a 404 status code when
there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no data frame analytics + /// jobs that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// The default value returns an empty data_frame_analytics array when there + /// are no matches and the subset of results when there are partial matches. + /// If this parameter is false, the request returns a 404 status code when + /// there are no matches or only partial matches. + /// /// public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Skips the specified number of data frame analytics jobs. + /// + /// Skips the specified number of data frame analytics jobs. + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of data frame analytics jobs to obtain. + /// + /// Specifies the maximum number of data frame analytics jobs to obtain. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } /// - /// Defines whether the stats response should be verbose. + /// + /// Defines whether the stats response should be verbose. + /// /// public bool? Verbose { get => Q("verbose"); set => Q("verbose", value); } } /// -/// Retrieves usage information for data frame analytics jobs. +/// +/// Retrieves usage information for data frame analytics jobs. +/// /// public sealed partial class GetDataFrameAnalyticsStatsRequest : PlainRequest { @@ -76,34 +108,66 @@ public GetDataFrameAnalyticsStatsRequest(Elastic.Clients.Elasticsearch.Serverles internal override string OperationName => "ml.get_data_frame_analytics_stats"; /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no data frame analytics
jobs that match.
2. Contains the `_all` string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// The default value returns an empty data_frame_analytics array when there
are no matches and the subset of results when there are partial matches.
If this parameter is `false`, the request returns a 404 status code when
there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no data frame analytics + /// jobs that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// The default value returns an empty data_frame_analytics array when there + /// are no matches and the subset of results when there are partial matches. + /// If this parameter is false, the request returns a 404 status code when + /// there are no matches or only partial matches. + /// /// [JsonIgnore] public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Skips the specified number of data frame analytics jobs. + /// + /// Skips the specified number of data frame analytics jobs. + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of data frame analytics jobs to obtain. + /// + /// Specifies the maximum number of data frame analytics jobs to obtain. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } /// - /// Defines whether the stats response should be verbose. + /// + /// Defines whether the stats response should be verbose. + /// /// [JsonIgnore] public bool? Verbose { get => Q("verbose"); set => Q("verbose", value); } } /// -/// Retrieves usage information for data frame analytics jobs. +/// +/// Retrieves usage information for data frame analytics jobs. +/// /// public sealed partial class GetDataFrameAnalyticsStatsRequestDescriptor : RequestDescriptor, GetDataFrameAnalyticsStatsRequestParameters> { @@ -142,7 +206,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Retrieves usage information for data frame analytics jobs. +/// +/// Retrieves usage information for data frame analytics jobs. +/// /// public sealed partial class GetDataFrameAnalyticsStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetDataFrameAnalyticsStatsResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetDataFrameAnalyticsStatsResponse.g.cs index b486c4baed5..771939f5968 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetDataFrameAnalyticsStatsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetDataFrameAnalyticsStatsResponse.g.cs @@ -32,7 +32,9 @@ public sealed partial class GetDataFrameAnalyticsStatsResponse : ElasticsearchRe public long Count { get; init; } /// - /// An array of objects that contain usage information for data frame analytics jobs, which are sorted by the id value in ascending order. + /// + /// An array of objects that contain usage information for data frame analytics jobs, which are sorted by the id value in ascending order. + /// /// [JsonInclude, JsonPropertyName("data_frame_analytics")] public IReadOnlyCollection DataFrameAnalytics { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetDatafeedStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetDatafeedStatsRequest.g.cs index 153716021fb..c8b5f39eac4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetDatafeedStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetDatafeedStatsRequest.g.cs @@ -32,15 +32,46 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class GetDatafeedStatsRequestParameters : RequestParameters { /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no datafeeds that match.
2. Contains the `_all` string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// The default value is `true`, which returns an empty `datafeeds` array
when there are no matches and the subset of results when there are
partial matches. If this parameter is `false`, the request returns a
`404` status code when there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no datafeeds that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// The default value is true, which returns an empty datafeeds array + /// when there are no matches and the subset of results when there are + /// partial matches. If this parameter is false, the request returns a + /// 404 status code when there are no matches or only partial matches. + /// /// public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } } /// -/// Retrieves usage information for datafeeds.
You can get statistics for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get statistics for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``. If the datafeed is stopped, the
only information you receive is the `datafeed_id` and the `state`.
This API returns a maximum of 10,000 datafeeds. +/// +/// Retrieves usage information for datafeeds. +/// You can get statistics for multiple datafeeds in a single API request by +/// using a comma-separated list of datafeeds or a wildcard expression. You can +/// get statistics for all datafeeds by using _all, by specifying * as the +/// <feed_id>, or by omitting the <feed_id>. If the datafeed is stopped, the +/// only information you receive is the datafeed_id and the state. +/// This API returns a maximum of 10,000 datafeeds. +/// /// public sealed partial class GetDatafeedStatsRequest : PlainRequest { @@ -61,16 +92,47 @@ public GetDatafeedStatsRequest(Elastic.Clients.Elasticsearch.Serverless.Ids? dat internal override string OperationName => "ml.get_datafeed_stats"; /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no datafeeds that match.
2. Contains the `_all` string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// The default value is `true`, which returns an empty `datafeeds` array
when there are no matches and the subset of results when there are
partial matches. If this parameter is `false`, the request returns a
`404` status code when there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no datafeeds that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// The default value is true, which returns an empty datafeeds array + /// when there are no matches and the subset of results when there are + /// partial matches. If this parameter is false, the request returns a + /// 404 status code when there are no matches or only partial matches. + /// /// [JsonIgnore] public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } } /// -/// Retrieves usage information for datafeeds.
You can get statistics for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get statistics for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``. If the datafeed is stopped, the
only information you receive is the `datafeed_id` and the `state`.
This API returns a maximum of 10,000 datafeeds. +/// +/// Retrieves usage information for datafeeds. +/// You can get statistics for multiple datafeeds in a single API request by +/// using a comma-separated list of datafeeds or a wildcard expression. You can +/// get statistics for all datafeeds by using _all, by specifying * as the +/// <feed_id>, or by omitting the <feed_id>. If the datafeed is stopped, the +/// only information you receive is the datafeed_id and the state. +/// This API returns a maximum of 10,000 datafeeds. +/// /// public sealed partial class GetDatafeedStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetDatafeedsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetDatafeedsRequest.g.cs index ab800e2708c..66c9bdeccab 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetDatafeedsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetDatafeedsRequest.g.cs @@ -32,20 +32,54 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class GetDatafeedsRequestParameters : RequestParameters { /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no datafeeds that match.
2. Contains the `_all` string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// The default value is `true`, which returns an empty `datafeeds` array
when there are no matches and the subset of results when there are
partial matches. If this parameter is `false`, the request returns a
`404` status code when there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no datafeeds that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// The default value is true, which returns an empty datafeeds array + /// when there are no matches and the subset of results when there are + /// partial matches. If this parameter is false, the request returns a + /// 404 status code when there are no matches or only partial matches. + /// /// public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Indicates if certain fields should be removed from the configuration on
retrieval. This allows the configuration to be in an acceptable format to
be retrieved and then added to another cluster. + /// + /// Indicates if certain fields should be removed from the configuration on + /// retrieval. This allows the configuration to be in an acceptable format to + /// be retrieved and then added to another cluster. + /// /// public bool? ExcludeGenerated { get => Q("exclude_generated"); set => Q("exclude_generated", value); } } /// -/// Retrieves configuration information for datafeeds.
You can get information for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get information for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``.
This API returns a maximum of 10,000 datafeeds. +/// +/// Retrieves configuration information for datafeeds. +/// You can get information for multiple datafeeds in a single API request by +/// using a comma-separated list of datafeeds or a wildcard expression. You can +/// get information for all datafeeds by using _all, by specifying * as the +/// <feed_id>, or by omitting the <feed_id>. +/// This API returns a maximum of 10,000 datafeeds. +/// /// public sealed partial class GetDatafeedsRequest : PlainRequest { @@ -66,22 +100,56 @@ public GetDatafeedsRequest(Elastic.Clients.Elasticsearch.Serverless.Ids? datafee internal override string OperationName => "ml.get_datafeeds"; /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no datafeeds that match.
2. Contains the `_all` string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// The default value is `true`, which returns an empty `datafeeds` array
when there are no matches and the subset of results when there are
partial matches. If this parameter is `false`, the request returns a
`404` status code when there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no datafeeds that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// The default value is true, which returns an empty datafeeds array + /// when there are no matches and the subset of results when there are + /// partial matches. If this parameter is false, the request returns a + /// 404 status code when there are no matches or only partial matches. + /// /// [JsonIgnore] public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Indicates if certain fields should be removed from the configuration on
retrieval. This allows the configuration to be in an acceptable format to
be retrieved and then added to another cluster. + /// + /// Indicates if certain fields should be removed from the configuration on + /// retrieval. This allows the configuration to be in an acceptable format to + /// be retrieved and then added to another cluster. + /// /// [JsonIgnore] public bool? ExcludeGenerated { get => Q("exclude_generated"); set => Q("exclude_generated", value); } } /// -/// Retrieves configuration information for datafeeds.
You can get information for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get information for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``.
This API returns a maximum of 10,000 datafeeds. +/// +/// Retrieves configuration information for datafeeds. +/// You can get information for multiple datafeeds in a single API request by +/// using a comma-separated list of datafeeds or a wildcard expression. You can +/// get information for all datafeeds by using _all, by specifying * as the +/// <feed_id>, or by omitting the <feed_id>. +/// This API returns a maximum of 10,000 datafeeds. +/// /// public sealed partial class GetDatafeedsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetFiltersRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetFiltersRequest.g.cs index c351ac06be9..1c49125ce48 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetFiltersRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetFiltersRequest.g.cs @@ -32,18 +32,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class GetFiltersRequestParameters : RequestParameters { /// - /// Skips the specified number of filters. + /// + /// Skips the specified number of filters. + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of filters to obtain. + /// + /// Specifies the maximum number of filters to obtain. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Retrieves filters.
You can get a single filter or all filters. +/// +/// Retrieves filters. +/// You can get a single filter or all filters. +/// /// public sealed partial class GetFiltersRequest : PlainRequest { @@ -64,20 +71,27 @@ public GetFiltersRequest(Elastic.Clients.Elasticsearch.Serverless.Ids? filterId) internal override string OperationName => "ml.get_filters"; /// - /// Skips the specified number of filters. + /// + /// Skips the specified number of filters. + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of filters to obtain. + /// + /// Specifies the maximum number of filters to obtain. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Retrieves filters.
You can get a single filter or all filters. +/// +/// Retrieves filters. +/// You can get a single filter or all filters. +/// /// public sealed partial class GetFiltersRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetInfluencersRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetInfluencersRequest.g.cs index 80accaa1352..284a1144592 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetInfluencersRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetInfluencersRequest.g.cs @@ -32,48 +32,75 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class GetInfluencersRequestParameters : RequestParameters { /// - /// If true, the results are sorted in descending order. + /// + /// If true, the results are sorted in descending order. + /// /// public bool? Desc { get => Q("desc"); set => Q("desc", value); } /// - /// Returns influencers with timestamps earlier than this time.
The default value means it is unset and results are not limited to
specific timestamps. + /// + /// Returns influencers with timestamps earlier than this time. + /// The default value means it is unset and results are not limited to + /// specific timestamps. + /// /// public DateTimeOffset? End { get => Q("end"); set => Q("end", value); } /// - /// If true, the output excludes interim results. By default, interim results
are included. + /// + /// If true, the output excludes interim results. By default, interim results + /// are included. + /// /// public bool? ExcludeInterim { get => Q("exclude_interim"); set => Q("exclude_interim", value); } /// - /// Skips the specified number of influencers. + /// + /// Skips the specified number of influencers. + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// Returns influencers with anomaly scores greater than or equal to this
value. + /// + /// Returns influencers with anomaly scores greater than or equal to this + /// value. + /// /// public double? InfluencerScore { get => Q("influencer_score"); set => Q("influencer_score", value); } /// - /// Specifies the maximum number of influencers to obtain. + /// + /// Specifies the maximum number of influencers to obtain. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } /// - /// Specifies the sort field for the requested influencers. By default, the
influencers are sorted by the `influencer_score` value. + /// + /// Specifies the sort field for the requested influencers. By default, the + /// influencers are sorted by the influencer_score value. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Field? Sort { get => Q("sort"); set => Q("sort", value); } /// - /// Returns influencers with timestamps after this time. The default value
means it is unset and results are not limited to specific timestamps. + /// + /// Returns influencers with timestamps after this time. The default value + /// means it is unset and results are not limited to specific timestamps. + /// /// public DateTimeOffset? Start { get => Q("start"); set => Q("start", value); } } /// -/// Retrieves anomaly detection job results for one or more influencers.
Influencers are the entities that have contributed to, or are to blame for,
the anomalies. Influencer results are available only if an
`influencer_field_name` is specified in the job configuration. +/// +/// Retrieves anomaly detection job results for one or more influencers. +/// Influencers are the entities that have contributed to, or are to blame for, +/// the anomalies. Influencer results are available only if an +/// influencer_field_name is specified in the job configuration. +/// /// public sealed partial class GetInfluencersRequest : PlainRequest { @@ -90,62 +117,92 @@ public GetInfluencersRequest(Elastic.Clients.Elasticsearch.Serverless.Id jobId) internal override string OperationName => "ml.get_influencers"; /// - /// If true, the results are sorted in descending order. + /// + /// If true, the results are sorted in descending order. + /// /// [JsonIgnore] public bool? Desc { get => Q("desc"); set => Q("desc", value); } /// - /// Returns influencers with timestamps earlier than this time.
The default value means it is unset and results are not limited to
specific timestamps. + /// + /// Returns influencers with timestamps earlier than this time. + /// The default value means it is unset and results are not limited to + /// specific timestamps. + /// /// [JsonIgnore] public DateTimeOffset? End { get => Q("end"); set => Q("end", value); } /// - /// If true, the output excludes interim results. By default, interim results
are included. + /// + /// If true, the output excludes interim results. By default, interim results + /// are included. + /// /// [JsonIgnore] public bool? ExcludeInterim { get => Q("exclude_interim"); set => Q("exclude_interim", value); } /// - /// Skips the specified number of influencers. + /// + /// Skips the specified number of influencers. + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// Returns influencers with anomaly scores greater than or equal to this
value. + /// + /// Returns influencers with anomaly scores greater than or equal to this + /// value. + /// /// [JsonIgnore] public double? InfluencerScore { get => Q("influencer_score"); set => Q("influencer_score", value); } /// - /// Specifies the maximum number of influencers to obtain. + /// + /// Specifies the maximum number of influencers to obtain. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } /// - /// Specifies the sort field for the requested influencers. By default, the
influencers are sorted by the `influencer_score` value. + /// + /// Specifies the sort field for the requested influencers. By default, the + /// influencers are sorted by the influencer_score value. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Field? Sort { get => Q("sort"); set => Q("sort", value); } /// - /// Returns influencers with timestamps after this time. The default value
means it is unset and results are not limited to specific timestamps. + /// + /// Returns influencers with timestamps after this time. The default value + /// means it is unset and results are not limited to specific timestamps. + /// /// [JsonIgnore] public DateTimeOffset? Start { get => Q("start"); set => Q("start", value); } /// - /// Configures pagination.
This parameter has the `from` and `size` properties. + /// + /// Configures pagination. + /// This parameter has the from and size properties. + /// /// [JsonInclude, JsonPropertyName("page")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Page? Page { get; set; } } /// -/// Retrieves anomaly detection job results for one or more influencers.
Influencers are the entities that have contributed to, or are to blame for,
the anomalies. Influencer results are available only if an
`influencer_field_name` is specified in the job configuration. +/// +/// Retrieves anomaly detection job results for one or more influencers. +/// Influencers are the entities that have contributed to, or are to blame for, +/// the anomalies. Influencer results are available only if an +/// influencer_field_name is specified in the job configuration. +/// /// public sealed partial class GetInfluencersRequestDescriptor : RequestDescriptor, GetInfluencersRequestParameters> { @@ -183,7 +240,10 @@ public GetInfluencersRequestDescriptor JobId(Elastic.Clients.Elastics private Action PageDescriptorAction { get; set; } /// - /// Configures pagination.
This parameter has the `from` and `size` properties. + /// + /// Configures pagination. + /// This parameter has the from and size properties. + /// /// public GetInfluencersRequestDescriptor Page(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Page? page) { @@ -233,7 +293,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Retrieves anomaly detection job results for one or more influencers.
Influencers are the entities that have contributed to, or are to blame for,
the anomalies. Influencer results are available only if an
`influencer_field_name` is specified in the job configuration. +/// +/// Retrieves anomaly detection job results for one or more influencers. +/// Influencers are the entities that have contributed to, or are to blame for, +/// the anomalies. Influencer results are available only if an +/// influencer_field_name is specified in the job configuration. +/// /// public sealed partial class GetInfluencersRequestDescriptor : RequestDescriptor { @@ -271,7 +336,10 @@ public GetInfluencersRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Serve private Action PageDescriptorAction { get; set; } /// - /// Configures pagination.
This parameter has the `from` and `size` properties. + /// + /// Configures pagination. + /// This parameter has the from and size properties. + /// /// public GetInfluencersRequestDescriptor Page(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Page? page) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetInfluencersResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetInfluencersResponse.g.cs index cc5f7cffd68..3d09d58a4df 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetInfluencersResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetInfluencersResponse.g.cs @@ -32,7 +32,9 @@ public sealed partial class GetInfluencersResponse : ElasticsearchResponse public long Count { get; init; } /// - /// Array of influencer objects + /// + /// Array of influencer objects + /// /// [JsonInclude, JsonPropertyName("influencers")] public IReadOnlyCollection Influencers { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetJobStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetJobStatsRequest.g.cs index d7626f9d975..6f37b1614b4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetJobStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetJobStatsRequest.g.cs @@ -32,15 +32,40 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class GetJobStatsRequestParameters : RequestParameters { /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no jobs that match.
2. Contains the _all string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// If `true`, the API returns an empty `jobs` array when
there are no matches and the subset of results when there are partial
matches. If `false`, the API returns a `404` status
code when there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no jobs that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// If true, the API returns an empty jobs array when + /// there are no matches and the subset of results when there are partial + /// matches. If false, the API returns a 404 status + /// code when there are no matches or only partial matches. + /// /// public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } } /// -/// Retrieves usage information for anomaly detection jobs. +/// +/// Retrieves usage information for anomaly detection jobs. +/// /// public sealed partial class GetJobStatsRequest : PlainRequest { @@ -61,16 +86,41 @@ public GetJobStatsRequest(Elastic.Clients.Elasticsearch.Serverless.Id? jobId) : internal override string OperationName => "ml.get_job_stats"; /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no jobs that match.
2. Contains the _all string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// If `true`, the API returns an empty `jobs` array when
there are no matches and the subset of results when there are partial
matches. If `false`, the API returns a `404` status
code when there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no jobs that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// If true, the API returns an empty jobs array when + /// there are no matches and the subset of results when there are partial + /// matches. If false, the API returns a 404 status + /// code when there are no matches or only partial matches. + /// /// [JsonIgnore] public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } } /// -/// Retrieves usage information for anomaly detection jobs. +/// +/// Retrieves usage information for anomaly detection jobs. +/// /// public sealed partial class GetJobStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetJobsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetJobsRequest.g.cs index e014c800e2c..3f96b65c613 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetJobsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetJobsRequest.g.cs @@ -32,20 +32,53 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class GetJobsRequestParameters : RequestParameters { /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no jobs that match.
2. Contains the _all string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// The default value is `true`, which returns an empty `jobs` array when
there are no matches and the subset of results when there are partial
matches. If this parameter is `false`, the request returns a `404` status
code when there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no jobs that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// The default value is true, which returns an empty jobs array when + /// there are no matches and the subset of results when there are partial + /// matches. If this parameter is false, the request returns a 404 status + /// code when there are no matches or only partial matches. + /// /// public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Indicates if certain fields should be removed from the configuration on
retrieval. This allows the configuration to be in an acceptable format to
be retrieved and then added to another cluster. + /// + /// Indicates if certain fields should be removed from the configuration on + /// retrieval. This allows the configuration to be in an acceptable format to + /// be retrieved and then added to another cluster. + /// /// public bool? ExcludeGenerated { get => Q("exclude_generated"); set => Q("exclude_generated", value); } } /// -/// Retrieves configuration information for anomaly detection jobs.
You can get information for multiple anomaly detection jobs in a single API
request by using a group name, a comma-separated list of jobs, or a wildcard
expression. You can get information for all anomaly detection jobs by using
`_all`, by specifying `*` as the ``, or by omitting the ``. +/// +/// Retrieves configuration information for anomaly detection jobs. +/// You can get information for multiple anomaly detection jobs in a single API +/// request by using a group name, a comma-separated list of jobs, or a wildcard +/// expression. You can get information for all anomaly detection jobs by using +/// _all, by specifying * as the <job_id>, or by omitting the <job_id>. +/// /// public sealed partial class GetJobsRequest : PlainRequest { @@ -66,22 +99,55 @@ public GetJobsRequest(Elastic.Clients.Elasticsearch.Serverless.Ids? jobId) : bas internal override string OperationName => "ml.get_jobs"; /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no jobs that match.
2. Contains the _all string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// The default value is `true`, which returns an empty `jobs` array when
there are no matches and the subset of results when there are partial
matches. If this parameter is `false`, the request returns a `404` status
code when there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no jobs that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// The default value is true, which returns an empty jobs array when + /// there are no matches and the subset of results when there are partial + /// matches. If this parameter is false, the request returns a 404 status + /// code when there are no matches or only partial matches. + /// /// [JsonIgnore] public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Indicates if certain fields should be removed from the configuration on
retrieval. This allows the configuration to be in an acceptable format to
be retrieved and then added to another cluster. + /// + /// Indicates if certain fields should be removed from the configuration on + /// retrieval. This allows the configuration to be in an acceptable format to + /// be retrieved and then added to another cluster. + /// /// [JsonIgnore] public bool? ExcludeGenerated { get => Q("exclude_generated"); set => Q("exclude_generated", value); } } /// -/// Retrieves configuration information for anomaly detection jobs.
You can get information for multiple anomaly detection jobs in a single API
request by using a group name, a comma-separated list of jobs, or a wildcard
expression. You can get information for all anomaly detection jobs by using
`_all`, by specifying `*` as the ``, or by omitting the ``. +/// +/// Retrieves configuration information for anomaly detection jobs. +/// You can get information for multiple anomaly detection jobs in a single API +/// request by using a group name, a comma-separated list of jobs, or a wildcard +/// expression. You can get information for all anomaly detection jobs by using +/// _all, by specifying * as the <job_id>, or by omitting the <job_id>. +/// /// public sealed partial class GetJobsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetMemoryStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetMemoryStatsRequest.g.cs index 19d06374b9e..3ce4e4f34f5 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetMemoryStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetMemoryStatsRequest.g.cs @@ -32,18 +32,27 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class GetMemoryStatsRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node. If no response is received before the timeout
expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout + /// expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request
fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request + /// fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Get information about how machine learning jobs and trained models are using memory,
on each node, both within the JVM heap, and natively, outside of the JVM. +/// +/// Get information about how machine learning jobs and trained models are using memory, +/// on each node, both within the JVM heap, and natively, outside of the JVM. +/// /// public sealed partial class GetMemoryStatsRequest : PlainRequest { @@ -64,20 +73,29 @@ public GetMemoryStatsRequest(Elastic.Clients.Elasticsearch.Serverless.Id? nodeId internal override string OperationName => "ml.get_memory_stats"; /// - /// Period to wait for a connection to the master node. If no response is received before the timeout
expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout + /// expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request
fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request + /// fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Get information about how machine learning jobs and trained models are using memory,
on each node, both within the JVM heap, and natively, outside of the JVM. +/// +/// Get information about how machine learning jobs and trained models are using memory, +/// on each node, both within the JVM heap, and natively, outside of the JVM. +/// /// public sealed partial class GetMemoryStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetModelSnapshotUpgradeStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetModelSnapshotUpgradeStatsRequest.g.cs index 4cdb0468e27..d46d6fd2f5e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetModelSnapshotUpgradeStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetModelSnapshotUpgradeStatsRequest.g.cs @@ -32,15 +32,39 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class GetModelSnapshotUpgradeStatsRequestParameters : RequestParameters { /// - /// Specifies what to do when the request: - /// - Contains wildcard expressions and there are no jobs that match.
- Contains the _all string or no identifiers and there are no matches.
- Contains wildcard expressions and there are only partial matches. - /// The default value is true, which returns an empty jobs array when there are no matches and the subset of results
when there are partial matches. If this parameter is false, the request returns a 404 status code when there are
no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no jobs that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// The default value is true, which returns an empty jobs array when there are no matches and the subset of results + /// when there are partial matches. If this parameter is false, the request returns a 404 status code when there are + /// no matches or only partial matches. + /// /// public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } } /// -/// Retrieves usage information for anomaly detection job model snapshot upgrades. +/// +/// Retrieves usage information for anomaly detection job model snapshot upgrades. +/// /// public sealed partial class GetModelSnapshotUpgradeStatsRequest : PlainRequest { @@ -57,16 +81,40 @@ public GetModelSnapshotUpgradeStatsRequest(Elastic.Clients.Elasticsearch.Serverl internal override string OperationName => "ml.get_model_snapshot_upgrade_stats"; /// - /// Specifies what to do when the request: - /// - Contains wildcard expressions and there are no jobs that match.
- Contains the _all string or no identifiers and there are no matches.
- Contains wildcard expressions and there are only partial matches. - /// The default value is true, which returns an empty jobs array when there are no matches and the subset of results
when there are partial matches. If this parameter is false, the request returns a 404 status code when there are
no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no jobs that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// The default value is true, which returns an empty jobs array when there are no matches and the subset of results + /// when there are partial matches. If this parameter is false, the request returns a 404 status code when there are + /// no matches or only partial matches. + /// /// [JsonIgnore] public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } } /// -/// Retrieves usage information for anomaly detection job model snapshot upgrades. +/// +/// Retrieves usage information for anomaly detection job model snapshot upgrades. +/// /// public sealed partial class GetModelSnapshotUpgradeStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetModelSnapshotsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetModelSnapshotsRequest.g.cs index e78f9daa3dc..93acc17b0bb 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetModelSnapshotsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetModelSnapshotsRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class GetModelSnapshotsRequestParameters : RequestParameters { /// - /// Skips the specified number of snapshots. + /// + /// Skips the specified number of snapshots. + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of snapshots to obtain. + /// + /// Specifies the maximum number of snapshots to obtain. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Retrieves information about model snapshots. +/// +/// Retrieves information about model snapshots. +/// /// public sealed partial class GetModelSnapshotsRequest : PlainRequest { @@ -64,25 +70,33 @@ public GetModelSnapshotsRequest(Elastic.Clients.Elasticsearch.Serverless.Id jobI internal override string OperationName => "ml.get_model_snapshots"; /// - /// Skips the specified number of snapshots. + /// + /// Skips the specified number of snapshots. + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of snapshots to obtain. + /// + /// Specifies the maximum number of snapshots to obtain. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } /// - /// Refer to the description for the `desc` query parameter. + /// + /// Refer to the description for the desc query parameter. + /// /// [JsonInclude, JsonPropertyName("desc")] public bool? Desc { get; set; } /// - /// Refer to the description for the `end` query parameter. + /// + /// Refer to the description for the end query parameter. + /// /// [JsonInclude, JsonPropertyName("end")] public DateTimeOffset? End { get; set; } @@ -90,20 +104,26 @@ public GetModelSnapshotsRequest(Elastic.Clients.Elasticsearch.Serverless.Id jobI public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Page? Page { get; set; } /// - /// Refer to the description for the `sort` query parameter. + /// + /// Refer to the description for the sort query parameter. + /// /// [JsonInclude, JsonPropertyName("sort")] public Elastic.Clients.Elasticsearch.Serverless.Field? Sort { get; set; } /// - /// Refer to the description for the `start` query parameter. + /// + /// Refer to the description for the start query parameter. + /// /// [JsonInclude, JsonPropertyName("start")] public DateTimeOffset? Start { get; set; } } /// -/// Retrieves information about model snapshots. +/// +/// Retrieves information about model snapshots. +/// /// public sealed partial class GetModelSnapshotsRequestDescriptor : RequestDescriptor, GetModelSnapshotsRequestParameters> { @@ -149,7 +169,9 @@ public GetModelSnapshotsRequestDescriptor SnapshotId(Elastic.Clients. private DateTimeOffset? StartValue { get; set; } /// - /// Refer to the description for the `desc` query parameter. + /// + /// Refer to the description for the desc query parameter. + /// /// public GetModelSnapshotsRequestDescriptor Desc(bool? desc = true) { @@ -158,7 +180,9 @@ public GetModelSnapshotsRequestDescriptor Desc(bool? desc = true) } /// - /// Refer to the description for the `end` query parameter. + /// + /// Refer to the description for the end query parameter. + /// /// public GetModelSnapshotsRequestDescriptor End(DateTimeOffset? end) { @@ -191,7 +215,9 @@ public GetModelSnapshotsRequestDescriptor Page(Action - /// Refer to the description for the `sort` query parameter. + /// + /// Refer to the description for the sort query parameter. + /// /// public GetModelSnapshotsRequestDescriptor Sort(Elastic.Clients.Elasticsearch.Serverless.Field? sort) { @@ -200,7 +226,9 @@ public GetModelSnapshotsRequestDescriptor Sort(Elastic.Clients.Elasti } /// - /// Refer to the description for the `sort` query parameter. + /// + /// Refer to the description for the sort query parameter. + /// /// public GetModelSnapshotsRequestDescriptor Sort(Expression> sort) { @@ -209,7 +237,9 @@ public GetModelSnapshotsRequestDescriptor Sort(Expression - /// Refer to the description for the `sort` query parameter. + /// + /// Refer to the description for the sort query parameter. + /// /// public GetModelSnapshotsRequestDescriptor Sort(Expression> sort) { @@ -218,7 +248,9 @@ public GetModelSnapshotsRequestDescriptor Sort(Expression - /// Refer to the description for the `start` query parameter. + /// + /// Refer to the description for the start query parameter. + /// /// public GetModelSnapshotsRequestDescriptor Start(DateTimeOffset? start) { @@ -274,7 +306,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Retrieves information about model snapshots. +/// +/// Retrieves information about model snapshots. +/// /// public sealed partial class GetModelSnapshotsRequestDescriptor : RequestDescriptor { @@ -320,7 +354,9 @@ public GetModelSnapshotsRequestDescriptor SnapshotId(Elastic.Clients.Elasticsear private DateTimeOffset? StartValue { get; set; } /// - /// Refer to the description for the `desc` query parameter. + /// + /// Refer to the description for the desc query parameter. + /// /// public GetModelSnapshotsRequestDescriptor Desc(bool? desc = true) { @@ -329,7 +365,9 @@ public GetModelSnapshotsRequestDescriptor Desc(bool? desc = true) } /// - /// Refer to the description for the `end` query parameter. + /// + /// Refer to the description for the end query parameter. + /// /// public GetModelSnapshotsRequestDescriptor End(DateTimeOffset? end) { @@ -362,7 +400,9 @@ public GetModelSnapshotsRequestDescriptor Page(Action - /// Refer to the description for the `sort` query parameter. + /// + /// Refer to the description for the sort query parameter. + /// /// public GetModelSnapshotsRequestDescriptor Sort(Elastic.Clients.Elasticsearch.Serverless.Field? sort) { @@ -371,7 +411,9 @@ public GetModelSnapshotsRequestDescriptor Sort(Elastic.Clients.Elasticsearch.Ser } /// - /// Refer to the description for the `sort` query parameter. + /// + /// Refer to the description for the sort query parameter. + /// /// public GetModelSnapshotsRequestDescriptor Sort(Expression> sort) { @@ -380,7 +422,9 @@ public GetModelSnapshotsRequestDescriptor Sort(Expression - /// Refer to the description for the `sort` query parameter. + /// + /// Refer to the description for the sort query parameter. + /// /// public GetModelSnapshotsRequestDescriptor Sort(Expression> sort) { @@ -389,7 +433,9 @@ public GetModelSnapshotsRequestDescriptor Sort(Expression - /// Refer to the description for the `start` query parameter. + /// + /// Refer to the description for the start query parameter. + /// /// public GetModelSnapshotsRequestDescriptor Start(DateTimeOffset? start) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetOverallBucketsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetOverallBucketsRequest.g.cs index ac767207b2a..e222aa49ce3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetOverallBucketsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetOverallBucketsRequest.g.cs @@ -34,8 +34,26 @@ public sealed partial class GetOverallBucketsRequestParameters : RequestParamete } /// -/// Retrieves overall bucket results that summarize the bucket results of
multiple anomaly detection jobs. -/// The `overall_score` is calculated by combining the scores of all the
buckets within the overall bucket span. First, the maximum
`anomaly_score` per anomaly detection job in the overall bucket is
calculated. Then the `top_n` of those scores are averaged to result in
the `overall_score`. This means that you can fine-tune the
`overall_score` so that it is more or less sensitive to the number of
jobs that detect an anomaly at the same time. For example, if you set
`top_n` to `1`, the `overall_score` is the maximum bucket score in the
overall bucket. Alternatively, if you set `top_n` to the number of jobs,
the `overall_score` is high only when all jobs detect anomalies in that
overall bucket. If you set the `bucket_span` parameter (to a value
greater than its default), the `overall_score` is the maximum
`overall_score` of the overall buckets that have a span equal to the
jobs' largest bucket span. +/// +/// Retrieves overall bucket results that summarize the bucket results of +/// multiple anomaly detection jobs. +/// +/// +/// The overall_score is calculated by combining the scores of all the +/// buckets within the overall bucket span. First, the maximum +/// anomaly_score per anomaly detection job in the overall bucket is +/// calculated. Then the top_n of those scores are averaged to result in +/// the overall_score. This means that you can fine-tune the +/// overall_score so that it is more or less sensitive to the number of +/// jobs that detect an anomaly at the same time. For example, if you set +/// top_n to 1, the overall_score is the maximum bucket score in the +/// overall bucket. Alternatively, if you set top_n to the number of jobs, +/// the overall_score is high only when all jobs detect anomalies in that +/// overall bucket. If you set the bucket_span parameter (to a value +/// greater than its default), the overall_score is the maximum +/// overall_score of the overall buckets that have a span equal to the +/// jobs' largest bucket span. +/// /// public sealed partial class GetOverallBucketsRequest : PlainRequest { @@ -52,51 +70,83 @@ public GetOverallBucketsRequest(Elastic.Clients.Elasticsearch.Serverless.Id jobI internal override string OperationName => "ml.get_overall_buckets"; /// - /// Refer to the description for the `allow_no_match` query parameter. + /// + /// Refer to the description for the allow_no_match query parameter. + /// /// [JsonInclude, JsonPropertyName("allow_no_match")] public bool? AllowNoMatch { get; set; } /// - /// Refer to the description for the `bucket_span` query parameter. + /// + /// Refer to the description for the bucket_span query parameter. + /// /// [JsonInclude, JsonPropertyName("bucket_span")] public Elastic.Clients.Elasticsearch.Serverless.Duration? BucketSpan { get; set; } /// - /// Refer to the description for the `end` query parameter. + /// + /// Refer to the description for the end query parameter. + /// /// [JsonInclude, JsonPropertyName("end")] public DateTimeOffset? End { get; set; } /// - /// Refer to the description for the `exclude_interim` query parameter. + /// + /// Refer to the description for the exclude_interim query parameter. + /// /// [JsonInclude, JsonPropertyName("exclude_interim")] public bool? ExcludeInterim { get; set; } /// - /// Refer to the description for the `overall_score` query parameter. + /// + /// Refer to the description for the overall_score query parameter. + /// /// [JsonInclude, JsonPropertyName("overall_score")] public object? OverallScore { get; set; } /// - /// Refer to the description for the `start` query parameter. + /// + /// Refer to the description for the start query parameter. + /// /// [JsonInclude, JsonPropertyName("start")] public DateTimeOffset? Start { get; set; } /// - /// Refer to the description for the `top_n` query parameter. + /// + /// Refer to the description for the top_n query parameter. + /// /// [JsonInclude, JsonPropertyName("top_n")] public int? TopN { get; set; } } /// -/// Retrieves overall bucket results that summarize the bucket results of
multiple anomaly detection jobs. -/// The `overall_score` is calculated by combining the scores of all the
buckets within the overall bucket span. First, the maximum
`anomaly_score` per anomaly detection job in the overall bucket is
calculated. Then the `top_n` of those scores are averaged to result in
the `overall_score`. This means that you can fine-tune the
`overall_score` so that it is more or less sensitive to the number of
jobs that detect an anomaly at the same time. For example, if you set
`top_n` to `1`, the `overall_score` is the maximum bucket score in the
overall bucket. Alternatively, if you set `top_n` to the number of jobs,
the `overall_score` is high only when all jobs detect anomalies in that
overall bucket. If you set the `bucket_span` parameter (to a value
greater than its default), the `overall_score` is the maximum
`overall_score` of the overall buckets that have a span equal to the
jobs' largest bucket span. +/// +/// Retrieves overall bucket results that summarize the bucket results of +/// multiple anomaly detection jobs. +/// +/// +/// The overall_score is calculated by combining the scores of all the +/// buckets within the overall bucket span. First, the maximum +/// anomaly_score per anomaly detection job in the overall bucket is +/// calculated. Then the top_n of those scores are averaged to result in +/// the overall_score. This means that you can fine-tune the +/// overall_score so that it is more or less sensitive to the number of +/// jobs that detect an anomaly at the same time. For example, if you set +/// top_n to 1, the overall_score is the maximum bucket score in the +/// overall bucket. Alternatively, if you set top_n to the number of jobs, +/// the overall_score is high only when all jobs detect anomalies in that +/// overall bucket. If you set the bucket_span parameter (to a value +/// greater than its default), the overall_score is the maximum +/// overall_score of the overall buckets that have a span equal to the +/// jobs' largest bucket span. +/// /// public sealed partial class GetOverallBucketsRequestDescriptor : RequestDescriptor { @@ -129,7 +179,9 @@ public GetOverallBucketsRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Se private int? TopNValue { get; set; } /// - /// Refer to the description for the `allow_no_match` query parameter. + /// + /// Refer to the description for the allow_no_match query parameter. + /// /// public GetOverallBucketsRequestDescriptor AllowNoMatch(bool? allowNoMatch = true) { @@ -138,7 +190,9 @@ public GetOverallBucketsRequestDescriptor AllowNoMatch(bool? allowNoMatch = true } /// - /// Refer to the description for the `bucket_span` query parameter. + /// + /// Refer to the description for the bucket_span query parameter. + /// /// public GetOverallBucketsRequestDescriptor BucketSpan(Elastic.Clients.Elasticsearch.Serverless.Duration? bucketSpan) { @@ -147,7 +201,9 @@ public GetOverallBucketsRequestDescriptor BucketSpan(Elastic.Clients.Elasticsear } /// - /// Refer to the description for the `end` query parameter. + /// + /// Refer to the description for the end query parameter. + /// /// public GetOverallBucketsRequestDescriptor End(DateTimeOffset? end) { @@ -156,7 +212,9 @@ public GetOverallBucketsRequestDescriptor End(DateTimeOffset? end) } /// - /// Refer to the description for the `exclude_interim` query parameter. + /// + /// Refer to the description for the exclude_interim query parameter. + /// /// public GetOverallBucketsRequestDescriptor ExcludeInterim(bool? excludeInterim = true) { @@ -165,7 +223,9 @@ public GetOverallBucketsRequestDescriptor ExcludeInterim(bool? excludeInterim = } /// - /// Refer to the description for the `overall_score` query parameter. + /// + /// Refer to the description for the overall_score query parameter. + /// /// public GetOverallBucketsRequestDescriptor OverallScore(object? overallScore) { @@ -174,7 +234,9 @@ public GetOverallBucketsRequestDescriptor OverallScore(object? overallScore) } /// - /// Refer to the description for the `start` query parameter. + /// + /// Refer to the description for the start query parameter. + /// /// public GetOverallBucketsRequestDescriptor Start(DateTimeOffset? start) { @@ -183,7 +245,9 @@ public GetOverallBucketsRequestDescriptor Start(DateTimeOffset? start) } /// - /// Refer to the description for the `top_n` query parameter. + /// + /// Refer to the description for the top_n query parameter. + /// /// public GetOverallBucketsRequestDescriptor TopN(int? topN) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetOverallBucketsResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetOverallBucketsResponse.g.cs index 5415cf2c3bb..f5d132ee50e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetOverallBucketsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetOverallBucketsResponse.g.cs @@ -32,7 +32,9 @@ public sealed partial class GetOverallBucketsResponse : ElasticsearchResponse public long Count { get; init; } /// - /// Array of overall bucket objects + /// + /// Array of overall bucket objects + /// /// [JsonInclude, JsonPropertyName("overall_buckets")] public IReadOnlyCollection OverallBuckets { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetRecordsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetRecordsRequest.g.cs index 5ddd46f69d7..57a886b8d92 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetRecordsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetRecordsRequest.g.cs @@ -32,18 +32,34 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class GetRecordsRequestParameters : RequestParameters { /// - /// Skips the specified number of records. + /// + /// Skips the specified number of records. + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of records to obtain. + /// + /// Specifies the maximum number of records to obtain. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Retrieves anomaly records for an anomaly detection job.
Records contain the detailed analytical results. They describe the anomalous
activity that has been identified in the input data based on the detector
configuration.
There can be many anomaly records depending on the characteristics and size
of the input data. In practice, there are often too many to be able to
manually process them. The machine learning features therefore perform a
sophisticated aggregation of the anomaly records into buckets.
The number of record results depends on the number of anomalies found in each
bucket, which relates to the number of time series being modeled and the
number of detectors. +/// +/// Retrieves anomaly records for an anomaly detection job. +/// Records contain the detailed analytical results. They describe the anomalous +/// activity that has been identified in the input data based on the detector +/// configuration. +/// There can be many anomaly records depending on the characteristics and size +/// of the input data. In practice, there are often too many to be able to +/// manually process them. The machine learning features therefore perform a +/// sophisticated aggregation of the anomaly records into buckets. +/// The number of record results depends on the number of anomalies found in each +/// bucket, which relates to the number of time series being modeled and the +/// number of detectors. +/// /// public sealed partial class GetRecordsRequest : PlainRequest { @@ -60,31 +76,41 @@ public GetRecordsRequest(Elastic.Clients.Elasticsearch.Serverless.Id jobId) : ba internal override string OperationName => "ml.get_records"; /// - /// Skips the specified number of records. + /// + /// Skips the specified number of records. + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of records to obtain. + /// + /// Specifies the maximum number of records to obtain. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } /// - /// Refer to the description for the `desc` query parameter. + /// + /// Refer to the description for the desc query parameter. + /// /// [JsonInclude, JsonPropertyName("desc")] public bool? Desc { get; set; } /// - /// Refer to the description for the `end` query parameter. + /// + /// Refer to the description for the end query parameter. + /// /// [JsonInclude, JsonPropertyName("end")] public DateTimeOffset? End { get; set; } /// - /// Refer to the description for the `exclude_interim` query parameter. + /// + /// Refer to the description for the exclude_interim query parameter. + /// /// [JsonInclude, JsonPropertyName("exclude_interim")] public bool? ExcludeInterim { get; set; } @@ -92,26 +118,44 @@ public GetRecordsRequest(Elastic.Clients.Elasticsearch.Serverless.Id jobId) : ba public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Page? Page { get; set; } /// - /// Refer to the description for the `record_score` query parameter. + /// + /// Refer to the description for the record_score query parameter. + /// /// [JsonInclude, JsonPropertyName("record_score")] public double? RecordScore { get; set; } /// - /// Refer to the description for the `sort` query parameter. + /// + /// Refer to the description for the sort query parameter. + /// /// [JsonInclude, JsonPropertyName("sort")] public Elastic.Clients.Elasticsearch.Serverless.Field? Sort { get; set; } /// - /// Refer to the description for the `start` query parameter. + /// + /// Refer to the description for the start query parameter. + /// /// [JsonInclude, JsonPropertyName("start")] public DateTimeOffset? Start { get; set; } } /// -/// Retrieves anomaly records for an anomaly detection job.
Records contain the detailed analytical results. They describe the anomalous
activity that has been identified in the input data based on the detector
configuration.
There can be many anomaly records depending on the characteristics and size
of the input data. In practice, there are often too many to be able to
manually process them. The machine learning features therefore perform a
sophisticated aggregation of the anomaly records into buckets.
The number of record results depends on the number of anomalies found in each
bucket, which relates to the number of time series being modeled and the
number of detectors. +/// +/// Retrieves anomaly records for an anomaly detection job. +/// Records contain the detailed analytical results. They describe the anomalous +/// activity that has been identified in the input data based on the detector +/// configuration. +/// There can be many anomaly records depending on the characteristics and size +/// of the input data. In practice, there are often too many to be able to +/// manually process them. The machine learning features therefore perform a +/// sophisticated aggregation of the anomaly records into buckets. +/// The number of record results depends on the number of anomalies found in each +/// bucket, which relates to the number of time series being modeled and the +/// number of detectors. +/// /// public sealed partial class GetRecordsRequestDescriptor : RequestDescriptor, GetRecordsRequestParameters> { @@ -149,7 +193,9 @@ public GetRecordsRequestDescriptor JobId(Elastic.Clients.Elasticsearc private DateTimeOffset? StartValue { get; set; } /// - /// Refer to the description for the `desc` query parameter. + /// + /// Refer to the description for the desc query parameter. + /// /// public GetRecordsRequestDescriptor Desc(bool? desc = true) { @@ -158,7 +204,9 @@ public GetRecordsRequestDescriptor Desc(bool? desc = true) } /// - /// Refer to the description for the `end` query parameter. + /// + /// Refer to the description for the end query parameter. + /// /// public GetRecordsRequestDescriptor End(DateTimeOffset? end) { @@ -167,7 +215,9 @@ public GetRecordsRequestDescriptor End(DateTimeOffset? end) } /// - /// Refer to the description for the `exclude_interim` query parameter. + /// + /// Refer to the description for the exclude_interim query parameter. + /// /// public GetRecordsRequestDescriptor ExcludeInterim(bool? excludeInterim = true) { @@ -200,7 +250,9 @@ public GetRecordsRequestDescriptor Page(Action - /// Refer to the description for the `record_score` query parameter. + /// + /// Refer to the description for the record_score query parameter. + /// /// public GetRecordsRequestDescriptor RecordScore(double? recordScore) { @@ -209,7 +261,9 @@ public GetRecordsRequestDescriptor RecordScore(double? recordScore) } /// - /// Refer to the description for the `sort` query parameter. + /// + /// Refer to the description for the sort query parameter. + /// /// public GetRecordsRequestDescriptor Sort(Elastic.Clients.Elasticsearch.Serverless.Field? sort) { @@ -218,7 +272,9 @@ public GetRecordsRequestDescriptor Sort(Elastic.Clients.Elasticsearch } /// - /// Refer to the description for the `sort` query parameter. + /// + /// Refer to the description for the sort query parameter. + /// /// public GetRecordsRequestDescriptor Sort(Expression> sort) { @@ -227,7 +283,9 @@ public GetRecordsRequestDescriptor Sort(Expression - /// Refer to the description for the `sort` query parameter. + /// + /// Refer to the description for the sort query parameter. + /// /// public GetRecordsRequestDescriptor Sort(Expression> sort) { @@ -236,7 +294,9 @@ public GetRecordsRequestDescriptor Sort(Expression - /// Refer to the description for the `start` query parameter. + /// + /// Refer to the description for the start query parameter. + /// /// public GetRecordsRequestDescriptor Start(DateTimeOffset? start) { @@ -304,7 +364,19 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Retrieves anomaly records for an anomaly detection job.
Records contain the detailed analytical results. They describe the anomalous
activity that has been identified in the input data based on the detector
configuration.
There can be many anomaly records depending on the characteristics and size
of the input data. In practice, there are often too many to be able to
manually process them. The machine learning features therefore perform a
sophisticated aggregation of the anomaly records into buckets.
The number of record results depends on the number of anomalies found in each
bucket, which relates to the number of time series being modeled and the
number of detectors. +/// +/// Retrieves anomaly records for an anomaly detection job. +/// Records contain the detailed analytical results. They describe the anomalous +/// activity that has been identified in the input data based on the detector +/// configuration. +/// There can be many anomaly records depending on the characteristics and size +/// of the input data. In practice, there are often too many to be able to +/// manually process them. The machine learning features therefore perform a +/// sophisticated aggregation of the anomaly records into buckets. +/// The number of record results depends on the number of anomalies found in each +/// bucket, which relates to the number of time series being modeled and the +/// number of detectors. +/// /// public sealed partial class GetRecordsRequestDescriptor : RequestDescriptor { @@ -342,7 +414,9 @@ public GetRecordsRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Serverles private DateTimeOffset? StartValue { get; set; } /// - /// Refer to the description for the `desc` query parameter. + /// + /// Refer to the description for the desc query parameter. + /// /// public GetRecordsRequestDescriptor Desc(bool? desc = true) { @@ -351,7 +425,9 @@ public GetRecordsRequestDescriptor Desc(bool? desc = true) } /// - /// Refer to the description for the `end` query parameter. + /// + /// Refer to the description for the end query parameter. + /// /// public GetRecordsRequestDescriptor End(DateTimeOffset? end) { @@ -360,7 +436,9 @@ public GetRecordsRequestDescriptor End(DateTimeOffset? end) } /// - /// Refer to the description for the `exclude_interim` query parameter. + /// + /// Refer to the description for the exclude_interim query parameter. + /// /// public GetRecordsRequestDescriptor ExcludeInterim(bool? excludeInterim = true) { @@ -393,7 +471,9 @@ public GetRecordsRequestDescriptor Page(Action - /// Refer to the description for the `record_score` query parameter. + /// + /// Refer to the description for the record_score query parameter. + /// /// public GetRecordsRequestDescriptor RecordScore(double? recordScore) { @@ -402,7 +482,9 @@ public GetRecordsRequestDescriptor RecordScore(double? recordScore) } /// - /// Refer to the description for the `sort` query parameter. + /// + /// Refer to the description for the sort query parameter. + /// /// public GetRecordsRequestDescriptor Sort(Elastic.Clients.Elasticsearch.Serverless.Field? sort) { @@ -411,7 +493,9 @@ public GetRecordsRequestDescriptor Sort(Elastic.Clients.Elasticsearch.Serverless } /// - /// Refer to the description for the `sort` query parameter. + /// + /// Refer to the description for the sort query parameter. + /// /// public GetRecordsRequestDescriptor Sort(Expression> sort) { @@ -420,7 +504,9 @@ public GetRecordsRequestDescriptor Sort(Expression - /// Refer to the description for the `sort` query parameter. + /// + /// Refer to the description for the sort query parameter. + /// /// public GetRecordsRequestDescriptor Sort(Expression> sort) { @@ -429,7 +515,9 @@ public GetRecordsRequestDescriptor Sort(Expression - /// Refer to the description for the `start` query parameter. + /// + /// Refer to the description for the start query parameter. + /// /// public GetRecordsRequestDescriptor Start(DateTimeOffset? start) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetTrainedModelsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetTrainedModelsRequest.g.cs index c41c4d6425a..44f885edd24 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetTrainedModelsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetTrainedModelsRequest.g.cs @@ -32,45 +32,86 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class GetTrainedModelsRequestParameters : RequestParameters { /// - /// Specifies what to do when the request: - /// - Contains wildcard expressions and there are no models that match.
- Contains the _all string or no identifiers and there are no matches.
- Contains wildcard expressions and there are only partial matches. - /// If true, it returns an empty array when there are no matches and the
subset of results when there are partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no models that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// If true, it returns an empty array when there are no matches and the + /// subset of results when there are partial matches. + /// /// public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Specifies whether the included model definition should be returned as a
JSON map (true) or in a custom compressed format (false). + /// + /// Specifies whether the included model definition should be returned as a + /// JSON map (true) or in a custom compressed format (false). + /// /// public bool? DecompressDefinition { get => Q("decompress_definition"); set => Q("decompress_definition", value); } /// - /// Indicates if certain fields should be removed from the configuration on
retrieval. This allows the configuration to be in an acceptable format to
be retrieved and then added to another cluster. + /// + /// Indicates if certain fields should be removed from the configuration on + /// retrieval. This allows the configuration to be in an acceptable format to + /// be retrieved and then added to another cluster. + /// /// public bool? ExcludeGenerated { get => Q("exclude_generated"); set => Q("exclude_generated", value); } /// - /// Skips the specified number of models. + /// + /// Skips the specified number of models. + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// A comma delimited string of optional fields to include in the response
body. + /// + /// A comma delimited string of optional fields to include in the response + /// body. + /// /// public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Include? Include { get => Q("include"); set => Q("include", value); } /// - /// Specifies the maximum number of models to obtain. + /// + /// Specifies the maximum number of models to obtain. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } /// - /// A comma delimited string of tags. A trained model can have many tags, or
none. When supplied, only trained models that contain all the supplied
tags are returned. + /// + /// A comma delimited string of tags. A trained model can have many tags, or + /// none. When supplied, only trained models that contain all the supplied + /// tags are returned. + /// /// public ICollection? Tags { get => Q?>("tags"); set => Q("tags", value); } } /// -/// Retrieves configuration information for a trained model. +/// +/// Retrieves configuration information for a trained model. +/// /// public sealed partial class GetTrainedModelsRequest : PlainRequest { @@ -91,52 +132,93 @@ public GetTrainedModelsRequest(Elastic.Clients.Elasticsearch.Serverless.Ids? mod internal override string OperationName => "ml.get_trained_models"; /// - /// Specifies what to do when the request: - /// - Contains wildcard expressions and there are no models that match.
- Contains the _all string or no identifiers and there are no matches.
- Contains wildcard expressions and there are only partial matches. - /// If true, it returns an empty array when there are no matches and the
subset of results when there are partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no models that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// If true, it returns an empty array when there are no matches and the + /// subset of results when there are partial matches. + /// /// [JsonIgnore] public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Specifies whether the included model definition should be returned as a
JSON map (true) or in a custom compressed format (false). + /// + /// Specifies whether the included model definition should be returned as a + /// JSON map (true) or in a custom compressed format (false). + /// /// [JsonIgnore] public bool? DecompressDefinition { get => Q("decompress_definition"); set => Q("decompress_definition", value); } /// - /// Indicates if certain fields should be removed from the configuration on
retrieval. This allows the configuration to be in an acceptable format to
be retrieved and then added to another cluster. + /// + /// Indicates if certain fields should be removed from the configuration on + /// retrieval. This allows the configuration to be in an acceptable format to + /// be retrieved and then added to another cluster. + /// /// [JsonIgnore] public bool? ExcludeGenerated { get => Q("exclude_generated"); set => Q("exclude_generated", value); } /// - /// Skips the specified number of models. + /// + /// Skips the specified number of models. + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// A comma delimited string of optional fields to include in the response
body. + /// + /// A comma delimited string of optional fields to include in the response + /// body. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Include? Include { get => Q("include"); set => Q("include", value); } /// - /// Specifies the maximum number of models to obtain. + /// + /// Specifies the maximum number of models to obtain. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } /// - /// A comma delimited string of tags. A trained model can have many tags, or
none. When supplied, only trained models that contain all the supplied
tags are returned. + /// + /// A comma delimited string of tags. A trained model can have many tags, or + /// none. When supplied, only trained models that contain all the supplied + /// tags are returned. + /// /// [JsonIgnore] public ICollection? Tags { get => Q?>("tags"); set => Q("tags", value); } } /// -/// Retrieves configuration information for a trained model. +/// +/// Retrieves configuration information for a trained model. +/// /// public sealed partial class GetTrainedModelsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetTrainedModelsResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetTrainedModelsResponse.g.cs index bfc56d151b5..cd391598dfc 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetTrainedModelsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetTrainedModelsResponse.g.cs @@ -32,7 +32,9 @@ public sealed partial class GetTrainedModelsResponse : ElasticsearchResponse public int Count { get; init; } /// - /// An array of trained model resources, which are sorted by the model_id value in ascending order. + /// + /// An array of trained model resources, which are sorted by the model_id value in ascending order. + /// /// [JsonInclude, JsonPropertyName("trained_model_configs")] public IReadOnlyCollection TrainedModelConfigs { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetTrainedModelsStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetTrainedModelsStatsRequest.g.cs index 27db37b2c80..77bcfc8d35e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetTrainedModelsStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetTrainedModelsStatsRequest.g.cs @@ -32,25 +32,53 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class GetTrainedModelsStatsRequestParameters : RequestParameters { /// - /// Specifies what to do when the request: - /// - Contains wildcard expressions and there are no models that match.
- Contains the _all string or no identifiers and there are no matches.
- Contains wildcard expressions and there are only partial matches. - /// If true, it returns an empty array when there are no matches and the
subset of results when there are partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no models that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// If true, it returns an empty array when there are no matches and the + /// subset of results when there are partial matches. + /// /// public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Skips the specified number of models. + /// + /// Skips the specified number of models. + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of models to obtain. + /// + /// Specifies the maximum number of models to obtain. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Retrieves usage information for trained models. You can get usage information for multiple trained
models in a single API request by using a comma-separated list of model IDs or a wildcard expression. +/// +/// Retrieves usage information for trained models. You can get usage information for multiple trained +/// models in a single API request by using a comma-separated list of model IDs or a wildcard expression. +/// /// public sealed partial class GetTrainedModelsStatsRequest : PlainRequest { @@ -71,28 +99,56 @@ public GetTrainedModelsStatsRequest(Elastic.Clients.Elasticsearch.Serverless.Ids internal override string OperationName => "ml.get_trained_models_stats"; /// - /// Specifies what to do when the request: - /// - Contains wildcard expressions and there are no models that match.
- Contains the _all string or no identifiers and there are no matches.
- Contains wildcard expressions and there are only partial matches. - /// If true, it returns an empty array when there are no matches and the
subset of results when there are partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no models that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// If true, it returns an empty array when there are no matches and the + /// subset of results when there are partial matches. + /// /// [JsonIgnore] public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Skips the specified number of models. + /// + /// Skips the specified number of models. + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of models to obtain. + /// + /// Specifies the maximum number of models to obtain. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Retrieves usage information for trained models. You can get usage information for multiple trained
models in a single API request by using a comma-separated list of model IDs or a wildcard expression. +/// +/// Retrieves usage information for trained models. You can get usage information for multiple trained +/// models in a single API request by using a comma-separated list of model IDs or a wildcard expression. +/// /// public sealed partial class GetTrainedModelsStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetTrainedModelsStatsResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetTrainedModelsStatsResponse.g.cs index 5d7ef041ab6..ae4dc05f018 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetTrainedModelsStatsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/GetTrainedModelsStatsResponse.g.cs @@ -29,13 +29,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class GetTrainedModelsStatsResponse : ElasticsearchResponse { /// - /// The total number of trained model statistics that matched the requested ID patterns. Could be higher than the number of items in the trained_model_stats array as the size of the array is restricted by the supplied size parameter. + /// + /// The total number of trained model statistics that matched the requested ID patterns. Could be higher than the number of items in the trained_model_stats array as the size of the array is restricted by the supplied size parameter. + /// /// [JsonInclude, JsonPropertyName("count")] public int Count { get; init; } /// - /// An array of trained model statistics, which are sorted by the model_id value in ascending order. + /// + /// An array of trained model statistics, which are sorted by the model_id value in ascending order. + /// /// [JsonInclude, JsonPropertyName("trained_model_stats")] public IReadOnlyCollection TrainedModelStats { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/InferTrainedModelRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/InferTrainedModelRequest.g.cs index 7f62dcaa1b6..d50f007ffed 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/InferTrainedModelRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/InferTrainedModelRequest.g.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class InferTrainedModelRequestParameters : RequestParameters { /// - /// Controls the amount of time to wait for inference results. + /// + /// Controls the amount of time to wait for inference results. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Evaluates a trained model. +/// +/// Evaluates a trained model. +/// /// public sealed partial class InferTrainedModelRequest : PlainRequest { @@ -55,26 +59,36 @@ public InferTrainedModelRequest(Elastic.Clients.Elasticsearch.Serverless.Id mode internal override string OperationName => "ml.infer_trained_model"; /// - /// Controls the amount of time to wait for inference results. + /// + /// Controls the amount of time to wait for inference results. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// An array of objects to pass to the model for inference. The objects should contain a fields matching your
configured trained model input. Typically, for NLP models, the field name is `text_field`.
Currently, for NLP models, only a single value is allowed. + /// + /// An array of objects to pass to the model for inference. The objects should contain a fields matching your + /// configured trained model input. Typically, for NLP models, the field name is text_field. + /// Currently, for NLP models, only a single value is allowed. + /// /// [JsonInclude, JsonPropertyName("docs")] public ICollection> Docs { get; set; } /// - /// The inference configuration updates to apply on the API call + /// + /// The inference configuration updates to apply on the API call + /// /// [JsonInclude, JsonPropertyName("inference_config")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.InferenceConfigUpdate? InferenceConfig { get; set; } } /// -/// Evaluates a trained model. +/// +/// Evaluates a trained model. +/// /// public sealed partial class InferTrainedModelRequestDescriptor : RequestDescriptor, InferTrainedModelRequestParameters> { @@ -106,7 +120,11 @@ public InferTrainedModelRequestDescriptor ModelId(Elastic.Clients.Ela private Action> InferenceConfigDescriptorAction { get; set; } /// - /// An array of objects to pass to the model for inference. The objects should contain a fields matching your
configured trained model input. Typically, for NLP models, the field name is `text_field`.
Currently, for NLP models, only a single value is allowed. + /// + /// An array of objects to pass to the model for inference. The objects should contain a fields matching your + /// configured trained model input. Typically, for NLP models, the field name is text_field. + /// Currently, for NLP models, only a single value is allowed. + /// /// public InferTrainedModelRequestDescriptor Docs(ICollection> docs) { @@ -115,7 +133,9 @@ public InferTrainedModelRequestDescriptor Docs(ICollection - /// The inference configuration updates to apply on the API call + /// + /// The inference configuration updates to apply on the API call + /// /// public InferTrainedModelRequestDescriptor InferenceConfig(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.InferenceConfigUpdate? inferenceConfig) { @@ -167,7 +187,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Evaluates a trained model. +/// +/// Evaluates a trained model. +/// /// public sealed partial class InferTrainedModelRequestDescriptor : RequestDescriptor { @@ -199,7 +221,11 @@ public InferTrainedModelRequestDescriptor ModelId(Elastic.Clients.Elasticsearch. private Action InferenceConfigDescriptorAction { get; set; } /// - /// An array of objects to pass to the model for inference. The objects should contain a fields matching your
configured trained model input. Typically, for NLP models, the field name is `text_field`.
Currently, for NLP models, only a single value is allowed. + /// + /// An array of objects to pass to the model for inference. The objects should contain a fields matching your + /// configured trained model input. Typically, for NLP models, the field name is text_field. + /// Currently, for NLP models, only a single value is allowed. + /// /// public InferTrainedModelRequestDescriptor Docs(ICollection> docs) { @@ -208,7 +234,9 @@ public InferTrainedModelRequestDescriptor Docs(ICollection - /// The inference configuration updates to apply on the API call + /// + /// The inference configuration updates to apply on the API call + /// /// public InferTrainedModelRequestDescriptor InferenceConfig(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.InferenceConfigUpdate? inferenceConfig) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/MlInfoRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/MlInfoRequest.g.cs index 508adef0ad5..1b1f54ddbf1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/MlInfoRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/MlInfoRequest.g.cs @@ -34,7 +34,15 @@ public sealed partial class MlInfoRequestParameters : RequestParameters } /// -/// Returns defaults and limits used by machine learning.
This endpoint is designed to be used by a user interface that needs to fully
understand machine learning configurations where some options are not
specified, meaning that the defaults should be used. This endpoint may be
used to find out what those defaults are. It also provides information about
the maximum size of machine learning jobs that could run in the current
cluster configuration. +/// +/// Returns defaults and limits used by machine learning. +/// This endpoint is designed to be used by a user interface that needs to fully +/// understand machine learning configurations where some options are not +/// specified, meaning that the defaults should be used. This endpoint may be +/// used to find out what those defaults are. It also provides information about +/// the maximum size of machine learning jobs that could run in the current +/// cluster configuration. +/// /// public sealed partial class MlInfoRequest : PlainRequest { @@ -48,7 +56,15 @@ public sealed partial class MlInfoRequest : PlainRequest -/// Returns defaults and limits used by machine learning.
This endpoint is designed to be used by a user interface that needs to fully
understand machine learning configurations where some options are not
specified, meaning that the defaults should be used. This endpoint may be
used to find out what those defaults are. It also provides information about
the maximum size of machine learning jobs that could run in the current
cluster configuration. +/// +/// Returns defaults and limits used by machine learning. +/// This endpoint is designed to be used by a user interface that needs to fully +/// understand machine learning configurations where some options are not +/// specified, meaning that the defaults should be used. This endpoint may be +/// used to find out what those defaults are. It also provides information about +/// the maximum size of machine learning jobs that could run in the current +/// cluster configuration. +/// /// public sealed partial class MlInfoRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/OpenJobRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/OpenJobRequest.g.cs index 21583855f9a..30e276f478a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/OpenJobRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/OpenJobRequest.g.cs @@ -34,7 +34,16 @@ public sealed partial class OpenJobRequestParameters : RequestParameters } /// -/// Open anomaly detection jobs.
An anomaly detection job must be opened in order for it to be ready to
receive and analyze data. It can be opened and closed multiple times
throughout its lifecycle.
When you open a new job, it starts with an empty model.
When you open an existing job, the most recent model state is automatically
loaded. The job is ready to resume its analysis from where it left off, once
new data is received. +/// +/// Open anomaly detection jobs. +/// An anomaly detection job must be opened in order for it to be ready to +/// receive and analyze data. It can be opened and closed multiple times +/// throughout its lifecycle. +/// When you open a new job, it starts with an empty model. +/// When you open an existing job, the most recent model state is automatically +/// loaded. The job is ready to resume its analysis from where it left off, once +/// new data is received. +/// /// public sealed partial class OpenJobRequest : PlainRequest { @@ -51,14 +60,25 @@ public OpenJobRequest(Elastic.Clients.Elasticsearch.Serverless.Id jobId) : base( internal override string OperationName => "ml.open_job"; /// - /// Refer to the description for the `timeout` query parameter. + /// + /// Refer to the description for the timeout query parameter. + /// /// [JsonInclude, JsonPropertyName("timeout")] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get; set; } } /// -/// Open anomaly detection jobs.
An anomaly detection job must be opened in order for it to be ready to
receive and analyze data. It can be opened and closed multiple times
throughout its lifecycle.
When you open a new job, it starts with an empty model.
When you open an existing job, the most recent model state is automatically
loaded. The job is ready to resume its analysis from where it left off, once
new data is received. +/// +/// Open anomaly detection jobs. +/// An anomaly detection job must be opened in order for it to be ready to +/// receive and analyze data. It can be opened and closed multiple times +/// throughout its lifecycle. +/// When you open a new job, it starts with an empty model. +/// When you open an existing job, the most recent model state is automatically +/// loaded. The job is ready to resume its analysis from where it left off, once +/// new data is received. +/// /// public sealed partial class OpenJobRequestDescriptor : RequestDescriptor { @@ -85,7 +105,9 @@ public OpenJobRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Serverless.I private Elastic.Clients.Elasticsearch.Serverless.Duration? TimeoutValue { get; set; } /// - /// Refer to the description for the `timeout` query parameter. + /// + /// Refer to the description for the timeout query parameter. + /// /// public OpenJobRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Serverless.Duration? timeout) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/OpenJobResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/OpenJobResponse.g.cs index e30acf43546..cd43a5e3eda 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/OpenJobResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/OpenJobResponse.g.cs @@ -29,7 +29,10 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class OpenJobResponse : ElasticsearchResponse { /// - /// The ID of the node that the job was started on. In serverless this will be the "serverless".
If the job is allowed to open lazily and has not yet been assigned to a node, this value is an empty string. + /// + /// The ID of the node that the job was started on. In serverless this will be the "serverless". + /// If the job is allowed to open lazily and has not yet been assigned to a node, this value is an empty string. + /// /// [JsonInclude, JsonPropertyName("node")] public string Node { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PostCalendarEventsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PostCalendarEventsRequest.g.cs index 98344aff9b9..ae5ea625651 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PostCalendarEventsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PostCalendarEventsRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class PostCalendarEventsRequestParameters : RequestParamet } /// -/// Adds scheduled events to a calendar. +/// +/// Adds scheduled events to a calendar. +/// /// public sealed partial class PostCalendarEventsRequest : PlainRequest { @@ -51,14 +53,18 @@ public PostCalendarEventsRequest(Elastic.Clients.Elasticsearch.Serverless.Id cal internal override string OperationName => "ml.post_calendar_events"; /// - /// A list of one of more scheduled events. The event’s start and end times can be specified as integer milliseconds since the epoch or as a string in ISO 8601 format. + /// + /// A list of one of more scheduled events. The event’s start and end times can be specified as integer milliseconds since the epoch or as a string in ISO 8601 format. + /// /// [JsonInclude, JsonPropertyName("events")] public ICollection Events { get; set; } } /// -/// Adds scheduled events to a calendar. +/// +/// Adds scheduled events to a calendar. +/// /// public sealed partial class PostCalendarEventsRequestDescriptor : RequestDescriptor { @@ -88,7 +94,9 @@ public PostCalendarEventsRequestDescriptor CalendarId(Elastic.Clients.Elasticsea private Action[] EventsDescriptorActions { get; set; } /// - /// A list of one of more scheduled events. The event’s start and end times can be specified as integer milliseconds since the epoch or as a string in ISO 8601 format. + /// + /// A list of one of more scheduled events. The event’s start and end times can be specified as integer milliseconds since the epoch or as a string in ISO 8601 format. + /// /// public PostCalendarEventsRequestDescriptor Events(ICollection events) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PreviewDataFrameAnalyticsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PreviewDataFrameAnalyticsRequest.g.cs index 19d58446e65..966ba77ba2f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PreviewDataFrameAnalyticsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PreviewDataFrameAnalyticsRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class PreviewDataFrameAnalyticsRequestParameters : Request } /// -/// Previews the extracted features used by a data frame analytics config. +/// +/// Previews the extracted features used by a data frame analytics config. +/// /// public sealed partial class PreviewDataFrameAnalyticsRequest : PlainRequest { @@ -55,14 +57,20 @@ public PreviewDataFrameAnalyticsRequest(Elastic.Clients.Elasticsearch.Serverless internal override string OperationName => "ml.preview_data_frame_analytics"; /// - /// A data frame analytics config as described in create data frame analytics
jobs. Note that `id` and `dest` don’t need to be provided in the context of
this API. + /// + /// A data frame analytics config as described in create data frame analytics + /// jobs. Note that id and dest don’t need to be provided in the context of + /// this API. + /// /// [JsonInclude, JsonPropertyName("config")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframePreviewConfig? Config { get; set; } } /// -/// Previews the extracted features used by a data frame analytics config. +/// +/// Previews the extracted features used by a data frame analytics config. +/// /// public sealed partial class PreviewDataFrameAnalyticsRequestDescriptor : RequestDescriptor, PreviewDataFrameAnalyticsRequestParameters> { @@ -95,7 +103,11 @@ public PreviewDataFrameAnalyticsRequestDescriptor Id(Elastic.Clients. private Action> ConfigDescriptorAction { get; set; } /// - /// A data frame analytics config as described in create data frame analytics
jobs. Note that `id` and `dest` don’t need to be provided in the context of
this API. + /// + /// A data frame analytics config as described in create data frame analytics + /// jobs. Note that id and dest don’t need to be provided in the context of + /// this API. + /// /// public PreviewDataFrameAnalyticsRequestDescriptor Config(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframePreviewConfig? config) { @@ -145,7 +157,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Previews the extracted features used by a data frame analytics config. +/// +/// Previews the extracted features used by a data frame analytics config. +/// /// public sealed partial class PreviewDataFrameAnalyticsRequestDescriptor : RequestDescriptor { @@ -178,7 +192,11 @@ public PreviewDataFrameAnalyticsRequestDescriptor Id(Elastic.Clients.Elasticsear private Action ConfigDescriptorAction { get; set; } /// - /// A data frame analytics config as described in create data frame analytics
jobs. Note that `id` and `dest` don’t need to be provided in the context of
this API. + /// + /// A data frame analytics config as described in create data frame analytics + /// jobs. Note that id and dest don’t need to be provided in the context of + /// this API. + /// /// public PreviewDataFrameAnalyticsRequestDescriptor Config(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframePreviewConfig? config) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PreviewDataFrameAnalyticsResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PreviewDataFrameAnalyticsResponse.g.cs index 952972cb93a..aaa361ed3cb 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PreviewDataFrameAnalyticsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PreviewDataFrameAnalyticsResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class PreviewDataFrameAnalyticsResponse : ElasticsearchResponse { /// - /// An array of objects that contain feature name and value pairs. The features have been processed and indicate what will be sent to the model for training. + /// + /// An array of objects that contain feature name and value pairs. The features have been processed and indicate what will be sent to the model for training. + /// /// [JsonInclude, JsonPropertyName("feature_values")] public IReadOnlyCollection> FeatureValues { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutCalendarJobRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutCalendarJobRequest.g.cs index 1aafb988054..dd7d0690138 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutCalendarJobRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutCalendarJobRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class PutCalendarJobRequestParameters : RequestParameters } /// -/// Adds an anomaly detection job to a calendar. +/// +/// Adds an anomaly detection job to a calendar. +/// /// public sealed partial class PutCalendarJobRequest : PlainRequest { @@ -52,7 +54,9 @@ public PutCalendarJobRequest(Elastic.Clients.Elasticsearch.Serverless.Id calenda } /// -/// Adds an anomaly detection job to a calendar. +/// +/// Adds an anomaly detection job to a calendar. +/// /// public sealed partial class PutCalendarJobRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutCalendarJobResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutCalendarJobResponse.g.cs index d9e6e160fa6..b1d318b6602 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutCalendarJobResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutCalendarJobResponse.g.cs @@ -29,19 +29,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class PutCalendarJobResponse : ElasticsearchResponse { /// - /// A string that uniquely identifies a calendar. + /// + /// A string that uniquely identifies a calendar. + /// /// [JsonInclude, JsonPropertyName("calendar_id")] public string CalendarId { get; init; } /// - /// A description of the calendar. + /// + /// A description of the calendar. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; init; } /// - /// A list of anomaly detection job identifiers or group names. + /// + /// A list of anomaly detection job identifiers or group names. + /// /// [JsonInclude, JsonPropertyName("job_ids")] [SingleOrManyCollectionConverter(typeof(string))] diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutCalendarRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutCalendarRequest.g.cs index f395cb2c869..9e97916ad1c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutCalendarRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutCalendarRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class PutCalendarRequestParameters : RequestParameters } /// -/// Creates a calendar. +/// +/// Creates a calendar. +/// /// public sealed partial class PutCalendarRequest : PlainRequest { @@ -51,20 +53,26 @@ public PutCalendarRequest(Elastic.Clients.Elasticsearch.Serverless.Id calendarId internal override string OperationName => "ml.put_calendar"; /// - /// A description of the calendar. + /// + /// A description of the calendar. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// An array of anomaly detection job identifiers. + /// + /// An array of anomaly detection job identifiers. + /// /// [JsonInclude, JsonPropertyName("job_ids")] public ICollection? JobIds { get; set; } } /// -/// Creates a calendar. +/// +/// Creates a calendar. +/// /// public sealed partial class PutCalendarRequestDescriptor : RequestDescriptor { @@ -92,7 +100,9 @@ public PutCalendarRequestDescriptor CalendarId(Elastic.Clients.Elasticsearch.Ser private ICollection? JobIdsValue { get; set; } /// - /// A description of the calendar. + /// + /// A description of the calendar. + /// /// public PutCalendarRequestDescriptor Description(string? description) { @@ -101,7 +111,9 @@ public PutCalendarRequestDescriptor Description(string? description) } /// - /// An array of anomaly detection job identifiers. + /// + /// An array of anomaly detection job identifiers. + /// /// public PutCalendarRequestDescriptor JobIds(ICollection? jobIds) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutCalendarResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutCalendarResponse.g.cs index 85c887c9b97..6196799ffd7 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutCalendarResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutCalendarResponse.g.cs @@ -29,19 +29,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class PutCalendarResponse : ElasticsearchResponse { /// - /// A string that uniquely identifies a calendar. + /// + /// A string that uniquely identifies a calendar. + /// /// [JsonInclude, JsonPropertyName("calendar_id")] public string CalendarId { get; init; } /// - /// A description of the calendar. + /// + /// A description of the calendar. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; init; } /// - /// A list of anomaly detection job identifiers or group names. + /// + /// A list of anomaly detection job identifiers or group names. + /// /// [JsonInclude, JsonPropertyName("job_ids")] [SingleOrManyCollectionConverter(typeof(string))] diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutDataFrameAnalyticsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutDataFrameAnalyticsRequest.g.cs index 558c77d721c..4923fd2ea26 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutDataFrameAnalyticsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutDataFrameAnalyticsRequest.g.cs @@ -34,7 +34,11 @@ public sealed partial class PutDataFrameAnalyticsRequestParameters : RequestPara } /// -/// Instantiates a data frame analytics job.
This API creates a data frame analytics job that performs an analysis on the
source indices and stores the outcome in a destination index. +/// +/// Instantiates a data frame analytics job. +/// This API creates a data frame analytics job that performs an analysis on the +/// source indices and stores the outcome in a destination index. +/// /// public sealed partial class PutDataFrameAnalyticsRequest : PlainRequest { @@ -51,31 +55,77 @@ public PutDataFrameAnalyticsRequest(Elastic.Clients.Elasticsearch.Serverless.Id internal override string OperationName => "ml.put_data_frame_analytics"; /// - /// Specifies whether this job can start when there is insufficient machine
learning node capacity for it to be immediately assigned to a node. If
set to `false` and a machine learning node with capacity to run the job
cannot be immediately found, the API returns an error. If set to `true`,
the API does not return an error; the job waits in the `starting` state
until sufficient machine learning node capacity is available. This
behavior is also affected by the cluster-wide
`xpack.ml.max_lazy_ml_nodes` setting. + /// + /// Specifies whether this job can start when there is insufficient machine + /// learning node capacity for it to be immediately assigned to a node. If + /// set to false and a machine learning node with capacity to run the job + /// cannot be immediately found, the API returns an error. If set to true, + /// the API does not return an error; the job waits in the starting state + /// until sufficient machine learning node capacity is available. This + /// behavior is also affected by the cluster-wide + /// xpack.ml.max_lazy_ml_nodes setting. + /// /// [JsonInclude, JsonPropertyName("allow_lazy_start")] public bool? AllowLazyStart { get; set; } /// - /// The analysis configuration, which contains the information necessary to
perform one of the following types of analysis: classification, outlier
detection, or regression. + /// + /// The analysis configuration, which contains the information necessary to + /// perform one of the following types of analysis: classification, outlier + /// detection, or regression. + /// /// [JsonInclude, JsonPropertyName("analysis")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalysis Analysis { get; set; } /// - /// Specifies `includes` and/or `excludes` patterns to select which fields
will be included in the analysis. The patterns specified in `excludes`
are applied last, therefore `excludes` takes precedence. In other words,
if the same field is specified in both `includes` and `excludes`, then
the field will not be included in the analysis. If `analyzed_fields` is
not set, only the relevant fields will be included. For example, all the
numeric fields for outlier detection.
The supported fields vary for each type of analysis. Outlier detection
requires numeric or `boolean` data to analyze. The algorithms don’t
support missing values therefore fields that have data types other than
numeric or boolean are ignored. Documents where included fields contain
missing values, null values, or an array are also ignored. Therefore the
`dest` index may contain documents that don’t have an outlier score.
Regression supports fields that are numeric, `boolean`, `text`,
`keyword`, and `ip` data types. It is also tolerant of missing values.
Fields that are supported are included in the analysis, other fields are
ignored. Documents where included fields contain an array with two or
more values are also ignored. Documents in the `dest` index that don’t
contain a results field are not included in the regression analysis.
Classification supports fields that are numeric, `boolean`, `text`,
`keyword`, and `ip` data types. It is also tolerant of missing values.
Fields that are supported are included in the analysis, other fields are
ignored. Documents where included fields contain an array with two or
more values are also ignored. Documents in the `dest` index that don’t
contain a results field are not included in the classification analysis.
Classification analysis can be improved by mapping ordinal variable
values to a single number. For example, in case of age ranges, you can
model the values as `0-14 = 0`, `15-24 = 1`, `25-34 = 2`, and so on. + /// + /// Specifies includes and/or excludes patterns to select which fields + /// will be included in the analysis. The patterns specified in excludes + /// are applied last, therefore excludes takes precedence. In other words, + /// if the same field is specified in both includes and excludes, then + /// the field will not be included in the analysis. If analyzed_fields is + /// not set, only the relevant fields will be included. For example, all the + /// numeric fields for outlier detection. + /// The supported fields vary for each type of analysis. Outlier detection + /// requires numeric or boolean data to analyze. The algorithms don’t + /// support missing values therefore fields that have data types other than + /// numeric or boolean are ignored. Documents where included fields contain + /// missing values, null values, or an array are also ignored. Therefore the + /// dest index may contain documents that don’t have an outlier score. + /// Regression supports fields that are numeric, boolean, text, + /// keyword, and ip data types. It is also tolerant of missing values. + /// Fields that are supported are included in the analysis, other fields are + /// ignored. Documents where included fields contain an array with two or + /// more values are also ignored. Documents in the dest index that don’t + /// contain a results field are not included in the regression analysis. + /// Classification supports fields that are numeric, boolean, text, + /// keyword, and ip data types. It is also tolerant of missing values. + /// Fields that are supported are included in the analysis, other fields are + /// ignored. Documents where included fields contain an array with two or + /// more values are also ignored. Documents in the dest index that don’t + /// contain a results field are not included in the classification analysis. + /// Classification analysis can be improved by mapping ordinal variable + /// values to a single number. For example, in case of age ranges, you can + /// model the values as 0-14 = 0, 15-24 = 1, 25-34 = 2, and so on. + /// /// [JsonInclude, JsonPropertyName("analyzed_fields")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalysisAnalyzedFields? AnalyzedFields { get; set; } /// - /// A description of the job. + /// + /// A description of the job. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The destination configuration. + /// + /// The destination configuration. + /// /// [JsonInclude, JsonPropertyName("dest")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalyticsDestination Dest { get; set; } @@ -83,19 +133,32 @@ public PutDataFrameAnalyticsRequest(Elastic.Clients.Elasticsearch.Serverless.Id public IDictionary>>? Headers { get; set; } /// - /// The maximum number of threads to be used by the analysis. Using more
threads may decrease the time necessary to complete the analysis at the
cost of using more CPU. Note that the process may use additional threads
for operational functionality other than the analysis itself. + /// + /// The maximum number of threads to be used by the analysis. Using more + /// threads may decrease the time necessary to complete the analysis at the + /// cost of using more CPU. Note that the process may use additional threads + /// for operational functionality other than the analysis itself. + /// /// [JsonInclude, JsonPropertyName("max_num_threads")] public int? MaxNumThreads { get; set; } /// - /// The approximate maximum amount of memory resources that are permitted for
analytical processing. If your `elasticsearch.yml` file contains an
`xpack.ml.max_model_memory_limit` setting, an error occurs when you try
to create data frame analytics jobs that have `model_memory_limit` values
greater than that setting. + /// + /// The approximate maximum amount of memory resources that are permitted for + /// analytical processing. If your elasticsearch.yml file contains an + /// xpack.ml.max_model_memory_limit setting, an error occurs when you try + /// to create data frame analytics jobs that have model_memory_limit values + /// greater than that setting. + /// /// [JsonInclude, JsonPropertyName("model_memory_limit")] public string? ModelMemoryLimit { get; set; } /// - /// The configuration of how to source the analysis data. + /// + /// The configuration of how to source the analysis data. + /// /// [JsonInclude, JsonPropertyName("source")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalyticsSource Source { get; set; } @@ -104,7 +167,11 @@ public PutDataFrameAnalyticsRequest(Elastic.Clients.Elasticsearch.Serverless.Id } /// -/// Instantiates a data frame analytics job.
This API creates a data frame analytics job that performs an analysis on the
source indices and stores the outcome in a destination index. +/// +/// Instantiates a data frame analytics job. +/// This API creates a data frame analytics job that performs an analysis on the +/// source indices and stores the outcome in a destination index. +/// /// public sealed partial class PutDataFrameAnalyticsRequestDescriptor : RequestDescriptor, PutDataFrameAnalyticsRequestParameters> { @@ -148,7 +215,16 @@ public PutDataFrameAnalyticsRequestDescriptor Id(Elastic.Clients.Elas private string? VersionValue { get; set; } /// - /// Specifies whether this job can start when there is insufficient machine
learning node capacity for it to be immediately assigned to a node. If
set to `false` and a machine learning node with capacity to run the job
cannot be immediately found, the API returns an error. If set to `true`,
the API does not return an error; the job waits in the `starting` state
until sufficient machine learning node capacity is available. This
behavior is also affected by the cluster-wide
`xpack.ml.max_lazy_ml_nodes` setting. + /// + /// Specifies whether this job can start when there is insufficient machine + /// learning node capacity for it to be immediately assigned to a node. If + /// set to false and a machine learning node with capacity to run the job + /// cannot be immediately found, the API returns an error. If set to true, + /// the API does not return an error; the job waits in the starting state + /// until sufficient machine learning node capacity is available. This + /// behavior is also affected by the cluster-wide + /// xpack.ml.max_lazy_ml_nodes setting. + /// /// public PutDataFrameAnalyticsRequestDescriptor AllowLazyStart(bool? allowLazyStart = true) { @@ -157,7 +233,11 @@ public PutDataFrameAnalyticsRequestDescriptor AllowLazyStart(bool? al } /// - /// The analysis configuration, which contains the information necessary to
perform one of the following types of analysis: classification, outlier
detection, or regression. + /// + /// The analysis configuration, which contains the information necessary to + /// perform one of the following types of analysis: classification, outlier + /// detection, or regression. + /// /// public PutDataFrameAnalyticsRequestDescriptor Analysis(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalysis analysis) { @@ -184,7 +264,36 @@ public PutDataFrameAnalyticsRequestDescriptor Analysis(Action - /// Specifies `includes` and/or `excludes` patterns to select which fields
will be included in the analysis. The patterns specified in `excludes`
are applied last, therefore `excludes` takes precedence. In other words,
if the same field is specified in both `includes` and `excludes`, then
the field will not be included in the analysis. If `analyzed_fields` is
not set, only the relevant fields will be included. For example, all the
numeric fields for outlier detection.
The supported fields vary for each type of analysis. Outlier detection
requires numeric or `boolean` data to analyze. The algorithms don’t
support missing values therefore fields that have data types other than
numeric or boolean are ignored. Documents where included fields contain
missing values, null values, or an array are also ignored. Therefore the
`dest` index may contain documents that don’t have an outlier score.
Regression supports fields that are numeric, `boolean`, `text`,
`keyword`, and `ip` data types. It is also tolerant of missing values.
Fields that are supported are included in the analysis, other fields are
ignored. Documents where included fields contain an array with two or
more values are also ignored. Documents in the `dest` index that don’t
contain a results field are not included in the regression analysis.
Classification supports fields that are numeric, `boolean`, `text`,
`keyword`, and `ip` data types. It is also tolerant of missing values.
Fields that are supported are included in the analysis, other fields are
ignored. Documents where included fields contain an array with two or
more values are also ignored. Documents in the `dest` index that don’t
contain a results field are not included in the classification analysis.
Classification analysis can be improved by mapping ordinal variable
values to a single number. For example, in case of age ranges, you can
model the values as `0-14 = 0`, `15-24 = 1`, `25-34 = 2`, and so on. + /// + /// Specifies includes and/or excludes patterns to select which fields + /// will be included in the analysis. The patterns specified in excludes + /// are applied last, therefore excludes takes precedence. In other words, + /// if the same field is specified in both includes and excludes, then + /// the field will not be included in the analysis. If analyzed_fields is + /// not set, only the relevant fields will be included. For example, all the + /// numeric fields for outlier detection. + /// The supported fields vary for each type of analysis. Outlier detection + /// requires numeric or boolean data to analyze. The algorithms don’t + /// support missing values therefore fields that have data types other than + /// numeric or boolean are ignored. Documents where included fields contain + /// missing values, null values, or an array are also ignored. Therefore the + /// dest index may contain documents that don’t have an outlier score. + /// Regression supports fields that are numeric, boolean, text, + /// keyword, and ip data types. It is also tolerant of missing values. + /// Fields that are supported are included in the analysis, other fields are + /// ignored. Documents where included fields contain an array with two or + /// more values are also ignored. Documents in the dest index that don’t + /// contain a results field are not included in the regression analysis. + /// Classification supports fields that are numeric, boolean, text, + /// keyword, and ip data types. It is also tolerant of missing values. + /// Fields that are supported are included in the analysis, other fields are + /// ignored. Documents where included fields contain an array with two or + /// more values are also ignored. Documents in the dest index that don’t + /// contain a results field are not included in the classification analysis. + /// Classification analysis can be improved by mapping ordinal variable + /// values to a single number. For example, in case of age ranges, you can + /// model the values as 0-14 = 0, 15-24 = 1, 25-34 = 2, and so on. + /// /// public PutDataFrameAnalyticsRequestDescriptor AnalyzedFields(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalysisAnalyzedFields? analyzedFields) { @@ -211,7 +320,9 @@ public PutDataFrameAnalyticsRequestDescriptor AnalyzedFields(Action - /// A description of the job. + /// + /// A description of the job. + /// /// public PutDataFrameAnalyticsRequestDescriptor Description(string? description) { @@ -220,7 +331,9 @@ public PutDataFrameAnalyticsRequestDescriptor Description(string? des } /// - /// The destination configuration. + /// + /// The destination configuration. + /// /// public PutDataFrameAnalyticsRequestDescriptor Dest(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalyticsDestination dest) { @@ -253,7 +366,12 @@ public PutDataFrameAnalyticsRequestDescriptor Headers(Func - /// The maximum number of threads to be used by the analysis. Using more
threads may decrease the time necessary to complete the analysis at the
cost of using more CPU. Note that the process may use additional threads
for operational functionality other than the analysis itself. + /// + /// The maximum number of threads to be used by the analysis. Using more + /// threads may decrease the time necessary to complete the analysis at the + /// cost of using more CPU. Note that the process may use additional threads + /// for operational functionality other than the analysis itself. + /// /// public PutDataFrameAnalyticsRequestDescriptor MaxNumThreads(int? maxNumThreads) { @@ -262,7 +380,13 @@ public PutDataFrameAnalyticsRequestDescriptor MaxNumThreads(int? maxN } /// - /// The approximate maximum amount of memory resources that are permitted for
analytical processing. If your `elasticsearch.yml` file contains an
`xpack.ml.max_model_memory_limit` setting, an error occurs when you try
to create data frame analytics jobs that have `model_memory_limit` values
greater than that setting. + /// + /// The approximate maximum amount of memory resources that are permitted for + /// analytical processing. If your elasticsearch.yml file contains an + /// xpack.ml.max_model_memory_limit setting, an error occurs when you try + /// to create data frame analytics jobs that have model_memory_limit values + /// greater than that setting. + /// /// public PutDataFrameAnalyticsRequestDescriptor ModelMemoryLimit(string? modelMemoryLimit) { @@ -271,7 +395,9 @@ public PutDataFrameAnalyticsRequestDescriptor ModelMemoryLimit(string } /// - /// The configuration of how to source the analysis data. + /// + /// The configuration of how to source the analysis data. + /// /// public PutDataFrameAnalyticsRequestDescriptor Source(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalyticsSource source) { @@ -411,7 +537,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Instantiates a data frame analytics job.
This API creates a data frame analytics job that performs an analysis on the
source indices and stores the outcome in a destination index. +/// +/// Instantiates a data frame analytics job. +/// This API creates a data frame analytics job that performs an analysis on the +/// source indices and stores the outcome in a destination index. +/// /// public sealed partial class PutDataFrameAnalyticsRequestDescriptor : RequestDescriptor { @@ -455,7 +585,16 @@ public PutDataFrameAnalyticsRequestDescriptor Id(Elastic.Clients.Elasticsearch.S private string? VersionValue { get; set; } /// - /// Specifies whether this job can start when there is insufficient machine
learning node capacity for it to be immediately assigned to a node. If
set to `false` and a machine learning node with capacity to run the job
cannot be immediately found, the API returns an error. If set to `true`,
the API does not return an error; the job waits in the `starting` state
until sufficient machine learning node capacity is available. This
behavior is also affected by the cluster-wide
`xpack.ml.max_lazy_ml_nodes` setting. + /// + /// Specifies whether this job can start when there is insufficient machine + /// learning node capacity for it to be immediately assigned to a node. If + /// set to false and a machine learning node with capacity to run the job + /// cannot be immediately found, the API returns an error. If set to true, + /// the API does not return an error; the job waits in the starting state + /// until sufficient machine learning node capacity is available. This + /// behavior is also affected by the cluster-wide + /// xpack.ml.max_lazy_ml_nodes setting. + /// /// public PutDataFrameAnalyticsRequestDescriptor AllowLazyStart(bool? allowLazyStart = true) { @@ -464,7 +603,11 @@ public PutDataFrameAnalyticsRequestDescriptor AllowLazyStart(bool? allowLazyStar } /// - /// The analysis configuration, which contains the information necessary to
perform one of the following types of analysis: classification, outlier
detection, or regression. + /// + /// The analysis configuration, which contains the information necessary to + /// perform one of the following types of analysis: classification, outlier + /// detection, or regression. + /// /// public PutDataFrameAnalyticsRequestDescriptor Analysis(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalysis analysis) { @@ -491,7 +634,36 @@ public PutDataFrameAnalyticsRequestDescriptor Analysis(Action - /// Specifies `includes` and/or `excludes` patterns to select which fields
will be included in the analysis. The patterns specified in `excludes`
are applied last, therefore `excludes` takes precedence. In other words,
if the same field is specified in both `includes` and `excludes`, then
the field will not be included in the analysis. If `analyzed_fields` is
not set, only the relevant fields will be included. For example, all the
numeric fields for outlier detection.
The supported fields vary for each type of analysis. Outlier detection
requires numeric or `boolean` data to analyze. The algorithms don’t
support missing values therefore fields that have data types other than
numeric or boolean are ignored. Documents where included fields contain
missing values, null values, or an array are also ignored. Therefore the
`dest` index may contain documents that don’t have an outlier score.
Regression supports fields that are numeric, `boolean`, `text`,
`keyword`, and `ip` data types. It is also tolerant of missing values.
Fields that are supported are included in the analysis, other fields are
ignored. Documents where included fields contain an array with two or
more values are also ignored. Documents in the `dest` index that don’t
contain a results field are not included in the regression analysis.
Classification supports fields that are numeric, `boolean`, `text`,
`keyword`, and `ip` data types. It is also tolerant of missing values.
Fields that are supported are included in the analysis, other fields are
ignored. Documents where included fields contain an array with two or
more values are also ignored. Documents in the `dest` index that don’t
contain a results field are not included in the classification analysis.
Classification analysis can be improved by mapping ordinal variable
values to a single number. For example, in case of age ranges, you can
model the values as `0-14 = 0`, `15-24 = 1`, `25-34 = 2`, and so on. + /// + /// Specifies includes and/or excludes patterns to select which fields + /// will be included in the analysis. The patterns specified in excludes + /// are applied last, therefore excludes takes precedence. In other words, + /// if the same field is specified in both includes and excludes, then + /// the field will not be included in the analysis. If analyzed_fields is + /// not set, only the relevant fields will be included. For example, all the + /// numeric fields for outlier detection. + /// The supported fields vary for each type of analysis. Outlier detection + /// requires numeric or boolean data to analyze. The algorithms don’t + /// support missing values therefore fields that have data types other than + /// numeric or boolean are ignored. Documents where included fields contain + /// missing values, null values, or an array are also ignored. Therefore the + /// dest index may contain documents that don’t have an outlier score. + /// Regression supports fields that are numeric, boolean, text, + /// keyword, and ip data types. It is also tolerant of missing values. + /// Fields that are supported are included in the analysis, other fields are + /// ignored. Documents where included fields contain an array with two or + /// more values are also ignored. Documents in the dest index that don’t + /// contain a results field are not included in the regression analysis. + /// Classification supports fields that are numeric, boolean, text, + /// keyword, and ip data types. It is also tolerant of missing values. + /// Fields that are supported are included in the analysis, other fields are + /// ignored. Documents where included fields contain an array with two or + /// more values are also ignored. Documents in the dest index that don’t + /// contain a results field are not included in the classification analysis. + /// Classification analysis can be improved by mapping ordinal variable + /// values to a single number. For example, in case of age ranges, you can + /// model the values as 0-14 = 0, 15-24 = 1, 25-34 = 2, and so on. + /// /// public PutDataFrameAnalyticsRequestDescriptor AnalyzedFields(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalysisAnalyzedFields? analyzedFields) { @@ -518,7 +690,9 @@ public PutDataFrameAnalyticsRequestDescriptor AnalyzedFields(Action - /// A description of the job. + /// + /// A description of the job. + /// /// public PutDataFrameAnalyticsRequestDescriptor Description(string? description) { @@ -527,7 +701,9 @@ public PutDataFrameAnalyticsRequestDescriptor Description(string? description) } /// - /// The destination configuration. + /// + /// The destination configuration. + /// /// public PutDataFrameAnalyticsRequestDescriptor Dest(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalyticsDestination dest) { @@ -560,7 +736,12 @@ public PutDataFrameAnalyticsRequestDescriptor Headers(Func - /// The maximum number of threads to be used by the analysis. Using more
threads may decrease the time necessary to complete the analysis at the
cost of using more CPU. Note that the process may use additional threads
for operational functionality other than the analysis itself. + /// + /// The maximum number of threads to be used by the analysis. Using more + /// threads may decrease the time necessary to complete the analysis at the + /// cost of using more CPU. Note that the process may use additional threads + /// for operational functionality other than the analysis itself. + /// /// public PutDataFrameAnalyticsRequestDescriptor MaxNumThreads(int? maxNumThreads) { @@ -569,7 +750,13 @@ public PutDataFrameAnalyticsRequestDescriptor MaxNumThreads(int? maxNumThreads) } /// - /// The approximate maximum amount of memory resources that are permitted for
analytical processing. If your `elasticsearch.yml` file contains an
`xpack.ml.max_model_memory_limit` setting, an error occurs when you try
to create data frame analytics jobs that have `model_memory_limit` values
greater than that setting. + /// + /// The approximate maximum amount of memory resources that are permitted for + /// analytical processing. If your elasticsearch.yml file contains an + /// xpack.ml.max_model_memory_limit setting, an error occurs when you try + /// to create data frame analytics jobs that have model_memory_limit values + /// greater than that setting. + /// /// public PutDataFrameAnalyticsRequestDescriptor ModelMemoryLimit(string? modelMemoryLimit) { @@ -578,7 +765,9 @@ public PutDataFrameAnalyticsRequestDescriptor ModelMemoryLimit(string? modelMemo } /// - /// The configuration of how to source the analysis data. + /// + /// The configuration of how to source the analysis data. + /// /// public PutDataFrameAnalyticsRequestDescriptor Source(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalyticsSource source) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutDatafeedRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutDatafeedRequest.g.cs index e0292dd3687..0ac9589d3bb 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutDatafeedRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutDatafeedRequest.g.cs @@ -32,17 +32,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class PutDatafeedRequestParameters : RequestParameters { /// - /// If true, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the `_all`
string or when no indices are specified. + /// + /// If true, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the _all + /// string or when no indices are specified. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams. Supports comma-separated values. + /// + /// Type of index that wildcard patterns can match. If the request can target data streams, this argument determines + /// whether wildcard expressions match hidden data streams. Supports comma-separated values. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If true, unavailable indices (missing or closed) are ignored. + /// + /// If true, unavailable indices (missing or closed) are ignored. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } } @@ -240,7 +248,13 @@ public override void Write(Utf8JsonWriter writer, PutDatafeedRequest value, Json } /// -/// Instantiates a datafeed.
Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.
You can associate only one datafeed with each anomaly detection job.
The datafeed contains a query that runs at a defined interval (`frequency`).
If you are concerned about delayed data, you can add a delay (`query_delay') at each interval.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had
at the time of creation and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead.
You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. +/// +/// Instantiates a datafeed. +/// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. +/// You can associate only one datafeed with each anomaly detection job. +/// The datafeed contains a query that runs at a defined interval (frequency). +/// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. +/// /// [JsonConverter(typeof(PutDatafeedRequestConverter))] public sealed partial class PutDatafeedRequest : PlainRequest @@ -262,43 +276,71 @@ public PutDatafeedRequest() internal override string OperationName => "ml.put_datafeed"; /// - /// If true, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the `_all`
string or when no indices are specified. + /// + /// If true, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the _all + /// string or when no indices are specified. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams. Supports comma-separated values. + /// + /// Type of index that wildcard patterns can match. If the request can target data streams, this argument determines + /// whether wildcard expressions match hidden data streams. Supports comma-separated values. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If true, unavailable indices (missing or closed) are ignored. + /// + /// If true, unavailable indices (missing or closed) are ignored. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If set, the datafeed performs aggregation searches.
Support for aggregations is limited and should be used only with low cardinality data. + /// + /// If set, the datafeed performs aggregation searches. + /// Support for aggregations is limited and should be used only with low cardinality data. + /// /// [JsonInclude, JsonPropertyName("aggregations")] public IDictionary? Aggregations { get; set; } /// - /// Datafeeds might be required to search over long time periods, for several months or years.
This search is split into time chunks in order to ensure the load on Elasticsearch is managed.
Chunking configuration controls how the size of these time chunks are calculated;
it is an advanced configuration option. + /// + /// Datafeeds might be required to search over long time periods, for several months or years. + /// This search is split into time chunks in order to ensure the load on Elasticsearch is managed. + /// Chunking configuration controls how the size of these time chunks are calculated; + /// it is an advanced configuration option. + /// /// [JsonInclude, JsonPropertyName("chunking_config")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ChunkingConfig? ChunkingConfig { get; set; } /// - /// Specifies whether the datafeed checks for missing data and the size of the window.
The datafeed can optionally search over indices that have already been read in an effort to determine whether
any data has subsequently been added to the index. If missing data is found, it is a good indication that the
`query_delay` is set too low and the data is being indexed after the datafeed has passed that moment in time.
This check runs only on real-time datafeeds. + /// + /// Specifies whether the datafeed checks for missing data and the size of the window. + /// The datafeed can optionally search over indices that have already been read in an effort to determine whether + /// any data has subsequently been added to the index. If missing data is found, it is a good indication that the + /// query_delay is set too low and the data is being indexed after the datafeed has passed that moment in time. + /// This check runs only on real-time datafeeds. + /// /// [JsonInclude, JsonPropertyName("delayed_data_check_config")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DelayedDataCheckConfig? DelayedDataCheckConfig { get; set; } /// - /// The interval at which scheduled queries are made while the datafeed runs in real time.
The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible
fraction of the bucket span. When `frequency` is shorter than the bucket span, interim results for the last
(partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses
aggregations, this value must be divisible by the interval of the date histogram aggregation. + /// + /// The interval at which scheduled queries are made while the datafeed runs in real time. + /// The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible + /// fraction of the bucket span. When frequency is shorter than the bucket span, interim results for the last + /// (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses + /// aggregations, this value must be divisible by the interval of the date histogram aggregation. + /// /// [JsonInclude, JsonPropertyName("frequency")] public Elastic.Clients.Elasticsearch.Serverless.Duration? Frequency { get; set; } @@ -306,62 +348,97 @@ public PutDatafeedRequest() public IDictionary>>? Headers { get; set; } /// - /// An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine
learning nodes must have the `remote_cluster_client` role. + /// + /// An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine + /// learning nodes must have the remote_cluster_client role. + /// /// [JsonInclude, JsonPropertyName("indices")] public Elastic.Clients.Elasticsearch.Serverless.Indices? Indices { get; set; } /// - /// Specifies index expansion options that are used during search + /// + /// Specifies index expansion options that are used during search + /// /// [JsonInclude, JsonPropertyName("indices_options")] public Elastic.Clients.Elasticsearch.Serverless.IndicesOptions? IndicesOptions { get; set; } /// - /// Identifier for the anomaly detection job. + /// + /// Identifier for the anomaly detection job. + /// /// [JsonInclude, JsonPropertyName("job_id")] public Elastic.Clients.Elasticsearch.Serverless.Id? JobId { get; set; } /// - /// If a real-time datafeed has never seen any data (including during any initial training period), it automatically
stops and closes the associated job after this many real-time searches return no documents. In other words,
it stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no
end time that sees no data remains started until it is explicitly stopped. By default, it is not set. + /// + /// If a real-time datafeed has never seen any data (including during any initial training period), it automatically + /// stops and closes the associated job after this many real-time searches return no documents. In other words, + /// it stops after frequency times max_empty_searches of real-time operation. If not set, a datafeed with no + /// end time that sees no data remains started until it is explicitly stopped. By default, it is not set. + /// /// [JsonInclude, JsonPropertyName("max_empty_searches")] public int? MaxEmptySearches { get; set; } /// - /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an
Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this
object is passed verbatim to Elasticsearch. + /// + /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an + /// Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this + /// object is passed verbatim to Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? Query { get; set; } /// - /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might
not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default
value is randomly selected between `60s` and `120s`. This randomness improves the query performance
when there are multiple jobs running on the same node. + /// + /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might + /// not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default + /// value is randomly selected between 60s and 120s. This randomness improves the query performance + /// when there are multiple jobs running on the same node. + /// /// [JsonInclude, JsonPropertyName("query_delay")] public Elastic.Clients.Elasticsearch.Serverless.Duration? QueryDelay { get; set; } /// - /// Specifies runtime fields for the datafeed search. + /// + /// Specifies runtime fields for the datafeed search. + /// /// [JsonInclude, JsonPropertyName("runtime_mappings")] public IDictionary? RuntimeMappings { get; set; } /// - /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed.
The detector configuration objects in a job can contain functions that use these script fields. + /// + /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. + /// The detector configuration objects in a job can contain functions that use these script fields. + /// /// [JsonInclude, JsonPropertyName("script_fields")] public IDictionary? ScriptFields { get; set; } /// - /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations.
The maximum value is the value of `index.max_result_window`, which is 10,000 by default. + /// + /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. + /// The maximum value is the value of index.max_result_window, which is 10,000 by default. + /// /// [JsonInclude, JsonPropertyName("scroll_size")] public int? ScrollSize { get; set; } } /// -/// Instantiates a datafeed.
Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.
You can associate only one datafeed with each anomaly detection job.
The datafeed contains a query that runs at a defined interval (`frequency`).
If you are concerned about delayed data, you can add a delay (`query_delay') at each interval.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had
at the time of creation and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead.
You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. +/// +/// Instantiates a datafeed. +/// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. +/// You can associate only one datafeed with each anomaly detection job. +/// The datafeed contains a query that runs at a defined interval (frequency). +/// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. +/// /// public sealed partial class PutDatafeedRequestDescriptor : RequestDescriptor, PutDatafeedRequestParameters> { @@ -413,7 +490,10 @@ public PutDatafeedRequestDescriptor DatafeedId(Elastic.Clients.Elasti private int? ScrollSizeValue { get; set; } /// - /// If set, the datafeed performs aggregation searches.
Support for aggregations is limited and should be used only with low cardinality data. + /// + /// If set, the datafeed performs aggregation searches. + /// Support for aggregations is limited and should be used only with low cardinality data. + /// /// public PutDatafeedRequestDescriptor Aggregations(Func>, FluentDescriptorDictionary>> selector) { @@ -422,7 +502,12 @@ public PutDatafeedRequestDescriptor Aggregations(Func - /// Datafeeds might be required to search over long time periods, for several months or years.
This search is split into time chunks in order to ensure the load on Elasticsearch is managed.
Chunking configuration controls how the size of these time chunks are calculated;
it is an advanced configuration option. + /// + /// Datafeeds might be required to search over long time periods, for several months or years. + /// This search is split into time chunks in order to ensure the load on Elasticsearch is managed. + /// Chunking configuration controls how the size of these time chunks are calculated; + /// it is an advanced configuration option. + /// /// public PutDatafeedRequestDescriptor ChunkingConfig(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ChunkingConfig? chunkingConfig) { @@ -449,7 +534,13 @@ public PutDatafeedRequestDescriptor ChunkingConfig(Action - /// Specifies whether the datafeed checks for missing data and the size of the window.
The datafeed can optionally search over indices that have already been read in an effort to determine whether
any data has subsequently been added to the index. If missing data is found, it is a good indication that the
`query_delay` is set too low and the data is being indexed after the datafeed has passed that moment in time.
This check runs only on real-time datafeeds. + /// + /// Specifies whether the datafeed checks for missing data and the size of the window. + /// The datafeed can optionally search over indices that have already been read in an effort to determine whether + /// any data has subsequently been added to the index. If missing data is found, it is a good indication that the + /// query_delay is set too low and the data is being indexed after the datafeed has passed that moment in time. + /// This check runs only on real-time datafeeds. + /// /// public PutDatafeedRequestDescriptor DelayedDataCheckConfig(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DelayedDataCheckConfig? delayedDataCheckConfig) { @@ -476,7 +567,13 @@ public PutDatafeedRequestDescriptor DelayedDataCheckConfig(Action - /// The interval at which scheduled queries are made while the datafeed runs in real time.
The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible
fraction of the bucket span. When `frequency` is shorter than the bucket span, interim results for the last
(partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses
aggregations, this value must be divisible by the interval of the date histogram aggregation. + /// + /// The interval at which scheduled queries are made while the datafeed runs in real time. + /// The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible + /// fraction of the bucket span. When frequency is shorter than the bucket span, interim results for the last + /// (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses + /// aggregations, this value must be divisible by the interval of the date histogram aggregation. + /// /// public PutDatafeedRequestDescriptor Frequency(Elastic.Clients.Elasticsearch.Serverless.Duration? frequency) { @@ -491,7 +588,10 @@ public PutDatafeedRequestDescriptor Headers(Func - /// An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine
learning nodes must have the `remote_cluster_client` role. + /// + /// An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine + /// learning nodes must have the remote_cluster_client role. + /// /// public PutDatafeedRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.Indices? indices) { @@ -500,7 +600,9 @@ public PutDatafeedRequestDescriptor Indices(Elastic.Clients.Elasticse } /// - /// Specifies index expansion options that are used during search + /// + /// Specifies index expansion options that are used during search + /// /// public PutDatafeedRequestDescriptor IndicesOptions(Elastic.Clients.Elasticsearch.Serverless.IndicesOptions? indicesOptions) { @@ -527,7 +629,9 @@ public PutDatafeedRequestDescriptor IndicesOptions(Action - /// Identifier for the anomaly detection job. + /// + /// Identifier for the anomaly detection job. + /// /// public PutDatafeedRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Serverless.Id? jobId) { @@ -536,7 +640,12 @@ public PutDatafeedRequestDescriptor JobId(Elastic.Clients.Elasticsear } /// - /// If a real-time datafeed has never seen any data (including during any initial training period), it automatically
stops and closes the associated job after this many real-time searches return no documents. In other words,
it stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no
end time that sees no data remains started until it is explicitly stopped. By default, it is not set. + /// + /// If a real-time datafeed has never seen any data (including during any initial training period), it automatically + /// stops and closes the associated job after this many real-time searches return no documents. In other words, + /// it stops after frequency times max_empty_searches of real-time operation. If not set, a datafeed with no + /// end time that sees no data remains started until it is explicitly stopped. By default, it is not set. + /// /// public PutDatafeedRequestDescriptor MaxEmptySearches(int? maxEmptySearches) { @@ -545,7 +654,11 @@ public PutDatafeedRequestDescriptor MaxEmptySearches(int? maxEmptySea } /// - /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an
Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this
object is passed verbatim to Elasticsearch. + /// + /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an + /// Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this + /// object is passed verbatim to Elasticsearch. + /// /// public PutDatafeedRequestDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -572,7 +685,12 @@ public PutDatafeedRequestDescriptor Query(Action - /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might
not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default
value is randomly selected between `60s` and `120s`. This randomness improves the query performance
when there are multiple jobs running on the same node. + /// + /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might + /// not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default + /// value is randomly selected between 60s and 120s. This randomness improves the query performance + /// when there are multiple jobs running on the same node. + /// /// public PutDatafeedRequestDescriptor QueryDelay(Elastic.Clients.Elasticsearch.Serverless.Duration? queryDelay) { @@ -581,7 +699,9 @@ public PutDatafeedRequestDescriptor QueryDelay(Elastic.Clients.Elasti } /// - /// Specifies runtime fields for the datafeed search. + /// + /// Specifies runtime fields for the datafeed search. + /// /// public PutDatafeedRequestDescriptor RuntimeMappings(Func>, FluentDescriptorDictionary>> selector) { @@ -590,7 +710,10 @@ public PutDatafeedRequestDescriptor RuntimeMappings(Func - /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed.
The detector configuration objects in a job can contain functions that use these script fields. + /// + /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. + /// The detector configuration objects in a job can contain functions that use these script fields. + /// /// public PutDatafeedRequestDescriptor ScriptFields(Func, FluentDescriptorDictionary> selector) { @@ -599,7 +722,10 @@ public PutDatafeedRequestDescriptor ScriptFields(Func - /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations.
The maximum value is the value of `index.max_result_window`, which is 10,000 by default. + /// + /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. + /// The maximum value is the value of index.max_result_window, which is 10,000 by default. + /// /// public PutDatafeedRequestDescriptor ScrollSize(int? scrollSize) { @@ -739,7 +865,13 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Instantiates a datafeed.
Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.
You can associate only one datafeed with each anomaly detection job.
The datafeed contains a query that runs at a defined interval (`frequency`).
If you are concerned about delayed data, you can add a delay (`query_delay') at each interval.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had
at the time of creation and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead.
You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. +/// +/// Instantiates a datafeed. +/// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. +/// You can associate only one datafeed with each anomaly detection job. +/// The datafeed contains a query that runs at a defined interval (frequency). +/// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. +/// /// public sealed partial class PutDatafeedRequestDescriptor : RequestDescriptor { @@ -791,7 +923,10 @@ public PutDatafeedRequestDescriptor DatafeedId(Elastic.Clients.Elasticsearch.Ser private int? ScrollSizeValue { get; set; } /// - /// If set, the datafeed performs aggregation searches.
Support for aggregations is limited and should be used only with low cardinality data. + /// + /// If set, the datafeed performs aggregation searches. + /// Support for aggregations is limited and should be used only with low cardinality data. + /// /// public PutDatafeedRequestDescriptor Aggregations(Func, FluentDescriptorDictionary> selector) { @@ -800,7 +935,12 @@ public PutDatafeedRequestDescriptor Aggregations(Func - /// Datafeeds might be required to search over long time periods, for several months or years.
This search is split into time chunks in order to ensure the load on Elasticsearch is managed.
Chunking configuration controls how the size of these time chunks are calculated;
it is an advanced configuration option. + /// + /// Datafeeds might be required to search over long time periods, for several months or years. + /// This search is split into time chunks in order to ensure the load on Elasticsearch is managed. + /// Chunking configuration controls how the size of these time chunks are calculated; + /// it is an advanced configuration option. + /// /// public PutDatafeedRequestDescriptor ChunkingConfig(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ChunkingConfig? chunkingConfig) { @@ -827,7 +967,13 @@ public PutDatafeedRequestDescriptor ChunkingConfig(Action - /// Specifies whether the datafeed checks for missing data and the size of the window.
The datafeed can optionally search over indices that have already been read in an effort to determine whether
any data has subsequently been added to the index. If missing data is found, it is a good indication that the
`query_delay` is set too low and the data is being indexed after the datafeed has passed that moment in time.
This check runs only on real-time datafeeds. + /// + /// Specifies whether the datafeed checks for missing data and the size of the window. + /// The datafeed can optionally search over indices that have already been read in an effort to determine whether + /// any data has subsequently been added to the index. If missing data is found, it is a good indication that the + /// query_delay is set too low and the data is being indexed after the datafeed has passed that moment in time. + /// This check runs only on real-time datafeeds. + /// /// public PutDatafeedRequestDescriptor DelayedDataCheckConfig(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DelayedDataCheckConfig? delayedDataCheckConfig) { @@ -854,7 +1000,13 @@ public PutDatafeedRequestDescriptor DelayedDataCheckConfig(Action - /// The interval at which scheduled queries are made while the datafeed runs in real time.
The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible
fraction of the bucket span. When `frequency` is shorter than the bucket span, interim results for the last
(partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses
aggregations, this value must be divisible by the interval of the date histogram aggregation. + /// + /// The interval at which scheduled queries are made while the datafeed runs in real time. + /// The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible + /// fraction of the bucket span. When frequency is shorter than the bucket span, interim results for the last + /// (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses + /// aggregations, this value must be divisible by the interval of the date histogram aggregation. + /// /// public PutDatafeedRequestDescriptor Frequency(Elastic.Clients.Elasticsearch.Serverless.Duration? frequency) { @@ -869,7 +1021,10 @@ public PutDatafeedRequestDescriptor Headers(Func - /// An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine
learning nodes must have the `remote_cluster_client` role. + /// + /// An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine + /// learning nodes must have the remote_cluster_client role. + /// /// public PutDatafeedRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.Indices? indices) { @@ -878,7 +1033,9 @@ public PutDatafeedRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Server } /// - /// Specifies index expansion options that are used during search + /// + /// Specifies index expansion options that are used during search + /// /// public PutDatafeedRequestDescriptor IndicesOptions(Elastic.Clients.Elasticsearch.Serverless.IndicesOptions? indicesOptions) { @@ -905,7 +1062,9 @@ public PutDatafeedRequestDescriptor IndicesOptions(Action - /// Identifier for the anomaly detection job. + /// + /// Identifier for the anomaly detection job. + /// /// public PutDatafeedRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Serverless.Id? jobId) { @@ -914,7 +1073,12 @@ public PutDatafeedRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Serverle } /// - /// If a real-time datafeed has never seen any data (including during any initial training period), it automatically
stops and closes the associated job after this many real-time searches return no documents. In other words,
it stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no
end time that sees no data remains started until it is explicitly stopped. By default, it is not set. + /// + /// If a real-time datafeed has never seen any data (including during any initial training period), it automatically + /// stops and closes the associated job after this many real-time searches return no documents. In other words, + /// it stops after frequency times max_empty_searches of real-time operation. If not set, a datafeed with no + /// end time that sees no data remains started until it is explicitly stopped. By default, it is not set. + /// /// public PutDatafeedRequestDescriptor MaxEmptySearches(int? maxEmptySearches) { @@ -923,7 +1087,11 @@ public PutDatafeedRequestDescriptor MaxEmptySearches(int? maxEmptySearches) } /// - /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an
Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this
object is passed verbatim to Elasticsearch. + /// + /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an + /// Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this + /// object is passed verbatim to Elasticsearch. + /// /// public PutDatafeedRequestDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -950,7 +1118,12 @@ public PutDatafeedRequestDescriptor Query(Action - /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might
not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default
value is randomly selected between `60s` and `120s`. This randomness improves the query performance
when there are multiple jobs running on the same node. + /// + /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might + /// not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default + /// value is randomly selected between 60s and 120s. This randomness improves the query performance + /// when there are multiple jobs running on the same node. + /// /// public PutDatafeedRequestDescriptor QueryDelay(Elastic.Clients.Elasticsearch.Serverless.Duration? queryDelay) { @@ -959,7 +1132,9 @@ public PutDatafeedRequestDescriptor QueryDelay(Elastic.Clients.Elasticsearch.Ser } /// - /// Specifies runtime fields for the datafeed search. + /// + /// Specifies runtime fields for the datafeed search. + /// /// public PutDatafeedRequestDescriptor RuntimeMappings(Func, FluentDescriptorDictionary> selector) { @@ -968,7 +1143,10 @@ public PutDatafeedRequestDescriptor RuntimeMappings(Func - /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed.
The detector configuration objects in a job can contain functions that use these script fields. + /// + /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. + /// The detector configuration objects in a job can contain functions that use these script fields. + /// /// public PutDatafeedRequestDescriptor ScriptFields(Func, FluentDescriptorDictionary> selector) { @@ -977,7 +1155,10 @@ public PutDatafeedRequestDescriptor ScriptFields(Func - /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations.
The maximum value is the value of `index.max_result_window`, which is 10,000 by default. + /// + /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. + /// The maximum value is the value of index.max_result_window, which is 10,000 by default. + /// /// public PutDatafeedRequestDescriptor ScrollSize(int? scrollSize) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutFilterRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutFilterRequest.g.cs index 1803b304e16..93d8f9159e9 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutFilterRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutFilterRequest.g.cs @@ -34,7 +34,11 @@ public sealed partial class PutFilterRequestParameters : RequestParameters } /// -/// Instantiates a filter.
A filter contains a list of strings. It can be used by one or more anomaly detection jobs.
Specifically, filters are referenced in the `custom_rules` property of detector configuration objects. +/// +/// Instantiates a filter. +/// A filter contains a list of strings. It can be used by one or more anomaly detection jobs. +/// Specifically, filters are referenced in the custom_rules property of detector configuration objects. +/// /// public sealed partial class PutFilterRequest : PlainRequest { @@ -51,20 +55,29 @@ public PutFilterRequest(Elastic.Clients.Elasticsearch.Serverless.Id filterId) : internal override string OperationName => "ml.put_filter"; /// - /// A description of the filter. + /// + /// A description of the filter. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The items of the filter. A wildcard `*` can be used at the beginning or the end of an item.
Up to 10000 items are allowed in each filter. + /// + /// The items of the filter. A wildcard * can be used at the beginning or the end of an item. + /// Up to 10000 items are allowed in each filter. + /// /// [JsonInclude, JsonPropertyName("items")] public ICollection? Items { get; set; } } /// -/// Instantiates a filter.
A filter contains a list of strings. It can be used by one or more anomaly detection jobs.
Specifically, filters are referenced in the `custom_rules` property of detector configuration objects. +/// +/// Instantiates a filter. +/// A filter contains a list of strings. It can be used by one or more anomaly detection jobs. +/// Specifically, filters are referenced in the custom_rules property of detector configuration objects. +/// /// public sealed partial class PutFilterRequestDescriptor : RequestDescriptor { @@ -92,7 +105,9 @@ public PutFilterRequestDescriptor FilterId(Elastic.Clients.Elasticsearch.Serverl private ICollection? ItemsValue { get; set; } /// - /// A description of the filter. + /// + /// A description of the filter. + /// /// public PutFilterRequestDescriptor Description(string? description) { @@ -101,7 +116,10 @@ public PutFilterRequestDescriptor Description(string? description) } /// - /// The items of the filter. A wildcard `*` can be used at the beginning or the end of an item.
Up to 10000 items are allowed in each filter. + /// + /// The items of the filter. A wildcard * can be used at the beginning or the end of an item. + /// Up to 10000 items are allowed in each filter. + /// /// public PutFilterRequestDescriptor Items(ICollection? items) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutJobRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutJobRequest.g.cs index 749ab93417c..8e7709adc0a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutJobRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutJobRequest.g.cs @@ -34,7 +34,10 @@ public sealed partial class PutJobRequestParameters : RequestParameters } /// -/// Create an anomaly detection job.
If you include a `datafeed_config`, you must have read index privileges on the source index. +/// +/// Create an anomaly detection job. +/// If you include a datafeed_config, you must have read index privileges on the source index. +/// /// public sealed partial class PutJobRequest : PlainRequest { @@ -51,98 +54,131 @@ public PutJobRequest(Elastic.Clients.Elasticsearch.Serverless.Id jobId) : base(r internal override string OperationName => "ml.put_job"; /// - /// Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. By default, if a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this option is set to true, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available. + /// + /// Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. By default, if a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide xpack.ml.max_lazy_ml_nodes setting. If this option is set to true, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available. + /// /// [JsonInclude, JsonPropertyName("allow_lazy_open")] public bool? AllowLazyOpen { get; set; } /// - /// Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational. + /// + /// Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational. + /// /// [JsonInclude, JsonPropertyName("analysis_config")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.AnalysisConfig AnalysisConfig { get; set; } /// - /// Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes. + /// + /// Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes. + /// /// [JsonInclude, JsonPropertyName("analysis_limits")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.AnalysisLimits? AnalysisLimits { get; set; } /// - /// Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. For very large models (several GB), persistence could take 10-20 minutes, so do not set the `background_persist_interval` value too low. + /// + /// Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. For very large models (several GB), persistence could take 10-20 minutes, so do not set the background_persist_interval value too low. + /// /// [JsonInclude, JsonPropertyName("background_persist_interval")] public Elastic.Clients.Elasticsearch.Serverless.Duration? BackgroundPersistInterval { get; set; } /// - /// Advanced configuration option. Contains custom meta data about the job. + /// + /// Advanced configuration option. Contains custom meta data about the job. + /// /// [JsonInclude, JsonPropertyName("custom_settings")] public object? CustomSettings { get; set; } /// - /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to `model_snapshot_retention_days`. + /// + /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to model_snapshot_retention_days. + /// /// [JsonInclude, JsonPropertyName("daily_model_snapshot_retention_after_days")] public long? DailyModelSnapshotRetentionAfterDays { get; set; } /// - /// Defines the format of the input data when you send data to the job by using the post data API. Note that when configure a datafeed, these properties are automatically set. When data is received via the post data API, it is not stored in Elasticsearch. Only the results for anomaly detection are retained. + /// + /// Defines the format of the input data when you send data to the job by using the post data API. Note that when configure a datafeed, these properties are automatically set. When data is received via the post data API, it is not stored in Elasticsearch. Only the results for anomaly detection are retained. + /// /// [JsonInclude, JsonPropertyName("data_description")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataDescription DataDescription { get; set; } /// - /// Defines a datafeed for the anomaly detection job. If Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. + /// + /// Defines a datafeed for the anomaly detection job. If Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. + /// /// [JsonInclude, JsonPropertyName("datafeed_config")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DatafeedConfig? DatafeedConfig { get; set; } /// - /// A description of the job. + /// + /// A description of the job. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// A list of job groups. A job can belong to no groups or many. + /// + /// A list of job groups. A job can belong to no groups or many. + /// /// [JsonInclude, JsonPropertyName("groups")] public ICollection? Groups { get; set; } /// - /// This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced. + /// + /// This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced. + /// /// [JsonInclude, JsonPropertyName("model_plot_config")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ModelPlotConfig? ModelPlotConfig { get; set; } /// - /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. By default, snapshots ten days older than the newest snapshot are deleted. + /// + /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. By default, snapshots ten days older than the newest snapshot are deleted. + /// /// [JsonInclude, JsonPropertyName("model_snapshot_retention_days")] public long? ModelSnapshotRetentionDays { get; set; } /// - /// Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. The default value is the longer of 30 days or 100 bucket spans. + /// + /// Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. The default value is the longer of 30 days or 100 bucket spans. + /// /// [JsonInclude, JsonPropertyName("renormalization_window_days")] public long? RenormalizationWindowDays { get; set; } /// - /// A text string that affects the name of the machine learning results index. By default, the job generates an index named `.ml-anomalies-shared`. + /// + /// A text string that affects the name of the machine learning results index. By default, the job generates an index named .ml-anomalies-shared. + /// /// [JsonInclude, JsonPropertyName("results_index_name")] public Elastic.Clients.Elasticsearch.Serverless.IndexName? ResultsIndexName { get; set; } /// - /// Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained. Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. Annotations added by users are retained forever. + /// + /// Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained. Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. Annotations added by users are retained forever. + /// /// [JsonInclude, JsonPropertyName("results_retention_days")] public long? ResultsRetentionDays { get; set; } } /// -/// Create an anomaly detection job.
If you include a `datafeed_config`, you must have read index privileges on the source index. +/// +/// Create an anomaly detection job. +/// If you include a datafeed_config, you must have read index privileges on the source index. +/// /// public sealed partial class PutJobRequestDescriptor : RequestDescriptor, PutJobRequestParameters> { @@ -193,7 +229,9 @@ public PutJobRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Se private long? ResultsRetentionDaysValue { get; set; } /// - /// Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. By default, if a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this option is set to true, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available. + /// + /// Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. By default, if a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide xpack.ml.max_lazy_ml_nodes setting. If this option is set to true, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available. + /// /// public PutJobRequestDescriptor AllowLazyOpen(bool? allowLazyOpen = true) { @@ -202,7 +240,9 @@ public PutJobRequestDescriptor AllowLazyOpen(bool? allowLazyOpen = tr } /// - /// Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational. + /// + /// Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational. + /// /// public PutJobRequestDescriptor AnalysisConfig(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.AnalysisConfig analysisConfig) { @@ -229,7 +269,9 @@ public PutJobRequestDescriptor AnalysisConfig(Action - /// Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes. + /// + /// Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes. + /// /// public PutJobRequestDescriptor AnalysisLimits(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.AnalysisLimits? analysisLimits) { @@ -256,7 +298,9 @@ public PutJobRequestDescriptor AnalysisLimits(Action - /// Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. For very large models (several GB), persistence could take 10-20 minutes, so do not set the `background_persist_interval` value too low. + /// + /// Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. For very large models (several GB), persistence could take 10-20 minutes, so do not set the background_persist_interval value too low. + /// /// public PutJobRequestDescriptor BackgroundPersistInterval(Elastic.Clients.Elasticsearch.Serverless.Duration? backgroundPersistInterval) { @@ -265,7 +309,9 @@ public PutJobRequestDescriptor BackgroundPersistInterval(Elastic.Clie } /// - /// Advanced configuration option. Contains custom meta data about the job. + /// + /// Advanced configuration option. Contains custom meta data about the job. + /// /// public PutJobRequestDescriptor CustomSettings(object? customSettings) { @@ -274,7 +320,9 @@ public PutJobRequestDescriptor CustomSettings(object? customSettings) } /// - /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to `model_snapshot_retention_days`. + /// + /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to model_snapshot_retention_days. + /// /// public PutJobRequestDescriptor DailyModelSnapshotRetentionAfterDays(long? dailyModelSnapshotRetentionAfterDays) { @@ -283,7 +331,9 @@ public PutJobRequestDescriptor DailyModelSnapshotRetentionAfterDays(l } /// - /// Defines the format of the input data when you send data to the job by using the post data API. Note that when configure a datafeed, these properties are automatically set. When data is received via the post data API, it is not stored in Elasticsearch. Only the results for anomaly detection are retained. + /// + /// Defines the format of the input data when you send data to the job by using the post data API. Note that when configure a datafeed, these properties are automatically set. When data is received via the post data API, it is not stored in Elasticsearch. Only the results for anomaly detection are retained. + /// /// public PutJobRequestDescriptor DataDescription(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataDescription dataDescription) { @@ -310,7 +360,9 @@ public PutJobRequestDescriptor DataDescription(Action - /// Defines a datafeed for the anomaly detection job. If Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. + /// + /// Defines a datafeed for the anomaly detection job. If Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. + /// /// public PutJobRequestDescriptor DatafeedConfig(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DatafeedConfig? datafeedConfig) { @@ -337,7 +389,9 @@ public PutJobRequestDescriptor DatafeedConfig(Action - /// A description of the job. + /// + /// A description of the job. + /// /// public PutJobRequestDescriptor Description(string? description) { @@ -346,7 +400,9 @@ public PutJobRequestDescriptor Description(string? description) } /// - /// A list of job groups. A job can belong to no groups or many. + /// + /// A list of job groups. A job can belong to no groups or many. + /// /// public PutJobRequestDescriptor Groups(ICollection? groups) { @@ -355,7 +411,9 @@ public PutJobRequestDescriptor Groups(ICollection? groups) } /// - /// This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced. + /// + /// This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced. + /// /// public PutJobRequestDescriptor ModelPlotConfig(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ModelPlotConfig? modelPlotConfig) { @@ -382,7 +440,9 @@ public PutJobRequestDescriptor ModelPlotConfig(Action - /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. By default, snapshots ten days older than the newest snapshot are deleted. + /// + /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. By default, snapshots ten days older than the newest snapshot are deleted. + /// /// public PutJobRequestDescriptor ModelSnapshotRetentionDays(long? modelSnapshotRetentionDays) { @@ -391,7 +451,9 @@ public PutJobRequestDescriptor ModelSnapshotRetentionDays(long? model } /// - /// Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. The default value is the longer of 30 days or 100 bucket spans. + /// + /// Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. The default value is the longer of 30 days or 100 bucket spans. + /// /// public PutJobRequestDescriptor RenormalizationWindowDays(long? renormalizationWindowDays) { @@ -400,7 +462,9 @@ public PutJobRequestDescriptor RenormalizationWindowDays(long? renorm } /// - /// A text string that affects the name of the machine learning results index. By default, the job generates an index named `.ml-anomalies-shared`. + /// + /// A text string that affects the name of the machine learning results index. By default, the job generates an index named .ml-anomalies-shared. + /// /// public PutJobRequestDescriptor ResultsIndexName(Elastic.Clients.Elasticsearch.Serverless.IndexName? resultsIndexName) { @@ -409,7 +473,9 @@ public PutJobRequestDescriptor ResultsIndexName(Elastic.Clients.Elast } /// - /// Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained. Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. Annotations added by users are retained forever. + /// + /// Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained. Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. Annotations added by users are retained forever. + /// /// public PutJobRequestDescriptor ResultsRetentionDays(long? resultsRetentionDays) { @@ -565,7 +631,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Create an anomaly detection job.
If you include a `datafeed_config`, you must have read index privileges on the source index. +/// +/// Create an anomaly detection job. +/// If you include a datafeed_config, you must have read index privileges on the source index. +/// /// public sealed partial class PutJobRequestDescriptor : RequestDescriptor { @@ -616,7 +685,9 @@ public PutJobRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Serverless.Id private long? ResultsRetentionDaysValue { get; set; } /// - /// Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. By default, if a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this option is set to true, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available. + /// + /// Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. By default, if a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide xpack.ml.max_lazy_ml_nodes setting. If this option is set to true, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available. + /// /// public PutJobRequestDescriptor AllowLazyOpen(bool? allowLazyOpen = true) { @@ -625,7 +696,9 @@ public PutJobRequestDescriptor AllowLazyOpen(bool? allowLazyOpen = true) } /// - /// Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational. + /// + /// Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational. + /// /// public PutJobRequestDescriptor AnalysisConfig(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.AnalysisConfig analysisConfig) { @@ -652,7 +725,9 @@ public PutJobRequestDescriptor AnalysisConfig(Action - /// Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes. + /// + /// Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes. + /// /// public PutJobRequestDescriptor AnalysisLimits(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.AnalysisLimits? analysisLimits) { @@ -679,7 +754,9 @@ public PutJobRequestDescriptor AnalysisLimits(Action - /// Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. For very large models (several GB), persistence could take 10-20 minutes, so do not set the `background_persist_interval` value too low. + /// + /// Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. For very large models (several GB), persistence could take 10-20 minutes, so do not set the background_persist_interval value too low. + /// /// public PutJobRequestDescriptor BackgroundPersistInterval(Elastic.Clients.Elasticsearch.Serverless.Duration? backgroundPersistInterval) { @@ -688,7 +765,9 @@ public PutJobRequestDescriptor BackgroundPersistInterval(Elastic.Clients.Elastic } /// - /// Advanced configuration option. Contains custom meta data about the job. + /// + /// Advanced configuration option. Contains custom meta data about the job. + /// /// public PutJobRequestDescriptor CustomSettings(object? customSettings) { @@ -697,7 +776,9 @@ public PutJobRequestDescriptor CustomSettings(object? customSettings) } /// - /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to `model_snapshot_retention_days`. + /// + /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to model_snapshot_retention_days. + /// /// public PutJobRequestDescriptor DailyModelSnapshotRetentionAfterDays(long? dailyModelSnapshotRetentionAfterDays) { @@ -706,7 +787,9 @@ public PutJobRequestDescriptor DailyModelSnapshotRetentionAfterDays(long? dailyM } /// - /// Defines the format of the input data when you send data to the job by using the post data API. Note that when configure a datafeed, these properties are automatically set. When data is received via the post data API, it is not stored in Elasticsearch. Only the results for anomaly detection are retained. + /// + /// Defines the format of the input data when you send data to the job by using the post data API. Note that when configure a datafeed, these properties are automatically set. When data is received via the post data API, it is not stored in Elasticsearch. Only the results for anomaly detection are retained. + /// /// public PutJobRequestDescriptor DataDescription(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataDescription dataDescription) { @@ -733,7 +816,9 @@ public PutJobRequestDescriptor DataDescription(Action - /// Defines a datafeed for the anomaly detection job. If Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. + /// + /// Defines a datafeed for the anomaly detection job. If Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. + /// /// public PutJobRequestDescriptor DatafeedConfig(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DatafeedConfig? datafeedConfig) { @@ -760,7 +845,9 @@ public PutJobRequestDescriptor DatafeedConfig(Action - /// A description of the job. + /// + /// A description of the job. + /// /// public PutJobRequestDescriptor Description(string? description) { @@ -769,7 +856,9 @@ public PutJobRequestDescriptor Description(string? description) } /// - /// A list of job groups. A job can belong to no groups or many. + /// + /// A list of job groups. A job can belong to no groups or many. + /// /// public PutJobRequestDescriptor Groups(ICollection? groups) { @@ -778,7 +867,9 @@ public PutJobRequestDescriptor Groups(ICollection? groups) } /// - /// This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced. + /// + /// This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced. + /// /// public PutJobRequestDescriptor ModelPlotConfig(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ModelPlotConfig? modelPlotConfig) { @@ -805,7 +896,9 @@ public PutJobRequestDescriptor ModelPlotConfig(Action - /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. By default, snapshots ten days older than the newest snapshot are deleted. + /// + /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. By default, snapshots ten days older than the newest snapshot are deleted. + /// /// public PutJobRequestDescriptor ModelSnapshotRetentionDays(long? modelSnapshotRetentionDays) { @@ -814,7 +907,9 @@ public PutJobRequestDescriptor ModelSnapshotRetentionDays(long? modelSnapshotRet } /// - /// Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. The default value is the longer of 30 days or 100 bucket spans. + /// + /// Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. The default value is the longer of 30 days or 100 bucket spans. + /// /// public PutJobRequestDescriptor RenormalizationWindowDays(long? renormalizationWindowDays) { @@ -823,7 +918,9 @@ public PutJobRequestDescriptor RenormalizationWindowDays(long? renormalizationWi } /// - /// A text string that affects the name of the machine learning results index. By default, the job generates an index named `.ml-anomalies-shared`. + /// + /// A text string that affects the name of the machine learning results index. By default, the job generates an index named .ml-anomalies-shared. + /// /// public PutJobRequestDescriptor ResultsIndexName(Elastic.Clients.Elasticsearch.Serverless.IndexName? resultsIndexName) { @@ -832,7 +929,9 @@ public PutJobRequestDescriptor ResultsIndexName(Elastic.Clients.Elasticsearch.Se } /// - /// Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained. Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. Annotations added by users are retained forever. + /// + /// Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained. Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. Annotations added by users are retained forever. + /// /// public PutJobRequestDescriptor ResultsRetentionDays(long? resultsRetentionDays) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelAliasRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelAliasRequest.g.cs index cd3776f551b..48f4ff25dd4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelAliasRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelAliasRequest.g.cs @@ -32,13 +32,34 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class PutTrainedModelAliasRequestParameters : RequestParameters { /// - /// Specifies whether the alias gets reassigned to the specified trained
model if it is already assigned to a different model. If the alias is
already assigned and this parameter is false, the API returns an error. + /// + /// Specifies whether the alias gets reassigned to the specified trained + /// model if it is already assigned to a different model. If the alias is + /// already assigned and this parameter is false, the API returns an error. + /// /// public bool? Reassign { get => Q("reassign"); set => Q("reassign", value); } } /// -/// Creates or updates a trained model alias. A trained model alias is a logical
name used to reference a single trained model.
You can use aliases instead of trained model identifiers to make it easier to
reference your models. For example, you can use aliases in inference
aggregations and processors.
An alias must be unique and refer to only a single trained model. However,
you can have multiple aliases for each trained model.
If you use this API to update an alias such that it references a different
trained model ID and the model uses a different type of data frame analytics,
an error occurs. For example, this situation occurs if you have a trained
model for regression analysis and a trained model for classification
analysis; you cannot reassign an alias from one type of trained model to
another.
If you use this API to update an alias and there are very few input fields in
common between the old and new trained models for the model alias, the API
returns a warning. +/// +/// Creates or updates a trained model alias. A trained model alias is a logical +/// name used to reference a single trained model. +/// You can use aliases instead of trained model identifiers to make it easier to +/// reference your models. For example, you can use aliases in inference +/// aggregations and processors. +/// An alias must be unique and refer to only a single trained model. However, +/// you can have multiple aliases for each trained model. +/// If you use this API to update an alias such that it references a different +/// trained model ID and the model uses a different type of data frame analytics, +/// an error occurs. For example, this situation occurs if you have a trained +/// model for regression analysis and a trained model for classification +/// analysis; you cannot reassign an alias from one type of trained model to +/// another. +/// If you use this API to update an alias and there are very few input fields in +/// common between the old and new trained models for the model alias, the API +/// returns a warning. +/// /// public sealed partial class PutTrainedModelAliasRequest : PlainRequest { @@ -55,14 +76,35 @@ public PutTrainedModelAliasRequest(Elastic.Clients.Elasticsearch.Serverless.Id m internal override string OperationName => "ml.put_trained_model_alias"; /// - /// Specifies whether the alias gets reassigned to the specified trained
model if it is already assigned to a different model. If the alias is
already assigned and this parameter is false, the API returns an error. + /// + /// Specifies whether the alias gets reassigned to the specified trained + /// model if it is already assigned to a different model. If the alias is + /// already assigned and this parameter is false, the API returns an error. + /// /// [JsonIgnore] public bool? Reassign { get => Q("reassign"); set => Q("reassign", value); } } /// -/// Creates or updates a trained model alias. A trained model alias is a logical
name used to reference a single trained model.
You can use aliases instead of trained model identifiers to make it easier to
reference your models. For example, you can use aliases in inference
aggregations and processors.
An alias must be unique and refer to only a single trained model. However,
you can have multiple aliases for each trained model.
If you use this API to update an alias such that it references a different
trained model ID and the model uses a different type of data frame analytics,
an error occurs. For example, this situation occurs if you have a trained
model for regression analysis and a trained model for classification
analysis; you cannot reassign an alias from one type of trained model to
another.
If you use this API to update an alias and there are very few input fields in
common between the old and new trained models for the model alias, the API
returns a warning. +/// +/// Creates or updates a trained model alias. A trained model alias is a logical +/// name used to reference a single trained model. +/// You can use aliases instead of trained model identifiers to make it easier to +/// reference your models. For example, you can use aliases in inference +/// aggregations and processors. +/// An alias must be unique and refer to only a single trained model. However, +/// you can have multiple aliases for each trained model. +/// If you use this API to update an alias such that it references a different +/// trained model ID and the model uses a different type of data frame analytics, +/// an error occurs. For example, this situation occurs if you have a trained +/// model for regression analysis and a trained model for classification +/// analysis; you cannot reassign an alias from one type of trained model to +/// another. +/// If you use this API to update an alias and there are very few input fields in +/// common between the old and new trained models for the model alias, the API +/// returns a warning. +/// /// public sealed partial class PutTrainedModelAliasRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelAliasResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelAliasResponse.g.cs index 9e578e5f1ab..8fa9c7fa77b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelAliasResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelAliasResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class PutTrainedModelAliasResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelDefinitionPartRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelDefinitionPartRequest.g.cs index 18093abd56e..d30ce3b4bf4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelDefinitionPartRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelDefinitionPartRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class PutTrainedModelDefinitionPartRequestParameters : Req } /// -/// Creates part of a trained model definition. +/// +/// Creates part of a trained model definition. +/// /// public sealed partial class PutTrainedModelDefinitionPartRequest : PlainRequest { @@ -51,26 +53,34 @@ public PutTrainedModelDefinitionPartRequest(Elastic.Clients.Elasticsearch.Server internal override string OperationName => "ml.put_trained_model_definition_part"; /// - /// The definition part for the model. Must be a base64 encoded string. + /// + /// The definition part for the model. Must be a base64 encoded string. + /// /// [JsonInclude, JsonPropertyName("definition")] public string Definition { get; set; } /// - /// The total uncompressed definition length in bytes. Not base64 encoded. + /// + /// The total uncompressed definition length in bytes. Not base64 encoded. + /// /// [JsonInclude, JsonPropertyName("total_definition_length")] public long TotalDefinitionLength { get; set; } /// - /// The total number of parts that will be uploaded. Must be greater than 0. + /// + /// The total number of parts that will be uploaded. Must be greater than 0. + /// /// [JsonInclude, JsonPropertyName("total_parts")] public int TotalParts { get; set; } } /// -/// Creates part of a trained model definition. +/// +/// Creates part of a trained model definition. +/// /// public sealed partial class PutTrainedModelDefinitionPartRequestDescriptor : RequestDescriptor { @@ -105,7 +115,9 @@ public PutTrainedModelDefinitionPartRequestDescriptor Part(int part) private int TotalPartsValue { get; set; } /// - /// The definition part for the model. Must be a base64 encoded string. + /// + /// The definition part for the model. Must be a base64 encoded string. + /// /// public PutTrainedModelDefinitionPartRequestDescriptor Definition(string definition) { @@ -114,7 +126,9 @@ public PutTrainedModelDefinitionPartRequestDescriptor Definition(string definiti } /// - /// The total uncompressed definition length in bytes. Not base64 encoded. + /// + /// The total uncompressed definition length in bytes. Not base64 encoded. + /// /// public PutTrainedModelDefinitionPartRequestDescriptor TotalDefinitionLength(long totalDefinitionLength) { @@ -123,7 +137,9 @@ public PutTrainedModelDefinitionPartRequestDescriptor TotalDefinitionLength(long } /// - /// The total number of parts that will be uploaded. Must be greater than 0. + /// + /// The total number of parts that will be uploaded. Must be greater than 0. + /// /// public PutTrainedModelDefinitionPartRequestDescriptor TotalParts(int totalParts) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelDefinitionPartResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelDefinitionPartResponse.g.cs index 5f00a738b65..dd3c200a6b1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelDefinitionPartResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelDefinitionPartResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class PutTrainedModelDefinitionPartResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelRequest.g.cs index 5e09722bcf2..00e304e6b19 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelRequest.g.cs @@ -32,18 +32,27 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class PutTrainedModelRequestParameters : RequestParameters { /// - /// If set to `true` and a `compressed_definition` is provided,
the request defers definition decompression and skips relevant
validations. + /// + /// If set to true and a compressed_definition is provided, + /// the request defers definition decompression and skips relevant + /// validations. + /// /// public bool? DeferDefinitionDecompression { get => Q("defer_definition_decompression"); set => Q("defer_definition_decompression", value); } /// - /// Whether to wait for all child operations (e.g. model download)
to complete. + /// + /// Whether to wait for all child operations (e.g. model download) + /// to complete. + /// /// public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Enables you to supply a trained model that is not created by data frame analytics. +/// +/// Enables you to supply a trained model that is not created by data frame analytics. +/// /// public sealed partial class PutTrainedModelRequest : PlainRequest { @@ -60,86 +69,131 @@ public PutTrainedModelRequest(Elastic.Clients.Elasticsearch.Serverless.Id modelI internal override string OperationName => "ml.put_trained_model"; /// - /// If set to `true` and a `compressed_definition` is provided,
the request defers definition decompression and skips relevant
validations. + /// + /// If set to true and a compressed_definition is provided, + /// the request defers definition decompression and skips relevant + /// validations. + /// /// [JsonIgnore] public bool? DeferDefinitionDecompression { get => Q("defer_definition_decompression"); set => Q("defer_definition_decompression", value); } /// - /// Whether to wait for all child operations (e.g. model download)
to complete. + /// + /// Whether to wait for all child operations (e.g. model download) + /// to complete. + /// /// [JsonIgnore] public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } /// - /// The compressed (GZipped and Base64 encoded) inference definition of the
model. If compressed_definition is specified, then definition cannot be
specified. + /// + /// The compressed (GZipped and Base64 encoded) inference definition of the + /// model. If compressed_definition is specified, then definition cannot be + /// specified. + /// /// [JsonInclude, JsonPropertyName("compressed_definition")] public string? CompressedDefinition { get; set; } /// - /// The inference definition for the model. If definition is specified, then
compressed_definition cannot be specified. + /// + /// The inference definition for the model. If definition is specified, then + /// compressed_definition cannot be specified. + /// /// [JsonInclude, JsonPropertyName("definition")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Definition? Definition { get; set; } /// - /// A human-readable description of the inference trained model. + /// + /// A human-readable description of the inference trained model. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The default configuration for inference. This can be either a regression
or classification configuration. It must match the underlying
definition.trained_model's target_type. For pre-packaged models such as
ELSER the config is not required. + /// + /// The default configuration for inference. This can be either a regression + /// or classification configuration. It must match the underlying + /// definition.trained_model's target_type. For pre-packaged models such as + /// ELSER the config is not required. + /// /// [JsonInclude, JsonPropertyName("inference_config")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.InferenceConfigCreate? InferenceConfig { get; set; } /// - /// The input field names for the model definition. + /// + /// The input field names for the model definition. + /// /// [JsonInclude, JsonPropertyName("input")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Input? Input { get; set; } /// - /// An object map that contains metadata about the model. + /// + /// An object map that contains metadata about the model. + /// /// [JsonInclude, JsonPropertyName("metadata")] public object? Metadata { get; set; } /// - /// The estimated memory usage in bytes to keep the trained model in memory.
This property is supported only if defer_definition_decompression is true
or the model definition is not supplied. + /// + /// The estimated memory usage in bytes to keep the trained model in memory. + /// This property is supported only if defer_definition_decompression is true + /// or the model definition is not supplied. + /// /// [JsonInclude, JsonPropertyName("model_size_bytes")] public long? ModelSizeBytes { get; set; } /// - /// The model type. + /// + /// The model type. + /// /// [JsonInclude, JsonPropertyName("model_type")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainedModelType? ModelType { get; set; } /// - /// The platform architecture (if applicable) of the trained mode. If the model
only works on one platform, because it is heavily optimized for a particular
processor architecture and OS combination, then this field specifies which.
The format of the string must match the platform identifiers used by Elasticsearch,
so one of, `linux-x86_64`, `linux-aarch64`, `darwin-x86_64`, `darwin-aarch64`,
or `windows-x86_64`. For portable models (those that work independent of processor
architecture or OS features), leave this field unset. + /// + /// The platform architecture (if applicable) of the trained mode. If the model + /// only works on one platform, because it is heavily optimized for a particular + /// processor architecture and OS combination, then this field specifies which. + /// The format of the string must match the platform identifiers used by Elasticsearch, + /// so one of, linux-x86_64, linux-aarch64, darwin-x86_64, darwin-aarch64, + /// or windows-x86_64. For portable models (those that work independent of processor + /// architecture or OS features), leave this field unset. + /// /// [JsonInclude, JsonPropertyName("platform_architecture")] public string? PlatformArchitecture { get; set; } /// - /// Optional prefix strings applied at inference + /// + /// Optional prefix strings applied at inference + /// /// [JsonInclude, JsonPropertyName("prefix_strings")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainedModelPrefixStrings? PrefixStrings { get; set; } /// - /// An array of tags to organize the model. + /// + /// An array of tags to organize the model. + /// /// [JsonInclude, JsonPropertyName("tags")] public ICollection? Tags { get; set; } } /// -/// Enables you to supply a trained model that is not created by data frame analytics. +/// +/// Enables you to supply a trained model that is not created by data frame analytics. +/// /// public sealed partial class PutTrainedModelRequestDescriptor : RequestDescriptor, PutTrainedModelRequestParameters> { @@ -187,7 +241,11 @@ public PutTrainedModelRequestDescriptor ModelId(Elastic.Clients.Elast private ICollection? TagsValue { get; set; } /// - /// The compressed (GZipped and Base64 encoded) inference definition of the
model. If compressed_definition is specified, then definition cannot be
specified. + /// + /// The compressed (GZipped and Base64 encoded) inference definition of the + /// model. If compressed_definition is specified, then definition cannot be + /// specified. + /// /// public PutTrainedModelRequestDescriptor CompressedDefinition(string? compressedDefinition) { @@ -196,7 +254,10 @@ public PutTrainedModelRequestDescriptor CompressedDefinition(string? } /// - /// The inference definition for the model. If definition is specified, then
compressed_definition cannot be specified. + /// + /// The inference definition for the model. If definition is specified, then + /// compressed_definition cannot be specified. + /// /// public PutTrainedModelRequestDescriptor Definition(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Definition? definition) { @@ -223,7 +284,9 @@ public PutTrainedModelRequestDescriptor Definition(Action - /// A human-readable description of the inference trained model. + /// + /// A human-readable description of the inference trained model. + /// /// public PutTrainedModelRequestDescriptor Description(string? description) { @@ -232,7 +295,12 @@ public PutTrainedModelRequestDescriptor Description(string? descripti } /// - /// The default configuration for inference. This can be either a regression
or classification configuration. It must match the underlying
definition.trained_model's target_type. For pre-packaged models such as
ELSER the config is not required. + /// + /// The default configuration for inference. This can be either a regression + /// or classification configuration. It must match the underlying + /// definition.trained_model's target_type. For pre-packaged models such as + /// ELSER the config is not required. + /// /// public PutTrainedModelRequestDescriptor InferenceConfig(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.InferenceConfigCreate? inferenceConfig) { @@ -259,7 +327,9 @@ public PutTrainedModelRequestDescriptor InferenceConfig(Action - /// The input field names for the model definition. + /// + /// The input field names for the model definition. + /// /// public PutTrainedModelRequestDescriptor Input(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Input? input) { @@ -286,7 +356,9 @@ public PutTrainedModelRequestDescriptor Input(Action - /// An object map that contains metadata about the model. + /// + /// An object map that contains metadata about the model. + /// /// public PutTrainedModelRequestDescriptor Metadata(object? metadata) { @@ -295,7 +367,11 @@ public PutTrainedModelRequestDescriptor Metadata(object? metadata) } /// - /// The estimated memory usage in bytes to keep the trained model in memory.
This property is supported only if defer_definition_decompression is true
or the model definition is not supplied. + /// + /// The estimated memory usage in bytes to keep the trained model in memory. + /// This property is supported only if defer_definition_decompression is true + /// or the model definition is not supplied. + /// /// public PutTrainedModelRequestDescriptor ModelSizeBytes(long? modelSizeBytes) { @@ -304,7 +380,9 @@ public PutTrainedModelRequestDescriptor ModelSizeBytes(long? modelSiz } /// - /// The model type. + /// + /// The model type. + /// /// public PutTrainedModelRequestDescriptor ModelType(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainedModelType? modelType) { @@ -313,7 +391,15 @@ public PutTrainedModelRequestDescriptor ModelType(Elastic.Clients.Ela } /// - /// The platform architecture (if applicable) of the trained mode. If the model
only works on one platform, because it is heavily optimized for a particular
processor architecture and OS combination, then this field specifies which.
The format of the string must match the platform identifiers used by Elasticsearch,
so one of, `linux-x86_64`, `linux-aarch64`, `darwin-x86_64`, `darwin-aarch64`,
or `windows-x86_64`. For portable models (those that work independent of processor
architecture or OS features), leave this field unset. + /// + /// The platform architecture (if applicable) of the trained mode. If the model + /// only works on one platform, because it is heavily optimized for a particular + /// processor architecture and OS combination, then this field specifies which. + /// The format of the string must match the platform identifiers used by Elasticsearch, + /// so one of, linux-x86_64, linux-aarch64, darwin-x86_64, darwin-aarch64, + /// or windows-x86_64. For portable models (those that work independent of processor + /// architecture or OS features), leave this field unset. + /// /// public PutTrainedModelRequestDescriptor PlatformArchitecture(string? platformArchitecture) { @@ -322,7 +408,9 @@ public PutTrainedModelRequestDescriptor PlatformArchitecture(string? } /// - /// Optional prefix strings applied at inference + /// + /// Optional prefix strings applied at inference + /// /// public PutTrainedModelRequestDescriptor PrefixStrings(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainedModelPrefixStrings? prefixStrings) { @@ -349,7 +437,9 @@ public PutTrainedModelRequestDescriptor PrefixStrings(Action - /// An array of tags to organize the model. + /// + /// An array of tags to organize the model. + /// /// public PutTrainedModelRequestDescriptor Tags(ICollection? tags) { @@ -471,7 +561,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Enables you to supply a trained model that is not created by data frame analytics. +/// +/// Enables you to supply a trained model that is not created by data frame analytics. +/// /// public sealed partial class PutTrainedModelRequestDescriptor : RequestDescriptor { @@ -519,7 +611,11 @@ public PutTrainedModelRequestDescriptor ModelId(Elastic.Clients.Elasticsearch.Se private ICollection? TagsValue { get; set; } /// - /// The compressed (GZipped and Base64 encoded) inference definition of the
model. If compressed_definition is specified, then definition cannot be
specified. + /// + /// The compressed (GZipped and Base64 encoded) inference definition of the + /// model. If compressed_definition is specified, then definition cannot be + /// specified. + /// /// public PutTrainedModelRequestDescriptor CompressedDefinition(string? compressedDefinition) { @@ -528,7 +624,10 @@ public PutTrainedModelRequestDescriptor CompressedDefinition(string? compressedD } /// - /// The inference definition for the model. If definition is specified, then
compressed_definition cannot be specified. + /// + /// The inference definition for the model. If definition is specified, then + /// compressed_definition cannot be specified. + /// /// public PutTrainedModelRequestDescriptor Definition(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Definition? definition) { @@ -555,7 +654,9 @@ public PutTrainedModelRequestDescriptor Definition(Action - /// A human-readable description of the inference trained model. + /// + /// A human-readable description of the inference trained model. + /// /// public PutTrainedModelRequestDescriptor Description(string? description) { @@ -564,7 +665,12 @@ public PutTrainedModelRequestDescriptor Description(string? description) } /// - /// The default configuration for inference. This can be either a regression
or classification configuration. It must match the underlying
definition.trained_model's target_type. For pre-packaged models such as
ELSER the config is not required. + /// + /// The default configuration for inference. This can be either a regression + /// or classification configuration. It must match the underlying + /// definition.trained_model's target_type. For pre-packaged models such as + /// ELSER the config is not required. + /// /// public PutTrainedModelRequestDescriptor InferenceConfig(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.InferenceConfigCreate? inferenceConfig) { @@ -591,7 +697,9 @@ public PutTrainedModelRequestDescriptor InferenceConfig(Action - /// The input field names for the model definition. + /// + /// The input field names for the model definition. + /// /// public PutTrainedModelRequestDescriptor Input(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Input? input) { @@ -618,7 +726,9 @@ public PutTrainedModelRequestDescriptor Input(Action - /// An object map that contains metadata about the model. + /// + /// An object map that contains metadata about the model. + /// /// public PutTrainedModelRequestDescriptor Metadata(object? metadata) { @@ -627,7 +737,11 @@ public PutTrainedModelRequestDescriptor Metadata(object? metadata) } /// - /// The estimated memory usage in bytes to keep the trained model in memory.
This property is supported only if defer_definition_decompression is true
or the model definition is not supplied. + /// + /// The estimated memory usage in bytes to keep the trained model in memory. + /// This property is supported only if defer_definition_decompression is true + /// or the model definition is not supplied. + /// /// public PutTrainedModelRequestDescriptor ModelSizeBytes(long? modelSizeBytes) { @@ -636,7 +750,9 @@ public PutTrainedModelRequestDescriptor ModelSizeBytes(long? modelSizeBytes) } /// - /// The model type. + /// + /// The model type. + /// /// public PutTrainedModelRequestDescriptor ModelType(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainedModelType? modelType) { @@ -645,7 +761,15 @@ public PutTrainedModelRequestDescriptor ModelType(Elastic.Clients.Elasticsearch. } /// - /// The platform architecture (if applicable) of the trained mode. If the model
only works on one platform, because it is heavily optimized for a particular
processor architecture and OS combination, then this field specifies which.
The format of the string must match the platform identifiers used by Elasticsearch,
so one of, `linux-x86_64`, `linux-aarch64`, `darwin-x86_64`, `darwin-aarch64`,
or `windows-x86_64`. For portable models (those that work independent of processor
architecture or OS features), leave this field unset. + /// + /// The platform architecture (if applicable) of the trained mode. If the model + /// only works on one platform, because it is heavily optimized for a particular + /// processor architecture and OS combination, then this field specifies which. + /// The format of the string must match the platform identifiers used by Elasticsearch, + /// so one of, linux-x86_64, linux-aarch64, darwin-x86_64, darwin-aarch64, + /// or windows-x86_64. For portable models (those that work independent of processor + /// architecture or OS features), leave this field unset. + /// /// public PutTrainedModelRequestDescriptor PlatformArchitecture(string? platformArchitecture) { @@ -654,7 +778,9 @@ public PutTrainedModelRequestDescriptor PlatformArchitecture(string? platformArc } /// - /// Optional prefix strings applied at inference + /// + /// Optional prefix strings applied at inference + /// /// public PutTrainedModelRequestDescriptor PrefixStrings(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainedModelPrefixStrings? prefixStrings) { @@ -681,7 +807,9 @@ public PutTrainedModelRequestDescriptor PrefixStrings(Action - /// An array of tags to organize the model. + /// + /// An array of tags to organize the model. + /// /// public PutTrainedModelRequestDescriptor Tags(ICollection? tags) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelResponse.g.cs index e92cc562529..1d1df81e3df 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelResponse.g.cs @@ -32,61 +32,81 @@ public sealed partial class PutTrainedModelResponse : ElasticsearchResponse public string? CompressedDefinition { get; init; } /// - /// Information on the creator of the trained model. + /// + /// Information on the creator of the trained model. + /// /// [JsonInclude, JsonPropertyName("created_by")] public string? CreatedBy { get; init; } /// - /// The time when the trained model was created. + /// + /// The time when the trained model was created. + /// /// [JsonInclude, JsonPropertyName("create_time")] public DateTimeOffset? CreateTime { get; init; } /// - /// Any field map described in the inference configuration takes precedence. + /// + /// Any field map described in the inference configuration takes precedence. + /// /// [JsonInclude, JsonPropertyName("default_field_map")] public IReadOnlyDictionary? DefaultFieldMap { get; init; } /// - /// The free-text description of the trained model. + /// + /// The free-text description of the trained model. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; init; } /// - /// The estimated heap usage in bytes to keep the trained model in memory. + /// + /// The estimated heap usage in bytes to keep the trained model in memory. + /// /// [JsonInclude, JsonPropertyName("estimated_heap_memory_usage_bytes")] public int? EstimatedHeapMemoryUsageBytes { get; init; } /// - /// The estimated number of operations to use the trained model. + /// + /// The estimated number of operations to use the trained model. + /// /// [JsonInclude, JsonPropertyName("estimated_operations")] public int? EstimatedOperations { get; init; } /// - /// True if the full model definition is present. + /// + /// True if the full model definition is present. + /// /// [JsonInclude, JsonPropertyName("fully_defined")] public bool? FullyDefined { get; init; } /// - /// The default configuration for inference. This can be either a regression, classification, or one of the many NLP focused configurations. It must match the underlying definition.trained_model's target_type. For pre-packaged models such as ELSER the config is not required. + /// + /// The default configuration for inference. This can be either a regression, classification, or one of the many NLP focused configurations. It must match the underlying definition.trained_model's target_type. For pre-packaged models such as ELSER the config is not required. + /// /// [JsonInclude, JsonPropertyName("inference_config")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.InferenceConfigCreate? InferenceConfig { get; init; } /// - /// The input field names for the model definition. + /// + /// The input field names for the model definition. + /// /// [JsonInclude, JsonPropertyName("input")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainedModelConfigInput Input { get; init; } /// - /// The license level of the trained model. + /// + /// The license level of the trained model. + /// /// [JsonInclude, JsonPropertyName("license_level")] public string? LicenseLevel { get; init; } @@ -94,13 +114,17 @@ public sealed partial class PutTrainedModelResponse : ElasticsearchResponse public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainedModelLocation? Location { get; init; } /// - /// An object containing metadata about the trained model. For example, models created by data frame analytics contain analysis_config and input objects. + /// + /// An object containing metadata about the trained model. For example, models created by data frame analytics contain analysis_config and input objects. + /// /// [JsonInclude, JsonPropertyName("metadata")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainedModelConfigMetadata? Metadata { get; init; } /// - /// Identifier for the trained model. + /// + /// Identifier for the trained model. + /// /// [JsonInclude, JsonPropertyName("model_id")] public string ModelId { get; init; } @@ -108,7 +132,9 @@ public sealed partial class PutTrainedModelResponse : ElasticsearchResponse public Elastic.Clients.Elasticsearch.Serverless.ByteSize? ModelSizeBytes { get; init; } /// - /// The model type + /// + /// The model type + /// /// [JsonInclude, JsonPropertyName("model_type")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainedModelType? ModelType { get; init; } @@ -116,13 +142,17 @@ public sealed partial class PutTrainedModelResponse : ElasticsearchResponse public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainedModelPrefixStrings? PrefixStrings { get; init; } /// - /// A comma delimited string of tags. A trained model can have many tags, or none. + /// + /// A comma delimited string of tags. A trained model can have many tags, or none. + /// /// [JsonInclude, JsonPropertyName("tags")] public IReadOnlyCollection Tags { get; init; } /// - /// The Elasticsearch version number in which the trained model was created. + /// + /// The Elasticsearch version number in which the trained model was created. + /// /// [JsonInclude, JsonPropertyName("version")] public string? Version { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelVocabularyRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelVocabularyRequest.g.cs index e7f1ebfc331..b2ce74e9d33 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelVocabularyRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelVocabularyRequest.g.cs @@ -34,7 +34,11 @@ public sealed partial class PutTrainedModelVocabularyRequestParameters : Request } /// -/// Creates a trained model vocabulary.
This API is supported only for natural language processing (NLP) models.
The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition. +/// +/// Creates a trained model vocabulary. +/// This API is supported only for natural language processing (NLP) models. +/// The vocabulary is stored in the index as described in inference_config.*.vocabulary of the trained model definition. +/// /// public sealed partial class PutTrainedModelVocabularyRequest : PlainRequest { @@ -51,26 +55,36 @@ public PutTrainedModelVocabularyRequest(Elastic.Clients.Elasticsearch.Serverless internal override string OperationName => "ml.put_trained_model_vocabulary"; /// - /// The optional model merges if required by the tokenizer. + /// + /// The optional model merges if required by the tokenizer. + /// /// [JsonInclude, JsonPropertyName("merges")] public ICollection? Merges { get; set; } /// - /// The optional vocabulary value scores if required by the tokenizer. + /// + /// The optional vocabulary value scores if required by the tokenizer. + /// /// [JsonInclude, JsonPropertyName("scores")] public ICollection? Scores { get; set; } /// - /// The model vocabulary, which must not be empty. + /// + /// The model vocabulary, which must not be empty. + /// /// [JsonInclude, JsonPropertyName("vocabulary")] public ICollection Vocabulary { get; set; } } /// -/// Creates a trained model vocabulary.
This API is supported only for natural language processing (NLP) models.
The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition. +/// +/// Creates a trained model vocabulary. +/// This API is supported only for natural language processing (NLP) models. +/// The vocabulary is stored in the index as described in inference_config.*.vocabulary of the trained model definition. +/// /// public sealed partial class PutTrainedModelVocabularyRequestDescriptor : RequestDescriptor { @@ -99,7 +113,9 @@ public PutTrainedModelVocabularyRequestDescriptor ModelId(Elastic.Clients.Elasti private ICollection VocabularyValue { get; set; } /// - /// The optional model merges if required by the tokenizer. + /// + /// The optional model merges if required by the tokenizer. + /// /// public PutTrainedModelVocabularyRequestDescriptor Merges(ICollection? merges) { @@ -108,7 +124,9 @@ public PutTrainedModelVocabularyRequestDescriptor Merges(ICollection? me } /// - /// The optional vocabulary value scores if required by the tokenizer. + /// + /// The optional vocabulary value scores if required by the tokenizer. + /// /// public PutTrainedModelVocabularyRequestDescriptor Scores(ICollection? scores) { @@ -117,7 +135,9 @@ public PutTrainedModelVocabularyRequestDescriptor Scores(ICollection? sc } /// - /// The model vocabulary, which must not be empty. + /// + /// The model vocabulary, which must not be empty. + /// /// public PutTrainedModelVocabularyRequestDescriptor Vocabulary(ICollection vocabulary) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelVocabularyResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelVocabularyResponse.g.cs index 78dd66b652c..aeb196b185e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelVocabularyResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelVocabularyResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class PutTrainedModelVocabularyResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ResetJobRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ResetJobRequest.g.cs index a780ab75c79..a664de93d9d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ResetJobRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ResetJobRequest.g.cs @@ -32,18 +32,31 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class ResetJobRequestParameters : RequestParameters { /// - /// Specifies whether annotations that have been added by the
user should be deleted along with any auto-generated annotations when the job is
reset. + /// + /// Specifies whether annotations that have been added by the + /// user should be deleted along with any auto-generated annotations when the job is + /// reset. + /// /// public bool? DeleteUserAnnotations { get => Q("delete_user_annotations"); set => Q("delete_user_annotations", value); } /// - /// Should this request wait until the operation has completed before
returning. + /// + /// Should this request wait until the operation has completed before + /// returning. + /// /// public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Resets an anomaly detection job.
All model state and results are deleted. The job is ready to start over as if
it had just been created.
It is not currently possible to reset multiple jobs using wildcards or a
comma separated list. +/// +/// Resets an anomaly detection job. +/// All model state and results are deleted. The job is ready to start over as if +/// it had just been created. +/// It is not currently possible to reset multiple jobs using wildcards or a +/// comma separated list. +/// /// public sealed partial class ResetJobRequest : PlainRequest { @@ -60,20 +73,33 @@ public ResetJobRequest(Elastic.Clients.Elasticsearch.Serverless.Id jobId) : base internal override string OperationName => "ml.reset_job"; /// - /// Specifies whether annotations that have been added by the
user should be deleted along with any auto-generated annotations when the job is
reset. + /// + /// Specifies whether annotations that have been added by the + /// user should be deleted along with any auto-generated annotations when the job is + /// reset. + /// /// [JsonIgnore] public bool? DeleteUserAnnotations { get => Q("delete_user_annotations"); set => Q("delete_user_annotations", value); } /// - /// Should this request wait until the operation has completed before
returning. + /// + /// Should this request wait until the operation has completed before + /// returning. + /// /// [JsonIgnore] public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Resets an anomaly detection job.
All model state and results are deleted. The job is ready to start over as if
it had just been created.
It is not currently possible to reset multiple jobs using wildcards or a
comma separated list. +/// +/// Resets an anomaly detection job. +/// All model state and results are deleted. The job is ready to start over as if +/// it had just been created. +/// It is not currently possible to reset multiple jobs using wildcards or a +/// comma separated list. +/// /// public sealed partial class ResetJobRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ResetJobResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ResetJobResponse.g.cs index aa0af2f69f9..b0d56d75278 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ResetJobResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ResetJobResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class ResetJobResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/RevertModelSnapshotRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/RevertModelSnapshotRequest.g.cs index cca4d0b1da3..b936dad0f86 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/RevertModelSnapshotRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/RevertModelSnapshotRequest.g.cs @@ -34,7 +34,16 @@ public sealed partial class RevertModelSnapshotRequestParameters : RequestParame } /// -/// Reverts to a specific snapshot.
The machine learning features react quickly to anomalous input, learning new
behaviors in data. Highly anomalous input increases the variance in the
models whilst the system learns whether this is a new step-change in behavior
or a one-off event. In the case where this anomalous input is known to be a
one-off, then it might be appropriate to reset the model state to a time
before this event. For example, you might consider reverting to a saved
snapshot after Black Friday or a critical system failure. +/// +/// Reverts to a specific snapshot. +/// The machine learning features react quickly to anomalous input, learning new +/// behaviors in data. Highly anomalous input increases the variance in the +/// models whilst the system learns whether this is a new step-change in behavior +/// or a one-off event. In the case where this anomalous input is known to be a +/// one-off, then it might be appropriate to reset the model state to a time +/// before this event. For example, you might consider reverting to a saved +/// snapshot after Black Friday or a critical system failure. +/// /// public sealed partial class RevertModelSnapshotRequest : PlainRequest { @@ -51,14 +60,25 @@ public RevertModelSnapshotRequest(Elastic.Clients.Elasticsearch.Serverless.Id jo internal override string OperationName => "ml.revert_model_snapshot"; /// - /// Refer to the description for the `delete_intervening_results` query parameter. + /// + /// Refer to the description for the delete_intervening_results query parameter. + /// /// [JsonInclude, JsonPropertyName("delete_intervening_results")] public bool? DeleteInterveningResults { get; set; } } /// -/// Reverts to a specific snapshot.
The machine learning features react quickly to anomalous input, learning new
behaviors in data. Highly anomalous input increases the variance in the
models whilst the system learns whether this is a new step-change in behavior
or a one-off event. In the case where this anomalous input is known to be a
one-off, then it might be appropriate to reset the model state to a time
before this event. For example, you might consider reverting to a saved
snapshot after Black Friday or a critical system failure. +/// +/// Reverts to a specific snapshot. +/// The machine learning features react quickly to anomalous input, learning new +/// behaviors in data. Highly anomalous input increases the variance in the +/// models whilst the system learns whether this is a new step-change in behavior +/// or a one-off event. In the case where this anomalous input is known to be a +/// one-off, then it might be appropriate to reset the model state to a time +/// before this event. For example, you might consider reverting to a saved +/// snapshot after Black Friday or a critical system failure. +/// /// public sealed partial class RevertModelSnapshotRequestDescriptor : RequestDescriptor { @@ -91,7 +111,9 @@ public RevertModelSnapshotRequestDescriptor SnapshotId(Elastic.Clients.Elasticse private bool? DeleteInterveningResultsValue { get; set; } /// - /// Refer to the description for the `delete_intervening_results` query parameter. + /// + /// Refer to the description for the delete_intervening_results query parameter. + /// /// public RevertModelSnapshotRequestDescriptor DeleteInterveningResults(bool? deleteInterveningResults = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/SetUpgradeModeRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/SetUpgradeModeRequest.g.cs index 31a3522b0e3..7e6eda13c46 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/SetUpgradeModeRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/SetUpgradeModeRequest.g.cs @@ -32,18 +32,37 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class SetUpgradeModeRequestParameters : RequestParameters { /// - /// When `true`, it enables `upgrade_mode` which temporarily halts all job
and datafeed tasks and prohibits new job and datafeed tasks from
starting. + /// + /// When true, it enables upgrade_mode which temporarily halts all job + /// and datafeed tasks and prohibits new job and datafeed tasks from + /// starting. + /// /// public bool? Enabled { get => Q("enabled"); set => Q("enabled", value); } /// - /// The time to wait for the request to be completed. + /// + /// The time to wait for the request to be completed. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Sets a cluster wide upgrade_mode setting that prepares machine learning
indices for an upgrade.
When upgrading your cluster, in some circumstances you must restart your
nodes and reindex your machine learning indices. In those circumstances,
there must be no machine learning jobs running. You can close the machine
learning jobs, do the upgrade, then open all the jobs again. Alternatively,
you can use this API to temporarily halt tasks associated with the jobs and
datafeeds and prevent new jobs from opening. You can also use this API
during upgrades that do not require you to reindex your machine learning
indices, though stopping jobs is not a requirement in that case.
You can see the current value for the upgrade_mode setting by using the get
machine learning info API. +/// +/// Sets a cluster wide upgrade_mode setting that prepares machine learning +/// indices for an upgrade. +/// When upgrading your cluster, in some circumstances you must restart your +/// nodes and reindex your machine learning indices. In those circumstances, +/// there must be no machine learning jobs running. You can close the machine +/// learning jobs, do the upgrade, then open all the jobs again. Alternatively, +/// you can use this API to temporarily halt tasks associated with the jobs and +/// datafeeds and prevent new jobs from opening. You can also use this API +/// during upgrades that do not require you to reindex your machine learning +/// indices, though stopping jobs is not a requirement in that case. +/// You can see the current value for the upgrade_mode setting by using the get +/// machine learning info API. +/// /// public sealed partial class SetUpgradeModeRequest : PlainRequest { @@ -56,20 +75,39 @@ public sealed partial class SetUpgradeModeRequest : PlainRequest "ml.set_upgrade_mode"; /// - /// When `true`, it enables `upgrade_mode` which temporarily halts all job
and datafeed tasks and prohibits new job and datafeed tasks from
starting. + /// + /// When true, it enables upgrade_mode which temporarily halts all job + /// and datafeed tasks and prohibits new job and datafeed tasks from + /// starting. + /// /// [JsonIgnore] public bool? Enabled { get => Q("enabled"); set => Q("enabled", value); } /// - /// The time to wait for the request to be completed. + /// + /// The time to wait for the request to be completed. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Sets a cluster wide upgrade_mode setting that prepares machine learning
indices for an upgrade.
When upgrading your cluster, in some circumstances you must restart your
nodes and reindex your machine learning indices. In those circumstances,
there must be no machine learning jobs running. You can close the machine
learning jobs, do the upgrade, then open all the jobs again. Alternatively,
you can use this API to temporarily halt tasks associated with the jobs and
datafeeds and prevent new jobs from opening. You can also use this API
during upgrades that do not require you to reindex your machine learning
indices, though stopping jobs is not a requirement in that case.
You can see the current value for the upgrade_mode setting by using the get
machine learning info API. +/// +/// Sets a cluster wide upgrade_mode setting that prepares machine learning +/// indices for an upgrade. +/// When upgrading your cluster, in some circumstances you must restart your +/// nodes and reindex your machine learning indices. In those circumstances, +/// there must be no machine learning jobs running. You can close the machine +/// learning jobs, do the upgrade, then open all the jobs again. Alternatively, +/// you can use this API to temporarily halt tasks associated with the jobs and +/// datafeeds and prevent new jobs from opening. You can also use this API +/// during upgrades that do not require you to reindex your machine learning +/// indices, though stopping jobs is not a requirement in that case. +/// You can see the current value for the upgrade_mode setting by using the get +/// machine learning info API. +/// /// public sealed partial class SetUpgradeModeRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/SetUpgradeModeResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/SetUpgradeModeResponse.g.cs index e5257412c43..68adcc98b6f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/SetUpgradeModeResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/SetUpgradeModeResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class SetUpgradeModeResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StartDataFrameAnalyticsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StartDataFrameAnalyticsRequest.g.cs index 637b78d6c0f..d37036516c5 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StartDataFrameAnalyticsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StartDataFrameAnalyticsRequest.g.cs @@ -32,13 +32,29 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class StartDataFrameAnalyticsRequestParameters : RequestParameters { /// - /// Controls the amount of time to wait until the data frame analytics job
starts. + /// + /// Controls the amount of time to wait until the data frame analytics job + /// starts. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Starts a data frame analytics job.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle.
If the destination index does not exist, it is created automatically the
first time you start the data frame analytics job. The
`index.number_of_shards` and `index.number_of_replicas` settings for the
destination index are copied from the source index. If there are multiple
source indices, the destination index copies the highest setting values. The
mappings for the destination index are also copied from the source indices.
If there are any mapping conflicts, the job fails to start.
If the destination index exists, it is used as is. You can therefore set up
the destination index in advance with custom settings and mappings. +/// +/// Starts a data frame analytics job. +/// A data frame analytics job can be started and stopped multiple times +/// throughout its lifecycle. +/// If the destination index does not exist, it is created automatically the +/// first time you start the data frame analytics job. The +/// index.number_of_shards and index.number_of_replicas settings for the +/// destination index are copied from the source index. If there are multiple +/// source indices, the destination index copies the highest setting values. The +/// mappings for the destination index are also copied from the source indices. +/// If there are any mapping conflicts, the job fails to start. +/// If the destination index exists, it is used as is. You can therefore set up +/// the destination index in advance with custom settings and mappings. +/// /// public sealed partial class StartDataFrameAnalyticsRequest : PlainRequest { @@ -55,14 +71,30 @@ public StartDataFrameAnalyticsRequest(Elastic.Clients.Elasticsearch.Serverless.I internal override string OperationName => "ml.start_data_frame_analytics"; /// - /// Controls the amount of time to wait until the data frame analytics job
starts. + /// + /// Controls the amount of time to wait until the data frame analytics job + /// starts. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Starts a data frame analytics job.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle.
If the destination index does not exist, it is created automatically the
first time you start the data frame analytics job. The
`index.number_of_shards` and `index.number_of_replicas` settings for the
destination index are copied from the source index. If there are multiple
source indices, the destination index copies the highest setting values. The
mappings for the destination index are also copied from the source indices.
If there are any mapping conflicts, the job fails to start.
If the destination index exists, it is used as is. You can therefore set up
the destination index in advance with custom settings and mappings. +/// +/// Starts a data frame analytics job. +/// A data frame analytics job can be started and stopped multiple times +/// throughout its lifecycle. +/// If the destination index does not exist, it is created automatically the +/// first time you start the data frame analytics job. The +/// index.number_of_shards and index.number_of_replicas settings for the +/// destination index are copied from the source index. If there are multiple +/// source indices, the destination index copies the highest setting values. The +/// mappings for the destination index are also copied from the source indices. +/// If there are any mapping conflicts, the job fails to start. +/// If the destination index exists, it is used as is. You can therefore set up +/// the destination index in advance with custom settings and mappings. +/// /// public sealed partial class StartDataFrameAnalyticsRequestDescriptor : RequestDescriptor, StartDataFrameAnalyticsRequestParameters> { @@ -94,7 +126,20 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Starts a data frame analytics job.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle.
If the destination index does not exist, it is created automatically the
first time you start the data frame analytics job. The
`index.number_of_shards` and `index.number_of_replicas` settings for the
destination index are copied from the source index. If there are multiple
source indices, the destination index copies the highest setting values. The
mappings for the destination index are also copied from the source indices.
If there are any mapping conflicts, the job fails to start.
If the destination index exists, it is used as is. You can therefore set up
the destination index in advance with custom settings and mappings. +/// +/// Starts a data frame analytics job. +/// A data frame analytics job can be started and stopped multiple times +/// throughout its lifecycle. +/// If the destination index does not exist, it is created automatically the +/// first time you start the data frame analytics job. The +/// index.number_of_shards and index.number_of_replicas settings for the +/// destination index are copied from the source index. If there are multiple +/// source indices, the destination index copies the highest setting values. The +/// mappings for the destination index are also copied from the source indices. +/// If there are any mapping conflicts, the job fails to start. +/// If the destination index exists, it is used as is. You can therefore set up +/// the destination index in advance with custom settings and mappings. +/// /// public sealed partial class StartDataFrameAnalyticsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StartDataFrameAnalyticsResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StartDataFrameAnalyticsResponse.g.cs index 7a17db9eb46..87442b0d491 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StartDataFrameAnalyticsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StartDataFrameAnalyticsResponse.g.cs @@ -32,7 +32,13 @@ public sealed partial class StartDataFrameAnalyticsResponse : ElasticsearchRespo public bool Acknowledged { get; init; } /// - /// The ID of the node that the job was started on. If the job is allowed to open lazily and has not yet been assigned to a node, this value is an empty string.
The node ID of the node the job has been assigned to, or
an empty string if it hasn't been assigned to a node. In
serverless if the job has been assigned to run then the
node ID will be "serverless". + /// + /// The ID of the node that the job was started on. If the job is allowed to open lazily and has not yet been assigned to a node, this value is an empty string. + /// The node ID of the node the job has been assigned to, or + /// an empty string if it hasn't been assigned to a node. In + /// serverless if the job has been assigned to run then the + /// node ID will be "serverless". + /// /// [JsonInclude, JsonPropertyName("node")] public string Node { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StartDatafeedRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StartDatafeedRequest.g.cs index d1a3c53ec69..a46cd5c746f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StartDatafeedRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StartDatafeedRequest.g.cs @@ -34,11 +34,25 @@ public sealed partial class StartDatafeedRequestParameters : RequestParameters } /// -/// Starts one or more datafeeds. -/// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. -/// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. -/// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.
If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. -/// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or
update it had at the time of creation or update and runs the query using those same roles. If you provided secondary
authorization headers when you created or updated the datafeed, those credentials are used instead. +/// +/// Starts one or more datafeeds. +/// +/// +/// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped +/// multiple times throughout its lifecycle. +/// +/// +/// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. +/// +/// +/// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped. +/// If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. +/// +/// +/// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or +/// update it had at the time of creation or update and runs the query using those same roles. If you provided secondary +/// authorization headers when you created or updated the datafeed, those credentials are used instead. +/// /// public sealed partial class StartDatafeedRequest : PlainRequest { @@ -55,30 +69,50 @@ public StartDatafeedRequest(Elastic.Clients.Elasticsearch.Serverless.Id datafeed internal override string OperationName => "ml.start_datafeed"; /// - /// Refer to the description for the `end` query parameter. + /// + /// Refer to the description for the end query parameter. + /// /// [JsonInclude, JsonPropertyName("end")] public DateTimeOffset? End { get; set; } /// - /// Refer to the description for the `start` query parameter. + /// + /// Refer to the description for the start query parameter. + /// /// [JsonInclude, JsonPropertyName("start")] public DateTimeOffset? Start { get; set; } /// - /// Refer to the description for the `timeout` query parameter. + /// + /// Refer to the description for the timeout query parameter. + /// /// [JsonInclude, JsonPropertyName("timeout")] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get; set; } } /// -/// Starts one or more datafeeds. -/// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. -/// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. -/// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.
If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. -/// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or
update it had at the time of creation or update and runs the query using those same roles. If you provided secondary
authorization headers when you created or updated the datafeed, those credentials are used instead. +/// +/// Starts one or more datafeeds. +/// +/// +/// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped +/// multiple times throughout its lifecycle. +/// +/// +/// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. +/// +/// +/// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped. +/// If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. +/// +/// +/// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or +/// update it had at the time of creation or update and runs the query using those same roles. If you provided secondary +/// authorization headers when you created or updated the datafeed, those credentials are used instead. +/// /// public sealed partial class StartDatafeedRequestDescriptor : RequestDescriptor { @@ -107,7 +141,9 @@ public StartDatafeedRequestDescriptor DatafeedId(Elastic.Clients.Elasticsearch.S private Elastic.Clients.Elasticsearch.Serverless.Duration? TimeoutValue { get; set; } /// - /// Refer to the description for the `end` query parameter. + /// + /// Refer to the description for the end query parameter. + /// /// public StartDatafeedRequestDescriptor End(DateTimeOffset? end) { @@ -116,7 +152,9 @@ public StartDatafeedRequestDescriptor End(DateTimeOffset? end) } /// - /// Refer to the description for the `start` query parameter. + /// + /// Refer to the description for the start query parameter. + /// /// public StartDatafeedRequestDescriptor Start(DateTimeOffset? start) { @@ -125,7 +163,9 @@ public StartDatafeedRequestDescriptor Start(DateTimeOffset? start) } /// - /// Refer to the description for the `timeout` query parameter. + /// + /// Refer to the description for the timeout query parameter. + /// /// public StartDatafeedRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Serverless.Duration? timeout) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StartDatafeedResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StartDatafeedResponse.g.cs index b5c2223b839..032255be81e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StartDatafeedResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StartDatafeedResponse.g.cs @@ -29,14 +29,19 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class StartDatafeedResponse : ElasticsearchResponse { /// - /// The ID of the node that the job was started on. In serverless this will be the "serverless".
If the job is allowed to open lazily and has not yet been assigned to a node, this value is an empty string. + /// + /// The ID of the node that the job was started on. In serverless this will be the "serverless". + /// If the job is allowed to open lazily and has not yet been assigned to a node, this value is an empty string. + /// /// [JsonInclude, JsonPropertyName("node")] [SingleOrManyCollectionConverter(typeof(string))] public IReadOnlyCollection Node { get; init; } /// - /// For a successful response, this value is always `true`. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("started")] public bool Started { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StartTrainedModelDeploymentRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StartTrainedModelDeploymentRequest.g.cs index 39ace65e17a..35099a02839 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StartTrainedModelDeploymentRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StartTrainedModelDeploymentRequest.g.cs @@ -32,43 +32,71 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class StartTrainedModelDeploymentRequestParameters : RequestParameters { /// - /// The inference cache size (in memory outside the JVM heap) per node for the model.
The default value is the same size as the `model_size_bytes`. To disable the cache,
`0b` can be provided. + /// + /// The inference cache size (in memory outside the JVM heap) per node for the model. + /// The default value is the same size as the model_size_bytes. To disable the cache, + /// 0b can be provided. + /// /// public Elastic.Clients.Elasticsearch.Serverless.ByteSize? CacheSize { get => Q("cache_size"); set => Q("cache_size", value); } /// - /// The number of model allocations on each node where the model is deployed.
All allocations on a node share the same copy of the model in memory but use
a separate set of threads to evaluate the model.
Increasing this value generally increases the throughput.
If this setting is greater than the number of hardware threads
it will automatically be changed to a value less than the number of hardware threads. + /// + /// The number of model allocations on each node where the model is deployed. + /// All allocations on a node share the same copy of the model in memory but use + /// a separate set of threads to evaluate the model. + /// Increasing this value generally increases the throughput. + /// If this setting is greater than the number of hardware threads + /// it will automatically be changed to a value less than the number of hardware threads. + /// /// public int? NumberOfAllocations { get => Q("number_of_allocations"); set => Q("number_of_allocations", value); } /// - /// The deployment priority. + /// + /// The deployment priority. + /// /// public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainingPriority? Priority { get => Q("priority"); set => Q("priority", value); } /// - /// Specifies the number of inference requests that are allowed in the queue. After the number of requests exceeds
this value, new requests are rejected with a 429 error. + /// + /// Specifies the number of inference requests that are allowed in the queue. After the number of requests exceeds + /// this value, new requests are rejected with a 429 error. + /// /// public int? QueueCapacity { get => Q("queue_capacity"); set => Q("queue_capacity", value); } /// - /// Sets the number of threads used by each model allocation during inference. This generally increases
the inference speed. The inference process is a compute-bound process; any number
greater than the number of available hardware threads on the machine does not increase the
inference speed. If this setting is greater than the number of hardware threads
it will automatically be changed to a value less than the number of hardware threads. + /// + /// Sets the number of threads used by each model allocation during inference. This generally increases + /// the inference speed. The inference process is a compute-bound process; any number + /// greater than the number of available hardware threads on the machine does not increase the + /// inference speed. If this setting is greater than the number of hardware threads + /// it will automatically be changed to a value less than the number of hardware threads. + /// /// public int? ThreadsPerAllocation { get => Q("threads_per_allocation"); set => Q("threads_per_allocation", value); } /// - /// Specifies the amount of time to wait for the model to deploy. + /// + /// Specifies the amount of time to wait for the model to deploy. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Specifies the allocation status to wait for before returning. + /// + /// Specifies the allocation status to wait for before returning. + /// /// public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DeploymentAllocationState? WaitFor { get => Q("wait_for"); set => Q("wait_for", value); } } /// -/// Starts a trained model deployment, which allocates the model to every machine learning node. +/// +/// Starts a trained model deployment, which allocates the model to every machine learning node. +/// /// public sealed partial class StartTrainedModelDeploymentRequest : PlainRequest { @@ -85,50 +113,78 @@ public StartTrainedModelDeploymentRequest(Elastic.Clients.Elasticsearch.Serverle internal override string OperationName => "ml.start_trained_model_deployment"; /// - /// The inference cache size (in memory outside the JVM heap) per node for the model.
The default value is the same size as the `model_size_bytes`. To disable the cache,
`0b` can be provided. + /// + /// The inference cache size (in memory outside the JVM heap) per node for the model. + /// The default value is the same size as the model_size_bytes. To disable the cache, + /// 0b can be provided. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? CacheSize { get => Q("cache_size"); set => Q("cache_size", value); } /// - /// The number of model allocations on each node where the model is deployed.
All allocations on a node share the same copy of the model in memory but use
a separate set of threads to evaluate the model.
Increasing this value generally increases the throughput.
If this setting is greater than the number of hardware threads
it will automatically be changed to a value less than the number of hardware threads. + /// + /// The number of model allocations on each node where the model is deployed. + /// All allocations on a node share the same copy of the model in memory but use + /// a separate set of threads to evaluate the model. + /// Increasing this value generally increases the throughput. + /// If this setting is greater than the number of hardware threads + /// it will automatically be changed to a value less than the number of hardware threads. + /// /// [JsonIgnore] public int? NumberOfAllocations { get => Q("number_of_allocations"); set => Q("number_of_allocations", value); } /// - /// The deployment priority. + /// + /// The deployment priority. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainingPriority? Priority { get => Q("priority"); set => Q("priority", value); } /// - /// Specifies the number of inference requests that are allowed in the queue. After the number of requests exceeds
this value, new requests are rejected with a 429 error. + /// + /// Specifies the number of inference requests that are allowed in the queue. After the number of requests exceeds + /// this value, new requests are rejected with a 429 error. + /// /// [JsonIgnore] public int? QueueCapacity { get => Q("queue_capacity"); set => Q("queue_capacity", value); } /// - /// Sets the number of threads used by each model allocation during inference. This generally increases
the inference speed. The inference process is a compute-bound process; any number
greater than the number of available hardware threads on the machine does not increase the
inference speed. If this setting is greater than the number of hardware threads
it will automatically be changed to a value less than the number of hardware threads. + /// + /// Sets the number of threads used by each model allocation during inference. This generally increases + /// the inference speed. The inference process is a compute-bound process; any number + /// greater than the number of available hardware threads on the machine does not increase the + /// inference speed. If this setting is greater than the number of hardware threads + /// it will automatically be changed to a value less than the number of hardware threads. + /// /// [JsonIgnore] public int? ThreadsPerAllocation { get => Q("threads_per_allocation"); set => Q("threads_per_allocation", value); } /// - /// Specifies the amount of time to wait for the model to deploy. + /// + /// Specifies the amount of time to wait for the model to deploy. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Specifies the allocation status to wait for before returning. + /// + /// Specifies the allocation status to wait for before returning. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DeploymentAllocationState? WaitFor { get => Q("wait_for"); set => Q("wait_for", value); } } /// -/// Starts a trained model deployment, which allocates the model to every machine learning node. +/// +/// Starts a trained model deployment, which allocates the model to every machine learning node. +/// /// public sealed partial class StartTrainedModelDeploymentRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StopDataFrameAnalyticsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StopDataFrameAnalyticsRequest.g.cs index 99848b36ca0..632355c339d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StopDataFrameAnalyticsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StopDataFrameAnalyticsRequest.g.cs @@ -32,25 +32,58 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class StopDataFrameAnalyticsRequestParameters : RequestParameters { /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no data frame analytics
jobs that match.
2. Contains the _all string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// The default value is true, which returns an empty data_frame_analytics
array when there are no matches and the subset of results when there are
partial matches. If this parameter is false, the request returns a 404
status code when there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no data frame analytics + /// jobs that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// The default value is true, which returns an empty data_frame_analytics + /// array when there are no matches and the subset of results when there are + /// partial matches. If this parameter is false, the request returns a 404 + /// status code when there are no matches or only partial matches. + /// /// public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// If true, the data frame analytics job is stopped forcefully. + /// + /// If true, the data frame analytics job is stopped forcefully. + /// /// public bool? Force { get => Q("force"); set => Q("force", value); } /// - /// Controls the amount of time to wait until the data frame analytics job
stops. Defaults to 20 seconds. + /// + /// Controls the amount of time to wait until the data frame analytics job + /// stops. Defaults to 20 seconds. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Stops one or more data frame analytics jobs.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle. +/// +/// Stops one or more data frame analytics jobs. +/// A data frame analytics job can be started and stopped multiple times +/// throughout its lifecycle. +/// /// public sealed partial class StopDataFrameAnalyticsRequest : PlainRequest { @@ -67,28 +100,61 @@ public StopDataFrameAnalyticsRequest(Elastic.Clients.Elasticsearch.Serverless.Id internal override string OperationName => "ml.stop_data_frame_analytics"; /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no data frame analytics
jobs that match.
2. Contains the _all string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// The default value is true, which returns an empty data_frame_analytics
array when there are no matches and the subset of results when there are
partial matches. If this parameter is false, the request returns a 404
status code when there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no data frame analytics + /// jobs that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// The default value is true, which returns an empty data_frame_analytics + /// array when there are no matches and the subset of results when there are + /// partial matches. If this parameter is false, the request returns a 404 + /// status code when there are no matches or only partial matches. + /// /// [JsonIgnore] public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// If true, the data frame analytics job is stopped forcefully. + /// + /// If true, the data frame analytics job is stopped forcefully. + /// /// [JsonIgnore] public bool? Force { get => Q("force"); set => Q("force", value); } /// - /// Controls the amount of time to wait until the data frame analytics job
stops. Defaults to 20 seconds. + /// + /// Controls the amount of time to wait until the data frame analytics job + /// stops. Defaults to 20 seconds. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Stops one or more data frame analytics jobs.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle. +/// +/// Stops one or more data frame analytics jobs. +/// A data frame analytics job can be started and stopped multiple times +/// throughout its lifecycle. +/// /// public sealed partial class StopDataFrameAnalyticsRequestDescriptor : RequestDescriptor, StopDataFrameAnalyticsRequestParameters> { @@ -122,7 +188,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Stops one or more data frame analytics jobs.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle. +/// +/// Stops one or more data frame analytics jobs. +/// A data frame analytics job can be started and stopped multiple times +/// throughout its lifecycle. +/// /// public sealed partial class StopDataFrameAnalyticsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StopDatafeedRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StopDatafeedRequest.g.cs index 65ba8ed10d9..ca4de1da2da 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StopDatafeedRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StopDatafeedRequest.g.cs @@ -34,7 +34,11 @@ public sealed partial class StopDatafeedRequestParameters : RequestParameters } /// -/// Stops one or more datafeeds.
A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. +/// +/// Stops one or more datafeeds. +/// A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped +/// multiple times throughout its lifecycle. +/// /// public sealed partial class StopDatafeedRequest : PlainRequest { @@ -51,26 +55,36 @@ public StopDatafeedRequest(Elastic.Clients.Elasticsearch.Serverless.Id datafeedI internal override string OperationName => "ml.stop_datafeed"; /// - /// Refer to the description for the `allow_no_match` query parameter. + /// + /// Refer to the description for the allow_no_match query parameter. + /// /// [JsonInclude, JsonPropertyName("allow_no_match")] public bool? AllowNoMatch { get; set; } /// - /// Refer to the description for the `force` query parameter. + /// + /// Refer to the description for the force query parameter. + /// /// [JsonInclude, JsonPropertyName("force")] public bool? Force { get; set; } /// - /// Refer to the description for the `timeout` query parameter. + /// + /// Refer to the description for the timeout query parameter. + /// /// [JsonInclude, JsonPropertyName("timeout")] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get; set; } } /// -/// Stops one or more datafeeds.
A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. +/// +/// Stops one or more datafeeds. +/// A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped +/// multiple times throughout its lifecycle. +/// /// public sealed partial class StopDatafeedRequestDescriptor : RequestDescriptor { @@ -99,7 +113,9 @@ public StopDatafeedRequestDescriptor DatafeedId(Elastic.Clients.Elasticsearch.Se private Elastic.Clients.Elasticsearch.Serverless.Duration? TimeoutValue { get; set; } /// - /// Refer to the description for the `allow_no_match` query parameter. + /// + /// Refer to the description for the allow_no_match query parameter. + /// /// public StopDatafeedRequestDescriptor AllowNoMatch(bool? allowNoMatch = true) { @@ -108,7 +124,9 @@ public StopDatafeedRequestDescriptor AllowNoMatch(bool? allowNoMatch = true) } /// - /// Refer to the description for the `force` query parameter. + /// + /// Refer to the description for the force query parameter. + /// /// public StopDatafeedRequestDescriptor Force(bool? force = true) { @@ -117,7 +135,9 @@ public StopDatafeedRequestDescriptor Force(bool? force = true) } /// - /// Refer to the description for the `timeout` query parameter. + /// + /// Refer to the description for the timeout query parameter. + /// /// public StopDatafeedRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Serverless.Duration? timeout) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StopTrainedModelDeploymentRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StopTrainedModelDeploymentRequest.g.cs index 0235ac43401..0a1c5c27cbe 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StopTrainedModelDeploymentRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/StopTrainedModelDeploymentRequest.g.cs @@ -32,18 +32,28 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class StopTrainedModelDeploymentRequestParameters : RequestParameters { /// - /// Specifies what to do when the request: contains wildcard expressions and there are no deployments that match;
contains the `_all` string or no identifiers and there are no matches; or contains wildcard expressions and
there are only partial matches. By default, it returns an empty array when there are no matches and the subset of results when there are partial matches.
If `false`, the request returns a 404 status code when there are no matches or only partial matches. + /// + /// Specifies what to do when the request: contains wildcard expressions and there are no deployments that match; + /// contains the _all string or no identifiers and there are no matches; or contains wildcard expressions and + /// there are only partial matches. By default, it returns an empty array when there are no matches and the subset of results when there are partial matches. + /// If false, the request returns a 404 status code when there are no matches or only partial matches. + /// /// public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Forcefully stops the deployment, even if it is used by ingest pipelines. You can't use these pipelines until you
restart the model deployment. + /// + /// Forcefully stops the deployment, even if it is used by ingest pipelines. You can't use these pipelines until you + /// restart the model deployment. + /// /// public bool? Force { get => Q("force"); set => Q("force", value); } } /// -/// Stops a trained model deployment. +/// +/// Stops a trained model deployment. +/// /// public sealed partial class StopTrainedModelDeploymentRequest : PlainRequest { @@ -60,20 +70,30 @@ public StopTrainedModelDeploymentRequest(Elastic.Clients.Elasticsearch.Serverles internal override string OperationName => "ml.stop_trained_model_deployment"; /// - /// Specifies what to do when the request: contains wildcard expressions and there are no deployments that match;
contains the `_all` string or no identifiers and there are no matches; or contains wildcard expressions and
there are only partial matches. By default, it returns an empty array when there are no matches and the subset of results when there are partial matches.
If `false`, the request returns a 404 status code when there are no matches or only partial matches. + /// + /// Specifies what to do when the request: contains wildcard expressions and there are no deployments that match; + /// contains the _all string or no identifiers and there are no matches; or contains wildcard expressions and + /// there are only partial matches. By default, it returns an empty array when there are no matches and the subset of results when there are partial matches. + /// If false, the request returns a 404 status code when there are no matches or only partial matches. + /// /// [JsonIgnore] public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Forcefully stops the deployment, even if it is used by ingest pipelines. You can't use these pipelines until you
restart the model deployment. + /// + /// Forcefully stops the deployment, even if it is used by ingest pipelines. You can't use these pipelines until you + /// restart the model deployment. + /// /// [JsonIgnore] public bool? Force { get => Q("force"); set => Q("force", value); } } /// -/// Stops a trained model deployment. +/// +/// Stops a trained model deployment. +/// /// public sealed partial class StopTrainedModelDeploymentRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpdateDataFrameAnalyticsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpdateDataFrameAnalyticsRequest.g.cs index a3e9d39fbfb..02e531e59b7 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpdateDataFrameAnalyticsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpdateDataFrameAnalyticsRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class UpdateDataFrameAnalyticsRequestParameters : RequestP } /// -/// Updates an existing data frame analytics job. +/// +/// Updates an existing data frame analytics job. +/// /// public sealed partial class UpdateDataFrameAnalyticsRequest : PlainRequest { @@ -51,32 +53,50 @@ public UpdateDataFrameAnalyticsRequest(Elastic.Clients.Elasticsearch.Serverless. internal override string OperationName => "ml.update_data_frame_analytics"; /// - /// Specifies whether this job can start when there is insufficient machine
learning node capacity for it to be immediately assigned to a node. + /// + /// Specifies whether this job can start when there is insufficient machine + /// learning node capacity for it to be immediately assigned to a node. + /// /// [JsonInclude, JsonPropertyName("allow_lazy_start")] public bool? AllowLazyStart { get; set; } /// - /// A description of the job. + /// + /// A description of the job. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The maximum number of threads to be used by the analysis. Using more
threads may decrease the time necessary to complete the analysis at the
cost of using more CPU. Note that the process may use additional threads
for operational functionality other than the analysis itself. + /// + /// The maximum number of threads to be used by the analysis. Using more + /// threads may decrease the time necessary to complete the analysis at the + /// cost of using more CPU. Note that the process may use additional threads + /// for operational functionality other than the analysis itself. + /// /// [JsonInclude, JsonPropertyName("max_num_threads")] public int? MaxNumThreads { get; set; } /// - /// The approximate maximum amount of memory resources that are permitted for
analytical processing. If your `elasticsearch.yml` file contains an
`xpack.ml.max_model_memory_limit` setting, an error occurs when you try
to create data frame analytics jobs that have `model_memory_limit` values
greater than that setting. + /// + /// The approximate maximum amount of memory resources that are permitted for + /// analytical processing. If your elasticsearch.yml file contains an + /// xpack.ml.max_model_memory_limit setting, an error occurs when you try + /// to create data frame analytics jobs that have model_memory_limit values + /// greater than that setting. + /// /// [JsonInclude, JsonPropertyName("model_memory_limit")] public string? ModelMemoryLimit { get; set; } } /// -/// Updates an existing data frame analytics job. +/// +/// Updates an existing data frame analytics job. +/// /// public sealed partial class UpdateDataFrameAnalyticsRequestDescriptor : RequestDescriptor, UpdateDataFrameAnalyticsRequestParameters> { @@ -106,7 +126,10 @@ public UpdateDataFrameAnalyticsRequestDescriptor Id(Elastic.Clients.E private string? ModelMemoryLimitValue { get; set; } /// - /// Specifies whether this job can start when there is insufficient machine
learning node capacity for it to be immediately assigned to a node. + /// + /// Specifies whether this job can start when there is insufficient machine + /// learning node capacity for it to be immediately assigned to a node. + /// /// public UpdateDataFrameAnalyticsRequestDescriptor AllowLazyStart(bool? allowLazyStart = true) { @@ -115,7 +138,9 @@ public UpdateDataFrameAnalyticsRequestDescriptor AllowLazyStart(bool? } /// - /// A description of the job. + /// + /// A description of the job. + /// /// public UpdateDataFrameAnalyticsRequestDescriptor Description(string? description) { @@ -124,7 +149,12 @@ public UpdateDataFrameAnalyticsRequestDescriptor Description(string? } /// - /// The maximum number of threads to be used by the analysis. Using more
threads may decrease the time necessary to complete the analysis at the
cost of using more CPU. Note that the process may use additional threads
for operational functionality other than the analysis itself. + /// + /// The maximum number of threads to be used by the analysis. Using more + /// threads may decrease the time necessary to complete the analysis at the + /// cost of using more CPU. Note that the process may use additional threads + /// for operational functionality other than the analysis itself. + /// /// public UpdateDataFrameAnalyticsRequestDescriptor MaxNumThreads(int? maxNumThreads) { @@ -133,7 +163,13 @@ public UpdateDataFrameAnalyticsRequestDescriptor MaxNumThreads(int? m } /// - /// The approximate maximum amount of memory resources that are permitted for
analytical processing. If your `elasticsearch.yml` file contains an
`xpack.ml.max_model_memory_limit` setting, an error occurs when you try
to create data frame analytics jobs that have `model_memory_limit` values
greater than that setting. + /// + /// The approximate maximum amount of memory resources that are permitted for + /// analytical processing. If your elasticsearch.yml file contains an + /// xpack.ml.max_model_memory_limit setting, an error occurs when you try + /// to create data frame analytics jobs that have model_memory_limit values + /// greater than that setting. + /// /// public UpdateDataFrameAnalyticsRequestDescriptor ModelMemoryLimit(string? modelMemoryLimit) { @@ -173,7 +209,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Updates an existing data frame analytics job. +/// +/// Updates an existing data frame analytics job. +/// /// public sealed partial class UpdateDataFrameAnalyticsRequestDescriptor : RequestDescriptor { @@ -203,7 +241,10 @@ public UpdateDataFrameAnalyticsRequestDescriptor Id(Elastic.Clients.Elasticsearc private string? ModelMemoryLimitValue { get; set; } /// - /// Specifies whether this job can start when there is insufficient machine
learning node capacity for it to be immediately assigned to a node. + /// + /// Specifies whether this job can start when there is insufficient machine + /// learning node capacity for it to be immediately assigned to a node. + /// /// public UpdateDataFrameAnalyticsRequestDescriptor AllowLazyStart(bool? allowLazyStart = true) { @@ -212,7 +253,9 @@ public UpdateDataFrameAnalyticsRequestDescriptor AllowLazyStart(bool? allowLazyS } /// - /// A description of the job. + /// + /// A description of the job. + /// /// public UpdateDataFrameAnalyticsRequestDescriptor Description(string? description) { @@ -221,7 +264,12 @@ public UpdateDataFrameAnalyticsRequestDescriptor Description(string? description } /// - /// The maximum number of threads to be used by the analysis. Using more
threads may decrease the time necessary to complete the analysis at the
cost of using more CPU. Note that the process may use additional threads
for operational functionality other than the analysis itself. + /// + /// The maximum number of threads to be used by the analysis. Using more + /// threads may decrease the time necessary to complete the analysis at the + /// cost of using more CPU. Note that the process may use additional threads + /// for operational functionality other than the analysis itself. + /// /// public UpdateDataFrameAnalyticsRequestDescriptor MaxNumThreads(int? maxNumThreads) { @@ -230,7 +278,13 @@ public UpdateDataFrameAnalyticsRequestDescriptor MaxNumThreads(int? maxNumThread } /// - /// The approximate maximum amount of memory resources that are permitted for
analytical processing. If your `elasticsearch.yml` file contains an
`xpack.ml.max_model_memory_limit` setting, an error occurs when you try
to create data frame analytics jobs that have `model_memory_limit` values
greater than that setting. + /// + /// The approximate maximum amount of memory resources that are permitted for + /// analytical processing. If your elasticsearch.yml file contains an + /// xpack.ml.max_model_memory_limit setting, an error occurs when you try + /// to create data frame analytics jobs that have model_memory_limit values + /// greater than that setting. + /// /// public UpdateDataFrameAnalyticsRequestDescriptor ModelMemoryLimit(string? modelMemoryLimit) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpdateDatafeedRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpdateDatafeedRequest.g.cs index d6e4c153e7e..08939820568 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpdateDatafeedRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpdateDatafeedRequest.g.cs @@ -32,18 +32,52 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class UpdateDatafeedRequestParameters : RequestParameters { /// - /// If `true`, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the
`_all` string or when no indices are specified. + /// + /// If true, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the + /// _all string or when no indices are specified. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams. Supports comma-separated values. Valid values are: - /// * `all`: Match any data stream or index, including hidden ones.
* `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
* `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or both.
* `none`: Wildcard patterns are not accepted.
* `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. + /// + /// Type of index that wildcard patterns can match. If the request can target data streams, this argument determines + /// whether wildcard expressions match hidden data streams. Supports comma-separated values. Valid values are: + /// + /// + /// + /// + /// all: Match any data stream or index, including hidden ones. + /// + /// + /// + /// + /// closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. + /// + /// + /// + /// + /// hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. + /// + /// + /// + /// + /// none: Wildcard patterns are not accepted. + /// + /// + /// + /// + /// open: Match open, non-hidden indices. Also matches any non-hidden data stream. + /// + /// + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, unavailable indices (missing or closed) are ignored. + /// + /// If true, unavailable indices (missing or closed) are ignored. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } } @@ -229,7 +263,13 @@ public override void Write(Utf8JsonWriter writer, UpdateDatafeedRequest value, J } /// -/// Updates the properties of a datafeed.
You must stop and start the datafeed for the changes to be applied.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at
the time of the update and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead. +/// +/// Updates the properties of a datafeed. +/// You must stop and start the datafeed for the changes to be applied. +/// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at +/// the time of the update and runs the query using those same roles. If you provide secondary authorization headers, +/// those credentials are used instead. +/// /// [JsonConverter(typeof(UpdateDatafeedRequestConverter))] public sealed partial class UpdateDatafeedRequest : PlainRequest @@ -251,56 +291,114 @@ public UpdateDatafeedRequest() internal override string OperationName => "ml.update_datafeed"; /// - /// If `true`, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the
`_all` string or when no indices are specified. + /// + /// If true, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the + /// _all string or when no indices are specified. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams. Supports comma-separated values. Valid values are: - /// * `all`: Match any data stream or index, including hidden ones.
* `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
* `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or both.
* `none`: Wildcard patterns are not accepted.
* `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. + /// + /// Type of index that wildcard patterns can match. If the request can target data streams, this argument determines + /// whether wildcard expressions match hidden data streams. Supports comma-separated values. Valid values are: + /// + /// + /// + /// + /// all: Match any data stream or index, including hidden ones. + /// + /// + /// + /// + /// closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. + /// + /// + /// + /// + /// hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. + /// + /// + /// + /// + /// none: Wildcard patterns are not accepted. + /// + /// + /// + /// + /// open: Match open, non-hidden indices. Also matches any non-hidden data stream. + /// + /// + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, unavailable indices (missing or closed) are ignored. + /// + /// If true, unavailable indices (missing or closed) are ignored. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only
with low cardinality data. + /// + /// If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only + /// with low cardinality data. + /// /// [JsonInclude, JsonPropertyName("aggregations")] public IDictionary? Aggregations { get; set; } /// - /// Datafeeds might search over long time periods, for several months or years. This search is split into time
chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of
these time chunks are calculated; it is an advanced configuration option. + /// + /// Datafeeds might search over long time periods, for several months or years. This search is split into time + /// chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of + /// these time chunks are calculated; it is an advanced configuration option. + /// /// [JsonInclude, JsonPropertyName("chunking_config")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ChunkingConfig? ChunkingConfig { get; set; } /// - /// Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally
search over indices that have already been read in an effort to determine whether any data has subsequently been
added to the index. If missing data is found, it is a good indication that the `query_delay` is set too low and
the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time
datafeeds. + /// + /// Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally + /// search over indices that have already been read in an effort to determine whether any data has subsequently been + /// added to the index. If missing data is found, it is a good indication that the query_delay is set too low and + /// the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time + /// datafeeds. + /// /// [JsonInclude, JsonPropertyName("delayed_data_check_config")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DelayedDataCheckConfig? DelayedDataCheckConfig { get; set; } /// - /// The interval at which scheduled queries are made while the datafeed runs in real time. The default value is
either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket
span. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are
written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value
must be divisible by the interval of the date histogram aggregation. + /// + /// The interval at which scheduled queries are made while the datafeed runs in real time. The default value is + /// either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket + /// span. When frequency is shorter than the bucket span, interim results for the last (partial) bucket are + /// written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value + /// must be divisible by the interval of the date histogram aggregation. + /// /// [JsonInclude, JsonPropertyName("frequency")] public Elastic.Clients.Elasticsearch.Serverless.Duration? Frequency { get; set; } /// - /// An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine
learning nodes must have the `remote_cluster_client` role. + /// + /// An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine + /// learning nodes must have the remote_cluster_client role. + /// /// [JsonInclude, JsonPropertyName("indices")] public ICollection? Indices { get; set; } /// - /// Specifies index expansion options that are used during search. + /// + /// Specifies index expansion options that are used during search. + /// /// [JsonInclude, JsonPropertyName("indices_options")] public Elastic.Clients.Elasticsearch.Serverless.IndicesOptions? IndicesOptions { get; set; } @@ -308,44 +406,76 @@ public UpdateDatafeedRequest() public Elastic.Clients.Elasticsearch.Serverless.Id? JobId { get; set; } /// - /// If a real-time datafeed has never seen any data (including during any initial training period), it automatically
stops and closes the associated job after this many real-time searches return no documents. In other words,
it stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no
end time that sees no data remains started until it is explicitly stopped. By default, it is not set. + /// + /// If a real-time datafeed has never seen any data (including during any initial training period), it automatically + /// stops and closes the associated job after this many real-time searches return no documents. In other words, + /// it stops after frequency times max_empty_searches of real-time operation. If not set, a datafeed with no + /// end time that sees no data remains started until it is explicitly stopped. By default, it is not set. + /// /// [JsonInclude, JsonPropertyName("max_empty_searches")] public int? MaxEmptySearches { get; set; } /// - /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an
Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this
object is passed verbatim to Elasticsearch. Note that if you change the query, the analyzed data is also
changed. Therefore, the time required to learn might be long and the understandability of the results is
unpredictable. If you want to make significant changes to the source data, it is recommended that you
clone the job and datafeed and make the amendments in the clone. Let both run in parallel and close one
when you are satisfied with the results of the job. + /// + /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an + /// Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this + /// object is passed verbatim to Elasticsearch. Note that if you change the query, the analyzed data is also + /// changed. Therefore, the time required to learn might be long and the understandability of the results is + /// unpredictable. If you want to make significant changes to the source data, it is recommended that you + /// clone the job and datafeed and make the amendments in the clone. Let both run in parallel and close one + /// when you are satisfied with the results of the job. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? Query { get; set; } /// - /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might
not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default
value is randomly selected between `60s` and `120s`. This randomness improves the query performance
when there are multiple jobs running on the same node. + /// + /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might + /// not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default + /// value is randomly selected between 60s and 120s. This randomness improves the query performance + /// when there are multiple jobs running on the same node. + /// /// [JsonInclude, JsonPropertyName("query_delay")] public Elastic.Clients.Elasticsearch.Serverless.Duration? QueryDelay { get; set; } /// - /// Specifies runtime fields for the datafeed search. + /// + /// Specifies runtime fields for the datafeed search. + /// /// [JsonInclude, JsonPropertyName("runtime_mappings")] public IDictionary? RuntimeMappings { get; set; } /// - /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed.
The detector configuration objects in a job can contain functions that use these script fields. + /// + /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. + /// The detector configuration objects in a job can contain functions that use these script fields. + /// /// [JsonInclude, JsonPropertyName("script_fields")] public IDictionary? ScriptFields { get; set; } /// - /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations.
The maximum value is the value of `index.max_result_window`. + /// + /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. + /// The maximum value is the value of index.max_result_window. + /// /// [JsonInclude, JsonPropertyName("scroll_size")] public int? ScrollSize { get; set; } } /// -/// Updates the properties of a datafeed.
You must stop and start the datafeed for the changes to be applied.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at
the time of the update and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead. +/// +/// Updates the properties of a datafeed. +/// You must stop and start the datafeed for the changes to be applied. +/// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at +/// the time of the update and runs the query using those same roles. If you provide secondary authorization headers, +/// those credentials are used instead. +/// /// public sealed partial class UpdateDatafeedRequestDescriptor : RequestDescriptor, UpdateDatafeedRequestParameters> { @@ -396,7 +526,10 @@ public UpdateDatafeedRequestDescriptor DatafeedId(Elastic.Clients.Ela private int? ScrollSizeValue { get; set; } /// - /// If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only
with low cardinality data. + /// + /// If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only + /// with low cardinality data. + /// /// public UpdateDatafeedRequestDescriptor Aggregations(Func>, FluentDescriptorDictionary>> selector) { @@ -405,7 +538,11 @@ public UpdateDatafeedRequestDescriptor Aggregations(Func - /// Datafeeds might search over long time periods, for several months or years. This search is split into time
chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of
these time chunks are calculated; it is an advanced configuration option. + /// + /// Datafeeds might search over long time periods, for several months or years. This search is split into time + /// chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of + /// these time chunks are calculated; it is an advanced configuration option. + /// /// public UpdateDatafeedRequestDescriptor ChunkingConfig(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ChunkingConfig? chunkingConfig) { @@ -432,7 +569,13 @@ public UpdateDatafeedRequestDescriptor ChunkingConfig(Action - /// Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally
search over indices that have already been read in an effort to determine whether any data has subsequently been
added to the index. If missing data is found, it is a good indication that the `query_delay` is set too low and
the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time
datafeeds. + /// + /// Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally + /// search over indices that have already been read in an effort to determine whether any data has subsequently been + /// added to the index. If missing data is found, it is a good indication that the query_delay is set too low and + /// the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time + /// datafeeds. + /// /// public UpdateDatafeedRequestDescriptor DelayedDataCheckConfig(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DelayedDataCheckConfig? delayedDataCheckConfig) { @@ -459,7 +602,13 @@ public UpdateDatafeedRequestDescriptor DelayedDataCheckConfig(Action< } /// - /// The interval at which scheduled queries are made while the datafeed runs in real time. The default value is
either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket
span. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are
written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value
must be divisible by the interval of the date histogram aggregation. + /// + /// The interval at which scheduled queries are made while the datafeed runs in real time. The default value is + /// either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket + /// span. When frequency is shorter than the bucket span, interim results for the last (partial) bucket are + /// written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value + /// must be divisible by the interval of the date histogram aggregation. + /// /// public UpdateDatafeedRequestDescriptor Frequency(Elastic.Clients.Elasticsearch.Serverless.Duration? frequency) { @@ -468,7 +617,10 @@ public UpdateDatafeedRequestDescriptor Frequency(Elastic.Clients.Elas } /// - /// An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine
learning nodes must have the `remote_cluster_client` role. + /// + /// An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine + /// learning nodes must have the remote_cluster_client role. + /// /// public UpdateDatafeedRequestDescriptor Indices(ICollection? indices) { @@ -477,7 +629,9 @@ public UpdateDatafeedRequestDescriptor Indices(ICollection? i } /// - /// Specifies index expansion options that are used during search. + /// + /// Specifies index expansion options that are used during search. + /// /// public UpdateDatafeedRequestDescriptor IndicesOptions(Elastic.Clients.Elasticsearch.Serverless.IndicesOptions? indicesOptions) { @@ -510,7 +664,12 @@ public UpdateDatafeedRequestDescriptor JobId(Elastic.Clients.Elastics } /// - /// If a real-time datafeed has never seen any data (including during any initial training period), it automatically
stops and closes the associated job after this many real-time searches return no documents. In other words,
it stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no
end time that sees no data remains started until it is explicitly stopped. By default, it is not set. + /// + /// If a real-time datafeed has never seen any data (including during any initial training period), it automatically + /// stops and closes the associated job after this many real-time searches return no documents. In other words, + /// it stops after frequency times max_empty_searches of real-time operation. If not set, a datafeed with no + /// end time that sees no data remains started until it is explicitly stopped. By default, it is not set. + /// /// public UpdateDatafeedRequestDescriptor MaxEmptySearches(int? maxEmptySearches) { @@ -519,7 +678,15 @@ public UpdateDatafeedRequestDescriptor MaxEmptySearches(int? maxEmpty } /// - /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an
Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this
object is passed verbatim to Elasticsearch. Note that if you change the query, the analyzed data is also
changed. Therefore, the time required to learn might be long and the understandability of the results is
unpredictable. If you want to make significant changes to the source data, it is recommended that you
clone the job and datafeed and make the amendments in the clone. Let both run in parallel and close one
when you are satisfied with the results of the job. + /// + /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an + /// Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this + /// object is passed verbatim to Elasticsearch. Note that if you change the query, the analyzed data is also + /// changed. Therefore, the time required to learn might be long and the understandability of the results is + /// unpredictable. If you want to make significant changes to the source data, it is recommended that you + /// clone the job and datafeed and make the amendments in the clone. Let both run in parallel and close one + /// when you are satisfied with the results of the job. + /// /// public UpdateDatafeedRequestDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -546,7 +713,12 @@ public UpdateDatafeedRequestDescriptor Query(Action - /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might
not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default
value is randomly selected between `60s` and `120s`. This randomness improves the query performance
when there are multiple jobs running on the same node. + /// + /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might + /// not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default + /// value is randomly selected between 60s and 120s. This randomness improves the query performance + /// when there are multiple jobs running on the same node. + /// /// public UpdateDatafeedRequestDescriptor QueryDelay(Elastic.Clients.Elasticsearch.Serverless.Duration? queryDelay) { @@ -555,7 +727,9 @@ public UpdateDatafeedRequestDescriptor QueryDelay(Elastic.Clients.Ela } /// - /// Specifies runtime fields for the datafeed search. + /// + /// Specifies runtime fields for the datafeed search. + /// /// public UpdateDatafeedRequestDescriptor RuntimeMappings(Func>, FluentDescriptorDictionary>> selector) { @@ -564,7 +738,10 @@ public UpdateDatafeedRequestDescriptor RuntimeMappings(Func - /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed.
The detector configuration objects in a job can contain functions that use these script fields. + /// + /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. + /// The detector configuration objects in a job can contain functions that use these script fields. + /// /// public UpdateDatafeedRequestDescriptor ScriptFields(Func, FluentDescriptorDictionary> selector) { @@ -573,7 +750,10 @@ public UpdateDatafeedRequestDescriptor ScriptFields(Func - /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations.
The maximum value is the value of `index.max_result_window`. + /// + /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. + /// The maximum value is the value of index.max_result_window. + /// /// public UpdateDatafeedRequestDescriptor ScrollSize(int? scrollSize) { @@ -707,7 +887,13 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Updates the properties of a datafeed.
You must stop and start the datafeed for the changes to be applied.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at
the time of the update and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead. +/// +/// Updates the properties of a datafeed. +/// You must stop and start the datafeed for the changes to be applied. +/// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at +/// the time of the update and runs the query using those same roles. If you provide secondary authorization headers, +/// those credentials are used instead. +/// /// public sealed partial class UpdateDatafeedRequestDescriptor : RequestDescriptor { @@ -758,7 +944,10 @@ public UpdateDatafeedRequestDescriptor DatafeedId(Elastic.Clients.Elasticsearch. private int? ScrollSizeValue { get; set; } /// - /// If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only
with low cardinality data. + /// + /// If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only + /// with low cardinality data. + /// /// public UpdateDatafeedRequestDescriptor Aggregations(Func, FluentDescriptorDictionary> selector) { @@ -767,7 +956,11 @@ public UpdateDatafeedRequestDescriptor Aggregations(Func - /// Datafeeds might search over long time periods, for several months or years. This search is split into time
chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of
these time chunks are calculated; it is an advanced configuration option. + /// + /// Datafeeds might search over long time periods, for several months or years. This search is split into time + /// chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of + /// these time chunks are calculated; it is an advanced configuration option. + /// /// public UpdateDatafeedRequestDescriptor ChunkingConfig(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ChunkingConfig? chunkingConfig) { @@ -794,7 +987,13 @@ public UpdateDatafeedRequestDescriptor ChunkingConfig(Action - /// Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally
search over indices that have already been read in an effort to determine whether any data has subsequently been
added to the index. If missing data is found, it is a good indication that the `query_delay` is set too low and
the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time
datafeeds. + /// + /// Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally + /// search over indices that have already been read in an effort to determine whether any data has subsequently been + /// added to the index. If missing data is found, it is a good indication that the query_delay is set too low and + /// the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time + /// datafeeds. + /// /// public UpdateDatafeedRequestDescriptor DelayedDataCheckConfig(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DelayedDataCheckConfig? delayedDataCheckConfig) { @@ -821,7 +1020,13 @@ public UpdateDatafeedRequestDescriptor DelayedDataCheckConfig(Action - /// The interval at which scheduled queries are made while the datafeed runs in real time. The default value is
either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket
span. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are
written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value
must be divisible by the interval of the date histogram aggregation. + /// + /// The interval at which scheduled queries are made while the datafeed runs in real time. The default value is + /// either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket + /// span. When frequency is shorter than the bucket span, interim results for the last (partial) bucket are + /// written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value + /// must be divisible by the interval of the date histogram aggregation. + /// /// public UpdateDatafeedRequestDescriptor Frequency(Elastic.Clients.Elasticsearch.Serverless.Duration? frequency) { @@ -830,7 +1035,10 @@ public UpdateDatafeedRequestDescriptor Frequency(Elastic.Clients.Elasticsearch.S } /// - /// An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine
learning nodes must have the `remote_cluster_client` role. + /// + /// An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine + /// learning nodes must have the remote_cluster_client role. + /// /// public UpdateDatafeedRequestDescriptor Indices(ICollection? indices) { @@ -839,7 +1047,9 @@ public UpdateDatafeedRequestDescriptor Indices(ICollection? indices) } /// - /// Specifies index expansion options that are used during search. + /// + /// Specifies index expansion options that are used during search. + /// /// public UpdateDatafeedRequestDescriptor IndicesOptions(Elastic.Clients.Elasticsearch.Serverless.IndicesOptions? indicesOptions) { @@ -872,7 +1082,12 @@ public UpdateDatafeedRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Serve } /// - /// If a real-time datafeed has never seen any data (including during any initial training period), it automatically
stops and closes the associated job after this many real-time searches return no documents. In other words,
it stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no
end time that sees no data remains started until it is explicitly stopped. By default, it is not set. + /// + /// If a real-time datafeed has never seen any data (including during any initial training period), it automatically + /// stops and closes the associated job after this many real-time searches return no documents. In other words, + /// it stops after frequency times max_empty_searches of real-time operation. If not set, a datafeed with no + /// end time that sees no data remains started until it is explicitly stopped. By default, it is not set. + /// /// public UpdateDatafeedRequestDescriptor MaxEmptySearches(int? maxEmptySearches) { @@ -881,7 +1096,15 @@ public UpdateDatafeedRequestDescriptor MaxEmptySearches(int? maxEmptySearches) } /// - /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an
Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this
object is passed verbatim to Elasticsearch. Note that if you change the query, the analyzed data is also
changed. Therefore, the time required to learn might be long and the understandability of the results is
unpredictable. If you want to make significant changes to the source data, it is recommended that you
clone the job and datafeed and make the amendments in the clone. Let both run in parallel and close one
when you are satisfied with the results of the job. + /// + /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an + /// Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this + /// object is passed verbatim to Elasticsearch. Note that if you change the query, the analyzed data is also + /// changed. Therefore, the time required to learn might be long and the understandability of the results is + /// unpredictable. If you want to make significant changes to the source data, it is recommended that you + /// clone the job and datafeed and make the amendments in the clone. Let both run in parallel and close one + /// when you are satisfied with the results of the job. + /// /// public UpdateDatafeedRequestDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -908,7 +1131,12 @@ public UpdateDatafeedRequestDescriptor Query(Action - /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might
not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default
value is randomly selected between `60s` and `120s`. This randomness improves the query performance
when there are multiple jobs running on the same node. + /// + /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might + /// not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default + /// value is randomly selected between 60s and 120s. This randomness improves the query performance + /// when there are multiple jobs running on the same node. + /// /// public UpdateDatafeedRequestDescriptor QueryDelay(Elastic.Clients.Elasticsearch.Serverless.Duration? queryDelay) { @@ -917,7 +1145,9 @@ public UpdateDatafeedRequestDescriptor QueryDelay(Elastic.Clients.Elasticsearch. } /// - /// Specifies runtime fields for the datafeed search. + /// + /// Specifies runtime fields for the datafeed search. + /// /// public UpdateDatafeedRequestDescriptor RuntimeMappings(Func, FluentDescriptorDictionary> selector) { @@ -926,7 +1156,10 @@ public UpdateDatafeedRequestDescriptor RuntimeMappings(Func - /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed.
The detector configuration objects in a job can contain functions that use these script fields. + /// + /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. + /// The detector configuration objects in a job can contain functions that use these script fields. + /// /// public UpdateDatafeedRequestDescriptor ScriptFields(Func, FluentDescriptorDictionary> selector) { @@ -935,7 +1168,10 @@ public UpdateDatafeedRequestDescriptor ScriptFields(Func - /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations.
The maximum value is the value of `index.max_result_window`. + /// + /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. + /// The maximum value is the value of index.max_result_window. + /// /// public UpdateDatafeedRequestDescriptor ScrollSize(int? scrollSize) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpdateFilterRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpdateFilterRequest.g.cs index 1e2b7894840..6b871286309 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpdateFilterRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpdateFilterRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class UpdateFilterRequestParameters : RequestParameters } /// -/// Updates the description of a filter, adds items, or removes items from the list. +/// +/// Updates the description of a filter, adds items, or removes items from the list. +/// /// public sealed partial class UpdateFilterRequest : PlainRequest { @@ -51,26 +53,34 @@ public UpdateFilterRequest(Elastic.Clients.Elasticsearch.Serverless.Id filterId) internal override string OperationName => "ml.update_filter"; /// - /// The items to add to the filter. + /// + /// The items to add to the filter. + /// /// [JsonInclude, JsonPropertyName("add_items")] public ICollection? AddItems { get; set; } /// - /// A description for the filter. + /// + /// A description for the filter. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The items to remove from the filter. + /// + /// The items to remove from the filter. + /// /// [JsonInclude, JsonPropertyName("remove_items")] public ICollection? RemoveItems { get; set; } } /// -/// Updates the description of a filter, adds items, or removes items from the list. +/// +/// Updates the description of a filter, adds items, or removes items from the list. +/// /// public sealed partial class UpdateFilterRequestDescriptor : RequestDescriptor { @@ -99,7 +109,9 @@ public UpdateFilterRequestDescriptor FilterId(Elastic.Clients.Elasticsearch.Serv private ICollection? RemoveItemsValue { get; set; } /// - /// The items to add to the filter. + /// + /// The items to add to the filter. + /// /// public UpdateFilterRequestDescriptor AddItems(ICollection? addItems) { @@ -108,7 +120,9 @@ public UpdateFilterRequestDescriptor AddItems(ICollection? addItems) } /// - /// A description for the filter. + /// + /// A description for the filter. + /// /// public UpdateFilterRequestDescriptor Description(string? description) { @@ -117,7 +131,9 @@ public UpdateFilterRequestDescriptor Description(string? description) } /// - /// The items to remove from the filter. + /// + /// The items to remove from the filter. + /// /// public UpdateFilterRequestDescriptor RemoveItems(ICollection? removeItems) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpdateJobRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpdateJobRequest.g.cs index 112973d07ec..c2e35c9c0d3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpdateJobRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpdateJobRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class UpdateJobRequestParameters : RequestParameters } /// -/// Updates certain properties of an anomaly detection job. +/// +/// Updates certain properties of an anomaly detection job. +/// /// public sealed partial class UpdateJobRequest : PlainRequest { @@ -51,7 +53,17 @@ public UpdateJobRequest(Elastic.Clients.Elasticsearch.Serverless.Id jobId) : bas internal override string OperationName => "ml.update_job"; /// - /// Advanced configuration option. Specifies whether this job can open when
there is insufficient machine learning node capacity for it to be
immediately assigned to a node. If `false` and a machine learning node
with capacity to run the job cannot immediately be found, the open
anomaly detection jobs API returns an error. However, this is also
subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this
option is set to `true`, the open anomaly detection jobs API does not
return an error and the job waits in the opening state until sufficient
machine learning node capacity is available. + /// + /// Advanced configuration option. Specifies whether this job can open when + /// there is insufficient machine learning node capacity for it to be + /// immediately assigned to a node. If false and a machine learning node + /// with capacity to run the job cannot immediately be found, the open + /// anomaly detection jobs API returns an error. However, this is also + /// subject to the cluster-wide xpack.ml.max_lazy_ml_nodes setting. If this + /// option is set to true, the open anomaly detection jobs API does not + /// return an error and the job waits in the opening state until sufficient + /// machine learning node capacity is available. + /// /// [JsonInclude, JsonPropertyName("allow_lazy_open")] public bool? AllowLazyOpen { get; set; } @@ -59,7 +71,18 @@ public UpdateJobRequest(Elastic.Clients.Elasticsearch.Serverless.Id jobId) : bas public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.AnalysisMemoryLimit? AnalysisLimits { get; set; } /// - /// Advanced configuration option. The time between each periodic persistence
of the model.
The default value is a randomized value between 3 to 4 hours, which
avoids all jobs persisting at exactly the same time. The smallest allowed
value is 1 hour.
For very large models (several GB), persistence could take 10-20 minutes,
so do not set the value too low.
If the job is open when you make the update, you must stop the datafeed,
close the job, then reopen the job and restart the datafeed for the
changes to take effect. + /// + /// Advanced configuration option. The time between each periodic persistence + /// of the model. + /// The default value is a randomized value between 3 to 4 hours, which + /// avoids all jobs persisting at exactly the same time. The smallest allowed + /// value is 1 hour. + /// For very large models (several GB), persistence could take 10-20 minutes, + /// so do not set the value too low. + /// If the job is open when you make the update, you must stop the datafeed, + /// close the job, then reopen the job and restart the datafeed for the + /// changes to take effect. + /// /// [JsonInclude, JsonPropertyName("background_persist_interval")] public Elastic.Clients.Elasticsearch.Serverless.Duration? BackgroundPersistInterval { get; set; } @@ -67,31 +90,49 @@ public UpdateJobRequest(Elastic.Clients.Elasticsearch.Serverless.Id jobId) : bas public ICollection? CategorizationFilters { get; set; } /// - /// Advanced configuration option. Contains custom meta data about the job.
For example, it can contain custom URL information as shown in Adding
custom URLs to machine learning results. + /// + /// Advanced configuration option. Contains custom meta data about the job. + /// For example, it can contain custom URL information as shown in Adding + /// custom URLs to machine learning results. + /// /// [JsonInclude, JsonPropertyName("custom_settings")] public IDictionary? CustomSettings { get; set; } /// - /// Advanced configuration option, which affects the automatic removal of old
model snapshots for this job. It specifies a period of time (in days)
after which only the first snapshot per day is retained. This period is
relative to the timestamp of the most recent snapshot for this job. Valid
values range from 0 to `model_snapshot_retention_days`. For jobs created
before version 7.8.0, the default value matches
`model_snapshot_retention_days`. + /// + /// Advanced configuration option, which affects the automatic removal of old + /// model snapshots for this job. It specifies a period of time (in days) + /// after which only the first snapshot per day is retained. This period is + /// relative to the timestamp of the most recent snapshot for this job. Valid + /// values range from 0 to model_snapshot_retention_days. For jobs created + /// before version 7.8.0, the default value matches + /// model_snapshot_retention_days. + /// /// [JsonInclude, JsonPropertyName("daily_model_snapshot_retention_after_days")] public long? DailyModelSnapshotRetentionAfterDays { get; set; } /// - /// A description of the job. + /// + /// A description of the job. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// An array of detector update objects. + /// + /// An array of detector update objects. + /// /// [JsonInclude, JsonPropertyName("detectors")] public ICollection? Detectors { get; set; } /// - /// A list of job groups. A job can belong to no groups or many. + /// + /// A list of job groups. A job can belong to no groups or many. + /// /// [JsonInclude, JsonPropertyName("groups")] public ICollection? Groups { get; set; } @@ -101,32 +142,51 @@ public UpdateJobRequest(Elastic.Clients.Elasticsearch.Serverless.Id jobId) : bas public Elastic.Clients.Elasticsearch.Serverless.Duration? ModelPruneWindow { get; set; } /// - /// Advanced configuration option, which affects the automatic removal of old
model snapshots for this job. It specifies the maximum period of time (in
days) that snapshots are retained. This period is relative to the
timestamp of the most recent snapshot for this job. + /// + /// Advanced configuration option, which affects the automatic removal of old + /// model snapshots for this job. It specifies the maximum period of time (in + /// days) that snapshots are retained. This period is relative to the + /// timestamp of the most recent snapshot for this job. + /// /// [JsonInclude, JsonPropertyName("model_snapshot_retention_days")] public long? ModelSnapshotRetentionDays { get; set; } /// - /// Settings related to how categorization interacts with partition fields. + /// + /// Settings related to how categorization interacts with partition fields. + /// /// [JsonInclude, JsonPropertyName("per_partition_categorization")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.PerPartitionCategorization? PerPartitionCategorization { get; set; } /// - /// Advanced configuration option. The period over which adjustments to the
score are applied, as new data is seen. + /// + /// Advanced configuration option. The period over which adjustments to the + /// score are applied, as new data is seen. + /// /// [JsonInclude, JsonPropertyName("renormalization_window_days")] public long? RenormalizationWindowDays { get; set; } /// - /// Advanced configuration option. The period of time (in days) that results
are retained. Age is calculated relative to the timestamp of the latest
bucket result. If this property has a non-null value, once per day at
00:30 (server time), results that are the specified number of days older
than the latest bucket result are deleted from Elasticsearch. The default
value is null, which means all results are retained. + /// + /// Advanced configuration option. The period of time (in days) that results + /// are retained. Age is calculated relative to the timestamp of the latest + /// bucket result. If this property has a non-null value, once per day at + /// 00:30 (server time), results that are the specified number of days older + /// than the latest bucket result are deleted from Elasticsearch. The default + /// value is null, which means all results are retained. + /// /// [JsonInclude, JsonPropertyName("results_retention_days")] public long? ResultsRetentionDays { get; set; } } /// -/// Updates certain properties of an anomaly detection job. +/// +/// Updates certain properties of an anomaly detection job. +/// /// public sealed partial class UpdateJobRequestDescriptor : RequestDescriptor, UpdateJobRequestParameters> { @@ -176,7 +236,17 @@ public UpdateJobRequestDescriptor JobId(Elastic.Clients.Elasticsearch private long? ResultsRetentionDaysValue { get; set; } /// - /// Advanced configuration option. Specifies whether this job can open when
there is insufficient machine learning node capacity for it to be
immediately assigned to a node. If `false` and a machine learning node
with capacity to run the job cannot immediately be found, the open
anomaly detection jobs API returns an error. However, this is also
subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this
option is set to `true`, the open anomaly detection jobs API does not
return an error and the job waits in the opening state until sufficient
machine learning node capacity is available. + /// + /// Advanced configuration option. Specifies whether this job can open when + /// there is insufficient machine learning node capacity for it to be + /// immediately assigned to a node. If false and a machine learning node + /// with capacity to run the job cannot immediately be found, the open + /// anomaly detection jobs API returns an error. However, this is also + /// subject to the cluster-wide xpack.ml.max_lazy_ml_nodes setting. If this + /// option is set to true, the open anomaly detection jobs API does not + /// return an error and the job waits in the opening state until sufficient + /// machine learning node capacity is available. + /// /// public UpdateJobRequestDescriptor AllowLazyOpen(bool? allowLazyOpen = true) { @@ -209,7 +279,18 @@ public UpdateJobRequestDescriptor AnalysisLimits(Action - /// Advanced configuration option. The time between each periodic persistence
of the model.
The default value is a randomized value between 3 to 4 hours, which
avoids all jobs persisting at exactly the same time. The smallest allowed
value is 1 hour.
For very large models (several GB), persistence could take 10-20 minutes,
so do not set the value too low.
If the job is open when you make the update, you must stop the datafeed,
close the job, then reopen the job and restart the datafeed for the
changes to take effect. + /// + /// Advanced configuration option. The time between each periodic persistence + /// of the model. + /// The default value is a randomized value between 3 to 4 hours, which + /// avoids all jobs persisting at exactly the same time. The smallest allowed + /// value is 1 hour. + /// For very large models (several GB), persistence could take 10-20 minutes, + /// so do not set the value too low. + /// If the job is open when you make the update, you must stop the datafeed, + /// close the job, then reopen the job and restart the datafeed for the + /// changes to take effect. + /// /// public UpdateJobRequestDescriptor BackgroundPersistInterval(Elastic.Clients.Elasticsearch.Serverless.Duration? backgroundPersistInterval) { @@ -224,7 +305,11 @@ public UpdateJobRequestDescriptor CategorizationFilters(ICollection - /// Advanced configuration option. Contains custom meta data about the job.
For example, it can contain custom URL information as shown in Adding
custom URLs to machine learning results. + /// + /// Advanced configuration option. Contains custom meta data about the job. + /// For example, it can contain custom URL information as shown in Adding + /// custom URLs to machine learning results. + /// /// public UpdateJobRequestDescriptor CustomSettings(Func, FluentDictionary> selector) { @@ -233,7 +318,15 @@ public UpdateJobRequestDescriptor CustomSettings(Func - /// Advanced configuration option, which affects the automatic removal of old
model snapshots for this job. It specifies a period of time (in days)
after which only the first snapshot per day is retained. This period is
relative to the timestamp of the most recent snapshot for this job. Valid
values range from 0 to `model_snapshot_retention_days`. For jobs created
before version 7.8.0, the default value matches
`model_snapshot_retention_days`. + /// + /// Advanced configuration option, which affects the automatic removal of old + /// model snapshots for this job. It specifies a period of time (in days) + /// after which only the first snapshot per day is retained. This period is + /// relative to the timestamp of the most recent snapshot for this job. Valid + /// values range from 0 to model_snapshot_retention_days. For jobs created + /// before version 7.8.0, the default value matches + /// model_snapshot_retention_days. + /// /// public UpdateJobRequestDescriptor DailyModelSnapshotRetentionAfterDays(long? dailyModelSnapshotRetentionAfterDays) { @@ -242,7 +335,9 @@ public UpdateJobRequestDescriptor DailyModelSnapshotRetentionAfterDay } /// - /// A description of the job. + /// + /// A description of the job. + /// /// public UpdateJobRequestDescriptor Description(string? description) { @@ -251,7 +346,9 @@ public UpdateJobRequestDescriptor Description(string? description) } /// - /// An array of detector update objects. + /// + /// An array of detector update objects. + /// /// public UpdateJobRequestDescriptor Detectors(ICollection? detectors) { @@ -290,7 +387,9 @@ public UpdateJobRequestDescriptor Detectors(params Action - /// A list of job groups. A job can belong to no groups or many. + /// + /// A list of job groups. A job can belong to no groups or many. + /// /// public UpdateJobRequestDescriptor Groups(ICollection? groups) { @@ -329,7 +428,12 @@ public UpdateJobRequestDescriptor ModelPruneWindow(Elastic.Clients.El } /// - /// Advanced configuration option, which affects the automatic removal of old
model snapshots for this job. It specifies the maximum period of time (in
days) that snapshots are retained. This period is relative to the
timestamp of the most recent snapshot for this job. + /// + /// Advanced configuration option, which affects the automatic removal of old + /// model snapshots for this job. It specifies the maximum period of time (in + /// days) that snapshots are retained. This period is relative to the + /// timestamp of the most recent snapshot for this job. + /// /// public UpdateJobRequestDescriptor ModelSnapshotRetentionDays(long? modelSnapshotRetentionDays) { @@ -338,7 +442,9 @@ public UpdateJobRequestDescriptor ModelSnapshotRetentionDays(long? mo } /// - /// Settings related to how categorization interacts with partition fields. + /// + /// Settings related to how categorization interacts with partition fields. + /// /// public UpdateJobRequestDescriptor PerPartitionCategorization(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.PerPartitionCategorization? perPartitionCategorization) { @@ -365,7 +471,10 @@ public UpdateJobRequestDescriptor PerPartitionCategorization(Action - /// Advanced configuration option. The period over which adjustments to the
score are applied, as new data is seen. + /// + /// Advanced configuration option. The period over which adjustments to the + /// score are applied, as new data is seen. + /// /// public UpdateJobRequestDescriptor RenormalizationWindowDays(long? renormalizationWindowDays) { @@ -374,7 +483,14 @@ public UpdateJobRequestDescriptor RenormalizationWindowDays(long? ren } /// - /// Advanced configuration option. The period of time (in days) that results
are retained. Age is calculated relative to the timestamp of the latest
bucket result. If this property has a non-null value, once per day at
00:30 (server time), results that are the specified number of days older
than the latest bucket result are deleted from Elasticsearch. The default
value is null, which means all results are retained. + /// + /// Advanced configuration option. The period of time (in days) that results + /// are retained. Age is calculated relative to the timestamp of the latest + /// bucket result. If this property has a non-null value, once per day at + /// 00:30 (server time), results that are the specified number of days older + /// than the latest bucket result are deleted from Elasticsearch. The default + /// value is null, which means all results are retained. + /// /// public UpdateJobRequestDescriptor ResultsRetentionDays(long? resultsRetentionDays) { @@ -535,7 +651,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Updates certain properties of an anomaly detection job. +/// +/// Updates certain properties of an anomaly detection job. +/// /// public sealed partial class UpdateJobRequestDescriptor : RequestDescriptor { @@ -585,7 +703,17 @@ public UpdateJobRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Serverless private long? ResultsRetentionDaysValue { get; set; } /// - /// Advanced configuration option. Specifies whether this job can open when
there is insufficient machine learning node capacity for it to be
immediately assigned to a node. If `false` and a machine learning node
with capacity to run the job cannot immediately be found, the open
anomaly detection jobs API returns an error. However, this is also
subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this
option is set to `true`, the open anomaly detection jobs API does not
return an error and the job waits in the opening state until sufficient
machine learning node capacity is available. + /// + /// Advanced configuration option. Specifies whether this job can open when + /// there is insufficient machine learning node capacity for it to be + /// immediately assigned to a node. If false and a machine learning node + /// with capacity to run the job cannot immediately be found, the open + /// anomaly detection jobs API returns an error. However, this is also + /// subject to the cluster-wide xpack.ml.max_lazy_ml_nodes setting. If this + /// option is set to true, the open anomaly detection jobs API does not + /// return an error and the job waits in the opening state until sufficient + /// machine learning node capacity is available. + /// /// public UpdateJobRequestDescriptor AllowLazyOpen(bool? allowLazyOpen = true) { @@ -618,7 +746,18 @@ public UpdateJobRequestDescriptor AnalysisLimits(Action - /// Advanced configuration option. The time between each periodic persistence
of the model.
The default value is a randomized value between 3 to 4 hours, which
avoids all jobs persisting at exactly the same time. The smallest allowed
value is 1 hour.
For very large models (several GB), persistence could take 10-20 minutes,
so do not set the value too low.
If the job is open when you make the update, you must stop the datafeed,
close the job, then reopen the job and restart the datafeed for the
changes to take effect. + /// + /// Advanced configuration option. The time between each periodic persistence + /// of the model. + /// The default value is a randomized value between 3 to 4 hours, which + /// avoids all jobs persisting at exactly the same time. The smallest allowed + /// value is 1 hour. + /// For very large models (several GB), persistence could take 10-20 minutes, + /// so do not set the value too low. + /// If the job is open when you make the update, you must stop the datafeed, + /// close the job, then reopen the job and restart the datafeed for the + /// changes to take effect. + /// /// public UpdateJobRequestDescriptor BackgroundPersistInterval(Elastic.Clients.Elasticsearch.Serverless.Duration? backgroundPersistInterval) { @@ -633,7 +772,11 @@ public UpdateJobRequestDescriptor CategorizationFilters(ICollection? cat } /// - /// Advanced configuration option. Contains custom meta data about the job.
For example, it can contain custom URL information as shown in Adding
custom URLs to machine learning results. + /// + /// Advanced configuration option. Contains custom meta data about the job. + /// For example, it can contain custom URL information as shown in Adding + /// custom URLs to machine learning results. + /// /// public UpdateJobRequestDescriptor CustomSettings(Func, FluentDictionary> selector) { @@ -642,7 +785,15 @@ public UpdateJobRequestDescriptor CustomSettings(Func - /// Advanced configuration option, which affects the automatic removal of old
model snapshots for this job. It specifies a period of time (in days)
after which only the first snapshot per day is retained. This period is
relative to the timestamp of the most recent snapshot for this job. Valid
values range from 0 to `model_snapshot_retention_days`. For jobs created
before version 7.8.0, the default value matches
`model_snapshot_retention_days`. + /// + /// Advanced configuration option, which affects the automatic removal of old + /// model snapshots for this job. It specifies a period of time (in days) + /// after which only the first snapshot per day is retained. This period is + /// relative to the timestamp of the most recent snapshot for this job. Valid + /// values range from 0 to model_snapshot_retention_days. For jobs created + /// before version 7.8.0, the default value matches + /// model_snapshot_retention_days. + /// /// public UpdateJobRequestDescriptor DailyModelSnapshotRetentionAfterDays(long? dailyModelSnapshotRetentionAfterDays) { @@ -651,7 +802,9 @@ public UpdateJobRequestDescriptor DailyModelSnapshotRetentionAfterDays(long? dai } /// - /// A description of the job. + /// + /// A description of the job. + /// /// public UpdateJobRequestDescriptor Description(string? description) { @@ -660,7 +813,9 @@ public UpdateJobRequestDescriptor Description(string? description) } /// - /// An array of detector update objects. + /// + /// An array of detector update objects. + /// /// public UpdateJobRequestDescriptor Detectors(ICollection? detectors) { @@ -699,7 +854,9 @@ public UpdateJobRequestDescriptor Detectors(params Action - /// A list of job groups. A job can belong to no groups or many. + /// + /// A list of job groups. A job can belong to no groups or many. + /// /// public UpdateJobRequestDescriptor Groups(ICollection? groups) { @@ -738,7 +895,12 @@ public UpdateJobRequestDescriptor ModelPruneWindow(Elastic.Clients.Elasticsearch } /// - /// Advanced configuration option, which affects the automatic removal of old
model snapshots for this job. It specifies the maximum period of time (in
days) that snapshots are retained. This period is relative to the
timestamp of the most recent snapshot for this job. + /// + /// Advanced configuration option, which affects the automatic removal of old + /// model snapshots for this job. It specifies the maximum period of time (in + /// days) that snapshots are retained. This period is relative to the + /// timestamp of the most recent snapshot for this job. + /// /// public UpdateJobRequestDescriptor ModelSnapshotRetentionDays(long? modelSnapshotRetentionDays) { @@ -747,7 +909,9 @@ public UpdateJobRequestDescriptor ModelSnapshotRetentionDays(long? modelSnapshot } /// - /// Settings related to how categorization interacts with partition fields. + /// + /// Settings related to how categorization interacts with partition fields. + /// /// public UpdateJobRequestDescriptor PerPartitionCategorization(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.PerPartitionCategorization? perPartitionCategorization) { @@ -774,7 +938,10 @@ public UpdateJobRequestDescriptor PerPartitionCategorization(Action - /// Advanced configuration option. The period over which adjustments to the
score are applied, as new data is seen. + /// + /// Advanced configuration option. The period over which adjustments to the + /// score are applied, as new data is seen. + /// /// public UpdateJobRequestDescriptor RenormalizationWindowDays(long? renormalizationWindowDays) { @@ -783,7 +950,14 @@ public UpdateJobRequestDescriptor RenormalizationWindowDays(long? renormalizatio } /// - /// Advanced configuration option. The period of time (in days) that results
are retained. Age is calculated relative to the timestamp of the latest
bucket result. If this property has a non-null value, once per day at
00:30 (server time), results that are the specified number of days older
than the latest bucket result are deleted from Elasticsearch. The default
value is null, which means all results are retained. + /// + /// Advanced configuration option. The period of time (in days) that results + /// are retained. Age is calculated relative to the timestamp of the latest + /// bucket result. If this property has a non-null value, once per day at + /// 00:30 (server time), results that are the specified number of days older + /// than the latest bucket result are deleted from Elasticsearch. The default + /// value is null, which means all results are retained. + /// /// public UpdateJobRequestDescriptor ResultsRetentionDays(long? resultsRetentionDays) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpdateModelSnapshotRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpdateModelSnapshotRequest.g.cs index ccab0e08031..76aa4b74276 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpdateModelSnapshotRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpdateModelSnapshotRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class UpdateModelSnapshotRequestParameters : RequestParame } /// -/// Updates certain properties of a snapshot. +/// +/// Updates certain properties of a snapshot. +/// /// public sealed partial class UpdateModelSnapshotRequest : PlainRequest { @@ -51,20 +53,28 @@ public UpdateModelSnapshotRequest(Elastic.Clients.Elasticsearch.Serverless.Id jo internal override string OperationName => "ml.update_model_snapshot"; /// - /// A description of the model snapshot. + /// + /// A description of the model snapshot. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// If `true`, this snapshot will not be deleted during automatic cleanup of
snapshots older than `model_snapshot_retention_days`. However, this
snapshot will be deleted when the job is deleted. + /// + /// If true, this snapshot will not be deleted during automatic cleanup of + /// snapshots older than model_snapshot_retention_days. However, this + /// snapshot will be deleted when the job is deleted. + /// /// [JsonInclude, JsonPropertyName("retain")] public bool? Retain { get; set; } } /// -/// Updates certain properties of a snapshot. +/// +/// Updates certain properties of a snapshot. +/// /// public sealed partial class UpdateModelSnapshotRequestDescriptor : RequestDescriptor { @@ -98,7 +108,9 @@ public UpdateModelSnapshotRequestDescriptor SnapshotId(Elastic.Clients.Elasticse private bool? RetainValue { get; set; } /// - /// A description of the model snapshot. + /// + /// A description of the model snapshot. + /// /// public UpdateModelSnapshotRequestDescriptor Description(string? description) { @@ -107,7 +119,11 @@ public UpdateModelSnapshotRequestDescriptor Description(string? description) } /// - /// If `true`, this snapshot will not be deleted during automatic cleanup of
snapshots older than `model_snapshot_retention_days`. However, this
snapshot will be deleted when the job is deleted. + /// + /// If true, this snapshot will not be deleted during automatic cleanup of + /// snapshots older than model_snapshot_retention_days. However, this + /// snapshot will be deleted when the job is deleted. + /// /// public UpdateModelSnapshotRequestDescriptor Retain(bool? retain = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpgradeJobSnapshotRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpgradeJobSnapshotRequest.g.cs index 7fa112ddb84..fa97a7637dc 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpgradeJobSnapshotRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpgradeJobSnapshotRequest.g.cs @@ -32,18 +32,33 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class UpgradeJobSnapshotRequestParameters : RequestParameters { /// - /// Controls the time to wait for the request to complete. + /// + /// Controls the time to wait for the request to complete. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// When true, the API won’t respond until the upgrade is complete.
Otherwise, it responds as soon as the upgrade task is assigned to a node. + /// + /// When true, the API won’t respond until the upgrade is complete. + /// Otherwise, it responds as soon as the upgrade task is assigned to a node. + /// /// public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Upgrades an anomaly detection model snapshot to the latest major version.
Over time, older snapshot formats are deprecated and removed. Anomaly
detection jobs support only snapshots that are from the current or previous
major version.
This API provides a means to upgrade a snapshot to the current major version.
This aids in preparing the cluster for an upgrade to the next major version.
Only one snapshot per anomaly detection job can be upgraded at a time and the
upgraded snapshot cannot be the current snapshot of the anomaly detection
job. +/// +/// Upgrades an anomaly detection model snapshot to the latest major version. +/// Over time, older snapshot formats are deprecated and removed. Anomaly +/// detection jobs support only snapshots that are from the current or previous +/// major version. +/// This API provides a means to upgrade a snapshot to the current major version. +/// This aids in preparing the cluster for an upgrade to the next major version. +/// Only one snapshot per anomaly detection job can be upgraded at a time and the +/// upgraded snapshot cannot be the current snapshot of the anomaly detection +/// job. +/// /// public sealed partial class UpgradeJobSnapshotRequest : PlainRequest { @@ -60,20 +75,35 @@ public UpgradeJobSnapshotRequest(Elastic.Clients.Elasticsearch.Serverless.Id job internal override string OperationName => "ml.upgrade_job_snapshot"; /// - /// Controls the time to wait for the request to complete. + /// + /// Controls the time to wait for the request to complete. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// When true, the API won’t respond until the upgrade is complete.
Otherwise, it responds as soon as the upgrade task is assigned to a node. + /// + /// When true, the API won’t respond until the upgrade is complete. + /// Otherwise, it responds as soon as the upgrade task is assigned to a node. + /// /// [JsonIgnore] public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Upgrades an anomaly detection model snapshot to the latest major version.
Over time, older snapshot formats are deprecated and removed. Anomaly
detection jobs support only snapshots that are from the current or previous
major version.
This API provides a means to upgrade a snapshot to the current major version.
This aids in preparing the cluster for an upgrade to the next major version.
Only one snapshot per anomaly detection job can be upgraded at a time and the
upgraded snapshot cannot be the current snapshot of the anomaly detection
job. +/// +/// Upgrades an anomaly detection model snapshot to the latest major version. +/// Over time, older snapshot formats are deprecated and removed. Anomaly +/// detection jobs support only snapshots that are from the current or previous +/// major version. +/// This API provides a means to upgrade a snapshot to the current major version. +/// This aids in preparing the cluster for an upgrade to the next major version. +/// Only one snapshot per anomaly detection job can be upgraded at a time and the +/// upgraded snapshot cannot be the current snapshot of the anomaly detection +/// job. +/// /// public sealed partial class UpgradeJobSnapshotRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpgradeJobSnapshotResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpgradeJobSnapshotResponse.g.cs index 8bdade8e7e2..0b0d55c900d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpgradeJobSnapshotResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpgradeJobSnapshotResponse.g.cs @@ -29,13 +29,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class UpgradeJobSnapshotResponse : ElasticsearchResponse { /// - /// When true, this means the task is complete. When false, it is still running. + /// + /// When true, this means the task is complete. When false, it is still running. + /// /// [JsonInclude, JsonPropertyName("completed")] public bool Completed { get; init; } /// - /// The ID of the node that the upgrade task was started on if it is still running. In serverless this will be the "serverless". + /// + /// The ID of the node that the upgrade task was started on if it is still running. In serverless this will be the "serverless". + /// /// [JsonInclude, JsonPropertyName("node")] public string Node { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ValidateDetectorRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ValidateDetectorRequest.g.cs index 7b25c48799c..0d71e337459 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ValidateDetectorRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ValidateDetectorRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class ValidateDetectorRequestParameters : RequestParameter } /// -/// Validates an anomaly detection detector. +/// +/// Validates an anomaly detection detector. +/// /// public sealed partial class ValidateDetectorRequest : PlainRequest, ISelfSerializable { @@ -56,7 +58,9 @@ void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions op } /// -/// Validates an anomaly detection detector. +/// +/// Validates an anomaly detection detector. +/// /// public sealed partial class ValidateDetectorRequestDescriptor : RequestDescriptor, ValidateDetectorRequestParameters> { @@ -106,7 +110,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Validates an anomaly detection detector. +/// +/// Validates an anomaly detection detector. +/// /// public sealed partial class ValidateDetectorRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ValidateDetectorResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ValidateDetectorResponse.g.cs index 5778b842494..9b25cee80ac 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ValidateDetectorResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ValidateDetectorResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class ValidateDetectorResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ValidateRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ValidateRequest.g.cs index 7eaa61c0f57..da1ea34eb21 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ValidateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ValidateRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class ValidateRequestParameters : RequestParameters } /// -/// Validates an anomaly detection job. +/// +/// Validates an anomaly detection job. +/// /// public sealed partial class ValidateRequest : PlainRequest { @@ -67,7 +69,9 @@ public sealed partial class ValidateRequest : PlainRequest -/// Validates an anomaly detection job. +/// +/// Validates an anomaly detection job. +/// /// public sealed partial class ValidateRequestDescriptor : RequestDescriptor, ValidateRequestParameters> { @@ -331,7 +335,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Validates an anomaly detection job. +/// +/// Validates an anomaly detection job. +/// /// public sealed partial class ValidateRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ValidateResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ValidateResponse.g.cs index 68cfeb3a832..338fd739327 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ValidateResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ValidateResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class ValidateResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiGetRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiGetRequest.g.cs index ee955d35e9e..1ce6fadcc65 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiGetRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiGetRequest.g.cs @@ -32,48 +32,69 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class MultiGetRequestParameters : RequestParameters { /// - /// Specifies the node or shard the operation should be performed on. Random by default. + /// + /// Specifies the node or shard the operation should be performed on. Random by default. + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If `true`, the request is real-time as opposed to near-real-time. + /// + /// If true, the request is real-time as opposed to near-real-time. + /// /// public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } /// - /// If `true`, the request refreshes relevant shards before retrieving documents. + /// + /// If true, the request refreshes relevant shards before retrieving documents. + /// /// public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// True or false to return the `_source` field or not, or a list of fields to return. + /// + /// True or false to return the _source field or not, or a list of fields to return. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfigParam? Source { get => Q("_source"); set => Q("_source", value); } /// - /// A comma-separated list of source fields to exclude from the response.
You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. + /// + /// A comma-separated list of source fields to exclude from the response. + /// You can also use this parameter to exclude fields from the subset specified in _source_includes query parameter. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response.
If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter.
If the `_source` parameter is `false`, this parameter is ignored. + /// + /// A comma-separated list of source fields to include in the response. + /// If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the _source_excludes query parameter. + /// If the _source parameter is false, this parameter is ignored. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// If `true`, retrieves the document fields stored in the index rather than the document `_source`. + /// + /// If true, retrieves the document fields stored in the index rather than the document _source. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? StoredFields { get => Q("stored_fields"); set => Q("stored_fields", value); } } /// -/// Allows to get multiple documents in one request. +/// +/// Allows to get multiple documents in one request. +/// /// public sealed partial class MultiGetRequest : PlainRequest { @@ -94,68 +115,93 @@ public MultiGetRequest(Elastic.Clients.Elasticsearch.Serverless.IndexName? index internal override string OperationName => "mget"; /// - /// Specifies the node or shard the operation should be performed on. Random by default. + /// + /// Specifies the node or shard the operation should be performed on. Random by default. + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If `true`, the request is real-time as opposed to near-real-time. + /// + /// If true, the request is real-time as opposed to near-real-time. + /// /// [JsonIgnore] public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } /// - /// If `true`, the request refreshes relevant shards before retrieving documents. + /// + /// If true, the request refreshes relevant shards before retrieving documents. + /// /// [JsonIgnore] public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// True or false to return the `_source` field or not, or a list of fields to return. + /// + /// True or false to return the _source field or not, or a list of fields to return. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfigParam? Source { get => Q("_source"); set => Q("_source", value); } /// - /// A comma-separated list of source fields to exclude from the response.
You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. + /// + /// A comma-separated list of source fields to exclude from the response. + /// You can also use this parameter to exclude fields from the subset specified in _source_includes query parameter. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response.
If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter.
If the `_source` parameter is `false`, this parameter is ignored. + /// + /// A comma-separated list of source fields to include in the response. + /// If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the _source_excludes query parameter. + /// If the _source parameter is false, this parameter is ignored. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// If `true`, retrieves the document fields stored in the index rather than the document `_source`. + /// + /// If true, retrieves the document fields stored in the index rather than the document _source. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? StoredFields { get => Q("stored_fields"); set => Q("stored_fields", value); } /// - /// The documents you want to retrieve. Required if no index is specified in the request URI. + /// + /// The documents you want to retrieve. Required if no index is specified in the request URI. + /// /// [JsonInclude, JsonPropertyName("docs")] public ICollection? Docs { get; set; } /// - /// The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI. + /// + /// The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI. + /// /// [JsonInclude, JsonPropertyName("ids")] public Elastic.Clients.Elasticsearch.Serverless.Ids? Ids { get; set; } } /// -/// Allows to get multiple documents in one request. +/// +/// Allows to get multiple documents in one request. +/// /// public sealed partial class MultiGetRequestDescriptor : RequestDescriptor, MultiGetRequestParameters> { @@ -199,7 +245,9 @@ public MultiGetRequestDescriptor Index(Elastic.Clients.Elasticsearch. private Elastic.Clients.Elasticsearch.Serverless.Ids? IdsValue { get; set; } /// - /// The documents you want to retrieve. Required if no index is specified in the request URI. + /// + /// The documents you want to retrieve. Required if no index is specified in the request URI. + /// /// public MultiGetRequestDescriptor Docs(ICollection? docs) { @@ -238,7 +286,9 @@ public MultiGetRequestDescriptor Docs(params Action - /// The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI. + /// + /// The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI. + /// /// public MultiGetRequestDescriptor Ids(Elastic.Clients.Elasticsearch.Serverless.Ids? ids) { @@ -291,7 +341,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Allows to get multiple documents in one request. +/// +/// Allows to get multiple documents in one request. +/// /// public sealed partial class MultiGetRequestDescriptor : RequestDescriptor { @@ -335,7 +387,9 @@ public MultiGetRequestDescriptor Index(Elastic.Clients.Elasticsearch.Serverless. private Elastic.Clients.Elasticsearch.Serverless.Ids? IdsValue { get; set; } /// - /// The documents you want to retrieve. Required if no index is specified in the request URI. + /// + /// The documents you want to retrieve. Required if no index is specified in the request URI. + /// /// public MultiGetRequestDescriptor Docs(ICollection? docs) { @@ -374,7 +428,9 @@ public MultiGetRequestDescriptor Docs(params Action - /// The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI. + /// + /// The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI. + /// /// public MultiGetRequestDescriptor Ids(Elastic.Clients.Elasticsearch.Serverless.Ids? ids) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiSearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiSearchRequest.g.cs index 429eeb794e0..cacee94a167 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiSearchRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiSearchRequest.g.cs @@ -34,68 +34,94 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class MultiSearchRequestParameters : RequestParameters { /// - /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. + /// + /// If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. + /// /// public bool? CcsMinimizeRoundtrips { get => Q("ccs_minimize_roundtrips"); set => Q("ccs_minimize_roundtrips", value); } /// - /// Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// + /// Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If true, concrete, expanded or aliased indices are ignored when frozen. + /// + /// If true, concrete, expanded or aliased indices are ignored when frozen. + /// /// public bool? IgnoreThrottled { get => Q("ignore_throttled"); set => Q("ignore_throttled", value); } /// - /// If true, missing or closed indices are not included in the response. + /// + /// If true, missing or closed indices are not included in the response. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Maximum number of concurrent searches the multi search API can execute. + /// + /// Maximum number of concurrent searches the multi search API can execute. + /// /// public long? MaxConcurrentSearches { get => Q("max_concurrent_searches"); set => Q("max_concurrent_searches", value); } /// - /// Maximum number of concurrent shard requests that each sub-search request executes per node. + /// + /// Maximum number of concurrent shard requests that each sub-search request executes per node. + /// /// public long? MaxConcurrentShardRequests { get => Q("max_concurrent_shard_requests"); set => Q("max_concurrent_shard_requests", value); } /// - /// Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint. + /// + /// Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint. + /// /// public long? PreFilterShardSize { get => Q("pre_filter_shard_size"); set => Q("pre_filter_shard_size", value); } /// - /// If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object. + /// + /// If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object. + /// /// public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } /// - /// Custom routing value used to route search operations to a specific shard. + /// + /// Custom routing value used to route search operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Indicates whether global term and document frequencies should be used when scoring returned documents. + /// + /// Indicates whether global term and document frequencies should be used when scoring returned documents. + /// /// public Elastic.Clients.Elasticsearch.Serverless.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } /// - /// Specifies whether aggregation and suggester names should be prefixed by their respective types in the response. + /// + /// Specifies whether aggregation and suggester names should be prefixed by their respective types in the response. + /// /// public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } } /// -/// Allows to execute several search operations in one request. +/// +/// Allows to execute several search operations in one request. +/// /// public sealed partial class MultiSearchRequest : PlainRequest, IStreamSerializable { @@ -116,73 +142,97 @@ public MultiSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? indi internal override string OperationName => "msearch"; /// - /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. + /// + /// If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. + /// /// [JsonIgnore] public bool? CcsMinimizeRoundtrips { get => Q("ccs_minimize_roundtrips"); set => Q("ccs_minimize_roundtrips", value); } /// - /// Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// + /// Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If true, concrete, expanded or aliased indices are ignored when frozen. + /// + /// If true, concrete, expanded or aliased indices are ignored when frozen. + /// /// [JsonIgnore] public bool? IgnoreThrottled { get => Q("ignore_throttled"); set => Q("ignore_throttled", value); } /// - /// If true, missing or closed indices are not included in the response. + /// + /// If true, missing or closed indices are not included in the response. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Maximum number of concurrent searches the multi search API can execute. + /// + /// Maximum number of concurrent searches the multi search API can execute. + /// /// [JsonIgnore] public long? MaxConcurrentSearches { get => Q("max_concurrent_searches"); set => Q("max_concurrent_searches", value); } /// - /// Maximum number of concurrent shard requests that each sub-search request executes per node. + /// + /// Maximum number of concurrent shard requests that each sub-search request executes per node. + /// /// [JsonIgnore] public long? MaxConcurrentShardRequests { get => Q("max_concurrent_shard_requests"); set => Q("max_concurrent_shard_requests", value); } /// - /// Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint. + /// + /// Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint. + /// /// [JsonIgnore] public long? PreFilterShardSize { get => Q("pre_filter_shard_size"); set => Q("pre_filter_shard_size", value); } /// - /// If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object. + /// + /// If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object. + /// /// [JsonIgnore] public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } /// - /// Custom routing value used to route search operations to a specific shard. + /// + /// Custom routing value used to route search operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Indicates whether global term and document frequencies should be used when scoring returned documents. + /// + /// Indicates whether global term and document frequencies should be used when scoring returned documents. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } /// - /// Specifies whether aggregation and suggester names should be prefixed by their respective types in the response. + /// + /// Specifies whether aggregation and suggester names should be prefixed by their respective types in the response. + /// /// [JsonIgnore] public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } @@ -212,7 +262,9 @@ async Task IStreamSerializable.SerializeAsync(Stream stream, IElasticsearchClien } /// -/// Allows to execute several search operations in one request. +/// +/// Allows to execute several search operations in one request. +/// /// public sealed partial class MultiSearchRequestDescriptor : RequestDescriptor, MultiSearchRequestParameters>, IStreamSerializable { @@ -289,7 +341,9 @@ public MultiSearchRequestDescriptor AddSearches(Elastic.Clients.Elast } /// -/// Allows to execute several search operations in one request. +/// +/// Allows to execute several search operations in one request. +/// /// public sealed partial class MultiSearchRequestDescriptor : RequestDescriptor, IStreamSerializable { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiSearchTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiSearchTemplateRequest.g.cs index 58e4cea5a43..b8c319c3d88 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiSearchTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiSearchTemplateRequest.g.cs @@ -34,33 +34,47 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class MultiSearchTemplateRequestParameters : RequestParameters { /// - /// If `true`, network round-trips are minimized for cross-cluster search requests. + /// + /// If true, network round-trips are minimized for cross-cluster search requests. + /// /// public bool? CcsMinimizeRoundtrips { get => Q("ccs_minimize_roundtrips"); set => Q("ccs_minimize_roundtrips", value); } /// - /// Maximum number of concurrent searches the API can run. + /// + /// Maximum number of concurrent searches the API can run. + /// /// public long? MaxConcurrentSearches { get => Q("max_concurrent_searches"); set => Q("max_concurrent_searches", value); } /// - /// If `true`, the response returns `hits.total` as an integer.
If `false`, it returns `hits.total` as an object. + /// + /// If true, the response returns hits.total as an integer. + /// If false, it returns hits.total as an object. + /// /// public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } /// - /// The type of the search operation.
Available options: `query_then_fetch`, `dfs_query_then_fetch`. + /// + /// The type of the search operation. + /// Available options: query_then_fetch, dfs_query_then_fetch. + /// /// public Elastic.Clients.Elasticsearch.Serverless.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } /// - /// If `true`, the response prefixes aggregation and suggester names with their respective types. + /// + /// If true, the response prefixes aggregation and suggester names with their respective types. + /// /// public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } } /// -/// Runs multiple templated searches with a single request. +/// +/// Runs multiple templated searches with a single request. +/// /// public sealed partial class MultiSearchTemplateRequest : PlainRequest, IStreamSerializable { @@ -81,31 +95,43 @@ public MultiSearchTemplateRequest(Elastic.Clients.Elasticsearch.Serverless.Indic internal override string OperationName => "msearch_template"; /// - /// If `true`, network round-trips are minimized for cross-cluster search requests. + /// + /// If true, network round-trips are minimized for cross-cluster search requests. + /// /// [JsonIgnore] public bool? CcsMinimizeRoundtrips { get => Q("ccs_minimize_roundtrips"); set => Q("ccs_minimize_roundtrips", value); } /// - /// Maximum number of concurrent searches the API can run. + /// + /// Maximum number of concurrent searches the API can run. + /// /// [JsonIgnore] public long? MaxConcurrentSearches { get => Q("max_concurrent_searches"); set => Q("max_concurrent_searches", value); } /// - /// If `true`, the response returns `hits.total` as an integer.
If `false`, it returns `hits.total` as an object. + /// + /// If true, the response returns hits.total as an integer. + /// If false, it returns hits.total as an object. + /// /// [JsonIgnore] public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } /// - /// The type of the search operation.
Available options: `query_then_fetch`, `dfs_query_then_fetch`. + /// + /// The type of the search operation. + /// Available options: query_then_fetch, dfs_query_then_fetch. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } /// - /// If `true`, the response prefixes aggregation and suggester names with their respective types. + /// + /// If true, the response prefixes aggregation and suggester names with their respective types. + /// /// [JsonIgnore] public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } @@ -135,7 +161,9 @@ async Task IStreamSerializable.SerializeAsync(Stream stream, IElasticsearchClien } /// -/// Runs multiple templated searches with a single request. +/// +/// Runs multiple templated searches with a single request. +/// /// public sealed partial class MultiSearchTemplateRequestDescriptor : RequestDescriptor, MultiSearchTemplateRequestParameters>, IStreamSerializable { @@ -205,7 +233,9 @@ public MultiSearchTemplateRequestDescriptor AddSearchTemplates(Elasti } /// -/// Runs multiple templated searches with a single request. +/// +/// Runs multiple templated searches with a single request. +/// /// public sealed partial class MultiSearchTemplateRequestDescriptor : RequestDescriptor, IStreamSerializable { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiTermVectorsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiTermVectorsRequest.g.cs index bedde8b16fc..78dae622801 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiTermVectorsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiTermVectorsRequest.g.cs @@ -32,63 +32,89 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class MultiTermVectorsRequestParameters : RequestParameters { /// - /// Comma-separated list or wildcard expressions of fields to include in the statistics.
Used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. + /// + /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// Used as the default list unless a specific field list is provided in the completion_fields or fielddata_fields parameters. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? Fields { get => Q("fields"); set => Q("fields", value); } /// - /// If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + /// + /// If true, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + /// /// public bool? FieldStatistics { get => Q("field_statistics"); set => Q("field_statistics", value); } /// - /// If `true`, the response includes term offsets. + /// + /// If true, the response includes term offsets. + /// /// public bool? Offsets { get => Q("offsets"); set => Q("offsets", value); } /// - /// If `true`, the response includes term payloads. + /// + /// If true, the response includes term payloads. + /// /// public bool? Payloads { get => Q("payloads"); set => Q("payloads", value); } /// - /// If `true`, the response includes term positions. + /// + /// If true, the response includes term positions. + /// /// public bool? Positions { get => Q("positions"); set => Q("positions", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If true, the request is real-time as opposed to near-real-time. + /// + /// If true, the request is real-time as opposed to near-real-time. + /// /// public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// If true, the response includes term frequency and document frequency. + /// + /// If true, the response includes term frequency and document frequency. + /// /// public bool? TermStatistics { get => Q("term_statistics"); set => Q("term_statistics", value); } /// - /// If `true`, returns the document version as part of a hit. + /// + /// If true, returns the document version as part of a hit. + /// /// public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type. + /// + /// Specific version type. + /// /// public Elastic.Clients.Elasticsearch.Serverless.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } } /// -/// Returns multiple termvectors in one request. +/// +/// Returns multiple termvectors in one request. +/// /// public sealed partial class MultiTermVectorsRequest : PlainRequest { @@ -109,86 +135,116 @@ public MultiTermVectorsRequest(Elastic.Clients.Elasticsearch.Serverless.IndexNam internal override string OperationName => "mtermvectors"; /// - /// Comma-separated list or wildcard expressions of fields to include in the statistics.
Used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. + /// + /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// Used as the default list unless a specific field list is provided in the completion_fields or fielddata_fields parameters. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? Fields { get => Q("fields"); set => Q("fields", value); } /// - /// If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + /// + /// If true, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + /// /// [JsonIgnore] public bool? FieldStatistics { get => Q("field_statistics"); set => Q("field_statistics", value); } /// - /// If `true`, the response includes term offsets. + /// + /// If true, the response includes term offsets. + /// /// [JsonIgnore] public bool? Offsets { get => Q("offsets"); set => Q("offsets", value); } /// - /// If `true`, the response includes term payloads. + /// + /// If true, the response includes term payloads. + /// /// [JsonIgnore] public bool? Payloads { get => Q("payloads"); set => Q("payloads", value); } /// - /// If `true`, the response includes term positions. + /// + /// If true, the response includes term positions. + /// /// [JsonIgnore] public bool? Positions { get => Q("positions"); set => Q("positions", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If true, the request is real-time as opposed to near-real-time. + /// + /// If true, the request is real-time as opposed to near-real-time. + /// /// [JsonIgnore] public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// If true, the response includes term frequency and document frequency. + /// + /// If true, the response includes term frequency and document frequency. + /// /// [JsonIgnore] public bool? TermStatistics { get => Q("term_statistics"); set => Q("term_statistics", value); } /// - /// If `true`, returns the document version as part of a hit. + /// + /// If true, returns the document version as part of a hit. + /// /// [JsonIgnore] public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type. + /// + /// Specific version type. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } /// - /// Array of existing or artificial documents. + /// + /// Array of existing or artificial documents. + /// /// [JsonInclude, JsonPropertyName("docs")] public ICollection? Docs { get; set; } /// - /// Simplified syntax to specify documents by their ID if they're in the same index. + /// + /// Simplified syntax to specify documents by their ID if they're in the same index. + /// /// [JsonInclude, JsonPropertyName("ids")] public ICollection? Ids { get; set; } } /// -/// Returns multiple termvectors in one request. +/// +/// Returns multiple termvectors in one request. +/// /// public sealed partial class MultiTermVectorsRequestDescriptor : RequestDescriptor, MultiTermVectorsRequestParameters> { @@ -235,7 +291,9 @@ public MultiTermVectorsRequestDescriptor Index(Elastic.Clients.Elasti private ICollection? IdsValue { get; set; } /// - /// Array of existing or artificial documents. + /// + /// Array of existing or artificial documents. + /// /// public MultiTermVectorsRequestDescriptor Docs(ICollection? docs) { @@ -274,7 +332,9 @@ public MultiTermVectorsRequestDescriptor Docs(params Action - /// Simplified syntax to specify documents by their ID if they're in the same index. + /// + /// Simplified syntax to specify documents by their ID if they're in the same index. + /// /// public MultiTermVectorsRequestDescriptor Ids(ICollection? ids) { @@ -327,7 +387,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns multiple termvectors in one request. +/// +/// Returns multiple termvectors in one request. +/// /// public sealed partial class MultiTermVectorsRequestDescriptor : RequestDescriptor { @@ -374,7 +436,9 @@ public MultiTermVectorsRequestDescriptor Index(Elastic.Clients.Elasticsearch.Ser private ICollection? IdsValue { get; set; } /// - /// Array of existing or artificial documents. + /// + /// Array of existing or artificial documents. + /// /// public MultiTermVectorsRequestDescriptor Docs(ICollection? docs) { @@ -413,7 +477,9 @@ public MultiTermVectorsRequestDescriptor Docs(params Action - /// Simplified syntax to specify documents by their ID if they're in the same index. + /// + /// Simplified syntax to specify documents by their ID if they're in the same index. + /// /// public MultiTermVectorsRequestDescriptor Ids(ICollection? ids) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/HotThreadsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/HotThreadsRequest.g.cs index a392bfc028c..a0e1f4011c6 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/HotThreadsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/HotThreadsRequest.g.cs @@ -32,48 +32,71 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class HotThreadsRequestParameters : RequestParameters { /// - /// If true, known idle threads (e.g. waiting in a socket select, or to get
a task from an empty queue) are filtered out. + /// + /// If true, known idle threads (e.g. waiting in a socket select, or to get + /// a task from an empty queue) are filtered out. + /// /// public bool? IgnoreIdleThreads { get => Q("ignore_idle_threads"); set => Q("ignore_idle_threads", value); } /// - /// The interval to do the second sampling of threads. + /// + /// The interval to do the second sampling of threads. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Interval { get => Q("interval"); set => Q("interval", value); } /// - /// Period to wait for a connection to the master node. If no response
is received before the timeout expires, the request fails and
returns an error. + /// + /// Period to wait for a connection to the master node. If no response + /// is received before the timeout expires, the request fails and + /// returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Number of samples of thread stacktrace. + /// + /// Number of samples of thread stacktrace. + /// /// public long? Snapshots { get => Q("snapshots"); set => Q("snapshots", value); } /// - /// The sort order for 'cpu' type (default: total) + /// + /// The sort order for 'cpu' type (default: total) + /// /// public Elastic.Clients.Elasticsearch.Serverless.ThreadType? Sort { get => Q("sort"); set => Q("sort", value); } /// - /// Specifies the number of hot threads to provide information for. + /// + /// Specifies the number of hot threads to provide information for. + /// /// public long? Threads { get => Q("threads"); set => Q("threads", value); } /// - /// Period to wait for a response. If no response is received
before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received + /// before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The type to sample. + /// + /// The type to sample. + /// /// public Elastic.Clients.Elasticsearch.Serverless.ThreadType? Type { get => Q("type"); set => Q("type", value); } } /// -/// This API yields a breakdown of the hot threads on each selected node in the cluster.
The output is plain text with a breakdown of each node’s top hot threads. +/// +/// This API yields a breakdown of the hot threads on each selected node in the cluster. +/// The output is plain text with a breakdown of each node’s top hot threads. +/// /// public sealed partial class HotThreadsRequest : PlainRequest { @@ -94,56 +117,79 @@ public HotThreadsRequest(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeI internal override string OperationName => "nodes.hot_threads"; /// - /// If true, known idle threads (e.g. waiting in a socket select, or to get
a task from an empty queue) are filtered out. + /// + /// If true, known idle threads (e.g. waiting in a socket select, or to get + /// a task from an empty queue) are filtered out. + /// /// [JsonIgnore] public bool? IgnoreIdleThreads { get => Q("ignore_idle_threads"); set => Q("ignore_idle_threads", value); } /// - /// The interval to do the second sampling of threads. + /// + /// The interval to do the second sampling of threads. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Interval { get => Q("interval"); set => Q("interval", value); } /// - /// Period to wait for a connection to the master node. If no response
is received before the timeout expires, the request fails and
returns an error. + /// + /// Period to wait for a connection to the master node. If no response + /// is received before the timeout expires, the request fails and + /// returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Number of samples of thread stacktrace. + /// + /// Number of samples of thread stacktrace. + /// /// [JsonIgnore] public long? Snapshots { get => Q("snapshots"); set => Q("snapshots", value); } /// - /// The sort order for 'cpu' type (default: total) + /// + /// The sort order for 'cpu' type (default: total) + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.ThreadType? Sort { get => Q("sort"); set => Q("sort", value); } /// - /// Specifies the number of hot threads to provide information for. + /// + /// Specifies the number of hot threads to provide information for. + /// /// [JsonIgnore] public long? Threads { get => Q("threads"); set => Q("threads", value); } /// - /// Period to wait for a response. If no response is received
before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received + /// before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The type to sample. + /// + /// The type to sample. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.ThreadType? Type { get => Q("type"); set => Q("type", value); } } /// -/// This API yields a breakdown of the hot threads on each selected node in the cluster.
The output is plain text with a breakdown of each node’s top hot threads. +/// +/// This API yields a breakdown of the hot threads on each selected node in the cluster. +/// The output is plain text with a breakdown of each node’s top hot threads. +/// /// public sealed partial class HotThreadsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesInfoRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesInfoRequest.g.cs index 5be40417b3f..2d418a9957c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesInfoRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesInfoRequest.g.cs @@ -32,23 +32,31 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class NodesInfoRequestParameters : RequestParameters { /// - /// If true, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Returns cluster nodes information. +/// +/// Returns cluster nodes information. +/// /// public sealed partial class NodesInfoRequest : PlainRequest { @@ -77,26 +85,34 @@ public NodesInfoRequest(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeId internal override string OperationName => "nodes.info"; /// - /// If true, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// [JsonIgnore] public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Returns cluster nodes information. +/// +/// Returns cluster nodes information. +/// /// public sealed partial class NodesInfoRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesInfoResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesInfoResponse.g.cs index 664213a26e6..e4455498428 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesInfoResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesInfoResponse.g.cs @@ -34,7 +34,9 @@ public sealed partial class NodesInfoResponse : ElasticsearchResponse public IReadOnlyDictionary Nodes { get; init; } /// - /// Contains statistics about the number of nodes selected by the request’s node filters. + /// + /// Contains statistics about the number of nodes selected by the request’s node filters. + /// /// [JsonInclude, JsonPropertyName("_nodes")] public Elastic.Clients.Elasticsearch.Serverless.NodeStatistics? NodeStats { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesStatsRequest.g.cs index c3b10797cc1..2eb10229211 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesStatsRequest.g.cs @@ -32,58 +32,80 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class NodesStatsRequestParameters : RequestParameters { /// - /// Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + /// + /// Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? CompletionFields { get => Q("completion_fields"); set => Q("completion_fields", value); } /// - /// Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + /// + /// Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? FielddataFields { get => Q("fielddata_fields"); set => Q("fielddata_fields", value); } /// - /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// + /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? Fields { get => Q("fields"); set => Q("fields", value); } /// - /// Comma-separated list of search groups to include in the search statistics. + /// + /// Comma-separated list of search groups to include in the search statistics. + /// /// public bool? Groups { get => Q("groups"); set => Q("groups", value); } /// - /// If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + /// + /// If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + /// /// public bool? IncludeSegmentFileSizes { get => Q("include_segment_file_sizes"); set => Q("include_segment_file_sizes", value); } /// - /// If `true`, the response includes information from segments that are not loaded into memory. + /// + /// If true, the response includes information from segments that are not loaded into memory. + /// /// public bool? IncludeUnloadedSegments { get => Q("include_unloaded_segments"); set => Q("include_unloaded_segments", value); } /// - /// Indicates whether statistics are aggregated at the cluster, index, or shard level. + /// + /// Indicates whether statistics are aggregated at the cluster, index, or shard level. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Level? Level { get => Q("level"); set => Q("level", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// A comma-separated list of document types for the indexing index metric. + /// + /// A comma-separated list of document types for the indexing index metric. + /// /// public ICollection? Types { get => Q?>("types"); set => Q("types", value); } } /// -/// Returns cluster nodes statistics. +/// +/// Returns cluster nodes statistics. +/// /// public sealed partial class NodesStatsRequest : PlainRequest { @@ -120,68 +142,90 @@ public NodesStatsRequest(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeI internal override string OperationName => "nodes.stats"; /// - /// Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + /// + /// Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? CompletionFields { get => Q("completion_fields"); set => Q("completion_fields", value); } /// - /// Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + /// + /// Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? FielddataFields { get => Q("fielddata_fields"); set => Q("fielddata_fields", value); } /// - /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// + /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? Fields { get => Q("fields"); set => Q("fields", value); } /// - /// Comma-separated list of search groups to include in the search statistics. + /// + /// Comma-separated list of search groups to include in the search statistics. + /// /// [JsonIgnore] public bool? Groups { get => Q("groups"); set => Q("groups", value); } /// - /// If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + /// + /// If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + /// /// [JsonIgnore] public bool? IncludeSegmentFileSizes { get => Q("include_segment_file_sizes"); set => Q("include_segment_file_sizes", value); } /// - /// If `true`, the response includes information from segments that are not loaded into memory. + /// + /// If true, the response includes information from segments that are not loaded into memory. + /// /// [JsonIgnore] public bool? IncludeUnloadedSegments { get => Q("include_unloaded_segments"); set => Q("include_unloaded_segments", value); } /// - /// Indicates whether statistics are aggregated at the cluster, index, or shard level. + /// + /// Indicates whether statistics are aggregated at the cluster, index, or shard level. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Level? Level { get => Q("level"); set => Q("level", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// A comma-separated list of document types for the indexing index metric. + /// + /// A comma-separated list of document types for the indexing index metric. + /// /// [JsonIgnore] public ICollection? Types { get => Q?>("types"); set => Q("types", value); } } /// -/// Returns cluster nodes statistics. +/// +/// Returns cluster nodes statistics. +/// /// public sealed partial class NodesStatsRequestDescriptor : RequestDescriptor, NodesStatsRequestParameters> { @@ -238,7 +282,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns cluster nodes statistics. +/// +/// Returns cluster nodes statistics. +/// /// public sealed partial class NodesStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesStatsResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesStatsResponse.g.cs index 56845d07a1c..c61a304dbc5 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesStatsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesStatsResponse.g.cs @@ -34,7 +34,9 @@ public sealed partial class NodesStatsResponse : ElasticsearchResponse public IReadOnlyDictionary Nodes { get; init; } /// - /// Contains statistics about the number of nodes selected by the request’s node filters. + /// + /// Contains statistics about the number of nodes selected by the request’s node filters. + /// /// [JsonInclude, JsonPropertyName("_nodes")] public Elastic.Clients.Elasticsearch.Serverless.NodeStatistics? NodeStats { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesUsageRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesUsageRequest.g.cs index ddb86ad3215..e655fd43792 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesUsageRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesUsageRequest.g.cs @@ -32,13 +32,18 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class NodesUsageRequestParameters : RequestParameters { /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Returns information on the usage of features. +/// +/// Returns information on the usage of features. +/// /// public sealed partial class NodesUsageRequest : PlainRequest { @@ -67,14 +72,19 @@ public NodesUsageRequest(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeI internal override string OperationName => "nodes.usage"; /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Returns information on the usage of features. +/// +/// Returns information on the usage of features. +/// /// public sealed partial class NodesUsageRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesUsageResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesUsageResponse.g.cs index 9862d4ae212..2b034f606ba 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesUsageResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesUsageResponse.g.cs @@ -34,7 +34,9 @@ public sealed partial class NodesUsageResponse : ElasticsearchResponse public IReadOnlyDictionary Nodes { get; init; } /// - /// Contains statistics about the number of nodes selected by the request’s node filters. + /// + /// Contains statistics about the number of nodes selected by the request’s node filters. + /// /// [JsonInclude, JsonPropertyName("_nodes")] public Elastic.Clients.Elasticsearch.Serverless.NodeStatistics? NodeStats { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/OpenPointInTimeRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/OpenPointInTimeRequest.g.cs index 5d67598c544..856765300ec 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/OpenPointInTimeRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/OpenPointInTimeRequest.g.cs @@ -32,33 +32,53 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class OpenPointInTimeRequestParameters : RequestParameters { /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Extends the time to live of the corresponding point in time. + /// + /// Extends the time to live of the corresponding point in time. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } } /// -/// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. +/// +/// A search request by default executes against the most recent visible data of the target indices, +/// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the +/// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple +/// search requests using the same point in time. For example, if refreshes happen between +/// search_after requests, then the results of those requests might not be consistent as changes happening +/// between searches are only visible to the more recent point in time. +/// /// public sealed partial class OpenPointInTimeRequest : PlainRequest { @@ -75,38 +95,58 @@ public OpenPointInTimeRequest(Elastic.Clients.Elasticsearch.Serverless.Indices i internal override string OperationName => "open_point_in_time"; /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Extends the time to live of the corresponding point in time. + /// + /// Extends the time to live of the corresponding point in time. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } } /// -/// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. +/// +/// A search request by default executes against the most recent visible data of the target indices, +/// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the +/// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple +/// search requests using the same point in time. For example, if refreshes happen between +/// search_after requests, then the results of those requests might not be consistent as changes happening +/// between searches are only visible to the more recent point in time. +/// /// public sealed partial class OpenPointInTimeRequestDescriptor : RequestDescriptor, OpenPointInTimeRequestParameters> { @@ -146,7 +186,14 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. +/// +/// A search request by default executes against the most recent visible data of the target indices, +/// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the +/// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple +/// search requests using the same point in time. For example, if refreshes happen between +/// search_after requests, then the results of those requests might not be consistent as changes happening +/// between searches are only visible to the more recent point in time. +/// /// public sealed partial class OpenPointInTimeRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/PingRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/PingRequest.g.cs index 5465897c65c..33dafd6f976 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/PingRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/PingRequest.g.cs @@ -34,7 +34,10 @@ public sealed partial class PingRequestParameters : RequestParameters } /// -/// Ping the cluster.
Returns whether the cluster is running. +/// +/// Ping the cluster. +/// Returns whether the cluster is running. +/// /// public sealed partial class PingRequest : PlainRequest { @@ -48,7 +51,10 @@ public sealed partial class PingRequest : PlainRequest } /// -/// Ping the cluster.
Returns whether the cluster is running. +/// +/// Ping the cluster. +/// Returns whether the cluster is running. +/// /// public sealed partial class PingRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/PutScriptRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/PutScriptRequest.g.cs index cf6aee4132d..e86f7e88aa1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/PutScriptRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/PutScriptRequest.g.cs @@ -32,18 +32,27 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class PutScriptRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// 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. +/// /// public sealed partial class PutScriptRequest : PlainRequest { @@ -64,26 +73,37 @@ public PutScriptRequest(Elastic.Clients.Elasticsearch.Serverless.Id id, Elastic. internal override string OperationName => "put_script"; /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Contains the script or search template, its parameters, and its language. + /// + /// Contains the script or search template, its parameters, and its language. + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Serverless.StoredScript Script { get; set; } } /// -/// 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. +/// /// public sealed partial class PutScriptRequestDescriptor : RequestDescriptor, PutScriptRequestParameters> { @@ -125,7 +145,9 @@ public PutScriptRequestDescriptor Id(Elastic.Clients.Elasticsearch.Se private Action ScriptDescriptorAction { get; set; } /// - /// Contains the script or search template, its parameters, and its language. + /// + /// Contains the script or search template, its parameters, and its language. + /// /// public PutScriptRequestDescriptor Script(Elastic.Clients.Elasticsearch.Serverless.StoredScript script) { @@ -175,7 +197,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// 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. +/// /// public sealed partial class PutScriptRequestDescriptor : RequestDescriptor { @@ -217,7 +242,9 @@ public PutScriptRequestDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id private Action ScriptDescriptorAction { get; set; } /// - /// Contains the script or search template, its parameters, and its language. + /// + /// Contains the script or search template, its parameters, and its language. + /// /// public PutScriptRequestDescriptor Script(Elastic.Clients.Elasticsearch.Serverless.StoredScript script) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/PutScriptResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/PutScriptResponse.g.cs index c968ddd6e6e..bcbe6d1caf9 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/PutScriptResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/PutScriptResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class PutScriptResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/DeleteRuleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/DeleteRuleRequest.g.cs index 54b45ec3bc6..dd95c7a0111 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/DeleteRuleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/DeleteRuleRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class DeleteRuleRequestParameters : RequestParameters } /// -/// Deletes a query rule within a query ruleset. +/// +/// Deletes a query rule within a query ruleset. +/// /// public sealed partial class DeleteRuleRequest : PlainRequest { @@ -52,7 +54,9 @@ public DeleteRuleRequest(Elastic.Clients.Elasticsearch.Serverless.Id rulesetId, } /// -/// Deletes a query rule within a query ruleset. +/// +/// Deletes a query rule within a query ruleset. +/// /// public sealed partial class DeleteRuleRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/DeleteRuleResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/DeleteRuleResponse.g.cs index 0dfb148a64b..110941115db 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/DeleteRuleResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/DeleteRuleResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryRules; public sealed partial class DeleteRuleResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/DeleteRulesetRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/DeleteRulesetRequest.g.cs index 324be39c977..fbccf927d64 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/DeleteRulesetRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/DeleteRulesetRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class DeleteRulesetRequestParameters : RequestParameters } /// -/// Deletes a query ruleset. +/// +/// Deletes a query ruleset. +/// /// public sealed partial class DeleteRulesetRequest : PlainRequest { @@ -52,7 +54,9 @@ public DeleteRulesetRequest(Elastic.Clients.Elasticsearch.Serverless.Id rulesetI } /// -/// Deletes a query ruleset. +/// +/// Deletes a query ruleset. +/// /// public sealed partial class DeleteRulesetRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/DeleteRulesetResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/DeleteRulesetResponse.g.cs index 4508411c472..84c27bf6567 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/DeleteRulesetResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/DeleteRulesetResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryRules; public sealed partial class DeleteRulesetResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/GetRuleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/GetRuleRequest.g.cs index 94e2620eac7..1800ee95924 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/GetRuleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/GetRuleRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class GetRuleRequestParameters : RequestParameters } /// -/// Returns the details about a query rule within a query ruleset +/// +/// Returns the details about a query rule within a query ruleset +/// /// public sealed partial class GetRuleRequest : PlainRequest { @@ -52,7 +54,9 @@ public GetRuleRequest(Elastic.Clients.Elasticsearch.Serverless.Id rulesetId, Ela } /// -/// Returns the details about a query rule within a query ruleset +/// +/// Returns the details about a query rule within a query ruleset +/// /// public sealed partial class GetRuleRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/GetRulesetRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/GetRulesetRequest.g.cs index 4269db61e68..e7df1907fed 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/GetRulesetRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/GetRulesetRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class GetRulesetRequestParameters : RequestParameters } /// -/// Returns the details about a query ruleset +/// +/// Returns the details about a query ruleset +/// /// public sealed partial class GetRulesetRequest : PlainRequest { @@ -52,7 +54,9 @@ public GetRulesetRequest(Elastic.Clients.Elasticsearch.Serverless.Id rulesetId) } /// -/// Returns the details about a query ruleset +/// +/// Returns the details about a query ruleset +/// /// public sealed partial class GetRulesetRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/GetRulesetResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/GetRulesetResponse.g.cs index 9fb90479f2d..cfe4c74c1dd 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/GetRulesetResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/GetRulesetResponse.g.cs @@ -29,13 +29,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryRules; public sealed partial class GetRulesetResponse : ElasticsearchResponse { /// - /// Rules associated with the query ruleset + /// + /// Rules associated with the query ruleset + /// /// [JsonInclude, JsonPropertyName("rules")] public IReadOnlyCollection Rules { get; init; } /// - /// Query Ruleset unique identifier + /// + /// Query Ruleset unique identifier + /// /// [JsonInclude, JsonPropertyName("ruleset_id")] public string RulesetId { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/ListRulesetsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/ListRulesetsRequest.g.cs index 23d37ac752e..bfac7d7d9c4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/ListRulesetsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/ListRulesetsRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryRules; public sealed partial class ListRulesetsRequestParameters : RequestParameters { /// - /// Starting offset (default: 0) + /// + /// Starting offset (default: 0) + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// specifies a max number of results to get + /// + /// specifies a max number of results to get + /// /// public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Returns summarized information about existing query rulesets. +/// +/// Returns summarized information about existing query rulesets. +/// /// public sealed partial class ListRulesetsRequest : PlainRequest { @@ -56,20 +62,26 @@ public sealed partial class ListRulesetsRequest : PlainRequest "query_rules.list_rulesets"; /// - /// Starting offset (default: 0) + /// + /// Starting offset (default: 0) + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// specifies a max number of results to get + /// + /// specifies a max number of results to get + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Returns summarized information about existing query rulesets. +/// +/// Returns summarized information about existing query rulesets. +/// /// public sealed partial class ListRulesetsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/PutRuleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/PutRuleRequest.g.cs index 17fc1de770c..e8c13c62bdd 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/PutRuleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/PutRuleRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class PutRuleRequestParameters : RequestParameters } /// -/// Creates or updates a query rule within a query ruleset. +/// +/// Creates or updates a query rule within a query ruleset. +/// /// public sealed partial class PutRuleRequest : PlainRequest { @@ -62,7 +64,9 @@ public PutRuleRequest(Elastic.Clients.Elasticsearch.Serverless.Id rulesetId, Ela } /// -/// Creates or updates a query rule within a query ruleset. +/// +/// Creates or updates a query rule within a query ruleset. +/// /// public sealed partial class PutRuleRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/PutRulesetRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/PutRulesetRequest.g.cs index df39b62d120..cd31931ffe0 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/PutRulesetRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/PutRulesetRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class PutRulesetRequestParameters : RequestParameters } /// -/// Creates or updates a query ruleset. +/// +/// Creates or updates a query ruleset. +/// /// public sealed partial class PutRulesetRequest : PlainRequest { @@ -56,7 +58,9 @@ public PutRulesetRequest(Elastic.Clients.Elasticsearch.Serverless.Id rulesetId) } /// -/// Creates or updates a query ruleset. +/// +/// Creates or updates a query ruleset. +/// /// public sealed partial class PutRulesetRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/RankEvalRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/RankEvalRequest.g.cs index ee1f94c4a7a..69ff475374b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/RankEvalRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/RankEvalRequest.g.cs @@ -32,28 +32,38 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class RankEvalRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// + /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, missing or closed indices are not included in the response. + /// + /// If true, missing or closed indices are not included in the response. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Search operation type + /// + /// Search operation type + /// /// public string? SearchType { get => Q("search_type"); set => Q("search_type", value); } } /// -/// Enables you to evaluate the quality of ranked search results over a set of typical search queries. +/// +/// Enables you to evaluate the quality of ranked search results over a set of typical search queries. +/// /// public sealed partial class RankEvalRequest : PlainRequest { @@ -74,44 +84,58 @@ public RankEvalRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? indices internal override string OperationName => "rank_eval"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// + /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, missing or closed indices are not included in the response. + /// + /// If true, missing or closed indices are not included in the response. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Search operation type + /// + /// Search operation type + /// /// [JsonIgnore] public string? SearchType { get => Q("search_type"); set => Q("search_type", value); } /// - /// Definition of the evaluation metric to calculate. + /// + /// Definition of the evaluation metric to calculate. + /// /// [JsonInclude, JsonPropertyName("metric")] public Elastic.Clients.Elasticsearch.Serverless.Core.RankEval.RankEvalMetric? Metric { get; set; } /// - /// A set of typical search requests, together with their provided ratings. + /// + /// A set of typical search requests, together with their provided ratings. + /// /// [JsonInclude, JsonPropertyName("requests")] public ICollection Requests { get; set; } } /// -/// Enables you to evaluate the quality of ranked search results over a set of typical search queries. +/// +/// Enables you to evaluate the quality of ranked search results over a set of typical search queries. +/// /// public sealed partial class RankEvalRequestDescriptor : RequestDescriptor, RankEvalRequestParameters> { @@ -153,7 +177,9 @@ public RankEvalRequestDescriptor Indices(Elastic.Clients.Elasticsearc private Action>[] RequestsDescriptorActions { get; set; } /// - /// Definition of the evaluation metric to calculate. + /// + /// Definition of the evaluation metric to calculate. + /// /// public RankEvalRequestDescriptor Metric(Elastic.Clients.Elasticsearch.Serverless.Core.RankEval.RankEvalMetric? metric) { @@ -180,7 +206,9 @@ public RankEvalRequestDescriptor Metric(Action - /// A set of typical search requests, together with their provided ratings. + /// + /// A set of typical search requests, together with their provided ratings. + /// /// public RankEvalRequestDescriptor Requests(ICollection requests) { @@ -273,7 +301,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Enables you to evaluate the quality of ranked search results over a set of typical search queries. +/// +/// Enables you to evaluate the quality of ranked search results over a set of typical search queries. +/// /// public sealed partial class RankEvalRequestDescriptor : RequestDescriptor { @@ -315,7 +345,9 @@ public RankEvalRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Serverles private Action[] RequestsDescriptorActions { get; set; } /// - /// Definition of the evaluation metric to calculate. + /// + /// Definition of the evaluation metric to calculate. + /// /// public RankEvalRequestDescriptor Metric(Elastic.Clients.Elasticsearch.Serverless.Core.RankEval.RankEvalMetric? metric) { @@ -342,7 +374,9 @@ public RankEvalRequestDescriptor Metric(Action - /// A set of typical search requests, together with their provided ratings. + /// + /// A set of typical search requests, together with their provided ratings. + /// /// public RankEvalRequestDescriptor Requests(ICollection requests) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/RankEvalResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/RankEvalResponse.g.cs index c7ea3961fbc..52a07698d2f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/RankEvalResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/RankEvalResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class RankEvalResponse : ElasticsearchResponse { /// - /// The details section contains one entry for every query in the original requests section, keyed by the search request id + /// + /// The details section contains one entry for every query in the original requests section, keyed by the search request id + /// /// [JsonInclude, JsonPropertyName("details")] public IReadOnlyDictionary Details { get; init; } @@ -37,7 +39,9 @@ public sealed partial class RankEvalResponse : ElasticsearchResponse public IReadOnlyDictionary Failures { get; init; } /// - /// The overall evaluation quality calculated by the defined metric + /// + /// The overall evaluation quality calculated by the defined metric + /// /// [JsonInclude, JsonPropertyName("metric_score")] public double MetricScore { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ReindexRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ReindexRequest.g.cs index 5c118907a77..95d2c0f1980 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ReindexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ReindexRequest.g.cs @@ -32,48 +32,70 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class ReindexRequestParameters : RequestParameters { /// - /// If `true`, the request refreshes affected shards to make this operation visible to search. + /// + /// If true, the request refreshes affected shards to make this operation visible to search. + /// /// public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// The throttle for this request in sub-requests per second.
Defaults to no throttle. + /// + /// The throttle for this request in sub-requests per second. + /// Defaults to no throttle. + /// /// public float? RequestsPerSecond { get => Q("requests_per_second"); set => Q("requests_per_second", value); } /// - /// If `true`, the destination must be an index alias. + /// + /// If true, the destination must be an index alias. + /// /// public bool? RequireAlias { get => Q("require_alias"); set => Q("require_alias", value); } /// - /// Specifies how long a consistent view of the index should be maintained for scrolled search. + /// + /// Specifies how long a consistent view of the index should be maintained for scrolled search. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); } /// - /// The number of slices this task should be divided into.
Defaults to 1 slice, meaning the task isn’t sliced into subtasks. + /// + /// The number of slices this task should be divided into. + /// Defaults to 1 slice, meaning the task isn’t sliced into subtasks. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Slices? Slices { get => Q("slices"); set => Q("slices", value); } /// - /// Period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards. + /// + /// Period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// public Elastic.Clients.Elasticsearch.Serverless.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } /// - /// If `true`, the request blocks until the operation is complete. + /// + /// If true, the request blocks until the operation is complete. + /// /// public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Reindex documents.
Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. +/// +/// Reindex documents. +/// Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. +/// /// public sealed partial class ReindexRequest : PlainRequest { @@ -86,73 +108,100 @@ public sealed partial class ReindexRequest : PlainRequest "reindex"; /// - /// If `true`, the request refreshes affected shards to make this operation visible to search. + /// + /// If true, the request refreshes affected shards to make this operation visible to search. + /// /// [JsonIgnore] public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// The throttle for this request in sub-requests per second.
Defaults to no throttle. + /// + /// The throttle for this request in sub-requests per second. + /// Defaults to no throttle. + /// /// [JsonIgnore] public float? RequestsPerSecond { get => Q("requests_per_second"); set => Q("requests_per_second", value); } /// - /// If `true`, the destination must be an index alias. + /// + /// If true, the destination must be an index alias. + /// /// [JsonIgnore] public bool? RequireAlias { get => Q("require_alias"); set => Q("require_alias", value); } /// - /// Specifies how long a consistent view of the index should be maintained for scrolled search. + /// + /// Specifies how long a consistent view of the index should be maintained for scrolled search. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); } /// - /// The number of slices this task should be divided into.
Defaults to 1 slice, meaning the task isn’t sliced into subtasks. + /// + /// The number of slices this task should be divided into. + /// Defaults to 1 slice, meaning the task isn’t sliced into subtasks. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Slices? Slices { get => Q("slices"); set => Q("slices", value); } /// - /// Period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards. + /// + /// Period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } /// - /// If `true`, the request blocks until the operation is complete. + /// + /// If true, the request blocks until the operation is complete. + /// /// [JsonIgnore] public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } /// - /// Set to proceed to continue reindexing even if there are conflicts. + /// + /// Set to proceed to continue reindexing even if there are conflicts. + /// /// [JsonInclude, JsonPropertyName("conflicts")] public Elastic.Clients.Elasticsearch.Serverless.Conflicts? Conflicts { get; set; } /// - /// The destination you are copying to. + /// + /// The destination you are copying to. + /// /// [JsonInclude, JsonPropertyName("dest")] public Elastic.Clients.Elasticsearch.Serverless.Core.Reindex.Destination Dest { get; set; } /// - /// The maximum number of documents to reindex. + /// + /// The maximum number of documents to reindex. + /// /// [JsonInclude, JsonPropertyName("max_docs")] public long? MaxDocs { get; set; } /// - /// The script to run to update the document source or metadata when reindexing. + /// + /// The script to run to update the document source or metadata when reindexing. + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Serverless.Script? Script { get; set; } @@ -160,14 +209,19 @@ public sealed partial class ReindexRequest : PlainRequest - /// The source you are copying from. + /// + /// The source you are copying from. + /// /// [JsonInclude, JsonPropertyName("source")] public Elastic.Clients.Elasticsearch.Serverless.Core.Reindex.Source Source { get; set; } } /// -/// Reindex documents.
Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. +/// +/// Reindex documents. +/// Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. +/// /// public sealed partial class ReindexRequestDescriptor : RequestDescriptor, ReindexRequestParameters> { @@ -208,7 +262,9 @@ public ReindexRequestDescriptor() private Action> SourceDescriptorAction { get; set; } /// - /// Set to proceed to continue reindexing even if there are conflicts. + /// + /// Set to proceed to continue reindexing even if there are conflicts. + /// /// public ReindexRequestDescriptor Conflicts(Elastic.Clients.Elasticsearch.Serverless.Conflicts? conflicts) { @@ -217,7 +273,9 @@ public ReindexRequestDescriptor Conflicts(Elastic.Clients.Elasticsear } /// - /// The destination you are copying to. + /// + /// The destination you are copying to. + /// /// public ReindexRequestDescriptor Dest(Elastic.Clients.Elasticsearch.Serverless.Core.Reindex.Destination dest) { @@ -244,7 +302,9 @@ public ReindexRequestDescriptor Dest(Action - /// The maximum number of documents to reindex. + /// + /// The maximum number of documents to reindex. + /// /// public ReindexRequestDescriptor MaxDocs(long? maxDocs) { @@ -253,7 +313,9 @@ public ReindexRequestDescriptor MaxDocs(long? maxDocs) } /// - /// The script to run to update the document source or metadata when reindexing. + /// + /// The script to run to update the document source or metadata when reindexing. + /// /// public ReindexRequestDescriptor Script(Elastic.Clients.Elasticsearch.Serverless.Script? script) { @@ -286,7 +348,9 @@ public ReindexRequestDescriptor Size(long? size) } /// - /// The source you are copying from. + /// + /// The source you are copying from. + /// /// public ReindexRequestDescriptor Source(Elastic.Clients.Elasticsearch.Serverless.Core.Reindex.Source source) { @@ -386,7 +450,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Reindex documents.
Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. +/// +/// Reindex documents. +/// Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. +/// /// public sealed partial class ReindexRequestDescriptor : RequestDescriptor { @@ -427,7 +494,9 @@ public ReindexRequestDescriptor() private Action SourceDescriptorAction { get; set; } /// - /// Set to proceed to continue reindexing even if there are conflicts. + /// + /// Set to proceed to continue reindexing even if there are conflicts. + /// /// public ReindexRequestDescriptor Conflicts(Elastic.Clients.Elasticsearch.Serverless.Conflicts? conflicts) { @@ -436,7 +505,9 @@ public ReindexRequestDescriptor Conflicts(Elastic.Clients.Elasticsearch.Serverle } /// - /// The destination you are copying to. + /// + /// The destination you are copying to. + /// /// public ReindexRequestDescriptor Dest(Elastic.Clients.Elasticsearch.Serverless.Core.Reindex.Destination dest) { @@ -463,7 +534,9 @@ public ReindexRequestDescriptor Dest(Action - /// The maximum number of documents to reindex. + /// + /// The maximum number of documents to reindex. + /// /// public ReindexRequestDescriptor MaxDocs(long? maxDocs) { @@ -472,7 +545,9 @@ public ReindexRequestDescriptor MaxDocs(long? maxDocs) } /// - /// The script to run to update the document source or metadata when reindexing. + /// + /// The script to run to update the document source or metadata when reindexing. + /// /// public ReindexRequestDescriptor Script(Elastic.Clients.Elasticsearch.Serverless.Script? script) { @@ -505,7 +580,9 @@ public ReindexRequestDescriptor Size(long? size) } /// - /// The source you are copying from. + /// + /// The source you are copying from. + /// /// public ReindexRequestDescriptor Source(Elastic.Clients.Elasticsearch.Serverless.Core.Reindex.Source source) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ReindexRethrottleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ReindexRethrottleRequest.g.cs index 1fef35a8ec1..ddb5d42e4f1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ReindexRethrottleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ReindexRethrottleRequest.g.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class ReindexRethrottleRequestParameters : RequestParameters { /// - /// The throttle for this request in sub-requests per second. + /// + /// The throttle for this request in sub-requests per second. + /// /// public float? RequestsPerSecond { get => Q("requests_per_second"); set => Q("requests_per_second", value); } } /// -/// Copies documents from a source to a destination. +/// +/// Copies documents from a source to a destination. +/// /// public sealed partial class ReindexRethrottleRequest : PlainRequest { @@ -55,14 +59,18 @@ public ReindexRethrottleRequest(Elastic.Clients.Elasticsearch.Serverless.Id task internal override string OperationName => "reindex_rethrottle"; /// - /// The throttle for this request in sub-requests per second. + /// + /// The throttle for this request in sub-requests per second. + /// /// [JsonIgnore] public float? RequestsPerSecond { get => Q("requests_per_second"); set => Q("requests_per_second", value); } } /// -/// Copies documents from a source to a destination. +/// +/// Copies documents from a source to a destination. +/// /// public sealed partial class ReindexRethrottleRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/RenderSearchTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/RenderSearchTemplateRequest.g.cs index 2a1b2d897cf..07b1760ae43 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/RenderSearchTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/RenderSearchTemplateRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class RenderSearchTemplateRequestParameters : RequestParam } /// -/// Renders a search template as a search request body. +/// +/// Renders a search template as a search request body. +/// /// public sealed partial class RenderSearchTemplateRequest : PlainRequest { @@ -58,20 +60,31 @@ public RenderSearchTemplateRequest(Elastic.Clients.Elasticsearch.Serverless.Id? public string? File { get; set; } /// - /// Key-value pairs used to replace Mustache variables in the template.
The key is the variable name.
The value is the variable value. + /// + /// Key-value pairs used to replace Mustache variables in the template. + /// The key is the variable name. + /// The value is the variable value. + /// /// [JsonInclude, JsonPropertyName("params")] public IDictionary? Params { get; set; } /// - /// An inline search template.
Supports the same parameters as the search API's request body.
These parameters also support Mustache variables.
If no `id` or `` is specified, this parameter is required. + /// + /// An inline search template. + /// Supports the same parameters as the search API's request body. + /// These parameters also support Mustache variables. + /// If no id or <templated-id> is specified, this parameter is required. + /// /// [JsonInclude, JsonPropertyName("source")] public string? Source { get; set; } } /// -/// Renders a search template as a search request body. +/// +/// Renders a search template as a search request body. +/// /// public sealed partial class RenderSearchTemplateRequestDescriptor : RequestDescriptor, RenderSearchTemplateRequestParameters> { @@ -110,7 +123,11 @@ public RenderSearchTemplateRequestDescriptor File(string? file) } /// - /// Key-value pairs used to replace Mustache variables in the template.
The key is the variable name.
The value is the variable value. + /// + /// Key-value pairs used to replace Mustache variables in the template. + /// The key is the variable name. + /// The value is the variable value. + /// /// public RenderSearchTemplateRequestDescriptor Params(Func, FluentDictionary> selector) { @@ -119,7 +136,12 @@ public RenderSearchTemplateRequestDescriptor Params(Func - /// An inline search template.
Supports the same parameters as the search API's request body.
These parameters also support Mustache variables.
If no `id` or `` is specified, this parameter is required. + /// + /// An inline search template. + /// Supports the same parameters as the search API's request body. + /// These parameters also support Mustache variables. + /// If no id or <templated-id> is specified, this parameter is required. + /// /// public RenderSearchTemplateRequestDescriptor Source(string? source) { @@ -153,7 +175,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Renders a search template as a search request body. +/// +/// Renders a search template as a search request body. +/// /// public sealed partial class RenderSearchTemplateRequestDescriptor : RequestDescriptor { @@ -192,7 +216,11 @@ public RenderSearchTemplateRequestDescriptor File(string? file) } /// - /// Key-value pairs used to replace Mustache variables in the template.
The key is the variable name.
The value is the variable value. + /// + /// Key-value pairs used to replace Mustache variables in the template. + /// The key is the variable name. + /// The value is the variable value. + /// /// public RenderSearchTemplateRequestDescriptor Params(Func, FluentDictionary> selector) { @@ -201,7 +229,12 @@ public RenderSearchTemplateRequestDescriptor Params(Func - /// An inline search template.
Supports the same parameters as the search API's request body.
These parameters also support Mustache variables.
If no `id` or `` is specified, this parameter is required. + /// + /// An inline search template. + /// Supports the same parameters as the search API's request body. + /// These parameters also support Mustache variables. + /// If no id or <templated-id> is specified, this parameter is required. + /// /// public RenderSearchTemplateRequestDescriptor Source(string? source) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ScrollRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ScrollRequest.g.cs index 5542fbe32d4..80b60e31b90 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ScrollRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ScrollRequest.g.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class ScrollRequestParameters : RequestParameters { /// - /// If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object. + /// + /// If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object. + /// /// public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } } /// -/// Allows to retrieve a large numbers of results from a single search request. +/// +/// Allows to retrieve a large numbers of results from a single search request. +/// /// public sealed partial class ScrollRequest : PlainRequest { @@ -51,26 +55,34 @@ public sealed partial class ScrollRequest : PlainRequest "scroll"; /// - /// If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object. + /// + /// If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object. + /// /// [JsonIgnore] public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } /// - /// Period to retain the search context for scrolling. + /// + /// Period to retain the search context for scrolling. + /// /// [JsonInclude, JsonPropertyName("scroll")] public Elastic.Clients.Elasticsearch.Serverless.Duration? Scroll { get; set; } /// - /// Scroll ID of the search. + /// + /// Scroll ID of the search. + /// /// [JsonInclude, JsonPropertyName("scroll_id")] public Elastic.Clients.Elasticsearch.Serverless.ScrollId ScrollId { get; set; } } /// -/// Allows to retrieve a large numbers of results from a single search request. +/// +/// Allows to retrieve a large numbers of results from a single search request. +/// /// public sealed partial class ScrollRequestDescriptor : RequestDescriptor { @@ -94,7 +106,9 @@ public ScrollRequestDescriptor() private Elastic.Clients.Elasticsearch.Serverless.ScrollId ScrollIdValue { get; set; } /// - /// Period to retain the search context for scrolling. + /// + /// Period to retain the search context for scrolling. + /// /// public ScrollRequestDescriptor Scroll(Elastic.Clients.Elasticsearch.Serverless.Duration? scroll) { @@ -103,7 +117,9 @@ public ScrollRequestDescriptor Scroll(Elastic.Clients.Elasticsearch.Serverless.D } /// - /// Scroll ID of the search. + /// + /// Scroll ID of the search. + /// /// public ScrollRequestDescriptor ScrollId(Elastic.Clients.Elasticsearch.Serverless.ScrollId scrollId) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SearchMvtRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SearchMvtRequest.g.cs index 8a5f2822dff..27cb84e2b63 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SearchMvtRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SearchMvtRequest.g.cs @@ -34,7 +34,10 @@ public sealed partial class SearchMvtRequestParameters : RequestParameters } /// -/// Search a vector tile.
Searches a vector tile for geospatial values. +/// +/// Search a vector tile. +/// Searches a vector tile for geospatial values. +/// /// public sealed partial class SearchMvtRequest : PlainRequest { @@ -51,95 +54,174 @@ public SearchMvtRequest(Elastic.Clients.Elasticsearch.Serverless.Indices indices internal override string OperationName => "search_mvt"; /// - /// Sub-aggregations for the geotile_grid. - /// Supports the following aggregation types:
- avg
- cardinality
- max
- min
- sum + /// + /// Sub-aggregations for the geotile_grid. + /// + /// + /// Supports the following aggregation types: + /// + /// + /// + /// + /// avg + /// + /// + /// + /// + /// cardinality + /// + /// + /// + /// + /// max + /// + /// + /// + /// + /// min + /// + /// + /// + /// + /// sum + /// + /// + /// /// [JsonInclude, JsonPropertyName("aggs")] public IDictionary? Aggs { get; set; } /// - /// Size, in pixels, of a clipping buffer outside the tile. This allows renderers
to avoid outline artifacts from geometries that extend past the extent of the tile. + /// + /// Size, in pixels, of a clipping buffer outside the tile. This allows renderers + /// to avoid outline artifacts from geometries that extend past the extent of the tile. + /// /// [JsonInclude, JsonPropertyName("buffer")] public int? Buffer { get; set; } /// - /// If false, the meta layer’s feature is the bounding box of the tile.
If true, the meta layer’s feature is a bounding box resulting from a
geo_bounds aggregation. The aggregation runs on values that intersect
the // tile with wrap_longitude set to false. The resulting
bounding box may be larger than the vector tile. + /// + /// If false, the meta layer’s feature is the bounding box of the tile. + /// If true, the meta layer’s feature is a bounding box resulting from a + /// geo_bounds aggregation. The aggregation runs on <field> values that intersect + /// the <zoom>/<x>/<y> tile with wrap_longitude set to false. The resulting + /// bounding box may be larger than the vector tile. + /// /// [JsonInclude, JsonPropertyName("exact_bounds")] public bool? ExactBounds { get; set; } /// - /// Size, in pixels, of a side of the tile. Vector tiles are square with equal sides. + /// + /// Size, in pixels, of a side of the tile. Vector tiles are square with equal sides. + /// /// [JsonInclude, JsonPropertyName("extent")] public int? Extent { get; set; } /// - /// Fields to return in the `hits` layer. Supports wildcards (`*`).
This parameter does not support fields with array values. Fields with array
values may return inconsistent results. + /// + /// Fields to return in the hits layer. Supports wildcards (*). + /// This parameter does not support fields with array values. Fields with array + /// values may return inconsistent results. + /// /// [JsonInclude, JsonPropertyName("fields")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] public Elastic.Clients.Elasticsearch.Serverless.Fields? Fields { get; set; } /// - /// Aggregation used to create a grid for the `field`. + /// + /// Aggregation used to create a grid for the field. + /// /// [JsonInclude, JsonPropertyName("grid_agg")] public Elastic.Clients.Elasticsearch.Serverless.Core.SearchMvt.GridAggregationType? GridAgg { get; set; } /// - /// Additional zoom levels available through the aggs layer. For example, if is 7
and grid_precision is 8, you can zoom in up to level 15. Accepts 0-8. If 0, results
don’t include the aggs layer. + /// + /// Additional zoom levels available through the aggs layer. For example, if <zoom> is 7 + /// and grid_precision is 8, you can zoom in up to level 15. Accepts 0-8. If 0, results + /// don’t include the aggs layer. + /// /// [JsonInclude, JsonPropertyName("grid_precision")] public int? GridPrecision { get; set; } /// - /// Determines the geometry type for features in the aggs layer. In the aggs layer,
each feature represents a geotile_grid cell. If 'grid' each feature is a Polygon
of the cells bounding box. If 'point' each feature is a Point that is the centroid
of the cell. + /// + /// Determines the geometry type for features in the aggs layer. In the aggs layer, + /// each feature represents a geotile_grid cell. If 'grid' each feature is a Polygon + /// of the cells bounding box. If 'point' each feature is a Point that is the centroid + /// of the cell. + /// /// [JsonInclude, JsonPropertyName("grid_type")] public Elastic.Clients.Elasticsearch.Serverless.Core.SearchMvt.GridType? GridType { get; set; } /// - /// Query DSL used to filter documents for the search. + /// + /// Query DSL used to filter documents for the search. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? Query { get; set; } /// - /// Defines one or more runtime fields in the search request. These fields take
precedence over mapped fields with the same name. + /// + /// Defines one or more runtime fields in the search request. These fields take + /// precedence over mapped fields with the same name. + /// /// [JsonInclude, JsonPropertyName("runtime_mappings")] public IDictionary? RuntimeMappings { get; set; } /// - /// Maximum number of features to return in the hits layer. Accepts 0-10000.
If 0, results don’t include the hits layer. + /// + /// Maximum number of features to return in the hits layer. Accepts 0-10000. + /// If 0, results don’t include the hits layer. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// Sorts features in the hits layer. By default, the API calculates a bounding
box for each feature. It sorts features based on this box’s diagonal length,
from longest to shortest. + /// + /// Sorts features in the hits layer. By default, the API calculates a bounding + /// box for each feature. It sorts features based on this box’s diagonal length, + /// from longest to shortest. + /// /// [JsonInclude, JsonPropertyName("sort")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.SortOptions))] public ICollection? Sort { get; set; } /// - /// Number of hits matching the query to count accurately. If `true`, the exact number
of hits is returned at the cost of some performance. If `false`, the response does
not include the total number of hits matching the query. + /// + /// Number of hits matching the query to count accurately. If true, the exact number + /// of hits is returned at the cost of some performance. If false, the response does + /// not include the total number of hits matching the query. + /// /// [JsonInclude, JsonPropertyName("track_total_hits")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.TrackHits? TrackTotalHits { get; set; } /// - /// If `true`, the hits and aggs layers will contain additional point features representing
suggested label positions for the original features. + /// + /// If true, the hits and aggs layers will contain additional point features representing + /// suggested label positions for the original features. + /// /// [JsonInclude, JsonPropertyName("with_labels")] public bool? WithLabels { get; set; } } /// -/// Search a vector tile.
Searches a vector tile for geospatial values. +/// +/// Search a vector tile. +/// Searches a vector tile for geospatial values. +/// /// public sealed partial class SearchMvtRequestDescriptor : RequestDescriptor, SearchMvtRequestParameters> { @@ -212,8 +294,39 @@ public SearchMvtRequestDescriptor Zoom(int zoom) private bool? WithLabelsValue { get; set; } /// - /// Sub-aggregations for the geotile_grid. - /// Supports the following aggregation types:
- avg
- cardinality
- max
- min
- sum + /// + /// Sub-aggregations for the geotile_grid. + /// + /// + /// Supports the following aggregation types: + /// + /// + /// + /// + /// avg + /// + /// + /// + /// + /// cardinality + /// + /// + /// + /// + /// max + /// + /// + /// + /// + /// min + /// + /// + /// + /// + /// sum + /// + /// + /// /// public SearchMvtRequestDescriptor Aggs(Func>, FluentDescriptorDictionary>> selector) { @@ -222,7 +335,10 @@ public SearchMvtRequestDescriptor Aggs(Func - /// Size, in pixels, of a clipping buffer outside the tile. This allows renderers
to avoid outline artifacts from geometries that extend past the extent of the tile. + /// + /// Size, in pixels, of a clipping buffer outside the tile. This allows renderers + /// to avoid outline artifacts from geometries that extend past the extent of the tile. + /// /// public SearchMvtRequestDescriptor Buffer(int? buffer) { @@ -231,7 +347,13 @@ public SearchMvtRequestDescriptor Buffer(int? buffer) } /// - /// If false, the meta layer’s feature is the bounding box of the tile.
If true, the meta layer’s feature is a bounding box resulting from a
geo_bounds aggregation. The aggregation runs on values that intersect
the // tile with wrap_longitude set to false. The resulting
bounding box may be larger than the vector tile. + /// + /// If false, the meta layer’s feature is the bounding box of the tile. + /// If true, the meta layer’s feature is a bounding box resulting from a + /// geo_bounds aggregation. The aggregation runs on <field> values that intersect + /// the <zoom>/<x>/<y> tile with wrap_longitude set to false. The resulting + /// bounding box may be larger than the vector tile. + /// /// public SearchMvtRequestDescriptor ExactBounds(bool? exactBounds = true) { @@ -240,7 +362,9 @@ public SearchMvtRequestDescriptor ExactBounds(bool? exactBounds = tru } /// - /// Size, in pixels, of a side of the tile. Vector tiles are square with equal sides. + /// + /// Size, in pixels, of a side of the tile. Vector tiles are square with equal sides. + /// /// public SearchMvtRequestDescriptor Extent(int? extent) { @@ -249,7 +373,11 @@ public SearchMvtRequestDescriptor Extent(int? extent) } /// - /// Fields to return in the `hits` layer. Supports wildcards (`*`).
This parameter does not support fields with array values. Fields with array
values may return inconsistent results. + /// + /// Fields to return in the hits layer. Supports wildcards (*). + /// This parameter does not support fields with array values. Fields with array + /// values may return inconsistent results. + /// /// public SearchMvtRequestDescriptor Fields(Elastic.Clients.Elasticsearch.Serverless.Fields? fields) { @@ -258,7 +386,9 @@ public SearchMvtRequestDescriptor Fields(Elastic.Clients.Elasticsearc } /// - /// Aggregation used to create a grid for the `field`. + /// + /// Aggregation used to create a grid for the field. + /// /// public SearchMvtRequestDescriptor GridAgg(Elastic.Clients.Elasticsearch.Serverless.Core.SearchMvt.GridAggregationType? gridAgg) { @@ -267,7 +397,11 @@ public SearchMvtRequestDescriptor GridAgg(Elastic.Clients.Elasticsear } /// - /// Additional zoom levels available through the aggs layer. For example, if is 7
and grid_precision is 8, you can zoom in up to level 15. Accepts 0-8. If 0, results
don’t include the aggs layer. + /// + /// Additional zoom levels available through the aggs layer. For example, if <zoom> is 7 + /// and grid_precision is 8, you can zoom in up to level 15. Accepts 0-8. If 0, results + /// don’t include the aggs layer. + /// /// public SearchMvtRequestDescriptor GridPrecision(int? gridPrecision) { @@ -276,7 +410,12 @@ public SearchMvtRequestDescriptor GridPrecision(int? gridPrecision) } /// - /// Determines the geometry type for features in the aggs layer. In the aggs layer,
each feature represents a geotile_grid cell. If 'grid' each feature is a Polygon
of the cells bounding box. If 'point' each feature is a Point that is the centroid
of the cell. + /// + /// Determines the geometry type for features in the aggs layer. In the aggs layer, + /// each feature represents a geotile_grid cell. If 'grid' each feature is a Polygon + /// of the cells bounding box. If 'point' each feature is a Point that is the centroid + /// of the cell. + /// /// public SearchMvtRequestDescriptor GridType(Elastic.Clients.Elasticsearch.Serverless.Core.SearchMvt.GridType? gridType) { @@ -285,7 +424,9 @@ public SearchMvtRequestDescriptor GridType(Elastic.Clients.Elasticsea } /// - /// Query DSL used to filter documents for the search. + /// + /// Query DSL used to filter documents for the search. + /// /// public SearchMvtRequestDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -312,7 +453,10 @@ public SearchMvtRequestDescriptor Query(Action - /// Defines one or more runtime fields in the search request. These fields take
precedence over mapped fields with the same name. + /// + /// Defines one or more runtime fields in the search request. These fields take + /// precedence over mapped fields with the same name. + /// /// public SearchMvtRequestDescriptor RuntimeMappings(Func>, FluentDescriptorDictionary>> selector) { @@ -321,7 +465,10 @@ public SearchMvtRequestDescriptor RuntimeMappings(Func - /// Maximum number of features to return in the hits layer. Accepts 0-10000.
If 0, results don’t include the hits layer. + /// + /// Maximum number of features to return in the hits layer. Accepts 0-10000. + /// If 0, results don’t include the hits layer. + /// /// public SearchMvtRequestDescriptor Size(int? size) { @@ -330,7 +477,11 @@ public SearchMvtRequestDescriptor Size(int? size) } /// - /// Sorts features in the hits layer. By default, the API calculates a bounding
box for each feature. It sorts features based on this box’s diagonal length,
from longest to shortest. + /// + /// Sorts features in the hits layer. By default, the API calculates a bounding + /// box for each feature. It sorts features based on this box’s diagonal length, + /// from longest to shortest. + /// /// public SearchMvtRequestDescriptor Sort(ICollection? sort) { @@ -369,7 +520,11 @@ public SearchMvtRequestDescriptor Sort(params Action - /// Number of hits matching the query to count accurately. If `true`, the exact number
of hits is returned at the cost of some performance. If `false`, the response does
not include the total number of hits matching the query. + /// + /// Number of hits matching the query to count accurately. If true, the exact number + /// of hits is returned at the cost of some performance. If false, the response does + /// not include the total number of hits matching the query. + /// /// public SearchMvtRequestDescriptor TrackTotalHits(Elastic.Clients.Elasticsearch.Serverless.Core.Search.TrackHits? trackTotalHits) { @@ -378,7 +533,10 @@ public SearchMvtRequestDescriptor TrackTotalHits(Elastic.Clients.Elas } /// - /// If `true`, the hits and aggs layers will contain additional point features representing
suggested label positions for the original features. + /// + /// If true, the hits and aggs layers will contain additional point features representing + /// suggested label positions for the original features. + /// /// public SearchMvtRequestDescriptor WithLabels(bool? withLabels = true) { @@ -511,7 +669,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Search a vector tile.
Searches a vector tile for geospatial values. +/// +/// Search a vector tile. +/// Searches a vector tile for geospatial values. +/// /// public sealed partial class SearchMvtRequestDescriptor : RequestDescriptor { @@ -580,8 +741,39 @@ public SearchMvtRequestDescriptor Zoom(int zoom) private bool? WithLabelsValue { get; set; } /// - /// Sub-aggregations for the geotile_grid. - /// Supports the following aggregation types:
- avg
- cardinality
- max
- min
- sum + /// + /// Sub-aggregations for the geotile_grid. + /// + /// + /// Supports the following aggregation types: + /// + /// + /// + /// + /// avg + /// + /// + /// + /// + /// cardinality + /// + /// + /// + /// + /// max + /// + /// + /// + /// + /// min + /// + /// + /// + /// + /// sum + /// + /// + /// /// public SearchMvtRequestDescriptor Aggs(Func, FluentDescriptorDictionary> selector) { @@ -590,7 +782,10 @@ public SearchMvtRequestDescriptor Aggs(Func - /// Size, in pixels, of a clipping buffer outside the tile. This allows renderers
to avoid outline artifacts from geometries that extend past the extent of the tile. + /// + /// Size, in pixels, of a clipping buffer outside the tile. This allows renderers + /// to avoid outline artifacts from geometries that extend past the extent of the tile. + /// /// public SearchMvtRequestDescriptor Buffer(int? buffer) { @@ -599,7 +794,13 @@ public SearchMvtRequestDescriptor Buffer(int? buffer) } /// - /// If false, the meta layer’s feature is the bounding box of the tile.
If true, the meta layer’s feature is a bounding box resulting from a
geo_bounds aggregation. The aggregation runs on values that intersect
the // tile with wrap_longitude set to false. The resulting
bounding box may be larger than the vector tile. + /// + /// If false, the meta layer’s feature is the bounding box of the tile. + /// If true, the meta layer’s feature is a bounding box resulting from a + /// geo_bounds aggregation. The aggregation runs on <field> values that intersect + /// the <zoom>/<x>/<y> tile with wrap_longitude set to false. The resulting + /// bounding box may be larger than the vector tile. + /// /// public SearchMvtRequestDescriptor ExactBounds(bool? exactBounds = true) { @@ -608,7 +809,9 @@ public SearchMvtRequestDescriptor ExactBounds(bool? exactBounds = true) } /// - /// Size, in pixels, of a side of the tile. Vector tiles are square with equal sides. + /// + /// Size, in pixels, of a side of the tile. Vector tiles are square with equal sides. + /// /// public SearchMvtRequestDescriptor Extent(int? extent) { @@ -617,7 +820,11 @@ public SearchMvtRequestDescriptor Extent(int? extent) } /// - /// Fields to return in the `hits` layer. Supports wildcards (`*`).
This parameter does not support fields with array values. Fields with array
values may return inconsistent results. + /// + /// Fields to return in the hits layer. Supports wildcards (*). + /// This parameter does not support fields with array values. Fields with array + /// values may return inconsistent results. + /// /// public SearchMvtRequestDescriptor Fields(Elastic.Clients.Elasticsearch.Serverless.Fields? fields) { @@ -626,7 +833,9 @@ public SearchMvtRequestDescriptor Fields(Elastic.Clients.Elasticsearch.Serverles } /// - /// Aggregation used to create a grid for the `field`. + /// + /// Aggregation used to create a grid for the field. + /// /// public SearchMvtRequestDescriptor GridAgg(Elastic.Clients.Elasticsearch.Serverless.Core.SearchMvt.GridAggregationType? gridAgg) { @@ -635,7 +844,11 @@ public SearchMvtRequestDescriptor GridAgg(Elastic.Clients.Elasticsearch.Serverle } /// - /// Additional zoom levels available through the aggs layer. For example, if is 7
and grid_precision is 8, you can zoom in up to level 15. Accepts 0-8. If 0, results
don’t include the aggs layer. + /// + /// Additional zoom levels available through the aggs layer. For example, if <zoom> is 7 + /// and grid_precision is 8, you can zoom in up to level 15. Accepts 0-8. If 0, results + /// don’t include the aggs layer. + /// /// public SearchMvtRequestDescriptor GridPrecision(int? gridPrecision) { @@ -644,7 +857,12 @@ public SearchMvtRequestDescriptor GridPrecision(int? gridPrecision) } /// - /// Determines the geometry type for features in the aggs layer. In the aggs layer,
each feature represents a geotile_grid cell. If 'grid' each feature is a Polygon
of the cells bounding box. If 'point' each feature is a Point that is the centroid
of the cell. + /// + /// Determines the geometry type for features in the aggs layer. In the aggs layer, + /// each feature represents a geotile_grid cell. If 'grid' each feature is a Polygon + /// of the cells bounding box. If 'point' each feature is a Point that is the centroid + /// of the cell. + /// /// public SearchMvtRequestDescriptor GridType(Elastic.Clients.Elasticsearch.Serverless.Core.SearchMvt.GridType? gridType) { @@ -653,7 +871,9 @@ public SearchMvtRequestDescriptor GridType(Elastic.Clients.Elasticsearch.Serverl } /// - /// Query DSL used to filter documents for the search. + /// + /// Query DSL used to filter documents for the search. + /// /// public SearchMvtRequestDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -680,7 +900,10 @@ public SearchMvtRequestDescriptor Query(Action - /// Defines one or more runtime fields in the search request. These fields take
precedence over mapped fields with the same name. + /// + /// Defines one or more runtime fields in the search request. These fields take + /// precedence over mapped fields with the same name. + /// /// public SearchMvtRequestDescriptor RuntimeMappings(Func, FluentDescriptorDictionary> selector) { @@ -689,7 +912,10 @@ public SearchMvtRequestDescriptor RuntimeMappings(Func - /// Maximum number of features to return in the hits layer. Accepts 0-10000.
If 0, results don’t include the hits layer. + /// + /// Maximum number of features to return in the hits layer. Accepts 0-10000. + /// If 0, results don’t include the hits layer. + /// /// public SearchMvtRequestDescriptor Size(int? size) { @@ -698,7 +924,11 @@ public SearchMvtRequestDescriptor Size(int? size) } /// - /// Sorts features in the hits layer. By default, the API calculates a bounding
box for each feature. It sorts features based on this box’s diagonal length,
from longest to shortest. + /// + /// Sorts features in the hits layer. By default, the API calculates a bounding + /// box for each feature. It sorts features based on this box’s diagonal length, + /// from longest to shortest. + /// /// public SearchMvtRequestDescriptor Sort(ICollection? sort) { @@ -737,7 +967,11 @@ public SearchMvtRequestDescriptor Sort(params Action - /// Number of hits matching the query to count accurately. If `true`, the exact number
of hits is returned at the cost of some performance. If `false`, the response does
not include the total number of hits matching the query. + /// + /// Number of hits matching the query to count accurately. If true, the exact number + /// of hits is returned at the cost of some performance. If false, the response does + /// not include the total number of hits matching the query. + /// /// public SearchMvtRequestDescriptor TrackTotalHits(Elastic.Clients.Elasticsearch.Serverless.Core.Search.TrackHits? trackTotalHits) { @@ -746,7 +980,10 @@ public SearchMvtRequestDescriptor TrackTotalHits(Elastic.Clients.Elasticsearch.S } /// - /// If `true`, the hits and aggs layers will contain additional point features representing
suggested label positions for the original features. + /// + /// If true, the hits and aggs layers will contain additional point features representing + /// suggested label positions for the original features. + /// /// public SearchMvtRequestDescriptor WithLabels(bool? withLabels = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SearchRequest.g.cs index 32a77cf91c9..a117fb67133 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SearchRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SearchRequest.g.cs @@ -32,147 +32,241 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class SearchRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices.
For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results. + /// + /// If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results. + /// /// public bool? AllowPartialSearchResults { get => Q("allow_partial_search_results"); set => Q("allow_partial_search_results", value); } /// - /// Analyzer to use for the query string.
This parameter can only be used when the q query string parameter is specified. + /// + /// Analyzer to use for the query string. + /// This parameter can only be used when the q query string parameter is specified. + /// /// public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// - /// If true, wildcard and prefix queries are analyzed.
This parameter can only be used when the q query string parameter is specified. + /// + /// If true, wildcard and prefix queries are analyzed. + /// This parameter can only be used when the q query string parameter is specified. + /// /// public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } /// - /// The number of shard results that should be reduced at once on the coordinating node.
This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large. + /// + /// The number of shard results that should be reduced at once on the coordinating node. + /// This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large. + /// /// public long? BatchedReduceSize { get => Q("batched_reduce_size"); set => Q("batched_reduce_size", value); } /// - /// If true, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. + /// + /// If true, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. + /// /// public bool? CcsMinimizeRoundtrips { get => Q("ccs_minimize_roundtrips"); set => Q("ccs_minimize_roundtrips", value); } /// - /// The default operator for query string query: AND or OR.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// The default operator for query string query: AND or OR. + /// This parameter can only be used when the q query string parameter is specified. + /// /// public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } /// - /// Field to use as default where no field prefix is given in the query string.
This parameter can only be used when the q query string parameter is specified. + /// + /// Field to use as default where no field prefix is given in the query string. + /// This parameter can only be used when the q query string parameter is specified. + /// /// public string? Df { get => Q("df"); set => Q("df", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, concrete, expanded or aliased indices will be ignored when frozen. + /// + /// If true, concrete, expanded or aliased indices will be ignored when frozen. + /// /// public bool? IgnoreThrottled { get => Q("ignore_throttled"); set => Q("ignore_throttled", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// This parameter can only be used when the q query string parameter is specified. + /// /// public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// - /// Defines the number of concurrent shard requests per node this search executes concurrently.
This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests. + /// + /// Defines the number of concurrent shard requests per node this search executes concurrently. + /// This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests. + /// /// public long? MaxConcurrentShardRequests { get => Q("max_concurrent_shard_requests"); set => Q("max_concurrent_shard_requests", value); } /// - /// The minimum version of the node that can handle the request
Any handling node with a lower version will fail the request. + /// + /// The minimum version of the node that can handle the request + /// Any handling node with a lower version will fail the request. + /// /// public string? MinCompatibleShardNode { get => Q("min_compatible_shard_node"); set => Q("min_compatible_shard_node", value); } /// - /// Nodes and shards used for the search.
By default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are:
`_only_local` to run the search only on shards on the local node;
`_local` to, if possible, run the search on shards on the local node, or if not, select shards using the default method;
`_only_nodes:,` to run the search on only the specified nodes IDs, where, if suitable shards exist on more than one selected node, use shards on those nodes using the default method, or if none of the specified nodes are available, select shards from any available node using the default method;
`_prefer_nodes:,` to if possible, run the search on the specified nodes IDs, or if not, select shards using the default method;
`_shards:,` to run the search only on the specified shards;
`` (any string that does not start with `_`) to route searches with the same `` to the same shards in the same order. + /// + /// Nodes and shards used for the search. + /// By default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are: + /// _only_local to run the search only on shards on the local node; + /// _local to, if possible, run the search on shards on the local node, or if not, select shards using the default method; + /// _only_nodes:<node-id>,<node-id> to run the search on only the specified nodes IDs, where, if suitable shards exist on more than one selected node, use shards on those nodes using the default method, or if none of the specified nodes are available, select shards from any available node using the default method; + /// _prefer_nodes:<node-id>,<node-id> to if possible, run the search on the specified nodes IDs, or if not, select shards using the default method; + /// _shards:<shard>,<shard> to run the search only on the specified shards; + /// <custom-string> (any string that does not start with _) to route searches with the same <custom-string> to the same shards in the same order. + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold.
This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method (if date filters are mandatory to match but the shard bounds and the query are disjoint).
When unspecified, the pre-filter phase is executed if any of these conditions is met:
the request targets more than 128 shards;
the request targets one or more read-only index;
the primary sort of the query targets an indexed field. + /// + /// Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. + /// This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method (if date filters are mandatory to match but the shard bounds and the query are disjoint). + /// When unspecified, the pre-filter phase is executed if any of these conditions is met: + /// the request targets more than 128 shards; + /// the request targets one or more read-only index; + /// the primary sort of the query targets an indexed field. + /// /// public long? PreFilterShardSize { get => Q("pre_filter_shard_size"); set => Q("pre_filter_shard_size", value); } /// - /// Query in the Lucene query string syntax using query parameter search.
Query parameter searches do not support the full Elasticsearch Query DSL but are handy for testing. + /// + /// Query in the Lucene query string syntax using query parameter search. + /// Query parameter searches do not support the full Elasticsearch Query DSL but are handy for testing. + /// /// public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } /// - /// If `true`, the caching of search results is enabled for requests where `size` is `0`.
Defaults to index level settings. + /// + /// If true, the caching of search results is enabled for requests where size is 0. + /// Defaults to index level settings. + /// /// public bool? RequestCache { get => Q("request_cache"); set => Q("request_cache", value); } /// - /// Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response. + /// + /// Indicates whether hits.total should be rendered as an integer or an object in the rest search response. + /// /// public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Period to retain the search context for scrolling. See Scroll search results.
By default, this value cannot exceed `1d` (24 hours).
You can change this limit using the `search.max_keep_alive` cluster-level setting. + /// + /// Period to retain the search context for scrolling. See Scroll search results. + /// By default, this value cannot exceed 1d (24 hours). + /// You can change this limit using the search.max_keep_alive cluster-level setting. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); } /// - /// How distributed term frequencies are calculated for relevance scoring. + /// + /// How distributed term frequencies are calculated for relevance scoring. + /// /// public Elastic.Clients.Elasticsearch.Serverless.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } /// - /// A comma-separated list of source fields to exclude from the response.
You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.
If the `_source` parameter is `false`, this parameter is ignored. + /// + /// A comma-separated list of source fields to exclude from the response. + /// You can also use this parameter to exclude fields from the subset specified in _source_includes query parameter. + /// If the _source parameter is false, this parameter is ignored. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response.
If this parameter is specified, only these source fields are returned.
You can exclude fields from this subset using the `_source_excludes` query parameter.
If the `_source` parameter is `false`, this parameter is ignored. + /// + /// A comma-separated list of source fields to include in the response. + /// If this parameter is specified, only these source fields are returned. + /// You can exclude fields from this subset using the _source_excludes query parameter. + /// If the _source parameter is false, this parameter is ignored. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// Specifies which field to use for suggestions. + /// + /// Specifies which field to use for suggestions. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Field? SuggestField { get => Q("suggest_field"); set => Q("suggest_field", value); } /// - /// Specifies the suggest mode.
This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. + /// + /// Specifies the suggest mode. + /// This parameter can only be used when the suggest_field and suggest_text query string parameters are specified. + /// /// public Elastic.Clients.Elasticsearch.Serverless.SuggestMode? SuggestMode { get => Q("suggest_mode"); set => Q("suggest_mode", value); } /// - /// Number of suggestions to return.
This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. + /// + /// Number of suggestions to return. + /// This parameter can only be used when the suggest_field and suggest_text query string parameters are specified. + /// /// public long? SuggestSize { get => Q("suggest_size"); set => Q("suggest_size", value); } /// - /// The source text for which the suggestions should be returned.
This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. + /// + /// The source text for which the suggestions should be returned. + /// This parameter can only be used when the suggest_field and suggest_text query string parameters are specified. + /// /// public string? SuggestText { get => Q("suggest_text"); set => Q("suggest_text", value); } /// - /// If `true`, aggregation and suggester names are be prefixed by their respective types in the response. + /// + /// If true, aggregation and suggester names are be prefixed by their respective types in the response. + /// /// public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } } @@ -610,7 +704,11 @@ public override void Write(Utf8JsonWriter writer, SearchRequest value, JsonSeria } /// -/// Returns search hits that match the query defined in the request.
You can provide search queries using the `q` query string parameter or the request body.
If both are specified, only the query parameter is used. +/// +/// Returns search hits that match the query defined in the request. +/// You can provide search queries using the q query string parameter or the request body. +/// If both are specified, only the query parameter is used. +/// /// [JsonConverter(typeof(SearchRequestConverter))] public partial class SearchRequest : PlainRequest @@ -632,390 +730,586 @@ public SearchRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? indices) internal override string OperationName => "search"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices.
For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results. + /// + /// If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results. + /// /// [JsonIgnore] public bool? AllowPartialSearchResults { get => Q("allow_partial_search_results"); set => Q("allow_partial_search_results", value); } /// - /// Analyzer to use for the query string.
This parameter can only be used when the q query string parameter is specified. + /// + /// Analyzer to use for the query string. + /// This parameter can only be used when the q query string parameter is specified. + /// /// [JsonIgnore] public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// - /// If true, wildcard and prefix queries are analyzed.
This parameter can only be used when the q query string parameter is specified. + /// + /// If true, wildcard and prefix queries are analyzed. + /// This parameter can only be used when the q query string parameter is specified. + /// /// [JsonIgnore] public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } /// - /// The number of shard results that should be reduced at once on the coordinating node.
This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large. + /// + /// The number of shard results that should be reduced at once on the coordinating node. + /// This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large. + /// /// [JsonIgnore] public long? BatchedReduceSize { get => Q("batched_reduce_size"); set => Q("batched_reduce_size", value); } /// - /// If true, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. + /// + /// If true, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. + /// /// [JsonIgnore] public bool? CcsMinimizeRoundtrips { get => Q("ccs_minimize_roundtrips"); set => Q("ccs_minimize_roundtrips", value); } /// - /// The default operator for query string query: AND or OR.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// The default operator for query string query: AND or OR. + /// This parameter can only be used when the q query string parameter is specified. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } /// - /// Field to use as default where no field prefix is given in the query string.
This parameter can only be used when the q query string parameter is specified. + /// + /// Field to use as default where no field prefix is given in the query string. + /// This parameter can only be used when the q query string parameter is specified. + /// /// [JsonIgnore] public string? Df { get => Q("df"); set => Q("df", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, concrete, expanded or aliased indices will be ignored when frozen. + /// + /// If true, concrete, expanded or aliased indices will be ignored when frozen. + /// /// [JsonIgnore] public bool? IgnoreThrottled { get => Q("ignore_throttled"); set => Q("ignore_throttled", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// This parameter can only be used when the q query string parameter is specified. + /// /// [JsonIgnore] public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// - /// Defines the number of concurrent shard requests per node this search executes concurrently.
This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests. + /// + /// Defines the number of concurrent shard requests per node this search executes concurrently. + /// This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests. + /// /// [JsonIgnore] public long? MaxConcurrentShardRequests { get => Q("max_concurrent_shard_requests"); set => Q("max_concurrent_shard_requests", value); } /// - /// The minimum version of the node that can handle the request
Any handling node with a lower version will fail the request. + /// + /// The minimum version of the node that can handle the request + /// Any handling node with a lower version will fail the request. + /// /// [JsonIgnore] public string? MinCompatibleShardNode { get => Q("min_compatible_shard_node"); set => Q("min_compatible_shard_node", value); } /// - /// Nodes and shards used for the search.
By default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are:
`_only_local` to run the search only on shards on the local node;
`_local` to, if possible, run the search on shards on the local node, or if not, select shards using the default method;
`_only_nodes:,` to run the search on only the specified nodes IDs, where, if suitable shards exist on more than one selected node, use shards on those nodes using the default method, or if none of the specified nodes are available, select shards from any available node using the default method;
`_prefer_nodes:,` to if possible, run the search on the specified nodes IDs, or if not, select shards using the default method;
`_shards:,` to run the search only on the specified shards;
`` (any string that does not start with `_`) to route searches with the same `` to the same shards in the same order. + /// + /// Nodes and shards used for the search. + /// By default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are: + /// _only_local to run the search only on shards on the local node; + /// _local to, if possible, run the search on shards on the local node, or if not, select shards using the default method; + /// _only_nodes:<node-id>,<node-id> to run the search on only the specified nodes IDs, where, if suitable shards exist on more than one selected node, use shards on those nodes using the default method, or if none of the specified nodes are available, select shards from any available node using the default method; + /// _prefer_nodes:<node-id>,<node-id> to if possible, run the search on the specified nodes IDs, or if not, select shards using the default method; + /// _shards:<shard>,<shard> to run the search only on the specified shards; + /// <custom-string> (any string that does not start with _) to route searches with the same <custom-string> to the same shards in the same order. + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold.
This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method (if date filters are mandatory to match but the shard bounds and the query are disjoint).
When unspecified, the pre-filter phase is executed if any of these conditions is met:
the request targets more than 128 shards;
the request targets one or more read-only index;
the primary sort of the query targets an indexed field. + /// + /// Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. + /// This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method (if date filters are mandatory to match but the shard bounds and the query are disjoint). + /// When unspecified, the pre-filter phase is executed if any of these conditions is met: + /// the request targets more than 128 shards; + /// the request targets one or more read-only index; + /// the primary sort of the query targets an indexed field. + /// /// [JsonIgnore] public long? PreFilterShardSize { get => Q("pre_filter_shard_size"); set => Q("pre_filter_shard_size", value); } /// - /// Query in the Lucene query string syntax using query parameter search.
Query parameter searches do not support the full Elasticsearch Query DSL but are handy for testing. + /// + /// Query in the Lucene query string syntax using query parameter search. + /// Query parameter searches do not support the full Elasticsearch Query DSL but are handy for testing. + /// /// [JsonIgnore] public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } /// - /// If `true`, the caching of search results is enabled for requests where `size` is `0`.
Defaults to index level settings. + /// + /// If true, the caching of search results is enabled for requests where size is 0. + /// Defaults to index level settings. + /// /// [JsonIgnore] public bool? RequestCache { get => Q("request_cache"); set => Q("request_cache", value); } /// - /// Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response. + /// + /// Indicates whether hits.total should be rendered as an integer or an object in the rest search response. + /// /// [JsonIgnore] public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Period to retain the search context for scrolling. See Scroll search results.
By default, this value cannot exceed `1d` (24 hours).
You can change this limit using the `search.max_keep_alive` cluster-level setting. + /// + /// Period to retain the search context for scrolling. See Scroll search results. + /// By default, this value cannot exceed 1d (24 hours). + /// You can change this limit using the search.max_keep_alive cluster-level setting. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); } /// - /// How distributed term frequencies are calculated for relevance scoring. + /// + /// How distributed term frequencies are calculated for relevance scoring. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } /// - /// A comma-separated list of source fields to exclude from the response.
You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.
If the `_source` parameter is `false`, this parameter is ignored. + /// + /// A comma-separated list of source fields to exclude from the response. + /// You can also use this parameter to exclude fields from the subset specified in _source_includes query parameter. + /// If the _source parameter is false, this parameter is ignored. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response.
If this parameter is specified, only these source fields are returned.
You can exclude fields from this subset using the `_source_excludes` query parameter.
If the `_source` parameter is `false`, this parameter is ignored. + /// + /// A comma-separated list of source fields to include in the response. + /// If this parameter is specified, only these source fields are returned. + /// You can exclude fields from this subset using the _source_excludes query parameter. + /// If the _source parameter is false, this parameter is ignored. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// Specifies which field to use for suggestions. + /// + /// Specifies which field to use for suggestions. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Field? SuggestField { get => Q("suggest_field"); set => Q("suggest_field", value); } /// - /// Specifies the suggest mode.
This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. + /// + /// Specifies the suggest mode. + /// This parameter can only be used when the suggest_field and suggest_text query string parameters are specified. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.SuggestMode? SuggestMode { get => Q("suggest_mode"); set => Q("suggest_mode", value); } /// - /// Number of suggestions to return.
This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. + /// + /// Number of suggestions to return. + /// This parameter can only be used when the suggest_field and suggest_text query string parameters are specified. + /// /// [JsonIgnore] public long? SuggestSize { get => Q("suggest_size"); set => Q("suggest_size", value); } /// - /// The source text for which the suggestions should be returned.
This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. + /// + /// The source text for which the suggestions should be returned. + /// This parameter can only be used when the suggest_field and suggest_text query string parameters are specified. + /// /// [JsonIgnore] public string? SuggestText { get => Q("suggest_text"); set => Q("suggest_text", value); } /// - /// If `true`, aggregation and suggester names are be prefixed by their respective types in the response. + /// + /// If true, aggregation and suggester names are be prefixed by their respective types in the response. + /// /// [JsonIgnore] public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } /// - /// Defines the aggregations that are run as part of the search request. + /// + /// Defines the aggregations that are run as part of the search request. + /// /// [JsonInclude, JsonPropertyName("aggregations")] public IDictionary? Aggregations { get; set; } /// - /// Collapses search results the values of the specified field. + /// + /// Collapses search results the values of the specified field. + /// /// [JsonInclude, JsonPropertyName("collapse")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.FieldCollapse? Collapse { get; set; } /// - /// Array of wildcard (`*`) patterns.
The request returns doc values for field names matching these patterns in the `hits.fields` property of the response. + /// + /// Array of wildcard (*) patterns. + /// The request returns doc values for field names matching these patterns in the hits.fields property of the response. + /// /// [JsonInclude, JsonPropertyName("docvalue_fields")] public ICollection? DocvalueFields { get; set; } /// - /// If true, returns detailed information about score computation as part of a hit. + /// + /// If true, returns detailed information about score computation as part of a hit. + /// /// [JsonInclude, JsonPropertyName("explain")] public bool? Explain { get; set; } /// - /// Configuration of search extensions defined by Elasticsearch plugins. + /// + /// Configuration of search extensions defined by Elasticsearch plugins. + /// /// [JsonInclude, JsonPropertyName("ext")] public IDictionary? Ext { get; set; } /// - /// Array of wildcard (`*`) patterns.
The request returns values for field names matching these patterns in the `hits.fields` property of the response. + /// + /// Array of wildcard (*) patterns. + /// The request returns values for field names matching these patterns in the hits.fields property of the response. + /// /// [JsonInclude, JsonPropertyName("fields")] public ICollection? Fields { get; set; } /// - /// Starting document offset.
Needs to be non-negative.
By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.
To page through more hits, use the `search_after` parameter. + /// + /// Starting document offset. + /// Needs to be non-negative. + /// By default, you cannot page through more than 10,000 hits using the from and size parameters. + /// To page through more hits, use the search_after parameter. + /// /// [JsonInclude, JsonPropertyName("from")] public int? From { get; set; } /// - /// Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results. + /// + /// Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results. + /// /// [JsonInclude, JsonPropertyName("highlight")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.Highlight? Highlight { get; set; } /// - /// Boosts the _score of documents from specified indices. + /// + /// Boosts the _score of documents from specified indices. + /// /// [JsonInclude, JsonPropertyName("indices_boost")] public ICollection>? IndicesBoost { get; set; } /// - /// Defines the approximate kNN search to run. + /// + /// Defines the approximate kNN search to run. + /// /// [JsonInclude, JsonPropertyName("knn")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.KnnSearch))] public ICollection? Knn { get; set; } /// - /// Minimum `_score` for matching documents.
Documents with a lower `_score` are not included in the search results. + /// + /// Minimum _score for matching documents. + /// Documents with a lower _score are not included in the search results. + /// /// [JsonInclude, JsonPropertyName("min_score")] public double? MinScore { get; set; } /// - /// Limits the search to a point in time (PIT).
If you provide a PIT, you cannot specify an `` in the request path. + /// + /// Limits the search to a point in time (PIT). + /// If you provide a PIT, you cannot specify an <index> in the request path. + /// /// [JsonInclude, JsonPropertyName("pit")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.PointInTimeReference? Pit { get; set; } /// - /// Use the `post_filter` parameter to filter search results.
The search hits are filtered after the aggregations are calculated.
A post filter has no impact on the aggregation results. + /// + /// Use the post_filter parameter to filter search results. + /// The search hits are filtered after the aggregations are calculated. + /// A post filter has no impact on the aggregation results. + /// /// [JsonInclude, JsonPropertyName("post_filter")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? PostFilter { get; set; } /// - /// Set to `true` to return detailed timing information about the execution of individual components in a search request.
NOTE: This is a debugging tool and adds significant overhead to search execution. + /// + /// Set to true to return detailed timing information about the execution of individual components in a search request. + /// NOTE: This is a debugging tool and adds significant overhead to search execution. + /// /// [JsonInclude, JsonPropertyName("profile")] public bool? Profile { get; set; } /// - /// Defines the search definition using the Query DSL. + /// + /// Defines the search definition using the Query DSL. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? Query { get; set; } /// - /// Defines the Reciprocal Rank Fusion (RRF) to use. + /// + /// Defines the Reciprocal Rank Fusion (RRF) to use. + /// /// [JsonInclude, JsonPropertyName("rank")] public Elastic.Clients.Elasticsearch.Serverless.Rank? Rank { get; set; } /// - /// Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases. + /// + /// Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the query and post_filter phases. + /// /// [JsonInclude, JsonPropertyName("rescore")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.Core.Search.Rescore))] public ICollection? Rescore { get; set; } /// - /// A retriever is a specification to describe top documents returned from a search. A retriever replaces other elements of the search API that also return top documents such as query and knn. + /// + /// A retriever is a specification to describe top documents returned from a search. A retriever replaces other elements of the search API that also return top documents such as query and knn. + /// /// [JsonInclude, JsonPropertyName("retriever")] public Elastic.Clients.Elasticsearch.Serverless.Retriever? Retriever { get; set; } /// - /// Defines one or more runtime fields in the search request.
These fields take precedence over mapped fields with the same name. + /// + /// Defines one or more runtime fields in the search request. + /// These fields take precedence over mapped fields with the same name. + /// /// [JsonInclude, JsonPropertyName("runtime_mappings")] public IDictionary? RuntimeMappings { get; set; } /// - /// Retrieve a script evaluation (based on different fields) for each hit. + /// + /// Retrieve a script evaluation (based on different fields) for each hit. + /// /// [JsonInclude, JsonPropertyName("script_fields")] public IDictionary? ScriptFields { get; set; } /// - /// Used to retrieve the next page of hits using a set of sort values from the previous page. + /// + /// Used to retrieve the next page of hits using a set of sort values from the previous page. + /// /// [JsonInclude, JsonPropertyName("search_after")] public ICollection? SearchAfter { get; set; } /// - /// If `true`, returns sequence number and primary term of the last modification of each hit. + /// + /// If true, returns sequence number and primary term of the last modification of each hit. + /// /// [JsonInclude, JsonPropertyName("seq_no_primary_term")] public bool? SeqNoPrimaryTerm { get; set; } /// - /// The number of hits to return.
By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.
To page through more hits, use the `search_after` parameter. + /// + /// The number of hits to return. + /// By default, you cannot page through more than 10,000 hits using the from and size parameters. + /// To page through more hits, use the search_after parameter. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// Can be used to split a scrolled search into multiple slices that can be consumed independently. + /// + /// Can be used to split a scrolled search into multiple slices that can be consumed independently. + /// /// [JsonInclude, JsonPropertyName("slice")] public Elastic.Clients.Elasticsearch.Serverless.SlicedScroll? Slice { get; set; } /// - /// A comma-separated list of : pairs. + /// + /// A comma-separated list of <field>:<direction> pairs. + /// /// [JsonInclude, JsonPropertyName("sort")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.SortOptions))] public ICollection? Sort { get; set; } /// - /// Indicates which source fields are returned for matching documents.
These fields are returned in the hits._source property of the search response. + /// + /// Indicates which source fields are returned for matching documents. + /// These fields are returned in the hits._source property of the search response. + /// /// [JsonInclude, JsonPropertyName("_source")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfig? Source { get; set; } /// - /// Stats groups to associate with the search.
Each group maintains a statistics aggregation for its associated searches.
You can retrieve these stats using the indices stats API. + /// + /// Stats groups to associate with the search. + /// Each group maintains a statistics aggregation for its associated searches. + /// You can retrieve these stats using the indices stats API. + /// /// [JsonInclude, JsonPropertyName("stats")] public ICollection? Stats { get; set; } /// - /// List of stored fields to return as part of a hit.
If no fields are specified, no stored fields are included in the response.
If this field is specified, the `_source` parameter defaults to `false`.
You can pass `_source: true` to return both source fields and stored fields in the search response. + /// + /// List of stored fields to return as part of a hit. + /// If no fields are specified, no stored fields are included in the response. + /// If this field is specified, the _source parameter defaults to false. + /// You can pass _source: true to return both source fields and stored fields in the search response. + /// /// [JsonInclude, JsonPropertyName("stored_fields")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] public Elastic.Clients.Elasticsearch.Serverless.Fields? StoredFields { get; set; } /// - /// Defines a suggester that provides similar looking terms based on a provided text. + /// + /// Defines a suggester that provides similar looking terms based on a provided text. + /// /// [JsonInclude, JsonPropertyName("suggest")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.Suggester? Suggest { get; set; } /// - /// Maximum number of documents to collect for each shard.
If a query reaches this limit, Elasticsearch terminates the query early.
Elasticsearch collects documents before sorting.
Use with caution.
Elasticsearch applies this parameter to each shard handling the request.
When possible, let Elasticsearch perform early termination automatically.
Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.
If set to `0` (default), the query does not terminate early. + /// + /// Maximum number of documents to collect for each shard. + /// If a query reaches this limit, Elasticsearch terminates the query early. + /// Elasticsearch collects documents before sorting. + /// Use with caution. + /// Elasticsearch applies this parameter to each shard handling the request. + /// When possible, let Elasticsearch perform early termination automatically. + /// Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + /// If set to 0 (default), the query does not terminate early. + /// /// [JsonInclude, JsonPropertyName("terminate_after")] public long? TerminateAfter { get; set; } /// - /// Specifies the period of time to wait for a response from each shard.
If no response is received before the timeout expires, the request fails and returns an error.
Defaults to no timeout. + /// + /// Specifies the period of time to wait for a response from each shard. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// Defaults to no timeout. + /// /// [JsonInclude, JsonPropertyName("timeout")] public string? Timeout { get; set; } /// - /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// + /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// /// [JsonInclude, JsonPropertyName("track_scores")] public bool? TrackScores { get; set; } /// - /// Number of hits matching the query to count accurately.
If `true`, the exact number of hits is returned at the cost of some performance.
If `false`, the response does not include the total number of hits matching the query. + /// + /// Number of hits matching the query to count accurately. + /// If true, the exact number of hits is returned at the cost of some performance. + /// If false, the response does not include the total number of hits matching the query. + /// /// [JsonInclude, JsonPropertyName("track_total_hits")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.TrackHits? TrackTotalHits { get; set; } /// - /// If true, returns document version as part of a hit. + /// + /// If true, returns document version as part of a hit. + /// /// [JsonInclude, JsonPropertyName("version")] public bool? Version { get; set; } } /// -/// Returns search hits that match the query defined in the request.
You can provide search queries using the `q` query string parameter or the request body.
If both are specified, only the query parameter is used. +/// +/// Returns search hits that match the query defined in the request. +/// You can provide search queries using the q query string parameter or the request body. +/// If both are specified, only the query parameter is used. +/// /// public sealed partial class SearchRequestDescriptor : RequestDescriptor, SearchRequestParameters> { @@ -1142,7 +1436,9 @@ public SearchRequestDescriptor Indices(Elastic.Clients.Elasticsearch. private bool? VersionValue { get; set; } /// - /// Defines the aggregations that are run as part of the search request. + /// + /// Defines the aggregations that are run as part of the search request. + /// /// public SearchRequestDescriptor Aggregations(Func>, FluentDescriptorDictionary>> selector) { @@ -1151,7 +1447,9 @@ public SearchRequestDescriptor Aggregations(Func - /// Collapses search results the values of the specified field. + /// + /// Collapses search results the values of the specified field. + /// /// public SearchRequestDescriptor Collapse(Elastic.Clients.Elasticsearch.Serverless.Core.Search.FieldCollapse? collapse) { @@ -1178,7 +1476,10 @@ public SearchRequestDescriptor Collapse(Action - /// Array of wildcard (`*`) patterns.
The request returns doc values for field names matching these patterns in the `hits.fields` property of the response. + /// + /// Array of wildcard (*) patterns. + /// The request returns doc values for field names matching these patterns in the hits.fields property of the response. + /// /// public SearchRequestDescriptor DocvalueFields(ICollection? docvalueFields) { @@ -1217,7 +1518,9 @@ public SearchRequestDescriptor DocvalueFields(params Action - /// If true, returns detailed information about score computation as part of a hit. + /// + /// If true, returns detailed information about score computation as part of a hit. + /// /// public SearchRequestDescriptor Explain(bool? explain = true) { @@ -1226,7 +1529,9 @@ public SearchRequestDescriptor Explain(bool? explain = true) } /// - /// Configuration of search extensions defined by Elasticsearch plugins. + /// + /// Configuration of search extensions defined by Elasticsearch plugins. + /// /// public SearchRequestDescriptor Ext(Func, FluentDictionary> selector) { @@ -1235,7 +1540,10 @@ public SearchRequestDescriptor Ext(Func - /// Array of wildcard (`*`) patterns.
The request returns values for field names matching these patterns in the `hits.fields` property of the response. + /// + /// Array of wildcard (*) patterns. + /// The request returns values for field names matching these patterns in the hits.fields property of the response. + /// /// public SearchRequestDescriptor Fields(ICollection? fields) { @@ -1274,7 +1582,12 @@ public SearchRequestDescriptor Fields(params Action - /// Starting document offset.
Needs to be non-negative.
By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.
To page through more hits, use the `search_after` parameter. + /// + /// Starting document offset. + /// Needs to be non-negative. + /// By default, you cannot page through more than 10,000 hits using the from and size parameters. + /// To page through more hits, use the search_after parameter. + /// /// public SearchRequestDescriptor From(int? from) { @@ -1283,7 +1596,9 @@ public SearchRequestDescriptor From(int? from) } /// - /// Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results. + /// + /// Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results. + /// /// public SearchRequestDescriptor Highlight(Elastic.Clients.Elasticsearch.Serverless.Core.Search.Highlight? highlight) { @@ -1310,7 +1625,9 @@ public SearchRequestDescriptor Highlight(Action - /// Boosts the _score of documents from specified indices. + /// + /// Boosts the _score of documents from specified indices. + /// /// public SearchRequestDescriptor IndicesBoost(ICollection>? indicesBoost) { @@ -1319,7 +1636,9 @@ public SearchRequestDescriptor IndicesBoost(ICollection - /// Defines the approximate kNN search to run. + /// + /// Defines the approximate kNN search to run. + /// /// public SearchRequestDescriptor Knn(ICollection? knn) { @@ -1358,7 +1677,10 @@ public SearchRequestDescriptor Knn(params Action - /// Minimum `_score` for matching documents.
Documents with a lower `_score` are not included in the search results. + /// + /// Minimum _score for matching documents. + /// Documents with a lower _score are not included in the search results. + /// /// public SearchRequestDescriptor MinScore(double? minScore) { @@ -1367,7 +1689,10 @@ public SearchRequestDescriptor MinScore(double? minScore) } /// - /// Limits the search to a point in time (PIT).
If you provide a PIT, you cannot specify an `` in the request path. + /// + /// Limits the search to a point in time (PIT). + /// If you provide a PIT, you cannot specify an <index> in the request path. + /// /// public SearchRequestDescriptor Pit(Elastic.Clients.Elasticsearch.Serverless.Core.Search.PointInTimeReference? pit) { @@ -1394,7 +1719,11 @@ public SearchRequestDescriptor Pit(Action - /// Use the `post_filter` parameter to filter search results.
The search hits are filtered after the aggregations are calculated.
A post filter has no impact on the aggregation results. + /// + /// Use the post_filter parameter to filter search results. + /// The search hits are filtered after the aggregations are calculated. + /// A post filter has no impact on the aggregation results. + /// /// public SearchRequestDescriptor PostFilter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? postFilter) { @@ -1421,7 +1750,10 @@ public SearchRequestDescriptor PostFilter(Action - /// Set to `true` to return detailed timing information about the execution of individual components in a search request.
NOTE: This is a debugging tool and adds significant overhead to search execution. + /// + /// Set to true to return detailed timing information about the execution of individual components in a search request. + /// NOTE: This is a debugging tool and adds significant overhead to search execution. + /// /// public SearchRequestDescriptor Profile(bool? profile = true) { @@ -1430,7 +1762,9 @@ public SearchRequestDescriptor Profile(bool? profile = true) } /// - /// Defines the search definition using the Query DSL. + /// + /// Defines the search definition using the Query DSL. + /// /// public SearchRequestDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -1457,7 +1791,9 @@ public SearchRequestDescriptor Query(Action - /// Defines the Reciprocal Rank Fusion (RRF) to use. + /// + /// Defines the Reciprocal Rank Fusion (RRF) to use. + /// /// public SearchRequestDescriptor Rank(Elastic.Clients.Elasticsearch.Serverless.Rank? rank) { @@ -1484,7 +1820,9 @@ public SearchRequestDescriptor Rank(Action - /// Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases. + /// + /// Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the query and post_filter phases. + /// /// public SearchRequestDescriptor Rescore(ICollection? rescore) { @@ -1523,7 +1861,9 @@ public SearchRequestDescriptor Rescore(params Action - /// A retriever is a specification to describe top documents returned from a search. A retriever replaces other elements of the search API that also return top documents such as query and knn. + /// + /// A retriever is a specification to describe top documents returned from a search. A retriever replaces other elements of the search API that also return top documents such as query and knn. + /// /// public SearchRequestDescriptor Retriever(Elastic.Clients.Elasticsearch.Serverless.Retriever? retriever) { @@ -1550,7 +1890,10 @@ public SearchRequestDescriptor Retriever(Action - /// Defines one or more runtime fields in the search request.
These fields take precedence over mapped fields with the same name. + /// + /// Defines one or more runtime fields in the search request. + /// These fields take precedence over mapped fields with the same name. + /// /// public SearchRequestDescriptor RuntimeMappings(Func>, FluentDescriptorDictionary>> selector) { @@ -1559,7 +1902,9 @@ public SearchRequestDescriptor RuntimeMappings(Func - /// Retrieve a script evaluation (based on different fields) for each hit. + /// + /// Retrieve a script evaluation (based on different fields) for each hit. + /// /// public SearchRequestDescriptor ScriptFields(Func, FluentDescriptorDictionary> selector) { @@ -1568,7 +1913,9 @@ public SearchRequestDescriptor ScriptFields(Func - /// Used to retrieve the next page of hits using a set of sort values from the previous page. + /// + /// Used to retrieve the next page of hits using a set of sort values from the previous page. + /// /// public SearchRequestDescriptor SearchAfter(ICollection? searchAfter) { @@ -1577,7 +1924,9 @@ public SearchRequestDescriptor SearchAfter(ICollection - /// If `true`, returns sequence number and primary term of the last modification of each hit. + /// + /// If true, returns sequence number and primary term of the last modification of each hit. + /// /// public SearchRequestDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = true) { @@ -1586,7 +1935,11 @@ public SearchRequestDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTer } /// - /// The number of hits to return.
By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.
To page through more hits, use the `search_after` parameter. + /// + /// The number of hits to return. + /// By default, you cannot page through more than 10,000 hits using the from and size parameters. + /// To page through more hits, use the search_after parameter. + /// /// public SearchRequestDescriptor Size(int? size) { @@ -1595,7 +1948,9 @@ public SearchRequestDescriptor Size(int? size) } /// - /// Can be used to split a scrolled search into multiple slices that can be consumed independently. + /// + /// Can be used to split a scrolled search into multiple slices that can be consumed independently. + /// /// public SearchRequestDescriptor Slice(Elastic.Clients.Elasticsearch.Serverless.SlicedScroll? slice) { @@ -1622,7 +1977,9 @@ public SearchRequestDescriptor Slice(Action - /// A comma-separated list of : pairs. + /// + /// A comma-separated list of <field>:<direction> pairs. + /// /// public SearchRequestDescriptor Sort(ICollection? sort) { @@ -1661,7 +2018,10 @@ public SearchRequestDescriptor Sort(params Action - /// Indicates which source fields are returned for matching documents.
These fields are returned in the hits._source property of the search response. + /// + /// Indicates which source fields are returned for matching documents. + /// These fields are returned in the hits._source property of the search response. + /// /// public SearchRequestDescriptor Source(Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfig? source) { @@ -1670,7 +2030,11 @@ public SearchRequestDescriptor Source(Elastic.Clients.Elasticsearch.S } /// - /// Stats groups to associate with the search.
Each group maintains a statistics aggregation for its associated searches.
You can retrieve these stats using the indices stats API. + /// + /// Stats groups to associate with the search. + /// Each group maintains a statistics aggregation for its associated searches. + /// You can retrieve these stats using the indices stats API. + /// /// public SearchRequestDescriptor Stats(ICollection? stats) { @@ -1679,7 +2043,12 @@ public SearchRequestDescriptor Stats(ICollection? stats) } /// - /// List of stored fields to return as part of a hit.
If no fields are specified, no stored fields are included in the response.
If this field is specified, the `_source` parameter defaults to `false`.
You can pass `_source: true` to return both source fields and stored fields in the search response. + /// + /// List of stored fields to return as part of a hit. + /// If no fields are specified, no stored fields are included in the response. + /// If this field is specified, the _source parameter defaults to false. + /// You can pass _source: true to return both source fields and stored fields in the search response. + /// /// public SearchRequestDescriptor StoredFields(Elastic.Clients.Elasticsearch.Serverless.Fields? storedFields) { @@ -1688,7 +2057,9 @@ public SearchRequestDescriptor StoredFields(Elastic.Clients.Elasticse } /// - /// Defines a suggester that provides similar looking terms based on a provided text. + /// + /// Defines a suggester that provides similar looking terms based on a provided text. + /// /// public SearchRequestDescriptor Suggest(Elastic.Clients.Elasticsearch.Serverless.Core.Search.Suggester? suggest) { @@ -1715,7 +2086,16 @@ public SearchRequestDescriptor Suggest(Action - /// Maximum number of documents to collect for each shard.
If a query reaches this limit, Elasticsearch terminates the query early.
Elasticsearch collects documents before sorting.
Use with caution.
Elasticsearch applies this parameter to each shard handling the request.
When possible, let Elasticsearch perform early termination automatically.
Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.
If set to `0` (default), the query does not terminate early. + /// + /// Maximum number of documents to collect for each shard. + /// If a query reaches this limit, Elasticsearch terminates the query early. + /// Elasticsearch collects documents before sorting. + /// Use with caution. + /// Elasticsearch applies this parameter to each shard handling the request. + /// When possible, let Elasticsearch perform early termination automatically. + /// Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + /// If set to 0 (default), the query does not terminate early. + /// /// public SearchRequestDescriptor TerminateAfter(long? terminateAfter) { @@ -1724,7 +2104,11 @@ public SearchRequestDescriptor TerminateAfter(long? terminateAfter) } /// - /// Specifies the period of time to wait for a response from each shard.
If no response is received before the timeout expires, the request fails and returns an error.
Defaults to no timeout. + /// + /// Specifies the period of time to wait for a response from each shard. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// Defaults to no timeout. + /// /// public SearchRequestDescriptor Timeout(string? timeout) { @@ -1733,7 +2117,9 @@ public SearchRequestDescriptor Timeout(string? timeout) } /// - /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// + /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// /// public SearchRequestDescriptor TrackScores(bool? trackScores = true) { @@ -1742,7 +2128,11 @@ public SearchRequestDescriptor TrackScores(bool? trackScores = true) } /// - /// Number of hits matching the query to count accurately.
If `true`, the exact number of hits is returned at the cost of some performance.
If `false`, the response does not include the total number of hits matching the query. + /// + /// Number of hits matching the query to count accurately. + /// If true, the exact number of hits is returned at the cost of some performance. + /// If false, the response does not include the total number of hits matching the query. + /// /// public SearchRequestDescriptor TrackTotalHits(Elastic.Clients.Elasticsearch.Serverless.Core.Search.TrackHits? trackTotalHits) { @@ -1751,7 +2141,9 @@ public SearchRequestDescriptor TrackTotalHits(Elastic.Clients.Elastic } /// - /// If true, returns document version as part of a hit. + /// + /// If true, returns document version as part of a hit. + /// /// public SearchRequestDescriptor Version(bool? version = true) { @@ -2180,7 +2572,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns search hits that match the query defined in the request.
You can provide search queries using the `q` query string parameter or the request body.
If both are specified, only the query parameter is used. +/// +/// Returns search hits that match the query defined in the request. +/// You can provide search queries using the q query string parameter or the request body. +/// If both are specified, only the query parameter is used. +/// /// public sealed partial class SearchRequestDescriptor : RequestDescriptor { @@ -2307,7 +2703,9 @@ public SearchRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless. private bool? VersionValue { get; set; } /// - /// Defines the aggregations that are run as part of the search request. + /// + /// Defines the aggregations that are run as part of the search request. + /// /// public SearchRequestDescriptor Aggregations(Func, FluentDescriptorDictionary> selector) { @@ -2316,7 +2714,9 @@ public SearchRequestDescriptor Aggregations(Func - /// Collapses search results the values of the specified field. + /// + /// Collapses search results the values of the specified field. + /// /// public SearchRequestDescriptor Collapse(Elastic.Clients.Elasticsearch.Serverless.Core.Search.FieldCollapse? collapse) { @@ -2343,7 +2743,10 @@ public SearchRequestDescriptor Collapse(Action - /// Array of wildcard (`*`) patterns.
The request returns doc values for field names matching these patterns in the `hits.fields` property of the response. + /// + /// Array of wildcard (*) patterns. + /// The request returns doc values for field names matching these patterns in the hits.fields property of the response. + /// /// public SearchRequestDescriptor DocvalueFields(ICollection? docvalueFields) { @@ -2382,7 +2785,9 @@ public SearchRequestDescriptor DocvalueFields(params Action - /// If true, returns detailed information about score computation as part of a hit. + /// + /// If true, returns detailed information about score computation as part of a hit. + /// /// public SearchRequestDescriptor Explain(bool? explain = true) { @@ -2391,7 +2796,9 @@ public SearchRequestDescriptor Explain(bool? explain = true) } /// - /// Configuration of search extensions defined by Elasticsearch plugins. + /// + /// Configuration of search extensions defined by Elasticsearch plugins. + /// /// public SearchRequestDescriptor Ext(Func, FluentDictionary> selector) { @@ -2400,7 +2807,10 @@ public SearchRequestDescriptor Ext(Func, Fluent } /// - /// Array of wildcard (`*`) patterns.
The request returns values for field names matching these patterns in the `hits.fields` property of the response. + /// + /// Array of wildcard (*) patterns. + /// The request returns values for field names matching these patterns in the hits.fields property of the response. + /// /// public SearchRequestDescriptor Fields(ICollection? fields) { @@ -2439,7 +2849,12 @@ public SearchRequestDescriptor Fields(params Action - /// Starting document offset.
Needs to be non-negative.
By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.
To page through more hits, use the `search_after` parameter. + /// + /// Starting document offset. + /// Needs to be non-negative. + /// By default, you cannot page through more than 10,000 hits using the from and size parameters. + /// To page through more hits, use the search_after parameter. + /// /// public SearchRequestDescriptor From(int? from) { @@ -2448,7 +2863,9 @@ public SearchRequestDescriptor From(int? from) } /// - /// Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results. + /// + /// Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results. + /// /// public SearchRequestDescriptor Highlight(Elastic.Clients.Elasticsearch.Serverless.Core.Search.Highlight? highlight) { @@ -2475,7 +2892,9 @@ public SearchRequestDescriptor Highlight(Action - /// Boosts the _score of documents from specified indices. + /// + /// Boosts the _score of documents from specified indices. + /// /// public SearchRequestDescriptor IndicesBoost(ICollection>? indicesBoost) { @@ -2484,7 +2903,9 @@ public SearchRequestDescriptor IndicesBoost(ICollection - /// Defines the approximate kNN search to run. + /// + /// Defines the approximate kNN search to run. + /// /// public SearchRequestDescriptor Knn(ICollection? knn) { @@ -2523,7 +2944,10 @@ public SearchRequestDescriptor Knn(params Action - /// Minimum `_score` for matching documents.
Documents with a lower `_score` are not included in the search results. + /// + /// Minimum _score for matching documents. + /// Documents with a lower _score are not included in the search results. + /// /// public SearchRequestDescriptor MinScore(double? minScore) { @@ -2532,7 +2956,10 @@ public SearchRequestDescriptor MinScore(double? minScore) } /// - /// Limits the search to a point in time (PIT).
If you provide a PIT, you cannot specify an `` in the request path. + /// + /// Limits the search to a point in time (PIT). + /// If you provide a PIT, you cannot specify an <index> in the request path. + /// /// public SearchRequestDescriptor Pit(Elastic.Clients.Elasticsearch.Serverless.Core.Search.PointInTimeReference? pit) { @@ -2559,7 +2986,11 @@ public SearchRequestDescriptor Pit(Action - /// Use the `post_filter` parameter to filter search results.
The search hits are filtered after the aggregations are calculated.
A post filter has no impact on the aggregation results. + /// + /// Use the post_filter parameter to filter search results. + /// The search hits are filtered after the aggregations are calculated. + /// A post filter has no impact on the aggregation results. + /// /// public SearchRequestDescriptor PostFilter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? postFilter) { @@ -2586,7 +3017,10 @@ public SearchRequestDescriptor PostFilter(Action - /// Set to `true` to return detailed timing information about the execution of individual components in a search request.
NOTE: This is a debugging tool and adds significant overhead to search execution. + /// + /// Set to true to return detailed timing information about the execution of individual components in a search request. + /// NOTE: This is a debugging tool and adds significant overhead to search execution. + /// /// public SearchRequestDescriptor Profile(bool? profile = true) { @@ -2595,7 +3029,9 @@ public SearchRequestDescriptor Profile(bool? profile = true) } /// - /// Defines the search definition using the Query DSL. + /// + /// Defines the search definition using the Query DSL. + /// /// public SearchRequestDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -2622,7 +3058,9 @@ public SearchRequestDescriptor Query(Action - /// Defines the Reciprocal Rank Fusion (RRF) to use. + /// + /// Defines the Reciprocal Rank Fusion (RRF) to use. + /// /// public SearchRequestDescriptor Rank(Elastic.Clients.Elasticsearch.Serverless.Rank? rank) { @@ -2649,7 +3087,9 @@ public SearchRequestDescriptor Rank(Action - /// Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases. + /// + /// Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the query and post_filter phases. + /// /// public SearchRequestDescriptor Rescore(ICollection? rescore) { @@ -2688,7 +3128,9 @@ public SearchRequestDescriptor Rescore(params Action - /// A retriever is a specification to describe top documents returned from a search. A retriever replaces other elements of the search API that also return top documents such as query and knn. + /// + /// A retriever is a specification to describe top documents returned from a search. A retriever replaces other elements of the search API that also return top documents such as query and knn. + /// /// public SearchRequestDescriptor Retriever(Elastic.Clients.Elasticsearch.Serverless.Retriever? retriever) { @@ -2715,7 +3157,10 @@ public SearchRequestDescriptor Retriever(Action - /// Defines one or more runtime fields in the search request.
These fields take precedence over mapped fields with the same name. + /// + /// Defines one or more runtime fields in the search request. + /// These fields take precedence over mapped fields with the same name. + /// /// public SearchRequestDescriptor RuntimeMappings(Func, FluentDescriptorDictionary> selector) { @@ -2724,7 +3169,9 @@ public SearchRequestDescriptor RuntimeMappings(Func - /// Retrieve a script evaluation (based on different fields) for each hit. + /// + /// Retrieve a script evaluation (based on different fields) for each hit. + /// /// public SearchRequestDescriptor ScriptFields(Func, FluentDescriptorDictionary> selector) { @@ -2733,7 +3180,9 @@ public SearchRequestDescriptor ScriptFields(Func - /// Used to retrieve the next page of hits using a set of sort values from the previous page. + /// + /// Used to retrieve the next page of hits using a set of sort values from the previous page. + /// /// public SearchRequestDescriptor SearchAfter(ICollection? searchAfter) { @@ -2742,7 +3191,9 @@ public SearchRequestDescriptor SearchAfter(ICollection - /// If `true`, returns sequence number and primary term of the last modification of each hit. + /// + /// If true, returns sequence number and primary term of the last modification of each hit. + /// /// public SearchRequestDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = true) { @@ -2751,7 +3202,11 @@ public SearchRequestDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = true) } /// - /// The number of hits to return.
By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.
To page through more hits, use the `search_after` parameter. + /// + /// The number of hits to return. + /// By default, you cannot page through more than 10,000 hits using the from and size parameters. + /// To page through more hits, use the search_after parameter. + /// /// public SearchRequestDescriptor Size(int? size) { @@ -2760,7 +3215,9 @@ public SearchRequestDescriptor Size(int? size) } /// - /// Can be used to split a scrolled search into multiple slices that can be consumed independently. + /// + /// Can be used to split a scrolled search into multiple slices that can be consumed independently. + /// /// public SearchRequestDescriptor Slice(Elastic.Clients.Elasticsearch.Serverless.SlicedScroll? slice) { @@ -2787,7 +3244,9 @@ public SearchRequestDescriptor Slice(Action - /// A comma-separated list of : pairs. + /// + /// A comma-separated list of <field>:<direction> pairs. + /// /// public SearchRequestDescriptor Sort(ICollection? sort) { @@ -2826,7 +3285,10 @@ public SearchRequestDescriptor Sort(params Action - /// Indicates which source fields are returned for matching documents.
These fields are returned in the hits._source property of the search response. + /// + /// Indicates which source fields are returned for matching documents. + /// These fields are returned in the hits._source property of the search response. + /// /// public SearchRequestDescriptor Source(Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfig? source) { @@ -2835,7 +3297,11 @@ public SearchRequestDescriptor Source(Elastic.Clients.Elasticsearch.Serverless.C } /// - /// Stats groups to associate with the search.
Each group maintains a statistics aggregation for its associated searches.
You can retrieve these stats using the indices stats API. + /// + /// Stats groups to associate with the search. + /// Each group maintains a statistics aggregation for its associated searches. + /// You can retrieve these stats using the indices stats API. + /// /// public SearchRequestDescriptor Stats(ICollection? stats) { @@ -2844,7 +3310,12 @@ public SearchRequestDescriptor Stats(ICollection? stats) } /// - /// List of stored fields to return as part of a hit.
If no fields are specified, no stored fields are included in the response.
If this field is specified, the `_source` parameter defaults to `false`.
You can pass `_source: true` to return both source fields and stored fields in the search response. + /// + /// List of stored fields to return as part of a hit. + /// If no fields are specified, no stored fields are included in the response. + /// If this field is specified, the _source parameter defaults to false. + /// You can pass _source: true to return both source fields and stored fields in the search response. + /// /// public SearchRequestDescriptor StoredFields(Elastic.Clients.Elasticsearch.Serverless.Fields? storedFields) { @@ -2853,7 +3324,9 @@ public SearchRequestDescriptor StoredFields(Elastic.Clients.Elasticsearch.Server } /// - /// Defines a suggester that provides similar looking terms based on a provided text. + /// + /// Defines a suggester that provides similar looking terms based on a provided text. + /// /// public SearchRequestDescriptor Suggest(Elastic.Clients.Elasticsearch.Serverless.Core.Search.Suggester? suggest) { @@ -2880,7 +3353,16 @@ public SearchRequestDescriptor Suggest(Action - /// Maximum number of documents to collect for each shard.
If a query reaches this limit, Elasticsearch terminates the query early.
Elasticsearch collects documents before sorting.
Use with caution.
Elasticsearch applies this parameter to each shard handling the request.
When possible, let Elasticsearch perform early termination automatically.
Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.
If set to `0` (default), the query does not terminate early. + /// + /// Maximum number of documents to collect for each shard. + /// If a query reaches this limit, Elasticsearch terminates the query early. + /// Elasticsearch collects documents before sorting. + /// Use with caution. + /// Elasticsearch applies this parameter to each shard handling the request. + /// When possible, let Elasticsearch perform early termination automatically. + /// Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + /// If set to 0 (default), the query does not terminate early. + /// /// public SearchRequestDescriptor TerminateAfter(long? terminateAfter) { @@ -2889,7 +3371,11 @@ public SearchRequestDescriptor TerminateAfter(long? terminateAfter) } /// - /// Specifies the period of time to wait for a response from each shard.
If no response is received before the timeout expires, the request fails and returns an error.
Defaults to no timeout. + /// + /// Specifies the period of time to wait for a response from each shard. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// Defaults to no timeout. + /// /// public SearchRequestDescriptor Timeout(string? timeout) { @@ -2898,7 +3384,9 @@ public SearchRequestDescriptor Timeout(string? timeout) } /// - /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// + /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// /// public SearchRequestDescriptor TrackScores(bool? trackScores = true) { @@ -2907,7 +3395,11 @@ public SearchRequestDescriptor TrackScores(bool? trackScores = true) } /// - /// Number of hits matching the query to count accurately.
If `true`, the exact number of hits is returned at the cost of some performance.
If `false`, the response does not include the total number of hits matching the query. + /// + /// Number of hits matching the query to count accurately. + /// If true, the exact number of hits is returned at the cost of some performance. + /// If false, the response does not include the total number of hits matching the query. + /// /// public SearchRequestDescriptor TrackTotalHits(Elastic.Clients.Elasticsearch.Serverless.Core.Search.TrackHits? trackTotalHits) { @@ -2916,7 +3408,9 @@ public SearchRequestDescriptor TrackTotalHits(Elastic.Clients.Elasticsearch.Serv } /// - /// If true, returns document version as part of a hit. + /// + /// If true, returns document version as part of a hit. + /// /// public SearchRequestDescriptor Version(bool? version = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SearchTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SearchTemplateRequest.g.cs index e8ea4bcab4e..9cd5b268e2c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SearchTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SearchTemplateRequest.g.cs @@ -32,63 +32,94 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class SearchTemplateRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices.
For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// If `true`, network round-trips are minimized for cross-cluster search requests. + /// + /// If true, network round-trips are minimized for cross-cluster search requests. + /// /// public bool? CcsMinimizeRoundtrips { get => Q("ccs_minimize_roundtrips"); set => Q("ccs_minimize_roundtrips", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled. + /// + /// If true, specified concrete, expanded, or aliased indices are not included in the response when throttled. + /// /// public bool? IgnoreThrottled { get => Q("ignore_throttled"); set => Q("ignore_throttled", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If true, hits.total are rendered as an integer in the response. + /// + /// If true, hits.total are rendered as an integer in the response. + /// /// public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Specifies how long a consistent view of the index
should be maintained for scrolled search. + /// + /// Specifies how long a consistent view of the index + /// should be maintained for scrolled search. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); } /// - /// The type of the search operation. + /// + /// The type of the search operation. + /// /// public Elastic.Clients.Elasticsearch.Serverless.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } /// - /// If `true`, the response prefixes aggregation and suggester names with their respective types. + /// + /// If true, the response prefixes aggregation and suggester names with their respective types. + /// /// public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } } /// -/// Runs a search with a search template. +/// +/// Runs a search with a search template. +/// /// public sealed partial class SearchTemplateRequest : PlainRequest { @@ -109,104 +140,150 @@ public SearchTemplateRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? i internal override string OperationName => "search_template"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices.
For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// If `true`, network round-trips are minimized for cross-cluster search requests. + /// + /// If true, network round-trips are minimized for cross-cluster search requests. + /// /// [JsonIgnore] public bool? CcsMinimizeRoundtrips { get => Q("ccs_minimize_roundtrips"); set => Q("ccs_minimize_roundtrips", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled. + /// + /// If true, specified concrete, expanded, or aliased indices are not included in the response when throttled. + /// /// [JsonIgnore] public bool? IgnoreThrottled { get => Q("ignore_throttled"); set => Q("ignore_throttled", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If true, hits.total are rendered as an integer in the response. + /// + /// If true, hits.total are rendered as an integer in the response. + /// /// [JsonIgnore] public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Specifies how long a consistent view of the index
should be maintained for scrolled search. + /// + /// Specifies how long a consistent view of the index + /// should be maintained for scrolled search. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); } /// - /// The type of the search operation. + /// + /// The type of the search operation. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } /// - /// If `true`, the response prefixes aggregation and suggester names with their respective types. + /// + /// If true, the response prefixes aggregation and suggester names with their respective types. + /// /// [JsonIgnore] public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } /// - /// If `true`, returns detailed information about score calculation as part of each hit. + /// + /// If true, returns detailed information about score calculation as part of each hit. + /// /// [JsonInclude, JsonPropertyName("explain")] public bool? Explain { get; set; } /// - /// ID of the search template to use. If no source is specified,
this parameter is required. + /// + /// ID of the search template to use. If no source is specified, + /// this parameter is required. + /// /// [JsonInclude, JsonPropertyName("id")] public Elastic.Clients.Elasticsearch.Serverless.Id? Id { get; set; } /// - /// Key-value pairs used to replace Mustache variables in the template.
The key is the variable name.
The value is the variable value. + /// + /// Key-value pairs used to replace Mustache variables in the template. + /// The key is the variable name. + /// The value is the variable value. + /// /// [JsonInclude, JsonPropertyName("params")] public IDictionary? Params { get; set; } /// - /// If `true`, the query execution is profiled. + /// + /// If true, the query execution is profiled. + /// /// [JsonInclude, JsonPropertyName("profile")] public bool? Profile { get; set; } /// - /// An inline search template. Supports the same parameters as the search API's
request body. Also supports Mustache variables. If no id is specified, this
parameter is required. + /// + /// An inline search template. Supports the same parameters as the search API's + /// request body. Also supports Mustache variables. If no id is specified, this + /// parameter is required. + /// /// [JsonInclude, JsonPropertyName("source")] public string? Source { get; set; } } /// -/// Runs a search with a search template. +/// +/// Runs a search with a search template. +/// /// public sealed partial class SearchTemplateRequestDescriptor : RequestDescriptor, SearchTemplateRequestParameters> { @@ -253,7 +330,9 @@ public SearchTemplateRequestDescriptor Indices(Elastic.Clients.Elasti private string? SourceValue { get; set; } /// - /// If `true`, returns detailed information about score calculation as part of each hit. + /// + /// If true, returns detailed information about score calculation as part of each hit. + /// /// public SearchTemplateRequestDescriptor Explain(bool? explain = true) { @@ -262,7 +341,10 @@ public SearchTemplateRequestDescriptor Explain(bool? explain = true) } /// - /// ID of the search template to use. If no source is specified,
this parameter is required. + /// + /// ID of the search template to use. If no source is specified, + /// this parameter is required. + /// /// public SearchTemplateRequestDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id? id) { @@ -271,7 +353,11 @@ public SearchTemplateRequestDescriptor Id(Elastic.Clients.Elasticsear } /// - /// Key-value pairs used to replace Mustache variables in the template.
The key is the variable name.
The value is the variable value. + /// + /// Key-value pairs used to replace Mustache variables in the template. + /// The key is the variable name. + /// The value is the variable value. + /// /// public SearchTemplateRequestDescriptor Params(Func, FluentDictionary> selector) { @@ -280,7 +366,9 @@ public SearchTemplateRequestDescriptor Params(Func - /// If `true`, the query execution is profiled. + /// + /// If true, the query execution is profiled. + /// /// public SearchTemplateRequestDescriptor Profile(bool? profile = true) { @@ -289,7 +377,11 @@ public SearchTemplateRequestDescriptor Profile(bool? profile = true) } /// - /// An inline search template. Supports the same parameters as the search API's
request body. Also supports Mustache variables. If no id is specified, this
parameter is required. + /// + /// An inline search template. Supports the same parameters as the search API's + /// request body. Also supports Mustache variables. If no id is specified, this + /// parameter is required. + /// /// public SearchTemplateRequestDescriptor Source(string? source) { @@ -335,7 +427,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Runs a search with a search template. +/// +/// Runs a search with a search template. +/// /// public sealed partial class SearchTemplateRequestDescriptor : RequestDescriptor { @@ -382,7 +476,9 @@ public SearchTemplateRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Ser private string? SourceValue { get; set; } /// - /// If `true`, returns detailed information about score calculation as part of each hit. + /// + /// If true, returns detailed information about score calculation as part of each hit. + /// /// public SearchTemplateRequestDescriptor Explain(bool? explain = true) { @@ -391,7 +487,10 @@ public SearchTemplateRequestDescriptor Explain(bool? explain = true) } /// - /// ID of the search template to use. If no source is specified,
this parameter is required. + /// + /// ID of the search template to use. If no source is specified, + /// this parameter is required. + /// /// public SearchTemplateRequestDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id? id) { @@ -400,7 +499,11 @@ public SearchTemplateRequestDescriptor Id(Elastic.Clients.Elasticsearch.Serverle } /// - /// Key-value pairs used to replace Mustache variables in the template.
The key is the variable name.
The value is the variable value. + /// + /// Key-value pairs used to replace Mustache variables in the template. + /// The key is the variable name. + /// The value is the variable value. + /// /// public SearchTemplateRequestDescriptor Params(Func, FluentDictionary> selector) { @@ -409,7 +512,9 @@ public SearchTemplateRequestDescriptor Params(Func - /// If `true`, the query execution is profiled. + /// + /// If true, the query execution is profiled. + /// /// public SearchTemplateRequestDescriptor Profile(bool? profile = true) { @@ -418,7 +523,11 @@ public SearchTemplateRequestDescriptor Profile(bool? profile = true) } /// - /// An inline search template. Supports the same parameters as the search API's
request body. Also supports Mustache variables. If no id is specified, this
parameter is required. + /// + /// An inline search template. Supports the same parameters as the search API's + /// request body. Also supports Mustache variables. If no id is specified, this + /// parameter is required. + /// /// public SearchTemplateRequestDescriptor Source(string? source) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CleanupRepositoryRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CleanupRepositoryRequest.g.cs index 1bf200a80a2..dc3a32faf69 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CleanupRepositoryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CleanupRepositoryRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Snapshot; public sealed partial class CleanupRepositoryRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node. + /// + /// Period to wait for a connection to the master node. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. + /// + /// Period to wait for a response. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. +/// +/// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. +/// /// public sealed partial class CleanupRepositoryRequest : PlainRequest { @@ -60,20 +66,26 @@ public CleanupRepositoryRequest(Elastic.Clients.Elasticsearch.Serverless.Name na internal override string OperationName => "snapshot.cleanup_repository"; /// - /// Period to wait for a connection to the master node. + /// + /// Period to wait for a connection to the master node. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. + /// + /// Period to wait for a response. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. +/// +/// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. +/// /// public sealed partial class CleanupRepositoryRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CleanupRepositoryResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CleanupRepositoryResponse.g.cs index 557ac8f6305..55ac4578906 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CleanupRepositoryResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CleanupRepositoryResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Snapshot; public sealed partial class CleanupRepositoryResponse : ElasticsearchResponse { /// - /// Statistics for cleanup operations. + /// + /// Statistics for cleanup operations. + /// /// [JsonInclude, JsonPropertyName("results")] public Elastic.Clients.Elasticsearch.Serverless.Snapshot.CleanupRepositoryResults Results { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CloneSnapshotRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CloneSnapshotRequest.g.cs index 96b7cc71605..895f9427c77 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CloneSnapshotRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CloneSnapshotRequest.g.cs @@ -32,14 +32,18 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Snapshot; public sealed partial class CloneSnapshotRequestParameters : RequestParameters { /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Clones indices from one snapshot into another snapshot in the same repository. +/// +/// Clones indices from one snapshot into another snapshot in the same repository. +/// /// public sealed partial class CloneSnapshotRequest : PlainRequest { @@ -56,7 +60,9 @@ public CloneSnapshotRequest(Elastic.Clients.Elasticsearch.Serverless.Name reposi internal override string OperationName => "snapshot.clone"; /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } @@ -67,7 +73,9 @@ public CloneSnapshotRequest(Elastic.Clients.Elasticsearch.Serverless.Name reposi } /// -/// Clones indices from one snapshot into another snapshot in the same repository. +/// +/// Clones indices from one snapshot into another snapshot in the same repository. +/// /// public sealed partial class CloneSnapshotRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CloneSnapshotResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CloneSnapshotResponse.g.cs index c5110a0e38a..270cd3d5615 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CloneSnapshotResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CloneSnapshotResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Snapshot; public sealed partial class CloneSnapshotResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CreateRepositoryRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CreateRepositoryRequest.g.cs index fb499f54e47..f439eb01a71 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CreateRepositoryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CreateRepositoryRequest.g.cs @@ -32,23 +32,31 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Snapshot; public sealed partial class CreateRepositoryRequestParameters : RequestParameters { /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// + /// Explicit operation timeout + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Whether to verify the repository after creation + /// + /// Whether to verify the repository after creation + /// /// public bool? Verify { get => Q("verify"); set => Q("verify", value); } } /// -/// Creates a repository. +/// +/// Creates a repository. +/// /// public sealed partial class CreateRepositoryRequest : PlainRequest, ISelfSerializable { @@ -65,19 +73,25 @@ public CreateRepositoryRequest(Elastic.Clients.Elasticsearch.Serverless.Name nam internal override string OperationName => "snapshot.create_repository"; /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// + /// Explicit operation timeout + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Whether to verify the repository after creation + /// + /// Whether to verify the repository after creation + /// /// [JsonIgnore] public bool? Verify { get => Q("verify"); set => Q("verify", value); } @@ -91,7 +105,9 @@ void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions op } /// -/// Creates a repository. +/// +/// Creates a repository. +/// /// public sealed partial class CreateRepositoryRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CreateRepositoryResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CreateRepositoryResponse.g.cs index b91dcf5fe51..8ad697984f4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CreateRepositoryResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CreateRepositoryResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Snapshot; public sealed partial class CreateRepositoryResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CreateSnapshotRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CreateSnapshotRequest.g.cs index c5f4e5666df..c5a148f5447 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CreateSnapshotRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CreateSnapshotRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Snapshot; public sealed partial class CreateSnapshotRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// If `true`, the request returns a response when the snapshot is complete. If `false`, the request returns a response when the snapshot initializes. + /// + /// If true, the request returns a response when the snapshot is complete. If false, the request returns a response when the snapshot initializes. + /// /// public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Creates a snapshot in a repository. +/// +/// Creates a snapshot in a repository. +/// /// public sealed partial class CreateSnapshotRequest : PlainRequest { @@ -60,56 +66,74 @@ public CreateSnapshotRequest(Elastic.Clients.Elasticsearch.Serverless.Name repos internal override string OperationName => "snapshot.create"; /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// If `true`, the request returns a response when the snapshot is complete. If `false`, the request returns a response when the snapshot initializes. + /// + /// If true, the request returns a response when the snapshot is complete. If false, the request returns a response when the snapshot initializes. + /// /// [JsonIgnore] public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } /// - /// Feature states to include in the snapshot. Each feature state includes one or more system indices containing related data. You can view a list of eligible features using the get features API. If `include_global_state` is `true`, all current feature states are included by default. If `include_global_state` is `false`, no feature states are included by default. + /// + /// Feature states to include in the snapshot. Each feature state includes one or more system indices containing related data. You can view a list of eligible features using the get features API. If include_global_state is true, all current feature states are included by default. If include_global_state is false, no feature states are included by default. + /// /// [JsonInclude, JsonPropertyName("feature_states")] public ICollection? FeatureStates { get; set; } /// - /// If `true`, the request ignores data streams and indices in `indices` that are missing or closed. If `false`, the request returns an error for any data stream or index that is missing or closed. + /// + /// If true, the request ignores data streams and indices in indices that are missing or closed. If false, the request returns an error for any data stream or index that is missing or closed. + /// /// [JsonInclude, JsonPropertyName("ignore_unavailable")] public bool? IgnoreUnavailable { get; set; } /// - /// If `true`, the current cluster state is included in the snapshot. The cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies. It also includes data stored in system indices, such as Watches and task records (configurable via `feature_states`). + /// + /// If true, the current cluster state is included in the snapshot. The cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies. It also includes data stored in system indices, such as Watches and task records (configurable via feature_states). + /// /// [JsonInclude, JsonPropertyName("include_global_state")] public bool? IncludeGlobalState { get; set; } /// - /// Data streams and indices to include in the snapshot. Supports multi-target syntax. Includes all data streams and indices by default. + /// + /// Data streams and indices to include in the snapshot. Supports multi-target syntax. Includes all data streams and indices by default. + /// /// [JsonInclude, JsonPropertyName("indices")] public Elastic.Clients.Elasticsearch.Serverless.Indices? Indices { get; set; } /// - /// Optional metadata for the snapshot. May have any contents. Must be less than 1024 bytes. This map is not automatically generated by Elasticsearch. + /// + /// Optional metadata for the snapshot. May have any contents. Must be less than 1024 bytes. This map is not automatically generated by Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("metadata")] public IDictionary? Metadata { get; set; } /// - /// If `true`, allows restoring a partial snapshot of indices with unavailable shards. Only shards that were successfully included in the snapshot will be restored. All missing shards will be recreated as empty. If `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available. + /// + /// If true, allows restoring a partial snapshot of indices with unavailable shards. Only shards that were successfully included in the snapshot will be restored. All missing shards will be recreated as empty. If false, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available. + /// /// [JsonInclude, JsonPropertyName("partial")] public bool? Partial { get; set; } } /// -/// Creates a snapshot in a repository. +/// +/// Creates a snapshot in a repository. +/// /// public sealed partial class CreateSnapshotRequestDescriptor : RequestDescriptor { @@ -150,7 +174,9 @@ public CreateSnapshotRequestDescriptor Snapshot(Elastic.Clients.Elasticsearch.Se private bool? PartialValue { get; set; } /// - /// Feature states to include in the snapshot. Each feature state includes one or more system indices containing related data. You can view a list of eligible features using the get features API. If `include_global_state` is `true`, all current feature states are included by default. If `include_global_state` is `false`, no feature states are included by default. + /// + /// Feature states to include in the snapshot. Each feature state includes one or more system indices containing related data. You can view a list of eligible features using the get features API. If include_global_state is true, all current feature states are included by default. If include_global_state is false, no feature states are included by default. + /// /// public CreateSnapshotRequestDescriptor FeatureStates(ICollection? featureStates) { @@ -159,7 +185,9 @@ public CreateSnapshotRequestDescriptor FeatureStates(ICollection? featur } /// - /// If `true`, the request ignores data streams and indices in `indices` that are missing or closed. If `false`, the request returns an error for any data stream or index that is missing or closed. + /// + /// If true, the request ignores data streams and indices in indices that are missing or closed. If false, the request returns an error for any data stream or index that is missing or closed. + /// /// public CreateSnapshotRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) { @@ -168,7 +196,9 @@ public CreateSnapshotRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable } /// - /// If `true`, the current cluster state is included in the snapshot. The cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies. It also includes data stored in system indices, such as Watches and task records (configurable via `feature_states`). + /// + /// If true, the current cluster state is included in the snapshot. The cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies. It also includes data stored in system indices, such as Watches and task records (configurable via feature_states). + /// /// public CreateSnapshotRequestDescriptor IncludeGlobalState(bool? includeGlobalState = true) { @@ -177,7 +207,9 @@ public CreateSnapshotRequestDescriptor IncludeGlobalState(bool? includeGlobalSta } /// - /// Data streams and indices to include in the snapshot. Supports multi-target syntax. Includes all data streams and indices by default. + /// + /// Data streams and indices to include in the snapshot. Supports multi-target syntax. Includes all data streams and indices by default. + /// /// public CreateSnapshotRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.Indices? indices) { @@ -186,7 +218,9 @@ public CreateSnapshotRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Ser } /// - /// Optional metadata for the snapshot. May have any contents. Must be less than 1024 bytes. This map is not automatically generated by Elasticsearch. + /// + /// Optional metadata for the snapshot. May have any contents. Must be less than 1024 bytes. This map is not automatically generated by Elasticsearch. + /// /// public CreateSnapshotRequestDescriptor Metadata(Func, FluentDictionary> selector) { @@ -195,7 +229,9 @@ public CreateSnapshotRequestDescriptor Metadata(Func - /// If `true`, allows restoring a partial snapshot of indices with unavailable shards. Only shards that were successfully included in the snapshot will be restored. All missing shards will be recreated as empty. If `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available. + /// + /// If true, allows restoring a partial snapshot of indices with unavailable shards. Only shards that were successfully included in the snapshot will be restored. All missing shards will be recreated as empty. If false, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available. + /// /// public CreateSnapshotRequestDescriptor Partial(bool? partial = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CreateSnapshotResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CreateSnapshotResponse.g.cs index f70080c70a9..5a29b97af9c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CreateSnapshotResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CreateSnapshotResponse.g.cs @@ -29,13 +29,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Snapshot; public sealed partial class CreateSnapshotResponse : ElasticsearchResponse { /// - /// Equals `true` if the snapshot was accepted. Present when the request had `wait_for_completion` set to `false` + /// + /// Equals true if the snapshot was accepted. Present when the request had wait_for_completion set to false + /// /// [JsonInclude, JsonPropertyName("accepted")] public bool? Accepted { get; init; } /// - /// Snapshot information. Present when the request had `wait_for_completion` set to `true` + /// + /// Snapshot information. Present when the request had wait_for_completion set to true + /// /// [JsonInclude, JsonPropertyName("snapshot")] public Elastic.Clients.Elasticsearch.Serverless.Snapshot.SnapshotInfo? Snapshot { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/DeleteRepositoryRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/DeleteRepositoryRequest.g.cs index ad90ed2ae43..8f1161f20dc 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/DeleteRepositoryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/DeleteRepositoryRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Snapshot; public sealed partial class DeleteRepositoryRequestParameters : RequestParameters { /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// + /// Explicit operation timeout + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Deletes a repository. +/// +/// Deletes a repository. +/// /// public sealed partial class DeleteRepositoryRequest : PlainRequest { @@ -60,20 +66,26 @@ public DeleteRepositoryRequest(Elastic.Clients.Elasticsearch.Serverless.Names na internal override string OperationName => "snapshot.delete_repository"; /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// + /// Explicit operation timeout + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Deletes a repository. +/// +/// Deletes a repository. +/// /// public sealed partial class DeleteRepositoryRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/DeleteRepositoryResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/DeleteRepositoryResponse.g.cs index 98a2b6b89aa..b9feee61eab 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/DeleteRepositoryResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/DeleteRepositoryResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Snapshot; public sealed partial class DeleteRepositoryResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/DeleteSnapshotRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/DeleteSnapshotRequest.g.cs index 8d8bfb8160a..e505498c8fb 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/DeleteSnapshotRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/DeleteSnapshotRequest.g.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Snapshot; public sealed partial class DeleteSnapshotRequestParameters : RequestParameters { /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Deletes one or more snapshots. +/// +/// Deletes one or more snapshots. +/// /// public sealed partial class DeleteSnapshotRequest : PlainRequest { @@ -55,14 +59,18 @@ public DeleteSnapshotRequest(Elastic.Clients.Elasticsearch.Serverless.Name repos internal override string OperationName => "snapshot.delete"; /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Deletes one or more snapshots. +/// +/// Deletes one or more snapshots. +/// /// public sealed partial class DeleteSnapshotRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/DeleteSnapshotResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/DeleteSnapshotResponse.g.cs index 1bafca1cb8a..1657e82dd35 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/DeleteSnapshotResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/DeleteSnapshotResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Snapshot; public sealed partial class DeleteSnapshotResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/GetRepositoryRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/GetRepositoryRequest.g.cs index 1bbc0fea9e9..52143cbe9c8 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/GetRepositoryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/GetRepositoryRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Snapshot; public sealed partial class GetRepositoryRequestParameters : RequestParameters { /// - /// Return local information, do not retrieve the state from master node (default: false) + /// + /// Return local information, do not retrieve the state from master node (default: false) + /// /// public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Returns information about a repository. +/// +/// Returns information about a repository. +/// /// public sealed partial class GetRepositoryRequest : PlainRequest { @@ -64,20 +70,26 @@ public GetRepositoryRequest(Elastic.Clients.Elasticsearch.Serverless.Names? name internal override string OperationName => "snapshot.get_repository"; /// - /// Return local information, do not retrieve the state from master node (default: false) + /// + /// Return local information, do not retrieve the state from master node (default: false) + /// /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Returns information about a repository. +/// +/// Returns information about a repository. +/// /// public sealed partial class GetRepositoryRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/GetSnapshotRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/GetSnapshotRequest.g.cs index ccdf4b93018..e6fbe84a0c6 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/GetSnapshotRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/GetSnapshotRequest.g.cs @@ -32,73 +32,101 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Snapshot; public sealed partial class GetSnapshotRequestParameters : RequestParameters { /// - /// Offset identifier to start pagination from as returned by the next field in the response body. + /// + /// Offset identifier to start pagination from as returned by the next field in the response body. + /// /// public string? After { get => Q("after"); set => Q("after", value); } /// - /// Value of the current sort column at which to start retrieval. Can either be a string snapshot- or repository name when sorting by snapshot or repository name, a millisecond time value or a number when sorting by index- or shard count. + /// + /// Value of the current sort column at which to start retrieval. Can either be a string snapshot- or repository name when sorting by snapshot or repository name, a millisecond time value or a number when sorting by index- or shard count. + /// /// public string? FromSortValue { get => Q("from_sort_value"); set => Q("from_sort_value", value); } /// - /// If false, the request returns an error for any snapshots that are unavailable. + /// + /// If false, the request returns an error for any snapshots that are unavailable. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If true, returns the repository name in each snapshot. + /// + /// If true, returns the repository name in each snapshot. + /// /// public bool? IncludeRepository { get => Q("include_repository"); set => Q("include_repository", value); } /// - /// If true, returns additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index. Defaults to false, meaning that this information is omitted. + /// + /// If true, returns additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index. Defaults to false, meaning that this information is omitted. + /// /// public bool? IndexDetails { get => Q("index_details"); set => Q("index_details", value); } /// - /// If true, returns the name of each index in each snapshot. + /// + /// If true, returns the name of each index in each snapshot. + /// /// public bool? IndexNames { get => Q("index_names"); set => Q("index_names", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually exclusive with using the after parameter. Defaults to 0. + /// + /// Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually exclusive with using the after parameter. Defaults to 0. + /// /// public int? Offset { get => Q("offset"); set => Q("offset", value); } /// - /// Sort order. Valid values are asc for ascending and desc for descending order. Defaults to asc, meaning ascending order. + /// + /// Sort order. Valid values are asc for ascending and desc for descending order. Defaults to asc, meaning ascending order. + /// /// public Elastic.Clients.Elasticsearch.Serverless.SortOrder? Order { get => Q("order"); set => Q("order", value); } /// - /// Maximum number of snapshots to return. Defaults to 0 which means return all that match the request without limit. + /// + /// Maximum number of snapshots to return. Defaults to 0 which means return all that match the request without limit. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } /// - /// Filter snapshots by a comma-separated list of SLM policy names that snapshots belong to. Also accepts wildcards (*) and combinations of wildcards followed by exclude patterns starting with -. To include snapshots not created by an SLM policy you can use the special pattern _none that will match all snapshots without an SLM policy. + /// + /// Filter snapshots by a comma-separated list of SLM policy names that snapshots belong to. Also accepts wildcards (*) and combinations of wildcards followed by exclude patterns starting with -. To include snapshots not created by an SLM policy you can use the special pattern _none that will match all snapshots without an SLM policy. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Name? SlmPolicyFilter { get => Q("slm_policy_filter"); set => Q("slm_policy_filter", value); } /// - /// Allows setting a sort order for the result. Defaults to start_time, i.e. sorting by snapshot start time stamp. + /// + /// Allows setting a sort order for the result. Defaults to start_time, i.e. sorting by snapshot start time stamp. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Snapshot.SnapshotSort? Sort { get => Q("sort"); set => Q("sort", value); } /// - /// If true, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted. + /// + /// If true, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted. + /// /// public bool? Verbose { get => Q("verbose"); set => Q("verbose", value); } } /// -/// Returns information about a snapshot. +/// +/// Returns information about a snapshot. +/// /// public sealed partial class GetSnapshotRequest : PlainRequest { @@ -115,86 +143,114 @@ public GetSnapshotRequest(Elastic.Clients.Elasticsearch.Serverless.Name reposito internal override string OperationName => "snapshot.get"; /// - /// Offset identifier to start pagination from as returned by the next field in the response body. + /// + /// Offset identifier to start pagination from as returned by the next field in the response body. + /// /// [JsonIgnore] public string? After { get => Q("after"); set => Q("after", value); } /// - /// Value of the current sort column at which to start retrieval. Can either be a string snapshot- or repository name when sorting by snapshot or repository name, a millisecond time value or a number when sorting by index- or shard count. + /// + /// Value of the current sort column at which to start retrieval. Can either be a string snapshot- or repository name when sorting by snapshot or repository name, a millisecond time value or a number when sorting by index- or shard count. + /// /// [JsonIgnore] public string? FromSortValue { get => Q("from_sort_value"); set => Q("from_sort_value", value); } /// - /// If false, the request returns an error for any snapshots that are unavailable. + /// + /// If false, the request returns an error for any snapshots that are unavailable. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If true, returns the repository name in each snapshot. + /// + /// If true, returns the repository name in each snapshot. + /// /// [JsonIgnore] public bool? IncludeRepository { get => Q("include_repository"); set => Q("include_repository", value); } /// - /// If true, returns additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index. Defaults to false, meaning that this information is omitted. + /// + /// If true, returns additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index. Defaults to false, meaning that this information is omitted. + /// /// [JsonIgnore] public bool? IndexDetails { get => Q("index_details"); set => Q("index_details", value); } /// - /// If true, returns the name of each index in each snapshot. + /// + /// If true, returns the name of each index in each snapshot. + /// /// [JsonIgnore] public bool? IndexNames { get => Q("index_names"); set => Q("index_names", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually exclusive with using the after parameter. Defaults to 0. + /// + /// Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually exclusive with using the after parameter. Defaults to 0. + /// /// [JsonIgnore] public int? Offset { get => Q("offset"); set => Q("offset", value); } /// - /// Sort order. Valid values are asc for ascending and desc for descending order. Defaults to asc, meaning ascending order. + /// + /// Sort order. Valid values are asc for ascending and desc for descending order. Defaults to asc, meaning ascending order. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.SortOrder? Order { get => Q("order"); set => Q("order", value); } /// - /// Maximum number of snapshots to return. Defaults to 0 which means return all that match the request without limit. + /// + /// Maximum number of snapshots to return. Defaults to 0 which means return all that match the request without limit. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } /// - /// Filter snapshots by a comma-separated list of SLM policy names that snapshots belong to. Also accepts wildcards (*) and combinations of wildcards followed by exclude patterns starting with -. To include snapshots not created by an SLM policy you can use the special pattern _none that will match all snapshots without an SLM policy. + /// + /// Filter snapshots by a comma-separated list of SLM policy names that snapshots belong to. Also accepts wildcards (*) and combinations of wildcards followed by exclude patterns starting with -. To include snapshots not created by an SLM policy you can use the special pattern _none that will match all snapshots without an SLM policy. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Name? SlmPolicyFilter { get => Q("slm_policy_filter"); set => Q("slm_policy_filter", value); } /// - /// Allows setting a sort order for the result. Defaults to start_time, i.e. sorting by snapshot start time stamp. + /// + /// Allows setting a sort order for the result. Defaults to start_time, i.e. sorting by snapshot start time stamp. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Snapshot.SnapshotSort? Sort { get => Q("sort"); set => Q("sort", value); } /// - /// If true, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted. + /// + /// If true, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted. + /// /// [JsonIgnore] public bool? Verbose { get => Q("verbose"); set => Q("verbose", value); } } /// -/// Returns information about a snapshot. +/// +/// Returns information about a snapshot. +/// /// public sealed partial class GetSnapshotRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/GetSnapshotResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/GetSnapshotResponse.g.cs index 89c5596de5a..cd6c88debb1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/GetSnapshotResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/GetSnapshotResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Snapshot; public sealed partial class GetSnapshotResponse : ElasticsearchResponse { /// - /// The number of remaining snapshots that were not returned due to size limits and that can be fetched by additional requests using the next field value. + /// + /// The number of remaining snapshots that were not returned due to size limits and that can be fetched by additional requests using the next field value. + /// /// [JsonInclude, JsonPropertyName("remaining")] public int Remaining { get; init; } @@ -39,7 +41,9 @@ public sealed partial class GetSnapshotResponse : ElasticsearchResponse public IReadOnlyCollection? Snapshots { get; init; } /// - /// The total number of snapshots that match the request when ignoring size limit or after query parameter. + /// + /// The total number of snapshots that match the request when ignoring size limit or after query parameter. + /// /// [JsonInclude, JsonPropertyName("total")] public int Total { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/RestoreRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/RestoreRequest.g.cs index a6440300859..919861aeefb 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/RestoreRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/RestoreRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Snapshot; public sealed partial class RestoreRequestParameters : RequestParameters { /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Should this request wait until the operation has completed before returning + /// + /// Should this request wait until the operation has completed before returning + /// /// public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Restores a snapshot. +/// +/// Restores a snapshot. +/// /// public sealed partial class RestoreRequest : PlainRequest { @@ -60,13 +66,17 @@ public RestoreRequest(Elastic.Clients.Elasticsearch.Serverless.Name repository, internal override string OperationName => "snapshot.restore"; /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Should this request wait until the operation has completed before returning + /// + /// Should this request wait until the operation has completed before returning + /// /// [JsonIgnore] public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } @@ -93,7 +103,9 @@ public RestoreRequest(Elastic.Clients.Elasticsearch.Serverless.Name repository, } /// -/// Restores a snapshot. +/// +/// Restores a snapshot. +/// /// public sealed partial class RestoreRequestDescriptor : RequestDescriptor, RestoreRequestParameters> { @@ -295,7 +307,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Restores a snapshot. +/// +/// Restores a snapshot. +/// /// public sealed partial class RestoreRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/SnapshotStatusRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/SnapshotStatusRequest.g.cs index 72f4b2f7f5f..48d630754f2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/SnapshotStatusRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/SnapshotStatusRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Snapshot; public sealed partial class SnapshotStatusRequestParameters : RequestParameters { /// - /// Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown + /// + /// Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Returns information about the status of a snapshot. +/// +/// Returns information about the status of a snapshot. +/// /// public sealed partial class SnapshotStatusRequest : PlainRequest { @@ -68,20 +74,26 @@ public SnapshotStatusRequest(Elastic.Clients.Elasticsearch.Serverless.Name? repo internal override string OperationName => "snapshot.status"; /// - /// Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown + /// + /// Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Returns information about the status of a snapshot. +/// +/// Returns information about the status of a snapshot. +/// /// public sealed partial class SnapshotStatusRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/VerifyRepositoryRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/VerifyRepositoryRequest.g.cs index ab3c5550a24..60bc82b4c76 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/VerifyRepositoryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/VerifyRepositoryRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Snapshot; public sealed partial class VerifyRepositoryRequestParameters : RequestParameters { /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// + /// Explicit operation timeout + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Verifies a repository. +/// +/// Verifies a repository. +/// /// public sealed partial class VerifyRepositoryRequest : PlainRequest { @@ -60,20 +66,26 @@ public VerifyRepositoryRequest(Elastic.Clients.Elasticsearch.Serverless.Name nam internal override string OperationName => "snapshot.verify_repository"; /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// + /// Explicit operation timeout + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Verifies a repository. +/// +/// Verifies a repository. +/// /// public sealed partial class VerifyRepositoryRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/DeleteLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/DeleteLifecycleRequest.g.cs index 65a8350d2e4..9185dfb4497 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/DeleteLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/DeleteLifecycleRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class DeleteLifecycleRequestParameters : RequestParameters } /// -/// Deletes an existing snapshot lifecycle policy. +/// +/// Deletes an existing snapshot lifecycle policy. +/// /// public sealed partial class DeleteLifecycleRequest : PlainRequest { @@ -52,7 +54,9 @@ public DeleteLifecycleRequest(Elastic.Clients.Elasticsearch.Serverless.Name poli } /// -/// Deletes an existing snapshot lifecycle policy. +/// +/// Deletes an existing snapshot lifecycle policy. +/// /// public sealed partial class DeleteLifecycleRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/DeleteLifecycleResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/DeleteLifecycleResponse.g.cs index 1c239e6133d..c55e6564aa6 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/DeleteLifecycleResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/DeleteLifecycleResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.SnapshotLifecycleManagement; public sealed partial class DeleteLifecycleResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/ExecuteLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/ExecuteLifecycleRequest.g.cs index 57a63d4eb70..94e6ed2d209 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/ExecuteLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/ExecuteLifecycleRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class ExecuteLifecycleRequestParameters : RequestParameter } /// -/// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. +/// +/// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. +/// /// public sealed partial class ExecuteLifecycleRequest : PlainRequest { @@ -52,7 +54,9 @@ public ExecuteLifecycleRequest(Elastic.Clients.Elasticsearch.Serverless.Name pol } /// -/// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. +/// +/// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. +/// /// public sealed partial class ExecuteLifecycleRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/ExecuteRetentionRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/ExecuteRetentionRequest.g.cs index 7a3fda69346..85ebef47e24 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/ExecuteRetentionRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/ExecuteRetentionRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class ExecuteRetentionRequestParameters : RequestParameter } /// -/// Deletes any snapshots that are expired according to the policy's retention rules. +/// +/// Deletes any snapshots that are expired according to the policy's retention rules. +/// /// public sealed partial class ExecuteRetentionRequest : PlainRequest { @@ -48,7 +50,9 @@ public sealed partial class ExecuteRetentionRequest : PlainRequest -/// Deletes any snapshots that are expired according to the policy's retention rules. +/// +/// Deletes any snapshots that are expired according to the policy's retention rules. +/// /// public sealed partial class ExecuteRetentionRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/ExecuteRetentionResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/ExecuteRetentionResponse.g.cs index 0b6e97aa675..df9da9e895a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/ExecuteRetentionResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/ExecuteRetentionResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.SnapshotLifecycleManagement; public sealed partial class ExecuteRetentionResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/GetLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/GetLifecycleRequest.g.cs index 56a7ecfdad8..9176c90f39a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/GetLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/GetLifecycleRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class GetLifecycleRequestParameters : RequestParameters } /// -/// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. +/// +/// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. +/// /// public sealed partial class GetLifecycleRequest : PlainRequest { @@ -56,7 +58,9 @@ public GetLifecycleRequest(Elastic.Clients.Elasticsearch.Serverless.Names? polic } /// -/// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. +/// +/// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. +/// /// public sealed partial class GetLifecycleRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/GetSlmStatusRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/GetSlmStatusRequest.g.cs index eafb0160f8f..97a1b70b905 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/GetSlmStatusRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/GetSlmStatusRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class GetSlmStatusRequestParameters : RequestParameters } /// -/// Retrieves the status of snapshot lifecycle management (SLM). +/// +/// Retrieves the status of snapshot lifecycle management (SLM). +/// /// public sealed partial class GetSlmStatusRequest : PlainRequest { @@ -48,7 +50,9 @@ public sealed partial class GetSlmStatusRequest : PlainRequest -/// Retrieves the status of snapshot lifecycle management (SLM). +/// +/// Retrieves the status of snapshot lifecycle management (SLM). +/// /// public sealed partial class GetSlmStatusRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/GetStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/GetStatsRequest.g.cs index 462f850e638..4dfaa30bda6 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/GetStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/GetStatsRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class GetStatsRequestParameters : RequestParameters } /// -/// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. +/// +/// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. +/// /// public sealed partial class GetStatsRequest : PlainRequest { @@ -48,7 +50,9 @@ public sealed partial class GetStatsRequest : PlainRequest -/// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. +/// +/// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. +/// /// public sealed partial class GetStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/PutLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/PutLifecycleRequest.g.cs index 33ac529fe76..8f8d136e97a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/PutLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/PutLifecycleRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.Serverless.SnapshotLifecycleManagement; public sealed partial class PutLifecycleRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Creates or updates a snapshot lifecycle policy. +/// +/// Creates or updates a snapshot lifecycle policy. +/// /// public sealed partial class PutLifecycleRequest : PlainRequest { @@ -60,50 +66,66 @@ public PutLifecycleRequest(Elastic.Clients.Elasticsearch.Serverless.Name policyI internal override string OperationName => "slm.put_lifecycle"; /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Configuration for each snapshot created by the policy. + /// + /// Configuration for each snapshot created by the policy. + /// /// [JsonInclude, JsonPropertyName("config")] public Elastic.Clients.Elasticsearch.Serverless.SnapshotLifecycleManagement.SlmConfiguration? Config { get; set; } /// - /// Name automatically assigned to each snapshot created by the policy. Date math is supported. To prevent conflicting snapshot names, a UUID is automatically appended to each snapshot name. + /// + /// Name automatically assigned to each snapshot created by the policy. Date math is supported. To prevent conflicting snapshot names, a UUID is automatically appended to each snapshot name. + /// /// [JsonInclude, JsonPropertyName("name")] public Elastic.Clients.Elasticsearch.Serverless.Name? Name { get; set; } /// - /// Repository used to store snapshots created by this policy. This repository must exist prior to the policy’s creation. You can create a repository using the snapshot repository API. + /// + /// Repository used to store snapshots created by this policy. This repository must exist prior to the policy’s creation. You can create a repository using the snapshot repository API. + /// /// [JsonInclude, JsonPropertyName("repository")] public string? Repository { get; set; } /// - /// Retention rules used to retain and delete snapshots created by the policy. + /// + /// Retention rules used to retain and delete snapshots created by the policy. + /// /// [JsonInclude, JsonPropertyName("retention")] public Elastic.Clients.Elasticsearch.Serverless.SnapshotLifecycleManagement.Retention? Retention { get; set; } /// - /// Periodic or absolute schedule at which the policy creates snapshots. SLM applies schedule changes immediately. + /// + /// Periodic or absolute schedule at which the policy creates snapshots. SLM applies schedule changes immediately. + /// /// [JsonInclude, JsonPropertyName("schedule")] public string? Schedule { get; set; } } /// -/// Creates or updates a snapshot lifecycle policy. +/// +/// Creates or updates a snapshot lifecycle policy. +/// /// public sealed partial class PutLifecycleRequestDescriptor : RequestDescriptor { @@ -141,7 +163,9 @@ public PutLifecycleRequestDescriptor PolicyId(Elastic.Clients.Elasticsearch.Serv private string? ScheduleValue { get; set; } /// - /// Configuration for each snapshot created by the policy. + /// + /// Configuration for each snapshot created by the policy. + /// /// public PutLifecycleRequestDescriptor Config(Elastic.Clients.Elasticsearch.Serverless.SnapshotLifecycleManagement.SlmConfiguration? config) { @@ -168,7 +192,9 @@ public PutLifecycleRequestDescriptor Config(Action - /// Name automatically assigned to each snapshot created by the policy. Date math is supported. To prevent conflicting snapshot names, a UUID is automatically appended to each snapshot name. + /// + /// Name automatically assigned to each snapshot created by the policy. Date math is supported. To prevent conflicting snapshot names, a UUID is automatically appended to each snapshot name. + /// /// public PutLifecycleRequestDescriptor Name(Elastic.Clients.Elasticsearch.Serverless.Name? name) { @@ -177,7 +203,9 @@ public PutLifecycleRequestDescriptor Name(Elastic.Clients.Elasticsearch.Serverle } /// - /// Repository used to store snapshots created by this policy. This repository must exist prior to the policy’s creation. You can create a repository using the snapshot repository API. + /// + /// Repository used to store snapshots created by this policy. This repository must exist prior to the policy’s creation. You can create a repository using the snapshot repository API. + /// /// public PutLifecycleRequestDescriptor Repository(string? repository) { @@ -186,7 +214,9 @@ public PutLifecycleRequestDescriptor Repository(string? repository) } /// - /// Retention rules used to retain and delete snapshots created by the policy. + /// + /// Retention rules used to retain and delete snapshots created by the policy. + /// /// public PutLifecycleRequestDescriptor Retention(Elastic.Clients.Elasticsearch.Serverless.SnapshotLifecycleManagement.Retention? retention) { @@ -213,7 +243,9 @@ public PutLifecycleRequestDescriptor Retention(Action - /// Periodic or absolute schedule at which the policy creates snapshots. SLM applies schedule changes immediately. + /// + /// Periodic or absolute schedule at which the policy creates snapshots. SLM applies schedule changes immediately. + /// /// public PutLifecycleRequestDescriptor Schedule(string? schedule) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/PutLifecycleResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/PutLifecycleResponse.g.cs index 953965ec996..81e78167d5f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/PutLifecycleResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/PutLifecycleResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.SnapshotLifecycleManagement; public sealed partial class PutLifecycleResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/StartSlmRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/StartSlmRequest.g.cs index dcf894c9db2..394d34fdec0 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/StartSlmRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/StartSlmRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class StartSlmRequestParameters : RequestParameters } /// -/// Turns on snapshot lifecycle management (SLM). +/// +/// Turns on snapshot lifecycle management (SLM). +/// /// public sealed partial class StartSlmRequest : PlainRequest { @@ -48,7 +50,9 @@ public sealed partial class StartSlmRequest : PlainRequest -/// Turns on snapshot lifecycle management (SLM). +/// +/// Turns on snapshot lifecycle management (SLM). +/// /// public sealed partial class StartSlmRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/StartSlmResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/StartSlmResponse.g.cs index 93638085bee..3c808d5388b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/StartSlmResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/StartSlmResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.SnapshotLifecycleManagement; public sealed partial class StartSlmResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/StopSlmRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/StopSlmRequest.g.cs index dec8526f0a1..2492c4d0d46 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/StopSlmRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/StopSlmRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class StopSlmRequestParameters : RequestParameters } /// -/// Turns off snapshot lifecycle management (SLM). +/// +/// Turns off snapshot lifecycle management (SLM). +/// /// public sealed partial class StopSlmRequest : PlainRequest { @@ -48,7 +50,9 @@ public sealed partial class StopSlmRequest : PlainRequest -/// Turns off snapshot lifecycle management (SLM). +/// +/// Turns off snapshot lifecycle management (SLM). +/// /// public sealed partial class StopSlmRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/StopSlmResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/StopSlmResponse.g.cs index 93085cefd2c..158747d810b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/StopSlmResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/StopSlmResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.SnapshotLifecycleManagement; public sealed partial class StopSlmResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/ClearCursorRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/ClearCursorRequest.g.cs index 1bba5dadbb8..d3f5a2a415c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/ClearCursorRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/ClearCursorRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class ClearCursorRequestParameters : RequestParameters } /// -/// Clears the SQL cursor +/// +/// Clears the SQL cursor +/// /// public sealed partial class ClearCursorRequest : PlainRequest { @@ -47,14 +49,18 @@ public sealed partial class ClearCursorRequest : PlainRequest "sql.clear_cursor"; /// - /// Cursor to clear. + /// + /// Cursor to clear. + /// /// [JsonInclude, JsonPropertyName("cursor")] public string Cursor { get; set; } } /// -/// Clears the SQL cursor +/// +/// Clears the SQL cursor +/// /// public sealed partial class ClearCursorRequestDescriptor : RequestDescriptor { @@ -75,7 +81,9 @@ public ClearCursorRequestDescriptor() private string CursorValue { get; set; } /// - /// Cursor to clear. + /// + /// Cursor to clear. + /// /// public ClearCursorRequestDescriptor Cursor(string cursor) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/DeleteAsyncRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/DeleteAsyncRequest.g.cs index 38eb5c99b16..cc741e63644 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/DeleteAsyncRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/DeleteAsyncRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class DeleteAsyncRequestParameters : RequestParameters } /// -/// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. +/// +/// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. +/// /// public sealed partial class DeleteAsyncRequest : PlainRequest { @@ -52,7 +54,9 @@ public DeleteAsyncRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : base } /// -/// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. +/// +/// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. +/// /// public sealed partial class DeleteAsyncRequestDescriptor : RequestDescriptor, DeleteAsyncRequestParameters> { @@ -82,7 +86,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. +/// +/// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. +/// /// public sealed partial class DeleteAsyncRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/DeleteAsyncResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/DeleteAsyncResponse.g.cs index 1d4fe6f738f..09cfb3fee42 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/DeleteAsyncResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/DeleteAsyncResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Sql; public sealed partial class DeleteAsyncResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/GetAsyncRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/GetAsyncRequest.g.cs index 52aa3fbf11d..35a0477155a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/GetAsyncRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/GetAsyncRequest.g.cs @@ -32,28 +32,41 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Sql; public sealed partial class GetAsyncRequestParameters : RequestParameters { /// - /// Separator for CSV results. The API only supports this parameter for CSV responses. + /// + /// Separator for CSV results. The API only supports this parameter for CSV responses. + /// /// public string? Delimiter { get => Q("delimiter"); set => Q("delimiter", value); } /// - /// Format for the response. You must specify a format using this parameter or the
Accept HTTP header. If you specify both, the API uses this parameter. + /// + /// Format for the response. You must specify a format using this parameter or the + /// Accept HTTP header. If you specify both, the API uses this parameter. + /// /// public string? Format { get => Q("format"); set => Q("format", value); } /// - /// Retention period for the search and its results. Defaults
to the `keep_alive` period for the original SQL search. + /// + /// Retention period for the search and its results. Defaults + /// to the keep_alive period for the original SQL search. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); } /// - /// Period to wait for complete results. Defaults to no timeout,
meaning the request waits for complete search results. + /// + /// Period to wait for complete results. Defaults to no timeout, + /// meaning the request waits for complete search results. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? WaitForCompletionTimeout { get => Q("wait_for_completion_timeout"); set => Q("wait_for_completion_timeout", value); } } /// -/// Returns the current status and available results for an async SQL search or stored synchronous SQL search +/// +/// Returns the current status and available results for an async SQL search or stored synchronous SQL search +/// /// public sealed partial class GetAsyncRequest : PlainRequest { @@ -70,32 +83,45 @@ public GetAsyncRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : base(r internal override string OperationName => "sql.get_async"; /// - /// Separator for CSV results. The API only supports this parameter for CSV responses. + /// + /// Separator for CSV results. The API only supports this parameter for CSV responses. + /// /// [JsonIgnore] public string? Delimiter { get => Q("delimiter"); set => Q("delimiter", value); } /// - /// Format for the response. You must specify a format using this parameter or the
Accept HTTP header. If you specify both, the API uses this parameter. + /// + /// Format for the response. You must specify a format using this parameter or the + /// Accept HTTP header. If you specify both, the API uses this parameter. + /// /// [JsonIgnore] public string? Format { get => Q("format"); set => Q("format", value); } /// - /// Retention period for the search and its results. Defaults
to the `keep_alive` period for the original SQL search. + /// + /// Retention period for the search and its results. Defaults + /// to the keep_alive period for the original SQL search. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); } /// - /// Period to wait for complete results. Defaults to no timeout,
meaning the request waits for complete search results. + /// + /// Period to wait for complete results. Defaults to no timeout, + /// meaning the request waits for complete search results. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? WaitForCompletionTimeout { get => Q("wait_for_completion_timeout"); set => Q("wait_for_completion_timeout", value); } } /// -/// Returns the current status and available results for an async SQL search or stored synchronous SQL search +/// +/// Returns the current status and available results for an async SQL search or stored synchronous SQL search +/// /// public sealed partial class GetAsyncRequestDescriptor : RequestDescriptor, GetAsyncRequestParameters> { @@ -130,7 +156,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns the current status and available results for an async SQL search or stored synchronous SQL search +/// +/// Returns the current status and available results for an async SQL search or stored synchronous SQL search +/// /// public sealed partial class GetAsyncRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/GetAsyncResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/GetAsyncResponse.g.cs index 3603d74dd53..b2f81b3bb98 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/GetAsyncResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/GetAsyncResponse.g.cs @@ -29,31 +29,51 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Sql; public sealed partial class GetAsyncResponse : ElasticsearchResponse { /// - /// Column headings for the search results. Each object is a column. + /// + /// Column headings for the search results. Each object is a column. + /// /// [JsonInclude, JsonPropertyName("columns")] public IReadOnlyCollection? Columns { get; init; } /// - /// Cursor for the next set of paginated results. For CSV, TSV, and
TXT responses, this value is returned in the `Cursor` HTTP header. + /// + /// Cursor for the next set of paginated results. For CSV, TSV, and + /// TXT responses, this value is returned in the Cursor HTTP header. + /// /// [JsonInclude, JsonPropertyName("cursor")] public string? Cursor { get; init; } /// - /// Identifier for the search. This value is only returned for async and saved
synchronous searches. For CSV, TSV, and TXT responses, this value is returned
in the `Async-ID` HTTP header. + /// + /// Identifier for the search. This value is only returned for async and saved + /// synchronous searches. For CSV, TSV, and TXT responses, this value is returned + /// in the Async-ID HTTP header. + /// /// [JsonInclude, JsonPropertyName("id")] public string Id { get; init; } /// - /// If `true`, the response does not contain complete search results. If `is_partial`
is `true` and `is_running` is `true`, the search is still running. If `is_partial`
is `true` but `is_running` is `false`, the results are partial due to a failure or
timeout. This value is only returned for async and saved synchronous searches.
For CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header. + /// + /// If true, the response does not contain complete search results. If is_partial + /// is true and is_running is true, the search is still running. If is_partial + /// is true but is_running is false, the results are partial due to a failure or + /// timeout. This value is only returned for async and saved synchronous searches. + /// For CSV, TSV, and TXT responses, this value is returned in the Async-partial HTTP header. + /// /// [JsonInclude, JsonPropertyName("is_partial")] public bool IsPartial { get; init; } /// - /// If `true`, the search is still running. If false, the search has finished.
This value is only returned for async and saved synchronous searches. For
CSV, TSV, and TXT responses, this value is returned in the `Async-partial`
HTTP header. + /// + /// If true, the search is still running. If false, the search has finished. + /// This value is only returned for async and saved synchronous searches. For + /// CSV, TSV, and TXT responses, this value is returned in the Async-partial + /// HTTP header. + /// /// [JsonInclude, JsonPropertyName("is_running")] public bool IsRunning { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/GetAsyncStatusRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/GetAsyncStatusRequest.g.cs index 572db65f77f..e356874e9da 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/GetAsyncStatusRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/GetAsyncStatusRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class GetAsyncStatusRequestParameters : RequestParameters } /// -/// Returns the current status of an async SQL search or a stored synchronous SQL search +/// +/// Returns the current status of an async SQL search or a stored synchronous SQL search +/// /// public sealed partial class GetAsyncStatusRequest : PlainRequest { @@ -52,7 +54,9 @@ public GetAsyncStatusRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : b } /// -/// Returns the current status of an async SQL search or a stored synchronous SQL search +/// +/// Returns the current status of an async SQL search or a stored synchronous SQL search +/// /// public sealed partial class GetAsyncStatusRequestDescriptor : RequestDescriptor, GetAsyncStatusRequestParameters> { @@ -82,7 +86,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns the current status of an async SQL search or a stored synchronous SQL search +/// +/// Returns the current status of an async SQL search or a stored synchronous SQL search +/// /// public sealed partial class GetAsyncStatusRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/GetAsyncStatusResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/GetAsyncStatusResponse.g.cs index efc2638c4c8..7e4c8941777 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/GetAsyncStatusResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/GetAsyncStatusResponse.g.cs @@ -29,37 +29,54 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Sql; public sealed partial class GetAsyncStatusResponse : ElasticsearchResponse { /// - /// HTTP status code for the search. The API only returns this property for completed searches. + /// + /// HTTP status code for the search. The API only returns this property for completed searches. + /// /// [JsonInclude, JsonPropertyName("completion_status")] public int? CompletionStatus { get; init; } /// - /// Timestamp, in milliseconds since the Unix epoch, when Elasticsearch will delete
the search and its results, even if the search is still running. + /// + /// Timestamp, in milliseconds since the Unix epoch, when Elasticsearch will delete + /// the search and its results, even if the search is still running. + /// /// [JsonInclude, JsonPropertyName("expiration_time_in_millis")] public long ExpirationTimeInMillis { get; init; } /// - /// Identifier for the search. + /// + /// Identifier for the search. + /// /// [JsonInclude, JsonPropertyName("id")] public string Id { get; init; } /// - /// If `true`, the response does not contain complete search results. If `is_partial`
is `true` and `is_running` is `true`, the search is still running. If `is_partial`
is `true` but `is_running` is `false`, the results are partial due to a failure or
timeout. + /// + /// If true, the response does not contain complete search results. If is_partial + /// is true and is_running is true, the search is still running. If is_partial + /// is true but is_running is false, the results are partial due to a failure or + /// timeout. + /// /// [JsonInclude, JsonPropertyName("is_partial")] public bool IsPartial { get; init; } /// - /// If `true`, the search is still running. If `false`, the search has finished. + /// + /// If true, the search is still running. If false, the search has finished. + /// /// [JsonInclude, JsonPropertyName("is_running")] public bool IsRunning { get; init; } /// - /// Timestamp, in milliseconds since the Unix epoch, when the search started.
The API only returns this property for running searches. + /// + /// Timestamp, in milliseconds since the Unix epoch, when the search started. + /// The API only returns this property for running searches. + /// /// [JsonInclude, JsonPropertyName("start_time_in_millis")] public long StartTimeInMillis { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/QueryRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/QueryRequest.g.cs index 3b0de3cd822..acc10e56463 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/QueryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/QueryRequest.g.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Sql; public sealed partial class QueryRequestParameters : RequestParameters { /// - /// Format for the response. + /// + /// Format for the response. + /// /// public string? Format { get => Q("format"); set => Q("format", value); } } /// -/// Executes a SQL request +/// +/// Executes a SQL request +/// /// public sealed partial class QueryRequest : PlainRequest { @@ -51,110 +55,149 @@ public sealed partial class QueryRequest : PlainRequest internal override string OperationName => "sql.query"; /// - /// Format for the response. + /// + /// Format for the response. + /// /// [JsonIgnore] public string? Format { get => Q("format"); set => Q("format", value); } /// - /// Default catalog (cluster) for queries. If unspecified, the queries execute on the data in the local cluster only. + /// + /// Default catalog (cluster) for queries. If unspecified, the queries execute on the data in the local cluster only. + /// /// [JsonInclude, JsonPropertyName("catalog")] public string? Catalog { get; set; } /// - /// If true, the results in a columnar fashion: one row represents all the values of a certain column from the current page of results. + /// + /// If true, the results in a columnar fashion: one row represents all the values of a certain column from the current page of results. + /// /// [JsonInclude, JsonPropertyName("columnar")] public bool? Columnar { get; set; } /// - /// Cursor used to retrieve a set of paginated results.
If you specify a cursor, the API only uses the `columnar` and `time_zone` request body parameters.
It ignores other request body parameters. + /// + /// Cursor used to retrieve a set of paginated results. + /// If you specify a cursor, the API only uses the columnar and time_zone request body parameters. + /// It ignores other request body parameters. + /// /// [JsonInclude, JsonPropertyName("cursor")] public string? Cursor { get; set; } /// - /// The maximum number of rows (or entries) to return in one response + /// + /// The maximum number of rows (or entries) to return in one response + /// /// [JsonInclude, JsonPropertyName("fetch_size")] public int? FetchSize { get; set; } /// - /// Throw an exception when encountering multiple values for a field (default) or be lenient and return the first value from the list (without any guarantees of what that will be - typically the first in natural ascending order). + /// + /// Throw an exception when encountering multiple values for a field (default) or be lenient and return the first value from the list (without any guarantees of what that will be - typically the first in natural ascending order). + /// /// [JsonInclude, JsonPropertyName("field_multi_value_leniency")] public bool? FieldMultiValueLeniency { get; set; } /// - /// Elasticsearch query DSL for additional filtering. + /// + /// Elasticsearch query DSL for additional filtering. + /// /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? Filter { get; set; } /// - /// If true, the search can run on frozen indices. Defaults to false. + /// + /// If true, the search can run on frozen indices. Defaults to false. + /// /// [JsonInclude, JsonPropertyName("index_using_frozen")] public bool? IndexUsingFrozen { get; set; } /// - /// Retention period for an async or saved synchronous search. + /// + /// Retention period for an async or saved synchronous search. + /// /// [JsonInclude, JsonPropertyName("keep_alive")] public Elastic.Clients.Elasticsearch.Serverless.Duration? KeepAlive { get; set; } /// - /// If true, Elasticsearch stores synchronous searches if you also specify the wait_for_completion_timeout parameter. If false, Elasticsearch only stores async searches that don’t finish before the wait_for_completion_timeout. + /// + /// If true, Elasticsearch stores synchronous searches if you also specify the wait_for_completion_timeout parameter. If false, Elasticsearch only stores async searches that don’t finish before the wait_for_completion_timeout. + /// /// [JsonInclude, JsonPropertyName("keep_on_completion")] public bool? KeepOnCompletion { get; set; } /// - /// The timeout before a pagination request fails. + /// + /// The timeout before a pagination request fails. + /// /// [JsonInclude, JsonPropertyName("page_timeout")] public Elastic.Clients.Elasticsearch.Serverless.Duration? PageTimeout { get; set; } /// - /// Values for parameters in the query. + /// + /// Values for parameters in the query. + /// /// [JsonInclude, JsonPropertyName("params")] public IDictionary? Params { get; set; } /// - /// SQL query to run. + /// + /// SQL query to run. + /// /// [JsonInclude, JsonPropertyName("query")] public string? Query { get; set; } /// - /// The timeout before the request fails. + /// + /// The timeout before the request fails. + /// /// [JsonInclude, JsonPropertyName("request_timeout")] public Elastic.Clients.Elasticsearch.Serverless.Duration? RequestTimeout { get; set; } /// - /// Defines one or more runtime fields in the search request. These fields take
precedence over mapped fields with the same name. + /// + /// Defines one or more runtime fields in the search request. These fields take + /// precedence over mapped fields with the same name. + /// /// [JsonInclude, JsonPropertyName("runtime_mappings")] public IDictionary? RuntimeMappings { get; set; } /// - /// ISO-8601 time zone ID for the search. + /// + /// ISO-8601 time zone ID for the search. + /// /// [JsonInclude, JsonPropertyName("time_zone")] public string? TimeZone { get; set; } /// - /// Period to wait for complete results. Defaults to no timeout, meaning the request waits for complete search results. If the search doesn’t finish within this period, the search becomes async. + /// + /// Period to wait for complete results. Defaults to no timeout, meaning the request waits for complete search results. If the search doesn’t finish within this period, the search becomes async. + /// /// [JsonInclude, JsonPropertyName("wait_for_completion_timeout")] public Elastic.Clients.Elasticsearch.Serverless.Duration? WaitForCompletionTimeout { get; set; } } /// -/// Executes a SQL request +/// +/// Executes a SQL request +/// /// public sealed partial class QueryRequestDescriptor : RequestDescriptor, QueryRequestParameters> { @@ -194,7 +237,9 @@ public QueryRequestDescriptor() private Elastic.Clients.Elasticsearch.Serverless.Duration? WaitForCompletionTimeoutValue { get; set; } /// - /// Default catalog (cluster) for queries. If unspecified, the queries execute on the data in the local cluster only. + /// + /// Default catalog (cluster) for queries. If unspecified, the queries execute on the data in the local cluster only. + /// /// public QueryRequestDescriptor Catalog(string? catalog) { @@ -203,7 +248,9 @@ public QueryRequestDescriptor Catalog(string? catalog) } /// - /// If true, the results in a columnar fashion: one row represents all the values of a certain column from the current page of results. + /// + /// If true, the results in a columnar fashion: one row represents all the values of a certain column from the current page of results. + /// /// public QueryRequestDescriptor Columnar(bool? columnar = true) { @@ -212,7 +259,11 @@ public QueryRequestDescriptor Columnar(bool? columnar = true) } /// - /// Cursor used to retrieve a set of paginated results.
If you specify a cursor, the API only uses the `columnar` and `time_zone` request body parameters.
It ignores other request body parameters. + /// + /// Cursor used to retrieve a set of paginated results. + /// If you specify a cursor, the API only uses the columnar and time_zone request body parameters. + /// It ignores other request body parameters. + /// /// public QueryRequestDescriptor Cursor(string? cursor) { @@ -221,7 +272,9 @@ public QueryRequestDescriptor Cursor(string? cursor) } /// - /// The maximum number of rows (or entries) to return in one response + /// + /// The maximum number of rows (or entries) to return in one response + /// /// public QueryRequestDescriptor FetchSize(int? fetchSize) { @@ -230,7 +283,9 @@ public QueryRequestDescriptor FetchSize(int? fetchSize) } /// - /// Throw an exception when encountering multiple values for a field (default) or be lenient and return the first value from the list (without any guarantees of what that will be - typically the first in natural ascending order). + /// + /// Throw an exception when encountering multiple values for a field (default) or be lenient and return the first value from the list (without any guarantees of what that will be - typically the first in natural ascending order). + /// /// public QueryRequestDescriptor FieldMultiValueLeniency(bool? fieldMultiValueLeniency = true) { @@ -239,7 +294,9 @@ public QueryRequestDescriptor FieldMultiValueLeniency(bool? fieldMult } /// - /// Elasticsearch query DSL for additional filtering. + /// + /// Elasticsearch query DSL for additional filtering. + /// /// public QueryRequestDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? filter) { @@ -266,7 +323,9 @@ public QueryRequestDescriptor Filter(Action - /// If true, the search can run on frozen indices. Defaults to false. + /// + /// If true, the search can run on frozen indices. Defaults to false. + /// /// public QueryRequestDescriptor IndexUsingFrozen(bool? indexUsingFrozen = true) { @@ -275,7 +334,9 @@ public QueryRequestDescriptor IndexUsingFrozen(bool? indexUsingFrozen } /// - /// Retention period for an async or saved synchronous search. + /// + /// Retention period for an async or saved synchronous search. + /// /// public QueryRequestDescriptor KeepAlive(Elastic.Clients.Elasticsearch.Serverless.Duration? keepAlive) { @@ -284,7 +345,9 @@ public QueryRequestDescriptor KeepAlive(Elastic.Clients.Elasticsearch } /// - /// If true, Elasticsearch stores synchronous searches if you also specify the wait_for_completion_timeout parameter. If false, Elasticsearch only stores async searches that don’t finish before the wait_for_completion_timeout. + /// + /// If true, Elasticsearch stores synchronous searches if you also specify the wait_for_completion_timeout parameter. If false, Elasticsearch only stores async searches that don’t finish before the wait_for_completion_timeout. + /// /// public QueryRequestDescriptor KeepOnCompletion(bool? keepOnCompletion = true) { @@ -293,7 +356,9 @@ public QueryRequestDescriptor KeepOnCompletion(bool? keepOnCompletion } /// - /// The timeout before a pagination request fails. + /// + /// The timeout before a pagination request fails. + /// /// public QueryRequestDescriptor PageTimeout(Elastic.Clients.Elasticsearch.Serverless.Duration? pageTimeout) { @@ -302,7 +367,9 @@ public QueryRequestDescriptor PageTimeout(Elastic.Clients.Elasticsear } /// - /// Values for parameters in the query. + /// + /// Values for parameters in the query. + /// /// public QueryRequestDescriptor Params(Func, FluentDictionary> selector) { @@ -311,7 +378,9 @@ public QueryRequestDescriptor Params(Func - /// SQL query to run. + /// + /// SQL query to run. + /// /// public QueryRequestDescriptor Query(string? query) { @@ -320,7 +389,9 @@ public QueryRequestDescriptor Query(string? query) } /// - /// The timeout before the request fails. + /// + /// The timeout before the request fails. + /// /// public QueryRequestDescriptor RequestTimeout(Elastic.Clients.Elasticsearch.Serverless.Duration? requestTimeout) { @@ -329,7 +400,10 @@ public QueryRequestDescriptor RequestTimeout(Elastic.Clients.Elastics } /// - /// Defines one or more runtime fields in the search request. These fields take
precedence over mapped fields with the same name. + /// + /// Defines one or more runtime fields in the search request. These fields take + /// precedence over mapped fields with the same name. + /// /// public QueryRequestDescriptor RuntimeMappings(Func>, FluentDescriptorDictionary>> selector) { @@ -338,7 +412,9 @@ public QueryRequestDescriptor RuntimeMappings(Func - /// ISO-8601 time zone ID for the search. + /// + /// ISO-8601 time zone ID for the search. + /// /// public QueryRequestDescriptor TimeZone(string? timeZone) { @@ -347,7 +423,9 @@ public QueryRequestDescriptor TimeZone(string? timeZone) } /// - /// Period to wait for complete results. Defaults to no timeout, meaning the request waits for complete search results. If the search doesn’t finish within this period, the search becomes async. + /// + /// Period to wait for complete results. Defaults to no timeout, meaning the request waits for complete search results. If the search doesn’t finish within this period, the search becomes async. + /// /// public QueryRequestDescriptor WaitForCompletionTimeout(Elastic.Clients.Elasticsearch.Serverless.Duration? waitForCompletionTimeout) { @@ -469,7 +547,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Executes a SQL request +/// +/// Executes a SQL request +/// /// public sealed partial class QueryRequestDescriptor : RequestDescriptor { @@ -509,7 +589,9 @@ public QueryRequestDescriptor() private Elastic.Clients.Elasticsearch.Serverless.Duration? WaitForCompletionTimeoutValue { get; set; } /// - /// Default catalog (cluster) for queries. If unspecified, the queries execute on the data in the local cluster only. + /// + /// Default catalog (cluster) for queries. If unspecified, the queries execute on the data in the local cluster only. + /// /// public QueryRequestDescriptor Catalog(string? catalog) { @@ -518,7 +600,9 @@ public QueryRequestDescriptor Catalog(string? catalog) } /// - /// If true, the results in a columnar fashion: one row represents all the values of a certain column from the current page of results. + /// + /// If true, the results in a columnar fashion: one row represents all the values of a certain column from the current page of results. + /// /// public QueryRequestDescriptor Columnar(bool? columnar = true) { @@ -527,7 +611,11 @@ public QueryRequestDescriptor Columnar(bool? columnar = true) } /// - /// Cursor used to retrieve a set of paginated results.
If you specify a cursor, the API only uses the `columnar` and `time_zone` request body parameters.
It ignores other request body parameters. + /// + /// Cursor used to retrieve a set of paginated results. + /// If you specify a cursor, the API only uses the columnar and time_zone request body parameters. + /// It ignores other request body parameters. + /// /// public QueryRequestDescriptor Cursor(string? cursor) { @@ -536,7 +624,9 @@ public QueryRequestDescriptor Cursor(string? cursor) } /// - /// The maximum number of rows (or entries) to return in one response + /// + /// The maximum number of rows (or entries) to return in one response + /// /// public QueryRequestDescriptor FetchSize(int? fetchSize) { @@ -545,7 +635,9 @@ public QueryRequestDescriptor FetchSize(int? fetchSize) } /// - /// Throw an exception when encountering multiple values for a field (default) or be lenient and return the first value from the list (without any guarantees of what that will be - typically the first in natural ascending order). + /// + /// Throw an exception when encountering multiple values for a field (default) or be lenient and return the first value from the list (without any guarantees of what that will be - typically the first in natural ascending order). + /// /// public QueryRequestDescriptor FieldMultiValueLeniency(bool? fieldMultiValueLeniency = true) { @@ -554,7 +646,9 @@ public QueryRequestDescriptor FieldMultiValueLeniency(bool? fieldMultiValueLenie } /// - /// Elasticsearch query DSL for additional filtering. + /// + /// Elasticsearch query DSL for additional filtering. + /// /// public QueryRequestDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? filter) { @@ -581,7 +675,9 @@ public QueryRequestDescriptor Filter(Action - /// If true, the search can run on frozen indices. Defaults to false. + /// + /// If true, the search can run on frozen indices. Defaults to false. + /// /// public QueryRequestDescriptor IndexUsingFrozen(bool? indexUsingFrozen = true) { @@ -590,7 +686,9 @@ public QueryRequestDescriptor IndexUsingFrozen(bool? indexUsingFrozen = true) } /// - /// Retention period for an async or saved synchronous search. + /// + /// Retention period for an async or saved synchronous search. + /// /// public QueryRequestDescriptor KeepAlive(Elastic.Clients.Elasticsearch.Serverless.Duration? keepAlive) { @@ -599,7 +697,9 @@ public QueryRequestDescriptor KeepAlive(Elastic.Clients.Elasticsearch.Serverless } /// - /// If true, Elasticsearch stores synchronous searches if you also specify the wait_for_completion_timeout parameter. If false, Elasticsearch only stores async searches that don’t finish before the wait_for_completion_timeout. + /// + /// If true, Elasticsearch stores synchronous searches if you also specify the wait_for_completion_timeout parameter. If false, Elasticsearch only stores async searches that don’t finish before the wait_for_completion_timeout. + /// /// public QueryRequestDescriptor KeepOnCompletion(bool? keepOnCompletion = true) { @@ -608,7 +708,9 @@ public QueryRequestDescriptor KeepOnCompletion(bool? keepOnCompletion = true) } /// - /// The timeout before a pagination request fails. + /// + /// The timeout before a pagination request fails. + /// /// public QueryRequestDescriptor PageTimeout(Elastic.Clients.Elasticsearch.Serverless.Duration? pageTimeout) { @@ -617,7 +719,9 @@ public QueryRequestDescriptor PageTimeout(Elastic.Clients.Elasticsearch.Serverle } /// - /// Values for parameters in the query. + /// + /// Values for parameters in the query. + /// /// public QueryRequestDescriptor Params(Func, FluentDictionary> selector) { @@ -626,7 +730,9 @@ public QueryRequestDescriptor Params(Func, Flue } /// - /// SQL query to run. + /// + /// SQL query to run. + /// /// public QueryRequestDescriptor Query(string? query) { @@ -635,7 +741,9 @@ public QueryRequestDescriptor Query(string? query) } /// - /// The timeout before the request fails. + /// + /// The timeout before the request fails. + /// /// public QueryRequestDescriptor RequestTimeout(Elastic.Clients.Elasticsearch.Serverless.Duration? requestTimeout) { @@ -644,7 +752,10 @@ public QueryRequestDescriptor RequestTimeout(Elastic.Clients.Elasticsearch.Serve } /// - /// Defines one or more runtime fields in the search request. These fields take
precedence over mapped fields with the same name. + /// + /// Defines one or more runtime fields in the search request. These fields take + /// precedence over mapped fields with the same name. + /// /// public QueryRequestDescriptor RuntimeMappings(Func, FluentDescriptorDictionary> selector) { @@ -653,7 +764,9 @@ public QueryRequestDescriptor RuntimeMappings(Func - /// ISO-8601 time zone ID for the search. + /// + /// ISO-8601 time zone ID for the search. + /// /// public QueryRequestDescriptor TimeZone(string? timeZone) { @@ -662,7 +775,9 @@ public QueryRequestDescriptor TimeZone(string? timeZone) } /// - /// Period to wait for complete results. Defaults to no timeout, meaning the request waits for complete search results. If the search doesn’t finish within this period, the search becomes async. + /// + /// Period to wait for complete results. Defaults to no timeout, meaning the request waits for complete search results. If the search doesn’t finish within this period, the search becomes async. + /// /// public QueryRequestDescriptor WaitForCompletionTimeout(Elastic.Clients.Elasticsearch.Serverless.Duration? waitForCompletionTimeout) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/QueryResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/QueryResponse.g.cs index 071d362d93f..3b1a52167ce 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/QueryResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/QueryResponse.g.cs @@ -29,31 +29,51 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Sql; public sealed partial class QueryResponse : ElasticsearchResponse { /// - /// Column headings for the search results. Each object is a column. + /// + /// Column headings for the search results. Each object is a column. + /// /// [JsonInclude, JsonPropertyName("columns")] public IReadOnlyCollection? Columns { get; init; } /// - /// Cursor for the next set of paginated results. For CSV, TSV, and
TXT responses, this value is returned in the `Cursor` HTTP header. + /// + /// Cursor for the next set of paginated results. For CSV, TSV, and + /// TXT responses, this value is returned in the Cursor HTTP header. + /// /// [JsonInclude, JsonPropertyName("cursor")] public string? Cursor { get; init; } /// - /// Identifier for the search. This value is only returned for async and saved
synchronous searches. For CSV, TSV, and TXT responses, this value is returned
in the `Async-ID` HTTP header. + /// + /// Identifier for the search. This value is only returned for async and saved + /// synchronous searches. For CSV, TSV, and TXT responses, this value is returned + /// in the Async-ID HTTP header. + /// /// [JsonInclude, JsonPropertyName("id")] public string? Id { get; init; } /// - /// If `true`, the response does not contain complete search results. If `is_partial`
is `true` and `is_running` is `true`, the search is still running. If `is_partial`
is `true` but `is_running` is `false`, the results are partial due to a failure or
timeout. This value is only returned for async and saved synchronous searches.
For CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header. + /// + /// If true, the response does not contain complete search results. If is_partial + /// is true and is_running is true, the search is still running. If is_partial + /// is true but is_running is false, the results are partial due to a failure or + /// timeout. This value is only returned for async and saved synchronous searches. + /// For CSV, TSV, and TXT responses, this value is returned in the Async-partial HTTP header. + /// /// [JsonInclude, JsonPropertyName("is_partial")] public bool? IsPartial { get; init; } /// - /// If `true`, the search is still running. If false, the search has finished.
This value is only returned for async and saved synchronous searches. For
CSV, TSV, and TXT responses, this value is returned in the `Async-partial`
HTTP header. + /// + /// If true, the search is still running. If false, the search has finished. + /// This value is only returned for async and saved synchronous searches. For + /// CSV, TSV, and TXT responses, this value is returned in the Async-partial + /// HTTP header. + /// /// [JsonInclude, JsonPropertyName("is_running")] public bool? IsRunning { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/TranslateRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/TranslateRequest.g.cs index d66b32806af..ff1c27a038b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/TranslateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/TranslateRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class TranslateRequestParameters : RequestParameters } /// -/// Translates SQL into Elasticsearch queries +/// +/// Translates SQL into Elasticsearch queries +/// /// public sealed partial class TranslateRequest : PlainRequest { @@ -47,32 +49,42 @@ public sealed partial class TranslateRequest : PlainRequest "sql.translate"; /// - /// The maximum number of rows (or entries) to return in one response. + /// + /// The maximum number of rows (or entries) to return in one response. + /// /// [JsonInclude, JsonPropertyName("fetch_size")] public int? FetchSize { get; set; } /// - /// Elasticsearch query DSL for additional filtering. + /// + /// Elasticsearch query DSL for additional filtering. + /// /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? Filter { get; set; } /// - /// SQL query to run. + /// + /// SQL query to run. + /// /// [JsonInclude, JsonPropertyName("query")] public string Query { get; set; } /// - /// ISO-8601 time zone ID for the search. + /// + /// ISO-8601 time zone ID for the search. + /// /// [JsonInclude, JsonPropertyName("time_zone")] public string? TimeZone { get; set; } } /// -/// Translates SQL into Elasticsearch queries +/// +/// Translates SQL into Elasticsearch queries +/// /// public sealed partial class TranslateRequestDescriptor : RequestDescriptor, TranslateRequestParameters> { @@ -98,7 +110,9 @@ public TranslateRequestDescriptor() private string? TimeZoneValue { get; set; } /// - /// The maximum number of rows (or entries) to return in one response. + /// + /// The maximum number of rows (or entries) to return in one response. + /// /// public TranslateRequestDescriptor FetchSize(int? fetchSize) { @@ -107,7 +121,9 @@ public TranslateRequestDescriptor FetchSize(int? fetchSize) } /// - /// Elasticsearch query DSL for additional filtering. + /// + /// Elasticsearch query DSL for additional filtering. + /// /// public TranslateRequestDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? filter) { @@ -134,7 +150,9 @@ public TranslateRequestDescriptor Filter(Action - /// SQL query to run. + /// + /// SQL query to run. + /// /// public TranslateRequestDescriptor Query(string query) { @@ -143,7 +161,9 @@ public TranslateRequestDescriptor Query(string query) } /// - /// ISO-8601 time zone ID for the search. + /// + /// ISO-8601 time zone ID for the search. + /// /// public TranslateRequestDescriptor TimeZone(string? timeZone) { @@ -189,7 +209,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Translates SQL into Elasticsearch queries +/// +/// Translates SQL into Elasticsearch queries +/// /// public sealed partial class TranslateRequestDescriptor : RequestDescriptor { @@ -215,7 +237,9 @@ public TranslateRequestDescriptor() private string? TimeZoneValue { get; set; } /// - /// The maximum number of rows (or entries) to return in one response. + /// + /// The maximum number of rows (or entries) to return in one response. + /// /// public TranslateRequestDescriptor FetchSize(int? fetchSize) { @@ -224,7 +248,9 @@ public TranslateRequestDescriptor FetchSize(int? fetchSize) } /// - /// Elasticsearch query DSL for additional filtering. + /// + /// Elasticsearch query DSL for additional filtering. + /// /// public TranslateRequestDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? filter) { @@ -251,7 +277,9 @@ public TranslateRequestDescriptor Filter(Action - /// SQL query to run. + /// + /// SQL query to run. + /// /// public TranslateRequestDescriptor Query(string query) { @@ -260,7 +288,9 @@ public TranslateRequestDescriptor Query(string query) } /// - /// ISO-8601 time zone ID for the search. + /// + /// ISO-8601 time zone ID for the search. + /// /// public TranslateRequestDescriptor TimeZone(string? timeZone) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/DeleteSynonymRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/DeleteSynonymRequest.g.cs index d3929942076..6020d220ab2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/DeleteSynonymRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/DeleteSynonymRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class DeleteSynonymRequestParameters : RequestParameters } /// -/// Deletes a synonym set +/// +/// Deletes a synonym set +/// /// public sealed partial class DeleteSynonymRequest : PlainRequest { @@ -52,7 +54,9 @@ public DeleteSynonymRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : ba } /// -/// Deletes a synonym set +/// +/// Deletes a synonym set +/// /// public sealed partial class DeleteSynonymRequestDescriptor : RequestDescriptor, DeleteSynonymRequestParameters> { @@ -82,7 +86,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Deletes a synonym set +/// +/// Deletes a synonym set +/// /// public sealed partial class DeleteSynonymRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/DeleteSynonymResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/DeleteSynonymResponse.g.cs index a1ed28894bb..479bdd5aaa4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/DeleteSynonymResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/DeleteSynonymResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Synonyms; public sealed partial class DeleteSynonymResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/DeleteSynonymRuleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/DeleteSynonymRuleRequest.g.cs index 7e90ec003e2..b7738711561 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/DeleteSynonymRuleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/DeleteSynonymRuleRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class DeleteSynonymRuleRequestParameters : RequestParamete } /// -/// Deletes a synonym rule in a synonym set +/// +/// Deletes a synonym rule in a synonym set +/// /// public sealed partial class DeleteSynonymRuleRequest : PlainRequest { @@ -52,7 +54,9 @@ public DeleteSynonymRuleRequest(Elastic.Clients.Elasticsearch.Serverless.Id setI } /// -/// Deletes a synonym rule in a synonym set +/// +/// Deletes a synonym rule in a synonym set +/// /// public sealed partial class DeleteSynonymRuleRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/DeleteSynonymRuleResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/DeleteSynonymRuleResponse.g.cs index 6e133b1bded..73974df9ed9 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/DeleteSynonymRuleResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/DeleteSynonymRuleResponse.g.cs @@ -29,13 +29,18 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Synonyms; public sealed partial class DeleteSynonymRuleResponse : ElasticsearchResponse { /// - /// Updating synonyms in a synonym set reloads the associated analyzers.
This is the analyzers reloading result + /// + /// Updating synonyms in a synonym set reloads the associated analyzers. + /// This is the analyzers reloading result + /// /// [JsonInclude, JsonPropertyName("reload_analyzers_details")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.ReloadResult ReloadAnalyzersDetails { get; init; } /// - /// Update operation result + /// + /// Update operation result + /// /// [JsonInclude, JsonPropertyName("result")] public Elastic.Clients.Elasticsearch.Serverless.Result Result { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/GetSynonymRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/GetSynonymRequest.g.cs index 09e85b1f821..fd701fa1eba 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/GetSynonymRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/GetSynonymRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Synonyms; public sealed partial class GetSynonymRequestParameters : RequestParameters { /// - /// Starting offset for query rules to be retrieved + /// + /// Starting offset for query rules to be retrieved + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// specifies a max number of query rules to retrieve + /// + /// specifies a max number of query rules to retrieve + /// /// public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Retrieves a synonym set +/// +/// Retrieves a synonym set +/// /// public sealed partial class GetSynonymRequest : PlainRequest { @@ -60,20 +66,26 @@ public GetSynonymRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : base( internal override string OperationName => "synonyms.get_synonym"; /// - /// Starting offset for query rules to be retrieved + /// + /// Starting offset for query rules to be retrieved + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// specifies a max number of query rules to retrieve + /// + /// specifies a max number of query rules to retrieve + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Retrieves a synonym set +/// +/// Retrieves a synonym set +/// /// public sealed partial class GetSynonymRequestDescriptor : RequestDescriptor, GetSynonymRequestParameters> { @@ -106,7 +118,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Retrieves a synonym set +/// +/// Retrieves a synonym set +/// /// public sealed partial class GetSynonymRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/GetSynonymRuleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/GetSynonymRuleRequest.g.cs index 574166d6ff1..40e41cdafdd 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/GetSynonymRuleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/GetSynonymRuleRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class GetSynonymRuleRequestParameters : RequestParameters } /// -/// Retrieves a synonym rule from a synonym set +/// +/// Retrieves a synonym rule from a synonym set +/// /// public sealed partial class GetSynonymRuleRequest : PlainRequest { @@ -52,7 +54,9 @@ public GetSynonymRuleRequest(Elastic.Clients.Elasticsearch.Serverless.Id setId, } /// -/// Retrieves a synonym rule from a synonym set +/// +/// Retrieves a synonym rule from a synonym set +/// /// public sealed partial class GetSynonymRuleRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/GetSynonymRuleResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/GetSynonymRuleResponse.g.cs index d010730a552..ddf0532449c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/GetSynonymRuleResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/GetSynonymRuleResponse.g.cs @@ -29,13 +29,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Synonyms; public sealed partial class GetSynonymRuleResponse : ElasticsearchResponse { /// - /// Synonym Rule identifier + /// + /// Synonym Rule identifier + /// /// [JsonInclude, JsonPropertyName("id")] public string Id { get; init; } /// - /// Synonyms, in Solr format, that conform the synonym rule. See https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#_solr_synonyms_2 + /// + /// Synonyms, in Solr format, that conform the synonym rule. See https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#_solr_synonyms_2 + /// /// [JsonInclude, JsonPropertyName("synonyms")] public string Synonyms { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/GetSynonymsSetsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/GetSynonymsSetsRequest.g.cs index b545a2b71fc..b48b61f87af 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/GetSynonymsSetsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/GetSynonymsSetsRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Synonyms; public sealed partial class GetSynonymsSetsRequestParameters : RequestParameters { /// - /// Starting offset + /// + /// Starting offset + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// specifies a max number of results to get + /// + /// specifies a max number of results to get + /// /// public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Retrieves a summary of all defined synonym sets +/// +/// Retrieves a summary of all defined synonym sets +/// /// public sealed partial class GetSynonymsSetsRequest : PlainRequest { @@ -56,20 +62,26 @@ public sealed partial class GetSynonymsSetsRequest : PlainRequest "synonyms.get_synonyms_sets"; /// - /// Starting offset + /// + /// Starting offset + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// specifies a max number of results to get + /// + /// specifies a max number of results to get + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Retrieves a summary of all defined synonym sets +/// +/// Retrieves a summary of all defined synonym sets +/// /// public sealed partial class GetSynonymsSetsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/PutSynonymRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/PutSynonymRequest.g.cs index 4c27c3210a2..c670e0332d1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/PutSynonymRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/PutSynonymRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class PutSynonymRequestParameters : RequestParameters } /// -/// Creates or updates a synonym set. +/// +/// Creates or updates a synonym set. +/// /// public sealed partial class PutSynonymRequest : PlainRequest { @@ -51,14 +53,18 @@ public PutSynonymRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : base( internal override string OperationName => "synonyms.put_synonym"; /// - /// The synonym set information to update + /// + /// The synonym set information to update + /// /// [JsonInclude, JsonPropertyName("synonyms_set")] public ICollection SynonymsSet { get; set; } } /// -/// Creates or updates a synonym set. +/// +/// Creates or updates a synonym set. +/// /// public sealed partial class PutSynonymRequestDescriptor : RequestDescriptor, PutSynonymRequestParameters> { @@ -88,7 +94,9 @@ public PutSynonymRequestDescriptor Id(Elastic.Clients.Elasticsearch.S private Action[] SynonymsSetDescriptorActions { get; set; } /// - /// The synonym set information to update + /// + /// The synonym set information to update + /// /// public PutSynonymRequestDescriptor SynonymsSet(ICollection synonymsSet) { @@ -165,7 +173,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Creates or updates a synonym set. +/// +/// Creates or updates a synonym set. +/// /// public sealed partial class PutSynonymRequestDescriptor : RequestDescriptor { @@ -195,7 +205,9 @@ public PutSynonymRequestDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.I private Action[] SynonymsSetDescriptorActions { get; set; } /// - /// The synonym set information to update + /// + /// The synonym set information to update + /// /// public PutSynonymRequestDescriptor SynonymsSet(ICollection synonymsSet) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/PutSynonymRuleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/PutSynonymRuleRequest.g.cs index 0aa6ba769a5..0817a1097d0 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/PutSynonymRuleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/PutSynonymRuleRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class PutSynonymRuleRequestParameters : RequestParameters } /// -/// Creates or updates a synonym rule in a synonym set +/// +/// Creates or updates a synonym rule in a synonym set +/// /// public sealed partial class PutSynonymRuleRequest : PlainRequest { @@ -55,7 +57,9 @@ public PutSynonymRuleRequest(Elastic.Clients.Elasticsearch.Serverless.Id setId, } /// -/// Creates or updates a synonym rule in a synonym set +/// +/// Creates or updates a synonym rule in a synonym set +/// /// public sealed partial class PutSynonymRuleRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/PutSynonymRuleResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/PutSynonymRuleResponse.g.cs index 89557b91831..242f0cd0cde 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/PutSynonymRuleResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/PutSynonymRuleResponse.g.cs @@ -29,13 +29,18 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Synonyms; public sealed partial class PutSynonymRuleResponse : ElasticsearchResponse { /// - /// Updating synonyms in a synonym set reloads the associated analyzers.
This is the analyzers reloading result + /// + /// Updating synonyms in a synonym set reloads the associated analyzers. + /// This is the analyzers reloading result + /// /// [JsonInclude, JsonPropertyName("reload_analyzers_details")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.ReloadResult ReloadAnalyzersDetails { get; init; } /// - /// Update operation result + /// + /// Update operation result + /// /// [JsonInclude, JsonPropertyName("result")] public Elastic.Clients.Elasticsearch.Serverless.Result Result { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TermVectorsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TermVectorsRequest.g.cs index c27095b46c3..188b3bbb320 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TermVectorsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TermVectorsRequest.g.cs @@ -32,63 +32,90 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class TermVectorsRequestParameters : RequestParameters { /// - /// Comma-separated list or wildcard expressions of fields to include in the statistics.
Used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. + /// + /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// Used as the default list unless a specific field list is provided in the completion_fields or fielddata_fields parameters. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? Fields { get => Q("fields"); set => Q("fields", value); } /// - /// If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + /// + /// If true, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + /// /// public bool? FieldStatistics { get => Q("field_statistics"); set => Q("field_statistics", value); } /// - /// If `true`, the response includes term offsets. + /// + /// If true, the response includes term offsets. + /// /// public bool? Offsets { get => Q("offsets"); set => Q("offsets", value); } /// - /// If `true`, the response includes term payloads. + /// + /// If true, the response includes term payloads. + /// /// public bool? Payloads { get => Q("payloads"); set => Q("payloads", value); } /// - /// If `true`, the response includes term positions. + /// + /// If true, the response includes term positions. + /// /// public bool? Positions { get => Q("positions"); set => Q("positions", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If true, the request is real-time as opposed to near-real-time. + /// + /// If true, the request is real-time as opposed to near-real-time. + /// /// public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// If `true`, the response includes term frequency and document frequency. + /// + /// If true, the response includes term frequency and document frequency. + /// /// public bool? TermStatistics { get => Q("term_statistics"); set => Q("term_statistics", value); } /// - /// If `true`, returns the document version as part of a hit. + /// + /// If true, returns the document version as part of a hit. + /// /// public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type. + /// + /// Specific version type. + /// /// public Elastic.Clients.Elasticsearch.Serverless.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } } /// -/// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. +/// +/// Get term vector information. +/// Returns information and statistics about terms in the fields of a particular document. +/// /// public sealed partial class TermVectorsRequest : PlainRequest { @@ -109,93 +136,126 @@ public TermVectorsRequest(Elastic.Clients.Elasticsearch.Serverless.IndexName ind internal override string OperationName => "termvectors"; /// - /// Comma-separated list or wildcard expressions of fields to include in the statistics.
Used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. + /// + /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// Used as the default list unless a specific field list is provided in the completion_fields or fielddata_fields parameters. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? Fields { get => Q("fields"); set => Q("fields", value); } /// - /// If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + /// + /// If true, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + /// /// [JsonIgnore] public bool? FieldStatistics { get => Q("field_statistics"); set => Q("field_statistics", value); } /// - /// If `true`, the response includes term offsets. + /// + /// If true, the response includes term offsets. + /// /// [JsonIgnore] public bool? Offsets { get => Q("offsets"); set => Q("offsets", value); } /// - /// If `true`, the response includes term payloads. + /// + /// If true, the response includes term payloads. + /// /// [JsonIgnore] public bool? Payloads { get => Q("payloads"); set => Q("payloads", value); } /// - /// If `true`, the response includes term positions. + /// + /// If true, the response includes term positions. + /// /// [JsonIgnore] public bool? Positions { get => Q("positions"); set => Q("positions", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If true, the request is real-time as opposed to near-real-time. + /// + /// If true, the request is real-time as opposed to near-real-time. + /// /// [JsonIgnore] public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// If `true`, the response includes term frequency and document frequency. + /// + /// If true, the response includes term frequency and document frequency. + /// /// [JsonIgnore] public bool? TermStatistics { get => Q("term_statistics"); set => Q("term_statistics", value); } /// - /// If `true`, returns the document version as part of a hit. + /// + /// If true, returns the document version as part of a hit. + /// /// [JsonIgnore] public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type. + /// + /// Specific version type. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } /// - /// An artificial document (a document not present in the index) for which you want to retrieve term vectors. + /// + /// An artificial document (a document not present in the index) for which you want to retrieve term vectors. + /// /// [JsonInclude, JsonPropertyName("doc")] [SourceConverter] public TDocument? Doc { get; set; } /// - /// Filter terms based on their tf-idf scores. + /// + /// Filter terms based on their tf-idf scores. + /// /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.Serverless.Core.TermVectors.Filter? Filter { get; set; } /// - /// Overrides the default per-field analyzer. + /// + /// Overrides the default per-field analyzer. + /// /// [JsonInclude, JsonPropertyName("per_field_analyzer")] public IDictionary? PerFieldAnalyzer { get; set; } } /// -/// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. +/// +/// Get term vector information. +/// Returns information and statistics about terms in the fields of a particular document. +/// /// public sealed partial class TermVectorsRequestDescriptor : RequestDescriptor, TermVectorsRequestParameters> { @@ -264,7 +324,9 @@ public TermVectorsRequestDescriptor Index(Elastic.Clients.Elasticsear private IDictionary? PerFieldAnalyzerValue { get; set; } /// - /// An artificial document (a document not present in the index) for which you want to retrieve term vectors. + /// + /// An artificial document (a document not present in the index) for which you want to retrieve term vectors. + /// /// public TermVectorsRequestDescriptor Doc(TDocument? doc) { @@ -273,7 +335,9 @@ public TermVectorsRequestDescriptor Doc(TDocument? doc) } /// - /// Filter terms based on their tf-idf scores. + /// + /// Filter terms based on their tf-idf scores. + /// /// public TermVectorsRequestDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.Core.TermVectors.Filter? filter) { @@ -300,7 +364,9 @@ public TermVectorsRequestDescriptor Filter(Action - /// Overrides the default per-field analyzer. + /// + /// Overrides the default per-field analyzer. + /// /// public TermVectorsRequestDescriptor PerFieldAnalyzer(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TermsEnumRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TermsEnumRequest.g.cs index 95e39f9cd8c..bb1c84842d9 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TermsEnumRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TermsEnumRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class TermsEnumRequestParameters : RequestParameters } /// -/// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. +/// +/// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. +/// /// public sealed partial class TermsEnumRequest : PlainRequest { @@ -51,19 +53,25 @@ public TermsEnumRequest(Elastic.Clients.Elasticsearch.Serverless.IndexName index internal override string OperationName => "terms_enum"; /// - /// When true the provided search string is matched against index terms without case sensitivity. + /// + /// When true the provided search string is matched against index terms without case sensitivity. + /// /// [JsonInclude, JsonPropertyName("case_insensitive")] public bool? CaseInsensitive { get; set; } /// - /// The string to match at the start of indexed terms. If not provided, all terms in the field are considered. + /// + /// The string to match at the start of indexed terms. If not provided, all terms in the field are considered. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Allows to filter an index shard if the provided query rewrites to match_none. + /// + /// Allows to filter an index shard if the provided query rewrites to match_none. + /// /// [JsonInclude, JsonPropertyName("index_filter")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? IndexFilter { get; set; } @@ -71,26 +79,34 @@ public TermsEnumRequest(Elastic.Clients.Elasticsearch.Serverless.IndexName index public string? SearchAfter { get; set; } /// - /// How many matching terms to return. + /// + /// How many matching terms to return. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// The string after which terms in the index should be returned. Allows for a form of pagination if the last result from one request is passed as the search_after parameter for a subsequent request. + /// + /// The string after which terms in the index should be returned. Allows for a form of pagination if the last result from one request is passed as the search_after parameter for a subsequent request. + /// /// [JsonInclude, JsonPropertyName("string")] public string? String { get; set; } /// - /// The maximum length of time to spend collecting results. Defaults to "1s" (one second). If the timeout is exceeded the complete flag set to false in the response and the results may be partial or empty. + /// + /// The maximum length of time to spend collecting results. Defaults to "1s" (one second). If the timeout is exceeded the complete flag set to false in the response and the results may be partial or empty. + /// /// [JsonInclude, JsonPropertyName("timeout")] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get; set; } } /// -/// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. +/// +/// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. +/// /// public sealed partial class TermsEnumRequestDescriptor : RequestDescriptor, TermsEnumRequestParameters> { @@ -129,7 +145,9 @@ public TermsEnumRequestDescriptor Index(Elastic.Clients.Elasticsearch private Elastic.Clients.Elasticsearch.Serverless.Duration? TimeoutValue { get; set; } /// - /// When true the provided search string is matched against index terms without case sensitivity. + /// + /// When true the provided search string is matched against index terms without case sensitivity. + /// /// public TermsEnumRequestDescriptor CaseInsensitive(bool? caseInsensitive = true) { @@ -138,7 +156,9 @@ public TermsEnumRequestDescriptor CaseInsensitive(bool? caseInsensiti } /// - /// The string to match at the start of indexed terms. If not provided, all terms in the field are considered. + /// + /// The string to match at the start of indexed terms. If not provided, all terms in the field are considered. + /// /// public TermsEnumRequestDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -147,7 +167,9 @@ public TermsEnumRequestDescriptor Field(Elastic.Clients.Elasticsearch } /// - /// The string to match at the start of indexed terms. If not provided, all terms in the field are considered. + /// + /// The string to match at the start of indexed terms. If not provided, all terms in the field are considered. + /// /// public TermsEnumRequestDescriptor Field(Expression> field) { @@ -156,7 +178,9 @@ public TermsEnumRequestDescriptor Field(Expression - /// The string to match at the start of indexed terms. If not provided, all terms in the field are considered. + /// + /// The string to match at the start of indexed terms. If not provided, all terms in the field are considered. + /// /// public TermsEnumRequestDescriptor Field(Expression> field) { @@ -165,7 +189,9 @@ public TermsEnumRequestDescriptor Field(Expression - /// Allows to filter an index shard if the provided query rewrites to match_none. + /// + /// Allows to filter an index shard if the provided query rewrites to match_none. + /// /// public TermsEnumRequestDescriptor IndexFilter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? indexFilter) { @@ -198,7 +224,9 @@ public TermsEnumRequestDescriptor SearchAfter(string? searchAfter) } /// - /// How many matching terms to return. + /// + /// How many matching terms to return. + /// /// public TermsEnumRequestDescriptor Size(int? size) { @@ -207,7 +235,9 @@ public TermsEnumRequestDescriptor Size(int? size) } /// - /// The string after which terms in the index should be returned. Allows for a form of pagination if the last result from one request is passed as the search_after parameter for a subsequent request. + /// + /// The string after which terms in the index should be returned. Allows for a form of pagination if the last result from one request is passed as the search_after parameter for a subsequent request. + /// /// public TermsEnumRequestDescriptor String(string? value) { @@ -216,7 +246,9 @@ public TermsEnumRequestDescriptor String(string? value) } /// - /// The maximum length of time to spend collecting results. Defaults to "1s" (one second). If the timeout is exceeded the complete flag set to false in the response and the results may be partial or empty. + /// + /// The maximum length of time to spend collecting results. Defaults to "1s" (one second). If the timeout is exceeded the complete flag set to false in the response and the results may be partial or empty. + /// /// public TermsEnumRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Serverless.Duration? timeout) { @@ -280,7 +312,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. +/// +/// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. +/// /// public sealed partial class TermsEnumRequestDescriptor : RequestDescriptor { @@ -315,7 +349,9 @@ public TermsEnumRequestDescriptor Index(Elastic.Clients.Elasticsearch.Serverless private Elastic.Clients.Elasticsearch.Serverless.Duration? TimeoutValue { get; set; } /// - /// When true the provided search string is matched against index terms without case sensitivity. + /// + /// When true the provided search string is matched against index terms without case sensitivity. + /// /// public TermsEnumRequestDescriptor CaseInsensitive(bool? caseInsensitive = true) { @@ -324,7 +360,9 @@ public TermsEnumRequestDescriptor CaseInsensitive(bool? caseInsensitive = true) } /// - /// The string to match at the start of indexed terms. If not provided, all terms in the field are considered. + /// + /// The string to match at the start of indexed terms. If not provided, all terms in the field are considered. + /// /// public TermsEnumRequestDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -333,7 +371,9 @@ public TermsEnumRequestDescriptor Field(Elastic.Clients.Elasticsearch.Serverless } /// - /// The string to match at the start of indexed terms. If not provided, all terms in the field are considered. + /// + /// The string to match at the start of indexed terms. If not provided, all terms in the field are considered. + /// /// public TermsEnumRequestDescriptor Field(Expression> field) { @@ -342,7 +382,9 @@ public TermsEnumRequestDescriptor Field(Expression - /// The string to match at the start of indexed terms. If not provided, all terms in the field are considered. + /// + /// The string to match at the start of indexed terms. If not provided, all terms in the field are considered. + /// /// public TermsEnumRequestDescriptor Field(Expression> field) { @@ -351,7 +393,9 @@ public TermsEnumRequestDescriptor Field(Expression - /// Allows to filter an index shard if the provided query rewrites to match_none. + /// + /// Allows to filter an index shard if the provided query rewrites to match_none. + /// /// public TermsEnumRequestDescriptor IndexFilter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? indexFilter) { @@ -384,7 +428,9 @@ public TermsEnumRequestDescriptor SearchAfter(string? searchAfter) } /// - /// How many matching terms to return. + /// + /// How many matching terms to return. + /// /// public TermsEnumRequestDescriptor Size(int? size) { @@ -393,7 +439,9 @@ public TermsEnumRequestDescriptor Size(int? size) } /// - /// The string after which terms in the index should be returned. Allows for a form of pagination if the last result from one request is passed as the search_after parameter for a subsequent request. + /// + /// The string after which terms in the index should be returned. Allows for a form of pagination if the last result from one request is passed as the search_after parameter for a subsequent request. + /// /// public TermsEnumRequestDescriptor String(string? value) { @@ -402,7 +450,9 @@ public TermsEnumRequestDescriptor String(string? value) } /// - /// The maximum length of time to spend collecting results. Defaults to "1s" (one second). If the timeout is exceeded the complete flag set to false in the response and the results may be partial or empty. + /// + /// The maximum length of time to spend collecting results. Defaults to "1s" (one second). If the timeout is exceeded the complete flag set to false in the response and the results may be partial or empty. + /// /// public TermsEnumRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Serverless.Duration? timeout) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TextStructure/TestGrokPatternRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TextStructure/TestGrokPatternRequest.g.cs index 649f9a97484..7a919159f1b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TextStructure/TestGrokPatternRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TextStructure/TestGrokPatternRequest.g.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.TextStructure; public sealed partial class TestGrokPatternRequestParameters : RequestParameters { /// - /// The mode of compatibility with ECS compliant Grok patterns (disabled or v1, default: disabled). + /// + /// The mode of compatibility with ECS compliant Grok patterns (disabled or v1, default: disabled). + /// /// public string? EcsCompatibility { get => Q("ecs_compatibility"); set => Q("ecs_compatibility", value); } } /// -/// Tests a Grok pattern on some text. +/// +/// Tests a Grok pattern on some text. +/// /// public sealed partial class TestGrokPatternRequest : PlainRequest { @@ -51,26 +55,34 @@ public sealed partial class TestGrokPatternRequest : PlainRequest "text_structure.test_grok_pattern"; /// - /// The mode of compatibility with ECS compliant Grok patterns (disabled or v1, default: disabled). + /// + /// The mode of compatibility with ECS compliant Grok patterns (disabled or v1, default: disabled). + /// /// [JsonIgnore] public string? EcsCompatibility { get => Q("ecs_compatibility"); set => Q("ecs_compatibility", value); } /// - /// Grok pattern to run on the text. + /// + /// Grok pattern to run on the text. + /// /// [JsonInclude, JsonPropertyName("grok_pattern")] public string GrokPattern { get; set; } /// - /// Lines of text to run the Grok pattern on. + /// + /// Lines of text to run the Grok pattern on. + /// /// [JsonInclude, JsonPropertyName("text")] public ICollection Text { get; set; } } /// -/// Tests a Grok pattern on some text. +/// +/// Tests a Grok pattern on some text. +/// /// public sealed partial class TestGrokPatternRequestDescriptor : RequestDescriptor { @@ -94,7 +106,9 @@ public TestGrokPatternRequestDescriptor() private ICollection TextValue { get; set; } /// - /// Grok pattern to run on the text. + /// + /// Grok pattern to run on the text. + /// /// public TestGrokPatternRequestDescriptor GrokPattern(string grokPattern) { @@ -103,7 +117,9 @@ public TestGrokPatternRequestDescriptor GrokPattern(string grokPattern) } /// - /// Lines of text to run the Grok pattern on. + /// + /// Lines of text to run the Grok pattern on. + /// /// public TestGrokPatternRequestDescriptor Text(ICollection text) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/DeleteTransformRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/DeleteTransformRequest.g.cs index 2f1b3437ff7..9f3ae50b26c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/DeleteTransformRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/DeleteTransformRequest.g.cs @@ -32,23 +32,34 @@ namespace Elastic.Clients.Elasticsearch.Serverless.TransformManagement; public sealed partial class DeleteTransformRequestParameters : RequestParameters { /// - /// If this value is true, the destination index is deleted together with the transform. If false, the destination
index will not be deleted + /// + /// If this value is true, the destination index is deleted together with the transform. If false, the destination + /// index will not be deleted + /// /// public bool? DeleteDestIndex { get => Q("delete_dest_index"); set => Q("delete_dest_index", value); } /// - /// If this value is false, the transform must be stopped before it can be deleted. If true, the transform is
deleted regardless of its current state. + /// + /// If this value is false, the transform must be stopped before it can be deleted. If true, the transform is + /// deleted regardless of its current state. + /// /// public bool? Force { get => Q("force"); set => Q("force", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete a transform.
Deletes a transform. +/// +/// Delete a transform. +/// Deletes a transform. +/// /// public sealed partial class DeleteTransformRequest : PlainRequest { @@ -65,26 +76,37 @@ public DeleteTransformRequest(Elastic.Clients.Elasticsearch.Serverless.Id transf internal override string OperationName => "transform.delete_transform"; /// - /// If this value is true, the destination index is deleted together with the transform. If false, the destination
index will not be deleted + /// + /// If this value is true, the destination index is deleted together with the transform. If false, the destination + /// index will not be deleted + /// /// [JsonIgnore] public bool? DeleteDestIndex { get => Q("delete_dest_index"); set => Q("delete_dest_index", value); } /// - /// If this value is false, the transform must be stopped before it can be deleted. If true, the transform is
deleted regardless of its current state. + /// + /// If this value is false, the transform must be stopped before it can be deleted. If true, the transform is + /// deleted regardless of its current state. + /// /// [JsonIgnore] public bool? Force { get => Q("force"); set => Q("force", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete a transform.
Deletes a transform. +/// +/// Delete a transform. +/// Deletes a transform. +/// /// public sealed partial class DeleteTransformRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/DeleteTransformResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/DeleteTransformResponse.g.cs index b96bafac0fe..b39ea167e98 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/DeleteTransformResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/DeleteTransformResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.TransformManagement; public sealed partial class DeleteTransformResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/GetTransformRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/GetTransformRequest.g.cs index 1dc4dbe32a1..49b4e299702 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/GetTransformRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/GetTransformRequest.g.cs @@ -32,30 +32,62 @@ namespace Elastic.Clients.Elasticsearch.Serverless.TransformManagement; public sealed partial class GetTransformRequestParameters : RequestParameters { /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no transforms that match.
2. Contains the _all string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// If this parameter is false, the request returns a 404 status code when
there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no transforms that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// If this parameter is false, the request returns a 404 status code when + /// there are no matches or only partial matches. + /// /// public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Excludes fields that were automatically added when creating the
transform. This allows the configuration to be in an acceptable format to
be retrieved and then added to another cluster. + /// + /// Excludes fields that were automatically added when creating the + /// transform. This allows the configuration to be in an acceptable format to + /// be retrieved and then added to another cluster. + /// /// public bool? ExcludeGenerated { get => Q("exclude_generated"); set => Q("exclude_generated", value); } /// - /// Skips the specified number of transforms. + /// + /// Skips the specified number of transforms. + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of transforms to obtain. + /// + /// Specifies the maximum number of transforms to obtain. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Get transforms.
Retrieves configuration information for transforms. +/// +/// Get transforms. +/// Retrieves configuration information for transforms. +/// /// public sealed partial class GetTransformRequest : PlainRequest { @@ -76,34 +108,66 @@ public GetTransformRequest(Elastic.Clients.Elasticsearch.Serverless.Names? trans internal override string OperationName => "transform.get_transform"; /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no transforms that match.
2. Contains the _all string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// If this parameter is false, the request returns a 404 status code when
there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no transforms that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// If this parameter is false, the request returns a 404 status code when + /// there are no matches or only partial matches. + /// /// [JsonIgnore] public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Excludes fields that were automatically added when creating the
transform. This allows the configuration to be in an acceptable format to
be retrieved and then added to another cluster. + /// + /// Excludes fields that were automatically added when creating the + /// transform. This allows the configuration to be in an acceptable format to + /// be retrieved and then added to another cluster. + /// /// [JsonIgnore] public bool? ExcludeGenerated { get => Q("exclude_generated"); set => Q("exclude_generated", value); } /// - /// Skips the specified number of transforms. + /// + /// Skips the specified number of transforms. + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of transforms to obtain. + /// + /// Specifies the maximum number of transforms to obtain. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Get transforms.
Retrieves configuration information for transforms. +/// +/// Get transforms. +/// Retrieves configuration information for transforms. +/// /// public sealed partial class GetTransformRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/GetTransformStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/GetTransformStatsRequest.g.cs index 28fa8d84769..35c13f2f63f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/GetTransformStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/GetTransformStatsRequest.g.cs @@ -32,30 +32,60 @@ namespace Elastic.Clients.Elasticsearch.Serverless.TransformManagement; public sealed partial class GetTransformStatsRequestParameters : RequestParameters { /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no transforms that match.
2. Contains the _all string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// If this parameter is false, the request returns a 404 status code when
there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no transforms that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// If this parameter is false, the request returns a 404 status code when + /// there are no matches or only partial matches. + /// /// public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Skips the specified number of transforms. + /// + /// Skips the specified number of transforms. + /// /// public long? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of transforms to obtain. + /// + /// Specifies the maximum number of transforms to obtain. + /// /// public long? Size { get => Q("size"); set => Q("size", value); } /// - /// Controls the time to wait for the stats + /// + /// Controls the time to wait for the stats + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Get transform stats.
Retrieves usage information for transforms. +/// +/// Get transform stats. +/// Retrieves usage information for transforms. +/// /// public sealed partial class GetTransformStatsRequest : PlainRequest { @@ -72,34 +102,64 @@ public GetTransformStatsRequest(Elastic.Clients.Elasticsearch.Serverless.Names t internal override string OperationName => "transform.get_transform_stats"; /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no transforms that match.
2. Contains the _all string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// If this parameter is false, the request returns a 404 status code when
there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no transforms that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// If this parameter is false, the request returns a 404 status code when + /// there are no matches or only partial matches. + /// /// [JsonIgnore] public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Skips the specified number of transforms. + /// + /// Skips the specified number of transforms. + /// /// [JsonIgnore] public long? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of transforms to obtain. + /// + /// Specifies the maximum number of transforms to obtain. + /// /// [JsonIgnore] public long? Size { get => Q("size"); set => Q("size", value); } /// - /// Controls the time to wait for the stats + /// + /// Controls the time to wait for the stats + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Get transform stats.
Retrieves usage information for transforms. +/// +/// Get transform stats. +/// Retrieves usage information for transforms. +/// /// public sealed partial class GetTransformStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/PreviewTransformRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/PreviewTransformRequest.g.cs index 62bcf8b9347..522ff56db3e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/PreviewTransformRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/PreviewTransformRequest.g.cs @@ -32,14 +32,24 @@ namespace Elastic.Clients.Elasticsearch.Serverless.TransformManagement; public sealed partial class PreviewTransformRequestParameters : RequestParameters { /// - /// Period to wait for a response. If no response is received before the
timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the + /// timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Preview a transform.
Generates a preview of the results that you will get when you create a transform with the same configuration. -/// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also
generates a list of mappings and settings for the destination index. These values are determined based on the field
types of the source index and the transform aggregations. +/// +/// Preview a transform. +/// Generates a preview of the results that you will get when you create a transform with the same configuration. +/// +/// +/// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also +/// generates a list of mappings and settings for the destination index. These values are determined based on the field +/// types of the source index and the transform aggregations. +/// /// public sealed partial class PreviewTransformRequest : PlainRequest { @@ -60,69 +70,104 @@ public PreviewTransformRequest(Elastic.Clients.Elasticsearch.Serverless.Id? tran internal override string OperationName => "transform.preview_transform"; /// - /// Period to wait for a response. If no response is received before the
timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the + /// timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Free text description of the transform. + /// + /// Free text description of the transform. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The destination for the transform. + /// + /// The destination for the transform. + /// /// [JsonInclude, JsonPropertyName("dest")] public Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Destination? Dest { get; set; } /// - /// The interval between checks for changes in the source indices when the
transform is running continuously. Also determines the retry interval in
the event of transient failures while the transform is searching or
indexing. The minimum value is 1s and the maximum is 1h. + /// + /// The interval between checks for changes in the source indices when the + /// transform is running continuously. Also determines the retry interval in + /// the event of transient failures while the transform is searching or + /// indexing. The minimum value is 1s and the maximum is 1h. + /// /// [JsonInclude, JsonPropertyName("frequency")] public Elastic.Clients.Elasticsearch.Serverless.Duration? Frequency { get; set; } /// - /// The latest method transforms the data by finding the latest document for
each unique key. + /// + /// The latest method transforms the data by finding the latest document for + /// each unique key. + /// /// [JsonInclude, JsonPropertyName("latest")] public Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Latest? Latest { get; set; } /// - /// The pivot method transforms the data by aggregating and grouping it.
These objects define the group by fields and the aggregation to reduce
the data. + /// + /// The pivot method transforms the data by aggregating and grouping it. + /// These objects define the group by fields and the aggregation to reduce + /// the data. + /// /// [JsonInclude, JsonPropertyName("pivot")] public Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Pivot? Pivot { get; set; } /// - /// Defines a retention policy for the transform. Data that meets the defined
criteria is deleted from the destination index. + /// + /// Defines a retention policy for the transform. Data that meets the defined + /// criteria is deleted from the destination index. + /// /// [JsonInclude, JsonPropertyName("retention_policy")] public Elastic.Clients.Elasticsearch.Serverless.TransformManagement.RetentionPolicy? RetentionPolicy { get; set; } /// - /// Defines optional transform settings. + /// + /// Defines optional transform settings. + /// /// [JsonInclude, JsonPropertyName("settings")] public Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Settings? Settings { get; set; } /// - /// The source of the data for the transform. + /// + /// The source of the data for the transform. + /// /// [JsonInclude, JsonPropertyName("source")] public Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Source? Source { get; set; } /// - /// Defines the properties transforms require to run continuously. + /// + /// Defines the properties transforms require to run continuously. + /// /// [JsonInclude, JsonPropertyName("sync")] public Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Sync? Sync { get; set; } } /// -/// Preview a transform.
Generates a preview of the results that you will get when you create a transform with the same configuration. -/// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also
generates a list of mappings and settings for the destination index. These values are determined based on the field
types of the source index and the transform aggregations. +/// +/// Preview a transform. +/// Generates a preview of the results that you will get when you create a transform with the same configuration. +/// +/// +/// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also +/// generates a list of mappings and settings for the destination index. These values are determined based on the field +/// types of the source index and the transform aggregations. +/// /// public sealed partial class PreviewTransformRequestDescriptor : RequestDescriptor, PreviewTransformRequestParameters> { @@ -177,7 +222,9 @@ public PreviewTransformRequestDescriptor TransformId(Elastic.Clients. private Action> SyncDescriptorAction { get; set; } /// - /// Free text description of the transform. + /// + /// Free text description of the transform. + /// /// public PreviewTransformRequestDescriptor Description(string? description) { @@ -186,7 +233,9 @@ public PreviewTransformRequestDescriptor Description(string? descript } /// - /// The destination for the transform. + /// + /// The destination for the transform. + /// /// public PreviewTransformRequestDescriptor Dest(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Destination? dest) { @@ -213,7 +262,12 @@ public PreviewTransformRequestDescriptor Dest(Action - /// The interval between checks for changes in the source indices when the
transform is running continuously. Also determines the retry interval in
the event of transient failures while the transform is searching or
indexing. The minimum value is 1s and the maximum is 1h. + /// + /// The interval between checks for changes in the source indices when the + /// transform is running continuously. Also determines the retry interval in + /// the event of transient failures while the transform is searching or + /// indexing. The minimum value is 1s and the maximum is 1h. + /// /// public PreviewTransformRequestDescriptor Frequency(Elastic.Clients.Elasticsearch.Serverless.Duration? frequency) { @@ -222,7 +276,10 @@ public PreviewTransformRequestDescriptor Frequency(Elastic.Clients.El } /// - /// The latest method transforms the data by finding the latest document for
each unique key. + /// + /// The latest method transforms the data by finding the latest document for + /// each unique key. + /// /// public PreviewTransformRequestDescriptor Latest(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Latest? latest) { @@ -249,7 +306,11 @@ public PreviewTransformRequestDescriptor Latest(Action - /// The pivot method transforms the data by aggregating and grouping it.
These objects define the group by fields and the aggregation to reduce
the data. + /// + /// The pivot method transforms the data by aggregating and grouping it. + /// These objects define the group by fields and the aggregation to reduce + /// the data. + /// /// public PreviewTransformRequestDescriptor Pivot(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Pivot? pivot) { @@ -276,7 +337,10 @@ public PreviewTransformRequestDescriptor Pivot(Action - /// Defines a retention policy for the transform. Data that meets the defined
criteria is deleted from the destination index. + /// + /// Defines a retention policy for the transform. Data that meets the defined + /// criteria is deleted from the destination index. + /// /// public PreviewTransformRequestDescriptor RetentionPolicy(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.RetentionPolicy? retentionPolicy) { @@ -303,7 +367,9 @@ public PreviewTransformRequestDescriptor RetentionPolicy(Action - /// Defines optional transform settings. + /// + /// Defines optional transform settings. + /// /// public PreviewTransformRequestDescriptor Settings(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Settings? settings) { @@ -330,7 +396,9 @@ public PreviewTransformRequestDescriptor Settings(Action - /// The source of the data for the transform. + /// + /// The source of the data for the transform. + /// /// public PreviewTransformRequestDescriptor Source(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Source? source) { @@ -357,7 +425,9 @@ public PreviewTransformRequestDescriptor Source(Action - /// Defines the properties transforms require to run continuously. + /// + /// Defines the properties transforms require to run continuously. + /// /// public PreviewTransformRequestDescriptor Sync(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Sync? sync) { @@ -515,8 +585,15 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Preview a transform.
Generates a preview of the results that you will get when you create a transform with the same configuration. -/// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also
generates a list of mappings and settings for the destination index. These values are determined based on the field
types of the source index and the transform aggregations. +/// +/// Preview a transform. +/// Generates a preview of the results that you will get when you create a transform with the same configuration. +/// +/// +/// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also +/// generates a list of mappings and settings for the destination index. These values are determined based on the field +/// types of the source index and the transform aggregations. +/// /// public sealed partial class PreviewTransformRequestDescriptor : RequestDescriptor { @@ -571,7 +648,9 @@ public PreviewTransformRequestDescriptor TransformId(Elastic.Clients.Elasticsear private Action SyncDescriptorAction { get; set; } /// - /// Free text description of the transform. + /// + /// Free text description of the transform. + /// /// public PreviewTransformRequestDescriptor Description(string? description) { @@ -580,7 +659,9 @@ public PreviewTransformRequestDescriptor Description(string? description) } /// - /// The destination for the transform. + /// + /// The destination for the transform. + /// /// public PreviewTransformRequestDescriptor Dest(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Destination? dest) { @@ -607,7 +688,12 @@ public PreviewTransformRequestDescriptor Dest(Action - /// The interval between checks for changes in the source indices when the
transform is running continuously. Also determines the retry interval in
the event of transient failures while the transform is searching or
indexing. The minimum value is 1s and the maximum is 1h. + /// + /// The interval between checks for changes in the source indices when the + /// transform is running continuously. Also determines the retry interval in + /// the event of transient failures while the transform is searching or + /// indexing. The minimum value is 1s and the maximum is 1h. + /// /// public PreviewTransformRequestDescriptor Frequency(Elastic.Clients.Elasticsearch.Serverless.Duration? frequency) { @@ -616,7 +702,10 @@ public PreviewTransformRequestDescriptor Frequency(Elastic.Clients.Elasticsearch } /// - /// The latest method transforms the data by finding the latest document for
each unique key. + /// + /// The latest method transforms the data by finding the latest document for + /// each unique key. + /// /// public PreviewTransformRequestDescriptor Latest(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Latest? latest) { @@ -643,7 +732,11 @@ public PreviewTransformRequestDescriptor Latest(Action - /// The pivot method transforms the data by aggregating and grouping it.
These objects define the group by fields and the aggregation to reduce
the data. + /// + /// The pivot method transforms the data by aggregating and grouping it. + /// These objects define the group by fields and the aggregation to reduce + /// the data. + /// /// public PreviewTransformRequestDescriptor Pivot(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Pivot? pivot) { @@ -670,7 +763,10 @@ public PreviewTransformRequestDescriptor Pivot(Action - /// Defines a retention policy for the transform. Data that meets the defined
criteria is deleted from the destination index. + /// + /// Defines a retention policy for the transform. Data that meets the defined + /// criteria is deleted from the destination index. + /// /// public PreviewTransformRequestDescriptor RetentionPolicy(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.RetentionPolicy? retentionPolicy) { @@ -697,7 +793,9 @@ public PreviewTransformRequestDescriptor RetentionPolicy(Action - /// Defines optional transform settings. + /// + /// Defines optional transform settings. + /// /// public PreviewTransformRequestDescriptor Settings(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Settings? settings) { @@ -724,7 +822,9 @@ public PreviewTransformRequestDescriptor Settings(Action - /// The source of the data for the transform. + /// + /// The source of the data for the transform. + /// /// public PreviewTransformRequestDescriptor Source(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Source? source) { @@ -751,7 +851,9 @@ public PreviewTransformRequestDescriptor Source(Action - /// Defines the properties transforms require to run continuously. + /// + /// Defines the properties transforms require to run continuously. + /// /// public PreviewTransformRequestDescriptor Sync(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Sync? sync) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/PutTransformRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/PutTransformRequest.g.cs index e16673d7d1b..5f0582187cd 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/PutTransformRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/PutTransformRequest.g.cs @@ -32,22 +32,53 @@ namespace Elastic.Clients.Elasticsearch.Serverless.TransformManagement; public sealed partial class PutTransformRequestParameters : RequestParameters { /// - /// When the transform is created, a series of validations occur to ensure its success. For example, there is a
check for the existence of the source indices and a check that the destination index is not part of the source
index pattern. You can use this parameter to skip the checks, for example when the source index does not exist
until after the transform is created. The validations are always run when you start the transform, however, with
the exception of privilege checks. + /// + /// When the transform is created, a series of validations occur to ensure its success. For example, there is a + /// check for the existence of the source indices and a check that the destination index is not part of the source + /// index pattern. You can use this parameter to skip the checks, for example when the source index does not exist + /// until after the transform is created. The validations are always run when you start the transform, however, with + /// the exception of privilege checks. + /// /// public bool? DeferValidation { get => Q("defer_validation"); set => Q("defer_validation", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Create a transform.
Creates a transform. -/// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as
a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
unique row per entity. -/// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If
you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in
the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values
in the latest object. -/// You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and
`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the
transform remembers which roles the user that created it had at the time of creation and uses those same roles. If
those roles do not have the required privileges on the source and destination indices, the transform fails when it
attempts unauthorized operations. -/// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any
`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not
give users any privileges on `.data-frame-internal*` indices. +/// +/// Create a transform. +/// Creates a transform. +/// +/// +/// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as +/// a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a +/// unique row per entity. +/// +/// +/// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If +/// you choose to use the pivot method for your transform, the entities are defined by the set of group_by fields in +/// the pivot object. If you choose to use the latest method, the entities are defined by the unique_key field values +/// in the latest object. +/// +/// +/// You must have create_index, index, and read privileges on the destination index and read and +/// view_index_metadata privileges on the source indices. When Elasticsearch security features are enabled, the +/// transform remembers which roles the user that created it had at the time of creation and uses those same roles. If +/// those roles do not have the required privileges on the source and destination indices, the transform fails when it +/// attempts unauthorized operations. +/// +/// +/// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any +/// .transform-internal* indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do +/// not give users any privileges on .transform-internal* indices. If you used transforms prior to 7.5, also do not +/// give users any privileges on .data-frame-internal* indices. +/// /// public sealed partial class PutTransformRequest : PlainRequest { @@ -64,84 +95,139 @@ public PutTransformRequest(Elastic.Clients.Elasticsearch.Serverless.Id transform internal override string OperationName => "transform.put_transform"; /// - /// When the transform is created, a series of validations occur to ensure its success. For example, there is a
check for the existence of the source indices and a check that the destination index is not part of the source
index pattern. You can use this parameter to skip the checks, for example when the source index does not exist
until after the transform is created. The validations are always run when you start the transform, however, with
the exception of privilege checks. + /// + /// When the transform is created, a series of validations occur to ensure its success. For example, there is a + /// check for the existence of the source indices and a check that the destination index is not part of the source + /// index pattern. You can use this parameter to skip the checks, for example when the source index does not exist + /// until after the transform is created. The validations are always run when you start the transform, however, with + /// the exception of privilege checks. + /// /// [JsonIgnore] public bool? DeferValidation { get => Q("defer_validation"); set => Q("defer_validation", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Free text description of the transform. + /// + /// Free text description of the transform. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The destination for the transform. + /// + /// The destination for the transform. + /// /// [JsonInclude, JsonPropertyName("dest")] public Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Destination Dest { get; set; } /// - /// The interval between checks for changes in the source indices when the transform is running continuously. Also
determines the retry interval in the event of transient failures while the transform is searching or indexing.
The minimum value is `1s` and the maximum is `1h`. + /// + /// The interval between checks for changes in the source indices when the transform is running continuously. Also + /// determines the retry interval in the event of transient failures while the transform is searching or indexing. + /// The minimum value is 1s and the maximum is 1h. + /// /// [JsonInclude, JsonPropertyName("frequency")] public Elastic.Clients.Elasticsearch.Serverless.Duration? Frequency { get; set; } /// - /// The latest method transforms the data by finding the latest document for each unique key. + /// + /// The latest method transforms the data by finding the latest document for each unique key. + /// /// [JsonInclude, JsonPropertyName("latest")] public Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Latest? Latest { get; set; } /// - /// Defines optional transform metadata. + /// + /// Defines optional transform metadata. + /// /// [JsonInclude, JsonPropertyName("_meta")] public IDictionary? Meta { get; set; } /// - /// The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields
and the aggregation to reduce the data. + /// + /// The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields + /// and the aggregation to reduce the data. + /// /// [JsonInclude, JsonPropertyName("pivot")] public Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Pivot? Pivot { get; set; } /// - /// Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the
destination index. + /// + /// Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the + /// destination index. + /// /// [JsonInclude, JsonPropertyName("retention_policy")] public Elastic.Clients.Elasticsearch.Serverless.TransformManagement.RetentionPolicy? RetentionPolicy { get; set; } /// - /// Defines optional transform settings. + /// + /// Defines optional transform settings. + /// /// [JsonInclude, JsonPropertyName("settings")] public Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Settings? Settings { get; set; } /// - /// The source of the data for the transform. + /// + /// The source of the data for the transform. + /// /// [JsonInclude, JsonPropertyName("source")] public Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Source Source { get; set; } /// - /// Defines the properties transforms require to run continuously. + /// + /// Defines the properties transforms require to run continuously. + /// /// [JsonInclude, JsonPropertyName("sync")] public Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Sync? Sync { get; set; } } /// -/// Create a transform.
Creates a transform. -/// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as
a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
unique row per entity. -/// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If
you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in
the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values
in the latest object. -/// You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and
`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the
transform remembers which roles the user that created it had at the time of creation and uses those same roles. If
those roles do not have the required privileges on the source and destination indices, the transform fails when it
attempts unauthorized operations. -/// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any
`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not
give users any privileges on `.data-frame-internal*` indices. +/// +/// Create a transform. +/// Creates a transform. +/// +/// +/// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as +/// a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a +/// unique row per entity. +/// +/// +/// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If +/// you choose to use the pivot method for your transform, the entities are defined by the set of group_by fields in +/// the pivot object. If you choose to use the latest method, the entities are defined by the unique_key field values +/// in the latest object. +/// +/// +/// You must have create_index, index, and read privileges on the destination index and read and +/// view_index_metadata privileges on the source indices. When Elasticsearch security features are enabled, the +/// transform remembers which roles the user that created it had at the time of creation and uses those same roles. If +/// those roles do not have the required privileges on the source and destination indices, the transform fails when it +/// attempts unauthorized operations. +/// +/// +/// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any +/// .transform-internal* indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do +/// not give users any privileges on .transform-internal* indices. If you used transforms prior to 7.5, also do not +/// give users any privileges on .data-frame-internal* indices. +/// /// public sealed partial class PutTransformRequestDescriptor : RequestDescriptor, PutTransformRequestParameters> { @@ -194,7 +280,9 @@ public PutTransformRequestDescriptor TransformId(Elastic.Clients.Elas private Action> SyncDescriptorAction { get; set; } /// - /// Free text description of the transform. + /// + /// Free text description of the transform. + /// /// public PutTransformRequestDescriptor Description(string? description) { @@ -203,7 +291,9 @@ public PutTransformRequestDescriptor Description(string? description) } /// - /// The destination for the transform. + /// + /// The destination for the transform. + /// /// public PutTransformRequestDescriptor Dest(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Destination dest) { @@ -230,7 +320,11 @@ public PutTransformRequestDescriptor Dest(Action - /// The interval between checks for changes in the source indices when the transform is running continuously. Also
determines the retry interval in the event of transient failures while the transform is searching or indexing.
The minimum value is `1s` and the maximum is `1h`. + /// + /// The interval between checks for changes in the source indices when the transform is running continuously. Also + /// determines the retry interval in the event of transient failures while the transform is searching or indexing. + /// The minimum value is 1s and the maximum is 1h. + /// /// public PutTransformRequestDescriptor Frequency(Elastic.Clients.Elasticsearch.Serverless.Duration? frequency) { @@ -239,7 +333,9 @@ public PutTransformRequestDescriptor Frequency(Elastic.Clients.Elasti } /// - /// The latest method transforms the data by finding the latest document for each unique key. + /// + /// The latest method transforms the data by finding the latest document for each unique key. + /// /// public PutTransformRequestDescriptor Latest(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Latest? latest) { @@ -266,7 +362,9 @@ public PutTransformRequestDescriptor Latest(Action - /// Defines optional transform metadata. + /// + /// Defines optional transform metadata. + /// /// public PutTransformRequestDescriptor Meta(Func, FluentDictionary> selector) { @@ -275,7 +373,10 @@ public PutTransformRequestDescriptor Meta(Func - /// The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields
and the aggregation to reduce the data. + /// + /// The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields + /// and the aggregation to reduce the data. + /// /// public PutTransformRequestDescriptor Pivot(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Pivot? pivot) { @@ -302,7 +403,10 @@ public PutTransformRequestDescriptor Pivot(Action - /// Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the
destination index. + /// + /// Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the + /// destination index. + /// /// public PutTransformRequestDescriptor RetentionPolicy(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.RetentionPolicy? retentionPolicy) { @@ -329,7 +433,9 @@ public PutTransformRequestDescriptor RetentionPolicy(Action - /// Defines optional transform settings. + /// + /// Defines optional transform settings. + /// /// public PutTransformRequestDescriptor Settings(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Settings? settings) { @@ -356,7 +462,9 @@ public PutTransformRequestDescriptor Settings(Action - /// The source of the data for the transform. + /// + /// The source of the data for the transform. + /// /// public PutTransformRequestDescriptor Source(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Source source) { @@ -383,7 +491,9 @@ public PutTransformRequestDescriptor Source(Action - /// Defines the properties transforms require to run continuously. + /// + /// Defines the properties transforms require to run continuously. + /// /// public PutTransformRequestDescriptor Sync(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Sync? sync) { @@ -547,11 +657,34 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Create a transform.
Creates a transform. -/// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as
a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
unique row per entity. -/// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If
you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in
the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values
in the latest object. -/// You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and
`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the
transform remembers which roles the user that created it had at the time of creation and uses those same roles. If
those roles do not have the required privileges on the source and destination indices, the transform fails when it
attempts unauthorized operations. -/// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any
`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not
give users any privileges on `.data-frame-internal*` indices. +/// +/// Create a transform. +/// Creates a transform. +/// +/// +/// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as +/// a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a +/// unique row per entity. +/// +/// +/// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If +/// you choose to use the pivot method for your transform, the entities are defined by the set of group_by fields in +/// the pivot object. If you choose to use the latest method, the entities are defined by the unique_key field values +/// in the latest object. +/// +/// +/// You must have create_index, index, and read privileges on the destination index and read and +/// view_index_metadata privileges on the source indices. When Elasticsearch security features are enabled, the +/// transform remembers which roles the user that created it had at the time of creation and uses those same roles. If +/// those roles do not have the required privileges on the source and destination indices, the transform fails when it +/// attempts unauthorized operations. +/// +/// +/// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any +/// .transform-internal* indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do +/// not give users any privileges on .transform-internal* indices. If you used transforms prior to 7.5, also do not +/// give users any privileges on .data-frame-internal* indices. +/// /// public sealed partial class PutTransformRequestDescriptor : RequestDescriptor { @@ -604,7 +737,9 @@ public PutTransformRequestDescriptor TransformId(Elastic.Clients.Elasticsearch.S private Action SyncDescriptorAction { get; set; } /// - /// Free text description of the transform. + /// + /// Free text description of the transform. + /// /// public PutTransformRequestDescriptor Description(string? description) { @@ -613,7 +748,9 @@ public PutTransformRequestDescriptor Description(string? description) } /// - /// The destination for the transform. + /// + /// The destination for the transform. + /// /// public PutTransformRequestDescriptor Dest(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Destination dest) { @@ -640,7 +777,11 @@ public PutTransformRequestDescriptor Dest(Action - /// The interval between checks for changes in the source indices when the transform is running continuously. Also
determines the retry interval in the event of transient failures while the transform is searching or indexing.
The minimum value is `1s` and the maximum is `1h`. + /// + /// The interval between checks for changes in the source indices when the transform is running continuously. Also + /// determines the retry interval in the event of transient failures while the transform is searching or indexing. + /// The minimum value is 1s and the maximum is 1h. + /// /// public PutTransformRequestDescriptor Frequency(Elastic.Clients.Elasticsearch.Serverless.Duration? frequency) { @@ -649,7 +790,9 @@ public PutTransformRequestDescriptor Frequency(Elastic.Clients.Elasticsearch.Ser } /// - /// The latest method transforms the data by finding the latest document for each unique key. + /// + /// The latest method transforms the data by finding the latest document for each unique key. + /// /// public PutTransformRequestDescriptor Latest(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Latest? latest) { @@ -676,7 +819,9 @@ public PutTransformRequestDescriptor Latest(Action - /// Defines optional transform metadata. + /// + /// Defines optional transform metadata. + /// /// public PutTransformRequestDescriptor Meta(Func, FluentDictionary> selector) { @@ -685,7 +830,10 @@ public PutTransformRequestDescriptor Meta(Func, } /// - /// The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields
and the aggregation to reduce the data. + /// + /// The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields + /// and the aggregation to reduce the data. + /// /// public PutTransformRequestDescriptor Pivot(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Pivot? pivot) { @@ -712,7 +860,10 @@ public PutTransformRequestDescriptor Pivot(Action - /// Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the
destination index. + /// + /// Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the + /// destination index. + /// /// public PutTransformRequestDescriptor RetentionPolicy(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.RetentionPolicy? retentionPolicy) { @@ -739,7 +890,9 @@ public PutTransformRequestDescriptor RetentionPolicy(Action - /// Defines optional transform settings. + /// + /// Defines optional transform settings. + /// /// public PutTransformRequestDescriptor Settings(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Settings? settings) { @@ -766,7 +919,9 @@ public PutTransformRequestDescriptor Settings(Action - /// The source of the data for the transform. + /// + /// The source of the data for the transform. + /// /// public PutTransformRequestDescriptor Source(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Source source) { @@ -793,7 +948,9 @@ public PutTransformRequestDescriptor Source(Action - /// Defines the properties transforms require to run continuously. + /// + /// Defines the properties transforms require to run continuously. + /// /// public PutTransformRequestDescriptor Sync(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Sync? sync) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/PutTransformResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/PutTransformResponse.g.cs index b249e53d43a..37567c05c87 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/PutTransformResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/PutTransformResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.TransformManagement; public sealed partial class PutTransformResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/ResetTransformRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/ResetTransformRequest.g.cs index 9d61f79ccfb..3f5b65e9748 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/ResetTransformRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/ResetTransformRequest.g.cs @@ -32,13 +32,21 @@ namespace Elastic.Clients.Elasticsearch.Serverless.TransformManagement; public sealed partial class ResetTransformRequestParameters : RequestParameters { /// - /// If this value is `true`, the transform is reset regardless of its current state. If it's `false`, the transform
must be stopped before it can be reset. + /// + /// If this value is true, the transform is reset regardless of its current state. If it's false, the transform + /// must be stopped before it can be reset. + /// /// public bool? Force { get => Q("force"); set => Q("force", value); } } /// -/// Reset a transform.
Resets a transform.
Before you can reset it, you must stop it; alternatively, use the `force` query parameter.
If the destination index was created by the transform, it is deleted. +/// +/// Reset a transform. +/// Resets a transform. +/// Before you can reset it, you must stop it; alternatively, use the force query parameter. +/// If the destination index was created by the transform, it is deleted. +/// /// public sealed partial class ResetTransformRequest : PlainRequest { @@ -55,14 +63,22 @@ public ResetTransformRequest(Elastic.Clients.Elasticsearch.Serverless.Id transfo internal override string OperationName => "transform.reset_transform"; /// - /// If this value is `true`, the transform is reset regardless of its current state. If it's `false`, the transform
must be stopped before it can be reset. + /// + /// If this value is true, the transform is reset regardless of its current state. If it's false, the transform + /// must be stopped before it can be reset. + /// /// [JsonIgnore] public bool? Force { get => Q("force"); set => Q("force", value); } } /// -/// Reset a transform.
Resets a transform.
Before you can reset it, you must stop it; alternatively, use the `force` query parameter.
If the destination index was created by the transform, it is deleted. +/// +/// Reset a transform. +/// Resets a transform. +/// Before you can reset it, you must stop it; alternatively, use the force query parameter. +/// If the destination index was created by the transform, it is deleted. +/// /// public sealed partial class ResetTransformRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/ResetTransformResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/ResetTransformResponse.g.cs index fb4ed2eb3ec..d97e012a67e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/ResetTransformResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/ResetTransformResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.TransformManagement; public sealed partial class ResetTransformResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/ScheduleNowTransformRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/ScheduleNowTransformRequest.g.cs index f42efbafa3e..f36b141fe68 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/ScheduleNowTransformRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/ScheduleNowTransformRequest.g.cs @@ -32,14 +32,24 @@ namespace Elastic.Clients.Elasticsearch.Serverless.TransformManagement; public sealed partial class ScheduleNowTransformRequestParameters : RequestParameters { /// - /// Controls the time to wait for the scheduling to take place + /// + /// Controls the time to wait for the scheduling to take place + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Schedule a transform to start now.
Instantly runs a transform to process data. -/// If you _schedule_now a transform, it will process the new data instantly,
without waiting for the configured frequency interval. After _schedule_now API is called,
the transform will be processed again at now + frequency unless _schedule_now API
is called again in the meantime. +/// +/// Schedule a transform to start now. +/// Instantly runs a transform to process data. +/// +/// +/// If you _schedule_now a transform, it will process the new data instantly, +/// without waiting for the configured frequency interval. After _schedule_now API is called, +/// the transform will be processed again at now + frequency unless _schedule_now API +/// is called again in the meantime. +/// /// public sealed partial class ScheduleNowTransformRequest : PlainRequest { @@ -56,15 +66,25 @@ public ScheduleNowTransformRequest(Elastic.Clients.Elasticsearch.Serverless.Id t internal override string OperationName => "transform.schedule_now_transform"; /// - /// Controls the time to wait for the scheduling to take place + /// + /// Controls the time to wait for the scheduling to take place + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Schedule a transform to start now.
Instantly runs a transform to process data. -/// If you _schedule_now a transform, it will process the new data instantly,
without waiting for the configured frequency interval. After _schedule_now API is called,
the transform will be processed again at now + frequency unless _schedule_now API
is called again in the meantime. +/// +/// Schedule a transform to start now. +/// Instantly runs a transform to process data. +/// +/// +/// If you _schedule_now a transform, it will process the new data instantly, +/// without waiting for the configured frequency interval. After _schedule_now API is called, +/// the transform will be processed again at now + frequency unless _schedule_now API +/// is called again in the meantime. +/// /// public sealed partial class ScheduleNowTransformRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/ScheduleNowTransformResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/ScheduleNowTransformResponse.g.cs index 53bcf08486b..c9a9273b214 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/ScheduleNowTransformResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/ScheduleNowTransformResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.TransformManagement; public sealed partial class ScheduleNowTransformResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/StartTransformRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/StartTransformRequest.g.cs index 32084a6bd6d..a8ce40e696f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/StartTransformRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/StartTransformRequest.g.cs @@ -32,20 +32,42 @@ namespace Elastic.Clients.Elasticsearch.Serverless.TransformManagement; public sealed partial class StartTransformRequestParameters : RequestParameters { /// - /// Restricts the set of transformed entities to those changed after this time. Relative times like now-30d are supported. Only applicable for continuous transforms. + /// + /// Restricts the set of transformed entities to those changed after this time. Relative times like now-30d are supported. Only applicable for continuous transforms. + /// /// public string? From { get => Q("from"); set => Q("from", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Start a transform.
Starts a transform. -/// When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is
set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping
definitions for the destination index from the source indices and the transform aggregations. If fields in the
destination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),
the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce
mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you
start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings
in a pivot transform. -/// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you
created the transform, they occur when you start the transform—​with the exception of privilege checks. When
Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the
time of creation and uses those same roles. If those roles do not have the required privileges on the source and
destination indices, the transform fails when it attempts unauthorized operations. +/// +/// Start a transform. +/// Starts a transform. +/// +/// +/// When you start a transform, it creates the destination index if it does not already exist. The number_of_shards is +/// set to 1 and the auto_expand_replicas is set to 0-1. If it is a pivot transform, it deduces the mapping +/// definitions for the destination index from the source indices and the transform aggregations. If fields in the +/// destination index are derived from scripts (as in the case of scripted_metric or bucket_script aggregations), +/// the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce +/// mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you +/// start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings +/// in a pivot transform. +/// +/// +/// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you +/// created the transform, they occur when you start the transform—​with the exception of privilege checks. When +/// Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the +/// time of creation and uses those same roles. If those roles do not have the required privileges on the source and +/// destination indices, the transform fails when it attempts unauthorized operations. +/// /// public sealed partial class StartTransformRequest : PlainRequest { @@ -62,22 +84,44 @@ public StartTransformRequest(Elastic.Clients.Elasticsearch.Serverless.Id transfo internal override string OperationName => "transform.start_transform"; /// - /// Restricts the set of transformed entities to those changed after this time. Relative times like now-30d are supported. Only applicable for continuous transforms. + /// + /// Restricts the set of transformed entities to those changed after this time. Relative times like now-30d are supported. Only applicable for continuous transforms. + /// /// [JsonIgnore] public string? From { get => Q("from"); set => Q("from", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Start a transform.
Starts a transform. -/// When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is
set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping
definitions for the destination index from the source indices and the transform aggregations. If fields in the
destination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),
the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce
mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you
start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings
in a pivot transform. -/// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you
created the transform, they occur when you start the transform—​with the exception of privilege checks. When
Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the
time of creation and uses those same roles. If those roles do not have the required privileges on the source and
destination indices, the transform fails when it attempts unauthorized operations. +/// +/// Start a transform. +/// Starts a transform. +/// +/// +/// When you start a transform, it creates the destination index if it does not already exist. The number_of_shards is +/// set to 1 and the auto_expand_replicas is set to 0-1. If it is a pivot transform, it deduces the mapping +/// definitions for the destination index from the source indices and the transform aggregations. If fields in the +/// destination index are derived from scripts (as in the case of scripted_metric or bucket_script aggregations), +/// the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce +/// mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you +/// start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings +/// in a pivot transform. +/// +/// +/// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you +/// created the transform, they occur when you start the transform—​with the exception of privilege checks. When +/// Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the +/// time of creation and uses those same roles. If those roles do not have the required privileges on the source and +/// destination indices, the transform fails when it attempts unauthorized operations. +/// /// public sealed partial class StartTransformRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/StartTransformResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/StartTransformResponse.g.cs index 61a4125aaa4..595a38b4095 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/StartTransformResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/StartTransformResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.TransformManagement; public sealed partial class StartTransformResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/StopTransformRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/StopTransformRequest.g.cs index 119630269bf..b377e5f02e9 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/StopTransformRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/StopTransformRequest.g.cs @@ -32,35 +32,59 @@ namespace Elastic.Clients.Elasticsearch.Serverless.TransformManagement; public sealed partial class StopTransformRequestParameters : RequestParameters { /// - /// Specifies what to do when the request: contains wildcard expressions and there are no transforms that match;
contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there
are only partial matches. - /// If it is true, the API returns a successful acknowledgement message when there are no matches. When there are
only partial matches, the API stops the appropriate transforms. - /// If it is false, the request returns a 404 status code when there are no matches or only partial matches. + /// + /// Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; + /// contains the _all string or no identifiers and there are no matches; contains wildcard expressions and there + /// are only partial matches. + /// + /// + /// If it is true, the API returns a successful acknowledgement message when there are no matches. When there are + /// only partial matches, the API stops the appropriate transforms. + /// + /// + /// If it is false, the request returns a 404 status code when there are no matches or only partial matches. + /// /// public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// If it is true, the API forcefully stops the transforms. + /// + /// If it is true, the API forcefully stops the transforms. + /// /// public bool? Force { get => Q("force"); set => Q("force", value); } /// - /// Period to wait for a response when `wait_for_completion` is `true`. If no response is received before the
timeout expires, the request returns a timeout exception. However, the request continues processing and
eventually moves the transform to a STOPPED state. + /// + /// Period to wait for a response when wait_for_completion is true. If no response is received before the + /// timeout expires, the request returns a timeout exception. However, the request continues processing and + /// eventually moves the transform to a STOPPED state. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// If it is true, the transform does not completely stop until the current checkpoint is completed. If it is false,
the transform stops as soon as possible. + /// + /// If it is true, the transform does not completely stop until the current checkpoint is completed. If it is false, + /// the transform stops as soon as possible. + /// /// public bool? WaitForCheckpoint { get => Q("wait_for_checkpoint"); set => Q("wait_for_checkpoint", value); } /// - /// If it is true, the API blocks until the indexer state completely stops. If it is false, the API returns
immediately and the indexer is stopped asynchronously in the background. + /// + /// If it is true, the API blocks until the indexer state completely stops. If it is false, the API returns + /// immediately and the indexer is stopped asynchronously in the background. + /// /// public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Stop transforms.
Stops one or more transforms. +/// +/// Stop transforms. +/// Stops one or more transforms. +/// /// public sealed partial class StopTransformRequest : PlainRequest { @@ -77,40 +101,64 @@ public StopTransformRequest(Elastic.Clients.Elasticsearch.Serverless.Name transf internal override string OperationName => "transform.stop_transform"; /// - /// Specifies what to do when the request: contains wildcard expressions and there are no transforms that match;
contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there
are only partial matches. - /// If it is true, the API returns a successful acknowledgement message when there are no matches. When there are
only partial matches, the API stops the appropriate transforms. - /// If it is false, the request returns a 404 status code when there are no matches or only partial matches. + /// + /// Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; + /// contains the _all string or no identifiers and there are no matches; contains wildcard expressions and there + /// are only partial matches. + /// + /// + /// If it is true, the API returns a successful acknowledgement message when there are no matches. When there are + /// only partial matches, the API stops the appropriate transforms. + /// + /// + /// If it is false, the request returns a 404 status code when there are no matches or only partial matches. + /// /// [JsonIgnore] public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// If it is true, the API forcefully stops the transforms. + /// + /// If it is true, the API forcefully stops the transforms. + /// /// [JsonIgnore] public bool? Force { get => Q("force"); set => Q("force", value); } /// - /// Period to wait for a response when `wait_for_completion` is `true`. If no response is received before the
timeout expires, the request returns a timeout exception. However, the request continues processing and
eventually moves the transform to a STOPPED state. + /// + /// Period to wait for a response when wait_for_completion is true. If no response is received before the + /// timeout expires, the request returns a timeout exception. However, the request continues processing and + /// eventually moves the transform to a STOPPED state. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// If it is true, the transform does not completely stop until the current checkpoint is completed. If it is false,
the transform stops as soon as possible. + /// + /// If it is true, the transform does not completely stop until the current checkpoint is completed. If it is false, + /// the transform stops as soon as possible. + /// /// [JsonIgnore] public bool? WaitForCheckpoint { get => Q("wait_for_checkpoint"); set => Q("wait_for_checkpoint", value); } /// - /// If it is true, the API blocks until the indexer state completely stops. If it is false, the API returns
immediately and the indexer is stopped asynchronously in the background. + /// + /// If it is true, the API blocks until the indexer state completely stops. If it is false, the API returns + /// immediately and the indexer is stopped asynchronously in the background. + /// /// [JsonIgnore] public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Stop transforms.
Stops one or more transforms. +/// +/// Stop transforms. +/// Stops one or more transforms. +/// /// public sealed partial class StopTransformRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/StopTransformResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/StopTransformResponse.g.cs index 815fb2c711c..985c2bcd51a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/StopTransformResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/StopTransformResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.TransformManagement; public sealed partial class StopTransformResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/UpdateTransformRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/UpdateTransformRequest.g.cs index 3aaf0e28bc1..7e32990df7b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/UpdateTransformRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/UpdateTransformRequest.g.cs @@ -32,19 +32,35 @@ namespace Elastic.Clients.Elasticsearch.Serverless.TransformManagement; public sealed partial class UpdateTransformRequestParameters : RequestParameters { /// - /// When true, deferrable validations are not run. This behavior may be
desired if the source index does not exist until after the transform is
created. + /// + /// When true, deferrable validations are not run. This behavior may be + /// desired if the source index does not exist until after the transform is + /// created. + /// /// public bool? DeferValidation { get => Q("defer_validation"); set => Q("defer_validation", value); } /// - /// Period to wait for a response. If no response is received before the
timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the + /// timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Update a transform.
Updates certain properties of a transform. -/// All updated properties except `description` do not take effect until after the transform starts the next checkpoint,
thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`
privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When
Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the
time of update and runs with those privileges. +/// +/// Update a transform. +/// Updates certain properties of a transform. +/// +/// +/// All updated properties except description do not take effect until after the transform starts the next checkpoint, +/// thus there is data consistency in each checkpoint. To use this API, you must have read and view_index_metadata +/// privileges for the source indices. You must also have index and read privileges for the destination index. When +/// Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the +/// time of update and runs with those privileges. +/// /// public sealed partial class UpdateTransformRequest : PlainRequest { @@ -61,69 +77,105 @@ public UpdateTransformRequest(Elastic.Clients.Elasticsearch.Serverless.Id transf internal override string OperationName => "transform.update_transform"; /// - /// When true, deferrable validations are not run. This behavior may be
desired if the source index does not exist until after the transform is
created. + /// + /// When true, deferrable validations are not run. This behavior may be + /// desired if the source index does not exist until after the transform is + /// created. + /// /// [JsonIgnore] public bool? DeferValidation { get => Q("defer_validation"); set => Q("defer_validation", value); } /// - /// Period to wait for a response. If no response is received before the
timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the + /// timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Free text description of the transform. + /// + /// Free text description of the transform. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The destination for the transform. + /// + /// The destination for the transform. + /// /// [JsonInclude, JsonPropertyName("dest")] public Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Destination? Dest { get; set; } /// - /// The interval between checks for changes in the source indices when the
transform is running continuously. Also determines the retry interval in
the event of transient failures while the transform is searching or
indexing. The minimum value is 1s and the maximum is 1h. + /// + /// The interval between checks for changes in the source indices when the + /// transform is running continuously. Also determines the retry interval in + /// the event of transient failures while the transform is searching or + /// indexing. The minimum value is 1s and the maximum is 1h. + /// /// [JsonInclude, JsonPropertyName("frequency")] public Elastic.Clients.Elasticsearch.Serverless.Duration? Frequency { get; set; } /// - /// Defines optional transform metadata. + /// + /// Defines optional transform metadata. + /// /// [JsonInclude, JsonPropertyName("_meta")] public IDictionary? Meta { get; set; } /// - /// Defines a retention policy for the transform. Data that meets the defined
criteria is deleted from the destination index. + /// + /// Defines a retention policy for the transform. Data that meets the defined + /// criteria is deleted from the destination index. + /// /// [JsonInclude, JsonPropertyName("retention_policy")] public Elastic.Clients.Elasticsearch.Serverless.TransformManagement.RetentionPolicy? RetentionPolicy { get; set; } /// - /// Defines optional transform settings. + /// + /// Defines optional transform settings. + /// /// [JsonInclude, JsonPropertyName("settings")] public Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Settings? Settings { get; set; } /// - /// The source of the data for the transform. + /// + /// The source of the data for the transform. + /// /// [JsonInclude, JsonPropertyName("source")] public Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Source? Source { get; set; } /// - /// Defines the properties transforms require to run continuously. + /// + /// Defines the properties transforms require to run continuously. + /// /// [JsonInclude, JsonPropertyName("sync")] public Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Sync? Sync { get; set; } } /// -/// Update a transform.
Updates certain properties of a transform. -/// All updated properties except `description` do not take effect until after the transform starts the next checkpoint,
thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`
privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When
Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the
time of update and runs with those privileges. +/// +/// Update a transform. +/// Updates certain properties of a transform. +/// +/// +/// All updated properties except description do not take effect until after the transform starts the next checkpoint, +/// thus there is data consistency in each checkpoint. To use this API, you must have read and view_index_metadata +/// privileges for the source indices. You must also have index and read privileges for the destination index. When +/// Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the +/// time of update and runs with those privileges. +/// /// public sealed partial class UpdateTransformRequestDescriptor : RequestDescriptor, UpdateTransformRequestParameters> { @@ -170,7 +222,9 @@ public UpdateTransformRequestDescriptor TransformId(Elastic.Clients.E private Action> SyncDescriptorAction { get; set; } /// - /// Free text description of the transform. + /// + /// Free text description of the transform. + /// /// public UpdateTransformRequestDescriptor Description(string? description) { @@ -179,7 +233,9 @@ public UpdateTransformRequestDescriptor Description(string? descripti } /// - /// The destination for the transform. + /// + /// The destination for the transform. + /// /// public UpdateTransformRequestDescriptor Dest(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Destination? dest) { @@ -206,7 +262,12 @@ public UpdateTransformRequestDescriptor Dest(Action - /// The interval between checks for changes in the source indices when the
transform is running continuously. Also determines the retry interval in
the event of transient failures while the transform is searching or
indexing. The minimum value is 1s and the maximum is 1h. + /// + /// The interval between checks for changes in the source indices when the + /// transform is running continuously. Also determines the retry interval in + /// the event of transient failures while the transform is searching or + /// indexing. The minimum value is 1s and the maximum is 1h. + /// /// public UpdateTransformRequestDescriptor Frequency(Elastic.Clients.Elasticsearch.Serverless.Duration? frequency) { @@ -215,7 +276,9 @@ public UpdateTransformRequestDescriptor Frequency(Elastic.Clients.Ela } /// - /// Defines optional transform metadata. + /// + /// Defines optional transform metadata. + /// /// public UpdateTransformRequestDescriptor Meta(Func, FluentDictionary> selector) { @@ -224,7 +287,10 @@ public UpdateTransformRequestDescriptor Meta(Func - /// Defines a retention policy for the transform. Data that meets the defined
criteria is deleted from the destination index. + /// + /// Defines a retention policy for the transform. Data that meets the defined + /// criteria is deleted from the destination index. + /// /// public UpdateTransformRequestDescriptor RetentionPolicy(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.RetentionPolicy? retentionPolicy) { @@ -251,7 +317,9 @@ public UpdateTransformRequestDescriptor RetentionPolicy(Action - /// Defines optional transform settings. + /// + /// Defines optional transform settings. + /// /// public UpdateTransformRequestDescriptor Settings(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Settings? settings) { @@ -278,7 +346,9 @@ public UpdateTransformRequestDescriptor Settings(Action - /// The source of the data for the transform. + /// + /// The source of the data for the transform. + /// /// public UpdateTransformRequestDescriptor Source(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Source? source) { @@ -305,7 +375,9 @@ public UpdateTransformRequestDescriptor Source(Action - /// Defines the properties transforms require to run continuously. + /// + /// Defines the properties transforms require to run continuously. + /// /// public UpdateTransformRequestDescriptor Sync(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Sync? sync) { @@ -437,8 +509,17 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Update a transform.
Updates certain properties of a transform. -/// All updated properties except `description` do not take effect until after the transform starts the next checkpoint,
thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`
privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When
Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the
time of update and runs with those privileges. +/// +/// Update a transform. +/// Updates certain properties of a transform. +/// +/// +/// All updated properties except description do not take effect until after the transform starts the next checkpoint, +/// thus there is data consistency in each checkpoint. To use this API, you must have read and view_index_metadata +/// privileges for the source indices. You must also have index and read privileges for the destination index. When +/// Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the +/// time of update and runs with those privileges. +/// /// public sealed partial class UpdateTransformRequestDescriptor : RequestDescriptor { @@ -485,7 +566,9 @@ public UpdateTransformRequestDescriptor TransformId(Elastic.Clients.Elasticsearc private Action SyncDescriptorAction { get; set; } /// - /// Free text description of the transform. + /// + /// Free text description of the transform. + /// /// public UpdateTransformRequestDescriptor Description(string? description) { @@ -494,7 +577,9 @@ public UpdateTransformRequestDescriptor Description(string? description) } /// - /// The destination for the transform. + /// + /// The destination for the transform. + /// /// public UpdateTransformRequestDescriptor Dest(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Destination? dest) { @@ -521,7 +606,12 @@ public UpdateTransformRequestDescriptor Dest(Action - /// The interval between checks for changes in the source indices when the
transform is running continuously. Also determines the retry interval in
the event of transient failures while the transform is searching or
indexing. The minimum value is 1s and the maximum is 1h. + /// + /// The interval between checks for changes in the source indices when the + /// transform is running continuously. Also determines the retry interval in + /// the event of transient failures while the transform is searching or + /// indexing. The minimum value is 1s and the maximum is 1h. + /// /// public UpdateTransformRequestDescriptor Frequency(Elastic.Clients.Elasticsearch.Serverless.Duration? frequency) { @@ -530,7 +620,9 @@ public UpdateTransformRequestDescriptor Frequency(Elastic.Clients.Elasticsearch. } /// - /// Defines optional transform metadata. + /// + /// Defines optional transform metadata. + /// /// public UpdateTransformRequestDescriptor Meta(Func, FluentDictionary> selector) { @@ -539,7 +631,10 @@ public UpdateTransformRequestDescriptor Meta(Func - /// Defines a retention policy for the transform. Data that meets the defined
criteria is deleted from the destination index. + /// + /// Defines a retention policy for the transform. Data that meets the defined + /// criteria is deleted from the destination index. + /// /// public UpdateTransformRequestDescriptor RetentionPolicy(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.RetentionPolicy? retentionPolicy) { @@ -566,7 +661,9 @@ public UpdateTransformRequestDescriptor RetentionPolicy(Action - /// Defines optional transform settings. + /// + /// Defines optional transform settings. + /// /// public UpdateTransformRequestDescriptor Settings(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Settings? settings) { @@ -593,7 +690,9 @@ public UpdateTransformRequestDescriptor Settings(Action - /// The source of the data for the transform. + /// + /// The source of the data for the transform. + /// /// public UpdateTransformRequestDescriptor Source(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Source? source) { @@ -620,7 +719,9 @@ public UpdateTransformRequestDescriptor Source(Action - /// Defines the properties transforms require to run continuously. + /// + /// Defines the properties transforms require to run continuously. + /// /// public UpdateTransformRequestDescriptor Sync(Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Sync? sync) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/UpgradeTransformsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/UpgradeTransformsRequest.g.cs index 08eae0c5f66..3d6ca63425b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/UpgradeTransformsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/UpgradeTransformsRequest.g.cs @@ -32,18 +32,30 @@ namespace Elastic.Clients.Elasticsearch.Serverless.TransformManagement; public sealed partial class UpgradeTransformsRequestParameters : RequestParameters { /// - /// When true, the request checks for updates but does not run them. + /// + /// When true, the request checks for updates but does not run them. + /// /// public bool? DryRun { get => Q("dry_run"); set => Q("dry_run", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and
returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and + /// returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Upgrades all transforms.
This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It
also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not
affect the source and destination indices. The upgrade also does not affect the roles that transforms use when
Elasticsearch security features are enabled; the role used to read source data and write to the destination index
remains unchanged. +/// +/// Upgrades all transforms. +/// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It +/// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not +/// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when +/// Elasticsearch security features are enabled; the role used to read source data and write to the destination index +/// remains unchanged. +/// /// public sealed partial class UpgradeTransformsRequest : PlainRequest { @@ -56,20 +68,32 @@ public sealed partial class UpgradeTransformsRequest : PlainRequest "transform.upgrade_transforms"; /// - /// When true, the request checks for updates but does not run them. + /// + /// When true, the request checks for updates but does not run them. + /// /// [JsonIgnore] public bool? DryRun { get => Q("dry_run"); set => Q("dry_run", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and
returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and + /// returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Upgrades all transforms.
This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It
also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not
affect the source and destination indices. The upgrade also does not affect the roles that transforms use when
Elasticsearch security features are enabled; the role used to read source data and write to the destination index
remains unchanged. +/// +/// Upgrades all transforms. +/// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It +/// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not +/// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when +/// Elasticsearch security features are enabled; the role used to read source data and write to the destination index +/// remains unchanged. +/// /// public sealed partial class UpgradeTransformsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/UpgradeTransformsResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/UpgradeTransformsResponse.g.cs index c60f735bdac..0d286e7ad75 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/UpgradeTransformsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/UpgradeTransformsResponse.g.cs @@ -29,19 +29,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.TransformManagement; public sealed partial class UpgradeTransformsResponse : ElasticsearchResponse { /// - /// The number of transforms that need to be upgraded. + /// + /// The number of transforms that need to be upgraded. + /// /// [JsonInclude, JsonPropertyName("needs_update")] public int NeedsUpdate { get; init; } /// - /// The number of transforms that don’t require upgrading. + /// + /// The number of transforms that don’t require upgrading. + /// /// [JsonInclude, JsonPropertyName("no_action")] public int NoAction { get; init; } /// - /// The number of transforms that have been upgraded. + /// + /// The number of transforms that have been upgraded. + /// /// [JsonInclude, JsonPropertyName("updated")] public int Updated { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/UpdateByQueryRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/UpdateByQueryRequest.g.cs index 5f2ccb1796f..4922a189bde 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/UpdateByQueryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/UpdateByQueryRequest.g.cs @@ -32,148 +32,223 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class UpdateByQueryRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices.
For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Analyzer to use for the query string. + /// + /// Analyzer to use for the query string. + /// /// public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// - /// If `true`, wildcard and prefix queries are analyzed. + /// + /// If true, wildcard and prefix queries are analyzed. + /// /// public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } /// - /// The default operator for query string query: `AND` or `OR`. + /// + /// The default operator for query string query: AND or OR. + /// /// public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } /// - /// Field to use as default where no field prefix is given in the query string. + /// + /// Field to use as default where no field prefix is given in the query string. + /// /// public string? Df { get => Q("df"); set => Q("df", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Starting offset (default: 0) + /// + /// Starting offset (default: 0) + /// /// public long? From { get => Q("from"); set => Q("from", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// + /// If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// /// public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// - /// ID of the pipeline to use to preprocess incoming documents.
If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.
If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// + /// ID of the pipeline to use to preprocess incoming documents. + /// If the index has a default ingest pipeline specified, then setting the value to _none disables the default ingest pipeline for this request. + /// If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// /// public string? Pipeline { get => Q("pipeline"); set => Q("pipeline", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If `true`, Elasticsearch refreshes affected shards to make the operation visible to search. + /// + /// If true, Elasticsearch refreshes affected shards to make the operation visible to search. + /// /// public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// If `true`, the request cache is used for this request. + /// + /// If true, the request cache is used for this request. + /// /// public bool? RequestCache { get => Q("request_cache"); set => Q("request_cache", value); } /// - /// The throttle for this request in sub-requests per second. + /// + /// The throttle for this request in sub-requests per second. + /// /// public float? RequestsPerSecond { get => Q("requests_per_second"); set => Q("requests_per_second", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Period to retain the search context for scrolling. + /// + /// Period to retain the search context for scrolling. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); } /// - /// Size of the scroll request that powers the operation. + /// + /// Size of the scroll request that powers the operation. + /// /// public long? ScrollSize { get => Q("scroll_size"); set => Q("scroll_size", value); } /// - /// Explicit timeout for each search request. + /// + /// Explicit timeout for each search request. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? SearchTimeout { get => Q("search_timeout"); set => Q("search_timeout", value); } /// - /// The type of the search operation. Available options: `query_then_fetch`, `dfs_query_then_fetch`. + /// + /// The type of the search operation. Available options: query_then_fetch, dfs_query_then_fetch. + /// /// public Elastic.Clients.Elasticsearch.Serverless.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } /// - /// The number of slices this task should be divided into. + /// + /// The number of slices this task should be divided into. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Slices? Slices { get => Q("slices"); set => Q("slices", value); } /// - /// A comma-separated list of : pairs. + /// + /// A comma-separated list of <field>:<direction> pairs. + /// /// public ICollection? Sort { get => Q?>("sort"); set => Q("sort", value); } /// - /// Specific `tag` of the request for logging and statistical purposes. + /// + /// Specific tag of the request for logging and statistical purposes. + /// /// public ICollection? Stats { get => Q?>("stats"); set => Q("stats", value); } /// - /// Maximum number of documents to collect for each shard.
If a query reaches this limit, Elasticsearch terminates the query early.
Elasticsearch collects documents before sorting.
Use with caution.
Elasticsearch applies this parameter to each shard handling the request.
When possible, let Elasticsearch perform early termination automatically.
Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + /// + /// Maximum number of documents to collect for each shard. + /// If a query reaches this limit, Elasticsearch terminates the query early. + /// Elasticsearch collects documents before sorting. + /// Use with caution. + /// Elasticsearch applies this parameter to each shard handling the request. + /// When possible, let Elasticsearch perform early termination automatically. + /// Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + /// /// public long? TerminateAfter { get => Q("terminate_after"); set => Q("terminate_after", value); } /// - /// Period each update request waits for the following operations: dynamic mapping updates, waiting for active shards. + /// + /// Period each update request waits for the following operations: dynamic mapping updates, waiting for active shards. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// If `true`, returns the document version as part of a hit. + /// + /// If true, returns the document version as part of a hit. + /// /// public bool? Version { get => Q("version"); set => Q("version", value); } /// - /// Should the document increment the version number (internal) on hit or not (reindex) + /// + /// Should the document increment the version number (internal) on hit or not (reindex) + /// /// public bool? VersionType { get => Q("version_type"); set => Q("version_type", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// public Elastic.Clients.Elasticsearch.Serverless.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } /// - /// If `true`, the request blocks until the operation is complete. + /// + /// If true, the request blocks until the operation is complete. + /// /// public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// 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. +/// /// public sealed partial class UpdateByQueryRequest : PlainRequest { @@ -190,206 +265,291 @@ public UpdateByQueryRequest(Elastic.Clients.Elasticsearch.Serverless.Indices ind internal override string OperationName => "update_by_query"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices.
For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Analyzer to use for the query string. + /// + /// Analyzer to use for the query string. + /// /// [JsonIgnore] public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// - /// If `true`, wildcard and prefix queries are analyzed. + /// + /// If true, wildcard and prefix queries are analyzed. + /// /// [JsonIgnore] public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } /// - /// The default operator for query string query: `AND` or `OR`. + /// + /// The default operator for query string query: AND or OR. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } /// - /// Field to use as default where no field prefix is given in the query string. + /// + /// Field to use as default where no field prefix is given in the query string. + /// /// [JsonIgnore] public string? Df { get => Q("df"); set => Q("df", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Starting offset (default: 0) + /// + /// Starting offset (default: 0) + /// /// [JsonIgnore] public long? From { get => Q("from"); set => Q("from", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// + /// If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// /// [JsonIgnore] public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// - /// ID of the pipeline to use to preprocess incoming documents.
If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.
If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// + /// ID of the pipeline to use to preprocess incoming documents. + /// If the index has a default ingest pipeline specified, then setting the value to _none disables the default ingest pipeline for this request. + /// If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// /// [JsonIgnore] public string? Pipeline { get => Q("pipeline"); set => Q("pipeline", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If `true`, Elasticsearch refreshes affected shards to make the operation visible to search. + /// + /// If true, Elasticsearch refreshes affected shards to make the operation visible to search. + /// /// [JsonIgnore] public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// If `true`, the request cache is used for this request. + /// + /// If true, the request cache is used for this request. + /// /// [JsonIgnore] public bool? RequestCache { get => Q("request_cache"); set => Q("request_cache", value); } /// - /// The throttle for this request in sub-requests per second. + /// + /// The throttle for this request in sub-requests per second. + /// /// [JsonIgnore] public float? RequestsPerSecond { get => Q("requests_per_second"); set => Q("requests_per_second", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Period to retain the search context for scrolling. + /// + /// Period to retain the search context for scrolling. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); } /// - /// Size of the scroll request that powers the operation. + /// + /// Size of the scroll request that powers the operation. + /// /// [JsonIgnore] public long? ScrollSize { get => Q("scroll_size"); set => Q("scroll_size", value); } /// - /// Explicit timeout for each search request. + /// + /// Explicit timeout for each search request. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? SearchTimeout { get => Q("search_timeout"); set => Q("search_timeout", value); } /// - /// The type of the search operation. Available options: `query_then_fetch`, `dfs_query_then_fetch`. + /// + /// The type of the search operation. Available options: query_then_fetch, dfs_query_then_fetch. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } /// - /// The number of slices this task should be divided into. + /// + /// The number of slices this task should be divided into. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Slices? Slices { get => Q("slices"); set => Q("slices", value); } /// - /// A comma-separated list of : pairs. + /// + /// A comma-separated list of <field>:<direction> pairs. + /// /// [JsonIgnore] public ICollection? Sort { get => Q?>("sort"); set => Q("sort", value); } /// - /// Specific `tag` of the request for logging and statistical purposes. + /// + /// Specific tag of the request for logging and statistical purposes. + /// /// [JsonIgnore] public ICollection? Stats { get => Q?>("stats"); set => Q("stats", value); } /// - /// Maximum number of documents to collect for each shard.
If a query reaches this limit, Elasticsearch terminates the query early.
Elasticsearch collects documents before sorting.
Use with caution.
Elasticsearch applies this parameter to each shard handling the request.
When possible, let Elasticsearch perform early termination automatically.
Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + /// + /// Maximum number of documents to collect for each shard. + /// If a query reaches this limit, Elasticsearch terminates the query early. + /// Elasticsearch collects documents before sorting. + /// Use with caution. + /// Elasticsearch applies this parameter to each shard handling the request. + /// When possible, let Elasticsearch perform early termination automatically. + /// Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + /// /// [JsonIgnore] public long? TerminateAfter { get => Q("terminate_after"); set => Q("terminate_after", value); } /// - /// Period each update request waits for the following operations: dynamic mapping updates, waiting for active shards. + /// + /// Period each update request waits for the following operations: dynamic mapping updates, waiting for active shards. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// If `true`, returns the document version as part of a hit. + /// + /// If true, returns the document version as part of a hit. + /// /// [JsonIgnore] public bool? Version { get => Q("version"); set => Q("version", value); } /// - /// Should the document increment the version number (internal) on hit or not (reindex) + /// + /// Should the document increment the version number (internal) on hit or not (reindex) + /// /// [JsonIgnore] public bool? VersionType { get => Q("version_type"); set => Q("version_type", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } /// - /// If `true`, the request blocks until the operation is complete. + /// + /// If true, the request blocks until the operation is complete. + /// /// [JsonIgnore] public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } /// - /// What to do if update by query hits version conflicts: `abort` or `proceed`. + /// + /// What to do if update by query hits version conflicts: abort or proceed. + /// /// [JsonInclude, JsonPropertyName("conflicts")] public Elastic.Clients.Elasticsearch.Serverless.Conflicts? Conflicts { get; set; } /// - /// The maximum number of documents to update. + /// + /// The maximum number of documents to update. + /// /// [JsonInclude, JsonPropertyName("max_docs")] public long? MaxDocs { get; set; } /// - /// Specifies the documents to update using the Query DSL. + /// + /// Specifies the documents to update using the Query DSL. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? Query { get; set; } /// - /// The script to run to update the document source or metadata when updating. + /// + /// The script to run to update the document source or metadata when updating. + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Serverless.Script? Script { get; set; } /// - /// Slice the request manually using the provided slice ID and total number of slices. + /// + /// Slice the request manually using the provided slice ID and total number of slices. + /// /// [JsonInclude, JsonPropertyName("slice")] public Elastic.Clients.Elasticsearch.Serverless.SlicedScroll? Slice { get; set; } } /// -/// 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. +/// /// public sealed partial class UpdateByQueryRequestDescriptor : RequestDescriptor, UpdateByQueryRequestParameters> { @@ -459,7 +619,9 @@ public UpdateByQueryRequestDescriptor Indices(Elastic.Clients.Elastic private Action> SliceDescriptorAction { get; set; } /// - /// What to do if update by query hits version conflicts: `abort` or `proceed`. + /// + /// What to do if update by query hits version conflicts: abort or proceed. + /// /// public UpdateByQueryRequestDescriptor Conflicts(Elastic.Clients.Elasticsearch.Serverless.Conflicts? conflicts) { @@ -468,7 +630,9 @@ public UpdateByQueryRequestDescriptor Conflicts(Elastic.Clients.Elast } /// - /// The maximum number of documents to update. + /// + /// The maximum number of documents to update. + /// /// public UpdateByQueryRequestDescriptor MaxDocs(long? maxDocs) { @@ -477,7 +641,9 @@ public UpdateByQueryRequestDescriptor MaxDocs(long? maxDocs) } /// - /// Specifies the documents to update using the Query DSL. + /// + /// Specifies the documents to update using the Query DSL. + /// /// public UpdateByQueryRequestDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -504,7 +670,9 @@ public UpdateByQueryRequestDescriptor Query(Action - /// The script to run to update the document source or metadata when updating. + /// + /// The script to run to update the document source or metadata when updating. + /// /// public UpdateByQueryRequestDescriptor Script(Elastic.Clients.Elasticsearch.Serverless.Script? script) { @@ -531,7 +699,9 @@ public UpdateByQueryRequestDescriptor Script(Action - /// Slice the request manually using the provided slice ID and total number of slices. + /// + /// Slice the request manually using the provided slice ID and total number of slices. + /// /// public UpdateByQueryRequestDescriptor Slice(Elastic.Clients.Elasticsearch.Serverless.SlicedScroll? slice) { @@ -625,7 +795,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// 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. +/// /// public sealed partial class UpdateByQueryRequestDescriptor : RequestDescriptor { @@ -691,7 +865,9 @@ public UpdateByQueryRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Serv private Action SliceDescriptorAction { get; set; } /// - /// What to do if update by query hits version conflicts: `abort` or `proceed`. + /// + /// What to do if update by query hits version conflicts: abort or proceed. + /// /// public UpdateByQueryRequestDescriptor Conflicts(Elastic.Clients.Elasticsearch.Serverless.Conflicts? conflicts) { @@ -700,7 +876,9 @@ public UpdateByQueryRequestDescriptor Conflicts(Elastic.Clients.Elasticsearch.Se } /// - /// The maximum number of documents to update. + /// + /// The maximum number of documents to update. + /// /// public UpdateByQueryRequestDescriptor MaxDocs(long? maxDocs) { @@ -709,7 +887,9 @@ public UpdateByQueryRequestDescriptor MaxDocs(long? maxDocs) } /// - /// Specifies the documents to update using the Query DSL. + /// + /// Specifies the documents to update using the Query DSL. + /// /// public UpdateByQueryRequestDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -736,7 +916,9 @@ public UpdateByQueryRequestDescriptor Query(Action - /// The script to run to update the document source or metadata when updating. + /// + /// The script to run to update the document source or metadata when updating. + /// /// public UpdateByQueryRequestDescriptor Script(Elastic.Clients.Elasticsearch.Serverless.Script? script) { @@ -763,7 +945,9 @@ public UpdateByQueryRequestDescriptor Script(Action - /// Slice the request manually using the provided slice ID and total number of slices. + /// + /// Slice the request manually using the provided slice ID and total number of slices. + /// /// public UpdateByQueryRequestDescriptor Slice(Elastic.Clients.Elasticsearch.Serverless.SlicedScroll? slice) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/UpdateByQueryRethrottleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/UpdateByQueryRethrottleRequest.g.cs index c50986e2fa2..469b6b336ac 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/UpdateByQueryRethrottleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/UpdateByQueryRethrottleRequest.g.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class UpdateByQueryRethrottleRequestParameters : RequestParameters { /// - /// The throttle for this request in sub-requests per second. + /// + /// The throttle for this request in sub-requests per second. + /// /// public float? RequestsPerSecond { get => Q("requests_per_second"); set => Q("requests_per_second", value); } } /// -/// Changes the number of requests per second for a particular Update By Query operation. +/// +/// Changes the number of requests per second for a particular Update By Query operation. +/// /// public sealed partial class UpdateByQueryRethrottleRequest : PlainRequest { @@ -55,14 +59,18 @@ public UpdateByQueryRethrottleRequest(Elastic.Clients.Elasticsearch.Serverless.I internal override string OperationName => "update_by_query_rethrottle"; /// - /// The throttle for this request in sub-requests per second. + /// + /// The throttle for this request in sub-requests per second. + /// /// [JsonIgnore] public float? RequestsPerSecond { get => Q("requests_per_second"); set => Q("requests_per_second", value); } } /// -/// Changes the number of requests per second for a particular Update By Query operation. +/// +/// Changes the number of requests per second for a particular Update By Query operation. +/// /// public sealed partial class UpdateByQueryRethrottleRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/UpdateRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/UpdateRequest.g.cs index c6681c27e76..00b975145e3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/UpdateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/UpdateRequest.g.cs @@ -32,63 +32,94 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class UpdateRequestParameters : RequestParameters { /// - /// Only perform the operation if the document has this primary term. + /// + /// Only perform the operation if the document has this primary term. + /// /// public long? IfPrimaryTerm { get => Q("if_primary_term"); set => Q("if_primary_term", value); } /// - /// Only perform the operation if the document has this sequence number. + /// + /// Only perform the operation if the document has this sequence number. + /// /// public long? IfSeqNo { get => Q("if_seq_no"); set => Q("if_seq_no", value); } /// - /// The script language. + /// + /// The script language. + /// /// public string? Lang { get => Q("lang"); set => Q("lang", value); } /// - /// If 'true', Elasticsearch refreshes the affected shards to make this operation
visible to search, if 'wait_for' then wait for a refresh to make this operation
visible to search, if 'false' do nothing with refreshes. + /// + /// If 'true', Elasticsearch refreshes the affected shards to make this operation + /// visible to search, if 'wait_for' then wait for a refresh to make this operation + /// visible to search, if 'false' do nothing with refreshes. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Refresh? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// If true, the destination must be an index alias. + /// + /// If true, the destination must be an index alias. + /// /// public bool? RequireAlias { get => Q("require_alias"); set => Q("require_alias", value); } /// - /// Specify how many times should the operation be retried when a conflict occurs. + /// + /// Specify how many times should the operation be retried when a conflict occurs. + /// /// public int? RetryOnConflict { get => Q("retry_on_conflict"); set => Q("retry_on_conflict", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Specify the source fields you want to exclude. + /// + /// Specify the source fields you want to exclude. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// Specify the source fields you want to retrieve. + /// + /// Specify the source fields you want to retrieve. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// Period to wait for dynamic mapping updates and active shards.
This guarantees Elasticsearch waits for at least the timeout before failing.
The actual wait time could be longer, particularly when multiple waits occur. + /// + /// Period to wait for dynamic mapping updates and active shards. + /// This guarantees Elasticsearch waits for at least the timeout before failing. + /// The actual wait time could be longer, particularly when multiple waits occur. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operations.
Set to 'all' or any positive integer up to the total number of shards in the index
(number_of_replicas+1). Defaults to 1 meaning the primary shard. + /// + /// The number of shard copies that must be active before proceeding with the operations. + /// Set to 'all' or any positive integer up to the total number of shards in the index + /// (number_of_replicas+1). Defaults to 1 meaning the primary shard. + /// /// public Elastic.Clients.Elasticsearch.Serverless.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Update a document.
Updates a document by running a script or passing a partial document. +/// +/// Update a document. +/// Updates a document by running a script or passing a partial document. +/// /// public sealed partial class UpdateRequest : PlainRequest { @@ -105,110 +136,155 @@ public UpdateRequest(Elastic.Clients.Elasticsearch.Serverless.IndexName index, E internal override string OperationName => "update"; /// - /// Only perform the operation if the document has this primary term. + /// + /// Only perform the operation if the document has this primary term. + /// /// [JsonIgnore] public long? IfPrimaryTerm { get => Q("if_primary_term"); set => Q("if_primary_term", value); } /// - /// Only perform the operation if the document has this sequence number. + /// + /// Only perform the operation if the document has this sequence number. + /// /// [JsonIgnore] public long? IfSeqNo { get => Q("if_seq_no"); set => Q("if_seq_no", value); } /// - /// The script language. + /// + /// The script language. + /// /// [JsonIgnore] public string? Lang { get => Q("lang"); set => Q("lang", value); } /// - /// If 'true', Elasticsearch refreshes the affected shards to make this operation
visible to search, if 'wait_for' then wait for a refresh to make this operation
visible to search, if 'false' do nothing with refreshes. + /// + /// If 'true', Elasticsearch refreshes the affected shards to make this operation + /// visible to search, if 'wait_for' then wait for a refresh to make this operation + /// visible to search, if 'false' do nothing with refreshes. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Refresh? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// If true, the destination must be an index alias. + /// + /// If true, the destination must be an index alias. + /// /// [JsonIgnore] public bool? RequireAlias { get => Q("require_alias"); set => Q("require_alias", value); } /// - /// Specify how many times should the operation be retried when a conflict occurs. + /// + /// Specify how many times should the operation be retried when a conflict occurs. + /// /// [JsonIgnore] public int? RetryOnConflict { get => Q("retry_on_conflict"); set => Q("retry_on_conflict", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Specify the source fields you want to exclude. + /// + /// Specify the source fields you want to exclude. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// Specify the source fields you want to retrieve. + /// + /// Specify the source fields you want to retrieve. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// Period to wait for dynamic mapping updates and active shards.
This guarantees Elasticsearch waits for at least the timeout before failing.
The actual wait time could be longer, particularly when multiple waits occur. + /// + /// Period to wait for dynamic mapping updates and active shards. + /// This guarantees Elasticsearch waits for at least the timeout before failing. + /// The actual wait time could be longer, particularly when multiple waits occur. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operations.
Set to 'all' or any positive integer up to the total number of shards in the index
(number_of_replicas+1). Defaults to 1 meaning the primary shard. + /// + /// The number of shard copies that must be active before proceeding with the operations. + /// Set to 'all' or any positive integer up to the total number of shards in the index + /// (number_of_replicas+1). Defaults to 1 meaning the primary shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } /// - /// Set to false to disable setting 'result' in the response
to 'noop' if no change to the document occurred. + /// + /// Set to false to disable setting 'result' in the response + /// to 'noop' if no change to the document occurred. + /// /// [JsonInclude, JsonPropertyName("detect_noop")] public bool? DetectNoop { get; set; } /// - /// A partial update to an existing document. + /// + /// A partial update to an existing document. + /// /// [JsonInclude, JsonPropertyName("doc")] [SourceConverter] public TPartialDocument? Doc { get; set; } /// - /// Set to true to use the contents of 'doc' as the value of 'upsert' + /// + /// Set to true to use the contents of 'doc' as the value of 'upsert' + /// /// [JsonInclude, JsonPropertyName("doc_as_upsert")] public bool? DocAsUpsert { get; set; } /// - /// Script to execute to update the document. + /// + /// Script to execute to update the document. + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Serverless.Script? Script { get; set; } /// - /// Set to true to execute the script whether or not the document exists. + /// + /// Set to true to execute the script whether or not the document exists. + /// /// [JsonInclude, JsonPropertyName("scripted_upsert")] public bool? ScriptedUpsert { get; set; } /// - /// Set to false to disable source retrieval. You can also specify a comma-separated
list of the fields you want to retrieve. + /// + /// Set to false to disable source retrieval. You can also specify a comma-separated + /// list of the fields you want to retrieve. + /// /// [JsonInclude, JsonPropertyName("_source")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfig? Source { get; set; } /// - /// If the document does not already exist, the contents of 'upsert' are inserted as a
new document. If the document exists, the 'script' is executed. + /// + /// If the document does not already exist, the contents of 'upsert' are inserted as a + /// new document. If the document exists, the 'script' is executed. + /// /// [JsonInclude, JsonPropertyName("upsert")] [SourceConverter] @@ -216,7 +292,10 @@ public UpdateRequest(Elastic.Clients.Elasticsearch.Serverless.IndexName index, E } /// -/// Update a document.
Updates a document by running a script or passing a partial document. +/// +/// Update a document. +/// Updates a document by running a script or passing a partial document. +/// /// public sealed partial class UpdateRequestDescriptor : RequestDescriptor, UpdateRequestParameters> { @@ -285,7 +364,10 @@ public UpdateRequestDescriptor Index(Elastic.Client private TDocument? UpsertValue { get; set; } /// - /// Set to false to disable setting 'result' in the response
to 'noop' if no change to the document occurred. + /// + /// Set to false to disable setting 'result' in the response + /// to 'noop' if no change to the document occurred. + /// /// public UpdateRequestDescriptor DetectNoop(bool? detectNoop = true) { @@ -294,7 +376,9 @@ public UpdateRequestDescriptor DetectNoop(bool? det } /// - /// A partial update to an existing document. + /// + /// A partial update to an existing document. + /// /// public UpdateRequestDescriptor Doc(TPartialDocument? doc) { @@ -303,7 +387,9 @@ public UpdateRequestDescriptor Doc(TPartialDocument } /// - /// Set to true to use the contents of 'doc' as the value of 'upsert' + /// + /// Set to true to use the contents of 'doc' as the value of 'upsert' + /// /// public UpdateRequestDescriptor DocAsUpsert(bool? docAsUpsert = true) { @@ -312,7 +398,9 @@ public UpdateRequestDescriptor DocAsUpsert(bool? do } /// - /// Script to execute to update the document. + /// + /// Script to execute to update the document. + /// /// public UpdateRequestDescriptor Script(Elastic.Clients.Elasticsearch.Serverless.Script? script) { @@ -339,7 +427,9 @@ public UpdateRequestDescriptor Script(Action - /// Set to true to execute the script whether or not the document exists. + /// + /// Set to true to execute the script whether or not the document exists. + /// /// public UpdateRequestDescriptor ScriptedUpsert(bool? scriptedUpsert = true) { @@ -348,7 +438,10 @@ public UpdateRequestDescriptor ScriptedUpsert(bool? } /// - /// Set to false to disable source retrieval. You can also specify a comma-separated
list of the fields you want to retrieve. + /// + /// Set to false to disable source retrieval. You can also specify a comma-separated + /// list of the fields you want to retrieve. + /// /// public UpdateRequestDescriptor Source(Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfig? source) { @@ -357,7 +450,10 @@ public UpdateRequestDescriptor Source(Elastic.Clien } /// - /// If the document does not already exist, the contents of 'upsert' are inserted as a
new document. If the document exists, the 'script' is executed. + /// + /// If the document does not already exist, the contents of 'upsert' are inserted as a + /// new document. If the document exists, the 'script' is executed. + /// /// public UpdateRequestDescriptor Upsert(TDocument? upsert) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Xpack/XpackInfoRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Xpack/XpackInfoRequest.g.cs index 27ef2927712..87f0195bc1a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Xpack/XpackInfoRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Xpack/XpackInfoRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Xpack; public sealed partial class XpackInfoRequestParameters : RequestParameters { /// - /// If this param is used it must be set to true + /// + /// If this param is used it must be set to true + /// /// public bool? AcceptEnterprise { get => Q("accept_enterprise"); set => Q("accept_enterprise", value); } /// - /// A comma-separated list of the information categories to include in the response. For example, `build,license,features`. + /// + /// A comma-separated list of the information categories to include in the response. For example, build,license,features. + /// /// public ICollection? Categories { get => Q?>("categories"); set => Q("categories", value); } } /// -/// Provides general information about the installed X-Pack features. +/// +/// Provides general information about the installed X-Pack features. +/// /// public sealed partial class XpackInfoRequest : PlainRequest { @@ -56,20 +62,26 @@ public sealed partial class XpackInfoRequest : PlainRequest "xpack.info"; /// - /// If this param is used it must be set to true + /// + /// If this param is used it must be set to true + /// /// [JsonIgnore] public bool? AcceptEnterprise { get => Q("accept_enterprise"); set => Q("accept_enterprise", value); } /// - /// A comma-separated list of the information categories to include in the response. For example, `build,license,features`. + /// + /// A comma-separated list of the information categories to include in the response. For example, build,license,features. + /// /// [JsonIgnore] public ICollection? Categories { get => Q?>("categories"); set => Q("categories", value); } } /// -/// Provides general information about the installed X-Pack features. +/// +/// Provides general information about the installed X-Pack features. +/// /// public sealed partial class XpackInfoRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Xpack/XpackUsageRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Xpack/XpackUsageRequest.g.cs index 269e1054876..fdd2695a5a0 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Xpack/XpackUsageRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Xpack/XpackUsageRequest.g.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Xpack; public sealed partial class XpackUsageRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// This API provides information about which features are currently enabled and available under the current license and some usage statistics. +/// +/// This API provides information about which features are currently enabled and available under the current license and some usage statistics. +/// /// public sealed partial class XpackUsageRequest : PlainRequest { @@ -51,14 +55,18 @@ public sealed partial class XpackUsageRequest : PlainRequest "xpack.usage"; /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// This API provides information about which features are currently enabled and available under the current license and some usage statistics. +/// +/// This API provides information about which features are currently enabled and available under the current license and some usage statistics. +/// /// public sealed partial class XpackUsageRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.AsyncSearch.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.AsyncSearch.g.cs index 3518889061e..557338f3fcb 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.AsyncSearch.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.AsyncSearch.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.AsyncSearch; public partial class AsyncSearchNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected AsyncSearchNamespacedClient() : base() { @@ -38,7 +40,12 @@ internal AsyncSearchNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// Deletes an async search by identifier.
If the search is still running, the search request will be cancelled.
Otherwise, the saved search results are deleted.
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. + /// + /// Deletes an async search by identifier. + /// If the search is still running, the search request will be cancelled. + /// Otherwise, the saved search results are deleted. + /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteAsyncSearchRequest request, CancellationToken cancellationToken = default) @@ -48,7 +55,12 @@ public virtual Task DeleteAsync(DeleteAsyncSearchRequ } /// - /// Deletes an async search by identifier.
If the search is still running, the search request will be cancelled.
Otherwise, the saved search results are deleted.
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. + /// + /// Deletes an async search by identifier. + /// If the search is still running, the search request will be cancelled. + /// Otherwise, the saved search results are deleted. + /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteAsyncSearchRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -58,7 +70,12 @@ public virtual Task DeleteAsync(DeleteAsyn } /// - /// Deletes an async search by identifier.
If the search is still running, the search request will be cancelled.
Otherwise, the saved search results are deleted.
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. + /// + /// Deletes an async search by identifier. + /// If the search is still running, the search request will be cancelled. + /// Otherwise, the saved search results are deleted. + /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -69,7 +86,12 @@ public virtual Task DeleteAsync(Elastic.Cl } /// - /// Deletes an async search by identifier.
If the search is still running, the search request will be cancelled.
Otherwise, the saved search results are deleted.
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. + /// + /// Deletes an async search by identifier. + /// If the search is still running, the search request will be cancelled. + /// Otherwise, the saved search results are deleted. + /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -81,7 +103,12 @@ public virtual Task DeleteAsync(Elastic.Cl } /// - /// Deletes an async search by identifier.
If the search is still running, the search request will be cancelled.
Otherwise, the saved search results are deleted.
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. + /// + /// Deletes an async search by identifier. + /// If the search is still running, the search request will be cancelled. + /// Otherwise, the saved search results are deleted. + /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteAsyncSearchRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -91,7 +118,12 @@ public virtual Task DeleteAsync(DeleteAsyncSearchRequ } /// - /// Deletes an async search by identifier.
If the search is still running, the search request will be cancelled.
Otherwise, the saved search results are deleted.
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. + /// + /// Deletes an async search by identifier. + /// If the search is still running, the search request will be cancelled. + /// Otherwise, the saved search results are deleted. + /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -102,7 +134,12 @@ public virtual Task DeleteAsync(Elastic.Clients.Elast } /// - /// Deletes an async search by identifier.
If the search is still running, the search request will be cancelled.
Otherwise, the saved search results are deleted.
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. + /// + /// Deletes an async search by identifier. + /// If the search is still running, the search request will be cancelled. + /// Otherwise, the saved search results are deleted. + /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -114,7 +151,10 @@ public virtual Task DeleteAsync(Elastic.Clients.Elast } /// - /// Retrieves the results of a previously submitted async search request given its identifier.
If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. + /// + /// Retrieves the results of a previously submitted async search request given its identifier. + /// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(GetAsyncSearchRequest request, CancellationToken cancellationToken = default) @@ -124,7 +164,10 @@ public virtual Task> GetAsync(GetAs } /// - /// Retrieves the results of a previously submitted async search request given its identifier.
If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. + /// + /// Retrieves the results of a previously submitted async search request given its identifier. + /// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(GetAsyncSearchRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -134,7 +177,10 @@ public virtual Task> GetAsync(GetAs } /// - /// Retrieves the results of a previously submitted async search request given its identifier.
If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. + /// + /// Retrieves the results of a previously submitted async search request given its identifier. + /// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -145,7 +191,10 @@ public virtual Task> GetAsync(Elast } /// - /// Retrieves the results of a previously submitted async search request given its identifier.
If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. + /// + /// Retrieves the results of a previously submitted async search request given its identifier. + /// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -157,7 +206,11 @@ public virtual Task> GetAsync(Elast } /// - /// Get async search status
Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. + /// + /// Get async search status + /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(AsyncSearchStatusRequest request, CancellationToken cancellationToken = default) @@ -167,7 +220,11 @@ public virtual Task StatusAsync(AsyncSearchStatusRequ } /// - /// Get async search status
Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. + /// + /// Get async search status + /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(AsyncSearchStatusRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -177,7 +234,11 @@ public virtual Task StatusAsync(AsyncSearc } /// - /// Get async search status
Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. + /// + /// Get async search status + /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -188,7 +249,11 @@ public virtual Task StatusAsync(Elastic.Cl } /// - /// Get async search status
Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. + /// + /// Get async search status + /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -200,7 +265,11 @@ public virtual Task StatusAsync(Elastic.Cl } /// - /// Get async search status
Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. + /// + /// Get async search status + /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(AsyncSearchStatusRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -210,7 +279,11 @@ public virtual Task StatusAsync(AsyncSearchStatusRequ } /// - /// Get async search status
Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. + /// + /// Get async search status + /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -221,7 +294,11 @@ public virtual Task StatusAsync(Elastic.Clients.Elast } /// - /// Get async search status
Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. + /// + /// Get async search status + /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -233,7 +310,13 @@ public virtual Task StatusAsync(Elastic.Clients.Elast } /// - /// Runs a search request asynchronously.
When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.
Warning: Async search does not support scroll nor search requests that only include the suggest section.
By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. + /// + /// Runs a search request asynchronously. + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. + /// Warning: Async search does not support scroll nor search requests that only include the suggest section. + /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SubmitAsync(SubmitAsyncSearchRequest request, CancellationToken cancellationToken = default) @@ -243,7 +326,13 @@ public virtual Task> SubmitAsync } /// - /// Runs a search request asynchronously.
When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.
Warning: Async search does not support scroll nor search requests that only include the suggest section.
By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. + /// + /// Runs a search request asynchronously. + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. + /// Warning: Async search does not support scroll nor search requests that only include the suggest section. + /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SubmitAsync(SubmitAsyncSearchRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -253,7 +342,13 @@ public virtual Task> SubmitAsync } /// - /// Runs a search request asynchronously.
When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.
Warning: Async search does not support scroll nor search requests that only include the suggest section.
By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. + /// + /// Runs a search request asynchronously. + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. + /// Warning: Async search does not support scroll nor search requests that only include the suggest section. + /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SubmitAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -264,7 +359,13 @@ public virtual Task> SubmitAsync } /// - /// Runs a search request asynchronously.
When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.
Warning: Async search does not support scroll nor search requests that only include the suggest section.
By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. + /// + /// Runs a search request asynchronously. + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. + /// Warning: Async search does not support scroll nor search requests that only include the suggest section. + /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SubmitAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -276,7 +377,13 @@ public virtual Task> SubmitAsync } /// - /// Runs a search request asynchronously.
When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.
Warning: Async search does not support scroll nor search requests that only include the suggest section.
By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. + /// + /// Runs a search request asynchronously. + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. + /// Warning: Async search does not support scroll nor search requests that only include the suggest section. + /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SubmitAsync(CancellationToken cancellationToken = default) @@ -287,7 +394,13 @@ public virtual Task> SubmitAsync } /// - /// Runs a search request asynchronously.
When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.
Warning: Async search does not support scroll nor search requests that only include the suggest section.
By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. + /// + /// Runs a search request asynchronously. + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. + /// Warning: Async search does not support scroll nor search requests that only include the suggest section. + /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SubmitAsync(Action> configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Cluster.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Cluster.g.cs index 5d61131d0d0..e2b9c481879 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Cluster.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Cluster.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public partial class ClusterNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected ClusterNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal ClusterNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// Provides explanations for shard allocations in the cluster. + /// + /// Provides explanations for shard allocations in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AllocationExplainAsync(AllocationExplainRequest request, CancellationToken cancellationToken = default) @@ -48,7 +52,9 @@ public virtual Task AllocationExplainAsync(Allocation } /// - /// Provides explanations for shard allocations in the cluster. + /// + /// Provides explanations for shard allocations in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AllocationExplainAsync(AllocationExplainRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -58,7 +64,9 @@ public virtual Task AllocationExplainAsync(Allocation } /// - /// Provides explanations for shard allocations in the cluster. + /// + /// Provides explanations for shard allocations in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AllocationExplainAsync(CancellationToken cancellationToken = default) @@ -69,7 +77,9 @@ public virtual Task AllocationExplainAsync(Cancellati } /// - /// Provides explanations for shard allocations in the cluster. + /// + /// Provides explanations for shard allocations in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AllocationExplainAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -81,7 +91,11 @@ public virtual Task AllocationExplainAsync(Action - /// Delete component templates.
Deletes component templates.
Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. + /// + /// Delete component templates. + /// Deletes component templates. + /// Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteComponentTemplateAsync(DeleteComponentTemplateRequest request, CancellationToken cancellationToken = default) @@ -91,7 +105,11 @@ public virtual Task DeleteComponentTemplateAsyn } /// - /// Delete component templates.
Deletes component templates.
Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. + /// + /// Delete component templates. + /// Deletes component templates. + /// Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteComponentTemplateAsync(DeleteComponentTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -101,7 +119,11 @@ public virtual Task DeleteComponentTemplateAsyn } /// - /// Delete component templates.
Deletes component templates.
Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. + /// + /// Delete component templates. + /// Deletes component templates. + /// Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteComponentTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Names name, CancellationToken cancellationToken = default) @@ -112,7 +134,11 @@ public virtual Task DeleteComponentTemplateAsyn } /// - /// Delete component templates.
Deletes component templates.
Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. + /// + /// Delete component templates. + /// Deletes component templates. + /// Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteComponentTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Names name, Action configureRequest, CancellationToken cancellationToken = default) @@ -124,7 +150,10 @@ public virtual Task DeleteComponentTemplateAsyn } /// - /// Check component templates.
Returns information about whether a particular component template exists. + /// + /// Check component templates. + /// Returns information about whether a particular component template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsComponentTemplateAsync(ExistsComponentTemplateRequest request, CancellationToken cancellationToken = default) @@ -134,7 +163,10 @@ public virtual Task ExistsComponentTemplateAsyn } /// - /// Check component templates.
Returns information about whether a particular component template exists. + /// + /// Check component templates. + /// Returns information about whether a particular component template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsComponentTemplateAsync(ExistsComponentTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -144,7 +176,10 @@ public virtual Task ExistsComponentTemplateAsyn } /// - /// Check component templates.
Returns information about whether a particular component template exists. + /// + /// Check component templates. + /// Returns information about whether a particular component template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsComponentTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Names name, CancellationToken cancellationToken = default) @@ -155,7 +190,10 @@ public virtual Task ExistsComponentTemplateAsyn } /// - /// Check component templates.
Returns information about whether a particular component template exists. + /// + /// Check component templates. + /// Returns information about whether a particular component template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsComponentTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Names name, Action configureRequest, CancellationToken cancellationToken = default) @@ -167,7 +205,10 @@ public virtual Task ExistsComponentTemplateAsyn } /// - /// Get component templates.
Retrieves information about component templates. + /// + /// Get component templates. + /// Retrieves information about component templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetComponentTemplateAsync(GetComponentTemplateRequest request, CancellationToken cancellationToken = default) @@ -177,7 +218,10 @@ public virtual Task GetComponentTemplateAsync(GetC } /// - /// Get component templates.
Retrieves information about component templates. + /// + /// Get component templates. + /// Retrieves information about component templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetComponentTemplateAsync(GetComponentTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -187,7 +231,10 @@ public virtual Task GetComponentTemplateAsync(GetC } /// - /// Get component templates.
Retrieves information about component templates. + /// + /// Get component templates. + /// Retrieves information about component templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetComponentTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Name? name, CancellationToken cancellationToken = default) @@ -198,7 +245,10 @@ public virtual Task GetComponentTemplateAsync(Elas } /// - /// Get component templates.
Retrieves information about component templates. + /// + /// Get component templates. + /// Retrieves information about component templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetComponentTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Name? name, Action configureRequest, CancellationToken cancellationToken = default) @@ -210,7 +260,10 @@ public virtual Task GetComponentTemplateAsync(Elas } /// - /// Get component templates.
Retrieves information about component templates. + /// + /// Get component templates. + /// Retrieves information about component templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetComponentTemplateAsync(CancellationToken cancellationToken = default) @@ -221,7 +274,10 @@ public virtual Task GetComponentTemplateAsync(Canc } /// - /// Get component templates.
Retrieves information about component templates. + /// + /// Get component templates. + /// Retrieves information about component templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetComponentTemplateAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -233,7 +289,10 @@ public virtual Task GetComponentTemplateAsync(Acti } /// - /// Returns cluster-wide settings.
By default, it returns only settings that have been explicitly defined. + /// + /// Returns cluster-wide settings. + /// By default, it returns only settings that have been explicitly defined. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(GetClusterSettingsRequest request, CancellationToken cancellationToken = default) @@ -243,7 +302,10 @@ public virtual Task GetSettingsAsync(GetClusterSetti } /// - /// Returns cluster-wide settings.
By default, it returns only settings that have been explicitly defined. + /// + /// Returns cluster-wide settings. + /// By default, it returns only settings that have been explicitly defined. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(GetClusterSettingsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -253,7 +315,10 @@ public virtual Task GetSettingsAsync(GetClusterSetti } /// - /// Returns cluster-wide settings.
By default, it returns only settings that have been explicitly defined. + /// + /// Returns cluster-wide settings. + /// By default, it returns only settings that have been explicitly defined. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(CancellationToken cancellationToken = default) @@ -264,7 +329,10 @@ public virtual Task GetSettingsAsync(CancellationTok } /// - /// Returns cluster-wide settings.
By default, it returns only settings that have been explicitly defined. + /// + /// Returns cluster-wide settings. + /// By default, it returns only settings that have been explicitly defined. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -276,7 +344,10 @@ public virtual Task GetSettingsAsync(Action - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(HealthRequest request, CancellationToken cancellationToken = default) @@ -286,7 +357,10 @@ public virtual Task HealthAsync(HealthRequest request, Cancellat } /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(HealthRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -296,7 +370,10 @@ public virtual Task HealthAsync(HealthRequestDescript } /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -307,7 +384,10 @@ public virtual Task HealthAsync(Elastic.Clients.Elast } /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -319,7 +399,10 @@ public virtual Task HealthAsync(Elastic.Clients.Elast } /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(CancellationToken cancellationToken = default) @@ -330,7 +413,10 @@ public virtual Task HealthAsync(CancellationToken can } /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -342,7 +428,10 @@ public virtual Task HealthAsync(Action - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(HealthRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -352,7 +441,10 @@ public virtual Task HealthAsync(HealthRequestDescriptor descript } /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -363,7 +455,10 @@ public virtual Task HealthAsync(Elastic.Clients.Elasticsearch.Se } /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -375,7 +470,10 @@ public virtual Task HealthAsync(Elastic.Clients.Elasticsearch.Se } /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(CancellationToken cancellationToken = default) @@ -386,7 +484,10 @@ public virtual Task HealthAsync(CancellationToken cancellationTo } /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -398,7 +499,10 @@ public virtual Task HealthAsync(Action } /// - /// Get cluster info.
Returns basic information about the cluster. + /// + /// Get cluster info. + /// Returns basic information about the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(ClusterInfoRequest request, CancellationToken cancellationToken = default) @@ -408,7 +512,10 @@ public virtual Task InfoAsync(ClusterInfoRequest request, C } /// - /// Get cluster info.
Returns basic information about the cluster. + /// + /// Get cluster info. + /// Returns basic information about the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(ClusterInfoRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -418,7 +525,10 @@ public virtual Task InfoAsync(ClusterInfoRequestDescriptor } /// - /// Get cluster info.
Returns basic information about the cluster. + /// + /// Get cluster info. + /// Returns basic information about the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(IReadOnlyCollection target, CancellationToken cancellationToken = default) @@ -429,7 +539,10 @@ public virtual Task InfoAsync(IReadOnlyCollection - /// Get cluster info.
Returns basic information about the cluster. + /// + /// Get cluster info. + /// Returns basic information about the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(IReadOnlyCollection target, Action configureRequest, CancellationToken cancellationToken = default) @@ -441,7 +554,12 @@ public virtual Task InfoAsync(IReadOnlyCollection - /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed.
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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests.
However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. + /// + /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. + /// 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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. + /// However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PendingTasksAsync(PendingTasksRequest request, CancellationToken cancellationToken = default) @@ -451,7 +569,12 @@ public virtual Task PendingTasksAsync(PendingTasksRequest } /// - /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed.
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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests.
However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. + /// + /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. + /// 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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. + /// However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PendingTasksAsync(PendingTasksRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -461,7 +584,12 @@ public virtual Task PendingTasksAsync(PendingTasksRequestD } /// - /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed.
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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests.
However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. + /// + /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. + /// 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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. + /// However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PendingTasksAsync(CancellationToken cancellationToken = default) @@ -472,7 +600,12 @@ public virtual Task PendingTasksAsync(CancellationToken ca } /// - /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed.
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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests.
However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. + /// + /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. + /// 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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. + /// However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PendingTasksAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -484,11 +617,28 @@ public virtual Task PendingTasksAsync(Action - /// Create or update a component template.
Creates or updates 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 `composed_of` list.
Component templates are only applied to new data streams and indices as part of a matching index template. - /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. - /// Component templates are only used during index creation.
For data streams, this includes data stream creation and the creation of a stream’s backing indices.
Changes to component templates do not affect existing indices, including a stream’s backing indices. - /// You can use C-style `/* *\/` block comments in component templates.
You can include comments anywhere in the request body except before the opening curly bracket. + /// + /// Create or update a component template. + /// Creates or updates 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 composed_of list. + /// Component templates are only applied to new data streams and indices as part of a matching index template. + /// + /// + /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. + /// + /// + /// Component templates are only used during index creation. + /// For data streams, this includes data stream creation and the creation of a stream’s backing indices. + /// Changes to component templates do not affect existing indices, including a stream’s backing indices. + /// + /// + /// You can use C-style /* *\/ block comments in component templates. + /// You can include comments anywhere in the request body except before the opening curly bracket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutComponentTemplateAsync(PutComponentTemplateRequest request, CancellationToken cancellationToken = default) @@ -498,11 +648,28 @@ public virtual Task PutComponentTemplateAsync(PutC } /// - /// Create or update a component template.
Creates or updates 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 `composed_of` list.
Component templates are only applied to new data streams and indices as part of a matching index template. - /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. - /// Component templates are only used during index creation.
For data streams, this includes data stream creation and the creation of a stream’s backing indices.
Changes to component templates do not affect existing indices, including a stream’s backing indices. - /// You can use C-style `/* *\/` block comments in component templates.
You can include comments anywhere in the request body except before the opening curly bracket. + /// + /// Create or update a component template. + /// Creates or updates 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 composed_of list. + /// Component templates are only applied to new data streams and indices as part of a matching index template. + /// + /// + /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. + /// + /// + /// Component templates are only used during index creation. + /// For data streams, this includes data stream creation and the creation of a stream’s backing indices. + /// Changes to component templates do not affect existing indices, including a stream’s backing indices. + /// + /// + /// You can use C-style /* *\/ block comments in component templates. + /// You can include comments anywhere in the request body except before the opening curly bracket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutComponentTemplateAsync(PutComponentTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -512,11 +679,28 @@ public virtual Task PutComponentTemplateAsync - /// Create or update a component template.
Creates or updates 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 `composed_of` list.
Component templates are only applied to new data streams and indices as part of a matching index template. - /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. - /// Component templates are only used during index creation.
For data streams, this includes data stream creation and the creation of a stream’s backing indices.
Changes to component templates do not affect existing indices, including a stream’s backing indices. - /// You can use C-style `/* *\/` block comments in component templates.
You can include comments anywhere in the request body except before the opening curly bracket. + /// + /// Create or update a component template. + /// Creates or updates 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 composed_of list. + /// Component templates are only applied to new data streams and indices as part of a matching index template. + /// + /// + /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. + /// + /// + /// Component templates are only used during index creation. + /// For data streams, this includes data stream creation and the creation of a stream’s backing indices. + /// Changes to component templates do not affect existing indices, including a stream’s backing indices. + /// + /// + /// You can use C-style /* *\/ block comments in component templates. + /// You can include comments anywhere in the request body except before the opening curly bracket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutComponentTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, CancellationToken cancellationToken = default) @@ -527,11 +711,28 @@ public virtual Task PutComponentTemplateAsync - /// Create or update a component template.
Creates or updates 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 `composed_of` list.
Component templates are only applied to new data streams and indices as part of a matching index template. - /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. - /// Component templates are only used during index creation.
For data streams, this includes data stream creation and the creation of a stream’s backing indices.
Changes to component templates do not affect existing indices, including a stream’s backing indices. - /// You can use C-style `/* *\/` block comments in component templates.
You can include comments anywhere in the request body except before the opening curly bracket. + /// + /// Create or update a component template. + /// Creates or updates 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 composed_of list. + /// Component templates are only applied to new data streams and indices as part of a matching index template. + /// + /// + /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. + /// + /// + /// Component templates are only used during index creation. + /// For data streams, this includes data stream creation and the creation of a stream’s backing indices. + /// Changes to component templates do not affect existing indices, including a stream’s backing indices. + /// + /// + /// You can use C-style /* *\/ block comments in component templates. + /// You can include comments anywhere in the request body except before the opening curly bracket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutComponentTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, Action> configureRequest, CancellationToken cancellationToken = default) @@ -543,11 +744,28 @@ public virtual Task PutComponentTemplateAsync - /// Create or update a component template.
Creates or updates 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 `composed_of` list.
Component templates are only applied to new data streams and indices as part of a matching index template. - /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. - /// Component templates are only used during index creation.
For data streams, this includes data stream creation and the creation of a stream’s backing indices.
Changes to component templates do not affect existing indices, including a stream’s backing indices. - /// You can use C-style `/* *\/` block comments in component templates.
You can include comments anywhere in the request body except before the opening curly bracket. + /// + /// Create or update a component template. + /// Creates or updates 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 composed_of list. + /// Component templates are only applied to new data streams and indices as part of a matching index template. + /// + /// + /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. + /// + /// + /// Component templates are only used during index creation. + /// For data streams, this includes data stream creation and the creation of a stream’s backing indices. + /// Changes to component templates do not affect existing indices, including a stream’s backing indices. + /// + /// + /// You can use C-style /* *\/ block comments in component templates. + /// You can include comments anywhere in the request body except before the opening curly bracket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutComponentTemplateAsync(PutComponentTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -557,11 +775,28 @@ public virtual Task PutComponentTemplateAsync(PutC } /// - /// Create or update a component template.
Creates or updates 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 `composed_of` list.
Component templates are only applied to new data streams and indices as part of a matching index template. - /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. - /// Component templates are only used during index creation.
For data streams, this includes data stream creation and the creation of a stream’s backing indices.
Changes to component templates do not affect existing indices, including a stream’s backing indices. - /// You can use C-style `/* *\/` block comments in component templates.
You can include comments anywhere in the request body except before the opening curly bracket. + /// + /// Create or update a component template. + /// Creates or updates 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 composed_of list. + /// Component templates are only applied to new data streams and indices as part of a matching index template. + /// + /// + /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. + /// + /// + /// Component templates are only used during index creation. + /// For data streams, this includes data stream creation and the creation of a stream’s backing indices. + /// Changes to component templates do not affect existing indices, including a stream’s backing indices. + /// + /// + /// You can use C-style /* *\/ block comments in component templates. + /// You can include comments anywhere in the request body except before the opening curly bracket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutComponentTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, CancellationToken cancellationToken = default) @@ -572,11 +807,28 @@ public virtual Task PutComponentTemplateAsync(Elas } /// - /// Create or update a component template.
Creates or updates 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 `composed_of` list.
Component templates are only applied to new data streams and indices as part of a matching index template. - /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. - /// Component templates are only used during index creation.
For data streams, this includes data stream creation and the creation of a stream’s backing indices.
Changes to component templates do not affect existing indices, including a stream’s backing indices. - /// You can use C-style `/* *\/` block comments in component templates.
You can include comments anywhere in the request body except before the opening curly bracket. + /// + /// Create or update a component template. + /// Creates or updates 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 composed_of list. + /// Component templates are only applied to new data streams and indices as part of a matching index template. + /// + /// + /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. + /// + /// + /// Component templates are only used during index creation. + /// For data streams, this includes data stream creation and the creation of a stream’s backing indices. + /// Changes to component templates do not affect existing indices, including a stream’s backing indices. + /// + /// + /// You can use C-style /* *\/ block comments in component templates. + /// You can include comments anywhere in the request body except before the opening curly bracket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutComponentTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -588,7 +840,10 @@ public virtual Task PutComponentTemplateAsync(Elas } /// - /// Returns cluster statistics.
It returns 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). + /// + /// Returns cluster statistics. + /// It returns 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). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(ClusterStatsRequest request, CancellationToken cancellationToken = default) @@ -598,7 +853,10 @@ public virtual Task StatsAsync(ClusterStatsRequest request } /// - /// Returns cluster statistics.
It returns 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). + /// + /// Returns cluster statistics. + /// It returns 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). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(ClusterStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -608,7 +866,10 @@ public virtual Task StatsAsync(ClusterStatsRequestDescript } /// - /// Returns cluster statistics.
It returns 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). + /// + /// Returns cluster statistics. + /// It returns 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). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeId, CancellationToken cancellationToken = default) @@ -619,7 +880,10 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsear } /// - /// Returns cluster statistics.
It returns 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). + /// + /// Returns cluster statistics. + /// It returns 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). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeId, Action configureRequest, CancellationToken cancellationToken = default) @@ -631,7 +895,10 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsear } /// - /// Returns cluster statistics.
It returns 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). + /// + /// Returns cluster statistics. + /// It returns 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). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(CancellationToken cancellationToken = default) @@ -642,7 +909,10 @@ public virtual Task StatsAsync(CancellationToken cancellat } /// - /// Returns cluster statistics.
It returns 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). + /// + /// Returns cluster statistics. + /// It returns 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). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Enrich.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Enrich.g.cs index d45592880b2..6d6d1351c57 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Enrich.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Enrich.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Enrich; public partial class EnrichNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected EnrichNamespacedClient() : base() { @@ -38,7 +40,10 @@ internal EnrichNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// Delete an enrich policy.
Deletes an existing enrich policy and its enrich index. + /// + /// Delete an enrich policy. + /// Deletes an existing enrich policy and its enrich index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeletePolicyAsync(DeletePolicyRequest request, CancellationToken cancellationToken = default) @@ -48,7 +53,10 @@ public virtual Task DeletePolicyAsync(DeletePolicyRequest } /// - /// Delete an enrich policy.
Deletes an existing enrich policy and its enrich index. + /// + /// Delete an enrich policy. + /// Deletes an existing enrich policy and its enrich index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeletePolicyAsync(DeletePolicyRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -58,7 +66,10 @@ public virtual Task DeletePolicyAsync(DeletePolicyRequestD } /// - /// Delete an enrich policy.
Deletes an existing enrich policy and its enrich index. + /// + /// Delete an enrich policy. + /// Deletes an existing enrich policy and its enrich index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeletePolicyAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, CancellationToken cancellationToken = default) @@ -69,7 +80,10 @@ public virtual Task DeletePolicyAsync(Elastic.Clients.Elas } /// - /// Delete an enrich policy.
Deletes an existing enrich policy and its enrich index. + /// + /// Delete an enrich policy. + /// Deletes an existing enrich policy and its enrich index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeletePolicyAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -81,7 +95,9 @@ public virtual Task DeletePolicyAsync(Elastic.Clients.Elas } /// - /// Creates the enrich index for an existing enrich policy. + /// + /// Creates the enrich index for an existing enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExecutePolicyAsync(ExecutePolicyRequest request, CancellationToken cancellationToken = default) @@ -91,7 +107,9 @@ public virtual Task ExecutePolicyAsync(ExecutePolicyReque } /// - /// Creates the enrich index for an existing enrich policy. + /// + /// Creates the enrich index for an existing enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExecutePolicyAsync(ExecutePolicyRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -101,7 +119,9 @@ public virtual Task ExecutePolicyAsync(ExecutePolicyReque } /// - /// Creates the enrich index for an existing enrich policy. + /// + /// Creates the enrich index for an existing enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExecutePolicyAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, CancellationToken cancellationToken = default) @@ -112,7 +132,9 @@ public virtual Task ExecutePolicyAsync(Elastic.Clients.El } /// - /// Creates the enrich index for an existing enrich policy. + /// + /// Creates the enrich index for an existing enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExecutePolicyAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -124,7 +146,10 @@ public virtual Task ExecutePolicyAsync(Elastic.Clients.El } /// - /// Get an enrich policy.
Returns information about an enrich policy. + /// + /// Get an enrich policy. + /// Returns information about an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPolicyAsync(GetPolicyRequest request, CancellationToken cancellationToken = default) @@ -134,7 +159,10 @@ public virtual Task GetPolicyAsync(GetPolicyRequest request, } /// - /// Get an enrich policy.
Returns information about an enrich policy. + /// + /// Get an enrich policy. + /// Returns information about an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPolicyAsync(GetPolicyRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -144,7 +172,10 @@ public virtual Task GetPolicyAsync(GetPolicyRequestDescriptor } /// - /// Get an enrich policy.
Returns information about an enrich policy. + /// + /// Get an enrich policy. + /// Returns information about an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPolicyAsync(Elastic.Clients.Elasticsearch.Serverless.Names? name, CancellationToken cancellationToken = default) @@ -155,7 +186,10 @@ public virtual Task GetPolicyAsync(Elastic.Clients.Elasticsea } /// - /// Get an enrich policy.
Returns information about an enrich policy. + /// + /// Get an enrich policy. + /// Returns information about an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPolicyAsync(Elastic.Clients.Elasticsearch.Serverless.Names? name, Action configureRequest, CancellationToken cancellationToken = default) @@ -167,7 +201,10 @@ public virtual Task GetPolicyAsync(Elastic.Clients.Elasticsea } /// - /// Get an enrich policy.
Returns information about an enrich policy. + /// + /// Get an enrich policy. + /// Returns information about an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPolicyAsync(CancellationToken cancellationToken = default) @@ -178,7 +215,10 @@ public virtual Task GetPolicyAsync(CancellationToken cancella } /// - /// Get an enrich policy.
Returns information about an enrich policy. + /// + /// Get an enrich policy. + /// Returns information about an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPolicyAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -190,7 +230,10 @@ public virtual Task GetPolicyAsync(Action - /// Create an enrich policy.
Creates an enrich policy. + /// + /// Create an enrich policy. + /// Creates an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPolicyAsync(PutPolicyRequest request, CancellationToken cancellationToken = default) @@ -200,7 +243,10 @@ public virtual Task PutPolicyAsync(PutPolicyRequest request, } /// - /// Create an enrich policy.
Creates an enrich policy. + /// + /// Create an enrich policy. + /// Creates an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPolicyAsync(PutPolicyRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -210,7 +256,10 @@ public virtual Task PutPolicyAsync(PutPolicyReques } /// - /// Create an enrich policy.
Creates an enrich policy. + /// + /// Create an enrich policy. + /// Creates an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPolicyAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, CancellationToken cancellationToken = default) @@ -221,7 +270,10 @@ public virtual Task PutPolicyAsync(Elastic.Clients } /// - /// Create an enrich policy.
Creates an enrich policy. + /// + /// Create an enrich policy. + /// Creates an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPolicyAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, Action> configureRequest, CancellationToken cancellationToken = default) @@ -233,7 +285,10 @@ public virtual Task PutPolicyAsync(Elastic.Clients } /// - /// Create an enrich policy.
Creates an enrich policy. + /// + /// Create an enrich policy. + /// Creates an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPolicyAsync(PutPolicyRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -243,7 +298,10 @@ public virtual Task PutPolicyAsync(PutPolicyRequestDescriptor } /// - /// Create an enrich policy.
Creates an enrich policy. + /// + /// Create an enrich policy. + /// Creates an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPolicyAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, CancellationToken cancellationToken = default) @@ -254,7 +312,10 @@ public virtual Task PutPolicyAsync(Elastic.Clients.Elasticsea } /// - /// Create an enrich policy.
Creates an enrich policy. + /// + /// Create an enrich policy. + /// Creates an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPolicyAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -266,7 +327,10 @@ public virtual Task PutPolicyAsync(Elastic.Clients.Elasticsea } /// - /// Get enrich stats.
Returns enrich coordinator statistics and information about enrich policies that are currently executing. + /// + /// Get enrich stats. + /// Returns enrich coordinator statistics and information about enrich policies that are currently executing. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(EnrichStatsRequest request, CancellationToken cancellationToken = default) @@ -276,7 +340,10 @@ public virtual Task StatsAsync(EnrichStatsRequest request, } /// - /// Get enrich stats.
Returns enrich coordinator statistics and information about enrich policies that are currently executing. + /// + /// Get enrich stats. + /// Returns enrich coordinator statistics and information about enrich policies that are currently executing. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(EnrichStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -286,7 +353,10 @@ public virtual Task StatsAsync(EnrichStatsRequestDescriptor } /// - /// Get enrich stats.
Returns enrich coordinator statistics and information about enrich policies that are currently executing. + /// + /// Get enrich stats. + /// Returns enrich coordinator statistics and information about enrich policies that are currently executing. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(CancellationToken cancellationToken = default) @@ -297,7 +367,10 @@ public virtual Task StatsAsync(CancellationToken cancellati } /// - /// Get enrich stats.
Returns enrich coordinator statistics and information about enrich policies that are currently executing. + /// + /// Get enrich stats. + /// Returns enrich coordinator statistics and information about enrich policies that are currently executing. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Eql.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Eql.g.cs index 5a26b32c099..6f6de5930a0 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Eql.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Eql.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Eql; public partial class EqlNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected EqlNamespacedClient() : base() { @@ -38,7 +40,10 @@ internal EqlNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// Deletes an async EQL search or a stored synchronous EQL search.
The API also deletes results for the search. + /// + /// Deletes an async EQL search or a stored synchronous EQL search. + /// The API also deletes results for the search. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(EqlDeleteRequest request, CancellationToken cancellationToken = default) @@ -48,7 +53,10 @@ public virtual Task DeleteAsync(EqlDeleteRequest request, Can } /// - /// Deletes an async EQL search or a stored synchronous EQL search.
The API also deletes results for the search. + /// + /// Deletes an async EQL search or a stored synchronous EQL search. + /// The API also deletes results for the search. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(EqlDeleteRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -58,7 +66,10 @@ public virtual Task DeleteAsync(EqlDeleteRequestDe } /// - /// Deletes an async EQL search or a stored synchronous EQL search.
The API also deletes results for the search. + /// + /// Deletes an async EQL search or a stored synchronous EQL search. + /// The API also deletes results for the search. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -69,7 +80,10 @@ public virtual Task DeleteAsync(Elastic.Clients.El } /// - /// Deletes an async EQL search or a stored synchronous EQL search.
The API also deletes results for the search. + /// + /// Deletes an async EQL search or a stored synchronous EQL search. + /// The API also deletes results for the search. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -81,7 +95,10 @@ public virtual Task DeleteAsync(Elastic.Clients.El } /// - /// Deletes an async EQL search or a stored synchronous EQL search.
The API also deletes results for the search. + /// + /// Deletes an async EQL search or a stored synchronous EQL search. + /// The API also deletes results for the search. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(EqlDeleteRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -91,7 +108,10 @@ public virtual Task DeleteAsync(EqlDeleteRequestDescriptor de } /// - /// Deletes an async EQL search or a stored synchronous EQL search.
The API also deletes results for the search. + /// + /// Deletes an async EQL search or a stored synchronous EQL search. + /// The API also deletes results for the search. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -102,7 +122,10 @@ public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch } /// - /// Deletes an async EQL search or a stored synchronous EQL search.
The API also deletes results for the search. + /// + /// Deletes an async EQL search or a stored synchronous EQL search. + /// The API also deletes results for the search. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -114,7 +137,9 @@ public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch } /// - /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + /// + /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(EqlGetRequest request, CancellationToken cancellationToken = default) @@ -124,7 +149,9 @@ public virtual Task> GetAsync(EqlGetRequest reque } /// - /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + /// + /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(EqlGetRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -134,7 +161,9 @@ public virtual Task> GetAsync(EqlGetRequestDescri } /// - /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + /// + /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -145,7 +174,9 @@ public virtual Task> GetAsync(Elastic.Clients.Ela } /// - /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + /// + /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -157,7 +188,9 @@ public virtual Task> GetAsync(Elastic.Clients.Ela } /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// + /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(GetEqlStatusRequest request, CancellationToken cancellationToken = default) @@ -167,7 +200,9 @@ public virtual Task GetStatusAsync(GetEqlStatusRequest req } /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// + /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(GetEqlStatusRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -177,7 +212,9 @@ public virtual Task GetStatusAsync(GetEqlStatus } /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// + /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -188,7 +225,9 @@ public virtual Task GetStatusAsync(Elastic.Clie } /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// + /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -200,7 +239,9 @@ public virtual Task GetStatusAsync(Elastic.Clie } /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// + /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(GetEqlStatusRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -210,7 +251,9 @@ public virtual Task GetStatusAsync(GetEqlStatusRequestDesc } /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// + /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -221,7 +264,9 @@ public virtual Task GetStatusAsync(Elastic.Clients.Elastic } /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// + /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -233,7 +278,9 @@ public virtual Task GetStatusAsync(Elastic.Clients.Elastic } /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// + /// Returns results matching a query expressed in Event Query Language (EQL) + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchAsync(EqlSearchRequest request, CancellationToken cancellationToken = default) @@ -243,7 +290,9 @@ public virtual Task> SearchAsync(EqlSearchRequ } /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// + /// Returns results matching a query expressed in Event Query Language (EQL) + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchAsync(EqlSearchRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -253,7 +302,9 @@ public virtual Task> SearchAsync(EqlSearchRequ } /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// + /// Returns results matching a query expressed in Event Query Language (EQL) + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, CancellationToken cancellationToken = default) @@ -264,7 +315,9 @@ public virtual Task> SearchAsync(Elastic.Clien } /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// + /// Returns results matching a query expressed in Event Query Language (EQL) + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -276,7 +329,9 @@ public virtual Task> SearchAsync(Elastic.Clien } /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// + /// Returns results matching a query expressed in Event Query Language (EQL) + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchAsync(CancellationToken cancellationToken = default) @@ -287,7 +342,9 @@ public virtual Task> SearchAsync(CancellationT } /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// + /// Returns results matching a query expressed in Event Query Language (EQL) + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchAsync(Action> configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Esql.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Esql.g.cs index 98074501f2d..245c60e503f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Esql.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Esql.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Esql; public partial class EsqlNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected EsqlNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal EsqlNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// Executes an ES|QL request + /// + /// Executes an ES|QL request + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(EsqlQueryRequest request, CancellationToken cancellationToken = default) @@ -48,7 +52,9 @@ public virtual Task QueryAsync(EsqlQueryRequest request, Canc } /// - /// Executes an ES|QL request + /// + /// Executes an ES|QL request + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(EsqlQueryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -58,7 +64,9 @@ public virtual Task QueryAsync(EsqlQueryRequestDes } /// - /// Executes an ES|QL request + /// + /// Executes an ES|QL request + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(CancellationToken cancellationToken = default) @@ -69,7 +77,9 @@ public virtual Task QueryAsync(CancellationToken c } /// - /// Executes an ES|QL request + /// + /// Executes an ES|QL request + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -81,7 +91,9 @@ public virtual Task QueryAsync(Action - /// Executes an ES|QL request + /// + /// Executes an ES|QL request + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(EsqlQueryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -91,7 +103,9 @@ public virtual Task QueryAsync(EsqlQueryRequestDescriptor des } /// - /// Executes an ES|QL request + /// + /// Executes an ES|QL request + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(CancellationToken cancellationToken = default) @@ -102,7 +116,9 @@ public virtual Task QueryAsync(CancellationToken cancellation } /// - /// Executes an ES|QL request + /// + /// Executes an ES|QL request + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Graph.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Graph.g.cs index b21960ad36e..1d51b370471 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Graph.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Graph.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Graph; public partial class GraphNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected GraphNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal GraphNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// + /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(ExploreRequest request, CancellationToken cancellationToken = default) @@ -48,7 +52,9 @@ public virtual Task ExploreAsync(ExploreRequest request, Cancel } /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// + /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(ExploreRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -58,7 +64,9 @@ public virtual Task ExploreAsync(ExploreRequestDescr } /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// + /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, CancellationToken cancellationToken = default) @@ -69,7 +77,9 @@ public virtual Task ExploreAsync(Elastic.Clients.Ela } /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// + /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -81,7 +91,9 @@ public virtual Task ExploreAsync(Elastic.Clients.Ela } /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// + /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(CancellationToken cancellationToken = default) @@ -92,7 +104,9 @@ public virtual Task ExploreAsync(CancellationToken c } /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// + /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -104,7 +118,9 @@ public virtual Task ExploreAsync(Action - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// + /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(ExploreRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -114,7 +130,9 @@ public virtual Task ExploreAsync(ExploreRequestDescriptor descr } /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// + /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, CancellationToken cancellationToken = default) @@ -125,7 +143,9 @@ public virtual Task ExploreAsync(Elastic.Clients.Elasticsearch. } /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// + /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Indices.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Indices.g.cs index c05c1a97225..2a96072cdf4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Indices.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Indices.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public partial class IndicesNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected IndicesNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal IndicesNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(AnalyzeIndexRequest request, CancellationToken cancellationToken = default) @@ -48,7 +52,9 @@ public virtual Task AnalyzeAsync(AnalyzeIndexRequest reque } /// - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(AnalyzeIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -58,7 +64,9 @@ public virtual Task AnalyzeAsync(AnalyzeIndexRe } /// - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName? index, CancellationToken cancellationToken = default) @@ -69,7 +77,9 @@ public virtual Task AnalyzeAsync(Elastic.Client } /// - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName? index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -81,7 +91,9 @@ public virtual Task AnalyzeAsync(Elastic.Client } /// - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(CancellationToken cancellationToken = default) @@ -92,7 +104,9 @@ public virtual Task AnalyzeAsync(CancellationTo } /// - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -104,7 +118,9 @@ public virtual Task AnalyzeAsync(Action - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(AnalyzeIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -114,7 +130,9 @@ public virtual Task AnalyzeAsync(AnalyzeIndexRequestDescri } /// - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName? index, CancellationToken cancellationToken = default) @@ -125,7 +143,9 @@ public virtual Task AnalyzeAsync(Elastic.Clients.Elasticse } /// - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName? index, Action configureRequest, CancellationToken cancellationToken = default) @@ -137,7 +157,9 @@ public virtual Task AnalyzeAsync(Elastic.Clients.Elasticse } /// - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(CancellationToken cancellationToken = default) @@ -148,7 +170,9 @@ public virtual Task AnalyzeAsync(CancellationToken cancell } /// - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -160,7 +184,10 @@ public virtual Task AnalyzeAsync(Action - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(ClearCacheRequest request, CancellationToken cancellationToken = default) @@ -170,7 +197,10 @@ public virtual Task ClearCacheAsync(ClearCacheRequest reques } /// - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(ClearCacheRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -180,7 +210,10 @@ public virtual Task ClearCacheAsync(ClearCacheReq } /// - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -191,7 +224,10 @@ public virtual Task ClearCacheAsync(Elastic.Clien } /// - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -203,7 +239,10 @@ public virtual Task ClearCacheAsync(Elastic.Clien } /// - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(CancellationToken cancellationToken = default) @@ -214,7 +253,10 @@ public virtual Task ClearCacheAsync(CancellationT } /// - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -226,7 +268,10 @@ public virtual Task ClearCacheAsync(Action - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(ClearCacheRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -236,7 +281,10 @@ public virtual Task ClearCacheAsync(ClearCacheRequestDescrip } /// - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -247,7 +295,10 @@ public virtual Task ClearCacheAsync(Elastic.Clients.Elastics } /// - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -259,7 +310,10 @@ public virtual Task ClearCacheAsync(Elastic.Clients.Elastics } /// - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(CancellationToken cancellationToken = default) @@ -270,7 +324,10 @@ public virtual Task ClearCacheAsync(CancellationToken cancel } /// - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -282,7 +339,9 @@ public virtual Task ClearCacheAsync(Action - /// Closes an index. + /// + /// Closes an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(CloseIndexRequest request, CancellationToken cancellationToken = default) @@ -292,7 +351,9 @@ public virtual Task CloseAsync(CloseIndexRequest request, Ca } /// - /// Closes an index. + /// + /// Closes an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(CloseIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -302,7 +363,9 @@ public virtual Task CloseAsync(CloseIndexRequestD } /// - /// Closes an index. + /// + /// Closes an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, CancellationToken cancellationToken = default) @@ -313,7 +376,9 @@ public virtual Task CloseAsync(Elastic.Clients.El } /// - /// Closes an index. + /// + /// Closes an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -325,7 +390,9 @@ public virtual Task CloseAsync(Elastic.Clients.El } /// - /// Closes an index. + /// + /// Closes an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(CancellationToken cancellationToken = default) @@ -336,7 +403,9 @@ public virtual Task CloseAsync(CancellationToken } /// - /// Closes an index. + /// + /// Closes an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -348,7 +417,9 @@ public virtual Task CloseAsync(Action - /// Closes an index. + /// + /// Closes an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(CloseIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -358,7 +429,9 @@ public virtual Task CloseAsync(CloseIndexRequestDescriptor d } /// - /// Closes an index. + /// + /// Closes an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, CancellationToken cancellationToken = default) @@ -369,7 +442,9 @@ public virtual Task CloseAsync(Elastic.Clients.Elasticsearch } /// - /// Closes an index. + /// + /// Closes an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -381,7 +456,10 @@ public virtual Task CloseAsync(Elastic.Clients.Elasticsearch } /// - /// Create an index.
Creates a new index. + /// + /// Create an index. + /// Creates a new index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(CreateIndexRequest request, CancellationToken cancellationToken = default) @@ -391,7 +469,10 @@ public virtual Task CreateAsync(CreateIndexRequest request, } /// - /// Create an index.
Creates a new index. + /// + /// Create an index. + /// Creates a new index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(CreateIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -401,7 +482,10 @@ public virtual Task CreateAsync(CreateIndexReque } /// - /// Create an index.
Creates a new index. + /// + /// Create an index. + /// Creates a new index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, CancellationToken cancellationToken = default) @@ -412,7 +496,10 @@ public virtual Task CreateAsync(Elastic.Clients. } /// - /// Create an index.
Creates a new index. + /// + /// Create an index. + /// Creates a new index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -424,7 +511,10 @@ public virtual Task CreateAsync(Elastic.Clients. } /// - /// Create an index.
Creates a new index. + /// + /// Create an index. + /// Creates a new index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(CancellationToken cancellationToken = default) @@ -435,7 +525,10 @@ public virtual Task CreateAsync(CancellationToke } /// - /// Create an index.
Creates a new index. + /// + /// Create an index. + /// Creates a new index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -447,7 +540,10 @@ public virtual Task CreateAsync(Action - /// Create an index.
Creates a new index. + /// + /// Create an index. + /// Creates a new index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(CreateIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -457,7 +553,10 @@ public virtual Task CreateAsync(CreateIndexRequestDescripto } /// - /// Create an index.
Creates a new index. + /// + /// Create an index. + /// Creates a new index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, CancellationToken cancellationToken = default) @@ -468,7 +567,10 @@ public virtual Task CreateAsync(Elastic.Clients.Elasticsear } /// - /// Create an index.
Creates a new index. + /// + /// Create an index. + /// Creates a new index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, Action configureRequest, CancellationToken cancellationToken = default) @@ -480,7 +582,11 @@ public virtual Task CreateAsync(Elastic.Clients.Elasticsear } /// - /// Create a data stream.
Creates a data stream.
You must have a matching index template with data stream enabled. + /// + /// Create a data stream. + /// Creates a data stream. + /// You must have a matching index template with data stream enabled. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateDataStreamAsync(CreateDataStreamRequest request, CancellationToken cancellationToken = default) @@ -490,7 +596,11 @@ public virtual Task CreateDataStreamAsync(CreateDataSt } /// - /// Create a data stream.
Creates a data stream.
You must have a matching index template with data stream enabled. + /// + /// Create a data stream. + /// Creates a data stream. + /// You must have a matching index template with data stream enabled. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateDataStreamAsync(CreateDataStreamRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -500,7 +610,11 @@ public virtual Task CreateDataStreamAsync(CreateDataSt } /// - /// Create a data stream.
Creates a data stream.
You must have a matching index template with data stream enabled. + /// + /// Create a data stream. + /// Creates a data stream. + /// You must have a matching index template with data stream enabled. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateDataStreamAsync(Elastic.Clients.Elasticsearch.Serverless.DataStreamName name, CancellationToken cancellationToken = default) @@ -511,7 +625,11 @@ public virtual Task CreateDataStreamAsync(Elastic.Clie } /// - /// Create a data stream.
Creates a data stream.
You must have a matching index template with data stream enabled. + /// + /// Create a data stream. + /// Creates a data stream. + /// You must have a matching index template with data stream enabled. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateDataStreamAsync(Elastic.Clients.Elasticsearch.Serverless.DataStreamName name, Action configureRequest, CancellationToken cancellationToken = default) @@ -523,7 +641,10 @@ public virtual Task CreateDataStreamAsync(Elastic.Clie } /// - /// Get data stream stats.
Retrieves statistics for one or more data streams. + /// + /// Get data stream stats. + /// Retrieves statistics for one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DataStreamsStatsAsync(DataStreamsStatsRequest request, CancellationToken cancellationToken = default) @@ -533,7 +654,10 @@ public virtual Task DataStreamsStatsAsync(DataStreamsS } /// - /// Get data stream stats.
Retrieves statistics for one or more data streams. + /// + /// Get data stream stats. + /// Retrieves statistics for one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DataStreamsStatsAsync(DataStreamsStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -543,7 +667,10 @@ public virtual Task DataStreamsStatsAsync(DataStreamsS } /// - /// Get data stream stats.
Retrieves statistics for one or more data streams. + /// + /// Get data stream stats. + /// Retrieves statistics for one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DataStreamsStatsAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName? name, CancellationToken cancellationToken = default) @@ -554,7 +681,10 @@ public virtual Task DataStreamsStatsAsync(Elastic.Clie } /// - /// Get data stream stats.
Retrieves statistics for one or more data streams. + /// + /// Get data stream stats. + /// Retrieves statistics for one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DataStreamsStatsAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName? name, Action configureRequest, CancellationToken cancellationToken = default) @@ -566,7 +696,10 @@ public virtual Task DataStreamsStatsAsync(Elastic.Clie } /// - /// Get data stream stats.
Retrieves statistics for one or more data streams. + /// + /// Get data stream stats. + /// Retrieves statistics for one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DataStreamsStatsAsync(CancellationToken cancellationToken = default) @@ -577,7 +710,10 @@ public virtual Task DataStreamsStatsAsync(Cancellation } /// - /// Get data stream stats.
Retrieves statistics for one or more data streams. + /// + /// Get data stream stats. + /// Retrieves statistics for one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DataStreamsStatsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -589,7 +725,10 @@ public virtual Task DataStreamsStatsAsync(Action - /// Delete indices.
Deletes one or more indices. + /// + /// Delete indices. + /// Deletes one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteIndexRequest request, CancellationToken cancellationToken = default) @@ -599,7 +738,10 @@ public virtual Task DeleteAsync(DeleteIndexRequest request, } /// - /// Delete indices.
Deletes one or more indices. + /// + /// Delete indices. + /// Deletes one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -609,7 +751,10 @@ public virtual Task DeleteAsync(DeleteIndexReque } /// - /// Delete indices.
Deletes one or more indices. + /// + /// Delete indices. + /// Deletes one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, CancellationToken cancellationToken = default) @@ -620,7 +765,10 @@ public virtual Task DeleteAsync(Elastic.Clients. } /// - /// Delete indices.
Deletes one or more indices. + /// + /// Delete indices. + /// Deletes one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -632,7 +780,10 @@ public virtual Task DeleteAsync(Elastic.Clients. } /// - /// Delete indices.
Deletes one or more indices. + /// + /// Delete indices. + /// Deletes one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(CancellationToken cancellationToken = default) @@ -643,7 +794,10 @@ public virtual Task DeleteAsync(CancellationToke } /// - /// Delete indices.
Deletes one or more indices. + /// + /// Delete indices. + /// Deletes one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -655,7 +809,10 @@ public virtual Task DeleteAsync(Action - /// Delete indices.
Deletes one or more indices. + /// + /// Delete indices. + /// Deletes one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -665,7 +822,10 @@ public virtual Task DeleteAsync(DeleteIndexRequestDescripto } /// - /// Delete indices.
Deletes one or more indices. + /// + /// Delete indices. + /// Deletes one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, CancellationToken cancellationToken = default) @@ -676,7 +836,10 @@ public virtual Task DeleteAsync(Elastic.Clients.Elasticsear } /// - /// Delete indices.
Deletes one or more indices. + /// + /// Delete indices. + /// Deletes one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -688,7 +851,10 @@ public virtual Task DeleteAsync(Elastic.Clients.Elasticsear } /// - /// Delete an alias.
Removes a data stream or index from an alias. + /// + /// Delete an alias. + /// Removes a data stream or index from an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAliasAsync(DeleteAliasRequest request, CancellationToken cancellationToken = default) @@ -698,7 +864,10 @@ public virtual Task DeleteAliasAsync(DeleteAliasRequest req } /// - /// Delete an alias.
Removes a data stream or index from an alias. + /// + /// Delete an alias. + /// Removes a data stream or index from an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAliasAsync(DeleteAliasRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -708,7 +877,10 @@ public virtual Task DeleteAliasAsync(DeleteAlias } /// - /// Delete an alias.
Removes a data stream or index from an alias. + /// + /// Delete an alias. + /// Removes a data stream or index from an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAliasAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Elastic.Clients.Elasticsearch.Serverless.Names name, CancellationToken cancellationToken = default) @@ -719,7 +891,10 @@ public virtual Task DeleteAliasAsync(Elastic.Cli } /// - /// Delete an alias.
Removes a data stream or index from an alias. + /// + /// Delete an alias. + /// Removes a data stream or index from an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAliasAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Elastic.Clients.Elasticsearch.Serverless.Names name, Action> configureRequest, CancellationToken cancellationToken = default) @@ -731,7 +906,10 @@ public virtual Task DeleteAliasAsync(Elastic.Cli } /// - /// Delete an alias.
Removes a data stream or index from an alias. + /// + /// Delete an alias. + /// Removes a data stream or index from an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAliasAsync(Elastic.Clients.Elasticsearch.Serverless.Names name, CancellationToken cancellationToken = default) @@ -742,7 +920,10 @@ public virtual Task DeleteAliasAsync(Elastic.Cli } /// - /// Delete an alias.
Removes a data stream or index from an alias. + /// + /// Delete an alias. + /// Removes a data stream or index from an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAliasAsync(Elastic.Clients.Elasticsearch.Serverless.Names name, Action> configureRequest, CancellationToken cancellationToken = default) @@ -754,7 +935,10 @@ public virtual Task DeleteAliasAsync(Elastic.Cli } /// - /// Delete an alias.
Removes a data stream or index from an alias. + /// + /// Delete an alias. + /// Removes a data stream or index from an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAliasAsync(DeleteAliasRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -764,7 +948,10 @@ public virtual Task DeleteAliasAsync(DeleteAliasRequestDesc } /// - /// Delete an alias.
Removes a data stream or index from an alias. + /// + /// Delete an alias. + /// Removes a data stream or index from an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAliasAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Elastic.Clients.Elasticsearch.Serverless.Names name, CancellationToken cancellationToken = default) @@ -775,7 +962,10 @@ public virtual Task DeleteAliasAsync(Elastic.Clients.Elasti } /// - /// Delete an alias.
Removes a data stream or index from an alias. + /// + /// Delete an alias. + /// Removes a data stream or index from an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAliasAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Elastic.Clients.Elasticsearch.Serverless.Names name, Action configureRequest, CancellationToken cancellationToken = default) @@ -787,7 +977,10 @@ public virtual Task DeleteAliasAsync(Elastic.Clients.Elasti } /// - /// Delete data stream lifecycles.
Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. + /// + /// Delete data stream lifecycles. + /// Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataLifecycleAsync(DeleteDataLifecycleRequest request, CancellationToken cancellationToken = default) @@ -797,7 +990,10 @@ public virtual Task DeleteDataLifecycleAsync(Delete } /// - /// Delete data stream lifecycles.
Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. + /// + /// Delete data stream lifecycles. + /// Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataLifecycleAsync(DeleteDataLifecycleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -807,7 +1003,10 @@ public virtual Task DeleteDataLifecycleAsync(Delete } /// - /// Delete data stream lifecycles.
Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. + /// + /// Delete data stream lifecycles. + /// Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataLifecycleAsync(Elastic.Clients.Elasticsearch.Serverless.DataStreamNames name, CancellationToken cancellationToken = default) @@ -818,7 +1017,10 @@ public virtual Task DeleteDataLifecycleAsync(Elasti } /// - /// Delete data stream lifecycles.
Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. + /// + /// Delete data stream lifecycles. + /// Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataLifecycleAsync(Elastic.Clients.Elasticsearch.Serverless.DataStreamNames name, Action configureRequest, CancellationToken cancellationToken = default) @@ -830,7 +1032,10 @@ public virtual Task DeleteDataLifecycleAsync(Elasti } /// - /// Delete data streams.
Deletes one or more data streams and their backing indices. + /// + /// Delete data streams. + /// Deletes one or more data streams and their backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataStreamAsync(DeleteDataStreamRequest request, CancellationToken cancellationToken = default) @@ -840,7 +1045,10 @@ public virtual Task DeleteDataStreamAsync(DeleteDataSt } /// - /// Delete data streams.
Deletes one or more data streams and their backing indices. + /// + /// Delete data streams. + /// Deletes one or more data streams and their backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataStreamAsync(DeleteDataStreamRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -850,7 +1058,10 @@ public virtual Task DeleteDataStreamAsync(DeleteDataSt } /// - /// Delete data streams.
Deletes one or more data streams and their backing indices. + /// + /// Delete data streams. + /// Deletes one or more data streams and their backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataStreamAsync(Elastic.Clients.Elasticsearch.Serverless.DataStreamNames name, CancellationToken cancellationToken = default) @@ -861,7 +1072,10 @@ public virtual Task DeleteDataStreamAsync(Elastic.Clie } /// - /// Delete data streams.
Deletes one or more data streams and their backing indices. + /// + /// Delete data streams. + /// Deletes one or more data streams and their backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataStreamAsync(Elastic.Clients.Elasticsearch.Serverless.DataStreamNames name, Action configureRequest, CancellationToken cancellationToken = default) @@ -873,7 +1087,12 @@ public virtual Task DeleteDataStreamAsync(Elastic.Clie } /// - /// Delete an index template.
The provided may contain multiple template names separated by a comma. If multiple template
names are specified then there is no wildcard support and the provided names should match completely with
existing templates. + /// + /// Delete an index template. + /// The provided <index-template> may contain multiple template names separated by a comma. If multiple template + /// names are specified then there is no wildcard support and the provided names should match completely with + /// existing templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteIndexTemplateAsync(DeleteIndexTemplateRequest request, CancellationToken cancellationToken = default) @@ -883,7 +1102,12 @@ public virtual Task DeleteIndexTemplateAsync(Delete } /// - /// Delete an index template.
The provided may contain multiple template names separated by a comma. If multiple template
names are specified then there is no wildcard support and the provided names should match completely with
existing templates. + /// + /// Delete an index template. + /// The provided <index-template> may contain multiple template names separated by a comma. If multiple template + /// names are specified then there is no wildcard support and the provided names should match completely with + /// existing templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteIndexTemplateAsync(DeleteIndexTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -893,7 +1117,12 @@ public virtual Task DeleteIndexTemplateAsync(Delete } /// - /// Delete an index template.
The provided may contain multiple template names separated by a comma. If multiple template
names are specified then there is no wildcard support and the provided names should match completely with
existing templates. + /// + /// Delete an index template. + /// The provided <index-template> may contain multiple template names separated by a comma. If multiple template + /// names are specified then there is no wildcard support and the provided names should match completely with + /// existing templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteIndexTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Names name, CancellationToken cancellationToken = default) @@ -904,7 +1133,12 @@ public virtual Task DeleteIndexTemplateAsync(Elasti } /// - /// Delete an index template.
The provided may contain multiple template names separated by a comma. If multiple template
names are specified then there is no wildcard support and the provided names should match completely with
existing templates. + /// + /// Delete an index template. + /// The provided <index-template> may contain multiple template names separated by a comma. If multiple template + /// names are specified then there is no wildcard support and the provided names should match completely with + /// existing templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteIndexTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Names name, Action configureRequest, CancellationToken cancellationToken = default) @@ -916,7 +1150,10 @@ public virtual Task DeleteIndexTemplateAsync(Elasti } /// - /// Check indices.
Checks if one or more indices, index aliases, or data streams exist. + /// + /// Check indices. + /// Checks if one or more indices, index aliases, or data streams exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(ExistsRequest request, CancellationToken cancellationToken = default) @@ -926,7 +1163,10 @@ public virtual Task ExistsAsync(ExistsRequest request, Cancellat } /// - /// Check indices.
Checks if one or more indices, index aliases, or data streams exist. + /// + /// Check indices. + /// Checks if one or more indices, index aliases, or data streams exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(ExistsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -936,7 +1176,10 @@ public virtual Task ExistsAsync(ExistsRequestDescript } /// - /// Check indices.
Checks if one or more indices, index aliases, or data streams exist. + /// + /// Check indices. + /// Checks if one or more indices, index aliases, or data streams exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, CancellationToken cancellationToken = default) @@ -947,7 +1190,10 @@ public virtual Task ExistsAsync(Elastic.Clients.Elast } /// - /// Check indices.
Checks if one or more indices, index aliases, or data streams exist. + /// + /// Check indices. + /// Checks if one or more indices, index aliases, or data streams exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -959,7 +1205,10 @@ public virtual Task ExistsAsync(Elastic.Clients.Elast } /// - /// Check indices.
Checks if one or more indices, index aliases, or data streams exist. + /// + /// Check indices. + /// Checks if one or more indices, index aliases, or data streams exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(CancellationToken cancellationToken = default) @@ -970,7 +1219,10 @@ public virtual Task ExistsAsync(CancellationToken can } /// - /// Check indices.
Checks if one or more indices, index aliases, or data streams exist. + /// + /// Check indices. + /// Checks if one or more indices, index aliases, or data streams exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -982,7 +1234,10 @@ public virtual Task ExistsAsync(Action - /// Check indices.
Checks if one or more indices, index aliases, or data streams exist. + /// + /// Check indices. + /// Checks if one or more indices, index aliases, or data streams exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(ExistsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -992,7 +1247,10 @@ public virtual Task ExistsAsync(ExistsRequestDescriptor descript } /// - /// Check indices.
Checks if one or more indices, index aliases, or data streams exist. + /// + /// Check indices. + /// Checks if one or more indices, index aliases, or data streams exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, CancellationToken cancellationToken = default) @@ -1003,7 +1261,10 @@ public virtual Task ExistsAsync(Elastic.Clients.Elasticsearch.Se } /// - /// Check indices.
Checks if one or more indices, index aliases, or data streams exist. + /// + /// Check indices. + /// Checks if one or more indices, index aliases, or data streams exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -1015,7 +1276,10 @@ public virtual Task ExistsAsync(Elastic.Clients.Elasticsearch.Se } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAliasAsync(ExistsAliasRequest request, CancellationToken cancellationToken = default) @@ -1025,7 +1289,10 @@ public virtual Task ExistsAliasAsync(ExistsAliasRequest req } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAliasAsync(ExistsAliasRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1035,7 +1302,10 @@ public virtual Task ExistsAliasAsync(ExistsAlias } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAliasAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Elastic.Clients.Elasticsearch.Serverless.Names name, CancellationToken cancellationToken = default) @@ -1046,7 +1316,10 @@ public virtual Task ExistsAliasAsync(Elastic.Cli } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAliasAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Elastic.Clients.Elasticsearch.Serverless.Names name, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1058,7 +1331,10 @@ public virtual Task ExistsAliasAsync(Elastic.Cli } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAliasAsync(Elastic.Clients.Elasticsearch.Serverless.Names name, CancellationToken cancellationToken = default) @@ -1069,7 +1345,10 @@ public virtual Task ExistsAliasAsync(Elastic.Cli } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAliasAsync(Elastic.Clients.Elasticsearch.Serverless.Names name, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1081,7 +1360,10 @@ public virtual Task ExistsAliasAsync(Elastic.Cli } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAliasAsync(ExistsAliasRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1091,7 +1373,10 @@ public virtual Task ExistsAliasAsync(ExistsAliasRequestDesc } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAliasAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Elastic.Clients.Elasticsearch.Serverless.Names name, CancellationToken cancellationToken = default) @@ -1102,7 +1387,10 @@ public virtual Task ExistsAliasAsync(Elastic.Clients.Elasti } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAliasAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Elastic.Clients.Elasticsearch.Serverless.Names name, Action configureRequest, CancellationToken cancellationToken = default) @@ -1114,7 +1402,10 @@ public virtual Task ExistsAliasAsync(Elastic.Clients.Elasti } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAliasAsync(Elastic.Clients.Elasticsearch.Serverless.Names name, CancellationToken cancellationToken = default) @@ -1125,7 +1416,10 @@ public virtual Task ExistsAliasAsync(Elastic.Clients.Elasti } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAliasAsync(Elastic.Clients.Elasticsearch.Serverless.Names name, Action configureRequest, CancellationToken cancellationToken = default) @@ -1137,7 +1431,9 @@ public virtual Task ExistsAliasAsync(Elastic.Clients.Elasti } /// - /// Returns information about whether a particular index template exists. + /// + /// Returns information about whether a particular index template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsIndexTemplateAsync(ExistsIndexTemplateRequest request, CancellationToken cancellationToken = default) @@ -1147,7 +1443,9 @@ public virtual Task ExistsIndexTemplateAsync(Exists } /// - /// Returns information about whether a particular index template exists. + /// + /// Returns information about whether a particular index template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsIndexTemplateAsync(ExistsIndexTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1157,7 +1455,9 @@ public virtual Task ExistsIndexTemplateAsync(Exists } /// - /// Returns information about whether a particular index template exists. + /// + /// Returns information about whether a particular index template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsIndexTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, CancellationToken cancellationToken = default) @@ -1168,7 +1468,9 @@ public virtual Task ExistsIndexTemplateAsync(Elasti } /// - /// Returns information about whether a particular index template exists. + /// + /// Returns information about whether a particular index template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsIndexTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -1180,7 +1482,10 @@ public virtual Task ExistsIndexTemplateAsync(Elasti } /// - /// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// + /// Get the status for a data stream lifecycle. + /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataLifecycleAsync(ExplainDataLifecycleRequest request, CancellationToken cancellationToken = default) @@ -1190,7 +1495,10 @@ public virtual Task ExplainDataLifecycleAsync(Expl } /// - /// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// + /// Get the status for a data stream lifecycle. + /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataLifecycleAsync(ExplainDataLifecycleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1200,7 +1508,10 @@ public virtual Task ExplainDataLifecycleAsync - /// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// + /// Get the status for a data stream lifecycle. + /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataLifecycleAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, CancellationToken cancellationToken = default) @@ -1211,7 +1522,10 @@ public virtual Task ExplainDataLifecycleAsync - /// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// + /// Get the status for a data stream lifecycle. + /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataLifecycleAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1223,7 +1537,10 @@ public virtual Task ExplainDataLifecycleAsync - /// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// + /// Get the status for a data stream lifecycle. + /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataLifecycleAsync(CancellationToken cancellationToken = default) @@ -1234,7 +1551,10 @@ public virtual Task ExplainDataLifecycleAsync - /// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// + /// Get the status for a data stream lifecycle. + /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataLifecycleAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -1246,7 +1566,10 @@ public virtual Task ExplainDataLifecycleAsync - /// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// + /// Get the status for a data stream lifecycle. + /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataLifecycleAsync(ExplainDataLifecycleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1256,7 +1579,10 @@ public virtual Task ExplainDataLifecycleAsync(Expl } /// - /// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// + /// Get the status for a data stream lifecycle. + /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataLifecycleAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, CancellationToken cancellationToken = default) @@ -1267,7 +1593,10 @@ public virtual Task ExplainDataLifecycleAsync(Elas } /// - /// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// + /// Get the status for a data stream lifecycle. + /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataLifecycleAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -1279,7 +1608,9 @@ public virtual Task ExplainDataLifecycleAsync(Elas } /// - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(FlushRequest request, CancellationToken cancellationToken = default) @@ -1289,7 +1620,9 @@ public virtual Task FlushAsync(FlushRequest request, Cancellation } /// - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(FlushRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1299,7 +1632,9 @@ public virtual Task FlushAsync(FlushRequestDescriptor< } /// - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -1310,7 +1645,9 @@ public virtual Task FlushAsync(Elastic.Clients.Elastic } /// - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1322,7 +1659,9 @@ public virtual Task FlushAsync(Elastic.Clients.Elastic } /// - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(CancellationToken cancellationToken = default) @@ -1333,7 +1672,9 @@ public virtual Task FlushAsync(CancellationToken cance } /// - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -1345,7 +1686,9 @@ public virtual Task FlushAsync(Action - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(FlushRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1355,7 +1698,9 @@ public virtual Task FlushAsync(FlushRequestDescriptor descriptor, } /// - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -1366,7 +1711,9 @@ public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Serv } /// - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -1378,7 +1725,9 @@ public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Serv } /// - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(CancellationToken cancellationToken = default) @@ -1389,7 +1738,9 @@ public virtual Task FlushAsync(CancellationToken cancellationToke } /// - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -1401,7 +1752,9 @@ public virtual Task FlushAsync(Action con } /// - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForcemergeAsync(ForcemergeRequest request, CancellationToken cancellationToken = default) @@ -1411,7 +1764,9 @@ public virtual Task ForcemergeAsync(ForcemergeRequest reques } /// - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForcemergeAsync(ForcemergeRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1421,7 +1776,9 @@ public virtual Task ForcemergeAsync(ForcemergeReq } /// - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForcemergeAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -1432,7 +1789,9 @@ public virtual Task ForcemergeAsync(Elastic.Clien } /// - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForcemergeAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1444,7 +1803,9 @@ public virtual Task ForcemergeAsync(Elastic.Clien } /// - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForcemergeAsync(CancellationToken cancellationToken = default) @@ -1455,7 +1816,9 @@ public virtual Task ForcemergeAsync(CancellationT } /// - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForcemergeAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -1467,7 +1830,9 @@ public virtual Task ForcemergeAsync(Action - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForcemergeAsync(ForcemergeRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1477,7 +1842,9 @@ public virtual Task ForcemergeAsync(ForcemergeRequestDescrip } /// - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForcemergeAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -1488,7 +1855,9 @@ public virtual Task ForcemergeAsync(Elastic.Clients.Elastics } /// - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForcemergeAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -1500,7 +1869,9 @@ public virtual Task ForcemergeAsync(Elastic.Clients.Elastics } /// - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForcemergeAsync(CancellationToken cancellationToken = default) @@ -1511,7 +1882,9 @@ public virtual Task ForcemergeAsync(CancellationToken cancel } /// - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForcemergeAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -1523,7 +1896,11 @@ public virtual Task ForcemergeAsync(Action - /// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. + /// + /// Get index information. + /// Returns information about one or more indices. For data streams, the API returns information about the + /// stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(GetIndexRequest request, CancellationToken cancellationToken = default) @@ -1533,7 +1910,11 @@ public virtual Task GetAsync(GetIndexRequest request, Cancella } /// - /// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. + /// + /// Get index information. + /// Returns information about one or more indices. For data streams, the API returns information about the + /// stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(GetIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1543,7 +1924,11 @@ public virtual Task GetAsync(GetIndexRequestDescrip } /// - /// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. + /// + /// Get index information. + /// Returns information about one or more indices. For data streams, the API returns information about the + /// stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, CancellationToken cancellationToken = default) @@ -1554,7 +1939,11 @@ public virtual Task GetAsync(Elastic.Clients.Elasti } /// - /// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. + /// + /// Get index information. + /// Returns information about one or more indices. For data streams, the API returns information about the + /// stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1566,7 +1955,11 @@ public virtual Task GetAsync(Elastic.Clients.Elasti } /// - /// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. + /// + /// Get index information. + /// Returns information about one or more indices. For data streams, the API returns information about the + /// stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(CancellationToken cancellationToken = default) @@ -1577,7 +1970,11 @@ public virtual Task GetAsync(CancellationToken canc } /// - /// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. + /// + /// Get index information. + /// Returns information about one or more indices. For data streams, the API returns information about the + /// stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -1589,7 +1986,11 @@ public virtual Task GetAsync(Action - /// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. + /// + /// Get index information. + /// Returns information about one or more indices. For data streams, the API returns information about the + /// stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(GetIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1599,7 +2000,11 @@ public virtual Task GetAsync(GetIndexRequestDescriptor descrip } /// - /// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. + /// + /// Get index information. + /// Returns information about one or more indices. For data streams, the API returns information about the + /// stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, CancellationToken cancellationToken = default) @@ -1610,7 +2015,11 @@ public virtual Task GetAsync(Elastic.Clients.Elasticsearch.Ser } /// - /// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. + /// + /// Get index information. + /// Returns information about one or more indices. For data streams, the API returns information about the + /// stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -1622,7 +2031,10 @@ public virtual Task GetAsync(Elastic.Clients.Elasticsearch.Ser } /// - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAliasAsync(GetAliasRequest request, CancellationToken cancellationToken = default) @@ -1632,7 +2044,10 @@ public virtual Task GetAliasAsync(GetAliasRequest request, Can } /// - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAliasAsync(GetAliasRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1642,7 +2057,10 @@ public virtual Task GetAliasAsync(GetAliasRequestDe } /// - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAliasAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Elastic.Clients.Elasticsearch.Serverless.Names? name, CancellationToken cancellationToken = default) @@ -1653,7 +2071,10 @@ public virtual Task GetAliasAsync(Elastic.Clients.E } /// - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAliasAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Elastic.Clients.Elasticsearch.Serverless.Names? name, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1665,7 +2086,10 @@ public virtual Task GetAliasAsync(Elastic.Clients.E } /// - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAliasAsync(CancellationToken cancellationToken = default) @@ -1676,7 +2100,10 @@ public virtual Task GetAliasAsync(CancellationToken } /// - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAliasAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -1688,7 +2115,10 @@ public virtual Task GetAliasAsync(Action - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAliasAsync(GetAliasRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1698,7 +2128,10 @@ public virtual Task GetAliasAsync(GetAliasRequestDescriptor de } /// - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAliasAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Elastic.Clients.Elasticsearch.Serverless.Names? name, CancellationToken cancellationToken = default) @@ -1709,7 +2142,10 @@ public virtual Task GetAliasAsync(Elastic.Clients.Elasticsearc } /// - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAliasAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Elastic.Clients.Elasticsearch.Serverless.Names? name, Action configureRequest, CancellationToken cancellationToken = default) @@ -1721,7 +2157,10 @@ public virtual Task GetAliasAsync(Elastic.Clients.Elasticsearc } /// - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAliasAsync(CancellationToken cancellationToken = default) @@ -1732,7 +2171,10 @@ public virtual Task GetAliasAsync(CancellationToken cancellati } /// - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAliasAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -1744,7 +2186,10 @@ public virtual Task GetAliasAsync(Action - /// Get data stream lifecycles.
Retrieves the data stream lifecycle configuration of one or more data streams. + /// + /// Get data stream lifecycles. + /// Retrieves the data stream lifecycle configuration of one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataLifecycleAsync(GetDataLifecycleRequest request, CancellationToken cancellationToken = default) @@ -1754,7 +2199,10 @@ public virtual Task GetDataLifecycleAsync(GetDataLifec } /// - /// Get data stream lifecycles.
Retrieves the data stream lifecycle configuration of one or more data streams. + /// + /// Get data stream lifecycles. + /// Retrieves the data stream lifecycle configuration of one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataLifecycleAsync(GetDataLifecycleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1764,7 +2212,10 @@ public virtual Task GetDataLifecycleAsync(GetDataLifec } /// - /// Get data stream lifecycles.
Retrieves the data stream lifecycle configuration of one or more data streams. + /// + /// Get data stream lifecycles. + /// Retrieves the data stream lifecycle configuration of one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataLifecycleAsync(Elastic.Clients.Elasticsearch.Serverless.DataStreamNames name, CancellationToken cancellationToken = default) @@ -1775,7 +2226,10 @@ public virtual Task GetDataLifecycleAsync(Elastic.Clie } /// - /// Get data stream lifecycles.
Retrieves the data stream lifecycle configuration of one or more data streams. + /// + /// Get data stream lifecycles. + /// Retrieves the data stream lifecycle configuration of one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataLifecycleAsync(Elastic.Clients.Elasticsearch.Serverless.DataStreamNames name, Action configureRequest, CancellationToken cancellationToken = default) @@ -1787,7 +2241,10 @@ public virtual Task GetDataLifecycleAsync(Elastic.Clie } /// - /// Get data streams.
Retrieves information about one or more data streams. + /// + /// Get data streams. + /// Retrieves information about one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataStreamAsync(GetDataStreamRequest request, CancellationToken cancellationToken = default) @@ -1797,7 +2254,10 @@ public virtual Task GetDataStreamAsync(GetDataStreamReque } /// - /// Get data streams.
Retrieves information about one or more data streams. + /// + /// Get data streams. + /// Retrieves information about one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataStreamAsync(GetDataStreamRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1807,7 +2267,10 @@ public virtual Task GetDataStreamAsync(GetDataStreamReque } /// - /// Get data streams.
Retrieves information about one or more data streams. + /// + /// Get data streams. + /// Retrieves information about one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataStreamAsync(Elastic.Clients.Elasticsearch.Serverless.DataStreamNames? name, CancellationToken cancellationToken = default) @@ -1818,7 +2281,10 @@ public virtual Task GetDataStreamAsync(Elastic.Clients.El } /// - /// Get data streams.
Retrieves information about one or more data streams. + /// + /// Get data streams. + /// Retrieves information about one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataStreamAsync(Elastic.Clients.Elasticsearch.Serverless.DataStreamNames? name, Action configureRequest, CancellationToken cancellationToken = default) @@ -1830,7 +2296,10 @@ public virtual Task GetDataStreamAsync(Elastic.Clients.El } /// - /// Get data streams.
Retrieves information about one or more data streams. + /// + /// Get data streams. + /// Retrieves information about one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataStreamAsync(CancellationToken cancellationToken = default) @@ -1841,7 +2310,10 @@ public virtual Task GetDataStreamAsync(CancellationToken } /// - /// Get data streams.
Retrieves information about one or more data streams. + /// + /// Get data streams. + /// Retrieves information about one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataStreamAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -1853,7 +2325,10 @@ public virtual Task GetDataStreamAsync(Action - /// Get index templates.
Returns information about one or more index templates. + /// + /// Get index templates. + /// Returns information about one or more index templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetIndexTemplateAsync(GetIndexTemplateRequest request, CancellationToken cancellationToken = default) @@ -1863,7 +2338,10 @@ public virtual Task GetIndexTemplateAsync(GetIndexTemp } /// - /// Get index templates.
Returns information about one or more index templates. + /// + /// Get index templates. + /// Returns information about one or more index templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetIndexTemplateAsync(GetIndexTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1873,7 +2351,10 @@ public virtual Task GetIndexTemplateAsync(GetIndexTemp } /// - /// Get index templates.
Returns information about one or more index templates. + /// + /// Get index templates. + /// Returns information about one or more index templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetIndexTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Name? name, CancellationToken cancellationToken = default) @@ -1884,7 +2365,10 @@ public virtual Task GetIndexTemplateAsync(Elastic.Clie } /// - /// Get index templates.
Returns information about one or more index templates. + /// + /// Get index templates. + /// Returns information about one or more index templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetIndexTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Name? name, Action configureRequest, CancellationToken cancellationToken = default) @@ -1896,7 +2380,10 @@ public virtual Task GetIndexTemplateAsync(Elastic.Clie } /// - /// Get index templates.
Returns information about one or more index templates. + /// + /// Get index templates. + /// Returns information about one or more index templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetIndexTemplateAsync(CancellationToken cancellationToken = default) @@ -1907,7 +2394,10 @@ public virtual Task GetIndexTemplateAsync(Cancellation } /// - /// Get index templates.
Returns information about one or more index templates. + /// + /// Get index templates. + /// Returns information about one or more index templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetIndexTemplateAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -1919,7 +2409,11 @@ public virtual Task GetIndexTemplateAsync(Action - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMappingAsync(GetMappingRequest request, CancellationToken cancellationToken = default) @@ -1929,7 +2423,11 @@ public virtual Task GetMappingAsync(GetMappingRequest reques } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMappingAsync(GetMappingRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1939,7 +2437,11 @@ public virtual Task GetMappingAsync(GetMappingReq } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMappingAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -1950,7 +2452,11 @@ public virtual Task GetMappingAsync(Elastic.Clien } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMappingAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1962,7 +2468,11 @@ public virtual Task GetMappingAsync(Elastic.Clien } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMappingAsync(CancellationToken cancellationToken = default) @@ -1973,7 +2483,11 @@ public virtual Task GetMappingAsync(CancellationT } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMappingAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -1985,7 +2499,11 @@ public virtual Task GetMappingAsync(Action - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMappingAsync(GetMappingRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1995,7 +2513,11 @@ public virtual Task GetMappingAsync(GetMappingRequestDescrip } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMappingAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -2006,7 +2528,11 @@ public virtual Task GetMappingAsync(Elastic.Clients.Elastics } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMappingAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -2018,7 +2544,11 @@ public virtual Task GetMappingAsync(Elastic.Clients.Elastics } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMappingAsync(CancellationToken cancellationToken = default) @@ -2029,7 +2559,11 @@ public virtual Task GetMappingAsync(CancellationToken cancel } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMappingAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -2041,7 +2575,11 @@ public virtual Task GetMappingAsync(Action - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(GetIndicesSettingsRequest request, CancellationToken cancellationToken = default) @@ -2051,7 +2589,11 @@ public virtual Task GetSettingsAsync(GetIndicesSetti } /// - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(GetIndicesSettingsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2061,7 +2603,11 @@ public virtual Task GetSettingsAsync(GetI } /// - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Elastic.Clients.Elasticsearch.Serverless.Names? name, CancellationToken cancellationToken = default) @@ -2072,7 +2618,11 @@ public virtual Task GetSettingsAsync(Elas } /// - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Elastic.Clients.Elasticsearch.Serverless.Names? name, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2084,7 +2634,11 @@ public virtual Task GetSettingsAsync(Elas } /// - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(CancellationToken cancellationToken = default) @@ -2095,7 +2649,11 @@ public virtual Task GetSettingsAsync(Canc } /// - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -2107,7 +2665,11 @@ public virtual Task GetSettingsAsync(Acti } /// - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(GetIndicesSettingsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2117,7 +2679,11 @@ public virtual Task GetSettingsAsync(GetIndicesSetti } /// - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Elastic.Clients.Elasticsearch.Serverless.Names? name, CancellationToken cancellationToken = default) @@ -2128,7 +2694,11 @@ public virtual Task GetSettingsAsync(Elastic.Clients } /// - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Elastic.Clients.Elasticsearch.Serverless.Names? name, Action configureRequest, CancellationToken cancellationToken = default) @@ -2140,7 +2710,11 @@ public virtual Task GetSettingsAsync(Elastic.Clients } /// - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(CancellationToken cancellationToken = default) @@ -2151,7 +2725,11 @@ public virtual Task GetSettingsAsync(CancellationTok } /// - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -2163,7 +2741,19 @@ public virtual Task GetSettingsAsync(Action - /// Convert an index alias to a data stream.
Converts an index alias to a data stream.
You must have a matching index template that is data stream enabled.
The alias must meet the following criteria:
The alias must have a write index;
All indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;
The alias must not have any filters;
The alias must not use custom routing.
If successful, the request removes the alias and creates a data stream with the same name.
The indices for the alias become hidden backing indices for the stream.
The write index for the alias becomes the write index for the stream. + /// + /// Convert an index alias to a data stream. + /// Converts an index alias to a data stream. + /// You must have a matching index template that is data stream enabled. + /// The alias must meet the following criteria: + /// The alias must have a write index; + /// All indices for the alias must have a @timestamp field mapping of a date or date_nanos field type; + /// The alias must not have any filters; + /// The alias must not use custom routing. + /// If successful, the request removes the alias and creates a data stream with the same name. + /// The indices for the alias become hidden backing indices for the stream. + /// The write index for the alias becomes the write index for the stream. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MigrateToDataStreamAsync(MigrateToDataStreamRequest request, CancellationToken cancellationToken = default) @@ -2173,7 +2763,19 @@ public virtual Task MigrateToDataStreamAsync(Migrat } /// - /// Convert an index alias to a data stream.
Converts an index alias to a data stream.
You must have a matching index template that is data stream enabled.
The alias must meet the following criteria:
The alias must have a write index;
All indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;
The alias must not have any filters;
The alias must not use custom routing.
If successful, the request removes the alias and creates a data stream with the same name.
The indices for the alias become hidden backing indices for the stream.
The write index for the alias becomes the write index for the stream. + /// + /// Convert an index alias to a data stream. + /// Converts an index alias to a data stream. + /// You must have a matching index template that is data stream enabled. + /// The alias must meet the following criteria: + /// The alias must have a write index; + /// All indices for the alias must have a @timestamp field mapping of a date or date_nanos field type; + /// The alias must not have any filters; + /// The alias must not use custom routing. + /// If successful, the request removes the alias and creates a data stream with the same name. + /// The indices for the alias become hidden backing indices for the stream. + /// The write index for the alias becomes the write index for the stream. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MigrateToDataStreamAsync(MigrateToDataStreamRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2183,7 +2785,19 @@ public virtual Task MigrateToDataStreamAsync(Migrat } /// - /// Convert an index alias to a data stream.
Converts an index alias to a data stream.
You must have a matching index template that is data stream enabled.
The alias must meet the following criteria:
The alias must have a write index;
All indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;
The alias must not have any filters;
The alias must not use custom routing.
If successful, the request removes the alias and creates a data stream with the same name.
The indices for the alias become hidden backing indices for the stream.
The write index for the alias becomes the write index for the stream. + /// + /// Convert an index alias to a data stream. + /// Converts an index alias to a data stream. + /// You must have a matching index template that is data stream enabled. + /// The alias must meet the following criteria: + /// The alias must have a write index; + /// All indices for the alias must have a @timestamp field mapping of a date or date_nanos field type; + /// The alias must not have any filters; + /// The alias must not use custom routing. + /// If successful, the request removes the alias and creates a data stream with the same name. + /// The indices for the alias become hidden backing indices for the stream. + /// The write index for the alias becomes the write index for the stream. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MigrateToDataStreamAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName name, CancellationToken cancellationToken = default) @@ -2194,7 +2808,19 @@ public virtual Task MigrateToDataStreamAsync(Elasti } /// - /// Convert an index alias to a data stream.
Converts an index alias to a data stream.
You must have a matching index template that is data stream enabled.
The alias must meet the following criteria:
The alias must have a write index;
All indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;
The alias must not have any filters;
The alias must not use custom routing.
If successful, the request removes the alias and creates a data stream with the same name.
The indices for the alias become hidden backing indices for the stream.
The write index for the alias becomes the write index for the stream. + /// + /// Convert an index alias to a data stream. + /// Converts an index alias to a data stream. + /// You must have a matching index template that is data stream enabled. + /// The alias must meet the following criteria: + /// The alias must have a write index; + /// All indices for the alias must have a @timestamp field mapping of a date or date_nanos field type; + /// The alias must not have any filters; + /// The alias must not use custom routing. + /// If successful, the request removes the alias and creates a data stream with the same name. + /// The indices for the alias become hidden backing indices for the stream. + /// The write index for the alias becomes the write index for the stream. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MigrateToDataStreamAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName name, Action configureRequest, CancellationToken cancellationToken = default) @@ -2206,7 +2832,10 @@ public virtual Task MigrateToDataStreamAsync(Elasti } /// - /// Update data streams.
Performs one or more data stream modification actions in a single atomic operation. + /// + /// Update data streams. + /// Performs one or more data stream modification actions in a single atomic operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ModifyDataStreamAsync(ModifyDataStreamRequest request, CancellationToken cancellationToken = default) @@ -2216,7 +2845,10 @@ public virtual Task ModifyDataStreamAsync(ModifyDataSt } /// - /// Update data streams.
Performs one or more data stream modification actions in a single atomic operation. + /// + /// Update data streams. + /// Performs one or more data stream modification actions in a single atomic operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ModifyDataStreamAsync(ModifyDataStreamRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2226,7 +2858,10 @@ public virtual Task ModifyDataStreamAsync(ModifyDataSt } /// - /// Update data streams.
Performs one or more data stream modification actions in a single atomic operation. + /// + /// Update data streams. + /// Performs one or more data stream modification actions in a single atomic operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ModifyDataStreamAsync(CancellationToken cancellationToken = default) @@ -2237,7 +2872,10 @@ public virtual Task ModifyDataStreamAsync(Cancellation } /// - /// Update data streams.
Performs one or more data stream modification actions in a single atomic operation. + /// + /// Update data streams. + /// Performs one or more data stream modification actions in a single atomic operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ModifyDataStreamAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -2249,7 +2887,10 @@ public virtual Task ModifyDataStreamAsync(Action - /// Opens a closed index.
For data streams, the API opens any closed backing indices. + /// + /// Opens a closed index. + /// For data streams, the API opens any closed backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenAsync(OpenIndexRequest request, CancellationToken cancellationToken = default) @@ -2259,7 +2900,10 @@ public virtual Task OpenAsync(OpenIndexRequest request, Cance } /// - /// Opens a closed index.
For data streams, the API opens any closed backing indices. + /// + /// Opens a closed index. + /// For data streams, the API opens any closed backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenAsync(OpenIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2269,7 +2913,10 @@ public virtual Task OpenAsync(OpenIndexRequestDesc } /// - /// Opens a closed index.
For data streams, the API opens any closed backing indices. + /// + /// Opens a closed index. + /// For data streams, the API opens any closed backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, CancellationToken cancellationToken = default) @@ -2280,7 +2927,10 @@ public virtual Task OpenAsync(Elastic.Clients.Elas } /// - /// Opens a closed index.
For data streams, the API opens any closed backing indices. + /// + /// Opens a closed index. + /// For data streams, the API opens any closed backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2292,7 +2942,10 @@ public virtual Task OpenAsync(Elastic.Clients.Elas } /// - /// Opens a closed index.
For data streams, the API opens any closed backing indices. + /// + /// Opens a closed index. + /// For data streams, the API opens any closed backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenAsync(CancellationToken cancellationToken = default) @@ -2303,7 +2956,10 @@ public virtual Task OpenAsync(CancellationToken ca } /// - /// Opens a closed index.
For data streams, the API opens any closed backing indices. + /// + /// Opens a closed index. + /// For data streams, the API opens any closed backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -2315,7 +2971,10 @@ public virtual Task OpenAsync(Action - /// Opens a closed index.
For data streams, the API opens any closed backing indices. + /// + /// Opens a closed index. + /// For data streams, the API opens any closed backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenAsync(OpenIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2325,7 +2984,10 @@ public virtual Task OpenAsync(OpenIndexRequestDescriptor desc } /// - /// Opens a closed index.
For data streams, the API opens any closed backing indices. + /// + /// Opens a closed index. + /// For data streams, the API opens any closed backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, CancellationToken cancellationToken = default) @@ -2336,7 +2998,10 @@ public virtual Task OpenAsync(Elastic.Clients.Elasticsearch.S } /// - /// Opens a closed index.
For data streams, the API opens any closed backing indices. + /// + /// Opens a closed index. + /// For data streams, the API opens any closed backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -2348,7 +3013,10 @@ public virtual Task OpenAsync(Elastic.Clients.Elasticsearch.S } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAliasAsync(PutAliasRequest request, CancellationToken cancellationToken = default) @@ -2358,7 +3026,10 @@ public virtual Task PutAliasAsync(PutAliasRequest request, Can } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAliasAsync(PutAliasRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2368,7 +3039,10 @@ public virtual Task PutAliasAsync(PutAliasRequestDe } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAliasAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Elastic.Clients.Elasticsearch.Serverless.Name name, CancellationToken cancellationToken = default) @@ -2379,7 +3053,10 @@ public virtual Task PutAliasAsync(Elastic.Clients.E } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAliasAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Elastic.Clients.Elasticsearch.Serverless.Name name, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2391,7 +3068,10 @@ public virtual Task PutAliasAsync(Elastic.Clients.E } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAliasAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, CancellationToken cancellationToken = default) @@ -2402,7 +3082,10 @@ public virtual Task PutAliasAsync(Elastic.Clients.E } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAliasAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2414,7 +3097,10 @@ public virtual Task PutAliasAsync(Elastic.Clients.E } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAliasAsync(PutAliasRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2424,7 +3110,10 @@ public virtual Task PutAliasAsync(PutAliasRequestDescriptor de } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAliasAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Elastic.Clients.Elasticsearch.Serverless.Name name, CancellationToken cancellationToken = default) @@ -2435,7 +3124,10 @@ public virtual Task PutAliasAsync(Elastic.Clients.Elasticsearc } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAliasAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Elastic.Clients.Elasticsearch.Serverless.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -2447,7 +3139,10 @@ public virtual Task PutAliasAsync(Elastic.Clients.Elasticsearc } /// - /// Update data stream lifecycles.
Update the data stream lifecycle of the specified data streams. + /// + /// Update data stream lifecycles. + /// Update the data stream lifecycle of the specified data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataLifecycleAsync(PutDataLifecycleRequest request, CancellationToken cancellationToken = default) @@ -2457,7 +3152,10 @@ public virtual Task PutDataLifecycleAsync(PutDataLifec } /// - /// Update data stream lifecycles.
Update the data stream lifecycle of the specified data streams. + /// + /// Update data stream lifecycles. + /// Update the data stream lifecycle of the specified data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataLifecycleAsync(PutDataLifecycleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2467,7 +3165,10 @@ public virtual Task PutDataLifecycleAsync(PutDataLifec } /// - /// Update data stream lifecycles.
Update the data stream lifecycle of the specified data streams. + /// + /// Update data stream lifecycles. + /// Update the data stream lifecycle of the specified data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataLifecycleAsync(Elastic.Clients.Elasticsearch.Serverless.DataStreamNames name, CancellationToken cancellationToken = default) @@ -2478,7 +3179,10 @@ public virtual Task PutDataLifecycleAsync(Elastic.Clie } /// - /// Update data stream lifecycles.
Update the data stream lifecycle of the specified data streams. + /// + /// Update data stream lifecycles. + /// Update the data stream lifecycle of the specified data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataLifecycleAsync(Elastic.Clients.Elasticsearch.Serverless.DataStreamNames name, Action configureRequest, CancellationToken cancellationToken = default) @@ -2490,7 +3194,10 @@ public virtual Task PutDataLifecycleAsync(Elastic.Clie } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutIndexTemplateAsync(PutIndexTemplateRequest request, CancellationToken cancellationToken = default) @@ -2500,7 +3207,10 @@ public virtual Task PutIndexTemplateAsync(PutIndexTemp } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutIndexTemplateAsync(PutIndexTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2510,7 +3220,10 @@ public virtual Task PutIndexTemplateAsync(P } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutIndexTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, CancellationToken cancellationToken = default) @@ -2521,7 +3234,10 @@ public virtual Task PutIndexTemplateAsync(E } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutIndexTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2533,7 +3249,10 @@ public virtual Task PutIndexTemplateAsync(E } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutIndexTemplateAsync(PutIndexTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2543,7 +3262,10 @@ public virtual Task PutIndexTemplateAsync(PutIndexTemp } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutIndexTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, CancellationToken cancellationToken = default) @@ -2554,7 +3276,10 @@ public virtual Task PutIndexTemplateAsync(Elastic.Clie } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutIndexTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -2566,7 +3291,12 @@ public virtual Task PutIndexTemplateAsync(Elastic.Clie } /// - /// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. + /// + /// Update field mappings. + /// Adds new fields to an existing data stream or index. + /// You can also use this API to change the search settings of existing fields. + /// For data streams, these changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutMappingAsync(PutMappingRequest request, CancellationToken cancellationToken = default) @@ -2576,7 +3306,12 @@ public virtual Task PutMappingAsync(PutMappingRequest reques } /// - /// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. + /// + /// Update field mappings. + /// Adds new fields to an existing data stream or index. + /// You can also use this API to change the search settings of existing fields. + /// For data streams, these changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutMappingAsync(PutMappingRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2586,7 +3321,12 @@ public virtual Task PutMappingAsync(PutMappingReq } /// - /// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. + /// + /// Update field mappings. + /// Adds new fields to an existing data stream or index. + /// You can also use this API to change the search settings of existing fields. + /// For data streams, these changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutMappingAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, CancellationToken cancellationToken = default) @@ -2597,7 +3337,12 @@ public virtual Task PutMappingAsync(Elastic.Clien } /// - /// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. + /// + /// Update field mappings. + /// Adds new fields to an existing data stream or index. + /// You can also use this API to change the search settings of existing fields. + /// For data streams, these changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutMappingAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2609,7 +3354,12 @@ public virtual Task PutMappingAsync(Elastic.Clien } /// - /// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. + /// + /// Update field mappings. + /// Adds new fields to an existing data stream or index. + /// You can also use this API to change the search settings of existing fields. + /// For data streams, these changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutMappingAsync(CancellationToken cancellationToken = default) @@ -2620,7 +3370,12 @@ public virtual Task PutMappingAsync(CancellationT } /// - /// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. + /// + /// Update field mappings. + /// Adds new fields to an existing data stream or index. + /// You can also use this API to change the search settings of existing fields. + /// For data streams, these changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutMappingAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -2632,7 +3387,12 @@ public virtual Task PutMappingAsync(Action - /// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. + /// + /// Update field mappings. + /// Adds new fields to an existing data stream or index. + /// You can also use this API to change the search settings of existing fields. + /// For data streams, these changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutMappingAsync(PutMappingRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2642,7 +3402,12 @@ public virtual Task PutMappingAsync(PutMappingRequestDescrip } /// - /// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. + /// + /// Update field mappings. + /// Adds new fields to an existing data stream or index. + /// You can also use this API to change the search settings of existing fields. + /// For data streams, these changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutMappingAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, CancellationToken cancellationToken = default) @@ -2653,7 +3418,12 @@ public virtual Task PutMappingAsync(Elastic.Clients.Elastics } /// - /// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. + /// + /// Update field mappings. + /// Adds new fields to an existing data stream or index. + /// You can also use this API to change the search settings of existing fields. + /// For data streams, these changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutMappingAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -2665,7 +3435,11 @@ public virtual Task PutMappingAsync(Elastic.Clients.Elastics } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSettingsAsync(PutIndicesSettingsRequest request, CancellationToken cancellationToken = default) @@ -2675,7 +3449,11 @@ public virtual Task PutSettingsAsync(PutIndicesSetti } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSettingsAsync(PutIndicesSettingsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2685,7 +3463,11 @@ public virtual Task PutSettingsAsync(PutI } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSettingsAsync(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexSettings settings, Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -2696,7 +3478,11 @@ public virtual Task PutSettingsAsync(Elas } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSettingsAsync(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexSettings settings, Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2708,7 +3494,11 @@ public virtual Task PutSettingsAsync(Elas } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSettingsAsync(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexSettings settings, CancellationToken cancellationToken = default) @@ -2719,7 +3509,11 @@ public virtual Task PutSettingsAsync(Elas } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSettingsAsync(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexSettings settings, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2731,7 +3525,11 @@ public virtual Task PutSettingsAsync(Elas } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSettingsAsync(PutIndicesSettingsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2741,7 +3539,11 @@ public virtual Task PutSettingsAsync(PutIndicesSetti } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSettingsAsync(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexSettings settings, Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -2752,7 +3554,11 @@ public virtual Task PutSettingsAsync(Elastic.Clients } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSettingsAsync(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexSettings settings, Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -2764,7 +3570,11 @@ public virtual Task PutSettingsAsync(Elastic.Clients } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSettingsAsync(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexSettings settings, CancellationToken cancellationToken = default) @@ -2775,7 +3585,11 @@ public virtual Task PutSettingsAsync(Elastic.Clients } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSettingsAsync(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexSettings settings, Action configureRequest, CancellationToken cancellationToken = default) @@ -2787,7 +3601,10 @@ public virtual Task PutSettingsAsync(Elastic.Clients } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTemplateAsync(PutTemplateRequest request, CancellationToken cancellationToken = default) @@ -2797,7 +3614,10 @@ public virtual Task PutTemplateAsync(PutTemplateRequest req } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTemplateAsync(PutTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2807,7 +3627,10 @@ public virtual Task PutTemplateAsync(PutTemplate } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, CancellationToken cancellationToken = default) @@ -2818,7 +3641,10 @@ public virtual Task PutTemplateAsync(Elastic.Cli } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2830,7 +3656,10 @@ public virtual Task PutTemplateAsync(Elastic.Cli } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTemplateAsync(PutTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2840,7 +3669,10 @@ public virtual Task PutTemplateAsync(PutTemplateRequestDesc } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, CancellationToken cancellationToken = default) @@ -2851,7 +3683,10 @@ public virtual Task PutTemplateAsync(Elastic.Clients.Elasti } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -2863,7 +3698,10 @@ public virtual Task PutTemplateAsync(Elastic.Clients.Elasti } /// - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RecoveryAsync(RecoveryRequest request, CancellationToken cancellationToken = default) @@ -2873,7 +3711,10 @@ public virtual Task RecoveryAsync(RecoveryRequest request, Can } /// - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RecoveryAsync(RecoveryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2883,7 +3724,10 @@ public virtual Task RecoveryAsync(RecoveryRequestDe } /// - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RecoveryAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -2894,7 +3738,10 @@ public virtual Task RecoveryAsync(Elastic.Clients.E } /// - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RecoveryAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2906,7 +3753,10 @@ public virtual Task RecoveryAsync(Elastic.Clients.E } /// - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RecoveryAsync(CancellationToken cancellationToken = default) @@ -2917,7 +3767,10 @@ public virtual Task RecoveryAsync(CancellationToken } /// - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RecoveryAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -2929,7 +3782,10 @@ public virtual Task RecoveryAsync(Action - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RecoveryAsync(RecoveryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2939,7 +3795,10 @@ public virtual Task RecoveryAsync(RecoveryRequestDescriptor de } /// - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RecoveryAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -2950,7 +3809,10 @@ public virtual Task RecoveryAsync(Elastic.Clients.Elasticsearc } /// - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RecoveryAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -2962,7 +3824,10 @@ public virtual Task RecoveryAsync(Elastic.Clients.Elasticsearc } /// - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RecoveryAsync(CancellationToken cancellationToken = default) @@ -2973,7 +3838,10 @@ public virtual Task RecoveryAsync(CancellationToken cancellati } /// - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RecoveryAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -2985,7 +3853,11 @@ public virtual Task RecoveryAsync(Action - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RefreshAsync(RefreshRequest request, CancellationToken cancellationToken = default) @@ -2995,7 +3867,11 @@ public virtual Task RefreshAsync(RefreshRequest request, Cancel } /// - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RefreshAsync(RefreshRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3005,7 +3881,11 @@ public virtual Task RefreshAsync(RefreshRequestDescr } /// - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RefreshAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -3016,7 +3896,11 @@ public virtual Task RefreshAsync(Elastic.Clients.Ela } /// - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RefreshAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3028,7 +3912,11 @@ public virtual Task RefreshAsync(Elastic.Clients.Ela } /// - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RefreshAsync(CancellationToken cancellationToken = default) @@ -3039,7 +3927,11 @@ public virtual Task RefreshAsync(CancellationToken c } /// - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RefreshAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -3051,7 +3943,11 @@ public virtual Task RefreshAsync(Action - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RefreshAsync(RefreshRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3061,7 +3957,11 @@ public virtual Task RefreshAsync(RefreshRequestDescriptor descr } /// - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RefreshAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -3072,7 +3972,11 @@ public virtual Task RefreshAsync(Elastic.Clients.Elasticsearch. } /// - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RefreshAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -3084,7 +3988,11 @@ public virtual Task RefreshAsync(Elastic.Clients.Elasticsearch. } /// - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RefreshAsync(CancellationToken cancellationToken = default) @@ -3095,7 +4003,11 @@ public virtual Task RefreshAsync(CancellationToken cancellation } /// - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RefreshAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -3107,7 +4019,10 @@ public virtual Task RefreshAsync(Action - /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams.
Multiple patterns and remote clusters are supported. + /// + /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. + /// Multiple patterns and remote clusters are supported. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResolveIndexAsync(ResolveIndexRequest request, CancellationToken cancellationToken = default) @@ -3117,7 +4032,10 @@ public virtual Task ResolveIndexAsync(ResolveIndexRequest } /// - /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams.
Multiple patterns and remote clusters are supported. + /// + /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. + /// Multiple patterns and remote clusters are supported. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResolveIndexAsync(ResolveIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3127,7 +4045,10 @@ public virtual Task ResolveIndexAsync(ResolveIndexRequestD } /// - /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams.
Multiple patterns and remote clusters are supported. + /// + /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. + /// Multiple patterns and remote clusters are supported. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResolveIndexAsync(Elastic.Clients.Elasticsearch.Serverless.Names name, CancellationToken cancellationToken = default) @@ -3138,7 +4059,10 @@ public virtual Task ResolveIndexAsync(Elastic.Clients.Elas } /// - /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams.
Multiple patterns and remote clusters are supported. + /// + /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. + /// Multiple patterns and remote clusters are supported. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResolveIndexAsync(Elastic.Clients.Elasticsearch.Serverless.Names name, Action configureRequest, CancellationToken cancellationToken = default) @@ -3150,7 +4074,10 @@ public virtual Task ResolveIndexAsync(Elastic.Clients.Elas } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(RolloverRequest request, CancellationToken cancellationToken = default) @@ -3160,7 +4087,10 @@ public virtual Task RolloverAsync(RolloverRequest request, Can } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(RolloverRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3170,7 +4100,10 @@ public virtual Task RolloverAsync(RolloverRequestDe } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.Serverless.IndexAlias alias, Elastic.Clients.Elasticsearch.Serverless.IndexName? newIndex, CancellationToken cancellationToken = default) @@ -3181,7 +4114,10 @@ public virtual Task RolloverAsync(Elastic.Clients.E } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.Serverless.IndexAlias alias, Elastic.Clients.Elasticsearch.Serverless.IndexName? newIndex, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3193,7 +4129,10 @@ public virtual Task RolloverAsync(Elastic.Clients.E } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.Serverless.IndexAlias alias, CancellationToken cancellationToken = default) @@ -3204,7 +4143,10 @@ public virtual Task RolloverAsync(Elastic.Clients.E } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.Serverless.IndexAlias alias, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3216,7 +4158,10 @@ public virtual Task RolloverAsync(Elastic.Clients.E } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(RolloverRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3226,7 +4171,10 @@ public virtual Task RolloverAsync(RolloverRequestDescriptor de } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.Serverless.IndexAlias alias, Elastic.Clients.Elasticsearch.Serverless.IndexName? newIndex, CancellationToken cancellationToken = default) @@ -3237,7 +4185,10 @@ public virtual Task RolloverAsync(Elastic.Clients.Elasticsearc } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.Serverless.IndexAlias alias, Elastic.Clients.Elasticsearch.Serverless.IndexName? newIndex, Action configureRequest, CancellationToken cancellationToken = default) @@ -3249,7 +4200,10 @@ public virtual Task RolloverAsync(Elastic.Clients.Elasticsearc } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.Serverless.IndexAlias alias, CancellationToken cancellationToken = default) @@ -3260,7 +4214,10 @@ public virtual Task RolloverAsync(Elastic.Clients.Elasticsearc } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.Serverless.IndexAlias alias, Action configureRequest, CancellationToken cancellationToken = default) @@ -3272,7 +4229,10 @@ public virtual Task RolloverAsync(Elastic.Clients.Elasticsearc } /// - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SegmentsAsync(SegmentsRequest request, CancellationToken cancellationToken = default) @@ -3282,7 +4242,10 @@ public virtual Task SegmentsAsync(SegmentsRequest request, Can } /// - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SegmentsAsync(SegmentsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3292,7 +4255,10 @@ public virtual Task SegmentsAsync(SegmentsRequestDe } /// - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SegmentsAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -3303,7 +4269,10 @@ public virtual Task SegmentsAsync(Elastic.Clients.E } /// - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SegmentsAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3315,7 +4284,10 @@ public virtual Task SegmentsAsync(Elastic.Clients.E } /// - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SegmentsAsync(CancellationToken cancellationToken = default) @@ -3326,7 +4298,10 @@ public virtual Task SegmentsAsync(CancellationToken } /// - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SegmentsAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -3338,7 +4313,10 @@ public virtual Task SegmentsAsync(Action - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SegmentsAsync(SegmentsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3348,7 +4326,10 @@ public virtual Task SegmentsAsync(SegmentsRequestDescriptor de } /// - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SegmentsAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -3359,7 +4340,10 @@ public virtual Task SegmentsAsync(Elastic.Clients.Elasticsearc } /// - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SegmentsAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -3371,7 +4355,10 @@ public virtual Task SegmentsAsync(Elastic.Clients.Elasticsearc } /// - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SegmentsAsync(CancellationToken cancellationToken = default) @@ -3382,7 +4369,10 @@ public virtual Task SegmentsAsync(CancellationToken cancellati } /// - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SegmentsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -3394,7 +4384,10 @@ public virtual Task SegmentsAsync(Action - /// Simulate an index.
Returns the index configuration that would be applied to the specified index from an existing index template. + /// + /// Simulate an index. + /// Returns the index configuration that would be applied to the specified index from an existing index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateIndexTemplateAsync(SimulateIndexTemplateRequest request, CancellationToken cancellationToken = default) @@ -3404,7 +4397,10 @@ public virtual Task SimulateIndexTemplateAsync(Si } /// - /// Simulate an index.
Returns the index configuration that would be applied to the specified index from an existing index template. + /// + /// Simulate an index. + /// Returns the index configuration that would be applied to the specified index from an existing index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateIndexTemplateAsync(SimulateIndexTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3414,7 +4410,10 @@ public virtual Task SimulateIndexTemplateAsync(Si } /// - /// Simulate an index.
Returns the index configuration that would be applied to the specified index from an existing index template. + /// + /// Simulate an index. + /// Returns the index configuration that would be applied to the specified index from an existing index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateIndexTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, CancellationToken cancellationToken = default) @@ -3425,7 +4424,10 @@ public virtual Task SimulateIndexTemplateAsync(El } /// - /// Simulate an index.
Returns the index configuration that would be applied to the specified index from an existing index template. + /// + /// Simulate an index. + /// Returns the index configuration that would be applied to the specified index from an existing index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateIndexTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -3437,7 +4439,10 @@ public virtual Task SimulateIndexTemplateAsync(El } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateTemplateAsync(SimulateTemplateRequest request, CancellationToken cancellationToken = default) @@ -3447,7 +4452,10 @@ public virtual Task SimulateTemplateAsync(SimulateTemp } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateTemplateAsync(SimulateTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3457,7 +4465,10 @@ public virtual Task SimulateTemplateAsync(S } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Name? name, CancellationToken cancellationToken = default) @@ -3468,7 +4479,10 @@ public virtual Task SimulateTemplateAsync(E } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Name? name, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3480,7 +4494,10 @@ public virtual Task SimulateTemplateAsync(E } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateTemplateAsync(CancellationToken cancellationToken = default) @@ -3491,7 +4508,10 @@ public virtual Task SimulateTemplateAsync(C } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateTemplateAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -3503,7 +4523,10 @@ public virtual Task SimulateTemplateAsync(A } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateTemplateAsync(SimulateTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3513,7 +4536,10 @@ public virtual Task SimulateTemplateAsync(SimulateTemp } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Name? name, CancellationToken cancellationToken = default) @@ -3524,7 +4550,10 @@ public virtual Task SimulateTemplateAsync(Elastic.Clie } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Name? name, Action configureRequest, CancellationToken cancellationToken = default) @@ -3536,7 +4565,10 @@ public virtual Task SimulateTemplateAsync(Elastic.Clie } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateTemplateAsync(CancellationToken cancellationToken = default) @@ -3547,7 +4579,10 @@ public virtual Task SimulateTemplateAsync(Cancellation } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateTemplateAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -3559,7 +4594,10 @@ public virtual Task SimulateTemplateAsync(Action - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(IndicesStatsRequest request, CancellationToken cancellationToken = default) @@ -3569,7 +4607,10 @@ public virtual Task StatsAsync(IndicesStatsRequest request } /// - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(IndicesStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3579,7 +4620,10 @@ public virtual Task StatsAsync(IndicesStatsRequ } /// - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Elastic.Clients.Elasticsearch.Serverless.Metrics? metric, CancellationToken cancellationToken = default) @@ -3590,7 +4634,10 @@ public virtual Task StatsAsync(Elastic.Clients. } /// - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Elastic.Clients.Elasticsearch.Serverless.Metrics? metric, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3602,7 +4649,10 @@ public virtual Task StatsAsync(Elastic.Clients. } /// - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(CancellationToken cancellationToken = default) @@ -3613,7 +4663,10 @@ public virtual Task StatsAsync(CancellationToke } /// - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -3625,7 +4678,10 @@ public virtual Task StatsAsync(Action - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(IndicesStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3635,7 +4691,10 @@ public virtual Task StatsAsync(IndicesStatsRequestDescript } /// - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Elastic.Clients.Elasticsearch.Serverless.Metrics? metric, CancellationToken cancellationToken = default) @@ -3646,7 +4705,10 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsear } /// - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Elastic.Clients.Elasticsearch.Serverless.Metrics? metric, Action configureRequest, CancellationToken cancellationToken = default) @@ -3658,7 +4720,10 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsear } /// - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(CancellationToken cancellationToken = default) @@ -3669,7 +4734,10 @@ public virtual Task StatsAsync(CancellationToken cancellat } /// - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -3681,7 +4749,10 @@ public virtual Task StatsAsync(Action - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateAliasesAsync(UpdateAliasesRequest request, CancellationToken cancellationToken = default) @@ -3691,7 +4762,10 @@ public virtual Task UpdateAliasesAsync(UpdateAliasesReque } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateAliasesAsync(UpdateAliasesRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3701,7 +4775,10 @@ public virtual Task UpdateAliasesAsync(UpdateA } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateAliasesAsync(CancellationToken cancellationToken = default) @@ -3712,7 +4789,10 @@ public virtual Task UpdateAliasesAsync(Cancell } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateAliasesAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -3724,7 +4804,10 @@ public virtual Task UpdateAliasesAsync(Action< } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateAliasesAsync(UpdateAliasesRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3734,7 +4817,10 @@ public virtual Task UpdateAliasesAsync(UpdateAliasesReque } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateAliasesAsync(CancellationToken cancellationToken = default) @@ -3745,7 +4831,10 @@ public virtual Task UpdateAliasesAsync(CancellationToken } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateAliasesAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -3757,7 +4846,10 @@ public virtual Task UpdateAliasesAsync(Action - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateQueryAsync(ValidateQueryRequest request, CancellationToken cancellationToken = default) @@ -3767,7 +4859,10 @@ public virtual Task ValidateQueryAsync(ValidateQueryReque } /// - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateQueryAsync(ValidateQueryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3777,7 +4872,10 @@ public virtual Task ValidateQueryAsync(Validat } /// - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateQueryAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -3788,7 +4886,10 @@ public virtual Task ValidateQueryAsync(Elastic } /// - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateQueryAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3800,7 +4901,10 @@ public virtual Task ValidateQueryAsync(Elastic } /// - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateQueryAsync(CancellationToken cancellationToken = default) @@ -3811,7 +4915,10 @@ public virtual Task ValidateQueryAsync(Cancell } /// - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateQueryAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -3823,7 +4930,10 @@ public virtual Task ValidateQueryAsync(Action< } /// - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateQueryAsync(ValidateQueryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3833,7 +4943,10 @@ public virtual Task ValidateQueryAsync(ValidateQueryReque } /// - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateQueryAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -3844,7 +4957,10 @@ public virtual Task ValidateQueryAsync(Elastic.Clients.El } /// - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateQueryAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -3856,7 +4972,10 @@ public virtual Task ValidateQueryAsync(Elastic.Clients.El } /// - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateQueryAsync(CancellationToken cancellationToken = default) @@ -3867,7 +4986,10 @@ public virtual Task ValidateQueryAsync(CancellationToken } /// - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateQueryAsync(Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Ingest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Ingest.g.cs index a5877284eb9..665eb1f8ca3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Ingest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Ingest.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public partial class IngestNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected IngestNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal IngestNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// Deletes one or more existing ingest pipeline. + /// + /// Deletes one or more existing ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeletePipelineAsync(DeletePipelineRequest request, CancellationToken cancellationToken = default) @@ -48,7 +52,9 @@ public virtual Task DeletePipelineAsync(DeletePipelineRe } /// - /// Deletes one or more existing ingest pipeline. + /// + /// Deletes one or more existing ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeletePipelineAsync(DeletePipelineRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -58,7 +64,9 @@ public virtual Task DeletePipelineAsync(Delet } /// - /// Deletes one or more existing ingest pipeline. + /// + /// Deletes one or more existing ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeletePipelineAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -69,7 +77,9 @@ public virtual Task DeletePipelineAsync(Elast } /// - /// Deletes one or more existing ingest pipeline. + /// + /// Deletes one or more existing ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeletePipelineAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -81,7 +91,9 @@ public virtual Task DeletePipelineAsync(Elast } /// - /// Deletes one or more existing ingest pipeline. + /// + /// Deletes one or more existing ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeletePipelineAsync(DeletePipelineRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -91,7 +103,9 @@ public virtual Task DeletePipelineAsync(DeletePipelineRe } /// - /// Deletes one or more existing ingest pipeline. + /// + /// Deletes one or more existing ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeletePipelineAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -102,7 +116,9 @@ public virtual Task DeletePipelineAsync(Elastic.Clients. } /// - /// Deletes one or more existing ingest pipeline. + /// + /// Deletes one or more existing ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeletePipelineAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -114,7 +130,9 @@ public virtual Task DeletePipelineAsync(Elastic.Clients. } /// - /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// + /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GeoIpStatsAsync(GeoIpStatsRequest request, CancellationToken cancellationToken = default) @@ -124,7 +142,9 @@ public virtual Task GeoIpStatsAsync(GeoIpStatsRequest reques } /// - /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// + /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GeoIpStatsAsync(GeoIpStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -134,7 +154,9 @@ public virtual Task GeoIpStatsAsync(GeoIpStatsRequestDescrip } /// - /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// + /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GeoIpStatsAsync(CancellationToken cancellationToken = default) @@ -145,7 +167,9 @@ public virtual Task GeoIpStatsAsync(CancellationToken cancel } /// - /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// + /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GeoIpStatsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -157,7 +181,10 @@ public virtual Task GeoIpStatsAsync(Action - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPipelineAsync(GetPipelineRequest request, CancellationToken cancellationToken = default) @@ -167,7 +194,10 @@ public virtual Task GetPipelineAsync(GetPipelineRequest req } /// - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPipelineAsync(GetPipelineRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -177,7 +207,10 @@ public virtual Task GetPipelineAsync(GetPipeline } /// - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPipelineAsync(Elastic.Clients.Elasticsearch.Serverless.Id? id, CancellationToken cancellationToken = default) @@ -188,7 +221,10 @@ public virtual Task GetPipelineAsync(Elastic.Cli } /// - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPipelineAsync(Elastic.Clients.Elasticsearch.Serverless.Id? id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -200,7 +236,10 @@ public virtual Task GetPipelineAsync(Elastic.Cli } /// - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPipelineAsync(CancellationToken cancellationToken = default) @@ -211,7 +250,10 @@ public virtual Task GetPipelineAsync(Cancellatio } /// - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPipelineAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -223,7 +265,10 @@ public virtual Task GetPipelineAsync(Action - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPipelineAsync(GetPipelineRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -233,7 +278,10 @@ public virtual Task GetPipelineAsync(GetPipelineRequestDesc } /// - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPipelineAsync(Elastic.Clients.Elasticsearch.Serverless.Id? id, CancellationToken cancellationToken = default) @@ -244,7 +292,10 @@ public virtual Task GetPipelineAsync(Elastic.Clients.Elasti } /// - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPipelineAsync(Elastic.Clients.Elasticsearch.Serverless.Id? id, Action configureRequest, CancellationToken cancellationToken = default) @@ -256,7 +307,10 @@ public virtual Task GetPipelineAsync(Elastic.Clients.Elasti } /// - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPipelineAsync(CancellationToken cancellationToken = default) @@ -267,7 +321,10 @@ public virtual Task GetPipelineAsync(CancellationToken canc } /// - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPipelineAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -279,7 +336,11 @@ public virtual Task GetPipelineAsync(Action - /// Extracts structured fields out of a single text field within a document.
You choose which field to extract matched fields from, as well as the grok pattern you expect will match.
A grok pattern is like a regular expression that supports aliased expressions that can be reused. + /// + /// Extracts structured fields out of a single text field within a document. + /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. + /// A grok pattern is like a regular expression that supports aliased expressions that can be reused. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ProcessorGrokAsync(ProcessorGrokRequest request, CancellationToken cancellationToken = default) @@ -289,7 +350,11 @@ public virtual Task ProcessorGrokAsync(ProcessorGrokReque } /// - /// Extracts structured fields out of a single text field within a document.
You choose which field to extract matched fields from, as well as the grok pattern you expect will match.
A grok pattern is like a regular expression that supports aliased expressions that can be reused. + /// + /// Extracts structured fields out of a single text field within a document. + /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. + /// A grok pattern is like a regular expression that supports aliased expressions that can be reused. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ProcessorGrokAsync(ProcessorGrokRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -299,7 +364,11 @@ public virtual Task ProcessorGrokAsync(ProcessorGrokReque } /// - /// Extracts structured fields out of a single text field within a document.
You choose which field to extract matched fields from, as well as the grok pattern you expect will match.
A grok pattern is like a regular expression that supports aliased expressions that can be reused. + /// + /// Extracts structured fields out of a single text field within a document. + /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. + /// A grok pattern is like a regular expression that supports aliased expressions that can be reused. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ProcessorGrokAsync(CancellationToken cancellationToken = default) @@ -310,7 +379,11 @@ public virtual Task ProcessorGrokAsync(CancellationToken } /// - /// Extracts structured fields out of a single text field within a document.
You choose which field to extract matched fields from, as well as the grok pattern you expect will match.
A grok pattern is like a regular expression that supports aliased expressions that can be reused. + /// + /// Extracts structured fields out of a single text field within a document. + /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. + /// A grok pattern is like a regular expression that supports aliased expressions that can be reused. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ProcessorGrokAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -322,7 +395,10 @@ public virtual Task ProcessorGrokAsync(Action - /// Creates or updates an ingest pipeline.
Changes made using this API take effect immediately. + /// + /// Creates or updates an ingest pipeline. + /// Changes made using this API take effect immediately. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPipelineAsync(PutPipelineRequest request, CancellationToken cancellationToken = default) @@ -332,7 +408,10 @@ public virtual Task PutPipelineAsync(PutPipelineRequest req } /// - /// Creates or updates an ingest pipeline.
Changes made using this API take effect immediately. + /// + /// Creates or updates an ingest pipeline. + /// Changes made using this API take effect immediately. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPipelineAsync(PutPipelineRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -342,7 +421,10 @@ public virtual Task PutPipelineAsync(PutPipeline } /// - /// Creates or updates an ingest pipeline.
Changes made using this API take effect immediately. + /// + /// Creates or updates an ingest pipeline. + /// Changes made using this API take effect immediately. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPipelineAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -353,7 +435,10 @@ public virtual Task PutPipelineAsync(Elastic.Cli } /// - /// Creates or updates an ingest pipeline.
Changes made using this API take effect immediately. + /// + /// Creates or updates an ingest pipeline. + /// Changes made using this API take effect immediately. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPipelineAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -365,7 +450,10 @@ public virtual Task PutPipelineAsync(Elastic.Cli } /// - /// Creates or updates an ingest pipeline.
Changes made using this API take effect immediately. + /// + /// Creates or updates an ingest pipeline. + /// Changes made using this API take effect immediately. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPipelineAsync(PutPipelineRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -375,7 +463,10 @@ public virtual Task PutPipelineAsync(PutPipelineRequestDesc } /// - /// Creates or updates an ingest pipeline.
Changes made using this API take effect immediately. + /// + /// Creates or updates an ingest pipeline. + /// Changes made using this API take effect immediately. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPipelineAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -386,7 +477,10 @@ public virtual Task PutPipelineAsync(Elastic.Clients.Elasti } /// - /// Creates or updates an ingest pipeline.
Changes made using this API take effect immediately. + /// + /// Creates or updates an ingest pipeline. + /// Changes made using this API take effect immediately. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPipelineAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -398,7 +492,9 @@ public virtual Task PutPipelineAsync(Elastic.Clients.Elasti } /// - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateAsync(SimulateRequest request, CancellationToken cancellationToken = default) @@ -408,7 +504,9 @@ public virtual Task SimulateAsync(SimulateRequest request, Can } /// - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateAsync(SimulateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -418,7 +516,9 @@ public virtual Task SimulateAsync(SimulateRequestDe } /// - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateAsync(Elastic.Clients.Elasticsearch.Serverless.Id? id, CancellationToken cancellationToken = default) @@ -429,7 +529,9 @@ public virtual Task SimulateAsync(Elastic.Clients.E } /// - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateAsync(Elastic.Clients.Elasticsearch.Serverless.Id? id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -441,7 +543,9 @@ public virtual Task SimulateAsync(Elastic.Clients.E } /// - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateAsync(CancellationToken cancellationToken = default) @@ -452,7 +556,9 @@ public virtual Task SimulateAsync(CancellationToken } /// - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -464,7 +570,9 @@ public virtual Task SimulateAsync(Action - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateAsync(SimulateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -474,7 +582,9 @@ public virtual Task SimulateAsync(SimulateRequestDescriptor de } /// - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateAsync(Elastic.Clients.Elasticsearch.Serverless.Id? id, CancellationToken cancellationToken = default) @@ -485,7 +595,9 @@ public virtual Task SimulateAsync(Elastic.Clients.Elasticsearc } /// - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateAsync(Elastic.Clients.Elasticsearch.Serverless.Id? id, Action configureRequest, CancellationToken cancellationToken = default) @@ -497,7 +609,9 @@ public virtual Task SimulateAsync(Elastic.Clients.Elasticsearc } /// - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateAsync(CancellationToken cancellationToken = default) @@ -508,7 +622,9 @@ public virtual Task SimulateAsync(CancellationToken cancellati } /// - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateAsync(Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.License.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.License.g.cs index 4efb755b1be..9393a46cfa1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.License.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.License.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.LicenseManagement; public partial class LicenseManagementNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected LicenseManagementNamespacedClient() : base() { @@ -38,7 +40,11 @@ internal LicenseManagementNamespacedClient(ElasticsearchClient client) : base(cl } /// - /// Get license information.
Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires.
For more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions). + /// + /// Get license information. + /// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. + /// For more information about the different types of licenses, refer to Elastic Stack subscriptions. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(GetLicenseRequest request, CancellationToken cancellationToken = default) @@ -48,7 +54,11 @@ public virtual Task GetAsync(GetLicenseRequest request, Canc } /// - /// Get license information.
Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires.
For more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions). + /// + /// Get license information. + /// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. + /// For more information about the different types of licenses, refer to Elastic Stack subscriptions. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(GetLicenseRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -58,7 +68,11 @@ public virtual Task GetAsync(GetLicenseRequestDescriptor des } /// - /// Get license information.
Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires.
For more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions). + /// + /// Get license information. + /// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. + /// For more information about the different types of licenses, refer to Elastic Stack subscriptions. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(CancellationToken cancellationToken = default) @@ -69,7 +83,11 @@ public virtual Task GetAsync(CancellationToken cancellationT } /// - /// Get license information.
Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires.
For more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions). + /// + /// Get license information. + /// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. + /// For more information about the different types of licenses, refer to Elastic Stack subscriptions. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Ml.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Ml.g.cs index 8633ff7d9f5..b19f46b34b6 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Ml.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Ml.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public partial class MachineLearningNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected MachineLearningNamespacedClient() : base() { @@ -38,7 +40,13 @@ internal MachineLearningNamespacedClient(ElasticsearchClient client) : base(clie } /// - /// Clear trained model deployment cache.
Cache will be cleared on all nodes where the trained model is assigned.
A trained model deployment may have an inference cache enabled.
As requests are handled by each allocated node, their responses may be cached on that individual node.
Calling this API clears the caches without restarting the deployment. + /// + /// Clear trained model deployment cache. + /// Cache will be cleared on all nodes where the trained model is assigned. + /// A trained model deployment may have an inference cache enabled. + /// As requests are handled by each allocated node, their responses may be cached on that individual node. + /// Calling this API clears the caches without restarting the deployment. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearTrainedModelDeploymentCacheAsync(ClearTrainedModelDeploymentCacheRequest request, CancellationToken cancellationToken = default) @@ -48,7 +56,13 @@ public virtual Task ClearTrainedModelD } /// - /// Clear trained model deployment cache.
Cache will be cleared on all nodes where the trained model is assigned.
A trained model deployment may have an inference cache enabled.
As requests are handled by each allocated node, their responses may be cached on that individual node.
Calling this API clears the caches without restarting the deployment. + /// + /// Clear trained model deployment cache. + /// Cache will be cleared on all nodes where the trained model is assigned. + /// A trained model deployment may have an inference cache enabled. + /// As requests are handled by each allocated node, their responses may be cached on that individual node. + /// Calling this API clears the caches without restarting the deployment. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearTrainedModelDeploymentCacheAsync(ClearTrainedModelDeploymentCacheRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -58,7 +72,13 @@ public virtual Task ClearTrainedModelD } /// - /// Clear trained model deployment cache.
Cache will be cleared on all nodes where the trained model is assigned.
A trained model deployment may have an inference cache enabled.
As requests are handled by each allocated node, their responses may be cached on that individual node.
Calling this API clears the caches without restarting the deployment. + /// + /// Clear trained model deployment cache. + /// Cache will be cleared on all nodes where the trained model is assigned. + /// A trained model deployment may have an inference cache enabled. + /// As requests are handled by each allocated node, their responses may be cached on that individual node. + /// Calling this API clears the caches without restarting the deployment. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearTrainedModelDeploymentCacheAsync(Elastic.Clients.Elasticsearch.Serverless.Id modelId, CancellationToken cancellationToken = default) @@ -69,7 +89,13 @@ public virtual Task ClearTrainedModelD } /// - /// Clear trained model deployment cache.
Cache will be cleared on all nodes where the trained model is assigned.
A trained model deployment may have an inference cache enabled.
As requests are handled by each allocated node, their responses may be cached on that individual node.
Calling this API clears the caches without restarting the deployment. + /// + /// Clear trained model deployment cache. + /// Cache will be cleared on all nodes where the trained model is assigned. + /// A trained model deployment may have an inference cache enabled. + /// As requests are handled by each allocated node, their responses may be cached on that individual node. + /// Calling this API clears the caches without restarting the deployment. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearTrainedModelDeploymentCacheAsync(Elastic.Clients.Elasticsearch.Serverless.Id modelId, Action configureRequest, CancellationToken cancellationToken = default) @@ -81,7 +107,13 @@ public virtual Task ClearTrainedModelD } /// - /// Close anomaly detection jobs.
A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.
When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.
If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.
When a datafeed that has a specified end date stops, it automatically closes its associated job. + /// + /// Close anomaly detection jobs. + /// A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results. + /// When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data. + /// If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. + /// When a datafeed that has a specified end date stops, it automatically closes its associated job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseJobAsync(CloseJobRequest request, CancellationToken cancellationToken = default) @@ -91,7 +123,13 @@ public virtual Task CloseJobAsync(CloseJobRequest request, Can } /// - /// Close anomaly detection jobs.
A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.
When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.
If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.
When a datafeed that has a specified end date stops, it automatically closes its associated job. + /// + /// Close anomaly detection jobs. + /// A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results. + /// When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data. + /// If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. + /// When a datafeed that has a specified end date stops, it automatically closes its associated job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseJobAsync(CloseJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -101,7 +139,13 @@ public virtual Task CloseJobAsync(CloseJobRequestDescriptor de } /// - /// Close anomaly detection jobs.
A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.
When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.
If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.
When a datafeed that has a specified end date stops, it automatically closes its associated job. + /// + /// Close anomaly detection jobs. + /// A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results. + /// When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data. + /// If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. + /// When a datafeed that has a specified end date stops, it automatically closes its associated job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseJobAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, CancellationToken cancellationToken = default) @@ -112,7 +156,13 @@ public virtual Task CloseJobAsync(Elastic.Clients.Elasticsearc } /// - /// Close anomaly detection jobs.
A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.
When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.
If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.
When a datafeed that has a specified end date stops, it automatically closes its associated job. + /// + /// Close anomaly detection jobs. + /// A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results. + /// When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data. + /// If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. + /// When a datafeed that has a specified end date stops, it automatically closes its associated job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseJobAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -124,7 +174,10 @@ public virtual Task CloseJobAsync(Elastic.Clients.Elasticsearc } /// - /// Delete a calendar.
Removes all scheduled events from a calendar, then deletes it. + /// + /// Delete a calendar. + /// Removes all scheduled events from a calendar, then deletes it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarAsync(DeleteCalendarRequest request, CancellationToken cancellationToken = default) @@ -134,7 +187,10 @@ public virtual Task DeleteCalendarAsync(DeleteCalendarRe } /// - /// Delete a calendar.
Removes all scheduled events from a calendar, then deletes it. + /// + /// Delete a calendar. + /// Removes all scheduled events from a calendar, then deletes it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarAsync(DeleteCalendarRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -144,7 +200,10 @@ public virtual Task DeleteCalendarAsync(DeleteCalendarRe } /// - /// Delete a calendar.
Removes all scheduled events from a calendar, then deletes it. + /// + /// Delete a calendar. + /// Removes all scheduled events from a calendar, then deletes it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarAsync(Elastic.Clients.Elasticsearch.Serverless.Id calendarId, CancellationToken cancellationToken = default) @@ -155,7 +214,10 @@ public virtual Task DeleteCalendarAsync(Elastic.Clients. } /// - /// Delete a calendar.
Removes all scheduled events from a calendar, then deletes it. + /// + /// Delete a calendar. + /// Removes all scheduled events from a calendar, then deletes it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarAsync(Elastic.Clients.Elasticsearch.Serverless.Id calendarId, Action configureRequest, CancellationToken cancellationToken = default) @@ -167,7 +229,9 @@ public virtual Task DeleteCalendarAsync(Elastic.Clients. } /// - /// Delete events from a calendar. + /// + /// Delete events from a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarEventAsync(DeleteCalendarEventRequest request, CancellationToken cancellationToken = default) @@ -177,7 +241,9 @@ public virtual Task DeleteCalendarEventAsync(Delete } /// - /// Delete events from a calendar. + /// + /// Delete events from a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarEventAsync(DeleteCalendarEventRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -187,7 +253,9 @@ public virtual Task DeleteCalendarEventAsync(Delete } /// - /// Delete events from a calendar. + /// + /// Delete events from a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarEventAsync(Elastic.Clients.Elasticsearch.Serverless.Id calendarId, Elastic.Clients.Elasticsearch.Serverless.Id eventId, CancellationToken cancellationToken = default) @@ -198,7 +266,9 @@ public virtual Task DeleteCalendarEventAsync(Elasti } /// - /// Delete events from a calendar. + /// + /// Delete events from a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarEventAsync(Elastic.Clients.Elasticsearch.Serverless.Id calendarId, Elastic.Clients.Elasticsearch.Serverless.Id eventId, Action configureRequest, CancellationToken cancellationToken = default) @@ -210,7 +280,9 @@ public virtual Task DeleteCalendarEventAsync(Elasti } /// - /// Delete anomaly jobs from a calendar. + /// + /// Delete anomaly jobs from a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarJobAsync(DeleteCalendarJobRequest request, CancellationToken cancellationToken = default) @@ -220,7 +292,9 @@ public virtual Task DeleteCalendarJobAsync(DeleteCale } /// - /// Delete anomaly jobs from a calendar. + /// + /// Delete anomaly jobs from a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarJobAsync(DeleteCalendarJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -230,7 +304,9 @@ public virtual Task DeleteCalendarJobAsync(DeleteCale } /// - /// Delete anomaly jobs from a calendar. + /// + /// Delete anomaly jobs from a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarJobAsync(Elastic.Clients.Elasticsearch.Serverless.Id calendarId, Elastic.Clients.Elasticsearch.Serverless.Ids jobId, CancellationToken cancellationToken = default) @@ -241,7 +317,9 @@ public virtual Task DeleteCalendarJobAsync(Elastic.Cl } /// - /// Delete anomaly jobs from a calendar. + /// + /// Delete anomaly jobs from a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarJobAsync(Elastic.Clients.Elasticsearch.Serverless.Id calendarId, Elastic.Clients.Elasticsearch.Serverless.Ids jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -253,7 +331,9 @@ public virtual Task DeleteCalendarJobAsync(Elastic.Cl } /// - /// Delete a datafeed. + /// + /// Delete a datafeed. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDatafeedAsync(DeleteDatafeedRequest request, CancellationToken cancellationToken = default) @@ -263,7 +343,9 @@ public virtual Task DeleteDatafeedAsync(DeleteDatafeedRe } /// - /// Delete a datafeed. + /// + /// Delete a datafeed. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDatafeedAsync(DeleteDatafeedRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -273,7 +355,9 @@ public virtual Task DeleteDatafeedAsync(DeleteDatafeedRe } /// - /// Delete a datafeed. + /// + /// Delete a datafeed. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDatafeedAsync(Elastic.Clients.Elasticsearch.Serverless.Id datafeedId, CancellationToken cancellationToken = default) @@ -284,7 +368,9 @@ public virtual Task DeleteDatafeedAsync(Elastic.Clients. } /// - /// Delete a datafeed. + /// + /// Delete a datafeed. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDatafeedAsync(Elastic.Clients.Elasticsearch.Serverless.Id datafeedId, Action configureRequest, CancellationToken cancellationToken = default) @@ -296,7 +382,9 @@ public virtual Task DeleteDatafeedAsync(Elastic.Clients. } /// - /// Delete a data frame analytics job. + /// + /// Delete a data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataFrameAnalyticsAsync(DeleteDataFrameAnalyticsRequest request, CancellationToken cancellationToken = default) @@ -306,7 +394,9 @@ public virtual Task DeleteDataFrameAnalyticsAs } /// - /// Delete a data frame analytics job. + /// + /// Delete a data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataFrameAnalyticsAsync(DeleteDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -316,7 +406,9 @@ public virtual Task DeleteDataFrameAnalyticsAs } /// - /// Delete a data frame analytics job. + /// + /// Delete a data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -327,7 +419,9 @@ public virtual Task DeleteDataFrameAnalyticsAs } /// - /// Delete a data frame analytics job. + /// + /// Delete a data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -339,7 +433,9 @@ public virtual Task DeleteDataFrameAnalyticsAs } /// - /// Delete a data frame analytics job. + /// + /// Delete a data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataFrameAnalyticsAsync(DeleteDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -349,7 +445,9 @@ public virtual Task DeleteDataFrameAnalyticsAs } /// - /// Delete a data frame analytics job. + /// + /// Delete a data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -360,7 +458,9 @@ public virtual Task DeleteDataFrameAnalyticsAs } /// - /// Delete a data frame analytics job. + /// + /// Delete a data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -372,7 +472,17 @@ public virtual Task DeleteDataFrameAnalyticsAs } /// - /// Delete expired ML data.
Deletes all job results, model snapshots and forecast data that have exceeded
their retention days period. Machine learning state documents that are not
associated with any job are also deleted.
You can limit the request to a single or set of anomaly detection jobs by
using a job identifier, a group name, a comma-separated list of jobs, or a
wildcard expression. You can delete expired data for all anomaly detection
jobs by using _all, by specifying * as the , or by omitting the
. + /// + /// Delete expired ML data. + /// Deletes all job results, model snapshots and forecast data that have exceeded + /// their retention days period. Machine learning state documents that are not + /// associated with any job are also deleted. + /// You can limit the request to a single or set of anomaly detection jobs by + /// using a job identifier, a group name, a comma-separated list of jobs, or a + /// wildcard expression. You can delete expired data for all anomaly detection + /// jobs by using _all, by specifying * as the <job_id>, or by omitting the + /// <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteExpiredDataAsync(DeleteExpiredDataRequest request, CancellationToken cancellationToken = default) @@ -382,7 +492,17 @@ public virtual Task DeleteExpiredDataAsync(DeleteExpi } /// - /// Delete expired ML data.
Deletes all job results, model snapshots and forecast data that have exceeded
their retention days period. Machine learning state documents that are not
associated with any job are also deleted.
You can limit the request to a single or set of anomaly detection jobs by
using a job identifier, a group name, a comma-separated list of jobs, or a
wildcard expression. You can delete expired data for all anomaly detection
jobs by using _all, by specifying * as the , or by omitting the
. + /// + /// Delete expired ML data. + /// Deletes all job results, model snapshots and forecast data that have exceeded + /// their retention days period. Machine learning state documents that are not + /// associated with any job are also deleted. + /// You can limit the request to a single or set of anomaly detection jobs by + /// using a job identifier, a group name, a comma-separated list of jobs, or a + /// wildcard expression. You can delete expired data for all anomaly detection + /// jobs by using _all, by specifying * as the <job_id>, or by omitting the + /// <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteExpiredDataAsync(DeleteExpiredDataRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -392,7 +512,17 @@ public virtual Task DeleteExpiredDataAsync(DeleteExpi } /// - /// Delete expired ML data.
Deletes all job results, model snapshots and forecast data that have exceeded
their retention days period. Machine learning state documents that are not
associated with any job are also deleted.
You can limit the request to a single or set of anomaly detection jobs by
using a job identifier, a group name, a comma-separated list of jobs, or a
wildcard expression. You can delete expired data for all anomaly detection
jobs by using _all, by specifying * as the , or by omitting the
. + /// + /// Delete expired ML data. + /// Deletes all job results, model snapshots and forecast data that have exceeded + /// their retention days period. Machine learning state documents that are not + /// associated with any job are also deleted. + /// You can limit the request to a single or set of anomaly detection jobs by + /// using a job identifier, a group name, a comma-separated list of jobs, or a + /// wildcard expression. You can delete expired data for all anomaly detection + /// jobs by using _all, by specifying * as the <job_id>, or by omitting the + /// <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteExpiredDataAsync(Elastic.Clients.Elasticsearch.Serverless.Id? jobId, CancellationToken cancellationToken = default) @@ -403,7 +533,17 @@ public virtual Task DeleteExpiredDataAsync(Elastic.Cl } /// - /// Delete expired ML data.
Deletes all job results, model snapshots and forecast data that have exceeded
their retention days period. Machine learning state documents that are not
associated with any job are also deleted.
You can limit the request to a single or set of anomaly detection jobs by
using a job identifier, a group name, a comma-separated list of jobs, or a
wildcard expression. You can delete expired data for all anomaly detection
jobs by using _all, by specifying * as the , or by omitting the
. + /// + /// Delete expired ML data. + /// Deletes all job results, model snapshots and forecast data that have exceeded + /// their retention days period. Machine learning state documents that are not + /// associated with any job are also deleted. + /// You can limit the request to a single or set of anomaly detection jobs by + /// using a job identifier, a group name, a comma-separated list of jobs, or a + /// wildcard expression. You can delete expired data for all anomaly detection + /// jobs by using _all, by specifying * as the <job_id>, or by omitting the + /// <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteExpiredDataAsync(Elastic.Clients.Elasticsearch.Serverless.Id? jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -415,7 +555,17 @@ public virtual Task DeleteExpiredDataAsync(Elastic.Cl } /// - /// Delete expired ML data.
Deletes all job results, model snapshots and forecast data that have exceeded
their retention days period. Machine learning state documents that are not
associated with any job are also deleted.
You can limit the request to a single or set of anomaly detection jobs by
using a job identifier, a group name, a comma-separated list of jobs, or a
wildcard expression. You can delete expired data for all anomaly detection
jobs by using _all, by specifying * as the , or by omitting the
. + /// + /// Delete expired ML data. + /// Deletes all job results, model snapshots and forecast data that have exceeded + /// their retention days period. Machine learning state documents that are not + /// associated with any job are also deleted. + /// You can limit the request to a single or set of anomaly detection jobs by + /// using a job identifier, a group name, a comma-separated list of jobs, or a + /// wildcard expression. You can delete expired data for all anomaly detection + /// jobs by using _all, by specifying * as the <job_id>, or by omitting the + /// <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteExpiredDataAsync(CancellationToken cancellationToken = default) @@ -426,7 +576,17 @@ public virtual Task DeleteExpiredDataAsync(Cancellati } /// - /// Delete expired ML data.
Deletes all job results, model snapshots and forecast data that have exceeded
their retention days period. Machine learning state documents that are not
associated with any job are also deleted.
You can limit the request to a single or set of anomaly detection jobs by
using a job identifier, a group name, a comma-separated list of jobs, or a
wildcard expression. You can delete expired data for all anomaly detection
jobs by using _all, by specifying * as the , or by omitting the
. + /// + /// Delete expired ML data. + /// Deletes all job results, model snapshots and forecast data that have exceeded + /// their retention days period. Machine learning state documents that are not + /// associated with any job are also deleted. + /// You can limit the request to a single or set of anomaly detection jobs by + /// using a job identifier, a group name, a comma-separated list of jobs, or a + /// wildcard expression. You can delete expired data for all anomaly detection + /// jobs by using _all, by specifying * as the <job_id>, or by omitting the + /// <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteExpiredDataAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -438,7 +598,11 @@ public virtual Task DeleteExpiredDataAsync(Action - /// Delete a filter.
If an anomaly detection job references the filter, you cannot delete the
filter. You must update or delete the job before you can delete the filter. + /// + /// Delete a filter. + /// If an anomaly detection job references the filter, you cannot delete the + /// filter. You must update or delete the job before you can delete the filter. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteFilterAsync(DeleteFilterRequest request, CancellationToken cancellationToken = default) @@ -448,7 +612,11 @@ public virtual Task DeleteFilterAsync(DeleteFilterRequest } /// - /// Delete a filter.
If an anomaly detection job references the filter, you cannot delete the
filter. You must update or delete the job before you can delete the filter. + /// + /// Delete a filter. + /// If an anomaly detection job references the filter, you cannot delete the + /// filter. You must update or delete the job before you can delete the filter. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteFilterAsync(DeleteFilterRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -458,7 +626,11 @@ public virtual Task DeleteFilterAsync(DeleteFilterRequestD } /// - /// Delete a filter.
If an anomaly detection job references the filter, you cannot delete the
filter. You must update or delete the job before you can delete the filter. + /// + /// Delete a filter. + /// If an anomaly detection job references the filter, you cannot delete the + /// filter. You must update or delete the job before you can delete the filter. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteFilterAsync(Elastic.Clients.Elasticsearch.Serverless.Id filterId, CancellationToken cancellationToken = default) @@ -469,7 +641,11 @@ public virtual Task DeleteFilterAsync(Elastic.Clients.Elas } /// - /// Delete a filter.
If an anomaly detection job references the filter, you cannot delete the
filter. You must update or delete the job before you can delete the filter. + /// + /// Delete a filter. + /// If an anomaly detection job references the filter, you cannot delete the + /// filter. You must update or delete the job before you can delete the filter. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteFilterAsync(Elastic.Clients.Elasticsearch.Serverless.Id filterId, Action configureRequest, CancellationToken cancellationToken = default) @@ -481,7 +657,13 @@ public virtual Task DeleteFilterAsync(Elastic.Clients.Elas } /// - /// Delete forecasts from a job.
By default, forecasts are retained for 14 days. You can specify a
different retention period with the `expires_in` parameter in the forecast
jobs API. The delete forecast API enables you to delete one or more
forecasts before they expire. + /// + /// Delete forecasts from a job. + /// By default, forecasts are retained for 14 days. You can specify a + /// different retention period with the expires_in parameter in the forecast + /// jobs API. The delete forecast API enables you to delete one or more + /// forecasts before they expire. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteForecastAsync(DeleteForecastRequest request, CancellationToken cancellationToken = default) @@ -491,7 +673,13 @@ public virtual Task DeleteForecastAsync(DeleteForecastRe } /// - /// Delete forecasts from a job.
By default, forecasts are retained for 14 days. You can specify a
different retention period with the `expires_in` parameter in the forecast
jobs API. The delete forecast API enables you to delete one or more
forecasts before they expire. + /// + /// Delete forecasts from a job. + /// By default, forecasts are retained for 14 days. You can specify a + /// different retention period with the expires_in parameter in the forecast + /// jobs API. The delete forecast API enables you to delete one or more + /// forecasts before they expire. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteForecastAsync(DeleteForecastRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -501,7 +689,13 @@ public virtual Task DeleteForecastAsync(DeleteForecastRe } /// - /// Delete forecasts from a job.
By default, forecasts are retained for 14 days. You can specify a
different retention period with the `expires_in` parameter in the forecast
jobs API. The delete forecast API enables you to delete one or more
forecasts before they expire. + /// + /// Delete forecasts from a job. + /// By default, forecasts are retained for 14 days. You can specify a + /// different retention period with the expires_in parameter in the forecast + /// jobs API. The delete forecast API enables you to delete one or more + /// forecasts before they expire. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteForecastAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Elastic.Clients.Elasticsearch.Serverless.Id? forecastId, CancellationToken cancellationToken = default) @@ -512,7 +706,13 @@ public virtual Task DeleteForecastAsync(Elastic.Clients. } /// - /// Delete forecasts from a job.
By default, forecasts are retained for 14 days. You can specify a
different retention period with the `expires_in` parameter in the forecast
jobs API. The delete forecast API enables you to delete one or more
forecasts before they expire. + /// + /// Delete forecasts from a job. + /// By default, forecasts are retained for 14 days. You can specify a + /// different retention period with the expires_in parameter in the forecast + /// jobs API. The delete forecast API enables you to delete one or more + /// forecasts before they expire. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteForecastAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Elastic.Clients.Elasticsearch.Serverless.Id? forecastId, Action configureRequest, CancellationToken cancellationToken = default) @@ -524,7 +724,13 @@ public virtual Task DeleteForecastAsync(Elastic.Clients. } /// - /// Delete forecasts from a job.
By default, forecasts are retained for 14 days. You can specify a
different retention period with the `expires_in` parameter in the forecast
jobs API. The delete forecast API enables you to delete one or more
forecasts before they expire. + /// + /// Delete forecasts from a job. + /// By default, forecasts are retained for 14 days. You can specify a + /// different retention period with the expires_in parameter in the forecast + /// jobs API. The delete forecast API enables you to delete one or more + /// forecasts before they expire. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteForecastAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, CancellationToken cancellationToken = default) @@ -535,7 +741,13 @@ public virtual Task DeleteForecastAsync(Elastic.Clients. } /// - /// Delete forecasts from a job.
By default, forecasts are retained for 14 days. You can specify a
different retention period with the `expires_in` parameter in the forecast
jobs API. The delete forecast API enables you to delete one or more
forecasts before they expire. + /// + /// Delete forecasts from a job. + /// By default, forecasts are retained for 14 days. You can specify a + /// different retention period with the expires_in parameter in the forecast + /// jobs API. The delete forecast API enables you to delete one or more + /// forecasts before they expire. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteForecastAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -547,7 +759,15 @@ public virtual Task DeleteForecastAsync(Elastic.Clients. } /// - /// Delete an anomaly detection job.
All job configuration, model state and results are deleted.
It is not currently possible to delete multiple jobs using wildcards or a
comma separated list. If you delete a job that has a datafeed, the request
first tries to delete the datafeed. This behavior is equivalent to calling
the delete datafeed API with the same timeout and force parameters as the
delete job request. + /// + /// Delete an anomaly detection job. + /// All job configuration, model state and results are deleted. + /// It is not currently possible to delete multiple jobs using wildcards or a + /// comma separated list. If you delete a job that has a datafeed, the request + /// first tries to delete the datafeed. This behavior is equivalent to calling + /// the delete datafeed API with the same timeout and force parameters as the + /// delete job request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteJobAsync(DeleteJobRequest request, CancellationToken cancellationToken = default) @@ -557,7 +777,15 @@ public virtual Task DeleteJobAsync(DeleteJobRequest request, } /// - /// Delete an anomaly detection job.
All job configuration, model state and results are deleted.
It is not currently possible to delete multiple jobs using wildcards or a
comma separated list. If you delete a job that has a datafeed, the request
first tries to delete the datafeed. This behavior is equivalent to calling
the delete datafeed API with the same timeout and force parameters as the
delete job request. + /// + /// Delete an anomaly detection job. + /// All job configuration, model state and results are deleted. + /// It is not currently possible to delete multiple jobs using wildcards or a + /// comma separated list. If you delete a job that has a datafeed, the request + /// first tries to delete the datafeed. This behavior is equivalent to calling + /// the delete datafeed API with the same timeout and force parameters as the + /// delete job request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteJobAsync(DeleteJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -567,7 +795,15 @@ public virtual Task DeleteJobAsync(DeleteJobRequestDescriptor } /// - /// Delete an anomaly detection job.
All job configuration, model state and results are deleted.
It is not currently possible to delete multiple jobs using wildcards or a
comma separated list. If you delete a job that has a datafeed, the request
first tries to delete the datafeed. This behavior is equivalent to calling
the delete datafeed API with the same timeout and force parameters as the
delete job request. + /// + /// Delete an anomaly detection job. + /// All job configuration, model state and results are deleted. + /// It is not currently possible to delete multiple jobs using wildcards or a + /// comma separated list. If you delete a job that has a datafeed, the request + /// first tries to delete the datafeed. This behavior is equivalent to calling + /// the delete datafeed API with the same timeout and force parameters as the + /// delete job request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteJobAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, CancellationToken cancellationToken = default) @@ -578,7 +814,15 @@ public virtual Task DeleteJobAsync(Elastic.Clients.Elasticsea } /// - /// Delete an anomaly detection job.
All job configuration, model state and results are deleted.
It is not currently possible to delete multiple jobs using wildcards or a
comma separated list. If you delete a job that has a datafeed, the request
first tries to delete the datafeed. This behavior is equivalent to calling
the delete datafeed API with the same timeout and force parameters as the
delete job request. + /// + /// Delete an anomaly detection job. + /// All job configuration, model state and results are deleted. + /// It is not currently possible to delete multiple jobs using wildcards or a + /// comma separated list. If you delete a job that has a datafeed, the request + /// first tries to delete the datafeed. This behavior is equivalent to calling + /// the delete datafeed API with the same timeout and force parameters as the + /// delete job request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteJobAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -590,7 +834,12 @@ public virtual Task DeleteJobAsync(Elastic.Clients.Elasticsea } /// - /// Delete a model snapshot.
You cannot delete the active model snapshot. To delete that snapshot, first
revert to a different one. To identify the active model snapshot, refer to
the `model_snapshot_id` in the results from the get jobs API. + /// + /// Delete a model snapshot. + /// You cannot delete the active model snapshot. To delete that snapshot, first + /// revert to a different one. To identify the active model snapshot, refer to + /// the model_snapshot_id in the results from the get jobs API. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteModelSnapshotAsync(DeleteModelSnapshotRequest request, CancellationToken cancellationToken = default) @@ -600,7 +849,12 @@ public virtual Task DeleteModelSnapshotAsync(Delete } /// - /// Delete a model snapshot.
You cannot delete the active model snapshot. To delete that snapshot, first
revert to a different one. To identify the active model snapshot, refer to
the `model_snapshot_id` in the results from the get jobs API. + /// + /// Delete a model snapshot. + /// You cannot delete the active model snapshot. To delete that snapshot, first + /// revert to a different one. To identify the active model snapshot, refer to + /// the model_snapshot_id in the results from the get jobs API. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteModelSnapshotAsync(DeleteModelSnapshotRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -610,7 +864,12 @@ public virtual Task DeleteModelSnapshotAsync(Delete } /// - /// Delete a model snapshot.
You cannot delete the active model snapshot. To delete that snapshot, first
revert to a different one. To identify the active model snapshot, refer to
the `model_snapshot_id` in the results from the get jobs API. + /// + /// Delete a model snapshot. + /// You cannot delete the active model snapshot. To delete that snapshot, first + /// revert to a different one. To identify the active model snapshot, refer to + /// the model_snapshot_id in the results from the get jobs API. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteModelSnapshotAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Elastic.Clients.Elasticsearch.Serverless.Id snapshotId, CancellationToken cancellationToken = default) @@ -621,7 +880,12 @@ public virtual Task DeleteModelSnapshotAsync(Elasti } /// - /// Delete a model snapshot.
You cannot delete the active model snapshot. To delete that snapshot, first
revert to a different one. To identify the active model snapshot, refer to
the `model_snapshot_id` in the results from the get jobs API. + /// + /// Delete a model snapshot. + /// You cannot delete the active model snapshot. To delete that snapshot, first + /// revert to a different one. To identify the active model snapshot, refer to + /// the model_snapshot_id in the results from the get jobs API. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteModelSnapshotAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Elastic.Clients.Elasticsearch.Serverless.Id snapshotId, Action configureRequest, CancellationToken cancellationToken = default) @@ -633,7 +897,10 @@ public virtual Task DeleteModelSnapshotAsync(Elasti } /// - /// Delete an unreferenced trained model.
The request deletes a trained inference model that is not referenced by an ingest pipeline. + /// + /// Delete an unreferenced trained model. + /// The request deletes a trained inference model that is not referenced by an ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteTrainedModelAsync(DeleteTrainedModelRequest request, CancellationToken cancellationToken = default) @@ -643,7 +910,10 @@ public virtual Task DeleteTrainedModelAsync(DeleteTr } /// - /// Delete an unreferenced trained model.
The request deletes a trained inference model that is not referenced by an ingest pipeline. + /// + /// Delete an unreferenced trained model. + /// The request deletes a trained inference model that is not referenced by an ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteTrainedModelAsync(DeleteTrainedModelRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -653,7 +923,10 @@ public virtual Task DeleteTrainedModelAsync(DeleteTr } /// - /// Delete an unreferenced trained model.
The request deletes a trained inference model that is not referenced by an ingest pipeline. + /// + /// Delete an unreferenced trained model. + /// The request deletes a trained inference model that is not referenced by an ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteTrainedModelAsync(Elastic.Clients.Elasticsearch.Serverless.Id modelId, CancellationToken cancellationToken = default) @@ -664,7 +937,10 @@ public virtual Task DeleteTrainedModelAsync(Elastic. } /// - /// Delete an unreferenced trained model.
The request deletes a trained inference model that is not referenced by an ingest pipeline. + /// + /// Delete an unreferenced trained model. + /// The request deletes a trained inference model that is not referenced by an ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteTrainedModelAsync(Elastic.Clients.Elasticsearch.Serverless.Id modelId, Action configureRequest, CancellationToken cancellationToken = default) @@ -676,7 +952,12 @@ public virtual Task DeleteTrainedModelAsync(Elastic. } /// - /// Delete a trained model alias.
This API deletes an existing model alias that refers to a trained model. If
the model alias is missing or refers to a model other than the one identified
by the `model_id`, this API returns an error. + /// + /// Delete a trained model alias. + /// This API deletes an existing model alias that refers to a trained model. If + /// the model alias is missing or refers to a model other than the one identified + /// by the model_id, this API returns an error. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteTrainedModelAliasAsync(DeleteTrainedModelAliasRequest request, CancellationToken cancellationToken = default) @@ -686,7 +967,12 @@ public virtual Task DeleteTrainedModelAliasAsyn } /// - /// Delete a trained model alias.
This API deletes an existing model alias that refers to a trained model. If
the model alias is missing or refers to a model other than the one identified
by the `model_id`, this API returns an error. + /// + /// Delete a trained model alias. + /// This API deletes an existing model alias that refers to a trained model. If + /// the model alias is missing or refers to a model other than the one identified + /// by the model_id, this API returns an error. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteTrainedModelAliasAsync(DeleteTrainedModelAliasRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -696,7 +982,12 @@ public virtual Task DeleteTrainedModelAliasAsyn } /// - /// Delete a trained model alias.
This API deletes an existing model alias that refers to a trained model. If
the model alias is missing or refers to a model other than the one identified
by the `model_id`, this API returns an error. + /// + /// Delete a trained model alias. + /// This API deletes an existing model alias that refers to a trained model. If + /// the model alias is missing or refers to a model other than the one identified + /// by the model_id, this API returns an error. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteTrainedModelAliasAsync(Elastic.Clients.Elasticsearch.Serverless.Id modelId, Elastic.Clients.Elasticsearch.Serverless.Name modelAlias, CancellationToken cancellationToken = default) @@ -707,7 +998,12 @@ public virtual Task DeleteTrainedModelAliasAsyn } /// - /// Delete a trained model alias.
This API deletes an existing model alias that refers to a trained model. If
the model alias is missing or refers to a model other than the one identified
by the `model_id`, this API returns an error. + /// + /// Delete a trained model alias. + /// This API deletes an existing model alias that refers to a trained model. If + /// the model alias is missing or refers to a model other than the one identified + /// by the model_id, this API returns an error. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteTrainedModelAliasAsync(Elastic.Clients.Elasticsearch.Serverless.Id modelId, Elastic.Clients.Elasticsearch.Serverless.Name modelAlias, Action configureRequest, CancellationToken cancellationToken = default) @@ -719,7 +1015,12 @@ public virtual Task DeleteTrainedModelAliasAsyn } /// - /// Estimate job model memory usage.
Makes an estimation of the memory usage for an anomaly detection job model.
It is based on analysis configuration details for the job and cardinality
estimates for the fields it references. + /// + /// Estimate job model memory usage. + /// Makes an estimation of the memory usage for an anomaly detection job model. + /// It is based on analysis configuration details for the job and cardinality + /// estimates for the fields it references. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task EstimateModelMemoryAsync(EstimateModelMemoryRequest request, CancellationToken cancellationToken = default) @@ -729,7 +1030,12 @@ public virtual Task EstimateModelMemoryAsync(Estima } /// - /// Estimate job model memory usage.
Makes an estimation of the memory usage for an anomaly detection job model.
It is based on analysis configuration details for the job and cardinality
estimates for the fields it references. + /// + /// Estimate job model memory usage. + /// Makes an estimation of the memory usage for an anomaly detection job model. + /// It is based on analysis configuration details for the job and cardinality + /// estimates for the fields it references. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task EstimateModelMemoryAsync(EstimateModelMemoryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -739,7 +1045,12 @@ public virtual Task EstimateModelMemoryAsync - /// Estimate job model memory usage.
Makes an estimation of the memory usage for an anomaly detection job model.
It is based on analysis configuration details for the job and cardinality
estimates for the fields it references. + /// + /// Estimate job model memory usage. + /// Makes an estimation of the memory usage for an anomaly detection job model. + /// It is based on analysis configuration details for the job and cardinality + /// estimates for the fields it references. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task EstimateModelMemoryAsync(CancellationToken cancellationToken = default) @@ -750,7 +1061,12 @@ public virtual Task EstimateModelMemoryAsync - /// Estimate job model memory usage.
Makes an estimation of the memory usage for an anomaly detection job model.
It is based on analysis configuration details for the job and cardinality
estimates for the fields it references. + /// + /// Estimate job model memory usage. + /// Makes an estimation of the memory usage for an anomaly detection job model. + /// It is based on analysis configuration details for the job and cardinality + /// estimates for the fields it references. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task EstimateModelMemoryAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -762,7 +1078,12 @@ public virtual Task EstimateModelMemoryAsync - /// Estimate job model memory usage.
Makes an estimation of the memory usage for an anomaly detection job model.
It is based on analysis configuration details for the job and cardinality
estimates for the fields it references. + /// + /// Estimate job model memory usage. + /// Makes an estimation of the memory usage for an anomaly detection job model. + /// It is based on analysis configuration details for the job and cardinality + /// estimates for the fields it references. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task EstimateModelMemoryAsync(EstimateModelMemoryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -772,7 +1093,12 @@ public virtual Task EstimateModelMemoryAsync(Estima } /// - /// Estimate job model memory usage.
Makes an estimation of the memory usage for an anomaly detection job model.
It is based on analysis configuration details for the job and cardinality
estimates for the fields it references. + /// + /// Estimate job model memory usage. + /// Makes an estimation of the memory usage for an anomaly detection job model. + /// It is based on analysis configuration details for the job and cardinality + /// estimates for the fields it references. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task EstimateModelMemoryAsync(CancellationToken cancellationToken = default) @@ -783,7 +1109,12 @@ public virtual Task EstimateModelMemoryAsync(Cancel } /// - /// Estimate job model memory usage.
Makes an estimation of the memory usage for an anomaly detection job model.
It is based on analysis configuration details for the job and cardinality
estimates for the fields it references. + /// + /// Estimate job model memory usage. + /// Makes an estimation of the memory usage for an anomaly detection job model. + /// It is based on analysis configuration details for the job and cardinality + /// estimates for the fields it references. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task EstimateModelMemoryAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -795,7 +1126,13 @@ public virtual Task EstimateModelMemoryAsync(Action } /// - /// Evaluate data frame analytics.
The API packages together commonly used evaluation metrics for various types
of machine learning features. This has been designed for use on indexes
created by data frame analytics. Evaluation requires both a ground truth
field and an analytics result field to be present. + /// + /// Evaluate data frame analytics. + /// The API packages together commonly used evaluation metrics for various types + /// of machine learning features. This has been designed for use on indexes + /// created by data frame analytics. Evaluation requires both a ground truth + /// field and an analytics result field to be present. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task EvaluateDataFrameAsync(EvaluateDataFrameRequest request, CancellationToken cancellationToken = default) @@ -805,7 +1142,13 @@ public virtual Task EvaluateDataFrameAsync(EvaluateDa } /// - /// Evaluate data frame analytics.
The API packages together commonly used evaluation metrics for various types
of machine learning features. This has been designed for use on indexes
created by data frame analytics. Evaluation requires both a ground truth
field and an analytics result field to be present. + /// + /// Evaluate data frame analytics. + /// The API packages together commonly used evaluation metrics for various types + /// of machine learning features. This has been designed for use on indexes + /// created by data frame analytics. Evaluation requires both a ground truth + /// field and an analytics result field to be present. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task EvaluateDataFrameAsync(EvaluateDataFrameRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -815,7 +1158,13 @@ public virtual Task EvaluateDataFrameAsync } /// - /// Evaluate data frame analytics.
The API packages together commonly used evaluation metrics for various types
of machine learning features. This has been designed for use on indexes
created by data frame analytics. Evaluation requires both a ground truth
field and an analytics result field to be present. + /// + /// Evaluate data frame analytics. + /// The API packages together commonly used evaluation metrics for various types + /// of machine learning features. This has been designed for use on indexes + /// created by data frame analytics. Evaluation requires both a ground truth + /// field and an analytics result field to be present. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task EvaluateDataFrameAsync(CancellationToken cancellationToken = default) @@ -826,7 +1175,13 @@ public virtual Task EvaluateDataFrameAsync } /// - /// Evaluate data frame analytics.
The API packages together commonly used evaluation metrics for various types
of machine learning features. This has been designed for use on indexes
created by data frame analytics. Evaluation requires both a ground truth
field and an analytics result field to be present. + /// + /// Evaluate data frame analytics. + /// The API packages together commonly used evaluation metrics for various types + /// of machine learning features. This has been designed for use on indexes + /// created by data frame analytics. Evaluation requires both a ground truth + /// field and an analytics result field to be present. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task EvaluateDataFrameAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -838,7 +1193,13 @@ public virtual Task EvaluateDataFrameAsync } /// - /// Evaluate data frame analytics.
The API packages together commonly used evaluation metrics for various types
of machine learning features. This has been designed for use on indexes
created by data frame analytics. Evaluation requires both a ground truth
field and an analytics result field to be present. + /// + /// Evaluate data frame analytics. + /// The API packages together commonly used evaluation metrics for various types + /// of machine learning features. This has been designed for use on indexes + /// created by data frame analytics. Evaluation requires both a ground truth + /// field and an analytics result field to be present. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task EvaluateDataFrameAsync(EvaluateDataFrameRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -848,7 +1209,13 @@ public virtual Task EvaluateDataFrameAsync(EvaluateDa } /// - /// Evaluate data frame analytics.
The API packages together commonly used evaluation metrics for various types
of machine learning features. This has been designed for use on indexes
created by data frame analytics. Evaluation requires both a ground truth
field and an analytics result field to be present. + /// + /// Evaluate data frame analytics. + /// The API packages together commonly used evaluation metrics for various types + /// of machine learning features. This has been designed for use on indexes + /// created by data frame analytics. Evaluation requires both a ground truth + /// field and an analytics result field to be present. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task EvaluateDataFrameAsync(CancellationToken cancellationToken = default) @@ -859,7 +1226,13 @@ public virtual Task EvaluateDataFrameAsync(Cancellati } /// - /// Evaluate data frame analytics.
The API packages together commonly used evaluation metrics for various types
of machine learning features. This has been designed for use on indexes
created by data frame analytics. Evaluation requires both a ground truth
field and an analytics result field to be present. + /// + /// Evaluate data frame analytics. + /// The API packages together commonly used evaluation metrics for various types + /// of machine learning features. This has been designed for use on indexes + /// created by data frame analytics. Evaluation requires both a ground truth + /// field and an analytics result field to be present. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task EvaluateDataFrameAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -871,7 +1244,25 @@ public virtual Task EvaluateDataFrameAsync(Action - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataFrameAnalyticsAsync(ExplainDataFrameAnalyticsRequest request, CancellationToken cancellationToken = default) @@ -881,7 +1272,25 @@ public virtual Task ExplainDataFrameAnalytics } /// - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataFrameAnalyticsAsync(ExplainDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -891,7 +1300,25 @@ public virtual Task ExplainDataFrameAnalytics } /// - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id? id, CancellationToken cancellationToken = default) @@ -902,7 +1329,25 @@ public virtual Task ExplainDataFrameAnalytics } /// - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id? id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -914,7 +1359,25 @@ public virtual Task ExplainDataFrameAnalytics } /// - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataFrameAnalyticsAsync(CancellationToken cancellationToken = default) @@ -925,7 +1388,25 @@ public virtual Task ExplainDataFrameAnalytics } /// - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataFrameAnalyticsAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -937,7 +1418,25 @@ public virtual Task ExplainDataFrameAnalytics } /// - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataFrameAnalyticsAsync(ExplainDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -947,7 +1446,25 @@ public virtual Task ExplainDataFrameAnalytics } /// - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id? id, CancellationToken cancellationToken = default) @@ -958,7 +1475,25 @@ public virtual Task ExplainDataFrameAnalytics } /// - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id? id, Action configureRequest, CancellationToken cancellationToken = default) @@ -970,7 +1505,25 @@ public virtual Task ExplainDataFrameAnalytics } /// - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataFrameAnalyticsAsync(CancellationToken cancellationToken = default) @@ -981,7 +1534,25 @@ public virtual Task ExplainDataFrameAnalytics } /// - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataFrameAnalyticsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -993,7 +1564,17 @@ public virtual Task ExplainDataFrameAnalytics } /// - /// Forces any buffered data to be processed by the job.
The flush jobs API is only applicable when sending data for analysis using
the post data API. Depending on the content of the buffer, then it might
additionally calculate new results. Both flush and close operations are
similar, however the flush is more efficient if you are expecting to send
more data for analysis. When flushing, the job remains open and is available
to continue analyzing data. A close operation additionally prunes and
persists the model state to disk and the job must be opened again before
analyzing further data. + /// + /// Forces any buffered data to be processed by the job. + /// The flush jobs API is only applicable when sending data for analysis using + /// the post data API. Depending on the content of the buffer, then it might + /// additionally calculate new results. Both flush and close operations are + /// similar, however the flush is more efficient if you are expecting to send + /// more data for analysis. When flushing, the job remains open and is available + /// to continue analyzing data. A close operation additionally prunes and + /// persists the model state to disk and the job must be opened again before + /// analyzing further data. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushJobAsync(FlushJobRequest request, CancellationToken cancellationToken = default) @@ -1003,7 +1584,17 @@ public virtual Task FlushJobAsync(FlushJobRequest request, Can } /// - /// Forces any buffered data to be processed by the job.
The flush jobs API is only applicable when sending data for analysis using
the post data API. Depending on the content of the buffer, then it might
additionally calculate new results. Both flush and close operations are
similar, however the flush is more efficient if you are expecting to send
more data for analysis. When flushing, the job remains open and is available
to continue analyzing data. A close operation additionally prunes and
persists the model state to disk and the job must be opened again before
analyzing further data. + /// + /// Forces any buffered data to be processed by the job. + /// The flush jobs API is only applicable when sending data for analysis using + /// the post data API. Depending on the content of the buffer, then it might + /// additionally calculate new results. Both flush and close operations are + /// similar, however the flush is more efficient if you are expecting to send + /// more data for analysis. When flushing, the job remains open and is available + /// to continue analyzing data. A close operation additionally prunes and + /// persists the model state to disk and the job must be opened again before + /// analyzing further data. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushJobAsync(FlushJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1013,7 +1604,17 @@ public virtual Task FlushJobAsync(FlushJobRequestDescriptor de } /// - /// Forces any buffered data to be processed by the job.
The flush jobs API is only applicable when sending data for analysis using
the post data API. Depending on the content of the buffer, then it might
additionally calculate new results. Both flush and close operations are
similar, however the flush is more efficient if you are expecting to send
more data for analysis. When flushing, the job remains open and is available
to continue analyzing data. A close operation additionally prunes and
persists the model state to disk and the job must be opened again before
analyzing further data. + /// + /// Forces any buffered data to be processed by the job. + /// The flush jobs API is only applicable when sending data for analysis using + /// the post data API. Depending on the content of the buffer, then it might + /// additionally calculate new results. Both flush and close operations are + /// similar, however the flush is more efficient if you are expecting to send + /// more data for analysis. When flushing, the job remains open and is available + /// to continue analyzing data. A close operation additionally prunes and + /// persists the model state to disk and the job must be opened again before + /// analyzing further data. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushJobAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, CancellationToken cancellationToken = default) @@ -1024,7 +1625,17 @@ public virtual Task FlushJobAsync(Elastic.Clients.Elasticsearc } /// - /// Forces any buffered data to be processed by the job.
The flush jobs API is only applicable when sending data for analysis using
the post data API. Depending on the content of the buffer, then it might
additionally calculate new results. Both flush and close operations are
similar, however the flush is more efficient if you are expecting to send
more data for analysis. When flushing, the job remains open and is available
to continue analyzing data. A close operation additionally prunes and
persists the model state to disk and the job must be opened again before
analyzing further data. + /// + /// Forces any buffered data to be processed by the job. + /// The flush jobs API is only applicable when sending data for analysis using + /// the post data API. Depending on the content of the buffer, then it might + /// additionally calculate new results. Both flush and close operations are + /// similar, however the flush is more efficient if you are expecting to send + /// more data for analysis. When flushing, the job remains open and is available + /// to continue analyzing data. A close operation additionally prunes and + /// persists the model state to disk and the job must be opened again before + /// analyzing further data. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushJobAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -1036,8 +1647,15 @@ public virtual Task FlushJobAsync(Elastic.Clients.Elasticsearc } /// - /// Predicts the future behavior of a time series by using its historical
behavior. - /// Forecasts are not supported for jobs that perform population analysis; an
error occurs if you try to create a forecast for a job that has an
`over_field_name` in its configuration. + /// + /// Predicts the future behavior of a time series by using its historical + /// behavior. + /// + /// + /// Forecasts are not supported for jobs that perform population analysis; an + /// error occurs if you try to create a forecast for a job that has an + /// over_field_name in its configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForecastAsync(ForecastRequest request, CancellationToken cancellationToken = default) @@ -1047,8 +1665,15 @@ public virtual Task ForecastAsync(ForecastRequest request, Can } /// - /// Predicts the future behavior of a time series by using its historical
behavior. - /// Forecasts are not supported for jobs that perform population analysis; an
error occurs if you try to create a forecast for a job that has an
`over_field_name` in its configuration. + /// + /// Predicts the future behavior of a time series by using its historical + /// behavior. + /// + /// + /// Forecasts are not supported for jobs that perform population analysis; an + /// error occurs if you try to create a forecast for a job that has an + /// over_field_name in its configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForecastAsync(ForecastRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1058,8 +1683,15 @@ public virtual Task ForecastAsync(ForecastRequestDescriptor de } /// - /// Predicts the future behavior of a time series by using its historical
behavior. - /// Forecasts are not supported for jobs that perform population analysis; an
error occurs if you try to create a forecast for a job that has an
`over_field_name` in its configuration. + /// + /// Predicts the future behavior of a time series by using its historical + /// behavior. + /// + /// + /// Forecasts are not supported for jobs that perform population analysis; an + /// error occurs if you try to create a forecast for a job that has an + /// over_field_name in its configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForecastAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, CancellationToken cancellationToken = default) @@ -1070,8 +1702,15 @@ public virtual Task ForecastAsync(Elastic.Clients.Elasticsearc } /// - /// Predicts the future behavior of a time series by using its historical
behavior. - /// Forecasts are not supported for jobs that perform population analysis; an
error occurs if you try to create a forecast for a job that has an
`over_field_name` in its configuration. + /// + /// Predicts the future behavior of a time series by using its historical + /// behavior. + /// + /// + /// Forecasts are not supported for jobs that perform population analysis; an + /// error occurs if you try to create a forecast for a job that has an + /// over_field_name in its configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForecastAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -1083,7 +1722,10 @@ public virtual Task ForecastAsync(Elastic.Clients.Elasticsearc } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBucketsAsync(GetBucketsRequest request, CancellationToken cancellationToken = default) @@ -1093,7 +1735,10 @@ public virtual Task GetBucketsAsync(GetBucketsRequest reques } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBucketsAsync(GetBucketsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1103,7 +1748,10 @@ public virtual Task GetBucketsAsync(GetBucketsReq } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBucketsAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, DateTimeOffset? timestamp, CancellationToken cancellationToken = default) @@ -1114,7 +1762,10 @@ public virtual Task GetBucketsAsync(Elastic.Clien } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBucketsAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, DateTimeOffset? timestamp, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1126,7 +1777,10 @@ public virtual Task GetBucketsAsync(Elastic.Clien } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBucketsAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, CancellationToken cancellationToken = default) @@ -1137,7 +1791,10 @@ public virtual Task GetBucketsAsync(Elastic.Clien } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBucketsAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1149,7 +1806,10 @@ public virtual Task GetBucketsAsync(Elastic.Clien } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBucketsAsync(GetBucketsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1159,7 +1819,10 @@ public virtual Task GetBucketsAsync(GetBucketsRequestDescrip } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBucketsAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, DateTimeOffset? timestamp, CancellationToken cancellationToken = default) @@ -1170,7 +1833,10 @@ public virtual Task GetBucketsAsync(Elastic.Clients.Elastics } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBucketsAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, DateTimeOffset? timestamp, Action configureRequest, CancellationToken cancellationToken = default) @@ -1182,7 +1848,10 @@ public virtual Task GetBucketsAsync(Elastic.Clients.Elastics } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBucketsAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, CancellationToken cancellationToken = default) @@ -1193,7 +1862,10 @@ public virtual Task GetBucketsAsync(Elastic.Clients.Elastics } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBucketsAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -1205,7 +1877,9 @@ public virtual Task GetBucketsAsync(Elastic.Clients.Elastics } /// - /// Retrieves information about the scheduled events in calendars. + /// + /// Retrieves information about the scheduled events in calendars. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCalendarEventsAsync(GetCalendarEventsRequest request, CancellationToken cancellationToken = default) @@ -1215,7 +1889,9 @@ public virtual Task GetCalendarEventsAsync(GetCalenda } /// - /// Retrieves information about the scheduled events in calendars. + /// + /// Retrieves information about the scheduled events in calendars. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCalendarEventsAsync(GetCalendarEventsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1225,7 +1901,9 @@ public virtual Task GetCalendarEventsAsync(GetCalenda } /// - /// Retrieves information about the scheduled events in calendars. + /// + /// Retrieves information about the scheduled events in calendars. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCalendarEventsAsync(Elastic.Clients.Elasticsearch.Serverless.Id calendarId, CancellationToken cancellationToken = default) @@ -1236,7 +1914,9 @@ public virtual Task GetCalendarEventsAsync(Elastic.Cl } /// - /// Retrieves information about the scheduled events in calendars. + /// + /// Retrieves information about the scheduled events in calendars. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCalendarEventsAsync(Elastic.Clients.Elasticsearch.Serverless.Id calendarId, Action configureRequest, CancellationToken cancellationToken = default) @@ -1248,7 +1928,9 @@ public virtual Task GetCalendarEventsAsync(Elastic.Cl } /// - /// Retrieves configuration information for calendars. + /// + /// Retrieves configuration information for calendars. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCalendarsAsync(GetCalendarsRequest request, CancellationToken cancellationToken = default) @@ -1258,7 +1940,9 @@ public virtual Task GetCalendarsAsync(GetCalendarsRequest } /// - /// Retrieves configuration information for calendars. + /// + /// Retrieves configuration information for calendars. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCalendarsAsync(GetCalendarsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1268,7 +1952,9 @@ public virtual Task GetCalendarsAsync(GetCalendarsRequestD } /// - /// Retrieves configuration information for calendars. + /// + /// Retrieves configuration information for calendars. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCalendarsAsync(Elastic.Clients.Elasticsearch.Serverless.Id? calendarId, CancellationToken cancellationToken = default) @@ -1279,7 +1965,9 @@ public virtual Task GetCalendarsAsync(Elastic.Clients.Elas } /// - /// Retrieves configuration information for calendars. + /// + /// Retrieves configuration information for calendars. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCalendarsAsync(Elastic.Clients.Elasticsearch.Serverless.Id? calendarId, Action configureRequest, CancellationToken cancellationToken = default) @@ -1291,7 +1979,9 @@ public virtual Task GetCalendarsAsync(Elastic.Clients.Elas } /// - /// Retrieves configuration information for calendars. + /// + /// Retrieves configuration information for calendars. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCalendarsAsync(CancellationToken cancellationToken = default) @@ -1302,7 +1992,9 @@ public virtual Task GetCalendarsAsync(CancellationToken ca } /// - /// Retrieves configuration information for calendars. + /// + /// Retrieves configuration information for calendars. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCalendarsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -1314,7 +2006,9 @@ public virtual Task GetCalendarsAsync(Action - /// Retrieves anomaly detection job results for one or more categories. + /// + /// Retrieves anomaly detection job results for one or more categories. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCategoriesAsync(GetCategoriesRequest request, CancellationToken cancellationToken = default) @@ -1324,7 +2018,9 @@ public virtual Task GetCategoriesAsync(GetCategoriesReque } /// - /// Retrieves anomaly detection job results for one or more categories. + /// + /// Retrieves anomaly detection job results for one or more categories. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCategoriesAsync(GetCategoriesRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1334,7 +2030,9 @@ public virtual Task GetCategoriesAsync(GetCategoriesReque } /// - /// Retrieves anomaly detection job results for one or more categories. + /// + /// Retrieves anomaly detection job results for one or more categories. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCategoriesAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, string? categoryId, CancellationToken cancellationToken = default) @@ -1345,7 +2043,9 @@ public virtual Task GetCategoriesAsync(Elastic.Clients.El } /// - /// Retrieves anomaly detection job results for one or more categories. + /// + /// Retrieves anomaly detection job results for one or more categories. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCategoriesAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, string? categoryId, Action configureRequest, CancellationToken cancellationToken = default) @@ -1357,7 +2057,9 @@ public virtual Task GetCategoriesAsync(Elastic.Clients.El } /// - /// Retrieves anomaly detection job results for one or more categories. + /// + /// Retrieves anomaly detection job results for one or more categories. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCategoriesAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, CancellationToken cancellationToken = default) @@ -1368,7 +2070,9 @@ public virtual Task GetCategoriesAsync(Elastic.Clients.El } /// - /// Retrieves anomaly detection job results for one or more categories. + /// + /// Retrieves anomaly detection job results for one or more categories. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCategoriesAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -1380,7 +2084,14 @@ public virtual Task GetCategoriesAsync(Elastic.Clients.El } /// - /// Retrieves configuration information for datafeeds.
You can get information for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get information for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves configuration information for datafeeds. + /// You can get information for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get information for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDatafeedsAsync(GetDatafeedsRequest request, CancellationToken cancellationToken = default) @@ -1390,7 +2101,14 @@ public virtual Task GetDatafeedsAsync(GetDatafeedsRequest } /// - /// Retrieves configuration information for datafeeds.
You can get information for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get information for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves configuration information for datafeeds. + /// You can get information for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get information for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDatafeedsAsync(GetDatafeedsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1400,7 +2118,14 @@ public virtual Task GetDatafeedsAsync(GetDatafeedsRequestD } /// - /// Retrieves configuration information for datafeeds.
You can get information for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get information for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves configuration information for datafeeds. + /// You can get information for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get information for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDatafeedsAsync(Elastic.Clients.Elasticsearch.Serverless.Ids? datafeedId, CancellationToken cancellationToken = default) @@ -1411,7 +2136,14 @@ public virtual Task GetDatafeedsAsync(Elastic.Clients.Elas } /// - /// Retrieves configuration information for datafeeds.
You can get information for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get information for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves configuration information for datafeeds. + /// You can get information for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get information for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDatafeedsAsync(Elastic.Clients.Elasticsearch.Serverless.Ids? datafeedId, Action configureRequest, CancellationToken cancellationToken = default) @@ -1423,7 +2155,14 @@ public virtual Task GetDatafeedsAsync(Elastic.Clients.Elas } /// - /// Retrieves configuration information for datafeeds.
You can get information for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get information for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves configuration information for datafeeds. + /// You can get information for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get information for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDatafeedsAsync(CancellationToken cancellationToken = default) @@ -1434,7 +2173,14 @@ public virtual Task GetDatafeedsAsync(CancellationToken ca } /// - /// Retrieves configuration information for datafeeds.
You can get information for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get information for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves configuration information for datafeeds. + /// You can get information for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get information for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDatafeedsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -1446,7 +2192,15 @@ public virtual Task GetDatafeedsAsync(Action - /// Retrieves usage information for datafeeds.
You can get statistics for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get statistics for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``. If the datafeed is stopped, the
only information you receive is the `datafeed_id` and the `state`.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves usage information for datafeeds. + /// You can get statistics for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get statistics for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. If the datafeed is stopped, the + /// only information you receive is the datafeed_id and the state. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDatafeedStatsAsync(GetDatafeedStatsRequest request, CancellationToken cancellationToken = default) @@ -1456,7 +2210,15 @@ public virtual Task GetDatafeedStatsAsync(GetDatafeedS } /// - /// Retrieves usage information for datafeeds.
You can get statistics for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get statistics for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``. If the datafeed is stopped, the
only information you receive is the `datafeed_id` and the `state`.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves usage information for datafeeds. + /// You can get statistics for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get statistics for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. If the datafeed is stopped, the + /// only information you receive is the datafeed_id and the state. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDatafeedStatsAsync(GetDatafeedStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1466,7 +2228,15 @@ public virtual Task GetDatafeedStatsAsync(GetDatafeedS } /// - /// Retrieves usage information for datafeeds.
You can get statistics for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get statistics for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``. If the datafeed is stopped, the
only information you receive is the `datafeed_id` and the `state`.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves usage information for datafeeds. + /// You can get statistics for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get statistics for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. If the datafeed is stopped, the + /// only information you receive is the datafeed_id and the state. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDatafeedStatsAsync(Elastic.Clients.Elasticsearch.Serverless.Ids? datafeedId, CancellationToken cancellationToken = default) @@ -1477,7 +2247,15 @@ public virtual Task GetDatafeedStatsAsync(Elastic.Clie } /// - /// Retrieves usage information for datafeeds.
You can get statistics for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get statistics for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``. If the datafeed is stopped, the
only information you receive is the `datafeed_id` and the `state`.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves usage information for datafeeds. + /// You can get statistics for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get statistics for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. If the datafeed is stopped, the + /// only information you receive is the datafeed_id and the state. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDatafeedStatsAsync(Elastic.Clients.Elasticsearch.Serverless.Ids? datafeedId, Action configureRequest, CancellationToken cancellationToken = default) @@ -1489,7 +2267,15 @@ public virtual Task GetDatafeedStatsAsync(Elastic.Clie } /// - /// Retrieves usage information for datafeeds.
You can get statistics for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get statistics for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``. If the datafeed is stopped, the
only information you receive is the `datafeed_id` and the `state`.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves usage information for datafeeds. + /// You can get statistics for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get statistics for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. If the datafeed is stopped, the + /// only information you receive is the datafeed_id and the state. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDatafeedStatsAsync(CancellationToken cancellationToken = default) @@ -1500,7 +2286,15 @@ public virtual Task GetDatafeedStatsAsync(Cancellation } /// - /// Retrieves usage information for datafeeds.
You can get statistics for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get statistics for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``. If the datafeed is stopped, the
only information you receive is the `datafeed_id` and the `state`.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves usage information for datafeeds. + /// You can get statistics for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get statistics for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. If the datafeed is stopped, the + /// only information you receive is the datafeed_id and the state. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDatafeedStatsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -1512,7 +2306,12 @@ public virtual Task GetDatafeedStatsAsync(Action - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsAsync(GetDataFrameAnalyticsRequest request, CancellationToken cancellationToken = default) @@ -1522,7 +2321,12 @@ public virtual Task GetDataFrameAnalyticsAsync(Ge } /// - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsAsync(GetDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1532,7 +2336,12 @@ public virtual Task GetDataFrameAnalyticsAsync - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id? id, CancellationToken cancellationToken = default) @@ -1543,7 +2352,12 @@ public virtual Task GetDataFrameAnalyticsAsync - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id? id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1555,7 +2369,12 @@ public virtual Task GetDataFrameAnalyticsAsync - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsAsync(CancellationToken cancellationToken = default) @@ -1566,7 +2385,12 @@ public virtual Task GetDataFrameAnalyticsAsync - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -1578,7 +2402,12 @@ public virtual Task GetDataFrameAnalyticsAsync - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsAsync(GetDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1588,7 +2417,12 @@ public virtual Task GetDataFrameAnalyticsAsync(Ge } /// - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id? id, CancellationToken cancellationToken = default) @@ -1599,7 +2433,12 @@ public virtual Task GetDataFrameAnalyticsAsync(El } /// - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id? id, Action configureRequest, CancellationToken cancellationToken = default) @@ -1611,7 +2450,12 @@ public virtual Task GetDataFrameAnalyticsAsync(El } /// - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsAsync(CancellationToken cancellationToken = default) @@ -1622,7 +2466,12 @@ public virtual Task GetDataFrameAnalyticsAsync(Ca } /// - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -1634,7 +2483,9 @@ public virtual Task GetDataFrameAnalyticsAsync(Ac } /// - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsStatsAsync(GetDataFrameAnalyticsStatsRequest request, CancellationToken cancellationToken = default) @@ -1644,7 +2495,9 @@ public virtual Task GetDataFrameAnalyticsSta } /// - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsStatsAsync(GetDataFrameAnalyticsStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1654,7 +2507,9 @@ public virtual Task GetDataFrameAnalyticsSta } /// - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsStatsAsync(Elastic.Clients.Elasticsearch.Serverless.Id? id, CancellationToken cancellationToken = default) @@ -1665,7 +2520,9 @@ public virtual Task GetDataFrameAnalyticsSta } /// - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsStatsAsync(Elastic.Clients.Elasticsearch.Serverless.Id? id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1677,7 +2534,9 @@ public virtual Task GetDataFrameAnalyticsSta } /// - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsStatsAsync(CancellationToken cancellationToken = default) @@ -1688,7 +2547,9 @@ public virtual Task GetDataFrameAnalyticsSta } /// - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsStatsAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -1700,7 +2561,9 @@ public virtual Task GetDataFrameAnalyticsSta } /// - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsStatsAsync(GetDataFrameAnalyticsStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1710,7 +2573,9 @@ public virtual Task GetDataFrameAnalyticsSta } /// - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsStatsAsync(Elastic.Clients.Elasticsearch.Serverless.Id? id, CancellationToken cancellationToken = default) @@ -1721,7 +2586,9 @@ public virtual Task GetDataFrameAnalyticsSta } /// - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsStatsAsync(Elastic.Clients.Elasticsearch.Serverless.Id? id, Action configureRequest, CancellationToken cancellationToken = default) @@ -1733,7 +2600,9 @@ public virtual Task GetDataFrameAnalyticsSta } /// - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsStatsAsync(CancellationToken cancellationToken = default) @@ -1744,7 +2613,9 @@ public virtual Task GetDataFrameAnalyticsSta } /// - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsStatsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -1756,7 +2627,10 @@ public virtual Task GetDataFrameAnalyticsSta } /// - /// Retrieves filters.
You can get a single filter or all filters. + /// + /// Retrieves filters. + /// You can get a single filter or all filters. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetFiltersAsync(GetFiltersRequest request, CancellationToken cancellationToken = default) @@ -1766,7 +2640,10 @@ public virtual Task GetFiltersAsync(GetFiltersRequest reques } /// - /// Retrieves filters.
You can get a single filter or all filters. + /// + /// Retrieves filters. + /// You can get a single filter or all filters. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetFiltersAsync(GetFiltersRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1776,7 +2653,10 @@ public virtual Task GetFiltersAsync(GetFiltersRequestDescrip } /// - /// Retrieves filters.
You can get a single filter or all filters. + /// + /// Retrieves filters. + /// You can get a single filter or all filters. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetFiltersAsync(Elastic.Clients.Elasticsearch.Serverless.Ids? filterId, CancellationToken cancellationToken = default) @@ -1787,7 +2667,10 @@ public virtual Task GetFiltersAsync(Elastic.Clients.Elastics } /// - /// Retrieves filters.
You can get a single filter or all filters. + /// + /// Retrieves filters. + /// You can get a single filter or all filters. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetFiltersAsync(Elastic.Clients.Elasticsearch.Serverless.Ids? filterId, Action configureRequest, CancellationToken cancellationToken = default) @@ -1799,7 +2682,10 @@ public virtual Task GetFiltersAsync(Elastic.Clients.Elastics } /// - /// Retrieves filters.
You can get a single filter or all filters. + /// + /// Retrieves filters. + /// You can get a single filter or all filters. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetFiltersAsync(CancellationToken cancellationToken = default) @@ -1810,7 +2696,10 @@ public virtual Task GetFiltersAsync(CancellationToken cancel } /// - /// Retrieves filters.
You can get a single filter or all filters. + /// + /// Retrieves filters. + /// You can get a single filter or all filters. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetFiltersAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -1822,7 +2711,12 @@ public virtual Task GetFiltersAsync(Action - /// Retrieves anomaly detection job results for one or more influencers.
Influencers are the entities that have contributed to, or are to blame for,
the anomalies. Influencer results are available only if an
`influencer_field_name` is specified in the job configuration. + /// + /// Retrieves anomaly detection job results for one or more influencers. + /// Influencers are the entities that have contributed to, or are to blame for, + /// the anomalies. Influencer results are available only if an + /// influencer_field_name is specified in the job configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetInfluencersAsync(GetInfluencersRequest request, CancellationToken cancellationToken = default) @@ -1832,7 +2726,12 @@ public virtual Task GetInfluencersAsync(GetInfluencersRe } /// - /// Retrieves anomaly detection job results for one or more influencers.
Influencers are the entities that have contributed to, or are to blame for,
the anomalies. Influencer results are available only if an
`influencer_field_name` is specified in the job configuration. + /// + /// Retrieves anomaly detection job results for one or more influencers. + /// Influencers are the entities that have contributed to, or are to blame for, + /// the anomalies. Influencer results are available only if an + /// influencer_field_name is specified in the job configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetInfluencersAsync(GetInfluencersRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1842,7 +2741,12 @@ public virtual Task GetInfluencersAsync(GetIn } /// - /// Retrieves anomaly detection job results for one or more influencers.
Influencers are the entities that have contributed to, or are to blame for,
the anomalies. Influencer results are available only if an
`influencer_field_name` is specified in the job configuration. + /// + /// Retrieves anomaly detection job results for one or more influencers. + /// Influencers are the entities that have contributed to, or are to blame for, + /// the anomalies. Influencer results are available only if an + /// influencer_field_name is specified in the job configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetInfluencersAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, CancellationToken cancellationToken = default) @@ -1853,7 +2757,12 @@ public virtual Task GetInfluencersAsync(Elast } /// - /// Retrieves anomaly detection job results for one or more influencers.
Influencers are the entities that have contributed to, or are to blame for,
the anomalies. Influencer results are available only if an
`influencer_field_name` is specified in the job configuration. + /// + /// Retrieves anomaly detection job results for one or more influencers. + /// Influencers are the entities that have contributed to, or are to blame for, + /// the anomalies. Influencer results are available only if an + /// influencer_field_name is specified in the job configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetInfluencersAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1865,7 +2774,12 @@ public virtual Task GetInfluencersAsync(Elast } /// - /// Retrieves anomaly detection job results for one or more influencers.
Influencers are the entities that have contributed to, or are to blame for,
the anomalies. Influencer results are available only if an
`influencer_field_name` is specified in the job configuration. + /// + /// Retrieves anomaly detection job results for one or more influencers. + /// Influencers are the entities that have contributed to, or are to blame for, + /// the anomalies. Influencer results are available only if an + /// influencer_field_name is specified in the job configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetInfluencersAsync(GetInfluencersRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1875,7 +2789,12 @@ public virtual Task GetInfluencersAsync(GetInfluencersRe } /// - /// Retrieves anomaly detection job results for one or more influencers.
Influencers are the entities that have contributed to, or are to blame for,
the anomalies. Influencer results are available only if an
`influencer_field_name` is specified in the job configuration. + /// + /// Retrieves anomaly detection job results for one or more influencers. + /// Influencers are the entities that have contributed to, or are to blame for, + /// the anomalies. Influencer results are available only if an + /// influencer_field_name is specified in the job configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetInfluencersAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, CancellationToken cancellationToken = default) @@ -1886,7 +2805,12 @@ public virtual Task GetInfluencersAsync(Elastic.Clients. } /// - /// Retrieves anomaly detection job results for one or more influencers.
Influencers are the entities that have contributed to, or are to blame for,
the anomalies. Influencer results are available only if an
`influencer_field_name` is specified in the job configuration. + /// + /// Retrieves anomaly detection job results for one or more influencers. + /// Influencers are the entities that have contributed to, or are to blame for, + /// the anomalies. Influencer results are available only if an + /// influencer_field_name is specified in the job configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetInfluencersAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -1898,7 +2822,13 @@ public virtual Task GetInfluencersAsync(Elastic.Clients. } /// - /// Retrieves configuration information for anomaly detection jobs.
You can get information for multiple anomaly detection jobs in a single API
request by using a group name, a comma-separated list of jobs, or a wildcard
expression. You can get information for all anomaly detection jobs by using
`_all`, by specifying `*` as the ``, or by omitting the ``. + /// + /// Retrieves configuration information for anomaly detection jobs. + /// You can get information for multiple anomaly detection jobs in a single API + /// request by using a group name, a comma-separated list of jobs, or a wildcard + /// expression. You can get information for all anomaly detection jobs by using + /// _all, by specifying * as the <job_id>, or by omitting the <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobsAsync(GetJobsRequest request, CancellationToken cancellationToken = default) @@ -1908,7 +2838,13 @@ public virtual Task GetJobsAsync(GetJobsRequest request, Cancel } /// - /// Retrieves configuration information for anomaly detection jobs.
You can get information for multiple anomaly detection jobs in a single API
request by using a group name, a comma-separated list of jobs, or a wildcard
expression. You can get information for all anomaly detection jobs by using
`_all`, by specifying `*` as the ``, or by omitting the ``. + /// + /// Retrieves configuration information for anomaly detection jobs. + /// You can get information for multiple anomaly detection jobs in a single API + /// request by using a group name, a comma-separated list of jobs, or a wildcard + /// expression. You can get information for all anomaly detection jobs by using + /// _all, by specifying * as the <job_id>, or by omitting the <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobsAsync(GetJobsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1918,7 +2854,13 @@ public virtual Task GetJobsAsync(GetJobsRequestDescriptor descr } /// - /// Retrieves configuration information for anomaly detection jobs.
You can get information for multiple anomaly detection jobs in a single API
request by using a group name, a comma-separated list of jobs, or a wildcard
expression. You can get information for all anomaly detection jobs by using
`_all`, by specifying `*` as the ``, or by omitting the ``. + /// + /// Retrieves configuration information for anomaly detection jobs. + /// You can get information for multiple anomaly detection jobs in a single API + /// request by using a group name, a comma-separated list of jobs, or a wildcard + /// expression. You can get information for all anomaly detection jobs by using + /// _all, by specifying * as the <job_id>, or by omitting the <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobsAsync(Elastic.Clients.Elasticsearch.Serverless.Ids? jobId, CancellationToken cancellationToken = default) @@ -1929,7 +2871,13 @@ public virtual Task GetJobsAsync(Elastic.Clients.Elasticsearch. } /// - /// Retrieves configuration information for anomaly detection jobs.
You can get information for multiple anomaly detection jobs in a single API
request by using a group name, a comma-separated list of jobs, or a wildcard
expression. You can get information for all anomaly detection jobs by using
`_all`, by specifying `*` as the ``, or by omitting the ``. + /// + /// Retrieves configuration information for anomaly detection jobs. + /// You can get information for multiple anomaly detection jobs in a single API + /// request by using a group name, a comma-separated list of jobs, or a wildcard + /// expression. You can get information for all anomaly detection jobs by using + /// _all, by specifying * as the <job_id>, or by omitting the <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobsAsync(Elastic.Clients.Elasticsearch.Serverless.Ids? jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -1941,7 +2889,13 @@ public virtual Task GetJobsAsync(Elastic.Clients.Elasticsearch. } /// - /// Retrieves configuration information for anomaly detection jobs.
You can get information for multiple anomaly detection jobs in a single API
request by using a group name, a comma-separated list of jobs, or a wildcard
expression. You can get information for all anomaly detection jobs by using
`_all`, by specifying `*` as the ``, or by omitting the ``. + /// + /// Retrieves configuration information for anomaly detection jobs. + /// You can get information for multiple anomaly detection jobs in a single API + /// request by using a group name, a comma-separated list of jobs, or a wildcard + /// expression. You can get information for all anomaly detection jobs by using + /// _all, by specifying * as the <job_id>, or by omitting the <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobsAsync(CancellationToken cancellationToken = default) @@ -1952,7 +2906,13 @@ public virtual Task GetJobsAsync(CancellationToken cancellation } /// - /// Retrieves configuration information for anomaly detection jobs.
You can get information for multiple anomaly detection jobs in a single API
request by using a group name, a comma-separated list of jobs, or a wildcard
expression. You can get information for all anomaly detection jobs by using
`_all`, by specifying `*` as the ``, or by omitting the ``. + /// + /// Retrieves configuration information for anomaly detection jobs. + /// You can get information for multiple anomaly detection jobs in a single API + /// request by using a group name, a comma-separated list of jobs, or a wildcard + /// expression. You can get information for all anomaly detection jobs by using + /// _all, by specifying * as the <job_id>, or by omitting the <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -1964,7 +2924,9 @@ public virtual Task GetJobsAsync(Action - /// Retrieves usage information for anomaly detection jobs. + /// + /// Retrieves usage information for anomaly detection jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobStatsAsync(GetJobStatsRequest request, CancellationToken cancellationToken = default) @@ -1974,7 +2936,9 @@ public virtual Task GetJobStatsAsync(GetJobStatsRequest req } /// - /// Retrieves usage information for anomaly detection jobs. + /// + /// Retrieves usage information for anomaly detection jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobStatsAsync(GetJobStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1984,7 +2948,9 @@ public virtual Task GetJobStatsAsync(GetJobStatsRequestDesc } /// - /// Retrieves usage information for anomaly detection jobs. + /// + /// Retrieves usage information for anomaly detection jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobStatsAsync(Elastic.Clients.Elasticsearch.Serverless.Id? jobId, CancellationToken cancellationToken = default) @@ -1995,7 +2961,9 @@ public virtual Task GetJobStatsAsync(Elastic.Clients.Elasti } /// - /// Retrieves usage information for anomaly detection jobs. + /// + /// Retrieves usage information for anomaly detection jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobStatsAsync(Elastic.Clients.Elasticsearch.Serverless.Id? jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -2007,7 +2975,9 @@ public virtual Task GetJobStatsAsync(Elastic.Clients.Elasti } /// - /// Retrieves usage information for anomaly detection jobs. + /// + /// Retrieves usage information for anomaly detection jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobStatsAsync(CancellationToken cancellationToken = default) @@ -2018,7 +2988,9 @@ public virtual Task GetJobStatsAsync(CancellationToken canc } /// - /// Retrieves usage information for anomaly detection jobs. + /// + /// Retrieves usage information for anomaly detection jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobStatsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -2030,7 +3002,10 @@ public virtual Task GetJobStatsAsync(Action - /// Get information about how machine learning jobs and trained models are using memory,
on each node, both within the JVM heap, and natively, outside of the JVM. + /// + /// Get information about how machine learning jobs and trained models are using memory, + /// on each node, both within the JVM heap, and natively, outside of the JVM. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMemoryStatsAsync(GetMemoryStatsRequest request, CancellationToken cancellationToken = default) @@ -2040,7 +3015,10 @@ public virtual Task GetMemoryStatsAsync(GetMemoryStatsRe } /// - /// Get information about how machine learning jobs and trained models are using memory,
on each node, both within the JVM heap, and natively, outside of the JVM. + /// + /// Get information about how machine learning jobs and trained models are using memory, + /// on each node, both within the JVM heap, and natively, outside of the JVM. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMemoryStatsAsync(GetMemoryStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2050,7 +3028,10 @@ public virtual Task GetMemoryStatsAsync(GetMemoryStatsRe } /// - /// Get information about how machine learning jobs and trained models are using memory,
on each node, both within the JVM heap, and natively, outside of the JVM. + /// + /// Get information about how machine learning jobs and trained models are using memory, + /// on each node, both within the JVM heap, and natively, outside of the JVM. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMemoryStatsAsync(Elastic.Clients.Elasticsearch.Serverless.Id? nodeId, CancellationToken cancellationToken = default) @@ -2061,7 +3042,10 @@ public virtual Task GetMemoryStatsAsync(Elastic.Clients. } /// - /// Get information about how machine learning jobs and trained models are using memory,
on each node, both within the JVM heap, and natively, outside of the JVM. + /// + /// Get information about how machine learning jobs and trained models are using memory, + /// on each node, both within the JVM heap, and natively, outside of the JVM. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMemoryStatsAsync(Elastic.Clients.Elasticsearch.Serverless.Id? nodeId, Action configureRequest, CancellationToken cancellationToken = default) @@ -2073,7 +3057,10 @@ public virtual Task GetMemoryStatsAsync(Elastic.Clients. } /// - /// Get information about how machine learning jobs and trained models are using memory,
on each node, both within the JVM heap, and natively, outside of the JVM. + /// + /// Get information about how machine learning jobs and trained models are using memory, + /// on each node, both within the JVM heap, and natively, outside of the JVM. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMemoryStatsAsync(CancellationToken cancellationToken = default) @@ -2084,7 +3071,10 @@ public virtual Task GetMemoryStatsAsync(CancellationToke } /// - /// Get information about how machine learning jobs and trained models are using memory,
on each node, both within the JVM heap, and natively, outside of the JVM. + /// + /// Get information about how machine learning jobs and trained models are using memory, + /// on each node, both within the JVM heap, and natively, outside of the JVM. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMemoryStatsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -2096,7 +3086,9 @@ public virtual Task GetMemoryStatsAsync(Action - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetModelSnapshotsAsync(GetModelSnapshotsRequest request, CancellationToken cancellationToken = default) @@ -2106,7 +3098,9 @@ public virtual Task GetModelSnapshotsAsync(GetModelSn } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetModelSnapshotsAsync(GetModelSnapshotsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2116,7 +3110,9 @@ public virtual Task GetModelSnapshotsAsync } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetModelSnapshotsAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Elastic.Clients.Elasticsearch.Serverless.Id? snapshotId, CancellationToken cancellationToken = default) @@ -2127,7 +3123,9 @@ public virtual Task GetModelSnapshotsAsync } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetModelSnapshotsAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Elastic.Clients.Elasticsearch.Serverless.Id? snapshotId, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2139,7 +3137,9 @@ public virtual Task GetModelSnapshotsAsync } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetModelSnapshotsAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, CancellationToken cancellationToken = default) @@ -2150,7 +3150,9 @@ public virtual Task GetModelSnapshotsAsync } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetModelSnapshotsAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2162,7 +3164,9 @@ public virtual Task GetModelSnapshotsAsync } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetModelSnapshotsAsync(GetModelSnapshotsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2172,7 +3176,9 @@ public virtual Task GetModelSnapshotsAsync(GetModelSn } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetModelSnapshotsAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Elastic.Clients.Elasticsearch.Serverless.Id? snapshotId, CancellationToken cancellationToken = default) @@ -2183,7 +3189,9 @@ public virtual Task GetModelSnapshotsAsync(Elastic.Cl } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetModelSnapshotsAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Elastic.Clients.Elasticsearch.Serverless.Id? snapshotId, Action configureRequest, CancellationToken cancellationToken = default) @@ -2195,7 +3203,9 @@ public virtual Task GetModelSnapshotsAsync(Elastic.Cl } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetModelSnapshotsAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, CancellationToken cancellationToken = default) @@ -2206,7 +3216,9 @@ public virtual Task GetModelSnapshotsAsync(Elastic.Cl } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetModelSnapshotsAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -2218,7 +3230,9 @@ public virtual Task GetModelSnapshotsAsync(Elastic.Cl } /// - /// Retrieves usage information for anomaly detection job model snapshot upgrades. + /// + /// Retrieves usage information for anomaly detection job model snapshot upgrades. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetModelSnapshotUpgradeStatsAsync(GetModelSnapshotUpgradeStatsRequest request, CancellationToken cancellationToken = default) @@ -2228,7 +3242,9 @@ public virtual Task GetModelSnapshotUpgrad } /// - /// Retrieves usage information for anomaly detection job model snapshot upgrades. + /// + /// Retrieves usage information for anomaly detection job model snapshot upgrades. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetModelSnapshotUpgradeStatsAsync(GetModelSnapshotUpgradeStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2238,7 +3254,9 @@ public virtual Task GetModelSnapshotUpgrad } /// - /// Retrieves usage information for anomaly detection job model snapshot upgrades. + /// + /// Retrieves usage information for anomaly detection job model snapshot upgrades. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetModelSnapshotUpgradeStatsAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Elastic.Clients.Elasticsearch.Serverless.Id snapshotId, CancellationToken cancellationToken = default) @@ -2249,7 +3267,9 @@ public virtual Task GetModelSnapshotUpgrad } /// - /// Retrieves usage information for anomaly detection job model snapshot upgrades. + /// + /// Retrieves usage information for anomaly detection job model snapshot upgrades. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetModelSnapshotUpgradeStatsAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Elastic.Clients.Elasticsearch.Serverless.Id snapshotId, Action configureRequest, CancellationToken cancellationToken = default) @@ -2261,8 +3281,26 @@ public virtual Task GetModelSnapshotUpgrad } /// - /// Retrieves overall bucket results that summarize the bucket results of
multiple anomaly detection jobs. - /// The `overall_score` is calculated by combining the scores of all the
buckets within the overall bucket span. First, the maximum
`anomaly_score` per anomaly detection job in the overall bucket is
calculated. Then the `top_n` of those scores are averaged to result in
the `overall_score`. This means that you can fine-tune the
`overall_score` so that it is more or less sensitive to the number of
jobs that detect an anomaly at the same time. For example, if you set
`top_n` to `1`, the `overall_score` is the maximum bucket score in the
overall bucket. Alternatively, if you set `top_n` to the number of jobs,
the `overall_score` is high only when all jobs detect anomalies in that
overall bucket. If you set the `bucket_span` parameter (to a value
greater than its default), the `overall_score` is the maximum
`overall_score` of the overall buckets that have a span equal to the
jobs' largest bucket span. + /// + /// Retrieves overall bucket results that summarize the bucket results of + /// multiple anomaly detection jobs. + /// + /// + /// The overall_score is calculated by combining the scores of all the + /// buckets within the overall bucket span. First, the maximum + /// anomaly_score per anomaly detection job in the overall bucket is + /// calculated. Then the top_n of those scores are averaged to result in + /// the overall_score. This means that you can fine-tune the + /// overall_score so that it is more or less sensitive to the number of + /// jobs that detect an anomaly at the same time. For example, if you set + /// top_n to 1, the overall_score is the maximum bucket score in the + /// overall bucket. Alternatively, if you set top_n to the number of jobs, + /// the overall_score is high only when all jobs detect anomalies in that + /// overall bucket. If you set the bucket_span parameter (to a value + /// greater than its default), the overall_score is the maximum + /// overall_score of the overall buckets that have a span equal to the + /// jobs' largest bucket span. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetOverallBucketsAsync(GetOverallBucketsRequest request, CancellationToken cancellationToken = default) @@ -2272,8 +3310,26 @@ public virtual Task GetOverallBucketsAsync(GetOverall } /// - /// Retrieves overall bucket results that summarize the bucket results of
multiple anomaly detection jobs. - /// The `overall_score` is calculated by combining the scores of all the
buckets within the overall bucket span. First, the maximum
`anomaly_score` per anomaly detection job in the overall bucket is
calculated. Then the `top_n` of those scores are averaged to result in
the `overall_score`. This means that you can fine-tune the
`overall_score` so that it is more or less sensitive to the number of
jobs that detect an anomaly at the same time. For example, if you set
`top_n` to `1`, the `overall_score` is the maximum bucket score in the
overall bucket. Alternatively, if you set `top_n` to the number of jobs,
the `overall_score` is high only when all jobs detect anomalies in that
overall bucket. If you set the `bucket_span` parameter (to a value
greater than its default), the `overall_score` is the maximum
`overall_score` of the overall buckets that have a span equal to the
jobs' largest bucket span. + /// + /// Retrieves overall bucket results that summarize the bucket results of + /// multiple anomaly detection jobs. + /// + /// + /// The overall_score is calculated by combining the scores of all the + /// buckets within the overall bucket span. First, the maximum + /// anomaly_score per anomaly detection job in the overall bucket is + /// calculated. Then the top_n of those scores are averaged to result in + /// the overall_score. This means that you can fine-tune the + /// overall_score so that it is more or less sensitive to the number of + /// jobs that detect an anomaly at the same time. For example, if you set + /// top_n to 1, the overall_score is the maximum bucket score in the + /// overall bucket. Alternatively, if you set top_n to the number of jobs, + /// the overall_score is high only when all jobs detect anomalies in that + /// overall bucket. If you set the bucket_span parameter (to a value + /// greater than its default), the overall_score is the maximum + /// overall_score of the overall buckets that have a span equal to the + /// jobs' largest bucket span. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetOverallBucketsAsync(GetOverallBucketsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2283,8 +3339,26 @@ public virtual Task GetOverallBucketsAsync(GetOverall } /// - /// Retrieves overall bucket results that summarize the bucket results of
multiple anomaly detection jobs. - /// The `overall_score` is calculated by combining the scores of all the
buckets within the overall bucket span. First, the maximum
`anomaly_score` per anomaly detection job in the overall bucket is
calculated. Then the `top_n` of those scores are averaged to result in
the `overall_score`. This means that you can fine-tune the
`overall_score` so that it is more or less sensitive to the number of
jobs that detect an anomaly at the same time. For example, if you set
`top_n` to `1`, the `overall_score` is the maximum bucket score in the
overall bucket. Alternatively, if you set `top_n` to the number of jobs,
the `overall_score` is high only when all jobs detect anomalies in that
overall bucket. If you set the `bucket_span` parameter (to a value
greater than its default), the `overall_score` is the maximum
`overall_score` of the overall buckets that have a span equal to the
jobs' largest bucket span. + /// + /// Retrieves overall bucket results that summarize the bucket results of + /// multiple anomaly detection jobs. + /// + /// + /// The overall_score is calculated by combining the scores of all the + /// buckets within the overall bucket span. First, the maximum + /// anomaly_score per anomaly detection job in the overall bucket is + /// calculated. Then the top_n of those scores are averaged to result in + /// the overall_score. This means that you can fine-tune the + /// overall_score so that it is more or less sensitive to the number of + /// jobs that detect an anomaly at the same time. For example, if you set + /// top_n to 1, the overall_score is the maximum bucket score in the + /// overall bucket. Alternatively, if you set top_n to the number of jobs, + /// the overall_score is high only when all jobs detect anomalies in that + /// overall bucket. If you set the bucket_span parameter (to a value + /// greater than its default), the overall_score is the maximum + /// overall_score of the overall buckets that have a span equal to the + /// jobs' largest bucket span. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetOverallBucketsAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, CancellationToken cancellationToken = default) @@ -2295,8 +3369,26 @@ public virtual Task GetOverallBucketsAsync(Elastic.Cl } /// - /// Retrieves overall bucket results that summarize the bucket results of
multiple anomaly detection jobs. - /// The `overall_score` is calculated by combining the scores of all the
buckets within the overall bucket span. First, the maximum
`anomaly_score` per anomaly detection job in the overall bucket is
calculated. Then the `top_n` of those scores are averaged to result in
the `overall_score`. This means that you can fine-tune the
`overall_score` so that it is more or less sensitive to the number of
jobs that detect an anomaly at the same time. For example, if you set
`top_n` to `1`, the `overall_score` is the maximum bucket score in the
overall bucket. Alternatively, if you set `top_n` to the number of jobs,
the `overall_score` is high only when all jobs detect anomalies in that
overall bucket. If you set the `bucket_span` parameter (to a value
greater than its default), the `overall_score` is the maximum
`overall_score` of the overall buckets that have a span equal to the
jobs' largest bucket span. + /// + /// Retrieves overall bucket results that summarize the bucket results of + /// multiple anomaly detection jobs. + /// + /// + /// The overall_score is calculated by combining the scores of all the + /// buckets within the overall bucket span. First, the maximum + /// anomaly_score per anomaly detection job in the overall bucket is + /// calculated. Then the top_n of those scores are averaged to result in + /// the overall_score. This means that you can fine-tune the + /// overall_score so that it is more or less sensitive to the number of + /// jobs that detect an anomaly at the same time. For example, if you set + /// top_n to 1, the overall_score is the maximum bucket score in the + /// overall bucket. Alternatively, if you set top_n to the number of jobs, + /// the overall_score is high only when all jobs detect anomalies in that + /// overall bucket. If you set the bucket_span parameter (to a value + /// greater than its default), the overall_score is the maximum + /// overall_score of the overall buckets that have a span equal to the + /// jobs' largest bucket span. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetOverallBucketsAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -2308,7 +3400,19 @@ public virtual Task GetOverallBucketsAsync(Elastic.Cl } /// - /// Retrieves anomaly records for an anomaly detection job.
Records contain the detailed analytical results. They describe the anomalous
activity that has been identified in the input data based on the detector
configuration.
There can be many anomaly records depending on the characteristics and size
of the input data. In practice, there are often too many to be able to
manually process them. The machine learning features therefore perform a
sophisticated aggregation of the anomaly records into buckets.
The number of record results depends on the number of anomalies found in each
bucket, which relates to the number of time series being modeled and the
number of detectors. + /// + /// Retrieves anomaly records for an anomaly detection job. + /// Records contain the detailed analytical results. They describe the anomalous + /// activity that has been identified in the input data based on the detector + /// configuration. + /// There can be many anomaly records depending on the characteristics and size + /// of the input data. In practice, there are often too many to be able to + /// manually process them. The machine learning features therefore perform a + /// sophisticated aggregation of the anomaly records into buckets. + /// The number of record results depends on the number of anomalies found in each + /// bucket, which relates to the number of time series being modeled and the + /// number of detectors. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRecordsAsync(GetRecordsRequest request, CancellationToken cancellationToken = default) @@ -2318,7 +3422,19 @@ public virtual Task GetRecordsAsync(GetRecordsRequest reques } /// - /// Retrieves anomaly records for an anomaly detection job.
Records contain the detailed analytical results. They describe the anomalous
activity that has been identified in the input data based on the detector
configuration.
There can be many anomaly records depending on the characteristics and size
of the input data. In practice, there are often too many to be able to
manually process them. The machine learning features therefore perform a
sophisticated aggregation of the anomaly records into buckets.
The number of record results depends on the number of anomalies found in each
bucket, which relates to the number of time series being modeled and the
number of detectors. + /// + /// Retrieves anomaly records for an anomaly detection job. + /// Records contain the detailed analytical results. They describe the anomalous + /// activity that has been identified in the input data based on the detector + /// configuration. + /// There can be many anomaly records depending on the characteristics and size + /// of the input data. In practice, there are often too many to be able to + /// manually process them. The machine learning features therefore perform a + /// sophisticated aggregation of the anomaly records into buckets. + /// The number of record results depends on the number of anomalies found in each + /// bucket, which relates to the number of time series being modeled and the + /// number of detectors. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRecordsAsync(GetRecordsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2328,7 +3444,19 @@ public virtual Task GetRecordsAsync(GetRecordsReq } /// - /// Retrieves anomaly records for an anomaly detection job.
Records contain the detailed analytical results. They describe the anomalous
activity that has been identified in the input data based on the detector
configuration.
There can be many anomaly records depending on the characteristics and size
of the input data. In practice, there are often too many to be able to
manually process them. The machine learning features therefore perform a
sophisticated aggregation of the anomaly records into buckets.
The number of record results depends on the number of anomalies found in each
bucket, which relates to the number of time series being modeled and the
number of detectors. + /// + /// Retrieves anomaly records for an anomaly detection job. + /// Records contain the detailed analytical results. They describe the anomalous + /// activity that has been identified in the input data based on the detector + /// configuration. + /// There can be many anomaly records depending on the characteristics and size + /// of the input data. In practice, there are often too many to be able to + /// manually process them. The machine learning features therefore perform a + /// sophisticated aggregation of the anomaly records into buckets. + /// The number of record results depends on the number of anomalies found in each + /// bucket, which relates to the number of time series being modeled and the + /// number of detectors. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRecordsAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, CancellationToken cancellationToken = default) @@ -2339,7 +3467,19 @@ public virtual Task GetRecordsAsync(Elastic.Clien } /// - /// Retrieves anomaly records for an anomaly detection job.
Records contain the detailed analytical results. They describe the anomalous
activity that has been identified in the input data based on the detector
configuration.
There can be many anomaly records depending on the characteristics and size
of the input data. In practice, there are often too many to be able to
manually process them. The machine learning features therefore perform a
sophisticated aggregation of the anomaly records into buckets.
The number of record results depends on the number of anomalies found in each
bucket, which relates to the number of time series being modeled and the
number of detectors. + /// + /// Retrieves anomaly records for an anomaly detection job. + /// Records contain the detailed analytical results. They describe the anomalous + /// activity that has been identified in the input data based on the detector + /// configuration. + /// There can be many anomaly records depending on the characteristics and size + /// of the input data. In practice, there are often too many to be able to + /// manually process them. The machine learning features therefore perform a + /// sophisticated aggregation of the anomaly records into buckets. + /// The number of record results depends on the number of anomalies found in each + /// bucket, which relates to the number of time series being modeled and the + /// number of detectors. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRecordsAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2351,7 +3491,19 @@ public virtual Task GetRecordsAsync(Elastic.Clien } /// - /// Retrieves anomaly records for an anomaly detection job.
Records contain the detailed analytical results. They describe the anomalous
activity that has been identified in the input data based on the detector
configuration.
There can be many anomaly records depending on the characteristics and size
of the input data. In practice, there are often too many to be able to
manually process them. The machine learning features therefore perform a
sophisticated aggregation of the anomaly records into buckets.
The number of record results depends on the number of anomalies found in each
bucket, which relates to the number of time series being modeled and the
number of detectors. + /// + /// Retrieves anomaly records for an anomaly detection job. + /// Records contain the detailed analytical results. They describe the anomalous + /// activity that has been identified in the input data based on the detector + /// configuration. + /// There can be many anomaly records depending on the characteristics and size + /// of the input data. In practice, there are often too many to be able to + /// manually process them. The machine learning features therefore perform a + /// sophisticated aggregation of the anomaly records into buckets. + /// The number of record results depends on the number of anomalies found in each + /// bucket, which relates to the number of time series being modeled and the + /// number of detectors. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRecordsAsync(GetRecordsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2361,7 +3513,19 @@ public virtual Task GetRecordsAsync(GetRecordsRequestDescrip } /// - /// Retrieves anomaly records for an anomaly detection job.
Records contain the detailed analytical results. They describe the anomalous
activity that has been identified in the input data based on the detector
configuration.
There can be many anomaly records depending on the characteristics and size
of the input data. In practice, there are often too many to be able to
manually process them. The machine learning features therefore perform a
sophisticated aggregation of the anomaly records into buckets.
The number of record results depends on the number of anomalies found in each
bucket, which relates to the number of time series being modeled and the
number of detectors. + /// + /// Retrieves anomaly records for an anomaly detection job. + /// Records contain the detailed analytical results. They describe the anomalous + /// activity that has been identified in the input data based on the detector + /// configuration. + /// There can be many anomaly records depending on the characteristics and size + /// of the input data. In practice, there are often too many to be able to + /// manually process them. The machine learning features therefore perform a + /// sophisticated aggregation of the anomaly records into buckets. + /// The number of record results depends on the number of anomalies found in each + /// bucket, which relates to the number of time series being modeled and the + /// number of detectors. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRecordsAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, CancellationToken cancellationToken = default) @@ -2372,7 +3536,19 @@ public virtual Task GetRecordsAsync(Elastic.Clients.Elastics } /// - /// Retrieves anomaly records for an anomaly detection job.
Records contain the detailed analytical results. They describe the anomalous
activity that has been identified in the input data based on the detector
configuration.
There can be many anomaly records depending on the characteristics and size
of the input data. In practice, there are often too many to be able to
manually process them. The machine learning features therefore perform a
sophisticated aggregation of the anomaly records into buckets.
The number of record results depends on the number of anomalies found in each
bucket, which relates to the number of time series being modeled and the
number of detectors. + /// + /// Retrieves anomaly records for an anomaly detection job. + /// Records contain the detailed analytical results. They describe the anomalous + /// activity that has been identified in the input data based on the detector + /// configuration. + /// There can be many anomaly records depending on the characteristics and size + /// of the input data. In practice, there are often too many to be able to + /// manually process them. The machine learning features therefore perform a + /// sophisticated aggregation of the anomaly records into buckets. + /// The number of record results depends on the number of anomalies found in each + /// bucket, which relates to the number of time series being modeled and the + /// number of detectors. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRecordsAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -2384,7 +3560,9 @@ public virtual Task GetRecordsAsync(Elastic.Clients.Elastics } /// - /// Retrieves configuration information for a trained model. + /// + /// Retrieves configuration information for a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTrainedModelsAsync(GetTrainedModelsRequest request, CancellationToken cancellationToken = default) @@ -2394,7 +3572,9 @@ public virtual Task GetTrainedModelsAsync(GetTrainedMo } /// - /// Retrieves configuration information for a trained model. + /// + /// Retrieves configuration information for a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTrainedModelsAsync(GetTrainedModelsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2404,7 +3584,9 @@ public virtual Task GetTrainedModelsAsync(GetTrainedMo } /// - /// Retrieves configuration information for a trained model. + /// + /// Retrieves configuration information for a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTrainedModelsAsync(Elastic.Clients.Elasticsearch.Serverless.Ids? modelId, CancellationToken cancellationToken = default) @@ -2415,7 +3597,9 @@ public virtual Task GetTrainedModelsAsync(Elastic.Clie } /// - /// Retrieves configuration information for a trained model. + /// + /// Retrieves configuration information for a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTrainedModelsAsync(Elastic.Clients.Elasticsearch.Serverless.Ids? modelId, Action configureRequest, CancellationToken cancellationToken = default) @@ -2427,7 +3611,9 @@ public virtual Task GetTrainedModelsAsync(Elastic.Clie } /// - /// Retrieves configuration information for a trained model. + /// + /// Retrieves configuration information for a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTrainedModelsAsync(CancellationToken cancellationToken = default) @@ -2438,7 +3624,9 @@ public virtual Task GetTrainedModelsAsync(Cancellation } /// - /// Retrieves configuration information for a trained model. + /// + /// Retrieves configuration information for a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTrainedModelsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -2450,7 +3638,10 @@ public virtual Task GetTrainedModelsAsync(Action - /// Retrieves usage information for trained models. You can get usage information for multiple trained
models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// + /// Retrieves usage information for trained models. You can get usage information for multiple trained + /// models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTrainedModelsStatsAsync(GetTrainedModelsStatsRequest request, CancellationToken cancellationToken = default) @@ -2460,7 +3651,10 @@ public virtual Task GetTrainedModelsStatsAsync(Ge } /// - /// Retrieves usage information for trained models. You can get usage information for multiple trained
models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// + /// Retrieves usage information for trained models. You can get usage information for multiple trained + /// models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTrainedModelsStatsAsync(GetTrainedModelsStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2470,7 +3664,10 @@ public virtual Task GetTrainedModelsStatsAsync(Ge } /// - /// Retrieves usage information for trained models. You can get usage information for multiple trained
models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// + /// Retrieves usage information for trained models. You can get usage information for multiple trained + /// models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTrainedModelsStatsAsync(Elastic.Clients.Elasticsearch.Serverless.Ids? modelId, CancellationToken cancellationToken = default) @@ -2481,7 +3678,10 @@ public virtual Task GetTrainedModelsStatsAsync(El } /// - /// Retrieves usage information for trained models. You can get usage information for multiple trained
models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// + /// Retrieves usage information for trained models. You can get usage information for multiple trained + /// models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTrainedModelsStatsAsync(Elastic.Clients.Elasticsearch.Serverless.Ids? modelId, Action configureRequest, CancellationToken cancellationToken = default) @@ -2493,7 +3693,10 @@ public virtual Task GetTrainedModelsStatsAsync(El } /// - /// Retrieves usage information for trained models. You can get usage information for multiple trained
models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// + /// Retrieves usage information for trained models. You can get usage information for multiple trained + /// models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTrainedModelsStatsAsync(CancellationToken cancellationToken = default) @@ -2504,7 +3707,10 @@ public virtual Task GetTrainedModelsStatsAsync(Ca } /// - /// Retrieves usage information for trained models. You can get usage information for multiple trained
models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// + /// Retrieves usage information for trained models. You can get usage information for multiple trained + /// models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTrainedModelsStatsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -2516,7 +3722,9 @@ public virtual Task GetTrainedModelsStatsAsync(Ac } /// - /// Evaluates a trained model. + /// + /// Evaluates a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InferTrainedModelAsync(InferTrainedModelRequest request, CancellationToken cancellationToken = default) @@ -2526,7 +3734,9 @@ public virtual Task InferTrainedModelAsync(InferTrain } /// - /// Evaluates a trained model. + /// + /// Evaluates a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InferTrainedModelAsync(InferTrainedModelRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2536,7 +3746,9 @@ public virtual Task InferTrainedModelAsync } /// - /// Evaluates a trained model. + /// + /// Evaluates a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InferTrainedModelAsync(Elastic.Clients.Elasticsearch.Serverless.Id modelId, CancellationToken cancellationToken = default) @@ -2547,7 +3759,9 @@ public virtual Task InferTrainedModelAsync } /// - /// Evaluates a trained model. + /// + /// Evaluates a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InferTrainedModelAsync(Elastic.Clients.Elasticsearch.Serverless.Id modelId, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2559,7 +3773,9 @@ public virtual Task InferTrainedModelAsync } /// - /// Evaluates a trained model. + /// + /// Evaluates a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InferTrainedModelAsync(InferTrainedModelRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2569,7 +3785,9 @@ public virtual Task InferTrainedModelAsync(InferTrain } /// - /// Evaluates a trained model. + /// + /// Evaluates a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InferTrainedModelAsync(Elastic.Clients.Elasticsearch.Serverless.Id modelId, CancellationToken cancellationToken = default) @@ -2580,7 +3798,9 @@ public virtual Task InferTrainedModelAsync(Elastic.Cl } /// - /// Evaluates a trained model. + /// + /// Evaluates a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InferTrainedModelAsync(Elastic.Clients.Elasticsearch.Serverless.Id modelId, Action configureRequest, CancellationToken cancellationToken = default) @@ -2592,7 +3812,15 @@ public virtual Task InferTrainedModelAsync(Elastic.Cl } /// - /// Returns defaults and limits used by machine learning.
This endpoint is designed to be used by a user interface that needs to fully
understand machine learning configurations where some options are not
specified, meaning that the defaults should be used. This endpoint may be
used to find out what those defaults are. It also provides information about
the maximum size of machine learning jobs that could run in the current
cluster configuration. + /// + /// Returns defaults and limits used by machine learning. + /// This endpoint is designed to be used by a user interface that needs to fully + /// understand machine learning configurations where some options are not + /// specified, meaning that the defaults should be used. This endpoint may be + /// used to find out what those defaults are. It also provides information about + /// the maximum size of machine learning jobs that could run in the current + /// cluster configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(MlInfoRequest request, CancellationToken cancellationToken = default) @@ -2602,7 +3830,15 @@ public virtual Task InfoAsync(MlInfoRequest request, Cancellatio } /// - /// Returns defaults and limits used by machine learning.
This endpoint is designed to be used by a user interface that needs to fully
understand machine learning configurations where some options are not
specified, meaning that the defaults should be used. This endpoint may be
used to find out what those defaults are. It also provides information about
the maximum size of machine learning jobs that could run in the current
cluster configuration. + /// + /// Returns defaults and limits used by machine learning. + /// This endpoint is designed to be used by a user interface that needs to fully + /// understand machine learning configurations where some options are not + /// specified, meaning that the defaults should be used. This endpoint may be + /// used to find out what those defaults are. It also provides information about + /// the maximum size of machine learning jobs that could run in the current + /// cluster configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(MlInfoRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2612,7 +3848,15 @@ public virtual Task InfoAsync(MlInfoRequestDescriptor descriptor } /// - /// Returns defaults and limits used by machine learning.
This endpoint is designed to be used by a user interface that needs to fully
understand machine learning configurations where some options are not
specified, meaning that the defaults should be used. This endpoint may be
used to find out what those defaults are. It also provides information about
the maximum size of machine learning jobs that could run in the current
cluster configuration. + /// + /// Returns defaults and limits used by machine learning. + /// This endpoint is designed to be used by a user interface that needs to fully + /// understand machine learning configurations where some options are not + /// specified, meaning that the defaults should be used. This endpoint may be + /// used to find out what those defaults are. It also provides information about + /// the maximum size of machine learning jobs that could run in the current + /// cluster configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(CancellationToken cancellationToken = default) @@ -2623,7 +3867,15 @@ public virtual Task InfoAsync(CancellationToken cancellationToke } /// - /// Returns defaults and limits used by machine learning.
This endpoint is designed to be used by a user interface that needs to fully
understand machine learning configurations where some options are not
specified, meaning that the defaults should be used. This endpoint may be
used to find out what those defaults are. It also provides information about
the maximum size of machine learning jobs that could run in the current
cluster configuration. + /// + /// Returns defaults and limits used by machine learning. + /// This endpoint is designed to be used by a user interface that needs to fully + /// understand machine learning configurations where some options are not + /// specified, meaning that the defaults should be used. This endpoint may be + /// used to find out what those defaults are. It also provides information about + /// the maximum size of machine learning jobs that could run in the current + /// cluster configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -2635,7 +3887,16 @@ public virtual Task InfoAsync(Action co } /// - /// Open anomaly detection jobs.
An anomaly detection job must be opened in order for it to be ready to
receive and analyze data. It can be opened and closed multiple times
throughout its lifecycle.
When you open a new job, it starts with an empty model.
When you open an existing job, the most recent model state is automatically
loaded. The job is ready to resume its analysis from where it left off, once
new data is received. + /// + /// Open anomaly detection jobs. + /// An anomaly detection job must be opened in order for it to be ready to + /// receive and analyze data. It can be opened and closed multiple times + /// throughout its lifecycle. + /// When you open a new job, it starts with an empty model. + /// When you open an existing job, the most recent model state is automatically + /// loaded. The job is ready to resume its analysis from where it left off, once + /// new data is received. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenJobAsync(OpenJobRequest request, CancellationToken cancellationToken = default) @@ -2645,7 +3906,16 @@ public virtual Task OpenJobAsync(OpenJobRequest request, Cancel } /// - /// Open anomaly detection jobs.
An anomaly detection job must be opened in order for it to be ready to
receive and analyze data. It can be opened and closed multiple times
throughout its lifecycle.
When you open a new job, it starts with an empty model.
When you open an existing job, the most recent model state is automatically
loaded. The job is ready to resume its analysis from where it left off, once
new data is received. + /// + /// Open anomaly detection jobs. + /// An anomaly detection job must be opened in order for it to be ready to + /// receive and analyze data. It can be opened and closed multiple times + /// throughout its lifecycle. + /// When you open a new job, it starts with an empty model. + /// When you open an existing job, the most recent model state is automatically + /// loaded. The job is ready to resume its analysis from where it left off, once + /// new data is received. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenJobAsync(OpenJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2655,7 +3925,16 @@ public virtual Task OpenJobAsync(OpenJobRequestDescriptor descr } /// - /// Open anomaly detection jobs.
An anomaly detection job must be opened in order for it to be ready to
receive and analyze data. It can be opened and closed multiple times
throughout its lifecycle.
When you open a new job, it starts with an empty model.
When you open an existing job, the most recent model state is automatically
loaded. The job is ready to resume its analysis from where it left off, once
new data is received. + /// + /// Open anomaly detection jobs. + /// An anomaly detection job must be opened in order for it to be ready to + /// receive and analyze data. It can be opened and closed multiple times + /// throughout its lifecycle. + /// When you open a new job, it starts with an empty model. + /// When you open an existing job, the most recent model state is automatically + /// loaded. The job is ready to resume its analysis from where it left off, once + /// new data is received. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenJobAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, CancellationToken cancellationToken = default) @@ -2666,7 +3945,16 @@ public virtual Task OpenJobAsync(Elastic.Clients.Elasticsearch. } /// - /// Open anomaly detection jobs.
An anomaly detection job must be opened in order for it to be ready to
receive and analyze data. It can be opened and closed multiple times
throughout its lifecycle.
When you open a new job, it starts with an empty model.
When you open an existing job, the most recent model state is automatically
loaded. The job is ready to resume its analysis from where it left off, once
new data is received. + /// + /// Open anomaly detection jobs. + /// An anomaly detection job must be opened in order for it to be ready to + /// receive and analyze data. It can be opened and closed multiple times + /// throughout its lifecycle. + /// When you open a new job, it starts with an empty model. + /// When you open an existing job, the most recent model state is automatically + /// loaded. The job is ready to resume its analysis from where it left off, once + /// new data is received. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenJobAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -2678,7 +3966,9 @@ public virtual Task OpenJobAsync(Elastic.Clients.Elasticsearch. } /// - /// Adds scheduled events to a calendar. + /// + /// Adds scheduled events to a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostCalendarEventsAsync(PostCalendarEventsRequest request, CancellationToken cancellationToken = default) @@ -2688,7 +3978,9 @@ public virtual Task PostCalendarEventsAsync(PostCale } /// - /// Adds scheduled events to a calendar. + /// + /// Adds scheduled events to a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostCalendarEventsAsync(PostCalendarEventsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2698,7 +3990,9 @@ public virtual Task PostCalendarEventsAsync(PostCale } /// - /// Adds scheduled events to a calendar. + /// + /// Adds scheduled events to a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostCalendarEventsAsync(Elastic.Clients.Elasticsearch.Serverless.Id calendarId, CancellationToken cancellationToken = default) @@ -2709,7 +4003,9 @@ public virtual Task PostCalendarEventsAsync(Elastic. } /// - /// Adds scheduled events to a calendar. + /// + /// Adds scheduled events to a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostCalendarEventsAsync(Elastic.Clients.Elasticsearch.Serverless.Id calendarId, Action configureRequest, CancellationToken cancellationToken = default) @@ -2721,7 +4017,9 @@ public virtual Task PostCalendarEventsAsync(Elastic. } /// - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PreviewDataFrameAnalyticsAsync(PreviewDataFrameAnalyticsRequest request, CancellationToken cancellationToken = default) @@ -2731,7 +4029,9 @@ public virtual Task PreviewDataFrameAnalytics } /// - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PreviewDataFrameAnalyticsAsync(PreviewDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2741,7 +4041,9 @@ public virtual Task PreviewDataFrameAnalytics } /// - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PreviewDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id? id, CancellationToken cancellationToken = default) @@ -2752,7 +4054,9 @@ public virtual Task PreviewDataFrameAnalytics } /// - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PreviewDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id? id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2764,7 +4068,9 @@ public virtual Task PreviewDataFrameAnalytics } /// - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PreviewDataFrameAnalyticsAsync(CancellationToken cancellationToken = default) @@ -2775,7 +4081,9 @@ public virtual Task PreviewDataFrameAnalytics } /// - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PreviewDataFrameAnalyticsAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -2787,7 +4095,9 @@ public virtual Task PreviewDataFrameAnalytics } /// - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PreviewDataFrameAnalyticsAsync(PreviewDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2797,7 +4107,9 @@ public virtual Task PreviewDataFrameAnalytics } /// - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PreviewDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id? id, CancellationToken cancellationToken = default) @@ -2808,7 +4120,9 @@ public virtual Task PreviewDataFrameAnalytics } /// - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PreviewDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id? id, Action configureRequest, CancellationToken cancellationToken = default) @@ -2820,7 +4134,9 @@ public virtual Task PreviewDataFrameAnalytics } /// - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PreviewDataFrameAnalyticsAsync(CancellationToken cancellationToken = default) @@ -2831,7 +4147,9 @@ public virtual Task PreviewDataFrameAnalytics } /// - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PreviewDataFrameAnalyticsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -2843,7 +4161,9 @@ public virtual Task PreviewDataFrameAnalytics } /// - /// Creates a calendar. + /// + /// Creates a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutCalendarAsync(PutCalendarRequest request, CancellationToken cancellationToken = default) @@ -2853,7 +4173,9 @@ public virtual Task PutCalendarAsync(PutCalendarRequest req } /// - /// Creates a calendar. + /// + /// Creates a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutCalendarAsync(PutCalendarRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2863,7 +4185,9 @@ public virtual Task PutCalendarAsync(PutCalendarRequestDesc } /// - /// Creates a calendar. + /// + /// Creates a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutCalendarAsync(Elastic.Clients.Elasticsearch.Serverless.Id calendarId, CancellationToken cancellationToken = default) @@ -2874,7 +4198,9 @@ public virtual Task PutCalendarAsync(Elastic.Clients.Elasti } /// - /// Creates a calendar. + /// + /// Creates a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutCalendarAsync(Elastic.Clients.Elasticsearch.Serverless.Id calendarId, Action configureRequest, CancellationToken cancellationToken = default) @@ -2886,7 +4212,9 @@ public virtual Task PutCalendarAsync(Elastic.Clients.Elasti } /// - /// Adds an anomaly detection job to a calendar. + /// + /// Adds an anomaly detection job to a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutCalendarJobAsync(PutCalendarJobRequest request, CancellationToken cancellationToken = default) @@ -2896,7 +4224,9 @@ public virtual Task PutCalendarJobAsync(PutCalendarJobRe } /// - /// Adds an anomaly detection job to a calendar. + /// + /// Adds an anomaly detection job to a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutCalendarJobAsync(PutCalendarJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2906,7 +4236,9 @@ public virtual Task PutCalendarJobAsync(PutCalendarJobRe } /// - /// Adds an anomaly detection job to a calendar. + /// + /// Adds an anomaly detection job to a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutCalendarJobAsync(Elastic.Clients.Elasticsearch.Serverless.Id calendarId, Elastic.Clients.Elasticsearch.Serverless.Ids jobId, CancellationToken cancellationToken = default) @@ -2917,7 +4249,9 @@ public virtual Task PutCalendarJobAsync(Elastic.Clients. } /// - /// Adds an anomaly detection job to a calendar. + /// + /// Adds an anomaly detection job to a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutCalendarJobAsync(Elastic.Clients.Elasticsearch.Serverless.Id calendarId, Elastic.Clients.Elasticsearch.Serverless.Ids jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -2929,7 +4263,13 @@ public virtual Task PutCalendarJobAsync(Elastic.Clients. } /// - /// Instantiates a datafeed.
Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.
You can associate only one datafeed with each anomaly detection job.
The datafeed contains a query that runs at a defined interval (`frequency`).
If you are concerned about delayed data, you can add a delay (`query_delay') at each interval.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had
at the time of creation and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead.
You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. + /// + /// Instantiates a datafeed. + /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. + /// You can associate only one datafeed with each anomaly detection job. + /// The datafeed contains a query that runs at a defined interval (frequency). + /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDatafeedAsync(PutDatafeedRequest request, CancellationToken cancellationToken = default) @@ -2939,7 +4279,13 @@ public virtual Task PutDatafeedAsync(PutDatafeedRequest req } /// - /// Instantiates a datafeed.
Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.
You can associate only one datafeed with each anomaly detection job.
The datafeed contains a query that runs at a defined interval (`frequency`).
If you are concerned about delayed data, you can add a delay (`query_delay') at each interval.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had
at the time of creation and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead.
You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. + /// + /// Instantiates a datafeed. + /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. + /// You can associate only one datafeed with each anomaly detection job. + /// The datafeed contains a query that runs at a defined interval (frequency). + /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDatafeedAsync(PutDatafeedRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2949,7 +4295,13 @@ public virtual Task PutDatafeedAsync(PutDatafeed } /// - /// Instantiates a datafeed.
Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.
You can associate only one datafeed with each anomaly detection job.
The datafeed contains a query that runs at a defined interval (`frequency`).
If you are concerned about delayed data, you can add a delay (`query_delay') at each interval.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had
at the time of creation and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead.
You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. + /// + /// Instantiates a datafeed. + /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. + /// You can associate only one datafeed with each anomaly detection job. + /// The datafeed contains a query that runs at a defined interval (frequency). + /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDatafeedAsync(Elastic.Clients.Elasticsearch.Serverless.Id datafeedId, CancellationToken cancellationToken = default) @@ -2960,7 +4312,13 @@ public virtual Task PutDatafeedAsync(Elastic.Cli } /// - /// Instantiates a datafeed.
Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.
You can associate only one datafeed with each anomaly detection job.
The datafeed contains a query that runs at a defined interval (`frequency`).
If you are concerned about delayed data, you can add a delay (`query_delay') at each interval.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had
at the time of creation and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead.
You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. + /// + /// Instantiates a datafeed. + /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. + /// You can associate only one datafeed with each anomaly detection job. + /// The datafeed contains a query that runs at a defined interval (frequency). + /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDatafeedAsync(Elastic.Clients.Elasticsearch.Serverless.Id datafeedId, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2972,7 +4330,13 @@ public virtual Task PutDatafeedAsync(Elastic.Cli } /// - /// Instantiates a datafeed.
Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.
You can associate only one datafeed with each anomaly detection job.
The datafeed contains a query that runs at a defined interval (`frequency`).
If you are concerned about delayed data, you can add a delay (`query_delay') at each interval.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had
at the time of creation and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead.
You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. + /// + /// Instantiates a datafeed. + /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. + /// You can associate only one datafeed with each anomaly detection job. + /// The datafeed contains a query that runs at a defined interval (frequency). + /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDatafeedAsync(PutDatafeedRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2982,7 +4346,13 @@ public virtual Task PutDatafeedAsync(PutDatafeedRequestDesc } /// - /// Instantiates a datafeed.
Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.
You can associate only one datafeed with each anomaly detection job.
The datafeed contains a query that runs at a defined interval (`frequency`).
If you are concerned about delayed data, you can add a delay (`query_delay') at each interval.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had
at the time of creation and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead.
You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. + /// + /// Instantiates a datafeed. + /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. + /// You can associate only one datafeed with each anomaly detection job. + /// The datafeed contains a query that runs at a defined interval (frequency). + /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDatafeedAsync(Elastic.Clients.Elasticsearch.Serverless.Id datafeedId, CancellationToken cancellationToken = default) @@ -2993,7 +4363,13 @@ public virtual Task PutDatafeedAsync(Elastic.Clients.Elasti } /// - /// Instantiates a datafeed.
Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.
You can associate only one datafeed with each anomaly detection job.
The datafeed contains a query that runs at a defined interval (`frequency`).
If you are concerned about delayed data, you can add a delay (`query_delay') at each interval.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had
at the time of creation and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead.
You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. + /// + /// Instantiates a datafeed. + /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. + /// You can associate only one datafeed with each anomaly detection job. + /// The datafeed contains a query that runs at a defined interval (frequency). + /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDatafeedAsync(Elastic.Clients.Elasticsearch.Serverless.Id datafeedId, Action configureRequest, CancellationToken cancellationToken = default) @@ -3005,7 +4381,11 @@ public virtual Task PutDatafeedAsync(Elastic.Clients.Elasti } /// - /// Instantiates a data frame analytics job.
This API creates a data frame analytics job that performs an analysis on the
source indices and stores the outcome in a destination index. + /// + /// Instantiates a data frame analytics job. + /// This API creates a data frame analytics job that performs an analysis on the + /// source indices and stores the outcome in a destination index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataFrameAnalyticsAsync(PutDataFrameAnalyticsRequest request, CancellationToken cancellationToken = default) @@ -3015,7 +4395,11 @@ public virtual Task PutDataFrameAnalyticsAsync(Pu } /// - /// Instantiates a data frame analytics job.
This API creates a data frame analytics job that performs an analysis on the
source indices and stores the outcome in a destination index. + /// + /// Instantiates a data frame analytics job. + /// This API creates a data frame analytics job that performs an analysis on the + /// source indices and stores the outcome in a destination index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataFrameAnalyticsAsync(PutDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3025,7 +4409,11 @@ public virtual Task PutDataFrameAnalyticsAsync - /// Instantiates a data frame analytics job.
This API creates a data frame analytics job that performs an analysis on the
source indices and stores the outcome in a destination index. + /// + /// Instantiates a data frame analytics job. + /// This API creates a data frame analytics job that performs an analysis on the + /// source indices and stores the outcome in a destination index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -3036,7 +4424,11 @@ public virtual Task PutDataFrameAnalyticsAsync - /// Instantiates a data frame analytics job.
This API creates a data frame analytics job that performs an analysis on the
source indices and stores the outcome in a destination index. + /// + /// Instantiates a data frame analytics job. + /// This API creates a data frame analytics job that performs an analysis on the + /// source indices and stores the outcome in a destination index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3048,7 +4440,11 @@ public virtual Task PutDataFrameAnalyticsAsync - /// Instantiates a data frame analytics job.
This API creates a data frame analytics job that performs an analysis on the
source indices and stores the outcome in a destination index. + /// + /// Instantiates a data frame analytics job. + /// This API creates a data frame analytics job that performs an analysis on the + /// source indices and stores the outcome in a destination index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataFrameAnalyticsAsync(PutDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3058,7 +4454,11 @@ public virtual Task PutDataFrameAnalyticsAsync(Pu } /// - /// Instantiates a data frame analytics job.
This API creates a data frame analytics job that performs an analysis on the
source indices and stores the outcome in a destination index. + /// + /// Instantiates a data frame analytics job. + /// This API creates a data frame analytics job that performs an analysis on the + /// source indices and stores the outcome in a destination index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -3069,7 +4469,11 @@ public virtual Task PutDataFrameAnalyticsAsync(El } /// - /// Instantiates a data frame analytics job.
This API creates a data frame analytics job that performs an analysis on the
source indices and stores the outcome in a destination index. + /// + /// Instantiates a data frame analytics job. + /// This API creates a data frame analytics job that performs an analysis on the + /// source indices and stores the outcome in a destination index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -3081,7 +4485,11 @@ public virtual Task PutDataFrameAnalyticsAsync(El } /// - /// Instantiates a filter.
A filter contains a list of strings. It can be used by one or more anomaly detection jobs.
Specifically, filters are referenced in the `custom_rules` property of detector configuration objects. + /// + /// Instantiates a filter. + /// A filter contains a list of strings. It can be used by one or more anomaly detection jobs. + /// Specifically, filters are referenced in the custom_rules property of detector configuration objects. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutFilterAsync(PutFilterRequest request, CancellationToken cancellationToken = default) @@ -3091,7 +4499,11 @@ public virtual Task PutFilterAsync(PutFilterRequest request, } /// - /// Instantiates a filter.
A filter contains a list of strings. It can be used by one or more anomaly detection jobs.
Specifically, filters are referenced in the `custom_rules` property of detector configuration objects. + /// + /// Instantiates a filter. + /// A filter contains a list of strings. It can be used by one or more anomaly detection jobs. + /// Specifically, filters are referenced in the custom_rules property of detector configuration objects. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutFilterAsync(PutFilterRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3101,7 +4513,11 @@ public virtual Task PutFilterAsync(PutFilterRequestDescriptor } /// - /// Instantiates a filter.
A filter contains a list of strings. It can be used by one or more anomaly detection jobs.
Specifically, filters are referenced in the `custom_rules` property of detector configuration objects. + /// + /// Instantiates a filter. + /// A filter contains a list of strings. It can be used by one or more anomaly detection jobs. + /// Specifically, filters are referenced in the custom_rules property of detector configuration objects. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutFilterAsync(Elastic.Clients.Elasticsearch.Serverless.Id filterId, CancellationToken cancellationToken = default) @@ -3112,7 +4528,11 @@ public virtual Task PutFilterAsync(Elastic.Clients.Elasticsea } /// - /// Instantiates a filter.
A filter contains a list of strings. It can be used by one or more anomaly detection jobs.
Specifically, filters are referenced in the `custom_rules` property of detector configuration objects. + /// + /// Instantiates a filter. + /// A filter contains a list of strings. It can be used by one or more anomaly detection jobs. + /// Specifically, filters are referenced in the custom_rules property of detector configuration objects. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutFilterAsync(Elastic.Clients.Elasticsearch.Serverless.Id filterId, Action configureRequest, CancellationToken cancellationToken = default) @@ -3124,7 +4544,10 @@ public virtual Task PutFilterAsync(Elastic.Clients.Elasticsea } /// - /// Create an anomaly detection job.
If you include a `datafeed_config`, you must have read index privileges on the source index. + /// + /// Create an anomaly detection job. + /// If you include a datafeed_config, you must have read index privileges on the source index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutJobAsync(PutJobRequest request, CancellationToken cancellationToken = default) @@ -3134,7 +4557,10 @@ public virtual Task PutJobAsync(PutJobRequest request, Cancellat } /// - /// Create an anomaly detection job.
If you include a `datafeed_config`, you must have read index privileges on the source index. + /// + /// Create an anomaly detection job. + /// If you include a datafeed_config, you must have read index privileges on the source index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutJobAsync(PutJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3144,7 +4570,10 @@ public virtual Task PutJobAsync(PutJobRequestDescript } /// - /// Create an anomaly detection job.
If you include a `datafeed_config`, you must have read index privileges on the source index. + /// + /// Create an anomaly detection job. + /// If you include a datafeed_config, you must have read index privileges on the source index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutJobAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, CancellationToken cancellationToken = default) @@ -3155,7 +4584,10 @@ public virtual Task PutJobAsync(Elastic.Clients.Elast } /// - /// Create an anomaly detection job.
If you include a `datafeed_config`, you must have read index privileges on the source index. + /// + /// Create an anomaly detection job. + /// If you include a datafeed_config, you must have read index privileges on the source index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutJobAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3167,7 +4599,10 @@ public virtual Task PutJobAsync(Elastic.Clients.Elast } /// - /// Create an anomaly detection job.
If you include a `datafeed_config`, you must have read index privileges on the source index. + /// + /// Create an anomaly detection job. + /// If you include a datafeed_config, you must have read index privileges on the source index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutJobAsync(PutJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3177,7 +4612,10 @@ public virtual Task PutJobAsync(PutJobRequestDescriptor descript } /// - /// Create an anomaly detection job.
If you include a `datafeed_config`, you must have read index privileges on the source index. + /// + /// Create an anomaly detection job. + /// If you include a datafeed_config, you must have read index privileges on the source index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutJobAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, CancellationToken cancellationToken = default) @@ -3188,7 +4626,10 @@ public virtual Task PutJobAsync(Elastic.Clients.Elasticsearch.Se } /// - /// Create an anomaly detection job.
If you include a `datafeed_config`, you must have read index privileges on the source index. + /// + /// Create an anomaly detection job. + /// If you include a datafeed_config, you must have read index privileges on the source index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutJobAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -3200,7 +4641,9 @@ public virtual Task PutJobAsync(Elastic.Clients.Elasticsearch.Se } /// - /// Enables you to supply a trained model that is not created by data frame analytics. + /// + /// Enables you to supply a trained model that is not created by data frame analytics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelAsync(PutTrainedModelRequest request, CancellationToken cancellationToken = default) @@ -3210,7 +4653,9 @@ public virtual Task PutTrainedModelAsync(PutTrainedMode } /// - /// Enables you to supply a trained model that is not created by data frame analytics. + /// + /// Enables you to supply a trained model that is not created by data frame analytics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelAsync(PutTrainedModelRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3220,7 +4665,9 @@ public virtual Task PutTrainedModelAsync(Put } /// - /// Enables you to supply a trained model that is not created by data frame analytics. + /// + /// Enables you to supply a trained model that is not created by data frame analytics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelAsync(Elastic.Clients.Elasticsearch.Serverless.Id modelId, CancellationToken cancellationToken = default) @@ -3231,7 +4678,9 @@ public virtual Task PutTrainedModelAsync(Ela } /// - /// Enables you to supply a trained model that is not created by data frame analytics. + /// + /// Enables you to supply a trained model that is not created by data frame analytics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelAsync(Elastic.Clients.Elasticsearch.Serverless.Id modelId, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3243,7 +4692,9 @@ public virtual Task PutTrainedModelAsync(Ela } /// - /// Enables you to supply a trained model that is not created by data frame analytics. + /// + /// Enables you to supply a trained model that is not created by data frame analytics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelAsync(PutTrainedModelRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3253,7 +4704,9 @@ public virtual Task PutTrainedModelAsync(PutTrainedMode } /// - /// Enables you to supply a trained model that is not created by data frame analytics. + /// + /// Enables you to supply a trained model that is not created by data frame analytics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelAsync(Elastic.Clients.Elasticsearch.Serverless.Id modelId, CancellationToken cancellationToken = default) @@ -3264,7 +4717,9 @@ public virtual Task PutTrainedModelAsync(Elastic.Client } /// - /// Enables you to supply a trained model that is not created by data frame analytics. + /// + /// Enables you to supply a trained model that is not created by data frame analytics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelAsync(Elastic.Clients.Elasticsearch.Serverless.Id modelId, Action configureRequest, CancellationToken cancellationToken = default) @@ -3276,7 +4731,24 @@ public virtual Task PutTrainedModelAsync(Elastic.Client } /// - /// Creates or updates a trained model alias. A trained model alias is a logical
name used to reference a single trained model.
You can use aliases instead of trained model identifiers to make it easier to
reference your models. For example, you can use aliases in inference
aggregations and processors.
An alias must be unique and refer to only a single trained model. However,
you can have multiple aliases for each trained model.
If you use this API to update an alias such that it references a different
trained model ID and the model uses a different type of data frame analytics,
an error occurs. For example, this situation occurs if you have a trained
model for regression analysis and a trained model for classification
analysis; you cannot reassign an alias from one type of trained model to
another.
If you use this API to update an alias and there are very few input fields in
common between the old and new trained models for the model alias, the API
returns a warning. + /// + /// Creates or updates a trained model alias. A trained model alias is a logical + /// name used to reference a single trained model. + /// You can use aliases instead of trained model identifiers to make it easier to + /// reference your models. For example, you can use aliases in inference + /// aggregations and processors. + /// An alias must be unique and refer to only a single trained model. However, + /// you can have multiple aliases for each trained model. + /// If you use this API to update an alias such that it references a different + /// trained model ID and the model uses a different type of data frame analytics, + /// an error occurs. For example, this situation occurs if you have a trained + /// model for regression analysis and a trained model for classification + /// analysis; you cannot reassign an alias from one type of trained model to + /// another. + /// If you use this API to update an alias and there are very few input fields in + /// common between the old and new trained models for the model alias, the API + /// returns a warning. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelAliasAsync(PutTrainedModelAliasRequest request, CancellationToken cancellationToken = default) @@ -3286,7 +4758,24 @@ public virtual Task PutTrainedModelAliasAsync(PutT } /// - /// Creates or updates a trained model alias. A trained model alias is a logical
name used to reference a single trained model.
You can use aliases instead of trained model identifiers to make it easier to
reference your models. For example, you can use aliases in inference
aggregations and processors.
An alias must be unique and refer to only a single trained model. However,
you can have multiple aliases for each trained model.
If you use this API to update an alias such that it references a different
trained model ID and the model uses a different type of data frame analytics,
an error occurs. For example, this situation occurs if you have a trained
model for regression analysis and a trained model for classification
analysis; you cannot reassign an alias from one type of trained model to
another.
If you use this API to update an alias and there are very few input fields in
common between the old and new trained models for the model alias, the API
returns a warning. + /// + /// Creates or updates a trained model alias. A trained model alias is a logical + /// name used to reference a single trained model. + /// You can use aliases instead of trained model identifiers to make it easier to + /// reference your models. For example, you can use aliases in inference + /// aggregations and processors. + /// An alias must be unique and refer to only a single trained model. However, + /// you can have multiple aliases for each trained model. + /// If you use this API to update an alias such that it references a different + /// trained model ID and the model uses a different type of data frame analytics, + /// an error occurs. For example, this situation occurs if you have a trained + /// model for regression analysis and a trained model for classification + /// analysis; you cannot reassign an alias from one type of trained model to + /// another. + /// If you use this API to update an alias and there are very few input fields in + /// common between the old and new trained models for the model alias, the API + /// returns a warning. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelAliasAsync(PutTrainedModelAliasRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3296,7 +4785,24 @@ public virtual Task PutTrainedModelAliasAsync(PutT } /// - /// Creates or updates a trained model alias. A trained model alias is a logical
name used to reference a single trained model.
You can use aliases instead of trained model identifiers to make it easier to
reference your models. For example, you can use aliases in inference
aggregations and processors.
An alias must be unique and refer to only a single trained model. However,
you can have multiple aliases for each trained model.
If you use this API to update an alias such that it references a different
trained model ID and the model uses a different type of data frame analytics,
an error occurs. For example, this situation occurs if you have a trained
model for regression analysis and a trained model for classification
analysis; you cannot reassign an alias from one type of trained model to
another.
If you use this API to update an alias and there are very few input fields in
common between the old and new trained models for the model alias, the API
returns a warning. + /// + /// Creates or updates a trained model alias. A trained model alias is a logical + /// name used to reference a single trained model. + /// You can use aliases instead of trained model identifiers to make it easier to + /// reference your models. For example, you can use aliases in inference + /// aggregations and processors. + /// An alias must be unique and refer to only a single trained model. However, + /// you can have multiple aliases for each trained model. + /// If you use this API to update an alias such that it references a different + /// trained model ID and the model uses a different type of data frame analytics, + /// an error occurs. For example, this situation occurs if you have a trained + /// model for regression analysis and a trained model for classification + /// analysis; you cannot reassign an alias from one type of trained model to + /// another. + /// If you use this API to update an alias and there are very few input fields in + /// common between the old and new trained models for the model alias, the API + /// returns a warning. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelAliasAsync(Elastic.Clients.Elasticsearch.Serverless.Id modelId, Elastic.Clients.Elasticsearch.Serverless.Name modelAlias, CancellationToken cancellationToken = default) @@ -3307,7 +4813,24 @@ public virtual Task PutTrainedModelAliasAsync(Elas } /// - /// Creates or updates a trained model alias. A trained model alias is a logical
name used to reference a single trained model.
You can use aliases instead of trained model identifiers to make it easier to
reference your models. For example, you can use aliases in inference
aggregations and processors.
An alias must be unique and refer to only a single trained model. However,
you can have multiple aliases for each trained model.
If you use this API to update an alias such that it references a different
trained model ID and the model uses a different type of data frame analytics,
an error occurs. For example, this situation occurs if you have a trained
model for regression analysis and a trained model for classification
analysis; you cannot reassign an alias from one type of trained model to
another.
If you use this API to update an alias and there are very few input fields in
common between the old and new trained models for the model alias, the API
returns a warning. + /// + /// Creates or updates a trained model alias. A trained model alias is a logical + /// name used to reference a single trained model. + /// You can use aliases instead of trained model identifiers to make it easier to + /// reference your models. For example, you can use aliases in inference + /// aggregations and processors. + /// An alias must be unique and refer to only a single trained model. However, + /// you can have multiple aliases for each trained model. + /// If you use this API to update an alias such that it references a different + /// trained model ID and the model uses a different type of data frame analytics, + /// an error occurs. For example, this situation occurs if you have a trained + /// model for regression analysis and a trained model for classification + /// analysis; you cannot reassign an alias from one type of trained model to + /// another. + /// If you use this API to update an alias and there are very few input fields in + /// common between the old and new trained models for the model alias, the API + /// returns a warning. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelAliasAsync(Elastic.Clients.Elasticsearch.Serverless.Id modelId, Elastic.Clients.Elasticsearch.Serverless.Name modelAlias, Action configureRequest, CancellationToken cancellationToken = default) @@ -3319,7 +4842,9 @@ public virtual Task PutTrainedModelAliasAsync(Elas } /// - /// Creates part of a trained model definition. + /// + /// Creates part of a trained model definition. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelDefinitionPartAsync(PutTrainedModelDefinitionPartRequest request, CancellationToken cancellationToken = default) @@ -3329,7 +4854,9 @@ public virtual Task PutTrainedModelDefini } /// - /// Creates part of a trained model definition. + /// + /// Creates part of a trained model definition. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelDefinitionPartAsync(PutTrainedModelDefinitionPartRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3339,7 +4866,9 @@ public virtual Task PutTrainedModelDefini } /// - /// Creates part of a trained model definition. + /// + /// Creates part of a trained model definition. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelDefinitionPartAsync(Elastic.Clients.Elasticsearch.Serverless.Id modelId, int part, CancellationToken cancellationToken = default) @@ -3350,7 +4879,9 @@ public virtual Task PutTrainedModelDefini } /// - /// Creates part of a trained model definition. + /// + /// Creates part of a trained model definition. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelDefinitionPartAsync(Elastic.Clients.Elasticsearch.Serverless.Id modelId, int part, Action configureRequest, CancellationToken cancellationToken = default) @@ -3362,7 +4893,11 @@ public virtual Task PutTrainedModelDefini } /// - /// Creates a trained model vocabulary.
This API is supported only for natural language processing (NLP) models.
The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition. + /// + /// Creates a trained model vocabulary. + /// This API is supported only for natural language processing (NLP) models. + /// The vocabulary is stored in the index as described in inference_config.*.vocabulary of the trained model definition. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelVocabularyAsync(PutTrainedModelVocabularyRequest request, CancellationToken cancellationToken = default) @@ -3372,7 +4907,11 @@ public virtual Task PutTrainedModelVocabulary } /// - /// Creates a trained model vocabulary.
This API is supported only for natural language processing (NLP) models.
The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition. + /// + /// Creates a trained model vocabulary. + /// This API is supported only for natural language processing (NLP) models. + /// The vocabulary is stored in the index as described in inference_config.*.vocabulary of the trained model definition. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelVocabularyAsync(PutTrainedModelVocabularyRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3382,7 +4921,11 @@ public virtual Task PutTrainedModelVocabulary } /// - /// Creates a trained model vocabulary.
This API is supported only for natural language processing (NLP) models.
The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition. + /// + /// Creates a trained model vocabulary. + /// This API is supported only for natural language processing (NLP) models. + /// The vocabulary is stored in the index as described in inference_config.*.vocabulary of the trained model definition. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelVocabularyAsync(Elastic.Clients.Elasticsearch.Serverless.Id modelId, CancellationToken cancellationToken = default) @@ -3393,7 +4936,11 @@ public virtual Task PutTrainedModelVocabulary } /// - /// Creates a trained model vocabulary.
This API is supported only for natural language processing (NLP) models.
The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition. + /// + /// Creates a trained model vocabulary. + /// This API is supported only for natural language processing (NLP) models. + /// The vocabulary is stored in the index as described in inference_config.*.vocabulary of the trained model definition. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelVocabularyAsync(Elastic.Clients.Elasticsearch.Serverless.Id modelId, Action configureRequest, CancellationToken cancellationToken = default) @@ -3405,7 +4952,13 @@ public virtual Task PutTrainedModelVocabulary } /// - /// Resets an anomaly detection job.
All model state and results are deleted. The job is ready to start over as if
it had just been created.
It is not currently possible to reset multiple jobs using wildcards or a
comma separated list. + /// + /// Resets an anomaly detection job. + /// All model state and results are deleted. The job is ready to start over as if + /// it had just been created. + /// It is not currently possible to reset multiple jobs using wildcards or a + /// comma separated list. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResetJobAsync(ResetJobRequest request, CancellationToken cancellationToken = default) @@ -3415,7 +4968,13 @@ public virtual Task ResetJobAsync(ResetJobRequest request, Can } /// - /// Resets an anomaly detection job.
All model state and results are deleted. The job is ready to start over as if
it had just been created.
It is not currently possible to reset multiple jobs using wildcards or a
comma separated list. + /// + /// Resets an anomaly detection job. + /// All model state and results are deleted. The job is ready to start over as if + /// it had just been created. + /// It is not currently possible to reset multiple jobs using wildcards or a + /// comma separated list. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResetJobAsync(ResetJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3425,7 +4984,13 @@ public virtual Task ResetJobAsync(ResetJobRequestDescriptor de } /// - /// Resets an anomaly detection job.
All model state and results are deleted. The job is ready to start over as if
it had just been created.
It is not currently possible to reset multiple jobs using wildcards or a
comma separated list. + /// + /// Resets an anomaly detection job. + /// All model state and results are deleted. The job is ready to start over as if + /// it had just been created. + /// It is not currently possible to reset multiple jobs using wildcards or a + /// comma separated list. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResetJobAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, CancellationToken cancellationToken = default) @@ -3436,7 +5001,13 @@ public virtual Task ResetJobAsync(Elastic.Clients.Elasticsearc } /// - /// Resets an anomaly detection job.
All model state and results are deleted. The job is ready to start over as if
it had just been created.
It is not currently possible to reset multiple jobs using wildcards or a
comma separated list. + /// + /// Resets an anomaly detection job. + /// All model state and results are deleted. The job is ready to start over as if + /// it had just been created. + /// It is not currently possible to reset multiple jobs using wildcards or a + /// comma separated list. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResetJobAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -3448,7 +5019,16 @@ public virtual Task ResetJobAsync(Elastic.Clients.Elasticsearc } /// - /// Reverts to a specific snapshot.
The machine learning features react quickly to anomalous input, learning new
behaviors in data. Highly anomalous input increases the variance in the
models whilst the system learns whether this is a new step-change in behavior
or a one-off event. In the case where this anomalous input is known to be a
one-off, then it might be appropriate to reset the model state to a time
before this event. For example, you might consider reverting to a saved
snapshot after Black Friday or a critical system failure. + /// + /// Reverts to a specific snapshot. + /// The machine learning features react quickly to anomalous input, learning new + /// behaviors in data. Highly anomalous input increases the variance in the + /// models whilst the system learns whether this is a new step-change in behavior + /// or a one-off event. In the case where this anomalous input is known to be a + /// one-off, then it might be appropriate to reset the model state to a time + /// before this event. For example, you might consider reverting to a saved + /// snapshot after Black Friday or a critical system failure. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RevertModelSnapshotAsync(RevertModelSnapshotRequest request, CancellationToken cancellationToken = default) @@ -3458,7 +5038,16 @@ public virtual Task RevertModelSnapshotAsync(Revert } /// - /// Reverts to a specific snapshot.
The machine learning features react quickly to anomalous input, learning new
behaviors in data. Highly anomalous input increases the variance in the
models whilst the system learns whether this is a new step-change in behavior
or a one-off event. In the case where this anomalous input is known to be a
one-off, then it might be appropriate to reset the model state to a time
before this event. For example, you might consider reverting to a saved
snapshot after Black Friday or a critical system failure. + /// + /// Reverts to a specific snapshot. + /// The machine learning features react quickly to anomalous input, learning new + /// behaviors in data. Highly anomalous input increases the variance in the + /// models whilst the system learns whether this is a new step-change in behavior + /// or a one-off event. In the case where this anomalous input is known to be a + /// one-off, then it might be appropriate to reset the model state to a time + /// before this event. For example, you might consider reverting to a saved + /// snapshot after Black Friday or a critical system failure. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RevertModelSnapshotAsync(RevertModelSnapshotRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3468,7 +5057,16 @@ public virtual Task RevertModelSnapshotAsync(Revert } /// - /// Reverts to a specific snapshot.
The machine learning features react quickly to anomalous input, learning new
behaviors in data. Highly anomalous input increases the variance in the
models whilst the system learns whether this is a new step-change in behavior
or a one-off event. In the case where this anomalous input is known to be a
one-off, then it might be appropriate to reset the model state to a time
before this event. For example, you might consider reverting to a saved
snapshot after Black Friday or a critical system failure. + /// + /// Reverts to a specific snapshot. + /// The machine learning features react quickly to anomalous input, learning new + /// behaviors in data. Highly anomalous input increases the variance in the + /// models whilst the system learns whether this is a new step-change in behavior + /// or a one-off event. In the case where this anomalous input is known to be a + /// one-off, then it might be appropriate to reset the model state to a time + /// before this event. For example, you might consider reverting to a saved + /// snapshot after Black Friday or a critical system failure. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RevertModelSnapshotAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Elastic.Clients.Elasticsearch.Serverless.Id snapshotId, CancellationToken cancellationToken = default) @@ -3479,7 +5077,16 @@ public virtual Task RevertModelSnapshotAsync(Elasti } /// - /// Reverts to a specific snapshot.
The machine learning features react quickly to anomalous input, learning new
behaviors in data. Highly anomalous input increases the variance in the
models whilst the system learns whether this is a new step-change in behavior
or a one-off event. In the case where this anomalous input is known to be a
one-off, then it might be appropriate to reset the model state to a time
before this event. For example, you might consider reverting to a saved
snapshot after Black Friday or a critical system failure. + /// + /// Reverts to a specific snapshot. + /// The machine learning features react quickly to anomalous input, learning new + /// behaviors in data. Highly anomalous input increases the variance in the + /// models whilst the system learns whether this is a new step-change in behavior + /// or a one-off event. In the case where this anomalous input is known to be a + /// one-off, then it might be appropriate to reset the model state to a time + /// before this event. For example, you might consider reverting to a saved + /// snapshot after Black Friday or a critical system failure. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RevertModelSnapshotAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Elastic.Clients.Elasticsearch.Serverless.Id snapshotId, Action configureRequest, CancellationToken cancellationToken = default) @@ -3491,7 +5098,20 @@ public virtual Task RevertModelSnapshotAsync(Elasti } /// - /// Sets a cluster wide upgrade_mode setting that prepares machine learning
indices for an upgrade.
When upgrading your cluster, in some circumstances you must restart your
nodes and reindex your machine learning indices. In those circumstances,
there must be no machine learning jobs running. You can close the machine
learning jobs, do the upgrade, then open all the jobs again. Alternatively,
you can use this API to temporarily halt tasks associated with the jobs and
datafeeds and prevent new jobs from opening. You can also use this API
during upgrades that do not require you to reindex your machine learning
indices, though stopping jobs is not a requirement in that case.
You can see the current value for the upgrade_mode setting by using the get
machine learning info API. + /// + /// Sets a cluster wide upgrade_mode setting that prepares machine learning + /// indices for an upgrade. + /// When upgrading your cluster, in some circumstances you must restart your + /// nodes and reindex your machine learning indices. In those circumstances, + /// there must be no machine learning jobs running. You can close the machine + /// learning jobs, do the upgrade, then open all the jobs again. Alternatively, + /// you can use this API to temporarily halt tasks associated with the jobs and + /// datafeeds and prevent new jobs from opening. You can also use this API + /// during upgrades that do not require you to reindex your machine learning + /// indices, though stopping jobs is not a requirement in that case. + /// You can see the current value for the upgrade_mode setting by using the get + /// machine learning info API. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SetUpgradeModeAsync(SetUpgradeModeRequest request, CancellationToken cancellationToken = default) @@ -3501,7 +5121,20 @@ public virtual Task SetUpgradeModeAsync(SetUpgradeModeRe } /// - /// Sets a cluster wide upgrade_mode setting that prepares machine learning
indices for an upgrade.
When upgrading your cluster, in some circumstances you must restart your
nodes and reindex your machine learning indices. In those circumstances,
there must be no machine learning jobs running. You can close the machine
learning jobs, do the upgrade, then open all the jobs again. Alternatively,
you can use this API to temporarily halt tasks associated with the jobs and
datafeeds and prevent new jobs from opening. You can also use this API
during upgrades that do not require you to reindex your machine learning
indices, though stopping jobs is not a requirement in that case.
You can see the current value for the upgrade_mode setting by using the get
machine learning info API. + /// + /// Sets a cluster wide upgrade_mode setting that prepares machine learning + /// indices for an upgrade. + /// When upgrading your cluster, in some circumstances you must restart your + /// nodes and reindex your machine learning indices. In those circumstances, + /// there must be no machine learning jobs running. You can close the machine + /// learning jobs, do the upgrade, then open all the jobs again. Alternatively, + /// you can use this API to temporarily halt tasks associated with the jobs and + /// datafeeds and prevent new jobs from opening. You can also use this API + /// during upgrades that do not require you to reindex your machine learning + /// indices, though stopping jobs is not a requirement in that case. + /// You can see the current value for the upgrade_mode setting by using the get + /// machine learning info API. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SetUpgradeModeAsync(SetUpgradeModeRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3511,7 +5144,20 @@ public virtual Task SetUpgradeModeAsync(SetUpgradeModeRe } /// - /// Sets a cluster wide upgrade_mode setting that prepares machine learning
indices for an upgrade.
When upgrading your cluster, in some circumstances you must restart your
nodes and reindex your machine learning indices. In those circumstances,
there must be no machine learning jobs running. You can close the machine
learning jobs, do the upgrade, then open all the jobs again. Alternatively,
you can use this API to temporarily halt tasks associated with the jobs and
datafeeds and prevent new jobs from opening. You can also use this API
during upgrades that do not require you to reindex your machine learning
indices, though stopping jobs is not a requirement in that case.
You can see the current value for the upgrade_mode setting by using the get
machine learning info API. + /// + /// Sets a cluster wide upgrade_mode setting that prepares machine learning + /// indices for an upgrade. + /// When upgrading your cluster, in some circumstances you must restart your + /// nodes and reindex your machine learning indices. In those circumstances, + /// there must be no machine learning jobs running. You can close the machine + /// learning jobs, do the upgrade, then open all the jobs again. Alternatively, + /// you can use this API to temporarily halt tasks associated with the jobs and + /// datafeeds and prevent new jobs from opening. You can also use this API + /// during upgrades that do not require you to reindex your machine learning + /// indices, though stopping jobs is not a requirement in that case. + /// You can see the current value for the upgrade_mode setting by using the get + /// machine learning info API. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SetUpgradeModeAsync(CancellationToken cancellationToken = default) @@ -3522,7 +5168,20 @@ public virtual Task SetUpgradeModeAsync(CancellationToke } /// - /// Sets a cluster wide upgrade_mode setting that prepares machine learning
indices for an upgrade.
When upgrading your cluster, in some circumstances you must restart your
nodes and reindex your machine learning indices. In those circumstances,
there must be no machine learning jobs running. You can close the machine
learning jobs, do the upgrade, then open all the jobs again. Alternatively,
you can use this API to temporarily halt tasks associated with the jobs and
datafeeds and prevent new jobs from opening. You can also use this API
during upgrades that do not require you to reindex your machine learning
indices, though stopping jobs is not a requirement in that case.
You can see the current value for the upgrade_mode setting by using the get
machine learning info API. + /// + /// Sets a cluster wide upgrade_mode setting that prepares machine learning + /// indices for an upgrade. + /// When upgrading your cluster, in some circumstances you must restart your + /// nodes and reindex your machine learning indices. In those circumstances, + /// there must be no machine learning jobs running. You can close the machine + /// learning jobs, do the upgrade, then open all the jobs again. Alternatively, + /// you can use this API to temporarily halt tasks associated with the jobs and + /// datafeeds and prevent new jobs from opening. You can also use this API + /// during upgrades that do not require you to reindex your machine learning + /// indices, though stopping jobs is not a requirement in that case. + /// You can see the current value for the upgrade_mode setting by using the get + /// machine learning info API. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SetUpgradeModeAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -3534,11 +5193,25 @@ public virtual Task SetUpgradeModeAsync(Action - /// Starts one or more datafeeds. - /// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. - /// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. - /// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.
If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. - /// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or
update it had at the time of creation or update and runs the query using those same roles. If you provided secondary
authorization headers when you created or updated the datafeed, those credentials are used instead. + /// + /// Starts one or more datafeeds. + /// + /// + /// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped + /// multiple times throughout its lifecycle. + /// + /// + /// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. + /// + /// + /// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped. + /// If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. + /// + /// + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or + /// update it had at the time of creation or update and runs the query using those same roles. If you provided secondary + /// authorization headers when you created or updated the datafeed, those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartDatafeedAsync(StartDatafeedRequest request, CancellationToken cancellationToken = default) @@ -3548,11 +5221,25 @@ public virtual Task StartDatafeedAsync(StartDatafeedReque } /// - /// Starts one or more datafeeds. - /// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. - /// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. - /// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.
If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. - /// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or
update it had at the time of creation or update and runs the query using those same roles. If you provided secondary
authorization headers when you created or updated the datafeed, those credentials are used instead. + /// + /// Starts one or more datafeeds. + /// + /// + /// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped + /// multiple times throughout its lifecycle. + /// + /// + /// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. + /// + /// + /// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped. + /// If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. + /// + /// + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or + /// update it had at the time of creation or update and runs the query using those same roles. If you provided secondary + /// authorization headers when you created or updated the datafeed, those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartDatafeedAsync(StartDatafeedRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3562,11 +5249,25 @@ public virtual Task StartDatafeedAsync(StartDatafeedReque } /// - /// Starts one or more datafeeds. - /// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. - /// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. - /// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.
If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. - /// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or
update it had at the time of creation or update and runs the query using those same roles. If you provided secondary
authorization headers when you created or updated the datafeed, those credentials are used instead. + /// + /// Starts one or more datafeeds. + /// + /// + /// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped + /// multiple times throughout its lifecycle. + /// + /// + /// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. + /// + /// + /// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped. + /// If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. + /// + /// + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or + /// update it had at the time of creation or update and runs the query using those same roles. If you provided secondary + /// authorization headers when you created or updated the datafeed, those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartDatafeedAsync(Elastic.Clients.Elasticsearch.Serverless.Id datafeedId, CancellationToken cancellationToken = default) @@ -3577,11 +5278,25 @@ public virtual Task StartDatafeedAsync(Elastic.Clients.El } /// - /// Starts one or more datafeeds. - /// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. - /// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. - /// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.
If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. - /// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or
update it had at the time of creation or update and runs the query using those same roles. If you provided secondary
authorization headers when you created or updated the datafeed, those credentials are used instead. + /// + /// Starts one or more datafeeds. + /// + /// + /// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped + /// multiple times throughout its lifecycle. + /// + /// + /// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. + /// + /// + /// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped. + /// If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. + /// + /// + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or + /// update it had at the time of creation or update and runs the query using those same roles. If you provided secondary + /// authorization headers when you created or updated the datafeed, those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartDatafeedAsync(Elastic.Clients.Elasticsearch.Serverless.Id datafeedId, Action configureRequest, CancellationToken cancellationToken = default) @@ -3593,7 +5308,20 @@ public virtual Task StartDatafeedAsync(Elastic.Clients.El } /// - /// Starts a data frame analytics job.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle.
If the destination index does not exist, it is created automatically the
first time you start the data frame analytics job. The
`index.number_of_shards` and `index.number_of_replicas` settings for the
destination index are copied from the source index. If there are multiple
source indices, the destination index copies the highest setting values. The
mappings for the destination index are also copied from the source indices.
If there are any mapping conflicts, the job fails to start.
If the destination index exists, it is used as is. You can therefore set up
the destination index in advance with custom settings and mappings. + /// + /// Starts a data frame analytics job. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// If the destination index does not exist, it is created automatically the + /// first time you start the data frame analytics job. The + /// index.number_of_shards and index.number_of_replicas settings for the + /// destination index are copied from the source index. If there are multiple + /// source indices, the destination index copies the highest setting values. The + /// mappings for the destination index are also copied from the source indices. + /// If there are any mapping conflicts, the job fails to start. + /// If the destination index exists, it is used as is. You can therefore set up + /// the destination index in advance with custom settings and mappings. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartDataFrameAnalyticsAsync(StartDataFrameAnalyticsRequest request, CancellationToken cancellationToken = default) @@ -3603,7 +5331,20 @@ public virtual Task StartDataFrameAnalyticsAsyn } /// - /// Starts a data frame analytics job.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle.
If the destination index does not exist, it is created automatically the
first time you start the data frame analytics job. The
`index.number_of_shards` and `index.number_of_replicas` settings for the
destination index are copied from the source index. If there are multiple
source indices, the destination index copies the highest setting values. The
mappings for the destination index are also copied from the source indices.
If there are any mapping conflicts, the job fails to start.
If the destination index exists, it is used as is. You can therefore set up
the destination index in advance with custom settings and mappings. + /// + /// Starts a data frame analytics job. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// If the destination index does not exist, it is created automatically the + /// first time you start the data frame analytics job. The + /// index.number_of_shards and index.number_of_replicas settings for the + /// destination index are copied from the source index. If there are multiple + /// source indices, the destination index copies the highest setting values. The + /// mappings for the destination index are also copied from the source indices. + /// If there are any mapping conflicts, the job fails to start. + /// If the destination index exists, it is used as is. You can therefore set up + /// the destination index in advance with custom settings and mappings. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartDataFrameAnalyticsAsync(StartDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3613,7 +5354,20 @@ public virtual Task StartDataFrameAnalyticsAsyn } /// - /// Starts a data frame analytics job.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle.
If the destination index does not exist, it is created automatically the
first time you start the data frame analytics job. The
`index.number_of_shards` and `index.number_of_replicas` settings for the
destination index are copied from the source index. If there are multiple
source indices, the destination index copies the highest setting values. The
mappings for the destination index are also copied from the source indices.
If there are any mapping conflicts, the job fails to start.
If the destination index exists, it is used as is. You can therefore set up
the destination index in advance with custom settings and mappings. + /// + /// Starts a data frame analytics job. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// If the destination index does not exist, it is created automatically the + /// first time you start the data frame analytics job. The + /// index.number_of_shards and index.number_of_replicas settings for the + /// destination index are copied from the source index. If there are multiple + /// source indices, the destination index copies the highest setting values. The + /// mappings for the destination index are also copied from the source indices. + /// If there are any mapping conflicts, the job fails to start. + /// If the destination index exists, it is used as is. You can therefore set up + /// the destination index in advance with custom settings and mappings. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -3624,7 +5378,20 @@ public virtual Task StartDataFrameAnalyticsAsyn } /// - /// Starts a data frame analytics job.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle.
If the destination index does not exist, it is created automatically the
first time you start the data frame analytics job. The
`index.number_of_shards` and `index.number_of_replicas` settings for the
destination index are copied from the source index. If there are multiple
source indices, the destination index copies the highest setting values. The
mappings for the destination index are also copied from the source indices.
If there are any mapping conflicts, the job fails to start.
If the destination index exists, it is used as is. You can therefore set up
the destination index in advance with custom settings and mappings. + /// + /// Starts a data frame analytics job. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// If the destination index does not exist, it is created automatically the + /// first time you start the data frame analytics job. The + /// index.number_of_shards and index.number_of_replicas settings for the + /// destination index are copied from the source index. If there are multiple + /// source indices, the destination index copies the highest setting values. The + /// mappings for the destination index are also copied from the source indices. + /// If there are any mapping conflicts, the job fails to start. + /// If the destination index exists, it is used as is. You can therefore set up + /// the destination index in advance with custom settings and mappings. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3636,7 +5403,20 @@ public virtual Task StartDataFrameAnalyticsAsyn } /// - /// Starts a data frame analytics job.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle.
If the destination index does not exist, it is created automatically the
first time you start the data frame analytics job. The
`index.number_of_shards` and `index.number_of_replicas` settings for the
destination index are copied from the source index. If there are multiple
source indices, the destination index copies the highest setting values. The
mappings for the destination index are also copied from the source indices.
If there are any mapping conflicts, the job fails to start.
If the destination index exists, it is used as is. You can therefore set up
the destination index in advance with custom settings and mappings. + /// + /// Starts a data frame analytics job. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// If the destination index does not exist, it is created automatically the + /// first time you start the data frame analytics job. The + /// index.number_of_shards and index.number_of_replicas settings for the + /// destination index are copied from the source index. If there are multiple + /// source indices, the destination index copies the highest setting values. The + /// mappings for the destination index are also copied from the source indices. + /// If there are any mapping conflicts, the job fails to start. + /// If the destination index exists, it is used as is. You can therefore set up + /// the destination index in advance with custom settings and mappings. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartDataFrameAnalyticsAsync(StartDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3646,7 +5426,20 @@ public virtual Task StartDataFrameAnalyticsAsyn } /// - /// Starts a data frame analytics job.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle.
If the destination index does not exist, it is created automatically the
first time you start the data frame analytics job. The
`index.number_of_shards` and `index.number_of_replicas` settings for the
destination index are copied from the source index. If there are multiple
source indices, the destination index copies the highest setting values. The
mappings for the destination index are also copied from the source indices.
If there are any mapping conflicts, the job fails to start.
If the destination index exists, it is used as is. You can therefore set up
the destination index in advance with custom settings and mappings. + /// + /// Starts a data frame analytics job. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// If the destination index does not exist, it is created automatically the + /// first time you start the data frame analytics job. The + /// index.number_of_shards and index.number_of_replicas settings for the + /// destination index are copied from the source index. If there are multiple + /// source indices, the destination index copies the highest setting values. The + /// mappings for the destination index are also copied from the source indices. + /// If there are any mapping conflicts, the job fails to start. + /// If the destination index exists, it is used as is. You can therefore set up + /// the destination index in advance with custom settings and mappings. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -3657,7 +5450,20 @@ public virtual Task StartDataFrameAnalyticsAsyn } /// - /// Starts a data frame analytics job.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle.
If the destination index does not exist, it is created automatically the
first time you start the data frame analytics job. The
`index.number_of_shards` and `index.number_of_replicas` settings for the
destination index are copied from the source index. If there are multiple
source indices, the destination index copies the highest setting values. The
mappings for the destination index are also copied from the source indices.
If there are any mapping conflicts, the job fails to start.
If the destination index exists, it is used as is. You can therefore set up
the destination index in advance with custom settings and mappings. + /// + /// Starts a data frame analytics job. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// If the destination index does not exist, it is created automatically the + /// first time you start the data frame analytics job. The + /// index.number_of_shards and index.number_of_replicas settings for the + /// destination index are copied from the source index. If there are multiple + /// source indices, the destination index copies the highest setting values. The + /// mappings for the destination index are also copied from the source indices. + /// If there are any mapping conflicts, the job fails to start. + /// If the destination index exists, it is used as is. You can therefore set up + /// the destination index in advance with custom settings and mappings. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -3669,7 +5475,9 @@ public virtual Task StartDataFrameAnalyticsAsyn } /// - /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// + /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartTrainedModelDeploymentAsync(StartTrainedModelDeploymentRequest request, CancellationToken cancellationToken = default) @@ -3679,7 +5487,9 @@ public virtual Task StartTrainedModelDeploy } /// - /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// + /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartTrainedModelDeploymentAsync(StartTrainedModelDeploymentRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3689,7 +5499,9 @@ public virtual Task StartTrainedModelDeploy } /// - /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// + /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartTrainedModelDeploymentAsync(Elastic.Clients.Elasticsearch.Serverless.Id modelId, CancellationToken cancellationToken = default) @@ -3700,7 +5512,9 @@ public virtual Task StartTrainedModelDeploy } /// - /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// + /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartTrainedModelDeploymentAsync(Elastic.Clients.Elasticsearch.Serverless.Id modelId, Action configureRequest, CancellationToken cancellationToken = default) @@ -3712,7 +5526,11 @@ public virtual Task StartTrainedModelDeploy } /// - /// Stops one or more datafeeds.
A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. + /// + /// Stops one or more datafeeds. + /// A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped + /// multiple times throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopDatafeedAsync(StopDatafeedRequest request, CancellationToken cancellationToken = default) @@ -3722,7 +5540,11 @@ public virtual Task StopDatafeedAsync(StopDatafeedRequest } /// - /// Stops one or more datafeeds.
A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. + /// + /// Stops one or more datafeeds. + /// A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped + /// multiple times throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopDatafeedAsync(StopDatafeedRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3732,7 +5554,11 @@ public virtual Task StopDatafeedAsync(StopDatafeedRequestD } /// - /// Stops one or more datafeeds.
A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. + /// + /// Stops one or more datafeeds. + /// A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped + /// multiple times throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopDatafeedAsync(Elastic.Clients.Elasticsearch.Serverless.Id datafeedId, CancellationToken cancellationToken = default) @@ -3743,7 +5569,11 @@ public virtual Task StopDatafeedAsync(Elastic.Clients.Elas } /// - /// Stops one or more datafeeds.
A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. + /// + /// Stops one or more datafeeds. + /// A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped + /// multiple times throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopDatafeedAsync(Elastic.Clients.Elasticsearch.Serverless.Id datafeedId, Action configureRequest, CancellationToken cancellationToken = default) @@ -3755,7 +5585,11 @@ public virtual Task StopDatafeedAsync(Elastic.Clients.Elas } /// - /// Stops one or more data frame analytics jobs.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle. + /// + /// Stops one or more data frame analytics jobs. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopDataFrameAnalyticsAsync(StopDataFrameAnalyticsRequest request, CancellationToken cancellationToken = default) @@ -3765,7 +5599,11 @@ public virtual Task StopDataFrameAnalyticsAsync( } /// - /// Stops one or more data frame analytics jobs.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle. + /// + /// Stops one or more data frame analytics jobs. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopDataFrameAnalyticsAsync(StopDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3775,7 +5613,11 @@ public virtual Task StopDataFrameAnalyticsAsync< } /// - /// Stops one or more data frame analytics jobs.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle. + /// + /// Stops one or more data frame analytics jobs. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -3786,7 +5628,11 @@ public virtual Task StopDataFrameAnalyticsAsync< } /// - /// Stops one or more data frame analytics jobs.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle. + /// + /// Stops one or more data frame analytics jobs. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3798,7 +5644,11 @@ public virtual Task StopDataFrameAnalyticsAsync< } /// - /// Stops one or more data frame analytics jobs.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle. + /// + /// Stops one or more data frame analytics jobs. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopDataFrameAnalyticsAsync(StopDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3808,7 +5658,11 @@ public virtual Task StopDataFrameAnalyticsAsync( } /// - /// Stops one or more data frame analytics jobs.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle. + /// + /// Stops one or more data frame analytics jobs. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -3819,7 +5673,11 @@ public virtual Task StopDataFrameAnalyticsAsync( } /// - /// Stops one or more data frame analytics jobs.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle. + /// + /// Stops one or more data frame analytics jobs. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -3831,7 +5689,9 @@ public virtual Task StopDataFrameAnalyticsAsync( } /// - /// Stops a trained model deployment. + /// + /// Stops a trained model deployment. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopTrainedModelDeploymentAsync(StopTrainedModelDeploymentRequest request, CancellationToken cancellationToken = default) @@ -3841,7 +5701,9 @@ public virtual Task StopTrainedModelDeployme } /// - /// Stops a trained model deployment. + /// + /// Stops a trained model deployment. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopTrainedModelDeploymentAsync(StopTrainedModelDeploymentRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3851,7 +5713,9 @@ public virtual Task StopTrainedModelDeployme } /// - /// Stops a trained model deployment. + /// + /// Stops a trained model deployment. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopTrainedModelDeploymentAsync(Elastic.Clients.Elasticsearch.Serverless.Id modelId, CancellationToken cancellationToken = default) @@ -3862,7 +5726,9 @@ public virtual Task StopTrainedModelDeployme } /// - /// Stops a trained model deployment. + /// + /// Stops a trained model deployment. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopTrainedModelDeploymentAsync(Elastic.Clients.Elasticsearch.Serverless.Id modelId, Action configureRequest, CancellationToken cancellationToken = default) @@ -3874,7 +5740,13 @@ public virtual Task StopTrainedModelDeployme } /// - /// Updates the properties of a datafeed.
You must stop and start the datafeed for the changes to be applied.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at
the time of the update and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead. + /// + /// Updates the properties of a datafeed. + /// You must stop and start the datafeed for the changes to be applied. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at + /// the time of the update and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateDatafeedAsync(UpdateDatafeedRequest request, CancellationToken cancellationToken = default) @@ -3884,7 +5756,13 @@ public virtual Task UpdateDatafeedAsync(UpdateDatafeedRe } /// - /// Updates the properties of a datafeed.
You must stop and start the datafeed for the changes to be applied.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at
the time of the update and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead. + /// + /// Updates the properties of a datafeed. + /// You must stop and start the datafeed for the changes to be applied. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at + /// the time of the update and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateDatafeedAsync(UpdateDatafeedRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3894,7 +5772,13 @@ public virtual Task UpdateDatafeedAsync(Updat } /// - /// Updates the properties of a datafeed.
You must stop and start the datafeed for the changes to be applied.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at
the time of the update and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead. + /// + /// Updates the properties of a datafeed. + /// You must stop and start the datafeed for the changes to be applied. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at + /// the time of the update and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateDatafeedAsync(Elastic.Clients.Elasticsearch.Serverless.Id datafeedId, CancellationToken cancellationToken = default) @@ -3905,7 +5789,13 @@ public virtual Task UpdateDatafeedAsync(Elast } /// - /// Updates the properties of a datafeed.
You must stop and start the datafeed for the changes to be applied.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at
the time of the update and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead. + /// + /// Updates the properties of a datafeed. + /// You must stop and start the datafeed for the changes to be applied. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at + /// the time of the update and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateDatafeedAsync(Elastic.Clients.Elasticsearch.Serverless.Id datafeedId, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3917,7 +5807,13 @@ public virtual Task UpdateDatafeedAsync(Elast } /// - /// Updates the properties of a datafeed.
You must stop and start the datafeed for the changes to be applied.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at
the time of the update and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead. + /// + /// Updates the properties of a datafeed. + /// You must stop and start the datafeed for the changes to be applied. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at + /// the time of the update and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateDatafeedAsync(UpdateDatafeedRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3927,7 +5823,13 @@ public virtual Task UpdateDatafeedAsync(UpdateDatafeedRe } /// - /// Updates the properties of a datafeed.
You must stop and start the datafeed for the changes to be applied.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at
the time of the update and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead. + /// + /// Updates the properties of a datafeed. + /// You must stop and start the datafeed for the changes to be applied. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at + /// the time of the update and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateDatafeedAsync(Elastic.Clients.Elasticsearch.Serverless.Id datafeedId, CancellationToken cancellationToken = default) @@ -3938,7 +5840,13 @@ public virtual Task UpdateDatafeedAsync(Elastic.Clients. } /// - /// Updates the properties of a datafeed.
You must stop and start the datafeed for the changes to be applied.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at
the time of the update and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead. + /// + /// Updates the properties of a datafeed. + /// You must stop and start the datafeed for the changes to be applied. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at + /// the time of the update and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateDatafeedAsync(Elastic.Clients.Elasticsearch.Serverless.Id datafeedId, Action configureRequest, CancellationToken cancellationToken = default) @@ -3950,7 +5858,9 @@ public virtual Task UpdateDatafeedAsync(Elastic.Clients. } /// - /// Updates an existing data frame analytics job. + /// + /// Updates an existing data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateDataFrameAnalyticsAsync(UpdateDataFrameAnalyticsRequest request, CancellationToken cancellationToken = default) @@ -3960,7 +5870,9 @@ public virtual Task UpdateDataFrameAnalyticsAs } /// - /// Updates an existing data frame analytics job. + /// + /// Updates an existing data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateDataFrameAnalyticsAsync(UpdateDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3970,7 +5882,9 @@ public virtual Task UpdateDataFrameAnalyticsAs } /// - /// Updates an existing data frame analytics job. + /// + /// Updates an existing data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -3981,7 +5895,9 @@ public virtual Task UpdateDataFrameAnalyticsAs } /// - /// Updates an existing data frame analytics job. + /// + /// Updates an existing data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3993,7 +5909,9 @@ public virtual Task UpdateDataFrameAnalyticsAs } /// - /// Updates an existing data frame analytics job. + /// + /// Updates an existing data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateDataFrameAnalyticsAsync(UpdateDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4003,7 +5921,9 @@ public virtual Task UpdateDataFrameAnalyticsAs } /// - /// Updates an existing data frame analytics job. + /// + /// Updates an existing data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -4014,7 +5934,9 @@ public virtual Task UpdateDataFrameAnalyticsAs } /// - /// Updates an existing data frame analytics job. + /// + /// Updates an existing data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -4026,7 +5948,9 @@ public virtual Task UpdateDataFrameAnalyticsAs } /// - /// Updates the description of a filter, adds items, or removes items from the list. + /// + /// Updates the description of a filter, adds items, or removes items from the list. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateFilterAsync(UpdateFilterRequest request, CancellationToken cancellationToken = default) @@ -4036,7 +5960,9 @@ public virtual Task UpdateFilterAsync(UpdateFilterRequest } /// - /// Updates the description of a filter, adds items, or removes items from the list. + /// + /// Updates the description of a filter, adds items, or removes items from the list. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateFilterAsync(UpdateFilterRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4046,7 +5972,9 @@ public virtual Task UpdateFilterAsync(UpdateFilterRequestD } /// - /// Updates the description of a filter, adds items, or removes items from the list. + /// + /// Updates the description of a filter, adds items, or removes items from the list. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateFilterAsync(Elastic.Clients.Elasticsearch.Serverless.Id filterId, CancellationToken cancellationToken = default) @@ -4057,7 +5985,9 @@ public virtual Task UpdateFilterAsync(Elastic.Clients.Elas } /// - /// Updates the description of a filter, adds items, or removes items from the list. + /// + /// Updates the description of a filter, adds items, or removes items from the list. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateFilterAsync(Elastic.Clients.Elasticsearch.Serverless.Id filterId, Action configureRequest, CancellationToken cancellationToken = default) @@ -4069,7 +5999,9 @@ public virtual Task UpdateFilterAsync(Elastic.Clients.Elas } /// - /// Updates certain properties of an anomaly detection job. + /// + /// Updates certain properties of an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateJobAsync(UpdateJobRequest request, CancellationToken cancellationToken = default) @@ -4079,7 +6011,9 @@ public virtual Task UpdateJobAsync(UpdateJobRequest request, } /// - /// Updates certain properties of an anomaly detection job. + /// + /// Updates certain properties of an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateJobAsync(UpdateJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4089,7 +6023,9 @@ public virtual Task UpdateJobAsync(UpdateJobReques } /// - /// Updates certain properties of an anomaly detection job. + /// + /// Updates certain properties of an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateJobAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, CancellationToken cancellationToken = default) @@ -4100,7 +6036,9 @@ public virtual Task UpdateJobAsync(Elastic.Clients } /// - /// Updates certain properties of an anomaly detection job. + /// + /// Updates certain properties of an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateJobAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Action> configureRequest, CancellationToken cancellationToken = default) @@ -4112,7 +6050,9 @@ public virtual Task UpdateJobAsync(Elastic.Clients } /// - /// Updates certain properties of an anomaly detection job. + /// + /// Updates certain properties of an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateJobAsync(UpdateJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4122,7 +6062,9 @@ public virtual Task UpdateJobAsync(UpdateJobRequestDescriptor } /// - /// Updates certain properties of an anomaly detection job. + /// + /// Updates certain properties of an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateJobAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, CancellationToken cancellationToken = default) @@ -4133,7 +6075,9 @@ public virtual Task UpdateJobAsync(Elastic.Clients.Elasticsea } /// - /// Updates certain properties of an anomaly detection job. + /// + /// Updates certain properties of an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateJobAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -4145,7 +6089,9 @@ public virtual Task UpdateJobAsync(Elastic.Clients.Elasticsea } /// - /// Updates certain properties of a snapshot. + /// + /// Updates certain properties of a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateModelSnapshotAsync(UpdateModelSnapshotRequest request, CancellationToken cancellationToken = default) @@ -4155,7 +6101,9 @@ public virtual Task UpdateModelSnapshotAsync(Update } /// - /// Updates certain properties of a snapshot. + /// + /// Updates certain properties of a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateModelSnapshotAsync(UpdateModelSnapshotRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4165,7 +6113,9 @@ public virtual Task UpdateModelSnapshotAsync(Update } /// - /// Updates certain properties of a snapshot. + /// + /// Updates certain properties of a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateModelSnapshotAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Elastic.Clients.Elasticsearch.Serverless.Id snapshotId, CancellationToken cancellationToken = default) @@ -4176,7 +6126,9 @@ public virtual Task UpdateModelSnapshotAsync(Elasti } /// - /// Updates certain properties of a snapshot. + /// + /// Updates certain properties of a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateModelSnapshotAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Elastic.Clients.Elasticsearch.Serverless.Id snapshotId, Action configureRequest, CancellationToken cancellationToken = default) @@ -4188,7 +6140,17 @@ public virtual Task UpdateModelSnapshotAsync(Elasti } /// - /// Upgrades an anomaly detection model snapshot to the latest major version.
Over time, older snapshot formats are deprecated and removed. Anomaly
detection jobs support only snapshots that are from the current or previous
major version.
This API provides a means to upgrade a snapshot to the current major version.
This aids in preparing the cluster for an upgrade to the next major version.
Only one snapshot per anomaly detection job can be upgraded at a time and the
upgraded snapshot cannot be the current snapshot of the anomaly detection
job. + /// + /// Upgrades an anomaly detection model snapshot to the latest major version. + /// Over time, older snapshot formats are deprecated and removed. Anomaly + /// detection jobs support only snapshots that are from the current or previous + /// major version. + /// This API provides a means to upgrade a snapshot to the current major version. + /// This aids in preparing the cluster for an upgrade to the next major version. + /// Only one snapshot per anomaly detection job can be upgraded at a time and the + /// upgraded snapshot cannot be the current snapshot of the anomaly detection + /// job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpgradeJobSnapshotAsync(UpgradeJobSnapshotRequest request, CancellationToken cancellationToken = default) @@ -4198,7 +6160,17 @@ public virtual Task UpgradeJobSnapshotAsync(UpgradeJ } /// - /// Upgrades an anomaly detection model snapshot to the latest major version.
Over time, older snapshot formats are deprecated and removed. Anomaly
detection jobs support only snapshots that are from the current or previous
major version.
This API provides a means to upgrade a snapshot to the current major version.
This aids in preparing the cluster for an upgrade to the next major version.
Only one snapshot per anomaly detection job can be upgraded at a time and the
upgraded snapshot cannot be the current snapshot of the anomaly detection
job. + /// + /// Upgrades an anomaly detection model snapshot to the latest major version. + /// Over time, older snapshot formats are deprecated and removed. Anomaly + /// detection jobs support only snapshots that are from the current or previous + /// major version. + /// This API provides a means to upgrade a snapshot to the current major version. + /// This aids in preparing the cluster for an upgrade to the next major version. + /// Only one snapshot per anomaly detection job can be upgraded at a time and the + /// upgraded snapshot cannot be the current snapshot of the anomaly detection + /// job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpgradeJobSnapshotAsync(UpgradeJobSnapshotRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4208,7 +6180,17 @@ public virtual Task UpgradeJobSnapshotAsync(UpgradeJ } /// - /// Upgrades an anomaly detection model snapshot to the latest major version.
Over time, older snapshot formats are deprecated and removed. Anomaly
detection jobs support only snapshots that are from the current or previous
major version.
This API provides a means to upgrade a snapshot to the current major version.
This aids in preparing the cluster for an upgrade to the next major version.
Only one snapshot per anomaly detection job can be upgraded at a time and the
upgraded snapshot cannot be the current snapshot of the anomaly detection
job. + /// + /// Upgrades an anomaly detection model snapshot to the latest major version. + /// Over time, older snapshot formats are deprecated and removed. Anomaly + /// detection jobs support only snapshots that are from the current or previous + /// major version. + /// This API provides a means to upgrade a snapshot to the current major version. + /// This aids in preparing the cluster for an upgrade to the next major version. + /// Only one snapshot per anomaly detection job can be upgraded at a time and the + /// upgraded snapshot cannot be the current snapshot of the anomaly detection + /// job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpgradeJobSnapshotAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Elastic.Clients.Elasticsearch.Serverless.Id snapshotId, CancellationToken cancellationToken = default) @@ -4219,7 +6201,17 @@ public virtual Task UpgradeJobSnapshotAsync(Elastic. } /// - /// Upgrades an anomaly detection model snapshot to the latest major version.
Over time, older snapshot formats are deprecated and removed. Anomaly
detection jobs support only snapshots that are from the current or previous
major version.
This API provides a means to upgrade a snapshot to the current major version.
This aids in preparing the cluster for an upgrade to the next major version.
Only one snapshot per anomaly detection job can be upgraded at a time and the
upgraded snapshot cannot be the current snapshot of the anomaly detection
job. + /// + /// Upgrades an anomaly detection model snapshot to the latest major version. + /// Over time, older snapshot formats are deprecated and removed. Anomaly + /// detection jobs support only snapshots that are from the current or previous + /// major version. + /// This API provides a means to upgrade a snapshot to the current major version. + /// This aids in preparing the cluster for an upgrade to the next major version. + /// Only one snapshot per anomaly detection job can be upgraded at a time and the + /// upgraded snapshot cannot be the current snapshot of the anomaly detection + /// job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpgradeJobSnapshotAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Elastic.Clients.Elasticsearch.Serverless.Id snapshotId, Action configureRequest, CancellationToken cancellationToken = default) @@ -4231,7 +6223,9 @@ public virtual Task UpgradeJobSnapshotAsync(Elastic. } /// - /// Validates an anomaly detection job. + /// + /// Validates an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateAsync(ValidateRequest request, CancellationToken cancellationToken = default) @@ -4241,7 +6235,9 @@ public virtual Task ValidateAsync(ValidateRequest request, Can } /// - /// Validates an anomaly detection job. + /// + /// Validates an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateAsync(ValidateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4251,7 +6247,9 @@ public virtual Task ValidateAsync(ValidateRequestDe } /// - /// Validates an anomaly detection job. + /// + /// Validates an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateAsync(CancellationToken cancellationToken = default) @@ -4262,7 +6260,9 @@ public virtual Task ValidateAsync(CancellationToken } /// - /// Validates an anomaly detection job. + /// + /// Validates an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -4274,7 +6274,9 @@ public virtual Task ValidateAsync(Action - /// Validates an anomaly detection job. + /// + /// Validates an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateAsync(ValidateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4284,7 +6286,9 @@ public virtual Task ValidateAsync(ValidateRequestDescriptor de } /// - /// Validates an anomaly detection job. + /// + /// Validates an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateAsync(CancellationToken cancellationToken = default) @@ -4295,7 +6299,9 @@ public virtual Task ValidateAsync(CancellationToken cancellati } /// - /// Validates an anomaly detection job. + /// + /// Validates an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -4307,7 +6313,9 @@ public virtual Task ValidateAsync(Action - /// Validates an anomaly detection detector. + /// + /// Validates an anomaly detection detector. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateDetectorAsync(ValidateDetectorRequest request, CancellationToken cancellationToken = default) @@ -4317,7 +6325,9 @@ public virtual Task ValidateDetectorAsync(ValidateDete } /// - /// Validates an anomaly detection detector. + /// + /// Validates an anomaly detection detector. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateDetectorAsync(ValidateDetectorRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4327,7 +6337,9 @@ public virtual Task ValidateDetectorAsync(V } /// - /// Validates an anomaly detection detector. + /// + /// Validates an anomaly detection detector. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateDetectorAsync(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Detector detector, CancellationToken cancellationToken = default) @@ -4338,7 +6350,9 @@ public virtual Task ValidateDetectorAsync(E } /// - /// Validates an anomaly detection detector. + /// + /// Validates an anomaly detection detector. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateDetectorAsync(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Detector detector, Action> configureRequest, CancellationToken cancellationToken = default) @@ -4350,7 +6364,9 @@ public virtual Task ValidateDetectorAsync(E } /// - /// Validates an anomaly detection detector. + /// + /// Validates an anomaly detection detector. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateDetectorAsync(ValidateDetectorRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4360,7 +6376,9 @@ public virtual Task ValidateDetectorAsync(ValidateDete } /// - /// Validates an anomaly detection detector. + /// + /// Validates an anomaly detection detector. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateDetectorAsync(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Detector detector, CancellationToken cancellationToken = default) @@ -4371,7 +6389,9 @@ public virtual Task ValidateDetectorAsync(Elastic.Clie } /// - /// Validates an anomaly detection detector. + /// + /// Validates an anomaly detection detector. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateDetectorAsync(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Detector detector, Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Nodes.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Nodes.g.cs index 09d07a321af..747843a3c0c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Nodes.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Nodes.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public partial class NodesNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected NodesNamespacedClient() : base() { @@ -38,7 +40,10 @@ internal NodesNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// This API yields a breakdown of the hot threads on each selected node in the cluster.
The output is plain text with a breakdown of each node’s top hot threads. + /// + /// This API yields a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of each node’s top hot threads. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HotThreadsAsync(HotThreadsRequest request, CancellationToken cancellationToken = default) @@ -48,7 +53,10 @@ public virtual Task HotThreadsAsync(HotThreadsRequest reques } /// - /// This API yields a breakdown of the hot threads on each selected node in the cluster.
The output is plain text with a breakdown of each node’s top hot threads. + /// + /// This API yields a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of each node’s top hot threads. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HotThreadsAsync(HotThreadsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -58,7 +66,10 @@ public virtual Task HotThreadsAsync(HotThreadsRequestDescrip } /// - /// This API yields a breakdown of the hot threads on each selected node in the cluster.
The output is plain text with a breakdown of each node’s top hot threads. + /// + /// This API yields a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of each node’s top hot threads. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HotThreadsAsync(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeId, CancellationToken cancellationToken = default) @@ -69,7 +80,10 @@ public virtual Task HotThreadsAsync(Elastic.Clients.Elastics } /// - /// This API yields a breakdown of the hot threads on each selected node in the cluster.
The output is plain text with a breakdown of each node’s top hot threads. + /// + /// This API yields a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of each node’s top hot threads. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HotThreadsAsync(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeId, Action configureRequest, CancellationToken cancellationToken = default) @@ -81,7 +95,10 @@ public virtual Task HotThreadsAsync(Elastic.Clients.Elastics } /// - /// This API yields a breakdown of the hot threads on each selected node in the cluster.
The output is plain text with a breakdown of each node’s top hot threads. + /// + /// This API yields a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of each node’s top hot threads. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HotThreadsAsync(CancellationToken cancellationToken = default) @@ -92,7 +109,10 @@ public virtual Task HotThreadsAsync(CancellationToken cancel } /// - /// This API yields a breakdown of the hot threads on each selected node in the cluster.
The output is plain text with a breakdown of each node’s top hot threads. + /// + /// This API yields a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of each node’s top hot threads. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HotThreadsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -104,7 +124,9 @@ public virtual Task HotThreadsAsync(Action - /// Returns cluster nodes information. + /// + /// Returns cluster nodes information. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(NodesInfoRequest request, CancellationToken cancellationToken = default) @@ -114,7 +136,9 @@ public virtual Task InfoAsync(NodesInfoRequest request, Cance } /// - /// Returns cluster nodes information. + /// + /// Returns cluster nodes information. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(NodesInfoRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -124,7 +148,9 @@ public virtual Task InfoAsync(NodesInfoRequestDescriptor desc } /// - /// Returns cluster nodes information. + /// + /// Returns cluster nodes information. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Serverless.Metrics? metric, CancellationToken cancellationToken = default) @@ -135,7 +161,9 @@ public virtual Task InfoAsync(Elastic.Clients.Elasticsearch.S } /// - /// Returns cluster nodes information. + /// + /// Returns cluster nodes information. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Serverless.Metrics? metric, Action configureRequest, CancellationToken cancellationToken = default) @@ -147,7 +175,9 @@ public virtual Task InfoAsync(Elastic.Clients.Elasticsearch.S } /// - /// Returns cluster nodes information. + /// + /// Returns cluster nodes information. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(CancellationToken cancellationToken = default) @@ -158,7 +188,9 @@ public virtual Task InfoAsync(CancellationToken cancellationT } /// - /// Returns cluster nodes information. + /// + /// Returns cluster nodes information. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -170,7 +202,9 @@ public virtual Task InfoAsync(Action - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(NodesStatsRequest request, CancellationToken cancellationToken = default) @@ -180,7 +214,9 @@ public virtual Task StatsAsync(NodesStatsRequest request, Ca } /// - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(NodesStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -190,7 +226,9 @@ public virtual Task StatsAsync(NodesStatsRequestD } /// - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Serverless.Metrics? metric, Elastic.Clients.Elasticsearch.Serverless.Metrics? indexMetric, CancellationToken cancellationToken = default) @@ -201,7 +239,9 @@ public virtual Task StatsAsync(Elastic.Clients.El } /// - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Serverless.Metrics? metric, Elastic.Clients.Elasticsearch.Serverless.Metrics? indexMetric, Action> configureRequest, CancellationToken cancellationToken = default) @@ -213,7 +253,9 @@ public virtual Task StatsAsync(Elastic.Clients.El } /// - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(CancellationToken cancellationToken = default) @@ -224,7 +266,9 @@ public virtual Task StatsAsync(CancellationToken } /// - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -236,7 +280,9 @@ public virtual Task StatsAsync(Action - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(NodesStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -246,7 +292,9 @@ public virtual Task StatsAsync(NodesStatsRequestDescriptor d } /// - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Serverless.Metrics? metric, Elastic.Clients.Elasticsearch.Serverless.Metrics? indexMetric, CancellationToken cancellationToken = default) @@ -257,7 +305,9 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsearch } /// - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Serverless.Metrics? metric, Elastic.Clients.Elasticsearch.Serverless.Metrics? indexMetric, Action configureRequest, CancellationToken cancellationToken = default) @@ -269,7 +319,9 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsearch } /// - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(CancellationToken cancellationToken = default) @@ -280,7 +332,9 @@ public virtual Task StatsAsync(CancellationToken cancellatio } /// - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -292,7 +346,9 @@ public virtual Task StatsAsync(Action - /// Returns information on the usage of features. + /// + /// Returns information on the usage of features. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(NodesUsageRequest request, CancellationToken cancellationToken = default) @@ -302,7 +358,9 @@ public virtual Task UsageAsync(NodesUsageRequest request, Ca } /// - /// Returns information on the usage of features. + /// + /// Returns information on the usage of features. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(NodesUsageRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -312,7 +370,9 @@ public virtual Task UsageAsync(NodesUsageRequestDescriptor d } /// - /// Returns information on the usage of features. + /// + /// Returns information on the usage of features. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Serverless.Metrics? metric, CancellationToken cancellationToken = default) @@ -323,7 +383,9 @@ public virtual Task UsageAsync(Elastic.Clients.Elasticsearch } /// - /// Returns information on the usage of features. + /// + /// Returns information on the usage of features. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Serverless.Metrics? metric, Action configureRequest, CancellationToken cancellationToken = default) @@ -335,7 +397,9 @@ public virtual Task UsageAsync(Elastic.Clients.Elasticsearch } /// - /// Returns information on the usage of features. + /// + /// Returns information on the usage of features. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(CancellationToken cancellationToken = default) @@ -346,7 +410,9 @@ public virtual Task UsageAsync(CancellationToken cancellatio } /// - /// Returns information on the usage of features. + /// + /// Returns information on the usage of features. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.QueryRules.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.QueryRules.g.cs index e44e5035f6f..9adeb57e856 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.QueryRules.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.QueryRules.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryRules; public partial class QueryRulesNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected QueryRulesNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal QueryRulesNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// Deletes a query rule within a query ruleset. + /// + /// Deletes a query rule within a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteRuleAsync(DeleteRuleRequest request, CancellationToken cancellationToken = default) @@ -48,7 +52,9 @@ public virtual Task DeleteRuleAsync(DeleteRuleRequest reques } /// - /// Deletes a query rule within a query ruleset. + /// + /// Deletes a query rule within a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteRuleAsync(DeleteRuleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -58,7 +64,9 @@ public virtual Task DeleteRuleAsync(DeleteRuleRequestDescrip } /// - /// Deletes a query rule within a query ruleset. + /// + /// Deletes a query rule within a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteRuleAsync(Elastic.Clients.Elasticsearch.Serverless.Id rulesetId, Elastic.Clients.Elasticsearch.Serverless.Id ruleId, CancellationToken cancellationToken = default) @@ -69,7 +77,9 @@ public virtual Task DeleteRuleAsync(Elastic.Clients.Elastics } /// - /// Deletes a query rule within a query ruleset. + /// + /// Deletes a query rule within a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteRuleAsync(Elastic.Clients.Elasticsearch.Serverless.Id rulesetId, Elastic.Clients.Elasticsearch.Serverless.Id ruleId, Action configureRequest, CancellationToken cancellationToken = default) @@ -81,7 +91,9 @@ public virtual Task DeleteRuleAsync(Elastic.Clients.Elastics } /// - /// Deletes a query ruleset. + /// + /// Deletes a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteRulesetAsync(DeleteRulesetRequest request, CancellationToken cancellationToken = default) @@ -91,7 +103,9 @@ public virtual Task DeleteRulesetAsync(DeleteRulesetReque } /// - /// Deletes a query ruleset. + /// + /// Deletes a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteRulesetAsync(DeleteRulesetRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -101,7 +115,9 @@ public virtual Task DeleteRulesetAsync(DeleteRulesetReque } /// - /// Deletes a query ruleset. + /// + /// Deletes a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteRulesetAsync(Elastic.Clients.Elasticsearch.Serverless.Id rulesetId, CancellationToken cancellationToken = default) @@ -112,7 +128,9 @@ public virtual Task DeleteRulesetAsync(Elastic.Clients.El } /// - /// Deletes a query ruleset. + /// + /// Deletes a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteRulesetAsync(Elastic.Clients.Elasticsearch.Serverless.Id rulesetId, Action configureRequest, CancellationToken cancellationToken = default) @@ -124,7 +142,9 @@ public virtual Task DeleteRulesetAsync(Elastic.Clients.El } /// - /// Returns the details about a query rule within a query ruleset + /// + /// Returns the details about a query rule within a query ruleset + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRuleAsync(GetRuleRequest request, CancellationToken cancellationToken = default) @@ -134,7 +154,9 @@ public virtual Task GetRuleAsync(GetRuleRequest request, Cancel } /// - /// Returns the details about a query rule within a query ruleset + /// + /// Returns the details about a query rule within a query ruleset + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRuleAsync(GetRuleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -144,7 +166,9 @@ public virtual Task GetRuleAsync(GetRuleRequestDescriptor descr } /// - /// Returns the details about a query rule within a query ruleset + /// + /// Returns the details about a query rule within a query ruleset + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRuleAsync(Elastic.Clients.Elasticsearch.Serverless.Id rulesetId, Elastic.Clients.Elasticsearch.Serverless.Id ruleId, CancellationToken cancellationToken = default) @@ -155,7 +179,9 @@ public virtual Task GetRuleAsync(Elastic.Clients.Elasticsearch. } /// - /// Returns the details about a query rule within a query ruleset + /// + /// Returns the details about a query rule within a query ruleset + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRuleAsync(Elastic.Clients.Elasticsearch.Serverless.Id rulesetId, Elastic.Clients.Elasticsearch.Serverless.Id ruleId, Action configureRequest, CancellationToken cancellationToken = default) @@ -167,7 +193,9 @@ public virtual Task GetRuleAsync(Elastic.Clients.Elasticsearch. } /// - /// Returns the details about a query ruleset + /// + /// Returns the details about a query ruleset + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRulesetAsync(GetRulesetRequest request, CancellationToken cancellationToken = default) @@ -177,7 +205,9 @@ public virtual Task GetRulesetAsync(GetRulesetRequest reques } /// - /// Returns the details about a query ruleset + /// + /// Returns the details about a query ruleset + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRulesetAsync(GetRulesetRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -187,7 +217,9 @@ public virtual Task GetRulesetAsync(GetRulesetRequestDescrip } /// - /// Returns the details about a query ruleset + /// + /// Returns the details about a query ruleset + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRulesetAsync(Elastic.Clients.Elasticsearch.Serverless.Id rulesetId, CancellationToken cancellationToken = default) @@ -198,7 +230,9 @@ public virtual Task GetRulesetAsync(Elastic.Clients.Elastics } /// - /// Returns the details about a query ruleset + /// + /// Returns the details about a query ruleset + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRulesetAsync(Elastic.Clients.Elasticsearch.Serverless.Id rulesetId, Action configureRequest, CancellationToken cancellationToken = default) @@ -210,7 +244,9 @@ public virtual Task GetRulesetAsync(Elastic.Clients.Elastics } /// - /// Returns summarized information about existing query rulesets. + /// + /// Returns summarized information about existing query rulesets. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ListRulesetsAsync(ListRulesetsRequest request, CancellationToken cancellationToken = default) @@ -220,7 +256,9 @@ public virtual Task ListRulesetsAsync(ListRulesetsRequest } /// - /// Returns summarized information about existing query rulesets. + /// + /// Returns summarized information about existing query rulesets. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ListRulesetsAsync(ListRulesetsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -230,7 +268,9 @@ public virtual Task ListRulesetsAsync(ListRulesetsRequestD } /// - /// Returns summarized information about existing query rulesets. + /// + /// Returns summarized information about existing query rulesets. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ListRulesetsAsync(CancellationToken cancellationToken = default) @@ -241,7 +281,9 @@ public virtual Task ListRulesetsAsync(CancellationToken ca } /// - /// Returns summarized information about existing query rulesets. + /// + /// Returns summarized information about existing query rulesets. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ListRulesetsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -253,7 +295,9 @@ public virtual Task ListRulesetsAsync(Action - /// Creates or updates a query rule within a query ruleset. + /// + /// Creates or updates a query rule within a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutRuleAsync(PutRuleRequest request, CancellationToken cancellationToken = default) @@ -263,7 +307,9 @@ public virtual Task PutRuleAsync(PutRuleRequest request, Cancel } /// - /// Creates or updates a query rule within a query ruleset. + /// + /// Creates or updates a query rule within a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutRuleAsync(PutRuleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -273,7 +319,9 @@ public virtual Task PutRuleAsync(PutRuleRequestDescriptor descr } /// - /// Creates or updates a query rule within a query ruleset. + /// + /// Creates or updates a query rule within a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutRuleAsync(Elastic.Clients.Elasticsearch.Serverless.Id rulesetId, Elastic.Clients.Elasticsearch.Serverless.Id ruleId, CancellationToken cancellationToken = default) @@ -284,7 +332,9 @@ public virtual Task PutRuleAsync(Elastic.Clients.Elasticsearch. } /// - /// Creates or updates a query rule within a query ruleset. + /// + /// Creates or updates a query rule within a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutRuleAsync(Elastic.Clients.Elasticsearch.Serverless.Id rulesetId, Elastic.Clients.Elasticsearch.Serverless.Id ruleId, Action configureRequest, CancellationToken cancellationToken = default) @@ -296,7 +346,9 @@ public virtual Task PutRuleAsync(Elastic.Clients.Elasticsearch. } /// - /// Creates or updates a query ruleset. + /// + /// Creates or updates a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutRulesetAsync(PutRulesetRequest request, CancellationToken cancellationToken = default) @@ -306,7 +358,9 @@ public virtual Task PutRulesetAsync(PutRulesetRequest reques } /// - /// Creates or updates a query ruleset. + /// + /// Creates or updates a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutRulesetAsync(PutRulesetRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -316,7 +370,9 @@ public virtual Task PutRulesetAsync(PutRulesetRequestDescrip } /// - /// Creates or updates a query ruleset. + /// + /// Creates or updates a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutRulesetAsync(Elastic.Clients.Elasticsearch.Serverless.Id rulesetId, CancellationToken cancellationToken = default) @@ -327,7 +383,9 @@ public virtual Task PutRulesetAsync(Elastic.Clients.Elastics } /// - /// Creates or updates a query ruleset. + /// + /// Creates or updates a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutRulesetAsync(Elastic.Clients.Elasticsearch.Serverless.Id rulesetId, Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Slm.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Slm.g.cs index 311d84cb9a9..7103898eb08 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Slm.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Slm.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.SnapshotLifecycleManagement; public partial class SnapshotLifecycleManagementNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected SnapshotLifecycleManagementNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal SnapshotLifecycleManagementNamespacedClient(ElasticsearchClient client) } /// - /// Deletes an existing snapshot lifecycle policy. + /// + /// Deletes an existing snapshot lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteLifecycleAsync(DeleteLifecycleRequest request, CancellationToken cancellationToken = default) @@ -48,7 +52,9 @@ public virtual Task DeleteLifecycleAsync(DeleteLifecycl } /// - /// Deletes an existing snapshot lifecycle policy. + /// + /// Deletes an existing snapshot lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteLifecycleAsync(DeleteLifecycleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -58,7 +64,9 @@ public virtual Task DeleteLifecycleAsync(DeleteLifecycl } /// - /// Deletes an existing snapshot lifecycle policy. + /// + /// Deletes an existing snapshot lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteLifecycleAsync(Elastic.Clients.Elasticsearch.Serverless.Name policyId, CancellationToken cancellationToken = default) @@ -69,7 +77,9 @@ public virtual Task DeleteLifecycleAsync(Elastic.Client } /// - /// Deletes an existing snapshot lifecycle policy. + /// + /// Deletes an existing snapshot lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteLifecycleAsync(Elastic.Clients.Elasticsearch.Serverless.Name policyId, Action configureRequest, CancellationToken cancellationToken = default) @@ -81,7 +91,9 @@ public virtual Task DeleteLifecycleAsync(Elastic.Client } /// - /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// + /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExecuteLifecycleAsync(ExecuteLifecycleRequest request, CancellationToken cancellationToken = default) @@ -91,7 +103,9 @@ public virtual Task ExecuteLifecycleAsync(ExecuteLifec } /// - /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// + /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExecuteLifecycleAsync(ExecuteLifecycleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -101,7 +115,9 @@ public virtual Task ExecuteLifecycleAsync(ExecuteLifec } /// - /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// + /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExecuteLifecycleAsync(Elastic.Clients.Elasticsearch.Serverless.Name policyId, CancellationToken cancellationToken = default) @@ -112,7 +128,9 @@ public virtual Task ExecuteLifecycleAsync(Elastic.Clie } /// - /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// + /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExecuteLifecycleAsync(Elastic.Clients.Elasticsearch.Serverless.Name policyId, Action configureRequest, CancellationToken cancellationToken = default) @@ -124,7 +142,9 @@ public virtual Task ExecuteLifecycleAsync(Elastic.Clie } /// - /// Deletes any snapshots that are expired according to the policy's retention rules. + /// + /// Deletes any snapshots that are expired according to the policy's retention rules. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExecuteRetentionAsync(ExecuteRetentionRequest request, CancellationToken cancellationToken = default) @@ -134,7 +154,9 @@ public virtual Task ExecuteRetentionAsync(ExecuteReten } /// - /// Deletes any snapshots that are expired according to the policy's retention rules. + /// + /// Deletes any snapshots that are expired according to the policy's retention rules. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExecuteRetentionAsync(ExecuteRetentionRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -144,7 +166,9 @@ public virtual Task ExecuteRetentionAsync(ExecuteReten } /// - /// Deletes any snapshots that are expired according to the policy's retention rules. + /// + /// Deletes any snapshots that are expired according to the policy's retention rules. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExecuteRetentionAsync(CancellationToken cancellationToken = default) @@ -155,7 +179,9 @@ public virtual Task ExecuteRetentionAsync(Cancellation } /// - /// Deletes any snapshots that are expired according to the policy's retention rules. + /// + /// Deletes any snapshots that are expired according to the policy's retention rules. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExecuteRetentionAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -167,7 +193,9 @@ public virtual Task ExecuteRetentionAsync(Action - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// + /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetLifecycleAsync(GetLifecycleRequest request, CancellationToken cancellationToken = default) @@ -177,7 +205,9 @@ public virtual Task GetLifecycleAsync(GetLifecycleRequest } /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// + /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetLifecycleAsync(GetLifecycleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -187,7 +217,9 @@ public virtual Task GetLifecycleAsync(GetLifecycleRequestD } /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// + /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetLifecycleAsync(Elastic.Clients.Elasticsearch.Serverless.Names? policyId, CancellationToken cancellationToken = default) @@ -198,7 +230,9 @@ public virtual Task GetLifecycleAsync(Elastic.Clients.Elas } /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// + /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetLifecycleAsync(Elastic.Clients.Elasticsearch.Serverless.Names? policyId, Action configureRequest, CancellationToken cancellationToken = default) @@ -210,7 +244,9 @@ public virtual Task GetLifecycleAsync(Elastic.Clients.Elas } /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// + /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetLifecycleAsync(CancellationToken cancellationToken = default) @@ -221,7 +257,9 @@ public virtual Task GetLifecycleAsync(CancellationToken ca } /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// + /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetLifecycleAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -233,7 +271,9 @@ public virtual Task GetLifecycleAsync(Action - /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// + /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatsAsync(GetStatsRequest request, CancellationToken cancellationToken = default) @@ -243,7 +283,9 @@ public virtual Task GetStatsAsync(GetStatsRequest request, Can } /// - /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// + /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatsAsync(GetStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -253,7 +295,9 @@ public virtual Task GetStatsAsync(GetStatsRequestDescriptor de } /// - /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// + /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatsAsync(CancellationToken cancellationToken = default) @@ -264,7 +308,9 @@ public virtual Task GetStatsAsync(CancellationToken cancellati } /// - /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// + /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -276,7 +322,9 @@ public virtual Task GetStatsAsync(Action - /// Retrieves the status of snapshot lifecycle management (SLM). + /// + /// Retrieves the status of snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(GetSlmStatusRequest request, CancellationToken cancellationToken = default) @@ -286,7 +334,9 @@ public virtual Task GetStatusAsync(GetSlmStatusRequest req } /// - /// Retrieves the status of snapshot lifecycle management (SLM). + /// + /// Retrieves the status of snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(GetSlmStatusRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -296,7 +346,9 @@ public virtual Task GetStatusAsync(GetSlmStatusRequestDesc } /// - /// Retrieves the status of snapshot lifecycle management (SLM). + /// + /// Retrieves the status of snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(CancellationToken cancellationToken = default) @@ -307,7 +359,9 @@ public virtual Task GetStatusAsync(CancellationToken cance } /// - /// Retrieves the status of snapshot lifecycle management (SLM). + /// + /// Retrieves the status of snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -319,7 +373,9 @@ public virtual Task GetStatusAsync(Action - /// Creates or updates a snapshot lifecycle policy. + /// + /// Creates or updates a snapshot lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutLifecycleAsync(PutLifecycleRequest request, CancellationToken cancellationToken = default) @@ -329,7 +385,9 @@ public virtual Task PutLifecycleAsync(PutLifecycleRequest } /// - /// Creates or updates a snapshot lifecycle policy. + /// + /// Creates or updates a snapshot lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutLifecycleAsync(PutLifecycleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -339,7 +397,9 @@ public virtual Task PutLifecycleAsync(PutLifecycleRequestD } /// - /// Creates or updates a snapshot lifecycle policy. + /// + /// Creates or updates a snapshot lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutLifecycleAsync(Elastic.Clients.Elasticsearch.Serverless.Name policyId, CancellationToken cancellationToken = default) @@ -350,7 +410,9 @@ public virtual Task PutLifecycleAsync(Elastic.Clients.Elas } /// - /// Creates or updates a snapshot lifecycle policy. + /// + /// Creates or updates a snapshot lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutLifecycleAsync(Elastic.Clients.Elasticsearch.Serverless.Name policyId, Action configureRequest, CancellationToken cancellationToken = default) @@ -362,7 +424,9 @@ public virtual Task PutLifecycleAsync(Elastic.Clients.Elas } /// - /// Turns on snapshot lifecycle management (SLM). + /// + /// Turns on snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartAsync(StartSlmRequest request, CancellationToken cancellationToken = default) @@ -372,7 +436,9 @@ public virtual Task StartAsync(StartSlmRequest request, Cancel } /// - /// Turns on snapshot lifecycle management (SLM). + /// + /// Turns on snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartAsync(StartSlmRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -382,7 +448,9 @@ public virtual Task StartAsync(StartSlmRequestDescriptor descr } /// - /// Turns on snapshot lifecycle management (SLM). + /// + /// Turns on snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartAsync(CancellationToken cancellationToken = default) @@ -393,7 +461,9 @@ public virtual Task StartAsync(CancellationToken cancellationT } /// - /// Turns on snapshot lifecycle management (SLM). + /// + /// Turns on snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -405,7 +475,9 @@ public virtual Task StartAsync(Action - /// Turns off snapshot lifecycle management (SLM). + /// + /// Turns off snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopAsync(StopSlmRequest request, CancellationToken cancellationToken = default) @@ -415,7 +487,9 @@ public virtual Task StopAsync(StopSlmRequest request, Cancellat } /// - /// Turns off snapshot lifecycle management (SLM). + /// + /// Turns off snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopAsync(StopSlmRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -425,7 +499,9 @@ public virtual Task StopAsync(StopSlmRequestDescriptor descript } /// - /// Turns off snapshot lifecycle management (SLM). + /// + /// Turns off snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopAsync(CancellationToken cancellationToken = default) @@ -436,7 +512,9 @@ public virtual Task StopAsync(CancellationToken cancellationTok } /// - /// Turns off snapshot lifecycle management (SLM). + /// + /// Turns off snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopAsync(Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Snapshot.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Snapshot.g.cs index 81c40f79b38..1993aa63876 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Snapshot.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Snapshot.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Snapshot; public partial class SnapshotNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected SnapshotNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal SnapshotNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// + /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CleanupRepositoryAsync(CleanupRepositoryRequest request, CancellationToken cancellationToken = default) @@ -48,7 +52,9 @@ public virtual Task CleanupRepositoryAsync(CleanupRep } /// - /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// + /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CleanupRepositoryAsync(CleanupRepositoryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -58,7 +64,9 @@ public virtual Task CleanupRepositoryAsync(CleanupRep } /// - /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// + /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CleanupRepositoryAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, CancellationToken cancellationToken = default) @@ -69,7 +77,9 @@ public virtual Task CleanupRepositoryAsync(Elastic.Cl } /// - /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// + /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CleanupRepositoryAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -81,7 +91,9 @@ public virtual Task CleanupRepositoryAsync(Elastic.Cl } /// - /// Clones indices from one snapshot into another snapshot in the same repository. + /// + /// Clones indices from one snapshot into another snapshot in the same repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloneAsync(CloneSnapshotRequest request, CancellationToken cancellationToken = default) @@ -91,7 +103,9 @@ public virtual Task CloneAsync(CloneSnapshotRequest reque } /// - /// Clones indices from one snapshot into another snapshot in the same repository. + /// + /// Clones indices from one snapshot into another snapshot in the same repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloneAsync(CloneSnapshotRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -101,7 +115,9 @@ public virtual Task CloneAsync(CloneSnapshotRequestDescri } /// - /// Clones indices from one snapshot into another snapshot in the same repository. + /// + /// Clones indices from one snapshot into another snapshot in the same repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloneAsync(Elastic.Clients.Elasticsearch.Serverless.Name repository, Elastic.Clients.Elasticsearch.Serverless.Name snapshot, Elastic.Clients.Elasticsearch.Serverless.Name targetSnapshot, CancellationToken cancellationToken = default) @@ -112,7 +128,9 @@ public virtual Task CloneAsync(Elastic.Clients.Elasticsea } /// - /// Clones indices from one snapshot into another snapshot in the same repository. + /// + /// Clones indices from one snapshot into another snapshot in the same repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloneAsync(Elastic.Clients.Elasticsearch.Serverless.Name repository, Elastic.Clients.Elasticsearch.Serverless.Name snapshot, Elastic.Clients.Elasticsearch.Serverless.Name targetSnapshot, Action configureRequest, CancellationToken cancellationToken = default) @@ -124,7 +142,9 @@ public virtual Task CloneAsync(Elastic.Clients.Elasticsea } /// - /// Creates a snapshot in a repository. + /// + /// Creates a snapshot in a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(CreateSnapshotRequest request, CancellationToken cancellationToken = default) @@ -134,7 +154,9 @@ public virtual Task CreateAsync(CreateSnapshotRequest re } /// - /// Creates a snapshot in a repository. + /// + /// Creates a snapshot in a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(CreateSnapshotRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -144,7 +166,9 @@ public virtual Task CreateAsync(CreateSnapshotRequestDes } /// - /// Creates a snapshot in a repository. + /// + /// Creates a snapshot in a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(Elastic.Clients.Elasticsearch.Serverless.Name repository, Elastic.Clients.Elasticsearch.Serverless.Name snapshot, CancellationToken cancellationToken = default) @@ -155,7 +179,9 @@ public virtual Task CreateAsync(Elastic.Clients.Elastics } /// - /// Creates a snapshot in a repository. + /// + /// Creates a snapshot in a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(Elastic.Clients.Elasticsearch.Serverless.Name repository, Elastic.Clients.Elasticsearch.Serverless.Name snapshot, Action configureRequest, CancellationToken cancellationToken = default) @@ -167,7 +193,9 @@ public virtual Task CreateAsync(Elastic.Clients.Elastics } /// - /// Creates a repository. + /// + /// Creates a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateRepositoryAsync(CreateRepositoryRequest request, CancellationToken cancellationToken = default) @@ -177,7 +205,9 @@ public virtual Task CreateRepositoryAsync(CreateReposi } /// - /// Creates a repository. + /// + /// Creates a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateRepositoryAsync(CreateRepositoryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -187,7 +217,9 @@ public virtual Task CreateRepositoryAsync(CreateReposi } /// - /// Creates a repository. + /// + /// Creates a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateRepositoryAsync(Elastic.Clients.Elasticsearch.Serverless.Snapshot.IRepository repository, Elastic.Clients.Elasticsearch.Serverless.Name name, CancellationToken cancellationToken = default) @@ -198,7 +230,9 @@ public virtual Task CreateRepositoryAsync(Elastic.Clie } /// - /// Creates a repository. + /// + /// Creates a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateRepositoryAsync(Elastic.Clients.Elasticsearch.Serverless.Snapshot.IRepository repository, Elastic.Clients.Elasticsearch.Serverless.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -210,7 +244,9 @@ public virtual Task CreateRepositoryAsync(Elastic.Clie } /// - /// Deletes one or more snapshots. + /// + /// Deletes one or more snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteSnapshotRequest request, CancellationToken cancellationToken = default) @@ -220,7 +256,9 @@ public virtual Task DeleteAsync(DeleteSnapshotRequest re } /// - /// Deletes one or more snapshots. + /// + /// Deletes one or more snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteSnapshotRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -230,7 +268,9 @@ public virtual Task DeleteAsync(DeleteSnapshotRequestDes } /// - /// Deletes one or more snapshots. + /// + /// Deletes one or more snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Serverless.Name repository, Elastic.Clients.Elasticsearch.Serverless.Name snapshot, CancellationToken cancellationToken = default) @@ -241,7 +281,9 @@ public virtual Task DeleteAsync(Elastic.Clients.Elastics } /// - /// Deletes one or more snapshots. + /// + /// Deletes one or more snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Serverless.Name repository, Elastic.Clients.Elasticsearch.Serverless.Name snapshot, Action configureRequest, CancellationToken cancellationToken = default) @@ -253,7 +295,9 @@ public virtual Task DeleteAsync(Elastic.Clients.Elastics } /// - /// Deletes a repository. + /// + /// Deletes a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteRepositoryAsync(DeleteRepositoryRequest request, CancellationToken cancellationToken = default) @@ -263,7 +307,9 @@ public virtual Task DeleteRepositoryAsync(DeleteReposi } /// - /// Deletes a repository. + /// + /// Deletes a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteRepositoryAsync(DeleteRepositoryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -273,7 +319,9 @@ public virtual Task DeleteRepositoryAsync(DeleteReposi } /// - /// Deletes a repository. + /// + /// Deletes a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteRepositoryAsync(Elastic.Clients.Elasticsearch.Serverless.Names name, CancellationToken cancellationToken = default) @@ -284,7 +332,9 @@ public virtual Task DeleteRepositoryAsync(Elastic.Clie } /// - /// Deletes a repository. + /// + /// Deletes a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteRepositoryAsync(Elastic.Clients.Elasticsearch.Serverless.Names name, Action configureRequest, CancellationToken cancellationToken = default) @@ -296,7 +346,9 @@ public virtual Task DeleteRepositoryAsync(Elastic.Clie } /// - /// Returns information about a snapshot. + /// + /// Returns information about a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(GetSnapshotRequest request, CancellationToken cancellationToken = default) @@ -306,7 +358,9 @@ public virtual Task GetAsync(GetSnapshotRequest request, Ca } /// - /// Returns information about a snapshot. + /// + /// Returns information about a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(GetSnapshotRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -316,7 +370,9 @@ public virtual Task GetAsync(GetSnapshotRequestDescriptor d } /// - /// Returns information about a snapshot. + /// + /// Returns information about a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(Elastic.Clients.Elasticsearch.Serverless.Name repository, Elastic.Clients.Elasticsearch.Serverless.Names snapshot, CancellationToken cancellationToken = default) @@ -327,7 +383,9 @@ public virtual Task GetAsync(Elastic.Clients.Elasticsearch. } /// - /// Returns information about a snapshot. + /// + /// Returns information about a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(Elastic.Clients.Elasticsearch.Serverless.Name repository, Elastic.Clients.Elasticsearch.Serverless.Names snapshot, Action configureRequest, CancellationToken cancellationToken = default) @@ -339,7 +397,9 @@ public virtual Task GetAsync(Elastic.Clients.Elasticsearch. } /// - /// Returns information about a repository. + /// + /// Returns information about a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRepositoryAsync(GetRepositoryRequest request, CancellationToken cancellationToken = default) @@ -349,7 +409,9 @@ public virtual Task GetRepositoryAsync(GetRepositoryReque } /// - /// Returns information about a repository. + /// + /// Returns information about a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRepositoryAsync(GetRepositoryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -359,7 +421,9 @@ public virtual Task GetRepositoryAsync(GetRepositoryReque } /// - /// Returns information about a repository. + /// + /// Returns information about a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRepositoryAsync(Elastic.Clients.Elasticsearch.Serverless.Names? name, CancellationToken cancellationToken = default) @@ -370,7 +434,9 @@ public virtual Task GetRepositoryAsync(Elastic.Clients.El } /// - /// Returns information about a repository. + /// + /// Returns information about a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRepositoryAsync(Elastic.Clients.Elasticsearch.Serverless.Names? name, Action configureRequest, CancellationToken cancellationToken = default) @@ -382,7 +448,9 @@ public virtual Task GetRepositoryAsync(Elastic.Clients.El } /// - /// Returns information about a repository. + /// + /// Returns information about a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRepositoryAsync(CancellationToken cancellationToken = default) @@ -393,7 +461,9 @@ public virtual Task GetRepositoryAsync(CancellationToken } /// - /// Returns information about a repository. + /// + /// Returns information about a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRepositoryAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -405,7 +475,9 @@ public virtual Task GetRepositoryAsync(Action - /// Restores a snapshot. + /// + /// Restores a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RestoreAsync(RestoreRequest request, CancellationToken cancellationToken = default) @@ -415,7 +487,9 @@ public virtual Task RestoreAsync(RestoreRequest request, Cancel } /// - /// Restores a snapshot. + /// + /// Restores a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RestoreAsync(RestoreRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -425,7 +499,9 @@ public virtual Task RestoreAsync(RestoreRequestDescr } /// - /// Restores a snapshot. + /// + /// Restores a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RestoreAsync(Elastic.Clients.Elasticsearch.Serverless.Name repository, Elastic.Clients.Elasticsearch.Serverless.Name snapshot, CancellationToken cancellationToken = default) @@ -436,7 +512,9 @@ public virtual Task RestoreAsync(Elastic.Clients.Ela } /// - /// Restores a snapshot. + /// + /// Restores a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RestoreAsync(Elastic.Clients.Elasticsearch.Serverless.Name repository, Elastic.Clients.Elasticsearch.Serverless.Name snapshot, Action> configureRequest, CancellationToken cancellationToken = default) @@ -448,7 +526,9 @@ public virtual Task RestoreAsync(Elastic.Clients.Ela } /// - /// Restores a snapshot. + /// + /// Restores a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RestoreAsync(RestoreRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -458,7 +538,9 @@ public virtual Task RestoreAsync(RestoreRequestDescriptor descr } /// - /// Restores a snapshot. + /// + /// Restores a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RestoreAsync(Elastic.Clients.Elasticsearch.Serverless.Name repository, Elastic.Clients.Elasticsearch.Serverless.Name snapshot, CancellationToken cancellationToken = default) @@ -469,7 +551,9 @@ public virtual Task RestoreAsync(Elastic.Clients.Elasticsearch. } /// - /// Restores a snapshot. + /// + /// Restores a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RestoreAsync(Elastic.Clients.Elasticsearch.Serverless.Name repository, Elastic.Clients.Elasticsearch.Serverless.Name snapshot, Action configureRequest, CancellationToken cancellationToken = default) @@ -481,7 +565,9 @@ public virtual Task RestoreAsync(Elastic.Clients.Elasticsearch. } /// - /// Returns information about the status of a snapshot. + /// + /// Returns information about the status of a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(SnapshotStatusRequest request, CancellationToken cancellationToken = default) @@ -491,7 +577,9 @@ public virtual Task StatusAsync(SnapshotStatusRequest re } /// - /// Returns information about the status of a snapshot. + /// + /// Returns information about the status of a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(SnapshotStatusRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -501,7 +589,9 @@ public virtual Task StatusAsync(SnapshotStatusRequestDes } /// - /// Returns information about the status of a snapshot. + /// + /// Returns information about the status of a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(Elastic.Clients.Elasticsearch.Serverless.Name? repository, Elastic.Clients.Elasticsearch.Serverless.Names? snapshot, CancellationToken cancellationToken = default) @@ -512,7 +602,9 @@ public virtual Task StatusAsync(Elastic.Clients.Elastics } /// - /// Returns information about the status of a snapshot. + /// + /// Returns information about the status of a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(Elastic.Clients.Elasticsearch.Serverless.Name? repository, Elastic.Clients.Elasticsearch.Serverless.Names? snapshot, Action configureRequest, CancellationToken cancellationToken = default) @@ -524,7 +616,9 @@ public virtual Task StatusAsync(Elastic.Clients.Elastics } /// - /// Returns information about the status of a snapshot. + /// + /// Returns information about the status of a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(CancellationToken cancellationToken = default) @@ -535,7 +629,9 @@ public virtual Task StatusAsync(CancellationToken cancel } /// - /// Returns information about the status of a snapshot. + /// + /// Returns information about the status of a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -547,7 +643,9 @@ public virtual Task StatusAsync(Action - /// Verifies a repository. + /// + /// Verifies a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task VerifyRepositoryAsync(VerifyRepositoryRequest request, CancellationToken cancellationToken = default) @@ -557,7 +655,9 @@ public virtual Task VerifyRepositoryAsync(VerifyReposi } /// - /// Verifies a repository. + /// + /// Verifies a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task VerifyRepositoryAsync(VerifyRepositoryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -567,7 +667,9 @@ public virtual Task VerifyRepositoryAsync(VerifyReposi } /// - /// Verifies a repository. + /// + /// Verifies a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task VerifyRepositoryAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, CancellationToken cancellationToken = default) @@ -578,7 +680,9 @@ public virtual Task VerifyRepositoryAsync(Elastic.Clie } /// - /// Verifies a repository. + /// + /// Verifies a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task VerifyRepositoryAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Sql.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Sql.g.cs index eae5fc67f5f..4fc0ea883d9 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Sql.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Sql.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Sql; public partial class SqlNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected SqlNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal SqlNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// Clears the SQL cursor + /// + /// Clears the SQL cursor + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCursorAsync(ClearCursorRequest request, CancellationToken cancellationToken = default) @@ -48,7 +52,9 @@ public virtual Task ClearCursorAsync(ClearCursorRequest req } /// - /// Clears the SQL cursor + /// + /// Clears the SQL cursor + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCursorAsync(ClearCursorRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -58,7 +64,9 @@ public virtual Task ClearCursorAsync(ClearCursorRequestDesc } /// - /// Clears the SQL cursor + /// + /// Clears the SQL cursor + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCursorAsync(CancellationToken cancellationToken = default) @@ -69,7 +77,9 @@ public virtual Task ClearCursorAsync(CancellationToken canc } /// - /// Clears the SQL cursor + /// + /// Clears the SQL cursor + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCursorAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -81,7 +91,9 @@ public virtual Task ClearCursorAsync(Action - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// + /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsyncAsync(DeleteAsyncRequest request, CancellationToken cancellationToken = default) @@ -91,7 +103,9 @@ public virtual Task DeleteAsyncAsync(DeleteAsyncRequest req } /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// + /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsyncAsync(DeleteAsyncRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -101,7 +115,9 @@ public virtual Task DeleteAsyncAsync(DeleteAsync } /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// + /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsyncAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -112,7 +128,9 @@ public virtual Task DeleteAsyncAsync(Elastic.Cli } /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// + /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsyncAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -124,7 +142,9 @@ public virtual Task DeleteAsyncAsync(Elastic.Cli } /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// + /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsyncAsync(DeleteAsyncRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -134,7 +154,9 @@ public virtual Task DeleteAsyncAsync(DeleteAsyncRequestDesc } /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// + /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsyncAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -145,7 +167,9 @@ public virtual Task DeleteAsyncAsync(Elastic.Clients.Elasti } /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// + /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsyncAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -157,7 +181,9 @@ public virtual Task DeleteAsyncAsync(Elastic.Clients.Elasti } /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// + /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsyncAsync(GetAsyncRequest request, CancellationToken cancellationToken = default) @@ -167,7 +193,9 @@ public virtual Task GetAsyncAsync(GetAsyncRequest request, Can } /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// + /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsyncAsync(GetAsyncRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -177,7 +205,9 @@ public virtual Task GetAsyncAsync(GetAsyncRequestDe } /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// + /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsyncAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -188,7 +218,9 @@ public virtual Task GetAsyncAsync(Elastic.Clients.E } /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// + /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsyncAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -200,7 +232,9 @@ public virtual Task GetAsyncAsync(Elastic.Clients.E } /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// + /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsyncAsync(GetAsyncRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -210,7 +244,9 @@ public virtual Task GetAsyncAsync(GetAsyncRequestDescriptor de } /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// + /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsyncAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -221,7 +257,9 @@ public virtual Task GetAsyncAsync(Elastic.Clients.Elasticsearc } /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// + /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsyncAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -233,7 +271,9 @@ public virtual Task GetAsyncAsync(Elastic.Clients.Elasticsearc } /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// + /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsyncStatusAsync(GetAsyncStatusRequest request, CancellationToken cancellationToken = default) @@ -243,7 +283,9 @@ public virtual Task GetAsyncStatusAsync(GetAsyncStatusRe } /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// + /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsyncStatusAsync(GetAsyncStatusRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -253,7 +295,9 @@ public virtual Task GetAsyncStatusAsync(GetAs } /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// + /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsyncStatusAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -264,7 +308,9 @@ public virtual Task GetAsyncStatusAsync(Elast } /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// + /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsyncStatusAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -276,7 +322,9 @@ public virtual Task GetAsyncStatusAsync(Elast } /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// + /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsyncStatusAsync(GetAsyncStatusRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -286,7 +334,9 @@ public virtual Task GetAsyncStatusAsync(GetAsyncStatusRe } /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// + /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsyncStatusAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -297,7 +347,9 @@ public virtual Task GetAsyncStatusAsync(Elastic.Clients. } /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// + /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsyncStatusAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -309,7 +361,9 @@ public virtual Task GetAsyncStatusAsync(Elastic.Clients. } /// - /// Executes a SQL request + /// + /// Executes a SQL request + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(QueryRequest request, CancellationToken cancellationToken = default) @@ -319,7 +373,9 @@ public virtual Task QueryAsync(QueryRequest request, Cancellation } /// - /// Executes a SQL request + /// + /// Executes a SQL request + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(QueryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -329,7 +385,9 @@ public virtual Task QueryAsync(QueryRequestDescriptor< } /// - /// Executes a SQL request + /// + /// Executes a SQL request + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(CancellationToken cancellationToken = default) @@ -340,7 +398,9 @@ public virtual Task QueryAsync(CancellationToken cance } /// - /// Executes a SQL request + /// + /// Executes a SQL request + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -352,7 +412,9 @@ public virtual Task QueryAsync(Action - /// Executes a SQL request + /// + /// Executes a SQL request + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(QueryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -362,7 +424,9 @@ public virtual Task QueryAsync(QueryRequestDescriptor descriptor, } /// - /// Executes a SQL request + /// + /// Executes a SQL request + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(CancellationToken cancellationToken = default) @@ -373,7 +437,9 @@ public virtual Task QueryAsync(CancellationToken cancellationToke } /// - /// Executes a SQL request + /// + /// Executes a SQL request + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -385,7 +451,9 @@ public virtual Task QueryAsync(Action con } /// - /// Translates SQL into Elasticsearch queries + /// + /// Translates SQL into Elasticsearch queries + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TranslateAsync(TranslateRequest request, CancellationToken cancellationToken = default) @@ -395,7 +463,9 @@ public virtual Task TranslateAsync(TranslateRequest request, } /// - /// Translates SQL into Elasticsearch queries + /// + /// Translates SQL into Elasticsearch queries + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TranslateAsync(TranslateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -405,7 +475,9 @@ public virtual Task TranslateAsync(TranslateReques } /// - /// Translates SQL into Elasticsearch queries + /// + /// Translates SQL into Elasticsearch queries + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TranslateAsync(CancellationToken cancellationToken = default) @@ -416,7 +488,9 @@ public virtual Task TranslateAsync(CancellationTok } /// - /// Translates SQL into Elasticsearch queries + /// + /// Translates SQL into Elasticsearch queries + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TranslateAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -428,7 +502,9 @@ public virtual Task TranslateAsync(Action - /// Translates SQL into Elasticsearch queries + /// + /// Translates SQL into Elasticsearch queries + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TranslateAsync(TranslateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -438,7 +514,9 @@ public virtual Task TranslateAsync(TranslateRequestDescriptor } /// - /// Translates SQL into Elasticsearch queries + /// + /// Translates SQL into Elasticsearch queries + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TranslateAsync(CancellationToken cancellationToken = default) @@ -449,7 +527,9 @@ public virtual Task TranslateAsync(CancellationToken cancella } /// - /// Translates SQL into Elasticsearch queries + /// + /// Translates SQL into Elasticsearch queries + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TranslateAsync(Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Synonyms.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Synonyms.g.cs index 86efea874c2..2682447ffa6 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Synonyms.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Synonyms.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Synonyms; public partial class SynonymsNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected SynonymsNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal SynonymsNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// Deletes a synonym set + /// + /// Deletes a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteSynonymAsync(DeleteSynonymRequest request, CancellationToken cancellationToken = default) @@ -48,7 +52,9 @@ public virtual Task DeleteSynonymAsync(DeleteSynonymReque } /// - /// Deletes a synonym set + /// + /// Deletes a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteSynonymAsync(DeleteSynonymRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -58,7 +64,9 @@ public virtual Task DeleteSynonymAsync(DeleteS } /// - /// Deletes a synonym set + /// + /// Deletes a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteSynonymAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -69,7 +77,9 @@ public virtual Task DeleteSynonymAsync(Elastic } /// - /// Deletes a synonym set + /// + /// Deletes a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteSynonymAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -81,7 +91,9 @@ public virtual Task DeleteSynonymAsync(Elastic } /// - /// Deletes a synonym set + /// + /// Deletes a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteSynonymAsync(DeleteSynonymRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -91,7 +103,9 @@ public virtual Task DeleteSynonymAsync(DeleteSynonymReque } /// - /// Deletes a synonym set + /// + /// Deletes a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteSynonymAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -102,7 +116,9 @@ public virtual Task DeleteSynonymAsync(Elastic.Clients.El } /// - /// Deletes a synonym set + /// + /// Deletes a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteSynonymAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -114,7 +130,9 @@ public virtual Task DeleteSynonymAsync(Elastic.Clients.El } /// - /// Deletes a synonym rule in a synonym set + /// + /// Deletes a synonym rule in a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteSynonymRuleAsync(DeleteSynonymRuleRequest request, CancellationToken cancellationToken = default) @@ -124,7 +142,9 @@ public virtual Task DeleteSynonymRuleAsync(DeleteSyno } /// - /// Deletes a synonym rule in a synonym set + /// + /// Deletes a synonym rule in a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteSynonymRuleAsync(DeleteSynonymRuleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -134,7 +154,9 @@ public virtual Task DeleteSynonymRuleAsync(DeleteSyno } /// - /// Deletes a synonym rule in a synonym set + /// + /// Deletes a synonym rule in a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteSynonymRuleAsync(Elastic.Clients.Elasticsearch.Serverless.Id setId, Elastic.Clients.Elasticsearch.Serverless.Id ruleId, CancellationToken cancellationToken = default) @@ -145,7 +167,9 @@ public virtual Task DeleteSynonymRuleAsync(Elastic.Cl } /// - /// Deletes a synonym rule in a synonym set + /// + /// Deletes a synonym rule in a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteSynonymRuleAsync(Elastic.Clients.Elasticsearch.Serverless.Id setId, Elastic.Clients.Elasticsearch.Serverless.Id ruleId, Action configureRequest, CancellationToken cancellationToken = default) @@ -157,7 +181,9 @@ public virtual Task DeleteSynonymRuleAsync(Elastic.Cl } /// - /// Retrieves a synonym set + /// + /// Retrieves a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSynonymAsync(GetSynonymRequest request, CancellationToken cancellationToken = default) @@ -167,7 +193,9 @@ public virtual Task GetSynonymAsync(GetSynonymRequest reques } /// - /// Retrieves a synonym set + /// + /// Retrieves a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSynonymAsync(GetSynonymRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -177,7 +205,9 @@ public virtual Task GetSynonymAsync(GetSynonymReq } /// - /// Retrieves a synonym set + /// + /// Retrieves a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSynonymAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -188,7 +218,9 @@ public virtual Task GetSynonymAsync(Elastic.Clien } /// - /// Retrieves a synonym set + /// + /// Retrieves a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSynonymAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -200,7 +232,9 @@ public virtual Task GetSynonymAsync(Elastic.Clien } /// - /// Retrieves a synonym set + /// + /// Retrieves a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSynonymAsync(GetSynonymRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -210,7 +244,9 @@ public virtual Task GetSynonymAsync(GetSynonymRequestDescrip } /// - /// Retrieves a synonym set + /// + /// Retrieves a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSynonymAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -221,7 +257,9 @@ public virtual Task GetSynonymAsync(Elastic.Clients.Elastics } /// - /// Retrieves a synonym set + /// + /// Retrieves a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSynonymAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -233,7 +271,9 @@ public virtual Task GetSynonymAsync(Elastic.Clients.Elastics } /// - /// Retrieves a synonym rule from a synonym set + /// + /// Retrieves a synonym rule from a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSynonymRuleAsync(GetSynonymRuleRequest request, CancellationToken cancellationToken = default) @@ -243,7 +283,9 @@ public virtual Task GetSynonymRuleAsync(GetSynonymRuleRe } /// - /// Retrieves a synonym rule from a synonym set + /// + /// Retrieves a synonym rule from a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSynonymRuleAsync(GetSynonymRuleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -253,7 +295,9 @@ public virtual Task GetSynonymRuleAsync(GetSynonymRuleRe } /// - /// Retrieves a synonym rule from a synonym set + /// + /// Retrieves a synonym rule from a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSynonymRuleAsync(Elastic.Clients.Elasticsearch.Serverless.Id setId, Elastic.Clients.Elasticsearch.Serverless.Id ruleId, CancellationToken cancellationToken = default) @@ -264,7 +308,9 @@ public virtual Task GetSynonymRuleAsync(Elastic.Clients. } /// - /// Retrieves a synonym rule from a synonym set + /// + /// Retrieves a synonym rule from a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSynonymRuleAsync(Elastic.Clients.Elasticsearch.Serverless.Id setId, Elastic.Clients.Elasticsearch.Serverless.Id ruleId, Action configureRequest, CancellationToken cancellationToken = default) @@ -276,7 +322,9 @@ public virtual Task GetSynonymRuleAsync(Elastic.Clients. } /// - /// Retrieves a summary of all defined synonym sets + /// + /// Retrieves a summary of all defined synonym sets + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSynonymsSetsAsync(GetSynonymsSetsRequest request, CancellationToken cancellationToken = default) @@ -286,7 +334,9 @@ public virtual Task GetSynonymsSetsAsync(GetSynonymsSet } /// - /// Retrieves a summary of all defined synonym sets + /// + /// Retrieves a summary of all defined synonym sets + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSynonymsSetsAsync(GetSynonymsSetsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -296,7 +346,9 @@ public virtual Task GetSynonymsSetsAsync(GetSynonymsSet } /// - /// Retrieves a summary of all defined synonym sets + /// + /// Retrieves a summary of all defined synonym sets + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSynonymsSetsAsync(CancellationToken cancellationToken = default) @@ -307,7 +359,9 @@ public virtual Task GetSynonymsSetsAsync(CancellationTo } /// - /// Retrieves a summary of all defined synonym sets + /// + /// Retrieves a summary of all defined synonym sets + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSynonymsSetsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -319,7 +373,9 @@ public virtual Task GetSynonymsSetsAsync(Action - /// Creates or updates a synonym set. + /// + /// Creates or updates a synonym set. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSynonymAsync(PutSynonymRequest request, CancellationToken cancellationToken = default) @@ -329,7 +385,9 @@ public virtual Task PutSynonymAsync(PutSynonymRequest reques } /// - /// Creates or updates a synonym set. + /// + /// Creates or updates a synonym set. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSynonymAsync(PutSynonymRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -339,7 +397,9 @@ public virtual Task PutSynonymAsync(PutSynonymReq } /// - /// Creates or updates a synonym set. + /// + /// Creates or updates a synonym set. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSynonymAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -350,7 +410,9 @@ public virtual Task PutSynonymAsync(Elastic.Clien } /// - /// Creates or updates a synonym set. + /// + /// Creates or updates a synonym set. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSynonymAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -362,7 +424,9 @@ public virtual Task PutSynonymAsync(Elastic.Clien } /// - /// Creates or updates a synonym set. + /// + /// Creates or updates a synonym set. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSynonymAsync(PutSynonymRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -372,7 +436,9 @@ public virtual Task PutSynonymAsync(PutSynonymRequestDescrip } /// - /// Creates or updates a synonym set. + /// + /// Creates or updates a synonym set. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSynonymAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -383,7 +449,9 @@ public virtual Task PutSynonymAsync(Elastic.Clients.Elastics } /// - /// Creates or updates a synonym set. + /// + /// Creates or updates a synonym set. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSynonymAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -395,7 +463,9 @@ public virtual Task PutSynonymAsync(Elastic.Clients.Elastics } /// - /// Creates or updates a synonym rule in a synonym set + /// + /// Creates or updates a synonym rule in a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSynonymRuleAsync(PutSynonymRuleRequest request, CancellationToken cancellationToken = default) @@ -405,7 +475,9 @@ public virtual Task PutSynonymRuleAsync(PutSynonymRuleRe } /// - /// Creates or updates a synonym rule in a synonym set + /// + /// Creates or updates a synonym rule in a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSynonymRuleAsync(PutSynonymRuleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -415,7 +487,9 @@ public virtual Task PutSynonymRuleAsync(PutSynonymRuleRe } /// - /// Creates or updates a synonym rule in a synonym set + /// + /// Creates or updates a synonym rule in a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSynonymRuleAsync(Elastic.Clients.Elasticsearch.Serverless.Id setId, Elastic.Clients.Elasticsearch.Serverless.Id ruleId, CancellationToken cancellationToken = default) @@ -426,7 +500,9 @@ public virtual Task PutSynonymRuleAsync(Elastic.Clients. } /// - /// Creates or updates a synonym rule in a synonym set + /// + /// Creates or updates a synonym rule in a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSynonymRuleAsync(Elastic.Clients.Elasticsearch.Serverless.Id setId, Elastic.Clients.Elasticsearch.Serverless.Id ruleId, Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.TextStructure.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.TextStructure.g.cs index d801794ccc2..6244a645f91 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.TextStructure.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.TextStructure.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.TextStructure; public partial class TextStructureNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected TextStructureNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal TextStructureNamespacedClient(ElasticsearchClient client) : base(client } /// - /// Tests a Grok pattern on some text. + /// + /// Tests a Grok pattern on some text. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TestGrokPatternAsync(TestGrokPatternRequest request, CancellationToken cancellationToken = default) @@ -48,7 +52,9 @@ public virtual Task TestGrokPatternAsync(TestGrokPatter } /// - /// Tests a Grok pattern on some text. + /// + /// Tests a Grok pattern on some text. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TestGrokPatternAsync(TestGrokPatternRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -58,7 +64,9 @@ public virtual Task TestGrokPatternAsync(TestGrokPatter } /// - /// Tests a Grok pattern on some text. + /// + /// Tests a Grok pattern on some text. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TestGrokPatternAsync(CancellationToken cancellationToken = default) @@ -69,7 +77,9 @@ public virtual Task TestGrokPatternAsync(CancellationTo } /// - /// Tests a Grok pattern on some text. + /// + /// Tests a Grok pattern on some text. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TestGrokPatternAsync(Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Transform.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Transform.g.cs index 12cabff5949..162ad128d0a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Transform.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Transform.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.TransformManagement; public partial class TransformManagementNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected TransformManagementNamespacedClient() : base() { @@ -38,7 +40,10 @@ internal TransformManagementNamespacedClient(ElasticsearchClient client) : base( } /// - /// Delete a transform.
Deletes a transform. + /// + /// Delete a transform. + /// Deletes a transform. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteTransformAsync(DeleteTransformRequest request, CancellationToken cancellationToken = default) @@ -48,7 +53,10 @@ public virtual Task DeleteTransformAsync(DeleteTransfor } /// - /// Delete a transform.
Deletes a transform. + /// + /// Delete a transform. + /// Deletes a transform. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteTransformAsync(DeleteTransformRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -58,7 +66,10 @@ public virtual Task DeleteTransformAsync(DeleteTransfor } /// - /// Delete a transform.
Deletes a transform. + /// + /// Delete a transform. + /// Deletes a transform. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteTransformAsync(Elastic.Clients.Elasticsearch.Serverless.Id transformId, CancellationToken cancellationToken = default) @@ -69,7 +80,10 @@ public virtual Task DeleteTransformAsync(Elastic.Client } /// - /// Delete a transform.
Deletes a transform. + /// + /// Delete a transform. + /// Deletes a transform. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteTransformAsync(Elastic.Clients.Elasticsearch.Serverless.Id transformId, Action configureRequest, CancellationToken cancellationToken = default) @@ -81,7 +95,10 @@ public virtual Task DeleteTransformAsync(Elastic.Client } /// - /// Get transforms.
Retrieves configuration information for transforms. + /// + /// Get transforms. + /// Retrieves configuration information for transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTransformAsync(GetTransformRequest request, CancellationToken cancellationToken = default) @@ -91,7 +108,10 @@ public virtual Task GetTransformAsync(GetTransformRequest } /// - /// Get transforms.
Retrieves configuration information for transforms. + /// + /// Get transforms. + /// Retrieves configuration information for transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTransformAsync(GetTransformRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -101,7 +121,10 @@ public virtual Task GetTransformAsync(GetTransformRequestD } /// - /// Get transforms.
Retrieves configuration information for transforms. + /// + /// Get transforms. + /// Retrieves configuration information for transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTransformAsync(Elastic.Clients.Elasticsearch.Serverless.Names? transformId, CancellationToken cancellationToken = default) @@ -112,7 +135,10 @@ public virtual Task GetTransformAsync(Elastic.Clients.Elas } /// - /// Get transforms.
Retrieves configuration information for transforms. + /// + /// Get transforms. + /// Retrieves configuration information for transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTransformAsync(Elastic.Clients.Elasticsearch.Serverless.Names? transformId, Action configureRequest, CancellationToken cancellationToken = default) @@ -124,7 +150,10 @@ public virtual Task GetTransformAsync(Elastic.Clients.Elas } /// - /// Get transforms.
Retrieves configuration information for transforms. + /// + /// Get transforms. + /// Retrieves configuration information for transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTransformAsync(CancellationToken cancellationToken = default) @@ -135,7 +164,10 @@ public virtual Task GetTransformAsync(CancellationToken ca } /// - /// Get transforms.
Retrieves configuration information for transforms. + /// + /// Get transforms. + /// Retrieves configuration information for transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTransformAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -147,7 +179,10 @@ public virtual Task GetTransformAsync(Action - /// Get transform stats.
Retrieves usage information for transforms. + /// + /// Get transform stats. + /// Retrieves usage information for transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTransformStatsAsync(GetTransformStatsRequest request, CancellationToken cancellationToken = default) @@ -157,7 +192,10 @@ public virtual Task GetTransformStatsAsync(GetTransfo } /// - /// Get transform stats.
Retrieves usage information for transforms. + /// + /// Get transform stats. + /// Retrieves usage information for transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTransformStatsAsync(GetTransformStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -167,7 +205,10 @@ public virtual Task GetTransformStatsAsync(GetTransfo } /// - /// Get transform stats.
Retrieves usage information for transforms. + /// + /// Get transform stats. + /// Retrieves usage information for transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTransformStatsAsync(Elastic.Clients.Elasticsearch.Serverless.Names transformId, CancellationToken cancellationToken = default) @@ -178,7 +219,10 @@ public virtual Task GetTransformStatsAsync(Elastic.Cl } /// - /// Get transform stats.
Retrieves usage information for transforms. + /// + /// Get transform stats. + /// Retrieves usage information for transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTransformStatsAsync(Elastic.Clients.Elasticsearch.Serverless.Names transformId, Action configureRequest, CancellationToken cancellationToken = default) @@ -190,8 +234,15 @@ public virtual Task GetTransformStatsAsync(Elastic.Cl } /// - /// Preview a transform.
Generates a preview of the results that you will get when you create a transform with the same configuration. - /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also
generates a list of mappings and settings for the destination index. These values are determined based on the field
types of the source index and the transform aggregations. + /// + /// Preview a transform. + /// Generates a preview of the results that you will get when you create a transform with the same configuration. + /// + /// + /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also + /// generates a list of mappings and settings for the destination index. These values are determined based on the field + /// types of the source index and the transform aggregations. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> PreviewTransformAsync(PreviewTransformRequest request, CancellationToken cancellationToken = default) @@ -201,8 +252,15 @@ public virtual Task> PreviewTransformAsync< } /// - /// Preview a transform.
Generates a preview of the results that you will get when you create a transform with the same configuration. - /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also
generates a list of mappings and settings for the destination index. These values are determined based on the field
types of the source index and the transform aggregations. + /// + /// Preview a transform. + /// Generates a preview of the results that you will get when you create a transform with the same configuration. + /// + /// + /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also + /// generates a list of mappings and settings for the destination index. These values are determined based on the field + /// types of the source index and the transform aggregations. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> PreviewTransformAsync(PreviewTransformRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -212,8 +270,15 @@ public virtual Task> PreviewTransformAsync< } /// - /// Preview a transform.
Generates a preview of the results that you will get when you create a transform with the same configuration. - /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also
generates a list of mappings and settings for the destination index. These values are determined based on the field
types of the source index and the transform aggregations. + /// + /// Preview a transform. + /// Generates a preview of the results that you will get when you create a transform with the same configuration. + /// + /// + /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also + /// generates a list of mappings and settings for the destination index. These values are determined based on the field + /// types of the source index and the transform aggregations. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> PreviewTransformAsync(Elastic.Clients.Elasticsearch.Serverless.Id? transformId, CancellationToken cancellationToken = default) @@ -224,8 +289,15 @@ public virtual Task> PreviewTransformAsync< } /// - /// Preview a transform.
Generates a preview of the results that you will get when you create a transform with the same configuration. - /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also
generates a list of mappings and settings for the destination index. These values are determined based on the field
types of the source index and the transform aggregations. + /// + /// Preview a transform. + /// Generates a preview of the results that you will get when you create a transform with the same configuration. + /// + /// + /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also + /// generates a list of mappings and settings for the destination index. These values are determined based on the field + /// types of the source index and the transform aggregations. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> PreviewTransformAsync(Elastic.Clients.Elasticsearch.Serverless.Id? transformId, Action> configureRequest, CancellationToken cancellationToken = default) @@ -237,8 +309,15 @@ public virtual Task> PreviewTransformAsync< } /// - /// Preview a transform.
Generates a preview of the results that you will get when you create a transform with the same configuration. - /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also
generates a list of mappings and settings for the destination index. These values are determined based on the field
types of the source index and the transform aggregations. + /// + /// Preview a transform. + /// Generates a preview of the results that you will get when you create a transform with the same configuration. + /// + /// + /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also + /// generates a list of mappings and settings for the destination index. These values are determined based on the field + /// types of the source index and the transform aggregations. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> PreviewTransformAsync(CancellationToken cancellationToken = default) @@ -249,8 +328,15 @@ public virtual Task> PreviewTransformAsync< } /// - /// Preview a transform.
Generates a preview of the results that you will get when you create a transform with the same configuration. - /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also
generates a list of mappings and settings for the destination index. These values are determined based on the field
types of the source index and the transform aggregations. + /// + /// Preview a transform. + /// Generates a preview of the results that you will get when you create a transform with the same configuration. + /// + /// + /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also + /// generates a list of mappings and settings for the destination index. These values are determined based on the field + /// types of the source index and the transform aggregations. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> PreviewTransformAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -262,11 +348,34 @@ public virtual Task> PreviewTransformAsync< } /// - /// Create a transform.
Creates a transform. - /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as
a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
unique row per entity. - /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If
you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in
the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values
in the latest object. - /// You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and
`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the
transform remembers which roles the user that created it had at the time of creation and uses those same roles. If
those roles do not have the required privileges on the source and destination indices, the transform fails when it
attempts unauthorized operations. - /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any
`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not
give users any privileges on `.data-frame-internal*` indices. + /// + /// Create a transform. + /// Creates a transform. + /// + /// + /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as + /// a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a + /// unique row per entity. + /// + /// + /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If + /// you choose to use the pivot method for your transform, the entities are defined by the set of group_by fields in + /// the pivot object. If you choose to use the latest method, the entities are defined by the unique_key field values + /// in the latest object. + /// + /// + /// You must have create_index, index, and read privileges on the destination index and read and + /// view_index_metadata privileges on the source indices. When Elasticsearch security features are enabled, the + /// transform remembers which roles the user that created it had at the time of creation and uses those same roles. If + /// those roles do not have the required privileges on the source and destination indices, the transform fails when it + /// attempts unauthorized operations. + /// + /// + /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any + /// .transform-internal* indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do + /// not give users any privileges on .transform-internal* indices. If you used transforms prior to 7.5, also do not + /// give users any privileges on .data-frame-internal* indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTransformAsync(PutTransformRequest request, CancellationToken cancellationToken = default) @@ -276,11 +385,34 @@ public virtual Task PutTransformAsync(PutTransformRequest } /// - /// Create a transform.
Creates a transform. - /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as
a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
unique row per entity. - /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If
you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in
the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values
in the latest object. - /// You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and
`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the
transform remembers which roles the user that created it had at the time of creation and uses those same roles. If
those roles do not have the required privileges on the source and destination indices, the transform fails when it
attempts unauthorized operations. - /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any
`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not
give users any privileges on `.data-frame-internal*` indices. + /// + /// Create a transform. + /// Creates a transform. + /// + /// + /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as + /// a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a + /// unique row per entity. + /// + /// + /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If + /// you choose to use the pivot method for your transform, the entities are defined by the set of group_by fields in + /// the pivot object. If you choose to use the latest method, the entities are defined by the unique_key field values + /// in the latest object. + /// + /// + /// You must have create_index, index, and read privileges on the destination index and read and + /// view_index_metadata privileges on the source indices. When Elasticsearch security features are enabled, the + /// transform remembers which roles the user that created it had at the time of creation and uses those same roles. If + /// those roles do not have the required privileges on the source and destination indices, the transform fails when it + /// attempts unauthorized operations. + /// + /// + /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any + /// .transform-internal* indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do + /// not give users any privileges on .transform-internal* indices. If you used transforms prior to 7.5, also do not + /// give users any privileges on .data-frame-internal* indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTransformAsync(PutTransformRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -290,11 +422,34 @@ public virtual Task PutTransformAsync(PutTransf } /// - /// Create a transform.
Creates a transform. - /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as
a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
unique row per entity. - /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If
you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in
the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values
in the latest object. - /// You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and
`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the
transform remembers which roles the user that created it had at the time of creation and uses those same roles. If
those roles do not have the required privileges on the source and destination indices, the transform fails when it
attempts unauthorized operations. - /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any
`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not
give users any privileges on `.data-frame-internal*` indices. + /// + /// Create a transform. + /// Creates a transform. + /// + /// + /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as + /// a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a + /// unique row per entity. + /// + /// + /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If + /// you choose to use the pivot method for your transform, the entities are defined by the set of group_by fields in + /// the pivot object. If you choose to use the latest method, the entities are defined by the unique_key field values + /// in the latest object. + /// + /// + /// You must have create_index, index, and read privileges on the destination index and read and + /// view_index_metadata privileges on the source indices. When Elasticsearch security features are enabled, the + /// transform remembers which roles the user that created it had at the time of creation and uses those same roles. If + /// those roles do not have the required privileges on the source and destination indices, the transform fails when it + /// attempts unauthorized operations. + /// + /// + /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any + /// .transform-internal* indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do + /// not give users any privileges on .transform-internal* indices. If you used transforms prior to 7.5, also do not + /// give users any privileges on .data-frame-internal* indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTransformAsync(Elastic.Clients.Elasticsearch.Serverless.Id transformId, CancellationToken cancellationToken = default) @@ -305,11 +460,34 @@ public virtual Task PutTransformAsync(Elastic.C } /// - /// Create a transform.
Creates a transform. - /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as
a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
unique row per entity. - /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If
you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in
the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values
in the latest object. - /// You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and
`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the
transform remembers which roles the user that created it had at the time of creation and uses those same roles. If
those roles do not have the required privileges on the source and destination indices, the transform fails when it
attempts unauthorized operations. - /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any
`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not
give users any privileges on `.data-frame-internal*` indices. + /// + /// Create a transform. + /// Creates a transform. + /// + /// + /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as + /// a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a + /// unique row per entity. + /// + /// + /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If + /// you choose to use the pivot method for your transform, the entities are defined by the set of group_by fields in + /// the pivot object. If you choose to use the latest method, the entities are defined by the unique_key field values + /// in the latest object. + /// + /// + /// You must have create_index, index, and read privileges on the destination index and read and + /// view_index_metadata privileges on the source indices. When Elasticsearch security features are enabled, the + /// transform remembers which roles the user that created it had at the time of creation and uses those same roles. If + /// those roles do not have the required privileges on the source and destination indices, the transform fails when it + /// attempts unauthorized operations. + /// + /// + /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any + /// .transform-internal* indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do + /// not give users any privileges on .transform-internal* indices. If you used transforms prior to 7.5, also do not + /// give users any privileges on .data-frame-internal* indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTransformAsync(Elastic.Clients.Elasticsearch.Serverless.Id transformId, Action> configureRequest, CancellationToken cancellationToken = default) @@ -321,11 +499,34 @@ public virtual Task PutTransformAsync(Elastic.C } /// - /// Create a transform.
Creates a transform. - /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as
a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
unique row per entity. - /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If
you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in
the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values
in the latest object. - /// You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and
`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the
transform remembers which roles the user that created it had at the time of creation and uses those same roles. If
those roles do not have the required privileges on the source and destination indices, the transform fails when it
attempts unauthorized operations. - /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any
`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not
give users any privileges on `.data-frame-internal*` indices. + /// + /// Create a transform. + /// Creates a transform. + /// + /// + /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as + /// a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a + /// unique row per entity. + /// + /// + /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If + /// you choose to use the pivot method for your transform, the entities are defined by the set of group_by fields in + /// the pivot object. If you choose to use the latest method, the entities are defined by the unique_key field values + /// in the latest object. + /// + /// + /// You must have create_index, index, and read privileges on the destination index and read and + /// view_index_metadata privileges on the source indices. When Elasticsearch security features are enabled, the + /// transform remembers which roles the user that created it had at the time of creation and uses those same roles. If + /// those roles do not have the required privileges on the source and destination indices, the transform fails when it + /// attempts unauthorized operations. + /// + /// + /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any + /// .transform-internal* indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do + /// not give users any privileges on .transform-internal* indices. If you used transforms prior to 7.5, also do not + /// give users any privileges on .data-frame-internal* indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTransformAsync(PutTransformRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -335,11 +536,34 @@ public virtual Task PutTransformAsync(PutTransformRequestD } /// - /// Create a transform.
Creates a transform. - /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as
a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
unique row per entity. - /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If
you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in
the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values
in the latest object. - /// You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and
`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the
transform remembers which roles the user that created it had at the time of creation and uses those same roles. If
those roles do not have the required privileges on the source and destination indices, the transform fails when it
attempts unauthorized operations. - /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any
`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not
give users any privileges on `.data-frame-internal*` indices. + /// + /// Create a transform. + /// Creates a transform. + /// + /// + /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as + /// a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a + /// unique row per entity. + /// + /// + /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If + /// you choose to use the pivot method for your transform, the entities are defined by the set of group_by fields in + /// the pivot object. If you choose to use the latest method, the entities are defined by the unique_key field values + /// in the latest object. + /// + /// + /// You must have create_index, index, and read privileges on the destination index and read and + /// view_index_metadata privileges on the source indices. When Elasticsearch security features are enabled, the + /// transform remembers which roles the user that created it had at the time of creation and uses those same roles. If + /// those roles do not have the required privileges on the source and destination indices, the transform fails when it + /// attempts unauthorized operations. + /// + /// + /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any + /// .transform-internal* indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do + /// not give users any privileges on .transform-internal* indices. If you used transforms prior to 7.5, also do not + /// give users any privileges on .data-frame-internal* indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTransformAsync(Elastic.Clients.Elasticsearch.Serverless.Id transformId, CancellationToken cancellationToken = default) @@ -350,11 +574,34 @@ public virtual Task PutTransformAsync(Elastic.Clients.Elas } /// - /// Create a transform.
Creates a transform. - /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as
a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
unique row per entity. - /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If
you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in
the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values
in the latest object. - /// You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and
`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the
transform remembers which roles the user that created it had at the time of creation and uses those same roles. If
those roles do not have the required privileges on the source and destination indices, the transform fails when it
attempts unauthorized operations. - /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any
`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not
give users any privileges on `.data-frame-internal*` indices. + /// + /// Create a transform. + /// Creates a transform. + /// + /// + /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as + /// a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a + /// unique row per entity. + /// + /// + /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If + /// you choose to use the pivot method for your transform, the entities are defined by the set of group_by fields in + /// the pivot object. If you choose to use the latest method, the entities are defined by the unique_key field values + /// in the latest object. + /// + /// + /// You must have create_index, index, and read privileges on the destination index and read and + /// view_index_metadata privileges on the source indices. When Elasticsearch security features are enabled, the + /// transform remembers which roles the user that created it had at the time of creation and uses those same roles. If + /// those roles do not have the required privileges on the source and destination indices, the transform fails when it + /// attempts unauthorized operations. + /// + /// + /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any + /// .transform-internal* indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do + /// not give users any privileges on .transform-internal* indices. If you used transforms prior to 7.5, also do not + /// give users any privileges on .data-frame-internal* indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTransformAsync(Elastic.Clients.Elasticsearch.Serverless.Id transformId, Action configureRequest, CancellationToken cancellationToken = default) @@ -366,7 +613,12 @@ public virtual Task PutTransformAsync(Elastic.Clients.Elas } /// - /// Reset a transform.
Resets a transform.
Before you can reset it, you must stop it; alternatively, use the `force` query parameter.
If the destination index was created by the transform, it is deleted. + /// + /// Reset a transform. + /// Resets a transform. + /// Before you can reset it, you must stop it; alternatively, use the force query parameter. + /// If the destination index was created by the transform, it is deleted. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResetTransformAsync(ResetTransformRequest request, CancellationToken cancellationToken = default) @@ -376,7 +628,12 @@ public virtual Task ResetTransformAsync(ResetTransformRe } /// - /// Reset a transform.
Resets a transform.
Before you can reset it, you must stop it; alternatively, use the `force` query parameter.
If the destination index was created by the transform, it is deleted. + /// + /// Reset a transform. + /// Resets a transform. + /// Before you can reset it, you must stop it; alternatively, use the force query parameter. + /// If the destination index was created by the transform, it is deleted. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResetTransformAsync(ResetTransformRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -386,7 +643,12 @@ public virtual Task ResetTransformAsync(ResetTransformRe } /// - /// Reset a transform.
Resets a transform.
Before you can reset it, you must stop it; alternatively, use the `force` query parameter.
If the destination index was created by the transform, it is deleted. + /// + /// Reset a transform. + /// Resets a transform. + /// Before you can reset it, you must stop it; alternatively, use the force query parameter. + /// If the destination index was created by the transform, it is deleted. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResetTransformAsync(Elastic.Clients.Elasticsearch.Serverless.Id transformId, CancellationToken cancellationToken = default) @@ -397,7 +659,12 @@ public virtual Task ResetTransformAsync(Elastic.Clients. } /// - /// Reset a transform.
Resets a transform.
Before you can reset it, you must stop it; alternatively, use the `force` query parameter.
If the destination index was created by the transform, it is deleted. + /// + /// Reset a transform. + /// Resets a transform. + /// Before you can reset it, you must stop it; alternatively, use the force query parameter. + /// If the destination index was created by the transform, it is deleted. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResetTransformAsync(Elastic.Clients.Elasticsearch.Serverless.Id transformId, Action configureRequest, CancellationToken cancellationToken = default) @@ -409,8 +676,16 @@ public virtual Task ResetTransformAsync(Elastic.Clients. } /// - /// Schedule a transform to start now.
Instantly runs a transform to process data. - /// If you _schedule_now a transform, it will process the new data instantly,
without waiting for the configured frequency interval. After _schedule_now API is called,
the transform will be processed again at now + frequency unless _schedule_now API
is called again in the meantime. + /// + /// Schedule a transform to start now. + /// Instantly runs a transform to process data. + /// + /// + /// If you _schedule_now a transform, it will process the new data instantly, + /// without waiting for the configured frequency interval. After _schedule_now API is called, + /// the transform will be processed again at now + frequency unless _schedule_now API + /// is called again in the meantime. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ScheduleNowTransformAsync(ScheduleNowTransformRequest request, CancellationToken cancellationToken = default) @@ -420,8 +695,16 @@ public virtual Task ScheduleNowTransformAsync(Sche } /// - /// Schedule a transform to start now.
Instantly runs a transform to process data. - /// If you _schedule_now a transform, it will process the new data instantly,
without waiting for the configured frequency interval. After _schedule_now API is called,
the transform will be processed again at now + frequency unless _schedule_now API
is called again in the meantime. + /// + /// Schedule a transform to start now. + /// Instantly runs a transform to process data. + /// + /// + /// If you _schedule_now a transform, it will process the new data instantly, + /// without waiting for the configured frequency interval. After _schedule_now API is called, + /// the transform will be processed again at now + frequency unless _schedule_now API + /// is called again in the meantime. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ScheduleNowTransformAsync(ScheduleNowTransformRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -431,8 +714,16 @@ public virtual Task ScheduleNowTransformAsync(Sche } /// - /// Schedule a transform to start now.
Instantly runs a transform to process data. - /// If you _schedule_now a transform, it will process the new data instantly,
without waiting for the configured frequency interval. After _schedule_now API is called,
the transform will be processed again at now + frequency unless _schedule_now API
is called again in the meantime. + /// + /// Schedule a transform to start now. + /// Instantly runs a transform to process data. + /// + /// + /// If you _schedule_now a transform, it will process the new data instantly, + /// without waiting for the configured frequency interval. After _schedule_now API is called, + /// the transform will be processed again at now + frequency unless _schedule_now API + /// is called again in the meantime. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ScheduleNowTransformAsync(Elastic.Clients.Elasticsearch.Serverless.Id transformId, CancellationToken cancellationToken = default) @@ -443,8 +734,16 @@ public virtual Task ScheduleNowTransformAsync(Elas } /// - /// Schedule a transform to start now.
Instantly runs a transform to process data. - /// If you _schedule_now a transform, it will process the new data instantly,
without waiting for the configured frequency interval. After _schedule_now API is called,
the transform will be processed again at now + frequency unless _schedule_now API
is called again in the meantime. + /// + /// Schedule a transform to start now. + /// Instantly runs a transform to process data. + /// + /// + /// If you _schedule_now a transform, it will process the new data instantly, + /// without waiting for the configured frequency interval. After _schedule_now API is called, + /// the transform will be processed again at now + frequency unless _schedule_now API + /// is called again in the meantime. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ScheduleNowTransformAsync(Elastic.Clients.Elasticsearch.Serverless.Id transformId, Action configureRequest, CancellationToken cancellationToken = default) @@ -456,9 +755,27 @@ public virtual Task ScheduleNowTransformAsync(Elas } /// - /// Start a transform.
Starts a transform. - /// When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is
set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping
definitions for the destination index from the source indices and the transform aggregations. If fields in the
destination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),
the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce
mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you
start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings
in a pivot transform. - /// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you
created the transform, they occur when you start the transform—​with the exception of privilege checks. When
Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the
time of creation and uses those same roles. If those roles do not have the required privileges on the source and
destination indices, the transform fails when it attempts unauthorized operations. + /// + /// Start a transform. + /// Starts a transform. + /// + /// + /// When you start a transform, it creates the destination index if it does not already exist. The number_of_shards is + /// set to 1 and the auto_expand_replicas is set to 0-1. If it is a pivot transform, it deduces the mapping + /// definitions for the destination index from the source indices and the transform aggregations. If fields in the + /// destination index are derived from scripts (as in the case of scripted_metric or bucket_script aggregations), + /// the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce + /// mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you + /// start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings + /// in a pivot transform. + /// + /// + /// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you + /// created the transform, they occur when you start the transform—​with the exception of privilege checks. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the + /// time of creation and uses those same roles. If those roles do not have the required privileges on the source and + /// destination indices, the transform fails when it attempts unauthorized operations. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartTransformAsync(StartTransformRequest request, CancellationToken cancellationToken = default) @@ -468,9 +785,27 @@ public virtual Task StartTransformAsync(StartTransformRe } /// - /// Start a transform.
Starts a transform. - /// When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is
set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping
definitions for the destination index from the source indices and the transform aggregations. If fields in the
destination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),
the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce
mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you
start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings
in a pivot transform. - /// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you
created the transform, they occur when you start the transform—​with the exception of privilege checks. When
Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the
time of creation and uses those same roles. If those roles do not have the required privileges on the source and
destination indices, the transform fails when it attempts unauthorized operations. + /// + /// Start a transform. + /// Starts a transform. + /// + /// + /// When you start a transform, it creates the destination index if it does not already exist. The number_of_shards is + /// set to 1 and the auto_expand_replicas is set to 0-1. If it is a pivot transform, it deduces the mapping + /// definitions for the destination index from the source indices and the transform aggregations. If fields in the + /// destination index are derived from scripts (as in the case of scripted_metric or bucket_script aggregations), + /// the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce + /// mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you + /// start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings + /// in a pivot transform. + /// + /// + /// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you + /// created the transform, they occur when you start the transform—​with the exception of privilege checks. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the + /// time of creation and uses those same roles. If those roles do not have the required privileges on the source and + /// destination indices, the transform fails when it attempts unauthorized operations. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartTransformAsync(StartTransformRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -480,9 +815,27 @@ public virtual Task StartTransformAsync(StartTransformRe } /// - /// Start a transform.
Starts a transform. - /// When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is
set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping
definitions for the destination index from the source indices and the transform aggregations. If fields in the
destination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),
the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce
mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you
start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings
in a pivot transform. - /// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you
created the transform, they occur when you start the transform—​with the exception of privilege checks. When
Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the
time of creation and uses those same roles. If those roles do not have the required privileges on the source and
destination indices, the transform fails when it attempts unauthorized operations. + /// + /// Start a transform. + /// Starts a transform. + /// + /// + /// When you start a transform, it creates the destination index if it does not already exist. The number_of_shards is + /// set to 1 and the auto_expand_replicas is set to 0-1. If it is a pivot transform, it deduces the mapping + /// definitions for the destination index from the source indices and the transform aggregations. If fields in the + /// destination index are derived from scripts (as in the case of scripted_metric or bucket_script aggregations), + /// the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce + /// mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you + /// start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings + /// in a pivot transform. + /// + /// + /// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you + /// created the transform, they occur when you start the transform—​with the exception of privilege checks. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the + /// time of creation and uses those same roles. If those roles do not have the required privileges on the source and + /// destination indices, the transform fails when it attempts unauthorized operations. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartTransformAsync(Elastic.Clients.Elasticsearch.Serverless.Id transformId, CancellationToken cancellationToken = default) @@ -493,9 +846,27 @@ public virtual Task StartTransformAsync(Elastic.Clients. } /// - /// Start a transform.
Starts a transform. - /// When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is
set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping
definitions for the destination index from the source indices and the transform aggregations. If fields in the
destination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),
the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce
mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you
start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings
in a pivot transform. - /// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you
created the transform, they occur when you start the transform—​with the exception of privilege checks. When
Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the
time of creation and uses those same roles. If those roles do not have the required privileges on the source and
destination indices, the transform fails when it attempts unauthorized operations. + /// + /// Start a transform. + /// Starts a transform. + /// + /// + /// When you start a transform, it creates the destination index if it does not already exist. The number_of_shards is + /// set to 1 and the auto_expand_replicas is set to 0-1. If it is a pivot transform, it deduces the mapping + /// definitions for the destination index from the source indices and the transform aggregations. If fields in the + /// destination index are derived from scripts (as in the case of scripted_metric or bucket_script aggregations), + /// the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce + /// mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you + /// start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings + /// in a pivot transform. + /// + /// + /// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you + /// created the transform, they occur when you start the transform—​with the exception of privilege checks. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the + /// time of creation and uses those same roles. If those roles do not have the required privileges on the source and + /// destination indices, the transform fails when it attempts unauthorized operations. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartTransformAsync(Elastic.Clients.Elasticsearch.Serverless.Id transformId, Action configureRequest, CancellationToken cancellationToken = default) @@ -507,7 +878,10 @@ public virtual Task StartTransformAsync(Elastic.Clients. } /// - /// Stop transforms.
Stops one or more transforms. + /// + /// Stop transforms. + /// Stops one or more transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopTransformAsync(StopTransformRequest request, CancellationToken cancellationToken = default) @@ -517,7 +891,10 @@ public virtual Task StopTransformAsync(StopTransformReque } /// - /// Stop transforms.
Stops one or more transforms. + /// + /// Stop transforms. + /// Stops one or more transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopTransformAsync(StopTransformRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -527,7 +904,10 @@ public virtual Task StopTransformAsync(StopTransformReque } /// - /// Stop transforms.
Stops one or more transforms. + /// + /// Stop transforms. + /// Stops one or more transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopTransformAsync(Elastic.Clients.Elasticsearch.Serverless.Name transformId, CancellationToken cancellationToken = default) @@ -538,7 +918,10 @@ public virtual Task StopTransformAsync(Elastic.Clients.El } /// - /// Stop transforms.
Stops one or more transforms. + /// + /// Stop transforms. + /// Stops one or more transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopTransformAsync(Elastic.Clients.Elasticsearch.Serverless.Name transformId, Action configureRequest, CancellationToken cancellationToken = default) @@ -550,8 +933,17 @@ public virtual Task StopTransformAsync(Elastic.Clients.El } /// - /// Update a transform.
Updates certain properties of a transform. - /// All updated properties except `description` do not take effect until after the transform starts the next checkpoint,
thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`
privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When
Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the
time of update and runs with those privileges. + /// + /// Update a transform. + /// Updates certain properties of a transform. + /// + /// + /// All updated properties except description do not take effect until after the transform starts the next checkpoint, + /// thus there is data consistency in each checkpoint. To use this API, you must have read and view_index_metadata + /// privileges for the source indices. You must also have index and read privileges for the destination index. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the + /// time of update and runs with those privileges. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateTransformAsync(UpdateTransformRequest request, CancellationToken cancellationToken = default) @@ -561,8 +953,17 @@ public virtual Task UpdateTransformAsync(UpdateTransfor } /// - /// Update a transform.
Updates certain properties of a transform. - /// All updated properties except `description` do not take effect until after the transform starts the next checkpoint,
thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`
privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When
Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the
time of update and runs with those privileges. + /// + /// Update a transform. + /// Updates certain properties of a transform. + /// + /// + /// All updated properties except description do not take effect until after the transform starts the next checkpoint, + /// thus there is data consistency in each checkpoint. To use this API, you must have read and view_index_metadata + /// privileges for the source indices. You must also have index and read privileges for the destination index. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the + /// time of update and runs with those privileges. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateTransformAsync(UpdateTransformRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -572,8 +973,17 @@ public virtual Task UpdateTransformAsync(Upd } /// - /// Update a transform.
Updates certain properties of a transform. - /// All updated properties except `description` do not take effect until after the transform starts the next checkpoint,
thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`
privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When
Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the
time of update and runs with those privileges. + /// + /// Update a transform. + /// Updates certain properties of a transform. + /// + /// + /// All updated properties except description do not take effect until after the transform starts the next checkpoint, + /// thus there is data consistency in each checkpoint. To use this API, you must have read and view_index_metadata + /// privileges for the source indices. You must also have index and read privileges for the destination index. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the + /// time of update and runs with those privileges. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateTransformAsync(Elastic.Clients.Elasticsearch.Serverless.Id transformId, CancellationToken cancellationToken = default) @@ -584,8 +994,17 @@ public virtual Task UpdateTransformAsync(Ela } /// - /// Update a transform.
Updates certain properties of a transform. - /// All updated properties except `description` do not take effect until after the transform starts the next checkpoint,
thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`
privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When
Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the
time of update and runs with those privileges. + /// + /// Update a transform. + /// Updates certain properties of a transform. + /// + /// + /// All updated properties except description do not take effect until after the transform starts the next checkpoint, + /// thus there is data consistency in each checkpoint. To use this API, you must have read and view_index_metadata + /// privileges for the source indices. You must also have index and read privileges for the destination index. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the + /// time of update and runs with those privileges. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateTransformAsync(Elastic.Clients.Elasticsearch.Serverless.Id transformId, Action> configureRequest, CancellationToken cancellationToken = default) @@ -597,8 +1016,17 @@ public virtual Task UpdateTransformAsync(Ela } /// - /// Update a transform.
Updates certain properties of a transform. - /// All updated properties except `description` do not take effect until after the transform starts the next checkpoint,
thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`
privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When
Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the
time of update and runs with those privileges. + /// + /// Update a transform. + /// Updates certain properties of a transform. + /// + /// + /// All updated properties except description do not take effect until after the transform starts the next checkpoint, + /// thus there is data consistency in each checkpoint. To use this API, you must have read and view_index_metadata + /// privileges for the source indices. You must also have index and read privileges for the destination index. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the + /// time of update and runs with those privileges. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateTransformAsync(UpdateTransformRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -608,8 +1036,17 @@ public virtual Task UpdateTransformAsync(UpdateTransfor } /// - /// Update a transform.
Updates certain properties of a transform. - /// All updated properties except `description` do not take effect until after the transform starts the next checkpoint,
thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`
privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When
Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the
time of update and runs with those privileges. + /// + /// Update a transform. + /// Updates certain properties of a transform. + /// + /// + /// All updated properties except description do not take effect until after the transform starts the next checkpoint, + /// thus there is data consistency in each checkpoint. To use this API, you must have read and view_index_metadata + /// privileges for the source indices. You must also have index and read privileges for the destination index. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the + /// time of update and runs with those privileges. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateTransformAsync(Elastic.Clients.Elasticsearch.Serverless.Id transformId, CancellationToken cancellationToken = default) @@ -620,8 +1057,17 @@ public virtual Task UpdateTransformAsync(Elastic.Client } /// - /// Update a transform.
Updates certain properties of a transform. - /// All updated properties except `description` do not take effect until after the transform starts the next checkpoint,
thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`
privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When
Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the
time of update and runs with those privileges. + /// + /// Update a transform. + /// Updates certain properties of a transform. + /// + /// + /// All updated properties except description do not take effect until after the transform starts the next checkpoint, + /// thus there is data consistency in each checkpoint. To use this API, you must have read and view_index_metadata + /// privileges for the source indices. You must also have index and read privileges for the destination index. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the + /// time of update and runs with those privileges. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateTransformAsync(Elastic.Clients.Elasticsearch.Serverless.Id transformId, Action configureRequest, CancellationToken cancellationToken = default) @@ -633,7 +1079,14 @@ public virtual Task UpdateTransformAsync(Elastic.Client } /// - /// Upgrades all transforms.
This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It
also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not
affect the source and destination indices. The upgrade also does not affect the roles that transforms use when
Elasticsearch security features are enabled; the role used to read source data and write to the destination index
remains unchanged. + /// + /// Upgrades all transforms. + /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It + /// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not + /// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when + /// Elasticsearch security features are enabled; the role used to read source data and write to the destination index + /// remains unchanged. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpgradeTransformsAsync(UpgradeTransformsRequest request, CancellationToken cancellationToken = default) @@ -643,7 +1096,14 @@ public virtual Task UpgradeTransformsAsync(UpgradeTra } /// - /// Upgrades all transforms.
This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It
also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not
affect the source and destination indices. The upgrade also does not affect the roles that transforms use when
Elasticsearch security features are enabled; the role used to read source data and write to the destination index
remains unchanged. + /// + /// Upgrades all transforms. + /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It + /// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not + /// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when + /// Elasticsearch security features are enabled; the role used to read source data and write to the destination index + /// remains unchanged. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpgradeTransformsAsync(UpgradeTransformsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -653,7 +1113,14 @@ public virtual Task UpgradeTransformsAsync(UpgradeTra } /// - /// Upgrades all transforms.
This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It
also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not
affect the source and destination indices. The upgrade also does not affect the roles that transforms use when
Elasticsearch security features are enabled; the role used to read source data and write to the destination index
remains unchanged. + /// + /// Upgrades all transforms. + /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It + /// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not + /// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when + /// Elasticsearch security features are enabled; the role used to read source data and write to the destination index + /// remains unchanged. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpgradeTransformsAsync(CancellationToken cancellationToken = default) @@ -664,7 +1131,14 @@ public virtual Task UpgradeTransformsAsync(Cancellati } /// - /// Upgrades all transforms.
This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It
also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not
affect the source and destination indices. The upgrade also does not affect the roles that transforms use when
Elasticsearch security features are enabled; the role used to read source data and write to the destination index
remains unchanged. + /// + /// Upgrades all transforms. + /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It + /// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not + /// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when + /// Elasticsearch security features are enabled; the role used to read source data and write to the destination index + /// remains unchanged. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpgradeTransformsAsync(Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Xpack.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Xpack.g.cs index 892877ba55e..10bf4564987 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Xpack.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Xpack.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Xpack; public partial class XpackNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected XpackNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal XpackNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// Provides general information about the installed X-Pack features. + /// + /// Provides general information about the installed X-Pack features. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(XpackInfoRequest request, CancellationToken cancellationToken = default) @@ -48,7 +52,9 @@ public virtual Task InfoAsync(XpackInfoRequest request, Cance } /// - /// Provides general information about the installed X-Pack features. + /// + /// Provides general information about the installed X-Pack features. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(XpackInfoRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -58,7 +64,9 @@ public virtual Task InfoAsync(XpackInfoRequestDescriptor desc } /// - /// Provides general information about the installed X-Pack features. + /// + /// Provides general information about the installed X-Pack features. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(CancellationToken cancellationToken = default) @@ -69,7 +77,9 @@ public virtual Task InfoAsync(CancellationToken cancellationT } /// - /// Provides general information about the installed X-Pack features. + /// + /// Provides general information about the installed X-Pack features. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -81,7 +91,9 @@ public virtual Task InfoAsync(Action - /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// + /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(XpackUsageRequest request, CancellationToken cancellationToken = default) @@ -91,7 +103,9 @@ public virtual Task UsageAsync(XpackUsageRequest request, Ca } /// - /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// + /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(XpackUsageRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -101,7 +115,9 @@ public virtual Task UsageAsync(XpackUsageRequestDescriptor d } /// - /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// + /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(CancellationToken cancellationToken = default) @@ -112,7 +128,9 @@ public virtual Task UsageAsync(CancellationToken cancellatio } /// - /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// + /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.g.cs index ebb79accae4..e40b3bfe8ba 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.g.cs @@ -89,7 +89,11 @@ private partial void SetupNamespaces() } /// - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(BulkRequest request, CancellationToken cancellationToken = default) @@ -99,7 +103,11 @@ public virtual Task BulkAsync(BulkRequest request, CancellationTok } /// - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(BulkRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -109,7 +117,11 @@ public virtual Task BulkAsync(BulkRequestDescriptor - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName? index, CancellationToken cancellationToken = default) @@ -120,7 +132,11 @@ public virtual Task BulkAsync(Elastic.Clients.Elasticse } /// - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName? index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -132,7 +148,11 @@ public virtual Task BulkAsync(Elastic.Clients.Elasticse } /// - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(CancellationToken cancellationToken = default) @@ -143,7 +163,11 @@ public virtual Task BulkAsync(CancellationToken cancell } /// - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -155,7 +179,11 @@ public virtual Task BulkAsync(Action - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(BulkRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -165,7 +193,11 @@ public virtual Task BulkAsync(BulkRequestDescriptor descriptor, Ca } /// - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName? index, CancellationToken cancellationToken = default) @@ -176,7 +208,11 @@ public virtual Task BulkAsync(Elastic.Clients.Elasticsearch.Server } /// - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName? index, Action configureRequest, CancellationToken cancellationToken = default) @@ -188,7 +224,11 @@ public virtual Task BulkAsync(Elastic.Clients.Elasticsearch.Server } /// - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(CancellationToken cancellationToken = default) @@ -199,7 +239,11 @@ public virtual Task BulkAsync(CancellationToken cancellationToken } /// - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -211,7 +255,9 @@ public virtual Task BulkAsync(Action config } /// - /// Clears the search context and results for a scrolling search. + /// + /// Clears the search context and results for a scrolling search. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearScrollAsync(ClearScrollRequest request, CancellationToken cancellationToken = default) @@ -221,7 +267,9 @@ public virtual Task ClearScrollAsync(ClearScrollRequest req } /// - /// Clears the search context and results for a scrolling search. + /// + /// Clears the search context and results for a scrolling search. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearScrollAsync(ClearScrollRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -231,7 +279,9 @@ public virtual Task ClearScrollAsync(ClearScrollRequestDesc } /// - /// Clears the search context and results for a scrolling search. + /// + /// Clears the search context and results for a scrolling search. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearScrollAsync(CancellationToken cancellationToken = default) @@ -242,7 +292,9 @@ public virtual Task ClearScrollAsync(CancellationToken canc } /// - /// Clears the search context and results for a scrolling search. + /// + /// Clears the search context and results for a scrolling search. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearScrollAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -254,7 +306,9 @@ public virtual Task ClearScrollAsync(Action - /// Closes a point-in-time. + /// + /// Closes a point-in-time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClosePointInTimeAsync(ClosePointInTimeRequest request, CancellationToken cancellationToken = default) @@ -264,7 +318,9 @@ public virtual Task ClosePointInTimeAsync(ClosePointIn } /// - /// Closes a point-in-time. + /// + /// Closes a point-in-time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClosePointInTimeAsync(ClosePointInTimeRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -274,7 +330,9 @@ public virtual Task ClosePointInTimeAsync(ClosePointIn } /// - /// Closes a point-in-time. + /// + /// Closes a point-in-time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClosePointInTimeAsync(CancellationToken cancellationToken = default) @@ -285,7 +343,9 @@ public virtual Task ClosePointInTimeAsync(Cancellation } /// - /// Closes a point-in-time. + /// + /// Closes a point-in-time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClosePointInTimeAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -297,7 +357,9 @@ public virtual Task ClosePointInTimeAsync(Action - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CountAsync(CountRequest request, CancellationToken cancellationToken = default) @@ -307,7 +369,9 @@ public virtual Task CountAsync(CountRequest request, Cancellation } /// - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CountAsync(CountRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -317,7 +381,9 @@ public virtual Task CountAsync(CountRequestDescriptor< } /// - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CountAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -328,7 +394,9 @@ public virtual Task CountAsync(Elastic.Clients.Elastic } /// - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CountAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -340,7 +408,9 @@ public virtual Task CountAsync(Elastic.Clients.Elastic } /// - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CountAsync(CancellationToken cancellationToken = default) @@ -351,7 +421,9 @@ public virtual Task CountAsync(CancellationToken cance } /// - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CountAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -363,7 +435,9 @@ public virtual Task CountAsync(Action - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CountAsync(CountRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -373,7 +447,9 @@ public virtual Task CountAsync(CountRequestDescriptor descriptor, } /// - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CountAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -384,7 +460,9 @@ public virtual Task CountAsync(Elastic.Clients.Elasticsearch.Serv } /// - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CountAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -396,7 +474,9 @@ public virtual Task CountAsync(Elastic.Clients.Elasticsearch.Serv } /// - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CountAsync(CancellationToken cancellationToken = default) @@ -407,7 +487,9 @@ public virtual Task CountAsync(CancellationToken cancellationToke } /// - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CountAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -419,7 +501,11 @@ public virtual Task CountAsync(Action con } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(CreateRequest request, CancellationToken cancellationToken = default) @@ -429,7 +515,11 @@ public virtual Task CreateAsync(CreateRequest - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(CreateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -439,7 +529,11 @@ public virtual Task CreateAsync(CreateRequestDescript } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.IndexName index, Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -450,7 +544,11 @@ public virtual Task CreateAsync(TDocument document, E } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.IndexName index, Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -462,7 +560,11 @@ public virtual Task CreateAsync(TDocument document, E } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(TDocument document, CancellationToken cancellationToken = default) @@ -473,7 +575,11 @@ public virtual Task CreateAsync(TDocument document, C } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(TDocument document, Action> configureRequest, CancellationToken cancellationToken = default) @@ -485,7 +591,11 @@ public virtual Task CreateAsync(TDocument document, A } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.IndexName index, CancellationToken cancellationToken = default) @@ -496,7 +606,11 @@ public virtual Task CreateAsync(TDocument document, E } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -508,7 +622,11 @@ public virtual Task CreateAsync(TDocument document, E } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -519,7 +637,11 @@ public virtual Task CreateAsync(TDocument document, E } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -531,7 +653,10 @@ public virtual Task CreateAsync(TDocument document, E } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteRequest request, CancellationToken cancellationToken = default) @@ -541,7 +666,10 @@ public virtual Task DeleteAsync(DeleteRequest request, Cancellat } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -551,7 +679,10 @@ public virtual Task DeleteAsync(DeleteRequestDescript } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -562,7 +693,10 @@ public virtual Task DeleteAsync(Elastic.Clients.Elast } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -574,7 +708,10 @@ public virtual Task DeleteAsync(Elastic.Clients.Elast } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(TDocument document, CancellationToken cancellationToken = default) @@ -585,7 +722,10 @@ public virtual Task DeleteAsync(TDocument document, C } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(TDocument document, Action> configureRequest, CancellationToken cancellationToken = default) @@ -597,7 +737,10 @@ public virtual Task DeleteAsync(TDocument document, A } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.IndexName index, CancellationToken cancellationToken = default) @@ -608,7 +751,10 @@ public virtual Task DeleteAsync(TDocument document, E } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -620,7 +766,10 @@ public virtual Task DeleteAsync(TDocument document, E } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -631,7 +780,10 @@ public virtual Task DeleteAsync(TDocument document, E } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -643,7 +795,10 @@ public virtual Task DeleteAsync(TDocument document, E } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -654,7 +809,10 @@ public virtual Task DeleteAsync(Elastic.Clients.Elast } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -666,7 +824,10 @@ public virtual Task DeleteAsync(Elastic.Clients.Elast } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -676,7 +837,10 @@ public virtual Task DeleteAsync(DeleteRequestDescriptor descript } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -687,7 +851,10 @@ public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Se } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, Elastic.Clients.Elasticsearch.Serverless.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -699,7 +866,10 @@ public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Se } /// - /// Delete documents.
Deletes documents that match the specified query. + /// + /// Delete documents. + /// Deletes documents that match the specified query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteByQueryAsync(DeleteByQueryRequest request, CancellationToken cancellationToken = default) @@ -709,7 +879,10 @@ public virtual Task DeleteByQueryAsync(DeleteByQueryReque } /// - /// Delete documents.
Deletes documents that match the specified query. + /// + /// Delete documents. + /// Deletes documents that match the specified query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteByQueryAsync(DeleteByQueryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -719,7 +892,10 @@ public virtual Task DeleteByQueryAsync(DeleteB } /// - /// Delete documents.
Deletes documents that match the specified query. + /// + /// Delete documents. + /// Deletes documents that match the specified query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteByQueryAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, CancellationToken cancellationToken = default) @@ -730,7 +906,10 @@ public virtual Task DeleteByQueryAsync(Elastic } /// - /// Delete documents.
Deletes documents that match the specified query. + /// + /// Delete documents. + /// Deletes documents that match the specified query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteByQueryAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -742,7 +921,10 @@ public virtual Task DeleteByQueryAsync(Elastic } /// - /// Delete documents.
Deletes documents that match the specified query. + /// + /// Delete documents. + /// Deletes documents that match the specified query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteByQueryAsync(CancellationToken cancellationToken = default) @@ -753,7 +935,10 @@ public virtual Task DeleteByQueryAsync(Cancell } /// - /// Delete documents.
Deletes documents that match the specified query. + /// + /// Delete documents. + /// Deletes documents that match the specified query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteByQueryAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -765,7 +950,10 @@ public virtual Task DeleteByQueryAsync(Action< } /// - /// Delete documents.
Deletes documents that match the specified query. + /// + /// Delete documents. + /// Deletes documents that match the specified query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteByQueryAsync(DeleteByQueryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -775,7 +963,10 @@ public virtual Task DeleteByQueryAsync(DeleteByQueryReque } /// - /// Delete documents.
Deletes documents that match the specified query. + /// + /// Delete documents. + /// Deletes documents that match the specified query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteByQueryAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, CancellationToken cancellationToken = default) @@ -786,7 +977,10 @@ public virtual Task DeleteByQueryAsync(Elastic.Clients.El } /// - /// Delete documents.
Deletes documents that match the specified query. + /// + /// Delete documents. + /// Deletes documents that match the specified query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteByQueryAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -798,7 +992,9 @@ public virtual Task DeleteByQueryAsync(Elastic.Clients.El } /// - /// Changes the number of requests per second for a particular Delete By Query operation. + /// + /// Changes the number of requests per second for a particular Delete By Query operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteByQueryRethrottleAsync(DeleteByQueryRethrottleRequest request, CancellationToken cancellationToken = default) @@ -808,7 +1004,9 @@ public virtual Task DeleteByQueryRethrottleAsyn } /// - /// Changes the number of requests per second for a particular Delete By Query operation. + /// + /// Changes the number of requests per second for a particular Delete By Query operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteByQueryRethrottleAsync(DeleteByQueryRethrottleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -818,7 +1016,9 @@ public virtual Task DeleteByQueryRethrottleAsyn } /// - /// Changes the number of requests per second for a particular Delete By Query operation. + /// + /// Changes the number of requests per second for a particular Delete By Query operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteByQueryRethrottleAsync(Elastic.Clients.Elasticsearch.Serverless.TaskId taskId, CancellationToken cancellationToken = default) @@ -829,7 +1029,9 @@ public virtual Task DeleteByQueryRethrottleAsyn } /// - /// Changes the number of requests per second for a particular Delete By Query operation. + /// + /// Changes the number of requests per second for a particular Delete By Query operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteByQueryRethrottleAsync(Elastic.Clients.Elasticsearch.Serverless.TaskId taskId, Action configureRequest, CancellationToken cancellationToken = default) @@ -841,7 +1043,10 @@ public virtual Task DeleteByQueryRethrottleAsyn } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteScriptAsync(DeleteScriptRequest request, CancellationToken cancellationToken = default) @@ -851,7 +1056,10 @@ public virtual Task DeleteScriptAsync(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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteScriptAsync(DeleteScriptRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -861,7 +1069,10 @@ public virtual Task DeleteScriptAsync(DeleteScr } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteScriptAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -872,7 +1083,10 @@ public virtual Task DeleteScriptAsync(Elastic.C } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteScriptAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -884,7 +1098,10 @@ public virtual Task DeleteScriptAsync(Elastic.C } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteScriptAsync(DeleteScriptRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -894,7 +1111,10 @@ public virtual Task DeleteScriptAsync(DeleteScriptRequestD } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteScriptAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -905,7 +1125,10 @@ public virtual Task DeleteScriptAsync(Elastic.Clients.Elas } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteScriptAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -917,7 +1140,10 @@ public virtual Task DeleteScriptAsync(Elastic.Clients.Elas } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(ExistsRequest request, CancellationToken cancellationToken = default) @@ -927,7 +1153,10 @@ public virtual Task ExistsAsync(ExistsRequest request, Cancellat } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(ExistsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -937,7 +1166,10 @@ public virtual Task ExistsAsync(ExistsRequestDescript } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -948,7 +1180,10 @@ public virtual Task ExistsAsync(Elastic.Clients.Elast } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -960,7 +1195,10 @@ public virtual Task ExistsAsync(Elastic.Clients.Elast } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(TDocument document, CancellationToken cancellationToken = default) @@ -971,7 +1209,10 @@ public virtual Task ExistsAsync(TDocument document, C } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(TDocument document, Action> configureRequest, CancellationToken cancellationToken = default) @@ -983,7 +1224,10 @@ public virtual Task ExistsAsync(TDocument document, A } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.IndexName index, CancellationToken cancellationToken = default) @@ -994,7 +1238,10 @@ public virtual Task ExistsAsync(TDocument document, E } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1006,7 +1253,10 @@ public virtual Task ExistsAsync(TDocument document, E } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -1017,7 +1267,10 @@ public virtual Task ExistsAsync(TDocument document, E } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1029,7 +1282,10 @@ public virtual Task ExistsAsync(TDocument document, E } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -1040,7 +1296,10 @@ public virtual Task ExistsAsync(Elastic.Clients.Elast } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1052,7 +1311,10 @@ public virtual Task ExistsAsync(Elastic.Clients.Elast } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(ExistsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1062,7 +1324,10 @@ public virtual Task ExistsAsync(ExistsRequestDescriptor descript } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -1073,7 +1338,10 @@ public virtual Task ExistsAsync(Elastic.Clients.Elasticsearch.Se } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, Elastic.Clients.Elasticsearch.Serverless.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -1085,7 +1353,10 @@ public virtual Task ExistsAsync(Elastic.Clients.Elasticsearch.Se } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsSourceAsync(ExistsSourceRequest request, CancellationToken cancellationToken = default) @@ -1095,7 +1366,10 @@ public virtual Task ExistsSourceAsync(ExistsSourceRequest } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsSourceAsync(ExistsSourceRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1105,7 +1379,10 @@ public virtual Task ExistsSourceAsync(ExistsSou } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsSourceAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -1116,7 +1393,10 @@ public virtual Task ExistsSourceAsync(Elastic.C } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsSourceAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1128,7 +1408,10 @@ public virtual Task ExistsSourceAsync(Elastic.C } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsSourceAsync(TDocument document, CancellationToken cancellationToken = default) @@ -1139,7 +1422,10 @@ public virtual Task ExistsSourceAsync(TDocument } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsSourceAsync(TDocument document, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1151,7 +1437,10 @@ public virtual Task ExistsSourceAsync(TDocument } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsSourceAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.IndexName index, CancellationToken cancellationToken = default) @@ -1162,7 +1451,10 @@ public virtual Task ExistsSourceAsync(TDocument } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsSourceAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1174,7 +1466,10 @@ public virtual Task ExistsSourceAsync(TDocument } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsSourceAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -1185,7 +1480,10 @@ public virtual Task ExistsSourceAsync(TDocument } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsSourceAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1197,7 +1495,10 @@ public virtual Task ExistsSourceAsync(TDocument } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsSourceAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -1208,7 +1509,10 @@ public virtual Task ExistsSourceAsync(Elastic.C } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsSourceAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1220,7 +1524,10 @@ public virtual Task ExistsSourceAsync(Elastic.C } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsSourceAsync(ExistsSourceRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1230,7 +1537,10 @@ public virtual Task ExistsSourceAsync(ExistsSourceRequestD } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsSourceAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -1241,7 +1551,10 @@ public virtual Task ExistsSourceAsync(Elastic.Clients.Elas } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsSourceAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, Elastic.Clients.Elasticsearch.Serverless.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -1253,7 +1566,10 @@ public virtual Task ExistsSourceAsync(Elastic.Clients.Elas } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> ExplainAsync(ExplainRequest request, CancellationToken cancellationToken = default) @@ -1263,7 +1579,10 @@ public virtual Task> ExplainAsync(ExplainR } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> ExplainAsync(ExplainRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1273,7 +1592,10 @@ public virtual Task> ExplainAsync(ExplainR } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> ExplainAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -1284,7 +1606,10 @@ public virtual Task> ExplainAsync(Elastic. } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> ExplainAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1296,7 +1621,10 @@ public virtual Task> ExplainAsync(Elastic. } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> ExplainAsync(TDocument document, CancellationToken cancellationToken = default) @@ -1307,7 +1635,10 @@ public virtual Task> ExplainAsync(TDocumen } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> ExplainAsync(TDocument document, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1319,7 +1650,10 @@ public virtual Task> ExplainAsync(TDocumen } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> ExplainAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.IndexName index, CancellationToken cancellationToken = default) @@ -1330,7 +1664,10 @@ public virtual Task> ExplainAsync(TDocumen } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> ExplainAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1342,7 +1679,10 @@ public virtual Task> ExplainAsync(TDocumen } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> ExplainAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -1353,7 +1693,10 @@ public virtual Task> ExplainAsync(TDocumen } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> ExplainAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1365,7 +1708,10 @@ public virtual Task> ExplainAsync(TDocumen } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> ExplainAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -1376,7 +1722,10 @@ public virtual Task> ExplainAsync(Elastic. } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> ExplainAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1388,7 +1737,11 @@ public virtual Task> ExplainAsync(Elastic. } /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldCapsAsync(FieldCapsRequest request, CancellationToken cancellationToken = default) @@ -1398,7 +1751,11 @@ public virtual Task FieldCapsAsync(FieldCapsRequest request, } /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldCapsAsync(FieldCapsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1408,7 +1765,11 @@ public virtual Task FieldCapsAsync(FieldCapsReques } /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldCapsAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -1419,7 +1780,11 @@ public virtual Task FieldCapsAsync(Elastic.Clients } /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldCapsAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1431,7 +1796,11 @@ public virtual Task FieldCapsAsync(Elastic.Clients } /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldCapsAsync(CancellationToken cancellationToken = default) @@ -1442,7 +1811,11 @@ public virtual Task FieldCapsAsync(CancellationTok } /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldCapsAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -1454,7 +1827,11 @@ public virtual Task FieldCapsAsync(Action - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldCapsAsync(FieldCapsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1464,7 +1841,11 @@ public virtual Task FieldCapsAsync(FieldCapsRequestDescriptor } /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldCapsAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -1475,7 +1856,11 @@ public virtual Task FieldCapsAsync(Elastic.Clients.Elasticsea } /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldCapsAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -1487,7 +1872,11 @@ public virtual Task FieldCapsAsync(Elastic.Clients.Elasticsea } /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldCapsAsync(CancellationToken cancellationToken = default) @@ -1498,7 +1887,11 @@ public virtual Task FieldCapsAsync(CancellationToken cancella } /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldCapsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -1510,7 +1903,10 @@ public virtual Task FieldCapsAsync(Action - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(GetRequest request, CancellationToken cancellationToken = default) @@ -1520,7 +1916,10 @@ public virtual Task> GetAsync(GetRequest reque } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(GetRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1530,7 +1929,10 @@ public virtual Task> GetAsync(GetRequestDescri } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -1541,7 +1943,10 @@ public virtual Task> GetAsync(Elastic.Clients. } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1553,7 +1958,10 @@ public virtual Task> GetAsync(Elastic.Clients. } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(TDocument document, CancellationToken cancellationToken = default) @@ -1564,7 +1972,10 @@ public virtual Task> GetAsync(TDocument docume } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(TDocument document, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1576,7 +1987,10 @@ public virtual Task> GetAsync(TDocument docume } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.IndexName index, CancellationToken cancellationToken = default) @@ -1587,7 +2001,10 @@ public virtual Task> GetAsync(TDocument docume } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1599,7 +2016,10 @@ public virtual Task> GetAsync(TDocument docume } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -1610,7 +2030,10 @@ public virtual Task> GetAsync(TDocument docume } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1622,7 +2045,10 @@ public virtual Task> GetAsync(TDocument docume } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -1633,7 +2059,10 @@ public virtual Task> GetAsync(Elastic.Clients. } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1645,7 +2074,10 @@ public virtual Task> GetAsync(Elastic.Clients. } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetScriptAsync(GetScriptRequest request, CancellationToken cancellationToken = default) @@ -1655,7 +2087,10 @@ public virtual Task GetScriptAsync(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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetScriptAsync(GetScriptRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1665,7 +2100,10 @@ public virtual Task GetScriptAsync(GetScriptReques } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetScriptAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -1676,7 +2114,10 @@ public virtual Task GetScriptAsync(Elastic.Clients } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetScriptAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1688,7 +2129,10 @@ public virtual Task GetScriptAsync(Elastic.Clients } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetScriptAsync(GetScriptRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1698,7 +2142,10 @@ public virtual Task GetScriptAsync(GetScriptRequestDescriptor } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetScriptAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -1709,7 +2156,10 @@ public virtual Task GetScriptAsync(Elastic.Clients.Elasticsea } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetScriptAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -1721,7 +2171,10 @@ public virtual Task GetScriptAsync(Elastic.Clients.Elasticsea } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetSourceAsync(GetSourceRequest request, CancellationToken cancellationToken = default) @@ -1731,7 +2184,10 @@ public virtual Task> GetSourceAsync(GetS } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetSourceAsync(GetSourceRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1741,7 +2197,10 @@ public virtual Task> GetSourceAsync(GetS } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetSourceAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -1752,7 +2211,10 @@ public virtual Task> GetSourceAsync(Elas } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetSourceAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1764,7 +2226,10 @@ public virtual Task> GetSourceAsync(Elas } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetSourceAsync(TDocument document, CancellationToken cancellationToken = default) @@ -1775,7 +2240,10 @@ public virtual Task> GetSourceAsync(TDoc } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetSourceAsync(TDocument document, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1787,7 +2255,10 @@ public virtual Task> GetSourceAsync(TDoc } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetSourceAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.IndexName index, CancellationToken cancellationToken = default) @@ -1798,7 +2269,10 @@ public virtual Task> GetSourceAsync(TDoc } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetSourceAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1810,7 +2284,10 @@ public virtual Task> GetSourceAsync(TDoc } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetSourceAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -1821,7 +2298,10 @@ public virtual Task> GetSourceAsync(TDoc } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetSourceAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1833,7 +2313,10 @@ public virtual Task> GetSourceAsync(TDoc } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetSourceAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -1844,7 +2327,10 @@ public virtual Task> GetSourceAsync(Elas } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetSourceAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1856,7 +2342,9 @@ public virtual Task> GetSourceAsync(Elas } /// - /// Returns the health of the cluster. + /// + /// Returns the health of the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthReportAsync(HealthReportRequest request, CancellationToken cancellationToken = default) @@ -1866,7 +2354,9 @@ public virtual Task HealthReportAsync(HealthReportRequest } /// - /// Returns the health of the cluster. + /// + /// Returns the health of the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthReportAsync(HealthReportRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1876,7 +2366,9 @@ public virtual Task HealthReportAsync(HealthReportRequestD } /// - /// Returns the health of the cluster. + /// + /// Returns the health of the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthReportAsync(IReadOnlyCollection? feature, CancellationToken cancellationToken = default) @@ -1887,7 +2379,9 @@ public virtual Task HealthReportAsync(IReadOnlyCollection< } /// - /// Returns the health of the cluster. + /// + /// Returns the health of the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthReportAsync(IReadOnlyCollection? feature, Action configureRequest, CancellationToken cancellationToken = default) @@ -1899,7 +2393,9 @@ public virtual Task HealthReportAsync(IReadOnlyCollection< } /// - /// Returns the health of the cluster. + /// + /// Returns the health of the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthReportAsync(CancellationToken cancellationToken = default) @@ -1910,7 +2406,9 @@ public virtual Task HealthReportAsync(CancellationToken ca } /// - /// Returns the health of the cluster. + /// + /// Returns the health of the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthReportAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -1922,7 +2420,11 @@ public virtual Task HealthReportAsync(Action - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task IndexAsync(IndexRequest request, CancellationToken cancellationToken = default) @@ -1932,7 +2434,11 @@ public virtual Task IndexAsync(IndexRequest } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task IndexAsync(IndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1942,7 +2448,11 @@ public virtual Task IndexAsync(IndexRequestDescriptor< } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task IndexAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.IndexName index, Elastic.Clients.Elasticsearch.Serverless.Id? id, CancellationToken cancellationToken = default) @@ -1953,7 +2463,11 @@ public virtual Task IndexAsync(TDocument document, Ela } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task IndexAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.IndexName index, Elastic.Clients.Elasticsearch.Serverless.Id? id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1965,7 +2479,11 @@ public virtual Task IndexAsync(TDocument document, Ela } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task IndexAsync(TDocument document, CancellationToken cancellationToken = default) @@ -1976,7 +2494,11 @@ public virtual Task IndexAsync(TDocument document, Can } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task IndexAsync(TDocument document, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1988,7 +2510,11 @@ public virtual Task IndexAsync(TDocument document, Act } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task IndexAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.IndexName index, CancellationToken cancellationToken = default) @@ -1999,7 +2525,11 @@ public virtual Task IndexAsync(TDocument document, Ela } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task IndexAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2011,7 +2541,11 @@ public virtual Task IndexAsync(TDocument document, Ela } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task IndexAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.Id? id, CancellationToken cancellationToken = default) @@ -2022,7 +2556,11 @@ public virtual Task IndexAsync(TDocument document, Ela } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task IndexAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.Id? id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2034,7 +2572,10 @@ public virtual Task IndexAsync(TDocument document, Ela } /// - /// Get cluster info.
Returns basic information about the cluster. + /// + /// Get cluster info. + /// Returns basic information about the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(InfoRequest request, CancellationToken cancellationToken = default) @@ -2044,7 +2585,10 @@ public virtual Task InfoAsync(InfoRequest request, CancellationTok } /// - /// Get cluster info.
Returns basic information about the cluster. + /// + /// Get cluster info. + /// Returns basic information about the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(InfoRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2054,7 +2598,10 @@ public virtual Task InfoAsync(InfoRequestDescriptor descriptor, Ca } /// - /// Get cluster info.
Returns basic information about the cluster. + /// + /// Get cluster info. + /// Returns basic information about the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(CancellationToken cancellationToken = default) @@ -2065,7 +2612,10 @@ public virtual Task InfoAsync(CancellationToken cancellationToken } /// - /// Get cluster info.
Returns basic information about the cluster. + /// + /// Get cluster info. + /// Returns basic information about the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -2077,7 +2627,9 @@ public virtual Task InfoAsync(Action config } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MtermvectorsAsync(MultiTermVectorsRequest request, CancellationToken cancellationToken = default) @@ -2087,7 +2639,9 @@ public virtual Task MtermvectorsAsync(MultiTermVectors } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MtermvectorsAsync(MultiTermVectorsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2097,7 +2651,9 @@ public virtual Task MtermvectorsAsync(Multi } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MtermvectorsAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName? index, CancellationToken cancellationToken = default) @@ -2108,7 +2664,9 @@ public virtual Task MtermvectorsAsync(Elast } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MtermvectorsAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName? index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2120,7 +2678,9 @@ public virtual Task MtermvectorsAsync(Elast } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MtermvectorsAsync(CancellationToken cancellationToken = default) @@ -2131,7 +2691,9 @@ public virtual Task MtermvectorsAsync(Cance } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MtermvectorsAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -2143,7 +2705,9 @@ public virtual Task MtermvectorsAsync(Actio } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MtermvectorsAsync(MultiTermVectorsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2153,7 +2717,9 @@ public virtual Task MtermvectorsAsync(MultiTermVectors } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MtermvectorsAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName? index, CancellationToken cancellationToken = default) @@ -2164,7 +2730,9 @@ public virtual Task MtermvectorsAsync(Elastic.Clients. } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MtermvectorsAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName? index, Action configureRequest, CancellationToken cancellationToken = default) @@ -2176,7 +2744,9 @@ public virtual Task MtermvectorsAsync(Elastic.Clients. } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MtermvectorsAsync(CancellationToken cancellationToken = default) @@ -2187,7 +2757,9 @@ public virtual Task MtermvectorsAsync(CancellationToke } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MtermvectorsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -2199,7 +2771,9 @@ public virtual Task MtermvectorsAsync(Action - /// Allows to get multiple documents in one request. + /// + /// Allows to get multiple documents in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiGetAsync(MultiGetRequest request, CancellationToken cancellationToken = default) @@ -2209,7 +2783,9 @@ public virtual Task> MultiGetAsync(MultiG } /// - /// Allows to get multiple documents in one request. + /// + /// Allows to get multiple documents in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiGetAsync(MultiGetRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2219,7 +2795,9 @@ public virtual Task> MultiGetAsync(MultiG } /// - /// Allows to get multiple documents in one request. + /// + /// Allows to get multiple documents in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiGetAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName? index, CancellationToken cancellationToken = default) @@ -2230,7 +2808,9 @@ public virtual Task> MultiGetAsync(Elasti } /// - /// Allows to get multiple documents in one request. + /// + /// Allows to get multiple documents in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiGetAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName? index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2242,7 +2822,9 @@ public virtual Task> MultiGetAsync(Elasti } /// - /// Allows to get multiple documents in one request. + /// + /// Allows to get multiple documents in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiGetAsync(CancellationToken cancellationToken = default) @@ -2253,7 +2835,9 @@ public virtual Task> MultiGetAsync(Cancel } /// - /// Allows to get multiple documents in one request. + /// + /// Allows to get multiple documents in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiGetAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -2265,7 +2849,9 @@ public virtual Task> MultiGetAsync(Action } /// - /// Allows to execute several search operations in one request. + /// + /// Allows to execute several search operations in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiSearchAsync(MultiSearchRequest request, CancellationToken cancellationToken = default) @@ -2275,7 +2861,9 @@ public virtual Task> MultiSearchAsync( } /// - /// Allows to execute several search operations in one request. + /// + /// Allows to execute several search operations in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiSearchAsync(MultiSearchRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2285,7 +2873,9 @@ public virtual Task> MultiSearchAsync( } /// - /// Allows to execute several search operations in one request. + /// + /// Allows to execute several search operations in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiSearchAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -2296,7 +2886,9 @@ public virtual Task> MultiSearchAsync( } /// - /// Allows to execute several search operations in one request. + /// + /// Allows to execute several search operations in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiSearchAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2308,7 +2900,9 @@ public virtual Task> MultiSearchAsync( } /// - /// Allows to execute several search operations in one request. + /// + /// Allows to execute several search operations in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiSearchAsync(CancellationToken cancellationToken = default) @@ -2319,7 +2913,9 @@ public virtual Task> MultiSearchAsync( } /// - /// Allows to execute several search operations in one request. + /// + /// Allows to execute several search operations in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiSearchAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -2331,7 +2927,9 @@ public virtual Task> MultiSearchAsync( } /// - /// Runs multiple templated searches with a single request. + /// + /// Runs multiple templated searches with a single request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiSearchTemplateAsync(MultiSearchTemplateRequest request, CancellationToken cancellationToken = default) @@ -2341,7 +2939,9 @@ public virtual Task> MultiSearchTemplateA } /// - /// Runs multiple templated searches with a single request. + /// + /// Runs multiple templated searches with a single request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiSearchTemplateAsync(MultiSearchTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2351,7 +2951,9 @@ public virtual Task> MultiSearchTemplateA } /// - /// Runs multiple templated searches with a single request. + /// + /// Runs multiple templated searches with a single request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiSearchTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -2362,7 +2964,9 @@ public virtual Task> MultiSearchTemplateA } /// - /// Runs multiple templated searches with a single request. + /// + /// Runs multiple templated searches with a single request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiSearchTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2374,7 +2978,9 @@ public virtual Task> MultiSearchTemplateA } /// - /// Runs multiple templated searches with a single request. + /// + /// Runs multiple templated searches with a single request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiSearchTemplateAsync(CancellationToken cancellationToken = default) @@ -2385,7 +2991,9 @@ public virtual Task> MultiSearchTemplateA } /// - /// Runs multiple templated searches with a single request. + /// + /// Runs multiple templated searches with a single request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiSearchTemplateAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -2397,7 +3005,14 @@ public virtual Task> MultiSearchTemplateA } /// - /// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. + /// + /// A search request by default executes against the most recent visible data of the target indices, + /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the + /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple + /// search requests using the same point in time. For example, if refreshes happen between + /// search_after requests, then the results of those requests might not be consistent as changes happening + /// between searches are only visible to the more recent point in time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(OpenPointInTimeRequest request, CancellationToken cancellationToken = default) @@ -2407,7 +3022,14 @@ public virtual Task OpenPointInTimeAsync(OpenPointInTim } /// - /// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. + /// + /// A search request by default executes against the most recent visible data of the target indices, + /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the + /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple + /// search requests using the same point in time. For example, if refreshes happen between + /// search_after requests, then the results of those requests might not be consistent as changes happening + /// between searches are only visible to the more recent point in time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(OpenPointInTimeRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2417,7 +3039,14 @@ public virtual Task OpenPointInTimeAsync(Ope } /// - /// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. + /// + /// A search request by default executes against the most recent visible data of the target indices, + /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the + /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple + /// search requests using the same point in time. For example, if refreshes happen between + /// search_after requests, then the results of those requests might not be consistent as changes happening + /// between searches are only visible to the more recent point in time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, CancellationToken cancellationToken = default) @@ -2428,7 +3057,14 @@ public virtual Task OpenPointInTimeAsync(Ela } /// - /// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. + /// + /// A search request by default executes against the most recent visible data of the target indices, + /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the + /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple + /// search requests using the same point in time. For example, if refreshes happen between + /// search_after requests, then the results of those requests might not be consistent as changes happening + /// between searches are only visible to the more recent point in time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2440,7 +3076,14 @@ public virtual Task OpenPointInTimeAsync(Ela } /// - /// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. + /// + /// A search request by default executes against the most recent visible data of the target indices, + /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the + /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple + /// search requests using the same point in time. For example, if refreshes happen between + /// search_after requests, then the results of those requests might not be consistent as changes happening + /// between searches are only visible to the more recent point in time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(CancellationToken cancellationToken = default) @@ -2451,7 +3094,14 @@ public virtual Task OpenPointInTimeAsync(Can } /// - /// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. + /// + /// A search request by default executes against the most recent visible data of the target indices, + /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the + /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple + /// search requests using the same point in time. For example, if refreshes happen between + /// search_after requests, then the results of those requests might not be consistent as changes happening + /// between searches are only visible to the more recent point in time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -2463,7 +3113,14 @@ public virtual Task OpenPointInTimeAsync(Act } /// - /// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. + /// + /// A search request by default executes against the most recent visible data of the target indices, + /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the + /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple + /// search requests using the same point in time. For example, if refreshes happen between + /// search_after requests, then the results of those requests might not be consistent as changes happening + /// between searches are only visible to the more recent point in time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(OpenPointInTimeRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2473,7 +3130,14 @@ public virtual Task OpenPointInTimeAsync(OpenPointInTim } /// - /// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. + /// + /// A search request by default executes against the most recent visible data of the target indices, + /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the + /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple + /// search requests using the same point in time. For example, if refreshes happen between + /// search_after requests, then the results of those requests might not be consistent as changes happening + /// between searches are only visible to the more recent point in time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, CancellationToken cancellationToken = default) @@ -2484,7 +3148,14 @@ public virtual Task OpenPointInTimeAsync(Elastic.Client } /// - /// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. + /// + /// A search request by default executes against the most recent visible data of the target indices, + /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the + /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple + /// search requests using the same point in time. For example, if refreshes happen between + /// search_after requests, then the results of those requests might not be consistent as changes happening + /// between searches are only visible to the more recent point in time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -2496,7 +3167,10 @@ public virtual Task OpenPointInTimeAsync(Elastic.Client } /// - /// Ping the cluster.
Returns whether the cluster is running. + /// + /// Ping the cluster. + /// Returns whether the cluster is running. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PingAsync(PingRequest request, CancellationToken cancellationToken = default) @@ -2506,7 +3180,10 @@ public virtual Task PingAsync(PingRequest request, CancellationTok } /// - /// Ping the cluster.
Returns whether the cluster is running. + /// + /// Ping the cluster. + /// Returns whether the cluster is running. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PingAsync(PingRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2516,7 +3193,10 @@ public virtual Task PingAsync(PingRequestDescriptor descriptor, Ca } /// - /// Ping the cluster.
Returns whether the cluster is running. + /// + /// Ping the cluster. + /// Returns whether the cluster is running. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PingAsync(CancellationToken cancellationToken = default) @@ -2527,7 +3207,10 @@ public virtual Task PingAsync(CancellationToken cancellationToken } /// - /// Ping the cluster.
Returns whether the cluster is running. + /// + /// Ping the cluster. + /// Returns whether the cluster is running. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PingAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -2539,7 +3222,10 @@ public virtual Task PingAsync(Action config } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutScriptAsync(PutScriptRequest request, CancellationToken cancellationToken = default) @@ -2549,7 +3235,10 @@ public virtual Task PutScriptAsync(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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutScriptAsync(PutScriptRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2559,7 +3248,10 @@ public virtual Task PutScriptAsync(PutScriptReques } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutScriptAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Elastic.Clients.Elasticsearch.Serverless.Name? context, CancellationToken cancellationToken = default) @@ -2570,7 +3262,10 @@ public virtual Task PutScriptAsync(Elastic.Clients } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutScriptAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Elastic.Clients.Elasticsearch.Serverless.Name? context, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2582,7 +3277,10 @@ public virtual Task PutScriptAsync(Elastic.Clients } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutScriptAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -2593,7 +3291,10 @@ public virtual Task PutScriptAsync(Elastic.Clients } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutScriptAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2605,7 +3306,10 @@ public virtual Task PutScriptAsync(Elastic.Clients } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutScriptAsync(PutScriptRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2615,7 +3319,10 @@ public virtual Task PutScriptAsync(PutScriptRequestDescriptor } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutScriptAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Elastic.Clients.Elasticsearch.Serverless.Name? context, CancellationToken cancellationToken = default) @@ -2626,7 +3333,10 @@ public virtual Task PutScriptAsync(Elastic.Clients.Elasticsea } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutScriptAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Elastic.Clients.Elasticsearch.Serverless.Name? context, Action configureRequest, CancellationToken cancellationToken = default) @@ -2638,7 +3348,10 @@ public virtual Task PutScriptAsync(Elastic.Clients.Elasticsea } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutScriptAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -2649,7 +3362,10 @@ public virtual Task PutScriptAsync(Elastic.Clients.Elasticsea } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutScriptAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -2661,7 +3377,9 @@ public virtual Task PutScriptAsync(Elastic.Clients.Elasticsea } /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RankEvalAsync(RankEvalRequest request, CancellationToken cancellationToken = default) @@ -2671,7 +3389,9 @@ public virtual Task RankEvalAsync(RankEvalRequest request, Can } /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RankEvalAsync(RankEvalRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2681,7 +3401,9 @@ public virtual Task RankEvalAsync(RankEvalRequestDe } /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RankEvalAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -2692,7 +3414,9 @@ public virtual Task RankEvalAsync(Elastic.Clients.E } /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RankEvalAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2704,7 +3428,9 @@ public virtual Task RankEvalAsync(Elastic.Clients.E } /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RankEvalAsync(CancellationToken cancellationToken = default) @@ -2715,7 +3441,9 @@ public virtual Task RankEvalAsync(CancellationToken } /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RankEvalAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -2727,7 +3455,9 @@ public virtual Task RankEvalAsync(Action - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RankEvalAsync(RankEvalRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2737,7 +3467,9 @@ public virtual Task RankEvalAsync(RankEvalRequestDescriptor de } /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RankEvalAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -2748,7 +3480,9 @@ public virtual Task RankEvalAsync(Elastic.Clients.Elasticsearc } /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RankEvalAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -2760,7 +3494,9 @@ public virtual Task RankEvalAsync(Elastic.Clients.Elasticsearc } /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RankEvalAsync(CancellationToken cancellationToken = default) @@ -2771,7 +3507,9 @@ public virtual Task RankEvalAsync(CancellationToken cancellati } /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RankEvalAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -2783,7 +3521,10 @@ public virtual Task RankEvalAsync(Action - /// Reindex documents.
Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// + /// Reindex documents. + /// Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReindexAsync(ReindexRequest request, CancellationToken cancellationToken = default) @@ -2793,7 +3534,10 @@ public virtual Task ReindexAsync(ReindexRequest request, Cancel } /// - /// Reindex documents.
Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// + /// Reindex documents. + /// Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReindexAsync(ReindexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2803,7 +3547,10 @@ public virtual Task ReindexAsync(ReindexRequestDescr } /// - /// Reindex documents.
Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// + /// Reindex documents. + /// Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReindexAsync(CancellationToken cancellationToken = default) @@ -2814,7 +3561,10 @@ public virtual Task ReindexAsync(CancellationToken c } /// - /// Reindex documents.
Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// + /// Reindex documents. + /// Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReindexAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -2826,7 +3576,10 @@ public virtual Task ReindexAsync(Action - /// Reindex documents.
Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// + /// Reindex documents. + /// Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReindexAsync(ReindexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2836,7 +3589,10 @@ public virtual Task ReindexAsync(ReindexRequestDescriptor descr } /// - /// Reindex documents.
Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// + /// Reindex documents. + /// Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReindexAsync(CancellationToken cancellationToken = default) @@ -2847,7 +3603,10 @@ public virtual Task ReindexAsync(CancellationToken cancellation } /// - /// Reindex documents.
Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// + /// Reindex documents. + /// Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReindexAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -2859,7 +3618,9 @@ public virtual Task ReindexAsync(Action - /// Copies documents from a source to a destination. + /// + /// Copies documents from a source to a destination. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReindexRethrottleAsync(ReindexRethrottleRequest request, CancellationToken cancellationToken = default) @@ -2869,7 +3630,9 @@ public virtual Task ReindexRethrottleAsync(ReindexRet } /// - /// Copies documents from a source to a destination. + /// + /// Copies documents from a source to a destination. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReindexRethrottleAsync(ReindexRethrottleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2879,7 +3642,9 @@ public virtual Task ReindexRethrottleAsync(ReindexRet } /// - /// Copies documents from a source to a destination. + /// + /// Copies documents from a source to a destination. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReindexRethrottleAsync(Elastic.Clients.Elasticsearch.Serverless.Id taskId, CancellationToken cancellationToken = default) @@ -2890,7 +3655,9 @@ public virtual Task ReindexRethrottleAsync(Elastic.Cl } /// - /// Copies documents from a source to a destination. + /// + /// Copies documents from a source to a destination. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReindexRethrottleAsync(Elastic.Clients.Elasticsearch.Serverless.Id taskId, Action configureRequest, CancellationToken cancellationToken = default) @@ -2902,7 +3669,9 @@ public virtual Task ReindexRethrottleAsync(Elastic.Cl } /// - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RenderSearchTemplateAsync(RenderSearchTemplateRequest request, CancellationToken cancellationToken = default) @@ -2912,7 +3681,9 @@ public virtual Task RenderSearchTemplateAsync(Rend } /// - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RenderSearchTemplateAsync(RenderSearchTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2922,7 +3693,9 @@ public virtual Task RenderSearchTemplateAsync - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RenderSearchTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Id? id, CancellationToken cancellationToken = default) @@ -2933,7 +3706,9 @@ public virtual Task RenderSearchTemplateAsync - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RenderSearchTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Id? id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2945,7 +3720,9 @@ public virtual Task RenderSearchTemplateAsync - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RenderSearchTemplateAsync(CancellationToken cancellationToken = default) @@ -2956,7 +3733,9 @@ public virtual Task RenderSearchTemplateAsync - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RenderSearchTemplateAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -2968,7 +3747,9 @@ public virtual Task RenderSearchTemplateAsync - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RenderSearchTemplateAsync(RenderSearchTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2978,7 +3759,9 @@ public virtual Task RenderSearchTemplateAsync(Rend } /// - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RenderSearchTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Id? id, CancellationToken cancellationToken = default) @@ -2989,7 +3772,9 @@ public virtual Task RenderSearchTemplateAsync(Elas } /// - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RenderSearchTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Id? id, Action configureRequest, CancellationToken cancellationToken = default) @@ -3001,7 +3786,9 @@ public virtual Task RenderSearchTemplateAsync(Elas } /// - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RenderSearchTemplateAsync(CancellationToken cancellationToken = default) @@ -3012,7 +3799,9 @@ public virtual Task RenderSearchTemplateAsync(Canc } /// - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RenderSearchTemplateAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -3024,7 +3813,9 @@ public virtual Task RenderSearchTemplateAsync(Acti } /// - /// Allows to retrieve a large numbers of results from a single search request. + /// + /// Allows to retrieve a large numbers of results from a single search request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> ScrollAsync(ScrollRequest request, CancellationToken cancellationToken = default) @@ -3034,7 +3825,11 @@ public virtual Task> ScrollAsync(ScrollRequ } /// - /// Returns search hits that match the query defined in the request.
You can provide search queries using the `q` query string parameter or the request body.
If both are specified, only the query parameter is used. + /// + /// Returns search hits that match the query defined in the request. + /// You can provide search queries using the q query string parameter or the request body. + /// If both are specified, only the query parameter is used. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchAsync(SearchRequest request, CancellationToken cancellationToken = default) @@ -3044,7 +3839,11 @@ public virtual Task> SearchAsync(SearchRequ } /// - /// Returns search hits that match the query defined in the request.
You can provide search queries using the `q` query string parameter or the request body.
If both are specified, only the query parameter is used. + /// + /// Returns search hits that match the query defined in the request. + /// You can provide search queries using the q query string parameter or the request body. + /// If both are specified, only the query parameter is used. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchAsync(SearchRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3054,7 +3853,11 @@ public virtual Task> SearchAsync(SearchRequ } /// - /// Returns search hits that match the query defined in the request.
You can provide search queries using the `q` query string parameter or the request body.
If both are specified, only the query parameter is used. + /// + /// Returns search hits that match the query defined in the request. + /// You can provide search queries using the q query string parameter or the request body. + /// If both are specified, only the query parameter is used. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -3065,7 +3868,11 @@ public virtual Task> SearchAsync(Elastic.Cl } /// - /// Returns search hits that match the query defined in the request.
You can provide search queries using the `q` query string parameter or the request body.
If both are specified, only the query parameter is used. + /// + /// Returns search hits that match the query defined in the request. + /// You can provide search queries using the q query string parameter or the request body. + /// If both are specified, only the query parameter is used. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3077,7 +3884,11 @@ public virtual Task> SearchAsync(Elastic.Cl } /// - /// Returns search hits that match the query defined in the request.
You can provide search queries using the `q` query string parameter or the request body.
If both are specified, only the query parameter is used. + /// + /// Returns search hits that match the query defined in the request. + /// You can provide search queries using the q query string parameter or the request body. + /// If both are specified, only the query parameter is used. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchAsync(CancellationToken cancellationToken = default) @@ -3088,7 +3899,11 @@ public virtual Task> SearchAsync(Cancellati } /// - /// Returns search hits that match the query defined in the request.
You can provide search queries using the `q` query string parameter or the request body.
If both are specified, only the query parameter is used. + /// + /// Returns search hits that match the query defined in the request. + /// You can provide search queries using the q query string parameter or the request body. + /// If both are specified, only the query parameter is used. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -3100,7 +3915,10 @@ public virtual Task> SearchAsync(Action - /// Search a vector tile.
Searches a vector tile for geospatial values. + /// + /// Search a vector tile. + /// Searches a vector tile for geospatial values. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SearchMvtAsync(SearchMvtRequest request, CancellationToken cancellationToken = default) @@ -3110,7 +3928,10 @@ public virtual Task SearchMvtAsync(SearchMvtRequest request, } /// - /// Search a vector tile.
Searches a vector tile for geospatial values. + /// + /// Search a vector tile. + /// Searches a vector tile for geospatial values. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SearchMvtAsync(SearchMvtRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3120,7 +3941,10 @@ public virtual Task SearchMvtAsync(SearchMvtReques } /// - /// Search a vector tile.
Searches a vector tile for geospatial values. + /// + /// Search a vector tile. + /// Searches a vector tile for geospatial values. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SearchMvtAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Elastic.Clients.Elasticsearch.Serverless.Field field, int zoom, int x, int y, CancellationToken cancellationToken = default) @@ -3131,7 +3955,10 @@ public virtual Task SearchMvtAsync(Elastic.Clients } /// - /// Search a vector tile.
Searches a vector tile for geospatial values. + /// + /// Search a vector tile. + /// Searches a vector tile for geospatial values. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SearchMvtAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Elastic.Clients.Elasticsearch.Serverless.Field field, int zoom, int x, int y, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3143,7 +3970,10 @@ public virtual Task SearchMvtAsync(Elastic.Clients } /// - /// Search a vector tile.
Searches a vector tile for geospatial values. + /// + /// Search a vector tile. + /// Searches a vector tile for geospatial values. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SearchMvtAsync(Elastic.Clients.Elasticsearch.Serverless.Field field, int zoom, int x, int y, CancellationToken cancellationToken = default) @@ -3154,7 +3984,10 @@ public virtual Task SearchMvtAsync(Elastic.Clients } /// - /// Search a vector tile.
Searches a vector tile for geospatial values. + /// + /// Search a vector tile. + /// Searches a vector tile for geospatial values. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SearchMvtAsync(Elastic.Clients.Elasticsearch.Serverless.Field field, int zoom, int x, int y, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3166,7 +3999,10 @@ public virtual Task SearchMvtAsync(Elastic.Clients } /// - /// Search a vector tile.
Searches a vector tile for geospatial values. + /// + /// Search a vector tile. + /// Searches a vector tile for geospatial values. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SearchMvtAsync(SearchMvtRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3176,7 +4012,10 @@ public virtual Task SearchMvtAsync(SearchMvtRequestDescriptor } /// - /// Search a vector tile.
Searches a vector tile for geospatial values. + /// + /// Search a vector tile. + /// Searches a vector tile for geospatial values. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SearchMvtAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Elastic.Clients.Elasticsearch.Serverless.Field field, int zoom, int x, int y, CancellationToken cancellationToken = default) @@ -3187,7 +4026,10 @@ public virtual Task SearchMvtAsync(Elastic.Clients.Elasticsea } /// - /// Search a vector tile.
Searches a vector tile for geospatial values. + /// + /// Search a vector tile. + /// Searches a vector tile for geospatial values. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SearchMvtAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Elastic.Clients.Elasticsearch.Serverless.Field field, int zoom, int x, int y, Action configureRequest, CancellationToken cancellationToken = default) @@ -3199,7 +4041,9 @@ public virtual Task SearchMvtAsync(Elastic.Clients.Elasticsea } /// - /// Runs a search with a search template. + /// + /// Runs a search with a search template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchTemplateAsync(SearchTemplateRequest request, CancellationToken cancellationToken = default) @@ -3209,7 +4053,9 @@ public virtual Task> SearchTemplateAsync - /// Runs a search with a search template. + /// + /// Runs a search with a search template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchTemplateAsync(SearchTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3219,7 +4065,9 @@ public virtual Task> SearchTemplateAsync - /// Runs a search with a search template. + /// + /// Runs a search with a search template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) @@ -3230,7 +4078,9 @@ public virtual Task> SearchTemplateAsync - /// Runs a search with a search template. + /// + /// Runs a search with a search template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3242,7 +4092,9 @@ public virtual Task> SearchTemplateAsync - /// Runs a search with a search template. + /// + /// Runs a search with a search template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchTemplateAsync(CancellationToken cancellationToken = default) @@ -3253,7 +4105,9 @@ public virtual Task> SearchTemplateAsync - /// Runs a search with a search template. + /// + /// Runs a search with a search template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchTemplateAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -3265,7 +4119,9 @@ public virtual Task> SearchTemplateAsync - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermsEnumAsync(TermsEnumRequest request, CancellationToken cancellationToken = default) @@ -3275,7 +4131,9 @@ public virtual Task TermsEnumAsync(TermsEnumRequest request, } /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermsEnumAsync(TermsEnumRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3285,7 +4143,9 @@ public virtual Task TermsEnumAsync(TermsEnumReques } /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermsEnumAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, CancellationToken cancellationToken = default) @@ -3296,7 +4156,9 @@ public virtual Task TermsEnumAsync(Elastic.Clients } /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermsEnumAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3308,7 +4170,9 @@ public virtual Task TermsEnumAsync(Elastic.Clients } /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermsEnumAsync(CancellationToken cancellationToken = default) @@ -3319,7 +4183,9 @@ public virtual Task TermsEnumAsync(CancellationTok } /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermsEnumAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -3331,7 +4197,9 @@ public virtual Task TermsEnumAsync(Action - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermsEnumAsync(TermsEnumRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3341,7 +4209,9 @@ public virtual Task TermsEnumAsync(TermsEnumRequestDescriptor } /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermsEnumAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, CancellationToken cancellationToken = default) @@ -3352,7 +4222,9 @@ public virtual Task TermsEnumAsync(Elastic.Clients.Elasticsea } /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermsEnumAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, Action configureRequest, CancellationToken cancellationToken = default) @@ -3364,7 +4236,10 @@ public virtual Task TermsEnumAsync(Elastic.Clients.Elasticsea } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermvectorsAsync(TermVectorsRequest request, CancellationToken cancellationToken = default) @@ -3374,7 +4249,10 @@ public virtual Task TermvectorsAsync(TermVectors } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermvectorsAsync(TermVectorsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3384,7 +4262,10 @@ public virtual Task TermvectorsAsync(TermVectors } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermvectorsAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, Elastic.Clients.Elasticsearch.Serverless.Id? id, CancellationToken cancellationToken = default) @@ -3395,7 +4276,10 @@ public virtual Task TermvectorsAsync(Elastic.Cli } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermvectorsAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, Elastic.Clients.Elasticsearch.Serverless.Id? id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3407,7 +4291,10 @@ public virtual Task TermvectorsAsync(Elastic.Cli } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermvectorsAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, CancellationToken cancellationToken = default) @@ -3418,7 +4305,10 @@ public virtual Task TermvectorsAsync(Elastic.Cli } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermvectorsAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3430,7 +4320,10 @@ public virtual Task TermvectorsAsync(Elastic.Cli } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermvectorsAsync(TDocument document, CancellationToken cancellationToken = default) @@ -3441,7 +4334,10 @@ public virtual Task TermvectorsAsync(TDocument d } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermvectorsAsync(TDocument document, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3453,7 +4349,10 @@ public virtual Task TermvectorsAsync(TDocument d } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermvectorsAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.IndexName index, CancellationToken cancellationToken = default) @@ -3464,7 +4363,10 @@ public virtual Task TermvectorsAsync(TDocument d } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermvectorsAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3476,7 +4378,10 @@ public virtual Task TermvectorsAsync(TDocument d } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermvectorsAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.Id? id, CancellationToken cancellationToken = default) @@ -3487,7 +4392,10 @@ public virtual Task TermvectorsAsync(TDocument d } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermvectorsAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.Id? id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3499,7 +4407,10 @@ public virtual Task TermvectorsAsync(TDocument d } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermvectorsAsync(Elastic.Clients.Elasticsearch.Serverless.Id? id, CancellationToken cancellationToken = default) @@ -3510,7 +4421,10 @@ public virtual Task TermvectorsAsync(Elastic.Cli } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermvectorsAsync(Elastic.Clients.Elasticsearch.Serverless.Id? id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3522,7 +4436,10 @@ public virtual Task TermvectorsAsync(Elastic.Cli } /// - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> UpdateAsync(UpdateRequest request, CancellationToken cancellationToken = default) @@ -3532,7 +4449,10 @@ public virtual Task> UpdateAsync - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> UpdateAsync(UpdateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3542,7 +4462,10 @@ public virtual Task> UpdateAsync - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> UpdateAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -3553,7 +4476,10 @@ public virtual Task> UpdateAsync - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> UpdateAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName index, Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3565,7 +4491,10 @@ public virtual Task> UpdateAsync - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> UpdateAsync(TDocument document, CancellationToken cancellationToken = default) @@ -3576,7 +4505,10 @@ public virtual Task> UpdateAsync - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> UpdateAsync(TDocument document, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3588,7 +4520,10 @@ public virtual Task> UpdateAsync - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> UpdateAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.IndexName index, CancellationToken cancellationToken = default) @@ -3599,7 +4534,10 @@ public virtual Task> UpdateAsync - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> UpdateAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3611,7 +4549,10 @@ public virtual Task> UpdateAsync - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> UpdateAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -3622,7 +4563,10 @@ public virtual Task> UpdateAsync - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> UpdateAsync(TDocument document, Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3634,7 +4578,10 @@ public virtual Task> UpdateAsync - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> UpdateAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) @@ -3645,7 +4592,10 @@ public virtual Task> UpdateAsync - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> UpdateAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3657,7 +4607,11 @@ public virtual Task> UpdateAsync - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateByQueryAsync(UpdateByQueryRequest request, CancellationToken cancellationToken = default) @@ -3667,7 +4621,11 @@ public virtual Task UpdateByQueryAsync(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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateByQueryAsync(UpdateByQueryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3677,7 +4635,11 @@ public virtual Task UpdateByQueryAsync(UpdateB } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateByQueryAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, CancellationToken cancellationToken = default) @@ -3688,7 +4650,11 @@ public virtual Task UpdateByQueryAsync(Elastic } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateByQueryAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3700,7 +4666,11 @@ public virtual Task UpdateByQueryAsync(Elastic } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateByQueryAsync(CancellationToken cancellationToken = default) @@ -3711,7 +4681,11 @@ public virtual Task UpdateByQueryAsync(Cancell } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateByQueryAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -3723,7 +4697,11 @@ public virtual Task UpdateByQueryAsync(Action< } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateByQueryAsync(UpdateByQueryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3733,7 +4711,11 @@ public virtual Task UpdateByQueryAsync(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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateByQueryAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, CancellationToken cancellationToken = default) @@ -3744,7 +4726,11 @@ public virtual Task UpdateByQueryAsync(Elastic.Clients.El } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateByQueryAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -3756,7 +4742,9 @@ public virtual Task UpdateByQueryAsync(Elastic.Clients.El } /// - /// Changes the number of requests per second for a particular Update By Query operation. + /// + /// Changes the number of requests per second for a particular Update By Query operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateByQueryRethrottleAsync(UpdateByQueryRethrottleRequest request, CancellationToken cancellationToken = default) @@ -3766,7 +4754,9 @@ public virtual Task UpdateByQueryRethrottleAsyn } /// - /// Changes the number of requests per second for a particular Update By Query operation. + /// + /// Changes the number of requests per second for a particular Update By Query operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateByQueryRethrottleAsync(UpdateByQueryRethrottleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3776,7 +4766,9 @@ public virtual Task UpdateByQueryRethrottleAsyn } /// - /// Changes the number of requests per second for a particular Update By Query operation. + /// + /// Changes the number of requests per second for a particular Update By Query operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateByQueryRethrottleAsync(Elastic.Clients.Elasticsearch.Serverless.Id taskId, CancellationToken cancellationToken = default) @@ -3787,7 +4779,9 @@ public virtual Task UpdateByQueryRethrottleAsyn } /// - /// Changes the number of requests per second for a particular Update By Query operation. + /// + /// Changes the number of requests per second for a particular Update By Query operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateByQueryRethrottleAsync(Elastic.Clients.Elasticsearch.Serverless.Id taskId, Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/AdjacencyMatrixAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/AdjacencyMatrixAggregation.g.cs index 358c99afac9..86e616fbddc 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/AdjacencyMatrixAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/AdjacencyMatrixAggregation.g.cs @@ -30,13 +30,18 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class AdjacencyMatrixAggregation { /// - /// Filters used to create buckets.
At least one filter is required. + /// + /// Filters used to create buckets. + /// At least one filter is required. + /// /// [JsonInclude, JsonPropertyName("filters")] public IDictionary? Filters { get; set; } /// - /// Separator used to concatenate filter names. Defaults to &. + /// + /// Separator used to concatenate filter names. Defaults to &. + /// /// [JsonInclude, JsonPropertyName("separator")] public string? Separator { get; set; } @@ -56,7 +61,10 @@ public AdjacencyMatrixAggregationDescriptor() : base() private string? SeparatorValue { get; set; } /// - /// Filters used to create buckets.
At least one filter is required. + /// + /// Filters used to create buckets. + /// At least one filter is required. + /// /// public AdjacencyMatrixAggregationDescriptor Filters(Func>, FluentDescriptorDictionary>> selector) { @@ -65,7 +73,9 @@ public AdjacencyMatrixAggregationDescriptor Filters(Func - /// Separator used to concatenate filter names. Defaults to &. + /// + /// Separator used to concatenate filter names. Defaults to &. + /// /// public AdjacencyMatrixAggregationDescriptor Separator(string? separator) { @@ -104,7 +114,10 @@ public AdjacencyMatrixAggregationDescriptor() : base() private string? SeparatorValue { get; set; } /// - /// Filters used to create buckets.
At least one filter is required. + /// + /// Filters used to create buckets. + /// At least one filter is required. + /// /// public AdjacencyMatrixAggregationDescriptor Filters(Func, FluentDescriptorDictionary> selector) { @@ -113,7 +126,9 @@ public AdjacencyMatrixAggregationDescriptor Filters(Func - /// Separator used to concatenate filter names. Defaults to &. + /// + /// Separator used to concatenate filter names. Defaults to &. + /// /// public AdjacencyMatrixAggregationDescriptor Separator(string? separator) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/AdjacencyMatrixBucket.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/AdjacencyMatrixBucket.g.cs index 8a853bd57b0..21d617735bd 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/AdjacencyMatrixBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/AdjacencyMatrixBucket.g.cs @@ -77,7 +77,9 @@ public override void Write(Utf8JsonWriter writer, AdjacencyMatrixBucket value, J public sealed partial class AdjacencyMatrixBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/Aggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/Aggregation.g.cs index 236347389e2..9e2e2f1a0fb 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/Aggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/Aggregation.g.cs @@ -120,7 +120,10 @@ internal Aggregation(string variantName, object variant) public static Aggregation WeightedAvg(Elastic.Clients.Elasticsearch.Serverless.Aggregations.WeightedAverageAggregation weightedAverageAggregation) => new Aggregation("weighted_avg", weightedAverageAggregation); /// - /// Sub-aggregations for this aggregation.
Only applies to bucket aggregations. + /// + /// Sub-aggregations for this aggregation. + /// Only applies to bucket aggregations. + /// /// [JsonInclude, JsonPropertyName("aggregations")] public IDictionary? Aggregations { get; set; } @@ -970,7 +973,10 @@ private AggregationDescriptor Set(object variant, string variantName) private IDictionary? MetaValue { get; set; } /// - /// Sub-aggregations for this aggregation.
Only applies to bucket aggregations. + /// + /// Sub-aggregations for this aggregation. + /// Only applies to bucket aggregations. + /// /// public AggregationDescriptor Aggregations(Func>, FluentDescriptorDictionary>> selector) { @@ -1196,7 +1202,10 @@ private AggregationDescriptor Set(object variant, string variantName) private IDictionary? MetaValue { get; set; } /// - /// Sub-aggregations for this aggregation.
Only applies to bucket aggregations. + /// + /// Sub-aggregations for this aggregation. + /// Only applies to bucket aggregations. + /// /// public AggregationDescriptor Aggregations(Func, FluentDescriptorDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/AggregationRange.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/AggregationRange.g.cs index ce9601dcbaa..34c3c4015eb 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/AggregationRange.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/AggregationRange.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class AggregationRange { /// - /// Start of the range (inclusive). + /// + /// Start of the range (inclusive). + /// /// [JsonInclude, JsonPropertyName("from")] public double? From { get; set; } /// - /// Custom key to return the range with. + /// + /// Custom key to return the range with. + /// /// [JsonInclude, JsonPropertyName("key")] public string? Key { get; set; } /// - /// End of the range (exclusive). + /// + /// End of the range (exclusive). + /// /// [JsonInclude, JsonPropertyName("to")] public double? To { get; set; } @@ -61,7 +67,9 @@ public AggregationRangeDescriptor() : base() private double? ToValue { get; set; } /// - /// Start of the range (inclusive). + /// + /// Start of the range (inclusive). + /// /// public AggregationRangeDescriptor From(double? from) { @@ -70,7 +78,9 @@ public AggregationRangeDescriptor From(double? from) } /// - /// Custom key to return the range with. + /// + /// Custom key to return the range with. + /// /// public AggregationRangeDescriptor Key(string? key) { @@ -79,7 +89,9 @@ public AggregationRangeDescriptor Key(string? key) } /// - /// End of the range (exclusive). + /// + /// End of the range (exclusive). + /// /// public AggregationRangeDescriptor To(double? to) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/AutoDateHistogramAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/AutoDateHistogramAggregation.g.cs index 8feb30d35ab..a2f98a53ca0 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/AutoDateHistogramAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/AutoDateHistogramAggregation.g.cs @@ -30,37 +30,52 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class AutoDateHistogramAggregation { /// - /// The target number of buckets. + /// + /// The target number of buckets. + /// /// [JsonInclude, JsonPropertyName("buckets")] public int? Buckets { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } /// - /// The date format used to format `key_as_string` in the response.
If no `format` is specified, the first date format specified in the field mapping is used. + /// + /// The date format used to format key_as_string in the response. + /// If no format is specified, the first date format specified in the field mapping is used. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// The minimum rounding interval.
This can make the collection process more efficient, as the aggregation will not attempt to round at any interval lower than `minimum_interval`. + /// + /// The minimum rounding interval. + /// This can make the collection process more efficient, as the aggregation will not attempt to round at any interval lower than minimum_interval. + /// /// [JsonInclude, JsonPropertyName("minimum_interval")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.MinimumInterval? MinimumInterval { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public DateTimeOffset? Missing { get; set; } /// - /// Time zone specified as a ISO 8601 UTC offset. + /// + /// Time zone specified as a ISO 8601 UTC offset. + /// /// [JsonInclude, JsonPropertyName("offset")] public string? Offset { get; set; } @@ -70,7 +85,9 @@ public sealed partial class AutoDateHistogramAggregation public Elastic.Clients.Elasticsearch.Serverless.Script? Script { get; set; } /// - /// Time zone ID. + /// + /// Time zone ID. + /// /// [JsonInclude, JsonPropertyName("time_zone")] public string? TimeZone { get; set; } @@ -99,7 +116,9 @@ public AutoDateHistogramAggregationDescriptor() : base() private string? TimeZoneValue { get; set; } /// - /// The target number of buckets. + /// + /// The target number of buckets. + /// /// public AutoDateHistogramAggregationDescriptor Buckets(int? buckets) { @@ -108,7 +127,9 @@ public AutoDateHistogramAggregationDescriptor Buckets(int? buckets) } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public AutoDateHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -117,7 +138,9 @@ public AutoDateHistogramAggregationDescriptor Field(Elastic.Clients.E } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public AutoDateHistogramAggregationDescriptor Field(Expression> field) { @@ -126,7 +149,9 @@ public AutoDateHistogramAggregationDescriptor Field(Expressio } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public AutoDateHistogramAggregationDescriptor Field(Expression> field) { @@ -135,7 +160,10 @@ public AutoDateHistogramAggregationDescriptor Field(Expression - /// The date format used to format `key_as_string` in the response.
If no `format` is specified, the first date format specified in the field mapping is used. + /// + /// The date format used to format key_as_string in the response. + /// If no format is specified, the first date format specified in the field mapping is used. + /// /// public AutoDateHistogramAggregationDescriptor Format(string? format) { @@ -144,7 +172,10 @@ public AutoDateHistogramAggregationDescriptor Format(string? format) } /// - /// The minimum rounding interval.
This can make the collection process more efficient, as the aggregation will not attempt to round at any interval lower than `minimum_interval`. + /// + /// The minimum rounding interval. + /// This can make the collection process more efficient, as the aggregation will not attempt to round at any interval lower than minimum_interval. + /// /// public AutoDateHistogramAggregationDescriptor MinimumInterval(Elastic.Clients.Elasticsearch.Serverless.Aggregations.MinimumInterval? minimumInterval) { @@ -153,7 +184,10 @@ public AutoDateHistogramAggregationDescriptor MinimumInterval(Elastic } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public AutoDateHistogramAggregationDescriptor Missing(DateTimeOffset? missing) { @@ -162,7 +196,9 @@ public AutoDateHistogramAggregationDescriptor Missing(DateTimeOffset? } /// - /// Time zone specified as a ISO 8601 UTC offset. + /// + /// Time zone specified as a ISO 8601 UTC offset. + /// /// public AutoDateHistogramAggregationDescriptor Offset(string? offset) { @@ -201,7 +237,9 @@ public AutoDateHistogramAggregationDescriptor Script(Action - /// Time zone ID. + /// + /// Time zone ID. + /// /// public AutoDateHistogramAggregationDescriptor TimeZone(string? timeZone) { @@ -301,7 +339,9 @@ public AutoDateHistogramAggregationDescriptor() : base() private string? TimeZoneValue { get; set; } /// - /// The target number of buckets. + /// + /// The target number of buckets. + /// /// public AutoDateHistogramAggregationDescriptor Buckets(int? buckets) { @@ -310,7 +350,9 @@ public AutoDateHistogramAggregationDescriptor Buckets(int? buckets) } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public AutoDateHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -319,7 +361,9 @@ public AutoDateHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearc } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public AutoDateHistogramAggregationDescriptor Field(Expression> field) { @@ -328,7 +372,9 @@ public AutoDateHistogramAggregationDescriptor Field(Expressio } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public AutoDateHistogramAggregationDescriptor Field(Expression> field) { @@ -337,7 +383,10 @@ public AutoDateHistogramAggregationDescriptor Field(Expression - /// The date format used to format `key_as_string` in the response.
If no `format` is specified, the first date format specified in the field mapping is used. + /// + /// The date format used to format key_as_string in the response. + /// If no format is specified, the first date format specified in the field mapping is used. + /// /// public AutoDateHistogramAggregationDescriptor Format(string? format) { @@ -346,7 +395,10 @@ public AutoDateHistogramAggregationDescriptor Format(string? format) } /// - /// The minimum rounding interval.
This can make the collection process more efficient, as the aggregation will not attempt to round at any interval lower than `minimum_interval`. + /// + /// The minimum rounding interval. + /// This can make the collection process more efficient, as the aggregation will not attempt to round at any interval lower than minimum_interval. + /// /// public AutoDateHistogramAggregationDescriptor MinimumInterval(Elastic.Clients.Elasticsearch.Serverless.Aggregations.MinimumInterval? minimumInterval) { @@ -355,7 +407,10 @@ public AutoDateHistogramAggregationDescriptor MinimumInterval(Elastic.Clients.El } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public AutoDateHistogramAggregationDescriptor Missing(DateTimeOffset? missing) { @@ -364,7 +419,9 @@ public AutoDateHistogramAggregationDescriptor Missing(DateTimeOffset? missing) } /// - /// Time zone specified as a ISO 8601 UTC offset. + /// + /// Time zone specified as a ISO 8601 UTC offset. + /// /// public AutoDateHistogramAggregationDescriptor Offset(string? offset) { @@ -403,7 +460,9 @@ public AutoDateHistogramAggregationDescriptor Script(Action - /// Time zone ID. + /// + /// Time zone ID. + /// /// public AutoDateHistogramAggregationDescriptor TimeZone(string? timeZone) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/AverageAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/AverageAggregate.g.cs index cf27f832307..c583ff496b8 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/AverageAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/AverageAggregate.g.cs @@ -33,7 +33,10 @@ public sealed partial class AverageAggregate : IAggregate public IReadOnlyDictionary? Meta { get; init; } /// - /// The metric value. A missing value generally means that there was no data to aggregate,
unless specified otherwise. + /// + /// The metric value. A missing value generally means that there was no data to aggregate, + /// unless specified otherwise. + /// /// [JsonInclude, JsonPropertyName("value")] public double? Value { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/AverageAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/AverageAggregation.g.cs index fa6785cbcb3..8bb99fed5ce 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/AverageAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/AverageAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class AverageAggregation { /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } @@ -38,7 +40,10 @@ public sealed partial class AverageAggregation public string? Format { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.Serverless.FieldValue? Missing { get; set; } @@ -64,7 +69,9 @@ public AverageAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public AverageAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -73,7 +80,9 @@ public AverageAggregationDescriptor Field(Elastic.Clients.Elasticsear } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public AverageAggregationDescriptor Field(Expression> field) { @@ -82,7 +91,9 @@ public AverageAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public AverageAggregationDescriptor Field(Expression> field) { @@ -97,7 +108,10 @@ public AverageAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public AverageAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -186,7 +200,9 @@ public AverageAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public AverageAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -195,7 +211,9 @@ public AverageAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverle } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public AverageAggregationDescriptor Field(Expression> field) { @@ -204,7 +222,9 @@ public AverageAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public AverageAggregationDescriptor Field(Expression> field) { @@ -219,7 +239,10 @@ public AverageAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public AverageAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/AverageBucketAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/AverageBucketAggregation.g.cs index a9c6154d883..09fce4611a2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/AverageBucketAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/AverageBucketAggregation.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class AverageBucketAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? GapPolicy { get; set; } @@ -63,7 +70,9 @@ public AverageBucketAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? GapPolicyValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public AverageBucketAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? bucketsPath) { @@ -72,7 +81,10 @@ public AverageBucketAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsea } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public AverageBucketAggregationDescriptor Format(string? format) { @@ -81,7 +93,9 @@ public AverageBucketAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public AverageBucketAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? gapPolicy) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/BoxplotAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/BoxplotAggregation.g.cs index 8f738d262e2..3b6483459f7 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/BoxplotAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/BoxplotAggregation.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class BoxplotAggregation { /// - /// Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. + /// + /// Limits the maximum number of nodes used by the underlying TDigest algorithm to 20 * compression, enabling control of memory usage and approximation error. + /// /// [JsonInclude, JsonPropertyName("compression")] public double? Compression { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.Serverless.FieldValue? Missing { get; set; } @@ -68,7 +75,9 @@ public BoxplotAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. + /// + /// Limits the maximum number of nodes used by the underlying TDigest algorithm to 20 * compression, enabling control of memory usage and approximation error. + /// /// public BoxplotAggregationDescriptor Compression(double? compression) { @@ -77,7 +86,9 @@ public BoxplotAggregationDescriptor Compression(double? compression) } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public BoxplotAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -86,7 +97,9 @@ public BoxplotAggregationDescriptor Field(Elastic.Clients.Elasticsear } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public BoxplotAggregationDescriptor Field(Expression> field) { @@ -95,7 +108,9 @@ public BoxplotAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public BoxplotAggregationDescriptor Field(Expression> field) { @@ -104,7 +119,10 @@ public BoxplotAggregationDescriptor Field(Expression - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public BoxplotAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -193,7 +211,9 @@ public BoxplotAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. + /// + /// Limits the maximum number of nodes used by the underlying TDigest algorithm to 20 * compression, enabling control of memory usage and approximation error. + /// /// public BoxplotAggregationDescriptor Compression(double? compression) { @@ -202,7 +222,9 @@ public BoxplotAggregationDescriptor Compression(double? compression) } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public BoxplotAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -211,7 +233,9 @@ public BoxplotAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverle } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public BoxplotAggregationDescriptor Field(Expression> field) { @@ -220,7 +244,9 @@ public BoxplotAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public BoxplotAggregationDescriptor Field(Expression> field) { @@ -229,7 +255,10 @@ public BoxplotAggregationDescriptor Field(Expression - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public BoxplotAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/BucketMetricValueAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/BucketMetricValueAggregate.g.cs index 7e3aeb72401..4929e00d636 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/BucketMetricValueAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/BucketMetricValueAggregate.g.cs @@ -35,7 +35,10 @@ public sealed partial class BucketMetricValueAggregate : IAggregate public IReadOnlyDictionary? Meta { get; init; } /// - /// The metric value. A missing value generally means that there was no data to aggregate,
unless specified otherwise. + /// + /// The metric value. A missing value generally means that there was no data to aggregate, + /// unless specified otherwise. + /// /// [JsonInclude, JsonPropertyName("value")] public double? Value { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/BucketScriptAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/BucketScriptAggregation.g.cs index 3174de7ee9d..46a0e964fef 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/BucketScriptAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/BucketScriptAggregation.g.cs @@ -30,25 +30,34 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class BucketScriptAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? GapPolicy { get; set; } /// - /// The script to run for this aggregation. + /// + /// The script to run for this aggregation. + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Serverless.Script? Script { get; set; } @@ -72,7 +81,9 @@ public BucketScriptAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public BucketScriptAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? bucketsPath) { @@ -81,7 +92,10 @@ public BucketScriptAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsear } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public BucketScriptAggregationDescriptor Format(string? format) { @@ -90,7 +104,9 @@ public BucketScriptAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public BucketScriptAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? gapPolicy) { @@ -99,7 +115,9 @@ public BucketScriptAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch } /// - /// The script to run for this aggregation. + /// + /// The script to run for this aggregation. + /// /// public BucketScriptAggregationDescriptor Script(Elastic.Clients.Elasticsearch.Serverless.Script? script) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/BucketSelectorAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/BucketSelectorAggregation.g.cs index bbd0c4cd262..debc2ea2a74 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/BucketSelectorAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/BucketSelectorAggregation.g.cs @@ -30,25 +30,34 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class BucketSelectorAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? GapPolicy { get; set; } /// - /// The script to run for this aggregation. + /// + /// The script to run for this aggregation. + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Serverless.Script? Script { get; set; } @@ -72,7 +81,9 @@ public BucketSelectorAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public BucketSelectorAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? bucketsPath) { @@ -81,7 +92,10 @@ public BucketSelectorAggregationDescriptor BucketsPath(Elastic.Clients.Elasticse } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public BucketSelectorAggregationDescriptor Format(string? format) { @@ -90,7 +104,9 @@ public BucketSelectorAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public BucketSelectorAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? gapPolicy) { @@ -99,7 +115,9 @@ public BucketSelectorAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsear } /// - /// The script to run for this aggregation. + /// + /// The script to run for this aggregation. + /// /// public BucketSelectorAggregationDescriptor Script(Elastic.Clients.Elasticsearch.Serverless.Script? script) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/BucketSortAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/BucketSortAggregation.g.cs index d516fbb3beb..93e5a1a5b67 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/BucketSortAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/BucketSortAggregation.g.cs @@ -30,25 +30,34 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class BucketSortAggregation { /// - /// Buckets in positions prior to `from` will be truncated. + /// + /// Buckets in positions prior to from will be truncated. + /// /// [JsonInclude, JsonPropertyName("from")] public int? From { get; set; } /// - /// The policy to apply when gaps are found in the data. + /// + /// The policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? GapPolicy { get; set; } /// - /// The number of buckets to return.
Defaults to all buckets of the parent aggregation. + /// + /// The number of buckets to return. + /// Defaults to all buckets of the parent aggregation. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// The list of fields to sort on. + /// + /// The list of fields to sort on. + /// /// [JsonInclude, JsonPropertyName("sort")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.SortOptions))] @@ -74,7 +83,9 @@ public BucketSortAggregationDescriptor() : base() private Action>[] SortDescriptorActions { get; set; } /// - /// Buckets in positions prior to `from` will be truncated. + /// + /// Buckets in positions prior to from will be truncated. + /// /// public BucketSortAggregationDescriptor From(int? from) { @@ -83,7 +94,9 @@ public BucketSortAggregationDescriptor From(int? from) } /// - /// The policy to apply when gaps are found in the data. + /// + /// The policy to apply when gaps are found in the data. + /// /// public BucketSortAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? gapPolicy) { @@ -92,7 +105,10 @@ public BucketSortAggregationDescriptor GapPolicy(Elastic.Clients.Elas } /// - /// The number of buckets to return.
Defaults to all buckets of the parent aggregation. + /// + /// The number of buckets to return. + /// Defaults to all buckets of the parent aggregation. + /// /// public BucketSortAggregationDescriptor Size(int? size) { @@ -101,7 +117,9 @@ public BucketSortAggregationDescriptor Size(int? size) } /// - /// The list of fields to sort on. + /// + /// The list of fields to sort on. + /// /// public BucketSortAggregationDescriptor Sort(ICollection? sort) { @@ -210,7 +228,9 @@ public BucketSortAggregationDescriptor() : base() private Action[] SortDescriptorActions { get; set; } /// - /// Buckets in positions prior to `from` will be truncated. + /// + /// Buckets in positions prior to from will be truncated. + /// /// public BucketSortAggregationDescriptor From(int? from) { @@ -219,7 +239,9 @@ public BucketSortAggregationDescriptor From(int? from) } /// - /// The policy to apply when gaps are found in the data. + /// + /// The policy to apply when gaps are found in the data. + /// /// public BucketSortAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? gapPolicy) { @@ -228,7 +250,10 @@ public BucketSortAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.S } /// - /// The number of buckets to return.
Defaults to all buckets of the parent aggregation. + /// + /// The number of buckets to return. + /// Defaults to all buckets of the parent aggregation. + /// /// public BucketSortAggregationDescriptor Size(int? size) { @@ -237,7 +262,9 @@ public BucketSortAggregationDescriptor Size(int? size) } /// - /// The list of fields to sort on. + /// + /// The list of fields to sort on. + /// /// public BucketSortAggregationDescriptor Sort(ICollection? sort) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/Buckets.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/Buckets.g.cs index 1600e36ac53..8bc046aac83 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/Buckets.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/Buckets.g.cs @@ -31,7 +31,10 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; /// -/// Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for
the different buckets, the result is a dictionary. +/// +/// Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for +/// the different buckets, the result is a dictionary. +/// /// public sealed partial class Buckets : Union, IReadOnlyCollection> { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CardinalityAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CardinalityAggregation.g.cs index dd5f17b3279..1ac44390f6f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CardinalityAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CardinalityAggregation.g.cs @@ -30,25 +30,35 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class CardinalityAggregation { /// - /// Mechanism by which cardinality aggregations is run. + /// + /// Mechanism by which cardinality aggregations is run. + /// /// [JsonInclude, JsonPropertyName("execution_hint")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.CardinalityExecutionMode? ExecutionHint { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.Serverless.FieldValue? Missing { get; set; } /// - /// A unique count below which counts are expected to be close to accurate.
This allows to trade memory for accuracy. + /// + /// A unique count below which counts are expected to be close to accurate. + /// This allows to trade memory for accuracy. + /// /// [JsonInclude, JsonPropertyName("precision_threshold")] public int? PrecisionThreshold { get; set; } @@ -78,7 +88,9 @@ public CardinalityAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// Mechanism by which cardinality aggregations is run. + /// + /// Mechanism by which cardinality aggregations is run. + /// /// public CardinalityAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsearch.Serverless.Aggregations.CardinalityExecutionMode? executionHint) { @@ -87,7 +99,9 @@ public CardinalityAggregationDescriptor ExecutionHint(Elastic.Clients } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public CardinalityAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -96,7 +110,9 @@ public CardinalityAggregationDescriptor Field(Elastic.Clients.Elastic } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public CardinalityAggregationDescriptor Field(Expression> field) { @@ -105,7 +121,9 @@ public CardinalityAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public CardinalityAggregationDescriptor Field(Expression> field) { @@ -114,7 +132,10 @@ public CardinalityAggregationDescriptor Field(Expression - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public CardinalityAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -123,7 +144,10 @@ public CardinalityAggregationDescriptor Missing(Elastic.Clients.Elast } /// - /// A unique count below which counts are expected to be close to accurate.
This allows to trade memory for accuracy. + /// + /// A unique count below which counts are expected to be close to accurate. + /// This allows to trade memory for accuracy. + /// /// public CardinalityAggregationDescriptor PrecisionThreshold(int? precisionThreshold) { @@ -232,7 +256,9 @@ public CardinalityAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// Mechanism by which cardinality aggregations is run. + /// + /// Mechanism by which cardinality aggregations is run. + /// /// public CardinalityAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsearch.Serverless.Aggregations.CardinalityExecutionMode? executionHint) { @@ -241,7 +267,9 @@ public CardinalityAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsea } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public CardinalityAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -250,7 +278,9 @@ public CardinalityAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serv } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public CardinalityAggregationDescriptor Field(Expression> field) { @@ -259,7 +289,9 @@ public CardinalityAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public CardinalityAggregationDescriptor Field(Expression> field) { @@ -268,7 +300,10 @@ public CardinalityAggregationDescriptor Field(Expression - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public CardinalityAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -277,7 +312,10 @@ public CardinalityAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Se } /// - /// A unique count below which counts are expected to be close to accurate.
This allows to trade memory for accuracy. + /// + /// A unique count below which counts are expected to be close to accurate. + /// This allows to trade memory for accuracy. + /// /// public CardinalityAggregationDescriptor PrecisionThreshold(int? precisionThreshold) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ChiSquareHeuristic.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ChiSquareHeuristic.g.cs index 55c0bada3fb..c1a258dbf75 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ChiSquareHeuristic.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ChiSquareHeuristic.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class ChiSquareHeuristic { /// - /// Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. + /// + /// Set to false if you defined a custom background filter that represents a different set of documents that you want to compare to. + /// /// [JsonInclude, JsonPropertyName("background_is_superset")] public bool BackgroundIsSuperset { get; set; } /// - /// Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset. + /// + /// Set to false to filter out the terms that appear less often in the subset than in documents outside the subset. + /// /// [JsonInclude, JsonPropertyName("include_negatives")] public bool IncludeNegatives { get; set; } @@ -54,7 +58,9 @@ public ChiSquareHeuristicDescriptor() : base() private bool IncludeNegativesValue { get; set; } /// - /// Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. + /// + /// Set to false if you defined a custom background filter that represents a different set of documents that you want to compare to. + /// /// public ChiSquareHeuristicDescriptor BackgroundIsSuperset(bool backgroundIsSuperset = true) { @@ -63,7 +69,9 @@ public ChiSquareHeuristicDescriptor BackgroundIsSuperset(bool backgroundIsSupers } /// - /// Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset. + /// + /// Set to false to filter out the terms that appear less often in the subset than in documents outside the subset. + /// /// public ChiSquareHeuristicDescriptor IncludeNegatives(bool includeNegatives = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ChildrenAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ChildrenAggregate.g.cs index 7a853ee27a7..cb007f3ba2d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ChildrenAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ChildrenAggregate.g.cs @@ -77,7 +77,9 @@ public override void Write(Utf8JsonWriter writer, ChildrenAggregate value, JsonS public sealed partial class ChildrenAggregate : IAggregate { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ChildrenAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ChildrenAggregation.g.cs index 7840a57fd0d..22c79891b3c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ChildrenAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ChildrenAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class ChildrenAggregation { /// - /// The child type that should be selected. + /// + /// The child type that should be selected. + /// /// [JsonInclude, JsonPropertyName("type")] public string? Type { get; set; } @@ -49,7 +51,9 @@ public ChildrenAggregationDescriptor() : base() private string? TypeValue { get; set; } /// - /// The child type that should be selected. + /// + /// The child type that should be selected. + /// /// public ChildrenAggregationDescriptor Type(string? type) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CompositeAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CompositeAggregation.g.cs index 3fcbc0ec673..472e5be90b4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CompositeAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CompositeAggregation.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class CompositeAggregation { /// - /// When paginating, use the `after_key` value returned in the previous response to retrieve the next page. + /// + /// When paginating, use the after_key value returned in the previous response to retrieve the next page. + /// /// [JsonInclude, JsonPropertyName("after")] public IDictionary? After { get; set; } /// - /// The number of composite buckets that should be returned. + /// + /// The number of composite buckets that should be returned. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// The value sources used to build composite buckets.
Keys are returned in the order of the `sources` definition. + /// + /// The value sources used to build composite buckets. + /// Keys are returned in the order of the sources definition. + /// /// [JsonInclude, JsonPropertyName("sources")] public ICollection>? Sources { get; set; } @@ -63,7 +70,9 @@ public CompositeAggregationDescriptor() : base() private ICollection>? SourcesValue { get; set; } /// - /// When paginating, use the `after_key` value returned in the previous response to retrieve the next page. + /// + /// When paginating, use the after_key value returned in the previous response to retrieve the next page. + /// /// public CompositeAggregationDescriptor After(Func, FluentDictionary> selector) { @@ -72,7 +81,9 @@ public CompositeAggregationDescriptor After(Func - /// The number of composite buckets that should be returned. + /// + /// The number of composite buckets that should be returned. + /// /// public CompositeAggregationDescriptor Size(int? size) { @@ -81,7 +92,10 @@ public CompositeAggregationDescriptor Size(int? size) } /// - /// The value sources used to build composite buckets.
Keys are returned in the order of the `sources` definition. + /// + /// The value sources used to build composite buckets. + /// Keys are returned in the order of the sources definition. + /// /// public CompositeAggregationDescriptor Sources(ICollection>? sources) { @@ -127,7 +141,9 @@ public CompositeAggregationDescriptor() : base() private ICollection>? SourcesValue { get; set; } /// - /// When paginating, use the `after_key` value returned in the previous response to retrieve the next page. + /// + /// When paginating, use the after_key value returned in the previous response to retrieve the next page. + /// /// public CompositeAggregationDescriptor After(Func, FluentDictionary> selector) { @@ -136,7 +152,9 @@ public CompositeAggregationDescriptor After(Func - /// The number of composite buckets that should be returned. + /// + /// The number of composite buckets that should be returned. + /// /// public CompositeAggregationDescriptor Size(int? size) { @@ -145,7 +163,10 @@ public CompositeAggregationDescriptor Size(int? size) } /// - /// The value sources used to build composite buckets.
Keys are returned in the order of the `sources` definition. + /// + /// The value sources used to build composite buckets. + /// Keys are returned in the order of the sources definition. + /// /// public CompositeAggregationDescriptor Sources(ICollection>? sources) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CompositeAggregationSource.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CompositeAggregationSource.g.cs index 913c8300657..8bc2fb2c8be 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CompositeAggregationSource.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CompositeAggregationSource.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class CompositeAggregationSource { /// - /// A date histogram aggregation. + /// + /// A date histogram aggregation. + /// /// [JsonInclude, JsonPropertyName("date_histogram")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.CompositeDateHistogramAggregation? DateHistogram { get; set; } /// - /// A geotile grid aggregation. + /// + /// A geotile grid aggregation. + /// /// [JsonInclude, JsonPropertyName("geotile_grid")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.CompositeGeoTileGridAggregation? GeotileGrid { get; set; } /// - /// A histogram aggregation. + /// + /// A histogram aggregation. + /// /// [JsonInclude, JsonPropertyName("histogram")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.CompositeHistogramAggregation? Histogram { get; set; } /// - /// A terms aggregation. + /// + /// A terms aggregation. + /// /// [JsonInclude, JsonPropertyName("terms")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.CompositeTermsAggregation? Terms { get; set; } @@ -76,7 +84,9 @@ public CompositeAggregationSourceDescriptor() : base() private Action> TermsDescriptorAction { get; set; } /// - /// A date histogram aggregation. + /// + /// A date histogram aggregation. + /// /// public CompositeAggregationSourceDescriptor DateHistogram(Elastic.Clients.Elasticsearch.Serverless.Aggregations.CompositeDateHistogramAggregation? dateHistogram) { @@ -103,7 +113,9 @@ public CompositeAggregationSourceDescriptor DateHistogram(Action - /// A geotile grid aggregation. + /// + /// A geotile grid aggregation. + /// /// public CompositeAggregationSourceDescriptor GeotileGrid(Elastic.Clients.Elasticsearch.Serverless.Aggregations.CompositeGeoTileGridAggregation? geotileGrid) { @@ -130,7 +142,9 @@ public CompositeAggregationSourceDescriptor GeotileGrid(Action - /// A histogram aggregation. + /// + /// A histogram aggregation. + /// /// public CompositeAggregationSourceDescriptor Histogram(Elastic.Clients.Elasticsearch.Serverless.Aggregations.CompositeHistogramAggregation? histogram) { @@ -157,7 +171,9 @@ public CompositeAggregationSourceDescriptor Histogram(Action - /// A terms aggregation. + /// + /// A terms aggregation. + /// /// public CompositeAggregationSourceDescriptor Terms(Elastic.Clients.Elasticsearch.Serverless.Aggregations.CompositeTermsAggregation? terms) { @@ -276,7 +292,9 @@ public CompositeAggregationSourceDescriptor() : base() private Action TermsDescriptorAction { get; set; } /// - /// A date histogram aggregation. + /// + /// A date histogram aggregation. + /// /// public CompositeAggregationSourceDescriptor DateHistogram(Elastic.Clients.Elasticsearch.Serverless.Aggregations.CompositeDateHistogramAggregation? dateHistogram) { @@ -303,7 +321,9 @@ public CompositeAggregationSourceDescriptor DateHistogram(Action - /// A geotile grid aggregation. + /// + /// A geotile grid aggregation. + /// /// public CompositeAggregationSourceDescriptor GeotileGrid(Elastic.Clients.Elasticsearch.Serverless.Aggregations.CompositeGeoTileGridAggregation? geotileGrid) { @@ -330,7 +350,9 @@ public CompositeAggregationSourceDescriptor GeotileGrid(Action - /// A histogram aggregation. + /// + /// A histogram aggregation. + /// /// public CompositeAggregationSourceDescriptor Histogram(Elastic.Clients.Elasticsearch.Serverless.Aggregations.CompositeHistogramAggregation? histogram) { @@ -357,7 +379,9 @@ public CompositeAggregationSourceDescriptor Histogram(Action - /// A terms aggregation. + /// + /// A terms aggregation. + /// /// public CompositeAggregationSourceDescriptor Terms(Elastic.Clients.Elasticsearch.Serverless.Aggregations.CompositeTermsAggregation? terms) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CompositeBucket.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CompositeBucket.g.cs index a2c9e542bc2..22f264dd557 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CompositeBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CompositeBucket.g.cs @@ -77,7 +77,9 @@ public override void Write(Utf8JsonWriter writer, CompositeBucket value, JsonSer public sealed partial class CompositeBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CompositeDateHistogramAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CompositeDateHistogramAggregation.g.cs index 00995f17f70..acc1d465d72 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CompositeDateHistogramAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CompositeDateHistogramAggregation.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class CompositeDateHistogramAggregation { /// - /// Either `calendar_interval` or `fixed_interval` must be present + /// + /// Either calendar_interval or fixed_interval must be present + /// /// [JsonInclude, JsonPropertyName("calendar_interval")] public string? CalendarInterval { get; set; } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } /// - /// Either `calendar_interval` or `fixed_interval` must be present + /// + /// Either calendar_interval or fixed_interval must be present + /// /// [JsonInclude, JsonPropertyName("fixed_interval")] public string? FixedInterval { get; set; } @@ -58,7 +64,9 @@ public sealed partial class CompositeDateHistogramAggregation public Elastic.Clients.Elasticsearch.Serverless.SortOrder? Order { get; set; } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Serverless.Script? Script { get; set; } @@ -91,7 +99,9 @@ public CompositeDateHistogramAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Aggregations.ValueType? ValueTypeValue { get; set; } /// - /// Either `calendar_interval` or `fixed_interval` must be present + /// + /// Either calendar_interval or fixed_interval must be present + /// /// public CompositeDateHistogramAggregationDescriptor CalendarInterval(string? calendarInterval) { @@ -100,7 +110,9 @@ public CompositeDateHistogramAggregationDescriptor CalendarInterval(s } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeDateHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -109,7 +121,9 @@ public CompositeDateHistogramAggregationDescriptor Field(Elastic.Clie } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeDateHistogramAggregationDescriptor Field(Expression> field) { @@ -118,7 +132,9 @@ public CompositeDateHistogramAggregationDescriptor Field(Expr } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeDateHistogramAggregationDescriptor Field(Expression> field) { @@ -127,7 +143,9 @@ public CompositeDateHistogramAggregationDescriptor Field(Expression - /// Either `calendar_interval` or `fixed_interval` must be present + /// + /// Either calendar_interval or fixed_interval must be present + /// /// public CompositeDateHistogramAggregationDescriptor FixedInterval(string? fixedInterval) { @@ -166,7 +184,9 @@ public CompositeDateHistogramAggregationDescriptor Order(Elastic.Clie } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeDateHistogramAggregationDescriptor Script(Elastic.Clients.Elasticsearch.Serverless.Script? script) { @@ -310,7 +330,9 @@ public CompositeDateHistogramAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Aggregations.ValueType? ValueTypeValue { get; set; } /// - /// Either `calendar_interval` or `fixed_interval` must be present + /// + /// Either calendar_interval or fixed_interval must be present + /// /// public CompositeDateHistogramAggregationDescriptor CalendarInterval(string? calendarInterval) { @@ -319,7 +341,9 @@ public CompositeDateHistogramAggregationDescriptor CalendarInterval(string? cale } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeDateHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -328,7 +352,9 @@ public CompositeDateHistogramAggregationDescriptor Field(Elastic.Clients.Elastic } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeDateHistogramAggregationDescriptor Field(Expression> field) { @@ -337,7 +363,9 @@ public CompositeDateHistogramAggregationDescriptor Field(Expr } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeDateHistogramAggregationDescriptor Field(Expression> field) { @@ -346,7 +374,9 @@ public CompositeDateHistogramAggregationDescriptor Field(Expression - /// Either `calendar_interval` or `fixed_interval` must be present + /// + /// Either calendar_interval or fixed_interval must be present + /// /// public CompositeDateHistogramAggregationDescriptor FixedInterval(string? fixedInterval) { @@ -385,7 +415,9 @@ public CompositeDateHistogramAggregationDescriptor Order(Elastic.Clients.Elastic } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeDateHistogramAggregationDescriptor Script(Elastic.Clients.Elasticsearch.Serverless.Script? script) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CompositeGeoTileGridAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CompositeGeoTileGridAggregation.g.cs index ea3e14f1815..db157c512db 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CompositeGeoTileGridAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CompositeGeoTileGridAggregation.g.cs @@ -33,7 +33,9 @@ public sealed partial class CompositeGeoTileGridAggregation public Elastic.Clients.Elasticsearch.Serverless.GeoBounds? Bounds { get; set; } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } @@ -47,7 +49,9 @@ public sealed partial class CompositeGeoTileGridAggregation public int? Precision { get; set; } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Serverless.Script? Script { get; set; } @@ -81,7 +85,9 @@ public CompositeGeoTileGridAggregationDescriptor Bounds(Elastic.Clien } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeGeoTileGridAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -90,7 +96,9 @@ public CompositeGeoTileGridAggregationDescriptor Field(Elastic.Client } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeGeoTileGridAggregationDescriptor Field(Expression> field) { @@ -99,7 +107,9 @@ public CompositeGeoTileGridAggregationDescriptor Field(Expres } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeGeoTileGridAggregationDescriptor Field(Expression> field) { @@ -132,7 +142,9 @@ public CompositeGeoTileGridAggregationDescriptor Precision(int? preci } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeGeoTileGridAggregationDescriptor Script(Elastic.Clients.Elasticsearch.Serverless.Script? script) { @@ -255,7 +267,9 @@ public CompositeGeoTileGridAggregationDescriptor Bounds(Elastic.Clients.Elastics } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeGeoTileGridAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -264,7 +278,9 @@ public CompositeGeoTileGridAggregationDescriptor Field(Elastic.Clients.Elasticse } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeGeoTileGridAggregationDescriptor Field(Expression> field) { @@ -273,7 +289,9 @@ public CompositeGeoTileGridAggregationDescriptor Field(Expres } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeGeoTileGridAggregationDescriptor Field(Expression> field) { @@ -306,7 +324,9 @@ public CompositeGeoTileGridAggregationDescriptor Precision(int? precision) } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeGeoTileGridAggregationDescriptor Script(Elastic.Clients.Elasticsearch.Serverless.Script? script) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CompositeHistogramAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CompositeHistogramAggregation.g.cs index 9a4fa0e5c85..0c450d42260 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CompositeHistogramAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CompositeHistogramAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class CompositeHistogramAggregation { /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } @@ -44,7 +46,9 @@ public sealed partial class CompositeHistogramAggregation public Elastic.Clients.Elasticsearch.Serverless.SortOrder? Order { get; set; } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Serverless.Script? Script { get; set; } @@ -71,7 +75,9 @@ public CompositeHistogramAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Aggregations.ValueType? ValueTypeValue { get; set; } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -80,7 +86,9 @@ public CompositeHistogramAggregationDescriptor Field(Elastic.Clients. } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeHistogramAggregationDescriptor Field(Expression> field) { @@ -89,7 +97,9 @@ public CompositeHistogramAggregationDescriptor Field(Expressi } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeHistogramAggregationDescriptor Field(Expression> field) { @@ -122,7 +132,9 @@ public CompositeHistogramAggregationDescriptor Order(Elastic.Clients. } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeHistogramAggregationDescriptor Script(Elastic.Clients.Elasticsearch.Serverless.Script? script) { @@ -228,7 +240,9 @@ public CompositeHistogramAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Aggregations.ValueType? ValueTypeValue { get; set; } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -237,7 +251,9 @@ public CompositeHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsear } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeHistogramAggregationDescriptor Field(Expression> field) { @@ -246,7 +262,9 @@ public CompositeHistogramAggregationDescriptor Field(Expressi } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeHistogramAggregationDescriptor Field(Expression> field) { @@ -279,7 +297,9 @@ public CompositeHistogramAggregationDescriptor Order(Elastic.Clients.Elasticsear } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeHistogramAggregationDescriptor Script(Elastic.Clients.Elasticsearch.Serverless.Script? script) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CompositeTermsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CompositeTermsAggregation.g.cs index 7842e188b09..2b6256edd6b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CompositeTermsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CompositeTermsAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class CompositeTermsAggregation { /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } @@ -42,7 +44,9 @@ public sealed partial class CompositeTermsAggregation public Elastic.Clients.Elasticsearch.Serverless.SortOrder? Order { get; set; } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Serverless.Script? Script { get; set; } @@ -68,7 +72,9 @@ public CompositeTermsAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Aggregations.ValueType? ValueTypeValue { get; set; } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeTermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -77,7 +83,9 @@ public CompositeTermsAggregationDescriptor Field(Elastic.Clients.Elas } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeTermsAggregationDescriptor Field(Expression> field) { @@ -86,7 +94,9 @@ public CompositeTermsAggregationDescriptor Field(Expression - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeTermsAggregationDescriptor Field(Expression> field) { @@ -113,7 +123,9 @@ public CompositeTermsAggregationDescriptor Order(Elastic.Clients.Elas } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeTermsAggregationDescriptor Script(Elastic.Clients.Elasticsearch.Serverless.Script? script) { @@ -216,7 +228,9 @@ public CompositeTermsAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Aggregations.ValueType? ValueTypeValue { get; set; } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeTermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -225,7 +239,9 @@ public CompositeTermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.S } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeTermsAggregationDescriptor Field(Expression> field) { @@ -234,7 +250,9 @@ public CompositeTermsAggregationDescriptor Field(Expression - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeTermsAggregationDescriptor Field(Expression> field) { @@ -261,7 +279,9 @@ public CompositeTermsAggregationDescriptor Order(Elastic.Clients.Elasticsearch.S } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeTermsAggregationDescriptor Script(Elastic.Clients.Elasticsearch.Serverless.Script? script) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CumulativeCardinalityAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CumulativeCardinalityAggregate.g.cs index cff07a06f50..c0a86ffc1cd 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CumulativeCardinalityAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CumulativeCardinalityAggregate.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; /// -/// Result of the `cumulative_cardinality` aggregation +/// +/// Result of the cumulative_cardinality aggregation +/// /// public sealed partial class CumulativeCardinalityAggregate : IAggregate { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CumulativeCardinalityAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CumulativeCardinalityAggregation.g.cs index d0b15dfcc69..ca1648c65c1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CumulativeCardinalityAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CumulativeCardinalityAggregation.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class CumulativeCardinalityAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? GapPolicy { get; set; } @@ -63,7 +70,9 @@ public CumulativeCardinalityAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? GapPolicyValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public CumulativeCardinalityAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? bucketsPath) { @@ -72,7 +81,10 @@ public CumulativeCardinalityAggregationDescriptor BucketsPath(Elastic.Clients.El } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public CumulativeCardinalityAggregationDescriptor Format(string? format) { @@ -81,7 +93,9 @@ public CumulativeCardinalityAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public CumulativeCardinalityAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? gapPolicy) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CumulativeSumAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CumulativeSumAggregation.g.cs index f29f407c71d..28ea29890ce 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CumulativeSumAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/CumulativeSumAggregation.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class CumulativeSumAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? GapPolicy { get; set; } @@ -63,7 +70,9 @@ public CumulativeSumAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? GapPolicyValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public CumulativeSumAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? bucketsPath) { @@ -72,7 +81,10 @@ public CumulativeSumAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsea } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public CumulativeSumAggregationDescriptor Format(string? format) { @@ -81,7 +93,9 @@ public CumulativeSumAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public CumulativeSumAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? gapPolicy) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DateHistogramAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DateHistogramAggregation.g.cs index 2b9be7e459e..5abfd93f60d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DateHistogramAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DateHistogramAggregation.g.cs @@ -30,61 +30,85 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class DateHistogramAggregation { /// - /// Calendar-aware interval.
Can be specified using the unit name, such as `month`, or as a single unit quantity, such as `1M`. + /// + /// Calendar-aware interval. + /// Can be specified using the unit name, such as month, or as a single unit quantity, such as 1M. + /// /// [JsonInclude, JsonPropertyName("calendar_interval")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.CalendarInterval? CalendarInterval { get; set; } /// - /// Enables extending the bounds of the histogram beyond the data itself. + /// + /// Enables extending the bounds of the histogram beyond the data itself. + /// /// [JsonInclude, JsonPropertyName("extended_bounds")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.ExtendedBoundsDate? ExtendedBounds { get; set; } /// - /// The date field whose values are use to build a histogram. + /// + /// The date field whose values are use to build a histogram. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } /// - /// Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar. + /// + /// Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar. + /// /// [JsonInclude, JsonPropertyName("fixed_interval")] public Elastic.Clients.Elasticsearch.Serverless.Duration? FixedInterval { get; set; } /// - /// The date format used to format `key_as_string` in the response.
If no `format` is specified, the first date format specified in the field mapping is used. + /// + /// The date format used to format key_as_string in the response. + /// If no format is specified, the first date format specified in the field mapping is used. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Limits the histogram to specified bounds. + /// + /// Limits the histogram to specified bounds. + /// /// [JsonInclude, JsonPropertyName("hard_bounds")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.ExtendedBoundsDate? HardBounds { get; set; } /// - /// Only returns buckets that have `min_doc_count` number of documents.
By default, all buckets between the first bucket that matches documents and the last one are returned. + /// + /// Only returns buckets that have min_doc_count number of documents. + /// By default, all buckets between the first bucket that matches documents and the last one are returned. + /// /// [JsonInclude, JsonPropertyName("min_doc_count")] public int? MinDocCount { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public DateTimeOffset? Missing { get; set; } /// - /// Changes the start value of each bucket by the specified positive (`+`) or negative offset (`-`) duration. + /// + /// Changes the start value of each bucket by the specified positive (+) or negative offset (-) duration. + /// /// [JsonInclude, JsonPropertyName("offset")] public Elastic.Clients.Elasticsearch.Serverless.Duration? Offset { get; set; } /// - /// The sort order of the returned buckets. + /// + /// The sort order of the returned buckets. + /// /// [JsonInclude, JsonPropertyName("order")] [SingleOrManyCollectionConverter(typeof(KeyValuePair))] @@ -95,7 +119,10 @@ public sealed partial class DateHistogramAggregation public Elastic.Clients.Elasticsearch.Serverless.Script? Script { get; set; } /// - /// Time zone used for bucketing and rounding.
Defaults to Coordinated Universal Time (UTC). + /// + /// Time zone used for bucketing and rounding. + /// Defaults to Coordinated Universal Time (UTC). + /// /// [JsonInclude, JsonPropertyName("time_zone")] public string? TimeZone { get; set; } @@ -133,7 +160,10 @@ public DateHistogramAggregationDescriptor() : base() private string? TimeZoneValue { get; set; } /// - /// Calendar-aware interval.
Can be specified using the unit name, such as `month`, or as a single unit quantity, such as `1M`. + /// + /// Calendar-aware interval. + /// Can be specified using the unit name, such as month, or as a single unit quantity, such as 1M. + /// /// public DateHistogramAggregationDescriptor CalendarInterval(Elastic.Clients.Elasticsearch.Serverless.Aggregations.CalendarInterval? calendarInterval) { @@ -142,7 +172,9 @@ public DateHistogramAggregationDescriptor CalendarInterval(Elastic.Cl } /// - /// Enables extending the bounds of the histogram beyond the data itself. + /// + /// Enables extending the bounds of the histogram beyond the data itself. + /// /// public DateHistogramAggregationDescriptor ExtendedBounds(Elastic.Clients.Elasticsearch.Serverless.Aggregations.ExtendedBoundsDate? extendedBounds) { @@ -169,7 +201,9 @@ public DateHistogramAggregationDescriptor ExtendedBounds(Action - /// The date field whose values are use to build a histogram. + /// + /// The date field whose values are use to build a histogram. + /// /// public DateHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -178,7 +212,9 @@ public DateHistogramAggregationDescriptor Field(Elastic.Clients.Elast } /// - /// The date field whose values are use to build a histogram. + /// + /// The date field whose values are use to build a histogram. + /// /// public DateHistogramAggregationDescriptor Field(Expression> field) { @@ -187,7 +223,9 @@ public DateHistogramAggregationDescriptor Field(Expression - /// The date field whose values are use to build a histogram. + /// + /// The date field whose values are use to build a histogram. + /// /// public DateHistogramAggregationDescriptor Field(Expression> field) { @@ -196,7 +234,9 @@ public DateHistogramAggregationDescriptor Field(Expression - /// Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar. + /// + /// Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar. + /// /// public DateHistogramAggregationDescriptor FixedInterval(Elastic.Clients.Elasticsearch.Serverless.Duration? fixedInterval) { @@ -205,7 +245,10 @@ public DateHistogramAggregationDescriptor FixedInterval(Elastic.Clien } /// - /// The date format used to format `key_as_string` in the response.
If no `format` is specified, the first date format specified in the field mapping is used. + /// + /// The date format used to format key_as_string in the response. + /// If no format is specified, the first date format specified in the field mapping is used. + /// /// public DateHistogramAggregationDescriptor Format(string? format) { @@ -214,7 +257,9 @@ public DateHistogramAggregationDescriptor Format(string? format) } /// - /// Limits the histogram to specified bounds. + /// + /// Limits the histogram to specified bounds. + /// /// public DateHistogramAggregationDescriptor HardBounds(Elastic.Clients.Elasticsearch.Serverless.Aggregations.ExtendedBoundsDate? hardBounds) { @@ -241,7 +286,10 @@ public DateHistogramAggregationDescriptor HardBounds(Action - /// Only returns buckets that have `min_doc_count` number of documents.
By default, all buckets between the first bucket that matches documents and the last one are returned. + /// + /// Only returns buckets that have min_doc_count number of documents. + /// By default, all buckets between the first bucket that matches documents and the last one are returned. + /// /// public DateHistogramAggregationDescriptor MinDocCount(int? minDocCount) { @@ -250,7 +298,10 @@ public DateHistogramAggregationDescriptor MinDocCount(int? minDocCoun } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public DateHistogramAggregationDescriptor Missing(DateTimeOffset? missing) { @@ -259,7 +310,9 @@ public DateHistogramAggregationDescriptor Missing(DateTimeOffset? mis } /// - /// Changes the start value of each bucket by the specified positive (`+`) or negative offset (`-`) duration. + /// + /// Changes the start value of each bucket by the specified positive (+) or negative offset (-) duration. + /// /// public DateHistogramAggregationDescriptor Offset(Elastic.Clients.Elasticsearch.Serverless.Duration? offset) { @@ -268,7 +321,9 @@ public DateHistogramAggregationDescriptor Offset(Elastic.Clients.Elas } /// - /// The sort order of the returned buckets. + /// + /// The sort order of the returned buckets. + /// /// public DateHistogramAggregationDescriptor Order(ICollection>? order) { @@ -307,7 +362,10 @@ public DateHistogramAggregationDescriptor Script(Action - /// Time zone used for bucketing and rounding.
Defaults to Coordinated Universal Time (UTC). + /// + /// Time zone used for bucketing and rounding. + /// Defaults to Coordinated Universal Time (UTC). + /// /// public DateHistogramAggregationDescriptor TimeZone(string? timeZone) { @@ -459,7 +517,10 @@ public DateHistogramAggregationDescriptor() : base() private string? TimeZoneValue { get; set; } /// - /// Calendar-aware interval.
Can be specified using the unit name, such as `month`, or as a single unit quantity, such as `1M`. + /// + /// Calendar-aware interval. + /// Can be specified using the unit name, such as month, or as a single unit quantity, such as 1M. + /// /// public DateHistogramAggregationDescriptor CalendarInterval(Elastic.Clients.Elasticsearch.Serverless.Aggregations.CalendarInterval? calendarInterval) { @@ -468,7 +529,9 @@ public DateHistogramAggregationDescriptor CalendarInterval(Elastic.Clients.Elast } /// - /// Enables extending the bounds of the histogram beyond the data itself. + /// + /// Enables extending the bounds of the histogram beyond the data itself. + /// /// public DateHistogramAggregationDescriptor ExtendedBounds(Elastic.Clients.Elasticsearch.Serverless.Aggregations.ExtendedBoundsDate? extendedBounds) { @@ -495,7 +558,9 @@ public DateHistogramAggregationDescriptor ExtendedBounds(Action - /// The date field whose values are use to build a histogram. + /// + /// The date field whose values are use to build a histogram. + /// /// public DateHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -504,7 +569,9 @@ public DateHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Se } /// - /// The date field whose values are use to build a histogram. + /// + /// The date field whose values are use to build a histogram. + /// /// public DateHistogramAggregationDescriptor Field(Expression> field) { @@ -513,7 +580,9 @@ public DateHistogramAggregationDescriptor Field(Expression - /// The date field whose values are use to build a histogram. + /// + /// The date field whose values are use to build a histogram. + /// /// public DateHistogramAggregationDescriptor Field(Expression> field) { @@ -522,7 +591,9 @@ public DateHistogramAggregationDescriptor Field(Expression - /// Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar. + /// + /// Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar. + /// /// public DateHistogramAggregationDescriptor FixedInterval(Elastic.Clients.Elasticsearch.Serverless.Duration? fixedInterval) { @@ -531,7 +602,10 @@ public DateHistogramAggregationDescriptor FixedInterval(Elastic.Clients.Elastics } /// - /// The date format used to format `key_as_string` in the response.
If no `format` is specified, the first date format specified in the field mapping is used. + /// + /// The date format used to format key_as_string in the response. + /// If no format is specified, the first date format specified in the field mapping is used. + /// /// public DateHistogramAggregationDescriptor Format(string? format) { @@ -540,7 +614,9 @@ public DateHistogramAggregationDescriptor Format(string? format) } /// - /// Limits the histogram to specified bounds. + /// + /// Limits the histogram to specified bounds. + /// /// public DateHistogramAggregationDescriptor HardBounds(Elastic.Clients.Elasticsearch.Serverless.Aggregations.ExtendedBoundsDate? hardBounds) { @@ -567,7 +643,10 @@ public DateHistogramAggregationDescriptor HardBounds(Action - /// Only returns buckets that have `min_doc_count` number of documents.
By default, all buckets between the first bucket that matches documents and the last one are returned. + /// + /// Only returns buckets that have min_doc_count number of documents. + /// By default, all buckets between the first bucket that matches documents and the last one are returned. + /// /// public DateHistogramAggregationDescriptor MinDocCount(int? minDocCount) { @@ -576,7 +655,10 @@ public DateHistogramAggregationDescriptor MinDocCount(int? minDocCount) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public DateHistogramAggregationDescriptor Missing(DateTimeOffset? missing) { @@ -585,7 +667,9 @@ public DateHistogramAggregationDescriptor Missing(DateTimeOffset? missing) } /// - /// Changes the start value of each bucket by the specified positive (`+`) or negative offset (`-`) duration. + /// + /// Changes the start value of each bucket by the specified positive (+) or negative offset (-) duration. + /// /// public DateHistogramAggregationDescriptor Offset(Elastic.Clients.Elasticsearch.Serverless.Duration? offset) { @@ -594,7 +678,9 @@ public DateHistogramAggregationDescriptor Offset(Elastic.Clients.Elasticsearch.S } /// - /// The sort order of the returned buckets. + /// + /// The sort order of the returned buckets. + /// /// public DateHistogramAggregationDescriptor Order(ICollection>? order) { @@ -633,7 +719,10 @@ public DateHistogramAggregationDescriptor Script(Action - /// Time zone used for bucketing and rounding.
Defaults to Coordinated Universal Time (UTC). + /// + /// Time zone used for bucketing and rounding. + /// Defaults to Coordinated Universal Time (UTC). + /// /// public DateHistogramAggregationDescriptor TimeZone(string? timeZone) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DateHistogramBucket.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DateHistogramBucket.g.cs index 31459715c86..26386f3c977 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DateHistogramBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DateHistogramBucket.g.cs @@ -84,7 +84,9 @@ public override void Write(Utf8JsonWriter writer, DateHistogramBucket value, Jso public sealed partial class DateHistogramBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DateRangeAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DateRangeAggregate.g.cs index d082bff5151..a885c04604d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DateRangeAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DateRangeAggregate.g.cs @@ -28,7 +28,10 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; /// -/// Result of a `date_range` aggregation. Same format as a for a `range` aggregation: `from` and `to`
in `buckets` are milliseconds since the Epoch, represented as a floating point number. +/// +/// Result of a date_range aggregation. Same format as a for a range aggregation: from and to +/// in buckets are milliseconds since the Epoch, represented as a floating point number. +/// /// public sealed partial class DateRangeAggregate : IAggregate { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DateRangeAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DateRangeAggregation.g.cs index 997a4c65878..3199a7d4b84 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DateRangeAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DateRangeAggregation.g.cs @@ -30,31 +30,42 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class DateRangeAggregation { /// - /// The date field whose values are use to build ranges. + /// + /// The date field whose values are use to build ranges. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } /// - /// The date format used to format `from` and `to` in the response. + /// + /// The date format used to format from and to in the response. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.Serverless.FieldValue? Missing { get; set; } /// - /// Array of date ranges. + /// + /// Array of date ranges. + /// /// [JsonInclude, JsonPropertyName("ranges")] public ICollection? Ranges { get; set; } /// - /// Time zone used to convert dates from another time zone to UTC. + /// + /// Time zone used to convert dates from another time zone to UTC. + /// /// [JsonInclude, JsonPropertyName("time_zone")] public string? TimeZone { get; set; } @@ -80,7 +91,9 @@ public DateRangeAggregationDescriptor() : base() private string? TimeZoneValue { get; set; } /// - /// The date field whose values are use to build ranges. + /// + /// The date field whose values are use to build ranges. + /// /// public DateRangeAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -89,7 +102,9 @@ public DateRangeAggregationDescriptor Field(Elastic.Clients.Elasticse } /// - /// The date field whose values are use to build ranges. + /// + /// The date field whose values are use to build ranges. + /// /// public DateRangeAggregationDescriptor Field(Expression> field) { @@ -98,7 +113,9 @@ public DateRangeAggregationDescriptor Field(Expression - /// The date field whose values are use to build ranges. + /// + /// The date field whose values are use to build ranges. + /// /// public DateRangeAggregationDescriptor Field(Expression> field) { @@ -107,7 +124,9 @@ public DateRangeAggregationDescriptor Field(Expression - /// The date format used to format `from` and `to` in the response. + /// + /// The date format used to format from and to in the response. + /// /// public DateRangeAggregationDescriptor Format(string? format) { @@ -116,7 +135,10 @@ public DateRangeAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public DateRangeAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -125,7 +147,9 @@ public DateRangeAggregationDescriptor Missing(Elastic.Clients.Elastic } /// - /// Array of date ranges. + /// + /// Array of date ranges. + /// /// public DateRangeAggregationDescriptor Ranges(ICollection? ranges) { @@ -164,7 +188,9 @@ public DateRangeAggregationDescriptor Ranges(params Action - /// Time zone used to convert dates from another time zone to UTC. + /// + /// Time zone used to convert dates from another time zone to UTC. + /// /// public DateRangeAggregationDescriptor TimeZone(string? timeZone) { @@ -252,7 +278,9 @@ public DateRangeAggregationDescriptor() : base() private string? TimeZoneValue { get; set; } /// - /// The date field whose values are use to build ranges. + /// + /// The date field whose values are use to build ranges. + /// /// public DateRangeAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -261,7 +289,9 @@ public DateRangeAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Server } /// - /// The date field whose values are use to build ranges. + /// + /// The date field whose values are use to build ranges. + /// /// public DateRangeAggregationDescriptor Field(Expression> field) { @@ -270,7 +300,9 @@ public DateRangeAggregationDescriptor Field(Expression - /// The date field whose values are use to build ranges. + /// + /// The date field whose values are use to build ranges. + /// /// public DateRangeAggregationDescriptor Field(Expression> field) { @@ -279,7 +311,9 @@ public DateRangeAggregationDescriptor Field(Expression - /// The date format used to format `from` and `to` in the response. + /// + /// The date format used to format from and to in the response. + /// /// public DateRangeAggregationDescriptor Format(string? format) { @@ -288,7 +322,10 @@ public DateRangeAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public DateRangeAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -297,7 +334,9 @@ public DateRangeAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serv } /// - /// Array of date ranges. + /// + /// Array of date ranges. + /// /// public DateRangeAggregationDescriptor Ranges(ICollection? ranges) { @@ -336,7 +375,9 @@ public DateRangeAggregationDescriptor Ranges(params Action - /// Time zone used to convert dates from another time zone to UTC. + /// + /// Time zone used to convert dates from another time zone to UTC. + /// /// public DateRangeAggregationDescriptor TimeZone(string? timeZone) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DateRangeExpression.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DateRangeExpression.g.cs index abd106510a0..cb2b74a1c7f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DateRangeExpression.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DateRangeExpression.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class DateRangeExpression { /// - /// Start of the range (inclusive). + /// + /// Start of the range (inclusive). + /// /// [JsonInclude, JsonPropertyName("from")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.FieldDateMath? From { get; set; } /// - /// Custom key to return the range with. + /// + /// Custom key to return the range with. + /// /// [JsonInclude, JsonPropertyName("key")] public string? Key { get; set; } /// - /// End of the range (exclusive). + /// + /// End of the range (exclusive). + /// /// [JsonInclude, JsonPropertyName("to")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.FieldDateMath? To { get; set; } @@ -61,7 +67,9 @@ public DateRangeExpressionDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Aggregations.FieldDateMath? ToValue { get; set; } /// - /// Start of the range (inclusive). + /// + /// Start of the range (inclusive). + /// /// public DateRangeExpressionDescriptor From(Elastic.Clients.Elasticsearch.Serverless.Aggregations.FieldDateMath? from) { @@ -70,7 +78,9 @@ public DateRangeExpressionDescriptor From(Elastic.Clients.Elasticsearch.Serverle } /// - /// Custom key to return the range with. + /// + /// Custom key to return the range with. + /// /// public DateRangeExpressionDescriptor Key(string? key) { @@ -79,7 +89,9 @@ public DateRangeExpressionDescriptor Key(string? key) } /// - /// End of the range (exclusive). + /// + /// End of the range (exclusive). + /// /// public DateRangeExpressionDescriptor To(Elastic.Clients.Elasticsearch.Serverless.Aggregations.FieldDateMath? to) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DerivativeAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DerivativeAggregate.g.cs index 310daddfabc..d5399747ce3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DerivativeAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DerivativeAggregate.g.cs @@ -37,7 +37,10 @@ public sealed partial class DerivativeAggregate : IAggregate public string? NormalizedValueAsString { get; init; } /// - /// The metric value. A missing value generally means that there was no data to aggregate,
unless specified otherwise. + /// + /// The metric value. A missing value generally means that there was no data to aggregate, + /// unless specified otherwise. + /// /// [JsonInclude, JsonPropertyName("value")] public double? Value { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DerivativeAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DerivativeAggregation.g.cs index 31a5d633215..c9f68edb9ea 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DerivativeAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DerivativeAggregation.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class DerivativeAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? GapPolicy { get; set; } @@ -63,7 +70,9 @@ public DerivativeAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? GapPolicyValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public DerivativeAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? bucketsPath) { @@ -72,7 +81,10 @@ public DerivativeAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public DerivativeAggregationDescriptor Format(string? format) { @@ -81,7 +93,9 @@ public DerivativeAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public DerivativeAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? gapPolicy) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DiversifiedSamplerAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DiversifiedSamplerAggregation.g.cs index 85f5ae6e6f0..41f701194fe 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DiversifiedSamplerAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DiversifiedSamplerAggregation.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class DiversifiedSamplerAggregation { /// - /// The type of value used for de-duplication. + /// + /// The type of value used for de-duplication. + /// /// [JsonInclude, JsonPropertyName("execution_hint")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.SamplerAggregationExecutionHint? ExecutionHint { get; set; } /// - /// The field used to provide values used for de-duplication. + /// + /// The field used to provide values used for de-duplication. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } /// - /// Limits how many documents are permitted per choice of de-duplicating value. + /// + /// Limits how many documents are permitted per choice of de-duplicating value. + /// /// [JsonInclude, JsonPropertyName("max_docs_per_value")] public int? MaxDocsPerValue { get; set; } @@ -50,7 +56,9 @@ public sealed partial class DiversifiedSamplerAggregation public Elastic.Clients.Elasticsearch.Serverless.Script? Script { get; set; } /// - /// Limits how many top-scoring documents are collected in the sample processed on each shard. + /// + /// Limits how many top-scoring documents are collected in the sample processed on each shard. + /// /// [JsonInclude, JsonPropertyName("shard_size")] public int? ShardSize { get; set; } @@ -75,7 +83,9 @@ public DiversifiedSamplerAggregationDescriptor() : base() private int? ShardSizeValue { get; set; } /// - /// The type of value used for de-duplication. + /// + /// The type of value used for de-duplication. + /// /// public DiversifiedSamplerAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsearch.Serverless.Aggregations.SamplerAggregationExecutionHint? executionHint) { @@ -84,7 +94,9 @@ public DiversifiedSamplerAggregationDescriptor ExecutionHint(Elastic. } /// - /// The field used to provide values used for de-duplication. + /// + /// The field used to provide values used for de-duplication. + /// /// public DiversifiedSamplerAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -93,7 +105,9 @@ public DiversifiedSamplerAggregationDescriptor Field(Elastic.Clients. } /// - /// The field used to provide values used for de-duplication. + /// + /// The field used to provide values used for de-duplication. + /// /// public DiversifiedSamplerAggregationDescriptor Field(Expression> field) { @@ -102,7 +116,9 @@ public DiversifiedSamplerAggregationDescriptor Field(Expressi } /// - /// The field used to provide values used for de-duplication. + /// + /// The field used to provide values used for de-duplication. + /// /// public DiversifiedSamplerAggregationDescriptor Field(Expression> field) { @@ -111,7 +127,9 @@ public DiversifiedSamplerAggregationDescriptor Field(Expression - /// Limits how many documents are permitted per choice of de-duplicating value. + /// + /// Limits how many documents are permitted per choice of de-duplicating value. + /// /// public DiversifiedSamplerAggregationDescriptor MaxDocsPerValue(int? maxDocsPerValue) { @@ -144,7 +162,9 @@ public DiversifiedSamplerAggregationDescriptor Script(Action - /// Limits how many top-scoring documents are collected in the sample processed on each shard. + /// + /// Limits how many top-scoring documents are collected in the sample processed on each shard. + /// /// public DiversifiedSamplerAggregationDescriptor ShardSize(int? shardSize) { @@ -216,7 +236,9 @@ public DiversifiedSamplerAggregationDescriptor() : base() private int? ShardSizeValue { get; set; } /// - /// The type of value used for de-duplication. + /// + /// The type of value used for de-duplication. + /// /// public DiversifiedSamplerAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsearch.Serverless.Aggregations.SamplerAggregationExecutionHint? executionHint) { @@ -225,7 +247,9 @@ public DiversifiedSamplerAggregationDescriptor ExecutionHint(Elastic.Clients.Ela } /// - /// The field used to provide values used for de-duplication. + /// + /// The field used to provide values used for de-duplication. + /// /// public DiversifiedSamplerAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -234,7 +258,9 @@ public DiversifiedSamplerAggregationDescriptor Field(Elastic.Clients.Elasticsear } /// - /// The field used to provide values used for de-duplication. + /// + /// The field used to provide values used for de-duplication. + /// /// public DiversifiedSamplerAggregationDescriptor Field(Expression> field) { @@ -243,7 +269,9 @@ public DiversifiedSamplerAggregationDescriptor Field(Expressi } /// - /// The field used to provide values used for de-duplication. + /// + /// The field used to provide values used for de-duplication. + /// /// public DiversifiedSamplerAggregationDescriptor Field(Expression> field) { @@ -252,7 +280,9 @@ public DiversifiedSamplerAggregationDescriptor Field(Expression - /// Limits how many documents are permitted per choice of de-duplicating value. + /// + /// Limits how many documents are permitted per choice of de-duplicating value. + /// /// public DiversifiedSamplerAggregationDescriptor MaxDocsPerValue(int? maxDocsPerValue) { @@ -285,7 +315,9 @@ public DiversifiedSamplerAggregationDescriptor Script(Action - /// Limits how many top-scoring documents are collected in the sample processed on each shard. + /// + /// Limits how many top-scoring documents are collected in the sample processed on each shard. + /// /// public DiversifiedSamplerAggregationDescriptor ShardSize(int? shardSize) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DoubleTermsAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DoubleTermsAggregate.g.cs index 70c7506f6f7..10bb23a1570 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DoubleTermsAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DoubleTermsAggregate.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; /// -/// Result of a `terms` aggregation when the field is some kind of decimal number like a float, double, or distance. +/// +/// Result of a terms aggregation when the field is some kind of decimal number like a float, double, or distance. +/// /// public sealed partial class DoubleTermsAggregate : IAggregate { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DoubleTermsBucket.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DoubleTermsBucket.g.cs index 0115b393c6e..5dc845c246a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DoubleTermsBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/DoubleTermsBucket.g.cs @@ -91,7 +91,9 @@ public override void Write(Utf8JsonWriter writer, DoubleTermsBucket value, JsonS public sealed partial class DoubleTermsBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ExtendedBoundsDate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ExtendedBoundsDate.g.cs index 984f26ff3a5..fb847e470d7 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ExtendedBoundsDate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ExtendedBoundsDate.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class ExtendedBoundsDate { /// - /// Maximum value for the bound. + /// + /// Maximum value for the bound. + /// /// [JsonInclude, JsonPropertyName("max")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.FieldDateMath? Max { get; set; } /// - /// Minimum value for the bound. + /// + /// Minimum value for the bound. + /// /// [JsonInclude, JsonPropertyName("min")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.FieldDateMath? Min { get; set; } @@ -54,7 +58,9 @@ public ExtendedBoundsDateDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Aggregations.FieldDateMath? MinValue { get; set; } /// - /// Maximum value for the bound. + /// + /// Maximum value for the bound. + /// /// public ExtendedBoundsDateDescriptor Max(Elastic.Clients.Elasticsearch.Serverless.Aggregations.FieldDateMath? max) { @@ -63,7 +69,9 @@ public ExtendedBoundsDateDescriptor Max(Elastic.Clients.Elasticsearch.Serverless } /// - /// Minimum value for the bound. + /// + /// Minimum value for the bound. + /// /// public ExtendedBoundsDateDescriptor Min(Elastic.Clients.Elasticsearch.Serverless.Aggregations.FieldDateMath? min) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ExtendedBoundsFloat.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ExtendedBoundsFloat.g.cs index 300347d8dc1..a37a0be8325 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ExtendedBoundsFloat.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ExtendedBoundsFloat.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class ExtendedBoundsFloat { /// - /// Maximum value for the bound. + /// + /// Maximum value for the bound. + /// /// [JsonInclude, JsonPropertyName("max")] public float? Max { get; set; } /// - /// Minimum value for the bound. + /// + /// Minimum value for the bound. + /// /// [JsonInclude, JsonPropertyName("min")] public float? Min { get; set; } @@ -54,7 +58,9 @@ public ExtendedBoundsFloatDescriptor() : base() private float? MinValue { get; set; } /// - /// Maximum value for the bound. + /// + /// Maximum value for the bound. + /// /// public ExtendedBoundsFloatDescriptor Max(float? max) { @@ -63,7 +69,9 @@ public ExtendedBoundsFloatDescriptor Max(float? max) } /// - /// Minimum value for the bound. + /// + /// Minimum value for the bound. + /// /// public ExtendedBoundsFloatDescriptor Min(float? min) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ExtendedStatsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ExtendedStatsAggregation.g.cs index 5d9d23ab7c9..f96241d7a75 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ExtendedStatsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ExtendedStatsAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class ExtendedStatsAggregation { /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } @@ -38,7 +40,10 @@ public sealed partial class ExtendedStatsAggregation public string? Format { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.Serverless.FieldValue? Missing { get; set; } @@ -46,7 +51,9 @@ public sealed partial class ExtendedStatsAggregation public Elastic.Clients.Elasticsearch.Serverless.Script? Script { get; set; } /// - /// The number of standard deviations above/below the mean to display. + /// + /// The number of standard deviations above/below the mean to display. + /// /// [JsonInclude, JsonPropertyName("sigma")] public double? Sigma { get; set; } @@ -71,7 +78,9 @@ public ExtendedStatsAggregationDescriptor() : base() private double? SigmaValue { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ExtendedStatsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -80,7 +89,9 @@ public ExtendedStatsAggregationDescriptor Field(Elastic.Clients.Elast } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ExtendedStatsAggregationDescriptor Field(Expression> field) { @@ -89,7 +100,9 @@ public ExtendedStatsAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ExtendedStatsAggregationDescriptor Field(Expression> field) { @@ -104,7 +117,10 @@ public ExtendedStatsAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public ExtendedStatsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -137,7 +153,9 @@ public ExtendedStatsAggregationDescriptor Script(Action - /// The number of standard deviations above/below the mean to display. + /// + /// The number of standard deviations above/below the mean to display. + /// /// public ExtendedStatsAggregationDescriptor Sigma(double? sigma) { @@ -209,7 +227,9 @@ public ExtendedStatsAggregationDescriptor() : base() private double? SigmaValue { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ExtendedStatsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -218,7 +238,9 @@ public ExtendedStatsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Se } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ExtendedStatsAggregationDescriptor Field(Expression> field) { @@ -227,7 +249,9 @@ public ExtendedStatsAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ExtendedStatsAggregationDescriptor Field(Expression> field) { @@ -242,7 +266,10 @@ public ExtendedStatsAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public ExtendedStatsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -275,7 +302,9 @@ public ExtendedStatsAggregationDescriptor Script(Action - /// The number of standard deviations above/below the mean to display. + /// + /// The number of standard deviations above/below the mean to display. + /// /// public ExtendedStatsAggregationDescriptor Sigma(double? sigma) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ExtendedStatsBucketAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ExtendedStatsBucketAggregation.g.cs index c1ff51ce10b..28c9ff862a7 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ExtendedStatsBucketAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ExtendedStatsBucketAggregation.g.cs @@ -30,25 +30,34 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class ExtendedStatsBucketAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? GapPolicy { get; set; } /// - /// The number of standard deviations above/below the mean to display. + /// + /// The number of standard deviations above/below the mean to display. + /// /// [JsonInclude, JsonPropertyName("sigma")] public double? Sigma { get; set; } @@ -70,7 +79,9 @@ public ExtendedStatsBucketAggregationDescriptor() : base() private double? SigmaValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public ExtendedStatsBucketAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? bucketsPath) { @@ -79,7 +90,10 @@ public ExtendedStatsBucketAggregationDescriptor BucketsPath(Elastic.Clients.Elas } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public ExtendedStatsBucketAggregationDescriptor Format(string? format) { @@ -88,7 +102,9 @@ public ExtendedStatsBucketAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public ExtendedStatsBucketAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? gapPolicy) { @@ -97,7 +113,9 @@ public ExtendedStatsBucketAggregationDescriptor GapPolicy(Elastic.Clients.Elasti } /// - /// The number of standard deviations above/below the mean to display. + /// + /// The number of standard deviations above/below the mean to display. + /// /// public ExtendedStatsBucketAggregationDescriptor Sigma(double? sigma) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/FieldDateMath.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/FieldDateMath.g.cs index 5cd007ef9b1..b3b67cd970e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/FieldDateMath.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/FieldDateMath.g.cs @@ -31,7 +31,10 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; /// -/// A date range limit, represented either as a DateMath expression or a number expressed
according to the target field's precision. +/// +/// A date range limit, represented either as a DateMath expression or a number expressed +/// according to the target field's precision. +/// /// public sealed partial class FieldDateMath : Union { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/FilterAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/FilterAggregate.g.cs index 7ae0d8c6dee..1518ef244d1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/FilterAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/FilterAggregate.g.cs @@ -77,7 +77,9 @@ public override void Write(Utf8JsonWriter writer, FilterAggregate value, JsonSer public sealed partial class FilterAggregate : IAggregate { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/FiltersAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/FiltersAggregation.g.cs index 7f7323c763a..bb446d659a9 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/FiltersAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/FiltersAggregation.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class FiltersAggregation { /// - /// Collection of queries from which to build buckets. + /// + /// Collection of queries from which to build buckets. + /// /// [JsonInclude, JsonPropertyName("filters")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.Buckets? Filters { get; set; } /// - /// Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters. + /// + /// Set to true to add a bucket to the response which will contain all documents that do not match any of the given filters. + /// /// [JsonInclude, JsonPropertyName("other_bucket")] public bool? OtherBucket { get; set; } /// - /// The key with which the other bucket is returned. + /// + /// The key with which the other bucket is returned. + /// /// [JsonInclude, JsonPropertyName("other_bucket_key")] public string? OtherBucketKey { get; set; } @@ -63,7 +69,9 @@ public FiltersAggregationDescriptor() : base() private string? OtherBucketKeyValue { get; set; } /// - /// Collection of queries from which to build buckets. + /// + /// Collection of queries from which to build buckets. + /// /// public FiltersAggregationDescriptor Filters(Elastic.Clients.Elasticsearch.Serverless.Aggregations.Buckets? filters) { @@ -72,7 +80,9 @@ public FiltersAggregationDescriptor Filters(Elastic.Clients.Elasticse } /// - /// Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters. + /// + /// Set to true to add a bucket to the response which will contain all documents that do not match any of the given filters. + /// /// public FiltersAggregationDescriptor OtherBucket(bool? otherBucket = true) { @@ -81,7 +91,9 @@ public FiltersAggregationDescriptor OtherBucket(bool? otherBucket = t } /// - /// The key with which the other bucket is returned. + /// + /// The key with which the other bucket is returned. + /// /// public FiltersAggregationDescriptor OtherBucketKey(string? otherBucketKey) { @@ -127,7 +139,9 @@ public FiltersAggregationDescriptor() : base() private string? OtherBucketKeyValue { get; set; } /// - /// Collection of queries from which to build buckets. + /// + /// Collection of queries from which to build buckets. + /// /// public FiltersAggregationDescriptor Filters(Elastic.Clients.Elasticsearch.Serverless.Aggregations.Buckets? filters) { @@ -136,7 +150,9 @@ public FiltersAggregationDescriptor Filters(Elastic.Clients.Elasticsearch.Server } /// - /// Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters. + /// + /// Set to true to add a bucket to the response which will contain all documents that do not match any of the given filters. + /// /// public FiltersAggregationDescriptor OtherBucket(bool? otherBucket = true) { @@ -145,7 +161,9 @@ public FiltersAggregationDescriptor OtherBucket(bool? otherBucket = true) } /// - /// The key with which the other bucket is returned. + /// + /// The key with which the other bucket is returned. + /// /// public FiltersAggregationDescriptor OtherBucketKey(string? otherBucketKey) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/FiltersBucket.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/FiltersBucket.g.cs index 645e0298522..0de13876564 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/FiltersBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/FiltersBucket.g.cs @@ -70,7 +70,9 @@ public override void Write(Utf8JsonWriter writer, FiltersBucket value, JsonSeria public sealed partial class FiltersBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/FrequentItemSetsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/FrequentItemSetsAggregation.g.cs index 80108f64615..f6e4457f7de 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/FrequentItemSetsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/FrequentItemSetsAggregation.g.cs @@ -30,31 +30,41 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class FrequentItemSetsAggregation { /// - /// Fields to analyze. + /// + /// Fields to analyze. + /// /// [JsonInclude, JsonPropertyName("fields")] public ICollection Fields { get; set; } /// - /// Query that filters documents from analysis. + /// + /// Query that filters documents from analysis. + /// /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? Filter { get; set; } /// - /// The minimum size of one item set. + /// + /// The minimum size of one item set. + /// /// [JsonInclude, JsonPropertyName("minimum_set_size")] public int? MinimumSetSize { get; set; } /// - /// The minimum support of one item set. + /// + /// The minimum support of one item set. + /// /// [JsonInclude, JsonPropertyName("minimum_support")] public double? MinimumSupport { get; set; } /// - /// The number of top item sets to return. + /// + /// The number of top item sets to return. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } @@ -82,7 +92,9 @@ public FrequentItemSetsAggregationDescriptor() : base() private int? SizeValue { get; set; } /// - /// Fields to analyze. + /// + /// Fields to analyze. + /// /// public FrequentItemSetsAggregationDescriptor Fields(ICollection fields) { @@ -121,7 +133,9 @@ public FrequentItemSetsAggregationDescriptor Fields(params Action - /// Query that filters documents from analysis. + /// + /// Query that filters documents from analysis. + /// /// public FrequentItemSetsAggregationDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? filter) { @@ -148,7 +162,9 @@ public FrequentItemSetsAggregationDescriptor Filter(Action - /// The minimum size of one item set. + /// + /// The minimum size of one item set. + /// /// public FrequentItemSetsAggregationDescriptor MinimumSetSize(int? minimumSetSize) { @@ -157,7 +173,9 @@ public FrequentItemSetsAggregationDescriptor MinimumSetSize(int? mini } /// - /// The minimum support of one item set. + /// + /// The minimum support of one item set. + /// /// public FrequentItemSetsAggregationDescriptor MinimumSupport(double? minimumSupport) { @@ -166,7 +184,9 @@ public FrequentItemSetsAggregationDescriptor MinimumSupport(double? m } /// - /// The number of top item sets to return. + /// + /// The number of top item sets to return. + /// /// public FrequentItemSetsAggregationDescriptor Size(int? size) { @@ -266,7 +286,9 @@ public FrequentItemSetsAggregationDescriptor() : base() private int? SizeValue { get; set; } /// - /// Fields to analyze. + /// + /// Fields to analyze. + /// /// public FrequentItemSetsAggregationDescriptor Fields(ICollection fields) { @@ -305,7 +327,9 @@ public FrequentItemSetsAggregationDescriptor Fields(params Action - /// Query that filters documents from analysis. + /// + /// Query that filters documents from analysis. + /// /// public FrequentItemSetsAggregationDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? filter) { @@ -332,7 +356,9 @@ public FrequentItemSetsAggregationDescriptor Filter(Action - /// The minimum size of one item set. + /// + /// The minimum size of one item set. + /// /// public FrequentItemSetsAggregationDescriptor MinimumSetSize(int? minimumSetSize) { @@ -341,7 +367,9 @@ public FrequentItemSetsAggregationDescriptor MinimumSetSize(int? minimumSetSize) } /// - /// The minimum support of one item set. + /// + /// The minimum support of one item set. + /// /// public FrequentItemSetsAggregationDescriptor MinimumSupport(double? minimumSupport) { @@ -350,7 +378,9 @@ public FrequentItemSetsAggregationDescriptor MinimumSupport(double? minimumSuppo } /// - /// The number of top item sets to return. + /// + /// The number of top item sets to return. + /// /// public FrequentItemSetsAggregationDescriptor Size(int? size) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/FrequentItemSetsBucket.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/FrequentItemSetsBucket.g.cs index b21da546e56..61749981144 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/FrequentItemSetsBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/FrequentItemSetsBucket.g.cs @@ -84,7 +84,9 @@ public override void Write(Utf8JsonWriter writer, FrequentItemSetsBucket value, public sealed partial class FrequentItemSetsBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/FrequentItemSetsField.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/FrequentItemSetsField.g.cs index bbed41f9202..d602457cf05 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/FrequentItemSetsField.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/FrequentItemSetsField.g.cs @@ -30,7 +30,10 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class FrequentItemSetsField { /// - /// Values to exclude.
Can be regular expression strings or arrays of strings of exact terms. + /// + /// Values to exclude. + /// Can be regular expression strings or arrays of strings of exact terms. + /// /// [JsonInclude, JsonPropertyName("exclude")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsExclude? Exclude { get; set; } @@ -38,7 +41,10 @@ public sealed partial class FrequentItemSetsField public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Values to include.
Can be regular expression strings or arrays of strings of exact terms. + /// + /// Values to include. + /// Can be regular expression strings or arrays of strings of exact terms. + /// /// [JsonInclude, JsonPropertyName("include")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsInclude? Include { get; set; } @@ -57,7 +63,10 @@ public FrequentItemSetsFieldDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsInclude? IncludeValue { get; set; } /// - /// Values to exclude.
Can be regular expression strings or arrays of strings of exact terms. + /// + /// Values to exclude. + /// Can be regular expression strings or arrays of strings of exact terms. + /// /// public FrequentItemSetsFieldDescriptor Exclude(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsExclude? exclude) { @@ -84,7 +93,10 @@ public FrequentItemSetsFieldDescriptor Field(Expression - /// Values to include.
Can be regular expression strings or arrays of strings of exact terms. + /// + /// Values to include. + /// Can be regular expression strings or arrays of strings of exact terms. + /// /// public FrequentItemSetsFieldDescriptor Include(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsInclude? include) { @@ -126,7 +138,10 @@ public FrequentItemSetsFieldDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsInclude? IncludeValue { get; set; } /// - /// Values to exclude.
Can be regular expression strings or arrays of strings of exact terms. + /// + /// Values to exclude. + /// Can be regular expression strings or arrays of strings of exact terms. + /// /// public FrequentItemSetsFieldDescriptor Exclude(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsExclude? exclude) { @@ -153,7 +168,10 @@ public FrequentItemSetsFieldDescriptor Field(Expression - /// Values to include.
Can be regular expression strings or arrays of strings of exact terms. + /// + /// Values to include. + /// Can be regular expression strings or arrays of strings of exact terms. + /// /// public FrequentItemSetsFieldDescriptor Include(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsInclude? include) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeoBoundsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeoBoundsAggregation.g.cs index 60dda141d46..fc7717d21b4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeoBoundsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeoBoundsAggregation.g.cs @@ -30,13 +30,18 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class GeoBoundsAggregation { /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.Serverless.FieldValue? Missing { get; set; } @@ -44,7 +49,9 @@ public sealed partial class GeoBoundsAggregation public Elastic.Clients.Elasticsearch.Serverless.Script? Script { get; set; } /// - /// Specifies whether the bounding box should be allowed to overlap the international date line. + /// + /// Specifies whether the bounding box should be allowed to overlap the international date line. + /// /// [JsonInclude, JsonPropertyName("wrap_longitude")] public bool? WrapLongitude { get; set; } @@ -68,7 +75,9 @@ public GeoBoundsAggregationDescriptor() : base() private bool? WrapLongitudeValue { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public GeoBoundsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -77,7 +86,9 @@ public GeoBoundsAggregationDescriptor Field(Elastic.Clients.Elasticse } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public GeoBoundsAggregationDescriptor Field(Expression> field) { @@ -86,7 +97,9 @@ public GeoBoundsAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public GeoBoundsAggregationDescriptor Field(Expression> field) { @@ -95,7 +108,10 @@ public GeoBoundsAggregationDescriptor Field(Expression - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public GeoBoundsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -128,7 +144,9 @@ public GeoBoundsAggregationDescriptor Script(Action - /// Specifies whether the bounding box should be allowed to overlap the international date line. + /// + /// Specifies whether the bounding box should be allowed to overlap the international date line. + /// /// public GeoBoundsAggregationDescriptor WrapLongitude(bool? wrapLongitude = true) { @@ -193,7 +211,9 @@ public GeoBoundsAggregationDescriptor() : base() private bool? WrapLongitudeValue { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public GeoBoundsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -202,7 +222,9 @@ public GeoBoundsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Server } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public GeoBoundsAggregationDescriptor Field(Expression> field) { @@ -211,7 +233,9 @@ public GeoBoundsAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public GeoBoundsAggregationDescriptor Field(Expression> field) { @@ -220,7 +244,10 @@ public GeoBoundsAggregationDescriptor Field(Expression - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public GeoBoundsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -253,7 +280,9 @@ public GeoBoundsAggregationDescriptor Script(Action - /// Specifies whether the bounding box should be allowed to overlap the international date line. + /// + /// Specifies whether the bounding box should be allowed to overlap the international date line. + /// /// public GeoBoundsAggregationDescriptor WrapLongitude(bool? wrapLongitude = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeoCentroidAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeoCentroidAggregation.g.cs index be268ed90e3..e3d5fd215f2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeoCentroidAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeoCentroidAggregation.g.cs @@ -33,7 +33,9 @@ public sealed partial class GeoCentroidAggregation public long? Count { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } @@ -41,7 +43,10 @@ public sealed partial class GeoCentroidAggregation public Elastic.Clients.Elasticsearch.Serverless.GeoLocation? Location { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.Serverless.FieldValue? Missing { get; set; } @@ -74,7 +79,9 @@ public GeoCentroidAggregationDescriptor Count(long? count) } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public GeoCentroidAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -83,7 +90,9 @@ public GeoCentroidAggregationDescriptor Field(Elastic.Clients.Elastic } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public GeoCentroidAggregationDescriptor Field(Expression> field) { @@ -92,7 +101,9 @@ public GeoCentroidAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public GeoCentroidAggregationDescriptor Field(Expression> field) { @@ -107,7 +118,10 @@ public GeoCentroidAggregationDescriptor Location(Elastic.Clients.Elas } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public GeoCentroidAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -209,7 +223,9 @@ public GeoCentroidAggregationDescriptor Count(long? count) } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public GeoCentroidAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -218,7 +234,9 @@ public GeoCentroidAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serv } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public GeoCentroidAggregationDescriptor Field(Expression> field) { @@ -227,7 +245,9 @@ public GeoCentroidAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public GeoCentroidAggregationDescriptor Field(Expression> field) { @@ -242,7 +262,10 @@ public GeoCentroidAggregationDescriptor Location(Elastic.Clients.Elasticsearch.S } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public GeoCentroidAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeoDistanceAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeoDistanceAggregate.g.cs index 66504e2ca74..df2c4d5c0ba 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeoDistanceAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeoDistanceAggregate.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; /// -/// Result of a `geo_distance` aggregation. The unit for `from` and `to` is meters by default. +/// +/// Result of a geo_distance aggregation. The unit for from and to is meters by default. +/// /// public sealed partial class GeoDistanceAggregate : IAggregate { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeoDistanceAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeoDistanceAggregation.g.cs index 05e60f90306..704e70503a9 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeoDistanceAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeoDistanceAggregation.g.cs @@ -30,31 +30,41 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class GeoDistanceAggregation { /// - /// The distance calculation type. + /// + /// The distance calculation type. + /// /// [JsonInclude, JsonPropertyName("distance_type")] public Elastic.Clients.Elasticsearch.Serverless.GeoDistanceType? DistanceType { get; set; } /// - /// A field of type `geo_point` used to evaluate the distance. + /// + /// A field of type geo_point used to evaluate the distance. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } /// - /// The origin used to evaluate the distance. + /// + /// The origin used to evaluate the distance. + /// /// [JsonInclude, JsonPropertyName("origin")] public Elastic.Clients.Elasticsearch.Serverless.GeoLocation? Origin { get; set; } /// - /// An array of ranges used to bucket documents. + /// + /// An array of ranges used to bucket documents. + /// /// [JsonInclude, JsonPropertyName("ranges")] public ICollection? Ranges { get; set; } /// - /// The distance unit. + /// + /// The distance unit. + /// /// [JsonInclude, JsonPropertyName("unit")] public Elastic.Clients.Elasticsearch.Serverless.DistanceUnit? Unit { get; set; } @@ -80,7 +90,9 @@ public GeoDistanceAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.DistanceUnit? UnitValue { get; set; } /// - /// The distance calculation type. + /// + /// The distance calculation type. + /// /// public GeoDistanceAggregationDescriptor DistanceType(Elastic.Clients.Elasticsearch.Serverless.GeoDistanceType? distanceType) { @@ -89,7 +101,9 @@ public GeoDistanceAggregationDescriptor DistanceType(Elastic.Clients. } /// - /// A field of type `geo_point` used to evaluate the distance. + /// + /// A field of type geo_point used to evaluate the distance. + /// /// public GeoDistanceAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -98,7 +112,9 @@ public GeoDistanceAggregationDescriptor Field(Elastic.Clients.Elastic } /// - /// A field of type `geo_point` used to evaluate the distance. + /// + /// A field of type geo_point used to evaluate the distance. + /// /// public GeoDistanceAggregationDescriptor Field(Expression> field) { @@ -107,7 +123,9 @@ public GeoDistanceAggregationDescriptor Field(Expression - /// A field of type `geo_point` used to evaluate the distance. + /// + /// A field of type geo_point used to evaluate the distance. + /// /// public GeoDistanceAggregationDescriptor Field(Expression> field) { @@ -116,7 +134,9 @@ public GeoDistanceAggregationDescriptor Field(Expression - /// The origin used to evaluate the distance. + /// + /// The origin used to evaluate the distance. + /// /// public GeoDistanceAggregationDescriptor Origin(Elastic.Clients.Elasticsearch.Serverless.GeoLocation? origin) { @@ -125,7 +145,9 @@ public GeoDistanceAggregationDescriptor Origin(Elastic.Clients.Elasti } /// - /// An array of ranges used to bucket documents. + /// + /// An array of ranges used to bucket documents. + /// /// public GeoDistanceAggregationDescriptor Ranges(ICollection? ranges) { @@ -164,7 +186,9 @@ public GeoDistanceAggregationDescriptor Ranges(params Action - /// The distance unit. + /// + /// The distance unit. + /// /// public GeoDistanceAggregationDescriptor Unit(Elastic.Clients.Elasticsearch.Serverless.DistanceUnit? unit) { @@ -252,7 +276,9 @@ public GeoDistanceAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.DistanceUnit? UnitValue { get; set; } /// - /// The distance calculation type. + /// + /// The distance calculation type. + /// /// public GeoDistanceAggregationDescriptor DistanceType(Elastic.Clients.Elasticsearch.Serverless.GeoDistanceType? distanceType) { @@ -261,7 +287,9 @@ public GeoDistanceAggregationDescriptor DistanceType(Elastic.Clients.Elasticsear } /// - /// A field of type `geo_point` used to evaluate the distance. + /// + /// A field of type geo_point used to evaluate the distance. + /// /// public GeoDistanceAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -270,7 +298,9 @@ public GeoDistanceAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serv } /// - /// A field of type `geo_point` used to evaluate the distance. + /// + /// A field of type geo_point used to evaluate the distance. + /// /// public GeoDistanceAggregationDescriptor Field(Expression> field) { @@ -279,7 +309,9 @@ public GeoDistanceAggregationDescriptor Field(Expression - /// A field of type `geo_point` used to evaluate the distance. + /// + /// A field of type geo_point used to evaluate the distance. + /// /// public GeoDistanceAggregationDescriptor Field(Expression> field) { @@ -288,7 +320,9 @@ public GeoDistanceAggregationDescriptor Field(Expression - /// The origin used to evaluate the distance. + /// + /// The origin used to evaluate the distance. + /// /// public GeoDistanceAggregationDescriptor Origin(Elastic.Clients.Elasticsearch.Serverless.GeoLocation? origin) { @@ -297,7 +331,9 @@ public GeoDistanceAggregationDescriptor Origin(Elastic.Clients.Elasticsearch.Ser } /// - /// An array of ranges used to bucket documents. + /// + /// An array of ranges used to bucket documents. + /// /// public GeoDistanceAggregationDescriptor Ranges(ICollection? ranges) { @@ -336,7 +372,9 @@ public GeoDistanceAggregationDescriptor Ranges(params Action - /// The distance unit. + /// + /// The distance unit. + /// /// public GeoDistanceAggregationDescriptor Unit(Elastic.Clients.Elasticsearch.Serverless.DistanceUnit? unit) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeoLineAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeoLineAggregation.g.cs index 02ef9aead37..190f4d4c11b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeoLineAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeoLineAggregation.g.cs @@ -30,31 +30,43 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class GeoLineAggregation { /// - /// When `true`, returns an additional array of the sort values in the feature properties. + /// + /// When true, returns an additional array of the sort values in the feature properties. + /// /// [JsonInclude, JsonPropertyName("include_sort")] public bool? IncludeSort { get; set; } /// - /// The name of the geo_point field. + /// + /// The name of the geo_point field. + /// /// [JsonInclude, JsonPropertyName("point")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.GeoLinePoint Point { get; set; } /// - /// The maximum length of the line represented in the aggregation.
Valid sizes are between 1 and 10000. + /// + /// The maximum length of the line represented in the aggregation. + /// Valid sizes are between 1 and 10000. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// The name of the numeric field to use as the sort key for ordering the points.
When the `geo_line` aggregation is nested inside a `time_series` aggregation, this field defaults to `@timestamp`, and any other value will result in error. + /// + /// The name of the numeric field to use as the sort key for ordering the points. + /// When the geo_line aggregation is nested inside a time_series aggregation, this field defaults to @timestamp, and any other value will result in error. + /// /// [JsonInclude, JsonPropertyName("sort")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.GeoLineSort Sort { get; set; } /// - /// The order in which the line is sorted (ascending or descending). + /// + /// The order in which the line is sorted (ascending or descending). + /// /// [JsonInclude, JsonPropertyName("sort_order")] public Elastic.Clients.Elasticsearch.Serverless.SortOrder? SortOrder { get; set; } @@ -79,7 +91,9 @@ public GeoLineAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.SortOrder? SortOrderValue { get; set; } /// - /// When `true`, returns an additional array of the sort values in the feature properties. + /// + /// When true, returns an additional array of the sort values in the feature properties. + /// /// public GeoLineAggregationDescriptor IncludeSort(bool? includeSort = true) { @@ -88,7 +102,9 @@ public GeoLineAggregationDescriptor IncludeSort(bool? includeSort = t } /// - /// The name of the geo_point field. + /// + /// The name of the geo_point field. + /// /// public GeoLineAggregationDescriptor Point(Elastic.Clients.Elasticsearch.Serverless.Aggregations.GeoLinePoint point) { @@ -115,7 +131,10 @@ public GeoLineAggregationDescriptor Point(Action - /// The maximum length of the line represented in the aggregation.
Valid sizes are between 1 and 10000. + /// + /// The maximum length of the line represented in the aggregation. + /// Valid sizes are between 1 and 10000. + /// /// public GeoLineAggregationDescriptor Size(int? size) { @@ -124,7 +143,10 @@ public GeoLineAggregationDescriptor Size(int? size) } /// - /// The name of the numeric field to use as the sort key for ordering the points.
When the `geo_line` aggregation is nested inside a `time_series` aggregation, this field defaults to `@timestamp`, and any other value will result in error. + /// + /// The name of the numeric field to use as the sort key for ordering the points. + /// When the geo_line aggregation is nested inside a time_series aggregation, this field defaults to @timestamp, and any other value will result in error. + /// /// public GeoLineAggregationDescriptor Sort(Elastic.Clients.Elasticsearch.Serverless.Aggregations.GeoLineSort sort) { @@ -151,7 +173,9 @@ public GeoLineAggregationDescriptor Sort(Action - /// The order in which the line is sorted (ascending or descending). + /// + /// The order in which the line is sorted (ascending or descending). + /// /// public GeoLineAggregationDescriptor SortOrder(Elastic.Clients.Elasticsearch.Serverless.SortOrder? sortOrder) { @@ -235,7 +259,9 @@ public GeoLineAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.SortOrder? SortOrderValue { get; set; } /// - /// When `true`, returns an additional array of the sort values in the feature properties. + /// + /// When true, returns an additional array of the sort values in the feature properties. + /// /// public GeoLineAggregationDescriptor IncludeSort(bool? includeSort = true) { @@ -244,7 +270,9 @@ public GeoLineAggregationDescriptor IncludeSort(bool? includeSort = true) } /// - /// The name of the geo_point field. + /// + /// The name of the geo_point field. + /// /// public GeoLineAggregationDescriptor Point(Elastic.Clients.Elasticsearch.Serverless.Aggregations.GeoLinePoint point) { @@ -271,7 +299,10 @@ public GeoLineAggregationDescriptor Point(Action - /// The maximum length of the line represented in the aggregation.
Valid sizes are between 1 and 10000. + /// + /// The maximum length of the line represented in the aggregation. + /// Valid sizes are between 1 and 10000. + /// /// public GeoLineAggregationDescriptor Size(int? size) { @@ -280,7 +311,10 @@ public GeoLineAggregationDescriptor Size(int? size) } /// - /// The name of the numeric field to use as the sort key for ordering the points.
When the `geo_line` aggregation is nested inside a `time_series` aggregation, this field defaults to `@timestamp`, and any other value will result in error. + /// + /// The name of the numeric field to use as the sort key for ordering the points. + /// When the geo_line aggregation is nested inside a time_series aggregation, this field defaults to @timestamp, and any other value will result in error. + /// /// public GeoLineAggregationDescriptor Sort(Elastic.Clients.Elasticsearch.Serverless.Aggregations.GeoLineSort sort) { @@ -307,7 +341,9 @@ public GeoLineAggregationDescriptor Sort(Action - /// The order in which the line is sorted (ascending or descending). + /// + /// The order in which the line is sorted (ascending or descending). + /// /// public GeoLineAggregationDescriptor SortOrder(Elastic.Clients.Elasticsearch.Serverless.SortOrder? sortOrder) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeoLinePoint.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeoLinePoint.g.cs index 6690961eeb7..b91af1b478e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeoLinePoint.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeoLinePoint.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class GeoLinePoint { /// - /// The name of the geo_point field. + /// + /// The name of the geo_point field. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } @@ -47,7 +49,9 @@ public GeoLinePointDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field FieldValue { get; set; } /// - /// The name of the geo_point field. + /// + /// The name of the geo_point field. + /// /// public GeoLinePointDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -56,7 +60,9 @@ public GeoLinePointDescriptor Field(Elastic.Clients.Elasticsearch.Ser } /// - /// The name of the geo_point field. + /// + /// The name of the geo_point field. + /// /// public GeoLinePointDescriptor Field(Expression> field) { @@ -65,7 +71,9 @@ public GeoLinePointDescriptor Field(Expression - /// The name of the geo_point field. + /// + /// The name of the geo_point field. + /// /// public GeoLinePointDescriptor Field(Expression> field) { @@ -93,7 +101,9 @@ public GeoLinePointDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field FieldValue { get; set; } /// - /// The name of the geo_point field. + /// + /// The name of the geo_point field. + /// /// public GeoLinePointDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -102,7 +112,9 @@ public GeoLinePointDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Fie } /// - /// The name of the geo_point field. + /// + /// The name of the geo_point field. + /// /// public GeoLinePointDescriptor Field(Expression> field) { @@ -111,7 +123,9 @@ public GeoLinePointDescriptor Field(Expression - /// The name of the geo_point field. + /// + /// The name of the geo_point field. + /// /// public GeoLinePointDescriptor Field(Expression> field) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeoLineSort.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeoLineSort.g.cs index 2bbe56ed8ea..c841571ce4a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeoLineSort.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeoLineSort.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class GeoLineSort { /// - /// The name of the numeric field to use as the sort key for ordering the points. + /// + /// The name of the numeric field to use as the sort key for ordering the points. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } @@ -47,7 +49,9 @@ public GeoLineSortDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field FieldValue { get; set; } /// - /// The name of the numeric field to use as the sort key for ordering the points. + /// + /// The name of the numeric field to use as the sort key for ordering the points. + /// /// public GeoLineSortDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -56,7 +60,9 @@ public GeoLineSortDescriptor Field(Elastic.Clients.Elasticsearch.Serv } /// - /// The name of the numeric field to use as the sort key for ordering the points. + /// + /// The name of the numeric field to use as the sort key for ordering the points. + /// /// public GeoLineSortDescriptor Field(Expression> field) { @@ -65,7 +71,9 @@ public GeoLineSortDescriptor Field(Expression - /// The name of the numeric field to use as the sort key for ordering the points. + /// + /// The name of the numeric field to use as the sort key for ordering the points. + /// /// public GeoLineSortDescriptor Field(Expression> field) { @@ -93,7 +101,9 @@ public GeoLineSortDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field FieldValue { get; set; } /// - /// The name of the numeric field to use as the sort key for ordering the points. + /// + /// The name of the numeric field to use as the sort key for ordering the points. + /// /// public GeoLineSortDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -102,7 +112,9 @@ public GeoLineSortDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Fiel } /// - /// The name of the numeric field to use as the sort key for ordering the points. + /// + /// The name of the numeric field to use as the sort key for ordering the points. + /// /// public GeoLineSortDescriptor Field(Expression> field) { @@ -111,7 +123,9 @@ public GeoLineSortDescriptor Field(Expression - /// The name of the numeric field to use as the sort key for ordering the points. + /// + /// The name of the numeric field to use as the sort key for ordering the points. + /// /// public GeoLineSortDescriptor Field(Expression> field) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeohashGridAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeohashGridAggregation.g.cs index 3f0e2cc3ad9..58ae2f5cc99 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeohashGridAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeohashGridAggregation.g.cs @@ -30,31 +30,43 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class GeohashGridAggregation { /// - /// The bounding box to filter the points in each bucket. + /// + /// The bounding box to filter the points in each bucket. + /// /// [JsonInclude, JsonPropertyName("bounds")] public Elastic.Clients.Elasticsearch.Serverless.GeoBounds? Bounds { get; set; } /// - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohash_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geohash_grid aggregates all array values. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } /// - /// The string length of the geohashes used to define cells/buckets in the results. + /// + /// The string length of the geohashes used to define cells/buckets in the results. + /// /// [JsonInclude, JsonPropertyName("precision")] public Elastic.Clients.Elasticsearch.Serverless.GeohashPrecision? Precision { get; set; } /// - /// Allows for more accurate counting of the top cells returned in the final result the aggregation.
Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. + /// + /// Allows for more accurate counting of the top cells returned in the final result the aggregation. + /// Defaults to returning max(10,(size x number-of-shards)) buckets from each shard. + /// /// [JsonInclude, JsonPropertyName("shard_size")] public int? ShardSize { get; set; } /// - /// The maximum number of geohash buckets to return. + /// + /// The maximum number of geohash buckets to return. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } @@ -77,7 +89,9 @@ public GeohashGridAggregationDescriptor() : base() private int? SizeValue { get; set; } /// - /// The bounding box to filter the points in each bucket. + /// + /// The bounding box to filter the points in each bucket. + /// /// public GeohashGridAggregationDescriptor Bounds(Elastic.Clients.Elasticsearch.Serverless.GeoBounds? bounds) { @@ -86,7 +100,10 @@ public GeohashGridAggregationDescriptor Bounds(Elastic.Clients.Elasti } /// - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohash_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geohash_grid aggregates all array values. + /// /// public GeohashGridAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -95,7 +112,10 @@ public GeohashGridAggregationDescriptor Field(Elastic.Clients.Elastic } /// - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohash_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geohash_grid aggregates all array values. + /// /// public GeohashGridAggregationDescriptor Field(Expression> field) { @@ -104,7 +124,10 @@ public GeohashGridAggregationDescriptor Field(Expression - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohash_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geohash_grid aggregates all array values. + /// /// public GeohashGridAggregationDescriptor Field(Expression> field) { @@ -113,7 +136,9 @@ public GeohashGridAggregationDescriptor Field(Expression - /// The string length of the geohashes used to define cells/buckets in the results. + /// + /// The string length of the geohashes used to define cells/buckets in the results. + /// /// public GeohashGridAggregationDescriptor Precision(Elastic.Clients.Elasticsearch.Serverless.GeohashPrecision? precision) { @@ -122,7 +147,10 @@ public GeohashGridAggregationDescriptor Precision(Elastic.Clients.Ela } /// - /// Allows for more accurate counting of the top cells returned in the final result the aggregation.
Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. + /// + /// Allows for more accurate counting of the top cells returned in the final result the aggregation. + /// Defaults to returning max(10,(size x number-of-shards)) buckets from each shard. + /// /// public GeohashGridAggregationDescriptor ShardSize(int? shardSize) { @@ -131,7 +159,9 @@ public GeohashGridAggregationDescriptor ShardSize(int? shardSize) } /// - /// The maximum number of geohash buckets to return. + /// + /// The maximum number of geohash buckets to return. + /// /// public GeohashGridAggregationDescriptor Size(int? size) { @@ -191,7 +221,9 @@ public GeohashGridAggregationDescriptor() : base() private int? SizeValue { get; set; } /// - /// The bounding box to filter the points in each bucket. + /// + /// The bounding box to filter the points in each bucket. + /// /// public GeohashGridAggregationDescriptor Bounds(Elastic.Clients.Elasticsearch.Serverless.GeoBounds? bounds) { @@ -200,7 +232,10 @@ public GeohashGridAggregationDescriptor Bounds(Elastic.Clients.Elasticsearch.Ser } /// - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohash_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geohash_grid aggregates all array values. + /// /// public GeohashGridAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -209,7 +244,10 @@ public GeohashGridAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serv } /// - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohash_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geohash_grid aggregates all array values. + /// /// public GeohashGridAggregationDescriptor Field(Expression> field) { @@ -218,7 +256,10 @@ public GeohashGridAggregationDescriptor Field(Expression - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohash_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geohash_grid aggregates all array values. + /// /// public GeohashGridAggregationDescriptor Field(Expression> field) { @@ -227,7 +268,9 @@ public GeohashGridAggregationDescriptor Field(Expression - /// The string length of the geohashes used to define cells/buckets in the results. + /// + /// The string length of the geohashes used to define cells/buckets in the results. + /// /// public GeohashGridAggregationDescriptor Precision(Elastic.Clients.Elasticsearch.Serverless.GeohashPrecision? precision) { @@ -236,7 +279,10 @@ public GeohashGridAggregationDescriptor Precision(Elastic.Clients.Elasticsearch. } /// - /// Allows for more accurate counting of the top cells returned in the final result the aggregation.
Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. + /// + /// Allows for more accurate counting of the top cells returned in the final result the aggregation. + /// Defaults to returning max(10,(size x number-of-shards)) buckets from each shard. + /// /// public GeohashGridAggregationDescriptor ShardSize(int? shardSize) { @@ -245,7 +291,9 @@ public GeohashGridAggregationDescriptor ShardSize(int? shardSize) } /// - /// The maximum number of geohash buckets to return. + /// + /// The maximum number of geohash buckets to return. + /// /// public GeohashGridAggregationDescriptor Size(int? size) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeohashGridBucket.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeohashGridBucket.g.cs index 2da0bf001a5..1bb531d814f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeohashGridBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeohashGridBucket.g.cs @@ -77,7 +77,9 @@ public override void Write(Utf8JsonWriter writer, GeohashGridBucket value, JsonS public sealed partial class GeohashGridBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeohexGridAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeohexGridAggregation.g.cs index 9f3271be624..06c865c90b0 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeohexGridAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeohexGridAggregation.g.cs @@ -30,31 +30,43 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class GeohexGridAggregation { /// - /// Bounding box used to filter the geo-points in each bucket. + /// + /// Bounding box used to filter the geo-points in each bucket. + /// /// [JsonInclude, JsonPropertyName("bounds")] public Elastic.Clients.Elasticsearch.Serverless.GeoBounds? Bounds { get; set; } /// - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohex_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geohex_grid aggregates all array values. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Integer zoom of the key used to defined cells or buckets
in the results. Value should be between 0-15. + /// + /// Integer zoom of the key used to defined cells or buckets + /// in the results. Value should be between 0-15. + /// /// [JsonInclude, JsonPropertyName("precision")] public int? Precision { get; set; } /// - /// Number of buckets returned from each shard. + /// + /// Number of buckets returned from each shard. + /// /// [JsonInclude, JsonPropertyName("shard_size")] public int? ShardSize { get; set; } /// - /// Maximum number of buckets to return. + /// + /// Maximum number of buckets to return. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } @@ -77,7 +89,9 @@ public GeohexGridAggregationDescriptor() : base() private int? SizeValue { get; set; } /// - /// Bounding box used to filter the geo-points in each bucket. + /// + /// Bounding box used to filter the geo-points in each bucket. + /// /// public GeohexGridAggregationDescriptor Bounds(Elastic.Clients.Elasticsearch.Serverless.GeoBounds? bounds) { @@ -86,7 +100,10 @@ public GeohexGridAggregationDescriptor Bounds(Elastic.Clients.Elastic } /// - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohex_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geohex_grid aggregates all array values. + /// /// public GeohexGridAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -95,7 +112,10 @@ public GeohexGridAggregationDescriptor Field(Elastic.Clients.Elastics } /// - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohex_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geohex_grid aggregates all array values. + /// /// public GeohexGridAggregationDescriptor Field(Expression> field) { @@ -104,7 +124,10 @@ public GeohexGridAggregationDescriptor Field(Expression - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohex_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geohex_grid aggregates all array values. + /// /// public GeohexGridAggregationDescriptor Field(Expression> field) { @@ -113,7 +136,10 @@ public GeohexGridAggregationDescriptor Field(Expression - /// Integer zoom of the key used to defined cells or buckets
in the results. Value should be between 0-15. + /// + /// Integer zoom of the key used to defined cells or buckets + /// in the results. Value should be between 0-15. + /// /// public GeohexGridAggregationDescriptor Precision(int? precision) { @@ -122,7 +148,9 @@ public GeohexGridAggregationDescriptor Precision(int? precision) } /// - /// Number of buckets returned from each shard. + /// + /// Number of buckets returned from each shard. + /// /// public GeohexGridAggregationDescriptor ShardSize(int? shardSize) { @@ -131,7 +159,9 @@ public GeohexGridAggregationDescriptor ShardSize(int? shardSize) } /// - /// Maximum number of buckets to return. + /// + /// Maximum number of buckets to return. + /// /// public GeohexGridAggregationDescriptor Size(int? size) { @@ -187,7 +217,9 @@ public GeohexGridAggregationDescriptor() : base() private int? SizeValue { get; set; } /// - /// Bounding box used to filter the geo-points in each bucket. + /// + /// Bounding box used to filter the geo-points in each bucket. + /// /// public GeohexGridAggregationDescriptor Bounds(Elastic.Clients.Elasticsearch.Serverless.GeoBounds? bounds) { @@ -196,7 +228,10 @@ public GeohexGridAggregationDescriptor Bounds(Elastic.Clients.Elasticsearch.Serv } /// - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohex_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geohex_grid aggregates all array values. + /// /// public GeohexGridAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -205,7 +240,10 @@ public GeohexGridAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serve } /// - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohex_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geohex_grid aggregates all array values. + /// /// public GeohexGridAggregationDescriptor Field(Expression> field) { @@ -214,7 +252,10 @@ public GeohexGridAggregationDescriptor Field(Expression - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohex_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geohex_grid aggregates all array values. + /// /// public GeohexGridAggregationDescriptor Field(Expression> field) { @@ -223,7 +264,10 @@ public GeohexGridAggregationDescriptor Field(Expression - /// Integer zoom of the key used to defined cells or buckets
in the results. Value should be between 0-15. + /// + /// Integer zoom of the key used to defined cells or buckets + /// in the results. Value should be between 0-15. + /// /// public GeohexGridAggregationDescriptor Precision(int? precision) { @@ -232,7 +276,9 @@ public GeohexGridAggregationDescriptor Precision(int? precision) } /// - /// Number of buckets returned from each shard. + /// + /// Number of buckets returned from each shard. + /// /// public GeohexGridAggregationDescriptor ShardSize(int? shardSize) { @@ -241,7 +287,9 @@ public GeohexGridAggregationDescriptor ShardSize(int? shardSize) } /// - /// Maximum number of buckets to return. + /// + /// Maximum number of buckets to return. + /// /// public GeohexGridAggregationDescriptor Size(int? size) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeohexGridBucket.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeohexGridBucket.g.cs index b209a3d44ec..5878ecf1f79 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeohexGridBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeohexGridBucket.g.cs @@ -77,7 +77,9 @@ public override void Write(Utf8JsonWriter writer, GeohexGridBucket value, JsonSe public sealed partial class GeohexGridBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeotileGridAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeotileGridAggregation.g.cs index da67eceef79..18d182ef309 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeotileGridAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeotileGridAggregation.g.cs @@ -30,31 +30,44 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class GeotileGridAggregation { /// - /// A bounding box to filter the geo-points or geo-shapes in each bucket. + /// + /// A bounding box to filter the geo-points or geo-shapes in each bucket. + /// /// [JsonInclude, JsonPropertyName("bounds")] public Elastic.Clients.Elasticsearch.Serverless.GeoBounds? Bounds { get; set; } /// - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geotile_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geotile_grid aggregates all array values. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } /// - /// Integer zoom of the key used to define cells/buckets in the results.
Values outside of the range [0,29] will be rejected. + /// + /// Integer zoom of the key used to define cells/buckets in the results. + /// Values outside of the range [0,29] will be rejected. + /// /// [JsonInclude, JsonPropertyName("precision")] public double? Precision { get; set; } /// - /// Allows for more accurate counting of the top cells returned in the final result the aggregation.
Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. + /// + /// Allows for more accurate counting of the top cells returned in the final result the aggregation. + /// Defaults to returning max(10,(size x number-of-shards)) buckets from each shard. + /// /// [JsonInclude, JsonPropertyName("shard_size")] public int? ShardSize { get; set; } /// - /// The maximum number of buckets to return. + /// + /// The maximum number of buckets to return. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } @@ -78,7 +91,9 @@ public GeotileGridAggregationDescriptor() : base() private int? SizeValue { get; set; } /// - /// A bounding box to filter the geo-points or geo-shapes in each bucket. + /// + /// A bounding box to filter the geo-points or geo-shapes in each bucket. + /// /// public GeotileGridAggregationDescriptor Bounds(Elastic.Clients.Elasticsearch.Serverless.GeoBounds? bounds) { @@ -87,7 +102,10 @@ public GeotileGridAggregationDescriptor Bounds(Elastic.Clients.Elasti } /// - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geotile_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geotile_grid aggregates all array values. + /// /// public GeotileGridAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -96,7 +114,10 @@ public GeotileGridAggregationDescriptor Field(Elastic.Clients.Elastic } /// - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geotile_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geotile_grid aggregates all array values. + /// /// public GeotileGridAggregationDescriptor Field(Expression> field) { @@ -105,7 +126,10 @@ public GeotileGridAggregationDescriptor Field(Expression - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geotile_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geotile_grid aggregates all array values. + /// /// public GeotileGridAggregationDescriptor Field(Expression> field) { @@ -114,7 +138,10 @@ public GeotileGridAggregationDescriptor Field(Expression - /// Integer zoom of the key used to define cells/buckets in the results.
Values outside of the range [0,29] will be rejected. + /// + /// Integer zoom of the key used to define cells/buckets in the results. + /// Values outside of the range [0,29] will be rejected. + /// /// public GeotileGridAggregationDescriptor Precision(double? precision) { @@ -123,7 +150,10 @@ public GeotileGridAggregationDescriptor Precision(double? precision) } /// - /// Allows for more accurate counting of the top cells returned in the final result the aggregation.
Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. + /// + /// Allows for more accurate counting of the top cells returned in the final result the aggregation. + /// Defaults to returning max(10,(size x number-of-shards)) buckets from each shard. + /// /// public GeotileGridAggregationDescriptor ShardSize(int? shardSize) { @@ -132,7 +162,9 @@ public GeotileGridAggregationDescriptor ShardSize(int? shardSize) } /// - /// The maximum number of buckets to return. + /// + /// The maximum number of buckets to return. + /// /// public GeotileGridAggregationDescriptor Size(int? size) { @@ -192,7 +224,9 @@ public GeotileGridAggregationDescriptor() : base() private int? SizeValue { get; set; } /// - /// A bounding box to filter the geo-points or geo-shapes in each bucket. + /// + /// A bounding box to filter the geo-points or geo-shapes in each bucket. + /// /// public GeotileGridAggregationDescriptor Bounds(Elastic.Clients.Elasticsearch.Serverless.GeoBounds? bounds) { @@ -201,7 +235,10 @@ public GeotileGridAggregationDescriptor Bounds(Elastic.Clients.Elasticsearch.Ser } /// - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geotile_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geotile_grid aggregates all array values. + /// /// public GeotileGridAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -210,7 +247,10 @@ public GeotileGridAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serv } /// - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geotile_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geotile_grid aggregates all array values. + /// /// public GeotileGridAggregationDescriptor Field(Expression> field) { @@ -219,7 +259,10 @@ public GeotileGridAggregationDescriptor Field(Expression - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geotile_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geotile_grid aggregates all array values. + /// /// public GeotileGridAggregationDescriptor Field(Expression> field) { @@ -228,7 +271,10 @@ public GeotileGridAggregationDescriptor Field(Expression - /// Integer zoom of the key used to define cells/buckets in the results.
Values outside of the range [0,29] will be rejected. + /// + /// Integer zoom of the key used to define cells/buckets in the results. + /// Values outside of the range [0,29] will be rejected. + /// /// public GeotileGridAggregationDescriptor Precision(double? precision) { @@ -237,7 +283,10 @@ public GeotileGridAggregationDescriptor Precision(double? precision) } /// - /// Allows for more accurate counting of the top cells returned in the final result the aggregation.
Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. + /// + /// Allows for more accurate counting of the top cells returned in the final result the aggregation. + /// Defaults to returning max(10,(size x number-of-shards)) buckets from each shard. + /// /// public GeotileGridAggregationDescriptor ShardSize(int? shardSize) { @@ -246,7 +295,9 @@ public GeotileGridAggregationDescriptor ShardSize(int? shardSize) } /// - /// The maximum number of buckets to return. + /// + /// The maximum number of buckets to return. + /// /// public GeotileGridAggregationDescriptor Size(int? size) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeotileGridBucket.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeotileGridBucket.g.cs index 6dd85f2d912..cfcaeda800e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeotileGridBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GeotileGridBucket.g.cs @@ -77,7 +77,9 @@ public override void Write(Utf8JsonWriter writer, GeotileGridBucket value, JsonS public sealed partial class GeotileGridBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GlobalAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GlobalAggregate.g.cs index 143b11cad28..d20cbd31f1c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GlobalAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GlobalAggregate.g.cs @@ -77,7 +77,9 @@ public override void Write(Utf8JsonWriter writer, GlobalAggregate value, JsonSer public sealed partial class GlobalAggregate : IAggregate { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GoogleNormalizedDistanceHeuristic.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GoogleNormalizedDistanceHeuristic.g.cs index 6592bf20a7e..1c2904f0f6c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GoogleNormalizedDistanceHeuristic.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/GoogleNormalizedDistanceHeuristic.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class GoogleNormalizedDistanceHeuristic { /// - /// Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. + /// + /// Set to false if you defined a custom background filter that represents a different set of documents that you want to compare to. + /// /// [JsonInclude, JsonPropertyName("background_is_superset")] public bool? BackgroundIsSuperset { get; set; } @@ -47,7 +49,9 @@ public GoogleNormalizedDistanceHeuristicDescriptor() : base() private bool? BackgroundIsSupersetValue { get; set; } /// - /// Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. + /// + /// Set to false if you defined a custom background filter that represents a different set of documents that you want to compare to. + /// /// public GoogleNormalizedDistanceHeuristicDescriptor BackgroundIsSuperset(bool? backgroundIsSuperset = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/HdrMethod.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/HdrMethod.g.cs index 47289ba1914..49a13fbb1ca 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/HdrMethod.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/HdrMethod.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class HdrMethod { /// - /// Specifies the resolution of values for the histogram in number of significant digits. + /// + /// Specifies the resolution of values for the histogram in number of significant digits. + /// /// [JsonInclude, JsonPropertyName("number_of_significant_value_digits")] public int? NumberOfSignificantValueDigits { get; set; } @@ -47,7 +49,9 @@ public HdrMethodDescriptor() : base() private int? NumberOfSignificantValueDigitsValue { get; set; } /// - /// Specifies the resolution of values for the histogram in number of significant digits. + /// + /// Specifies the resolution of values for the histogram in number of significant digits. + /// /// public HdrMethodDescriptor NumberOfSignificantValueDigits(int? numberOfSignificantValueDigits) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/HistogramAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/HistogramAggregation.g.cs index ef8cdc1526c..35865ac046e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/HistogramAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/HistogramAggregation.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class HistogramAggregation { /// - /// Enables extending the bounds of the histogram beyond the data itself. + /// + /// Enables extending the bounds of the histogram beyond the data itself. + /// /// [JsonInclude, JsonPropertyName("extended_bounds")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.ExtendedBoundsFloat? ExtendedBounds { get; set; } /// - /// The name of the field to aggregate on. + /// + /// The name of the field to aggregate on. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } @@ -44,37 +48,55 @@ public sealed partial class HistogramAggregation public string? Format { get; set; } /// - /// Limits the range of buckets in the histogram.
It is particularly useful in the case of open data ranges that can result in a very large number of buckets. + /// + /// Limits the range of buckets in the histogram. + /// It is particularly useful in the case of open data ranges that can result in a very large number of buckets. + /// /// [JsonInclude, JsonPropertyName("hard_bounds")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.ExtendedBoundsFloat? HardBounds { get; set; } /// - /// The interval for the buckets.
Must be a positive decimal. + /// + /// The interval for the buckets. + /// Must be a positive decimal. + /// /// [JsonInclude, JsonPropertyName("interval")] public double? Interval { get; set; } /// - /// Only returns buckets that have `min_doc_count` number of documents.
By default, the response will fill gaps in the histogram with empty buckets. + /// + /// Only returns buckets that have min_doc_count number of documents. + /// By default, the response will fill gaps in the histogram with empty buckets. + /// /// [JsonInclude, JsonPropertyName("min_doc_count")] public int? MinDocCount { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public double? Missing { get; set; } /// - /// By default, the bucket keys start with 0 and then continue in even spaced steps of `interval`.
The bucket boundaries can be shifted by using the `offset` option. + /// + /// By default, the bucket keys start with 0 and then continue in even spaced steps of interval. + /// The bucket boundaries can be shifted by using the offset option. + /// /// [JsonInclude, JsonPropertyName("offset")] public double? Offset { get; set; } /// - /// The sort order of the returned buckets.
By default, the returned buckets are sorted by their key ascending. + /// + /// The sort order of the returned buckets. + /// By default, the returned buckets are sorted by their key ascending. + /// /// [JsonInclude, JsonPropertyName("order")] [SingleOrManyCollectionConverter(typeof(KeyValuePair))] @@ -112,7 +134,9 @@ public HistogramAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// Enables extending the bounds of the histogram beyond the data itself. + /// + /// Enables extending the bounds of the histogram beyond the data itself. + /// /// public HistogramAggregationDescriptor ExtendedBounds(Elastic.Clients.Elasticsearch.Serverless.Aggregations.ExtendedBoundsFloat? extendedBounds) { @@ -139,7 +163,9 @@ public HistogramAggregationDescriptor ExtendedBounds(Action - /// The name of the field to aggregate on. + /// + /// The name of the field to aggregate on. + /// /// public HistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -148,7 +174,9 @@ public HistogramAggregationDescriptor Field(Elastic.Clients.Elasticse } /// - /// The name of the field to aggregate on. + /// + /// The name of the field to aggregate on. + /// /// public HistogramAggregationDescriptor Field(Expression> field) { @@ -157,7 +185,9 @@ public HistogramAggregationDescriptor Field(Expression - /// The name of the field to aggregate on. + /// + /// The name of the field to aggregate on. + /// /// public HistogramAggregationDescriptor Field(Expression> field) { @@ -172,7 +202,10 @@ public HistogramAggregationDescriptor Format(string? format) } /// - /// Limits the range of buckets in the histogram.
It is particularly useful in the case of open data ranges that can result in a very large number of buckets. + /// + /// Limits the range of buckets in the histogram. + /// It is particularly useful in the case of open data ranges that can result in a very large number of buckets. + /// /// public HistogramAggregationDescriptor HardBounds(Elastic.Clients.Elasticsearch.Serverless.Aggregations.ExtendedBoundsFloat? hardBounds) { @@ -199,7 +232,10 @@ public HistogramAggregationDescriptor HardBounds(Action - /// The interval for the buckets.
Must be a positive decimal. + /// + /// The interval for the buckets. + /// Must be a positive decimal. + /// /// public HistogramAggregationDescriptor Interval(double? interval) { @@ -208,7 +244,10 @@ public HistogramAggregationDescriptor Interval(double? interval) } /// - /// Only returns buckets that have `min_doc_count` number of documents.
By default, the response will fill gaps in the histogram with empty buckets. + /// + /// Only returns buckets that have min_doc_count number of documents. + /// By default, the response will fill gaps in the histogram with empty buckets. + /// /// public HistogramAggregationDescriptor MinDocCount(int? minDocCount) { @@ -217,7 +256,10 @@ public HistogramAggregationDescriptor MinDocCount(int? minDocCount) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public HistogramAggregationDescriptor Missing(double? missing) { @@ -226,7 +268,10 @@ public HistogramAggregationDescriptor Missing(double? missing) } /// - /// By default, the bucket keys start with 0 and then continue in even spaced steps of `interval`.
The bucket boundaries can be shifted by using the `offset` option. + /// + /// By default, the bucket keys start with 0 and then continue in even spaced steps of interval. + /// The bucket boundaries can be shifted by using the offset option. + /// /// public HistogramAggregationDescriptor Offset(double? offset) { @@ -235,7 +280,10 @@ public HistogramAggregationDescriptor Offset(double? offset) } /// - /// The sort order of the returned buckets.
By default, the returned buckets are sorted by their key ascending. + /// + /// The sort order of the returned buckets. + /// By default, the returned buckets are sorted by their key ascending. + /// /// public HistogramAggregationDescriptor Order(ICollection>? order) { @@ -390,7 +438,9 @@ public HistogramAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// Enables extending the bounds of the histogram beyond the data itself. + /// + /// Enables extending the bounds of the histogram beyond the data itself. + /// /// public HistogramAggregationDescriptor ExtendedBounds(Elastic.Clients.Elasticsearch.Serverless.Aggregations.ExtendedBoundsFloat? extendedBounds) { @@ -417,7 +467,9 @@ public HistogramAggregationDescriptor ExtendedBounds(Action - /// The name of the field to aggregate on. + /// + /// The name of the field to aggregate on. + /// /// public HistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -426,7 +478,9 @@ public HistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Server } /// - /// The name of the field to aggregate on. + /// + /// The name of the field to aggregate on. + /// /// public HistogramAggregationDescriptor Field(Expression> field) { @@ -435,7 +489,9 @@ public HistogramAggregationDescriptor Field(Expression - /// The name of the field to aggregate on. + /// + /// The name of the field to aggregate on. + /// /// public HistogramAggregationDescriptor Field(Expression> field) { @@ -450,7 +506,10 @@ public HistogramAggregationDescriptor Format(string? format) } /// - /// Limits the range of buckets in the histogram.
It is particularly useful in the case of open data ranges that can result in a very large number of buckets. + /// + /// Limits the range of buckets in the histogram. + /// It is particularly useful in the case of open data ranges that can result in a very large number of buckets. + /// /// public HistogramAggregationDescriptor HardBounds(Elastic.Clients.Elasticsearch.Serverless.Aggregations.ExtendedBoundsFloat? hardBounds) { @@ -477,7 +536,10 @@ public HistogramAggregationDescriptor HardBounds(Action - /// The interval for the buckets.
Must be a positive decimal. + /// + /// The interval for the buckets. + /// Must be a positive decimal. + /// /// public HistogramAggregationDescriptor Interval(double? interval) { @@ -486,7 +548,10 @@ public HistogramAggregationDescriptor Interval(double? interval) } /// - /// Only returns buckets that have `min_doc_count` number of documents.
By default, the response will fill gaps in the histogram with empty buckets. + /// + /// Only returns buckets that have min_doc_count number of documents. + /// By default, the response will fill gaps in the histogram with empty buckets. + /// /// public HistogramAggregationDescriptor MinDocCount(int? minDocCount) { @@ -495,7 +560,10 @@ public HistogramAggregationDescriptor MinDocCount(int? minDocCount) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public HistogramAggregationDescriptor Missing(double? missing) { @@ -504,7 +572,10 @@ public HistogramAggregationDescriptor Missing(double? missing) } /// - /// By default, the bucket keys start with 0 and then continue in even spaced steps of `interval`.
The bucket boundaries can be shifted by using the `offset` option. + /// + /// By default, the bucket keys start with 0 and then continue in even spaced steps of interval. + /// The bucket boundaries can be shifted by using the offset option. + /// /// public HistogramAggregationDescriptor Offset(double? offset) { @@ -513,7 +584,10 @@ public HistogramAggregationDescriptor Offset(double? offset) } /// - /// The sort order of the returned buckets.
By default, the returned buckets are sorted by their key ascending. + /// + /// The sort order of the returned buckets. + /// By default, the returned buckets are sorted by their key ascending. + /// /// public HistogramAggregationDescriptor Order(ICollection>? order) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/HistogramBucket.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/HistogramBucket.g.cs index 4add224991a..fe02969739e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/HistogramBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/HistogramBucket.g.cs @@ -84,7 +84,9 @@ public override void Write(Utf8JsonWriter writer, HistogramBucket value, JsonSer public sealed partial class HistogramBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/InferenceAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/InferenceAggregate.g.cs index 7ac285b7fb5..c181704ab19 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/InferenceAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/InferenceAggregate.g.cs @@ -93,7 +93,9 @@ public override void Write(Utf8JsonWriter writer, InferenceAggregate value, Json public sealed partial class InferenceAggregate : IAggregate { /// - /// Additional data + /// + /// Additional data + /// /// public IReadOnlyDictionary Data { get; init; } public IReadOnlyCollection? FeatureImportance { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/InferenceAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/InferenceAggregation.g.cs index d2d7345c81f..b34d2de30f2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/InferenceAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/InferenceAggregation.g.cs @@ -30,31 +30,42 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class InferenceAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? GapPolicy { get; set; } /// - /// Contains the inference type and its options. + /// + /// Contains the inference type and its options. + /// /// [JsonInclude, JsonPropertyName("inference_config")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.InferenceConfig? InferenceConfig { get; set; } /// - /// The ID or alias for the trained model. + /// + /// The ID or alias for the trained model. + /// /// [JsonInclude, JsonPropertyName("model_id")] public Elastic.Clients.Elasticsearch.Serverless.Name ModelId { get; set; } @@ -79,7 +90,9 @@ public InferenceAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Name ModelIdValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public InferenceAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? bucketsPath) { @@ -88,7 +101,10 @@ public InferenceAggregationDescriptor BucketsPath(Elastic.Clients.Ela } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public InferenceAggregationDescriptor Format(string? format) { @@ -97,7 +113,9 @@ public InferenceAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public InferenceAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? gapPolicy) { @@ -106,7 +124,9 @@ public InferenceAggregationDescriptor GapPolicy(Elastic.Clients.Elast } /// - /// Contains the inference type and its options. + /// + /// Contains the inference type and its options. + /// /// public InferenceAggregationDescriptor InferenceConfig(Elastic.Clients.Elasticsearch.Serverless.Aggregations.InferenceConfig? inferenceConfig) { @@ -133,7 +153,9 @@ public InferenceAggregationDescriptor InferenceConfig(Action - /// The ID or alias for the trained model. + /// + /// The ID or alias for the trained model. + /// /// public InferenceAggregationDescriptor ModelId(Elastic.Clients.Elasticsearch.Serverless.Name modelId) { @@ -201,7 +223,9 @@ public InferenceAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Name ModelIdValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public InferenceAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? bucketsPath) { @@ -210,7 +234,10 @@ public InferenceAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch. } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public InferenceAggregationDescriptor Format(string? format) { @@ -219,7 +246,9 @@ public InferenceAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public InferenceAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? gapPolicy) { @@ -228,7 +257,9 @@ public InferenceAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Se } /// - /// Contains the inference type and its options. + /// + /// Contains the inference type and its options. + /// /// public InferenceAggregationDescriptor InferenceConfig(Elastic.Clients.Elasticsearch.Serverless.Aggregations.InferenceConfig? inferenceConfig) { @@ -255,7 +286,9 @@ public InferenceAggregationDescriptor InferenceConfig(Action - /// The ID or alias for the trained model. + /// + /// The ID or alias for the trained model. + /// /// public InferenceAggregationDescriptor ModelId(Elastic.Clients.Elasticsearch.Serverless.Name modelId) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/IpPrefixAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/IpPrefixAggregation.g.cs index a425dd00f19..c3de028c560 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/IpPrefixAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/IpPrefixAggregation.g.cs @@ -30,31 +30,42 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class IpPrefixAggregation { /// - /// Defines whether the prefix length is appended to IP address keys in the response. + /// + /// Defines whether the prefix length is appended to IP address keys in the response. + /// /// [JsonInclude, JsonPropertyName("append_prefix_length")] public bool? AppendPrefixLength { get; set; } /// - /// The IP address field to aggregation on. The field mapping type must be `ip`. + /// + /// The IP address field to aggregation on. The field mapping type must be ip. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Defines whether the prefix applies to IPv6 addresses. + /// + /// Defines whether the prefix applies to IPv6 addresses. + /// /// [JsonInclude, JsonPropertyName("is_ipv6")] public bool? IsIpv6 { get; set; } /// - /// Minimum number of documents in a bucket for it to be included in the response. + /// + /// Minimum number of documents in a bucket for it to be included in the response. + /// /// [JsonInclude, JsonPropertyName("min_doc_count")] public long? MinDocCount { get; set; } /// - /// Length of the network prefix. For IPv4 addresses the accepted range is [0, 32].
For IPv6 addresses the accepted range is [0, 128]. + /// + /// Length of the network prefix. For IPv4 addresses the accepted range is [0, 32]. + /// For IPv6 addresses the accepted range is [0, 128]. + /// /// [JsonInclude, JsonPropertyName("prefix_length")] public int PrefixLength { get; set; } @@ -77,7 +88,9 @@ public IpPrefixAggregationDescriptor() : base() private int PrefixLengthValue { get; set; } /// - /// Defines whether the prefix length is appended to IP address keys in the response. + /// + /// Defines whether the prefix length is appended to IP address keys in the response. + /// /// public IpPrefixAggregationDescriptor AppendPrefixLength(bool? appendPrefixLength = true) { @@ -86,7 +99,9 @@ public IpPrefixAggregationDescriptor AppendPrefixLength(bool? appendP } /// - /// The IP address field to aggregation on. The field mapping type must be `ip`. + /// + /// The IP address field to aggregation on. The field mapping type must be ip. + /// /// public IpPrefixAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -95,7 +110,9 @@ public IpPrefixAggregationDescriptor Field(Elastic.Clients.Elasticsea } /// - /// The IP address field to aggregation on. The field mapping type must be `ip`. + /// + /// The IP address field to aggregation on. The field mapping type must be ip. + /// /// public IpPrefixAggregationDescriptor Field(Expression> field) { @@ -104,7 +121,9 @@ public IpPrefixAggregationDescriptor Field(Expression - /// The IP address field to aggregation on. The field mapping type must be `ip`. + /// + /// The IP address field to aggregation on. The field mapping type must be ip. + /// /// public IpPrefixAggregationDescriptor Field(Expression> field) { @@ -113,7 +132,9 @@ public IpPrefixAggregationDescriptor Field(Expression - /// Defines whether the prefix applies to IPv6 addresses. + /// + /// Defines whether the prefix applies to IPv6 addresses. + /// /// public IpPrefixAggregationDescriptor IsIpv6(bool? isIpv6 = true) { @@ -122,7 +143,9 @@ public IpPrefixAggregationDescriptor IsIpv6(bool? isIpv6 = true) } /// - /// Minimum number of documents in a bucket for it to be included in the response. + /// + /// Minimum number of documents in a bucket for it to be included in the response. + /// /// public IpPrefixAggregationDescriptor MinDocCount(long? minDocCount) { @@ -131,7 +154,10 @@ public IpPrefixAggregationDescriptor MinDocCount(long? minDocCount) } /// - /// Length of the network prefix. For IPv4 addresses the accepted range is [0, 32].
For IPv6 addresses the accepted range is [0, 128]. + /// + /// Length of the network prefix. For IPv4 addresses the accepted range is [0, 32]. + /// For IPv6 addresses the accepted range is [0, 128]. + /// /// public IpPrefixAggregationDescriptor PrefixLength(int prefixLength) { @@ -183,7 +209,9 @@ public IpPrefixAggregationDescriptor() : base() private int PrefixLengthValue { get; set; } /// - /// Defines whether the prefix length is appended to IP address keys in the response. + /// + /// Defines whether the prefix length is appended to IP address keys in the response. + /// /// public IpPrefixAggregationDescriptor AppendPrefixLength(bool? appendPrefixLength = true) { @@ -192,7 +220,9 @@ public IpPrefixAggregationDescriptor AppendPrefixLength(bool? appendPrefixLength } /// - /// The IP address field to aggregation on. The field mapping type must be `ip`. + /// + /// The IP address field to aggregation on. The field mapping type must be ip. + /// /// public IpPrefixAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -201,7 +231,9 @@ public IpPrefixAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverl } /// - /// The IP address field to aggregation on. The field mapping type must be `ip`. + /// + /// The IP address field to aggregation on. The field mapping type must be ip. + /// /// public IpPrefixAggregationDescriptor Field(Expression> field) { @@ -210,7 +242,9 @@ public IpPrefixAggregationDescriptor Field(Expression - /// The IP address field to aggregation on. The field mapping type must be `ip`. + /// + /// The IP address field to aggregation on. The field mapping type must be ip. + /// /// public IpPrefixAggregationDescriptor Field(Expression> field) { @@ -219,7 +253,9 @@ public IpPrefixAggregationDescriptor Field(Expression - /// Defines whether the prefix applies to IPv6 addresses. + /// + /// Defines whether the prefix applies to IPv6 addresses. + /// /// public IpPrefixAggregationDescriptor IsIpv6(bool? isIpv6 = true) { @@ -228,7 +264,9 @@ public IpPrefixAggregationDescriptor IsIpv6(bool? isIpv6 = true) } /// - /// Minimum number of documents in a bucket for it to be included in the response. + /// + /// Minimum number of documents in a bucket for it to be included in the response. + /// /// public IpPrefixAggregationDescriptor MinDocCount(long? minDocCount) { @@ -237,7 +275,10 @@ public IpPrefixAggregationDescriptor MinDocCount(long? minDocCount) } /// - /// Length of the network prefix. For IPv4 addresses the accepted range is [0, 32].
For IPv6 addresses the accepted range is [0, 128]. + /// + /// Length of the network prefix. For IPv4 addresses the accepted range is [0, 32]. + /// For IPv6 addresses the accepted range is [0, 128]. + /// /// public IpPrefixAggregationDescriptor PrefixLength(int prefixLength) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/IpPrefixBucket.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/IpPrefixBucket.g.cs index 3a1a038cffd..8ad90a71f6b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/IpPrefixBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/IpPrefixBucket.g.cs @@ -98,7 +98,9 @@ public override void Write(Utf8JsonWriter writer, IpPrefixBucket value, JsonSeri public sealed partial class IpPrefixBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/IpRangeAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/IpRangeAggregation.g.cs index b33901bb662..daa1f0b6788 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/IpRangeAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/IpRangeAggregation.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class IpRangeAggregation { /// - /// The date field whose values are used to build ranges. + /// + /// The date field whose values are used to build ranges. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } /// - /// Array of IP ranges. + /// + /// Array of IP ranges. + /// /// [JsonInclude, JsonPropertyName("ranges")] public ICollection? Ranges { get; set; } @@ -59,7 +63,9 @@ public IpRangeAggregationDescriptor() : base() private Action[] RangesDescriptorActions { get; set; } /// - /// The date field whose values are used to build ranges. + /// + /// The date field whose values are used to build ranges. + /// /// public IpRangeAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -68,7 +74,9 @@ public IpRangeAggregationDescriptor Field(Elastic.Clients.Elasticsear } /// - /// The date field whose values are used to build ranges. + /// + /// The date field whose values are used to build ranges. + /// /// public IpRangeAggregationDescriptor Field(Expression> field) { @@ -77,7 +85,9 @@ public IpRangeAggregationDescriptor Field(Expression - /// The date field whose values are used to build ranges. + /// + /// The date field whose values are used to build ranges. + /// /// public IpRangeAggregationDescriptor Field(Expression> field) { @@ -86,7 +96,9 @@ public IpRangeAggregationDescriptor Field(Expression - /// Array of IP ranges. + /// + /// Array of IP ranges. + /// /// public IpRangeAggregationDescriptor Ranges(ICollection? ranges) { @@ -183,7 +195,9 @@ public IpRangeAggregationDescriptor() : base() private Action[] RangesDescriptorActions { get; set; } /// - /// The date field whose values are used to build ranges. + /// + /// The date field whose values are used to build ranges. + /// /// public IpRangeAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -192,7 +206,9 @@ public IpRangeAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverle } /// - /// The date field whose values are used to build ranges. + /// + /// The date field whose values are used to build ranges. + /// /// public IpRangeAggregationDescriptor Field(Expression> field) { @@ -201,7 +217,9 @@ public IpRangeAggregationDescriptor Field(Expression - /// The date field whose values are used to build ranges. + /// + /// The date field whose values are used to build ranges. + /// /// public IpRangeAggregationDescriptor Field(Expression> field) { @@ -210,7 +228,9 @@ public IpRangeAggregationDescriptor Field(Expression - /// Array of IP ranges. + /// + /// Array of IP ranges. + /// /// public IpRangeAggregationDescriptor Ranges(ICollection? ranges) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/IpRangeAggregationRange.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/IpRangeAggregationRange.g.cs index 520fda546e5..5258d7ee53b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/IpRangeAggregationRange.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/IpRangeAggregationRange.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class IpRangeAggregationRange { /// - /// Start of the range. + /// + /// Start of the range. + /// /// [JsonInclude, JsonPropertyName("from")] public string? From { get; set; } /// - /// IP range defined as a CIDR mask. + /// + /// IP range defined as a CIDR mask. + /// /// [JsonInclude, JsonPropertyName("mask")] public string? Mask { get; set; } /// - /// End of the range. + /// + /// End of the range. + /// /// [JsonInclude, JsonPropertyName("to")] public string? To { get; set; } @@ -61,7 +67,9 @@ public IpRangeAggregationRangeDescriptor() : base() private string? ToValue { get; set; } /// - /// Start of the range. + /// + /// Start of the range. + /// /// public IpRangeAggregationRangeDescriptor From(string? from) { @@ -70,7 +78,9 @@ public IpRangeAggregationRangeDescriptor From(string? from) } /// - /// IP range defined as a CIDR mask. + /// + /// IP range defined as a CIDR mask. + /// /// public IpRangeAggregationRangeDescriptor Mask(string? mask) { @@ -79,7 +89,9 @@ public IpRangeAggregationRangeDescriptor Mask(string? mask) } /// - /// End of the range. + /// + /// End of the range. + /// /// public IpRangeAggregationRangeDescriptor To(string? to) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/IpRangeBucket.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/IpRangeBucket.g.cs index 2a52728f0d3..eb63a544bb6 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/IpRangeBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/IpRangeBucket.g.cs @@ -91,7 +91,9 @@ public override void Write(Utf8JsonWriter writer, IpRangeBucket value, JsonSeria public sealed partial class IpRangeBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/LongRareTermsAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/LongRareTermsAggregate.g.cs index 352a90c2f93..f609bb3999b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/LongRareTermsAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/LongRareTermsAggregate.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; /// -/// Result of the `rare_terms` aggregation when the field is some kind of whole number like a integer, long, or a date. +/// +/// Result of the rare_terms aggregation when the field is some kind of whole number like a integer, long, or a date. +/// /// public sealed partial class LongRareTermsAggregate : IAggregate { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/LongRareTermsBucket.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/LongRareTermsBucket.g.cs index 71dc5b33b38..97f7fb82c59 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/LongRareTermsBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/LongRareTermsBucket.g.cs @@ -84,7 +84,9 @@ public override void Write(Utf8JsonWriter writer, LongRareTermsBucket value, Jso public sealed partial class LongRareTermsBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/LongTermsAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/LongTermsAggregate.g.cs index c83db968258..b4bfc3acf8f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/LongTermsAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/LongTermsAggregate.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; /// -/// Result of a `terms` aggregation when the field is some kind of whole number like a integer, long, or a date. +/// +/// Result of a terms aggregation when the field is some kind of whole number like a integer, long, or a date. +/// /// public sealed partial class LongTermsAggregate : IAggregate { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/LongTermsBucket.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/LongTermsBucket.g.cs index c6dc09a9a7f..6d3ebf56606 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/LongTermsBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/LongTermsBucket.g.cs @@ -91,7 +91,9 @@ public override void Write(Utf8JsonWriter writer, LongTermsBucket value, JsonSer public sealed partial class LongTermsBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MatrixStatsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MatrixStatsAggregation.g.cs index 481f7b76243..dd596d44720 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MatrixStatsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MatrixStatsAggregation.g.cs @@ -30,20 +30,27 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class MatrixStatsAggregation { /// - /// An array of fields for computing the statistics. + /// + /// An array of fields for computing the statistics. + /// /// [JsonInclude, JsonPropertyName("fields")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] public Elastic.Clients.Elasticsearch.Serverless.Fields? Fields { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public IDictionary? Missing { get; set; } /// - /// Array value the aggregation will use for array or multi-valued fields. + /// + /// Array value the aggregation will use for array or multi-valued fields. + /// /// [JsonInclude, JsonPropertyName("mode")] public Elastic.Clients.Elasticsearch.Serverless.SortMode? Mode { get; set; } @@ -64,7 +71,9 @@ public MatrixStatsAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.SortMode? ModeValue { get; set; } /// - /// An array of fields for computing the statistics. + /// + /// An array of fields for computing the statistics. + /// /// public MatrixStatsAggregationDescriptor Fields(Elastic.Clients.Elasticsearch.Serverless.Fields? fields) { @@ -73,7 +82,10 @@ public MatrixStatsAggregationDescriptor Fields(Elastic.Clients.Elasti } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public MatrixStatsAggregationDescriptor Missing(Func, FluentDictionary> selector) { @@ -82,7 +94,9 @@ public MatrixStatsAggregationDescriptor Missing(Func - /// Array value the aggregation will use for array or multi-valued fields. + /// + /// Array value the aggregation will use for array or multi-valued fields. + /// /// public MatrixStatsAggregationDescriptor Mode(Elastic.Clients.Elasticsearch.Serverless.SortMode? mode) { @@ -128,7 +142,9 @@ public MatrixStatsAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.SortMode? ModeValue { get; set; } /// - /// An array of fields for computing the statistics. + /// + /// An array of fields for computing the statistics. + /// /// public MatrixStatsAggregationDescriptor Fields(Elastic.Clients.Elasticsearch.Serverless.Fields? fields) { @@ -137,7 +153,10 @@ public MatrixStatsAggregationDescriptor Fields(Elastic.Clients.Elasticsearch.Ser } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public MatrixStatsAggregationDescriptor Missing(Func, FluentDictionary> selector) { @@ -146,7 +165,9 @@ public MatrixStatsAggregationDescriptor Missing(Func - /// Array value the aggregation will use for array or multi-valued fields. + /// + /// Array value the aggregation will use for array or multi-valued fields. + /// /// public MatrixStatsAggregationDescriptor Mode(Elastic.Clients.Elasticsearch.Serverless.SortMode? mode) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MaxAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MaxAggregate.g.cs index a9a25dc9d9d..a17cee15fdd 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MaxAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MaxAggregate.g.cs @@ -33,7 +33,10 @@ public sealed partial class MaxAggregate : IAggregate public IReadOnlyDictionary? Meta { get; init; } /// - /// The metric value. A missing value generally means that there was no data to aggregate,
unless specified otherwise. + /// + /// The metric value. A missing value generally means that there was no data to aggregate, + /// unless specified otherwise. + /// /// [JsonInclude, JsonPropertyName("value")] public double? Value { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MaxAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MaxAggregation.g.cs index d55e96d7c83..48cc3ed00d9 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MaxAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MaxAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class MaxAggregation { /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } @@ -38,7 +40,10 @@ public sealed partial class MaxAggregation public string? Format { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.Serverless.FieldValue? Missing { get; set; } @@ -64,7 +69,9 @@ public MaxAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MaxAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -73,7 +80,9 @@ public MaxAggregationDescriptor Field(Elastic.Clients.Elasticsearch.S } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MaxAggregationDescriptor Field(Expression> field) { @@ -82,7 +91,9 @@ public MaxAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MaxAggregationDescriptor Field(Expression> field) { @@ -97,7 +108,10 @@ public MaxAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public MaxAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -186,7 +200,9 @@ public MaxAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MaxAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -195,7 +211,9 @@ public MaxAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.F } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MaxAggregationDescriptor Field(Expression> field) { @@ -204,7 +222,9 @@ public MaxAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MaxAggregationDescriptor Field(Expression> field) { @@ -219,7 +239,10 @@ public MaxAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public MaxAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MaxBucketAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MaxBucketAggregation.g.cs index 39e68d085f5..74a0107649f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MaxBucketAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MaxBucketAggregation.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class MaxBucketAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? GapPolicy { get; set; } @@ -63,7 +70,9 @@ public MaxBucketAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? GapPolicyValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public MaxBucketAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? bucketsPath) { @@ -72,7 +81,10 @@ public MaxBucketAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch. } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public MaxBucketAggregationDescriptor Format(string? format) { @@ -81,7 +93,9 @@ public MaxBucketAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public MaxBucketAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? gapPolicy) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MedianAbsoluteDeviationAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MedianAbsoluteDeviationAggregate.g.cs index ab854c3f6c7..572d8d27a3a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MedianAbsoluteDeviationAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MedianAbsoluteDeviationAggregate.g.cs @@ -33,7 +33,10 @@ public sealed partial class MedianAbsoluteDeviationAggregate : IAggregate public IReadOnlyDictionary? Meta { get; init; } /// - /// The metric value. A missing value generally means that there was no data to aggregate,
unless specified otherwise. + /// + /// The metric value. A missing value generally means that there was no data to aggregate, + /// unless specified otherwise. + /// /// [JsonInclude, JsonPropertyName("value")] public double? Value { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MedianAbsoluteDeviationAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MedianAbsoluteDeviationAggregation.g.cs index 181b8a2570b..7d38f3e70ab 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MedianAbsoluteDeviationAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MedianAbsoluteDeviationAggregation.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class MedianAbsoluteDeviationAggregation { /// - /// Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. + /// + /// Limits the maximum number of nodes used by the underlying TDigest algorithm to 20 * compression, enabling control of memory usage and approximation error. + /// /// [JsonInclude, JsonPropertyName("compression")] public double? Compression { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } @@ -44,7 +48,10 @@ public sealed partial class MedianAbsoluteDeviationAggregation public string? Format { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.Serverless.FieldValue? Missing { get; set; } @@ -71,7 +78,9 @@ public MedianAbsoluteDeviationAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. + /// + /// Limits the maximum number of nodes used by the underlying TDigest algorithm to 20 * compression, enabling control of memory usage and approximation error. + /// /// public MedianAbsoluteDeviationAggregationDescriptor Compression(double? compression) { @@ -80,7 +89,9 @@ public MedianAbsoluteDeviationAggregationDescriptor Compression(doubl } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MedianAbsoluteDeviationAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -89,7 +100,9 @@ public MedianAbsoluteDeviationAggregationDescriptor Field(Elastic.Cli } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MedianAbsoluteDeviationAggregationDescriptor Field(Expression> field) { @@ -98,7 +111,9 @@ public MedianAbsoluteDeviationAggregationDescriptor Field(Exp } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MedianAbsoluteDeviationAggregationDescriptor Field(Expression> field) { @@ -113,7 +128,10 @@ public MedianAbsoluteDeviationAggregationDescriptor Format(string? fo } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public MedianAbsoluteDeviationAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -209,7 +227,9 @@ public MedianAbsoluteDeviationAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. + /// + /// Limits the maximum number of nodes used by the underlying TDigest algorithm to 20 * compression, enabling control of memory usage and approximation error. + /// /// public MedianAbsoluteDeviationAggregationDescriptor Compression(double? compression) { @@ -218,7 +238,9 @@ public MedianAbsoluteDeviationAggregationDescriptor Compression(double? compress } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MedianAbsoluteDeviationAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -227,7 +249,9 @@ public MedianAbsoluteDeviationAggregationDescriptor Field(Elastic.Clients.Elasti } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MedianAbsoluteDeviationAggregationDescriptor Field(Expression> field) { @@ -236,7 +260,9 @@ public MedianAbsoluteDeviationAggregationDescriptor Field(Exp } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MedianAbsoluteDeviationAggregationDescriptor Field(Expression> field) { @@ -251,7 +277,10 @@ public MedianAbsoluteDeviationAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public MedianAbsoluteDeviationAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MinAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MinAggregate.g.cs index 1d7912c68cb..c027bc24cfb 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MinAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MinAggregate.g.cs @@ -33,7 +33,10 @@ public sealed partial class MinAggregate : IAggregate public IReadOnlyDictionary? Meta { get; init; } /// - /// The metric value. A missing value generally means that there was no data to aggregate,
unless specified otherwise. + /// + /// The metric value. A missing value generally means that there was no data to aggregate, + /// unless specified otherwise. + /// /// [JsonInclude, JsonPropertyName("value")] public double? Value { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MinAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MinAggregation.g.cs index 4b7d60f52be..65f06dbcddc 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MinAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MinAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class MinAggregation { /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } @@ -38,7 +40,10 @@ public sealed partial class MinAggregation public string? Format { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.Serverless.FieldValue? Missing { get; set; } @@ -64,7 +69,9 @@ public MinAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MinAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -73,7 +80,9 @@ public MinAggregationDescriptor Field(Elastic.Clients.Elasticsearch.S } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MinAggregationDescriptor Field(Expression> field) { @@ -82,7 +91,9 @@ public MinAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MinAggregationDescriptor Field(Expression> field) { @@ -97,7 +108,10 @@ public MinAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public MinAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -186,7 +200,9 @@ public MinAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MinAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -195,7 +211,9 @@ public MinAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.F } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MinAggregationDescriptor Field(Expression> field) { @@ -204,7 +222,9 @@ public MinAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MinAggregationDescriptor Field(Expression> field) { @@ -219,7 +239,10 @@ public MinAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public MinAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MinBucketAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MinBucketAggregation.g.cs index 7768e4b5f99..795a7b40807 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MinBucketAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MinBucketAggregation.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class MinBucketAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? GapPolicy { get; set; } @@ -63,7 +70,9 @@ public MinBucketAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? GapPolicyValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public MinBucketAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? bucketsPath) { @@ -72,7 +81,10 @@ public MinBucketAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch. } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public MinBucketAggregationDescriptor Format(string? format) { @@ -81,7 +93,9 @@ public MinBucketAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public MinBucketAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? gapPolicy) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MissingAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MissingAggregate.g.cs index 21a57756ed0..7beb0b402f8 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MissingAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MissingAggregate.g.cs @@ -77,7 +77,9 @@ public override void Write(Utf8JsonWriter writer, MissingAggregate value, JsonSe public sealed partial class MissingAggregate : IAggregate { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MissingAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MissingAggregation.g.cs index a3c1e51bc5f..afffcc58ce0 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MissingAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MissingAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class MissingAggregation { /// - /// The name of the field. + /// + /// The name of the field. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } @@ -52,7 +54,9 @@ public MissingAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.FieldValue? MissingValue { get; set; } /// - /// The name of the field. + /// + /// The name of the field. + /// /// public MissingAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -61,7 +65,9 @@ public MissingAggregationDescriptor Field(Elastic.Clients.Elasticsear } /// - /// The name of the field. + /// + /// The name of the field. + /// /// public MissingAggregationDescriptor Field(Expression> field) { @@ -70,7 +76,9 @@ public MissingAggregationDescriptor Field(Expression - /// The name of the field. + /// + /// The name of the field. + /// /// public MissingAggregationDescriptor Field(Expression> field) { @@ -115,7 +123,9 @@ public MissingAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.FieldValue? MissingValue { get; set; } /// - /// The name of the field. + /// + /// The name of the field. + /// /// public MissingAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -124,7 +134,9 @@ public MissingAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverle } /// - /// The name of the field. + /// + /// The name of the field. + /// /// public MissingAggregationDescriptor Field(Expression> field) { @@ -133,7 +145,9 @@ public MissingAggregationDescriptor Field(Expression - /// The name of the field. + /// + /// The name of the field. + /// /// public MissingAggregationDescriptor Field(Expression> field) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MovingFunctionAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MovingFunctionAggregation.g.cs index 2ce20f78016..8e64de08216 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MovingFunctionAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MovingFunctionAggregation.g.cs @@ -30,37 +30,51 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class MovingFunctionAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? GapPolicy { get; set; } /// - /// The script that should be executed on each window of data. + /// + /// The script that should be executed on each window of data. + /// /// [JsonInclude, JsonPropertyName("script")] public string? Script { get; set; } /// - /// By default, the window consists of the last n values excluding the current bucket.
Increasing `shift` by 1, moves the starting window position by 1 to the right. + /// + /// By default, the window consists of the last n values excluding the current bucket. + /// Increasing shift by 1, moves the starting window position by 1 to the right. + /// /// [JsonInclude, JsonPropertyName("shift")] public int? Shift { get; set; } /// - /// The size of window to "slide" across the histogram. + /// + /// The size of window to "slide" across the histogram. + /// /// [JsonInclude, JsonPropertyName("window")] public int? Window { get; set; } @@ -84,7 +98,9 @@ public MovingFunctionAggregationDescriptor() : base() private int? WindowValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public MovingFunctionAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? bucketsPath) { @@ -93,7 +109,10 @@ public MovingFunctionAggregationDescriptor BucketsPath(Elastic.Clients.Elasticse } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public MovingFunctionAggregationDescriptor Format(string? format) { @@ -102,7 +121,9 @@ public MovingFunctionAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public MovingFunctionAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? gapPolicy) { @@ -111,7 +132,9 @@ public MovingFunctionAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsear } /// - /// The script that should be executed on each window of data. + /// + /// The script that should be executed on each window of data. + /// /// public MovingFunctionAggregationDescriptor Script(string? script) { @@ -120,7 +143,10 @@ public MovingFunctionAggregationDescriptor Script(string? script) } /// - /// By default, the window consists of the last n values excluding the current bucket.
Increasing `shift` by 1, moves the starting window position by 1 to the right. + /// + /// By default, the window consists of the last n values excluding the current bucket. + /// Increasing shift by 1, moves the starting window position by 1 to the right. + /// /// public MovingFunctionAggregationDescriptor Shift(int? shift) { @@ -129,7 +155,9 @@ public MovingFunctionAggregationDescriptor Shift(int? shift) } /// - /// The size of window to "slide" across the histogram. + /// + /// The size of window to "slide" across the histogram. + /// /// public MovingFunctionAggregationDescriptor Window(int? window) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MovingPercentilesAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MovingPercentilesAggregation.g.cs index 88b752ce250..dce677b84f8 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MovingPercentilesAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MovingPercentilesAggregation.g.cs @@ -30,31 +30,43 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class MovingPercentilesAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? GapPolicy { get; set; } /// - /// By default, the window consists of the last n values excluding the current bucket.
Increasing `shift` by 1, moves the starting window position by 1 to the right. + /// + /// By default, the window consists of the last n values excluding the current bucket. + /// Increasing shift by 1, moves the starting window position by 1 to the right. + /// /// [JsonInclude, JsonPropertyName("shift")] public int? Shift { get; set; } /// - /// The size of window to "slide" across the histogram. + /// + /// The size of window to "slide" across the histogram. + /// /// [JsonInclude, JsonPropertyName("window")] public int? Window { get; set; } @@ -77,7 +89,9 @@ public MovingPercentilesAggregationDescriptor() : base() private int? WindowValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public MovingPercentilesAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? bucketsPath) { @@ -86,7 +100,10 @@ public MovingPercentilesAggregationDescriptor BucketsPath(Elastic.Clients.Elasti } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public MovingPercentilesAggregationDescriptor Format(string? format) { @@ -95,7 +112,9 @@ public MovingPercentilesAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public MovingPercentilesAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? gapPolicy) { @@ -104,7 +123,10 @@ public MovingPercentilesAggregationDescriptor GapPolicy(Elastic.Clients.Elastics } /// - /// By default, the window consists of the last n values excluding the current bucket.
Increasing `shift` by 1, moves the starting window position by 1 to the right. + /// + /// By default, the window consists of the last n values excluding the current bucket. + /// Increasing shift by 1, moves the starting window position by 1 to the right. + /// /// public MovingPercentilesAggregationDescriptor Shift(int? shift) { @@ -113,7 +135,9 @@ public MovingPercentilesAggregationDescriptor Shift(int? shift) } /// - /// The size of window to "slide" across the histogram. + /// + /// The size of window to "slide" across the histogram. + /// /// public MovingPercentilesAggregationDescriptor Window(int? window) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MultiTermLookup.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MultiTermLookup.g.cs index d67300ec644..1ae2d7fc6d4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MultiTermLookup.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MultiTermLookup.g.cs @@ -30,13 +30,18 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class MultiTermLookup { /// - /// A fields from which to retrieve terms. + /// + /// A fields from which to retrieve terms. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.Serverless.FieldValue? Missing { get; set; } @@ -54,7 +59,9 @@ public MultiTermLookupDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.FieldValue? MissingValue { get; set; } /// - /// A fields from which to retrieve terms. + /// + /// A fields from which to retrieve terms. + /// /// public MultiTermLookupDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -63,7 +70,9 @@ public MultiTermLookupDescriptor Field(Elastic.Clients.Elasticsearch. } /// - /// A fields from which to retrieve terms. + /// + /// A fields from which to retrieve terms. + /// /// public MultiTermLookupDescriptor Field(Expression> field) { @@ -72,7 +81,9 @@ public MultiTermLookupDescriptor Field(Expression - /// A fields from which to retrieve terms. + /// + /// A fields from which to retrieve terms. + /// /// public MultiTermLookupDescriptor Field(Expression> field) { @@ -81,7 +92,10 @@ public MultiTermLookupDescriptor Field(Expression - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public MultiTermLookupDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -116,7 +130,9 @@ public MultiTermLookupDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.FieldValue? MissingValue { get; set; } /// - /// A fields from which to retrieve terms. + /// + /// A fields from which to retrieve terms. + /// /// public MultiTermLookupDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -125,7 +141,9 @@ public MultiTermLookupDescriptor Field(Elastic.Clients.Elasticsearch.Serverless. } /// - /// A fields from which to retrieve terms. + /// + /// A fields from which to retrieve terms. + /// /// public MultiTermLookupDescriptor Field(Expression> field) { @@ -134,7 +152,9 @@ public MultiTermLookupDescriptor Field(Expression - /// A fields from which to retrieve terms. + /// + /// A fields from which to retrieve terms. + /// /// public MultiTermLookupDescriptor Field(Expression> field) { @@ -143,7 +163,10 @@ public MultiTermLookupDescriptor Field(Expression - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public MultiTermLookupDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MultiTermsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MultiTermsAggregation.g.cs index e365218c7ad..385bae8dd19 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MultiTermsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MultiTermsAggregation.g.cs @@ -30,50 +30,68 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class MultiTermsAggregation { /// - /// Specifies the strategy for data collection. + /// + /// Specifies the strategy for data collection. + /// /// [JsonInclude, JsonPropertyName("collect_mode")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsAggregationCollectMode? CollectMode { get; set; } /// - /// The minimum number of documents in a bucket for it to be returned. + /// + /// The minimum number of documents in a bucket for it to be returned. + /// /// [JsonInclude, JsonPropertyName("min_doc_count")] public long? MinDocCount { get; set; } /// - /// Specifies the sort order of the buckets.
Defaults to sorting by descending document count. + /// + /// Specifies the sort order of the buckets. + /// Defaults to sorting by descending document count. + /// /// [JsonInclude, JsonPropertyName("order")] [SingleOrManyCollectionConverter(typeof(KeyValuePair))] public ICollection>? Order { get; set; } /// - /// The minimum number of documents in a bucket on each shard for it to be returned. + /// + /// The minimum number of documents in a bucket on each shard for it to be returned. + /// /// [JsonInclude, JsonPropertyName("shard_min_doc_count")] public long? ShardMinDocCount { get; set; } /// - /// The number of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// + /// The number of candidate terms produced by each shard. + /// By default, shard_size will be automatically estimated based on the number of shards and the size parameter. + /// /// [JsonInclude, JsonPropertyName("shard_size")] public int? ShardSize { get; set; } /// - /// Calculates the doc count error on per term basis. + /// + /// Calculates the doc count error on per term basis. + /// /// [JsonInclude, JsonPropertyName("show_term_doc_count_error")] public bool? ShowTermDocCountError { get; set; } /// - /// The number of term buckets should be returned out of the overall terms list. + /// + /// The number of term buckets should be returned out of the overall terms list. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// The field from which to generate sets of terms. + /// + /// The field from which to generate sets of terms. + /// /// [JsonInclude, JsonPropertyName("terms")] public ICollection Terms { get; set; } @@ -102,7 +120,9 @@ public MultiTermsAggregationDescriptor() : base() private Action>[] TermsDescriptorActions { get; set; } /// - /// Specifies the strategy for data collection. + /// + /// Specifies the strategy for data collection. + /// /// public MultiTermsAggregationDescriptor CollectMode(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsAggregationCollectMode? collectMode) { @@ -111,7 +131,9 @@ public MultiTermsAggregationDescriptor CollectMode(Elastic.Clients.El } /// - /// The minimum number of documents in a bucket for it to be returned. + /// + /// The minimum number of documents in a bucket for it to be returned. + /// /// public MultiTermsAggregationDescriptor MinDocCount(long? minDocCount) { @@ -120,7 +142,10 @@ public MultiTermsAggregationDescriptor MinDocCount(long? minDocCount) } /// - /// Specifies the sort order of the buckets.
Defaults to sorting by descending document count. + /// + /// Specifies the sort order of the buckets. + /// Defaults to sorting by descending document count. + /// /// public MultiTermsAggregationDescriptor Order(ICollection>? order) { @@ -129,7 +154,9 @@ public MultiTermsAggregationDescriptor Order(ICollection - /// The minimum number of documents in a bucket on each shard for it to be returned. + /// + /// The minimum number of documents in a bucket on each shard for it to be returned. + /// /// public MultiTermsAggregationDescriptor ShardMinDocCount(long? shardMinDocCount) { @@ -138,7 +165,10 @@ public MultiTermsAggregationDescriptor ShardMinDocCount(long? shardMi } /// - /// The number of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// + /// The number of candidate terms produced by each shard. + /// By default, shard_size will be automatically estimated based on the number of shards and the size parameter. + /// /// public MultiTermsAggregationDescriptor ShardSize(int? shardSize) { @@ -147,7 +177,9 @@ public MultiTermsAggregationDescriptor ShardSize(int? shardSize) } /// - /// Calculates the doc count error on per term basis. + /// + /// Calculates the doc count error on per term basis. + /// /// public MultiTermsAggregationDescriptor ShowTermDocCountError(bool? showTermDocCountError = true) { @@ -156,7 +188,9 @@ public MultiTermsAggregationDescriptor ShowTermDocCountError(bool? sh } /// - /// The number of term buckets should be returned out of the overall terms list. + /// + /// The number of term buckets should be returned out of the overall terms list. + /// /// public MultiTermsAggregationDescriptor Size(int? size) { @@ -165,7 +199,9 @@ public MultiTermsAggregationDescriptor Size(int? size) } /// - /// The field from which to generate sets of terms. + /// + /// The field from which to generate sets of terms. + /// /// public MultiTermsAggregationDescriptor Terms(ICollection terms) { @@ -304,7 +340,9 @@ public MultiTermsAggregationDescriptor() : base() private Action[] TermsDescriptorActions { get; set; } /// - /// Specifies the strategy for data collection. + /// + /// Specifies the strategy for data collection. + /// /// public MultiTermsAggregationDescriptor CollectMode(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsAggregationCollectMode? collectMode) { @@ -313,7 +351,9 @@ public MultiTermsAggregationDescriptor CollectMode(Elastic.Clients.Elasticsearch } /// - /// The minimum number of documents in a bucket for it to be returned. + /// + /// The minimum number of documents in a bucket for it to be returned. + /// /// public MultiTermsAggregationDescriptor MinDocCount(long? minDocCount) { @@ -322,7 +362,10 @@ public MultiTermsAggregationDescriptor MinDocCount(long? minDocCount) } /// - /// Specifies the sort order of the buckets.
Defaults to sorting by descending document count. + /// + /// Specifies the sort order of the buckets. + /// Defaults to sorting by descending document count. + /// /// public MultiTermsAggregationDescriptor Order(ICollection>? order) { @@ -331,7 +374,9 @@ public MultiTermsAggregationDescriptor Order(ICollection - /// The minimum number of documents in a bucket on each shard for it to be returned. + /// + /// The minimum number of documents in a bucket on each shard for it to be returned. + /// /// public MultiTermsAggregationDescriptor ShardMinDocCount(long? shardMinDocCount) { @@ -340,7 +385,10 @@ public MultiTermsAggregationDescriptor ShardMinDocCount(long? shardMinDocCount) } /// - /// The number of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// + /// The number of candidate terms produced by each shard. + /// By default, shard_size will be automatically estimated based on the number of shards and the size parameter. + /// /// public MultiTermsAggregationDescriptor ShardSize(int? shardSize) { @@ -349,7 +397,9 @@ public MultiTermsAggregationDescriptor ShardSize(int? shardSize) } /// - /// Calculates the doc count error on per term basis. + /// + /// Calculates the doc count error on per term basis. + /// /// public MultiTermsAggregationDescriptor ShowTermDocCountError(bool? showTermDocCountError = true) { @@ -358,7 +408,9 @@ public MultiTermsAggregationDescriptor ShowTermDocCountError(bool? showTermDocCo } /// - /// The number of term buckets should be returned out of the overall terms list. + /// + /// The number of term buckets should be returned out of the overall terms list. + /// /// public MultiTermsAggregationDescriptor Size(int? size) { @@ -367,7 +419,9 @@ public MultiTermsAggregationDescriptor Size(int? size) } /// - /// The field from which to generate sets of terms. + /// + /// The field from which to generate sets of terms. + /// /// public MultiTermsAggregationDescriptor Terms(ICollection terms) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MultiTermsBucket.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MultiTermsBucket.g.cs index 6652c3ad895..8ffc914e5ea 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MultiTermsBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MultiTermsBucket.g.cs @@ -91,7 +91,9 @@ public override void Write(Utf8JsonWriter writer, MultiTermsBucket value, JsonSe public sealed partial class MultiTermsBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MutualInformationHeuristic.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MutualInformationHeuristic.g.cs index e45373a5b21..6dbd0ff16e2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MutualInformationHeuristic.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/MutualInformationHeuristic.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class MutualInformationHeuristic { /// - /// Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. + /// + /// Set to false if you defined a custom background filter that represents a different set of documents that you want to compare to. + /// /// [JsonInclude, JsonPropertyName("background_is_superset")] public bool? BackgroundIsSuperset { get; set; } /// - /// Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset. + /// + /// Set to false to filter out the terms that appear less often in the subset than in documents outside the subset. + /// /// [JsonInclude, JsonPropertyName("include_negatives")] public bool? IncludeNegatives { get; set; } @@ -54,7 +58,9 @@ public MutualInformationHeuristicDescriptor() : base() private bool? IncludeNegativesValue { get; set; } /// - /// Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. + /// + /// Set to false if you defined a custom background filter that represents a different set of documents that you want to compare to. + /// /// public MutualInformationHeuristicDescriptor BackgroundIsSuperset(bool? backgroundIsSuperset = true) { @@ -63,7 +69,9 @@ public MutualInformationHeuristicDescriptor BackgroundIsSuperset(bool? backgroun } /// - /// Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset. + /// + /// Set to false to filter out the terms that appear less often in the subset than in documents outside the subset. + /// /// public MutualInformationHeuristicDescriptor IncludeNegatives(bool? includeNegatives = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/NestedAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/NestedAggregate.g.cs index 9aef93a0d7d..2fecd1dea37 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/NestedAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/NestedAggregate.g.cs @@ -77,7 +77,9 @@ public override void Write(Utf8JsonWriter writer, NestedAggregate value, JsonSer public sealed partial class NestedAggregate : IAggregate { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/NestedAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/NestedAggregation.g.cs index cb89b03b67f..995d92ab418 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/NestedAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/NestedAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class NestedAggregation { /// - /// The path to the field of type `nested`. + /// + /// The path to the field of type nested. + /// /// [JsonInclude, JsonPropertyName("path")] public Elastic.Clients.Elasticsearch.Serverless.Field? Path { get; set; } @@ -49,7 +51,9 @@ public NestedAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? PathValue { get; set; } /// - /// The path to the field of type `nested`. + /// + /// The path to the field of type nested. + /// /// public NestedAggregationDescriptor Path(Elastic.Clients.Elasticsearch.Serverless.Field? path) { @@ -58,7 +62,9 @@ public NestedAggregationDescriptor Path(Elastic.Clients.Elasticsearch } /// - /// The path to the field of type `nested`. + /// + /// The path to the field of type nested. + /// /// public NestedAggregationDescriptor Path(Expression> path) { @@ -67,7 +73,9 @@ public NestedAggregationDescriptor Path(Expression - /// The path to the field of type `nested`. + /// + /// The path to the field of type nested. + /// /// public NestedAggregationDescriptor Path(Expression> path) { @@ -99,7 +107,9 @@ public NestedAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? PathValue { get; set; } /// - /// The path to the field of type `nested`. + /// + /// The path to the field of type nested. + /// /// public NestedAggregationDescriptor Path(Elastic.Clients.Elasticsearch.Serverless.Field? path) { @@ -108,7 +118,9 @@ public NestedAggregationDescriptor Path(Elastic.Clients.Elasticsearch.Serverless } /// - /// The path to the field of type `nested`. + /// + /// The path to the field of type nested. + /// /// public NestedAggregationDescriptor Path(Expression> path) { @@ -117,7 +129,9 @@ public NestedAggregationDescriptor Path(Expression - /// The path to the field of type `nested`. + /// + /// The path to the field of type nested. + /// /// public NestedAggregationDescriptor Path(Expression> path) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/NormalizeAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/NormalizeAggregation.g.cs index ee665eacdb0..e5316d862a8 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/NormalizeAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/NormalizeAggregation.g.cs @@ -30,25 +30,34 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class NormalizeAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? GapPolicy { get; set; } /// - /// The specific method to apply. + /// + /// The specific method to apply. + /// /// [JsonInclude, JsonPropertyName("method")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.NormalizeMethod? Method { get; set; } @@ -70,7 +79,9 @@ public NormalizeAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Aggregations.NormalizeMethod? MethodValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public NormalizeAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? bucketsPath) { @@ -79,7 +90,10 @@ public NormalizeAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch. } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public NormalizeAggregationDescriptor Format(string? format) { @@ -88,7 +102,9 @@ public NormalizeAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public NormalizeAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? gapPolicy) { @@ -97,7 +113,9 @@ public NormalizeAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Se } /// - /// The specific method to apply. + /// + /// The specific method to apply. + /// /// public NormalizeAggregationDescriptor Method(Elastic.Clients.Elasticsearch.Serverless.Aggregations.NormalizeMethod? method) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ParentAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ParentAggregate.g.cs index 146a25b6366..c504491ea66 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ParentAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ParentAggregate.g.cs @@ -77,7 +77,9 @@ public override void Write(Utf8JsonWriter writer, ParentAggregate value, JsonSer public sealed partial class ParentAggregate : IAggregate { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ParentAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ParentAggregation.g.cs index 2ff1ae31713..e02954c66d2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ParentAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ParentAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class ParentAggregation { /// - /// The child type that should be selected. + /// + /// The child type that should be selected. + /// /// [JsonInclude, JsonPropertyName("type")] public string? Type { get; set; } @@ -49,7 +51,9 @@ public ParentAggregationDescriptor() : base() private string? TypeValue { get; set; } /// - /// The child type that should be selected. + /// + /// The child type that should be selected. + /// /// public ParentAggregationDescriptor Type(string? type) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/PercentileRanksAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/PercentileRanksAggregation.g.cs index eded597c74e..67de21797b9 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/PercentileRanksAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/PercentileRanksAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class PercentileRanksAggregation { /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } @@ -38,13 +40,18 @@ public sealed partial class PercentileRanksAggregation public string? Format { get; set; } /// - /// Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks. + /// + /// Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks. + /// /// [JsonInclude, JsonPropertyName("hdr")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.HdrMethod? Hdr { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.Serverless.FieldValue? Missing { get; set; } @@ -52,13 +59,17 @@ public sealed partial class PercentileRanksAggregation public Elastic.Clients.Elasticsearch.Serverless.Script? Script { get; set; } /// - /// Sets parameters for the default TDigest algorithm used to calculate percentile ranks. + /// + /// Sets parameters for the default TDigest algorithm used to calculate percentile ranks. + /// /// [JsonInclude, JsonPropertyName("tdigest")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.TDigest? TDigest { get; set; } /// - /// An array of values for which to calculate the percentile ranks. + /// + /// An array of values for which to calculate the percentile ranks. + /// /// [JsonInclude, JsonPropertyName("values")] public ICollection? Values { get; set; } @@ -89,7 +100,9 @@ public PercentileRanksAggregationDescriptor() : base() private ICollection? ValuesValue { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public PercentileRanksAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -98,7 +111,9 @@ public PercentileRanksAggregationDescriptor Field(Elastic.Clients.Ela } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public PercentileRanksAggregationDescriptor Field(Expression> field) { @@ -107,7 +122,9 @@ public PercentileRanksAggregationDescriptor Field(Expression< } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public PercentileRanksAggregationDescriptor Field(Expression> field) { @@ -122,7 +139,9 @@ public PercentileRanksAggregationDescriptor Format(string? format) } /// - /// Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks. + /// + /// Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks. + /// /// public PercentileRanksAggregationDescriptor Hdr(Elastic.Clients.Elasticsearch.Serverless.Aggregations.HdrMethod? hdr) { @@ -149,7 +168,10 @@ public PercentileRanksAggregationDescriptor Hdr(Action - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public PercentileRanksAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -182,7 +204,9 @@ public PercentileRanksAggregationDescriptor Script(Action - /// Sets parameters for the default TDigest algorithm used to calculate percentile ranks. + /// + /// Sets parameters for the default TDigest algorithm used to calculate percentile ranks. + /// /// public PercentileRanksAggregationDescriptor TDigest(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TDigest? tDigest) { @@ -209,7 +233,9 @@ public PercentileRanksAggregationDescriptor TDigest(Action - /// An array of values for which to calculate the percentile ranks. + /// + /// An array of values for which to calculate the percentile ranks. + /// /// public PercentileRanksAggregationDescriptor Values(ICollection? values) { @@ -319,7 +345,9 @@ public PercentileRanksAggregationDescriptor() : base() private ICollection? ValuesValue { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public PercentileRanksAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -328,7 +356,9 @@ public PercentileRanksAggregationDescriptor Field(Elastic.Clients.Elasticsearch. } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public PercentileRanksAggregationDescriptor Field(Expression> field) { @@ -337,7 +367,9 @@ public PercentileRanksAggregationDescriptor Field(Expression< } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public PercentileRanksAggregationDescriptor Field(Expression> field) { @@ -352,7 +384,9 @@ public PercentileRanksAggregationDescriptor Format(string? format) } /// - /// Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks. + /// + /// Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks. + /// /// public PercentileRanksAggregationDescriptor Hdr(Elastic.Clients.Elasticsearch.Serverless.Aggregations.HdrMethod? hdr) { @@ -379,7 +413,10 @@ public PercentileRanksAggregationDescriptor Hdr(Action - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public PercentileRanksAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -412,7 +449,9 @@ public PercentileRanksAggregationDescriptor Script(Action - /// Sets parameters for the default TDigest algorithm used to calculate percentile ranks. + /// + /// Sets parameters for the default TDigest algorithm used to calculate percentile ranks. + /// /// public PercentileRanksAggregationDescriptor TDigest(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TDigest? tDigest) { @@ -439,7 +478,9 @@ public PercentileRanksAggregationDescriptor TDigest(Action - /// An array of values for which to calculate the percentile ranks. + /// + /// An array of values for which to calculate the percentile ranks. + /// /// public PercentileRanksAggregationDescriptor Values(ICollection? values) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/PercentilesAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/PercentilesAggregation.g.cs index b2ee3be00ae..ab5dd97184a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/PercentilesAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/PercentilesAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class PercentilesAggregation { /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } @@ -38,19 +40,26 @@ public sealed partial class PercentilesAggregation public string? Format { get; set; } /// - /// Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles. + /// + /// Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles. + /// /// [JsonInclude, JsonPropertyName("hdr")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.HdrMethod? Hdr { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.Serverless.FieldValue? Missing { get; set; } /// - /// The percentiles to calculate. + /// + /// The percentiles to calculate. + /// /// [JsonInclude, JsonPropertyName("percents")] public ICollection? Percents { get; set; } @@ -58,7 +67,9 @@ public sealed partial class PercentilesAggregation public Elastic.Clients.Elasticsearch.Serverless.Script? Script { get; set; } /// - /// Sets parameters for the default TDigest algorithm used to calculate percentiles. + /// + /// Sets parameters for the default TDigest algorithm used to calculate percentiles. + /// /// [JsonInclude, JsonPropertyName("tdigest")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.TDigest? TDigest { get; set; } @@ -89,7 +100,9 @@ public PercentilesAggregationDescriptor() : base() private Action TDigestDescriptorAction { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public PercentilesAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -98,7 +111,9 @@ public PercentilesAggregationDescriptor Field(Elastic.Clients.Elastic } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public PercentilesAggregationDescriptor Field(Expression> field) { @@ -107,7 +122,9 @@ public PercentilesAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public PercentilesAggregationDescriptor Field(Expression> field) { @@ -122,7 +139,9 @@ public PercentilesAggregationDescriptor Format(string? format) } /// - /// Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles. + /// + /// Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles. + /// /// public PercentilesAggregationDescriptor Hdr(Elastic.Clients.Elasticsearch.Serverless.Aggregations.HdrMethod? hdr) { @@ -149,7 +168,10 @@ public PercentilesAggregationDescriptor Hdr(Action - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public PercentilesAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -158,7 +180,9 @@ public PercentilesAggregationDescriptor Missing(Elastic.Clients.Elast } /// - /// The percentiles to calculate. + /// + /// The percentiles to calculate. + /// /// public PercentilesAggregationDescriptor Percents(ICollection? percents) { @@ -191,7 +215,9 @@ public PercentilesAggregationDescriptor Script(Action - /// Sets parameters for the default TDigest algorithm used to calculate percentiles. + /// + /// Sets parameters for the default TDigest algorithm used to calculate percentiles. + /// /// public PercentilesAggregationDescriptor TDigest(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TDigest? tDigest) { @@ -319,7 +345,9 @@ public PercentilesAggregationDescriptor() : base() private Action TDigestDescriptorAction { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public PercentilesAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -328,7 +356,9 @@ public PercentilesAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serv } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public PercentilesAggregationDescriptor Field(Expression> field) { @@ -337,7 +367,9 @@ public PercentilesAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public PercentilesAggregationDescriptor Field(Expression> field) { @@ -352,7 +384,9 @@ public PercentilesAggregationDescriptor Format(string? format) } /// - /// Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles. + /// + /// Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles. + /// /// public PercentilesAggregationDescriptor Hdr(Elastic.Clients.Elasticsearch.Serverless.Aggregations.HdrMethod? hdr) { @@ -379,7 +413,10 @@ public PercentilesAggregationDescriptor Hdr(Action - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public PercentilesAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -388,7 +425,9 @@ public PercentilesAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Se } /// - /// The percentiles to calculate. + /// + /// The percentiles to calculate. + /// /// public PercentilesAggregationDescriptor Percents(ICollection? percents) { @@ -421,7 +460,9 @@ public PercentilesAggregationDescriptor Script(Action - /// Sets parameters for the default TDigest algorithm used to calculate percentiles. + /// + /// Sets parameters for the default TDigest algorithm used to calculate percentiles. + /// /// public PercentilesAggregationDescriptor TDigest(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TDigest? tDigest) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/PercentilesBucketAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/PercentilesBucketAggregation.g.cs index dddbac76eea..a89020e7e24 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/PercentilesBucketAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/PercentilesBucketAggregation.g.cs @@ -30,25 +30,34 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class PercentilesBucketAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? GapPolicy { get; set; } /// - /// The list of percentiles to calculate. + /// + /// The list of percentiles to calculate. + /// /// [JsonInclude, JsonPropertyName("percents")] public ICollection? Percents { get; set; } @@ -70,7 +79,9 @@ public PercentilesBucketAggregationDescriptor() : base() private ICollection? PercentsValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public PercentilesBucketAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? bucketsPath) { @@ -79,7 +90,10 @@ public PercentilesBucketAggregationDescriptor BucketsPath(Elastic.Clients.Elasti } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public PercentilesBucketAggregationDescriptor Format(string? format) { @@ -88,7 +102,9 @@ public PercentilesBucketAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public PercentilesBucketAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? gapPolicy) { @@ -97,7 +113,9 @@ public PercentilesBucketAggregationDescriptor GapPolicy(Elastic.Clients.Elastics } /// - /// The list of percentiles to calculate. + /// + /// The list of percentiles to calculate. + /// /// public PercentilesBucketAggregationDescriptor Percents(ICollection? percents) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/RangeAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/RangeAggregation.g.cs index 0fc83170cbb..cac73f6ecea 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/RangeAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/RangeAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class RangeAggregation { /// - /// The date field whose values are use to build ranges. + /// + /// The date field whose values are use to build ranges. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } @@ -38,13 +40,18 @@ public sealed partial class RangeAggregation public string? Format { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public int? Missing { get; set; } /// - /// An array of ranges used to bucket documents. + /// + /// An array of ranges used to bucket documents. + /// /// [JsonInclude, JsonPropertyName("ranges")] public ICollection? Ranges { get; set; } @@ -74,7 +81,9 @@ public RangeAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The date field whose values are use to build ranges. + /// + /// The date field whose values are use to build ranges. + /// /// public RangeAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -83,7 +92,9 @@ public RangeAggregationDescriptor Field(Elastic.Clients.Elasticsearch } /// - /// The date field whose values are use to build ranges. + /// + /// The date field whose values are use to build ranges. + /// /// public RangeAggregationDescriptor Field(Expression> field) { @@ -92,7 +103,9 @@ public RangeAggregationDescriptor Field(Expression - /// The date field whose values are use to build ranges. + /// + /// The date field whose values are use to build ranges. + /// /// public RangeAggregationDescriptor Field(Expression> field) { @@ -107,7 +120,10 @@ public RangeAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public RangeAggregationDescriptor Missing(int? missing) { @@ -116,7 +132,9 @@ public RangeAggregationDescriptor Missing(int? missing) } /// - /// An array of ranges used to bucket documents. + /// + /// An array of ranges used to bucket documents. + /// /// public RangeAggregationDescriptor Ranges(ICollection? ranges) { @@ -270,7 +288,9 @@ public RangeAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The date field whose values are use to build ranges. + /// + /// The date field whose values are use to build ranges. + /// /// public RangeAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -279,7 +299,9 @@ public RangeAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless } /// - /// The date field whose values are use to build ranges. + /// + /// The date field whose values are use to build ranges. + /// /// public RangeAggregationDescriptor Field(Expression> field) { @@ -288,7 +310,9 @@ public RangeAggregationDescriptor Field(Expression - /// The date field whose values are use to build ranges. + /// + /// The date field whose values are use to build ranges. + /// /// public RangeAggregationDescriptor Field(Expression> field) { @@ -303,7 +327,10 @@ public RangeAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public RangeAggregationDescriptor Missing(int? missing) { @@ -312,7 +339,9 @@ public RangeAggregationDescriptor Missing(int? missing) } /// - /// An array of ranges used to bucket documents. + /// + /// An array of ranges used to bucket documents. + /// /// public RangeAggregationDescriptor Ranges(ICollection? ranges) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/RangeBucket.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/RangeBucket.g.cs index 04d805ebe29..92d28d6da79 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/RangeBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/RangeBucket.g.cs @@ -105,7 +105,9 @@ public override void Write(Utf8JsonWriter writer, RangeBucket value, JsonSeriali public sealed partial class RangeBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } @@ -113,7 +115,9 @@ public sealed partial class RangeBucket public string? FromAsString { get; init; } /// - /// The bucket key. Present if the aggregation is _not_ keyed + /// + /// The bucket key. Present if the aggregation is not keyed + /// /// public string? Key { get; init; } public double? To { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/RareTermsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/RareTermsAggregation.g.cs index e5e799e58cd..e92635a541b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/RareTermsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/RareTermsAggregation.g.cs @@ -30,37 +30,51 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class RareTermsAggregation { /// - /// Terms that should be excluded from the aggregation. + /// + /// Terms that should be excluded from the aggregation. + /// /// [JsonInclude, JsonPropertyName("exclude")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsExclude? Exclude { get; set; } /// - /// The field from which to return rare terms. + /// + /// The field from which to return rare terms. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } /// - /// Terms that should be included in the aggregation. + /// + /// Terms that should be included in the aggregation. + /// /// [JsonInclude, JsonPropertyName("include")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsInclude? Include { get; set; } /// - /// The maximum number of documents a term should appear in. + /// + /// The maximum number of documents a term should appear in. + /// /// [JsonInclude, JsonPropertyName("max_doc_count")] public long? MaxDocCount { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.Serverless.FieldValue? Missing { get; set; } /// - /// The precision of the internal CuckooFilters.
Smaller precision leads to better approximation, but higher memory usage. + /// + /// The precision of the internal CuckooFilters. + /// Smaller precision leads to better approximation, but higher memory usage. + /// /// [JsonInclude, JsonPropertyName("precision")] public double? Precision { get; set; } @@ -87,7 +101,9 @@ public RareTermsAggregationDescriptor() : base() private string? ValueTypeValue { get; set; } /// - /// Terms that should be excluded from the aggregation. + /// + /// Terms that should be excluded from the aggregation. + /// /// public RareTermsAggregationDescriptor Exclude(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsExclude? exclude) { @@ -96,7 +112,9 @@ public RareTermsAggregationDescriptor Exclude(Elastic.Clients.Elastic } /// - /// The field from which to return rare terms. + /// + /// The field from which to return rare terms. + /// /// public RareTermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -105,7 +123,9 @@ public RareTermsAggregationDescriptor Field(Elastic.Clients.Elasticse } /// - /// The field from which to return rare terms. + /// + /// The field from which to return rare terms. + /// /// public RareTermsAggregationDescriptor Field(Expression> field) { @@ -114,7 +134,9 @@ public RareTermsAggregationDescriptor Field(Expression - /// The field from which to return rare terms. + /// + /// The field from which to return rare terms. + /// /// public RareTermsAggregationDescriptor Field(Expression> field) { @@ -123,7 +145,9 @@ public RareTermsAggregationDescriptor Field(Expression - /// Terms that should be included in the aggregation. + /// + /// Terms that should be included in the aggregation. + /// /// public RareTermsAggregationDescriptor Include(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsInclude? include) { @@ -132,7 +156,9 @@ public RareTermsAggregationDescriptor Include(Elastic.Clients.Elastic } /// - /// The maximum number of documents a term should appear in. + /// + /// The maximum number of documents a term should appear in. + /// /// public RareTermsAggregationDescriptor MaxDocCount(long? maxDocCount) { @@ -141,7 +167,10 @@ public RareTermsAggregationDescriptor MaxDocCount(long? maxDocCount) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public RareTermsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -150,7 +179,10 @@ public RareTermsAggregationDescriptor Missing(Elastic.Clients.Elastic } /// - /// The precision of the internal CuckooFilters.
Smaller precision leads to better approximation, but higher memory usage. + /// + /// The precision of the internal CuckooFilters. + /// Smaller precision leads to better approximation, but higher memory usage. + /// /// public RareTermsAggregationDescriptor Precision(double? precision) { @@ -230,7 +262,9 @@ public RareTermsAggregationDescriptor() : base() private string? ValueTypeValue { get; set; } /// - /// Terms that should be excluded from the aggregation. + /// + /// Terms that should be excluded from the aggregation. + /// /// public RareTermsAggregationDescriptor Exclude(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsExclude? exclude) { @@ -239,7 +273,9 @@ public RareTermsAggregationDescriptor Exclude(Elastic.Clients.Elasticsearch.Serv } /// - /// The field from which to return rare terms. + /// + /// The field from which to return rare terms. + /// /// public RareTermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -248,7 +284,9 @@ public RareTermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Server } /// - /// The field from which to return rare terms. + /// + /// The field from which to return rare terms. + /// /// public RareTermsAggregationDescriptor Field(Expression> field) { @@ -257,7 +295,9 @@ public RareTermsAggregationDescriptor Field(Expression - /// The field from which to return rare terms. + /// + /// The field from which to return rare terms. + /// /// public RareTermsAggregationDescriptor Field(Expression> field) { @@ -266,7 +306,9 @@ public RareTermsAggregationDescriptor Field(Expression - /// Terms that should be included in the aggregation. + /// + /// Terms that should be included in the aggregation. + /// /// public RareTermsAggregationDescriptor Include(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsInclude? include) { @@ -275,7 +317,9 @@ public RareTermsAggregationDescriptor Include(Elastic.Clients.Elasticsearch.Serv } /// - /// The maximum number of documents a term should appear in. + /// + /// The maximum number of documents a term should appear in. + /// /// public RareTermsAggregationDescriptor MaxDocCount(long? maxDocCount) { @@ -284,7 +328,10 @@ public RareTermsAggregationDescriptor MaxDocCount(long? maxDocCount) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public RareTermsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -293,7 +340,10 @@ public RareTermsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serv } /// - /// The precision of the internal CuckooFilters.
Smaller precision leads to better approximation, but higher memory usage. + /// + /// The precision of the internal CuckooFilters. + /// Smaller precision leads to better approximation, but higher memory usage. + /// /// public RareTermsAggregationDescriptor Precision(double? precision) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/RateAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/RateAggregation.g.cs index 9eb5f5a1f11..a87f9578bfc 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/RateAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/RateAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class RateAggregation { /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } @@ -38,13 +40,18 @@ public sealed partial class RateAggregation public string? Format { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.Serverless.FieldValue? Missing { get; set; } /// - /// How the rate is calculated. + /// + /// How the rate is calculated. + /// /// [JsonInclude, JsonPropertyName("mode")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.RateMode? Mode { get; set; } @@ -52,7 +59,10 @@ public sealed partial class RateAggregation public Elastic.Clients.Elasticsearch.Serverless.Script? Script { get; set; } /// - /// The interval used to calculate the rate.
By default, the interval of the `date_histogram` is used. + /// + /// The interval used to calculate the rate. + /// By default, the interval of the date_histogram is used. + /// /// [JsonInclude, JsonPropertyName("unit")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.CalendarInterval? Unit { get; set; } @@ -78,7 +88,9 @@ public RateAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Aggregations.CalendarInterval? UnitValue { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public RateAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -87,7 +99,9 @@ public RateAggregationDescriptor Field(Elastic.Clients.Elasticsearch. } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public RateAggregationDescriptor Field(Expression> field) { @@ -96,7 +110,9 @@ public RateAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public RateAggregationDescriptor Field(Expression> field) { @@ -111,7 +127,10 @@ public RateAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public RateAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -120,7 +139,9 @@ public RateAggregationDescriptor Missing(Elastic.Clients.Elasticsearc } /// - /// How the rate is calculated. + /// + /// How the rate is calculated. + /// /// public RateAggregationDescriptor Mode(Elastic.Clients.Elasticsearch.Serverless.Aggregations.RateMode? mode) { @@ -153,7 +174,10 @@ public RateAggregationDescriptor Script(Action - /// The interval used to calculate the rate.
By default, the interval of the `date_histogram` is used. + /// + /// The interval used to calculate the rate. + /// By default, the interval of the date_histogram is used. + /// /// public RateAggregationDescriptor Unit(Elastic.Clients.Elasticsearch.Serverless.Aggregations.CalendarInterval? unit) { @@ -232,7 +256,9 @@ public RateAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Aggregations.CalendarInterval? UnitValue { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public RateAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -241,7 +267,9 @@ public RateAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless. } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public RateAggregationDescriptor Field(Expression> field) { @@ -250,7 +278,9 @@ public RateAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public RateAggregationDescriptor Field(Expression> field) { @@ -265,7 +295,10 @@ public RateAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public RateAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -274,7 +307,9 @@ public RateAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverles } /// - /// How the rate is calculated. + /// + /// How the rate is calculated. + /// /// public RateAggregationDescriptor Mode(Elastic.Clients.Elasticsearch.Serverless.Aggregations.RateMode? mode) { @@ -307,7 +342,10 @@ public RateAggregationDescriptor Script(Action - /// The interval used to calculate the rate.
By default, the interval of the `date_histogram` is used. + /// + /// The interval used to calculate the rate. + /// By default, the interval of the date_histogram is used. + /// /// public RateAggregationDescriptor Unit(Elastic.Clients.Elasticsearch.Serverless.Aggregations.CalendarInterval? unit) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ReverseNestedAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ReverseNestedAggregate.g.cs index 0bc30043dba..b4dcfa21b23 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ReverseNestedAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ReverseNestedAggregate.g.cs @@ -77,7 +77,9 @@ public override void Write(Utf8JsonWriter writer, ReverseNestedAggregate value, public sealed partial class ReverseNestedAggregate : IAggregate { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ReverseNestedAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ReverseNestedAggregation.g.cs index 3b83e415f4d..43c5ca5e4b5 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ReverseNestedAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ReverseNestedAggregation.g.cs @@ -30,7 +30,10 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class ReverseNestedAggregation { /// - /// Defines the nested object field that should be joined back to.
The default is empty, which means that it joins back to the root/main document level. + /// + /// Defines the nested object field that should be joined back to. + /// The default is empty, which means that it joins back to the root/main document level. + /// /// [JsonInclude, JsonPropertyName("path")] public Elastic.Clients.Elasticsearch.Serverless.Field? Path { get; set; } @@ -49,7 +52,10 @@ public ReverseNestedAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? PathValue { get; set; } /// - /// Defines the nested object field that should be joined back to.
The default is empty, which means that it joins back to the root/main document level. + /// + /// Defines the nested object field that should be joined back to. + /// The default is empty, which means that it joins back to the root/main document level. + /// /// public ReverseNestedAggregationDescriptor Path(Elastic.Clients.Elasticsearch.Serverless.Field? path) { @@ -58,7 +64,10 @@ public ReverseNestedAggregationDescriptor Path(Elastic.Clients.Elasti } /// - /// Defines the nested object field that should be joined back to.
The default is empty, which means that it joins back to the root/main document level. + /// + /// Defines the nested object field that should be joined back to. + /// The default is empty, which means that it joins back to the root/main document level. + /// /// public ReverseNestedAggregationDescriptor Path(Expression> path) { @@ -67,7 +76,10 @@ public ReverseNestedAggregationDescriptor Path(Expression - /// Defines the nested object field that should be joined back to.
The default is empty, which means that it joins back to the root/main document level. + /// + /// Defines the nested object field that should be joined back to. + /// The default is empty, which means that it joins back to the root/main document level. + /// /// public ReverseNestedAggregationDescriptor Path(Expression> path) { @@ -99,7 +111,10 @@ public ReverseNestedAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? PathValue { get; set; } /// - /// Defines the nested object field that should be joined back to.
The default is empty, which means that it joins back to the root/main document level. + /// + /// Defines the nested object field that should be joined back to. + /// The default is empty, which means that it joins back to the root/main document level. + /// /// public ReverseNestedAggregationDescriptor Path(Elastic.Clients.Elasticsearch.Serverless.Field? path) { @@ -108,7 +123,10 @@ public ReverseNestedAggregationDescriptor Path(Elastic.Clients.Elasticsearch.Ser } /// - /// Defines the nested object field that should be joined back to.
The default is empty, which means that it joins back to the root/main document level. + /// + /// Defines the nested object field that should be joined back to. + /// The default is empty, which means that it joins back to the root/main document level. + /// /// public ReverseNestedAggregationDescriptor Path(Expression> path) { @@ -117,7 +135,10 @@ public ReverseNestedAggregationDescriptor Path(Expression - /// Defines the nested object field that should be joined back to.
The default is empty, which means that it joins back to the root/main document level. + /// + /// Defines the nested object field that should be joined back to. + /// The default is empty, which means that it joins back to the root/main document level. + /// /// public ReverseNestedAggregationDescriptor Path(Expression> path) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SamplerAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SamplerAggregate.g.cs index 192ef284a8d..f067ef6d31b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SamplerAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SamplerAggregate.g.cs @@ -77,7 +77,9 @@ public override void Write(Utf8JsonWriter writer, SamplerAggregate value, JsonSe public sealed partial class SamplerAggregate : IAggregate { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SamplerAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SamplerAggregation.g.cs index 374bad487d2..c9c3d45d203 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SamplerAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SamplerAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class SamplerAggregation { /// - /// Limits how many top-scoring documents are collected in the sample processed on each shard. + /// + /// Limits how many top-scoring documents are collected in the sample processed on each shard. + /// /// [JsonInclude, JsonPropertyName("shard_size")] public int? ShardSize { get; set; } @@ -49,7 +51,9 @@ public SamplerAggregationDescriptor() : base() private int? ShardSizeValue { get; set; } /// - /// Limits how many top-scoring documents are collected in the sample processed on each shard. + /// + /// Limits how many top-scoring documents are collected in the sample processed on each shard. + /// /// public SamplerAggregationDescriptor ShardSize(int? shardSize) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ScriptedMetricAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ScriptedMetricAggregation.g.cs index 01239e3e1e9..789e93828b2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ScriptedMetricAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ScriptedMetricAggregation.g.cs @@ -30,43 +30,63 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class ScriptedMetricAggregation { /// - /// Runs once on each shard after document collection is complete.
Allows the aggregation to consolidate the state returned from each shard. + /// + /// Runs once on each shard after document collection is complete. + /// Allows the aggregation to consolidate the state returned from each shard. + /// /// [JsonInclude, JsonPropertyName("combine_script")] public Elastic.Clients.Elasticsearch.Serverless.Script? CombineScript { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } /// - /// Runs prior to any collection of documents.
Allows the aggregation to set up any initial state. + /// + /// Runs prior to any collection of documents. + /// Allows the aggregation to set up any initial state. + /// /// [JsonInclude, JsonPropertyName("init_script")] public Elastic.Clients.Elasticsearch.Serverless.Script? InitScript { get; set; } /// - /// Run once per document collected.
If no `combine_script` is specified, the resulting state needs to be stored in the `state` object. + /// + /// Run once per document collected. + /// If no combine_script is specified, the resulting state needs to be stored in the state object. + /// /// [JsonInclude, JsonPropertyName("map_script")] public Elastic.Clients.Elasticsearch.Serverless.Script? MapScript { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.Serverless.FieldValue? Missing { get; set; } /// - /// A global object with script parameters for `init`, `map` and `combine` scripts.
It is shared between the scripts. + /// + /// A global object with script parameters for init, map and combine scripts. + /// It is shared between the scripts. + /// /// [JsonInclude, JsonPropertyName("params")] public IDictionary? Params { get; set; } /// - /// Runs once on the coordinating node after all shards have returned their results.
The script is provided with access to a variable `states`, which is an array of the result of the `combine_script` on each shard. + /// + /// Runs once on the coordinating node after all shards have returned their results. + /// The script is provided with access to a variable states, which is an array of the result of the combine_script on each shard. + /// /// [JsonInclude, JsonPropertyName("reduce_script")] public Elastic.Clients.Elasticsearch.Serverless.Script? ReduceScript { get; set; } @@ -104,7 +124,10 @@ public ScriptedMetricAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// Runs once on each shard after document collection is complete.
Allows the aggregation to consolidate the state returned from each shard. + /// + /// Runs once on each shard after document collection is complete. + /// Allows the aggregation to consolidate the state returned from each shard. + /// /// public ScriptedMetricAggregationDescriptor CombineScript(Elastic.Clients.Elasticsearch.Serverless.Script? combineScript) { @@ -131,7 +154,9 @@ public ScriptedMetricAggregationDescriptor CombineScript(Action - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ScriptedMetricAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -140,7 +165,9 @@ public ScriptedMetricAggregationDescriptor Field(Elastic.Clients.Elas } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ScriptedMetricAggregationDescriptor Field(Expression> field) { @@ -149,7 +176,9 @@ public ScriptedMetricAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ScriptedMetricAggregationDescriptor Field(Expression> field) { @@ -158,7 +187,10 @@ public ScriptedMetricAggregationDescriptor Field(Expression - /// Runs prior to any collection of documents.
Allows the aggregation to set up any initial state. + /// + /// Runs prior to any collection of documents. + /// Allows the aggregation to set up any initial state. + /// /// public ScriptedMetricAggregationDescriptor InitScript(Elastic.Clients.Elasticsearch.Serverless.Script? initScript) { @@ -185,7 +217,10 @@ public ScriptedMetricAggregationDescriptor InitScript(Action - /// Run once per document collected.
If no `combine_script` is specified, the resulting state needs to be stored in the `state` object. + /// + /// Run once per document collected. + /// If no combine_script is specified, the resulting state needs to be stored in the state object. + /// /// public ScriptedMetricAggregationDescriptor MapScript(Elastic.Clients.Elasticsearch.Serverless.Script? mapScript) { @@ -212,7 +247,10 @@ public ScriptedMetricAggregationDescriptor MapScript(Action - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public ScriptedMetricAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -221,7 +259,10 @@ public ScriptedMetricAggregationDescriptor Missing(Elastic.Clients.El } /// - /// A global object with script parameters for `init`, `map` and `combine` scripts.
It is shared between the scripts. + /// + /// A global object with script parameters for init, map and combine scripts. + /// It is shared between the scripts. + /// /// public ScriptedMetricAggregationDescriptor Params(Func, FluentDictionary> selector) { @@ -230,7 +271,10 @@ public ScriptedMetricAggregationDescriptor Params(Func - /// Runs once on the coordinating node after all shards have returned their results.
The script is provided with access to a variable `states`, which is an array of the result of the `combine_script` on each shard. + /// + /// Runs once on the coordinating node after all shards have returned their results. + /// The script is provided with access to a variable states, which is an array of the result of the combine_script on each shard. + /// /// public ScriptedMetricAggregationDescriptor ReduceScript(Elastic.Clients.Elasticsearch.Serverless.Script? reduceScript) { @@ -413,7 +457,10 @@ public ScriptedMetricAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// Runs once on each shard after document collection is complete.
Allows the aggregation to consolidate the state returned from each shard. + /// + /// Runs once on each shard after document collection is complete. + /// Allows the aggregation to consolidate the state returned from each shard. + /// /// public ScriptedMetricAggregationDescriptor CombineScript(Elastic.Clients.Elasticsearch.Serverless.Script? combineScript) { @@ -440,7 +487,9 @@ public ScriptedMetricAggregationDescriptor CombineScript(Action - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ScriptedMetricAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -449,7 +498,9 @@ public ScriptedMetricAggregationDescriptor Field(Elastic.Clients.Elasticsearch.S } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ScriptedMetricAggregationDescriptor Field(Expression> field) { @@ -458,7 +509,9 @@ public ScriptedMetricAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ScriptedMetricAggregationDescriptor Field(Expression> field) { @@ -467,7 +520,10 @@ public ScriptedMetricAggregationDescriptor Field(Expression - /// Runs prior to any collection of documents.
Allows the aggregation to set up any initial state. + /// + /// Runs prior to any collection of documents. + /// Allows the aggregation to set up any initial state. + /// /// public ScriptedMetricAggregationDescriptor InitScript(Elastic.Clients.Elasticsearch.Serverless.Script? initScript) { @@ -494,7 +550,10 @@ public ScriptedMetricAggregationDescriptor InitScript(Action - /// Run once per document collected.
If no `combine_script` is specified, the resulting state needs to be stored in the `state` object. + /// + /// Run once per document collected. + /// If no combine_script is specified, the resulting state needs to be stored in the state object. + /// /// public ScriptedMetricAggregationDescriptor MapScript(Elastic.Clients.Elasticsearch.Serverless.Script? mapScript) { @@ -521,7 +580,10 @@ public ScriptedMetricAggregationDescriptor MapScript(Action - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public ScriptedMetricAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -530,7 +592,10 @@ public ScriptedMetricAggregationDescriptor Missing(Elastic.Clients.Elasticsearch } /// - /// A global object with script parameters for `init`, `map` and `combine` scripts.
It is shared between the scripts. + /// + /// A global object with script parameters for init, map and combine scripts. + /// It is shared between the scripts. + /// /// public ScriptedMetricAggregationDescriptor Params(Func, FluentDictionary> selector) { @@ -539,7 +604,10 @@ public ScriptedMetricAggregationDescriptor Params(Func - /// Runs once on the coordinating node after all shards have returned their results.
The script is provided with access to a variable `states`, which is an array of the result of the `combine_script` on each shard. + /// + /// Runs once on the coordinating node after all shards have returned their results. + /// The script is provided with access to a variable states, which is an array of the result of the combine_script on each shard. + /// /// public ScriptedMetricAggregationDescriptor ReduceScript(Elastic.Clients.Elasticsearch.Serverless.Script? reduceScript) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SerialDifferencingAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SerialDifferencingAggregation.g.cs index 6f091db5caf..ce7e96c21ea 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SerialDifferencingAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SerialDifferencingAggregation.g.cs @@ -30,25 +30,35 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class SerialDifferencingAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? GapPolicy { get; set; } /// - /// The historical bucket to subtract from the current value.
Must be a positive, non-zero integer. + /// + /// The historical bucket to subtract from the current value. + /// Must be a positive, non-zero integer. + /// /// [JsonInclude, JsonPropertyName("lag")] public int? Lag { get; set; } @@ -70,7 +80,9 @@ public SerialDifferencingAggregationDescriptor() : base() private int? LagValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public SerialDifferencingAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? bucketsPath) { @@ -79,7 +91,10 @@ public SerialDifferencingAggregationDescriptor BucketsPath(Elastic.Clients.Elast } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public SerialDifferencingAggregationDescriptor Format(string? format) { @@ -88,7 +103,9 @@ public SerialDifferencingAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public SerialDifferencingAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? gapPolicy) { @@ -97,7 +114,10 @@ public SerialDifferencingAggregationDescriptor GapPolicy(Elastic.Clients.Elastic } /// - /// The historical bucket to subtract from the current value.
Must be a positive, non-zero integer. + /// + /// The historical bucket to subtract from the current value. + /// Must be a positive, non-zero integer. + /// /// public SerialDifferencingAggregationDescriptor Lag(int? lag) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SignificantLongTermsBucket.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SignificantLongTermsBucket.g.cs index 8dc978ac649..b2e0622e3b8 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SignificantLongTermsBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SignificantLongTermsBucket.g.cs @@ -98,7 +98,9 @@ public override void Write(Utf8JsonWriter writer, SignificantLongTermsBucket val public sealed partial class SignificantLongTermsBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary Aggregations { get; init; } public long BgCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SignificantStringTermsBucket.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SignificantStringTermsBucket.g.cs index 063f37d37d3..4adf4ae4fc4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SignificantStringTermsBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SignificantStringTermsBucket.g.cs @@ -91,7 +91,9 @@ public override void Write(Utf8JsonWriter writer, SignificantStringTermsBucket v public sealed partial class SignificantStringTermsBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary Aggregations { get; init; } public long BgCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SignificantTermsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SignificantTermsAggregation.g.cs index a9cd778550b..68da3188fa9 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SignificantTermsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SignificantTermsAggregation.g.cs @@ -30,91 +30,123 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class SignificantTermsAggregation { /// - /// A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. + /// + /// A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. + /// /// [JsonInclude, JsonPropertyName("background_filter")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? BackgroundFilter { get; set; } /// - /// Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. + /// + /// Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. + /// /// [JsonInclude, JsonPropertyName("chi_square")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.ChiSquareHeuristic? ChiSquare { get; set; } /// - /// Terms to exclude. + /// + /// Terms to exclude. + /// /// [JsonInclude, JsonPropertyName("exclude")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsExclude? Exclude { get; set; } /// - /// Mechanism by which the aggregation should be executed: using field values directly or using global ordinals. + /// + /// Mechanism by which the aggregation should be executed: using field values directly or using global ordinals. + /// /// [JsonInclude, JsonPropertyName("execution_hint")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsAggregationExecutionHint? ExecutionHint { get; set; } /// - /// The field from which to return significant terms. + /// + /// The field from which to return significant terms. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } /// - /// Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + /// + /// Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + /// /// [JsonInclude, JsonPropertyName("gnd")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.GoogleNormalizedDistanceHeuristic? Gnd { get; set; } /// - /// Terms to include. + /// + /// Terms to include. + /// /// [JsonInclude, JsonPropertyName("include")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsInclude? Include { get; set; } /// - /// Use JLH score as the significance score. + /// + /// Use JLH score as the significance score. + /// /// [JsonInclude, JsonPropertyName("jlh")] public Elastic.Clients.Elasticsearch.Serverless.EmptyObject? Jlh { get; set; } /// - /// Only return terms that are found in more than `min_doc_count` hits. + /// + /// Only return terms that are found in more than min_doc_count hits. + /// /// [JsonInclude, JsonPropertyName("min_doc_count")] public long? MinDocCount { get; set; } /// - /// Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. + /// + /// Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. + /// /// [JsonInclude, JsonPropertyName("mutual_information")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.MutualInformationHeuristic? MutualInformation { get; set; } /// - /// A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. + /// + /// A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. + /// /// [JsonInclude, JsonPropertyName("percentage")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.PercentageScoreHeuristic? Percentage { get; set; } /// - /// Customized score, implemented via a script. + /// + /// Customized score, implemented via a script. + /// /// [JsonInclude, JsonPropertyName("script_heuristic")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.ScriptedHeuristic? ScriptHeuristic { get; set; } /// - /// Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`.
Terms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. + /// + /// Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the min_doc_count. + /// Terms will only be considered if their local shard frequency within the set is higher than the shard_min_doc_count. + /// /// [JsonInclude, JsonPropertyName("shard_min_doc_count")] public long? ShardMinDocCount { get; set; } /// - /// Can be used to control the volumes of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// + /// Can be used to control the volumes of candidate terms produced by each shard. + /// By default, shard_size will be automatically estimated based on the number of shards and the size parameter. + /// /// [JsonInclude, JsonPropertyName("shard_size")] public int? ShardSize { get; set; } /// - /// The number of buckets returned out of the overall terms list. + /// + /// The number of buckets returned out of the overall terms list. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } @@ -161,7 +193,9 @@ public SignificantTermsAggregationDescriptor() : base() private int? SizeValue { get; set; } /// - /// A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. + /// + /// A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. + /// /// public SignificantTermsAggregationDescriptor BackgroundFilter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? backgroundFilter) { @@ -188,7 +222,9 @@ public SignificantTermsAggregationDescriptor BackgroundFilter(Action< } /// - /// Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. + /// + /// Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. + /// /// public SignificantTermsAggregationDescriptor ChiSquare(Elastic.Clients.Elasticsearch.Serverless.Aggregations.ChiSquareHeuristic? chiSquare) { @@ -215,7 +251,9 @@ public SignificantTermsAggregationDescriptor ChiSquare(Action - /// Terms to exclude. + /// + /// Terms to exclude. + /// /// public SignificantTermsAggregationDescriptor Exclude(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsExclude? exclude) { @@ -224,7 +262,9 @@ public SignificantTermsAggregationDescriptor Exclude(Elastic.Clients. } /// - /// Mechanism by which the aggregation should be executed: using field values directly or using global ordinals. + /// + /// Mechanism by which the aggregation should be executed: using field values directly or using global ordinals. + /// /// public SignificantTermsAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsAggregationExecutionHint? executionHint) { @@ -233,7 +273,9 @@ public SignificantTermsAggregationDescriptor ExecutionHint(Elastic.Cl } /// - /// The field from which to return significant terms. + /// + /// The field from which to return significant terms. + /// /// public SignificantTermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -242,7 +284,9 @@ public SignificantTermsAggregationDescriptor Field(Elastic.Clients.El } /// - /// The field from which to return significant terms. + /// + /// The field from which to return significant terms. + /// /// public SignificantTermsAggregationDescriptor Field(Expression> field) { @@ -251,7 +295,9 @@ public SignificantTermsAggregationDescriptor Field(Expression } /// - /// The field from which to return significant terms. + /// + /// The field from which to return significant terms. + /// /// public SignificantTermsAggregationDescriptor Field(Expression> field) { @@ -260,7 +306,9 @@ public SignificantTermsAggregationDescriptor Field(Expression - /// Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + /// + /// Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + /// /// public SignificantTermsAggregationDescriptor Gnd(Elastic.Clients.Elasticsearch.Serverless.Aggregations.GoogleNormalizedDistanceHeuristic? gnd) { @@ -287,7 +335,9 @@ public SignificantTermsAggregationDescriptor Gnd(Action - /// Terms to include. + /// + /// Terms to include. + /// /// public SignificantTermsAggregationDescriptor Include(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsInclude? include) { @@ -296,7 +346,9 @@ public SignificantTermsAggregationDescriptor Include(Elastic.Clients. } /// - /// Use JLH score as the significance score. + /// + /// Use JLH score as the significance score. + /// /// public SignificantTermsAggregationDescriptor Jlh(Elastic.Clients.Elasticsearch.Serverless.EmptyObject? jlh) { @@ -323,7 +375,9 @@ public SignificantTermsAggregationDescriptor Jlh(Action - /// Only return terms that are found in more than `min_doc_count` hits. + /// + /// Only return terms that are found in more than min_doc_count hits. + /// /// public SignificantTermsAggregationDescriptor MinDocCount(long? minDocCount) { @@ -332,7 +386,9 @@ public SignificantTermsAggregationDescriptor MinDocCount(long? minDoc } /// - /// Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. + /// + /// Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. + /// /// public SignificantTermsAggregationDescriptor MutualInformation(Elastic.Clients.Elasticsearch.Serverless.Aggregations.MutualInformationHeuristic? mutualInformation) { @@ -359,7 +415,9 @@ public SignificantTermsAggregationDescriptor MutualInformation(Action } /// - /// A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. + /// + /// A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. + /// /// public SignificantTermsAggregationDescriptor Percentage(Elastic.Clients.Elasticsearch.Serverless.Aggregations.PercentageScoreHeuristic? percentage) { @@ -386,7 +444,9 @@ public SignificantTermsAggregationDescriptor Percentage(Action - /// Customized score, implemented via a script. + /// + /// Customized score, implemented via a script. + /// /// public SignificantTermsAggregationDescriptor ScriptHeuristic(Elastic.Clients.Elasticsearch.Serverless.Aggregations.ScriptedHeuristic? scriptHeuristic) { @@ -413,7 +473,10 @@ public SignificantTermsAggregationDescriptor ScriptHeuristic(Action - /// Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`.
Terms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. + /// + /// Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the min_doc_count. + /// Terms will only be considered if their local shard frequency within the set is higher than the shard_min_doc_count. + /// /// public SignificantTermsAggregationDescriptor ShardMinDocCount(long? shardMinDocCount) { @@ -422,7 +485,10 @@ public SignificantTermsAggregationDescriptor ShardMinDocCount(long? s } /// - /// Can be used to control the volumes of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// + /// Can be used to control the volumes of candidate terms produced by each shard. + /// By default, shard_size will be automatically estimated based on the number of shards and the size parameter. + /// /// public SignificantTermsAggregationDescriptor ShardSize(int? shardSize) { @@ -431,7 +497,9 @@ public SignificantTermsAggregationDescriptor ShardSize(int? shardSize } /// - /// The number of buckets returned out of the overall terms list. + /// + /// The number of buckets returned out of the overall terms list. + /// /// public SignificantTermsAggregationDescriptor Size(int? size) { @@ -645,7 +713,9 @@ public SignificantTermsAggregationDescriptor() : base() private int? SizeValue { get; set; } /// - /// A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. + /// + /// A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. + /// /// public SignificantTermsAggregationDescriptor BackgroundFilter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? backgroundFilter) { @@ -672,7 +742,9 @@ public SignificantTermsAggregationDescriptor BackgroundFilter(Action - /// Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. + /// + /// Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. + /// /// public SignificantTermsAggregationDescriptor ChiSquare(Elastic.Clients.Elasticsearch.Serverless.Aggregations.ChiSquareHeuristic? chiSquare) { @@ -699,7 +771,9 @@ public SignificantTermsAggregationDescriptor ChiSquare(Action - /// Terms to exclude. + /// + /// Terms to exclude. + /// /// public SignificantTermsAggregationDescriptor Exclude(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsExclude? exclude) { @@ -708,7 +782,9 @@ public SignificantTermsAggregationDescriptor Exclude(Elastic.Clients.Elasticsear } /// - /// Mechanism by which the aggregation should be executed: using field values directly or using global ordinals. + /// + /// Mechanism by which the aggregation should be executed: using field values directly or using global ordinals. + /// /// public SignificantTermsAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsAggregationExecutionHint? executionHint) { @@ -717,7 +793,9 @@ public SignificantTermsAggregationDescriptor ExecutionHint(Elastic.Clients.Elast } /// - /// The field from which to return significant terms. + /// + /// The field from which to return significant terms. + /// /// public SignificantTermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -726,7 +804,9 @@ public SignificantTermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch } /// - /// The field from which to return significant terms. + /// + /// The field from which to return significant terms. + /// /// public SignificantTermsAggregationDescriptor Field(Expression> field) { @@ -735,7 +815,9 @@ public SignificantTermsAggregationDescriptor Field(Expression } /// - /// The field from which to return significant terms. + /// + /// The field from which to return significant terms. + /// /// public SignificantTermsAggregationDescriptor Field(Expression> field) { @@ -744,7 +826,9 @@ public SignificantTermsAggregationDescriptor Field(Expression - /// Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + /// + /// Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + /// /// public SignificantTermsAggregationDescriptor Gnd(Elastic.Clients.Elasticsearch.Serverless.Aggregations.GoogleNormalizedDistanceHeuristic? gnd) { @@ -771,7 +855,9 @@ public SignificantTermsAggregationDescriptor Gnd(Action - /// Terms to include. + /// + /// Terms to include. + /// /// public SignificantTermsAggregationDescriptor Include(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsInclude? include) { @@ -780,7 +866,9 @@ public SignificantTermsAggregationDescriptor Include(Elastic.Clients.Elasticsear } /// - /// Use JLH score as the significance score. + /// + /// Use JLH score as the significance score. + /// /// public SignificantTermsAggregationDescriptor Jlh(Elastic.Clients.Elasticsearch.Serverless.EmptyObject? jlh) { @@ -807,7 +895,9 @@ public SignificantTermsAggregationDescriptor Jlh(Action - /// Only return terms that are found in more than `min_doc_count` hits. + /// + /// Only return terms that are found in more than min_doc_count hits. + /// /// public SignificantTermsAggregationDescriptor MinDocCount(long? minDocCount) { @@ -816,7 +906,9 @@ public SignificantTermsAggregationDescriptor MinDocCount(long? minDocCount) } /// - /// Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. + /// + /// Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. + /// /// public SignificantTermsAggregationDescriptor MutualInformation(Elastic.Clients.Elasticsearch.Serverless.Aggregations.MutualInformationHeuristic? mutualInformation) { @@ -843,7 +935,9 @@ public SignificantTermsAggregationDescriptor MutualInformation(Action - /// A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. + /// + /// A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. + /// /// public SignificantTermsAggregationDescriptor Percentage(Elastic.Clients.Elasticsearch.Serverless.Aggregations.PercentageScoreHeuristic? percentage) { @@ -870,7 +964,9 @@ public SignificantTermsAggregationDescriptor Percentage(Action - /// Customized score, implemented via a script. + /// + /// Customized score, implemented via a script. + /// /// public SignificantTermsAggregationDescriptor ScriptHeuristic(Elastic.Clients.Elasticsearch.Serverless.Aggregations.ScriptedHeuristic? scriptHeuristic) { @@ -897,7 +993,10 @@ public SignificantTermsAggregationDescriptor ScriptHeuristic(Action - /// Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`.
Terms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. + /// + /// Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the min_doc_count. + /// Terms will only be considered if their local shard frequency within the set is higher than the shard_min_doc_count. + /// /// public SignificantTermsAggregationDescriptor ShardMinDocCount(long? shardMinDocCount) { @@ -906,7 +1005,10 @@ public SignificantTermsAggregationDescriptor ShardMinDocCount(long? shardMinDocC } /// - /// Can be used to control the volumes of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// + /// Can be used to control the volumes of candidate terms produced by each shard. + /// By default, shard_size will be automatically estimated based on the number of shards and the size parameter. + /// /// public SignificantTermsAggregationDescriptor ShardSize(int? shardSize) { @@ -915,7 +1017,9 @@ public SignificantTermsAggregationDescriptor ShardSize(int? shardSize) } /// - /// The number of buckets returned out of the overall terms list. + /// + /// The number of buckets returned out of the overall terms list. + /// /// public SignificantTermsAggregationDescriptor Size(int? size) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SignificantTextAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SignificantTextAggregation.g.cs index adbc2b53998..3b445cbbdda 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SignificantTextAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SignificantTextAggregation.g.cs @@ -30,103 +30,139 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class SignificantTextAggregation { /// - /// A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. + /// + /// A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. + /// /// [JsonInclude, JsonPropertyName("background_filter")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? BackgroundFilter { get; set; } /// - /// Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. + /// + /// Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. + /// /// [JsonInclude, JsonPropertyName("chi_square")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.ChiSquareHeuristic? ChiSquare { get; set; } /// - /// Values to exclude. + /// + /// Values to exclude. + /// /// [JsonInclude, JsonPropertyName("exclude")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsExclude? Exclude { get; set; } /// - /// Determines whether the aggregation will use field values directly or global ordinals. + /// + /// Determines whether the aggregation will use field values directly or global ordinals. + /// /// [JsonInclude, JsonPropertyName("execution_hint")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsAggregationExecutionHint? ExecutionHint { get; set; } /// - /// The field from which to return significant text. + /// + /// The field from which to return significant text. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } /// - /// Whether to out duplicate text to deal with noisy data. + /// + /// Whether to out duplicate text to deal with noisy data. + /// /// [JsonInclude, JsonPropertyName("filter_duplicate_text")] public bool? FilterDuplicateText { get; set; } /// - /// Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + /// + /// Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + /// /// [JsonInclude, JsonPropertyName("gnd")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.GoogleNormalizedDistanceHeuristic? Gnd { get; set; } /// - /// Values to include. + /// + /// Values to include. + /// /// [JsonInclude, JsonPropertyName("include")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsInclude? Include { get; set; } /// - /// Use JLH score as the significance score. + /// + /// Use JLH score as the significance score. + /// /// [JsonInclude, JsonPropertyName("jlh")] public Elastic.Clients.Elasticsearch.Serverless.EmptyObject? Jlh { get; set; } /// - /// Only return values that are found in more than `min_doc_count` hits. + /// + /// Only return values that are found in more than min_doc_count hits. + /// /// [JsonInclude, JsonPropertyName("min_doc_count")] public long? MinDocCount { get; set; } /// - /// Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. + /// + /// Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. + /// /// [JsonInclude, JsonPropertyName("mutual_information")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.MutualInformationHeuristic? MutualInformation { get; set; } /// - /// A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. + /// + /// A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. + /// /// [JsonInclude, JsonPropertyName("percentage")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.PercentageScoreHeuristic? Percentage { get; set; } /// - /// Customized score, implemented via a script. + /// + /// Customized score, implemented via a script. + /// /// [JsonInclude, JsonPropertyName("script_heuristic")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.ScriptedHeuristic? ScriptHeuristic { get; set; } /// - /// Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the min_doc_count.
Values will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. + /// + /// Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the min_doc_count. + /// Values will only be considered if their local shard frequency within the set is higher than the shard_min_doc_count. + /// /// [JsonInclude, JsonPropertyName("shard_min_doc_count")] public long? ShardMinDocCount { get; set; } /// - /// The number of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// + /// The number of candidate terms produced by each shard. + /// By default, shard_size will be automatically estimated based on the number of shards and the size parameter. + /// /// [JsonInclude, JsonPropertyName("shard_size")] public int? ShardSize { get; set; } /// - /// The number of buckets returned out of the overall terms list. + /// + /// The number of buckets returned out of the overall terms list. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// Overrides the JSON `_source` fields from which text will be analyzed. + /// + /// Overrides the JSON _source fields from which text will be analyzed. + /// /// [JsonInclude, JsonPropertyName("source_fields")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] @@ -176,7 +212,9 @@ public SignificantTextAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Fields? SourceFieldsValue { get; set; } /// - /// A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. + /// + /// A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. + /// /// public SignificantTextAggregationDescriptor BackgroundFilter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? backgroundFilter) { @@ -203,7 +241,9 @@ public SignificantTextAggregationDescriptor BackgroundFilter(Action - /// Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. + /// + /// Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. + /// /// public SignificantTextAggregationDescriptor ChiSquare(Elastic.Clients.Elasticsearch.Serverless.Aggregations.ChiSquareHeuristic? chiSquare) { @@ -230,7 +270,9 @@ public SignificantTextAggregationDescriptor ChiSquare(Action - /// Values to exclude. + /// + /// Values to exclude. + /// /// public SignificantTextAggregationDescriptor Exclude(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsExclude? exclude) { @@ -239,7 +281,9 @@ public SignificantTextAggregationDescriptor Exclude(Elastic.Clients.E } /// - /// Determines whether the aggregation will use field values directly or global ordinals. + /// + /// Determines whether the aggregation will use field values directly or global ordinals. + /// /// public SignificantTextAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsAggregationExecutionHint? executionHint) { @@ -248,7 +292,9 @@ public SignificantTextAggregationDescriptor ExecutionHint(Elastic.Cli } /// - /// The field from which to return significant text. + /// + /// The field from which to return significant text. + /// /// public SignificantTextAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -257,7 +303,9 @@ public SignificantTextAggregationDescriptor Field(Elastic.Clients.Ela } /// - /// The field from which to return significant text. + /// + /// The field from which to return significant text. + /// /// public SignificantTextAggregationDescriptor Field(Expression> field) { @@ -266,7 +314,9 @@ public SignificantTextAggregationDescriptor Field(Expression< } /// - /// The field from which to return significant text. + /// + /// The field from which to return significant text. + /// /// public SignificantTextAggregationDescriptor Field(Expression> field) { @@ -275,7 +325,9 @@ public SignificantTextAggregationDescriptor Field(Expression - /// Whether to out duplicate text to deal with noisy data. + /// + /// Whether to out duplicate text to deal with noisy data. + /// /// public SignificantTextAggregationDescriptor FilterDuplicateText(bool? filterDuplicateText = true) { @@ -284,7 +336,9 @@ public SignificantTextAggregationDescriptor FilterDuplicateText(bool? } /// - /// Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + /// + /// Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + /// /// public SignificantTextAggregationDescriptor Gnd(Elastic.Clients.Elasticsearch.Serverless.Aggregations.GoogleNormalizedDistanceHeuristic? gnd) { @@ -311,7 +365,9 @@ public SignificantTextAggregationDescriptor Gnd(Action - /// Values to include. + /// + /// Values to include. + /// /// public SignificantTextAggregationDescriptor Include(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsInclude? include) { @@ -320,7 +376,9 @@ public SignificantTextAggregationDescriptor Include(Elastic.Clients.E } /// - /// Use JLH score as the significance score. + /// + /// Use JLH score as the significance score. + /// /// public SignificantTextAggregationDescriptor Jlh(Elastic.Clients.Elasticsearch.Serverless.EmptyObject? jlh) { @@ -347,7 +405,9 @@ public SignificantTextAggregationDescriptor Jlh(Action - /// Only return values that are found in more than `min_doc_count` hits. + /// + /// Only return values that are found in more than min_doc_count hits. + /// /// public SignificantTextAggregationDescriptor MinDocCount(long? minDocCount) { @@ -356,7 +416,9 @@ public SignificantTextAggregationDescriptor MinDocCount(long? minDocC } /// - /// Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. + /// + /// Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. + /// /// public SignificantTextAggregationDescriptor MutualInformation(Elastic.Clients.Elasticsearch.Serverless.Aggregations.MutualInformationHeuristic? mutualInformation) { @@ -383,7 +445,9 @@ public SignificantTextAggregationDescriptor MutualInformation(Action< } /// - /// A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. + /// + /// A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. + /// /// public SignificantTextAggregationDescriptor Percentage(Elastic.Clients.Elasticsearch.Serverless.Aggregations.PercentageScoreHeuristic? percentage) { @@ -410,7 +474,9 @@ public SignificantTextAggregationDescriptor Percentage(Action - /// Customized score, implemented via a script. + /// + /// Customized score, implemented via a script. + /// /// public SignificantTextAggregationDescriptor ScriptHeuristic(Elastic.Clients.Elasticsearch.Serverless.Aggregations.ScriptedHeuristic? scriptHeuristic) { @@ -437,7 +503,10 @@ public SignificantTextAggregationDescriptor ScriptHeuristic(Action - /// Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the min_doc_count.
Values will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. + /// + /// Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the min_doc_count. + /// Values will only be considered if their local shard frequency within the set is higher than the shard_min_doc_count. + /// /// public SignificantTextAggregationDescriptor ShardMinDocCount(long? shardMinDocCount) { @@ -446,7 +515,10 @@ public SignificantTextAggregationDescriptor ShardMinDocCount(long? sh } /// - /// The number of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// + /// The number of candidate terms produced by each shard. + /// By default, shard_size will be automatically estimated based on the number of shards and the size parameter. + /// /// public SignificantTextAggregationDescriptor ShardSize(int? shardSize) { @@ -455,7 +527,9 @@ public SignificantTextAggregationDescriptor ShardSize(int? shardSize) } /// - /// The number of buckets returned out of the overall terms list. + /// + /// The number of buckets returned out of the overall terms list. + /// /// public SignificantTextAggregationDescriptor Size(int? size) { @@ -464,7 +538,9 @@ public SignificantTextAggregationDescriptor Size(int? size) } /// - /// Overrides the JSON `_source` fields from which text will be analyzed. + /// + /// Overrides the JSON _source fields from which text will be analyzed. + /// /// public SignificantTextAggregationDescriptor SourceFields(Elastic.Clients.Elasticsearch.Serverless.Fields? sourceFields) { @@ -692,7 +768,9 @@ public SignificantTextAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Fields? SourceFieldsValue { get; set; } /// - /// A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. + /// + /// A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. + /// /// public SignificantTextAggregationDescriptor BackgroundFilter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? backgroundFilter) { @@ -719,7 +797,9 @@ public SignificantTextAggregationDescriptor BackgroundFilter(Action - /// Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. + /// + /// Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. + /// /// public SignificantTextAggregationDescriptor ChiSquare(Elastic.Clients.Elasticsearch.Serverless.Aggregations.ChiSquareHeuristic? chiSquare) { @@ -746,7 +826,9 @@ public SignificantTextAggregationDescriptor ChiSquare(Action - /// Values to exclude. + /// + /// Values to exclude. + /// /// public SignificantTextAggregationDescriptor Exclude(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsExclude? exclude) { @@ -755,7 +837,9 @@ public SignificantTextAggregationDescriptor Exclude(Elastic.Clients.Elasticsearc } /// - /// Determines whether the aggregation will use field values directly or global ordinals. + /// + /// Determines whether the aggregation will use field values directly or global ordinals. + /// /// public SignificantTextAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsAggregationExecutionHint? executionHint) { @@ -764,7 +848,9 @@ public SignificantTextAggregationDescriptor ExecutionHint(Elastic.Clients.Elasti } /// - /// The field from which to return significant text. + /// + /// The field from which to return significant text. + /// /// public SignificantTextAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -773,7 +859,9 @@ public SignificantTextAggregationDescriptor Field(Elastic.Clients.Elasticsearch. } /// - /// The field from which to return significant text. + /// + /// The field from which to return significant text. + /// /// public SignificantTextAggregationDescriptor Field(Expression> field) { @@ -782,7 +870,9 @@ public SignificantTextAggregationDescriptor Field(Expression< } /// - /// The field from which to return significant text. + /// + /// The field from which to return significant text. + /// /// public SignificantTextAggregationDescriptor Field(Expression> field) { @@ -791,7 +881,9 @@ public SignificantTextAggregationDescriptor Field(Expression - /// Whether to out duplicate text to deal with noisy data. + /// + /// Whether to out duplicate text to deal with noisy data. + /// /// public SignificantTextAggregationDescriptor FilterDuplicateText(bool? filterDuplicateText = true) { @@ -800,7 +892,9 @@ public SignificantTextAggregationDescriptor FilterDuplicateText(bool? filterDupl } /// - /// Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + /// + /// Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + /// /// public SignificantTextAggregationDescriptor Gnd(Elastic.Clients.Elasticsearch.Serverless.Aggregations.GoogleNormalizedDistanceHeuristic? gnd) { @@ -827,7 +921,9 @@ public SignificantTextAggregationDescriptor Gnd(Action - /// Values to include. + /// + /// Values to include. + /// /// public SignificantTextAggregationDescriptor Include(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsInclude? include) { @@ -836,7 +932,9 @@ public SignificantTextAggregationDescriptor Include(Elastic.Clients.Elasticsearc } /// - /// Use JLH score as the significance score. + /// + /// Use JLH score as the significance score. + /// /// public SignificantTextAggregationDescriptor Jlh(Elastic.Clients.Elasticsearch.Serverless.EmptyObject? jlh) { @@ -863,7 +961,9 @@ public SignificantTextAggregationDescriptor Jlh(Action - /// Only return values that are found in more than `min_doc_count` hits. + /// + /// Only return values that are found in more than min_doc_count hits. + /// /// public SignificantTextAggregationDescriptor MinDocCount(long? minDocCount) { @@ -872,7 +972,9 @@ public SignificantTextAggregationDescriptor MinDocCount(long? minDocCount) } /// - /// Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. + /// + /// Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. + /// /// public SignificantTextAggregationDescriptor MutualInformation(Elastic.Clients.Elasticsearch.Serverless.Aggregations.MutualInformationHeuristic? mutualInformation) { @@ -899,7 +1001,9 @@ public SignificantTextAggregationDescriptor MutualInformation(Action - /// A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. + /// + /// A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. + /// /// public SignificantTextAggregationDescriptor Percentage(Elastic.Clients.Elasticsearch.Serverless.Aggregations.PercentageScoreHeuristic? percentage) { @@ -926,7 +1030,9 @@ public SignificantTextAggregationDescriptor Percentage(Action - /// Customized score, implemented via a script. + /// + /// Customized score, implemented via a script. + /// /// public SignificantTextAggregationDescriptor ScriptHeuristic(Elastic.Clients.Elasticsearch.Serverless.Aggregations.ScriptedHeuristic? scriptHeuristic) { @@ -953,7 +1059,10 @@ public SignificantTextAggregationDescriptor ScriptHeuristic(Action - /// Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the min_doc_count.
Values will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. + /// + /// Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the min_doc_count. + /// Values will only be considered if their local shard frequency within the set is higher than the shard_min_doc_count. + /// /// public SignificantTextAggregationDescriptor ShardMinDocCount(long? shardMinDocCount) { @@ -962,7 +1071,10 @@ public SignificantTextAggregationDescriptor ShardMinDocCount(long? shardMinDocCo } /// - /// The number of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// + /// The number of candidate terms produced by each shard. + /// By default, shard_size will be automatically estimated based on the number of shards and the size parameter. + /// /// public SignificantTextAggregationDescriptor ShardSize(int? shardSize) { @@ -971,7 +1083,9 @@ public SignificantTextAggregationDescriptor ShardSize(int? shardSize) } /// - /// The number of buckets returned out of the overall terms list. + /// + /// The number of buckets returned out of the overall terms list. + /// /// public SignificantTextAggregationDescriptor Size(int? size) { @@ -980,7 +1094,9 @@ public SignificantTextAggregationDescriptor Size(int? size) } /// - /// Overrides the JSON `_source` fields from which text will be analyzed. + /// + /// Overrides the JSON _source fields from which text will be analyzed. + /// /// public SignificantTextAggregationDescriptor SourceFields(Elastic.Clients.Elasticsearch.Serverless.Fields? sourceFields) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SimpleValueAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SimpleValueAggregate.g.cs index 767adb9f317..68ac88cf2db 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SimpleValueAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SimpleValueAggregate.g.cs @@ -33,7 +33,10 @@ public sealed partial class SimpleValueAggregate : IAggregate public IReadOnlyDictionary? Meta { get; init; } /// - /// The metric value. A missing value generally means that there was no data to aggregate,
unless specified otherwise. + /// + /// The metric value. A missing value generally means that there was no data to aggregate, + /// unless specified otherwise. + /// /// [JsonInclude, JsonPropertyName("value")] public double? Value { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StatsAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StatsAggregate.g.cs index a8c8c66d214..cd96a122c42 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StatsAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StatsAggregate.g.cs @@ -28,7 +28,10 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; /// -/// Statistics aggregation result. `min`, `max` and `avg` are missing if there were no values to process
(`count` is zero). +/// +/// Statistics aggregation result. min, max and avg are missing if there were no values to process +/// (count is zero). +/// /// public sealed partial class StatsAggregate : IAggregate { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StatsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StatsAggregation.g.cs index 2f5f90a7f08..24d99d20aa3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StatsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StatsAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class StatsAggregation { /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } @@ -38,7 +40,10 @@ public sealed partial class StatsAggregation public string? Format { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.Serverless.FieldValue? Missing { get; set; } @@ -64,7 +69,9 @@ public StatsAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public StatsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -73,7 +80,9 @@ public StatsAggregationDescriptor Field(Elastic.Clients.Elasticsearch } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public StatsAggregationDescriptor Field(Expression> field) { @@ -82,7 +91,9 @@ public StatsAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public StatsAggregationDescriptor Field(Expression> field) { @@ -97,7 +108,10 @@ public StatsAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public StatsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -186,7 +200,9 @@ public StatsAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public StatsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -195,7 +211,9 @@ public StatsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public StatsAggregationDescriptor Field(Expression> field) { @@ -204,7 +222,9 @@ public StatsAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public StatsAggregationDescriptor Field(Expression> field) { @@ -219,7 +239,10 @@ public StatsAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public StatsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StatsBucketAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StatsBucketAggregation.g.cs index aaaa57c420d..216123f3b03 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StatsBucketAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StatsBucketAggregation.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class StatsBucketAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? GapPolicy { get; set; } @@ -63,7 +70,9 @@ public StatsBucketAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? GapPolicyValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public StatsBucketAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? bucketsPath) { @@ -72,7 +81,10 @@ public StatsBucketAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearc } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public StatsBucketAggregationDescriptor Format(string? format) { @@ -81,7 +93,9 @@ public StatsBucketAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public StatsBucketAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? gapPolicy) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StringRareTermsAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StringRareTermsAggregate.g.cs index fd301b335c9..04fb7cdb10c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StringRareTermsAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StringRareTermsAggregate.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; /// -/// Result of the `rare_terms` aggregation when the field is a string. +/// +/// Result of the rare_terms aggregation when the field is a string. +/// /// public sealed partial class StringRareTermsAggregate : IAggregate { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StringRareTermsBucket.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StringRareTermsBucket.g.cs index 64bb1f6b9a4..1bc02b85d3b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StringRareTermsBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StringRareTermsBucket.g.cs @@ -77,7 +77,9 @@ public override void Write(Utf8JsonWriter writer, StringRareTermsBucket value, J public sealed partial class StringRareTermsBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StringStatsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StringStatsAggregation.g.cs index df8ff10e4d5..b92f2f6afa0 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StringStatsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StringStatsAggregation.g.cs @@ -30,13 +30,18 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class StringStatsAggregation { /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.Serverless.FieldValue? Missing { get; set; } @@ -44,7 +49,9 @@ public sealed partial class StringStatsAggregation public Elastic.Clients.Elasticsearch.Serverless.Script? Script { get; set; } /// - /// Shows the probability distribution for all characters. + /// + /// Shows the probability distribution for all characters. + /// /// [JsonInclude, JsonPropertyName("show_distribution")] public bool? ShowDistribution { get; set; } @@ -68,7 +75,9 @@ public StringStatsAggregationDescriptor() : base() private bool? ShowDistributionValue { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public StringStatsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -77,7 +86,9 @@ public StringStatsAggregationDescriptor Field(Elastic.Clients.Elastic } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public StringStatsAggregationDescriptor Field(Expression> field) { @@ -86,7 +97,9 @@ public StringStatsAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public StringStatsAggregationDescriptor Field(Expression> field) { @@ -95,7 +108,10 @@ public StringStatsAggregationDescriptor Field(Expression - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public StringStatsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -128,7 +144,9 @@ public StringStatsAggregationDescriptor Script(Action - /// Shows the probability distribution for all characters. + /// + /// Shows the probability distribution for all characters. + /// /// public StringStatsAggregationDescriptor ShowDistribution(bool? showDistribution = true) { @@ -193,7 +211,9 @@ public StringStatsAggregationDescriptor() : base() private bool? ShowDistributionValue { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public StringStatsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -202,7 +222,9 @@ public StringStatsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serv } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public StringStatsAggregationDescriptor Field(Expression> field) { @@ -211,7 +233,9 @@ public StringStatsAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public StringStatsAggregationDescriptor Field(Expression> field) { @@ -220,7 +244,10 @@ public StringStatsAggregationDescriptor Field(Expression - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public StringStatsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -253,7 +280,9 @@ public StringStatsAggregationDescriptor Script(Action - /// Shows the probability distribution for all characters. + /// + /// Shows the probability distribution for all characters. + /// /// public StringStatsAggregationDescriptor ShowDistribution(bool? showDistribution = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StringTermsAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StringTermsAggregate.g.cs index 08b2070fa46..88ae16d8ebf 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StringTermsAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StringTermsAggregate.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; /// -/// Result of a `terms` aggregation when the field is a string. +/// +/// Result of a terms aggregation when the field is a string. +/// /// public sealed partial class StringTermsAggregate : IAggregate { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StringTermsBucket.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StringTermsBucket.g.cs index d368fb1bbfd..013a4dbbaed 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StringTermsBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/StringTermsBucket.g.cs @@ -84,7 +84,9 @@ public override void Write(Utf8JsonWriter writer, StringTermsBucket value, JsonS public sealed partial class StringTermsBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SumAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SumAggregate.g.cs index ae3ff25da92..238d466c9b9 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SumAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SumAggregate.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; /// -/// Sum aggregation result. `value` is always present and is zero if there were no values to process. +/// +/// Sum aggregation result. value is always present and is zero if there were no values to process. +/// /// public sealed partial class SumAggregate : IAggregate { @@ -36,7 +38,10 @@ public sealed partial class SumAggregate : IAggregate public IReadOnlyDictionary? Meta { get; init; } /// - /// The metric value. A missing value generally means that there was no data to aggregate,
unless specified otherwise. + /// + /// The metric value. A missing value generally means that there was no data to aggregate, + /// unless specified otherwise. + /// /// [JsonInclude, JsonPropertyName("value")] public double? Value { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SumAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SumAggregation.g.cs index e3d0a830165..5c73f9a9e1b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SumAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SumAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class SumAggregation { /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } @@ -38,7 +40,10 @@ public sealed partial class SumAggregation public string? Format { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.Serverless.FieldValue? Missing { get; set; } @@ -64,7 +69,9 @@ public SumAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public SumAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -73,7 +80,9 @@ public SumAggregationDescriptor Field(Elastic.Clients.Elasticsearch.S } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public SumAggregationDescriptor Field(Expression> field) { @@ -82,7 +91,9 @@ public SumAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public SumAggregationDescriptor Field(Expression> field) { @@ -97,7 +108,10 @@ public SumAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public SumAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -186,7 +200,9 @@ public SumAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public SumAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -195,7 +211,9 @@ public SumAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.F } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public SumAggregationDescriptor Field(Expression> field) { @@ -204,7 +222,9 @@ public SumAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public SumAggregationDescriptor Field(Expression> field) { @@ -219,7 +239,10 @@ public SumAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public SumAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SumBucketAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SumBucketAggregation.g.cs index 0f3275e662b..5ee5875ebec 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SumBucketAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/SumBucketAggregation.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class SumBucketAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? GapPolicy { get; set; } @@ -63,7 +70,9 @@ public SumBucketAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? GapPolicyValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public SumBucketAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Serverless.Aggregations.BucketsPath? bucketsPath) { @@ -72,7 +81,10 @@ public SumBucketAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch. } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public SumBucketAggregationDescriptor Format(string? format) { @@ -81,7 +93,9 @@ public SumBucketAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public SumBucketAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Serverless.Aggregations.GapPolicy? gapPolicy) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/TDigest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/TDigest.g.cs index e726728e480..4b8114bc7bd 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/TDigest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/TDigest.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class TDigest { /// - /// Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. + /// + /// Limits the maximum number of nodes used by the underlying TDigest algorithm to 20 * compression, enabling control of memory usage and approximation error. + /// /// [JsonInclude, JsonPropertyName("compression")] public int? Compression { get; set; } @@ -47,7 +49,9 @@ public TDigestDescriptor() : base() private int? CompressionValue { get; set; } /// - /// Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. + /// + /// Limits the maximum number of nodes used by the underlying TDigest algorithm to 20 * compression, enabling control of memory usage and approximation error. + /// /// public TDigestDescriptor Compression(int? compression) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/TTestAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/TTestAggregation.g.cs index 4c20ff006ed..a91f300f7dd 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/TTestAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/TTestAggregation.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class TTestAggregation { /// - /// Test population A. + /// + /// Test population A. + /// /// [JsonInclude, JsonPropertyName("a")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.TestPopulation? a { get; set; } /// - /// Test population B. + /// + /// Test population B. + /// /// [JsonInclude, JsonPropertyName("b")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.TestPopulation? b { get; set; } /// - /// The type of test. + /// + /// The type of test. + /// /// [JsonInclude, JsonPropertyName("type")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.TTestType? Type { get; set; } @@ -67,7 +73,9 @@ public TTestAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Aggregations.TTestType? TypeValue { get; set; } /// - /// Test population A. + /// + /// Test population A. + /// /// public TTestAggregationDescriptor a(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TestPopulation? a) { @@ -94,7 +102,9 @@ public TTestAggregationDescriptor a(Action - /// Test population B. + /// + /// Test population B. + /// /// public TTestAggregationDescriptor b(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TestPopulation? b) { @@ -121,7 +131,9 @@ public TTestAggregationDescriptor b(Action - /// The type of test. + /// + /// The type of test. + /// /// public TTestAggregationDescriptor Type(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TTestType? type) { @@ -191,7 +203,9 @@ public TTestAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Aggregations.TTestType? TypeValue { get; set; } /// - /// Test population A. + /// + /// Test population A. + /// /// public TTestAggregationDescriptor a(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TestPopulation? a) { @@ -218,7 +232,9 @@ public TTestAggregationDescriptor a(Action - /// Test population B. + /// + /// Test population B. + /// /// public TTestAggregationDescriptor b(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TestPopulation? b) { @@ -245,7 +261,9 @@ public TTestAggregationDescriptor b(Action - /// The type of test. + /// + /// The type of test. + /// /// public TTestAggregationDescriptor Type(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TTestType? type) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/TermsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/TermsAggregation.g.cs index 528f792cd66..58078764401 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/TermsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/TermsAggregation.g.cs @@ -30,25 +30,34 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class TermsAggregation { /// - /// Determines how child aggregations should be calculated: breadth-first or depth-first. + /// + /// Determines how child aggregations should be calculated: breadth-first or depth-first. + /// /// [JsonInclude, JsonPropertyName("collect_mode")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsAggregationCollectMode? CollectMode { get; set; } /// - /// Values to exclude.
Accepts regular expressions and partitions. + /// + /// Values to exclude. + /// Accepts regular expressions and partitions. + /// /// [JsonInclude, JsonPropertyName("exclude")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsExclude? Exclude { get; set; } /// - /// Determines whether the aggregation will use field values directly or global ordinals. + /// + /// Determines whether the aggregation will use field values directly or global ordinals. + /// /// [JsonInclude, JsonPropertyName("execution_hint")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsAggregationExecutionHint? ExecutionHint { get; set; } /// - /// The field from which to return terms. + /// + /// The field from which to return terms. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } @@ -56,19 +65,27 @@ public sealed partial class TermsAggregation public string? Format { get; set; } /// - /// Values to include.
Accepts regular expressions and partitions. + /// + /// Values to include. + /// Accepts regular expressions and partitions. + /// /// [JsonInclude, JsonPropertyName("include")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsInclude? Include { get; set; } /// - /// Only return values that are found in more than `min_doc_count` hits. + /// + /// Only return values that are found in more than min_doc_count hits. + /// /// [JsonInclude, JsonPropertyName("min_doc_count")] public int? MinDocCount { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.Serverless.FieldValue? Missing { get; set; } @@ -78,7 +95,10 @@ public sealed partial class TermsAggregation public Elastic.Clients.Elasticsearch.Serverless.Aggregations.MissingOrder? MissingOrder { get; set; } /// - /// Specifies the sort order of the buckets.
Defaults to sorting by descending document count. + /// + /// Specifies the sort order of the buckets. + /// Defaults to sorting by descending document count. + /// /// [JsonInclude, JsonPropertyName("order")] [SingleOrManyCollectionConverter(typeof(KeyValuePair))] @@ -87,31 +107,43 @@ public sealed partial class TermsAggregation public Elastic.Clients.Elasticsearch.Serverless.Script? Script { get; set; } /// - /// Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`.
Terms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. + /// + /// Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the min_doc_count. + /// Terms will only be considered if their local shard frequency within the set is higher than the shard_min_doc_count. + /// /// [JsonInclude, JsonPropertyName("shard_min_doc_count")] public long? ShardMinDocCount { get; set; } /// - /// The number of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// + /// The number of candidate terms produced by each shard. + /// By default, shard_size will be automatically estimated based on the number of shards and the size parameter. + /// /// [JsonInclude, JsonPropertyName("shard_size")] public int? ShardSize { get; set; } /// - /// Set to `true` to return the `doc_count_error_upper_bound`, which is an upper bound to the error on the `doc_count` returned by each shard. + /// + /// Set to true to return the doc_count_error_upper_bound, which is an upper bound to the error on the doc_count returned by each shard. + /// /// [JsonInclude, JsonPropertyName("show_term_doc_count_error")] public bool? ShowTermDocCountError { get; set; } /// - /// The number of buckets returned out of the overall terms list. + /// + /// The number of buckets returned out of the overall terms list. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// Coerced unmapped fields into the specified type. + /// + /// Coerced unmapped fields into the specified type. + /// /// [JsonInclude, JsonPropertyName("value_type")] public string? ValueType { get; set; } @@ -149,7 +181,9 @@ public TermsAggregationDescriptor() : base() private string? ValueTypeValue { get; set; } /// - /// Determines how child aggregations should be calculated: breadth-first or depth-first. + /// + /// Determines how child aggregations should be calculated: breadth-first or depth-first. + /// /// public TermsAggregationDescriptor CollectMode(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsAggregationCollectMode? collectMode) { @@ -158,7 +192,10 @@ public TermsAggregationDescriptor CollectMode(Elastic.Clients.Elastic } /// - /// Values to exclude.
Accepts regular expressions and partitions. + /// + /// Values to exclude. + /// Accepts regular expressions and partitions. + /// /// public TermsAggregationDescriptor Exclude(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsExclude? exclude) { @@ -167,7 +204,9 @@ public TermsAggregationDescriptor Exclude(Elastic.Clients.Elasticsear } /// - /// Determines whether the aggregation will use field values directly or global ordinals. + /// + /// Determines whether the aggregation will use field values directly or global ordinals. + /// /// public TermsAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsAggregationExecutionHint? executionHint) { @@ -176,7 +215,9 @@ public TermsAggregationDescriptor ExecutionHint(Elastic.Clients.Elast } /// - /// The field from which to return terms. + /// + /// The field from which to return terms. + /// /// public TermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -185,7 +226,9 @@ public TermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch } /// - /// The field from which to return terms. + /// + /// The field from which to return terms. + /// /// public TermsAggregationDescriptor Field(Expression> field) { @@ -194,7 +237,9 @@ public TermsAggregationDescriptor Field(Expression - /// The field from which to return terms. + /// + /// The field from which to return terms. + /// /// public TermsAggregationDescriptor Field(Expression> field) { @@ -209,7 +254,10 @@ public TermsAggregationDescriptor Format(string? format) } /// - /// Values to include.
Accepts regular expressions and partitions. + /// + /// Values to include. + /// Accepts regular expressions and partitions. + /// /// public TermsAggregationDescriptor Include(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsInclude? include) { @@ -218,7 +266,9 @@ public TermsAggregationDescriptor Include(Elastic.Clients.Elasticsear } /// - /// Only return values that are found in more than `min_doc_count` hits. + /// + /// Only return values that are found in more than min_doc_count hits. + /// /// public TermsAggregationDescriptor MinDocCount(int? minDocCount) { @@ -227,7 +277,10 @@ public TermsAggregationDescriptor MinDocCount(int? minDocCount) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public TermsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -248,7 +301,10 @@ public TermsAggregationDescriptor MissingOrder(Elastic.Clients.Elasti } /// - /// Specifies the sort order of the buckets.
Defaults to sorting by descending document count. + /// + /// Specifies the sort order of the buckets. + /// Defaults to sorting by descending document count. + /// /// public TermsAggregationDescriptor Order(ICollection>? order) { @@ -281,7 +337,10 @@ public TermsAggregationDescriptor Script(Action - /// Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`.
Terms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. + /// + /// Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the min_doc_count. + /// Terms will only be considered if their local shard frequency within the set is higher than the shard_min_doc_count. + /// /// public TermsAggregationDescriptor ShardMinDocCount(long? shardMinDocCount) { @@ -290,7 +349,10 @@ public TermsAggregationDescriptor ShardMinDocCount(long? shardMinDocC } /// - /// The number of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// + /// The number of candidate terms produced by each shard. + /// By default, shard_size will be automatically estimated based on the number of shards and the size parameter. + /// /// public TermsAggregationDescriptor ShardSize(int? shardSize) { @@ -299,7 +361,9 @@ public TermsAggregationDescriptor ShardSize(int? shardSize) } /// - /// Set to `true` to return the `doc_count_error_upper_bound`, which is an upper bound to the error on the `doc_count` returned by each shard. + /// + /// Set to true to return the doc_count_error_upper_bound, which is an upper bound to the error on the doc_count returned by each shard. + /// /// public TermsAggregationDescriptor ShowTermDocCountError(bool? showTermDocCountError = true) { @@ -308,7 +372,9 @@ public TermsAggregationDescriptor ShowTermDocCountError(bool? showTer } /// - /// The number of buckets returned out of the overall terms list. + /// + /// The number of buckets returned out of the overall terms list. + /// /// public TermsAggregationDescriptor Size(int? size) { @@ -317,7 +383,9 @@ public TermsAggregationDescriptor Size(int? size) } /// - /// Coerced unmapped fields into the specified type. + /// + /// Coerced unmapped fields into the specified type. + /// /// public TermsAggregationDescriptor ValueType(string? valueType) { @@ -473,7 +541,9 @@ public TermsAggregationDescriptor() : base() private string? ValueTypeValue { get; set; } /// - /// Determines how child aggregations should be calculated: breadth-first or depth-first. + /// + /// Determines how child aggregations should be calculated: breadth-first or depth-first. + /// /// public TermsAggregationDescriptor CollectMode(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsAggregationCollectMode? collectMode) { @@ -482,7 +552,10 @@ public TermsAggregationDescriptor CollectMode(Elastic.Clients.Elasticsearch.Serv } /// - /// Values to exclude.
Accepts regular expressions and partitions. + /// + /// Values to exclude. + /// Accepts regular expressions and partitions. + /// /// public TermsAggregationDescriptor Exclude(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsExclude? exclude) { @@ -491,7 +564,9 @@ public TermsAggregationDescriptor Exclude(Elastic.Clients.Elasticsearch.Serverle } /// - /// Determines whether the aggregation will use field values directly or global ordinals. + /// + /// Determines whether the aggregation will use field values directly or global ordinals. + /// /// public TermsAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsAggregationExecutionHint? executionHint) { @@ -500,7 +575,9 @@ public TermsAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsearch.Se } /// - /// The field from which to return terms. + /// + /// The field from which to return terms. + /// /// public TermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -509,7 +586,9 @@ public TermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless } /// - /// The field from which to return terms. + /// + /// The field from which to return terms. + /// /// public TermsAggregationDescriptor Field(Expression> field) { @@ -518,7 +597,9 @@ public TermsAggregationDescriptor Field(Expression - /// The field from which to return terms. + /// + /// The field from which to return terms. + /// /// public TermsAggregationDescriptor Field(Expression> field) { @@ -533,7 +614,10 @@ public TermsAggregationDescriptor Format(string? format) } /// - /// Values to include.
Accepts regular expressions and partitions. + /// + /// Values to include. + /// Accepts regular expressions and partitions. + /// /// public TermsAggregationDescriptor Include(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TermsInclude? include) { @@ -542,7 +626,9 @@ public TermsAggregationDescriptor Include(Elastic.Clients.Elasticsearch.Serverle } /// - /// Only return values that are found in more than `min_doc_count` hits. + /// + /// Only return values that are found in more than min_doc_count hits. + /// /// public TermsAggregationDescriptor MinDocCount(int? minDocCount) { @@ -551,7 +637,10 @@ public TermsAggregationDescriptor MinDocCount(int? minDocCount) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public TermsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -572,7 +661,10 @@ public TermsAggregationDescriptor MissingOrder(Elastic.Clients.Elasticsearch.Ser } /// - /// Specifies the sort order of the buckets.
Defaults to sorting by descending document count. + /// + /// Specifies the sort order of the buckets. + /// Defaults to sorting by descending document count. + /// /// public TermsAggregationDescriptor Order(ICollection>? order) { @@ -605,7 +697,10 @@ public TermsAggregationDescriptor Script(Action - /// Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`.
Terms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. + /// + /// Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the min_doc_count. + /// Terms will only be considered if their local shard frequency within the set is higher than the shard_min_doc_count. + /// /// public TermsAggregationDescriptor ShardMinDocCount(long? shardMinDocCount) { @@ -614,7 +709,10 @@ public TermsAggregationDescriptor ShardMinDocCount(long? shardMinDocCount) } /// - /// The number of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// + /// The number of candidate terms produced by each shard. + /// By default, shard_size will be automatically estimated based on the number of shards and the size parameter. + /// /// public TermsAggregationDescriptor ShardSize(int? shardSize) { @@ -623,7 +721,9 @@ public TermsAggregationDescriptor ShardSize(int? shardSize) } /// - /// Set to `true` to return the `doc_count_error_upper_bound`, which is an upper bound to the error on the `doc_count` returned by each shard. + /// + /// Set to true to return the doc_count_error_upper_bound, which is an upper bound to the error on the doc_count returned by each shard. + /// /// public TermsAggregationDescriptor ShowTermDocCountError(bool? showTermDocCountError = true) { @@ -632,7 +732,9 @@ public TermsAggregationDescriptor ShowTermDocCountError(bool? showTermDocCountEr } /// - /// The number of buckets returned out of the overall terms list. + /// + /// The number of buckets returned out of the overall terms list. + /// /// public TermsAggregationDescriptor Size(int? size) { @@ -641,7 +743,9 @@ public TermsAggregationDescriptor Size(int? size) } /// - /// Coerced unmapped fields into the specified type. + /// + /// Coerced unmapped fields into the specified type. + /// /// public TermsAggregationDescriptor ValueType(string? valueType) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/TestPopulation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/TestPopulation.g.cs index 5e3635f1fe2..45d39ff326b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/TestPopulation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/TestPopulation.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class TestPopulation { /// - /// The field to aggregate. + /// + /// The field to aggregate. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// A filter used to define a set of records to run unpaired t-test on. + /// + /// A filter used to define a set of records to run unpaired t-test on. + /// /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? Filter { get; set; } @@ -61,7 +65,9 @@ public TestPopulationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field to aggregate. + /// + /// The field to aggregate. + /// /// public TestPopulationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -70,7 +76,9 @@ public TestPopulationDescriptor Field(Elastic.Clients.Elasticsearch.S } /// - /// The field to aggregate. + /// + /// The field to aggregate. + /// /// public TestPopulationDescriptor Field(Expression> field) { @@ -79,7 +87,9 @@ public TestPopulationDescriptor Field(Expression - /// The field to aggregate. + /// + /// The field to aggregate. + /// /// public TestPopulationDescriptor Field(Expression> field) { @@ -88,7 +98,9 @@ public TestPopulationDescriptor Field(Expression - /// A filter used to define a set of records to run unpaired t-test on. + /// + /// A filter used to define a set of records to run unpaired t-test on. + /// /// public TestPopulationDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? filter) { @@ -196,7 +208,9 @@ public TestPopulationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field to aggregate. + /// + /// The field to aggregate. + /// /// public TestPopulationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -205,7 +219,9 @@ public TestPopulationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.F } /// - /// The field to aggregate. + /// + /// The field to aggregate. + /// /// public TestPopulationDescriptor Field(Expression> field) { @@ -214,7 +230,9 @@ public TestPopulationDescriptor Field(Expression - /// The field to aggregate. + /// + /// The field to aggregate. + /// /// public TestPopulationDescriptor Field(Expression> field) { @@ -223,7 +241,9 @@ public TestPopulationDescriptor Field(Expression - /// A filter used to define a set of records to run unpaired t-test on. + /// + /// A filter used to define a set of records to run unpaired t-test on. + /// /// public TestPopulationDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? filter) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/TopHitsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/TopHitsAggregation.g.cs index 179c1575afa..e61be0c1116 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/TopHitsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/TopHitsAggregation.g.cs @@ -30,43 +30,59 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class TopHitsAggregation { /// - /// Fields for which to return doc values. + /// + /// Fields for which to return doc values. + /// /// [JsonInclude, JsonPropertyName("docvalue_fields")] public ICollection? DocvalueFields { get; set; } /// - /// If `true`, returns detailed information about score computation as part of a hit. + /// + /// If true, returns detailed information about score computation as part of a hit. + /// /// [JsonInclude, JsonPropertyName("explain")] public bool? Explain { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } /// - /// Array of wildcard (*) patterns. The request returns values for field names
matching these patterns in the hits.fields property of the response. + /// + /// Array of wildcard (*) patterns. The request returns values for field names + /// matching these patterns in the hits.fields property of the response. + /// /// [JsonInclude, JsonPropertyName("fields")] public ICollection? Fields { get; set; } /// - /// Starting document offset. + /// + /// Starting document offset. + /// /// [JsonInclude, JsonPropertyName("from")] public int? From { get; set; } /// - /// Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in the search results. + /// + /// Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in the search results. + /// /// [JsonInclude, JsonPropertyName("highlight")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.Highlight? Highlight { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.Serverless.FieldValue? Missing { get; set; } @@ -74,51 +90,68 @@ public sealed partial class TopHitsAggregation public Elastic.Clients.Elasticsearch.Serverless.Script? Script { get; set; } /// - /// Returns the result of one or more script evaluations for each hit. + /// + /// Returns the result of one or more script evaluations for each hit. + /// /// [JsonInclude, JsonPropertyName("script_fields")] public IDictionary? ScriptFields { get; set; } /// - /// If `true`, returns sequence number and primary term of the last modification of each hit. + /// + /// If true, returns sequence number and primary term of the last modification of each hit. + /// /// [JsonInclude, JsonPropertyName("seq_no_primary_term")] public bool? SeqNoPrimaryTerm { get; set; } /// - /// The maximum number of top matching hits to return per bucket. + /// + /// The maximum number of top matching hits to return per bucket. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// Sort order of the top matching hits.
By default, the hits are sorted by the score of the main query. + /// + /// Sort order of the top matching hits. + /// By default, the hits are sorted by the score of the main query. + /// /// [JsonInclude, JsonPropertyName("sort")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.SortOptions))] public ICollection? Sort { get; set; } /// - /// Selects the fields of the source that are returned. + /// + /// Selects the fields of the source that are returned. + /// /// [JsonInclude, JsonPropertyName("_source")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfig? Source { get; set; } /// - /// Returns values for the specified stored fields (fields that use the `store` mapping option). + /// + /// Returns values for the specified stored fields (fields that use the store mapping option). + /// /// [JsonInclude, JsonPropertyName("stored_fields")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] public Elastic.Clients.Elasticsearch.Serverless.Fields? StoredFields { get; set; } /// - /// If `true`, calculates and returns document scores, even if the scores are not used for sorting. + /// + /// If true, calculates and returns document scores, even if the scores are not used for sorting. + /// /// [JsonInclude, JsonPropertyName("track_scores")] public bool? TrackScores { get; set; } /// - /// If `true`, returns document version as part of a hit. + /// + /// If true, returns document version as part of a hit. + /// /// [JsonInclude, JsonPropertyName("version")] public bool? Version { get; set; } @@ -165,7 +198,9 @@ public TopHitsAggregationDescriptor() : base() private bool? VersionValue { get; set; } /// - /// Fields for which to return doc values. + /// + /// Fields for which to return doc values. + /// /// public TopHitsAggregationDescriptor DocvalueFields(ICollection? docvalueFields) { @@ -204,7 +239,9 @@ public TopHitsAggregationDescriptor DocvalueFields(params Action - /// If `true`, returns detailed information about score computation as part of a hit. + /// + /// If true, returns detailed information about score computation as part of a hit. + /// /// public TopHitsAggregationDescriptor Explain(bool? explain = true) { @@ -213,7 +250,9 @@ public TopHitsAggregationDescriptor Explain(bool? explain = true) } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public TopHitsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -222,7 +261,9 @@ public TopHitsAggregationDescriptor Field(Elastic.Clients.Elasticsear } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public TopHitsAggregationDescriptor Field(Expression> field) { @@ -231,7 +272,9 @@ public TopHitsAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public TopHitsAggregationDescriptor Field(Expression> field) { @@ -240,7 +283,10 @@ public TopHitsAggregationDescriptor Field(Expression - /// Array of wildcard (*) patterns. The request returns values for field names
matching these patterns in the hits.fields property of the response. + /// + /// Array of wildcard (*) patterns. The request returns values for field names + /// matching these patterns in the hits.fields property of the response. + /// /// public TopHitsAggregationDescriptor Fields(ICollection? fields) { @@ -279,7 +325,9 @@ public TopHitsAggregationDescriptor Fields(params Action - /// Starting document offset. + /// + /// Starting document offset. + /// /// public TopHitsAggregationDescriptor From(int? from) { @@ -288,7 +336,9 @@ public TopHitsAggregationDescriptor From(int? from) } /// - /// Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in the search results. + /// + /// Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in the search results. + /// /// public TopHitsAggregationDescriptor Highlight(Elastic.Clients.Elasticsearch.Serverless.Core.Search.Highlight? highlight) { @@ -315,7 +365,10 @@ public TopHitsAggregationDescriptor Highlight(Action - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public TopHitsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -348,7 +401,9 @@ public TopHitsAggregationDescriptor Script(Action - /// Returns the result of one or more script evaluations for each hit. + /// + /// Returns the result of one or more script evaluations for each hit. + /// /// public TopHitsAggregationDescriptor ScriptFields(Func, FluentDescriptorDictionary> selector) { @@ -357,7 +412,9 @@ public TopHitsAggregationDescriptor ScriptFields(Func - /// If `true`, returns sequence number and primary term of the last modification of each hit. + /// + /// If true, returns sequence number and primary term of the last modification of each hit. + /// /// public TopHitsAggregationDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = true) { @@ -366,7 +423,9 @@ public TopHitsAggregationDescriptor SeqNoPrimaryTerm(bool? seqNoPrima } /// - /// The maximum number of top matching hits to return per bucket. + /// + /// The maximum number of top matching hits to return per bucket. + /// /// public TopHitsAggregationDescriptor Size(int? size) { @@ -375,7 +434,10 @@ public TopHitsAggregationDescriptor Size(int? size) } /// - /// Sort order of the top matching hits.
By default, the hits are sorted by the score of the main query. + /// + /// Sort order of the top matching hits. + /// By default, the hits are sorted by the score of the main query. + /// /// public TopHitsAggregationDescriptor Sort(ICollection? sort) { @@ -414,7 +476,9 @@ public TopHitsAggregationDescriptor Sort(params Action - /// Selects the fields of the source that are returned. + /// + /// Selects the fields of the source that are returned. + /// /// public TopHitsAggregationDescriptor Source(Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfig? source) { @@ -423,7 +487,9 @@ public TopHitsAggregationDescriptor Source(Elastic.Clients.Elasticsea } /// - /// Returns values for the specified stored fields (fields that use the `store` mapping option). + /// + /// Returns values for the specified stored fields (fields that use the store mapping option). + /// /// public TopHitsAggregationDescriptor StoredFields(Elastic.Clients.Elasticsearch.Serverless.Fields? storedFields) { @@ -432,7 +498,9 @@ public TopHitsAggregationDescriptor StoredFields(Elastic.Clients.Elas } /// - /// If `true`, calculates and returns document scores, even if the scores are not used for sorting. + /// + /// If true, calculates and returns document scores, even if the scores are not used for sorting. + /// /// public TopHitsAggregationDescriptor TrackScores(bool? trackScores = true) { @@ -441,7 +509,9 @@ public TopHitsAggregationDescriptor TrackScores(bool? trackScores = t } /// - /// If `true`, returns document version as part of a hit. + /// + /// If true, returns document version as part of a hit. + /// /// public TopHitsAggregationDescriptor Version(bool? version = true) { @@ -684,7 +754,9 @@ public TopHitsAggregationDescriptor() : base() private bool? VersionValue { get; set; } /// - /// Fields for which to return doc values. + /// + /// Fields for which to return doc values. + /// /// public TopHitsAggregationDescriptor DocvalueFields(ICollection? docvalueFields) { @@ -723,7 +795,9 @@ public TopHitsAggregationDescriptor DocvalueFields(params Action - /// If `true`, returns detailed information about score computation as part of a hit. + /// + /// If true, returns detailed information about score computation as part of a hit. + /// /// public TopHitsAggregationDescriptor Explain(bool? explain = true) { @@ -732,7 +806,9 @@ public TopHitsAggregationDescriptor Explain(bool? explain = true) } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public TopHitsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -741,7 +817,9 @@ public TopHitsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverle } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public TopHitsAggregationDescriptor Field(Expression> field) { @@ -750,7 +828,9 @@ public TopHitsAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public TopHitsAggregationDescriptor Field(Expression> field) { @@ -759,7 +839,10 @@ public TopHitsAggregationDescriptor Field(Expression - /// Array of wildcard (*) patterns. The request returns values for field names
matching these patterns in the hits.fields property of the response. + /// + /// Array of wildcard (*) patterns. The request returns values for field names + /// matching these patterns in the hits.fields property of the response. + /// /// public TopHitsAggregationDescriptor Fields(ICollection? fields) { @@ -798,7 +881,9 @@ public TopHitsAggregationDescriptor Fields(params Action - /// Starting document offset. + /// + /// Starting document offset. + /// /// public TopHitsAggregationDescriptor From(int? from) { @@ -807,7 +892,9 @@ public TopHitsAggregationDescriptor From(int? from) } /// - /// Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in the search results. + /// + /// Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in the search results. + /// /// public TopHitsAggregationDescriptor Highlight(Elastic.Clients.Elasticsearch.Serverless.Core.Search.Highlight? highlight) { @@ -834,7 +921,10 @@ public TopHitsAggregationDescriptor Highlight(Action - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public TopHitsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -867,7 +957,9 @@ public TopHitsAggregationDescriptor Script(Action - /// Returns the result of one or more script evaluations for each hit. + /// + /// Returns the result of one or more script evaluations for each hit. + /// /// public TopHitsAggregationDescriptor ScriptFields(Func, FluentDescriptorDictionary> selector) { @@ -876,7 +968,9 @@ public TopHitsAggregationDescriptor ScriptFields(Func - /// If `true`, returns sequence number and primary term of the last modification of each hit. + /// + /// If true, returns sequence number and primary term of the last modification of each hit. + /// /// public TopHitsAggregationDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = true) { @@ -885,7 +979,9 @@ public TopHitsAggregationDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = tr } /// - /// The maximum number of top matching hits to return per bucket. + /// + /// The maximum number of top matching hits to return per bucket. + /// /// public TopHitsAggregationDescriptor Size(int? size) { @@ -894,7 +990,10 @@ public TopHitsAggregationDescriptor Size(int? size) } /// - /// Sort order of the top matching hits.
By default, the hits are sorted by the score of the main query. + /// + /// Sort order of the top matching hits. + /// By default, the hits are sorted by the score of the main query. + /// /// public TopHitsAggregationDescriptor Sort(ICollection? sort) { @@ -933,7 +1032,9 @@ public TopHitsAggregationDescriptor Sort(params Action - /// Selects the fields of the source that are returned. + /// + /// Selects the fields of the source that are returned. + /// /// public TopHitsAggregationDescriptor Source(Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfig? source) { @@ -942,7 +1043,9 @@ public TopHitsAggregationDescriptor Source(Elastic.Clients.Elasticsearch.Serverl } /// - /// Returns values for the specified stored fields (fields that use the `store` mapping option). + /// + /// Returns values for the specified stored fields (fields that use the store mapping option). + /// /// public TopHitsAggregationDescriptor StoredFields(Elastic.Clients.Elasticsearch.Serverless.Fields? storedFields) { @@ -951,7 +1054,9 @@ public TopHitsAggregationDescriptor StoredFields(Elastic.Clients.Elasticsearch.S } /// - /// If `true`, calculates and returns document scores, even if the scores are not used for sorting. + /// + /// If true, calculates and returns document scores, even if the scores are not used for sorting. + /// /// public TopHitsAggregationDescriptor TrackScores(bool? trackScores = true) { @@ -960,7 +1065,9 @@ public TopHitsAggregationDescriptor TrackScores(bool? trackScores = true) } /// - /// If `true`, returns document version as part of a hit. + /// + /// If true, returns document version as part of a hit. + /// /// public TopHitsAggregationDescriptor Version(bool? version = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/TopMetricsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/TopMetricsAggregation.g.cs index e66cc60a861..2fbf37981d7 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/TopMetricsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/TopMetricsAggregation.g.cs @@ -30,20 +30,27 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class TopMetricsAggregation { /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } /// - /// The fields of the top document to return. + /// + /// The fields of the top document to return. + /// /// [JsonInclude, JsonPropertyName("metrics")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.Aggregations.TopMetricsValue))] public ICollection? Metrics { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.Serverless.FieldValue? Missing { get; set; } @@ -51,13 +58,17 @@ public sealed partial class TopMetricsAggregation public Elastic.Clients.Elasticsearch.Serverless.Script? Script { get; set; } /// - /// The number of top documents from which to return metrics. + /// + /// The number of top documents from which to return metrics. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// The sort order of the documents. + /// + /// The sort order of the documents. + /// /// [JsonInclude, JsonPropertyName("sort")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.SortOptions))] @@ -90,7 +101,9 @@ public TopMetricsAggregationDescriptor() : base() private Action>[] SortDescriptorActions { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public TopMetricsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -99,7 +112,9 @@ public TopMetricsAggregationDescriptor Field(Elastic.Clients.Elastics } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public TopMetricsAggregationDescriptor Field(Expression> field) { @@ -108,7 +123,9 @@ public TopMetricsAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public TopMetricsAggregationDescriptor Field(Expression> field) { @@ -117,7 +134,9 @@ public TopMetricsAggregationDescriptor Field(Expression - /// The fields of the top document to return. + /// + /// The fields of the top document to return. + /// /// public TopMetricsAggregationDescriptor Metrics(ICollection? metrics) { @@ -156,7 +175,10 @@ public TopMetricsAggregationDescriptor Metrics(params Action - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public TopMetricsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -189,7 +211,9 @@ public TopMetricsAggregationDescriptor Script(Action - /// The number of top documents from which to return metrics. + /// + /// The number of top documents from which to return metrics. + /// /// public TopMetricsAggregationDescriptor Size(int? size) { @@ -198,7 +222,9 @@ public TopMetricsAggregationDescriptor Size(int? size) } /// - /// The sort order of the documents. + /// + /// The sort order of the documents. + /// /// public TopMetricsAggregationDescriptor Sort(ICollection? sort) { @@ -359,7 +385,9 @@ public TopMetricsAggregationDescriptor() : base() private Action[] SortDescriptorActions { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public TopMetricsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -368,7 +396,9 @@ public TopMetricsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serve } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public TopMetricsAggregationDescriptor Field(Expression> field) { @@ -377,7 +407,9 @@ public TopMetricsAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public TopMetricsAggregationDescriptor Field(Expression> field) { @@ -386,7 +418,9 @@ public TopMetricsAggregationDescriptor Field(Expression - /// The fields of the top document to return. + /// + /// The fields of the top document to return. + /// /// public TopMetricsAggregationDescriptor Metrics(ICollection? metrics) { @@ -425,7 +459,10 @@ public TopMetricsAggregationDescriptor Metrics(params Action - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public TopMetricsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -458,7 +495,9 @@ public TopMetricsAggregationDescriptor Script(Action - /// The number of top documents from which to return metrics. + /// + /// The number of top documents from which to return metrics. + /// /// public TopMetricsAggregationDescriptor Size(int? size) { @@ -467,7 +506,9 @@ public TopMetricsAggregationDescriptor Size(int? size) } /// - /// The sort order of the documents. + /// + /// The sort order of the documents. + /// /// public TopMetricsAggregationDescriptor Sort(ICollection? sort) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/TopMetricsValue.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/TopMetricsValue.g.cs index 8ce4bbd4206..2d425cf31c3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/TopMetricsValue.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/TopMetricsValue.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class TopMetricsValue { /// - /// A field to return as a metric. + /// + /// A field to return as a metric. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } @@ -47,7 +49,9 @@ public TopMetricsValueDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field FieldValue { get; set; } /// - /// A field to return as a metric. + /// + /// A field to return as a metric. + /// /// public TopMetricsValueDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -56,7 +60,9 @@ public TopMetricsValueDescriptor Field(Elastic.Clients.Elasticsearch. } /// - /// A field to return as a metric. + /// + /// A field to return as a metric. + /// /// public TopMetricsValueDescriptor Field(Expression> field) { @@ -65,7 +71,9 @@ public TopMetricsValueDescriptor Field(Expression - /// A field to return as a metric. + /// + /// A field to return as a metric. + /// /// public TopMetricsValueDescriptor Field(Expression> field) { @@ -93,7 +101,9 @@ public TopMetricsValueDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field FieldValue { get; set; } /// - /// A field to return as a metric. + /// + /// A field to return as a metric. + /// /// public TopMetricsValueDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -102,7 +112,9 @@ public TopMetricsValueDescriptor Field(Elastic.Clients.Elasticsearch.Serverless. } /// - /// A field to return as a metric. + /// + /// A field to return as a metric. + /// /// public TopMetricsValueDescriptor Field(Expression> field) { @@ -111,7 +123,9 @@ public TopMetricsValueDescriptor Field(Expression - /// A field to return as a metric. + /// + /// A field to return as a metric. + /// /// public TopMetricsValueDescriptor Field(Expression> field) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/UnmappedRareTermsAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/UnmappedRareTermsAggregate.g.cs index d597a6059e6..1c1fbf17411 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/UnmappedRareTermsAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/UnmappedRareTermsAggregate.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; /// -/// Result of a `rare_terms` aggregation when the field is unmapped. `buckets` is always empty. +/// +/// Result of a rare_terms aggregation when the field is unmapped. buckets is always empty. +/// /// public sealed partial class UnmappedRareTermsAggregate : IAggregate { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/UnmappedSamplerAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/UnmappedSamplerAggregate.g.cs index 861fdab5a7c..631e5546508 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/UnmappedSamplerAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/UnmappedSamplerAggregate.g.cs @@ -77,7 +77,9 @@ public override void Write(Utf8JsonWriter writer, UnmappedSamplerAggregate value public sealed partial class UnmappedSamplerAggregate : IAggregate { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/UnmappedSignificantTermsAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/UnmappedSignificantTermsAggregate.g.cs index 33eb4a09dbf..5d1b5dc369d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/UnmappedSignificantTermsAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/UnmappedSignificantTermsAggregate.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; /// -/// Result of the `significant_terms` aggregation on an unmapped field. `buckets` is always empty. +/// +/// Result of the significant_terms aggregation on an unmapped field. buckets is always empty. +/// /// public sealed partial class UnmappedSignificantTermsAggregate : IAggregate { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/UnmappedTermsAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/UnmappedTermsAggregate.g.cs index 0353dce9731..cc5108caa82 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/UnmappedTermsAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/UnmappedTermsAggregate.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; /// -/// Result of a `terms` aggregation when the field is unmapped. `buckets` is always empty. +/// +/// Result of a terms aggregation when the field is unmapped. buckets is always empty. +/// /// public sealed partial class UnmappedTermsAggregate : IAggregate { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ValueCountAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ValueCountAggregate.g.cs index 02d2017ebfe..c17384089a2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ValueCountAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ValueCountAggregate.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; /// -/// Value count aggregation result. `value` is always present. +/// +/// Value count aggregation result. value is always present. +/// /// public sealed partial class ValueCountAggregate : IAggregate { @@ -36,7 +38,10 @@ public sealed partial class ValueCountAggregate : IAggregate public IReadOnlyDictionary? Meta { get; init; } /// - /// The metric value. A missing value generally means that there was no data to aggregate,
unless specified otherwise. + /// + /// The metric value. A missing value generally means that there was no data to aggregate, + /// unless specified otherwise. + /// /// [JsonInclude, JsonPropertyName("value")] public double? Value { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ValueCountAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ValueCountAggregation.g.cs index 1ff4ffdfe96..e3bb51d98ea 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ValueCountAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/ValueCountAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class ValueCountAggregation { /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } @@ -38,7 +40,10 @@ public sealed partial class ValueCountAggregation public string? Format { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.Serverless.FieldValue? Missing { get; set; } @@ -64,7 +69,9 @@ public ValueCountAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ValueCountAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -73,7 +80,9 @@ public ValueCountAggregationDescriptor Field(Elastic.Clients.Elastics } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ValueCountAggregationDescriptor Field(Expression> field) { @@ -82,7 +91,9 @@ public ValueCountAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ValueCountAggregationDescriptor Field(Expression> field) { @@ -97,7 +108,10 @@ public ValueCountAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public ValueCountAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { @@ -186,7 +200,9 @@ public ValueCountAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ValueCountAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -195,7 +211,9 @@ public ValueCountAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serve } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ValueCountAggregationDescriptor Field(Expression> field) { @@ -204,7 +222,9 @@ public ValueCountAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ValueCountAggregationDescriptor Field(Expression> field) { @@ -219,7 +239,10 @@ public ValueCountAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public ValueCountAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Serverless.FieldValue? missing) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/VariableWidthHistogramAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/VariableWidthHistogramAggregation.g.cs index 585ccdd2539..3505931b801 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/VariableWidthHistogramAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/VariableWidthHistogramAggregation.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class VariableWidthHistogramAggregation { /// - /// The target number of buckets. + /// + /// The target number of buckets. + /// /// [JsonInclude, JsonPropertyName("buckets")] public int? Buckets { get; set; } /// - /// The name of the field. + /// + /// The name of the field. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } /// - /// Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run.
Defaults to `min(10 * shard_size, 50000)`. + /// + /// Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run. + /// Defaults to min(10 * shard_size, 50000). + /// /// [JsonInclude, JsonPropertyName("initial_buffer")] public int? InitialBuffer { get; set; } @@ -50,7 +57,10 @@ public sealed partial class VariableWidthHistogramAggregation public Elastic.Clients.Elasticsearch.Serverless.Script? Script { get; set; } /// - /// The number of buckets that the coordinating node will request from each shard.
Defaults to `buckets * 50`. + /// + /// The number of buckets that the coordinating node will request from each shard. + /// Defaults to buckets * 50. + /// /// [JsonInclude, JsonPropertyName("shard_size")] public int? ShardSize { get; set; } @@ -75,7 +85,9 @@ public VariableWidthHistogramAggregationDescriptor() : base() private int? ShardSizeValue { get; set; } /// - /// The target number of buckets. + /// + /// The target number of buckets. + /// /// public VariableWidthHistogramAggregationDescriptor Buckets(int? buckets) { @@ -84,7 +96,9 @@ public VariableWidthHistogramAggregationDescriptor Buckets(int? bucke } /// - /// The name of the field. + /// + /// The name of the field. + /// /// public VariableWidthHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -93,7 +107,9 @@ public VariableWidthHistogramAggregationDescriptor Field(Elastic.Clie } /// - /// The name of the field. + /// + /// The name of the field. + /// /// public VariableWidthHistogramAggregationDescriptor Field(Expression> field) { @@ -102,7 +118,9 @@ public VariableWidthHistogramAggregationDescriptor Field(Expr } /// - /// The name of the field. + /// + /// The name of the field. + /// /// public VariableWidthHistogramAggregationDescriptor Field(Expression> field) { @@ -111,7 +129,10 @@ public VariableWidthHistogramAggregationDescriptor Field(Expression - /// Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run.
Defaults to `min(10 * shard_size, 50000)`. + /// + /// Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run. + /// Defaults to min(10 * shard_size, 50000). + /// /// public VariableWidthHistogramAggregationDescriptor InitialBuffer(int? initialBuffer) { @@ -144,7 +165,10 @@ public VariableWidthHistogramAggregationDescriptor Script(Action - /// The number of buckets that the coordinating node will request from each shard.
Defaults to `buckets * 50`. + /// + /// The number of buckets that the coordinating node will request from each shard. + /// Defaults to buckets * 50. + /// /// public VariableWidthHistogramAggregationDescriptor ShardSize(int? shardSize) { @@ -216,7 +240,9 @@ public VariableWidthHistogramAggregationDescriptor() : base() private int? ShardSizeValue { get; set; } /// - /// The target number of buckets. + /// + /// The target number of buckets. + /// /// public VariableWidthHistogramAggregationDescriptor Buckets(int? buckets) { @@ -225,7 +251,9 @@ public VariableWidthHistogramAggregationDescriptor Buckets(int? buckets) } /// - /// The name of the field. + /// + /// The name of the field. + /// /// public VariableWidthHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -234,7 +262,9 @@ public VariableWidthHistogramAggregationDescriptor Field(Elastic.Clients.Elastic } /// - /// The name of the field. + /// + /// The name of the field. + /// /// public VariableWidthHistogramAggregationDescriptor Field(Expression> field) { @@ -243,7 +273,9 @@ public VariableWidthHistogramAggregationDescriptor Field(Expr } /// - /// The name of the field. + /// + /// The name of the field. + /// /// public VariableWidthHistogramAggregationDescriptor Field(Expression> field) { @@ -252,7 +284,10 @@ public VariableWidthHistogramAggregationDescriptor Field(Expression - /// Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run.
Defaults to `min(10 * shard_size, 50000)`. + /// + /// Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run. + /// Defaults to min(10 * shard_size, 50000). + /// /// public VariableWidthHistogramAggregationDescriptor InitialBuffer(int? initialBuffer) { @@ -285,7 +320,10 @@ public VariableWidthHistogramAggregationDescriptor Script(Action - /// The number of buckets that the coordinating node will request from each shard.
Defaults to `buckets * 50`. + /// + /// The number of buckets that the coordinating node will request from each shard. + /// Defaults to buckets * 50. + /// /// public VariableWidthHistogramAggregationDescriptor ShardSize(int? shardSize) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/VariableWidthHistogramBucket.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/VariableWidthHistogramBucket.g.cs index 5050994fafd..a088c167857 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/VariableWidthHistogramBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/VariableWidthHistogramBucket.g.cs @@ -112,7 +112,9 @@ public override void Write(Utf8JsonWriter writer, VariableWidthHistogramBucket v public sealed partial class VariableWidthHistogramBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/WeightedAverageAggregate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/WeightedAverageAggregate.g.cs index 4bd66cfeebf..e54a85ecb15 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/WeightedAverageAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/WeightedAverageAggregate.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; /// -/// Weighted average aggregation result. `value` is missing if the weight was set to zero. +/// +/// Weighted average aggregation result. value is missing if the weight was set to zero. +/// /// public sealed partial class WeightedAverageAggregate : IAggregate { @@ -36,7 +38,10 @@ public sealed partial class WeightedAverageAggregate : IAggregate public IReadOnlyDictionary? Meta { get; init; } /// - /// The metric value. A missing value generally means that there was no data to aggregate,
unless specified otherwise. + /// + /// The metric value. A missing value generally means that there was no data to aggregate, + /// unless specified otherwise. + /// /// [JsonInclude, JsonPropertyName("value")] public double? Value { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/WeightedAverageAggregation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/WeightedAverageAggregation.g.cs index d0074c4e431..0ac4cfbcb50 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/WeightedAverageAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/WeightedAverageAggregation.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class WeightedAverageAggregation { /// - /// A numeric response formatter. + /// + /// A numeric response formatter. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Configuration for the field that provides the values. + /// + /// Configuration for the field that provides the values. + /// /// [JsonInclude, JsonPropertyName("value")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.WeightedAverageValue? Value { get; set; } @@ -44,7 +48,9 @@ public sealed partial class WeightedAverageAggregation public Elastic.Clients.Elasticsearch.Serverless.Aggregations.ValueType? ValueType { get; set; } /// - /// Configuration for the field or script that provides the weights. + /// + /// Configuration for the field or script that provides the weights. + /// /// [JsonInclude, JsonPropertyName("weight")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.WeightedAverageValue? Weight { get; set; } @@ -70,7 +76,9 @@ public WeightedAverageAggregationDescriptor() : base() private Action> WeightDescriptorAction { get; set; } /// - /// A numeric response formatter. + /// + /// A numeric response formatter. + /// /// public WeightedAverageAggregationDescriptor Format(string? format) { @@ -79,7 +87,9 @@ public WeightedAverageAggregationDescriptor Format(string? format) } /// - /// Configuration for the field that provides the values. + /// + /// Configuration for the field that provides the values. + /// /// public WeightedAverageAggregationDescriptor Value(Elastic.Clients.Elasticsearch.Serverless.Aggregations.WeightedAverageValue? value) { @@ -112,7 +122,9 @@ public WeightedAverageAggregationDescriptor ValueType(Elastic.Clients } /// - /// Configuration for the field or script that provides the weights. + /// + /// Configuration for the field or script that provides the weights. + /// /// public WeightedAverageAggregationDescriptor Weight(Elastic.Clients.Elasticsearch.Serverless.Aggregations.WeightedAverageValue? weight) { @@ -207,7 +219,9 @@ public WeightedAverageAggregationDescriptor() : base() private Action WeightDescriptorAction { get; set; } /// - /// A numeric response formatter. + /// + /// A numeric response formatter. + /// /// public WeightedAverageAggregationDescriptor Format(string? format) { @@ -216,7 +230,9 @@ public WeightedAverageAggregationDescriptor Format(string? format) } /// - /// Configuration for the field that provides the values. + /// + /// Configuration for the field that provides the values. + /// /// public WeightedAverageAggregationDescriptor Value(Elastic.Clients.Elasticsearch.Serverless.Aggregations.WeightedAverageValue? value) { @@ -249,7 +265,9 @@ public WeightedAverageAggregationDescriptor ValueType(Elastic.Clients.Elasticsea } /// - /// Configuration for the field or script that provides the weights. + /// + /// Configuration for the field or script that provides the weights. + /// /// public WeightedAverageAggregationDescriptor Weight(Elastic.Clients.Elasticsearch.Serverless.Aggregations.WeightedAverageValue? weight) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/WeightedAverageValue.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/WeightedAverageValue.g.cs index 5ecd52ebd5b..8819c604890 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/WeightedAverageValue.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Aggregations/WeightedAverageValue.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Aggregations; public sealed partial class WeightedAverageValue { /// - /// The field from which to extract the values or weights. + /// + /// The field from which to extract the values or weights. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field? Field { get; set; } /// - /// A value or weight to use if the field is missing. + /// + /// A value or weight to use if the field is missing. + /// /// [JsonInclude, JsonPropertyName("missing")] public double? Missing { get; set; } @@ -59,7 +63,9 @@ public WeightedAverageValueDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field from which to extract the values or weights. + /// + /// The field from which to extract the values or weights. + /// /// public WeightedAverageValueDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -68,7 +74,9 @@ public WeightedAverageValueDescriptor Field(Elastic.Clients.Elasticse } /// - /// The field from which to extract the values or weights. + /// + /// The field from which to extract the values or weights. + /// /// public WeightedAverageValueDescriptor Field(Expression> field) { @@ -77,7 +85,9 @@ public WeightedAverageValueDescriptor Field(Expression - /// The field from which to extract the values or weights. + /// + /// The field from which to extract the values or weights. + /// /// public WeightedAverageValueDescriptor Field(Expression> field) { @@ -86,7 +96,9 @@ public WeightedAverageValueDescriptor Field(Expression - /// A value or weight to use if the field is missing. + /// + /// A value or weight to use if the field is missing. + /// /// public WeightedAverageValueDescriptor Missing(double? missing) { @@ -168,7 +180,9 @@ public WeightedAverageValueDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field from which to extract the values or weights. + /// + /// The field from which to extract the values or weights. + /// /// public WeightedAverageValueDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field? field) { @@ -177,7 +191,9 @@ public WeightedAverageValueDescriptor Field(Elastic.Clients.Elasticsearch.Server } /// - /// The field from which to extract the values or weights. + /// + /// The field from which to extract the values or weights. + /// /// public WeightedAverageValueDescriptor Field(Expression> field) { @@ -186,7 +202,9 @@ public WeightedAverageValueDescriptor Field(Expression - /// The field from which to extract the values or weights. + /// + /// The field from which to extract the values or weights. + /// /// public WeightedAverageValueDescriptor Field(Expression> field) { @@ -195,7 +213,9 @@ public WeightedAverageValueDescriptor Field(Expression - /// A value or weight to use if the field is missing. + /// + /// A value or weight to use if the field is missing. + /// /// public WeightedAverageValueDescriptor Missing(double? missing) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/AsyncSearch/AsyncSearch.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/AsyncSearch/AsyncSearch.g.cs index efb9407f9c6..f9bde910d58 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/AsyncSearch/AsyncSearch.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/AsyncSearch/AsyncSearch.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.AsyncSearch; public sealed partial class AsyncSearch { /// - /// Partial aggregations results, coming from the shards that have already completed the execution of the query. + /// + /// Partial aggregations results, coming from the shards that have already completed the execution of the query. + /// /// [JsonInclude, JsonPropertyName("aggregations")] public Elastic.Clients.Elasticsearch.Serverless.Aggregations.AggregateDictionary? Aggregations { get; init; } @@ -44,7 +46,10 @@ public sealed partial class AsyncSearch public double? MaxScore { get; init; } /// - /// Indicates how many reductions of the results have been performed.
If this number increases compared to the last retrieved results for a get asynch search request, you can expect additional results included in the search response. + /// + /// Indicates how many reductions of the results have been performed. + /// If this number increases compared to the last retrieved results for a get asynch search request, you can expect additional results included in the search response. + /// /// [JsonInclude, JsonPropertyName("num_reduce_phases")] public long? NumReducePhases { get; init; } @@ -56,7 +61,10 @@ public sealed partial class AsyncSearch public Elastic.Clients.Elasticsearch.Serverless.ScrollId? ScrollId { get; init; } /// - /// Indicates how many shards have run the query.
Note that in order for shard results to be included in the search response, they need to be reduced first. + /// + /// Indicates how many shards have run the query. + /// Note that in order for shard results to be included in the search response, they need to be reduced first. + /// /// [JsonInclude, JsonPropertyName("_shards")] public Elastic.Clients.Elasticsearch.Serverless.ShardStatistics Shards { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/CharFilterTypes.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/CharFilterTypes.g.cs index b7a21f5cd19..b7e4bc7978b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/CharFilterTypes.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/CharFilterTypes.g.cs @@ -30,49 +30,65 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class CharFilterTypes { /// - /// Contains statistics about analyzer types used in selected nodes. + /// + /// Contains statistics about analyzer types used in selected nodes. + /// /// [JsonInclude, JsonPropertyName("analyzer_types")] public IReadOnlyCollection AnalyzerTypes { get; init; } /// - /// Contains statistics about built-in analyzers used in selected nodes. + /// + /// Contains statistics about built-in analyzers used in selected nodes. + /// /// [JsonInclude, JsonPropertyName("built_in_analyzers")] public IReadOnlyCollection BuiltInAnalyzers { get; init; } /// - /// Contains statistics about built-in character filters used in selected nodes. + /// + /// Contains statistics about built-in character filters used in selected nodes. + /// /// [JsonInclude, JsonPropertyName("built_in_char_filters")] public IReadOnlyCollection BuiltInCharFilters { get; init; } /// - /// Contains statistics about built-in token filters used in selected nodes. + /// + /// Contains statistics about built-in token filters used in selected nodes. + /// /// [JsonInclude, JsonPropertyName("built_in_filters")] public IReadOnlyCollection BuiltInFilters { get; init; } /// - /// Contains statistics about built-in tokenizers used in selected nodes. + /// + /// Contains statistics about built-in tokenizers used in selected nodes. + /// /// [JsonInclude, JsonPropertyName("built_in_tokenizers")] public IReadOnlyCollection BuiltInTokenizers { get; init; } /// - /// Contains statistics about character filter types used in selected nodes. + /// + /// Contains statistics about character filter types used in selected nodes. + /// /// [JsonInclude, JsonPropertyName("char_filter_types")] public IReadOnlyCollection CharFilterTypes2 { get; init; } /// - /// Contains statistics about token filter types used in selected nodes. + /// + /// Contains statistics about token filter types used in selected nodes. + /// /// [JsonInclude, JsonPropertyName("filter_types")] public IReadOnlyCollection FilterTypes { get; init; } /// - /// Contains statistics about tokenizer types used in selected nodes. + /// + /// Contains statistics about tokenizer types used in selected nodes. + /// /// [JsonInclude, JsonPropertyName("tokenizer_types")] public IReadOnlyCollection TokenizerTypes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterFileSystem.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterFileSystem.g.cs index bef525f6364..d30cd548905 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterFileSystem.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterFileSystem.g.cs @@ -30,19 +30,27 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class ClusterFileSystem { /// - /// Total number of bytes available to JVM in file stores across all selected nodes.
Depending on operating system or process-level restrictions, this number may be less than `nodes.fs.free_in_byes`.
This is the actual amount of free disk space the selected Elasticsearch nodes can use. + /// + /// Total number of bytes available to JVM in file stores across all selected nodes. + /// Depending on operating system or process-level restrictions, this number may be less than nodes.fs.free_in_byes. + /// This is the actual amount of free disk space the selected Elasticsearch nodes can use. + /// /// [JsonInclude, JsonPropertyName("available_in_bytes")] public long AvailableInBytes { get; init; } /// - /// Total number of unallocated bytes in file stores across all selected nodes. + /// + /// Total number of unallocated bytes in file stores across all selected nodes. + /// /// [JsonInclude, JsonPropertyName("free_in_bytes")] public long FreeInBytes { get; init; } /// - /// Total size, in bytes, of all file stores across all selected nodes. + /// + /// Total size, in bytes, of all file stores across all selected nodes. + /// /// [JsonInclude, JsonPropertyName("total_in_bytes")] public long TotalInBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterIndices.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterIndices.g.cs index 464bca20c23..3cfe0fc1c4d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterIndices.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterIndices.g.cs @@ -30,67 +30,89 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class ClusterIndices { /// - /// Contains statistics about analyzers and analyzer components used in selected nodes. + /// + /// Contains statistics about analyzers and analyzer components used in selected nodes. + /// /// [JsonInclude, JsonPropertyName("analysis")] public Elastic.Clients.Elasticsearch.Serverless.Cluster.CharFilterTypes Analysis { get; init; } /// - /// Contains statistics about memory used for completion in selected nodes. + /// + /// Contains statistics about memory used for completion in selected nodes. + /// /// [JsonInclude, JsonPropertyName("completion")] public Elastic.Clients.Elasticsearch.Serverless.CompletionStats Completion { get; init; } /// - /// Total number of indices with shards assigned to selected nodes. + /// + /// Total number of indices with shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("count")] public long Count { get; init; } /// - /// Contains counts for documents in selected nodes. + /// + /// Contains counts for documents in selected nodes. + /// /// [JsonInclude, JsonPropertyName("docs")] public Elastic.Clients.Elasticsearch.Serverless.DocStats Docs { get; init; } /// - /// Contains statistics about the field data cache of selected nodes. + /// + /// Contains statistics about the field data cache of selected nodes. + /// /// [JsonInclude, JsonPropertyName("fielddata")] public Elastic.Clients.Elasticsearch.Serverless.FielddataStats Fielddata { get; init; } /// - /// Contains statistics about field mappings in selected nodes. + /// + /// Contains statistics about field mappings in selected nodes. + /// /// [JsonInclude, JsonPropertyName("mappings")] public Elastic.Clients.Elasticsearch.Serverless.Cluster.FieldTypesMappings Mappings { get; init; } /// - /// Contains statistics about the query cache of selected nodes. + /// + /// Contains statistics about the query cache of selected nodes. + /// /// [JsonInclude, JsonPropertyName("query_cache")] public Elastic.Clients.Elasticsearch.Serverless.QueryCacheStats QueryCache { get; init; } /// - /// Contains statistics about segments in selected nodes. + /// + /// Contains statistics about segments in selected nodes. + /// /// [JsonInclude, JsonPropertyName("segments")] public Elastic.Clients.Elasticsearch.Serverless.SegmentsStats Segments { get; init; } /// - /// Contains statistics about indices with shards assigned to selected nodes. + /// + /// Contains statistics about indices with shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("shards")] public Elastic.Clients.Elasticsearch.Serverless.Cluster.ClusterIndicesShards Shards { get; init; } /// - /// Contains statistics about the size of shards assigned to selected nodes. + /// + /// Contains statistics about the size of shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("store")] public Elastic.Clients.Elasticsearch.Serverless.StoreStats Store { get; init; } /// - /// Contains statistics about analyzers and analyzer components used in selected nodes. + /// + /// Contains statistics about analyzers and analyzer components used in selected nodes. + /// /// [JsonInclude, JsonPropertyName("versions")] public IReadOnlyCollection? Versions { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterIndicesShards.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterIndicesShards.g.cs index 0e475599360..fd41d982203 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterIndicesShards.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterIndicesShards.g.cs @@ -28,30 +28,40 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; /// -/// Contains statistics about shards assigned to selected nodes. +/// +/// Contains statistics about shards assigned to selected nodes. +/// /// public sealed partial class ClusterIndicesShards { /// - /// Contains statistics about shards assigned to selected nodes. + /// + /// Contains statistics about shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.Serverless.Cluster.ClusterIndicesShardsIndex? Index { get; init; } /// - /// Number of primary shards assigned to selected nodes. + /// + /// Number of primary shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("primaries")] public double? Primaries { get; init; } /// - /// Ratio of replica shards to primary shards across all selected nodes. + /// + /// Ratio of replica shards to primary shards across all selected nodes. + /// /// [JsonInclude, JsonPropertyName("replication")] public double? Replication { get; init; } /// - /// Total number of shards assigned to selected nodes. + /// + /// Total number of shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("total")] public double? Total { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterIndicesShardsIndex.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterIndicesShardsIndex.g.cs index 6c8acd5616f..1c84635282d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterIndicesShardsIndex.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterIndicesShardsIndex.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class ClusterIndicesShardsIndex { /// - /// Contains statistics about the number of primary shards assigned to selected nodes. + /// + /// Contains statistics about the number of primary shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("primaries")] public Elastic.Clients.Elasticsearch.Serverless.Cluster.ClusterShardMetrics Primaries { get; init; } /// - /// Contains statistics about the number of replication shards assigned to selected nodes. + /// + /// Contains statistics about the number of replication shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("replication")] public Elastic.Clients.Elasticsearch.Serverless.Cluster.ClusterShardMetrics Replication { get; init; } /// - /// Contains statistics about the number of shards assigned to selected nodes. + /// + /// Contains statistics about the number of shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("shards")] public Elastic.Clients.Elasticsearch.Serverless.Cluster.ClusterShardMetrics Shards { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterJvm.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterJvm.g.cs index 320145049d7..0bb8bdd2d38 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterJvm.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterJvm.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class ClusterJvm { /// - /// Uptime duration, in milliseconds, since JVM last started. + /// + /// Uptime duration, in milliseconds, since JVM last started. + /// /// [JsonInclude, JsonPropertyName("max_uptime_in_millis")] public long MaxUptimeInMillis { get; init; } /// - /// Contains statistics about memory used by selected nodes. + /// + /// Contains statistics about memory used by selected nodes. + /// /// [JsonInclude, JsonPropertyName("mem")] public Elastic.Clients.Elasticsearch.Serverless.Cluster.ClusterJvmMemory Mem { get; init; } /// - /// Number of active threads in use by JVM across all selected nodes. + /// + /// Number of active threads in use by JVM across all selected nodes. + /// /// [JsonInclude, JsonPropertyName("threads")] public long Threads { get; init; } /// - /// Contains statistics about the JVM versions used by selected nodes. + /// + /// Contains statistics about the JVM versions used by selected nodes. + /// /// [JsonInclude, JsonPropertyName("versions")] public IReadOnlyCollection Versions { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterJvmMemory.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterJvmMemory.g.cs index e76690e787b..4852724d45f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterJvmMemory.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterJvmMemory.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class ClusterJvmMemory { /// - /// Maximum amount of memory, in bytes, available for use by the heap across all selected nodes. + /// + /// Maximum amount of memory, in bytes, available for use by the heap across all selected nodes. + /// /// [JsonInclude, JsonPropertyName("heap_max_in_bytes")] public long HeapMaxInBytes { get; init; } /// - /// Memory, in bytes, currently in use by the heap across all selected nodes. + /// + /// Memory, in bytes, currently in use by the heap across all selected nodes. + /// /// [JsonInclude, JsonPropertyName("heap_used_in_bytes")] public long HeapUsedInBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterJvmVersion.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterJvmVersion.g.cs index d8a39fe1f22..cec8a46d2a5 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterJvmVersion.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterJvmVersion.g.cs @@ -30,43 +30,58 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class ClusterJvmVersion { /// - /// Always `true`. All distributions come with a bundled Java Development Kit (JDK). + /// + /// Always true. All distributions come with a bundled Java Development Kit (JDK). + /// /// [JsonInclude, JsonPropertyName("bundled_jdk")] public bool BundledJdk { get; init; } /// - /// Total number of selected nodes using JVM. + /// + /// Total number of selected nodes using JVM. + /// /// [JsonInclude, JsonPropertyName("count")] public int Count { get; init; } /// - /// If `true`, a bundled JDK is in use by JVM. + /// + /// If true, a bundled JDK is in use by JVM. + /// /// [JsonInclude, JsonPropertyName("using_bundled_jdk")] public bool UsingBundledJdk { get; init; } /// - /// Version of JVM used by one or more selected nodes. + /// + /// Version of JVM used by one or more selected nodes. + /// /// [JsonInclude, JsonPropertyName("version")] public string Version { get; init; } /// - /// Name of the JVM. + /// + /// Name of the JVM. + /// /// [JsonInclude, JsonPropertyName("vm_name")] public string VmName { get; init; } /// - /// Vendor of the JVM. + /// + /// Vendor of the JVM. + /// /// [JsonInclude, JsonPropertyName("vm_vendor")] public string VmVendor { get; init; } /// - /// Full version number of JVM.
The full version number includes a plus sign (+) followed by the build number. + /// + /// Full version number of JVM. + /// The full version number includes a plus sign (+) followed by the build number. + /// /// [JsonInclude, JsonPropertyName("vm_version")] public string VmVersion { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterNetworkTypes.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterNetworkTypes.g.cs index 17f5e823d4c..42726c2770f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterNetworkTypes.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterNetworkTypes.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class ClusterNetworkTypes { /// - /// Contains statistics about the HTTP network types used by selected nodes. + /// + /// Contains statistics about the HTTP network types used by selected nodes. + /// /// [JsonInclude, JsonPropertyName("http_types")] public IReadOnlyDictionary HttpTypes { get; init; } /// - /// Contains statistics about the transport network types used by selected nodes. + /// + /// Contains statistics about the transport network types used by selected nodes. + /// /// [JsonInclude, JsonPropertyName("transport_types")] public IReadOnlyDictionary TransportTypes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterNodes.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterNodes.g.cs index 3f193c15b82..729a29ce92c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterNodes.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterNodes.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class ClusterNodes { /// - /// Contains counts for nodes selected by the request’s node filters. + /// + /// Contains counts for nodes selected by the request’s node filters. + /// /// [JsonInclude, JsonPropertyName("count")] public Elastic.Clients.Elasticsearch.Serverless.Cluster.ClusterNodeCount Count { get; init; } /// - /// Contains statistics about the discovery types used by selected nodes. + /// + /// Contains statistics about the discovery types used by selected nodes. + /// /// [JsonInclude, JsonPropertyName("discovery_types")] public IReadOnlyDictionary DiscoveryTypes { get; init; } /// - /// Contains statistics about file stores by selected nodes. + /// + /// Contains statistics about file stores by selected nodes. + /// /// [JsonInclude, JsonPropertyName("fs")] public Elastic.Clients.Elasticsearch.Serverless.Cluster.ClusterFileSystem Fs { get; init; } @@ -52,43 +58,58 @@ public sealed partial class ClusterNodes public Elastic.Clients.Elasticsearch.Serverless.Cluster.ClusterIngest Ingest { get; init; } /// - /// Contains statistics about the Java Virtual Machines (JVMs) used by selected nodes. + /// + /// Contains statistics about the Java Virtual Machines (JVMs) used by selected nodes. + /// /// [JsonInclude, JsonPropertyName("jvm")] public Elastic.Clients.Elasticsearch.Serverless.Cluster.ClusterJvm Jvm { get; init; } /// - /// Contains statistics about the transport and HTTP networks used by selected nodes. + /// + /// Contains statistics about the transport and HTTP networks used by selected nodes. + /// /// [JsonInclude, JsonPropertyName("network_types")] public Elastic.Clients.Elasticsearch.Serverless.Cluster.ClusterNetworkTypes NetworkTypes { get; init; } /// - /// Contains statistics about the operating systems used by selected nodes. + /// + /// Contains statistics about the operating systems used by selected nodes. + /// /// [JsonInclude, JsonPropertyName("os")] public Elastic.Clients.Elasticsearch.Serverless.Cluster.ClusterOperatingSystem Os { get; init; } /// - /// Contains statistics about Elasticsearch distributions installed on selected nodes. + /// + /// Contains statistics about Elasticsearch distributions installed on selected nodes. + /// /// [JsonInclude, JsonPropertyName("packaging_types")] public IReadOnlyCollection PackagingTypes { get; init; } /// - /// Contains statistics about installed plugins and modules by selected nodes.
If no plugins or modules are installed, this array is empty. + /// + /// Contains statistics about installed plugins and modules by selected nodes. + /// If no plugins or modules are installed, this array is empty. + /// /// [JsonInclude, JsonPropertyName("plugins")] public IReadOnlyCollection Plugins { get; init; } /// - /// Contains statistics about processes used by selected nodes. + /// + /// Contains statistics about processes used by selected nodes. + /// /// [JsonInclude, JsonPropertyName("process")] public Elastic.Clients.Elasticsearch.Serverless.Cluster.ClusterProcess Process { get; init; } /// - /// Array of Elasticsearch versions used on selected nodes. + /// + /// Array of Elasticsearch versions used on selected nodes. + /// /// [JsonInclude, JsonPropertyName("versions")] public IReadOnlyCollection Versions { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterOperatingSystem.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterOperatingSystem.g.cs index c610b1055a4..d222650835a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterOperatingSystem.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterOperatingSystem.g.cs @@ -30,37 +30,51 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class ClusterOperatingSystem { /// - /// Number of processors used to calculate thread pool size across all selected nodes.
This number can be set with the processors setting of a node and defaults to the number of processors reported by the operating system.
In both cases, this number will never be larger than 32. + /// + /// Number of processors used to calculate thread pool size across all selected nodes. + /// This number can be set with the processors setting of a node and defaults to the number of processors reported by the operating system. + /// In both cases, this number will never be larger than 32. + /// /// [JsonInclude, JsonPropertyName("allocated_processors")] public int AllocatedProcessors { get; init; } /// - /// Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes. + /// + /// Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes. + /// /// [JsonInclude, JsonPropertyName("architectures")] public IReadOnlyCollection? Architectures { get; init; } /// - /// Number of processors available to JVM across all selected nodes. + /// + /// Number of processors available to JVM across all selected nodes. + /// /// [JsonInclude, JsonPropertyName("available_processors")] public int AvailableProcessors { get; init; } /// - /// Contains statistics about memory used by selected nodes. + /// + /// Contains statistics about memory used by selected nodes. + /// /// [JsonInclude, JsonPropertyName("mem")] public Elastic.Clients.Elasticsearch.Serverless.Cluster.OperatingSystemMemoryInfo Mem { get; init; } /// - /// Contains statistics about operating systems used by selected nodes. + /// + /// Contains statistics about operating systems used by selected nodes. + /// /// [JsonInclude, JsonPropertyName("names")] public IReadOnlyCollection Names { get; init; } /// - /// Contains statistics about operating systems used by selected nodes. + /// + /// Contains statistics about operating systems used by selected nodes. + /// /// [JsonInclude, JsonPropertyName("pretty_names")] public IReadOnlyCollection PrettyNames { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterOperatingSystemArchitecture.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterOperatingSystemArchitecture.g.cs index d7d3d6ccf0d..61bdabcb62c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterOperatingSystemArchitecture.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterOperatingSystemArchitecture.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class ClusterOperatingSystemArchitecture { /// - /// Name of an architecture used by one or more selected nodes. + /// + /// Name of an architecture used by one or more selected nodes. + /// /// [JsonInclude, JsonPropertyName("arch")] public string Arch { get; init; } /// - /// Number of selected nodes using the architecture. + /// + /// Number of selected nodes using the architecture. + /// /// [JsonInclude, JsonPropertyName("count")] public int Count { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterOperatingSystemName.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterOperatingSystemName.g.cs index f75d4e2505d..80c7fe442a1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterOperatingSystemName.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterOperatingSystemName.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class ClusterOperatingSystemName { /// - /// Number of selected nodes using the operating system. + /// + /// Number of selected nodes using the operating system. + /// /// [JsonInclude, JsonPropertyName("count")] public int Count { get; init; } /// - /// Name of an operating system used by one or more selected nodes. + /// + /// Name of an operating system used by one or more selected nodes. + /// /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterOperatingSystemPrettyName.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterOperatingSystemPrettyName.g.cs index b86279d176c..d01cda664a6 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterOperatingSystemPrettyName.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterOperatingSystemPrettyName.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class ClusterOperatingSystemPrettyName { /// - /// Number of selected nodes using the operating system. + /// + /// Number of selected nodes using the operating system. + /// /// [JsonInclude, JsonPropertyName("count")] public int Count { get; init; } /// - /// Human-readable name of an operating system used by one or more selected nodes. + /// + /// Human-readable name of an operating system used by one or more selected nodes. + /// /// [JsonInclude, JsonPropertyName("pretty_name")] public string PrettyName { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterProcess.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterProcess.g.cs index bef11994b67..bb1f40f8d6a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterProcess.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterProcess.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class ClusterProcess { /// - /// Contains statistics about CPU used by selected nodes. + /// + /// Contains statistics about CPU used by selected nodes. + /// /// [JsonInclude, JsonPropertyName("cpu")] public Elastic.Clients.Elasticsearch.Serverless.Cluster.ClusterProcessCpu Cpu { get; init; } /// - /// Contains statistics about open file descriptors in selected nodes. + /// + /// Contains statistics about open file descriptors in selected nodes. + /// /// [JsonInclude, JsonPropertyName("open_file_descriptors")] public Elastic.Clients.Elasticsearch.Serverless.Cluster.ClusterProcessOpenFileDescriptors OpenFileDescriptors { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterProcessCpu.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterProcessCpu.g.cs index 0ecd38a47ce..628af314ee5 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterProcessCpu.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterProcessCpu.g.cs @@ -30,7 +30,10 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class ClusterProcessCpu { /// - /// Percentage of CPU used across all selected nodes.
Returns `-1` if not supported. + /// + /// Percentage of CPU used across all selected nodes. + /// Returns -1 if not supported. + /// /// [JsonInclude, JsonPropertyName("percent")] public int Percent { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterProcessOpenFileDescriptors.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterProcessOpenFileDescriptors.g.cs index 2c4cc40ccff..d83dbda5e67 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterProcessOpenFileDescriptors.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterProcessOpenFileDescriptors.g.cs @@ -30,19 +30,28 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class ClusterProcessOpenFileDescriptors { /// - /// Average number of concurrently open file descriptors.
Returns `-1` if not supported. + /// + /// Average number of concurrently open file descriptors. + /// Returns -1 if not supported. + /// /// [JsonInclude, JsonPropertyName("avg")] public long Avg { get; init; } /// - /// Maximum number of concurrently open file descriptors allowed across all selected nodes.
Returns `-1` if not supported. + /// + /// Maximum number of concurrently open file descriptors allowed across all selected nodes. + /// Returns -1 if not supported. + /// /// [JsonInclude, JsonPropertyName("max")] public long Max { get; init; } /// - /// Minimum number of concurrently open file descriptors across all selected nodes.
Returns -1 if not supported. + /// + /// Minimum number of concurrently open file descriptors across all selected nodes. + /// Returns -1 if not supported. + /// /// [JsonInclude, JsonPropertyName("min")] public long Min { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterShardMetrics.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterShardMetrics.g.cs index 6b3c9b26533..1c37490ab83 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterShardMetrics.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/ClusterShardMetrics.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class ClusterShardMetrics { /// - /// Mean number of shards in an index, counting only shards assigned to selected nodes. + /// + /// Mean number of shards in an index, counting only shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("avg")] public double Avg { get; init; } /// - /// Maximum number of shards in an index, counting only shards assigned to selected nodes. + /// + /// Maximum number of shards in an index, counting only shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("max")] public double Max { get; init; } /// - /// Minimum number of shards in an index, counting only shards assigned to selected nodes. + /// + /// Minimum number of shards in an index, counting only shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("min")] public double Min { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/FieldTypes.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/FieldTypes.g.cs index b2f48f7fd75..b0cec494d36 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/FieldTypes.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/FieldTypes.g.cs @@ -30,43 +30,57 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class FieldTypes { /// - /// The number of occurrences of the field type in selected nodes. + /// + /// The number of occurrences of the field type in selected nodes. + /// /// [JsonInclude, JsonPropertyName("count")] public int Count { get; init; } /// - /// The number of indices containing the field type in selected nodes. + /// + /// The number of indices containing the field type in selected nodes. + /// /// [JsonInclude, JsonPropertyName("index_count")] public int IndexCount { get; init; } /// - /// For dense_vector field types, number of indexed vector types in selected nodes. + /// + /// For dense_vector field types, number of indexed vector types in selected nodes. + /// /// [JsonInclude, JsonPropertyName("indexed_vector_count")] public long? IndexedVectorCount { get; init; } /// - /// For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes. + /// + /// For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes. + /// /// [JsonInclude, JsonPropertyName("indexed_vector_dim_max")] public long? IndexedVectorDimMax { get; init; } /// - /// For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes. + /// + /// For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes. + /// /// [JsonInclude, JsonPropertyName("indexed_vector_dim_min")] public long? IndexedVectorDimMin { get; init; } /// - /// The name for the field type in selected nodes. + /// + /// The name for the field type in selected nodes. + /// /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } /// - /// The number of fields that declare a script. + /// + /// The number of fields that declare a script. + /// /// [JsonInclude, JsonPropertyName("script_count")] public int? ScriptCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/FieldTypesMappings.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/FieldTypesMappings.g.cs index 4782bb02b8e..a557cde8bbb 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/FieldTypesMappings.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/FieldTypesMappings.g.cs @@ -30,37 +30,49 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class FieldTypesMappings { /// - /// Contains statistics about field data types used in selected nodes. + /// + /// Contains statistics about field data types used in selected nodes. + /// /// [JsonInclude, JsonPropertyName("field_types")] public IReadOnlyCollection FieldTypes { get; init; } /// - /// Contains statistics about runtime field data types used in selected nodes. + /// + /// Contains statistics about runtime field data types used in selected nodes. + /// /// [JsonInclude, JsonPropertyName("runtime_field_types")] public IReadOnlyCollection? RuntimeFieldTypes { get; init; } /// - /// Total number of fields in all non-system indices, accounting for mapping deduplication. + /// + /// Total number of fields in all non-system indices, accounting for mapping deduplication. + /// /// [JsonInclude, JsonPropertyName("total_deduplicated_field_count")] public int? TotalDeduplicatedFieldCount { get; init; } /// - /// Total size of all mappings after deduplication and compression. + /// + /// Total size of all mappings after deduplication and compression. + /// /// [JsonInclude, JsonPropertyName("total_deduplicated_mapping_size")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? TotalDeduplicatedMappingSize { get; init; } /// - /// Total size of all mappings, in bytes, after deduplication and compression. + /// + /// Total size of all mappings, in bytes, after deduplication and compression. + /// /// [JsonInclude, JsonPropertyName("total_deduplicated_mapping_size_in_bytes")] public long? TotalDeduplicatedMappingSizeInBytes { get; init; } /// - /// Total number of fields in all non-system indices. + /// + /// Total number of fields in all non-system indices. + /// /// [JsonInclude, JsonPropertyName("total_field_count")] public int? TotalFieldCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/NodePackagingType.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/NodePackagingType.g.cs index 5ea45302090..acc6b91750e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/NodePackagingType.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/NodePackagingType.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class NodePackagingType { /// - /// Number of selected nodes using the distribution flavor and file type. + /// + /// Number of selected nodes using the distribution flavor and file type. + /// /// [JsonInclude, JsonPropertyName("count")] public int Count { get; init; } /// - /// Type of Elasticsearch distribution. This is always `default`. + /// + /// Type of Elasticsearch distribution. This is always default. + /// /// [JsonInclude, JsonPropertyName("flavor")] public string Flavor { get; init; } /// - /// File type (such as `tar` or `zip`) used for the distribution package. + /// + /// File type (such as tar or zip) used for the distribution package. + /// /// [JsonInclude, JsonPropertyName("type")] public string Type { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/OperatingSystemMemoryInfo.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/OperatingSystemMemoryInfo.g.cs index bf9be164a4d..bdde2e74f12 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/OperatingSystemMemoryInfo.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/OperatingSystemMemoryInfo.g.cs @@ -30,37 +30,49 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class OperatingSystemMemoryInfo { /// - /// Total amount, in bytes, of memory across all selected nodes, but using the value specified using the `es.total_memory_bytes` system property instead of measured total memory for those nodes where that system property was set. + /// + /// Total amount, in bytes, of memory across all selected nodes, but using the value specified using the es.total_memory_bytes system property instead of measured total memory for those nodes where that system property was set. + /// /// [JsonInclude, JsonPropertyName("adjusted_total_in_bytes")] public long? AdjustedTotalInBytes { get; init; } /// - /// Amount, in bytes, of free physical memory across all selected nodes. + /// + /// Amount, in bytes, of free physical memory across all selected nodes. + /// /// [JsonInclude, JsonPropertyName("free_in_bytes")] public long FreeInBytes { get; init; } /// - /// Percentage of free physical memory across all selected nodes. + /// + /// Percentage of free physical memory across all selected nodes. + /// /// [JsonInclude, JsonPropertyName("free_percent")] public int FreePercent { get; init; } /// - /// Total amount, in bytes, of physical memory across all selected nodes. + /// + /// Total amount, in bytes, of physical memory across all selected nodes. + /// /// [JsonInclude, JsonPropertyName("total_in_bytes")] public long TotalInBytes { get; init; } /// - /// Amount, in bytes, of physical memory in use across all selected nodes. + /// + /// Amount, in bytes, of physical memory in use across all selected nodes. + /// /// [JsonInclude, JsonPropertyName("used_in_bytes")] public long UsedInBytes { get; init; } /// - /// Percentage of physical memory in use across all selected nodes. + /// + /// Percentage of physical memory in use across all selected nodes. + /// /// [JsonInclude, JsonPropertyName("used_percent")] public int UsedPercent { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/PendingTask.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/PendingTask.g.cs index 7730460d81b..0d08dd1d7f8 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/PendingTask.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/PendingTask.g.cs @@ -30,37 +30,50 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class PendingTask { /// - /// Indicates whether the pending tasks are currently executing or not. + /// + /// Indicates whether the pending tasks are currently executing or not. + /// /// [JsonInclude, JsonPropertyName("executing")] public bool Executing { get; init; } /// - /// The number that represents when the task has been inserted into the task queue. + /// + /// The number that represents when the task has been inserted into the task queue. + /// /// [JsonInclude, JsonPropertyName("insert_order")] public int InsertOrder { get; init; } /// - /// The priority of the pending task.
The valid priorities in descending priority order are: `IMMEDIATE` > `URGENT` > `HIGH` > `NORMAL` > `LOW` > `LANGUID`. + /// + /// The priority of the pending task. + /// The valid priorities in descending priority order are: IMMEDIATE > URGENT > HIGH > NORMAL > LOW > LANGUID. + /// /// [JsonInclude, JsonPropertyName("priority")] public string Priority { get; init; } /// - /// A general description of the cluster task that may include a reason and origin. + /// + /// A general description of the cluster task that may include a reason and origin. + /// /// [JsonInclude, JsonPropertyName("source")] public string Source { get; init; } /// - /// The time since the task is waiting for being performed. + /// + /// The time since the task is waiting for being performed. + /// /// [JsonInclude, JsonPropertyName("time_in_queue")] public Elastic.Clients.Elasticsearch.Serverless.Duration? TimeInQueue { get; init; } /// - /// The time expressed in milliseconds since the task is waiting for being performed. + /// + /// The time expressed in milliseconds since the task is waiting for being performed. + /// /// [JsonInclude, JsonPropertyName("time_in_queue_millis")] public long TimeInQueueMillis { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/RuntimeFieldTypes.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/RuntimeFieldTypes.g.cs index 24dd42aeae5..4f65523719a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/RuntimeFieldTypes.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Cluster/RuntimeFieldTypes.g.cs @@ -30,85 +30,113 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Cluster; public sealed partial class RuntimeFieldTypes { /// - /// Maximum number of characters for a single runtime field script. + /// + /// Maximum number of characters for a single runtime field script. + /// /// [JsonInclude, JsonPropertyName("chars_max")] public int CharsMax { get; init; } /// - /// Total number of characters for the scripts that define the current runtime field data type. + /// + /// Total number of characters for the scripts that define the current runtime field data type. + /// /// [JsonInclude, JsonPropertyName("chars_total")] public int CharsTotal { get; init; } /// - /// Number of runtime fields mapped to the field data type in selected nodes. + /// + /// Number of runtime fields mapped to the field data type in selected nodes. + /// /// [JsonInclude, JsonPropertyName("count")] public int Count { get; init; } /// - /// Maximum number of accesses to doc_values for a single runtime field script + /// + /// Maximum number of accesses to doc_values for a single runtime field script + /// /// [JsonInclude, JsonPropertyName("doc_max")] public int DocMax { get; init; } /// - /// Total number of accesses to doc_values for the scripts that define the current runtime field data type. + /// + /// Total number of accesses to doc_values for the scripts that define the current runtime field data type. + /// /// [JsonInclude, JsonPropertyName("doc_total")] public int DocTotal { get; init; } /// - /// Number of indices containing a mapping of the runtime field data type in selected nodes. + /// + /// Number of indices containing a mapping of the runtime field data type in selected nodes. + /// /// [JsonInclude, JsonPropertyName("index_count")] public int IndexCount { get; init; } /// - /// Script languages used for the runtime fields scripts. + /// + /// Script languages used for the runtime fields scripts. + /// /// [JsonInclude, JsonPropertyName("lang")] public IReadOnlyCollection Lang { get; init; } /// - /// Maximum number of lines for a single runtime field script. + /// + /// Maximum number of lines for a single runtime field script. + /// /// [JsonInclude, JsonPropertyName("lines_max")] public int LinesMax { get; init; } /// - /// Total number of lines for the scripts that define the current runtime field data type. + /// + /// Total number of lines for the scripts that define the current runtime field data type. + /// /// [JsonInclude, JsonPropertyName("lines_total")] public int LinesTotal { get; init; } /// - /// Field data type used in selected nodes. + /// + /// Field data type used in selected nodes. + /// /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } /// - /// Number of runtime fields that don’t declare a script. + /// + /// Number of runtime fields that don’t declare a script. + /// /// [JsonInclude, JsonPropertyName("scriptless_count")] public int ScriptlessCount { get; init; } /// - /// Number of runtime fields that shadow an indexed field. + /// + /// Number of runtime fields that shadow an indexed field. + /// /// [JsonInclude, JsonPropertyName("shadowed_count")] public int ShadowedCount { get; init; } /// - /// Maximum number of accesses to _source for a single runtime field script. + /// + /// Maximum number of accesses to _source for a single runtime field script. + /// /// [JsonInclude, JsonPropertyName("source_max")] public int SourceMax { get; init; } /// - /// Total number of accesses to _source for the scripts that define the current runtime field data type. + /// + /// Total number of accesses to _source for the scripts that define the current runtime field data type. + /// /// [JsonInclude, JsonPropertyName("source_total")] public int SourceTotal { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/CompletionStats.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/CompletionStats.g.cs index 07f10390f6d..98ef24f22fe 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/CompletionStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/CompletionStats.g.cs @@ -34,13 +34,17 @@ public sealed partial class CompletionStats public IReadOnlyDictionary? Fields { get; init; } /// - /// Total amount of memory used for completion across all shards assigned to selected nodes. + /// + /// Total amount of memory used for completion across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("size")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? Size { get; init; } /// - /// Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes. + /// + /// Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("size_in_bytes")] public long SizeInBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Bulk/ResponseItem.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Bulk/ResponseItem.g.cs index 8b35513e825..86ed9308f54 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Bulk/ResponseItem.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Bulk/ResponseItem.g.cs @@ -30,7 +30,10 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.Bulk; public partial class ResponseItem { /// - /// Contains additional information about the failed operation.
The parameter is only returned for failed operations. + /// + /// Contains additional information about the failed operation. + /// The parameter is only returned for failed operations. + /// /// [JsonInclude, JsonPropertyName("error")] public Elastic.Clients.Elasticsearch.Serverless.ErrorCause? Error { get; init; } @@ -40,49 +43,69 @@ public partial class ResponseItem public Elastic.Clients.Elasticsearch.Serverless.InlineGet>? Get { get; init; } /// - /// The document ID associated with the operation. + /// + /// The document ID associated with the operation. + /// /// [JsonInclude, JsonPropertyName("_id")] public string? Id { get; init; } /// - /// Name of the index associated with the operation.
If the operation targeted a data stream, this is the backing index into which the document was written. + /// + /// Name of the index associated with the operation. + /// If the operation targeted a data stream, this is the backing index into which the document was written. + /// /// [JsonInclude, JsonPropertyName("_index")] public string Index { get; init; } /// - /// The primary term assigned to the document for the operation. + /// + /// The primary term assigned to the document for the operation. + /// /// [JsonInclude, JsonPropertyName("_primary_term")] public long? PrimaryTerm { get; init; } /// - /// Result of the operation.
Successful values are `created`, `deleted`, and `updated`. + /// + /// Result of the operation. + /// Successful values are created, deleted, and updated. + /// /// [JsonInclude, JsonPropertyName("result")] public string? Result { get; init; } /// - /// The sequence number assigned to the document for the operation.
Sequence numbers are used to ensure an older version of a document doesn’t overwrite a newer version. + /// + /// The sequence number assigned to the document for the operation. + /// Sequence numbers are used to ensure an older version of a document doesn’t overwrite a newer version. + /// /// [JsonInclude, JsonPropertyName("_seq_no")] public long? SeqNo { get; init; } /// - /// Contains shard information for the operation. + /// + /// Contains shard information for the operation. + /// /// [JsonInclude, JsonPropertyName("_shards")] public Elastic.Clients.Elasticsearch.Serverless.ShardStatistics? Shards { get; init; } /// - /// HTTP status code returned for the operation. + /// + /// HTTP status code returned for the operation. + /// /// [JsonInclude, JsonPropertyName("status")] public int Status { get; init; } /// - /// The document version associated with the operation.
The document version is incremented each time the document is updated. + /// + /// The document version associated with the operation. + /// The document version is incremented each time the document is updated. + /// /// [JsonInclude, JsonPropertyName("_version")] public long? Version { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Context.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Context.g.cs index fe2ce09dc18..8fdad13fb9d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Context.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Context.g.cs @@ -31,7 +31,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.Search; /// -/// Text or location that we want similar documents for or a lookup to a document's field for the text. +/// +/// Text or location that we want similar documents for or a lookup to a document's field for the text. +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class Context : Union diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/FieldCaps/FieldCapability.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/FieldCaps/FieldCapability.g.cs index 5dcf33e96b3..fb55120aeb0 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/FieldCaps/FieldCapability.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/FieldCaps/FieldCapability.g.cs @@ -30,46 +30,60 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.FieldCaps; public sealed partial class FieldCapability { /// - /// Whether this field can be aggregated on all indices. + /// + /// Whether this field can be aggregated on all indices. + /// /// [JsonInclude, JsonPropertyName("aggregatable")] public bool Aggregatable { get; init; } /// - /// The list of indices where this field has the same type family, or null if all indices have the same type family for the field. + /// + /// The list of indices where this field has the same type family, or null if all indices have the same type family for the field. + /// /// [JsonInclude, JsonPropertyName("indices")] [SingleOrManyCollectionConverter(typeof(string))] public IReadOnlyCollection? Indices { get; init; } /// - /// Merged metadata across all indices as a map of string keys to arrays of values. A value length of 1 indicates that all indices had the same value for this key, while a length of 2 or more indicates that not all indices had the same value for this key. + /// + /// Merged metadata across all indices as a map of string keys to arrays of values. A value length of 1 indicates that all indices had the same value for this key, while a length of 2 or more indicates that not all indices had the same value for this key. + /// /// [JsonInclude, JsonPropertyName("meta")] public IReadOnlyDictionary? Meta { get; init; } /// - /// Whether this field is registered as a metadata field. + /// + /// Whether this field is registered as a metadata field. + /// /// [JsonInclude, JsonPropertyName("metadata_field")] public bool? MetadataField { get; init; } /// - /// The list of indices where this field is not aggregatable, or null if all indices have the same definition for the field. + /// + /// The list of indices where this field is not aggregatable, or null if all indices have the same definition for the field. + /// /// [JsonInclude, JsonPropertyName("non_aggregatable_indices")] [SingleOrManyCollectionConverter(typeof(string))] public IReadOnlyCollection? NonAggregatableIndices { get; init; } /// - /// The list of indices where this field is not searchable, or null if all indices have the same definition for the field. + /// + /// The list of indices where this field is not searchable, or null if all indices have the same definition for the field. + /// /// [JsonInclude, JsonPropertyName("non_searchable_indices")] [SingleOrManyCollectionConverter(typeof(string))] public IReadOnlyCollection? NonSearchableIndices { get; init; } /// - /// Whether this field is indexed for search on all indices. + /// + /// Whether this field is indexed for search on all indices. + /// /// [JsonInclude, JsonPropertyName("searchable")] public bool Searchable { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/DiskIndicator.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/DiskIndicator.g.cs index 0520c573f94..93fc7429d59 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/DiskIndicator.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/DiskIndicator.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.HealthReport; /// -/// DISK +/// +/// DISK +/// /// public sealed partial class DiskIndicator { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/IlmIndicator.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/IlmIndicator.g.cs index 1466907fb7b..28272157f9a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/IlmIndicator.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/IlmIndicator.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.HealthReport; /// -/// ILM +/// +/// ILM +/// /// public sealed partial class IlmIndicator { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/MasterIsStableIndicator.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/MasterIsStableIndicator.g.cs index 9303ebe980d..cfc3254debb 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/MasterIsStableIndicator.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/MasterIsStableIndicator.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.HealthReport; /// -/// MASTER_IS_STABLE +/// +/// MASTER_IS_STABLE +/// /// public sealed partial class MasterIsStableIndicator { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/RepositoryIntegrityIndicator.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/RepositoryIntegrityIndicator.g.cs index 9bbd5dbad20..338974b61d8 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/RepositoryIntegrityIndicator.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/RepositoryIntegrityIndicator.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.HealthReport; /// -/// REPOSITORY_INTEGRITY +/// +/// REPOSITORY_INTEGRITY +/// /// public sealed partial class RepositoryIntegrityIndicator { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/ShardsAvailabilityIndicator.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/ShardsAvailabilityIndicator.g.cs index 0140d11d29d..b6f74ef1f63 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/ShardsAvailabilityIndicator.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/ShardsAvailabilityIndicator.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.HealthReport; /// -/// SHARDS_AVAILABILITY +/// +/// SHARDS_AVAILABILITY +/// /// public sealed partial class ShardsAvailabilityIndicator { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/ShardsCapacityIndicator.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/ShardsCapacityIndicator.g.cs index 0a79ce68d8a..acfe6ed691a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/ShardsCapacityIndicator.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/ShardsCapacityIndicator.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.HealthReport; /// -/// SHARDS_CAPACITY +/// +/// SHARDS_CAPACITY +/// /// public sealed partial class ShardsCapacityIndicator { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/SlmIndicator.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/SlmIndicator.g.cs index 9f389c5423c..7583430b1dc 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/SlmIndicator.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/SlmIndicator.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.HealthReport; /// -/// SLM +/// +/// SLM +/// /// public sealed partial class SlmIndicator { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/MGet/MultiGetOperation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/MGet/MultiGetOperation.g.cs index 4ce180b8146..6621f1f9ef0 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/MGet/MultiGetOperation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/MGet/MultiGetOperation.g.cs @@ -30,31 +30,41 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.MGet; public sealed partial class MultiGetOperation { /// - /// The unique document ID. + /// + /// The unique document ID. + /// /// [JsonInclude, JsonPropertyName("_id")] public Elastic.Clients.Elasticsearch.Serverless.Id Id { get; set; } /// - /// The index that contains the document. + /// + /// The index that contains the document. + /// /// [JsonInclude, JsonPropertyName("_index")] public Elastic.Clients.Elasticsearch.Serverless.IndexName? Index { get; set; } /// - /// The key for the primary shard the document resides on. Required if routing is used during indexing. + /// + /// The key for the primary shard the document resides on. Required if routing is used during indexing. + /// /// [JsonInclude, JsonPropertyName("routing")] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get; set; } /// - /// If `false`, excludes all _source fields. + /// + /// If false, excludes all _source fields. + /// /// [JsonInclude, JsonPropertyName("_source")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfig? Source { get; set; } /// - /// The stored fields you want to retrieve. + /// + /// The stored fields you want to retrieve. + /// /// [JsonInclude, JsonPropertyName("stored_fields")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] @@ -82,7 +92,9 @@ public MultiGetOperationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.VersionType? VersionTypeValue { get; set; } /// - /// The unique document ID. + /// + /// The unique document ID. + /// /// public MultiGetOperationDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id id) { @@ -91,7 +103,9 @@ public MultiGetOperationDescriptor Id(Elastic.Clients.Elasticsearch.S } /// - /// The index that contains the document. + /// + /// The index that contains the document. + /// /// public MultiGetOperationDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.IndexName? index) { @@ -100,7 +114,9 @@ public MultiGetOperationDescriptor Index(Elastic.Clients.Elasticsearc } /// - /// The key for the primary shard the document resides on. Required if routing is used during indexing. + /// + /// The key for the primary shard the document resides on. Required if routing is used during indexing. + /// /// public MultiGetOperationDescriptor Routing(Elastic.Clients.Elasticsearch.Serverless.Routing? routing) { @@ -109,7 +125,9 @@ public MultiGetOperationDescriptor Routing(Elastic.Clients.Elasticsea } /// - /// If `false`, excludes all _source fields. + /// + /// If false, excludes all _source fields. + /// /// public MultiGetOperationDescriptor Source(Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfig? source) { @@ -118,7 +136,9 @@ public MultiGetOperationDescriptor Source(Elastic.Clients.Elasticsear } /// - /// The stored fields you want to retrieve. + /// + /// The stored fields you want to retrieve. + /// /// public MultiGetOperationDescriptor StoredFields(Elastic.Clients.Elasticsearch.Serverless.Fields? storedFields) { @@ -200,7 +220,9 @@ public MultiGetOperationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.VersionType? VersionTypeValue { get; set; } /// - /// The unique document ID. + /// + /// The unique document ID. + /// /// public MultiGetOperationDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id id) { @@ -209,7 +231,9 @@ public MultiGetOperationDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.I } /// - /// The index that contains the document. + /// + /// The index that contains the document. + /// /// public MultiGetOperationDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.IndexName? index) { @@ -218,7 +242,9 @@ public MultiGetOperationDescriptor Index(Elastic.Clients.Elasticsearch.Serverles } /// - /// The key for the primary shard the document resides on. Required if routing is used during indexing. + /// + /// The key for the primary shard the document resides on. Required if routing is used during indexing. + /// /// public MultiGetOperationDescriptor Routing(Elastic.Clients.Elasticsearch.Serverless.Routing? routing) { @@ -227,7 +253,9 @@ public MultiGetOperationDescriptor Routing(Elastic.Clients.Elasticsearch.Serverl } /// - /// If `false`, excludes all _source fields. + /// + /// If false, excludes all _source fields. + /// /// public MultiGetOperationDescriptor Source(Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfig? source) { @@ -236,7 +264,9 @@ public MultiGetOperationDescriptor Source(Elastic.Clients.Elasticsearch.Serverle } /// - /// The stored fields you want to retrieve. + /// + /// The stored fields you want to retrieve. + /// /// public MultiGetOperationDescriptor StoredFields(Elastic.Clients.Elasticsearch.Serverless.Fields? storedFields) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/MSearch/MultisearchBody.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/MSearch/MultisearchBody.g.cs index 2d5869dba4e..7d80571faa9 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/MSearch/MultisearchBody.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/MSearch/MultisearchBody.g.cs @@ -430,119 +430,186 @@ public sealed partial class MultisearchBody public Elastic.Clients.Elasticsearch.Serverless.Core.Search.FieldCollapse? Collapse { get; set; } /// - /// Array of wildcard (*) patterns. The request returns doc values for field
names matching these patterns in the hits.fields property of the response. + /// + /// Array of wildcard (*) patterns. The request returns doc values for field + /// names matching these patterns in the hits.fields property of the response. + /// /// public ICollection? DocvalueFields { get; set; } /// - /// If true, returns detailed information about score computation as part of a hit. + /// + /// If true, returns detailed information about score computation as part of a hit. + /// /// public bool? Explain { get; set; } /// - /// Configuration of search extensions defined by Elasticsearch plugins. + /// + /// Configuration of search extensions defined by Elasticsearch plugins. + /// /// public IDictionary? Ext { get; set; } /// - /// Array of wildcard (*) patterns. The request returns values for field names
matching these patterns in the hits.fields property of the response. + /// + /// Array of wildcard (*) patterns. The request returns values for field names + /// matching these patterns in the hits.fields property of the response. + /// /// public ICollection? Fields { get; set; } /// - /// Starting document offset. By default, you cannot page through more than 10,000
hits using the from and size parameters. To page through more hits, use the
search_after parameter. + /// + /// Starting document offset. By default, you cannot page through more than 10,000 + /// hits using the from and size parameters. To page through more hits, use the + /// search_after parameter. + /// /// public int? From { get; set; } public Elastic.Clients.Elasticsearch.Serverless.Core.Search.Highlight? Highlight { get; set; } /// - /// Boosts the _score of documents from specified indices. + /// + /// Boosts the _score of documents from specified indices. + /// /// public ICollection>? IndicesBoost { get; set; } /// - /// Defines the approximate kNN search to run. + /// + /// Defines the approximate kNN search to run. + /// /// public ICollection? Knn { get; set; } /// - /// Minimum _score for matching documents. Documents with a lower _score are
not included in the search results. + /// + /// Minimum _score for matching documents. Documents with a lower _score are + /// not included in the search results. + /// /// public double? MinScore { get; set; } /// - /// Limits the search to a point in time (PIT). If you provide a PIT, you
cannot specify an in the request path. + /// + /// Limits the search to a point in time (PIT). If you provide a PIT, you + /// cannot specify an <index> in the request path. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Core.Search.PointInTimeReference? Pit { get; set; } public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? PostFilter { get; set; } public bool? Profile { get; set; } /// - /// Defines the search definition using the Query DSL. + /// + /// Defines the search definition using the Query DSL. + /// /// public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? Query { get; set; } public ICollection? Rescore { get; set; } /// - /// Defines one or more runtime fields in the search request. These fields take
precedence over mapped fields with the same name. + /// + /// Defines one or more runtime fields in the search request. These fields take + /// precedence over mapped fields with the same name. + /// /// public IDictionary? RuntimeMappings { get; set; } /// - /// Retrieve a script evaluation (based on different fields) for each hit. + /// + /// Retrieve a script evaluation (based on different fields) for each hit. + /// /// public IDictionary? ScriptFields { get; set; } public ICollection? SearchAfter { get; set; } /// - /// If true, returns sequence number and primary term of the last modification
of each hit. See Optimistic concurrency control. + /// + /// If true, returns sequence number and primary term of the last modification + /// of each hit. See Optimistic concurrency control. + /// /// public bool? SeqNoPrimaryTerm { get; set; } /// - /// The number of hits to return. By default, you cannot page through more
than 10,000 hits using the from and size parameters. To page through more
hits, use the search_after parameter. + /// + /// The number of hits to return. By default, you cannot page through more + /// than 10,000 hits using the from and size parameters. To page through more + /// hits, use the search_after parameter. + /// /// public int? Size { get; set; } public ICollection? Sort { get; set; } /// - /// Indicates which source fields are returned for matching documents. These
fields are returned in the hits._source property of the search response. + /// + /// Indicates which source fields are returned for matching documents. These + /// fields are returned in the hits._source property of the search response. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfig? Source { get; set; } /// - /// Stats groups to associate with the search. Each group maintains a statistics
aggregation for its associated searches. You can retrieve these stats using
the indices stats API. + /// + /// Stats groups to associate with the search. Each group maintains a statistics + /// aggregation for its associated searches. You can retrieve these stats using + /// the indices stats API. + /// /// public ICollection? Stats { get; set; } /// - /// List of stored fields to return as part of a hit. If no fields are specified,
no stored fields are included in the response. If this field is specified, the _source
parameter defaults to false. You can pass _source: true to return both source fields
and stored fields in the search response. + /// + /// List of stored fields to return as part of a hit. If no fields are specified, + /// no stored fields are included in the response. If this field is specified, the _source + /// parameter defaults to false. You can pass _source: true to return both source fields + /// and stored fields in the search response. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fields? StoredFields { get; set; } public Elastic.Clients.Elasticsearch.Serverless.Core.Search.Suggester? Suggest { get; set; } /// - /// Maximum number of documents to collect for each shard. If a query reaches this
limit, Elasticsearch terminates the query early. Elasticsearch collects documents
before sorting. Defaults to 0, which does not terminate query execution early. + /// + /// Maximum number of documents to collect for each shard. If a query reaches this + /// limit, Elasticsearch terminates the query early. Elasticsearch collects documents + /// before sorting. Defaults to 0, which does not terminate query execution early. + /// /// public long? TerminateAfter { get; set; } /// - /// Specifies the period of time to wait for a response from each shard. If no response
is received before the timeout expires, the request fails and returns an error.
Defaults to no timeout. + /// + /// Specifies the period of time to wait for a response from each shard. If no response + /// is received before the timeout expires, the request fails and returns an error. + /// Defaults to no timeout. + /// /// public string? Timeout { get; set; } /// - /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// + /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// /// public bool? TrackScores { get; set; } /// - /// Number of hits matching the query to count accurately. If true, the exact
number of hits is returned at the cost of some performance. If false, the
response does not include the total number of hits matching the query.
Defaults to 10,000 hits. + /// + /// Number of hits matching the query to count accurately. If true, the exact + /// number of hits is returned at the cost of some performance. If false, the + /// response does not include the total number of hits matching the query. + /// Defaults to 10,000 hits. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Core.Search.TrackHits? TrackTotalHits { get; set; } /// - /// If true, returns document version as part of a hit. + /// + /// If true, returns document version as part of a hit. + /// /// public bool? Version { get; set; } } @@ -645,7 +712,10 @@ public MultisearchBodyDescriptor Collapse(Action - /// Array of wildcard (*) patterns. The request returns doc values for field
names matching these patterns in the hits.fields property of the response. + /// + /// Array of wildcard (*) patterns. The request returns doc values for field + /// names matching these patterns in the hits.fields property of the response. + /// /// public MultisearchBodyDescriptor DocvalueFields(ICollection? docvalueFields) { @@ -684,7 +754,9 @@ public MultisearchBodyDescriptor DocvalueFields(params Action - /// If true, returns detailed information about score computation as part of a hit. + /// + /// If true, returns detailed information about score computation as part of a hit. + /// /// public MultisearchBodyDescriptor Explain(bool? explain = true) { @@ -693,7 +765,9 @@ public MultisearchBodyDescriptor Explain(bool? explain = true) } /// - /// Configuration of search extensions defined by Elasticsearch plugins. + /// + /// Configuration of search extensions defined by Elasticsearch plugins. + /// /// public MultisearchBodyDescriptor Ext(Func, FluentDictionary> selector) { @@ -702,7 +776,10 @@ public MultisearchBodyDescriptor Ext(Func - /// Array of wildcard (*) patterns. The request returns values for field names
matching these patterns in the hits.fields property of the response. + /// + /// Array of wildcard (*) patterns. The request returns values for field names + /// matching these patterns in the hits.fields property of the response. + /// /// public MultisearchBodyDescriptor Fields(ICollection? fields) { @@ -741,7 +818,11 @@ public MultisearchBodyDescriptor Fields(params Action - /// Starting document offset. By default, you cannot page through more than 10,000
hits using the from and size parameters. To page through more hits, use the
search_after parameter. + /// + /// Starting document offset. By default, you cannot page through more than 10,000 + /// hits using the from and size parameters. To page through more hits, use the + /// search_after parameter. + /// /// public MultisearchBodyDescriptor From(int? from) { @@ -774,7 +855,9 @@ public MultisearchBodyDescriptor Highlight(Action - /// Boosts the _score of documents from specified indices. + /// + /// Boosts the _score of documents from specified indices. + /// /// public MultisearchBodyDescriptor IndicesBoost(ICollection>? indicesBoost) { @@ -783,7 +866,9 @@ public MultisearchBodyDescriptor IndicesBoost(ICollection - /// Defines the approximate kNN search to run. + /// + /// Defines the approximate kNN search to run. + /// /// public MultisearchBodyDescriptor Knn(ICollection? knn) { @@ -822,7 +907,10 @@ public MultisearchBodyDescriptor Knn(params Action - /// Minimum _score for matching documents. Documents with a lower _score are
not included in the search results. + /// + /// Minimum _score for matching documents. Documents with a lower _score are + /// not included in the search results. + /// /// public MultisearchBodyDescriptor MinScore(double? minScore) { @@ -831,7 +919,10 @@ public MultisearchBodyDescriptor MinScore(double? minScore) } /// - /// Limits the search to a point in time (PIT). If you provide a PIT, you
cannot specify an in the request path. + /// + /// Limits the search to a point in time (PIT). If you provide a PIT, you + /// cannot specify an <index> in the request path. + /// /// public MultisearchBodyDescriptor Pit(Elastic.Clients.Elasticsearch.Serverless.Core.Search.PointInTimeReference? pit) { @@ -888,7 +979,9 @@ public MultisearchBodyDescriptor Profile(bool? profile = true) } /// - /// Defines the search definition using the Query DSL. + /// + /// Defines the search definition using the Query DSL. + /// /// public MultisearchBodyDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -951,7 +1044,10 @@ public MultisearchBodyDescriptor Rescore(params Action - /// Defines one or more runtime fields in the search request. These fields take
precedence over mapped fields with the same name. + /// + /// Defines one or more runtime fields in the search request. These fields take + /// precedence over mapped fields with the same name. + /// /// public MultisearchBodyDescriptor RuntimeMappings(Func>, FluentDescriptorDictionary>> selector) { @@ -960,7 +1056,9 @@ public MultisearchBodyDescriptor RuntimeMappings(Func - /// Retrieve a script evaluation (based on different fields) for each hit. + /// + /// Retrieve a script evaluation (based on different fields) for each hit. + /// /// public MultisearchBodyDescriptor ScriptFields(Func, FluentDescriptorDictionary> selector) { @@ -975,7 +1073,10 @@ public MultisearchBodyDescriptor SearchAfter(ICollection - /// If true, returns sequence number and primary term of the last modification
of each hit. See Optimistic concurrency control. + /// + /// If true, returns sequence number and primary term of the last modification + /// of each hit. See Optimistic concurrency control. + /// /// public MultisearchBodyDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = true) { @@ -984,7 +1085,11 @@ public MultisearchBodyDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryT } /// - /// The number of hits to return. By default, you cannot page through more
than 10,000 hits using the from and size parameters. To page through more
hits, use the search_after parameter. + /// + /// The number of hits to return. By default, you cannot page through more + /// than 10,000 hits using the from and size parameters. To page through more + /// hits, use the search_after parameter. + /// /// public MultisearchBodyDescriptor Size(int? size) { @@ -1029,7 +1134,10 @@ public MultisearchBodyDescriptor Sort(params Action - /// Indicates which source fields are returned for matching documents. These
fields are returned in the hits._source property of the search response. + /// + /// Indicates which source fields are returned for matching documents. These + /// fields are returned in the hits._source property of the search response. + /// /// public MultisearchBodyDescriptor Source(Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfig? source) { @@ -1038,7 +1146,11 @@ public MultisearchBodyDescriptor Source(Elastic.Clients.Elasticsearch } /// - /// Stats groups to associate with the search. Each group maintains a statistics
aggregation for its associated searches. You can retrieve these stats using
the indices stats API. + /// + /// Stats groups to associate with the search. Each group maintains a statistics + /// aggregation for its associated searches. You can retrieve these stats using + /// the indices stats API. + /// /// public MultisearchBodyDescriptor Stats(ICollection? stats) { @@ -1047,7 +1159,12 @@ public MultisearchBodyDescriptor Stats(ICollection? stats) } /// - /// List of stored fields to return as part of a hit. If no fields are specified,
no stored fields are included in the response. If this field is specified, the _source
parameter defaults to false. You can pass _source: true to return both source fields
and stored fields in the search response. + /// + /// List of stored fields to return as part of a hit. If no fields are specified, + /// no stored fields are included in the response. If this field is specified, the _source + /// parameter defaults to false. You can pass _source: true to return both source fields + /// and stored fields in the search response. + /// /// public MultisearchBodyDescriptor StoredFields(Elastic.Clients.Elasticsearch.Serverless.Fields? storedFields) { @@ -1080,7 +1197,11 @@ public MultisearchBodyDescriptor Suggest(Action - /// Maximum number of documents to collect for each shard. If a query reaches this
limit, Elasticsearch terminates the query early. Elasticsearch collects documents
before sorting. Defaults to 0, which does not terminate query execution early. + /// + /// Maximum number of documents to collect for each shard. If a query reaches this + /// limit, Elasticsearch terminates the query early. Elasticsearch collects documents + /// before sorting. Defaults to 0, which does not terminate query execution early. + /// /// public MultisearchBodyDescriptor TerminateAfter(long? terminateAfter) { @@ -1089,7 +1210,11 @@ public MultisearchBodyDescriptor TerminateAfter(long? terminateAfter) } /// - /// Specifies the period of time to wait for a response from each shard. If no response
is received before the timeout expires, the request fails and returns an error.
Defaults to no timeout. + /// + /// Specifies the period of time to wait for a response from each shard. If no response + /// is received before the timeout expires, the request fails and returns an error. + /// Defaults to no timeout. + /// /// public MultisearchBodyDescriptor Timeout(string? timeout) { @@ -1098,7 +1223,9 @@ public MultisearchBodyDescriptor Timeout(string? timeout) } /// - /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// + /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// /// public MultisearchBodyDescriptor TrackScores(bool? trackScores = true) { @@ -1107,7 +1234,12 @@ public MultisearchBodyDescriptor TrackScores(bool? trackScores = true } /// - /// Number of hits matching the query to count accurately. If true, the exact
number of hits is returned at the cost of some performance. If false, the
response does not include the total number of hits matching the query.
Defaults to 10,000 hits. + /// + /// Number of hits matching the query to count accurately. If true, the exact + /// number of hits is returned at the cost of some performance. If false, the + /// response does not include the total number of hits matching the query. + /// Defaults to 10,000 hits. + /// /// public MultisearchBodyDescriptor TrackTotalHits(Elastic.Clients.Elasticsearch.Serverless.Core.Search.TrackHits? trackTotalHits) { @@ -1116,7 +1248,9 @@ public MultisearchBodyDescriptor TrackTotalHits(Elastic.Clients.Elast } /// - /// If true, returns document version as part of a hit. + /// + /// If true, returns document version as part of a hit. + /// /// public MultisearchBodyDescriptor Version(bool? version = true) { @@ -1594,7 +1728,10 @@ public MultisearchBodyDescriptor Collapse(Action - /// Array of wildcard (*) patterns. The request returns doc values for field
names matching these patterns in the hits.fields property of the response. + /// + /// Array of wildcard (*) patterns. The request returns doc values for field + /// names matching these patterns in the hits.fields property of the response. + /// /// public MultisearchBodyDescriptor DocvalueFields(ICollection? docvalueFields) { @@ -1633,7 +1770,9 @@ public MultisearchBodyDescriptor DocvalueFields(params Action - /// If true, returns detailed information about score computation as part of a hit. + /// + /// If true, returns detailed information about score computation as part of a hit. + /// /// public MultisearchBodyDescriptor Explain(bool? explain = true) { @@ -1642,7 +1781,9 @@ public MultisearchBodyDescriptor Explain(bool? explain = true) } /// - /// Configuration of search extensions defined by Elasticsearch plugins. + /// + /// Configuration of search extensions defined by Elasticsearch plugins. + /// /// public MultisearchBodyDescriptor Ext(Func, FluentDictionary> selector) { @@ -1651,7 +1792,10 @@ public MultisearchBodyDescriptor Ext(Func, Flue } /// - /// Array of wildcard (*) patterns. The request returns values for field names
matching these patterns in the hits.fields property of the response. + /// + /// Array of wildcard (*) patterns. The request returns values for field names + /// matching these patterns in the hits.fields property of the response. + /// /// public MultisearchBodyDescriptor Fields(ICollection? fields) { @@ -1690,7 +1834,11 @@ public MultisearchBodyDescriptor Fields(params Action - /// Starting document offset. By default, you cannot page through more than 10,000
hits using the from and size parameters. To page through more hits, use the
search_after parameter. + /// + /// Starting document offset. By default, you cannot page through more than 10,000 + /// hits using the from and size parameters. To page through more hits, use the + /// search_after parameter. + /// /// public MultisearchBodyDescriptor From(int? from) { @@ -1723,7 +1871,9 @@ public MultisearchBodyDescriptor Highlight(Action - /// Boosts the _score of documents from specified indices. + /// + /// Boosts the _score of documents from specified indices. + /// /// public MultisearchBodyDescriptor IndicesBoost(ICollection>? indicesBoost) { @@ -1732,7 +1882,9 @@ public MultisearchBodyDescriptor IndicesBoost(ICollection - /// Defines the approximate kNN search to run. + /// + /// Defines the approximate kNN search to run. + /// /// public MultisearchBodyDescriptor Knn(ICollection? knn) { @@ -1771,7 +1923,10 @@ public MultisearchBodyDescriptor Knn(params Action - /// Minimum _score for matching documents. Documents with a lower _score are
not included in the search results. + /// + /// Minimum _score for matching documents. Documents with a lower _score are + /// not included in the search results. + /// /// public MultisearchBodyDescriptor MinScore(double? minScore) { @@ -1780,7 +1935,10 @@ public MultisearchBodyDescriptor MinScore(double? minScore) } /// - /// Limits the search to a point in time (PIT). If you provide a PIT, you
cannot specify an in the request path. + /// + /// Limits the search to a point in time (PIT). If you provide a PIT, you + /// cannot specify an <index> in the request path. + /// /// public MultisearchBodyDescriptor Pit(Elastic.Clients.Elasticsearch.Serverless.Core.Search.PointInTimeReference? pit) { @@ -1837,7 +1995,9 @@ public MultisearchBodyDescriptor Profile(bool? profile = true) } /// - /// Defines the search definition using the Query DSL. + /// + /// Defines the search definition using the Query DSL. + /// /// public MultisearchBodyDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -1900,7 +2060,10 @@ public MultisearchBodyDescriptor Rescore(params Action - /// Defines one or more runtime fields in the search request. These fields take
precedence over mapped fields with the same name. + /// + /// Defines one or more runtime fields in the search request. These fields take + /// precedence over mapped fields with the same name. + /// /// public MultisearchBodyDescriptor RuntimeMappings(Func, FluentDescriptorDictionary> selector) { @@ -1909,7 +2072,9 @@ public MultisearchBodyDescriptor RuntimeMappings(Func - /// Retrieve a script evaluation (based on different fields) for each hit. + /// + /// Retrieve a script evaluation (based on different fields) for each hit. + /// /// public MultisearchBodyDescriptor ScriptFields(Func, FluentDescriptorDictionary> selector) { @@ -1924,7 +2089,10 @@ public MultisearchBodyDescriptor SearchAfter(ICollection - /// If true, returns sequence number and primary term of the last modification
of each hit. See Optimistic concurrency control. + /// + /// If true, returns sequence number and primary term of the last modification + /// of each hit. See Optimistic concurrency control. + /// /// public MultisearchBodyDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = true) { @@ -1933,7 +2101,11 @@ public MultisearchBodyDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = true) } /// - /// The number of hits to return. By default, you cannot page through more
than 10,000 hits using the from and size parameters. To page through more
hits, use the search_after parameter. + /// + /// The number of hits to return. By default, you cannot page through more + /// than 10,000 hits using the from and size parameters. To page through more + /// hits, use the search_after parameter. + /// /// public MultisearchBodyDescriptor Size(int? size) { @@ -1978,7 +2150,10 @@ public MultisearchBodyDescriptor Sort(params Action - /// Indicates which source fields are returned for matching documents. These
fields are returned in the hits._source property of the search response. + /// + /// Indicates which source fields are returned for matching documents. These + /// fields are returned in the hits._source property of the search response. + /// /// public MultisearchBodyDescriptor Source(Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfig? source) { @@ -1987,7 +2162,11 @@ public MultisearchBodyDescriptor Source(Elastic.Clients.Elasticsearch.Serverless } /// - /// Stats groups to associate with the search. Each group maintains a statistics
aggregation for its associated searches. You can retrieve these stats using
the indices stats API. + /// + /// Stats groups to associate with the search. Each group maintains a statistics + /// aggregation for its associated searches. You can retrieve these stats using + /// the indices stats API. + /// /// public MultisearchBodyDescriptor Stats(ICollection? stats) { @@ -1996,7 +2175,12 @@ public MultisearchBodyDescriptor Stats(ICollection? stats) } /// - /// List of stored fields to return as part of a hit. If no fields are specified,
no stored fields are included in the response. If this field is specified, the _source
parameter defaults to false. You can pass _source: true to return both source fields
and stored fields in the search response. + /// + /// List of stored fields to return as part of a hit. If no fields are specified, + /// no stored fields are included in the response. If this field is specified, the _source + /// parameter defaults to false. You can pass _source: true to return both source fields + /// and stored fields in the search response. + /// /// public MultisearchBodyDescriptor StoredFields(Elastic.Clients.Elasticsearch.Serverless.Fields? storedFields) { @@ -2029,7 +2213,11 @@ public MultisearchBodyDescriptor Suggest(Action - /// Maximum number of documents to collect for each shard. If a query reaches this
limit, Elasticsearch terminates the query early. Elasticsearch collects documents
before sorting. Defaults to 0, which does not terminate query execution early. + /// + /// Maximum number of documents to collect for each shard. If a query reaches this + /// limit, Elasticsearch terminates the query early. Elasticsearch collects documents + /// before sorting. Defaults to 0, which does not terminate query execution early. + /// /// public MultisearchBodyDescriptor TerminateAfter(long? terminateAfter) { @@ -2038,7 +2226,11 @@ public MultisearchBodyDescriptor TerminateAfter(long? terminateAfter) } /// - /// Specifies the period of time to wait for a response from each shard. If no response
is received before the timeout expires, the request fails and returns an error.
Defaults to no timeout. + /// + /// Specifies the period of time to wait for a response from each shard. If no response + /// is received before the timeout expires, the request fails and returns an error. + /// Defaults to no timeout. + /// /// public MultisearchBodyDescriptor Timeout(string? timeout) { @@ -2047,7 +2239,9 @@ public MultisearchBodyDescriptor Timeout(string? timeout) } /// - /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// + /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// /// public MultisearchBodyDescriptor TrackScores(bool? trackScores = true) { @@ -2056,7 +2250,12 @@ public MultisearchBodyDescriptor TrackScores(bool? trackScores = true) } /// - /// Number of hits matching the query to count accurately. If true, the exact
number of hits is returned at the cost of some performance. If false, the
response does not include the total number of hits matching the query.
Defaults to 10,000 hits. + /// + /// Number of hits matching the query to count accurately. If true, the exact + /// number of hits is returned at the cost of some performance. If false, the + /// response does not include the total number of hits matching the query. + /// Defaults to 10,000 hits. + /// /// public MultisearchBodyDescriptor TrackTotalHits(Elastic.Clients.Elasticsearch.Serverless.Core.Search.TrackHits? trackTotalHits) { @@ -2065,7 +2264,9 @@ public MultisearchBodyDescriptor TrackTotalHits(Elastic.Clients.Elasticsearch.Se } /// - /// If true, returns document version as part of a hit. + /// + /// If true, returns document version as part of a hit. + /// /// public MultisearchBodyDescriptor Version(bool? version = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/MSearch/MultisearchHeader.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/MSearch/MultisearchHeader.g.cs index e681824741f..dbff568ba1b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/MSearch/MultisearchHeader.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/MSearch/MultisearchHeader.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.MSearch; /// -/// Contains parameters used to limit or change the subsequent search body request. +/// +/// Contains parameters used to limit or change the subsequent search body request. +/// /// public sealed partial class MultisearchHeader { @@ -58,7 +60,9 @@ public sealed partial class MultisearchHeader } /// -/// Contains parameters used to limit or change the subsequent search body request. +/// +/// Contains parameters used to limit or change the subsequent search body request. +/// /// public sealed partial class MultisearchHeaderDescriptor : SerializableDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/MSearchTemplate/TemplateConfig.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/MSearchTemplate/TemplateConfig.g.cs index 6e2201615a8..cec2496d68a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/MSearchTemplate/TemplateConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/MSearchTemplate/TemplateConfig.g.cs @@ -30,31 +30,46 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.MSearchTemplate; public sealed partial class TemplateConfig { /// - /// If `true`, returns detailed information about score calculation as part of each hit. + /// + /// If true, returns detailed information about score calculation as part of each hit. + /// /// [JsonInclude, JsonPropertyName("explain")] public bool? Explain { get; init; } /// - /// ID of the search template to use. If no source is specified,
this parameter is required. + /// + /// ID of the search template to use. If no source is specified, + /// this parameter is required. + /// /// [JsonInclude, JsonPropertyName("id")] public Elastic.Clients.Elasticsearch.Serverless.Id? Id { get; init; } /// - /// Key-value pairs used to replace Mustache variables in the template.
The key is the variable name.
The value is the variable value. + /// + /// Key-value pairs used to replace Mustache variables in the template. + /// The key is the variable name. + /// The value is the variable value. + /// /// [JsonInclude, JsonPropertyName("params")] public IReadOnlyDictionary? Params { get; init; } /// - /// If `true`, the query execution is profiled. + /// + /// If true, the query execution is profiled. + /// /// [JsonInclude, JsonPropertyName("profile")] public bool? Profile { get; init; } /// - /// An inline search template. Supports the same parameters as the search API's
request body. Also supports Mustache variables. If no id is specified, this
parameter is required. + /// + /// An inline search template. Supports the same parameters as the search API's + /// request body. Also supports Mustache variables. If no id is specified, this + /// parameter is required. + /// /// [JsonInclude, JsonPropertyName("source")] public string? Source { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Mtermvectors/MultiTermVectorsOperation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Mtermvectors/MultiTermVectorsOperation.g.cs index 88256e2b8c0..1a3667265ba 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Mtermvectors/MultiTermVectorsOperation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Mtermvectors/MultiTermVectorsOperation.g.cs @@ -30,80 +30,107 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.Mtermvectors; public sealed partial class MultiTermVectorsOperation { /// - /// An artificial document (a document not present in the index) for which you want to retrieve term vectors. + /// + /// An artificial document (a document not present in the index) for which you want to retrieve term vectors. + /// /// [JsonInclude, JsonPropertyName("doc")] public object? Doc { get; set; } /// - /// Comma-separated list or wildcard expressions of fields to include in the statistics.
Used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. + /// + /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// Used as the default list unless a specific field list is provided in the completion_fields or fielddata_fields parameters. + /// /// [JsonInclude, JsonPropertyName("fields")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] public Elastic.Clients.Elasticsearch.Serverless.Fields? Fields { get; set; } /// - /// If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + /// + /// If true, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + /// /// [JsonInclude, JsonPropertyName("field_statistics")] public bool? FieldStatistics { get; set; } /// - /// Filter terms based on their tf-idf scores. + /// + /// Filter terms based on their tf-idf scores. + /// /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.Serverless.Core.TermVectors.Filter? Filter { get; set; } /// - /// The ID of the document. + /// + /// The ID of the document. + /// /// [JsonInclude, JsonPropertyName("_id")] public Elastic.Clients.Elasticsearch.Serverless.Id? Id { get; set; } /// - /// The index of the document. + /// + /// The index of the document. + /// /// [JsonInclude, JsonPropertyName("_index")] public Elastic.Clients.Elasticsearch.Serverless.IndexName? Index { get; set; } /// - /// If `true`, the response includes term offsets. + /// + /// If true, the response includes term offsets. + /// /// [JsonInclude, JsonPropertyName("offsets")] public bool? Offsets { get; set; } /// - /// If `true`, the response includes term payloads. + /// + /// If true, the response includes term payloads. + /// /// [JsonInclude, JsonPropertyName("payloads")] public bool? Payloads { get; set; } /// - /// If `true`, the response includes term positions. + /// + /// If true, the response includes term positions. + /// /// [JsonInclude, JsonPropertyName("positions")] public bool? Positions { get; set; } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonInclude, JsonPropertyName("routing")] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get; set; } /// - /// If true, the response includes term frequency and document frequency. + /// + /// If true, the response includes term frequency and document frequency. + /// /// [JsonInclude, JsonPropertyName("term_statistics")] public bool? TermStatistics { get; set; } /// - /// If `true`, returns the document version as part of a hit. + /// + /// If true, returns the document version as part of a hit. + /// /// [JsonInclude, JsonPropertyName("version")] public long? Version { get; set; } /// - /// Specific version type. + /// + /// Specific version type. + /// /// [JsonInclude, JsonPropertyName("version_type")] public Elastic.Clients.Elasticsearch.Serverless.VersionType? VersionType { get; set; } @@ -134,7 +161,9 @@ public MultiTermVectorsOperationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.VersionType? VersionTypeValue { get; set; } /// - /// An artificial document (a document not present in the index) for which you want to retrieve term vectors. + /// + /// An artificial document (a document not present in the index) for which you want to retrieve term vectors. + /// /// public MultiTermVectorsOperationDescriptor Doc(object? doc) { @@ -143,7 +172,10 @@ public MultiTermVectorsOperationDescriptor Doc(object? doc) } /// - /// Comma-separated list or wildcard expressions of fields to include in the statistics.
Used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. + /// + /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// Used as the default list unless a specific field list is provided in the completion_fields or fielddata_fields parameters. + /// /// public MultiTermVectorsOperationDescriptor Fields(Elastic.Clients.Elasticsearch.Serverless.Fields? fields) { @@ -152,7 +184,9 @@ public MultiTermVectorsOperationDescriptor Fields(Elastic.Clients.Ela } /// - /// If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + /// + /// If true, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + /// /// public MultiTermVectorsOperationDescriptor FieldStatistics(bool? fieldStatistics = true) { @@ -161,7 +195,9 @@ public MultiTermVectorsOperationDescriptor FieldStatistics(bool? fiel } /// - /// Filter terms based on their tf-idf scores. + /// + /// Filter terms based on their tf-idf scores. + /// /// public MultiTermVectorsOperationDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.Core.TermVectors.Filter? filter) { @@ -188,7 +224,9 @@ public MultiTermVectorsOperationDescriptor Filter(Action - /// The ID of the document. + /// + /// The ID of the document. + /// /// public MultiTermVectorsOperationDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id? id) { @@ -197,7 +235,9 @@ public MultiTermVectorsOperationDescriptor Id(Elastic.Clients.Elastic } /// - /// The index of the document. + /// + /// The index of the document. + /// /// public MultiTermVectorsOperationDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.IndexName? index) { @@ -206,7 +246,9 @@ public MultiTermVectorsOperationDescriptor Index(Elastic.Clients.Elas } /// - /// If `true`, the response includes term offsets. + /// + /// If true, the response includes term offsets. + /// /// public MultiTermVectorsOperationDescriptor Offsets(bool? offsets = true) { @@ -215,7 +257,9 @@ public MultiTermVectorsOperationDescriptor Offsets(bool? offsets = tr } /// - /// If `true`, the response includes term payloads. + /// + /// If true, the response includes term payloads. + /// /// public MultiTermVectorsOperationDescriptor Payloads(bool? payloads = true) { @@ -224,7 +268,9 @@ public MultiTermVectorsOperationDescriptor Payloads(bool? payloads = } /// - /// If `true`, the response includes term positions. + /// + /// If true, the response includes term positions. + /// /// public MultiTermVectorsOperationDescriptor Positions(bool? positions = true) { @@ -233,7 +279,9 @@ public MultiTermVectorsOperationDescriptor Positions(bool? positions } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public MultiTermVectorsOperationDescriptor Routing(Elastic.Clients.Elasticsearch.Serverless.Routing? routing) { @@ -242,7 +290,9 @@ public MultiTermVectorsOperationDescriptor Routing(Elastic.Clients.El } /// - /// If true, the response includes term frequency and document frequency. + /// + /// If true, the response includes term frequency and document frequency. + /// /// public MultiTermVectorsOperationDescriptor TermStatistics(bool? termStatistics = true) { @@ -251,7 +301,9 @@ public MultiTermVectorsOperationDescriptor TermStatistics(bool? termS } /// - /// If `true`, returns the document version as part of a hit. + /// + /// If true, returns the document version as part of a hit. + /// /// public MultiTermVectorsOperationDescriptor Version(long? version) { @@ -260,7 +312,9 @@ public MultiTermVectorsOperationDescriptor Version(long? version) } /// - /// Specific version type. + /// + /// Specific version type. + /// /// public MultiTermVectorsOperationDescriptor VersionType(Elastic.Clients.Elasticsearch.Serverless.VersionType? versionType) { @@ -388,7 +442,9 @@ public MultiTermVectorsOperationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.VersionType? VersionTypeValue { get; set; } /// - /// An artificial document (a document not present in the index) for which you want to retrieve term vectors. + /// + /// An artificial document (a document not present in the index) for which you want to retrieve term vectors. + /// /// public MultiTermVectorsOperationDescriptor Doc(object? doc) { @@ -397,7 +453,10 @@ public MultiTermVectorsOperationDescriptor Doc(object? doc) } /// - /// Comma-separated list or wildcard expressions of fields to include in the statistics.
Used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. + /// + /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// Used as the default list unless a specific field list is provided in the completion_fields or fielddata_fields parameters. + /// /// public MultiTermVectorsOperationDescriptor Fields(Elastic.Clients.Elasticsearch.Serverless.Fields? fields) { @@ -406,7 +465,9 @@ public MultiTermVectorsOperationDescriptor Fields(Elastic.Clients.Elasticsearch. } /// - /// If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + /// + /// If true, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + /// /// public MultiTermVectorsOperationDescriptor FieldStatistics(bool? fieldStatistics = true) { @@ -415,7 +476,9 @@ public MultiTermVectorsOperationDescriptor FieldStatistics(bool? fieldStatistics } /// - /// Filter terms based on their tf-idf scores. + /// + /// Filter terms based on their tf-idf scores. + /// /// public MultiTermVectorsOperationDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.Core.TermVectors.Filter? filter) { @@ -442,7 +505,9 @@ public MultiTermVectorsOperationDescriptor Filter(Action - /// The ID of the document. + /// + /// The ID of the document. + /// /// public MultiTermVectorsOperationDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id? id) { @@ -451,7 +516,9 @@ public MultiTermVectorsOperationDescriptor Id(Elastic.Clients.Elasticsearch.Serv } /// - /// The index of the document. + /// + /// The index of the document. + /// /// public MultiTermVectorsOperationDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.IndexName? index) { @@ -460,7 +527,9 @@ public MultiTermVectorsOperationDescriptor Index(Elastic.Clients.Elasticsearch.S } /// - /// If `true`, the response includes term offsets. + /// + /// If true, the response includes term offsets. + /// /// public MultiTermVectorsOperationDescriptor Offsets(bool? offsets = true) { @@ -469,7 +538,9 @@ public MultiTermVectorsOperationDescriptor Offsets(bool? offsets = true) } /// - /// If `true`, the response includes term payloads. + /// + /// If true, the response includes term payloads. + /// /// public MultiTermVectorsOperationDescriptor Payloads(bool? payloads = true) { @@ -478,7 +549,9 @@ public MultiTermVectorsOperationDescriptor Payloads(bool? payloads = true) } /// - /// If `true`, the response includes term positions. + /// + /// If true, the response includes term positions. + /// /// public MultiTermVectorsOperationDescriptor Positions(bool? positions = true) { @@ -487,7 +560,9 @@ public MultiTermVectorsOperationDescriptor Positions(bool? positions = true) } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public MultiTermVectorsOperationDescriptor Routing(Elastic.Clients.Elasticsearch.Serverless.Routing? routing) { @@ -496,7 +571,9 @@ public MultiTermVectorsOperationDescriptor Routing(Elastic.Clients.Elasticsearch } /// - /// If true, the response includes term frequency and document frequency. + /// + /// If true, the response includes term frequency and document frequency. + /// /// public MultiTermVectorsOperationDescriptor TermStatistics(bool? termStatistics = true) { @@ -505,7 +582,9 @@ public MultiTermVectorsOperationDescriptor TermStatistics(bool? termStatistics = } /// - /// If `true`, returns the document version as part of a hit. + /// + /// If true, returns the document version as part of a hit. + /// /// public MultiTermVectorsOperationDescriptor Version(long? version) { @@ -514,7 +593,9 @@ public MultiTermVectorsOperationDescriptor Version(long? version) } /// - /// Specific version type. + /// + /// Specific version type. + /// /// public MultiTermVectorsOperationDescriptor VersionType(Elastic.Clients.Elasticsearch.Serverless.VersionType? versionType) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/DocumentRating.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/DocumentRating.g.cs index 071c9f0d4fd..4a2e1755791 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/DocumentRating.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/DocumentRating.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.RankEval; public sealed partial class DocumentRating { /// - /// The document ID. + /// + /// The document ID. + /// /// [JsonInclude, JsonPropertyName("_id")] public Elastic.Clients.Elasticsearch.Serverless.Id Id { get; set; } /// - /// The document’s index. For data streams, this should be the document’s backing index. + /// + /// The document’s index. For data streams, this should be the document’s backing index. + /// /// [JsonInclude, JsonPropertyName("_index")] public Elastic.Clients.Elasticsearch.Serverless.IndexName Index { get; set; } /// - /// The document’s relevance with regard to this search request. + /// + /// The document’s relevance with regard to this search request. + /// /// [JsonInclude, JsonPropertyName("rating")] public int Rating { get; set; } @@ -61,7 +67,9 @@ public DocumentRatingDescriptor() : base() private int RatingValue { get; set; } /// - /// The document ID. + /// + /// The document ID. + /// /// public DocumentRatingDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id id) { @@ -70,7 +78,9 @@ public DocumentRatingDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id i } /// - /// The document’s index. For data streams, this should be the document’s backing index. + /// + /// The document’s index. For data streams, this should be the document’s backing index. + /// /// public DocumentRatingDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.IndexName index) { @@ -79,7 +89,9 @@ public DocumentRatingDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.I } /// - /// The document’s relevance with regard to this search request. + /// + /// The document’s relevance with regard to this search request. + /// /// public DocumentRatingDescriptor Rating(int rating) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricDetail.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricDetail.g.cs index 16d62ac3f0b..3934d3a62ac 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricDetail.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricDetail.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.RankEval; public sealed partial class RankEvalMetricDetail { /// - /// The hits section shows a grouping of the search results with their supplied ratings + /// + /// The hits section shows a grouping of the search results with their supplied ratings + /// /// [JsonInclude, JsonPropertyName("hits")] public IReadOnlyCollection Hits { get; init; } /// - /// The metric_details give additional information about the calculated quality metric (e.g. how many of the retrieved documents were relevant). The content varies for each metric but allows for better interpretation of the results + /// + /// The metric_details give additional information about the calculated quality metric (e.g. how many of the retrieved documents were relevant). The content varies for each metric but allows for better interpretation of the results + /// /// [JsonInclude, JsonPropertyName("metric_details")] public IReadOnlyDictionary> MetricDetails { get; init; } /// - /// The metric_score in the details section shows the contribution of this query to the global quality metric score + /// + /// The metric_score in the details section shows the contribution of this query to the global quality metric score + /// /// [JsonInclude, JsonPropertyName("metric_score")] public double MetricScore { get; init; } /// - /// The unrated_docs section contains an _index and _id entry for each document in the search result for this query that didn’t have a ratings value. This can be used to ask the user to supply ratings for these documents + /// + /// The unrated_docs section contains an _index and _id entry for each document in the search result for this query that didn’t have a ratings value. This can be used to ask the user to supply ratings for these documents + /// /// [JsonInclude, JsonPropertyName("unrated_docs")] public IReadOnlyCollection UnratedDocs { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricDiscountedCumulativeGain.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricDiscountedCumulativeGain.g.cs index 034f48226a1..615d4356cf6 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricDiscountedCumulativeGain.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricDiscountedCumulativeGain.g.cs @@ -28,26 +28,34 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.RankEval; /// -/// Discounted cumulative gain (DCG) +/// +/// Discounted cumulative gain (DCG) +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricDiscountedCumulativeGain { /// - /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// + /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// /// [JsonInclude, JsonPropertyName("k")] public int? k { get; set; } /// - /// If set to true, this metric will calculate the Normalized DCG. + /// + /// If set to true, this metric will calculate the Normalized DCG. + /// /// [JsonInclude, JsonPropertyName("normalize")] public bool? Normalize { get; set; } } /// -/// Discounted cumulative gain (DCG) +/// +/// Discounted cumulative gain (DCG) +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricDiscountedCumulativeGainDescriptor : SerializableDescriptor @@ -62,7 +70,9 @@ public RankEvalMetricDiscountedCumulativeGainDescriptor() : base() private bool? NormalizeValue { get; set; } /// - /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// + /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// /// public RankEvalMetricDiscountedCumulativeGainDescriptor k(int? k) { @@ -71,7 +81,9 @@ public RankEvalMetricDiscountedCumulativeGainDescriptor k(int? k) } /// - /// If set to true, this metric will calculate the Normalized DCG. + /// + /// If set to true, this metric will calculate the Normalized DCG. + /// /// public RankEvalMetricDiscountedCumulativeGainDescriptor Normalize(bool? normalize = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricExpectedReciprocalRank.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricExpectedReciprocalRank.g.cs index 36aa86800c3..1316267b831 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricExpectedReciprocalRank.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricExpectedReciprocalRank.g.cs @@ -28,26 +28,34 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.RankEval; /// -/// Expected Reciprocal Rank (ERR) +/// +/// Expected Reciprocal Rank (ERR) +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricExpectedReciprocalRank { /// - /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// + /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// /// [JsonInclude, JsonPropertyName("k")] public int? k { get; set; } /// - /// The highest relevance grade used in the user-supplied relevance judgments. + /// + /// The highest relevance grade used in the user-supplied relevance judgments. + /// /// [JsonInclude, JsonPropertyName("maximum_relevance")] public int MaximumRelevance { get; set; } } /// -/// Expected Reciprocal Rank (ERR) +/// +/// Expected Reciprocal Rank (ERR) +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricExpectedReciprocalRankDescriptor : SerializableDescriptor @@ -62,7 +70,9 @@ public RankEvalMetricExpectedReciprocalRankDescriptor() : base() private int MaximumRelevanceValue { get; set; } /// - /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// + /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// /// public RankEvalMetricExpectedReciprocalRankDescriptor k(int? k) { @@ -71,7 +81,9 @@ public RankEvalMetricExpectedReciprocalRankDescriptor k(int? k) } /// - /// The highest relevance grade used in the user-supplied relevance judgments. + /// + /// The highest relevance grade used in the user-supplied relevance judgments. + /// /// public RankEvalMetricExpectedReciprocalRankDescriptor MaximumRelevance(int maximumRelevance) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricMeanReciprocalRank.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricMeanReciprocalRank.g.cs index 5defddbf09a..75255541725 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricMeanReciprocalRank.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricMeanReciprocalRank.g.cs @@ -28,26 +28,34 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.RankEval; /// -/// Mean Reciprocal Rank +/// +/// Mean Reciprocal Rank +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricMeanReciprocalRank { /// - /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// + /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// /// [JsonInclude, JsonPropertyName("k")] public int? k { get; set; } /// - /// Sets the rating threshold above which documents are considered to be "relevant". + /// + /// Sets the rating threshold above which documents are considered to be "relevant". + /// /// [JsonInclude, JsonPropertyName("relevant_rating_threshold")] public int? RelevantRatingThreshold { get; set; } } /// -/// Mean Reciprocal Rank +/// +/// Mean Reciprocal Rank +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricMeanReciprocalRankDescriptor : SerializableDescriptor @@ -62,7 +70,9 @@ public RankEvalMetricMeanReciprocalRankDescriptor() : base() private int? RelevantRatingThresholdValue { get; set; } /// - /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// + /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// /// public RankEvalMetricMeanReciprocalRankDescriptor k(int? k) { @@ -71,7 +81,9 @@ public RankEvalMetricMeanReciprocalRankDescriptor k(int? k) } /// - /// Sets the rating threshold above which documents are considered to be "relevant". + /// + /// Sets the rating threshold above which documents are considered to be "relevant". + /// /// public RankEvalMetricMeanReciprocalRankDescriptor RelevantRatingThreshold(int? relevantRatingThreshold) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricPrecision.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricPrecision.g.cs index 044256b11cc..defa0222f92 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricPrecision.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricPrecision.g.cs @@ -28,32 +28,42 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.RankEval; /// -/// Precision at K (P@k) +/// +/// Precision at K (P@k) +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricPrecision { /// - /// Controls how unlabeled documents in the search results are counted. If set to true, unlabeled documents are ignored and neither count as relevant or irrelevant. Set to false (the default), they are treated as irrelevant. + /// + /// Controls how unlabeled documents in the search results are counted. If set to true, unlabeled documents are ignored and neither count as relevant or irrelevant. Set to false (the default), they are treated as irrelevant. + /// /// [JsonInclude, JsonPropertyName("ignore_unlabeled")] public bool? IgnoreUnlabeled { get; set; } /// - /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// + /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// /// [JsonInclude, JsonPropertyName("k")] public int? k { get; set; } /// - /// Sets the rating threshold above which documents are considered to be "relevant". + /// + /// Sets the rating threshold above which documents are considered to be "relevant". + /// /// [JsonInclude, JsonPropertyName("relevant_rating_threshold")] public int? RelevantRatingThreshold { get; set; } } /// -/// Precision at K (P@k) +/// +/// Precision at K (P@k) +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricPrecisionDescriptor : SerializableDescriptor @@ -69,7 +79,9 @@ public RankEvalMetricPrecisionDescriptor() : base() private int? RelevantRatingThresholdValue { get; set; } /// - /// Controls how unlabeled documents in the search results are counted. If set to true, unlabeled documents are ignored and neither count as relevant or irrelevant. Set to false (the default), they are treated as irrelevant. + /// + /// Controls how unlabeled documents in the search results are counted. If set to true, unlabeled documents are ignored and neither count as relevant or irrelevant. Set to false (the default), they are treated as irrelevant. + /// /// public RankEvalMetricPrecisionDescriptor IgnoreUnlabeled(bool? ignoreUnlabeled = true) { @@ -78,7 +90,9 @@ public RankEvalMetricPrecisionDescriptor IgnoreUnlabeled(bool? ignoreUnlabeled = } /// - /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// + /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// /// public RankEvalMetricPrecisionDescriptor k(int? k) { @@ -87,7 +101,9 @@ public RankEvalMetricPrecisionDescriptor k(int? k) } /// - /// Sets the rating threshold above which documents are considered to be "relevant". + /// + /// Sets the rating threshold above which documents are considered to be "relevant". + /// /// public RankEvalMetricPrecisionDescriptor RelevantRatingThreshold(int? relevantRatingThreshold) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricRecall.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricRecall.g.cs index b00d738c131..5520df8f82b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricRecall.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricRecall.g.cs @@ -28,26 +28,34 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.RankEval; /// -/// Recall at K (R@k) +/// +/// Recall at K (R@k) +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricRecall { /// - /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// + /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// /// [JsonInclude, JsonPropertyName("k")] public int? k { get; set; } /// - /// Sets the rating threshold above which documents are considered to be "relevant". + /// + /// Sets the rating threshold above which documents are considered to be "relevant". + /// /// [JsonInclude, JsonPropertyName("relevant_rating_threshold")] public int? RelevantRatingThreshold { get; set; } } /// -/// Recall at K (R@k) +/// +/// Recall at K (R@k) +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricRecallDescriptor : SerializableDescriptor @@ -62,7 +70,9 @@ public RankEvalMetricRecallDescriptor() : base() private int? RelevantRatingThresholdValue { get; set; } /// - /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// + /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// /// public RankEvalMetricRecallDescriptor k(int? k) { @@ -71,7 +81,9 @@ public RankEvalMetricRecallDescriptor k(int? k) } /// - /// Sets the rating threshold above which documents are considered to be "relevant". + /// + /// Sets the rating threshold above which documents are considered to be "relevant". + /// /// public RankEvalMetricRecallDescriptor RelevantRatingThreshold(int? relevantRatingThreshold) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalRequestItem.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalRequestItem.g.cs index b9677341432..70203af12a7 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalRequestItem.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalRequestItem.g.cs @@ -30,31 +30,41 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.RankEval; public sealed partial class RankEvalRequestItem { /// - /// The search request’s ID, used to group result details later. + /// + /// The search request’s ID, used to group result details later. + /// /// [JsonInclude, JsonPropertyName("id")] public Elastic.Clients.Elasticsearch.Serverless.Id Id { get; set; } /// - /// The search template parameters. + /// + /// The search template parameters. + /// /// [JsonInclude, JsonPropertyName("params")] public IDictionary? Params { get; set; } /// - /// List of document ratings + /// + /// List of document ratings + /// /// [JsonInclude, JsonPropertyName("ratings")] public ICollection Ratings { get; set; } /// - /// The query being evaluated. + /// + /// The query being evaluated. + /// /// [JsonInclude, JsonPropertyName("request")] public Elastic.Clients.Elasticsearch.Serverless.Core.RankEval.RankEvalQuery? Request { get; set; } /// - /// The search template Id + /// + /// The search template Id + /// /// [JsonInclude, JsonPropertyName("template_id")] public Elastic.Clients.Elasticsearch.Serverless.Id? TemplateId { get; set; } @@ -80,7 +90,9 @@ public RankEvalRequestItemDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Id? TemplateIdValue { get; set; } /// - /// The search request’s ID, used to group result details later. + /// + /// The search request’s ID, used to group result details later. + /// /// public RankEvalRequestItemDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id id) { @@ -89,7 +101,9 @@ public RankEvalRequestItemDescriptor Id(Elastic.Clients.Elasticsearch } /// - /// The search template parameters. + /// + /// The search template parameters. + /// /// public RankEvalRequestItemDescriptor Params(Func, FluentDictionary> selector) { @@ -98,7 +112,9 @@ public RankEvalRequestItemDescriptor Params(Func - /// List of document ratings + /// + /// List of document ratings + /// /// public RankEvalRequestItemDescriptor Ratings(ICollection ratings) { @@ -137,7 +153,9 @@ public RankEvalRequestItemDescriptor Ratings(params Action - /// The query being evaluated. + /// + /// The query being evaluated. + /// /// public RankEvalRequestItemDescriptor Request(Elastic.Clients.Elasticsearch.Serverless.Core.RankEval.RankEvalQuery? request) { @@ -164,7 +182,9 @@ public RankEvalRequestItemDescriptor Request(Action - /// The search template Id + /// + /// The search template Id + /// /// public RankEvalRequestItemDescriptor TemplateId(Elastic.Clients.Elasticsearch.Serverless.Id? templateId) { @@ -260,7 +280,9 @@ public RankEvalRequestItemDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Id? TemplateIdValue { get; set; } /// - /// The search request’s ID, used to group result details later. + /// + /// The search request’s ID, used to group result details later. + /// /// public RankEvalRequestItemDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id id) { @@ -269,7 +291,9 @@ public RankEvalRequestItemDescriptor Id(Elastic.Clients.Elasticsearch.Serverless } /// - /// The search template parameters. + /// + /// The search template parameters. + /// /// public RankEvalRequestItemDescriptor Params(Func, FluentDictionary> selector) { @@ -278,7 +302,9 @@ public RankEvalRequestItemDescriptor Params(Func - /// List of document ratings + /// + /// List of document ratings + /// /// public RankEvalRequestItemDescriptor Ratings(ICollection ratings) { @@ -317,7 +343,9 @@ public RankEvalRequestItemDescriptor Ratings(params Action - /// The query being evaluated. + /// + /// The query being evaluated. + /// /// public RankEvalRequestItemDescriptor Request(Elastic.Clients.Elasticsearch.Serverless.Core.RankEval.RankEvalQuery? request) { @@ -344,7 +372,9 @@ public RankEvalRequestItemDescriptor Request(Action - /// The search template Id + /// + /// The search template Id + /// /// public RankEvalRequestItemDescriptor TemplateId(Elastic.Clients.Elasticsearch.Serverless.Id? templateId) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Reindex/Destination.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Reindex/Destination.g.cs index 67fa69e84f3..0cc263940d7 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Reindex/Destination.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Reindex/Destination.g.cs @@ -30,31 +30,43 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.Reindex; public sealed partial class Destination { /// - /// The name of the data stream, index, or index alias you are copying to. + /// + /// The name of the data stream, index, or index alias you are copying to. + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.Serverless.IndexName Index { get; set; } /// - /// Set to `create` to only index documents that do not already exist.
Important: To reindex to a data stream destination, this argument must be `create`. + /// + /// Set to create to only index documents that do not already exist. + /// Important: To reindex to a data stream destination, this argument must be create. + /// /// [JsonInclude, JsonPropertyName("op_type")] public Elastic.Clients.Elasticsearch.Serverless.OpType? OpType { get; set; } /// - /// The name of the pipeline to use. + /// + /// The name of the pipeline to use. + /// /// [JsonInclude, JsonPropertyName("pipeline")] public string? Pipeline { get; set; } /// - /// By default, a document's routing is preserved unless it’s changed by the script.
Set to `discard` to set routing to `null`, or `=value` to route using the specified `value`. + /// + /// By default, a document's routing is preserved unless it’s changed by the script. + /// Set to discard to set routing to null, or =value to route using the specified value. + /// /// [JsonInclude, JsonPropertyName("routing")] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get; set; } /// - /// The versioning to use for the indexing operation. + /// + /// The versioning to use for the indexing operation. + /// /// [JsonInclude, JsonPropertyName("version_type")] public Elastic.Clients.Elasticsearch.Serverless.VersionType? VersionType { get; set; } @@ -75,7 +87,9 @@ public DestinationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.VersionType? VersionTypeValue { get; set; } /// - /// The name of the data stream, index, or index alias you are copying to. + /// + /// The name of the data stream, index, or index alias you are copying to. + /// /// public DestinationDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.IndexName index) { @@ -84,7 +98,10 @@ public DestinationDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.Inde } /// - /// Set to `create` to only index documents that do not already exist.
Important: To reindex to a data stream destination, this argument must be `create`. + /// + /// Set to create to only index documents that do not already exist. + /// Important: To reindex to a data stream destination, this argument must be create. + /// /// public DestinationDescriptor OpType(Elastic.Clients.Elasticsearch.Serverless.OpType? opType) { @@ -93,7 +110,9 @@ public DestinationDescriptor OpType(Elastic.Clients.Elasticsearch.Serverless.OpT } /// - /// The name of the pipeline to use. + /// + /// The name of the pipeline to use. + /// /// public DestinationDescriptor Pipeline(string? pipeline) { @@ -102,7 +121,10 @@ public DestinationDescriptor Pipeline(string? pipeline) } /// - /// By default, a document's routing is preserved unless it’s changed by the script.
Set to `discard` to set routing to `null`, or `=value` to route using the specified `value`. + /// + /// By default, a document's routing is preserved unless it’s changed by the script. + /// Set to discard to set routing to null, or =value to route using the specified value. + /// /// public DestinationDescriptor Routing(Elastic.Clients.Elasticsearch.Serverless.Routing? routing) { @@ -111,7 +133,9 @@ public DestinationDescriptor Routing(Elastic.Clients.Elasticsearch.Serverless.Ro } /// - /// The versioning to use for the indexing operation. + /// + /// The versioning to use for the indexing operation. + /// /// public DestinationDescriptor VersionType(Elastic.Clients.Elasticsearch.Serverless.VersionType? versionType) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Reindex/RemoteSource.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Reindex/RemoteSource.g.cs index 9f3ba8303cd..8977541e4cd 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Reindex/RemoteSource.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Reindex/RemoteSource.g.cs @@ -30,37 +30,50 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.Reindex; public sealed partial class RemoteSource { /// - /// The remote connection timeout.
Defaults to 30 seconds. + /// + /// The remote connection timeout. + /// Defaults to 30 seconds. + /// /// [JsonInclude, JsonPropertyName("connect_timeout")] public Elastic.Clients.Elasticsearch.Serverless.Duration? ConnectTimeout { get; set; } /// - /// An object containing the headers of the request. + /// + /// An object containing the headers of the request. + /// /// [JsonInclude, JsonPropertyName("headers")] public IDictionary? Headers { get; set; } /// - /// The URL for the remote instance of Elasticsearch that you want to index from. + /// + /// The URL for the remote instance of Elasticsearch that you want to index from. + /// /// [JsonInclude, JsonPropertyName("host")] public string Host { get; set; } /// - /// The password to use for authentication with the remote host. + /// + /// The password to use for authentication with the remote host. + /// /// [JsonInclude, JsonPropertyName("password")] public string? Password { get; set; } /// - /// The remote socket read timeout. Defaults to 30 seconds. + /// + /// The remote socket read timeout. Defaults to 30 seconds. + /// /// [JsonInclude, JsonPropertyName("socket_timeout")] public Elastic.Clients.Elasticsearch.Serverless.Duration? SocketTimeout { get; set; } /// - /// The username to use for authentication with the remote host. + /// + /// The username to use for authentication with the remote host. + /// /// [JsonInclude, JsonPropertyName("username")] public Elastic.Clients.Elasticsearch.Serverless.Username? Username { get; set; } @@ -82,7 +95,10 @@ public RemoteSourceDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Username? UsernameValue { get; set; } /// - /// The remote connection timeout.
Defaults to 30 seconds. + /// + /// The remote connection timeout. + /// Defaults to 30 seconds. + /// /// public RemoteSourceDescriptor ConnectTimeout(Elastic.Clients.Elasticsearch.Serverless.Duration? connectTimeout) { @@ -91,7 +107,9 @@ public RemoteSourceDescriptor ConnectTimeout(Elastic.Clients.Elasticsearch.Serve } /// - /// An object containing the headers of the request. + /// + /// An object containing the headers of the request. + /// /// public RemoteSourceDescriptor Headers(Func, FluentDictionary> selector) { @@ -100,7 +118,9 @@ public RemoteSourceDescriptor Headers(Func, Flu } /// - /// The URL for the remote instance of Elasticsearch that you want to index from. + /// + /// The URL for the remote instance of Elasticsearch that you want to index from. + /// /// public RemoteSourceDescriptor Host(string host) { @@ -109,7 +129,9 @@ public RemoteSourceDescriptor Host(string host) } /// - /// The password to use for authentication with the remote host. + /// + /// The password to use for authentication with the remote host. + /// /// public RemoteSourceDescriptor Password(string? password) { @@ -118,7 +140,9 @@ public RemoteSourceDescriptor Password(string? password) } /// - /// The remote socket read timeout. Defaults to 30 seconds. + /// + /// The remote socket read timeout. Defaults to 30 seconds. + /// /// public RemoteSourceDescriptor SocketTimeout(Elastic.Clients.Elasticsearch.Serverless.Duration? socketTimeout) { @@ -127,7 +151,9 @@ public RemoteSourceDescriptor SocketTimeout(Elastic.Clients.Elasticsearch.Server } /// - /// The username to use for authentication with the remote host. + /// + /// The username to use for authentication with the remote host. + /// /// public RemoteSourceDescriptor Username(Elastic.Clients.Elasticsearch.Serverless.Username? username) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Reindex/Source.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Reindex/Source.g.cs index c7ffe5d858d..7da14332827 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Reindex/Source.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Reindex/Source.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.Reindex; public sealed partial class Source { /// - /// The name of the data stream, index, or alias you are copying from.
Accepts a comma-separated list to reindex from multiple sources. + /// + /// The name of the data stream, index, or alias you are copying from. + /// Accepts a comma-separated list to reindex from multiple sources. + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.Serverless.Indices Indices { get; set; } /// - /// Specifies the documents to reindex using the Query DSL. + /// + /// Specifies the documents to reindex using the Query DSL. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? Query { get; set; } /// - /// A remote instance of Elasticsearch that you want to index from. + /// + /// A remote instance of Elasticsearch that you want to index from. + /// /// [JsonInclude, JsonPropertyName("remote")] public Elastic.Clients.Elasticsearch.Serverless.Core.Reindex.RemoteSource? Remote { get; set; } @@ -50,13 +57,18 @@ public sealed partial class Source public IDictionary? RuntimeMappings { get; set; } /// - /// The number of documents to index per batch.
Use when indexing from remote to ensure that the batches fit within the on-heap buffer, which defaults to a maximum size of 100 MB. + /// + /// The number of documents to index per batch. + /// Use when indexing from remote to ensure that the batches fit within the on-heap buffer, which defaults to a maximum size of 100 MB. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// Slice the reindex request manually using the provided slice ID and total number of slices. + /// + /// Slice the reindex request manually using the provided slice ID and total number of slices. + /// /// [JsonInclude, JsonPropertyName("slice")] public Elastic.Clients.Elasticsearch.Serverless.SlicedScroll? Slice { get; set; } @@ -65,7 +77,10 @@ public sealed partial class Source public ICollection? Sort { get; set; } /// - /// If `true` reindexes all source fields.
Set to a list to reindex select fields. + /// + /// If true reindexes all source fields. + /// Set to a list to reindex select fields. + /// /// [JsonInclude, JsonPropertyName("_source")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] @@ -99,7 +114,10 @@ public SourceDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Fields? SourceFieldsValue { get; set; } /// - /// The name of the data stream, index, or alias you are copying from.
Accepts a comma-separated list to reindex from multiple sources. + /// + /// The name of the data stream, index, or alias you are copying from. + /// Accepts a comma-separated list to reindex from multiple sources. + /// /// public SourceDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.Indices indices) { @@ -108,7 +126,9 @@ public SourceDescriptor Indices(Elastic.Clients.Elasticsearch.Serverl } /// - /// Specifies the documents to reindex using the Query DSL. + /// + /// Specifies the documents to reindex using the Query DSL. + /// /// public SourceDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -135,7 +155,9 @@ public SourceDescriptor Query(Action - /// A remote instance of Elasticsearch that you want to index from. + /// + /// A remote instance of Elasticsearch that you want to index from. + /// /// public SourceDescriptor Remote(Elastic.Clients.Elasticsearch.Serverless.Core.Reindex.RemoteSource? remote) { @@ -168,7 +190,10 @@ public SourceDescriptor RuntimeMappings(Func - /// The number of documents to index per batch.
Use when indexing from remote to ensure that the batches fit within the on-heap buffer, which defaults to a maximum size of 100 MB. + /// + /// The number of documents to index per batch. + /// Use when indexing from remote to ensure that the batches fit within the on-heap buffer, which defaults to a maximum size of 100 MB. + /// /// public SourceDescriptor Size(int? size) { @@ -177,7 +202,9 @@ public SourceDescriptor Size(int? size) } /// - /// Slice the reindex request manually using the provided slice ID and total number of slices. + /// + /// Slice the reindex request manually using the provided slice ID and total number of slices. + /// /// public SourceDescriptor Slice(Elastic.Clients.Elasticsearch.Serverless.SlicedScroll? slice) { @@ -240,7 +267,10 @@ public SourceDescriptor Sort(params Action - /// If `true` reindexes all source fields.
Set to a list to reindex select fields. + /// + /// If true reindexes all source fields. + /// Set to a list to reindex select fields. + /// /// public SourceDescriptor SourceFields(Elastic.Clients.Elasticsearch.Serverless.Fields? sourceFields) { @@ -379,7 +409,10 @@ public SourceDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Fields? SourceFieldsValue { get; set; } /// - /// The name of the data stream, index, or alias you are copying from.
Accepts a comma-separated list to reindex from multiple sources. + /// + /// The name of the data stream, index, or alias you are copying from. + /// Accepts a comma-separated list to reindex from multiple sources. + /// /// public SourceDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.Indices indices) { @@ -388,7 +421,9 @@ public SourceDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.Indices } /// - /// Specifies the documents to reindex using the Query DSL. + /// + /// Specifies the documents to reindex using the Query DSL. + /// /// public SourceDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -415,7 +450,9 @@ public SourceDescriptor Query(Action - /// A remote instance of Elasticsearch that you want to index from. + /// + /// A remote instance of Elasticsearch that you want to index from. + /// /// public SourceDescriptor Remote(Elastic.Clients.Elasticsearch.Serverless.Core.Reindex.RemoteSource? remote) { @@ -448,7 +485,10 @@ public SourceDescriptor RuntimeMappings(Func - /// The number of documents to index per batch.
Use when indexing from remote to ensure that the batches fit within the on-heap buffer, which defaults to a maximum size of 100 MB. + /// + /// The number of documents to index per batch. + /// Use when indexing from remote to ensure that the batches fit within the on-heap buffer, which defaults to a maximum size of 100 MB. + /// /// public SourceDescriptor Size(int? size) { @@ -457,7 +497,9 @@ public SourceDescriptor Size(int? size) } /// - /// Slice the reindex request manually using the provided slice ID and total number of slices. + /// + /// Slice the reindex request manually using the provided slice ID and total number of slices. + /// /// public SourceDescriptor Slice(Elastic.Clients.Elasticsearch.Serverless.SlicedScroll? slice) { @@ -520,7 +562,10 @@ public SourceDescriptor Sort(params Action - /// If `true` reindexes all source fields.
Set to a list to reindex select fields. + /// + /// If true reindexes all source fields. + /// Set to a list to reindex select fields. + /// /// public SourceDescriptor SourceFields(Elastic.Clients.Elasticsearch.Serverless.Fields? sourceFields) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/ReindexRethrottle/ReindexStatus.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/ReindexRethrottle/ReindexStatus.g.cs index 778a03ca4de..d3d73bde17c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/ReindexRethrottle/ReindexStatus.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/ReindexRethrottle/ReindexStatus.g.cs @@ -30,37 +30,49 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.ReindexRethrottle; public sealed partial class ReindexStatus { /// - /// The number of scroll responses pulled back by the reindex. + /// + /// The number of scroll responses pulled back by the reindex. + /// /// [JsonInclude, JsonPropertyName("batches")] public long Batches { get; init; } /// - /// The number of documents that were successfully created. + /// + /// The number of documents that were successfully created. + /// /// [JsonInclude, JsonPropertyName("created")] public long Created { get; init; } /// - /// The number of documents that were successfully deleted. + /// + /// The number of documents that were successfully deleted. + /// /// [JsonInclude, JsonPropertyName("deleted")] public long Deleted { get; init; } /// - /// The number of documents that were ignored because the script used for the reindex returned a `noop` value for `ctx.op`. + /// + /// The number of documents that were ignored because the script used for the reindex returned a noop value for ctx.op. + /// /// [JsonInclude, JsonPropertyName("noops")] public long Noops { get; init; } /// - /// The number of requests per second effectively executed during the reindex. + /// + /// The number of requests per second effectively executed during the reindex. + /// /// [JsonInclude, JsonPropertyName("requests_per_second")] public float RequestsPerSecond { get; init; } /// - /// The number of retries attempted by reindex. `bulk` is the number of bulk actions retried and `search` is the number of search actions retried. + /// + /// The number of retries attempted by reindex. bulk is the number of bulk actions retried and search is the number of search actions retried. + /// /// [JsonInclude, JsonPropertyName("retries")] public Elastic.Clients.Elasticsearch.Serverless.Retries Retries { get; init; } @@ -68,7 +80,9 @@ public sealed partial class ReindexStatus public Elastic.Clients.Elasticsearch.Serverless.Duration? Throttled { get; init; } /// - /// Number of milliseconds the request slept to conform to `requests_per_second`. + /// + /// Number of milliseconds the request slept to conform to requests_per_second. + /// /// [JsonInclude, JsonPropertyName("throttled_millis")] public long ThrottledMillis { get; init; } @@ -76,25 +90,34 @@ public sealed partial class ReindexStatus public Elastic.Clients.Elasticsearch.Serverless.Duration? ThrottledUntil { get; init; } /// - /// This field should always be equal to zero in a `_reindex` response.
It only has meaning when using the Task API, where it indicates the next time (in milliseconds since epoch) a throttled request will be executed again in order to conform to `requests_per_second`. + /// + /// This field should always be equal to zero in a _reindex response. + /// It only has meaning when using the Task API, where it indicates the next time (in milliseconds since epoch) a throttled request will be executed again in order to conform to requests_per_second. + /// /// [JsonInclude, JsonPropertyName("throttled_until_millis")] public long ThrottledUntilMillis { get; init; } /// - /// The number of documents that were successfully processed. + /// + /// The number of documents that were successfully processed. + /// /// [JsonInclude, JsonPropertyName("total")] public long Total { get; init; } /// - /// The number of documents that were successfully updated, for example, a document with same ID already existed prior to reindex updating it. + /// + /// The number of documents that were successfully updated, for example, a document with same ID already existed prior to reindex updating it. + /// /// [JsonInclude, JsonPropertyName("updated")] public long Updated { get; init; } /// - /// The number of version conflicts that reindex hits. + /// + /// The number of version conflicts that reindex hits. + /// /// [JsonInclude, JsonPropertyName("version_conflicts")] public long VersionConflicts { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/CompletionContext.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/CompletionContext.g.cs index a7cd51b9752..735e528d441 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/CompletionContext.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/CompletionContext.g.cs @@ -30,31 +30,46 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.Search; public sealed partial class CompletionContext { /// - /// The factor by which the score of the suggestion should be boosted.
The score is computed by multiplying the boost with the suggestion weight. + /// + /// The factor by which the score of the suggestion should be boosted. + /// The score is computed by multiplying the boost with the suggestion weight. + /// /// [JsonInclude, JsonPropertyName("boost")] public double? Boost { get; set; } /// - /// The value of the category to filter/boost on. + /// + /// The value of the category to filter/boost on. + /// /// [JsonInclude, JsonPropertyName("context")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.Context Context { get; set; } /// - /// An array of precision values at which neighboring geohashes should be taken into account.
Precision value can be a distance value (`5m`, `10km`, etc.) or a raw geohash precision (`1`..`12`).
Defaults to generating neighbors for index time precision level. + /// + /// An array of precision values at which neighboring geohashes should be taken into account. + /// Precision value can be a distance value (5m, 10km, etc.) or a raw geohash precision (1..12). + /// Defaults to generating neighbors for index time precision level. + /// /// [JsonInclude, JsonPropertyName("neighbours")] public ICollection? Neighbours { get; set; } /// - /// The precision of the geohash to encode the query geo point.
Can be specified as a distance value (`5m`, `10km`, etc.), or as a raw geohash precision (`1`..`12`).
Defaults to index time precision level. + /// + /// The precision of the geohash to encode the query geo point. + /// Can be specified as a distance value (5m, 10km, etc.), or as a raw geohash precision (1..12). + /// Defaults to index time precision level. + /// /// [JsonInclude, JsonPropertyName("precision")] public Elastic.Clients.Elasticsearch.Serverless.GeohashPrecision? Precision { get; set; } /// - /// Whether the category value should be treated as a prefix or not. + /// + /// Whether the category value should be treated as a prefix or not. + /// /// [JsonInclude, JsonPropertyName("prefix")] public bool? Prefix { get; set; } @@ -75,7 +90,10 @@ public CompletionContextDescriptor() : base() private bool? PrefixValue { get; set; } /// - /// The factor by which the score of the suggestion should be boosted.
The score is computed by multiplying the boost with the suggestion weight. + /// + /// The factor by which the score of the suggestion should be boosted. + /// The score is computed by multiplying the boost with the suggestion weight. + /// /// public CompletionContextDescriptor Boost(double? boost) { @@ -84,7 +102,9 @@ public CompletionContextDescriptor Boost(double? boost) } /// - /// The value of the category to filter/boost on. + /// + /// The value of the category to filter/boost on. + /// /// public CompletionContextDescriptor Context(Elastic.Clients.Elasticsearch.Serverless.Core.Search.Context context) { @@ -93,7 +113,11 @@ public CompletionContextDescriptor Context(Elastic.Clients.Elasticsearch.Serverl } /// - /// An array of precision values at which neighboring geohashes should be taken into account.
Precision value can be a distance value (`5m`, `10km`, etc.) or a raw geohash precision (`1`..`12`).
Defaults to generating neighbors for index time precision level. + /// + /// An array of precision values at which neighboring geohashes should be taken into account. + /// Precision value can be a distance value (5m, 10km, etc.) or a raw geohash precision (1..12). + /// Defaults to generating neighbors for index time precision level. + /// /// public CompletionContextDescriptor Neighbours(ICollection? neighbours) { @@ -102,7 +126,11 @@ public CompletionContextDescriptor Neighbours(ICollection - /// The precision of the geohash to encode the query geo point.
Can be specified as a distance value (`5m`, `10km`, etc.), or as a raw geohash precision (`1`..`12`).
Defaults to index time precision level. + /// + /// The precision of the geohash to encode the query geo point. + /// Can be specified as a distance value (5m, 10km, etc.), or as a raw geohash precision (1..12). + /// Defaults to index time precision level. + /// /// public CompletionContextDescriptor Precision(Elastic.Clients.Elasticsearch.Serverless.GeohashPrecision? precision) { @@ -111,7 +139,9 @@ public CompletionContextDescriptor Precision(Elastic.Clients.Elasticsearch.Serve } /// - /// Whether the category value should be treated as a prefix or not. + /// + /// Whether the category value should be treated as a prefix or not. + /// /// public CompletionContextDescriptor Prefix(bool? prefix = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/CompletionSuggester.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/CompletionSuggester.g.cs index 2a46ade476a..3a121eb0a95 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/CompletionSuggester.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/CompletionSuggester.g.cs @@ -30,43 +30,59 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.Search; public sealed partial class CompletionSuggester { /// - /// The analyzer to analyze the suggest text with.
Defaults to the search analyzer of the suggest field. + /// + /// The analyzer to analyze the suggest text with. + /// Defaults to the search analyzer of the suggest field. + /// /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } /// - /// A value, geo point object, or a geo hash string to filter or boost the suggestion on. + /// + /// A value, geo point object, or a geo hash string to filter or boost the suggestion on. + /// /// [JsonInclude, JsonPropertyName("contexts")] public IDictionary>>? Contexts { get; set; } /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Enables fuzziness, meaning you can have a typo in your search and still get results back. + /// + /// Enables fuzziness, meaning you can have a typo in your search and still get results back. + /// /// [JsonInclude, JsonPropertyName("fuzzy")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.SuggestFuzziness? Fuzzy { get; set; } /// - /// A regex query that expresses a prefix as a regular expression. + /// + /// A regex query that expresses a prefix as a regular expression. + /// /// [JsonInclude, JsonPropertyName("regex")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.RegexOptions? Regex { get; set; } /// - /// The maximum corrections to be returned per suggest text token. + /// + /// The maximum corrections to be returned per suggest text token. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// Whether duplicate suggestions should be filtered out. + /// + /// Whether duplicate suggestions should be filtered out. + /// /// [JsonInclude, JsonPropertyName("skip_duplicates")] public bool? SkipDuplicates { get; set; } @@ -95,7 +111,10 @@ public CompletionSuggesterDescriptor() : base() private bool? SkipDuplicatesValue { get; set; } /// - /// The analyzer to analyze the suggest text with.
Defaults to the search analyzer of the suggest field. + /// + /// The analyzer to analyze the suggest text with. + /// Defaults to the search analyzer of the suggest field. + /// /// public CompletionSuggesterDescriptor Analyzer(string? analyzer) { @@ -104,7 +123,9 @@ public CompletionSuggesterDescriptor Analyzer(string? analyzer) } /// - /// A value, geo point object, or a geo hash string to filter or boost the suggestion on. + /// + /// A value, geo point object, or a geo hash string to filter or boost the suggestion on. + /// /// public CompletionSuggesterDescriptor Contexts(Func>>, FluentDictionary>>> selector) { @@ -113,7 +134,10 @@ public CompletionSuggesterDescriptor Contexts(Func - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public CompletionSuggesterDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -122,7 +146,10 @@ public CompletionSuggesterDescriptor Field(Elastic.Clients.Elasticsea } /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public CompletionSuggesterDescriptor Field(Expression> field) { @@ -131,7 +158,10 @@ public CompletionSuggesterDescriptor Field(Expression - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public CompletionSuggesterDescriptor Field(Expression> field) { @@ -140,7 +170,9 @@ public CompletionSuggesterDescriptor Field(Expression - /// Enables fuzziness, meaning you can have a typo in your search and still get results back. + /// + /// Enables fuzziness, meaning you can have a typo in your search and still get results back. + /// /// public CompletionSuggesterDescriptor Fuzzy(Elastic.Clients.Elasticsearch.Serverless.Core.Search.SuggestFuzziness? fuzzy) { @@ -167,7 +199,9 @@ public CompletionSuggesterDescriptor Fuzzy(Action - /// A regex query that expresses a prefix as a regular expression. + /// + /// A regex query that expresses a prefix as a regular expression. + /// /// public CompletionSuggesterDescriptor Regex(Elastic.Clients.Elasticsearch.Serverless.Core.Search.RegexOptions? regex) { @@ -194,7 +228,9 @@ public CompletionSuggesterDescriptor Regex(Action - /// The maximum corrections to be returned per suggest text token. + /// + /// The maximum corrections to be returned per suggest text token. + /// /// public CompletionSuggesterDescriptor Size(int? size) { @@ -203,7 +239,9 @@ public CompletionSuggesterDescriptor Size(int? size) } /// - /// Whether duplicate suggestions should be filtered out. + /// + /// Whether duplicate suggestions should be filtered out. + /// /// public CompletionSuggesterDescriptor SkipDuplicates(bool? skipDuplicates = true) { @@ -297,7 +335,10 @@ public CompletionSuggesterDescriptor() : base() private bool? SkipDuplicatesValue { get; set; } /// - /// The analyzer to analyze the suggest text with.
Defaults to the search analyzer of the suggest field. + /// + /// The analyzer to analyze the suggest text with. + /// Defaults to the search analyzer of the suggest field. + /// /// public CompletionSuggesterDescriptor Analyzer(string? analyzer) { @@ -306,7 +347,9 @@ public CompletionSuggesterDescriptor Analyzer(string? analyzer) } /// - /// A value, geo point object, or a geo hash string to filter or boost the suggestion on. + /// + /// A value, geo point object, or a geo hash string to filter or boost the suggestion on. + /// /// public CompletionSuggesterDescriptor Contexts(Func>>, FluentDictionary>>> selector) { @@ -315,7 +358,10 @@ public CompletionSuggesterDescriptor Contexts(Func - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public CompletionSuggesterDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -324,7 +370,10 @@ public CompletionSuggesterDescriptor Field(Elastic.Clients.Elasticsearch.Serverl } /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public CompletionSuggesterDescriptor Field(Expression> field) { @@ -333,7 +382,10 @@ public CompletionSuggesterDescriptor Field(Expression - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public CompletionSuggesterDescriptor Field(Expression> field) { @@ -342,7 +394,9 @@ public CompletionSuggesterDescriptor Field(Expression - /// Enables fuzziness, meaning you can have a typo in your search and still get results back. + /// + /// Enables fuzziness, meaning you can have a typo in your search and still get results back. + /// /// public CompletionSuggesterDescriptor Fuzzy(Elastic.Clients.Elasticsearch.Serverless.Core.Search.SuggestFuzziness? fuzzy) { @@ -369,7 +423,9 @@ public CompletionSuggesterDescriptor Fuzzy(Action - /// A regex query that expresses a prefix as a regular expression. + /// + /// A regex query that expresses a prefix as a regular expression. + /// /// public CompletionSuggesterDescriptor Regex(Elastic.Clients.Elasticsearch.Serverless.Core.Search.RegexOptions? regex) { @@ -396,7 +452,9 @@ public CompletionSuggesterDescriptor Regex(Action - /// The maximum corrections to be returned per suggest text token. + /// + /// The maximum corrections to be returned per suggest text token. + /// /// public CompletionSuggesterDescriptor Size(int? size) { @@ -405,7 +463,9 @@ public CompletionSuggesterDescriptor Size(int? size) } /// - /// Whether duplicate suggestions should be filtered out. + /// + /// Whether duplicate suggestions should be filtered out. + /// /// public CompletionSuggesterDescriptor SkipDuplicates(bool? skipDuplicates = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/DirectGenerator.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/DirectGenerator.g.cs index d850c22198d..404c811fbb5 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/DirectGenerator.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/DirectGenerator.g.cs @@ -30,67 +30,100 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.Search; public sealed partial class DirectGenerator { /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// The maximum edit distance candidate suggestions can have in order to be considered as a suggestion.
Can only be `1` or `2`. + /// + /// The maximum edit distance candidate suggestions can have in order to be considered as a suggestion. + /// Can only be 1 or 2. + /// /// [JsonInclude, JsonPropertyName("max_edits")] public int? MaxEdits { get; set; } /// - /// A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level.
Can improve accuracy at the cost of performance. + /// + /// A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level. + /// Can improve accuracy at the cost of performance. + /// /// [JsonInclude, JsonPropertyName("max_inspections")] public float? MaxInspections { get; set; } /// - /// The maximum threshold in number of documents in which a suggest text token can exist in order to be included.
This can be used to exclude high frequency terms — which are usually spelled correctly — from being spellchecked.
Can be a relative percentage number (for example `0.4`) or an absolute number to represent document frequencies.
If a value higher than 1 is specified, then fractional can not be specified. + /// + /// The maximum threshold in number of documents in which a suggest text token can exist in order to be included. + /// This can be used to exclude high frequency terms — which are usually spelled correctly — from being spellchecked. + /// Can be a relative percentage number (for example 0.4) or an absolute number to represent document frequencies. + /// If a value higher than 1 is specified, then fractional can not be specified. + /// /// [JsonInclude, JsonPropertyName("max_term_freq")] public float? MaxTermFreq { get; set; } /// - /// The minimal threshold in number of documents a suggestion should appear in.
This can improve quality by only suggesting high frequency terms.
Can be specified as an absolute number or as a relative percentage of number of documents.
If a value higher than 1 is specified, the number cannot be fractional. + /// + /// The minimal threshold in number of documents a suggestion should appear in. + /// This can improve quality by only suggesting high frequency terms. + /// Can be specified as an absolute number or as a relative percentage of number of documents. + /// If a value higher than 1 is specified, the number cannot be fractional. + /// /// [JsonInclude, JsonPropertyName("min_doc_freq")] public float? MinDocFreq { get; set; } /// - /// The minimum length a suggest text term must have in order to be included. + /// + /// The minimum length a suggest text term must have in order to be included. + /// /// [JsonInclude, JsonPropertyName("min_word_length")] public int? MinWordLength { get; set; } /// - /// A filter (analyzer) that is applied to each of the generated tokens before they are passed to the actual phrase scorer. + /// + /// A filter (analyzer) that is applied to each of the generated tokens before they are passed to the actual phrase scorer. + /// /// [JsonInclude, JsonPropertyName("post_filter")] public string? PostFilter { get; set; } /// - /// A filter (analyzer) that is applied to each of the tokens passed to this candidate generator.
This filter is applied to the original token before candidates are generated. + /// + /// A filter (analyzer) that is applied to each of the tokens passed to this candidate generator. + /// This filter is applied to the original token before candidates are generated. + /// /// [JsonInclude, JsonPropertyName("pre_filter")] public string? PreFilter { get; set; } /// - /// The number of minimal prefix characters that must match in order be a candidate suggestions.
Increasing this number improves spellcheck performance. + /// + /// The number of minimal prefix characters that must match in order be a candidate suggestions. + /// Increasing this number improves spellcheck performance. + /// /// [JsonInclude, JsonPropertyName("prefix_length")] public int? PrefixLength { get; set; } /// - /// The maximum corrections to be returned per suggest text token. + /// + /// The maximum corrections to be returned per suggest text token. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// Controls what suggestions are included on the suggestions generated on each shard. + /// + /// Controls what suggestions are included on the suggestions generated on each shard. + /// /// [JsonInclude, JsonPropertyName("suggest_mode")] public Elastic.Clients.Elasticsearch.Serverless.SuggestMode? SuggestMode { get; set; } @@ -117,7 +150,10 @@ public DirectGeneratorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.SuggestMode? SuggestModeValue { get; set; } /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public DirectGeneratorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -126,7 +162,10 @@ public DirectGeneratorDescriptor Field(Elastic.Clients.Elasticsearch. } /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public DirectGeneratorDescriptor Field(Expression> field) { @@ -135,7 +174,10 @@ public DirectGeneratorDescriptor Field(Expression - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public DirectGeneratorDescriptor Field(Expression> field) { @@ -144,7 +186,10 @@ public DirectGeneratorDescriptor Field(Expression - /// The maximum edit distance candidate suggestions can have in order to be considered as a suggestion.
Can only be `1` or `2`. + /// + /// The maximum edit distance candidate suggestions can have in order to be considered as a suggestion. + /// Can only be 1 or 2. + /// /// public DirectGeneratorDescriptor MaxEdits(int? maxEdits) { @@ -153,7 +198,10 @@ public DirectGeneratorDescriptor MaxEdits(int? maxEdits) } /// - /// A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level.
Can improve accuracy at the cost of performance. + /// + /// A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level. + /// Can improve accuracy at the cost of performance. + /// /// public DirectGeneratorDescriptor MaxInspections(float? maxInspections) { @@ -162,7 +210,12 @@ public DirectGeneratorDescriptor MaxInspections(float? maxInspections } /// - /// The maximum threshold in number of documents in which a suggest text token can exist in order to be included.
This can be used to exclude high frequency terms — which are usually spelled correctly — from being spellchecked.
Can be a relative percentage number (for example `0.4`) or an absolute number to represent document frequencies.
If a value higher than 1 is specified, then fractional can not be specified. + /// + /// The maximum threshold in number of documents in which a suggest text token can exist in order to be included. + /// This can be used to exclude high frequency terms — which are usually spelled correctly — from being spellchecked. + /// Can be a relative percentage number (for example 0.4) or an absolute number to represent document frequencies. + /// If a value higher than 1 is specified, then fractional can not be specified. + /// /// public DirectGeneratorDescriptor MaxTermFreq(float? maxTermFreq) { @@ -171,7 +224,12 @@ public DirectGeneratorDescriptor MaxTermFreq(float? maxTermFreq) } /// - /// The minimal threshold in number of documents a suggestion should appear in.
This can improve quality by only suggesting high frequency terms.
Can be specified as an absolute number or as a relative percentage of number of documents.
If a value higher than 1 is specified, the number cannot be fractional. + /// + /// The minimal threshold in number of documents a suggestion should appear in. + /// This can improve quality by only suggesting high frequency terms. + /// Can be specified as an absolute number or as a relative percentage of number of documents. + /// If a value higher than 1 is specified, the number cannot be fractional. + /// /// public DirectGeneratorDescriptor MinDocFreq(float? minDocFreq) { @@ -180,7 +238,9 @@ public DirectGeneratorDescriptor MinDocFreq(float? minDocFreq) } /// - /// The minimum length a suggest text term must have in order to be included. + /// + /// The minimum length a suggest text term must have in order to be included. + /// /// public DirectGeneratorDescriptor MinWordLength(int? minWordLength) { @@ -189,7 +249,9 @@ public DirectGeneratorDescriptor MinWordLength(int? minWordLength) } /// - /// A filter (analyzer) that is applied to each of the generated tokens before they are passed to the actual phrase scorer. + /// + /// A filter (analyzer) that is applied to each of the generated tokens before they are passed to the actual phrase scorer. + /// /// public DirectGeneratorDescriptor PostFilter(string? postFilter) { @@ -198,7 +260,10 @@ public DirectGeneratorDescriptor PostFilter(string? postFilter) } /// - /// A filter (analyzer) that is applied to each of the tokens passed to this candidate generator.
This filter is applied to the original token before candidates are generated. + /// + /// A filter (analyzer) that is applied to each of the tokens passed to this candidate generator. + /// This filter is applied to the original token before candidates are generated. + /// /// public DirectGeneratorDescriptor PreFilter(string? preFilter) { @@ -207,7 +272,10 @@ public DirectGeneratorDescriptor PreFilter(string? preFilter) } /// - /// The number of minimal prefix characters that must match in order be a candidate suggestions.
Increasing this number improves spellcheck performance. + /// + /// The number of minimal prefix characters that must match in order be a candidate suggestions. + /// Increasing this number improves spellcheck performance. + /// /// public DirectGeneratorDescriptor PrefixLength(int? prefixLength) { @@ -216,7 +284,9 @@ public DirectGeneratorDescriptor PrefixLength(int? prefixLength) } /// - /// The maximum corrections to be returned per suggest text token. + /// + /// The maximum corrections to be returned per suggest text token. + /// /// public DirectGeneratorDescriptor Size(int? size) { @@ -225,7 +295,9 @@ public DirectGeneratorDescriptor Size(int? size) } /// - /// Controls what suggestions are included on the suggestions generated on each shard. + /// + /// Controls what suggestions are included on the suggestions generated on each shard. + /// /// public DirectGeneratorDescriptor SuggestMode(Elastic.Clients.Elasticsearch.Serverless.SuggestMode? suggestMode) { @@ -323,7 +395,10 @@ public DirectGeneratorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.SuggestMode? SuggestModeValue { get; set; } /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public DirectGeneratorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -332,7 +407,10 @@ public DirectGeneratorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless. } /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public DirectGeneratorDescriptor Field(Expression> field) { @@ -341,7 +419,10 @@ public DirectGeneratorDescriptor Field(Expression - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public DirectGeneratorDescriptor Field(Expression> field) { @@ -350,7 +431,10 @@ public DirectGeneratorDescriptor Field(Expression - /// The maximum edit distance candidate suggestions can have in order to be considered as a suggestion.
Can only be `1` or `2`. + /// + /// The maximum edit distance candidate suggestions can have in order to be considered as a suggestion. + /// Can only be 1 or 2. + /// /// public DirectGeneratorDescriptor MaxEdits(int? maxEdits) { @@ -359,7 +443,10 @@ public DirectGeneratorDescriptor MaxEdits(int? maxEdits) } /// - /// A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level.
Can improve accuracy at the cost of performance. + /// + /// A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level. + /// Can improve accuracy at the cost of performance. + /// /// public DirectGeneratorDescriptor MaxInspections(float? maxInspections) { @@ -368,7 +455,12 @@ public DirectGeneratorDescriptor MaxInspections(float? maxInspections) } /// - /// The maximum threshold in number of documents in which a suggest text token can exist in order to be included.
This can be used to exclude high frequency terms — which are usually spelled correctly — from being spellchecked.
Can be a relative percentage number (for example `0.4`) or an absolute number to represent document frequencies.
If a value higher than 1 is specified, then fractional can not be specified. + /// + /// The maximum threshold in number of documents in which a suggest text token can exist in order to be included. + /// This can be used to exclude high frequency terms — which are usually spelled correctly — from being spellchecked. + /// Can be a relative percentage number (for example 0.4) or an absolute number to represent document frequencies. + /// If a value higher than 1 is specified, then fractional can not be specified. + /// /// public DirectGeneratorDescriptor MaxTermFreq(float? maxTermFreq) { @@ -377,7 +469,12 @@ public DirectGeneratorDescriptor MaxTermFreq(float? maxTermFreq) } /// - /// The minimal threshold in number of documents a suggestion should appear in.
This can improve quality by only suggesting high frequency terms.
Can be specified as an absolute number or as a relative percentage of number of documents.
If a value higher than 1 is specified, the number cannot be fractional. + /// + /// The minimal threshold in number of documents a suggestion should appear in. + /// This can improve quality by only suggesting high frequency terms. + /// Can be specified as an absolute number or as a relative percentage of number of documents. + /// If a value higher than 1 is specified, the number cannot be fractional. + /// /// public DirectGeneratorDescriptor MinDocFreq(float? minDocFreq) { @@ -386,7 +483,9 @@ public DirectGeneratorDescriptor MinDocFreq(float? minDocFreq) } /// - /// The minimum length a suggest text term must have in order to be included. + /// + /// The minimum length a suggest text term must have in order to be included. + /// /// public DirectGeneratorDescriptor MinWordLength(int? minWordLength) { @@ -395,7 +494,9 @@ public DirectGeneratorDescriptor MinWordLength(int? minWordLength) } /// - /// A filter (analyzer) that is applied to each of the generated tokens before they are passed to the actual phrase scorer. + /// + /// A filter (analyzer) that is applied to each of the generated tokens before they are passed to the actual phrase scorer. + /// /// public DirectGeneratorDescriptor PostFilter(string? postFilter) { @@ -404,7 +505,10 @@ public DirectGeneratorDescriptor PostFilter(string? postFilter) } /// - /// A filter (analyzer) that is applied to each of the tokens passed to this candidate generator.
This filter is applied to the original token before candidates are generated. + /// + /// A filter (analyzer) that is applied to each of the tokens passed to this candidate generator. + /// This filter is applied to the original token before candidates are generated. + /// /// public DirectGeneratorDescriptor PreFilter(string? preFilter) { @@ -413,7 +517,10 @@ public DirectGeneratorDescriptor PreFilter(string? preFilter) } /// - /// The number of minimal prefix characters that must match in order be a candidate suggestions.
Increasing this number improves spellcheck performance. + /// + /// The number of minimal prefix characters that must match in order be a candidate suggestions. + /// Increasing this number improves spellcheck performance. + /// /// public DirectGeneratorDescriptor PrefixLength(int? prefixLength) { @@ -422,7 +529,9 @@ public DirectGeneratorDescriptor PrefixLength(int? prefixLength) } /// - /// The maximum corrections to be returned per suggest text token. + /// + /// The maximum corrections to be returned per suggest text token. + /// /// public DirectGeneratorDescriptor Size(int? size) { @@ -431,7 +540,9 @@ public DirectGeneratorDescriptor Size(int? size) } /// - /// Controls what suggestions are included on the suggestions generated on each shard. + /// + /// Controls what suggestions are included on the suggestions generated on each shard. + /// /// public DirectGeneratorDescriptor SuggestMode(Elastic.Clients.Elasticsearch.Serverless.SuggestMode? suggestMode) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/FieldCollapse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/FieldCollapse.g.cs index 1395c4cb758..a37f32afbc0 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/FieldCollapse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/FieldCollapse.g.cs @@ -33,20 +33,26 @@ public sealed partial class FieldCollapse public Elastic.Clients.Elasticsearch.Serverless.Core.Search.FieldCollapse? Collapse { get; set; } /// - /// The field to collapse the result set on + /// + /// The field to collapse the result set on + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// The number of inner hits and their sort order + /// + /// The number of inner hits and their sort order + /// /// [JsonInclude, JsonPropertyName("inner_hits")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.Core.Search.InnerHits))] public ICollection? InnerHits { get; set; } /// - /// The number of concurrent requests allowed to retrieve the inner_hits per group + /// + /// The number of concurrent requests allowed to retrieve the inner_hits per group + /// /// [JsonInclude, JsonPropertyName("max_concurrent_group_searches")] public int? MaxConcurrentGroupSearches { get; set; } @@ -95,7 +101,9 @@ public FieldCollapseDescriptor Collapse(Action - /// The field to collapse the result set on + /// + /// The field to collapse the result set on + /// /// public FieldCollapseDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -104,7 +112,9 @@ public FieldCollapseDescriptor Field(Elastic.Clients.Elasticsearch.Se } /// - /// The field to collapse the result set on + /// + /// The field to collapse the result set on + /// /// public FieldCollapseDescriptor Field(Expression> field) { @@ -113,7 +123,9 @@ public FieldCollapseDescriptor Field(Expression - /// The field to collapse the result set on + /// + /// The field to collapse the result set on + /// /// public FieldCollapseDescriptor Field(Expression> field) { @@ -122,7 +134,9 @@ public FieldCollapseDescriptor Field(Expression - /// The number of inner hits and their sort order + /// + /// The number of inner hits and their sort order + /// /// public FieldCollapseDescriptor InnerHits(ICollection? innerHits) { @@ -161,7 +175,9 @@ public FieldCollapseDescriptor InnerHits(params Action - /// The number of concurrent requests allowed to retrieve the inner_hits per group + /// + /// The number of concurrent requests allowed to retrieve the inner_hits per group + /// /// public FieldCollapseDescriptor MaxConcurrentGroupSearches(int? maxConcurrentGroupSearches) { @@ -272,7 +288,9 @@ public FieldCollapseDescriptor Collapse(Action - /// The field to collapse the result set on + /// + /// The field to collapse the result set on + /// /// public FieldCollapseDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -281,7 +299,9 @@ public FieldCollapseDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Fi } /// - /// The field to collapse the result set on + /// + /// The field to collapse the result set on + /// /// public FieldCollapseDescriptor Field(Expression> field) { @@ -290,7 +310,9 @@ public FieldCollapseDescriptor Field(Expression - /// The field to collapse the result set on + /// + /// The field to collapse the result set on + /// /// public FieldCollapseDescriptor Field(Expression> field) { @@ -299,7 +321,9 @@ public FieldCollapseDescriptor Field(Expression - /// The number of inner hits and their sort order + /// + /// The number of inner hits and their sort order + /// /// public FieldCollapseDescriptor InnerHits(ICollection? innerHits) { @@ -338,7 +362,9 @@ public FieldCollapseDescriptor InnerHits(params Action - /// The number of concurrent requests allowed to retrieve the inner_hits per group + /// + /// The number of concurrent requests allowed to retrieve the inner_hits per group + /// /// public FieldCollapseDescriptor MaxConcurrentGroupSearches(int? maxConcurrentGroupSearches) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/FieldSuggester.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/FieldSuggester.g.cs index bc4be24578a..c717dbd72ea 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/FieldSuggester.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/FieldSuggester.g.cs @@ -51,19 +51,26 @@ internal FieldSuggester(string variantName, object variant) public static FieldSuggester Term(Elastic.Clients.Elasticsearch.Serverless.Core.Search.TermSuggester termSuggester) => new FieldSuggester("term", termSuggester); /// - /// Prefix used to search for suggestions. + /// + /// Prefix used to search for suggestions. + /// /// [JsonInclude, JsonPropertyName("prefix")] public string? Prefix { get; set; } /// - /// A prefix expressed as a regular expression. + /// + /// A prefix expressed as a regular expression. + /// /// [JsonInclude, JsonPropertyName("regex")] public string? Regex { get; set; } /// - /// The text to use as input for the suggester.
Needs to be set globally or per suggestion. + /// + /// The text to use as input for the suggester. + /// Needs to be set globally or per suggestion. + /// /// [JsonInclude, JsonPropertyName("text")] public string? Text { get; set; } @@ -236,7 +243,9 @@ private FieldSuggesterDescriptor Set(object variant, string variantNa private string? TextValue { get; set; } /// - /// Prefix used to search for suggestions. + /// + /// Prefix used to search for suggestions. + /// /// public FieldSuggesterDescriptor Prefix(string? prefix) { @@ -245,7 +254,9 @@ public FieldSuggesterDescriptor Prefix(string? prefix) } /// - /// A prefix expressed as a regular expression. + /// + /// A prefix expressed as a regular expression. + /// /// public FieldSuggesterDescriptor Regex(string? regex) { @@ -254,7 +265,10 @@ public FieldSuggesterDescriptor Regex(string? regex) } /// - /// The text to use as input for the suggester.
Needs to be set globally or per suggestion. + /// + /// The text to use as input for the suggester. + /// Needs to be set globally or per suggestion. + /// /// public FieldSuggesterDescriptor Text(string? text) { @@ -343,7 +357,9 @@ private FieldSuggesterDescriptor Set(object variant, string variantName) private string? TextValue { get; set; } /// - /// Prefix used to search for suggestions. + /// + /// Prefix used to search for suggestions. + /// /// public FieldSuggesterDescriptor Prefix(string? prefix) { @@ -352,7 +368,9 @@ public FieldSuggesterDescriptor Prefix(string? prefix) } /// - /// A prefix expressed as a regular expression. + /// + /// A prefix expressed as a regular expression. + /// /// public FieldSuggesterDescriptor Regex(string? regex) { @@ -361,7 +379,10 @@ public FieldSuggesterDescriptor Regex(string? regex) } /// - /// The text to use as input for the suggester.
Needs to be set globally or per suggestion. + /// + /// The text to use as input for the suggester. + /// Needs to be set globally or per suggestion. + /// /// public FieldSuggesterDescriptor Text(string? text) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/Highlight.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/Highlight.g.cs index f65bfbeda16..d2ec32f9516 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/Highlight.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/Highlight.g.cs @@ -30,25 +30,36 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.Search; public sealed partial class Highlight { /// - /// A string that contains each boundary character. + /// + /// A string that contains each boundary character. + /// /// [JsonInclude, JsonPropertyName("boundary_chars")] public string? BoundaryChars { get; set; } /// - /// How far to scan for boundary characters. + /// + /// How far to scan for boundary characters. + /// /// [JsonInclude, JsonPropertyName("boundary_max_scan")] public int? BoundaryMaxScan { get; set; } /// - /// Specifies how to break the highlighted fragments: chars, sentence, or word.
Only valid for the unified and fvh highlighters.
Defaults to `sentence` for the `unified` highlighter. Defaults to `chars` for the `fvh` highlighter. + /// + /// Specifies how to break the highlighted fragments: chars, sentence, or word. + /// Only valid for the unified and fvh highlighters. + /// Defaults to sentence for the unified highlighter. Defaults to chars for the fvh highlighter. + /// /// [JsonInclude, JsonPropertyName("boundary_scanner")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.BoundaryScanner? BoundaryScanner { get; set; } /// - /// Controls which locale is used to search for sentence and word boundaries.
This parameter takes a form of a language tag, for example: `"en-US"`, `"fr-FR"`, `"ja-JP"`. + /// + /// Controls which locale is used to search for sentence and word boundaries. + /// This parameter takes a form of a language tag, for example: "en-US", "fr-FR", "ja-JP". + /// /// [JsonInclude, JsonPropertyName("boundary_scanner_locale")] public string? BoundaryScannerLocale { get; set; } @@ -58,13 +69,18 @@ public sealed partial class Highlight public IDictionary Fields { get; set; } /// - /// Specifies how text should be broken up in highlight snippets: `simple` or `span`.
Only valid for the `plain` highlighter. + /// + /// Specifies how text should be broken up in highlight snippets: simple or span. + /// Only valid for the plain highlighter. + /// /// [JsonInclude, JsonPropertyName("fragmenter")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.HighlighterFragmenter? Fragmenter { get; set; } /// - /// The size of the highlighted fragment in characters. + /// + /// The size of the highlighted fragment in characters. + /// /// [JsonInclude, JsonPropertyName("fragment_size")] public int? FragmentSize { get; set; } @@ -72,13 +88,20 @@ public sealed partial class Highlight public bool? HighlightFilter { get; set; } /// - /// Highlight matches for a query other than the search query.
This is especially useful if you use a rescore query because those are not taken into account by highlighting by default. + /// + /// Highlight matches for a query other than the search query. + /// This is especially useful if you use a rescore query because those are not taken into account by highlighting by default. + /// /// [JsonInclude, JsonPropertyName("highlight_query")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? HighlightQuery { get; set; } /// - /// If set to a non-negative value, highlighting stops at this defined maximum limit.
The rest of the text is not processed, thus not highlighted and no error is returned
The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it’s set to lower value than the query setting. + /// + /// If set to a non-negative value, highlighting stops at this defined maximum limit. + /// The rest of the text is not processed, thus not highlighted and no error is returned + /// The max_analyzed_offset query setting does not override the index.highlight.max_analyzed_offset setting, which prevails when it’s set to lower value than the query setting. + /// /// [JsonInclude, JsonPropertyName("max_analyzed_offset")] public int? MaxAnalyzedOffset { get; set; } @@ -86,13 +109,21 @@ public sealed partial class Highlight public int? MaxFragmentLength { get; set; } /// - /// The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. + /// + /// The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. + /// /// [JsonInclude, JsonPropertyName("no_match_size")] public int? NoMatchSize { get; set; } /// - /// The maximum number of fragments to return.
If the number of fragments is set to `0`, no fragments are returned.
Instead, the entire field contents are highlighted and returned.
This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required.
If `number_of_fragments` is `0`, `fragment_size` is ignored. + /// + /// The maximum number of fragments to return. + /// If the number of fragments is set to 0, no fragments are returned. + /// Instead, the entire field contents are highlighted and returned. + /// This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. + /// If number_of_fragments is 0, fragment_size is ignored. + /// /// [JsonInclude, JsonPropertyName("number_of_fragments")] public int? NumberOfFragments { get; set; } @@ -100,37 +131,58 @@ public sealed partial class Highlight public IDictionary? Options { get; set; } /// - /// Sorts highlighted fragments by score when set to `score`.
By default, fragments will be output in the order they appear in the field (order: `none`).
Setting this option to `score` will output the most relevant fragments first.
Each highlighter applies its own logic to compute relevancy scores. + /// + /// Sorts highlighted fragments by score when set to score. + /// By default, fragments will be output in the order they appear in the field (order: none). + /// Setting this option to score will output the most relevant fragments first. + /// Each highlighter applies its own logic to compute relevancy scores. + /// /// [JsonInclude, JsonPropertyName("order")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.HighlighterOrder? Order { get; set; } /// - /// Controls the number of matching phrases in a document that are considered.
Prevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory.
When using `matched_fields`, `phrase_limit` phrases per matched field are considered. Raising the limit increases query time and consumes more memory.
Only supported by the `fvh` highlighter. + /// + /// Controls the number of matching phrases in a document that are considered. + /// Prevents the fvh highlighter from analyzing too many phrases and consuming too much memory. + /// When using matched_fields, phrase_limit phrases per matched field are considered. Raising the limit increases query time and consumes more memory. + /// Only supported by the fvh highlighter. + /// /// [JsonInclude, JsonPropertyName("phrase_limit")] public int? PhraseLimit { get; set; } /// - /// Use in conjunction with `pre_tags` to define the HTML tags to use for the highlighted text.
By default, highlighted text is wrapped in `` and `` tags. + /// + /// Use in conjunction with pre_tags to define the HTML tags to use for the highlighted text. + /// By default, highlighted text is wrapped in <em> and </em> tags. + /// /// [JsonInclude, JsonPropertyName("post_tags")] public ICollection? PostTags { get; set; } /// - /// Use in conjunction with `post_tags` to define the HTML tags to use for the highlighted text.
By default, highlighted text is wrapped in `` and `` tags. + /// + /// Use in conjunction with post_tags to define the HTML tags to use for the highlighted text. + /// By default, highlighted text is wrapped in <em> and </em> tags. + /// /// [JsonInclude, JsonPropertyName("pre_tags")] public ICollection? PreTags { get; set; } /// - /// By default, only fields that contains a query match are highlighted.
Set to `false` to highlight all fields. + /// + /// By default, only fields that contains a query match are highlighted. + /// Set to false to highlight all fields. + /// /// [JsonInclude, JsonPropertyName("require_field_match")] public bool? RequireFieldMatch { get; set; } /// - /// Set to `styled` to use the built-in tag schema. + /// + /// Set to styled to use the built-in tag schema. + /// /// [JsonInclude, JsonPropertyName("tags_schema")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.HighlighterTagsSchema? TagsSchema { get; set; } @@ -172,7 +224,9 @@ public HighlightDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Core.Search.HighlighterType? TypeValue { get; set; } /// - /// A string that contains each boundary character. + /// + /// A string that contains each boundary character. + /// /// public HighlightDescriptor BoundaryChars(string? boundaryChars) { @@ -181,7 +235,9 @@ public HighlightDescriptor BoundaryChars(string? boundaryChars) } /// - /// How far to scan for boundary characters. + /// + /// How far to scan for boundary characters. + /// /// public HighlightDescriptor BoundaryMaxScan(int? boundaryMaxScan) { @@ -190,7 +246,11 @@ public HighlightDescriptor BoundaryMaxScan(int? boundaryMaxScan) } /// - /// Specifies how to break the highlighted fragments: chars, sentence, or word.
Only valid for the unified and fvh highlighters.
Defaults to `sentence` for the `unified` highlighter. Defaults to `chars` for the `fvh` highlighter. + /// + /// Specifies how to break the highlighted fragments: chars, sentence, or word. + /// Only valid for the unified and fvh highlighters. + /// Defaults to sentence for the unified highlighter. Defaults to chars for the fvh highlighter. + /// /// public HighlightDescriptor BoundaryScanner(Elastic.Clients.Elasticsearch.Serverless.Core.Search.BoundaryScanner? boundaryScanner) { @@ -199,7 +259,10 @@ public HighlightDescriptor BoundaryScanner(Elastic.Clients.Elasticsea } /// - /// Controls which locale is used to search for sentence and word boundaries.
This parameter takes a form of a language tag, for example: `"en-US"`, `"fr-FR"`, `"ja-JP"`. + /// + /// Controls which locale is used to search for sentence and word boundaries. + /// This parameter takes a form of a language tag, for example: "en-US", "fr-FR", "ja-JP". + /// /// public HighlightDescriptor BoundaryScannerLocale(string? boundaryScannerLocale) { @@ -220,7 +283,10 @@ public HighlightDescriptor Fields(Func - /// Specifies how text should be broken up in highlight snippets: `simple` or `span`.
Only valid for the `plain` highlighter. + /// + /// Specifies how text should be broken up in highlight snippets: simple or span. + /// Only valid for the plain highlighter. + /// /// public HighlightDescriptor Fragmenter(Elastic.Clients.Elasticsearch.Serverless.Core.Search.HighlighterFragmenter? fragmenter) { @@ -229,7 +295,9 @@ public HighlightDescriptor Fragmenter(Elastic.Clients.Elasticsearch.S } /// - /// The size of the highlighted fragment in characters. + /// + /// The size of the highlighted fragment in characters. + /// /// public HighlightDescriptor FragmentSize(int? fragmentSize) { @@ -244,7 +312,10 @@ public HighlightDescriptor HighlightFilter(bool? highlightFilter = tr } /// - /// Highlight matches for a query other than the search query.
This is especially useful if you use a rescore query because those are not taken into account by highlighting by default. + /// + /// Highlight matches for a query other than the search query. + /// This is especially useful if you use a rescore query because those are not taken into account by highlighting by default. + /// /// public HighlightDescriptor HighlightQuery(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? highlightQuery) { @@ -271,7 +342,11 @@ public HighlightDescriptor HighlightQuery(Action - /// If set to a non-negative value, highlighting stops at this defined maximum limit.
The rest of the text is not processed, thus not highlighted and no error is returned
The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it’s set to lower value than the query setting. + /// + /// If set to a non-negative value, highlighting stops at this defined maximum limit. + /// The rest of the text is not processed, thus not highlighted and no error is returned + /// The max_analyzed_offset query setting does not override the index.highlight.max_analyzed_offset setting, which prevails when it’s set to lower value than the query setting. + /// /// public HighlightDescriptor MaxAnalyzedOffset(int? maxAnalyzedOffset) { @@ -286,7 +361,9 @@ public HighlightDescriptor MaxFragmentLength(int? maxFragmentLength) } /// - /// The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. + /// + /// The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. + /// /// public HighlightDescriptor NoMatchSize(int? noMatchSize) { @@ -295,7 +372,13 @@ public HighlightDescriptor NoMatchSize(int? noMatchSize) } /// - /// The maximum number of fragments to return.
If the number of fragments is set to `0`, no fragments are returned.
Instead, the entire field contents are highlighted and returned.
This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required.
If `number_of_fragments` is `0`, `fragment_size` is ignored. + /// + /// The maximum number of fragments to return. + /// If the number of fragments is set to 0, no fragments are returned. + /// Instead, the entire field contents are highlighted and returned. + /// This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. + /// If number_of_fragments is 0, fragment_size is ignored. + /// /// public HighlightDescriptor NumberOfFragments(int? numberOfFragments) { @@ -310,7 +393,12 @@ public HighlightDescriptor Options(Func - /// Sorts highlighted fragments by score when set to `score`.
By default, fragments will be output in the order they appear in the field (order: `none`).
Setting this option to `score` will output the most relevant fragments first.
Each highlighter applies its own logic to compute relevancy scores. + /// + /// Sorts highlighted fragments by score when set to score. + /// By default, fragments will be output in the order they appear in the field (order: none). + /// Setting this option to score will output the most relevant fragments first. + /// Each highlighter applies its own logic to compute relevancy scores. + /// /// public HighlightDescriptor Order(Elastic.Clients.Elasticsearch.Serverless.Core.Search.HighlighterOrder? order) { @@ -319,7 +407,12 @@ public HighlightDescriptor Order(Elastic.Clients.Elasticsearch.Server } /// - /// Controls the number of matching phrases in a document that are considered.
Prevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory.
When using `matched_fields`, `phrase_limit` phrases per matched field are considered. Raising the limit increases query time and consumes more memory.
Only supported by the `fvh` highlighter. + /// + /// Controls the number of matching phrases in a document that are considered. + /// Prevents the fvh highlighter from analyzing too many phrases and consuming too much memory. + /// When using matched_fields, phrase_limit phrases per matched field are considered. Raising the limit increases query time and consumes more memory. + /// Only supported by the fvh highlighter. + /// /// public HighlightDescriptor PhraseLimit(int? phraseLimit) { @@ -328,7 +421,10 @@ public HighlightDescriptor PhraseLimit(int? phraseLimit) } /// - /// Use in conjunction with `pre_tags` to define the HTML tags to use for the highlighted text.
By default, highlighted text is wrapped in `` and `` tags. + /// + /// Use in conjunction with pre_tags to define the HTML tags to use for the highlighted text. + /// By default, highlighted text is wrapped in <em> and </em> tags. + /// /// public HighlightDescriptor PostTags(ICollection? postTags) { @@ -337,7 +433,10 @@ public HighlightDescriptor PostTags(ICollection? postTags) } /// - /// Use in conjunction with `post_tags` to define the HTML tags to use for the highlighted text.
By default, highlighted text is wrapped in `` and `` tags. + /// + /// Use in conjunction with post_tags to define the HTML tags to use for the highlighted text. + /// By default, highlighted text is wrapped in <em> and </em> tags. + /// /// public HighlightDescriptor PreTags(ICollection? preTags) { @@ -346,7 +445,10 @@ public HighlightDescriptor PreTags(ICollection? preTags) } /// - /// By default, only fields that contains a query match are highlighted.
Set to `false` to highlight all fields. + /// + /// By default, only fields that contains a query match are highlighted. + /// Set to false to highlight all fields. + /// /// public HighlightDescriptor RequireFieldMatch(bool? requireFieldMatch = true) { @@ -355,7 +457,9 @@ public HighlightDescriptor RequireFieldMatch(bool? requireFieldMatch } /// - /// Set to `styled` to use the built-in tag schema. + /// + /// Set to styled to use the built-in tag schema. + /// /// public HighlightDescriptor TagsSchema(Elastic.Clients.Elasticsearch.Serverless.Core.Search.HighlighterTagsSchema? tagsSchema) { @@ -548,7 +652,9 @@ public HighlightDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Core.Search.HighlighterType? TypeValue { get; set; } /// - /// A string that contains each boundary character. + /// + /// A string that contains each boundary character. + /// /// public HighlightDescriptor BoundaryChars(string? boundaryChars) { @@ -557,7 +663,9 @@ public HighlightDescriptor BoundaryChars(string? boundaryChars) } /// - /// How far to scan for boundary characters. + /// + /// How far to scan for boundary characters. + /// /// public HighlightDescriptor BoundaryMaxScan(int? boundaryMaxScan) { @@ -566,7 +674,11 @@ public HighlightDescriptor BoundaryMaxScan(int? boundaryMaxScan) } /// - /// Specifies how to break the highlighted fragments: chars, sentence, or word.
Only valid for the unified and fvh highlighters.
Defaults to `sentence` for the `unified` highlighter. Defaults to `chars` for the `fvh` highlighter. + /// + /// Specifies how to break the highlighted fragments: chars, sentence, or word. + /// Only valid for the unified and fvh highlighters. + /// Defaults to sentence for the unified highlighter. Defaults to chars for the fvh highlighter. + /// /// public HighlightDescriptor BoundaryScanner(Elastic.Clients.Elasticsearch.Serverless.Core.Search.BoundaryScanner? boundaryScanner) { @@ -575,7 +687,10 @@ public HighlightDescriptor BoundaryScanner(Elastic.Clients.Elasticsearch.Serverl } /// - /// Controls which locale is used to search for sentence and word boundaries.
This parameter takes a form of a language tag, for example: `"en-US"`, `"fr-FR"`, `"ja-JP"`. + /// + /// Controls which locale is used to search for sentence and word boundaries. + /// This parameter takes a form of a language tag, for example: "en-US", "fr-FR", "ja-JP". + /// /// public HighlightDescriptor BoundaryScannerLocale(string? boundaryScannerLocale) { @@ -596,7 +711,10 @@ public HighlightDescriptor Fields(Func - /// Specifies how text should be broken up in highlight snippets: `simple` or `span`.
Only valid for the `plain` highlighter. + /// + /// Specifies how text should be broken up in highlight snippets: simple or span. + /// Only valid for the plain highlighter. + /// /// public HighlightDescriptor Fragmenter(Elastic.Clients.Elasticsearch.Serverless.Core.Search.HighlighterFragmenter? fragmenter) { @@ -605,7 +723,9 @@ public HighlightDescriptor Fragmenter(Elastic.Clients.Elasticsearch.Serverless.C } /// - /// The size of the highlighted fragment in characters. + /// + /// The size of the highlighted fragment in characters. + /// /// public HighlightDescriptor FragmentSize(int? fragmentSize) { @@ -620,7 +740,10 @@ public HighlightDescriptor HighlightFilter(bool? highlightFilter = true) } /// - /// Highlight matches for a query other than the search query.
This is especially useful if you use a rescore query because those are not taken into account by highlighting by default. + /// + /// Highlight matches for a query other than the search query. + /// This is especially useful if you use a rescore query because those are not taken into account by highlighting by default. + /// /// public HighlightDescriptor HighlightQuery(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? highlightQuery) { @@ -647,7 +770,11 @@ public HighlightDescriptor HighlightQuery(Action - /// If set to a non-negative value, highlighting stops at this defined maximum limit.
The rest of the text is not processed, thus not highlighted and no error is returned
The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it’s set to lower value than the query setting. + /// + /// If set to a non-negative value, highlighting stops at this defined maximum limit. + /// The rest of the text is not processed, thus not highlighted and no error is returned + /// The max_analyzed_offset query setting does not override the index.highlight.max_analyzed_offset setting, which prevails when it’s set to lower value than the query setting. + /// /// public HighlightDescriptor MaxAnalyzedOffset(int? maxAnalyzedOffset) { @@ -662,7 +789,9 @@ public HighlightDescriptor MaxFragmentLength(int? maxFragmentLength) } /// - /// The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. + /// + /// The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. + /// /// public HighlightDescriptor NoMatchSize(int? noMatchSize) { @@ -671,7 +800,13 @@ public HighlightDescriptor NoMatchSize(int? noMatchSize) } /// - /// The maximum number of fragments to return.
If the number of fragments is set to `0`, no fragments are returned.
Instead, the entire field contents are highlighted and returned.
This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required.
If `number_of_fragments` is `0`, `fragment_size` is ignored. + /// + /// The maximum number of fragments to return. + /// If the number of fragments is set to 0, no fragments are returned. + /// Instead, the entire field contents are highlighted and returned. + /// This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. + /// If number_of_fragments is 0, fragment_size is ignored. + /// /// public HighlightDescriptor NumberOfFragments(int? numberOfFragments) { @@ -686,7 +821,12 @@ public HighlightDescriptor Options(Func, Fluent } /// - /// Sorts highlighted fragments by score when set to `score`.
By default, fragments will be output in the order they appear in the field (order: `none`).
Setting this option to `score` will output the most relevant fragments first.
Each highlighter applies its own logic to compute relevancy scores. + /// + /// Sorts highlighted fragments by score when set to score. + /// By default, fragments will be output in the order they appear in the field (order: none). + /// Setting this option to score will output the most relevant fragments first. + /// Each highlighter applies its own logic to compute relevancy scores. + /// /// public HighlightDescriptor Order(Elastic.Clients.Elasticsearch.Serverless.Core.Search.HighlighterOrder? order) { @@ -695,7 +835,12 @@ public HighlightDescriptor Order(Elastic.Clients.Elasticsearch.Serverless.Core.S } /// - /// Controls the number of matching phrases in a document that are considered.
Prevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory.
When using `matched_fields`, `phrase_limit` phrases per matched field are considered. Raising the limit increases query time and consumes more memory.
Only supported by the `fvh` highlighter. + /// + /// Controls the number of matching phrases in a document that are considered. + /// Prevents the fvh highlighter from analyzing too many phrases and consuming too much memory. + /// When using matched_fields, phrase_limit phrases per matched field are considered. Raising the limit increases query time and consumes more memory. + /// Only supported by the fvh highlighter. + /// /// public HighlightDescriptor PhraseLimit(int? phraseLimit) { @@ -704,7 +849,10 @@ public HighlightDescriptor PhraseLimit(int? phraseLimit) } /// - /// Use in conjunction with `pre_tags` to define the HTML tags to use for the highlighted text.
By default, highlighted text is wrapped in `` and `` tags. + /// + /// Use in conjunction with pre_tags to define the HTML tags to use for the highlighted text. + /// By default, highlighted text is wrapped in <em> and </em> tags. + /// /// public HighlightDescriptor PostTags(ICollection? postTags) { @@ -713,7 +861,10 @@ public HighlightDescriptor PostTags(ICollection? postTags) } /// - /// Use in conjunction with `post_tags` to define the HTML tags to use for the highlighted text.
By default, highlighted text is wrapped in `` and `` tags. + /// + /// Use in conjunction with post_tags to define the HTML tags to use for the highlighted text. + /// By default, highlighted text is wrapped in <em> and </em> tags. + /// /// public HighlightDescriptor PreTags(ICollection? preTags) { @@ -722,7 +873,10 @@ public HighlightDescriptor PreTags(ICollection? preTags) } /// - /// By default, only fields that contains a query match are highlighted.
Set to `false` to highlight all fields. + /// + /// By default, only fields that contains a query match are highlighted. + /// Set to false to highlight all fields. + /// /// public HighlightDescriptor RequireFieldMatch(bool? requireFieldMatch = true) { @@ -731,7 +885,9 @@ public HighlightDescriptor RequireFieldMatch(bool? requireFieldMatch = true) } /// - /// Set to `styled` to use the built-in tag schema. + /// + /// Set to styled to use the built-in tag schema. + /// /// public HighlightDescriptor TagsSchema(Elastic.Clients.Elasticsearch.Serverless.Core.Search.HighlighterTagsSchema? tagsSchema) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/HighlightField.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/HighlightField.g.cs index e66e9ec3777..3dae061b55b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/HighlightField.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/HighlightField.g.cs @@ -33,31 +33,45 @@ public sealed partial class HighlightField public Elastic.Clients.Elasticsearch.Serverless.Analysis.IAnalyzer? Analyzer { get; set; } /// - /// A string that contains each boundary character. + /// + /// A string that contains each boundary character. + /// /// [JsonInclude, JsonPropertyName("boundary_chars")] public string? BoundaryChars { get; set; } /// - /// How far to scan for boundary characters. + /// + /// How far to scan for boundary characters. + /// /// [JsonInclude, JsonPropertyName("boundary_max_scan")] public int? BoundaryMaxScan { get; set; } /// - /// Specifies how to break the highlighted fragments: chars, sentence, or word.
Only valid for the unified and fvh highlighters.
Defaults to `sentence` for the `unified` highlighter. Defaults to `chars` for the `fvh` highlighter. + /// + /// Specifies how to break the highlighted fragments: chars, sentence, or word. + /// Only valid for the unified and fvh highlighters. + /// Defaults to sentence for the unified highlighter. Defaults to chars for the fvh highlighter. + /// /// [JsonInclude, JsonPropertyName("boundary_scanner")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.BoundaryScanner? BoundaryScanner { get; set; } /// - /// Controls which locale is used to search for sentence and word boundaries.
This parameter takes a form of a language tag, for example: `"en-US"`, `"fr-FR"`, `"ja-JP"`. + /// + /// Controls which locale is used to search for sentence and word boundaries. + /// This parameter takes a form of a language tag, for example: "en-US", "fr-FR", "ja-JP". + /// /// [JsonInclude, JsonPropertyName("boundary_scanner_locale")] public string? BoundaryScannerLocale { get; set; } /// - /// Specifies how text should be broken up in highlight snippets: `simple` or `span`.
Only valid for the `plain` highlighter. + /// + /// Specifies how text should be broken up in highlight snippets: simple or span. + /// Only valid for the plain highlighter. + /// /// [JsonInclude, JsonPropertyName("fragmenter")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.HighlighterFragmenter? Fragmenter { get; set; } @@ -65,7 +79,9 @@ public sealed partial class HighlightField public int? FragmentOffset { get; set; } /// - /// The size of the highlighted fragment in characters. + /// + /// The size of the highlighted fragment in characters. + /// /// [JsonInclude, JsonPropertyName("fragment_size")] public int? FragmentSize { get; set; } @@ -73,7 +89,10 @@ public sealed partial class HighlightField public bool? HighlightFilter { get; set; } /// - /// Highlight matches for a query other than the search query.
This is especially useful if you use a rescore query because those are not taken into account by highlighting by default. + /// + /// Highlight matches for a query other than the search query. + /// This is especially useful if you use a rescore query because those are not taken into account by highlighting by default. + /// /// [JsonInclude, JsonPropertyName("highlight_query")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? HighlightQuery { get; set; } @@ -82,7 +101,11 @@ public sealed partial class HighlightField public Elastic.Clients.Elasticsearch.Serverless.Fields? MatchedFields { get; set; } /// - /// If set to a non-negative value, highlighting stops at this defined maximum limit.
The rest of the text is not processed, thus not highlighted and no error is returned
The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it’s set to lower value than the query setting. + /// + /// If set to a non-negative value, highlighting stops at this defined maximum limit. + /// The rest of the text is not processed, thus not highlighted and no error is returned + /// The max_analyzed_offset query setting does not override the index.highlight.max_analyzed_offset setting, which prevails when it’s set to lower value than the query setting. + /// /// [JsonInclude, JsonPropertyName("max_analyzed_offset")] public int? MaxAnalyzedOffset { get; set; } @@ -90,13 +113,21 @@ public sealed partial class HighlightField public int? MaxFragmentLength { get; set; } /// - /// The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. + /// + /// The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. + /// /// [JsonInclude, JsonPropertyName("no_match_size")] public int? NoMatchSize { get; set; } /// - /// The maximum number of fragments to return.
If the number of fragments is set to `0`, no fragments are returned.
Instead, the entire field contents are highlighted and returned.
This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required.
If `number_of_fragments` is `0`, `fragment_size` is ignored. + /// + /// The maximum number of fragments to return. + /// If the number of fragments is set to 0, no fragments are returned. + /// Instead, the entire field contents are highlighted and returned. + /// This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. + /// If number_of_fragments is 0, fragment_size is ignored. + /// /// [JsonInclude, JsonPropertyName("number_of_fragments")] public int? NumberOfFragments { get; set; } @@ -104,37 +135,58 @@ public sealed partial class HighlightField public IDictionary? Options { get; set; } /// - /// Sorts highlighted fragments by score when set to `score`.
By default, fragments will be output in the order they appear in the field (order: `none`).
Setting this option to `score` will output the most relevant fragments first.
Each highlighter applies its own logic to compute relevancy scores. + /// + /// Sorts highlighted fragments by score when set to score. + /// By default, fragments will be output in the order they appear in the field (order: none). + /// Setting this option to score will output the most relevant fragments first. + /// Each highlighter applies its own logic to compute relevancy scores. + /// /// [JsonInclude, JsonPropertyName("order")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.HighlighterOrder? Order { get; set; } /// - /// Controls the number of matching phrases in a document that are considered.
Prevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory.
When using `matched_fields`, `phrase_limit` phrases per matched field are considered. Raising the limit increases query time and consumes more memory.
Only supported by the `fvh` highlighter. + /// + /// Controls the number of matching phrases in a document that are considered. + /// Prevents the fvh highlighter from analyzing too many phrases and consuming too much memory. + /// When using matched_fields, phrase_limit phrases per matched field are considered. Raising the limit increases query time and consumes more memory. + /// Only supported by the fvh highlighter. + /// /// [JsonInclude, JsonPropertyName("phrase_limit")] public int? PhraseLimit { get; set; } /// - /// Use in conjunction with `pre_tags` to define the HTML tags to use for the highlighted text.
By default, highlighted text is wrapped in `` and `` tags. + /// + /// Use in conjunction with pre_tags to define the HTML tags to use for the highlighted text. + /// By default, highlighted text is wrapped in <em> and </em> tags. + /// /// [JsonInclude, JsonPropertyName("post_tags")] public ICollection? PostTags { get; set; } /// - /// Use in conjunction with `post_tags` to define the HTML tags to use for the highlighted text.
By default, highlighted text is wrapped in `` and `` tags. + /// + /// Use in conjunction with post_tags to define the HTML tags to use for the highlighted text. + /// By default, highlighted text is wrapped in <em> and </em> tags. + /// /// [JsonInclude, JsonPropertyName("pre_tags")] public ICollection? PreTags { get; set; } /// - /// By default, only fields that contains a query match are highlighted.
Set to `false` to highlight all fields. + /// + /// By default, only fields that contains a query match are highlighted. + /// Set to false to highlight all fields. + /// /// [JsonInclude, JsonPropertyName("require_field_match")] public bool? RequireFieldMatch { get; set; } /// - /// Set to `styled` to use the built-in tag schema. + /// + /// Set to styled to use the built-in tag schema. + /// /// [JsonInclude, JsonPropertyName("tags_schema")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.HighlighterTagsSchema? TagsSchema { get; set; } @@ -183,7 +235,9 @@ public HighlightFieldDescriptor Analyzer(Elastic.Clients.Elasticsearc } /// - /// A string that contains each boundary character. + /// + /// A string that contains each boundary character. + /// /// public HighlightFieldDescriptor BoundaryChars(string? boundaryChars) { @@ -192,7 +246,9 @@ public HighlightFieldDescriptor BoundaryChars(string? boundaryChars) } /// - /// How far to scan for boundary characters. + /// + /// How far to scan for boundary characters. + /// /// public HighlightFieldDescriptor BoundaryMaxScan(int? boundaryMaxScan) { @@ -201,7 +257,11 @@ public HighlightFieldDescriptor BoundaryMaxScan(int? boundaryMaxScan) } /// - /// Specifies how to break the highlighted fragments: chars, sentence, or word.
Only valid for the unified and fvh highlighters.
Defaults to `sentence` for the `unified` highlighter. Defaults to `chars` for the `fvh` highlighter. + /// + /// Specifies how to break the highlighted fragments: chars, sentence, or word. + /// Only valid for the unified and fvh highlighters. + /// Defaults to sentence for the unified highlighter. Defaults to chars for the fvh highlighter. + /// /// public HighlightFieldDescriptor BoundaryScanner(Elastic.Clients.Elasticsearch.Serverless.Core.Search.BoundaryScanner? boundaryScanner) { @@ -210,7 +270,10 @@ public HighlightFieldDescriptor BoundaryScanner(Elastic.Clients.Elast } /// - /// Controls which locale is used to search for sentence and word boundaries.
This parameter takes a form of a language tag, for example: `"en-US"`, `"fr-FR"`, `"ja-JP"`. + /// + /// Controls which locale is used to search for sentence and word boundaries. + /// This parameter takes a form of a language tag, for example: "en-US", "fr-FR", "ja-JP". + /// /// public HighlightFieldDescriptor BoundaryScannerLocale(string? boundaryScannerLocale) { @@ -219,7 +282,10 @@ public HighlightFieldDescriptor BoundaryScannerLocale(string? boundar } /// - /// Specifies how text should be broken up in highlight snippets: `simple` or `span`.
Only valid for the `plain` highlighter. + /// + /// Specifies how text should be broken up in highlight snippets: simple or span. + /// Only valid for the plain highlighter. + /// /// public HighlightFieldDescriptor Fragmenter(Elastic.Clients.Elasticsearch.Serverless.Core.Search.HighlighterFragmenter? fragmenter) { @@ -234,7 +300,9 @@ public HighlightFieldDescriptor FragmentOffset(int? fragmentOffset) } /// - /// The size of the highlighted fragment in characters. + /// + /// The size of the highlighted fragment in characters. + /// /// public HighlightFieldDescriptor FragmentSize(int? fragmentSize) { @@ -249,7 +317,10 @@ public HighlightFieldDescriptor HighlightFilter(bool? highlightFilter } /// - /// Highlight matches for a query other than the search query.
This is especially useful if you use a rescore query because those are not taken into account by highlighting by default. + /// + /// Highlight matches for a query other than the search query. + /// This is especially useful if you use a rescore query because those are not taken into account by highlighting by default. + /// /// public HighlightFieldDescriptor HighlightQuery(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? highlightQuery) { @@ -282,7 +353,11 @@ public HighlightFieldDescriptor MatchedFields(Elastic.Clients.Elastic } /// - /// If set to a non-negative value, highlighting stops at this defined maximum limit.
The rest of the text is not processed, thus not highlighted and no error is returned
The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it’s set to lower value than the query setting. + /// + /// If set to a non-negative value, highlighting stops at this defined maximum limit. + /// The rest of the text is not processed, thus not highlighted and no error is returned + /// The max_analyzed_offset query setting does not override the index.highlight.max_analyzed_offset setting, which prevails when it’s set to lower value than the query setting. + /// /// public HighlightFieldDescriptor MaxAnalyzedOffset(int? maxAnalyzedOffset) { @@ -297,7 +372,9 @@ public HighlightFieldDescriptor MaxFragmentLength(int? maxFragmentLen } /// - /// The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. + /// + /// The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. + /// /// public HighlightFieldDescriptor NoMatchSize(int? noMatchSize) { @@ -306,7 +383,13 @@ public HighlightFieldDescriptor NoMatchSize(int? noMatchSize) } /// - /// The maximum number of fragments to return.
If the number of fragments is set to `0`, no fragments are returned.
Instead, the entire field contents are highlighted and returned.
This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required.
If `number_of_fragments` is `0`, `fragment_size` is ignored. + /// + /// The maximum number of fragments to return. + /// If the number of fragments is set to 0, no fragments are returned. + /// Instead, the entire field contents are highlighted and returned. + /// This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. + /// If number_of_fragments is 0, fragment_size is ignored. + /// /// public HighlightFieldDescriptor NumberOfFragments(int? numberOfFragments) { @@ -321,7 +404,12 @@ public HighlightFieldDescriptor Options(Func - /// Sorts highlighted fragments by score when set to `score`.
By default, fragments will be output in the order they appear in the field (order: `none`).
Setting this option to `score` will output the most relevant fragments first.
Each highlighter applies its own logic to compute relevancy scores. + /// + /// Sorts highlighted fragments by score when set to score. + /// By default, fragments will be output in the order they appear in the field (order: none). + /// Setting this option to score will output the most relevant fragments first. + /// Each highlighter applies its own logic to compute relevancy scores. + /// /// public HighlightFieldDescriptor Order(Elastic.Clients.Elasticsearch.Serverless.Core.Search.HighlighterOrder? order) { @@ -330,7 +418,12 @@ public HighlightFieldDescriptor Order(Elastic.Clients.Elasticsearch.S } /// - /// Controls the number of matching phrases in a document that are considered.
Prevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory.
When using `matched_fields`, `phrase_limit` phrases per matched field are considered. Raising the limit increases query time and consumes more memory.
Only supported by the `fvh` highlighter. + /// + /// Controls the number of matching phrases in a document that are considered. + /// Prevents the fvh highlighter from analyzing too many phrases and consuming too much memory. + /// When using matched_fields, phrase_limit phrases per matched field are considered. Raising the limit increases query time and consumes more memory. + /// Only supported by the fvh highlighter. + /// /// public HighlightFieldDescriptor PhraseLimit(int? phraseLimit) { @@ -339,7 +432,10 @@ public HighlightFieldDescriptor PhraseLimit(int? phraseLimit) } /// - /// Use in conjunction with `pre_tags` to define the HTML tags to use for the highlighted text.
By default, highlighted text is wrapped in `` and `` tags. + /// + /// Use in conjunction with pre_tags to define the HTML tags to use for the highlighted text. + /// By default, highlighted text is wrapped in <em> and </em> tags. + /// /// public HighlightFieldDescriptor PostTags(ICollection? postTags) { @@ -348,7 +444,10 @@ public HighlightFieldDescriptor PostTags(ICollection? postTag } /// - /// Use in conjunction with `post_tags` to define the HTML tags to use for the highlighted text.
By default, highlighted text is wrapped in `` and `` tags. + /// + /// Use in conjunction with post_tags to define the HTML tags to use for the highlighted text. + /// By default, highlighted text is wrapped in <em> and </em> tags. + /// /// public HighlightFieldDescriptor PreTags(ICollection? preTags) { @@ -357,7 +456,10 @@ public HighlightFieldDescriptor PreTags(ICollection? preTags) } /// - /// By default, only fields that contains a query match are highlighted.
Set to `false` to highlight all fields. + /// + /// By default, only fields that contains a query match are highlighted. + /// Set to false to highlight all fields. + /// /// public HighlightFieldDescriptor RequireFieldMatch(bool? requireFieldMatch = true) { @@ -366,7 +468,9 @@ public HighlightFieldDescriptor RequireFieldMatch(bool? requireFieldM } /// - /// Set to `styled` to use the built-in tag schema. + /// + /// Set to styled to use the built-in tag schema. + /// /// public HighlightFieldDescriptor TagsSchema(Elastic.Clients.Elasticsearch.Serverless.Core.Search.HighlighterTagsSchema? tagsSchema) { @@ -576,7 +680,9 @@ public HighlightFieldDescriptor Analyzer(Elastic.Clients.Elasticsearch.Serverles } /// - /// A string that contains each boundary character. + /// + /// A string that contains each boundary character. + /// /// public HighlightFieldDescriptor BoundaryChars(string? boundaryChars) { @@ -585,7 +691,9 @@ public HighlightFieldDescriptor BoundaryChars(string? boundaryChars) } /// - /// How far to scan for boundary characters. + /// + /// How far to scan for boundary characters. + /// /// public HighlightFieldDescriptor BoundaryMaxScan(int? boundaryMaxScan) { @@ -594,7 +702,11 @@ public HighlightFieldDescriptor BoundaryMaxScan(int? boundaryMaxScan) } /// - /// Specifies how to break the highlighted fragments: chars, sentence, or word.
Only valid for the unified and fvh highlighters.
Defaults to `sentence` for the `unified` highlighter. Defaults to `chars` for the `fvh` highlighter. + /// + /// Specifies how to break the highlighted fragments: chars, sentence, or word. + /// Only valid for the unified and fvh highlighters. + /// Defaults to sentence for the unified highlighter. Defaults to chars for the fvh highlighter. + /// /// public HighlightFieldDescriptor BoundaryScanner(Elastic.Clients.Elasticsearch.Serverless.Core.Search.BoundaryScanner? boundaryScanner) { @@ -603,7 +715,10 @@ public HighlightFieldDescriptor BoundaryScanner(Elastic.Clients.Elasticsearch.Se } /// - /// Controls which locale is used to search for sentence and word boundaries.
This parameter takes a form of a language tag, for example: `"en-US"`, `"fr-FR"`, `"ja-JP"`. + /// + /// Controls which locale is used to search for sentence and word boundaries. + /// This parameter takes a form of a language tag, for example: "en-US", "fr-FR", "ja-JP". + /// /// public HighlightFieldDescriptor BoundaryScannerLocale(string? boundaryScannerLocale) { @@ -612,7 +727,10 @@ public HighlightFieldDescriptor BoundaryScannerLocale(string? boundaryScannerLoc } /// - /// Specifies how text should be broken up in highlight snippets: `simple` or `span`.
Only valid for the `plain` highlighter. + /// + /// Specifies how text should be broken up in highlight snippets: simple or span. + /// Only valid for the plain highlighter. + /// /// public HighlightFieldDescriptor Fragmenter(Elastic.Clients.Elasticsearch.Serverless.Core.Search.HighlighterFragmenter? fragmenter) { @@ -627,7 +745,9 @@ public HighlightFieldDescriptor FragmentOffset(int? fragmentOffset) } /// - /// The size of the highlighted fragment in characters. + /// + /// The size of the highlighted fragment in characters. + /// /// public HighlightFieldDescriptor FragmentSize(int? fragmentSize) { @@ -642,7 +762,10 @@ public HighlightFieldDescriptor HighlightFilter(bool? highlightFilter = true) } /// - /// Highlight matches for a query other than the search query.
This is especially useful if you use a rescore query because those are not taken into account by highlighting by default. + /// + /// Highlight matches for a query other than the search query. + /// This is especially useful if you use a rescore query because those are not taken into account by highlighting by default. + /// /// public HighlightFieldDescriptor HighlightQuery(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? highlightQuery) { @@ -675,7 +798,11 @@ public HighlightFieldDescriptor MatchedFields(Elastic.Clients.Elasticsearch.Serv } /// - /// If set to a non-negative value, highlighting stops at this defined maximum limit.
The rest of the text is not processed, thus not highlighted and no error is returned
The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it’s set to lower value than the query setting. + /// + /// If set to a non-negative value, highlighting stops at this defined maximum limit. + /// The rest of the text is not processed, thus not highlighted and no error is returned + /// The max_analyzed_offset query setting does not override the index.highlight.max_analyzed_offset setting, which prevails when it’s set to lower value than the query setting. + /// /// public HighlightFieldDescriptor MaxAnalyzedOffset(int? maxAnalyzedOffset) { @@ -690,7 +817,9 @@ public HighlightFieldDescriptor MaxFragmentLength(int? maxFragmentLength) } /// - /// The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. + /// + /// The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. + /// /// public HighlightFieldDescriptor NoMatchSize(int? noMatchSize) { @@ -699,7 +828,13 @@ public HighlightFieldDescriptor NoMatchSize(int? noMatchSize) } /// - /// The maximum number of fragments to return.
If the number of fragments is set to `0`, no fragments are returned.
Instead, the entire field contents are highlighted and returned.
This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required.
If `number_of_fragments` is `0`, `fragment_size` is ignored. + /// + /// The maximum number of fragments to return. + /// If the number of fragments is set to 0, no fragments are returned. + /// Instead, the entire field contents are highlighted and returned. + /// This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. + /// If number_of_fragments is 0, fragment_size is ignored. + /// /// public HighlightFieldDescriptor NumberOfFragments(int? numberOfFragments) { @@ -714,7 +849,12 @@ public HighlightFieldDescriptor Options(Func, F } /// - /// Sorts highlighted fragments by score when set to `score`.
By default, fragments will be output in the order they appear in the field (order: `none`).
Setting this option to `score` will output the most relevant fragments first.
Each highlighter applies its own logic to compute relevancy scores. + /// + /// Sorts highlighted fragments by score when set to score. + /// By default, fragments will be output in the order they appear in the field (order: none). + /// Setting this option to score will output the most relevant fragments first. + /// Each highlighter applies its own logic to compute relevancy scores. + /// /// public HighlightFieldDescriptor Order(Elastic.Clients.Elasticsearch.Serverless.Core.Search.HighlighterOrder? order) { @@ -723,7 +863,12 @@ public HighlightFieldDescriptor Order(Elastic.Clients.Elasticsearch.Serverless.C } /// - /// Controls the number of matching phrases in a document that are considered.
Prevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory.
When using `matched_fields`, `phrase_limit` phrases per matched field are considered. Raising the limit increases query time and consumes more memory.
Only supported by the `fvh` highlighter. + /// + /// Controls the number of matching phrases in a document that are considered. + /// Prevents the fvh highlighter from analyzing too many phrases and consuming too much memory. + /// When using matched_fields, phrase_limit phrases per matched field are considered. Raising the limit increases query time and consumes more memory. + /// Only supported by the fvh highlighter. + /// /// public HighlightFieldDescriptor PhraseLimit(int? phraseLimit) { @@ -732,7 +877,10 @@ public HighlightFieldDescriptor PhraseLimit(int? phraseLimit) } /// - /// Use in conjunction with `pre_tags` to define the HTML tags to use for the highlighted text.
By default, highlighted text is wrapped in `` and `` tags. + /// + /// Use in conjunction with pre_tags to define the HTML tags to use for the highlighted text. + /// By default, highlighted text is wrapped in <em> and </em> tags. + /// /// public HighlightFieldDescriptor PostTags(ICollection? postTags) { @@ -741,7 +889,10 @@ public HighlightFieldDescriptor PostTags(ICollection? postTags) } /// - /// Use in conjunction with `post_tags` to define the HTML tags to use for the highlighted text.
By default, highlighted text is wrapped in `` and `` tags. + /// + /// Use in conjunction with post_tags to define the HTML tags to use for the highlighted text. + /// By default, highlighted text is wrapped in <em> and </em> tags. + /// /// public HighlightFieldDescriptor PreTags(ICollection? preTags) { @@ -750,7 +901,10 @@ public HighlightFieldDescriptor PreTags(ICollection? preTags) } /// - /// By default, only fields that contains a query match are highlighted.
Set to `false` to highlight all fields. + /// + /// By default, only fields that contains a query match are highlighted. + /// Set to false to highlight all fields. + /// /// public HighlightFieldDescriptor RequireFieldMatch(bool? requireFieldMatch = true) { @@ -759,7 +913,9 @@ public HighlightFieldDescriptor RequireFieldMatch(bool? requireFieldMatch = true } /// - /// Set to `styled` to use the built-in tag schema. + /// + /// Set to styled to use the built-in tag schema. + /// /// public HighlightFieldDescriptor TagsSchema(Elastic.Clients.Elasticsearch.Serverless.Core.Search.HighlighterTagsSchema? tagsSchema) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/HitsMetadata.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/HitsMetadata.g.cs index 3db872977d3..badae00d49b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/HitsMetadata.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/HitsMetadata.g.cs @@ -35,7 +35,9 @@ public sealed partial class HitsMetadata public double? MaxScore { get; init; } /// - /// Total hit count information, present only if `track_total_hits` wasn't `false` in the search request. + /// + /// Total hit count information, present only if track_total_hits wasn't false in the search request. + /// /// [JsonInclude, JsonPropertyName("total")] public Union? Total { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/InnerHits.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/InnerHits.g.cs index 7e668521777..614deb15cec 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/InnerHits.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/InnerHits.g.cs @@ -40,7 +40,9 @@ public sealed partial class InnerHits public Elastic.Clients.Elasticsearch.Serverless.Fields? Fields { get; set; } /// - /// Inner hit starting document offset. + /// + /// Inner hit starting document offset. + /// /// [JsonInclude, JsonPropertyName("from")] public int? From { get; set; } @@ -50,7 +52,10 @@ public sealed partial class InnerHits public bool? IgnoreUnmapped { get; set; } /// - /// The name for the particular inner hit definition in the response.
Useful when a search request contains multiple inner hits. + /// + /// The name for the particular inner hit definition in the response. + /// Useful when a search request contains multiple inner hits. + /// /// [JsonInclude, JsonPropertyName("name")] public Elastic.Clients.Elasticsearch.Serverless.Name? Name { get; set; } @@ -60,13 +65,18 @@ public sealed partial class InnerHits public bool? SeqNoPrimaryTerm { get; set; } /// - /// The maximum number of hits to return per `inner_hits`. + /// + /// The maximum number of hits to return per inner_hits. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// How the inner hits should be sorted per `inner_hits`.
By default, inner hits are sorted by score. + /// + /// How the inner hits should be sorted per inner_hits. + /// By default, inner hits are sorted by score. + /// /// [JsonInclude, JsonPropertyName("sort")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.SortOptions))] @@ -190,7 +200,9 @@ public InnerHitsDescriptor Fields(Elastic.Clients.Elasticsearch.Serve } /// - /// Inner hit starting document offset. + /// + /// Inner hit starting document offset. + /// /// public InnerHitsDescriptor From(int? from) { @@ -229,7 +241,10 @@ public InnerHitsDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true } /// - /// The name for the particular inner hit definition in the response.
Useful when a search request contains multiple inner hits. + /// + /// The name for the particular inner hit definition in the response. + /// Useful when a search request contains multiple inner hits. + /// /// public InnerHitsDescriptor Name(Elastic.Clients.Elasticsearch.Serverless.Name? name) { @@ -250,7 +265,9 @@ public InnerHitsDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = } /// - /// The maximum number of hits to return per `inner_hits`. + /// + /// The maximum number of hits to return per inner_hits. + /// /// public InnerHitsDescriptor Size(int? size) { @@ -259,7 +276,10 @@ public InnerHitsDescriptor Size(int? size) } /// - /// How the inner hits should be sorted per `inner_hits`.
By default, inner hits are sorted by score. + /// + /// How the inner hits should be sorted per inner_hits. + /// By default, inner hits are sorted by score. + /// /// public InnerHitsDescriptor Sort(ICollection? sort) { @@ -600,7 +620,9 @@ public InnerHitsDescriptor Fields(Elastic.Clients.Elasticsearch.Serverless.Field } /// - /// Inner hit starting document offset. + /// + /// Inner hit starting document offset. + /// /// public InnerHitsDescriptor From(int? from) { @@ -639,7 +661,10 @@ public InnerHitsDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) } /// - /// The name for the particular inner hit definition in the response.
Useful when a search request contains multiple inner hits. + /// + /// The name for the particular inner hit definition in the response. + /// Useful when a search request contains multiple inner hits. + /// /// public InnerHitsDescriptor Name(Elastic.Clients.Elasticsearch.Serverless.Name? name) { @@ -660,7 +685,9 @@ public InnerHitsDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = true) } /// - /// The maximum number of hits to return per `inner_hits`. + /// + /// The maximum number of hits to return per inner_hits. + /// /// public InnerHitsDescriptor Size(int? size) { @@ -669,7 +696,10 @@ public InnerHitsDescriptor Size(int? size) } /// - /// How the inner hits should be sorted per `inner_hits`.
By default, inner hits are sorted by score. + /// + /// How the inner hits should be sorted per inner_hits. + /// By default, inner hits are sorted by score. + /// /// public InnerHitsDescriptor Sort(ICollection? sort) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/LaplaceSmoothingModel.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/LaplaceSmoothingModel.g.cs index 5126e3c183e..c89fbee6e53 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/LaplaceSmoothingModel.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/LaplaceSmoothingModel.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.Search; public sealed partial class LaplaceSmoothingModel { /// - /// A constant that is added to all counts to balance weights. + /// + /// A constant that is added to all counts to balance weights. + /// /// [JsonInclude, JsonPropertyName("alpha")] public double Alpha { get; set; } @@ -49,7 +51,9 @@ public LaplaceSmoothingModelDescriptor() : base() private double AlphaValue { get; set; } /// - /// A constant that is added to all counts to balance weights. + /// + /// A constant that is added to all counts to balance weights. + /// /// public LaplaceSmoothingModelDescriptor Alpha(double alpha) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/LearningToRank.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/LearningToRank.g.cs index 1d557ddb6c1..154c9261fe6 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/LearningToRank.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/LearningToRank.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.Search; public sealed partial class LearningToRank { /// - /// The unique identifier of the trained model uploaded to Elasticsearch + /// + /// The unique identifier of the trained model uploaded to Elasticsearch + /// /// [JsonInclude, JsonPropertyName("model_id")] public string ModelId { get; set; } /// - /// Named parameters to be passed to the query templates used for feature + /// + /// Named parameters to be passed to the query templates used for feature + /// /// [JsonInclude, JsonPropertyName("params")] public IDictionary? Params { get; set; } @@ -56,7 +60,9 @@ public LearningToRankDescriptor() : base() private IDictionary? ParamsValue { get; set; } /// - /// The unique identifier of the trained model uploaded to Elasticsearch + /// + /// The unique identifier of the trained model uploaded to Elasticsearch + /// /// public LearningToRankDescriptor ModelId(string modelId) { @@ -65,7 +71,9 @@ public LearningToRankDescriptor ModelId(string modelId) } /// - /// Named parameters to be passed to the query templates used for feature + /// + /// Named parameters to be passed to the query templates used for feature + /// /// public LearningToRankDescriptor Params(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/PhraseSuggestCollate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/PhraseSuggestCollate.g.cs index 60b52542830..bb29dcc85cb 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/PhraseSuggestCollate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/PhraseSuggestCollate.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.Search; public sealed partial class PhraseSuggestCollate { /// - /// Parameters to use if the query is templated. + /// + /// Parameters to use if the query is templated. + /// /// [JsonInclude, JsonPropertyName("params")] public IDictionary? Params { get; set; } /// - /// Returns all suggestions with an extra `collate_match` option indicating whether the generated phrase matched any document. + /// + /// Returns all suggestions with an extra collate_match option indicating whether the generated phrase matched any document. + /// /// [JsonInclude, JsonPropertyName("prune")] public bool? Prune { get; set; } /// - /// A collate query that is run once for every suggestion. + /// + /// A collate query that is run once for every suggestion. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.PhraseSuggestCollateQuery Query { get; set; } @@ -63,7 +69,9 @@ public PhraseSuggestCollateDescriptor() : base() private Action QueryDescriptorAction { get; set; } /// - /// Parameters to use if the query is templated. + /// + /// Parameters to use if the query is templated. + /// /// public PhraseSuggestCollateDescriptor Params(Func, FluentDictionary> selector) { @@ -72,7 +80,9 @@ public PhraseSuggestCollateDescriptor Params(Func - /// Returns all suggestions with an extra `collate_match` option indicating whether the generated phrase matched any document. + /// + /// Returns all suggestions with an extra collate_match option indicating whether the generated phrase matched any document. + /// /// public PhraseSuggestCollateDescriptor Prune(bool? prune = true) { @@ -81,7 +91,9 @@ public PhraseSuggestCollateDescriptor Prune(bool? prune = true) } /// - /// A collate query that is run once for every suggestion. + /// + /// A collate query that is run once for every suggestion. + /// /// public PhraseSuggestCollateDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.Core.Search.PhraseSuggestCollateQuery query) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/PhraseSuggestCollateQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/PhraseSuggestCollateQuery.g.cs index e9a9adc0d1f..1599d255669 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/PhraseSuggestCollateQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/PhraseSuggestCollateQuery.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.Search; public sealed partial class PhraseSuggestCollateQuery { /// - /// The search template ID. + /// + /// The search template ID. + /// /// [JsonInclude, JsonPropertyName("id")] public Elastic.Clients.Elasticsearch.Serverless.Id? Id { get; set; } /// - /// The query source. + /// + /// The query source. + /// /// [JsonInclude, JsonPropertyName("source")] public string? Source { get; set; } @@ -54,7 +58,9 @@ public PhraseSuggestCollateQueryDescriptor() : base() private string? SourceValue { get; set; } /// - /// The search template ID. + /// + /// The search template ID. + /// /// public PhraseSuggestCollateQueryDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id? id) { @@ -63,7 +69,9 @@ public PhraseSuggestCollateQueryDescriptor Id(Elastic.Clients.Elasticsearch.Serv } /// - /// The query source. + /// + /// The query source. + /// /// public PhraseSuggestCollateQueryDescriptor Source(string? source) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/PhraseSuggestHighlight.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/PhraseSuggestHighlight.g.cs index e5389e9d768..5ef60bc95f0 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/PhraseSuggestHighlight.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/PhraseSuggestHighlight.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.Search; public sealed partial class PhraseSuggestHighlight { /// - /// Use in conjunction with `pre_tag` to define the HTML tags to use for the highlighted text. + /// + /// Use in conjunction with pre_tag to define the HTML tags to use for the highlighted text. + /// /// [JsonInclude, JsonPropertyName("post_tag")] public string PostTag { get; set; } /// - /// Use in conjunction with `post_tag` to define the HTML tags to use for the highlighted text. + /// + /// Use in conjunction with post_tag to define the HTML tags to use for the highlighted text. + /// /// [JsonInclude, JsonPropertyName("pre_tag")] public string PreTag { get; set; } @@ -54,7 +58,9 @@ public PhraseSuggestHighlightDescriptor() : base() private string PreTagValue { get; set; } /// - /// Use in conjunction with `pre_tag` to define the HTML tags to use for the highlighted text. + /// + /// Use in conjunction with pre_tag to define the HTML tags to use for the highlighted text. + /// /// public PhraseSuggestHighlightDescriptor PostTag(string postTag) { @@ -63,7 +69,9 @@ public PhraseSuggestHighlightDescriptor PostTag(string postTag) } /// - /// Use in conjunction with `post_tag` to define the HTML tags to use for the highlighted text. + /// + /// Use in conjunction with post_tag to define the HTML tags to use for the highlighted text. + /// /// public PhraseSuggestHighlightDescriptor PreTag(string preTag) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/PhraseSuggester.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/PhraseSuggester.g.cs index 448e1a0158a..b00426bafee 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/PhraseSuggester.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/PhraseSuggester.g.cs @@ -30,31 +30,44 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.Search; public sealed partial class PhraseSuggester { /// - /// The analyzer to analyze the suggest text with.
Defaults to the search analyzer of the suggest field. + /// + /// The analyzer to analyze the suggest text with. + /// Defaults to the search analyzer of the suggest field. + /// /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } /// - /// Checks each suggestion against the specified query to prune suggestions for which no matching docs exist in the index. + /// + /// Checks each suggestion against the specified query to prune suggestions for which no matching docs exist in the index. + /// /// [JsonInclude, JsonPropertyName("collate")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.PhraseSuggestCollate? Collate { get; set; } /// - /// Defines a factor applied to the input phrases score, which is used as a threshold for other suggest candidates.
Only candidates that score higher than the threshold will be included in the result. + /// + /// Defines a factor applied to the input phrases score, which is used as a threshold for other suggest candidates. + /// Only candidates that score higher than the threshold will be included in the result. + /// /// [JsonInclude, JsonPropertyName("confidence")] public double? Confidence { get; set; } /// - /// A list of candidate generators that produce a list of possible terms per term in the given text. + /// + /// A list of candidate generators that produce a list of possible terms per term in the given text. + /// /// [JsonInclude, JsonPropertyName("direct_generator")] public ICollection? DirectGenerator { get; set; } /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } @@ -62,55 +75,79 @@ public sealed partial class PhraseSuggester public bool? ForceUnigrams { get; set; } /// - /// Sets max size of the n-grams (shingles) in the field.
If the field doesn’t contain n-grams (shingles), this should be omitted or set to `1`.
If the field uses a shingle filter, the `gram_size` is set to the `max_shingle_size` if not explicitly set. + /// + /// Sets max size of the n-grams (shingles) in the field. + /// If the field doesn’t contain n-grams (shingles), this should be omitted or set to 1. + /// If the field uses a shingle filter, the gram_size is set to the max_shingle_size if not explicitly set. + /// /// [JsonInclude, JsonPropertyName("gram_size")] public int? GramSize { get; set; } /// - /// Sets up suggestion highlighting.
If not provided, no highlighted field is returned. + /// + /// Sets up suggestion highlighting. + /// If not provided, no highlighted field is returned. + /// /// [JsonInclude, JsonPropertyName("highlight")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.PhraseSuggestHighlight? Highlight { get; set; } /// - /// The maximum percentage of the terms considered to be misspellings in order to form a correction.
This method accepts a float value in the range `[0..1)` as a fraction of the actual query terms or a number `>=1` as an absolute number of query terms. + /// + /// The maximum percentage of the terms considered to be misspellings in order to form a correction. + /// This method accepts a float value in the range [0..1) as a fraction of the actual query terms or a number >=1 as an absolute number of query terms. + /// /// [JsonInclude, JsonPropertyName("max_errors")] public double? MaxErrors { get; set; } /// - /// The likelihood of a term being misspelled even if the term exists in the dictionary. + /// + /// The likelihood of a term being misspelled even if the term exists in the dictionary. + /// /// [JsonInclude, JsonPropertyName("real_word_error_likelihood")] public double? RealWordErrorLikelihood { get; set; } /// - /// The separator that is used to separate terms in the bigram field.
If not set, the whitespace character is used as a separator. + /// + /// The separator that is used to separate terms in the bigram field. + /// If not set, the whitespace character is used as a separator. + /// /// [JsonInclude, JsonPropertyName("separator")] public string? Separator { get; set; } /// - /// Sets the maximum number of suggested terms to be retrieved from each individual shard. + /// + /// Sets the maximum number of suggested terms to be retrieved from each individual shard. + /// /// [JsonInclude, JsonPropertyName("shard_size")] public int? ShardSize { get; set; } /// - /// The maximum corrections to be returned per suggest text token. + /// + /// The maximum corrections to be returned per suggest text token. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// The smoothing model used to balance weight between infrequent grams (grams (shingles) are not existing in the index) and frequent grams (appear at least once in the index).
The default model is Stupid Backoff. + /// + /// The smoothing model used to balance weight between infrequent grams (grams (shingles) are not existing in the index) and frequent grams (appear at least once in the index). + /// The default model is Stupid Backoff. + /// /// [JsonInclude, JsonPropertyName("smoothing")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.SmoothingModel? Smoothing { get; set; } /// - /// The text/query to provide suggestions for. + /// + /// The text/query to provide suggestions for. + /// /// [JsonInclude, JsonPropertyName("text")] public string? Text { get; set; } @@ -155,7 +192,10 @@ public PhraseSuggesterDescriptor() : base() private int? TokenLimitValue { get; set; } /// - /// The analyzer to analyze the suggest text with.
Defaults to the search analyzer of the suggest field. + /// + /// The analyzer to analyze the suggest text with. + /// Defaults to the search analyzer of the suggest field. + /// /// public PhraseSuggesterDescriptor Analyzer(string? analyzer) { @@ -164,7 +204,9 @@ public PhraseSuggesterDescriptor Analyzer(string? analyzer) } /// - /// Checks each suggestion against the specified query to prune suggestions for which no matching docs exist in the index. + /// + /// Checks each suggestion against the specified query to prune suggestions for which no matching docs exist in the index. + /// /// public PhraseSuggesterDescriptor Collate(Elastic.Clients.Elasticsearch.Serverless.Core.Search.PhraseSuggestCollate? collate) { @@ -191,7 +233,10 @@ public PhraseSuggesterDescriptor Collate(Action - /// Defines a factor applied to the input phrases score, which is used as a threshold for other suggest candidates.
Only candidates that score higher than the threshold will be included in the result. + /// + /// Defines a factor applied to the input phrases score, which is used as a threshold for other suggest candidates. + /// Only candidates that score higher than the threshold will be included in the result. + /// /// public PhraseSuggesterDescriptor Confidence(double? confidence) { @@ -200,7 +245,9 @@ public PhraseSuggesterDescriptor Confidence(double? confidence) } /// - /// A list of candidate generators that produce a list of possible terms per term in the given text. + /// + /// A list of candidate generators that produce a list of possible terms per term in the given text. + /// /// public PhraseSuggesterDescriptor DirectGenerator(ICollection? directGenerator) { @@ -239,7 +286,10 @@ public PhraseSuggesterDescriptor DirectGenerator(params Action - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public PhraseSuggesterDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -248,7 +298,10 @@ public PhraseSuggesterDescriptor Field(Elastic.Clients.Elasticsearch. } /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public PhraseSuggesterDescriptor Field(Expression> field) { @@ -257,7 +310,10 @@ public PhraseSuggesterDescriptor Field(Expression - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public PhraseSuggesterDescriptor Field(Expression> field) { @@ -272,7 +328,11 @@ public PhraseSuggesterDescriptor ForceUnigrams(bool? forceUnigrams = } /// - /// Sets max size of the n-grams (shingles) in the field.
If the field doesn’t contain n-grams (shingles), this should be omitted or set to `1`.
If the field uses a shingle filter, the `gram_size` is set to the `max_shingle_size` if not explicitly set. + /// + /// Sets max size of the n-grams (shingles) in the field. + /// If the field doesn’t contain n-grams (shingles), this should be omitted or set to 1. + /// If the field uses a shingle filter, the gram_size is set to the max_shingle_size if not explicitly set. + /// /// public PhraseSuggesterDescriptor GramSize(int? gramSize) { @@ -281,7 +341,10 @@ public PhraseSuggesterDescriptor GramSize(int? gramSize) } /// - /// Sets up suggestion highlighting.
If not provided, no highlighted field is returned. + /// + /// Sets up suggestion highlighting. + /// If not provided, no highlighted field is returned. + /// /// public PhraseSuggesterDescriptor Highlight(Elastic.Clients.Elasticsearch.Serverless.Core.Search.PhraseSuggestHighlight? highlight) { @@ -308,7 +371,10 @@ public PhraseSuggesterDescriptor Highlight(Action - /// The maximum percentage of the terms considered to be misspellings in order to form a correction.
This method accepts a float value in the range `[0..1)` as a fraction of the actual query terms or a number `>=1` as an absolute number of query terms. + /// + /// The maximum percentage of the terms considered to be misspellings in order to form a correction. + /// This method accepts a float value in the range [0..1) as a fraction of the actual query terms or a number >=1 as an absolute number of query terms. + /// /// public PhraseSuggesterDescriptor MaxErrors(double? maxErrors) { @@ -317,7 +383,9 @@ public PhraseSuggesterDescriptor MaxErrors(double? maxErrors) } /// - /// The likelihood of a term being misspelled even if the term exists in the dictionary. + /// + /// The likelihood of a term being misspelled even if the term exists in the dictionary. + /// /// public PhraseSuggesterDescriptor RealWordErrorLikelihood(double? realWordErrorLikelihood) { @@ -326,7 +394,10 @@ public PhraseSuggesterDescriptor RealWordErrorLikelihood(double? real } /// - /// The separator that is used to separate terms in the bigram field.
If not set, the whitespace character is used as a separator. + /// + /// The separator that is used to separate terms in the bigram field. + /// If not set, the whitespace character is used as a separator. + /// /// public PhraseSuggesterDescriptor Separator(string? separator) { @@ -335,7 +406,9 @@ public PhraseSuggesterDescriptor Separator(string? separator) } /// - /// Sets the maximum number of suggested terms to be retrieved from each individual shard. + /// + /// Sets the maximum number of suggested terms to be retrieved from each individual shard. + /// /// public PhraseSuggesterDescriptor ShardSize(int? shardSize) { @@ -344,7 +417,9 @@ public PhraseSuggesterDescriptor ShardSize(int? shardSize) } /// - /// The maximum corrections to be returned per suggest text token. + /// + /// The maximum corrections to be returned per suggest text token. + /// /// public PhraseSuggesterDescriptor Size(int? size) { @@ -353,7 +428,10 @@ public PhraseSuggesterDescriptor Size(int? size) } /// - /// The smoothing model used to balance weight between infrequent grams (grams (shingles) are not existing in the index) and frequent grams (appear at least once in the index).
The default model is Stupid Backoff. + /// + /// The smoothing model used to balance weight between infrequent grams (grams (shingles) are not existing in the index) and frequent grams (appear at least once in the index). + /// The default model is Stupid Backoff. + /// /// public PhraseSuggesterDescriptor Smoothing(Elastic.Clients.Elasticsearch.Serverless.Core.Search.SmoothingModel? smoothing) { @@ -380,7 +458,9 @@ public PhraseSuggesterDescriptor Smoothing(Action - /// The text/query to provide suggestions for. + /// + /// The text/query to provide suggestions for. + /// /// public PhraseSuggesterDescriptor Text(string? text) { @@ -583,7 +663,10 @@ public PhraseSuggesterDescriptor() : base() private int? TokenLimitValue { get; set; } /// - /// The analyzer to analyze the suggest text with.
Defaults to the search analyzer of the suggest field. + /// + /// The analyzer to analyze the suggest text with. + /// Defaults to the search analyzer of the suggest field. + /// /// public PhraseSuggesterDescriptor Analyzer(string? analyzer) { @@ -592,7 +675,9 @@ public PhraseSuggesterDescriptor Analyzer(string? analyzer) } /// - /// Checks each suggestion against the specified query to prune suggestions for which no matching docs exist in the index. + /// + /// Checks each suggestion against the specified query to prune suggestions for which no matching docs exist in the index. + /// /// public PhraseSuggesterDescriptor Collate(Elastic.Clients.Elasticsearch.Serverless.Core.Search.PhraseSuggestCollate? collate) { @@ -619,7 +704,10 @@ public PhraseSuggesterDescriptor Collate(Action - /// Defines a factor applied to the input phrases score, which is used as a threshold for other suggest candidates.
Only candidates that score higher than the threshold will be included in the result. + /// + /// Defines a factor applied to the input phrases score, which is used as a threshold for other suggest candidates. + /// Only candidates that score higher than the threshold will be included in the result. + /// /// public PhraseSuggesterDescriptor Confidence(double? confidence) { @@ -628,7 +716,9 @@ public PhraseSuggesterDescriptor Confidence(double? confidence) } /// - /// A list of candidate generators that produce a list of possible terms per term in the given text. + /// + /// A list of candidate generators that produce a list of possible terms per term in the given text. + /// /// public PhraseSuggesterDescriptor DirectGenerator(ICollection? directGenerator) { @@ -667,7 +757,10 @@ public PhraseSuggesterDescriptor DirectGenerator(params Action - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public PhraseSuggesterDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -676,7 +769,10 @@ public PhraseSuggesterDescriptor Field(Elastic.Clients.Elasticsearch.Serverless. } /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public PhraseSuggesterDescriptor Field(Expression> field) { @@ -685,7 +781,10 @@ public PhraseSuggesterDescriptor Field(Expression - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public PhraseSuggesterDescriptor Field(Expression> field) { @@ -700,7 +799,11 @@ public PhraseSuggesterDescriptor ForceUnigrams(bool? forceUnigrams = true) } /// - /// Sets max size of the n-grams (shingles) in the field.
If the field doesn’t contain n-grams (shingles), this should be omitted or set to `1`.
If the field uses a shingle filter, the `gram_size` is set to the `max_shingle_size` if not explicitly set. + /// + /// Sets max size of the n-grams (shingles) in the field. + /// If the field doesn’t contain n-grams (shingles), this should be omitted or set to 1. + /// If the field uses a shingle filter, the gram_size is set to the max_shingle_size if not explicitly set. + /// /// public PhraseSuggesterDescriptor GramSize(int? gramSize) { @@ -709,7 +812,10 @@ public PhraseSuggesterDescriptor GramSize(int? gramSize) } /// - /// Sets up suggestion highlighting.
If not provided, no highlighted field is returned. + /// + /// Sets up suggestion highlighting. + /// If not provided, no highlighted field is returned. + /// /// public PhraseSuggesterDescriptor Highlight(Elastic.Clients.Elasticsearch.Serverless.Core.Search.PhraseSuggestHighlight? highlight) { @@ -736,7 +842,10 @@ public PhraseSuggesterDescriptor Highlight(Action - /// The maximum percentage of the terms considered to be misspellings in order to form a correction.
This method accepts a float value in the range `[0..1)` as a fraction of the actual query terms or a number `>=1` as an absolute number of query terms. + /// + /// The maximum percentage of the terms considered to be misspellings in order to form a correction. + /// This method accepts a float value in the range [0..1) as a fraction of the actual query terms or a number >=1 as an absolute number of query terms. + /// /// public PhraseSuggesterDescriptor MaxErrors(double? maxErrors) { @@ -745,7 +854,9 @@ public PhraseSuggesterDescriptor MaxErrors(double? maxErrors) } /// - /// The likelihood of a term being misspelled even if the term exists in the dictionary. + /// + /// The likelihood of a term being misspelled even if the term exists in the dictionary. + /// /// public PhraseSuggesterDescriptor RealWordErrorLikelihood(double? realWordErrorLikelihood) { @@ -754,7 +865,10 @@ public PhraseSuggesterDescriptor RealWordErrorLikelihood(double? realWordErrorLi } /// - /// The separator that is used to separate terms in the bigram field.
If not set, the whitespace character is used as a separator. + /// + /// The separator that is used to separate terms in the bigram field. + /// If not set, the whitespace character is used as a separator. + /// /// public PhraseSuggesterDescriptor Separator(string? separator) { @@ -763,7 +877,9 @@ public PhraseSuggesterDescriptor Separator(string? separator) } /// - /// Sets the maximum number of suggested terms to be retrieved from each individual shard. + /// + /// Sets the maximum number of suggested terms to be retrieved from each individual shard. + /// /// public PhraseSuggesterDescriptor ShardSize(int? shardSize) { @@ -772,7 +888,9 @@ public PhraseSuggesterDescriptor ShardSize(int? shardSize) } /// - /// The maximum corrections to be returned per suggest text token. + /// + /// The maximum corrections to be returned per suggest text token. + /// /// public PhraseSuggesterDescriptor Size(int? size) { @@ -781,7 +899,10 @@ public PhraseSuggesterDescriptor Size(int? size) } /// - /// The smoothing model used to balance weight between infrequent grams (grams (shingles) are not existing in the index) and frequent grams (appear at least once in the index).
The default model is Stupid Backoff. + /// + /// The smoothing model used to balance weight between infrequent grams (grams (shingles) are not existing in the index) and frequent grams (appear at least once in the index). + /// The default model is Stupid Backoff. + /// /// public PhraseSuggesterDescriptor Smoothing(Elastic.Clients.Elasticsearch.Serverless.Core.Search.SmoothingModel? smoothing) { @@ -808,7 +929,9 @@ public PhraseSuggesterDescriptor Smoothing(Action - /// The text/query to provide suggestions for. + /// + /// The text/query to provide suggestions for. + /// /// public PhraseSuggesterDescriptor Text(string? text) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/RegexOptions.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/RegexOptions.g.cs index 273c95e28ee..f6dd5f60fef 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/RegexOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/RegexOptions.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.Search; public sealed partial class RegexOptions { /// - /// Optional operators for the regular expression. + /// + /// Optional operators for the regular expression. + /// /// [JsonInclude, JsonPropertyName("flags")] public object? Flags { get; set; } /// - /// Maximum number of automaton states required for the query. + /// + /// Maximum number of automaton states required for the query. + /// /// [JsonInclude, JsonPropertyName("max_determinized_states")] public int? MaxDeterminizedStates { get; set; } @@ -54,7 +58,9 @@ public RegexOptionsDescriptor() : base() private int? MaxDeterminizedStatesValue { get; set; } /// - /// Optional operators for the regular expression. + /// + /// Optional operators for the regular expression. + /// /// public RegexOptionsDescriptor Flags(object? flags) { @@ -63,7 +69,9 @@ public RegexOptionsDescriptor Flags(object? flags) } /// - /// Maximum number of automaton states required for the query. + /// + /// Maximum number of automaton states required for the query. + /// /// public RegexOptionsDescriptor MaxDeterminizedStates(int? maxDeterminizedStates) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/RescoreQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/RescoreQuery.g.cs index 24b5edb684e..a25a82997ec 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/RescoreQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/RescoreQuery.g.cs @@ -30,25 +30,34 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.Search; public sealed partial class RescoreQuery { /// - /// The query to use for rescoring.
This query is only run on the Top-K results returned by the `query` and `post_filter` phases. + /// + /// The query to use for rescoring. + /// This query is only run on the Top-K results returned by the query and post_filter phases. + /// /// [JsonInclude, JsonPropertyName("rescore_query")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query Query { get; set; } /// - /// Relative importance of the original query versus the rescore query. + /// + /// Relative importance of the original query versus the rescore query. + /// /// [JsonInclude, JsonPropertyName("query_weight")] public double? QueryWeight { get; set; } /// - /// Relative importance of the rescore query versus the original query. + /// + /// Relative importance of the rescore query versus the original query. + /// /// [JsonInclude, JsonPropertyName("rescore_query_weight")] public double? RescoreQueryWeight { get; set; } /// - /// Determines how scores are combined. + /// + /// Determines how scores are combined. + /// /// [JsonInclude, JsonPropertyName("score_mode")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.ScoreMode? ScoreMode { get; set; } @@ -72,7 +81,10 @@ public RescoreQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Core.Search.ScoreMode? ScoreModeValue { get; set; } /// - /// The query to use for rescoring.
This query is only run on the Top-K results returned by the `query` and `post_filter` phases. + /// + /// The query to use for rescoring. + /// This query is only run on the Top-K results returned by the query and post_filter phases. + /// /// public RescoreQueryDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query query) { @@ -99,7 +111,9 @@ public RescoreQueryDescriptor Query(Action - /// Relative importance of the original query versus the rescore query. + /// + /// Relative importance of the original query versus the rescore query. + /// /// public RescoreQueryDescriptor QueryWeight(double? queryWeight) { @@ -108,7 +122,9 @@ public RescoreQueryDescriptor QueryWeight(double? queryWeight) } /// - /// Relative importance of the rescore query versus the original query. + /// + /// Relative importance of the rescore query versus the original query. + /// /// public RescoreQueryDescriptor RescoreQueryWeight(double? rescoreQueryWeight) { @@ -117,7 +133,9 @@ public RescoreQueryDescriptor RescoreQueryWeight(double? rescoreQuery } /// - /// Determines how scores are combined. + /// + /// Determines how scores are combined. + /// /// public RescoreQueryDescriptor ScoreMode(Elastic.Clients.Elasticsearch.Serverless.Core.Search.ScoreMode? scoreMode) { @@ -182,7 +200,10 @@ public RescoreQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Core.Search.ScoreMode? ScoreModeValue { get; set; } /// - /// The query to use for rescoring.
This query is only run on the Top-K results returned by the `query` and `post_filter` phases. + /// + /// The query to use for rescoring. + /// This query is only run on the Top-K results returned by the query and post_filter phases. + /// /// public RescoreQueryDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query query) { @@ -209,7 +230,9 @@ public RescoreQueryDescriptor Query(Action - /// Relative importance of the original query versus the rescore query. + /// + /// Relative importance of the original query versus the rescore query. + /// /// public RescoreQueryDescriptor QueryWeight(double? queryWeight) { @@ -218,7 +241,9 @@ public RescoreQueryDescriptor QueryWeight(double? queryWeight) } /// - /// Relative importance of the rescore query versus the original query. + /// + /// Relative importance of the rescore query versus the original query. + /// /// public RescoreQueryDescriptor RescoreQueryWeight(double? rescoreQueryWeight) { @@ -227,7 +252,9 @@ public RescoreQueryDescriptor RescoreQueryWeight(double? rescoreQueryWeight) } /// - /// Determines how scores are combined. + /// + /// Determines how scores are combined. + /// /// public RescoreQueryDescriptor ScoreMode(Elastic.Clients.Elasticsearch.Serverless.Core.Search.ScoreMode? scoreMode) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/StupidBackoffSmoothingModel.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/StupidBackoffSmoothingModel.g.cs index 3f8c16f720d..d3a323a4d29 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/StupidBackoffSmoothingModel.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/StupidBackoffSmoothingModel.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.Search; public sealed partial class StupidBackoffSmoothingModel { /// - /// A constant factor that the lower order n-gram model is discounted by. + /// + /// A constant factor that the lower order n-gram model is discounted by. + /// /// [JsonInclude, JsonPropertyName("discount")] public double Discount { get; set; } @@ -49,7 +51,9 @@ public StupidBackoffSmoothingModelDescriptor() : base() private double DiscountValue { get; set; } /// - /// A constant factor that the lower order n-gram model is discounted by. + /// + /// A constant factor that the lower order n-gram model is discounted by. + /// /// public StupidBackoffSmoothingModelDescriptor Discount(double discount) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/SuggestFuzziness.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/SuggestFuzziness.g.cs index 9f7f0343bb8..d898822c690 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/SuggestFuzziness.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/SuggestFuzziness.g.cs @@ -30,31 +30,42 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.Search; public sealed partial class SuggestFuzziness { /// - /// The fuzziness factor. + /// + /// The fuzziness factor. + /// /// [JsonInclude, JsonPropertyName("fuzziness")] public Elastic.Clients.Elasticsearch.Serverless.Fuzziness? Fuzziness { get; set; } /// - /// Minimum length of the input before fuzzy suggestions are returned. + /// + /// Minimum length of the input before fuzzy suggestions are returned. + /// /// [JsonInclude, JsonPropertyName("min_length")] public int? MinLength { get; set; } /// - /// Minimum length of the input, which is not checked for fuzzy alternatives. + /// + /// Minimum length of the input, which is not checked for fuzzy alternatives. + /// /// [JsonInclude, JsonPropertyName("prefix_length")] public int? PrefixLength { get; set; } /// - /// If set to `true`, transpositions are counted as one change instead of two. + /// + /// If set to true, transpositions are counted as one change instead of two. + /// /// [JsonInclude, JsonPropertyName("transpositions")] public bool? Transpositions { get; set; } /// - /// If `true`, all measurements (like fuzzy edit distance, transpositions, and lengths) are measured in Unicode code points instead of in bytes.
This is slightly slower than raw bytes. + /// + /// If true, all measurements (like fuzzy edit distance, transpositions, and lengths) are measured in Unicode code points instead of in bytes. + /// This is slightly slower than raw bytes. + /// /// [JsonInclude, JsonPropertyName("unicode_aware")] public bool? UnicodeAware { get; set; } @@ -75,7 +86,9 @@ public SuggestFuzzinessDescriptor() : base() private bool? UnicodeAwareValue { get; set; } /// - /// The fuzziness factor. + /// + /// The fuzziness factor. + /// /// public SuggestFuzzinessDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Serverless.Fuzziness? fuzziness) { @@ -84,7 +97,9 @@ public SuggestFuzzinessDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Server } /// - /// Minimum length of the input before fuzzy suggestions are returned. + /// + /// Minimum length of the input before fuzzy suggestions are returned. + /// /// public SuggestFuzzinessDescriptor MinLength(int? minLength) { @@ -93,7 +108,9 @@ public SuggestFuzzinessDescriptor MinLength(int? minLength) } /// - /// Minimum length of the input, which is not checked for fuzzy alternatives. + /// + /// Minimum length of the input, which is not checked for fuzzy alternatives. + /// /// public SuggestFuzzinessDescriptor PrefixLength(int? prefixLength) { @@ -102,7 +119,9 @@ public SuggestFuzzinessDescriptor PrefixLength(int? prefixLength) } /// - /// If set to `true`, transpositions are counted as one change instead of two. + /// + /// If set to true, transpositions are counted as one change instead of two. + /// /// public SuggestFuzzinessDescriptor Transpositions(bool? transpositions = true) { @@ -111,7 +130,10 @@ public SuggestFuzzinessDescriptor Transpositions(bool? transpositions = true) } /// - /// If `true`, all measurements (like fuzzy edit distance, transpositions, and lengths) are measured in Unicode code points instead of in bytes.
This is slightly slower than raw bytes. + /// + /// If true, all measurements (like fuzzy edit distance, transpositions, and lengths) are measured in Unicode code points instead of in bytes. + /// This is slightly slower than raw bytes. + /// /// public SuggestFuzzinessDescriptor UnicodeAware(bool? unicodeAware = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/Suggester.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/Suggester.g.cs index aeec92d1c52..7f1dbc2d2f9 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/Suggester.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/Suggester.g.cs @@ -82,12 +82,16 @@ public override void Write(Utf8JsonWriter writer, Suggester value, JsonSerialize public sealed partial class Suggester { /// - /// The named suggesters + /// + /// The named suggesters + /// /// public IDictionary Suggesters { get; set; } /// - /// Global suggest text, to avoid repetition when the same text is used in several suggesters + /// + /// Global suggest text, to avoid repetition when the same text is used in several suggesters + /// /// public string? Text { get; set; } } @@ -104,7 +108,9 @@ public SuggesterDescriptor() : base() private string? TextValue { get; set; } /// - /// The named suggesters + /// + /// The named suggesters + /// /// public SuggesterDescriptor Suggesters(Func>, FluentDescriptorDictionary>> selector) { @@ -113,7 +119,9 @@ public SuggesterDescriptor Suggesters(Func - /// Global suggest text, to avoid repetition when the same text is used in several suggesters + /// + /// Global suggest text, to avoid repetition when the same text is used in several suggesters + /// /// public SuggesterDescriptor Text(string? text) { @@ -155,7 +163,9 @@ public SuggesterDescriptor() : base() private string? TextValue { get; set; } /// - /// The named suggesters + /// + /// The named suggesters + /// /// public SuggesterDescriptor Suggesters(Func, FluentDescriptorDictionary> selector) { @@ -164,7 +174,9 @@ public SuggesterDescriptor Suggesters(Func - /// Global suggest text, to avoid repetition when the same text is used in several suggesters + /// + /// Global suggest text, to avoid repetition when the same text is used in several suggesters + /// /// public SuggesterDescriptor Text(string? text) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/TermSuggester.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/TermSuggester.g.cs index 30972fe1437..d3961ae4718 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/TermSuggester.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Search/TermSuggester.g.cs @@ -30,13 +30,19 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.Search; public sealed partial class TermSuggester { /// - /// The analyzer to analyze the suggest text with.
Defaults to the search analyzer of the suggest field. + /// + /// The analyzer to analyze the suggest text with. + /// Defaults to the search analyzer of the suggest field. + /// /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } @@ -44,73 +50,106 @@ public sealed partial class TermSuggester public bool? LowercaseTerms { get; set; } /// - /// The maximum edit distance candidate suggestions can have in order to be considered as a suggestion.
Can only be `1` or `2`. + /// + /// The maximum edit distance candidate suggestions can have in order to be considered as a suggestion. + /// Can only be 1 or 2. + /// /// [JsonInclude, JsonPropertyName("max_edits")] public int? MaxEdits { get; set; } /// - /// A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level.
Can improve accuracy at the cost of performance. + /// + /// A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level. + /// Can improve accuracy at the cost of performance. + /// /// [JsonInclude, JsonPropertyName("max_inspections")] public int? MaxInspections { get; set; } /// - /// The maximum threshold in number of documents in which a suggest text token can exist in order to be included.
Can be a relative percentage number (for example `0.4`) or an absolute number to represent document frequencies.
If a value higher than 1 is specified, then fractional can not be specified. + /// + /// The maximum threshold in number of documents in which a suggest text token can exist in order to be included. + /// Can be a relative percentage number (for example 0.4) or an absolute number to represent document frequencies. + /// If a value higher than 1 is specified, then fractional can not be specified. + /// /// [JsonInclude, JsonPropertyName("max_term_freq")] public float? MaxTermFreq { get; set; } /// - /// The minimal threshold in number of documents a suggestion should appear in.
This can improve quality by only suggesting high frequency terms.
Can be specified as an absolute number or as a relative percentage of number of documents.
If a value higher than 1 is specified, then the number cannot be fractional. + /// + /// The minimal threshold in number of documents a suggestion should appear in. + /// This can improve quality by only suggesting high frequency terms. + /// Can be specified as an absolute number or as a relative percentage of number of documents. + /// If a value higher than 1 is specified, then the number cannot be fractional. + /// /// [JsonInclude, JsonPropertyName("min_doc_freq")] public float? MinDocFreq { get; set; } /// - /// The minimum length a suggest text term must have in order to be included. + /// + /// The minimum length a suggest text term must have in order to be included. + /// /// [JsonInclude, JsonPropertyName("min_word_length")] public int? MinWordLength { get; set; } /// - /// The number of minimal prefix characters that must match in order be a candidate for suggestions.
Increasing this number improves spellcheck performance. + /// + /// The number of minimal prefix characters that must match in order be a candidate for suggestions. + /// Increasing this number improves spellcheck performance. + /// /// [JsonInclude, JsonPropertyName("prefix_length")] public int? PrefixLength { get; set; } /// - /// Sets the maximum number of suggestions to be retrieved from each individual shard. + /// + /// Sets the maximum number of suggestions to be retrieved from each individual shard. + /// /// [JsonInclude, JsonPropertyName("shard_size")] public int? ShardSize { get; set; } /// - /// The maximum corrections to be returned per suggest text token. + /// + /// The maximum corrections to be returned per suggest text token. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// Defines how suggestions should be sorted per suggest text term. + /// + /// Defines how suggestions should be sorted per suggest text term. + /// /// [JsonInclude, JsonPropertyName("sort")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.SuggestSort? Sort { get; set; } /// - /// The string distance implementation to use for comparing how similar suggested terms are. + /// + /// The string distance implementation to use for comparing how similar suggested terms are. + /// /// [JsonInclude, JsonPropertyName("string_distance")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.StringDistance? StringDistance { get; set; } /// - /// Controls what suggestions are included or controls for what suggest text terms, suggestions should be suggested. + /// + /// Controls what suggestions are included or controls for what suggest text terms, suggestions should be suggested. + /// /// [JsonInclude, JsonPropertyName("suggest_mode")] public Elastic.Clients.Elasticsearch.Serverless.SuggestMode? SuggestMode { get; set; } /// - /// The suggest text.
Needs to be set globally or per suggestion. + /// + /// The suggest text. + /// Needs to be set globally or per suggestion. + /// /// [JsonInclude, JsonPropertyName("text")] public string? Text { get; set; } @@ -143,7 +182,10 @@ public TermSuggesterDescriptor() : base() private string? TextValue { get; set; } /// - /// The analyzer to analyze the suggest text with.
Defaults to the search analyzer of the suggest field. + /// + /// The analyzer to analyze the suggest text with. + /// Defaults to the search analyzer of the suggest field. + /// /// public TermSuggesterDescriptor Analyzer(string? analyzer) { @@ -152,7 +194,10 @@ public TermSuggesterDescriptor Analyzer(string? analyzer) } /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public TermSuggesterDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -161,7 +206,10 @@ public TermSuggesterDescriptor Field(Elastic.Clients.Elasticsearch.Se } /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public TermSuggesterDescriptor Field(Expression> field) { @@ -170,7 +218,10 @@ public TermSuggesterDescriptor Field(Expression - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public TermSuggesterDescriptor Field(Expression> field) { @@ -185,7 +236,10 @@ public TermSuggesterDescriptor LowercaseTerms(bool? lowercaseTerms = } /// - /// The maximum edit distance candidate suggestions can have in order to be considered as a suggestion.
Can only be `1` or `2`. + /// + /// The maximum edit distance candidate suggestions can have in order to be considered as a suggestion. + /// Can only be 1 or 2. + /// /// public TermSuggesterDescriptor MaxEdits(int? maxEdits) { @@ -194,7 +248,10 @@ public TermSuggesterDescriptor MaxEdits(int? maxEdits) } /// - /// A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level.
Can improve accuracy at the cost of performance. + /// + /// A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level. + /// Can improve accuracy at the cost of performance. + /// /// public TermSuggesterDescriptor MaxInspections(int? maxInspections) { @@ -203,7 +260,11 @@ public TermSuggesterDescriptor MaxInspections(int? maxInspections) } /// - /// The maximum threshold in number of documents in which a suggest text token can exist in order to be included.
Can be a relative percentage number (for example `0.4`) or an absolute number to represent document frequencies.
If a value higher than 1 is specified, then fractional can not be specified. + /// + /// The maximum threshold in number of documents in which a suggest text token can exist in order to be included. + /// Can be a relative percentage number (for example 0.4) or an absolute number to represent document frequencies. + /// If a value higher than 1 is specified, then fractional can not be specified. + /// /// public TermSuggesterDescriptor MaxTermFreq(float? maxTermFreq) { @@ -212,7 +273,12 @@ public TermSuggesterDescriptor MaxTermFreq(float? maxTermFreq) } /// - /// The minimal threshold in number of documents a suggestion should appear in.
This can improve quality by only suggesting high frequency terms.
Can be specified as an absolute number or as a relative percentage of number of documents.
If a value higher than 1 is specified, then the number cannot be fractional. + /// + /// The minimal threshold in number of documents a suggestion should appear in. + /// This can improve quality by only suggesting high frequency terms. + /// Can be specified as an absolute number or as a relative percentage of number of documents. + /// If a value higher than 1 is specified, then the number cannot be fractional. + /// /// public TermSuggesterDescriptor MinDocFreq(float? minDocFreq) { @@ -221,7 +287,9 @@ public TermSuggesterDescriptor MinDocFreq(float? minDocFreq) } /// - /// The minimum length a suggest text term must have in order to be included. + /// + /// The minimum length a suggest text term must have in order to be included. + /// /// public TermSuggesterDescriptor MinWordLength(int? minWordLength) { @@ -230,7 +298,10 @@ public TermSuggesterDescriptor MinWordLength(int? minWordLength) } /// - /// The number of minimal prefix characters that must match in order be a candidate for suggestions.
Increasing this number improves spellcheck performance. + /// + /// The number of minimal prefix characters that must match in order be a candidate for suggestions. + /// Increasing this number improves spellcheck performance. + /// /// public TermSuggesterDescriptor PrefixLength(int? prefixLength) { @@ -239,7 +310,9 @@ public TermSuggesterDescriptor PrefixLength(int? prefixLength) } /// - /// Sets the maximum number of suggestions to be retrieved from each individual shard. + /// + /// Sets the maximum number of suggestions to be retrieved from each individual shard. + /// /// public TermSuggesterDescriptor ShardSize(int? shardSize) { @@ -248,7 +321,9 @@ public TermSuggesterDescriptor ShardSize(int? shardSize) } /// - /// The maximum corrections to be returned per suggest text token. + /// + /// The maximum corrections to be returned per suggest text token. + /// /// public TermSuggesterDescriptor Size(int? size) { @@ -257,7 +332,9 @@ public TermSuggesterDescriptor Size(int? size) } /// - /// Defines how suggestions should be sorted per suggest text term. + /// + /// Defines how suggestions should be sorted per suggest text term. + /// /// public TermSuggesterDescriptor Sort(Elastic.Clients.Elasticsearch.Serverless.Core.Search.SuggestSort? sort) { @@ -266,7 +343,9 @@ public TermSuggesterDescriptor Sort(Elastic.Clients.Elasticsearch.Ser } /// - /// The string distance implementation to use for comparing how similar suggested terms are. + /// + /// The string distance implementation to use for comparing how similar suggested terms are. + /// /// public TermSuggesterDescriptor StringDistance(Elastic.Clients.Elasticsearch.Serverless.Core.Search.StringDistance? stringDistance) { @@ -275,7 +354,9 @@ public TermSuggesterDescriptor StringDistance(Elastic.Clients.Elastic } /// - /// Controls what suggestions are included or controls for what suggest text terms, suggestions should be suggested. + /// + /// Controls what suggestions are included or controls for what suggest text terms, suggestions should be suggested. + /// /// public TermSuggesterDescriptor SuggestMode(Elastic.Clients.Elasticsearch.Serverless.SuggestMode? suggestMode) { @@ -284,7 +365,10 @@ public TermSuggesterDescriptor SuggestMode(Elastic.Clients.Elasticsea } /// - /// The suggest text.
Needs to be set globally or per suggestion. + /// + /// The suggest text. + /// Needs to be set globally or per suggestion. + /// /// public TermSuggesterDescriptor Text(string? text) { @@ -410,7 +494,10 @@ public TermSuggesterDescriptor() : base() private string? TextValue { get; set; } /// - /// The analyzer to analyze the suggest text with.
Defaults to the search analyzer of the suggest field. + /// + /// The analyzer to analyze the suggest text with. + /// Defaults to the search analyzer of the suggest field. + /// /// public TermSuggesterDescriptor Analyzer(string? analyzer) { @@ -419,7 +506,10 @@ public TermSuggesterDescriptor Analyzer(string? analyzer) } /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public TermSuggesterDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -428,7 +518,10 @@ public TermSuggesterDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Fi } /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public TermSuggesterDescriptor Field(Expression> field) { @@ -437,7 +530,10 @@ public TermSuggesterDescriptor Field(Expression - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public TermSuggesterDescriptor Field(Expression> field) { @@ -452,7 +548,10 @@ public TermSuggesterDescriptor LowercaseTerms(bool? lowercaseTerms = true) } /// - /// The maximum edit distance candidate suggestions can have in order to be considered as a suggestion.
Can only be `1` or `2`. + /// + /// The maximum edit distance candidate suggestions can have in order to be considered as a suggestion. + /// Can only be 1 or 2. + /// /// public TermSuggesterDescriptor MaxEdits(int? maxEdits) { @@ -461,7 +560,10 @@ public TermSuggesterDescriptor MaxEdits(int? maxEdits) } /// - /// A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level.
Can improve accuracy at the cost of performance. + /// + /// A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level. + /// Can improve accuracy at the cost of performance. + /// /// public TermSuggesterDescriptor MaxInspections(int? maxInspections) { @@ -470,7 +572,11 @@ public TermSuggesterDescriptor MaxInspections(int? maxInspections) } /// - /// The maximum threshold in number of documents in which a suggest text token can exist in order to be included.
Can be a relative percentage number (for example `0.4`) or an absolute number to represent document frequencies.
If a value higher than 1 is specified, then fractional can not be specified. + /// + /// The maximum threshold in number of documents in which a suggest text token can exist in order to be included. + /// Can be a relative percentage number (for example 0.4) or an absolute number to represent document frequencies. + /// If a value higher than 1 is specified, then fractional can not be specified. + /// /// public TermSuggesterDescriptor MaxTermFreq(float? maxTermFreq) { @@ -479,7 +585,12 @@ public TermSuggesterDescriptor MaxTermFreq(float? maxTermFreq) } /// - /// The minimal threshold in number of documents a suggestion should appear in.
This can improve quality by only suggesting high frequency terms.
Can be specified as an absolute number or as a relative percentage of number of documents.
If a value higher than 1 is specified, then the number cannot be fractional. + /// + /// The minimal threshold in number of documents a suggestion should appear in. + /// This can improve quality by only suggesting high frequency terms. + /// Can be specified as an absolute number or as a relative percentage of number of documents. + /// If a value higher than 1 is specified, then the number cannot be fractional. + /// /// public TermSuggesterDescriptor MinDocFreq(float? minDocFreq) { @@ -488,7 +599,9 @@ public TermSuggesterDescriptor MinDocFreq(float? minDocFreq) } /// - /// The minimum length a suggest text term must have in order to be included. + /// + /// The minimum length a suggest text term must have in order to be included. + /// /// public TermSuggesterDescriptor MinWordLength(int? minWordLength) { @@ -497,7 +610,10 @@ public TermSuggesterDescriptor MinWordLength(int? minWordLength) } /// - /// The number of minimal prefix characters that must match in order be a candidate for suggestions.
Increasing this number improves spellcheck performance. + /// + /// The number of minimal prefix characters that must match in order be a candidate for suggestions. + /// Increasing this number improves spellcheck performance. + /// /// public TermSuggesterDescriptor PrefixLength(int? prefixLength) { @@ -506,7 +622,9 @@ public TermSuggesterDescriptor PrefixLength(int? prefixLength) } /// - /// Sets the maximum number of suggestions to be retrieved from each individual shard. + /// + /// Sets the maximum number of suggestions to be retrieved from each individual shard. + /// /// public TermSuggesterDescriptor ShardSize(int? shardSize) { @@ -515,7 +633,9 @@ public TermSuggesterDescriptor ShardSize(int? shardSize) } /// - /// The maximum corrections to be returned per suggest text token. + /// + /// The maximum corrections to be returned per suggest text token. + /// /// public TermSuggesterDescriptor Size(int? size) { @@ -524,7 +644,9 @@ public TermSuggesterDescriptor Size(int? size) } /// - /// Defines how suggestions should be sorted per suggest text term. + /// + /// Defines how suggestions should be sorted per suggest text term. + /// /// public TermSuggesterDescriptor Sort(Elastic.Clients.Elasticsearch.Serverless.Core.Search.SuggestSort? sort) { @@ -533,7 +655,9 @@ public TermSuggesterDescriptor Sort(Elastic.Clients.Elasticsearch.Serverless.Cor } /// - /// The string distance implementation to use for comparing how similar suggested terms are. + /// + /// The string distance implementation to use for comparing how similar suggested terms are. + /// /// public TermSuggesterDescriptor StringDistance(Elastic.Clients.Elasticsearch.Serverless.Core.Search.StringDistance? stringDistance) { @@ -542,7 +666,9 @@ public TermSuggesterDescriptor StringDistance(Elastic.Clients.Elasticsearch.Serv } /// - /// Controls what suggestions are included or controls for what suggest text terms, suggestions should be suggested. + /// + /// Controls what suggestions are included or controls for what suggest text terms, suggestions should be suggested. + /// /// public TermSuggesterDescriptor SuggestMode(Elastic.Clients.Elasticsearch.Serverless.SuggestMode? suggestMode) { @@ -551,7 +677,10 @@ public TermSuggesterDescriptor SuggestMode(Elastic.Clients.Elasticsearch.Serverl } /// - /// The suggest text.
Needs to be set globally or per suggestion. + /// + /// The suggest text. + /// Needs to be set globally or per suggestion. + /// /// public TermSuggesterDescriptor Text(string? text) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/SourceConfig.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/SourceConfig.g.cs index e9ebafa4041..f790c8e2665 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/SourceConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/SourceConfig.g.cs @@ -31,7 +31,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.Search; /// -/// Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered. +/// +/// Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered. +/// /// public sealed partial class SourceConfig : Union { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/SourceConfigParam.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/SourceConfigParam.g.cs index 18d83848038..762d51fe35e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/SourceConfigParam.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/SourceConfigParam.g.cs @@ -31,7 +31,10 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.Search; /// -/// Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.
Used as a query parameter along with the `_source_includes` and `_source_excludes` parameters. +/// +/// Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered. +/// Used as a query parameter along with the _source_includes and _source_excludes parameters. +/// /// public sealed partial class SourceConfigParam : Union { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/TermVectors/Filter.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/TermVectors/Filter.g.cs index ff5c0262ab2..29950c455ce 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/TermVectors/Filter.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/TermVectors/Filter.g.cs @@ -30,43 +30,60 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.TermVectors; public sealed partial class Filter { /// - /// Ignore words which occur in more than this many docs.
Defaults to unbounded. + /// + /// Ignore words which occur in more than this many docs. + /// Defaults to unbounded. + /// /// [JsonInclude, JsonPropertyName("max_doc_freq")] public int? MaxDocFreq { get; set; } /// - /// Maximum number of terms that must be returned per field. + /// + /// Maximum number of terms that must be returned per field. + /// /// [JsonInclude, JsonPropertyName("max_num_terms")] public int? MaxNumTerms { get; set; } /// - /// Ignore words with more than this frequency in the source doc.
Defaults to unbounded. + /// + /// Ignore words with more than this frequency in the source doc. + /// Defaults to unbounded. + /// /// [JsonInclude, JsonPropertyName("max_term_freq")] public int? MaxTermFreq { get; set; } /// - /// The maximum word length above which words will be ignored.
Defaults to unbounded. + /// + /// The maximum word length above which words will be ignored. + /// Defaults to unbounded. + /// /// [JsonInclude, JsonPropertyName("max_word_length")] public int? MaxWordLength { get; set; } /// - /// Ignore terms which do not occur in at least this many docs. + /// + /// Ignore terms which do not occur in at least this many docs. + /// /// [JsonInclude, JsonPropertyName("min_doc_freq")] public int? MinDocFreq { get; set; } /// - /// Ignore words with less than this frequency in the source doc. + /// + /// Ignore words with less than this frequency in the source doc. + /// /// [JsonInclude, JsonPropertyName("min_term_freq")] public int? MinTermFreq { get; set; } /// - /// The minimum word length below which words will be ignored. + /// + /// The minimum word length below which words will be ignored. + /// /// [JsonInclude, JsonPropertyName("min_word_length")] public int? MinWordLength { get; set; } @@ -89,7 +106,10 @@ public FilterDescriptor() : base() private int? MinWordLengthValue { get; set; } /// - /// Ignore words which occur in more than this many docs.
Defaults to unbounded. + /// + /// Ignore words which occur in more than this many docs. + /// Defaults to unbounded. + /// /// public FilterDescriptor MaxDocFreq(int? maxDocFreq) { @@ -98,7 +118,9 @@ public FilterDescriptor MaxDocFreq(int? maxDocFreq) } /// - /// Maximum number of terms that must be returned per field. + /// + /// Maximum number of terms that must be returned per field. + /// /// public FilterDescriptor MaxNumTerms(int? maxNumTerms) { @@ -107,7 +129,10 @@ public FilterDescriptor MaxNumTerms(int? maxNumTerms) } /// - /// Ignore words with more than this frequency in the source doc.
Defaults to unbounded. + /// + /// Ignore words with more than this frequency in the source doc. + /// Defaults to unbounded. + /// /// public FilterDescriptor MaxTermFreq(int? maxTermFreq) { @@ -116,7 +141,10 @@ public FilterDescriptor MaxTermFreq(int? maxTermFreq) } /// - /// The maximum word length above which words will be ignored.
Defaults to unbounded. + /// + /// The maximum word length above which words will be ignored. + /// Defaults to unbounded. + /// /// public FilterDescriptor MaxWordLength(int? maxWordLength) { @@ -125,7 +153,9 @@ public FilterDescriptor MaxWordLength(int? maxWordLength) } /// - /// Ignore terms which do not occur in at least this many docs. + /// + /// Ignore terms which do not occur in at least this many docs. + /// /// public FilterDescriptor MinDocFreq(int? minDocFreq) { @@ -134,7 +164,9 @@ public FilterDescriptor MinDocFreq(int? minDocFreq) } /// - /// Ignore words with less than this frequency in the source doc. + /// + /// Ignore words with less than this frequency in the source doc. + /// /// public FilterDescriptor MinTermFreq(int? minTermFreq) { @@ -143,7 +175,9 @@ public FilterDescriptor MinTermFreq(int? minTermFreq) } /// - /// The minimum word length below which words will be ignored. + /// + /// The minimum word length below which words will be ignored. + /// /// public FilterDescriptor MinWordLength(int? minWordLength) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/TrackHits.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/TrackHits.g.cs index 19f60f4ddd5..58cf0283a76 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/TrackHits.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/TrackHits.g.cs @@ -31,7 +31,12 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.Search; /// -/// Number of hits matching the query to count accurately. If true, the exact
number of hits is returned at the cost of some performance. If false, the
response does not include the total number of hits matching the query.
Defaults to 10,000 hits. +/// +/// Number of hits matching the query to count accurately. If true, the exact +/// number of hits is returned at the cost of some performance. If false, the +/// response does not include the total number of hits matching the query. +/// Defaults to 10,000 hits. +/// /// public sealed partial class TrackHits : Union { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/DocStats.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/DocStats.g.cs index b500b748eba..dd91a5446a2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/DocStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/DocStats.g.cs @@ -30,13 +30,20 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class DocStats { /// - /// Total number of non-deleted documents across all primary shards assigned to selected nodes.
This number is based on documents in Lucene segments and may include documents from nested fields. + /// + /// Total number of non-deleted documents across all primary shards assigned to selected nodes. + /// This number is based on documents in Lucene segments and may include documents from nested fields. + /// /// [JsonInclude, JsonPropertyName("count")] public long Count { get; init; } /// - /// Total number of deleted documents across all primary shards assigned to selected nodes.
This number is based on documents in Lucene segments.
Elasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged. + /// + /// Total number of deleted documents across all primary shards assigned to selected nodes. + /// This number is based on documents in Lucene segments. + /// Elasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged. + /// /// [JsonInclude, JsonPropertyName("deleted")] public long? Deleted { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/EmptyObject.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/EmptyObject.g.cs index c2677772610..aea9c1b1871 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/EmptyObject.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/EmptyObject.g.cs @@ -28,14 +28,18 @@ namespace Elastic.Clients.Elasticsearch.Serverless; /// -/// For empty Class assignments +/// +/// For empty Class assignments +/// /// public sealed partial class EmptyObject { } /// -/// For empty Class assignments +/// +/// For empty Class assignments +/// /// public sealed partial class EmptyObjectDescriptor : SerializableDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Aggregations.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Aggregations.g.cs index 32494766661..a60560bba8e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Aggregations.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Aggregations.g.cs @@ -124,27 +124,37 @@ public override void Write(Utf8JsonWriter writer, CalendarInterval value, JsonSe public enum CardinalityExecutionMode { /// - /// Run the aggregation by using segment ordinal values and resolving those values after each segment. + /// + /// Run the aggregation by using segment ordinal values and resolving those values after each segment. + /// /// [EnumMember(Value = "segment_ordinals")] SegmentOrdinals, /// - /// Heuristic-based mode, default in Elasticsearch 8.4 and later. + /// + /// Heuristic-based mode, default in Elasticsearch 8.4 and later. + /// /// [EnumMember(Value = "save_time_heuristic")] SaveTimeHeuristic, /// - /// Heuristic-based mode, default in Elasticsearch 8.3 and earlier. + /// + /// Heuristic-based mode, default in Elasticsearch 8.3 and earlier. + /// /// [EnumMember(Value = "save_memory_heuristic")] SaveMemoryHeuristic, /// - /// Run the aggregation by using global ordinals of the field and resolving those values after finishing a shard. + /// + /// Run the aggregation by using global ordinals of the field and resolving those values after finishing a shard. + /// /// [EnumMember(Value = "global_ordinals")] GlobalOrdinals, /// - /// Run the aggregation by using field values directly. + /// + /// Run the aggregation by using field values directly. + /// /// [EnumMember(Value = "direct")] Direct @@ -202,17 +212,25 @@ public override void Write(Utf8JsonWriter writer, CardinalityExecutionMode value public enum GapPolicy { /// - /// Treats missing data as if the bucket does not exist. It will skip the bucket and
continue calculating using the next available value. + /// + /// Treats missing data as if the bucket does not exist. It will skip the bucket and + /// continue calculating using the next available value. + /// /// [EnumMember(Value = "skip")] Skip, /// - /// Similar to skip, except if the metric provides a non-null, non-NaN value this value is used,
otherwise the empty bucket is skipped. + /// + /// Similar to skip, except if the metric provides a non-null, non-NaN value this value is used, + /// otherwise the empty bucket is skipped. + /// /// [EnumMember(Value = "keep_values")] KeepValues, /// - /// Replace missing values with a zero (0) and pipeline aggregation computation will proceed as normal. + /// + /// Replace missing values with a zero (0) and pipeline aggregation computation will proceed as normal. + /// /// [EnumMember(Value = "insert_zeros")] InsertZeros @@ -379,32 +397,44 @@ public override void Write(Utf8JsonWriter writer, MissingOrder value, JsonSerial public enum NormalizeMethod { /// - /// This method normalizes such that each value represents how far it is from the mean relative to the standard deviation. + /// + /// This method normalizes such that each value represents how far it is from the mean relative to the standard deviation. + /// /// [EnumMember(Value = "z-score")] ZScore, /// - /// This method normalizes such that each value is exponentiated and relative to the sum of the exponents of the original values. + /// + /// This method normalizes such that each value is exponentiated and relative to the sum of the exponents of the original values. + /// /// [EnumMember(Value = "softmax")] Softmax, /// - /// This method rescales the data such that the minimum number is 0, and the maximum number is 100, with the rest normalized linearly in-between. + /// + /// This method rescales the data such that the minimum number is 0, and the maximum number is 100, with the rest normalized linearly in-between. + /// /// [EnumMember(Value = "rescale_0_100")] Rescale0100, /// - /// This method rescales the data such that the minimum number is 0, and the maximum number is 1, with the rest normalized linearly in-between. + /// + /// This method rescales the data such that the minimum number is 0, and the maximum number is 1, with the rest normalized linearly in-between. + /// /// [EnumMember(Value = "rescale_0_1")] Rescale01, /// - /// This method normalizes each value so that it represents a percentage of the total sum it attributes to. + /// + /// This method normalizes each value so that it represents a percentage of the total sum it attributes to. + /// /// [EnumMember(Value = "percent_of_sum")] PercentOfSum, /// - /// This method normalizes such that each value is normalized by how much it differs from the average. + /// + /// This method normalizes such that each value is normalized by how much it differs from the average. + /// /// [EnumMember(Value = "mean")] Mean @@ -467,12 +497,16 @@ public override void Write(Utf8JsonWriter writer, NormalizeMethod value, JsonSer public enum RateMode { /// - /// Uses the number of values of the field. + /// + /// Uses the number of values of the field. + /// /// [EnumMember(Value = "value_count")] ValueCount, /// - /// Calculates the sum of all values of the field. + /// + /// Calculates the sum of all values of the field. + /// /// [EnumMember(Value = "sum")] Sum @@ -515,17 +549,23 @@ public override void Write(Utf8JsonWriter writer, RateMode value, JsonSerializer public enum SamplerAggregationExecutionHint { /// - /// Hold field values directly. + /// + /// Hold field values directly. + /// /// [EnumMember(Value = "map")] Map, /// - /// Hold ordinals of the field as determined by the Lucene index. + /// + /// Hold ordinals of the field as determined by the Lucene index. + /// /// [EnumMember(Value = "global_ordinals")] GlobalOrdinals, /// - /// Hold hashes of the field values - with potential for hash collisions. + /// + /// Hold hashes of the field values - with potential for hash collisions. + /// /// [EnumMember(Value = "bytes_hash")] BytesHash @@ -573,12 +613,16 @@ public override void Write(Utf8JsonWriter writer, SamplerAggregationExecutionHin public enum TermsAggregationCollectMode { /// - /// Expands all branches of the aggregation tree in one depth-first pass, before any pruning occurs. + /// + /// Expands all branches of the aggregation tree in one depth-first pass, before any pruning occurs. + /// /// [EnumMember(Value = "depth_first")] DepthFirst, /// - /// Caches the set of documents that fall into the uppermost buckets for subsequent replay. + /// + /// Caches the set of documents that fall into the uppermost buckets for subsequent replay. + /// /// [EnumMember(Value = "breadth_first")] BreadthFirst @@ -677,17 +721,23 @@ public override void Write(Utf8JsonWriter writer, TermsAggregationExecutionHint public enum TTestType { /// - /// Performs paired t-test. + /// + /// Performs paired t-test. + /// /// [EnumMember(Value = "paired")] Paired, /// - /// Performs two-sample equal variance test. + /// + /// Performs two-sample equal variance test. + /// /// [EnumMember(Value = "homoscedastic")] Homoscedastic, /// - /// Performs two-sample unequal variance test. + /// + /// Performs two-sample unequal variance test. + /// /// [EnumMember(Value = "heteroscedastic")] Heteroscedastic diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Core.Search.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Core.Search.g.cs index 230c04d7542..733910adc3f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Core.Search.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Core.Search.g.cs @@ -32,17 +32,29 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.Search; public enum BoundaryScanner { /// - /// Break highlighted fragments at the next word boundary, as determined by Java’s `BreakIterator`.
You can specify the locale to use with `boundary_scanner_locale`. + /// + /// Break highlighted fragments at the next word boundary, as determined by Java’s BreakIterator. + /// You can specify the locale to use with boundary_scanner_locale. + /// /// [EnumMember(Value = "word")] Word, /// - /// Break highlighted fragments at the next sentence boundary, as determined by Java’s `BreakIterator`.
You can specify the locale to use with `boundary_scanner_locale`.
When used with the `unified` highlighter, the `sentence` scanner splits sentences bigger than `fragment_size` at the first word boundary next to fragment_size.
You can set `fragment_size` to `0` to never split any sentence. + /// + /// Break highlighted fragments at the next sentence boundary, as determined by Java’s BreakIterator. + /// You can specify the locale to use with boundary_scanner_locale. + /// When used with the unified highlighter, the sentence scanner splits sentences bigger than fragment_size at the first word boundary next to fragment_size. + /// You can set fragment_size to 0 to never split any sentence. + /// /// [EnumMember(Value = "sentence")] Sentence, /// - /// Use the characters specified by `boundary_chars` as highlighting boundaries.
The `boundary_max_scan` setting controls how far to scan for boundary characters.
Only valid for the `fvh` highlighter. + /// + /// Use the characters specified by boundary_chars as highlighting boundaries. + /// The boundary_max_scan setting controls how far to scan for boundary characters. + /// Only valid for the fvh highlighter. + /// /// [EnumMember(Value = "chars")] Chars @@ -250,17 +262,23 @@ public override void Write(Utf8JsonWriter writer, HighlighterTagsSchema value, J public readonly string Value { get; } /// - /// The unified highlighter uses the Lucene Unified Highlighter. + /// + /// The unified highlighter uses the Lucene Unified Highlighter. + /// /// public static HighlighterType Unified { get; } = new HighlighterType("unified"); /// - /// The `plain` highlighter uses the standard Lucene highlighter + /// + /// The plain highlighter uses the standard Lucene highlighter + /// /// public static HighlighterType Plain { get; } = new HighlighterType("plain"); /// - /// The fvh highlighter uses the Lucene Fast Vector highlighter. + /// + /// The fvh highlighter uses the Lucene Fast Vector highlighter. + /// /// public static HighlighterType FastVector { get; } = new HighlighterType("fvh"); @@ -281,27 +299,38 @@ public override void Write(Utf8JsonWriter writer, HighlighterTagsSchema value, J public enum ScoreMode { /// - /// Add the original score and the rescore query score. + /// + /// Add the original score and the rescore query score. + /// /// [EnumMember(Value = "total")] Total, /// - /// Multiply the original score by the rescore query score.
Useful for `function` query rescores. + /// + /// Multiply the original score by the rescore query score. + /// Useful for function query rescores. + /// /// [EnumMember(Value = "multiply")] Multiply, /// - /// Take the min of the original score and the rescore query score. + /// + /// Take the min of the original score and the rescore query score. + /// /// [EnumMember(Value = "min")] Min, /// - /// Take the max of original score and the rescore query score. + /// + /// Take the max of original score and the rescore query score. + /// /// [EnumMember(Value = "max")] Max, /// - /// Average the original score and the rescore query score. + /// + /// Average the original score and the rescore query score. + /// /// [EnumMember(Value = "avg")] Avg @@ -359,27 +388,37 @@ public override void Write(Utf8JsonWriter writer, ScoreMode value, JsonSerialize public enum StringDistance { /// - /// String distance algorithm based on character n-grams. + /// + /// String distance algorithm based on character n-grams. + /// /// [EnumMember(Value = "ngram")] Ngram, /// - /// String distance algorithm based on the Levenshtein edit distance algorithm. + /// + /// String distance algorithm based on the Levenshtein edit distance algorithm. + /// /// [EnumMember(Value = "levenshtein")] Levenshtein, /// - /// String distance algorithm based on Jaro-Winkler algorithm. + /// + /// String distance algorithm based on Jaro-Winkler algorithm. + /// /// [EnumMember(Value = "jaro_winkler")] JaroWinkler, /// - /// Based on the Damerau-Levenshtein algorithm, but highly optimized for comparing string distance for terms inside the index. + /// + /// Based on the Damerau-Levenshtein algorithm, but highly optimized for comparing string distance for terms inside the index. + /// /// [EnumMember(Value = "internal")] Internal, /// - /// String distance algorithm based on Damerau-Levenshtein algorithm. + /// + /// String distance algorithm based on Damerau-Levenshtein algorithm. + /// /// [EnumMember(Value = "damerau_levenshtein")] DamerauLevenshtein @@ -437,12 +476,16 @@ public override void Write(Utf8JsonWriter writer, StringDistance value, JsonSeri public enum SuggestSort { /// - /// Sort by score first, then document frequency and then the term itself. + /// + /// Sort by score first, then document frequency and then the term itself. + /// /// [EnumMember(Value = "score")] Score, /// - /// Sort by document frequency first, then similarity score and then the term itself. + /// + /// Sort by document frequency first, then similarity score and then the term itself. + /// /// [EnumMember(Value = "frequency")] Frequency @@ -485,12 +528,16 @@ public override void Write(Utf8JsonWriter writer, SuggestSort value, JsonSeriali public enum TotalHitsRelation { /// - /// Lower bound, including returned events or sequences + /// + /// Lower bound, including returned events or sequences + /// /// [EnumMember(Value = "gte")] Gte, /// - /// Accurate + /// + /// Accurate + /// /// [EnumMember(Value = "eq")] Eq diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Eql.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Eql.g.cs index efb1cf7cbea..75e0ada4a0f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Eql.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Eql.g.cs @@ -32,12 +32,16 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Eql; public enum ResultPosition { /// - /// Return the most recent matches, similar to the Unix tail command. + /// + /// Return the most recent matches, similar to the Unix tail command. + /// /// [EnumMember(Value = "tail")] Tail, /// - /// Return the earliest matches, similar to the Unix head command. + /// + /// Return the earliest matches, similar to the Unix head command. + /// /// [EnumMember(Value = "head")] Head diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.IndexManagement.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.IndexManagement.g.cs index f88b37adba8..8c629226390 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.IndexManagement.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.IndexManagement.g.cs @@ -567,22 +567,38 @@ public override void Write(Utf8JsonWriter writer, ShardRoutingState value, JsonS public readonly string Value { get; } /// - /// The NIO FS type stores the shard index on the file system (maps to Lucene NIOFSDirectory) using NIO. It allows multiple
threads to read from the same file concurrently. It is not recommended on Windows because of a bug in the SUN Java
implementation and disables some optimizations for heap memory usage. + /// + /// The NIO FS type stores the shard index on the file system (maps to Lucene NIOFSDirectory) using NIO. It allows multiple + /// threads to read from the same file concurrently. It is not recommended on Windows because of a bug in the SUN Java + /// implementation and disables some optimizations for heap memory usage. + /// /// public static StorageType Niofs { get; } = new StorageType("niofs"); /// - /// The MMap FS type stores the shard index on the file system (maps to Lucene MMapDirectory) by mapping a file into
memory (mmap). Memory mapping uses up a portion of the virtual memory address space in your process equal to the size
of the file being mapped. Before using this class, be sure you have allowed plenty of virtual address space. + /// + /// The MMap FS type stores the shard index on the file system (maps to Lucene MMapDirectory) by mapping a file into + /// memory (mmap). Memory mapping uses up a portion of the virtual memory address space in your process equal to the size + /// of the file being mapped. Before using this class, be sure you have allowed plenty of virtual address space. + /// /// public static StorageType Mmapfs { get; } = new StorageType("mmapfs"); /// - /// The hybridfs type is a hybrid of niofs and mmapfs, which chooses the best file system type for each type of file
based on the read access pattern. Currently only the Lucene term dictionary, norms and doc values files are memory
mapped. All other files are opened using Lucene NIOFSDirectory. Similarly to mmapfs be sure you have allowed
plenty of virtual address space. + /// + /// The hybridfs type is a hybrid of niofs and mmapfs, which chooses the best file system type for each type of file + /// based on the read access pattern. Currently only the Lucene term dictionary, norms and doc values files are memory + /// mapped. All other files are opened using Lucene NIOFSDirectory. Similarly to mmapfs be sure you have allowed + /// plenty of virtual address space. + /// /// public static StorageType Hybridfs { get; } = new StorageType("hybridfs"); /// - /// Default file system implementation. This will pick the best implementation depending on the operating environment, which
is currently hybridfs on all supported systems but is subject to change. + /// + /// Default file system implementation. This will pick the best implementation depending on the operating environment, which + /// is currently hybridfs on all supported systems but is subject to change. + /// /// public static StorageType Fs { get; } = new StorageType("fs"); @@ -603,12 +619,18 @@ public override void Write(Utf8JsonWriter writer, ShardRoutingState value, JsonS public enum TranslogDurability { /// - /// (default) fsync and commit after every request. In the event of hardware failure, all acknowledged writes
will already have been committed to disk. + /// + /// (default) fsync and commit after every request. In the event of hardware failure, all acknowledged writes + /// will already have been committed to disk. + /// /// [EnumMember(Value = "request")] Request, /// - /// fsync and commit in the background every sync_interval. In the event of a failure, all acknowledged writes
since the last automatic commit will be discarded. + /// + /// fsync and commit in the background every sync_interval. In the event of a failure, all acknowledged writes + /// since the last automatic commit will be discarded. + /// /// [EnumMember(Value = "async")] Async diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Ingest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Ingest.g.cs index acf10695d15..79956b3e4c1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Ingest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Ingest.g.cs @@ -109,12 +109,16 @@ public override void Write(Utf8JsonWriter writer, ConvertType value, JsonSeriali public enum JsonProcessorConflictStrategy { /// - /// Root fields that conflict with fields from the parsed JSON will be overridden. + /// + /// Root fields that conflict with fields from the parsed JSON will be overridden. + /// /// [EnumMember(Value = "replace")] Replace, /// - /// Conflicting fields will be merged. + /// + /// Conflicting fields will be merged. + /// /// [EnumMember(Value = "merge")] Merge diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.MachineLearning.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.MachineLearning.g.cs index 7eaa7b6d97b..bc9ef7c13fd 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.MachineLearning.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.MachineLearning.g.cs @@ -354,17 +354,23 @@ public override void Write(Utf8JsonWriter writer, DataframeState value, JsonSeri public enum DeploymentAllocationState { /// - /// Trained model deployment is starting but it is not yet deployed on any nodes. + /// + /// Trained model deployment is starting but it is not yet deployed on any nodes. + /// /// [EnumMember(Value = "starting")] Starting, /// - /// The trained model is started on at least one node. + /// + /// The trained model is started on at least one node. + /// /// [EnumMember(Value = "started")] Started, /// - /// Trained model deployment has started on all valid nodes. + /// + /// Trained model deployment has started on all valid nodes. + /// /// [EnumMember(Value = "fully_allocated")] FullyAllocated @@ -468,17 +474,23 @@ public override void Write(Utf8JsonWriter writer, DeploymentAssignmentState valu public enum DeploymentState { /// - /// The deployment is preparing to stop and deallocate the model from the relevant nodes. + /// + /// The deployment is preparing to stop and deallocate the model from the relevant nodes. + /// /// [EnumMember(Value = "stopping")] Stopping, /// - /// The deployment has recently started but is not yet usable; the model is not allocated on any nodes. + /// + /// The deployment has recently started but is not yet usable; the model is not allocated on any nodes. + /// /// [EnumMember(Value = "starting")] Starting, /// - /// The deployment is usable; at least one node has the model allocated. + /// + /// The deployment is usable; at least one node has the model allocated. + /// /// [EnumMember(Value = "started")] Started @@ -624,27 +636,42 @@ public override void Write(Utf8JsonWriter writer, FilterType value, JsonSerializ public enum Include { /// - /// Includes the total feature importance for the training data set. The
baseline and total feature importance values are returned in the metadata
field in the response body. + /// + /// Includes the total feature importance for the training data set. The + /// baseline and total feature importance values are returned in the metadata + /// field in the response body. + /// /// [EnumMember(Value = "total_feature_importance")] TotalFeatureImportance, /// - /// Includes the information about hyperparameters used to train the model.
This information consists of the value, the absolute and relative
importance of the hyperparameter as well as an indicator of whether it was
specified by the user or tuned during hyperparameter optimization. + /// + /// Includes the information about hyperparameters used to train the model. + /// This information consists of the value, the absolute and relative + /// importance of the hyperparameter as well as an indicator of whether it was + /// specified by the user or tuned during hyperparameter optimization. + /// /// [EnumMember(Value = "hyperparameters")] Hyperparameters, /// - /// Includes the baseline for feature importance values. + /// + /// Includes the baseline for feature importance values. + /// /// [EnumMember(Value = "feature_importance_baseline")] FeatureImportanceBaseline, /// - /// Includes the model definition status. + /// + /// Includes the model definition status. + /// /// [EnumMember(Value = "definition_status")] DefinitionStatus, /// - /// Includes the model definition. + /// + /// Includes the model definition. + /// /// [EnumMember(Value = "definition")] Definition @@ -751,27 +778,40 @@ public override void Write(Utf8JsonWriter writer, JobBlockedReason value, JsonSe public enum JobState { /// - /// The job open action is in progress and has not yet completed. + /// + /// The job open action is in progress and has not yet completed. + /// /// [EnumMember(Value = "opening")] Opening, /// - /// The job is available to receive and process data. + /// + /// The job is available to receive and process data. + /// /// [EnumMember(Value = "opened")] Opened, /// - /// The job did not finish successfully due to an error.
This situation can occur due to invalid input data, a fatal error occurring during the analysis, or an external interaction such as the process being killed by the Linux out of memory (OOM) killer.
If the job had irrevocably failed, it must be force closed and then deleted.
If the datafeed can be corrected, the job can be closed and then re-opened. + /// + /// The job did not finish successfully due to an error. + /// This situation can occur due to invalid input data, a fatal error occurring during the analysis, or an external interaction such as the process being killed by the Linux out of memory (OOM) killer. + /// If the job had irrevocably failed, it must be force closed and then deleted. + /// If the datafeed can be corrected, the job can be closed and then re-opened. + /// /// [EnumMember(Value = "failed")] Failed, /// - /// The job close action is in progress and has not yet completed. A closing job cannot accept further data. + /// + /// The job close action is in progress and has not yet completed. A closing job cannot accept further data. + /// /// [EnumMember(Value = "closing")] Closing, /// - /// The job finished successfully with its model state persisted. The job must be opened before it can accept further data. + /// + /// The job finished successfully with its model state persisted. The job must be opened before it can accept further data. + /// /// [EnumMember(Value = "closed")] Closed @@ -878,27 +918,37 @@ public override void Write(Utf8JsonWriter writer, MemoryStatus value, JsonSerial public enum RoutingState { /// - /// The trained model is being deallocated from this node. + /// + /// The trained model is being deallocated from this node. + /// /// [EnumMember(Value = "stopping")] Stopping, /// - /// The trained model is fully deallocated from this node. + /// + /// The trained model is fully deallocated from this node. + /// /// [EnumMember(Value = "stopped")] Stopped, /// - /// The trained model is attempting to allocate on this node; inference requests are not yet accepted. + /// + /// The trained model is attempting to allocate on this node; inference requests are not yet accepted. + /// /// [EnumMember(Value = "starting")] Starting, /// - /// The trained model is allocated and ready to accept inference requests. + /// + /// The trained model is allocated and ready to accept inference requests. + /// /// [EnumMember(Value = "started")] Started, /// - /// The allocation attempt failed. + /// + /// The allocation attempt failed. + /// /// [EnumMember(Value = "failed")] Failed @@ -956,12 +1006,16 @@ public override void Write(Utf8JsonWriter writer, RoutingState value, JsonSerial public enum RuleAction { /// - /// The result will not be created. Unless you also specify `skip_model_update`, the model will be updated as usual with the corresponding series value. + /// + /// The result will not be created. Unless you also specify skip_model_update, the model will be updated as usual with the corresponding series value. + /// /// [EnumMember(Value = "skip_result")] SkipResult, /// - /// The value for that series will not be used to update the model. Unless you also specify `skip_result`, the results will be created as usual. This action is suitable when certain values are expected to be consistently anomalous and they affect the model in a way that negatively impacts the rest of the results. + /// + /// The value for that series will not be used to update the model. Unless you also specify skip_result, the results will be created as usual. This action is suitable when certain values are expected to be consistently anomalous and they affect the model in a way that negatively impacts the rest of the results. + /// /// [EnumMember(Value = "skip_model_update")] SkipModelUpdate @@ -1109,17 +1163,24 @@ public override void Write(Utf8JsonWriter writer, TokenizationTruncate value, Js public enum TrainedModelType { /// - /// The model definition is an ensemble model of decision trees. + /// + /// The model definition is an ensemble model of decision trees. + /// /// [EnumMember(Value = "tree_ensemble")] TreeEnsemble, /// - /// The stored definition is a PyTorch (specifically a TorchScript) model.
Currently only NLP models are supported. + /// + /// The stored definition is a PyTorch (specifically a TorchScript) model. + /// Currently only NLP models are supported. + /// /// [EnumMember(Value = "pytorch")] Pytorch, /// - /// A special type reserved for language identification models. + /// + /// A special type reserved for language identification models. + /// /// [EnumMember(Value = "lang_ident")] LangIdent diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Mapping.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Mapping.g.cs index a9baf1d67e6..22624d5e068 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Mapping.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Mapping.g.cs @@ -759,7 +759,10 @@ public override void Write(Utf8JsonWriter writer, RuntimeFieldType value, JsonSe public enum SourceFieldMode { /// - /// Instead of storing source documents on disk exactly as you send them,
Elasticsearch can reconstruct source content on the fly upon retrieval. + /// + /// Instead of storing source documents on disk exactly as you send them, + /// Elasticsearch can reconstruct source content on the fly upon retrieval. + /// /// [EnumMember(Value = "synthetic")] Synthetic, diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.NoNamespace.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.NoNamespace.g.cs index 7445bf9f0e3..d44b52c36e8 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.NoNamespace.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.NoNamespace.g.cs @@ -158,12 +158,16 @@ public override void Write(Utf8JsonWriter writer, ClusterSearchStatus value, Jso public enum Conflicts { /// - /// Continue reindexing even if there are conflicts. + /// + /// Continue reindexing even if there are conflicts. + /// /// [EnumMember(Value = "proceed")] Proceed, /// - /// Stop reindexing if there are conflicts. + /// + /// Stop reindexing if there are conflicts. + /// /// [EnumMember(Value = "abort")] Abort @@ -472,27 +476,37 @@ public override void Write(Utf8JsonWriter writer, DistanceUnit value, JsonSerial public enum ExpandWildcard { /// - /// Match open, non-hidden indices. Also matches any non-hidden data stream. + /// + /// Match open, non-hidden indices. Also matches any non-hidden data stream. + /// /// [EnumMember(Value = "open")] Open, /// - /// Wildcard expressions are not accepted. + /// + /// Wildcard expressions are not accepted. + /// /// [EnumMember(Value = "none")] None, /// - /// Match hidden data streams and hidden indices. Must be combined with open, closed, or both. + /// + /// Match hidden data streams and hidden indices. Must be combined with open, closed, or both. + /// /// [EnumMember(Value = "hidden")] Hidden, /// - /// Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. + /// + /// Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. + /// /// [EnumMember(Value = "closed")] Closed, /// - /// Match any data stream or index, including hidden ones. + /// + /// Match any data stream or index, including hidden ones. + /// /// [EnumMember(Value = "all")] All @@ -606,12 +620,16 @@ public override void Write(Utf8JsonWriter writer, FieldSortNumericType value, Js public enum GeoDistanceType { /// - /// The `plane` calculation is faster but less accurate. + /// + /// The plane calculation is faster but less accurate. + /// /// [EnumMember(Value = "plane")] Plane, /// - /// The `arc` calculation is the most accurate. + /// + /// The arc calculation is the most accurate. + /// /// [EnumMember(Value = "arc")] Arc @@ -654,22 +672,31 @@ public override void Write(Utf8JsonWriter writer, GeoDistanceType value, JsonSer public enum GeoShapeRelation { /// - /// Return all documents whose `geo_shape` or `geo_point` field is within the query geometry.
Line geometries are not supported. + /// + /// Return all documents whose geo_shape or geo_point field is within the query geometry. + /// Line geometries are not supported. + /// /// [EnumMember(Value = "within")] Within, /// - /// Return all documents whose `geo_shape` or `geo_point` field intersects the query geometry. + /// + /// Return all documents whose geo_shape or geo_point field intersects the query geometry. + /// /// [EnumMember(Value = "intersects")] Intersects, /// - /// Return all documents whose `geo_shape` or `geo_point` field has nothing in common with the query geometry. + /// + /// Return all documents whose geo_shape or geo_point field has nothing in common with the query geometry. + /// /// [EnumMember(Value = "disjoint")] Disjoint, /// - /// Return all documents whose `geo_shape` or `geo_point` field contains the query geometry. + /// + /// Return all documents whose geo_shape or geo_point field contains the query geometry. + /// /// [EnumMember(Value = "contains")] Contains @@ -722,17 +749,23 @@ public override void Write(Utf8JsonWriter writer, GeoShapeRelation value, JsonSe public enum HealthStatus { /// - /// All primary shards are assigned, but one or more replica shards are unassigned. If a node in the cluster fails, some data could be unavailable until that node is repaired. + /// + /// All primary shards are assigned, but one or more replica shards are unassigned. If a node in the cluster fails, some data could be unavailable until that node is repaired. + /// /// [EnumMember(Value = "yellow")] Yellow, /// - /// One or more primary shards are unassigned, so some data is unavailable. This can occur briefly during cluster startup as primary shards are assigned. + /// + /// One or more primary shards are unassigned, so some data is unavailable. This can occur briefly during cluster startup as primary shards are assigned. + /// /// [EnumMember(Value = "red")] Red, /// - /// All shards are assigned. + /// + /// All shards are assigned. + /// /// [EnumMember(Value = "green")] Green @@ -1223,22 +1256,30 @@ public override void Write(Utf8JsonWriter writer, Result value, JsonSerializerOp public readonly string Value { get; } /// - /// Painless scripting language, purpose-built for Elasticsearch. + /// + /// Painless scripting language, purpose-built for Elasticsearch. + /// /// public static ScriptLanguage Painless { get; } = new ScriptLanguage("painless"); /// - /// Mustache templated, used for templates. + /// + /// Mustache templated, used for templates. + /// /// public static ScriptLanguage Mustache { get; } = new ScriptLanguage("mustache"); /// - /// Expert Java API + /// + /// Expert Java API + /// /// public static ScriptLanguage Java { get; } = new ScriptLanguage("java"); /// - /// Lucene’s expressions language, compiles a JavaScript expression to bytecode. + /// + /// Lucene’s expressions language, compiles a JavaScript expression to bytecode. + /// /// public static ScriptLanguage Expression { get; } = new ScriptLanguage("expression"); @@ -1308,12 +1349,16 @@ public override void Write(Utf8JsonWriter writer, ScriptSortType value, JsonSeri public enum SearchType { /// - /// Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate. + /// + /// Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate. + /// /// [EnumMember(Value = "query_then_fetch")] QueryThenFetch, /// - /// Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate. + /// + /// Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate. + /// /// [EnumMember(Value = "dfs_query_then_fetch")] DfsQueryThenFetch @@ -1356,7 +1401,9 @@ public override void Write(Utf8JsonWriter writer, SearchType value, JsonSerializ public enum SlicesCalculation { /// - /// Let Elasticsearch choose a reasonable number for most data streams and indices. + /// + /// Let Elasticsearch choose a reasonable number for most data streams and indices. + /// /// [EnumMember(Value = "auto")] Auto @@ -1457,12 +1504,16 @@ public override void Write(Utf8JsonWriter writer, SortMode value, JsonSerializer public enum SortOrder { /// - /// Descending (largest to smallest) + /// + /// Descending (largest to smallest) + /// /// [EnumMember(Value = "desc")] Desc, /// - /// Ascending (smallest to largest) + /// + /// Ascending (smallest to largest) + /// /// [EnumMember(Value = "asc")] Asc @@ -1505,17 +1556,23 @@ public override void Write(Utf8JsonWriter writer, SortOrder value, JsonSerialize public enum SuggestMode { /// - /// Only suggest terms that occur in more docs on the shard than the original term. + /// + /// Only suggest terms that occur in more docs on the shard than the original term. + /// /// [EnumMember(Value = "popular")] Popular, /// - /// Only generate suggestions for terms that are not in the shard. + /// + /// Only generate suggestions for terms that are not in the shard. + /// /// [EnumMember(Value = "missing")] Missing, /// - /// Suggest any matching suggestions based on terms in the suggest text. + /// + /// Suggest any matching suggestions based on terms in the suggest text. + /// /// [EnumMember(Value = "always")] Always @@ -1703,19 +1760,27 @@ public override void Write(Utf8JsonWriter writer, TimeUnit value, JsonSerializer public enum VersionType { /// - /// Use internal versioning that starts at 1 and increments with each update or delete. + /// + /// Use internal versioning that starts at 1 and increments with each update or delete. + /// /// [EnumMember(Value = "internal")] Internal, [EnumMember(Value = "force")] Force, /// - /// Only index the document if the given version is equal or higher than the version of the stored document or if there is no existing document.
Note: the external_gte version type is meant for special use cases and should be used with care.
If used incorrectly, it can result in loss of data. + /// + /// Only index the document if the given version is equal or higher than the version of the stored document or if there is no existing document. + /// Note: the external_gte version type is meant for special use cases and should be used with care. + /// If used incorrectly, it can result in loss of data. + /// /// [EnumMember(Value = "external_gte")] ExternalGte, /// - /// Only index the document if the given version is strictly higher than the version of the stored document or if there is no existing document. + /// + /// Only index the document if the given version is strictly higher than the version of the stored document or if there is no existing document. + /// /// [EnumMember(Value = "external")] External diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.QueryDsl.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.QueryDsl.g.cs index 0355cac3b29..e5e98a0d91a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.QueryDsl.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.QueryDsl.g.cs @@ -137,12 +137,16 @@ public override void Write(Utf8JsonWriter writer, CombinedFieldsOperator value, public enum CombinedFieldsZeroTerms { /// - /// No documents are returned if the analyzer removes all tokens. + /// + /// No documents are returned if the analyzer removes all tokens. + /// /// [EnumMember(Value = "none")] None, /// - /// Returns all documents, similar to a `match_all` query. + /// + /// Returns all documents, similar to a match_all query. + /// /// [EnumMember(Value = "all")] All @@ -185,52 +189,74 @@ public override void Write(Utf8JsonWriter writer, CombinedFieldsZeroTerms value, public enum FieldValueFactorModifier { /// - /// Square the field value (multiply it by itself). + /// + /// Square the field value (multiply it by itself). + /// /// [EnumMember(Value = "square")] Square, /// - /// Take the square root of the field value. + /// + /// Take the square root of the field value. + /// /// [EnumMember(Value = "sqrt")] Sqrt, /// - /// Reciprocate the field value, same as `1/x` where `x` is the field’s value. + /// + /// Reciprocate the field value, same as 1/x where x is the field’s value. + /// /// [EnumMember(Value = "reciprocal")] Reciprocal, /// - /// Do not apply any multiplier to the field value. + /// + /// Do not apply any multiplier to the field value. + /// /// [EnumMember(Value = "none")] None, /// - /// Add 2 to the field value and take the common logarithm. + /// + /// Add 2 to the field value and take the common logarithm. + /// /// [EnumMember(Value = "log2p")] Log2p, /// - /// Add 1 to the field value and take the common logarithm. + /// + /// Add 1 to the field value and take the common logarithm. + /// /// [EnumMember(Value = "log1p")] Log1p, /// - /// Take the common logarithm of the field value.
Because this function will return a negative value and cause an error if used on values between 0 and 1, it is recommended to use `log1p` instead. + /// + /// Take the common logarithm of the field value. + /// Because this function will return a negative value and cause an error if used on values between 0 and 1, it is recommended to use log1p instead. + /// /// [EnumMember(Value = "log")] Log, /// - /// Add 2 to the field value and take the natural logarithm. + /// + /// Add 2 to the field value and take the natural logarithm. + /// /// [EnumMember(Value = "ln2p")] Ln2p, /// - /// Add 1 to the field value and take the natural logarithm. + /// + /// Add 1 to the field value and take the natural logarithm. + /// /// [EnumMember(Value = "ln1p")] Ln1p, /// - /// Take the natural logarithm of the field value.
Because this function will return a negative value and cause an error if used on values between 0 and 1, it is recommended to use `ln1p` instead. + /// + /// Take the natural logarithm of the field value. + /// Because this function will return a negative value and cause an error if used on values between 0 and 1, it is recommended to use ln1p instead. + /// /// [EnumMember(Value = "ln")] Ln @@ -313,32 +339,45 @@ public override void Write(Utf8JsonWriter writer, FieldValueFactorModifier value public enum FunctionBoostMode { /// - /// Query score and function score are added + /// + /// Query score and function score are added + /// /// [EnumMember(Value = "sum")] Sum, /// - /// Only the function score is used.
The query score is ignored. + /// + /// Only the function score is used. + /// The query score is ignored. + /// /// [EnumMember(Value = "replace")] Replace, /// - /// Query score and function score are multiplied + /// + /// Query score and function score are multiplied + /// /// [EnumMember(Value = "multiply")] Multiply, /// - /// Min of query score and function score + /// + /// Min of query score and function score + /// /// [EnumMember(Value = "min")] Min, /// - /// Max of query score and function score + /// + /// Max of query score and function score + /// /// [EnumMember(Value = "max")] Max, /// - /// Query score and function score are averaged + /// + /// Query score and function score are averaged + /// /// [EnumMember(Value = "avg")] Avg @@ -401,32 +440,44 @@ public override void Write(Utf8JsonWriter writer, FunctionBoostMode value, JsonS public enum FunctionScoreMode { /// - /// Scores are summed. + /// + /// Scores are summed. + /// /// [EnumMember(Value = "sum")] Sum, /// - /// Scores are multiplied. + /// + /// Scores are multiplied. + /// /// [EnumMember(Value = "multiply")] Multiply, /// - /// Minimum score is used. + /// + /// Minimum score is used. + /// /// [EnumMember(Value = "min")] Min, /// - /// Maximum score is used. + /// + /// Maximum score is used. + /// /// [EnumMember(Value = "max")] Max, /// - /// The first function that has a matching filter is applied. + /// + /// The first function that has a matching filter is applied. + /// /// [EnumMember(Value = "first")] First, /// - /// Scores are averaged. + /// + /// Scores are averaged. + /// /// [EnumMember(Value = "avg")] Avg @@ -491,12 +542,16 @@ public enum GeoValidationMethod [EnumMember(Value = "strict")] Strict, /// - /// Accept geo points with invalid latitude or longitude. + /// + /// Accept geo points with invalid latitude or longitude. + /// /// [EnumMember(Value = "ignore_malformed")] IgnoreMalformed, /// - /// Accept geo points with invalid latitude or longitude and additionally try and infer correct coordinates. + /// + /// Accept geo points with invalid latitude or longitude and additionally try and infer correct coordinates. + /// /// [EnumMember(Value = "coerce")] Coerce @@ -544,22 +599,30 @@ public override void Write(Utf8JsonWriter writer, GeoValidationMethod value, Jso public enum MultiValueMode { /// - /// Distance is the sum of all distances. + /// + /// Distance is the sum of all distances. + /// /// [EnumMember(Value = "sum")] Sum, /// - /// Distance is the minimum distance. + /// + /// Distance is the minimum distance. + /// /// [EnumMember(Value = "min")] Min, /// - /// Distance is the maximum distance. + /// + /// Distance is the maximum distance. + /// /// [EnumMember(Value = "max")] Max, /// - /// Distance is the average distance. + /// + /// Distance is the average distance. + /// /// [EnumMember(Value = "avg")] Avg @@ -656,17 +719,23 @@ public override void Write(Utf8JsonWriter writer, Operator value, JsonSerializer public enum RangeRelation { /// - /// Matches documents with a range field value entirely within the query’s range. + /// + /// Matches documents with a range field value entirely within the query’s range. + /// /// [EnumMember(Value = "within")] Within, /// - /// Matches documents with a range field value that intersects the query’s range. + /// + /// Matches documents with a range field value that intersects the query’s range. + /// /// [EnumMember(Value = "intersects")] Intersects, /// - /// Matches documents with a range field value that entirely contains the query’s range. + /// + /// Matches documents with a range field value that entirely contains the query’s range. + /// /// [EnumMember(Value = "contains")] Contains @@ -715,67 +784,95 @@ public override void Write(Utf8JsonWriter writer, RangeRelation value, JsonSeria public enum SimpleQueryStringFlag { /// - /// Enables whitespace as split characters. + /// + /// Enables whitespace as split characters. + /// /// [EnumMember(Value = "WHITESPACE")] Whitespace = 1 << 0, /// - /// Enables the `~N` operator, after a phrase where `N` is maximum number of positions allowed between matching tokens.
Synonymous to `NEAR`. + /// + /// Enables the ~N operator, after a phrase where N is maximum number of positions allowed between matching tokens. + /// Synonymous to NEAR. + /// /// [EnumMember(Value = "SLOP")] Slop = 1 << 1, /// - /// Enables the `*` prefix operator. + /// + /// Enables the * prefix operator. + /// /// [EnumMember(Value = "PREFIX")] Prefix = 1 << 2, /// - /// Enables the `(` and `)` operators to control operator precedence. + /// + /// Enables the ( and ) operators to control operator precedence. + /// /// [EnumMember(Value = "PRECEDENCE")] Precedence = 1 << 3, /// - /// Enables the `"` quotes operator used to search for phrases. + /// + /// Enables the " quotes operator used to search for phrases. + /// /// [EnumMember(Value = "PHRASE")] Phrase = 1 << 4, /// - /// Enables the `\|` OR operator. + /// + /// Enables the \| OR operator. + /// /// [EnumMember(Value = "OR")] Or = 1 << 5, /// - /// Enables the `-` NOT operator. + /// + /// Enables the - NOT operator. + /// /// [EnumMember(Value = "NOT")] Not = 1 << 6, /// - /// Disables all operators. + /// + /// Disables all operators. + /// /// [EnumMember(Value = "NONE")] None = 1 << 7, /// - /// Enables the `~N` operator, after a phrase where `N` is the maximum number of positions allowed between matching tokens.
Synonymous to `SLOP`. + /// + /// Enables the ~N operator, after a phrase where N is the maximum number of positions allowed between matching tokens. + /// Synonymous to SLOP. + /// /// [EnumMember(Value = "NEAR")] Near = 1 << 8, /// - /// Enables the `~N` operator after a word, where `N` is an integer denoting the allowed edit distance for matching. + /// + /// Enables the ~N operator after a word, where N is an integer denoting the allowed edit distance for matching. + /// /// [EnumMember(Value = "FUZZY")] Fuzzy = 1 << 9, /// - /// Enables `\` as an escape character. + /// + /// Enables \ as an escape character. + /// /// [EnumMember(Value = "ESCAPE")] Escape = 1 << 10, /// - /// Enables the `+` AND operator. + /// + /// Enables the + AND operator. + /// /// [EnumMember(Value = "AND")] And = 1 << 11, /// - /// Enables all optional operators. + /// + /// Enables all optional operators. + /// /// [EnumMember(Value = "ALL")] All = 1 << 12 @@ -867,32 +964,45 @@ public override void Write(Utf8JsonWriter writer, SimpleQueryStringFlag value, J public enum TextQueryType { /// - /// Runs a `match_phrase_prefix` query on each field and uses the `_score` from the best field. + /// + /// Runs a match_phrase_prefix query on each field and uses the _score from the best field. + /// /// [EnumMember(Value = "phrase_prefix")] PhrasePrefix, /// - /// Runs a `match_phrase` query on each field and uses the `_score` from the best field. + /// + /// Runs a match_phrase query on each field and uses the _score from the best field. + /// /// [EnumMember(Value = "phrase")] Phrase, /// - /// Finds documents that match any field and combines the `_score` from each field. + /// + /// Finds documents that match any field and combines the _score from each field. + /// /// [EnumMember(Value = "most_fields")] MostFields, /// - /// Treats fields with the same analyzer as though they were one big field.
Looks for each word in any field. + /// + /// Treats fields with the same analyzer as though they were one big field. + /// Looks for each word in any field. + /// /// [EnumMember(Value = "cross_fields")] CrossFields, /// - /// Creates a `match_bool_prefix` query on each field and combines the `_score` from each field. + /// + /// Creates a match_bool_prefix query on each field and combines the _score from each field. + /// /// [EnumMember(Value = "bool_prefix")] BoolPrefix, /// - /// Finds documents that match any field, but uses the `_score` from the best field. + /// + /// Finds documents that match any field, but uses the _score from the best field. + /// /// [EnumMember(Value = "best_fields")] BestFields @@ -955,12 +1065,16 @@ public override void Write(Utf8JsonWriter writer, TextQueryType value, JsonSeria public enum ZeroTermsQuery { /// - /// No documents are returned if the `analyzer` removes all tokens. + /// + /// No documents are returned if the analyzer removes all tokens. + /// /// [EnumMember(Value = "none")] None, /// - /// Returns all documents, similar to a `match_all` query. + /// + /// Returns all documents, similar to a match_all query. + /// /// [EnumMember(Value = "all")] All diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Snapshot.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Snapshot.g.cs index c5bb292c907..0d7094311a0 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Snapshot.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Snapshot.g.cs @@ -32,27 +32,37 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Snapshot; public enum ShardsStatsStage { /// - /// Number of shards in the snapshot that are in the started stage of being stored in the repository. + /// + /// Number of shards in the snapshot that are in the started stage of being stored in the repository. + /// /// [EnumMember(Value = "STARTED")] Started, /// - /// Number of shards in the snapshot that are in the initializing stage of being stored in the repository. + /// + /// Number of shards in the snapshot that are in the initializing stage of being stored in the repository. + /// /// [EnumMember(Value = "INIT")] Init, /// - /// Number of shards in the snapshot that are in the finalizing stage of being stored in the repository. + /// + /// Number of shards in the snapshot that are in the finalizing stage of being stored in the repository. + /// /// [EnumMember(Value = "FINALIZE")] Finalize, /// - /// Number of shards in the snapshot that were not successfully stored in the repository. + /// + /// Number of shards in the snapshot that were not successfully stored in the repository. + /// /// [EnumMember(Value = "FAILURE")] Failure, /// - /// Number of shards in the snapshot that were successfully stored in the repository. + /// + /// Number of shards in the snapshot that were successfully stored in the repository. + /// /// [EnumMember(Value = "DONE")] Done diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Eql/EqlHits.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Eql/EqlHits.g.cs index 7a4ec3db0c5..72efe9c0cc7 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Eql/EqlHits.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Eql/EqlHits.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Eql; public sealed partial class EqlHits { /// - /// Contains events matching the query. Each object represents a matching event. + /// + /// Contains events matching the query. Each object represents a matching event. + /// /// [JsonInclude, JsonPropertyName("events")] public IReadOnlyCollection>? Events { get; init; } /// - /// Contains event sequences matching the query. Each object represents a matching sequence. This parameter is only returned for EQL queries containing a sequence. + /// + /// Contains event sequences matching the query. Each object represents a matching sequence. This parameter is only returned for EQL queries containing a sequence. + /// /// [JsonInclude, JsonPropertyName("sequences")] public IReadOnlyCollection>? Sequences { get; init; } /// - /// Metadata about the number of matching events or sequences. + /// + /// Metadata about the number of matching events or sequences. + /// /// [JsonInclude, JsonPropertyName("total")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.TotalHits? Total { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Eql/HitsEvent.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Eql/HitsEvent.g.cs index 7f845dcd99b..5614df40669 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Eql/HitsEvent.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Eql/HitsEvent.g.cs @@ -34,25 +34,33 @@ public sealed partial class HitsEvent public IReadOnlyDictionary>? Fields { get; init; } /// - /// Unique identifier for the event. This ID is only unique within the index. + /// + /// Unique identifier for the event. This ID is only unique within the index. + /// /// [JsonInclude, JsonPropertyName("_id")] public string Id { get; init; } /// - /// Name of the index containing the event. + /// + /// Name of the index containing the event. + /// /// [JsonInclude, JsonPropertyName("_index")] public string Index { get; init; } /// - /// Set to `true` for events in a timespan-constrained sequence that do not meet a given condition. + /// + /// Set to true for events in a timespan-constrained sequence that do not meet a given condition. + /// /// [JsonInclude, JsonPropertyName("missing")] public bool? Missing { get; init; } /// - /// Original JSON body passed for the event at index time. + /// + /// Original JSON body passed for the event at index time. + /// /// [JsonInclude, JsonPropertyName("_source")] [SourceConverter] diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Eql/HitsSequence.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Eql/HitsSequence.g.cs index 0f224ca4b16..db8772ee9ca 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Eql/HitsSequence.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Eql/HitsSequence.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Eql; public sealed partial class HitsSequence { /// - /// Contains events matching the query. Each object represents a matching event. + /// + /// Contains events matching the query. Each object represents a matching event. + /// /// [JsonInclude, JsonPropertyName("events")] public IReadOnlyCollection> Events { get; init; } /// - /// Shared field values used to constrain matches in the sequence. These are defined using the by keyword in the EQL query syntax. + /// + /// Shared field values used to constrain matches in the sequence. These are defined using the by keyword in the EQL query syntax. + /// /// [JsonInclude, JsonPropertyName("join_keys")] public IReadOnlyCollection? JoinKeys { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/ErrorCause.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/ErrorCause.g.cs index b887b4162b3..f5aa3c93f05 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/ErrorCause.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/ErrorCause.g.cs @@ -97,7 +97,10 @@ public override void Write(Utf8JsonWriter writer, ErrorCause value, JsonSerializ } /// -/// Cause and details about a request failure. This class defines the properties common to all error types.
Additional details are also provided, that depend on the error type. +/// +/// Cause and details about a request failure. This class defines the properties common to all error types. +/// Additional details are also provided, that depend on the error type. +/// /// [JsonConverter(typeof(ErrorCauseConverter))] public sealed partial class ErrorCause @@ -105,24 +108,32 @@ public sealed partial class ErrorCause public Elastic.Clients.Elasticsearch.Serverless.ErrorCause? CausedBy { get; init; } /// - /// Additional details about the error + /// + /// Additional details about the error + /// /// public IReadOnlyDictionary Metadata { get; init; } /// - /// A human-readable explanation of the error, in english + /// + /// A human-readable explanation of the error, in english + /// /// public string? Reason { get; init; } public IReadOnlyCollection? RootCause { get; init; } /// - /// The server stack trace. Present only if the `error_trace=true` parameter was sent with the request. + /// + /// The server stack trace. Present only if the error_trace=true parameter was sent with the request. + /// /// public string? StackTrace { get; init; } public IReadOnlyCollection? Suppressed { get; init; } /// - /// The type of error + /// + /// The type of error + /// /// public string Type { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/ErrorResponseBase.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/ErrorResponseBase.g.cs index 8fbc5e9c6a1..0bf6505243d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/ErrorResponseBase.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/ErrorResponseBase.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless; /// -/// The response returned by Elasticsearch when request execution did not succeed. +/// +/// The response returned by Elasticsearch when request execution did not succeed. +/// /// public sealed partial class ErrorResponseBase { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/GeoBounds.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/GeoBounds.g.cs index 43284d37d75..b8a34bb8503 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/GeoBounds.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/GeoBounds.g.cs @@ -31,7 +31,31 @@ namespace Elastic.Clients.Elasticsearch.Serverless; /// -/// A geo bounding box. It can be represented in various ways:
- as 4 top/bottom/left/right coordinates
- as 2 top_left / bottom_right points
- as 2 top_right / bottom_left points
- as a WKT bounding box +/// +/// A geo bounding box. It can be represented in various ways: +/// +/// +/// +/// +/// as 4 top/bottom/left/right coordinates +/// +/// +/// +/// +/// as 2 top_left / bottom_right points +/// +/// +/// +/// +/// as 2 top_right / bottom_left points +/// +/// +/// +/// +/// as a WKT bounding box +/// +/// +/// /// [JsonConverter(typeof(GeoBoundsConverter))] public sealed partial class GeoBounds : IComplexUnion diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/GeoLine.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/GeoLine.g.cs index b2e1fb20077..5eed9e2f8a1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/GeoLine.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/GeoLine.g.cs @@ -28,18 +28,24 @@ namespace Elastic.Clients.Elasticsearch.Serverless; /// -/// A GeoJson GeoLine. +/// +/// A GeoJson GeoLine. +/// /// public sealed partial class GeoLine { /// - /// Array of `[lon, lat]` coordinates + /// + /// Array of [lon, lat] coordinates + /// /// [JsonInclude, JsonPropertyName("coordinates")] public IReadOnlyCollection> Coordinates { get; init; } /// - /// Always `"LineString"` + /// + /// Always "LineString" + /// /// [JsonInclude, JsonPropertyName("type")] public string Type { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/GeoLocation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/GeoLocation.g.cs index 21fdce2ed75..dcf1bc9a0b3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/GeoLocation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/GeoLocation.g.cs @@ -31,7 +31,31 @@ namespace Elastic.Clients.Elasticsearch.Serverless; /// -/// A latitude/longitude as a 2 dimensional point. It can be represented in various ways:
- as a `{lat, long}` object
- as a geo hash value
- as a `[lon, lat]` array
- as a string in `", "` or WKT point formats +/// +/// A latitude/longitude as a 2 dimensional point. It can be represented in various ways: +/// +/// +/// +/// +/// as a {lat, long} object +/// +/// +/// +/// +/// as a geo hash value +/// +/// +/// +/// +/// as a [lon, lat] array +/// +/// +/// +/// +/// as a string in "<lat>, <lon>" or WKT point formats +/// +/// +/// /// [JsonConverter(typeof(GeoLocationConverter))] public sealed partial class GeoLocation : IComplexUnion diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/GeohashPrecision.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/GeohashPrecision.g.cs index 3bd5a377ab2..e9e49928d87 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/GeohashPrecision.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/GeohashPrecision.g.cs @@ -31,7 +31,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless; /// -/// A precision that can be expressed as a geohash length between 1 and 12, or a distance measure like "1km", "10m". +/// +/// A precision that can be expressed as a geohash length between 1 and 12, or a distance measure like "1km", "10m". +/// /// public sealed partial class GeohashPrecision : Union { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Graph/ExploreControls.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Graph/ExploreControls.g.cs index c6a2d31e7c0..7ce7756ed12 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Graph/ExploreControls.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Graph/ExploreControls.g.cs @@ -30,25 +30,39 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Graph; public sealed partial class ExploreControls { /// - /// To avoid the top-matching documents sample being dominated by a single source of results, it is sometimes necessary to request diversity in the sample.
You can do this by selecting a single-value field and setting a maximum number of documents per value for that field. + /// + /// To avoid the top-matching documents sample being dominated by a single source of results, it is sometimes necessary to request diversity in the sample. + /// You can do this by selecting a single-value field and setting a maximum number of documents per value for that field. + /// /// [JsonInclude, JsonPropertyName("sample_diversity")] public Elastic.Clients.Elasticsearch.Serverless.Graph.SampleDiversity? SampleDiversity { get; set; } /// - /// Each hop considers a sample of the best-matching documents on each shard.
Using samples improves the speed of execution and keeps exploration focused on meaningfully-connected terms.
Very small values (less than 50) might not provide sufficient weight-of-evidence to identify significant connections between terms.
Very large sample sizes can dilute the quality of the results and increase execution times. + /// + /// Each hop considers a sample of the best-matching documents on each shard. + /// Using samples improves the speed of execution and keeps exploration focused on meaningfully-connected terms. + /// Very small values (less than 50) might not provide sufficient weight-of-evidence to identify significant connections between terms. + /// Very large sample sizes can dilute the quality of the results and increase execution times. + /// /// [JsonInclude, JsonPropertyName("sample_size")] public int? SampleSize { get; set; } /// - /// The length of time in milliseconds after which exploration will be halted and the results gathered so far are returned.
This timeout is honored on a best-effort basis.
Execution might overrun this timeout if, for example, a long pause is encountered while FieldData is loaded for a field. + /// + /// The length of time in milliseconds after which exploration will be halted and the results gathered so far are returned. + /// This timeout is honored on a best-effort basis. + /// Execution might overrun this timeout if, for example, a long pause is encountered while FieldData is loaded for a field. + /// /// [JsonInclude, JsonPropertyName("timeout")] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get; set; } /// - /// Filters associated terms so only those that are significantly associated with your query are included. + /// + /// Filters associated terms so only those that are significantly associated with your query are included. + /// /// [JsonInclude, JsonPropertyName("use_significance")] public bool UseSignificance { get; set; } @@ -70,7 +84,10 @@ public ExploreControlsDescriptor() : base() private bool UseSignificanceValue { get; set; } /// - /// To avoid the top-matching documents sample being dominated by a single source of results, it is sometimes necessary to request diversity in the sample.
You can do this by selecting a single-value field and setting a maximum number of documents per value for that field. + /// + /// To avoid the top-matching documents sample being dominated by a single source of results, it is sometimes necessary to request diversity in the sample. + /// You can do this by selecting a single-value field and setting a maximum number of documents per value for that field. + /// /// public ExploreControlsDescriptor SampleDiversity(Elastic.Clients.Elasticsearch.Serverless.Graph.SampleDiversity? sampleDiversity) { @@ -97,7 +114,12 @@ public ExploreControlsDescriptor SampleDiversity(Action - /// Each hop considers a sample of the best-matching documents on each shard.
Using samples improves the speed of execution and keeps exploration focused on meaningfully-connected terms.
Very small values (less than 50) might not provide sufficient weight-of-evidence to identify significant connections between terms.
Very large sample sizes can dilute the quality of the results and increase execution times. + /// + /// Each hop considers a sample of the best-matching documents on each shard. + /// Using samples improves the speed of execution and keeps exploration focused on meaningfully-connected terms. + /// Very small values (less than 50) might not provide sufficient weight-of-evidence to identify significant connections between terms. + /// Very large sample sizes can dilute the quality of the results and increase execution times. + /// /// public ExploreControlsDescriptor SampleSize(int? sampleSize) { @@ -106,7 +128,11 @@ public ExploreControlsDescriptor SampleSize(int? sampleSize) } /// - /// The length of time in milliseconds after which exploration will be halted and the results gathered so far are returned.
This timeout is honored on a best-effort basis.
Execution might overrun this timeout if, for example, a long pause is encountered while FieldData is loaded for a field. + /// + /// The length of time in milliseconds after which exploration will be halted and the results gathered so far are returned. + /// This timeout is honored on a best-effort basis. + /// Execution might overrun this timeout if, for example, a long pause is encountered while FieldData is loaded for a field. + /// /// public ExploreControlsDescriptor Timeout(Elastic.Clients.Elasticsearch.Serverless.Duration? timeout) { @@ -115,7 +141,9 @@ public ExploreControlsDescriptor Timeout(Elastic.Clients.Elasticsearc } /// - /// Filters associated terms so only those that are significantly associated with your query are included. + /// + /// Filters associated terms so only those that are significantly associated with your query are included. + /// /// public ExploreControlsDescriptor UseSignificance(bool useSignificance = true) { @@ -176,7 +204,10 @@ public ExploreControlsDescriptor() : base() private bool UseSignificanceValue { get; set; } /// - /// To avoid the top-matching documents sample being dominated by a single source of results, it is sometimes necessary to request diversity in the sample.
You can do this by selecting a single-value field and setting a maximum number of documents per value for that field. + /// + /// To avoid the top-matching documents sample being dominated by a single source of results, it is sometimes necessary to request diversity in the sample. + /// You can do this by selecting a single-value field and setting a maximum number of documents per value for that field. + /// /// public ExploreControlsDescriptor SampleDiversity(Elastic.Clients.Elasticsearch.Serverless.Graph.SampleDiversity? sampleDiversity) { @@ -203,7 +234,12 @@ public ExploreControlsDescriptor SampleDiversity(Action - /// Each hop considers a sample of the best-matching documents on each shard.
Using samples improves the speed of execution and keeps exploration focused on meaningfully-connected terms.
Very small values (less than 50) might not provide sufficient weight-of-evidence to identify significant connections between terms.
Very large sample sizes can dilute the quality of the results and increase execution times. + /// + /// Each hop considers a sample of the best-matching documents on each shard. + /// Using samples improves the speed of execution and keeps exploration focused on meaningfully-connected terms. + /// Very small values (less than 50) might not provide sufficient weight-of-evidence to identify significant connections between terms. + /// Very large sample sizes can dilute the quality of the results and increase execution times. + /// /// public ExploreControlsDescriptor SampleSize(int? sampleSize) { @@ -212,7 +248,11 @@ public ExploreControlsDescriptor SampleSize(int? sampleSize) } /// - /// The length of time in milliseconds after which exploration will be halted and the results gathered so far are returned.
This timeout is honored on a best-effort basis.
Execution might overrun this timeout if, for example, a long pause is encountered while FieldData is loaded for a field. + /// + /// The length of time in milliseconds after which exploration will be halted and the results gathered so far are returned. + /// This timeout is honored on a best-effort basis. + /// Execution might overrun this timeout if, for example, a long pause is encountered while FieldData is loaded for a field. + /// /// public ExploreControlsDescriptor Timeout(Elastic.Clients.Elasticsearch.Serverless.Duration? timeout) { @@ -221,7 +261,9 @@ public ExploreControlsDescriptor Timeout(Elastic.Clients.Elasticsearch.Serverles } /// - /// Filters associated terms so only those that are significantly associated with your query are included. + /// + /// Filters associated terms so only those that are significantly associated with your query are included. + /// /// public ExploreControlsDescriptor UseSignificance(bool useSignificance = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Graph/Hop.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Graph/Hop.g.cs index a141ac52b7d..bc55d644b4f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Graph/Hop.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Graph/Hop.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Graph; public sealed partial class Hop { /// - /// Specifies one or more fields from which you want to extract terms that are associated with the specified vertices. + /// + /// Specifies one or more fields from which you want to extract terms that are associated with the specified vertices. + /// /// [JsonInclude, JsonPropertyName("connections")] public Elastic.Clients.Elasticsearch.Serverless.Graph.Hop? Connections { get; set; } /// - /// An optional guiding query that constrains the Graph API as it explores connected terms. + /// + /// An optional guiding query that constrains the Graph API as it explores connected terms. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query Query { get; set; } /// - /// Contains the fields you are interested in. + /// + /// Contains the fields you are interested in. + /// /// [JsonInclude, JsonPropertyName("vertices")] public ICollection Vertices { get; set; } @@ -68,7 +74,9 @@ public HopDescriptor() : base() private Action>[] VerticesDescriptorActions { get; set; } /// - /// Specifies one or more fields from which you want to extract terms that are associated with the specified vertices. + /// + /// Specifies one or more fields from which you want to extract terms that are associated with the specified vertices. + /// /// public HopDescriptor Connections(Elastic.Clients.Elasticsearch.Serverless.Graph.Hop? connections) { @@ -95,7 +103,9 @@ public HopDescriptor Connections(Action - /// An optional guiding query that constrains the Graph API as it explores connected terms. + /// + /// An optional guiding query that constrains the Graph API as it explores connected terms. + /// /// public HopDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query query) { @@ -122,7 +132,9 @@ public HopDescriptor Query(Action - /// Contains the fields you are interested in. + /// + /// Contains the fields you are interested in. + /// /// public HopDescriptor Vertices(ICollection vertices) { @@ -250,7 +262,9 @@ public HopDescriptor() : base() private Action[] VerticesDescriptorActions { get; set; } /// - /// Specifies one or more fields from which you want to extract terms that are associated with the specified vertices. + /// + /// Specifies one or more fields from which you want to extract terms that are associated with the specified vertices. + /// /// public HopDescriptor Connections(Elastic.Clients.Elasticsearch.Serverless.Graph.Hop? connections) { @@ -277,7 +291,9 @@ public HopDescriptor Connections(Action - /// An optional guiding query that constrains the Graph API as it explores connected terms. + /// + /// An optional guiding query that constrains the Graph API as it explores connected terms. + /// /// public HopDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query query) { @@ -304,7 +320,9 @@ public HopDescriptor Query(Action - /// Contains the fields you are interested in. + /// + /// Contains the fields you are interested in. + /// /// public HopDescriptor Vertices(ICollection vertices) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Graph/VertexDefinition.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Graph/VertexDefinition.g.cs index 43338811e74..7296fe76a63 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Graph/VertexDefinition.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Graph/VertexDefinition.g.cs @@ -30,37 +30,50 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Graph; public sealed partial class VertexDefinition { /// - /// Prevents the specified terms from being included in the results. + /// + /// Prevents the specified terms from being included in the results. + /// /// [JsonInclude, JsonPropertyName("exclude")] public ICollection? Exclude { get; set; } /// - /// Identifies a field in the documents of interest. + /// + /// Identifies a field in the documents of interest. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Identifies the terms of interest that form the starting points from which you want to spider out. + /// + /// Identifies the terms of interest that form the starting points from which you want to spider out. + /// /// [JsonInclude, JsonPropertyName("include")] public ICollection? Include { get; set; } /// - /// Specifies how many documents must contain a pair of terms before it is considered to be a useful connection.
This setting acts as a certainty threshold. + /// + /// Specifies how many documents must contain a pair of terms before it is considered to be a useful connection. + /// This setting acts as a certainty threshold. + /// /// [JsonInclude, JsonPropertyName("min_doc_count")] public long? MinDocCount { get; set; } /// - /// Controls how many documents on a particular shard have to contain a pair of terms before the connection is returned for global consideration. + /// + /// Controls how many documents on a particular shard have to contain a pair of terms before the connection is returned for global consideration. + /// /// [JsonInclude, JsonPropertyName("shard_min_doc_count")] public long? ShardMinDocCount { get; set; } /// - /// Specifies the maximum number of vertex terms returned for each field. + /// + /// Specifies the maximum number of vertex terms returned for each field. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } @@ -85,7 +98,9 @@ public VertexDefinitionDescriptor() : base() private int? SizeValue { get; set; } /// - /// Prevents the specified terms from being included in the results. + /// + /// Prevents the specified terms from being included in the results. + /// /// public VertexDefinitionDescriptor Exclude(ICollection? exclude) { @@ -94,7 +109,9 @@ public VertexDefinitionDescriptor Exclude(ICollection? exclud } /// - /// Identifies a field in the documents of interest. + /// + /// Identifies a field in the documents of interest. + /// /// public VertexDefinitionDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -103,7 +120,9 @@ public VertexDefinitionDescriptor Field(Elastic.Clients.Elasticsearch } /// - /// Identifies a field in the documents of interest. + /// + /// Identifies a field in the documents of interest. + /// /// public VertexDefinitionDescriptor Field(Expression> field) { @@ -112,7 +131,9 @@ public VertexDefinitionDescriptor Field(Expression - /// Identifies a field in the documents of interest. + /// + /// Identifies a field in the documents of interest. + /// /// public VertexDefinitionDescriptor Field(Expression> field) { @@ -121,7 +142,9 @@ public VertexDefinitionDescriptor Field(Expression - /// Identifies the terms of interest that form the starting points from which you want to spider out. + /// + /// Identifies the terms of interest that form the starting points from which you want to spider out. + /// /// public VertexDefinitionDescriptor Include(ICollection? include) { @@ -160,7 +183,10 @@ public VertexDefinitionDescriptor Include(params Action - /// Specifies how many documents must contain a pair of terms before it is considered to be a useful connection.
This setting acts as a certainty threshold. + /// + /// Specifies how many documents must contain a pair of terms before it is considered to be a useful connection. + /// This setting acts as a certainty threshold. + /// /// public VertexDefinitionDescriptor MinDocCount(long? minDocCount) { @@ -169,7 +195,9 @@ public VertexDefinitionDescriptor MinDocCount(long? minDocCount) } /// - /// Controls how many documents on a particular shard have to contain a pair of terms before the connection is returned for global consideration. + /// + /// Controls how many documents on a particular shard have to contain a pair of terms before the connection is returned for global consideration. + /// /// public VertexDefinitionDescriptor ShardMinDocCount(long? shardMinDocCount) { @@ -178,7 +206,9 @@ public VertexDefinitionDescriptor ShardMinDocCount(long? shardMinDocC } /// - /// Specifies the maximum number of vertex terms returned for each field. + /// + /// Specifies the maximum number of vertex terms returned for each field. + /// /// public VertexDefinitionDescriptor Size(int? size) { @@ -269,7 +299,9 @@ public VertexDefinitionDescriptor() : base() private int? SizeValue { get; set; } /// - /// Prevents the specified terms from being included in the results. + /// + /// Prevents the specified terms from being included in the results. + /// /// public VertexDefinitionDescriptor Exclude(ICollection? exclude) { @@ -278,7 +310,9 @@ public VertexDefinitionDescriptor Exclude(ICollection? exclude) } /// - /// Identifies a field in the documents of interest. + /// + /// Identifies a field in the documents of interest. + /// /// public VertexDefinitionDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -287,7 +321,9 @@ public VertexDefinitionDescriptor Field(Elastic.Clients.Elasticsearch.Serverless } /// - /// Identifies a field in the documents of interest. + /// + /// Identifies a field in the documents of interest. + /// /// public VertexDefinitionDescriptor Field(Expression> field) { @@ -296,7 +332,9 @@ public VertexDefinitionDescriptor Field(Expression - /// Identifies a field in the documents of interest. + /// + /// Identifies a field in the documents of interest. + /// /// public VertexDefinitionDescriptor Field(Expression> field) { @@ -305,7 +343,9 @@ public VertexDefinitionDescriptor Field(Expression - /// Identifies the terms of interest that form the starting points from which you want to spider out. + /// + /// Identifies the terms of interest that form the starting points from which you want to spider out. + /// /// public VertexDefinitionDescriptor Include(ICollection? include) { @@ -344,7 +384,10 @@ public VertexDefinitionDescriptor Include(params Action - /// Specifies how many documents must contain a pair of terms before it is considered to be a useful connection.
This setting acts as a certainty threshold. + /// + /// Specifies how many documents must contain a pair of terms before it is considered to be a useful connection. + /// This setting acts as a certainty threshold. + /// /// public VertexDefinitionDescriptor MinDocCount(long? minDocCount) { @@ -353,7 +396,9 @@ public VertexDefinitionDescriptor MinDocCount(long? minDocCount) } /// - /// Controls how many documents on a particular shard have to contain a pair of terms before the connection is returned for global consideration. + /// + /// Controls how many documents on a particular shard have to contain a pair of terms before the connection is returned for global consideration. + /// /// public VertexDefinitionDescriptor ShardMinDocCount(long? shardMinDocCount) { @@ -362,7 +407,9 @@ public VertexDefinitionDescriptor ShardMinDocCount(long? shardMinDocCount) } /// - /// Specifies the maximum number of vertex terms returned for each field. + /// + /// Specifies the maximum number of vertex terms returned for each field. + /// /// public VertexDefinitionDescriptor Size(int? size) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexLifecycleManagement/Actions.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexLifecycleManagement/Actions.g.cs index fc3d3ae94cc..6f11b17d11c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexLifecycleManagement/Actions.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexLifecycleManagement/Actions.g.cs @@ -30,73 +30,97 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexLifecycleManagement; public sealed partial class Actions { /// - /// Phases allowed: warm, cold. + /// + /// Phases allowed: warm, cold. + /// /// [JsonInclude, JsonPropertyName("allocate")] public Elastic.Clients.Elasticsearch.Serverless.IndexLifecycleManagement.AllocateAction? Allocate { get; init; } /// - /// Phases allowed: delete. + /// + /// Phases allowed: delete. + /// /// [JsonInclude, JsonPropertyName("delete")] public Elastic.Clients.Elasticsearch.Serverless.IndexLifecycleManagement.DeleteAction? Delete { get; init; } /// - /// Phases allowed: hot, warm, cold. + /// + /// Phases allowed: hot, warm, cold. + /// /// [JsonInclude, JsonPropertyName("downsample")] public Elastic.Clients.Elasticsearch.Serverless.IndexLifecycleManagement.DownsampleAction? Downsample { get; init; } /// - /// Phases allowed: hot, warm. + /// + /// Phases allowed: hot, warm. + /// /// [JsonInclude, JsonPropertyName("forcemerge")] public Elastic.Clients.Elasticsearch.Serverless.IndexLifecycleManagement.ForceMergeAction? Forcemerge { get; init; } /// - /// Phases allowed: warm, cold. + /// + /// Phases allowed: warm, cold. + /// /// [JsonInclude, JsonPropertyName("migrate")] public Elastic.Clients.Elasticsearch.Serverless.IndexLifecycleManagement.MigrateAction? Migrate { get; init; } /// - /// Phases allowed: hot, warm, cold. + /// + /// Phases allowed: hot, warm, cold. + /// /// [JsonInclude, JsonPropertyName("readonly")] public Elastic.Clients.Elasticsearch.Serverless.EmptyObject? Readonly { get; init; } /// - /// Phases allowed: hot. + /// + /// Phases allowed: hot. + /// /// [JsonInclude, JsonPropertyName("rollover")] public Elastic.Clients.Elasticsearch.Serverless.IndexLifecycleManagement.RolloverAction? Rollover { get; init; } /// - /// Phases allowed: hot, cold, frozen. + /// + /// Phases allowed: hot, cold, frozen. + /// /// [JsonInclude, JsonPropertyName("searchable_snapshot")] public Elastic.Clients.Elasticsearch.Serverless.IndexLifecycleManagement.SearchableSnapshotAction? SearchableSnapshot { get; init; } /// - /// Phases allowed: hot, warm, cold. + /// + /// Phases allowed: hot, warm, cold. + /// /// [JsonInclude, JsonPropertyName("set_priority")] public Elastic.Clients.Elasticsearch.Serverless.IndexLifecycleManagement.SetPriorityAction? SetPriority { get; init; } /// - /// Phases allowed: hot, warm. + /// + /// Phases allowed: hot, warm. + /// /// [JsonInclude, JsonPropertyName("shrink")] public Elastic.Clients.Elasticsearch.Serverless.IndexLifecycleManagement.ShrinkAction? Shrink { get; init; } /// - /// Phases allowed: hot, warm, cold, frozen. + /// + /// Phases allowed: hot, warm, cold, frozen. + /// /// [JsonInclude, JsonPropertyName("unfollow")] public Elastic.Clients.Elasticsearch.Serverless.EmptyObject? Unfollow { get; init; } /// - /// Phases allowed: delete. + /// + /// Phases allowed: delete. + /// /// [JsonInclude, JsonPropertyName("wait_for_snapshot")] public Elastic.Clients.Elasticsearch.Serverless.IndexLifecycleManagement.WaitForSnapshotAction? WaitForSnapshot { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/AddAction.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/AddAction.g.cs index b3c4017e047..b7b1346d94b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/AddAction.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/AddAction.g.cs @@ -30,68 +30,99 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class AddAction { /// - /// Alias for the action.
Index alias names support date math. + /// + /// Alias for the action. + /// Index alias names support date math. + /// /// [JsonInclude, JsonPropertyName("alias")] public Elastic.Clients.Elasticsearch.Serverless.IndexAlias? Alias { get; set; } /// - /// Aliases for the action.
Index alias names support date math. + /// + /// Aliases for the action. + /// Index alias names support date math. + /// /// [JsonInclude, JsonPropertyName("aliases")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.IndexAlias))] public ICollection? Aliases { get; set; } /// - /// Query used to limit documents the alias can access. + /// + /// Query used to limit documents the alias can access. + /// /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? Filter { get; set; } /// - /// Data stream or index for the action.
Supports wildcards (`*`). + /// + /// Data stream or index for the action. + /// Supports wildcards (*). + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.Serverless.IndexName? Index { get; set; } /// - /// Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations.
Data stream aliases don’t support this parameter. + /// + /// Value used to route indexing operations to a specific shard. + /// If specified, this overwrites the routing value for indexing operations. + /// Data stream aliases don’t support this parameter. + /// /// [JsonInclude, JsonPropertyName("index_routing")] public Elastic.Clients.Elasticsearch.Serverless.Routing? IndexRouting { get; set; } /// - /// Data streams or indices for the action.
Supports wildcards (`*`). + /// + /// Data streams or indices for the action. + /// Supports wildcards (*). + /// /// [JsonInclude, JsonPropertyName("indices")] public Elastic.Clients.Elasticsearch.Serverless.Indices? Indices { get; set; } /// - /// If `true`, the alias is hidden. + /// + /// If true, the alias is hidden. + /// /// [JsonInclude, JsonPropertyName("is_hidden")] public bool? IsHidden { get; set; } /// - /// If `true`, sets the write index or data stream for the alias. + /// + /// If true, sets the write index or data stream for the alias. + /// /// [JsonInclude, JsonPropertyName("is_write_index")] public bool? IsWriteIndex { get; set; } /// - /// If `true`, the alias must exist to perform the action. + /// + /// If true, the alias must exist to perform the action. + /// /// [JsonInclude, JsonPropertyName("must_exist")] public bool? MustExist { get; set; } /// - /// Value used to route indexing and search operations to a specific shard.
Data stream aliases don’t support this parameter. + /// + /// Value used to route indexing and search operations to a specific shard. + /// Data stream aliases don’t support this parameter. + /// /// [JsonInclude, JsonPropertyName("routing")] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get; set; } /// - /// Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations.
Data stream aliases don’t support this parameter. + /// + /// Value used to route search operations to a specific shard. + /// If specified, this overwrites the routing value for search operations. + /// Data stream aliases don’t support this parameter. + /// /// [JsonInclude, JsonPropertyName("search_routing")] public Elastic.Clients.Elasticsearch.Serverless.Routing? SearchRouting { get; set; } @@ -122,7 +153,10 @@ public AddActionDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Routing? SearchRoutingValue { get; set; } /// - /// Alias for the action.
Index alias names support date math. + /// + /// Alias for the action. + /// Index alias names support date math. + /// /// public AddActionDescriptor Alias(Elastic.Clients.Elasticsearch.Serverless.IndexAlias? alias) { @@ -131,7 +165,10 @@ public AddActionDescriptor Alias(Elastic.Clients.Elasticsearch.Server } /// - /// Aliases for the action.
Index alias names support date math. + /// + /// Aliases for the action. + /// Index alias names support date math. + /// /// public AddActionDescriptor Aliases(ICollection? aliases) { @@ -140,7 +177,9 @@ public AddActionDescriptor Aliases(ICollection - /// Query used to limit documents the alias can access. + /// + /// Query used to limit documents the alias can access. + /// /// public AddActionDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? filter) { @@ -167,7 +206,10 @@ public AddActionDescriptor Filter(Action - /// Data stream or index for the action.
Supports wildcards (`*`). + /// + /// Data stream or index for the action. + /// Supports wildcards (*). + /// /// public AddActionDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.IndexName? index) { @@ -176,7 +218,11 @@ public AddActionDescriptor Index(Elastic.Clients.Elasticsearch.Server } /// - /// Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations.
Data stream aliases don’t support this parameter. + /// + /// Value used to route indexing operations to a specific shard. + /// If specified, this overwrites the routing value for indexing operations. + /// Data stream aliases don’t support this parameter. + /// /// public AddActionDescriptor IndexRouting(Elastic.Clients.Elasticsearch.Serverless.Routing? indexRouting) { @@ -185,7 +231,10 @@ public AddActionDescriptor IndexRouting(Elastic.Clients.Elasticsearch } /// - /// Data streams or indices for the action.
Supports wildcards (`*`). + /// + /// Data streams or indices for the action. + /// Supports wildcards (*). + /// /// public AddActionDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.Indices? indices) { @@ -194,7 +243,9 @@ public AddActionDescriptor Indices(Elastic.Clients.Elasticsearch.Serv } /// - /// If `true`, the alias is hidden. + /// + /// If true, the alias is hidden. + /// /// public AddActionDescriptor IsHidden(bool? isHidden = true) { @@ -203,7 +254,9 @@ public AddActionDescriptor IsHidden(bool? isHidden = true) } /// - /// If `true`, sets the write index or data stream for the alias. + /// + /// If true, sets the write index or data stream for the alias. + /// /// public AddActionDescriptor IsWriteIndex(bool? isWriteIndex = true) { @@ -212,7 +265,9 @@ public AddActionDescriptor IsWriteIndex(bool? isWriteIndex = true) } /// - /// If `true`, the alias must exist to perform the action. + /// + /// If true, the alias must exist to perform the action. + /// /// public AddActionDescriptor MustExist(bool? mustExist = true) { @@ -221,7 +276,10 @@ public AddActionDescriptor MustExist(bool? mustExist = true) } /// - /// Value used to route indexing and search operations to a specific shard.
Data stream aliases don’t support this parameter. + /// + /// Value used to route indexing and search operations to a specific shard. + /// Data stream aliases don’t support this parameter. + /// /// public AddActionDescriptor Routing(Elastic.Clients.Elasticsearch.Serverless.Routing? routing) { @@ -230,7 +288,11 @@ public AddActionDescriptor Routing(Elastic.Clients.Elasticsearch.Serv } /// - /// Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations.
Data stream aliases don’t support this parameter. + /// + /// Value used to route search operations to a specific shard. + /// If specified, this overwrites the routing value for search operations. + /// Data stream aliases don’t support this parameter. + /// /// public AddActionDescriptor SearchRouting(Elastic.Clients.Elasticsearch.Serverless.Routing? searchRouting) { @@ -344,7 +406,10 @@ public AddActionDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Routing? SearchRoutingValue { get; set; } /// - /// Alias for the action.
Index alias names support date math. + /// + /// Alias for the action. + /// Index alias names support date math. + /// /// public AddActionDescriptor Alias(Elastic.Clients.Elasticsearch.Serverless.IndexAlias? alias) { @@ -353,7 +418,10 @@ public AddActionDescriptor Alias(Elastic.Clients.Elasticsearch.Serverless.IndexA } /// - /// Aliases for the action.
Index alias names support date math. + /// + /// Aliases for the action. + /// Index alias names support date math. + /// /// public AddActionDescriptor Aliases(ICollection? aliases) { @@ -362,7 +430,9 @@ public AddActionDescriptor Aliases(ICollection - /// Query used to limit documents the alias can access. + /// + /// Query used to limit documents the alias can access. + /// /// public AddActionDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? filter) { @@ -389,7 +459,10 @@ public AddActionDescriptor Filter(Action - /// Data stream or index for the action.
Supports wildcards (`*`). + /// + /// Data stream or index for the action. + /// Supports wildcards (*). + /// /// public AddActionDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.IndexName? index) { @@ -398,7 +471,11 @@ public AddActionDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.IndexN } /// - /// Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations.
Data stream aliases don’t support this parameter. + /// + /// Value used to route indexing operations to a specific shard. + /// If specified, this overwrites the routing value for indexing operations. + /// Data stream aliases don’t support this parameter. + /// /// public AddActionDescriptor IndexRouting(Elastic.Clients.Elasticsearch.Serverless.Routing? indexRouting) { @@ -407,7 +484,10 @@ public AddActionDescriptor IndexRouting(Elastic.Clients.Elasticsearch.Serverless } /// - /// Data streams or indices for the action.
Supports wildcards (`*`). + /// + /// Data streams or indices for the action. + /// Supports wildcards (*). + /// /// public AddActionDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.Indices? indices) { @@ -416,7 +496,9 @@ public AddActionDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.Indi } /// - /// If `true`, the alias is hidden. + /// + /// If true, the alias is hidden. + /// /// public AddActionDescriptor IsHidden(bool? isHidden = true) { @@ -425,7 +507,9 @@ public AddActionDescriptor IsHidden(bool? isHidden = true) } /// - /// If `true`, sets the write index or data stream for the alias. + /// + /// If true, sets the write index or data stream for the alias. + /// /// public AddActionDescriptor IsWriteIndex(bool? isWriteIndex = true) { @@ -434,7 +518,9 @@ public AddActionDescriptor IsWriteIndex(bool? isWriteIndex = true) } /// - /// If `true`, the alias must exist to perform the action. + /// + /// If true, the alias must exist to perform the action. + /// /// public AddActionDescriptor MustExist(bool? mustExist = true) { @@ -443,7 +529,10 @@ public AddActionDescriptor MustExist(bool? mustExist = true) } /// - /// Value used to route indexing and search operations to a specific shard.
Data stream aliases don’t support this parameter. + /// + /// Value used to route indexing and search operations to a specific shard. + /// Data stream aliases don’t support this parameter. + /// /// public AddActionDescriptor Routing(Elastic.Clients.Elasticsearch.Serverless.Routing? routing) { @@ -452,7 +541,11 @@ public AddActionDescriptor Routing(Elastic.Clients.Elasticsearch.Serverless.Rout } /// - /// Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations.
Data stream aliases don’t support this parameter. + /// + /// Value used to route search operations to a specific shard. + /// If specified, this overwrites the routing value for search operations. + /// Data stream aliases don’t support this parameter. + /// /// public AddActionDescriptor SearchRouting(Elastic.Clients.Elasticsearch.Serverless.Routing? searchRouting) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/Alias.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/Alias.g.cs index 85729426a1e..1d1675189b9 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/Alias.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/Alias.g.cs @@ -30,37 +30,52 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class Alias { /// - /// Query used to limit documents the alias can access. + /// + /// Query used to limit documents the alias can access. + /// /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? Filter { get; set; } /// - /// Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations. + /// + /// Value used to route indexing operations to a specific shard. + /// If specified, this overwrites the routing value for indexing operations. + /// /// [JsonInclude, JsonPropertyName("index_routing")] public Elastic.Clients.Elasticsearch.Serverless.Routing? IndexRouting { get; set; } /// - /// If `true`, the alias is hidden.
All indices for the alias must have the same `is_hidden` value. + /// + /// If true, the alias is hidden. + /// All indices for the alias must have the same is_hidden value. + /// /// [JsonInclude, JsonPropertyName("is_hidden")] public bool? IsHidden { get; set; } /// - /// If `true`, the index is the write index for the alias. + /// + /// If true, the index is the write index for the alias. + /// /// [JsonInclude, JsonPropertyName("is_write_index")] public bool? IsWriteIndex { get; set; } /// - /// Value used to route indexing and search operations to a specific shard. + /// + /// Value used to route indexing and search operations to a specific shard. + /// /// [JsonInclude, JsonPropertyName("routing")] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get; set; } /// - /// Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations. + /// + /// Value used to route search operations to a specific shard. + /// If specified, this overwrites the routing value for search operations. + /// /// [JsonInclude, JsonPropertyName("search_routing")] public Elastic.Clients.Elasticsearch.Serverless.Routing? SearchRouting { get; set; } @@ -84,7 +99,9 @@ public AliasDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Routing? SearchRoutingValue { get; set; } /// - /// Query used to limit documents the alias can access. + /// + /// Query used to limit documents the alias can access. + /// /// public AliasDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? filter) { @@ -111,7 +128,10 @@ public AliasDescriptor Filter(Action - /// Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations. + /// + /// Value used to route indexing operations to a specific shard. + /// If specified, this overwrites the routing value for indexing operations. + /// /// public AliasDescriptor IndexRouting(Elastic.Clients.Elasticsearch.Serverless.Routing? indexRouting) { @@ -120,7 +140,10 @@ public AliasDescriptor IndexRouting(Elastic.Clients.Elasticsearch.Ser } /// - /// If `true`, the alias is hidden.
All indices for the alias must have the same `is_hidden` value. + /// + /// If true, the alias is hidden. + /// All indices for the alias must have the same is_hidden value. + /// /// public AliasDescriptor IsHidden(bool? isHidden = true) { @@ -129,7 +152,9 @@ public AliasDescriptor IsHidden(bool? isHidden = true) } /// - /// If `true`, the index is the write index for the alias. + /// + /// If true, the index is the write index for the alias. + /// /// public AliasDescriptor IsWriteIndex(bool? isWriteIndex = true) { @@ -138,7 +163,9 @@ public AliasDescriptor IsWriteIndex(bool? isWriteIndex = true) } /// - /// Value used to route indexing and search operations to a specific shard. + /// + /// Value used to route indexing and search operations to a specific shard. + /// /// public AliasDescriptor Routing(Elastic.Clients.Elasticsearch.Serverless.Routing? routing) { @@ -147,7 +174,10 @@ public AliasDescriptor Routing(Elastic.Clients.Elasticsearch.Serverle } /// - /// Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations. + /// + /// Value used to route search operations to a specific shard. + /// If specified, this overwrites the routing value for search operations. + /// /// public AliasDescriptor SearchRouting(Elastic.Clients.Elasticsearch.Serverless.Routing? searchRouting) { @@ -226,7 +256,9 @@ public AliasDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Routing? SearchRoutingValue { get; set; } /// - /// Query used to limit documents the alias can access. + /// + /// Query used to limit documents the alias can access. + /// /// public AliasDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? filter) { @@ -253,7 +285,10 @@ public AliasDescriptor Filter(Action - /// Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations. + /// + /// Value used to route indexing operations to a specific shard. + /// If specified, this overwrites the routing value for indexing operations. + /// /// public AliasDescriptor IndexRouting(Elastic.Clients.Elasticsearch.Serverless.Routing? indexRouting) { @@ -262,7 +297,10 @@ public AliasDescriptor IndexRouting(Elastic.Clients.Elasticsearch.Serverless.Rou } /// - /// If `true`, the alias is hidden.
All indices for the alias must have the same `is_hidden` value. + /// + /// If true, the alias is hidden. + /// All indices for the alias must have the same is_hidden value. + /// /// public AliasDescriptor IsHidden(bool? isHidden = true) { @@ -271,7 +309,9 @@ public AliasDescriptor IsHidden(bool? isHidden = true) } /// - /// If `true`, the index is the write index for the alias. + /// + /// If true, the index is the write index for the alias. + /// /// public AliasDescriptor IsWriteIndex(bool? isWriteIndex = true) { @@ -280,7 +320,9 @@ public AliasDescriptor IsWriteIndex(bool? isWriteIndex = true) } /// - /// Value used to route indexing and search operations to a specific shard. + /// + /// Value used to route indexing and search operations to a specific shard. + /// /// public AliasDescriptor Routing(Elastic.Clients.Elasticsearch.Serverless.Routing? routing) { @@ -289,7 +331,10 @@ public AliasDescriptor Routing(Elastic.Clients.Elasticsearch.Serverless.Routing? } /// - /// Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations. + /// + /// Value used to route search operations to a specific shard. + /// If specified, this overwrites the routing value for search operations. + /// /// public AliasDescriptor SearchRouting(Elastic.Clients.Elasticsearch.Serverless.Routing? searchRouting) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/AliasDefinition.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/AliasDefinition.g.cs index 3084def3137..1a33c027bda 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/AliasDefinition.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/AliasDefinition.g.cs @@ -30,37 +30,52 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class AliasDefinition { /// - /// Query used to limit documents the alias can access. + /// + /// Query used to limit documents the alias can access. + /// /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? Filter { get; init; } /// - /// Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations. + /// + /// Value used to route indexing operations to a specific shard. + /// If specified, this overwrites the routing value for indexing operations. + /// /// [JsonInclude, JsonPropertyName("index_routing")] public string? IndexRouting { get; init; } /// - /// If `true`, the alias is hidden.
All indices for the alias must have the same `is_hidden` value. + /// + /// If true, the alias is hidden. + /// All indices for the alias must have the same is_hidden value. + /// /// [JsonInclude, JsonPropertyName("is_hidden")] public bool? IsHidden { get; init; } /// - /// If `true`, the index is the write index for the alias. + /// + /// If true, the index is the write index for the alias. + /// /// [JsonInclude, JsonPropertyName("is_write_index")] public bool? IsWriteIndex { get; init; } /// - /// Value used to route indexing and search operations to a specific shard. + /// + /// Value used to route indexing and search operations to a specific shard. + /// /// [JsonInclude, JsonPropertyName("routing")] public string? Routing { get; init; } /// - /// Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations. + /// + /// Value used to route search operations to a specific shard. + /// If specified, this overwrites the routing value for search operations. + /// /// [JsonInclude, JsonPropertyName("search_routing")] public string? SearchRouting { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStream.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStream.g.cs index 477c9728129..efc62d2ae0c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStream.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStream.g.cs @@ -30,91 +30,128 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class DataStream { /// - /// If `true`, the data stream allows custom routing on write request. + /// + /// If true, the data stream allows custom routing on write request. + /// /// [JsonInclude, JsonPropertyName("allow_custom_routing")] public bool? AllowCustomRouting { get; init; } /// - /// Current generation for the data stream. This number acts as a cumulative count of the stream’s rollovers, starting at 1. + /// + /// Current generation for the data stream. This number acts as a cumulative count of the stream’s rollovers, starting at 1. + /// /// [JsonInclude, JsonPropertyName("generation")] public int Generation { get; init; } /// - /// If `true`, the data stream is hidden. + /// + /// If true, the data stream is hidden. + /// /// [JsonInclude, JsonPropertyName("hidden")] public bool Hidden { get; init; } /// - /// Name of the current ILM lifecycle policy in the stream’s matching index template.
This lifecycle policy is set in the `index.lifecycle.name` setting.
If the template does not include a lifecycle policy, this property is not included in the response.
NOTE: A data stream’s backing indices may be assigned different lifecycle policies. To retrieve the lifecycle policy for individual backing indices, use the get index settings API. + /// + /// Name of the current ILM lifecycle policy in the stream’s matching index template. + /// This lifecycle policy is set in the index.lifecycle.name setting. + /// If the template does not include a lifecycle policy, this property is not included in the response. + /// NOTE: A data stream’s backing indices may be assigned different lifecycle policies. To retrieve the lifecycle policy for individual backing indices, use the get index settings API. + /// /// [JsonInclude, JsonPropertyName("ilm_policy")] public string? IlmPolicy { get; init; } /// - /// Array of objects containing information about the data stream’s backing indices.
The last item in this array contains information about the stream’s current write index. + /// + /// Array of objects containing information about the data stream’s backing indices. + /// The last item in this array contains information about the stream’s current write index. + /// /// [JsonInclude, JsonPropertyName("indices")] public IReadOnlyCollection Indices { get; init; } /// - /// Contains the configuration for the data stream lifecycle of this data stream. + /// + /// Contains the configuration for the data stream lifecycle of this data stream. + /// /// [JsonInclude, JsonPropertyName("lifecycle")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycleWithRollover? Lifecycle { get; init; } /// - /// Custom metadata for the stream, copied from the `_meta` object of the stream’s matching index template.
If empty, the response omits this property. + /// + /// Custom metadata for the stream, copied from the _meta object of the stream’s matching index template. + /// If empty, the response omits this property. + /// /// [JsonInclude, JsonPropertyName("_meta")] public IReadOnlyDictionary? Meta { get; init; } /// - /// Name of the data stream. + /// + /// Name of the data stream. + /// /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } /// - /// Name of the lifecycle system that'll manage the next generation of the data stream. + /// + /// Name of the lifecycle system that'll manage the next generation of the data stream. + /// /// [JsonInclude, JsonPropertyName("next_generation_managed_by")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.ManagedBy NextGenerationManagedBy { get; init; } /// - /// Indicates if ILM should take precedence over DSL in case both are configured to managed this data stream. + /// + /// Indicates if ILM should take precedence over DSL in case both are configured to managed this data stream. + /// /// [JsonInclude, JsonPropertyName("prefer_ilm")] public bool PreferIlm { get; init; } /// - /// If `true`, the data stream is created and managed by cross-cluster replication and the local cluster can not write into this data stream or change its mappings. + /// + /// If true, the data stream is created and managed by cross-cluster replication and the local cluster can not write into this data stream or change its mappings. + /// /// [JsonInclude, JsonPropertyName("replicated")] public bool? Replicated { get; init; } /// - /// Health status of the data stream.
This health status is based on the state of the primary and replica shards of the stream’s backing indices. + /// + /// Health status of the data stream. + /// This health status is based on the state of the primary and replica shards of the stream’s backing indices. + /// /// [JsonInclude, JsonPropertyName("status")] public Elastic.Clients.Elasticsearch.Serverless.HealthStatus Status { get; init; } /// - /// If `true`, the data stream is created and managed by an Elastic stack component and cannot be modified through normal user interaction. + /// + /// If true, the data stream is created and managed by an Elastic stack component and cannot be modified through normal user interaction. + /// /// [JsonInclude, JsonPropertyName("system")] public bool? System { get; init; } /// - /// Name of the index template used to create the data stream’s backing indices.
The template’s index pattern must match the name of this data stream. + /// + /// Name of the index template used to create the data stream’s backing indices. + /// The template’s index pattern must match the name of this data stream. + /// /// [JsonInclude, JsonPropertyName("template")] public string Template { get; init; } /// - /// Information about the `@timestamp` field in the data stream. + /// + /// Information about the @timestamp field in the data stream. + /// /// [JsonInclude, JsonPropertyName("timestamp_field")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamTimestampField TimestampField { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamIndex.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamIndex.g.cs index c9cc6589d7a..56f571033ad 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamIndex.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamIndex.g.cs @@ -30,31 +30,41 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class DataStreamIndex { /// - /// Name of the current ILM lifecycle policy configured for this backing index. + /// + /// Name of the current ILM lifecycle policy configured for this backing index. + /// /// [JsonInclude, JsonPropertyName("ilm_policy")] public string? IlmPolicy { get; init; } /// - /// Name of the backing index. + /// + /// Name of the backing index. + /// /// [JsonInclude, JsonPropertyName("index_name")] public string IndexName { get; init; } /// - /// Universally unique identifier (UUID) for the index. + /// + /// Universally unique identifier (UUID) for the index. + /// /// [JsonInclude, JsonPropertyName("index_uuid")] public string IndexUuid { get; init; } /// - /// Name of the lifecycle system that's currently managing this backing index. + /// + /// Name of the lifecycle system that's currently managing this backing index. + /// /// [JsonInclude, JsonPropertyName("managed_by")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.ManagedBy ManagedBy { get; init; } /// - /// Indicates if ILM should take precedence over DSL in case both are configured to manage this index. + /// + /// Indicates if ILM should take precedence over DSL in case both are configured to manage this index. + /// /// [JsonInclude, JsonPropertyName("prefer_ilm")] public bool PreferIlm { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamLifecycle.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamLifecycle.g.cs index 5aff2514d66..52d2669e5eb 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamLifecycle.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamLifecycle.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; /// -/// Data stream lifecycle denotes that a data stream is managed by the data stream lifecycle and contains the configuration. +/// +/// Data stream lifecycle denotes that a data stream is managed by the data stream lifecycle and contains the configuration. +/// /// public sealed partial class DataStreamLifecycle { @@ -39,7 +41,9 @@ public sealed partial class DataStreamLifecycle } /// -/// Data stream lifecycle denotes that a data stream is managed by the data stream lifecycle and contains the configuration. +/// +/// Data stream lifecycle denotes that a data stream is managed by the data stream lifecycle and contains the configuration. +/// /// public sealed partial class DataStreamLifecycleDescriptor : SerializableDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamLifecycleDownsampling.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamLifecycleDownsampling.g.cs index 298b03ac31d..1352b3aa6b5 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamLifecycleDownsampling.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamLifecycleDownsampling.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class DataStreamLifecycleDownsampling { /// - /// The list of downsampling rounds to execute as part of this downsampling configuration + /// + /// The list of downsampling rounds to execute as part of this downsampling configuration + /// /// [JsonInclude, JsonPropertyName("rounds")] public ICollection Rounds { get; set; } @@ -50,7 +52,9 @@ public DataStreamLifecycleDownsamplingDescriptor() : base() private Action[] RoundsDescriptorActions { get; set; } /// - /// The list of downsampling rounds to execute as part of this downsampling configuration + /// + /// The list of downsampling rounds to execute as part of this downsampling configuration + /// /// public DataStreamLifecycleDownsamplingDescriptor Rounds(ICollection rounds) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamLifecycleWithRollover.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamLifecycleWithRollover.g.cs index a14bd60d03e..b9ccfb7f5fc 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamLifecycleWithRollover.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamLifecycleWithRollover.g.cs @@ -28,24 +28,37 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; /// -/// Data stream lifecycle with rollover can be used to display the configuration including the default rollover conditions,
if asked. +/// +/// Data stream lifecycle with rollover can be used to display the configuration including the default rollover conditions, +/// if asked. +/// /// public sealed partial class DataStreamLifecycleWithRollover { /// - /// If defined, every document added to this data stream will be stored at least for this time frame.
Any time after this duration the document could be deleted.
When empty, every document in this data stream will be stored indefinitely. + /// + /// If defined, every document added to this data stream will be stored at least for this time frame. + /// Any time after this duration the document could be deleted. + /// When empty, every document in this data stream will be stored indefinitely. + /// /// [JsonInclude, JsonPropertyName("data_retention")] public Elastic.Clients.Elasticsearch.Serverless.Duration? DataRetention { get; init; } /// - /// The downsampling configuration to execute for the managed backing index after rollover. + /// + /// The downsampling configuration to execute for the managed backing index after rollover. + /// /// [JsonInclude, JsonPropertyName("downsampling")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycleDownsampling? Downsampling { get; init; } /// - /// The conditions which will trigger the rollover of a backing index as configured by the cluster setting `cluster.lifecycle.default.rollover`.
This property is an implementation detail and it will only be retrieved when the query param `include_defaults` is set to true.
The contents of this field are subject to change. + /// + /// The conditions which will trigger the rollover of a backing index as configured by the cluster setting cluster.lifecycle.default.rollover. + /// This property is an implementation detail and it will only be retrieved when the query param include_defaults is set to true. + /// The contents of this field are subject to change. + /// /// [JsonInclude, JsonPropertyName("rollover")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycleRolloverConditions? Rollover { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamTimestampField.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamTimestampField.g.cs index c1c73707383..b8ea21a678a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamTimestampField.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamTimestampField.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class DataStreamTimestampField { /// - /// Name of the timestamp field for the data stream, which must be `@timestamp`. The `@timestamp` field must be included in every document indexed to the data stream. + /// + /// Name of the timestamp field for the data stream, which must be @timestamp. The @timestamp field must be included in every document indexed to the data stream. + /// /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamsStatsItem.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamsStatsItem.g.cs index 7af1ae1aef3..0edca1b0b99 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamsStatsItem.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamsStatsItem.g.cs @@ -30,31 +30,46 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class DataStreamsStatsItem { /// - /// Current number of backing indices for the data stream. + /// + /// Current number of backing indices for the data stream. + /// /// [JsonInclude, JsonPropertyName("backing_indices")] public int BackingIndices { get; init; } /// - /// Name of the data stream. + /// + /// Name of the data stream. + /// /// [JsonInclude, JsonPropertyName("data_stream")] public string DataStream { get; init; } /// - /// The data stream’s highest `@timestamp` value, converted to milliseconds since the Unix epoch.
NOTE: This timestamp is provided as a best effort.
The data stream may contain `@timestamp` values higher than this if one or more of the following conditions are met:
The stream contains closed backing indices;
Backing indices with a lower generation contain higher `@timestamp` values. + /// + /// The data stream’s highest @timestamp value, converted to milliseconds since the Unix epoch. + /// NOTE: This timestamp is provided as a best effort. + /// The data stream may contain @timestamp values higher than this if one or more of the following conditions are met: + /// The stream contains closed backing indices; + /// Backing indices with a lower generation contain higher @timestamp values. + /// /// [JsonInclude, JsonPropertyName("maximum_timestamp")] public long MaximumTimestamp { get; init; } /// - /// Total size of all shards for the data stream’s backing indices.
This parameter is only returned if the `human` query parameter is `true`. + /// + /// Total size of all shards for the data stream’s backing indices. + /// This parameter is only returned if the human query parameter is true. + /// /// [JsonInclude, JsonPropertyName("store_size")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? StoreSize { get; init; } /// - /// Total size, in bytes, of all shards for the data stream’s backing indices. + /// + /// Total size, in bytes, of all shards for the data stream’s backing indices. + /// /// [JsonInclude, JsonPropertyName("store_size_bytes")] public long StoreSizeBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DownsampleConfig.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DownsampleConfig.g.cs index 229dbf8c548..2e98d824bd2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DownsampleConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DownsampleConfig.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class DownsampleConfig { /// - /// The interval at which to aggregate the original time series index. + /// + /// The interval at which to aggregate the original time series index. + /// /// [JsonInclude, JsonPropertyName("fixed_interval")] public string FixedInterval { get; set; } @@ -47,7 +49,9 @@ public DownsampleConfigDescriptor() : base() private string FixedIntervalValue { get; set; } /// - /// The interval at which to aggregate the original time series index. + /// + /// The interval at which to aggregate the original time series index. + /// /// public DownsampleConfigDescriptor FixedInterval(string fixedInterval) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DownsamplingRound.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DownsamplingRound.g.cs index f37376ed2e1..8c8dddd33d3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DownsamplingRound.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DownsamplingRound.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class DownsamplingRound { /// - /// The duration since rollover when this downsampling round should execute + /// + /// The duration since rollover when this downsampling round should execute + /// /// [JsonInclude, JsonPropertyName("after")] public Elastic.Clients.Elasticsearch.Serverless.Duration After { get; set; } /// - /// The downsample configuration to execute. + /// + /// The downsample configuration to execute. + /// /// [JsonInclude, JsonPropertyName("config")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DownsampleConfig Config { get; set; } @@ -56,7 +60,9 @@ public DownsamplingRoundDescriptor() : base() private Action ConfigDescriptorAction { get; set; } /// - /// The duration since rollover when this downsampling round should execute + /// + /// The duration since rollover when this downsampling round should execute + /// /// public DownsamplingRoundDescriptor After(Elastic.Clients.Elasticsearch.Serverless.Duration after) { @@ -65,7 +71,9 @@ public DownsamplingRoundDescriptor After(Elastic.Clients.Elasticsearch.Serverles } /// - /// The downsample configuration to execute. + /// + /// The downsample configuration to execute. + /// /// public DownsamplingRoundDescriptor Config(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DownsampleConfig config) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/ExplainAnalyzeToken.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/ExplainAnalyzeToken.g.cs index f831bdb118e..9d6ab4edf40 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/ExplainAnalyzeToken.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/ExplainAnalyzeToken.g.cs @@ -121,7 +121,9 @@ public override void Write(Utf8JsonWriter writer, ExplainAnalyzeToken value, Jso public sealed partial class ExplainAnalyzeToken { /// - /// Additional tokenizer-specific attributes + /// + /// Additional tokenizer-specific attributes + /// /// public IReadOnlyDictionary Attributes { get; init; } public string Bytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexAndDataStreamAction.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexAndDataStreamAction.g.cs index bdfefd2d6ec..b5b82c9af8b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexAndDataStreamAction.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexAndDataStreamAction.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class IndexAndDataStreamAction { /// - /// Data stream targeted by the action. + /// + /// Data stream targeted by the action. + /// /// [JsonInclude, JsonPropertyName("data_stream")] public Elastic.Clients.Elasticsearch.Serverless.DataStreamName DataStream { get; set; } /// - /// Index for the action. + /// + /// Index for the action. + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.Serverless.IndexName Index { get; set; } @@ -54,7 +58,9 @@ public IndexAndDataStreamActionDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.IndexName IndexValue { get; set; } /// - /// Data stream targeted by the action. + /// + /// Data stream targeted by the action. + /// /// public IndexAndDataStreamActionDescriptor DataStream(Elastic.Clients.Elasticsearch.Serverless.DataStreamName dataStream) { @@ -63,7 +69,9 @@ public IndexAndDataStreamActionDescriptor DataStream(Elastic.Clients.Elasticsear } /// - /// Index for the action. + /// + /// Index for the action. + /// /// public IndexAndDataStreamActionDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.IndexName index) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexSettings.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexSettings.g.cs index f86fe5c736f..4fe509576f3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexSettings.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexSettings.g.cs @@ -747,7 +747,9 @@ public sealed partial class IndexSettings public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexSettingsAnalysis? Analysis { get; set; } /// - /// Settings to define analyzers, tokenizers, token filters and character filters. + /// + /// Settings to define analyzers, tokenizers, token filters and character filters. + /// /// public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.SettingsAnalyze? Analyze { get; set; } public string? AutoExpandReplicas { get; set; } @@ -765,7 +767,9 @@ public sealed partial class IndexSettings public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexSettings? Index { get; set; } /// - /// Configure indexing back pressure limits. + /// + /// Configure indexing back pressure limits. + /// /// public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexingPressure? IndexingPressure { get; set; } public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexingSlowlogSettings? IndexingSlowlog { get; set; } @@ -773,7 +777,9 @@ public sealed partial class IndexSettings public bool? LoadFixedBitsetFiltersEagerly { get; set; } /// - /// Enable or disable dynamic mapping for an index. + /// + /// Enable or disable dynamic mapping for an index. + /// /// public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.MappingLimitSettings? Mapping { get; set; } public int? MaxDocvalueFieldsSearch { get; set; } @@ -794,7 +800,9 @@ public sealed partial class IndexSettings public object? NumberOfShards { get; set; } /// - /// Additional settings not covered in this type. Unless these settings are defined by a plugin, please open an issue on the [Elasticsearch API specification](https://github.com/elastic/elasticsearch-specification) so that they can be added in a future release + /// + /// Additional settings not covered in this type. Unless these settings are defined by a plugin, please open an issue on the Elasticsearch API specification so that they can be added in a future release + /// /// public IDictionary OtherSettings { get; set; } public object? Priority { get; set; } @@ -809,14 +817,18 @@ public sealed partial class IndexSettings public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexSettings? Settings { get; set; } /// - /// Configure custom similarity settings to customize how search results are scored. + /// + /// Configure custom similarity settings to customize how search results are scored. + /// /// public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.SettingsSimilarities? Similarity { get; set; } public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.SoftDeletes? SoftDeletes { get; set; } public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexSegmentSort? Sort { get; set; } /// - /// The store module allows you to control how index data is stored and accessed on disk. + /// + /// The store module allows you to control how index data is stored and accessed on disk. + /// /// public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.Storage? Store { get; set; } public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexSettingsTimeSeries? TimeSeries { get; set; } @@ -963,7 +975,9 @@ public IndexSettingsDescriptor Analysis(Action - /// Settings to define analyzers, tokenizers, token filters and character filters. + /// + /// Settings to define analyzers, tokenizers, token filters and character filters. + /// /// public IndexSettingsDescriptor Analyze(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.SettingsAnalyze? analyze) { @@ -1122,7 +1136,9 @@ public IndexSettingsDescriptor Index(Action - /// Configure indexing back pressure limits. + /// + /// Configure indexing back pressure limits. + /// /// public IndexSettingsDescriptor IndexingPressure(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexingPressure? indexingPressure) { @@ -1203,7 +1219,9 @@ public IndexSettingsDescriptor LoadFixedBitsetFiltersEagerly(bool? lo } /// - /// Enable or disable dynamic mapping for an index. + /// + /// Enable or disable dynamic mapping for an index. + /// /// public IndexSettingsDescriptor Mapping(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.MappingLimitSettings? mapping) { @@ -1344,7 +1362,9 @@ public IndexSettingsDescriptor NumberOfShards(object? numberOfShards) } /// - /// Additional settings not covered in this type. Unless these settings are defined by a plugin, please open an issue on the [Elasticsearch API specification](https://github.com/elastic/elasticsearch-specification) so that they can be added in a future release + /// + /// Additional settings not covered in this type. Unless these settings are defined by a plugin, please open an issue on the Elasticsearch API specification so that they can be added in a future release + /// /// public IndexSettingsDescriptor OtherSettings(Func, FluentDictionary> selector) { @@ -1503,7 +1523,9 @@ public IndexSettingsDescriptor Settings(Action - /// Configure custom similarity settings to customize how search results are scored. + /// + /// Configure custom similarity settings to customize how search results are scored. + /// /// public IndexSettingsDescriptor Similarity(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.SettingsSimilarities? similarity) { @@ -1574,7 +1596,9 @@ public IndexSettingsDescriptor Sort(Action - /// The store module allows you to control how index data is stored and accessed on disk. + /// + /// The store module allows you to control how index data is stored and accessed on disk. + /// /// public IndexSettingsDescriptor Store(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.Storage? store) { @@ -2388,7 +2412,9 @@ public IndexSettingsDescriptor Analysis(Action - /// Settings to define analyzers, tokenizers, token filters and character filters. + /// + /// Settings to define analyzers, tokenizers, token filters and character filters. + /// /// public IndexSettingsDescriptor Analyze(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.SettingsAnalyze? analyze) { @@ -2547,7 +2573,9 @@ public IndexSettingsDescriptor Index(Action - /// Configure indexing back pressure limits. + /// + /// Configure indexing back pressure limits. + /// /// public IndexSettingsDescriptor IndexingPressure(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexingPressure? indexingPressure) { @@ -2628,7 +2656,9 @@ public IndexSettingsDescriptor LoadFixedBitsetFiltersEagerly(bool? loadFixedBits } /// - /// Enable or disable dynamic mapping for an index. + /// + /// Enable or disable dynamic mapping for an index. + /// /// public IndexSettingsDescriptor Mapping(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.MappingLimitSettings? mapping) { @@ -2769,7 +2799,9 @@ public IndexSettingsDescriptor NumberOfShards(object? numberOfShards) } /// - /// Additional settings not covered in this type. Unless these settings are defined by a plugin, please open an issue on the [Elasticsearch API specification](https://github.com/elastic/elasticsearch-specification) so that they can be added in a future release + /// + /// Additional settings not covered in this type. Unless these settings are defined by a plugin, please open an issue on the Elasticsearch API specification so that they can be added in a future release + /// /// public IndexSettingsDescriptor OtherSettings(Func, FluentDictionary> selector) { @@ -2928,7 +2960,9 @@ public IndexSettingsDescriptor Settings(Action - /// Configure custom similarity settings to customize how search results are scored. + /// + /// Configure custom similarity settings to customize how search results are scored. + /// /// public IndexSettingsDescriptor Similarity(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.SettingsSimilarities? similarity) { @@ -2999,7 +3033,9 @@ public IndexSettingsDescriptor Sort(Action - /// The store module allows you to control how index data is stored and accessed on disk. + /// + /// The store module allows you to control how index data is stored and accessed on disk. + /// /// public IndexSettingsDescriptor Store(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.Storage? store) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexSettingsLifecycle.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexSettingsLifecycle.g.cs index 177a2048f12..886a878bcb9 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexSettingsLifecycle.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexSettingsLifecycle.g.cs @@ -30,31 +30,49 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class IndexSettingsLifecycle { /// - /// Indicates whether or not the index has been rolled over. Automatically set to true when ILM completes the rollover action.
You can explicitly set it to skip rollover. + /// + /// Indicates whether or not the index has been rolled over. Automatically set to true when ILM completes the rollover action. + /// You can explicitly set it to skip rollover. + /// /// [JsonInclude, JsonPropertyName("indexing_complete")] public bool? IndexingComplete { get; set; } /// - /// The name of the policy to use to manage the index. For information about how Elasticsearch applies policy changes, see Policy updates. + /// + /// The name of the policy to use to manage the index. For information about how Elasticsearch applies policy changes, see Policy updates. + /// /// [JsonInclude, JsonPropertyName("name")] public Elastic.Clients.Elasticsearch.Serverless.Name? Name { get; set; } /// - /// If specified, this is the timestamp used to calculate the index age for its phase transitions. Use this setting
if you create a new index that contains old data and want to use the original creation date to calculate the index
age. Specified as a Unix epoch value in milliseconds. + /// + /// If specified, this is the timestamp used to calculate the index age for its phase transitions. Use this setting + /// if you create a new index that contains old data and want to use the original creation date to calculate the index + /// age. Specified as a Unix epoch value in milliseconds. + /// /// [JsonInclude, JsonPropertyName("origination_date")] public long? OriginationDate { get; set; } /// - /// Set to true to parse the origination date from the index name. This origination date is used to calculate the index age
for its phase transitions. The index name must match the pattern ^.*-{date_format}-\\d+, where the date_format is
yyyy.MM.dd and the trailing digits are optional. An index that was rolled over would normally match the full format,
for example logs-2016.10.31-000002). If the index name doesn’t match the pattern, index creation fails. + /// + /// Set to true to parse the origination date from the index name. This origination date is used to calculate the index age + /// for its phase transitions. The index name must match the pattern ^.*-{date_format}-\d+, where the date_format is + /// yyyy.MM.dd and the trailing digits are optional. An index that was rolled over would normally match the full format, + /// for example logs-2016.10.31-000002). If the index name doesn’t match the pattern, index creation fails. + /// /// [JsonInclude, JsonPropertyName("parse_origination_date")] public bool? ParseOriginationDate { get; set; } /// - /// The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action.
When the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more
information about rolling indices, see Rollover. + /// + /// The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action. + /// When the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more + /// information about rolling indices, see Rollover. + /// /// [JsonInclude, JsonPropertyName("rollover_alias")] public string? RolloverAlias { get; set; } @@ -80,7 +98,10 @@ public IndexSettingsLifecycleDescriptor() : base() private Action StepDescriptorAction { get; set; } /// - /// Indicates whether or not the index has been rolled over. Automatically set to true when ILM completes the rollover action.
You can explicitly set it to skip rollover. + /// + /// Indicates whether or not the index has been rolled over. Automatically set to true when ILM completes the rollover action. + /// You can explicitly set it to skip rollover. + /// /// public IndexSettingsLifecycleDescriptor IndexingComplete(bool? indexingComplete = true) { @@ -89,7 +110,9 @@ public IndexSettingsLifecycleDescriptor IndexingComplete(bool? indexingComplete } /// - /// The name of the policy to use to manage the index. For information about how Elasticsearch applies policy changes, see Policy updates. + /// + /// The name of the policy to use to manage the index. For information about how Elasticsearch applies policy changes, see Policy updates. + /// /// public IndexSettingsLifecycleDescriptor Name(Elastic.Clients.Elasticsearch.Serverless.Name? name) { @@ -98,7 +121,11 @@ public IndexSettingsLifecycleDescriptor Name(Elastic.Clients.Elasticsearch.Serve } /// - /// If specified, this is the timestamp used to calculate the index age for its phase transitions. Use this setting
if you create a new index that contains old data and want to use the original creation date to calculate the index
age. Specified as a Unix epoch value in milliseconds. + /// + /// If specified, this is the timestamp used to calculate the index age for its phase transitions. Use this setting + /// if you create a new index that contains old data and want to use the original creation date to calculate the index + /// age. Specified as a Unix epoch value in milliseconds. + /// /// public IndexSettingsLifecycleDescriptor OriginationDate(long? originationDate) { @@ -107,7 +134,12 @@ public IndexSettingsLifecycleDescriptor OriginationDate(long? originationDate) } /// - /// Set to true to parse the origination date from the index name. This origination date is used to calculate the index age
for its phase transitions. The index name must match the pattern ^.*-{date_format}-\\d+, where the date_format is
yyyy.MM.dd and the trailing digits are optional. An index that was rolled over would normally match the full format,
for example logs-2016.10.31-000002). If the index name doesn’t match the pattern, index creation fails. + /// + /// Set to true to parse the origination date from the index name. This origination date is used to calculate the index age + /// for its phase transitions. The index name must match the pattern ^.*-{date_format}-\d+, where the date_format is + /// yyyy.MM.dd and the trailing digits are optional. An index that was rolled over would normally match the full format, + /// for example logs-2016.10.31-000002). If the index name doesn’t match the pattern, index creation fails. + /// /// public IndexSettingsLifecycleDescriptor ParseOriginationDate(bool? parseOriginationDate = true) { @@ -116,7 +148,11 @@ public IndexSettingsLifecycleDescriptor ParseOriginationDate(bool? parseOriginat } /// - /// The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action.
When the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more
information about rolling indices, see Rollover. + /// + /// The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action. + /// When the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more + /// information about rolling indices, see Rollover. + /// /// public IndexSettingsLifecycleDescriptor RolloverAlias(string? rolloverAlias) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexSettingsLifecycleStep.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexSettingsLifecycleStep.g.cs index 93d2c1bbc57..7948827f35f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexSettingsLifecycleStep.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexSettingsLifecycleStep.g.cs @@ -30,7 +30,10 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class IndexSettingsLifecycleStep { /// - /// Time to wait for the cluster to resolve allocation issues during an ILM shrink action. Must be greater than 1h (1 hour).
See Shard allocation for shrink. + /// + /// Time to wait for the cluster to resolve allocation issues during an ILM shrink action. Must be greater than 1h (1 hour). + /// See Shard allocation for shrink. + /// /// [JsonInclude, JsonPropertyName("wait_time_threshold")] public Elastic.Clients.Elasticsearch.Serverless.Duration? WaitTimeThreshold { get; set; } @@ -47,7 +50,10 @@ public IndexSettingsLifecycleStepDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Duration? WaitTimeThresholdValue { get; set; } /// - /// Time to wait for the cluster to resolve allocation issues during an ILM shrink action. Must be greater than 1h (1 hour).
See Shard allocation for shrink. + /// + /// Time to wait for the cluster to resolve allocation issues during an ILM shrink action. Must be greater than 1h (1 hour). + /// See Shard allocation for shrink. + /// /// public IndexSettingsLifecycleStepDescriptor WaitTimeThreshold(Elastic.Clients.Elasticsearch.Serverless.Duration? waitTimeThreshold) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexState.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexState.g.cs index 1038b45d26d..67910b34d75 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexState.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexState.g.cs @@ -35,13 +35,17 @@ public sealed partial class IndexState public Elastic.Clients.Elasticsearch.Serverless.DataStreamName? DataStream { get; set; } /// - /// Default settings, included when the request's `include_default` is `true`. + /// + /// Default settings, included when the request's include_default is true. + /// /// [JsonInclude, JsonPropertyName("defaults")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexSettings? Defaults { get; set; } /// - /// Data stream lifecycle applicable if this is a data stream. + /// + /// Data stream lifecycle applicable if this is a data stream. + /// /// [JsonInclude, JsonPropertyName("lifecycle")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycle? Lifecycle { get; set; } @@ -87,7 +91,9 @@ public IndexStateDescriptor DataStream(Elastic.Clients.Elasticsearch. } /// - /// Default settings, included when the request's `include_default` is `true`. + /// + /// Default settings, included when the request's include_default is true. + /// /// public IndexStateDescriptor Defaults(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexSettings? defaults) { @@ -114,7 +120,9 @@ public IndexStateDescriptor Defaults(Action - /// Data stream lifecycle applicable if this is a data stream. + /// + /// Data stream lifecycle applicable if this is a data stream. + /// /// public IndexStateDescriptor Lifecycle(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycle? lifecycle) { @@ -307,7 +315,9 @@ public IndexStateDescriptor DataStream(Elastic.Clients.Elasticsearch.Serverless. } /// - /// Default settings, included when the request's `include_default` is `true`. + /// + /// Default settings, included when the request's include_default is true. + /// /// public IndexStateDescriptor Defaults(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexSettings? defaults) { @@ -334,7 +344,9 @@ public IndexStateDescriptor Defaults(Action - /// Data stream lifecycle applicable if this is a data stream. + /// + /// Data stream lifecycle applicable if this is a data stream. + /// /// public IndexStateDescriptor Lifecycle(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycle? lifecycle) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexStats.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexStats.g.cs index 32b00985513..4e040fc0dde 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexStats.g.cs @@ -33,85 +33,113 @@ public sealed partial class IndexStats public Elastic.Clients.Elasticsearch.Serverless.BulkStats? Bulk { get; init; } /// - /// Contains statistics about completions across all shards assigned to the node. + /// + /// Contains statistics about completions across all shards assigned to the node. + /// /// [JsonInclude, JsonPropertyName("completion")] public Elastic.Clients.Elasticsearch.Serverless.CompletionStats? Completion { get; init; } /// - /// Contains statistics about documents across all primary shards assigned to the node. + /// + /// Contains statistics about documents across all primary shards assigned to the node. + /// /// [JsonInclude, JsonPropertyName("docs")] public Elastic.Clients.Elasticsearch.Serverless.DocStats? Docs { get; init; } /// - /// Contains statistics about the field data cache across all shards assigned to the node. + /// + /// Contains statistics about the field data cache across all shards assigned to the node. + /// /// [JsonInclude, JsonPropertyName("fielddata")] public Elastic.Clients.Elasticsearch.Serverless.FielddataStats? Fielddata { get; init; } /// - /// Contains statistics about flush operations for the node. + /// + /// Contains statistics about flush operations for the node. + /// /// [JsonInclude, JsonPropertyName("flush")] public Elastic.Clients.Elasticsearch.Serverless.FlushStats? Flush { get; init; } /// - /// Contains statistics about get operations for the node. + /// + /// Contains statistics about get operations for the node. + /// /// [JsonInclude, JsonPropertyName("get")] public Elastic.Clients.Elasticsearch.Serverless.GetStats? Get { get; init; } /// - /// Contains statistics about indexing operations for the node. + /// + /// Contains statistics about indexing operations for the node. + /// /// [JsonInclude, JsonPropertyName("indexing")] public Elastic.Clients.Elasticsearch.Serverless.IndexingStats? Indexing { get; init; } /// - /// Contains statistics about indices operations for the node. + /// + /// Contains statistics about indices operations for the node. + /// /// [JsonInclude, JsonPropertyName("indices")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndicesStats? Indices { get; init; } /// - /// Contains statistics about merge operations for the node. + /// + /// Contains statistics about merge operations for the node. + /// /// [JsonInclude, JsonPropertyName("merges")] public Elastic.Clients.Elasticsearch.Serverless.MergesStats? Merges { get; init; } /// - /// Contains statistics about the query cache across all shards assigned to the node. + /// + /// Contains statistics about the query cache across all shards assigned to the node. + /// /// [JsonInclude, JsonPropertyName("query_cache")] public Elastic.Clients.Elasticsearch.Serverless.QueryCacheStats? QueryCache { get; init; } /// - /// Contains statistics about recovery operations for the node. + /// + /// Contains statistics about recovery operations for the node. + /// /// [JsonInclude, JsonPropertyName("recovery")] public Elastic.Clients.Elasticsearch.Serverless.RecoveryStats? Recovery { get; init; } /// - /// Contains statistics about refresh operations for the node. + /// + /// Contains statistics about refresh operations for the node. + /// /// [JsonInclude, JsonPropertyName("refresh")] public Elastic.Clients.Elasticsearch.Serverless.RefreshStats? Refresh { get; init; } /// - /// Contains statistics about the request cache across all shards assigned to the node. + /// + /// Contains statistics about the request cache across all shards assigned to the node. + /// /// [JsonInclude, JsonPropertyName("request_cache")] public Elastic.Clients.Elasticsearch.Serverless.RequestCacheStats? RequestCache { get; init; } /// - /// Contains statistics about search operations for the node. + /// + /// Contains statistics about search operations for the node. + /// /// [JsonInclude, JsonPropertyName("search")] public Elastic.Clients.Elasticsearch.Serverless.SearchStats? Search { get; init; } /// - /// Contains statistics about segments across all shards assigned to the node. + /// + /// Contains statistics about segments across all shards assigned to the node. + /// /// [JsonInclude, JsonPropertyName("segments")] public Elastic.Clients.Elasticsearch.Serverless.SegmentsStats? Segments { get; init; } @@ -119,19 +147,25 @@ public sealed partial class IndexStats public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.ShardsTotalStats? ShardStats { get; init; } /// - /// Contains statistics about the size of shards assigned to the node. + /// + /// Contains statistics about the size of shards assigned to the node. + /// /// [JsonInclude, JsonPropertyName("store")] public Elastic.Clients.Elasticsearch.Serverless.StoreStats? Store { get; init; } /// - /// Contains statistics about transaction log operations for the node. + /// + /// Contains statistics about transaction log operations for the node. + /// /// [JsonInclude, JsonPropertyName("translog")] public Elastic.Clients.Elasticsearch.Serverless.TranslogStats? Translog { get; init; } /// - /// Contains statistics about index warming operations for the node. + /// + /// Contains statistics about index warming operations for the node. + /// /// [JsonInclude, JsonPropertyName("warmer")] public Elastic.Clients.Elasticsearch.Serverless.WarmerStats? Warmer { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexTemplate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexTemplate.g.cs index 7a0e3603a24..615da923b57 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexTemplate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexTemplate.g.cs @@ -33,44 +33,67 @@ public sealed partial class IndexTemplate public bool? AllowAutoCreate { get; init; } /// - /// An ordered list of component template names.
Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// + /// An ordered list of component template names. + /// Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// /// [JsonInclude, JsonPropertyName("composed_of")] public IReadOnlyCollection ComposedOf { get; init; } /// - /// If this object is included, the template is used to create data streams and their backing indices.
Supports an empty object.
Data streams require a matching index template with a `data_stream` object. + /// + /// If this object is included, the template is used to create data streams and their backing indices. + /// Supports an empty object. + /// Data streams require a matching index template with a data_stream object. + /// /// [JsonInclude, JsonPropertyName("data_stream")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexTemplateDataStreamConfiguration? DataStream { get; init; } /// - /// Name of the index template. + /// + /// Name of the index template. + /// /// [JsonInclude, JsonPropertyName("index_patterns")] [SingleOrManyCollectionConverter(typeof(string))] public IReadOnlyCollection IndexPatterns { get; init; } /// - /// Optional user metadata about the index template. May have any contents.
This map is not automatically generated by Elasticsearch. + /// + /// Optional user metadata about the index template. May have any contents. + /// This map is not automatically generated by Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("_meta")] public IReadOnlyDictionary? Meta { get; init; } /// - /// Priority to determine index template precedence when a new data stream or index is created.
The index template with the highest priority is chosen.
If no priority is specified the template is treated as though it is of priority 0 (lowest priority).
This number is not automatically generated by Elasticsearch. + /// + /// Priority to determine index template precedence when a new data stream or index is created. + /// The index template with the highest priority is chosen. + /// If no priority is specified the template is treated as though it is of priority 0 (lowest priority). + /// This number is not automatically generated by Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("priority")] public long? Priority { get; init; } /// - /// Template to be applied.
It may optionally include an `aliases`, `mappings`, or `settings` configuration. + /// + /// Template to be applied. + /// It may optionally include an aliases, mappings, or settings configuration. + /// /// [JsonInclude, JsonPropertyName("template")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexTemplateSummary? Template { get; init; } /// - /// Version number used to manage index templates externally.
This number is not automatically generated by Elasticsearch. + /// + /// Version number used to manage index templates externally. + /// This number is not automatically generated by Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("version")] public long? Version { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexTemplateDataStreamConfiguration.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexTemplateDataStreamConfiguration.g.cs index fc932e82b63..62ced6e40fc 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexTemplateDataStreamConfiguration.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexTemplateDataStreamConfiguration.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class IndexTemplateDataStreamConfiguration { /// - /// If true, the data stream supports custom routing. + /// + /// If true, the data stream supports custom routing. + /// /// [JsonInclude, JsonPropertyName("allow_custom_routing")] public bool? AllowCustomRouting { get; init; } /// - /// If true, the data stream is hidden. + /// + /// If true, the data stream is hidden. + /// /// [JsonInclude, JsonPropertyName("hidden")] public bool? Hidden { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexTemplateMapping.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexTemplateMapping.g.cs index d7591a9a692..aeee17d900b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexTemplateMapping.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexTemplateMapping.g.cs @@ -30,7 +30,12 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class IndexTemplateMapping { /// - /// Aliases to add.
If the index template includes a `data_stream` object, these are data stream aliases.
Otherwise, these are index aliases.
Data stream aliases ignore the `index_routing`, `routing`, and `search_routing` options. + /// + /// Aliases to add. + /// If the index template includes a data_stream object, these are data stream aliases. + /// Otherwise, these are index aliases. + /// Data stream aliases ignore the index_routing, routing, and search_routing options. + /// /// [JsonInclude, JsonPropertyName("aliases")] public IDictionary? Aliases { get; set; } @@ -38,13 +43,18 @@ public sealed partial class IndexTemplateMapping public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycle? Lifecycle { get; set; } /// - /// Mapping for fields in the index.
If specified, this mapping can include field names, field data types, and mapping parameters. + /// + /// Mapping for fields in the index. + /// If specified, this mapping can include field names, field data types, and mapping parameters. + /// /// [JsonInclude, JsonPropertyName("mappings")] public Elastic.Clients.Elasticsearch.Serverless.Mapping.TypeMapping? Mappings { get; set; } /// - /// Configuration options for the index. + /// + /// Configuration options for the index. + /// /// [JsonInclude, JsonPropertyName("settings")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexSettings? Settings { get; set; } @@ -70,7 +80,12 @@ public IndexTemplateMappingDescriptor() : base() private Action> SettingsDescriptorAction { get; set; } /// - /// Aliases to add.
If the index template includes a `data_stream` object, these are data stream aliases.
Otherwise, these are index aliases.
Data stream aliases ignore the `index_routing`, `routing`, and `search_routing` options. + /// + /// Aliases to add. + /// If the index template includes a data_stream object, these are data stream aliases. + /// Otherwise, these are index aliases. + /// Data stream aliases ignore the index_routing, routing, and search_routing options. + /// /// public IndexTemplateMappingDescriptor Aliases(Func>, FluentDescriptorDictionary>> selector) { @@ -103,7 +118,10 @@ public IndexTemplateMappingDescriptor Lifecycle(Action - /// Mapping for fields in the index.
If specified, this mapping can include field names, field data types, and mapping parameters. + /// + /// Mapping for fields in the index. + /// If specified, this mapping can include field names, field data types, and mapping parameters. + /// /// public IndexTemplateMappingDescriptor Mappings(Elastic.Clients.Elasticsearch.Serverless.Mapping.TypeMapping? mappings) { @@ -130,7 +148,9 @@ public IndexTemplateMappingDescriptor Mappings(Action - /// Configuration options for the index. + /// + /// Configuration options for the index. + /// /// public IndexTemplateMappingDescriptor Settings(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexSettings? settings) { @@ -237,7 +257,12 @@ public IndexTemplateMappingDescriptor() : base() private Action SettingsDescriptorAction { get; set; } /// - /// Aliases to add.
If the index template includes a `data_stream` object, these are data stream aliases.
Otherwise, these are index aliases.
Data stream aliases ignore the `index_routing`, `routing`, and `search_routing` options. + /// + /// Aliases to add. + /// If the index template includes a data_stream object, these are data stream aliases. + /// Otherwise, these are index aliases. + /// Data stream aliases ignore the index_routing, routing, and search_routing options. + /// /// public IndexTemplateMappingDescriptor Aliases(Func, FluentDescriptorDictionary> selector) { @@ -270,7 +295,10 @@ public IndexTemplateMappingDescriptor Lifecycle(Action - /// Mapping for fields in the index.
If specified, this mapping can include field names, field data types, and mapping parameters. + /// + /// Mapping for fields in the index. + /// If specified, this mapping can include field names, field data types, and mapping parameters. + /// /// public IndexTemplateMappingDescriptor Mappings(Elastic.Clients.Elasticsearch.Serverless.Mapping.TypeMapping? mappings) { @@ -297,7 +325,9 @@ public IndexTemplateMappingDescriptor Mappings(Action - /// Configuration options for the index. + /// + /// Configuration options for the index. + /// /// public IndexTemplateMappingDescriptor Settings(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexSettings? settings) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexTemplateSummary.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexTemplateSummary.g.cs index 63f12296520..a13a65df15f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexTemplateSummary.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexTemplateSummary.g.cs @@ -30,7 +30,12 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class IndexTemplateSummary { /// - /// Aliases to add.
If the index template includes a `data_stream` object, these are data stream aliases.
Otherwise, these are index aliases.
Data stream aliases ignore the `index_routing`, `routing`, and `search_routing` options. + /// + /// Aliases to add. + /// If the index template includes a data_stream object, these are data stream aliases. + /// Otherwise, these are index aliases. + /// Data stream aliases ignore the index_routing, routing, and search_routing options. + /// /// [JsonInclude, JsonPropertyName("aliases")] [ReadOnlyIndexNameDictionaryConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.Alias))] @@ -39,13 +44,18 @@ public sealed partial class IndexTemplateSummary public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycleWithRollover? Lifecycle { get; init; } /// - /// Mapping for fields in the index.
If specified, this mapping can include field names, field data types, and mapping parameters. + /// + /// Mapping for fields in the index. + /// If specified, this mapping can include field names, field data types, and mapping parameters. + /// /// [JsonInclude, JsonPropertyName("mappings")] public Elastic.Clients.Elasticsearch.Serverless.Mapping.TypeMapping? Mappings { get; init; } /// - /// Configuration options for the index. + /// + /// Configuration options for the index. + /// /// [JsonInclude, JsonPropertyName("settings")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexSettings? Settings { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexingPressureMemory.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexingPressureMemory.g.cs index 789aea81308..d6e8cab7ca4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexingPressureMemory.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexingPressureMemory.g.cs @@ -30,7 +30,11 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class IndexingPressureMemory { /// - /// Number of outstanding bytes that may be consumed by indexing requests. When this limit is reached or exceeded,
the node will reject new coordinating and primary operations. When replica operations consume 1.5x this limit,
the node will reject new replica operations. Defaults to 10% of the heap. + /// + /// Number of outstanding bytes that may be consumed by indexing requests. When this limit is reached or exceeded, + /// the node will reject new coordinating and primary operations. When replica operations consume 1.5x this limit, + /// the node will reject new replica operations. Defaults to 10% of the heap. + /// /// [JsonInclude, JsonPropertyName("limit")] public int? Limit { get; set; } @@ -47,7 +51,11 @@ public IndexingPressureMemoryDescriptor() : base() private int? LimitValue { get; set; } /// - /// Number of outstanding bytes that may be consumed by indexing requests. When this limit is reached or exceeded,
the node will reject new coordinating and primary operations. When replica operations consume 1.5x this limit,
the node will reject new replica operations. Defaults to 10% of the heap. + /// + /// Number of outstanding bytes that may be consumed by indexing requests. When this limit is reached or exceeded, + /// the node will reject new coordinating and primary operations. When replica operations consume 1.5x this limit, + /// the node will reject new replica operations. Defaults to 10% of the heap. + /// /// public IndexingPressureMemoryDescriptor Limit(int? limit) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexingSlowlogTresholds.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexingSlowlogTresholds.g.cs index 07c33d32bb3..3671ec3a746 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexingSlowlogTresholds.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexingSlowlogTresholds.g.cs @@ -30,7 +30,10 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class IndexingSlowlogTresholds { /// - /// The indexing slow log, similar in functionality to the search slow log. The log file name ends with `_index_indexing_slowlog.json`.
Log and the thresholds are configured in the same way as the search slowlog. + /// + /// The indexing slow log, similar in functionality to the search slow log. The log file name ends with _index_indexing_slowlog.json. + /// Log and the thresholds are configured in the same way as the search slowlog. + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.SlowlogTresholdLevels? Index { get; set; } @@ -49,7 +52,10 @@ public IndexingSlowlogTresholdsDescriptor() : base() private Action IndexDescriptorAction { get; set; } /// - /// The indexing slow log, similar in functionality to the search slow log. The log file name ends with `_index_indexing_slowlog.json`.
Log and the thresholds are configured in the same way as the search slowlog. + /// + /// The indexing slow log, similar in functionality to the search slow log. The log file name ends with _index_indexing_slowlog.json. + /// Log and the thresholds are configured in the same way as the search slowlog. + /// /// public IndexingSlowlogTresholdsDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.SlowlogTresholdLevels? index) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettings.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettings.g.cs index 585ba44d3e4..f98973e026a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettings.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettings.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; /// -/// Mapping Limit Settings +/// +/// Mapping Limit Settings +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class MappingLimitSettings @@ -52,7 +54,9 @@ public sealed partial class MappingLimitSettings } /// -/// Mapping Limit Settings +/// +/// Mapping Limit Settings +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class MappingLimitSettingsDescriptor : SerializableDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettingsDepth.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettingsDepth.g.cs index ed80d210885..d60bf5c8430 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettingsDepth.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettingsDepth.g.cs @@ -30,7 +30,10 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class MappingLimitSettingsDepth { /// - /// The maximum depth for a field, which is measured as the number of inner objects. For instance, if all fields are defined
at the root object level, then the depth is 1. If there is one object mapping, then the depth is 2, etc. + /// + /// The maximum depth for a field, which is measured as the number of inner objects. For instance, if all fields are defined + /// at the root object level, then the depth is 1. If there is one object mapping, then the depth is 2, etc. + /// /// [JsonInclude, JsonPropertyName("limit")] public long? Limit { get; set; } @@ -47,7 +50,10 @@ public MappingLimitSettingsDepthDescriptor() : base() private long? LimitValue { get; set; } /// - /// The maximum depth for a field, which is measured as the number of inner objects. For instance, if all fields are defined
at the root object level, then the depth is 1. If there is one object mapping, then the depth is 2, etc. + /// + /// The maximum depth for a field, which is measured as the number of inner objects. For instance, if all fields are defined + /// at the root object level, then the depth is 1. If there is one object mapping, then the depth is 2, etc. + /// /// public MappingLimitSettingsDepthDescriptor Limit(long? limit) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettingsDimensionFields.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettingsDimensionFields.g.cs index fa6bdcd2a52..1133af14e1f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettingsDimensionFields.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettingsDimensionFields.g.cs @@ -30,7 +30,10 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class MappingLimitSettingsDimensionFields { /// - /// [preview] This functionality is in technical preview and may be changed or removed in a future release.
Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. + /// + /// [preview] This functionality is in technical preview and may be changed or removed in a future release. + /// Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. + /// /// [JsonInclude, JsonPropertyName("limit")] public long? Limit { get; set; } @@ -47,7 +50,10 @@ public MappingLimitSettingsDimensionFieldsDescriptor() : base() private long? LimitValue { get; set; } /// - /// [preview] This functionality is in technical preview and may be changed or removed in a future release.
Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. + /// + /// [preview] This functionality is in technical preview and may be changed or removed in a future release. + /// Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. + /// /// public MappingLimitSettingsDimensionFieldsDescriptor Limit(long? limit) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettingsFieldNameLength.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettingsFieldNameLength.g.cs index 1f8fab428c1..85fa93716b2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettingsFieldNameLength.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettingsFieldNameLength.g.cs @@ -30,7 +30,11 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class MappingLimitSettingsFieldNameLength { /// - /// Setting for the maximum length of a field name. This setting isn’t really something that addresses mappings explosion but
might still be useful if you want to limit the field length. It usually shouldn’t be necessary to set this setting. The
default is okay unless a user starts to add a huge number of fields with really long names. Default is `Long.MAX_VALUE` (no limit). + /// + /// Setting for the maximum length of a field name. This setting isn’t really something that addresses mappings explosion but + /// might still be useful if you want to limit the field length. It usually shouldn’t be necessary to set this setting. The + /// default is okay unless a user starts to add a huge number of fields with really long names. Default is Long.MAX_VALUE (no limit). + /// /// [JsonInclude, JsonPropertyName("limit")] public long? Limit { get; set; } @@ -47,7 +51,11 @@ public MappingLimitSettingsFieldNameLengthDescriptor() : base() private long? LimitValue { get; set; } /// - /// Setting for the maximum length of a field name. This setting isn’t really something that addresses mappings explosion but
might still be useful if you want to limit the field length. It usually shouldn’t be necessary to set this setting. The
default is okay unless a user starts to add a huge number of fields with really long names. Default is `Long.MAX_VALUE` (no limit). + /// + /// Setting for the maximum length of a field name. This setting isn’t really something that addresses mappings explosion but + /// might still be useful if you want to limit the field length. It usually shouldn’t be necessary to set this setting. The + /// default is okay unless a user starts to add a huge number of fields with really long names. Default is Long.MAX_VALUE (no limit). + /// /// public MappingLimitSettingsFieldNameLengthDescriptor Limit(long? limit) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettingsNestedFields.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettingsNestedFields.g.cs index c14ee0c3418..b02aabdc182 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettingsNestedFields.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettingsNestedFields.g.cs @@ -30,7 +30,11 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class MappingLimitSettingsNestedFields { /// - /// The maximum number of distinct nested mappings in an index. The nested type should only be used in special cases, when
arrays of objects need to be queried independently of each other. To safeguard against poorly designed mappings, this
setting limits the number of unique nested types per index. + /// + /// The maximum number of distinct nested mappings in an index. The nested type should only be used in special cases, when + /// arrays of objects need to be queried independently of each other. To safeguard against poorly designed mappings, this + /// setting limits the number of unique nested types per index. + /// /// [JsonInclude, JsonPropertyName("limit")] public long? Limit { get; set; } @@ -47,7 +51,11 @@ public MappingLimitSettingsNestedFieldsDescriptor() : base() private long? LimitValue { get; set; } /// - /// The maximum number of distinct nested mappings in an index. The nested type should only be used in special cases, when
arrays of objects need to be queried independently of each other. To safeguard against poorly designed mappings, this
setting limits the number of unique nested types per index. + /// + /// The maximum number of distinct nested mappings in an index. The nested type should only be used in special cases, when + /// arrays of objects need to be queried independently of each other. To safeguard against poorly designed mappings, this + /// setting limits the number of unique nested types per index. + /// /// public MappingLimitSettingsNestedFieldsDescriptor Limit(long? limit) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettingsNestedObjects.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettingsNestedObjects.g.cs index 6470d12445d..860e1442178 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettingsNestedObjects.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettingsNestedObjects.g.cs @@ -30,7 +30,10 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class MappingLimitSettingsNestedObjects { /// - /// The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps
to prevent out of memory errors when a document contains too many nested objects. + /// + /// The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps + /// to prevent out of memory errors when a document contains too many nested objects. + /// /// [JsonInclude, JsonPropertyName("limit")] public long? Limit { get; set; } @@ -47,7 +50,10 @@ public MappingLimitSettingsNestedObjectsDescriptor() : base() private long? LimitValue { get; set; } /// - /// The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps
to prevent out of memory errors when a document contains too many nested objects. + /// + /// The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps + /// to prevent out of memory errors when a document contains too many nested objects. + /// /// public MappingLimitSettingsNestedObjectsDescriptor Limit(long? limit) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettingsTotalFields.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettingsTotalFields.g.cs index a6974a18d28..95ab12b37b8 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettingsTotalFields.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettingsTotalFields.g.cs @@ -30,13 +30,23 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class MappingLimitSettingsTotalFields { /// - /// This setting determines what happens when a dynamically mapped field would exceed the total fields limit. When set
to false (the default), the index request of the document that tries to add a dynamic field to the mapping will fail
with the message Limit of total fields [X] has been exceeded. When set to true, the index request will not fail.
Instead, fields that would exceed the limit are not added to the mapping, similar to dynamic: false.
The fields that were not added to the mapping will be added to the _ignored field. + /// + /// This setting determines what happens when a dynamically mapped field would exceed the total fields limit. When set + /// to false (the default), the index request of the document that tries to add a dynamic field to the mapping will fail + /// with the message Limit of total fields [X] has been exceeded. When set to true, the index request will not fail. + /// Instead, fields that would exceed the limit are not added to the mapping, similar to dynamic: false. + /// The fields that were not added to the mapping will be added to the _ignored field. + /// /// [JsonInclude, JsonPropertyName("ignore_dynamic_beyond_limit")] public bool? IgnoreDynamicBeyondLimit { get; set; } /// - /// The maximum number of fields in an index. Field and object mappings, as well as field aliases count towards this limit.
The limit is in place to prevent mappings and searches from becoming too large. Higher values can lead to performance
degradations and memory issues, especially in clusters with a high load or few resources. + /// + /// The maximum number of fields in an index. Field and object mappings, as well as field aliases count towards this limit. + /// The limit is in place to prevent mappings and searches from becoming too large. Higher values can lead to performance + /// degradations and memory issues, especially in clusters with a high load or few resources. + /// /// [JsonInclude, JsonPropertyName("limit")] public long? Limit { get; set; } @@ -54,7 +64,13 @@ public MappingLimitSettingsTotalFieldsDescriptor() : base() private long? LimitValue { get; set; } /// - /// This setting determines what happens when a dynamically mapped field would exceed the total fields limit. When set
to false (the default), the index request of the document that tries to add a dynamic field to the mapping will fail
with the message Limit of total fields [X] has been exceeded. When set to true, the index request will not fail.
Instead, fields that would exceed the limit are not added to the mapping, similar to dynamic: false.
The fields that were not added to the mapping will be added to the _ignored field. + /// + /// This setting determines what happens when a dynamically mapped field would exceed the total fields limit. When set + /// to false (the default), the index request of the document that tries to add a dynamic field to the mapping will fail + /// with the message Limit of total fields [X] has been exceeded. When set to true, the index request will not fail. + /// Instead, fields that would exceed the limit are not added to the mapping, similar to dynamic: false. + /// The fields that were not added to the mapping will be added to the _ignored field. + /// /// public MappingLimitSettingsTotalFieldsDescriptor IgnoreDynamicBeyondLimit(bool? ignoreDynamicBeyondLimit = true) { @@ -63,7 +79,11 @@ public MappingLimitSettingsTotalFieldsDescriptor IgnoreDynamicBeyondLimit(bool? } /// - /// The maximum number of fields in an index. Field and object mappings, as well as field aliases count towards this limit.
The limit is in place to prevent mappings and searches from becoming too large. Higher values can lead to performance
degradations and memory issues, especially in clusters with a high load or few resources. + /// + /// The maximum number of fields in an index. Field and object mappings, as well as field aliases count towards this limit. + /// The limit is in place to prevent mappings and searches from becoming too large. Higher values can lead to performance + /// degradations and memory issues, especially in clusters with a high load or few resources. + /// /// public MappingLimitSettingsTotalFieldsDescriptor Limit(long? limit) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/RemoveAction.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/RemoveAction.g.cs index d8feea8b1d3..580051e8000 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/RemoveAction.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/RemoveAction.g.cs @@ -30,32 +30,46 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class RemoveAction { /// - /// Alias for the action.
Index alias names support date math. + /// + /// Alias for the action. + /// Index alias names support date math. + /// /// [JsonInclude, JsonPropertyName("alias")] public Elastic.Clients.Elasticsearch.Serverless.IndexAlias? Alias { get; set; } /// - /// Aliases for the action.
Index alias names support date math. + /// + /// Aliases for the action. + /// Index alias names support date math. + /// /// [JsonInclude, JsonPropertyName("aliases")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.IndexAlias))] public ICollection? Aliases { get; set; } /// - /// Data stream or index for the action.
Supports wildcards (`*`). + /// + /// Data stream or index for the action. + /// Supports wildcards (*). + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.Serverless.IndexName? Index { get; set; } /// - /// Data streams or indices for the action.
Supports wildcards (`*`). + /// + /// Data streams or indices for the action. + /// Supports wildcards (*). + /// /// [JsonInclude, JsonPropertyName("indices")] public Elastic.Clients.Elasticsearch.Serverless.Indices? Indices { get; set; } /// - /// If `true`, the alias must exist to perform the action. + /// + /// If true, the alias must exist to perform the action. + /// /// [JsonInclude, JsonPropertyName("must_exist")] public bool? MustExist { get; set; } @@ -78,7 +92,10 @@ public RemoveActionDescriptor() : base() private bool? MustExistValue { get; set; } /// - /// Alias for the action.
Index alias names support date math. + /// + /// Alias for the action. + /// Index alias names support date math. + /// /// public RemoveActionDescriptor Alias(Elastic.Clients.Elasticsearch.Serverless.IndexAlias? alias) { @@ -87,7 +104,10 @@ public RemoveActionDescriptor Alias(Elastic.Clients.Elasticsearch.Serverless.Ind } /// - /// Aliases for the action.
Index alias names support date math. + /// + /// Aliases for the action. + /// Index alias names support date math. + /// /// public RemoveActionDescriptor Aliases(ICollection? aliases) { @@ -96,7 +116,10 @@ public RemoveActionDescriptor Aliases(ICollection - /// Data stream or index for the action.
Supports wildcards (`*`). + /// + /// Data stream or index for the action. + /// Supports wildcards (*). + /// /// public RemoveActionDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.IndexName? index) { @@ -105,7 +128,10 @@ public RemoveActionDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.Ind } /// - /// Data streams or indices for the action.
Supports wildcards (`*`). + /// + /// Data streams or indices for the action. + /// Supports wildcards (*). + /// /// public RemoveActionDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.Indices? indices) { @@ -114,7 +140,9 @@ public RemoveActionDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.I } /// - /// If `true`, the alias must exist to perform the action. + /// + /// If true, the alias must exist to perform the action. + /// /// public RemoveActionDescriptor MustExist(bool? mustExist = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/RemoveIndexAction.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/RemoveIndexAction.g.cs index 67b07f7bafe..ad925cdd4ea 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/RemoveIndexAction.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/RemoveIndexAction.g.cs @@ -30,19 +30,27 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class RemoveIndexAction { /// - /// Data stream or index for the action.
Supports wildcards (`*`). + /// + /// Data stream or index for the action. + /// Supports wildcards (*). + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.Serverless.IndexName? Index { get; set; } /// - /// Data streams or indices for the action.
Supports wildcards (`*`). + /// + /// Data streams or indices for the action. + /// Supports wildcards (*). + /// /// [JsonInclude, JsonPropertyName("indices")] public Elastic.Clients.Elasticsearch.Serverless.Indices? Indices { get; set; } /// - /// If `true`, the alias must exist to perform the action. + /// + /// If true, the alias must exist to perform the action. + /// /// [JsonInclude, JsonPropertyName("must_exist")] public bool? MustExist { get; set; } @@ -63,7 +71,10 @@ public RemoveIndexActionDescriptor() : base() private bool? MustExistValue { get; set; } /// - /// Data stream or index for the action.
Supports wildcards (`*`). + /// + /// Data stream or index for the action. + /// Supports wildcards (*). + /// /// public RemoveIndexActionDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.IndexName? index) { @@ -72,7 +83,10 @@ public RemoveIndexActionDescriptor Index(Elastic.Clients.Elasticsearch.Serverles } /// - /// Data streams or indices for the action.
Supports wildcards (`*`). + /// + /// Data streams or indices for the action. + /// Supports wildcards (*). + /// /// public RemoveIndexActionDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.Indices? indices) { @@ -81,7 +95,9 @@ public RemoveIndexActionDescriptor Indices(Elastic.Clients.Elasticsearch.Serverl } /// - /// If `true`, the alias must exist to perform the action. + /// + /// If true, the alias must exist to perform the action. + /// /// public RemoveIndexActionDescriptor MustExist(bool? mustExist = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/SoftDeletes.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/SoftDeletes.g.cs index 53b99958ef3..7a86dfc4ff6 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/SoftDeletes.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/SoftDeletes.g.cs @@ -30,13 +30,20 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class SoftDeletes { /// - /// Indicates whether soft deletes are enabled on the index. + /// + /// Indicates whether soft deletes are enabled on the index. + /// /// [JsonInclude, JsonPropertyName("enabled")] public bool? Enabled { get; set; } /// - /// The maximum period to retain a shard history retention lease before it is considered expired.
Shard history retention leases ensure that soft deletes are retained during merges on the Lucene
index. If a soft delete is merged away before it can be replicated to a follower the following
process will fail due to incomplete history on the leader. + /// + /// The maximum period to retain a shard history retention lease before it is considered expired. + /// Shard history retention leases ensure that soft deletes are retained during merges on the Lucene + /// index. If a soft delete is merged away before it can be replicated to a follower the following + /// process will fail due to incomplete history on the leader. + /// /// [JsonInclude, JsonPropertyName("retention_lease")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.RetentionLease? RetentionLease { get; set; } @@ -56,7 +63,9 @@ public SoftDeletesDescriptor() : base() private Action RetentionLeaseDescriptorAction { get; set; } /// - /// Indicates whether soft deletes are enabled on the index. + /// + /// Indicates whether soft deletes are enabled on the index. + /// /// public SoftDeletesDescriptor Enabled(bool? enabled = true) { @@ -65,7 +74,12 @@ public SoftDeletesDescriptor Enabled(bool? enabled = true) } /// - /// The maximum period to retain a shard history retention lease before it is considered expired.
Shard history retention leases ensure that soft deletes are retained during merges on the Lucene
index. If a soft delete is merged away before it can be replicated to a follower the following
process will fail due to incomplete history on the leader. + /// + /// The maximum period to retain a shard history retention lease before it is considered expired. + /// Shard history retention leases ensure that soft deletes are retained during merges on the Lucene + /// index. If a soft delete is merged away before it can be replicated to a follower the following + /// process will fail due to incomplete history on the leader. + /// /// public SoftDeletesDescriptor RetentionLease(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.RetentionLease? retentionLease) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/Storage.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/Storage.g.cs index 3f7891890a0..d24cf487179 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/Storage.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/Storage.g.cs @@ -30,7 +30,12 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class Storage { /// - /// You can restrict the use of the mmapfs and the related hybridfs store type via the setting node.store.allow_mmap.
This is a boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This
setting is useful, for example, if you are in an environment where you can not control the ability to create a lot
of memory maps so you need disable the ability to use memory-mapping. + /// + /// You can restrict the use of the mmapfs and the related hybridfs store type via the setting node.store.allow_mmap. + /// This is a boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This + /// setting is useful, for example, if you are in an environment where you can not control the ability to create a lot + /// of memory maps so you need disable the ability to use memory-mapping. + /// /// [JsonInclude, JsonPropertyName("allow_mmap")] public bool? AllowMmap { get; set; } @@ -50,7 +55,12 @@ public StorageDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.IndexManagement.StorageType TypeValue { get; set; } /// - /// You can restrict the use of the mmapfs and the related hybridfs store type via the setting node.store.allow_mmap.
This is a boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This
setting is useful, for example, if you are in an environment where you can not control the ability to create a lot
of memory maps so you need disable the ability to use memory-mapping. + /// + /// You can restrict the use of the mmapfs and the related hybridfs store type via the setting node.store.allow_mmap. + /// This is a boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This + /// setting is useful, for example, if you are in an environment where you can not control the ability to create a lot + /// of memory maps so you need disable the ability to use memory-mapping. + /// /// public StorageDescriptor AllowMmap(bool? allowMmap = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/Translog.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/Translog.g.cs index 6e62e1a7c3a..5d44519a217 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/Translog.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/Translog.g.cs @@ -30,13 +30,21 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class Translog { /// - /// Whether or not to `fsync` and commit the translog after every index, delete, update, or bulk request. + /// + /// Whether or not to fsync and commit the translog after every index, delete, update, or bulk request. + /// /// [JsonInclude, JsonPropertyName("durability")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.TranslogDurability? Durability { get; set; } /// - /// The translog stores all operations that are not yet safely persisted in Lucene (i.e., are not
part of a Lucene commit point). Although these operations are available for reads, they will need
to be replayed if the shard was stopped and had to be recovered. This setting controls the
maximum total size of these operations, to prevent recoveries from taking too long. Once the
maximum size has been reached a flush will happen, generating a new Lucene commit point. + /// + /// The translog stores all operations that are not yet safely persisted in Lucene (i.e., are not + /// part of a Lucene commit point). Although these operations are available for reads, they will need + /// to be replayed if the shard was stopped and had to be recovered. This setting controls the + /// maximum total size of these operations, to prevent recoveries from taking too long. Once the + /// maximum size has been reached a flush will happen, generating a new Lucene commit point. + /// /// [JsonInclude, JsonPropertyName("flush_threshold_size")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? FlushThresholdSize { get; set; } @@ -44,7 +52,10 @@ public sealed partial class Translog public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.TranslogRetention? Retention { get; set; } /// - /// How often the translog is fsynced to disk and committed, regardless of write operations.
Values less than 100ms are not allowed. + /// + /// How often the translog is fsynced to disk and committed, regardless of write operations. + /// Values less than 100ms are not allowed. + /// /// [JsonInclude, JsonPropertyName("sync_interval")] public Elastic.Clients.Elasticsearch.Serverless.Duration? SyncInterval { get; set; } @@ -66,7 +77,9 @@ public TranslogDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Duration? SyncIntervalValue { get; set; } /// - /// Whether or not to `fsync` and commit the translog after every index, delete, update, or bulk request. + /// + /// Whether or not to fsync and commit the translog after every index, delete, update, or bulk request. + /// /// public TranslogDescriptor Durability(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.TranslogDurability? durability) { @@ -75,7 +88,13 @@ public TranslogDescriptor Durability(Elastic.Clients.Elasticsearch.Serverless.In } /// - /// The translog stores all operations that are not yet safely persisted in Lucene (i.e., are not
part of a Lucene commit point). Although these operations are available for reads, they will need
to be replayed if the shard was stopped and had to be recovered. This setting controls the
maximum total size of these operations, to prevent recoveries from taking too long. Once the
maximum size has been reached a flush will happen, generating a new Lucene commit point. + /// + /// The translog stores all operations that are not yet safely persisted in Lucene (i.e., are not + /// part of a Lucene commit point). Although these operations are available for reads, they will need + /// to be replayed if the shard was stopped and had to be recovered. This setting controls the + /// maximum total size of these operations, to prevent recoveries from taking too long. Once the + /// maximum size has been reached a flush will happen, generating a new Lucene commit point. + /// /// public TranslogDescriptor FlushThresholdSize(Elastic.Clients.Elasticsearch.Serverless.ByteSize? flushThresholdSize) { @@ -108,7 +127,10 @@ public TranslogDescriptor Retention(Action - /// How often the translog is fsynced to disk and committed, regardless of write operations.
Values less than 100ms are not allowed. + /// + /// How often the translog is fsynced to disk and committed, regardless of write operations. + /// Values less than 100ms are not allowed. + /// /// public TranslogDescriptor SyncInterval(Elastic.Clients.Elasticsearch.Serverless.Duration? syncInterval) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/TranslogRetention.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/TranslogRetention.g.cs index 4f1e2ab503b..f75d4f1b16a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/TranslogRetention.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/TranslogRetention.g.cs @@ -30,13 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class TranslogRetention { /// - /// This controls the maximum duration for which translog files are kept by each shard. Keeping more
translog files increases the chance of performing an operation based sync when recovering replicas. If
the translog files are not sufficient, replica recovery will fall back to a file based sync. This setting
is ignored, and should not be set, if soft deletes are enabled. Soft deletes are enabled by default in
indices created in Elasticsearch versions 7.0.0 and later. + /// + /// This controls the maximum duration for which translog files are kept by each shard. Keeping more + /// translog files increases the chance of performing an operation based sync when recovering replicas. If + /// the translog files are not sufficient, replica recovery will fall back to a file based sync. This setting + /// is ignored, and should not be set, if soft deletes are enabled. Soft deletes are enabled by default in + /// indices created in Elasticsearch versions 7.0.0 and later. + /// /// [JsonInclude, JsonPropertyName("age")] public Elastic.Clients.Elasticsearch.Serverless.Duration? Age { get; set; } /// - /// This controls the total size of translog files to keep for each shard. Keeping more translog files increases
the chance of performing an operation based sync when recovering a replica. If the translog files are not
sufficient, replica recovery will fall back to a file based sync. This setting is ignored, and should not be
set, if soft deletes are enabled. Soft deletes are enabled by default in indices created in Elasticsearch
versions 7.0.0 and later. + /// + /// This controls the total size of translog files to keep for each shard. Keeping more translog files increases + /// the chance of performing an operation based sync when recovering a replica. If the translog files are not + /// sufficient, replica recovery will fall back to a file based sync. This setting is ignored, and should not be + /// set, if soft deletes are enabled. Soft deletes are enabled by default in indices created in Elasticsearch + /// versions 7.0.0 and later. + /// /// [JsonInclude, JsonPropertyName("size")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? Size { get; set; } @@ -54,7 +66,13 @@ public TranslogRetentionDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.ByteSize? SizeValue { get; set; } /// - /// This controls the maximum duration for which translog files are kept by each shard. Keeping more
translog files increases the chance of performing an operation based sync when recovering replicas. If
the translog files are not sufficient, replica recovery will fall back to a file based sync. This setting
is ignored, and should not be set, if soft deletes are enabled. Soft deletes are enabled by default in
indices created in Elasticsearch versions 7.0.0 and later. + /// + /// This controls the maximum duration for which translog files are kept by each shard. Keeping more + /// translog files increases the chance of performing an operation based sync when recovering replicas. If + /// the translog files are not sufficient, replica recovery will fall back to a file based sync. This setting + /// is ignored, and should not be set, if soft deletes are enabled. Soft deletes are enabled by default in + /// indices created in Elasticsearch versions 7.0.0 and later. + /// /// public TranslogRetentionDescriptor Age(Elastic.Clients.Elasticsearch.Serverless.Duration? age) { @@ -63,7 +81,13 @@ public TranslogRetentionDescriptor Age(Elastic.Clients.Elasticsearch.Serverless. } /// - /// This controls the total size of translog files to keep for each shard. Keeping more translog files increases
the chance of performing an operation based sync when recovering a replica. If the translog files are not
sufficient, replica recovery will fall back to a file based sync. This setting is ignored, and should not be
set, if soft deletes are enabled. Soft deletes are enabled by default in indices created in Elasticsearch
versions 7.0.0 and later. + /// + /// This controls the total size of translog files to keep for each shard. Keeping more translog files increases + /// the chance of performing an operation based sync when recovering a replica. If the translog files are not + /// sufficient, replica recovery will fall back to a file based sync. This setting is ignored, and should not be + /// set, if soft deletes are enabled. Soft deletes are enabled by default in indices created in Elasticsearch + /// versions 7.0.0 and later. + /// /// public TranslogRetentionDescriptor Size(Elastic.Clients.Elasticsearch.Serverless.ByteSize? size) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndicesOptions.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndicesOptions.g.cs index fd75f1f9092..a71d5c87c47 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndicesOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndicesOptions.g.cs @@ -28,38 +28,56 @@ namespace Elastic.Clients.Elasticsearch.Serverless; /// -/// Controls how to deal with unavailable concrete indices (closed or missing), how wildcard expressions are expanded
to actual indices (all, closed or open indices) and how to deal with wildcard expressions that resolve to no indices. +/// +/// Controls how to deal with unavailable concrete indices (closed or missing), how wildcard expressions are expanded +/// to actual indices (all, closed or open indices) and how to deal with wildcard expressions that resolve to no indices. +/// /// public sealed partial class IndicesOptions { /// - /// If false, the request returns an error if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices. This behavior applies even if the request targets other open indices. For example,
a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only + /// missing or closed indices. This behavior applies even if the request targets other open indices. For example, + /// a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// [JsonInclude, JsonPropertyName("allow_no_indices")] public bool? AllowNoIndices { get; set; } /// - /// Type of index that wildcard patterns can match. If the request can target data streams, this argument
determines whether wildcard expressions match hidden data streams. Supports comma-separated values,
such as `open,hidden`. + /// + /// Type of index that wildcard patterns can match. If the request can target data streams, this argument + /// determines whether wildcard expressions match hidden data streams. Supports comma-separated values, + /// such as open,hidden. + /// /// [JsonInclude, JsonPropertyName("expand_wildcards")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.ExpandWildcard))] public ICollection? ExpandWildcards { get; set; } /// - /// If true, concrete, expanded or aliased indices are ignored when frozen. + /// + /// If true, concrete, expanded or aliased indices are ignored when frozen. + /// /// [JsonInclude, JsonPropertyName("ignore_throttled")] public bool? IgnoreThrottled { get; set; } /// - /// If true, missing or closed indices are not included in the response. + /// + /// If true, missing or closed indices are not included in the response. + /// /// [JsonInclude, JsonPropertyName("ignore_unavailable")] public bool? IgnoreUnavailable { get; set; } } /// -/// Controls how to deal with unavailable concrete indices (closed or missing), how wildcard expressions are expanded
to actual indices (all, closed or open indices) and how to deal with wildcard expressions that resolve to no indices. +/// +/// Controls how to deal with unavailable concrete indices (closed or missing), how wildcard expressions are expanded +/// to actual indices (all, closed or open indices) and how to deal with wildcard expressions that resolve to no indices. +/// /// public sealed partial class IndicesOptionsDescriptor : SerializableDescriptor { @@ -75,7 +93,11 @@ public IndicesOptionsDescriptor() : base() private bool? IgnoreUnavailableValue { get; set; } /// - /// If false, the request returns an error if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices. This behavior applies even if the request targets other open indices. For example,
a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only + /// missing or closed indices. This behavior applies even if the request targets other open indices. For example, + /// a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// public IndicesOptionsDescriptor AllowNoIndices(bool? allowNoIndices = true) { @@ -84,7 +106,11 @@ public IndicesOptionsDescriptor AllowNoIndices(bool? allowNoIndices = true) } /// - /// Type of index that wildcard patterns can match. If the request can target data streams, this argument
determines whether wildcard expressions match hidden data streams. Supports comma-separated values,
such as `open,hidden`. + /// + /// Type of index that wildcard patterns can match. If the request can target data streams, this argument + /// determines whether wildcard expressions match hidden data streams. Supports comma-separated values, + /// such as open,hidden. + /// /// public IndicesOptionsDescriptor ExpandWildcards(ICollection? expandWildcards) { @@ -93,7 +119,9 @@ public IndicesOptionsDescriptor ExpandWildcards(ICollection - /// If true, concrete, expanded or aliased indices are ignored when frozen. + /// + /// If true, concrete, expanded or aliased indices are ignored when frozen. + /// /// public IndicesOptionsDescriptor IgnoreThrottled(bool? ignoreThrottled = true) { @@ -102,7 +130,9 @@ public IndicesOptionsDescriptor IgnoreThrottled(bool? ignoreThrottled = true) } /// - /// If true, missing or closed indices are not included in the response. + /// + /// If true, missing or closed indices are not included in the response. + /// /// public IndicesOptionsDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/AppendProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/AppendProcessor.g.cs index 4e58cd26243..0e2b0839e9a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/AppendProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/AppendProcessor.g.cs @@ -30,49 +30,68 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class AppendProcessor { /// - /// If `false`, the processor does not append values already present in the field. + /// + /// If false, the processor does not append values already present in the field. + /// /// [JsonInclude, JsonPropertyName("allow_duplicates")] public bool? AllowDuplicates { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to be appended to.
Supports template snippets. + /// + /// The field to be appended to. + /// Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The value to be appended. Supports template snippets. + /// + /// The value to be appended. Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("value")] public ICollection Value { get; set; } @@ -101,7 +120,9 @@ public AppendProcessorDescriptor() : base() private ICollection ValueValue { get; set; } /// - /// If `false`, the processor does not append values already present in the field. + /// + /// If false, the processor does not append values already present in the field. + /// /// public AppendProcessorDescriptor AllowDuplicates(bool? allowDuplicates = true) { @@ -110,7 +131,10 @@ public AppendProcessorDescriptor AllowDuplicates(bool? allowDuplicate } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public AppendProcessorDescriptor Description(string? description) { @@ -119,7 +143,10 @@ public AppendProcessorDescriptor Description(string? description) } /// - /// The field to be appended to.
Supports template snippets. + /// + /// The field to be appended to. + /// Supports template snippets. + /// /// public AppendProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -128,7 +155,10 @@ public AppendProcessorDescriptor Field(Elastic.Clients.Elasticsearch. } /// - /// The field to be appended to.
Supports template snippets. + /// + /// The field to be appended to. + /// Supports template snippets. + /// /// public AppendProcessorDescriptor Field(Expression> field) { @@ -137,7 +167,10 @@ public AppendProcessorDescriptor Field(Expression - /// The field to be appended to.
Supports template snippets. + /// + /// The field to be appended to. + /// Supports template snippets. + /// /// public AppendProcessorDescriptor Field(Expression> field) { @@ -146,7 +179,9 @@ public AppendProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public AppendProcessorDescriptor If(string? value) { @@ -155,7 +190,9 @@ public AppendProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public AppendProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -164,7 +201,9 @@ public AppendProcessorDescriptor IgnoreFailure(bool? ignoreFailure = } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public AppendProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -203,7 +242,10 @@ public AppendProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public AppendProcessorDescriptor Tag(string? tag) { @@ -212,7 +254,9 @@ public AppendProcessorDescriptor Tag(string? tag) } /// - /// The value to be appended. Supports template snippets. + /// + /// The value to be appended. Supports template snippets. + /// /// public AppendProcessorDescriptor Value(ICollection value) { @@ -313,7 +357,9 @@ public AppendProcessorDescriptor() : base() private ICollection ValueValue { get; set; } /// - /// If `false`, the processor does not append values already present in the field. + /// + /// If false, the processor does not append values already present in the field. + /// /// public AppendProcessorDescriptor AllowDuplicates(bool? allowDuplicates = true) { @@ -322,7 +368,10 @@ public AppendProcessorDescriptor AllowDuplicates(bool? allowDuplicates = true) } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public AppendProcessorDescriptor Description(string? description) { @@ -331,7 +380,10 @@ public AppendProcessorDescriptor Description(string? description) } /// - /// The field to be appended to.
Supports template snippets. + /// + /// The field to be appended to. + /// Supports template snippets. + /// /// public AppendProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -340,7 +392,10 @@ public AppendProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless. } /// - /// The field to be appended to.
Supports template snippets. + /// + /// The field to be appended to. + /// Supports template snippets. + /// /// public AppendProcessorDescriptor Field(Expression> field) { @@ -349,7 +404,10 @@ public AppendProcessorDescriptor Field(Expression - /// The field to be appended to.
Supports template snippets. + /// + /// The field to be appended to. + /// Supports template snippets. + /// /// public AppendProcessorDescriptor Field(Expression> field) { @@ -358,7 +416,9 @@ public AppendProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public AppendProcessorDescriptor If(string? value) { @@ -367,7 +427,9 @@ public AppendProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public AppendProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -376,7 +438,9 @@ public AppendProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public AppendProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -415,7 +479,10 @@ public AppendProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public AppendProcessorDescriptor Tag(string? tag) { @@ -424,7 +491,9 @@ public AppendProcessorDescriptor Tag(string? tag) } /// - /// The value to be appended. Supports template snippets. + /// + /// The value to be appended. Supports template snippets. + /// /// public AppendProcessorDescriptor Value(ICollection value) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/AttachmentProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/AttachmentProcessor.g.cs index 146fe7e6284..0a33244ee82 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/AttachmentProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/AttachmentProcessor.g.cs @@ -30,79 +30,110 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class AttachmentProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to get the base64 encoded field from. + /// + /// The field to get the base64 encoded field from. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and field does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// The number of chars being used for extraction to prevent huge fields.
Use `-1` for no limit. + /// + /// The number of chars being used for extraction to prevent huge fields. + /// Use -1 for no limit. + /// /// [JsonInclude, JsonPropertyName("indexed_chars")] public long? IndexedChars { get; set; } /// - /// Field name from which you can overwrite the number of chars being used for extraction. + /// + /// Field name from which you can overwrite the number of chars being used for extraction. + /// /// [JsonInclude, JsonPropertyName("indexed_chars_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? IndexedCharsField { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Array of properties to select to be stored.
Can be `content`, `title`, `name`, `author`, `keywords`, `date`, `content_type`, `content_length`, `language`. + /// + /// Array of properties to select to be stored. + /// Can be content, title, name, author, keywords, date, content_type, content_length, language. + /// /// [JsonInclude, JsonPropertyName("properties")] public ICollection? Properties { get; set; } /// - /// If true, the binary field will be removed from the document + /// + /// If true, the binary field will be removed from the document + /// /// [JsonInclude, JsonPropertyName("remove_binary")] public bool? RemoveBinary { get; set; } /// - /// Field containing the name of the resource to decode.
If specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection. + /// + /// Field containing the name of the resource to decode. + /// If specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection. + /// /// [JsonInclude, JsonPropertyName("resource_name")] public string? ResourceName { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field that will hold the attachment information. + /// + /// The field that will hold the attachment information. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? TargetField { get; set; } @@ -136,7 +167,10 @@ public AttachmentProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public AttachmentProcessorDescriptor Description(string? description) { @@ -145,7 +179,9 @@ public AttachmentProcessorDescriptor Description(string? description) } /// - /// The field to get the base64 encoded field from. + /// + /// The field to get the base64 encoded field from. + /// /// public AttachmentProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -154,7 +190,9 @@ public AttachmentProcessorDescriptor Field(Elastic.Clients.Elasticsea } /// - /// The field to get the base64 encoded field from. + /// + /// The field to get the base64 encoded field from. + /// /// public AttachmentProcessorDescriptor Field(Expression> field) { @@ -163,7 +201,9 @@ public AttachmentProcessorDescriptor Field(Expression - /// The field to get the base64 encoded field from. + /// + /// The field to get the base64 encoded field from. + /// /// public AttachmentProcessorDescriptor Field(Expression> field) { @@ -172,7 +212,9 @@ public AttachmentProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public AttachmentProcessorDescriptor If(string? value) { @@ -181,7 +223,9 @@ public AttachmentProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public AttachmentProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -190,7 +234,9 @@ public AttachmentProcessorDescriptor IgnoreFailure(bool? ignoreFailur } /// - /// If `true` and field does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public AttachmentProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -199,7 +245,10 @@ public AttachmentProcessorDescriptor IgnoreMissing(bool? ignoreMissin } /// - /// The number of chars being used for extraction to prevent huge fields.
Use `-1` for no limit. + /// + /// The number of chars being used for extraction to prevent huge fields. + /// Use -1 for no limit. + /// /// public AttachmentProcessorDescriptor IndexedChars(long? indexedChars) { @@ -208,7 +257,9 @@ public AttachmentProcessorDescriptor IndexedChars(long? indexedChars) } /// - /// Field name from which you can overwrite the number of chars being used for extraction. + /// + /// Field name from which you can overwrite the number of chars being used for extraction. + /// /// public AttachmentProcessorDescriptor IndexedCharsField(Elastic.Clients.Elasticsearch.Serverless.Field? indexedCharsField) { @@ -217,7 +268,9 @@ public AttachmentProcessorDescriptor IndexedCharsField(Elastic.Client } /// - /// Field name from which you can overwrite the number of chars being used for extraction. + /// + /// Field name from which you can overwrite the number of chars being used for extraction. + /// /// public AttachmentProcessorDescriptor IndexedCharsField(Expression> indexedCharsField) { @@ -226,7 +279,9 @@ public AttachmentProcessorDescriptor IndexedCharsField(Expres } /// - /// Field name from which you can overwrite the number of chars being used for extraction. + /// + /// Field name from which you can overwrite the number of chars being used for extraction. + /// /// public AttachmentProcessorDescriptor IndexedCharsField(Expression> indexedCharsField) { @@ -235,7 +290,9 @@ public AttachmentProcessorDescriptor IndexedCharsField(Expression - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public AttachmentProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -274,7 +331,10 @@ public AttachmentProcessorDescriptor OnFailure(params Action - /// Array of properties to select to be stored.
Can be `content`, `title`, `name`, `author`, `keywords`, `date`, `content_type`, `content_length`, `language`. + /// + /// Array of properties to select to be stored. + /// Can be content, title, name, author, keywords, date, content_type, content_length, language. + /// /// public AttachmentProcessorDescriptor Properties(ICollection? properties) { @@ -283,7 +343,9 @@ public AttachmentProcessorDescriptor Properties(ICollection? } /// - /// If true, the binary field will be removed from the document + /// + /// If true, the binary field will be removed from the document + /// /// public AttachmentProcessorDescriptor RemoveBinary(bool? removeBinary = true) { @@ -292,7 +354,10 @@ public AttachmentProcessorDescriptor RemoveBinary(bool? removeBinary } /// - /// Field containing the name of the resource to decode.
If specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection. + /// + /// Field containing the name of the resource to decode. + /// If specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection. + /// /// public AttachmentProcessorDescriptor ResourceName(string? resourceName) { @@ -301,7 +366,10 @@ public AttachmentProcessorDescriptor ResourceName(string? resourceNam } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public AttachmentProcessorDescriptor Tag(string? tag) { @@ -310,7 +378,9 @@ public AttachmentProcessorDescriptor Tag(string? tag) } /// - /// The field that will hold the attachment information. + /// + /// The field that will hold the attachment information. + /// /// public AttachmentProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -319,7 +389,9 @@ public AttachmentProcessorDescriptor TargetField(Elastic.Clients.Elas } /// - /// The field that will hold the attachment information. + /// + /// The field that will hold the attachment information. + /// /// public AttachmentProcessorDescriptor TargetField(Expression> targetField) { @@ -328,7 +400,9 @@ public AttachmentProcessorDescriptor TargetField(Expression - /// The field that will hold the attachment information. + /// + /// The field that will hold the attachment information. + /// /// public AttachmentProcessorDescriptor TargetField(Expression> targetField) { @@ -468,7 +542,10 @@ public AttachmentProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public AttachmentProcessorDescriptor Description(string? description) { @@ -477,7 +554,9 @@ public AttachmentProcessorDescriptor Description(string? description) } /// - /// The field to get the base64 encoded field from. + /// + /// The field to get the base64 encoded field from. + /// /// public AttachmentProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -486,7 +565,9 @@ public AttachmentProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverl } /// - /// The field to get the base64 encoded field from. + /// + /// The field to get the base64 encoded field from. + /// /// public AttachmentProcessorDescriptor Field(Expression> field) { @@ -495,7 +576,9 @@ public AttachmentProcessorDescriptor Field(Expression - /// The field to get the base64 encoded field from. + /// + /// The field to get the base64 encoded field from. + /// /// public AttachmentProcessorDescriptor Field(Expression> field) { @@ -504,7 +587,9 @@ public AttachmentProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public AttachmentProcessorDescriptor If(string? value) { @@ -513,7 +598,9 @@ public AttachmentProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public AttachmentProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -522,7 +609,9 @@ public AttachmentProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and field does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public AttachmentProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -531,7 +620,10 @@ public AttachmentProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// The number of chars being used for extraction to prevent huge fields.
Use `-1` for no limit. + /// + /// The number of chars being used for extraction to prevent huge fields. + /// Use -1 for no limit. + /// /// public AttachmentProcessorDescriptor IndexedChars(long? indexedChars) { @@ -540,7 +632,9 @@ public AttachmentProcessorDescriptor IndexedChars(long? indexedChars) } /// - /// Field name from which you can overwrite the number of chars being used for extraction. + /// + /// Field name from which you can overwrite the number of chars being used for extraction. + /// /// public AttachmentProcessorDescriptor IndexedCharsField(Elastic.Clients.Elasticsearch.Serverless.Field? indexedCharsField) { @@ -549,7 +643,9 @@ public AttachmentProcessorDescriptor IndexedCharsField(Elastic.Clients.Elasticse } /// - /// Field name from which you can overwrite the number of chars being used for extraction. + /// + /// Field name from which you can overwrite the number of chars being used for extraction. + /// /// public AttachmentProcessorDescriptor IndexedCharsField(Expression> indexedCharsField) { @@ -558,7 +654,9 @@ public AttachmentProcessorDescriptor IndexedCharsField(Expres } /// - /// Field name from which you can overwrite the number of chars being used for extraction. + /// + /// Field name from which you can overwrite the number of chars being used for extraction. + /// /// public AttachmentProcessorDescriptor IndexedCharsField(Expression> indexedCharsField) { @@ -567,7 +665,9 @@ public AttachmentProcessorDescriptor IndexedCharsField(Expression - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public AttachmentProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -606,7 +706,10 @@ public AttachmentProcessorDescriptor OnFailure(params Action - /// Array of properties to select to be stored.
Can be `content`, `title`, `name`, `author`, `keywords`, `date`, `content_type`, `content_length`, `language`. + /// + /// Array of properties to select to be stored. + /// Can be content, title, name, author, keywords, date, content_type, content_length, language. + /// /// public AttachmentProcessorDescriptor Properties(ICollection? properties) { @@ -615,7 +718,9 @@ public AttachmentProcessorDescriptor Properties(ICollection? properties) } /// - /// If true, the binary field will be removed from the document + /// + /// If true, the binary field will be removed from the document + /// /// public AttachmentProcessorDescriptor RemoveBinary(bool? removeBinary = true) { @@ -624,7 +729,10 @@ public AttachmentProcessorDescriptor RemoveBinary(bool? removeBinary = true) } /// - /// Field containing the name of the resource to decode.
If specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection. + /// + /// Field containing the name of the resource to decode. + /// If specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection. + /// /// public AttachmentProcessorDescriptor ResourceName(string? resourceName) { @@ -633,7 +741,10 @@ public AttachmentProcessorDescriptor ResourceName(string? resourceName) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public AttachmentProcessorDescriptor Tag(string? tag) { @@ -642,7 +753,9 @@ public AttachmentProcessorDescriptor Tag(string? tag) } /// - /// The field that will hold the attachment information. + /// + /// The field that will hold the attachment information. + /// /// public AttachmentProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -651,7 +764,9 @@ public AttachmentProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.S } /// - /// The field that will hold the attachment information. + /// + /// The field that will hold the attachment information. + /// /// public AttachmentProcessorDescriptor TargetField(Expression> targetField) { @@ -660,7 +775,9 @@ public AttachmentProcessorDescriptor TargetField(Expression - /// The field that will hold the attachment information. + /// + /// The field that will hold the attachment information. + /// /// public AttachmentProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/BytesProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/BytesProcessor.g.cs index 71186a3998f..2477837b43a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/BytesProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/BytesProcessor.g.cs @@ -30,49 +30,68 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class BytesProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to convert. + /// + /// The field to convert. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? TargetField { get; set; } @@ -101,7 +120,10 @@ public BytesProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public BytesProcessorDescriptor Description(string? description) { @@ -110,7 +132,9 @@ public BytesProcessorDescriptor Description(string? description) } /// - /// The field to convert. + /// + /// The field to convert. + /// /// public BytesProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -119,7 +143,9 @@ public BytesProcessorDescriptor Field(Elastic.Clients.Elasticsearch.S } /// - /// The field to convert. + /// + /// The field to convert. + /// /// public BytesProcessorDescriptor Field(Expression> field) { @@ -128,7 +154,9 @@ public BytesProcessorDescriptor Field(Expression - /// The field to convert. + /// + /// The field to convert. + /// /// public BytesProcessorDescriptor Field(Expression> field) { @@ -137,7 +165,9 @@ public BytesProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public BytesProcessorDescriptor If(string? value) { @@ -146,7 +176,9 @@ public BytesProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public BytesProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -155,7 +187,9 @@ public BytesProcessorDescriptor IgnoreFailure(bool? ignoreFailure = t } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public BytesProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -164,7 +198,9 @@ public BytesProcessorDescriptor IgnoreMissing(bool? ignoreMissing = t } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public BytesProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -203,7 +239,10 @@ public BytesProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public BytesProcessorDescriptor Tag(string? tag) { @@ -212,7 +251,10 @@ public BytesProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public BytesProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -221,7 +263,10 @@ public BytesProcessorDescriptor TargetField(Elastic.Clients.Elasticse } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public BytesProcessorDescriptor TargetField(Expression> targetField) { @@ -230,7 +275,10 @@ public BytesProcessorDescriptor TargetField(Expression - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public BytesProcessorDescriptor TargetField(Expression> targetField) { @@ -335,7 +383,10 @@ public BytesProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public BytesProcessorDescriptor Description(string? description) { @@ -344,7 +395,9 @@ public BytesProcessorDescriptor Description(string? description) } /// - /// The field to convert. + /// + /// The field to convert. + /// /// public BytesProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -353,7 +406,9 @@ public BytesProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.F } /// - /// The field to convert. + /// + /// The field to convert. + /// /// public BytesProcessorDescriptor Field(Expression> field) { @@ -362,7 +417,9 @@ public BytesProcessorDescriptor Field(Expression - /// The field to convert. + /// + /// The field to convert. + /// /// public BytesProcessorDescriptor Field(Expression> field) { @@ -371,7 +428,9 @@ public BytesProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public BytesProcessorDescriptor If(string? value) { @@ -380,7 +439,9 @@ public BytesProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public BytesProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -389,7 +450,9 @@ public BytesProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public BytesProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -398,7 +461,9 @@ public BytesProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public BytesProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -437,7 +502,10 @@ public BytesProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public BytesProcessorDescriptor Tag(string? tag) { @@ -446,7 +514,10 @@ public BytesProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public BytesProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -455,7 +526,10 @@ public BytesProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Server } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public BytesProcessorDescriptor TargetField(Expression> targetField) { @@ -464,7 +538,10 @@ public BytesProcessorDescriptor TargetField(Expression - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public BytesProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/CircleProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/CircleProcessor.g.cs index edc6c3e0520..f0ccc3c7d70 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/CircleProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/CircleProcessor.g.cs @@ -30,61 +30,84 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class CircleProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for `geo_shape`, unit-less for `shape`). + /// + /// The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for geo_shape, unit-less for shape). + /// /// [JsonInclude, JsonPropertyName("error_distance")] public double ErrorDistance { get; set; } /// - /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// + /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Which field mapping type is to be used when processing the circle: `geo_shape` or `shape`. + /// + /// Which field mapping type is to be used when processing the circle: geo_shape or shape. + /// /// [JsonInclude, JsonPropertyName("shape_type")] public Elastic.Clients.Elasticsearch.Serverless.Ingest.ShapeType ShapeType { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field to assign the polygon shape to
By default, the field is updated in-place. + /// + /// The field to assign the polygon shape to + /// By default, the field is updated in-place. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? TargetField { get; set; } @@ -115,7 +138,10 @@ public CircleProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public CircleProcessorDescriptor Description(string? description) { @@ -124,7 +150,9 @@ public CircleProcessorDescriptor Description(string? description) } /// - /// The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for `geo_shape`, unit-less for `shape`). + /// + /// The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for geo_shape, unit-less for shape). + /// /// public CircleProcessorDescriptor ErrorDistance(double errorDistance) { @@ -133,7 +161,9 @@ public CircleProcessorDescriptor ErrorDistance(double errorDistance) } /// - /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// + /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// /// public CircleProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -142,7 +172,9 @@ public CircleProcessorDescriptor Field(Elastic.Clients.Elasticsearch. } /// - /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// + /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// /// public CircleProcessorDescriptor Field(Expression> field) { @@ -151,7 +183,9 @@ public CircleProcessorDescriptor Field(Expression - /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// + /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// /// public CircleProcessorDescriptor Field(Expression> field) { @@ -160,7 +194,9 @@ public CircleProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public CircleProcessorDescriptor If(string? value) { @@ -169,7 +205,9 @@ public CircleProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public CircleProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -178,7 +216,9 @@ public CircleProcessorDescriptor IgnoreFailure(bool? ignoreFailure = } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public CircleProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -187,7 +227,9 @@ public CircleProcessorDescriptor IgnoreMissing(bool? ignoreMissing = } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public CircleProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -226,7 +268,9 @@ public CircleProcessorDescriptor OnFailure(params Action - /// Which field mapping type is to be used when processing the circle: `geo_shape` or `shape`. + /// + /// Which field mapping type is to be used when processing the circle: geo_shape or shape. + /// /// public CircleProcessorDescriptor ShapeType(Elastic.Clients.Elasticsearch.Serverless.Ingest.ShapeType shapeType) { @@ -235,7 +279,10 @@ public CircleProcessorDescriptor ShapeType(Elastic.Clients.Elasticsea } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public CircleProcessorDescriptor Tag(string? tag) { @@ -244,7 +291,10 @@ public CircleProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the polygon shape to
By default, the field is updated in-place. + /// + /// The field to assign the polygon shape to + /// By default, the field is updated in-place. + /// /// public CircleProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -253,7 +303,10 @@ public CircleProcessorDescriptor TargetField(Elastic.Clients.Elastics } /// - /// The field to assign the polygon shape to
By default, the field is updated in-place. + /// + /// The field to assign the polygon shape to + /// By default, the field is updated in-place. + /// /// public CircleProcessorDescriptor TargetField(Expression> targetField) { @@ -262,7 +315,10 @@ public CircleProcessorDescriptor TargetField(Expression - /// The field to assign the polygon shape to
By default, the field is updated in-place. + /// + /// The field to assign the polygon shape to + /// By default, the field is updated in-place. + /// /// public CircleProcessorDescriptor TargetField(Expression> targetField) { @@ -373,7 +429,10 @@ public CircleProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public CircleProcessorDescriptor Description(string? description) { @@ -382,7 +441,9 @@ public CircleProcessorDescriptor Description(string? description) } /// - /// The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for `geo_shape`, unit-less for `shape`). + /// + /// The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for geo_shape, unit-less for shape). + /// /// public CircleProcessorDescriptor ErrorDistance(double errorDistance) { @@ -391,7 +452,9 @@ public CircleProcessorDescriptor ErrorDistance(double errorDistance) } /// - /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// + /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// /// public CircleProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -400,7 +463,9 @@ public CircleProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless. } /// - /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// + /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// /// public CircleProcessorDescriptor Field(Expression> field) { @@ -409,7 +474,9 @@ public CircleProcessorDescriptor Field(Expression - /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// + /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// /// public CircleProcessorDescriptor Field(Expression> field) { @@ -418,7 +485,9 @@ public CircleProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public CircleProcessorDescriptor If(string? value) { @@ -427,7 +496,9 @@ public CircleProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public CircleProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -436,7 +507,9 @@ public CircleProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public CircleProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -445,7 +518,9 @@ public CircleProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public CircleProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -484,7 +559,9 @@ public CircleProcessorDescriptor OnFailure(params Action - /// Which field mapping type is to be used when processing the circle: `geo_shape` or `shape`. + /// + /// Which field mapping type is to be used when processing the circle: geo_shape or shape. + /// /// public CircleProcessorDescriptor ShapeType(Elastic.Clients.Elasticsearch.Serverless.Ingest.ShapeType shapeType) { @@ -493,7 +570,10 @@ public CircleProcessorDescriptor ShapeType(Elastic.Clients.Elasticsearch.Serverl } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public CircleProcessorDescriptor Tag(string? tag) { @@ -502,7 +582,10 @@ public CircleProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the polygon shape to
By default, the field is updated in-place. + /// + /// The field to assign the polygon shape to + /// By default, the field is updated in-place. + /// /// public CircleProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -511,7 +594,10 @@ public CircleProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serve } /// - /// The field to assign the polygon shape to
By default, the field is updated in-place. + /// + /// The field to assign the polygon shape to + /// By default, the field is updated in-place. + /// /// public CircleProcessorDescriptor TargetField(Expression> targetField) { @@ -520,7 +606,10 @@ public CircleProcessorDescriptor TargetField(Expression - /// The field to assign the polygon shape to
By default, the field is updated in-place. + /// + /// The field to assign the polygon shape to + /// By default, the field is updated in-place. + /// /// public CircleProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/ConvertProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/ConvertProcessor.g.cs index c9dbebe2bd3..e5fbdcfca4c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/ConvertProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/ConvertProcessor.g.cs @@ -30,55 +30,76 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class ConvertProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field whose value is to be converted. + /// + /// The field whose value is to be converted. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field to assign the converted value to.
By default, the `field` is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? TargetField { get; set; } /// - /// The type to convert the existing value to. + /// + /// The type to convert the existing value to. + /// /// [JsonInclude, JsonPropertyName("type")] public Elastic.Clients.Elasticsearch.Serverless.Ingest.ConvertType Type { get; set; } @@ -108,7 +129,10 @@ public ConvertProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Ingest.ConvertType TypeValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public ConvertProcessorDescriptor Description(string? description) { @@ -117,7 +141,9 @@ public ConvertProcessorDescriptor Description(string? description) } /// - /// The field whose value is to be converted. + /// + /// The field whose value is to be converted. + /// /// public ConvertProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -126,7 +152,9 @@ public ConvertProcessorDescriptor Field(Elastic.Clients.Elasticsearch } /// - /// The field whose value is to be converted. + /// + /// The field whose value is to be converted. + /// /// public ConvertProcessorDescriptor Field(Expression> field) { @@ -135,7 +163,9 @@ public ConvertProcessorDescriptor Field(Expression - /// The field whose value is to be converted. + /// + /// The field whose value is to be converted. + /// /// public ConvertProcessorDescriptor Field(Expression> field) { @@ -144,7 +174,9 @@ public ConvertProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public ConvertProcessorDescriptor If(string? value) { @@ -153,7 +185,9 @@ public ConvertProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public ConvertProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -162,7 +196,9 @@ public ConvertProcessorDescriptor IgnoreFailure(bool? ignoreFailure = } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public ConvertProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -171,7 +207,9 @@ public ConvertProcessorDescriptor IgnoreMissing(bool? ignoreMissing = } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public ConvertProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -210,7 +248,10 @@ public ConvertProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public ConvertProcessorDescriptor Tag(string? tag) { @@ -219,7 +260,10 @@ public ConvertProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the converted value to.
By default, the `field` is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public ConvertProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -228,7 +272,10 @@ public ConvertProcessorDescriptor TargetField(Elastic.Clients.Elastic } /// - /// The field to assign the converted value to.
By default, the `field` is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public ConvertProcessorDescriptor TargetField(Expression> targetField) { @@ -237,7 +284,10 @@ public ConvertProcessorDescriptor TargetField(Expression - /// The field to assign the converted value to.
By default, the `field` is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public ConvertProcessorDescriptor TargetField(Expression> targetField) { @@ -246,7 +296,9 @@ public ConvertProcessorDescriptor TargetField(Expression - /// The type to convert the existing value to. + /// + /// The type to convert the existing value to. + /// /// public ConvertProcessorDescriptor Type(Elastic.Clients.Elasticsearch.Serverless.Ingest.ConvertType type) { @@ -354,7 +406,10 @@ public ConvertProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Ingest.ConvertType TypeValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public ConvertProcessorDescriptor Description(string? description) { @@ -363,7 +418,9 @@ public ConvertProcessorDescriptor Description(string? description) } /// - /// The field whose value is to be converted. + /// + /// The field whose value is to be converted. + /// /// public ConvertProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -372,7 +429,9 @@ public ConvertProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless } /// - /// The field whose value is to be converted. + /// + /// The field whose value is to be converted. + /// /// public ConvertProcessorDescriptor Field(Expression> field) { @@ -381,7 +440,9 @@ public ConvertProcessorDescriptor Field(Expression - /// The field whose value is to be converted. + /// + /// The field whose value is to be converted. + /// /// public ConvertProcessorDescriptor Field(Expression> field) { @@ -390,7 +451,9 @@ public ConvertProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public ConvertProcessorDescriptor If(string? value) { @@ -399,7 +462,9 @@ public ConvertProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public ConvertProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -408,7 +473,9 @@ public ConvertProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public ConvertProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -417,7 +484,9 @@ public ConvertProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public ConvertProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -456,7 +525,10 @@ public ConvertProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public ConvertProcessorDescriptor Tag(string? tag) { @@ -465,7 +537,10 @@ public ConvertProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the converted value to.
By default, the `field` is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public ConvertProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -474,7 +549,10 @@ public ConvertProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serv } /// - /// The field to assign the converted value to.
By default, the `field` is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public ConvertProcessorDescriptor TargetField(Expression> targetField) { @@ -483,7 +561,10 @@ public ConvertProcessorDescriptor TargetField(Expression - /// The field to assign the converted value to.
By default, the `field` is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public ConvertProcessorDescriptor TargetField(Expression> targetField) { @@ -492,7 +573,9 @@ public ConvertProcessorDescriptor TargetField(Expression - /// The type to convert the existing value to. + /// + /// The type to convert the existing value to. + /// /// public ConvertProcessorDescriptor Type(Elastic.Clients.Elasticsearch.Serverless.Ingest.ConvertType type) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/CsvProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/CsvProcessor.g.cs index 5f4db76a4f1..697cf8aa26e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/CsvProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/CsvProcessor.g.cs @@ -30,74 +30,102 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class CsvProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// Value used to fill empty fields.
Empty fields are skipped if this is not provided.
An empty field is one with no value (2 consecutive separators) or empty quotes (`""`). + /// + /// Value used to fill empty fields. + /// Empty fields are skipped if this is not provided. + /// An empty field is one with no value (2 consecutive separators) or empty quotes (""). + /// /// [JsonInclude, JsonPropertyName("empty_value")] public object? EmptyValue { get; set; } /// - /// The field to extract data from. + /// + /// The field to extract data from. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Quote used in CSV, has to be single character string. + /// + /// Quote used in CSV, has to be single character string. + /// /// [JsonInclude, JsonPropertyName("quote")] public string? Quote { get; set; } /// - /// Separator used in CSV, has to be single character string. + /// + /// Separator used in CSV, has to be single character string. + /// /// [JsonInclude, JsonPropertyName("separator")] public string? Separator { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The array of fields to assign extracted values to. + /// + /// The array of fields to assign extracted values to. + /// /// [JsonInclude, JsonPropertyName("target_fields")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] public Elastic.Clients.Elasticsearch.Serverless.Fields TargetFields { get; set; } /// - /// Trim whitespaces in unquoted fields. + /// + /// Trim whitespaces in unquoted fields. + /// /// [JsonInclude, JsonPropertyName("trim")] public bool? Trim { get; set; } @@ -130,7 +158,10 @@ public CsvProcessorDescriptor() : base() private bool? TrimValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public CsvProcessorDescriptor Description(string? description) { @@ -139,7 +170,11 @@ public CsvProcessorDescriptor Description(string? description) } /// - /// Value used to fill empty fields.
Empty fields are skipped if this is not provided.
An empty field is one with no value (2 consecutive separators) or empty quotes (`""`). + /// + /// Value used to fill empty fields. + /// Empty fields are skipped if this is not provided. + /// An empty field is one with no value (2 consecutive separators) or empty quotes (""). + /// /// public CsvProcessorDescriptor EmptyValue(object? emptyValue) { @@ -148,7 +183,9 @@ public CsvProcessorDescriptor EmptyValue(object? emptyValue) } /// - /// The field to extract data from. + /// + /// The field to extract data from. + /// /// public CsvProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -157,7 +194,9 @@ public CsvProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Ser } /// - /// The field to extract data from. + /// + /// The field to extract data from. + /// /// public CsvProcessorDescriptor Field(Expression> field) { @@ -166,7 +205,9 @@ public CsvProcessorDescriptor Field(Expression - /// The field to extract data from. + /// + /// The field to extract data from. + /// /// public CsvProcessorDescriptor Field(Expression> field) { @@ -175,7 +216,9 @@ public CsvProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public CsvProcessorDescriptor If(string? value) { @@ -184,7 +227,9 @@ public CsvProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public CsvProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -193,7 +238,9 @@ public CsvProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tru } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public CsvProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -202,7 +249,9 @@ public CsvProcessorDescriptor IgnoreMissing(bool? ignoreMissing = tru } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public CsvProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -241,7 +290,9 @@ public CsvProcessorDescriptor OnFailure(params Action - /// Quote used in CSV, has to be single character string. + /// + /// Quote used in CSV, has to be single character string. + /// /// public CsvProcessorDescriptor Quote(string? quote) { @@ -250,7 +301,9 @@ public CsvProcessorDescriptor Quote(string? quote) } /// - /// Separator used in CSV, has to be single character string. + /// + /// Separator used in CSV, has to be single character string. + /// /// public CsvProcessorDescriptor Separator(string? separator) { @@ -259,7 +312,10 @@ public CsvProcessorDescriptor Separator(string? separator) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public CsvProcessorDescriptor Tag(string? tag) { @@ -268,7 +324,9 @@ public CsvProcessorDescriptor Tag(string? tag) } /// - /// The array of fields to assign extracted values to. + /// + /// The array of fields to assign extracted values to. + /// /// public CsvProcessorDescriptor TargetFields(Elastic.Clients.Elasticsearch.Serverless.Fields targetFields) { @@ -277,7 +335,9 @@ public CsvProcessorDescriptor TargetFields(Elastic.Clients.Elasticsea } /// - /// Trim whitespaces in unquoted fields. + /// + /// Trim whitespaces in unquoted fields. + /// /// public CsvProcessorDescriptor Trim(bool? trim = true) { @@ -406,7 +466,10 @@ public CsvProcessorDescriptor() : base() private bool? TrimValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public CsvProcessorDescriptor Description(string? description) { @@ -415,7 +478,11 @@ public CsvProcessorDescriptor Description(string? description) } /// - /// Value used to fill empty fields.
Empty fields are skipped if this is not provided.
An empty field is one with no value (2 consecutive separators) or empty quotes (`""`). + /// + /// Value used to fill empty fields. + /// Empty fields are skipped if this is not provided. + /// An empty field is one with no value (2 consecutive separators) or empty quotes (""). + /// /// public CsvProcessorDescriptor EmptyValue(object? emptyValue) { @@ -424,7 +491,9 @@ public CsvProcessorDescriptor EmptyValue(object? emptyValue) } /// - /// The field to extract data from. + /// + /// The field to extract data from. + /// /// public CsvProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -433,7 +502,9 @@ public CsvProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Fie } /// - /// The field to extract data from. + /// + /// The field to extract data from. + /// /// public CsvProcessorDescriptor Field(Expression> field) { @@ -442,7 +513,9 @@ public CsvProcessorDescriptor Field(Expression - /// The field to extract data from. + /// + /// The field to extract data from. + /// /// public CsvProcessorDescriptor Field(Expression> field) { @@ -451,7 +524,9 @@ public CsvProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public CsvProcessorDescriptor If(string? value) { @@ -460,7 +535,9 @@ public CsvProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public CsvProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -469,7 +546,9 @@ public CsvProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public CsvProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -478,7 +557,9 @@ public CsvProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public CsvProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -517,7 +598,9 @@ public CsvProcessorDescriptor OnFailure(params Action - /// Quote used in CSV, has to be single character string. + /// + /// Quote used in CSV, has to be single character string. + /// /// public CsvProcessorDescriptor Quote(string? quote) { @@ -526,7 +609,9 @@ public CsvProcessorDescriptor Quote(string? quote) } /// - /// Separator used in CSV, has to be single character string. + /// + /// Separator used in CSV, has to be single character string. + /// /// public CsvProcessorDescriptor Separator(string? separator) { @@ -535,7 +620,10 @@ public CsvProcessorDescriptor Separator(string? separator) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public CsvProcessorDescriptor Tag(string? tag) { @@ -544,7 +632,9 @@ public CsvProcessorDescriptor Tag(string? tag) } /// - /// The array of fields to assign extracted values to. + /// + /// The array of fields to assign extracted values to. + /// /// public CsvProcessorDescriptor TargetFields(Elastic.Clients.Elasticsearch.Serverless.Fields targetFields) { @@ -553,7 +643,9 @@ public CsvProcessorDescriptor TargetFields(Elastic.Clients.Elasticsearch.Serverl } /// - /// Trim whitespaces in unquoted fields. + /// + /// Trim whitespaces in unquoted fields. + /// /// public CsvProcessorDescriptor Trim(bool? trim = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/DateIndexNameProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/DateIndexNameProcessor.g.cs index e2c04753d09..283d93d762b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/DateIndexNameProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/DateIndexNameProcessor.g.cs @@ -30,73 +30,105 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class DateIndexNameProcessor { /// - /// An array of the expected date formats for parsing dates / timestamps in the document being preprocessed.
Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + /// + /// An array of the expected date formats for parsing dates / timestamps in the document being preprocessed. + /// Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + /// /// [JsonInclude, JsonPropertyName("date_formats")] public ICollection DateFormats { get; set; } /// - /// How to round the date when formatting the date into the index name. Valid values are:
`y` (year), `M` (month), `w` (week), `d` (day), `h` (hour), `m` (minute) and `s` (second).
Supports template snippets. + /// + /// How to round the date when formatting the date into the index name. Valid values are: + /// y (year), M (month), w (week), d (day), h (hour), m (minute) and s (second). + /// Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("date_rounding")] public string DateRounding { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to get the date or timestamp from. + /// + /// The field to get the date or timestamp from. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// The format to be used when printing the parsed date into the index name.
A valid java time pattern is expected here.
Supports template snippets. + /// + /// The format to be used when printing the parsed date into the index name. + /// A valid java time pattern is expected here. + /// Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("index_name_format")] public string? IndexNameFormat { get; set; } /// - /// A prefix of the index name to be prepended before the printed date.
Supports template snippets. + /// + /// A prefix of the index name to be prepended before the printed date. + /// Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("index_name_prefix")] public string? IndexNamePrefix { get; set; } /// - /// The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days. + /// + /// The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days. + /// /// [JsonInclude, JsonPropertyName("locale")] public string? Locale { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names. + /// + /// The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names. + /// /// [JsonInclude, JsonPropertyName("timezone")] public string? Timezone { get; set; } @@ -129,7 +161,10 @@ public DateIndexNameProcessorDescriptor() : base() private string? TimezoneValue { get; set; } /// - /// An array of the expected date formats for parsing dates / timestamps in the document being preprocessed.
Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + /// + /// An array of the expected date formats for parsing dates / timestamps in the document being preprocessed. + /// Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + /// /// public DateIndexNameProcessorDescriptor DateFormats(ICollection dateFormats) { @@ -138,7 +173,11 @@ public DateIndexNameProcessorDescriptor DateFormats(ICollection - /// How to round the date when formatting the date into the index name. Valid values are:
`y` (year), `M` (month), `w` (week), `d` (day), `h` (hour), `m` (minute) and `s` (second).
Supports template snippets. + /// + /// How to round the date when formatting the date into the index name. Valid values are: + /// y (year), M (month), w (week), d (day), h (hour), m (minute) and s (second). + /// Supports template snippets. + /// /// public DateIndexNameProcessorDescriptor DateRounding(string dateRounding) { @@ -147,7 +186,10 @@ public DateIndexNameProcessorDescriptor DateRounding(string dateRound } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public DateIndexNameProcessorDescriptor Description(string? description) { @@ -156,7 +198,9 @@ public DateIndexNameProcessorDescriptor Description(string? descripti } /// - /// The field to get the date or timestamp from. + /// + /// The field to get the date or timestamp from. + /// /// public DateIndexNameProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -165,7 +209,9 @@ public DateIndexNameProcessorDescriptor Field(Elastic.Clients.Elastic } /// - /// The field to get the date or timestamp from. + /// + /// The field to get the date or timestamp from. + /// /// public DateIndexNameProcessorDescriptor Field(Expression> field) { @@ -174,7 +220,9 @@ public DateIndexNameProcessorDescriptor Field(Expression - /// The field to get the date or timestamp from. + /// + /// The field to get the date or timestamp from. + /// /// public DateIndexNameProcessorDescriptor Field(Expression> field) { @@ -183,7 +231,9 @@ public DateIndexNameProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public DateIndexNameProcessorDescriptor If(string? value) { @@ -192,7 +242,9 @@ public DateIndexNameProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public DateIndexNameProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -201,7 +253,11 @@ public DateIndexNameProcessorDescriptor IgnoreFailure(bool? ignoreFai } /// - /// The format to be used when printing the parsed date into the index name.
A valid java time pattern is expected here.
Supports template snippets. + /// + /// The format to be used when printing the parsed date into the index name. + /// A valid java time pattern is expected here. + /// Supports template snippets. + /// /// public DateIndexNameProcessorDescriptor IndexNameFormat(string? indexNameFormat) { @@ -210,7 +266,10 @@ public DateIndexNameProcessorDescriptor IndexNameFormat(string? index } /// - /// A prefix of the index name to be prepended before the printed date.
Supports template snippets. + /// + /// A prefix of the index name to be prepended before the printed date. + /// Supports template snippets. + /// /// public DateIndexNameProcessorDescriptor IndexNamePrefix(string? indexNamePrefix) { @@ -219,7 +278,9 @@ public DateIndexNameProcessorDescriptor IndexNamePrefix(string? index } /// - /// The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days. + /// + /// The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days. + /// /// public DateIndexNameProcessorDescriptor Locale(string? locale) { @@ -228,7 +289,9 @@ public DateIndexNameProcessorDescriptor Locale(string? locale) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public DateIndexNameProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -267,7 +330,10 @@ public DateIndexNameProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public DateIndexNameProcessorDescriptor Tag(string? tag) { @@ -276,7 +342,9 @@ public DateIndexNameProcessorDescriptor Tag(string? tag) } /// - /// The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names. + /// + /// The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names. + /// /// public DateIndexNameProcessorDescriptor Timezone(string? timezone) { @@ -401,7 +469,10 @@ public DateIndexNameProcessorDescriptor() : base() private string? TimezoneValue { get; set; } /// - /// An array of the expected date formats for parsing dates / timestamps in the document being preprocessed.
Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + /// + /// An array of the expected date formats for parsing dates / timestamps in the document being preprocessed. + /// Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + /// /// public DateIndexNameProcessorDescriptor DateFormats(ICollection dateFormats) { @@ -410,7 +481,11 @@ public DateIndexNameProcessorDescriptor DateFormats(ICollection dateForm } /// - /// How to round the date when formatting the date into the index name. Valid values are:
`y` (year), `M` (month), `w` (week), `d` (day), `h` (hour), `m` (minute) and `s` (second).
Supports template snippets. + /// + /// How to round the date when formatting the date into the index name. Valid values are: + /// y (year), M (month), w (week), d (day), h (hour), m (minute) and s (second). + /// Supports template snippets. + /// /// public DateIndexNameProcessorDescriptor DateRounding(string dateRounding) { @@ -419,7 +494,10 @@ public DateIndexNameProcessorDescriptor DateRounding(string dateRounding) } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public DateIndexNameProcessorDescriptor Description(string? description) { @@ -428,7 +506,9 @@ public DateIndexNameProcessorDescriptor Description(string? description) } /// - /// The field to get the date or timestamp from. + /// + /// The field to get the date or timestamp from. + /// /// public DateIndexNameProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -437,7 +517,9 @@ public DateIndexNameProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serv } /// - /// The field to get the date or timestamp from. + /// + /// The field to get the date or timestamp from. + /// /// public DateIndexNameProcessorDescriptor Field(Expression> field) { @@ -446,7 +528,9 @@ public DateIndexNameProcessorDescriptor Field(Expression - /// The field to get the date or timestamp from. + /// + /// The field to get the date or timestamp from. + /// /// public DateIndexNameProcessorDescriptor Field(Expression> field) { @@ -455,7 +539,9 @@ public DateIndexNameProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public DateIndexNameProcessorDescriptor If(string? value) { @@ -464,7 +550,9 @@ public DateIndexNameProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public DateIndexNameProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -473,7 +561,11 @@ public DateIndexNameProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true } /// - /// The format to be used when printing the parsed date into the index name.
A valid java time pattern is expected here.
Supports template snippets. + /// + /// The format to be used when printing the parsed date into the index name. + /// A valid java time pattern is expected here. + /// Supports template snippets. + /// /// public DateIndexNameProcessorDescriptor IndexNameFormat(string? indexNameFormat) { @@ -482,7 +574,10 @@ public DateIndexNameProcessorDescriptor IndexNameFormat(string? indexNameFormat) } /// - /// A prefix of the index name to be prepended before the printed date.
Supports template snippets. + /// + /// A prefix of the index name to be prepended before the printed date. + /// Supports template snippets. + /// /// public DateIndexNameProcessorDescriptor IndexNamePrefix(string? indexNamePrefix) { @@ -491,7 +586,9 @@ public DateIndexNameProcessorDescriptor IndexNamePrefix(string? indexNamePrefix) } /// - /// The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days. + /// + /// The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days. + /// /// public DateIndexNameProcessorDescriptor Locale(string? locale) { @@ -500,7 +597,9 @@ public DateIndexNameProcessorDescriptor Locale(string? locale) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public DateIndexNameProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -539,7 +638,10 @@ public DateIndexNameProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public DateIndexNameProcessorDescriptor Tag(string? tag) { @@ -548,7 +650,9 @@ public DateIndexNameProcessorDescriptor Tag(string? tag) } /// - /// The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names. + /// + /// The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names. + /// /// public DateIndexNameProcessorDescriptor Timezone(string? timezone) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/DateProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/DateProcessor.g.cs index 26fbd7373ed..667ad4196c0 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/DateProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/DateProcessor.g.cs @@ -30,61 +30,86 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class DateProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to get the date from. + /// + /// The field to get the date from. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// An array of the expected date formats.
Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + /// + /// An array of the expected date formats. + /// Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + /// /// [JsonInclude, JsonPropertyName("formats")] public ICollection Formats { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// The locale to use when parsing the date, relevant when parsing month names or week days.
Supports template snippets. + /// + /// The locale to use when parsing the date, relevant when parsing month names or week days. + /// Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("locale")] public string? Locale { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field that will hold the parsed date. + /// + /// The field that will hold the parsed date. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? TargetField { get; set; } /// - /// The timezone to use when parsing the date.
Supports template snippets. + /// + /// The timezone to use when parsing the date. + /// Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("timezone")] public string? Timezone { get; set; } @@ -115,7 +140,10 @@ public DateProcessorDescriptor() : base() private string? TimezoneValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public DateProcessorDescriptor Description(string? description) { @@ -124,7 +152,9 @@ public DateProcessorDescriptor Description(string? description) } /// - /// The field to get the date from. + /// + /// The field to get the date from. + /// /// public DateProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -133,7 +163,9 @@ public DateProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Se } /// - /// The field to get the date from. + /// + /// The field to get the date from. + /// /// public DateProcessorDescriptor Field(Expression> field) { @@ -142,7 +174,9 @@ public DateProcessorDescriptor Field(Expression - /// The field to get the date from. + /// + /// The field to get the date from. + /// /// public DateProcessorDescriptor Field(Expression> field) { @@ -151,7 +185,10 @@ public DateProcessorDescriptor Field(Expression - /// An array of the expected date formats.
Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + /// + /// An array of the expected date formats. + /// Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + /// /// public DateProcessorDescriptor Formats(ICollection formats) { @@ -160,7 +197,9 @@ public DateProcessorDescriptor Formats(ICollection formats) } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public DateProcessorDescriptor If(string? value) { @@ -169,7 +208,9 @@ public DateProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public DateProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -178,7 +219,10 @@ public DateProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tr } /// - /// The locale to use when parsing the date, relevant when parsing month names or week days.
Supports template snippets. + /// + /// The locale to use when parsing the date, relevant when parsing month names or week days. + /// Supports template snippets. + /// /// public DateProcessorDescriptor Locale(string? locale) { @@ -187,7 +231,9 @@ public DateProcessorDescriptor Locale(string? locale) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public DateProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -226,7 +272,10 @@ public DateProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public DateProcessorDescriptor Tag(string? tag) { @@ -235,7 +284,9 @@ public DateProcessorDescriptor Tag(string? tag) } /// - /// The field that will hold the parsed date. + /// + /// The field that will hold the parsed date. + /// /// public DateProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -244,7 +295,9 @@ public DateProcessorDescriptor TargetField(Elastic.Clients.Elasticsea } /// - /// The field that will hold the parsed date. + /// + /// The field that will hold the parsed date. + /// /// public DateProcessorDescriptor TargetField(Expression> targetField) { @@ -253,7 +306,9 @@ public DateProcessorDescriptor TargetField(Expression - /// The field that will hold the parsed date. + /// + /// The field that will hold the parsed date. + /// /// public DateProcessorDescriptor TargetField(Expression> targetField) { @@ -262,7 +317,10 @@ public DateProcessorDescriptor TargetField(Expression - /// The timezone to use when parsing the date.
Supports template snippets. + /// + /// The timezone to use when parsing the date. + /// Supports template snippets. + /// /// public DateProcessorDescriptor Timezone(string? timezone) { @@ -377,7 +435,10 @@ public DateProcessorDescriptor() : base() private string? TimezoneValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public DateProcessorDescriptor Description(string? description) { @@ -386,7 +447,9 @@ public DateProcessorDescriptor Description(string? description) } /// - /// The field to get the date from. + /// + /// The field to get the date from. + /// /// public DateProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -395,7 +458,9 @@ public DateProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Fi } /// - /// The field to get the date from. + /// + /// The field to get the date from. + /// /// public DateProcessorDescriptor Field(Expression> field) { @@ -404,7 +469,9 @@ public DateProcessorDescriptor Field(Expression - /// The field to get the date from. + /// + /// The field to get the date from. + /// /// public DateProcessorDescriptor Field(Expression> field) { @@ -413,7 +480,10 @@ public DateProcessorDescriptor Field(Expression - /// An array of the expected date formats.
Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + /// + /// An array of the expected date formats. + /// Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + /// /// public DateProcessorDescriptor Formats(ICollection formats) { @@ -422,7 +492,9 @@ public DateProcessorDescriptor Formats(ICollection formats) } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public DateProcessorDescriptor If(string? value) { @@ -431,7 +503,9 @@ public DateProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public DateProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -440,7 +514,10 @@ public DateProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// The locale to use when parsing the date, relevant when parsing month names or week days.
Supports template snippets. + /// + /// The locale to use when parsing the date, relevant when parsing month names or week days. + /// Supports template snippets. + /// /// public DateProcessorDescriptor Locale(string? locale) { @@ -449,7 +526,9 @@ public DateProcessorDescriptor Locale(string? locale) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public DateProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -488,7 +567,10 @@ public DateProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public DateProcessorDescriptor Tag(string? tag) { @@ -497,7 +579,9 @@ public DateProcessorDescriptor Tag(string? tag) } /// - /// The field that will hold the parsed date. + /// + /// The field that will hold the parsed date. + /// /// public DateProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -506,7 +590,9 @@ public DateProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverl } /// - /// The field that will hold the parsed date. + /// + /// The field that will hold the parsed date. + /// /// public DateProcessorDescriptor TargetField(Expression> targetField) { @@ -515,7 +601,9 @@ public DateProcessorDescriptor TargetField(Expression - /// The field that will hold the parsed date. + /// + /// The field that will hold the parsed date. + /// /// public DateProcessorDescriptor TargetField(Expression> targetField) { @@ -524,7 +612,10 @@ public DateProcessorDescriptor TargetField(Expression - /// The timezone to use when parsing the date.
Supports template snippets. + /// + /// The timezone to use when parsing the date. + /// Supports template snippets. + /// /// public DateProcessorDescriptor Timezone(string? timezone) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/DissectProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/DissectProcessor.g.cs index de18b36c388..0d87b0ad6f6 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/DissectProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/DissectProcessor.g.cs @@ -30,55 +30,75 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class DissectProcessor { /// - /// The character(s) that separate the appended fields. + /// + /// The character(s) that separate the appended fields. + /// /// [JsonInclude, JsonPropertyName("append_separator")] public string? AppendSeparator { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to dissect. + /// + /// The field to dissect. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// The pattern to apply to the field. + /// + /// The pattern to apply to the field. + /// /// [JsonInclude, JsonPropertyName("pattern")] public string Pattern { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } @@ -108,7 +128,9 @@ public DissectProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// The character(s) that separate the appended fields. + /// + /// The character(s) that separate the appended fields. + /// /// public DissectProcessorDescriptor AppendSeparator(string? appendSeparator) { @@ -117,7 +139,10 @@ public DissectProcessorDescriptor AppendSeparator(string? appendSepar } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public DissectProcessorDescriptor Description(string? description) { @@ -126,7 +151,9 @@ public DissectProcessorDescriptor Description(string? description) } /// - /// The field to dissect. + /// + /// The field to dissect. + /// /// public DissectProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -135,7 +162,9 @@ public DissectProcessorDescriptor Field(Elastic.Clients.Elasticsearch } /// - /// The field to dissect. + /// + /// The field to dissect. + /// /// public DissectProcessorDescriptor Field(Expression> field) { @@ -144,7 +173,9 @@ public DissectProcessorDescriptor Field(Expression - /// The field to dissect. + /// + /// The field to dissect. + /// /// public DissectProcessorDescriptor Field(Expression> field) { @@ -153,7 +184,9 @@ public DissectProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public DissectProcessorDescriptor If(string? value) { @@ -162,7 +195,9 @@ public DissectProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public DissectProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -171,7 +206,9 @@ public DissectProcessorDescriptor IgnoreFailure(bool? ignoreFailure = } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public DissectProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -180,7 +217,9 @@ public DissectProcessorDescriptor IgnoreMissing(bool? ignoreMissing = } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public DissectProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -219,7 +258,9 @@ public DissectProcessorDescriptor OnFailure(params Action - /// The pattern to apply to the field. + /// + /// The pattern to apply to the field. + /// /// public DissectProcessorDescriptor Pattern(string pattern) { @@ -228,7 +269,10 @@ public DissectProcessorDescriptor Pattern(string pattern) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public DissectProcessorDescriptor Tag(string? tag) { @@ -336,7 +380,9 @@ public DissectProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// The character(s) that separate the appended fields. + /// + /// The character(s) that separate the appended fields. + /// /// public DissectProcessorDescriptor AppendSeparator(string? appendSeparator) { @@ -345,7 +391,10 @@ public DissectProcessorDescriptor AppendSeparator(string? appendSeparator) } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public DissectProcessorDescriptor Description(string? description) { @@ -354,7 +403,9 @@ public DissectProcessorDescriptor Description(string? description) } /// - /// The field to dissect. + /// + /// The field to dissect. + /// /// public DissectProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -363,7 +414,9 @@ public DissectProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless } /// - /// The field to dissect. + /// + /// The field to dissect. + /// /// public DissectProcessorDescriptor Field(Expression> field) { @@ -372,7 +425,9 @@ public DissectProcessorDescriptor Field(Expression - /// The field to dissect. + /// + /// The field to dissect. + /// /// public DissectProcessorDescriptor Field(Expression> field) { @@ -381,7 +436,9 @@ public DissectProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public DissectProcessorDescriptor If(string? value) { @@ -390,7 +447,9 @@ public DissectProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public DissectProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -399,7 +458,9 @@ public DissectProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public DissectProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -408,7 +469,9 @@ public DissectProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public DissectProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -447,7 +510,9 @@ public DissectProcessorDescriptor OnFailure(params Action - /// The pattern to apply to the field. + /// + /// The pattern to apply to the field. + /// /// public DissectProcessorDescriptor Pattern(string pattern) { @@ -456,7 +521,10 @@ public DissectProcessorDescriptor Pattern(string pattern) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public DissectProcessorDescriptor Tag(string? tag) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/Document.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/Document.g.cs index 643c80f34f4..9b19111ef15 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/Document.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/Document.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class Document { /// - /// Unique identifier for the document.
This ID must be unique within the `_index`. + /// + /// Unique identifier for the document. + /// This ID must be unique within the _index. + /// /// [JsonInclude, JsonPropertyName("_id")] public Elastic.Clients.Elasticsearch.Serverless.Id? Id { get; set; } /// - /// Name of the index containing the document. + /// + /// Name of the index containing the document. + /// /// [JsonInclude, JsonPropertyName("_index")] public Elastic.Clients.Elasticsearch.Serverless.IndexName? Index { get; set; } /// - /// JSON body for the document. + /// + /// JSON body for the document. + /// /// [JsonInclude, JsonPropertyName("_source")] public object Source { get; set; } @@ -61,7 +68,10 @@ public DocumentDescriptor() : base() private object SourceValue { get; set; } /// - /// Unique identifier for the document.
This ID must be unique within the `_index`. + /// + /// Unique identifier for the document. + /// This ID must be unique within the _index. + /// /// public DocumentDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id? id) { @@ -70,7 +80,9 @@ public DocumentDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id? id) } /// - /// Name of the index containing the document. + /// + /// Name of the index containing the document. + /// /// public DocumentDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.IndexName? index) { @@ -79,7 +91,9 @@ public DocumentDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.IndexNa } /// - /// JSON body for the document. + /// + /// JSON body for the document. + /// /// public DocumentDescriptor Source(object source) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/DocumentSimulation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/DocumentSimulation.g.cs index 1360d6e2838..13bfc8367f9 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/DocumentSimulation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/DocumentSimulation.g.cs @@ -104,34 +104,46 @@ public override void Write(Utf8JsonWriter writer, DocumentSimulation value, Json } /// -/// The simulated document, with optional metadata. +/// +/// The simulated document, with optional metadata. +/// /// [JsonConverter(typeof(DocumentSimulationConverter))] public sealed partial class DocumentSimulation { /// - /// Unique identifier for the document. This ID must be unique within the `_index`. + /// + /// Unique identifier for the document. This ID must be unique within the _index. + /// /// public string Id { get; init; } /// - /// Name of the index containing the document. + /// + /// Name of the index containing the document. + /// /// public string Index { get; init; } public Elastic.Clients.Elasticsearch.Serverless.Ingest.IngestInfo Ingest { get; init; } /// - /// Additional metadata + /// + /// Additional metadata + /// /// public IReadOnlyDictionary Metadata { get; init; } /// - /// Value used to send the document to a specific primary shard. + /// + /// Value used to send the document to a specific primary shard. + /// /// public string? Routing { get; init; } /// - /// JSON body for the document. + /// + /// JSON body for the document. + /// /// public IReadOnlyDictionary Source { get; init; } public long? Version { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/DotExpanderProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/DotExpanderProcessor.g.cs index ff40871399b..f311c327dd7 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/DotExpanderProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/DotExpanderProcessor.g.cs @@ -30,43 +30,61 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class DotExpanderProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to expand into an object field.
If set to `*`, all top-level fields will be expanded. + /// + /// The field to expand into an object field. + /// If set to *, all top-level fields will be expanded. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// The field that contains the field to expand.
Only required if the field to expand is part another object field, because the `field` option can only understand leaf fields. + /// + /// The field that contains the field to expand. + /// Only required if the field to expand is part another object field, because the field option can only understand leaf fields. + /// /// [JsonInclude, JsonPropertyName("path")] public string? Path { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } @@ -94,7 +112,10 @@ public DotExpanderProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public DotExpanderProcessorDescriptor Description(string? description) { @@ -103,7 +124,10 @@ public DotExpanderProcessorDescriptor Description(string? description } /// - /// The field to expand into an object field.
If set to `*`, all top-level fields will be expanded. + /// + /// The field to expand into an object field. + /// If set to *, all top-level fields will be expanded. + /// /// public DotExpanderProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -112,7 +136,10 @@ public DotExpanderProcessorDescriptor Field(Elastic.Clients.Elasticse } /// - /// The field to expand into an object field.
If set to `*`, all top-level fields will be expanded. + /// + /// The field to expand into an object field. + /// If set to *, all top-level fields will be expanded. + /// /// public DotExpanderProcessorDescriptor Field(Expression> field) { @@ -121,7 +148,10 @@ public DotExpanderProcessorDescriptor Field(Expression - /// The field to expand into an object field.
If set to `*`, all top-level fields will be expanded. + /// + /// The field to expand into an object field. + /// If set to *, all top-level fields will be expanded. + /// /// public DotExpanderProcessorDescriptor Field(Expression> field) { @@ -130,7 +160,9 @@ public DotExpanderProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public DotExpanderProcessorDescriptor If(string? value) { @@ -139,7 +171,9 @@ public DotExpanderProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public DotExpanderProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -148,7 +182,9 @@ public DotExpanderProcessorDescriptor IgnoreFailure(bool? ignoreFailu } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public DotExpanderProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -187,7 +223,10 @@ public DotExpanderProcessorDescriptor OnFailure(params Action - /// The field that contains the field to expand.
Only required if the field to expand is part another object field, because the `field` option can only understand leaf fields. + /// + /// The field that contains the field to expand. + /// Only required if the field to expand is part another object field, because the field option can only understand leaf fields. + /// /// public DotExpanderProcessorDescriptor Path(string? path) { @@ -196,7 +235,10 @@ public DotExpanderProcessorDescriptor Path(string? path) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public DotExpanderProcessorDescriptor Tag(string? tag) { @@ -294,7 +336,10 @@ public DotExpanderProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public DotExpanderProcessorDescriptor Description(string? description) { @@ -303,7 +348,10 @@ public DotExpanderProcessorDescriptor Description(string? description) } /// - /// The field to expand into an object field.
If set to `*`, all top-level fields will be expanded. + /// + /// The field to expand into an object field. + /// If set to *, all top-level fields will be expanded. + /// /// public DotExpanderProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -312,7 +360,10 @@ public DotExpanderProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Server } /// - /// The field to expand into an object field.
If set to `*`, all top-level fields will be expanded. + /// + /// The field to expand into an object field. + /// If set to *, all top-level fields will be expanded. + /// /// public DotExpanderProcessorDescriptor Field(Expression> field) { @@ -321,7 +372,10 @@ public DotExpanderProcessorDescriptor Field(Expression - /// The field to expand into an object field.
If set to `*`, all top-level fields will be expanded. + /// + /// The field to expand into an object field. + /// If set to *, all top-level fields will be expanded. + /// /// public DotExpanderProcessorDescriptor Field(Expression> field) { @@ -330,7 +384,9 @@ public DotExpanderProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public DotExpanderProcessorDescriptor If(string? value) { @@ -339,7 +395,9 @@ public DotExpanderProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public DotExpanderProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -348,7 +406,9 @@ public DotExpanderProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public DotExpanderProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -387,7 +447,10 @@ public DotExpanderProcessorDescriptor OnFailure(params Action - /// The field that contains the field to expand.
Only required if the field to expand is part another object field, because the `field` option can only understand leaf fields. + /// + /// The field that contains the field to expand. + /// Only required if the field to expand is part another object field, because the field option can only understand leaf fields. + /// /// public DotExpanderProcessorDescriptor Path(string? path) { @@ -396,7 +459,10 @@ public DotExpanderProcessorDescriptor Path(string? path) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public DotExpanderProcessorDescriptor Tag(string? tag) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/DropProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/DropProcessor.g.cs index 25277b1d45f..1b6659d3e63 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/DropProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/DropProcessor.g.cs @@ -30,31 +30,43 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class DropProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } @@ -80,7 +92,10 @@ public DropProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public DropProcessorDescriptor Description(string? description) { @@ -89,7 +104,9 @@ public DropProcessorDescriptor Description(string? description) } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public DropProcessorDescriptor If(string? value) { @@ -98,7 +115,9 @@ public DropProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public DropProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -107,7 +126,9 @@ public DropProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tr } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public DropProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -146,7 +167,10 @@ public DropProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public DropProcessorDescriptor Tag(string? tag) { @@ -234,7 +258,10 @@ public DropProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public DropProcessorDescriptor Description(string? description) { @@ -243,7 +270,9 @@ public DropProcessorDescriptor Description(string? description) } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public DropProcessorDescriptor If(string? value) { @@ -252,7 +281,9 @@ public DropProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public DropProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -261,7 +292,9 @@ public DropProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public DropProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -300,7 +333,10 @@ public DropProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public DropProcessorDescriptor Tag(string? tag) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/EnrichProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/EnrichProcessor.g.cs index 6cb63951c05..fa0d6e8c1df 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/EnrichProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/EnrichProcessor.g.cs @@ -30,73 +30,105 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class EnrichProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field in the input document that matches the policies match_field used to retrieve the enrichment data.
Supports template snippets. + /// + /// The field in the input document that matches the policies match_field used to retrieve the enrichment data. + /// Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// The maximum number of matched documents to include under the configured target field.
The `target_field` will be turned into a json array if `max_matches` is higher than 1, otherwise `target_field` will become a json object.
In order to avoid documents getting too large, the maximum allowed value is 128. + /// + /// The maximum number of matched documents to include under the configured target field. + /// The target_field will be turned into a json array if max_matches is higher than 1, otherwise target_field will become a json object. + /// In order to avoid documents getting too large, the maximum allowed value is 128. + /// /// [JsonInclude, JsonPropertyName("max_matches")] public int? MaxMatches { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// If processor will update fields with pre-existing non-null-valued field.
When set to `false`, such fields will not be touched. + /// + /// If processor will update fields with pre-existing non-null-valued field. + /// When set to false, such fields will not be touched. + /// /// [JsonInclude, JsonPropertyName("override")] public bool? Override { get; set; } /// - /// The name of the enrich policy to use. + /// + /// The name of the enrich policy to use. + /// /// [JsonInclude, JsonPropertyName("policy_name")] public string PolicyName { get; set; } /// - /// A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index.
This option is only used for `geo_match` enrich policy types. + /// + /// A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index. + /// This option is only used for geo_match enrich policy types. + /// /// [JsonInclude, JsonPropertyName("shape_relation")] public Elastic.Clients.Elasticsearch.Serverless.GeoShapeRelation? ShapeRelation { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// Field added to incoming documents to contain enrich data. This field contains both the `match_field` and `enrich_fields` specified in the enrich policy.
Supports template snippets. + /// + /// Field added to incoming documents to contain enrich data. This field contains both the match_field and enrich_fields specified in the enrich policy. + /// Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Serverless.Field TargetField { get; set; } @@ -129,7 +161,10 @@ public EnrichProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public EnrichProcessorDescriptor Description(string? description) { @@ -138,7 +173,10 @@ public EnrichProcessorDescriptor Description(string? description) } /// - /// The field in the input document that matches the policies match_field used to retrieve the enrichment data.
Supports template snippets. + /// + /// The field in the input document that matches the policies match_field used to retrieve the enrichment data. + /// Supports template snippets. + /// /// public EnrichProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -147,7 +185,10 @@ public EnrichProcessorDescriptor Field(Elastic.Clients.Elasticsearch. } /// - /// The field in the input document that matches the policies match_field used to retrieve the enrichment data.
Supports template snippets. + /// + /// The field in the input document that matches the policies match_field used to retrieve the enrichment data. + /// Supports template snippets. + /// /// public EnrichProcessorDescriptor Field(Expression> field) { @@ -156,7 +197,10 @@ public EnrichProcessorDescriptor Field(Expression - /// The field in the input document that matches the policies match_field used to retrieve the enrichment data.
Supports template snippets. + /// + /// The field in the input document that matches the policies match_field used to retrieve the enrichment data. + /// Supports template snippets. + /// /// public EnrichProcessorDescriptor Field(Expression> field) { @@ -165,7 +209,9 @@ public EnrichProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public EnrichProcessorDescriptor If(string? value) { @@ -174,7 +220,9 @@ public EnrichProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public EnrichProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -183,7 +231,9 @@ public EnrichProcessorDescriptor IgnoreFailure(bool? ignoreFailure = } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public EnrichProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -192,7 +242,11 @@ public EnrichProcessorDescriptor IgnoreMissing(bool? ignoreMissing = } /// - /// The maximum number of matched documents to include under the configured target field.
The `target_field` will be turned into a json array if `max_matches` is higher than 1, otherwise `target_field` will become a json object.
In order to avoid documents getting too large, the maximum allowed value is 128. + /// + /// The maximum number of matched documents to include under the configured target field. + /// The target_field will be turned into a json array if max_matches is higher than 1, otherwise target_field will become a json object. + /// In order to avoid documents getting too large, the maximum allowed value is 128. + /// /// public EnrichProcessorDescriptor MaxMatches(int? maxMatches) { @@ -201,7 +255,9 @@ public EnrichProcessorDescriptor MaxMatches(int? maxMatches) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public EnrichProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -240,7 +296,10 @@ public EnrichProcessorDescriptor OnFailure(params Action - /// If processor will update fields with pre-existing non-null-valued field.
When set to `false`, such fields will not be touched. + /// + /// If processor will update fields with pre-existing non-null-valued field. + /// When set to false, such fields will not be touched. + /// /// public EnrichProcessorDescriptor Override(bool? value = true) { @@ -249,7 +308,9 @@ public EnrichProcessorDescriptor Override(bool? value = true) } /// - /// The name of the enrich policy to use. + /// + /// The name of the enrich policy to use. + /// /// public EnrichProcessorDescriptor PolicyName(string policyName) { @@ -258,7 +319,10 @@ public EnrichProcessorDescriptor PolicyName(string policyName) } /// - /// A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index.
This option is only used for `geo_match` enrich policy types. + /// + /// A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index. + /// This option is only used for geo_match enrich policy types. + /// /// public EnrichProcessorDescriptor ShapeRelation(Elastic.Clients.Elasticsearch.Serverless.GeoShapeRelation? shapeRelation) { @@ -267,7 +331,10 @@ public EnrichProcessorDescriptor ShapeRelation(Elastic.Clients.Elasti } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public EnrichProcessorDescriptor Tag(string? tag) { @@ -276,7 +343,10 @@ public EnrichProcessorDescriptor Tag(string? tag) } /// - /// Field added to incoming documents to contain enrich data. This field contains both the `match_field` and `enrich_fields` specified in the enrich policy.
Supports template snippets. + /// + /// Field added to incoming documents to contain enrich data. This field contains both the match_field and enrich_fields specified in the enrich policy. + /// Supports template snippets. + /// /// public EnrichProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field targetField) { @@ -285,7 +355,10 @@ public EnrichProcessorDescriptor TargetField(Elastic.Clients.Elastics } /// - /// Field added to incoming documents to contain enrich data. This field contains both the `match_field` and `enrich_fields` specified in the enrich policy.
Supports template snippets. + /// + /// Field added to incoming documents to contain enrich data. This field contains both the match_field and enrich_fields specified in the enrich policy. + /// Supports template snippets. + /// /// public EnrichProcessorDescriptor TargetField(Expression> targetField) { @@ -294,7 +367,10 @@ public EnrichProcessorDescriptor TargetField(Expression - /// Field added to incoming documents to contain enrich data. This field contains both the `match_field` and `enrich_fields` specified in the enrich policy.
Supports template snippets. + /// + /// Field added to incoming documents to contain enrich data. This field contains both the match_field and enrich_fields specified in the enrich policy. + /// Supports template snippets. + /// /// public EnrichProcessorDescriptor TargetField(Expression> targetField) { @@ -419,7 +495,10 @@ public EnrichProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public EnrichProcessorDescriptor Description(string? description) { @@ -428,7 +507,10 @@ public EnrichProcessorDescriptor Description(string? description) } /// - /// The field in the input document that matches the policies match_field used to retrieve the enrichment data.
Supports template snippets. + /// + /// The field in the input document that matches the policies match_field used to retrieve the enrichment data. + /// Supports template snippets. + /// /// public EnrichProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -437,7 +519,10 @@ public EnrichProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless. } /// - /// The field in the input document that matches the policies match_field used to retrieve the enrichment data.
Supports template snippets. + /// + /// The field in the input document that matches the policies match_field used to retrieve the enrichment data. + /// Supports template snippets. + /// /// public EnrichProcessorDescriptor Field(Expression> field) { @@ -446,7 +531,10 @@ public EnrichProcessorDescriptor Field(Expression - /// The field in the input document that matches the policies match_field used to retrieve the enrichment data.
Supports template snippets. + /// + /// The field in the input document that matches the policies match_field used to retrieve the enrichment data. + /// Supports template snippets. + /// /// public EnrichProcessorDescriptor Field(Expression> field) { @@ -455,7 +543,9 @@ public EnrichProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public EnrichProcessorDescriptor If(string? value) { @@ -464,7 +554,9 @@ public EnrichProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public EnrichProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -473,7 +565,9 @@ public EnrichProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public EnrichProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -482,7 +576,11 @@ public EnrichProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// The maximum number of matched documents to include under the configured target field.
The `target_field` will be turned into a json array if `max_matches` is higher than 1, otherwise `target_field` will become a json object.
In order to avoid documents getting too large, the maximum allowed value is 128. + /// + /// The maximum number of matched documents to include under the configured target field. + /// The target_field will be turned into a json array if max_matches is higher than 1, otherwise target_field will become a json object. + /// In order to avoid documents getting too large, the maximum allowed value is 128. + /// /// public EnrichProcessorDescriptor MaxMatches(int? maxMatches) { @@ -491,7 +589,9 @@ public EnrichProcessorDescriptor MaxMatches(int? maxMatches) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public EnrichProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -530,7 +630,10 @@ public EnrichProcessorDescriptor OnFailure(params Action - /// If processor will update fields with pre-existing non-null-valued field.
When set to `false`, such fields will not be touched. + /// + /// If processor will update fields with pre-existing non-null-valued field. + /// When set to false, such fields will not be touched. + /// /// public EnrichProcessorDescriptor Override(bool? value = true) { @@ -539,7 +642,9 @@ public EnrichProcessorDescriptor Override(bool? value = true) } /// - /// The name of the enrich policy to use. + /// + /// The name of the enrich policy to use. + /// /// public EnrichProcessorDescriptor PolicyName(string policyName) { @@ -548,7 +653,10 @@ public EnrichProcessorDescriptor PolicyName(string policyName) } /// - /// A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index.
This option is only used for `geo_match` enrich policy types. + /// + /// A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index. + /// This option is only used for geo_match enrich policy types. + /// /// public EnrichProcessorDescriptor ShapeRelation(Elastic.Clients.Elasticsearch.Serverless.GeoShapeRelation? shapeRelation) { @@ -557,7 +665,10 @@ public EnrichProcessorDescriptor ShapeRelation(Elastic.Clients.Elasticsearch.Ser } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public EnrichProcessorDescriptor Tag(string? tag) { @@ -566,7 +677,10 @@ public EnrichProcessorDescriptor Tag(string? tag) } /// - /// Field added to incoming documents to contain enrich data. This field contains both the `match_field` and `enrich_fields` specified in the enrich policy.
Supports template snippets. + /// + /// Field added to incoming documents to contain enrich data. This field contains both the match_field and enrich_fields specified in the enrich policy. + /// Supports template snippets. + /// /// public EnrichProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field targetField) { @@ -575,7 +689,10 @@ public EnrichProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serve } /// - /// Field added to incoming documents to contain enrich data. This field contains both the `match_field` and `enrich_fields` specified in the enrich policy.
Supports template snippets. + /// + /// Field added to incoming documents to contain enrich data. This field contains both the match_field and enrich_fields specified in the enrich policy. + /// Supports template snippets. + /// /// public EnrichProcessorDescriptor TargetField(Expression> targetField) { @@ -584,7 +701,10 @@ public EnrichProcessorDescriptor TargetField(Expression - /// Field added to incoming documents to contain enrich data. This field contains both the `match_field` and `enrich_fields` specified in the enrich policy.
Supports template snippets. + /// + /// Field added to incoming documents to contain enrich data. This field contains both the match_field and enrich_fields specified in the enrich policy. + /// Supports template snippets. + /// /// public EnrichProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/FailProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/FailProcessor.g.cs index 02d73e67073..5d77e770c5b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/FailProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/FailProcessor.g.cs @@ -30,37 +30,52 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class FailProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// The error message thrown by the processor.
Supports template snippets. + /// + /// The error message thrown by the processor. + /// Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("message")] public string Message { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } @@ -87,7 +102,10 @@ public FailProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public FailProcessorDescriptor Description(string? description) { @@ -96,7 +114,9 @@ public FailProcessorDescriptor Description(string? description) } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public FailProcessorDescriptor If(string? value) { @@ -105,7 +125,9 @@ public FailProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public FailProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -114,7 +136,10 @@ public FailProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tr } /// - /// The error message thrown by the processor.
Supports template snippets. + /// + /// The error message thrown by the processor. + /// Supports template snippets. + /// /// public FailProcessorDescriptor Message(string message) { @@ -123,7 +148,9 @@ public FailProcessorDescriptor Message(string message) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public FailProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -162,7 +189,10 @@ public FailProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public FailProcessorDescriptor Tag(string? tag) { @@ -253,7 +283,10 @@ public FailProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public FailProcessorDescriptor Description(string? description) { @@ -262,7 +295,9 @@ public FailProcessorDescriptor Description(string? description) } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public FailProcessorDescriptor If(string? value) { @@ -271,7 +306,9 @@ public FailProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public FailProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -280,7 +317,10 @@ public FailProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// The error message thrown by the processor.
Supports template snippets. + /// + /// The error message thrown by the processor. + /// Supports template snippets. + /// /// public FailProcessorDescriptor Message(string message) { @@ -289,7 +329,9 @@ public FailProcessorDescriptor Message(string message) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public FailProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -328,7 +370,10 @@ public FailProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public FailProcessorDescriptor Tag(string? tag) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/ForeachProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/ForeachProcessor.g.cs index 0dce10f89f1..691c22c137e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/ForeachProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/ForeachProcessor.g.cs @@ -30,49 +30,67 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class ForeachProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// Field containing array or object values. + /// + /// Field containing array or object values. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true`, the processor silently exits without changing the document if the `field` is `null` or missing. + /// + /// If true, the processor silently exits without changing the document if the field is null or missing. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Ingest processor to run on each element. + /// + /// Ingest processor to run on each element. + /// /// [JsonInclude, JsonPropertyName("processor")] public Elastic.Clients.Elasticsearch.Serverless.Ingest.Processor Processor { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } @@ -103,7 +121,10 @@ public ForeachProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public ForeachProcessorDescriptor Description(string? description) { @@ -112,7 +133,9 @@ public ForeachProcessorDescriptor Description(string? description) } /// - /// Field containing array or object values. + /// + /// Field containing array or object values. + /// /// public ForeachProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -121,7 +144,9 @@ public ForeachProcessorDescriptor Field(Elastic.Clients.Elasticsearch } /// - /// Field containing array or object values. + /// + /// Field containing array or object values. + /// /// public ForeachProcessorDescriptor Field(Expression> field) { @@ -130,7 +155,9 @@ public ForeachProcessorDescriptor Field(Expression - /// Field containing array or object values. + /// + /// Field containing array or object values. + /// /// public ForeachProcessorDescriptor Field(Expression> field) { @@ -139,7 +166,9 @@ public ForeachProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public ForeachProcessorDescriptor If(string? value) { @@ -148,7 +177,9 @@ public ForeachProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public ForeachProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -157,7 +188,9 @@ public ForeachProcessorDescriptor IgnoreFailure(bool? ignoreFailure = } /// - /// If `true`, the processor silently exits without changing the document if the `field` is `null` or missing. + /// + /// If true, the processor silently exits without changing the document if the field is null or missing. + /// /// public ForeachProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -166,7 +199,9 @@ public ForeachProcessorDescriptor IgnoreMissing(bool? ignoreMissing = } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public ForeachProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -205,7 +240,9 @@ public ForeachProcessorDescriptor OnFailure(params Action - /// Ingest processor to run on each element. + /// + /// Ingest processor to run on each element. + /// /// public ForeachProcessorDescriptor Processor(Elastic.Clients.Elasticsearch.Serverless.Ingest.Processor processor) { @@ -232,7 +269,10 @@ public ForeachProcessorDescriptor Processor(Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public ForeachProcessorDescriptor Tag(string? tag) { @@ -349,7 +389,10 @@ public ForeachProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public ForeachProcessorDescriptor Description(string? description) { @@ -358,7 +401,9 @@ public ForeachProcessorDescriptor Description(string? description) } /// - /// Field containing array or object values. + /// + /// Field containing array or object values. + /// /// public ForeachProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -367,7 +412,9 @@ public ForeachProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless } /// - /// Field containing array or object values. + /// + /// Field containing array or object values. + /// /// public ForeachProcessorDescriptor Field(Expression> field) { @@ -376,7 +423,9 @@ public ForeachProcessorDescriptor Field(Expression - /// Field containing array or object values. + /// + /// Field containing array or object values. + /// /// public ForeachProcessorDescriptor Field(Expression> field) { @@ -385,7 +434,9 @@ public ForeachProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public ForeachProcessorDescriptor If(string? value) { @@ -394,7 +445,9 @@ public ForeachProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public ForeachProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -403,7 +456,9 @@ public ForeachProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true`, the processor silently exits without changing the document if the `field` is `null` or missing. + /// + /// If true, the processor silently exits without changing the document if the field is null or missing. + /// /// public ForeachProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -412,7 +467,9 @@ public ForeachProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public ForeachProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -451,7 +508,9 @@ public ForeachProcessorDescriptor OnFailure(params Action - /// Ingest processor to run on each element. + /// + /// Ingest processor to run on each element. + /// /// public ForeachProcessorDescriptor Processor(Elastic.Clients.Elasticsearch.Serverless.Ingest.Processor processor) { @@ -478,7 +537,10 @@ public ForeachProcessorDescriptor Processor(Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public ForeachProcessorDescriptor Tag(string? tag) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/GeoIpDownloadStatistics.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/GeoIpDownloadStatistics.g.cs index 7eab61c56a1..7bd81559f29 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/GeoIpDownloadStatistics.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/GeoIpDownloadStatistics.g.cs @@ -30,31 +30,41 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class GeoIpDownloadStatistics { /// - /// Current number of databases available for use. + /// + /// Current number of databases available for use. + /// /// [JsonInclude, JsonPropertyName("database_count")] public int DatabaseCount { get; init; } /// - /// Total number of failed database downloads. + /// + /// Total number of failed database downloads. + /// /// [JsonInclude, JsonPropertyName("failed_downloads")] public int FailedDownloads { get; init; } /// - /// Total number of database updates skipped. + /// + /// Total number of database updates skipped. + /// /// [JsonInclude, JsonPropertyName("skipped_updates")] public int SkippedUpdates { get; init; } /// - /// Total number of successful database downloads. + /// + /// Total number of successful database downloads. + /// /// [JsonInclude, JsonPropertyName("successful_downloads")] public int SuccessfulDownloads { get; init; } /// - /// Total milliseconds spent downloading databases. + /// + /// Total milliseconds spent downloading databases. + /// /// [JsonInclude, JsonPropertyName("total_download_time")] public long TotalDownloadTime { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/GeoIpNodeDatabaseName.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/GeoIpNodeDatabaseName.g.cs index c79c158eb40..4946807577b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/GeoIpNodeDatabaseName.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/GeoIpNodeDatabaseName.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class GeoIpNodeDatabaseName { /// - /// Name of the database. + /// + /// Name of the database. + /// /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/GeoIpNodeDatabases.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/GeoIpNodeDatabases.g.cs index 187be6ce93a..67416283f12 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/GeoIpNodeDatabases.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/GeoIpNodeDatabases.g.cs @@ -28,18 +28,24 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; /// -/// Downloaded databases for the node. The field key is the node ID. +/// +/// Downloaded databases for the node. The field key is the node ID. +/// /// public sealed partial class GeoIpNodeDatabases { /// - /// Downloaded databases for the node. + /// + /// Downloaded databases for the node. + /// /// [JsonInclude, JsonPropertyName("databases")] public IReadOnlyCollection Databases { get; init; } /// - /// Downloaded database files, including related license files. Elasticsearch stores these files in the node’s temporary directory: $ES_TMPDIR/geoip-databases/. + /// + /// Downloaded database files, including related license files. Elasticsearch stores these files in the node’s temporary directory: $ES_TMPDIR/geoip-databases/<node_id>. + /// /// [JsonInclude, JsonPropertyName("files_in_temp")] public IReadOnlyCollection FilesInTemp { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/GeoIpProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/GeoIpProcessor.g.cs index 5dc6651fc97..0a7368724f1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/GeoIpProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/GeoIpProcessor.g.cs @@ -30,67 +30,91 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class GeoIpProcessor { /// - /// The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. + /// + /// The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. + /// /// [JsonInclude, JsonPropertyName("database_file")] public string? DatabaseFile { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to get the ip address from for the geographical lookup. + /// + /// The field to get the ip address from for the geographical lookup. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// If `true`, only the first found geoip data will be returned, even if the field contains an array. + /// + /// If true, only the first found geoip data will be returned, even if the field contains an array. + /// /// [JsonInclude, JsonPropertyName("first_only")] public bool? FirstOnly { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Controls what properties are added to the `target_field` based on the geoip lookup. + /// + /// Controls what properties are added to the target_field based on the geoip lookup. + /// /// [JsonInclude, JsonPropertyName("properties")] public ICollection? Properties { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field that will hold the geographical information looked up from the MaxMind database. + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? TargetField { get; set; } @@ -122,7 +146,9 @@ public GeoIpProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } /// - /// The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. + /// + /// The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. + /// /// public GeoIpProcessorDescriptor DatabaseFile(string? databaseFile) { @@ -131,7 +157,10 @@ public GeoIpProcessorDescriptor DatabaseFile(string? databaseFile) } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public GeoIpProcessorDescriptor Description(string? description) { @@ -140,7 +169,9 @@ public GeoIpProcessorDescriptor Description(string? description) } /// - /// The field to get the ip address from for the geographical lookup. + /// + /// The field to get the ip address from for the geographical lookup. + /// /// public GeoIpProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -149,7 +180,9 @@ public GeoIpProcessorDescriptor Field(Elastic.Clients.Elasticsearch.S } /// - /// The field to get the ip address from for the geographical lookup. + /// + /// The field to get the ip address from for the geographical lookup. + /// /// public GeoIpProcessorDescriptor Field(Expression> field) { @@ -158,7 +191,9 @@ public GeoIpProcessorDescriptor Field(Expression - /// The field to get the ip address from for the geographical lookup. + /// + /// The field to get the ip address from for the geographical lookup. + /// /// public GeoIpProcessorDescriptor Field(Expression> field) { @@ -167,7 +202,9 @@ public GeoIpProcessorDescriptor Field(Expression - /// If `true`, only the first found geoip data will be returned, even if the field contains an array. + /// + /// If true, only the first found geoip data will be returned, even if the field contains an array. + /// /// public GeoIpProcessorDescriptor FirstOnly(bool? firstOnly = true) { @@ -176,7 +213,9 @@ public GeoIpProcessorDescriptor FirstOnly(bool? firstOnly = true) } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public GeoIpProcessorDescriptor If(string? value) { @@ -185,7 +224,9 @@ public GeoIpProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public GeoIpProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -194,7 +235,9 @@ public GeoIpProcessorDescriptor IgnoreFailure(bool? ignoreFailure = t } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public GeoIpProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -203,7 +246,9 @@ public GeoIpProcessorDescriptor IgnoreMissing(bool? ignoreMissing = t } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public GeoIpProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -242,7 +287,9 @@ public GeoIpProcessorDescriptor OnFailure(params Action - /// Controls what properties are added to the `target_field` based on the geoip lookup. + /// + /// Controls what properties are added to the target_field based on the geoip lookup. + /// /// public GeoIpProcessorDescriptor Properties(ICollection? properties) { @@ -251,7 +298,10 @@ public GeoIpProcessorDescriptor Properties(ICollection? prope } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public GeoIpProcessorDescriptor Tag(string? tag) { @@ -260,7 +310,9 @@ public GeoIpProcessorDescriptor Tag(string? tag) } /// - /// The field that will hold the geographical information looked up from the MaxMind database. + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// /// public GeoIpProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -269,7 +321,9 @@ public GeoIpProcessorDescriptor TargetField(Elastic.Clients.Elasticse } /// - /// The field that will hold the geographical information looked up from the MaxMind database. + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// /// public GeoIpProcessorDescriptor TargetField(Expression> targetField) { @@ -278,7 +332,9 @@ public GeoIpProcessorDescriptor TargetField(Expression - /// The field that will hold the geographical information looked up from the MaxMind database. + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// /// public GeoIpProcessorDescriptor TargetField(Expression> targetField) { @@ -404,7 +460,9 @@ public GeoIpProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } /// - /// The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. + /// + /// The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. + /// /// public GeoIpProcessorDescriptor DatabaseFile(string? databaseFile) { @@ -413,7 +471,10 @@ public GeoIpProcessorDescriptor DatabaseFile(string? databaseFile) } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public GeoIpProcessorDescriptor Description(string? description) { @@ -422,7 +483,9 @@ public GeoIpProcessorDescriptor Description(string? description) } /// - /// The field to get the ip address from for the geographical lookup. + /// + /// The field to get the ip address from for the geographical lookup. + /// /// public GeoIpProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -431,7 +494,9 @@ public GeoIpProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.F } /// - /// The field to get the ip address from for the geographical lookup. + /// + /// The field to get the ip address from for the geographical lookup. + /// /// public GeoIpProcessorDescriptor Field(Expression> field) { @@ -440,7 +505,9 @@ public GeoIpProcessorDescriptor Field(Expression - /// The field to get the ip address from for the geographical lookup. + /// + /// The field to get the ip address from for the geographical lookup. + /// /// public GeoIpProcessorDescriptor Field(Expression> field) { @@ -449,7 +516,9 @@ public GeoIpProcessorDescriptor Field(Expression - /// If `true`, only the first found geoip data will be returned, even if the field contains an array. + /// + /// If true, only the first found geoip data will be returned, even if the field contains an array. + /// /// public GeoIpProcessorDescriptor FirstOnly(bool? firstOnly = true) { @@ -458,7 +527,9 @@ public GeoIpProcessorDescriptor FirstOnly(bool? firstOnly = true) } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public GeoIpProcessorDescriptor If(string? value) { @@ -467,7 +538,9 @@ public GeoIpProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public GeoIpProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -476,7 +549,9 @@ public GeoIpProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public GeoIpProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -485,7 +560,9 @@ public GeoIpProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public GeoIpProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -524,7 +601,9 @@ public GeoIpProcessorDescriptor OnFailure(params Action - /// Controls what properties are added to the `target_field` based on the geoip lookup. + /// + /// Controls what properties are added to the target_field based on the geoip lookup. + /// /// public GeoIpProcessorDescriptor Properties(ICollection? properties) { @@ -533,7 +612,10 @@ public GeoIpProcessorDescriptor Properties(ICollection? properties) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public GeoIpProcessorDescriptor Tag(string? tag) { @@ -542,7 +624,9 @@ public GeoIpProcessorDescriptor Tag(string? tag) } /// - /// The field that will hold the geographical information looked up from the MaxMind database. + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// /// public GeoIpProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -551,7 +635,9 @@ public GeoIpProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Server } /// - /// The field that will hold the geographical information looked up from the MaxMind database. + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// /// public GeoIpProcessorDescriptor TargetField(Expression> targetField) { @@ -560,7 +646,9 @@ public GeoIpProcessorDescriptor TargetField(Expression - /// The field that will hold the geographical information looked up from the MaxMind database. + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// /// public GeoIpProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/GrokProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/GrokProcessor.g.cs index e274a9369bb..c9ef8ec6fe7 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/GrokProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/GrokProcessor.g.cs @@ -30,61 +30,85 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class GrokProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to use for grok expression parsing. + /// + /// The field to use for grok expression parsing. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor.
Patterns matching existing names will override the pre-existing definition. + /// + /// A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor. + /// Patterns matching existing names will override the pre-existing definition. + /// /// [JsonInclude, JsonPropertyName("pattern_definitions")] public IDictionary? PatternDefinitions { get; set; } /// - /// An ordered list of grok expression to match and extract named captures with.
Returns on the first expression in the list that matches. + /// + /// An ordered list of grok expression to match and extract named captures with. + /// Returns on the first expression in the list that matches. + /// /// [JsonInclude, JsonPropertyName("patterns")] public ICollection Patterns { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// When `true`, `_ingest._grok_match_index` will be inserted into your matched document’s metadata with the index into the pattern found in `patterns` that matched. + /// + /// When true, _ingest._grok_match_index will be inserted into your matched document’s metadata with the index into the pattern found in patterns that matched. + /// /// [JsonInclude, JsonPropertyName("trace_match")] public bool? TraceMatch { get; set; } @@ -115,7 +139,10 @@ public GrokProcessorDescriptor() : base() private bool? TraceMatchValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public GrokProcessorDescriptor Description(string? description) { @@ -124,7 +151,9 @@ public GrokProcessorDescriptor Description(string? description) } /// - /// The field to use for grok expression parsing. + /// + /// The field to use for grok expression parsing. + /// /// public GrokProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -133,7 +162,9 @@ public GrokProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Se } /// - /// The field to use for grok expression parsing. + /// + /// The field to use for grok expression parsing. + /// /// public GrokProcessorDescriptor Field(Expression> field) { @@ -142,7 +173,9 @@ public GrokProcessorDescriptor Field(Expression - /// The field to use for grok expression parsing. + /// + /// The field to use for grok expression parsing. + /// /// public GrokProcessorDescriptor Field(Expression> field) { @@ -151,7 +184,9 @@ public GrokProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public GrokProcessorDescriptor If(string? value) { @@ -160,7 +195,9 @@ public GrokProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public GrokProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -169,7 +206,9 @@ public GrokProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tr } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public GrokProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -178,7 +217,9 @@ public GrokProcessorDescriptor IgnoreMissing(bool? ignoreMissing = tr } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public GrokProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -217,7 +258,10 @@ public GrokProcessorDescriptor OnFailure(params Action - /// A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor.
Patterns matching existing names will override the pre-existing definition. + /// + /// A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor. + /// Patterns matching existing names will override the pre-existing definition. + /// /// public GrokProcessorDescriptor PatternDefinitions(Func, FluentDictionary> selector) { @@ -226,7 +270,10 @@ public GrokProcessorDescriptor PatternDefinitions(Func - /// An ordered list of grok expression to match and extract named captures with.
Returns on the first expression in the list that matches. + /// + /// An ordered list of grok expression to match and extract named captures with. + /// Returns on the first expression in the list that matches. + /// /// public GrokProcessorDescriptor Patterns(ICollection patterns) { @@ -235,7 +282,10 @@ public GrokProcessorDescriptor Patterns(ICollection patterns) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public GrokProcessorDescriptor Tag(string? tag) { @@ -244,7 +294,9 @@ public GrokProcessorDescriptor Tag(string? tag) } /// - /// When `true`, `_ingest._grok_match_index` will be inserted into your matched document’s metadata with the index into the pattern found in `patterns` that matched. + /// + /// When true, _ingest._grok_match_index will be inserted into your matched document’s metadata with the index into the pattern found in patterns that matched. + /// /// public GrokProcessorDescriptor TraceMatch(bool? traceMatch = true) { @@ -359,7 +411,10 @@ public GrokProcessorDescriptor() : base() private bool? TraceMatchValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public GrokProcessorDescriptor Description(string? description) { @@ -368,7 +423,9 @@ public GrokProcessorDescriptor Description(string? description) } /// - /// The field to use for grok expression parsing. + /// + /// The field to use for grok expression parsing. + /// /// public GrokProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -377,7 +434,9 @@ public GrokProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Fi } /// - /// The field to use for grok expression parsing. + /// + /// The field to use for grok expression parsing. + /// /// public GrokProcessorDescriptor Field(Expression> field) { @@ -386,7 +445,9 @@ public GrokProcessorDescriptor Field(Expression - /// The field to use for grok expression parsing. + /// + /// The field to use for grok expression parsing. + /// /// public GrokProcessorDescriptor Field(Expression> field) { @@ -395,7 +456,9 @@ public GrokProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public GrokProcessorDescriptor If(string? value) { @@ -404,7 +467,9 @@ public GrokProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public GrokProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -413,7 +478,9 @@ public GrokProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public GrokProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -422,7 +489,9 @@ public GrokProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public GrokProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -461,7 +530,10 @@ public GrokProcessorDescriptor OnFailure(params Action - /// A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor.
Patterns matching existing names will override the pre-existing definition. + /// + /// A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor. + /// Patterns matching existing names will override the pre-existing definition. + /// /// public GrokProcessorDescriptor PatternDefinitions(Func, FluentDictionary> selector) { @@ -470,7 +542,10 @@ public GrokProcessorDescriptor PatternDefinitions(Func - /// An ordered list of grok expression to match and extract named captures with.
Returns on the first expression in the list that matches. + /// + /// An ordered list of grok expression to match and extract named captures with. + /// Returns on the first expression in the list that matches. + /// /// public GrokProcessorDescriptor Patterns(ICollection patterns) { @@ -479,7 +554,10 @@ public GrokProcessorDescriptor Patterns(ICollection patterns) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public GrokProcessorDescriptor Tag(string? tag) { @@ -488,7 +566,9 @@ public GrokProcessorDescriptor Tag(string? tag) } /// - /// When `true`, `_ingest._grok_match_index` will be inserted into your matched document’s metadata with the index into the pattern found in `patterns` that matched. + /// + /// When true, _ingest._grok_match_index will be inserted into your matched document’s metadata with the index into the pattern found in patterns that matched. + /// /// public GrokProcessorDescriptor TraceMatch(bool? traceMatch = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/GsubProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/GsubProcessor.g.cs index 7c54184cf34..5982f39403c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/GsubProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/GsubProcessor.g.cs @@ -30,61 +30,84 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class GsubProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to apply the replacement to. + /// + /// The field to apply the replacement to. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// The pattern to be replaced. + /// + /// The pattern to be replaced. + /// /// [JsonInclude, JsonPropertyName("pattern")] public string Pattern { get; set; } /// - /// The string to replace the matching patterns with. + /// + /// The string to replace the matching patterns with. + /// /// [JsonInclude, JsonPropertyName("replacement")] public string Replacement { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field to assign the converted value to
By default, the `field` is updated in-place. + /// + /// The field to assign the converted value to + /// By default, the field is updated in-place. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? TargetField { get; set; } @@ -115,7 +138,10 @@ public GsubProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public GsubProcessorDescriptor Description(string? description) { @@ -124,7 +150,9 @@ public GsubProcessorDescriptor Description(string? description) } /// - /// The field to apply the replacement to. + /// + /// The field to apply the replacement to. + /// /// public GsubProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -133,7 +161,9 @@ public GsubProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Se } /// - /// The field to apply the replacement to. + /// + /// The field to apply the replacement to. + /// /// public GsubProcessorDescriptor Field(Expression> field) { @@ -142,7 +172,9 @@ public GsubProcessorDescriptor Field(Expression - /// The field to apply the replacement to. + /// + /// The field to apply the replacement to. + /// /// public GsubProcessorDescriptor Field(Expression> field) { @@ -151,7 +183,9 @@ public GsubProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public GsubProcessorDescriptor If(string? value) { @@ -160,7 +194,9 @@ public GsubProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public GsubProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -169,7 +205,9 @@ public GsubProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tr } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public GsubProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -178,7 +216,9 @@ public GsubProcessorDescriptor IgnoreMissing(bool? ignoreMissing = tr } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public GsubProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -217,7 +257,9 @@ public GsubProcessorDescriptor OnFailure(params Action - /// The pattern to be replaced. + /// + /// The pattern to be replaced. + /// /// public GsubProcessorDescriptor Pattern(string pattern) { @@ -226,7 +268,9 @@ public GsubProcessorDescriptor Pattern(string pattern) } /// - /// The string to replace the matching patterns with. + /// + /// The string to replace the matching patterns with. + /// /// public GsubProcessorDescriptor Replacement(string replacement) { @@ -235,7 +279,10 @@ public GsubProcessorDescriptor Replacement(string replacement) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public GsubProcessorDescriptor Tag(string? tag) { @@ -244,7 +291,10 @@ public GsubProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the converted value to
By default, the `field` is updated in-place. + /// + /// The field to assign the converted value to + /// By default, the field is updated in-place. + /// /// public GsubProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -253,7 +303,10 @@ public GsubProcessorDescriptor TargetField(Elastic.Clients.Elasticsea } /// - /// The field to assign the converted value to
By default, the `field` is updated in-place. + /// + /// The field to assign the converted value to + /// By default, the field is updated in-place. + /// /// public GsubProcessorDescriptor TargetField(Expression> targetField) { @@ -262,7 +315,10 @@ public GsubProcessorDescriptor TargetField(Expression - /// The field to assign the converted value to
By default, the `field` is updated in-place. + /// + /// The field to assign the converted value to + /// By default, the field is updated in-place. + /// /// public GsubProcessorDescriptor TargetField(Expression> targetField) { @@ -373,7 +429,10 @@ public GsubProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public GsubProcessorDescriptor Description(string? description) { @@ -382,7 +441,9 @@ public GsubProcessorDescriptor Description(string? description) } /// - /// The field to apply the replacement to. + /// + /// The field to apply the replacement to. + /// /// public GsubProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -391,7 +452,9 @@ public GsubProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Fi } /// - /// The field to apply the replacement to. + /// + /// The field to apply the replacement to. + /// /// public GsubProcessorDescriptor Field(Expression> field) { @@ -400,7 +463,9 @@ public GsubProcessorDescriptor Field(Expression - /// The field to apply the replacement to. + /// + /// The field to apply the replacement to. + /// /// public GsubProcessorDescriptor Field(Expression> field) { @@ -409,7 +474,9 @@ public GsubProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public GsubProcessorDescriptor If(string? value) { @@ -418,7 +485,9 @@ public GsubProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public GsubProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -427,7 +496,9 @@ public GsubProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public GsubProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -436,7 +507,9 @@ public GsubProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public GsubProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -475,7 +548,9 @@ public GsubProcessorDescriptor OnFailure(params Action - /// The pattern to be replaced. + /// + /// The pattern to be replaced. + /// /// public GsubProcessorDescriptor Pattern(string pattern) { @@ -484,7 +559,9 @@ public GsubProcessorDescriptor Pattern(string pattern) } /// - /// The string to replace the matching patterns with. + /// + /// The string to replace the matching patterns with. + /// /// public GsubProcessorDescriptor Replacement(string replacement) { @@ -493,7 +570,10 @@ public GsubProcessorDescriptor Replacement(string replacement) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public GsubProcessorDescriptor Tag(string? tag) { @@ -502,7 +582,10 @@ public GsubProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the converted value to
By default, the `field` is updated in-place. + /// + /// The field to assign the converted value to + /// By default, the field is updated in-place. + /// /// public GsubProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -511,7 +594,10 @@ public GsubProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverl } /// - /// The field to assign the converted value to
By default, the `field` is updated in-place. + /// + /// The field to assign the converted value to + /// By default, the field is updated in-place. + /// /// public GsubProcessorDescriptor TargetField(Expression> targetField) { @@ -520,7 +606,10 @@ public GsubProcessorDescriptor TargetField(Expression - /// The field to assign the converted value to
By default, the `field` is updated in-place. + /// + /// The field to assign the converted value to + /// By default, the field is updated in-place. + /// /// public GsubProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/InferenceConfigClassification.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/InferenceConfigClassification.g.cs index 4b0305888ea..226e73d3d6a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/InferenceConfigClassification.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/InferenceConfigClassification.g.cs @@ -30,31 +30,42 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class InferenceConfigClassification { /// - /// Specifies the number of top class predictions to return. + /// + /// Specifies the number of top class predictions to return. + /// /// [JsonInclude, JsonPropertyName("num_top_classes")] public int? NumTopClasses { get; set; } /// - /// Specifies the maximum number of feature importance values per document. + /// + /// Specifies the maximum number of feature importance values per document. + /// /// [JsonInclude, JsonPropertyName("num_top_feature_importance_values")] public int? NumTopFeatureImportanceValues { get; set; } /// - /// Specifies the type of the predicted field to write.
Valid values are: `string`, `number`, `boolean`. + /// + /// Specifies the type of the predicted field to write. + /// Valid values are: string, number, boolean. + /// /// [JsonInclude, JsonPropertyName("prediction_field_type")] public string? PredictionFieldType { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// /// [JsonInclude, JsonPropertyName("results_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? ResultsField { get; set; } /// - /// Specifies the field to which the top classes are written. + /// + /// Specifies the field to which the top classes are written. + /// /// [JsonInclude, JsonPropertyName("top_classes_results_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? TopClassesResultsField { get; set; } @@ -77,7 +88,9 @@ public InferenceConfigClassificationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TopClassesResultsFieldValue { get; set; } /// - /// Specifies the number of top class predictions to return. + /// + /// Specifies the number of top class predictions to return. + /// /// public InferenceConfigClassificationDescriptor NumTopClasses(int? numTopClasses) { @@ -86,7 +99,9 @@ public InferenceConfigClassificationDescriptor NumTopClasses(int? num } /// - /// Specifies the maximum number of feature importance values per document. + /// + /// Specifies the maximum number of feature importance values per document. + /// /// public InferenceConfigClassificationDescriptor NumTopFeatureImportanceValues(int? numTopFeatureImportanceValues) { @@ -95,7 +110,10 @@ public InferenceConfigClassificationDescriptor NumTopFeatureImportanc } /// - /// Specifies the type of the predicted field to write.
Valid values are: `string`, `number`, `boolean`. + /// + /// Specifies the type of the predicted field to write. + /// Valid values are: string, number, boolean. + /// /// public InferenceConfigClassificationDescriptor PredictionFieldType(string? predictionFieldType) { @@ -104,7 +122,9 @@ public InferenceConfigClassificationDescriptor PredictionFieldType(st } /// - /// The field that is added to incoming documents to contain the inference prediction. + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// /// public InferenceConfigClassificationDescriptor ResultsField(Elastic.Clients.Elasticsearch.Serverless.Field? resultsField) { @@ -113,7 +133,9 @@ public InferenceConfigClassificationDescriptor ResultsField(Elastic.C } /// - /// The field that is added to incoming documents to contain the inference prediction. + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// /// public InferenceConfigClassificationDescriptor ResultsField(Expression> resultsField) { @@ -122,7 +144,9 @@ public InferenceConfigClassificationDescriptor ResultsField(E } /// - /// The field that is added to incoming documents to contain the inference prediction. + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// /// public InferenceConfigClassificationDescriptor ResultsField(Expression> resultsField) { @@ -131,7 +155,9 @@ public InferenceConfigClassificationDescriptor ResultsField(Expressio } /// - /// Specifies the field to which the top classes are written. + /// + /// Specifies the field to which the top classes are written. + /// /// public InferenceConfigClassificationDescriptor TopClassesResultsField(Elastic.Clients.Elasticsearch.Serverless.Field? topClassesResultsField) { @@ -140,7 +166,9 @@ public InferenceConfigClassificationDescriptor TopClassesResultsField } /// - /// Specifies the field to which the top classes are written. + /// + /// Specifies the field to which the top classes are written. + /// /// public InferenceConfigClassificationDescriptor TopClassesResultsField(Expression> topClassesResultsField) { @@ -149,7 +177,9 @@ public InferenceConfigClassificationDescriptor TopClassesResultsField } /// - /// Specifies the field to which the top classes are written. + /// + /// Specifies the field to which the top classes are written. + /// /// public InferenceConfigClassificationDescriptor TopClassesResultsField(Expression> topClassesResultsField) { @@ -209,7 +239,9 @@ public InferenceConfigClassificationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TopClassesResultsFieldValue { get; set; } /// - /// Specifies the number of top class predictions to return. + /// + /// Specifies the number of top class predictions to return. + /// /// public InferenceConfigClassificationDescriptor NumTopClasses(int? numTopClasses) { @@ -218,7 +250,9 @@ public InferenceConfigClassificationDescriptor NumTopClasses(int? numTopClasses) } /// - /// Specifies the maximum number of feature importance values per document. + /// + /// Specifies the maximum number of feature importance values per document. + /// /// public InferenceConfigClassificationDescriptor NumTopFeatureImportanceValues(int? numTopFeatureImportanceValues) { @@ -227,7 +261,10 @@ public InferenceConfigClassificationDescriptor NumTopFeatureImportanceValues(int } /// - /// Specifies the type of the predicted field to write.
Valid values are: `string`, `number`, `boolean`. + /// + /// Specifies the type of the predicted field to write. + /// Valid values are: string, number, boolean. + /// /// public InferenceConfigClassificationDescriptor PredictionFieldType(string? predictionFieldType) { @@ -236,7 +273,9 @@ public InferenceConfigClassificationDescriptor PredictionFieldType(string? predi } /// - /// The field that is added to incoming documents to contain the inference prediction. + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// /// public InferenceConfigClassificationDescriptor ResultsField(Elastic.Clients.Elasticsearch.Serverless.Field? resultsField) { @@ -245,7 +284,9 @@ public InferenceConfigClassificationDescriptor ResultsField(Elastic.Clients.Elas } /// - /// The field that is added to incoming documents to contain the inference prediction. + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// /// public InferenceConfigClassificationDescriptor ResultsField(Expression> resultsField) { @@ -254,7 +295,9 @@ public InferenceConfigClassificationDescriptor ResultsField(E } /// - /// The field that is added to incoming documents to contain the inference prediction. + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// /// public InferenceConfigClassificationDescriptor ResultsField(Expression> resultsField) { @@ -263,7 +306,9 @@ public InferenceConfigClassificationDescriptor ResultsField(Expressio } /// - /// Specifies the field to which the top classes are written. + /// + /// Specifies the field to which the top classes are written. + /// /// public InferenceConfigClassificationDescriptor TopClassesResultsField(Elastic.Clients.Elasticsearch.Serverless.Field? topClassesResultsField) { @@ -272,7 +317,9 @@ public InferenceConfigClassificationDescriptor TopClassesResultsField(Elastic.Cl } /// - /// Specifies the field to which the top classes are written. + /// + /// Specifies the field to which the top classes are written. + /// /// public InferenceConfigClassificationDescriptor TopClassesResultsField(Expression> topClassesResultsField) { @@ -281,7 +328,9 @@ public InferenceConfigClassificationDescriptor TopClassesResultsField - /// Specifies the field to which the top classes are written. + /// + /// Specifies the field to which the top classes are written. + /// /// public InferenceConfigClassificationDescriptor TopClassesResultsField(Expression> topClassesResultsField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/InferenceConfigRegression.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/InferenceConfigRegression.g.cs index 1ab92895b11..7cff6fb9ae8 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/InferenceConfigRegression.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/InferenceConfigRegression.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class InferenceConfigRegression { /// - /// Specifies the maximum number of feature importance values per document. + /// + /// Specifies the maximum number of feature importance values per document. + /// /// [JsonInclude, JsonPropertyName("num_top_feature_importance_values")] public int? NumTopFeatureImportanceValues { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// /// [JsonInclude, JsonPropertyName("results_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? ResultsField { get; set; } @@ -56,7 +60,9 @@ public InferenceConfigRegressionDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? ResultsFieldValue { get; set; } /// - /// Specifies the maximum number of feature importance values per document. + /// + /// Specifies the maximum number of feature importance values per document. + /// /// public InferenceConfigRegressionDescriptor NumTopFeatureImportanceValues(int? numTopFeatureImportanceValues) { @@ -65,7 +71,9 @@ public InferenceConfigRegressionDescriptor NumTopFeatureImportanceVal } /// - /// The field that is added to incoming documents to contain the inference prediction. + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// /// public InferenceConfigRegressionDescriptor ResultsField(Elastic.Clients.Elasticsearch.Serverless.Field? resultsField) { @@ -74,7 +82,9 @@ public InferenceConfigRegressionDescriptor ResultsField(Elastic.Clien } /// - /// The field that is added to incoming documents to contain the inference prediction. + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// /// public InferenceConfigRegressionDescriptor ResultsField(Expression> resultsField) { @@ -83,7 +93,9 @@ public InferenceConfigRegressionDescriptor ResultsField(Expre } /// - /// The field that is added to incoming documents to contain the inference prediction. + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// /// public InferenceConfigRegressionDescriptor ResultsField(Expression> resultsField) { @@ -122,7 +134,9 @@ public InferenceConfigRegressionDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? ResultsFieldValue { get; set; } /// - /// Specifies the maximum number of feature importance values per document. + /// + /// Specifies the maximum number of feature importance values per document. + /// /// public InferenceConfigRegressionDescriptor NumTopFeatureImportanceValues(int? numTopFeatureImportanceValues) { @@ -131,7 +145,9 @@ public InferenceConfigRegressionDescriptor NumTopFeatureImportanceValues(int? nu } /// - /// The field that is added to incoming documents to contain the inference prediction. + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// /// public InferenceConfigRegressionDescriptor ResultsField(Elastic.Clients.Elasticsearch.Serverless.Field? resultsField) { @@ -140,7 +156,9 @@ public InferenceConfigRegressionDescriptor ResultsField(Elastic.Clients.Elastics } /// - /// The field that is added to incoming documents to contain the inference prediction. + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// /// public InferenceConfigRegressionDescriptor ResultsField(Expression> resultsField) { @@ -149,7 +167,9 @@ public InferenceConfigRegressionDescriptor ResultsField(Expre } /// - /// The field that is added to incoming documents to contain the inference prediction. + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// /// public InferenceConfigRegressionDescriptor ResultsField(Expression> resultsField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/InferenceProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/InferenceProcessor.g.cs index 5e36e1916e9..402c858e867 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/InferenceProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/InferenceProcessor.g.cs @@ -30,55 +30,76 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class InferenceProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// Maps the document field names to the known field names of the model.
This mapping takes precedence over any default mappings provided in the model configuration. + /// + /// Maps the document field names to the known field names of the model. + /// This mapping takes precedence over any default mappings provided in the model configuration. + /// /// [JsonInclude, JsonPropertyName("field_map")] public IDictionary? FieldMap { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// Contains the inference type and its options. + /// + /// Contains the inference type and its options. + /// /// [JsonInclude, JsonPropertyName("inference_config")] public Elastic.Clients.Elasticsearch.Serverless.Ingest.InferenceConfig? InferenceConfig { get; set; } /// - /// The ID or alias for the trained model, or the ID of the deployment. + /// + /// The ID or alias for the trained model, or the ID of the deployment. + /// /// [JsonInclude, JsonPropertyName("model_id")] public Elastic.Clients.Elasticsearch.Serverless.Id ModelId { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// Field added to incoming documents to contain results objects. + /// + /// Field added to incoming documents to contain results objects. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? TargetField { get; set; } @@ -110,7 +131,10 @@ public InferenceProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public InferenceProcessorDescriptor Description(string? description) { @@ -119,7 +143,10 @@ public InferenceProcessorDescriptor Description(string? description) } /// - /// Maps the document field names to the known field names of the model.
This mapping takes precedence over any default mappings provided in the model configuration. + /// + /// Maps the document field names to the known field names of the model. + /// This mapping takes precedence over any default mappings provided in the model configuration. + /// /// public InferenceProcessorDescriptor FieldMap(Func, FluentDictionary> selector) { @@ -128,7 +155,9 @@ public InferenceProcessorDescriptor FieldMap(Func - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public InferenceProcessorDescriptor If(string? value) { @@ -137,7 +166,9 @@ public InferenceProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public InferenceProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -146,7 +177,9 @@ public InferenceProcessorDescriptor IgnoreFailure(bool? ignoreFailure } /// - /// Contains the inference type and its options. + /// + /// Contains the inference type and its options. + /// /// public InferenceProcessorDescriptor InferenceConfig(Elastic.Clients.Elasticsearch.Serverless.Ingest.InferenceConfig? inferenceConfig) { @@ -173,7 +206,9 @@ public InferenceProcessorDescriptor InferenceConfig(Action - /// The ID or alias for the trained model, or the ID of the deployment. + /// + /// The ID or alias for the trained model, or the ID of the deployment. + /// /// public InferenceProcessorDescriptor ModelId(Elastic.Clients.Elasticsearch.Serverless.Id modelId) { @@ -182,7 +217,9 @@ public InferenceProcessorDescriptor ModelId(Elastic.Clients.Elasticse } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public InferenceProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -221,7 +258,10 @@ public InferenceProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public InferenceProcessorDescriptor Tag(string? tag) { @@ -230,7 +270,9 @@ public InferenceProcessorDescriptor Tag(string? tag) } /// - /// Field added to incoming documents to contain results objects. + /// + /// Field added to incoming documents to contain results objects. + /// /// public InferenceProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -239,7 +281,9 @@ public InferenceProcessorDescriptor TargetField(Elastic.Clients.Elast } /// - /// Field added to incoming documents to contain results objects. + /// + /// Field added to incoming documents to contain results objects. + /// /// public InferenceProcessorDescriptor TargetField(Expression> targetField) { @@ -248,7 +292,9 @@ public InferenceProcessorDescriptor TargetField(Expression - /// Field added to incoming documents to contain results objects. + /// + /// Field added to incoming documents to contain results objects. + /// /// public InferenceProcessorDescriptor TargetField(Expression> targetField) { @@ -372,7 +418,10 @@ public InferenceProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public InferenceProcessorDescriptor Description(string? description) { @@ -381,7 +430,10 @@ public InferenceProcessorDescriptor Description(string? description) } /// - /// Maps the document field names to the known field names of the model.
This mapping takes precedence over any default mappings provided in the model configuration. + /// + /// Maps the document field names to the known field names of the model. + /// This mapping takes precedence over any default mappings provided in the model configuration. + /// /// public InferenceProcessorDescriptor FieldMap(Func, FluentDictionary> selector) { @@ -390,7 +442,9 @@ public InferenceProcessorDescriptor FieldMap(Func - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public InferenceProcessorDescriptor If(string? value) { @@ -399,7 +453,9 @@ public InferenceProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public InferenceProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -408,7 +464,9 @@ public InferenceProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// Contains the inference type and its options. + /// + /// Contains the inference type and its options. + /// /// public InferenceProcessorDescriptor InferenceConfig(Elastic.Clients.Elasticsearch.Serverless.Ingest.InferenceConfig? inferenceConfig) { @@ -435,7 +493,9 @@ public InferenceProcessorDescriptor InferenceConfig(Action - /// The ID or alias for the trained model, or the ID of the deployment. + /// + /// The ID or alias for the trained model, or the ID of the deployment. + /// /// public InferenceProcessorDescriptor ModelId(Elastic.Clients.Elasticsearch.Serverless.Id modelId) { @@ -444,7 +504,9 @@ public InferenceProcessorDescriptor ModelId(Elastic.Clients.Elasticsearch.Server } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public InferenceProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -483,7 +545,10 @@ public InferenceProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public InferenceProcessorDescriptor Tag(string? tag) { @@ -492,7 +557,9 @@ public InferenceProcessorDescriptor Tag(string? tag) } /// - /// Field added to incoming documents to contain results objects. + /// + /// Field added to incoming documents to contain results objects. + /// /// public InferenceProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -501,7 +568,9 @@ public InferenceProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Se } /// - /// Field added to incoming documents to contain results objects. + /// + /// Field added to incoming documents to contain results objects. + /// /// public InferenceProcessorDescriptor TargetField(Expression> targetField) { @@ -510,7 +579,9 @@ public InferenceProcessorDescriptor TargetField(Expression - /// Field added to incoming documents to contain results objects. + /// + /// Field added to incoming documents to contain results objects. + /// /// public InferenceProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/JoinProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/JoinProcessor.g.cs index 760b7d655cf..67a06195c8a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/JoinProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/JoinProcessor.g.cs @@ -30,49 +30,68 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class JoinProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// Field containing array values to join. + /// + /// Field containing array values to join. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// The separator character. + /// + /// The separator character. + /// /// [JsonInclude, JsonPropertyName("separator")] public string Separator { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field to assign the joined value to.
By default, the field is updated in-place. + /// + /// The field to assign the joined value to. + /// By default, the field is updated in-place. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? TargetField { get; set; } @@ -101,7 +120,10 @@ public JoinProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public JoinProcessorDescriptor Description(string? description) { @@ -110,7 +132,9 @@ public JoinProcessorDescriptor Description(string? description) } /// - /// Field containing array values to join. + /// + /// Field containing array values to join. + /// /// public JoinProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -119,7 +143,9 @@ public JoinProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Se } /// - /// Field containing array values to join. + /// + /// Field containing array values to join. + /// /// public JoinProcessorDescriptor Field(Expression> field) { @@ -128,7 +154,9 @@ public JoinProcessorDescriptor Field(Expression - /// Field containing array values to join. + /// + /// Field containing array values to join. + /// /// public JoinProcessorDescriptor Field(Expression> field) { @@ -137,7 +165,9 @@ public JoinProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public JoinProcessorDescriptor If(string? value) { @@ -146,7 +176,9 @@ public JoinProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public JoinProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -155,7 +187,9 @@ public JoinProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tr } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public JoinProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -194,7 +228,9 @@ public JoinProcessorDescriptor OnFailure(params Action - /// The separator character. + /// + /// The separator character. + /// /// public JoinProcessorDescriptor Separator(string separator) { @@ -203,7 +239,10 @@ public JoinProcessorDescriptor Separator(string separator) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public JoinProcessorDescriptor Tag(string? tag) { @@ -212,7 +251,10 @@ public JoinProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the joined value to.
By default, the field is updated in-place. + /// + /// The field to assign the joined value to. + /// By default, the field is updated in-place. + /// /// public JoinProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -221,7 +263,10 @@ public JoinProcessorDescriptor TargetField(Elastic.Clients.Elasticsea } /// - /// The field to assign the joined value to.
By default, the field is updated in-place. + /// + /// The field to assign the joined value to. + /// By default, the field is updated in-place. + /// /// public JoinProcessorDescriptor TargetField(Expression> targetField) { @@ -230,7 +275,10 @@ public JoinProcessorDescriptor TargetField(Expression - /// The field to assign the joined value to.
By default, the field is updated in-place. + /// + /// The field to assign the joined value to. + /// By default, the field is updated in-place. + /// /// public JoinProcessorDescriptor TargetField(Expression> targetField) { @@ -331,7 +379,10 @@ public JoinProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public JoinProcessorDescriptor Description(string? description) { @@ -340,7 +391,9 @@ public JoinProcessorDescriptor Description(string? description) } /// - /// Field containing array values to join. + /// + /// Field containing array values to join. + /// /// public JoinProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -349,7 +402,9 @@ public JoinProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Fi } /// - /// Field containing array values to join. + /// + /// Field containing array values to join. + /// /// public JoinProcessorDescriptor Field(Expression> field) { @@ -358,7 +413,9 @@ public JoinProcessorDescriptor Field(Expression - /// Field containing array values to join. + /// + /// Field containing array values to join. + /// /// public JoinProcessorDescriptor Field(Expression> field) { @@ -367,7 +424,9 @@ public JoinProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public JoinProcessorDescriptor If(string? value) { @@ -376,7 +435,9 @@ public JoinProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public JoinProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -385,7 +446,9 @@ public JoinProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public JoinProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -424,7 +487,9 @@ public JoinProcessorDescriptor OnFailure(params Action - /// The separator character. + /// + /// The separator character. + /// /// public JoinProcessorDescriptor Separator(string separator) { @@ -433,7 +498,10 @@ public JoinProcessorDescriptor Separator(string separator) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public JoinProcessorDescriptor Tag(string? tag) { @@ -442,7 +510,10 @@ public JoinProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the joined value to.
By default, the field is updated in-place. + /// + /// The field to assign the joined value to. + /// By default, the field is updated in-place. + /// /// public JoinProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -451,7 +522,10 @@ public JoinProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverl } /// - /// The field to assign the joined value to.
By default, the field is updated in-place. + /// + /// The field to assign the joined value to. + /// By default, the field is updated in-place. + /// /// public JoinProcessorDescriptor TargetField(Expression> targetField) { @@ -460,7 +534,10 @@ public JoinProcessorDescriptor TargetField(Expression - /// The field to assign the joined value to.
By default, the field is updated in-place. + /// + /// The field to assign the joined value to. + /// By default, the field is updated in-place. + /// /// public JoinProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/JsonProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/JsonProcessor.g.cs index b18517a1e0b..92b4f24297a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/JsonProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/JsonProcessor.g.cs @@ -30,61 +30,88 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class JsonProcessor { /// - /// Flag that forces the parsed JSON to be added at the top level of the document.
`target_field` must not be set when this option is chosen. + /// + /// Flag that forces the parsed JSON to be added at the top level of the document. + /// target_field must not be set when this option is chosen. + /// /// [JsonInclude, JsonPropertyName("add_to_root")] public bool? AddToRoot { get; set; } /// - /// When set to `replace`, root fields that conflict with fields from the parsed JSON will be overridden.
When set to `merge`, conflicting fields will be merged.
Only applicable `if add_to_root` is set to true. + /// + /// When set to replace, root fields that conflict with fields from the parsed JSON will be overridden. + /// When set to merge, conflicting fields will be merged. + /// Only applicable if add_to_root is set to true. + /// /// [JsonInclude, JsonPropertyName("add_to_root_conflict_strategy")] public Elastic.Clients.Elasticsearch.Serverless.Ingest.JsonProcessorConflictStrategy? AddToRootConflictStrategy { get; set; } /// - /// When set to `true`, the JSON parser will not fail if the JSON contains duplicate keys.
Instead, the last encountered value for any duplicate key wins. + /// + /// When set to true, the JSON parser will not fail if the JSON contains duplicate keys. + /// Instead, the last encountered value for any duplicate key wins. + /// /// [JsonInclude, JsonPropertyName("allow_duplicate_keys")] public bool? AllowDuplicateKeys { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to be parsed. + /// + /// The field to be parsed. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field that the converted structured object will be written into.
Any existing content in this field will be overwritten. + /// + /// The field that the converted structured object will be written into. + /// Any existing content in this field will be overwritten. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? TargetField { get; set; } @@ -115,7 +142,10 @@ public JsonProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } /// - /// Flag that forces the parsed JSON to be added at the top level of the document.
`target_field` must not be set when this option is chosen. + /// + /// Flag that forces the parsed JSON to be added at the top level of the document. + /// target_field must not be set when this option is chosen. + /// /// public JsonProcessorDescriptor AddToRoot(bool? addToRoot = true) { @@ -124,7 +154,11 @@ public JsonProcessorDescriptor AddToRoot(bool? addToRoot = true) } /// - /// When set to `replace`, root fields that conflict with fields from the parsed JSON will be overridden.
When set to `merge`, conflicting fields will be merged.
Only applicable `if add_to_root` is set to true. + /// + /// When set to replace, root fields that conflict with fields from the parsed JSON will be overridden. + /// When set to merge, conflicting fields will be merged. + /// Only applicable if add_to_root is set to true. + /// /// public JsonProcessorDescriptor AddToRootConflictStrategy(Elastic.Clients.Elasticsearch.Serverless.Ingest.JsonProcessorConflictStrategy? addToRootConflictStrategy) { @@ -133,7 +167,10 @@ public JsonProcessorDescriptor AddToRootConflictStrategy(Elastic.Clie } /// - /// When set to `true`, the JSON parser will not fail if the JSON contains duplicate keys.
Instead, the last encountered value for any duplicate key wins. + /// + /// When set to true, the JSON parser will not fail if the JSON contains duplicate keys. + /// Instead, the last encountered value for any duplicate key wins. + /// /// public JsonProcessorDescriptor AllowDuplicateKeys(bool? allowDuplicateKeys = true) { @@ -142,7 +179,10 @@ public JsonProcessorDescriptor AllowDuplicateKeys(bool? allowDuplicat } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public JsonProcessorDescriptor Description(string? description) { @@ -151,7 +191,9 @@ public JsonProcessorDescriptor Description(string? description) } /// - /// The field to be parsed. + /// + /// The field to be parsed. + /// /// public JsonProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -160,7 +202,9 @@ public JsonProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Se } /// - /// The field to be parsed. + /// + /// The field to be parsed. + /// /// public JsonProcessorDescriptor Field(Expression> field) { @@ -169,7 +213,9 @@ public JsonProcessorDescriptor Field(Expression - /// The field to be parsed. + /// + /// The field to be parsed. + /// /// public JsonProcessorDescriptor Field(Expression> field) { @@ -178,7 +224,9 @@ public JsonProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public JsonProcessorDescriptor If(string? value) { @@ -187,7 +235,9 @@ public JsonProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public JsonProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -196,7 +246,9 @@ public JsonProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tr } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public JsonProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -235,7 +287,10 @@ public JsonProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public JsonProcessorDescriptor Tag(string? tag) { @@ -244,7 +299,10 @@ public JsonProcessorDescriptor Tag(string? tag) } /// - /// The field that the converted structured object will be written into.
Any existing content in this field will be overwritten. + /// + /// The field that the converted structured object will be written into. + /// Any existing content in this field will be overwritten. + /// /// public JsonProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -253,7 +311,10 @@ public JsonProcessorDescriptor TargetField(Elastic.Clients.Elasticsea } /// - /// The field that the converted structured object will be written into.
Any existing content in this field will be overwritten. + /// + /// The field that the converted structured object will be written into. + /// Any existing content in this field will be overwritten. + /// /// public JsonProcessorDescriptor TargetField(Expression> targetField) { @@ -262,7 +323,10 @@ public JsonProcessorDescriptor TargetField(Expression - /// The field that the converted structured object will be written into.
Any existing content in this field will be overwritten. + /// + /// The field that the converted structured object will be written into. + /// Any existing content in this field will be overwritten. + /// /// public JsonProcessorDescriptor TargetField(Expression> targetField) { @@ -381,7 +445,10 @@ public JsonProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } /// - /// Flag that forces the parsed JSON to be added at the top level of the document.
`target_field` must not be set when this option is chosen. + /// + /// Flag that forces the parsed JSON to be added at the top level of the document. + /// target_field must not be set when this option is chosen. + /// /// public JsonProcessorDescriptor AddToRoot(bool? addToRoot = true) { @@ -390,7 +457,11 @@ public JsonProcessorDescriptor AddToRoot(bool? addToRoot = true) } /// - /// When set to `replace`, root fields that conflict with fields from the parsed JSON will be overridden.
When set to `merge`, conflicting fields will be merged.
Only applicable `if add_to_root` is set to true. + /// + /// When set to replace, root fields that conflict with fields from the parsed JSON will be overridden. + /// When set to merge, conflicting fields will be merged. + /// Only applicable if add_to_root is set to true. + /// /// public JsonProcessorDescriptor AddToRootConflictStrategy(Elastic.Clients.Elasticsearch.Serverless.Ingest.JsonProcessorConflictStrategy? addToRootConflictStrategy) { @@ -399,7 +470,10 @@ public JsonProcessorDescriptor AddToRootConflictStrategy(Elastic.Clients.Elastic } /// - /// When set to `true`, the JSON parser will not fail if the JSON contains duplicate keys.
Instead, the last encountered value for any duplicate key wins. + /// + /// When set to true, the JSON parser will not fail if the JSON contains duplicate keys. + /// Instead, the last encountered value for any duplicate key wins. + /// /// public JsonProcessorDescriptor AllowDuplicateKeys(bool? allowDuplicateKeys = true) { @@ -408,7 +482,10 @@ public JsonProcessorDescriptor AllowDuplicateKeys(bool? allowDuplicateKeys = tru } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public JsonProcessorDescriptor Description(string? description) { @@ -417,7 +494,9 @@ public JsonProcessorDescriptor Description(string? description) } /// - /// The field to be parsed. + /// + /// The field to be parsed. + /// /// public JsonProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -426,7 +505,9 @@ public JsonProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Fi } /// - /// The field to be parsed. + /// + /// The field to be parsed. + /// /// public JsonProcessorDescriptor Field(Expression> field) { @@ -435,7 +516,9 @@ public JsonProcessorDescriptor Field(Expression - /// The field to be parsed. + /// + /// The field to be parsed. + /// /// public JsonProcessorDescriptor Field(Expression> field) { @@ -444,7 +527,9 @@ public JsonProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public JsonProcessorDescriptor If(string? value) { @@ -453,7 +538,9 @@ public JsonProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public JsonProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -462,7 +549,9 @@ public JsonProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public JsonProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -501,7 +590,10 @@ public JsonProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public JsonProcessorDescriptor Tag(string? tag) { @@ -510,7 +602,10 @@ public JsonProcessorDescriptor Tag(string? tag) } /// - /// The field that the converted structured object will be written into.
Any existing content in this field will be overwritten. + /// + /// The field that the converted structured object will be written into. + /// Any existing content in this field will be overwritten. + /// /// public JsonProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -519,7 +614,10 @@ public JsonProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverl } /// - /// The field that the converted structured object will be written into.
Any existing content in this field will be overwritten. + /// + /// The field that the converted structured object will be written into. + /// Any existing content in this field will be overwritten. + /// /// public JsonProcessorDescriptor TargetField(Expression> targetField) { @@ -528,7 +626,10 @@ public JsonProcessorDescriptor TargetField(Expression - /// The field that the converted structured object will be written into.
Any existing content in this field will be overwritten. + /// + /// The field that the converted structured object will be written into. + /// Any existing content in this field will be overwritten. + /// /// public JsonProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/KeyValueProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/KeyValueProcessor.g.cs index b45158b3afa..010d194bd82 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/KeyValueProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/KeyValueProcessor.g.cs @@ -30,97 +30,135 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class KeyValueProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// List of keys to exclude from document. + /// + /// List of keys to exclude from document. + /// /// [JsonInclude, JsonPropertyName("exclude_keys")] public ICollection? ExcludeKeys { get; set; } /// - /// The field to be parsed.
Supports template snippets. + /// + /// The field to be parsed. + /// Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Regex pattern to use for splitting key-value pairs. + /// + /// Regex pattern to use for splitting key-value pairs. + /// /// [JsonInclude, JsonPropertyName("field_split")] public string FieldSplit { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// List of keys to filter and insert into document.
Defaults to including all keys. + /// + /// List of keys to filter and insert into document. + /// Defaults to including all keys. + /// /// [JsonInclude, JsonPropertyName("include_keys")] public ICollection? IncludeKeys { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Prefix to be added to extracted keys. + /// + /// Prefix to be added to extracted keys. + /// /// [JsonInclude, JsonPropertyName("prefix")] public string? Prefix { get; set; } /// - /// If `true`. strip brackets `()`, `<>`, `[]` as well as quotes `'` and `"` from extracted values. + /// + /// If true. strip brackets (), <>, [] as well as quotes ' and " from extracted values. + /// /// [JsonInclude, JsonPropertyName("strip_brackets")] public bool? StripBrackets { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field to insert the extracted keys into.
Defaults to the root of the document.
Supports template snippets. + /// + /// The field to insert the extracted keys into. + /// Defaults to the root of the document. + /// Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? TargetField { get; set; } /// - /// String of characters to trim from extracted keys. + /// + /// String of characters to trim from extracted keys. + /// /// [JsonInclude, JsonPropertyName("trim_key")] public string? TrimKey { get; set; } /// - /// String of characters to trim from extracted values. + /// + /// String of characters to trim from extracted values. + /// /// [JsonInclude, JsonPropertyName("trim_value")] public string? TrimValue { get; set; } /// - /// Regex pattern to use for splitting the key from the value within a key-value pair. + /// + /// Regex pattern to use for splitting the key from the value within a key-value pair. + /// /// [JsonInclude, JsonPropertyName("value_split")] public string ValueSplit { get; set; } @@ -157,7 +195,10 @@ public KeyValueProcessorDescriptor() : base() private string ValueSplitValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public KeyValueProcessorDescriptor Description(string? description) { @@ -166,7 +207,9 @@ public KeyValueProcessorDescriptor Description(string? description) } /// - /// List of keys to exclude from document. + /// + /// List of keys to exclude from document. + /// /// public KeyValueProcessorDescriptor ExcludeKeys(ICollection? excludeKeys) { @@ -175,7 +218,10 @@ public KeyValueProcessorDescriptor ExcludeKeys(ICollection? e } /// - /// The field to be parsed.
Supports template snippets. + /// + /// The field to be parsed. + /// Supports template snippets. + /// /// public KeyValueProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -184,7 +230,10 @@ public KeyValueProcessorDescriptor Field(Elastic.Clients.Elasticsearc } /// - /// The field to be parsed.
Supports template snippets. + /// + /// The field to be parsed. + /// Supports template snippets. + /// /// public KeyValueProcessorDescriptor Field(Expression> field) { @@ -193,7 +242,10 @@ public KeyValueProcessorDescriptor Field(Expression - /// The field to be parsed.
Supports template snippets. + /// + /// The field to be parsed. + /// Supports template snippets. + /// /// public KeyValueProcessorDescriptor Field(Expression> field) { @@ -202,7 +254,9 @@ public KeyValueProcessorDescriptor Field(Expression - /// Regex pattern to use for splitting key-value pairs. + /// + /// Regex pattern to use for splitting key-value pairs. + /// /// public KeyValueProcessorDescriptor FieldSplit(string fieldSplit) { @@ -211,7 +265,9 @@ public KeyValueProcessorDescriptor FieldSplit(string fieldSplit) } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public KeyValueProcessorDescriptor If(string? value) { @@ -220,7 +276,9 @@ public KeyValueProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public KeyValueProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -229,7 +287,9 @@ public KeyValueProcessorDescriptor IgnoreFailure(bool? ignoreFailure } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public KeyValueProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -238,7 +298,10 @@ public KeyValueProcessorDescriptor IgnoreMissing(bool? ignoreMissing } /// - /// List of keys to filter and insert into document.
Defaults to including all keys. + /// + /// List of keys to filter and insert into document. + /// Defaults to including all keys. + /// /// public KeyValueProcessorDescriptor IncludeKeys(ICollection? includeKeys) { @@ -247,7 +310,9 @@ public KeyValueProcessorDescriptor IncludeKeys(ICollection? i } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public KeyValueProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -286,7 +351,9 @@ public KeyValueProcessorDescriptor OnFailure(params Action - /// Prefix to be added to extracted keys. + /// + /// Prefix to be added to extracted keys. + /// /// public KeyValueProcessorDescriptor Prefix(string? prefix) { @@ -295,7 +362,9 @@ public KeyValueProcessorDescriptor Prefix(string? prefix) } /// - /// If `true`. strip brackets `()`, `<>`, `[]` as well as quotes `'` and `"` from extracted values. + /// + /// If true. strip brackets (), <>, [] as well as quotes ' and " from extracted values. + /// /// public KeyValueProcessorDescriptor StripBrackets(bool? stripBrackets = true) { @@ -304,7 +373,10 @@ public KeyValueProcessorDescriptor StripBrackets(bool? stripBrackets } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public KeyValueProcessorDescriptor Tag(string? tag) { @@ -313,7 +385,11 @@ public KeyValueProcessorDescriptor Tag(string? tag) } /// - /// The field to insert the extracted keys into.
Defaults to the root of the document.
Supports template snippets. + /// + /// The field to insert the extracted keys into. + /// Defaults to the root of the document. + /// Supports template snippets. + /// /// public KeyValueProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -322,7 +398,11 @@ public KeyValueProcessorDescriptor TargetField(Elastic.Clients.Elasti } /// - /// The field to insert the extracted keys into.
Defaults to the root of the document.
Supports template snippets. + /// + /// The field to insert the extracted keys into. + /// Defaults to the root of the document. + /// Supports template snippets. + /// /// public KeyValueProcessorDescriptor TargetField(Expression> targetField) { @@ -331,7 +411,11 @@ public KeyValueProcessorDescriptor TargetField(Expression - /// The field to insert the extracted keys into.
Defaults to the root of the document.
Supports template snippets. + /// + /// The field to insert the extracted keys into. + /// Defaults to the root of the document. + /// Supports template snippets. + /// /// public KeyValueProcessorDescriptor TargetField(Expression> targetField) { @@ -340,7 +424,9 @@ public KeyValueProcessorDescriptor TargetField(Expression - /// String of characters to trim from extracted keys. + /// + /// String of characters to trim from extracted keys. + /// /// public KeyValueProcessorDescriptor TrimKey(string? trimKey) { @@ -349,7 +435,9 @@ public KeyValueProcessorDescriptor TrimKey(string? trimKey) } /// - /// String of characters to trim from extracted values. + /// + /// String of characters to trim from extracted values. + /// /// public KeyValueProcessorDescriptor TrimValue(string? trimValue) { @@ -358,7 +446,9 @@ public KeyValueProcessorDescriptor TrimValue(string? trimValue) } /// - /// Regex pattern to use for splitting the key from the value within a key-value pair. + /// + /// Regex pattern to use for splitting the key from the value within a key-value pair. + /// /// public KeyValueProcessorDescriptor ValueSplit(string valueSplit) { @@ -511,7 +601,10 @@ public KeyValueProcessorDescriptor() : base() private string ValueSplitValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public KeyValueProcessorDescriptor Description(string? description) { @@ -520,7 +613,9 @@ public KeyValueProcessorDescriptor Description(string? description) } /// - /// List of keys to exclude from document. + /// + /// List of keys to exclude from document. + /// /// public KeyValueProcessorDescriptor ExcludeKeys(ICollection? excludeKeys) { @@ -529,7 +624,10 @@ public KeyValueProcessorDescriptor ExcludeKeys(ICollection? excludeKeys) } /// - /// The field to be parsed.
Supports template snippets. + /// + /// The field to be parsed. + /// Supports template snippets. + /// /// public KeyValueProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -538,7 +636,10 @@ public KeyValueProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverles } /// - /// The field to be parsed.
Supports template snippets. + /// + /// The field to be parsed. + /// Supports template snippets. + /// /// public KeyValueProcessorDescriptor Field(Expression> field) { @@ -547,7 +648,10 @@ public KeyValueProcessorDescriptor Field(Expression - /// The field to be parsed.
Supports template snippets. + /// + /// The field to be parsed. + /// Supports template snippets. + /// /// public KeyValueProcessorDescriptor Field(Expression> field) { @@ -556,7 +660,9 @@ public KeyValueProcessorDescriptor Field(Expression - /// Regex pattern to use for splitting key-value pairs. + /// + /// Regex pattern to use for splitting key-value pairs. + /// /// public KeyValueProcessorDescriptor FieldSplit(string fieldSplit) { @@ -565,7 +671,9 @@ public KeyValueProcessorDescriptor FieldSplit(string fieldSplit) } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public KeyValueProcessorDescriptor If(string? value) { @@ -574,7 +682,9 @@ public KeyValueProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public KeyValueProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -583,7 +693,9 @@ public KeyValueProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public KeyValueProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -592,7 +704,10 @@ public KeyValueProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// List of keys to filter and insert into document.
Defaults to including all keys. + /// + /// List of keys to filter and insert into document. + /// Defaults to including all keys. + /// /// public KeyValueProcessorDescriptor IncludeKeys(ICollection? includeKeys) { @@ -601,7 +716,9 @@ public KeyValueProcessorDescriptor IncludeKeys(ICollection? includeKeys) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public KeyValueProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -640,7 +757,9 @@ public KeyValueProcessorDescriptor OnFailure(params Action - /// Prefix to be added to extracted keys. + /// + /// Prefix to be added to extracted keys. + /// /// public KeyValueProcessorDescriptor Prefix(string? prefix) { @@ -649,7 +768,9 @@ public KeyValueProcessorDescriptor Prefix(string? prefix) } /// - /// If `true`. strip brackets `()`, `<>`, `[]` as well as quotes `'` and `"` from extracted values. + /// + /// If true. strip brackets (), <>, [] as well as quotes ' and " from extracted values. + /// /// public KeyValueProcessorDescriptor StripBrackets(bool? stripBrackets = true) { @@ -658,7 +779,10 @@ public KeyValueProcessorDescriptor StripBrackets(bool? stripBrackets = true) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public KeyValueProcessorDescriptor Tag(string? tag) { @@ -667,7 +791,11 @@ public KeyValueProcessorDescriptor Tag(string? tag) } /// - /// The field to insert the extracted keys into.
Defaults to the root of the document.
Supports template snippets. + /// + /// The field to insert the extracted keys into. + /// Defaults to the root of the document. + /// Supports template snippets. + /// /// public KeyValueProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -676,7 +804,11 @@ public KeyValueProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Ser } /// - /// The field to insert the extracted keys into.
Defaults to the root of the document.
Supports template snippets. + /// + /// The field to insert the extracted keys into. + /// Defaults to the root of the document. + /// Supports template snippets. + /// /// public KeyValueProcessorDescriptor TargetField(Expression> targetField) { @@ -685,7 +817,11 @@ public KeyValueProcessorDescriptor TargetField(Expression - /// The field to insert the extracted keys into.
Defaults to the root of the document.
Supports template snippets. + /// + /// The field to insert the extracted keys into. + /// Defaults to the root of the document. + /// Supports template snippets. + /// /// public KeyValueProcessorDescriptor TargetField(Expression> targetField) { @@ -694,7 +830,9 @@ public KeyValueProcessorDescriptor TargetField(Expression - /// String of characters to trim from extracted keys. + /// + /// String of characters to trim from extracted keys. + /// /// public KeyValueProcessorDescriptor TrimKey(string? trimKey) { @@ -703,7 +841,9 @@ public KeyValueProcessorDescriptor TrimKey(string? trimKey) } /// - /// String of characters to trim from extracted values. + /// + /// String of characters to trim from extracted values. + /// /// public KeyValueProcessorDescriptor TrimValue(string? trimValue) { @@ -712,7 +852,9 @@ public KeyValueProcessorDescriptor TrimValue(string? trimValue) } /// - /// Regex pattern to use for splitting the key from the value within a key-value pair. + /// + /// Regex pattern to use for splitting the key from the value within a key-value pair. + /// /// public KeyValueProcessorDescriptor ValueSplit(string valueSplit) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/LowercaseProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/LowercaseProcessor.g.cs index 3b7f2d1213f..c47b32d7f60 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/LowercaseProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/LowercaseProcessor.g.cs @@ -30,49 +30,68 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class LowercaseProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to make lowercase. + /// + /// The field to make lowercase. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? TargetField { get; set; } @@ -101,7 +120,10 @@ public LowercaseProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public LowercaseProcessorDescriptor Description(string? description) { @@ -110,7 +132,9 @@ public LowercaseProcessorDescriptor Description(string? description) } /// - /// The field to make lowercase. + /// + /// The field to make lowercase. + /// /// public LowercaseProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -119,7 +143,9 @@ public LowercaseProcessorDescriptor Field(Elastic.Clients.Elasticsear } /// - /// The field to make lowercase. + /// + /// The field to make lowercase. + /// /// public LowercaseProcessorDescriptor Field(Expression> field) { @@ -128,7 +154,9 @@ public LowercaseProcessorDescriptor Field(Expression - /// The field to make lowercase. + /// + /// The field to make lowercase. + /// /// public LowercaseProcessorDescriptor Field(Expression> field) { @@ -137,7 +165,9 @@ public LowercaseProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public LowercaseProcessorDescriptor If(string? value) { @@ -146,7 +176,9 @@ public LowercaseProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public LowercaseProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -155,7 +187,9 @@ public LowercaseProcessorDescriptor IgnoreFailure(bool? ignoreFailure } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public LowercaseProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -164,7 +198,9 @@ public LowercaseProcessorDescriptor IgnoreMissing(bool? ignoreMissing } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public LowercaseProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -203,7 +239,10 @@ public LowercaseProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public LowercaseProcessorDescriptor Tag(string? tag) { @@ -212,7 +251,10 @@ public LowercaseProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public LowercaseProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -221,7 +263,10 @@ public LowercaseProcessorDescriptor TargetField(Elastic.Clients.Elast } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public LowercaseProcessorDescriptor TargetField(Expression> targetField) { @@ -230,7 +275,10 @@ public LowercaseProcessorDescriptor TargetField(Expression - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public LowercaseProcessorDescriptor TargetField(Expression> targetField) { @@ -335,7 +383,10 @@ public LowercaseProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public LowercaseProcessorDescriptor Description(string? description) { @@ -344,7 +395,9 @@ public LowercaseProcessorDescriptor Description(string? description) } /// - /// The field to make lowercase. + /// + /// The field to make lowercase. + /// /// public LowercaseProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -353,7 +406,9 @@ public LowercaseProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverle } /// - /// The field to make lowercase. + /// + /// The field to make lowercase. + /// /// public LowercaseProcessorDescriptor Field(Expression> field) { @@ -362,7 +417,9 @@ public LowercaseProcessorDescriptor Field(Expression - /// The field to make lowercase. + /// + /// The field to make lowercase. + /// /// public LowercaseProcessorDescriptor Field(Expression> field) { @@ -371,7 +428,9 @@ public LowercaseProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public LowercaseProcessorDescriptor If(string? value) { @@ -380,7 +439,9 @@ public LowercaseProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public LowercaseProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -389,7 +450,9 @@ public LowercaseProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public LowercaseProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -398,7 +461,9 @@ public LowercaseProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public LowercaseProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -437,7 +502,10 @@ public LowercaseProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public LowercaseProcessorDescriptor Tag(string? tag) { @@ -446,7 +514,10 @@ public LowercaseProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public LowercaseProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -455,7 +526,10 @@ public LowercaseProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Se } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public LowercaseProcessorDescriptor TargetField(Expression> targetField) { @@ -464,7 +538,10 @@ public LowercaseProcessorDescriptor TargetField(Expression - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public LowercaseProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/Pipeline.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/Pipeline.g.cs index 326d3906286..617925202ea 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/Pipeline.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/Pipeline.g.cs @@ -30,31 +30,42 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class Pipeline { /// - /// Description of the ingest pipeline. + /// + /// Description of the ingest pipeline. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// Arbitrary metadata about the ingest pipeline. This map is not automatically generated by Elasticsearch. + /// + /// Arbitrary metadata about the ingest pipeline. This map is not automatically generated by Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("_meta")] public IDictionary? Meta { get; set; } /// - /// Processors to run immediately after a processor failure. + /// + /// Processors to run immediately after a processor failure. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Processors used to perform transformations on documents before indexing.
Processors run sequentially in the order specified. + /// + /// Processors used to perform transformations on documents before indexing. + /// Processors run sequentially in the order specified. + /// /// [JsonInclude, JsonPropertyName("processors")] public ICollection? Processors { get; set; } /// - /// Version number used by external systems to track ingest pipelines. + /// + /// Version number used by external systems to track ingest pipelines. + /// /// [JsonInclude, JsonPropertyName("version")] public long? Version { get; set; } @@ -81,7 +92,9 @@ public PipelineDescriptor() : base() private long? VersionValue { get; set; } /// - /// Description of the ingest pipeline. + /// + /// Description of the ingest pipeline. + /// /// public PipelineDescriptor Description(string? description) { @@ -90,7 +103,9 @@ public PipelineDescriptor Description(string? description) } /// - /// Arbitrary metadata about the ingest pipeline. This map is not automatically generated by Elasticsearch. + /// + /// Arbitrary metadata about the ingest pipeline. This map is not automatically generated by Elasticsearch. + /// /// public PipelineDescriptor Meta(Func, FluentDictionary> selector) { @@ -99,7 +114,9 @@ public PipelineDescriptor Meta(Func, } /// - /// Processors to run immediately after a processor failure. + /// + /// Processors to run immediately after a processor failure. + /// /// public PipelineDescriptor OnFailure(ICollection? onFailure) { @@ -138,7 +155,10 @@ public PipelineDescriptor OnFailure(params Action - /// Processors used to perform transformations on documents before indexing.
Processors run sequentially in the order specified. + /// + /// Processors used to perform transformations on documents before indexing. + /// Processors run sequentially in the order specified. + /// /// public PipelineDescriptor Processors(ICollection? processors) { @@ -177,7 +197,9 @@ public PipelineDescriptor Processors(params Action - /// Version number used by external systems to track ingest pipelines. + /// + /// Version number used by external systems to track ingest pipelines. + /// /// public PipelineDescriptor Version(long? version) { @@ -293,7 +315,9 @@ public PipelineDescriptor() : base() private long? VersionValue { get; set; } /// - /// Description of the ingest pipeline. + /// + /// Description of the ingest pipeline. + /// /// public PipelineDescriptor Description(string? description) { @@ -302,7 +326,9 @@ public PipelineDescriptor Description(string? description) } /// - /// Arbitrary metadata about the ingest pipeline. This map is not automatically generated by Elasticsearch. + /// + /// Arbitrary metadata about the ingest pipeline. This map is not automatically generated by Elasticsearch. + /// /// public PipelineDescriptor Meta(Func, FluentDictionary> selector) { @@ -311,7 +337,9 @@ public PipelineDescriptor Meta(Func, FluentDict } /// - /// Processors to run immediately after a processor failure. + /// + /// Processors to run immediately after a processor failure. + /// /// public PipelineDescriptor OnFailure(ICollection? onFailure) { @@ -350,7 +378,10 @@ public PipelineDescriptor OnFailure(params Action - /// Processors used to perform transformations on documents before indexing.
Processors run sequentially in the order specified. + /// + /// Processors used to perform transformations on documents before indexing. + /// Processors run sequentially in the order specified. + /// /// public PipelineDescriptor Processors(ICollection? processors) { @@ -389,7 +420,9 @@ public PipelineDescriptor Processors(params Action - /// Version number used by external systems to track ingest pipelines. + /// + /// Version number used by external systems to track ingest pipelines. + /// /// public PipelineDescriptor Version(long? version) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/PipelineProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/PipelineProcessor.g.cs index 0ea077575ce..057b1640722 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/PipelineProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/PipelineProcessor.g.cs @@ -30,43 +30,60 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class PipelineProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// Whether to ignore missing pipelines instead of failing. + /// + /// Whether to ignore missing pipelines instead of failing. + /// /// [JsonInclude, JsonPropertyName("ignore_missing_pipeline")] public bool? IgnoreMissingPipeline { get; set; } /// - /// The name of the pipeline to execute.
Supports template snippets. + /// + /// The name of the pipeline to execute. + /// Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("name")] public Elastic.Clients.Elasticsearch.Serverless.Name Name { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } @@ -94,7 +111,10 @@ public PipelineProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public PipelineProcessorDescriptor Description(string? description) { @@ -103,7 +123,9 @@ public PipelineProcessorDescriptor Description(string? description) } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public PipelineProcessorDescriptor If(string? value) { @@ -112,7 +134,9 @@ public PipelineProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public PipelineProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -121,7 +145,9 @@ public PipelineProcessorDescriptor IgnoreFailure(bool? ignoreFailure } /// - /// Whether to ignore missing pipelines instead of failing. + /// + /// Whether to ignore missing pipelines instead of failing. + /// /// public PipelineProcessorDescriptor IgnoreMissingPipeline(bool? ignoreMissingPipeline = true) { @@ -130,7 +156,10 @@ public PipelineProcessorDescriptor IgnoreMissingPipeline(bool? ignore } /// - /// The name of the pipeline to execute.
Supports template snippets. + /// + /// The name of the pipeline to execute. + /// Supports template snippets. + /// /// public PipelineProcessorDescriptor Name(Elastic.Clients.Elasticsearch.Serverless.Name name) { @@ -139,7 +168,9 @@ public PipelineProcessorDescriptor Name(Elastic.Clients.Elasticsearch } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public PipelineProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -178,7 +209,10 @@ public PipelineProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public PipelineProcessorDescriptor Tag(string? tag) { @@ -276,7 +310,10 @@ public PipelineProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public PipelineProcessorDescriptor Description(string? description) { @@ -285,7 +322,9 @@ public PipelineProcessorDescriptor Description(string? description) } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public PipelineProcessorDescriptor If(string? value) { @@ -294,7 +333,9 @@ public PipelineProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public PipelineProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -303,7 +344,9 @@ public PipelineProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// Whether to ignore missing pipelines instead of failing. + /// + /// Whether to ignore missing pipelines instead of failing. + /// /// public PipelineProcessorDescriptor IgnoreMissingPipeline(bool? ignoreMissingPipeline = true) { @@ -312,7 +355,10 @@ public PipelineProcessorDescriptor IgnoreMissingPipeline(bool? ignoreMissingPipe } /// - /// The name of the pipeline to execute.
Supports template snippets. + /// + /// The name of the pipeline to execute. + /// Supports template snippets. + /// /// public PipelineProcessorDescriptor Name(Elastic.Clients.Elasticsearch.Serverless.Name name) { @@ -321,7 +367,9 @@ public PipelineProcessorDescriptor Name(Elastic.Clients.Elasticsearch.Serverless } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public PipelineProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -360,7 +408,10 @@ public PipelineProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public PipelineProcessorDescriptor Tag(string? tag) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/RemoveProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/RemoveProcessor.g.cs index d81557b9b83..f6f877bc357 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/RemoveProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/RemoveProcessor.g.cs @@ -30,51 +30,69 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class RemoveProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// Fields to be removed. Supports template snippets. + /// + /// Fields to be removed. Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("field")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] public Elastic.Clients.Elasticsearch.Serverless.Fields Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Fields to be kept. When set, all fields other than those specified are removed. + /// + /// Fields to be kept. When set, all fields other than those specified are removed. + /// /// [JsonInclude, JsonPropertyName("keep")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] public Elastic.Clients.Elasticsearch.Serverless.Fields? Keep { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } @@ -103,7 +121,10 @@ public RemoveProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public RemoveProcessorDescriptor Description(string? description) { @@ -112,7 +133,9 @@ public RemoveProcessorDescriptor Description(string? description) } /// - /// Fields to be removed. Supports template snippets. + /// + /// Fields to be removed. Supports template snippets. + /// /// public RemoveProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Fields field) { @@ -121,7 +144,9 @@ public RemoveProcessorDescriptor Field(Elastic.Clients.Elasticsearch. } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public RemoveProcessorDescriptor If(string? value) { @@ -130,7 +155,9 @@ public RemoveProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public RemoveProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -139,7 +166,9 @@ public RemoveProcessorDescriptor IgnoreFailure(bool? ignoreFailure = } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public RemoveProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -148,7 +177,9 @@ public RemoveProcessorDescriptor IgnoreMissing(bool? ignoreMissing = } /// - /// Fields to be kept. When set, all fields other than those specified are removed. + /// + /// Fields to be kept. When set, all fields other than those specified are removed. + /// /// public RemoveProcessorDescriptor Keep(Elastic.Clients.Elasticsearch.Serverless.Fields? keep) { @@ -157,7 +188,9 @@ public RemoveProcessorDescriptor Keep(Elastic.Clients.Elasticsearch.S } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public RemoveProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -196,7 +229,10 @@ public RemoveProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public RemoveProcessorDescriptor Tag(string? tag) { @@ -301,7 +337,10 @@ public RemoveProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public RemoveProcessorDescriptor Description(string? description) { @@ -310,7 +349,9 @@ public RemoveProcessorDescriptor Description(string? description) } /// - /// Fields to be removed. Supports template snippets. + /// + /// Fields to be removed. Supports template snippets. + /// /// public RemoveProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Fields field) { @@ -319,7 +360,9 @@ public RemoveProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless. } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public RemoveProcessorDescriptor If(string? value) { @@ -328,7 +371,9 @@ public RemoveProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public RemoveProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -337,7 +382,9 @@ public RemoveProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public RemoveProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -346,7 +393,9 @@ public RemoveProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Fields to be kept. When set, all fields other than those specified are removed. + /// + /// Fields to be kept. When set, all fields other than those specified are removed. + /// /// public RemoveProcessorDescriptor Keep(Elastic.Clients.Elasticsearch.Serverless.Fields? keep) { @@ -355,7 +404,9 @@ public RemoveProcessorDescriptor Keep(Elastic.Clients.Elasticsearch.Serverless.F } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public RemoveProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -394,7 +445,10 @@ public RemoveProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public RemoveProcessorDescriptor Tag(string? tag) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/RenameProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/RenameProcessor.g.cs index 4148d79bf51..36c0ee328ab 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/RenameProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/RenameProcessor.g.cs @@ -30,49 +30,69 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class RenameProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to be renamed.
Supports template snippets. + /// + /// The field to be renamed. + /// Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The new name of the field.
Supports template snippets. + /// + /// The new name of the field. + /// Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Serverless.Field TargetField { get; set; } @@ -101,7 +121,10 @@ public RenameProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public RenameProcessorDescriptor Description(string? description) { @@ -110,7 +133,10 @@ public RenameProcessorDescriptor Description(string? description) } /// - /// The field to be renamed.
Supports template snippets. + /// + /// The field to be renamed. + /// Supports template snippets. + /// /// public RenameProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -119,7 +145,10 @@ public RenameProcessorDescriptor Field(Elastic.Clients.Elasticsearch. } /// - /// The field to be renamed.
Supports template snippets. + /// + /// The field to be renamed. + /// Supports template snippets. + /// /// public RenameProcessorDescriptor Field(Expression> field) { @@ -128,7 +157,10 @@ public RenameProcessorDescriptor Field(Expression - /// The field to be renamed.
Supports template snippets. + /// + /// The field to be renamed. + /// Supports template snippets. + /// /// public RenameProcessorDescriptor Field(Expression> field) { @@ -137,7 +169,9 @@ public RenameProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public RenameProcessorDescriptor If(string? value) { @@ -146,7 +180,9 @@ public RenameProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public RenameProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -155,7 +191,9 @@ public RenameProcessorDescriptor IgnoreFailure(bool? ignoreFailure = } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public RenameProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -164,7 +202,9 @@ public RenameProcessorDescriptor IgnoreMissing(bool? ignoreMissing = } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public RenameProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -203,7 +243,10 @@ public RenameProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public RenameProcessorDescriptor Tag(string? tag) { @@ -212,7 +255,10 @@ public RenameProcessorDescriptor Tag(string? tag) } /// - /// The new name of the field.
Supports template snippets. + /// + /// The new name of the field. + /// Supports template snippets. + /// /// public RenameProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field targetField) { @@ -221,7 +267,10 @@ public RenameProcessorDescriptor TargetField(Elastic.Clients.Elastics } /// - /// The new name of the field.
Supports template snippets. + /// + /// The new name of the field. + /// Supports template snippets. + /// /// public RenameProcessorDescriptor TargetField(Expression> targetField) { @@ -230,7 +279,10 @@ public RenameProcessorDescriptor TargetField(Expression - /// The new name of the field.
Supports template snippets. + /// + /// The new name of the field. + /// Supports template snippets. + /// /// public RenameProcessorDescriptor TargetField(Expression> targetField) { @@ -331,7 +383,10 @@ public RenameProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public RenameProcessorDescriptor Description(string? description) { @@ -340,7 +395,10 @@ public RenameProcessorDescriptor Description(string? description) } /// - /// The field to be renamed.
Supports template snippets. + /// + /// The field to be renamed. + /// Supports template snippets. + /// /// public RenameProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -349,7 +407,10 @@ public RenameProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless. } /// - /// The field to be renamed.
Supports template snippets. + /// + /// The field to be renamed. + /// Supports template snippets. + /// /// public RenameProcessorDescriptor Field(Expression> field) { @@ -358,7 +419,10 @@ public RenameProcessorDescriptor Field(Expression - /// The field to be renamed.
Supports template snippets. + /// + /// The field to be renamed. + /// Supports template snippets. + /// /// public RenameProcessorDescriptor Field(Expression> field) { @@ -367,7 +431,9 @@ public RenameProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public RenameProcessorDescriptor If(string? value) { @@ -376,7 +442,9 @@ public RenameProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public RenameProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -385,7 +453,9 @@ public RenameProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public RenameProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -394,7 +464,9 @@ public RenameProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public RenameProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -433,7 +505,10 @@ public RenameProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public RenameProcessorDescriptor Tag(string? tag) { @@ -442,7 +517,10 @@ public RenameProcessorDescriptor Tag(string? tag) } /// - /// The new name of the field.
Supports template snippets. + /// + /// The new name of the field. + /// Supports template snippets. + /// /// public RenameProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field targetField) { @@ -451,7 +529,10 @@ public RenameProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serve } /// - /// The new name of the field.
Supports template snippets. + /// + /// The new name of the field. + /// Supports template snippets. + /// /// public RenameProcessorDescriptor TargetField(Expression> targetField) { @@ -460,7 +541,10 @@ public RenameProcessorDescriptor TargetField(Expression - /// The new name of the field.
Supports template snippets. + /// + /// The new name of the field. + /// Supports template snippets. + /// /// public RenameProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/RerouteProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/RerouteProcessor.g.cs index 3f07547797b..1e865f6735a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/RerouteProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/RerouteProcessor.g.cs @@ -30,55 +30,88 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class RerouteProcessor { /// - /// Field references or a static value for the dataset part of the data stream name.
In addition to the criteria for index names, cannot contain - and must be no longer than 100 characters.
Example values are nginx.access and nginx.error. - /// Supports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces).
When resolving field references, the processor replaces invalid characters with _. Uses the part
of the index name as a fallback if all field references resolve to a null, missing, or non-string value. - /// default {{data_stream.dataset}} + /// + /// Field references or a static value for the dataset part of the data stream name. + /// In addition to the criteria for index names, cannot contain - and must be no longer than 100 characters. + /// Example values are nginx.access and nginx.error. + /// + /// + /// Supports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces). + /// When resolving field references, the processor replaces invalid characters with _. Uses the <dataset> part + /// of the index name as a fallback if all field references resolve to a null, missing, or non-string value. + /// + /// + /// default {{data_stream.dataset}} + /// /// [JsonInclude, JsonPropertyName("dataset")] [SingleOrManyCollectionConverter(typeof(string))] public ICollection? Dataset { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// A static value for the target. Can’t be set when the dataset or namespace option is set. + /// + /// A static value for the target. Can’t be set when the dataset or namespace option is set. + /// /// [JsonInclude, JsonPropertyName("destination")] public string? Destination { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// Field references or a static value for the namespace part of the data stream name. See the criteria for
index names for allowed characters. Must be no longer than 100 characters. - /// Supports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces).
When resolving field references, the processor replaces invalid characters with _. Uses the part
of the index name as a fallback if all field references resolve to a null, missing, or non-string value. - /// default {{data_stream.namespace}} + /// + /// Field references or a static value for the namespace part of the data stream name. See the criteria for + /// index names for allowed characters. Must be no longer than 100 characters. + /// + /// + /// Supports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces). + /// When resolving field references, the processor replaces invalid characters with _. Uses the <namespace> part + /// of the index name as a fallback if all field references resolve to a null, missing, or non-string value. + /// + /// + /// default {{data_stream.namespace}} + /// /// [JsonInclude, JsonPropertyName("namespace")] [SingleOrManyCollectionConverter(typeof(string))] public ICollection? Namespace { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } @@ -107,9 +140,19 @@ public RerouteProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Field references or a static value for the dataset part of the data stream name.
In addition to the criteria for index names, cannot contain - and must be no longer than 100 characters.
Example values are nginx.access and nginx.error. - /// Supports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces).
When resolving field references, the processor replaces invalid characters with _. Uses the part
of the index name as a fallback if all field references resolve to a null, missing, or non-string value. - /// default {{data_stream.dataset}} + /// + /// Field references or a static value for the dataset part of the data stream name. + /// In addition to the criteria for index names, cannot contain - and must be no longer than 100 characters. + /// Example values are nginx.access and nginx.error. + /// + /// + /// Supports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces). + /// When resolving field references, the processor replaces invalid characters with _. Uses the <dataset> part + /// of the index name as a fallback if all field references resolve to a null, missing, or non-string value. + /// + /// + /// default {{data_stream.dataset}} + /// /// public RerouteProcessorDescriptor Dataset(ICollection? dataset) { @@ -118,7 +161,10 @@ public RerouteProcessorDescriptor Dataset(ICollection? datase } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public RerouteProcessorDescriptor Description(string? description) { @@ -127,7 +173,9 @@ public RerouteProcessorDescriptor Description(string? description) } /// - /// A static value for the target. Can’t be set when the dataset or namespace option is set. + /// + /// A static value for the target. Can’t be set when the dataset or namespace option is set. + /// /// public RerouteProcessorDescriptor Destination(string? destination) { @@ -136,7 +184,9 @@ public RerouteProcessorDescriptor Destination(string? destination) } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public RerouteProcessorDescriptor If(string? value) { @@ -145,7 +195,9 @@ public RerouteProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public RerouteProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -154,9 +206,18 @@ public RerouteProcessorDescriptor IgnoreFailure(bool? ignoreFailure = } /// - /// Field references or a static value for the namespace part of the data stream name. See the criteria for
index names for allowed characters. Must be no longer than 100 characters. - /// Supports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces).
When resolving field references, the processor replaces invalid characters with _. Uses the part
of the index name as a fallback if all field references resolve to a null, missing, or non-string value. - /// default {{data_stream.namespace}} + /// + /// Field references or a static value for the namespace part of the data stream name. See the criteria for + /// index names for allowed characters. Must be no longer than 100 characters. + /// + /// + /// Supports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces). + /// When resolving field references, the processor replaces invalid characters with _. Uses the <namespace> part + /// of the index name as a fallback if all field references resolve to a null, missing, or non-string value. + /// + /// + /// default {{data_stream.namespace}} + /// /// public RerouteProcessorDescriptor Namespace(ICollection? value) { @@ -165,7 +226,9 @@ public RerouteProcessorDescriptor Namespace(ICollection? valu } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public RerouteProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -204,7 +267,10 @@ public RerouteProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public RerouteProcessorDescriptor Tag(string? tag) { @@ -313,9 +379,19 @@ public RerouteProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Field references or a static value for the dataset part of the data stream name.
In addition to the criteria for index names, cannot contain - and must be no longer than 100 characters.
Example values are nginx.access and nginx.error. - /// Supports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces).
When resolving field references, the processor replaces invalid characters with _. Uses the part
of the index name as a fallback if all field references resolve to a null, missing, or non-string value. - /// default {{data_stream.dataset}} + /// + /// Field references or a static value for the dataset part of the data stream name. + /// In addition to the criteria for index names, cannot contain - and must be no longer than 100 characters. + /// Example values are nginx.access and nginx.error. + /// + /// + /// Supports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces). + /// When resolving field references, the processor replaces invalid characters with _. Uses the <dataset> part + /// of the index name as a fallback if all field references resolve to a null, missing, or non-string value. + /// + /// + /// default {{data_stream.dataset}} + /// /// public RerouteProcessorDescriptor Dataset(ICollection? dataset) { @@ -324,7 +400,10 @@ public RerouteProcessorDescriptor Dataset(ICollection? dataset) } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public RerouteProcessorDescriptor Description(string? description) { @@ -333,7 +412,9 @@ public RerouteProcessorDescriptor Description(string? description) } /// - /// A static value for the target. Can’t be set when the dataset or namespace option is set. + /// + /// A static value for the target. Can’t be set when the dataset or namespace option is set. + /// /// public RerouteProcessorDescriptor Destination(string? destination) { @@ -342,7 +423,9 @@ public RerouteProcessorDescriptor Destination(string? destination) } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public RerouteProcessorDescriptor If(string? value) { @@ -351,7 +434,9 @@ public RerouteProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public RerouteProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -360,9 +445,18 @@ public RerouteProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// Field references or a static value for the namespace part of the data stream name. See the criteria for
index names for allowed characters. Must be no longer than 100 characters. - /// Supports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces).
When resolving field references, the processor replaces invalid characters with _. Uses the part
of the index name as a fallback if all field references resolve to a null, missing, or non-string value. - /// default {{data_stream.namespace}} + /// + /// Field references or a static value for the namespace part of the data stream name. See the criteria for + /// index names for allowed characters. Must be no longer than 100 characters. + /// + /// + /// Supports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces). + /// When resolving field references, the processor replaces invalid characters with _. Uses the <namespace> part + /// of the index name as a fallback if all field references resolve to a null, missing, or non-string value. + /// + /// + /// default {{data_stream.namespace}} + /// /// public RerouteProcessorDescriptor Namespace(ICollection? value) { @@ -371,7 +465,9 @@ public RerouteProcessorDescriptor Namespace(ICollection? value) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public RerouteProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -410,7 +506,10 @@ public RerouteProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public RerouteProcessorDescriptor Tag(string? tag) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/ScriptProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/ScriptProcessor.g.cs index cd9555f862f..a3cb8bc52ac 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/ScriptProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/ScriptProcessor.g.cs @@ -30,55 +30,77 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class ScriptProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// ID of a stored script.
If no `source` is specified, this parameter is required. + /// + /// ID of a stored script. + /// If no source is specified, this parameter is required. + /// /// [JsonInclude, JsonPropertyName("id")] public Elastic.Clients.Elasticsearch.Serverless.Id? Id { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// Script language. + /// + /// Script language. + /// /// [JsonInclude, JsonPropertyName("lang")] public string? Lang { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Object containing parameters for the script. + /// + /// Object containing parameters for the script. + /// /// [JsonInclude, JsonPropertyName("params")] public IDictionary? Params { get; set; } /// - /// Inline script.
If no `id` is specified, this parameter is required. + /// + /// Inline script. + /// If no id is specified, this parameter is required. + /// /// [JsonInclude, JsonPropertyName("source")] public string? Source { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } @@ -108,7 +130,10 @@ public ScriptProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public ScriptProcessorDescriptor Description(string? description) { @@ -117,7 +142,10 @@ public ScriptProcessorDescriptor Description(string? description) } /// - /// ID of a stored script.
If no `source` is specified, this parameter is required. + /// + /// ID of a stored script. + /// If no source is specified, this parameter is required. + /// /// public ScriptProcessorDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id? id) { @@ -126,7 +154,9 @@ public ScriptProcessorDescriptor Id(Elastic.Clients.Elasticsearch.Ser } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public ScriptProcessorDescriptor If(string? value) { @@ -135,7 +165,9 @@ public ScriptProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public ScriptProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -144,7 +176,9 @@ public ScriptProcessorDescriptor IgnoreFailure(bool? ignoreFailure = } /// - /// Script language. + /// + /// Script language. + /// /// public ScriptProcessorDescriptor Lang(string? lang) { @@ -153,7 +187,9 @@ public ScriptProcessorDescriptor Lang(string? lang) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public ScriptProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -192,7 +228,9 @@ public ScriptProcessorDescriptor OnFailure(params Action - /// Object containing parameters for the script. + /// + /// Object containing parameters for the script. + /// /// public ScriptProcessorDescriptor Params(Func, FluentDictionary> selector) { @@ -201,7 +239,10 @@ public ScriptProcessorDescriptor Params(Func - /// Inline script.
If no `id` is specified, this parameter is required. + /// + /// Inline script. + /// If no id is specified, this parameter is required. + /// /// public ScriptProcessorDescriptor Source(string? source) { @@ -210,7 +251,10 @@ public ScriptProcessorDescriptor Source(string? source) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public ScriptProcessorDescriptor Tag(string? tag) { @@ -326,7 +370,10 @@ public ScriptProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public ScriptProcessorDescriptor Description(string? description) { @@ -335,7 +382,10 @@ public ScriptProcessorDescriptor Description(string? description) } /// - /// ID of a stored script.
If no `source` is specified, this parameter is required. + /// + /// ID of a stored script. + /// If no source is specified, this parameter is required. + /// /// public ScriptProcessorDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id? id) { @@ -344,7 +394,9 @@ public ScriptProcessorDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id? } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public ScriptProcessorDescriptor If(string? value) { @@ -353,7 +405,9 @@ public ScriptProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public ScriptProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -362,7 +416,9 @@ public ScriptProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// Script language. + /// + /// Script language. + /// /// public ScriptProcessorDescriptor Lang(string? lang) { @@ -371,7 +427,9 @@ public ScriptProcessorDescriptor Lang(string? lang) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public ScriptProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -410,7 +468,9 @@ public ScriptProcessorDescriptor OnFailure(params Action - /// Object containing parameters for the script. + /// + /// Object containing parameters for the script. + /// /// public ScriptProcessorDescriptor Params(Func, FluentDictionary> selector) { @@ -419,7 +479,10 @@ public ScriptProcessorDescriptor Params(Func, F } /// - /// Inline script.
If no `id` is specified, this parameter is required. + /// + /// Inline script. + /// If no id is specified, this parameter is required. + /// /// public ScriptProcessorDescriptor Source(string? source) { @@ -428,7 +491,10 @@ public ScriptProcessorDescriptor Source(string? source) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public ScriptProcessorDescriptor Tag(string? tag) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/SetProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/SetProcessor.g.cs index 8fe899465b8..c48440c59f2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/SetProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/SetProcessor.g.cs @@ -30,67 +30,98 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class SetProcessor { /// - /// The origin field which will be copied to `field`, cannot set `value` simultaneously.
Supported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc. + /// + /// The origin field which will be copied to field, cannot set value simultaneously. + /// Supported data types are boolean, number, array, object, string, date, etc. + /// /// [JsonInclude, JsonPropertyName("copy_from")] public Elastic.Clients.Elasticsearch.Serverless.Field? CopyFrom { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to insert, upsert, or update.
Supports template snippets. + /// + /// The field to insert, upsert, or update. + /// Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// If `true` and `value` is a template snippet that evaluates to `null` or the empty string, the processor quietly exits without modifying the document. + /// + /// If true and value is a template snippet that evaluates to null or the empty string, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_empty_value")] public bool? IgnoreEmptyValue { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// The media type for encoding `value`.
Applies only when value is a template snippet.
Must be one of `application/json`, `text/plain`, or `application/x-www-form-urlencoded`. + /// + /// The media type for encoding value. + /// Applies only when value is a template snippet. + /// Must be one of application/json, text/plain, or application/x-www-form-urlencoded. + /// /// [JsonInclude, JsonPropertyName("media_type")] public string? MediaType { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// If `true` processor will update fields with pre-existing non-null-valued field.
When set to `false`, such fields will not be touched. + /// + /// If true processor will update fields with pre-existing non-null-valued field. + /// When set to false, such fields will not be touched. + /// /// [JsonInclude, JsonPropertyName("override")] public bool? Override { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The value to be set for the field.
Supports template snippets.
May specify only one of `value` or `copy_from`. + /// + /// The value to be set for the field. + /// Supports template snippets. + /// May specify only one of value or copy_from. + /// /// [JsonInclude, JsonPropertyName("value")] public object? Value { get; set; } @@ -122,7 +153,10 @@ public SetProcessorDescriptor() : base() private object? ValueValue { get; set; } /// - /// The origin field which will be copied to `field`, cannot set `value` simultaneously.
Supported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc. + /// + /// The origin field which will be copied to field, cannot set value simultaneously. + /// Supported data types are boolean, number, array, object, string, date, etc. + /// /// public SetProcessorDescriptor CopyFrom(Elastic.Clients.Elasticsearch.Serverless.Field? copyFrom) { @@ -131,7 +165,10 @@ public SetProcessorDescriptor CopyFrom(Elastic.Clients.Elasticsearch. } /// - /// The origin field which will be copied to `field`, cannot set `value` simultaneously.
Supported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc. + /// + /// The origin field which will be copied to field, cannot set value simultaneously. + /// Supported data types are boolean, number, array, object, string, date, etc. + /// /// public SetProcessorDescriptor CopyFrom(Expression> copyFrom) { @@ -140,7 +177,10 @@ public SetProcessorDescriptor CopyFrom(Expression - /// The origin field which will be copied to `field`, cannot set `value` simultaneously.
Supported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc. + /// + /// The origin field which will be copied to field, cannot set value simultaneously. + /// Supported data types are boolean, number, array, object, string, date, etc. + /// /// public SetProcessorDescriptor CopyFrom(Expression> copyFrom) { @@ -149,7 +189,10 @@ public SetProcessorDescriptor CopyFrom(Expression - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public SetProcessorDescriptor Description(string? description) { @@ -158,7 +201,10 @@ public SetProcessorDescriptor Description(string? description) } /// - /// The field to insert, upsert, or update.
Supports template snippets. + /// + /// The field to insert, upsert, or update. + /// Supports template snippets. + /// /// public SetProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -167,7 +213,10 @@ public SetProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Ser } /// - /// The field to insert, upsert, or update.
Supports template snippets. + /// + /// The field to insert, upsert, or update. + /// Supports template snippets. + /// /// public SetProcessorDescriptor Field(Expression> field) { @@ -176,7 +225,10 @@ public SetProcessorDescriptor Field(Expression - /// The field to insert, upsert, or update.
Supports template snippets. + /// + /// The field to insert, upsert, or update. + /// Supports template snippets. + /// /// public SetProcessorDescriptor Field(Expression> field) { @@ -185,7 +237,9 @@ public SetProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public SetProcessorDescriptor If(string? value) { @@ -194,7 +248,9 @@ public SetProcessorDescriptor If(string? value) } /// - /// If `true` and `value` is a template snippet that evaluates to `null` or the empty string, the processor quietly exits without modifying the document. + /// + /// If true and value is a template snippet that evaluates to null or the empty string, the processor quietly exits without modifying the document. + /// /// public SetProcessorDescriptor IgnoreEmptyValue(bool? ignoreEmptyValue = true) { @@ -203,7 +259,9 @@ public SetProcessorDescriptor IgnoreEmptyValue(bool? ignoreEmptyValue } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public SetProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -212,7 +270,11 @@ public SetProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tru } /// - /// The media type for encoding `value`.
Applies only when value is a template snippet.
Must be one of `application/json`, `text/plain`, or `application/x-www-form-urlencoded`. + /// + /// The media type for encoding value. + /// Applies only when value is a template snippet. + /// Must be one of application/json, text/plain, or application/x-www-form-urlencoded. + /// /// public SetProcessorDescriptor MediaType(string? mediaType) { @@ -221,7 +283,9 @@ public SetProcessorDescriptor MediaType(string? mediaType) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public SetProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -260,7 +324,10 @@ public SetProcessorDescriptor OnFailure(params Action - /// If `true` processor will update fields with pre-existing non-null-valued field.
When set to `false`, such fields will not be touched. + /// + /// If true processor will update fields with pre-existing non-null-valued field. + /// When set to false, such fields will not be touched. + /// /// public SetProcessorDescriptor Override(bool? value = true) { @@ -269,7 +336,10 @@ public SetProcessorDescriptor Override(bool? value = true) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public SetProcessorDescriptor Tag(string? tag) { @@ -278,7 +348,11 @@ public SetProcessorDescriptor Tag(string? tag) } /// - /// The value to be set for the field.
Supports template snippets.
May specify only one of `value` or `copy_from`. + /// + /// The value to be set for the field. + /// Supports template snippets. + /// May specify only one of value or copy_from. + /// /// public SetProcessorDescriptor Value(object? value) { @@ -404,7 +478,10 @@ public SetProcessorDescriptor() : base() private object? ValueValue { get; set; } /// - /// The origin field which will be copied to `field`, cannot set `value` simultaneously.
Supported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc. + /// + /// The origin field which will be copied to field, cannot set value simultaneously. + /// Supported data types are boolean, number, array, object, string, date, etc. + /// /// public SetProcessorDescriptor CopyFrom(Elastic.Clients.Elasticsearch.Serverless.Field? copyFrom) { @@ -413,7 +490,10 @@ public SetProcessorDescriptor CopyFrom(Elastic.Clients.Elasticsearch.Serverless. } /// - /// The origin field which will be copied to `field`, cannot set `value` simultaneously.
Supported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc. + /// + /// The origin field which will be copied to field, cannot set value simultaneously. + /// Supported data types are boolean, number, array, object, string, date, etc. + /// /// public SetProcessorDescriptor CopyFrom(Expression> copyFrom) { @@ -422,7 +502,10 @@ public SetProcessorDescriptor CopyFrom(Expression - /// The origin field which will be copied to `field`, cannot set `value` simultaneously.
Supported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc. + /// + /// The origin field which will be copied to field, cannot set value simultaneously. + /// Supported data types are boolean, number, array, object, string, date, etc. + /// /// public SetProcessorDescriptor CopyFrom(Expression> copyFrom) { @@ -431,7 +514,10 @@ public SetProcessorDescriptor CopyFrom(Expression - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public SetProcessorDescriptor Description(string? description) { @@ -440,7 +526,10 @@ public SetProcessorDescriptor Description(string? description) } /// - /// The field to insert, upsert, or update.
Supports template snippets. + /// + /// The field to insert, upsert, or update. + /// Supports template snippets. + /// /// public SetProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -449,7 +538,10 @@ public SetProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Fie } /// - /// The field to insert, upsert, or update.
Supports template snippets. + /// + /// The field to insert, upsert, or update. + /// Supports template snippets. + /// /// public SetProcessorDescriptor Field(Expression> field) { @@ -458,7 +550,10 @@ public SetProcessorDescriptor Field(Expression - /// The field to insert, upsert, or update.
Supports template snippets. + /// + /// The field to insert, upsert, or update. + /// Supports template snippets. + /// /// public SetProcessorDescriptor Field(Expression> field) { @@ -467,7 +562,9 @@ public SetProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public SetProcessorDescriptor If(string? value) { @@ -476,7 +573,9 @@ public SetProcessorDescriptor If(string? value) } /// - /// If `true` and `value` is a template snippet that evaluates to `null` or the empty string, the processor quietly exits without modifying the document. + /// + /// If true and value is a template snippet that evaluates to null or the empty string, the processor quietly exits without modifying the document. + /// /// public SetProcessorDescriptor IgnoreEmptyValue(bool? ignoreEmptyValue = true) { @@ -485,7 +584,9 @@ public SetProcessorDescriptor IgnoreEmptyValue(bool? ignoreEmptyValue = true) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public SetProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -494,7 +595,11 @@ public SetProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// The media type for encoding `value`.
Applies only when value is a template snippet.
Must be one of `application/json`, `text/plain`, or `application/x-www-form-urlencoded`. + /// + /// The media type for encoding value. + /// Applies only when value is a template snippet. + /// Must be one of application/json, text/plain, or application/x-www-form-urlencoded. + /// /// public SetProcessorDescriptor MediaType(string? mediaType) { @@ -503,7 +608,9 @@ public SetProcessorDescriptor MediaType(string? mediaType) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public SetProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -542,7 +649,10 @@ public SetProcessorDescriptor OnFailure(params Action - /// If `true` processor will update fields with pre-existing non-null-valued field.
When set to `false`, such fields will not be touched. + /// + /// If true processor will update fields with pre-existing non-null-valued field. + /// When set to false, such fields will not be touched. + /// /// public SetProcessorDescriptor Override(bool? value = true) { @@ -551,7 +661,10 @@ public SetProcessorDescriptor Override(bool? value = true) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public SetProcessorDescriptor Tag(string? tag) { @@ -560,7 +673,11 @@ public SetProcessorDescriptor Tag(string? tag) } /// - /// The value to be set for the field.
Supports template snippets.
May specify only one of `value` or `copy_from`. + /// + /// The value to be set for the field. + /// Supports template snippets. + /// May specify only one of value or copy_from. + /// /// public SetProcessorDescriptor Value(object? value) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/SetSecurityUserProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/SetSecurityUserProcessor.g.cs index 9c74c40a62b..d4c853f4013 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/SetSecurityUserProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/SetSecurityUserProcessor.g.cs @@ -30,43 +30,59 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class SetSecurityUserProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to store the user information into. + /// + /// The field to store the user information into. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Controls what user related properties are added to the field. + /// + /// Controls what user related properties are added to the field. + /// /// [JsonInclude, JsonPropertyName("properties")] public ICollection? Properties { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } @@ -94,7 +110,10 @@ public SetSecurityUserProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public SetSecurityUserProcessorDescriptor Description(string? description) { @@ -103,7 +122,9 @@ public SetSecurityUserProcessorDescriptor Description(string? descrip } /// - /// The field to store the user information into. + /// + /// The field to store the user information into. + /// /// public SetSecurityUserProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -112,7 +133,9 @@ public SetSecurityUserProcessorDescriptor Field(Elastic.Clients.Elast } /// - /// The field to store the user information into. + /// + /// The field to store the user information into. + /// /// public SetSecurityUserProcessorDescriptor Field(Expression> field) { @@ -121,7 +144,9 @@ public SetSecurityUserProcessorDescriptor Field(Expression - /// The field to store the user information into. + /// + /// The field to store the user information into. + /// /// public SetSecurityUserProcessorDescriptor Field(Expression> field) { @@ -130,7 +155,9 @@ public SetSecurityUserProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public SetSecurityUserProcessorDescriptor If(string? value) { @@ -139,7 +166,9 @@ public SetSecurityUserProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public SetSecurityUserProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -148,7 +177,9 @@ public SetSecurityUserProcessorDescriptor IgnoreFailure(bool? ignoreF } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public SetSecurityUserProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -187,7 +218,9 @@ public SetSecurityUserProcessorDescriptor OnFailure(params Action - /// Controls what user related properties are added to the field. + /// + /// Controls what user related properties are added to the field. + /// /// public SetSecurityUserProcessorDescriptor Properties(ICollection? properties) { @@ -196,7 +229,10 @@ public SetSecurityUserProcessorDescriptor Properties(ICollection - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public SetSecurityUserProcessorDescriptor Tag(string? tag) { @@ -294,7 +330,10 @@ public SetSecurityUserProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public SetSecurityUserProcessorDescriptor Description(string? description) { @@ -303,7 +342,9 @@ public SetSecurityUserProcessorDescriptor Description(string? description) } /// - /// The field to store the user information into. + /// + /// The field to store the user information into. + /// /// public SetSecurityUserProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -312,7 +353,9 @@ public SetSecurityUserProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Se } /// - /// The field to store the user information into. + /// + /// The field to store the user information into. + /// /// public SetSecurityUserProcessorDescriptor Field(Expression> field) { @@ -321,7 +364,9 @@ public SetSecurityUserProcessorDescriptor Field(Expression - /// The field to store the user information into. + /// + /// The field to store the user information into. + /// /// public SetSecurityUserProcessorDescriptor Field(Expression> field) { @@ -330,7 +375,9 @@ public SetSecurityUserProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public SetSecurityUserProcessorDescriptor If(string? value) { @@ -339,7 +386,9 @@ public SetSecurityUserProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public SetSecurityUserProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -348,7 +397,9 @@ public SetSecurityUserProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tr } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public SetSecurityUserProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -387,7 +438,9 @@ public SetSecurityUserProcessorDescriptor OnFailure(params Action - /// Controls what user related properties are added to the field. + /// + /// Controls what user related properties are added to the field. + /// /// public SetSecurityUserProcessorDescriptor Properties(ICollection? properties) { @@ -396,7 +449,10 @@ public SetSecurityUserProcessorDescriptor Properties(ICollection? proper } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public SetSecurityUserProcessorDescriptor Tag(string? tag) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/SortProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/SortProcessor.g.cs index 5d9f34927eb..5967180b7ef 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/SortProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/SortProcessor.g.cs @@ -30,49 +30,69 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class SortProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to be sorted. + /// + /// The field to be sorted. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// The sort order to use.
Accepts `"asc"` or `"desc"`. + /// + /// The sort order to use. + /// Accepts "asc" or "desc". + /// /// [JsonInclude, JsonPropertyName("order")] public Elastic.Clients.Elasticsearch.Serverless.SortOrder? Order { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field to assign the sorted value to.
By default, the field is updated in-place. + /// + /// The field to assign the sorted value to. + /// By default, the field is updated in-place. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? TargetField { get; set; } @@ -101,7 +121,10 @@ public SortProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public SortProcessorDescriptor Description(string? description) { @@ -110,7 +133,9 @@ public SortProcessorDescriptor Description(string? description) } /// - /// The field to be sorted. + /// + /// The field to be sorted. + /// /// public SortProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -119,7 +144,9 @@ public SortProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Se } /// - /// The field to be sorted. + /// + /// The field to be sorted. + /// /// public SortProcessorDescriptor Field(Expression> field) { @@ -128,7 +155,9 @@ public SortProcessorDescriptor Field(Expression - /// The field to be sorted. + /// + /// The field to be sorted. + /// /// public SortProcessorDescriptor Field(Expression> field) { @@ -137,7 +166,9 @@ public SortProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public SortProcessorDescriptor If(string? value) { @@ -146,7 +177,9 @@ public SortProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public SortProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -155,7 +188,9 @@ public SortProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tr } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public SortProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -194,7 +229,10 @@ public SortProcessorDescriptor OnFailure(params Action - /// The sort order to use.
Accepts `"asc"` or `"desc"`. + /// + /// The sort order to use. + /// Accepts "asc" or "desc". + /// /// public SortProcessorDescriptor Order(Elastic.Clients.Elasticsearch.Serverless.SortOrder? order) { @@ -203,7 +241,10 @@ public SortProcessorDescriptor Order(Elastic.Clients.Elasticsearch.Se } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public SortProcessorDescriptor Tag(string? tag) { @@ -212,7 +253,10 @@ public SortProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the sorted value to.
By default, the field is updated in-place. + /// + /// The field to assign the sorted value to. + /// By default, the field is updated in-place. + /// /// public SortProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -221,7 +265,10 @@ public SortProcessorDescriptor TargetField(Elastic.Clients.Elasticsea } /// - /// The field to assign the sorted value to.
By default, the field is updated in-place. + /// + /// The field to assign the sorted value to. + /// By default, the field is updated in-place. + /// /// public SortProcessorDescriptor TargetField(Expression> targetField) { @@ -230,7 +277,10 @@ public SortProcessorDescriptor TargetField(Expression - /// The field to assign the sorted value to.
By default, the field is updated in-place. + /// + /// The field to assign the sorted value to. + /// By default, the field is updated in-place. + /// /// public SortProcessorDescriptor TargetField(Expression> targetField) { @@ -335,7 +385,10 @@ public SortProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public SortProcessorDescriptor Description(string? description) { @@ -344,7 +397,9 @@ public SortProcessorDescriptor Description(string? description) } /// - /// The field to be sorted. + /// + /// The field to be sorted. + /// /// public SortProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -353,7 +408,9 @@ public SortProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Fi } /// - /// The field to be sorted. + /// + /// The field to be sorted. + /// /// public SortProcessorDescriptor Field(Expression> field) { @@ -362,7 +419,9 @@ public SortProcessorDescriptor Field(Expression - /// The field to be sorted. + /// + /// The field to be sorted. + /// /// public SortProcessorDescriptor Field(Expression> field) { @@ -371,7 +430,9 @@ public SortProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public SortProcessorDescriptor If(string? value) { @@ -380,7 +441,9 @@ public SortProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public SortProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -389,7 +452,9 @@ public SortProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public SortProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -428,7 +493,10 @@ public SortProcessorDescriptor OnFailure(params Action - /// The sort order to use.
Accepts `"asc"` or `"desc"`. + /// + /// The sort order to use. + /// Accepts "asc" or "desc". + /// /// public SortProcessorDescriptor Order(Elastic.Clients.Elasticsearch.Serverless.SortOrder? order) { @@ -437,7 +505,10 @@ public SortProcessorDescriptor Order(Elastic.Clients.Elasticsearch.Serverless.So } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public SortProcessorDescriptor Tag(string? tag) { @@ -446,7 +517,10 @@ public SortProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the sorted value to.
By default, the field is updated in-place. + /// + /// The field to assign the sorted value to. + /// By default, the field is updated in-place. + /// /// public SortProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -455,7 +529,10 @@ public SortProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverl } /// - /// The field to assign the sorted value to.
By default, the field is updated in-place. + /// + /// The field to assign the sorted value to. + /// By default, the field is updated in-place. + /// /// public SortProcessorDescriptor TargetField(Expression> targetField) { @@ -464,7 +541,10 @@ public SortProcessorDescriptor TargetField(Expression - /// The field to assign the sorted value to.
By default, the field is updated in-place. + /// + /// The field to assign the sorted value to. + /// By default, the field is updated in-place. + /// /// public SortProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/SplitProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/SplitProcessor.g.cs index 9591968e1c1..37004038f5e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/SplitProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/SplitProcessor.g.cs @@ -30,61 +30,84 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class SplitProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to split. + /// + /// The field to split. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Preserves empty trailing fields, if any. + /// + /// Preserves empty trailing fields, if any. + /// /// [JsonInclude, JsonPropertyName("preserve_trailing")] public bool? PreserveTrailing { get; set; } /// - /// A regex which matches the separator, for example, `,` or `\s+`. + /// + /// A regex which matches the separator, for example, , or \s+. + /// /// [JsonInclude, JsonPropertyName("separator")] public string Separator { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field to assign the split value to.
By default, the field is updated in-place. + /// + /// The field to assign the split value to. + /// By default, the field is updated in-place. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? TargetField { get; set; } @@ -115,7 +138,10 @@ public SplitProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public SplitProcessorDescriptor Description(string? description) { @@ -124,7 +150,9 @@ public SplitProcessorDescriptor Description(string? description) } /// - /// The field to split. + /// + /// The field to split. + /// /// public SplitProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -133,7 +161,9 @@ public SplitProcessorDescriptor Field(Elastic.Clients.Elasticsearch.S } /// - /// The field to split. + /// + /// The field to split. + /// /// public SplitProcessorDescriptor Field(Expression> field) { @@ -142,7 +172,9 @@ public SplitProcessorDescriptor Field(Expression - /// The field to split. + /// + /// The field to split. + /// /// public SplitProcessorDescriptor Field(Expression> field) { @@ -151,7 +183,9 @@ public SplitProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public SplitProcessorDescriptor If(string? value) { @@ -160,7 +194,9 @@ public SplitProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public SplitProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -169,7 +205,9 @@ public SplitProcessorDescriptor IgnoreFailure(bool? ignoreFailure = t } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public SplitProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -178,7 +216,9 @@ public SplitProcessorDescriptor IgnoreMissing(bool? ignoreMissing = t } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public SplitProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -217,7 +257,9 @@ public SplitProcessorDescriptor OnFailure(params Action - /// Preserves empty trailing fields, if any. + /// + /// Preserves empty trailing fields, if any. + /// /// public SplitProcessorDescriptor PreserveTrailing(bool? preserveTrailing = true) { @@ -226,7 +268,9 @@ public SplitProcessorDescriptor PreserveTrailing(bool? preserveTraili } /// - /// A regex which matches the separator, for example, `,` or `\s+`. + /// + /// A regex which matches the separator, for example, , or \s+. + /// /// public SplitProcessorDescriptor Separator(string separator) { @@ -235,7 +279,10 @@ public SplitProcessorDescriptor Separator(string separator) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public SplitProcessorDescriptor Tag(string? tag) { @@ -244,7 +291,10 @@ public SplitProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the split value to.
By default, the field is updated in-place. + /// + /// The field to assign the split value to. + /// By default, the field is updated in-place. + /// /// public SplitProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -253,7 +303,10 @@ public SplitProcessorDescriptor TargetField(Elastic.Clients.Elasticse } /// - /// The field to assign the split value to.
By default, the field is updated in-place. + /// + /// The field to assign the split value to. + /// By default, the field is updated in-place. + /// /// public SplitProcessorDescriptor TargetField(Expression> targetField) { @@ -262,7 +315,10 @@ public SplitProcessorDescriptor TargetField(Expression - /// The field to assign the split value to.
By default, the field is updated in-place. + /// + /// The field to assign the split value to. + /// By default, the field is updated in-place. + /// /// public SplitProcessorDescriptor TargetField(Expression> targetField) { @@ -377,7 +433,10 @@ public SplitProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public SplitProcessorDescriptor Description(string? description) { @@ -386,7 +445,9 @@ public SplitProcessorDescriptor Description(string? description) } /// - /// The field to split. + /// + /// The field to split. + /// /// public SplitProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -395,7 +456,9 @@ public SplitProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.F } /// - /// The field to split. + /// + /// The field to split. + /// /// public SplitProcessorDescriptor Field(Expression> field) { @@ -404,7 +467,9 @@ public SplitProcessorDescriptor Field(Expression - /// The field to split. + /// + /// The field to split. + /// /// public SplitProcessorDescriptor Field(Expression> field) { @@ -413,7 +478,9 @@ public SplitProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public SplitProcessorDescriptor If(string? value) { @@ -422,7 +489,9 @@ public SplitProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public SplitProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -431,7 +500,9 @@ public SplitProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public SplitProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -440,7 +511,9 @@ public SplitProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public SplitProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -479,7 +552,9 @@ public SplitProcessorDescriptor OnFailure(params Action - /// Preserves empty trailing fields, if any. + /// + /// Preserves empty trailing fields, if any. + /// /// public SplitProcessorDescriptor PreserveTrailing(bool? preserveTrailing = true) { @@ -488,7 +563,9 @@ public SplitProcessorDescriptor PreserveTrailing(bool? preserveTrailing = true) } /// - /// A regex which matches the separator, for example, `,` or `\s+`. + /// + /// A regex which matches the separator, for example, , or \s+. + /// /// public SplitProcessorDescriptor Separator(string separator) { @@ -497,7 +574,10 @@ public SplitProcessorDescriptor Separator(string separator) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public SplitProcessorDescriptor Tag(string? tag) { @@ -506,7 +586,10 @@ public SplitProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the split value to.
By default, the field is updated in-place. + /// + /// The field to assign the split value to. + /// By default, the field is updated in-place. + /// /// public SplitProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -515,7 +598,10 @@ public SplitProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Server } /// - /// The field to assign the split value to.
By default, the field is updated in-place. + /// + /// The field to assign the split value to. + /// By default, the field is updated in-place. + /// /// public SplitProcessorDescriptor TargetField(Expression> targetField) { @@ -524,7 +610,10 @@ public SplitProcessorDescriptor TargetField(Expression - /// The field to assign the split value to.
By default, the field is updated in-place. + /// + /// The field to assign the split value to. + /// By default, the field is updated in-place. + /// /// public SplitProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/TrimProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/TrimProcessor.g.cs index 8f6b2737076..aa3c91d70e4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/TrimProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/TrimProcessor.g.cs @@ -30,49 +30,68 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class TrimProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The string-valued field to trim whitespace from. + /// + /// The string-valued field to trim whitespace from. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field to assign the trimmed value to.
By default, the field is updated in-place. + /// + /// The field to assign the trimmed value to. + /// By default, the field is updated in-place. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? TargetField { get; set; } @@ -101,7 +120,10 @@ public TrimProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public TrimProcessorDescriptor Description(string? description) { @@ -110,7 +132,9 @@ public TrimProcessorDescriptor Description(string? description) } /// - /// The string-valued field to trim whitespace from. + /// + /// The string-valued field to trim whitespace from. + /// /// public TrimProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -119,7 +143,9 @@ public TrimProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Se } /// - /// The string-valued field to trim whitespace from. + /// + /// The string-valued field to trim whitespace from. + /// /// public TrimProcessorDescriptor Field(Expression> field) { @@ -128,7 +154,9 @@ public TrimProcessorDescriptor Field(Expression - /// The string-valued field to trim whitespace from. + /// + /// The string-valued field to trim whitespace from. + /// /// public TrimProcessorDescriptor Field(Expression> field) { @@ -137,7 +165,9 @@ public TrimProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public TrimProcessorDescriptor If(string? value) { @@ -146,7 +176,9 @@ public TrimProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public TrimProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -155,7 +187,9 @@ public TrimProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tr } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public TrimProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -164,7 +198,9 @@ public TrimProcessorDescriptor IgnoreMissing(bool? ignoreMissing = tr } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public TrimProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -203,7 +239,10 @@ public TrimProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public TrimProcessorDescriptor Tag(string? tag) { @@ -212,7 +251,10 @@ public TrimProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the trimmed value to.
By default, the field is updated in-place. + /// + /// The field to assign the trimmed value to. + /// By default, the field is updated in-place. + /// /// public TrimProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -221,7 +263,10 @@ public TrimProcessorDescriptor TargetField(Elastic.Clients.Elasticsea } /// - /// The field to assign the trimmed value to.
By default, the field is updated in-place. + /// + /// The field to assign the trimmed value to. + /// By default, the field is updated in-place. + /// /// public TrimProcessorDescriptor TargetField(Expression> targetField) { @@ -230,7 +275,10 @@ public TrimProcessorDescriptor TargetField(Expression - /// The field to assign the trimmed value to.
By default, the field is updated in-place. + /// + /// The field to assign the trimmed value to. + /// By default, the field is updated in-place. + /// /// public TrimProcessorDescriptor TargetField(Expression> targetField) { @@ -335,7 +383,10 @@ public TrimProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public TrimProcessorDescriptor Description(string? description) { @@ -344,7 +395,9 @@ public TrimProcessorDescriptor Description(string? description) } /// - /// The string-valued field to trim whitespace from. + /// + /// The string-valued field to trim whitespace from. + /// /// public TrimProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -353,7 +406,9 @@ public TrimProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Fi } /// - /// The string-valued field to trim whitespace from. + /// + /// The string-valued field to trim whitespace from. + /// /// public TrimProcessorDescriptor Field(Expression> field) { @@ -362,7 +417,9 @@ public TrimProcessorDescriptor Field(Expression - /// The string-valued field to trim whitespace from. + /// + /// The string-valued field to trim whitespace from. + /// /// public TrimProcessorDescriptor Field(Expression> field) { @@ -371,7 +428,9 @@ public TrimProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public TrimProcessorDescriptor If(string? value) { @@ -380,7 +439,9 @@ public TrimProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public TrimProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -389,7 +450,9 @@ public TrimProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public TrimProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -398,7 +461,9 @@ public TrimProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public TrimProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -437,7 +502,10 @@ public TrimProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public TrimProcessorDescriptor Tag(string? tag) { @@ -446,7 +514,10 @@ public TrimProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the trimmed value to.
By default, the field is updated in-place. + /// + /// The field to assign the trimmed value to. + /// By default, the field is updated in-place. + /// /// public TrimProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -455,7 +526,10 @@ public TrimProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverl } /// - /// The field to assign the trimmed value to.
By default, the field is updated in-place. + /// + /// The field to assign the trimmed value to. + /// By default, the field is updated in-place. + /// /// public TrimProcessorDescriptor TargetField(Expression> targetField) { @@ -464,7 +538,10 @@ public TrimProcessorDescriptor TargetField(Expression - /// The field to assign the trimmed value to.
By default, the field is updated in-place. + /// + /// The field to assign the trimmed value to. + /// By default, the field is updated in-place. + /// /// public TrimProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/UppercaseProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/UppercaseProcessor.g.cs index 70115968baa..0ac5bc4040a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/UppercaseProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/UppercaseProcessor.g.cs @@ -30,49 +30,68 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class UppercaseProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to make uppercase. + /// + /// The field to make uppercase. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? TargetField { get; set; } @@ -101,7 +120,10 @@ public UppercaseProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public UppercaseProcessorDescriptor Description(string? description) { @@ -110,7 +132,9 @@ public UppercaseProcessorDescriptor Description(string? description) } /// - /// The field to make uppercase. + /// + /// The field to make uppercase. + /// /// public UppercaseProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -119,7 +143,9 @@ public UppercaseProcessorDescriptor Field(Elastic.Clients.Elasticsear } /// - /// The field to make uppercase. + /// + /// The field to make uppercase. + /// /// public UppercaseProcessorDescriptor Field(Expression> field) { @@ -128,7 +154,9 @@ public UppercaseProcessorDescriptor Field(Expression - /// The field to make uppercase. + /// + /// The field to make uppercase. + /// /// public UppercaseProcessorDescriptor Field(Expression> field) { @@ -137,7 +165,9 @@ public UppercaseProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public UppercaseProcessorDescriptor If(string? value) { @@ -146,7 +176,9 @@ public UppercaseProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public UppercaseProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -155,7 +187,9 @@ public UppercaseProcessorDescriptor IgnoreFailure(bool? ignoreFailure } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public UppercaseProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -164,7 +198,9 @@ public UppercaseProcessorDescriptor IgnoreMissing(bool? ignoreMissing } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public UppercaseProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -203,7 +239,10 @@ public UppercaseProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public UppercaseProcessorDescriptor Tag(string? tag) { @@ -212,7 +251,10 @@ public UppercaseProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public UppercaseProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -221,7 +263,10 @@ public UppercaseProcessorDescriptor TargetField(Elastic.Clients.Elast } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public UppercaseProcessorDescriptor TargetField(Expression> targetField) { @@ -230,7 +275,10 @@ public UppercaseProcessorDescriptor TargetField(Expression - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public UppercaseProcessorDescriptor TargetField(Expression> targetField) { @@ -335,7 +383,10 @@ public UppercaseProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public UppercaseProcessorDescriptor Description(string? description) { @@ -344,7 +395,9 @@ public UppercaseProcessorDescriptor Description(string? description) } /// - /// The field to make uppercase. + /// + /// The field to make uppercase. + /// /// public UppercaseProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -353,7 +406,9 @@ public UppercaseProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverle } /// - /// The field to make uppercase. + /// + /// The field to make uppercase. + /// /// public UppercaseProcessorDescriptor Field(Expression> field) { @@ -362,7 +417,9 @@ public UppercaseProcessorDescriptor Field(Expression - /// The field to make uppercase. + /// + /// The field to make uppercase. + /// /// public UppercaseProcessorDescriptor Field(Expression> field) { @@ -371,7 +428,9 @@ public UppercaseProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public UppercaseProcessorDescriptor If(string? value) { @@ -380,7 +439,9 @@ public UppercaseProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public UppercaseProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -389,7 +450,9 @@ public UppercaseProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public UppercaseProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -398,7 +461,9 @@ public UppercaseProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public UppercaseProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -437,7 +502,10 @@ public UppercaseProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public UppercaseProcessorDescriptor Tag(string? tag) { @@ -446,7 +514,10 @@ public UppercaseProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public UppercaseProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -455,7 +526,10 @@ public UppercaseProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Se } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public UppercaseProcessorDescriptor TargetField(Expression> targetField) { @@ -464,7 +538,10 @@ public UppercaseProcessorDescriptor TargetField(Expression - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public UppercaseProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/UrlDecodeProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/UrlDecodeProcessor.g.cs index 6f64268adb9..e9fa9e640bd 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/UrlDecodeProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/UrlDecodeProcessor.g.cs @@ -30,49 +30,68 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class UrlDecodeProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to decode. + /// + /// The field to decode. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? TargetField { get; set; } @@ -101,7 +120,10 @@ public UrlDecodeProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public UrlDecodeProcessorDescriptor Description(string? description) { @@ -110,7 +132,9 @@ public UrlDecodeProcessorDescriptor Description(string? description) } /// - /// The field to decode. + /// + /// The field to decode. + /// /// public UrlDecodeProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -119,7 +143,9 @@ public UrlDecodeProcessorDescriptor Field(Elastic.Clients.Elasticsear } /// - /// The field to decode. + /// + /// The field to decode. + /// /// public UrlDecodeProcessorDescriptor Field(Expression> field) { @@ -128,7 +154,9 @@ public UrlDecodeProcessorDescriptor Field(Expression - /// The field to decode. + /// + /// The field to decode. + /// /// public UrlDecodeProcessorDescriptor Field(Expression> field) { @@ -137,7 +165,9 @@ public UrlDecodeProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public UrlDecodeProcessorDescriptor If(string? value) { @@ -146,7 +176,9 @@ public UrlDecodeProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public UrlDecodeProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -155,7 +187,9 @@ public UrlDecodeProcessorDescriptor IgnoreFailure(bool? ignoreFailure } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public UrlDecodeProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -164,7 +198,9 @@ public UrlDecodeProcessorDescriptor IgnoreMissing(bool? ignoreMissing } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public UrlDecodeProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -203,7 +239,10 @@ public UrlDecodeProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public UrlDecodeProcessorDescriptor Tag(string? tag) { @@ -212,7 +251,10 @@ public UrlDecodeProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public UrlDecodeProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -221,7 +263,10 @@ public UrlDecodeProcessorDescriptor TargetField(Elastic.Clients.Elast } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public UrlDecodeProcessorDescriptor TargetField(Expression> targetField) { @@ -230,7 +275,10 @@ public UrlDecodeProcessorDescriptor TargetField(Expression - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public UrlDecodeProcessorDescriptor TargetField(Expression> targetField) { @@ -335,7 +383,10 @@ public UrlDecodeProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public UrlDecodeProcessorDescriptor Description(string? description) { @@ -344,7 +395,9 @@ public UrlDecodeProcessorDescriptor Description(string? description) } /// - /// The field to decode. + /// + /// The field to decode. + /// /// public UrlDecodeProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -353,7 +406,9 @@ public UrlDecodeProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverle } /// - /// The field to decode. + /// + /// The field to decode. + /// /// public UrlDecodeProcessorDescriptor Field(Expression> field) { @@ -362,7 +417,9 @@ public UrlDecodeProcessorDescriptor Field(Expression - /// The field to decode. + /// + /// The field to decode. + /// /// public UrlDecodeProcessorDescriptor Field(Expression> field) { @@ -371,7 +428,9 @@ public UrlDecodeProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public UrlDecodeProcessorDescriptor If(string? value) { @@ -380,7 +439,9 @@ public UrlDecodeProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public UrlDecodeProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -389,7 +450,9 @@ public UrlDecodeProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public UrlDecodeProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -398,7 +461,9 @@ public UrlDecodeProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public UrlDecodeProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -437,7 +502,10 @@ public UrlDecodeProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public UrlDecodeProcessorDescriptor Tag(string? tag) { @@ -446,7 +514,10 @@ public UrlDecodeProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public UrlDecodeProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -455,7 +526,10 @@ public UrlDecodeProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Se } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public UrlDecodeProcessorDescriptor TargetField(Expression> targetField) { @@ -464,7 +538,10 @@ public UrlDecodeProcessorDescriptor TargetField(Expression - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public UrlDecodeProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/UserAgentProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/UserAgentProcessor.g.cs index 865ee476ce3..de8974bf964 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/UserAgentProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/UserAgentProcessor.g.cs @@ -30,37 +30,50 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; public sealed partial class UserAgentProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field containing the user agent string. + /// + /// The field containing the user agent string. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } @@ -68,19 +81,26 @@ public sealed partial class UserAgentProcessor public ICollection? Options { get; set; } /// - /// The name of the file in the `config/ingest-user-agent` directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Elasticsearch. If not specified, ingest-user-agent will use the `regexes.yaml` from uap-core it ships with. + /// + /// The name of the file in the config/ingest-user-agent directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Elasticsearch. If not specified, ingest-user-agent will use the regexes.yaml from uap-core it ships with. + /// /// [JsonInclude, JsonPropertyName("regex_file")] public string? RegexFile { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field that will be filled with the user agent details. + /// + /// The field that will be filled with the user agent details. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? TargetField { get; set; } @@ -111,7 +131,10 @@ public UserAgentProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public UserAgentProcessorDescriptor Description(string? description) { @@ -120,7 +143,9 @@ public UserAgentProcessorDescriptor Description(string? description) } /// - /// The field containing the user agent string. + /// + /// The field containing the user agent string. + /// /// public UserAgentProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -129,7 +154,9 @@ public UserAgentProcessorDescriptor Field(Elastic.Clients.Elasticsear } /// - /// The field containing the user agent string. + /// + /// The field containing the user agent string. + /// /// public UserAgentProcessorDescriptor Field(Expression> field) { @@ -138,7 +165,9 @@ public UserAgentProcessorDescriptor Field(Expression - /// The field containing the user agent string. + /// + /// The field containing the user agent string. + /// /// public UserAgentProcessorDescriptor Field(Expression> field) { @@ -147,7 +176,9 @@ public UserAgentProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public UserAgentProcessorDescriptor If(string? value) { @@ -156,7 +187,9 @@ public UserAgentProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public UserAgentProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -165,7 +198,9 @@ public UserAgentProcessorDescriptor IgnoreFailure(bool? ignoreFailure } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public UserAgentProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -174,7 +209,9 @@ public UserAgentProcessorDescriptor IgnoreMissing(bool? ignoreMissing } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public UserAgentProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -219,7 +256,9 @@ public UserAgentProcessorDescriptor Options(ICollection - /// The name of the file in the `config/ingest-user-agent` directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Elasticsearch. If not specified, ingest-user-agent will use the `regexes.yaml` from uap-core it ships with. + /// + /// The name of the file in the config/ingest-user-agent directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Elasticsearch. If not specified, ingest-user-agent will use the regexes.yaml from uap-core it ships with. + /// /// public UserAgentProcessorDescriptor RegexFile(string? regexFile) { @@ -228,7 +267,10 @@ public UserAgentProcessorDescriptor RegexFile(string? regexFile) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public UserAgentProcessorDescriptor Tag(string? tag) { @@ -237,7 +279,9 @@ public UserAgentProcessorDescriptor Tag(string? tag) } /// - /// The field that will be filled with the user agent details. + /// + /// The field that will be filled with the user agent details. + /// /// public UserAgentProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -246,7 +290,9 @@ public UserAgentProcessorDescriptor TargetField(Elastic.Clients.Elast } /// - /// The field that will be filled with the user agent details. + /// + /// The field that will be filled with the user agent details. + /// /// public UserAgentProcessorDescriptor TargetField(Expression> targetField) { @@ -255,7 +301,9 @@ public UserAgentProcessorDescriptor TargetField(Expression - /// The field that will be filled with the user agent details. + /// + /// The field that will be filled with the user agent details. + /// /// public UserAgentProcessorDescriptor TargetField(Expression> targetField) { @@ -374,7 +422,10 @@ public UserAgentProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public UserAgentProcessorDescriptor Description(string? description) { @@ -383,7 +434,9 @@ public UserAgentProcessorDescriptor Description(string? description) } /// - /// The field containing the user agent string. + /// + /// The field containing the user agent string. + /// /// public UserAgentProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -392,7 +445,9 @@ public UserAgentProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverle } /// - /// The field containing the user agent string. + /// + /// The field containing the user agent string. + /// /// public UserAgentProcessorDescriptor Field(Expression> field) { @@ -401,7 +456,9 @@ public UserAgentProcessorDescriptor Field(Expression - /// The field containing the user agent string. + /// + /// The field containing the user agent string. + /// /// public UserAgentProcessorDescriptor Field(Expression> field) { @@ -410,7 +467,9 @@ public UserAgentProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public UserAgentProcessorDescriptor If(string? value) { @@ -419,7 +478,9 @@ public UserAgentProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public UserAgentProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -428,7 +489,9 @@ public UserAgentProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public UserAgentProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -437,7 +500,9 @@ public UserAgentProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public UserAgentProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -482,7 +547,9 @@ public UserAgentProcessorDescriptor Options(ICollection - /// The name of the file in the `config/ingest-user-agent` directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Elasticsearch. If not specified, ingest-user-agent will use the `regexes.yaml` from uap-core it ships with. + /// + /// The name of the file in the config/ingest-user-agent directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Elasticsearch. If not specified, ingest-user-agent will use the regexes.yaml from uap-core it ships with. + /// /// public UserAgentProcessorDescriptor RegexFile(string? regexFile) { @@ -491,7 +558,10 @@ public UserAgentProcessorDescriptor RegexFile(string? regexFile) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public UserAgentProcessorDescriptor Tag(string? tag) { @@ -500,7 +570,9 @@ public UserAgentProcessorDescriptor Tag(string? tag) } /// - /// The field that will be filled with the user agent details. + /// + /// The field that will be filled with the user agent details. + /// /// public UserAgentProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -509,7 +581,9 @@ public UserAgentProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Se } /// - /// The field that will be filled with the user agent details. + /// + /// The field that will be filled with the user agent details. + /// /// public UserAgentProcessorDescriptor TargetField(Expression> targetField) { @@ -518,7 +592,9 @@ public UserAgentProcessorDescriptor TargetField(Expression - /// The field that will be filled with the user agent details. + /// + /// The field that will be filled with the user agent details. + /// /// public UserAgentProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/InlineGet.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/InlineGet.g.cs index 57fc09cded1..0ecc654b5b4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/InlineGet.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/InlineGet.g.cs @@ -103,7 +103,9 @@ public sealed partial class InlineGet public bool Found { get; init; } /// - /// Document metadata + /// + /// Document metadata + /// /// public IReadOnlyDictionary Metadata { get; init; } public long? PrimaryTerm { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/KnnQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/KnnQuery.g.cs index 3fde80b3a14..fae72f24581 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/KnnQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/KnnQuery.g.cs @@ -30,26 +30,37 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class KnnQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// The name of the vector field to search against + /// + /// The name of the vector field to search against + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Filters for the kNN search query + /// + /// Filters for the kNN search query + /// /// [JsonInclude, JsonPropertyName("filter")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query))] public ICollection? Filter { get; set; } /// - /// The number of nearest neighbor candidates to consider per shard + /// + /// The number of nearest neighbor candidates to consider per shard + /// /// [JsonInclude, JsonPropertyName("num_candidates")] public int? NumCandidates { get; set; } @@ -57,19 +68,25 @@ public sealed partial class KnnQuery public string? QueryName { get; set; } /// - /// The query vector + /// + /// The query vector + /// /// [JsonInclude, JsonPropertyName("query_vector")] public ICollection? QueryVector { get; set; } /// - /// The query vector builder. You must provide a query_vector_builder or query_vector, but not both. + /// + /// The query vector builder. You must provide a query_vector_builder or query_vector, but not both. + /// /// [JsonInclude, JsonPropertyName("query_vector_builder")] public Elastic.Clients.Elasticsearch.Serverless.QueryVectorBuilder? QueryVectorBuilder { get; set; } /// - /// The minimum similarity for a vector to be considered a match + /// + /// The minimum similarity for a vector to be considered a match + /// /// [JsonInclude, JsonPropertyName("similarity")] public float? Similarity { get; set; } @@ -100,7 +117,12 @@ public KnnQueryDescriptor() : base() private float? SimilarityValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public KnnQueryDescriptor Boost(float? boost) { @@ -109,7 +131,9 @@ public KnnQueryDescriptor Boost(float? boost) } /// - /// The name of the vector field to search against + /// + /// The name of the vector field to search against + /// /// public KnnQueryDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -118,7 +142,9 @@ public KnnQueryDescriptor Field(Elastic.Clients.Elasticsearch.Serverl } /// - /// The name of the vector field to search against + /// + /// The name of the vector field to search against + /// /// public KnnQueryDescriptor Field(Expression> field) { @@ -127,7 +153,9 @@ public KnnQueryDescriptor Field(Expression - /// The name of the vector field to search against + /// + /// The name of the vector field to search against + /// /// public KnnQueryDescriptor Field(Expression> field) { @@ -136,7 +164,9 @@ public KnnQueryDescriptor Field(Expression> f } /// - /// Filters for the kNN search query + /// + /// Filters for the kNN search query + /// /// public KnnQueryDescriptor Filter(ICollection? filter) { @@ -175,7 +205,9 @@ public KnnQueryDescriptor Filter(params Action - /// The number of nearest neighbor candidates to consider per shard + /// + /// The number of nearest neighbor candidates to consider per shard + /// /// public KnnQueryDescriptor NumCandidates(int? numCandidates) { @@ -190,7 +222,9 @@ public KnnQueryDescriptor QueryName(string? queryName) } /// - /// The query vector + /// + /// The query vector + /// /// public KnnQueryDescriptor QueryVector(ICollection? queryVector) { @@ -199,7 +233,9 @@ public KnnQueryDescriptor QueryVector(ICollection? queryVector } /// - /// The query vector builder. You must provide a query_vector_builder or query_vector, but not both. + /// + /// The query vector builder. You must provide a query_vector_builder or query_vector, but not both. + /// /// public KnnQueryDescriptor QueryVectorBuilder(Elastic.Clients.Elasticsearch.Serverless.QueryVectorBuilder? queryVectorBuilder) { @@ -226,7 +262,9 @@ public KnnQueryDescriptor QueryVectorBuilder(Action - /// The minimum similarity for a vector to be considered a match + /// + /// The minimum similarity for a vector to be considered a match + /// /// public KnnQueryDescriptor Similarity(float? similarity) { @@ -341,7 +379,12 @@ public KnnQueryDescriptor() : base() private float? SimilarityValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public KnnQueryDescriptor Boost(float? boost) { @@ -350,7 +393,9 @@ public KnnQueryDescriptor Boost(float? boost) } /// - /// The name of the vector field to search against + /// + /// The name of the vector field to search against + /// /// public KnnQueryDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -359,7 +404,9 @@ public KnnQueryDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field f } /// - /// The name of the vector field to search against + /// + /// The name of the vector field to search against + /// /// public KnnQueryDescriptor Field(Expression> field) { @@ -368,7 +415,9 @@ public KnnQueryDescriptor Field(Expression - /// The name of the vector field to search against + /// + /// The name of the vector field to search against + /// /// public KnnQueryDescriptor Field(Expression> field) { @@ -377,7 +426,9 @@ public KnnQueryDescriptor Field(Expression> f } /// - /// Filters for the kNN search query + /// + /// Filters for the kNN search query + /// /// public KnnQueryDescriptor Filter(ICollection? filter) { @@ -416,7 +467,9 @@ public KnnQueryDescriptor Filter(params Action - /// The number of nearest neighbor candidates to consider per shard + /// + /// The number of nearest neighbor candidates to consider per shard + /// /// public KnnQueryDescriptor NumCandidates(int? numCandidates) { @@ -431,7 +484,9 @@ public KnnQueryDescriptor QueryName(string? queryName) } /// - /// The query vector + /// + /// The query vector + /// /// public KnnQueryDescriptor QueryVector(ICollection? queryVector) { @@ -440,7 +495,9 @@ public KnnQueryDescriptor QueryVector(ICollection? queryVector) } /// - /// The query vector builder. You must provide a query_vector_builder or query_vector, but not both. + /// + /// The query vector builder. You must provide a query_vector_builder or query_vector, but not both. + /// /// public KnnQueryDescriptor QueryVectorBuilder(Elastic.Clients.Elasticsearch.Serverless.QueryVectorBuilder? queryVectorBuilder) { @@ -467,7 +524,9 @@ public KnnQueryDescriptor QueryVectorBuilder(Action - /// The minimum similarity for a vector to be considered a match + /// + /// The minimum similarity for a vector to be considered a match + /// /// public KnnQueryDescriptor Similarity(float? similarity) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/KnnRetriever.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/KnnRetriever.g.cs index 00a0a9117e0..fb0452abfbd 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/KnnRetriever.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/KnnRetriever.g.cs @@ -30,44 +30,58 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class KnnRetriever { /// - /// The name of the vector field to search against. + /// + /// The name of the vector field to search against. + /// /// [JsonInclude, JsonPropertyName("field")] public string Field { get; set; } /// - /// Query to filter the documents that can match. + /// + /// Query to filter the documents that can match. + /// /// [JsonInclude, JsonPropertyName("filter")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query))] public ICollection? Filter { get; set; } /// - /// Number of nearest neighbors to return as top hits. + /// + /// Number of nearest neighbors to return as top hits. + /// /// [JsonInclude, JsonPropertyName("k")] public int k { get; set; } /// - /// Number of nearest neighbor candidates to consider per shard. + /// + /// Number of nearest neighbor candidates to consider per shard. + /// /// [JsonInclude, JsonPropertyName("num_candidates")] public int NumCandidates { get; set; } /// - /// Query vector. Must have the same number of dimensions as the vector field you are searching against. You must provide a query_vector_builder or query_vector, but not both. + /// + /// Query vector. Must have the same number of dimensions as the vector field you are searching against. You must provide a query_vector_builder or query_vector, but not both. + /// /// [JsonInclude, JsonPropertyName("query_vector")] public ICollection? QueryVector { get; set; } /// - /// Defines a model to build a query vector. + /// + /// Defines a model to build a query vector. + /// /// [JsonInclude, JsonPropertyName("query_vector_builder")] public Elastic.Clients.Elasticsearch.Serverless.QueryVectorBuilder? QueryVectorBuilder { get; set; } /// - /// The minimum similarity required for a document to be considered a match. + /// + /// The minimum similarity required for a document to be considered a match. + /// /// [JsonInclude, JsonPropertyName("similarity")] public float? Similarity { get; set; } @@ -97,7 +111,9 @@ public KnnRetrieverDescriptor() : base() private float? SimilarityValue { get; set; } /// - /// The name of the vector field to search against. + /// + /// The name of the vector field to search against. + /// /// public KnnRetrieverDescriptor Field(string field) { @@ -106,7 +122,9 @@ public KnnRetrieverDescriptor Field(string field) } /// - /// Query to filter the documents that can match. + /// + /// Query to filter the documents that can match. + /// /// public KnnRetrieverDescriptor Filter(ICollection? filter) { @@ -145,7 +163,9 @@ public KnnRetrieverDescriptor Filter(params Action - /// Number of nearest neighbors to return as top hits. + /// + /// Number of nearest neighbors to return as top hits. + /// /// public KnnRetrieverDescriptor k(int k) { @@ -154,7 +174,9 @@ public KnnRetrieverDescriptor k(int k) } /// - /// Number of nearest neighbor candidates to consider per shard. + /// + /// Number of nearest neighbor candidates to consider per shard. + /// /// public KnnRetrieverDescriptor NumCandidates(int numCandidates) { @@ -163,7 +185,9 @@ public KnnRetrieverDescriptor NumCandidates(int numCandidates) } /// - /// Query vector. Must have the same number of dimensions as the vector field you are searching against. You must provide a query_vector_builder or query_vector, but not both. + /// + /// Query vector. Must have the same number of dimensions as the vector field you are searching against. You must provide a query_vector_builder or query_vector, but not both. + /// /// public KnnRetrieverDescriptor QueryVector(ICollection? queryVector) { @@ -172,7 +196,9 @@ public KnnRetrieverDescriptor QueryVector(ICollection? queryVe } /// - /// Defines a model to build a query vector. + /// + /// Defines a model to build a query vector. + /// /// public KnnRetrieverDescriptor QueryVectorBuilder(Elastic.Clients.Elasticsearch.Serverless.QueryVectorBuilder? queryVectorBuilder) { @@ -199,7 +225,9 @@ public KnnRetrieverDescriptor QueryVectorBuilder(Action - /// The minimum similarity required for a document to be considered a match. + /// + /// The minimum similarity required for a document to be considered a match. + /// /// public KnnRetrieverDescriptor Similarity(float? similarity) { @@ -299,7 +327,9 @@ public KnnRetrieverDescriptor() : base() private float? SimilarityValue { get; set; } /// - /// The name of the vector field to search against. + /// + /// The name of the vector field to search against. + /// /// public KnnRetrieverDescriptor Field(string field) { @@ -308,7 +338,9 @@ public KnnRetrieverDescriptor Field(string field) } /// - /// Query to filter the documents that can match. + /// + /// Query to filter the documents that can match. + /// /// public KnnRetrieverDescriptor Filter(ICollection? filter) { @@ -347,7 +379,9 @@ public KnnRetrieverDescriptor Filter(params Action - /// Number of nearest neighbors to return as top hits. + /// + /// Number of nearest neighbors to return as top hits. + /// /// public KnnRetrieverDescriptor k(int k) { @@ -356,7 +390,9 @@ public KnnRetrieverDescriptor k(int k) } /// - /// Number of nearest neighbor candidates to consider per shard. + /// + /// Number of nearest neighbor candidates to consider per shard. + /// /// public KnnRetrieverDescriptor NumCandidates(int numCandidates) { @@ -365,7 +401,9 @@ public KnnRetrieverDescriptor NumCandidates(int numCandidates) } /// - /// Query vector. Must have the same number of dimensions as the vector field you are searching against. You must provide a query_vector_builder or query_vector, but not both. + /// + /// Query vector. Must have the same number of dimensions as the vector field you are searching against. You must provide a query_vector_builder or query_vector, but not both. + /// /// public KnnRetrieverDescriptor QueryVector(ICollection? queryVector) { @@ -374,7 +412,9 @@ public KnnRetrieverDescriptor QueryVector(ICollection? queryVector) } /// - /// Defines a model to build a query vector. + /// + /// Defines a model to build a query vector. + /// /// public KnnRetrieverDescriptor QueryVectorBuilder(Elastic.Clients.Elasticsearch.Serverless.QueryVectorBuilder? queryVectorBuilder) { @@ -401,7 +441,9 @@ public KnnRetrieverDescriptor QueryVectorBuilder(Action - /// The minimum similarity required for a document to be considered a match. + /// + /// The minimum similarity required for a document to be considered a match. + /// /// public KnnRetrieverDescriptor Similarity(float? similarity) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/KnnSearch.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/KnnSearch.g.cs index 7b6f946c752..a1deddb0eb4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/KnnSearch.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/KnnSearch.g.cs @@ -30,56 +30,74 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class KnnSearch { /// - /// Boost value to apply to kNN scores + /// + /// Boost value to apply to kNN scores + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// The name of the vector field to search against + /// + /// The name of the vector field to search against + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Filters for the kNN search query + /// + /// Filters for the kNN search query + /// /// [JsonInclude, JsonPropertyName("filter")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query))] public ICollection? Filter { get; set; } /// - /// If defined, each search hit will contain inner hits. + /// + /// If defined, each search hit will contain inner hits. + /// /// [JsonInclude, JsonPropertyName("inner_hits")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.InnerHits? InnerHits { get; set; } /// - /// The final number of nearest neighbors to return as top hits + /// + /// The final number of nearest neighbors to return as top hits + /// /// [JsonInclude, JsonPropertyName("k")] public int? k { get; set; } /// - /// The number of nearest neighbor candidates to consider per shard + /// + /// The number of nearest neighbor candidates to consider per shard + /// /// [JsonInclude, JsonPropertyName("num_candidates")] public int? NumCandidates { get; set; } /// - /// The query vector + /// + /// The query vector + /// /// [JsonInclude, JsonPropertyName("query_vector")] public ICollection? QueryVector { get; set; } /// - /// The query vector builder. You must provide a query_vector_builder or query_vector, but not both. + /// + /// The query vector builder. You must provide a query_vector_builder or query_vector, but not both. + /// /// [JsonInclude, JsonPropertyName("query_vector_builder")] public Elastic.Clients.Elasticsearch.Serverless.QueryVectorBuilder? QueryVectorBuilder { get; set; } /// - /// The minimum similarity for a vector to be considered a match + /// + /// The minimum similarity for a vector to be considered a match + /// /// [JsonInclude, JsonPropertyName("similarity")] public float? Similarity { get; set; } @@ -111,7 +129,9 @@ public KnnSearchDescriptor() : base() private float? SimilarityValue { get; set; } /// - /// Boost value to apply to kNN scores + /// + /// Boost value to apply to kNN scores + /// /// public KnnSearchDescriptor Boost(float? boost) { @@ -120,7 +140,9 @@ public KnnSearchDescriptor Boost(float? boost) } /// - /// The name of the vector field to search against + /// + /// The name of the vector field to search against + /// /// public KnnSearchDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -129,7 +151,9 @@ public KnnSearchDescriptor Field(Elastic.Clients.Elasticsearch.Server } /// - /// The name of the vector field to search against + /// + /// The name of the vector field to search against + /// /// public KnnSearchDescriptor Field(Expression> field) { @@ -138,7 +162,9 @@ public KnnSearchDescriptor Field(Expression - /// The name of the vector field to search against + /// + /// The name of the vector field to search against + /// /// public KnnSearchDescriptor Field(Expression> field) { @@ -147,7 +173,9 @@ public KnnSearchDescriptor Field(Expression> } /// - /// Filters for the kNN search query + /// + /// Filters for the kNN search query + /// /// public KnnSearchDescriptor Filter(ICollection? filter) { @@ -186,7 +214,9 @@ public KnnSearchDescriptor Filter(params Action - /// If defined, each search hit will contain inner hits. + /// + /// If defined, each search hit will contain inner hits. + /// /// public KnnSearchDescriptor InnerHits(Elastic.Clients.Elasticsearch.Serverless.Core.Search.InnerHits? innerHits) { @@ -213,7 +243,9 @@ public KnnSearchDescriptor InnerHits(Action - /// The final number of nearest neighbors to return as top hits + /// + /// The final number of nearest neighbors to return as top hits + /// /// public KnnSearchDescriptor k(int? k) { @@ -222,7 +254,9 @@ public KnnSearchDescriptor k(int? k) } /// - /// The number of nearest neighbor candidates to consider per shard + /// + /// The number of nearest neighbor candidates to consider per shard + /// /// public KnnSearchDescriptor NumCandidates(int? numCandidates) { @@ -231,7 +265,9 @@ public KnnSearchDescriptor NumCandidates(int? numCandidates) } /// - /// The query vector + /// + /// The query vector + /// /// public KnnSearchDescriptor QueryVector(ICollection? queryVector) { @@ -240,7 +276,9 @@ public KnnSearchDescriptor QueryVector(ICollection? queryVecto } /// - /// The query vector builder. You must provide a query_vector_builder or query_vector, but not both. + /// + /// The query vector builder. You must provide a query_vector_builder or query_vector, but not both. + /// /// public KnnSearchDescriptor QueryVectorBuilder(Elastic.Clients.Elasticsearch.Serverless.QueryVectorBuilder? queryVectorBuilder) { @@ -267,7 +305,9 @@ public KnnSearchDescriptor QueryVectorBuilder(Action - /// The minimum similarity for a vector to be considered a match + /// + /// The minimum similarity for a vector to be considered a match + /// /// public KnnSearchDescriptor Similarity(float? similarity) { @@ -401,7 +441,9 @@ public KnnSearchDescriptor() : base() private float? SimilarityValue { get; set; } /// - /// Boost value to apply to kNN scores + /// + /// Boost value to apply to kNN scores + /// /// public KnnSearchDescriptor Boost(float? boost) { @@ -410,7 +452,9 @@ public KnnSearchDescriptor Boost(float? boost) } /// - /// The name of the vector field to search against + /// + /// The name of the vector field to search against + /// /// public KnnSearchDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -419,7 +463,9 @@ public KnnSearchDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field } /// - /// The name of the vector field to search against + /// + /// The name of the vector field to search against + /// /// public KnnSearchDescriptor Field(Expression> field) { @@ -428,7 +474,9 @@ public KnnSearchDescriptor Field(Expression - /// The name of the vector field to search against + /// + /// The name of the vector field to search against + /// /// public KnnSearchDescriptor Field(Expression> field) { @@ -437,7 +485,9 @@ public KnnSearchDescriptor Field(Expression> } /// - /// Filters for the kNN search query + /// + /// Filters for the kNN search query + /// /// public KnnSearchDescriptor Filter(ICollection? filter) { @@ -476,7 +526,9 @@ public KnnSearchDescriptor Filter(params Action - /// If defined, each search hit will contain inner hits. + /// + /// If defined, each search hit will contain inner hits. + /// /// public KnnSearchDescriptor InnerHits(Elastic.Clients.Elasticsearch.Serverless.Core.Search.InnerHits? innerHits) { @@ -503,7 +555,9 @@ public KnnSearchDescriptor InnerHits(Action - /// The final number of nearest neighbors to return as top hits + /// + /// The final number of nearest neighbors to return as top hits + /// /// public KnnSearchDescriptor k(int? k) { @@ -512,7 +566,9 @@ public KnnSearchDescriptor k(int? k) } /// - /// The number of nearest neighbor candidates to consider per shard + /// + /// The number of nearest neighbor candidates to consider per shard + /// /// public KnnSearchDescriptor NumCandidates(int? numCandidates) { @@ -521,7 +577,9 @@ public KnnSearchDescriptor NumCandidates(int? numCandidates) } /// - /// The query vector + /// + /// The query vector + /// /// public KnnSearchDescriptor QueryVector(ICollection? queryVector) { @@ -530,7 +588,9 @@ public KnnSearchDescriptor QueryVector(ICollection? queryVector) } /// - /// The query vector builder. You must provide a query_vector_builder or query_vector, but not both. + /// + /// The query vector builder. You must provide a query_vector_builder or query_vector, but not both. + /// /// public KnnSearchDescriptor QueryVectorBuilder(Elastic.Clients.Elasticsearch.Serverless.QueryVectorBuilder? queryVectorBuilder) { @@ -557,7 +617,9 @@ public KnnSearchDescriptor QueryVectorBuilder(Action - /// The minimum similarity for a vector to be considered a match + /// + /// The minimum similarity for a vector to be considered a match + /// /// public KnnSearchDescriptor Similarity(float? similarity) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/LatLonGeoLocation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/LatLonGeoLocation.g.cs index e02b0a0b8c9..66d09482af8 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/LatLonGeoLocation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/LatLonGeoLocation.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class LatLonGeoLocation { /// - /// Latitude + /// + /// Latitude + /// /// [JsonInclude, JsonPropertyName("lat")] public double Lat { get; set; } /// - /// Longitude + /// + /// Longitude + /// /// [JsonInclude, JsonPropertyName("lon")] public double Lon { get; set; } @@ -54,7 +58,9 @@ public LatLonGeoLocationDescriptor() : base() private double LonValue { get; set; } /// - /// Latitude + /// + /// Latitude + /// /// public LatLonGeoLocationDescriptor Lat(double lat) { @@ -63,7 +69,9 @@ public LatLonGeoLocationDescriptor Lat(double lat) } /// - /// Longitude + /// + /// Longitude + /// /// public LatLonGeoLocationDescriptor Lon(double lon) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/AnalysisConfig.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/AnalysisConfig.g.cs index de62c2c7289..9335a95cc9c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/AnalysisConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/AnalysisConfig.g.cs @@ -30,68 +30,91 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class AnalysisConfig { /// - /// The size of the interval that the analysis is aggregated into, typically between `5m` and `1h`. This value should be either a whole number of days or equate to a
whole number of buckets in one day. If the anomaly detection job uses a datafeed with aggregations, this value must also be divisible by the interval of the date histogram aggregation. + /// + /// The size of the interval that the analysis is aggregated into, typically between 5m and 1h. This value should be either a whole number of days or equate to a + /// whole number of buckets in one day. If the anomaly detection job uses a datafeed with aggregations, this value must also be divisible by the interval of the date histogram aggregation. + /// /// [JsonInclude, JsonPropertyName("bucket_span")] public Elastic.Clients.Elasticsearch.Serverless.Duration? BucketSpan { get; set; } /// - /// If `categorization_field_name` is specified, you can also define the analyzer that is used to interpret the categorization field. This property cannot be used at the same time as `categorization_filters`. The categorization analyzer specifies how the `categorization_field` is interpreted by the categorization process. The `categorization_analyzer` field can be specified either as a string or as an object. If it is a string, it must refer to a built-in analyzer or one added by another plugin. + /// + /// If categorization_field_name is specified, you can also define the analyzer that is used to interpret the categorization field. This property cannot be used at the same time as categorization_filters. The categorization analyzer specifies how the categorization_field is interpreted by the categorization process. The categorization_analyzer field can be specified either as a string or as an object. If it is a string, it must refer to a built-in analyzer or one added by another plugin. + /// /// [JsonInclude, JsonPropertyName("categorization_analyzer")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.CategorizationAnalyzer? CategorizationAnalyzer { get; set; } /// - /// If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`. + /// + /// If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting by_field_name, over_field_name, or partition_field_name to the keyword mlcategory. + /// /// [JsonInclude, JsonPropertyName("categorization_field_name")] public Elastic.Clients.Elasticsearch.Serverless.Field? CategorizationFieldName { get; set; } /// - /// If `categorization_field_name` is specified, you can also define optional filters. This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as `categorization_analyzer`. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the `categorization_analyzer` property instead and include the filters as pattern_replace character filters. The effect is exactly the same. + /// + /// If categorization_field_name is specified, you can also define optional filters. This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as categorization_analyzer. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the categorization_analyzer property instead and include the filters as pattern_replace character filters. The effect is exactly the same. + /// /// [JsonInclude, JsonPropertyName("categorization_filters")] public ICollection? CategorizationFilters { get; set; } /// - /// Detector configuration objects specify which data fields a job analyzes. They also specify which analytical functions are used. You can specify multiple detectors for a job. If the detectors array does not contain at least one detector, no analysis can occur and an error is returned. + /// + /// Detector configuration objects specify which data fields a job analyzes. They also specify which analytical functions are used. You can specify multiple detectors for a job. If the detectors array does not contain at least one detector, no analysis can occur and an error is returned. + /// /// [JsonInclude, JsonPropertyName("detectors")] public ICollection Detectors { get; set; } /// - /// A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration. You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity. + /// + /// A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration. You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity. + /// /// [JsonInclude, JsonPropertyName("influencers")] [JsonConverter(typeof(FieldsConverter))] public Elastic.Clients.Elasticsearch.Serverless.Fields? Influencers { get; set; } /// - /// The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second. NOTE: Latency is applicable only when you send data by using the post data API. + /// + /// The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second. NOTE: Latency is applicable only when you send data by using the post data API. + /// /// [JsonInclude, JsonPropertyName("latency")] public Elastic.Clients.Elasticsearch.Serverless.Duration? Latency { get; set; } /// - /// Advanced configuration option. Affects the pruning of models that have not been updated for the given time duration. The value must be set to a multiple of the `bucket_span`. If set too low, important information may be removed from the model. For jobs created in 8.1 and later, the default value is the greater of `30d` or 20 times `bucket_span`. + /// + /// Advanced configuration option. Affects the pruning of models that have not been updated for the given time duration. The value must be set to a multiple of the bucket_span. If set too low, important information may be removed from the model. For jobs created in 8.1 and later, the default value is the greater of 30d or 20 times bucket_span. + /// /// [JsonInclude, JsonPropertyName("model_prune_window")] public Elastic.Clients.Elasticsearch.Serverless.Duration? ModelPruneWindow { get; set; } /// - /// This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features. If set to `true`, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. For example, suppose CPU and memory usage on host A is usually highly correlated with the same metrics on host B. Perhaps this correlation occurs because they are running a load-balanced application. If you enable this property, anomalies will be reported when, for example, CPU usage on host A is high and the value of CPU usage on host B is low. That is to say, you’ll see an anomaly when the CPU of host A is unusual given the CPU of host B. To use the `multivariate_by_fields` property, you must also specify `by_field_name` in your detector. + /// + /// This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features. If set to true, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. For example, suppose CPU and memory usage on host A is usually highly correlated with the same metrics on host B. Perhaps this correlation occurs because they are running a load-balanced application. If you enable this property, anomalies will be reported when, for example, CPU usage on host A is high and the value of CPU usage on host B is low. That is to say, you’ll see an anomaly when the CPU of host A is unusual given the CPU of host B. To use the multivariate_by_fields property, you must also specify by_field_name in your detector. + /// /// [JsonInclude, JsonPropertyName("multivariate_by_fields")] public bool? MultivariateByFields { get; set; } /// - /// Settings related to how categorization interacts with partition fields. + /// + /// Settings related to how categorization interacts with partition fields. + /// /// [JsonInclude, JsonPropertyName("per_partition_categorization")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.PerPartitionCategorization? PerPartitionCategorization { get; set; } /// - /// If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same `summary_count_field_name` applies to all detectors in the job. NOTE: The `summary_count_field_name` property cannot be used with the `metric` function. + /// + /// If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same summary_count_field_name applies to all detectors in the job. NOTE: The summary_count_field_name property cannot be used with the metric function. + /// /// [JsonInclude, JsonPropertyName("summary_count_field_name")] public Elastic.Clients.Elasticsearch.Serverless.Field? SummaryCountFieldName { get; set; } @@ -123,7 +146,10 @@ public AnalysisConfigDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? SummaryCountFieldNameValue { get; set; } /// - /// The size of the interval that the analysis is aggregated into, typically between `5m` and `1h`. This value should be either a whole number of days or equate to a
whole number of buckets in one day. If the anomaly detection job uses a datafeed with aggregations, this value must also be divisible by the interval of the date histogram aggregation. + /// + /// The size of the interval that the analysis is aggregated into, typically between 5m and 1h. This value should be either a whole number of days or equate to a + /// whole number of buckets in one day. If the anomaly detection job uses a datafeed with aggregations, this value must also be divisible by the interval of the date histogram aggregation. + /// /// public AnalysisConfigDescriptor BucketSpan(Elastic.Clients.Elasticsearch.Serverless.Duration? bucketSpan) { @@ -132,7 +158,9 @@ public AnalysisConfigDescriptor BucketSpan(Elastic.Clients.Elasticsea } /// - /// If `categorization_field_name` is specified, you can also define the analyzer that is used to interpret the categorization field. This property cannot be used at the same time as `categorization_filters`. The categorization analyzer specifies how the `categorization_field` is interpreted by the categorization process. The `categorization_analyzer` field can be specified either as a string or as an object. If it is a string, it must refer to a built-in analyzer or one added by another plugin. + /// + /// If categorization_field_name is specified, you can also define the analyzer that is used to interpret the categorization field. This property cannot be used at the same time as categorization_filters. The categorization analyzer specifies how the categorization_field is interpreted by the categorization process. The categorization_analyzer field can be specified either as a string or as an object. If it is a string, it must refer to a built-in analyzer or one added by another plugin. + /// /// public AnalysisConfigDescriptor CategorizationAnalyzer(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.CategorizationAnalyzer? categorizationAnalyzer) { @@ -141,7 +169,9 @@ public AnalysisConfigDescriptor CategorizationAnalyzer(Elastic.Client } /// - /// If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`. + /// + /// If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting by_field_name, over_field_name, or partition_field_name to the keyword mlcategory. + /// /// public AnalysisConfigDescriptor CategorizationFieldName(Elastic.Clients.Elasticsearch.Serverless.Field? categorizationFieldName) { @@ -150,7 +180,9 @@ public AnalysisConfigDescriptor CategorizationFieldName(Elastic.Clien } /// - /// If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`. + /// + /// If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting by_field_name, over_field_name, or partition_field_name to the keyword mlcategory. + /// /// public AnalysisConfigDescriptor CategorizationFieldName(Expression> categorizationFieldName) { @@ -159,7 +191,9 @@ public AnalysisConfigDescriptor CategorizationFieldName(Expre } /// - /// If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`. + /// + /// If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting by_field_name, over_field_name, or partition_field_name to the keyword mlcategory. + /// /// public AnalysisConfigDescriptor CategorizationFieldName(Expression> categorizationFieldName) { @@ -168,7 +202,9 @@ public AnalysisConfigDescriptor CategorizationFieldName(Expression - /// If `categorization_field_name` is specified, you can also define optional filters. This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as `categorization_analyzer`. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the `categorization_analyzer` property instead and include the filters as pattern_replace character filters. The effect is exactly the same. + /// + /// If categorization_field_name is specified, you can also define optional filters. This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as categorization_analyzer. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the categorization_analyzer property instead and include the filters as pattern_replace character filters. The effect is exactly the same. + /// /// public AnalysisConfigDescriptor CategorizationFilters(ICollection? categorizationFilters) { @@ -177,7 +213,9 @@ public AnalysisConfigDescriptor CategorizationFilters(ICollection - /// Detector configuration objects specify which data fields a job analyzes. They also specify which analytical functions are used. You can specify multiple detectors for a job. If the detectors array does not contain at least one detector, no analysis can occur and an error is returned. + /// + /// Detector configuration objects specify which data fields a job analyzes. They also specify which analytical functions are used. You can specify multiple detectors for a job. If the detectors array does not contain at least one detector, no analysis can occur and an error is returned. + /// /// public AnalysisConfigDescriptor Detectors(ICollection detectors) { @@ -216,7 +254,9 @@ public AnalysisConfigDescriptor Detectors(params Action - /// A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration. You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity. + /// + /// A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration. You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity. + /// /// public AnalysisConfigDescriptor Influencers(Elastic.Clients.Elasticsearch.Serverless.Fields? influencers) { @@ -225,7 +265,9 @@ public AnalysisConfigDescriptor Influencers(Elastic.Clients.Elasticse } /// - /// The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second. NOTE: Latency is applicable only when you send data by using the post data API. + /// + /// The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second. NOTE: Latency is applicable only when you send data by using the post data API. + /// /// public AnalysisConfigDescriptor Latency(Elastic.Clients.Elasticsearch.Serverless.Duration? latency) { @@ -234,7 +276,9 @@ public AnalysisConfigDescriptor Latency(Elastic.Clients.Elasticsearch } /// - /// Advanced configuration option. Affects the pruning of models that have not been updated for the given time duration. The value must be set to a multiple of the `bucket_span`. If set too low, important information may be removed from the model. For jobs created in 8.1 and later, the default value is the greater of `30d` or 20 times `bucket_span`. + /// + /// Advanced configuration option. Affects the pruning of models that have not been updated for the given time duration. The value must be set to a multiple of the bucket_span. If set too low, important information may be removed from the model. For jobs created in 8.1 and later, the default value is the greater of 30d or 20 times bucket_span. + /// /// public AnalysisConfigDescriptor ModelPruneWindow(Elastic.Clients.Elasticsearch.Serverless.Duration? modelPruneWindow) { @@ -243,7 +287,9 @@ public AnalysisConfigDescriptor ModelPruneWindow(Elastic.Clients.Elas } /// - /// This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features. If set to `true`, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. For example, suppose CPU and memory usage on host A is usually highly correlated with the same metrics on host B. Perhaps this correlation occurs because they are running a load-balanced application. If you enable this property, anomalies will be reported when, for example, CPU usage on host A is high and the value of CPU usage on host B is low. That is to say, you’ll see an anomaly when the CPU of host A is unusual given the CPU of host B. To use the `multivariate_by_fields` property, you must also specify `by_field_name` in your detector. + /// + /// This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features. If set to true, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. For example, suppose CPU and memory usage on host A is usually highly correlated with the same metrics on host B. Perhaps this correlation occurs because they are running a load-balanced application. If you enable this property, anomalies will be reported when, for example, CPU usage on host A is high and the value of CPU usage on host B is low. That is to say, you’ll see an anomaly when the CPU of host A is unusual given the CPU of host B. To use the multivariate_by_fields property, you must also specify by_field_name in your detector. + /// /// public AnalysisConfigDescriptor MultivariateByFields(bool? multivariateByFields = true) { @@ -252,7 +298,9 @@ public AnalysisConfigDescriptor MultivariateByFields(bool? multivaria } /// - /// Settings related to how categorization interacts with partition fields. + /// + /// Settings related to how categorization interacts with partition fields. + /// /// public AnalysisConfigDescriptor PerPartitionCategorization(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.PerPartitionCategorization? perPartitionCategorization) { @@ -279,7 +327,9 @@ public AnalysisConfigDescriptor PerPartitionCategorization(Action - /// If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same `summary_count_field_name` applies to all detectors in the job. NOTE: The `summary_count_field_name` property cannot be used with the `metric` function. + /// + /// If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same summary_count_field_name applies to all detectors in the job. NOTE: The summary_count_field_name property cannot be used with the metric function. + /// /// public AnalysisConfigDescriptor SummaryCountFieldName(Elastic.Clients.Elasticsearch.Serverless.Field? summaryCountFieldName) { @@ -288,7 +338,9 @@ public AnalysisConfigDescriptor SummaryCountFieldName(Elastic.Clients } /// - /// If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same `summary_count_field_name` applies to all detectors in the job. NOTE: The `summary_count_field_name` property cannot be used with the `metric` function. + /// + /// If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same summary_count_field_name applies to all detectors in the job. NOTE: The summary_count_field_name property cannot be used with the metric function. + /// /// public AnalysisConfigDescriptor SummaryCountFieldName(Expression> summaryCountFieldName) { @@ -297,7 +349,9 @@ public AnalysisConfigDescriptor SummaryCountFieldName(Express } /// - /// If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same `summary_count_field_name` applies to all detectors in the job. NOTE: The `summary_count_field_name` property cannot be used with the `metric` function. + /// + /// If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same summary_count_field_name applies to all detectors in the job. NOTE: The summary_count_field_name property cannot be used with the metric function. + /// /// public AnalysisConfigDescriptor SummaryCountFieldName(Expression> summaryCountFieldName) { @@ -439,7 +493,10 @@ public AnalysisConfigDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? SummaryCountFieldNameValue { get; set; } /// - /// The size of the interval that the analysis is aggregated into, typically between `5m` and `1h`. This value should be either a whole number of days or equate to a
whole number of buckets in one day. If the anomaly detection job uses a datafeed with aggregations, this value must also be divisible by the interval of the date histogram aggregation. + /// + /// The size of the interval that the analysis is aggregated into, typically between 5m and 1h. This value should be either a whole number of days or equate to a + /// whole number of buckets in one day. If the anomaly detection job uses a datafeed with aggregations, this value must also be divisible by the interval of the date histogram aggregation. + /// /// public AnalysisConfigDescriptor BucketSpan(Elastic.Clients.Elasticsearch.Serverless.Duration? bucketSpan) { @@ -448,7 +505,9 @@ public AnalysisConfigDescriptor BucketSpan(Elastic.Clients.Elasticsearch.Serverl } /// - /// If `categorization_field_name` is specified, you can also define the analyzer that is used to interpret the categorization field. This property cannot be used at the same time as `categorization_filters`. The categorization analyzer specifies how the `categorization_field` is interpreted by the categorization process. The `categorization_analyzer` field can be specified either as a string or as an object. If it is a string, it must refer to a built-in analyzer or one added by another plugin. + /// + /// If categorization_field_name is specified, you can also define the analyzer that is used to interpret the categorization field. This property cannot be used at the same time as categorization_filters. The categorization analyzer specifies how the categorization_field is interpreted by the categorization process. The categorization_analyzer field can be specified either as a string or as an object. If it is a string, it must refer to a built-in analyzer or one added by another plugin. + /// /// public AnalysisConfigDescriptor CategorizationAnalyzer(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.CategorizationAnalyzer? categorizationAnalyzer) { @@ -457,7 +516,9 @@ public AnalysisConfigDescriptor CategorizationAnalyzer(Elastic.Clients.Elasticse } /// - /// If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`. + /// + /// If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting by_field_name, over_field_name, or partition_field_name to the keyword mlcategory. + /// /// public AnalysisConfigDescriptor CategorizationFieldName(Elastic.Clients.Elasticsearch.Serverless.Field? categorizationFieldName) { @@ -466,7 +527,9 @@ public AnalysisConfigDescriptor CategorizationFieldName(Elastic.Clients.Elastics } /// - /// If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`. + /// + /// If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting by_field_name, over_field_name, or partition_field_name to the keyword mlcategory. + /// /// public AnalysisConfigDescriptor CategorizationFieldName(Expression> categorizationFieldName) { @@ -475,7 +538,9 @@ public AnalysisConfigDescriptor CategorizationFieldName(Expre } /// - /// If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`. + /// + /// If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting by_field_name, over_field_name, or partition_field_name to the keyword mlcategory. + /// /// public AnalysisConfigDescriptor CategorizationFieldName(Expression> categorizationFieldName) { @@ -484,7 +549,9 @@ public AnalysisConfigDescriptor CategorizationFieldName(Expression - /// If `categorization_field_name` is specified, you can also define optional filters. This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as `categorization_analyzer`. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the `categorization_analyzer` property instead and include the filters as pattern_replace character filters. The effect is exactly the same. + /// + /// If categorization_field_name is specified, you can also define optional filters. This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as categorization_analyzer. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the categorization_analyzer property instead and include the filters as pattern_replace character filters. The effect is exactly the same. + /// /// public AnalysisConfigDescriptor CategorizationFilters(ICollection? categorizationFilters) { @@ -493,7 +560,9 @@ public AnalysisConfigDescriptor CategorizationFilters(ICollection? categ } /// - /// Detector configuration objects specify which data fields a job analyzes. They also specify which analytical functions are used. You can specify multiple detectors for a job. If the detectors array does not contain at least one detector, no analysis can occur and an error is returned. + /// + /// Detector configuration objects specify which data fields a job analyzes. They also specify which analytical functions are used. You can specify multiple detectors for a job. If the detectors array does not contain at least one detector, no analysis can occur and an error is returned. + /// /// public AnalysisConfigDescriptor Detectors(ICollection detectors) { @@ -532,7 +601,9 @@ public AnalysisConfigDescriptor Detectors(params Action - /// A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration. You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity. + /// + /// A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration. You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity. + /// /// public AnalysisConfigDescriptor Influencers(Elastic.Clients.Elasticsearch.Serverless.Fields? influencers) { @@ -541,7 +612,9 @@ public AnalysisConfigDescriptor Influencers(Elastic.Clients.Elasticsearch.Server } /// - /// The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second. NOTE: Latency is applicable only when you send data by using the post data API. + /// + /// The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second. NOTE: Latency is applicable only when you send data by using the post data API. + /// /// public AnalysisConfigDescriptor Latency(Elastic.Clients.Elasticsearch.Serverless.Duration? latency) { @@ -550,7 +623,9 @@ public AnalysisConfigDescriptor Latency(Elastic.Clients.Elasticsearch.Serverless } /// - /// Advanced configuration option. Affects the pruning of models that have not been updated for the given time duration. The value must be set to a multiple of the `bucket_span`. If set too low, important information may be removed from the model. For jobs created in 8.1 and later, the default value is the greater of `30d` or 20 times `bucket_span`. + /// + /// Advanced configuration option. Affects the pruning of models that have not been updated for the given time duration. The value must be set to a multiple of the bucket_span. If set too low, important information may be removed from the model. For jobs created in 8.1 and later, the default value is the greater of 30d or 20 times bucket_span. + /// /// public AnalysisConfigDescriptor ModelPruneWindow(Elastic.Clients.Elasticsearch.Serverless.Duration? modelPruneWindow) { @@ -559,7 +634,9 @@ public AnalysisConfigDescriptor ModelPruneWindow(Elastic.Clients.Elasticsearch.S } /// - /// This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features. If set to `true`, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. For example, suppose CPU and memory usage on host A is usually highly correlated with the same metrics on host B. Perhaps this correlation occurs because they are running a load-balanced application. If you enable this property, anomalies will be reported when, for example, CPU usage on host A is high and the value of CPU usage on host B is low. That is to say, you’ll see an anomaly when the CPU of host A is unusual given the CPU of host B. To use the `multivariate_by_fields` property, you must also specify `by_field_name` in your detector. + /// + /// This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features. If set to true, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. For example, suppose CPU and memory usage on host A is usually highly correlated with the same metrics on host B. Perhaps this correlation occurs because they are running a load-balanced application. If you enable this property, anomalies will be reported when, for example, CPU usage on host A is high and the value of CPU usage on host B is low. That is to say, you’ll see an anomaly when the CPU of host A is unusual given the CPU of host B. To use the multivariate_by_fields property, you must also specify by_field_name in your detector. + /// /// public AnalysisConfigDescriptor MultivariateByFields(bool? multivariateByFields = true) { @@ -568,7 +645,9 @@ public AnalysisConfigDescriptor MultivariateByFields(bool? multivariateByFields } /// - /// Settings related to how categorization interacts with partition fields. + /// + /// Settings related to how categorization interacts with partition fields. + /// /// public AnalysisConfigDescriptor PerPartitionCategorization(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.PerPartitionCategorization? perPartitionCategorization) { @@ -595,7 +674,9 @@ public AnalysisConfigDescriptor PerPartitionCategorization(Action - /// If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same `summary_count_field_name` applies to all detectors in the job. NOTE: The `summary_count_field_name` property cannot be used with the `metric` function. + /// + /// If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same summary_count_field_name applies to all detectors in the job. NOTE: The summary_count_field_name property cannot be used with the metric function. + /// /// public AnalysisConfigDescriptor SummaryCountFieldName(Elastic.Clients.Elasticsearch.Serverless.Field? summaryCountFieldName) { @@ -604,7 +685,9 @@ public AnalysisConfigDescriptor SummaryCountFieldName(Elastic.Clients.Elasticsea } /// - /// If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same `summary_count_field_name` applies to all detectors in the job. NOTE: The `summary_count_field_name` property cannot be used with the `metric` function. + /// + /// If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same summary_count_field_name applies to all detectors in the job. NOTE: The summary_count_field_name property cannot be used with the metric function. + /// /// public AnalysisConfigDescriptor SummaryCountFieldName(Expression> summaryCountFieldName) { @@ -613,7 +696,9 @@ public AnalysisConfigDescriptor SummaryCountFieldName(Express } /// - /// If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same `summary_count_field_name` applies to all detectors in the job. NOTE: The `summary_count_field_name` property cannot be used with the `metric` function. + /// + /// If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same summary_count_field_name applies to all detectors in the job. NOTE: The summary_count_field_name property cannot be used with the metric function. + /// /// public AnalysisConfigDescriptor SummaryCountFieldName(Expression> summaryCountFieldName) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/AnalysisConfigRead.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/AnalysisConfigRead.g.cs index 56815c20ee7..daa30381300 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/AnalysisConfigRead.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/AnalysisConfigRead.g.cs @@ -30,67 +30,112 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class AnalysisConfigRead { /// - /// The size of the interval that the analysis is aggregated into, typically between `5m` and `1h`. + /// + /// The size of the interval that the analysis is aggregated into, typically between 5m and 1h. + /// /// [JsonInclude, JsonPropertyName("bucket_span")] public Elastic.Clients.Elasticsearch.Serverless.Duration BucketSpan { get; init; } /// - /// If `categorization_field_name` is specified, you can also define the analyzer that is used to interpret the categorization field.
This property cannot be used at the same time as `categorization_filters`.
The categorization analyzer specifies how the `categorization_field` is interpreted by the categorization process. + /// + /// If categorization_field_name is specified, you can also define the analyzer that is used to interpret the categorization field. + /// This property cannot be used at the same time as categorization_filters. + /// The categorization analyzer specifies how the categorization_field is interpreted by the categorization process. + /// /// [JsonInclude, JsonPropertyName("categorization_analyzer")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.CategorizationAnalyzer? CategorizationAnalyzer { get; init; } /// - /// If this property is specified, the values of the specified field will be categorized.
The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`. + /// + /// If this property is specified, the values of the specified field will be categorized. + /// The resulting categories must be used in a detector by setting by_field_name, over_field_name, or partition_field_name to the keyword mlcategory. + /// /// [JsonInclude, JsonPropertyName("categorization_field_name")] public string? CategorizationFieldName { get; init; } /// - /// If `categorization_field_name` is specified, you can also define optional filters.
This property expects an array of regular expressions.
The expressions are used to filter out matching sequences from the categorization field values. + /// + /// If categorization_field_name is specified, you can also define optional filters. + /// This property expects an array of regular expressions. + /// The expressions are used to filter out matching sequences from the categorization field values. + /// /// [JsonInclude, JsonPropertyName("categorization_filters")] public IReadOnlyCollection? CategorizationFilters { get; init; } /// - /// An array of detector configuration objects.
Detector configuration objects specify which data fields a job analyzes.
They also specify which analytical functions are used.
You can specify multiple detectors for a job. + /// + /// An array of detector configuration objects. + /// Detector configuration objects specify which data fields a job analyzes. + /// They also specify which analytical functions are used. + /// You can specify multiple detectors for a job. + /// /// [JsonInclude, JsonPropertyName("detectors")] public IReadOnlyCollection Detectors { get; init; } /// - /// A comma separated list of influencer field names.
Typically these can be the by, over, or partition fields that are used in the detector configuration.
You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data.
When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity. + /// + /// A comma separated list of influencer field names. + /// Typically these can be the by, over, or partition fields that are used in the detector configuration. + /// You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. + /// When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity. + /// /// [JsonInclude, JsonPropertyName("influencers")] public IReadOnlyCollection Influencers { get; init; } /// - /// The size of the window in which to expect data that is out of time order.
Defaults to no latency.
If you specify a non-zero value, it must be greater than or equal to one second. + /// + /// The size of the window in which to expect data that is out of time order. + /// Defaults to no latency. + /// If you specify a non-zero value, it must be greater than or equal to one second. + /// /// [JsonInclude, JsonPropertyName("latency")] public Elastic.Clients.Elasticsearch.Serverless.Duration? Latency { get; init; } /// - /// Advanced configuration option.
Affects the pruning of models that have not been updated for the given time duration.
The value must be set to a multiple of the `bucket_span`.
If set too low, important information may be removed from the model.
Typically, set to `30d` or longer.
If not set, model pruning only occurs if the model memory status reaches the soft limit or the hard limit.
For jobs created in 8.1 and later, the default value is the greater of `30d` or 20 times `bucket_span`. + /// + /// Advanced configuration option. + /// Affects the pruning of models that have not been updated for the given time duration. + /// The value must be set to a multiple of the bucket_span. + /// If set too low, important information may be removed from the model. + /// Typically, set to 30d or longer. + /// If not set, model pruning only occurs if the model memory status reaches the soft limit or the hard limit. + /// For jobs created in 8.1 and later, the default value is the greater of 30d or 20 times bucket_span. + /// /// [JsonInclude, JsonPropertyName("model_prune_window")] public Elastic.Clients.Elasticsearch.Serverless.Duration? ModelPruneWindow { get; init; } /// - /// This functionality is reserved for internal use.
It is not supported for use in customer environments and is not subject to the support SLA of official GA features.
If set to `true`, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. + /// + /// This functionality is reserved for internal use. + /// It is not supported for use in customer environments and is not subject to the support SLA of official GA features. + /// If set to true, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. + /// /// [JsonInclude, JsonPropertyName("multivariate_by_fields")] public bool? MultivariateByFields { get; init; } /// - /// Settings related to how categorization interacts with partition fields. + /// + /// Settings related to how categorization interacts with partition fields. + /// /// [JsonInclude, JsonPropertyName("per_partition_categorization")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.PerPartitionCategorization? PerPartitionCategorization { get; init; } /// - /// If this property is specified, the data that is fed to the job is expected to be pre-summarized.
This property value is the name of the field that contains the count of raw data points that have been summarized.
The same `summary_count_field_name` applies to all detectors in the job. + /// + /// If this property is specified, the data that is fed to the job is expected to be pre-summarized. + /// This property value is the name of the field that contains the count of raw data points that have been summarized. + /// The same summary_count_field_name applies to all detectors in the job. + /// /// [JsonInclude, JsonPropertyName("summary_count_field_name")] public string? SummaryCountFieldName { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/AnalysisLimits.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/AnalysisLimits.g.cs index fff15cdc0c7..2222f2104e5 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/AnalysisLimits.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/AnalysisLimits.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class AnalysisLimits { /// - /// The maximum number of examples stored per category in memory and in the results data store. If you increase this value, more examples are available, however it requires that you have more storage available. If you set this value to 0, no examples are stored. NOTE: The `categorization_examples_limit` applies only to analysis that uses categorization. + /// + /// The maximum number of examples stored per category in memory and in the results data store. If you increase this value, more examples are available, however it requires that you have more storage available. If you set this value to 0, no examples are stored. NOTE: The categorization_examples_limit applies only to analysis that uses categorization. + /// /// [JsonInclude, JsonPropertyName("categorization_examples_limit")] public long? CategorizationExamplesLimit { get; set; } /// - /// The approximate maximum amount of memory resources that are required for analytical processing. Once this limit is approached, data pruning becomes more aggressive. Upon exceeding this limit, new entities are not modeled. If the `xpack.ml.max_model_memory_limit` setting has a value greater than 0 and less than 1024mb, that value is used instead of the default. The default value is relatively small to ensure that high resource usage is a conscious decision. If you have jobs that are expected to analyze high cardinality fields, you will likely need to use a higher value. If you specify a number instead of a string, the units are assumed to be MiB. Specifying a string is recommended for clarity. If you specify a byte size unit of `b` or `kb` and the number does not equate to a discrete number of megabytes, it is rounded down to the closest MiB. The minimum valid value is 1 MiB. If you specify a value less than 1 MiB, an error occurs. If you specify a value for the `xpack.ml.max_model_memory_limit` setting, an error occurs when you try to create jobs that have `model_memory_limit` values greater than that setting value. + /// + /// The approximate maximum amount of memory resources that are required for analytical processing. Once this limit is approached, data pruning becomes more aggressive. Upon exceeding this limit, new entities are not modeled. If the xpack.ml.max_model_memory_limit setting has a value greater than 0 and less than 1024mb, that value is used instead of the default. The default value is relatively small to ensure that high resource usage is a conscious decision. If you have jobs that are expected to analyze high cardinality fields, you will likely need to use a higher value. If you specify a number instead of a string, the units are assumed to be MiB. Specifying a string is recommended for clarity. If you specify a byte size unit of b or kb and the number does not equate to a discrete number of megabytes, it is rounded down to the closest MiB. The minimum valid value is 1 MiB. If you specify a value less than 1 MiB, an error occurs. If you specify a value for the xpack.ml.max_model_memory_limit setting, an error occurs when you try to create jobs that have model_memory_limit values greater than that setting value. + /// /// [JsonInclude, JsonPropertyName("model_memory_limit")] public string? ModelMemoryLimit { get; set; } @@ -54,7 +58,9 @@ public AnalysisLimitsDescriptor() : base() private string? ModelMemoryLimitValue { get; set; } /// - /// The maximum number of examples stored per category in memory and in the results data store. If you increase this value, more examples are available, however it requires that you have more storage available. If you set this value to 0, no examples are stored. NOTE: The `categorization_examples_limit` applies only to analysis that uses categorization. + /// + /// The maximum number of examples stored per category in memory and in the results data store. If you increase this value, more examples are available, however it requires that you have more storage available. If you set this value to 0, no examples are stored. NOTE: The categorization_examples_limit applies only to analysis that uses categorization. + /// /// public AnalysisLimitsDescriptor CategorizationExamplesLimit(long? categorizationExamplesLimit) { @@ -63,7 +69,9 @@ public AnalysisLimitsDescriptor CategorizationExamplesLimit(long? categorization } /// - /// The approximate maximum amount of memory resources that are required for analytical processing. Once this limit is approached, data pruning becomes more aggressive. Upon exceeding this limit, new entities are not modeled. If the `xpack.ml.max_model_memory_limit` setting has a value greater than 0 and less than 1024mb, that value is used instead of the default. The default value is relatively small to ensure that high resource usage is a conscious decision. If you have jobs that are expected to analyze high cardinality fields, you will likely need to use a higher value. If you specify a number instead of a string, the units are assumed to be MiB. Specifying a string is recommended for clarity. If you specify a byte size unit of `b` or `kb` and the number does not equate to a discrete number of megabytes, it is rounded down to the closest MiB. The minimum valid value is 1 MiB. If you specify a value less than 1 MiB, an error occurs. If you specify a value for the `xpack.ml.max_model_memory_limit` setting, an error occurs when you try to create jobs that have `model_memory_limit` values greater than that setting value. + /// + /// The approximate maximum amount of memory resources that are required for analytical processing. Once this limit is approached, data pruning becomes more aggressive. Upon exceeding this limit, new entities are not modeled. If the xpack.ml.max_model_memory_limit setting has a value greater than 0 and less than 1024mb, that value is used instead of the default. The default value is relatively small to ensure that high resource usage is a conscious decision. If you have jobs that are expected to analyze high cardinality fields, you will likely need to use a higher value. If you specify a number instead of a string, the units are assumed to be MiB. Specifying a string is recommended for clarity. If you specify a byte size unit of b or kb and the number does not equate to a discrete number of megabytes, it is rounded down to the closest MiB. The minimum valid value is 1 MiB. If you specify a value less than 1 MiB, an error occurs. If you specify a value for the xpack.ml.max_model_memory_limit setting, an error occurs when you try to create jobs that have model_memory_limit values greater than that setting value. + /// /// public AnalysisLimitsDescriptor ModelMemoryLimit(string? modelMemoryLimit) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/AnalysisMemoryLimit.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/AnalysisMemoryLimit.g.cs index 6b9a8a19913..5a66ccef7e1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/AnalysisMemoryLimit.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/AnalysisMemoryLimit.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class AnalysisMemoryLimit { /// - /// Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes. + /// + /// Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes. + /// /// [JsonInclude, JsonPropertyName("model_memory_limit")] public string ModelMemoryLimit { get; set; } @@ -47,7 +49,9 @@ public AnalysisMemoryLimitDescriptor() : base() private string ModelMemoryLimitValue { get; set; } /// - /// Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes. + /// + /// Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes. + /// /// public AnalysisMemoryLimitDescriptor ModelMemoryLimit(string modelMemoryLimit) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Anomaly.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Anomaly.g.cs index 70d21759e4f..088efbe19a7 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Anomaly.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Anomaly.g.cs @@ -30,145 +30,193 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class Anomaly { /// - /// The actual value for the bucket. + /// + /// The actual value for the bucket. + /// /// [JsonInclude, JsonPropertyName("actual")] public IReadOnlyCollection? Actual { get; init; } /// - /// Information about the factors impacting the initial anomaly score. + /// + /// Information about the factors impacting the initial anomaly score. + /// /// [JsonInclude, JsonPropertyName("anomaly_score_explanation")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.AnomalyExplanation? AnomalyScoreExplanation { get; init; } /// - /// The length of the bucket in seconds. This value matches the `bucket_span` that is specified in the job. + /// + /// The length of the bucket in seconds. This value matches the bucket_span that is specified in the job. + /// /// [JsonInclude, JsonPropertyName("bucket_span")] public long BucketSpan { get; init; } /// - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// /// [JsonInclude, JsonPropertyName("by_field_name")] public string? ByFieldName { get; init; } /// - /// The value of `by_field_name`. + /// + /// The value of by_field_name. + /// /// [JsonInclude, JsonPropertyName("by_field_value")] public string? ByFieldValue { get; init; } /// - /// For population analysis, an over field must be specified in the detector. This property contains an array of anomaly records that are the causes for the anomaly that has been identified for the over field. This sub-resource contains the most anomalous records for the `over_field_name`. For scalability reasons, a maximum of the 10 most significant causes of the anomaly are returned. As part of the core analytical modeling, these low-level anomaly records are aggregated for their parent over field record. The `causes` resource contains similar elements to the record resource, namely `actual`, `typical`, `geo_results.actual_point`, `geo_results.typical_point`, `*_field_name` and `*_field_value`. Probability and scores are not applicable to causes. + /// + /// For population analysis, an over field must be specified in the detector. This property contains an array of anomaly records that are the causes for the anomaly that has been identified for the over field. This sub-resource contains the most anomalous records for the over_field_name. For scalability reasons, a maximum of the 10 most significant causes of the anomaly are returned. As part of the core analytical modeling, these low-level anomaly records are aggregated for their parent over field record. The causes resource contains similar elements to the record resource, namely actual, typical, geo_results.actual_point, geo_results.typical_point, *_field_name and *_field_value. Probability and scores are not applicable to causes. + /// /// [JsonInclude, JsonPropertyName("causes")] public IReadOnlyCollection? Causes { get; init; } /// - /// A unique identifier for the detector. + /// + /// A unique identifier for the detector. + /// /// [JsonInclude, JsonPropertyName("detector_index")] public int DetectorIndex { get; init; } /// - /// Certain functions require a field to operate on, for example, `sum()`. For those functions, this value is the name of the field to be analyzed. + /// + /// Certain functions require a field to operate on, for example, sum(). For those functions, this value is the name of the field to be analyzed. + /// /// [JsonInclude, JsonPropertyName("field_name")] public string? FieldName { get; init; } /// - /// The function in which the anomaly occurs, as specified in the detector configuration. For example, `max`. + /// + /// The function in which the anomaly occurs, as specified in the detector configuration. For example, max. + /// /// [JsonInclude, JsonPropertyName("function")] public string? Function { get; init; } /// - /// The description of the function in which the anomaly occurs, as specified in the detector configuration. + /// + /// The description of the function in which the anomaly occurs, as specified in the detector configuration. + /// /// [JsonInclude, JsonPropertyName("function_description")] public string? FunctionDescription { get; init; } /// - /// If the detector function is `lat_long`, this object contains comma delimited strings for the latitude and longitude of the actual and typical values. + /// + /// If the detector function is lat_long, this object contains comma delimited strings for the latitude and longitude of the actual and typical values. + /// /// [JsonInclude, JsonPropertyName("geo_results")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.GeoResults? GeoResults { get; init; } /// - /// If influencers were specified in the detector configuration, this array contains influencers that contributed to or were to blame for an anomaly. + /// + /// If influencers were specified in the detector configuration, this array contains influencers that contributed to or were to blame for an anomaly. + /// /// [JsonInclude, JsonPropertyName("influencers")] public IReadOnlyCollection? Influencers { get; init; } /// - /// A normalized score between 0-100, which is based on the probability of the anomalousness of this record. This is the initial value that was calculated at the time the bucket was processed. + /// + /// A normalized score between 0-100, which is based on the probability of the anomalousness of this record. This is the initial value that was calculated at the time the bucket was processed. + /// /// [JsonInclude, JsonPropertyName("initial_record_score")] public double InitialRecordScore { get; init; } /// - /// If true, this is an interim result. In other words, the results are calculated based on partial input data. + /// + /// If true, this is an interim result. In other words, the results are calculated based on partial input data. + /// /// [JsonInclude, JsonPropertyName("is_interim")] public bool IsInterim { get; init; } /// - /// Identifier for the anomaly detection job. + /// + /// Identifier for the anomaly detection job. + /// /// [JsonInclude, JsonPropertyName("job_id")] public string JobId { get; init; } /// - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// /// [JsonInclude, JsonPropertyName("over_field_name")] public string? OverFieldName { get; init; } /// - /// The value of `over_field_name`. + /// + /// The value of over_field_name. + /// /// [JsonInclude, JsonPropertyName("over_field_value")] public string? OverFieldValue { get; init; } /// - /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// + /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// /// [JsonInclude, JsonPropertyName("partition_field_name")] public string? PartitionFieldName { get; init; } /// - /// The value of `partition_field_name`. + /// + /// The value of partition_field_name. + /// /// [JsonInclude, JsonPropertyName("partition_field_value")] public string? PartitionFieldValue { get; init; } /// - /// The probability of the individual anomaly occurring, in the range 0 to 1. For example, `0.0000772031`. This value can be held to a high precision of over 300 decimal places, so the `record_score` is provided as a human-readable and friendly interpretation of this. + /// + /// The probability of the individual anomaly occurring, in the range 0 to 1. For example, 0.0000772031. This value can be held to a high precision of over 300 decimal places, so the record_score is provided as a human-readable and friendly interpretation of this. + /// /// [JsonInclude, JsonPropertyName("probability")] public double Probability { get; init; } /// - /// A normalized score between 0-100, which is based on the probability of the anomalousness of this record. Unlike `initial_record_score`, this value will be updated by a re-normalization process as new data is analyzed. + /// + /// A normalized score between 0-100, which is based on the probability of the anomalousness of this record. Unlike initial_record_score, this value will be updated by a re-normalization process as new data is analyzed. + /// /// [JsonInclude, JsonPropertyName("record_score")] public double RecordScore { get; init; } /// - /// Internal. This is always set to `record`. + /// + /// Internal. This is always set to record. + /// /// [JsonInclude, JsonPropertyName("result_type")] public string ResultType { get; init; } /// - /// The start time of the bucket for which these results were calculated. + /// + /// The start time of the bucket for which these results were calculated. + /// /// [JsonInclude, JsonPropertyName("timestamp")] public long Timestamp { get; init; } /// - /// The typical value for the bucket, according to analytical modeling. + /// + /// The typical value for the bucket, according to analytical modeling. + /// /// [JsonInclude, JsonPropertyName("typical")] public IReadOnlyCollection? Typical { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/AnomalyExplanation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/AnomalyExplanation.g.cs index 2bb7bd2a8bd..84be9c2d3c6 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/AnomalyExplanation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/AnomalyExplanation.g.cs @@ -30,61 +30,81 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class AnomalyExplanation { /// - /// Impact from the duration and magnitude of the detected anomaly relative to the historical average. + /// + /// Impact from the duration and magnitude of the detected anomaly relative to the historical average. + /// /// [JsonInclude, JsonPropertyName("anomaly_characteristics_impact")] public int? AnomalyCharacteristicsImpact { get; init; } /// - /// Length of the detected anomaly in the number of buckets. + /// + /// Length of the detected anomaly in the number of buckets. + /// /// [JsonInclude, JsonPropertyName("anomaly_length")] public int? AnomalyLength { get; init; } /// - /// Type of the detected anomaly: `spike` or `dip`. + /// + /// Type of the detected anomaly: spike or dip. + /// /// [JsonInclude, JsonPropertyName("anomaly_type")] public string? AnomalyType { get; init; } /// - /// Indicates reduction of anomaly score for the bucket with large confidence intervals. If a bucket has large confidence intervals, the score is reduced. + /// + /// Indicates reduction of anomaly score for the bucket with large confidence intervals. If a bucket has large confidence intervals, the score is reduced. + /// /// [JsonInclude, JsonPropertyName("high_variance_penalty")] public bool? HighVariancePenalty { get; init; } /// - /// If the bucket contains fewer samples than expected, the score is reduced. + /// + /// If the bucket contains fewer samples than expected, the score is reduced. + /// /// [JsonInclude, JsonPropertyName("incomplete_bucket_penalty")] public bool? IncompleteBucketPenalty { get; init; } /// - /// Lower bound of the 95% confidence interval. + /// + /// Lower bound of the 95% confidence interval. + /// /// [JsonInclude, JsonPropertyName("lower_confidence_bound")] public double? LowerConfidenceBound { get; init; } /// - /// Impact of the deviation between actual and typical values in the past 12 buckets. + /// + /// Impact of the deviation between actual and typical values in the past 12 buckets. + /// /// [JsonInclude, JsonPropertyName("multi_bucket_impact")] public int? MultiBucketImpact { get; init; } /// - /// Impact of the deviation between actual and typical values in the current bucket. + /// + /// Impact of the deviation between actual and typical values in the current bucket. + /// /// [JsonInclude, JsonPropertyName("single_bucket_impact")] public int? SingleBucketImpact { get; init; } /// - /// Typical (expected) value for this bucket. + /// + /// Typical (expected) value for this bucket. + /// /// [JsonInclude, JsonPropertyName("typical_value")] public double? TypicalValue { get; init; } /// - /// Upper bound of the 95% confidence interval. + /// + /// Upper bound of the 95% confidence interval. + /// /// [JsonInclude, JsonPropertyName("upper_confidence_bound")] public double? UpperConfidenceBound { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ApiKeyAuthorization.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ApiKeyAuthorization.g.cs index 409c1b875d0..642af49f7fa 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ApiKeyAuthorization.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ApiKeyAuthorization.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class ApiKeyAuthorization { /// - /// The identifier for the API key. + /// + /// The identifier for the API key. + /// /// [JsonInclude, JsonPropertyName("id")] public string Id { get; init; } /// - /// The name of the API key. + /// + /// The name of the API key. + /// /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/BucketInfluencer.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/BucketInfluencer.g.cs index 84cdea140d8..1cb782fb7fa 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/BucketInfluencer.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/BucketInfluencer.g.cs @@ -30,67 +30,93 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class BucketInfluencer { /// - /// A normalized score between 0-100, which is calculated for each bucket influencer. This score might be updated as
newer data is analyzed. + /// + /// A normalized score between 0-100, which is calculated for each bucket influencer. This score might be updated as + /// newer data is analyzed. + /// /// [JsonInclude, JsonPropertyName("anomaly_score")] public double AnomalyScore { get; init; } /// - /// The length of the bucket in seconds. This value matches the bucket span that is specified in the job. + /// + /// The length of the bucket in seconds. This value matches the bucket span that is specified in the job. + /// /// [JsonInclude, JsonPropertyName("bucket_span")] public long BucketSpan { get; init; } /// - /// The field name of the influencer. + /// + /// The field name of the influencer. + /// /// [JsonInclude, JsonPropertyName("influencer_field_name")] public string InfluencerFieldName { get; init; } /// - /// The score between 0-100 for each bucket influencer. This score is the initial value that was calculated at the
time the bucket was processed. + /// + /// The score between 0-100 for each bucket influencer. This score is the initial value that was calculated at the + /// time the bucket was processed. + /// /// [JsonInclude, JsonPropertyName("initial_anomaly_score")] public double InitialAnomalyScore { get; init; } /// - /// If true, this is an interim result. In other words, the results are calculated based on partial input data. + /// + /// If true, this is an interim result. In other words, the results are calculated based on partial input data. + /// /// [JsonInclude, JsonPropertyName("is_interim")] public bool IsInterim { get; init; } /// - /// Identifier for the anomaly detection job. + /// + /// Identifier for the anomaly detection job. + /// /// [JsonInclude, JsonPropertyName("job_id")] public string JobId { get; init; } /// - /// The probability that the bucket has this behavior, in the range 0 to 1. This value can be held to a high precision
of over 300 decimal places, so the `anomaly_score` is provided as a human-readable and friendly interpretation of
this. + /// + /// The probability that the bucket has this behavior, in the range 0 to 1. This value can be held to a high precision + /// of over 300 decimal places, so the anomaly_score is provided as a human-readable and friendly interpretation of + /// this. + /// /// [JsonInclude, JsonPropertyName("probability")] public double Probability { get; init; } /// - /// Internal. + /// + /// Internal. + /// /// [JsonInclude, JsonPropertyName("raw_anomaly_score")] public double RawAnomalyScore { get; init; } /// - /// Internal. This value is always set to `bucket_influencer`. + /// + /// Internal. This value is always set to bucket_influencer. + /// /// [JsonInclude, JsonPropertyName("result_type")] public string ResultType { get; init; } /// - /// The start time of the bucket for which these results were calculated. + /// + /// The start time of the bucket for which these results were calculated. + /// /// [JsonInclude, JsonPropertyName("timestamp")] public long Timestamp { get; init; } /// - /// The start time of the bucket for which these results were calculated. + /// + /// The start time of the bucket for which these results were calculated. + /// /// [JsonInclude, JsonPropertyName("timestamp_string")] public DateTimeOffset? TimestampString { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/BucketSummary.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/BucketSummary.g.cs index f4e8ca45f00..3b10161130f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/BucketSummary.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/BucketSummary.g.cs @@ -30,7 +30,11 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class BucketSummary { /// - /// The maximum anomaly score, between 0-100, for any of the bucket influencers. This is an overall, rate-limited
score for the job. All the anomaly records in the bucket contribute to this score. This value might be updated as
new data is analyzed. + /// + /// The maximum anomaly score, between 0-100, for any of the bucket influencers. This is an overall, rate-limited + /// score for the job. All the anomaly records in the bucket contribute to this score. This value might be updated as + /// new data is analyzed. + /// /// [JsonInclude, JsonPropertyName("anomaly_score")] public double AnomalyScore { get; init; } @@ -38,55 +42,76 @@ public sealed partial class BucketSummary public IReadOnlyCollection BucketInfluencers { get; init; } /// - /// The length of the bucket in seconds. This value matches the bucket span that is specified in the job. + /// + /// The length of the bucket in seconds. This value matches the bucket span that is specified in the job. + /// /// [JsonInclude, JsonPropertyName("bucket_span")] public long BucketSpan { get; init; } /// - /// The number of input data records processed in this bucket. + /// + /// The number of input data records processed in this bucket. + /// /// [JsonInclude, JsonPropertyName("event_count")] public long EventCount { get; init; } /// - /// The maximum anomaly score for any of the bucket influencers. This is the initial value that was calculated at the
time the bucket was processed. + /// + /// The maximum anomaly score for any of the bucket influencers. This is the initial value that was calculated at the + /// time the bucket was processed. + /// /// [JsonInclude, JsonPropertyName("initial_anomaly_score")] public double InitialAnomalyScore { get; init; } /// - /// If true, this is an interim result. In other words, the results are calculated based on partial input data. + /// + /// If true, this is an interim result. In other words, the results are calculated based on partial input data. + /// /// [JsonInclude, JsonPropertyName("is_interim")] public bool IsInterim { get; init; } /// - /// Identifier for the anomaly detection job. + /// + /// Identifier for the anomaly detection job. + /// /// [JsonInclude, JsonPropertyName("job_id")] public string JobId { get; init; } /// - /// The amount of time, in milliseconds, that it took to analyze the bucket contents and calculate results. + /// + /// The amount of time, in milliseconds, that it took to analyze the bucket contents and calculate results. + /// /// [JsonInclude, JsonPropertyName("processing_time_ms")] public long ProcessingTimeMs { get; init; } /// - /// Internal. This value is always set to bucket. + /// + /// Internal. This value is always set to bucket. + /// /// [JsonInclude, JsonPropertyName("result_type")] public string ResultType { get; init; } /// - /// The start time of the bucket. This timestamp uniquely identifies the bucket. Events that occur exactly at the
timestamp of the bucket are included in the results for the bucket. + /// + /// The start time of the bucket. This timestamp uniquely identifies the bucket. Events that occur exactly at the + /// timestamp of the bucket are included in the results for the bucket. + /// /// [JsonInclude, JsonPropertyName("timestamp")] public long Timestamp { get; init; } /// - /// The start time of the bucket. This timestamp uniquely identifies the bucket. Events that occur exactly at the
timestamp of the bucket are included in the results for the bucket. + /// + /// The start time of the bucket. This timestamp uniquely identifies the bucket. Events that occur exactly at the + /// timestamp of the bucket are included in the results for the bucket. + /// /// [JsonInclude, JsonPropertyName("timestamp_string")] public DateTimeOffset? TimestampString { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Calendar.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Calendar.g.cs index d578ac228b3..bd02e5c5c7a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Calendar.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Calendar.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class Calendar { /// - /// A string that uniquely identifies a calendar. + /// + /// A string that uniquely identifies a calendar. + /// /// [JsonInclude, JsonPropertyName("calendar_id")] public string CalendarId { get; init; } /// - /// A description of the calendar. + /// + /// A description of the calendar. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; init; } /// - /// An array of anomaly detection job identifiers. + /// + /// An array of anomaly detection job identifiers. + /// /// [JsonInclude, JsonPropertyName("job_ids")] public IReadOnlyCollection JobIds { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/CalendarEvent.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/CalendarEvent.g.cs index 4bfe895aacc..8b324a0c0c8 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/CalendarEvent.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/CalendarEvent.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class CalendarEvent { /// - /// A string that uniquely identifies a calendar. + /// + /// A string that uniquely identifies a calendar. + /// /// [JsonInclude, JsonPropertyName("calendar_id")] public Elastic.Clients.Elasticsearch.Serverless.Id? CalendarId { get; set; } /// - /// A description of the scheduled event. + /// + /// A description of the scheduled event. + /// /// [JsonInclude, JsonPropertyName("description")] public string Description { get; set; } /// - /// The timestamp for the end of the scheduled event in milliseconds since the epoch or ISO 8601 format. + /// + /// The timestamp for the end of the scheduled event in milliseconds since the epoch or ISO 8601 format. + /// /// [JsonInclude, JsonPropertyName("end_time")] public DateTimeOffset EndTime { get; set; } @@ -50,7 +56,9 @@ public sealed partial class CalendarEvent public Elastic.Clients.Elasticsearch.Serverless.Id? EventId { get; set; } /// - /// The timestamp for the beginning of the scheduled event in milliseconds since the epoch or ISO 8601 format. + /// + /// The timestamp for the beginning of the scheduled event in milliseconds since the epoch or ISO 8601 format. + /// /// [JsonInclude, JsonPropertyName("start_time")] public DateTimeOffset StartTime { get; set; } @@ -71,7 +79,9 @@ public CalendarEventDescriptor() : base() private DateTimeOffset StartTimeValue { get; set; } /// - /// A string that uniquely identifies a calendar. + /// + /// A string that uniquely identifies a calendar. + /// /// public CalendarEventDescriptor CalendarId(Elastic.Clients.Elasticsearch.Serverless.Id? calendarId) { @@ -80,7 +90,9 @@ public CalendarEventDescriptor CalendarId(Elastic.Clients.Elasticsearch.Serverle } /// - /// A description of the scheduled event. + /// + /// A description of the scheduled event. + /// /// public CalendarEventDescriptor Description(string description) { @@ -89,7 +101,9 @@ public CalendarEventDescriptor Description(string description) } /// - /// The timestamp for the end of the scheduled event in milliseconds since the epoch or ISO 8601 format. + /// + /// The timestamp for the end of the scheduled event in milliseconds since the epoch or ISO 8601 format. + /// /// public CalendarEventDescriptor EndTime(DateTimeOffset endTime) { @@ -104,7 +118,9 @@ public CalendarEventDescriptor EventId(Elastic.Clients.Elasticsearch.Serverless. } /// - /// The timestamp for the beginning of the scheduled event in milliseconds since the epoch or ISO 8601 format. + /// + /// The timestamp for the beginning of the scheduled event in milliseconds since the epoch or ISO 8601 format. + /// /// public CalendarEventDescriptor StartTime(DateTimeOffset startTime) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/CategorizationAnalyzerDefinition.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/CategorizationAnalyzerDefinition.g.cs index 6df4cbe848b..f52a8cc6d7a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/CategorizationAnalyzerDefinition.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/CategorizationAnalyzerDefinition.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class CategorizationAnalyzerDefinition { /// - /// One or more character filters. In addition to the built-in character filters, other plugins can provide more character filters. If this property is not specified, no character filters are applied prior to categorization. If you are customizing some other aspect of the analyzer and you need to achieve the equivalent of `categorization_filters` (which are not permitted when some other aspect of the analyzer is customized), add them here as pattern replace character filters. + /// + /// One or more character filters. In addition to the built-in character filters, other plugins can provide more character filters. If this property is not specified, no character filters are applied prior to categorization. If you are customizing some other aspect of the analyzer and you need to achieve the equivalent of categorization_filters (which are not permitted when some other aspect of the analyzer is customized), add them here as pattern replace character filters. + /// /// [JsonInclude, JsonPropertyName("char_filter")] public ICollection? CharFilter { get; set; } /// - /// One or more token filters. In addition to the built-in token filters, other plugins can provide more token filters. If this property is not specified, no token filters are applied prior to categorization. + /// + /// One or more token filters. In addition to the built-in token filters, other plugins can provide more token filters. If this property is not specified, no token filters are applied prior to categorization. + /// /// [JsonInclude, JsonPropertyName("filter")] public ICollection? Filter { get; set; } /// - /// The name or definition of the tokenizer to use after character filters are applied. This property is compulsory if `categorization_analyzer` is specified as an object. Machine learning provides a tokenizer called `ml_standard` that tokenizes in a way that has been determined to produce good categorization results on a variety of log file formats for logs in English. If you want to use that tokenizer but change the character or token filters, specify "tokenizer": "ml_standard" in your `categorization_analyzer`. Additionally, the `ml_classic` tokenizer is available, which tokenizes in the same way as the non-customizable tokenizer in old versions of the product (before 6.2). `ml_classic` was the default categorization tokenizer in versions 6.2 to 7.13, so if you need categorization identical to the default for jobs created in these versions, specify "tokenizer": "ml_classic" in your `categorization_analyzer`. + /// + /// The name or definition of the tokenizer to use after character filters are applied. This property is compulsory if categorization_analyzer is specified as an object. Machine learning provides a tokenizer called ml_standard that tokenizes in a way that has been determined to produce good categorization results on a variety of log file formats for logs in English. If you want to use that tokenizer but change the character or token filters, specify "tokenizer": "ml_standard" in your categorization_analyzer. Additionally, the ml_classic tokenizer is available, which tokenizes in the same way as the non-customizable tokenizer in old versions of the product (before 6.2). ml_classic was the default categorization tokenizer in versions 6.2 to 7.13, so if you need categorization identical to the default for jobs created in these versions, specify "tokenizer": "ml_classic" in your categorization_analyzer. + /// /// [JsonInclude, JsonPropertyName("tokenizer")] public Elastic.Clients.Elasticsearch.Serverless.Analysis.ITokenizer? Tokenizer { get; set; } @@ -61,7 +67,9 @@ public CategorizationAnalyzerDefinitionDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Analysis.ITokenizer? TokenizerValue { get; set; } /// - /// One or more character filters. In addition to the built-in character filters, other plugins can provide more character filters. If this property is not specified, no character filters are applied prior to categorization. If you are customizing some other aspect of the analyzer and you need to achieve the equivalent of `categorization_filters` (which are not permitted when some other aspect of the analyzer is customized), add them here as pattern replace character filters. + /// + /// One or more character filters. In addition to the built-in character filters, other plugins can provide more character filters. If this property is not specified, no character filters are applied prior to categorization. If you are customizing some other aspect of the analyzer and you need to achieve the equivalent of categorization_filters (which are not permitted when some other aspect of the analyzer is customized), add them here as pattern replace character filters. + /// /// public CategorizationAnalyzerDefinitionDescriptor CharFilter(ICollection? charFilter) { @@ -70,7 +78,9 @@ public CategorizationAnalyzerDefinitionDescriptor CharFilter(ICollection - /// One or more token filters. In addition to the built-in token filters, other plugins can provide more token filters. If this property is not specified, no token filters are applied prior to categorization. + /// + /// One or more token filters. In addition to the built-in token filters, other plugins can provide more token filters. If this property is not specified, no token filters are applied prior to categorization. + /// /// public CategorizationAnalyzerDefinitionDescriptor Filter(ICollection? filter) { @@ -79,7 +89,9 @@ public CategorizationAnalyzerDefinitionDescriptor Filter(ICollection - /// The name or definition of the tokenizer to use after character filters are applied. This property is compulsory if `categorization_analyzer` is specified as an object. Machine learning provides a tokenizer called `ml_standard` that tokenizes in a way that has been determined to produce good categorization results on a variety of log file formats for logs in English. If you want to use that tokenizer but change the character or token filters, specify "tokenizer": "ml_standard" in your `categorization_analyzer`. Additionally, the `ml_classic` tokenizer is available, which tokenizes in the same way as the non-customizable tokenizer in old versions of the product (before 6.2). `ml_classic` was the default categorization tokenizer in versions 6.2 to 7.13, so if you need categorization identical to the default for jobs created in these versions, specify "tokenizer": "ml_classic" in your `categorization_analyzer`. + /// + /// The name or definition of the tokenizer to use after character filters are applied. This property is compulsory if categorization_analyzer is specified as an object. Machine learning provides a tokenizer called ml_standard that tokenizes in a way that has been determined to produce good categorization results on a variety of log file formats for logs in English. If you want to use that tokenizer but change the character or token filters, specify "tokenizer": "ml_standard" in your categorization_analyzer. Additionally, the ml_classic tokenizer is available, which tokenizes in the same way as the non-customizable tokenizer in old versions of the product (before 6.2). ml_classic was the default categorization tokenizer in versions 6.2 to 7.13, so if you need categorization identical to the default for jobs created in these versions, specify "tokenizer": "ml_classic" in your categorization_analyzer. + /// /// public CategorizationAnalyzerDefinitionDescriptor Tokenizer(Elastic.Clients.Elasticsearch.Serverless.Analysis.ITokenizer? tokenizer) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Category.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Category.g.cs index 30652bb6617..6dc0faf00f2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Category.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Category.g.cs @@ -30,31 +30,41 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class Category { /// - /// A unique identifier for the category. category_id is unique at the job level, even when per-partition categorization is enabled. + /// + /// A unique identifier for the category. category_id is unique at the job level, even when per-partition categorization is enabled. + /// /// [JsonInclude, JsonPropertyName("category_id")] public long CategoryId { get; init; } /// - /// A list of examples of actual values that matched the category. + /// + /// A list of examples of actual values that matched the category. + /// /// [JsonInclude, JsonPropertyName("examples")] public IReadOnlyCollection Examples { get; init; } /// - /// [experimental] A Grok pattern that could be used in Logstash or an ingest pipeline to extract fields from messages that match the category. This field is experimental and may be changed or removed in a future release. The Grok patterns that are found are not optimal, but are often a good starting point for manual tweaking. + /// + /// [experimental] A Grok pattern that could be used in Logstash or an ingest pipeline to extract fields from messages that match the category. This field is experimental and may be changed or removed in a future release. The Grok patterns that are found are not optimal, but are often a good starting point for manual tweaking. + /// /// [JsonInclude, JsonPropertyName("grok_pattern")] public string? GrokPattern { get; init; } /// - /// Identifier for the anomaly detection job. + /// + /// Identifier for the anomaly detection job. + /// /// [JsonInclude, JsonPropertyName("job_id")] public string JobId { get; init; } /// - /// The maximum length of the fields that matched the category. The value is increased by 10% to enable matching for similar fields that have not been analyzed. + /// + /// The maximum length of the fields that matched the category. The value is increased by 10% to enable matching for similar fields that have not been analyzed. + /// /// [JsonInclude, JsonPropertyName("max_matching_length")] public long MaxMatchingLength { get; init; } @@ -62,7 +72,9 @@ public sealed partial class Category public string Mlcategory { get; init; } /// - /// The number of messages that have been matched by this category. This is only guaranteed to have the latest accurate count after a job _flush or _close + /// + /// The number of messages that have been matched by this category. This is only guaranteed to have the latest accurate count after a job _flush or _close + /// /// [JsonInclude, JsonPropertyName("num_matches")] public long? NumMatches { get; init; } @@ -70,25 +82,33 @@ public sealed partial class Category public string? p { get; init; } /// - /// If per-partition categorization is enabled, this property identifies the field used to segment the categorization. It is not present when per-partition categorization is disabled. + /// + /// If per-partition categorization is enabled, this property identifies the field used to segment the categorization. It is not present when per-partition categorization is disabled. + /// /// [JsonInclude, JsonPropertyName("partition_field_name")] public string? PartitionFieldName { get; init; } /// - /// If per-partition categorization is enabled, this property identifies the value of the partition_field_name for the category. It is not present when per-partition categorization is disabled. + /// + /// If per-partition categorization is enabled, this property identifies the value of the partition_field_name for the category. It is not present when per-partition categorization is disabled. + /// /// [JsonInclude, JsonPropertyName("partition_field_value")] public string? PartitionFieldValue { get; init; } /// - /// A list of category_id entries that this current category encompasses. Any new message that is processed by the categorizer will match against this category and not any of the categories in this list. This is only guaranteed to have the latest accurate list of categories after a job _flush or _close + /// + /// A list of category_id entries that this current category encompasses. Any new message that is processed by the categorizer will match against this category and not any of the categories in this list. This is only guaranteed to have the latest accurate list of categories after a job _flush or _close + /// /// [JsonInclude, JsonPropertyName("preferred_to_categories")] public IReadOnlyCollection? PreferredToCategories { get; init; } /// - /// A regular expression that is used to search for values that match the category. + /// + /// A regular expression that is used to search for values that match the category. + /// /// [JsonInclude, JsonPropertyName("regex")] public string Regex { get; init; } @@ -96,7 +116,9 @@ public sealed partial class Category public string ResultType { get; init; } /// - /// A space separated list of the common tokens that are matched in values of the category. + /// + /// A space separated list of the common tokens that are matched in values of the category. + /// /// [JsonInclude, JsonPropertyName("terms")] public string Terms { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ChunkingConfig.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ChunkingConfig.g.cs index 6e357a87fd1..06f570ede5a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ChunkingConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ChunkingConfig.g.cs @@ -30,13 +30,20 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class ChunkingConfig { /// - /// If the mode is `auto`, the chunk size is dynamically calculated;
this is the recommended value when the datafeed does not use aggregations.
If the mode is `manual`, chunking is applied according to the specified `time_span`;
use this mode when the datafeed uses aggregations. If the mode is `off`, no chunking is applied. + /// + /// If the mode is auto, the chunk size is dynamically calculated; + /// this is the recommended value when the datafeed does not use aggregations. + /// If the mode is manual, chunking is applied according to the specified time_span; + /// use this mode when the datafeed uses aggregations. If the mode is off, no chunking is applied. + /// /// [JsonInclude, JsonPropertyName("mode")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ChunkingMode Mode { get; set; } /// - /// The time span that each search will be querying. This setting is applicable only when the `mode` is set to `manual`. + /// + /// The time span that each search will be querying. This setting is applicable only when the mode is set to manual. + /// /// [JsonInclude, JsonPropertyName("time_span")] public Elastic.Clients.Elasticsearch.Serverless.Duration? TimeSpan { get; set; } @@ -54,7 +61,12 @@ public ChunkingConfigDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Duration? TimeSpanValue { get; set; } /// - /// If the mode is `auto`, the chunk size is dynamically calculated;
this is the recommended value when the datafeed does not use aggregations.
If the mode is `manual`, chunking is applied according to the specified `time_span`;
use this mode when the datafeed uses aggregations. If the mode is `off`, no chunking is applied. + /// + /// If the mode is auto, the chunk size is dynamically calculated; + /// this is the recommended value when the datafeed does not use aggregations. + /// If the mode is manual, chunking is applied according to the specified time_span; + /// use this mode when the datafeed uses aggregations. If the mode is off, no chunking is applied. + /// /// public ChunkingConfigDescriptor Mode(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ChunkingMode mode) { @@ -63,7 +75,9 @@ public ChunkingConfigDescriptor Mode(Elastic.Clients.Elasticsearch.Serverless.Ma } /// - /// The time span that each search will be querying. This setting is applicable only when the `mode` is set to `manual`. + /// + /// The time span that each search will be querying. This setting is applicable only when the mode is set to manual. + /// /// public ChunkingConfigDescriptor TimeSpan(Elastic.Clients.Elasticsearch.Serverless.Duration? timeSpan) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ClassificationInferenceOptions.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ClassificationInferenceOptions.g.cs index 5b046caf518..abd1deaa9f6 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ClassificationInferenceOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ClassificationInferenceOptions.g.cs @@ -30,31 +30,41 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class ClassificationInferenceOptions { /// - /// Specifies the number of top class predictions to return. Defaults to 0. + /// + /// Specifies the number of top class predictions to return. Defaults to 0. + /// /// [JsonInclude, JsonPropertyName("num_top_classes")] public int? NumTopClasses { get; set; } /// - /// Specifies the maximum number of feature importance values per document. + /// + /// Specifies the maximum number of feature importance values per document. + /// /// [JsonInclude, JsonPropertyName("num_top_feature_importance_values")] public int? NumTopFeatureImportanceValues { get; set; } /// - /// Specifies the type of the predicted field to write. Acceptable values are: string, number, boolean. When boolean is provided 1.0 is transformed to true and 0.0 to false. + /// + /// Specifies the type of the predicted field to write. Acceptable values are: string, number, boolean. When boolean is provided 1.0 is transformed to true and 0.0 to false. + /// /// [JsonInclude, JsonPropertyName("prediction_field_type")] public string? PredictionFieldType { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } /// - /// Specifies the field to which the top classes are written. Defaults to top_classes. + /// + /// Specifies the field to which the top classes are written. Defaults to top_classes. + /// /// [JsonInclude, JsonPropertyName("top_classes_results_field")] public string? TopClassesResultsField { get; set; } @@ -79,7 +89,9 @@ public ClassificationInferenceOptionsDescriptor() : base() private string? TopClassesResultsFieldValue { get; set; } /// - /// Specifies the number of top class predictions to return. Defaults to 0. + /// + /// Specifies the number of top class predictions to return. Defaults to 0. + /// /// public ClassificationInferenceOptionsDescriptor NumTopClasses(int? numTopClasses) { @@ -88,7 +100,9 @@ public ClassificationInferenceOptionsDescriptor NumTopClasses(int? numTopClasses } /// - /// Specifies the maximum number of feature importance values per document. + /// + /// Specifies the maximum number of feature importance values per document. + /// /// public ClassificationInferenceOptionsDescriptor NumTopFeatureImportanceValues(int? numTopFeatureImportanceValues) { @@ -97,7 +111,9 @@ public ClassificationInferenceOptionsDescriptor NumTopFeatureImportanceValues(in } /// - /// Specifies the type of the predicted field to write. Acceptable values are: string, number, boolean. When boolean is provided 1.0 is transformed to true and 0.0 to false. + /// + /// Specifies the type of the predicted field to write. Acceptable values are: string, number, boolean. When boolean is provided 1.0 is transformed to true and 0.0 to false. + /// /// public ClassificationInferenceOptionsDescriptor PredictionFieldType(string? predictionFieldType) { @@ -106,7 +122,9 @@ public ClassificationInferenceOptionsDescriptor PredictionFieldType(string? pred } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public ClassificationInferenceOptionsDescriptor ResultsField(string? resultsField) { @@ -115,7 +133,9 @@ public ClassificationInferenceOptionsDescriptor ResultsField(string? resultsFiel } /// - /// Specifies the field to which the top classes are written. Defaults to top_classes. + /// + /// Specifies the field to which the top classes are written. Defaults to top_classes. + /// /// public ClassificationInferenceOptionsDescriptor TopClassesResultsField(string? topClassesResultsField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ConfusionMatrixThreshold.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ConfusionMatrixThreshold.g.cs index 4a614bc7a97..3157696095f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ConfusionMatrixThreshold.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ConfusionMatrixThreshold.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class ConfusionMatrixThreshold { /// - /// False Negative + /// + /// False Negative + /// /// [JsonInclude, JsonPropertyName("fn")] public int FalseNegative { get; init; } /// - /// False Positive + /// + /// False Positive + /// /// [JsonInclude, JsonPropertyName("fp")] public int FalsePositive { get; init; } /// - /// True Negative + /// + /// True Negative + /// /// [JsonInclude, JsonPropertyName("tn")] public int TrueNegative { get; init; } /// - /// True Positive + /// + /// True Positive + /// /// [JsonInclude, JsonPropertyName("tp")] public int TruePositive { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataDescription.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataDescription.g.cs index defc3f4ed54..8fb2f89e752 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataDescription.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataDescription.g.cs @@ -33,19 +33,25 @@ public sealed partial class DataDescription public string? FieldDelimiter { get; set; } /// - /// Only JSON format is supported at this time. + /// + /// Only JSON format is supported at this time. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// The name of the field that contains the timestamp. + /// + /// The name of the field that contains the timestamp. + /// /// [JsonInclude, JsonPropertyName("time_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? TimeField { get; set; } /// - /// The time format, which can be `epoch`, `epoch_ms`, or a custom pattern. The value `epoch` refers to UNIX or Epoch time (the number of seconds since 1 Jan 1970). The value `epoch_ms` indicates that time is measured in milliseconds since the epoch. The `epoch` and `epoch_ms` time formats accept either integer or real values. Custom patterns must conform to the Java DateTimeFormatter class. When you use date-time formatting patterns, it is recommended that you provide the full date, time and time zone. For example: `yyyy-MM-dd'T'HH:mm:ssX`. If the pattern that you specify is not sufficient to produce a complete timestamp, job creation fails. + /// + /// The time format, which can be epoch, epoch_ms, or a custom pattern. The value epoch refers to UNIX or Epoch time (the number of seconds since 1 Jan 1970). The value epoch_ms indicates that time is measured in milliseconds since the epoch. The epoch and epoch_ms time formats accept either integer or real values. Custom patterns must conform to the Java DateTimeFormatter class. When you use date-time formatting patterns, it is recommended that you provide the full date, time and time zone. For example: yyyy-MM-dd'T'HH:mm:ssX. If the pattern that you specify is not sufficient to produce a complete timestamp, job creation fails. + /// /// [JsonInclude, JsonPropertyName("time_format")] public string? TimeFormat { get; set; } @@ -71,7 +77,9 @@ public DataDescriptionDescriptor FieldDelimiter(string? fieldDelimite } /// - /// Only JSON format is supported at this time. + /// + /// Only JSON format is supported at this time. + /// /// public DataDescriptionDescriptor Format(string? format) { @@ -80,7 +88,9 @@ public DataDescriptionDescriptor Format(string? format) } /// - /// The name of the field that contains the timestamp. + /// + /// The name of the field that contains the timestamp. + /// /// public DataDescriptionDescriptor TimeField(Elastic.Clients.Elasticsearch.Serverless.Field? timeField) { @@ -89,7 +99,9 @@ public DataDescriptionDescriptor TimeField(Elastic.Clients.Elasticsea } /// - /// The name of the field that contains the timestamp. + /// + /// The name of the field that contains the timestamp. + /// /// public DataDescriptionDescriptor TimeField(Expression> timeField) { @@ -98,7 +110,9 @@ public DataDescriptionDescriptor TimeField(Expression - /// The name of the field that contains the timestamp. + /// + /// The name of the field that contains the timestamp. + /// /// public DataDescriptionDescriptor TimeField(Expression> timeField) { @@ -107,7 +121,9 @@ public DataDescriptionDescriptor TimeField(Expression - /// The time format, which can be `epoch`, `epoch_ms`, or a custom pattern. The value `epoch` refers to UNIX or Epoch time (the number of seconds since 1 Jan 1970). The value `epoch_ms` indicates that time is measured in milliseconds since the epoch. The `epoch` and `epoch_ms` time formats accept either integer or real values. Custom patterns must conform to the Java DateTimeFormatter class. When you use date-time formatting patterns, it is recommended that you provide the full date, time and time zone. For example: `yyyy-MM-dd'T'HH:mm:ssX`. If the pattern that you specify is not sufficient to produce a complete timestamp, job creation fails. + /// + /// The time format, which can be epoch, epoch_ms, or a custom pattern. The value epoch refers to UNIX or Epoch time (the number of seconds since 1 Jan 1970). The value epoch_ms indicates that time is measured in milliseconds since the epoch. The epoch and epoch_ms time formats accept either integer or real values. Custom patterns must conform to the Java DateTimeFormatter class. When you use date-time formatting patterns, it is recommended that you provide the full date, time and time zone. For example: yyyy-MM-dd'T'HH:mm:ssX. If the pattern that you specify is not sufficient to produce a complete timestamp, job creation fails. + /// /// public DataDescriptionDescriptor TimeFormat(string? timeFormat) { @@ -166,7 +182,9 @@ public DataDescriptionDescriptor FieldDelimiter(string? fieldDelimiter) } /// - /// Only JSON format is supported at this time. + /// + /// Only JSON format is supported at this time. + /// /// public DataDescriptionDescriptor Format(string? format) { @@ -175,7 +193,9 @@ public DataDescriptionDescriptor Format(string? format) } /// - /// The name of the field that contains the timestamp. + /// + /// The name of the field that contains the timestamp. + /// /// public DataDescriptionDescriptor TimeField(Elastic.Clients.Elasticsearch.Serverless.Field? timeField) { @@ -184,7 +204,9 @@ public DataDescriptionDescriptor TimeField(Elastic.Clients.Elasticsearch.Serverl } /// - /// The name of the field that contains the timestamp. + /// + /// The name of the field that contains the timestamp. + /// /// public DataDescriptionDescriptor TimeField(Expression> timeField) { @@ -193,7 +215,9 @@ public DataDescriptionDescriptor TimeField(Expression - /// The name of the field that contains the timestamp. + /// + /// The name of the field that contains the timestamp. + /// /// public DataDescriptionDescriptor TimeField(Expression> timeField) { @@ -202,7 +226,9 @@ public DataDescriptionDescriptor TimeField(Expression - /// The time format, which can be `epoch`, `epoch_ms`, or a custom pattern. The value `epoch` refers to UNIX or Epoch time (the number of seconds since 1 Jan 1970). The value `epoch_ms` indicates that time is measured in milliseconds since the epoch. The `epoch` and `epoch_ms` time formats accept either integer or real values. Custom patterns must conform to the Java DateTimeFormatter class. When you use date-time formatting patterns, it is recommended that you provide the full date, time and time zone. For example: `yyyy-MM-dd'T'HH:mm:ssX`. If the pattern that you specify is not sufficient to produce a complete timestamp, job creation fails. + /// + /// The time format, which can be epoch, epoch_ms, or a custom pattern. The value epoch refers to UNIX or Epoch time (the number of seconds since 1 Jan 1970). The value epoch_ms indicates that time is measured in milliseconds since the epoch. The epoch and epoch_ms time formats accept either integer or real values. Custom patterns must conform to the Java DateTimeFormatter class. When you use date-time formatting patterns, it is recommended that you provide the full date, time and time zone. For example: yyyy-MM-dd'T'HH:mm:ssX. If the pattern that you specify is not sufficient to produce a complete timestamp, job creation fails. + /// /// public DataDescriptionDescriptor TimeFormat(string? timeFormat) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Datafeed.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Datafeed.g.cs index e21491fe9e0..2b8886a2e00 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Datafeed.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Datafeed.g.cs @@ -167,7 +167,9 @@ public sealed partial class Datafeed public IReadOnlyDictionary? Aggregations { get; init; } /// - /// The security privileges that the datafeed uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the datafeed, this property is omitted. + /// + /// The security privileges that the datafeed uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the datafeed, this property is omitted. + /// /// public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DatafeedAuthorization? Authorization { get; init; } public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ChunkingConfig? ChunkingConfig { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DatafeedAuthorization.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DatafeedAuthorization.g.cs index efa867d2bb8..b2fdee79f2e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DatafeedAuthorization.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DatafeedAuthorization.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DatafeedAuthorization { /// - /// If an API key was used for the most recent update to the datafeed, its name and identifier are listed in the response. + /// + /// If an API key was used for the most recent update to the datafeed, its name and identifier are listed in the response. + /// /// [JsonInclude, JsonPropertyName("api_key")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ApiKeyAuthorization? ApiKey { get; init; } /// - /// If a user ID was used for the most recent update to the datafeed, its roles at the time of the update are listed in the response. + /// + /// If a user ID was used for the most recent update to the datafeed, its roles at the time of the update are listed in the response. + /// /// [JsonInclude, JsonPropertyName("roles")] public IReadOnlyCollection? Roles { get; init; } /// - /// If a service account was used for the most recent update to the datafeed, the account name is listed in the response. + /// + /// If a service account was used for the most recent update to the datafeed, the account name is listed in the response. + /// /// [JsonInclude, JsonPropertyName("service_account")] public string? ServiceAccount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DatafeedConfig.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DatafeedConfig.g.cs index ed5be0c5db0..fabe268dcb2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DatafeedConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DatafeedConfig.g.cs @@ -223,68 +223,94 @@ public override void Write(Utf8JsonWriter writer, DatafeedConfig value, JsonSeri public sealed partial class DatafeedConfig { /// - /// If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data. + /// + /// If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data. + /// /// public IDictionary? Aggregations { get; set; } /// - /// Datafeeds might be required to search over long time periods, for several months or years. This search is split into time chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of these time chunks are calculated and is an advanced configuration option. + /// + /// Datafeeds might be required to search over long time periods, for several months or years. This search is split into time chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of these time chunks are calculated and is an advanced configuration option. + /// /// public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ChunkingConfig? ChunkingConfig { get; set; } /// - /// A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. The default value is the job identifier. + /// + /// A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. The default value is the job identifier. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Id? DatafeedId { get; set; } /// - /// Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally search over indices that have already been read in an effort to determine whether any data has subsequently been added to the index. If missing data is found, it is a good indication that the `query_delay` option is set too low and the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time datafeeds. + /// + /// Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally search over indices that have already been read in an effort to determine whether any data has subsequently been added to the index. If missing data is found, it is a good indication that the query_delay option is set too low and the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time datafeeds. + /// /// public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DelayedDataCheckConfig? DelayedDataCheckConfig { get; set; } /// - /// The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. For example: `150s`. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation. + /// + /// The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. For example: 150s. When frequency is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? Frequency { get; set; } /// - /// An array of index names. Wildcards are supported. If any indices are in remote clusters, the machine learning nodes must have the `remote_cluster_client` role. + /// + /// An array of index names. Wildcards are supported. If any indices are in remote clusters, the machine learning nodes must have the remote_cluster_client role. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Indices? Indices { get; set; } /// - /// Specifies index expansion options that are used during search. + /// + /// Specifies index expansion options that are used during search. + /// /// public Elastic.Clients.Elasticsearch.Serverless.IndicesOptions? IndicesOptions { get; set; } public Elastic.Clients.Elasticsearch.Serverless.Id? JobId { get; set; } /// - /// If a real-time datafeed has never seen any data (including during any initial training period) then it will automatically stop itself and close its associated job after this many real-time searches that return no documents. In other words, it will stop after `frequency` times `max_empty_searches` of real-time operation. If not set then a datafeed with no end time that sees no data will remain started until it is explicitly stopped. + /// + /// If a real-time datafeed has never seen any data (including during any initial training period) then it will automatically stop itself and close its associated job after this many real-time searches that return no documents. In other words, it will stop after frequency times max_empty_searches of real-time operation. If not set then a datafeed with no end time that sees no data will remain started until it is explicitly stopped. + /// /// public int? MaxEmptySearches { get; set; } /// - /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. + /// + /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. + /// /// public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? Query { get; set; } /// - /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default value is randomly selected between `60s` and `120s`. This randomness improves the query performance when there are multiple jobs running on the same node. + /// + /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default value is randomly selected between 60s and 120s. This randomness improves the query performance when there are multiple jobs running on the same node. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Duration? QueryDelay { get; set; } /// - /// Specifies runtime fields for the datafeed search. + /// + /// Specifies runtime fields for the datafeed search. + /// /// public IDictionary? RuntimeMappings { get; set; } /// - /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. The detector configuration objects in a job can contain functions that use these script fields. + /// + /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. The detector configuration objects in a job can contain functions that use these script fields. + /// /// public IDictionary? ScriptFields { get; set; } /// - /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. The maximum value is the value of `index.max_result_window`, which is 10,000 by default. + /// + /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. The maximum value is the value of index.max_result_window, which is 10,000 by default. + /// /// public int? ScrollSize { get; set; } } @@ -321,7 +347,9 @@ public DatafeedConfigDescriptor() : base() private int? ScrollSizeValue { get; set; } /// - /// If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data. + /// + /// If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data. + /// /// public DatafeedConfigDescriptor Aggregations(Func>, FluentDescriptorDictionary>> selector) { @@ -330,7 +358,9 @@ public DatafeedConfigDescriptor Aggregations(Func - /// Datafeeds might be required to search over long time periods, for several months or years. This search is split into time chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of these time chunks are calculated and is an advanced configuration option. + /// + /// Datafeeds might be required to search over long time periods, for several months or years. This search is split into time chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of these time chunks are calculated and is an advanced configuration option. + /// /// public DatafeedConfigDescriptor ChunkingConfig(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ChunkingConfig? chunkingConfig) { @@ -357,7 +387,9 @@ public DatafeedConfigDescriptor ChunkingConfig(Action - /// A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. The default value is the job identifier. + /// + /// A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. The default value is the job identifier. + /// /// public DatafeedConfigDescriptor DatafeedId(Elastic.Clients.Elasticsearch.Serverless.Id? datafeedId) { @@ -366,7 +398,9 @@ public DatafeedConfigDescriptor DatafeedId(Elastic.Clients.Elasticsea } /// - /// Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally search over indices that have already been read in an effort to determine whether any data has subsequently been added to the index. If missing data is found, it is a good indication that the `query_delay` option is set too low and the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time datafeeds. + /// + /// Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally search over indices that have already been read in an effort to determine whether any data has subsequently been added to the index. If missing data is found, it is a good indication that the query_delay option is set too low and the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time datafeeds. + /// /// public DatafeedConfigDescriptor DelayedDataCheckConfig(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DelayedDataCheckConfig? delayedDataCheckConfig) { @@ -393,7 +427,9 @@ public DatafeedConfigDescriptor DelayedDataCheckConfig(Action - /// The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. For example: `150s`. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation. + /// + /// The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. For example: 150s. When frequency is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation. + /// /// public DatafeedConfigDescriptor Frequency(Elastic.Clients.Elasticsearch.Serverless.Duration? frequency) { @@ -402,7 +438,9 @@ public DatafeedConfigDescriptor Frequency(Elastic.Clients.Elasticsear } /// - /// An array of index names. Wildcards are supported. If any indices are in remote clusters, the machine learning nodes must have the `remote_cluster_client` role. + /// + /// An array of index names. Wildcards are supported. If any indices are in remote clusters, the machine learning nodes must have the remote_cluster_client role. + /// /// public DatafeedConfigDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.Indices? indices) { @@ -411,7 +449,9 @@ public DatafeedConfigDescriptor Indices(Elastic.Clients.Elasticsearch } /// - /// Specifies index expansion options that are used during search. + /// + /// Specifies index expansion options that are used during search. + /// /// public DatafeedConfigDescriptor IndicesOptions(Elastic.Clients.Elasticsearch.Serverless.IndicesOptions? indicesOptions) { @@ -444,7 +484,9 @@ public DatafeedConfigDescriptor JobId(Elastic.Clients.Elasticsearch.S } /// - /// If a real-time datafeed has never seen any data (including during any initial training period) then it will automatically stop itself and close its associated job after this many real-time searches that return no documents. In other words, it will stop after `frequency` times `max_empty_searches` of real-time operation. If not set then a datafeed with no end time that sees no data will remain started until it is explicitly stopped. + /// + /// If a real-time datafeed has never seen any data (including during any initial training period) then it will automatically stop itself and close its associated job after this many real-time searches that return no documents. In other words, it will stop after frequency times max_empty_searches of real-time operation. If not set then a datafeed with no end time that sees no data will remain started until it is explicitly stopped. + /// /// public DatafeedConfigDescriptor MaxEmptySearches(int? maxEmptySearches) { @@ -453,7 +495,9 @@ public DatafeedConfigDescriptor MaxEmptySearches(int? maxEmptySearche } /// - /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. + /// + /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. + /// /// public DatafeedConfigDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -480,7 +524,9 @@ public DatafeedConfigDescriptor Query(Action - /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default value is randomly selected between `60s` and `120s`. This randomness improves the query performance when there are multiple jobs running on the same node. + /// + /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default value is randomly selected between 60s and 120s. This randomness improves the query performance when there are multiple jobs running on the same node. + /// /// public DatafeedConfigDescriptor QueryDelay(Elastic.Clients.Elasticsearch.Serverless.Duration? queryDelay) { @@ -489,7 +535,9 @@ public DatafeedConfigDescriptor QueryDelay(Elastic.Clients.Elasticsea } /// - /// Specifies runtime fields for the datafeed search. + /// + /// Specifies runtime fields for the datafeed search. + /// /// public DatafeedConfigDescriptor RuntimeMappings(Func>, FluentDescriptorDictionary>> selector) { @@ -498,7 +546,9 @@ public DatafeedConfigDescriptor RuntimeMappings(Func - /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. The detector configuration objects in a job can contain functions that use these script fields. + /// + /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. The detector configuration objects in a job can contain functions that use these script fields. + /// /// public DatafeedConfigDescriptor ScriptFields(Func, FluentDescriptorDictionary> selector) { @@ -507,7 +557,9 @@ public DatafeedConfigDescriptor ScriptFields(Func - /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. The maximum value is the value of `index.max_result_window`, which is 10,000 by default. + /// + /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. The maximum value is the value of index.max_result_window, which is 10,000 by default. + /// /// public DatafeedConfigDescriptor ScrollSize(int? scrollSize) { @@ -678,7 +730,9 @@ public DatafeedConfigDescriptor() : base() private int? ScrollSizeValue { get; set; } /// - /// If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data. + /// + /// If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data. + /// /// public DatafeedConfigDescriptor Aggregations(Func, FluentDescriptorDictionary> selector) { @@ -687,7 +741,9 @@ public DatafeedConfigDescriptor Aggregations(Func - /// Datafeeds might be required to search over long time periods, for several months or years. This search is split into time chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of these time chunks are calculated and is an advanced configuration option. + /// + /// Datafeeds might be required to search over long time periods, for several months or years. This search is split into time chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of these time chunks are calculated and is an advanced configuration option. + /// /// public DatafeedConfigDescriptor ChunkingConfig(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ChunkingConfig? chunkingConfig) { @@ -714,7 +770,9 @@ public DatafeedConfigDescriptor ChunkingConfig(Action - /// A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. The default value is the job identifier. + /// + /// A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. The default value is the job identifier. + /// /// public DatafeedConfigDescriptor DatafeedId(Elastic.Clients.Elasticsearch.Serverless.Id? datafeedId) { @@ -723,7 +781,9 @@ public DatafeedConfigDescriptor DatafeedId(Elastic.Clients.Elasticsearch.Serverl } /// - /// Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally search over indices that have already been read in an effort to determine whether any data has subsequently been added to the index. If missing data is found, it is a good indication that the `query_delay` option is set too low and the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time datafeeds. + /// + /// Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally search over indices that have already been read in an effort to determine whether any data has subsequently been added to the index. If missing data is found, it is a good indication that the query_delay option is set too low and the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time datafeeds. + /// /// public DatafeedConfigDescriptor DelayedDataCheckConfig(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DelayedDataCheckConfig? delayedDataCheckConfig) { @@ -750,7 +810,9 @@ public DatafeedConfigDescriptor DelayedDataCheckConfig(Action - /// The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. For example: `150s`. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation. + /// + /// The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. For example: 150s. When frequency is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation. + /// /// public DatafeedConfigDescriptor Frequency(Elastic.Clients.Elasticsearch.Serverless.Duration? frequency) { @@ -759,7 +821,9 @@ public DatafeedConfigDescriptor Frequency(Elastic.Clients.Elasticsearch.Serverle } /// - /// An array of index names. Wildcards are supported. If any indices are in remote clusters, the machine learning nodes must have the `remote_cluster_client` role. + /// + /// An array of index names. Wildcards are supported. If any indices are in remote clusters, the machine learning nodes must have the remote_cluster_client role. + /// /// public DatafeedConfigDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.Indices? indices) { @@ -768,7 +832,9 @@ public DatafeedConfigDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless } /// - /// Specifies index expansion options that are used during search. + /// + /// Specifies index expansion options that are used during search. + /// /// public DatafeedConfigDescriptor IndicesOptions(Elastic.Clients.Elasticsearch.Serverless.IndicesOptions? indicesOptions) { @@ -801,7 +867,9 @@ public DatafeedConfigDescriptor JobId(Elastic.Clients.Elasticsearch.Serverless.I } /// - /// If a real-time datafeed has never seen any data (including during any initial training period) then it will automatically stop itself and close its associated job after this many real-time searches that return no documents. In other words, it will stop after `frequency` times `max_empty_searches` of real-time operation. If not set then a datafeed with no end time that sees no data will remain started until it is explicitly stopped. + /// + /// If a real-time datafeed has never seen any data (including during any initial training period) then it will automatically stop itself and close its associated job after this many real-time searches that return no documents. In other words, it will stop after frequency times max_empty_searches of real-time operation. If not set then a datafeed with no end time that sees no data will remain started until it is explicitly stopped. + /// /// public DatafeedConfigDescriptor MaxEmptySearches(int? maxEmptySearches) { @@ -810,7 +878,9 @@ public DatafeedConfigDescriptor MaxEmptySearches(int? maxEmptySearches) } /// - /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. + /// + /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. + /// /// public DatafeedConfigDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -837,7 +907,9 @@ public DatafeedConfigDescriptor Query(Action - /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default value is randomly selected between `60s` and `120s`. This randomness improves the query performance when there are multiple jobs running on the same node. + /// + /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default value is randomly selected between 60s and 120s. This randomness improves the query performance when there are multiple jobs running on the same node. + /// /// public DatafeedConfigDescriptor QueryDelay(Elastic.Clients.Elasticsearch.Serverless.Duration? queryDelay) { @@ -846,7 +918,9 @@ public DatafeedConfigDescriptor QueryDelay(Elastic.Clients.Elasticsearch.Serverl } /// - /// Specifies runtime fields for the datafeed search. + /// + /// Specifies runtime fields for the datafeed search. + /// /// public DatafeedConfigDescriptor RuntimeMappings(Func, FluentDescriptorDictionary> selector) { @@ -855,7 +929,9 @@ public DatafeedConfigDescriptor RuntimeMappings(Func - /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. The detector configuration objects in a job can contain functions that use these script fields. + /// + /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. The detector configuration objects in a job can contain functions that use these script fields. + /// /// public DatafeedConfigDescriptor ScriptFields(Func, FluentDescriptorDictionary> selector) { @@ -864,7 +940,9 @@ public DatafeedConfigDescriptor ScriptFields(Func - /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. The maximum value is the value of `index.max_result_window`, which is 10,000 by default. + /// + /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. The maximum value is the value of index.max_result_window, which is 10,000 by default. + /// /// public DatafeedConfigDescriptor ScrollSize(int? scrollSize) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DatafeedRunningState.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DatafeedRunningState.g.cs index bfdbc6a85bc..5cf28e49c33 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DatafeedRunningState.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DatafeedRunningState.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DatafeedRunningState { /// - /// Indicates if the datafeed is "real-time"; meaning that the datafeed has no configured `end` time. + /// + /// Indicates if the datafeed is "real-time"; meaning that the datafeed has no configured end time. + /// /// [JsonInclude, JsonPropertyName("real_time_configured")] public bool RealTimeConfigured { get; init; } /// - /// Indicates whether the datafeed has finished running on the available past data.
For datafeeds without a configured `end` time, this means that the datafeed is now running on "real-time" data. + /// + /// Indicates whether the datafeed has finished running on the available past data. + /// For datafeeds without a configured end time, this means that the datafeed is now running on "real-time" data. + /// /// [JsonInclude, JsonPropertyName("real_time_running")] public bool RealTimeRunning { get; init; } /// - /// Provides the latest time interval the datafeed has searched. + /// + /// Provides the latest time interval the datafeed has searched. + /// /// [JsonInclude, JsonPropertyName("search_interval")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.RunningStateSearchInterval? SearchInterval { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DatafeedStats.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DatafeedStats.g.cs index a28d1e8c2dd..5673c68f978 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DatafeedStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DatafeedStats.g.cs @@ -30,31 +30,44 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DatafeedStats { /// - /// For started datafeeds only, contains messages relating to the selection of a node. + /// + /// For started datafeeds only, contains messages relating to the selection of a node. + /// /// [JsonInclude, JsonPropertyName("assignment_explanation")] public string? AssignmentExplanation { get; init; } /// - /// A numerical character string that uniquely identifies the datafeed.
This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
It must start and end with alphanumeric characters. + /// + /// A numerical character string that uniquely identifies the datafeed. + /// This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. + /// It must start and end with alphanumeric characters. + /// /// [JsonInclude, JsonPropertyName("datafeed_id")] public string DatafeedId { get; init; } /// - /// An object containing the running state for this datafeed.
It is only provided if the datafeed is started. + /// + /// An object containing the running state for this datafeed. + /// It is only provided if the datafeed is started. + /// /// [JsonInclude, JsonPropertyName("running_state")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DatafeedRunningState? RunningState { get; init; } /// - /// The status of the datafeed, which can be one of the following values: `starting`, `started`, `stopping`, `stopped`. + /// + /// The status of the datafeed, which can be one of the following values: starting, started, stopping, stopped. + /// /// [JsonInclude, JsonPropertyName("state")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DatafeedState State { get; init; } /// - /// An object that provides statistical information about timing aspect of this datafeed. + /// + /// An object that provides statistical information about timing aspect of this datafeed. + /// /// [JsonInclude, JsonPropertyName("timing_stats")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DatafeedTimingStats TimingStats { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DatafeedTimingStats.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DatafeedTimingStats.g.cs index 9ac4c4fc85e..6c407b4391c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DatafeedTimingStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DatafeedTimingStats.g.cs @@ -30,37 +30,49 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DatafeedTimingStats { /// - /// The average search time per bucket, in milliseconds. + /// + /// The average search time per bucket, in milliseconds. + /// /// [JsonInclude, JsonPropertyName("average_search_time_per_bucket_ms")] public double? AverageSearchTimePerBucketMs { get; init; } /// - /// The number of buckets processed. + /// + /// The number of buckets processed. + /// /// [JsonInclude, JsonPropertyName("bucket_count")] public long BucketCount { get; init; } /// - /// The exponential average search time per hour, in milliseconds. + /// + /// The exponential average search time per hour, in milliseconds. + /// /// [JsonInclude, JsonPropertyName("exponential_average_search_time_per_hour_ms")] public double ExponentialAverageSearchTimePerHourMs { get; init; } /// - /// Identifier for the anomaly detection job. + /// + /// Identifier for the anomaly detection job. + /// /// [JsonInclude, JsonPropertyName("job_id")] public string JobId { get; init; } /// - /// The number of searches run by the datafeed. + /// + /// The number of searches run by the datafeed. + /// /// [JsonInclude, JsonPropertyName("search_count")] public long SearchCount { get; init; } /// - /// The total time the datafeed spent searching, in milliseconds. + /// + /// The total time the datafeed spent searching, in milliseconds. + /// /// [JsonInclude, JsonPropertyName("total_search_time_ms")] public double TotalSearchTimeMs { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisAnalyzedFields.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisAnalyzedFields.g.cs index 9abae781abc..c4ec45eaae3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisAnalyzedFields.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisAnalyzedFields.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DataframeAnalysisAnalyzedFields { /// - /// An array of strings that defines the fields that will be included in the analysis. + /// + /// An array of strings that defines the fields that will be included in the analysis. + /// /// [JsonInclude, JsonPropertyName("excludes")] public ICollection Excludes { get; set; } /// - /// An array of strings that defines the fields that will be excluded from the analysis. You do not need to add fields with unsupported data types to excludes, these fields are excluded from the analysis automatically. + /// + /// An array of strings that defines the fields that will be excluded from the analysis. You do not need to add fields with unsupported data types to excludes, these fields are excluded from the analysis automatically. + /// /// [JsonInclude, JsonPropertyName("includes")] public ICollection Includes { get; set; } @@ -54,7 +58,9 @@ public DataframeAnalysisAnalyzedFieldsDescriptor() : base() private ICollection IncludesValue { get; set; } /// - /// An array of strings that defines the fields that will be included in the analysis. + /// + /// An array of strings that defines the fields that will be included in the analysis. + /// /// public DataframeAnalysisAnalyzedFieldsDescriptor Excludes(ICollection excludes) { @@ -63,7 +69,9 @@ public DataframeAnalysisAnalyzedFieldsDescriptor Excludes(ICollection ex } /// - /// An array of strings that defines the fields that will be excluded from the analysis. You do not need to add fields with unsupported data types to excludes, these fields are excluded from the analysis automatically. + /// + /// An array of strings that defines the fields that will be excluded from the analysis. You do not need to add fields with unsupported data types to excludes, these fields are excluded from the analysis automatically. + /// /// public DataframeAnalysisAnalyzedFieldsDescriptor Includes(ICollection includes) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisClassification.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisClassification.g.cs index 48f10e81ac6..812e24662e2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisClassification.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisClassification.g.cs @@ -291,98 +291,138 @@ public override void Write(Utf8JsonWriter writer, DataframeAnalysisClassificatio public sealed partial class DataframeAnalysisClassification { /// - /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero. + /// + /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero. + /// /// public double? Alpha { get; set; } public string? ClassAssignmentObjective { get; set; } /// - /// Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable.
For classification analysis, the data type of the field must be numeric (`integer`, `short`, `long`, `byte`), categorical (`ip` or `keyword`), or `boolean`. There must be no more than 30 different values in this field.
For regression analysis, the data type of the field must be numeric. + /// + /// Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable. + /// For classification analysis, the data type of the field must be numeric (integer, short, long, byte), categorical (ip or keyword), or boolean. There must be no more than 30 different values in this field. + /// For regression analysis, the data type of the field must be numeric. + /// /// public string DependentVariable { get; set; } /// - /// Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1. + /// + /// Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1. + /// /// public double? DownsampleFactor { get; set; } /// - /// Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable. + /// + /// Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable. + /// /// public bool? EarlyStoppingEnabled { get; set; } /// - /// Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1. + /// + /// Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1. + /// /// public double? Eta { get; set; } /// - /// Advanced configuration option. Specifies the rate at which `eta` increases for each new tree that is added to the forest. For example, a rate of 1.05 increases `eta` by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2. + /// + /// Advanced configuration option. Specifies the rate at which eta increases for each new tree that is added to the forest. For example, a rate of 1.05 increases eta by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2. + /// /// public double? EtaGrowthRatePerTree { get; set; } /// - /// Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization. + /// /// public double? FeatureBagFraction { get; set; } /// - /// Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple `feature_processors` entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields. + /// + /// Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple feature_processors entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields. + /// /// public ICollection? FeatureProcessors { get; set; } /// - /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// + /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// /// public double? Gamma { get; set; } /// - /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// + /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// /// public double? Lambda { get; set; } /// - /// Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization. + /// /// public int? MaxOptimizationRoundsPerHyperparameter { get; set; } /// - /// Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization. + /// /// public int? MaxTrees { get; set; } /// - /// Defines the number of categories for which the predicted probabilities are reported. It must be non-negative or -1. If it is -1 or greater than the total number of categories, probabilities are reported for all categories; if you have a large number of categories, there could be a significant effect on the size of your destination index. NOTE: To use the AUC ROC evaluation method, `num_top_classes` must be set to -1 or a value greater than or equal to the total number of categories. + /// + /// Defines the number of categories for which the predicted probabilities are reported. It must be non-negative or -1. If it is -1 or greater than the total number of categories, probabilities are reported for all categories; if you have a large number of categories, there could be a significant effect on the size of your destination index. NOTE: To use the AUC ROC evaluation method, num_top_classes must be set to -1 or a value greater than or equal to the total number of categories. + /// /// public int? NumTopClasses { get; set; } /// - /// Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs. + /// + /// Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs. + /// /// public int? NumTopFeatureImportanceValues { get; set; } /// - /// Defines the name of the prediction field in the results. Defaults to `_prediction`. + /// + /// Defines the name of the prediction field in the results. Defaults to <dependent_variable>_prediction. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Field? PredictionFieldName { get; set; } /// - /// Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as `source` and `analyzed_fields` are the same). + /// + /// Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as source and analyzed_fields are the same). + /// /// public double? RandomizeSeed { get; set; } /// - /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the `soft_tree_depth_tolerance` to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0. + /// + /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the soft_tree_depth_tolerance to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0. + /// /// public int? SoftTreeDepthLimit { get; set; } /// - /// Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds `soft_tree_depth_limit`. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01. + /// + /// Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds soft_tree_depth_limit. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01. + /// /// public double? SoftTreeDepthTolerance { get; set; } /// - /// Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage. + /// + /// Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage. + /// /// public double? TrainingPercent { get; set; } @@ -422,7 +462,9 @@ public DataframeAnalysisClassificationDescriptor() : base() private double? TrainingPercentValue { get; set; } /// - /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero. + /// + /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero. + /// /// public DataframeAnalysisClassificationDescriptor Alpha(double? alpha) { @@ -437,7 +479,11 @@ public DataframeAnalysisClassificationDescriptor ClassAssignmentObjec } /// - /// Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable.
For classification analysis, the data type of the field must be numeric (`integer`, `short`, `long`, `byte`), categorical (`ip` or `keyword`), or `boolean`. There must be no more than 30 different values in this field.
For regression analysis, the data type of the field must be numeric. + /// + /// Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable. + /// For classification analysis, the data type of the field must be numeric (integer, short, long, byte), categorical (ip or keyword), or boolean. There must be no more than 30 different values in this field. + /// For regression analysis, the data type of the field must be numeric. + /// /// public DataframeAnalysisClassificationDescriptor DependentVariable(string dependentVariable) { @@ -446,7 +492,9 @@ public DataframeAnalysisClassificationDescriptor DependentVariable(st } /// - /// Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1. + /// + /// Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1. + /// /// public DataframeAnalysisClassificationDescriptor DownsampleFactor(double? downsampleFactor) { @@ -455,7 +503,9 @@ public DataframeAnalysisClassificationDescriptor DownsampleFactor(dou } /// - /// Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable. + /// + /// Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable. + /// /// public DataframeAnalysisClassificationDescriptor EarlyStoppingEnabled(bool? earlyStoppingEnabled = true) { @@ -464,7 +514,9 @@ public DataframeAnalysisClassificationDescriptor EarlyStoppingEnabled } /// - /// Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1. + /// + /// Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1. + /// /// public DataframeAnalysisClassificationDescriptor Eta(double? eta) { @@ -473,7 +525,9 @@ public DataframeAnalysisClassificationDescriptor Eta(double? eta) } /// - /// Advanced configuration option. Specifies the rate at which `eta` increases for each new tree that is added to the forest. For example, a rate of 1.05 increases `eta` by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2. + /// + /// Advanced configuration option. Specifies the rate at which eta increases for each new tree that is added to the forest. For example, a rate of 1.05 increases eta by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2. + /// /// public DataframeAnalysisClassificationDescriptor EtaGrowthRatePerTree(double? etaGrowthRatePerTree) { @@ -482,7 +536,9 @@ public DataframeAnalysisClassificationDescriptor EtaGrowthRatePerTree } /// - /// Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization. + /// /// public DataframeAnalysisClassificationDescriptor FeatureBagFraction(double? featureBagFraction) { @@ -491,7 +547,9 @@ public DataframeAnalysisClassificationDescriptor FeatureBagFraction(d } /// - /// Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple `feature_processors` entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields. + /// + /// Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple feature_processors entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields. + /// /// public DataframeAnalysisClassificationDescriptor FeatureProcessors(ICollection? featureProcessors) { @@ -530,7 +588,9 @@ public DataframeAnalysisClassificationDescriptor FeatureProcessors(pa } /// - /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// + /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// /// public DataframeAnalysisClassificationDescriptor Gamma(double? gamma) { @@ -539,7 +599,9 @@ public DataframeAnalysisClassificationDescriptor Gamma(double? gamma) } /// - /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// + /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// /// public DataframeAnalysisClassificationDescriptor Lambda(double? lambda) { @@ -548,7 +610,9 @@ public DataframeAnalysisClassificationDescriptor Lambda(double? lambd } /// - /// Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization. + /// /// public DataframeAnalysisClassificationDescriptor MaxOptimizationRoundsPerHyperparameter(int? maxOptimizationRoundsPerHyperparameter) { @@ -557,7 +621,9 @@ public DataframeAnalysisClassificationDescriptor MaxOptimizationRound } /// - /// Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization. + /// /// public DataframeAnalysisClassificationDescriptor MaxTrees(int? maxTrees) { @@ -566,7 +632,9 @@ public DataframeAnalysisClassificationDescriptor MaxTrees(int? maxTre } /// - /// Defines the number of categories for which the predicted probabilities are reported. It must be non-negative or -1. If it is -1 or greater than the total number of categories, probabilities are reported for all categories; if you have a large number of categories, there could be a significant effect on the size of your destination index. NOTE: To use the AUC ROC evaluation method, `num_top_classes` must be set to -1 or a value greater than or equal to the total number of categories. + /// + /// Defines the number of categories for which the predicted probabilities are reported. It must be non-negative or -1. If it is -1 or greater than the total number of categories, probabilities are reported for all categories; if you have a large number of categories, there could be a significant effect on the size of your destination index. NOTE: To use the AUC ROC evaluation method, num_top_classes must be set to -1 or a value greater than or equal to the total number of categories. + /// /// public DataframeAnalysisClassificationDescriptor NumTopClasses(int? numTopClasses) { @@ -575,7 +643,9 @@ public DataframeAnalysisClassificationDescriptor NumTopClasses(int? n } /// - /// Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs. + /// + /// Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs. + /// /// public DataframeAnalysisClassificationDescriptor NumTopFeatureImportanceValues(int? numTopFeatureImportanceValues) { @@ -584,7 +654,9 @@ public DataframeAnalysisClassificationDescriptor NumTopFeatureImporta } /// - /// Defines the name of the prediction field in the results. Defaults to `_prediction`. + /// + /// Defines the name of the prediction field in the results. Defaults to <dependent_variable>_prediction. + /// /// public DataframeAnalysisClassificationDescriptor PredictionFieldName(Elastic.Clients.Elasticsearch.Serverless.Field? predictionFieldName) { @@ -593,7 +665,9 @@ public DataframeAnalysisClassificationDescriptor PredictionFieldName( } /// - /// Defines the name of the prediction field in the results. Defaults to `_prediction`. + /// + /// Defines the name of the prediction field in the results. Defaults to <dependent_variable>_prediction. + /// /// public DataframeAnalysisClassificationDescriptor PredictionFieldName(Expression> predictionFieldName) { @@ -602,7 +676,9 @@ public DataframeAnalysisClassificationDescriptor PredictionFieldName< } /// - /// Defines the name of the prediction field in the results. Defaults to `_prediction`. + /// + /// Defines the name of the prediction field in the results. Defaults to <dependent_variable>_prediction. + /// /// public DataframeAnalysisClassificationDescriptor PredictionFieldName(Expression> predictionFieldName) { @@ -611,7 +687,9 @@ public DataframeAnalysisClassificationDescriptor PredictionFieldName( } /// - /// Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as `source` and `analyzed_fields` are the same). + /// + /// Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as source and analyzed_fields are the same). + /// /// public DataframeAnalysisClassificationDescriptor RandomizeSeed(double? randomizeSeed) { @@ -620,7 +698,9 @@ public DataframeAnalysisClassificationDescriptor RandomizeSeed(double } /// - /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the `soft_tree_depth_tolerance` to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0. + /// + /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the soft_tree_depth_tolerance to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0. + /// /// public DataframeAnalysisClassificationDescriptor SoftTreeDepthLimit(int? softTreeDepthLimit) { @@ -629,7 +709,9 @@ public DataframeAnalysisClassificationDescriptor SoftTreeDepthLimit(i } /// - /// Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds `soft_tree_depth_limit`. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01. + /// + /// Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds soft_tree_depth_limit. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01. + /// /// public DataframeAnalysisClassificationDescriptor SoftTreeDepthTolerance(double? softTreeDepthTolerance) { @@ -638,7 +720,9 @@ public DataframeAnalysisClassificationDescriptor SoftTreeDepthToleran } /// - /// Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage. + /// + /// Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage. + /// /// public DataframeAnalysisClassificationDescriptor TrainingPercent(double? trainingPercent) { @@ -827,7 +911,9 @@ public DataframeAnalysisClassificationDescriptor() : base() private double? TrainingPercentValue { get; set; } /// - /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero. + /// + /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero. + /// /// public DataframeAnalysisClassificationDescriptor Alpha(double? alpha) { @@ -842,7 +928,11 @@ public DataframeAnalysisClassificationDescriptor ClassAssignmentObjective(string } /// - /// Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable.
For classification analysis, the data type of the field must be numeric (`integer`, `short`, `long`, `byte`), categorical (`ip` or `keyword`), or `boolean`. There must be no more than 30 different values in this field.
For regression analysis, the data type of the field must be numeric. + /// + /// Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable. + /// For classification analysis, the data type of the field must be numeric (integer, short, long, byte), categorical (ip or keyword), or boolean. There must be no more than 30 different values in this field. + /// For regression analysis, the data type of the field must be numeric. + /// /// public DataframeAnalysisClassificationDescriptor DependentVariable(string dependentVariable) { @@ -851,7 +941,9 @@ public DataframeAnalysisClassificationDescriptor DependentVariable(string depend } /// - /// Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1. + /// + /// Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1. + /// /// public DataframeAnalysisClassificationDescriptor DownsampleFactor(double? downsampleFactor) { @@ -860,7 +952,9 @@ public DataframeAnalysisClassificationDescriptor DownsampleFactor(double? downsa } /// - /// Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable. + /// + /// Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable. + /// /// public DataframeAnalysisClassificationDescriptor EarlyStoppingEnabled(bool? earlyStoppingEnabled = true) { @@ -869,7 +963,9 @@ public DataframeAnalysisClassificationDescriptor EarlyStoppingEnabled(bool? earl } /// - /// Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1. + /// + /// Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1. + /// /// public DataframeAnalysisClassificationDescriptor Eta(double? eta) { @@ -878,7 +974,9 @@ public DataframeAnalysisClassificationDescriptor Eta(double? eta) } /// - /// Advanced configuration option. Specifies the rate at which `eta` increases for each new tree that is added to the forest. For example, a rate of 1.05 increases `eta` by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2. + /// + /// Advanced configuration option. Specifies the rate at which eta increases for each new tree that is added to the forest. For example, a rate of 1.05 increases eta by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2. + /// /// public DataframeAnalysisClassificationDescriptor EtaGrowthRatePerTree(double? etaGrowthRatePerTree) { @@ -887,7 +985,9 @@ public DataframeAnalysisClassificationDescriptor EtaGrowthRatePerTree(double? et } /// - /// Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization. + /// /// public DataframeAnalysisClassificationDescriptor FeatureBagFraction(double? featureBagFraction) { @@ -896,7 +996,9 @@ public DataframeAnalysisClassificationDescriptor FeatureBagFraction(double? feat } /// - /// Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple `feature_processors` entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields. + /// + /// Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple feature_processors entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields. + /// /// public DataframeAnalysisClassificationDescriptor FeatureProcessors(ICollection? featureProcessors) { @@ -935,7 +1037,9 @@ public DataframeAnalysisClassificationDescriptor FeatureProcessors(params Action } /// - /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// + /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// /// public DataframeAnalysisClassificationDescriptor Gamma(double? gamma) { @@ -944,7 +1048,9 @@ public DataframeAnalysisClassificationDescriptor Gamma(double? gamma) } /// - /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// + /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// /// public DataframeAnalysisClassificationDescriptor Lambda(double? lambda) { @@ -953,7 +1059,9 @@ public DataframeAnalysisClassificationDescriptor Lambda(double? lambda) } /// - /// Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization. + /// /// public DataframeAnalysisClassificationDescriptor MaxOptimizationRoundsPerHyperparameter(int? maxOptimizationRoundsPerHyperparameter) { @@ -962,7 +1070,9 @@ public DataframeAnalysisClassificationDescriptor MaxOptimizationRoundsPerHyperpa } /// - /// Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization. + /// /// public DataframeAnalysisClassificationDescriptor MaxTrees(int? maxTrees) { @@ -971,7 +1081,9 @@ public DataframeAnalysisClassificationDescriptor MaxTrees(int? maxTrees) } /// - /// Defines the number of categories for which the predicted probabilities are reported. It must be non-negative or -1. If it is -1 or greater than the total number of categories, probabilities are reported for all categories; if you have a large number of categories, there could be a significant effect on the size of your destination index. NOTE: To use the AUC ROC evaluation method, `num_top_classes` must be set to -1 or a value greater than or equal to the total number of categories. + /// + /// Defines the number of categories for which the predicted probabilities are reported. It must be non-negative or -1. If it is -1 or greater than the total number of categories, probabilities are reported for all categories; if you have a large number of categories, there could be a significant effect on the size of your destination index. NOTE: To use the AUC ROC evaluation method, num_top_classes must be set to -1 or a value greater than or equal to the total number of categories. + /// /// public DataframeAnalysisClassificationDescriptor NumTopClasses(int? numTopClasses) { @@ -980,7 +1092,9 @@ public DataframeAnalysisClassificationDescriptor NumTopClasses(int? numTopClasse } /// - /// Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs. + /// + /// Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs. + /// /// public DataframeAnalysisClassificationDescriptor NumTopFeatureImportanceValues(int? numTopFeatureImportanceValues) { @@ -989,7 +1103,9 @@ public DataframeAnalysisClassificationDescriptor NumTopFeatureImportanceValues(i } /// - /// Defines the name of the prediction field in the results. Defaults to `_prediction`. + /// + /// Defines the name of the prediction field in the results. Defaults to <dependent_variable>_prediction. + /// /// public DataframeAnalysisClassificationDescriptor PredictionFieldName(Elastic.Clients.Elasticsearch.Serverless.Field? predictionFieldName) { @@ -998,7 +1114,9 @@ public DataframeAnalysisClassificationDescriptor PredictionFieldName(Elastic.Cli } /// - /// Defines the name of the prediction field in the results. Defaults to `_prediction`. + /// + /// Defines the name of the prediction field in the results. Defaults to <dependent_variable>_prediction. + /// /// public DataframeAnalysisClassificationDescriptor PredictionFieldName(Expression> predictionFieldName) { @@ -1007,7 +1125,9 @@ public DataframeAnalysisClassificationDescriptor PredictionFieldName - /// Defines the name of the prediction field in the results. Defaults to `_prediction`. + /// + /// Defines the name of the prediction field in the results. Defaults to <dependent_variable>_prediction. + /// /// public DataframeAnalysisClassificationDescriptor PredictionFieldName(Expression> predictionFieldName) { @@ -1016,7 +1136,9 @@ public DataframeAnalysisClassificationDescriptor PredictionFieldName( } /// - /// Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as `source` and `analyzed_fields` are the same). + /// + /// Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as source and analyzed_fields are the same). + /// /// public DataframeAnalysisClassificationDescriptor RandomizeSeed(double? randomizeSeed) { @@ -1025,7 +1147,9 @@ public DataframeAnalysisClassificationDescriptor RandomizeSeed(double? randomize } /// - /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the `soft_tree_depth_tolerance` to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0. + /// + /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the soft_tree_depth_tolerance to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0. + /// /// public DataframeAnalysisClassificationDescriptor SoftTreeDepthLimit(int? softTreeDepthLimit) { @@ -1034,7 +1158,9 @@ public DataframeAnalysisClassificationDescriptor SoftTreeDepthLimit(int? softTre } /// - /// Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds `soft_tree_depth_limit`. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01. + /// + /// Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds soft_tree_depth_limit. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01. + /// /// public DataframeAnalysisClassificationDescriptor SoftTreeDepthTolerance(double? softTreeDepthTolerance) { @@ -1043,7 +1169,9 @@ public DataframeAnalysisClassificationDescriptor SoftTreeDepthTolerance(double? } /// - /// Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage. + /// + /// Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage. + /// /// public DataframeAnalysisClassificationDescriptor TrainingPercent(double? trainingPercent) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorFrequencyEncoding.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorFrequencyEncoding.g.cs index 662ac907422..77877ebd80b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorFrequencyEncoding.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorFrequencyEncoding.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DataframeAnalysisFeatureProcessorFrequencyEncoding { /// - /// The resulting feature name. + /// + /// The resulting feature name. + /// /// [JsonInclude, JsonPropertyName("feature_name")] public Elastic.Clients.Elasticsearch.Serverless.Name FeatureName { get; set; } @@ -38,7 +40,9 @@ public sealed partial class DataframeAnalysisFeatureProcessorFrequencyEncoding public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// The resulting frequency map for the field value. If the field value is missing from the frequency_map, the resulting value is 0. + /// + /// The resulting frequency map for the field value. If the field value is missing from the frequency_map, the resulting value is 0. + /// /// [JsonInclude, JsonPropertyName("frequency_map")] public IDictionary FrequencyMap { get; set; } @@ -59,7 +63,9 @@ public DataframeAnalysisFeatureProcessorFrequencyEncodingDescriptor() : base() private IDictionary FrequencyMapValue { get; set; } /// - /// The resulting feature name. + /// + /// The resulting feature name. + /// /// public DataframeAnalysisFeatureProcessorFrequencyEncodingDescriptor FeatureName(Elastic.Clients.Elasticsearch.Serverless.Name featureName) { @@ -86,7 +92,9 @@ public DataframeAnalysisFeatureProcessorFrequencyEncodingDescriptor F } /// - /// The resulting frequency map for the field value. If the field value is missing from the frequency_map, the resulting value is 0. + /// + /// The resulting frequency map for the field value. If the field value is missing from the frequency_map, the resulting value is 0. + /// /// public DataframeAnalysisFeatureProcessorFrequencyEncodingDescriptor FrequencyMap(Func, FluentDictionary> selector) { @@ -120,7 +128,9 @@ public DataframeAnalysisFeatureProcessorFrequencyEncodingDescriptor() : base() private IDictionary FrequencyMapValue { get; set; } /// - /// The resulting feature name. + /// + /// The resulting feature name. + /// /// public DataframeAnalysisFeatureProcessorFrequencyEncodingDescriptor FeatureName(Elastic.Clients.Elasticsearch.Serverless.Name featureName) { @@ -147,7 +157,9 @@ public DataframeAnalysisFeatureProcessorFrequencyEncodingDescriptor Field - /// The resulting frequency map for the field value. If the field value is missing from the frequency_map, the resulting value is 0. + /// + /// The resulting frequency map for the field value. If the field value is missing from the frequency_map, the resulting value is 0. + /// /// public DataframeAnalysisFeatureProcessorFrequencyEncodingDescriptor FrequencyMap(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorMultiEncoding.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorMultiEncoding.g.cs index ada401aa4bb..82cdc66c1be 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorMultiEncoding.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorMultiEncoding.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DataframeAnalysisFeatureProcessorMultiEncoding { /// - /// The ordered array of custom processors to execute. Must be more than 1. + /// + /// The ordered array of custom processors to execute. Must be more than 1. + /// /// [JsonInclude, JsonPropertyName("processors")] public ICollection Processors { get; set; } @@ -49,7 +51,9 @@ public DataframeAnalysisFeatureProcessorMultiEncodingDescriptor() : base() private ICollection ProcessorsValue { get; set; } /// - /// The ordered array of custom processors to execute. Must be more than 1. + /// + /// The ordered array of custom processors to execute. Must be more than 1. + /// /// public DataframeAnalysisFeatureProcessorMultiEncodingDescriptor Processors(ICollection processors) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorNGramEncoding.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorNGramEncoding.g.cs index c74dd6e2886..348742af9c1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorNGramEncoding.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorNGramEncoding.g.cs @@ -33,31 +33,41 @@ public sealed partial class DataframeAnalysisFeatureProcessorNGramEncoding public bool? Custom { get; set; } /// - /// The feature name prefix. Defaults to ngram__. + /// + /// The feature name prefix. Defaults to ngram_<start>_<length>. + /// /// [JsonInclude, JsonPropertyName("feature_prefix")] public string? FeaturePrefix { get; set; } /// - /// The name of the text field to encode. + /// + /// The name of the text field to encode. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Specifies the length of the n-gram substring. Defaults to 50. Must be greater than 0. + /// + /// Specifies the length of the n-gram substring. Defaults to 50. Must be greater than 0. + /// /// [JsonInclude, JsonPropertyName("length")] public int? Length { get; set; } /// - /// Specifies which n-grams to gather. It’s an array of integer values where the minimum value is 1, and a maximum value is 5. + /// + /// Specifies which n-grams to gather. It’s an array of integer values where the minimum value is 1, and a maximum value is 5. + /// /// [JsonInclude, JsonPropertyName("n_grams")] public ICollection NGrams { get; set; } /// - /// Specifies the zero-indexed start of the n-gram substring. Negative values are allowed for encoding n-grams of string suffixes. Defaults to 0. + /// + /// Specifies the zero-indexed start of the n-gram substring. Negative values are allowed for encoding n-grams of string suffixes. Defaults to 0. + /// /// [JsonInclude, JsonPropertyName("start")] public int? Start { get; set; } @@ -87,7 +97,9 @@ public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Custo } /// - /// The feature name prefix. Defaults to ngram__. + /// + /// The feature name prefix. Defaults to ngram_<start>_<length>. + /// /// public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor FeaturePrefix(string? featurePrefix) { @@ -96,7 +108,9 @@ public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Featu } /// - /// The name of the text field to encode. + /// + /// The name of the text field to encode. + /// /// public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -105,7 +119,9 @@ public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Field } /// - /// The name of the text field to encode. + /// + /// The name of the text field to encode. + /// /// public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Field(Expression> field) { @@ -114,7 +130,9 @@ public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Field } /// - /// The name of the text field to encode. + /// + /// The name of the text field to encode. + /// /// public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Field(Expression> field) { @@ -123,7 +141,9 @@ public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Field } /// - /// Specifies the length of the n-gram substring. Defaults to 50. Must be greater than 0. + /// + /// Specifies the length of the n-gram substring. Defaults to 50. Must be greater than 0. + /// /// public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Length(int? length) { @@ -132,7 +152,9 @@ public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Lengt } /// - /// Specifies which n-grams to gather. It’s an array of integer values where the minimum value is 1, and a maximum value is 5. + /// + /// Specifies which n-grams to gather. It’s an array of integer values where the minimum value is 1, and a maximum value is 5. + /// /// public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor NGrams(ICollection nGrams) { @@ -141,7 +163,9 @@ public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor NGram } /// - /// Specifies the zero-indexed start of the n-gram substring. Negative values are allowed for encoding n-grams of string suffixes. Defaults to 0. + /// + /// Specifies the zero-indexed start of the n-gram substring. Negative values are allowed for encoding n-grams of string suffixes. Defaults to 0. + /// /// public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Start(int? start) { @@ -206,7 +230,9 @@ public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Custom(bool? cus } /// - /// The feature name prefix. Defaults to ngram__. + /// + /// The feature name prefix. Defaults to ngram_<start>_<length>. + /// /// public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor FeaturePrefix(string? featurePrefix) { @@ -215,7 +241,9 @@ public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor FeaturePrefix(st } /// - /// The name of the text field to encode. + /// + /// The name of the text field to encode. + /// /// public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -224,7 +252,9 @@ public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Field(Elastic.Cl } /// - /// The name of the text field to encode. + /// + /// The name of the text field to encode. + /// /// public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Field(Expression> field) { @@ -233,7 +263,9 @@ public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Field - /// The name of the text field to encode. + /// + /// The name of the text field to encode. + /// /// public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Field(Expression> field) { @@ -242,7 +274,9 @@ public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Field } /// - /// Specifies the length of the n-gram substring. Defaults to 50. Must be greater than 0. + /// + /// Specifies the length of the n-gram substring. Defaults to 50. Must be greater than 0. + /// /// public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Length(int? length) { @@ -251,7 +285,9 @@ public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Length(int? leng } /// - /// Specifies which n-grams to gather. It’s an array of integer values where the minimum value is 1, and a maximum value is 5. + /// + /// Specifies which n-grams to gather. It’s an array of integer values where the minimum value is 1, and a maximum value is 5. + /// /// public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor NGrams(ICollection nGrams) { @@ -260,7 +296,9 @@ public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor NGrams(ICollecti } /// - /// Specifies the zero-indexed start of the n-gram substring. Negative values are allowed for encoding n-grams of string suffixes. Defaults to 0. + /// + /// Specifies the zero-indexed start of the n-gram substring. Negative values are allowed for encoding n-grams of string suffixes. Defaults to 0. + /// /// public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Start(int? start) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorOneHotEncoding.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorOneHotEncoding.g.cs index 9c898e9b7f3..c30935c7521 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorOneHotEncoding.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorOneHotEncoding.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DataframeAnalysisFeatureProcessorOneHotEncoding { /// - /// The name of the field to encode. + /// + /// The name of the field to encode. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// The one hot map mapping the field value with the column name. + /// + /// The one hot map mapping the field value with the column name. + /// /// [JsonInclude, JsonPropertyName("hot_map")] public string HotMap { get; set; } @@ -56,7 +60,9 @@ public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor() : base() private string HotMapValue { get; set; } /// - /// The name of the field to encode. + /// + /// The name of the field to encode. + /// /// public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -65,7 +71,9 @@ public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor Fiel } /// - /// The name of the field to encode. + /// + /// The name of the field to encode. + /// /// public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor Field(Expression> field) { @@ -74,7 +82,9 @@ public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor Fiel } /// - /// The name of the field to encode. + /// + /// The name of the field to encode. + /// /// public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor Field(Expression> field) { @@ -83,7 +93,9 @@ public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor Fiel } /// - /// The one hot map mapping the field value with the column name. + /// + /// The one hot map mapping the field value with the column name. + /// /// public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor HotMap(string hotMap) { @@ -114,7 +126,9 @@ public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor() : base() private string HotMapValue { get; set; } /// - /// The name of the field to encode. + /// + /// The name of the field to encode. + /// /// public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -123,7 +137,9 @@ public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor Field(Elastic.C } /// - /// The name of the field to encode. + /// + /// The name of the field to encode. + /// /// public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor Field(Expression> field) { @@ -132,7 +148,9 @@ public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor Field - /// The name of the field to encode. + /// + /// The name of the field to encode. + /// /// public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor Field(Expression> field) { @@ -141,7 +159,9 @@ public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor Field - /// The one hot map mapping the field value with the column name. + /// + /// The one hot map mapping the field value with the column name. + /// /// public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor HotMap(string hotMap) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorTargetMeanEncoding.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorTargetMeanEncoding.g.cs index fd787e8935c..68086c92e87 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorTargetMeanEncoding.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorTargetMeanEncoding.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DataframeAnalysisFeatureProcessorTargetMeanEncoding { /// - /// The default value if field value is not found in the target_map. + /// + /// The default value if field value is not found in the target_map. + /// /// [JsonInclude, JsonPropertyName("default_value")] public int DefaultValue { get; set; } /// - /// The resulting feature name. + /// + /// The resulting feature name. + /// /// [JsonInclude, JsonPropertyName("feature_name")] public Elastic.Clients.Elasticsearch.Serverless.Name FeatureName { get; set; } /// - /// The name of the field to encode. + /// + /// The name of the field to encode. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// The field value to target mean transition map. + /// + /// The field value to target mean transition map. + /// /// [JsonInclude, JsonPropertyName("target_map")] public IDictionary TargetMap { get; set; } @@ -70,7 +78,9 @@ public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor() : base() private IDictionary TargetMapValue { get; set; } /// - /// The default value if field value is not found in the target_map. + /// + /// The default value if field value is not found in the target_map. + /// /// public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor DefaultValue(int defaultValue) { @@ -79,7 +89,9 @@ public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor } /// - /// The resulting feature name. + /// + /// The resulting feature name. + /// /// public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor FeatureName(Elastic.Clients.Elasticsearch.Serverless.Name featureName) { @@ -88,7 +100,9 @@ public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor } /// - /// The name of the field to encode. + /// + /// The name of the field to encode. + /// /// public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -97,7 +111,9 @@ public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor } /// - /// The name of the field to encode. + /// + /// The name of the field to encode. + /// /// public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor Field(Expression> field) { @@ -106,7 +122,9 @@ public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor } /// - /// The name of the field to encode. + /// + /// The name of the field to encode. + /// /// public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor Field(Expression> field) { @@ -115,7 +133,9 @@ public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor } /// - /// The field value to target mean transition map. + /// + /// The field value to target mean transition map. + /// /// public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor TargetMap(Func, FluentDictionary> selector) { @@ -152,7 +172,9 @@ public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor() : base() private IDictionary TargetMapValue { get; set; } /// - /// The default value if field value is not found in the target_map. + /// + /// The default value if field value is not found in the target_map. + /// /// public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor DefaultValue(int defaultValue) { @@ -161,7 +183,9 @@ public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor DefaultValu } /// - /// The resulting feature name. + /// + /// The resulting feature name. + /// /// public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor FeatureName(Elastic.Clients.Elasticsearch.Serverless.Name featureName) { @@ -170,7 +194,9 @@ public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor FeatureName } /// - /// The name of the field to encode. + /// + /// The name of the field to encode. + /// /// public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -179,7 +205,9 @@ public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor Field(Elast } /// - /// The name of the field to encode. + /// + /// The name of the field to encode. + /// /// public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor Field(Expression> field) { @@ -188,7 +216,9 @@ public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor Field - /// The name of the field to encode. + /// + /// The name of the field to encode. + /// /// public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor Field(Expression> field) { @@ -197,7 +227,9 @@ public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor Field - /// The field value to target mean transition map. + /// + /// The field value to target mean transition map. + /// /// public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor TargetMap(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisOutlierDetection.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisOutlierDetection.g.cs index b5266ef7597..3331daf6d3b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisOutlierDetection.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisOutlierDetection.g.cs @@ -30,37 +30,49 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DataframeAnalysisOutlierDetection { /// - /// Specifies whether the feature influence calculation is enabled. + /// + /// Specifies whether the feature influence calculation is enabled. + /// /// [JsonInclude, JsonPropertyName("compute_feature_influence")] public bool? ComputeFeatureInfluence { get; set; } /// - /// The minimum outlier score that a document needs to have in order to calculate its feature influence score. Value range: 0-1. + /// + /// The minimum outlier score that a document needs to have in order to calculate its feature influence score. Value range: 0-1. + /// /// [JsonInclude, JsonPropertyName("feature_influence_threshold")] public double? FeatureInfluenceThreshold { get; set; } /// - /// The method that outlier detection uses. Available methods are `lof`, `ldof`, `distance_kth_nn`, `distance_knn`, and `ensemble`. The default value is ensemble, which means that outlier detection uses an ensemble of different methods and normalises and combines their individual outlier scores to obtain the overall outlier score. + /// + /// The method that outlier detection uses. Available methods are lof, ldof, distance_kth_nn, distance_knn, and ensemble. The default value is ensemble, which means that outlier detection uses an ensemble of different methods and normalises and combines their individual outlier scores to obtain the overall outlier score. + /// /// [JsonInclude, JsonPropertyName("method")] public string? Method { get; set; } /// - /// Defines the value for how many nearest neighbors each method of outlier detection uses to calculate its outlier score. When the value is not set, different values are used for different ensemble members. This default behavior helps improve the diversity in the ensemble; only override it if you are confident that the value you choose is appropriate for the data set. + /// + /// Defines the value for how many nearest neighbors each method of outlier detection uses to calculate its outlier score. When the value is not set, different values are used for different ensemble members. This default behavior helps improve the diversity in the ensemble; only override it if you are confident that the value you choose is appropriate for the data set. + /// /// [JsonInclude, JsonPropertyName("n_neighbors")] public int? NNeighbors { get; set; } /// - /// The proportion of the data set that is assumed to be outlying prior to outlier detection. For example, 0.05 means it is assumed that 5% of values are real outliers and 95% are inliers. + /// + /// The proportion of the data set that is assumed to be outlying prior to outlier detection. For example, 0.05 means it is assumed that 5% of values are real outliers and 95% are inliers. + /// /// [JsonInclude, JsonPropertyName("outlier_fraction")] public double? OutlierFraction { get; set; } /// - /// If true, the following operation is performed on the columns before computing outlier scores: `(x_i - mean(x_i)) / sd(x_i)`. + /// + /// If true, the following operation is performed on the columns before computing outlier scores: (x_i - mean(x_i)) / sd(x_i). + /// /// [JsonInclude, JsonPropertyName("standardization_enabled")] public bool? StandardizationEnabled { get; set; } @@ -84,7 +96,9 @@ public DataframeAnalysisOutlierDetectionDescriptor() : base() private bool? StandardizationEnabledValue { get; set; } /// - /// Specifies whether the feature influence calculation is enabled. + /// + /// Specifies whether the feature influence calculation is enabled. + /// /// public DataframeAnalysisOutlierDetectionDescriptor ComputeFeatureInfluence(bool? computeFeatureInfluence = true) { @@ -93,7 +107,9 @@ public DataframeAnalysisOutlierDetectionDescriptor ComputeFeatureInfluence(bool? } /// - /// The minimum outlier score that a document needs to have in order to calculate its feature influence score. Value range: 0-1. + /// + /// The minimum outlier score that a document needs to have in order to calculate its feature influence score. Value range: 0-1. + /// /// public DataframeAnalysisOutlierDetectionDescriptor FeatureInfluenceThreshold(double? featureInfluenceThreshold) { @@ -102,7 +118,9 @@ public DataframeAnalysisOutlierDetectionDescriptor FeatureInfluenceThreshold(dou } /// - /// The method that outlier detection uses. Available methods are `lof`, `ldof`, `distance_kth_nn`, `distance_knn`, and `ensemble`. The default value is ensemble, which means that outlier detection uses an ensemble of different methods and normalises and combines their individual outlier scores to obtain the overall outlier score. + /// + /// The method that outlier detection uses. Available methods are lof, ldof, distance_kth_nn, distance_knn, and ensemble. The default value is ensemble, which means that outlier detection uses an ensemble of different methods and normalises and combines their individual outlier scores to obtain the overall outlier score. + /// /// public DataframeAnalysisOutlierDetectionDescriptor Method(string? method) { @@ -111,7 +129,9 @@ public DataframeAnalysisOutlierDetectionDescriptor Method(string? method) } /// - /// Defines the value for how many nearest neighbors each method of outlier detection uses to calculate its outlier score. When the value is not set, different values are used for different ensemble members. This default behavior helps improve the diversity in the ensemble; only override it if you are confident that the value you choose is appropriate for the data set. + /// + /// Defines the value for how many nearest neighbors each method of outlier detection uses to calculate its outlier score. When the value is not set, different values are used for different ensemble members. This default behavior helps improve the diversity in the ensemble; only override it if you are confident that the value you choose is appropriate for the data set. + /// /// public DataframeAnalysisOutlierDetectionDescriptor NNeighbors(int? nNeighbors) { @@ -120,7 +140,9 @@ public DataframeAnalysisOutlierDetectionDescriptor NNeighbors(int? nNeighbors) } /// - /// The proportion of the data set that is assumed to be outlying prior to outlier detection. For example, 0.05 means it is assumed that 5% of values are real outliers and 95% are inliers. + /// + /// The proportion of the data set that is assumed to be outlying prior to outlier detection. For example, 0.05 means it is assumed that 5% of values are real outliers and 95% are inliers. + /// /// public DataframeAnalysisOutlierDetectionDescriptor OutlierFraction(double? outlierFraction) { @@ -129,7 +151,9 @@ public DataframeAnalysisOutlierDetectionDescriptor OutlierFraction(double? outli } /// - /// If true, the following operation is performed on the columns before computing outlier scores: `(x_i - mean(x_i)) / sd(x_i)`. + /// + /// If true, the following operation is performed on the columns before computing outlier scores: (x_i - mean(x_i)) / sd(x_i). + /// /// public DataframeAnalysisOutlierDetectionDescriptor StandardizationEnabled(bool? standardizationEnabled = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisRegression.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisRegression.g.cs index 7ebf67cdb35..d8aa08cedd4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisRegression.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalysisRegression.g.cs @@ -291,102 +291,144 @@ public override void Write(Utf8JsonWriter writer, DataframeAnalysisRegression va public sealed partial class DataframeAnalysisRegression { /// - /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero. + /// + /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero. + /// /// public double? Alpha { get; set; } /// - /// Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable.
For classification analysis, the data type of the field must be numeric (`integer`, `short`, `long`, `byte`), categorical (`ip` or `keyword`), or `boolean`. There must be no more than 30 different values in this field.
For regression analysis, the data type of the field must be numeric. + /// + /// Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable. + /// For classification analysis, the data type of the field must be numeric (integer, short, long, byte), categorical (ip or keyword), or boolean. There must be no more than 30 different values in this field. + /// For regression analysis, the data type of the field must be numeric. + /// /// public string DependentVariable { get; set; } /// - /// Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1. + /// + /// Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1. + /// /// public double? DownsampleFactor { get; set; } /// - /// Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable. + /// + /// Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable. + /// /// public bool? EarlyStoppingEnabled { get; set; } /// - /// Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1. + /// + /// Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1. + /// /// public double? Eta { get; set; } /// - /// Advanced configuration option. Specifies the rate at which `eta` increases for each new tree that is added to the forest. For example, a rate of 1.05 increases `eta` by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2. + /// + /// Advanced configuration option. Specifies the rate at which eta increases for each new tree that is added to the forest. For example, a rate of 1.05 increases eta by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2. + /// /// public double? EtaGrowthRatePerTree { get; set; } /// - /// Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization. + /// /// public double? FeatureBagFraction { get; set; } /// - /// Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple `feature_processors` entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields. + /// + /// Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple feature_processors entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields. + /// /// public ICollection? FeatureProcessors { get; set; } /// - /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// + /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// /// public double? Gamma { get; set; } /// - /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// + /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// /// public double? Lambda { get; set; } /// - /// The loss function used during regression. Available options are `mse` (mean squared error), `msle` (mean squared logarithmic error), `huber` (Pseudo-Huber loss). + /// + /// The loss function used during regression. Available options are mse (mean squared error), msle (mean squared logarithmic error), huber (Pseudo-Huber loss). + /// /// public string? LossFunction { get; set; } /// - /// A positive number that is used as a parameter to the `loss_function`. + /// + /// A positive number that is used as a parameter to the loss_function. + /// /// public double? LossFunctionParameter { get; set; } /// - /// Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization. + /// /// public int? MaxOptimizationRoundsPerHyperparameter { get; set; } /// - /// Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization. + /// /// public int? MaxTrees { get; set; } /// - /// Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs. + /// + /// Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs. + /// /// public int? NumTopFeatureImportanceValues { get; set; } /// - /// Defines the name of the prediction field in the results. Defaults to `_prediction`. + /// + /// Defines the name of the prediction field in the results. Defaults to <dependent_variable>_prediction. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Field? PredictionFieldName { get; set; } /// - /// Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as `source` and `analyzed_fields` are the same). + /// + /// Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as source and analyzed_fields are the same). + /// /// public double? RandomizeSeed { get; set; } /// - /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the `soft_tree_depth_tolerance` to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0. + /// + /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the soft_tree_depth_tolerance to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0. + /// /// public int? SoftTreeDepthLimit { get; set; } /// - /// Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds `soft_tree_depth_limit`. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01. + /// + /// Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds soft_tree_depth_limit. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01. + /// /// public double? SoftTreeDepthTolerance { get; set; } /// - /// Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage. + /// + /// Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage. + /// /// public double? TrainingPercent { get; set; } @@ -426,7 +468,9 @@ public DataframeAnalysisRegressionDescriptor() : base() private double? TrainingPercentValue { get; set; } /// - /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero. + /// + /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero. + /// /// public DataframeAnalysisRegressionDescriptor Alpha(double? alpha) { @@ -435,7 +479,11 @@ public DataframeAnalysisRegressionDescriptor Alpha(double? alpha) } /// - /// Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable.
For classification analysis, the data type of the field must be numeric (`integer`, `short`, `long`, `byte`), categorical (`ip` or `keyword`), or `boolean`. There must be no more than 30 different values in this field.
For regression analysis, the data type of the field must be numeric. + /// + /// Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable. + /// For classification analysis, the data type of the field must be numeric (integer, short, long, byte), categorical (ip or keyword), or boolean. There must be no more than 30 different values in this field. + /// For regression analysis, the data type of the field must be numeric. + /// /// public DataframeAnalysisRegressionDescriptor DependentVariable(string dependentVariable) { @@ -444,7 +492,9 @@ public DataframeAnalysisRegressionDescriptor DependentVariable(string } /// - /// Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1. + /// + /// Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1. + /// /// public DataframeAnalysisRegressionDescriptor DownsampleFactor(double? downsampleFactor) { @@ -453,7 +503,9 @@ public DataframeAnalysisRegressionDescriptor DownsampleFactor(double? } /// - /// Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable. + /// + /// Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable. + /// /// public DataframeAnalysisRegressionDescriptor EarlyStoppingEnabled(bool? earlyStoppingEnabled = true) { @@ -462,7 +514,9 @@ public DataframeAnalysisRegressionDescriptor EarlyStoppingEnabled(boo } /// - /// Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1. + /// + /// Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1. + /// /// public DataframeAnalysisRegressionDescriptor Eta(double? eta) { @@ -471,7 +525,9 @@ public DataframeAnalysisRegressionDescriptor Eta(double? eta) } /// - /// Advanced configuration option. Specifies the rate at which `eta` increases for each new tree that is added to the forest. For example, a rate of 1.05 increases `eta` by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2. + /// + /// Advanced configuration option. Specifies the rate at which eta increases for each new tree that is added to the forest. For example, a rate of 1.05 increases eta by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2. + /// /// public DataframeAnalysisRegressionDescriptor EtaGrowthRatePerTree(double? etaGrowthRatePerTree) { @@ -480,7 +536,9 @@ public DataframeAnalysisRegressionDescriptor EtaGrowthRatePerTree(dou } /// - /// Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization. + /// /// public DataframeAnalysisRegressionDescriptor FeatureBagFraction(double? featureBagFraction) { @@ -489,7 +547,9 @@ public DataframeAnalysisRegressionDescriptor FeatureBagFraction(doubl } /// - /// Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple `feature_processors` entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields. + /// + /// Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple feature_processors entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields. + /// /// public DataframeAnalysisRegressionDescriptor FeatureProcessors(ICollection? featureProcessors) { @@ -528,7 +588,9 @@ public DataframeAnalysisRegressionDescriptor FeatureProcessors(params } /// - /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// + /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// /// public DataframeAnalysisRegressionDescriptor Gamma(double? gamma) { @@ -537,7 +599,9 @@ public DataframeAnalysisRegressionDescriptor Gamma(double? gamma) } /// - /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// + /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// /// public DataframeAnalysisRegressionDescriptor Lambda(double? lambda) { @@ -546,7 +610,9 @@ public DataframeAnalysisRegressionDescriptor Lambda(double? lambda) } /// - /// The loss function used during regression. Available options are `mse` (mean squared error), `msle` (mean squared logarithmic error), `huber` (Pseudo-Huber loss). + /// + /// The loss function used during regression. Available options are mse (mean squared error), msle (mean squared logarithmic error), huber (Pseudo-Huber loss). + /// /// public DataframeAnalysisRegressionDescriptor LossFunction(string? lossFunction) { @@ -555,7 +621,9 @@ public DataframeAnalysisRegressionDescriptor LossFunction(string? los } /// - /// A positive number that is used as a parameter to the `loss_function`. + /// + /// A positive number that is used as a parameter to the loss_function. + /// /// public DataframeAnalysisRegressionDescriptor LossFunctionParameter(double? lossFunctionParameter) { @@ -564,7 +632,9 @@ public DataframeAnalysisRegressionDescriptor LossFunctionParameter(do } /// - /// Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization. + /// /// public DataframeAnalysisRegressionDescriptor MaxOptimizationRoundsPerHyperparameter(int? maxOptimizationRoundsPerHyperparameter) { @@ -573,7 +643,9 @@ public DataframeAnalysisRegressionDescriptor MaxOptimizationRoundsPer } /// - /// Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization. + /// /// public DataframeAnalysisRegressionDescriptor MaxTrees(int? maxTrees) { @@ -582,7 +654,9 @@ public DataframeAnalysisRegressionDescriptor MaxTrees(int? maxTrees) } /// - /// Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs. + /// + /// Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs. + /// /// public DataframeAnalysisRegressionDescriptor NumTopFeatureImportanceValues(int? numTopFeatureImportanceValues) { @@ -591,7 +665,9 @@ public DataframeAnalysisRegressionDescriptor NumTopFeatureImportanceV } /// - /// Defines the name of the prediction field in the results. Defaults to `_prediction`. + /// + /// Defines the name of the prediction field in the results. Defaults to <dependent_variable>_prediction. + /// /// public DataframeAnalysisRegressionDescriptor PredictionFieldName(Elastic.Clients.Elasticsearch.Serverless.Field? predictionFieldName) { @@ -600,7 +676,9 @@ public DataframeAnalysisRegressionDescriptor PredictionFieldName(Elas } /// - /// Defines the name of the prediction field in the results. Defaults to `_prediction`. + /// + /// Defines the name of the prediction field in the results. Defaults to <dependent_variable>_prediction. + /// /// public DataframeAnalysisRegressionDescriptor PredictionFieldName(Expression> predictionFieldName) { @@ -609,7 +687,9 @@ public DataframeAnalysisRegressionDescriptor PredictionFieldName - /// Defines the name of the prediction field in the results. Defaults to `_prediction`. + /// + /// Defines the name of the prediction field in the results. Defaults to <dependent_variable>_prediction. + /// /// public DataframeAnalysisRegressionDescriptor PredictionFieldName(Expression> predictionFieldName) { @@ -618,7 +698,9 @@ public DataframeAnalysisRegressionDescriptor PredictionFieldName(Expr } /// - /// Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as `source` and `analyzed_fields` are the same). + /// + /// Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as source and analyzed_fields are the same). + /// /// public DataframeAnalysisRegressionDescriptor RandomizeSeed(double? randomizeSeed) { @@ -627,7 +709,9 @@ public DataframeAnalysisRegressionDescriptor RandomizeSeed(double? ra } /// - /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the `soft_tree_depth_tolerance` to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0. + /// + /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the soft_tree_depth_tolerance to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0. + /// /// public DataframeAnalysisRegressionDescriptor SoftTreeDepthLimit(int? softTreeDepthLimit) { @@ -636,7 +720,9 @@ public DataframeAnalysisRegressionDescriptor SoftTreeDepthLimit(int? } /// - /// Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds `soft_tree_depth_limit`. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01. + /// + /// Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds soft_tree_depth_limit. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01. + /// /// public DataframeAnalysisRegressionDescriptor SoftTreeDepthTolerance(double? softTreeDepthTolerance) { @@ -645,7 +731,9 @@ public DataframeAnalysisRegressionDescriptor SoftTreeDepthTolerance(d } /// - /// Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage. + /// + /// Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage. + /// /// public DataframeAnalysisRegressionDescriptor TrainingPercent(double? trainingPercent) { @@ -834,7 +922,9 @@ public DataframeAnalysisRegressionDescriptor() : base() private double? TrainingPercentValue { get; set; } /// - /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero. + /// + /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero. + /// /// public DataframeAnalysisRegressionDescriptor Alpha(double? alpha) { @@ -843,7 +933,11 @@ public DataframeAnalysisRegressionDescriptor Alpha(double? alpha) } /// - /// Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable.
For classification analysis, the data type of the field must be numeric (`integer`, `short`, `long`, `byte`), categorical (`ip` or `keyword`), or `boolean`. There must be no more than 30 different values in this field.
For regression analysis, the data type of the field must be numeric. + /// + /// Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable. + /// For classification analysis, the data type of the field must be numeric (integer, short, long, byte), categorical (ip or keyword), or boolean. There must be no more than 30 different values in this field. + /// For regression analysis, the data type of the field must be numeric. + /// /// public DataframeAnalysisRegressionDescriptor DependentVariable(string dependentVariable) { @@ -852,7 +946,9 @@ public DataframeAnalysisRegressionDescriptor DependentVariable(string dependentV } /// - /// Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1. + /// + /// Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1. + /// /// public DataframeAnalysisRegressionDescriptor DownsampleFactor(double? downsampleFactor) { @@ -861,7 +957,9 @@ public DataframeAnalysisRegressionDescriptor DownsampleFactor(double? downsample } /// - /// Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable. + /// + /// Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable. + /// /// public DataframeAnalysisRegressionDescriptor EarlyStoppingEnabled(bool? earlyStoppingEnabled = true) { @@ -870,7 +968,9 @@ public DataframeAnalysisRegressionDescriptor EarlyStoppingEnabled(bool? earlySto } /// - /// Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1. + /// + /// Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1. + /// /// public DataframeAnalysisRegressionDescriptor Eta(double? eta) { @@ -879,7 +979,9 @@ public DataframeAnalysisRegressionDescriptor Eta(double? eta) } /// - /// Advanced configuration option. Specifies the rate at which `eta` increases for each new tree that is added to the forest. For example, a rate of 1.05 increases `eta` by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2. + /// + /// Advanced configuration option. Specifies the rate at which eta increases for each new tree that is added to the forest. For example, a rate of 1.05 increases eta by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2. + /// /// public DataframeAnalysisRegressionDescriptor EtaGrowthRatePerTree(double? etaGrowthRatePerTree) { @@ -888,7 +990,9 @@ public DataframeAnalysisRegressionDescriptor EtaGrowthRatePerTree(double? etaGro } /// - /// Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization. + /// /// public DataframeAnalysisRegressionDescriptor FeatureBagFraction(double? featureBagFraction) { @@ -897,7 +1001,9 @@ public DataframeAnalysisRegressionDescriptor FeatureBagFraction(double? featureB } /// - /// Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple `feature_processors` entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields. + /// + /// Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple feature_processors entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields. + /// /// public DataframeAnalysisRegressionDescriptor FeatureProcessors(ICollection? featureProcessors) { @@ -936,7 +1042,9 @@ public DataframeAnalysisRegressionDescriptor FeatureProcessors(params Action - /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// + /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// /// public DataframeAnalysisRegressionDescriptor Gamma(double? gamma) { @@ -945,7 +1053,9 @@ public DataframeAnalysisRegressionDescriptor Gamma(double? gamma) } /// - /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// + /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// /// public DataframeAnalysisRegressionDescriptor Lambda(double? lambda) { @@ -954,7 +1064,9 @@ public DataframeAnalysisRegressionDescriptor Lambda(double? lambda) } /// - /// The loss function used during regression. Available options are `mse` (mean squared error), `msle` (mean squared logarithmic error), `huber` (Pseudo-Huber loss). + /// + /// The loss function used during regression. Available options are mse (mean squared error), msle (mean squared logarithmic error), huber (Pseudo-Huber loss). + /// /// public DataframeAnalysisRegressionDescriptor LossFunction(string? lossFunction) { @@ -963,7 +1075,9 @@ public DataframeAnalysisRegressionDescriptor LossFunction(string? lossFunction) } /// - /// A positive number that is used as a parameter to the `loss_function`. + /// + /// A positive number that is used as a parameter to the loss_function. + /// /// public DataframeAnalysisRegressionDescriptor LossFunctionParameter(double? lossFunctionParameter) { @@ -972,7 +1086,9 @@ public DataframeAnalysisRegressionDescriptor LossFunctionParameter(double? lossF } /// - /// Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization. + /// /// public DataframeAnalysisRegressionDescriptor MaxOptimizationRoundsPerHyperparameter(int? maxOptimizationRoundsPerHyperparameter) { @@ -981,7 +1097,9 @@ public DataframeAnalysisRegressionDescriptor MaxOptimizationRoundsPerHyperparame } /// - /// Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization. + /// /// public DataframeAnalysisRegressionDescriptor MaxTrees(int? maxTrees) { @@ -990,7 +1108,9 @@ public DataframeAnalysisRegressionDescriptor MaxTrees(int? maxTrees) } /// - /// Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs. + /// + /// Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs. + /// /// public DataframeAnalysisRegressionDescriptor NumTopFeatureImportanceValues(int? numTopFeatureImportanceValues) { @@ -999,7 +1119,9 @@ public DataframeAnalysisRegressionDescriptor NumTopFeatureImportanceValues(int? } /// - /// Defines the name of the prediction field in the results. Defaults to `_prediction`. + /// + /// Defines the name of the prediction field in the results. Defaults to <dependent_variable>_prediction. + /// /// public DataframeAnalysisRegressionDescriptor PredictionFieldName(Elastic.Clients.Elasticsearch.Serverless.Field? predictionFieldName) { @@ -1008,7 +1130,9 @@ public DataframeAnalysisRegressionDescriptor PredictionFieldName(Elastic.Clients } /// - /// Defines the name of the prediction field in the results. Defaults to `_prediction`. + /// + /// Defines the name of the prediction field in the results. Defaults to <dependent_variable>_prediction. + /// /// public DataframeAnalysisRegressionDescriptor PredictionFieldName(Expression> predictionFieldName) { @@ -1017,7 +1141,9 @@ public DataframeAnalysisRegressionDescriptor PredictionFieldName - /// Defines the name of the prediction field in the results. Defaults to `_prediction`. + /// + /// Defines the name of the prediction field in the results. Defaults to <dependent_variable>_prediction. + /// /// public DataframeAnalysisRegressionDescriptor PredictionFieldName(Expression> predictionFieldName) { @@ -1026,7 +1152,9 @@ public DataframeAnalysisRegressionDescriptor PredictionFieldName(Expr } /// - /// Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as `source` and `analyzed_fields` are the same). + /// + /// Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as source and analyzed_fields are the same). + /// /// public DataframeAnalysisRegressionDescriptor RandomizeSeed(double? randomizeSeed) { @@ -1035,7 +1163,9 @@ public DataframeAnalysisRegressionDescriptor RandomizeSeed(double? randomizeSeed } /// - /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the `soft_tree_depth_tolerance` to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0. + /// + /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the soft_tree_depth_tolerance to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0. + /// /// public DataframeAnalysisRegressionDescriptor SoftTreeDepthLimit(int? softTreeDepthLimit) { @@ -1044,7 +1174,9 @@ public DataframeAnalysisRegressionDescriptor SoftTreeDepthLimit(int? softTreeDep } /// - /// Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds `soft_tree_depth_limit`. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01. + /// + /// Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds soft_tree_depth_limit. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01. + /// /// public DataframeAnalysisRegressionDescriptor SoftTreeDepthTolerance(double? softTreeDepthTolerance) { @@ -1053,7 +1185,9 @@ public DataframeAnalysisRegressionDescriptor SoftTreeDepthTolerance(double? soft } /// - /// Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage. + /// + /// Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage. + /// /// public DataframeAnalysisRegressionDescriptor TrainingPercent(double? trainingPercent) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalytics.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalytics.g.cs index 95ed3300a35..f8050261083 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalytics.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalytics.g.cs @@ -30,37 +30,49 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DataframeAnalytics { /// - /// For running jobs only, contains messages relating to the selection of a node to run the job. + /// + /// For running jobs only, contains messages relating to the selection of a node to run the job. + /// /// [JsonInclude, JsonPropertyName("assignment_explanation")] public string? AssignmentExplanation { get; init; } /// - /// An object that provides counts for the quantity of documents skipped, used in training, or available for testing. + /// + /// An object that provides counts for the quantity of documents skipped, used in training, or available for testing. + /// /// [JsonInclude, JsonPropertyName("data_counts")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalyticsStatsDataCounts DataCounts { get; init; } /// - /// The unique identifier of the data frame analytics job. + /// + /// The unique identifier of the data frame analytics job. + /// /// [JsonInclude, JsonPropertyName("id")] public string Id { get; init; } /// - /// An object describing memory usage of the analytics. It is present only after the job is started and memory usage is reported. + /// + /// An object describing memory usage of the analytics. It is present only after the job is started and memory usage is reported. + /// /// [JsonInclude, JsonPropertyName("memory_usage")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalyticsStatsMemoryUsage MemoryUsage { get; init; } /// - /// The progress report of the data frame analytics job by phase. + /// + /// The progress report of the data frame analytics job by phase. + /// /// [JsonInclude, JsonPropertyName("progress")] public IReadOnlyCollection Progress { get; init; } /// - /// The status of the data frame analytics job, which can be one of the following values: failed, started, starting, stopping, stopped. + /// + /// The status of the data frame analytics job, which can be one of the following values: failed, started, starting, stopping, stopped. + /// /// [JsonInclude, JsonPropertyName("state")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeState State { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsAuthorization.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsAuthorization.g.cs index a60de5b8091..ec4d17328df 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsAuthorization.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsAuthorization.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DataframeAnalyticsAuthorization { /// - /// If an API key was used for the most recent update to the job, its name and identifier are listed in the response. + /// + /// If an API key was used for the most recent update to the job, its name and identifier are listed in the response. + /// /// [JsonInclude, JsonPropertyName("api_key")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ApiKeyAuthorization? ApiKey { get; init; } /// - /// If a user ID was used for the most recent update to the job, its roles at the time of the update are listed in the response. + /// + /// If a user ID was used for the most recent update to the job, its roles at the time of the update are listed in the response. + /// /// [JsonInclude, JsonPropertyName("roles")] public IReadOnlyCollection? Roles { get; init; } /// - /// If a service account was used for the most recent update to the job, the account name is listed in the response. + /// + /// If a service account was used for the most recent update to the job, the account name is listed in the response. + /// /// [JsonInclude, JsonPropertyName("service_account")] public string? ServiceAccount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsDestination.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsDestination.g.cs index 4818909dfcf..81422f87404 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsDestination.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsDestination.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DataframeAnalyticsDestination { /// - /// Defines the destination index to store the results of the data frame analytics job. + /// + /// Defines the destination index to store the results of the data frame analytics job. + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.Serverless.IndexName Index { get; set; } /// - /// Defines the name of the field in which to store the results of the analysis. Defaults to `ml`. + /// + /// Defines the name of the field in which to store the results of the analysis. Defaults to ml. + /// /// [JsonInclude, JsonPropertyName("results_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? ResultsField { get; set; } @@ -54,7 +58,9 @@ public DataframeAnalyticsDestinationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? ResultsFieldValue { get; set; } /// - /// Defines the destination index to store the results of the data frame analytics job. + /// + /// Defines the destination index to store the results of the data frame analytics job. + /// /// public DataframeAnalyticsDestinationDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.IndexName index) { @@ -63,7 +69,9 @@ public DataframeAnalyticsDestinationDescriptor Index(Elastic.Clients. } /// - /// Defines the name of the field in which to store the results of the analysis. Defaults to `ml`. + /// + /// Defines the name of the field in which to store the results of the analysis. Defaults to ml. + /// /// public DataframeAnalyticsDestinationDescriptor ResultsField(Elastic.Clients.Elasticsearch.Serverless.Field? resultsField) { @@ -72,7 +80,9 @@ public DataframeAnalyticsDestinationDescriptor ResultsField(Elastic.C } /// - /// Defines the name of the field in which to store the results of the analysis. Defaults to `ml`. + /// + /// Defines the name of the field in which to store the results of the analysis. Defaults to ml. + /// /// public DataframeAnalyticsDestinationDescriptor ResultsField(Expression> resultsField) { @@ -81,7 +91,9 @@ public DataframeAnalyticsDestinationDescriptor ResultsField(E } /// - /// Defines the name of the field in which to store the results of the analysis. Defaults to `ml`. + /// + /// Defines the name of the field in which to store the results of the analysis. Defaults to ml. + /// /// public DataframeAnalyticsDestinationDescriptor ResultsField(Expression> resultsField) { @@ -116,7 +128,9 @@ public DataframeAnalyticsDestinationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? ResultsFieldValue { get; set; } /// - /// Defines the destination index to store the results of the data frame analytics job. + /// + /// Defines the destination index to store the results of the data frame analytics job. + /// /// public DataframeAnalyticsDestinationDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.IndexName index) { @@ -125,7 +139,9 @@ public DataframeAnalyticsDestinationDescriptor Index(Elastic.Clients.Elasticsear } /// - /// Defines the name of the field in which to store the results of the analysis. Defaults to `ml`. + /// + /// Defines the name of the field in which to store the results of the analysis. Defaults to ml. + /// /// public DataframeAnalyticsDestinationDescriptor ResultsField(Elastic.Clients.Elasticsearch.Serverless.Field? resultsField) { @@ -134,7 +150,9 @@ public DataframeAnalyticsDestinationDescriptor ResultsField(Elastic.Clients.Elas } /// - /// Defines the name of the field in which to store the results of the analysis. Defaults to `ml`. + /// + /// Defines the name of the field in which to store the results of the analysis. Defaults to ml. + /// /// public DataframeAnalyticsDestinationDescriptor ResultsField(Expression> resultsField) { @@ -143,7 +161,9 @@ public DataframeAnalyticsDestinationDescriptor ResultsField(E } /// - /// Defines the name of the field in which to store the results of the analysis. Defaults to `ml`. + /// + /// Defines the name of the field in which to store the results of the analysis. Defaults to ml. + /// /// public DataframeAnalyticsDestinationDescriptor ResultsField(Expression> resultsField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsFieldSelection.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsFieldSelection.g.cs index abf1a9ce632..d99a523835a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsFieldSelection.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsFieldSelection.g.cs @@ -30,37 +30,49 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DataframeAnalyticsFieldSelection { /// - /// The feature type of this field for the analysis. May be categorical or numerical. + /// + /// The feature type of this field for the analysis. May be categorical or numerical. + /// /// [JsonInclude, JsonPropertyName("feature_type")] public string? FeatureType { get; init; } /// - /// Whether the field is selected to be included in the analysis. + /// + /// Whether the field is selected to be included in the analysis. + /// /// [JsonInclude, JsonPropertyName("is_included")] public bool IsIncluded { get; init; } /// - /// Whether the field is required. + /// + /// Whether the field is required. + /// /// [JsonInclude, JsonPropertyName("is_required")] public bool IsRequired { get; init; } /// - /// The mapping types of the field. + /// + /// The mapping types of the field. + /// /// [JsonInclude, JsonPropertyName("mapping_types")] public IReadOnlyCollection MappingTypes { get; init; } /// - /// The field name. + /// + /// The field name. + /// /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } /// - /// The reason a field is not selected to be included in the analysis. + /// + /// The reason a field is not selected to be included in the analysis. + /// /// [JsonInclude, JsonPropertyName("reason")] public string? Reason { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsMemoryEstimation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsMemoryEstimation.g.cs index d804a0dbc44..dd0c12b7901 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsMemoryEstimation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsMemoryEstimation.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DataframeAnalyticsMemoryEstimation { /// - /// Estimated memory usage under the assumption that overflowing to disk is allowed during data frame analytics. expected_memory_with_disk is usually smaller than expected_memory_without_disk as using disk allows to limit the main memory needed to perform data frame analytics. + /// + /// Estimated memory usage under the assumption that overflowing to disk is allowed during data frame analytics. expected_memory_with_disk is usually smaller than expected_memory_without_disk as using disk allows to limit the main memory needed to perform data frame analytics. + /// /// [JsonInclude, JsonPropertyName("expected_memory_with_disk")] public string ExpectedMemoryWithDisk { get; init; } /// - /// Estimated memory usage under the assumption that the whole data frame analytics should happen in memory (i.e. without overflowing to disk). + /// + /// Estimated memory usage under the assumption that the whole data frame analytics should happen in memory (i.e. without overflowing to disk). + /// /// [JsonInclude, JsonPropertyName("expected_memory_without_disk")] public string ExpectedMemoryWithoutDisk { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsSource.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsSource.g.cs index af109e48370..a4f72488bff 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsSource.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsSource.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DataframeAnalyticsSource { /// - /// Index or indices on which to perform the analysis. It can be a single index or index pattern as well as an array of indices or patterns. NOTE: If your source indices contain documents with the same IDs, only the document that is indexed last appears in the destination index. + /// + /// Index or indices on which to perform the analysis. It can be a single index or index pattern as well as an array of indices or patterns. NOTE: If your source indices contain documents with the same IDs, only the document that is indexed last appears in the destination index. + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.Serverless.Indices Indices { get; set; } /// - /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: {"match_all": {}}. + /// + /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: {"match_all": {}}. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? Query { get; set; } /// - /// Definitions of runtime fields that will become part of the mapping of the destination index. + /// + /// Definitions of runtime fields that will become part of the mapping of the destination index. + /// /// [JsonInclude, JsonPropertyName("runtime_mappings")] public IDictionary? RuntimeMappings { get; set; } /// - /// Specify `includes` and/or `excludes patterns to select which fields will be present in the destination. Fields that are excluded cannot be included in the analysis. + /// + /// Specify includes and/or `excludes patterns to select which fields will be present in the destination. Fields that are excluded cannot be included in the analysis. + /// /// [JsonInclude, JsonPropertyName("_source")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalysisAnalyzedFields? Source { get; set; } @@ -72,7 +80,9 @@ public DataframeAnalyticsSourceDescriptor() : base() private Action SourceDescriptorAction { get; set; } /// - /// Index or indices on which to perform the analysis. It can be a single index or index pattern as well as an array of indices or patterns. NOTE: If your source indices contain documents with the same IDs, only the document that is indexed last appears in the destination index. + /// + /// Index or indices on which to perform the analysis. It can be a single index or index pattern as well as an array of indices or patterns. NOTE: If your source indices contain documents with the same IDs, only the document that is indexed last appears in the destination index. + /// /// public DataframeAnalyticsSourceDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.Indices indices) { @@ -81,7 +91,9 @@ public DataframeAnalyticsSourceDescriptor Indices(Elastic.Clients.Ela } /// - /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: {"match_all": {}}. + /// + /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: {"match_all": {}}. + /// /// public DataframeAnalyticsSourceDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -108,7 +120,9 @@ public DataframeAnalyticsSourceDescriptor Query(Action - /// Definitions of runtime fields that will become part of the mapping of the destination index. + /// + /// Definitions of runtime fields that will become part of the mapping of the destination index. + /// /// public DataframeAnalyticsSourceDescriptor RuntimeMappings(Func>, FluentDescriptorDictionary>> selector) { @@ -117,7 +131,9 @@ public DataframeAnalyticsSourceDescriptor RuntimeMappings(Func - /// Specify `includes` and/or `excludes patterns to select which fields will be present in the destination. Fields that are excluded cannot be included in the analysis. + /// + /// Specify includes and/or `excludes patterns to select which fields will be present in the destination. Fields that are excluded cannot be included in the analysis. + /// /// public DataframeAnalyticsSourceDescriptor Source(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalysisAnalyzedFields? source) { @@ -208,7 +224,9 @@ public DataframeAnalyticsSourceDescriptor() : base() private Action SourceDescriptorAction { get; set; } /// - /// Index or indices on which to perform the analysis. It can be a single index or index pattern as well as an array of indices or patterns. NOTE: If your source indices contain documents with the same IDs, only the document that is indexed last appears in the destination index. + /// + /// Index or indices on which to perform the analysis. It can be a single index or index pattern as well as an array of indices or patterns. NOTE: If your source indices contain documents with the same IDs, only the document that is indexed last appears in the destination index. + /// /// public DataframeAnalyticsSourceDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.Indices indices) { @@ -217,7 +235,9 @@ public DataframeAnalyticsSourceDescriptor Indices(Elastic.Clients.Elasticsearch. } /// - /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: {"match_all": {}}. + /// + /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: {"match_all": {}}. + /// /// public DataframeAnalyticsSourceDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -244,7 +264,9 @@ public DataframeAnalyticsSourceDescriptor Query(Action - /// Definitions of runtime fields that will become part of the mapping of the destination index. + /// + /// Definitions of runtime fields that will become part of the mapping of the destination index. + /// /// public DataframeAnalyticsSourceDescriptor RuntimeMappings(Func, FluentDescriptorDictionary> selector) { @@ -253,7 +275,9 @@ public DataframeAnalyticsSourceDescriptor RuntimeMappings(Func - /// Specify `includes` and/or `excludes patterns to select which fields will be present in the destination. Fields that are excluded cannot be included in the analysis. + /// + /// Specify includes and/or `excludes patterns to select which fields will be present in the destination. Fields that are excluded cannot be included in the analysis. + /// /// public DataframeAnalyticsSourceDescriptor Source(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalysisAnalyzedFields? source) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsStatsDataCounts.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsStatsDataCounts.g.cs index cd9be8d45dc..7a5eedc30d6 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsStatsDataCounts.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsStatsDataCounts.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DataframeAnalyticsStatsDataCounts { /// - /// The number of documents that are skipped during the analysis because they contained values that are not supported by the analysis. For example, outlier detection does not support missing fields so it skips documents with missing fields. Likewise, all types of analysis skip documents that contain arrays with more than one element. + /// + /// The number of documents that are skipped during the analysis because they contained values that are not supported by the analysis. For example, outlier detection does not support missing fields so it skips documents with missing fields. Likewise, all types of analysis skip documents that contain arrays with more than one element. + /// /// [JsonInclude, JsonPropertyName("skipped_docs_count")] public int SkippedDocsCount { get; init; } /// - /// The number of documents that are not used for training the model and can be used for testing. + /// + /// The number of documents that are not used for training the model and can be used for testing. + /// /// [JsonInclude, JsonPropertyName("test_docs_count")] public int TestDocsCount { get; init; } /// - /// The number of documents that are used for training the model. + /// + /// The number of documents that are used for training the model. + /// /// [JsonInclude, JsonPropertyName("training_docs_count")] public int TrainingDocsCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsStatsMemoryUsage.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsStatsMemoryUsage.g.cs index 267a47b40c9..d9b2ed04691 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsStatsMemoryUsage.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsStatsMemoryUsage.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DataframeAnalyticsStatsMemoryUsage { /// - /// This value is present when the status is hard_limit and it is a new estimate of how much memory the job needs. + /// + /// This value is present when the status is hard_limit and it is a new estimate of how much memory the job needs. + /// /// [JsonInclude, JsonPropertyName("memory_reestimate_bytes")] public long? MemoryReestimateBytes { get; init; } /// - /// The number of bytes used at the highest peak of memory usage. + /// + /// The number of bytes used at the highest peak of memory usage. + /// /// [JsonInclude, JsonPropertyName("peak_usage_bytes")] public long PeakUsageBytes { get; init; } /// - /// The memory usage status. + /// + /// The memory usage status. + /// /// [JsonInclude, JsonPropertyName("status")] public string Status { get; init; } /// - /// The timestamp when memory usage was calculated. + /// + /// The timestamp when memory usage was calculated. + /// /// [JsonInclude, JsonPropertyName("timestamp")] public long? Timestamp { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsStatsProgress.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsStatsProgress.g.cs index f5e5e406f96..c61a9dae93a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsStatsProgress.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsStatsProgress.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DataframeAnalyticsStatsProgress { /// - /// Defines the phase of the data frame analytics job. + /// + /// Defines the phase of the data frame analytics job. + /// /// [JsonInclude, JsonPropertyName("phase")] public string Phase { get; init; } /// - /// The progress that the data frame analytics job has made expressed in percentage. + /// + /// The progress that the data frame analytics job has made expressed in percentage. + /// /// [JsonInclude, JsonPropertyName("progress_percent")] public int ProgressPercent { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsSummary.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsSummary.g.cs index 8225b2f6b20..83635a8a546 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsSummary.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsSummary.g.cs @@ -37,7 +37,9 @@ public sealed partial class DataframeAnalyticsSummary public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalysisAnalyzedFields? AnalyzedFields { get; init; } /// - /// The security privileges that the job uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the job, this property is omitted. + /// + /// The security privileges that the job uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the job, this property is omitted. + /// /// [JsonInclude, JsonPropertyName("authorization")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalyticsAuthorization? Authorization { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeClassificationSummary.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeClassificationSummary.g.cs index 00c20dd5990..ef0f0d47608 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeClassificationSummary.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeClassificationSummary.g.cs @@ -30,31 +30,42 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DataframeClassificationSummary { /// - /// Accuracy of predictions (per-class and overall). + /// + /// Accuracy of predictions (per-class and overall). + /// /// [JsonInclude, JsonPropertyName("accuracy")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeClassificationSummaryAccuracy? Accuracy { get; init; } /// - /// The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve.
It is calculated for a specific class (provided as "class_name") treated as positive. + /// + /// The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. + /// It is calculated for a specific class (provided as "class_name") treated as positive. + /// /// [JsonInclude, JsonPropertyName("auc_roc")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeEvaluationSummaryAucRoc? AucRoc { get; init; } /// - /// Multiclass confusion matrix. + /// + /// Multiclass confusion matrix. + /// /// [JsonInclude, JsonPropertyName("multiclass_confusion_matrix")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeClassificationSummaryMulticlassConfusionMatrix? MulticlassConfusionMatrix { get; init; } /// - /// Precision of predictions (per-class and average). + /// + /// Precision of predictions (per-class and average). + /// /// [JsonInclude, JsonPropertyName("precision")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeClassificationSummaryPrecision? Precision { get; init; } /// - /// Recall of predictions (per-class and average). + /// + /// Recall of predictions (per-class and average). + /// /// [JsonInclude, JsonPropertyName("recall")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeClassificationSummaryRecall? Recall { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationClassification.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationClassification.g.cs index c82d7504932..b41069346fa 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationClassification.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationClassification.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DataframeEvaluationClassification { /// - /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// + /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// /// [JsonInclude, JsonPropertyName("actual_field")] public Elastic.Clients.Elasticsearch.Serverless.Field ActualField { get; set; } /// - /// Specifies the metrics that are used for the evaluation. + /// + /// Specifies the metrics that are used for the evaluation. + /// /// [JsonInclude, JsonPropertyName("metrics")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeEvaluationClassificationMetrics? Metrics { get; set; } /// - /// The field in the index which contains the predicted value, in other words the results of the classification analysis. + /// + /// The field in the index which contains the predicted value, in other words the results of the classification analysis. + /// /// [JsonInclude, JsonPropertyName("predicted_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? PredictedField { get; set; } /// - /// The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }. This field must be defined as nested in the mappings. + /// + /// The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }. This field must be defined as nested in the mappings. + /// /// [JsonInclude, JsonPropertyName("top_classes_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? TopClassesField { get; set; } @@ -72,7 +80,9 @@ public DataframeEvaluationClassificationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TopClassesFieldValue { get; set; } /// - /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// + /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// /// public DataframeEvaluationClassificationDescriptor ActualField(Elastic.Clients.Elasticsearch.Serverless.Field actualField) { @@ -81,7 +91,9 @@ public DataframeEvaluationClassificationDescriptor ActualField(Elasti } /// - /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// + /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// /// public DataframeEvaluationClassificationDescriptor ActualField(Expression> actualField) { @@ -90,7 +102,9 @@ public DataframeEvaluationClassificationDescriptor ActualField - /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// + /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// /// public DataframeEvaluationClassificationDescriptor ActualField(Expression> actualField) { @@ -99,7 +113,9 @@ public DataframeEvaluationClassificationDescriptor ActualField(Expres } /// - /// Specifies the metrics that are used for the evaluation. + /// + /// Specifies the metrics that are used for the evaluation. + /// /// public DataframeEvaluationClassificationDescriptor Metrics(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeEvaluationClassificationMetrics? metrics) { @@ -126,7 +142,9 @@ public DataframeEvaluationClassificationDescriptor Metrics(Action - /// The field in the index which contains the predicted value, in other words the results of the classification analysis. + /// + /// The field in the index which contains the predicted value, in other words the results of the classification analysis. + /// /// public DataframeEvaluationClassificationDescriptor PredictedField(Elastic.Clients.Elasticsearch.Serverless.Field? predictedField) { @@ -135,7 +153,9 @@ public DataframeEvaluationClassificationDescriptor PredictedField(Ela } /// - /// The field in the index which contains the predicted value, in other words the results of the classification analysis. + /// + /// The field in the index which contains the predicted value, in other words the results of the classification analysis. + /// /// public DataframeEvaluationClassificationDescriptor PredictedField(Expression> predictedField) { @@ -144,7 +164,9 @@ public DataframeEvaluationClassificationDescriptor PredictedField - /// The field in the index which contains the predicted value, in other words the results of the classification analysis. + /// + /// The field in the index which contains the predicted value, in other words the results of the classification analysis. + /// /// public DataframeEvaluationClassificationDescriptor PredictedField(Expression> predictedField) { @@ -153,7 +175,9 @@ public DataframeEvaluationClassificationDescriptor PredictedField(Exp } /// - /// The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }. This field must be defined as nested in the mappings. + /// + /// The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }. This field must be defined as nested in the mappings. + /// /// public DataframeEvaluationClassificationDescriptor TopClassesField(Elastic.Clients.Elasticsearch.Serverless.Field? topClassesField) { @@ -162,7 +186,9 @@ public DataframeEvaluationClassificationDescriptor TopClassesField(El } /// - /// The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }. This field must be defined as nested in the mappings. + /// + /// The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }. This field must be defined as nested in the mappings. + /// /// public DataframeEvaluationClassificationDescriptor TopClassesField(Expression> topClassesField) { @@ -171,7 +197,9 @@ public DataframeEvaluationClassificationDescriptor TopClassesField - /// The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }. This field must be defined as nested in the mappings. + /// + /// The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }. This field must be defined as nested in the mappings. + /// /// public DataframeEvaluationClassificationDescriptor TopClassesField(Expression> topClassesField) { @@ -232,7 +260,9 @@ public DataframeEvaluationClassificationDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TopClassesFieldValue { get; set; } /// - /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// + /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// /// public DataframeEvaluationClassificationDescriptor ActualField(Elastic.Clients.Elasticsearch.Serverless.Field actualField) { @@ -241,7 +271,9 @@ public DataframeEvaluationClassificationDescriptor ActualField(Elastic.Clients.E } /// - /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// + /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// /// public DataframeEvaluationClassificationDescriptor ActualField(Expression> actualField) { @@ -250,7 +282,9 @@ public DataframeEvaluationClassificationDescriptor ActualField - /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// + /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// /// public DataframeEvaluationClassificationDescriptor ActualField(Expression> actualField) { @@ -259,7 +293,9 @@ public DataframeEvaluationClassificationDescriptor ActualField(Expres } /// - /// Specifies the metrics that are used for the evaluation. + /// + /// Specifies the metrics that are used for the evaluation. + /// /// public DataframeEvaluationClassificationDescriptor Metrics(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeEvaluationClassificationMetrics? metrics) { @@ -286,7 +322,9 @@ public DataframeEvaluationClassificationDescriptor Metrics(Action - /// The field in the index which contains the predicted value, in other words the results of the classification analysis. + /// + /// The field in the index which contains the predicted value, in other words the results of the classification analysis. + /// /// public DataframeEvaluationClassificationDescriptor PredictedField(Elastic.Clients.Elasticsearch.Serverless.Field? predictedField) { @@ -295,7 +333,9 @@ public DataframeEvaluationClassificationDescriptor PredictedField(Elastic.Client } /// - /// The field in the index which contains the predicted value, in other words the results of the classification analysis. + /// + /// The field in the index which contains the predicted value, in other words the results of the classification analysis. + /// /// public DataframeEvaluationClassificationDescriptor PredictedField(Expression> predictedField) { @@ -304,7 +344,9 @@ public DataframeEvaluationClassificationDescriptor PredictedField - /// The field in the index which contains the predicted value, in other words the results of the classification analysis. + /// + /// The field in the index which contains the predicted value, in other words the results of the classification analysis. + /// /// public DataframeEvaluationClassificationDescriptor PredictedField(Expression> predictedField) { @@ -313,7 +355,9 @@ public DataframeEvaluationClassificationDescriptor PredictedField(Exp } /// - /// The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }. This field must be defined as nested in the mappings. + /// + /// The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }. This field must be defined as nested in the mappings. + /// /// public DataframeEvaluationClassificationDescriptor TopClassesField(Elastic.Clients.Elasticsearch.Serverless.Field? topClassesField) { @@ -322,7 +366,9 @@ public DataframeEvaluationClassificationDescriptor TopClassesField(Elastic.Clien } /// - /// The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }. This field must be defined as nested in the mappings. + /// + /// The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }. This field must be defined as nested in the mappings. + /// /// public DataframeEvaluationClassificationDescriptor TopClassesField(Expression> topClassesField) { @@ -331,7 +377,9 @@ public DataframeEvaluationClassificationDescriptor TopClassesField - /// The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }. This field must be defined as nested in the mappings. + /// + /// The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }. This field must be defined as nested in the mappings. + /// /// public DataframeEvaluationClassificationDescriptor TopClassesField(Expression> topClassesField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationClassificationMetrics.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationClassificationMetrics.g.cs index 0468c386a0c..f776f2df50a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationClassificationMetrics.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationClassificationMetrics.g.cs @@ -30,31 +30,41 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DataframeEvaluationClassificationMetrics { /// - /// Accuracy of predictions (per-class and overall). + /// + /// Accuracy of predictions (per-class and overall). + /// /// [JsonInclude, JsonPropertyName("accuracy")] public IDictionary? Accuracy { get; set; } /// - /// The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. It is calculated for a specific class (provided as "class_name") treated as positive. + /// + /// The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. It is calculated for a specific class (provided as "class_name") treated as positive. + /// /// [JsonInclude, JsonPropertyName("auc_roc")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeEvaluationClassificationMetricsAucRoc? AucRoc { get; set; } /// - /// Multiclass confusion matrix. + /// + /// Multiclass confusion matrix. + /// /// [JsonInclude, JsonPropertyName("multiclass_confusion_matrix")] public IDictionary? MulticlassConfusionMatrix { get; set; } /// - /// Precision of predictions (per-class and average). + /// + /// Precision of predictions (per-class and average). + /// /// [JsonInclude, JsonPropertyName("precision")] public IDictionary? Precision { get; set; } /// - /// Recall of predictions (per-class and average). + /// + /// Recall of predictions (per-class and average). + /// /// [JsonInclude, JsonPropertyName("recall")] public IDictionary? Recall { get; set; } @@ -77,7 +87,9 @@ public DataframeEvaluationClassificationMetricsDescriptor() : base() private IDictionary? RecallValue { get; set; } /// - /// Accuracy of predictions (per-class and overall). + /// + /// Accuracy of predictions (per-class and overall). + /// /// public DataframeEvaluationClassificationMetricsDescriptor Accuracy(Func, FluentDictionary> selector) { @@ -86,7 +98,9 @@ public DataframeEvaluationClassificationMetricsDescriptor Accuracy(Func - /// The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. It is calculated for a specific class (provided as "class_name") treated as positive. + /// + /// The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. It is calculated for a specific class (provided as "class_name") treated as positive. + /// /// public DataframeEvaluationClassificationMetricsDescriptor AucRoc(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeEvaluationClassificationMetricsAucRoc? aucRoc) { @@ -113,7 +127,9 @@ public DataframeEvaluationClassificationMetricsDescriptor AucRoc(Action - /// Multiclass confusion matrix. + /// + /// Multiclass confusion matrix. + /// /// public DataframeEvaluationClassificationMetricsDescriptor MulticlassConfusionMatrix(Func, FluentDictionary> selector) { @@ -122,7 +138,9 @@ public DataframeEvaluationClassificationMetricsDescriptor MulticlassConfusionMat } /// - /// Precision of predictions (per-class and average). + /// + /// Precision of predictions (per-class and average). + /// /// public DataframeEvaluationClassificationMetricsDescriptor Precision(Func, FluentDictionary> selector) { @@ -131,7 +149,9 @@ public DataframeEvaluationClassificationMetricsDescriptor Precision(Func - /// Recall of predictions (per-class and average). + /// + /// Recall of predictions (per-class and average). + /// /// public DataframeEvaluationClassificationMetricsDescriptor Recall(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationClassificationMetricsAucRoc.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationClassificationMetricsAucRoc.g.cs index f14f1c38e45..4c8632f587f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationClassificationMetricsAucRoc.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationClassificationMetricsAucRoc.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DataframeEvaluationClassificationMetricsAucRoc { /// - /// Name of the only class that is treated as positive during AUC ROC calculation. Other classes are treated as negative ("one-vs-all" strategy). All the evaluated documents must have class_name in the list of their top classes. + /// + /// Name of the only class that is treated as positive during AUC ROC calculation. Other classes are treated as negative ("one-vs-all" strategy). All the evaluated documents must have class_name in the list of their top classes. + /// /// [JsonInclude, JsonPropertyName("class_name")] public Elastic.Clients.Elasticsearch.Serverless.Name? ClassName { get; set; } /// - /// Whether or not the curve should be returned in addition to the score. Default value is false. + /// + /// Whether or not the curve should be returned in addition to the score. Default value is false. + /// /// [JsonInclude, JsonPropertyName("include_curve")] public bool? IncludeCurve { get; set; } @@ -54,7 +58,9 @@ public DataframeEvaluationClassificationMetricsAucRocDescriptor() : base() private bool? IncludeCurveValue { get; set; } /// - /// Name of the only class that is treated as positive during AUC ROC calculation. Other classes are treated as negative ("one-vs-all" strategy). All the evaluated documents must have class_name in the list of their top classes. + /// + /// Name of the only class that is treated as positive during AUC ROC calculation. Other classes are treated as negative ("one-vs-all" strategy). All the evaluated documents must have class_name in the list of their top classes. + /// /// public DataframeEvaluationClassificationMetricsAucRocDescriptor ClassName(Elastic.Clients.Elasticsearch.Serverless.Name? className) { @@ -63,7 +69,9 @@ public DataframeEvaluationClassificationMetricsAucRocDescriptor ClassName(Elasti } /// - /// Whether or not the curve should be returned in addition to the score. Default value is false. + /// + /// Whether or not the curve should be returned in addition to the score. Default value is false. + /// /// public DataframeEvaluationClassificationMetricsAucRocDescriptor IncludeCurve(bool? includeCurve = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationOutlierDetection.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationOutlierDetection.g.cs index 2b74fe4f547..d0e2c195922 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationOutlierDetection.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationOutlierDetection.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DataframeEvaluationOutlierDetection { /// - /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// + /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// /// [JsonInclude, JsonPropertyName("actual_field")] public Elastic.Clients.Elasticsearch.Serverless.Field ActualField { get; set; } /// - /// Specifies the metrics that are used for the evaluation. + /// + /// Specifies the metrics that are used for the evaluation. + /// /// [JsonInclude, JsonPropertyName("metrics")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeEvaluationOutlierDetectionMetrics? Metrics { get; set; } /// - /// The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis. + /// + /// The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis. + /// /// [JsonInclude, JsonPropertyName("predicted_probability_field")] public Elastic.Clients.Elasticsearch.Serverless.Field PredictedProbabilityField { get; set; } @@ -65,7 +71,9 @@ public DataframeEvaluationOutlierDetectionDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field PredictedProbabilityFieldValue { get; set; } /// - /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// + /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// /// public DataframeEvaluationOutlierDetectionDescriptor ActualField(Elastic.Clients.Elasticsearch.Serverless.Field actualField) { @@ -74,7 +82,9 @@ public DataframeEvaluationOutlierDetectionDescriptor ActualField(Elas } /// - /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// + /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// /// public DataframeEvaluationOutlierDetectionDescriptor ActualField(Expression> actualField) { @@ -83,7 +93,9 @@ public DataframeEvaluationOutlierDetectionDescriptor ActualField - /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// + /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// /// public DataframeEvaluationOutlierDetectionDescriptor ActualField(Expression> actualField) { @@ -92,7 +104,9 @@ public DataframeEvaluationOutlierDetectionDescriptor ActualField(Expr } /// - /// Specifies the metrics that are used for the evaluation. + /// + /// Specifies the metrics that are used for the evaluation. + /// /// public DataframeEvaluationOutlierDetectionDescriptor Metrics(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeEvaluationOutlierDetectionMetrics? metrics) { @@ -119,7 +133,9 @@ public DataframeEvaluationOutlierDetectionDescriptor Metrics(Action - /// The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis. + /// + /// The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis. + /// /// public DataframeEvaluationOutlierDetectionDescriptor PredictedProbabilityField(Elastic.Clients.Elasticsearch.Serverless.Field predictedProbabilityField) { @@ -128,7 +144,9 @@ public DataframeEvaluationOutlierDetectionDescriptor PredictedProbabi } /// - /// The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis. + /// + /// The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis. + /// /// public DataframeEvaluationOutlierDetectionDescriptor PredictedProbabilityField(Expression> predictedProbabilityField) { @@ -137,7 +155,9 @@ public DataframeEvaluationOutlierDetectionDescriptor PredictedProbabi } /// - /// The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis. + /// + /// The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis. + /// /// public DataframeEvaluationOutlierDetectionDescriptor PredictedProbabilityField(Expression> predictedProbabilityField) { @@ -187,7 +207,9 @@ public DataframeEvaluationOutlierDetectionDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field PredictedProbabilityFieldValue { get; set; } /// - /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// + /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// /// public DataframeEvaluationOutlierDetectionDescriptor ActualField(Elastic.Clients.Elasticsearch.Serverless.Field actualField) { @@ -196,7 +218,9 @@ public DataframeEvaluationOutlierDetectionDescriptor ActualField(Elastic.Clients } /// - /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// + /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// /// public DataframeEvaluationOutlierDetectionDescriptor ActualField(Expression> actualField) { @@ -205,7 +229,9 @@ public DataframeEvaluationOutlierDetectionDescriptor ActualField - /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// + /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// /// public DataframeEvaluationOutlierDetectionDescriptor ActualField(Expression> actualField) { @@ -214,7 +240,9 @@ public DataframeEvaluationOutlierDetectionDescriptor ActualField(Expr } /// - /// Specifies the metrics that are used for the evaluation. + /// + /// Specifies the metrics that are used for the evaluation. + /// /// public DataframeEvaluationOutlierDetectionDescriptor Metrics(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeEvaluationOutlierDetectionMetrics? metrics) { @@ -241,7 +269,9 @@ public DataframeEvaluationOutlierDetectionDescriptor Metrics(Action - /// The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis. + /// + /// The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis. + /// /// public DataframeEvaluationOutlierDetectionDescriptor PredictedProbabilityField(Elastic.Clients.Elasticsearch.Serverless.Field predictedProbabilityField) { @@ -250,7 +280,9 @@ public DataframeEvaluationOutlierDetectionDescriptor PredictedProbabilityField(E } /// - /// The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis. + /// + /// The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis. + /// /// public DataframeEvaluationOutlierDetectionDescriptor PredictedProbabilityField(Expression> predictedProbabilityField) { @@ -259,7 +291,9 @@ public DataframeEvaluationOutlierDetectionDescriptor PredictedProbabilityField - /// The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis. + /// + /// The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis. + /// /// public DataframeEvaluationOutlierDetectionDescriptor PredictedProbabilityField(Expression> predictedProbabilityField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationOutlierDetectionMetrics.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationOutlierDetectionMetrics.g.cs index 01852528fe3..708bc5f7268 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationOutlierDetectionMetrics.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationOutlierDetectionMetrics.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DataframeEvaluationOutlierDetectionMetrics { /// - /// The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. It is calculated for a specific class (provided as "class_name") treated as positive. + /// + /// The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. It is calculated for a specific class (provided as "class_name") treated as positive. + /// /// [JsonInclude, JsonPropertyName("auc_roc")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeEvaluationClassificationMetricsAucRoc? AucRoc { get; set; } /// - /// Accuracy of predictions (per-class and overall). + /// + /// Accuracy of predictions (per-class and overall). + /// /// [JsonInclude, JsonPropertyName("confusion_matrix")] public IDictionary? ConfusionMatrix { get; set; } /// - /// Precision of predictions (per-class and average). + /// + /// Precision of predictions (per-class and average). + /// /// [JsonInclude, JsonPropertyName("precision")] public IDictionary? Precision { get; set; } /// - /// Recall of predictions (per-class and average). + /// + /// Recall of predictions (per-class and average). + /// /// [JsonInclude, JsonPropertyName("recall")] public IDictionary? Recall { get; set; } @@ -70,7 +78,9 @@ public DataframeEvaluationOutlierDetectionMetricsDescriptor() : base() private IDictionary? RecallValue { get; set; } /// - /// The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. It is calculated for a specific class (provided as "class_name") treated as positive. + /// + /// The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. It is calculated for a specific class (provided as "class_name") treated as positive. + /// /// public DataframeEvaluationOutlierDetectionMetricsDescriptor AucRoc(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeEvaluationClassificationMetricsAucRoc? aucRoc) { @@ -97,7 +107,9 @@ public DataframeEvaluationOutlierDetectionMetricsDescriptor AucRoc(Action - /// Accuracy of predictions (per-class and overall). + /// + /// Accuracy of predictions (per-class and overall). + /// /// public DataframeEvaluationOutlierDetectionMetricsDescriptor ConfusionMatrix(Func, FluentDictionary> selector) { @@ -106,7 +118,9 @@ public DataframeEvaluationOutlierDetectionMetricsDescriptor ConfusionMatrix(Func } /// - /// Precision of predictions (per-class and average). + /// + /// Precision of predictions (per-class and average). + /// /// public DataframeEvaluationOutlierDetectionMetricsDescriptor Precision(Func, FluentDictionary> selector) { @@ -115,7 +129,9 @@ public DataframeEvaluationOutlierDetectionMetricsDescriptor Precision(Func - /// Recall of predictions (per-class and average). + /// + /// Recall of predictions (per-class and average). + /// /// public DataframeEvaluationOutlierDetectionMetricsDescriptor Recall(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationRegression.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationRegression.g.cs index 04fe0b9ccda..d232ce84dd3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationRegression.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationRegression.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DataframeEvaluationRegression { /// - /// The field of the index which contains the ground truth. The data type of this field must be numerical. + /// + /// The field of the index which contains the ground truth. The data type of this field must be numerical. + /// /// [JsonInclude, JsonPropertyName("actual_field")] public Elastic.Clients.Elasticsearch.Serverless.Field ActualField { get; set; } /// - /// Specifies the metrics that are used for the evaluation. For more information on mse, msle, and huber, consult the Jupyter notebook on regression loss functions. + /// + /// Specifies the metrics that are used for the evaluation. For more information on mse, msle, and huber, consult the Jupyter notebook on regression loss functions. + /// /// [JsonInclude, JsonPropertyName("metrics")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeEvaluationRegressionMetrics? Metrics { get; set; } /// - /// The field in the index that contains the predicted value, in other words the results of the regression analysis. + /// + /// The field in the index that contains the predicted value, in other words the results of the regression analysis. + /// /// [JsonInclude, JsonPropertyName("predicted_field")] public Elastic.Clients.Elasticsearch.Serverless.Field PredictedField { get; set; } @@ -65,7 +71,9 @@ public DataframeEvaluationRegressionDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field PredictedFieldValue { get; set; } /// - /// The field of the index which contains the ground truth. The data type of this field must be numerical. + /// + /// The field of the index which contains the ground truth. The data type of this field must be numerical. + /// /// public DataframeEvaluationRegressionDescriptor ActualField(Elastic.Clients.Elasticsearch.Serverless.Field actualField) { @@ -74,7 +82,9 @@ public DataframeEvaluationRegressionDescriptor ActualField(Elastic.Cl } /// - /// The field of the index which contains the ground truth. The data type of this field must be numerical. + /// + /// The field of the index which contains the ground truth. The data type of this field must be numerical. + /// /// public DataframeEvaluationRegressionDescriptor ActualField(Expression> actualField) { @@ -83,7 +93,9 @@ public DataframeEvaluationRegressionDescriptor ActualField(Ex } /// - /// The field of the index which contains the ground truth. The data type of this field must be numerical. + /// + /// The field of the index which contains the ground truth. The data type of this field must be numerical. + /// /// public DataframeEvaluationRegressionDescriptor ActualField(Expression> actualField) { @@ -92,7 +104,9 @@ public DataframeEvaluationRegressionDescriptor ActualField(Expression } /// - /// Specifies the metrics that are used for the evaluation. For more information on mse, msle, and huber, consult the Jupyter notebook on regression loss functions. + /// + /// Specifies the metrics that are used for the evaluation. For more information on mse, msle, and huber, consult the Jupyter notebook on regression loss functions. + /// /// public DataframeEvaluationRegressionDescriptor Metrics(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeEvaluationRegressionMetrics? metrics) { @@ -119,7 +133,9 @@ public DataframeEvaluationRegressionDescriptor Metrics(Action - /// The field in the index that contains the predicted value, in other words the results of the regression analysis. + /// + /// The field in the index that contains the predicted value, in other words the results of the regression analysis. + /// /// public DataframeEvaluationRegressionDescriptor PredictedField(Elastic.Clients.Elasticsearch.Serverless.Field predictedField) { @@ -128,7 +144,9 @@ public DataframeEvaluationRegressionDescriptor PredictedField(Elastic } /// - /// The field in the index that contains the predicted value, in other words the results of the regression analysis. + /// + /// The field in the index that contains the predicted value, in other words the results of the regression analysis. + /// /// public DataframeEvaluationRegressionDescriptor PredictedField(Expression> predictedField) { @@ -137,7 +155,9 @@ public DataframeEvaluationRegressionDescriptor PredictedField } /// - /// The field in the index that contains the predicted value, in other words the results of the regression analysis. + /// + /// The field in the index that contains the predicted value, in other words the results of the regression analysis. + /// /// public DataframeEvaluationRegressionDescriptor PredictedField(Expression> predictedField) { @@ -187,7 +207,9 @@ public DataframeEvaluationRegressionDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field PredictedFieldValue { get; set; } /// - /// The field of the index which contains the ground truth. The data type of this field must be numerical. + /// + /// The field of the index which contains the ground truth. The data type of this field must be numerical. + /// /// public DataframeEvaluationRegressionDescriptor ActualField(Elastic.Clients.Elasticsearch.Serverless.Field actualField) { @@ -196,7 +218,9 @@ public DataframeEvaluationRegressionDescriptor ActualField(Elastic.Clients.Elast } /// - /// The field of the index which contains the ground truth. The data type of this field must be numerical. + /// + /// The field of the index which contains the ground truth. The data type of this field must be numerical. + /// /// public DataframeEvaluationRegressionDescriptor ActualField(Expression> actualField) { @@ -205,7 +229,9 @@ public DataframeEvaluationRegressionDescriptor ActualField(Ex } /// - /// The field of the index which contains the ground truth. The data type of this field must be numerical. + /// + /// The field of the index which contains the ground truth. The data type of this field must be numerical. + /// /// public DataframeEvaluationRegressionDescriptor ActualField(Expression> actualField) { @@ -214,7 +240,9 @@ public DataframeEvaluationRegressionDescriptor ActualField(Expression } /// - /// Specifies the metrics that are used for the evaluation. For more information on mse, msle, and huber, consult the Jupyter notebook on regression loss functions. + /// + /// Specifies the metrics that are used for the evaluation. For more information on mse, msle, and huber, consult the Jupyter notebook on regression loss functions. + /// /// public DataframeEvaluationRegressionDescriptor Metrics(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeEvaluationRegressionMetrics? metrics) { @@ -241,7 +269,9 @@ public DataframeEvaluationRegressionDescriptor Metrics(Action - /// The field in the index that contains the predicted value, in other words the results of the regression analysis. + /// + /// The field in the index that contains the predicted value, in other words the results of the regression analysis. + /// /// public DataframeEvaluationRegressionDescriptor PredictedField(Elastic.Clients.Elasticsearch.Serverless.Field predictedField) { @@ -250,7 +280,9 @@ public DataframeEvaluationRegressionDescriptor PredictedField(Elastic.Clients.El } /// - /// The field in the index that contains the predicted value, in other words the results of the regression analysis. + /// + /// The field in the index that contains the predicted value, in other words the results of the regression analysis. + /// /// public DataframeEvaluationRegressionDescriptor PredictedField(Expression> predictedField) { @@ -259,7 +291,9 @@ public DataframeEvaluationRegressionDescriptor PredictedField } /// - /// The field in the index that contains the predicted value, in other words the results of the regression analysis. + /// + /// The field in the index that contains the predicted value, in other words the results of the regression analysis. + /// /// public DataframeEvaluationRegressionDescriptor PredictedField(Expression> predictedField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationRegressionMetrics.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationRegressionMetrics.g.cs index 21620947f3b..f360d6b2ad1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationRegressionMetrics.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationRegressionMetrics.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DataframeEvaluationRegressionMetrics { /// - /// Pseudo Huber loss function. + /// + /// Pseudo Huber loss function. + /// /// [JsonInclude, JsonPropertyName("huber")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeEvaluationRegressionMetricsHuber? Huber { get; set; } /// - /// Average squared difference between the predicted values and the actual (ground truth) value. For more information, read this wiki article. + /// + /// Average squared difference between the predicted values and the actual (ground truth) value. For more information, read this wiki article. + /// /// [JsonInclude, JsonPropertyName("mse")] public IDictionary? Mse { get; set; } /// - /// Average squared difference between the logarithm of the predicted values and the logarithm of the actual (ground truth) value. + /// + /// Average squared difference between the logarithm of the predicted values and the logarithm of the actual (ground truth) value. + /// /// [JsonInclude, JsonPropertyName("msle")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeEvaluationRegressionMetricsMsle? Msle { get; set; } /// - /// Proportion of the variance in the dependent variable that is predictable from the independent variables. + /// + /// Proportion of the variance in the dependent variable that is predictable from the independent variables. + /// /// [JsonInclude, JsonPropertyName("r_squared")] public IDictionary? RSquared { get; set; } @@ -72,7 +80,9 @@ public DataframeEvaluationRegressionMetricsDescriptor() : base() private IDictionary? RSquaredValue { get; set; } /// - /// Pseudo Huber loss function. + /// + /// Pseudo Huber loss function. + /// /// public DataframeEvaluationRegressionMetricsDescriptor Huber(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeEvaluationRegressionMetricsHuber? huber) { @@ -99,7 +109,9 @@ public DataframeEvaluationRegressionMetricsDescriptor Huber(Action - /// Average squared difference between the predicted values and the actual (ground truth) value. For more information, read this wiki article. + /// + /// Average squared difference between the predicted values and the actual (ground truth) value. For more information, read this wiki article. + /// /// public DataframeEvaluationRegressionMetricsDescriptor Mse(Func, FluentDictionary> selector) { @@ -108,7 +120,9 @@ public DataframeEvaluationRegressionMetricsDescriptor Mse(Func - /// Average squared difference between the logarithm of the predicted values and the logarithm of the actual (ground truth) value. + /// + /// Average squared difference between the logarithm of the predicted values and the logarithm of the actual (ground truth) value. + /// /// public DataframeEvaluationRegressionMetricsDescriptor Msle(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeEvaluationRegressionMetricsMsle? msle) { @@ -135,7 +149,9 @@ public DataframeEvaluationRegressionMetricsDescriptor Msle(Action - /// Proportion of the variance in the dependent variable that is predictable from the independent variables. + /// + /// Proportion of the variance in the dependent variable that is predictable from the independent variables. + /// /// public DataframeEvaluationRegressionMetricsDescriptor RSquared(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationRegressionMetricsHuber.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationRegressionMetricsHuber.g.cs index e6d7043a60b..e1388d95a21 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationRegressionMetricsHuber.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationRegressionMetricsHuber.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DataframeEvaluationRegressionMetricsHuber { /// - /// Approximates 1/2 (prediction - actual)2 for values much less than delta and approximates a straight line with slope delta for values much larger than delta. Defaults to 1. Delta needs to be greater than 0. + /// + /// Approximates 1/2 (prediction - actual)2 for values much less than delta and approximates a straight line with slope delta for values much larger than delta. Defaults to 1. Delta needs to be greater than 0. + /// /// [JsonInclude, JsonPropertyName("delta")] public double? Delta { get; set; } @@ -47,7 +49,9 @@ public DataframeEvaluationRegressionMetricsHuberDescriptor() : base() private double? DeltaValue { get; set; } /// - /// Approximates 1/2 (prediction - actual)2 for values much less than delta and approximates a straight line with slope delta for values much larger than delta. Defaults to 1. Delta needs to be greater than 0. + /// + /// Approximates 1/2 (prediction - actual)2 for values much less than delta and approximates a straight line with slope delta for values much larger than delta. Defaults to 1. Delta needs to be greater than 0. + /// /// public DataframeEvaluationRegressionMetricsHuberDescriptor Delta(double? delta) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationRegressionMetricsMsle.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationRegressionMetricsMsle.g.cs index 2c01fb9eeb2..0d7b10c329d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationRegressionMetricsMsle.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeEvaluationRegressionMetricsMsle.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DataframeEvaluationRegressionMetricsMsle { /// - /// Defines the transition point at which you switch from minimizing quadratic error to minimizing quadratic log error. Defaults to 1. + /// + /// Defines the transition point at which you switch from minimizing quadratic error to minimizing quadratic log error. Defaults to 1. + /// /// [JsonInclude, JsonPropertyName("offset")] public double? Offset { get; set; } @@ -47,7 +49,9 @@ public DataframeEvaluationRegressionMetricsMsleDescriptor() : base() private double? OffsetValue { get; set; } /// - /// Defines the transition point at which you switch from minimizing quadratic error to minimizing quadratic log error. Defaults to 1. + /// + /// Defines the transition point at which you switch from minimizing quadratic error to minimizing quadratic log error. Defaults to 1. + /// /// public DataframeEvaluationRegressionMetricsMsleDescriptor Offset(double? offset) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeOutlierDetectionSummary.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeOutlierDetectionSummary.g.cs index 79b56edd857..43170ed7f19 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeOutlierDetectionSummary.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeOutlierDetectionSummary.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DataframeOutlierDetectionSummary { /// - /// The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. + /// + /// The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. + /// /// [JsonInclude, JsonPropertyName("auc_roc")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeEvaluationSummaryAucRoc? AucRoc { get; init; } /// - /// Set the different thresholds of the outlier score at where the metrics (`tp` - true positive, `fp` - false positive, `tn` - true negative, `fn` - false negative) are calculated. + /// + /// Set the different thresholds of the outlier score at where the metrics (tp - true positive, fp - false positive, tn - true negative, fn - false negative) are calculated. + /// /// [JsonInclude, JsonPropertyName("confusion_matrix")] public IReadOnlyDictionary? ConfusionMatrix { get; init; } /// - /// Set the different thresholds of the outlier score at where the metric is calculated. + /// + /// Set the different thresholds of the outlier score at where the metric is calculated. + /// /// [JsonInclude, JsonPropertyName("precision")] public IReadOnlyDictionary? Precision { get; init; } /// - /// Set the different thresholds of the outlier score at where the metric is calculated. + /// + /// Set the different thresholds of the outlier score at where the metric is calculated. + /// /// [JsonInclude, JsonPropertyName("recall")] public IReadOnlyDictionary? Recall { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeRegressionSummary.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeRegressionSummary.g.cs index b4be58ea44c..9d5ce63f9e8 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeRegressionSummary.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeRegressionSummary.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DataframeRegressionSummary { /// - /// Pseudo Huber loss function. + /// + /// Pseudo Huber loss function. + /// /// [JsonInclude, JsonPropertyName("huber")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeEvaluationValue? Huber { get; init; } /// - /// Average squared difference between the predicted values and the actual (`ground truth`) value. + /// + /// Average squared difference between the predicted values and the actual (ground truth) value. + /// /// [JsonInclude, JsonPropertyName("mse")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeEvaluationValue? Mse { get; init; } /// - /// Average squared difference between the logarithm of the predicted values and the logarithm of the actual (`ground truth`) value. + /// + /// Average squared difference between the logarithm of the predicted values and the logarithm of the actual (ground truth) value. + /// /// [JsonInclude, JsonPropertyName("msle")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeEvaluationValue? Msle { get; init; } /// - /// Proportion of the variance in the dependent variable that is predictable from the independent variables. + /// + /// Proportion of the variance in the dependent variable that is predictable from the independent variables. + /// /// [JsonInclude, JsonPropertyName("r_squared")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeEvaluationValue? RSquared { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Definition.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Definition.g.cs index 8b5862ba08d..1e69894799d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Definition.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Definition.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class Definition { /// - /// Collection of preprocessors + /// + /// Collection of preprocessors + /// /// [JsonInclude, JsonPropertyName("preprocessors")] public ICollection? Preprocessors { get; set; } /// - /// The definition of the trained model. + /// + /// The definition of the trained model. + /// /// [JsonInclude, JsonPropertyName("trained_model")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainedModel TrainedModel { get; set; } @@ -59,7 +63,9 @@ public DefinitionDescriptor() : base() private Action TrainedModelDescriptorAction { get; set; } /// - /// Collection of preprocessors + /// + /// Collection of preprocessors + /// /// public DefinitionDescriptor Preprocessors(ICollection? preprocessors) { @@ -98,7 +104,9 @@ public DefinitionDescriptor Preprocessors(params Action - /// The definition of the trained model. + /// + /// The definition of the trained model. + /// /// public DefinitionDescriptor TrainedModel(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainedModel trainedModel) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DelayedDataCheckConfig.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DelayedDataCheckConfig.g.cs index d18acc7b5e4..ec437ef5102 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DelayedDataCheckConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DelayedDataCheckConfig.g.cs @@ -30,13 +30,19 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DelayedDataCheckConfig { /// - /// The window of time that is searched for late data. This window of time ends with the latest finalized bucket.
It defaults to null, which causes an appropriate `check_window` to be calculated when the real-time datafeed runs.
In particular, the default `check_window` span calculation is based on the maximum of `2h` or `8 * bucket_span`. + /// + /// The window of time that is searched for late data. This window of time ends with the latest finalized bucket. + /// It defaults to null, which causes an appropriate check_window to be calculated when the real-time datafeed runs. + /// In particular, the default check_window span calculation is based on the maximum of 2h or 8 * bucket_span. + /// /// [JsonInclude, JsonPropertyName("check_window")] public Elastic.Clients.Elasticsearch.Serverless.Duration? CheckWindow { get; set; } /// - /// Specifies whether the datafeed periodically checks for delayed data. + /// + /// Specifies whether the datafeed periodically checks for delayed data. + /// /// [JsonInclude, JsonPropertyName("enabled")] public bool Enabled { get; set; } @@ -54,7 +60,11 @@ public DelayedDataCheckConfigDescriptor() : base() private bool EnabledValue { get; set; } /// - /// The window of time that is searched for late data. This window of time ends with the latest finalized bucket.
It defaults to null, which causes an appropriate `check_window` to be calculated when the real-time datafeed runs.
In particular, the default `check_window` span calculation is based on the maximum of `2h` or `8 * bucket_span`. + /// + /// The window of time that is searched for late data. This window of time ends with the latest finalized bucket. + /// It defaults to null, which causes an appropriate check_window to be calculated when the real-time datafeed runs. + /// In particular, the default check_window span calculation is based on the maximum of 2h or 8 * bucket_span. + /// /// public DelayedDataCheckConfigDescriptor CheckWindow(Elastic.Clients.Elasticsearch.Serverless.Duration? checkWindow) { @@ -63,7 +73,9 @@ public DelayedDataCheckConfigDescriptor CheckWindow(Elastic.Clients.Elasticsearc } /// - /// Specifies whether the datafeed periodically checks for delayed data. + /// + /// Specifies whether the datafeed periodically checks for delayed data. + /// /// public DelayedDataCheckConfigDescriptor Enabled(bool enabled = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DetectionRule.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DetectionRule.g.cs index 98491abd25f..23688092d20 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DetectionRule.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DetectionRule.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DetectionRule { /// - /// The set of actions to be triggered when the rule applies. If more than one action is specified the effects of all actions are combined. + /// + /// The set of actions to be triggered when the rule applies. If more than one action is specified the effects of all actions are combined. + /// /// [JsonInclude, JsonPropertyName("actions")] public ICollection? Actions { get; set; } /// - /// An array of numeric conditions when the rule applies. A rule must either have a non-empty scope or at least one condition. Multiple conditions are combined together with a logical AND. + /// + /// An array of numeric conditions when the rule applies. A rule must either have a non-empty scope or at least one condition. Multiple conditions are combined together with a logical AND. + /// /// [JsonInclude, JsonPropertyName("conditions")] public ICollection? Conditions { get; set; } /// - /// A scope of series where the rule applies. A rule must either have a non-empty scope or at least one condition. By default, the scope includes all series. Scoping is allowed for any of the fields that are also specified in `by_field_name`, `over_field_name`, or `partition_field_name`. + /// + /// A scope of series where the rule applies. A rule must either have a non-empty scope or at least one condition. By default, the scope includes all series. Scoping is allowed for any of the fields that are also specified in by_field_name, over_field_name, or partition_field_name. + /// /// [JsonInclude, JsonPropertyName("scope")] public IDictionary? Scope { get; set; } @@ -64,7 +70,9 @@ public DetectionRuleDescriptor() : base() private IDictionary ScopeValue { get; set; } /// - /// The set of actions to be triggered when the rule applies. If more than one action is specified the effects of all actions are combined. + /// + /// The set of actions to be triggered when the rule applies. If more than one action is specified the effects of all actions are combined. + /// /// public DetectionRuleDescriptor Actions(ICollection? actions) { @@ -73,7 +81,9 @@ public DetectionRuleDescriptor Actions(ICollection - /// An array of numeric conditions when the rule applies. A rule must either have a non-empty scope or at least one condition. Multiple conditions are combined together with a logical AND. + /// + /// An array of numeric conditions when the rule applies. A rule must either have a non-empty scope or at least one condition. Multiple conditions are combined together with a logical AND. + /// /// public DetectionRuleDescriptor Conditions(ICollection? conditions) { @@ -112,7 +122,9 @@ public DetectionRuleDescriptor Conditions(params Action - /// A scope of series where the rule applies. A rule must either have a non-empty scope or at least one condition. By default, the scope includes all series. Scoping is allowed for any of the fields that are also specified in `by_field_name`, `over_field_name`, or `partition_field_name`. + /// + /// A scope of series where the rule applies. A rule must either have a non-empty scope or at least one condition. By default, the scope includes all series. Scoping is allowed for any of the fields that are also specified in by_field_name, over_field_name, or partition_field_name. + /// /// public DetectionRuleDescriptor Scope(Func, FluentDescriptorDictionary> selector) { @@ -186,7 +198,9 @@ public DetectionRuleDescriptor() : base() private IDictionary ScopeValue { get; set; } /// - /// The set of actions to be triggered when the rule applies. If more than one action is specified the effects of all actions are combined. + /// + /// The set of actions to be triggered when the rule applies. If more than one action is specified the effects of all actions are combined. + /// /// public DetectionRuleDescriptor Actions(ICollection? actions) { @@ -195,7 +209,9 @@ public DetectionRuleDescriptor Actions(ICollection - /// An array of numeric conditions when the rule applies. A rule must either have a non-empty scope or at least one condition. Multiple conditions are combined together with a logical AND. + /// + /// An array of numeric conditions when the rule applies. A rule must either have a non-empty scope or at least one condition. Multiple conditions are combined together with a logical AND. + /// /// public DetectionRuleDescriptor Conditions(ICollection? conditions) { @@ -234,7 +250,9 @@ public DetectionRuleDescriptor Conditions(params Action - /// A scope of series where the rule applies. A rule must either have a non-empty scope or at least one condition. By default, the scope includes all series. Scoping is allowed for any of the fields that are also specified in `by_field_name`, `over_field_name`, or `partition_field_name`. + /// + /// A scope of series where the rule applies. A rule must either have a non-empty scope or at least one condition. By default, the scope includes all series. Scoping is allowed for any of the fields that are also specified in by_field_name, over_field_name, or partition_field_name. + /// /// public DetectionRuleDescriptor Scope(Func, FluentDescriptorDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Detector.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Detector.g.cs index b7c21f4b33c..d609fe6d7cf 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Detector.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Detector.g.cs @@ -30,61 +30,81 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class Detector { /// - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// /// [JsonInclude, JsonPropertyName("by_field_name")] public Elastic.Clients.Elasticsearch.Serverless.Field? ByFieldName { get; set; } /// - /// Custom rules enable you to customize the way detectors operate. For example, a rule may dictate conditions under which results should be skipped. Kibana refers to custom rules as job rules. + /// + /// Custom rules enable you to customize the way detectors operate. For example, a rule may dictate conditions under which results should be skipped. Kibana refers to custom rules as job rules. + /// /// [JsonInclude, JsonPropertyName("custom_rules")] public ICollection? CustomRules { get; set; } /// - /// A description of the detector. + /// + /// A description of the detector. + /// /// [JsonInclude, JsonPropertyName("detector_description")] public string? DetectorDescription { get; set; } /// - /// A unique identifier for the detector. This identifier is based on the order of the detectors in the `analysis_config`, starting at zero. If you specify a value for this property, it is ignored. + /// + /// A unique identifier for the detector. This identifier is based on the order of the detectors in the analysis_config, starting at zero. If you specify a value for this property, it is ignored. + /// /// [JsonInclude, JsonPropertyName("detector_index")] public int? DetectorIndex { get; set; } /// - /// If set, frequent entities are excluded from influencing the anomaly results. Entities can be considered frequent over time or frequent in a population. If you are working with both over and by fields, you can set `exclude_frequent` to `all` for both fields, or to `by` or `over` for those specific fields. + /// + /// If set, frequent entities are excluded from influencing the anomaly results. Entities can be considered frequent over time or frequent in a population. If you are working with both over and by fields, you can set exclude_frequent to all for both fields, or to by or over for those specific fields. + /// /// [JsonInclude, JsonPropertyName("exclude_frequent")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ExcludeFrequent? ExcludeFrequent { get; set; } /// - /// The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The `field_name` cannot contain double quotes or backslashes. + /// + /// The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The field_name cannot contain double quotes or backslashes. + /// /// [JsonInclude, JsonPropertyName("field_name")] public Elastic.Clients.Elasticsearch.Serverless.Field? FieldName { get; set; } /// - /// The analysis function that is used. For example, `count`, `rare`, `mean`, `min`, `max`, or `sum`. + /// + /// The analysis function that is used. For example, count, rare, mean, min, max, or sum. + /// /// [JsonInclude, JsonPropertyName("function")] public string? Function { get; set; } /// - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// /// [JsonInclude, JsonPropertyName("over_field_name")] public Elastic.Clients.Elasticsearch.Serverless.Field? OverFieldName { get; set; } /// - /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// + /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// /// [JsonInclude, JsonPropertyName("partition_field_name")] public Elastic.Clients.Elasticsearch.Serverless.Field? PartitionFieldName { get; set; } /// - /// Defines whether a new series is used as the null series when there is no value for the by or partition fields. + /// + /// Defines whether a new series is used as the null series when there is no value for the by or partition fields. + /// /// [JsonInclude, JsonPropertyName("use_null")] public bool? UseNull { get; set; } @@ -113,7 +133,9 @@ public DetectorDescriptor() : base() private bool? UseNullValue { get; set; } /// - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// /// public DetectorDescriptor ByFieldName(Elastic.Clients.Elasticsearch.Serverless.Field? byFieldName) { @@ -122,7 +144,9 @@ public DetectorDescriptor ByFieldName(Elastic.Clients.Elasticsearch.S } /// - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// /// public DetectorDescriptor ByFieldName(Expression> byFieldName) { @@ -131,7 +155,9 @@ public DetectorDescriptor ByFieldName(Expression - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// /// public DetectorDescriptor ByFieldName(Expression> byFieldName) { @@ -140,7 +166,9 @@ public DetectorDescriptor ByFieldName(Expression - /// Custom rules enable you to customize the way detectors operate. For example, a rule may dictate conditions under which results should be skipped. Kibana refers to custom rules as job rules. + /// + /// Custom rules enable you to customize the way detectors operate. For example, a rule may dictate conditions under which results should be skipped. Kibana refers to custom rules as job rules. + /// /// public DetectorDescriptor CustomRules(ICollection? customRules) { @@ -179,7 +207,9 @@ public DetectorDescriptor CustomRules(params Action - /// A description of the detector. + /// + /// A description of the detector. + /// /// public DetectorDescriptor DetectorDescription(string? detectorDescription) { @@ -188,7 +218,9 @@ public DetectorDescriptor DetectorDescription(string? detectorDescrip } /// - /// A unique identifier for the detector. This identifier is based on the order of the detectors in the `analysis_config`, starting at zero. If you specify a value for this property, it is ignored. + /// + /// A unique identifier for the detector. This identifier is based on the order of the detectors in the analysis_config, starting at zero. If you specify a value for this property, it is ignored. + /// /// public DetectorDescriptor DetectorIndex(int? detectorIndex) { @@ -197,7 +229,9 @@ public DetectorDescriptor DetectorIndex(int? detectorIndex) } /// - /// If set, frequent entities are excluded from influencing the anomaly results. Entities can be considered frequent over time or frequent in a population. If you are working with both over and by fields, you can set `exclude_frequent` to `all` for both fields, or to `by` or `over` for those specific fields. + /// + /// If set, frequent entities are excluded from influencing the anomaly results. Entities can be considered frequent over time or frequent in a population. If you are working with both over and by fields, you can set exclude_frequent to all for both fields, or to by or over for those specific fields. + /// /// public DetectorDescriptor ExcludeFrequent(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ExcludeFrequent? excludeFrequent) { @@ -206,7 +240,9 @@ public DetectorDescriptor ExcludeFrequent(Elastic.Clients.Elasticsear } /// - /// The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The `field_name` cannot contain double quotes or backslashes. + /// + /// The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The field_name cannot contain double quotes or backslashes. + /// /// public DetectorDescriptor FieldName(Elastic.Clients.Elasticsearch.Serverless.Field? fieldName) { @@ -215,7 +251,9 @@ public DetectorDescriptor FieldName(Elastic.Clients.Elasticsearch.Ser } /// - /// The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The `field_name` cannot contain double quotes or backslashes. + /// + /// The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The field_name cannot contain double quotes or backslashes. + /// /// public DetectorDescriptor FieldName(Expression> fieldName) { @@ -224,7 +262,9 @@ public DetectorDescriptor FieldName(Expression - /// The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The `field_name` cannot contain double quotes or backslashes. + /// + /// The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The field_name cannot contain double quotes or backslashes. + /// /// public DetectorDescriptor FieldName(Expression> fieldName) { @@ -233,7 +273,9 @@ public DetectorDescriptor FieldName(Expression - /// The analysis function that is used. For example, `count`, `rare`, `mean`, `min`, `max`, or `sum`. + /// + /// The analysis function that is used. For example, count, rare, mean, min, max, or sum. + /// /// public DetectorDescriptor Function(string? function) { @@ -242,7 +284,9 @@ public DetectorDescriptor Function(string? function) } /// - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// /// public DetectorDescriptor OverFieldName(Elastic.Clients.Elasticsearch.Serverless.Field? overFieldName) { @@ -251,7 +295,9 @@ public DetectorDescriptor OverFieldName(Elastic.Clients.Elasticsearch } /// - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// /// public DetectorDescriptor OverFieldName(Expression> overFieldName) { @@ -260,7 +306,9 @@ public DetectorDescriptor OverFieldName(Expression - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// /// public DetectorDescriptor OverFieldName(Expression> overFieldName) { @@ -269,7 +317,9 @@ public DetectorDescriptor OverFieldName(Expression - /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// + /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// /// public DetectorDescriptor PartitionFieldName(Elastic.Clients.Elasticsearch.Serverless.Field? partitionFieldName) { @@ -278,7 +328,9 @@ public DetectorDescriptor PartitionFieldName(Elastic.Clients.Elastics } /// - /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// + /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// /// public DetectorDescriptor PartitionFieldName(Expression> partitionFieldName) { @@ -287,7 +339,9 @@ public DetectorDescriptor PartitionFieldName(Expression - /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// + /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// /// public DetectorDescriptor PartitionFieldName(Expression> partitionFieldName) { @@ -296,7 +350,9 @@ public DetectorDescriptor PartitionFieldName(Expression - /// Defines whether a new series is used as the null series when there is no value for the by or partition fields. + /// + /// Defines whether a new series is used as the null series when there is no value for the by or partition fields. + /// /// public DetectorDescriptor UseNull(bool? useNull = true) { @@ -419,7 +475,9 @@ public DetectorDescriptor() : base() private bool? UseNullValue { get; set; } /// - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// /// public DetectorDescriptor ByFieldName(Elastic.Clients.Elasticsearch.Serverless.Field? byFieldName) { @@ -428,7 +486,9 @@ public DetectorDescriptor ByFieldName(Elastic.Clients.Elasticsearch.Serverless.F } /// - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// /// public DetectorDescriptor ByFieldName(Expression> byFieldName) { @@ -437,7 +497,9 @@ public DetectorDescriptor ByFieldName(Expression - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// /// public DetectorDescriptor ByFieldName(Expression> byFieldName) { @@ -446,7 +508,9 @@ public DetectorDescriptor ByFieldName(Expression - /// Custom rules enable you to customize the way detectors operate. For example, a rule may dictate conditions under which results should be skipped. Kibana refers to custom rules as job rules. + /// + /// Custom rules enable you to customize the way detectors operate. For example, a rule may dictate conditions under which results should be skipped. Kibana refers to custom rules as job rules. + /// /// public DetectorDescriptor CustomRules(ICollection? customRules) { @@ -485,7 +549,9 @@ public DetectorDescriptor CustomRules(params Action - /// A description of the detector. + /// + /// A description of the detector. + /// /// public DetectorDescriptor DetectorDescription(string? detectorDescription) { @@ -494,7 +560,9 @@ public DetectorDescriptor DetectorDescription(string? detectorDescription) } /// - /// A unique identifier for the detector. This identifier is based on the order of the detectors in the `analysis_config`, starting at zero. If you specify a value for this property, it is ignored. + /// + /// A unique identifier for the detector. This identifier is based on the order of the detectors in the analysis_config, starting at zero. If you specify a value for this property, it is ignored. + /// /// public DetectorDescriptor DetectorIndex(int? detectorIndex) { @@ -503,7 +571,9 @@ public DetectorDescriptor DetectorIndex(int? detectorIndex) } /// - /// If set, frequent entities are excluded from influencing the anomaly results. Entities can be considered frequent over time or frequent in a population. If you are working with both over and by fields, you can set `exclude_frequent` to `all` for both fields, or to `by` or `over` for those specific fields. + /// + /// If set, frequent entities are excluded from influencing the anomaly results. Entities can be considered frequent over time or frequent in a population. If you are working with both over and by fields, you can set exclude_frequent to all for both fields, or to by or over for those specific fields. + /// /// public DetectorDescriptor ExcludeFrequent(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ExcludeFrequent? excludeFrequent) { @@ -512,7 +582,9 @@ public DetectorDescriptor ExcludeFrequent(Elastic.Clients.Elasticsearch.Serverle } /// - /// The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The `field_name` cannot contain double quotes or backslashes. + /// + /// The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The field_name cannot contain double quotes or backslashes. + /// /// public DetectorDescriptor FieldName(Elastic.Clients.Elasticsearch.Serverless.Field? fieldName) { @@ -521,7 +593,9 @@ public DetectorDescriptor FieldName(Elastic.Clients.Elasticsearch.Serverless.Fie } /// - /// The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The `field_name` cannot contain double quotes or backslashes. + /// + /// The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The field_name cannot contain double quotes or backslashes. + /// /// public DetectorDescriptor FieldName(Expression> fieldName) { @@ -530,7 +604,9 @@ public DetectorDescriptor FieldName(Expression - /// The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The `field_name` cannot contain double quotes or backslashes. + /// + /// The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The field_name cannot contain double quotes or backslashes. + /// /// public DetectorDescriptor FieldName(Expression> fieldName) { @@ -539,7 +615,9 @@ public DetectorDescriptor FieldName(Expression - /// The analysis function that is used. For example, `count`, `rare`, `mean`, `min`, `max`, or `sum`. + /// + /// The analysis function that is used. For example, count, rare, mean, min, max, or sum. + /// /// public DetectorDescriptor Function(string? function) { @@ -548,7 +626,9 @@ public DetectorDescriptor Function(string? function) } /// - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// /// public DetectorDescriptor OverFieldName(Elastic.Clients.Elasticsearch.Serverless.Field? overFieldName) { @@ -557,7 +637,9 @@ public DetectorDescriptor OverFieldName(Elastic.Clients.Elasticsearch.Serverless } /// - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// /// public DetectorDescriptor OverFieldName(Expression> overFieldName) { @@ -566,7 +648,9 @@ public DetectorDescriptor OverFieldName(Expression - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// /// public DetectorDescriptor OverFieldName(Expression> overFieldName) { @@ -575,7 +659,9 @@ public DetectorDescriptor OverFieldName(Expression - /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// + /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// /// public DetectorDescriptor PartitionFieldName(Elastic.Clients.Elasticsearch.Serverless.Field? partitionFieldName) { @@ -584,7 +670,9 @@ public DetectorDescriptor PartitionFieldName(Elastic.Clients.Elasticsearch.Serve } /// - /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// + /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// /// public DetectorDescriptor PartitionFieldName(Expression> partitionFieldName) { @@ -593,7 +681,9 @@ public DetectorDescriptor PartitionFieldName(Expression - /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// + /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// /// public DetectorDescriptor PartitionFieldName(Expression> partitionFieldName) { @@ -602,7 +692,9 @@ public DetectorDescriptor PartitionFieldName(Expression - /// Defines whether a new series is used as the null series when there is no value for the by or partition fields. + /// + /// Defines whether a new series is used as the null series when there is no value for the by or partition fields. + /// /// public DetectorDescriptor UseNull(bool? useNull = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DetectorRead.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DetectorRead.g.cs index 71dcf24970d..b466f39c893 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DetectorRead.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DetectorRead.g.cs @@ -30,61 +30,94 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class DetectorRead { /// - /// The field used to split the data.
In particular, this property is used for analyzing the splits with respect to their own history.
It is used for finding unusual values in the context of the split. + /// + /// The field used to split the data. + /// In particular, this property is used for analyzing the splits with respect to their own history. + /// It is used for finding unusual values in the context of the split. + /// /// [JsonInclude, JsonPropertyName("by_field_name")] public string? ByFieldName { get; init; } /// - /// An array of custom rule objects, which enable you to customize the way detectors operate.
For example, a rule may dictate to the detector conditions under which results should be skipped.
Kibana refers to custom rules as job rules. + /// + /// An array of custom rule objects, which enable you to customize the way detectors operate. + /// For example, a rule may dictate to the detector conditions under which results should be skipped. + /// Kibana refers to custom rules as job rules. + /// /// [JsonInclude, JsonPropertyName("custom_rules")] public IReadOnlyCollection? CustomRules { get; init; } /// - /// A description of the detector. + /// + /// A description of the detector. + /// /// [JsonInclude, JsonPropertyName("detector_description")] public string? DetectorDescription { get; init; } /// - /// A unique identifier for the detector.
This identifier is based on the order of the detectors in the `analysis_config`, starting at zero. + /// + /// A unique identifier for the detector. + /// This identifier is based on the order of the detectors in the analysis_config, starting at zero. + /// /// [JsonInclude, JsonPropertyName("detector_index")] public int? DetectorIndex { get; init; } /// - /// Contains one of the following values: `all`, `none`, `by`, or `over`.
If set, frequent entities are excluded from influencing the anomaly results.
Entities can be considered frequent over time or frequent in a population.
If you are working with both over and by fields, then you can set `exclude_frequent` to all for both fields, or to `by` or `over` for those specific fields. + /// + /// Contains one of the following values: all, none, by, or over. + /// If set, frequent entities are excluded from influencing the anomaly results. + /// Entities can be considered frequent over time or frequent in a population. + /// If you are working with both over and by fields, then you can set exclude_frequent to all for both fields, or to by or over for those specific fields. + /// /// [JsonInclude, JsonPropertyName("exclude_frequent")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ExcludeFrequent? ExcludeFrequent { get; init; } /// - /// The field that the detector uses in the function.
If you use an event rate function such as `count` or `rare`, do not specify this field. + /// + /// The field that the detector uses in the function. + /// If you use an event rate function such as count or rare, do not specify this field. + /// /// [JsonInclude, JsonPropertyName("field_name")] public string? FieldName { get; init; } /// - /// The analysis function that is used.
For example, `count`, `rare`, `mean`, `min`, `max`, and `sum`. + /// + /// The analysis function that is used. + /// For example, count, rare, mean, min, max, and sum. + /// /// [JsonInclude, JsonPropertyName("function")] public string Function { get; init; } /// - /// The field used to split the data.
In particular, this property is used for analyzing the splits with respect to the history of all splits.
It is used for finding unusual values in the population of all splits. + /// + /// The field used to split the data. + /// In particular, this property is used for analyzing the splits with respect to the history of all splits. + /// It is used for finding unusual values in the population of all splits. + /// /// [JsonInclude, JsonPropertyName("over_field_name")] public string? OverFieldName { get; init; } /// - /// The field used to segment the analysis.
When you use this property, you have completely independent baselines for each value of this field. + /// + /// The field used to segment the analysis. + /// When you use this property, you have completely independent baselines for each value of this field. + /// /// [JsonInclude, JsonPropertyName("partition_field_name")] public string? PartitionFieldName { get; init; } /// - /// Defines whether a new series is used as the null series when there is no value for the by or partition fields. + /// + /// Defines whether a new series is used as the null series when there is no value for the by or partition fields. + /// /// [JsonInclude, JsonPropertyName("use_null")] public bool? UseNull { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/FillMaskInferenceOptions.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/FillMaskInferenceOptions.g.cs index 777ee973967..d14b5e81fe6 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/FillMaskInferenceOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/FillMaskInferenceOptions.g.cs @@ -28,30 +28,44 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; /// -/// Fill mask inference options +/// +/// Fill mask inference options +/// /// public sealed partial class FillMaskInferenceOptions { /// - /// The string/token which will be removed from incoming documents and replaced with the inference prediction(s).
In a response, this field contains the mask token for the specified model/tokenizer. Each model and tokenizer
has a predefined mask token which cannot be changed. Thus, it is recommended not to set this value in requests.
However, if this field is present in a request, its value must match the predefined value for that model/tokenizer,
otherwise the request will fail. + /// + /// The string/token which will be removed from incoming documents and replaced with the inference prediction(s). + /// In a response, this field contains the mask token for the specified model/tokenizer. Each model and tokenizer + /// has a predefined mask token which cannot be changed. Thus, it is recommended not to set this value in requests. + /// However, if this field is present in a request, its value must match the predefined value for that model/tokenizer, + /// otherwise the request will fail. + /// /// [JsonInclude, JsonPropertyName("mask_token")] public string? MaskToken { get; set; } /// - /// Specifies the number of top class predictions to return. Defaults to 0. + /// + /// Specifies the number of top class predictions to return. Defaults to 0. + /// /// [JsonInclude, JsonPropertyName("num_top_classes")] public int? NumTopClasses { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationConfig? Tokenization { get; set; } @@ -60,7 +74,9 @@ public sealed partial class FillMaskInferenceOptions } /// -/// Fill mask inference options +/// +/// Fill mask inference options +/// /// public sealed partial class FillMaskInferenceOptionsDescriptor : SerializableDescriptor { @@ -78,7 +94,13 @@ public FillMaskInferenceOptionsDescriptor() : base() private Action TokenizationDescriptorAction { get; set; } /// - /// The string/token which will be removed from incoming documents and replaced with the inference prediction(s).
In a response, this field contains the mask token for the specified model/tokenizer. Each model and tokenizer
has a predefined mask token which cannot be changed. Thus, it is recommended not to set this value in requests.
However, if this field is present in a request, its value must match the predefined value for that model/tokenizer,
otherwise the request will fail. + /// + /// The string/token which will be removed from incoming documents and replaced with the inference prediction(s). + /// In a response, this field contains the mask token for the specified model/tokenizer. Each model and tokenizer + /// has a predefined mask token which cannot be changed. Thus, it is recommended not to set this value in requests. + /// However, if this field is present in a request, its value must match the predefined value for that model/tokenizer, + /// otherwise the request will fail. + /// /// public FillMaskInferenceOptionsDescriptor MaskToken(string? maskToken) { @@ -87,7 +109,9 @@ public FillMaskInferenceOptionsDescriptor MaskToken(string? maskToken) } /// - /// Specifies the number of top class predictions to return. Defaults to 0. + /// + /// Specifies the number of top class predictions to return. Defaults to 0. + /// /// public FillMaskInferenceOptionsDescriptor NumTopClasses(int? numTopClasses) { @@ -96,7 +120,9 @@ public FillMaskInferenceOptionsDescriptor NumTopClasses(int? numTopClasses) } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public FillMaskInferenceOptionsDescriptor ResultsField(string? resultsField) { @@ -105,7 +131,9 @@ public FillMaskInferenceOptionsDescriptor ResultsField(string? resultsField) } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// public FillMaskInferenceOptionsDescriptor Tokenization(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationConfig? tokenization) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/FillMaskInferenceUpdateOptions.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/FillMaskInferenceUpdateOptions.g.cs index aa81691d2bc..373b0c4269e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/FillMaskInferenceUpdateOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/FillMaskInferenceUpdateOptions.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class FillMaskInferenceUpdateOptions { /// - /// Specifies the number of top class predictions to return. Defaults to 0. + /// + /// Specifies the number of top class predictions to return. Defaults to 0. + /// /// [JsonInclude, JsonPropertyName("num_top_classes")] public int? NumTopClasses { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.NlpTokenizationUpdateOptions? Tokenization { get; set; } @@ -65,7 +71,9 @@ public FillMaskInferenceUpdateOptionsDescriptor() : base() private Action TokenizationDescriptorAction { get; set; } /// - /// Specifies the number of top class predictions to return. Defaults to 0. + /// + /// Specifies the number of top class predictions to return. Defaults to 0. + /// /// public FillMaskInferenceUpdateOptionsDescriptor NumTopClasses(int? numTopClasses) { @@ -74,7 +82,9 @@ public FillMaskInferenceUpdateOptionsDescriptor NumTopClasses(int? numTopClasses } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public FillMaskInferenceUpdateOptionsDescriptor ResultsField(string? resultsField) { @@ -83,7 +93,9 @@ public FillMaskInferenceUpdateOptionsDescriptor ResultsField(string? resultsFiel } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// public FillMaskInferenceUpdateOptionsDescriptor Tokenization(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.NlpTokenizationUpdateOptions? tokenization) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Filter.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Filter.g.cs index d1198c64405..278c084fb64 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Filter.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Filter.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class Filter { /// - /// A description of the filter. + /// + /// A description of the filter. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; init; } /// - /// A string that uniquely identifies a filter. + /// + /// A string that uniquely identifies a filter. + /// /// [JsonInclude, JsonPropertyName("filter_id")] public string FilterId { get; init; } /// - /// An array of strings which is the filter item list. + /// + /// An array of strings which is the filter item list. + /// /// [JsonInclude, JsonPropertyName("items")] public IReadOnlyCollection Items { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/FilterRef.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/FilterRef.g.cs index 2db507f89ff..1fa35c12454 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/FilterRef.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/FilterRef.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class FilterRef { /// - /// The identifier for the filter. + /// + /// The identifier for the filter. + /// /// [JsonInclude, JsonPropertyName("filter_id")] public Elastic.Clients.Elasticsearch.Serverless.Id FilterId { get; set; } /// - /// If set to `include`, the rule applies for values in the filter. If set to `exclude`, the rule applies for values not in the filter. + /// + /// If set to include, the rule applies for values in the filter. If set to exclude, the rule applies for values not in the filter. + /// /// [JsonInclude, JsonPropertyName("filter_type")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.FilterType? FilterType { get; set; } @@ -54,7 +58,9 @@ public FilterRefDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.FilterType? FilterTypeValue { get; set; } /// - /// The identifier for the filter. + /// + /// The identifier for the filter. + /// /// public FilterRefDescriptor FilterId(Elastic.Clients.Elasticsearch.Serverless.Id filterId) { @@ -63,7 +69,9 @@ public FilterRefDescriptor FilterId(Elastic.Clients.Elasticsearch.Serverless.Id } /// - /// If set to `include`, the rule applies for values in the filter. If set to `exclude`, the rule applies for values not in the filter. + /// + /// If set to include, the rule applies for values in the filter. If set to exclude, the rule applies for values not in the filter. + /// /// public FilterRefDescriptor FilterType(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.FilterType? filterType) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/GeoResults.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/GeoResults.g.cs index 3cf4ec32ac4..d0d27829304 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/GeoResults.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/GeoResults.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class GeoResults { /// - /// The actual value for the bucket formatted as a `geo_point`. + /// + /// The actual value for the bucket formatted as a geo_point. + /// /// [JsonInclude, JsonPropertyName("actual_point")] public string ActualPoint { get; init; } /// - /// The typical value for the bucket formatted as a `geo_point`. + /// + /// The typical value for the bucket formatted as a geo_point. + /// /// [JsonInclude, JsonPropertyName("typical_point")] public string TypicalPoint { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Hyperparameter.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Hyperparameter.g.cs index 4eb545c360b..e4ed7657f46 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Hyperparameter.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Hyperparameter.g.cs @@ -30,31 +30,41 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class Hyperparameter { /// - /// A positive number showing how much the parameter influences the variation of the loss function. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization. + /// + /// A positive number showing how much the parameter influences the variation of the loss function. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization. + /// /// [JsonInclude, JsonPropertyName("absolute_importance")] public double? AbsoluteImportance { get; init; } /// - /// Name of the hyperparameter. + /// + /// Name of the hyperparameter. + /// /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } /// - /// A number between 0 and 1 showing the proportion of influence on the variation of the loss function among all tuned hyperparameters. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization. + /// + /// A number between 0 and 1 showing the proportion of influence on the variation of the loss function among all tuned hyperparameters. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization. + /// /// [JsonInclude, JsonPropertyName("relative_importance")] public double? RelativeImportance { get; init; } /// - /// Indicates if the hyperparameter is specified by the user (true) or optimized (false). + /// + /// Indicates if the hyperparameter is specified by the user (true) or optimized (false). + /// /// [JsonInclude, JsonPropertyName("supplied")] public bool Supplied { get; init; } /// - /// The value of the hyperparameter, either optimized or specified by the user. + /// + /// The value of the hyperparameter, either optimized or specified by the user. + /// /// [JsonInclude, JsonPropertyName("value")] public double Value { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/InferenceConfigCreate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/InferenceConfigCreate.g.cs index d8ec1bfe87a..a86e4468446 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/InferenceConfigCreate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/InferenceConfigCreate.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; /// -/// Inference configuration provided when storing the model config +/// +/// Inference configuration provided when storing the model config +/// /// [JsonConverter(typeof(InferenceConfigCreateConverter))] public sealed partial class InferenceConfigCreate diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/InferenceResponseResult.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/InferenceResponseResult.g.cs index 5e6d8cbf1b2..17adcb46d84 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/InferenceResponseResult.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/InferenceResponseResult.g.cs @@ -30,56 +30,84 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class InferenceResponseResult { /// - /// If the model is trained for named entity recognition (NER) tasks, the response contains the recognized entities. + /// + /// If the model is trained for named entity recognition (NER) tasks, the response contains the recognized entities. + /// /// [JsonInclude, JsonPropertyName("entities")] public IReadOnlyCollection? Entities { get; init; } /// - /// The feature importance for the inference results. Relevant only for classification or regression models + /// + /// The feature importance for the inference results. Relevant only for classification or regression models + /// /// [JsonInclude, JsonPropertyName("feature_importance")] public IReadOnlyCollection? FeatureImportance { get; init; } /// - /// Indicates whether the input text was truncated to meet the model's maximum sequence length limit. This property
is present only when it is true. + /// + /// Indicates whether the input text was truncated to meet the model's maximum sequence length limit. This property + /// is present only when it is true. + /// /// [JsonInclude, JsonPropertyName("is_truncated")] public bool? IsTruncated { get; init; } /// - /// If the model is trained for a text classification or zero shot classification task, the response is the
predicted class.
For named entity recognition (NER) tasks, it contains the annotated text output.
For fill mask tasks, it contains the top prediction for replacing the mask token.
For text embedding tasks, it contains the raw numerical text embedding values.
For regression models, its a numerical value
For classification models, it may be an integer, double, boolean or string depending on prediction type + /// + /// If the model is trained for a text classification or zero shot classification task, the response is the + /// predicted class. + /// For named entity recognition (NER) tasks, it contains the annotated text output. + /// For fill mask tasks, it contains the top prediction for replacing the mask token. + /// For text embedding tasks, it contains the raw numerical text embedding values. + /// For regression models, its a numerical value + /// For classification models, it may be an integer, double, boolean or string depending on prediction type + /// /// [JsonInclude, JsonPropertyName("predicted_value")] [SingleOrManyCollectionConverter(typeof(object))] public IReadOnlyCollection? PredictedValue { get; init; } /// - /// For fill mask tasks, the response contains the input text sequence with the mask token replaced by the predicted
value.
Additionally + /// + /// For fill mask tasks, the response contains the input text sequence with the mask token replaced by the predicted + /// value. + /// Additionally + /// /// [JsonInclude, JsonPropertyName("predicted_value_sequence")] public string? PredictedValueSequence { get; init; } /// - /// Specifies a probability for the predicted value. + /// + /// Specifies a probability for the predicted value. + /// /// [JsonInclude, JsonPropertyName("prediction_probability")] public double? PredictionProbability { get; init; } /// - /// Specifies a confidence score for the predicted value. + /// + /// Specifies a confidence score for the predicted value. + /// /// [JsonInclude, JsonPropertyName("prediction_score")] public double? PredictionScore { get; init; } /// - /// For fill mask, text classification, and zero shot classification tasks, the response contains a list of top
class entries. + /// + /// For fill mask, text classification, and zero shot classification tasks, the response contains a list of top + /// class entries. + /// /// [JsonInclude, JsonPropertyName("top_classes")] public IReadOnlyCollection? TopClasses { get; init; } /// - /// If the request failed, the response contains the reason for the failure. + /// + /// If the request failed, the response contains the reason for the failure. + /// /// [JsonInclude, JsonPropertyName("warning")] public string? Warning { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Influencer.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Influencer.g.cs index b17ecd0c6a3..6780f01d772 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Influencer.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Influencer.g.cs @@ -30,67 +30,96 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class Influencer { /// - /// The length of the bucket in seconds. This value matches the bucket span that is specified in the job. + /// + /// The length of the bucket in seconds. This value matches the bucket span that is specified in the job. + /// /// [JsonInclude, JsonPropertyName("bucket_span")] public long BucketSpan { get; init; } /// - /// Additional influencer properties are added, depending on the fields being analyzed. For example, if it’s
analyzing `user_name` as an influencer, a field `user_name` is added to the result document. This
information enables you to filter the anomaly results more easily. + /// + /// Additional influencer properties are added, depending on the fields being analyzed. For example, if it’s + /// analyzing user_name as an influencer, a field user_name is added to the result document. This + /// information enables you to filter the anomaly results more easily. + /// /// [JsonInclude, JsonPropertyName("foo")] public string? Foo { get; init; } /// - /// The field name of the influencer. + /// + /// The field name of the influencer. + /// /// [JsonInclude, JsonPropertyName("influencer_field_name")] public string InfluencerFieldName { get; init; } /// - /// The entity that influenced, contributed to, or was to blame for the anomaly. + /// + /// The entity that influenced, contributed to, or was to blame for the anomaly. + /// /// [JsonInclude, JsonPropertyName("influencer_field_value")] public string InfluencerFieldValue { get; init; } /// - /// A normalized score between 0-100, which is based on the probability of the influencer in this bucket aggregated
across detectors. Unlike `initial_influencer_score`, this value is updated by a re-normalization process as new
data is analyzed. + /// + /// A normalized score between 0-100, which is based on the probability of the influencer in this bucket aggregated + /// across detectors. Unlike initial_influencer_score, this value is updated by a re-normalization process as new + /// data is analyzed. + /// /// [JsonInclude, JsonPropertyName("influencer_score")] public double InfluencerScore { get; init; } /// - /// A normalized score between 0-100, which is based on the probability of the influencer aggregated across detectors.
This is the initial value that was calculated at the time the bucket was processed. + /// + /// A normalized score between 0-100, which is based on the probability of the influencer aggregated across detectors. + /// This is the initial value that was calculated at the time the bucket was processed. + /// /// [JsonInclude, JsonPropertyName("initial_influencer_score")] public double InitialInfluencerScore { get; init; } /// - /// If true, this is an interim result. In other words, the results are calculated based on partial input data. + /// + /// If true, this is an interim result. In other words, the results are calculated based on partial input data. + /// /// [JsonInclude, JsonPropertyName("is_interim")] public bool IsInterim { get; init; } /// - /// Identifier for the anomaly detection job. + /// + /// Identifier for the anomaly detection job. + /// /// [JsonInclude, JsonPropertyName("job_id")] public string JobId { get; init; } /// - /// The probability that the influencer has this behavior, in the range 0 to 1. This value can be held to a high
precision of over 300 decimal places, so the `influencer_score` is provided as a human-readable and friendly
interpretation of this value. + /// + /// The probability that the influencer has this behavior, in the range 0 to 1. This value can be held to a high + /// precision of over 300 decimal places, so the influencer_score is provided as a human-readable and friendly + /// interpretation of this value. + /// /// [JsonInclude, JsonPropertyName("probability")] public double Probability { get; init; } /// - /// Internal. This value is always set to `influencer`. + /// + /// Internal. This value is always set to influencer. + /// /// [JsonInclude, JsonPropertyName("result_type")] public string ResultType { get; init; } /// - /// The start time of the bucket for which these results were calculated. + /// + /// The start time of the bucket for which these results were calculated. + /// /// [JsonInclude, JsonPropertyName("timestamp")] public long Timestamp { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Job.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Job.g.cs index 8217dc26c57..aa895e01ed1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Job.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Job.g.cs @@ -30,25 +30,40 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class Job { /// - /// Advanced configuration option.
Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. + /// + /// Advanced configuration option. + /// Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. + /// /// [JsonInclude, JsonPropertyName("allow_lazy_open")] public bool AllowLazyOpen { get; init; } /// - /// The analysis configuration, which specifies how to analyze the data.
After you create a job, you cannot change the analysis configuration; all the properties are informational. + /// + /// The analysis configuration, which specifies how to analyze the data. + /// After you create a job, you cannot change the analysis configuration; all the properties are informational. + /// /// [JsonInclude, JsonPropertyName("analysis_config")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.AnalysisConfig AnalysisConfig { get; init; } /// - /// Limits can be applied for the resources required to hold the mathematical models in memory.
These limits are approximate and can be set per job.
They do not control the memory used by other processes, for example the Elasticsearch Java processes. + /// + /// Limits can be applied for the resources required to hold the mathematical models in memory. + /// These limits are approximate and can be set per job. + /// They do not control the memory used by other processes, for example the Elasticsearch Java processes. + /// /// [JsonInclude, JsonPropertyName("analysis_limits")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.AnalysisLimits? AnalysisLimits { get; init; } /// - /// Advanced configuration option.
The time between each periodic persistence of the model.
The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time.
The smallest allowed value is 1 hour. + /// + /// Advanced configuration option. + /// The time between each periodic persistence of the model. + /// The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. + /// The smallest allowed value is 1 hour. + /// /// [JsonInclude, JsonPropertyName("background_persist_interval")] public Elastic.Clients.Elasticsearch.Serverless.Duration? BackgroundPersistInterval { get; init; } @@ -58,73 +73,112 @@ public sealed partial class Job public DateTimeOffset? CreateTime { get; init; } /// - /// Advanced configuration option.
Contains custom metadata about the job. + /// + /// Advanced configuration option. + /// Contains custom metadata about the job. + /// /// [JsonInclude, JsonPropertyName("custom_settings")] public object? CustomSettings { get; init; } /// - /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job.
It specifies a period of time (in days) after which only the first snapshot per day is retained.
This period is relative to the timestamp of the most recent snapshot for this job.
Valid values range from 0 to `model_snapshot_retention_days`. + /// + /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job. + /// It specifies a period of time (in days) after which only the first snapshot per day is retained. + /// This period is relative to the timestamp of the most recent snapshot for this job. + /// Valid values range from 0 to model_snapshot_retention_days. + /// /// [JsonInclude, JsonPropertyName("daily_model_snapshot_retention_after_days")] public long? DailyModelSnapshotRetentionAfterDays { get; init; } /// - /// The data description defines the format of the input data when you send data to the job by using the post data API.
Note that when configuring a datafeed, these properties are automatically set.
When data is received via the post data API, it is not stored in Elasticsearch.
Only the results for anomaly detection are retained. + /// + /// The data description defines the format of the input data when you send data to the job by using the post data API. + /// Note that when configuring a datafeed, these properties are automatically set. + /// When data is received via the post data API, it is not stored in Elasticsearch. + /// Only the results for anomaly detection are retained. + /// /// [JsonInclude, JsonPropertyName("data_description")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataDescription DataDescription { get; init; } /// - /// The datafeed, which retrieves data from Elasticsearch for analysis by the job.
You can associate only one datafeed with each anomaly detection job. + /// + /// The datafeed, which retrieves data from Elasticsearch for analysis by the job. + /// You can associate only one datafeed with each anomaly detection job. + /// /// [JsonInclude, JsonPropertyName("datafeed_config")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Datafeed? DatafeedConfig { get; init; } /// - /// Indicates that the process of deleting the job is in progress but not yet completed.
It is only reported when `true`. + /// + /// Indicates that the process of deleting the job is in progress but not yet completed. + /// It is only reported when true. + /// /// [JsonInclude, JsonPropertyName("deleting")] public bool? Deleting { get; init; } /// - /// A description of the job. + /// + /// A description of the job. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; init; } /// - /// If the job closed or failed, this is the time the job finished, otherwise it is `null`.
This property is informational; you cannot change its value. + /// + /// If the job closed or failed, this is the time the job finished, otherwise it is null. + /// This property is informational; you cannot change its value. + /// /// [JsonInclude, JsonPropertyName("finished_time")] public DateTimeOffset? FinishedTime { get; init; } /// - /// A list of job groups.
A job can belong to no groups or many. + /// + /// A list of job groups. + /// A job can belong to no groups or many. + /// /// [JsonInclude, JsonPropertyName("groups")] public IReadOnlyCollection? Groups { get; init; } /// - /// Identifier for the anomaly detection job.
This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
It must start and end with alphanumeric characters. + /// + /// Identifier for the anomaly detection job. + /// This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. + /// It must start and end with alphanumeric characters. + /// /// [JsonInclude, JsonPropertyName("job_id")] public string JobId { get; init; } /// - /// Reserved for future use, currently set to `anomaly_detector`. + /// + /// Reserved for future use, currently set to anomaly_detector. + /// /// [JsonInclude, JsonPropertyName("job_type")] public string? JobType { get; init; } /// - /// The machine learning configuration version number at which the the job was created. + /// + /// The machine learning configuration version number at which the the job was created. + /// /// [JsonInclude, JsonPropertyName("job_version")] public string? JobVersion { get; init; } /// - /// This advanced configuration option stores model information along with the results.
It provides a more detailed view into anomaly detection.
Model plot provides a simplified and indicative view of the model and its bounds. + /// + /// This advanced configuration option stores model information along with the results. + /// It provides a more detailed view into anomaly detection. + /// Model plot provides a simplified and indicative view of the model and its bounds. + /// /// [JsonInclude, JsonPropertyName("model_plot_config")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ModelPlotConfig? ModelPlotConfig { get; init; } @@ -132,25 +186,45 @@ public sealed partial class Job public string? ModelSnapshotId { get; init; } /// - /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job.
It specifies the maximum period of time (in days) that snapshots are retained.
This period is relative to the timestamp of the most recent snapshot for this job.
By default, snapshots ten days older than the newest snapshot are deleted. + /// + /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job. + /// It specifies the maximum period of time (in days) that snapshots are retained. + /// This period is relative to the timestamp of the most recent snapshot for this job. + /// By default, snapshots ten days older than the newest snapshot are deleted. + /// /// [JsonInclude, JsonPropertyName("model_snapshot_retention_days")] public long ModelSnapshotRetentionDays { get; init; } /// - /// Advanced configuration option.
The period over which adjustments to the score are applied, as new data is seen.
The default value is the longer of 30 days or 100 `bucket_spans`. + /// + /// Advanced configuration option. + /// The period over which adjustments to the score are applied, as new data is seen. + /// The default value is the longer of 30 days or 100 bucket_spans. + /// /// [JsonInclude, JsonPropertyName("renormalization_window_days")] public long? RenormalizationWindowDays { get; init; } /// - /// A text string that affects the name of the machine learning results index.
The default value is `shared`, which generates an index named `.ml-anomalies-shared`. + /// + /// A text string that affects the name of the machine learning results index. + /// The default value is shared, which generates an index named .ml-anomalies-shared. + /// /// [JsonInclude, JsonPropertyName("results_index_name")] public string ResultsIndexName { get; init; } /// - /// Advanced configuration option.
The period of time (in days) that results are retained.
Age is calculated relative to the timestamp of the latest bucket result.
If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch.
The default value is null, which means all results are retained.
Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results.
Annotations added by users are retained forever. + /// + /// Advanced configuration option. + /// The period of time (in days) that results are retained. + /// Age is calculated relative to the timestamp of the latest bucket result. + /// If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. + /// The default value is null, which means all results are retained. + /// Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. + /// Annotations added by users are retained forever. + /// /// [JsonInclude, JsonPropertyName("results_retention_days")] public long? ResultsRetentionDays { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/JobStats.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/JobStats.g.cs index a636d4c7216..417d21bf799 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/JobStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/JobStats.g.cs @@ -30,55 +30,76 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class JobStats { /// - /// For open anomaly detection jobs only, contains messages relating to the selection of a node to run the job. + /// + /// For open anomaly detection jobs only, contains messages relating to the selection of a node to run the job. + /// /// [JsonInclude, JsonPropertyName("assignment_explanation")] public string? AssignmentExplanation { get; init; } /// - /// An object that describes the quantity of input to the job and any related error counts.
The `data_count` values are cumulative for the lifetime of a job.
If a model snapshot is reverted or old results are deleted, the job counts are not reset. + /// + /// An object that describes the quantity of input to the job and any related error counts. + /// The data_count values are cumulative for the lifetime of a job. + /// If a model snapshot is reverted or old results are deleted, the job counts are not reset. + /// /// [JsonInclude, JsonPropertyName("data_counts")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataCounts DataCounts { get; init; } /// - /// Indicates that the process of deleting the job is in progress but not yet completed. It is only reported when `true`. + /// + /// Indicates that the process of deleting the job is in progress but not yet completed. It is only reported when true. + /// /// [JsonInclude, JsonPropertyName("deleting")] public bool? Deleting { get; init; } /// - /// An object that provides statistical information about forecasts belonging to this job.
Some statistics are omitted if no forecasts have been made. + /// + /// An object that provides statistical information about forecasts belonging to this job. + /// Some statistics are omitted if no forecasts have been made. + /// /// [JsonInclude, JsonPropertyName("forecasts_stats")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.JobForecastStatistics ForecastsStats { get; init; } /// - /// Identifier for the anomaly detection job. + /// + /// Identifier for the anomaly detection job. + /// /// [JsonInclude, JsonPropertyName("job_id")] public string JobId { get; init; } /// - /// An object that provides information about the size and contents of the model. + /// + /// An object that provides information about the size and contents of the model. + /// /// [JsonInclude, JsonPropertyName("model_size_stats")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ModelSizeStats ModelSizeStats { get; init; } /// - /// For open jobs only, the elapsed time for which the job has been open. + /// + /// For open jobs only, the elapsed time for which the job has been open. + /// /// [JsonInclude, JsonPropertyName("open_time")] public DateTimeOffset? OpenTime { get; init; } /// - /// The status of the anomaly detection job, which can be one of the following values: `closed`, `closing`, `failed`, `opened`, `opening`. + /// + /// The status of the anomaly detection job, which can be one of the following values: closed, closing, failed, opened, opening. + /// /// [JsonInclude, JsonPropertyName("state")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.JobState State { get; init; } /// - /// An object that provides statistical information about timing aspect of this job. + /// + /// An object that provides statistical information about timing aspect of this job. + /// /// [JsonInclude, JsonPropertyName("timing_stats")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.JobTimingStats TimingStats { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/JvmStats.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/JvmStats.g.cs index 8648dda5fd1..2d222e2e8ef 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/JvmStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/JvmStats.g.cs @@ -30,37 +30,49 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class JvmStats { /// - /// Maximum amount of memory available for use by the heap. + /// + /// Maximum amount of memory available for use by the heap. + /// /// [JsonInclude, JsonPropertyName("heap_max")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? HeapMax { get; init; } /// - /// Maximum amount of memory, in bytes, available for use by the heap. + /// + /// Maximum amount of memory, in bytes, available for use by the heap. + /// /// [JsonInclude, JsonPropertyName("heap_max_in_bytes")] public int HeapMaxInBytes { get; init; } /// - /// Amount of Java heap currently being used for caching inference models. + /// + /// Amount of Java heap currently being used for caching inference models. + /// /// [JsonInclude, JsonPropertyName("java_inference")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? JavaInference { get; init; } /// - /// Amount of Java heap, in bytes, currently being used for caching inference models. + /// + /// Amount of Java heap, in bytes, currently being used for caching inference models. + /// /// [JsonInclude, JsonPropertyName("java_inference_in_bytes")] public int JavaInferenceInBytes { get; init; } /// - /// Maximum amount of Java heap to be used for caching inference models. + /// + /// Maximum amount of Java heap to be used for caching inference models. + /// /// [JsonInclude, JsonPropertyName("java_inference_max")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? JavaInferenceMax { get; init; } /// - /// Maximum amount of Java heap, in bytes, to be used for caching inference models. + /// + /// Maximum amount of Java heap, in bytes, to be used for caching inference models. + /// /// [JsonInclude, JsonPropertyName("java_inference_max_in_bytes")] public int JavaInferenceMaxInBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/MemMlStats.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/MemMlStats.g.cs index 34f46e3806e..fb4ad9f2700 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/MemMlStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/MemMlStats.g.cs @@ -30,61 +30,81 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class MemMlStats { /// - /// Amount of native memory set aside for anomaly detection jobs. + /// + /// Amount of native memory set aside for anomaly detection jobs. + /// /// [JsonInclude, JsonPropertyName("anomaly_detectors")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? AnomalyDetectors { get; init; } /// - /// Amount of native memory, in bytes, set aside for anomaly detection jobs. + /// + /// Amount of native memory, in bytes, set aside for anomaly detection jobs. + /// /// [JsonInclude, JsonPropertyName("anomaly_detectors_in_bytes")] public int AnomalyDetectorsInBytes { get; init; } /// - /// Amount of native memory set aside for data frame analytics jobs. + /// + /// Amount of native memory set aside for data frame analytics jobs. + /// /// [JsonInclude, JsonPropertyName("data_frame_analytics")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? DataFrameAnalytics { get; init; } /// - /// Amount of native memory, in bytes, set aside for data frame analytics jobs. + /// + /// Amount of native memory, in bytes, set aside for data frame analytics jobs. + /// /// [JsonInclude, JsonPropertyName("data_frame_analytics_in_bytes")] public int DataFrameAnalyticsInBytes { get; init; } /// - /// Maximum amount of native memory (separate to the JVM heap) that may be used by machine learning native processes. + /// + /// Maximum amount of native memory (separate to the JVM heap) that may be used by machine learning native processes. + /// /// [JsonInclude, JsonPropertyName("max")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? Max { get; init; } /// - /// Maximum amount of native memory (separate to the JVM heap), in bytes, that may be used by machine learning native processes. + /// + /// Maximum amount of native memory (separate to the JVM heap), in bytes, that may be used by machine learning native processes. + /// /// [JsonInclude, JsonPropertyName("max_in_bytes")] public int MaxInBytes { get; init; } /// - /// Amount of native memory set aside for loading machine learning native code shared libraries. + /// + /// Amount of native memory set aside for loading machine learning native code shared libraries. + /// /// [JsonInclude, JsonPropertyName("native_code_overhead")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? NativeCodeOverhead { get; init; } /// - /// Amount of native memory, in bytes, set aside for loading machine learning native code shared libraries. + /// + /// Amount of native memory, in bytes, set aside for loading machine learning native code shared libraries. + /// /// [JsonInclude, JsonPropertyName("native_code_overhead_in_bytes")] public int NativeCodeOverheadInBytes { get; init; } /// - /// Amount of native memory set aside for trained models that have a PyTorch model_type. + /// + /// Amount of native memory set aside for trained models that have a PyTorch model_type. + /// /// [JsonInclude, JsonPropertyName("native_inference")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? NativeInference { get; init; } /// - /// Amount of native memory, in bytes, set aside for trained models that have a PyTorch model_type. + /// + /// Amount of native memory, in bytes, set aside for trained models that have a PyTorch model_type. + /// /// [JsonInclude, JsonPropertyName("native_inference_in_bytes")] public int NativeInferenceInBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/MemStats.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/MemStats.g.cs index 1295a7406f5..57c7d2f5945 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/MemStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/MemStats.g.cs @@ -30,31 +30,43 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class MemStats { /// - /// If the amount of physical memory has been overridden using the es.total_memory_bytes system property
then this reports the overridden value. Otherwise it reports the same value as total. + /// + /// If the amount of physical memory has been overridden using the es.total_memory_bytes system property + /// then this reports the overridden value. Otherwise it reports the same value as total. + /// /// [JsonInclude, JsonPropertyName("adjusted_total")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? AdjustedTotal { get; init; } /// - /// If the amount of physical memory has been overridden using the `es.total_memory_bytes` system property
then this reports the overridden value in bytes. Otherwise it reports the same value as `total_in_bytes`. + /// + /// If the amount of physical memory has been overridden using the es.total_memory_bytes system property + /// then this reports the overridden value in bytes. Otherwise it reports the same value as total_in_bytes. + /// /// [JsonInclude, JsonPropertyName("adjusted_total_in_bytes")] public int AdjustedTotalInBytes { get; init; } /// - /// Contains statistics about machine learning use of native memory on the node. + /// + /// Contains statistics about machine learning use of native memory on the node. + /// /// [JsonInclude, JsonPropertyName("ml")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.MemMlStats Ml { get; init; } /// - /// Total amount of physical memory. + /// + /// Total amount of physical memory. + /// /// [JsonInclude, JsonPropertyName("total")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? Total { get; init; } /// - /// Total amount of physical memory in bytes. + /// + /// Total amount of physical memory in bytes. + /// /// [JsonInclude, JsonPropertyName("total_in_bytes")] public int TotalInBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Memory.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Memory.g.cs index baae2a913be..4a85e12020b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Memory.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Memory.g.cs @@ -35,31 +35,41 @@ public sealed partial class Memory public string EphemeralId { get; init; } /// - /// Contains Java Virtual Machine (JVM) statistics for the node. + /// + /// Contains Java Virtual Machine (JVM) statistics for the node. + /// /// [JsonInclude, JsonPropertyName("jvm")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.JvmStats Jvm { get; init; } /// - /// Contains statistics about memory usage for the node. + /// + /// Contains statistics about memory usage for the node. + /// /// [JsonInclude, JsonPropertyName("mem")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.MemStats Mem { get; init; } /// - /// Human-readable identifier for the node. Based on the Node name setting setting. + /// + /// Human-readable identifier for the node. Based on the Node name setting setting. + /// /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } /// - /// Roles assigned to the node. + /// + /// Roles assigned to the node. + /// /// [JsonInclude, JsonPropertyName("roles")] public IReadOnlyCollection Roles { get; init; } /// - /// The host and port where transport HTTP connections are accepted. + /// + /// The host and port where transport HTTP connections are accepted. + /// /// [JsonInclude, JsonPropertyName("transport_address")] public string TransportAddress { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ModelPlotConfig.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ModelPlotConfig.g.cs index 2728cc9cf5e..d5394af556e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ModelPlotConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ModelPlotConfig.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class ModelPlotConfig { /// - /// If true, enables calculation and storage of the model change annotations for each entity that is being analyzed. + /// + /// If true, enables calculation and storage of the model change annotations for each entity that is being analyzed. + /// /// [JsonInclude, JsonPropertyName("annotations_enabled")] public bool? AnnotationsEnabled { get; set; } /// - /// If true, enables calculation and storage of the model bounds for each entity that is being analyzed. + /// + /// If true, enables calculation and storage of the model bounds for each entity that is being analyzed. + /// /// [JsonInclude, JsonPropertyName("enabled")] public bool? Enabled { get; set; } /// - /// Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer. + /// + /// Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer. + /// /// [JsonInclude, JsonPropertyName("terms")] public Elastic.Clients.Elasticsearch.Serverless.Field? Terms { get; set; } @@ -61,7 +67,9 @@ public ModelPlotConfigDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TermsValue { get; set; } /// - /// If true, enables calculation and storage of the model change annotations for each entity that is being analyzed. + /// + /// If true, enables calculation and storage of the model change annotations for each entity that is being analyzed. + /// /// public ModelPlotConfigDescriptor AnnotationsEnabled(bool? annotationsEnabled = true) { @@ -70,7 +78,9 @@ public ModelPlotConfigDescriptor AnnotationsEnabled(bool? annotations } /// - /// If true, enables calculation and storage of the model bounds for each entity that is being analyzed. + /// + /// If true, enables calculation and storage of the model bounds for each entity that is being analyzed. + /// /// public ModelPlotConfigDescriptor Enabled(bool? enabled = true) { @@ -79,7 +89,9 @@ public ModelPlotConfigDescriptor Enabled(bool? enabled = true) } /// - /// Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer. + /// + /// Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer. + /// /// public ModelPlotConfigDescriptor Terms(Elastic.Clients.Elasticsearch.Serverless.Field? terms) { @@ -88,7 +100,9 @@ public ModelPlotConfigDescriptor Terms(Elastic.Clients.Elasticsearch. } /// - /// Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer. + /// + /// Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer. + /// /// public ModelPlotConfigDescriptor Terms(Expression> terms) { @@ -97,7 +111,9 @@ public ModelPlotConfigDescriptor Terms(Expression - /// Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer. + /// + /// Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer. + /// /// public ModelPlotConfigDescriptor Terms(Expression> terms) { @@ -143,7 +159,9 @@ public ModelPlotConfigDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? TermsValue { get; set; } /// - /// If true, enables calculation and storage of the model change annotations for each entity that is being analyzed. + /// + /// If true, enables calculation and storage of the model change annotations for each entity that is being analyzed. + /// /// public ModelPlotConfigDescriptor AnnotationsEnabled(bool? annotationsEnabled = true) { @@ -152,7 +170,9 @@ public ModelPlotConfigDescriptor AnnotationsEnabled(bool? annotationsEnabled = t } /// - /// If true, enables calculation and storage of the model bounds for each entity that is being analyzed. + /// + /// If true, enables calculation and storage of the model bounds for each entity that is being analyzed. + /// /// public ModelPlotConfigDescriptor Enabled(bool? enabled = true) { @@ -161,7 +181,9 @@ public ModelPlotConfigDescriptor Enabled(bool? enabled = true) } /// - /// Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer. + /// + /// Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer. + /// /// public ModelPlotConfigDescriptor Terms(Elastic.Clients.Elasticsearch.Serverless.Field? terms) { @@ -170,7 +192,9 @@ public ModelPlotConfigDescriptor Terms(Elastic.Clients.Elasticsearch.Serverless. } /// - /// Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer. + /// + /// Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer. + /// /// public ModelPlotConfigDescriptor Terms(Expression> terms) { @@ -179,7 +203,9 @@ public ModelPlotConfigDescriptor Terms(Expression - /// Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer. + /// + /// Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer. + /// /// public ModelPlotConfigDescriptor Terms(Expression> terms) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ModelSnapshot.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ModelSnapshot.g.cs index 4bfafb362e4..9db647910df 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ModelSnapshot.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ModelSnapshot.g.cs @@ -30,61 +30,81 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class ModelSnapshot { /// - /// An optional description of the job. + /// + /// An optional description of the job. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; init; } /// - /// A numerical character string that uniquely identifies the job that the snapshot was created for. + /// + /// A numerical character string that uniquely identifies the job that the snapshot was created for. + /// /// [JsonInclude, JsonPropertyName("job_id")] public string JobId { get; init; } /// - /// The timestamp of the latest processed record. + /// + /// The timestamp of the latest processed record. + /// /// [JsonInclude, JsonPropertyName("latest_record_time_stamp")] public int? LatestRecordTimeStamp { get; init; } /// - /// The timestamp of the latest bucket result. + /// + /// The timestamp of the latest bucket result. + /// /// [JsonInclude, JsonPropertyName("latest_result_time_stamp")] public int? LatestResultTimeStamp { get; init; } /// - /// The minimum version required to be able to restore the model snapshot. + /// + /// The minimum version required to be able to restore the model snapshot. + /// /// [JsonInclude, JsonPropertyName("min_version")] public string MinVersion { get; init; } /// - /// Summary information describing the model. + /// + /// Summary information describing the model. + /// /// [JsonInclude, JsonPropertyName("model_size_stats")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ModelSizeStats? ModelSizeStats { get; init; } /// - /// If true, this snapshot will not be deleted during automatic cleanup of snapshots older than model_snapshot_retention_days. However, this snapshot will be deleted when the job is deleted. The default value is false. + /// + /// If true, this snapshot will not be deleted during automatic cleanup of snapshots older than model_snapshot_retention_days. However, this snapshot will be deleted when the job is deleted. The default value is false. + /// /// [JsonInclude, JsonPropertyName("retain")] public bool Retain { get; init; } /// - /// For internal use only. + /// + /// For internal use only. + /// /// [JsonInclude, JsonPropertyName("snapshot_doc_count")] public long SnapshotDocCount { get; init; } /// - /// A numerical character string that uniquely identifies the model snapshot. + /// + /// A numerical character string that uniquely identifies the model snapshot. + /// /// [JsonInclude, JsonPropertyName("snapshot_id")] public string SnapshotId { get; init; } /// - /// The creation timestamp for the snapshot. + /// + /// The creation timestamp for the snapshot. + /// /// [JsonInclude, JsonPropertyName("timestamp")] public long Timestamp { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/NerInferenceOptions.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/NerInferenceOptions.g.cs index ce83ae501d1..1be4abae252 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/NerInferenceOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/NerInferenceOptions.g.cs @@ -28,24 +28,32 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; /// -/// Named entity recognition options +/// +/// Named entity recognition options +/// /// public sealed partial class NerInferenceOptions { /// - /// The token classification labels. Must be IOB formatted tags + /// + /// The token classification labels. Must be IOB formatted tags + /// /// [JsonInclude, JsonPropertyName("classification_labels")] public ICollection? ClassificationLabels { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } /// - /// The tokenization options + /// + /// The tokenization options + /// /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationConfig? Tokenization { get; set; } @@ -56,7 +64,9 @@ public sealed partial class NerInferenceOptions } /// -/// Named entity recognition options +/// +/// Named entity recognition options +/// /// public sealed partial class NerInferenceOptionsDescriptor : SerializableDescriptor { @@ -76,7 +86,9 @@ public NerInferenceOptionsDescriptor() : base() private Action VocabularyDescriptorAction { get; set; } /// - /// The token classification labels. Must be IOB formatted tags + /// + /// The token classification labels. Must be IOB formatted tags + /// /// public NerInferenceOptionsDescriptor ClassificationLabels(ICollection? classificationLabels) { @@ -85,7 +97,9 @@ public NerInferenceOptionsDescriptor ClassificationLabels(ICollection? c } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public NerInferenceOptionsDescriptor ResultsField(string? resultsField) { @@ -94,7 +108,9 @@ public NerInferenceOptionsDescriptor ResultsField(string? resultsField) } /// - /// The tokenization options + /// + /// The tokenization options + /// /// public NerInferenceOptionsDescriptor Tokenization(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationConfig? tokenization) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/NerInferenceUpdateOptions.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/NerInferenceUpdateOptions.g.cs index 6ad3e3a2ad4..0e001aa293b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/NerInferenceUpdateOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/NerInferenceUpdateOptions.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class NerInferenceUpdateOptions { /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.NlpTokenizationUpdateOptions? Tokenization { get; set; } @@ -58,7 +62,9 @@ public NerInferenceUpdateOptionsDescriptor() : base() private Action TokenizationDescriptorAction { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public NerInferenceUpdateOptionsDescriptor ResultsField(string? resultsField) { @@ -67,7 +73,9 @@ public NerInferenceUpdateOptionsDescriptor ResultsField(string? resultsField) } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// public NerInferenceUpdateOptionsDescriptor Tokenization(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.NlpTokenizationUpdateOptions? tokenization) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/NlpBertTokenizationConfig.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/NlpBertTokenizationConfig.g.cs index 3ba7af974b0..6e27c5db1a2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/NlpBertTokenizationConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/NlpBertTokenizationConfig.g.cs @@ -28,43 +28,57 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; /// -/// BERT and MPNet tokenization configuration options +/// +/// BERT and MPNet tokenization configuration options +/// /// public sealed partial class NlpBertTokenizationConfig { /// - /// Should the tokenizer lower case the text + /// + /// Should the tokenizer lower case the text + /// /// [JsonInclude, JsonPropertyName("do_lower_case")] public bool? DoLowerCase { get; set; } /// - /// Maximum input sequence length for the model + /// + /// Maximum input sequence length for the model + /// /// [JsonInclude, JsonPropertyName("max_sequence_length")] public int? MaxSequenceLength { get; set; } /// - /// Tokenization spanning options. Special value of -1 indicates no spanning takes place + /// + /// Tokenization spanning options. Special value of -1 indicates no spanning takes place + /// /// [JsonInclude, JsonPropertyName("span")] public int? Span { get; set; } /// - /// Should tokenization input be automatically truncated before sending to the model for inference + /// + /// Should tokenization input be automatically truncated before sending to the model for inference + /// /// [JsonInclude, JsonPropertyName("truncate")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationTruncate? Truncate { get; set; } /// - /// Is tokenization completed with special tokens + /// + /// Is tokenization completed with special tokens + /// /// [JsonInclude, JsonPropertyName("with_special_tokens")] public bool? WithSpecialTokens { get; set; } } /// -/// BERT and MPNet tokenization configuration options +/// +/// BERT and MPNet tokenization configuration options +/// /// public sealed partial class NlpBertTokenizationConfigDescriptor : SerializableDescriptor { @@ -81,7 +95,9 @@ public NlpBertTokenizationConfigDescriptor() : base() private bool? WithSpecialTokensValue { get; set; } /// - /// Should the tokenizer lower case the text + /// + /// Should the tokenizer lower case the text + /// /// public NlpBertTokenizationConfigDescriptor DoLowerCase(bool? doLowerCase = true) { @@ -90,7 +106,9 @@ public NlpBertTokenizationConfigDescriptor DoLowerCase(bool? doLowerCase = true) } /// - /// Maximum input sequence length for the model + /// + /// Maximum input sequence length for the model + /// /// public NlpBertTokenizationConfigDescriptor MaxSequenceLength(int? maxSequenceLength) { @@ -99,7 +117,9 @@ public NlpBertTokenizationConfigDescriptor MaxSequenceLength(int? maxSequenceLen } /// - /// Tokenization spanning options. Special value of -1 indicates no spanning takes place + /// + /// Tokenization spanning options. Special value of -1 indicates no spanning takes place + /// /// public NlpBertTokenizationConfigDescriptor Span(int? span) { @@ -108,7 +128,9 @@ public NlpBertTokenizationConfigDescriptor Span(int? span) } /// - /// Should tokenization input be automatically truncated before sending to the model for inference + /// + /// Should tokenization input be automatically truncated before sending to the model for inference + /// /// public NlpBertTokenizationConfigDescriptor Truncate(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationTruncate? truncate) { @@ -117,7 +139,9 @@ public NlpBertTokenizationConfigDescriptor Truncate(Elastic.Clients.Elasticsearc } /// - /// Is tokenization completed with special tokens + /// + /// Is tokenization completed with special tokens + /// /// public NlpBertTokenizationConfigDescriptor WithSpecialTokens(bool? withSpecialTokens = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/NlpRobertaTokenizationConfig.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/NlpRobertaTokenizationConfig.g.cs index e87a431e99d..90300b1c97b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/NlpRobertaTokenizationConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/NlpRobertaTokenizationConfig.g.cs @@ -28,36 +28,48 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; /// -/// RoBERTa tokenization configuration options +/// +/// RoBERTa tokenization configuration options +/// /// public sealed partial class NlpRobertaTokenizationConfig { /// - /// Should the tokenizer prefix input with a space character + /// + /// Should the tokenizer prefix input with a space character + /// /// [JsonInclude, JsonPropertyName("add_prefix_space")] public bool? AddPrefixSpace { get; set; } /// - /// Maximum input sequence length for the model + /// + /// Maximum input sequence length for the model + /// /// [JsonInclude, JsonPropertyName("max_sequence_length")] public int? MaxSequenceLength { get; set; } /// - /// Tokenization spanning options. Special value of -1 indicates no spanning takes place + /// + /// Tokenization spanning options. Special value of -1 indicates no spanning takes place + /// /// [JsonInclude, JsonPropertyName("span")] public int? Span { get; set; } /// - /// Should tokenization input be automatically truncated before sending to the model for inference + /// + /// Should tokenization input be automatically truncated before sending to the model for inference + /// /// [JsonInclude, JsonPropertyName("truncate")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationTruncate? Truncate { get; set; } /// - /// Is tokenization completed with special tokens + /// + /// Is tokenization completed with special tokens + /// /// [JsonInclude, JsonPropertyName("with_special_tokens")] public bool? WithSpecialTokens { get; set; } @@ -66,7 +78,9 @@ public sealed partial class NlpRobertaTokenizationConfig } /// -/// RoBERTa tokenization configuration options +/// +/// RoBERTa tokenization configuration options +/// /// public sealed partial class NlpRobertaTokenizationConfigDescriptor : SerializableDescriptor { @@ -83,7 +97,9 @@ public NlpRobertaTokenizationConfigDescriptor() : base() private bool? WithSpecialTokensValue { get; set; } /// - /// Should the tokenizer prefix input with a space character + /// + /// Should the tokenizer prefix input with a space character + /// /// public NlpRobertaTokenizationConfigDescriptor AddPrefixSpace(bool? addPrefixSpace = true) { @@ -92,7 +108,9 @@ public NlpRobertaTokenizationConfigDescriptor AddPrefixSpace(bool? addPrefixSpac } /// - /// Maximum input sequence length for the model + /// + /// Maximum input sequence length for the model + /// /// public NlpRobertaTokenizationConfigDescriptor MaxSequenceLength(int? maxSequenceLength) { @@ -101,7 +119,9 @@ public NlpRobertaTokenizationConfigDescriptor MaxSequenceLength(int? maxSequence } /// - /// Tokenization spanning options. Special value of -1 indicates no spanning takes place + /// + /// Tokenization spanning options. Special value of -1 indicates no spanning takes place + /// /// public NlpRobertaTokenizationConfigDescriptor Span(int? span) { @@ -110,7 +130,9 @@ public NlpRobertaTokenizationConfigDescriptor Span(int? span) } /// - /// Should tokenization input be automatically truncated before sending to the model for inference + /// + /// Should tokenization input be automatically truncated before sending to the model for inference + /// /// public NlpRobertaTokenizationConfigDescriptor Truncate(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationTruncate? truncate) { @@ -119,7 +141,9 @@ public NlpRobertaTokenizationConfigDescriptor Truncate(Elastic.Clients.Elasticse } /// - /// Is tokenization completed with special tokens + /// + /// Is tokenization completed with special tokens + /// /// public NlpRobertaTokenizationConfigDescriptor WithSpecialTokens(bool? withSpecialTokens = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/NlpTokenizationUpdateOptions.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/NlpTokenizationUpdateOptions.g.cs index 81464643dbc..fa8f9c663a6 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/NlpTokenizationUpdateOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/NlpTokenizationUpdateOptions.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class NlpTokenizationUpdateOptions { /// - /// Span options to apply + /// + /// Span options to apply + /// /// [JsonInclude, JsonPropertyName("span")] public int? Span { get; set; } /// - /// Truncate options to apply + /// + /// Truncate options to apply + /// /// [JsonInclude, JsonPropertyName("truncate")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationTruncate? Truncate { get; set; } @@ -54,7 +58,9 @@ public NlpTokenizationUpdateOptionsDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationTruncate? TruncateValue { get; set; } /// - /// Span options to apply + /// + /// Span options to apply + /// /// public NlpTokenizationUpdateOptionsDescriptor Span(int? span) { @@ -63,7 +69,9 @@ public NlpTokenizationUpdateOptionsDescriptor Span(int? span) } /// - /// Truncate options to apply + /// + /// Truncate options to apply + /// /// public NlpTokenizationUpdateOptionsDescriptor Truncate(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationTruncate? truncate) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/OverallBucket.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/OverallBucket.g.cs index 15f5eff8a19..9a9557ea98a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/OverallBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/OverallBucket.g.cs @@ -30,43 +30,57 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class OverallBucket { /// - /// The length of the bucket in seconds. Matches the job with the longest bucket_span value. + /// + /// The length of the bucket in seconds. Matches the job with the longest bucket_span value. + /// /// [JsonInclude, JsonPropertyName("bucket_span")] public long BucketSpan { get; init; } /// - /// If true, this is an interim result. In other words, the results are calculated based on partial input data. + /// + /// If true, this is an interim result. In other words, the results are calculated based on partial input data. + /// /// [JsonInclude, JsonPropertyName("is_interim")] public bool IsInterim { get; init; } /// - /// An array of objects that contain the max_anomaly_score per job_id. + /// + /// An array of objects that contain the max_anomaly_score per job_id. + /// /// [JsonInclude, JsonPropertyName("jobs")] public IReadOnlyCollection Jobs { get; init; } /// - /// The top_n average of the maximum bucket anomaly_score per job. + /// + /// The top_n average of the maximum bucket anomaly_score per job. + /// /// [JsonInclude, JsonPropertyName("overall_score")] public double OverallScore { get; init; } /// - /// Internal. This is always set to overall_bucket. + /// + /// Internal. This is always set to overall_bucket. + /// /// [JsonInclude, JsonPropertyName("result_type")] public string ResultType { get; init; } /// - /// The start time of the bucket for which these results were calculated. + /// + /// The start time of the bucket for which these results were calculated. + /// /// [JsonInclude, JsonPropertyName("timestamp")] public long Timestamp { get; init; } /// - /// The start time of the bucket for which these results were calculated. + /// + /// The start time of the bucket for which these results were calculated. + /// /// [JsonInclude, JsonPropertyName("timestamp_string")] public DateTimeOffset TimestampString { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Page.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Page.g.cs index cc083922535..d01fb20346b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Page.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Page.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class Page { /// - /// Skips the specified number of items. + /// + /// Skips the specified number of items. + /// /// [JsonInclude, JsonPropertyName("from")] public int? From { get; set; } /// - /// Specifies the maximum number of items to obtain. + /// + /// Specifies the maximum number of items to obtain. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } @@ -54,7 +58,9 @@ public PageDescriptor() : base() private int? SizeValue { get; set; } /// - /// Skips the specified number of items. + /// + /// Skips the specified number of items. + /// /// public PageDescriptor From(int? from) { @@ -63,7 +69,9 @@ public PageDescriptor From(int? from) } /// - /// Specifies the maximum number of items to obtain. + /// + /// Specifies the maximum number of items to obtain. + /// /// public PageDescriptor Size(int? size) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/PassThroughInferenceOptions.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/PassThroughInferenceOptions.g.cs index f7f0344ca37..ef00813e79e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/PassThroughInferenceOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/PassThroughInferenceOptions.g.cs @@ -28,18 +28,24 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; /// -/// Pass through configuration options +/// +/// Pass through configuration options +/// /// public sealed partial class PassThroughInferenceOptions { /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } /// - /// The tokenization options + /// + /// The tokenization options + /// /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationConfig? Tokenization { get; set; } @@ -50,7 +56,9 @@ public sealed partial class PassThroughInferenceOptions } /// -/// Pass through configuration options +/// +/// Pass through configuration options +/// /// public sealed partial class PassThroughInferenceOptionsDescriptor : SerializableDescriptor { @@ -69,7 +77,9 @@ public PassThroughInferenceOptionsDescriptor() : base() private Action VocabularyDescriptorAction { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public PassThroughInferenceOptionsDescriptor ResultsField(string? resultsField) { @@ -78,7 +88,9 @@ public PassThroughInferenceOptionsDescriptor ResultsField(string? resultsField) } /// - /// The tokenization options + /// + /// The tokenization options + /// /// public PassThroughInferenceOptionsDescriptor Tokenization(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationConfig? tokenization) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/PassThroughInferenceUpdateOptions.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/PassThroughInferenceUpdateOptions.g.cs index 9bdb718fc13..0618f73f9d6 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/PassThroughInferenceUpdateOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/PassThroughInferenceUpdateOptions.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class PassThroughInferenceUpdateOptions { /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.NlpTokenizationUpdateOptions? Tokenization { get; set; } @@ -58,7 +62,9 @@ public PassThroughInferenceUpdateOptionsDescriptor() : base() private Action TokenizationDescriptorAction { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public PassThroughInferenceUpdateOptionsDescriptor ResultsField(string? resultsField) { @@ -67,7 +73,9 @@ public PassThroughInferenceUpdateOptionsDescriptor ResultsField(string? resultsF } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// public PassThroughInferenceUpdateOptionsDescriptor Tokenization(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.NlpTokenizationUpdateOptions? tokenization) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/PerPartitionCategorization.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/PerPartitionCategorization.g.cs index 1c9e05fe2fb..eb7bae950d3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/PerPartitionCategorization.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/PerPartitionCategorization.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class PerPartitionCategorization { /// - /// To enable this setting, you must also set the `partition_field_name` property to the same value in every detector that uses the keyword `mlcategory`. Otherwise, job creation fails. + /// + /// To enable this setting, you must also set the partition_field_name property to the same value in every detector that uses the keyword mlcategory. Otherwise, job creation fails. + /// /// [JsonInclude, JsonPropertyName("enabled")] public bool? Enabled { get; set; } /// - /// This setting can be set to true only if per-partition categorization is enabled. If true, both categorization and subsequent anomaly detection stops for partitions where the categorization status changes to warn. This setting makes it viable to have a job where it is expected that categorization works well for some partitions but not others; you do not pay the cost of bad categorization forever in the partitions where it works badly. + /// + /// This setting can be set to true only if per-partition categorization is enabled. If true, both categorization and subsequent anomaly detection stops for partitions where the categorization status changes to warn. This setting makes it viable to have a job where it is expected that categorization works well for some partitions but not others; you do not pay the cost of bad categorization forever in the partitions where it works badly. + /// /// [JsonInclude, JsonPropertyName("stop_on_warn")] public bool? StopOnWarn { get; set; } @@ -54,7 +58,9 @@ public PerPartitionCategorizationDescriptor() : base() private bool? StopOnWarnValue { get; set; } /// - /// To enable this setting, you must also set the `partition_field_name` property to the same value in every detector that uses the keyword `mlcategory`. Otherwise, job creation fails. + /// + /// To enable this setting, you must also set the partition_field_name property to the same value in every detector that uses the keyword mlcategory. Otherwise, job creation fails. + /// /// public PerPartitionCategorizationDescriptor Enabled(bool? enabled = true) { @@ -63,7 +69,9 @@ public PerPartitionCategorizationDescriptor Enabled(bool? enabled = true) } /// - /// This setting can be set to true only if per-partition categorization is enabled. If true, both categorization and subsequent anomaly detection stops for partitions where the categorization status changes to warn. This setting makes it viable to have a job where it is expected that categorization works well for some partitions but not others; you do not pay the cost of bad categorization forever in the partitions where it works badly. + /// + /// This setting can be set to true only if per-partition categorization is enabled. If true, both categorization and subsequent anomaly detection stops for partitions where the categorization status changes to warn. This setting makes it viable to have a job where it is expected that categorization works well for some partitions but not others; you do not pay the cost of bad categorization forever in the partitions where it works badly. + /// /// public PerPartitionCategorizationDescriptor StopOnWarn(bool? stopOnWarn = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/QuestionAnsweringInferenceOptions.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/QuestionAnsweringInferenceOptions.g.cs index cce3e794931..eea25d5cc23 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/QuestionAnsweringInferenceOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/QuestionAnsweringInferenceOptions.g.cs @@ -28,30 +28,40 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; /// -/// Question answering inference options +/// +/// Question answering inference options +/// /// public sealed partial class QuestionAnsweringInferenceOptions { /// - /// The maximum answer length to consider + /// + /// The maximum answer length to consider + /// /// [JsonInclude, JsonPropertyName("max_answer_length")] public int? MaxAnswerLength { get; set; } /// - /// Specifies the number of top class predictions to return. Defaults to 0. + /// + /// Specifies the number of top class predictions to return. Defaults to 0. + /// /// [JsonInclude, JsonPropertyName("num_top_classes")] public int? NumTopClasses { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationConfig? Tokenization { get; set; } @@ -60,7 +70,9 @@ public sealed partial class QuestionAnsweringInferenceOptions } /// -/// Question answering inference options +/// +/// Question answering inference options +/// /// public sealed partial class QuestionAnsweringInferenceOptionsDescriptor : SerializableDescriptor { @@ -78,7 +90,9 @@ public QuestionAnsweringInferenceOptionsDescriptor() : base() private Action TokenizationDescriptorAction { get; set; } /// - /// The maximum answer length to consider + /// + /// The maximum answer length to consider + /// /// public QuestionAnsweringInferenceOptionsDescriptor MaxAnswerLength(int? maxAnswerLength) { @@ -87,7 +101,9 @@ public QuestionAnsweringInferenceOptionsDescriptor MaxAnswerLength(int? maxAnswe } /// - /// Specifies the number of top class predictions to return. Defaults to 0. + /// + /// Specifies the number of top class predictions to return. Defaults to 0. + /// /// public QuestionAnsweringInferenceOptionsDescriptor NumTopClasses(int? numTopClasses) { @@ -96,7 +112,9 @@ public QuestionAnsweringInferenceOptionsDescriptor NumTopClasses(int? numTopClas } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public QuestionAnsweringInferenceOptionsDescriptor ResultsField(string? resultsField) { @@ -105,7 +123,9 @@ public QuestionAnsweringInferenceOptionsDescriptor ResultsField(string? resultsF } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// public QuestionAnsweringInferenceOptionsDescriptor Tokenization(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationConfig? tokenization) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/QuestionAnsweringInferenceUpdateOptions.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/QuestionAnsweringInferenceUpdateOptions.g.cs index d433679b479..724868b82a2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/QuestionAnsweringInferenceUpdateOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/QuestionAnsweringInferenceUpdateOptions.g.cs @@ -30,31 +30,41 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class QuestionAnsweringInferenceUpdateOptions { /// - /// The maximum answer length to consider for extraction + /// + /// The maximum answer length to consider for extraction + /// /// [JsonInclude, JsonPropertyName("max_answer_length")] public int? MaxAnswerLength { get; set; } /// - /// Specifies the number of top class predictions to return. Defaults to 0. + /// + /// Specifies the number of top class predictions to return. Defaults to 0. + /// /// [JsonInclude, JsonPropertyName("num_top_classes")] public int? NumTopClasses { get; set; } /// - /// The question to answer given the inference context + /// + /// The question to answer given the inference context + /// /// [JsonInclude, JsonPropertyName("question")] public string Question { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.NlpTokenizationUpdateOptions? Tokenization { get; set; } @@ -79,7 +89,9 @@ public QuestionAnsweringInferenceUpdateOptionsDescriptor() : base() private Action TokenizationDescriptorAction { get; set; } /// - /// The maximum answer length to consider for extraction + /// + /// The maximum answer length to consider for extraction + /// /// public QuestionAnsweringInferenceUpdateOptionsDescriptor MaxAnswerLength(int? maxAnswerLength) { @@ -88,7 +100,9 @@ public QuestionAnsweringInferenceUpdateOptionsDescriptor MaxAnswerLength(int? ma } /// - /// Specifies the number of top class predictions to return. Defaults to 0. + /// + /// Specifies the number of top class predictions to return. Defaults to 0. + /// /// public QuestionAnsweringInferenceUpdateOptionsDescriptor NumTopClasses(int? numTopClasses) { @@ -97,7 +111,9 @@ public QuestionAnsweringInferenceUpdateOptionsDescriptor NumTopClasses(int? numT } /// - /// The question to answer given the inference context + /// + /// The question to answer given the inference context + /// /// public QuestionAnsweringInferenceUpdateOptionsDescriptor Question(string question) { @@ -106,7 +122,9 @@ public QuestionAnsweringInferenceUpdateOptionsDescriptor Question(string questio } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public QuestionAnsweringInferenceUpdateOptionsDescriptor ResultsField(string? resultsField) { @@ -115,7 +133,9 @@ public QuestionAnsweringInferenceUpdateOptionsDescriptor ResultsField(string? re } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// public QuestionAnsweringInferenceUpdateOptionsDescriptor Tokenization(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.NlpTokenizationUpdateOptions? tokenization) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/RegressionInferenceOptions.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/RegressionInferenceOptions.g.cs index e5b837e469e..b6c6eb113bf 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/RegressionInferenceOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/RegressionInferenceOptions.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class RegressionInferenceOptions { /// - /// Specifies the maximum number of feature importance values per document. + /// + /// Specifies the maximum number of feature importance values per document. + /// /// [JsonInclude, JsonPropertyName("num_top_feature_importance_values")] public int? NumTopFeatureImportanceValues { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? ResultsField { get; set; } @@ -58,7 +62,9 @@ public RegressionInferenceOptionsDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? ResultsFieldValue { get; set; } /// - /// Specifies the maximum number of feature importance values per document. + /// + /// Specifies the maximum number of feature importance values per document. + /// /// public RegressionInferenceOptionsDescriptor NumTopFeatureImportanceValues(int? numTopFeatureImportanceValues) { @@ -67,7 +73,9 @@ public RegressionInferenceOptionsDescriptor NumTopFeatureImportanceVa } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public RegressionInferenceOptionsDescriptor ResultsField(Elastic.Clients.Elasticsearch.Serverless.Field? resultsField) { @@ -76,7 +84,9 @@ public RegressionInferenceOptionsDescriptor ResultsField(Elastic.Clie } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public RegressionInferenceOptionsDescriptor ResultsField(Expression> resultsField) { @@ -85,7 +95,9 @@ public RegressionInferenceOptionsDescriptor ResultsField(Expr } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public RegressionInferenceOptionsDescriptor ResultsField(Expression> resultsField) { @@ -124,7 +136,9 @@ public RegressionInferenceOptionsDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? ResultsFieldValue { get; set; } /// - /// Specifies the maximum number of feature importance values per document. + /// + /// Specifies the maximum number of feature importance values per document. + /// /// public RegressionInferenceOptionsDescriptor NumTopFeatureImportanceValues(int? numTopFeatureImportanceValues) { @@ -133,7 +147,9 @@ public RegressionInferenceOptionsDescriptor NumTopFeatureImportanceValues(int? n } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public RegressionInferenceOptionsDescriptor ResultsField(Elastic.Clients.Elasticsearch.Serverless.Field? resultsField) { @@ -142,7 +158,9 @@ public RegressionInferenceOptionsDescriptor ResultsField(Elastic.Clients.Elastic } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public RegressionInferenceOptionsDescriptor ResultsField(Expression> resultsField) { @@ -151,7 +169,9 @@ public RegressionInferenceOptionsDescriptor ResultsField(Expr } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public RegressionInferenceOptionsDescriptor ResultsField(Expression> resultsField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/RuleCondition.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/RuleCondition.g.cs index 7a336af509b..615ee4c9c1a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/RuleCondition.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/RuleCondition.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class RuleCondition { /// - /// Specifies the result property to which the condition applies. If your detector uses `lat_long`, `metric`, `rare`, or `freq_rare` functions, you can only specify conditions that apply to time. + /// + /// Specifies the result property to which the condition applies. If your detector uses lat_long, metric, rare, or freq_rare functions, you can only specify conditions that apply to time. + /// /// [JsonInclude, JsonPropertyName("applies_to")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.AppliesTo AppliesTo { get; set; } /// - /// Specifies the condition operator. The available options are greater than, greater than or equals, less than, and less than or equals. + /// + /// Specifies the condition operator. The available options are greater than, greater than or equals, less than, and less than or equals. + /// /// [JsonInclude, JsonPropertyName("operator")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ConditionOperator Operator { get; set; } /// - /// The value that is compared against the `applies_to` field using the operator. + /// + /// The value that is compared against the applies_to field using the operator. + /// /// [JsonInclude, JsonPropertyName("value")] public double Value { get; set; } @@ -61,7 +67,9 @@ public RuleConditionDescriptor() : base() private double ValueValue { get; set; } /// - /// Specifies the result property to which the condition applies. If your detector uses `lat_long`, `metric`, `rare`, or `freq_rare` functions, you can only specify conditions that apply to time. + /// + /// Specifies the result property to which the condition applies. If your detector uses lat_long, metric, rare, or freq_rare functions, you can only specify conditions that apply to time. + /// /// public RuleConditionDescriptor AppliesTo(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.AppliesTo appliesTo) { @@ -70,7 +78,9 @@ public RuleConditionDescriptor AppliesTo(Elastic.Clients.Elasticsearch.Serverles } /// - /// Specifies the condition operator. The available options are greater than, greater than or equals, less than, and less than or equals. + /// + /// Specifies the condition operator. The available options are greater than, greater than or equals, less than, and less than or equals. + /// /// public RuleConditionDescriptor Operator(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ConditionOperator value) { @@ -79,7 +89,9 @@ public RuleConditionDescriptor Operator(Elastic.Clients.Elasticsearch.Serverless } /// - /// The value that is compared against the `applies_to` field using the operator. + /// + /// The value that is compared against the applies_to field using the operator. + /// /// public RuleConditionDescriptor Value(double value) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/RunningStateSearchInterval.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/RunningStateSearchInterval.g.cs index 3e6cd38af2d..ceffe5648d6 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/RunningStateSearchInterval.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/RunningStateSearchInterval.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class RunningStateSearchInterval { /// - /// The end time. + /// + /// The end time. + /// /// [JsonInclude, JsonPropertyName("end")] public Elastic.Clients.Elasticsearch.Serverless.Duration? End { get; init; } /// - /// The end time as an epoch in milliseconds. + /// + /// The end time as an epoch in milliseconds. + /// /// [JsonInclude, JsonPropertyName("end_ms")] public long EndMs { get; init; } /// - /// The start time. + /// + /// The start time. + /// /// [JsonInclude, JsonPropertyName("start")] public Elastic.Clients.Elasticsearch.Serverless.Duration? Start { get; init; } /// - /// The start time as an epoch in milliseconds. + /// + /// The start time as an epoch in milliseconds. + /// /// [JsonInclude, JsonPropertyName("start_ms")] public long StartMs { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextClassificationInferenceOptions.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextClassificationInferenceOptions.g.cs index 9965995130b..fed77e31d98 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextClassificationInferenceOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextClassificationInferenceOptions.g.cs @@ -28,30 +28,40 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; /// -/// Text classification configuration options +/// +/// Text classification configuration options +/// /// public sealed partial class TextClassificationInferenceOptions { /// - /// Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels + /// + /// Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels + /// /// [JsonInclude, JsonPropertyName("classification_labels")] public ICollection? ClassificationLabels { get; set; } /// - /// Specifies the number of top class predictions to return. Defaults to 0. + /// + /// Specifies the number of top class predictions to return. Defaults to 0. + /// /// [JsonInclude, JsonPropertyName("num_top_classes")] public int? NumTopClasses { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } /// - /// The tokenization options + /// + /// The tokenization options + /// /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationConfig? Tokenization { get; set; } @@ -60,7 +70,9 @@ public sealed partial class TextClassificationInferenceOptions } /// -/// Text classification configuration options +/// +/// Text classification configuration options +/// /// public sealed partial class TextClassificationInferenceOptionsDescriptor : SerializableDescriptor { @@ -78,7 +90,9 @@ public TextClassificationInferenceOptionsDescriptor() : base() private Action TokenizationDescriptorAction { get; set; } /// - /// Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels + /// + /// Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels + /// /// public TextClassificationInferenceOptionsDescriptor ClassificationLabels(ICollection? classificationLabels) { @@ -87,7 +101,9 @@ public TextClassificationInferenceOptionsDescriptor ClassificationLabels(ICollec } /// - /// Specifies the number of top class predictions to return. Defaults to 0. + /// + /// Specifies the number of top class predictions to return. Defaults to 0. + /// /// public TextClassificationInferenceOptionsDescriptor NumTopClasses(int? numTopClasses) { @@ -96,7 +112,9 @@ public TextClassificationInferenceOptionsDescriptor NumTopClasses(int? numTopCla } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public TextClassificationInferenceOptionsDescriptor ResultsField(string? resultsField) { @@ -105,7 +123,9 @@ public TextClassificationInferenceOptionsDescriptor ResultsField(string? results } /// - /// The tokenization options + /// + /// The tokenization options + /// /// public TextClassificationInferenceOptionsDescriptor Tokenization(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationConfig? tokenization) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextClassificationInferenceUpdateOptions.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextClassificationInferenceUpdateOptions.g.cs index 0d1f4c490dc..6613c59a10e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextClassificationInferenceUpdateOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextClassificationInferenceUpdateOptions.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class TextClassificationInferenceUpdateOptions { /// - /// Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels + /// + /// Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels + /// /// [JsonInclude, JsonPropertyName("classification_labels")] public ICollection? ClassificationLabels { get; set; } /// - /// Specifies the number of top class predictions to return. Defaults to 0. + /// + /// Specifies the number of top class predictions to return. Defaults to 0. + /// /// [JsonInclude, JsonPropertyName("num_top_classes")] public int? NumTopClasses { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.NlpTokenizationUpdateOptions? Tokenization { get; set; } @@ -72,7 +80,9 @@ public TextClassificationInferenceUpdateOptionsDescriptor() : base() private Action TokenizationDescriptorAction { get; set; } /// - /// Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels + /// + /// Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels + /// /// public TextClassificationInferenceUpdateOptionsDescriptor ClassificationLabels(ICollection? classificationLabels) { @@ -81,7 +91,9 @@ public TextClassificationInferenceUpdateOptionsDescriptor ClassificationLabels(I } /// - /// Specifies the number of top class predictions to return. Defaults to 0. + /// + /// Specifies the number of top class predictions to return. Defaults to 0. + /// /// public TextClassificationInferenceUpdateOptionsDescriptor NumTopClasses(int? numTopClasses) { @@ -90,7 +102,9 @@ public TextClassificationInferenceUpdateOptionsDescriptor NumTopClasses(int? num } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public TextClassificationInferenceUpdateOptionsDescriptor ResultsField(string? resultsField) { @@ -99,7 +113,9 @@ public TextClassificationInferenceUpdateOptionsDescriptor ResultsField(string? r } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// public TextClassificationInferenceUpdateOptionsDescriptor Tokenization(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.NlpTokenizationUpdateOptions? tokenization) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextEmbeddingInferenceOptions.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextEmbeddingInferenceOptions.g.cs index 706ffb770df..1ec7785d42c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextEmbeddingInferenceOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextEmbeddingInferenceOptions.g.cs @@ -28,24 +28,32 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; /// -/// Text embedding inference options +/// +/// Text embedding inference options +/// /// public sealed partial class TextEmbeddingInferenceOptions { /// - /// The number of dimensions in the embedding output + /// + /// The number of dimensions in the embedding output + /// /// [JsonInclude, JsonPropertyName("embedding_size")] public int? EmbeddingSize { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } /// - /// The tokenization options + /// + /// The tokenization options + /// /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationConfig? Tokenization { get; set; } @@ -54,7 +62,9 @@ public sealed partial class TextEmbeddingInferenceOptions } /// -/// Text embedding inference options +/// +/// Text embedding inference options +/// /// public sealed partial class TextEmbeddingInferenceOptionsDescriptor : SerializableDescriptor { @@ -71,7 +81,9 @@ public TextEmbeddingInferenceOptionsDescriptor() : base() private Action TokenizationDescriptorAction { get; set; } /// - /// The number of dimensions in the embedding output + /// + /// The number of dimensions in the embedding output + /// /// public TextEmbeddingInferenceOptionsDescriptor EmbeddingSize(int? embeddingSize) { @@ -80,7 +92,9 @@ public TextEmbeddingInferenceOptionsDescriptor EmbeddingSize(int? embeddingSize) } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public TextEmbeddingInferenceOptionsDescriptor ResultsField(string? resultsField) { @@ -89,7 +103,9 @@ public TextEmbeddingInferenceOptionsDescriptor ResultsField(string? resultsField } /// - /// The tokenization options + /// + /// The tokenization options + /// /// public TextEmbeddingInferenceOptionsDescriptor Tokenization(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationConfig? tokenization) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextEmbeddingInferenceUpdateOptions.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextEmbeddingInferenceUpdateOptions.g.cs index 1d48a15a576..aab77603e6d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextEmbeddingInferenceUpdateOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextEmbeddingInferenceUpdateOptions.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class TextEmbeddingInferenceUpdateOptions { /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } @@ -54,7 +56,9 @@ public TextEmbeddingInferenceUpdateOptionsDescriptor() : base() private Action TokenizationDescriptorAction { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public TextEmbeddingInferenceUpdateOptionsDescriptor ResultsField(string? resultsField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextExpansionInferenceOptions.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextExpansionInferenceOptions.g.cs index fea0b58e7fb..a99e3f66997 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextExpansionInferenceOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextExpansionInferenceOptions.g.cs @@ -28,18 +28,24 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; /// -/// Text expansion inference options +/// +/// Text expansion inference options +/// /// public sealed partial class TextExpansionInferenceOptions { /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } /// - /// The tokenization options + /// + /// The tokenization options + /// /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationConfig? Tokenization { get; set; } @@ -48,7 +54,9 @@ public sealed partial class TextExpansionInferenceOptions } /// -/// Text expansion inference options +/// +/// Text expansion inference options +/// /// public sealed partial class TextExpansionInferenceOptionsDescriptor : SerializableDescriptor { @@ -64,7 +72,9 @@ public TextExpansionInferenceOptionsDescriptor() : base() private Action TokenizationDescriptorAction { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public TextExpansionInferenceOptionsDescriptor ResultsField(string? resultsField) { @@ -73,7 +83,9 @@ public TextExpansionInferenceOptionsDescriptor ResultsField(string? resultsField } /// - /// The tokenization options + /// + /// The tokenization options + /// /// public TextExpansionInferenceOptionsDescriptor Tokenization(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationConfig? tokenization) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextExpansionInferenceUpdateOptions.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextExpansionInferenceUpdateOptions.g.cs index 88e84219153..e7ade69c7e4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextExpansionInferenceUpdateOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextExpansionInferenceUpdateOptions.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class TextExpansionInferenceUpdateOptions { /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } @@ -54,7 +56,9 @@ public TextExpansionInferenceUpdateOptionsDescriptor() : base() private Action TokenizationDescriptorAction { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public TextExpansionInferenceUpdateOptionsDescriptor ResultsField(string? resultsField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TokenizationConfig.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TokenizationConfig.g.cs index b0841e30ea1..5b609a8d592 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TokenizationConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TokenizationConfig.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; /// -/// Tokenization options stored in inference configuration +/// +/// Tokenization options stored in inference configuration +/// /// [JsonConverter(typeof(TokenizationConfigConverter))] public sealed partial class TokenizationConfig diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TotalFeatureImportance.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TotalFeatureImportance.g.cs index 798e12c06d2..691eaff684d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TotalFeatureImportance.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TotalFeatureImportance.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class TotalFeatureImportance { /// - /// If the trained model is a classification model, feature importance statistics are gathered per target class value. + /// + /// If the trained model is a classification model, feature importance statistics are gathered per target class value. + /// /// [JsonInclude, JsonPropertyName("classes")] public IReadOnlyCollection Classes { get; init; } /// - /// The feature for which this importance was calculated. + /// + /// The feature for which this importance was calculated. + /// /// [JsonInclude, JsonPropertyName("feature_name")] public string FeatureName { get; init; } /// - /// A collection of feature importance statistics related to the training data set for this particular feature. + /// + /// A collection of feature importance statistics related to the training data set for this particular feature. + /// /// [JsonInclude, JsonPropertyName("importance")] public IReadOnlyCollection Importance { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TotalFeatureImportanceClass.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TotalFeatureImportanceClass.g.cs index 05142eedeb8..7a660361c36 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TotalFeatureImportanceClass.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TotalFeatureImportanceClass.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class TotalFeatureImportanceClass { /// - /// The target class value. Could be a string, boolean, or number. + /// + /// The target class value. Could be a string, boolean, or number. + /// /// [JsonInclude, JsonPropertyName("class_name")] public string ClassName { get; init; } /// - /// A collection of feature importance statistics related to the training data set for this particular feature. + /// + /// A collection of feature importance statistics related to the training data set for this particular feature. + /// /// [JsonInclude, JsonPropertyName("importance")] public IReadOnlyCollection Importance { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TotalFeatureImportanceStatistics.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TotalFeatureImportanceStatistics.g.cs index 88c3ba5a26f..fb2a4665bec 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TotalFeatureImportanceStatistics.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TotalFeatureImportanceStatistics.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class TotalFeatureImportanceStatistics { /// - /// The maximum importance value across all the training data for this feature. + /// + /// The maximum importance value across all the training data for this feature. + /// /// [JsonInclude, JsonPropertyName("max")] public int Max { get; init; } /// - /// The average magnitude of this feature across all the training data. This value is the average of the absolute values of the importance for this feature. + /// + /// The average magnitude of this feature across all the training data. This value is the average of the absolute values of the importance for this feature. + /// /// [JsonInclude, JsonPropertyName("mean_magnitude")] public double MeanMagnitude { get; init; } /// - /// The minimum importance value across all the training data for this feature. + /// + /// The minimum importance value across all the training data for this feature. + /// /// [JsonInclude, JsonPropertyName("min")] public int Min { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModel.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModel.g.cs index 8f02b7b6e0f..bd3b3d35b2b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModel.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModel.g.cs @@ -30,19 +30,38 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class TrainedModel { /// - /// The definition for an ensemble model + /// + /// The definition for an ensemble model + /// /// [JsonInclude, JsonPropertyName("ensemble")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Ensemble? Ensemble { get; set; } /// - /// The definition for a binary decision tree. + /// + /// The definition for a binary decision tree. + /// /// [JsonInclude, JsonPropertyName("tree")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainedModelTree? Tree { get; set; } /// - /// The definition of a node in a tree.
There are two major types of nodes: leaf nodes and not-leaf nodes.
- Leaf nodes only need node_index and leaf_value defined.
- All other nodes need split_feature, left_child, right_child, threshold, decision_type, and default_left defined. + /// + /// The definition of a node in a tree. + /// There are two major types of nodes: leaf nodes and not-leaf nodes. + /// + /// + /// + /// + /// Leaf nodes only need node_index and leaf_value defined. + /// + /// + /// + /// + /// All other nodes need split_feature, left_child, right_child, threshold, decision_type, and default_left defined. + /// + /// + /// /// [JsonInclude, JsonPropertyName("tree_node")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainedModelTreeNode? TreeNode { get; set; } @@ -67,7 +86,9 @@ public TrainedModelDescriptor() : base() private Action TreeNodeDescriptorAction { get; set; } /// - /// The definition for an ensemble model + /// + /// The definition for an ensemble model + /// /// public TrainedModelDescriptor Ensemble(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Ensemble? ensemble) { @@ -94,7 +115,9 @@ public TrainedModelDescriptor Ensemble(Action - /// The definition for a binary decision tree. + /// + /// The definition for a binary decision tree. + /// /// public TrainedModelDescriptor Tree(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainedModelTree? tree) { @@ -121,7 +144,22 @@ public TrainedModelDescriptor Tree(Action - /// The definition of a node in a tree.
There are two major types of nodes: leaf nodes and not-leaf nodes.
- Leaf nodes only need node_index and leaf_value defined.
- All other nodes need split_feature, left_child, right_child, threshold, decision_type, and default_left defined. + /// + /// The definition of a node in a tree. + /// There are two major types of nodes: leaf nodes and not-leaf nodes. + /// + /// + /// + /// + /// Leaf nodes only need node_index and leaf_value defined. + /// + /// + /// + /// + /// All other nodes need split_feature, left_child, right_child, threshold, decision_type, and default_left defined. + /// + /// + /// /// public TrainedModelDescriptor TreeNode(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainedModelTreeNode? treeNode) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelAssignment.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelAssignment.g.cs index 4b36ae2d271..23465b606ae 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelAssignment.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelAssignment.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class TrainedModelAssignment { /// - /// The overall assignment state. + /// + /// The overall assignment state. + /// /// [JsonInclude, JsonPropertyName("assignment_state")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DeploymentAssignmentState AssignmentState { get; init; } @@ -38,13 +40,17 @@ public sealed partial class TrainedModelAssignment public int? MaxAssignedAllocations { get; init; } /// - /// The allocation state for each node. + /// + /// The allocation state for each node. + /// /// [JsonInclude, JsonPropertyName("routing_table")] public IReadOnlyDictionary RoutingTable { get; init; } /// - /// The timestamp when the deployment started. + /// + /// The timestamp when the deployment started. + /// /// [JsonInclude, JsonPropertyName("start_time")] public DateTimeOffset StartTime { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelAssignmentRoutingTable.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelAssignmentRoutingTable.g.cs index cbfa14d5653..8385980e2f8 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelAssignmentRoutingTable.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelAssignmentRoutingTable.g.cs @@ -30,25 +30,34 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class TrainedModelAssignmentRoutingTable { /// - /// Current number of allocations. + /// + /// Current number of allocations. + /// /// [JsonInclude, JsonPropertyName("current_allocations")] public int CurrentAllocations { get; init; } /// - /// The reason for the current state. It is usually populated only when the
`routing_state` is `failed`. + /// + /// The reason for the current state. It is usually populated only when the + /// routing_state is failed. + /// /// [JsonInclude, JsonPropertyName("reason")] public string Reason { get; init; } /// - /// The current routing state. + /// + /// The current routing state. + /// /// [JsonInclude, JsonPropertyName("routing_state")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.RoutingState RoutingState { get; init; } /// - /// Target number of allocations. + /// + /// Target number of allocations. + /// /// [JsonInclude, JsonPropertyName("target_allocations")] public int TargetAllocations { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelAssignmentTaskParameters.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelAssignmentTaskParameters.g.cs index 106d4e51237..95d869c899e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelAssignmentTaskParameters.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelAssignmentTaskParameters.g.cs @@ -30,31 +30,41 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class TrainedModelAssignmentTaskParameters { /// - /// The size of the trained model cache. + /// + /// The size of the trained model cache. + /// /// [JsonInclude, JsonPropertyName("cache_size")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize CacheSize { get; init; } /// - /// The unique identifier for the trained model deployment. + /// + /// The unique identifier for the trained model deployment. + /// /// [JsonInclude, JsonPropertyName("deployment_id")] public string DeploymentId { get; init; } /// - /// The size of the trained model in bytes. + /// + /// The size of the trained model in bytes. + /// /// [JsonInclude, JsonPropertyName("model_bytes")] public int ModelBytes { get; init; } /// - /// The unique identifier for the trained model. + /// + /// The unique identifier for the trained model. + /// /// [JsonInclude, JsonPropertyName("model_id")] public string ModelId { get; init; } /// - /// The total number of allocations this model is assigned across ML nodes. + /// + /// The total number of allocations this model is assigned across ML nodes. + /// /// [JsonInclude, JsonPropertyName("number_of_allocations")] public int NumberOfAllocations { get; init; } @@ -62,13 +72,17 @@ public sealed partial class TrainedModelAssignmentTaskParameters public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainingPriority Priority { get; init; } /// - /// Number of inference requests are allowed in the queue at a time. + /// + /// Number of inference requests are allowed in the queue at a time. + /// /// [JsonInclude, JsonPropertyName("queue_capacity")] public int QueueCapacity { get; init; } /// - /// Number of threads per allocation. + /// + /// Number of threads per allocation. + /// /// [JsonInclude, JsonPropertyName("threads_per_allocation")] public int ThreadsPerAllocation { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelConfig.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelConfig.g.cs index b96b0be96a0..9dd9ca46448 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelConfig.g.cs @@ -33,61 +33,81 @@ public sealed partial class TrainedModelConfig public string? CompressedDefinition { get; init; } /// - /// Information on the creator of the trained model. + /// + /// Information on the creator of the trained model. + /// /// [JsonInclude, JsonPropertyName("created_by")] public string? CreatedBy { get; init; } /// - /// The time when the trained model was created. + /// + /// The time when the trained model was created. + /// /// [JsonInclude, JsonPropertyName("create_time")] public DateTimeOffset? CreateTime { get; init; } /// - /// Any field map described in the inference configuration takes precedence. + /// + /// Any field map described in the inference configuration takes precedence. + /// /// [JsonInclude, JsonPropertyName("default_field_map")] public IReadOnlyDictionary? DefaultFieldMap { get; init; } /// - /// The free-text description of the trained model. + /// + /// The free-text description of the trained model. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; init; } /// - /// The estimated heap usage in bytes to keep the trained model in memory. + /// + /// The estimated heap usage in bytes to keep the trained model in memory. + /// /// [JsonInclude, JsonPropertyName("estimated_heap_memory_usage_bytes")] public int? EstimatedHeapMemoryUsageBytes { get; init; } /// - /// The estimated number of operations to use the trained model. + /// + /// The estimated number of operations to use the trained model. + /// /// [JsonInclude, JsonPropertyName("estimated_operations")] public int? EstimatedOperations { get; init; } /// - /// True if the full model definition is present. + /// + /// True if the full model definition is present. + /// /// [JsonInclude, JsonPropertyName("fully_defined")] public bool? FullyDefined { get; init; } /// - /// The default configuration for inference. This can be either a regression, classification, or one of the many NLP focused configurations. It must match the underlying definition.trained_model's target_type. For pre-packaged models such as ELSER the config is not required. + /// + /// The default configuration for inference. This can be either a regression, classification, or one of the many NLP focused configurations. It must match the underlying definition.trained_model's target_type. For pre-packaged models such as ELSER the config is not required. + /// /// [JsonInclude, JsonPropertyName("inference_config")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.InferenceConfigCreate? InferenceConfig { get; init; } /// - /// The input field names for the model definition. + /// + /// The input field names for the model definition. + /// /// [JsonInclude, JsonPropertyName("input")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainedModelConfigInput Input { get; init; } /// - /// The license level of the trained model. + /// + /// The license level of the trained model. + /// /// [JsonInclude, JsonPropertyName("license_level")] public string? LicenseLevel { get; init; } @@ -95,13 +115,17 @@ public sealed partial class TrainedModelConfig public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainedModelLocation? Location { get; init; } /// - /// An object containing metadata about the trained model. For example, models created by data frame analytics contain analysis_config and input objects. + /// + /// An object containing metadata about the trained model. For example, models created by data frame analytics contain analysis_config and input objects. + /// /// [JsonInclude, JsonPropertyName("metadata")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainedModelConfigMetadata? Metadata { get; init; } /// - /// Identifier for the trained model. + /// + /// Identifier for the trained model. + /// /// [JsonInclude, JsonPropertyName("model_id")] public string ModelId { get; init; } @@ -109,7 +133,9 @@ public sealed partial class TrainedModelConfig public Elastic.Clients.Elasticsearch.Serverless.ByteSize? ModelSizeBytes { get; init; } /// - /// The model type + /// + /// The model type + /// /// [JsonInclude, JsonPropertyName("model_type")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainedModelType? ModelType { get; init; } @@ -117,13 +143,17 @@ public sealed partial class TrainedModelConfig public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainedModelPrefixStrings? PrefixStrings { get; init; } /// - /// A comma delimited string of tags. A trained model can have many tags, or none. + /// + /// A comma delimited string of tags. A trained model can have many tags, or none. + /// /// [JsonInclude, JsonPropertyName("tags")] public IReadOnlyCollection Tags { get; init; } /// - /// The Elasticsearch version number in which the trained model was created. + /// + /// The Elasticsearch version number in which the trained model was created. + /// /// [JsonInclude, JsonPropertyName("version")] public string? Version { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelConfigInput.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelConfigInput.g.cs index 7d858c25f96..470067ae3b2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelConfigInput.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelConfigInput.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class TrainedModelConfigInput { /// - /// An array of input field names for the model. + /// + /// An array of input field names for the model. + /// /// [JsonInclude, JsonPropertyName("field_names")] public IReadOnlyCollection FieldNames { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelConfigMetadata.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelConfigMetadata.g.cs index 3b59229dde5..cae44fa3cb3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelConfigMetadata.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelConfigMetadata.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class TrainedModelConfigMetadata { /// - /// An object that contains the baseline for feature importance values. For regression analysis, it is a single value. For classification analysis, there is a value for each class. + /// + /// An object that contains the baseline for feature importance values. For regression analysis, it is a single value. For classification analysis, there is a value for each class. + /// /// [JsonInclude, JsonPropertyName("feature_importance_baseline")] public IReadOnlyDictionary? FeatureImportanceBaseline { get; init; } /// - /// List of the available hyperparameters optimized during the fine_parameter_tuning phase as well as specified by the user. + /// + /// List of the available hyperparameters optimized during the fine_parameter_tuning phase as well as specified by the user. + /// /// [JsonInclude, JsonPropertyName("hyperparameters")] public IReadOnlyCollection? Hyperparameters { get; init; } @@ -44,7 +48,9 @@ public sealed partial class TrainedModelConfigMetadata public IReadOnlyCollection? ModelAliases { get; init; } /// - /// An array of the total feature importance for each feature used from the training data set. This array of objects is returned if data frame analytics trained the model and the request includes total_feature_importance in the include request parameter. + /// + /// An array of the total feature importance for each feature used from the training data set. This array of objects is returned if data frame analytics trained the model and the request includes total_feature_importance in the include request parameter. + /// /// [JsonInclude, JsonPropertyName("total_feature_importance")] public IReadOnlyCollection? TotalFeatureImportance { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelDeploymentAllocationStatus.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelDeploymentAllocationStatus.g.cs index d4717b0317c..6fdd0cf1dbf 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelDeploymentAllocationStatus.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelDeploymentAllocationStatus.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class TrainedModelDeploymentAllocationStatus { /// - /// The current number of nodes where the model is allocated. + /// + /// The current number of nodes where the model is allocated. + /// /// [JsonInclude, JsonPropertyName("allocation_count")] public int AllocationCount { get; init; } /// - /// The detailed allocation state related to the nodes. + /// + /// The detailed allocation state related to the nodes. + /// /// [JsonInclude, JsonPropertyName("state")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DeploymentAllocationState State { get; init; } /// - /// The desired number of nodes for model allocation. + /// + /// The desired number of nodes for model allocation. + /// /// [JsonInclude, JsonPropertyName("target_allocation_count")] public int TargetAllocationCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelDeploymentNodesStats.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelDeploymentNodesStats.g.cs index d16c744b35a..d4ca4f95618 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelDeploymentNodesStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelDeploymentNodesStats.g.cs @@ -30,67 +30,89 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class TrainedModelDeploymentNodesStats { /// - /// The average time for each inference call to complete on this node. + /// + /// The average time for each inference call to complete on this node. + /// /// [JsonInclude, JsonPropertyName("average_inference_time_ms")] public double AverageInferenceTimeMs { get; init; } /// - /// The number of errors when evaluating the trained model. + /// + /// The number of errors when evaluating the trained model. + /// /// [JsonInclude, JsonPropertyName("error_count")] public int ErrorCount { get; init; } /// - /// The total number of inference calls made against this node for this model. + /// + /// The total number of inference calls made against this node for this model. + /// /// [JsonInclude, JsonPropertyName("inference_count")] public int InferenceCount { get; init; } /// - /// The epoch time stamp of the last inference call for the model on this node. + /// + /// The epoch time stamp of the last inference call for the model on this node. + /// /// [JsonInclude, JsonPropertyName("last_access")] public long LastAccess { get; init; } /// - /// The number of allocations assigned to this node. + /// + /// The number of allocations assigned to this node. + /// /// [JsonInclude, JsonPropertyName("number_of_allocations")] public int NumberOfAllocations { get; init; } /// - /// The number of inference requests queued to be processed. + /// + /// The number of inference requests queued to be processed. + /// /// [JsonInclude, JsonPropertyName("number_of_pending_requests")] public int NumberOfPendingRequests { get; init; } /// - /// The number of inference requests that were not processed because the queue was full. + /// + /// The number of inference requests that were not processed because the queue was full. + /// /// [JsonInclude, JsonPropertyName("rejection_execution_count")] public int RejectionExecutionCount { get; init; } /// - /// The current routing state and reason for the current routing state for this allocation. + /// + /// The current routing state and reason for the current routing state for this allocation. + /// /// [JsonInclude, JsonPropertyName("routing_state")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainedModelAssignmentRoutingTable RoutingState { get; init; } /// - /// The epoch timestamp when the allocation started. + /// + /// The epoch timestamp when the allocation started. + /// /// [JsonInclude, JsonPropertyName("start_time")] public long StartTime { get; init; } /// - /// The number of threads used by each allocation during inference. + /// + /// The number of threads used by each allocation during inference. + /// /// [JsonInclude, JsonPropertyName("threads_per_allocation")] public int ThreadsPerAllocation { get; init; } /// - /// The number of inference requests that timed out before being processed. + /// + /// The number of inference requests that timed out before being processed. + /// /// [JsonInclude, JsonPropertyName("timeout_count")] public int TimeoutCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelDeploymentStats.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelDeploymentStats.g.cs index 49ad5788b33..d9f682addf5 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelDeploymentStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelDeploymentStats.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class TrainedModelDeploymentStats { /// - /// The detailed allocation status for the deployment. + /// + /// The detailed allocation status for the deployment. + /// /// [JsonInclude, JsonPropertyName("allocation_status")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainedModelDeploymentAllocationStatus AllocationStatus { get; init; } @@ -38,79 +40,110 @@ public sealed partial class TrainedModelDeploymentStats public Elastic.Clients.Elasticsearch.Serverless.ByteSize? CacheSize { get; init; } /// - /// The unique identifier for the trained model deployment. + /// + /// The unique identifier for the trained model deployment. + /// /// [JsonInclude, JsonPropertyName("deployment_id")] public string DeploymentId { get; init; } /// - /// The sum of `error_count` for all nodes in the deployment. + /// + /// The sum of error_count for all nodes in the deployment. + /// /// [JsonInclude, JsonPropertyName("error_count")] public int ErrorCount { get; init; } /// - /// The sum of `inference_count` for all nodes in the deployment. + /// + /// The sum of inference_count for all nodes in the deployment. + /// /// [JsonInclude, JsonPropertyName("inference_count")] public int InferenceCount { get; init; } /// - /// The unique identifier for the trained model. + /// + /// The unique identifier for the trained model. + /// /// [JsonInclude, JsonPropertyName("model_id")] public string ModelId { get; init; } /// - /// The deployment stats for each node that currently has the model allocated.
In serverless, stats are reported for a single unnamed virtual node. + /// + /// The deployment stats for each node that currently has the model allocated. + /// In serverless, stats are reported for a single unnamed virtual node. + /// /// [JsonInclude, JsonPropertyName("nodes")] public IReadOnlyCollection Nodes { get; init; } /// - /// The number of allocations requested. + /// + /// The number of allocations requested. + /// /// [JsonInclude, JsonPropertyName("number_of_allocations")] public int NumberOfAllocations { get; init; } /// - /// The number of inference requests that can be queued before new requests are rejected. + /// + /// The number of inference requests that can be queued before new requests are rejected. + /// /// [JsonInclude, JsonPropertyName("queue_capacity")] public int QueueCapacity { get; init; } /// - /// The reason for the current deployment state. Usually only populated when
the model is not deployed to a node. + /// + /// The reason for the current deployment state. Usually only populated when + /// the model is not deployed to a node. + /// /// [JsonInclude, JsonPropertyName("reason")] public string Reason { get; init; } /// - /// The sum of `rejected_execution_count` for all nodes in the deployment.
Individual nodes reject an inference request if the inference queue is full.
The queue size is controlled by the `queue_capacity` setting in the start
trained model deployment API. + /// + /// The sum of rejected_execution_count for all nodes in the deployment. + /// Individual nodes reject an inference request if the inference queue is full. + /// The queue size is controlled by the queue_capacity setting in the start + /// trained model deployment API. + /// /// [JsonInclude, JsonPropertyName("rejected_execution_count")] public int RejectedExecutionCount { get; init; } /// - /// The epoch timestamp when the deployment started. + /// + /// The epoch timestamp when the deployment started. + /// /// [JsonInclude, JsonPropertyName("start_time")] public long StartTime { get; init; } /// - /// The overall state of the deployment. + /// + /// The overall state of the deployment. + /// /// [JsonInclude, JsonPropertyName("state")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DeploymentState State { get; init; } /// - /// The number of threads used be each allocation during inference. + /// + /// The number of threads used be each allocation during inference. + /// /// [JsonInclude, JsonPropertyName("threads_per_allocation")] public int ThreadsPerAllocation { get; init; } /// - /// The sum of `timeout_count` for all nodes in the deployment. + /// + /// The sum of timeout_count for all nodes in the deployment. + /// /// [JsonInclude, JsonPropertyName("timeout_count")] public int TimeoutCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelInferenceStats.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelInferenceStats.g.cs index 76c173b47b1..44c6dc55125 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelInferenceStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelInferenceStats.g.cs @@ -30,31 +30,45 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class TrainedModelInferenceStats { /// - /// The number of times the model was loaded for inference and was not retrieved from the cache.
If this number is close to the `inference_count`, the cache is not being appropriately used.
This can be solved by increasing the cache size or its time-to-live (TTL).
Refer to general machine learning settings for the appropriate settings. + /// + /// The number of times the model was loaded for inference and was not retrieved from the cache. + /// If this number is close to the inference_count, the cache is not being appropriately used. + /// This can be solved by increasing the cache size or its time-to-live (TTL). + /// Refer to general machine learning settings for the appropriate settings. + /// /// [JsonInclude, JsonPropertyName("cache_miss_count")] public int CacheMissCount { get; init; } /// - /// The number of failures when using the model for inference. + /// + /// The number of failures when using the model for inference. + /// /// [JsonInclude, JsonPropertyName("failure_count")] public int FailureCount { get; init; } /// - /// The total number of times the model has been called for inference.
This is across all inference contexts, including all pipelines. + /// + /// The total number of times the model has been called for inference. + /// This is across all inference contexts, including all pipelines. + /// /// [JsonInclude, JsonPropertyName("inference_count")] public int InferenceCount { get; init; } /// - /// The number of inference calls where all the training features for the model were missing. + /// + /// The number of inference calls where all the training features for the model were missing. + /// /// [JsonInclude, JsonPropertyName("missing_all_fields_count")] public int MissingAllFieldsCount { get; init; } /// - /// The time when the statistics were last updated. + /// + /// The time when the statistics were last updated. + /// /// [JsonInclude, JsonPropertyName("timestamp")] public long Timestamp { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelPrefixStrings.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelPrefixStrings.g.cs index 135f29d34df..e22990b6db9 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelPrefixStrings.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelPrefixStrings.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class TrainedModelPrefixStrings { /// - /// String prepended to input at ingest + /// + /// String prepended to input at ingest + /// /// [JsonInclude, JsonPropertyName("ingest")] public string? Ingest { get; set; } /// - /// String prepended to input at search + /// + /// String prepended to input at search + /// /// [JsonInclude, JsonPropertyName("search")] public string? Search { get; set; } @@ -54,7 +58,9 @@ public TrainedModelPrefixStringsDescriptor() : base() private string? SearchValue { get; set; } /// - /// String prepended to input at ingest + /// + /// String prepended to input at ingest + /// /// public TrainedModelPrefixStringsDescriptor Ingest(string? ingest) { @@ -63,7 +69,9 @@ public TrainedModelPrefixStringsDescriptor Ingest(string? ingest) } /// - /// String prepended to input at search + /// + /// String prepended to input at search + /// /// public TrainedModelPrefixStringsDescriptor Search(string? search) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelSizeStats.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelSizeStats.g.cs index e98b842846d..92944af967e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelSizeStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelSizeStats.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class TrainedModelSizeStats { /// - /// The size of the model in bytes. + /// + /// The size of the model in bytes. + /// /// [JsonInclude, JsonPropertyName("model_size_bytes")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize ModelSizeBytes { get; init; } /// - /// The amount of memory required to load the model in bytes. + /// + /// The amount of memory required to load the model in bytes. + /// /// [JsonInclude, JsonPropertyName("required_native_memory_bytes")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize RequiredNativeMemoryBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelStats.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelStats.g.cs index fdf18124614..67f582ae281 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelStats.g.cs @@ -30,37 +30,51 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class TrainedModelStats { /// - /// A collection of deployment stats, which is present when the models are deployed. + /// + /// A collection of deployment stats, which is present when the models are deployed. + /// /// [JsonInclude, JsonPropertyName("deployment_stats")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainedModelDeploymentStats? DeploymentStats { get; init; } /// - /// A collection of inference stats fields. + /// + /// A collection of inference stats fields. + /// /// [JsonInclude, JsonPropertyName("inference_stats")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainedModelInferenceStats? InferenceStats { get; init; } /// - /// A collection of ingest stats for the model across all nodes.
The values are summations of the individual node statistics.
The format matches the ingest section in the nodes stats API. + /// + /// A collection of ingest stats for the model across all nodes. + /// The values are summations of the individual node statistics. + /// The format matches the ingest section in the nodes stats API. + /// /// [JsonInclude, JsonPropertyName("ingest")] public IReadOnlyDictionary? Ingest { get; init; } /// - /// The unique identifier of the trained model. + /// + /// The unique identifier of the trained model. + /// /// [JsonInclude, JsonPropertyName("model_id")] public string ModelId { get; init; } /// - /// A collection of model size stats. + /// + /// A collection of model size stats. + /// /// [JsonInclude, JsonPropertyName("model_size_stats")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainedModelSizeStats ModelSizeStats { get; init; } /// - /// The number of ingest pipelines that currently refer to the model. + /// + /// The number of ingest pipelines that currently refer to the model. + /// /// [JsonInclude, JsonPropertyName("pipeline_count")] public int PipelineCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TransformAuthorization.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TransformAuthorization.g.cs index 878f6d0fcb0..260632bff6a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TransformAuthorization.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TransformAuthorization.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class TransformAuthorization { /// - /// If an API key was used for the most recent update to the transform, its name and identifier are listed in the response. + /// + /// If an API key was used for the most recent update to the transform, its name and identifier are listed in the response. + /// /// [JsonInclude, JsonPropertyName("api_key")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ApiKeyAuthorization? ApiKey { get; init; } /// - /// If a user ID was used for the most recent update to the transform, its roles at the time of the update are listed in the response. + /// + /// If a user ID was used for the most recent update to the transform, its roles at the time of the update are listed in the response. + /// /// [JsonInclude, JsonPropertyName("roles")] public IReadOnlyCollection? Roles { get; init; } /// - /// If a service account was used for the most recent update to the transform, the account name is listed in the response. + /// + /// If a service account was used for the most recent update to the transform, the account name is listed in the response. + /// /// [JsonInclude, JsonPropertyName("service_account")] public string? ServiceAccount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ZeroShotClassificationInferenceOptions.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ZeroShotClassificationInferenceOptions.g.cs index 93fc1a8e434..a53eb4c43a2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ZeroShotClassificationInferenceOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ZeroShotClassificationInferenceOptions.g.cs @@ -28,42 +28,57 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; /// -/// Zero shot classification configuration options +/// +/// Zero shot classification configuration options +/// /// public sealed partial class ZeroShotClassificationInferenceOptions { /// - /// The zero shot classification labels indicating entailment, neutral, and contradiction
Must contain exactly and only entailment, neutral, and contradiction + /// + /// The zero shot classification labels indicating entailment, neutral, and contradiction + /// Must contain exactly and only entailment, neutral, and contradiction + /// /// [JsonInclude, JsonPropertyName("classification_labels")] public ICollection ClassificationLabels { get; set; } /// - /// Hypothesis template used when tokenizing labels for prediction + /// + /// Hypothesis template used when tokenizing labels for prediction + /// /// [JsonInclude, JsonPropertyName("hypothesis_template")] public string? HypothesisTemplate { get; set; } /// - /// The labels to predict. + /// + /// The labels to predict. + /// /// [JsonInclude, JsonPropertyName("labels")] public ICollection? Labels { get; set; } /// - /// Indicates if more than one true label exists. + /// + /// Indicates if more than one true label exists. + /// /// [JsonInclude, JsonPropertyName("multi_label")] public bool? MultiLabel { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationConfig? Tokenization { get; set; } @@ -72,7 +87,9 @@ public sealed partial class ZeroShotClassificationInferenceOptions } /// -/// Zero shot classification configuration options +/// +/// Zero shot classification configuration options +/// /// public sealed partial class ZeroShotClassificationInferenceOptionsDescriptor : SerializableDescriptor { @@ -92,7 +109,10 @@ public ZeroShotClassificationInferenceOptionsDescriptor() : base() private Action TokenizationDescriptorAction { get; set; } /// - /// The zero shot classification labels indicating entailment, neutral, and contradiction
Must contain exactly and only entailment, neutral, and contradiction + /// + /// The zero shot classification labels indicating entailment, neutral, and contradiction + /// Must contain exactly and only entailment, neutral, and contradiction + /// /// public ZeroShotClassificationInferenceOptionsDescriptor ClassificationLabels(ICollection classificationLabels) { @@ -101,7 +121,9 @@ public ZeroShotClassificationInferenceOptionsDescriptor ClassificationLabels(ICo } /// - /// Hypothesis template used when tokenizing labels for prediction + /// + /// Hypothesis template used when tokenizing labels for prediction + /// /// public ZeroShotClassificationInferenceOptionsDescriptor HypothesisTemplate(string? hypothesisTemplate) { @@ -110,7 +132,9 @@ public ZeroShotClassificationInferenceOptionsDescriptor HypothesisTemplate(strin } /// - /// The labels to predict. + /// + /// The labels to predict. + /// /// public ZeroShotClassificationInferenceOptionsDescriptor Labels(ICollection? labels) { @@ -119,7 +143,9 @@ public ZeroShotClassificationInferenceOptionsDescriptor Labels(ICollection - /// Indicates if more than one true label exists. + /// + /// Indicates if more than one true label exists. + /// /// public ZeroShotClassificationInferenceOptionsDescriptor MultiLabel(bool? multiLabel = true) { @@ -128,7 +154,9 @@ public ZeroShotClassificationInferenceOptionsDescriptor MultiLabel(bool? multiLa } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public ZeroShotClassificationInferenceOptionsDescriptor ResultsField(string? resultsField) { @@ -137,7 +165,9 @@ public ZeroShotClassificationInferenceOptionsDescriptor ResultsField(string? res } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// public ZeroShotClassificationInferenceOptionsDescriptor Tokenization(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationConfig? tokenization) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ZeroShotClassificationInferenceUpdateOptions.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ZeroShotClassificationInferenceUpdateOptions.g.cs index bdbae85cd79..986afc982df 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ZeroShotClassificationInferenceUpdateOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ZeroShotClassificationInferenceUpdateOptions.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class ZeroShotClassificationInferenceUpdateOptions { /// - /// The labels to predict. + /// + /// The labels to predict. + /// /// [JsonInclude, JsonPropertyName("labels")] public ICollection Labels { get; set; } /// - /// Update the configured multi label option. Indicates if more than one true label exists. Defaults to the configured value. + /// + /// Update the configured multi label option. Indicates if more than one true label exists. Defaults to the configured value. + /// /// [JsonInclude, JsonPropertyName("multi_label")] public bool? MultiLabel { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.NlpTokenizationUpdateOptions? Tokenization { get; set; } @@ -72,7 +80,9 @@ public ZeroShotClassificationInferenceUpdateOptionsDescriptor() : base() private Action TokenizationDescriptorAction { get; set; } /// - /// The labels to predict. + /// + /// The labels to predict. + /// /// public ZeroShotClassificationInferenceUpdateOptionsDescriptor Labels(ICollection labels) { @@ -81,7 +91,9 @@ public ZeroShotClassificationInferenceUpdateOptionsDescriptor Labels(ICollection } /// - /// Update the configured multi label option. Indicates if more than one true label exists. Defaults to the configured value. + /// + /// Update the configured multi label option. Indicates if more than one true label exists. Defaults to the configured value. + /// /// public ZeroShotClassificationInferenceUpdateOptionsDescriptor MultiLabel(bool? multiLabel = true) { @@ -90,7 +102,9 @@ public ZeroShotClassificationInferenceUpdateOptionsDescriptor MultiLabel(bool? m } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public ZeroShotClassificationInferenceUpdateOptionsDescriptor ResultsField(string? resultsField) { @@ -99,7 +113,9 @@ public ZeroShotClassificationInferenceUpdateOptionsDescriptor ResultsField(strin } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// public ZeroShotClassificationInferenceUpdateOptionsDescriptor Tokenization(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.NlpTokenizationUpdateOptions? tokenization) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/AggregateMetricDoubleProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/AggregateMetricDoubleProperty.g.cs index f0b73cdae5b..f098aeb90b0 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/AggregateMetricDoubleProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/AggregateMetricDoubleProperty.g.cs @@ -39,7 +39,9 @@ public sealed partial class AggregateMetricDoubleProperty : IProperty public int? IgnoreAbove { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -110,7 +112,9 @@ public AggregateMetricDoublePropertyDescriptor IgnoreAbove(int? ignor } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public AggregateMetricDoublePropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -267,7 +271,9 @@ public AggregateMetricDoublePropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public AggregateMetricDoublePropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/BinaryProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/BinaryProperty.g.cs index 091b905814b..c3ded8fb693 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/BinaryProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/BinaryProperty.g.cs @@ -42,7 +42,9 @@ public sealed partial class BinaryProperty : IProperty public int? IgnoreAbove { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -120,7 +122,9 @@ public BinaryPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public BinaryPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -299,7 +303,9 @@ public BinaryPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public BinaryPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/BooleanProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/BooleanProperty.g.cs index d495e04aef1..42b917d1202 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/BooleanProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/BooleanProperty.g.cs @@ -48,7 +48,9 @@ public sealed partial class BooleanProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -170,7 +172,9 @@ public BooleanPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public BooleanPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -459,7 +463,9 @@ public BooleanPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public BooleanPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/ByteNumberProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/ByteNumberProperty.g.cs index dd3bfc1bb69..2b022d8ef2a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/ByteNumberProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/ByteNumberProperty.g.cs @@ -50,7 +50,9 @@ public sealed partial class ByteNumberProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -167,7 +169,9 @@ public ByteNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public ByteNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -498,7 +502,9 @@ public ByteNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public ByteNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/CompletionProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/CompletionProperty.g.cs index b2e90a7c21e..b18a51c7c77 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/CompletionProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/CompletionProperty.g.cs @@ -48,7 +48,9 @@ public sealed partial class CompletionProperty : IProperty public int? MaxInputLength { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -189,7 +191,9 @@ public CompletionPropertyDescriptor MaxInputLength(int? maxInputLengt } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public CompletionPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -534,7 +538,9 @@ public CompletionPropertyDescriptor MaxInputLength(int? maxInputLength) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public CompletionPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/ConstantKeywordProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/ConstantKeywordProperty.g.cs index 928dd6730db..aef2cc64a1a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/ConstantKeywordProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/ConstantKeywordProperty.g.cs @@ -37,7 +37,9 @@ public sealed partial class ConstantKeywordProperty : IProperty public int? IgnoreAbove { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -99,7 +101,9 @@ public ConstantKeywordPropertyDescriptor IgnoreAbove(int? ignoreAbove } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public ConstantKeywordPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -236,7 +240,9 @@ public ConstantKeywordPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public ConstantKeywordPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/DateNanosProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/DateNanosProperty.g.cs index 33c02d5c08f..c41e1563ea2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/DateNanosProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/DateNanosProperty.g.cs @@ -50,7 +50,9 @@ public sealed partial class DateNanosProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -162,7 +164,9 @@ public DateNanosPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public DateNanosPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -425,7 +429,9 @@ public DateNanosPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public DateNanosPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/DateProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/DateProperty.g.cs index a656dfab13a..b4be3a3b9f3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/DateProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/DateProperty.g.cs @@ -54,7 +54,9 @@ public sealed partial class DateProperty : IProperty public string? Locale { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -200,7 +202,9 @@ public DatePropertyDescriptor Locale(string? locale) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public DatePropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -545,7 +549,9 @@ public DatePropertyDescriptor Locale(string? locale) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public DatePropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/DateRangeProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/DateRangeProperty.g.cs index f4962b51522..9e925a17f2d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/DateRangeProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/DateRangeProperty.g.cs @@ -50,7 +50,9 @@ public sealed partial class DateRangeProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -156,7 +158,9 @@ public DateRangePropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public DateRangePropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -391,7 +395,9 @@ public DateRangePropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public DateRangePropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/DenseVectorProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/DenseVectorProperty.g.cs index 154282abce0..489ed9e9c6e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/DenseVectorProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/DenseVectorProperty.g.cs @@ -45,7 +45,9 @@ public sealed partial class DenseVectorProperty : IProperty public Elastic.Clients.Elasticsearch.Serverless.Mapping.DenseVectorIndexOptions? IndexOptions { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -154,7 +156,9 @@ public DenseVectorPropertyDescriptor IndexOptions(Action - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public DenseVectorPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -401,7 +405,9 @@ public DenseVectorPropertyDescriptor IndexOptions(Action - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public DenseVectorPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/DoubleNumberProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/DoubleNumberProperty.g.cs index a5795bfabec..25673dcc15e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/DoubleNumberProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/DoubleNumberProperty.g.cs @@ -50,7 +50,9 @@ public sealed partial class DoubleNumberProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -167,7 +169,9 @@ public DoubleNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public DoubleNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -498,7 +502,9 @@ public DoubleNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public DoubleNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/DoubleRangeProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/DoubleRangeProperty.g.cs index 43547a103e1..3ec6b12c63a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/DoubleRangeProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/DoubleRangeProperty.g.cs @@ -48,7 +48,9 @@ public sealed partial class DoubleRangeProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -147,7 +149,9 @@ public DoubleRangePropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public DoubleRangePropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -368,7 +372,9 @@ public DoubleRangePropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public DoubleRangePropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/DynamicProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/DynamicProperty.g.cs index b6fa6fe83da..6f9590a910e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/DynamicProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/DynamicProperty.g.cs @@ -66,7 +66,9 @@ public sealed partial class DynamicProperty : IProperty public string? Locale { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -280,7 +282,9 @@ public DynamicPropertyDescriptor Locale(string? locale) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public DynamicPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -875,7 +879,9 @@ public DynamicPropertyDescriptor Locale(string? locale) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public DynamicPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/FieldAliasProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/FieldAliasProperty.g.cs index 49c48afdc5b..13f46a7202b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/FieldAliasProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/FieldAliasProperty.g.cs @@ -37,7 +37,9 @@ public sealed partial class FieldAliasProperty : IProperty public int? IgnoreAbove { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -98,7 +100,9 @@ public FieldAliasPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public FieldAliasPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -247,7 +251,9 @@ public FieldAliasPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public FieldAliasPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/FlattenedProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/FlattenedProperty.g.cs index c25d5999ad5..4b889d7ed35 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/FlattenedProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/FlattenedProperty.g.cs @@ -49,7 +49,9 @@ public sealed partial class FlattenedProperty : IProperty public Elastic.Clients.Elasticsearch.Serverless.Mapping.IndexOptions? IndexOptions { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -158,7 +160,9 @@ public FlattenedPropertyDescriptor IndexOptions(Elastic.Clients.Elast } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public FlattenedPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -407,7 +411,9 @@ public FlattenedPropertyDescriptor IndexOptions(Elastic.Clients.Elasticsearch.Se } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public FlattenedPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/FloatNumberProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/FloatNumberProperty.g.cs index d97b66a8771..680f6acc55b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/FloatNumberProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/FloatNumberProperty.g.cs @@ -50,7 +50,9 @@ public sealed partial class FloatNumberProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -167,7 +169,9 @@ public FloatNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public FloatNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -498,7 +502,9 @@ public FloatNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public FloatNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/FloatRangeProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/FloatRangeProperty.g.cs index b44f492c902..c0704dca33e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/FloatRangeProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/FloatRangeProperty.g.cs @@ -48,7 +48,9 @@ public sealed partial class FloatRangeProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -147,7 +149,9 @@ public FloatRangePropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public FloatRangePropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -368,7 +372,9 @@ public FloatRangePropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public FloatRangePropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/GeoPointProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/GeoPointProperty.g.cs index 69b6673ac80..a6d8d7b4204 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/GeoPointProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/GeoPointProperty.g.cs @@ -48,7 +48,9 @@ public sealed partial class GeoPointProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -158,7 +160,9 @@ public GeoPointPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public GeoPointPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -475,7 +479,9 @@ public GeoPointPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public GeoPointPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/GeoShapeProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/GeoShapeProperty.g.cs index 4cd995afcc9..3d1abb7614f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/GeoShapeProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/GeoShapeProperty.g.cs @@ -28,7 +28,10 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Mapping; /// -/// The `geo_shape` data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles
and polygons. +/// +/// The geo_shape data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles +/// and polygons. +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class GeoShapeProperty : IProperty @@ -52,7 +55,9 @@ public sealed partial class GeoShapeProperty : IProperty public bool? IgnoreZValue { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -72,7 +77,10 @@ public sealed partial class GeoShapeProperty : IProperty } /// -/// The `geo_shape` data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles
and polygons. +/// +/// The geo_shape data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles +/// and polygons. +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class GeoShapePropertyDescriptor : SerializableDescriptor>, IBuildableDescriptor @@ -161,7 +169,9 @@ public GeoShapePropertyDescriptor IgnoreZValue(bool? ignoreZValue = t } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public GeoShapePropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -325,7 +335,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// The `geo_shape` data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles
and polygons. +/// +/// The geo_shape data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles +/// and polygons. +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class GeoShapePropertyDescriptor : SerializableDescriptor, IBuildableDescriptor @@ -414,7 +427,9 @@ public GeoShapePropertyDescriptor IgnoreZValue(bool? ignoreZValue = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public GeoShapePropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/HalfFloatNumberProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/HalfFloatNumberProperty.g.cs index d2c643c0d44..5e0dc9da951 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/HalfFloatNumberProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/HalfFloatNumberProperty.g.cs @@ -50,7 +50,9 @@ public sealed partial class HalfFloatNumberProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -167,7 +169,9 @@ public HalfFloatNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public HalfFloatNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -498,7 +502,9 @@ public HalfFloatNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public HalfFloatNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/HistogramProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/HistogramProperty.g.cs index 4aa89bed37d..7a4ee2601c0 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/HistogramProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/HistogramProperty.g.cs @@ -39,7 +39,9 @@ public sealed partial class HistogramProperty : IProperty public bool? IgnoreMalformed { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -104,7 +106,9 @@ public HistogramPropertyDescriptor IgnoreMalformed(bool? ignoreMalfor } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public HistogramPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -241,7 +245,9 @@ public HistogramPropertyDescriptor IgnoreMalformed(bool? ignoreMalformed = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public HistogramPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/IcuCollationProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/IcuCollationProperty.g.cs index 0daa9737013..48bcd984bae 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/IcuCollationProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/IcuCollationProperty.g.cs @@ -54,7 +54,9 @@ public sealed partial class IcuCollationProperty : IProperty public int? IgnoreAbove { get; set; } /// - /// Should the field be searchable? + /// + /// Should the field be searchable? + /// /// [JsonInclude, JsonPropertyName("index")] public bool? Index { get; set; } @@ -64,7 +66,9 @@ public sealed partial class IcuCollationProperty : IProperty public string? Language { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -72,7 +76,9 @@ public sealed partial class IcuCollationProperty : IProperty public bool? Norms { get; set; } /// - /// Accepts a string value which is substituted for any explicit null values. Defaults to null, which means the field is treated as missing. + /// + /// Accepts a string value which is substituted for any explicit null values. Defaults to null, which means the field is treated as missing. + /// /// [JsonInclude, JsonPropertyName("null_value")] public string? NullValue { get; set; } @@ -213,7 +219,9 @@ public IcuCollationPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Should the field be searchable? + /// + /// Should the field be searchable? + /// /// public IcuCollationPropertyDescriptor Index(bool? index = true) { @@ -234,7 +242,9 @@ public IcuCollationPropertyDescriptor Language(string? language) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public IcuCollationPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -249,7 +259,9 @@ public IcuCollationPropertyDescriptor Norms(bool? norms = true) } /// - /// Accepts a string value which is substituted for any explicit null values. Defaults to null, which means the field is treated as missing. + /// + /// Accepts a string value which is substituted for any explicit null values. Defaults to null, which means the field is treated as missing. + /// /// public IcuCollationPropertyDescriptor NullValue(string? nullValue) { @@ -622,7 +634,9 @@ public IcuCollationPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Should the field be searchable? + /// + /// Should the field be searchable? + /// /// public IcuCollationPropertyDescriptor Index(bool? index = true) { @@ -643,7 +657,9 @@ public IcuCollationPropertyDescriptor Language(string? language) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public IcuCollationPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -658,7 +674,9 @@ public IcuCollationPropertyDescriptor Norms(bool? norms = true) } /// - /// Accepts a string value which is substituted for any explicit null values. Defaults to null, which means the field is treated as missing. + /// + /// Accepts a string value which is substituted for any explicit null values. Defaults to null, which means the field is treated as missing. + /// /// public IcuCollationPropertyDescriptor NullValue(string? nullValue) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/IntegerNumberProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/IntegerNumberProperty.g.cs index 58badb3ef94..079db51b6fd 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/IntegerNumberProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/IntegerNumberProperty.g.cs @@ -50,7 +50,9 @@ public sealed partial class IntegerNumberProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -167,7 +169,9 @@ public IntegerNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public IntegerNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -498,7 +502,9 @@ public IntegerNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public IntegerNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/IntegerRangeProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/IntegerRangeProperty.g.cs index 1a8bed24b43..7feab5fc2ae 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/IntegerRangeProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/IntegerRangeProperty.g.cs @@ -48,7 +48,9 @@ public sealed partial class IntegerRangeProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -147,7 +149,9 @@ public IntegerRangePropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public IntegerRangePropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -368,7 +372,9 @@ public IntegerRangePropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public IntegerRangePropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/IpProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/IpProperty.g.cs index 3aff1e512f7..501b11fdad2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/IpProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/IpProperty.g.cs @@ -48,7 +48,9 @@ public sealed partial class IpProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -158,7 +160,9 @@ public IpPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public IpPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -475,7 +479,9 @@ public IpPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public IpPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/IpRangeProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/IpRangeProperty.g.cs index 37bb9fba63d..37734d18a1b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/IpRangeProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/IpRangeProperty.g.cs @@ -48,7 +48,9 @@ public sealed partial class IpRangeProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -147,7 +149,9 @@ public IpRangePropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public IpRangePropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -368,7 +372,9 @@ public IpRangePropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public IpRangePropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/JoinProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/JoinProperty.g.cs index 5546819ff19..55736e7eda3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/JoinProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/JoinProperty.g.cs @@ -39,7 +39,9 @@ public sealed partial class JoinProperty : IProperty public int? IgnoreAbove { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -107,7 +109,9 @@ public JoinPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public JoinPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -258,7 +262,9 @@ public JoinPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public JoinPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/KeywordProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/KeywordProperty.g.cs index d88b2d44a09..2d120c42c28 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/KeywordProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/KeywordProperty.g.cs @@ -50,7 +50,9 @@ public sealed partial class KeywordProperty : IProperty public Elastic.Clients.Elasticsearch.Serverless.Mapping.IndexOptions? IndexOptions { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -176,7 +178,9 @@ public KeywordPropertyDescriptor IndexOptions(Elastic.Clients.Elastic } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public KeywordPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -549,7 +553,9 @@ public KeywordPropertyDescriptor IndexOptions(Elastic.Clients.Elasticsearch.Serv } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public KeywordPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/LongNumberProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/LongNumberProperty.g.cs index a4cde2ed5c8..b7ed199faa9 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/LongNumberProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/LongNumberProperty.g.cs @@ -50,7 +50,9 @@ public sealed partial class LongNumberProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -167,7 +169,9 @@ public LongNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public LongNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -498,7 +502,9 @@ public LongNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public LongNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/LongRangeProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/LongRangeProperty.g.cs index fd6273d2097..61a912b6f23 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/LongRangeProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/LongRangeProperty.g.cs @@ -48,7 +48,9 @@ public sealed partial class LongRangeProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -147,7 +149,9 @@ public LongRangePropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public LongRangePropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -368,7 +372,9 @@ public LongRangePropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public LongRangePropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/MatchOnlyTextProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/MatchOnlyTextProperty.g.cs index 655261d6db3..25409117667 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/MatchOnlyTextProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/MatchOnlyTextProperty.g.cs @@ -28,25 +28,39 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Mapping; /// -/// A variant of text that trades scoring and efficiency of positional queries for space efficiency. This field
effectively stores data the same way as a text field that only indexes documents (index_options: docs) and
disables norms (norms: false). Term queries perform as fast if not faster as on text fields, however queries
that need positions such as the match_phrase query perform slower as they need to look at the _source document
to verify whether a phrase matches. All queries return constant scores that are equal to 1.0. +/// +/// A variant of text that trades scoring and efficiency of positional queries for space efficiency. This field +/// effectively stores data the same way as a text field that only indexes documents (index_options: docs) and +/// disables norms (norms: false). Term queries perform as fast if not faster as on text fields, however queries +/// that need positions such as the match_phrase query perform slower as they need to look at the _source document +/// to verify whether a phrase matches. All queries return constant scores that are equal to 1.0. +/// /// public sealed partial class MatchOnlyTextProperty : IProperty { /// - /// Allows you to copy the values of multiple fields into a group
field, which can then be queried as a single field. + /// + /// Allows you to copy the values of multiple fields into a group + /// field, which can then be queried as a single field. + /// /// [JsonInclude, JsonPropertyName("copy_to")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] public Elastic.Clients.Elasticsearch.Serverless.Fields? CopyTo { get; set; } /// - /// Multi-fields allow the same string value to be indexed in multiple ways for different purposes, such as one
field for search and a multi-field for sorting and aggregations, or the same string value analyzed by different analyzers. + /// + /// Multi-fields allow the same string value to be indexed in multiple ways for different purposes, such as one + /// field for search and a multi-field for sorting and aggregations, or the same string value analyzed by different analyzers. + /// /// [JsonInclude, JsonPropertyName("fields")] public Elastic.Clients.Elasticsearch.Serverless.Mapping.Properties? Fields { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -56,7 +70,13 @@ public sealed partial class MatchOnlyTextProperty : IProperty } /// -/// A variant of text that trades scoring and efficiency of positional queries for space efficiency. This field
effectively stores data the same way as a text field that only indexes documents (index_options: docs) and
disables norms (norms: false). Term queries perform as fast if not faster as on text fields, however queries
that need positions such as the match_phrase query perform slower as they need to look at the _source document
to verify whether a phrase matches. All queries return constant scores that are equal to 1.0. +/// +/// A variant of text that trades scoring and efficiency of positional queries for space efficiency. This field +/// effectively stores data the same way as a text field that only indexes documents (index_options: docs) and +/// disables norms (norms: false). Term queries perform as fast if not faster as on text fields, however queries +/// that need positions such as the match_phrase query perform slower as they need to look at the _source document +/// to verify whether a phrase matches. All queries return constant scores that are equal to 1.0. +/// /// public sealed partial class MatchOnlyTextPropertyDescriptor : SerializableDescriptor>, IBuildableDescriptor { @@ -71,7 +91,10 @@ public MatchOnlyTextPropertyDescriptor() : base() private IDictionary? MetaValue { get; set; } /// - /// Allows you to copy the values of multiple fields into a group
field, which can then be queried as a single field. + /// + /// Allows you to copy the values of multiple fields into a group + /// field, which can then be queried as a single field. + /// /// public MatchOnlyTextPropertyDescriptor CopyTo(Elastic.Clients.Elasticsearch.Serverless.Fields? copyTo) { @@ -80,7 +103,10 @@ public MatchOnlyTextPropertyDescriptor CopyTo(Elastic.Clients.Elastic } /// - /// Multi-fields allow the same string value to be indexed in multiple ways for different purposes, such as one
field for search and a multi-field for sorting and aggregations, or the same string value analyzed by different analyzers. + /// + /// Multi-fields allow the same string value to be indexed in multiple ways for different purposes, such as one + /// field for search and a multi-field for sorting and aggregations, or the same string value analyzed by different analyzers. + /// /// public MatchOnlyTextPropertyDescriptor Fields(Elastic.Clients.Elasticsearch.Serverless.Mapping.Properties? fields) { @@ -103,7 +129,9 @@ public MatchOnlyTextPropertyDescriptor Fields(Action - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public MatchOnlyTextPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -146,7 +174,13 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// A variant of text that trades scoring and efficiency of positional queries for space efficiency. This field
effectively stores data the same way as a text field that only indexes documents (index_options: docs) and
disables norms (norms: false). Term queries perform as fast if not faster as on text fields, however queries
that need positions such as the match_phrase query perform slower as they need to look at the _source document
to verify whether a phrase matches. All queries return constant scores that are equal to 1.0. +/// +/// A variant of text that trades scoring and efficiency of positional queries for space efficiency. This field +/// effectively stores data the same way as a text field that only indexes documents (index_options: docs) and +/// disables norms (norms: false). Term queries perform as fast if not faster as on text fields, however queries +/// that need positions such as the match_phrase query perform slower as they need to look at the _source document +/// to verify whether a phrase matches. All queries return constant scores that are equal to 1.0. +/// /// public sealed partial class MatchOnlyTextPropertyDescriptor : SerializableDescriptor, IBuildableDescriptor { @@ -161,7 +195,10 @@ public MatchOnlyTextPropertyDescriptor() : base() private IDictionary? MetaValue { get; set; } /// - /// Allows you to copy the values of multiple fields into a group
field, which can then be queried as a single field. + /// + /// Allows you to copy the values of multiple fields into a group + /// field, which can then be queried as a single field. + /// /// public MatchOnlyTextPropertyDescriptor CopyTo(Elastic.Clients.Elasticsearch.Serverless.Fields? copyTo) { @@ -170,7 +207,10 @@ public MatchOnlyTextPropertyDescriptor CopyTo(Elastic.Clients.Elasticsearch.Serv } /// - /// Multi-fields allow the same string value to be indexed in multiple ways for different purposes, such as one
field for search and a multi-field for sorting and aggregations, or the same string value analyzed by different analyzers. + /// + /// Multi-fields allow the same string value to be indexed in multiple ways for different purposes, such as one + /// field for search and a multi-field for sorting and aggregations, or the same string value analyzed by different analyzers. + /// /// public MatchOnlyTextPropertyDescriptor Fields(Elastic.Clients.Elasticsearch.Serverless.Mapping.Properties? fields) { @@ -193,7 +233,9 @@ public MatchOnlyTextPropertyDescriptor Fields(Action - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public MatchOnlyTextPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/Murmur3HashProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/Murmur3HashProperty.g.cs index 0a03e6e2d8a..2a758afb402 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/Murmur3HashProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/Murmur3HashProperty.g.cs @@ -42,7 +42,9 @@ public sealed partial class Murmur3HashProperty : IProperty public int? IgnoreAbove { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -120,7 +122,9 @@ public Murmur3HashPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public Murmur3HashPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -299,7 +303,9 @@ public Murmur3HashPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public Murmur3HashPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/NestedProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/NestedProperty.g.cs index f41649bf449..5aae740e1a6 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/NestedProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/NestedProperty.g.cs @@ -46,7 +46,9 @@ public sealed partial class NestedProperty : IProperty public bool? IncludeInRoot { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -138,7 +140,9 @@ public NestedPropertyDescriptor IncludeInRoot(bool? includeInRoot = t } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public NestedPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -345,7 +349,9 @@ public NestedPropertyDescriptor IncludeInRoot(bool? includeInRoot = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public NestedPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/ObjectProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/ObjectProperty.g.cs index c0e6da2811d..c30fddec9ca 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/ObjectProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/ObjectProperty.g.cs @@ -42,7 +42,9 @@ public sealed partial class ObjectProperty : IProperty public int? IgnoreAbove { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -123,7 +125,9 @@ public ObjectPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public ObjectPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -316,7 +320,9 @@ public ObjectPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public ObjectPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/PercolatorProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/PercolatorProperty.g.cs index d7416478be9..444ced0fdfd 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/PercolatorProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/PercolatorProperty.g.cs @@ -37,7 +37,9 @@ public sealed partial class PercolatorProperty : IProperty public int? IgnoreAbove { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -95,7 +97,9 @@ public PercolatorPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public PercolatorPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -218,7 +222,9 @@ public PercolatorPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public PercolatorPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/PointProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/PointProperty.g.cs index 9180209d5d1..d003988130f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/PointProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/PointProperty.g.cs @@ -46,7 +46,9 @@ public sealed partial class PointProperty : IProperty public bool? IgnoreZValue { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -141,7 +143,9 @@ public PointPropertyDescriptor IgnoreZValue(bool? ignoreZValue = true } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public PointPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -362,7 +366,9 @@ public PointPropertyDescriptor IgnoreZValue(bool? ignoreZValue = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public PointPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/RankFeatureProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/RankFeatureProperty.g.cs index 8484b6171be..4e13126ae90 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/RankFeatureProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/RankFeatureProperty.g.cs @@ -37,7 +37,9 @@ public sealed partial class RankFeatureProperty : IProperty public int? IgnoreAbove { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -98,7 +100,9 @@ public RankFeaturePropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public RankFeaturePropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -235,7 +239,9 @@ public RankFeaturePropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public RankFeaturePropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/RankFeaturesProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/RankFeaturesProperty.g.cs index 4be4fd1d41f..55b90f3c44c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/RankFeaturesProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/RankFeaturesProperty.g.cs @@ -37,7 +37,9 @@ public sealed partial class RankFeaturesProperty : IProperty public int? IgnoreAbove { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -98,7 +100,9 @@ public RankFeaturesPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public RankFeaturesPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -235,7 +239,9 @@ public RankFeaturesPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public RankFeaturesPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/RuntimeField.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/RuntimeField.g.cs index f84ef9258c8..40bf8fe428a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/RuntimeField.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/RuntimeField.g.cs @@ -30,43 +30,57 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Mapping; public sealed partial class RuntimeField { /// - /// For type `lookup` + /// + /// For type lookup + /// /// [JsonInclude, JsonPropertyName("fetch_fields")] public ICollection? FetchFields { get; set; } /// - /// A custom format for `date` type runtime fields. + /// + /// A custom format for date type runtime fields. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// For type `lookup` + /// + /// For type lookup + /// /// [JsonInclude, JsonPropertyName("input_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? InputField { get; set; } /// - /// Painless script executed at query time. + /// + /// Painless script executed at query time. + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Serverless.Script? Script { get; set; } /// - /// For type `lookup` + /// + /// For type lookup + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? TargetField { get; set; } /// - /// For type `lookup` + /// + /// For type lookup + /// /// [JsonInclude, JsonPropertyName("target_index")] public Elastic.Clients.Elasticsearch.Serverless.IndexName? TargetIndex { get; set; } /// - /// Field type, which can be: `boolean`, `composite`, `date`, `double`, `geo_point`, `ip`,`keyword`, `long`, or `lookup`. + /// + /// Field type, which can be: boolean, composite, date, double, geo_point, ip,keyword, long, or lookup. + /// /// [JsonInclude, JsonPropertyName("type")] public Elastic.Clients.Elasticsearch.Serverless.Mapping.RuntimeFieldType Type { get; set; } @@ -94,7 +108,9 @@ public RuntimeFieldDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Mapping.RuntimeFieldType TypeValue { get; set; } /// - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor FetchFields(ICollection? fetchFields) { @@ -133,7 +149,9 @@ public RuntimeFieldDescriptor FetchFields(params Action - /// A custom format for `date` type runtime fields. + /// + /// A custom format for date type runtime fields. + /// /// public RuntimeFieldDescriptor Format(string? format) { @@ -142,7 +160,9 @@ public RuntimeFieldDescriptor Format(string? format) } /// - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor InputField(Elastic.Clients.Elasticsearch.Serverless.Field? inputField) { @@ -151,7 +171,9 @@ public RuntimeFieldDescriptor InputField(Elastic.Clients.Elasticsearc } /// - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor InputField(Expression> inputField) { @@ -160,7 +182,9 @@ public RuntimeFieldDescriptor InputField(Expression - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor InputField(Expression> inputField) { @@ -169,7 +193,9 @@ public RuntimeFieldDescriptor InputField(Expression - /// Painless script executed at query time. + /// + /// Painless script executed at query time. + /// /// public RuntimeFieldDescriptor Script(Elastic.Clients.Elasticsearch.Serverless.Script? script) { @@ -196,7 +222,9 @@ public RuntimeFieldDescriptor Script(Action - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -205,7 +233,9 @@ public RuntimeFieldDescriptor TargetField(Elastic.Clients.Elasticsear } /// - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor TargetField(Expression> targetField) { @@ -214,7 +244,9 @@ public RuntimeFieldDescriptor TargetField(Expression - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor TargetField(Expression> targetField) { @@ -223,7 +255,9 @@ public RuntimeFieldDescriptor TargetField(Expression - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor TargetIndex(Elastic.Clients.Elasticsearch.Serverless.IndexName? targetIndex) { @@ -232,7 +266,9 @@ public RuntimeFieldDescriptor TargetIndex(Elastic.Clients.Elasticsear } /// - /// Field type, which can be: `boolean`, `composite`, `date`, `double`, `geo_point`, `ip`,`keyword`, `long`, or `lookup`. + /// + /// Field type, which can be: boolean, composite, date, double, geo_point, ip,keyword, long, or lookup. + /// /// public RuntimeFieldDescriptor Type(Elastic.Clients.Elasticsearch.Serverless.Mapping.RuntimeFieldType type) { @@ -342,7 +378,9 @@ public RuntimeFieldDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Mapping.RuntimeFieldType TypeValue { get; set; } /// - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor FetchFields(ICollection? fetchFields) { @@ -381,7 +419,9 @@ public RuntimeFieldDescriptor FetchFields(params Action - /// A custom format for `date` type runtime fields. + /// + /// A custom format for date type runtime fields. + /// /// public RuntimeFieldDescriptor Format(string? format) { @@ -390,7 +430,9 @@ public RuntimeFieldDescriptor Format(string? format) } /// - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor InputField(Elastic.Clients.Elasticsearch.Serverless.Field? inputField) { @@ -399,7 +441,9 @@ public RuntimeFieldDescriptor InputField(Elastic.Clients.Elasticsearch.Serverles } /// - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor InputField(Expression> inputField) { @@ -408,7 +452,9 @@ public RuntimeFieldDescriptor InputField(Expression - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor InputField(Expression> inputField) { @@ -417,7 +463,9 @@ public RuntimeFieldDescriptor InputField(Expression - /// Painless script executed at query time. + /// + /// Painless script executed at query time. + /// /// public RuntimeFieldDescriptor Script(Elastic.Clients.Elasticsearch.Serverless.Script? script) { @@ -444,7 +492,9 @@ public RuntimeFieldDescriptor Script(Action - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) { @@ -453,7 +503,9 @@ public RuntimeFieldDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverle } /// - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor TargetField(Expression> targetField) { @@ -462,7 +514,9 @@ public RuntimeFieldDescriptor TargetField(Expression - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor TargetField(Expression> targetField) { @@ -471,7 +525,9 @@ public RuntimeFieldDescriptor TargetField(Expression - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor TargetIndex(Elastic.Clients.Elasticsearch.Serverless.IndexName? targetIndex) { @@ -480,7 +536,9 @@ public RuntimeFieldDescriptor TargetIndex(Elastic.Clients.Elasticsearch.Serverle } /// - /// Field type, which can be: `boolean`, `composite`, `date`, `double`, `geo_point`, `ip`,`keyword`, `long`, or `lookup`. + /// + /// Field type, which can be: boolean, composite, date, double, geo_point, ip,keyword, long, or lookup. + /// /// public RuntimeFieldDescriptor Type(Elastic.Clients.Elasticsearch.Serverless.Mapping.RuntimeFieldType type) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/ScaledFloatNumberProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/ScaledFloatNumberProperty.g.cs index 43e47f7619f..343a9aaa7fd 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/ScaledFloatNumberProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/ScaledFloatNumberProperty.g.cs @@ -50,7 +50,9 @@ public sealed partial class ScaledFloatNumberProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -170,7 +172,9 @@ public ScaledFloatNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public ScaledFloatNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -515,7 +519,9 @@ public ScaledFloatNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public ScaledFloatNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/SearchAsYouTypeProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/SearchAsYouTypeProperty.g.cs index 5159255d910..ac3109d0e5a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/SearchAsYouTypeProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/SearchAsYouTypeProperty.g.cs @@ -48,7 +48,9 @@ public sealed partial class SearchAsYouTypeProperty : IProperty public int? MaxShingleSize { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -159,7 +161,9 @@ public SearchAsYouTypePropertyDescriptor MaxShingleSize(int? maxShing } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public SearchAsYouTypePropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -436,7 +440,9 @@ public SearchAsYouTypePropertyDescriptor MaxShingleSize(int? maxShingleSize) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public SearchAsYouTypePropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/ShapeProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/ShapeProperty.g.cs index e9b14cd5e2a..9472aa4b4ba 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/ShapeProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/ShapeProperty.g.cs @@ -28,7 +28,10 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Mapping; /// -/// The `shape` data type facilitates the indexing of and searching with arbitrary `x, y` cartesian shapes such as
rectangles and polygons. +/// +/// The shape data type facilitates the indexing of and searching with arbitrary x, y cartesian shapes such as +/// rectangles and polygons. +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class ShapeProperty : IProperty @@ -52,7 +55,9 @@ public sealed partial class ShapeProperty : IProperty public bool? IgnoreZValue { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -70,7 +75,10 @@ public sealed partial class ShapeProperty : IProperty } /// -/// The `shape` data type facilitates the indexing of and searching with arbitrary `x, y` cartesian shapes such as
rectangles and polygons. +/// +/// The shape data type facilitates the indexing of and searching with arbitrary x, y cartesian shapes such as +/// rectangles and polygons. +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class ShapePropertyDescriptor : SerializableDescriptor>, IBuildableDescriptor @@ -158,7 +166,9 @@ public ShapePropertyDescriptor IgnoreZValue(bool? ignoreZValue = true } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public ShapePropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -309,7 +319,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// The `shape` data type facilitates the indexing of and searching with arbitrary `x, y` cartesian shapes such as
rectangles and polygons. +/// +/// The shape data type facilitates the indexing of and searching with arbitrary x, y cartesian shapes such as +/// rectangles and polygons. +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class ShapePropertyDescriptor : SerializableDescriptor, IBuildableDescriptor @@ -397,7 +410,9 @@ public ShapePropertyDescriptor IgnoreZValue(bool? ignoreZValue = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public ShapePropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/ShortNumberProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/ShortNumberProperty.g.cs index 0bf79ea07cb..76f5dfc1708 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/ShortNumberProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/ShortNumberProperty.g.cs @@ -50,7 +50,9 @@ public sealed partial class ShortNumberProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -167,7 +169,9 @@ public ShortNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public ShortNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -498,7 +502,9 @@ public ShortNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public ShortNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/SparseVectorProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/SparseVectorProperty.g.cs index e87d19f4082..248ed867b51 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/SparseVectorProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/SparseVectorProperty.g.cs @@ -37,7 +37,9 @@ public sealed partial class SparseVectorProperty : IProperty public int? IgnoreAbove { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -95,7 +97,9 @@ public SparseVectorPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public SparseVectorPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -218,7 +222,9 @@ public SparseVectorPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public SparseVectorPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/TextProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/TextProperty.g.cs index 58ef2daed66..75c78c9a1b9 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/TextProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/TextProperty.g.cs @@ -58,7 +58,9 @@ public sealed partial class TextProperty : IProperty public Elastic.Clients.Elasticsearch.Serverless.Mapping.TextIndexPrefixes? IndexPrefixes { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -247,7 +249,9 @@ public TextPropertyDescriptor IndexPrefixes(Action - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public TextPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -716,7 +720,9 @@ public TextPropertyDescriptor IndexPrefixes(Action - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public TextPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/TokenCountProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/TokenCountProperty.g.cs index 3cd3073e5a5..623761ddf91 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/TokenCountProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/TokenCountProperty.g.cs @@ -50,7 +50,9 @@ public sealed partial class TokenCountProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -159,7 +161,9 @@ public TokenCountPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public TokenCountPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -408,7 +412,9 @@ public TokenCountPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public TokenCountPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/UnsignedLongNumberProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/UnsignedLongNumberProperty.g.cs index b89ef34b213..21a9e5c2730 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/UnsignedLongNumberProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/UnsignedLongNumberProperty.g.cs @@ -50,7 +50,9 @@ public sealed partial class UnsignedLongNumberProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -167,7 +169,9 @@ public UnsignedLongNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public UnsignedLongNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -498,7 +502,9 @@ public UnsignedLongNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public UnsignedLongNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/VersionProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/VersionProperty.g.cs index 9a17f9d0ada..0ff1efb3b93 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/VersionProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/VersionProperty.g.cs @@ -42,7 +42,9 @@ public sealed partial class VersionProperty : IProperty public int? IgnoreAbove { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -120,7 +122,9 @@ public VersionPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public VersionPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -299,7 +303,9 @@ public VersionPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public VersionPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/WildcardProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/WildcardProperty.g.cs index bd1e13c40ef..ebc72f971fa 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/WildcardProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/WildcardProperty.g.cs @@ -42,7 +42,9 @@ public sealed partial class WildcardProperty : IProperty public int? IgnoreAbove { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -123,7 +125,9 @@ public WildcardPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public WildcardPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -316,7 +320,9 @@ public WildcardPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public WildcardPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/NodeStatistics.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/NodeStatistics.g.cs index 8acd9469b2a..7801aab5bc2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/NodeStatistics.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/NodeStatistics.g.cs @@ -28,12 +28,16 @@ namespace Elastic.Clients.Elasticsearch.Serverless; /// -/// Contains statistics about the number of nodes selected by the request. +/// +/// Contains statistics about the number of nodes selected by the request. +/// /// public sealed partial class NodeStatistics { /// - /// Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response. + /// + /// Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response. + /// /// [JsonInclude, JsonPropertyName("failed")] public int Failed { get; init; } @@ -41,13 +45,17 @@ public sealed partial class NodeStatistics public IReadOnlyCollection? Failures { get; init; } /// - /// Number of nodes that responded successfully to the request. + /// + /// Number of nodes that responded successfully to the request. + /// /// [JsonInclude, JsonPropertyName("successful")] public int Successful { get; init; } /// - /// Total number of nodes selected by the request. + /// + /// Total number of nodes selected by the request. + /// /// [JsonInclude, JsonPropertyName("total")] public int Total { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/AdaptiveSelection.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/AdaptiveSelection.g.cs index c9837185bdf..b4d43a43aae 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/AdaptiveSelection.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/AdaptiveSelection.g.cs @@ -30,43 +30,57 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class AdaptiveSelection { /// - /// The exponentially weighted moving average queue size of search requests on the keyed node. + /// + /// The exponentially weighted moving average queue size of search requests on the keyed node. + /// /// [JsonInclude, JsonPropertyName("avg_queue_size")] public long? AvgQueueSize { get; init; } /// - /// The exponentially weighted moving average response time of search requests on the keyed node. + /// + /// The exponentially weighted moving average response time of search requests on the keyed node. + /// /// [JsonInclude, JsonPropertyName("avg_response_time")] public Elastic.Clients.Elasticsearch.Serverless.Duration? AvgResponseTime { get; init; } /// - /// The exponentially weighted moving average response time, in nanoseconds, of search requests on the keyed node. + /// + /// The exponentially weighted moving average response time, in nanoseconds, of search requests on the keyed node. + /// /// [JsonInclude, JsonPropertyName("avg_response_time_ns")] public long? AvgResponseTimeNs { get; init; } /// - /// The exponentially weighted moving average service time of search requests on the keyed node. + /// + /// The exponentially weighted moving average service time of search requests on the keyed node. + /// /// [JsonInclude, JsonPropertyName("avg_service_time")] public Elastic.Clients.Elasticsearch.Serverless.Duration? AvgServiceTime { get; init; } /// - /// The exponentially weighted moving average service time, in nanoseconds, of search requests on the keyed node. + /// + /// The exponentially weighted moving average service time, in nanoseconds, of search requests on the keyed node. + /// /// [JsonInclude, JsonPropertyName("avg_service_time_ns")] public long? AvgServiceTimeNs { get; init; } /// - /// The number of outstanding search requests to the keyed node from the node these stats are for. + /// + /// The number of outstanding search requests to the keyed node from the node these stats are for. + /// /// [JsonInclude, JsonPropertyName("outgoing_searches")] public long? OutgoingSearches { get; init; } /// - /// The rank of this node; used for shard selection when routing search requests. + /// + /// The rank of this node; used for shard selection when routing search requests. + /// /// [JsonInclude, JsonPropertyName("rank")] public string? Rank { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Breaker.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Breaker.g.cs index a7118a3e55a..fab0d9d7aa7 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Breaker.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Breaker.g.cs @@ -30,37 +30,49 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class Breaker { /// - /// Estimated memory used for the operation. + /// + /// Estimated memory used for the operation. + /// /// [JsonInclude, JsonPropertyName("estimated_size")] public string? EstimatedSize { get; init; } /// - /// Estimated memory used, in bytes, for the operation. + /// + /// Estimated memory used, in bytes, for the operation. + /// /// [JsonInclude, JsonPropertyName("estimated_size_in_bytes")] public long? EstimatedSizeInBytes { get; init; } /// - /// Memory limit for the circuit breaker. + /// + /// Memory limit for the circuit breaker. + /// /// [JsonInclude, JsonPropertyName("limit_size")] public string? LimitSize { get; init; } /// - /// Memory limit, in bytes, for the circuit breaker. + /// + /// Memory limit, in bytes, for the circuit breaker. + /// /// [JsonInclude, JsonPropertyName("limit_size_in_bytes")] public long? LimitSizeInBytes { get; init; } /// - /// A constant that all estimates for the circuit breaker are multiplied with to calculate a final estimate. + /// + /// A constant that all estimates for the circuit breaker are multiplied with to calculate a final estimate. + /// /// [JsonInclude, JsonPropertyName("overhead")] public float? Overhead { get; init; } /// - /// Total number of times the circuit breaker has been triggered and prevented an out of memory error. + /// + /// Total number of times the circuit breaker has been triggered and prevented an out of memory error. + /// /// [JsonInclude, JsonPropertyName("tripped")] public float? Tripped { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Cgroup.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Cgroup.g.cs index e6e9f8b4629..2674954d9dd 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Cgroup.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Cgroup.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class Cgroup { /// - /// Contains statistics about `cpu` control group for the node. + /// + /// Contains statistics about cpu control group for the node. + /// /// [JsonInclude, JsonPropertyName("cpu")] public Elastic.Clients.Elasticsearch.Serverless.Nodes.CgroupCpu? Cpu { get; init; } /// - /// Contains statistics about `cpuacct` control group for the node. + /// + /// Contains statistics about cpuacct control group for the node. + /// /// [JsonInclude, JsonPropertyName("cpuacct")] public Elastic.Clients.Elasticsearch.Serverless.Nodes.CpuAcct? Cpuacct { get; init; } /// - /// Contains statistics about the memory control group for the node. + /// + /// Contains statistics about the memory control group for the node. + /// /// [JsonInclude, JsonPropertyName("memory")] public Elastic.Clients.Elasticsearch.Serverless.Nodes.CgroupMemory? Memory { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/CgroupCpu.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/CgroupCpu.g.cs index 418a83a876e..ac316444b9e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/CgroupCpu.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/CgroupCpu.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class CgroupCpu { /// - /// The period of time, in microseconds, for how regularly all tasks in the same cgroup as the Elasticsearch process should have their access to CPU resources reallocated. + /// + /// The period of time, in microseconds, for how regularly all tasks in the same cgroup as the Elasticsearch process should have their access to CPU resources reallocated. + /// /// [JsonInclude, JsonPropertyName("cfs_period_micros")] public int? CfsPeriodMicros { get; init; } /// - /// The total amount of time, in microseconds, for which all tasks in the same cgroup as the Elasticsearch process can run during one period `cfs_period_micros`. + /// + /// The total amount of time, in microseconds, for which all tasks in the same cgroup as the Elasticsearch process can run during one period cfs_period_micros. + /// /// [JsonInclude, JsonPropertyName("cfs_quota_micros")] public int? CfsQuotaMicros { get; init; } /// - /// The `cpu` control group to which the Elasticsearch process belongs. + /// + /// The cpu control group to which the Elasticsearch process belongs. + /// /// [JsonInclude, JsonPropertyName("control_group")] public string? ControlGroup { get; init; } /// - /// Contains CPU statistics for the node. + /// + /// Contains CPU statistics for the node. + /// /// [JsonInclude, JsonPropertyName("stat")] public Elastic.Clients.Elasticsearch.Serverless.Nodes.CgroupCpuStat? Stat { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/CgroupCpuStat.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/CgroupCpuStat.g.cs index ba194afb4bf..9e67a624179 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/CgroupCpuStat.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/CgroupCpuStat.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class CgroupCpuStat { /// - /// The number of reporting periods (as specified by `cfs_period_micros`) that have elapsed. + /// + /// The number of reporting periods (as specified by cfs_period_micros) that have elapsed. + /// /// [JsonInclude, JsonPropertyName("number_of_elapsed_periods")] public long? NumberOfElapsedPeriods { get; init; } /// - /// The number of times all tasks in the same cgroup as the Elasticsearch process have been throttled. + /// + /// The number of times all tasks in the same cgroup as the Elasticsearch process have been throttled. + /// /// [JsonInclude, JsonPropertyName("number_of_times_throttled")] public long? NumberOfTimesThrottled { get; init; } /// - /// The total amount of time, in nanoseconds, for which all tasks in the same cgroup as the Elasticsearch process have been throttled. + /// + /// The total amount of time, in nanoseconds, for which all tasks in the same cgroup as the Elasticsearch process have been throttled. + /// /// [JsonInclude, JsonPropertyName("time_throttled_nanos")] public long? TimeThrottledNanos { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/CgroupMemory.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/CgroupMemory.g.cs index 9c4d9eca882..9a4633174a2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/CgroupMemory.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/CgroupMemory.g.cs @@ -30,19 +30,28 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class CgroupMemory { /// - /// The `memory` control group to which the Elasticsearch process belongs. + /// + /// The memory control group to which the Elasticsearch process belongs. + /// /// [JsonInclude, JsonPropertyName("control_group")] public string? ControlGroup { get; init; } /// - /// The maximum amount of user memory (including file cache) allowed for all tasks in the same cgroup as the Elasticsearch process.
This value can be too big to store in a `long`, so is returned as a string so that the value returned can exactly match what the underlying operating system interface returns.
Any value that is too large to parse into a `long` almost certainly means no limit has been set for the cgroup. + /// + /// The maximum amount of user memory (including file cache) allowed for all tasks in the same cgroup as the Elasticsearch process. + /// This value can be too big to store in a long, so is returned as a string so that the value returned can exactly match what the underlying operating system interface returns. + /// Any value that is too large to parse into a long almost certainly means no limit has been set for the cgroup. + /// /// [JsonInclude, JsonPropertyName("limit_in_bytes")] public string? LimitInBytes { get; init; } /// - /// The total current memory usage by processes in the cgroup, in bytes, by all tasks in the same cgroup as the Elasticsearch process.
This value is stored as a string for consistency with `limit_in_bytes`. + /// + /// The total current memory usage by processes in the cgroup, in bytes, by all tasks in the same cgroup as the Elasticsearch process. + /// This value is stored as a string for consistency with limit_in_bytes. + /// /// [JsonInclude, JsonPropertyName("usage_in_bytes")] public string? UsageInBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Client.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Client.g.cs index ec587443469..cb3c999c09c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Client.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Client.g.cs @@ -30,67 +30,91 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class Client { /// - /// Reported agent for the HTTP client.
If unavailable, this property is not included in the response. + /// + /// Reported agent for the HTTP client. + /// If unavailable, this property is not included in the response. + /// /// [JsonInclude, JsonPropertyName("agent")] public string? Agent { get; init; } /// - /// Time at which the client closed the connection if the connection is closed. + /// + /// Time at which the client closed the connection if the connection is closed. + /// /// [JsonInclude, JsonPropertyName("closed_time_millis")] public long? ClosedTimeMillis { get; init; } /// - /// Unique ID for the HTTP client. + /// + /// Unique ID for the HTTP client. + /// /// [JsonInclude, JsonPropertyName("id")] public long? Id { get; init; } /// - /// Time of the most recent request from this client. + /// + /// Time of the most recent request from this client. + /// /// [JsonInclude, JsonPropertyName("last_request_time_millis")] public long? LastRequestTimeMillis { get; init; } /// - /// The URI of the client’s most recent request. + /// + /// The URI of the client’s most recent request. + /// /// [JsonInclude, JsonPropertyName("last_uri")] public string? LastUri { get; init; } /// - /// Local address for the HTTP connection. + /// + /// Local address for the HTTP connection. + /// /// [JsonInclude, JsonPropertyName("local_address")] public string? LocalAddress { get; init; } /// - /// Time at which the client opened the connection. + /// + /// Time at which the client opened the connection. + /// /// [JsonInclude, JsonPropertyName("opened_time_millis")] public long? OpenedTimeMillis { get; init; } /// - /// Remote address for the HTTP connection. + /// + /// Remote address for the HTTP connection. + /// /// [JsonInclude, JsonPropertyName("remote_address")] public string? RemoteAddress { get; init; } /// - /// Number of requests from this client. + /// + /// Number of requests from this client. + /// /// [JsonInclude, JsonPropertyName("request_count")] public long? RequestCount { get; init; } /// - /// Cumulative size in bytes of all requests from this client. + /// + /// Cumulative size in bytes of all requests from this client. + /// /// [JsonInclude, JsonPropertyName("request_size_bytes")] public long? RequestSizeBytes { get; init; } /// - /// Value from the client’s `x-opaque-id` HTTP header.
If unavailable, this property is not included in the response. + /// + /// Value from the client’s x-opaque-id HTTP header. + /// If unavailable, this property is not included in the response. + /// /// [JsonInclude, JsonPropertyName("x_opaque_id")] public string? XOpaqueId { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/ClusterStateQueue.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/ClusterStateQueue.g.cs index 634f10be7f0..c1810c4bf7b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/ClusterStateQueue.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/ClusterStateQueue.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class ClusterStateQueue { /// - /// Number of committed cluster states in queue. + /// + /// Number of committed cluster states in queue. + /// /// [JsonInclude, JsonPropertyName("committed")] public long? Committed { get; init; } /// - /// Number of pending cluster states in queue. + /// + /// Number of pending cluster states in queue. + /// /// [JsonInclude, JsonPropertyName("pending")] public long? Pending { get; init; } /// - /// Total number of cluster states in queue. + /// + /// Total number of cluster states in queue. + /// /// [JsonInclude, JsonPropertyName("total")] public long? Total { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/ClusterStateUpdate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/ClusterStateUpdate.g.cs index 9affd45668c..7db3719e5dc 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/ClusterStateUpdate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/ClusterStateUpdate.g.cs @@ -30,91 +30,125 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class ClusterStateUpdate { /// - /// The cumulative amount of time spent waiting for a successful cluster state update to commit, which measures the time from the start of each publication until a majority of the master-eligible nodes have written the state to disk and confirmed the write to the elected master. + /// + /// The cumulative amount of time spent waiting for a successful cluster state update to commit, which measures the time from the start of each publication until a majority of the master-eligible nodes have written the state to disk and confirmed the write to the elected master. + /// /// [JsonInclude, JsonPropertyName("commit_time")] public Elastic.Clients.Elasticsearch.Serverless.Duration? CommitTime { get; init; } /// - /// The cumulative amount of time, in milliseconds, spent waiting for a successful cluster state update to commit, which measures the time from the start of each publication until a majority of the master-eligible nodes have written the state to disk and confirmed the write to the elected master. + /// + /// The cumulative amount of time, in milliseconds, spent waiting for a successful cluster state update to commit, which measures the time from the start of each publication until a majority of the master-eligible nodes have written the state to disk and confirmed the write to the elected master. + /// /// [JsonInclude, JsonPropertyName("commit_time_millis")] public long? CommitTimeMillis { get; init; } /// - /// The cumulative amount of time spent waiting for a successful cluster state update to complete, which measures the time from the start of each publication until all the other nodes have notified the elected master that they have applied the cluster state. + /// + /// The cumulative amount of time spent waiting for a successful cluster state update to complete, which measures the time from the start of each publication until all the other nodes have notified the elected master that they have applied the cluster state. + /// /// [JsonInclude, JsonPropertyName("completion_time")] public Elastic.Clients.Elasticsearch.Serverless.Duration? CompletionTime { get; init; } /// - /// The cumulative amount of time, in milliseconds, spent waiting for a successful cluster state update to complete, which measures the time from the start of each publication until all the other nodes have notified the elected master that they have applied the cluster state. + /// + /// The cumulative amount of time, in milliseconds, spent waiting for a successful cluster state update to complete, which measures the time from the start of each publication until all the other nodes have notified the elected master that they have applied the cluster state. + /// /// [JsonInclude, JsonPropertyName("completion_time_millis")] public long? CompletionTimeMillis { get; init; } /// - /// The cumulative amount of time spent computing no-op cluster state updates since the node started. + /// + /// The cumulative amount of time spent computing no-op cluster state updates since the node started. + /// /// [JsonInclude, JsonPropertyName("computation_time")] public Elastic.Clients.Elasticsearch.Serverless.Duration? ComputationTime { get; init; } /// - /// The cumulative amount of time, in milliseconds, spent computing no-op cluster state updates since the node started. + /// + /// The cumulative amount of time, in milliseconds, spent computing no-op cluster state updates since the node started. + /// /// [JsonInclude, JsonPropertyName("computation_time_millis")] public long? ComputationTimeMillis { get; init; } /// - /// The cumulative amount of time spent constructing a publication context since the node started for publications that ultimately succeeded.
This statistic includes the time spent computing the difference between the current and new cluster state preparing a serialized representation of this difference. + /// + /// The cumulative amount of time spent constructing a publication context since the node started for publications that ultimately succeeded. + /// This statistic includes the time spent computing the difference between the current and new cluster state preparing a serialized representation of this difference. + /// /// [JsonInclude, JsonPropertyName("context_construction_time")] public Elastic.Clients.Elasticsearch.Serverless.Duration? ContextConstructionTime { get; init; } /// - /// The cumulative amount of time, in milliseconds, spent constructing a publication context since the node started for publications that ultimately succeeded.
This statistic includes the time spent computing the difference between the current and new cluster state preparing a serialized representation of this difference. + /// + /// The cumulative amount of time, in milliseconds, spent constructing a publication context since the node started for publications that ultimately succeeded. + /// This statistic includes the time spent computing the difference between the current and new cluster state preparing a serialized representation of this difference. + /// /// [JsonInclude, JsonPropertyName("context_construction_time_millis")] public long? ContextConstructionTimeMillis { get; init; } /// - /// The number of cluster state update attempts that did not change the cluster state since the node started. + /// + /// The number of cluster state update attempts that did not change the cluster state since the node started. + /// /// [JsonInclude, JsonPropertyName("count")] public long Count { get; init; } /// - /// The cumulative amount of time spent successfully applying cluster state updates on the elected master since the node started. + /// + /// The cumulative amount of time spent successfully applying cluster state updates on the elected master since the node started. + /// /// [JsonInclude, JsonPropertyName("master_apply_time")] public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterApplyTime { get; init; } /// - /// The cumulative amount of time, in milliseconds, spent successfully applying cluster state updates on the elected master since the node started. + /// + /// The cumulative amount of time, in milliseconds, spent successfully applying cluster state updates on the elected master since the node started. + /// /// [JsonInclude, JsonPropertyName("master_apply_time_millis")] public long? MasterApplyTimeMillis { get; init; } /// - /// The cumulative amount of time spent notifying listeners of a no-op cluster state update since the node started. + /// + /// The cumulative amount of time spent notifying listeners of a no-op cluster state update since the node started. + /// /// [JsonInclude, JsonPropertyName("notification_time")] public Elastic.Clients.Elasticsearch.Serverless.Duration? NotificationTime { get; init; } /// - /// The cumulative amount of time, in milliseconds, spent notifying listeners of a no-op cluster state update since the node started. + /// + /// The cumulative amount of time, in milliseconds, spent notifying listeners of a no-op cluster state update since the node started. + /// /// [JsonInclude, JsonPropertyName("notification_time_millis")] public long? NotificationTimeMillis { get; init; } /// - /// The cumulative amount of time spent publishing cluster state updates which ultimately succeeded, which includes everything from the start of the publication (just after the computation of the new cluster state) until the publication has finished and the master node is ready to start processing the next state update.
This includes the time measured by `context_construction_time`, `commit_time`, `completion_time` and `master_apply_time`. + /// + /// The cumulative amount of time spent publishing cluster state updates which ultimately succeeded, which includes everything from the start of the publication (just after the computation of the new cluster state) until the publication has finished and the master node is ready to start processing the next state update. + /// This includes the time measured by context_construction_time, commit_time, completion_time and master_apply_time. + /// /// [JsonInclude, JsonPropertyName("publication_time")] public Elastic.Clients.Elasticsearch.Serverless.Duration? PublicationTime { get; init; } /// - /// The cumulative amount of time, in milliseconds, spent publishing cluster state updates which ultimately succeeded, which includes everything from the start of the publication (just after the computation of the new cluster state) until the publication has finished and the master node is ready to start processing the next state update.
This includes the time measured by `context_construction_time`, `commit_time`, `completion_time` and `master_apply_time`. + /// + /// The cumulative amount of time, in milliseconds, spent publishing cluster state updates which ultimately succeeded, which includes everything from the start of the publication (just after the computation of the new cluster state) until the publication has finished and the master node is ready to start processing the next state update. + /// This includes the time measured by context_construction_time, commit_time, completion_time and master_apply_time. + /// /// [JsonInclude, JsonPropertyName("publication_time_millis")] public long? PublicationTimeMillis { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/CpuAcct.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/CpuAcct.g.cs index 901dfeee3cb..a3e9e956630 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/CpuAcct.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/CpuAcct.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class CpuAcct { /// - /// The `cpuacct` control group to which the Elasticsearch process belongs. + /// + /// The cpuacct control group to which the Elasticsearch process belongs. + /// /// [JsonInclude, JsonPropertyName("control_group")] public string? ControlGroup { get; init; } /// - /// The total CPU time, in nanoseconds, consumed by all tasks in the same cgroup as the Elasticsearch process. + /// + /// The total CPU time, in nanoseconds, consumed by all tasks in the same cgroup as the Elasticsearch process. + /// /// [JsonInclude, JsonPropertyName("usage_nanos")] public long? UsageNanos { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/DataPathStats.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/DataPathStats.g.cs index ead8704cb28..683715551ac 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/DataPathStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/DataPathStats.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class DataPathStats { /// - /// Total amount of disk space available to this Java virtual machine on this file store. + /// + /// Total amount of disk space available to this Java virtual machine on this file store. + /// /// [JsonInclude, JsonPropertyName("available")] public string? Available { get; init; } /// - /// Total number of bytes available to this Java virtual machine on this file store. + /// + /// Total number of bytes available to this Java virtual machine on this file store. + /// /// [JsonInclude, JsonPropertyName("available_in_bytes")] public long? AvailableInBytes { get; init; } @@ -56,43 +60,57 @@ public sealed partial class DataPathStats public long? DiskWriteSizeInBytes { get; init; } /// - /// Total amount of unallocated disk space in the file store. + /// + /// Total amount of unallocated disk space in the file store. + /// /// [JsonInclude, JsonPropertyName("free")] public string? Free { get; init; } /// - /// Total number of unallocated bytes in the file store. + /// + /// Total number of unallocated bytes in the file store. + /// /// [JsonInclude, JsonPropertyName("free_in_bytes")] public long? FreeInBytes { get; init; } /// - /// Mount point of the file store (for example: `/dev/sda2`). + /// + /// Mount point of the file store (for example: /dev/sda2). + /// /// [JsonInclude, JsonPropertyName("mount")] public string? Mount { get; init; } /// - /// Path to the file store. + /// + /// Path to the file store. + /// /// [JsonInclude, JsonPropertyName("path")] public string? Path { get; init; } /// - /// Total size of the file store. + /// + /// Total size of the file store. + /// /// [JsonInclude, JsonPropertyName("total")] public string? Total { get; init; } /// - /// Total size of the file store in bytes. + /// + /// Total size of the file store in bytes. + /// /// [JsonInclude, JsonPropertyName("total_in_bytes")] public long? TotalInBytes { get; init; } /// - /// Type of the file store (ex: ext4). + /// + /// Type of the file store (ex: ext4). + /// /// [JsonInclude, JsonPropertyName("type")] public string? Type { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Discovery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Discovery.g.cs index 0d6a21e2e3b..52403657f79 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Discovery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Discovery.g.cs @@ -33,19 +33,28 @@ public sealed partial class Discovery public Elastic.Clients.Elasticsearch.Serverless.Nodes.ClusterAppliedStats? ClusterApplierStats { get; init; } /// - /// Contains statistics for the cluster state queue of the node. + /// + /// Contains statistics for the cluster state queue of the node. + /// /// [JsonInclude, JsonPropertyName("cluster_state_queue")] public Elastic.Clients.Elasticsearch.Serverless.Nodes.ClusterStateQueue? ClusterStateQueue { get; init; } /// - /// Contains low-level statistics about how long various activities took during cluster state updates while the node was the elected master.
Omitted if the node is not master-eligible.
Every field whose name ends in `_time` within this object is also represented as a raw number of milliseconds in a field whose name ends in `_time_millis`.
The human-readable fields with a `_time` suffix are only returned if requested with the `?human=true` query parameter. + /// + /// Contains low-level statistics about how long various activities took during cluster state updates while the node was the elected master. + /// Omitted if the node is not master-eligible. + /// Every field whose name ends in _time within this object is also represented as a raw number of milliseconds in a field whose name ends in _time_millis. + /// The human-readable fields with a _time suffix are only returned if requested with the ?human=true query parameter. + /// /// [JsonInclude, JsonPropertyName("cluster_state_update")] public IReadOnlyDictionary? ClusterStateUpdate { get; init; } /// - /// Contains statistics for the published cluster states of the node. + /// + /// Contains statistics for the published cluster states of the node. + /// /// [JsonInclude, JsonPropertyName("published_cluster_states")] public Elastic.Clients.Elasticsearch.Serverless.Nodes.PublishedClusterStates? PublishedClusterStates { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/ExtendedMemoryStats.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/ExtendedMemoryStats.g.cs index 98c5015689c..aebd1ec5b6e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/ExtendedMemoryStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/ExtendedMemoryStats.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class ExtendedMemoryStats { /// - /// If the amount of physical memory has been overridden using the `es`.`total_memory_bytes` system property then this reports the overridden value in bytes.
Otherwise it reports the same value as `total_in_bytes`. + /// + /// If the amount of physical memory has been overridden using the es.total_memory_bytes system property then this reports the overridden value in bytes. + /// Otherwise it reports the same value as total_in_bytes. + /// /// [JsonInclude, JsonPropertyName("adjusted_total_in_bytes")] public long? AdjustedTotalInBytes { get; init; } /// - /// Amount of free physical memory in bytes. + /// + /// Amount of free physical memory in bytes. + /// /// [JsonInclude, JsonPropertyName("free_in_bytes")] public long? FreeInBytes { get; init; } /// - /// Percentage of free memory. + /// + /// Percentage of free memory. + /// /// [JsonInclude, JsonPropertyName("free_percent")] public int? FreePercent { get; init; } @@ -56,7 +63,9 @@ public sealed partial class ExtendedMemoryStats public long? ShareInBytes { get; init; } /// - /// Total amount of physical memory in bytes. + /// + /// Total amount of physical memory in bytes. + /// /// [JsonInclude, JsonPropertyName("total_in_bytes")] public long? TotalInBytes { get; init; } @@ -66,13 +75,17 @@ public sealed partial class ExtendedMemoryStats public long? TotalVirtualInBytes { get; init; } /// - /// Amount of used physical memory in bytes. + /// + /// Amount of used physical memory in bytes. + /// /// [JsonInclude, JsonPropertyName("used_in_bytes")] public long? UsedInBytes { get; init; } /// - /// Percentage of used memory. + /// + /// Percentage of used memory. + /// /// [JsonInclude, JsonPropertyName("used_percent")] public int? UsedPercent { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/FileSystem.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/FileSystem.g.cs index 894a6eff96a..3282bb8dbc4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/FileSystem.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/FileSystem.g.cs @@ -30,25 +30,34 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class FileSystem { /// - /// List of all file stores. + /// + /// List of all file stores. + /// /// [JsonInclude, JsonPropertyName("data")] public IReadOnlyCollection? Data { get; init; } /// - /// Contains I/O statistics for the node. + /// + /// Contains I/O statistics for the node. + /// /// [JsonInclude, JsonPropertyName("io_stats")] public Elastic.Clients.Elasticsearch.Serverless.Nodes.IoStats? IoStats { get; init; } /// - /// Last time the file stores statistics were refreshed.
Recorded in milliseconds since the Unix Epoch. + /// + /// Last time the file stores statistics were refreshed. + /// Recorded in milliseconds since the Unix Epoch. + /// /// [JsonInclude, JsonPropertyName("timestamp")] public long? Timestamp { get; init; } /// - /// Contains statistics for all file stores of the node. + /// + /// Contains statistics for all file stores of the node. + /// /// [JsonInclude, JsonPropertyName("total")] public Elastic.Clients.Elasticsearch.Serverless.Nodes.FileSystemTotal? Total { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/FileSystemTotal.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/FileSystemTotal.g.cs index 013241b7655..72d413c736d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/FileSystemTotal.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/FileSystemTotal.g.cs @@ -30,37 +30,53 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class FileSystemTotal { /// - /// Total disk space available to this Java virtual machine on all file stores.
Depending on OS or process level restrictions, this might appear less than `free`.
This is the actual amount of free disk space the Elasticsearch node can utilise. + /// + /// Total disk space available to this Java virtual machine on all file stores. + /// Depending on OS or process level restrictions, this might appear less than free. + /// This is the actual amount of free disk space the Elasticsearch node can utilise. + /// /// [JsonInclude, JsonPropertyName("available")] public string? Available { get; init; } /// - /// Total number of bytes available to this Java virtual machine on all file stores.
Depending on OS or process level restrictions, this might appear less than `free_in_bytes`.
This is the actual amount of free disk space the Elasticsearch node can utilise. + /// + /// Total number of bytes available to this Java virtual machine on all file stores. + /// Depending on OS or process level restrictions, this might appear less than free_in_bytes. + /// This is the actual amount of free disk space the Elasticsearch node can utilise. + /// /// [JsonInclude, JsonPropertyName("available_in_bytes")] public long? AvailableInBytes { get; init; } /// - /// Total unallocated disk space in all file stores. + /// + /// Total unallocated disk space in all file stores. + /// /// [JsonInclude, JsonPropertyName("free")] public string? Free { get; init; } /// - /// Total number of unallocated bytes in all file stores. + /// + /// Total number of unallocated bytes in all file stores. + /// /// [JsonInclude, JsonPropertyName("free_in_bytes")] public long? FreeInBytes { get; init; } /// - /// Total size of all file stores. + /// + /// Total size of all file stores. + /// /// [JsonInclude, JsonPropertyName("total")] public string? Total { get; init; } /// - /// Total size of all file stores in bytes. + /// + /// Total size of all file stores in bytes. + /// /// [JsonInclude, JsonPropertyName("total_in_bytes")] public long? TotalInBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/GarbageCollector.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/GarbageCollector.g.cs index 95abcd0c53f..41ea9bdbf34 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/GarbageCollector.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/GarbageCollector.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class GarbageCollector { /// - /// Contains statistics about JVM garbage collectors for the node. + /// + /// Contains statistics about JVM garbage collectors for the node. + /// /// [JsonInclude, JsonPropertyName("collectors")] public IReadOnlyDictionary? Collectors { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/GarbageCollectorTotal.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/GarbageCollectorTotal.g.cs index 8794addb683..d607a1a0849 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/GarbageCollectorTotal.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/GarbageCollectorTotal.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class GarbageCollectorTotal { /// - /// Total number of JVM garbage collectors that collect objects. + /// + /// Total number of JVM garbage collectors that collect objects. + /// /// [JsonInclude, JsonPropertyName("collection_count")] public long? CollectionCount { get; init; } /// - /// Total time spent by JVM collecting objects. + /// + /// Total time spent by JVM collecting objects. + /// /// [JsonInclude, JsonPropertyName("collection_time")] public string? CollectionTime { get; init; } /// - /// Total time, in milliseconds, spent by JVM collecting objects. + /// + /// Total time, in milliseconds, spent by JVM collecting objects. + /// /// [JsonInclude, JsonPropertyName("collection_time_in_millis")] public long? CollectionTimeInMillis { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Http.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Http.g.cs index 9ff64891e98..460c81005a9 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Http.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Http.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class Http { /// - /// Information on current and recently-closed HTTP client connections.
Clients that have been closed longer than the `http.client_stats.closed_channels.max_age` setting will not be represented here. + /// + /// Information on current and recently-closed HTTP client connections. + /// Clients that have been closed longer than the http.client_stats.closed_channels.max_age setting will not be represented here. + /// /// [JsonInclude, JsonPropertyName("clients")] public IReadOnlyCollection? Clients { get; init; } /// - /// Current number of open HTTP connections for the node. + /// + /// Current number of open HTTP connections for the node. + /// /// [JsonInclude, JsonPropertyName("current_open")] public int? CurrentOpen { get; init; } /// - /// Total number of HTTP connections opened for the node. + /// + /// Total number of HTTP connections opened for the node. + /// /// [JsonInclude, JsonPropertyName("total_opened")] public long? TotalOpened { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/IndexingPressure.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/IndexingPressure.g.cs index 037417543f0..371c8bc550d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/IndexingPressure.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/IndexingPressure.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class IndexingPressure { /// - /// Contains statistics for memory consumption from indexing load. + /// + /// Contains statistics for memory consumption from indexing load. + /// /// [JsonInclude, JsonPropertyName("memory")] public Elastic.Clients.Elasticsearch.Serverless.Nodes.IndexingPressureMemory? Memory { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/IndexingPressureMemory.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/IndexingPressureMemory.g.cs index 82d704174b6..0becf6f3507 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/IndexingPressureMemory.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/IndexingPressureMemory.g.cs @@ -30,25 +30,35 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class IndexingPressureMemory { /// - /// Contains statistics for current indexing load. + /// + /// Contains statistics for current indexing load. + /// /// [JsonInclude, JsonPropertyName("current")] public Elastic.Clients.Elasticsearch.Serverless.Nodes.PressureMemory? Current { get; init; } /// - /// Configured memory limit for the indexing requests.
Replica requests have an automatic limit that is 1.5x this value. + /// + /// Configured memory limit for the indexing requests. + /// Replica requests have an automatic limit that is 1.5x this value. + /// /// [JsonInclude, JsonPropertyName("limit")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? Limit { get; init; } /// - /// Configured memory limit, in bytes, for the indexing requests.
Replica requests have an automatic limit that is 1.5x this value. + /// + /// Configured memory limit, in bytes, for the indexing requests. + /// Replica requests have an automatic limit that is 1.5x this value. + /// /// [JsonInclude, JsonPropertyName("limit_in_bytes")] public long? LimitInBytes { get; init; } /// - /// Contains statistics for the cumulative indexing load since the node started. + /// + /// Contains statistics for the cumulative indexing load since the node started. + /// /// [JsonInclude, JsonPropertyName("total")] public Elastic.Clients.Elasticsearch.Serverless.Nodes.PressureMemory? Total { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Ingest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Ingest.g.cs index fd25a3a160c..8f6d602f55a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Ingest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Ingest.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class Ingest { /// - /// Contains statistics about ingest pipelines for the node. + /// + /// Contains statistics about ingest pipelines for the node. + /// /// [JsonInclude, JsonPropertyName("pipelines")] public IReadOnlyDictionary? Pipelines { get; init; } /// - /// Contains statistics about ingest operations for the node. + /// + /// Contains statistics about ingest operations for the node. + /// /// [JsonInclude, JsonPropertyName("total")] public Elastic.Clients.Elasticsearch.Serverless.Nodes.IngestTotal? Total { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/IngestTotal.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/IngestTotal.g.cs index ba207391eb7..28969d1c701 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/IngestTotal.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/IngestTotal.g.cs @@ -30,31 +30,41 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class IngestTotal { /// - /// Total number of documents ingested during the lifetime of this node. + /// + /// Total number of documents ingested during the lifetime of this node. + /// /// [JsonInclude, JsonPropertyName("count")] public long? Count { get; init; } /// - /// Total number of documents currently being ingested. + /// + /// Total number of documents currently being ingested. + /// /// [JsonInclude, JsonPropertyName("current")] public long? Current { get; init; } /// - /// Total number of failed ingest operations during the lifetime of this node. + /// + /// Total number of failed ingest operations during the lifetime of this node. + /// /// [JsonInclude, JsonPropertyName("failed")] public long? Failed { get; init; } /// - /// Total number of ingest processors. + /// + /// Total number of ingest processors. + /// /// [JsonInclude, JsonPropertyName("processors")] public IReadOnlyCollection>? Processors { get; init; } /// - /// Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node. + /// + /// Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node. + /// /// [JsonInclude, JsonPropertyName("time_in_millis")] public long? TimeInMillis { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/IoStatDevice.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/IoStatDevice.g.cs index 7c9d023382c..2eb4d020c26 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/IoStatDevice.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/IoStatDevice.g.cs @@ -30,37 +30,49 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class IoStatDevice { /// - /// The Linux device name. + /// + /// The Linux device name. + /// /// [JsonInclude, JsonPropertyName("device_name")] public string? DeviceName { get; init; } /// - /// The total number of read and write operations for the device completed since starting Elasticsearch. + /// + /// The total number of read and write operations for the device completed since starting Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("operations")] public long? Operations { get; init; } /// - /// The total number of kilobytes read for the device since starting Elasticsearch. + /// + /// The total number of kilobytes read for the device since starting Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("read_kilobytes")] public long? ReadKilobytes { get; init; } /// - /// The total number of read operations for the device completed since starting Elasticsearch. + /// + /// The total number of read operations for the device completed since starting Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("read_operations")] public long? ReadOperations { get; init; } /// - /// The total number of kilobytes written for the device since starting Elasticsearch. + /// + /// The total number of kilobytes written for the device since starting Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("write_kilobytes")] public long? WriteKilobytes { get; init; } /// - /// The total number of write operations for the device completed since starting Elasticsearch. + /// + /// The total number of write operations for the device completed since starting Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("write_operations")] public long? WriteOperations { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/IoStats.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/IoStats.g.cs index 850811950a8..8ca58841b1d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/IoStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/IoStats.g.cs @@ -30,13 +30,18 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class IoStats { /// - /// Array of disk metrics for each device that is backing an Elasticsearch data path.
These disk metrics are probed periodically and averages between the last probe and the current probe are computed. + /// + /// Array of disk metrics for each device that is backing an Elasticsearch data path. + /// These disk metrics are probed periodically and averages between the last probe and the current probe are computed. + /// /// [JsonInclude, JsonPropertyName("devices")] public IReadOnlyCollection? Devices { get; init; } /// - /// The sum of the disk metrics for all devices that back an Elasticsearch data path. + /// + /// The sum of the disk metrics for all devices that back an Elasticsearch data path. + /// /// [JsonInclude, JsonPropertyName("total")] public Elastic.Clients.Elasticsearch.Serverless.Nodes.IoStatDevice? Total { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Jvm.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Jvm.g.cs index 71c6b9aeee8..ab1f138066c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Jvm.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Jvm.g.cs @@ -30,49 +30,66 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class Jvm { /// - /// Contains statistics about JVM buffer pools for the node. + /// + /// Contains statistics about JVM buffer pools for the node. + /// /// [JsonInclude, JsonPropertyName("buffer_pools")] public IReadOnlyDictionary? BufferPools { get; init; } /// - /// Contains statistics about classes loaded by JVM for the node. + /// + /// Contains statistics about classes loaded by JVM for the node. + /// /// [JsonInclude, JsonPropertyName("classes")] public Elastic.Clients.Elasticsearch.Serverless.Nodes.JvmClasses? Classes { get; init; } /// - /// Contains statistics about JVM garbage collectors for the node. + /// + /// Contains statistics about JVM garbage collectors for the node. + /// /// [JsonInclude, JsonPropertyName("gc")] public Elastic.Clients.Elasticsearch.Serverless.Nodes.GarbageCollector? Gc { get; init; } /// - /// Contains JVM memory usage statistics for the node. + /// + /// Contains JVM memory usage statistics for the node. + /// /// [JsonInclude, JsonPropertyName("mem")] public Elastic.Clients.Elasticsearch.Serverless.Nodes.JvmMemoryStats? Mem { get; init; } /// - /// Contains statistics about JVM thread usage for the node. + /// + /// Contains statistics about JVM thread usage for the node. + /// /// [JsonInclude, JsonPropertyName("threads")] public Elastic.Clients.Elasticsearch.Serverless.Nodes.JvmThreads? Threads { get; init; } /// - /// Last time JVM statistics were refreshed. + /// + /// Last time JVM statistics were refreshed. + /// /// [JsonInclude, JsonPropertyName("timestamp")] public long? Timestamp { get; init; } /// - /// Human-readable JVM uptime.
Only returned if the `human` query parameter is `true`. + /// + /// Human-readable JVM uptime. + /// Only returned if the human query parameter is true. + /// /// [JsonInclude, JsonPropertyName("uptime")] public string? Uptime { get; init; } /// - /// JVM uptime in milliseconds. + /// + /// JVM uptime in milliseconds. + /// /// [JsonInclude, JsonPropertyName("uptime_in_millis")] public long? UptimeInMillis { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/JvmClasses.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/JvmClasses.g.cs index 438d249e0c6..6bf3db7780e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/JvmClasses.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/JvmClasses.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class JvmClasses { /// - /// Number of classes currently loaded by JVM. + /// + /// Number of classes currently loaded by JVM. + /// /// [JsonInclude, JsonPropertyName("current_loaded_count")] public long? CurrentLoadedCount { get; init; } /// - /// Total number of classes loaded since the JVM started. + /// + /// Total number of classes loaded since the JVM started. + /// /// [JsonInclude, JsonPropertyName("total_loaded_count")] public long? TotalLoadedCount { get; init; } /// - /// Total number of classes unloaded since the JVM started. + /// + /// Total number of classes unloaded since the JVM started. + /// /// [JsonInclude, JsonPropertyName("total_unloaded_count")] public long? TotalUnloadedCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/JvmMemoryStats.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/JvmMemoryStats.g.cs index fe367209c76..addf31ae4c1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/JvmMemoryStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/JvmMemoryStats.g.cs @@ -30,43 +30,57 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class JvmMemoryStats { /// - /// Amount of memory, in bytes, available for use by the heap. + /// + /// Amount of memory, in bytes, available for use by the heap. + /// /// [JsonInclude, JsonPropertyName("heap_committed_in_bytes")] public long? HeapCommittedInBytes { get; init; } /// - /// Maximum amount of memory, in bytes, available for use by the heap. + /// + /// Maximum amount of memory, in bytes, available for use by the heap. + /// /// [JsonInclude, JsonPropertyName("heap_max_in_bytes")] public long? HeapMaxInBytes { get; init; } /// - /// Memory, in bytes, currently in use by the heap. + /// + /// Memory, in bytes, currently in use by the heap. + /// /// [JsonInclude, JsonPropertyName("heap_used_in_bytes")] public long? HeapUsedInBytes { get; init; } /// - /// Percentage of memory currently in use by the heap. + /// + /// Percentage of memory currently in use by the heap. + /// /// [JsonInclude, JsonPropertyName("heap_used_percent")] public long? HeapUsedPercent { get; init; } /// - /// Amount of non-heap memory available, in bytes. + /// + /// Amount of non-heap memory available, in bytes. + /// /// [JsonInclude, JsonPropertyName("non_heap_committed_in_bytes")] public long? NonHeapCommittedInBytes { get; init; } /// - /// Non-heap memory used, in bytes. + /// + /// Non-heap memory used, in bytes. + /// /// [JsonInclude, JsonPropertyName("non_heap_used_in_bytes")] public long? NonHeapUsedInBytes { get; init; } /// - /// Contains statistics about heap memory usage for the node. + /// + /// Contains statistics about heap memory usage for the node. + /// /// [JsonInclude, JsonPropertyName("pools")] public IReadOnlyDictionary? Pools { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/JvmThreads.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/JvmThreads.g.cs index 8cfe52ecfad..5152f8dc6bf 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/JvmThreads.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/JvmThreads.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class JvmThreads { /// - /// Number of active threads in use by JVM. + /// + /// Number of active threads in use by JVM. + /// /// [JsonInclude, JsonPropertyName("count")] public long? Count { get; init; } /// - /// Highest number of threads used by JVM. + /// + /// Highest number of threads used by JVM. + /// /// [JsonInclude, JsonPropertyName("peak_count")] public long? PeakCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/MemoryStats.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/MemoryStats.g.cs index 17b1c99b021..8f65065e537 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/MemoryStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/MemoryStats.g.cs @@ -30,13 +30,18 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class MemoryStats { /// - /// If the amount of physical memory has been overridden using the `es`.`total_memory_bytes` system property then this reports the overridden value in bytes.
Otherwise it reports the same value as `total_in_bytes`. + /// + /// If the amount of physical memory has been overridden using the es.total_memory_bytes system property then this reports the overridden value in bytes. + /// Otherwise it reports the same value as total_in_bytes. + /// /// [JsonInclude, JsonPropertyName("adjusted_total_in_bytes")] public long? AdjustedTotalInBytes { get; init; } /// - /// Amount of free physical memory in bytes. + /// + /// Amount of free physical memory in bytes. + /// /// [JsonInclude, JsonPropertyName("free_in_bytes")] public long? FreeInBytes { get; init; } @@ -50,7 +55,9 @@ public sealed partial class MemoryStats public long? ShareInBytes { get; init; } /// - /// Total amount of physical memory in bytes. + /// + /// Total amount of physical memory in bytes. + /// /// [JsonInclude, JsonPropertyName("total_in_bytes")] public long? TotalInBytes { get; init; } @@ -60,7 +67,9 @@ public sealed partial class MemoryStats public long? TotalVirtualInBytes { get; init; } /// - /// Amount of used physical memory in bytes. + /// + /// Amount of used physical memory in bytes. + /// /// [JsonInclude, JsonPropertyName("used_in_bytes")] public long? UsedInBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/NodeBufferPool.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/NodeBufferPool.g.cs index 8632c1c72b6..e5e0f06863c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/NodeBufferPool.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/NodeBufferPool.g.cs @@ -30,31 +30,41 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class NodeBufferPool { /// - /// Number of buffer pools. + /// + /// Number of buffer pools. + /// /// [JsonInclude, JsonPropertyName("count")] public long? Count { get; init; } /// - /// Total capacity of buffer pools. + /// + /// Total capacity of buffer pools. + /// /// [JsonInclude, JsonPropertyName("total_capacity")] public string? TotalCapacity { get; init; } /// - /// Total capacity of buffer pools in bytes. + /// + /// Total capacity of buffer pools in bytes. + /// /// [JsonInclude, JsonPropertyName("total_capacity_in_bytes")] public long? TotalCapacityInBytes { get; init; } /// - /// Size of buffer pools. + /// + /// Size of buffer pools. + /// /// [JsonInclude, JsonPropertyName("used")] public string? Used { get; init; } /// - /// Size of buffer pools in bytes. + /// + /// Size of buffer pools in bytes. + /// /// [JsonInclude, JsonPropertyName("used_in_bytes")] public long? UsedInBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/NodeInfo.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/NodeInfo.g.cs index 5244225bd2a..092befcffef 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/NodeInfo.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/NodeInfo.g.cs @@ -37,7 +37,9 @@ public sealed partial class NodeInfo public string BuildFlavor { get; init; } /// - /// Short hash of the last git commit in this release. + /// + /// Short hash of the last git commit in this release. + /// /// [JsonInclude, JsonPropertyName("build_hash")] public string BuildHash { get; init; } @@ -45,7 +47,9 @@ public sealed partial class NodeInfo public string BuildType { get; init; } /// - /// The node’s host name. + /// + /// The node’s host name. + /// /// [JsonInclude, JsonPropertyName("host")] public string Host { get; init; } @@ -55,7 +59,9 @@ public sealed partial class NodeInfo public Elastic.Clients.Elasticsearch.Serverless.Nodes.NodeInfoIngest? Ingest { get; init; } /// - /// The node’s IP address. + /// + /// The node’s IP address. + /// /// [JsonInclude, JsonPropertyName("ip")] public string Ip { get; init; } @@ -65,7 +71,9 @@ public sealed partial class NodeInfo public IReadOnlyCollection? Modules { get; init; } /// - /// The node's name + /// + /// The node's name + /// /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } @@ -85,13 +93,17 @@ public sealed partial class NodeInfo public IReadOnlyDictionary? ThreadPool { get; init; } /// - /// Total heap allowed to be used to hold recently indexed documents before they must be written to disk. This size is a shared pool across all shards on this node, and is controlled by Indexing Buffer settings. + /// + /// Total heap allowed to be used to hold recently indexed documents before they must be written to disk. This size is a shared pool across all shards on this node, and is controlled by Indexing Buffer settings. + /// /// [JsonInclude, JsonPropertyName("total_indexing_buffer")] public long? TotalIndexingBuffer { get; init; } /// - /// Same as total_indexing_buffer, but expressed in bytes. + /// + /// Same as total_indexing_buffer, but expressed in bytes. + /// /// [JsonInclude, JsonPropertyName("total_indexing_buffer_in_bytes")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? TotalIndexingBufferInBytes { get; init; } @@ -99,13 +111,17 @@ public sealed partial class NodeInfo public Elastic.Clients.Elasticsearch.Serverless.Nodes.NodeInfoTransport? Transport { get; init; } /// - /// Host and port where transport HTTP connections are accepted. + /// + /// Host and port where transport HTTP connections are accepted. + /// /// [JsonInclude, JsonPropertyName("transport_address")] public string TransportAddress { get; init; } /// - /// Elasticsearch version running on this node. + /// + /// Elasticsearch version running on this node. + /// /// [JsonInclude, JsonPropertyName("version")] public string Version { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/NodeInfoDiscover.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/NodeInfoDiscover.g.cs index 7fb60b09288..ab16ddd86ef 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/NodeInfoDiscover.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/NodeInfoDiscover.g.cs @@ -82,7 +82,9 @@ public sealed partial class NodeInfoDiscover public IReadOnlyCollection? SeedProviders { get; init; } /// - /// Additional or alternative settings + /// + /// Additional or alternative settings + /// /// public IReadOnlyDictionary Settings { get; init; } public string? Type { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/NodeOperatingSystemInfo.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/NodeOperatingSystemInfo.g.cs index 0defbb396b7..b014ef505d9 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/NodeOperatingSystemInfo.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/NodeOperatingSystemInfo.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class NodeOperatingSystemInfo { /// - /// The number of processors actually used to calculate thread pool size. This number can be set with the node.processors setting of a node and defaults to the number of processors reported by the OS. + /// + /// The number of processors actually used to calculate thread pool size. This number can be set with the node.processors setting of a node and defaults to the number of processors reported by the OS. + /// /// [JsonInclude, JsonPropertyName("allocated_processors")] public int? AllocatedProcessors { get; init; } /// - /// Name of the JVM architecture (ex: amd64, x86) + /// + /// Name of the JVM architecture (ex: amd64, x86) + /// /// [JsonInclude, JsonPropertyName("arch")] public string Arch { get; init; } /// - /// Number of processors available to the Java virtual machine + /// + /// Number of processors available to the Java virtual machine + /// /// [JsonInclude, JsonPropertyName("available_processors")] public int AvailableProcessors { get; init; } @@ -52,7 +58,9 @@ public sealed partial class NodeOperatingSystemInfo public Elastic.Clients.Elasticsearch.Serverless.Nodes.NodeInfoMemory? Mem { get; init; } /// - /// Name of the operating system (ex: Linux, Windows, Mac OS X) + /// + /// Name of the operating system (ex: Linux, Windows, Mac OS X) + /// /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } @@ -60,7 +68,9 @@ public sealed partial class NodeOperatingSystemInfo public string PrettyName { get; init; } /// - /// Refresh interval for the OS statistics + /// + /// Refresh interval for the OS statistics + /// /// [JsonInclude, JsonPropertyName("refresh_interval_in_millis")] public long RefreshIntervalInMillis { get; init; } @@ -68,7 +78,9 @@ public sealed partial class NodeOperatingSystemInfo public Elastic.Clients.Elasticsearch.Serverless.Nodes.NodeInfoMemory? Swap { get; init; } /// - /// Version of the operating system + /// + /// Version of the operating system + /// /// [JsonInclude, JsonPropertyName("version")] public string Version { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/NodeProcessInfo.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/NodeProcessInfo.g.cs index 5f18b54281a..d5b613ae01a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/NodeProcessInfo.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/NodeProcessInfo.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class NodeProcessInfo { /// - /// Process identifier (PID) + /// + /// Process identifier (PID) + /// /// [JsonInclude, JsonPropertyName("id")] public long Id { get; init; } /// - /// Indicates if the process address space has been successfully locked in memory + /// + /// Indicates if the process address space has been successfully locked in memory + /// /// [JsonInclude, JsonPropertyName("mlockall")] public bool Mlockall { get; init; } /// - /// Refresh interval for the process statistics + /// + /// Refresh interval for the process statistics + /// /// [JsonInclude, JsonPropertyName("refresh_interval_in_millis")] public long RefreshIntervalInMillis { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Pool.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Pool.g.cs index 34a454e88b7..bca37f58d78 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Pool.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Pool.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class Pool { /// - /// Maximum amount of memory, in bytes, available for use by the heap. + /// + /// Maximum amount of memory, in bytes, available for use by the heap. + /// /// [JsonInclude, JsonPropertyName("max_in_bytes")] public long? MaxInBytes { get; init; } /// - /// Largest amount of memory, in bytes, historically used by the heap. + /// + /// Largest amount of memory, in bytes, historically used by the heap. + /// /// [JsonInclude, JsonPropertyName("peak_max_in_bytes")] public long? PeakMaxInBytes { get; init; } /// - /// Largest amount of memory, in bytes, historically used by the heap. + /// + /// Largest amount of memory, in bytes, historically used by the heap. + /// /// [JsonInclude, JsonPropertyName("peak_used_in_bytes")] public long? PeakUsedInBytes { get; init; } /// - /// Memory, in bytes, used by the heap. + /// + /// Memory, in bytes, used by the heap. + /// /// [JsonInclude, JsonPropertyName("used_in_bytes")] public long? UsedInBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/PressureMemory.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/PressureMemory.g.cs index 19567ed42e4..cccfef83ab1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/PressureMemory.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/PressureMemory.g.cs @@ -30,79 +30,107 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class PressureMemory { /// - /// Memory consumed by indexing requests in the coordinating, primary, or replica stage. + /// + /// Memory consumed by indexing requests in the coordinating, primary, or replica stage. + /// /// [JsonInclude, JsonPropertyName("all")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? All { get; init; } /// - /// Memory consumed, in bytes, by indexing requests in the coordinating, primary, or replica stage. + /// + /// Memory consumed, in bytes, by indexing requests in the coordinating, primary, or replica stage. + /// /// [JsonInclude, JsonPropertyName("all_in_bytes")] public long? AllInBytes { get; init; } /// - /// Memory consumed by indexing requests in the coordinating or primary stage.
This value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally. + /// + /// Memory consumed by indexing requests in the coordinating or primary stage. + /// This value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally. + /// /// [JsonInclude, JsonPropertyName("combined_coordinating_and_primary")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? CombinedCoordinatingAndPrimary { get; init; } /// - /// Memory consumed, in bytes, by indexing requests in the coordinating or primary stage.
This value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally. + /// + /// Memory consumed, in bytes, by indexing requests in the coordinating or primary stage. + /// This value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally. + /// /// [JsonInclude, JsonPropertyName("combined_coordinating_and_primary_in_bytes")] public long? CombinedCoordinatingAndPrimaryInBytes { get; init; } /// - /// Memory consumed by indexing requests in the coordinating stage. + /// + /// Memory consumed by indexing requests in the coordinating stage. + /// /// [JsonInclude, JsonPropertyName("coordinating")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? Coordinating { get; init; } /// - /// Memory consumed, in bytes, by indexing requests in the coordinating stage. + /// + /// Memory consumed, in bytes, by indexing requests in the coordinating stage. + /// /// [JsonInclude, JsonPropertyName("coordinating_in_bytes")] public long? CoordinatingInBytes { get; init; } /// - /// Number of indexing requests rejected in the coordinating stage. + /// + /// Number of indexing requests rejected in the coordinating stage. + /// /// [JsonInclude, JsonPropertyName("coordinating_rejections")] public long? CoordinatingRejections { get; init; } /// - /// Memory consumed by indexing requests in the primary stage. + /// + /// Memory consumed by indexing requests in the primary stage. + /// /// [JsonInclude, JsonPropertyName("primary")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? Primary { get; init; } /// - /// Memory consumed, in bytes, by indexing requests in the primary stage. + /// + /// Memory consumed, in bytes, by indexing requests in the primary stage. + /// /// [JsonInclude, JsonPropertyName("primary_in_bytes")] public long? PrimaryInBytes { get; init; } /// - /// Number of indexing requests rejected in the primary stage. + /// + /// Number of indexing requests rejected in the primary stage. + /// /// [JsonInclude, JsonPropertyName("primary_rejections")] public long? PrimaryRejections { get; init; } /// - /// Memory consumed by indexing requests in the replica stage. + /// + /// Memory consumed by indexing requests in the replica stage. + /// /// [JsonInclude, JsonPropertyName("replica")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? Replica { get; init; } /// - /// Memory consumed, in bytes, by indexing requests in the replica stage. + /// + /// Memory consumed, in bytes, by indexing requests in the replica stage. + /// /// [JsonInclude, JsonPropertyName("replica_in_bytes")] public long? ReplicaInBytes { get; init; } /// - /// Number of indexing requests rejected in the replica stage. + /// + /// Number of indexing requests rejected in the replica stage. + /// /// [JsonInclude, JsonPropertyName("replica_rejections")] public long? ReplicaRejections { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Process.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Process.g.cs index 87defee51e6..bea16be24ab 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Process.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Process.g.cs @@ -30,31 +30,42 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class Process { /// - /// Contains CPU statistics for the node. + /// + /// Contains CPU statistics for the node. + /// /// [JsonInclude, JsonPropertyName("cpu")] public Elastic.Clients.Elasticsearch.Serverless.Nodes.Cpu? Cpu { get; init; } /// - /// Maximum number of file descriptors allowed on the system, or `-1` if not supported. + /// + /// Maximum number of file descriptors allowed on the system, or -1 if not supported. + /// /// [JsonInclude, JsonPropertyName("max_file_descriptors")] public int? MaxFileDescriptors { get; init; } /// - /// Contains virtual memory statistics for the node. + /// + /// Contains virtual memory statistics for the node. + /// /// [JsonInclude, JsonPropertyName("mem")] public Elastic.Clients.Elasticsearch.Serverless.Nodes.MemoryStats? Mem { get; init; } /// - /// Number of opened file descriptors associated with the current or `-1` if not supported. + /// + /// Number of opened file descriptors associated with the current or -1 if not supported. + /// /// [JsonInclude, JsonPropertyName("open_file_descriptors")] public int? OpenFileDescriptors { get; init; } /// - /// Last time the statistics were refreshed.
Recorded in milliseconds since the Unix Epoch. + /// + /// Last time the statistics were refreshed. + /// Recorded in milliseconds since the Unix Epoch. + /// /// [JsonInclude, JsonPropertyName("timestamp")] public long? Timestamp { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Processor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Processor.g.cs index 17ed5cba1ac..20fb3fa42cf 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Processor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Processor.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class Processor { /// - /// Number of documents transformed by the processor. + /// + /// Number of documents transformed by the processor. + /// /// [JsonInclude, JsonPropertyName("count")] public long? Count { get; init; } /// - /// Number of documents currently being transformed by the processor. + /// + /// Number of documents currently being transformed by the processor. + /// /// [JsonInclude, JsonPropertyName("current")] public long? Current { get; init; } /// - /// Number of failed operations for the processor. + /// + /// Number of failed operations for the processor. + /// /// [JsonInclude, JsonPropertyName("failed")] public long? Failed { get; init; } /// - /// Time, in milliseconds, spent by the processor transforming documents. + /// + /// Time, in milliseconds, spent by the processor transforming documents. + /// /// [JsonInclude, JsonPropertyName("time_in_millis")] public long? TimeInMillis { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/PublishedClusterStates.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/PublishedClusterStates.g.cs index 6cd9ce97cc6..0db9e471302 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/PublishedClusterStates.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/PublishedClusterStates.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class PublishedClusterStates { /// - /// Number of compatible differences between published cluster states. + /// + /// Number of compatible differences between published cluster states. + /// /// [JsonInclude, JsonPropertyName("compatible_diffs")] public long? CompatibleDiffs { get; init; } /// - /// Number of published cluster states. + /// + /// Number of published cluster states. + /// /// [JsonInclude, JsonPropertyName("full_states")] public long? FullStates { get; init; } /// - /// Number of incompatible differences between published cluster states. + /// + /// Number of incompatible differences between published cluster states. + /// /// [JsonInclude, JsonPropertyName("incompatible_diffs")] public long? IncompatibleDiffs { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/ScriptCache.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/ScriptCache.g.cs index 08173895289..b0fbd84d21b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/ScriptCache.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/ScriptCache.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class ScriptCache { /// - /// Total number of times the script cache has evicted old data. + /// + /// Total number of times the script cache has evicted old data. + /// /// [JsonInclude, JsonPropertyName("cache_evictions")] public long? CacheEvictions { get; init; } /// - /// Total number of times the script compilation circuit breaker has limited inline script compilations. + /// + /// Total number of times the script compilation circuit breaker has limited inline script compilations. + /// /// [JsonInclude, JsonPropertyName("compilation_limit_triggered")] public long? CompilationLimitTriggered { get; init; } /// - /// Total number of inline script compilations performed by the node. + /// + /// Total number of inline script compilations performed by the node. + /// /// [JsonInclude, JsonPropertyName("compilations")] public long? Compilations { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Scripting.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Scripting.g.cs index bc12d375a5c..46a5d2cc55e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Scripting.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Scripting.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class Scripting { /// - /// Total number of times the script cache has evicted old data. + /// + /// Total number of times the script cache has evicted old data. + /// /// [JsonInclude, JsonPropertyName("cache_evictions")] public long? CacheEvictions { get; init; } /// - /// Total number of times the script compilation circuit breaker has limited inline script compilations. + /// + /// Total number of times the script compilation circuit breaker has limited inline script compilations. + /// /// [JsonInclude, JsonPropertyName("compilation_limit_triggered")] public long? CompilationLimitTriggered { get; init; } /// - /// Total number of inline script compilations performed by the node. + /// + /// Total number of inline script compilations performed by the node. + /// /// [JsonInclude, JsonPropertyName("compilations")] public long? Compilations { get; init; } /// - /// Contains this recent history of script compilations. + /// + /// Contains this recent history of script compilations. + /// /// [JsonInclude, JsonPropertyName("compilations_history")] public IReadOnlyDictionary? CompilationsHistory { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/SerializedClusterState.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/SerializedClusterState.g.cs index 12a91e4784d..7ccf28e95af 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/SerializedClusterState.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/SerializedClusterState.g.cs @@ -33,7 +33,9 @@ public sealed partial class SerializedClusterState public Elastic.Clients.Elasticsearch.Serverless.Nodes.SerializedClusterStateDetail? Diffs { get; init; } /// - /// Number of published cluster states. + /// + /// Number of published cluster states. + /// /// [JsonInclude, JsonPropertyName("full_states")] public Elastic.Clients.Elasticsearch.Serverless.Nodes.SerializedClusterStateDetail? FullStates { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Stats.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Stats.g.cs index fe123cb279c..5fa4360b7c1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Stats.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Stats.g.cs @@ -30,105 +30,140 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class Stats { /// - /// Statistics about adaptive replica selection. + /// + /// Statistics about adaptive replica selection. + /// /// [JsonInclude, JsonPropertyName("adaptive_selection")] public IReadOnlyDictionary? AdaptiveSelection { get; init; } /// - /// Contains a list of attributes for the node. + /// + /// Contains a list of attributes for the node. + /// /// [JsonInclude, JsonPropertyName("attributes")] [ReadOnlyFieldDictionaryConverter(typeof(string))] public IReadOnlyDictionary? Attributes { get; init; } /// - /// Statistics about the field data circuit breaker. + /// + /// Statistics about the field data circuit breaker. + /// /// [JsonInclude, JsonPropertyName("breakers")] public IReadOnlyDictionary? Breakers { get; init; } /// - /// Contains node discovery statistics for the node. + /// + /// Contains node discovery statistics for the node. + /// /// [JsonInclude, JsonPropertyName("discovery")] public Elastic.Clients.Elasticsearch.Serverless.Nodes.Discovery? Discovery { get; init; } /// - /// File system information, data path, free disk space, read/write stats. + /// + /// File system information, data path, free disk space, read/write stats. + /// /// [JsonInclude, JsonPropertyName("fs")] public Elastic.Clients.Elasticsearch.Serverless.Nodes.FileSystem? Fs { get; init; } /// - /// Network host for the node, based on the network host setting. + /// + /// Network host for the node, based on the network host setting. + /// /// [JsonInclude, JsonPropertyName("host")] public string? Host { get; init; } /// - /// HTTP connection information. + /// + /// HTTP connection information. + /// /// [JsonInclude, JsonPropertyName("http")] public Elastic.Clients.Elasticsearch.Serverless.Nodes.Http? Http { get; init; } /// - /// Contains indexing pressure statistics for the node. + /// + /// Contains indexing pressure statistics for the node. + /// /// [JsonInclude, JsonPropertyName("indexing_pressure")] public Elastic.Clients.Elasticsearch.Serverless.Nodes.IndexingPressure? IndexingPressure { get; init; } /// - /// Indices stats about size, document count, indexing and deletion times, search times, field cache size, merges and flushes. + /// + /// Indices stats about size, document count, indexing and deletion times, search times, field cache size, merges and flushes. + /// /// [JsonInclude, JsonPropertyName("indices")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.ShardStats? Indices { get; init; } /// - /// Statistics about ingest preprocessing. + /// + /// Statistics about ingest preprocessing. + /// /// [JsonInclude, JsonPropertyName("ingest")] public Elastic.Clients.Elasticsearch.Serverless.Nodes.Ingest? Ingest { get; init; } /// - /// IP address and port for the node. + /// + /// IP address and port for the node. + /// /// [JsonInclude, JsonPropertyName("ip")] [SingleOrManyCollectionConverter(typeof(string))] public IReadOnlyCollection? Ip { get; init; } /// - /// JVM stats, memory pool information, garbage collection, buffer pools, number of loaded/unloaded classes. + /// + /// JVM stats, memory pool information, garbage collection, buffer pools, number of loaded/unloaded classes. + /// /// [JsonInclude, JsonPropertyName("jvm")] public Elastic.Clients.Elasticsearch.Serverless.Nodes.Jvm? Jvm { get; init; } /// - /// Human-readable identifier for the node.
Based on the node name setting. + /// + /// Human-readable identifier for the node. + /// Based on the node name setting. + /// /// [JsonInclude, JsonPropertyName("name")] public string? Name { get; init; } /// - /// Operating system stats, load average, mem, swap. + /// + /// Operating system stats, load average, mem, swap. + /// /// [JsonInclude, JsonPropertyName("os")] public Elastic.Clients.Elasticsearch.Serverless.Nodes.OperatingSystem? Os { get; init; } /// - /// Process statistics, memory consumption, cpu usage, open file descriptors. + /// + /// Process statistics, memory consumption, cpu usage, open file descriptors. + /// /// [JsonInclude, JsonPropertyName("process")] public Elastic.Clients.Elasticsearch.Serverless.Nodes.Process? Process { get; init; } /// - /// Roles assigned to the node. + /// + /// Roles assigned to the node. + /// /// [JsonInclude, JsonPropertyName("roles")] public IReadOnlyCollection? Roles { get; init; } /// - /// Contains script statistics for the node. + /// + /// Contains script statistics for the node. + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Serverless.Nodes.Scripting? Script { get; init; } @@ -136,7 +171,9 @@ public sealed partial class Stats public IReadOnlyDictionary>>? ScriptCache { get; init; } /// - /// Statistics about each thread pool, including current size, queue and rejected tasks. + /// + /// Statistics about each thread pool, including current size, queue and rejected tasks. + /// /// [JsonInclude, JsonPropertyName("thread_pool")] public IReadOnlyDictionary? ThreadPool { get; init; } @@ -144,13 +181,17 @@ public sealed partial class Stats public long? Timestamp { get; init; } /// - /// Transport statistics about sent and received bytes in cluster communication. + /// + /// Transport statistics about sent and received bytes in cluster communication. + /// /// [JsonInclude, JsonPropertyName("transport")] public Elastic.Clients.Elasticsearch.Serverless.Nodes.Transport? Transport { get; init; } /// - /// Host and port for the transport layer, used for internal communication between nodes in a cluster. + /// + /// Host and port for the transport layer, used for internal communication between nodes in a cluster. + /// /// [JsonInclude, JsonPropertyName("transport_address")] public string? TransportAddress { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/ThreadCount.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/ThreadCount.g.cs index d884b5d45cd..bf936d7684b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/ThreadCount.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/ThreadCount.g.cs @@ -30,37 +30,49 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class ThreadCount { /// - /// Number of active threads in the thread pool. + /// + /// Number of active threads in the thread pool. + /// /// [JsonInclude, JsonPropertyName("active")] public long? Active { get; init; } /// - /// Number of tasks completed by the thread pool executor. + /// + /// Number of tasks completed by the thread pool executor. + /// /// [JsonInclude, JsonPropertyName("completed")] public long? Completed { get; init; } /// - /// Highest number of active threads in the thread pool. + /// + /// Highest number of active threads in the thread pool. + /// /// [JsonInclude, JsonPropertyName("largest")] public long? Largest { get; init; } /// - /// Number of tasks in queue for the thread pool. + /// + /// Number of tasks in queue for the thread pool. + /// /// [JsonInclude, JsonPropertyName("queue")] public long? Queue { get; init; } /// - /// Number of tasks rejected by the thread pool executor. + /// + /// Number of tasks rejected by the thread pool executor. + /// /// [JsonInclude, JsonPropertyName("rejected")] public long? Rejected { get; init; } /// - /// Number of threads in the thread pool. + /// + /// Number of threads in the thread pool. + /// /// [JsonInclude, JsonPropertyName("threads")] public long? Threads { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Transport.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Transport.g.cs index 7041c92133f..ed04737e6fd 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Transport.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/Transport.g.cs @@ -30,61 +30,83 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class Transport { /// - /// The distribution of the time spent handling each inbound message on a transport thread, represented as a histogram. + /// + /// The distribution of the time spent handling each inbound message on a transport thread, represented as a histogram. + /// /// [JsonInclude, JsonPropertyName("inbound_handling_time_histogram")] public IReadOnlyCollection? InboundHandlingTimeHistogram { get; init; } /// - /// The distribution of the time spent sending each outbound transport message on a transport thread, represented as a histogram. + /// + /// The distribution of the time spent sending each outbound transport message on a transport thread, represented as a histogram. + /// /// [JsonInclude, JsonPropertyName("outbound_handling_time_histogram")] public IReadOnlyCollection? OutboundHandlingTimeHistogram { get; init; } /// - /// Total number of RX (receive) packets received by the node during internal cluster communication. + /// + /// Total number of RX (receive) packets received by the node during internal cluster communication. + /// /// [JsonInclude, JsonPropertyName("rx_count")] public long? RxCount { get; init; } /// - /// Size of RX packets received by the node during internal cluster communication. + /// + /// Size of RX packets received by the node during internal cluster communication. + /// /// [JsonInclude, JsonPropertyName("rx_size")] public string? RxSize { get; init; } /// - /// Size, in bytes, of RX packets received by the node during internal cluster communication. + /// + /// Size, in bytes, of RX packets received by the node during internal cluster communication. + /// /// [JsonInclude, JsonPropertyName("rx_size_in_bytes")] public long? RxSizeInBytes { get; init; } /// - /// Current number of inbound TCP connections used for internal communication between nodes. + /// + /// Current number of inbound TCP connections used for internal communication between nodes. + /// /// [JsonInclude, JsonPropertyName("server_open")] public int? ServerOpen { get; init; } /// - /// The cumulative number of outbound transport connections that this node has opened since it started.
Each transport connection may comprise multiple TCP connections but is only counted once in this statistic.
Transport connections are typically long-lived so this statistic should remain constant in a stable cluster. + /// + /// The cumulative number of outbound transport connections that this node has opened since it started. + /// Each transport connection may comprise multiple TCP connections but is only counted once in this statistic. + /// Transport connections are typically long-lived so this statistic should remain constant in a stable cluster. + /// /// [JsonInclude, JsonPropertyName("total_outbound_connections")] public long? TotalOutboundConnections { get; init; } /// - /// Total number of TX (transmit) packets sent by the node during internal cluster communication. + /// + /// Total number of TX (transmit) packets sent by the node during internal cluster communication. + /// /// [JsonInclude, JsonPropertyName("tx_count")] public long? TxCount { get; init; } /// - /// Size of TX packets sent by the node during internal cluster communication. + /// + /// Size of TX packets sent by the node during internal cluster communication. + /// /// [JsonInclude, JsonPropertyName("tx_size")] public string? TxSize { get; init; } /// - /// Size, in bytes, of TX packets sent by the node during internal cluster communication. + /// + /// Size, in bytes, of TX packets sent by the node during internal cluster communication. + /// /// [JsonInclude, JsonPropertyName("tx_size_in_bytes")] public long? TxSizeInBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/TransportHistogram.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/TransportHistogram.g.cs index 0e7cb2c11ff..1123336df0f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/TransportHistogram.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/TransportHistogram.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class TransportHistogram { /// - /// The number of times a transport thread took a period of time within the bounds of this bucket to handle an inbound message. + /// + /// The number of times a transport thread took a period of time within the bounds of this bucket to handle an inbound message. + /// /// [JsonInclude, JsonPropertyName("count")] public long? Count { get; init; } /// - /// The inclusive lower bound of the bucket in milliseconds. May be omitted on the first bucket if this bucket has no lower bound. + /// + /// The inclusive lower bound of the bucket in milliseconds. May be omitted on the first bucket if this bucket has no lower bound. + /// /// [JsonInclude, JsonPropertyName("ge_millis")] public long? GeMillis { get; init; } /// - /// The exclusive upper bound of the bucket in milliseconds.
May be omitted on the last bucket if this bucket has no upper bound. + /// + /// The exclusive upper bound of the bucket in milliseconds. + /// May be omitted on the last bucket if this bucket has no upper bound. + /// /// [JsonInclude, JsonPropertyName("lt_millis")] public long? LtMillis { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryCacheStats.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryCacheStats.g.cs index 39f43ffaafd..3545bd22965 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryCacheStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryCacheStats.g.cs @@ -30,49 +30,66 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class QueryCacheStats { /// - /// Total number of entries added to the query cache across all shards assigned to selected nodes.
This number includes current and evicted entries. + /// + /// Total number of entries added to the query cache across all shards assigned to selected nodes. + /// This number includes current and evicted entries. + /// /// [JsonInclude, JsonPropertyName("cache_count")] public long CacheCount { get; init; } /// - /// Total number of entries currently in the query cache across all shards assigned to selected nodes. + /// + /// Total number of entries currently in the query cache across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("cache_size")] public long CacheSize { get; init; } /// - /// Total number of query cache evictions across all shards assigned to selected nodes. + /// + /// Total number of query cache evictions across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("evictions")] public long Evictions { get; init; } /// - /// Total count of query cache hits across all shards assigned to selected nodes. + /// + /// Total count of query cache hits across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("hit_count")] public long HitCount { get; init; } /// - /// Total amount of memory used for the query cache across all shards assigned to selected nodes. + /// + /// Total amount of memory used for the query cache across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("memory_size")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? MemorySize { get; init; } /// - /// Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes. + /// + /// Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("memory_size_in_bytes")] public long MemorySizeInBytes { get; init; } /// - /// Total count of query cache misses across all shards assigned to selected nodes. + /// + /// Total count of query cache misses across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("miss_count")] public long MissCount { get; init; } /// - /// Total count of hits and misses in the query cache across all shards assigned to selected nodes. + /// + /// Total count of hits and misses in the query cache across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("total_count")] public long TotalCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/BoolQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/BoolQuery.g.cs index aa315b37025..546ff80a089 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/BoolQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/BoolQuery.g.cs @@ -30,33 +30,48 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class BoolQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// The clause (query) must appear in matching documents.
However, unlike `must`, the score of the query will be ignored. + /// + /// The clause (query) must appear in matching documents. + /// However, unlike must, the score of the query will be ignored. + /// /// [JsonInclude, JsonPropertyName("filter")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query))] public ICollection? Filter { get; set; } /// - /// Specifies the number or percentage of `should` clauses returned documents must match. + /// + /// Specifies the number or percentage of should clauses returned documents must match. + /// /// [JsonInclude, JsonPropertyName("minimum_should_match")] public Elastic.Clients.Elasticsearch.Serverless.MinimumShouldMatch? MinimumShouldMatch { get; set; } /// - /// The clause (query) must appear in matching documents and will contribute to the score. + /// + /// The clause (query) must appear in matching documents and will contribute to the score. + /// /// [JsonInclude, JsonPropertyName("must")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query))] public ICollection? Must { get; set; } /// - /// The clause (query) must not appear in the matching documents.
Because scoring is ignored, a score of `0` is returned for all documents. + /// + /// The clause (query) must not appear in the matching documents. + /// Because scoring is ignored, a score of 0 is returned for all documents. + /// /// [JsonInclude, JsonPropertyName("must_not")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query))] @@ -65,7 +80,9 @@ public sealed partial class BoolQuery public string? QueryName { get; set; } /// - /// The clause (query) should appear in the matching document. + /// + /// The clause (query) should appear in the matching document. + /// /// [JsonInclude, JsonPropertyName("should")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query))] @@ -103,7 +120,12 @@ public BoolQueryDescriptor() : base() private Action>[] ShouldDescriptorActions { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public BoolQueryDescriptor Boost(float? boost) { @@ -112,7 +134,10 @@ public BoolQueryDescriptor Boost(float? boost) } /// - /// The clause (query) must appear in matching documents.
However, unlike `must`, the score of the query will be ignored. + /// + /// The clause (query) must appear in matching documents. + /// However, unlike must, the score of the query will be ignored. + /// /// public BoolQueryDescriptor Filter(ICollection? filter) { @@ -151,7 +176,9 @@ public BoolQueryDescriptor Filter(params Action - /// Specifies the number or percentage of `should` clauses returned documents must match. + /// + /// Specifies the number or percentage of should clauses returned documents must match. + /// /// public BoolQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.Serverless.MinimumShouldMatch? minimumShouldMatch) { @@ -160,7 +187,9 @@ public BoolQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elastic } /// - /// The clause (query) must appear in matching documents and will contribute to the score. + /// + /// The clause (query) must appear in matching documents and will contribute to the score. + /// /// public BoolQueryDescriptor Must(ICollection? must) { @@ -199,7 +228,10 @@ public BoolQueryDescriptor Must(params Action - /// The clause (query) must not appear in the matching documents.
Because scoring is ignored, a score of `0` is returned for all documents. + /// + /// The clause (query) must not appear in the matching documents. + /// Because scoring is ignored, a score of 0 is returned for all documents. + /// /// public BoolQueryDescriptor MustNot(ICollection? mustNot) { @@ -244,7 +276,9 @@ public BoolQueryDescriptor QueryName(string? queryName) } /// - /// The clause (query) should appear in the matching document. + /// + /// The clause (query) should appear in the matching document. + /// /// public BoolQueryDescriptor Should(ICollection? should) { @@ -452,7 +486,12 @@ public BoolQueryDescriptor() : base() private Action[] ShouldDescriptorActions { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public BoolQueryDescriptor Boost(float? boost) { @@ -461,7 +500,10 @@ public BoolQueryDescriptor Boost(float? boost) } /// - /// The clause (query) must appear in matching documents.
However, unlike `must`, the score of the query will be ignored. + /// + /// The clause (query) must appear in matching documents. + /// However, unlike must, the score of the query will be ignored. + /// /// public BoolQueryDescriptor Filter(ICollection? filter) { @@ -500,7 +542,9 @@ public BoolQueryDescriptor Filter(params Action - /// Specifies the number or percentage of `should` clauses returned documents must match. + /// + /// Specifies the number or percentage of should clauses returned documents must match. + /// /// public BoolQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.Serverless.MinimumShouldMatch? minimumShouldMatch) { @@ -509,7 +553,9 @@ public BoolQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.Serv } /// - /// The clause (query) must appear in matching documents and will contribute to the score. + /// + /// The clause (query) must appear in matching documents and will contribute to the score. + /// /// public BoolQueryDescriptor Must(ICollection? must) { @@ -548,7 +594,10 @@ public BoolQueryDescriptor Must(params Action - /// The clause (query) must not appear in the matching documents.
Because scoring is ignored, a score of `0` is returned for all documents. + /// + /// The clause (query) must not appear in the matching documents. + /// Because scoring is ignored, a score of 0 is returned for all documents. + /// /// public BoolQueryDescriptor MustNot(ICollection? mustNot) { @@ -593,7 +642,9 @@ public BoolQueryDescriptor QueryName(string? queryName) } /// - /// The clause (query) should appear in the matching document. + /// + /// The clause (query) should appear in the matching document. + /// /// public BoolQueryDescriptor Should(ICollection? should) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/BoostingQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/BoostingQuery.g.cs index 4236314ff58..643c25356d3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/BoostingQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/BoostingQuery.g.cs @@ -30,25 +30,36 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class BoostingQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Query used to decrease the relevance score of matching documents. + /// + /// Query used to decrease the relevance score of matching documents. + /// /// [JsonInclude, JsonPropertyName("negative")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query Negative { get; set; } /// - /// Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the `negative` query. + /// + /// Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the negative query. + /// /// [JsonInclude, JsonPropertyName("negative_boost")] public double NegativeBoost { get; set; } /// - /// Any returned documents must match this query. + /// + /// Any returned documents must match this query. + /// /// [JsonInclude, JsonPropertyName("positive")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query Positive { get; set; } @@ -77,7 +88,12 @@ public BoostingQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public BoostingQueryDescriptor Boost(float? boost) { @@ -86,7 +102,9 @@ public BoostingQueryDescriptor Boost(float? boost) } /// - /// Query used to decrease the relevance score of matching documents. + /// + /// Query used to decrease the relevance score of matching documents. + /// /// public BoostingQueryDescriptor Negative(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query negative) { @@ -113,7 +131,9 @@ public BoostingQueryDescriptor Negative(Action - /// Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the `negative` query. + /// + /// Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the negative query. + /// /// public BoostingQueryDescriptor NegativeBoost(double negativeBoost) { @@ -122,7 +142,9 @@ public BoostingQueryDescriptor NegativeBoost(double negativeBoost) } /// - /// Any returned documents must match this query. + /// + /// Any returned documents must match this query. + /// /// public BoostingQueryDescriptor Positive(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query positive) { @@ -226,7 +248,12 @@ public BoostingQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public BoostingQueryDescriptor Boost(float? boost) { @@ -235,7 +262,9 @@ public BoostingQueryDescriptor Boost(float? boost) } /// - /// Query used to decrease the relevance score of matching documents. + /// + /// Query used to decrease the relevance score of matching documents. + /// /// public BoostingQueryDescriptor Negative(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query negative) { @@ -262,7 +291,9 @@ public BoostingQueryDescriptor Negative(Action - /// Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the `negative` query. + /// + /// Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the negative query. + /// /// public BoostingQueryDescriptor NegativeBoost(double negativeBoost) { @@ -271,7 +302,9 @@ public BoostingQueryDescriptor NegativeBoost(double negativeBoost) } /// - /// Any returned documents must match this query. + /// + /// Any returned documents must match this query. + /// /// public BoostingQueryDescriptor Positive(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query positive) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/CombinedFieldsQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/CombinedFieldsQuery.g.cs index 00c946f3058..5dd65d165b2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/CombinedFieldsQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/CombinedFieldsQuery.g.cs @@ -30,38 +30,54 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class CombinedFieldsQuery { /// - /// If true, match phrase queries are automatically created for multi-term synonyms. + /// + /// If true, match phrase queries are automatically created for multi-term synonyms. + /// /// [JsonInclude, JsonPropertyName("auto_generate_synonyms_phrase_query")] public bool? AutoGenerateSynonymsPhraseQuery { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// List of fields to search. Field wildcard patterns are allowed. Only `text` fields are supported, and they must all have the same search `analyzer`. + /// + /// List of fields to search. Field wildcard patterns are allowed. Only text fields are supported, and they must all have the same search analyzer. + /// /// [JsonInclude, JsonPropertyName("fields")] [JsonConverter(typeof(FieldsConverter))] public Elastic.Clients.Elasticsearch.Serverless.Fields Fields { get; set; } /// - /// Minimum number of clauses that must match for a document to be returned. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// /// [JsonInclude, JsonPropertyName("minimum_should_match")] public Elastic.Clients.Elasticsearch.Serverless.MinimumShouldMatch? MinimumShouldMatch { get; set; } /// - /// Boolean logic used to interpret text in the query value. + /// + /// Boolean logic used to interpret text in the query value. + /// /// [JsonInclude, JsonPropertyName("operator")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.CombinedFieldsOperator? Operator { get; set; } /// - /// Text to search for in the provided `fields`.
The `combined_fields` query analyzes the provided text before performing a search. + /// + /// Text to search for in the provided fields. + /// The combined_fields query analyzes the provided text before performing a search. + /// /// [JsonInclude, JsonPropertyName("query")] public string Query { get; set; } @@ -69,7 +85,9 @@ public sealed partial class CombinedFieldsQuery public string? QueryName { get; set; } /// - /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter. + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter. + /// /// [JsonInclude, JsonPropertyName("zero_terms_query")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.CombinedFieldsZeroTerms? ZeroTermsQuery { get; set; } @@ -95,7 +113,9 @@ public CombinedFieldsQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.CombinedFieldsZeroTerms? ZeroTermsQueryValue { get; set; } /// - /// If true, match phrase queries are automatically created for multi-term synonyms. + /// + /// If true, match phrase queries are automatically created for multi-term synonyms. + /// /// public CombinedFieldsQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSynonymsPhraseQuery = true) { @@ -104,7 +124,12 @@ public CombinedFieldsQueryDescriptor AutoGenerateSynonymsPhraseQuery( } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public CombinedFieldsQueryDescriptor Boost(float? boost) { @@ -113,7 +138,9 @@ public CombinedFieldsQueryDescriptor Boost(float? boost) } /// - /// List of fields to search. Field wildcard patterns are allowed. Only `text` fields are supported, and they must all have the same search `analyzer`. + /// + /// List of fields to search. Field wildcard patterns are allowed. Only text fields are supported, and they must all have the same search analyzer. + /// /// public CombinedFieldsQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Serverless.Fields fields) { @@ -122,7 +149,9 @@ public CombinedFieldsQueryDescriptor Fields(Elastic.Clients.Elasticse } /// - /// Minimum number of clauses that must match for a document to be returned. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// /// public CombinedFieldsQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.Serverless.MinimumShouldMatch? minimumShouldMatch) { @@ -131,7 +160,9 @@ public CombinedFieldsQueryDescriptor MinimumShouldMatch(Elastic.Clien } /// - /// Boolean logic used to interpret text in the query value. + /// + /// Boolean logic used to interpret text in the query value. + /// /// public CombinedFieldsQueryDescriptor Operator(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.CombinedFieldsOperator? value) { @@ -140,7 +171,10 @@ public CombinedFieldsQueryDescriptor Operator(Elastic.Clients.Elastic } /// - /// Text to search for in the provided `fields`.
The `combined_fields` query analyzes the provided text before performing a search. + /// + /// Text to search for in the provided fields. + /// The combined_fields query analyzes the provided text before performing a search. + /// /// public CombinedFieldsQueryDescriptor Query(string query) { @@ -155,7 +189,9 @@ public CombinedFieldsQueryDescriptor QueryName(string? queryName) } /// - /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter. + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter. + /// /// public CombinedFieldsQueryDescriptor ZeroTermsQuery(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.CombinedFieldsZeroTerms? zeroTermsQuery) { @@ -228,7 +264,9 @@ public CombinedFieldsQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.CombinedFieldsZeroTerms? ZeroTermsQueryValue { get; set; } /// - /// If true, match phrase queries are automatically created for multi-term synonyms. + /// + /// If true, match phrase queries are automatically created for multi-term synonyms. + /// /// public CombinedFieldsQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSynonymsPhraseQuery = true) { @@ -237,7 +275,12 @@ public CombinedFieldsQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoG } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public CombinedFieldsQueryDescriptor Boost(float? boost) { @@ -246,7 +289,9 @@ public CombinedFieldsQueryDescriptor Boost(float? boost) } /// - /// List of fields to search. Field wildcard patterns are allowed. Only `text` fields are supported, and they must all have the same search `analyzer`. + /// + /// List of fields to search. Field wildcard patterns are allowed. Only text fields are supported, and they must all have the same search analyzer. + /// /// public CombinedFieldsQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Serverless.Fields fields) { @@ -255,7 +300,9 @@ public CombinedFieldsQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Server } /// - /// Minimum number of clauses that must match for a document to be returned. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// /// public CombinedFieldsQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.Serverless.MinimumShouldMatch? minimumShouldMatch) { @@ -264,7 +311,9 @@ public CombinedFieldsQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elastics } /// - /// Boolean logic used to interpret text in the query value. + /// + /// Boolean logic used to interpret text in the query value. + /// /// public CombinedFieldsQueryDescriptor Operator(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.CombinedFieldsOperator? value) { @@ -273,7 +322,10 @@ public CombinedFieldsQueryDescriptor Operator(Elastic.Clients.Elasticsearch.Serv } /// - /// Text to search for in the provided `fields`.
The `combined_fields` query analyzes the provided text before performing a search. + /// + /// Text to search for in the provided fields. + /// The combined_fields query analyzes the provided text before performing a search. + /// /// public CombinedFieldsQueryDescriptor Query(string query) { @@ -288,7 +340,9 @@ public CombinedFieldsQueryDescriptor QueryName(string? queryName) } /// - /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter. + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter. + /// /// public CombinedFieldsQueryDescriptor ZeroTermsQuery(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.CombinedFieldsZeroTerms? zeroTermsQuery) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ConstantScoreQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ConstantScoreQuery.g.cs index bcb413eb1c3..9bc03ff0079 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ConstantScoreQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ConstantScoreQuery.g.cs @@ -30,13 +30,22 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class ConstantScoreQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Filter query you wish to run. Any returned documents must match this query.
Filter queries do not calculate relevance scores.
To speed up performance, Elasticsearch automatically caches frequently used filter queries. + /// + /// Filter query you wish to run. Any returned documents must match this query. + /// Filter queries do not calculate relevance scores. + /// To speed up performance, Elasticsearch automatically caches frequently used filter queries. + /// /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query Filter { get; set; } @@ -61,7 +70,12 @@ public ConstantScoreQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public ConstantScoreQueryDescriptor Boost(float? boost) { @@ -70,7 +84,11 @@ public ConstantScoreQueryDescriptor Boost(float? boost) } /// - /// Filter query you wish to run. Any returned documents must match this query.
Filter queries do not calculate relevance scores.
To speed up performance, Elasticsearch automatically caches frequently used filter queries. + /// + /// Filter query you wish to run. Any returned documents must match this query. + /// Filter queries do not calculate relevance scores. + /// To speed up performance, Elasticsearch automatically caches frequently used filter queries. + /// /// public ConstantScoreQueryDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query filter) { @@ -152,7 +170,12 @@ public ConstantScoreQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public ConstantScoreQueryDescriptor Boost(float? boost) { @@ -161,7 +184,11 @@ public ConstantScoreQueryDescriptor Boost(float? boost) } /// - /// Filter query you wish to run. Any returned documents must match this query.
Filter queries do not calculate relevance scores.
To speed up performance, Elasticsearch automatically caches frequently used filter queries. + /// + /// Filter query you wish to run. Any returned documents must match this query. + /// Filter queries do not calculate relevance scores. + /// To speed up performance, Elasticsearch automatically caches frequently used filter queries. + /// /// public ConstantScoreQueryDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query filter) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/DateDecayFunction.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/DateDecayFunction.g.cs index fdbc4cfbc58..b19c4540e0f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/DateDecayFunction.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/DateDecayFunction.g.cs @@ -85,7 +85,9 @@ public sealed partial class DateDecayFunction public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// + /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// /// public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.MultiValueMode? MultiValueMode { get; set; } public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.DecayPlacement Placement { get; set; } @@ -122,7 +124,9 @@ public DateDecayFunctionDescriptor Field(Expression - /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// + /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// /// public DateDecayFunctionDescriptor MultiValueMode(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.MultiValueMode? multiValueMode) { @@ -187,7 +191,9 @@ public DateDecayFunctionDescriptor Field(Expression - /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// + /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// /// public DateDecayFunctionDescriptor MultiValueMode(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.MultiValueMode? multiValueMode) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/DateDistanceFeatureQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/DateDistanceFeatureQuery.g.cs index 8aa3661bbb0..4acc19e3a1f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/DateDistanceFeatureQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/DateDistanceFeatureQuery.g.cs @@ -30,25 +30,43 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class DateDistanceFeatureQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Date or point of origin used to calculate distances.
If the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.
Date Math, such as `now-1h`, is supported.
If the field value is a `geo_point` field, the `origin` value must be a geopoint. + /// + /// Date or point of origin used to calculate distances. + /// If the field value is a date or date_nanos field, the origin value must be a date. + /// Date Math, such as now-1h, is supported. + /// If the field value is a geo_point field, the origin value must be a geopoint. + /// /// [JsonInclude, JsonPropertyName("origin")] public Elastic.Clients.Elasticsearch.Serverless.DateMath Origin { get; set; } /// - /// Distance from the `origin` at which relevance scores receive half of the `boost` value.
If the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`. + /// + /// Distance from the origin at which relevance scores receive half of the boost value. + /// If the field value is a date or date_nanos field, the pivot value must be a time unit, such as 1h or 10d. If the field value is a geo_point field, the pivot value must be a distance unit, such as 1km or 12m. + /// /// [JsonInclude, JsonPropertyName("pivot")] public Elastic.Clients.Elasticsearch.Serverless.Duration Pivot { get; set; } @@ -71,7 +89,12 @@ public DateDistanceFeatureQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public DateDistanceFeatureQueryDescriptor Boost(float? boost) { @@ -80,7 +103,12 @@ public DateDistanceFeatureQueryDescriptor Boost(float? boost) } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public DateDistanceFeatureQueryDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -89,7 +117,12 @@ public DateDistanceFeatureQueryDescriptor Field(Elastic.Clients.Elast } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public DateDistanceFeatureQueryDescriptor Field(Expression> field) { @@ -98,7 +131,12 @@ public DateDistanceFeatureQueryDescriptor Field(Expression - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public DateDistanceFeatureQueryDescriptor Field(Expression> field) { @@ -107,7 +145,12 @@ public DateDistanceFeatureQueryDescriptor Field(Expression - /// Date or point of origin used to calculate distances.
If the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.
Date Math, such as `now-1h`, is supported.
If the field value is a `geo_point` field, the `origin` value must be a geopoint. + /// + /// Date or point of origin used to calculate distances. + /// If the field value is a date or date_nanos field, the origin value must be a date. + /// Date Math, such as now-1h, is supported. + /// If the field value is a geo_point field, the origin value must be a geopoint. + /// /// public DateDistanceFeatureQueryDescriptor Origin(Elastic.Clients.Elasticsearch.Serverless.DateMath origin) { @@ -116,7 +159,10 @@ public DateDistanceFeatureQueryDescriptor Origin(Elastic.Clients.Elas } /// - /// Distance from the `origin` at which relevance scores receive half of the `boost` value.
If the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`. + /// + /// Distance from the origin at which relevance scores receive half of the boost value. + /// If the field value is a date or date_nanos field, the pivot value must be a time unit, such as 1h or 10d. If the field value is a geo_point field, the pivot value must be a distance unit, such as 1km or 12m. + /// /// public DateDistanceFeatureQueryDescriptor Pivot(Elastic.Clients.Elasticsearch.Serverless.Duration pivot) { @@ -170,7 +216,12 @@ public DateDistanceFeatureQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public DateDistanceFeatureQueryDescriptor Boost(float? boost) { @@ -179,7 +230,12 @@ public DateDistanceFeatureQueryDescriptor Boost(float? boost) } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public DateDistanceFeatureQueryDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -188,7 +244,12 @@ public DateDistanceFeatureQueryDescriptor Field(Elastic.Clients.Elasticsearch.Se } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public DateDistanceFeatureQueryDescriptor Field(Expression> field) { @@ -197,7 +258,12 @@ public DateDistanceFeatureQueryDescriptor Field(Expression - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public DateDistanceFeatureQueryDescriptor Field(Expression> field) { @@ -206,7 +272,12 @@ public DateDistanceFeatureQueryDescriptor Field(Expression - /// Date or point of origin used to calculate distances.
If the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.
Date Math, such as `now-1h`, is supported.
If the field value is a `geo_point` field, the `origin` value must be a geopoint. + /// + /// Date or point of origin used to calculate distances. + /// If the field value is a date or date_nanos field, the origin value must be a date. + /// Date Math, such as now-1h, is supported. + /// If the field value is a geo_point field, the origin value must be a geopoint. + /// /// public DateDistanceFeatureQueryDescriptor Origin(Elastic.Clients.Elasticsearch.Serverless.DateMath origin) { @@ -215,7 +286,10 @@ public DateDistanceFeatureQueryDescriptor Origin(Elastic.Clients.Elasticsearch.S } /// - /// Distance from the `origin` at which relevance scores receive half of the `boost` value.
If the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`. + /// + /// Distance from the origin at which relevance scores receive half of the boost value. + /// If the field value is a date or date_nanos field, the pivot value must be a time unit, such as 1h or 10d. If the field value is a geo_point field, the pivot value must be a distance unit, such as 1km or 12m. + /// /// public DateDistanceFeatureQueryDescriptor Pivot(Elastic.Clients.Elasticsearch.Serverless.Duration pivot) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/DateRangeQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/DateRangeQuery.g.cs index 26e06b85255..883b305c719 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/DateRangeQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/DateRangeQuery.g.cs @@ -205,45 +205,64 @@ public DateRangeQuery(Elastic.Clients.Elasticsearch.Serverless.Field field) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Date format used to convert `date` values in the query. + /// + /// Date format used to convert date values in the query. + /// /// public string? Format { get; set; } public Elastic.Clients.Elasticsearch.Serverless.DateMath? From { get; set; } /// - /// Greater than. + /// + /// Greater than. + /// /// public Elastic.Clients.Elasticsearch.Serverless.DateMath? Gt { get; set; } /// - /// Greater than or equal to. + /// + /// Greater than or equal to. + /// /// public Elastic.Clients.Elasticsearch.Serverless.DateMath? Gte { get; set; } /// - /// Less than. + /// + /// Less than. + /// /// public Elastic.Clients.Elasticsearch.Serverless.DateMath? Lt { get; set; } /// - /// Less than or equal to. + /// + /// Less than or equal to. + /// /// public Elastic.Clients.Elasticsearch.Serverless.DateMath? Lte { get; set; } public string? QueryName { get; set; } /// - /// Indicates how the range query matches values for `range` fields. + /// + /// Indicates how the range query matches values for range fields. + /// /// public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RangeRelation? Relation { get; set; } /// - /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC. + /// + /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query to UTC. + /// /// public string? TimeZone { get; set; } public Elastic.Clients.Elasticsearch.Serverless.DateMath? To { get; set; } @@ -271,7 +290,12 @@ public DateRangeQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.DateMath? ToValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public DateRangeQueryDescriptor Boost(float? boost) { @@ -298,7 +322,9 @@ public DateRangeQueryDescriptor Field(Expression - /// Date format used to convert `date` values in the query. + /// + /// Date format used to convert date values in the query. + /// /// public DateRangeQueryDescriptor Format(string? format) { @@ -313,7 +339,9 @@ public DateRangeQueryDescriptor From(Elastic.Clients.Elasticsearch.Se } /// - /// Greater than. + /// + /// Greater than. + /// /// public DateRangeQueryDescriptor Gt(Elastic.Clients.Elasticsearch.Serverless.DateMath? gt) { @@ -322,7 +350,9 @@ public DateRangeQueryDescriptor Gt(Elastic.Clients.Elasticsearch.Serv } /// - /// Greater than or equal to. + /// + /// Greater than or equal to. + /// /// public DateRangeQueryDescriptor Gte(Elastic.Clients.Elasticsearch.Serverless.DateMath? gte) { @@ -331,7 +361,9 @@ public DateRangeQueryDescriptor Gte(Elastic.Clients.Elasticsearch.Ser } /// - /// Less than. + /// + /// Less than. + /// /// public DateRangeQueryDescriptor Lt(Elastic.Clients.Elasticsearch.Serverless.DateMath? lt) { @@ -340,7 +372,9 @@ public DateRangeQueryDescriptor Lt(Elastic.Clients.Elasticsearch.Serv } /// - /// Less than or equal to. + /// + /// Less than or equal to. + /// /// public DateRangeQueryDescriptor Lte(Elastic.Clients.Elasticsearch.Serverless.DateMath? lte) { @@ -355,7 +389,9 @@ public DateRangeQueryDescriptor QueryName(string? queryName) } /// - /// Indicates how the range query matches values for `range` fields. + /// + /// Indicates how the range query matches values for range fields. + /// /// public DateRangeQueryDescriptor Relation(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RangeRelation? relation) { @@ -364,7 +400,9 @@ public DateRangeQueryDescriptor Relation(Elastic.Clients.Elasticsearc } /// - /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC. + /// + /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query to UTC. + /// /// public DateRangeQueryDescriptor TimeZone(string? timeZone) { @@ -478,7 +516,12 @@ public DateRangeQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.DateMath? ToValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public DateRangeQueryDescriptor Boost(float? boost) { @@ -505,7 +548,9 @@ public DateRangeQueryDescriptor Field(Expression - /// Date format used to convert `date` values in the query. + /// + /// Date format used to convert date values in the query. + /// /// public DateRangeQueryDescriptor Format(string? format) { @@ -520,7 +565,9 @@ public DateRangeQueryDescriptor From(Elastic.Clients.Elasticsearch.Serverless.Da } /// - /// Greater than. + /// + /// Greater than. + /// /// public DateRangeQueryDescriptor Gt(Elastic.Clients.Elasticsearch.Serverless.DateMath? gt) { @@ -529,7 +576,9 @@ public DateRangeQueryDescriptor Gt(Elastic.Clients.Elasticsearch.Serverless.Date } /// - /// Greater than or equal to. + /// + /// Greater than or equal to. + /// /// public DateRangeQueryDescriptor Gte(Elastic.Clients.Elasticsearch.Serverless.DateMath? gte) { @@ -538,7 +587,9 @@ public DateRangeQueryDescriptor Gte(Elastic.Clients.Elasticsearch.Serverless.Dat } /// - /// Less than. + /// + /// Less than. + /// /// public DateRangeQueryDescriptor Lt(Elastic.Clients.Elasticsearch.Serverless.DateMath? lt) { @@ -547,7 +598,9 @@ public DateRangeQueryDescriptor Lt(Elastic.Clients.Elasticsearch.Serverless.Date } /// - /// Less than or equal to. + /// + /// Less than or equal to. + /// /// public DateRangeQueryDescriptor Lte(Elastic.Clients.Elasticsearch.Serverless.DateMath? lte) { @@ -562,7 +615,9 @@ public DateRangeQueryDescriptor QueryName(string? queryName) } /// - /// Indicates how the range query matches values for `range` fields. + /// + /// Indicates how the range query matches values for range fields. + /// /// public DateRangeQueryDescriptor Relation(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RangeRelation? relation) { @@ -571,7 +626,9 @@ public DateRangeQueryDescriptor Relation(Elastic.Clients.Elasticsearch.Serverles } /// - /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC. + /// + /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query to UTC. + /// /// public DateRangeQueryDescriptor TimeZone(string? timeZone) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/DecayPlacement.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/DecayPlacement.g.cs index 464bf430d7d..52c7faaa5d7 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/DecayPlacement.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/DecayPlacement.g.cs @@ -30,27 +30,35 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class DecayPlacement { /// - /// Defines how documents are scored at the distance given at scale. + /// + /// Defines how documents are scored at the distance given at scale. + /// /// [JsonInclude, JsonPropertyName("decay")] public double? Decay { get; set; } /// - /// If defined, the decay function will only compute the decay function for documents with a distance greater than the defined `offset`. + /// + /// If defined, the decay function will only compute the decay function for documents with a distance greater than the defined offset. + /// /// [JsonInclude, JsonPropertyName("offset")] [SourceConverter] public TScale? Offset { get; set; } /// - /// The point of origin used for calculating distance. Must be given as a number for numeric field, date for date fields and geo point for geo fields. + /// + /// The point of origin used for calculating distance. Must be given as a number for numeric field, date for date fields and geo point for geo fields. + /// /// [JsonInclude, JsonPropertyName("origin")] [SourceConverter] public TOrigin? Origin { get; set; } /// - /// Defines the distance from origin + offset at which the computed score will equal `decay` parameter. + /// + /// Defines the distance from origin + offset at which the computed score will equal decay parameter. + /// /// [JsonInclude, JsonPropertyName("scale")] [SourceConverter] diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/DisMaxQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/DisMaxQuery.g.cs index 6d5026d4349..915e9e2b250 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/DisMaxQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/DisMaxQuery.g.cs @@ -30,13 +30,22 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class DisMaxQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// One or more query clauses.
Returned documents must match one or more of these queries.
If a document matches multiple queries, Elasticsearch uses the highest relevance score. + /// + /// One or more query clauses. + /// Returned documents must match one or more of these queries. + /// If a document matches multiple queries, Elasticsearch uses the highest relevance score. + /// /// [JsonInclude, JsonPropertyName("queries")] public ICollection Queries { get; set; } @@ -44,7 +53,9 @@ public sealed partial class DisMaxQuery public string? QueryName { get; set; } /// - /// Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses. + /// + /// Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses. + /// /// [JsonInclude, JsonPropertyName("tie_breaker")] public double? TieBreaker { get; set; } @@ -69,7 +80,12 @@ public DisMaxQueryDescriptor() : base() private double? TieBreakerValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public DisMaxQueryDescriptor Boost(float? boost) { @@ -78,7 +94,11 @@ public DisMaxQueryDescriptor Boost(float? boost) } /// - /// One or more query clauses.
Returned documents must match one or more of these queries.
If a document matches multiple queries, Elasticsearch uses the highest relevance score. + /// + /// One or more query clauses. + /// Returned documents must match one or more of these queries. + /// If a document matches multiple queries, Elasticsearch uses the highest relevance score. + /// /// public DisMaxQueryDescriptor Queries(ICollection queries) { @@ -123,7 +143,9 @@ public DisMaxQueryDescriptor QueryName(string? queryName) } /// - /// Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses. + /// + /// Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses. + /// /// public DisMaxQueryDescriptor TieBreaker(double? tieBreaker) { @@ -204,7 +226,12 @@ public DisMaxQueryDescriptor() : base() private double? TieBreakerValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public DisMaxQueryDescriptor Boost(float? boost) { @@ -213,7 +240,11 @@ public DisMaxQueryDescriptor Boost(float? boost) } /// - /// One or more query clauses.
Returned documents must match one or more of these queries.
If a document matches multiple queries, Elasticsearch uses the highest relevance score. + /// + /// One or more query clauses. + /// Returned documents must match one or more of these queries. + /// If a document matches multiple queries, Elasticsearch uses the highest relevance score. + /// /// public DisMaxQueryDescriptor Queries(ICollection queries) { @@ -258,7 +289,9 @@ public DisMaxQueryDescriptor QueryName(string? queryName) } /// - /// Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses. + /// + /// Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses. + /// /// public DisMaxQueryDescriptor TieBreaker(double? tieBreaker) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ExistsQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ExistsQuery.g.cs index e03da878d74..568678bc110 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ExistsQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ExistsQuery.g.cs @@ -30,13 +30,20 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class ExistsQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Name of the field you wish to search. + /// + /// Name of the field you wish to search. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } @@ -59,7 +66,12 @@ public ExistsQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public ExistsQueryDescriptor Boost(float? boost) { @@ -68,7 +80,9 @@ public ExistsQueryDescriptor Boost(float? boost) } /// - /// Name of the field you wish to search. + /// + /// Name of the field you wish to search. + /// /// public ExistsQueryDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -77,7 +91,9 @@ public ExistsQueryDescriptor Field(Elastic.Clients.Elasticsearch.Serv } /// - /// Name of the field you wish to search. + /// + /// Name of the field you wish to search. + /// /// public ExistsQueryDescriptor Field(Expression> field) { @@ -86,7 +102,9 @@ public ExistsQueryDescriptor Field(Expression - /// Name of the field you wish to search. + /// + /// Name of the field you wish to search. + /// /// public ExistsQueryDescriptor Field(Expression> field) { @@ -134,7 +152,12 @@ public ExistsQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public ExistsQueryDescriptor Boost(float? boost) { @@ -143,7 +166,9 @@ public ExistsQueryDescriptor Boost(float? boost) } /// - /// Name of the field you wish to search. + /// + /// Name of the field you wish to search. + /// /// public ExistsQueryDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -152,7 +177,9 @@ public ExistsQueryDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Fiel } /// - /// Name of the field you wish to search. + /// + /// Name of the field you wish to search. + /// /// public ExistsQueryDescriptor Field(Expression> field) { @@ -161,7 +188,9 @@ public ExistsQueryDescriptor Field(Expression - /// Name of the field you wish to search. + /// + /// Name of the field you wish to search. + /// /// public ExistsQueryDescriptor Field(Expression> field) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/FieldAndFormat.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/FieldAndFormat.g.cs index 26e1bce8da8..65dd5cedf73 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/FieldAndFormat.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/FieldAndFormat.g.cs @@ -28,18 +28,24 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; /// -/// A reference to a field with formatting instructions on how to return the value +/// +/// A reference to a field with formatting instructions on how to return the value +/// /// public sealed partial class FieldAndFormat { /// - /// Wildcard pattern. The request returns values for field names matching this pattern. + /// + /// Wildcard pattern. The request returns values for field names matching this pattern. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Format in which the values are returned. + /// + /// Format in which the values are returned. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } @@ -48,7 +54,9 @@ public sealed partial class FieldAndFormat } /// -/// A reference to a field with formatting instructions on how to return the value +/// +/// A reference to a field with formatting instructions on how to return the value +/// /// public sealed partial class FieldAndFormatDescriptor : SerializableDescriptor> { @@ -63,7 +71,9 @@ public FieldAndFormatDescriptor() : base() private bool? IncludeUnmappedValue { get; set; } /// - /// Wildcard pattern. The request returns values for field names matching this pattern. + /// + /// Wildcard pattern. The request returns values for field names matching this pattern. + /// /// public FieldAndFormatDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -72,7 +82,9 @@ public FieldAndFormatDescriptor Field(Elastic.Clients.Elasticsearch.S } /// - /// Wildcard pattern. The request returns values for field names matching this pattern. + /// + /// Wildcard pattern. The request returns values for field names matching this pattern. + /// /// public FieldAndFormatDescriptor Field(Expression> field) { @@ -81,7 +93,9 @@ public FieldAndFormatDescriptor Field(Expression - /// Wildcard pattern. The request returns values for field names matching this pattern. + /// + /// Wildcard pattern. The request returns values for field names matching this pattern. + /// /// public FieldAndFormatDescriptor Field(Expression> field) { @@ -90,7 +104,9 @@ public FieldAndFormatDescriptor Field(Expression - /// Format in which the values are returned. + /// + /// Format in which the values are returned. + /// /// public FieldAndFormatDescriptor Format(string? format) { @@ -126,7 +142,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// A reference to a field with formatting instructions on how to return the value +/// +/// A reference to a field with formatting instructions on how to return the value +/// /// public sealed partial class FieldAndFormatDescriptor : SerializableDescriptor { @@ -141,7 +159,9 @@ public FieldAndFormatDescriptor() : base() private bool? IncludeUnmappedValue { get; set; } /// - /// Wildcard pattern. The request returns values for field names matching this pattern. + /// + /// Wildcard pattern. The request returns values for field names matching this pattern. + /// /// public FieldAndFormatDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -150,7 +170,9 @@ public FieldAndFormatDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.F } /// - /// Wildcard pattern. The request returns values for field names matching this pattern. + /// + /// Wildcard pattern. The request returns values for field names matching this pattern. + /// /// public FieldAndFormatDescriptor Field(Expression> field) { @@ -159,7 +181,9 @@ public FieldAndFormatDescriptor Field(Expression - /// Wildcard pattern. The request returns values for field names matching this pattern. + /// + /// Wildcard pattern. The request returns values for field names matching this pattern. + /// /// public FieldAndFormatDescriptor Field(Expression> field) { @@ -168,7 +192,9 @@ public FieldAndFormatDescriptor Field(Expression - /// Format in which the values are returned. + /// + /// Format in which the values are returned. + /// /// public FieldAndFormatDescriptor Format(string? format) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/FieldLookup.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/FieldLookup.g.cs index b6cdd8f2c6a..6a56a71ad59 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/FieldLookup.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/FieldLookup.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class FieldLookup { /// - /// `id` of the document. + /// + /// id of the document. + /// /// [JsonInclude, JsonPropertyName("id")] public Elastic.Clients.Elasticsearch.Serverless.Id Id { get; set; } /// - /// Index from which to retrieve the document. + /// + /// Index from which to retrieve the document. + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.Serverless.IndexName? Index { get; set; } /// - /// Name of the field. + /// + /// Name of the field. + /// /// [JsonInclude, JsonPropertyName("path")] public Elastic.Clients.Elasticsearch.Serverless.Field? Path { get; set; } /// - /// Custom routing value. + /// + /// Custom routing value. + /// /// [JsonInclude, JsonPropertyName("routing")] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get; set; } @@ -68,7 +76,9 @@ public FieldLookupDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Routing? RoutingValue { get; set; } /// - /// `id` of the document. + /// + /// id of the document. + /// /// public FieldLookupDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id id) { @@ -77,7 +87,9 @@ public FieldLookupDescriptor Id(Elastic.Clients.Elasticsearch.Serverl } /// - /// Index from which to retrieve the document. + /// + /// Index from which to retrieve the document. + /// /// public FieldLookupDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.IndexName? index) { @@ -86,7 +98,9 @@ public FieldLookupDescriptor Index(Elastic.Clients.Elasticsearch.Serv } /// - /// Name of the field. + /// + /// Name of the field. + /// /// public FieldLookupDescriptor Path(Elastic.Clients.Elasticsearch.Serverless.Field? path) { @@ -95,7 +109,9 @@ public FieldLookupDescriptor Path(Elastic.Clients.Elasticsearch.Serve } /// - /// Name of the field. + /// + /// Name of the field. + /// /// public FieldLookupDescriptor Path(Expression> path) { @@ -104,7 +120,9 @@ public FieldLookupDescriptor Path(Expression - /// Name of the field. + /// + /// Name of the field. + /// /// public FieldLookupDescriptor Path(Expression> path) { @@ -113,7 +131,9 @@ public FieldLookupDescriptor Path(Expression> } /// - /// Custom routing value. + /// + /// Custom routing value. + /// /// public FieldLookupDescriptor Routing(Elastic.Clients.Elasticsearch.Serverless.Routing? routing) { @@ -162,7 +182,9 @@ public FieldLookupDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Routing? RoutingValue { get; set; } /// - /// `id` of the document. + /// + /// id of the document. + /// /// public FieldLookupDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id id) { @@ -171,7 +193,9 @@ public FieldLookupDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id id) } /// - /// Index from which to retrieve the document. + /// + /// Index from which to retrieve the document. + /// /// public FieldLookupDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.IndexName? index) { @@ -180,7 +204,9 @@ public FieldLookupDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.Inde } /// - /// Name of the field. + /// + /// Name of the field. + /// /// public FieldLookupDescriptor Path(Elastic.Clients.Elasticsearch.Serverless.Field? path) { @@ -189,7 +215,9 @@ public FieldLookupDescriptor Path(Elastic.Clients.Elasticsearch.Serverless.Field } /// - /// Name of the field. + /// + /// Name of the field. + /// /// public FieldLookupDescriptor Path(Expression> path) { @@ -198,7 +226,9 @@ public FieldLookupDescriptor Path(Expression - /// Name of the field. + /// + /// Name of the field. + /// /// public FieldLookupDescriptor Path(Expression> path) { @@ -207,7 +237,9 @@ public FieldLookupDescriptor Path(Expression> } /// - /// Custom routing value. + /// + /// Custom routing value. + /// /// public FieldLookupDescriptor Routing(Elastic.Clients.Elasticsearch.Serverless.Routing? routing) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/FieldValueFactorScoreFunction.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/FieldValueFactorScoreFunction.g.cs index 89a20843b88..edffcb2d5b2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/FieldValueFactorScoreFunction.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/FieldValueFactorScoreFunction.g.cs @@ -30,25 +30,34 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class FieldValueFactorScoreFunction { /// - /// Optional factor to multiply the field value with. + /// + /// Optional factor to multiply the field value with. + /// /// [JsonInclude, JsonPropertyName("factor")] public double? Factor { get; set; } /// - /// Field to be extracted from the document. + /// + /// Field to be extracted from the document. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Value used if the document doesn’t have that field.
The modifier and factor are still applied to it as though it were read from the document. + /// + /// Value used if the document doesn’t have that field. + /// The modifier and factor are still applied to it as though it were read from the document. + /// /// [JsonInclude, JsonPropertyName("missing")] public double? Missing { get; set; } /// - /// Modifier to apply to the field value. + /// + /// Modifier to apply to the field value. + /// /// [JsonInclude, JsonPropertyName("modifier")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.FieldValueFactorModifier? Modifier { get; set; } @@ -70,7 +79,9 @@ public FieldValueFactorScoreFunctionDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.FieldValueFactorModifier? ModifierValue { get; set; } /// - /// Optional factor to multiply the field value with. + /// + /// Optional factor to multiply the field value with. + /// /// public FieldValueFactorScoreFunctionDescriptor Factor(double? factor) { @@ -79,7 +90,9 @@ public FieldValueFactorScoreFunctionDescriptor Factor(double? factor) } /// - /// Field to be extracted from the document. + /// + /// Field to be extracted from the document. + /// /// public FieldValueFactorScoreFunctionDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -88,7 +101,9 @@ public FieldValueFactorScoreFunctionDescriptor Field(Elastic.Clients. } /// - /// Field to be extracted from the document. + /// + /// Field to be extracted from the document. + /// /// public FieldValueFactorScoreFunctionDescriptor Field(Expression> field) { @@ -97,7 +112,9 @@ public FieldValueFactorScoreFunctionDescriptor Field(Expressi } /// - /// Field to be extracted from the document. + /// + /// Field to be extracted from the document. + /// /// public FieldValueFactorScoreFunctionDescriptor Field(Expression> field) { @@ -106,7 +123,10 @@ public FieldValueFactorScoreFunctionDescriptor Field(Expression - /// Value used if the document doesn’t have that field.
The modifier and factor are still applied to it as though it were read from the document. + /// + /// Value used if the document doesn’t have that field. + /// The modifier and factor are still applied to it as though it were read from the document. + /// /// public FieldValueFactorScoreFunctionDescriptor Missing(double? missing) { @@ -115,7 +135,9 @@ public FieldValueFactorScoreFunctionDescriptor Missing(double? missin } /// - /// Modifier to apply to the field value. + /// + /// Modifier to apply to the field value. + /// /// public FieldValueFactorScoreFunctionDescriptor Modifier(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.FieldValueFactorModifier? modifier) { @@ -164,7 +186,9 @@ public FieldValueFactorScoreFunctionDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.FieldValueFactorModifier? ModifierValue { get; set; } /// - /// Optional factor to multiply the field value with. + /// + /// Optional factor to multiply the field value with. + /// /// public FieldValueFactorScoreFunctionDescriptor Factor(double? factor) { @@ -173,7 +197,9 @@ public FieldValueFactorScoreFunctionDescriptor Factor(double? factor) } /// - /// Field to be extracted from the document. + /// + /// Field to be extracted from the document. + /// /// public FieldValueFactorScoreFunctionDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -182,7 +208,9 @@ public FieldValueFactorScoreFunctionDescriptor Field(Elastic.Clients.Elasticsear } /// - /// Field to be extracted from the document. + /// + /// Field to be extracted from the document. + /// /// public FieldValueFactorScoreFunctionDescriptor Field(Expression> field) { @@ -191,7 +219,9 @@ public FieldValueFactorScoreFunctionDescriptor Field(Expressi } /// - /// Field to be extracted from the document. + /// + /// Field to be extracted from the document. + /// /// public FieldValueFactorScoreFunctionDescriptor Field(Expression> field) { @@ -200,7 +230,10 @@ public FieldValueFactorScoreFunctionDescriptor Field(Expression - /// Value used if the document doesn’t have that field.
The modifier and factor are still applied to it as though it were read from the document. + /// + /// Value used if the document doesn’t have that field. + /// The modifier and factor are still applied to it as though it were read from the document. + /// /// public FieldValueFactorScoreFunctionDescriptor Missing(double? missing) { @@ -209,7 +242,9 @@ public FieldValueFactorScoreFunctionDescriptor Missing(double? missing) } /// - /// Modifier to apply to the field value. + /// + /// Modifier to apply to the field value. + /// /// public FieldValueFactorScoreFunctionDescriptor Modifier(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.FieldValueFactorModifier? modifier) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/FunctionScoreQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/FunctionScoreQuery.g.cs index 903aa6c499d..d77b5de10da 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/FunctionScoreQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/FunctionScoreQuery.g.cs @@ -30,37 +30,52 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class FunctionScoreQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Defines how he newly computed score is combined with the score of the query + /// + /// Defines how he newly computed score is combined with the score of the query + /// /// [JsonInclude, JsonPropertyName("boost_mode")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.FunctionBoostMode? BoostMode { get; set; } /// - /// One or more functions that compute a new score for each document returned by the query. + /// + /// One or more functions that compute a new score for each document returned by the query. + /// /// [JsonInclude, JsonPropertyName("functions")] public ICollection? Functions { get; set; } /// - /// Restricts the new score to not exceed the provided limit. + /// + /// Restricts the new score to not exceed the provided limit. + /// /// [JsonInclude, JsonPropertyName("max_boost")] public double? MaxBoost { get; set; } /// - /// Excludes documents that do not meet the provided score threshold. + /// + /// Excludes documents that do not meet the provided score threshold. + /// /// [JsonInclude, JsonPropertyName("min_score")] public double? MinScore { get; set; } /// - /// A query that determines the documents for which a new score is computed. + /// + /// A query that determines the documents for which a new score is computed. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? Query { get; set; } @@ -68,7 +83,9 @@ public sealed partial class FunctionScoreQuery public string? QueryName { get; set; } /// - /// Specifies how the computed scores are combined + /// + /// Specifies how the computed scores are combined + /// /// [JsonInclude, JsonPropertyName("score_mode")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.FunctionScoreMode? ScoreMode { get; set; } @@ -99,7 +116,12 @@ public FunctionScoreQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.FunctionScoreMode? ScoreModeValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public FunctionScoreQueryDescriptor Boost(float? boost) { @@ -108,7 +130,9 @@ public FunctionScoreQueryDescriptor Boost(float? boost) } /// - /// Defines how he newly computed score is combined with the score of the query + /// + /// Defines how he newly computed score is combined with the score of the query + /// /// public FunctionScoreQueryDescriptor BoostMode(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.FunctionBoostMode? boostMode) { @@ -117,7 +141,9 @@ public FunctionScoreQueryDescriptor BoostMode(Elastic.Clients.Elastic } /// - /// One or more functions that compute a new score for each document returned by the query. + /// + /// One or more functions that compute a new score for each document returned by the query. + /// /// public FunctionScoreQueryDescriptor Functions(ICollection? functions) { @@ -156,7 +182,9 @@ public FunctionScoreQueryDescriptor Functions(params Action - /// Restricts the new score to not exceed the provided limit. + /// + /// Restricts the new score to not exceed the provided limit. + /// /// public FunctionScoreQueryDescriptor MaxBoost(double? maxBoost) { @@ -165,7 +193,9 @@ public FunctionScoreQueryDescriptor MaxBoost(double? maxBoost) } /// - /// Excludes documents that do not meet the provided score threshold. + /// + /// Excludes documents that do not meet the provided score threshold. + /// /// public FunctionScoreQueryDescriptor MinScore(double? minScore) { @@ -174,7 +204,9 @@ public FunctionScoreQueryDescriptor MinScore(double? minScore) } /// - /// A query that determines the documents for which a new score is computed. + /// + /// A query that determines the documents for which a new score is computed. + /// /// public FunctionScoreQueryDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -207,7 +239,9 @@ public FunctionScoreQueryDescriptor QueryName(string? queryName) } /// - /// Specifies how the computed scores are combined + /// + /// Specifies how the computed scores are combined + /// /// public FunctionScoreQueryDescriptor ScoreMode(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.FunctionScoreMode? scoreMode) { @@ -328,7 +362,12 @@ public FunctionScoreQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.FunctionScoreMode? ScoreModeValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public FunctionScoreQueryDescriptor Boost(float? boost) { @@ -337,7 +376,9 @@ public FunctionScoreQueryDescriptor Boost(float? boost) } /// - /// Defines how he newly computed score is combined with the score of the query + /// + /// Defines how he newly computed score is combined with the score of the query + /// /// public FunctionScoreQueryDescriptor BoostMode(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.FunctionBoostMode? boostMode) { @@ -346,7 +387,9 @@ public FunctionScoreQueryDescriptor BoostMode(Elastic.Clients.Elasticsearch.Serv } /// - /// One or more functions that compute a new score for each document returned by the query. + /// + /// One or more functions that compute a new score for each document returned by the query. + /// /// public FunctionScoreQueryDescriptor Functions(ICollection? functions) { @@ -385,7 +428,9 @@ public FunctionScoreQueryDescriptor Functions(params Action - /// Restricts the new score to not exceed the provided limit. + /// + /// Restricts the new score to not exceed the provided limit. + /// /// public FunctionScoreQueryDescriptor MaxBoost(double? maxBoost) { @@ -394,7 +439,9 @@ public FunctionScoreQueryDescriptor MaxBoost(double? maxBoost) } /// - /// Excludes documents that do not meet the provided score threshold. + /// + /// Excludes documents that do not meet the provided score threshold. + /// /// public FunctionScoreQueryDescriptor MinScore(double? minScore) { @@ -403,7 +450,9 @@ public FunctionScoreQueryDescriptor MinScore(double? minScore) } /// - /// A query that determines the documents for which a new score is computed. + /// + /// A query that determines the documents for which a new score is computed. + /// /// public FunctionScoreQueryDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -436,7 +485,9 @@ public FunctionScoreQueryDescriptor QueryName(string? queryName) } /// - /// Specifies how the computed scores are combined + /// + /// Specifies how the computed scores are combined + /// /// public FunctionScoreQueryDescriptor ScoreMode(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.FunctionScoreMode? scoreMode) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/FuzzyQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/FuzzyQuery.g.cs index a46c0b00b63..634c9f48cf2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/FuzzyQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/FuzzyQuery.g.cs @@ -165,39 +165,56 @@ public FuzzyQuery(Elastic.Clients.Elasticsearch.Serverless.Field field) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Maximum edit distance allowed for matching. + /// + /// Maximum edit distance allowed for matching. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fuzziness? Fuzziness { get; set; } /// - /// Maximum number of variations created. + /// + /// Maximum number of variations created. + /// /// public int? MaxExpansions { get; set; } /// - /// Number of beginning characters left unchanged when creating expansions. + /// + /// Number of beginning characters left unchanged when creating expansions. + /// /// public int? PrefixLength { get; set; } public string? QueryName { get; set; } /// - /// Number of beginning characters left unchanged when creating expansions. + /// + /// Number of beginning characters left unchanged when creating expansions. + /// /// public string? Rewrite { get; set; } /// - /// Indicates whether edits include transpositions of two adjacent characters (for example `ab` to `ba`). + /// + /// Indicates whether edits include transpositions of two adjacent characters (for example ab to ba). + /// /// public bool? Transpositions { get; set; } /// - /// Term you wish to find in the provided field. + /// + /// Term you wish to find in the provided field. + /// /// public object Value { get; set; } @@ -223,7 +240,12 @@ public FuzzyQueryDescriptor() : base() private object ValueValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public FuzzyQueryDescriptor Boost(float? boost) { @@ -250,7 +272,9 @@ public FuzzyQueryDescriptor Field(Expression> } /// - /// Maximum edit distance allowed for matching. + /// + /// Maximum edit distance allowed for matching. + /// /// public FuzzyQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Serverless.Fuzziness? fuzziness) { @@ -259,7 +283,9 @@ public FuzzyQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.S } /// - /// Maximum number of variations created. + /// + /// Maximum number of variations created. + /// /// public FuzzyQueryDescriptor MaxExpansions(int? maxExpansions) { @@ -268,7 +294,9 @@ public FuzzyQueryDescriptor MaxExpansions(int? maxExpansions) } /// - /// Number of beginning characters left unchanged when creating expansions. + /// + /// Number of beginning characters left unchanged when creating expansions. + /// /// public FuzzyQueryDescriptor PrefixLength(int? prefixLength) { @@ -283,7 +311,9 @@ public FuzzyQueryDescriptor QueryName(string? queryName) } /// - /// Number of beginning characters left unchanged when creating expansions. + /// + /// Number of beginning characters left unchanged when creating expansions. + /// /// public FuzzyQueryDescriptor Rewrite(string? rewrite) { @@ -292,7 +322,9 @@ public FuzzyQueryDescriptor Rewrite(string? rewrite) } /// - /// Indicates whether edits include transpositions of two adjacent characters (for example `ab` to `ba`). + /// + /// Indicates whether edits include transpositions of two adjacent characters (for example ab to ba). + /// /// public FuzzyQueryDescriptor Transpositions(bool? transpositions = true) { @@ -301,7 +333,9 @@ public FuzzyQueryDescriptor Transpositions(bool? transpositions = tru } /// - /// Term you wish to find in the provided field. + /// + /// Term you wish to find in the provided field. + /// /// public FuzzyQueryDescriptor Value(object value) { @@ -384,7 +418,12 @@ public FuzzyQueryDescriptor() : base() private object ValueValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public FuzzyQueryDescriptor Boost(float? boost) { @@ -411,7 +450,9 @@ public FuzzyQueryDescriptor Field(Expression> } /// - /// Maximum edit distance allowed for matching. + /// + /// Maximum edit distance allowed for matching. + /// /// public FuzzyQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Serverless.Fuzziness? fuzziness) { @@ -420,7 +461,9 @@ public FuzzyQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Serverless.F } /// - /// Maximum number of variations created. + /// + /// Maximum number of variations created. + /// /// public FuzzyQueryDescriptor MaxExpansions(int? maxExpansions) { @@ -429,7 +472,9 @@ public FuzzyQueryDescriptor MaxExpansions(int? maxExpansions) } /// - /// Number of beginning characters left unchanged when creating expansions. + /// + /// Number of beginning characters left unchanged when creating expansions. + /// /// public FuzzyQueryDescriptor PrefixLength(int? prefixLength) { @@ -444,7 +489,9 @@ public FuzzyQueryDescriptor QueryName(string? queryName) } /// - /// Number of beginning characters left unchanged when creating expansions. + /// + /// Number of beginning characters left unchanged when creating expansions. + /// /// public FuzzyQueryDescriptor Rewrite(string? rewrite) { @@ -453,7 +500,9 @@ public FuzzyQueryDescriptor Rewrite(string? rewrite) } /// - /// Indicates whether edits include transpositions of two adjacent characters (for example `ab` to `ba`). + /// + /// Indicates whether edits include transpositions of two adjacent characters (for example ab to ba). + /// /// public FuzzyQueryDescriptor Transpositions(bool? transpositions = true) { @@ -462,7 +511,9 @@ public FuzzyQueryDescriptor Transpositions(bool? transpositions = true) } /// - /// Term you wish to find in the provided field. + /// + /// Term you wish to find in the provided field. + /// /// public FuzzyQueryDescriptor Value(object value) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/GeoBoundingBoxQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/GeoBoundingBoxQuery.g.cs index 1ccd8c63653..3195a8c1898 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/GeoBoundingBoxQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/GeoBoundingBoxQuery.g.cs @@ -119,20 +119,31 @@ public override void Write(Utf8JsonWriter writer, GeoBoundingBoxQuery value, Jso public sealed partial class GeoBoundingBoxQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Serverless.GeoBounds BoundingBox { get; set; } public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Set to `true` to ignore an unmapped field and not match any documents for this query.
Set to `false` to throw an exception if the field is not mapped. + /// + /// Set to true to ignore an unmapped field and not match any documents for this query. + /// Set to false to throw an exception if the field is not mapped. + /// /// public bool? IgnoreUnmapped { get; set; } public string? QueryName { get; set; } /// - /// Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.
Set to `COERCE` to also try to infer correct latitude or longitude. + /// + /// Set to IGNORE_MALFORMED to accept geo points with invalid latitude or longitude. + /// Set to COERCE to also try to infer correct latitude or longitude. + /// /// public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.GeoValidationMethod? ValidationMethod { get; set; } @@ -155,7 +166,12 @@ public GeoBoundingBoxQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.GeoValidationMethod? ValidationMethodValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public GeoBoundingBoxQueryDescriptor Boost(float? boost) { @@ -188,7 +204,10 @@ public GeoBoundingBoxQueryDescriptor Field(Expression - /// Set to `true` to ignore an unmapped field and not match any documents for this query.
Set to `false` to throw an exception if the field is not mapped. + /// + /// Set to true to ignore an unmapped field and not match any documents for this query. + /// Set to false to throw an exception if the field is not mapped. + /// /// public GeoBoundingBoxQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { @@ -203,7 +222,10 @@ public GeoBoundingBoxQueryDescriptor QueryName(string? queryName) } /// - /// Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.
Set to `COERCE` to also try to infer correct latitude or longitude. + /// + /// Set to IGNORE_MALFORMED to accept geo points with invalid latitude or longitude. + /// Set to COERCE to also try to infer correct latitude or longitude. + /// /// public GeoBoundingBoxQueryDescriptor ValidationMethod(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.GeoValidationMethod? validationMethod) { @@ -265,7 +287,12 @@ public GeoBoundingBoxQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.GeoValidationMethod? ValidationMethodValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public GeoBoundingBoxQueryDescriptor Boost(float? boost) { @@ -298,7 +325,10 @@ public GeoBoundingBoxQueryDescriptor Field(Expression - /// Set to `true` to ignore an unmapped field and not match any documents for this query.
Set to `false` to throw an exception if the field is not mapped. + /// + /// Set to true to ignore an unmapped field and not match any documents for this query. + /// Set to false to throw an exception if the field is not mapped. + /// /// public GeoBoundingBoxQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { @@ -313,7 +343,10 @@ public GeoBoundingBoxQueryDescriptor QueryName(string? queryName) } /// - /// Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.
Set to `COERCE` to also try to infer correct latitude or longitude. + /// + /// Set to IGNORE_MALFORMED to accept geo points with invalid latitude or longitude. + /// Set to COERCE to also try to infer correct latitude or longitude. + /// /// public GeoBoundingBoxQueryDescriptor ValidationMethod(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.GeoValidationMethod? validationMethod) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/GeoDecayFunction.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/GeoDecayFunction.g.cs index 61704d7d419..6691e33a2f3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/GeoDecayFunction.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/GeoDecayFunction.g.cs @@ -85,7 +85,9 @@ public sealed partial class GeoDecayFunction public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// + /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// /// public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.MultiValueMode? MultiValueMode { get; set; } public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.DecayPlacement Placement { get; set; } @@ -122,7 +124,9 @@ public GeoDecayFunctionDescriptor Field(Expression - /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// + /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// /// public GeoDecayFunctionDescriptor MultiValueMode(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.MultiValueMode? multiValueMode) { @@ -187,7 +191,9 @@ public GeoDecayFunctionDescriptor Field(Expression - /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// + /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// /// public GeoDecayFunctionDescriptor MultiValueMode(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.MultiValueMode? multiValueMode) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/GeoDistanceFeatureQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/GeoDistanceFeatureQuery.g.cs index a7dd8fa562a..553ecc6bce7 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/GeoDistanceFeatureQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/GeoDistanceFeatureQuery.g.cs @@ -30,25 +30,43 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class GeoDistanceFeatureQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Date or point of origin used to calculate distances.
If the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.
Date Math, such as `now-1h`, is supported.
If the field value is a `geo_point` field, the `origin` value must be a geopoint. + /// + /// Date or point of origin used to calculate distances. + /// If the field value is a date or date_nanos field, the origin value must be a date. + /// Date Math, such as now-1h, is supported. + /// If the field value is a geo_point field, the origin value must be a geopoint. + /// /// [JsonInclude, JsonPropertyName("origin")] public Elastic.Clients.Elasticsearch.Serverless.GeoLocation Origin { get; set; } /// - /// Distance from the `origin` at which relevance scores receive half of the `boost` value.
If the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`. + /// + /// Distance from the origin at which relevance scores receive half of the boost value. + /// If the field value is a date or date_nanos field, the pivot value must be a time unit, such as 1h or 10d. If the field value is a geo_point field, the pivot value must be a distance unit, such as 1km or 12m. + /// /// [JsonInclude, JsonPropertyName("pivot")] public string Pivot { get; set; } @@ -71,7 +89,12 @@ public GeoDistanceFeatureQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public GeoDistanceFeatureQueryDescriptor Boost(float? boost) { @@ -80,7 +103,12 @@ public GeoDistanceFeatureQueryDescriptor Boost(float? boost) } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public GeoDistanceFeatureQueryDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -89,7 +117,12 @@ public GeoDistanceFeatureQueryDescriptor Field(Elastic.Clients.Elasti } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public GeoDistanceFeatureQueryDescriptor Field(Expression> field) { @@ -98,7 +131,12 @@ public GeoDistanceFeatureQueryDescriptor Field(Expression - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public GeoDistanceFeatureQueryDescriptor Field(Expression> field) { @@ -107,7 +145,12 @@ public GeoDistanceFeatureQueryDescriptor Field(Expression - /// Date or point of origin used to calculate distances.
If the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.
Date Math, such as `now-1h`, is supported.
If the field value is a `geo_point` field, the `origin` value must be a geopoint. + /// + /// Date or point of origin used to calculate distances. + /// If the field value is a date or date_nanos field, the origin value must be a date. + /// Date Math, such as now-1h, is supported. + /// If the field value is a geo_point field, the origin value must be a geopoint. + /// /// public GeoDistanceFeatureQueryDescriptor Origin(Elastic.Clients.Elasticsearch.Serverless.GeoLocation origin) { @@ -116,7 +159,10 @@ public GeoDistanceFeatureQueryDescriptor Origin(Elastic.Clients.Elast } /// - /// Distance from the `origin` at which relevance scores receive half of the `boost` value.
If the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`. + /// + /// Distance from the origin at which relevance scores receive half of the boost value. + /// If the field value is a date or date_nanos field, the pivot value must be a time unit, such as 1h or 10d. If the field value is a geo_point field, the pivot value must be a distance unit, such as 1km or 12m. + /// /// public GeoDistanceFeatureQueryDescriptor Pivot(string pivot) { @@ -170,7 +216,12 @@ public GeoDistanceFeatureQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public GeoDistanceFeatureQueryDescriptor Boost(float? boost) { @@ -179,7 +230,12 @@ public GeoDistanceFeatureQueryDescriptor Boost(float? boost) } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public GeoDistanceFeatureQueryDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -188,7 +244,12 @@ public GeoDistanceFeatureQueryDescriptor Field(Elastic.Clients.Elasticsearch.Ser } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public GeoDistanceFeatureQueryDescriptor Field(Expression> field) { @@ -197,7 +258,12 @@ public GeoDistanceFeatureQueryDescriptor Field(Expression - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public GeoDistanceFeatureQueryDescriptor Field(Expression> field) { @@ -206,7 +272,12 @@ public GeoDistanceFeatureQueryDescriptor Field(Expression - /// Date or point of origin used to calculate distances.
If the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.
Date Math, such as `now-1h`, is supported.
If the field value is a `geo_point` field, the `origin` value must be a geopoint. + /// + /// Date or point of origin used to calculate distances. + /// If the field value is a date or date_nanos field, the origin value must be a date. + /// Date Math, such as now-1h, is supported. + /// If the field value is a geo_point field, the origin value must be a geopoint. + /// /// public GeoDistanceFeatureQueryDescriptor Origin(Elastic.Clients.Elasticsearch.Serverless.GeoLocation origin) { @@ -215,7 +286,10 @@ public GeoDistanceFeatureQueryDescriptor Origin(Elastic.Clients.Elasticsearch.Se } /// - /// Distance from the `origin` at which relevance scores receive half of the `boost` value.
If the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`. + /// + /// Distance from the origin at which relevance scores receive half of the boost value. + /// If the field value is a date or date_nanos field, the pivot value must be a time unit, such as 1h or 10d. If the field value is a geo_point field, the pivot value must be a distance unit, such as 1km or 12m. + /// /// public GeoDistanceFeatureQueryDescriptor Pivot(string pivot) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/GeoDistanceQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/GeoDistanceQuery.g.cs index e71b7653fbe..2b3714fabf1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/GeoDistanceQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/GeoDistanceQuery.g.cs @@ -139,30 +139,47 @@ public override void Write(Utf8JsonWriter writer, GeoDistanceQuery value, JsonSe public sealed partial class GeoDistanceQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } /// - /// The radius of the circle centred on the specified location.
Points which fall into this circle are considered to be matches. + /// + /// The radius of the circle centred on the specified location. + /// Points which fall into this circle are considered to be matches. + /// /// public string Distance { get; set; } /// - /// How to compute the distance.
Set to `plane` for a faster calculation that's inaccurate on long distances and close to the poles. + /// + /// How to compute the distance. + /// Set to plane for a faster calculation that's inaccurate on long distances and close to the poles. + /// /// public Elastic.Clients.Elasticsearch.Serverless.GeoDistanceType? DistanceType { get; set; } public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Set to `true` to ignore an unmapped field and not match any documents for this query.
Set to `false` to throw an exception if the field is not mapped. + /// + /// Set to true to ignore an unmapped field and not match any documents for this query. + /// Set to false to throw an exception if the field is not mapped. + /// /// public bool? IgnoreUnmapped { get; set; } public Elastic.Clients.Elasticsearch.Serverless.GeoLocation Location { get; set; } public string? QueryName { get; set; } /// - /// Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.
Set to `COERCE` to also try to infer correct latitude or longitude. + /// + /// Set to IGNORE_MALFORMED to accept geo points with invalid latitude or longitude. + /// Set to COERCE to also try to infer correct latitude or longitude. + /// /// public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.GeoValidationMethod? ValidationMethod { get; set; } @@ -187,7 +204,12 @@ public GeoDistanceQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.GeoValidationMethod? ValidationMethodValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public GeoDistanceQueryDescriptor Boost(float? boost) { @@ -196,7 +218,10 @@ public GeoDistanceQueryDescriptor Boost(float? boost) } /// - /// The radius of the circle centred on the specified location.
Points which fall into this circle are considered to be matches. + /// + /// The radius of the circle centred on the specified location. + /// Points which fall into this circle are considered to be matches. + /// /// public GeoDistanceQueryDescriptor Distance(string distance) { @@ -205,7 +230,10 @@ public GeoDistanceQueryDescriptor Distance(string distance) } /// - /// How to compute the distance.
Set to `plane` for a faster calculation that's inaccurate on long distances and close to the poles. + /// + /// How to compute the distance. + /// Set to plane for a faster calculation that's inaccurate on long distances and close to the poles. + /// /// public GeoDistanceQueryDescriptor DistanceType(Elastic.Clients.Elasticsearch.Serverless.GeoDistanceType? distanceType) { @@ -232,7 +260,10 @@ public GeoDistanceQueryDescriptor Field(Expression - /// Set to `true` to ignore an unmapped field and not match any documents for this query.
Set to `false` to throw an exception if the field is not mapped. + /// + /// Set to true to ignore an unmapped field and not match any documents for this query. + /// Set to false to throw an exception if the field is not mapped. + /// /// public GeoDistanceQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { @@ -253,7 +284,10 @@ public GeoDistanceQueryDescriptor QueryName(string? queryName) } /// - /// Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.
Set to `COERCE` to also try to infer correct latitude or longitude. + /// + /// Set to IGNORE_MALFORMED to accept geo points with invalid latitude or longitude. + /// Set to COERCE to also try to infer correct latitude or longitude. + /// /// public GeoDistanceQueryDescriptor ValidationMethod(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.GeoValidationMethod? validationMethod) { @@ -325,7 +359,12 @@ public GeoDistanceQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.GeoValidationMethod? ValidationMethodValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public GeoDistanceQueryDescriptor Boost(float? boost) { @@ -334,7 +373,10 @@ public GeoDistanceQueryDescriptor Boost(float? boost) } /// - /// The radius of the circle centred on the specified location.
Points which fall into this circle are considered to be matches. + /// + /// The radius of the circle centred on the specified location. + /// Points which fall into this circle are considered to be matches. + /// /// public GeoDistanceQueryDescriptor Distance(string distance) { @@ -343,7 +385,10 @@ public GeoDistanceQueryDescriptor Distance(string distance) } /// - /// How to compute the distance.
Set to `plane` for a faster calculation that's inaccurate on long distances and close to the poles. + /// + /// How to compute the distance. + /// Set to plane for a faster calculation that's inaccurate on long distances and close to the poles. + /// /// public GeoDistanceQueryDescriptor DistanceType(Elastic.Clients.Elasticsearch.Serverless.GeoDistanceType? distanceType) { @@ -370,7 +415,10 @@ public GeoDistanceQueryDescriptor Field(Expression - /// Set to `true` to ignore an unmapped field and not match any documents for this query.
Set to `false` to throw an exception if the field is not mapped. + /// + /// Set to true to ignore an unmapped field and not match any documents for this query. + /// Set to false to throw an exception if the field is not mapped. + /// /// public GeoDistanceQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { @@ -391,7 +439,10 @@ public GeoDistanceQueryDescriptor QueryName(string? queryName) } /// - /// Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.
Set to `COERCE` to also try to infer correct latitude or longitude. + /// + /// Set to IGNORE_MALFORMED to accept geo points with invalid latitude or longitude. + /// Set to COERCE to also try to infer correct latitude or longitude. + /// /// public GeoDistanceQueryDescriptor ValidationMethod(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.GeoValidationMethod? validationMethod) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/GeoShapeFieldQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/GeoShapeFieldQuery.g.cs index 0244fbb6bd9..ae6f6b188a3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/GeoShapeFieldQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/GeoShapeFieldQuery.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class GeoShapeFieldQuery { /// - /// Query using an indexed shape retrieved from the the specified document and path. + /// + /// Query using an indexed shape retrieved from the the specified document and path. + /// /// [JsonInclude, JsonPropertyName("indexed_shape")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.FieldLookup? IndexedShape { get; set; } /// - /// Spatial relation operator used to search a geo field. + /// + /// Spatial relation operator used to search a geo field. + /// /// [JsonInclude, JsonPropertyName("relation")] public Elastic.Clients.Elasticsearch.Serverless.GeoShapeRelation? Relation { get; set; } @@ -59,7 +63,9 @@ public GeoShapeFieldQueryDescriptor() : base() private object? ShapeValue { get; set; } /// - /// Query using an indexed shape retrieved from the the specified document and path. + /// + /// Query using an indexed shape retrieved from the the specified document and path. + /// /// public GeoShapeFieldQueryDescriptor IndexedShape(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.FieldLookup? indexedShape) { @@ -86,7 +92,9 @@ public GeoShapeFieldQueryDescriptor IndexedShape(Action - /// Spatial relation operator used to search a geo field. + /// + /// Spatial relation operator used to search a geo field. + /// /// public GeoShapeFieldQueryDescriptor Relation(Elastic.Clients.Elasticsearch.Serverless.GeoShapeRelation? relation) { @@ -150,7 +158,9 @@ public GeoShapeFieldQueryDescriptor() : base() private object? ShapeValue { get; set; } /// - /// Query using an indexed shape retrieved from the the specified document and path. + /// + /// Query using an indexed shape retrieved from the the specified document and path. + /// /// public GeoShapeFieldQueryDescriptor IndexedShape(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.FieldLookup? indexedShape) { @@ -177,7 +187,9 @@ public GeoShapeFieldQueryDescriptor IndexedShape(Action - /// Spatial relation operator used to search a geo field. + /// + /// Spatial relation operator used to search a geo field. + /// /// public GeoShapeFieldQueryDescriptor Relation(Elastic.Clients.Elasticsearch.Serverless.GeoShapeRelation? relation) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/GeoShapeQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/GeoShapeQuery.g.cs index 8b50187502b..7bd66d932fe 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/GeoShapeQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/GeoShapeQuery.g.cs @@ -107,13 +107,21 @@ public override void Write(Utf8JsonWriter writer, GeoShapeQuery value, JsonSeria public sealed partial class GeoShapeQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Set to `true` to ignore an unmapped field and not match any documents for this query.
Set to `false` to throw an exception if the field is not mapped. + /// + /// Set to true to ignore an unmapped field and not match any documents for this query. + /// Set to false to throw an exception if the field is not mapped. + /// /// public bool? IgnoreUnmapped { get; set; } public string? QueryName { get; set; } @@ -139,7 +147,12 @@ public GeoShapeQueryDescriptor() : base() private Action> ShapeDescriptorAction { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public GeoShapeQueryDescriptor Boost(float? boost) { @@ -166,7 +179,10 @@ public GeoShapeQueryDescriptor Field(Expression - /// Set to `true` to ignore an unmapped field and not match any documents for this query.
Set to `false` to throw an exception if the field is not mapped. + /// + /// Set to true to ignore an unmapped field and not match any documents for this query. + /// Set to false to throw an exception if the field is not mapped. + /// /// public GeoShapeQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { @@ -253,7 +269,12 @@ public GeoShapeQueryDescriptor() : base() private Action ShapeDescriptorAction { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public GeoShapeQueryDescriptor Boost(float? boost) { @@ -280,7 +301,10 @@ public GeoShapeQueryDescriptor Field(Expression - /// Set to `true` to ignore an unmapped field and not match any documents for this query.
Set to `false` to throw an exception if the field is not mapped. + /// + /// Set to true to ignore an unmapped field and not match any documents for this query. + /// Set to false to throw an exception if the field is not mapped. + /// /// public GeoShapeQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/HasChildQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/HasChildQuery.g.cs index a3996855ce3..70bfb6461fb 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/HasChildQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/HasChildQuery.g.cs @@ -30,37 +30,55 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class HasChildQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. + /// + /// Indicates whether to ignore an unmapped type and not return any documents instead of an error. + /// /// [JsonInclude, JsonPropertyName("ignore_unmapped")] public bool? IgnoreUnmapped { get; set; } /// - /// If defined, each search hit will contain inner hits. + /// + /// If defined, each search hit will contain inner hits. + /// /// [JsonInclude, JsonPropertyName("inner_hits")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.InnerHits? InnerHits { get; set; } /// - /// Maximum number of child documents that match the query allowed for a returned parent document.
If the parent document exceeds this limit, it is excluded from the search results. + /// + /// Maximum number of child documents that match the query allowed for a returned parent document. + /// If the parent document exceeds this limit, it is excluded from the search results. + /// /// [JsonInclude, JsonPropertyName("max_children")] public int? MaxChildren { get; set; } /// - /// Minimum number of child documents that match the query required to match the query for a returned parent document.
If the parent document does not meet this limit, it is excluded from the search results. + /// + /// Minimum number of child documents that match the query required to match the query for a returned parent document. + /// If the parent document does not meet this limit, it is excluded from the search results. + /// /// [JsonInclude, JsonPropertyName("min_children")] public int? MinChildren { get; set; } /// - /// Query you wish to run on child documents of the `type` field.
If a child document matches the search, the query returns the parent document. + /// + /// Query you wish to run on child documents of the type field. + /// If a child document matches the search, the query returns the parent document. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query Query { get; set; } @@ -68,13 +86,17 @@ public sealed partial class HasChildQuery public string? QueryName { get; set; } /// - /// Indicates how scores for matching child documents affect the root parent document’s relevance score. + /// + /// Indicates how scores for matching child documents affect the root parent document’s relevance score. + /// /// [JsonInclude, JsonPropertyName("score_mode")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.ChildScoreMode? ScoreMode { get; set; } /// - /// Name of the child relationship mapped for the `join` field. + /// + /// Name of the child relationship mapped for the join field. + /// /// [JsonInclude, JsonPropertyName("type")] public string Type { get; set; } @@ -105,7 +127,12 @@ public HasChildQueryDescriptor() : base() private string TypeValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public HasChildQueryDescriptor Boost(float? boost) { @@ -114,7 +141,9 @@ public HasChildQueryDescriptor Boost(float? boost) } /// - /// Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. + /// + /// Indicates whether to ignore an unmapped type and not return any documents instead of an error. + /// /// public HasChildQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { @@ -123,7 +152,9 @@ public HasChildQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = } /// - /// If defined, each search hit will contain inner hits. + /// + /// If defined, each search hit will contain inner hits. + /// /// public HasChildQueryDescriptor InnerHits(Elastic.Clients.Elasticsearch.Serverless.Core.Search.InnerHits? innerHits) { @@ -150,7 +181,10 @@ public HasChildQueryDescriptor InnerHits(Action - /// Maximum number of child documents that match the query allowed for a returned parent document.
If the parent document exceeds this limit, it is excluded from the search results. + /// + /// Maximum number of child documents that match the query allowed for a returned parent document. + /// If the parent document exceeds this limit, it is excluded from the search results. + /// /// public HasChildQueryDescriptor MaxChildren(int? maxChildren) { @@ -159,7 +193,10 @@ public HasChildQueryDescriptor MaxChildren(int? maxChildren) } /// - /// Minimum number of child documents that match the query required to match the query for a returned parent document.
If the parent document does not meet this limit, it is excluded from the search results. + /// + /// Minimum number of child documents that match the query required to match the query for a returned parent document. + /// If the parent document does not meet this limit, it is excluded from the search results. + /// /// public HasChildQueryDescriptor MinChildren(int? minChildren) { @@ -168,7 +205,10 @@ public HasChildQueryDescriptor MinChildren(int? minChildren) } /// - /// Query you wish to run on child documents of the `type` field.
If a child document matches the search, the query returns the parent document. + /// + /// Query you wish to run on child documents of the type field. + /// If a child document matches the search, the query returns the parent document. + /// /// public HasChildQueryDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query query) { @@ -201,7 +241,9 @@ public HasChildQueryDescriptor QueryName(string? queryName) } /// - /// Indicates how scores for matching child documents affect the root parent document’s relevance score. + /// + /// Indicates how scores for matching child documents affect the root parent document’s relevance score. + /// /// public HasChildQueryDescriptor ScoreMode(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.ChildScoreMode? scoreMode) { @@ -210,7 +252,9 @@ public HasChildQueryDescriptor ScoreMode(Elastic.Clients.Elasticsearc } /// - /// Name of the child relationship mapped for the `join` field. + /// + /// Name of the child relationship mapped for the join field. + /// /// public HasChildQueryDescriptor Type(string type) { @@ -318,7 +362,12 @@ public HasChildQueryDescriptor() : base() private string TypeValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public HasChildQueryDescriptor Boost(float? boost) { @@ -327,7 +376,9 @@ public HasChildQueryDescriptor Boost(float? boost) } /// - /// Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. + /// + /// Indicates whether to ignore an unmapped type and not return any documents instead of an error. + /// /// public HasChildQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { @@ -336,7 +387,9 @@ public HasChildQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) } /// - /// If defined, each search hit will contain inner hits. + /// + /// If defined, each search hit will contain inner hits. + /// /// public HasChildQueryDescriptor InnerHits(Elastic.Clients.Elasticsearch.Serverless.Core.Search.InnerHits? innerHits) { @@ -363,7 +416,10 @@ public HasChildQueryDescriptor InnerHits(Action - /// Maximum number of child documents that match the query allowed for a returned parent document.
If the parent document exceeds this limit, it is excluded from the search results. + /// + /// Maximum number of child documents that match the query allowed for a returned parent document. + /// If the parent document exceeds this limit, it is excluded from the search results. + /// /// public HasChildQueryDescriptor MaxChildren(int? maxChildren) { @@ -372,7 +428,10 @@ public HasChildQueryDescriptor MaxChildren(int? maxChildren) } /// - /// Minimum number of child documents that match the query required to match the query for a returned parent document.
If the parent document does not meet this limit, it is excluded from the search results. + /// + /// Minimum number of child documents that match the query required to match the query for a returned parent document. + /// If the parent document does not meet this limit, it is excluded from the search results. + /// /// public HasChildQueryDescriptor MinChildren(int? minChildren) { @@ -381,7 +440,10 @@ public HasChildQueryDescriptor MinChildren(int? minChildren) } /// - /// Query you wish to run on child documents of the `type` field.
If a child document matches the search, the query returns the parent document. + /// + /// Query you wish to run on child documents of the type field. + /// If a child document matches the search, the query returns the parent document. + /// /// public HasChildQueryDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query query) { @@ -414,7 +476,9 @@ public HasChildQueryDescriptor QueryName(string? queryName) } /// - /// Indicates how scores for matching child documents affect the root parent document’s relevance score. + /// + /// Indicates how scores for matching child documents affect the root parent document’s relevance score. + /// /// public HasChildQueryDescriptor ScoreMode(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.ChildScoreMode? scoreMode) { @@ -423,7 +487,9 @@ public HasChildQueryDescriptor ScoreMode(Elastic.Clients.Elasticsearch.Serverles } /// - /// Name of the child relationship mapped for the `join` field. + /// + /// Name of the child relationship mapped for the join field. + /// /// public HasChildQueryDescriptor Type(string type) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/HasParentQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/HasParentQuery.g.cs index 407bc8dc4a7..5776345b119 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/HasParentQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/HasParentQuery.g.cs @@ -30,31 +30,46 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class HasParentQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Indicates whether to ignore an unmapped `parent_type` and not return any documents instead of an error.
You can use this parameter to query multiple indices that may not contain the `parent_type`. + /// + /// Indicates whether to ignore an unmapped parent_type and not return any documents instead of an error. + /// You can use this parameter to query multiple indices that may not contain the parent_type. + /// /// [JsonInclude, JsonPropertyName("ignore_unmapped")] public bool? IgnoreUnmapped { get; set; } /// - /// If defined, each search hit will contain inner hits. + /// + /// If defined, each search hit will contain inner hits. + /// /// [JsonInclude, JsonPropertyName("inner_hits")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.InnerHits? InnerHits { get; set; } /// - /// Name of the parent relationship mapped for the `join` field. + /// + /// Name of the parent relationship mapped for the join field. + /// /// [JsonInclude, JsonPropertyName("parent_type")] public string ParentType { get; set; } /// - /// Query you wish to run on parent documents of the `parent_type` field.
If a parent document matches the search, the query returns its child documents. + /// + /// Query you wish to run on parent documents of the parent_type field. + /// If a parent document matches the search, the query returns its child documents. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query Query { get; set; } @@ -62,7 +77,9 @@ public sealed partial class HasParentQuery public string? QueryName { get; set; } /// - /// Indicates whether the relevance score of a matching parent document is aggregated into its child documents. + /// + /// Indicates whether the relevance score of a matching parent document is aggregated into its child documents. + /// /// [JsonInclude, JsonPropertyName("score")] public bool? Score { get; set; } @@ -91,7 +108,12 @@ public HasParentQueryDescriptor() : base() private bool? ScoreValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public HasParentQueryDescriptor Boost(float? boost) { @@ -100,7 +122,10 @@ public HasParentQueryDescriptor Boost(float? boost) } /// - /// Indicates whether to ignore an unmapped `parent_type` and not return any documents instead of an error.
You can use this parameter to query multiple indices that may not contain the `parent_type`. + /// + /// Indicates whether to ignore an unmapped parent_type and not return any documents instead of an error. + /// You can use this parameter to query multiple indices that may not contain the parent_type. + /// /// public HasParentQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { @@ -109,7 +134,9 @@ public HasParentQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = } /// - /// If defined, each search hit will contain inner hits. + /// + /// If defined, each search hit will contain inner hits. + /// /// public HasParentQueryDescriptor InnerHits(Elastic.Clients.Elasticsearch.Serverless.Core.Search.InnerHits? innerHits) { @@ -136,7 +163,9 @@ public HasParentQueryDescriptor InnerHits(Action - /// Name of the parent relationship mapped for the `join` field. + /// + /// Name of the parent relationship mapped for the join field. + /// /// public HasParentQueryDescriptor ParentType(string parentType) { @@ -145,7 +174,10 @@ public HasParentQueryDescriptor ParentType(string parentType) } /// - /// Query you wish to run on parent documents of the `parent_type` field.
If a parent document matches the search, the query returns its child documents. + /// + /// Query you wish to run on parent documents of the parent_type field. + /// If a parent document matches the search, the query returns its child documents. + /// /// public HasParentQueryDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query query) { @@ -178,7 +210,9 @@ public HasParentQueryDescriptor QueryName(string? queryName) } /// - /// Indicates whether the relevance score of a matching parent document is aggregated into its child documents. + /// + /// Indicates whether the relevance score of a matching parent document is aggregated into its child documents. + /// /// public HasParentQueryDescriptor Score(bool? score = true) { @@ -272,7 +306,12 @@ public HasParentQueryDescriptor() : base() private bool? ScoreValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public HasParentQueryDescriptor Boost(float? boost) { @@ -281,7 +320,10 @@ public HasParentQueryDescriptor Boost(float? boost) } /// - /// Indicates whether to ignore an unmapped `parent_type` and not return any documents instead of an error.
You can use this parameter to query multiple indices that may not contain the `parent_type`. + /// + /// Indicates whether to ignore an unmapped parent_type and not return any documents instead of an error. + /// You can use this parameter to query multiple indices that may not contain the parent_type. + /// /// public HasParentQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { @@ -290,7 +332,9 @@ public HasParentQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) } /// - /// If defined, each search hit will contain inner hits. + /// + /// If defined, each search hit will contain inner hits. + /// /// public HasParentQueryDescriptor InnerHits(Elastic.Clients.Elasticsearch.Serverless.Core.Search.InnerHits? innerHits) { @@ -317,7 +361,9 @@ public HasParentQueryDescriptor InnerHits(Action - /// Name of the parent relationship mapped for the `join` field. + /// + /// Name of the parent relationship mapped for the join field. + /// /// public HasParentQueryDescriptor ParentType(string parentType) { @@ -326,7 +372,10 @@ public HasParentQueryDescriptor ParentType(string parentType) } /// - /// Query you wish to run on parent documents of the `parent_type` field.
If a parent document matches the search, the query returns its child documents. + /// + /// Query you wish to run on parent documents of the parent_type field. + /// If a parent document matches the search, the query returns its child documents. + /// /// public HasParentQueryDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query query) { @@ -359,7 +408,9 @@ public HasParentQueryDescriptor QueryName(string? queryName) } /// - /// Indicates whether the relevance score of a matching parent document is aggregated into its child documents. + /// + /// Indicates whether the relevance score of a matching parent document is aggregated into its child documents. + /// /// public HasParentQueryDescriptor Score(bool? score = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IdsQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IdsQuery.g.cs index 4dd37e79e77..3915c424b59 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IdsQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IdsQuery.g.cs @@ -30,7 +30,12 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class IdsQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } @@ -38,7 +43,9 @@ public sealed partial class IdsQuery public string? QueryName { get; set; } /// - /// An array of document IDs. + /// + /// An array of document IDs. + /// /// [JsonInclude, JsonPropertyName("values")] public Elastic.Clients.Elasticsearch.Serverless.Ids? Values { get; set; } @@ -59,7 +66,12 @@ public IdsQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Ids? ValuesValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public IdsQueryDescriptor Boost(float? boost) { @@ -74,7 +86,9 @@ public IdsQueryDescriptor QueryName(string? queryName) } /// - /// An array of document IDs. + /// + /// An array of document IDs. + /// /// public IdsQueryDescriptor Values(Elastic.Clients.Elasticsearch.Serverless.Ids? values) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IntervalsAllOf.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IntervalsAllOf.g.cs index 12aa0393570..1142c8d067f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IntervalsAllOf.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IntervalsAllOf.g.cs @@ -30,25 +30,34 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class IntervalsAllOf { /// - /// Rule used to filter returned intervals. + /// + /// Rule used to filter returned intervals. + /// /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.IntervalsFilter? Filter { get; set; } /// - /// An array of rules to combine. All rules must produce a match in a document for the overall source to match. + /// + /// An array of rules to combine. All rules must produce a match in a document for the overall source to match. + /// /// [JsonInclude, JsonPropertyName("intervals")] public ICollection Intervals { get; set; } /// - /// Maximum number of positions between the matching terms.
Intervals produced by the rules further apart than this are not considered matches. + /// + /// Maximum number of positions between the matching terms. + /// Intervals produced by the rules further apart than this are not considered matches. + /// /// [JsonInclude, JsonPropertyName("max_gaps")] public int? MaxGaps { get; set; } /// - /// If `true`, intervals produced by the rules should appear in the order in which they are specified. + /// + /// If true, intervals produced by the rules should appear in the order in which they are specified. + /// /// [JsonInclude, JsonPropertyName("ordered")] public bool? Ordered { get; set; } @@ -76,7 +85,9 @@ public IntervalsAllOfDescriptor() : base() private bool? OrderedValue { get; set; } /// - /// Rule used to filter returned intervals. + /// + /// Rule used to filter returned intervals. + /// /// public IntervalsAllOfDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.IntervalsFilter? filter) { @@ -103,7 +114,9 @@ public IntervalsAllOfDescriptor Filter(Action - /// An array of rules to combine. All rules must produce a match in a document for the overall source to match. + /// + /// An array of rules to combine. All rules must produce a match in a document for the overall source to match. + /// /// public IntervalsAllOfDescriptor Intervals(ICollection intervals) { @@ -142,7 +155,10 @@ public IntervalsAllOfDescriptor Intervals(params Action - /// Maximum number of positions between the matching terms.
Intervals produced by the rules further apart than this are not considered matches. + /// + /// Maximum number of positions between the matching terms. + /// Intervals produced by the rules further apart than this are not considered matches. + /// /// public IntervalsAllOfDescriptor MaxGaps(int? maxGaps) { @@ -151,7 +167,9 @@ public IntervalsAllOfDescriptor MaxGaps(int? maxGaps) } /// - /// If `true`, intervals produced by the rules should appear in the order in which they are specified. + /// + /// If true, intervals produced by the rules should appear in the order in which they are specified. + /// /// public IntervalsAllOfDescriptor Ordered(bool? ordered = true) { @@ -244,7 +262,9 @@ public IntervalsAllOfDescriptor() : base() private bool? OrderedValue { get; set; } /// - /// Rule used to filter returned intervals. + /// + /// Rule used to filter returned intervals. + /// /// public IntervalsAllOfDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.IntervalsFilter? filter) { @@ -271,7 +291,9 @@ public IntervalsAllOfDescriptor Filter(Action - /// An array of rules to combine. All rules must produce a match in a document for the overall source to match. + /// + /// An array of rules to combine. All rules must produce a match in a document for the overall source to match. + /// /// public IntervalsAllOfDescriptor Intervals(ICollection intervals) { @@ -310,7 +332,10 @@ public IntervalsAllOfDescriptor Intervals(params Action - /// Maximum number of positions between the matching terms.
Intervals produced by the rules further apart than this are not considered matches. + /// + /// Maximum number of positions between the matching terms. + /// Intervals produced by the rules further apart than this are not considered matches. + /// /// public IntervalsAllOfDescriptor MaxGaps(int? maxGaps) { @@ -319,7 +344,9 @@ public IntervalsAllOfDescriptor MaxGaps(int? maxGaps) } /// - /// If `true`, intervals produced by the rules should appear in the order in which they are specified. + /// + /// If true, intervals produced by the rules should appear in the order in which they are specified. + /// /// public IntervalsAllOfDescriptor Ordered(bool? ordered = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IntervalsAnyOf.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IntervalsAnyOf.g.cs index 5339d45c91f..4be35cc9c03 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IntervalsAnyOf.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IntervalsAnyOf.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class IntervalsAnyOf { /// - /// Rule used to filter returned intervals. + /// + /// Rule used to filter returned intervals. + /// /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.IntervalsFilter? Filter { get; set; } /// - /// An array of rules to match. + /// + /// An array of rules to match. + /// /// [JsonInclude, JsonPropertyName("intervals")] public ICollection Intervals { get; set; } @@ -62,7 +66,9 @@ public IntervalsAnyOfDescriptor() : base() private Action>[] IntervalsDescriptorActions { get; set; } /// - /// Rule used to filter returned intervals. + /// + /// Rule used to filter returned intervals. + /// /// public IntervalsAnyOfDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.IntervalsFilter? filter) { @@ -89,7 +95,9 @@ public IntervalsAnyOfDescriptor Filter(Action - /// An array of rules to match. + /// + /// An array of rules to match. + /// /// public IntervalsAnyOfDescriptor Intervals(ICollection intervals) { @@ -198,7 +206,9 @@ public IntervalsAnyOfDescriptor() : base() private Action[] IntervalsDescriptorActions { get; set; } /// - /// Rule used to filter returned intervals. + /// + /// Rule used to filter returned intervals. + /// /// public IntervalsAnyOfDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.IntervalsFilter? filter) { @@ -225,7 +235,9 @@ public IntervalsAnyOfDescriptor Filter(Action - /// An array of rules to match. + /// + /// An array of rules to match. + /// /// public IntervalsAnyOfDescriptor Intervals(ICollection intervals) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IntervalsFuzzy.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IntervalsFuzzy.g.cs index 8376943d820..4186a5b33dc 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IntervalsFuzzy.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IntervalsFuzzy.g.cs @@ -30,37 +30,50 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class IntervalsFuzzy { /// - /// Analyzer used to normalize the term. + /// + /// Analyzer used to normalize the term. + /// /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } /// - /// Maximum edit distance allowed for matching. + /// + /// Maximum edit distance allowed for matching. + /// /// [JsonInclude, JsonPropertyName("fuzziness")] public Elastic.Clients.Elasticsearch.Serverless.Fuzziness? Fuzziness { get; set; } /// - /// Number of beginning characters left unchanged when creating expansions. + /// + /// Number of beginning characters left unchanged when creating expansions. + /// /// [JsonInclude, JsonPropertyName("prefix_length")] public int? PrefixLength { get; set; } /// - /// The term to match. + /// + /// The term to match. + /// /// [JsonInclude, JsonPropertyName("term")] public string Term { get; set; } /// - /// Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// + /// Indicates whether edits include transpositions of two adjacent characters (for example, ab to ba). + /// /// [JsonInclude, JsonPropertyName("transpositions")] public bool? Transpositions { get; set; } /// - /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The term is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// [JsonInclude, JsonPropertyName("use_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? UseField { get; set; } @@ -85,7 +98,9 @@ public IntervalsFuzzyDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? UseFieldValue { get; set; } /// - /// Analyzer used to normalize the term. + /// + /// Analyzer used to normalize the term. + /// /// public IntervalsFuzzyDescriptor Analyzer(string? analyzer) { @@ -94,7 +109,9 @@ public IntervalsFuzzyDescriptor Analyzer(string? analyzer) } /// - /// Maximum edit distance allowed for matching. + /// + /// Maximum edit distance allowed for matching. + /// /// public IntervalsFuzzyDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Serverless.Fuzziness? fuzziness) { @@ -103,7 +120,9 @@ public IntervalsFuzzyDescriptor Fuzziness(Elastic.Clients.Elasticsear } /// - /// Number of beginning characters left unchanged when creating expansions. + /// + /// Number of beginning characters left unchanged when creating expansions. + /// /// public IntervalsFuzzyDescriptor PrefixLength(int? prefixLength) { @@ -112,7 +131,9 @@ public IntervalsFuzzyDescriptor PrefixLength(int? prefixLength) } /// - /// The term to match. + /// + /// The term to match. + /// /// public IntervalsFuzzyDescriptor Term(string term) { @@ -121,7 +142,9 @@ public IntervalsFuzzyDescriptor Term(string term) } /// - /// Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// + /// Indicates whether edits include transpositions of two adjacent characters (for example, ab to ba). + /// /// public IntervalsFuzzyDescriptor Transpositions(bool? transpositions = true) { @@ -130,7 +153,10 @@ public IntervalsFuzzyDescriptor Transpositions(bool? transpositions = } /// - /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The term is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsFuzzyDescriptor UseField(Elastic.Clients.Elasticsearch.Serverless.Field? useField) { @@ -139,7 +165,10 @@ public IntervalsFuzzyDescriptor UseField(Elastic.Clients.Elasticsearc } /// - /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The term is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsFuzzyDescriptor UseField(Expression> useField) { @@ -148,7 +177,10 @@ public IntervalsFuzzyDescriptor UseField(Expression - /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The term is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsFuzzyDescriptor UseField(Expression> useField) { @@ -211,7 +243,9 @@ public IntervalsFuzzyDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? UseFieldValue { get; set; } /// - /// Analyzer used to normalize the term. + /// + /// Analyzer used to normalize the term. + /// /// public IntervalsFuzzyDescriptor Analyzer(string? analyzer) { @@ -220,7 +254,9 @@ public IntervalsFuzzyDescriptor Analyzer(string? analyzer) } /// - /// Maximum edit distance allowed for matching. + /// + /// Maximum edit distance allowed for matching. + /// /// public IntervalsFuzzyDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Serverless.Fuzziness? fuzziness) { @@ -229,7 +265,9 @@ public IntervalsFuzzyDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Serverle } /// - /// Number of beginning characters left unchanged when creating expansions. + /// + /// Number of beginning characters left unchanged when creating expansions. + /// /// public IntervalsFuzzyDescriptor PrefixLength(int? prefixLength) { @@ -238,7 +276,9 @@ public IntervalsFuzzyDescriptor PrefixLength(int? prefixLength) } /// - /// The term to match. + /// + /// The term to match. + /// /// public IntervalsFuzzyDescriptor Term(string term) { @@ -247,7 +287,9 @@ public IntervalsFuzzyDescriptor Term(string term) } /// - /// Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// + /// Indicates whether edits include transpositions of two adjacent characters (for example, ab to ba). + /// /// public IntervalsFuzzyDescriptor Transpositions(bool? transpositions = true) { @@ -256,7 +298,10 @@ public IntervalsFuzzyDescriptor Transpositions(bool? transpositions = true) } /// - /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The term is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsFuzzyDescriptor UseField(Elastic.Clients.Elasticsearch.Serverless.Field? useField) { @@ -265,7 +310,10 @@ public IntervalsFuzzyDescriptor UseField(Elastic.Clients.Elasticsearch.Serverles } /// - /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The term is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsFuzzyDescriptor UseField(Expression> useField) { @@ -274,7 +322,10 @@ public IntervalsFuzzyDescriptor UseField(Expression - /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The term is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsFuzzyDescriptor UseField(Expression> useField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IntervalsMatch.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IntervalsMatch.g.cs index 61c710c01bd..149827281a3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IntervalsMatch.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IntervalsMatch.g.cs @@ -30,37 +30,51 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class IntervalsMatch { /// - /// Analyzer used to analyze terms in the query. + /// + /// Analyzer used to analyze terms in the query. + /// /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } /// - /// An optional interval filter. + /// + /// An optional interval filter. + /// /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.IntervalsFilter? Filter { get; set; } /// - /// Maximum number of positions between the matching terms.
Terms further apart than this are not considered matches. + /// + /// Maximum number of positions between the matching terms. + /// Terms further apart than this are not considered matches. + /// /// [JsonInclude, JsonPropertyName("max_gaps")] public int? MaxGaps { get; set; } /// - /// If `true`, matching terms must appear in their specified order. + /// + /// If true, matching terms must appear in their specified order. + /// /// [JsonInclude, JsonPropertyName("ordered")] public bool? Ordered { get; set; } /// - /// Text you wish to find in the provided field. + /// + /// Text you wish to find in the provided field. + /// /// [JsonInclude, JsonPropertyName("query")] public string Query { get; set; } /// - /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The term is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// [JsonInclude, JsonPropertyName("use_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? UseField { get; set; } @@ -87,7 +101,9 @@ public IntervalsMatchDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? UseFieldValue { get; set; } /// - /// Analyzer used to analyze terms in the query. + /// + /// Analyzer used to analyze terms in the query. + /// /// public IntervalsMatchDescriptor Analyzer(string? analyzer) { @@ -96,7 +112,9 @@ public IntervalsMatchDescriptor Analyzer(string? analyzer) } /// - /// An optional interval filter. + /// + /// An optional interval filter. + /// /// public IntervalsMatchDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.IntervalsFilter? filter) { @@ -123,7 +141,10 @@ public IntervalsMatchDescriptor Filter(Action - /// Maximum number of positions between the matching terms.
Terms further apart than this are not considered matches. + /// + /// Maximum number of positions between the matching terms. + /// Terms further apart than this are not considered matches. + /// /// public IntervalsMatchDescriptor MaxGaps(int? maxGaps) { @@ -132,7 +153,9 @@ public IntervalsMatchDescriptor MaxGaps(int? maxGaps) } /// - /// If `true`, matching terms must appear in their specified order. + /// + /// If true, matching terms must appear in their specified order. + /// /// public IntervalsMatchDescriptor Ordered(bool? ordered = true) { @@ -141,7 +164,9 @@ public IntervalsMatchDescriptor Ordered(bool? ordered = true) } /// - /// Text you wish to find in the provided field. + /// + /// Text you wish to find in the provided field. + /// /// public IntervalsMatchDescriptor Query(string query) { @@ -150,7 +175,10 @@ public IntervalsMatchDescriptor Query(string query) } /// - /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The term is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsMatchDescriptor UseField(Elastic.Clients.Elasticsearch.Serverless.Field? useField) { @@ -159,7 +187,10 @@ public IntervalsMatchDescriptor UseField(Elastic.Clients.Elasticsearc } /// - /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The term is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsMatchDescriptor UseField(Expression> useField) { @@ -168,7 +199,10 @@ public IntervalsMatchDescriptor UseField(Expression - /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The term is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsMatchDescriptor UseField(Expression> useField) { @@ -243,7 +277,9 @@ public IntervalsMatchDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? UseFieldValue { get; set; } /// - /// Analyzer used to analyze terms in the query. + /// + /// Analyzer used to analyze terms in the query. + /// /// public IntervalsMatchDescriptor Analyzer(string? analyzer) { @@ -252,7 +288,9 @@ public IntervalsMatchDescriptor Analyzer(string? analyzer) } /// - /// An optional interval filter. + /// + /// An optional interval filter. + /// /// public IntervalsMatchDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.IntervalsFilter? filter) { @@ -279,7 +317,10 @@ public IntervalsMatchDescriptor Filter(Action - /// Maximum number of positions between the matching terms.
Terms further apart than this are not considered matches. + /// + /// Maximum number of positions between the matching terms. + /// Terms further apart than this are not considered matches. + /// /// public IntervalsMatchDescriptor MaxGaps(int? maxGaps) { @@ -288,7 +329,9 @@ public IntervalsMatchDescriptor MaxGaps(int? maxGaps) } /// - /// If `true`, matching terms must appear in their specified order. + /// + /// If true, matching terms must appear in their specified order. + /// /// public IntervalsMatchDescriptor Ordered(bool? ordered = true) { @@ -297,7 +340,9 @@ public IntervalsMatchDescriptor Ordered(bool? ordered = true) } /// - /// Text you wish to find in the provided field. + /// + /// Text you wish to find in the provided field. + /// /// public IntervalsMatchDescriptor Query(string query) { @@ -306,7 +351,10 @@ public IntervalsMatchDescriptor Query(string query) } /// - /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The term is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsMatchDescriptor UseField(Elastic.Clients.Elasticsearch.Serverless.Field? useField) { @@ -315,7 +363,10 @@ public IntervalsMatchDescriptor UseField(Elastic.Clients.Elasticsearch.Serverles } /// - /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The term is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsMatchDescriptor UseField(Expression> useField) { @@ -324,7 +375,10 @@ public IntervalsMatchDescriptor UseField(Expression - /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The term is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsMatchDescriptor UseField(Expression> useField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IntervalsPrefix.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IntervalsPrefix.g.cs index c68c1da0c37..d28ebb0cdbe 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IntervalsPrefix.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IntervalsPrefix.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class IntervalsPrefix { /// - /// Analyzer used to analyze the `prefix`. + /// + /// Analyzer used to analyze the prefix. + /// /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } /// - /// Beginning characters of terms you wish to find in the top-level field. + /// + /// Beginning characters of terms you wish to find in the top-level field. + /// /// [JsonInclude, JsonPropertyName("prefix")] public string Prefix { get; set; } /// - /// If specified, match intervals from this field rather than the top-level field.
The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The prefix is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// [JsonInclude, JsonPropertyName("use_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? UseField { get; set; } @@ -64,7 +71,9 @@ public IntervalsPrefixDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? UseFieldValue { get; set; } /// - /// Analyzer used to analyze the `prefix`. + /// + /// Analyzer used to analyze the prefix. + /// /// public IntervalsPrefixDescriptor Analyzer(string? analyzer) { @@ -73,7 +82,9 @@ public IntervalsPrefixDescriptor Analyzer(string? analyzer) } /// - /// Beginning characters of terms you wish to find in the top-level field. + /// + /// Beginning characters of terms you wish to find in the top-level field. + /// /// public IntervalsPrefixDescriptor Prefix(string prefix) { @@ -82,7 +93,10 @@ public IntervalsPrefixDescriptor Prefix(string prefix) } /// - /// If specified, match intervals from this field rather than the top-level field.
The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The prefix is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsPrefixDescriptor UseField(Elastic.Clients.Elasticsearch.Serverless.Field? useField) { @@ -91,7 +105,10 @@ public IntervalsPrefixDescriptor UseField(Elastic.Clients.Elasticsear } /// - /// If specified, match intervals from this field rather than the top-level field.
The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The prefix is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsPrefixDescriptor UseField(Expression> useField) { @@ -100,7 +117,10 @@ public IntervalsPrefixDescriptor UseField(Expression - /// If specified, match intervals from this field rather than the top-level field.
The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The prefix is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsPrefixDescriptor UseField(Expression> useField) { @@ -142,7 +162,9 @@ public IntervalsPrefixDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? UseFieldValue { get; set; } /// - /// Analyzer used to analyze the `prefix`. + /// + /// Analyzer used to analyze the prefix. + /// /// public IntervalsPrefixDescriptor Analyzer(string? analyzer) { @@ -151,7 +173,9 @@ public IntervalsPrefixDescriptor Analyzer(string? analyzer) } /// - /// Beginning characters of terms you wish to find in the top-level field. + /// + /// Beginning characters of terms you wish to find in the top-level field. + /// /// public IntervalsPrefixDescriptor Prefix(string prefix) { @@ -160,7 +184,10 @@ public IntervalsPrefixDescriptor Prefix(string prefix) } /// - /// If specified, match intervals from this field rather than the top-level field.
The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The prefix is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsPrefixDescriptor UseField(Elastic.Clients.Elasticsearch.Serverless.Field? useField) { @@ -169,7 +196,10 @@ public IntervalsPrefixDescriptor UseField(Elastic.Clients.Elasticsearch.Serverle } /// - /// If specified, match intervals from this field rather than the top-level field.
The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The prefix is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsPrefixDescriptor UseField(Expression> useField) { @@ -178,7 +208,10 @@ public IntervalsPrefixDescriptor UseField(Expression - /// If specified, match intervals from this field rather than the top-level field.
The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The prefix is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsPrefixDescriptor UseField(Expression> useField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IntervalsQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IntervalsQuery.g.cs index ba8e920fc2b..58eac78e84c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IntervalsQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IntervalsQuery.g.cs @@ -54,7 +54,12 @@ internal IntervalsQuery(string variantName, object variant) public static IntervalsQuery Wildcard(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.IntervalsWildcard intervalsWildcard) => new IntervalsQuery("wildcard", intervalsWildcard); /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } @@ -259,7 +264,12 @@ private IntervalsQueryDescriptor Set(object variant, string variantNa private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public IntervalsQueryDescriptor Boost(float? boost) { @@ -377,7 +387,12 @@ private IntervalsQueryDescriptor Set(object variant, string variantName) private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public IntervalsQueryDescriptor Boost(float? boost) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IntervalsWildcard.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IntervalsWildcard.g.cs index a6433dfe037..cc611d1b7e3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IntervalsWildcard.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/IntervalsWildcard.g.cs @@ -30,19 +30,27 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class IntervalsWildcard { /// - /// Analyzer used to analyze the `pattern`.
Defaults to the top-level field's analyzer. + /// + /// Analyzer used to analyze the pattern. + /// Defaults to the top-level field's analyzer. + /// /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } /// - /// Wildcard pattern used to find matching terms. + /// + /// Wildcard pattern used to find matching terms. + /// /// [JsonInclude, JsonPropertyName("pattern")] public string Pattern { get; set; } /// - /// If specified, match intervals from this field rather than the top-level field.
The `pattern` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The pattern is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// [JsonInclude, JsonPropertyName("use_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? UseField { get; set; } @@ -64,7 +72,10 @@ public IntervalsWildcardDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? UseFieldValue { get; set; } /// - /// Analyzer used to analyze the `pattern`.
Defaults to the top-level field's analyzer. + /// + /// Analyzer used to analyze the pattern. + /// Defaults to the top-level field's analyzer. + /// /// public IntervalsWildcardDescriptor Analyzer(string? analyzer) { @@ -73,7 +84,9 @@ public IntervalsWildcardDescriptor Analyzer(string? analyzer) } /// - /// Wildcard pattern used to find matching terms. + /// + /// Wildcard pattern used to find matching terms. + /// /// public IntervalsWildcardDescriptor Pattern(string pattern) { @@ -82,7 +95,10 @@ public IntervalsWildcardDescriptor Pattern(string pattern) } /// - /// If specified, match intervals from this field rather than the top-level field.
The `pattern` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The pattern is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsWildcardDescriptor UseField(Elastic.Clients.Elasticsearch.Serverless.Field? useField) { @@ -91,7 +107,10 @@ public IntervalsWildcardDescriptor UseField(Elastic.Clients.Elasticse } /// - /// If specified, match intervals from this field rather than the top-level field.
The `pattern` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The pattern is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsWildcardDescriptor UseField(Expression> useField) { @@ -100,7 +119,10 @@ public IntervalsWildcardDescriptor UseField(Expression - /// If specified, match intervals from this field rather than the top-level field.
The `pattern` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The pattern is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsWildcardDescriptor UseField(Expression> useField) { @@ -142,7 +164,10 @@ public IntervalsWildcardDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field? UseFieldValue { get; set; } /// - /// Analyzer used to analyze the `pattern`.
Defaults to the top-level field's analyzer. + /// + /// Analyzer used to analyze the pattern. + /// Defaults to the top-level field's analyzer. + /// /// public IntervalsWildcardDescriptor Analyzer(string? analyzer) { @@ -151,7 +176,9 @@ public IntervalsWildcardDescriptor Analyzer(string? analyzer) } /// - /// Wildcard pattern used to find matching terms. + /// + /// Wildcard pattern used to find matching terms. + /// /// public IntervalsWildcardDescriptor Pattern(string pattern) { @@ -160,7 +187,10 @@ public IntervalsWildcardDescriptor Pattern(string pattern) } /// - /// If specified, match intervals from this field rather than the top-level field.
The `pattern` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The pattern is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsWildcardDescriptor UseField(Elastic.Clients.Elasticsearch.Serverless.Field? useField) { @@ -169,7 +199,10 @@ public IntervalsWildcardDescriptor UseField(Elastic.Clients.Elasticsearch.Server } /// - /// If specified, match intervals from this field rather than the top-level field.
The `pattern` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The pattern is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsWildcardDescriptor UseField(Expression> useField) { @@ -178,7 +211,10 @@ public IntervalsWildcardDescriptor UseField(Expression - /// If specified, match intervals from this field rather than the top-level field.
The `pattern` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The pattern is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsWildcardDescriptor UseField(Expression> useField) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/Like.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/Like.g.cs index 1d0cc3086b8..ef243c82d7a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/Like.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/Like.g.cs @@ -31,7 +31,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; /// -/// Text that we want similar documents for or a lookup to a document's field for the text. +/// +/// Text that we want similar documents for or a lookup to a document's field for the text. +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class Like : Union diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/LikeDocument.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/LikeDocument.g.cs index 6bdf1592980..366d3423770 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/LikeDocument.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/LikeDocument.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class LikeDocument { /// - /// A document not present in the index. + /// + /// A document not present in the index. + /// /// [JsonInclude, JsonPropertyName("doc")] public object? Doc { get; set; } @@ -39,19 +41,25 @@ public sealed partial class LikeDocument public Elastic.Clients.Elasticsearch.Serverless.Fields? Fields { get; set; } /// - /// ID of a document. + /// + /// ID of a document. + /// /// [JsonInclude, JsonPropertyName("_id")] public Elastic.Clients.Elasticsearch.Serverless.Id? Id { get; set; } /// - /// Index of a document. + /// + /// Index of a document. + /// /// [JsonInclude, JsonPropertyName("_index")] public Elastic.Clients.Elasticsearch.Serverless.IndexName? Index { get; set; } /// - /// Overrides the default analyzer. + /// + /// Overrides the default analyzer. + /// /// [JsonInclude, JsonPropertyName("per_field_analyzer")] public IDictionary? PerFieldAnalyzer { get; set; } @@ -81,7 +89,9 @@ public LikeDocumentDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.VersionType? VersionTypeValue { get; set; } /// - /// A document not present in the index. + /// + /// A document not present in the index. + /// /// public LikeDocumentDescriptor Doc(object? doc) { @@ -96,7 +106,9 @@ public LikeDocumentDescriptor Fields(Elastic.Clients.Elasticsearch.Se } /// - /// ID of a document. + /// + /// ID of a document. + /// /// public LikeDocumentDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id? id) { @@ -105,7 +117,9 @@ public LikeDocumentDescriptor Id(Elastic.Clients.Elasticsearch.Server } /// - /// Index of a document. + /// + /// Index of a document. + /// /// public LikeDocumentDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.IndexName? index) { @@ -114,7 +128,9 @@ public LikeDocumentDescriptor Index(Elastic.Clients.Elasticsearch.Ser } /// - /// Overrides the default analyzer. + /// + /// Overrides the default analyzer. + /// /// public LikeDocumentDescriptor PerFieldAnalyzer(Func, FluentDictionary> selector) { @@ -213,7 +229,9 @@ public LikeDocumentDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.VersionType? VersionTypeValue { get; set; } /// - /// A document not present in the index. + /// + /// A document not present in the index. + /// /// public LikeDocumentDescriptor Doc(object? doc) { @@ -228,7 +246,9 @@ public LikeDocumentDescriptor Fields(Elastic.Clients.Elasticsearch.Serverless.Fi } /// - /// ID of a document. + /// + /// ID of a document. + /// /// public LikeDocumentDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id? id) { @@ -237,7 +257,9 @@ public LikeDocumentDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id? id } /// - /// Index of a document. + /// + /// Index of a document. + /// /// public LikeDocumentDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.IndexName? index) { @@ -246,7 +268,9 @@ public LikeDocumentDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.Ind } /// - /// Overrides the default analyzer. + /// + /// Overrides the default analyzer. + /// /// public LikeDocumentDescriptor PerFieldAnalyzer(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MatchAllQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MatchAllQuery.g.cs index 784586fbd0b..cc070e757d0 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MatchAllQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MatchAllQuery.g.cs @@ -30,7 +30,12 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class MatchAllQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } @@ -52,7 +57,12 @@ public MatchAllQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public MatchAllQueryDescriptor Boost(float? boost) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MatchBoolPrefixQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MatchBoolPrefixQuery.g.cs index 1c17ad45ddc..d9abed4ea45 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MatchBoolPrefixQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MatchBoolPrefixQuery.g.cs @@ -201,53 +201,84 @@ public MatchBoolPrefixQuery(Elastic.Clients.Elasticsearch.Serverless.Field field } /// - /// Analyzer used to convert the text in the query value into tokens. + /// + /// Analyzer used to convert the text in the query value into tokens. + /// /// public string? Analyzer { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Maximum edit distance allowed for matching.
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// Maximum edit distance allowed for matching. + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fuzziness? Fuzziness { get; set; } /// - /// Method used to rewrite the query.
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// Method used to rewrite the query. + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public string? FuzzyRewrite { get; set; } /// - /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public bool? FuzzyTranspositions { get; set; } /// - /// Maximum number of terms to which the query will expand.
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// Maximum number of terms to which the query will expand. + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public int? MaxExpansions { get; set; } /// - /// Minimum number of clauses that must match for a document to be returned.
Applied to the constructed bool query. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// Applied to the constructed bool query. + /// /// public Elastic.Clients.Elasticsearch.Serverless.MinimumShouldMatch? MinimumShouldMatch { get; set; } /// - /// Boolean logic used to interpret text in the query value.
Applied to the constructed bool query. + /// + /// Boolean logic used to interpret text in the query value. + /// Applied to the constructed bool query. + /// /// public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Operator? Operator { get; set; } /// - /// Number of beginning characters left unchanged for fuzzy matching.
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public int? PrefixLength { get; set; } /// - /// Terms you wish to find in the provided field.
The last term is used in a prefix query. + /// + /// Terms you wish to find in the provided field. + /// The last term is used in a prefix query. + /// /// public string Query { get; set; } public string? QueryName { get; set; } @@ -277,7 +308,9 @@ public MatchBoolPrefixQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Analyzer used to convert the text in the query value into tokens. + /// + /// Analyzer used to convert the text in the query value into tokens. + /// /// public MatchBoolPrefixQueryDescriptor Analyzer(string? analyzer) { @@ -286,7 +319,12 @@ public MatchBoolPrefixQueryDescriptor Analyzer(string? analyzer) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public MatchBoolPrefixQueryDescriptor Boost(float? boost) { @@ -313,7 +351,10 @@ public MatchBoolPrefixQueryDescriptor Field(Expression - /// Maximum edit distance allowed for matching.
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// Maximum edit distance allowed for matching. + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public MatchBoolPrefixQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Serverless.Fuzziness? fuzziness) { @@ -322,7 +363,10 @@ public MatchBoolPrefixQueryDescriptor Fuzziness(Elastic.Clients.Elast } /// - /// Method used to rewrite the query.
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// Method used to rewrite the query. + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public MatchBoolPrefixQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) { @@ -331,7 +375,10 @@ public MatchBoolPrefixQueryDescriptor FuzzyRewrite(string? fuzzyRewri } /// - /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public MatchBoolPrefixQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true) { @@ -340,7 +387,10 @@ public MatchBoolPrefixQueryDescriptor FuzzyTranspositions(bool? fuzzy } /// - /// Maximum number of terms to which the query will expand.
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// Maximum number of terms to which the query will expand. + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public MatchBoolPrefixQueryDescriptor MaxExpansions(int? maxExpansions) { @@ -349,7 +399,10 @@ public MatchBoolPrefixQueryDescriptor MaxExpansions(int? maxExpansion } /// - /// Minimum number of clauses that must match for a document to be returned.
Applied to the constructed bool query. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// Applied to the constructed bool query. + /// /// public MatchBoolPrefixQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.Serverless.MinimumShouldMatch? minimumShouldMatch) { @@ -358,7 +411,10 @@ public MatchBoolPrefixQueryDescriptor MinimumShouldMatch(Elastic.Clie } /// - /// Boolean logic used to interpret text in the query value.
Applied to the constructed bool query. + /// + /// Boolean logic used to interpret text in the query value. + /// Applied to the constructed bool query. + /// /// public MatchBoolPrefixQueryDescriptor Operator(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Operator? value) { @@ -367,7 +423,10 @@ public MatchBoolPrefixQueryDescriptor Operator(Elastic.Clients.Elasti } /// - /// Number of beginning characters left unchanged for fuzzy matching.
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public MatchBoolPrefixQueryDescriptor PrefixLength(int? prefixLength) { @@ -376,7 +435,10 @@ public MatchBoolPrefixQueryDescriptor PrefixLength(int? prefixLength) } /// - /// Terms you wish to find in the provided field.
The last term is used in a prefix query. + /// + /// Terms you wish to find in the provided field. + /// The last term is used in a prefix query. + /// /// public MatchBoolPrefixQueryDescriptor Query(string query) { @@ -486,7 +548,9 @@ public MatchBoolPrefixQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Analyzer used to convert the text in the query value into tokens. + /// + /// Analyzer used to convert the text in the query value into tokens. + /// /// public MatchBoolPrefixQueryDescriptor Analyzer(string? analyzer) { @@ -495,7 +559,12 @@ public MatchBoolPrefixQueryDescriptor Analyzer(string? analyzer) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public MatchBoolPrefixQueryDescriptor Boost(float? boost) { @@ -522,7 +591,10 @@ public MatchBoolPrefixQueryDescriptor Field(Expression - /// Maximum edit distance allowed for matching.
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// Maximum edit distance allowed for matching. + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public MatchBoolPrefixQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Serverless.Fuzziness? fuzziness) { @@ -531,7 +603,10 @@ public MatchBoolPrefixQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Se } /// - /// Method used to rewrite the query.
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// Method used to rewrite the query. + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public MatchBoolPrefixQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) { @@ -540,7 +615,10 @@ public MatchBoolPrefixQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) } /// - /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public MatchBoolPrefixQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true) { @@ -549,7 +627,10 @@ public MatchBoolPrefixQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositi } /// - /// Maximum number of terms to which the query will expand.
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// Maximum number of terms to which the query will expand. + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public MatchBoolPrefixQueryDescriptor MaxExpansions(int? maxExpansions) { @@ -558,7 +639,10 @@ public MatchBoolPrefixQueryDescriptor MaxExpansions(int? maxExpansions) } /// - /// Minimum number of clauses that must match for a document to be returned.
Applied to the constructed bool query. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// Applied to the constructed bool query. + /// /// public MatchBoolPrefixQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.Serverless.MinimumShouldMatch? minimumShouldMatch) { @@ -567,7 +651,10 @@ public MatchBoolPrefixQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elastic } /// - /// Boolean logic used to interpret text in the query value.
Applied to the constructed bool query. + /// + /// Boolean logic used to interpret text in the query value. + /// Applied to the constructed bool query. + /// /// public MatchBoolPrefixQueryDescriptor Operator(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Operator? value) { @@ -576,7 +663,10 @@ public MatchBoolPrefixQueryDescriptor Operator(Elastic.Clients.Elasticsearch.Ser } /// - /// Number of beginning characters left unchanged for fuzzy matching.
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public MatchBoolPrefixQueryDescriptor PrefixLength(int? prefixLength) { @@ -585,7 +675,10 @@ public MatchBoolPrefixQueryDescriptor PrefixLength(int? prefixLength) } /// - /// Terms you wish to find in the provided field.
The last term is used in a prefix query. + /// + /// Terms you wish to find in the provided field. + /// The last term is used in a prefix query. + /// /// public MatchBoolPrefixQueryDescriptor Query(string query) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MatchNoneQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MatchNoneQuery.g.cs index d84946b65b9..0d58a802da4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MatchNoneQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MatchNoneQuery.g.cs @@ -30,7 +30,12 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class MatchNoneQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } @@ -52,7 +57,12 @@ public MatchNoneQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public MatchNoneQueryDescriptor Boost(float? boost) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MatchPhrasePrefixQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MatchPhrasePrefixQuery.g.cs index cb67ab91328..037b01ac21b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MatchPhrasePrefixQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MatchPhrasePrefixQuery.g.cs @@ -153,34 +153,49 @@ public MatchPhrasePrefixQuery(Elastic.Clients.Elasticsearch.Serverless.Field fie } /// - /// Analyzer used to convert text in the query value into tokens. + /// + /// Analyzer used to convert text in the query value into tokens. + /// /// public string? Analyzer { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Maximum number of terms to which the last provided term of the query value will expand. + /// + /// Maximum number of terms to which the last provided term of the query value will expand. + /// /// public int? MaxExpansions { get; set; } /// - /// Text you wish to find in the provided field. + /// + /// Text you wish to find in the provided field. + /// /// public string Query { get; set; } public string? QueryName { get; set; } /// - /// Maximum number of positions allowed between matching tokens. + /// + /// Maximum number of positions allowed between matching tokens. + /// /// public int? Slop { get; set; } /// - /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter. + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter. + /// /// public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.ZeroTermsQuery? ZeroTermsQuery { get; set; } @@ -205,7 +220,9 @@ public MatchPhrasePrefixQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.ZeroTermsQuery? ZeroTermsQueryValue { get; set; } /// - /// Analyzer used to convert text in the query value into tokens. + /// + /// Analyzer used to convert text in the query value into tokens. + /// /// public MatchPhrasePrefixQueryDescriptor Analyzer(string? analyzer) { @@ -214,7 +231,12 @@ public MatchPhrasePrefixQueryDescriptor Analyzer(string? analyzer) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public MatchPhrasePrefixQueryDescriptor Boost(float? boost) { @@ -241,7 +263,9 @@ public MatchPhrasePrefixQueryDescriptor Field(Expression - /// Maximum number of terms to which the last provided term of the query value will expand. + /// + /// Maximum number of terms to which the last provided term of the query value will expand. + /// /// public MatchPhrasePrefixQueryDescriptor MaxExpansions(int? maxExpansions) { @@ -250,7 +274,9 @@ public MatchPhrasePrefixQueryDescriptor MaxExpansions(int? maxExpansi } /// - /// Text you wish to find in the provided field. + /// + /// Text you wish to find in the provided field. + /// /// public MatchPhrasePrefixQueryDescriptor Query(string query) { @@ -265,7 +291,9 @@ public MatchPhrasePrefixQueryDescriptor QueryName(string? queryName) } /// - /// Maximum number of positions allowed between matching tokens. + /// + /// Maximum number of positions allowed between matching tokens. + /// /// public MatchPhrasePrefixQueryDescriptor Slop(int? slop) { @@ -274,7 +302,9 @@ public MatchPhrasePrefixQueryDescriptor Slop(int? slop) } /// - /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter. + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter. + /// /// public MatchPhrasePrefixQueryDescriptor ZeroTermsQuery(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.ZeroTermsQuery? zeroTermsQuery) { @@ -350,7 +380,9 @@ public MatchPhrasePrefixQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.ZeroTermsQuery? ZeroTermsQueryValue { get; set; } /// - /// Analyzer used to convert text in the query value into tokens. + /// + /// Analyzer used to convert text in the query value into tokens. + /// /// public MatchPhrasePrefixQueryDescriptor Analyzer(string? analyzer) { @@ -359,7 +391,12 @@ public MatchPhrasePrefixQueryDescriptor Analyzer(string? analyzer) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public MatchPhrasePrefixQueryDescriptor Boost(float? boost) { @@ -386,7 +423,9 @@ public MatchPhrasePrefixQueryDescriptor Field(Expression - /// Maximum number of terms to which the last provided term of the query value will expand. + /// + /// Maximum number of terms to which the last provided term of the query value will expand. + /// /// public MatchPhrasePrefixQueryDescriptor MaxExpansions(int? maxExpansions) { @@ -395,7 +434,9 @@ public MatchPhrasePrefixQueryDescriptor MaxExpansions(int? maxExpansions) } /// - /// Text you wish to find in the provided field. + /// + /// Text you wish to find in the provided field. + /// /// public MatchPhrasePrefixQueryDescriptor Query(string query) { @@ -410,7 +451,9 @@ public MatchPhrasePrefixQueryDescriptor QueryName(string? queryName) } /// - /// Maximum number of positions allowed between matching tokens. + /// + /// Maximum number of positions allowed between matching tokens. + /// /// public MatchPhrasePrefixQueryDescriptor Slop(int? slop) { @@ -419,7 +462,9 @@ public MatchPhrasePrefixQueryDescriptor Slop(int? slop) } /// - /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter. + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter. + /// /// public MatchPhrasePrefixQueryDescriptor ZeroTermsQuery(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.ZeroTermsQuery? zeroTermsQuery) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MatchPhraseQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MatchPhraseQuery.g.cs index 5f170d6376a..e19091ee3da 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MatchPhraseQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MatchPhraseQuery.g.cs @@ -141,29 +141,42 @@ public MatchPhraseQuery(Elastic.Clients.Elasticsearch.Serverless.Field field) } /// - /// Analyzer used to convert the text in the query value into tokens. + /// + /// Analyzer used to convert the text in the query value into tokens. + /// /// public string? Analyzer { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Query terms that are analyzed and turned into a phrase query. + /// + /// Query terms that are analyzed and turned into a phrase query. + /// /// public string Query { get; set; } public string? QueryName { get; set; } /// - /// Maximum number of positions allowed between matching tokens. + /// + /// Maximum number of positions allowed between matching tokens. + /// /// public int? Slop { get; set; } /// - /// Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter. + /// /// public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.ZeroTermsQuery? ZeroTermsQuery { get; set; } @@ -187,7 +200,9 @@ public MatchPhraseQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.ZeroTermsQuery? ZeroTermsQueryValue { get; set; } /// - /// Analyzer used to convert the text in the query value into tokens. + /// + /// Analyzer used to convert the text in the query value into tokens. + /// /// public MatchPhraseQueryDescriptor Analyzer(string? analyzer) { @@ -196,7 +211,12 @@ public MatchPhraseQueryDescriptor Analyzer(string? analyzer) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public MatchPhraseQueryDescriptor Boost(float? boost) { @@ -223,7 +243,9 @@ public MatchPhraseQueryDescriptor Field(Expression - /// Query terms that are analyzed and turned into a phrase query. + /// + /// Query terms that are analyzed and turned into a phrase query. + /// /// public MatchPhraseQueryDescriptor Query(string query) { @@ -238,7 +260,9 @@ public MatchPhraseQueryDescriptor QueryName(string? queryName) } /// - /// Maximum number of positions allowed between matching tokens. + /// + /// Maximum number of positions allowed between matching tokens. + /// /// public MatchPhraseQueryDescriptor Slop(int? slop) { @@ -247,7 +271,9 @@ public MatchPhraseQueryDescriptor Slop(int? slop) } /// - /// Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter. + /// /// public MatchPhraseQueryDescriptor ZeroTermsQuery(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.ZeroTermsQuery? zeroTermsQuery) { @@ -316,7 +342,9 @@ public MatchPhraseQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.ZeroTermsQuery? ZeroTermsQueryValue { get; set; } /// - /// Analyzer used to convert the text in the query value into tokens. + /// + /// Analyzer used to convert the text in the query value into tokens. + /// /// public MatchPhraseQueryDescriptor Analyzer(string? analyzer) { @@ -325,7 +353,12 @@ public MatchPhraseQueryDescriptor Analyzer(string? analyzer) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public MatchPhraseQueryDescriptor Boost(float? boost) { @@ -352,7 +385,9 @@ public MatchPhraseQueryDescriptor Field(Expression - /// Query terms that are analyzed and turned into a phrase query. + /// + /// Query terms that are analyzed and turned into a phrase query. + /// /// public MatchPhraseQueryDescriptor Query(string query) { @@ -367,7 +402,9 @@ public MatchPhraseQueryDescriptor QueryName(string? queryName) } /// - /// Maximum number of positions allowed between matching tokens. + /// + /// Maximum number of positions allowed between matching tokens. + /// /// public MatchPhraseQueryDescriptor Slop(int? slop) { @@ -376,7 +413,9 @@ public MatchPhraseQueryDescriptor Slop(int? slop) } /// - /// Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter. + /// /// public MatchPhraseQueryDescriptor ZeroTermsQuery(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.ZeroTermsQuery? zeroTermsQuery) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MatchQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MatchQuery.g.cs index 8441e796b25..da8b5240a59 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MatchQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MatchQuery.g.cs @@ -237,69 +237,98 @@ public MatchQuery(Elastic.Clients.Elasticsearch.Serverless.Field field) } /// - /// Analyzer used to convert the text in the query value into tokens. + /// + /// Analyzer used to convert the text in the query value into tokens. + /// /// public string? Analyzer { get; set; } /// - /// If `true`, match phrase queries are automatically created for multi-term synonyms. + /// + /// If true, match phrase queries are automatically created for multi-term synonyms. + /// /// public bool? AutoGenerateSynonymsPhraseQuery { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Maximum edit distance allowed for matching. + /// + /// Maximum edit distance allowed for matching. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Fuzziness? Fuzziness { get; set; } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public string? FuzzyRewrite { get; set; } /// - /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// + /// If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). + /// /// public bool? FuzzyTranspositions { get; set; } /// - /// If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. + /// + /// If true, format-based errors, such as providing a text query value for a numeric field, are ignored. + /// /// public bool? Lenient { get; set; } /// - /// Maximum number of terms to which the query will expand. + /// + /// Maximum number of terms to which the query will expand. + /// /// public int? MaxExpansions { get; set; } /// - /// Minimum number of clauses that must match for a document to be returned. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// /// public Elastic.Clients.Elasticsearch.Serverless.MinimumShouldMatch? MinimumShouldMatch { get; set; } /// - /// Boolean logic used to interpret text in the query value. + /// + /// Boolean logic used to interpret text in the query value. + /// /// public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Operator? Operator { get; set; } /// - /// Number of beginning characters left unchanged for fuzzy matching. + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// /// public int? PrefixLength { get; set; } /// - /// Text, number, boolean value or date you wish to find in the provided field. + /// + /// Text, number, boolean value or date you wish to find in the provided field. + /// /// public object Query { get; set; } public string? QueryName { get; set; } /// - /// Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter. + /// /// public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.ZeroTermsQuery? ZeroTermsQuery { get; set; } @@ -331,7 +360,9 @@ public MatchQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.ZeroTermsQuery? ZeroTermsQueryValue { get; set; } /// - /// Analyzer used to convert the text in the query value into tokens. + /// + /// Analyzer used to convert the text in the query value into tokens. + /// /// public MatchQueryDescriptor Analyzer(string? analyzer) { @@ -340,7 +371,9 @@ public MatchQueryDescriptor Analyzer(string? analyzer) } /// - /// If `true`, match phrase queries are automatically created for multi-term synonyms. + /// + /// If true, match phrase queries are automatically created for multi-term synonyms. + /// /// public MatchQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSynonymsPhraseQuery = true) { @@ -349,7 +382,12 @@ public MatchQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? aut } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public MatchQueryDescriptor Boost(float? boost) { @@ -376,7 +414,9 @@ public MatchQueryDescriptor Field(Expression> } /// - /// Maximum edit distance allowed for matching. + /// + /// Maximum edit distance allowed for matching. + /// /// public MatchQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Serverless.Fuzziness? fuzziness) { @@ -385,7 +425,9 @@ public MatchQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.S } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public MatchQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) { @@ -394,7 +436,9 @@ public MatchQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) } /// - /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// + /// If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). + /// /// public MatchQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true) { @@ -403,7 +447,9 @@ public MatchQueryDescriptor FuzzyTranspositions(bool? fuzzyTransposit } /// - /// If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. + /// + /// If true, format-based errors, such as providing a text query value for a numeric field, are ignored. + /// /// public MatchQueryDescriptor Lenient(bool? lenient = true) { @@ -412,7 +458,9 @@ public MatchQueryDescriptor Lenient(bool? lenient = true) } /// - /// Maximum number of terms to which the query will expand. + /// + /// Maximum number of terms to which the query will expand. + /// /// public MatchQueryDescriptor MaxExpansions(int? maxExpansions) { @@ -421,7 +469,9 @@ public MatchQueryDescriptor MaxExpansions(int? maxExpansions) } /// - /// Minimum number of clauses that must match for a document to be returned. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// /// public MatchQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.Serverless.MinimumShouldMatch? minimumShouldMatch) { @@ -430,7 +480,9 @@ public MatchQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasti } /// - /// Boolean logic used to interpret text in the query value. + /// + /// Boolean logic used to interpret text in the query value. + /// /// public MatchQueryDescriptor Operator(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Operator? value) { @@ -439,7 +491,9 @@ public MatchQueryDescriptor Operator(Elastic.Clients.Elasticsearch.Se } /// - /// Number of beginning characters left unchanged for fuzzy matching. + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// /// public MatchQueryDescriptor PrefixLength(int? prefixLength) { @@ -448,7 +502,9 @@ public MatchQueryDescriptor PrefixLength(int? prefixLength) } /// - /// Text, number, boolean value or date you wish to find in the provided field. + /// + /// Text, number, boolean value or date you wish to find in the provided field. + /// /// public MatchQueryDescriptor Query(object query) { @@ -463,7 +519,9 @@ public MatchQueryDescriptor QueryName(string? queryName) } /// - /// Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter. + /// /// public MatchQueryDescriptor ZeroTermsQuery(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.ZeroTermsQuery? zeroTermsQuery) { @@ -588,7 +646,9 @@ public MatchQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.ZeroTermsQuery? ZeroTermsQueryValue { get; set; } /// - /// Analyzer used to convert the text in the query value into tokens. + /// + /// Analyzer used to convert the text in the query value into tokens. + /// /// public MatchQueryDescriptor Analyzer(string? analyzer) { @@ -597,7 +657,9 @@ public MatchQueryDescriptor Analyzer(string? analyzer) } /// - /// If `true`, match phrase queries are automatically created for multi-term synonyms. + /// + /// If true, match phrase queries are automatically created for multi-term synonyms. + /// /// public MatchQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSynonymsPhraseQuery = true) { @@ -606,7 +668,12 @@ public MatchQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSy } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public MatchQueryDescriptor Boost(float? boost) { @@ -633,7 +700,9 @@ public MatchQueryDescriptor Field(Expression> } /// - /// Maximum edit distance allowed for matching. + /// + /// Maximum edit distance allowed for matching. + /// /// public MatchQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Serverless.Fuzziness? fuzziness) { @@ -642,7 +711,9 @@ public MatchQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Serverless.F } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public MatchQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) { @@ -651,7 +722,9 @@ public MatchQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) } /// - /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// + /// If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). + /// /// public MatchQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true) { @@ -660,7 +733,9 @@ public MatchQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true } /// - /// If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. + /// + /// If true, format-based errors, such as providing a text query value for a numeric field, are ignored. + /// /// public MatchQueryDescriptor Lenient(bool? lenient = true) { @@ -669,7 +744,9 @@ public MatchQueryDescriptor Lenient(bool? lenient = true) } /// - /// Maximum number of terms to which the query will expand. + /// + /// Maximum number of terms to which the query will expand. + /// /// public MatchQueryDescriptor MaxExpansions(int? maxExpansions) { @@ -678,7 +755,9 @@ public MatchQueryDescriptor MaxExpansions(int? maxExpansions) } /// - /// Minimum number of clauses that must match for a document to be returned. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// /// public MatchQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.Serverless.MinimumShouldMatch? minimumShouldMatch) { @@ -687,7 +766,9 @@ public MatchQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.Ser } /// - /// Boolean logic used to interpret text in the query value. + /// + /// Boolean logic used to interpret text in the query value. + /// /// public MatchQueryDescriptor Operator(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Operator? value) { @@ -696,7 +777,9 @@ public MatchQueryDescriptor Operator(Elastic.Clients.Elasticsearch.Serverless.Qu } /// - /// Number of beginning characters left unchanged for fuzzy matching. + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// /// public MatchQueryDescriptor PrefixLength(int? prefixLength) { @@ -705,7 +788,9 @@ public MatchQueryDescriptor PrefixLength(int? prefixLength) } /// - /// Text, number, boolean value or date you wish to find in the provided field. + /// + /// Text, number, boolean value or date you wish to find in the provided field. + /// /// public MatchQueryDescriptor Query(object query) { @@ -720,7 +805,9 @@ public MatchQueryDescriptor QueryName(string? queryName) } /// - /// Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter. + /// /// public MatchQueryDescriptor ZeroTermsQuery(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.ZeroTermsQuery? zeroTermsQuery) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MoreLikeThisQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MoreLikeThisQuery.g.cs index 65aae628c9f..96910cced47 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MoreLikeThisQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MoreLikeThisQuery.g.cs @@ -30,87 +30,123 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class MoreLikeThisQuery { /// - /// The analyzer that is used to analyze the free form text.
Defaults to the analyzer associated with the first field in fields. + /// + /// The analyzer that is used to analyze the free form text. + /// Defaults to the analyzer associated with the first field in fields. + /// /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Each term in the formed query could be further boosted by their tf-idf score.
This sets the boost factor to use when using this feature.
Defaults to deactivated (0). + /// + /// Each term in the formed query could be further boosted by their tf-idf score. + /// This sets the boost factor to use when using this feature. + /// Defaults to deactivated (0). + /// /// [JsonInclude, JsonPropertyName("boost_terms")] public double? BoostTerms { get; set; } /// - /// Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (`text` or `keyword`). + /// + /// Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (text or keyword). + /// /// [JsonInclude, JsonPropertyName("fail_on_unsupported_field")] public bool? FailOnUnsupportedField { get; set; } /// - /// A list of fields to fetch and analyze the text from.
Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + /// + /// A list of fields to fetch and analyze the text from. + /// Defaults to the index.query.default_field index setting, which has a default value of *. + /// /// [JsonInclude, JsonPropertyName("fields")] [JsonConverter(typeof(FieldsConverter))] public Elastic.Clients.Elasticsearch.Serverless.Fields? Fields { get; set; } /// - /// Specifies whether the input documents should also be included in the search results returned. + /// + /// Specifies whether the input documents should also be included in the search results returned. + /// /// [JsonInclude, JsonPropertyName("include")] public bool? Include { get; set; } /// - /// Specifies free form text and/or a single or multiple documents for which you want to find similar documents. + /// + /// Specifies free form text and/or a single or multiple documents for which you want to find similar documents. + /// /// [JsonInclude, JsonPropertyName("like")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Like))] public ICollection Like { get; set; } /// - /// The maximum document frequency above which the terms are ignored from the input document. + /// + /// The maximum document frequency above which the terms are ignored from the input document. + /// /// [JsonInclude, JsonPropertyName("max_doc_freq")] public int? MaxDocFreq { get; set; } /// - /// The maximum number of query terms that can be selected. + /// + /// The maximum number of query terms that can be selected. + /// /// [JsonInclude, JsonPropertyName("max_query_terms")] public int? MaxQueryTerms { get; set; } /// - /// The maximum word length above which the terms are ignored.
Defaults to unbounded (`0`). + /// + /// The maximum word length above which the terms are ignored. + /// Defaults to unbounded (0). + /// /// [JsonInclude, JsonPropertyName("max_word_length")] public int? MaxWordLength { get; set; } /// - /// The minimum document frequency below which the terms are ignored from the input document. + /// + /// The minimum document frequency below which the terms are ignored from the input document. + /// /// [JsonInclude, JsonPropertyName("min_doc_freq")] public int? MinDocFreq { get; set; } /// - /// After the disjunctive query has been formed, this parameter controls the number of terms that must match. + /// + /// After the disjunctive query has been formed, this parameter controls the number of terms that must match. + /// /// [JsonInclude, JsonPropertyName("minimum_should_match")] public Elastic.Clients.Elasticsearch.Serverless.MinimumShouldMatch? MinimumShouldMatch { get; set; } /// - /// The minimum term frequency below which the terms are ignored from the input document. + /// + /// The minimum term frequency below which the terms are ignored from the input document. + /// /// [JsonInclude, JsonPropertyName("min_term_freq")] public int? MinTermFreq { get; set; } /// - /// The minimum word length below which the terms are ignored. + /// + /// The minimum word length below which the terms are ignored. + /// /// [JsonInclude, JsonPropertyName("min_word_length")] public int? MinWordLength { get; set; } @@ -120,14 +156,19 @@ public sealed partial class MoreLikeThisQuery public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get; set; } /// - /// An array of stop words.
Any word in this set is ignored. + /// + /// An array of stop words. + /// Any word in this set is ignored. + /// /// [JsonInclude, JsonPropertyName("stop_words")] [SingleOrManyCollectionConverter(typeof(string))] public ICollection? StopWords { get; set; } /// - /// Used in combination with `like` to exclude documents that match a set of terms. + /// + /// Used in combination with like to exclude documents that match a set of terms. + /// /// [JsonInclude, JsonPropertyName("unlike")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Like))] @@ -170,7 +211,10 @@ public MoreLikeThisQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.VersionType? VersionTypeValue { get; set; } /// - /// The analyzer that is used to analyze the free form text.
Defaults to the analyzer associated with the first field in fields. + /// + /// The analyzer that is used to analyze the free form text. + /// Defaults to the analyzer associated with the first field in fields. + /// /// public MoreLikeThisQueryDescriptor Analyzer(string? analyzer) { @@ -179,7 +223,12 @@ public MoreLikeThisQueryDescriptor Analyzer(string? analyzer) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public MoreLikeThisQueryDescriptor Boost(float? boost) { @@ -188,7 +237,11 @@ public MoreLikeThisQueryDescriptor Boost(float? boost) } /// - /// Each term in the formed query could be further boosted by their tf-idf score.
This sets the boost factor to use when using this feature.
Defaults to deactivated (0). + /// + /// Each term in the formed query could be further boosted by their tf-idf score. + /// This sets the boost factor to use when using this feature. + /// Defaults to deactivated (0). + /// /// public MoreLikeThisQueryDescriptor BoostTerms(double? boostTerms) { @@ -197,7 +250,9 @@ public MoreLikeThisQueryDescriptor BoostTerms(double? boostTerms) } /// - /// Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (`text` or `keyword`). + /// + /// Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (text or keyword). + /// /// public MoreLikeThisQueryDescriptor FailOnUnsupportedField(bool? failOnUnsupportedField = true) { @@ -206,7 +261,10 @@ public MoreLikeThisQueryDescriptor FailOnUnsupportedField(bool? failO } /// - /// A list of fields to fetch and analyze the text from.
Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + /// + /// A list of fields to fetch and analyze the text from. + /// Defaults to the index.query.default_field index setting, which has a default value of *. + /// /// public MoreLikeThisQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Serverless.Fields? fields) { @@ -215,7 +273,9 @@ public MoreLikeThisQueryDescriptor Fields(Elastic.Clients.Elasticsear } /// - /// Specifies whether the input documents should also be included in the search results returned. + /// + /// Specifies whether the input documents should also be included in the search results returned. + /// /// public MoreLikeThisQueryDescriptor Include(bool? include = true) { @@ -224,7 +284,9 @@ public MoreLikeThisQueryDescriptor Include(bool? include = true) } /// - /// Specifies free form text and/or a single or multiple documents for which you want to find similar documents. + /// + /// Specifies free form text and/or a single or multiple documents for which you want to find similar documents. + /// /// public MoreLikeThisQueryDescriptor Like(ICollection like) { @@ -233,7 +295,9 @@ public MoreLikeThisQueryDescriptor Like(ICollection - /// The maximum document frequency above which the terms are ignored from the input document. + /// + /// The maximum document frequency above which the terms are ignored from the input document. + /// /// public MoreLikeThisQueryDescriptor MaxDocFreq(int? maxDocFreq) { @@ -242,7 +306,9 @@ public MoreLikeThisQueryDescriptor MaxDocFreq(int? maxDocFreq) } /// - /// The maximum number of query terms that can be selected. + /// + /// The maximum number of query terms that can be selected. + /// /// public MoreLikeThisQueryDescriptor MaxQueryTerms(int? maxQueryTerms) { @@ -251,7 +317,10 @@ public MoreLikeThisQueryDescriptor MaxQueryTerms(int? maxQueryTerms) } /// - /// The maximum word length above which the terms are ignored.
Defaults to unbounded (`0`). + /// + /// The maximum word length above which the terms are ignored. + /// Defaults to unbounded (0). + /// /// public MoreLikeThisQueryDescriptor MaxWordLength(int? maxWordLength) { @@ -260,7 +329,9 @@ public MoreLikeThisQueryDescriptor MaxWordLength(int? maxWordLength) } /// - /// The minimum document frequency below which the terms are ignored from the input document. + /// + /// The minimum document frequency below which the terms are ignored from the input document. + /// /// public MoreLikeThisQueryDescriptor MinDocFreq(int? minDocFreq) { @@ -269,7 +340,9 @@ public MoreLikeThisQueryDescriptor MinDocFreq(int? minDocFreq) } /// - /// After the disjunctive query has been formed, this parameter controls the number of terms that must match. + /// + /// After the disjunctive query has been formed, this parameter controls the number of terms that must match. + /// /// public MoreLikeThisQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.Serverless.MinimumShouldMatch? minimumShouldMatch) { @@ -278,7 +351,9 @@ public MoreLikeThisQueryDescriptor MinimumShouldMatch(Elastic.Clients } /// - /// The minimum term frequency below which the terms are ignored from the input document. + /// + /// The minimum term frequency below which the terms are ignored from the input document. + /// /// public MoreLikeThisQueryDescriptor MinTermFreq(int? minTermFreq) { @@ -287,7 +362,9 @@ public MoreLikeThisQueryDescriptor MinTermFreq(int? minTermFreq) } /// - /// The minimum word length below which the terms are ignored. + /// + /// The minimum word length below which the terms are ignored. + /// /// public MoreLikeThisQueryDescriptor MinWordLength(int? minWordLength) { @@ -308,7 +385,10 @@ public MoreLikeThisQueryDescriptor Routing(Elastic.Clients.Elasticsea } /// - /// An array of stop words.
Any word in this set is ignored. + /// + /// An array of stop words. + /// Any word in this set is ignored. + /// /// public MoreLikeThisQueryDescriptor StopWords(ICollection? stopWords) { @@ -317,7 +397,9 @@ public MoreLikeThisQueryDescriptor StopWords(ICollection? sto } /// - /// Used in combination with `like` to exclude documents that match a set of terms. + /// + /// Used in combination with like to exclude documents that match a set of terms. + /// /// public MoreLikeThisQueryDescriptor Unlike(ICollection? unlike) { @@ -490,7 +572,10 @@ public MoreLikeThisQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.VersionType? VersionTypeValue { get; set; } /// - /// The analyzer that is used to analyze the free form text.
Defaults to the analyzer associated with the first field in fields. + /// + /// The analyzer that is used to analyze the free form text. + /// Defaults to the analyzer associated with the first field in fields. + /// /// public MoreLikeThisQueryDescriptor Analyzer(string? analyzer) { @@ -499,7 +584,12 @@ public MoreLikeThisQueryDescriptor Analyzer(string? analyzer) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public MoreLikeThisQueryDescriptor Boost(float? boost) { @@ -508,7 +598,11 @@ public MoreLikeThisQueryDescriptor Boost(float? boost) } /// - /// Each term in the formed query could be further boosted by their tf-idf score.
This sets the boost factor to use when using this feature.
Defaults to deactivated (0). + /// + /// Each term in the formed query could be further boosted by their tf-idf score. + /// This sets the boost factor to use when using this feature. + /// Defaults to deactivated (0). + /// /// public MoreLikeThisQueryDescriptor BoostTerms(double? boostTerms) { @@ -517,7 +611,9 @@ public MoreLikeThisQueryDescriptor BoostTerms(double? boostTerms) } /// - /// Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (`text` or `keyword`). + /// + /// Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (text or keyword). + /// /// public MoreLikeThisQueryDescriptor FailOnUnsupportedField(bool? failOnUnsupportedField = true) { @@ -526,7 +622,10 @@ public MoreLikeThisQueryDescriptor FailOnUnsupportedField(bool? failOnUnsupporte } /// - /// A list of fields to fetch and analyze the text from.
Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + /// + /// A list of fields to fetch and analyze the text from. + /// Defaults to the index.query.default_field index setting, which has a default value of *. + /// /// public MoreLikeThisQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Serverless.Fields? fields) { @@ -535,7 +634,9 @@ public MoreLikeThisQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Serverle } /// - /// Specifies whether the input documents should also be included in the search results returned. + /// + /// Specifies whether the input documents should also be included in the search results returned. + /// /// public MoreLikeThisQueryDescriptor Include(bool? include = true) { @@ -544,7 +645,9 @@ public MoreLikeThisQueryDescriptor Include(bool? include = true) } /// - /// Specifies free form text and/or a single or multiple documents for which you want to find similar documents. + /// + /// Specifies free form text and/or a single or multiple documents for which you want to find similar documents. + /// /// public MoreLikeThisQueryDescriptor Like(ICollection like) { @@ -553,7 +656,9 @@ public MoreLikeThisQueryDescriptor Like(ICollection - /// The maximum document frequency above which the terms are ignored from the input document. + /// + /// The maximum document frequency above which the terms are ignored from the input document. + /// /// public MoreLikeThisQueryDescriptor MaxDocFreq(int? maxDocFreq) { @@ -562,7 +667,9 @@ public MoreLikeThisQueryDescriptor MaxDocFreq(int? maxDocFreq) } /// - /// The maximum number of query terms that can be selected. + /// + /// The maximum number of query terms that can be selected. + /// /// public MoreLikeThisQueryDescriptor MaxQueryTerms(int? maxQueryTerms) { @@ -571,7 +678,10 @@ public MoreLikeThisQueryDescriptor MaxQueryTerms(int? maxQueryTerms) } /// - /// The maximum word length above which the terms are ignored.
Defaults to unbounded (`0`). + /// + /// The maximum word length above which the terms are ignored. + /// Defaults to unbounded (0). + /// /// public MoreLikeThisQueryDescriptor MaxWordLength(int? maxWordLength) { @@ -580,7 +690,9 @@ public MoreLikeThisQueryDescriptor MaxWordLength(int? maxWordLength) } /// - /// The minimum document frequency below which the terms are ignored from the input document. + /// + /// The minimum document frequency below which the terms are ignored from the input document. + /// /// public MoreLikeThisQueryDescriptor MinDocFreq(int? minDocFreq) { @@ -589,7 +701,9 @@ public MoreLikeThisQueryDescriptor MinDocFreq(int? minDocFreq) } /// - /// After the disjunctive query has been formed, this parameter controls the number of terms that must match. + /// + /// After the disjunctive query has been formed, this parameter controls the number of terms that must match. + /// /// public MoreLikeThisQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.Serverless.MinimumShouldMatch? minimumShouldMatch) { @@ -598,7 +712,9 @@ public MoreLikeThisQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsea } /// - /// The minimum term frequency below which the terms are ignored from the input document. + /// + /// The minimum term frequency below which the terms are ignored from the input document. + /// /// public MoreLikeThisQueryDescriptor MinTermFreq(int? minTermFreq) { @@ -607,7 +723,9 @@ public MoreLikeThisQueryDescriptor MinTermFreq(int? minTermFreq) } /// - /// The minimum word length below which the terms are ignored. + /// + /// The minimum word length below which the terms are ignored. + /// /// public MoreLikeThisQueryDescriptor MinWordLength(int? minWordLength) { @@ -628,7 +746,10 @@ public MoreLikeThisQueryDescriptor Routing(Elastic.Clients.Elasticsearch.Serverl } /// - /// An array of stop words.
Any word in this set is ignored. + /// + /// An array of stop words. + /// Any word in this set is ignored. + /// /// public MoreLikeThisQueryDescriptor StopWords(ICollection? stopWords) { @@ -637,7 +758,9 @@ public MoreLikeThisQueryDescriptor StopWords(ICollection? stopWords) } /// - /// Used in combination with `like` to exclude documents that match a set of terms. + /// + /// Used in combination with like to exclude documents that match a set of terms. + /// /// public MoreLikeThisQueryDescriptor Unlike(ICollection? unlike) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MultiMatchQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MultiMatchQuery.g.cs index 812d0b8c2a2..46c3e3aab35 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MultiMatchQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/MultiMatchQuery.g.cs @@ -30,80 +30,111 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class MultiMatchQuery { /// - /// Analyzer used to convert the text in the query value into tokens. + /// + /// Analyzer used to convert the text in the query value into tokens. + /// /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } /// - /// If `true`, match phrase queries are automatically created for multi-term synonyms. + /// + /// If true, match phrase queries are automatically created for multi-term synonyms. + /// /// [JsonInclude, JsonPropertyName("auto_generate_synonyms_phrase_query")] public bool? AutoGenerateSynonymsPhraseQuery { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// The fields to be queried.
Defaults to the `index.query.default_field` index settings, which in turn defaults to `*`. + /// + /// The fields to be queried. + /// Defaults to the index.query.default_field index settings, which in turn defaults to *. + /// /// [JsonInclude, JsonPropertyName("fields")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] public Elastic.Clients.Elasticsearch.Serverless.Fields? Fields { get; set; } /// - /// Maximum edit distance allowed for matching. + /// + /// Maximum edit distance allowed for matching. + /// /// [JsonInclude, JsonPropertyName("fuzziness")] public Elastic.Clients.Elasticsearch.Serverless.Fuzziness? Fuzziness { get; set; } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// [JsonInclude, JsonPropertyName("fuzzy_rewrite")] public string? FuzzyRewrite { get; set; } /// - /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// [JsonInclude, JsonPropertyName("fuzzy_transpositions")] public bool? FuzzyTranspositions { get; set; } /// - /// If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. + /// + /// If true, format-based errors, such as providing a text query value for a numeric field, are ignored. + /// /// [JsonInclude, JsonPropertyName("lenient")] public bool? Lenient { get; set; } /// - /// Maximum number of terms to which the query will expand. + /// + /// Maximum number of terms to which the query will expand. + /// /// [JsonInclude, JsonPropertyName("max_expansions")] public int? MaxExpansions { get; set; } /// - /// Minimum number of clauses that must match for a document to be returned. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// /// [JsonInclude, JsonPropertyName("minimum_should_match")] public Elastic.Clients.Elasticsearch.Serverless.MinimumShouldMatch? MinimumShouldMatch { get; set; } /// - /// Boolean logic used to interpret text in the query value. + /// + /// Boolean logic used to interpret text in the query value. + /// /// [JsonInclude, JsonPropertyName("operator")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Operator? Operator { get; set; } /// - /// Number of beginning characters left unchanged for fuzzy matching. + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// /// [JsonInclude, JsonPropertyName("prefix_length")] public int? PrefixLength { get; set; } /// - /// Text, number, boolean value or date you wish to find in the provided field. + /// + /// Text, number, boolean value or date you wish to find in the provided field. + /// /// [JsonInclude, JsonPropertyName("query")] public string Query { get; set; } @@ -111,25 +142,33 @@ public sealed partial class MultiMatchQuery public string? QueryName { get; set; } /// - /// Maximum number of positions allowed between matching tokens. + /// + /// Maximum number of positions allowed between matching tokens. + /// /// [JsonInclude, JsonPropertyName("slop")] public int? Slop { get; set; } /// - /// Determines how scores for each per-term blended query and scores across groups are combined. + /// + /// Determines how scores for each per-term blended query and scores across groups are combined. + /// /// [JsonInclude, JsonPropertyName("tie_breaker")] public double? TieBreaker { get; set; } /// - /// How `the` multi_match query is executed internally. + /// + /// How the multi_match query is executed internally. + /// /// [JsonInclude, JsonPropertyName("type")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TextQueryType? Type { get; set; } /// - /// Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter. + /// /// [JsonInclude, JsonPropertyName("zero_terms_query")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.ZeroTermsQuery? ZeroTermsQuery { get; set; } @@ -165,7 +204,9 @@ public MultiMatchQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.ZeroTermsQuery? ZeroTermsQueryValue { get; set; } /// - /// Analyzer used to convert the text in the query value into tokens. + /// + /// Analyzer used to convert the text in the query value into tokens. + /// /// public MultiMatchQueryDescriptor Analyzer(string? analyzer) { @@ -174,7 +215,9 @@ public MultiMatchQueryDescriptor Analyzer(string? analyzer) } /// - /// If `true`, match phrase queries are automatically created for multi-term synonyms. + /// + /// If true, match phrase queries are automatically created for multi-term synonyms. + /// /// public MultiMatchQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSynonymsPhraseQuery = true) { @@ -183,7 +226,12 @@ public MultiMatchQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public MultiMatchQueryDescriptor Boost(float? boost) { @@ -192,7 +240,10 @@ public MultiMatchQueryDescriptor Boost(float? boost) } /// - /// The fields to be queried.
Defaults to the `index.query.default_field` index settings, which in turn defaults to `*`. + /// + /// The fields to be queried. + /// Defaults to the index.query.default_field index settings, which in turn defaults to *. + /// /// public MultiMatchQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Serverless.Fields? fields) { @@ -201,7 +252,9 @@ public MultiMatchQueryDescriptor Fields(Elastic.Clients.Elasticsearch } /// - /// Maximum edit distance allowed for matching. + /// + /// Maximum edit distance allowed for matching. + /// /// public MultiMatchQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Serverless.Fuzziness? fuzziness) { @@ -210,7 +263,9 @@ public MultiMatchQueryDescriptor Fuzziness(Elastic.Clients.Elasticsea } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public MultiMatchQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) { @@ -219,7 +274,10 @@ public MultiMatchQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) } /// - /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public MultiMatchQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true) { @@ -228,7 +286,9 @@ public MultiMatchQueryDescriptor FuzzyTranspositions(bool? fuzzyTrans } /// - /// If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. + /// + /// If true, format-based errors, such as providing a text query value for a numeric field, are ignored. + /// /// public MultiMatchQueryDescriptor Lenient(bool? lenient = true) { @@ -237,7 +297,9 @@ public MultiMatchQueryDescriptor Lenient(bool? lenient = true) } /// - /// Maximum number of terms to which the query will expand. + /// + /// Maximum number of terms to which the query will expand. + /// /// public MultiMatchQueryDescriptor MaxExpansions(int? maxExpansions) { @@ -246,7 +308,9 @@ public MultiMatchQueryDescriptor MaxExpansions(int? maxExpansions) } /// - /// Minimum number of clauses that must match for a document to be returned. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// /// public MultiMatchQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.Serverless.MinimumShouldMatch? minimumShouldMatch) { @@ -255,7 +319,9 @@ public MultiMatchQueryDescriptor MinimumShouldMatch(Elastic.Clients.E } /// - /// Boolean logic used to interpret text in the query value. + /// + /// Boolean logic used to interpret text in the query value. + /// /// public MultiMatchQueryDescriptor Operator(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Operator? value) { @@ -264,7 +330,9 @@ public MultiMatchQueryDescriptor Operator(Elastic.Clients.Elasticsear } /// - /// Number of beginning characters left unchanged for fuzzy matching. + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// /// public MultiMatchQueryDescriptor PrefixLength(int? prefixLength) { @@ -273,7 +341,9 @@ public MultiMatchQueryDescriptor PrefixLength(int? prefixLength) } /// - /// Text, number, boolean value or date you wish to find in the provided field. + /// + /// Text, number, boolean value or date you wish to find in the provided field. + /// /// public MultiMatchQueryDescriptor Query(string query) { @@ -288,7 +358,9 @@ public MultiMatchQueryDescriptor QueryName(string? queryName) } /// - /// Maximum number of positions allowed between matching tokens. + /// + /// Maximum number of positions allowed between matching tokens. + /// /// public MultiMatchQueryDescriptor Slop(int? slop) { @@ -297,7 +369,9 @@ public MultiMatchQueryDescriptor Slop(int? slop) } /// - /// Determines how scores for each per-term blended query and scores across groups are combined. + /// + /// Determines how scores for each per-term blended query and scores across groups are combined. + /// /// public MultiMatchQueryDescriptor TieBreaker(double? tieBreaker) { @@ -306,7 +380,9 @@ public MultiMatchQueryDescriptor TieBreaker(double? tieBreaker) } /// - /// How `the` multi_match query is executed internally. + /// + /// How the multi_match query is executed internally. + /// /// public MultiMatchQueryDescriptor Type(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TextQueryType? type) { @@ -315,7 +391,9 @@ public MultiMatchQueryDescriptor Type(Elastic.Clients.Elasticsearch.S } /// - /// Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter. + /// /// public MultiMatchQueryDescriptor ZeroTermsQuery(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.ZeroTermsQuery? zeroTermsQuery) { @@ -462,7 +540,9 @@ public MultiMatchQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.ZeroTermsQuery? ZeroTermsQueryValue { get; set; } /// - /// Analyzer used to convert the text in the query value into tokens. + /// + /// Analyzer used to convert the text in the query value into tokens. + /// /// public MultiMatchQueryDescriptor Analyzer(string? analyzer) { @@ -471,7 +551,9 @@ public MultiMatchQueryDescriptor Analyzer(string? analyzer) } /// - /// If `true`, match phrase queries are automatically created for multi-term synonyms. + /// + /// If true, match phrase queries are automatically created for multi-term synonyms. + /// /// public MultiMatchQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSynonymsPhraseQuery = true) { @@ -480,7 +562,12 @@ public MultiMatchQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGener } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public MultiMatchQueryDescriptor Boost(float? boost) { @@ -489,7 +576,10 @@ public MultiMatchQueryDescriptor Boost(float? boost) } /// - /// The fields to be queried.
Defaults to the `index.query.default_field` index settings, which in turn defaults to `*`. + /// + /// The fields to be queried. + /// Defaults to the index.query.default_field index settings, which in turn defaults to *. + /// /// public MultiMatchQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Serverless.Fields? fields) { @@ -498,7 +588,9 @@ public MultiMatchQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Serverless } /// - /// Maximum edit distance allowed for matching. + /// + /// Maximum edit distance allowed for matching. + /// /// public MultiMatchQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Serverless.Fuzziness? fuzziness) { @@ -507,7 +599,9 @@ public MultiMatchQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Serverl } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public MultiMatchQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) { @@ -516,7 +610,10 @@ public MultiMatchQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) } /// - /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public MultiMatchQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true) { @@ -525,7 +622,9 @@ public MultiMatchQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = } /// - /// If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. + /// + /// If true, format-based errors, such as providing a text query value for a numeric field, are ignored. + /// /// public MultiMatchQueryDescriptor Lenient(bool? lenient = true) { @@ -534,7 +633,9 @@ public MultiMatchQueryDescriptor Lenient(bool? lenient = true) } /// - /// Maximum number of terms to which the query will expand. + /// + /// Maximum number of terms to which the query will expand. + /// /// public MultiMatchQueryDescriptor MaxExpansions(int? maxExpansions) { @@ -543,7 +644,9 @@ public MultiMatchQueryDescriptor MaxExpansions(int? maxExpansions) } /// - /// Minimum number of clauses that must match for a document to be returned. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// /// public MultiMatchQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.Serverless.MinimumShouldMatch? minimumShouldMatch) { @@ -552,7 +655,9 @@ public MultiMatchQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearc } /// - /// Boolean logic used to interpret text in the query value. + /// + /// Boolean logic used to interpret text in the query value. + /// /// public MultiMatchQueryDescriptor Operator(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Operator? value) { @@ -561,7 +666,9 @@ public MultiMatchQueryDescriptor Operator(Elastic.Clients.Elasticsearch.Serverle } /// - /// Number of beginning characters left unchanged for fuzzy matching. + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// /// public MultiMatchQueryDescriptor PrefixLength(int? prefixLength) { @@ -570,7 +677,9 @@ public MultiMatchQueryDescriptor PrefixLength(int? prefixLength) } /// - /// Text, number, boolean value or date you wish to find in the provided field. + /// + /// Text, number, boolean value or date you wish to find in the provided field. + /// /// public MultiMatchQueryDescriptor Query(string query) { @@ -585,7 +694,9 @@ public MultiMatchQueryDescriptor QueryName(string? queryName) } /// - /// Maximum number of positions allowed between matching tokens. + /// + /// Maximum number of positions allowed between matching tokens. + /// /// public MultiMatchQueryDescriptor Slop(int? slop) { @@ -594,7 +705,9 @@ public MultiMatchQueryDescriptor Slop(int? slop) } /// - /// Determines how scores for each per-term blended query and scores across groups are combined. + /// + /// Determines how scores for each per-term blended query and scores across groups are combined. + /// /// public MultiMatchQueryDescriptor TieBreaker(double? tieBreaker) { @@ -603,7 +716,9 @@ public MultiMatchQueryDescriptor TieBreaker(double? tieBreaker) } /// - /// How `the` multi_match query is executed internally. + /// + /// How the multi_match query is executed internally. + /// /// public MultiMatchQueryDescriptor Type(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TextQueryType? type) { @@ -612,7 +727,9 @@ public MultiMatchQueryDescriptor Type(Elastic.Clients.Elasticsearch.Serverless.Q } /// - /// Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter. + /// /// public MultiMatchQueryDescriptor ZeroTermsQuery(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.ZeroTermsQuery? zeroTermsQuery) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/NestedQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/NestedQuery.g.cs index c707efc067d..48e9726c723 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/NestedQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/NestedQuery.g.cs @@ -30,31 +30,44 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class NestedQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Indicates whether to ignore an unmapped path and not return any documents instead of an error. + /// + /// Indicates whether to ignore an unmapped path and not return any documents instead of an error. + /// /// [JsonInclude, JsonPropertyName("ignore_unmapped")] public bool? IgnoreUnmapped { get; set; } /// - /// If defined, each search hit will contain inner hits. + /// + /// If defined, each search hit will contain inner hits. + /// /// [JsonInclude, JsonPropertyName("inner_hits")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.InnerHits? InnerHits { get; set; } /// - /// Path to the nested object you wish to search. + /// + /// Path to the nested object you wish to search. + /// /// [JsonInclude, JsonPropertyName("path")] public Elastic.Clients.Elasticsearch.Serverless.Field Path { get; set; } /// - /// Query you wish to run on nested objects in the path. + /// + /// Query you wish to run on nested objects in the path. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query Query { get; set; } @@ -62,7 +75,9 @@ public sealed partial class NestedQuery public string? QueryName { get; set; } /// - /// How scores for matching child objects affect the root parent document’s relevance score. + /// + /// How scores for matching child objects affect the root parent document’s relevance score. + /// /// [JsonInclude, JsonPropertyName("score_mode")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.ChildScoreMode? ScoreMode { get; set; } @@ -91,7 +106,12 @@ public NestedQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.ChildScoreMode? ScoreModeValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public NestedQueryDescriptor Boost(float? boost) { @@ -100,7 +120,9 @@ public NestedQueryDescriptor Boost(float? boost) } /// - /// Indicates whether to ignore an unmapped path and not return any documents instead of an error. + /// + /// Indicates whether to ignore an unmapped path and not return any documents instead of an error. + /// /// public NestedQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { @@ -109,7 +131,9 @@ public NestedQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = tr } /// - /// If defined, each search hit will contain inner hits. + /// + /// If defined, each search hit will contain inner hits. + /// /// public NestedQueryDescriptor InnerHits(Elastic.Clients.Elasticsearch.Serverless.Core.Search.InnerHits? innerHits) { @@ -136,7 +160,9 @@ public NestedQueryDescriptor InnerHits(Action - /// Path to the nested object you wish to search. + /// + /// Path to the nested object you wish to search. + /// /// public NestedQueryDescriptor Path(Elastic.Clients.Elasticsearch.Serverless.Field path) { @@ -145,7 +171,9 @@ public NestedQueryDescriptor Path(Elastic.Clients.Elasticsearch.Serve } /// - /// Path to the nested object you wish to search. + /// + /// Path to the nested object you wish to search. + /// /// public NestedQueryDescriptor Path(Expression> path) { @@ -154,7 +182,9 @@ public NestedQueryDescriptor Path(Expression - /// Path to the nested object you wish to search. + /// + /// Path to the nested object you wish to search. + /// /// public NestedQueryDescriptor Path(Expression> path) { @@ -163,7 +193,9 @@ public NestedQueryDescriptor Path(Expression> } /// - /// Query you wish to run on nested objects in the path. + /// + /// Query you wish to run on nested objects in the path. + /// /// public NestedQueryDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query query) { @@ -196,7 +228,9 @@ public NestedQueryDescriptor QueryName(string? queryName) } /// - /// How scores for matching child objects affect the root parent document’s relevance score. + /// + /// How scores for matching child objects affect the root parent document’s relevance score. + /// /// public NestedQueryDescriptor ScoreMode(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.ChildScoreMode? scoreMode) { @@ -290,7 +324,12 @@ public NestedQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.ChildScoreMode? ScoreModeValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public NestedQueryDescriptor Boost(float? boost) { @@ -299,7 +338,9 @@ public NestedQueryDescriptor Boost(float? boost) } /// - /// Indicates whether to ignore an unmapped path and not return any documents instead of an error. + /// + /// Indicates whether to ignore an unmapped path and not return any documents instead of an error. + /// /// public NestedQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { @@ -308,7 +349,9 @@ public NestedQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) } /// - /// If defined, each search hit will contain inner hits. + /// + /// If defined, each search hit will contain inner hits. + /// /// public NestedQueryDescriptor InnerHits(Elastic.Clients.Elasticsearch.Serverless.Core.Search.InnerHits? innerHits) { @@ -335,7 +378,9 @@ public NestedQueryDescriptor InnerHits(Action - /// Path to the nested object you wish to search. + /// + /// Path to the nested object you wish to search. + /// /// public NestedQueryDescriptor Path(Elastic.Clients.Elasticsearch.Serverless.Field path) { @@ -344,7 +389,9 @@ public NestedQueryDescriptor Path(Elastic.Clients.Elasticsearch.Serverless.Field } /// - /// Path to the nested object you wish to search. + /// + /// Path to the nested object you wish to search. + /// /// public NestedQueryDescriptor Path(Expression> path) { @@ -353,7 +400,9 @@ public NestedQueryDescriptor Path(Expression - /// Path to the nested object you wish to search. + /// + /// Path to the nested object you wish to search. + /// /// public NestedQueryDescriptor Path(Expression> path) { @@ -362,7 +411,9 @@ public NestedQueryDescriptor Path(Expression> } /// - /// Query you wish to run on nested objects in the path. + /// + /// Query you wish to run on nested objects in the path. + /// /// public NestedQueryDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query query) { @@ -395,7 +446,9 @@ public NestedQueryDescriptor QueryName(string? queryName) } /// - /// How scores for matching child objects affect the root parent document’s relevance score. + /// + /// How scores for matching child objects affect the root parent document’s relevance score. + /// /// public NestedQueryDescriptor ScoreMode(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.ChildScoreMode? scoreMode) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/NumberRangeQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/NumberRangeQuery.g.cs index 96ae49d4941..79bcf0a8336 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/NumberRangeQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/NumberRangeQuery.g.cs @@ -181,35 +181,50 @@ public NumberRangeQuery(Elastic.Clients.Elasticsearch.Serverless.Field field) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } public double? From { get; set; } /// - /// Greater than. + /// + /// Greater than. + /// /// public double? Gt { get; set; } /// - /// Greater than or equal to. + /// + /// Greater than or equal to. + /// /// public double? Gte { get; set; } /// - /// Less than. + /// + /// Less than. + /// /// public double? Lt { get; set; } /// - /// Less than or equal to. + /// + /// Less than or equal to. + /// /// public double? Lte { get; set; } public string? QueryName { get; set; } /// - /// Indicates how the range query matches values for `range` fields. + /// + /// Indicates how the range query matches values for range fields. + /// /// public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RangeRelation? Relation { get; set; } public double? To { get; set; } @@ -235,7 +250,12 @@ public NumberRangeQueryDescriptor() : base() private double? ToValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public NumberRangeQueryDescriptor Boost(float? boost) { @@ -268,7 +288,9 @@ public NumberRangeQueryDescriptor From(double? from) } /// - /// Greater than. + /// + /// Greater than. + /// /// public NumberRangeQueryDescriptor Gt(double? gt) { @@ -277,7 +299,9 @@ public NumberRangeQueryDescriptor Gt(double? gt) } /// - /// Greater than or equal to. + /// + /// Greater than or equal to. + /// /// public NumberRangeQueryDescriptor Gte(double? gte) { @@ -286,7 +310,9 @@ public NumberRangeQueryDescriptor Gte(double? gte) } /// - /// Less than. + /// + /// Less than. + /// /// public NumberRangeQueryDescriptor Lt(double? lt) { @@ -295,7 +321,9 @@ public NumberRangeQueryDescriptor Lt(double? lt) } /// - /// Less than or equal to. + /// + /// Less than or equal to. + /// /// public NumberRangeQueryDescriptor Lte(double? lte) { @@ -310,7 +338,9 @@ public NumberRangeQueryDescriptor QueryName(string? queryName) } /// - /// Indicates how the range query matches values for `range` fields. + /// + /// Indicates how the range query matches values for range fields. + /// /// public NumberRangeQueryDescriptor Relation(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RangeRelation? relation) { @@ -410,7 +440,12 @@ public NumberRangeQueryDescriptor() : base() private double? ToValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public NumberRangeQueryDescriptor Boost(float? boost) { @@ -443,7 +478,9 @@ public NumberRangeQueryDescriptor From(double? from) } /// - /// Greater than. + /// + /// Greater than. + /// /// public NumberRangeQueryDescriptor Gt(double? gt) { @@ -452,7 +489,9 @@ public NumberRangeQueryDescriptor Gt(double? gt) } /// - /// Greater than or equal to. + /// + /// Greater than or equal to. + /// /// public NumberRangeQueryDescriptor Gte(double? gte) { @@ -461,7 +500,9 @@ public NumberRangeQueryDescriptor Gte(double? gte) } /// - /// Less than. + /// + /// Less than. + /// /// public NumberRangeQueryDescriptor Lt(double? lt) { @@ -470,7 +511,9 @@ public NumberRangeQueryDescriptor Lt(double? lt) } /// - /// Less than or equal to. + /// + /// Less than or equal to. + /// /// public NumberRangeQueryDescriptor Lte(double? lte) { @@ -485,7 +528,9 @@ public NumberRangeQueryDescriptor QueryName(string? queryName) } /// - /// Indicates how the range query matches values for `range` fields. + /// + /// Indicates how the range query matches values for range fields. + /// /// public NumberRangeQueryDescriptor Relation(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RangeRelation? relation) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/NumericDecayFunction.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/NumericDecayFunction.g.cs index 8685418dc14..c8fb77dbb14 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/NumericDecayFunction.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/NumericDecayFunction.g.cs @@ -85,7 +85,9 @@ public sealed partial class NumericDecayFunction public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// + /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// /// public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.MultiValueMode? MultiValueMode { get; set; } public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.DecayPlacement Placement { get; set; } @@ -122,7 +124,9 @@ public NumericDecayFunctionDescriptor Field(Expression - /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// + /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// /// public NumericDecayFunctionDescriptor MultiValueMode(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.MultiValueMode? multiValueMode) { @@ -187,7 +191,9 @@ public NumericDecayFunctionDescriptor Field(Expression - /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// + /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// /// public NumericDecayFunctionDescriptor MultiValueMode(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.MultiValueMode? multiValueMode) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ParentIdQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ParentIdQuery.g.cs index a3df1e1c0f2..23f1dd60129 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ParentIdQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ParentIdQuery.g.cs @@ -30,19 +30,28 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class ParentIdQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// ID of the parent document. + /// + /// ID of the parent document. + /// /// [JsonInclude, JsonPropertyName("id")] public Elastic.Clients.Elasticsearch.Serverless.Id? Id { get; set; } /// - /// Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. + /// + /// Indicates whether to ignore an unmapped type and not return any documents instead of an error. + /// /// [JsonInclude, JsonPropertyName("ignore_unmapped")] public bool? IgnoreUnmapped { get; set; } @@ -50,7 +59,9 @@ public sealed partial class ParentIdQuery public string? QueryName { get; set; } /// - /// Name of the child relationship mapped for the `join` field. + /// + /// Name of the child relationship mapped for the join field. + /// /// [JsonInclude, JsonPropertyName("type")] public string? Type { get; set; } @@ -73,7 +84,12 @@ public ParentIdQueryDescriptor() : base() private string? TypeValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public ParentIdQueryDescriptor Boost(float? boost) { @@ -82,7 +98,9 @@ public ParentIdQueryDescriptor Boost(float? boost) } /// - /// ID of the parent document. + /// + /// ID of the parent document. + /// /// public ParentIdQueryDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id? id) { @@ -91,7 +109,9 @@ public ParentIdQueryDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id? i } /// - /// Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. + /// + /// Indicates whether to ignore an unmapped type and not return any documents instead of an error. + /// /// public ParentIdQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { @@ -106,7 +126,9 @@ public ParentIdQueryDescriptor QueryName(string? queryName) } /// - /// Name of the child relationship mapped for the `join` field. + /// + /// Name of the child relationship mapped for the join field. + /// /// public ParentIdQueryDescriptor Type(string? type) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/PercolateQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/PercolateQuery.g.cs index bc43533a9cf..67ad113daa1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/PercolateQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/PercolateQuery.g.cs @@ -30,49 +30,68 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class PercolateQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// The source of the document being percolated. + /// + /// The source of the document being percolated. + /// /// [JsonInclude, JsonPropertyName("document")] public object? Document { get; set; } /// - /// An array of sources of the documents being percolated. + /// + /// An array of sources of the documents being percolated. + /// /// [JsonInclude, JsonPropertyName("documents")] public ICollection? Documents { get; set; } /// - /// Field that holds the indexed queries. The field must use the `percolator` mapping type. + /// + /// Field that holds the indexed queries. The field must use the percolator mapping type. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// The ID of a stored document to percolate. + /// + /// The ID of a stored document to percolate. + /// /// [JsonInclude, JsonPropertyName("id")] public Elastic.Clients.Elasticsearch.Serverless.Id? Id { get; set; } /// - /// The index of a stored document to percolate. + /// + /// The index of a stored document to percolate. + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.Serverless.IndexName? Index { get; set; } /// - /// The suffix used for the `_percolator_document_slot` field when multiple `percolate` queries are specified. + /// + /// The suffix used for the _percolator_document_slot field when multiple percolate queries are specified. + /// /// [JsonInclude, JsonPropertyName("name")] public string? Name { get; set; } /// - /// Preference used to fetch document to percolate. + /// + /// Preference used to fetch document to percolate. + /// /// [JsonInclude, JsonPropertyName("preference")] public string? Preference { get; set; } @@ -80,13 +99,17 @@ public sealed partial class PercolateQuery public string? QueryName { get; set; } /// - /// Routing used to fetch document to percolate. + /// + /// Routing used to fetch document to percolate. + /// /// [JsonInclude, JsonPropertyName("routing")] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get; set; } /// - /// The expected version of a stored document to percolate. + /// + /// The expected version of a stored document to percolate. + /// /// [JsonInclude, JsonPropertyName("version")] public long? Version { get; set; } @@ -115,7 +138,12 @@ public PercolateQueryDescriptor() : base() private long? VersionValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public PercolateQueryDescriptor Boost(float? boost) { @@ -124,7 +152,9 @@ public PercolateQueryDescriptor Boost(float? boost) } /// - /// The source of the document being percolated. + /// + /// The source of the document being percolated. + /// /// public PercolateQueryDescriptor Document(object? document) { @@ -133,7 +163,9 @@ public PercolateQueryDescriptor Document(object? document) } /// - /// An array of sources of the documents being percolated. + /// + /// An array of sources of the documents being percolated. + /// /// public PercolateQueryDescriptor Documents(ICollection? documents) { @@ -142,7 +174,9 @@ public PercolateQueryDescriptor Documents(ICollection? docume } /// - /// Field that holds the indexed queries. The field must use the `percolator` mapping type. + /// + /// Field that holds the indexed queries. The field must use the percolator mapping type. + /// /// public PercolateQueryDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -151,7 +185,9 @@ public PercolateQueryDescriptor Field(Elastic.Clients.Elasticsearch.S } /// - /// Field that holds the indexed queries. The field must use the `percolator` mapping type. + /// + /// Field that holds the indexed queries. The field must use the percolator mapping type. + /// /// public PercolateQueryDescriptor Field(Expression> field) { @@ -160,7 +196,9 @@ public PercolateQueryDescriptor Field(Expression - /// Field that holds the indexed queries. The field must use the `percolator` mapping type. + /// + /// Field that holds the indexed queries. The field must use the percolator mapping type. + /// /// public PercolateQueryDescriptor Field(Expression> field) { @@ -169,7 +207,9 @@ public PercolateQueryDescriptor Field(Expression - /// The ID of a stored document to percolate. + /// + /// The ID of a stored document to percolate. + /// /// public PercolateQueryDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id? id) { @@ -178,7 +218,9 @@ public PercolateQueryDescriptor Id(Elastic.Clients.Elasticsearch.Serv } /// - /// The index of a stored document to percolate. + /// + /// The index of a stored document to percolate. + /// /// public PercolateQueryDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.IndexName? index) { @@ -187,7 +229,9 @@ public PercolateQueryDescriptor Index(Elastic.Clients.Elasticsearch.S } /// - /// The suffix used for the `_percolator_document_slot` field when multiple `percolate` queries are specified. + /// + /// The suffix used for the _percolator_document_slot field when multiple percolate queries are specified. + /// /// public PercolateQueryDescriptor Name(string? name) { @@ -196,7 +240,9 @@ public PercolateQueryDescriptor Name(string? name) } /// - /// Preference used to fetch document to percolate. + /// + /// Preference used to fetch document to percolate. + /// /// public PercolateQueryDescriptor Preference(string? preference) { @@ -211,7 +257,9 @@ public PercolateQueryDescriptor QueryName(string? queryName) } /// - /// Routing used to fetch document to percolate. + /// + /// Routing used to fetch document to percolate. + /// /// public PercolateQueryDescriptor Routing(Elastic.Clients.Elasticsearch.Serverless.Routing? routing) { @@ -220,7 +268,9 @@ public PercolateQueryDescriptor Routing(Elastic.Clients.Elasticsearch } /// - /// The expected version of a stored document to percolate. + /// + /// The expected version of a stored document to percolate. + /// /// public PercolateQueryDescriptor Version(long? version) { @@ -318,7 +368,12 @@ public PercolateQueryDescriptor() : base() private long? VersionValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public PercolateQueryDescriptor Boost(float? boost) { @@ -327,7 +382,9 @@ public PercolateQueryDescriptor Boost(float? boost) } /// - /// The source of the document being percolated. + /// + /// The source of the document being percolated. + /// /// public PercolateQueryDescriptor Document(object? document) { @@ -336,7 +393,9 @@ public PercolateQueryDescriptor Document(object? document) } /// - /// An array of sources of the documents being percolated. + /// + /// An array of sources of the documents being percolated. + /// /// public PercolateQueryDescriptor Documents(ICollection? documents) { @@ -345,7 +404,9 @@ public PercolateQueryDescriptor Documents(ICollection? documents) } /// - /// Field that holds the indexed queries. The field must use the `percolator` mapping type. + /// + /// Field that holds the indexed queries. The field must use the percolator mapping type. + /// /// public PercolateQueryDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -354,7 +415,9 @@ public PercolateQueryDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.F } /// - /// Field that holds the indexed queries. The field must use the `percolator` mapping type. + /// + /// Field that holds the indexed queries. The field must use the percolator mapping type. + /// /// public PercolateQueryDescriptor Field(Expression> field) { @@ -363,7 +426,9 @@ public PercolateQueryDescriptor Field(Expression - /// Field that holds the indexed queries. The field must use the `percolator` mapping type. + /// + /// Field that holds the indexed queries. The field must use the percolator mapping type. + /// /// public PercolateQueryDescriptor Field(Expression> field) { @@ -372,7 +437,9 @@ public PercolateQueryDescriptor Field(Expression - /// The ID of a stored document to percolate. + /// + /// The ID of a stored document to percolate. + /// /// public PercolateQueryDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id? id) { @@ -381,7 +448,9 @@ public PercolateQueryDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id? } /// - /// The index of a stored document to percolate. + /// + /// The index of a stored document to percolate. + /// /// public PercolateQueryDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.IndexName? index) { @@ -390,7 +459,9 @@ public PercolateQueryDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.I } /// - /// The suffix used for the `_percolator_document_slot` field when multiple `percolate` queries are specified. + /// + /// The suffix used for the _percolator_document_slot field when multiple percolate queries are specified. + /// /// public PercolateQueryDescriptor Name(string? name) { @@ -399,7 +470,9 @@ public PercolateQueryDescriptor Name(string? name) } /// - /// Preference used to fetch document to percolate. + /// + /// Preference used to fetch document to percolate. + /// /// public PercolateQueryDescriptor Preference(string? preference) { @@ -414,7 +487,9 @@ public PercolateQueryDescriptor QueryName(string? queryName) } /// - /// Routing used to fetch document to percolate. + /// + /// Routing used to fetch document to percolate. + /// /// public PercolateQueryDescriptor Routing(Elastic.Clients.Elasticsearch.Serverless.Routing? routing) { @@ -423,7 +498,9 @@ public PercolateQueryDescriptor Routing(Elastic.Clients.Elasticsearch.Serverless } /// - /// The expected version of a stored document to percolate. + /// + /// The expected version of a stored document to percolate. + /// /// public PercolateQueryDescriptor Version(long? version) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/PinnedDoc.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/PinnedDoc.g.cs index d340fadd499..3dfb68e3765 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/PinnedDoc.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/PinnedDoc.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class PinnedDoc { /// - /// The unique document ID. + /// + /// The unique document ID. + /// /// [JsonInclude, JsonPropertyName("_id")] public Elastic.Clients.Elasticsearch.Serverless.Id Id { get; set; } /// - /// The index that contains the document. + /// + /// The index that contains the document. + /// /// [JsonInclude, JsonPropertyName("_index")] public Elastic.Clients.Elasticsearch.Serverless.IndexName Index { get; set; } @@ -54,7 +58,9 @@ public PinnedDocDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.IndexName IndexValue { get; set; } /// - /// The unique document ID. + /// + /// The unique document ID. + /// /// public PinnedDocDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id id) { @@ -63,7 +69,9 @@ public PinnedDocDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id id) } /// - /// The index that contains the document. + /// + /// The index that contains the document. + /// /// public PinnedDocDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.IndexName index) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/PinnedQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/PinnedQuery.g.cs index 210da9ee3b5..3cee9827032 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/PinnedQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/PinnedQuery.g.cs @@ -50,13 +50,20 @@ internal PinnedQuery(string variantName, object variant) public static PinnedQuery Ids(IReadOnlyCollection id) => new PinnedQuery("ids", id); /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Any choice of query used to rank documents which will be ranked below the "pinned" documents. + /// + /// Any choice of query used to rank documents which will be ranked below the "pinned" documents. + /// /// [JsonInclude, JsonPropertyName("organic")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query Organic { get; set; } @@ -221,7 +228,12 @@ private PinnedQueryDescriptor Set(object variant, string variantName) private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public PinnedQueryDescriptor Boost(float? boost) { @@ -230,7 +242,9 @@ public PinnedQueryDescriptor Boost(float? boost) } /// - /// Any choice of query used to rank documents which will be ranked below the "pinned" documents. + /// + /// Any choice of query used to rank documents which will be ranked below the "pinned" documents. + /// /// public PinnedQueryDescriptor Organic(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query organic) { @@ -322,7 +336,12 @@ private PinnedQueryDescriptor Set(object variant, string variantName) private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public PinnedQueryDescriptor Boost(float? boost) { @@ -331,7 +350,9 @@ public PinnedQueryDescriptor Boost(float? boost) } /// - /// Any choice of query used to rank documents which will be ranked below the "pinned" documents. + /// + /// Any choice of query used to rank documents which will be ranked below the "pinned" documents. + /// /// public PinnedQueryDescriptor Organic(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query organic) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/PrefixQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/PrefixQuery.g.cs index 7f24149aaec..5bac74f80a7 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/PrefixQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/PrefixQuery.g.cs @@ -129,24 +129,36 @@ public PrefixQuery(Elastic.Clients.Elasticsearch.Serverless.Field field) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } /// - /// Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.
Default is `false` which means the case sensitivity of matching depends on the underlying field’s mapping. + /// + /// Allows ASCII case insensitive matching of the value with the indexed field values when set to true. + /// Default is false which means the case sensitivity of matching depends on the underlying field’s mapping. + /// /// public bool? CaseInsensitive { get; set; } public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } public string? QueryName { get; set; } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public string? Rewrite { get; set; } /// - /// Beginning characters of terms you wish to find in the provided field. + /// + /// Beginning characters of terms you wish to find in the provided field. + /// /// public string Value { get; set; } @@ -169,7 +181,12 @@ public PrefixQueryDescriptor() : base() private string ValueValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public PrefixQueryDescriptor Boost(float? boost) { @@ -178,7 +195,10 @@ public PrefixQueryDescriptor Boost(float? boost) } /// - /// Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.
Default is `false` which means the case sensitivity of matching depends on the underlying field’s mapping. + /// + /// Allows ASCII case insensitive matching of the value with the indexed field values when set to true. + /// Default is false which means the case sensitivity of matching depends on the underlying field’s mapping. + /// /// public PrefixQueryDescriptor CaseInsensitive(bool? caseInsensitive = true) { @@ -211,7 +231,9 @@ public PrefixQueryDescriptor QueryName(string? queryName) } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public PrefixQueryDescriptor Rewrite(string? rewrite) { @@ -220,7 +242,9 @@ public PrefixQueryDescriptor Rewrite(string? rewrite) } /// - /// Beginning characters of terms you wish to find in the provided field. + /// + /// Beginning characters of terms you wish to find in the provided field. + /// /// public PrefixQueryDescriptor Value(string value) { @@ -282,7 +306,12 @@ public PrefixQueryDescriptor() : base() private string ValueValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public PrefixQueryDescriptor Boost(float? boost) { @@ -291,7 +320,10 @@ public PrefixQueryDescriptor Boost(float? boost) } /// - /// Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.
Default is `false` which means the case sensitivity of matching depends on the underlying field’s mapping. + /// + /// Allows ASCII case insensitive matching of the value with the indexed field values when set to true. + /// Default is false which means the case sensitivity of matching depends on the underlying field’s mapping. + /// /// public PrefixQueryDescriptor CaseInsensitive(bool? caseInsensitive = true) { @@ -324,7 +356,9 @@ public PrefixQueryDescriptor QueryName(string? queryName) } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public PrefixQueryDescriptor Rewrite(string? rewrite) { @@ -333,7 +367,9 @@ public PrefixQueryDescriptor Rewrite(string? rewrite) } /// - /// Beginning characters of terms you wish to find in the provided field. + /// + /// Beginning characters of terms you wish to find in the provided field. + /// /// public PrefixQueryDescriptor Value(string value) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/QueryStringQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/QueryStringQuery.g.cs index 32bdc385b11..0e3a26c5163 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/QueryStringQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/QueryStringQuery.g.cs @@ -30,49 +30,70 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class QueryStringQuery { /// - /// If `true`, the wildcard characters `*` and `?` are allowed as the first character of the query string. + /// + /// If true, the wildcard characters * and ? are allowed as the first character of the query string. + /// /// [JsonInclude, JsonPropertyName("allow_leading_wildcard")] public bool? AllowLeadingWildcard { get; set; } /// - /// Analyzer used to convert text in the query string into tokens. + /// + /// Analyzer used to convert text in the query string into tokens. + /// /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } /// - /// If `true`, the query attempts to analyze wildcard terms in the query string. + /// + /// If true, the query attempts to analyze wildcard terms in the query string. + /// /// [JsonInclude, JsonPropertyName("analyze_wildcard")] public bool? AnalyzeWildcard { get; set; } /// - /// If `true`, match phrase queries are automatically created for multi-term synonyms. + /// + /// If true, match phrase queries are automatically created for multi-term synonyms. + /// /// [JsonInclude, JsonPropertyName("auto_generate_synonyms_phrase_query")] public bool? AutoGenerateSynonymsPhraseQuery { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Default field to search if no field is provided in the query string.
Supports wildcards (`*`).
Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + /// + /// Default field to search if no field is provided in the query string. + /// Supports wildcards (*). + /// Defaults to the index.query.default_field index setting, which has a default value of *. + /// /// [JsonInclude, JsonPropertyName("default_field")] public Elastic.Clients.Elasticsearch.Serverless.Field? DefaultField { get; set; } /// - /// Default boolean logic used to interpret text in the query string if no operators are specified. + /// + /// Default boolean logic used to interpret text in the query string if no operators are specified. + /// /// [JsonInclude, JsonPropertyName("default_operator")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Operator? DefaultOperator { get; set; } /// - /// If `true`, enable position increments in queries constructed from a `query_string` search. + /// + /// If true, enable position increments in queries constructed from a query_string search. + /// /// [JsonInclude, JsonPropertyName("enable_position_increments")] public bool? EnablePositionIncrements { get; set; } @@ -80,68 +101,90 @@ public sealed partial class QueryStringQuery public bool? Escape { get; set; } /// - /// Array of fields to search. Supports wildcards (`*`). + /// + /// Array of fields to search. Supports wildcards (*). + /// /// [JsonInclude, JsonPropertyName("fields")] [JsonConverter(typeof(FieldsConverter))] public Elastic.Clients.Elasticsearch.Serverless.Fields? Fields { get; set; } /// - /// Maximum edit distance allowed for fuzzy matching. + /// + /// Maximum edit distance allowed for fuzzy matching. + /// /// [JsonInclude, JsonPropertyName("fuzziness")] public Elastic.Clients.Elasticsearch.Serverless.Fuzziness? Fuzziness { get; set; } /// - /// Maximum number of terms to which the query expands for fuzzy matching. + /// + /// Maximum number of terms to which the query expands for fuzzy matching. + /// /// [JsonInclude, JsonPropertyName("fuzzy_max_expansions")] public int? FuzzyMaxExpansions { get; set; } /// - /// Number of beginning characters left unchanged for fuzzy matching. + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// /// [JsonInclude, JsonPropertyName("fuzzy_prefix_length")] public int? FuzzyPrefixLength { get; set; } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// [JsonInclude, JsonPropertyName("fuzzy_rewrite")] public string? FuzzyRewrite { get; set; } /// - /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// + /// If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). + /// /// [JsonInclude, JsonPropertyName("fuzzy_transpositions")] public bool? FuzzyTranspositions { get; set; } /// - /// If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. + /// + /// If true, format-based errors, such as providing a text value for a numeric field, are ignored. + /// /// [JsonInclude, JsonPropertyName("lenient")] public bool? Lenient { get; set; } /// - /// Maximum number of automaton states required for the query. + /// + /// Maximum number of automaton states required for the query. + /// /// [JsonInclude, JsonPropertyName("max_determinized_states")] public int? MaxDeterminizedStates { get; set; } /// - /// Minimum number of clauses that must match for a document to be returned. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// /// [JsonInclude, JsonPropertyName("minimum_should_match")] public Elastic.Clients.Elasticsearch.Serverless.MinimumShouldMatch? MinimumShouldMatch { get; set; } /// - /// Maximum number of positions allowed between matching tokens for phrases. + /// + /// Maximum number of positions allowed between matching tokens for phrases. + /// /// [JsonInclude, JsonPropertyName("phrase_slop")] public double? PhraseSlop { get; set; } /// - /// Query string you wish to parse and use for search. + /// + /// Query string you wish to parse and use for search. + /// /// [JsonInclude, JsonPropertyName("query")] public string Query { get; set; } @@ -149,37 +192,51 @@ public sealed partial class QueryStringQuery public string? QueryName { get; set; } /// - /// Analyzer used to convert quoted text in the query string into tokens.
For quoted text, this parameter overrides the analyzer specified in the `analyzer` parameter. + /// + /// Analyzer used to convert quoted text in the query string into tokens. + /// For quoted text, this parameter overrides the analyzer specified in the analyzer parameter. + /// /// [JsonInclude, JsonPropertyName("quote_analyzer")] public string? QuoteAnalyzer { get; set; } /// - /// Suffix appended to quoted text in the query string.
You can use this suffix to use a different analysis method for exact matches. + /// + /// Suffix appended to quoted text in the query string. + /// You can use this suffix to use a different analysis method for exact matches. + /// /// [JsonInclude, JsonPropertyName("quote_field_suffix")] public string? QuoteFieldSuffix { get; set; } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// [JsonInclude, JsonPropertyName("rewrite")] public string? Rewrite { get; set; } /// - /// How to combine the queries generated from the individual search terms in the resulting `dis_max` query. + /// + /// How to combine the queries generated from the individual search terms in the resulting dis_max query. + /// /// [JsonInclude, JsonPropertyName("tie_breaker")] public double? TieBreaker { get; set; } /// - /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query string to UTC. + /// + /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query string to UTC. + /// /// [JsonInclude, JsonPropertyName("time_zone")] public string? TimeZone { get; set; } /// - /// Determines how the query matches and scores documents. + /// + /// Determines how the query matches and scores documents. + /// /// [JsonInclude, JsonPropertyName("type")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TextQueryType? Type { get; set; } @@ -224,7 +281,9 @@ public QueryStringQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TextQueryType? TypeValue { get; set; } /// - /// If `true`, the wildcard characters `*` and `?` are allowed as the first character of the query string. + /// + /// If true, the wildcard characters * and ? are allowed as the first character of the query string. + /// /// public QueryStringQueryDescriptor AllowLeadingWildcard(bool? allowLeadingWildcard = true) { @@ -233,7 +292,9 @@ public QueryStringQueryDescriptor AllowLeadingWildcard(bool? allowLea } /// - /// Analyzer used to convert text in the query string into tokens. + /// + /// Analyzer used to convert text in the query string into tokens. + /// /// public QueryStringQueryDescriptor Analyzer(string? analyzer) { @@ -242,7 +303,9 @@ public QueryStringQueryDescriptor Analyzer(string? analyzer) } /// - /// If `true`, the query attempts to analyze wildcard terms in the query string. + /// + /// If true, the query attempts to analyze wildcard terms in the query string. + /// /// public QueryStringQueryDescriptor AnalyzeWildcard(bool? analyzeWildcard = true) { @@ -251,7 +314,9 @@ public QueryStringQueryDescriptor AnalyzeWildcard(bool? analyzeWildca } /// - /// If `true`, match phrase queries are automatically created for multi-term synonyms. + /// + /// If true, match phrase queries are automatically created for multi-term synonyms. + /// /// public QueryStringQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSynonymsPhraseQuery = true) { @@ -260,7 +325,12 @@ public QueryStringQueryDescriptor AutoGenerateSynonymsPhraseQuery(boo } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public QueryStringQueryDescriptor Boost(float? boost) { @@ -269,7 +339,11 @@ public QueryStringQueryDescriptor Boost(float? boost) } /// - /// Default field to search if no field is provided in the query string.
Supports wildcards (`*`).
Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + /// + /// Default field to search if no field is provided in the query string. + /// Supports wildcards (*). + /// Defaults to the index.query.default_field index setting, which has a default value of *. + /// /// public QueryStringQueryDescriptor DefaultField(Elastic.Clients.Elasticsearch.Serverless.Field? defaultField) { @@ -278,7 +352,11 @@ public QueryStringQueryDescriptor DefaultField(Elastic.Clients.Elasti } /// - /// Default field to search if no field is provided in the query string.
Supports wildcards (`*`).
Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + /// + /// Default field to search if no field is provided in the query string. + /// Supports wildcards (*). + /// Defaults to the index.query.default_field index setting, which has a default value of *. + /// /// public QueryStringQueryDescriptor DefaultField(Expression> defaultField) { @@ -287,7 +365,11 @@ public QueryStringQueryDescriptor DefaultField(Expression - /// Default field to search if no field is provided in the query string.
Supports wildcards (`*`).
Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + /// + /// Default field to search if no field is provided in the query string. + /// Supports wildcards (*). + /// Defaults to the index.query.default_field index setting, which has a default value of *. + /// /// public QueryStringQueryDescriptor DefaultField(Expression> defaultField) { @@ -296,7 +378,9 @@ public QueryStringQueryDescriptor DefaultField(Expression - /// Default boolean logic used to interpret text in the query string if no operators are specified. + /// + /// Default boolean logic used to interpret text in the query string if no operators are specified. + /// /// public QueryStringQueryDescriptor DefaultOperator(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Operator? defaultOperator) { @@ -305,7 +389,9 @@ public QueryStringQueryDescriptor DefaultOperator(Elastic.Clients.Ela } /// - /// If `true`, enable position increments in queries constructed from a `query_string` search. + /// + /// If true, enable position increments in queries constructed from a query_string search. + /// /// public QueryStringQueryDescriptor EnablePositionIncrements(bool? enablePositionIncrements = true) { @@ -320,7 +406,9 @@ public QueryStringQueryDescriptor Escape(bool? escape = true) } /// - /// Array of fields to search. Supports wildcards (`*`). + /// + /// Array of fields to search. Supports wildcards (*). + /// /// public QueryStringQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Serverless.Fields? fields) { @@ -329,7 +417,9 @@ public QueryStringQueryDescriptor Fields(Elastic.Clients.Elasticsearc } /// - /// Maximum edit distance allowed for fuzzy matching. + /// + /// Maximum edit distance allowed for fuzzy matching. + /// /// public QueryStringQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Serverless.Fuzziness? fuzziness) { @@ -338,7 +428,9 @@ public QueryStringQueryDescriptor Fuzziness(Elastic.Clients.Elasticse } /// - /// Maximum number of terms to which the query expands for fuzzy matching. + /// + /// Maximum number of terms to which the query expands for fuzzy matching. + /// /// public QueryStringQueryDescriptor FuzzyMaxExpansions(int? fuzzyMaxExpansions) { @@ -347,7 +439,9 @@ public QueryStringQueryDescriptor FuzzyMaxExpansions(int? fuzzyMaxExp } /// - /// Number of beginning characters left unchanged for fuzzy matching. + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// /// public QueryStringQueryDescriptor FuzzyPrefixLength(int? fuzzyPrefixLength) { @@ -356,7 +450,9 @@ public QueryStringQueryDescriptor FuzzyPrefixLength(int? fuzzyPrefixL } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public QueryStringQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) { @@ -365,7 +461,9 @@ public QueryStringQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) } /// - /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// + /// If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). + /// /// public QueryStringQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true) { @@ -374,7 +472,9 @@ public QueryStringQueryDescriptor FuzzyTranspositions(bool? fuzzyTran } /// - /// If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. + /// + /// If true, format-based errors, such as providing a text value for a numeric field, are ignored. + /// /// public QueryStringQueryDescriptor Lenient(bool? lenient = true) { @@ -383,7 +483,9 @@ public QueryStringQueryDescriptor Lenient(bool? lenient = true) } /// - /// Maximum number of automaton states required for the query. + /// + /// Maximum number of automaton states required for the query. + /// /// public QueryStringQueryDescriptor MaxDeterminizedStates(int? maxDeterminizedStates) { @@ -392,7 +494,9 @@ public QueryStringQueryDescriptor MaxDeterminizedStates(int? maxDeter } /// - /// Minimum number of clauses that must match for a document to be returned. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// /// public QueryStringQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.Serverless.MinimumShouldMatch? minimumShouldMatch) { @@ -401,7 +505,9 @@ public QueryStringQueryDescriptor MinimumShouldMatch(Elastic.Clients. } /// - /// Maximum number of positions allowed between matching tokens for phrases. + /// + /// Maximum number of positions allowed between matching tokens for phrases. + /// /// public QueryStringQueryDescriptor PhraseSlop(double? phraseSlop) { @@ -410,7 +516,9 @@ public QueryStringQueryDescriptor PhraseSlop(double? phraseSlop) } /// - /// Query string you wish to parse and use for search. + /// + /// Query string you wish to parse and use for search. + /// /// public QueryStringQueryDescriptor Query(string query) { @@ -425,7 +533,10 @@ public QueryStringQueryDescriptor QueryName(string? queryName) } /// - /// Analyzer used to convert quoted text in the query string into tokens.
For quoted text, this parameter overrides the analyzer specified in the `analyzer` parameter. + /// + /// Analyzer used to convert quoted text in the query string into tokens. + /// For quoted text, this parameter overrides the analyzer specified in the analyzer parameter. + /// /// public QueryStringQueryDescriptor QuoteAnalyzer(string? quoteAnalyzer) { @@ -434,7 +545,10 @@ public QueryStringQueryDescriptor QuoteAnalyzer(string? quoteAnalyzer } /// - /// Suffix appended to quoted text in the query string.
You can use this suffix to use a different analysis method for exact matches. + /// + /// Suffix appended to quoted text in the query string. + /// You can use this suffix to use a different analysis method for exact matches. + /// /// public QueryStringQueryDescriptor QuoteFieldSuffix(string? quoteFieldSuffix) { @@ -443,7 +557,9 @@ public QueryStringQueryDescriptor QuoteFieldSuffix(string? quoteField } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public QueryStringQueryDescriptor Rewrite(string? rewrite) { @@ -452,7 +568,9 @@ public QueryStringQueryDescriptor Rewrite(string? rewrite) } /// - /// How to combine the queries generated from the individual search terms in the resulting `dis_max` query. + /// + /// How to combine the queries generated from the individual search terms in the resulting dis_max query. + /// /// public QueryStringQueryDescriptor TieBreaker(double? tieBreaker) { @@ -461,7 +579,9 @@ public QueryStringQueryDescriptor TieBreaker(double? tieBreaker) } /// - /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query string to UTC. + /// + /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query string to UTC. + /// /// public QueryStringQueryDescriptor TimeZone(string? timeZone) { @@ -470,7 +590,9 @@ public QueryStringQueryDescriptor TimeZone(string? timeZone) } /// - /// Determines how the query matches and scores documents. + /// + /// Determines how the query matches and scores documents. + /// /// public QueryStringQueryDescriptor Type(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TextQueryType? type) { @@ -680,7 +802,9 @@ public QueryStringQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TextQueryType? TypeValue { get; set; } /// - /// If `true`, the wildcard characters `*` and `?` are allowed as the first character of the query string. + /// + /// If true, the wildcard characters * and ? are allowed as the first character of the query string. + /// /// public QueryStringQueryDescriptor AllowLeadingWildcard(bool? allowLeadingWildcard = true) { @@ -689,7 +813,9 @@ public QueryStringQueryDescriptor AllowLeadingWildcard(bool? allowLeadingWildcar } /// - /// Analyzer used to convert text in the query string into tokens. + /// + /// Analyzer used to convert text in the query string into tokens. + /// /// public QueryStringQueryDescriptor Analyzer(string? analyzer) { @@ -698,7 +824,9 @@ public QueryStringQueryDescriptor Analyzer(string? analyzer) } /// - /// If `true`, the query attempts to analyze wildcard terms in the query string. + /// + /// If true, the query attempts to analyze wildcard terms in the query string. + /// /// public QueryStringQueryDescriptor AnalyzeWildcard(bool? analyzeWildcard = true) { @@ -707,7 +835,9 @@ public QueryStringQueryDescriptor AnalyzeWildcard(bool? analyzeWildcard = true) } /// - /// If `true`, match phrase queries are automatically created for multi-term synonyms. + /// + /// If true, match phrase queries are automatically created for multi-term synonyms. + /// /// public QueryStringQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSynonymsPhraseQuery = true) { @@ -716,7 +846,12 @@ public QueryStringQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGene } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public QueryStringQueryDescriptor Boost(float? boost) { @@ -725,7 +860,11 @@ public QueryStringQueryDescriptor Boost(float? boost) } /// - /// Default field to search if no field is provided in the query string.
Supports wildcards (`*`).
Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + /// + /// Default field to search if no field is provided in the query string. + /// Supports wildcards (*). + /// Defaults to the index.query.default_field index setting, which has a default value of *. + /// /// public QueryStringQueryDescriptor DefaultField(Elastic.Clients.Elasticsearch.Serverless.Field? defaultField) { @@ -734,7 +873,11 @@ public QueryStringQueryDescriptor DefaultField(Elastic.Clients.Elasticsearch.Ser } /// - /// Default field to search if no field is provided in the query string.
Supports wildcards (`*`).
Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + /// + /// Default field to search if no field is provided in the query string. + /// Supports wildcards (*). + /// Defaults to the index.query.default_field index setting, which has a default value of *. + /// /// public QueryStringQueryDescriptor DefaultField(Expression> defaultField) { @@ -743,7 +886,11 @@ public QueryStringQueryDescriptor DefaultField(Expression - /// Default field to search if no field is provided in the query string.
Supports wildcards (`*`).
Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + /// + /// Default field to search if no field is provided in the query string. + /// Supports wildcards (*). + /// Defaults to the index.query.default_field index setting, which has a default value of *. + /// /// public QueryStringQueryDescriptor DefaultField(Expression> defaultField) { @@ -752,7 +899,9 @@ public QueryStringQueryDescriptor DefaultField(Expression - /// Default boolean logic used to interpret text in the query string if no operators are specified. + /// + /// Default boolean logic used to interpret text in the query string if no operators are specified. + /// /// public QueryStringQueryDescriptor DefaultOperator(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Operator? defaultOperator) { @@ -761,7 +910,9 @@ public QueryStringQueryDescriptor DefaultOperator(Elastic.Clients.Elasticsearch. } /// - /// If `true`, enable position increments in queries constructed from a `query_string` search. + /// + /// If true, enable position increments in queries constructed from a query_string search. + /// /// public QueryStringQueryDescriptor EnablePositionIncrements(bool? enablePositionIncrements = true) { @@ -776,7 +927,9 @@ public QueryStringQueryDescriptor Escape(bool? escape = true) } /// - /// Array of fields to search. Supports wildcards (`*`). + /// + /// Array of fields to search. Supports wildcards (*). + /// /// public QueryStringQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Serverless.Fields? fields) { @@ -785,7 +938,9 @@ public QueryStringQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Serverles } /// - /// Maximum edit distance allowed for fuzzy matching. + /// + /// Maximum edit distance allowed for fuzzy matching. + /// /// public QueryStringQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Serverless.Fuzziness? fuzziness) { @@ -794,7 +949,9 @@ public QueryStringQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Server } /// - /// Maximum number of terms to which the query expands for fuzzy matching. + /// + /// Maximum number of terms to which the query expands for fuzzy matching. + /// /// public QueryStringQueryDescriptor FuzzyMaxExpansions(int? fuzzyMaxExpansions) { @@ -803,7 +960,9 @@ public QueryStringQueryDescriptor FuzzyMaxExpansions(int? fuzzyMaxExpansions) } /// - /// Number of beginning characters left unchanged for fuzzy matching. + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// /// public QueryStringQueryDescriptor FuzzyPrefixLength(int? fuzzyPrefixLength) { @@ -812,7 +971,9 @@ public QueryStringQueryDescriptor FuzzyPrefixLength(int? fuzzyPrefixLength) } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public QueryStringQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) { @@ -821,7 +982,9 @@ public QueryStringQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) } /// - /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// + /// If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). + /// /// public QueryStringQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true) { @@ -830,7 +993,9 @@ public QueryStringQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions } /// - /// If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. + /// + /// If true, format-based errors, such as providing a text value for a numeric field, are ignored. + /// /// public QueryStringQueryDescriptor Lenient(bool? lenient = true) { @@ -839,7 +1004,9 @@ public QueryStringQueryDescriptor Lenient(bool? lenient = true) } /// - /// Maximum number of automaton states required for the query. + /// + /// Maximum number of automaton states required for the query. + /// /// public QueryStringQueryDescriptor MaxDeterminizedStates(int? maxDeterminizedStates) { @@ -848,7 +1015,9 @@ public QueryStringQueryDescriptor MaxDeterminizedStates(int? maxDeterminizedStat } /// - /// Minimum number of clauses that must match for a document to be returned. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// /// public QueryStringQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.Serverless.MinimumShouldMatch? minimumShouldMatch) { @@ -857,7 +1026,9 @@ public QueryStringQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsear } /// - /// Maximum number of positions allowed between matching tokens for phrases. + /// + /// Maximum number of positions allowed between matching tokens for phrases. + /// /// public QueryStringQueryDescriptor PhraseSlop(double? phraseSlop) { @@ -866,7 +1037,9 @@ public QueryStringQueryDescriptor PhraseSlop(double? phraseSlop) } /// - /// Query string you wish to parse and use for search. + /// + /// Query string you wish to parse and use for search. + /// /// public QueryStringQueryDescriptor Query(string query) { @@ -881,7 +1054,10 @@ public QueryStringQueryDescriptor QueryName(string? queryName) } /// - /// Analyzer used to convert quoted text in the query string into tokens.
For quoted text, this parameter overrides the analyzer specified in the `analyzer` parameter. + /// + /// Analyzer used to convert quoted text in the query string into tokens. + /// For quoted text, this parameter overrides the analyzer specified in the analyzer parameter. + /// /// public QueryStringQueryDescriptor QuoteAnalyzer(string? quoteAnalyzer) { @@ -890,7 +1066,10 @@ public QueryStringQueryDescriptor QuoteAnalyzer(string? quoteAnalyzer) } /// - /// Suffix appended to quoted text in the query string.
You can use this suffix to use a different analysis method for exact matches. + /// + /// Suffix appended to quoted text in the query string. + /// You can use this suffix to use a different analysis method for exact matches. + /// /// public QueryStringQueryDescriptor QuoteFieldSuffix(string? quoteFieldSuffix) { @@ -899,7 +1078,9 @@ public QueryStringQueryDescriptor QuoteFieldSuffix(string? quoteFieldSuffix) } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public QueryStringQueryDescriptor Rewrite(string? rewrite) { @@ -908,7 +1089,9 @@ public QueryStringQueryDescriptor Rewrite(string? rewrite) } /// - /// How to combine the queries generated from the individual search terms in the resulting `dis_max` query. + /// + /// How to combine the queries generated from the individual search terms in the resulting dis_max query. + /// /// public QueryStringQueryDescriptor TieBreaker(double? tieBreaker) { @@ -917,7 +1100,9 @@ public QueryStringQueryDescriptor TieBreaker(double? tieBreaker) } /// - /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query string to UTC. + /// + /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query string to UTC. + /// /// public QueryStringQueryDescriptor TimeZone(string? timeZone) { @@ -926,7 +1111,9 @@ public QueryStringQueryDescriptor TimeZone(string? timeZone) } /// - /// Determines how the query matches and scores documents. + /// + /// Determines how the query matches and scores documents. + /// /// public QueryStringQueryDescriptor Type(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TextQueryType? type) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/RankFeatureFunctionLogarithm.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/RankFeatureFunctionLogarithm.g.cs index 4312116848e..76810800eff 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/RankFeatureFunctionLogarithm.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/RankFeatureFunctionLogarithm.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class RankFeatureFunctionLogarithm { /// - /// Configurable scaling factor. + /// + /// Configurable scaling factor. + /// /// [JsonInclude, JsonPropertyName("scaling_factor")] public float ScalingFactor { get; set; } @@ -47,7 +49,9 @@ public RankFeatureFunctionLogarithmDescriptor() : base() private float ScalingFactorValue { get; set; } /// - /// Configurable scaling factor. + /// + /// Configurable scaling factor. + /// /// public RankFeatureFunctionLogarithmDescriptor ScalingFactor(float scalingFactor) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/RankFeatureFunctionSaturation.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/RankFeatureFunctionSaturation.g.cs index d83f8f87c94..0e0669a440d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/RankFeatureFunctionSaturation.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/RankFeatureFunctionSaturation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class RankFeatureFunctionSaturation { /// - /// Configurable pivot value so that the result will be less than 0.5. + /// + /// Configurable pivot value so that the result will be less than 0.5. + /// /// [JsonInclude, JsonPropertyName("pivot")] public float? Pivot { get; set; } @@ -47,7 +49,9 @@ public RankFeatureFunctionSaturationDescriptor() : base() private float? PivotValue { get; set; } /// - /// Configurable pivot value so that the result will be less than 0.5. + /// + /// Configurable pivot value so that the result will be less than 0.5. + /// /// public RankFeatureFunctionSaturationDescriptor Pivot(float? pivot) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/RankFeatureFunctionSigmoid.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/RankFeatureFunctionSigmoid.g.cs index d38dea209fc..3a7adb94c43 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/RankFeatureFunctionSigmoid.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/RankFeatureFunctionSigmoid.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class RankFeatureFunctionSigmoid { /// - /// Configurable Exponent. + /// + /// Configurable Exponent. + /// /// [JsonInclude, JsonPropertyName("exponent")] public float Exponent { get; set; } /// - /// Configurable pivot value so that the result will be less than 0.5. + /// + /// Configurable pivot value so that the result will be less than 0.5. + /// /// [JsonInclude, JsonPropertyName("pivot")] public float Pivot { get; set; } @@ -54,7 +58,9 @@ public RankFeatureFunctionSigmoidDescriptor() : base() private float PivotValue { get; set; } /// - /// Configurable Exponent. + /// + /// Configurable Exponent. + /// /// public RankFeatureFunctionSigmoidDescriptor Exponent(float exponent) { @@ -63,7 +69,9 @@ public RankFeatureFunctionSigmoidDescriptor Exponent(float exponent) } /// - /// Configurable pivot value so that the result will be less than 0.5. + /// + /// Configurable pivot value so that the result will be less than 0.5. + /// /// public RankFeatureFunctionSigmoidDescriptor Pivot(float pivot) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/RankFeatureQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/RankFeatureQuery.g.cs index a86263779ac..d7261a71c85 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/RankFeatureQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/RankFeatureQuery.g.cs @@ -30,25 +30,36 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class RankFeatureQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// `rank_feature` or `rank_features` field used to boost relevance scores. + /// + /// rank_feature or rank_features field used to boost relevance scores. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Linear function used to boost relevance scores based on the value of the rank feature `field`. + /// + /// Linear function used to boost relevance scores based on the value of the rank feature field. + /// /// [JsonInclude, JsonPropertyName("linear")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RankFeatureFunctionLinear? Linear { get; set; } /// - /// Logarithmic function used to boost relevance scores based on the value of the rank feature `field`. + /// + /// Logarithmic function used to boost relevance scores based on the value of the rank feature field. + /// /// [JsonInclude, JsonPropertyName("log")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RankFeatureFunctionLogarithm? Log { get; set; } @@ -56,13 +67,17 @@ public sealed partial class RankFeatureQuery public string? QueryName { get; set; } /// - /// Saturation function used to boost relevance scores based on the value of the rank feature `field`. + /// + /// Saturation function used to boost relevance scores based on the value of the rank feature field. + /// /// [JsonInclude, JsonPropertyName("saturation")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RankFeatureFunctionSaturation? Saturation { get; set; } /// - /// Sigmoid function used to boost relevance scores based on the value of the rank feature `field`. + /// + /// Sigmoid function used to boost relevance scores based on the value of the rank feature field. + /// /// [JsonInclude, JsonPropertyName("sigmoid")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RankFeatureFunctionSigmoid? Sigmoid { get; set; } @@ -95,7 +110,12 @@ public RankFeatureQueryDescriptor() : base() private Action SigmoidDescriptorAction { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public RankFeatureQueryDescriptor Boost(float? boost) { @@ -104,7 +124,9 @@ public RankFeatureQueryDescriptor Boost(float? boost) } /// - /// `rank_feature` or `rank_features` field used to boost relevance scores. + /// + /// rank_feature or rank_features field used to boost relevance scores. + /// /// public RankFeatureQueryDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -113,7 +135,9 @@ public RankFeatureQueryDescriptor Field(Elastic.Clients.Elasticsearch } /// - /// `rank_feature` or `rank_features` field used to boost relevance scores. + /// + /// rank_feature or rank_features field used to boost relevance scores. + /// /// public RankFeatureQueryDescriptor Field(Expression> field) { @@ -122,7 +146,9 @@ public RankFeatureQueryDescriptor Field(Expression - /// `rank_feature` or `rank_features` field used to boost relevance scores. + /// + /// rank_feature or rank_features field used to boost relevance scores. + /// /// public RankFeatureQueryDescriptor Field(Expression> field) { @@ -131,7 +157,9 @@ public RankFeatureQueryDescriptor Field(Expression - /// Linear function used to boost relevance scores based on the value of the rank feature `field`. + /// + /// Linear function used to boost relevance scores based on the value of the rank feature field. + /// /// public RankFeatureQueryDescriptor Linear(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RankFeatureFunctionLinear? linear) { @@ -158,7 +186,9 @@ public RankFeatureQueryDescriptor Linear(Action - /// Logarithmic function used to boost relevance scores based on the value of the rank feature `field`. + /// + /// Logarithmic function used to boost relevance scores based on the value of the rank feature field. + /// /// public RankFeatureQueryDescriptor Log(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RankFeatureFunctionLogarithm? log) { @@ -191,7 +221,9 @@ public RankFeatureQueryDescriptor QueryName(string? queryName) } /// - /// Saturation function used to boost relevance scores based on the value of the rank feature `field`. + /// + /// Saturation function used to boost relevance scores based on the value of the rank feature field. + /// /// public RankFeatureQueryDescriptor Saturation(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RankFeatureFunctionSaturation? saturation) { @@ -218,7 +250,9 @@ public RankFeatureQueryDescriptor Saturation(Action - /// Sigmoid function used to boost relevance scores based on the value of the rank feature `field`. + /// + /// Sigmoid function used to boost relevance scores based on the value of the rank feature field. + /// /// public RankFeatureQueryDescriptor Sigmoid(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RankFeatureFunctionSigmoid? sigmoid) { @@ -354,7 +388,12 @@ public RankFeatureQueryDescriptor() : base() private Action SigmoidDescriptorAction { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public RankFeatureQueryDescriptor Boost(float? boost) { @@ -363,7 +402,9 @@ public RankFeatureQueryDescriptor Boost(float? boost) } /// - /// `rank_feature` or `rank_features` field used to boost relevance scores. + /// + /// rank_feature or rank_features field used to boost relevance scores. + /// /// public RankFeatureQueryDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -372,7 +413,9 @@ public RankFeatureQueryDescriptor Field(Elastic.Clients.Elasticsearch.Serverless } /// - /// `rank_feature` or `rank_features` field used to boost relevance scores. + /// + /// rank_feature or rank_features field used to boost relevance scores. + /// /// public RankFeatureQueryDescriptor Field(Expression> field) { @@ -381,7 +424,9 @@ public RankFeatureQueryDescriptor Field(Expression - /// `rank_feature` or `rank_features` field used to boost relevance scores. + /// + /// rank_feature or rank_features field used to boost relevance scores. + /// /// public RankFeatureQueryDescriptor Field(Expression> field) { @@ -390,7 +435,9 @@ public RankFeatureQueryDescriptor Field(Expression - /// Linear function used to boost relevance scores based on the value of the rank feature `field`. + /// + /// Linear function used to boost relevance scores based on the value of the rank feature field. + /// /// public RankFeatureQueryDescriptor Linear(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RankFeatureFunctionLinear? linear) { @@ -417,7 +464,9 @@ public RankFeatureQueryDescriptor Linear(Action - /// Logarithmic function used to boost relevance scores based on the value of the rank feature `field`. + /// + /// Logarithmic function used to boost relevance scores based on the value of the rank feature field. + /// /// public RankFeatureQueryDescriptor Log(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RankFeatureFunctionLogarithm? log) { @@ -450,7 +499,9 @@ public RankFeatureQueryDescriptor QueryName(string? queryName) } /// - /// Saturation function used to boost relevance scores based on the value of the rank feature `field`. + /// + /// Saturation function used to boost relevance scores based on the value of the rank feature field. + /// /// public RankFeatureQueryDescriptor Saturation(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RankFeatureFunctionSaturation? saturation) { @@ -477,7 +528,9 @@ public RankFeatureQueryDescriptor Saturation(Action - /// Sigmoid function used to boost relevance scores based on the value of the rank feature `field`. + /// + /// Sigmoid function used to boost relevance scores based on the value of the rank feature field. + /// /// public RankFeatureQueryDescriptor Sigmoid(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RankFeatureFunctionSigmoid? sigmoid) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/RegexpQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/RegexpQuery.g.cs index 15b69597070..7f6db6dfaec 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/RegexpQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/RegexpQuery.g.cs @@ -153,34 +153,50 @@ public RegexpQuery(Elastic.Clients.Elasticsearch.Serverless.Field field) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } /// - /// Allows case insensitive matching of the regular expression value with the indexed field values when set to `true`.
When `false`, case sensitivity of matching depends on the underlying field’s mapping. + /// + /// Allows case insensitive matching of the regular expression value with the indexed field values when set to true. + /// When false, case sensitivity of matching depends on the underlying field’s mapping. + /// /// public bool? CaseInsensitive { get; set; } public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Enables optional operators for the regular expression. + /// + /// Enables optional operators for the regular expression. + /// /// public string? Flags { get; set; } /// - /// Maximum number of automaton states required for the query. + /// + /// Maximum number of automaton states required for the query. + /// /// public int? MaxDeterminizedStates { get; set; } public string? QueryName { get; set; } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public string? Rewrite { get; set; } /// - /// Regular expression for terms you wish to find in the provided field. + /// + /// Regular expression for terms you wish to find in the provided field. + /// /// public string Value { get; set; } @@ -205,7 +221,12 @@ public RegexpQueryDescriptor() : base() private string ValueValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public RegexpQueryDescriptor Boost(float? boost) { @@ -214,7 +235,10 @@ public RegexpQueryDescriptor Boost(float? boost) } /// - /// Allows case insensitive matching of the regular expression value with the indexed field values when set to `true`.
When `false`, case sensitivity of matching depends on the underlying field’s mapping. + /// + /// Allows case insensitive matching of the regular expression value with the indexed field values when set to true. + /// When false, case sensitivity of matching depends on the underlying field’s mapping. + /// /// public RegexpQueryDescriptor CaseInsensitive(bool? caseInsensitive = true) { @@ -241,7 +265,9 @@ public RegexpQueryDescriptor Field(Expression } /// - /// Enables optional operators for the regular expression. + /// + /// Enables optional operators for the regular expression. + /// /// public RegexpQueryDescriptor Flags(string? flags) { @@ -250,7 +276,9 @@ public RegexpQueryDescriptor Flags(string? flags) } /// - /// Maximum number of automaton states required for the query. + /// + /// Maximum number of automaton states required for the query. + /// /// public RegexpQueryDescriptor MaxDeterminizedStates(int? maxDeterminizedStates) { @@ -265,7 +293,9 @@ public RegexpQueryDescriptor QueryName(string? queryName) } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public RegexpQueryDescriptor Rewrite(string? rewrite) { @@ -274,7 +304,9 @@ public RegexpQueryDescriptor Rewrite(string? rewrite) } /// - /// Regular expression for terms you wish to find in the provided field. + /// + /// Regular expression for terms you wish to find in the provided field. + /// /// public RegexpQueryDescriptor Value(string value) { @@ -350,7 +382,12 @@ public RegexpQueryDescriptor() : base() private string ValueValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public RegexpQueryDescriptor Boost(float? boost) { @@ -359,7 +396,10 @@ public RegexpQueryDescriptor Boost(float? boost) } /// - /// Allows case insensitive matching of the regular expression value with the indexed field values when set to `true`.
When `false`, case sensitivity of matching depends on the underlying field’s mapping. + /// + /// Allows case insensitive matching of the regular expression value with the indexed field values when set to true. + /// When false, case sensitivity of matching depends on the underlying field’s mapping. + /// /// public RegexpQueryDescriptor CaseInsensitive(bool? caseInsensitive = true) { @@ -386,7 +426,9 @@ public RegexpQueryDescriptor Field(Expression } /// - /// Enables optional operators for the regular expression. + /// + /// Enables optional operators for the regular expression. + /// /// public RegexpQueryDescriptor Flags(string? flags) { @@ -395,7 +437,9 @@ public RegexpQueryDescriptor Flags(string? flags) } /// - /// Maximum number of automaton states required for the query. + /// + /// Maximum number of automaton states required for the query. + /// /// public RegexpQueryDescriptor MaxDeterminizedStates(int? maxDeterminizedStates) { @@ -410,7 +454,9 @@ public RegexpQueryDescriptor QueryName(string? queryName) } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public RegexpQueryDescriptor Rewrite(string? rewrite) { @@ -419,7 +465,9 @@ public RegexpQueryDescriptor Rewrite(string? rewrite) } /// - /// Regular expression for terms you wish to find in the provided field. + /// + /// Regular expression for terms you wish to find in the provided field. + /// /// public RegexpQueryDescriptor Value(string value) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/RuleQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/RuleQuery.g.cs index 56b4a8a1b1f..95406611384 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/RuleQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/RuleQuery.g.cs @@ -30,7 +30,12 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class RuleQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } @@ -63,7 +68,12 @@ public RuleQueryDescriptor() : base() private ICollection RulesetIdsValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public RuleQueryDescriptor Boost(float? boost) { @@ -169,7 +179,12 @@ public RuleQueryDescriptor() : base() private ICollection RulesetIdsValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public RuleQueryDescriptor Boost(float? boost) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ScriptQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ScriptQuery.g.cs index d9b31e24d9f..6651d241d68 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ScriptQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ScriptQuery.g.cs @@ -30,7 +30,12 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class ScriptQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } @@ -38,7 +43,10 @@ public sealed partial class ScriptQuery public string? QueryName { get; set; } /// - /// Contains a script to run as a query.
This script must return a boolean value, `true` or `false`. + /// + /// Contains a script to run as a query. + /// This script must return a boolean value, true or false. + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Serverless.Script Script { get; set; } @@ -61,7 +69,12 @@ public ScriptQueryDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public ScriptQueryDescriptor Boost(float? boost) { @@ -76,7 +89,10 @@ public ScriptQueryDescriptor QueryName(string? queryName) } /// - /// Contains a script to run as a query.
This script must return a boolean value, `true` or `false`. + /// + /// Contains a script to run as a query. + /// This script must return a boolean value, true or false. + /// /// public ScriptQueryDescriptor Script(Elastic.Clients.Elasticsearch.Serverless.Script script) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ScriptScoreFunction.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ScriptScoreFunction.g.cs index 100864d7323..40d2f1244ce 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ScriptScoreFunction.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ScriptScoreFunction.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class ScriptScoreFunction { /// - /// A script that computes a score. + /// + /// A script that computes a score. + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Serverless.Script Script { get; set; } @@ -51,7 +53,9 @@ public ScriptScoreFunctionDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// A script that computes a score. + /// + /// A script that computes a score. + /// /// public ScriptScoreFunctionDescriptor Script(Elastic.Clients.Elasticsearch.Serverless.Script script) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ScriptScoreQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ScriptScoreQuery.g.cs index 8472a5ef3d2..3b0647afb0a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ScriptScoreQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ScriptScoreQuery.g.cs @@ -30,19 +30,28 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class ScriptScoreQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Documents with a score lower than this floating point number are excluded from the search results. + /// + /// Documents with a score lower than this floating point number are excluded from the search results. + /// /// [JsonInclude, JsonPropertyName("min_score")] public float? MinScore { get; set; } /// - /// Query used to return documents. + /// + /// Query used to return documents. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query Query { get; set; } @@ -50,7 +59,10 @@ public sealed partial class ScriptScoreQuery public string? QueryName { get; set; } /// - /// Script used to compute the score of documents returned by the query.
Important: final relevance scores from the `script_score` query cannot be negative. + /// + /// Script used to compute the score of documents returned by the query. + /// Important: final relevance scores from the script_score query cannot be negative. + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Serverless.Script Script { get; set; } @@ -77,7 +89,12 @@ public ScriptScoreQueryDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public ScriptScoreQueryDescriptor Boost(float? boost) { @@ -86,7 +103,9 @@ public ScriptScoreQueryDescriptor Boost(float? boost) } /// - /// Documents with a score lower than this floating point number are excluded from the search results. + /// + /// Documents with a score lower than this floating point number are excluded from the search results. + /// /// public ScriptScoreQueryDescriptor MinScore(float? minScore) { @@ -95,7 +114,9 @@ public ScriptScoreQueryDescriptor MinScore(float? minScore) } /// - /// Query used to return documents. + /// + /// Query used to return documents. + /// /// public ScriptScoreQueryDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query query) { @@ -128,7 +149,10 @@ public ScriptScoreQueryDescriptor QueryName(string? queryName) } /// - /// Script used to compute the score of documents returned by the query.
Important: final relevance scores from the `script_score` query cannot be negative. + /// + /// Script used to compute the score of documents returned by the query. + /// Important: final relevance scores from the script_score query cannot be negative. + /// /// public ScriptScoreQueryDescriptor Script(Elastic.Clients.Elasticsearch.Serverless.Script script) { @@ -230,7 +254,12 @@ public ScriptScoreQueryDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public ScriptScoreQueryDescriptor Boost(float? boost) { @@ -239,7 +268,9 @@ public ScriptScoreQueryDescriptor Boost(float? boost) } /// - /// Documents with a score lower than this floating point number are excluded from the search results. + /// + /// Documents with a score lower than this floating point number are excluded from the search results. + /// /// public ScriptScoreQueryDescriptor MinScore(float? minScore) { @@ -248,7 +279,9 @@ public ScriptScoreQueryDescriptor MinScore(float? minScore) } /// - /// Query used to return documents. + /// + /// Query used to return documents. + /// /// public ScriptScoreQueryDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query query) { @@ -281,7 +314,10 @@ public ScriptScoreQueryDescriptor QueryName(string? queryName) } /// - /// Script used to compute the score of documents returned by the query.
Important: final relevance scores from the `script_score` query cannot be negative. + /// + /// Script used to compute the score of documents returned by the query. + /// Important: final relevance scores from the script_score query cannot be negative. + /// /// public ScriptScoreQueryDescriptor Script(Elastic.Clients.Elasticsearch.Serverless.Script script) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SemanticQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SemanticQuery.g.cs index 99d15394b16..7c0c761d25f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SemanticQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SemanticQuery.g.cs @@ -30,19 +30,28 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class SemanticQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// The field to query, which must be a semantic_text field type + /// + /// The field to query, which must be a semantic_text field type + /// /// [JsonInclude, JsonPropertyName("field")] public string Field { get; set; } /// - /// The query text + /// + /// The query text + /// /// [JsonInclude, JsonPropertyName("query")] public string Query { get; set; } @@ -66,7 +75,12 @@ public SemanticQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SemanticQueryDescriptor Boost(float? boost) { @@ -75,7 +89,9 @@ public SemanticQueryDescriptor Boost(float? boost) } /// - /// The field to query, which must be a semantic_text field type + /// + /// The field to query, which must be a semantic_text field type + /// /// public SemanticQueryDescriptor Field(string field) { @@ -84,7 +100,9 @@ public SemanticQueryDescriptor Field(string field) } /// - /// The query text + /// + /// The query text + /// /// public SemanticQueryDescriptor Query(string query) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ShapeFieldQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ShapeFieldQuery.g.cs index 137e4a1d15b..ece4254d153 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ShapeFieldQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ShapeFieldQuery.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class ShapeFieldQuery { /// - /// Queries using a pre-indexed shape. + /// + /// Queries using a pre-indexed shape. + /// /// [JsonInclude, JsonPropertyName("indexed_shape")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.FieldLookup? IndexedShape { get; set; } /// - /// Spatial relation between the query shape and the document shape. + /// + /// Spatial relation between the query shape and the document shape. + /// /// [JsonInclude, JsonPropertyName("relation")] public Elastic.Clients.Elasticsearch.Serverless.GeoShapeRelation? Relation { get; set; } /// - /// Queries using an inline shape definition in GeoJSON or Well Known Text (WKT) format. + /// + /// Queries using an inline shape definition in GeoJSON or Well Known Text (WKT) format. + /// /// [JsonInclude, JsonPropertyName("shape")] public object? Shape { get; set; } @@ -63,7 +69,9 @@ public ShapeFieldQueryDescriptor() : base() private object? ShapeValue { get; set; } /// - /// Queries using a pre-indexed shape. + /// + /// Queries using a pre-indexed shape. + /// /// public ShapeFieldQueryDescriptor IndexedShape(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.FieldLookup? indexedShape) { @@ -90,7 +98,9 @@ public ShapeFieldQueryDescriptor IndexedShape(Action - /// Spatial relation between the query shape and the document shape. + /// + /// Spatial relation between the query shape and the document shape. + /// /// public ShapeFieldQueryDescriptor Relation(Elastic.Clients.Elasticsearch.Serverless.GeoShapeRelation? relation) { @@ -99,7 +109,9 @@ public ShapeFieldQueryDescriptor Relation(Elastic.Clients.Elasticsear } /// - /// Queries using an inline shape definition in GeoJSON or Well Known Text (WKT) format. + /// + /// Queries using an inline shape definition in GeoJSON or Well Known Text (WKT) format. + /// /// public ShapeFieldQueryDescriptor Shape(object? shape) { @@ -157,7 +169,9 @@ public ShapeFieldQueryDescriptor() : base() private object? ShapeValue { get; set; } /// - /// Queries using a pre-indexed shape. + /// + /// Queries using a pre-indexed shape. + /// /// public ShapeFieldQueryDescriptor IndexedShape(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.FieldLookup? indexedShape) { @@ -184,7 +198,9 @@ public ShapeFieldQueryDescriptor IndexedShape(Action - /// Spatial relation between the query shape and the document shape. + /// + /// Spatial relation between the query shape and the document shape. + /// /// public ShapeFieldQueryDescriptor Relation(Elastic.Clients.Elasticsearch.Serverless.GeoShapeRelation? relation) { @@ -193,7 +209,9 @@ public ShapeFieldQueryDescriptor Relation(Elastic.Clients.Elasticsearch.Serverle } /// - /// Queries using an inline shape definition in GeoJSON or Well Known Text (WKT) format. + /// + /// Queries using an inline shape definition in GeoJSON or Well Known Text (WKT) format. + /// /// public ShapeFieldQueryDescriptor Shape(object? shape) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ShapeQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ShapeQuery.g.cs index ba54bb706e2..4d2e827716e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ShapeQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/ShapeQuery.g.cs @@ -107,13 +107,20 @@ public override void Write(Utf8JsonWriter writer, ShapeQuery value, JsonSerializ public sealed partial class ShapeQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// When set to `true` the query ignores an unmapped field and will not match any documents. + /// + /// When set to true the query ignores an unmapped field and will not match any documents. + /// /// public bool? IgnoreUnmapped { get; set; } public string? QueryName { get; set; } @@ -139,7 +146,12 @@ public ShapeQueryDescriptor() : base() private Action> ShapeDescriptorAction { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public ShapeQueryDescriptor Boost(float? boost) { @@ -166,7 +178,9 @@ public ShapeQueryDescriptor Field(Expression> } /// - /// When set to `true` the query ignores an unmapped field and will not match any documents. + /// + /// When set to true the query ignores an unmapped field and will not match any documents. + /// /// public ShapeQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { @@ -253,7 +267,12 @@ public ShapeQueryDescriptor() : base() private Action ShapeDescriptorAction { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public ShapeQueryDescriptor Boost(float? boost) { @@ -280,7 +299,9 @@ public ShapeQueryDescriptor Field(Expression> } /// - /// When set to `true` the query ignores an unmapped field and will not match any documents. + /// + /// When set to true the query ignores an unmapped field and will not match any documents. + /// /// public ShapeQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SimpleQueryStringQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SimpleQueryStringQuery.g.cs index 5c8945de48d..671cfc00e51 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SimpleQueryStringQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SimpleQueryStringQuery.g.cs @@ -30,80 +30,112 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class SimpleQueryStringQuery { /// - /// Analyzer used to convert text in the query string into tokens. + /// + /// Analyzer used to convert text in the query string into tokens. + /// /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } /// - /// If `true`, the query attempts to analyze wildcard terms in the query string. + /// + /// If true, the query attempts to analyze wildcard terms in the query string. + /// /// [JsonInclude, JsonPropertyName("analyze_wildcard")] public bool? AnalyzeWildcard { get; set; } /// - /// If `true`, the parser creates a match_phrase query for each multi-position token. + /// + /// If true, the parser creates a match_phrase query for each multi-position token. + /// /// [JsonInclude, JsonPropertyName("auto_generate_synonyms_phrase_query")] public bool? AutoGenerateSynonymsPhraseQuery { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Default boolean logic used to interpret text in the query string if no operators are specified. + /// + /// Default boolean logic used to interpret text in the query string if no operators are specified. + /// /// [JsonInclude, JsonPropertyName("default_operator")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Operator? DefaultOperator { get; set; } /// - /// Array of fields you wish to search.
Accepts wildcard expressions.
You also can boost relevance scores for matches to particular fields using a caret (`^`) notation.
Defaults to the `index.query.default_field index` setting, which has a default value of `*`. + /// + /// Array of fields you wish to search. + /// Accepts wildcard expressions. + /// You also can boost relevance scores for matches to particular fields using a caret (^) notation. + /// Defaults to the index.query.default_field index setting, which has a default value of *. + /// /// [JsonInclude, JsonPropertyName("fields")] [JsonConverter(typeof(FieldsConverter))] public Elastic.Clients.Elasticsearch.Serverless.Fields? Fields { get; set; } /// - /// List of enabled operators for the simple query string syntax. + /// + /// List of enabled operators for the simple query string syntax. + /// /// [JsonInclude, JsonPropertyName("flags")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.SimpleQueryStringFlag? Flags { get; set; } /// - /// Maximum number of terms to which the query expands for fuzzy matching. + /// + /// Maximum number of terms to which the query expands for fuzzy matching. + /// /// [JsonInclude, JsonPropertyName("fuzzy_max_expansions")] public int? FuzzyMaxExpansions { get; set; } /// - /// Number of beginning characters left unchanged for fuzzy matching. + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// /// [JsonInclude, JsonPropertyName("fuzzy_prefix_length")] public int? FuzzyPrefixLength { get; set; } /// - /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// + /// If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). + /// /// [JsonInclude, JsonPropertyName("fuzzy_transpositions")] public bool? FuzzyTranspositions { get; set; } /// - /// If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. + /// + /// If true, format-based errors, such as providing a text value for a numeric field, are ignored. + /// /// [JsonInclude, JsonPropertyName("lenient")] public bool? Lenient { get; set; } /// - /// Minimum number of clauses that must match for a document to be returned. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// /// [JsonInclude, JsonPropertyName("minimum_should_match")] public Elastic.Clients.Elasticsearch.Serverless.MinimumShouldMatch? MinimumShouldMatch { get; set; } /// - /// Query string in the simple query string syntax you wish to parse and use for search. + /// + /// Query string in the simple query string syntax you wish to parse and use for search. + /// /// [JsonInclude, JsonPropertyName("query")] public string Query { get; set; } @@ -111,7 +143,9 @@ public sealed partial class SimpleQueryStringQuery public string? QueryName { get; set; } /// - /// Suffix appended to quoted text in the query string. + /// + /// Suffix appended to quoted text in the query string. + /// /// [JsonInclude, JsonPropertyName("quote_field_suffix")] public string? QuoteFieldSuffix { get; set; } @@ -144,7 +178,9 @@ public SimpleQueryStringQueryDescriptor() : base() private string? QuoteFieldSuffixValue { get; set; } /// - /// Analyzer used to convert text in the query string into tokens. + /// + /// Analyzer used to convert text in the query string into tokens. + /// /// public SimpleQueryStringQueryDescriptor Analyzer(string? analyzer) { @@ -153,7 +189,9 @@ public SimpleQueryStringQueryDescriptor Analyzer(string? analyzer) } /// - /// If `true`, the query attempts to analyze wildcard terms in the query string. + /// + /// If true, the query attempts to analyze wildcard terms in the query string. + /// /// public SimpleQueryStringQueryDescriptor AnalyzeWildcard(bool? analyzeWildcard = true) { @@ -162,7 +200,9 @@ public SimpleQueryStringQueryDescriptor AnalyzeWildcard(bool? analyze } /// - /// If `true`, the parser creates a match_phrase query for each multi-position token. + /// + /// If true, the parser creates a match_phrase query for each multi-position token. + /// /// public SimpleQueryStringQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSynonymsPhraseQuery = true) { @@ -171,7 +211,12 @@ public SimpleQueryStringQueryDescriptor AutoGenerateSynonymsPhraseQue } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SimpleQueryStringQueryDescriptor Boost(float? boost) { @@ -180,7 +225,9 @@ public SimpleQueryStringQueryDescriptor Boost(float? boost) } /// - /// Default boolean logic used to interpret text in the query string if no operators are specified. + /// + /// Default boolean logic used to interpret text in the query string if no operators are specified. + /// /// public SimpleQueryStringQueryDescriptor DefaultOperator(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Operator? defaultOperator) { @@ -189,7 +236,12 @@ public SimpleQueryStringQueryDescriptor DefaultOperator(Elastic.Clien } /// - /// Array of fields you wish to search.
Accepts wildcard expressions.
You also can boost relevance scores for matches to particular fields using a caret (`^`) notation.
Defaults to the `index.query.default_field index` setting, which has a default value of `*`. + /// + /// Array of fields you wish to search. + /// Accepts wildcard expressions. + /// You also can boost relevance scores for matches to particular fields using a caret (^) notation. + /// Defaults to the index.query.default_field index setting, which has a default value of *. + /// /// public SimpleQueryStringQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Serverless.Fields? fields) { @@ -198,7 +250,9 @@ public SimpleQueryStringQueryDescriptor Fields(Elastic.Clients.Elasti } /// - /// List of enabled operators for the simple query string syntax. + /// + /// List of enabled operators for the simple query string syntax. + /// /// public SimpleQueryStringQueryDescriptor Flags(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.SimpleQueryStringFlag? flags) { @@ -207,7 +261,9 @@ public SimpleQueryStringQueryDescriptor Flags(Elastic.Clients.Elastic } /// - /// Maximum number of terms to which the query expands for fuzzy matching. + /// + /// Maximum number of terms to which the query expands for fuzzy matching. + /// /// public SimpleQueryStringQueryDescriptor FuzzyMaxExpansions(int? fuzzyMaxExpansions) { @@ -216,7 +272,9 @@ public SimpleQueryStringQueryDescriptor FuzzyMaxExpansions(int? fuzzy } /// - /// Number of beginning characters left unchanged for fuzzy matching. + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// /// public SimpleQueryStringQueryDescriptor FuzzyPrefixLength(int? fuzzyPrefixLength) { @@ -225,7 +283,9 @@ public SimpleQueryStringQueryDescriptor FuzzyPrefixLength(int? fuzzyP } /// - /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// + /// If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). + /// /// public SimpleQueryStringQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true) { @@ -234,7 +294,9 @@ public SimpleQueryStringQueryDescriptor FuzzyTranspositions(bool? fuz } /// - /// If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. + /// + /// If true, format-based errors, such as providing a text value for a numeric field, are ignored. + /// /// public SimpleQueryStringQueryDescriptor Lenient(bool? lenient = true) { @@ -243,7 +305,9 @@ public SimpleQueryStringQueryDescriptor Lenient(bool? lenient = true) } /// - /// Minimum number of clauses that must match for a document to be returned. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// /// public SimpleQueryStringQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.Serverless.MinimumShouldMatch? minimumShouldMatch) { @@ -252,7 +316,9 @@ public SimpleQueryStringQueryDescriptor MinimumShouldMatch(Elastic.Cl } /// - /// Query string in the simple query string syntax you wish to parse and use for search. + /// + /// Query string in the simple query string syntax you wish to parse and use for search. + /// /// public SimpleQueryStringQueryDescriptor Query(string query) { @@ -267,7 +333,9 @@ public SimpleQueryStringQueryDescriptor QueryName(string? queryName) } /// - /// Suffix appended to quoted text in the query string. + /// + /// Suffix appended to quoted text in the query string. + /// /// public SimpleQueryStringQueryDescriptor QuoteFieldSuffix(string? quoteFieldSuffix) { @@ -393,7 +461,9 @@ public SimpleQueryStringQueryDescriptor() : base() private string? QuoteFieldSuffixValue { get; set; } /// - /// Analyzer used to convert text in the query string into tokens. + /// + /// Analyzer used to convert text in the query string into tokens. + /// /// public SimpleQueryStringQueryDescriptor Analyzer(string? analyzer) { @@ -402,7 +472,9 @@ public SimpleQueryStringQueryDescriptor Analyzer(string? analyzer) } /// - /// If `true`, the query attempts to analyze wildcard terms in the query string. + /// + /// If true, the query attempts to analyze wildcard terms in the query string. + /// /// public SimpleQueryStringQueryDescriptor AnalyzeWildcard(bool? analyzeWildcard = true) { @@ -411,7 +483,9 @@ public SimpleQueryStringQueryDescriptor AnalyzeWildcard(bool? analyzeWildcard = } /// - /// If `true`, the parser creates a match_phrase query for each multi-position token. + /// + /// If true, the parser creates a match_phrase query for each multi-position token. + /// /// public SimpleQueryStringQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSynonymsPhraseQuery = true) { @@ -420,7 +494,12 @@ public SimpleQueryStringQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? au } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SimpleQueryStringQueryDescriptor Boost(float? boost) { @@ -429,7 +508,9 @@ public SimpleQueryStringQueryDescriptor Boost(float? boost) } /// - /// Default boolean logic used to interpret text in the query string if no operators are specified. + /// + /// Default boolean logic used to interpret text in the query string if no operators are specified. + /// /// public SimpleQueryStringQueryDescriptor DefaultOperator(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Operator? defaultOperator) { @@ -438,7 +519,12 @@ public SimpleQueryStringQueryDescriptor DefaultOperator(Elastic.Clients.Elastics } /// - /// Array of fields you wish to search.
Accepts wildcard expressions.
You also can boost relevance scores for matches to particular fields using a caret (`^`) notation.
Defaults to the `index.query.default_field index` setting, which has a default value of `*`. + /// + /// Array of fields you wish to search. + /// Accepts wildcard expressions. + /// You also can boost relevance scores for matches to particular fields using a caret (^) notation. + /// Defaults to the index.query.default_field index setting, which has a default value of *. + /// /// public SimpleQueryStringQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Serverless.Fields? fields) { @@ -447,7 +533,9 @@ public SimpleQueryStringQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Ser } /// - /// List of enabled operators for the simple query string syntax. + /// + /// List of enabled operators for the simple query string syntax. + /// /// public SimpleQueryStringQueryDescriptor Flags(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.SimpleQueryStringFlag? flags) { @@ -456,7 +544,9 @@ public SimpleQueryStringQueryDescriptor Flags(Elastic.Clients.Elasticsearch.Serv } /// - /// Maximum number of terms to which the query expands for fuzzy matching. + /// + /// Maximum number of terms to which the query expands for fuzzy matching. + /// /// public SimpleQueryStringQueryDescriptor FuzzyMaxExpansions(int? fuzzyMaxExpansions) { @@ -465,7 +555,9 @@ public SimpleQueryStringQueryDescriptor FuzzyMaxExpansions(int? fuzzyMaxExpansio } /// - /// Number of beginning characters left unchanged for fuzzy matching. + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// /// public SimpleQueryStringQueryDescriptor FuzzyPrefixLength(int? fuzzyPrefixLength) { @@ -474,7 +566,9 @@ public SimpleQueryStringQueryDescriptor FuzzyPrefixLength(int? fuzzyPrefixLength } /// - /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// + /// If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). + /// /// public SimpleQueryStringQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true) { @@ -483,7 +577,9 @@ public SimpleQueryStringQueryDescriptor FuzzyTranspositions(bool? fuzzyTransposi } /// - /// If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. + /// + /// If true, format-based errors, such as providing a text value for a numeric field, are ignored. + /// /// public SimpleQueryStringQueryDescriptor Lenient(bool? lenient = true) { @@ -492,7 +588,9 @@ public SimpleQueryStringQueryDescriptor Lenient(bool? lenient = true) } /// - /// Minimum number of clauses that must match for a document to be returned. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// /// public SimpleQueryStringQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.Serverless.MinimumShouldMatch? minimumShouldMatch) { @@ -501,7 +599,9 @@ public SimpleQueryStringQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elast } /// - /// Query string in the simple query string syntax you wish to parse and use for search. + /// + /// Query string in the simple query string syntax you wish to parse and use for search. + /// /// public SimpleQueryStringQueryDescriptor Query(string query) { @@ -516,7 +616,9 @@ public SimpleQueryStringQueryDescriptor QueryName(string? queryName) } /// - /// Suffix appended to quoted text in the query string. + /// + /// Suffix appended to quoted text in the query string. + /// /// public SimpleQueryStringQueryDescriptor QuoteFieldSuffix(string? quoteFieldSuffix) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanContainingQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanContainingQuery.g.cs index f3c779ff99c..0f87c6badd4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanContainingQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanContainingQuery.g.cs @@ -30,19 +30,30 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class SpanContainingQuery { /// - /// Can be any span query.
Matching spans from `big` that contain matches from `little` are returned. + /// + /// Can be any span query. + /// Matching spans from big that contain matches from little are returned. + /// /// [JsonInclude, JsonPropertyName("big")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.SpanQuery Big { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Can be any span query.
Matching spans from `big` that contain matches from `little` are returned. + /// + /// Can be any span query. + /// Matching spans from big that contain matches from little are returned. + /// /// [JsonInclude, JsonPropertyName("little")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.SpanQuery Little { get; set; } @@ -71,7 +82,10 @@ public SpanContainingQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Can be any span query.
Matching spans from `big` that contain matches from `little` are returned. + /// + /// Can be any span query. + /// Matching spans from big that contain matches from little are returned. + /// /// public SpanContainingQueryDescriptor Big(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.SpanQuery big) { @@ -98,7 +112,12 @@ public SpanContainingQueryDescriptor Big(Action - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanContainingQueryDescriptor Boost(float? boost) { @@ -107,7 +126,10 @@ public SpanContainingQueryDescriptor Boost(float? boost) } /// - /// Can be any span query.
Matching spans from `big` that contain matches from `little` are returned. + /// + /// Can be any span query. + /// Matching spans from big that contain matches from little are returned. + /// /// public SpanContainingQueryDescriptor Little(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.SpanQuery little) { @@ -208,7 +230,10 @@ public SpanContainingQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Can be any span query.
Matching spans from `big` that contain matches from `little` are returned. + /// + /// Can be any span query. + /// Matching spans from big that contain matches from little are returned. + /// /// public SpanContainingQueryDescriptor Big(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.SpanQuery big) { @@ -235,7 +260,12 @@ public SpanContainingQueryDescriptor Big(Action - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanContainingQueryDescriptor Boost(float? boost) { @@ -244,7 +274,10 @@ public SpanContainingQueryDescriptor Boost(float? boost) } /// - /// Can be any span query.
Matching spans from `big` that contain matches from `little` are returned. + /// + /// Can be any span query. + /// Matching spans from big that contain matches from little are returned. + /// /// public SpanContainingQueryDescriptor Little(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.SpanQuery little) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanFieldMaskingQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanFieldMaskingQuery.g.cs index f42d166b8a3..88681550921 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanFieldMaskingQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanFieldMaskingQuery.g.cs @@ -30,7 +30,12 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class SpanFieldMaskingQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } @@ -61,7 +66,12 @@ public SpanFieldMaskingQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanFieldMaskingQueryDescriptor Boost(float? boost) { @@ -170,7 +180,12 @@ public SpanFieldMaskingQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanFieldMaskingQueryDescriptor Boost(float? boost) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanFirstQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanFirstQuery.g.cs index 93e0a22a791..312e93bd1ce 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanFirstQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanFirstQuery.g.cs @@ -30,19 +30,28 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class SpanFirstQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Controls the maximum end position permitted in a match. + /// + /// Controls the maximum end position permitted in a match. + /// /// [JsonInclude, JsonPropertyName("end")] public int End { get; set; } /// - /// Can be any other span type query. + /// + /// Can be any other span type query. + /// /// [JsonInclude, JsonPropertyName("match")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.SpanQuery Match { get; set; } @@ -69,7 +78,12 @@ public SpanFirstQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanFirstQueryDescriptor Boost(float? boost) { @@ -78,7 +92,9 @@ public SpanFirstQueryDescriptor Boost(float? boost) } /// - /// Controls the maximum end position permitted in a match. + /// + /// Controls the maximum end position permitted in a match. + /// /// public SpanFirstQueryDescriptor End(int end) { @@ -87,7 +103,9 @@ public SpanFirstQueryDescriptor End(int end) } /// - /// Can be any other span type query. + /// + /// Can be any other span type query. + /// /// public SpanFirstQueryDescriptor Match(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.SpanQuery match) { @@ -172,7 +190,12 @@ public SpanFirstQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanFirstQueryDescriptor Boost(float? boost) { @@ -181,7 +204,9 @@ public SpanFirstQueryDescriptor Boost(float? boost) } /// - /// Controls the maximum end position permitted in a match. + /// + /// Controls the maximum end position permitted in a match. + /// /// public SpanFirstQueryDescriptor End(int end) { @@ -190,7 +215,9 @@ public SpanFirstQueryDescriptor End(int end) } /// - /// Can be any other span type query. + /// + /// Can be any other span type query. + /// /// public SpanFirstQueryDescriptor Match(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.SpanQuery match) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanMultiTermQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanMultiTermQuery.g.cs index 56e3ed48543..e4b75dafbc7 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanMultiTermQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanMultiTermQuery.g.cs @@ -30,13 +30,20 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class SpanMultiTermQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Should be a multi term query (one of `wildcard`, `fuzzy`, `prefix`, `range`, or `regexp` query). + /// + /// Should be a multi term query (one of wildcard, fuzzy, prefix, range, or regexp query). + /// /// [JsonInclude, JsonPropertyName("match")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query Match { get; set; } @@ -62,7 +69,12 @@ public SpanMultiTermQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanMultiTermQueryDescriptor Boost(float? boost) { @@ -71,7 +83,9 @@ public SpanMultiTermQueryDescriptor Boost(float? boost) } /// - /// Should be a multi term query (one of `wildcard`, `fuzzy`, `prefix`, `range`, or `regexp` query). + /// + /// Should be a multi term query (one of wildcard, fuzzy, prefix, range, or regexp query). + /// /// public SpanMultiTermQueryDescriptor Match(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query match) { @@ -153,7 +167,12 @@ public SpanMultiTermQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanMultiTermQueryDescriptor Boost(float? boost) { @@ -162,7 +181,9 @@ public SpanMultiTermQueryDescriptor Boost(float? boost) } /// - /// Should be a multi term query (one of `wildcard`, `fuzzy`, `prefix`, `range`, or `regexp` query). + /// + /// Should be a multi term query (one of wildcard, fuzzy, prefix, range, or regexp query). + /// /// public SpanMultiTermQueryDescriptor Match(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query match) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanNearQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanNearQuery.g.cs index 488626cf62d..46e595b09c6 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanNearQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanNearQuery.g.cs @@ -30,19 +30,28 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class SpanNearQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Array of one or more other span type queries. + /// + /// Array of one or more other span type queries. + /// /// [JsonInclude, JsonPropertyName("clauses")] public ICollection Clauses { get; set; } /// - /// Controls whether matches are required to be in-order. + /// + /// Controls whether matches are required to be in-order. + /// /// [JsonInclude, JsonPropertyName("in_order")] public bool? InOrder { get; set; } @@ -50,7 +59,9 @@ public sealed partial class SpanNearQuery public string? QueryName { get; set; } /// - /// Controls the maximum number of intervening unmatched positions permitted. + /// + /// Controls the maximum number of intervening unmatched positions permitted. + /// /// [JsonInclude, JsonPropertyName("slop")] public int? Slop { get; set; } @@ -77,7 +88,12 @@ public SpanNearQueryDescriptor() : base() private int? SlopValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanNearQueryDescriptor Boost(float? boost) { @@ -86,7 +102,9 @@ public SpanNearQueryDescriptor Boost(float? boost) } /// - /// Array of one or more other span type queries. + /// + /// Array of one or more other span type queries. + /// /// public SpanNearQueryDescriptor Clauses(ICollection clauses) { @@ -125,7 +143,9 @@ public SpanNearQueryDescriptor Clauses(params Action - /// Controls whether matches are required to be in-order. + /// + /// Controls whether matches are required to be in-order. + /// /// public SpanNearQueryDescriptor InOrder(bool? inOrder = true) { @@ -140,7 +160,9 @@ public SpanNearQueryDescriptor QueryName(string? queryName) } /// - /// Controls the maximum number of intervening unmatched positions permitted. + /// + /// Controls the maximum number of intervening unmatched positions permitted. + /// /// public SpanNearQueryDescriptor Slop(int? slop) { @@ -228,7 +250,12 @@ public SpanNearQueryDescriptor() : base() private int? SlopValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanNearQueryDescriptor Boost(float? boost) { @@ -237,7 +264,9 @@ public SpanNearQueryDescriptor Boost(float? boost) } /// - /// Array of one or more other span type queries. + /// + /// Array of one or more other span type queries. + /// /// public SpanNearQueryDescriptor Clauses(ICollection clauses) { @@ -276,7 +305,9 @@ public SpanNearQueryDescriptor Clauses(params Action - /// Controls whether matches are required to be in-order. + /// + /// Controls whether matches are required to be in-order. + /// /// public SpanNearQueryDescriptor InOrder(bool? inOrder = true) { @@ -291,7 +322,9 @@ public SpanNearQueryDescriptor QueryName(string? queryName) } /// - /// Controls the maximum number of intervening unmatched positions permitted. + /// + /// Controls the maximum number of intervening unmatched positions permitted. + /// /// public SpanNearQueryDescriptor Slop(int? slop) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanNotQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanNotQuery.g.cs index 44ca1b65ac1..32d6a0d7255 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanNotQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanNotQuery.g.cs @@ -30,37 +30,53 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class SpanNotQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// The number of tokens from within the include span that can’t have overlap with the exclude span.
Equivalent to setting both `pre` and `post`. + /// + /// The number of tokens from within the include span that can’t have overlap with the exclude span. + /// Equivalent to setting both pre and post. + /// /// [JsonInclude, JsonPropertyName("dist")] public int? Dist { get; set; } /// - /// Span query whose matches must not overlap those returned. + /// + /// Span query whose matches must not overlap those returned. + /// /// [JsonInclude, JsonPropertyName("exclude")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.SpanQuery Exclude { get; set; } /// - /// Span query whose matches are filtered. + /// + /// Span query whose matches are filtered. + /// /// [JsonInclude, JsonPropertyName("include")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.SpanQuery Include { get; set; } /// - /// The number of tokens after the include span that can’t have overlap with the exclude span. + /// + /// The number of tokens after the include span that can’t have overlap with the exclude span. + /// /// [JsonInclude, JsonPropertyName("post")] public int? Post { get; set; } /// - /// The number of tokens before the include span that can’t have overlap with the exclude span. + /// + /// The number of tokens before the include span that can’t have overlap with the exclude span. + /// /// [JsonInclude, JsonPropertyName("pre")] public int? Pre { get; set; } @@ -92,7 +108,12 @@ public SpanNotQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanNotQueryDescriptor Boost(float? boost) { @@ -101,7 +122,10 @@ public SpanNotQueryDescriptor Boost(float? boost) } /// - /// The number of tokens from within the include span that can’t have overlap with the exclude span.
Equivalent to setting both `pre` and `post`. + /// + /// The number of tokens from within the include span that can’t have overlap with the exclude span. + /// Equivalent to setting both pre and post. + /// /// public SpanNotQueryDescriptor Dist(int? dist) { @@ -110,7 +134,9 @@ public SpanNotQueryDescriptor Dist(int? dist) } /// - /// Span query whose matches must not overlap those returned. + /// + /// Span query whose matches must not overlap those returned. + /// /// public SpanNotQueryDescriptor Exclude(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.SpanQuery exclude) { @@ -137,7 +163,9 @@ public SpanNotQueryDescriptor Exclude(Action - /// Span query whose matches are filtered. + /// + /// Span query whose matches are filtered. + /// /// public SpanNotQueryDescriptor Include(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.SpanQuery include) { @@ -164,7 +192,9 @@ public SpanNotQueryDescriptor Include(Action - /// The number of tokens after the include span that can’t have overlap with the exclude span. + /// + /// The number of tokens after the include span that can’t have overlap with the exclude span. + /// /// public SpanNotQueryDescriptor Post(int? post) { @@ -173,7 +203,9 @@ public SpanNotQueryDescriptor Post(int? post) } /// - /// The number of tokens before the include span that can’t have overlap with the exclude span. + /// + /// The number of tokens before the include span that can’t have overlap with the exclude span. + /// /// public SpanNotQueryDescriptor Pre(int? pre) { @@ -277,7 +309,12 @@ public SpanNotQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanNotQueryDescriptor Boost(float? boost) { @@ -286,7 +323,10 @@ public SpanNotQueryDescriptor Boost(float? boost) } /// - /// The number of tokens from within the include span that can’t have overlap with the exclude span.
Equivalent to setting both `pre` and `post`. + /// + /// The number of tokens from within the include span that can’t have overlap with the exclude span. + /// Equivalent to setting both pre and post. + /// /// public SpanNotQueryDescriptor Dist(int? dist) { @@ -295,7 +335,9 @@ public SpanNotQueryDescriptor Dist(int? dist) } /// - /// Span query whose matches must not overlap those returned. + /// + /// Span query whose matches must not overlap those returned. + /// /// public SpanNotQueryDescriptor Exclude(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.SpanQuery exclude) { @@ -322,7 +364,9 @@ public SpanNotQueryDescriptor Exclude(Action - /// Span query whose matches are filtered. + /// + /// Span query whose matches are filtered. + /// /// public SpanNotQueryDescriptor Include(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.SpanQuery include) { @@ -349,7 +393,9 @@ public SpanNotQueryDescriptor Include(Action - /// The number of tokens after the include span that can’t have overlap with the exclude span. + /// + /// The number of tokens after the include span that can’t have overlap with the exclude span. + /// /// public SpanNotQueryDescriptor Post(int? post) { @@ -358,7 +404,9 @@ public SpanNotQueryDescriptor Post(int? post) } /// - /// The number of tokens before the include span that can’t have overlap with the exclude span. + /// + /// The number of tokens before the include span that can’t have overlap with the exclude span. + /// /// public SpanNotQueryDescriptor Pre(int? pre) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanOrQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanOrQuery.g.cs index f474918ecbb..83c31d674f9 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanOrQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanOrQuery.g.cs @@ -30,13 +30,20 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class SpanOrQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Array of one or more other span type queries. + /// + /// Array of one or more other span type queries. + /// /// [JsonInclude, JsonPropertyName("clauses")] public ICollection Clauses { get; set; } @@ -63,7 +70,12 @@ public SpanOrQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanOrQueryDescriptor Boost(float? boost) { @@ -72,7 +84,9 @@ public SpanOrQueryDescriptor Boost(float? boost) } /// - /// Array of one or more other span type queries. + /// + /// Array of one or more other span type queries. + /// /// public SpanOrQueryDescriptor Clauses(ICollection clauses) { @@ -182,7 +196,12 @@ public SpanOrQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanOrQueryDescriptor Boost(float? boost) { @@ -191,7 +210,9 @@ public SpanOrQueryDescriptor Boost(float? boost) } /// - /// Array of one or more other span type queries. + /// + /// Array of one or more other span type queries. + /// /// public SpanOrQueryDescriptor Clauses(ICollection clauses) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanTermQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanTermQuery.g.cs index 8356e34ff12..3567a984d2f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanTermQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanTermQuery.g.cs @@ -105,7 +105,12 @@ public SpanTermQuery(Elastic.Clients.Elasticsearch.Serverless.Field field) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } @@ -130,7 +135,12 @@ public SpanTermQueryDescriptor() : base() private string ValueValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanTermQueryDescriptor Boost(float? boost) { @@ -208,7 +218,12 @@ public SpanTermQueryDescriptor() : base() private string ValueValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanTermQueryDescriptor Boost(float? boost) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanWithinQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanWithinQuery.g.cs index 23cedc4a973..13f49ac0cf3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanWithinQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SpanWithinQuery.g.cs @@ -30,19 +30,30 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class SpanWithinQuery { /// - /// Can be any span query.
Matching spans from `little` that are enclosed within `big` are returned. + /// + /// Can be any span query. + /// Matching spans from little that are enclosed within big are returned. + /// /// [JsonInclude, JsonPropertyName("big")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.SpanQuery Big { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Can be any span query.
Matching spans from `little` that are enclosed within `big` are returned. + /// + /// Can be any span query. + /// Matching spans from little that are enclosed within big are returned. + /// /// [JsonInclude, JsonPropertyName("little")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.SpanQuery Little { get; set; } @@ -71,7 +82,10 @@ public SpanWithinQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Can be any span query.
Matching spans from `little` that are enclosed within `big` are returned. + /// + /// Can be any span query. + /// Matching spans from little that are enclosed within big are returned. + /// /// public SpanWithinQueryDescriptor Big(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.SpanQuery big) { @@ -98,7 +112,12 @@ public SpanWithinQueryDescriptor Big(Action - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanWithinQueryDescriptor Boost(float? boost) { @@ -107,7 +126,10 @@ public SpanWithinQueryDescriptor Boost(float? boost) } /// - /// Can be any span query.
Matching spans from `little` that are enclosed within `big` are returned. + /// + /// Can be any span query. + /// Matching spans from little that are enclosed within big are returned. + /// /// public SpanWithinQueryDescriptor Little(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.SpanQuery little) { @@ -208,7 +230,10 @@ public SpanWithinQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Can be any span query.
Matching spans from `little` that are enclosed within `big` are returned. + /// + /// Can be any span query. + /// Matching spans from little that are enclosed within big are returned. + /// /// public SpanWithinQueryDescriptor Big(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.SpanQuery big) { @@ -235,7 +260,12 @@ public SpanWithinQueryDescriptor Big(Action - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanWithinQueryDescriptor Boost(float? boost) { @@ -244,7 +274,10 @@ public SpanWithinQueryDescriptor Boost(float? boost) } /// - /// Can be any span query.
Matching spans from `little` that are enclosed within `big` are returned. + /// + /// Can be any span query. + /// Matching spans from little that are enclosed within big are returned. + /// /// public SpanWithinQueryDescriptor Little(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.SpanQuery little) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SparseVectorQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SparseVectorQuery.g.cs index 2800ecd3dba..d0034b94dbb 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SparseVectorQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/SparseVectorQuery.g.cs @@ -49,19 +49,30 @@ internal SparseVectorQuery(string variantName, object variant) public static SparseVectorQuery InferenceId(Elastic.Clients.Elasticsearch.Serverless.Id id) => new SparseVectorQuery("inference_id", id); /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// The name of the field that contains the token-weight pairs to be searched against.
This field must be a mapped sparse_vector field. + /// + /// The name of the field that contains the token-weight pairs to be searched against. + /// This field must be a mapped sparse_vector field. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// The query text you want to use for search.
If inference_id is specified, query must also be specified. + /// + /// The query text you want to use for search. + /// If inference_id is specified, query must also be specified. + /// /// [JsonInclude, JsonPropertyName("query")] public string? Query { get; set; } @@ -231,7 +242,12 @@ private SparseVectorQueryDescriptor Set(object variant, string varian private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SparseVectorQueryDescriptor Boost(float? boost) { @@ -240,7 +256,10 @@ public SparseVectorQueryDescriptor Boost(float? boost) } /// - /// The name of the field that contains the token-weight pairs to be searched against.
This field must be a mapped sparse_vector field. + /// + /// The name of the field that contains the token-weight pairs to be searched against. + /// This field must be a mapped sparse_vector field. + /// /// public SparseVectorQueryDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -249,7 +268,10 @@ public SparseVectorQueryDescriptor Field(Elastic.Clients.Elasticsearc } /// - /// The name of the field that contains the token-weight pairs to be searched against.
This field must be a mapped sparse_vector field. + /// + /// The name of the field that contains the token-weight pairs to be searched against. + /// This field must be a mapped sparse_vector field. + /// /// public SparseVectorQueryDescriptor Field(Expression> field) { @@ -258,7 +280,10 @@ public SparseVectorQueryDescriptor Field(Expression - /// The name of the field that contains the token-weight pairs to be searched against.
This field must be a mapped sparse_vector field. + /// + /// The name of the field that contains the token-weight pairs to be searched against. + /// This field must be a mapped sparse_vector field. + /// /// public SparseVectorQueryDescriptor Field(Expression> field) { @@ -267,7 +292,10 @@ public SparseVectorQueryDescriptor Field(Expression - /// The query text you want to use for search.
If inference_id is specified, query must also be specified. + /// + /// The query text you want to use for search. + /// If inference_id is specified, query must also be specified. + /// /// public SparseVectorQueryDescriptor Query(string? query) { @@ -364,7 +392,12 @@ private SparseVectorQueryDescriptor Set(object variant, string variantName) private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SparseVectorQueryDescriptor Boost(float? boost) { @@ -373,7 +406,10 @@ public SparseVectorQueryDescriptor Boost(float? boost) } /// - /// The name of the field that contains the token-weight pairs to be searched against.
This field must be a mapped sparse_vector field. + /// + /// The name of the field that contains the token-weight pairs to be searched against. + /// This field must be a mapped sparse_vector field. + /// /// public SparseVectorQueryDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -382,7 +418,10 @@ public SparseVectorQueryDescriptor Field(Elastic.Clients.Elasticsearch.Serverles } /// - /// The name of the field that contains the token-weight pairs to be searched against.
This field must be a mapped sparse_vector field. + /// + /// The name of the field that contains the token-weight pairs to be searched against. + /// This field must be a mapped sparse_vector field. + /// /// public SparseVectorQueryDescriptor Field(Expression> field) { @@ -391,7 +430,10 @@ public SparseVectorQueryDescriptor Field(Expression - /// The name of the field that contains the token-weight pairs to be searched against.
This field must be a mapped sparse_vector field. + /// + /// The name of the field that contains the token-weight pairs to be searched against. + /// This field must be a mapped sparse_vector field. + /// /// public SparseVectorQueryDescriptor Field(Expression> field) { @@ -400,7 +442,10 @@ public SparseVectorQueryDescriptor Field(Expression - /// The query text you want to use for search.
If inference_id is specified, query must also be specified. + /// + /// The query text you want to use for search. + /// If inference_id is specified, query must also be specified. + /// /// public SparseVectorQueryDescriptor Query(string? query) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TermQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TermQuery.g.cs index 71168c005df..7b04b4ec1d8 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TermQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TermQuery.g.cs @@ -117,19 +117,29 @@ public TermQuery(Elastic.Clients.Elasticsearch.Serverless.Field field) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } /// - /// Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.
When `false`, the case sensitivity of matching depends on the underlying field’s mapping. + /// + /// Allows ASCII case insensitive matching of the value with the indexed field values when set to true. + /// When false, the case sensitivity of matching depends on the underlying field’s mapping. + /// /// public bool? CaseInsensitive { get; set; } public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } public string? QueryName { get; set; } /// - /// Term you wish to find in the provided field. + /// + /// Term you wish to find in the provided field. + /// /// public Elastic.Clients.Elasticsearch.Serverless.FieldValue Value { get; set; } @@ -151,7 +161,12 @@ public TermQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.FieldValue ValueValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public TermQueryDescriptor Boost(float? boost) { @@ -160,7 +175,10 @@ public TermQueryDescriptor Boost(float? boost) } /// - /// Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.
When `false`, the case sensitivity of matching depends on the underlying field’s mapping. + /// + /// Allows ASCII case insensitive matching of the value with the indexed field values when set to true. + /// When false, the case sensitivity of matching depends on the underlying field’s mapping. + /// /// public TermQueryDescriptor CaseInsensitive(bool? caseInsensitive = true) { @@ -193,7 +211,9 @@ public TermQueryDescriptor QueryName(string? queryName) } /// - /// Term you wish to find in the provided field. + /// + /// Term you wish to find in the provided field. + /// /// public TermQueryDescriptor Value(Elastic.Clients.Elasticsearch.Serverless.FieldValue value) { @@ -248,7 +268,12 @@ public TermQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.FieldValue ValueValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public TermQueryDescriptor Boost(float? boost) { @@ -257,7 +282,10 @@ public TermQueryDescriptor Boost(float? boost) } /// - /// Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.
When `false`, the case sensitivity of matching depends on the underlying field’s mapping. + /// + /// Allows ASCII case insensitive matching of the value with the indexed field values when set to true. + /// When false, the case sensitivity of matching depends on the underlying field’s mapping. + /// /// public TermQueryDescriptor CaseInsensitive(bool? caseInsensitive = true) { @@ -290,7 +318,9 @@ public TermQueryDescriptor QueryName(string? queryName) } /// - /// Term you wish to find in the provided field. + /// + /// Term you wish to find in the provided field. + /// /// public TermQueryDescriptor Value(Elastic.Clients.Elasticsearch.Serverless.FieldValue value) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TermRangeQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TermRangeQuery.g.cs index 67b701bb40a..c400307d398 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TermRangeQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TermRangeQuery.g.cs @@ -181,35 +181,50 @@ public TermRangeQuery(Elastic.Clients.Elasticsearch.Serverless.Field field) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } public string? From { get; set; } /// - /// Greater than. + /// + /// Greater than. + /// /// public string? Gt { get; set; } /// - /// Greater than or equal to. + /// + /// Greater than or equal to. + /// /// public string? Gte { get; set; } /// - /// Less than. + /// + /// Less than. + /// /// public string? Lt { get; set; } /// - /// Less than or equal to. + /// + /// Less than or equal to. + /// /// public string? Lte { get; set; } public string? QueryName { get; set; } /// - /// Indicates how the range query matches values for `range` fields. + /// + /// Indicates how the range query matches values for range fields. + /// /// public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RangeRelation? Relation { get; set; } public string? To { get; set; } @@ -235,7 +250,12 @@ public TermRangeQueryDescriptor() : base() private string? ToValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public TermRangeQueryDescriptor Boost(float? boost) { @@ -268,7 +288,9 @@ public TermRangeQueryDescriptor From(string? from) } /// - /// Greater than. + /// + /// Greater than. + /// /// public TermRangeQueryDescriptor Gt(string? gt) { @@ -277,7 +299,9 @@ public TermRangeQueryDescriptor Gt(string? gt) } /// - /// Greater than or equal to. + /// + /// Greater than or equal to. + /// /// public TermRangeQueryDescriptor Gte(string? gte) { @@ -286,7 +310,9 @@ public TermRangeQueryDescriptor Gte(string? gte) } /// - /// Less than. + /// + /// Less than. + /// /// public TermRangeQueryDescriptor Lt(string? lt) { @@ -295,7 +321,9 @@ public TermRangeQueryDescriptor Lt(string? lt) } /// - /// Less than or equal to. + /// + /// Less than or equal to. + /// /// public TermRangeQueryDescriptor Lte(string? lte) { @@ -310,7 +338,9 @@ public TermRangeQueryDescriptor QueryName(string? queryName) } /// - /// Indicates how the range query matches values for `range` fields. + /// + /// Indicates how the range query matches values for range fields. + /// /// public TermRangeQueryDescriptor Relation(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RangeRelation? relation) { @@ -410,7 +440,12 @@ public TermRangeQueryDescriptor() : base() private string? ToValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public TermRangeQueryDescriptor Boost(float? boost) { @@ -443,7 +478,9 @@ public TermRangeQueryDescriptor From(string? from) } /// - /// Greater than. + /// + /// Greater than. + /// /// public TermRangeQueryDescriptor Gt(string? gt) { @@ -452,7 +489,9 @@ public TermRangeQueryDescriptor Gt(string? gt) } /// - /// Greater than or equal to. + /// + /// Greater than or equal to. + /// /// public TermRangeQueryDescriptor Gte(string? gte) { @@ -461,7 +500,9 @@ public TermRangeQueryDescriptor Gte(string? gte) } /// - /// Less than. + /// + /// Less than. + /// /// public TermRangeQueryDescriptor Lt(string? lt) { @@ -470,7 +511,9 @@ public TermRangeQueryDescriptor Lt(string? lt) } /// - /// Less than or equal to. + /// + /// Less than or equal to. + /// /// public TermRangeQueryDescriptor Lte(string? lte) { @@ -485,7 +528,9 @@ public TermRangeQueryDescriptor QueryName(string? queryName) } /// - /// Indicates how the range query matches values for `range` fields. + /// + /// Indicates how the range query matches values for range fields. + /// /// public TermRangeQueryDescriptor Relation(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RangeRelation? relation) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TermsQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TermsQuery.g.cs index 1b28329b4e7..87ff99707cf 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TermsQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TermsQuery.g.cs @@ -95,7 +95,12 @@ public override void Write(Utf8JsonWriter writer, TermsQuery value, JsonSerializ public sealed partial class TermsQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } @@ -119,7 +124,12 @@ public TermsQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TermsQueryField TermValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public TermsQueryDescriptor Boost(float? boost) { @@ -197,7 +207,12 @@ public TermsQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TermsQueryField TermValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public TermsQueryDescriptor Boost(float? boost) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TermsSetQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TermsSetQuery.g.cs index 4671f6f7bbe..64d06eaff47 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TermsSetQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TermsSetQuery.g.cs @@ -129,24 +129,35 @@ public TermsSetQuery(Elastic.Clients.Elasticsearch.Serverless.Field field) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Numeric field containing the number of matching terms required to return a document. + /// + /// Numeric field containing the number of matching terms required to return a document. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Field? MinimumShouldMatchField { get; set; } /// - /// Custom script containing the number of matching terms required to return a document. + /// + /// Custom script containing the number of matching terms required to return a document. + /// /// public Elastic.Clients.Elasticsearch.Serverless.Script? MinimumShouldMatchScript { get; set; } public string? QueryName { get; set; } /// - /// Array of terms you wish to find in the provided field. + /// + /// Array of terms you wish to find in the provided field. + /// /// public ICollection Terms { get; set; } @@ -171,7 +182,12 @@ public TermsSetQueryDescriptor() : base() private ICollection TermsValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public TermsSetQueryDescriptor Boost(float? boost) { @@ -198,7 +214,9 @@ public TermsSetQueryDescriptor Field(Expression - /// Numeric field containing the number of matching terms required to return a document. + /// + /// Numeric field containing the number of matching terms required to return a document. + /// /// public TermsSetQueryDescriptor MinimumShouldMatchField(Elastic.Clients.Elasticsearch.Serverless.Field? minimumShouldMatchField) { @@ -207,7 +225,9 @@ public TermsSetQueryDescriptor MinimumShouldMatchField(Elastic.Client } /// - /// Numeric field containing the number of matching terms required to return a document. + /// + /// Numeric field containing the number of matching terms required to return a document. + /// /// public TermsSetQueryDescriptor MinimumShouldMatchField(Expression> minimumShouldMatchField) { @@ -216,7 +236,9 @@ public TermsSetQueryDescriptor MinimumShouldMatchField(Expres } /// - /// Numeric field containing the number of matching terms required to return a document. + /// + /// Numeric field containing the number of matching terms required to return a document. + /// /// public TermsSetQueryDescriptor MinimumShouldMatchField(Expression> minimumShouldMatchField) { @@ -225,7 +247,9 @@ public TermsSetQueryDescriptor MinimumShouldMatchField(Expression - /// Custom script containing the number of matching terms required to return a document. + /// + /// Custom script containing the number of matching terms required to return a document. + /// /// public TermsSetQueryDescriptor MinimumShouldMatchScript(Elastic.Clients.Elasticsearch.Serverless.Script? minimumShouldMatchScript) { @@ -258,7 +282,9 @@ public TermsSetQueryDescriptor QueryName(string? queryName) } /// - /// Array of terms you wish to find in the provided field. + /// + /// Array of terms you wish to find in the provided field. + /// /// public TermsSetQueryDescriptor Terms(ICollection terms) { @@ -332,7 +358,12 @@ public TermsSetQueryDescriptor() : base() private ICollection TermsValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public TermsSetQueryDescriptor Boost(float? boost) { @@ -359,7 +390,9 @@ public TermsSetQueryDescriptor Field(Expression - /// Numeric field containing the number of matching terms required to return a document. + /// + /// Numeric field containing the number of matching terms required to return a document. + /// /// public TermsSetQueryDescriptor MinimumShouldMatchField(Elastic.Clients.Elasticsearch.Serverless.Field? minimumShouldMatchField) { @@ -368,7 +401,9 @@ public TermsSetQueryDescriptor MinimumShouldMatchField(Elastic.Clients.Elasticse } /// - /// Numeric field containing the number of matching terms required to return a document. + /// + /// Numeric field containing the number of matching terms required to return a document. + /// /// public TermsSetQueryDescriptor MinimumShouldMatchField(Expression> minimumShouldMatchField) { @@ -377,7 +412,9 @@ public TermsSetQueryDescriptor MinimumShouldMatchField(Expres } /// - /// Numeric field containing the number of matching terms required to return a document. + /// + /// Numeric field containing the number of matching terms required to return a document. + /// /// public TermsSetQueryDescriptor MinimumShouldMatchField(Expression> minimumShouldMatchField) { @@ -386,7 +423,9 @@ public TermsSetQueryDescriptor MinimumShouldMatchField(Expression - /// Custom script containing the number of matching terms required to return a document. + /// + /// Custom script containing the number of matching terms required to return a document. + /// /// public TermsSetQueryDescriptor MinimumShouldMatchScript(Elastic.Clients.Elasticsearch.Serverless.Script? minimumShouldMatchScript) { @@ -419,7 +458,9 @@ public TermsSetQueryDescriptor QueryName(string? queryName) } /// - /// Array of terms you wish to find in the provided field. + /// + /// Array of terms you wish to find in the provided field. + /// /// public TermsSetQueryDescriptor Terms(ICollection terms) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TextExpansionQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TextExpansionQuery.g.cs index ecef6f11cd4..c81b812bd62 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TextExpansionQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TextExpansionQuery.g.cs @@ -113,18 +113,27 @@ public TextExpansionQuery(Elastic.Clients.Elasticsearch.Serverless.Field field) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// The text expansion NLP model to use + /// + /// The text expansion NLP model to use + /// /// public string ModelId { get; set; } /// - /// The query text + /// + /// The query text + /// /// public string ModelText { get; set; } public string? QueryName { get; set; } @@ -147,7 +156,12 @@ public TextExpansionQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public TextExpansionQueryDescriptor Boost(float? boost) { @@ -174,7 +188,9 @@ public TextExpansionQueryDescriptor Field(Expression - /// The text expansion NLP model to use + /// + /// The text expansion NLP model to use + /// /// public TextExpansionQueryDescriptor ModelId(string modelId) { @@ -183,7 +199,9 @@ public TextExpansionQueryDescriptor ModelId(string modelId) } /// - /// The query text + /// + /// The query text + /// /// public TextExpansionQueryDescriptor ModelText(string modelText) { @@ -240,7 +258,12 @@ public TextExpansionQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public TextExpansionQueryDescriptor Boost(float? boost) { @@ -267,7 +290,9 @@ public TextExpansionQueryDescriptor Field(Expression - /// The text expansion NLP model to use + /// + /// The text expansion NLP model to use + /// /// public TextExpansionQueryDescriptor ModelId(string modelId) { @@ -276,7 +301,9 @@ public TextExpansionQueryDescriptor ModelId(string modelId) } /// - /// The query text + /// + /// The query text + /// /// public TextExpansionQueryDescriptor ModelText(string modelText) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TokenPruningConfig.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TokenPruningConfig.g.cs index b9a84244ac3..d88690d7268 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TokenPruningConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TokenPruningConfig.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class TokenPruningConfig { /// - /// Whether to only score pruned tokens, vs only scoring kept tokens. + /// + /// Whether to only score pruned tokens, vs only scoring kept tokens. + /// /// [JsonInclude, JsonPropertyName("only_score_pruned_tokens")] public bool? OnlyScorePrunedTokens { get; set; } /// - /// Tokens whose frequency is more than this threshold times the average frequency of all tokens in the specified field are considered outliers and pruned. + /// + /// Tokens whose frequency is more than this threshold times the average frequency of all tokens in the specified field are considered outliers and pruned. + /// /// [JsonInclude, JsonPropertyName("tokens_freq_ratio_threshold")] public int? TokensFreqRatioThreshold { get; set; } /// - /// Tokens whose weight is less than this threshold are considered nonsignificant and pruned. + /// + /// Tokens whose weight is less than this threshold are considered nonsignificant and pruned. + /// /// [JsonInclude, JsonPropertyName("tokens_weight_threshold")] public float? TokensWeightThreshold { get; set; } @@ -61,7 +67,9 @@ public TokenPruningConfigDescriptor() : base() private float? TokensWeightThresholdValue { get; set; } /// - /// Whether to only score pruned tokens, vs only scoring kept tokens. + /// + /// Whether to only score pruned tokens, vs only scoring kept tokens. + /// /// public TokenPruningConfigDescriptor OnlyScorePrunedTokens(bool? onlyScorePrunedTokens = true) { @@ -70,7 +78,9 @@ public TokenPruningConfigDescriptor OnlyScorePrunedTokens(bool? onlyScorePrunedT } /// - /// Tokens whose frequency is more than this threshold times the average frequency of all tokens in the specified field are considered outliers and pruned. + /// + /// Tokens whose frequency is more than this threshold times the average frequency of all tokens in the specified field are considered outliers and pruned. + /// /// public TokenPruningConfigDescriptor TokensFreqRatioThreshold(int? tokensFreqRatioThreshold) { @@ -79,7 +89,9 @@ public TokenPruningConfigDescriptor TokensFreqRatioThreshold(int? tokensFreqRati } /// - /// Tokens whose weight is less than this threshold are considered nonsignificant and pruned. + /// + /// Tokens whose weight is less than this threshold are considered nonsignificant and pruned. + /// /// public TokenPruningConfigDescriptor TokensWeightThreshold(float? tokensWeightThreshold) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/UntypedDecayFunction.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/UntypedDecayFunction.g.cs index 658e7c9f3b6..443a3d82046 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/UntypedDecayFunction.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/UntypedDecayFunction.g.cs @@ -85,7 +85,9 @@ public sealed partial class UntypedDecayFunction public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// + /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// /// public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.MultiValueMode? MultiValueMode { get; set; } public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.DecayPlacement Placement { get; set; } @@ -122,7 +124,9 @@ public UntypedDecayFunctionDescriptor Field(Expression - /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// + /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// /// public UntypedDecayFunctionDescriptor MultiValueMode(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.MultiValueMode? multiValueMode) { @@ -187,7 +191,9 @@ public UntypedDecayFunctionDescriptor Field(Expression - /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// + /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// /// public UntypedDecayFunctionDescriptor MultiValueMode(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.MultiValueMode? multiValueMode) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/UntypedDistanceFeatureQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/UntypedDistanceFeatureQuery.g.cs index 879b523387b..3fd405c221e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/UntypedDistanceFeatureQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/UntypedDistanceFeatureQuery.g.cs @@ -30,25 +30,43 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class UntypedDistanceFeatureQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Date or point of origin used to calculate distances.
If the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.
Date Math, such as `now-1h`, is supported.
If the field value is a `geo_point` field, the `origin` value must be a geopoint. + /// + /// Date or point of origin used to calculate distances. + /// If the field value is a date or date_nanos field, the origin value must be a date. + /// Date Math, such as now-1h, is supported. + /// If the field value is a geo_point field, the origin value must be a geopoint. + /// /// [JsonInclude, JsonPropertyName("origin")] public object Origin { get; set; } /// - /// Distance from the `origin` at which relevance scores receive half of the `boost` value.
If the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`. + /// + /// Distance from the origin at which relevance scores receive half of the boost value. + /// If the field value is a date or date_nanos field, the pivot value must be a time unit, such as 1h or 10d. If the field value is a geo_point field, the pivot value must be a distance unit, such as 1km or 12m. + /// /// [JsonInclude, JsonPropertyName("pivot")] public object Pivot { get; set; } @@ -71,7 +89,12 @@ public UntypedDistanceFeatureQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public UntypedDistanceFeatureQueryDescriptor Boost(float? boost) { @@ -80,7 +103,12 @@ public UntypedDistanceFeatureQueryDescriptor Boost(float? boost) } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public UntypedDistanceFeatureQueryDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -89,7 +117,12 @@ public UntypedDistanceFeatureQueryDescriptor Field(Elastic.Clients.El } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public UntypedDistanceFeatureQueryDescriptor Field(Expression> field) { @@ -98,7 +131,12 @@ public UntypedDistanceFeatureQueryDescriptor Field(Expression } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public UntypedDistanceFeatureQueryDescriptor Field(Expression> field) { @@ -107,7 +145,12 @@ public UntypedDistanceFeatureQueryDescriptor Field(Expression - /// Date or point of origin used to calculate distances.
If the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.
Date Math, such as `now-1h`, is supported.
If the field value is a `geo_point` field, the `origin` value must be a geopoint. + /// + /// Date or point of origin used to calculate distances. + /// If the field value is a date or date_nanos field, the origin value must be a date. + /// Date Math, such as now-1h, is supported. + /// If the field value is a geo_point field, the origin value must be a geopoint. + /// /// public UntypedDistanceFeatureQueryDescriptor Origin(object origin) { @@ -116,7 +159,10 @@ public UntypedDistanceFeatureQueryDescriptor Origin(object origin) } /// - /// Distance from the `origin` at which relevance scores receive half of the `boost` value.
If the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`. + /// + /// Distance from the origin at which relevance scores receive half of the boost value. + /// If the field value is a date or date_nanos field, the pivot value must be a time unit, such as 1h or 10d. If the field value is a geo_point field, the pivot value must be a distance unit, such as 1km or 12m. + /// /// public UntypedDistanceFeatureQueryDescriptor Pivot(object pivot) { @@ -170,7 +216,12 @@ public UntypedDistanceFeatureQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public UntypedDistanceFeatureQueryDescriptor Boost(float? boost) { @@ -179,7 +230,12 @@ public UntypedDistanceFeatureQueryDescriptor Boost(float? boost) } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public UntypedDistanceFeatureQueryDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -188,7 +244,12 @@ public UntypedDistanceFeatureQueryDescriptor Field(Elastic.Clients.Elasticsearch } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public UntypedDistanceFeatureQueryDescriptor Field(Expression> field) { @@ -197,7 +258,12 @@ public UntypedDistanceFeatureQueryDescriptor Field(Expression } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public UntypedDistanceFeatureQueryDescriptor Field(Expression> field) { @@ -206,7 +272,12 @@ public UntypedDistanceFeatureQueryDescriptor Field(Expression - /// Date or point of origin used to calculate distances.
If the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.
Date Math, such as `now-1h`, is supported.
If the field value is a `geo_point` field, the `origin` value must be a geopoint. + /// + /// Date or point of origin used to calculate distances. + /// If the field value is a date or date_nanos field, the origin value must be a date. + /// Date Math, such as now-1h, is supported. + /// If the field value is a geo_point field, the origin value must be a geopoint. + /// /// public UntypedDistanceFeatureQueryDescriptor Origin(object origin) { @@ -215,7 +286,10 @@ public UntypedDistanceFeatureQueryDescriptor Origin(object origin) } /// - /// Distance from the `origin` at which relevance scores receive half of the `boost` value.
If the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`. + /// + /// Distance from the origin at which relevance scores receive half of the boost value. + /// If the field value is a date or date_nanos field, the pivot value must be a time unit, such as 1h or 10d. If the field value is a geo_point field, the pivot value must be a distance unit, such as 1km or 12m. + /// /// public UntypedDistanceFeatureQueryDescriptor Pivot(object pivot) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/UntypedRangeQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/UntypedRangeQuery.g.cs index 9db11aab60b..71c878320d6 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/UntypedRangeQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/UntypedRangeQuery.g.cs @@ -205,45 +205,64 @@ public UntypedRangeQuery(Elastic.Clients.Elasticsearch.Serverless.Field field) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Date format used to convert `date` values in the query. + /// + /// Date format used to convert date values in the query. + /// /// public string? Format { get; set; } public object? From { get; set; } /// - /// Greater than. + /// + /// Greater than. + /// /// public object? Gt { get; set; } /// - /// Greater than or equal to. + /// + /// Greater than or equal to. + /// /// public object? Gte { get; set; } /// - /// Less than. + /// + /// Less than. + /// /// public object? Lt { get; set; } /// - /// Less than or equal to. + /// + /// Less than or equal to. + /// /// public object? Lte { get; set; } public string? QueryName { get; set; } /// - /// Indicates how the range query matches values for `range` fields. + /// + /// Indicates how the range query matches values for range fields. + /// /// public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RangeRelation? Relation { get; set; } /// - /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC. + /// + /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query to UTC. + /// /// public string? TimeZone { get; set; } public object? To { get; set; } @@ -271,7 +290,12 @@ public UntypedRangeQueryDescriptor() : base() private object? ToValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public UntypedRangeQueryDescriptor Boost(float? boost) { @@ -298,7 +322,9 @@ public UntypedRangeQueryDescriptor Field(Expression - /// Date format used to convert `date` values in the query. + /// + /// Date format used to convert date values in the query. + /// /// public UntypedRangeQueryDescriptor Format(string? format) { @@ -313,7 +339,9 @@ public UntypedRangeQueryDescriptor From(object? from) } /// - /// Greater than. + /// + /// Greater than. + /// /// public UntypedRangeQueryDescriptor Gt(object? gt) { @@ -322,7 +350,9 @@ public UntypedRangeQueryDescriptor Gt(object? gt) } /// - /// Greater than or equal to. + /// + /// Greater than or equal to. + /// /// public UntypedRangeQueryDescriptor Gte(object? gte) { @@ -331,7 +361,9 @@ public UntypedRangeQueryDescriptor Gte(object? gte) } /// - /// Less than. + /// + /// Less than. + /// /// public UntypedRangeQueryDescriptor Lt(object? lt) { @@ -340,7 +372,9 @@ public UntypedRangeQueryDescriptor Lt(object? lt) } /// - /// Less than or equal to. + /// + /// Less than or equal to. + /// /// public UntypedRangeQueryDescriptor Lte(object? lte) { @@ -355,7 +389,9 @@ public UntypedRangeQueryDescriptor QueryName(string? queryName) } /// - /// Indicates how the range query matches values for `range` fields. + /// + /// Indicates how the range query matches values for range fields. + /// /// public UntypedRangeQueryDescriptor Relation(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RangeRelation? relation) { @@ -364,7 +400,9 @@ public UntypedRangeQueryDescriptor Relation(Elastic.Clients.Elasticse } /// - /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC. + /// + /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query to UTC. + /// /// public UntypedRangeQueryDescriptor TimeZone(string? timeZone) { @@ -478,7 +516,12 @@ public UntypedRangeQueryDescriptor() : base() private object? ToValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public UntypedRangeQueryDescriptor Boost(float? boost) { @@ -505,7 +548,9 @@ public UntypedRangeQueryDescriptor Field(Expression - /// Date format used to convert `date` values in the query. + /// + /// Date format used to convert date values in the query. + /// /// public UntypedRangeQueryDescriptor Format(string? format) { @@ -520,7 +565,9 @@ public UntypedRangeQueryDescriptor From(object? from) } /// - /// Greater than. + /// + /// Greater than. + /// /// public UntypedRangeQueryDescriptor Gt(object? gt) { @@ -529,7 +576,9 @@ public UntypedRangeQueryDescriptor Gt(object? gt) } /// - /// Greater than or equal to. + /// + /// Greater than or equal to. + /// /// public UntypedRangeQueryDescriptor Gte(object? gte) { @@ -538,7 +587,9 @@ public UntypedRangeQueryDescriptor Gte(object? gte) } /// - /// Less than. + /// + /// Less than. + /// /// public UntypedRangeQueryDescriptor Lt(object? lt) { @@ -547,7 +598,9 @@ public UntypedRangeQueryDescriptor Lt(object? lt) } /// - /// Less than or equal to. + /// + /// Less than or equal to. + /// /// public UntypedRangeQueryDescriptor Lte(object? lte) { @@ -562,7 +615,9 @@ public UntypedRangeQueryDescriptor QueryName(string? queryName) } /// - /// Indicates how the range query matches values for `range` fields. + /// + /// Indicates how the range query matches values for range fields. + /// /// public UntypedRangeQueryDescriptor Relation(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RangeRelation? relation) { @@ -571,7 +626,9 @@ public UntypedRangeQueryDescriptor Relation(Elastic.Clients.Elasticsearch.Server } /// - /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC. + /// + /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query to UTC. + /// /// public UntypedRangeQueryDescriptor TimeZone(string? timeZone) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/WeightedTokensQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/WeightedTokensQuery.g.cs index 4d62b66c785..7a6599a9d21 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/WeightedTokensQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/WeightedTokensQuery.g.cs @@ -117,19 +117,28 @@ public WeightedTokensQuery(Elastic.Clients.Elasticsearch.Serverless.Field field) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Token pruning configurations + /// + /// Token pruning configurations + /// /// public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TokenPruningConfig? PruningConfig { get; set; } public string? QueryName { get; set; } /// - /// The tokens representing this query + /// + /// The tokens representing this query + /// /// public IDictionary Tokens { get; set; } @@ -153,7 +162,12 @@ public WeightedTokensQueryDescriptor() : base() private IDictionary TokensValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public WeightedTokensQueryDescriptor Boost(float? boost) { @@ -180,7 +194,9 @@ public WeightedTokensQueryDescriptor Field(Expression - /// Token pruning configurations + /// + /// Token pruning configurations + /// /// public WeightedTokensQueryDescriptor PruningConfig(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TokenPruningConfig? pruningConfig) { @@ -213,7 +229,9 @@ public WeightedTokensQueryDescriptor QueryName(string? queryName) } /// - /// The tokens representing this query + /// + /// The tokens representing this query + /// /// public WeightedTokensQueryDescriptor Tokens(Func, FluentDictionary> selector) { @@ -280,7 +298,12 @@ public WeightedTokensQueryDescriptor() : base() private IDictionary TokensValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public WeightedTokensQueryDescriptor Boost(float? boost) { @@ -307,7 +330,9 @@ public WeightedTokensQueryDescriptor Field(Expression - /// Token pruning configurations + /// + /// Token pruning configurations + /// /// public WeightedTokensQueryDescriptor PruningConfig(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TokenPruningConfig? pruningConfig) { @@ -340,7 +365,9 @@ public WeightedTokensQueryDescriptor QueryName(string? queryName) } /// - /// The tokens representing this query + /// + /// The tokens representing this query + /// /// public WeightedTokensQueryDescriptor Tokens(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/WildcardQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/WildcardQuery.g.cs index af13fd89780..33955b0736d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/WildcardQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/WildcardQuery.g.cs @@ -145,29 +145,42 @@ public WildcardQuery(Elastic.Clients.Elasticsearch.Serverless.Field field) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } /// - /// Allows case insensitive matching of the pattern with the indexed field values when set to true. Default is false which means the case sensitivity of matching depends on the underlying field’s mapping. + /// + /// Allows case insensitive matching of the pattern with the indexed field values when set to true. Default is false which means the case sensitivity of matching depends on the underlying field’s mapping. + /// /// public bool? CaseInsensitive { get; set; } public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } public string? QueryName { get; set; } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public string? Rewrite { get; set; } /// - /// Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set. + /// + /// Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set. + /// /// public string? Value { get; set; } /// - /// Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set. + /// + /// Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set. + /// /// public string? Wildcard { get; set; } @@ -191,7 +204,12 @@ public WildcardQueryDescriptor() : base() private string? WildcardValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public WildcardQueryDescriptor Boost(float? boost) { @@ -200,7 +218,9 @@ public WildcardQueryDescriptor Boost(float? boost) } /// - /// Allows case insensitive matching of the pattern with the indexed field values when set to true. Default is false which means the case sensitivity of matching depends on the underlying field’s mapping. + /// + /// Allows case insensitive matching of the pattern with the indexed field values when set to true. Default is false which means the case sensitivity of matching depends on the underlying field’s mapping. + /// /// public WildcardQueryDescriptor CaseInsensitive(bool? caseInsensitive = true) { @@ -233,7 +253,9 @@ public WildcardQueryDescriptor QueryName(string? queryName) } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public WildcardQueryDescriptor Rewrite(string? rewrite) { @@ -242,7 +264,9 @@ public WildcardQueryDescriptor Rewrite(string? rewrite) } /// - /// Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set. + /// + /// Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set. + /// /// public WildcardQueryDescriptor Value(string? value) { @@ -251,7 +275,9 @@ public WildcardQueryDescriptor Value(string? value) } /// - /// Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set. + /// + /// Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set. + /// /// public WildcardQueryDescriptor Wildcard(string? wildcard) { @@ -324,7 +350,12 @@ public WildcardQueryDescriptor() : base() private string? WildcardValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public WildcardQueryDescriptor Boost(float? boost) { @@ -333,7 +364,9 @@ public WildcardQueryDescriptor Boost(float? boost) } /// - /// Allows case insensitive matching of the pattern with the indexed field values when set to true. Default is false which means the case sensitivity of matching depends on the underlying field’s mapping. + /// + /// Allows case insensitive matching of the pattern with the indexed field values when set to true. Default is false which means the case sensitivity of matching depends on the underlying field’s mapping. + /// /// public WildcardQueryDescriptor CaseInsensitive(bool? caseInsensitive = true) { @@ -366,7 +399,9 @@ public WildcardQueryDescriptor QueryName(string? queryName) } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public WildcardQueryDescriptor Rewrite(string? rewrite) { @@ -375,7 +410,9 @@ public WildcardQueryDescriptor Rewrite(string? rewrite) } /// - /// Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set. + /// + /// Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set. + /// /// public WildcardQueryDescriptor Value(string? value) { @@ -384,7 +421,9 @@ public WildcardQueryDescriptor Value(string? value) } /// - /// Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set. + /// + /// Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set. + /// /// public WildcardQueryDescriptor Wildcard(string? wildcard) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/WrapperQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/WrapperQuery.g.cs index d6a38662a71..c50c064a3b9 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/WrapperQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/WrapperQuery.g.cs @@ -30,13 +30,21 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; public sealed partial class WrapperQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// A base64 encoded query.
The binary data format can be any of JSON, YAML, CBOR or SMILE encodings + /// + /// A base64 encoded query. + /// The binary data format can be any of JSON, YAML, CBOR or SMILE encodings + /// /// [JsonInclude, JsonPropertyName("query")] public string Query { get; set; } @@ -59,7 +67,12 @@ public WrapperQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public WrapperQueryDescriptor Boost(float? boost) { @@ -68,7 +81,10 @@ public WrapperQueryDescriptor Boost(float? boost) } /// - /// A base64 encoded query.
The binary data format can be any of JSON, YAML, CBOR or SMILE encodings + /// + /// A base64 encoded query. + /// The binary data format can be any of JSON, YAML, CBOR or SMILE encodings + /// /// public WrapperQueryDescriptor Query(string query) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryRules/QueryRulesetListItem.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryRules/QueryRulesetListItem.g.cs index ce2d09b44ed..5c37963523b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryRules/QueryRulesetListItem.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryRules/QueryRulesetListItem.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryRules; public sealed partial class QueryRulesetListItem { /// - /// A map of criteria type to the number of rules of that type + /// + /// A map of criteria type to the number of rules of that type + /// /// [JsonInclude, JsonPropertyName("rule_criteria_types_counts")] public IReadOnlyDictionary RuleCriteriaTypesCounts { get; init; } /// - /// Ruleset unique identifier + /// + /// Ruleset unique identifier + /// /// [JsonInclude, JsonPropertyName("ruleset_id")] public string RulesetId { get; init; } /// - /// The number of rules associated with this ruleset + /// + /// The number of rules associated with this ruleset + /// /// [JsonInclude, JsonPropertyName("rule_total_count")] public int RuleTotalCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/RRFRetriever.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/RRFRetriever.g.cs index 769fe10fa08..574be5754ea 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/RRFRetriever.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/RRFRetriever.g.cs @@ -30,26 +30,34 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class RRFRetriever { /// - /// Query to filter the documents that can match. + /// + /// Query to filter the documents that can match. + /// /// [JsonInclude, JsonPropertyName("filter")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query))] public ICollection? Filter { get; set; } /// - /// This value determines how much influence documents in individual result sets per query have over the final ranked result set. + /// + /// This value determines how much influence documents in individual result sets per query have over the final ranked result set. + /// /// [JsonInclude, JsonPropertyName("rank_constant")] public int? RankConstant { get; set; } /// - /// This value determines the size of the individual result sets per query. + /// + /// This value determines the size of the individual result sets per query. + /// /// [JsonInclude, JsonPropertyName("rank_window_size")] public int? RankWindowSize { get; set; } /// - /// A list of child retrievers to specify which sets of returned top documents will have the RRF formula applied to them. + /// + /// A list of child retrievers to specify which sets of returned top documents will have the RRF formula applied to them. + /// /// [JsonInclude, JsonPropertyName("retrievers")] public ICollection Retrievers { get; set; } @@ -77,7 +85,9 @@ public RRFRetrieverDescriptor() : base() private Action>[] RetrieversDescriptorActions { get; set; } /// - /// Query to filter the documents that can match. + /// + /// Query to filter the documents that can match. + /// /// public RRFRetrieverDescriptor Filter(ICollection? filter) { @@ -116,7 +126,9 @@ public RRFRetrieverDescriptor Filter(params Action - /// This value determines how much influence documents in individual result sets per query have over the final ranked result set. + /// + /// This value determines how much influence documents in individual result sets per query have over the final ranked result set. + /// /// public RRFRetrieverDescriptor RankConstant(int? rankConstant) { @@ -125,7 +137,9 @@ public RRFRetrieverDescriptor RankConstant(int? rankConstant) } /// - /// This value determines the size of the individual result sets per query. + /// + /// This value determines the size of the individual result sets per query. + /// /// public RRFRetrieverDescriptor RankWindowSize(int? rankWindowSize) { @@ -134,7 +148,9 @@ public RRFRetrieverDescriptor RankWindowSize(int? rankWindowSize) } /// - /// A list of child retrievers to specify which sets of returned top documents will have the RRF formula applied to them. + /// + /// A list of child retrievers to specify which sets of returned top documents will have the RRF formula applied to them. + /// /// public RRFRetrieverDescriptor Retrievers(ICollection retrievers) { @@ -271,7 +287,9 @@ public RRFRetrieverDescriptor() : base() private Action[] RetrieversDescriptorActions { get; set; } /// - /// Query to filter the documents that can match. + /// + /// Query to filter the documents that can match. + /// /// public RRFRetrieverDescriptor Filter(ICollection? filter) { @@ -310,7 +328,9 @@ public RRFRetrieverDescriptor Filter(params Action - /// This value determines how much influence documents in individual result sets per query have over the final ranked result set. + /// + /// This value determines how much influence documents in individual result sets per query have over the final ranked result set. + /// /// public RRFRetrieverDescriptor RankConstant(int? rankConstant) { @@ -319,7 +339,9 @@ public RRFRetrieverDescriptor RankConstant(int? rankConstant) } /// - /// This value determines the size of the individual result sets per query. + /// + /// This value determines the size of the individual result sets per query. + /// /// public RRFRetrieverDescriptor RankWindowSize(int? rankWindowSize) { @@ -328,7 +350,9 @@ public RRFRetrieverDescriptor RankWindowSize(int? rankWindowSize) } /// - /// A list of child retrievers to specify which sets of returned top documents will have the RRF formula applied to them. + /// + /// A list of child retrievers to specify which sets of returned top documents will have the RRF formula applied to them. + /// /// public RRFRetrieverDescriptor Retrievers(ICollection retrievers) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/RrfRank.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/RrfRank.g.cs index e1d53d7a1a2..63c54e86444 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/RrfRank.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/RrfRank.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class RrfRank { /// - /// How much influence documents in individual result sets per query have over the final ranked result set + /// + /// How much influence documents in individual result sets per query have over the final ranked result set + /// /// [JsonInclude, JsonPropertyName("rank_constant")] public long? RankConstant { get; set; } /// - /// Size of the individual result sets per query + /// + /// Size of the individual result sets per query + /// /// [JsonInclude, JsonPropertyName("rank_window_size")] public long? RankWindowSize { get; set; } @@ -56,7 +60,9 @@ public RrfRankDescriptor() : base() private long? RankWindowSizeValue { get; set; } /// - /// How much influence documents in individual result sets per query have over the final ranked result set + /// + /// How much influence documents in individual result sets per query have over the final ranked result set + /// /// public RrfRankDescriptor RankConstant(long? rankConstant) { @@ -65,7 +71,9 @@ public RrfRankDescriptor RankConstant(long? rankConstant) } /// - /// Size of the individual result sets per query + /// + /// Size of the individual result sets per query + /// /// public RrfRankDescriptor RankWindowSize(long? rankWindowSize) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Script.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Script.g.cs index b380ed67fbd..a3b666f40e3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Script.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Script.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class Script { /// - /// The `id` for a stored script. + /// + /// The id for a stored script. + /// /// [JsonInclude, JsonPropertyName("id")] public Elastic.Clients.Elasticsearch.Serverless.Id? Id { get; set; } /// - /// Specifies the language the script is written in. + /// + /// Specifies the language the script is written in. + /// /// [JsonInclude, JsonPropertyName("lang")] public Elastic.Clients.Elasticsearch.Serverless.ScriptLanguage? Lang { get; set; } @@ -44,13 +48,18 @@ public sealed partial class Script public IDictionary? Options { get; set; } /// - /// Specifies any named parameters that are passed into the script as variables.
Use parameters instead of hard-coded values to decrease compile time. + /// + /// Specifies any named parameters that are passed into the script as variables. + /// Use parameters instead of hard-coded values to decrease compile time. + /// /// [JsonInclude, JsonPropertyName("params")] public IDictionary? Params { get; set; } /// - /// The script source. + /// + /// The script source. + /// /// [JsonInclude, JsonPropertyName("source")] public string? Source { get; set; } @@ -73,7 +82,9 @@ public ScriptDescriptor() : base() private string? SourceValue { get; set; } /// - /// The `id` for a stored script. + /// + /// The id for a stored script. + /// /// public ScriptDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id? id) { @@ -82,7 +93,9 @@ public ScriptDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id? id) } /// - /// Specifies the language the script is written in. + /// + /// Specifies the language the script is written in. + /// /// public ScriptDescriptor Lang(Elastic.Clients.Elasticsearch.Serverless.ScriptLanguage? lang) { @@ -97,7 +110,10 @@ public ScriptDescriptor Options(Func, FluentDic } /// - /// Specifies any named parameters that are passed into the script as variables.
Use parameters instead of hard-coded values to decrease compile time. + /// + /// Specifies any named parameters that are passed into the script as variables. + /// Use parameters instead of hard-coded values to decrease compile time. + /// /// public ScriptDescriptor Params(Func, FluentDictionary> selector) { @@ -106,7 +122,9 @@ public ScriptDescriptor Params(Func, FluentDict } /// - /// The script source. + /// + /// The script source. + /// /// public ScriptDescriptor Source(string? source) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/SegmentsStats.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/SegmentsStats.g.cs index 90371ca1a90..0d80a084f21 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/SegmentsStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/SegmentsStats.g.cs @@ -30,37 +30,51 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class SegmentsStats { /// - /// Total number of segments across all shards assigned to selected nodes. + /// + /// Total number of segments across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("count")] public int Count { get; init; } /// - /// Total amount of memory used for doc values across all shards assigned to selected nodes. + /// + /// Total amount of memory used for doc values across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("doc_values_memory")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? DocValuesMemory { get; init; } /// - /// Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes. + /// + /// Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("doc_values_memory_in_bytes")] public long DocValuesMemoryInBytes { get; init; } /// - /// This object is not populated by the cluster stats API.
To get information on segment files, use the node stats API. + /// + /// This object is not populated by the cluster stats API. + /// To get information on segment files, use the node stats API. + /// /// [JsonInclude, JsonPropertyName("file_sizes")] public IReadOnlyDictionary FileSizes { get; init; } /// - /// Total amount of memory used by fixed bit sets across all shards assigned to selected nodes.
Fixed bit sets are used for nested object field types and type filters for join fields. + /// + /// Total amount of memory used by fixed bit sets across all shards assigned to selected nodes. + /// Fixed bit sets are used for nested object field types and type filters for join fields. + /// /// [JsonInclude, JsonPropertyName("fixed_bit_set")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? FixedBitSet { get; init; } /// - /// Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes. + /// + /// Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("fixed_bit_set_memory_in_bytes")] public long FixedBitSetMemoryInBytes { get; init; } @@ -68,61 +82,81 @@ public sealed partial class SegmentsStats public long? IndexWriterMaxMemoryInBytes { get; init; } /// - /// Total amount of memory used by all index writers across all shards assigned to selected nodes. + /// + /// Total amount of memory used by all index writers across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("index_writer_memory")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? IndexWriterMemory { get; init; } /// - /// Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes. + /// + /// Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("index_writer_memory_in_bytes")] public long IndexWriterMemoryInBytes { get; init; } /// - /// Unix timestamp, in milliseconds, of the most recently retried indexing request. + /// + /// Unix timestamp, in milliseconds, of the most recently retried indexing request. + /// /// [JsonInclude, JsonPropertyName("max_unsafe_auto_id_timestamp")] public long MaxUnsafeAutoIdTimestamp { get; init; } /// - /// Total amount of memory used for segments across all shards assigned to selected nodes. + /// + /// Total amount of memory used for segments across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("memory")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? Memory { get; init; } /// - /// Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes. + /// + /// Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("memory_in_bytes")] public long MemoryInBytes { get; init; } /// - /// Total amount of memory used for normalization factors across all shards assigned to selected nodes. + /// + /// Total amount of memory used for normalization factors across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("norms_memory")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? NormsMemory { get; init; } /// - /// Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes. + /// + /// Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("norms_memory_in_bytes")] public long NormsMemoryInBytes { get; init; } /// - /// Total amount of memory used for points across all shards assigned to selected nodes. + /// + /// Total amount of memory used for points across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("points_memory")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? PointsMemory { get; init; } /// - /// Total amount, in bytes, of memory used for points across all shards assigned to selected nodes. + /// + /// Total amount, in bytes, of memory used for points across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("points_memory_in_bytes")] public long PointsMemoryInBytes { get; init; } /// - /// Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes. + /// + /// Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("stored_fields_memory_in_bytes")] public long StoredFieldsMemoryInBytes { get; init; } @@ -130,37 +164,49 @@ public sealed partial class SegmentsStats public Elastic.Clients.Elasticsearch.Serverless.ByteSize? StoredMemory { get; init; } /// - /// Total amount of memory used for terms across all shards assigned to selected nodes. + /// + /// Total amount of memory used for terms across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("terms_memory")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? TermsMemory { get; init; } /// - /// Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes. + /// + /// Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("terms_memory_in_bytes")] public long TermsMemoryInBytes { get; init; } /// - /// Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes. + /// + /// Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("term_vectors_memory_in_bytes")] public long TermVectorsMemoryInBytes { get; init; } /// - /// Total amount of memory used for term vectors across all shards assigned to selected nodes. + /// + /// Total amount of memory used for term vectors across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("term_vectory_memory")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? TermVectoryMemory { get; init; } /// - /// Total amount of memory used by all version maps across all shards assigned to selected nodes. + /// + /// Total amount of memory used by all version maps across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("version_map_memory")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? VersionMapMemory { get; init; } /// - /// Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes. + /// + /// Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("version_map_memory_in_bytes")] public long VersionMapMemoryInBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/ShardStatistics.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/ShardStatistics.g.cs index 79cf3f79949..0957c62fef5 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/ShardStatistics.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/ShardStatistics.g.cs @@ -37,13 +37,17 @@ public sealed partial class ShardStatistics public int? Skipped { get; init; } /// - /// Indicates how many shards have successfully run the search. + /// + /// Indicates how many shards have successfully run the search. + /// /// [JsonInclude, JsonPropertyName("successful")] public int Successful { get; init; } /// - /// Indicates how many shards the search will run on overall. + /// + /// Indicates how many shards the search will run on overall. + /// /// [JsonInclude, JsonPropertyName("total")] public int Total { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Slices.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Slices.g.cs index 66c9cdb0e49..8742faa50ce 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Slices.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Slices.g.cs @@ -31,7 +31,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless; /// -/// Slices configuration used to parallelize a process. +/// +/// Slices configuration used to parallelize a process. +/// /// public sealed partial class Slices : Union { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Snapshot/CleanupRepositoryResults.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Snapshot/CleanupRepositoryResults.g.cs index ef47ed457bd..630ebffe578 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Snapshot/CleanupRepositoryResults.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Snapshot/CleanupRepositoryResults.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Snapshot; public sealed partial class CleanupRepositoryResults { /// - /// Number of binary large objects (blobs) removed during cleanup. + /// + /// Number of binary large objects (blobs) removed during cleanup. + /// /// [JsonInclude, JsonPropertyName("deleted_blobs")] public long DeletedBlobs { get; init; } /// - /// Number of bytes freed by cleanup operations. + /// + /// Number of bytes freed by cleanup operations. + /// /// [JsonInclude, JsonPropertyName("deleted_bytes")] public long DeletedBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/SnapshotLifecycleManagement/Retention.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/SnapshotLifecycleManagement/Retention.g.cs index 2f4108cc56b..7a871d8ba13 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/SnapshotLifecycleManagement/Retention.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/SnapshotLifecycleManagement/Retention.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Serverless.SnapshotLifecycleManagement; public sealed partial class Retention { /// - /// Time period after which a snapshot is considered expired and eligible for deletion. SLM deletes expired snapshots based on the slm.retention_schedule. + /// + /// Time period after which a snapshot is considered expired and eligible for deletion. SLM deletes expired snapshots based on the slm.retention_schedule. + /// /// [JsonInclude, JsonPropertyName("expire_after")] public Elastic.Clients.Elasticsearch.Serverless.Duration ExpireAfter { get; set; } /// - /// Maximum number of snapshots to retain, even if the snapshots have not yet expired. If the number of snapshots in the repository exceeds this limit, the policy retains the most recent snapshots and deletes older snapshots. + /// + /// Maximum number of snapshots to retain, even if the snapshots have not yet expired. If the number of snapshots in the repository exceeds this limit, the policy retains the most recent snapshots and deletes older snapshots. + /// /// [JsonInclude, JsonPropertyName("max_count")] public int MaxCount { get; set; } /// - /// Minimum number of snapshots to retain, even if the snapshots have expired. + /// + /// Minimum number of snapshots to retain, even if the snapshots have expired. + /// /// [JsonInclude, JsonPropertyName("min_count")] public int MinCount { get; set; } @@ -61,7 +67,9 @@ public RetentionDescriptor() : base() private int MinCountValue { get; set; } /// - /// Time period after which a snapshot is considered expired and eligible for deletion. SLM deletes expired snapshots based on the slm.retention_schedule. + /// + /// Time period after which a snapshot is considered expired and eligible for deletion. SLM deletes expired snapshots based on the slm.retention_schedule. + /// /// public RetentionDescriptor ExpireAfter(Elastic.Clients.Elasticsearch.Serverless.Duration expireAfter) { @@ -70,7 +78,9 @@ public RetentionDescriptor ExpireAfter(Elastic.Clients.Elasticsearch.Serverless. } /// - /// Maximum number of snapshots to retain, even if the snapshots have not yet expired. If the number of snapshots in the repository exceeds this limit, the policy retains the most recent snapshots and deletes older snapshots. + /// + /// Maximum number of snapshots to retain, even if the snapshots have not yet expired. If the number of snapshots in the repository exceeds this limit, the policy retains the most recent snapshots and deletes older snapshots. + /// /// public RetentionDescriptor MaxCount(int maxCount) { @@ -79,7 +89,9 @@ public RetentionDescriptor MaxCount(int maxCount) } /// - /// Minimum number of snapshots to retain, even if the snapshots have expired. + /// + /// Minimum number of snapshots to retain, even if the snapshots have expired. + /// /// public RetentionDescriptor MinCount(int minCount) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/SnapshotLifecycleManagement/SlmConfiguration.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/SnapshotLifecycleManagement/SlmConfiguration.g.cs index a566a055e3e..2644e660bfc 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/SnapshotLifecycleManagement/SlmConfiguration.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/SnapshotLifecycleManagement/SlmConfiguration.g.cs @@ -30,37 +30,51 @@ namespace Elastic.Clients.Elasticsearch.Serverless.SnapshotLifecycleManagement; public sealed partial class SlmConfiguration { /// - /// A list of feature states to be included in this snapshot. A list of features available for inclusion in the snapshot and their descriptions be can be retrieved using the get features API.
Each feature state includes one or more system indices containing data necessary for the function of that feature. Providing an empty array will include no feature states in the snapshot, regardless of the value of include_global_state. By default, all available feature states will be included in the snapshot if include_global_state is true, or no feature states if include_global_state is false. + /// + /// A list of feature states to be included in this snapshot. A list of features available for inclusion in the snapshot and their descriptions be can be retrieved using the get features API. + /// Each feature state includes one or more system indices containing data necessary for the function of that feature. Providing an empty array will include no feature states in the snapshot, regardless of the value of include_global_state. By default, all available feature states will be included in the snapshot if include_global_state is true, or no feature states if include_global_state is false. + /// /// [JsonInclude, JsonPropertyName("feature_states")] public ICollection? FeatureStates { get; set; } /// - /// If false, the snapshot fails if any data stream or index in indices is missing or closed. If true, the snapshot ignores missing or closed data streams and indices. + /// + /// If false, the snapshot fails if any data stream or index in indices is missing or closed. If true, the snapshot ignores missing or closed data streams and indices. + /// /// [JsonInclude, JsonPropertyName("ignore_unavailable")] public bool? IgnoreUnavailable { get; set; } /// - /// If true, the current global state is included in the snapshot. + /// + /// If true, the current global state is included in the snapshot. + /// /// [JsonInclude, JsonPropertyName("include_global_state")] public bool? IncludeGlobalState { get; set; } /// - /// A comma-separated list of data streams and indices to include in the snapshot. Multi-index syntax is supported.
By default, a snapshot includes all data streams and indices in the cluster. If this argument is provided, the snapshot only includes the specified data streams and clusters. + /// + /// A comma-separated list of data streams and indices to include in the snapshot. Multi-index syntax is supported. + /// By default, a snapshot includes all data streams and indices in the cluster. If this argument is provided, the snapshot only includes the specified data streams and clusters. + /// /// [JsonInclude, JsonPropertyName("indices")] public Elastic.Clients.Elasticsearch.Serverless.Indices? Indices { get; set; } /// - /// Attaches arbitrary metadata to the snapshot, such as a record of who took the snapshot, why it was taken, or any other useful data. Metadata must be less than 1024 bytes. + /// + /// Attaches arbitrary metadata to the snapshot, such as a record of who took the snapshot, why it was taken, or any other useful data. Metadata must be less than 1024 bytes. + /// /// [JsonInclude, JsonPropertyName("metadata")] public IDictionary? Metadata { get; set; } /// - /// If false, the entire snapshot will fail if one or more indices included in the snapshot do not have all primary shards available. + /// + /// If false, the entire snapshot will fail if one or more indices included in the snapshot do not have all primary shards available. + /// /// [JsonInclude, JsonPropertyName("partial")] public bool? Partial { get; set; } @@ -82,7 +96,10 @@ public SlmConfigurationDescriptor() : base() private bool? PartialValue { get; set; } /// - /// A list of feature states to be included in this snapshot. A list of features available for inclusion in the snapshot and their descriptions be can be retrieved using the get features API.
Each feature state includes one or more system indices containing data necessary for the function of that feature. Providing an empty array will include no feature states in the snapshot, regardless of the value of include_global_state. By default, all available feature states will be included in the snapshot if include_global_state is true, or no feature states if include_global_state is false. + /// + /// A list of feature states to be included in this snapshot. A list of features available for inclusion in the snapshot and their descriptions be can be retrieved using the get features API. + /// Each feature state includes one or more system indices containing data necessary for the function of that feature. Providing an empty array will include no feature states in the snapshot, regardless of the value of include_global_state. By default, all available feature states will be included in the snapshot if include_global_state is true, or no feature states if include_global_state is false. + /// /// public SlmConfigurationDescriptor FeatureStates(ICollection? featureStates) { @@ -91,7 +108,9 @@ public SlmConfigurationDescriptor FeatureStates(ICollection? featureStat } /// - /// If false, the snapshot fails if any data stream or index in indices is missing or closed. If true, the snapshot ignores missing or closed data streams and indices. + /// + /// If false, the snapshot fails if any data stream or index in indices is missing or closed. If true, the snapshot ignores missing or closed data streams and indices. + /// /// public SlmConfigurationDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) { @@ -100,7 +119,9 @@ public SlmConfigurationDescriptor IgnoreUnavailable(bool? ignoreUnavailable = tr } /// - /// If true, the current global state is included in the snapshot. + /// + /// If true, the current global state is included in the snapshot. + /// /// public SlmConfigurationDescriptor IncludeGlobalState(bool? includeGlobalState = true) { @@ -109,7 +130,10 @@ public SlmConfigurationDescriptor IncludeGlobalState(bool? includeGlobalState = } /// - /// A comma-separated list of data streams and indices to include in the snapshot. Multi-index syntax is supported.
By default, a snapshot includes all data streams and indices in the cluster. If this argument is provided, the snapshot only includes the specified data streams and clusters. + /// + /// A comma-separated list of data streams and indices to include in the snapshot. Multi-index syntax is supported. + /// By default, a snapshot includes all data streams and indices in the cluster. If this argument is provided, the snapshot only includes the specified data streams and clusters. + /// /// public SlmConfigurationDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.Indices? indices) { @@ -118,7 +142,9 @@ public SlmConfigurationDescriptor Indices(Elastic.Clients.Elasticsearch.Serverle } /// - /// Attaches arbitrary metadata to the snapshot, such as a record of who took the snapshot, why it was taken, or any other useful data. Metadata must be less than 1024 bytes. + /// + /// Attaches arbitrary metadata to the snapshot, such as a record of who took the snapshot, why it was taken, or any other useful data. Metadata must be less than 1024 bytes. + /// /// public SlmConfigurationDescriptor Metadata(Func, FluentDictionary> selector) { @@ -127,7 +153,9 @@ public SlmConfigurationDescriptor Metadata(Func } /// - /// If false, the entire snapshot will fail if one or more indices included in the snapshot do not have all primary shards available. + /// + /// If false, the entire snapshot will fail if one or more indices included in the snapshot do not have all primary shards available. + /// /// public SlmConfigurationDescriptor Partial(bool? partial = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/SpecUtils/OverloadOf.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/SpecUtils/OverloadOf.g.cs index 3ee612330b6..42c76c698cf 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/SpecUtils/OverloadOf.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/SpecUtils/OverloadOf.g.cs @@ -28,7 +28,11 @@ namespace Elastic.Clients.Elasticsearch.Serverless.SpecUtils; /// -/// A class that implements `OverloadOf` should have the exact same properties with the same types.
It can change if a property is required or not. There is no need to port the descriptions
and js doc tags, the compiler will do that for you. +/// +/// A class that implements OverloadOf should have the exact same properties with the same types. +/// It can change if a property is required or not. There is no need to port the descriptions +/// and js doc tags, the compiler will do that for you. +/// /// public sealed partial class OverloadOf { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/StandardRetriever.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/StandardRetriever.g.cs index b610f3d4b2f..82e67fa2a28 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/StandardRetriever.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/StandardRetriever.g.cs @@ -30,45 +30,59 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class StandardRetriever { /// - /// Collapses the top documents by a specified key into a single top document per key. + /// + /// Collapses the top documents by a specified key into a single top document per key. + /// /// [JsonInclude, JsonPropertyName("collapse")] public Elastic.Clients.Elasticsearch.Serverless.Core.Search.FieldCollapse? Collapse { get; set; } /// - /// Query to filter the documents that can match. + /// + /// Query to filter the documents that can match. + /// /// [JsonInclude, JsonPropertyName("filter")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query))] public ICollection? Filter { get; set; } /// - /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// + /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// /// [JsonInclude, JsonPropertyName("min_score")] public float? MinScore { get; set; } /// - /// Defines a query to retrieve a set of top documents. + /// + /// Defines a query to retrieve a set of top documents. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? Query { get; set; } /// - /// Defines a search after object parameter used for pagination. + /// + /// Defines a search after object parameter used for pagination. + /// /// [JsonInclude, JsonPropertyName("search_after")] public ICollection? SearchAfter { get; set; } /// - /// A sort object that that specifies the order of matching documents. + /// + /// A sort object that that specifies the order of matching documents. + /// /// [JsonInclude, JsonPropertyName("sort")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.SortOptions))] public ICollection? Sort { get; set; } /// - /// Maximum number of documents to collect for each shard. + /// + /// Maximum number of documents to collect for each shard. + /// /// [JsonInclude, JsonPropertyName("terminate_after")] public int? TerminateAfter { get; set; } @@ -103,7 +117,9 @@ public StandardRetrieverDescriptor() : base() private int? TerminateAfterValue { get; set; } /// - /// Collapses the top documents by a specified key into a single top document per key. + /// + /// Collapses the top documents by a specified key into a single top document per key. + /// /// public StandardRetrieverDescriptor Collapse(Elastic.Clients.Elasticsearch.Serverless.Core.Search.FieldCollapse? collapse) { @@ -130,7 +146,9 @@ public StandardRetrieverDescriptor Collapse(Action - /// Query to filter the documents that can match. + /// + /// Query to filter the documents that can match. + /// /// public StandardRetrieverDescriptor Filter(ICollection? filter) { @@ -169,7 +187,9 @@ public StandardRetrieverDescriptor Filter(params Action - /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// + /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// /// public StandardRetrieverDescriptor MinScore(float? minScore) { @@ -178,7 +198,9 @@ public StandardRetrieverDescriptor MinScore(float? minScore) } /// - /// Defines a query to retrieve a set of top documents. + /// + /// Defines a query to retrieve a set of top documents. + /// /// public StandardRetrieverDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -205,7 +227,9 @@ public StandardRetrieverDescriptor Query(Action - /// Defines a search after object parameter used for pagination. + /// + /// Defines a search after object parameter used for pagination. + /// /// public StandardRetrieverDescriptor SearchAfter(ICollection? searchAfter) { @@ -214,7 +238,9 @@ public StandardRetrieverDescriptor SearchAfter(ICollection - /// A sort object that that specifies the order of matching documents. + /// + /// A sort object that that specifies the order of matching documents. + /// /// public StandardRetrieverDescriptor Sort(ICollection? sort) { @@ -253,7 +279,9 @@ public StandardRetrieverDescriptor Sort(params Action - /// Maximum number of documents to collect for each shard. + /// + /// Maximum number of documents to collect for each shard. + /// /// public StandardRetrieverDescriptor TerminateAfter(int? terminateAfter) { @@ -403,7 +431,9 @@ public StandardRetrieverDescriptor() : base() private int? TerminateAfterValue { get; set; } /// - /// Collapses the top documents by a specified key into a single top document per key. + /// + /// Collapses the top documents by a specified key into a single top document per key. + /// /// public StandardRetrieverDescriptor Collapse(Elastic.Clients.Elasticsearch.Serverless.Core.Search.FieldCollapse? collapse) { @@ -430,7 +460,9 @@ public StandardRetrieverDescriptor Collapse(Action - /// Query to filter the documents that can match. + /// + /// Query to filter the documents that can match. + /// /// public StandardRetrieverDescriptor Filter(ICollection? filter) { @@ -469,7 +501,9 @@ public StandardRetrieverDescriptor Filter(params Action - /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// + /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// /// public StandardRetrieverDescriptor MinScore(float? minScore) { @@ -478,7 +512,9 @@ public StandardRetrieverDescriptor MinScore(float? minScore) } /// - /// Defines a query to retrieve a set of top documents. + /// + /// Defines a query to retrieve a set of top documents. + /// /// public StandardRetrieverDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -505,7 +541,9 @@ public StandardRetrieverDescriptor Query(Action - /// Defines a search after object parameter used for pagination. + /// + /// Defines a search after object parameter used for pagination. + /// /// public StandardRetrieverDescriptor SearchAfter(ICollection? searchAfter) { @@ -514,7 +552,9 @@ public StandardRetrieverDescriptor SearchAfter(ICollection - /// A sort object that that specifies the order of matching documents. + /// + /// A sort object that that specifies the order of matching documents. + /// /// public StandardRetrieverDescriptor Sort(ICollection? sort) { @@ -553,7 +593,9 @@ public StandardRetrieverDescriptor Sort(params Action - /// Maximum number of documents to collect for each shard. + /// + /// Maximum number of documents to collect for each shard. + /// /// public StandardRetrieverDescriptor TerminateAfter(int? terminateAfter) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/StoreStats.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/StoreStats.g.cs index d8fb6efa6b1..a83eb985d4b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/StoreStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/StoreStats.g.cs @@ -30,37 +30,51 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class StoreStats { /// - /// A prediction of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities. + /// + /// A prediction of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities. + /// /// [JsonInclude, JsonPropertyName("reserved")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? Reserved { get; init; } /// - /// A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities. + /// + /// A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities. + /// /// [JsonInclude, JsonPropertyName("reserved_in_bytes")] public long ReservedInBytes { get; init; } /// - /// Total size of all shards assigned to selected nodes. + /// + /// Total size of all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("size")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? Size { get; init; } /// - /// Total size, in bytes, of all shards assigned to selected nodes. + /// + /// Total size, in bytes, of all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("size_in_bytes")] public long SizeInBytes { get; init; } /// - /// Total data set size of all shards assigned to selected nodes.
This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices. + /// + /// Total data set size of all shards assigned to selected nodes. + /// This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices. + /// /// [JsonInclude, JsonPropertyName("total_data_set_size")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? TotalDataSetSize { get; init; } /// - /// Total data set size, in bytes, of all shards assigned to selected nodes.
This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices. + /// + /// Total data set size, in bytes, of all shards assigned to selected nodes. + /// This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices. + /// /// [JsonInclude, JsonPropertyName("total_data_set_size_in_bytes")] public long? TotalDataSetSizeInBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/StoredScript.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/StoredScript.g.cs index a4580720f86..9b8e806088e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/StoredScript.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/StoredScript.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class StoredScript { /// - /// Specifies the language the script is written in. + /// + /// Specifies the language the script is written in. + /// /// [JsonInclude, JsonPropertyName("lang")] public Elastic.Clients.Elasticsearch.Serverless.ScriptLanguage Language { get; set; } @@ -38,7 +40,9 @@ public sealed partial class StoredScript public IDictionary? Options { get; set; } /// - /// The script source. + /// + /// The script source. + /// /// [JsonInclude, JsonPropertyName("source")] public string Source { get; set; } @@ -57,7 +61,9 @@ public StoredScriptDescriptor() : base() private string SourceValue { get; set; } /// - /// Specifies the language the script is written in. + /// + /// Specifies the language the script is written in. + /// /// public StoredScriptDescriptor Language(Elastic.Clients.Elasticsearch.Serverless.ScriptLanguage language) { @@ -72,7 +78,9 @@ public StoredScriptDescriptor Options(Func, Flu } /// - /// The script source. + /// + /// The script source. + /// /// public StoredScriptDescriptor Source(string source) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Synonyms/SynonymRule.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Synonyms/SynonymRule.g.cs index e6795fb388d..309df1f48e1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Synonyms/SynonymRule.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Synonyms/SynonymRule.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Synonyms; public sealed partial class SynonymRule { /// - /// Synonym Rule identifier + /// + /// Synonym Rule identifier + /// /// [JsonInclude, JsonPropertyName("id")] public Elastic.Clients.Elasticsearch.Serverless.Id? Id { get; set; } /// - /// Synonyms, in Solr format, that conform the synonym rule. See https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#_solr_synonyms_2 + /// + /// Synonyms, in Solr format, that conform the synonym rule. See https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#_solr_synonyms_2 + /// /// [JsonInclude, JsonPropertyName("synonyms")] public string Synonyms { get; set; } @@ -54,7 +58,9 @@ public SynonymRuleDescriptor() : base() private string SynonymsValue { get; set; } /// - /// Synonym Rule identifier + /// + /// Synonym Rule identifier + /// /// public SynonymRuleDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id? id) { @@ -63,7 +69,9 @@ public SynonymRuleDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id? id) } /// - /// Synonyms, in Solr format, that conform the synonym rule. See https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#_solr_synonyms_2 + /// + /// Synonyms, in Solr format, that conform the synonym rule. See https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#_solr_synonyms_2 + /// /// public SynonymRuleDescriptor Synonyms(string synonyms) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Synonyms/SynonymRuleRead.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Synonyms/SynonymRuleRead.g.cs index eb2ee5a512a..6dcd59c66f2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Synonyms/SynonymRuleRead.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Synonyms/SynonymRuleRead.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Synonyms; public sealed partial class SynonymRuleRead { /// - /// Synonym Rule identifier + /// + /// Synonym Rule identifier + /// /// [JsonInclude, JsonPropertyName("id")] public string Id { get; init; } /// - /// Synonyms, in Solr format, that conform the synonym rule. See https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#_solr_synonyms_2 + /// + /// Synonyms, in Solr format, that conform the synonym rule. See https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#_solr_synonyms_2 + /// /// [JsonInclude, JsonPropertyName("synonyms")] public string Synonyms { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Synonyms/SynonymsSetItem.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Synonyms/SynonymsSetItem.g.cs index 4c2ad7cb749..08e2ab2ee00 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Synonyms/SynonymsSetItem.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Synonyms/SynonymsSetItem.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Synonyms; public sealed partial class SynonymsSetItem { /// - /// Number of synonym rules that the synonym set contains + /// + /// Number of synonym rules that the synonym set contains + /// /// [JsonInclude, JsonPropertyName("count")] public int Count { get; init; } /// - /// Synonyms set identifier + /// + /// Synonyms set identifier + /// /// [JsonInclude, JsonPropertyName("synonyms_set")] public string SynonymsSet { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Tasks/ParentTaskInfo.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Tasks/ParentTaskInfo.g.cs index 01021437267..11a125636ed 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Tasks/ParentTaskInfo.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Tasks/ParentTaskInfo.g.cs @@ -55,7 +55,9 @@ public sealed partial class ParentTaskInfo public long StartTimeInMillis { get; init; } /// - /// Task status information can vary wildly from task to task. + /// + /// Task status information can vary wildly from task to task. + /// /// [JsonInclude, JsonPropertyName("status")] public object? Status { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Tasks/TaskInfo.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Tasks/TaskInfo.g.cs index 6dffbfe329e..e1eaca90fcf 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Tasks/TaskInfo.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Tasks/TaskInfo.g.cs @@ -53,7 +53,9 @@ public sealed partial class TaskInfo public long StartTimeInMillis { get; init; } /// - /// Task status information can vary wildly from task to task. + /// + /// Task status information can vary wildly from task to task. + /// /// [JsonInclude, JsonPropertyName("status")] public object? Status { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/Destination.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/Destination.g.cs index d50962e671b..7b122eafbfa 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/Destination.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/Destination.g.cs @@ -30,13 +30,19 @@ namespace Elastic.Clients.Elasticsearch.Serverless.TransformManagement; public sealed partial class Destination { /// - /// The destination index for the transform. The mappings of the destination index are deduced based on the source
fields when possible. If alternate mappings are required, use the create index API prior to starting the
transform. + /// + /// The destination index for the transform. The mappings of the destination index are deduced based on the source + /// fields when possible. If alternate mappings are required, use the create index API prior to starting the + /// transform. + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.Serverless.IndexName? Index { get; set; } /// - /// The unique identifier for an ingest pipeline. + /// + /// The unique identifier for an ingest pipeline. + /// /// [JsonInclude, JsonPropertyName("pipeline")] public string? Pipeline { get; set; } @@ -54,7 +60,11 @@ public DestinationDescriptor() : base() private string? PipelineValue { get; set; } /// - /// The destination index for the transform. The mappings of the destination index are deduced based on the source
fields when possible. If alternate mappings are required, use the create index API prior to starting the
transform. + /// + /// The destination index for the transform. The mappings of the destination index are deduced based on the source + /// fields when possible. If alternate mappings are required, use the create index API prior to starting the + /// transform. + /// /// public DestinationDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.IndexName? index) { @@ -63,7 +73,9 @@ public DestinationDescriptor Index(Elastic.Clients.Elasticsearch.Serverless.Inde } /// - /// The unique identifier for an ingest pipeline. + /// + /// The unique identifier for an ingest pipeline. + /// /// public DestinationDescriptor Pipeline(string? pipeline) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/Latest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/Latest.g.cs index 8e09a0d9b45..246e68681c4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/Latest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/Latest.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Serverless.TransformManagement; public sealed partial class Latest { /// - /// Specifies the date field that is used to identify the latest documents. + /// + /// Specifies the date field that is used to identify the latest documents. + /// /// [JsonInclude, JsonPropertyName("sort")] public Elastic.Clients.Elasticsearch.Serverless.Field Sort { get; set; } /// - /// Specifies an array of one or more fields that are used to group the data. + /// + /// Specifies an array of one or more fields that are used to group the data. + /// /// [JsonInclude, JsonPropertyName("unique_key")] [JsonConverter(typeof(FieldsConverter))] @@ -55,7 +59,9 @@ public LatestDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Fields UniqueKeyValue { get; set; } /// - /// Specifies the date field that is used to identify the latest documents. + /// + /// Specifies the date field that is used to identify the latest documents. + /// /// public LatestDescriptor Sort(Elastic.Clients.Elasticsearch.Serverless.Field sort) { @@ -64,7 +70,9 @@ public LatestDescriptor Sort(Elastic.Clients.Elasticsearch.Serverless } /// - /// Specifies the date field that is used to identify the latest documents. + /// + /// Specifies the date field that is used to identify the latest documents. + /// /// public LatestDescriptor Sort(Expression> sort) { @@ -73,7 +81,9 @@ public LatestDescriptor Sort(Expression - /// Specifies the date field that is used to identify the latest documents. + /// + /// Specifies the date field that is used to identify the latest documents. + /// /// public LatestDescriptor Sort(Expression> sort) { @@ -82,7 +92,9 @@ public LatestDescriptor Sort(Expression> sort } /// - /// Specifies an array of one or more fields that are used to group the data. + /// + /// Specifies an array of one or more fields that are used to group the data. + /// /// public LatestDescriptor UniqueKey(Elastic.Clients.Elasticsearch.Serverless.Fields uniqueKey) { @@ -113,7 +125,9 @@ public LatestDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Fields UniqueKeyValue { get; set; } /// - /// Specifies the date field that is used to identify the latest documents. + /// + /// Specifies the date field that is used to identify the latest documents. + /// /// public LatestDescriptor Sort(Elastic.Clients.Elasticsearch.Serverless.Field sort) { @@ -122,7 +136,9 @@ public LatestDescriptor Sort(Elastic.Clients.Elasticsearch.Serverless.Field sort } /// - /// Specifies the date field that is used to identify the latest documents. + /// + /// Specifies the date field that is used to identify the latest documents. + /// /// public LatestDescriptor Sort(Expression> sort) { @@ -131,7 +147,9 @@ public LatestDescriptor Sort(Expression - /// Specifies the date field that is used to identify the latest documents. + /// + /// Specifies the date field that is used to identify the latest documents. + /// /// public LatestDescriptor Sort(Expression> sort) { @@ -140,7 +158,9 @@ public LatestDescriptor Sort(Expression> sort } /// - /// Specifies an array of one or more fields that are used to group the data. + /// + /// Specifies an array of one or more fields that are used to group the data. + /// /// public LatestDescriptor UniqueKey(Elastic.Clients.Elasticsearch.Serverless.Fields uniqueKey) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/Pivot.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/Pivot.g.cs index 0f01241ca8d..b688a16548d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/Pivot.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/Pivot.g.cs @@ -79,12 +79,20 @@ public override void Write(Utf8JsonWriter writer, Pivot value, JsonSerializerOpt public sealed partial class Pivot { /// - /// Defines how to aggregate the grouped data. The following aggregations are currently supported: average, bucket
script, bucket selector, cardinality, filter, geo bounds, geo centroid, geo line, max, median absolute deviation,
min, missing, percentiles, rare terms, scripted metric, stats, sum, terms, top metrics, value count, weighted
average. + /// + /// Defines how to aggregate the grouped data. The following aggregations are currently supported: average, bucket + /// script, bucket selector, cardinality, filter, geo bounds, geo centroid, geo line, max, median absolute deviation, + /// min, missing, percentiles, rare terms, scripted metric, stats, sum, terms, top metrics, value count, weighted + /// average. + /// /// public IDictionary? Aggregations { get; set; } /// - /// Defines how to group the data. More than one grouping can be defined per pivot. The following groupings are
currently supported: date histogram, geotile grid, histogram, terms. + /// + /// Defines how to group the data. More than one grouping can be defined per pivot. The following groupings are + /// currently supported: date histogram, geotile grid, histogram, terms. + /// /// public IDictionary? GroupBy { get; set; } } @@ -101,7 +109,12 @@ public PivotDescriptor() : base() private IDictionary> GroupByValue { get; set; } /// - /// Defines how to aggregate the grouped data. The following aggregations are currently supported: average, bucket
script, bucket selector, cardinality, filter, geo bounds, geo centroid, geo line, max, median absolute deviation,
min, missing, percentiles, rare terms, scripted metric, stats, sum, terms, top metrics, value count, weighted
average. + /// + /// Defines how to aggregate the grouped data. The following aggregations are currently supported: average, bucket + /// script, bucket selector, cardinality, filter, geo bounds, geo centroid, geo line, max, median absolute deviation, + /// min, missing, percentiles, rare terms, scripted metric, stats, sum, terms, top metrics, value count, weighted + /// average. + /// /// public PivotDescriptor Aggregations(Func>, FluentDescriptorDictionary>> selector) { @@ -110,7 +123,10 @@ public PivotDescriptor Aggregations(Func - /// Defines how to group the data. More than one grouping can be defined per pivot. The following groupings are
currently supported: date histogram, geotile grid, histogram, terms. + /// + /// Defines how to group the data. More than one grouping can be defined per pivot. The following groupings are + /// currently supported: date histogram, geotile grid, histogram, terms. + /// /// public PivotDescriptor GroupBy(Func>, FluentDescriptorDictionary>> selector) { @@ -149,7 +165,12 @@ public PivotDescriptor() : base() private IDictionary GroupByValue { get; set; } /// - /// Defines how to aggregate the grouped data. The following aggregations are currently supported: average, bucket
script, bucket selector, cardinality, filter, geo bounds, geo centroid, geo line, max, median absolute deviation,
min, missing, percentiles, rare terms, scripted metric, stats, sum, terms, top metrics, value count, weighted
average. + /// + /// Defines how to aggregate the grouped data. The following aggregations are currently supported: average, bucket + /// script, bucket selector, cardinality, filter, geo bounds, geo centroid, geo line, max, median absolute deviation, + /// min, missing, percentiles, rare terms, scripted metric, stats, sum, terms, top metrics, value count, weighted + /// average. + /// /// public PivotDescriptor Aggregations(Func, FluentDescriptorDictionary> selector) { @@ -158,7 +179,10 @@ public PivotDescriptor Aggregations(Func - /// Defines how to group the data. More than one grouping can be defined per pivot. The following groupings are
currently supported: date histogram, geotile grid, histogram, terms. + /// + /// Defines how to group the data. More than one grouping can be defined per pivot. The following groupings are + /// currently supported: date histogram, geotile grid, histogram, terms. + /// /// public PivotDescriptor GroupBy(Func, FluentDescriptorDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/Settings.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/Settings.g.cs index d0838ea69ed..236495082d1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/Settings.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/Settings.g.cs @@ -28,49 +28,74 @@ namespace Elastic.Clients.Elasticsearch.Serverless.TransformManagement; /// -/// The source of the data for the transform. +/// +/// The source of the data for the transform. +/// /// public sealed partial class Settings { /// - /// Specifies whether the transform checkpoint ranges should be optimized for performance. Such optimization can align
checkpoint ranges with the date histogram interval when date histogram is specified as a group source in the
transform config. As a result, less document updates in the destination index will be performed thus improving
overall performance. + /// + /// Specifies whether the transform checkpoint ranges should be optimized for performance. Such optimization can align + /// checkpoint ranges with the date histogram interval when date histogram is specified as a group source in the + /// transform config. As a result, less document updates in the destination index will be performed thus improving + /// overall performance. + /// /// [JsonInclude, JsonPropertyName("align_checkpoints")] public bool? AlignCheckpoints { get; set; } /// - /// Defines if dates in the ouput should be written as ISO formatted string or as millis since epoch. epoch_millis was
the default for transforms created before version 7.11. For compatible output set this value to `true`. + /// + /// Defines if dates in the ouput should be written as ISO formatted string or as millis since epoch. epoch_millis was + /// the default for transforms created before version 7.11. For compatible output set this value to true. + /// /// [JsonInclude, JsonPropertyName("dates_as_epoch_millis")] public bool? DatesAsEpochMillis { get; set; } /// - /// Specifies whether the transform should deduce the destination index mappings from the transform configuration. + /// + /// Specifies whether the transform should deduce the destination index mappings from the transform configuration. + /// /// [JsonInclude, JsonPropertyName("deduce_mappings")] public bool? DeduceMappings { get; set; } /// - /// Specifies a limit on the number of input documents per second. This setting throttles the transform by adding a
wait time between search requests. The default value is null, which disables throttling. + /// + /// Specifies a limit on the number of input documents per second. This setting throttles the transform by adding a + /// wait time between search requests. The default value is null, which disables throttling. + /// /// [JsonInclude, JsonPropertyName("docs_per_second")] public float? DocsPerSecond { get; set; } /// - /// Defines the initial page size to use for the composite aggregation for each checkpoint. If circuit breaker
exceptions occur, the page size is dynamically adjusted to a lower value. The minimum value is `10` and the
maximum is `65,536`. + /// + /// Defines the initial page size to use for the composite aggregation for each checkpoint. If circuit breaker + /// exceptions occur, the page size is dynamically adjusted to a lower value. The minimum value is 10 and the + /// maximum is 65,536. + /// /// [JsonInclude, JsonPropertyName("max_page_search_size")] public int? MaxPageSearchSize { get; set; } /// - /// If `true`, the transform runs in unattended mode. In unattended mode, the transform retries indefinitely in case
of an error which means the transform never fails. Setting the number of retries other than infinite fails in
validation. + /// + /// If true, the transform runs in unattended mode. In unattended mode, the transform retries indefinitely in case + /// of an error which means the transform never fails. Setting the number of retries other than infinite fails in + /// validation. + /// /// [JsonInclude, JsonPropertyName("unattended")] public bool? Unattended { get; set; } } /// -/// The source of the data for the transform. +/// +/// The source of the data for the transform. +/// /// public sealed partial class SettingsDescriptor : SerializableDescriptor { @@ -88,7 +113,12 @@ public SettingsDescriptor() : base() private bool? UnattendedValue { get; set; } /// - /// Specifies whether the transform checkpoint ranges should be optimized for performance. Such optimization can align
checkpoint ranges with the date histogram interval when date histogram is specified as a group source in the
transform config. As a result, less document updates in the destination index will be performed thus improving
overall performance. + /// + /// Specifies whether the transform checkpoint ranges should be optimized for performance. Such optimization can align + /// checkpoint ranges with the date histogram interval when date histogram is specified as a group source in the + /// transform config. As a result, less document updates in the destination index will be performed thus improving + /// overall performance. + /// /// public SettingsDescriptor AlignCheckpoints(bool? alignCheckpoints = true) { @@ -97,7 +127,10 @@ public SettingsDescriptor AlignCheckpoints(bool? alignCheckpoints = true) } /// - /// Defines if dates in the ouput should be written as ISO formatted string or as millis since epoch. epoch_millis was
the default for transforms created before version 7.11. For compatible output set this value to `true`. + /// + /// Defines if dates in the ouput should be written as ISO formatted string or as millis since epoch. epoch_millis was + /// the default for transforms created before version 7.11. For compatible output set this value to true. + /// /// public SettingsDescriptor DatesAsEpochMillis(bool? datesAsEpochMillis = true) { @@ -106,7 +139,9 @@ public SettingsDescriptor DatesAsEpochMillis(bool? datesAsEpochMillis = true) } /// - /// Specifies whether the transform should deduce the destination index mappings from the transform configuration. + /// + /// Specifies whether the transform should deduce the destination index mappings from the transform configuration. + /// /// public SettingsDescriptor DeduceMappings(bool? deduceMappings = true) { @@ -115,7 +150,10 @@ public SettingsDescriptor DeduceMappings(bool? deduceMappings = true) } /// - /// Specifies a limit on the number of input documents per second. This setting throttles the transform by adding a
wait time between search requests. The default value is null, which disables throttling. + /// + /// Specifies a limit on the number of input documents per second. This setting throttles the transform by adding a + /// wait time between search requests. The default value is null, which disables throttling. + /// /// public SettingsDescriptor DocsPerSecond(float? docsPerSecond) { @@ -124,7 +162,11 @@ public SettingsDescriptor DocsPerSecond(float? docsPerSecond) } /// - /// Defines the initial page size to use for the composite aggregation for each checkpoint. If circuit breaker
exceptions occur, the page size is dynamically adjusted to a lower value. The minimum value is `10` and the
maximum is `65,536`. + /// + /// Defines the initial page size to use for the composite aggregation for each checkpoint. If circuit breaker + /// exceptions occur, the page size is dynamically adjusted to a lower value. The minimum value is 10 and the + /// maximum is 65,536. + /// /// public SettingsDescriptor MaxPageSearchSize(int? maxPageSearchSize) { @@ -133,7 +175,11 @@ public SettingsDescriptor MaxPageSearchSize(int? maxPageSearchSize) } /// - /// If `true`, the transform runs in unattended mode. In unattended mode, the transform retries indefinitely in case
of an error which means the transform never fails. Setting the number of retries other than infinite fails in
validation. + /// + /// If true, the transform runs in unattended mode. In unattended mode, the transform retries indefinitely in case + /// of an error which means the transform never fails. Setting the number of retries other than infinite fails in + /// validation. + /// /// public SettingsDescriptor Unattended(bool? unattended = true) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/Source.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/Source.g.cs index 686bab473e9..334c94a87c4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/Source.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/Source.g.cs @@ -30,19 +30,29 @@ namespace Elastic.Clients.Elasticsearch.Serverless.TransformManagement; public sealed partial class Source { /// - /// The source indices for the transform. It can be a single index, an index pattern (for example, `"my-index-*""`), an
array of indices (for example, `["my-index-000001", "my-index-000002"]`), or an array of index patterns (for
example, `["my-index-*", "my-other-index-*"]`. For remote indices use the syntax `"remote_name:index_name"`. If
any indices are in remote clusters then the master node and at least one transform node must have the `remote_cluster_client` node role. + /// + /// The source indices for the transform. It can be a single index, an index pattern (for example, "my-index-*""), an + /// array of indices (for example, ["my-index-000001", "my-index-000002"]), or an array of index patterns (for + /// example, ["my-index-*", "my-other-index-*"]. For remote indices use the syntax "remote_name:index_name". If + /// any indices are in remote clusters then the master node and at least one transform node must have the remote_cluster_client node role. + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.Serverless.Indices Indices { get; set; } /// - /// A query clause that retrieves a subset of data from the source index. + /// + /// A query clause that retrieves a subset of data from the source index. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? Query { get; set; } /// - /// Definitions of search-time runtime fields that can be used by the transform. For search runtime fields all data
nodes, including remote nodes, must be 7.12 or later. + /// + /// Definitions of search-time runtime fields that can be used by the transform. For search runtime fields all data + /// nodes, including remote nodes, must be 7.12 or later. + /// /// [JsonInclude, JsonPropertyName("runtime_mappings")] public IDictionary? RuntimeMappings { get; set; } @@ -63,7 +73,12 @@ public SourceDescriptor() : base() private IDictionary> RuntimeMappingsValue { get; set; } /// - /// The source indices for the transform. It can be a single index, an index pattern (for example, `"my-index-*""`), an
array of indices (for example, `["my-index-000001", "my-index-000002"]`), or an array of index patterns (for
example, `["my-index-*", "my-other-index-*"]`. For remote indices use the syntax `"remote_name:index_name"`. If
any indices are in remote clusters then the master node and at least one transform node must have the `remote_cluster_client` node role. + /// + /// The source indices for the transform. It can be a single index, an index pattern (for example, "my-index-*""), an + /// array of indices (for example, ["my-index-000001", "my-index-000002"]), or an array of index patterns (for + /// example, ["my-index-*", "my-other-index-*"]. For remote indices use the syntax "remote_name:index_name". If + /// any indices are in remote clusters then the master node and at least one transform node must have the remote_cluster_client node role. + /// /// public SourceDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.Indices indices) { @@ -72,7 +87,9 @@ public SourceDescriptor Indices(Elastic.Clients.Elasticsearch.Serverl } /// - /// A query clause that retrieves a subset of data from the source index. + /// + /// A query clause that retrieves a subset of data from the source index. + /// /// public SourceDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -99,7 +116,10 @@ public SourceDescriptor Query(Action - /// Definitions of search-time runtime fields that can be used by the transform. For search runtime fields all data
nodes, including remote nodes, must be 7.12 or later. + /// + /// Definitions of search-time runtime fields that can be used by the transform. For search runtime fields all data + /// nodes, including remote nodes, must be 7.12 or later. + /// /// public SourceDescriptor RuntimeMappings(Func>, FluentDescriptorDictionary>> selector) { @@ -153,7 +173,12 @@ public SourceDescriptor() : base() private IDictionary RuntimeMappingsValue { get; set; } /// - /// The source indices for the transform. It can be a single index, an index pattern (for example, `"my-index-*""`), an
array of indices (for example, `["my-index-000001", "my-index-000002"]`), or an array of index patterns (for
example, `["my-index-*", "my-other-index-*"]`. For remote indices use the syntax `"remote_name:index_name"`. If
any indices are in remote clusters then the master node and at least one transform node must have the `remote_cluster_client` node role. + /// + /// The source indices for the transform. It can be a single index, an index pattern (for example, "my-index-*""), an + /// array of indices (for example, ["my-index-000001", "my-index-000002"]), or an array of index patterns (for + /// example, ["my-index-*", "my-other-index-*"]. For remote indices use the syntax "remote_name:index_name". If + /// any indices are in remote clusters then the master node and at least one transform node must have the remote_cluster_client node role. + /// /// public SourceDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.Indices indices) { @@ -162,7 +187,9 @@ public SourceDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.Indices } /// - /// A query clause that retrieves a subset of data from the source index. + /// + /// A query clause that retrieves a subset of data from the source index. + /// /// public SourceDescriptor Query(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query? query) { @@ -189,7 +216,10 @@ public SourceDescriptor Query(Action - /// Definitions of search-time runtime fields that can be used by the transform. For search runtime fields all data
nodes, including remote nodes, must be 7.12 or later. + /// + /// Definitions of search-time runtime fields that can be used by the transform. For search runtime fields all data + /// nodes, including remote nodes, must be 7.12 or later. + /// /// public SourceDescriptor RuntimeMappings(Func, FluentDescriptorDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/TimeRetentionPolicy.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/TimeRetentionPolicy.g.cs index 9f578f277eb..830dd573c4e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/TimeRetentionPolicy.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/TimeRetentionPolicy.g.cs @@ -30,13 +30,18 @@ namespace Elastic.Clients.Elasticsearch.Serverless.TransformManagement; public sealed partial class TimeRetentionPolicy { /// - /// The date field that is used to calculate the age of the document. + /// + /// The date field that is used to calculate the age of the document. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } /// - /// Specifies the maximum age of a document in the destination index. Documents that are older than the configured
value are removed from the destination index. + /// + /// Specifies the maximum age of a document in the destination index. Documents that are older than the configured + /// value are removed from the destination index. + /// /// [JsonInclude, JsonPropertyName("max_age")] public Elastic.Clients.Elasticsearch.Serverless.Duration MaxAge { get; set; } @@ -56,7 +61,9 @@ public TimeRetentionPolicyDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Duration MaxAgeValue { get; set; } /// - /// The date field that is used to calculate the age of the document. + /// + /// The date field that is used to calculate the age of the document. + /// /// public TimeRetentionPolicyDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -65,7 +72,9 @@ public TimeRetentionPolicyDescriptor Field(Elastic.Clients.Elasticsea } /// - /// The date field that is used to calculate the age of the document. + /// + /// The date field that is used to calculate the age of the document. + /// /// public TimeRetentionPolicyDescriptor Field(Expression> field) { @@ -74,7 +83,9 @@ public TimeRetentionPolicyDescriptor Field(Expression - /// The date field that is used to calculate the age of the document. + /// + /// The date field that is used to calculate the age of the document. + /// /// public TimeRetentionPolicyDescriptor Field(Expression> field) { @@ -83,7 +94,10 @@ public TimeRetentionPolicyDescriptor Field(Expression - /// Specifies the maximum age of a document in the destination index. Documents that are older than the configured
value are removed from the destination index. + /// + /// Specifies the maximum age of a document in the destination index. Documents that are older than the configured + /// value are removed from the destination index. + /// /// public TimeRetentionPolicyDescriptor MaxAge(Elastic.Clients.Elasticsearch.Serverless.Duration maxAge) { @@ -114,7 +128,9 @@ public TimeRetentionPolicyDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Duration MaxAgeValue { get; set; } /// - /// The date field that is used to calculate the age of the document. + /// + /// The date field that is used to calculate the age of the document. + /// /// public TimeRetentionPolicyDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -123,7 +139,9 @@ public TimeRetentionPolicyDescriptor Field(Elastic.Clients.Elasticsearch.Serverl } /// - /// The date field that is used to calculate the age of the document. + /// + /// The date field that is used to calculate the age of the document. + /// /// public TimeRetentionPolicyDescriptor Field(Expression> field) { @@ -132,7 +150,9 @@ public TimeRetentionPolicyDescriptor Field(Expression - /// The date field that is used to calculate the age of the document. + /// + /// The date field that is used to calculate the age of the document. + /// /// public TimeRetentionPolicyDescriptor Field(Expression> field) { @@ -141,7 +161,10 @@ public TimeRetentionPolicyDescriptor Field(Expression - /// Specifies the maximum age of a document in the destination index. Documents that are older than the configured
value are removed from the destination index. + /// + /// Specifies the maximum age of a document in the destination index. Documents that are older than the configured + /// value are removed from the destination index. + /// /// public TimeRetentionPolicyDescriptor MaxAge(Elastic.Clients.Elasticsearch.Serverless.Duration maxAge) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/TimeSync.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/TimeSync.g.cs index 7e725a89771..95938096402 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/TimeSync.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/TimeSync.g.cs @@ -30,13 +30,19 @@ namespace Elastic.Clients.Elasticsearch.Serverless.TransformManagement; public sealed partial class TimeSync { /// - /// The time delay between the current time and the latest input data time. + /// + /// The time delay between the current time and the latest input data time. + /// /// [JsonInclude, JsonPropertyName("delay")] public Elastic.Clients.Elasticsearch.Serverless.Duration? Delay { get; set; } /// - /// The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field
that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it
accounts for data transmission delays. + /// + /// The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field + /// that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it + /// accounts for data transmission delays. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } @@ -56,7 +62,9 @@ public TimeSyncDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field FieldValue { get; set; } /// - /// The time delay between the current time and the latest input data time. + /// + /// The time delay between the current time and the latest input data time. + /// /// public TimeSyncDescriptor Delay(Elastic.Clients.Elasticsearch.Serverless.Duration? delay) { @@ -65,7 +73,11 @@ public TimeSyncDescriptor Delay(Elastic.Clients.Elasticsearch.Serverl } /// - /// The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field
that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it
accounts for data transmission delays. + /// + /// The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field + /// that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it + /// accounts for data transmission delays. + /// /// public TimeSyncDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -74,7 +86,11 @@ public TimeSyncDescriptor Field(Elastic.Clients.Elasticsearch.Serverl } /// - /// The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field
that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it
accounts for data transmission delays. + /// + /// The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field + /// that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it + /// accounts for data transmission delays. + /// /// public TimeSyncDescriptor Field(Expression> field) { @@ -83,7 +99,11 @@ public TimeSyncDescriptor Field(Expression - /// The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field
that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it
accounts for data transmission delays. + /// + /// The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field + /// that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it + /// accounts for data transmission delays. + /// /// public TimeSyncDescriptor Field(Expression> field) { @@ -118,7 +138,9 @@ public TimeSyncDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.Field FieldValue { get; set; } /// - /// The time delay between the current time and the latest input data time. + /// + /// The time delay between the current time and the latest input data time. + /// /// public TimeSyncDescriptor Delay(Elastic.Clients.Elasticsearch.Serverless.Duration? delay) { @@ -127,7 +149,11 @@ public TimeSyncDescriptor Delay(Elastic.Clients.Elasticsearch.Serverless.Duratio } /// - /// The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field
that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it
accounts for data transmission delays. + /// + /// The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field + /// that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it + /// accounts for data transmission delays. + /// /// public TimeSyncDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) { @@ -136,7 +162,11 @@ public TimeSyncDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field f } /// - /// The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field
that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it
accounts for data transmission delays. + /// + /// The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field + /// that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it + /// accounts for data transmission delays. + /// /// public TimeSyncDescriptor Field(Expression> field) { @@ -145,7 +175,11 @@ public TimeSyncDescriptor Field(Expression - /// The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field
that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it
accounts for data transmission delays. + /// + /// The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field + /// that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it + /// accounts for data transmission delays. + /// /// public TimeSyncDescriptor Field(Expression> field) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/TransformSummary.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/TransformSummary.g.cs index 33b598cec6c..2b16dd6e585 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/TransformSummary.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TransformManagement/TransformSummary.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.Serverless.TransformManagement; public sealed partial class TransformSummary { /// - /// The security privileges that the transform uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the transform, this property is omitted. + /// + /// The security privileges that the transform uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the transform, this property is omitted. + /// /// [JsonInclude, JsonPropertyName("authorization")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TransformAuthorization? Authorization { get; init; } /// - /// The time the transform was created. + /// + /// The time the transform was created. + /// /// [JsonInclude, JsonPropertyName("create_time")] public long? CreateTime { get; init; } /// - /// Free text description of the transform. + /// + /// Free text description of the transform. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; init; } /// - /// The destination for the transform. + /// + /// The destination for the transform. + /// /// [JsonInclude, JsonPropertyName("dest")] public Elastic.Clients.Elasticsearch.Serverless.Core.Reindex.Destination Dest { get; init; } @@ -62,7 +70,9 @@ public sealed partial class TransformSummary public IReadOnlyDictionary? Meta { get; init; } /// - /// The pivot method transforms the data by aggregating and grouping it. + /// + /// The pivot method transforms the data by aggregating and grouping it. + /// /// [JsonInclude, JsonPropertyName("pivot")] public Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Pivot? Pivot { get; init; } @@ -70,25 +80,33 @@ public sealed partial class TransformSummary public Elastic.Clients.Elasticsearch.Serverless.TransformManagement.RetentionPolicy? RetentionPolicy { get; init; } /// - /// Defines optional transform settings. + /// + /// Defines optional transform settings. + /// /// [JsonInclude, JsonPropertyName("settings")] public Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Settings? Settings { get; init; } /// - /// The source of the data for the transform. + /// + /// The source of the data for the transform. + /// /// [JsonInclude, JsonPropertyName("source")] public Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Source Source { get; init; } /// - /// Defines the properties transforms require to run continuously. + /// + /// Defines the properties transforms require to run continuously. + /// /// [JsonInclude, JsonPropertyName("sync")] public Elastic.Clients.Elasticsearch.Serverless.TransformManagement.Sync? Sync { get; init; } /// - /// The version of Elasticsearch that existed on the node when the transform was created. + /// + /// The version of Elasticsearch that existed on the node when the transform was created. + /// /// [JsonInclude, JsonPropertyName("version")] public string? Version { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Xpack/MachineLearning.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Xpack/MachineLearning.g.cs index 4e271abda41..bb355cf693c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Xpack/MachineLearning.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Xpack/MachineLearning.g.cs @@ -41,7 +41,9 @@ public sealed partial class MachineLearning public Elastic.Clients.Elasticsearch.Serverless.Xpack.MlInference Inference { get; init; } /// - /// Job usage statistics. The `_all` entry is always present and gathers statistics for all jobs. + /// + /// Job usage statistics. The _all entry is always present and gathers statistics for all jobs. + /// /// [JsonInclude, JsonPropertyName("jobs")] public IReadOnlyDictionary Jobs { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/AsyncSearchStatusRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/AsyncSearchStatusRequest.g.cs index 151cef732ca..161d317eb36 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/AsyncSearchStatusRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/AsyncSearchStatusRequest.g.cs @@ -34,7 +34,11 @@ public sealed partial class AsyncSearchStatusRequestParameters : RequestParamete } /// -/// Get async search status
Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. +/// +/// Get async search status +/// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. +/// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. +/// /// public sealed partial class AsyncSearchStatusRequest : PlainRequest { @@ -52,7 +56,11 @@ public AsyncSearchStatusRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => } /// -/// Get async search status
Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. +/// +/// Get async search status +/// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. +/// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. +/// /// public sealed partial class AsyncSearchStatusRequestDescriptor : RequestDescriptor, AsyncSearchStatusRequestParameters> { @@ -82,7 +90,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Get async search status
Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. +/// +/// Get async search status +/// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. +/// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. +/// /// public sealed partial class AsyncSearchStatusRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/AsyncSearchStatusResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/AsyncSearchStatusResponse.g.cs index 9f9cff0d79f..126481dc53a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/AsyncSearchStatusResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/AsyncSearchStatusResponse.g.cs @@ -29,19 +29,29 @@ namespace Elastic.Clients.Elasticsearch.AsyncSearch; public sealed partial class AsyncSearchStatusResponse : ElasticsearchResponse { /// - /// Metadata about clusters involved in the cross-cluster search.
Not shown for local-only searches. + /// + /// Metadata about clusters involved in the cross-cluster search. + /// Not shown for local-only searches. + /// /// [JsonInclude, JsonPropertyName("_clusters")] public Elastic.Clients.Elasticsearch.ClusterStatistics? Clusters { get; init; } /// - /// If the async search completed, this field shows the status code of the search.
For example, 200 indicates that the async search was successfully completed.
503 indicates that the async search was completed with an error. + /// + /// If the async search completed, this field shows the status code of the search. + /// For example, 200 indicates that the async search was successfully completed. + /// 503 indicates that the async search was completed with an error. + /// /// [JsonInclude, JsonPropertyName("completion_status")] public int? CompletionStatus { get; init; } /// - /// Indicates when the async search completed. Only present
when the search has completed. + /// + /// Indicates when the async search completed. Only present + /// when the search has completed. + /// /// [JsonInclude, JsonPropertyName("completion_time")] public DateTimeOffset? CompletionTime { get; init; } @@ -49,7 +59,9 @@ public sealed partial class AsyncSearchStatusResponse : ElasticsearchResponse public long? CompletionTimeInMillis { get; init; } /// - /// Indicates when the async search will expire. + /// + /// Indicates when the async search will expire. + /// /// [JsonInclude, JsonPropertyName("expiration_time")] public DateTimeOffset? ExpirationTime { get; init; } @@ -59,19 +71,27 @@ public sealed partial class AsyncSearchStatusResponse : ElasticsearchResponse public string? Id { get; init; } /// - /// When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards.
While the query is running, `is_partial` is always set to `true`. + /// + /// When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards. + /// While the query is running, is_partial is always set to true. + /// /// [JsonInclude, JsonPropertyName("is_partial")] public bool IsPartial { get; init; } /// - /// Indicates whether the search is still running or has completed.
NOTE: If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though `is_running` is `false`. + /// + /// Indicates whether the search is still running or has completed. + /// NOTE: If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though is_running is false. + /// /// [JsonInclude, JsonPropertyName("is_running")] public bool IsRunning { get; init; } /// - /// Indicates how many shards have run the query so far. + /// + /// Indicates how many shards have run the query so far. + /// /// [JsonInclude, JsonPropertyName("_shards")] public Elastic.Clients.Elasticsearch.ShardStatistics Shards { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/DeleteAsyncSearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/DeleteAsyncSearchRequest.g.cs index 51aa060f0ad..2712b599330 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/DeleteAsyncSearchRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/DeleteAsyncSearchRequest.g.cs @@ -34,7 +34,12 @@ public sealed partial class DeleteAsyncSearchRequestParameters : RequestParamete } /// -/// Deletes an async search by identifier.
If the search is still running, the search request will be cancelled.
Otherwise, the saved search results are deleted.
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. +/// +/// Deletes an async search by identifier. +/// If the search is still running, the search request will be cancelled. +/// Otherwise, the saved search results are deleted. +/// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. +/// /// public sealed partial class DeleteAsyncSearchRequest : PlainRequest { @@ -52,7 +57,12 @@ public DeleteAsyncSearchRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => } /// -/// Deletes an async search by identifier.
If the search is still running, the search request will be cancelled.
Otherwise, the saved search results are deleted.
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. +/// +/// Deletes an async search by identifier. +/// If the search is still running, the search request will be cancelled. +/// Otherwise, the saved search results are deleted. +/// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. +/// /// public sealed partial class DeleteAsyncSearchRequestDescriptor : RequestDescriptor, DeleteAsyncSearchRequestParameters> { @@ -82,7 +92,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Deletes an async search by identifier.
If the search is still running, the search request will be cancelled.
Otherwise, the saved search results are deleted.
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. +/// +/// Deletes an async search by identifier. +/// If the search is still running, the search request will be cancelled. +/// Otherwise, the saved search results are deleted. +/// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. +/// /// public sealed partial class DeleteAsyncSearchRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/DeleteAsyncSearchResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/DeleteAsyncSearchResponse.g.cs index 4e3be7997ec..ea208db9469 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/DeleteAsyncSearchResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/DeleteAsyncSearchResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.AsyncSearch; public sealed partial class DeleteAsyncSearchResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/GetAsyncSearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/GetAsyncSearchRequest.g.cs index 009f12b1562..1bf4a779425 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/GetAsyncSearchRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/GetAsyncSearchRequest.g.cs @@ -32,23 +32,38 @@ namespace Elastic.Clients.Elasticsearch.AsyncSearch; public sealed partial class GetAsyncSearchRequestParameters : RequestParameters { /// - /// Specifies how long the async search should be available in the cluster.
When not specified, the `keep_alive` set with the corresponding submit async request will be used.
Otherwise, it is possible to override the value and extend the validity of the request.
When this period expires, the search, if still running, is cancelled.
If the search is completed, its saved results are deleted. + /// + /// Specifies how long the async search should be available in the cluster. + /// When not specified, the keep_alive set with the corresponding submit async request will be used. + /// Otherwise, it is possible to override the value and extend the validity of the request. + /// When this period expires, the search, if still running, is cancelled. + /// If the search is completed, its saved results are deleted. + /// /// public Elastic.Clients.Elasticsearch.Duration? KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); } /// - /// Specify whether aggregation and suggester names should be prefixed by their respective types in the response + /// + /// Specify whether aggregation and suggester names should be prefixed by their respective types in the response + /// /// public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } /// - /// Specifies to wait for the search to be completed up until the provided timeout.
Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires.
By default no timeout is set meaning that the currently available results will be returned without any additional wait. + /// + /// Specifies to wait for the search to be completed up until the provided timeout. + /// Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires. + /// By default no timeout is set meaning that the currently available results will be returned without any additional wait. + /// /// public Elastic.Clients.Elasticsearch.Duration? WaitForCompletionTimeout { get => Q("wait_for_completion_timeout"); set => Q("wait_for_completion_timeout", value); } } /// -/// Retrieves the results of a previously submitted async search request given its identifier.
If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. +/// +/// Retrieves the results of a previously submitted async search request given its identifier. +/// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. +/// /// public sealed partial class GetAsyncSearchRequest : PlainRequest { @@ -65,26 +80,41 @@ public GetAsyncSearchRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r. internal override string OperationName => "async_search.get"; /// - /// Specifies how long the async search should be available in the cluster.
When not specified, the `keep_alive` set with the corresponding submit async request will be used.
Otherwise, it is possible to override the value and extend the validity of the request.
When this period expires, the search, if still running, is cancelled.
If the search is completed, its saved results are deleted. + /// + /// Specifies how long the async search should be available in the cluster. + /// When not specified, the keep_alive set with the corresponding submit async request will be used. + /// Otherwise, it is possible to override the value and extend the validity of the request. + /// When this period expires, the search, if still running, is cancelled. + /// If the search is completed, its saved results are deleted. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); } /// - /// Specify whether aggregation and suggester names should be prefixed by their respective types in the response + /// + /// Specify whether aggregation and suggester names should be prefixed by their respective types in the response + /// /// [JsonIgnore] public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } /// - /// Specifies to wait for the search to be completed up until the provided timeout.
Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires.
By default no timeout is set meaning that the currently available results will be returned without any additional wait. + /// + /// Specifies to wait for the search to be completed up until the provided timeout. + /// Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires. + /// By default no timeout is set meaning that the currently available results will be returned without any additional wait. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? WaitForCompletionTimeout { get => Q("wait_for_completion_timeout"); set => Q("wait_for_completion_timeout", value); } } /// -/// Retrieves the results of a previously submitted async search request given its identifier.
If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. +/// +/// Retrieves the results of a previously submitted async search request given its identifier. +/// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. +/// /// public sealed partial class GetAsyncSearchRequestDescriptor : RequestDescriptor, GetAsyncSearchRequestParameters> { @@ -118,7 +148,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Retrieves the results of a previously submitted async search request given its identifier.
If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. +/// +/// Retrieves the results of a previously submitted async search request given its identifier. +/// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. +/// /// public sealed partial class GetAsyncSearchRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/GetAsyncSearchResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/GetAsyncSearchResponse.g.cs index 705ea995fd2..3dd949e280f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/GetAsyncSearchResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/GetAsyncSearchResponse.g.cs @@ -29,7 +29,10 @@ namespace Elastic.Clients.Elasticsearch.AsyncSearch; public sealed partial class GetAsyncSearchResponse : ElasticsearchResponse { /// - /// Indicates when the async search completed. Only present
when the search has completed. + /// + /// Indicates when the async search completed. Only present + /// when the search has completed. + /// /// [JsonInclude, JsonPropertyName("completion_time")] public DateTimeOffset? CompletionTime { get; init; } @@ -37,7 +40,9 @@ public sealed partial class GetAsyncSearchResponse : ElasticsearchRes public long? CompletionTimeInMillis { get; init; } /// - /// Indicates when the async search will expire. + /// + /// Indicates when the async search will expire. + /// /// [JsonInclude, JsonPropertyName("expiration_time")] public DateTimeOffset? ExpirationTime { get; init; } @@ -47,13 +52,19 @@ public sealed partial class GetAsyncSearchResponse : ElasticsearchRes public string? Id { get; init; } /// - /// When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards.
While the query is running, `is_partial` is always set to `true`. + /// + /// When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards. + /// While the query is running, is_partial is always set to true. + /// /// [JsonInclude, JsonPropertyName("is_partial")] public bool IsPartial { get; init; } /// - /// Indicates whether the search is still running or has completed.
NOTE: If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though `is_running` is `false`. + /// + /// Indicates whether the search is still running or has completed. + /// NOTE: If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though is_running is false. + /// /// [JsonInclude, JsonPropertyName("is_running")] public bool IsRunning { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/SubmitAsyncSearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/SubmitAsyncSearchRequest.g.cs index 14e1340f92d..9b8f681bf1b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/SubmitAsyncSearchRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/SubmitAsyncSearchRequest.g.cs @@ -32,150 +32,211 @@ namespace Elastic.Clients.Elasticsearch.AsyncSearch; public sealed partial class SubmitAsyncSearchRequestParameters : RequestParameters { /// - /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + /// + /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified) + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Indicate if an error should be returned if there is a partial search failure or timeout + /// + /// Indicate if an error should be returned if there is a partial search failure or timeout + /// /// public bool? AllowPartialSearchResults { get => Q("allow_partial_search_results"); set => Q("allow_partial_search_results", value); } /// - /// The analyzer to use for the query string + /// + /// The analyzer to use for the query string + /// /// public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// - /// Specify whether wildcard and prefix queries should be analyzed (default: false) + /// + /// Specify whether wildcard and prefix queries should be analyzed (default: false) + /// /// public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } /// - /// Affects how often partial results become available, which happens whenever shard results are reduced.
A partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default). + /// + /// Affects how often partial results become available, which happens whenever shard results are reduced. + /// A partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default). + /// /// public long? BatchedReduceSize { get => Q("batched_reduce_size"); set => Q("batched_reduce_size", value); } /// - /// The default value is the only supported value. + /// + /// The default value is the only supported value. + /// /// public bool? CcsMinimizeRoundtrips { get => Q("ccs_minimize_roundtrips"); set => Q("ccs_minimize_roundtrips", value); } /// - /// The default operator for query string query (AND or OR) + /// + /// The default operator for query string query (AND or OR) + /// /// public Elastic.Clients.Elasticsearch.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } /// - /// The field to use as default where no field prefix is given in the query string + /// + /// The field to use as default where no field prefix is given in the query string + /// /// public string? Df { get => Q("df"); set => Q("df", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// + /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Whether specified concrete, expanded or aliased indices should be ignored when throttled + /// + /// Whether specified concrete, expanded or aliased indices should be ignored when throttled + /// /// public bool? IgnoreThrottled { get => Q("ignore_throttled"); set => Q("ignore_throttled", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// + /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Specifies how long the async search needs to be available.
Ongoing async searches and any saved search results are deleted after this period. + /// + /// Specifies how long the async search needs to be available. + /// Ongoing async searches and any saved search results are deleted after this period. + /// /// public Elastic.Clients.Elasticsearch.Duration? KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); } /// - /// If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`. + /// + /// If true, results are stored for later retrieval when the search completes within the wait_for_completion_timeout. + /// /// public bool? KeepOnCompletion { get => Q("keep_on_completion"); set => Q("keep_on_completion", value); } /// - /// Specify whether format-based query failures (such as providing text to a numeric field) should be ignored + /// + /// Specify whether format-based query failures (such as providing text to a numeric field) should be ignored + /// /// public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// - /// The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests + /// + /// The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests + /// /// public long? MaxConcurrentShardRequests { get => Q("max_concurrent_shard_requests"); set => Q("max_concurrent_shard_requests", value); } public string? MinCompatibleShardNode { get => Q("min_compatible_shard_node"); set => Q("min_compatible_shard_node", value); } /// - /// Specify the node or shard the operation should be performed on (default: random) + /// + /// Specify the node or shard the operation should be performed on (default: random) + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped. + /// + /// The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped. + /// /// public long? PreFilterShardSize { get => Q("pre_filter_shard_size"); set => Q("pre_filter_shard_size", value); } /// - /// Query in the Lucene query string syntax + /// + /// Query in the Lucene query string syntax + /// /// public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } /// - /// Specify if request cache should be used for this request or not, defaults to true + /// + /// Specify if request cache should be used for this request or not, defaults to true + /// /// public bool? RequestCache { get => Q("request_cache"); set => Q("request_cache", value); } public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } /// - /// A comma-separated list of specific routing values + /// + /// A comma-separated list of specific routing values + /// /// public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } public Elastic.Clients.Elasticsearch.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); } /// - /// Search operation type + /// + /// Search operation type + /// /// public Elastic.Clients.Elasticsearch.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } /// - /// A list of fields to exclude from the returned _source field + /// + /// A list of fields to exclude from the returned _source field + /// /// public Elastic.Clients.Elasticsearch.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A list of fields to extract and return from the _source field + /// + /// A list of fields to extract and return from the _source field + /// /// public Elastic.Clients.Elasticsearch.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// Specifies which field to use for suggestions. + /// + /// Specifies which field to use for suggestions. + /// /// public Elastic.Clients.Elasticsearch.Field? SuggestField { get => Q("suggest_field"); set => Q("suggest_field", value); } /// - /// Specify suggest mode + /// + /// Specify suggest mode + /// /// public Elastic.Clients.Elasticsearch.SuggestMode? SuggestMode { get => Q("suggest_mode"); set => Q("suggest_mode", value); } /// - /// How many suggestions to return in response + /// + /// How many suggestions to return in response + /// /// public long? SuggestSize { get => Q("suggest_size"); set => Q("suggest_size", value); } /// - /// The source text for which the suggestions should be returned. + /// + /// The source text for which the suggestions should be returned. + /// /// public string? SuggestText { get => Q("suggest_text"); set => Q("suggest_text", value); } /// - /// Specify whether aggregation and suggester names should be prefixed by their respective types in the response + /// + /// Specify whether aggregation and suggester names should be prefixed by their respective types in the response + /// /// public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } /// - /// Blocks and waits until the search is completed up to a certain timeout.
When the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster. + /// + /// Blocks and waits until the search is completed up to a certain timeout. + /// When the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster. + /// /// public Elastic.Clients.Elasticsearch.Duration? WaitForCompletionTimeout { get => Q("wait_for_completion_timeout"); set => Q("wait_for_completion_timeout", value); } } @@ -589,7 +650,13 @@ public override void Write(Utf8JsonWriter writer, SubmitAsyncSearchRequest value } /// -/// Runs a search request asynchronously.
When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.
Warning: Async search does not support scroll nor search requests that only include the suggest section.
By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. +/// +/// Runs a search request asynchronously. +/// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. +/// Warning: Async search does not support scroll nor search requests that only include the suggest section. +/// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. +/// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. +/// /// [JsonConverter(typeof(SubmitAsyncSearchRequestConverter))] public sealed partial class SubmitAsyncSearchRequest : PlainRequest @@ -611,91 +678,123 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Indices? indices) internal override string OperationName => "async_search.submit"; /// - /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + /// + /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified) + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Indicate if an error should be returned if there is a partial search failure or timeout + /// + /// Indicate if an error should be returned if there is a partial search failure or timeout + /// /// [JsonIgnore] public bool? AllowPartialSearchResults { get => Q("allow_partial_search_results"); set => Q("allow_partial_search_results", value); } /// - /// The analyzer to use for the query string + /// + /// The analyzer to use for the query string + /// /// [JsonIgnore] public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// - /// Specify whether wildcard and prefix queries should be analyzed (default: false) + /// + /// Specify whether wildcard and prefix queries should be analyzed (default: false) + /// /// [JsonIgnore] public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } /// - /// Affects how often partial results become available, which happens whenever shard results are reduced.
A partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default). + /// + /// Affects how often partial results become available, which happens whenever shard results are reduced. + /// A partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default). + /// /// [JsonIgnore] public long? BatchedReduceSize { get => Q("batched_reduce_size"); set => Q("batched_reduce_size", value); } /// - /// The default value is the only supported value. + /// + /// The default value is the only supported value. + /// /// [JsonIgnore] public bool? CcsMinimizeRoundtrips { get => Q("ccs_minimize_roundtrips"); set => Q("ccs_minimize_roundtrips", value); } /// - /// The default operator for query string query (AND or OR) + /// + /// The default operator for query string query (AND or OR) + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } /// - /// The field to use as default where no field prefix is given in the query string + /// + /// The field to use as default where no field prefix is given in the query string + /// /// [JsonIgnore] public string? Df { get => Q("df"); set => Q("df", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// + /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Whether specified concrete, expanded or aliased indices should be ignored when throttled + /// + /// Whether specified concrete, expanded or aliased indices should be ignored when throttled + /// /// [JsonIgnore] public bool? IgnoreThrottled { get => Q("ignore_throttled"); set => Q("ignore_throttled", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// + /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Specifies how long the async search needs to be available.
Ongoing async searches and any saved search results are deleted after this period. + /// + /// Specifies how long the async search needs to be available. + /// Ongoing async searches and any saved search results are deleted after this period. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); } /// - /// If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`. + /// + /// If true, results are stored for later retrieval when the search completes within the wait_for_completion_timeout. + /// /// [JsonIgnore] public bool? KeepOnCompletion { get => Q("keep_on_completion"); set => Q("keep_on_completion", value); } /// - /// Specify whether format-based query failures (such as providing text to a numeric field) should be ignored + /// + /// Specify whether format-based query failures (such as providing text to a numeric field) should be ignored + /// /// [JsonIgnore] public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// - /// The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests + /// + /// The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests + /// /// [JsonIgnore] public long? MaxConcurrentShardRequests { get => Q("max_concurrent_shard_requests"); set => Q("max_concurrent_shard_requests", value); } @@ -703,25 +802,33 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Indices? indices) public string? MinCompatibleShardNode { get => Q("min_compatible_shard_node"); set => Q("min_compatible_shard_node", value); } /// - /// Specify the node or shard the operation should be performed on (default: random) + /// + /// Specify the node or shard the operation should be performed on (default: random) + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped. + /// + /// The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped. + /// /// [JsonIgnore] public long? PreFilterShardSize { get => Q("pre_filter_shard_size"); set => Q("pre_filter_shard_size", value); } /// - /// Query in the Lucene query string syntax + /// + /// Query in the Lucene query string syntax + /// /// [JsonIgnore] public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } /// - /// Specify if request cache should be used for this request or not, defaults to true + /// + /// Specify if request cache should be used for this request or not, defaults to true + /// /// [JsonIgnore] public bool? RequestCache { get => Q("request_cache"); set => Q("request_cache", value); } @@ -729,7 +836,9 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Indices? indices) public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } /// - /// A comma-separated list of specific routing values + /// + /// A comma-separated list of specific routing values + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } @@ -737,55 +846,74 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Indices? indices) public Elastic.Clients.Elasticsearch.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); } /// - /// Search operation type + /// + /// Search operation type + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } /// - /// A list of fields to exclude from the returned _source field + /// + /// A list of fields to exclude from the returned _source field + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A list of fields to extract and return from the _source field + /// + /// A list of fields to extract and return from the _source field + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// Specifies which field to use for suggestions. + /// + /// Specifies which field to use for suggestions. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Field? SuggestField { get => Q("suggest_field"); set => Q("suggest_field", value); } /// - /// Specify suggest mode + /// + /// Specify suggest mode + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.SuggestMode? SuggestMode { get => Q("suggest_mode"); set => Q("suggest_mode", value); } /// - /// How many suggestions to return in response + /// + /// How many suggestions to return in response + /// /// [JsonIgnore] public long? SuggestSize { get => Q("suggest_size"); set => Q("suggest_size", value); } /// - /// The source text for which the suggestions should be returned. + /// + /// The source text for which the suggestions should be returned. + /// /// [JsonIgnore] public string? SuggestText { get => Q("suggest_text"); set => Q("suggest_text", value); } /// - /// Specify whether aggregation and suggester names should be prefixed by their respective types in the response + /// + /// Specify whether aggregation and suggester names should be prefixed by their respective types in the response + /// /// [JsonIgnore] public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } /// - /// Blocks and waits until the search is completed up to a certain timeout.
When the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster. + /// + /// Blocks and waits until the search is completed up to a certain timeout. + /// When the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? WaitForCompletionTimeout { get => Q("wait_for_completion_timeout"); set => Q("wait_for_completion_timeout", value); } @@ -795,31 +923,45 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Indices? indices) public Elastic.Clients.Elasticsearch.Core.Search.FieldCollapse? Collapse { get; set; } /// - /// Array of wildcard (*) patterns. The request returns doc values for field
names matching these patterns in the hits.fields property of the response. + /// + /// Array of wildcard (*) patterns. The request returns doc values for field + /// names matching these patterns in the hits.fields property of the response. + /// /// [JsonInclude, JsonPropertyName("docvalue_fields")] public ICollection? DocvalueFields { get; set; } /// - /// If true, returns detailed information about score computation as part of a hit. + /// + /// If true, returns detailed information about score computation as part of a hit. + /// /// [JsonInclude, JsonPropertyName("explain")] public bool? Explain { get; set; } /// - /// Configuration of search extensions defined by Elasticsearch plugins. + /// + /// Configuration of search extensions defined by Elasticsearch plugins. + /// /// [JsonInclude, JsonPropertyName("ext")] public IDictionary? Ext { get; set; } /// - /// Array of wildcard (*) patterns. The request returns values for field names
matching these patterns in the hits.fields property of the response. + /// + /// Array of wildcard (*) patterns. The request returns values for field names + /// matching these patterns in the hits.fields property of the response. + /// /// [JsonInclude, JsonPropertyName("fields")] public ICollection? Fields { get; set; } /// - /// Starting document offset. By default, you cannot page through more than 10,000
hits using the from and size parameters. To page through more hits, use the
search_after parameter. + /// + /// Starting document offset. By default, you cannot page through more than 10,000 + /// hits using the from and size parameters. To page through more hits, use the + /// search_after parameter. + /// /// [JsonInclude, JsonPropertyName("from")] public int? From { get; set; } @@ -827,26 +969,36 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Indices? indices) public Elastic.Clients.Elasticsearch.Core.Search.Highlight? Highlight { get; set; } /// - /// Boosts the _score of documents from specified indices. + /// + /// Boosts the _score of documents from specified indices. + /// /// [JsonInclude, JsonPropertyName("indices_boost")] public ICollection>? IndicesBoost { get; set; } /// - /// Defines the approximate kNN search to run. + /// + /// Defines the approximate kNN search to run. + /// /// [JsonInclude, JsonPropertyName("knn")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.KnnSearch))] public ICollection? Knn { get; set; } /// - /// Minimum _score for matching documents. Documents with a lower _score are
not included in the search results. + /// + /// Minimum _score for matching documents. Documents with a lower _score are + /// not included in the search results. + /// /// [JsonInclude, JsonPropertyName("min_score")] public double? MinScore { get; set; } /// - /// Limits the search to a point in time (PIT). If you provide a PIT, you
cannot specify an in the request path. + /// + /// Limits the search to a point in time (PIT). If you provide a PIT, you + /// cannot specify an <index> in the request path. + /// /// [JsonInclude, JsonPropertyName("pit")] public Elastic.Clients.Elasticsearch.Core.Search.PointInTimeReference? Pit { get; set; } @@ -856,7 +1008,9 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Indices? indices) public bool? Profile { get; set; } /// - /// Defines the search definition using the Query DSL. + /// + /// Defines the search definition using the Query DSL. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Query { get; set; } @@ -865,13 +1019,18 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Indices? indices) public ICollection? Rescore { get; set; } /// - /// Defines one or more runtime fields in the search request. These fields take
precedence over mapped fields with the same name. + /// + /// Defines one or more runtime fields in the search request. These fields take + /// precedence over mapped fields with the same name. + /// /// [JsonInclude, JsonPropertyName("runtime_mappings")] public IDictionary? RuntimeMappings { get; set; } /// - /// Retrieve a script evaluation (based on different fields) for each hit. + /// + /// Retrieve a script evaluation (based on different fields) for each hit. + /// /// [JsonInclude, JsonPropertyName("script_fields")] public IDictionary? ScriptFields { get; set; } @@ -879,13 +1038,20 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Indices? indices) public ICollection? SearchAfter { get; set; } /// - /// If true, returns sequence number and primary term of the last modification
of each hit. See Optimistic concurrency control. + /// + /// If true, returns sequence number and primary term of the last modification + /// of each hit. See Optimistic concurrency control. + /// /// [JsonInclude, JsonPropertyName("seq_no_primary_term")] public bool? SeqNoPrimaryTerm { get; set; } /// - /// The number of hits to return. By default, you cannot page through more
than 10,000 hits using the from and size parameters. To page through more
hits, use the search_after parameter. + /// + /// The number of hits to return. By default, you cannot page through more + /// than 10,000 hits using the from and size parameters. To page through more + /// hits, use the search_after parameter. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } @@ -896,19 +1062,31 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Indices? indices) public ICollection? Sort { get; set; } /// - /// Indicates which source fields are returned for matching documents. These
fields are returned in the hits._source property of the search response. + /// + /// Indicates which source fields are returned for matching documents. These + /// fields are returned in the hits._source property of the search response. + /// /// [JsonInclude, JsonPropertyName("_source")] public Elastic.Clients.Elasticsearch.Core.Search.SourceConfig? Source { get; set; } /// - /// Stats groups to associate with the search. Each group maintains a statistics
aggregation for its associated searches. You can retrieve these stats using
the indices stats API. + /// + /// Stats groups to associate with the search. Each group maintains a statistics + /// aggregation for its associated searches. You can retrieve these stats using + /// the indices stats API. + /// /// [JsonInclude, JsonPropertyName("stats")] public ICollection? Stats { get; set; } /// - /// List of stored fields to return as part of a hit. If no fields are specified,
no stored fields are included in the response. If this field is specified, the _source
parameter defaults to false. You can pass _source: true to return both source fields
and stored fields in the search response. + /// + /// List of stored fields to return as part of a hit. If no fields are specified, + /// no stored fields are included in the response. If this field is specified, the _source + /// parameter defaults to false. You can pass _source: true to return both source fields + /// and stored fields in the search response. + /// /// [JsonInclude, JsonPropertyName("stored_fields")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] @@ -917,38 +1095,61 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Indices? indices) public Elastic.Clients.Elasticsearch.Core.Search.Suggester? Suggest { get; set; } /// - /// Maximum number of documents to collect for each shard. If a query reaches this
limit, Elasticsearch terminates the query early. Elasticsearch collects documents
before sorting. Defaults to 0, which does not terminate query execution early. + /// + /// Maximum number of documents to collect for each shard. If a query reaches this + /// limit, Elasticsearch terminates the query early. Elasticsearch collects documents + /// before sorting. Defaults to 0, which does not terminate query execution early. + /// /// [JsonInclude, JsonPropertyName("terminate_after")] public long? TerminateAfter { get; set; } /// - /// Specifies the period of time to wait for a response from each shard. If no response
is received before the timeout expires, the request fails and returns an error.
Defaults to no timeout. + /// + /// Specifies the period of time to wait for a response from each shard. If no response + /// is received before the timeout expires, the request fails and returns an error. + /// Defaults to no timeout. + /// /// [JsonInclude, JsonPropertyName("timeout")] public string? Timeout { get; set; } /// - /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// + /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// /// [JsonInclude, JsonPropertyName("track_scores")] public bool? TrackScores { get; set; } /// - /// Number of hits matching the query to count accurately. If true, the exact
number of hits is returned at the cost of some performance. If false, the
response does not include the total number of hits matching the query.
Defaults to 10,000 hits. + /// + /// Number of hits matching the query to count accurately. If true, the exact + /// number of hits is returned at the cost of some performance. If false, the + /// response does not include the total number of hits matching the query. + /// Defaults to 10,000 hits. + /// /// [JsonInclude, JsonPropertyName("track_total_hits")] public Elastic.Clients.Elasticsearch.Core.Search.TrackHits? TrackTotalHits { get; set; } /// - /// If true, returns document version as part of a hit. + /// + /// If true, returns document version as part of a hit. + /// /// [JsonInclude, JsonPropertyName("version")] public bool? Version { get; set; } } /// -/// Runs a search request asynchronously.
When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.
Warning: Async search does not support scroll nor search requests that only include the suggest section.
By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. +/// +/// Runs a search request asynchronously. +/// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. +/// Warning: Async search does not support scroll nor search requests that only include the suggest section. +/// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. +/// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. +/// /// public sealed partial class SubmitAsyncSearchRequestDescriptor : RequestDescriptor, SubmitAsyncSearchRequestParameters> { @@ -1102,7 +1303,10 @@ public SubmitAsyncSearchRequestDescriptor Collapse(Action - /// Array of wildcard (*) patterns. The request returns doc values for field
names matching these patterns in the hits.fields property of the response. + /// + /// Array of wildcard (*) patterns. The request returns doc values for field + /// names matching these patterns in the hits.fields property of the response. + /// /// public SubmitAsyncSearchRequestDescriptor DocvalueFields(ICollection? docvalueFields) { @@ -1141,7 +1345,9 @@ public SubmitAsyncSearchRequestDescriptor DocvalueFields(params Actio } /// - /// If true, returns detailed information about score computation as part of a hit. + /// + /// If true, returns detailed information about score computation as part of a hit. + /// /// public SubmitAsyncSearchRequestDescriptor Explain(bool? explain = true) { @@ -1150,7 +1356,9 @@ public SubmitAsyncSearchRequestDescriptor Explain(bool? explain = tru } /// - /// Configuration of search extensions defined by Elasticsearch plugins. + /// + /// Configuration of search extensions defined by Elasticsearch plugins. + /// /// public SubmitAsyncSearchRequestDescriptor Ext(Func, FluentDictionary> selector) { @@ -1159,7 +1367,10 @@ public SubmitAsyncSearchRequestDescriptor Ext(Func - /// Array of wildcard (*) patterns. The request returns values for field names
matching these patterns in the hits.fields property of the response. + /// + /// Array of wildcard (*) patterns. The request returns values for field names + /// matching these patterns in the hits.fields property of the response. + /// /// public SubmitAsyncSearchRequestDescriptor Fields(ICollection? fields) { @@ -1198,7 +1409,11 @@ public SubmitAsyncSearchRequestDescriptor Fields(params Action - /// Starting document offset. By default, you cannot page through more than 10,000
hits using the from and size parameters. To page through more hits, use the
search_after parameter. + /// + /// Starting document offset. By default, you cannot page through more than 10,000 + /// hits using the from and size parameters. To page through more hits, use the + /// search_after parameter. + /// /// public SubmitAsyncSearchRequestDescriptor From(int? from) { @@ -1231,7 +1446,9 @@ public SubmitAsyncSearchRequestDescriptor Highlight(Action - /// Boosts the _score of documents from specified indices. + /// + /// Boosts the _score of documents from specified indices. + /// /// public SubmitAsyncSearchRequestDescriptor IndicesBoost(ICollection>? indicesBoost) { @@ -1240,7 +1457,9 @@ public SubmitAsyncSearchRequestDescriptor IndicesBoost(ICollection - /// Defines the approximate kNN search to run. + /// + /// Defines the approximate kNN search to run. + /// /// public SubmitAsyncSearchRequestDescriptor Knn(ICollection? knn) { @@ -1279,7 +1498,10 @@ public SubmitAsyncSearchRequestDescriptor Knn(params Action - /// Minimum _score for matching documents. Documents with a lower _score are
not included in the search results. + /// + /// Minimum _score for matching documents. Documents with a lower _score are + /// not included in the search results. + /// /// public SubmitAsyncSearchRequestDescriptor MinScore(double? minScore) { @@ -1288,7 +1510,10 @@ public SubmitAsyncSearchRequestDescriptor MinScore(double? minScore) } /// - /// Limits the search to a point in time (PIT). If you provide a PIT, you
cannot specify an in the request path. + /// + /// Limits the search to a point in time (PIT). If you provide a PIT, you + /// cannot specify an <index> in the request path. + /// /// public SubmitAsyncSearchRequestDescriptor Pit(Elastic.Clients.Elasticsearch.Core.Search.PointInTimeReference? pit) { @@ -1345,7 +1570,9 @@ public SubmitAsyncSearchRequestDescriptor Profile(bool? profile = tru } /// - /// Defines the search definition using the Query DSL. + /// + /// Defines the search definition using the Query DSL. + /// /// public SubmitAsyncSearchRequestDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -1408,7 +1635,10 @@ public SubmitAsyncSearchRequestDescriptor Rescore(params Action - /// Defines one or more runtime fields in the search request. These fields take
precedence over mapped fields with the same name. + /// + /// Defines one or more runtime fields in the search request. These fields take + /// precedence over mapped fields with the same name. + /// /// public SubmitAsyncSearchRequestDescriptor RuntimeMappings(Func>, FluentDescriptorDictionary>> selector) { @@ -1417,7 +1647,9 @@ public SubmitAsyncSearchRequestDescriptor RuntimeMappings(Func - /// Retrieve a script evaluation (based on different fields) for each hit. + /// + /// Retrieve a script evaluation (based on different fields) for each hit. + /// /// public SubmitAsyncSearchRequestDescriptor ScriptFields(Func, FluentDescriptorDictionary> selector) { @@ -1432,7 +1664,10 @@ public SubmitAsyncSearchRequestDescriptor SearchAfter(ICollection - /// If true, returns sequence number and primary term of the last modification
of each hit. See Optimistic concurrency control. + /// + /// If true, returns sequence number and primary term of the last modification + /// of each hit. See Optimistic concurrency control. + /// /// public SubmitAsyncSearchRequestDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = true) { @@ -1441,7 +1676,11 @@ public SubmitAsyncSearchRequestDescriptor SeqNoPrimaryTerm(bool? seqN } /// - /// The number of hits to return. By default, you cannot page through more
than 10,000 hits using the from and size parameters. To page through more
hits, use the search_after parameter. + /// + /// The number of hits to return. By default, you cannot page through more + /// than 10,000 hits using the from and size parameters. To page through more + /// hits, use the search_after parameter. + /// /// public SubmitAsyncSearchRequestDescriptor Size(int? size) { @@ -1510,7 +1749,10 @@ public SubmitAsyncSearchRequestDescriptor Sort(params Action - /// Indicates which source fields are returned for matching documents. These
fields are returned in the hits._source property of the search response. + /// + /// Indicates which source fields are returned for matching documents. These + /// fields are returned in the hits._source property of the search response. + /// /// public SubmitAsyncSearchRequestDescriptor Source(Elastic.Clients.Elasticsearch.Core.Search.SourceConfig? source) { @@ -1519,7 +1761,11 @@ public SubmitAsyncSearchRequestDescriptor Source(Elastic.Clients.Elas } /// - /// Stats groups to associate with the search. Each group maintains a statistics
aggregation for its associated searches. You can retrieve these stats using
the indices stats API. + /// + /// Stats groups to associate with the search. Each group maintains a statistics + /// aggregation for its associated searches. You can retrieve these stats using + /// the indices stats API. + /// /// public SubmitAsyncSearchRequestDescriptor Stats(ICollection? stats) { @@ -1528,7 +1774,12 @@ public SubmitAsyncSearchRequestDescriptor Stats(ICollection? } /// - /// List of stored fields to return as part of a hit. If no fields are specified,
no stored fields are included in the response. If this field is specified, the _source
parameter defaults to false. You can pass _source: true to return both source fields
and stored fields in the search response. + /// + /// List of stored fields to return as part of a hit. If no fields are specified, + /// no stored fields are included in the response. If this field is specified, the _source + /// parameter defaults to false. You can pass _source: true to return both source fields + /// and stored fields in the search response. + /// /// public SubmitAsyncSearchRequestDescriptor StoredFields(Elastic.Clients.Elasticsearch.Fields? storedFields) { @@ -1561,7 +1812,11 @@ public SubmitAsyncSearchRequestDescriptor Suggest(Action - /// Maximum number of documents to collect for each shard. If a query reaches this
limit, Elasticsearch terminates the query early. Elasticsearch collects documents
before sorting. Defaults to 0, which does not terminate query execution early. + /// + /// Maximum number of documents to collect for each shard. If a query reaches this + /// limit, Elasticsearch terminates the query early. Elasticsearch collects documents + /// before sorting. Defaults to 0, which does not terminate query execution early. + /// /// public SubmitAsyncSearchRequestDescriptor TerminateAfter(long? terminateAfter) { @@ -1570,7 +1825,11 @@ public SubmitAsyncSearchRequestDescriptor TerminateAfter(long? termin } /// - /// Specifies the period of time to wait for a response from each shard. If no response
is received before the timeout expires, the request fails and returns an error.
Defaults to no timeout. + /// + /// Specifies the period of time to wait for a response from each shard. If no response + /// is received before the timeout expires, the request fails and returns an error. + /// Defaults to no timeout. + /// /// public SubmitAsyncSearchRequestDescriptor Timeout(string? timeout) { @@ -1579,7 +1838,9 @@ public SubmitAsyncSearchRequestDescriptor Timeout(string? timeout) } /// - /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// + /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// /// public SubmitAsyncSearchRequestDescriptor TrackScores(bool? trackScores = true) { @@ -1588,7 +1849,12 @@ public SubmitAsyncSearchRequestDescriptor TrackScores(bool? trackScor } /// - /// Number of hits matching the query to count accurately. If true, the exact
number of hits is returned at the cost of some performance. If false, the
response does not include the total number of hits matching the query.
Defaults to 10,000 hits. + /// + /// Number of hits matching the query to count accurately. If true, the exact + /// number of hits is returned at the cost of some performance. If false, the + /// response does not include the total number of hits matching the query. + /// Defaults to 10,000 hits. + /// /// public SubmitAsyncSearchRequestDescriptor TrackTotalHits(Elastic.Clients.Elasticsearch.Core.Search.TrackHits? trackTotalHits) { @@ -1597,7 +1863,9 @@ public SubmitAsyncSearchRequestDescriptor TrackTotalHits(Elastic.Clie } /// - /// If true, returns document version as part of a hit. + /// + /// If true, returns document version as part of a hit. + /// /// public SubmitAsyncSearchRequestDescriptor Version(bool? version = true) { @@ -1994,7 +2262,13 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Runs a search request asynchronously.
When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.
Warning: Async search does not support scroll nor search requests that only include the suggest section.
By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. +/// +/// Runs a search request asynchronously. +/// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. +/// Warning: Async search does not support scroll nor search requests that only include the suggest section. +/// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. +/// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. +/// /// public sealed partial class SubmitAsyncSearchRequestDescriptor : RequestDescriptor { @@ -2148,7 +2422,10 @@ public SubmitAsyncSearchRequestDescriptor Collapse(Action - /// Array of wildcard (*) patterns. The request returns doc values for field
names matching these patterns in the hits.fields property of the response. + /// + /// Array of wildcard (*) patterns. The request returns doc values for field + /// names matching these patterns in the hits.fields property of the response. + /// /// public SubmitAsyncSearchRequestDescriptor DocvalueFields(ICollection? docvalueFields) { @@ -2187,7 +2464,9 @@ public SubmitAsyncSearchRequestDescriptor DocvalueFields(params Action - /// If true, returns detailed information about score computation as part of a hit. + /// + /// If true, returns detailed information about score computation as part of a hit. + /// /// public SubmitAsyncSearchRequestDescriptor Explain(bool? explain = true) { @@ -2196,7 +2475,9 @@ public SubmitAsyncSearchRequestDescriptor Explain(bool? explain = true) } /// - /// Configuration of search extensions defined by Elasticsearch plugins. + /// + /// Configuration of search extensions defined by Elasticsearch plugins. + /// /// public SubmitAsyncSearchRequestDescriptor Ext(Func, FluentDictionary> selector) { @@ -2205,7 +2486,10 @@ public SubmitAsyncSearchRequestDescriptor Ext(Func - /// Array of wildcard (*) patterns. The request returns values for field names
matching these patterns in the hits.fields property of the response. + /// + /// Array of wildcard (*) patterns. The request returns values for field names + /// matching these patterns in the hits.fields property of the response. + /// /// public SubmitAsyncSearchRequestDescriptor Fields(ICollection? fields) { @@ -2244,7 +2528,11 @@ public SubmitAsyncSearchRequestDescriptor Fields(params Action - /// Starting document offset. By default, you cannot page through more than 10,000
hits using the from and size parameters. To page through more hits, use the
search_after parameter. + /// + /// Starting document offset. By default, you cannot page through more than 10,000 + /// hits using the from and size parameters. To page through more hits, use the + /// search_after parameter. + /// /// public SubmitAsyncSearchRequestDescriptor From(int? from) { @@ -2277,7 +2565,9 @@ public SubmitAsyncSearchRequestDescriptor Highlight(Action - /// Boosts the _score of documents from specified indices. + /// + /// Boosts the _score of documents from specified indices. + /// /// public SubmitAsyncSearchRequestDescriptor IndicesBoost(ICollection>? indicesBoost) { @@ -2286,7 +2576,9 @@ public SubmitAsyncSearchRequestDescriptor IndicesBoost(ICollection - /// Defines the approximate kNN search to run. + /// + /// Defines the approximate kNN search to run. + /// /// public SubmitAsyncSearchRequestDescriptor Knn(ICollection? knn) { @@ -2325,7 +2617,10 @@ public SubmitAsyncSearchRequestDescriptor Knn(params Action - /// Minimum _score for matching documents. Documents with a lower _score are
not included in the search results. + /// + /// Minimum _score for matching documents. Documents with a lower _score are + /// not included in the search results. + /// /// public SubmitAsyncSearchRequestDescriptor MinScore(double? minScore) { @@ -2334,7 +2629,10 @@ public SubmitAsyncSearchRequestDescriptor MinScore(double? minScore) } /// - /// Limits the search to a point in time (PIT). If you provide a PIT, you
cannot specify an in the request path. + /// + /// Limits the search to a point in time (PIT). If you provide a PIT, you + /// cannot specify an <index> in the request path. + /// /// public SubmitAsyncSearchRequestDescriptor Pit(Elastic.Clients.Elasticsearch.Core.Search.PointInTimeReference? pit) { @@ -2391,7 +2689,9 @@ public SubmitAsyncSearchRequestDescriptor Profile(bool? profile = true) } /// - /// Defines the search definition using the Query DSL. + /// + /// Defines the search definition using the Query DSL. + /// /// public SubmitAsyncSearchRequestDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -2454,7 +2754,10 @@ public SubmitAsyncSearchRequestDescriptor Rescore(params Action - /// Defines one or more runtime fields in the search request. These fields take
precedence over mapped fields with the same name. + /// + /// Defines one or more runtime fields in the search request. These fields take + /// precedence over mapped fields with the same name. + /// /// public SubmitAsyncSearchRequestDescriptor RuntimeMappings(Func, FluentDescriptorDictionary> selector) { @@ -2463,7 +2766,9 @@ public SubmitAsyncSearchRequestDescriptor RuntimeMappings(Func - /// Retrieve a script evaluation (based on different fields) for each hit. + /// + /// Retrieve a script evaluation (based on different fields) for each hit. + /// /// public SubmitAsyncSearchRequestDescriptor ScriptFields(Func, FluentDescriptorDictionary> selector) { @@ -2478,7 +2783,10 @@ public SubmitAsyncSearchRequestDescriptor SearchAfter(ICollection - /// If true, returns sequence number and primary term of the last modification
of each hit. See Optimistic concurrency control. + /// + /// If true, returns sequence number and primary term of the last modification + /// of each hit. See Optimistic concurrency control. + /// /// public SubmitAsyncSearchRequestDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = true) { @@ -2487,7 +2795,11 @@ public SubmitAsyncSearchRequestDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTer } /// - /// The number of hits to return. By default, you cannot page through more
than 10,000 hits using the from and size parameters. To page through more
hits, use the search_after parameter. + /// + /// The number of hits to return. By default, you cannot page through more + /// than 10,000 hits using the from and size parameters. To page through more + /// hits, use the search_after parameter. + /// /// public SubmitAsyncSearchRequestDescriptor Size(int? size) { @@ -2556,7 +2868,10 @@ public SubmitAsyncSearchRequestDescriptor Sort(params Action - /// Indicates which source fields are returned for matching documents. These
fields are returned in the hits._source property of the search response. + /// + /// Indicates which source fields are returned for matching documents. These + /// fields are returned in the hits._source property of the search response. + /// /// public SubmitAsyncSearchRequestDescriptor Source(Elastic.Clients.Elasticsearch.Core.Search.SourceConfig? source) { @@ -2565,7 +2880,11 @@ public SubmitAsyncSearchRequestDescriptor Source(Elastic.Clients.Elasticsearch.C } /// - /// Stats groups to associate with the search. Each group maintains a statistics
aggregation for its associated searches. You can retrieve these stats using
the indices stats API. + /// + /// Stats groups to associate with the search. Each group maintains a statistics + /// aggregation for its associated searches. You can retrieve these stats using + /// the indices stats API. + /// /// public SubmitAsyncSearchRequestDescriptor Stats(ICollection? stats) { @@ -2574,7 +2893,12 @@ public SubmitAsyncSearchRequestDescriptor Stats(ICollection? stats) } /// - /// List of stored fields to return as part of a hit. If no fields are specified,
no stored fields are included in the response. If this field is specified, the _source
parameter defaults to false. You can pass _source: true to return both source fields
and stored fields in the search response. + /// + /// List of stored fields to return as part of a hit. If no fields are specified, + /// no stored fields are included in the response. If this field is specified, the _source + /// parameter defaults to false. You can pass _source: true to return both source fields + /// and stored fields in the search response. + /// /// public SubmitAsyncSearchRequestDescriptor StoredFields(Elastic.Clients.Elasticsearch.Fields? storedFields) { @@ -2607,7 +2931,11 @@ public SubmitAsyncSearchRequestDescriptor Suggest(Action - /// Maximum number of documents to collect for each shard. If a query reaches this
limit, Elasticsearch terminates the query early. Elasticsearch collects documents
before sorting. Defaults to 0, which does not terminate query execution early. + /// + /// Maximum number of documents to collect for each shard. If a query reaches this + /// limit, Elasticsearch terminates the query early. Elasticsearch collects documents + /// before sorting. Defaults to 0, which does not terminate query execution early. + /// /// public SubmitAsyncSearchRequestDescriptor TerminateAfter(long? terminateAfter) { @@ -2616,7 +2944,11 @@ public SubmitAsyncSearchRequestDescriptor TerminateAfter(long? terminateAfter) } /// - /// Specifies the period of time to wait for a response from each shard. If no response
is received before the timeout expires, the request fails and returns an error.
Defaults to no timeout. + /// + /// Specifies the period of time to wait for a response from each shard. If no response + /// is received before the timeout expires, the request fails and returns an error. + /// Defaults to no timeout. + /// /// public SubmitAsyncSearchRequestDescriptor Timeout(string? timeout) { @@ -2625,7 +2957,9 @@ public SubmitAsyncSearchRequestDescriptor Timeout(string? timeout) } /// - /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// + /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// /// public SubmitAsyncSearchRequestDescriptor TrackScores(bool? trackScores = true) { @@ -2634,7 +2968,12 @@ public SubmitAsyncSearchRequestDescriptor TrackScores(bool? trackScores = true) } /// - /// Number of hits matching the query to count accurately. If true, the exact
number of hits is returned at the cost of some performance. If false, the
response does not include the total number of hits matching the query.
Defaults to 10,000 hits. + /// + /// Number of hits matching the query to count accurately. If true, the exact + /// number of hits is returned at the cost of some performance. If false, the + /// response does not include the total number of hits matching the query. + /// Defaults to 10,000 hits. + /// /// public SubmitAsyncSearchRequestDescriptor TrackTotalHits(Elastic.Clients.Elasticsearch.Core.Search.TrackHits? trackTotalHits) { @@ -2643,7 +2982,9 @@ public SubmitAsyncSearchRequestDescriptor TrackTotalHits(Elastic.Clients.Elastic } /// - /// If true, returns document version as part of a hit. + /// + /// If true, returns document version as part of a hit. + /// /// public SubmitAsyncSearchRequestDescriptor Version(bool? version = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/SubmitAsyncSearchResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/SubmitAsyncSearchResponse.g.cs index d8390b2f137..1eaf8d1c848 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/SubmitAsyncSearchResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/SubmitAsyncSearchResponse.g.cs @@ -29,7 +29,10 @@ namespace Elastic.Clients.Elasticsearch.AsyncSearch; public sealed partial class SubmitAsyncSearchResponse : ElasticsearchResponse { /// - /// Indicates when the async search completed. Only present
when the search has completed. + /// + /// Indicates when the async search completed. Only present + /// when the search has completed. + /// /// [JsonInclude, JsonPropertyName("completion_time")] public DateTimeOffset? CompletionTime { get; init; } @@ -37,7 +40,9 @@ public sealed partial class SubmitAsyncSearchResponse : Elasticsearch public long? CompletionTimeInMillis { get; init; } /// - /// Indicates when the async search will expire. + /// + /// Indicates when the async search will expire. + /// /// [JsonInclude, JsonPropertyName("expiration_time")] public DateTimeOffset? ExpirationTime { get; init; } @@ -47,13 +52,19 @@ public sealed partial class SubmitAsyncSearchResponse : Elasticsearch public string? Id { get; init; } /// - /// When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards.
While the query is running, `is_partial` is always set to `true`. + /// + /// When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards. + /// While the query is running, is_partial is always set to true. + /// /// [JsonInclude, JsonPropertyName("is_partial")] public bool IsPartial { get; init; } /// - /// Indicates whether the search is still running or has completed.
NOTE: If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though `is_running` is `false`. + /// + /// Indicates whether the search is still running or has completed. + /// NOTE: If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though is_running is false. + /// /// [JsonInclude, JsonPropertyName("is_running")] public bool IsRunning { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/BulkRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/BulkRequest.g.cs index 5f92de78d1b..fb0fce6ca19 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/BulkRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/BulkRequest.g.cs @@ -32,53 +32,79 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class BulkRequestParameters : RequestParameters { /// - /// ID of the pipeline to use to preprocess incoming documents.
If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.
If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// + /// ID of the pipeline to use to preprocess incoming documents. + /// If the index has a default ingest pipeline specified, then setting the value to _none disables the default ingest pipeline for this request. + /// If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// /// public string? Pipeline { get => Q("pipeline"); set => Q("pipeline", value); } /// - /// If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.
Valid values: `true`, `false`, `wait_for`. + /// + /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false do nothing with refreshes. + /// Valid values: true, false, wait_for. + /// /// public Elastic.Clients.Elasticsearch.Refresh? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// If `true`, the request’s actions must target an index alias. + /// + /// If true, the request’s actions must target an index alias. + /// /// public bool? RequireAlias { get => Q("require_alias"); set => Q("require_alias", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// `true` or `false` to return the `_source` field or not, or a list of fields to return. + /// + /// true or false to return the _source field or not, or a list of fields to return. + /// /// public Elastic.Clients.Elasticsearch.Core.Search.SourceConfigParam? Source { get => Q("_source"); set => Q("_source", value); } /// - /// A comma-separated list of source fields to exclude from the response. + /// + /// A comma-separated list of source fields to exclude from the response. + /// /// public Elastic.Clients.Elasticsearch.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response. + /// + /// A comma-separated list of source fields to include in the response. + /// /// public Elastic.Clients.Elasticsearch.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// Period each action waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. + /// + /// Period each action waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. +/// +/// Bulk index or delete documents. +/// Performs multiple indexing or delete operations in a single API call. +/// This reduces overhead and can greatly increase indexing speed. +/// /// public sealed partial class BulkRequest : PlainRequest { @@ -99,62 +125,88 @@ public BulkRequest(Elastic.Clients.Elasticsearch.IndexName? index) : base(r => r internal override string OperationName => "bulk"; /// - /// ID of the pipeline to use to preprocess incoming documents.
If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.
If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// + /// ID of the pipeline to use to preprocess incoming documents. + /// If the index has a default ingest pipeline specified, then setting the value to _none disables the default ingest pipeline for this request. + /// If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// /// [JsonIgnore] public string? Pipeline { get => Q("pipeline"); set => Q("pipeline", value); } /// - /// If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.
Valid values: `true`, `false`, `wait_for`. + /// + /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false do nothing with refreshes. + /// Valid values: true, false, wait_for. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Refresh? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// If `true`, the request’s actions must target an index alias. + /// + /// If true, the request’s actions must target an index alias. + /// /// [JsonIgnore] public bool? RequireAlias { get => Q("require_alias"); set => Q("require_alias", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// `true` or `false` to return the `_source` field or not, or a list of fields to return. + /// + /// true or false to return the _source field or not, or a list of fields to return. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Core.Search.SourceConfigParam? Source { get => Q("_source"); set => Q("_source", value); } /// - /// A comma-separated list of source fields to exclude from the response. + /// + /// A comma-separated list of source fields to exclude from the response. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response. + /// + /// A comma-separated list of source fields to include in the response. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// Period each action waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. + /// + /// Period each action waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. +/// +/// Bulk index or delete documents. +/// Performs multiple indexing or delete operations in a single API call. +/// This reduces overhead and can greatly increase indexing speed. +/// /// public sealed partial class BulkRequestDescriptor : RequestDescriptor, BulkRequestParameters> { @@ -200,7 +252,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. +/// +/// Bulk index or delete documents. +/// Performs multiple indexing or delete operations in a single API call. +/// This reduces overhead and can greatly increase indexing speed. +/// /// public sealed partial class BulkRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ClearScrollRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ClearScrollRequest.g.cs index 70e13422a01..e67018e2e3e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ClearScrollRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ClearScrollRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class ClearScrollRequestParameters : RequestParameters } /// -/// Clears the search context and results for a scrolling search. +/// +/// Clears the search context and results for a scrolling search. +/// /// public sealed partial class ClearScrollRequest : PlainRequest { @@ -47,14 +49,19 @@ public sealed partial class ClearScrollRequest : PlainRequest "clear_scroll"; /// - /// Scroll IDs to clear.
To clear all scroll IDs, use `_all`. + /// + /// Scroll IDs to clear. + /// To clear all scroll IDs, use _all. + /// /// [JsonInclude, JsonPropertyName("scroll_id")] public Elastic.Clients.Elasticsearch.ScrollIds? ScrollId { get; set; } } /// -/// Clears the search context and results for a scrolling search. +/// +/// Clears the search context and results for a scrolling search. +/// /// public sealed partial class ClearScrollRequestDescriptor : RequestDescriptor { @@ -75,7 +82,10 @@ public ClearScrollRequestDescriptor() private Elastic.Clients.Elasticsearch.ScrollIds? ScrollIdValue { get; set; } /// - /// Scroll IDs to clear.
To clear all scroll IDs, use `_all`. + /// + /// Scroll IDs to clear. + /// To clear all scroll IDs, use _all. + /// /// public ClearScrollRequestDescriptor ScrollId(Elastic.Clients.Elasticsearch.ScrollIds? scrollId) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ClosePointInTimeRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ClosePointInTimeRequest.g.cs index 254120c9e3b..6dcfca5220e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ClosePointInTimeRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ClosePointInTimeRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class ClosePointInTimeRequestParameters : RequestParameter } /// -/// Closes a point-in-time. +/// +/// Closes a point-in-time. +/// /// public sealed partial class ClosePointInTimeRequest : PlainRequest { @@ -47,14 +49,18 @@ public sealed partial class ClosePointInTimeRequest : PlainRequest "close_point_in_time"; /// - /// The ID of the point-in-time. + /// + /// The ID of the point-in-time. + /// /// [JsonInclude, JsonPropertyName("id")] public Elastic.Clients.Elasticsearch.Id Id { get; set; } } /// -/// Closes a point-in-time. +/// +/// Closes a point-in-time. +/// /// public sealed partial class ClosePointInTimeRequestDescriptor : RequestDescriptor { @@ -75,7 +81,9 @@ public ClosePointInTimeRequestDescriptor() private Elastic.Clients.Elasticsearch.Id IdValue { get; set; } /// - /// The ID of the point-in-time. + /// + /// The ID of the point-in-time. + /// /// public ClosePointInTimeRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id id) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/AllocationExplainRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/AllocationExplainRequest.g.cs index c888ddee9b4..3d8ef87c0ac 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/AllocationExplainRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/AllocationExplainRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class AllocationExplainRequestParameters : RequestParameters { /// - /// If true, returns information about disk usage and shard sizes. + /// + /// If true, returns information about disk usage and shard sizes. + /// /// public bool? IncludeDiskInfo { get => Q("include_disk_info"); set => Q("include_disk_info", value); } /// - /// If true, returns YES decisions in explanation. + /// + /// If true, returns YES decisions in explanation. + /// /// public bool? IncludeYesDecisions { get => Q("include_yes_decisions"); set => Q("include_yes_decisions", value); } } /// -/// Provides explanations for shard allocations in the cluster. +/// +/// Provides explanations for shard allocations in the cluster. +/// /// public sealed partial class AllocationExplainRequest : PlainRequest { @@ -56,44 +62,58 @@ public sealed partial class AllocationExplainRequest : PlainRequest "cluster.allocation_explain"; /// - /// If true, returns information about disk usage and shard sizes. + /// + /// If true, returns information about disk usage and shard sizes. + /// /// [JsonIgnore] public bool? IncludeDiskInfo { get => Q("include_disk_info"); set => Q("include_disk_info", value); } /// - /// If true, returns YES decisions in explanation. + /// + /// If true, returns YES decisions in explanation. + /// /// [JsonIgnore] public bool? IncludeYesDecisions { get => Q("include_yes_decisions"); set => Q("include_yes_decisions", value); } /// - /// Specifies the node ID or the name of the node to only explain a shard that is currently located on the specified node. + /// + /// Specifies the node ID or the name of the node to only explain a shard that is currently located on the specified node. + /// /// [JsonInclude, JsonPropertyName("current_node")] public string? CurrentNode { get; set; } /// - /// Specifies the name of the index that you would like an explanation for. + /// + /// Specifies the name of the index that you would like an explanation for. + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.IndexName? Index { get; set; } /// - /// If true, returns explanation for the primary shard for the given shard ID. + /// + /// If true, returns explanation for the primary shard for the given shard ID. + /// /// [JsonInclude, JsonPropertyName("primary")] public bool? Primary { get; set; } /// - /// Specifies the ID of the shard that you would like an explanation for. + /// + /// Specifies the ID of the shard that you would like an explanation for. + /// /// [JsonInclude, JsonPropertyName("shard")] public int? Shard { get; set; } } /// -/// Provides explanations for shard allocations in the cluster. +/// +/// Provides explanations for shard allocations in the cluster. +/// /// public sealed partial class AllocationExplainRequestDescriptor : RequestDescriptor { @@ -120,7 +140,9 @@ public AllocationExplainRequestDescriptor() private int? ShardValue { get; set; } /// - /// Specifies the node ID or the name of the node to only explain a shard that is currently located on the specified node. + /// + /// Specifies the node ID or the name of the node to only explain a shard that is currently located on the specified node. + /// /// public AllocationExplainRequestDescriptor CurrentNode(string? currentNode) { @@ -129,7 +151,9 @@ public AllocationExplainRequestDescriptor CurrentNode(string? currentNode) } /// - /// Specifies the name of the index that you would like an explanation for. + /// + /// Specifies the name of the index that you would like an explanation for. + /// /// public AllocationExplainRequestDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? index) { @@ -138,7 +162,9 @@ public AllocationExplainRequestDescriptor Index(Elastic.Clients.Elasticsearch.In } /// - /// If true, returns explanation for the primary shard for the given shard ID. + /// + /// If true, returns explanation for the primary shard for the given shard ID. + /// /// public AllocationExplainRequestDescriptor Primary(bool? primary = true) { @@ -147,7 +173,9 @@ public AllocationExplainRequestDescriptor Primary(bool? primary = true) } /// - /// Specifies the ID of the shard that you would like an explanation for. + /// + /// Specifies the ID of the shard that you would like an explanation for. + /// /// public AllocationExplainRequestDescriptor Shard(int? shard) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/ClusterInfoRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/ClusterInfoRequest.g.cs index 16cff006eee..301cea990ba 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/ClusterInfoRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/ClusterInfoRequest.g.cs @@ -34,7 +34,10 @@ public sealed partial class ClusterInfoRequestParameters : RequestParameters } /// -/// Get cluster info.
Returns basic information about the cluster. +/// +/// Get cluster info. +/// Returns basic information about the cluster. +/// /// public sealed partial class ClusterInfoRequest : PlainRequest { @@ -52,7 +55,10 @@ public ClusterInfoRequest(IReadOnlyCollection -/// Get cluster info.
Returns basic information about the cluster. +/// +/// Get cluster info. +/// Returns basic information about the cluster. +/// /// public sealed partial class ClusterInfoRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/ClusterStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/ClusterStatsRequest.g.cs index 0b7230d2de1..848f867049c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/ClusterStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/ClusterStatsRequest.g.cs @@ -32,18 +32,27 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterStatsRequestParameters : RequestParameters { /// - /// If `true`, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// Period to wait for each node to respond.
If a node does not respond before its timeout expires, the response does not include its stats.
However, timed out nodes are included in the response’s `_nodes.failed` property. Defaults to no timeout. + /// + /// Period to wait for each node to respond. + /// If a node does not respond before its timeout expires, the response does not include its stats. + /// However, timed out nodes are included in the response’s _nodes.failed property. Defaults to no timeout. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Returns cluster statistics.
It returns 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). +/// +/// Returns cluster statistics. +/// It returns 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). +/// /// public sealed partial class ClusterStatsRequest : PlainRequest { @@ -64,20 +73,29 @@ public ClusterStatsRequest(Elastic.Clients.Elasticsearch.NodeIds? nodeId) : base internal override string OperationName => "cluster.stats"; /// - /// If `true`, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// [JsonIgnore] public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// Period to wait for each node to respond.
If a node does not respond before its timeout expires, the response does not include its stats.
However, timed out nodes are included in the response’s `_nodes.failed` property. Defaults to no timeout. + /// + /// Period to wait for each node to respond. + /// If a node does not respond before its timeout expires, the response does not include its stats. + /// However, timed out nodes are included in the response’s _nodes.failed property. Defaults to no timeout. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Returns cluster statistics.
It returns 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). +/// +/// Returns cluster statistics. +/// It returns 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). +/// /// public sealed partial class ClusterStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/ClusterStatsResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/ClusterStatsResponse.g.cs index e043c33c200..75d8dfb2977 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/ClusterStatsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/ClusterStatsResponse.g.cs @@ -29,43 +29,57 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterStatsResponse : ElasticsearchResponse { /// - /// Name of the cluster, based on the cluster name setting. + /// + /// Name of the cluster, based on the cluster name setting. + /// /// [JsonInclude, JsonPropertyName("cluster_name")] public string ClusterName { get; init; } /// - /// Unique identifier for the cluster. + /// + /// Unique identifier for the cluster. + /// /// [JsonInclude, JsonPropertyName("cluster_uuid")] public string ClusterUuid { get; init; } /// - /// Contains statistics about indices with shards assigned to selected nodes. + /// + /// Contains statistics about indices with shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("indices")] public Elastic.Clients.Elasticsearch.Cluster.ClusterIndices Indices { get; init; } /// - /// Contains statistics about nodes selected by the request’s node filters. + /// + /// Contains statistics about nodes selected by the request’s node filters. + /// /// [JsonInclude, JsonPropertyName("nodes")] public Elastic.Clients.Elasticsearch.Cluster.ClusterNodes Nodes { get; init; } /// - /// Contains statistics about the number of nodes selected by the request’s node filters. + /// + /// Contains statistics about the number of nodes selected by the request’s node filters. + /// /// [JsonInclude, JsonPropertyName("_nodes")] public Elastic.Clients.Elasticsearch.NodeStatistics? NodeStats { get; init; } /// - /// Health status of the cluster, based on the state of its primary and replica shards. + /// + /// Health status of the cluster, based on the state of its primary and replica shards. + /// /// [JsonInclude, JsonPropertyName("status")] public Elastic.Clients.Elasticsearch.HealthStatus Status { get; init; } /// - /// Unix timestamp, in milliseconds, for the last time the cluster statistics were refreshed. + /// + /// Unix timestamp, in milliseconds, for the last time the cluster statistics were refreshed. + /// /// [JsonInclude, JsonPropertyName("timestamp")] public long Timestamp { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/DeleteComponentTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/DeleteComponentTemplateRequest.g.cs index dc23512fb4a..32f6d69ab35 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/DeleteComponentTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/DeleteComponentTemplateRequest.g.cs @@ -32,18 +32,28 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class DeleteComponentTemplateRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete component templates.
Deletes component templates.
Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. +/// +/// Delete component templates. +/// Deletes component templates. +/// Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. +/// /// public sealed partial class DeleteComponentTemplateRequest : PlainRequest { @@ -60,20 +70,30 @@ public DeleteComponentTemplateRequest(Elastic.Clients.Elasticsearch.Names name) internal override string OperationName => "cluster.delete_component_template"; /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete component templates.
Deletes component templates.
Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. +/// +/// Delete component templates. +/// Deletes component templates. +/// Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. +/// /// public sealed partial class DeleteComponentTemplateRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/DeleteComponentTemplateResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/DeleteComponentTemplateResponse.g.cs index dbecd33c1cf..7f8b65c9cbe 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/DeleteComponentTemplateResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/DeleteComponentTemplateResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class DeleteComponentTemplateResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/DeleteVotingConfigExclusionsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/DeleteVotingConfigExclusionsRequest.g.cs index bef3fa3ee28..e5b72a01db5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/DeleteVotingConfigExclusionsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/DeleteVotingConfigExclusionsRequest.g.cs @@ -32,13 +32,22 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class DeleteVotingConfigExclusionsRequestParameters : RequestParameters { /// - /// Specifies whether to wait for all excluded nodes to be removed from the
cluster before clearing the voting configuration exclusions list.
Defaults to true, meaning that all excluded nodes must be removed from
the cluster before this API takes any action. If set to false then the
voting configuration exclusions list is cleared even if some excluded
nodes are still in the cluster. + /// + /// Specifies whether to wait for all excluded nodes to be removed from the + /// cluster before clearing the voting configuration exclusions list. + /// Defaults to true, meaning that all excluded nodes must be removed from + /// the cluster before this API takes any action. If set to false then the + /// voting configuration exclusions list is cleared even if some excluded + /// nodes are still in the cluster. + /// /// public bool? WaitForRemoval { get => Q("wait_for_removal"); set => Q("wait_for_removal", value); } } /// -/// Clears cluster voting config exclusions. +/// +/// Clears cluster voting config exclusions. +/// /// public sealed partial class DeleteVotingConfigExclusionsRequest : PlainRequest { @@ -51,14 +60,23 @@ public sealed partial class DeleteVotingConfigExclusionsRequest : PlainRequest "cluster.delete_voting_config_exclusions"; /// - /// Specifies whether to wait for all excluded nodes to be removed from the
cluster before clearing the voting configuration exclusions list.
Defaults to true, meaning that all excluded nodes must be removed from
the cluster before this API takes any action. If set to false then the
voting configuration exclusions list is cleared even if some excluded
nodes are still in the cluster. + /// + /// Specifies whether to wait for all excluded nodes to be removed from the + /// cluster before clearing the voting configuration exclusions list. + /// Defaults to true, meaning that all excluded nodes must be removed from + /// the cluster before this API takes any action. If set to false then the + /// voting configuration exclusions list is cleared even if some excluded + /// nodes are still in the cluster. + /// /// [JsonIgnore] public bool? WaitForRemoval { get => Q("wait_for_removal"); set => Q("wait_for_removal", value); } } /// -/// Clears cluster voting config exclusions. +/// +/// Clears cluster voting config exclusions. +/// /// public sealed partial class DeleteVotingConfigExclusionsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/ExistsComponentTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/ExistsComponentTemplateRequest.g.cs index 8e072c4b44c..a751e5546b0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/ExistsComponentTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/ExistsComponentTemplateRequest.g.cs @@ -32,18 +32,28 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ExistsComponentTemplateRequestParameters : RequestParameters { /// - /// If true, the request retrieves information from the local node only.
Defaults to false, which means information is retrieved from the master node. + /// + /// If true, the request retrieves information from the local node only. + /// Defaults to false, which means information is retrieved from the master node. + /// /// public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node. If no response is
received before the timeout expires, the request fails and returns an
error. + /// + /// Period to wait for a connection to the master node. If no response is + /// received before the timeout expires, the request fails and returns an + /// error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Check component templates.
Returns information about whether a particular component template exists. +/// +/// Check component templates. +/// Returns information about whether a particular component template exists. +/// /// public sealed partial class ExistsComponentTemplateRequest : PlainRequest { @@ -60,20 +70,30 @@ public ExistsComponentTemplateRequest(Elastic.Clients.Elasticsearch.Names name) internal override string OperationName => "cluster.exists_component_template"; /// - /// If true, the request retrieves information from the local node only.
Defaults to false, which means information is retrieved from the master node. + /// + /// If true, the request retrieves information from the local node only. + /// Defaults to false, which means information is retrieved from the master node. + /// /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node. If no response is
received before the timeout expires, the request fails and returns an
error. + /// + /// Period to wait for a connection to the master node. If no response is + /// received before the timeout expires, the request fails and returns an + /// error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Check component templates.
Returns information about whether a particular component template exists. +/// +/// Check component templates. +/// Returns information about whether a particular component template exists. +/// /// public sealed partial class ExistsComponentTemplateRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/GetClusterSettingsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/GetClusterSettingsRequest.g.cs index 05d49039e8e..970172b0127 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/GetClusterSettingsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/GetClusterSettingsRequest.g.cs @@ -32,28 +32,41 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class GetClusterSettingsRequestParameters : RequestParameters { /// - /// If `true`, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// If `true`, returns default cluster settings from the local node. + /// + /// If true, returns default cluster settings from the local node. + /// /// public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Returns cluster-wide settings.
By default, it returns only settings that have been explicitly defined. +/// +/// Returns cluster-wide settings. +/// By default, it returns only settings that have been explicitly defined. +/// /// public sealed partial class GetClusterSettingsRequest : PlainRequest { @@ -66,32 +79,45 @@ public sealed partial class GetClusterSettingsRequest : PlainRequest "cluster.get_settings"; /// - /// If `true`, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// [JsonIgnore] public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// If `true`, returns default cluster settings from the local node. + /// + /// If true, returns default cluster settings from the local node. + /// /// [JsonIgnore] public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Returns cluster-wide settings.
By default, it returns only settings that have been explicitly defined. +/// +/// Returns cluster-wide settings. +/// By default, it returns only settings that have been explicitly defined. +/// /// public sealed partial class GetClusterSettingsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/GetComponentTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/GetComponentTemplateRequest.g.cs index 86d0d7d5d06..34c28379fae 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/GetComponentTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/GetComponentTemplateRequest.g.cs @@ -32,28 +32,41 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class GetComponentTemplateRequestParameters : RequestParameters { /// - /// If `true`, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// Return all default configurations for the component template (default: false) + /// + /// Return all default configurations for the component template (default: false) + /// /// public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// If `true`, the request retrieves information from the local node only.
If `false`, information is retrieved from the master node. + /// + /// If true, the request retrieves information from the local node only. + /// If false, information is retrieved from the master node. + /// /// public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get component templates.
Retrieves information about component templates. +/// +/// Get component templates. +/// Retrieves information about component templates. +/// /// public sealed partial class GetComponentTemplateRequest : PlainRequest { @@ -74,32 +87,45 @@ public GetComponentTemplateRequest(Elastic.Clients.Elasticsearch.Name? name) : b internal override string OperationName => "cluster.get_component_template"; /// - /// If `true`, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// [JsonIgnore] public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// Return all default configurations for the component template (default: false) + /// + /// Return all default configurations for the component template (default: false) + /// /// [JsonIgnore] public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// If `true`, the request retrieves information from the local node only.
If `false`, information is retrieved from the master node. + /// + /// If true, the request retrieves information from the local node only. + /// If false, information is retrieved from the master node. + /// /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get component templates.
Retrieves information about component templates. +/// +/// Get component templates. +/// Retrieves information about component templates. +/// /// public sealed partial class GetComponentTemplateRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/HealthRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/HealthRequest.g.cs index 342cb4a4b33..ea031bcd050 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/HealthRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/HealthRequest.g.cs @@ -32,63 +32,88 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class HealthRequestParameters : RequestParameters { /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// + /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Can be one of cluster, indices or shards. Controls the details level of the health information returned. + /// + /// Can be one of cluster, indices or shards. Controls the details level of the health information returned. + /// /// public Elastic.Clients.Elasticsearch.Level? Level { get => Q("level"); set => Q("level", value); } /// - /// If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + /// + /// If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + /// /// public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait. + /// + /// A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait. + /// /// public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } /// - /// Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed. + /// + /// Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed. + /// /// public Elastic.Clients.Elasticsearch.WaitForEvents? WaitForEvents { get => Q("wait_for_events"); set => Q("wait_for_events", value); } /// - /// The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and + /// + /// The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and <N. Alternatively, it is possible to use ge(N), le(N), gt(N) and lt(N) notation. + /// /// public object? WaitForNodes { get => Q("wait_for_nodes"); set => Q("wait_for_nodes", value); } /// - /// A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards. + /// + /// A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards. + /// /// public bool? WaitForNoInitializingShards { get => Q("wait_for_no_initializing_shards"); set => Q("wait_for_no_initializing_shards", value); } /// - /// A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards. + /// + /// A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards. + /// /// public bool? WaitForNoRelocatingShards { get => Q("wait_for_no_relocating_shards"); set => Q("wait_for_no_relocating_shards", value); } /// - /// One of green, yellow or red. Will wait (until the timeout provided) until the status of the cluster changes to the one provided or better, i.e. green > yellow > red. By default, will not wait for any status. + /// + /// One of green, yellow or red. Will wait (until the timeout provided) until the status of the cluster changes to the one provided or better, i.e. green > yellow > red. By default, will not wait for any status. + /// /// public Elastic.Clients.Elasticsearch.HealthStatus? WaitForStatus { get => Q("wait_for_status"); set => Q("wait_for_status", value); } } /// -/// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. +/// +/// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. +/// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. +/// /// public sealed partial class HealthRequest : PlainRequest { @@ -109,74 +134,99 @@ public HealthRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r => internal override string OperationName => "cluster.health"; /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// + /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Can be one of cluster, indices or shards. Controls the details level of the health information returned. + /// + /// Can be one of cluster, indices or shards. Controls the details level of the health information returned. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Level? Level { get => Q("level"); set => Q("level", value); } /// - /// If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + /// + /// If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + /// /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait. + /// + /// A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } /// - /// Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed. + /// + /// Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.WaitForEvents? WaitForEvents { get => Q("wait_for_events"); set => Q("wait_for_events", value); } /// - /// The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and + /// + /// The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and <N. Alternatively, it is possible to use ge(N), le(N), gt(N) and lt(N) notation. + /// /// [JsonIgnore] public object? WaitForNodes { get => Q("wait_for_nodes"); set => Q("wait_for_nodes", value); } /// - /// A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards. + /// + /// A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards. + /// /// [JsonIgnore] public bool? WaitForNoInitializingShards { get => Q("wait_for_no_initializing_shards"); set => Q("wait_for_no_initializing_shards", value); } /// - /// A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards. + /// + /// A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards. + /// /// [JsonIgnore] public bool? WaitForNoRelocatingShards { get => Q("wait_for_no_relocating_shards"); set => Q("wait_for_no_relocating_shards", value); } /// - /// One of green, yellow or red. Will wait (until the timeout provided) until the status of the cluster changes to the one provided or better, i.e. green > yellow > red. By default, will not wait for any status. + /// + /// One of green, yellow or red. Will wait (until the timeout provided) until the status of the cluster changes to the one provided or better, i.e. green > yellow > red. By default, will not wait for any status. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.HealthStatus? WaitForStatus { get => Q("wait_for_status"); set => Q("wait_for_status", value); } } /// -/// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. +/// +/// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. +/// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. +/// /// public sealed partial class HealthRequestDescriptor : RequestDescriptor, HealthRequestParameters> { @@ -222,7 +272,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. +/// +/// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. +/// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. +/// /// public sealed partial class HealthRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/HealthResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/HealthResponse.g.cs index 237fe05a1eb..abfc1200a0f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/HealthResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/HealthResponse.g.cs @@ -29,31 +29,41 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class HealthResponse : ElasticsearchResponse { /// - /// The number of active primary shards. + /// + /// The number of active primary shards. + /// /// [JsonInclude, JsonPropertyName("active_primary_shards")] public int ActivePrimaryShards { get; init; } /// - /// The total number of active primary and replica shards. + /// + /// The total number of active primary and replica shards. + /// /// [JsonInclude, JsonPropertyName("active_shards")] public int ActiveShards { get; init; } /// - /// The ratio of active shards in the cluster expressed as a percentage. + /// + /// The ratio of active shards in the cluster expressed as a percentage. + /// /// [JsonInclude, JsonPropertyName("active_shards_percent_as_number")] public double ActiveShardsPercentAsNumber { get; init; } /// - /// The name of the cluster. + /// + /// The name of the cluster. + /// /// [JsonInclude, JsonPropertyName("cluster_name")] public string ClusterName { get; init; } /// - /// The number of shards whose allocation has been delayed by the timeout settings. + /// + /// The number of shards whose allocation has been delayed by the timeout settings. + /// /// [JsonInclude, JsonPropertyName("delayed_unassigned_shards")] public int DelayedUnassignedShards { get; init; } @@ -62,37 +72,49 @@ public sealed partial class HealthResponse : ElasticsearchResponse public IReadOnlyDictionary? Indices { get; init; } /// - /// The number of shards that are under initialization. + /// + /// The number of shards that are under initialization. + /// /// [JsonInclude, JsonPropertyName("initializing_shards")] public int InitializingShards { get; init; } /// - /// The number of nodes that are dedicated data nodes. + /// + /// The number of nodes that are dedicated data nodes. + /// /// [JsonInclude, JsonPropertyName("number_of_data_nodes")] public int NumberOfDataNodes { get; init; } /// - /// The number of unfinished fetches. + /// + /// The number of unfinished fetches. + /// /// [JsonInclude, JsonPropertyName("number_of_in_flight_fetch")] public int NumberOfInFlightFetch { get; init; } /// - /// The number of nodes within the cluster. + /// + /// The number of nodes within the cluster. + /// /// [JsonInclude, JsonPropertyName("number_of_nodes")] public int NumberOfNodes { get; init; } /// - /// The number of cluster-level changes that have not yet been executed. + /// + /// The number of cluster-level changes that have not yet been executed. + /// /// [JsonInclude, JsonPropertyName("number_of_pending_tasks")] public int NumberOfPendingTasks { get; init; } /// - /// The number of shards that are under relocation. + /// + /// The number of shards that are under relocation. + /// /// [JsonInclude, JsonPropertyName("relocating_shards")] public int RelocatingShards { get; init; } @@ -100,25 +122,33 @@ public sealed partial class HealthResponse : ElasticsearchResponse public Elastic.Clients.Elasticsearch.HealthStatus Status { get; init; } /// - /// The time since the earliest initiated task is waiting for being performed. + /// + /// The time since the earliest initiated task is waiting for being performed. + /// /// [JsonInclude, JsonPropertyName("task_max_waiting_in_queue")] public Elastic.Clients.Elasticsearch.Duration? TaskMaxWaitingInQueue { get; init; } /// - /// The time expressed in milliseconds since the earliest initiated task is waiting for being performed. + /// + /// The time expressed in milliseconds since the earliest initiated task is waiting for being performed. + /// /// [JsonInclude, JsonPropertyName("task_max_waiting_in_queue_millis")] public long TaskMaxWaitingInQueueMillis { get; init; } /// - /// If false the response returned within the period of time that is specified by the timeout parameter (30s by default) + /// + /// If false the response returned within the period of time that is specified by the timeout parameter (30s by default) + /// /// [JsonInclude, JsonPropertyName("timed_out")] public bool TimedOut { get; init; } /// - /// The number of shards that are not allocated. + /// + /// The number of shards that are not allocated. + /// /// [JsonInclude, JsonPropertyName("unassigned_shards")] public int UnassignedShards { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/PendingTasksRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/PendingTasksRequest.g.cs index 22701ebb884..387562ae73b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/PendingTasksRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/PendingTasksRequest.g.cs @@ -32,18 +32,29 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class PendingTasksRequestParameters : RequestParameters { /// - /// If `true`, the request retrieves information from the local node only.
If `false`, information is retrieved from the master node. + /// + /// If true, the request retrieves information from the local node only. + /// If false, information is retrieved from the master node. + /// /// public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed.
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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests.
However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. +/// +/// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. +/// 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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. +/// However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. +/// /// public sealed partial class PendingTasksRequest : PlainRequest { @@ -56,20 +67,31 @@ public sealed partial class PendingTasksRequest : PlainRequest "cluster.pending_tasks"; /// - /// If `true`, the request retrieves information from the local node only.
If `false`, information is retrieved from the master node. + /// + /// If true, the request retrieves information from the local node only. + /// If false, information is retrieved from the master node. + /// /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed.
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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests.
However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. +/// +/// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. +/// 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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. +/// However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. +/// /// public sealed partial class PendingTasksRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/PostVotingConfigExclusionsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/PostVotingConfigExclusionsRequest.g.cs index 2b3c4865356..1dfcfa937de 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/PostVotingConfigExclusionsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/PostVotingConfigExclusionsRequest.g.cs @@ -32,23 +32,36 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class PostVotingConfigExclusionsRequestParameters : RequestParameters { /// - /// A comma-separated list of the persistent ids of the nodes to exclude
from the voting configuration. If specified, you may not also specify node_names. + /// + /// A comma-separated list of the persistent ids of the nodes to exclude + /// from the voting configuration. If specified, you may not also specify node_names. + /// /// public Elastic.Clients.Elasticsearch.Ids? NodeIds { get => Q("node_ids"); set => Q("node_ids", value); } /// - /// A comma-separated list of the names of the nodes to exclude from the
voting configuration. If specified, you may not also specify node_ids. + /// + /// A comma-separated list of the names of the nodes to exclude from the + /// voting configuration. If specified, you may not also specify node_ids. + /// /// public Elastic.Clients.Elasticsearch.Names? NodeNames { get => Q("node_names"); set => Q("node_names", value); } /// - /// When adding a voting configuration exclusion, the API waits for the
specified nodes to be excluded from the voting configuration before
returning. If the timeout expires before the appropriate condition
is satisfied, the request fails and returns an error. + /// + /// When adding a voting configuration exclusion, the API waits for the + /// specified nodes to be excluded from the voting configuration before + /// returning. If the timeout expires before the appropriate condition + /// is satisfied, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Updates the cluster voting config exclusions by node ids or node names. +/// +/// Updates the cluster voting config exclusions by node ids or node names. +/// /// public sealed partial class PostVotingConfigExclusionsRequest : PlainRequest { @@ -61,26 +74,39 @@ public sealed partial class PostVotingConfigExclusionsRequest : PlainRequest "cluster.post_voting_config_exclusions"; /// - /// A comma-separated list of the persistent ids of the nodes to exclude
from the voting configuration. If specified, you may not also specify node_names. + /// + /// A comma-separated list of the persistent ids of the nodes to exclude + /// from the voting configuration. If specified, you may not also specify node_names. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Ids? NodeIds { get => Q("node_ids"); set => Q("node_ids", value); } /// - /// A comma-separated list of the names of the nodes to exclude from the
voting configuration. If specified, you may not also specify node_ids. + /// + /// A comma-separated list of the names of the nodes to exclude from the + /// voting configuration. If specified, you may not also specify node_ids. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Names? NodeNames { get => Q("node_names"); set => Q("node_names", value); } /// - /// When adding a voting configuration exclusion, the API waits for the
specified nodes to be excluded from the voting configuration before
returning. If the timeout expires before the appropriate condition
is satisfied, the request fails and returns an error. + /// + /// When adding a voting configuration exclusion, the API waits for the + /// specified nodes to be excluded from the voting configuration before + /// returning. If the timeout expires before the appropriate condition + /// is satisfied, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Updates the cluster voting config exclusions by node ids or node names. +/// +/// Updates the cluster voting config exclusions by node ids or node names. +/// /// public sealed partial class PostVotingConfigExclusionsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/PutComponentTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/PutComponentTemplateRequest.g.cs index e6029d3d462..216951b38ec 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/PutComponentTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/PutComponentTemplateRequest.g.cs @@ -32,22 +32,44 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class PutComponentTemplateRequestParameters : RequestParameters { /// - /// If `true`, this request cannot replace or update existing component templates. + /// + /// If true, this request cannot replace or update existing component templates. + /// /// public bool? Create { get => Q("create"); set => Q("create", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Create or update a component template.
Creates or updates 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 `composed_of` list.
Component templates are only applied to new data streams and indices as part of a matching index template. -/// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. -/// Component templates are only used during index creation.
For data streams, this includes data stream creation and the creation of a stream’s backing indices.
Changes to component templates do not affect existing indices, including a stream’s backing indices. -/// You can use C-style `/* *\/` block comments in component templates.
You can include comments anywhere in the request body except before the opening curly bracket. +/// +/// Create or update a component template. +/// Creates or updates 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 composed_of list. +/// Component templates are only applied to new data streams and indices as part of a matching index template. +/// +/// +/// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. +/// +/// +/// Component templates are only used during index creation. +/// For data streams, this includes data stream creation and the creation of a stream’s backing indices. +/// Changes to component templates do not affect existing indices, including a stream’s backing indices. +/// +/// +/// You can use C-style /* *\/ block comments in component templates. +/// You can include comments anywhere in the request body except before the opening curly bracket. +/// /// public sealed partial class PutComponentTemplateRequest : PlainRequest { @@ -64,48 +86,84 @@ public PutComponentTemplateRequest(Elastic.Clients.Elasticsearch.Name name) : ba internal override string OperationName => "cluster.put_component_template"; /// - /// If `true`, this request cannot replace or update existing component templates. + /// + /// If true, this request cannot replace or update existing component templates. + /// /// [JsonIgnore] public bool? Create { get => Q("create"); set => Q("create", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Marks this index template as deprecated. When creating or updating a non-deprecated index template
that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// + /// Marks this index template as deprecated. When creating or updating a non-deprecated index template + /// that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// /// [JsonInclude, JsonPropertyName("deprecated")] public bool? Deprecated { get; set; } /// - /// Optional user metadata about the component template.
May have any contents. This map is not automatically generated by Elasticsearch.
This information is stored in the cluster state, so keeping it short is preferable.
To unset `_meta`, replace the template without specifying this information. + /// + /// Optional user metadata about the component template. + /// May have any contents. This map is not automatically generated by Elasticsearch. + /// This information is stored in the cluster state, so keeping it short is preferable. + /// To unset _meta, replace the template without specifying this information. + /// /// [JsonInclude, JsonPropertyName("_meta")] public IDictionary? Meta { get; set; } /// - /// The template to be applied which includes mappings, settings, or aliases configuration. + /// + /// The template to be applied which includes mappings, settings, or aliases configuration. + /// /// [JsonInclude, JsonPropertyName("template")] public Elastic.Clients.Elasticsearch.IndexManagement.IndexState Template { get; set; } /// - /// Version number used to manage component templates externally.
This number isn't automatically generated or incremented by Elasticsearch.
To unset a version, replace the template without specifying a version. + /// + /// Version number used to manage component templates externally. + /// This number isn't automatically generated or incremented by Elasticsearch. + /// To unset a version, replace the template without specifying a version. + /// /// [JsonInclude, JsonPropertyName("version")] public long? Version { get; set; } } /// -/// Create or update a component template.
Creates or updates 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 `composed_of` list.
Component templates are only applied to new data streams and indices as part of a matching index template. -/// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. -/// Component templates are only used during index creation.
For data streams, this includes data stream creation and the creation of a stream’s backing indices.
Changes to component templates do not affect existing indices, including a stream’s backing indices. -/// You can use C-style `/* *\/` block comments in component templates.
You can include comments anywhere in the request body except before the opening curly bracket. +/// +/// Create or update a component template. +/// Creates or updates 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 composed_of list. +/// Component templates are only applied to new data streams and indices as part of a matching index template. +/// +/// +/// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. +/// +/// +/// Component templates are only used during index creation. +/// For data streams, this includes data stream creation and the creation of a stream’s backing indices. +/// Changes to component templates do not affect existing indices, including a stream’s backing indices. +/// +/// +/// You can use C-style /* *\/ block comments in component templates. +/// You can include comments anywhere in the request body except before the opening curly bracket. +/// /// public sealed partial class PutComponentTemplateRequestDescriptor : RequestDescriptor, PutComponentTemplateRequestParameters> { @@ -140,7 +198,10 @@ public PutComponentTemplateRequestDescriptor Name(Elastic.Clients.Ela private long? VersionValue { get; set; } /// - /// Marks this index template as deprecated. When creating or updating a non-deprecated index template
that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// + /// Marks this index template as deprecated. When creating or updating a non-deprecated index template + /// that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// /// public PutComponentTemplateRequestDescriptor Deprecated(bool? deprecated = true) { @@ -149,7 +210,12 @@ public PutComponentTemplateRequestDescriptor Deprecated(bool? depreca } /// - /// Optional user metadata about the component template.
May have any contents. This map is not automatically generated by Elasticsearch.
This information is stored in the cluster state, so keeping it short is preferable.
To unset `_meta`, replace the template without specifying this information. + /// + /// Optional user metadata about the component template. + /// May have any contents. This map is not automatically generated by Elasticsearch. + /// This information is stored in the cluster state, so keeping it short is preferable. + /// To unset _meta, replace the template without specifying this information. + /// /// public PutComponentTemplateRequestDescriptor Meta(Func, FluentDictionary> selector) { @@ -158,7 +224,9 @@ public PutComponentTemplateRequestDescriptor Meta(Func - /// The template to be applied which includes mappings, settings, or aliases configuration. + /// + /// The template to be applied which includes mappings, settings, or aliases configuration. + /// /// public PutComponentTemplateRequestDescriptor Template(Elastic.Clients.Elasticsearch.IndexManagement.IndexState template) { @@ -185,7 +253,11 @@ public PutComponentTemplateRequestDescriptor Template(Action - /// Version number used to manage component templates externally.
This number isn't automatically generated or incremented by Elasticsearch.
To unset a version, replace the template without specifying a version. + /// + /// Version number used to manage component templates externally. + /// This number isn't automatically generated or incremented by Elasticsearch. + /// To unset a version, replace the template without specifying a version. + /// /// public PutComponentTemplateRequestDescriptor Version(long? version) { @@ -235,11 +307,28 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Create or update a component template.
Creates or updates 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 `composed_of` list.
Component templates are only applied to new data streams and indices as part of a matching index template. -/// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. -/// Component templates are only used during index creation.
For data streams, this includes data stream creation and the creation of a stream’s backing indices.
Changes to component templates do not affect existing indices, including a stream’s backing indices. -/// You can use C-style `/* *\/` block comments in component templates.
You can include comments anywhere in the request body except before the opening curly bracket. +/// +/// Create or update a component template. +/// Creates or updates 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 composed_of list. +/// Component templates are only applied to new data streams and indices as part of a matching index template. +/// +/// +/// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. +/// +/// +/// Component templates are only used during index creation. +/// For data streams, this includes data stream creation and the creation of a stream’s backing indices. +/// Changes to component templates do not affect existing indices, including a stream’s backing indices. +/// +/// +/// You can use C-style /* *\/ block comments in component templates. +/// You can include comments anywhere in the request body except before the opening curly bracket. +/// /// public sealed partial class PutComponentTemplateRequestDescriptor : RequestDescriptor { @@ -274,7 +363,10 @@ public PutComponentTemplateRequestDescriptor Name(Elastic.Clients.Elasticsearch. private long? VersionValue { get; set; } /// - /// Marks this index template as deprecated. When creating or updating a non-deprecated index template
that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// + /// Marks this index template as deprecated. When creating or updating a non-deprecated index template + /// that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// /// public PutComponentTemplateRequestDescriptor Deprecated(bool? deprecated = true) { @@ -283,7 +375,12 @@ public PutComponentTemplateRequestDescriptor Deprecated(bool? deprecated = true) } /// - /// Optional user metadata about the component template.
May have any contents. This map is not automatically generated by Elasticsearch.
This information is stored in the cluster state, so keeping it short is preferable.
To unset `_meta`, replace the template without specifying this information. + /// + /// Optional user metadata about the component template. + /// May have any contents. This map is not automatically generated by Elasticsearch. + /// This information is stored in the cluster state, so keeping it short is preferable. + /// To unset _meta, replace the template without specifying this information. + /// /// public PutComponentTemplateRequestDescriptor Meta(Func, FluentDictionary> selector) { @@ -292,7 +389,9 @@ public PutComponentTemplateRequestDescriptor Meta(Func - /// The template to be applied which includes mappings, settings, or aliases configuration. + /// + /// The template to be applied which includes mappings, settings, or aliases configuration. + /// /// public PutComponentTemplateRequestDescriptor Template(Elastic.Clients.Elasticsearch.IndexManagement.IndexState template) { @@ -319,7 +418,11 @@ public PutComponentTemplateRequestDescriptor Template(Action - /// Version number used to manage component templates externally.
This number isn't automatically generated or incremented by Elasticsearch.
To unset a version, replace the template without specifying a version. + /// + /// Version number used to manage component templates externally. + /// This number isn't automatically generated or incremented by Elasticsearch. + /// To unset a version, replace the template without specifying a version. + /// /// public PutComponentTemplateRequestDescriptor Version(long? version) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/PutComponentTemplateResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/PutComponentTemplateResponse.g.cs index d0754ce3a58..5b48a459f7a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/PutComponentTemplateResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/PutComponentTemplateResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class PutComponentTemplateResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CountRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CountRequest.g.cs index 310e99a5814..30fa707d9f5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CountRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CountRequest.g.cs @@ -32,78 +32,118 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class CountRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Analyzer to use for the query string.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// Analyzer to use for the query string. + /// This parameter can only be used when the q query string parameter is specified. + /// /// public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// - /// If `true`, wildcard and prefix queries are analyzed.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// If true, wildcard and prefix queries are analyzed. + /// This parameter can only be used when the q query string parameter is specified. + /// /// public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } /// - /// The default operator for query string query: `AND` or `OR`.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// The default operator for query string query: AND or OR. + /// This parameter can only be used when the q query string parameter is specified. + /// /// public Elastic.Clients.Elasticsearch.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } /// - /// Field to use as default where no field prefix is given in the query string.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// Field to use as default where no field prefix is given in the query string. + /// This parameter can only be used when the q query string parameter is specified. + /// /// public string? Df { get => Q("df"); set => Q("df", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, concrete, expanded or aliased indices are ignored when frozen. + /// + /// If true, concrete, expanded or aliased indices are ignored when frozen. + /// /// public bool? IgnoreThrottled { get => Q("ignore_throttled"); set => Q("ignore_throttled", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// + /// If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// /// public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// - /// Sets the minimum `_score` value that documents must have to be included in the result. + /// + /// Sets the minimum _score value that documents must have to be included in the result. + /// /// public double? MinScore { get => Q("min_score"); set => Q("min_score", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// Query in the Lucene query string syntax. + /// + /// Query in the Lucene query string syntax. + /// /// public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Maximum number of documents to collect for each shard.
If a query reaches this limit, Elasticsearch terminates the query early.
Elasticsearch collects documents before sorting. + /// + /// Maximum number of documents to collect for each shard. + /// If a query reaches this limit, Elasticsearch terminates the query early. + /// Elasticsearch collects documents before sorting. + /// /// public long? TerminateAfter { get => Q("terminate_after"); set => Q("terminate_after", value); } } /// -/// Returns number of documents matching a query. +/// +/// Returns number of documents matching a query. +/// /// public partial class CountRequest : PlainRequest { @@ -124,98 +164,140 @@ public CountRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r => internal override string OperationName => "count"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Analyzer to use for the query string.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// Analyzer to use for the query string. + /// This parameter can only be used when the q query string parameter is specified. + /// /// [JsonIgnore] public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// - /// If `true`, wildcard and prefix queries are analyzed.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// If true, wildcard and prefix queries are analyzed. + /// This parameter can only be used when the q query string parameter is specified. + /// /// [JsonIgnore] public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } /// - /// The default operator for query string query: `AND` or `OR`.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// The default operator for query string query: AND or OR. + /// This parameter can only be used when the q query string parameter is specified. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } /// - /// Field to use as default where no field prefix is given in the query string.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// Field to use as default where no field prefix is given in the query string. + /// This parameter can only be used when the q query string parameter is specified. + /// /// [JsonIgnore] public string? Df { get => Q("df"); set => Q("df", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, concrete, expanded or aliased indices are ignored when frozen. + /// + /// If true, concrete, expanded or aliased indices are ignored when frozen. + /// /// [JsonIgnore] public bool? IgnoreThrottled { get => Q("ignore_throttled"); set => Q("ignore_throttled", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// + /// If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// /// [JsonIgnore] public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// - /// Sets the minimum `_score` value that documents must have to be included in the result. + /// + /// Sets the minimum _score value that documents must have to be included in the result. + /// /// [JsonIgnore] public double? MinScore { get => Q("min_score"); set => Q("min_score", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// Query in the Lucene query string syntax. + /// + /// Query in the Lucene query string syntax. + /// /// [JsonIgnore] public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Maximum number of documents to collect for each shard.
If a query reaches this limit, Elasticsearch terminates the query early.
Elasticsearch collects documents before sorting. + /// + /// Maximum number of documents to collect for each shard. + /// If a query reaches this limit, Elasticsearch terminates the query early. + /// Elasticsearch collects documents before sorting. + /// /// [JsonIgnore] public long? TerminateAfter { get => Q("terminate_after"); set => Q("terminate_after", value); } /// - /// Defines the search definition using the Query DSL. + /// + /// Defines the search definition using the Query DSL. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Query { get; set; } } /// -/// Returns number of documents matching a query. +/// +/// Returns number of documents matching a query. +/// /// public sealed partial class CountRequestDescriptor : RequestDescriptor, CountRequestParameters> { @@ -263,7 +345,9 @@ public CountRequestDescriptor Indices(Elastic.Clients.Elasticsearch.I private Action> QueryDescriptorAction { get; set; } /// - /// Defines the search definition using the Query DSL. + /// + /// Defines the search definition using the Query DSL. + /// /// public CountRequestDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -313,7 +397,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns number of documents matching a query. +/// +/// Returns number of documents matching a query. +/// /// public sealed partial class CountRequestDescriptor : RequestDescriptor { @@ -361,7 +447,9 @@ public CountRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? ind private Action QueryDescriptorAction { get; set; } /// - /// Defines the search definition using the Query DSL. + /// + /// Defines the search definition using the Query DSL. + /// /// public CountRequestDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CreateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CreateRequest.g.cs index 858a8020b4d..08a4a4efb2b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CreateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CreateRequest.g.cs @@ -32,43 +32,66 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class CreateRequestParameters : RequestParameters { /// - /// ID of the pipeline to use to preprocess incoming documents.
If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.
If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// + /// ID of the pipeline to use to preprocess incoming documents. + /// If the index has a default ingest pipeline specified, then setting the value to _none disables the default ingest pipeline for this request. + /// If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// /// public string? Pipeline { get => Q("pipeline"); set => Q("pipeline", value); } /// - /// If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.
Valid values: `true`, `false`, `wait_for`. + /// + /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false do nothing with refreshes. + /// Valid values: true, false, wait_for. + /// /// public Elastic.Clients.Elasticsearch.Refresh? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. + /// + /// Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Explicit version number for concurrency control.
The specified version must match the current version of the document for the request to succeed. + /// + /// Explicit version number for concurrency control. + /// The specified version must match the current version of the document for the request to succeed. + /// /// public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type: `external`, `external_gte`. + /// + /// Specific version type: external, external_gte. + /// /// public Elastic.Clients.Elasticsearch.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. +/// +/// Index a document. +/// Adds a JSON document to the specified data stream or index and makes it searchable. +/// If the target is an index and the document already exists, the request updates the document and increments its version. +/// /// public sealed partial class CreateRequest : PlainRequest, ISelfSerializable { @@ -85,43 +108,62 @@ public CreateRequest(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clie internal override string OperationName => "create"; /// - /// ID of the pipeline to use to preprocess incoming documents.
If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.
If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// + /// ID of the pipeline to use to preprocess incoming documents. + /// If the index has a default ingest pipeline specified, then setting the value to _none disables the default ingest pipeline for this request. + /// If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// /// [JsonIgnore] public string? Pipeline { get => Q("pipeline"); set => Q("pipeline", value); } /// - /// If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.
Valid values: `true`, `false`, `wait_for`. + /// + /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false do nothing with refreshes. + /// Valid values: true, false, wait_for. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Refresh? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. + /// + /// Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Explicit version number for concurrency control.
The specified version must match the current version of the document for the request to succeed. + /// + /// Explicit version number for concurrency control. + /// The specified version must match the current version of the document for the request to succeed. + /// /// [JsonIgnore] public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type: `external`, `external_gte`. + /// + /// Specific version type: external, external_gte. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } @@ -135,7 +177,11 @@ void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions op } /// -/// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. +/// +/// Index a document. +/// Adds a JSON document to the specified data stream or index and makes it searchable. +/// If the target is an index and the document already exists, the request updates the document and increments its version. +/// /// public sealed partial class CreateRequestDescriptor : RequestDescriptor, CreateRequestParameters> { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/CcrStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/CcrStatsRequest.g.cs index 2000c438324..9773884078a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/CcrStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/CcrStatsRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class CcrStatsRequestParameters : RequestParameters } /// -/// Gets all stats related to cross-cluster replication. +/// +/// Gets all stats related to cross-cluster replication. +/// /// public sealed partial class CcrStatsRequest : PlainRequest { @@ -48,7 +50,9 @@ public sealed partial class CcrStatsRequest : PlainRequest -/// Gets all stats related to cross-cluster replication. +/// +/// Gets all stats related to cross-cluster replication. +/// /// public sealed partial class CcrStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/DeleteAutoFollowPatternRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/DeleteAutoFollowPatternRequest.g.cs index 7c9e0440837..aa830339381 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/DeleteAutoFollowPatternRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/DeleteAutoFollowPatternRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class DeleteAutoFollowPatternRequestParameters : RequestPa } /// -/// Deletes auto-follow patterns. +/// +/// Deletes auto-follow patterns. +/// /// public sealed partial class DeleteAutoFollowPatternRequest : PlainRequest { @@ -52,7 +54,9 @@ public DeleteAutoFollowPatternRequest(Elastic.Clients.Elasticsearch.Name name) : } /// -/// Deletes auto-follow patterns. +/// +/// Deletes auto-follow patterns. +/// /// public sealed partial class DeleteAutoFollowPatternRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/DeleteAutoFollowPatternResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/DeleteAutoFollowPatternResponse.g.cs index a84ce8b8a5c..99617d5ed3d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/DeleteAutoFollowPatternResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/DeleteAutoFollowPatternResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.CrossClusterReplication; public sealed partial class DeleteAutoFollowPatternResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/FollowInfoRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/FollowInfoRequest.g.cs index 177a36ea90c..d0614c3f819 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/FollowInfoRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/FollowInfoRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class FollowInfoRequestParameters : RequestParameters } /// -/// Retrieves information about all follower indices, including parameters and status for each follower index +/// +/// Retrieves information about all follower indices, including parameters and status for each follower index +/// /// public sealed partial class FollowInfoRequest : PlainRequest { @@ -52,7 +54,9 @@ public FollowInfoRequest(Elastic.Clients.Elasticsearch.Indices indices) : base(r } /// -/// Retrieves information about all follower indices, including parameters and status for each follower index +/// +/// Retrieves information about all follower indices, including parameters and status for each follower index +/// /// public sealed partial class FollowInfoRequestDescriptor : RequestDescriptor, FollowInfoRequestParameters> { @@ -86,7 +90,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Retrieves information about all follower indices, including parameters and status for each follower index +/// +/// Retrieves information about all follower indices, including parameters and status for each follower index +/// /// public sealed partial class FollowInfoRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/FollowRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/FollowRequest.g.cs index a3ec6541f4b..8f8c83045bf 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/FollowRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/FollowRequest.g.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch.CrossClusterReplication; public sealed partial class FollowRequestParameters : RequestParameters { /// - /// Sets the number of shard copies that must be active before returning. Defaults to 0. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) + /// + /// Sets the number of shard copies that must be active before returning. Defaults to 0. Set to all for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) + /// /// public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Creates a new follower index configured to follow the referenced leader index. +/// +/// Creates a new follower index configured to follow the referenced leader index. +/// /// public sealed partial class FollowRequest : PlainRequest { @@ -55,7 +59,9 @@ public FollowRequest(Elastic.Clients.Elasticsearch.IndexName index) : base(r => internal override string OperationName => "ccr.follow"; /// - /// Sets the number of shard copies that must be active before returning. Defaults to 0. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) + /// + /// Sets the number of shard copies that must be active before returning. Defaults to 0. Set to all for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } @@ -86,7 +92,9 @@ public FollowRequest(Elastic.Clients.Elasticsearch.IndexName index) : base(r => } /// -/// Creates a new follower index configured to follow the referenced leader index. +/// +/// Creates a new follower index configured to follow the referenced leader index. +/// /// public sealed partial class FollowRequestDescriptor : RequestDescriptor, FollowRequestParameters> { @@ -281,7 +289,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Creates a new follower index configured to follow the referenced leader index. +/// +/// Creates a new follower index configured to follow the referenced leader index. +/// /// public sealed partial class FollowRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/FollowStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/FollowStatsRequest.g.cs index 49783fdd22c..b332fb34f36 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/FollowStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/FollowStatsRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class FollowStatsRequestParameters : RequestParameters } /// -/// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. +/// +/// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. +/// /// public sealed partial class FollowStatsRequest : PlainRequest { @@ -52,7 +54,9 @@ public FollowStatsRequest(Elastic.Clients.Elasticsearch.Indices indices) : base( } /// -/// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. +/// +/// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. +/// /// public sealed partial class FollowStatsRequestDescriptor : RequestDescriptor, FollowStatsRequestParameters> { @@ -86,7 +90,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. +/// +/// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. +/// /// public sealed partial class FollowStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ForgetFollowerRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ForgetFollowerRequest.g.cs index 9ca54b85047..e0e1e13558f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ForgetFollowerRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ForgetFollowerRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class ForgetFollowerRequestParameters : RequestParameters } /// -/// Removes the follower retention leases from the leader. +/// +/// Removes the follower retention leases from the leader. +/// /// public sealed partial class ForgetFollowerRequest : PlainRequest { @@ -61,7 +63,9 @@ public ForgetFollowerRequest(Elastic.Clients.Elasticsearch.IndexName index) : ba } /// -/// Removes the follower retention leases from the leader. +/// +/// Removes the follower retention leases from the leader. +/// /// public sealed partial class ForgetFollowerRequestDescriptor : RequestDescriptor, ForgetFollowerRequestParameters> { @@ -150,7 +154,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Removes the follower retention leases from the leader. +/// +/// Removes the follower retention leases from the leader. +/// /// public sealed partial class ForgetFollowerRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/GetAutoFollowPatternRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/GetAutoFollowPatternRequest.g.cs index 0060d2e3a9e..6a3868fd049 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/GetAutoFollowPatternRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/GetAutoFollowPatternRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class GetAutoFollowPatternRequestParameters : RequestParam } /// -/// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. +/// +/// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. +/// /// public sealed partial class GetAutoFollowPatternRequest : PlainRequest { @@ -56,7 +58,9 @@ public GetAutoFollowPatternRequest(Elastic.Clients.Elasticsearch.Name? name) : b } /// -/// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. +/// +/// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. +/// /// public sealed partial class GetAutoFollowPatternRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PauseAutoFollowPatternRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PauseAutoFollowPatternRequest.g.cs index 458d88d6e59..f2ec08bdcac 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PauseAutoFollowPatternRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PauseAutoFollowPatternRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class PauseAutoFollowPatternRequestParameters : RequestPar } /// -/// Pauses an auto-follow pattern +/// +/// Pauses an auto-follow pattern +/// /// public sealed partial class PauseAutoFollowPatternRequest : PlainRequest { @@ -52,7 +54,9 @@ public PauseAutoFollowPatternRequest(Elastic.Clients.Elasticsearch.Name name) : } /// -/// Pauses an auto-follow pattern +/// +/// Pauses an auto-follow pattern +/// /// public sealed partial class PauseAutoFollowPatternRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PauseAutoFollowPatternResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PauseAutoFollowPatternResponse.g.cs index 0f7826b0fc1..bb6d5fb3a2e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PauseAutoFollowPatternResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PauseAutoFollowPatternResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.CrossClusterReplication; public sealed partial class PauseAutoFollowPatternResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PauseFollowRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PauseFollowRequest.g.cs index e1c02d68760..726fa92e33a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PauseFollowRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PauseFollowRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class PauseFollowRequestParameters : RequestParameters } /// -/// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. +/// +/// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. +/// /// public sealed partial class PauseFollowRequest : PlainRequest { @@ -52,7 +54,9 @@ public PauseFollowRequest(Elastic.Clients.Elasticsearch.IndexName index) : base( } /// -/// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. +/// +/// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. +/// /// public sealed partial class PauseFollowRequestDescriptor : RequestDescriptor, PauseFollowRequestParameters> { @@ -86,7 +90,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. +/// +/// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. +/// /// public sealed partial class PauseFollowRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PauseFollowResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PauseFollowResponse.g.cs index 7827171c11e..1d2496b5ce9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PauseFollowResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PauseFollowResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.CrossClusterReplication; public sealed partial class PauseFollowResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PutAutoFollowPatternRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PutAutoFollowPatternRequest.g.cs index 68f5f0d1910..d8fbbace26e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PutAutoFollowPatternRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PutAutoFollowPatternRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class PutAutoFollowPatternRequestParameters : RequestParam } /// -/// Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. +/// +/// Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. +/// /// public sealed partial class PutAutoFollowPatternRequest : PlainRequest { @@ -51,98 +53,130 @@ public PutAutoFollowPatternRequest(Elastic.Clients.Elasticsearch.Name name) : ba internal override string OperationName => "ccr.put_auto_follow_pattern"; /// - /// The name of follower index. The template {{leader_index}} can be used to derive the name of the follower index from the name of the leader index. When following a data stream, use {{leader_index}}; CCR does not support changes to the names of a follower data stream’s backing indices. + /// + /// The name of follower index. The template {{leader_index}} can be used to derive the name of the follower index from the name of the leader index. When following a data stream, use {{leader_index}}; CCR does not support changes to the names of a follower data stream’s backing indices. + /// /// [JsonInclude, JsonPropertyName("follow_index_pattern")] public string? FollowIndexPattern { get; set; } /// - /// An array of simple index patterns that can be used to exclude indices from being auto-followed. Indices in the remote cluster whose names are matching one or more leader_index_patterns and one or more leader_index_exclusion_patterns won’t be followed. + /// + /// An array of simple index patterns that can be used to exclude indices from being auto-followed. Indices in the remote cluster whose names are matching one or more leader_index_patterns and one or more leader_index_exclusion_patterns won’t be followed. + /// /// [JsonInclude, JsonPropertyName("leader_index_exclusion_patterns")] public ICollection? LeaderIndexExclusionPatterns { get; set; } /// - /// An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field. + /// + /// An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field. + /// /// [JsonInclude, JsonPropertyName("leader_index_patterns")] public ICollection? LeaderIndexPatterns { get; set; } /// - /// The maximum number of outstanding reads requests from the remote cluster. + /// + /// The maximum number of outstanding reads requests from the remote cluster. + /// /// [JsonInclude, JsonPropertyName("max_outstanding_read_requests")] public int? MaxOutstandingReadRequests { get; set; } /// - /// The maximum number of outstanding reads requests from the remote cluster. + /// + /// The maximum number of outstanding reads requests from the remote cluster. + /// /// [JsonInclude, JsonPropertyName("max_outstanding_write_requests")] public int? MaxOutstandingWriteRequests { get; set; } /// - /// The maximum number of operations to pull per read from the remote cluster. + /// + /// The maximum number of operations to pull per read from the remote cluster. + /// /// [JsonInclude, JsonPropertyName("max_read_request_operation_count")] public int? MaxReadRequestOperationCount { get; set; } /// - /// The maximum size in bytes of per read of a batch of operations pulled from the remote cluster. + /// + /// The maximum size in bytes of per read of a batch of operations pulled from the remote cluster. + /// /// [JsonInclude, JsonPropertyName("max_read_request_size")] public Elastic.Clients.Elasticsearch.ByteSize? MaxReadRequestSize { get; set; } /// - /// The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying. + /// + /// The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying. + /// /// [JsonInclude, JsonPropertyName("max_retry_delay")] public Elastic.Clients.Elasticsearch.Duration? MaxRetryDelay { get; set; } /// - /// The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the number of queued operations goes below the limit. + /// + /// The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the number of queued operations goes below the limit. + /// /// [JsonInclude, JsonPropertyName("max_write_buffer_count")] public int? MaxWriteBufferCount { get; set; } /// - /// The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the total bytes of queued operations goes below the limit. + /// + /// The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the total bytes of queued operations goes below the limit. + /// /// [JsonInclude, JsonPropertyName("max_write_buffer_size")] public Elastic.Clients.Elasticsearch.ByteSize? MaxWriteBufferSize { get; set; } /// - /// The maximum number of operations per bulk write request executed on the follower. + /// + /// The maximum number of operations per bulk write request executed on the follower. + /// /// [JsonInclude, JsonPropertyName("max_write_request_operation_count")] public int? MaxWriteRequestOperationCount { get; set; } /// - /// The maximum total bytes of operations per bulk write request executed on the follower. + /// + /// The maximum total bytes of operations per bulk write request executed on the follower. + /// /// [JsonInclude, JsonPropertyName("max_write_request_size")] public Elastic.Clients.Elasticsearch.ByteSize? MaxWriteRequestSize { get; set; } /// - /// The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. Then the follower will immediately attempt to read from the leader again. + /// + /// The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. Then the follower will immediately attempt to read from the leader again. + /// /// [JsonInclude, JsonPropertyName("read_poll_timeout")] public Elastic.Clients.Elasticsearch.Duration? ReadPollTimeout { get; set; } /// - /// The remote cluster containing the leader indices to match against. + /// + /// The remote cluster containing the leader indices to match against. + /// /// [JsonInclude, JsonPropertyName("remote_cluster")] public string RemoteCluster { get; set; } /// - /// Settings to override from the leader index. Note that certain settings can not be overrode (e.g., index.number_of_shards). + /// + /// Settings to override from the leader index. Note that certain settings can not be overrode (e.g., index.number_of_shards). + /// /// [JsonInclude, JsonPropertyName("settings")] public IDictionary? Settings { get; set; } } /// -/// Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. +/// +/// Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. +/// /// public sealed partial class PutAutoFollowPatternRequestDescriptor : RequestDescriptor { @@ -183,7 +217,9 @@ public PutAutoFollowPatternRequestDescriptor Name(Elastic.Clients.Elasticsearch. private IDictionary? SettingsValue { get; set; } /// - /// The name of follower index. The template {{leader_index}} can be used to derive the name of the follower index from the name of the leader index. When following a data stream, use {{leader_index}}; CCR does not support changes to the names of a follower data stream’s backing indices. + /// + /// The name of follower index. The template {{leader_index}} can be used to derive the name of the follower index from the name of the leader index. When following a data stream, use {{leader_index}}; CCR does not support changes to the names of a follower data stream’s backing indices. + /// /// public PutAutoFollowPatternRequestDescriptor FollowIndexPattern(string? followIndexPattern) { @@ -192,7 +228,9 @@ public PutAutoFollowPatternRequestDescriptor FollowIndexPattern(string? followIn } /// - /// An array of simple index patterns that can be used to exclude indices from being auto-followed. Indices in the remote cluster whose names are matching one or more leader_index_patterns and one or more leader_index_exclusion_patterns won’t be followed. + /// + /// An array of simple index patterns that can be used to exclude indices from being auto-followed. Indices in the remote cluster whose names are matching one or more leader_index_patterns and one or more leader_index_exclusion_patterns won’t be followed. + /// /// public PutAutoFollowPatternRequestDescriptor LeaderIndexExclusionPatterns(ICollection? leaderIndexExclusionPatterns) { @@ -201,7 +239,9 @@ public PutAutoFollowPatternRequestDescriptor LeaderIndexExclusionPatterns(IColle } /// - /// An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field. + /// + /// An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field. + /// /// public PutAutoFollowPatternRequestDescriptor LeaderIndexPatterns(ICollection? leaderIndexPatterns) { @@ -210,7 +250,9 @@ public PutAutoFollowPatternRequestDescriptor LeaderIndexPatterns(ICollection - /// The maximum number of outstanding reads requests from the remote cluster. + /// + /// The maximum number of outstanding reads requests from the remote cluster. + /// /// public PutAutoFollowPatternRequestDescriptor MaxOutstandingReadRequests(int? maxOutstandingReadRequests) { @@ -219,7 +261,9 @@ public PutAutoFollowPatternRequestDescriptor MaxOutstandingReadRequests(int? max } /// - /// The maximum number of outstanding reads requests from the remote cluster. + /// + /// The maximum number of outstanding reads requests from the remote cluster. + /// /// public PutAutoFollowPatternRequestDescriptor MaxOutstandingWriteRequests(int? maxOutstandingWriteRequests) { @@ -228,7 +272,9 @@ public PutAutoFollowPatternRequestDescriptor MaxOutstandingWriteRequests(int? ma } /// - /// The maximum number of operations to pull per read from the remote cluster. + /// + /// The maximum number of operations to pull per read from the remote cluster. + /// /// public PutAutoFollowPatternRequestDescriptor MaxReadRequestOperationCount(int? maxReadRequestOperationCount) { @@ -237,7 +283,9 @@ public PutAutoFollowPatternRequestDescriptor MaxReadRequestOperationCount(int? m } /// - /// The maximum size in bytes of per read of a batch of operations pulled from the remote cluster. + /// + /// The maximum size in bytes of per read of a batch of operations pulled from the remote cluster. + /// /// public PutAutoFollowPatternRequestDescriptor MaxReadRequestSize(Elastic.Clients.Elasticsearch.ByteSize? maxReadRequestSize) { @@ -246,7 +294,9 @@ public PutAutoFollowPatternRequestDescriptor MaxReadRequestSize(Elastic.Clients. } /// - /// The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying. + /// + /// The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying. + /// /// public PutAutoFollowPatternRequestDescriptor MaxRetryDelay(Elastic.Clients.Elasticsearch.Duration? maxRetryDelay) { @@ -255,7 +305,9 @@ public PutAutoFollowPatternRequestDescriptor MaxRetryDelay(Elastic.Clients.Elast } /// - /// The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the number of queued operations goes below the limit. + /// + /// The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the number of queued operations goes below the limit. + /// /// public PutAutoFollowPatternRequestDescriptor MaxWriteBufferCount(int? maxWriteBufferCount) { @@ -264,7 +316,9 @@ public PutAutoFollowPatternRequestDescriptor MaxWriteBufferCount(int? maxWriteBu } /// - /// The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the total bytes of queued operations goes below the limit. + /// + /// The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the total bytes of queued operations goes below the limit. + /// /// public PutAutoFollowPatternRequestDescriptor MaxWriteBufferSize(Elastic.Clients.Elasticsearch.ByteSize? maxWriteBufferSize) { @@ -273,7 +327,9 @@ public PutAutoFollowPatternRequestDescriptor MaxWriteBufferSize(Elastic.Clients. } /// - /// The maximum number of operations per bulk write request executed on the follower. + /// + /// The maximum number of operations per bulk write request executed on the follower. + /// /// public PutAutoFollowPatternRequestDescriptor MaxWriteRequestOperationCount(int? maxWriteRequestOperationCount) { @@ -282,7 +338,9 @@ public PutAutoFollowPatternRequestDescriptor MaxWriteRequestOperationCount(int? } /// - /// The maximum total bytes of operations per bulk write request executed on the follower. + /// + /// The maximum total bytes of operations per bulk write request executed on the follower. + /// /// public PutAutoFollowPatternRequestDescriptor MaxWriteRequestSize(Elastic.Clients.Elasticsearch.ByteSize? maxWriteRequestSize) { @@ -291,7 +349,9 @@ public PutAutoFollowPatternRequestDescriptor MaxWriteRequestSize(Elastic.Clients } /// - /// The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. Then the follower will immediately attempt to read from the leader again. + /// + /// The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. Then the follower will immediately attempt to read from the leader again. + /// /// public PutAutoFollowPatternRequestDescriptor ReadPollTimeout(Elastic.Clients.Elasticsearch.Duration? readPollTimeout) { @@ -300,7 +360,9 @@ public PutAutoFollowPatternRequestDescriptor ReadPollTimeout(Elastic.Clients.Ela } /// - /// The remote cluster containing the leader indices to match against. + /// + /// The remote cluster containing the leader indices to match against. + /// /// public PutAutoFollowPatternRequestDescriptor RemoteCluster(string remoteCluster) { @@ -309,7 +371,9 @@ public PutAutoFollowPatternRequestDescriptor RemoteCluster(string remoteCluster) } /// - /// Settings to override from the leader index. Note that certain settings can not be overrode (e.g., index.number_of_shards). + /// + /// Settings to override from the leader index. Note that certain settings can not be overrode (e.g., index.number_of_shards). + /// /// public PutAutoFollowPatternRequestDescriptor Settings(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PutAutoFollowPatternResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PutAutoFollowPatternResponse.g.cs index 7c3a0564b7b..12a5140d0b3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PutAutoFollowPatternResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PutAutoFollowPatternResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.CrossClusterReplication; public sealed partial class PutAutoFollowPatternResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ResumeAutoFollowPatternRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ResumeAutoFollowPatternRequest.g.cs index c8a2a4c2675..cd7fb91615b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ResumeAutoFollowPatternRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ResumeAutoFollowPatternRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class ResumeAutoFollowPatternRequestParameters : RequestPa } /// -/// Resumes an auto-follow pattern that has been paused +/// +/// Resumes an auto-follow pattern that has been paused +/// /// public sealed partial class ResumeAutoFollowPatternRequest : PlainRequest { @@ -52,7 +54,9 @@ public ResumeAutoFollowPatternRequest(Elastic.Clients.Elasticsearch.Name name) : } /// -/// Resumes an auto-follow pattern that has been paused +/// +/// Resumes an auto-follow pattern that has been paused +/// /// public sealed partial class ResumeAutoFollowPatternRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ResumeAutoFollowPatternResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ResumeAutoFollowPatternResponse.g.cs index 64ca6e64f4c..c7cab6b189b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ResumeAutoFollowPatternResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ResumeAutoFollowPatternResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.CrossClusterReplication; public sealed partial class ResumeAutoFollowPatternResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ResumeFollowRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ResumeFollowRequest.g.cs index 7c972aecf2f..7c4fadcf762 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ResumeFollowRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ResumeFollowRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class ResumeFollowRequestParameters : RequestParameters } /// -/// Resumes a follower index that has been paused +/// +/// Resumes a follower index that has been paused +/// /// public sealed partial class ResumeFollowRequest : PlainRequest { @@ -73,7 +75,9 @@ public ResumeFollowRequest(Elastic.Clients.Elasticsearch.IndexName index) : base } /// -/// Resumes a follower index that has been paused +/// +/// Resumes a follower index that has been paused +/// /// public sealed partial class ResumeFollowRequestDescriptor : RequestDescriptor, ResumeFollowRequestParameters> { @@ -240,7 +244,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Resumes a follower index that has been paused +/// +/// Resumes a follower index that has been paused +/// /// public sealed partial class ResumeFollowRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ResumeFollowResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ResumeFollowResponse.g.cs index 13c08f6f707..0a11009556d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ResumeFollowResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ResumeFollowResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.CrossClusterReplication; public sealed partial class ResumeFollowResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/UnfollowRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/UnfollowRequest.g.cs index 52fa7cc5436..2dae9dd50fc 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/UnfollowRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/UnfollowRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class UnfollowRequestParameters : RequestParameters } /// -/// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. +/// +/// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. +/// /// public sealed partial class UnfollowRequest : PlainRequest { @@ -52,7 +54,9 @@ public UnfollowRequest(Elastic.Clients.Elasticsearch.IndexName index) : base(r = } /// -/// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. +/// +/// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. +/// /// public sealed partial class UnfollowRequestDescriptor : RequestDescriptor, UnfollowRequestParameters> { @@ -86,7 +90,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. +/// +/// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. +/// /// public sealed partial class UnfollowRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/UnfollowResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/UnfollowResponse.g.cs index 9ddfba42a37..ee58b3bcbb8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/UnfollowResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/UnfollowResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.CrossClusterReplication; public sealed partial class UnfollowResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/DanglingIndices/ListDanglingIndicesRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/DanglingIndices/ListDanglingIndicesRequest.g.cs index 5f7ef4a6584..833cfd898c5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/DanglingIndices/ListDanglingIndicesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/DanglingIndices/ListDanglingIndicesRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class ListDanglingIndicesRequestParameters : RequestParame } /// -/// Returns all dangling indices. +/// +/// Returns all dangling indices. +/// /// public sealed partial class ListDanglingIndicesRequest : PlainRequest { @@ -48,7 +50,9 @@ public sealed partial class ListDanglingIndicesRequest : PlainRequest -/// Returns all dangling indices. +/// +/// Returns all dangling indices. +/// /// public sealed partial class ListDanglingIndicesRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/DeleteByQueryRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/DeleteByQueryRequest.g.cs index d9fc3cff3d6..838ab44281d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/DeleteByQueryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/DeleteByQueryRequest.g.cs @@ -32,148 +32,222 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class DeleteByQueryRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices.
For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Analyzer to use for the query string. + /// + /// Analyzer to use for the query string. + /// /// public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// - /// If `true`, wildcard and prefix queries are analyzed. + /// + /// If true, wildcard and prefix queries are analyzed. + /// /// public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } /// - /// What to do if delete by query hits version conflicts: `abort` or `proceed`. + /// + /// What to do if delete by query hits version conflicts: abort or proceed. + /// /// public Elastic.Clients.Elasticsearch.Conflicts? Conflicts { get => Q("conflicts"); set => Q("conflicts", value); } /// - /// The default operator for query string query: `AND` or `OR`. + /// + /// The default operator for query string query: AND or OR. + /// /// public Elastic.Clients.Elasticsearch.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } /// - /// Field to use as default where no field prefix is given in the query string. + /// + /// Field to use as default where no field prefix is given in the query string. + /// /// public string? Df { get => Q("df"); set => Q("df", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Starting offset (default: 0) + /// + /// Starting offset (default: 0) + /// /// public long? From { get => Q("from"); set => Q("from", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// + /// If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// /// public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// Query in the Lucene query string syntax. + /// + /// Query in the Lucene query string syntax. + /// /// public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } /// - /// If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes. + /// + /// If true, Elasticsearch refreshes all shards involved in the delete by query after the request completes. + /// /// public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// If `true`, the request cache is used for this request.
Defaults to the index-level setting. + /// + /// If true, the request cache is used for this request. + /// Defaults to the index-level setting. + /// /// public bool? RequestCache { get => Q("request_cache"); set => Q("request_cache", value); } /// - /// The throttle for this request in sub-requests per second. + /// + /// The throttle for this request in sub-requests per second. + /// /// public float? RequestsPerSecond { get => Q("requests_per_second"); set => Q("requests_per_second", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Period to retain the search context for scrolling. + /// + /// Period to retain the search context for scrolling. + /// /// public Elastic.Clients.Elasticsearch.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); } /// - /// Size of the scroll request that powers the operation. + /// + /// Size of the scroll request that powers the operation. + /// /// public long? ScrollSize { get => Q("scroll_size"); set => Q("scroll_size", value); } /// - /// Explicit timeout for each search request.
Defaults to no timeout. + /// + /// Explicit timeout for each search request. + /// Defaults to no timeout. + /// /// public Elastic.Clients.Elasticsearch.Duration? SearchTimeout { get => Q("search_timeout"); set => Q("search_timeout", value); } /// - /// The type of the search operation.
Available options: `query_then_fetch`, `dfs_query_then_fetch`. + /// + /// The type of the search operation. + /// Available options: query_then_fetch, dfs_query_then_fetch. + /// /// public Elastic.Clients.Elasticsearch.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } /// - /// The number of slices this task should be divided into. + /// + /// The number of slices this task should be divided into. + /// /// public Elastic.Clients.Elasticsearch.Slices? Slices { get => Q("slices"); set => Q("slices", value); } /// - /// A comma-separated list of : pairs. + /// + /// A comma-separated list of <field>:<direction> pairs. + /// /// public ICollection? Sort { get => Q?>("sort"); set => Q("sort", value); } /// - /// Specific `tag` of the request for logging and statistical purposes. + /// + /// Specific tag of the request for logging and statistical purposes. + /// /// public ICollection? Stats { get => Q?>("stats"); set => Q("stats", value); } /// - /// Maximum number of documents to collect for each shard.
If a query reaches this limit, Elasticsearch terminates the query early.
Elasticsearch collects documents before sorting.
Use with caution.
Elasticsearch applies this parameter to each shard handling the request.
When possible, let Elasticsearch perform early termination automatically.
Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + /// + /// Maximum number of documents to collect for each shard. + /// If a query reaches this limit, Elasticsearch terminates the query early. + /// Elasticsearch collects documents before sorting. + /// Use with caution. + /// Elasticsearch applies this parameter to each shard handling the request. + /// When possible, let Elasticsearch perform early termination automatically. + /// Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + /// /// public long? TerminateAfter { get => Q("terminate_after"); set => Q("terminate_after", value); } /// - /// Period each deletion request waits for active shards. + /// + /// Period each deletion request waits for active shards. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// If `true`, returns the document version as part of a hit. + /// + /// If true, returns the document version as part of a hit. + /// /// public bool? Version { get => Q("version"); set => Q("version", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } /// - /// If `true`, the request blocks until the operation is complete. + /// + /// If true, the request blocks until the operation is complete. + /// /// public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Delete documents.
Deletes documents that match the specified query. +/// +/// Delete documents. +/// Deletes documents that match the specified query. +/// /// public sealed partial class DeleteByQueryRequest : PlainRequest { @@ -190,194 +264,274 @@ public DeleteByQueryRequest(Elastic.Clients.Elasticsearch.Indices indices) : bas internal override string OperationName => "delete_by_query"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices.
For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Analyzer to use for the query string. + /// + /// Analyzer to use for the query string. + /// /// [JsonIgnore] public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// - /// If `true`, wildcard and prefix queries are analyzed. + /// + /// If true, wildcard and prefix queries are analyzed. + /// /// [JsonIgnore] public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } /// - /// What to do if delete by query hits version conflicts: `abort` or `proceed`. + /// + /// What to do if delete by query hits version conflicts: abort or proceed. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Conflicts? Conflicts { get => Q("conflicts"); set => Q("conflicts", value); } /// - /// The default operator for query string query: `AND` or `OR`. + /// + /// The default operator for query string query: AND or OR. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } /// - /// Field to use as default where no field prefix is given in the query string. + /// + /// Field to use as default where no field prefix is given in the query string. + /// /// [JsonIgnore] public string? Df { get => Q("df"); set => Q("df", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Starting offset (default: 0) + /// + /// Starting offset (default: 0) + /// /// [JsonIgnore] public long? From { get => Q("from"); set => Q("from", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// + /// If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// /// [JsonIgnore] public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// Query in the Lucene query string syntax. + /// + /// Query in the Lucene query string syntax. + /// /// [JsonIgnore] public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } /// - /// If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes. + /// + /// If true, Elasticsearch refreshes all shards involved in the delete by query after the request completes. + /// /// [JsonIgnore] public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// If `true`, the request cache is used for this request.
Defaults to the index-level setting. + /// + /// If true, the request cache is used for this request. + /// Defaults to the index-level setting. + /// /// [JsonIgnore] public bool? RequestCache { get => Q("request_cache"); set => Q("request_cache", value); } /// - /// The throttle for this request in sub-requests per second. + /// + /// The throttle for this request in sub-requests per second. + /// /// [JsonIgnore] public float? RequestsPerSecond { get => Q("requests_per_second"); set => Q("requests_per_second", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Period to retain the search context for scrolling. + /// + /// Period to retain the search context for scrolling. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); } /// - /// Size of the scroll request that powers the operation. + /// + /// Size of the scroll request that powers the operation. + /// /// [JsonIgnore] public long? ScrollSize { get => Q("scroll_size"); set => Q("scroll_size", value); } /// - /// Explicit timeout for each search request.
Defaults to no timeout. + /// + /// Explicit timeout for each search request. + /// Defaults to no timeout. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? SearchTimeout { get => Q("search_timeout"); set => Q("search_timeout", value); } /// - /// The type of the search operation.
Available options: `query_then_fetch`, `dfs_query_then_fetch`. + /// + /// The type of the search operation. + /// Available options: query_then_fetch, dfs_query_then_fetch. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } /// - /// The number of slices this task should be divided into. + /// + /// The number of slices this task should be divided into. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Slices? Slices { get => Q("slices"); set => Q("slices", value); } /// - /// A comma-separated list of : pairs. + /// + /// A comma-separated list of <field>:<direction> pairs. + /// /// [JsonIgnore] public ICollection? Sort { get => Q?>("sort"); set => Q("sort", value); } /// - /// Specific `tag` of the request for logging and statistical purposes. + /// + /// Specific tag of the request for logging and statistical purposes. + /// /// [JsonIgnore] public ICollection? Stats { get => Q?>("stats"); set => Q("stats", value); } /// - /// Maximum number of documents to collect for each shard.
If a query reaches this limit, Elasticsearch terminates the query early.
Elasticsearch collects documents before sorting.
Use with caution.
Elasticsearch applies this parameter to each shard handling the request.
When possible, let Elasticsearch perform early termination automatically.
Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + /// + /// Maximum number of documents to collect for each shard. + /// If a query reaches this limit, Elasticsearch terminates the query early. + /// Elasticsearch collects documents before sorting. + /// Use with caution. + /// Elasticsearch applies this parameter to each shard handling the request. + /// When possible, let Elasticsearch perform early termination automatically. + /// Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + /// /// [JsonIgnore] public long? TerminateAfter { get => Q("terminate_after"); set => Q("terminate_after", value); } /// - /// Period each deletion request waits for active shards. + /// + /// Period each deletion request waits for active shards. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// If `true`, returns the document version as part of a hit. + /// + /// If true, returns the document version as part of a hit. + /// /// [JsonIgnore] public bool? Version { get => Q("version"); set => Q("version", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } /// - /// If `true`, the request blocks until the operation is complete. + /// + /// If true, the request blocks until the operation is complete. + /// /// [JsonIgnore] public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } /// - /// The maximum number of documents to delete. + /// + /// The maximum number of documents to delete. + /// /// [JsonInclude, JsonPropertyName("max_docs")] public long? MaxDocs { get; set; } /// - /// Specifies the documents to delete using the Query DSL. + /// + /// Specifies the documents to delete using the Query DSL. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Query { get; set; } /// - /// Slice the request manually using the provided slice ID and total number of slices. + /// + /// Slice the request manually using the provided slice ID and total number of slices. + /// /// [JsonInclude, JsonPropertyName("slice")] public Elastic.Clients.Elasticsearch.SlicedScroll? Slice { get; set; } } /// -/// Delete documents.
Deletes documents that match the specified query. +/// +/// Delete documents. +/// Deletes documents that match the specified query. +/// /// public sealed partial class DeleteByQueryRequestDescriptor : RequestDescriptor, DeleteByQueryRequestParameters> { @@ -443,7 +597,9 @@ public DeleteByQueryRequestDescriptor Indices(Elastic.Clients.Elastic private Action> SliceDescriptorAction { get; set; } /// - /// The maximum number of documents to delete. + /// + /// The maximum number of documents to delete. + /// /// public DeleteByQueryRequestDescriptor MaxDocs(long? maxDocs) { @@ -452,7 +608,9 @@ public DeleteByQueryRequestDescriptor MaxDocs(long? maxDocs) } /// - /// Specifies the documents to delete using the Query DSL. + /// + /// Specifies the documents to delete using the Query DSL. + /// /// public DeleteByQueryRequestDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -479,7 +637,9 @@ public DeleteByQueryRequestDescriptor Query(Action - /// Slice the request manually using the provided slice ID and total number of slices. + /// + /// Slice the request manually using the provided slice ID and total number of slices. + /// /// public DeleteByQueryRequestDescriptor Slice(Elastic.Clients.Elasticsearch.SlicedScroll? slice) { @@ -551,7 +711,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Delete documents.
Deletes documents that match the specified query. +/// +/// Delete documents. +/// Deletes documents that match the specified query. +/// /// public sealed partial class DeleteByQueryRequestDescriptor : RequestDescriptor { @@ -613,7 +776,9 @@ public DeleteByQueryRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indi private Action SliceDescriptorAction { get; set; } /// - /// The maximum number of documents to delete. + /// + /// The maximum number of documents to delete. + /// /// public DeleteByQueryRequestDescriptor MaxDocs(long? maxDocs) { @@ -622,7 +787,9 @@ public DeleteByQueryRequestDescriptor MaxDocs(long? maxDocs) } /// - /// Specifies the documents to delete using the Query DSL. + /// + /// Specifies the documents to delete using the Query DSL. + /// /// public DeleteByQueryRequestDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -649,7 +816,9 @@ public DeleteByQueryRequestDescriptor Query(Action - /// Slice the request manually using the provided slice ID and total number of slices. + /// + /// Slice the request manually using the provided slice ID and total number of slices. + /// /// public DeleteByQueryRequestDescriptor Slice(Elastic.Clients.Elasticsearch.SlicedScroll? slice) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/DeleteByQueryRethrottleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/DeleteByQueryRethrottleRequest.g.cs index 91caad419a1..0249bb3b36e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/DeleteByQueryRethrottleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/DeleteByQueryRethrottleRequest.g.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class DeleteByQueryRethrottleRequestParameters : RequestParameters { /// - /// The throttle for this request in sub-requests per second. + /// + /// The throttle for this request in sub-requests per second. + /// /// public float? RequestsPerSecond { get => Q("requests_per_second"); set => Q("requests_per_second", value); } } /// -/// Changes the number of requests per second for a particular Delete By Query operation. +/// +/// Changes the number of requests per second for a particular Delete By Query operation. +/// /// public sealed partial class DeleteByQueryRethrottleRequest : PlainRequest { @@ -55,14 +59,18 @@ public DeleteByQueryRethrottleRequest(Elastic.Clients.Elasticsearch.TaskId taskI internal override string OperationName => "delete_by_query_rethrottle"; /// - /// The throttle for this request in sub-requests per second. + /// + /// The throttle for this request in sub-requests per second. + /// /// [JsonIgnore] public float? RequestsPerSecond { get => Q("requests_per_second"); set => Q("requests_per_second", value); } } /// -/// Changes the number of requests per second for a particular Delete By Query operation. +/// +/// Changes the number of requests per second for a particular Delete By Query operation. +/// /// public sealed partial class DeleteByQueryRethrottleRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/DeleteByQueryRethrottleResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/DeleteByQueryRethrottleResponse.g.cs index 569c30c7690..1835de4dc4b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/DeleteByQueryRethrottleResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/DeleteByQueryRethrottleResponse.g.cs @@ -32,7 +32,9 @@ public sealed partial class DeleteByQueryRethrottleResponse : ElasticsearchRespo public IReadOnlyCollection? NodeFailures { get; init; } /// - /// Task information grouped by node, if `group_by` was set to `node` (the default). + /// + /// Task information grouped by node, if group_by was set to node (the default). + /// /// [JsonInclude, JsonPropertyName("nodes")] public IReadOnlyDictionary? Nodes { get; init; } @@ -40,7 +42,10 @@ public sealed partial class DeleteByQueryRethrottleResponse : ElasticsearchRespo public IReadOnlyCollection? TaskFailures { get; init; } /// - /// Either a flat list of tasks if `group_by` was set to `none`, or grouped by parents if
`group_by` was set to `parents`. + /// + /// Either a flat list of tasks if group_by was set to none, or grouped by parents if + /// group_by was set to parents. + /// /// [JsonInclude, JsonPropertyName("tasks")] public Elastic.Clients.Elasticsearch.Tasks.TaskInfos? Tasks { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/DeleteRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/DeleteRequest.g.cs index 55f9532f3db..21204ab4a47 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/DeleteRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/DeleteRequest.g.cs @@ -32,48 +32,70 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class DeleteRequestParameters : RequestParameters { /// - /// Only perform the operation if the document has this primary term. + /// + /// Only perform the operation if the document has this primary term. + /// /// public long? IfPrimaryTerm { get => Q("if_primary_term"); set => Q("if_primary_term", value); } /// - /// Only perform the operation if the document has this sequence number. + /// + /// Only perform the operation if the document has this sequence number. + /// /// public long? IfSeqNo { get => Q("if_seq_no"); set => Q("if_seq_no", value); } /// - /// If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.
Valid values: `true`, `false`, `wait_for`. + /// + /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false do nothing with refreshes. + /// Valid values: true, false, wait_for. + /// /// public Elastic.Clients.Elasticsearch.Refresh? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Period to wait for active shards. + /// + /// Period to wait for active shards. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Explicit version number for concurrency control.
The specified version must match the current version of the document for the request to succeed. + /// + /// Explicit version number for concurrency control. + /// The specified version must match the current version of the document for the request to succeed. + /// /// public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type: `external`, `external_gte`. + /// + /// Specific version type: external, external_gte. + /// /// public Elastic.Clients.Elasticsearch.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Delete a document.
Removes a JSON document from the specified index. +/// +/// Delete a document. +/// Removes a JSON document from the specified index. +/// /// public partial class DeleteRequest : PlainRequest { @@ -90,56 +112,78 @@ public DeleteRequest(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clie internal override string OperationName => "delete"; /// - /// Only perform the operation if the document has this primary term. + /// + /// Only perform the operation if the document has this primary term. + /// /// [JsonIgnore] public long? IfPrimaryTerm { get => Q("if_primary_term"); set => Q("if_primary_term", value); } /// - /// Only perform the operation if the document has this sequence number. + /// + /// Only perform the operation if the document has this sequence number. + /// /// [JsonIgnore] public long? IfSeqNo { get => Q("if_seq_no"); set => Q("if_seq_no", value); } /// - /// If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.
Valid values: `true`, `false`, `wait_for`. + /// + /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false do nothing with refreshes. + /// Valid values: true, false, wait_for. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Refresh? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Period to wait for active shards. + /// + /// Period to wait for active shards. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Explicit version number for concurrency control.
The specified version must match the current version of the document for the request to succeed. + /// + /// Explicit version number for concurrency control. + /// The specified version must match the current version of the document for the request to succeed. + /// /// [JsonIgnore] public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type: `external`, `external_gte`. + /// + /// Specific version type: external, external_gte. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Delete a document.
Removes a JSON document from the specified index. +/// +/// Delete a document. +/// Removes a JSON document from the specified index. +/// /// public sealed partial class DeleteRequestDescriptor : RequestDescriptor, DeleteRequestParameters> { @@ -200,7 +244,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Delete a document.
Removes a JSON document from the specified index. +/// +/// Delete a document. +/// Removes a JSON document from the specified index. +/// /// public sealed partial class DeleteRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/DeleteScriptRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/DeleteScriptRequest.g.cs index eb29800dc4f..c04439a7ae2 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/DeleteScriptRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/DeleteScriptRequest.g.cs @@ -32,18 +32,27 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class DeleteScriptRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// 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. +/// /// public sealed partial class DeleteScriptRequest : PlainRequest { @@ -60,20 +69,29 @@ public DeleteScriptRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Re internal override string OperationName => "delete_script"; /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// 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. +/// /// public sealed partial class DeleteScriptRequestDescriptor : RequestDescriptor, DeleteScriptRequestParameters> { @@ -106,7 +124,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// 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. +/// /// public sealed partial class DeleteScriptRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/DeleteScriptResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/DeleteScriptResponse.g.cs index ad0375f61bc..660b7f3a641 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/DeleteScriptResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/DeleteScriptResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class DeleteScriptResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/DeletePolicyRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/DeletePolicyRequest.g.cs index 1219eb6b9dd..cb1be69ee44 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/DeletePolicyRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/DeletePolicyRequest.g.cs @@ -34,7 +34,10 @@ public sealed partial class DeletePolicyRequestParameters : RequestParameters } /// -/// Delete an enrich policy.
Deletes an existing enrich policy and its enrich index. +/// +/// Delete an enrich policy. +/// Deletes an existing enrich policy and its enrich index. +/// /// public sealed partial class DeletePolicyRequest : PlainRequest { @@ -52,7 +55,10 @@ public DeletePolicyRequest(Elastic.Clients.Elasticsearch.Name name) : base(r => } /// -/// Delete an enrich policy.
Deletes an existing enrich policy and its enrich index. +/// +/// Delete an enrich policy. +/// Deletes an existing enrich policy and its enrich index. +/// /// public sealed partial class DeletePolicyRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/DeletePolicyResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/DeletePolicyResponse.g.cs index 3f4bcd5d5ec..ce4f5649cb9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/DeletePolicyResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/DeletePolicyResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Enrich; public sealed partial class DeletePolicyResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/EnrichStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/EnrichStatsRequest.g.cs index eb190d3cef3..ed7d5ceab9e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/EnrichStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/EnrichStatsRequest.g.cs @@ -34,7 +34,10 @@ public sealed partial class EnrichStatsRequestParameters : RequestParameters } /// -/// Get enrich stats.
Returns enrich coordinator statistics and information about enrich policies that are currently executing. +/// +/// Get enrich stats. +/// Returns enrich coordinator statistics and information about enrich policies that are currently executing. +/// /// public sealed partial class EnrichStatsRequest : PlainRequest { @@ -48,7 +51,10 @@ public sealed partial class EnrichStatsRequest : PlainRequest -/// Get enrich stats.
Returns enrich coordinator statistics and information about enrich policies that are currently executing. +/// +/// Get enrich stats. +/// Returns enrich coordinator statistics and information about enrich policies that are currently executing. +/// /// public sealed partial class EnrichStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/EnrichStatsResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/EnrichStatsResponse.g.cs index 97edca927ff..9e9551fdeb4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/EnrichStatsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/EnrichStatsResponse.g.cs @@ -29,19 +29,25 @@ namespace Elastic.Clients.Elasticsearch.Enrich; public sealed partial class EnrichStatsResponse : ElasticsearchResponse { /// - /// Objects containing information about the enrich cache stats on each ingest node. + /// + /// Objects containing information about the enrich cache stats on each ingest node. + /// /// [JsonInclude, JsonPropertyName("cache_stats")] public IReadOnlyCollection? CacheStats { get; init; } /// - /// Objects containing information about each coordinating ingest node for configured enrich processors. + /// + /// Objects containing information about each coordinating ingest node for configured enrich processors. + /// /// [JsonInclude, JsonPropertyName("coordinator_stats")] public IReadOnlyCollection CoordinatorStats { get; init; } /// - /// Objects containing information about each enrich policy that is currently executing. + /// + /// Objects containing information about each enrich policy that is currently executing. + /// /// [JsonInclude, JsonPropertyName("executing_policies")] public IReadOnlyCollection ExecutingPolicies { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/ExecutePolicyRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/ExecutePolicyRequest.g.cs index aa34a75d88b..322dbe70e38 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/ExecutePolicyRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/ExecutePolicyRequest.g.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch.Enrich; public sealed partial class ExecutePolicyRequestParameters : RequestParameters { /// - /// If `true`, the request blocks other enrich policy execution requests until complete. + /// + /// If true, the request blocks other enrich policy execution requests until complete. + /// /// public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Creates the enrich index for an existing enrich policy. +/// +/// Creates the enrich index for an existing enrich policy. +/// /// public sealed partial class ExecutePolicyRequest : PlainRequest { @@ -55,14 +59,18 @@ public ExecutePolicyRequest(Elastic.Clients.Elasticsearch.Name name) : base(r => internal override string OperationName => "enrich.execute_policy"; /// - /// If `true`, the request blocks other enrich policy execution requests until complete. + /// + /// If true, the request blocks other enrich policy execution requests until complete. + /// /// [JsonIgnore] public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Creates the enrich index for an existing enrich policy. +/// +/// Creates the enrich index for an existing enrich policy. +/// /// public sealed partial class ExecutePolicyRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/GetPolicyRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/GetPolicyRequest.g.cs index c002d4b7529..c59336a0cb5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/GetPolicyRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/GetPolicyRequest.g.cs @@ -34,7 +34,10 @@ public sealed partial class GetPolicyRequestParameters : RequestParameters } /// -/// Get an enrich policy.
Returns information about an enrich policy. +/// +/// Get an enrich policy. +/// Returns information about an enrich policy. +/// /// public sealed partial class GetPolicyRequest : PlainRequest { @@ -56,7 +59,10 @@ public GetPolicyRequest(Elastic.Clients.Elasticsearch.Names? name) : base(r => r } /// -/// Get an enrich policy.
Returns information about an enrich policy. +/// +/// Get an enrich policy. +/// Returns information about an enrich policy. +/// /// public sealed partial class GetPolicyRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/PutPolicyRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/PutPolicyRequest.g.cs index 51a3306f9b3..bc543c0e396 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/PutPolicyRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/PutPolicyRequest.g.cs @@ -34,7 +34,10 @@ public sealed partial class PutPolicyRequestParameters : RequestParameters } /// -/// Create an enrich policy.
Creates an enrich policy. +/// +/// Create an enrich policy. +/// Creates an enrich policy. +/// /// public sealed partial class PutPolicyRequest : PlainRequest { @@ -51,26 +54,35 @@ public PutPolicyRequest(Elastic.Clients.Elasticsearch.Name name) : base(r => r.R internal override string OperationName => "enrich.put_policy"; /// - /// Matches enrich data to incoming documents based on a `geo_shape` query. + /// + /// Matches enrich data to incoming documents based on a geo_shape query. + /// /// [JsonInclude, JsonPropertyName("geo_match")] public Elastic.Clients.Elasticsearch.Enrich.EnrichPolicy? GeoMatch { get; set; } /// - /// Matches enrich data to incoming documents based on a `term` query. + /// + /// Matches enrich data to incoming documents based on a term query. + /// /// [JsonInclude, JsonPropertyName("match")] public Elastic.Clients.Elasticsearch.Enrich.EnrichPolicy? Match { get; set; } /// - /// Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a `term` query. + /// + /// Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a term query. + /// /// [JsonInclude, JsonPropertyName("range")] public Elastic.Clients.Elasticsearch.Enrich.EnrichPolicy? Range { get; set; } } /// -/// Create an enrich policy.
Creates an enrich policy. +/// +/// Create an enrich policy. +/// Creates an enrich policy. +/// /// public sealed partial class PutPolicyRequestDescriptor : RequestDescriptor, PutPolicyRequestParameters> { @@ -105,7 +117,9 @@ public PutPolicyRequestDescriptor Name(Elastic.Clients.Elasticsearch. private Action> RangeDescriptorAction { get; set; } /// - /// Matches enrich data to incoming documents based on a `geo_shape` query. + /// + /// Matches enrich data to incoming documents based on a geo_shape query. + /// /// public PutPolicyRequestDescriptor GeoMatch(Elastic.Clients.Elasticsearch.Enrich.EnrichPolicy? geoMatch) { @@ -132,7 +146,9 @@ public PutPolicyRequestDescriptor GeoMatch(Action - /// Matches enrich data to incoming documents based on a `term` query. + /// + /// Matches enrich data to incoming documents based on a term query. + /// /// public PutPolicyRequestDescriptor Match(Elastic.Clients.Elasticsearch.Enrich.EnrichPolicy? match) { @@ -159,7 +175,9 @@ public PutPolicyRequestDescriptor Match(Action - /// Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a `term` query. + /// + /// Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a term query. + /// /// public PutPolicyRequestDescriptor Range(Elastic.Clients.Elasticsearch.Enrich.EnrichPolicy? range) { @@ -241,7 +259,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Create an enrich policy.
Creates an enrich policy. +/// +/// Create an enrich policy. +/// Creates an enrich policy. +/// /// public sealed partial class PutPolicyRequestDescriptor : RequestDescriptor { @@ -276,7 +297,9 @@ public PutPolicyRequestDescriptor Name(Elastic.Clients.Elasticsearch.Name name) private Action RangeDescriptorAction { get; set; } /// - /// Matches enrich data to incoming documents based on a `geo_shape` query. + /// + /// Matches enrich data to incoming documents based on a geo_shape query. + /// /// public PutPolicyRequestDescriptor GeoMatch(Elastic.Clients.Elasticsearch.Enrich.EnrichPolicy? geoMatch) { @@ -303,7 +326,9 @@ public PutPolicyRequestDescriptor GeoMatch(Action - /// Matches enrich data to incoming documents based on a `term` query. + /// + /// Matches enrich data to incoming documents based on a term query. + /// /// public PutPolicyRequestDescriptor Match(Elastic.Clients.Elasticsearch.Enrich.EnrichPolicy? match) { @@ -330,7 +355,9 @@ public PutPolicyRequestDescriptor Match(Action - /// Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a `term` query. + /// + /// Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a term query. + /// /// public PutPolicyRequestDescriptor Range(Elastic.Clients.Elasticsearch.Enrich.EnrichPolicy? range) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/PutPolicyResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/PutPolicyResponse.g.cs index c41ba1af1e7..b1c1eb5625c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/PutPolicyResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/PutPolicyResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Enrich; public sealed partial class PutPolicyResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlDeleteRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlDeleteRequest.g.cs index 283607b7289..1cbdbeb07fa 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlDeleteRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlDeleteRequest.g.cs @@ -34,7 +34,10 @@ public sealed partial class EqlDeleteRequestParameters : RequestParameters } /// -/// Deletes an async EQL search or a stored synchronous EQL search.
The API also deletes results for the search. +/// +/// Deletes an async EQL search or a stored synchronous EQL search. +/// The API also deletes results for the search. +/// /// public sealed partial class EqlDeleteRequest : PlainRequest { @@ -52,7 +55,10 @@ public EqlDeleteRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Requi } /// -/// Deletes an async EQL search or a stored synchronous EQL search.
The API also deletes results for the search. +/// +/// Deletes an async EQL search or a stored synchronous EQL search. +/// The API also deletes results for the search. +/// /// public sealed partial class EqlDeleteRequestDescriptor : RequestDescriptor, EqlDeleteRequestParameters> { @@ -82,7 +88,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Deletes an async EQL search or a stored synchronous EQL search.
The API also deletes results for the search. +/// +/// Deletes an async EQL search or a stored synchronous EQL search. +/// The API also deletes results for the search. +/// /// public sealed partial class EqlDeleteRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlDeleteResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlDeleteResponse.g.cs index edec0bdb190..2ab88cfe2cc 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlDeleteResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlDeleteResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Eql; public sealed partial class EqlDeleteResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlGetRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlGetRequest.g.cs index 6e080a9e9db..903322e1e12 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlGetRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlGetRequest.g.cs @@ -32,18 +32,26 @@ namespace Elastic.Clients.Elasticsearch.Eql; public sealed partial class EqlGetRequestParameters : RequestParameters { /// - /// Period for which the search and its results are stored on the cluster.
Defaults to the keep_alive value set by the search’s EQL search API request. + /// + /// Period for which the search and its results are stored on the cluster. + /// Defaults to the keep_alive value set by the search’s EQL search API request. + /// /// public Elastic.Clients.Elasticsearch.Duration? KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); } /// - /// Timeout duration to wait for the request to finish.
Defaults to no timeout, meaning the request waits for complete search results. + /// + /// Timeout duration to wait for the request to finish. + /// Defaults to no timeout, meaning the request waits for complete search results. + /// /// public Elastic.Clients.Elasticsearch.Duration? WaitForCompletionTimeout { get => Q("wait_for_completion_timeout"); set => Q("wait_for_completion_timeout", value); } } /// -/// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. +/// +/// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. +/// /// public sealed partial class EqlGetRequest : PlainRequest { @@ -60,20 +68,28 @@ public EqlGetRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required internal override string OperationName => "eql.get"; /// - /// Period for which the search and its results are stored on the cluster.
Defaults to the keep_alive value set by the search’s EQL search API request. + /// + /// Period for which the search and its results are stored on the cluster. + /// Defaults to the keep_alive value set by the search’s EQL search API request. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); } /// - /// Timeout duration to wait for the request to finish.
Defaults to no timeout, meaning the request waits for complete search results. + /// + /// Timeout duration to wait for the request to finish. + /// Defaults to no timeout, meaning the request waits for complete search results. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? WaitForCompletionTimeout { get => Q("wait_for_completion_timeout"); set => Q("wait_for_completion_timeout", value); } } /// -/// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. +/// +/// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. +/// /// public sealed partial class EqlGetRequestDescriptor : RequestDescriptor, EqlGetRequestParameters> { @@ -106,7 +122,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. +/// +/// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. +/// /// public sealed partial class EqlGetRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlGetResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlGetResponse.g.cs index 6cf3a6e7de8..b808cd86302 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlGetResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlGetResponse.g.cs @@ -29,37 +29,49 @@ namespace Elastic.Clients.Elasticsearch.Eql; public sealed partial class EqlGetResponse : ElasticsearchResponse { /// - /// Contains matching events and sequences. Also contains related metadata. + /// + /// Contains matching events and sequences. Also contains related metadata. + /// /// [JsonInclude, JsonPropertyName("hits")] public Elastic.Clients.Elasticsearch.Eql.EqlHits Hits { get; init; } /// - /// Identifier for the search. + /// + /// Identifier for the search. + /// /// [JsonInclude, JsonPropertyName("id")] public string? Id { get; init; } /// - /// If true, the response does not contain complete search results. + /// + /// If true, the response does not contain complete search results. + /// /// [JsonInclude, JsonPropertyName("is_partial")] public bool? IsPartial { get; init; } /// - /// If true, the search request is still executing. + /// + /// If true, the search request is still executing. + /// /// [JsonInclude, JsonPropertyName("is_running")] public bool? IsRunning { get; init; } /// - /// If true, the request timed out before completion. + /// + /// If true, the request timed out before completion. + /// /// [JsonInclude, JsonPropertyName("timed_out")] public bool? TimedOut { get; init; } /// - /// Milliseconds it took Elasticsearch to execute the request. + /// + /// Milliseconds it took Elasticsearch to execute the request. + /// /// [JsonInclude, JsonPropertyName("took")] public long? Took { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlSearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlSearchRequest.g.cs index 2cf9b20938d..b3faf27c573 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlSearchRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlSearchRequest.g.cs @@ -35,13 +35,17 @@ public sealed partial class EqlSearchRequestParameters : RequestParameters public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If true, missing or closed indices are not included in the response. + /// + /// If true, missing or closed indices are not included in the response. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } } /// -/// Returns results matching a query expressed in Event Query Language (EQL) +/// +/// Returns results matching a query expressed in Event Query Language (EQL) +/// /// public sealed partial class EqlSearchRequest : PlainRequest { @@ -63,7 +67,9 @@ public EqlSearchRequest(Elastic.Clients.Elasticsearch.Indices indices) : base(r public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If true, missing or closed indices are not included in the response. + /// + /// If true, missing or closed indices are not included in the response. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } @@ -71,26 +77,34 @@ public EqlSearchRequest(Elastic.Clients.Elasticsearch.Indices indices) : base(r public bool? CaseSensitive { get; set; } /// - /// Field containing the event classification, such as process, file, or network. + /// + /// Field containing the event classification, such as process, file, or network. + /// /// [JsonInclude, JsonPropertyName("event_category_field")] public Elastic.Clients.Elasticsearch.Field? EventCategoryField { get; set; } /// - /// Maximum number of events to search at a time for sequence queries. + /// + /// Maximum number of events to search at a time for sequence queries. + /// /// [JsonInclude, JsonPropertyName("fetch_size")] public int? FetchSize { get; set; } /// - /// Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit. + /// + /// Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit. + /// /// [JsonInclude, JsonPropertyName("fields")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.QueryDsl.FieldAndFormat))] public ICollection? Fields { get; set; } /// - /// Query, written in Query DSL, used to filter the events on which the EQL query runs. + /// + /// Query, written in Query DSL, used to filter the events on which the EQL query runs. + /// /// [JsonInclude, JsonPropertyName("filter")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.QueryDsl.Query))] @@ -101,7 +115,9 @@ public EqlSearchRequest(Elastic.Clients.Elasticsearch.Indices indices) : base(r public bool? KeepOnCompletion { get; set; } /// - /// EQL query you wish to run. + /// + /// EQL query you wish to run. + /// /// [JsonInclude, JsonPropertyName("query")] public string Query { get; set; } @@ -111,19 +127,25 @@ public EqlSearchRequest(Elastic.Clients.Elasticsearch.Indices indices) : base(r public IDictionary? RuntimeMappings { get; set; } /// - /// For basic queries, the maximum number of matching events to return. Defaults to 10 + /// + /// For basic queries, the maximum number of matching events to return. Defaults to 10 + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// Field used to sort hits with the same timestamp in ascending order + /// + /// Field used to sort hits with the same timestamp in ascending order + /// /// [JsonInclude, JsonPropertyName("tiebreaker_field")] public Elastic.Clients.Elasticsearch.Field? TiebreakerField { get; set; } /// - /// Field containing event timestamp. Default "@timestamp" + /// + /// Field containing event timestamp. Default "@timestamp" + /// /// [JsonInclude, JsonPropertyName("timestamp_field")] public Elastic.Clients.Elasticsearch.Field? TimestampField { get; set; } @@ -132,7 +154,9 @@ public EqlSearchRequest(Elastic.Clients.Elasticsearch.Indices indices) : base(r } /// -/// Returns results matching a query expressed in Event Query Language (EQL) +/// +/// Returns results matching a query expressed in Event Query Language (EQL) +/// /// public sealed partial class EqlSearchRequestDescriptor : RequestDescriptor, EqlSearchRequestParameters> { @@ -192,7 +216,9 @@ public EqlSearchRequestDescriptor CaseSensitive(bool? caseSensitive = } /// - /// Field containing the event classification, such as process, file, or network. + /// + /// Field containing the event classification, such as process, file, or network. + /// /// public EqlSearchRequestDescriptor EventCategoryField(Elastic.Clients.Elasticsearch.Field? eventCategoryField) { @@ -201,7 +227,9 @@ public EqlSearchRequestDescriptor EventCategoryField(Elastic.Clients. } /// - /// Field containing the event classification, such as process, file, or network. + /// + /// Field containing the event classification, such as process, file, or network. + /// /// public EqlSearchRequestDescriptor EventCategoryField(Expression> eventCategoryField) { @@ -210,7 +238,9 @@ public EqlSearchRequestDescriptor EventCategoryField(Expressi } /// - /// Field containing the event classification, such as process, file, or network. + /// + /// Field containing the event classification, such as process, file, or network. + /// /// public EqlSearchRequestDescriptor EventCategoryField(Expression> eventCategoryField) { @@ -219,7 +249,9 @@ public EqlSearchRequestDescriptor EventCategoryField(Expression - /// Maximum number of events to search at a time for sequence queries. + /// + /// Maximum number of events to search at a time for sequence queries. + /// /// public EqlSearchRequestDescriptor FetchSize(int? fetchSize) { @@ -228,7 +260,9 @@ public EqlSearchRequestDescriptor FetchSize(int? fetchSize) } /// - /// Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit. + /// + /// Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit. + /// /// public EqlSearchRequestDescriptor Fields(ICollection? fields) { @@ -267,7 +301,9 @@ public EqlSearchRequestDescriptor Fields(params Action - /// Query, written in Query DSL, used to filter the events on which the EQL query runs. + /// + /// Query, written in Query DSL, used to filter the events on which the EQL query runs. + /// /// public EqlSearchRequestDescriptor Filter(ICollection? filter) { @@ -318,7 +354,9 @@ public EqlSearchRequestDescriptor KeepOnCompletion(bool? keepOnComple } /// - /// EQL query you wish to run. + /// + /// EQL query you wish to run. + /// /// public EqlSearchRequestDescriptor Query(string query) { @@ -339,7 +377,9 @@ public EqlSearchRequestDescriptor RuntimeMappings(Func - /// For basic queries, the maximum number of matching events to return. Defaults to 10 + /// + /// For basic queries, the maximum number of matching events to return. Defaults to 10 + /// /// public EqlSearchRequestDescriptor Size(int? size) { @@ -348,7 +388,9 @@ public EqlSearchRequestDescriptor Size(int? size) } /// - /// Field used to sort hits with the same timestamp in ascending order + /// + /// Field used to sort hits with the same timestamp in ascending order + /// /// public EqlSearchRequestDescriptor TiebreakerField(Elastic.Clients.Elasticsearch.Field? tiebreakerField) { @@ -357,7 +399,9 @@ public EqlSearchRequestDescriptor TiebreakerField(Elastic.Clients.Ela } /// - /// Field used to sort hits with the same timestamp in ascending order + /// + /// Field used to sort hits with the same timestamp in ascending order + /// /// public EqlSearchRequestDescriptor TiebreakerField(Expression> tiebreakerField) { @@ -366,7 +410,9 @@ public EqlSearchRequestDescriptor TiebreakerField(Expression< } /// - /// Field used to sort hits with the same timestamp in ascending order + /// + /// Field used to sort hits with the same timestamp in ascending order + /// /// public EqlSearchRequestDescriptor TiebreakerField(Expression> tiebreakerField) { @@ -375,7 +421,9 @@ public EqlSearchRequestDescriptor TiebreakerField(Expression - /// Field containing event timestamp. Default "@timestamp" + /// + /// Field containing event timestamp. Default "@timestamp" + /// /// public EqlSearchRequestDescriptor TimestampField(Elastic.Clients.Elasticsearch.Field? timestampField) { @@ -384,7 +432,9 @@ public EqlSearchRequestDescriptor TimestampField(Elastic.Clients.Elas } /// - /// Field containing event timestamp. Default "@timestamp" + /// + /// Field containing event timestamp. Default "@timestamp" + /// /// public EqlSearchRequestDescriptor TimestampField(Expression> timestampField) { @@ -393,7 +443,9 @@ public EqlSearchRequestDescriptor TimestampField(Expression - /// Field containing event timestamp. Default "@timestamp" + /// + /// Field containing event timestamp. Default "@timestamp" + /// /// public EqlSearchRequestDescriptor TimestampField(Expression> timestampField) { @@ -541,7 +593,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns results matching a query expressed in Event Query Language (EQL) +/// +/// Returns results matching a query expressed in Event Query Language (EQL) +/// /// public sealed partial class EqlSearchRequestDescriptor : RequestDescriptor { @@ -597,7 +651,9 @@ public EqlSearchRequestDescriptor CaseSensitive(bool? caseSensitive = true) } /// - /// Field containing the event classification, such as process, file, or network. + /// + /// Field containing the event classification, such as process, file, or network. + /// /// public EqlSearchRequestDescriptor EventCategoryField(Elastic.Clients.Elasticsearch.Field? eventCategoryField) { @@ -606,7 +662,9 @@ public EqlSearchRequestDescriptor EventCategoryField(Elastic.Clients.Elasticsear } /// - /// Field containing the event classification, such as process, file, or network. + /// + /// Field containing the event classification, such as process, file, or network. + /// /// public EqlSearchRequestDescriptor EventCategoryField(Expression> eventCategoryField) { @@ -615,7 +673,9 @@ public EqlSearchRequestDescriptor EventCategoryField(Expressi } /// - /// Field containing the event classification, such as process, file, or network. + /// + /// Field containing the event classification, such as process, file, or network. + /// /// public EqlSearchRequestDescriptor EventCategoryField(Expression> eventCategoryField) { @@ -624,7 +684,9 @@ public EqlSearchRequestDescriptor EventCategoryField(Expression - /// Maximum number of events to search at a time for sequence queries. + /// + /// Maximum number of events to search at a time for sequence queries. + /// /// public EqlSearchRequestDescriptor FetchSize(int? fetchSize) { @@ -633,7 +695,9 @@ public EqlSearchRequestDescriptor FetchSize(int? fetchSize) } /// - /// Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit. + /// + /// Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit. + /// /// public EqlSearchRequestDescriptor Fields(ICollection? fields) { @@ -672,7 +736,9 @@ public EqlSearchRequestDescriptor Fields(params Action - /// Query, written in Query DSL, used to filter the events on which the EQL query runs. + /// + /// Query, written in Query DSL, used to filter the events on which the EQL query runs. + /// /// public EqlSearchRequestDescriptor Filter(ICollection? filter) { @@ -723,7 +789,9 @@ public EqlSearchRequestDescriptor KeepOnCompletion(bool? keepOnCompletion = true } /// - /// EQL query you wish to run. + /// + /// EQL query you wish to run. + /// /// public EqlSearchRequestDescriptor Query(string query) { @@ -744,7 +812,9 @@ public EqlSearchRequestDescriptor RuntimeMappings(Func - /// For basic queries, the maximum number of matching events to return. Defaults to 10 + /// + /// For basic queries, the maximum number of matching events to return. Defaults to 10 + /// /// public EqlSearchRequestDescriptor Size(int? size) { @@ -753,7 +823,9 @@ public EqlSearchRequestDescriptor Size(int? size) } /// - /// Field used to sort hits with the same timestamp in ascending order + /// + /// Field used to sort hits with the same timestamp in ascending order + /// /// public EqlSearchRequestDescriptor TiebreakerField(Elastic.Clients.Elasticsearch.Field? tiebreakerField) { @@ -762,7 +834,9 @@ public EqlSearchRequestDescriptor TiebreakerField(Elastic.Clients.Elasticsearch. } /// - /// Field used to sort hits with the same timestamp in ascending order + /// + /// Field used to sort hits with the same timestamp in ascending order + /// /// public EqlSearchRequestDescriptor TiebreakerField(Expression> tiebreakerField) { @@ -771,7 +845,9 @@ public EqlSearchRequestDescriptor TiebreakerField(Expression< } /// - /// Field used to sort hits with the same timestamp in ascending order + /// + /// Field used to sort hits with the same timestamp in ascending order + /// /// public EqlSearchRequestDescriptor TiebreakerField(Expression> tiebreakerField) { @@ -780,7 +856,9 @@ public EqlSearchRequestDescriptor TiebreakerField(Expression - /// Field containing event timestamp. Default "@timestamp" + /// + /// Field containing event timestamp. Default "@timestamp" + /// /// public EqlSearchRequestDescriptor TimestampField(Elastic.Clients.Elasticsearch.Field? timestampField) { @@ -789,7 +867,9 @@ public EqlSearchRequestDescriptor TimestampField(Elastic.Clients.Elasticsearch.F } /// - /// Field containing event timestamp. Default "@timestamp" + /// + /// Field containing event timestamp. Default "@timestamp" + /// /// public EqlSearchRequestDescriptor TimestampField(Expression> timestampField) { @@ -798,7 +878,9 @@ public EqlSearchRequestDescriptor TimestampField(Expression - /// Field containing event timestamp. Default "@timestamp" + /// + /// Field containing event timestamp. Default "@timestamp" + /// /// public EqlSearchRequestDescriptor TimestampField(Expression> timestampField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlSearchResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlSearchResponse.g.cs index 5652957f69b..1f4602dc9b6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlSearchResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlSearchResponse.g.cs @@ -29,37 +29,49 @@ namespace Elastic.Clients.Elasticsearch.Eql; public sealed partial class EqlSearchResponse : ElasticsearchResponse { /// - /// Contains matching events and sequences. Also contains related metadata. + /// + /// Contains matching events and sequences. Also contains related metadata. + /// /// [JsonInclude, JsonPropertyName("hits")] public Elastic.Clients.Elasticsearch.Eql.EqlHits Hits { get; init; } /// - /// Identifier for the search. + /// + /// Identifier for the search. + /// /// [JsonInclude, JsonPropertyName("id")] public string? Id { get; init; } /// - /// If true, the response does not contain complete search results. + /// + /// If true, the response does not contain complete search results. + /// /// [JsonInclude, JsonPropertyName("is_partial")] public bool? IsPartial { get; init; } /// - /// If true, the search request is still executing. + /// + /// If true, the search request is still executing. + /// /// [JsonInclude, JsonPropertyName("is_running")] public bool? IsRunning { get; init; } /// - /// If true, the request timed out before completion. + /// + /// If true, the request timed out before completion. + /// /// [JsonInclude, JsonPropertyName("timed_out")] public bool? TimedOut { get; init; } /// - /// Milliseconds it took Elasticsearch to execute the request. + /// + /// Milliseconds it took Elasticsearch to execute the request. + /// /// [JsonInclude, JsonPropertyName("took")] public long? Took { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/GetEqlStatusRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/GetEqlStatusRequest.g.cs index 7507af95dfe..53f7ba02bbf 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/GetEqlStatusRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/GetEqlStatusRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class GetEqlStatusRequestParameters : RequestParameters } /// -/// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. +/// +/// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. +/// /// public sealed partial class GetEqlStatusRequest : PlainRequest { @@ -52,7 +54,9 @@ public GetEqlStatusRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Re } /// -/// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. +/// +/// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. +/// /// public sealed partial class GetEqlStatusRequestDescriptor : RequestDescriptor, GetEqlStatusRequestParameters> { @@ -82,7 +86,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. +/// +/// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. +/// /// public sealed partial class GetEqlStatusRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/GetEqlStatusResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/GetEqlStatusResponse.g.cs index b5ad7f26f12..a087b94c3a8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/GetEqlStatusResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/GetEqlStatusResponse.g.cs @@ -29,37 +29,49 @@ namespace Elastic.Clients.Elasticsearch.Eql; public sealed partial class GetEqlStatusResponse : ElasticsearchResponse { /// - /// For a completed search shows the http status code of the completed search. + /// + /// For a completed search shows the http status code of the completed search. + /// /// [JsonInclude, JsonPropertyName("completion_status")] public int? CompletionStatus { get; init; } /// - /// Shows a timestamp when the eql search will be expired, in milliseconds since the Unix epoch. When this time is reached, the search and its results are deleted, even if the search is still ongoing. + /// + /// Shows a timestamp when the eql search will be expired, in milliseconds since the Unix epoch. When this time is reached, the search and its results are deleted, even if the search is still ongoing. + /// /// [JsonInclude, JsonPropertyName("expiration_time_in_millis")] public long? ExpirationTimeInMillis { get; init; } /// - /// Identifier for the search. + /// + /// Identifier for the search. + /// /// [JsonInclude, JsonPropertyName("id")] public string Id { get; init; } /// - /// If true, the search request is still executing. If false, the search is completed. + /// + /// If true, the search request is still executing. If false, the search is completed. + /// /// [JsonInclude, JsonPropertyName("is_partial")] public bool IsPartial { get; init; } /// - /// If true, the response does not contain complete search results. This could be because either the search is still running (is_running status is false), or because it is already completed (is_running status is true) and results are partial due to failures or timeouts. + /// + /// If true, the response does not contain complete search results. This could be because either the search is still running (is_running status is false), or because it is already completed (is_running status is true) and results are partial due to failures or timeouts. + /// /// [JsonInclude, JsonPropertyName("is_running")] public bool IsRunning { get; init; } /// - /// For a running search shows a timestamp when the eql search started, in milliseconds since the Unix epoch. + /// + /// For a running search shows a timestamp when the eql search started, in milliseconds since the Unix epoch. + /// /// [JsonInclude, JsonPropertyName("start_time_in_millis")] public long? StartTimeInMillis { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Esql/EsqlQueryRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Esql/EsqlQueryRequest.g.cs index cf66e653ec0..a4500abf0e0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Esql/EsqlQueryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Esql/EsqlQueryRequest.g.cs @@ -32,23 +32,32 @@ namespace Elastic.Clients.Elasticsearch.Esql; public sealed partial class EsqlQueryRequestParameters : RequestParameters { /// - /// The character to use between values within a CSV row. Only valid for the CSV format. + /// + /// The character to use between values within a CSV row. Only valid for the CSV format. + /// /// public string? Delimiter { get => Q("delimiter"); set => Q("delimiter", value); } /// - /// Should columns that are entirely `null` be removed from the `columns` and `values` portion of the results?
Defaults to `false`. If `true` then the response will include an extra section under the name `all_columns` which has the name of all columns. + /// + /// Should columns that are entirely null be removed from the columns and values portion of the results? + /// Defaults to false. If true then the response will include an extra section under the name all_columns which has the name of all columns. + /// /// public bool? DropNullColumns { get => Q("drop_null_columns"); set => Q("drop_null_columns", value); } /// - /// A short version of the Accept header, e.g. json, yaml. + /// + /// A short version of the Accept header, e.g. json, yaml. + /// /// public string? Format { get => Q("format"); set => Q("format", value); } } /// -/// Executes an ES|QL request +/// +/// Executes an ES|QL request +/// /// public sealed partial class EsqlQueryRequest : PlainRequest { @@ -61,31 +70,42 @@ public sealed partial class EsqlQueryRequest : PlainRequest "esql.query"; /// - /// The character to use between values within a CSV row. Only valid for the CSV format. + /// + /// The character to use between values within a CSV row. Only valid for the CSV format. + /// /// [JsonIgnore] public string? Delimiter { get => Q("delimiter"); set => Q("delimiter", value); } /// - /// Should columns that are entirely `null` be removed from the `columns` and `values` portion of the results?
Defaults to `false`. If `true` then the response will include an extra section under the name `all_columns` which has the name of all columns. + /// + /// Should columns that are entirely null be removed from the columns and values portion of the results? + /// Defaults to false. If true then the response will include an extra section under the name all_columns which has the name of all columns. + /// /// [JsonIgnore] public bool? DropNullColumns { get => Q("drop_null_columns"); set => Q("drop_null_columns", value); } /// - /// A short version of the Accept header, e.g. json, yaml. + /// + /// A short version of the Accept header, e.g. json, yaml. + /// /// [JsonIgnore] public string? Format { get => Q("format"); set => Q("format", value); } /// - /// By default, ES|QL returns results as rows. For example, FROM returns each individual document as one row. For the JSON, YAML, CBOR and smile formats, ES|QL can return the results in a columnar fashion where one row represents all the values of a certain column in the results. + /// + /// By default, ES|QL returns results as rows. For example, FROM returns each individual document as one row. For the JSON, YAML, CBOR and smile formats, ES|QL can return the results in a columnar fashion where one row represents all the values of a certain column in the results. + /// /// [JsonInclude, JsonPropertyName("columnar")] public bool? Columnar { get; set; } /// - /// Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on. + /// + /// Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on. + /// /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Filter { get; set; } @@ -93,26 +113,37 @@ public sealed partial class EsqlQueryRequest : PlainRequest - /// To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters. + /// + /// To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters. + /// /// [JsonInclude, JsonPropertyName("params")] public ICollection? Params { get; set; } /// - /// If provided and `true` the response will include an extra `profile` object
with information on how the query was executed. This information is for human debugging
and its format can change at any time but it can give some insight into the performance
of each part of the query. + /// + /// If provided and true the response will include an extra profile object + /// with information on how the query was executed. This information is for human debugging + /// and its format can change at any time but it can give some insight into the performance + /// of each part of the query. + /// /// [JsonInclude, JsonPropertyName("profile")] public bool? Profile { get; set; } /// - /// The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results. + /// + /// The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results. + /// /// [JsonInclude, JsonPropertyName("query")] public string Query { get; set; } } /// -/// Executes an ES|QL request +/// +/// Executes an ES|QL request +/// /// public sealed partial class EsqlQueryRequestDescriptor : RequestDescriptor, EsqlQueryRequestParameters> { @@ -144,7 +175,9 @@ public EsqlQueryRequestDescriptor() private string QueryValue { get; set; } /// - /// By default, ES|QL returns results as rows. For example, FROM returns each individual document as one row. For the JSON, YAML, CBOR and smile formats, ES|QL can return the results in a columnar fashion where one row represents all the values of a certain column in the results. + /// + /// By default, ES|QL returns results as rows. For example, FROM returns each individual document as one row. For the JSON, YAML, CBOR and smile formats, ES|QL can return the results in a columnar fashion where one row represents all the values of a certain column in the results. + /// /// public EsqlQueryRequestDescriptor Columnar(bool? columnar = true) { @@ -153,7 +186,9 @@ public EsqlQueryRequestDescriptor Columnar(bool? columnar = true) } /// - /// Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on. + /// + /// Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on. + /// /// public EsqlQueryRequestDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.Query? filter) { @@ -186,7 +221,9 @@ public EsqlQueryRequestDescriptor Locale(string? locale) } /// - /// To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters. + /// + /// To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters. + /// /// public EsqlQueryRequestDescriptor Params(ICollection? value) { @@ -195,7 +232,12 @@ public EsqlQueryRequestDescriptor Params(ICollection - /// If provided and `true` the response will include an extra `profile` object
with information on how the query was executed. This information is for human debugging
and its format can change at any time but it can give some insight into the performance
of each part of the query. + /// + /// If provided and true the response will include an extra profile object + /// with information on how the query was executed. This information is for human debugging + /// and its format can change at any time but it can give some insight into the performance + /// of each part of the query. + /// /// public EsqlQueryRequestDescriptor Profile(bool? profile = true) { @@ -204,7 +246,9 @@ public EsqlQueryRequestDescriptor Profile(bool? profile = true) } /// - /// The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results. + /// + /// The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results. + /// /// public EsqlQueryRequestDescriptor Query(string query) { @@ -262,7 +306,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Executes an ES|QL request +/// +/// Executes an ES|QL request +/// /// public sealed partial class EsqlQueryRequestDescriptor : RequestDescriptor { @@ -294,7 +340,9 @@ public EsqlQueryRequestDescriptor() private string QueryValue { get; set; } /// - /// By default, ES|QL returns results as rows. For example, FROM returns each individual document as one row. For the JSON, YAML, CBOR and smile formats, ES|QL can return the results in a columnar fashion where one row represents all the values of a certain column in the results. + /// + /// By default, ES|QL returns results as rows. For example, FROM returns each individual document as one row. For the JSON, YAML, CBOR and smile formats, ES|QL can return the results in a columnar fashion where one row represents all the values of a certain column in the results. + /// /// public EsqlQueryRequestDescriptor Columnar(bool? columnar = true) { @@ -303,7 +351,9 @@ public EsqlQueryRequestDescriptor Columnar(bool? columnar = true) } /// - /// Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on. + /// + /// Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on. + /// /// public EsqlQueryRequestDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.Query? filter) { @@ -336,7 +386,9 @@ public EsqlQueryRequestDescriptor Locale(string? locale) } /// - /// To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters. + /// + /// To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters. + /// /// public EsqlQueryRequestDescriptor Params(ICollection? value) { @@ -345,7 +397,12 @@ public EsqlQueryRequestDescriptor Params(ICollection - /// If provided and `true` the response will include an extra `profile` object
with information on how the query was executed. This information is for human debugging
and its format can change at any time but it can give some insight into the performance
of each part of the query. + /// + /// If provided and true the response will include an extra profile object + /// with information on how the query was executed. This information is for human debugging + /// and its format can change at any time but it can give some insight into the performance + /// of each part of the query. + /// /// public EsqlQueryRequestDescriptor Profile(bool? profile = true) { @@ -354,7 +411,9 @@ public EsqlQueryRequestDescriptor Profile(bool? profile = true) } /// - /// The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results. + /// + /// The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results. + /// /// public EsqlQueryRequestDescriptor Query(string query) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ExistsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ExistsRequest.g.cs index 226695caf4e..1b463f0b6fc 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ExistsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ExistsRequest.g.cs @@ -32,58 +32,85 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class ExistsRequestParameters : RequestParameters { /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If `true`, the request is real-time as opposed to near-real-time. + /// + /// If true, the request is real-time as opposed to near-real-time. + /// /// public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } /// - /// If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes. + /// + /// If true, Elasticsearch refreshes all shards involved in the delete by query after the request completes. + /// /// public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// Target the specified primary shard. + /// + /// Target the specified primary shard. + /// /// public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// `true` or `false` to return the `_source` field or not, or a list of fields to return. + /// + /// true or false to return the _source field or not, or a list of fields to return. + /// /// public Elastic.Clients.Elasticsearch.Core.Search.SourceConfigParam? Source { get => Q("_source"); set => Q("_source", value); } /// - /// A comma-separated list of source fields to exclude in the response. + /// + /// A comma-separated list of source fields to exclude in the response. + /// /// public Elastic.Clients.Elasticsearch.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response. + /// + /// A comma-separated list of source fields to include in the response. + /// /// public Elastic.Clients.Elasticsearch.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// List of stored fields to return as part of a hit.
If no fields are specified, no stored fields are included in the response.
If this field is specified, the `_source` parameter defaults to false. + /// + /// List of stored fields to return as part of a hit. + /// If no fields are specified, no stored fields are included in the response. + /// If this field is specified, the _source parameter defaults to false. + /// /// public Elastic.Clients.Elasticsearch.Fields? StoredFields { get => Q("stored_fields"); set => Q("stored_fields", value); } /// - /// Explicit version number for concurrency control.
The specified version must match the current version of the document for the request to succeed. + /// + /// Explicit version number for concurrency control. + /// The specified version must match the current version of the document for the request to succeed. + /// /// public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type: `external`, `external_gte`. + /// + /// Specific version type: external, external_gte. + /// /// public Elastic.Clients.Elasticsearch.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } } /// -/// Check a document.
Checks if a specified document exists. +/// +/// Check a document. +/// Checks if a specified document exists. +/// /// public sealed partial class ExistsRequest : PlainRequest { @@ -100,68 +127,95 @@ public ExistsRequest(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clie internal override string OperationName => "exists"; /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If `true`, the request is real-time as opposed to near-real-time. + /// + /// If true, the request is real-time as opposed to near-real-time. + /// /// [JsonIgnore] public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } /// - /// If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes. + /// + /// If true, Elasticsearch refreshes all shards involved in the delete by query after the request completes. + /// /// [JsonIgnore] public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// Target the specified primary shard. + /// + /// Target the specified primary shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// `true` or `false` to return the `_source` field or not, or a list of fields to return. + /// + /// true or false to return the _source field or not, or a list of fields to return. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Core.Search.SourceConfigParam? Source { get => Q("_source"); set => Q("_source", value); } /// - /// A comma-separated list of source fields to exclude in the response. + /// + /// A comma-separated list of source fields to exclude in the response. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response. + /// + /// A comma-separated list of source fields to include in the response. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// List of stored fields to return as part of a hit.
If no fields are specified, no stored fields are included in the response.
If this field is specified, the `_source` parameter defaults to false. + /// + /// List of stored fields to return as part of a hit. + /// If no fields are specified, no stored fields are included in the response. + /// If this field is specified, the _source parameter defaults to false. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? StoredFields { get => Q("stored_fields"); set => Q("stored_fields", value); } /// - /// Explicit version number for concurrency control.
The specified version must match the current version of the document for the request to succeed. + /// + /// Explicit version number for concurrency control. + /// The specified version must match the current version of the document for the request to succeed. + /// /// [JsonIgnore] public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type: `external`, `external_gte`. + /// + /// Specific version type: external, external_gte. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } } /// -/// Check a document.
Checks if a specified document exists. +/// +/// Check a document. +/// Checks if a specified document exists. +/// /// public sealed partial class ExistsRequestDescriptor : RequestDescriptor, ExistsRequestParameters> { @@ -224,7 +278,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Check a document.
Checks if a specified document exists. +/// +/// Check a document. +/// Checks if a specified document exists. +/// /// public sealed partial class ExistsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ExistsSourceRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ExistsSourceRequest.g.cs index 9242efab0f4..121d99f6887 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ExistsSourceRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ExistsSourceRequest.g.cs @@ -32,53 +32,76 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class ExistsSourceRequestParameters : RequestParameters { /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If true, the request is real-time as opposed to near-real-time. + /// + /// If true, the request is real-time as opposed to near-real-time. + /// /// public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } /// - /// If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes. + /// + /// If true, Elasticsearch refreshes all shards involved in the delete by query after the request completes. + /// /// public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// Target the specified primary shard. + /// + /// Target the specified primary shard. + /// /// public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// `true` or `false` to return the `_source` field or not, or a list of fields to return. + /// + /// true or false to return the _source field or not, or a list of fields to return. + /// /// public Elastic.Clients.Elasticsearch.Core.Search.SourceConfigParam? Source { get => Q("_source"); set => Q("_source", value); } /// - /// A comma-separated list of source fields to exclude in the response. + /// + /// A comma-separated list of source fields to exclude in the response. + /// /// public Elastic.Clients.Elasticsearch.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response. + /// + /// A comma-separated list of source fields to include in the response. + /// /// public Elastic.Clients.Elasticsearch.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// Explicit version number for concurrency control.
The specified version must match the current version of the document for the request to succeed. + /// + /// Explicit version number for concurrency control. + /// The specified version must match the current version of the document for the request to succeed. + /// /// public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type: `external`, `external_gte`. + /// + /// Specific version type: external, external_gte. + /// /// public Elastic.Clients.Elasticsearch.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } } /// -/// Check for a document source.
Checks if a document's `_source` is stored. +/// +/// Check for a document source. +/// Checks if a document's _source is stored. +/// /// public sealed partial class ExistsSourceRequest : PlainRequest { @@ -95,62 +118,85 @@ public ExistsSourceRequest(Elastic.Clients.Elasticsearch.IndexName index, Elasti internal override string OperationName => "exists_source"; /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If true, the request is real-time as opposed to near-real-time. + /// + /// If true, the request is real-time as opposed to near-real-time. + /// /// [JsonIgnore] public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } /// - /// If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes. + /// + /// If true, Elasticsearch refreshes all shards involved in the delete by query after the request completes. + /// /// [JsonIgnore] public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// Target the specified primary shard. + /// + /// Target the specified primary shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// `true` or `false` to return the `_source` field or not, or a list of fields to return. + /// + /// true or false to return the _source field or not, or a list of fields to return. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Core.Search.SourceConfigParam? Source { get => Q("_source"); set => Q("_source", value); } /// - /// A comma-separated list of source fields to exclude in the response. + /// + /// A comma-separated list of source fields to exclude in the response. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response. + /// + /// A comma-separated list of source fields to include in the response. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// Explicit version number for concurrency control.
The specified version must match the current version of the document for the request to succeed. + /// + /// Explicit version number for concurrency control. + /// The specified version must match the current version of the document for the request to succeed. + /// /// [JsonIgnore] public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type: `external`, `external_gte`. + /// + /// Specific version type: external, external_gte. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } } /// -/// Check for a document source.
Checks if a document's `_source` is stored. +/// +/// Check for a document source. +/// Checks if a document's _source is stored. +/// /// public sealed partial class ExistsSourceRequestDescriptor : RequestDescriptor, ExistsSourceRequestParameters> { @@ -212,7 +258,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Check for a document source.
Checks if a document's `_source` is stored. +/// +/// Check for a document source. +/// Checks if a document's _source is stored. +/// /// public sealed partial class ExistsSourceRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ExplainRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ExplainRequest.g.cs index 3713a3d09b5..b58e805dc24 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ExplainRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ExplainRequest.g.cs @@ -32,68 +32,97 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class ExplainRequestParameters : RequestParameters { /// - /// Analyzer to use for the query string.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// Analyzer to use for the query string. + /// This parameter can only be used when the q query string parameter is specified. + /// /// public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// - /// If `true`, wildcard and prefix queries are analyzed. + /// + /// If true, wildcard and prefix queries are analyzed. + /// /// public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } /// - /// The default operator for query string query: `AND` or `OR`. + /// + /// The default operator for query string query: AND or OR. + /// /// public Elastic.Clients.Elasticsearch.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } /// - /// Field to use as default where no field prefix is given in the query string. + /// + /// Field to use as default where no field prefix is given in the query string. + /// /// public string? Df { get => Q("df"); set => Q("df", value); } /// - /// If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// + /// If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// /// public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// Query in the Lucene query string syntax. + /// + /// Query in the Lucene query string syntax. + /// /// public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// True or false to return the `_source` field or not, or a list of fields to return. + /// + /// True or false to return the _source field or not, or a list of fields to return. + /// /// public Elastic.Clients.Elasticsearch.Core.Search.SourceConfigParam? Source { get => Q("_source"); set => Q("_source", value); } /// - /// A comma-separated list of source fields to exclude from the response. + /// + /// A comma-separated list of source fields to exclude from the response. + /// /// public Elastic.Clients.Elasticsearch.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response. + /// + /// A comma-separated list of source fields to include in the response. + /// /// public Elastic.Clients.Elasticsearch.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// A comma-separated list of stored fields to return in the response. + /// + /// A comma-separated list of stored fields to return in the response. + /// /// public Elastic.Clients.Elasticsearch.Fields? StoredFields { get => Q("stored_fields"); set => Q("stored_fields", value); } } /// -/// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. +/// +/// Explain a document match result. +/// Returns information about why a specific document matches, or doesn’t match, a query. +/// /// public sealed partial class ExplainRequest : PlainRequest { @@ -110,86 +139,117 @@ public ExplainRequest(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Cli internal override string OperationName => "explain"; /// - /// Analyzer to use for the query string.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// Analyzer to use for the query string. + /// This parameter can only be used when the q query string parameter is specified. + /// /// [JsonIgnore] public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// - /// If `true`, wildcard and prefix queries are analyzed. + /// + /// If true, wildcard and prefix queries are analyzed. + /// /// [JsonIgnore] public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } /// - /// The default operator for query string query: `AND` or `OR`. + /// + /// The default operator for query string query: AND or OR. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } /// - /// Field to use as default where no field prefix is given in the query string. + /// + /// Field to use as default where no field prefix is given in the query string. + /// /// [JsonIgnore] public string? Df { get => Q("df"); set => Q("df", value); } /// - /// If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// + /// If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// /// [JsonIgnore] public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// Query in the Lucene query string syntax. + /// + /// Query in the Lucene query string syntax. + /// /// [JsonIgnore] public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// True or false to return the `_source` field or not, or a list of fields to return. + /// + /// True or false to return the _source field or not, or a list of fields to return. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Core.Search.SourceConfigParam? Source { get => Q("_source"); set => Q("_source", value); } /// - /// A comma-separated list of source fields to exclude from the response. + /// + /// A comma-separated list of source fields to exclude from the response. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response. + /// + /// A comma-separated list of source fields to include in the response. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// A comma-separated list of stored fields to return in the response. + /// + /// A comma-separated list of stored fields to return in the response. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? StoredFields { get => Q("stored_fields"); set => Q("stored_fields", value); } /// - /// Defines the search definition using the Query DSL. + /// + /// Defines the search definition using the Query DSL. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Query { get; set; } } /// -/// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. +/// +/// Explain a document match result. +/// Returns information about why a specific document matches, or doesn’t match, a query. +/// /// public sealed partial class ExplainRequestDescriptor : RequestDescriptor, ExplainRequestParameters> { @@ -253,7 +313,9 @@ public ExplainRequestDescriptor Index(Elastic.Clients.Elasticsearch.I private Action> QueryDescriptorAction { get; set; } /// - /// Defines the search definition using the Query DSL. + /// + /// Defines the search definition using the Query DSL. + /// /// public ExplainRequestDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -303,7 +365,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. +/// +/// Explain a document match result. +/// Returns information about why a specific document matches, or doesn’t match, a query. +/// /// public sealed partial class ExplainRequestDescriptor : RequestDescriptor { @@ -351,7 +416,9 @@ public ExplainRequestDescriptor Index(Elastic.Clients.Elasticsearch.IndexName in private Action QueryDescriptorAction { get; set; } /// - /// Defines the search definition using the Query DSL. + /// + /// Defines the search definition using the Query DSL. + /// /// public ExplainRequestDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Features/GetFeaturesRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Features/GetFeaturesRequest.g.cs index 9b0025bf7b2..6099b88f1ba 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Features/GetFeaturesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Features/GetFeaturesRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class GetFeaturesRequestParameters : RequestParameters } /// -/// Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot +/// +/// Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot +/// /// public sealed partial class GetFeaturesRequest : PlainRequest { @@ -48,7 +50,9 @@ public sealed partial class GetFeaturesRequest : PlainRequest -/// Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot +/// +/// Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot +/// /// public sealed partial class GetFeaturesRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Features/ResetFeaturesRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Features/ResetFeaturesRequest.g.cs index 6c9746c09ad..a4065f53384 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Features/ResetFeaturesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Features/ResetFeaturesRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class ResetFeaturesRequestParameters : RequestParameters } /// -/// Resets the internal state of features, usually by deleting system indices +/// +/// Resets the internal state of features, usually by deleting system indices +/// /// public sealed partial class ResetFeaturesRequest : PlainRequest { @@ -48,7 +50,9 @@ public sealed partial class ResetFeaturesRequest : PlainRequest -/// Resets the internal state of features, usually by deleting system indices +/// +/// Resets the internal state of features, usually by deleting system indices +/// /// public sealed partial class ResetFeaturesRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/FieldCapsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/FieldCapsRequest.g.cs index a28c466e09c..a8f3fbe206f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/FieldCapsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/FieldCapsRequest.g.cs @@ -32,43 +32,63 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class FieldCapsRequestParameters : RequestParameters { /// - /// If false, the request returns an error if any wildcard expression, index alias,
or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request
targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with bar. + /// + /// If false, the request returns an error if any wildcard expression, index alias, + /// or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request + /// targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. + /// + /// Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// An optional set of filters: can include +metadata,-metadata,-nested,-multifield,-parent + /// + /// An optional set of filters: can include +metadata,-metadata,-nested,-multifield,-parent + /// /// public string? Filters { get => Q("filters"); set => Q("filters", value); } /// - /// If `true`, missing or closed indices are not included in the response. + /// + /// If true, missing or closed indices are not included in the response. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If false, empty fields are not included in the response. + /// + /// If false, empty fields are not included in the response. + /// /// public bool? IncludeEmptyFields { get => Q("include_empty_fields"); set => Q("include_empty_fields", value); } /// - /// If true, unmapped fields are included in the response. + /// + /// If true, unmapped fields are included in the response. + /// /// public bool? IncludeUnmapped { get => Q("include_unmapped"); set => Q("include_unmapped", value); } /// - /// Only return results for fields that have one of the types in the list + /// + /// Only return results for fields that have one of the types in the list + /// /// public ICollection? Types { get => Q?>("types"); set => Q("types", value); } } /// -/// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. +/// +/// The field capabilities API returns the information about the capabilities of fields among multiple indices. +/// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type +/// of keyword is returned as any other field that belongs to the keyword family. +/// /// public sealed partial class FieldCapsRequest : PlainRequest { @@ -89,69 +109,96 @@ public FieldCapsRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r internal override string OperationName => "field_caps"; /// - /// If false, the request returns an error if any wildcard expression, index alias,
or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request
targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with bar. + /// + /// If false, the request returns an error if any wildcard expression, index alias, + /// or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request + /// targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. + /// + /// Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// An optional set of filters: can include +metadata,-metadata,-nested,-multifield,-parent + /// + /// An optional set of filters: can include +metadata,-metadata,-nested,-multifield,-parent + /// /// [JsonIgnore] public string? Filters { get => Q("filters"); set => Q("filters", value); } /// - /// If `true`, missing or closed indices are not included in the response. + /// + /// If true, missing or closed indices are not included in the response. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If false, empty fields are not included in the response. + /// + /// If false, empty fields are not included in the response. + /// /// [JsonIgnore] public bool? IncludeEmptyFields { get => Q("include_empty_fields"); set => Q("include_empty_fields", value); } /// - /// If true, unmapped fields are included in the response. + /// + /// If true, unmapped fields are included in the response. + /// /// [JsonIgnore] public bool? IncludeUnmapped { get => Q("include_unmapped"); set => Q("include_unmapped", value); } /// - /// Only return results for fields that have one of the types in the list + /// + /// Only return results for fields that have one of the types in the list + /// /// [JsonIgnore] public ICollection? Types { get => Q?>("types"); set => Q("types", value); } /// - /// List of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported. + /// + /// List of fields to retrieve capabilities for. Wildcard (*) expressions are supported. + /// /// [JsonInclude, JsonPropertyName("fields")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] public Elastic.Clients.Elasticsearch.Fields? Fields { get; set; } /// - /// Allows to filter indices if the provided query rewrites to match_none on every shard. + /// + /// Allows to filter indices if the provided query rewrites to match_none on every shard. + /// /// [JsonInclude, JsonPropertyName("index_filter")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? IndexFilter { get; set; } /// - /// Defines ad-hoc runtime fields in the request similar to the way it is done in search requests.
These fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings. + /// + /// Defines ad-hoc runtime fields in the request similar to the way it is done in search requests. + /// These fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings. + /// /// [JsonInclude, JsonPropertyName("runtime_mappings")] public IDictionary? RuntimeMappings { get; set; } } /// -/// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. +/// +/// The field capabilities API returns the information about the capabilities of fields among multiple indices. +/// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type +/// of keyword is returned as any other field that belongs to the keyword family. +/// /// public sealed partial class FieldCapsRequestDescriptor : RequestDescriptor, FieldCapsRequestParameters> { @@ -194,7 +241,9 @@ public FieldCapsRequestDescriptor Indices(Elastic.Clients.Elasticsear private IDictionary> RuntimeMappingsValue { get; set; } /// - /// List of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported. + /// + /// List of fields to retrieve capabilities for. Wildcard (*) expressions are supported. + /// /// public FieldCapsRequestDescriptor Fields(Elastic.Clients.Elasticsearch.Fields? fields) { @@ -203,7 +252,9 @@ public FieldCapsRequestDescriptor Fields(Elastic.Clients.Elasticsearc } /// - /// Allows to filter indices if the provided query rewrites to match_none on every shard. + /// + /// Allows to filter indices if the provided query rewrites to match_none on every shard. + /// /// public FieldCapsRequestDescriptor IndexFilter(Elastic.Clients.Elasticsearch.QueryDsl.Query? indexFilter) { @@ -230,7 +281,10 @@ public FieldCapsRequestDescriptor IndexFilter(Action - /// Defines ad-hoc runtime fields in the request similar to the way it is done in search requests.
These fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings. + /// + /// Defines ad-hoc runtime fields in the request similar to the way it is done in search requests. + /// These fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings. + /// /// public FieldCapsRequestDescriptor RuntimeMappings(Func>, FluentDescriptorDictionary>> selector) { @@ -274,7 +328,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. +/// +/// The field capabilities API returns the information about the capabilities of fields among multiple indices. +/// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type +/// of keyword is returned as any other field that belongs to the keyword family. +/// /// public sealed partial class FieldCapsRequestDescriptor : RequestDescriptor { @@ -317,7 +375,9 @@ public FieldCapsRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? private IDictionary RuntimeMappingsValue { get; set; } /// - /// List of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported. + /// + /// List of fields to retrieve capabilities for. Wildcard (*) expressions are supported. + /// /// public FieldCapsRequestDescriptor Fields(Elastic.Clients.Elasticsearch.Fields? fields) { @@ -326,7 +386,9 @@ public FieldCapsRequestDescriptor Fields(Elastic.Clients.Elasticsearch.Fields? f } /// - /// Allows to filter indices if the provided query rewrites to match_none on every shard. + /// + /// Allows to filter indices if the provided query rewrites to match_none on every shard. + /// /// public FieldCapsRequestDescriptor IndexFilter(Elastic.Clients.Elasticsearch.QueryDsl.Query? indexFilter) { @@ -353,7 +415,10 @@ public FieldCapsRequestDescriptor IndexFilter(Action - /// Defines ad-hoc runtime fields in the request similar to the way it is done in search requests.
These fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings. + /// + /// Defines ad-hoc runtime fields in the request similar to the way it is done in search requests. + /// These fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings. + /// /// public FieldCapsRequestDescriptor RuntimeMappings(Func, FluentDescriptorDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/GetRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/GetRequest.g.cs index 8082ab4c737..7e18fa17a3a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/GetRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/GetRequest.g.cs @@ -32,63 +32,92 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class GetRequestParameters : RequestParameters { /// - /// Should this request force synthetic _source?
Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance.
Fetches with this enabled will be slower the enabling synthetic source natively in the index. + /// + /// Should this request force synthetic _source? + /// Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. + /// Fetches with this enabled will be slower the enabling synthetic source natively in the index. + /// /// public bool? ForceSyntheticSource { get => Q("force_synthetic_source"); set => Q("force_synthetic_source", value); } /// - /// Specifies the node or shard the operation should be performed on. Random by default. + /// + /// Specifies the node or shard the operation should be performed on. Random by default. + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If `true`, the request is real-time as opposed to near-real-time. + /// + /// If true, the request is real-time as opposed to near-real-time. + /// /// public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } /// - /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. + /// + /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. + /// /// public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// Target the specified primary shard. + /// + /// Target the specified primary shard. + /// /// public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// True or false to return the _source field or not, or a list of fields to return. + /// + /// True or false to return the _source field or not, or a list of fields to return. + /// /// public Elastic.Clients.Elasticsearch.Core.Search.SourceConfigParam? Source { get => Q("_source"); set => Q("_source", value); } /// - /// A comma-separated list of source fields to exclude in the response. + /// + /// A comma-separated list of source fields to exclude in the response. + /// /// public Elastic.Clients.Elasticsearch.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response. + /// + /// A comma-separated list of source fields to include in the response. + /// /// public Elastic.Clients.Elasticsearch.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// List of stored fields to return as part of a hit.
If no fields are specified, no stored fields are included in the response.
If this field is specified, the `_source` parameter defaults to false. + /// + /// List of stored fields to return as part of a hit. + /// If no fields are specified, no stored fields are included in the response. + /// If this field is specified, the _source parameter defaults to false. + /// /// public Elastic.Clients.Elasticsearch.Fields? StoredFields { get => Q("stored_fields"); set => Q("stored_fields", value); } /// - /// Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. + /// + /// Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. + /// /// public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type: internal, external, external_gte. + /// + /// Specific version type: internal, external, external_gte. + /// /// public Elastic.Clients.Elasticsearch.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } } /// -/// Get a document by its ID.
Retrieves the document with the specified ID from an index. +/// +/// Get a document by its ID. +/// Retrieves the document with the specified ID from an index. +/// /// public sealed partial class GetRequest : PlainRequest { @@ -105,74 +134,103 @@ public GetRequest(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients internal override string OperationName => "get"; /// - /// Should this request force synthetic _source?
Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance.
Fetches with this enabled will be slower the enabling synthetic source natively in the index. + /// + /// Should this request force synthetic _source? + /// Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. + /// Fetches with this enabled will be slower the enabling synthetic source natively in the index. + /// /// [JsonIgnore] public bool? ForceSyntheticSource { get => Q("force_synthetic_source"); set => Q("force_synthetic_source", value); } /// - /// Specifies the node or shard the operation should be performed on. Random by default. + /// + /// Specifies the node or shard the operation should be performed on. Random by default. + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If `true`, the request is real-time as opposed to near-real-time. + /// + /// If true, the request is real-time as opposed to near-real-time. + /// /// [JsonIgnore] public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } /// - /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. + /// + /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. + /// /// [JsonIgnore] public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// Target the specified primary shard. + /// + /// Target the specified primary shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// True or false to return the _source field or not, or a list of fields to return. + /// + /// True or false to return the _source field or not, or a list of fields to return. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Core.Search.SourceConfigParam? Source { get => Q("_source"); set => Q("_source", value); } /// - /// A comma-separated list of source fields to exclude in the response. + /// + /// A comma-separated list of source fields to exclude in the response. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response. + /// + /// A comma-separated list of source fields to include in the response. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// List of stored fields to return as part of a hit.
If no fields are specified, no stored fields are included in the response.
If this field is specified, the `_source` parameter defaults to false. + /// + /// List of stored fields to return as part of a hit. + /// If no fields are specified, no stored fields are included in the response. + /// If this field is specified, the _source parameter defaults to false. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? StoredFields { get => Q("stored_fields"); set => Q("stored_fields", value); } /// - /// Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. + /// + /// Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. + /// /// [JsonIgnore] public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type: internal, external, external_gte. + /// + /// Specific version type: internal, external, external_gte. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } } /// -/// Get a document by its ID.
Retrieves the document with the specified ID from an index. +/// +/// Get a document by its ID. +/// Retrieves the document with the specified ID from an index. +/// /// public sealed partial class GetRequestDescriptor : RequestDescriptor, GetRequestParameters> { @@ -236,7 +294,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Get a document by its ID.
Retrieves the document with the specified ID from an index. +/// +/// Get a document by its ID. +/// Retrieves the document with the specified ID from an index. +/// /// public sealed partial class GetRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/GetScriptContextRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/GetScriptContextRequest.g.cs index 4cce6d2c3b5..1856a615dc8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/GetScriptContextRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/GetScriptContextRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class GetScriptContextRequestParameters : RequestParameter } /// -/// Returns all script contexts. +/// +/// Returns all script contexts. +/// /// public sealed partial class GetScriptContextRequest : PlainRequest { @@ -48,7 +50,9 @@ public sealed partial class GetScriptContextRequest : PlainRequest -/// Returns all script contexts. +/// +/// Returns all script contexts. +/// /// public sealed partial class GetScriptContextRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/GetScriptLanguagesRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/GetScriptLanguagesRequest.g.cs index e235880c01c..6be238b44b9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/GetScriptLanguagesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/GetScriptLanguagesRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class GetScriptLanguagesRequestParameters : RequestParamet } /// -/// Returns available script types, languages and contexts +/// +/// Returns available script types, languages and contexts +/// /// public sealed partial class GetScriptLanguagesRequest : PlainRequest { @@ -48,7 +50,9 @@ public sealed partial class GetScriptLanguagesRequest : PlainRequest -/// Returns available script types, languages and contexts +/// +/// Returns available script types, languages and contexts +/// /// public sealed partial class GetScriptLanguagesRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/GetScriptRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/GetScriptRequest.g.cs index 02e4423d4a1..379c4af08b3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/GetScriptRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/GetScriptRequest.g.cs @@ -32,13 +32,18 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class GetScriptRequestParameters : RequestParameters { /// - /// Specify timeout for connection to master + /// + /// Specify timeout for connection to master + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// 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. +/// /// public sealed partial class GetScriptRequest : PlainRequest { @@ -55,14 +60,19 @@ public GetScriptRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Requi internal override string OperationName => "get_script"; /// - /// Specify timeout for connection to master + /// + /// Specify timeout for connection to master + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// 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. +/// /// public sealed partial class GetScriptRequestDescriptor : RequestDescriptor, GetScriptRequestParameters> { @@ -94,7 +104,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// 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. +/// /// public sealed partial class GetScriptRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/GetSourceRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/GetSourceRequest.g.cs index 79ddbe31780..e1dd8a84b26 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/GetSourceRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/GetSourceRequest.g.cs @@ -32,54 +32,75 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class GetSourceRequestParameters : RequestParameters { /// - /// Specifies the node or shard the operation should be performed on. Random by default. + /// + /// Specifies the node or shard the operation should be performed on. Random by default. + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// Boolean) If true, the request is real-time as opposed to near-real-time. + /// + /// Boolean) If true, the request is real-time as opposed to near-real-time. + /// /// public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } /// - /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. + /// + /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. + /// /// public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// Target the specified primary shard. + /// + /// Target the specified primary shard. + /// /// public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// True or false to return the _source field or not, or a list of fields to return. + /// + /// True or false to return the _source field or not, or a list of fields to return. + /// /// public Elastic.Clients.Elasticsearch.Core.Search.SourceConfigParam? Source { get => Q("_source"); set => Q("_source", value); } /// - /// A comma-separated list of source fields to exclude in the response. + /// + /// A comma-separated list of source fields to exclude in the response. + /// /// public Elastic.Clients.Elasticsearch.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response. + /// + /// A comma-separated list of source fields to include in the response. + /// /// public Elastic.Clients.Elasticsearch.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } public Elastic.Clients.Elasticsearch.Fields? StoredFields { get => Q("stored_fields"); set => Q("stored_fields", value); } /// - /// Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. + /// + /// Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. + /// /// public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type: internal, external, external_gte. + /// + /// Specific version type: internal, external, external_gte. + /// /// public Elastic.Clients.Elasticsearch.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } } /// -/// Get a document's source.
Returns the source of a document. +/// +/// Get a document's source. +/// Returns the source of a document. +/// /// public sealed partial class GetSourceRequest : PlainRequest { @@ -96,43 +117,57 @@ public GetSourceRequest(Elastic.Clients.Elasticsearch.IndexName index, Elastic.C internal override string OperationName => "get_source"; /// - /// Specifies the node or shard the operation should be performed on. Random by default. + /// + /// Specifies the node or shard the operation should be performed on. Random by default. + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// Boolean) If true, the request is real-time as opposed to near-real-time. + /// + /// Boolean) If true, the request is real-time as opposed to near-real-time. + /// /// [JsonIgnore] public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } /// - /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. + /// + /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. + /// /// [JsonIgnore] public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// Target the specified primary shard. + /// + /// Target the specified primary shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// True or false to return the _source field or not, or a list of fields to return. + /// + /// True or false to return the _source field or not, or a list of fields to return. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Core.Search.SourceConfigParam? Source { get => Q("_source"); set => Q("_source", value); } /// - /// A comma-separated list of source fields to exclude in the response. + /// + /// A comma-separated list of source fields to exclude in the response. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response. + /// + /// A comma-separated list of source fields to include in the response. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } @@ -140,20 +175,27 @@ public GetSourceRequest(Elastic.Clients.Elasticsearch.IndexName index, Elastic.C public Elastic.Clients.Elasticsearch.Fields? StoredFields { get => Q("stored_fields"); set => Q("stored_fields", value); } /// - /// Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. + /// + /// Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. + /// /// [JsonIgnore] public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type: internal, external, external_gte. + /// + /// Specific version type: internal, external, external_gte. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } } /// -/// Get a document's source.
Returns the source of a document. +/// +/// Get a document's source. +/// Returns the source of a document. +/// /// public sealed partial class GetSourceRequestDescriptor : RequestDescriptor, GetSourceRequestParameters> { @@ -216,7 +258,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Get a document's source.
Returns the source of a document. +/// +/// Get a document's source. +/// Returns the source of a document. +/// /// public sealed partial class GetSourceRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Graph/ExploreRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Graph/ExploreRequest.g.cs index 7785d56386c..64337724631 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Graph/ExploreRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Graph/ExploreRequest.g.cs @@ -32,18 +32,26 @@ namespace Elastic.Clients.Elasticsearch.Graph; public sealed partial class ExploreRequestParameters : RequestParameters { /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Specifies the period of time to wait for a response from each shard.
If no response is received before the timeout expires, the request fails and returns an error.
Defaults to no timeout. + /// + /// Specifies the period of time to wait for a response from each shard. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// Defaults to no timeout. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. +/// +/// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. +/// /// public sealed partial class ExploreRequest : PlainRequest { @@ -60,44 +68,60 @@ public ExploreRequest(Elastic.Clients.Elasticsearch.Indices indices) : base(r => internal override string OperationName => "graph.explore"; /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Specifies the period of time to wait for a response from each shard.
If no response is received before the timeout expires, the request fails and returns an error.
Defaults to no timeout. + /// + /// Specifies the period of time to wait for a response from each shard. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// Defaults to no timeout. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Specifies or more fields from which you want to extract terms that are associated with the specified vertices. + /// + /// Specifies or more fields from which you want to extract terms that are associated with the specified vertices. + /// /// [JsonInclude, JsonPropertyName("connections")] public Elastic.Clients.Elasticsearch.Graph.Hop? Connections { get; set; } /// - /// Direct the Graph API how to build the graph. + /// + /// Direct the Graph API how to build the graph. + /// /// [JsonInclude, JsonPropertyName("controls")] public Elastic.Clients.Elasticsearch.Graph.ExploreControls? Controls { get; set; } /// - /// A seed query that identifies the documents of interest. Can be any valid Elasticsearch query. + /// + /// A seed query that identifies the documents of interest. Can be any valid Elasticsearch query. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Query { get; set; } /// - /// Specifies one or more fields that contain the terms you want to include in the graph as vertices. + /// + /// Specifies one or more fields that contain the terms you want to include in the graph as vertices. + /// /// [JsonInclude, JsonPropertyName("vertices")] public ICollection? Vertices { get; set; } } /// -/// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. +/// +/// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. +/// /// public sealed partial class ExploreRequestDescriptor : RequestDescriptor, ExploreRequestParameters> { @@ -143,7 +167,9 @@ public ExploreRequestDescriptor Indices(Elastic.Clients.Elasticsearch private Action>[] VerticesDescriptorActions { get; set; } /// - /// Specifies or more fields from which you want to extract terms that are associated with the specified vertices. + /// + /// Specifies or more fields from which you want to extract terms that are associated with the specified vertices. + /// /// public ExploreRequestDescriptor Connections(Elastic.Clients.Elasticsearch.Graph.Hop? connections) { @@ -170,7 +196,9 @@ public ExploreRequestDescriptor Connections(Action - /// Direct the Graph API how to build the graph. + /// + /// Direct the Graph API how to build the graph. + /// /// public ExploreRequestDescriptor Controls(Elastic.Clients.Elasticsearch.Graph.ExploreControls? controls) { @@ -197,7 +225,9 @@ public ExploreRequestDescriptor Controls(Action - /// A seed query that identifies the documents of interest. Can be any valid Elasticsearch query. + /// + /// A seed query that identifies the documents of interest. Can be any valid Elasticsearch query. + /// /// public ExploreRequestDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -224,7 +254,9 @@ public ExploreRequestDescriptor Query(Action - /// Specifies one or more fields that contain the terms you want to include in the graph as vertices. + /// + /// Specifies one or more fields that contain the terms you want to include in the graph as vertices. + /// /// public ExploreRequestDescriptor Vertices(ICollection? vertices) { @@ -349,7 +381,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. +/// +/// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. +/// /// public sealed partial class ExploreRequestDescriptor : RequestDescriptor { @@ -391,7 +425,9 @@ public ExploreRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indices in private Action[] VerticesDescriptorActions { get; set; } /// - /// Specifies or more fields from which you want to extract terms that are associated with the specified vertices. + /// + /// Specifies or more fields from which you want to extract terms that are associated with the specified vertices. + /// /// public ExploreRequestDescriptor Connections(Elastic.Clients.Elasticsearch.Graph.Hop? connections) { @@ -418,7 +454,9 @@ public ExploreRequestDescriptor Connections(Action - /// Direct the Graph API how to build the graph. + /// + /// Direct the Graph API how to build the graph. + /// /// public ExploreRequestDescriptor Controls(Elastic.Clients.Elasticsearch.Graph.ExploreControls? controls) { @@ -445,7 +483,9 @@ public ExploreRequestDescriptor Controls(Action - /// A seed query that identifies the documents of interest. Can be any valid Elasticsearch query. + /// + /// A seed query that identifies the documents of interest. Can be any valid Elasticsearch query. + /// /// public ExploreRequestDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -472,7 +512,9 @@ public ExploreRequestDescriptor Query(Action - /// Specifies one or more fields that contain the terms you want to include in the graph as vertices. + /// + /// Specifies one or more fields that contain the terms you want to include in the graph as vertices. + /// /// public ExploreRequestDescriptor Vertices(ICollection? vertices) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/HealthReportRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/HealthReportRequest.g.cs index 68d75383ca0..c8dce150535 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/HealthReportRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/HealthReportRequest.g.cs @@ -32,23 +32,31 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class HealthReportRequestParameters : RequestParameters { /// - /// Limit the number of affected resources the health report API returns. + /// + /// Limit the number of affected resources the health report API returns. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } /// - /// Explicit operation timeout. + /// + /// Explicit operation timeout. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Opt-in for more information about the health of the system. + /// + /// Opt-in for more information about the health of the system. + /// /// public bool? Verbose { get => Q("verbose"); set => Q("verbose", value); } } /// -/// Returns the health of the cluster. +/// +/// Returns the health of the cluster. +/// /// public sealed partial class HealthReportRequest : PlainRequest { @@ -69,26 +77,34 @@ public HealthReportRequest(IReadOnlyCollection? feature) : base(r => r.O internal override string OperationName => "health_report"; /// - /// Limit the number of affected resources the health report API returns. + /// + /// Limit the number of affected resources the health report API returns. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } /// - /// Explicit operation timeout. + /// + /// Explicit operation timeout. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Opt-in for more information about the health of the system. + /// + /// Opt-in for more information about the health of the system. + /// /// [JsonIgnore] public bool? Verbose { get => Q("verbose"); set => Q("verbose", value); } } /// -/// Returns the health of the cluster. +/// +/// Returns the health of the cluster. +/// /// public sealed partial class HealthReportRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/DeleteLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/DeleteLifecycleRequest.g.cs index 80e79377a15..99b30b36b03 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/DeleteLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/DeleteLifecycleRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.IndexLifecycleManagement; public sealed partial class DeleteLifecycleRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. +/// +/// Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. +/// /// public sealed partial class DeleteLifecycleRequest : PlainRequest { @@ -60,20 +66,26 @@ public DeleteLifecycleRequest(Elastic.Clients.Elasticsearch.Name name) : base(r internal override string OperationName => "ilm.delete_lifecycle"; /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. +/// +/// Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. +/// /// public sealed partial class DeleteLifecycleRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/DeleteLifecycleResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/DeleteLifecycleResponse.g.cs index ea34c3c59d1..07ce56d24ab 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/DeleteLifecycleResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/DeleteLifecycleResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.IndexLifecycleManagement; public sealed partial class DeleteLifecycleResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/GetIlmStatusRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/GetIlmStatusRequest.g.cs index 6c21dc260f5..9afa8d59465 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/GetIlmStatusRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/GetIlmStatusRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class GetIlmStatusRequestParameters : RequestParameters } /// -/// Retrieves the current index lifecycle management (ILM) status. +/// +/// Retrieves the current index lifecycle management (ILM) status. +/// /// public sealed partial class GetIlmStatusRequest : PlainRequest { @@ -48,7 +50,9 @@ public sealed partial class GetIlmStatusRequest : PlainRequest -/// Retrieves the current index lifecycle management (ILM) status. +/// +/// Retrieves the current index lifecycle management (ILM) status. +/// /// public sealed partial class GetIlmStatusRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/GetLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/GetLifecycleRequest.g.cs index 038ba1bcf4e..ef72ef3facc 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/GetLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/GetLifecycleRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.IndexLifecycleManagement; public sealed partial class GetLifecycleRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Retrieves a lifecycle policy. +/// +/// Retrieves a lifecycle policy. +/// /// public sealed partial class GetLifecycleRequest : PlainRequest { @@ -64,20 +70,26 @@ public GetLifecycleRequest(Elastic.Clients.Elasticsearch.Name? name) : base(r => internal override string OperationName => "ilm.get_lifecycle"; /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Retrieves a lifecycle policy. +/// +/// Retrieves a lifecycle policy. +/// /// public sealed partial class GetLifecycleRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/MigrateToDataTiersRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/MigrateToDataTiersRequest.g.cs index cbe969537a0..900ac672b69 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/MigrateToDataTiersRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/MigrateToDataTiersRequest.g.cs @@ -32,13 +32,20 @@ namespace Elastic.Clients.Elasticsearch.IndexLifecycleManagement; public sealed partial class MigrateToDataTiersRequestParameters : RequestParameters { /// - /// If true, simulates the migration from node attributes based allocation filters to data tiers, but does not perform the migration.
This provides a way to retrieve the indices and ILM policies that need to be migrated. + /// + /// If true, simulates the migration from node attributes based allocation filters to data tiers, but does not perform the migration. + /// This provides a way to retrieve the indices and ILM policies that need to be migrated. + /// /// public bool? DryRun { get => Q("dry_run"); set => Q("dry_run", value); } } /// -/// Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and
attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+
Using node roles enables ILM to automatically move the indices between data tiers. +/// +/// Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and +/// attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+ +/// Using node roles enables ILM to automatically move the indices between data tiers. +/// /// public sealed partial class MigrateToDataTiersRequest : PlainRequest { @@ -51,7 +58,10 @@ public sealed partial class MigrateToDataTiersRequest : PlainRequest "ilm.migrate_to_data_tiers"; /// - /// If true, simulates the migration from node attributes based allocation filters to data tiers, but does not perform the migration.
This provides a way to retrieve the indices and ILM policies that need to be migrated. + /// + /// If true, simulates the migration from node attributes based allocation filters to data tiers, but does not perform the migration. + /// This provides a way to retrieve the indices and ILM policies that need to be migrated. + /// /// [JsonIgnore] public bool? DryRun { get => Q("dry_run"); set => Q("dry_run", value); } @@ -62,7 +72,11 @@ public sealed partial class MigrateToDataTiersRequest : PlainRequest -/// Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and
attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+
Using node roles enables ILM to automatically move the indices between data tiers. +/// +/// Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and +/// attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+ +/// Using node roles enables ILM to automatically move the indices between data tiers. +/// /// public sealed partial class MigrateToDataTiersRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/MoveToStepRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/MoveToStepRequest.g.cs index a2445fa0ec6..dc57d3e8346 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/MoveToStepRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/MoveToStepRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class MoveToStepRequestParameters : RequestParameters } /// -/// Manually moves an index into the specified step and executes that step. +/// +/// Manually moves an index into the specified step and executes that step. +/// /// public sealed partial class MoveToStepRequest : PlainRequest { @@ -57,7 +59,9 @@ public MoveToStepRequest(Elastic.Clients.Elasticsearch.IndexName index) : base(r } /// -/// Manually moves an index into the specified step and executes that step. +/// +/// Manually moves an index into the specified step and executes that step. +/// /// public sealed partial class MoveToStepRequestDescriptor : RequestDescriptor, MoveToStepRequestParameters> { @@ -180,7 +184,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Manually moves an index into the specified step and executes that step. +/// +/// Manually moves an index into the specified step and executes that step. +/// /// public sealed partial class MoveToStepRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/MoveToStepResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/MoveToStepResponse.g.cs index cdb38fab612..081d908885b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/MoveToStepResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/MoveToStepResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.IndexLifecycleManagement; public sealed partial class MoveToStepResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/PutLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/PutLifecycleRequest.g.cs index 1d2c9140da5..ebcb14933ca 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/PutLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/PutLifecycleRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.IndexLifecycleManagement; public sealed partial class PutLifecycleRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. +/// +/// Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. +/// /// public sealed partial class PutLifecycleRequest : PlainRequest { @@ -60,13 +66,17 @@ public PutLifecycleRequest(Elastic.Clients.Elasticsearch.Name name) : base(r => internal override string OperationName => "ilm.put_lifecycle"; /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } @@ -75,7 +85,9 @@ public PutLifecycleRequest(Elastic.Clients.Elasticsearch.Name name) : base(r => } /// -/// Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. +/// +/// Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. +/// /// public sealed partial class PutLifecycleRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/PutLifecycleResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/PutLifecycleResponse.g.cs index 4a27668e714..d9f92f43a06 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/PutLifecycleResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/PutLifecycleResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.IndexLifecycleManagement; public sealed partial class PutLifecycleResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/RemovePolicyRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/RemovePolicyRequest.g.cs index ee6949c36fb..ebc564bf799 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/RemovePolicyRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/RemovePolicyRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class RemovePolicyRequestParameters : RequestParameters } /// -/// Removes the assigned lifecycle policy and stops managing the specified index +/// +/// Removes the assigned lifecycle policy and stops managing the specified index +/// /// public sealed partial class RemovePolicyRequest : PlainRequest { @@ -52,7 +54,9 @@ public RemovePolicyRequest(Elastic.Clients.Elasticsearch.IndexName index) : base } /// -/// Removes the assigned lifecycle policy and stops managing the specified index +/// +/// Removes the assigned lifecycle policy and stops managing the specified index +/// /// public sealed partial class RemovePolicyRequestDescriptor : RequestDescriptor, RemovePolicyRequestParameters> { @@ -86,7 +90,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Removes the assigned lifecycle policy and stops managing the specified index +/// +/// Removes the assigned lifecycle policy and stops managing the specified index +/// /// public sealed partial class RemovePolicyRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/RetryRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/RetryRequest.g.cs index 97adb377e80..3d4d583350c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/RetryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/RetryRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class RetryRequestParameters : RequestParameters } /// -/// Retries executing the policy for an index that is in the ERROR step. +/// +/// Retries executing the policy for an index that is in the ERROR step. +/// /// public sealed partial class RetryRequest : PlainRequest { @@ -52,7 +54,9 @@ public RetryRequest(Elastic.Clients.Elasticsearch.IndexName index) : base(r => r } /// -/// Retries executing the policy for an index that is in the ERROR step. +/// +/// Retries executing the policy for an index that is in the ERROR step. +/// /// public sealed partial class RetryRequestDescriptor : RequestDescriptor, RetryRequestParameters> { @@ -86,7 +90,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Retries executing the policy for an index that is in the ERROR step. +/// +/// Retries executing the policy for an index that is in the ERROR step. +/// /// public sealed partial class RetryRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/RetryResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/RetryResponse.g.cs index f5f3c13bd8a..73e6389fe10 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/RetryResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/RetryResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.IndexLifecycleManagement; public sealed partial class RetryResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/StartIlmRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/StartIlmRequest.g.cs index 3d26af8e7a2..3214015dc90 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/StartIlmRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/StartIlmRequest.g.cs @@ -36,7 +36,9 @@ public sealed partial class StartIlmRequestParameters : RequestParameters } /// -/// Start the index lifecycle management (ILM) plugin. +/// +/// Start the index lifecycle management (ILM) plugin. +/// /// public sealed partial class StartIlmRequest : PlainRequest { @@ -55,7 +57,9 @@ public sealed partial class StartIlmRequest : PlainRequest -/// Start the index lifecycle management (ILM) plugin. +/// +/// Start the index lifecycle management (ILM) plugin. +/// /// public sealed partial class StartIlmRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/StartIlmResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/StartIlmResponse.g.cs index d9d622befdf..039eca5b3fc 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/StartIlmResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/StartIlmResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.IndexLifecycleManagement; public sealed partial class StartIlmResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/StopIlmRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/StopIlmRequest.g.cs index ca72caa91ae..3ad197fb19e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/StopIlmRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/StopIlmRequest.g.cs @@ -36,7 +36,9 @@ public sealed partial class StopIlmRequestParameters : RequestParameters } /// -/// Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin +/// +/// Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin +/// /// public sealed partial class StopIlmRequest : PlainRequest { @@ -55,7 +57,9 @@ public sealed partial class StopIlmRequest : PlainRequest -/// Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin +/// +/// Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin +/// /// public sealed partial class StopIlmRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/StopIlmResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/StopIlmResponse.g.cs index 7ce7d199f01..d41403aec0b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/StopIlmResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/StopIlmResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.IndexLifecycleManagement; public sealed partial class StopIlmResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/AnalyzeIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/AnalyzeIndexRequest.g.cs index 013c2c7682c..2ce7315964f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/AnalyzeIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/AnalyzeIndexRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class AnalyzeIndexRequestParameters : RequestParameters } /// -/// Performs analysis on a text string and returns the resulting tokens. +/// +/// Performs analysis on a text string and returns the resulting tokens. +/// /// public sealed partial class AnalyzeIndexRequest : PlainRequest { @@ -55,63 +57,87 @@ public AnalyzeIndexRequest(Elastic.Clients.Elasticsearch.IndexName? index) : bas internal override string OperationName => "indices.analyze"; /// - /// The name of the analyzer that should be applied to the provided `text`.
This could be a built-in analyzer, or an analyzer that’s been configured in the index. + /// + /// The name of the analyzer that should be applied to the provided text. + /// This could be a built-in analyzer, or an analyzer that’s been configured in the index. + /// /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } /// - /// Array of token attributes used to filter the output of the `explain` parameter. + /// + /// Array of token attributes used to filter the output of the explain parameter. + /// /// [JsonInclude, JsonPropertyName("attributes")] public ICollection? Attributes { get; set; } /// - /// Array of character filters used to preprocess characters before the tokenizer. + /// + /// Array of character filters used to preprocess characters before the tokenizer. + /// /// [JsonInclude, JsonPropertyName("char_filter")] public ICollection? CharFilter { get; set; } /// - /// If `true`, the response includes token attributes and additional details. + /// + /// If true, the response includes token attributes and additional details. + /// /// [JsonInclude, JsonPropertyName("explain")] public bool? Explain { get; set; } /// - /// Field used to derive the analyzer.
To use this parameter, you must specify an index.
If specified, the `analyzer` parameter overrides this value. + /// + /// Field used to derive the analyzer. + /// To use this parameter, you must specify an index. + /// If specified, the analyzer parameter overrides this value. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } /// - /// Array of token filters used to apply after the tokenizer. + /// + /// Array of token filters used to apply after the tokenizer. + /// /// [JsonInclude, JsonPropertyName("filter")] public ICollection? Filter { get; set; } /// - /// Normalizer to use to convert text into a single token. + /// + /// Normalizer to use to convert text into a single token. + /// /// [JsonInclude, JsonPropertyName("normalizer")] public string? Normalizer { get; set; } /// - /// Text to analyze.
If an array of strings is provided, it is analyzed as a multi-value field. + /// + /// Text to analyze. + /// If an array of strings is provided, it is analyzed as a multi-value field. + /// /// [JsonInclude, JsonPropertyName("text")] [SingleOrManyCollectionConverter(typeof(string))] public ICollection? Text { get; set; } /// - /// Tokenizer to use to convert text into tokens. + /// + /// Tokenizer to use to convert text into tokens. + /// /// [JsonInclude, JsonPropertyName("tokenizer")] public Elastic.Clients.Elasticsearch.Analysis.ITokenizer? Tokenizer { get; set; } } /// -/// Performs analysis on a text string and returns the resulting tokens. +/// +/// Performs analysis on a text string and returns the resulting tokens. +/// /// public sealed partial class AnalyzeIndexRequestDescriptor : RequestDescriptor, AnalyzeIndexRequestParameters> { @@ -150,7 +176,10 @@ public AnalyzeIndexRequestDescriptor Index(Elastic.Clients.Elasticsea private Elastic.Clients.Elasticsearch.Analysis.ITokenizer? TokenizerValue { get; set; } /// - /// The name of the analyzer that should be applied to the provided `text`.
This could be a built-in analyzer, or an analyzer that’s been configured in the index. + /// + /// The name of the analyzer that should be applied to the provided text. + /// This could be a built-in analyzer, or an analyzer that’s been configured in the index. + /// /// public AnalyzeIndexRequestDescriptor Analyzer(string? analyzer) { @@ -159,7 +188,9 @@ public AnalyzeIndexRequestDescriptor Analyzer(string? analyzer) } /// - /// Array of token attributes used to filter the output of the `explain` parameter. + /// + /// Array of token attributes used to filter the output of the explain parameter. + /// /// public AnalyzeIndexRequestDescriptor Attributes(ICollection? attributes) { @@ -168,7 +199,9 @@ public AnalyzeIndexRequestDescriptor Attributes(ICollection? } /// - /// Array of character filters used to preprocess characters before the tokenizer. + /// + /// Array of character filters used to preprocess characters before the tokenizer. + /// /// public AnalyzeIndexRequestDescriptor CharFilter(ICollection? charFilter) { @@ -177,7 +210,9 @@ public AnalyzeIndexRequestDescriptor CharFilter(ICollection - /// If `true`, the response includes token attributes and additional details. + /// + /// If true, the response includes token attributes and additional details. + /// /// public AnalyzeIndexRequestDescriptor Explain(bool? explain = true) { @@ -186,7 +221,11 @@ public AnalyzeIndexRequestDescriptor Explain(bool? explain = true) } /// - /// Field used to derive the analyzer.
To use this parameter, you must specify an index.
If specified, the `analyzer` parameter overrides this value. + /// + /// Field used to derive the analyzer. + /// To use this parameter, you must specify an index. + /// If specified, the analyzer parameter overrides this value. + /// /// public AnalyzeIndexRequestDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -195,7 +234,11 @@ public AnalyzeIndexRequestDescriptor Field(Elastic.Clients.Elasticsea } /// - /// Field used to derive the analyzer.
To use this parameter, you must specify an index.
If specified, the `analyzer` parameter overrides this value. + /// + /// Field used to derive the analyzer. + /// To use this parameter, you must specify an index. + /// If specified, the analyzer parameter overrides this value. + /// /// public AnalyzeIndexRequestDescriptor Field(Expression> field) { @@ -204,7 +247,11 @@ public AnalyzeIndexRequestDescriptor Field(Expression - /// Field used to derive the analyzer.
To use this parameter, you must specify an index.
If specified, the `analyzer` parameter overrides this value. + /// + /// Field used to derive the analyzer. + /// To use this parameter, you must specify an index. + /// If specified, the analyzer parameter overrides this value. + /// /// public AnalyzeIndexRequestDescriptor Field(Expression> field) { @@ -213,7 +260,9 @@ public AnalyzeIndexRequestDescriptor Field(Expression - /// Array of token filters used to apply after the tokenizer. + /// + /// Array of token filters used to apply after the tokenizer. + /// /// public AnalyzeIndexRequestDescriptor Filter(ICollection? filter) { @@ -222,7 +271,9 @@ public AnalyzeIndexRequestDescriptor Filter(ICollection - /// Normalizer to use to convert text into a single token. + /// + /// Normalizer to use to convert text into a single token. + /// /// public AnalyzeIndexRequestDescriptor Normalizer(string? normalizer) { @@ -231,7 +282,10 @@ public AnalyzeIndexRequestDescriptor Normalizer(string? normalizer) } /// - /// Text to analyze.
If an array of strings is provided, it is analyzed as a multi-value field. + /// + /// Text to analyze. + /// If an array of strings is provided, it is analyzed as a multi-value field. + /// /// public AnalyzeIndexRequestDescriptor Text(ICollection? text) { @@ -240,7 +294,9 @@ public AnalyzeIndexRequestDescriptor Text(ICollection? text) } /// - /// Tokenizer to use to convert text into tokens. + /// + /// Tokenizer to use to convert text into tokens. + /// /// public AnalyzeIndexRequestDescriptor Tokenizer(Elastic.Clients.Elasticsearch.Analysis.ITokenizer? tokenizer) { @@ -310,7 +366,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Performs analysis on a text string and returns the resulting tokens. +/// +/// Performs analysis on a text string and returns the resulting tokens. +/// /// public sealed partial class AnalyzeIndexRequestDescriptor : RequestDescriptor { @@ -349,7 +407,10 @@ public AnalyzeIndexRequestDescriptor Index(Elastic.Clients.Elasticsearch.IndexNa private Elastic.Clients.Elasticsearch.Analysis.ITokenizer? TokenizerValue { get; set; } /// - /// The name of the analyzer that should be applied to the provided `text`.
This could be a built-in analyzer, or an analyzer that’s been configured in the index. + /// + /// The name of the analyzer that should be applied to the provided text. + /// This could be a built-in analyzer, or an analyzer that’s been configured in the index. + /// /// public AnalyzeIndexRequestDescriptor Analyzer(string? analyzer) { @@ -358,7 +419,9 @@ public AnalyzeIndexRequestDescriptor Analyzer(string? analyzer) } /// - /// Array of token attributes used to filter the output of the `explain` parameter. + /// + /// Array of token attributes used to filter the output of the explain parameter. + /// /// public AnalyzeIndexRequestDescriptor Attributes(ICollection? attributes) { @@ -367,7 +430,9 @@ public AnalyzeIndexRequestDescriptor Attributes(ICollection? attributes) } /// - /// Array of character filters used to preprocess characters before the tokenizer. + /// + /// Array of character filters used to preprocess characters before the tokenizer. + /// /// public AnalyzeIndexRequestDescriptor CharFilter(ICollection? charFilter) { @@ -376,7 +441,9 @@ public AnalyzeIndexRequestDescriptor CharFilter(ICollection - /// If `true`, the response includes token attributes and additional details. + /// + /// If true, the response includes token attributes and additional details. + /// /// public AnalyzeIndexRequestDescriptor Explain(bool? explain = true) { @@ -385,7 +452,11 @@ public AnalyzeIndexRequestDescriptor Explain(bool? explain = true) } /// - /// Field used to derive the analyzer.
To use this parameter, you must specify an index.
If specified, the `analyzer` parameter overrides this value. + /// + /// Field used to derive the analyzer. + /// To use this parameter, you must specify an index. + /// If specified, the analyzer parameter overrides this value. + /// /// public AnalyzeIndexRequestDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -394,7 +465,11 @@ public AnalyzeIndexRequestDescriptor Field(Elastic.Clients.Elasticsearch.Field? } /// - /// Field used to derive the analyzer.
To use this parameter, you must specify an index.
If specified, the `analyzer` parameter overrides this value. + /// + /// Field used to derive the analyzer. + /// To use this parameter, you must specify an index. + /// If specified, the analyzer parameter overrides this value. + /// /// public AnalyzeIndexRequestDescriptor Field(Expression> field) { @@ -403,7 +478,11 @@ public AnalyzeIndexRequestDescriptor Field(Expression - /// Field used to derive the analyzer.
To use this parameter, you must specify an index.
If specified, the `analyzer` parameter overrides this value. + /// + /// Field used to derive the analyzer. + /// To use this parameter, you must specify an index. + /// If specified, the analyzer parameter overrides this value. + /// /// public AnalyzeIndexRequestDescriptor Field(Expression> field) { @@ -412,7 +491,9 @@ public AnalyzeIndexRequestDescriptor Field(Expression - /// Array of token filters used to apply after the tokenizer. + /// + /// Array of token filters used to apply after the tokenizer. + /// /// public AnalyzeIndexRequestDescriptor Filter(ICollection? filter) { @@ -421,7 +502,9 @@ public AnalyzeIndexRequestDescriptor Filter(ICollection - /// Normalizer to use to convert text into a single token. + /// + /// Normalizer to use to convert text into a single token. + /// /// public AnalyzeIndexRequestDescriptor Normalizer(string? normalizer) { @@ -430,7 +513,10 @@ public AnalyzeIndexRequestDescriptor Normalizer(string? normalizer) } /// - /// Text to analyze.
If an array of strings is provided, it is analyzed as a multi-value field. + /// + /// Text to analyze. + /// If an array of strings is provided, it is analyzed as a multi-value field. + /// /// public AnalyzeIndexRequestDescriptor Text(ICollection? text) { @@ -439,7 +525,9 @@ public AnalyzeIndexRequestDescriptor Text(ICollection? text) } /// - /// Tokenizer to use to convert text into tokens. + /// + /// Tokenizer to use to convert text into tokens. + /// /// public AnalyzeIndexRequestDescriptor Tokenizer(Elastic.Clients.Elasticsearch.Analysis.ITokenizer? tokenizer) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ClearCacheRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ClearCacheRequest.g.cs index d56c1df76d3..05e99eb3a3a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ClearCacheRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ClearCacheRequest.g.cs @@ -32,43 +32,65 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class ClearCacheRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, clears the fields cache.
Use the `fields` parameter to clear the cache of specific fields only. + /// + /// If true, clears the fields cache. + /// Use the fields parameter to clear the cache of specific fields only. + /// /// public bool? Fielddata { get => Q("fielddata"); set => Q("fielddata", value); } /// - /// Comma-separated list of field names used to limit the `fielddata` parameter. + /// + /// Comma-separated list of field names used to limit the fielddata parameter. + /// /// public Elastic.Clients.Elasticsearch.Fields? Fields { get => Q("fields"); set => Q("fields", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, clears the query cache. + /// + /// If true, clears the query cache. + /// /// public bool? Query { get => Q("query"); set => Q("query", value); } /// - /// If `true`, clears the request cache. + /// + /// If true, clears the request cache. + /// /// public bool? Request { get => Q("request"); set => Q("request", value); } } /// -/// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. +/// +/// Clears the caches of one or more indices. +/// For data streams, the API clears the caches of the stream’s backing indices. +/// /// public sealed partial class ClearCacheRequest : PlainRequest { @@ -89,50 +111,72 @@ public ClearCacheRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base( internal override string OperationName => "indices.clear_cache"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, clears the fields cache.
Use the `fields` parameter to clear the cache of specific fields only. + /// + /// If true, clears the fields cache. + /// Use the fields parameter to clear the cache of specific fields only. + /// /// [JsonIgnore] public bool? Fielddata { get => Q("fielddata"); set => Q("fielddata", value); } /// - /// Comma-separated list of field names used to limit the `fielddata` parameter. + /// + /// Comma-separated list of field names used to limit the fielddata parameter. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? Fields { get => Q("fields"); set => Q("fields", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, clears the query cache. + /// + /// If true, clears the query cache. + /// /// [JsonIgnore] public bool? Query { get => Q("query"); set => Q("query", value); } /// - /// If `true`, clears the request cache. + /// + /// If true, clears the request cache. + /// /// [JsonIgnore] public bool? Request { get => Q("request"); set => Q("request", value); } } /// -/// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. +/// +/// Clears the caches of one or more indices. +/// For data streams, the API clears the caches of the stream’s backing indices. +/// /// public sealed partial class ClearCacheRequestDescriptor : RequestDescriptor, ClearCacheRequestParameters> { @@ -174,7 +218,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. +/// +/// Clears the caches of one or more indices. +/// For data streams, the API clears the caches of the stream’s backing indices. +/// /// public sealed partial class ClearCacheRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CloneIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CloneIndexRequest.g.cs index 4245b37a08d..a9fc2e385ba 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CloneIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CloneIndexRequest.g.cs @@ -32,23 +32,34 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class CloneIndexRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Clones an existing index. +/// +/// Clones an existing index. +/// /// public sealed partial class CloneIndexRequest : PlainRequest { @@ -65,38 +76,53 @@ public CloneIndexRequest(Elastic.Clients.Elasticsearch.IndexName index, Elastic. internal override string OperationName => "indices.clone"; /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } /// - /// Aliases for the resulting index. + /// + /// Aliases for the resulting index. + /// /// [JsonInclude, JsonPropertyName("aliases")] public IDictionary? Aliases { get; set; } /// - /// Configuration options for the target index. + /// + /// Configuration options for the target index. + /// /// [JsonInclude, JsonPropertyName("settings")] public IDictionary? Settings { get; set; } } /// -/// Clones an existing index. +/// +/// Clones an existing index. +/// /// public sealed partial class CloneIndexRequestDescriptor : RequestDescriptor, CloneIndexRequestParameters> { @@ -138,7 +164,9 @@ public CloneIndexRequestDescriptor Target(Elastic.Clients.Elasticsear private IDictionary? SettingsValue { get; set; } /// - /// Aliases for the resulting index. + /// + /// Aliases for the resulting index. + /// /// public CloneIndexRequestDescriptor Aliases(Func>, FluentDescriptorDictionary>> selector) { @@ -147,7 +175,9 @@ public CloneIndexRequestDescriptor Aliases(Func - /// Configuration options for the target index. + /// + /// Configuration options for the target index. + /// /// public CloneIndexRequestDescriptor Settings(Func, FluentDictionary> selector) { @@ -175,7 +205,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Clones an existing index. +/// +/// Clones an existing index. +/// /// public sealed partial class CloneIndexRequestDescriptor : RequestDescriptor { @@ -213,7 +245,9 @@ public CloneIndexRequestDescriptor Target(Elastic.Clients.Elasticsearch.Name tar private IDictionary? SettingsValue { get; set; } /// - /// Aliases for the resulting index. + /// + /// Aliases for the resulting index. + /// /// public CloneIndexRequestDescriptor Aliases(Func, FluentDescriptorDictionary> selector) { @@ -222,7 +256,9 @@ public CloneIndexRequestDescriptor Aliases(Func - /// Configuration options for the target index. + /// + /// Configuration options for the target index. + /// /// public CloneIndexRequestDescriptor Settings(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CloseIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CloseIndexRequest.g.cs index 08d56a5b063..0860f19f632 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CloseIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CloseIndexRequest.g.cs @@ -32,38 +32,59 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class CloseIndexRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Closes an index. +/// +/// Closes an index. +/// /// public sealed partial class CloseIndexRequest : PlainRequest { @@ -80,44 +101,65 @@ public CloseIndexRequest(Elastic.Clients.Elasticsearch.Indices indices) : base(r internal override string OperationName => "indices.close"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Closes an index. +/// +/// Closes an index. +/// /// public sealed partial class CloseIndexRequestDescriptor : RequestDescriptor, CloseIndexRequestParameters> { @@ -158,7 +200,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Closes an index. +/// +/// Closes an index. +/// /// public sealed partial class CloseIndexRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CreateDataStreamRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CreateDataStreamRequest.g.cs index 6e958536715..6caa4e4ee99 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CreateDataStreamRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CreateDataStreamRequest.g.cs @@ -31,10 +31,27 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class CreateDataStreamRequestParameters : RequestParameters { + /// + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// + public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } + + /// + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// + public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Create a data stream.
Creates a data stream.
You must have a matching index template with data stream enabled. +/// +/// Create a data stream. +/// Creates a data stream. +/// You must have a matching index template with data stream enabled. +/// /// public sealed partial class CreateDataStreamRequest : PlainRequest { @@ -49,10 +66,30 @@ public CreateDataStreamRequest(Elastic.Clients.Elasticsearch.DataStreamName name internal override bool SupportsBody => false; internal override string OperationName => "indices.create_data_stream"; + + /// + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } + + /// + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Create a data stream.
Creates a data stream.
You must have a matching index template with data stream enabled. +/// +/// Create a data stream. +/// Creates a data stream. +/// You must have a matching index template with data stream enabled. +/// /// public sealed partial class CreateDataStreamRequestDescriptor : RequestDescriptor { @@ -70,6 +107,9 @@ public CreateDataStreamRequestDescriptor(Elastic.Clients.Elasticsearch.DataStrea internal override string OperationName => "indices.create_data_stream"; + public CreateDataStreamRequestDescriptor MasterTimeout(Elastic.Clients.Elasticsearch.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); + public CreateDataStreamRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Duration? timeout) => Qs("timeout", timeout); + public CreateDataStreamRequestDescriptor Name(Elastic.Clients.Elasticsearch.DataStreamName name) { RouteValues.Required("name", name); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CreateDataStreamResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CreateDataStreamResponse.g.cs index 2d686c77fde..8317bdb2da9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CreateDataStreamResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CreateDataStreamResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class CreateDataStreamResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CreateIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CreateIndexRequest.g.cs index d834078ffc7..bfb3914d20f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CreateIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CreateIndexRequest.g.cs @@ -32,23 +32,35 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class CreateIndexRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Create an index.
Creates a new index. +/// +/// Create an index. +/// Creates a new index. +/// /// public sealed partial class CreateIndexRequest : PlainRequest { @@ -65,44 +77,79 @@ public CreateIndexRequest(Elastic.Clients.Elasticsearch.IndexName index) : base( internal override string OperationName => "indices.create"; /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } /// - /// Aliases for the index. + /// + /// Aliases for the index. + /// /// [JsonInclude, JsonPropertyName("aliases")] public IDictionary? Aliases { get; set; } /// - /// Mapping for fields in the index. If specified, this mapping can include:
- Field names
- Field data types
- Mapping parameters + /// + /// Mapping for fields in the index. If specified, this mapping can include: + /// + /// + /// + /// + /// Field names + /// + /// + /// + /// + /// Field data types + /// + /// + /// + /// + /// Mapping parameters + /// + /// + /// /// [JsonInclude, JsonPropertyName("mappings")] public Elastic.Clients.Elasticsearch.Mapping.TypeMapping? Mappings { get; set; } /// - /// Configuration options for the index. + /// + /// Configuration options for the index. + /// /// [JsonInclude, JsonPropertyName("settings")] public Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings? Settings { get; set; } } /// -/// Create an index.
Creates a new index. +/// +/// Create an index. +/// Creates a new index. +/// /// public sealed partial class CreateIndexRequestDescriptor : RequestDescriptor, CreateIndexRequestParameters> { @@ -143,7 +190,9 @@ public CreateIndexRequestDescriptor Index(Elastic.Clients.Elasticsear private Action> SettingsDescriptorAction { get; set; } /// - /// Aliases for the index. + /// + /// Aliases for the index. + /// /// public CreateIndexRequestDescriptor Aliases(Func>, FluentDescriptorDictionary>> selector) { @@ -152,7 +201,26 @@ public CreateIndexRequestDescriptor Aliases(Func - /// Mapping for fields in the index. If specified, this mapping can include:
- Field names
- Field data types
- Mapping parameters + /// + /// Mapping for fields in the index. If specified, this mapping can include: + /// + /// + /// + /// + /// Field names + /// + /// + /// + /// + /// Field data types + /// + /// + /// + /// + /// Mapping parameters + /// + /// + /// /// public CreateIndexRequestDescriptor Mappings(Elastic.Clients.Elasticsearch.Mapping.TypeMapping? mappings) { @@ -179,7 +247,9 @@ public CreateIndexRequestDescriptor Mappings(Action - /// Configuration options for the index. + /// + /// Configuration options for the index. + /// /// public CreateIndexRequestDescriptor Settings(Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings? settings) { @@ -251,7 +321,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Create an index.
Creates a new index. +/// +/// Create an index. +/// Creates a new index. +/// /// public sealed partial class CreateIndexRequestDescriptor : RequestDescriptor { @@ -288,7 +361,9 @@ public CreateIndexRequestDescriptor Index(Elastic.Clients.Elasticsearch.IndexNam private Action SettingsDescriptorAction { get; set; } /// - /// Aliases for the index. + /// + /// Aliases for the index. + /// /// public CreateIndexRequestDescriptor Aliases(Func, FluentDescriptorDictionary> selector) { @@ -297,7 +372,26 @@ public CreateIndexRequestDescriptor Aliases(Func - /// Mapping for fields in the index. If specified, this mapping can include:
- Field names
- Field data types
- Mapping parameters + /// + /// Mapping for fields in the index. If specified, this mapping can include: + /// + /// + /// + /// + /// Field names + /// + /// + /// + /// + /// Field data types + /// + /// + /// + /// + /// Mapping parameters + /// + /// + /// /// public CreateIndexRequestDescriptor Mappings(Elastic.Clients.Elasticsearch.Mapping.TypeMapping? mappings) { @@ -324,7 +418,9 @@ public CreateIndexRequestDescriptor Mappings(Action - /// Configuration options for the index. + /// + /// Configuration options for the index. + /// /// public CreateIndexRequestDescriptor Settings(Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings? settings) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DataStreamsStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DataStreamsStatsRequest.g.cs index f8f4974a579..ac3674e318b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DataStreamsStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DataStreamsStatsRequest.g.cs @@ -32,13 +32,19 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class DataStreamsStatsRequestParameters : RequestParameters { /// - /// Type of data stream that wildcard patterns can match.
Supports comma-separated values, such as `open,hidden`. + /// + /// Type of data stream that wildcard patterns can match. + /// Supports comma-separated values, such as open,hidden. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } } /// -/// Get data stream stats.
Retrieves statistics for one or more data streams. +/// +/// Get data stream stats. +/// Retrieves statistics for one or more data streams. +/// /// public sealed partial class DataStreamsStatsRequest : PlainRequest { @@ -59,14 +65,20 @@ public DataStreamsStatsRequest(Elastic.Clients.Elasticsearch.IndexName? name) : internal override string OperationName => "indices.data_streams_stats"; /// - /// Type of data stream that wildcard patterns can match.
Supports comma-separated values, such as `open,hidden`. + /// + /// Type of data stream that wildcard patterns can match. + /// Supports comma-separated values, such as open,hidden. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } } /// -/// Get data stream stats.
Retrieves statistics for one or more data streams. +/// +/// Get data stream stats. +/// Retrieves statistics for one or more data streams. +/// /// public sealed partial class DataStreamsStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DataStreamsStatsResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DataStreamsStatsResponse.g.cs index 656df1ad503..e4b9e962207 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DataStreamsStatsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DataStreamsStatsResponse.g.cs @@ -29,37 +29,50 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class DataStreamsStatsResponse : ElasticsearchResponse { /// - /// Total number of backing indices for the selected data streams. + /// + /// Total number of backing indices for the selected data streams. + /// /// [JsonInclude, JsonPropertyName("backing_indices")] public int BackingIndices { get; init; } /// - /// Total number of selected data streams. + /// + /// Total number of selected data streams. + /// /// [JsonInclude, JsonPropertyName("data_stream_count")] public int DataStreamCount { get; init; } /// - /// Contains statistics for the selected data streams. + /// + /// Contains statistics for the selected data streams. + /// /// [JsonInclude, JsonPropertyName("data_streams")] public IReadOnlyCollection DataStreams { get; init; } /// - /// Contains information about shards that attempted to execute the request. + /// + /// Contains information about shards that attempted to execute the request. + /// /// [JsonInclude, JsonPropertyName("_shards")] public Elastic.Clients.Elasticsearch.ShardStatistics Shards { get; init; } /// - /// Total size, in bytes, of all shards for the selected data streams. + /// + /// Total size, in bytes, of all shards for the selected data streams. + /// /// [JsonInclude, JsonPropertyName("total_store_size_bytes")] public long TotalStoreSizeBytes { get; init; } /// - /// Total size of all shards for the selected data streams.
This property is included only if the `human` query parameter is `true` + /// + /// Total size of all shards for the selected data streams. + /// This property is included only if the human query parameter is true + /// /// [JsonInclude, JsonPropertyName("total_store_sizes")] public Elastic.Clients.Elasticsearch.ByteSize? TotalStoreSizes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteAliasRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteAliasRequest.g.cs index 616796e0e4c..c67a3f52376 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteAliasRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteAliasRequest.g.cs @@ -32,18 +32,27 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class DeleteAliasRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete an alias.
Removes a data stream or index from an alias. +/// +/// Delete an alias. +/// Removes a data stream or index from an alias. +/// /// public sealed partial class DeleteAliasRequest : PlainRequest { @@ -60,20 +69,29 @@ public DeleteAliasRequest(Elastic.Clients.Elasticsearch.Indices indices, Elastic internal override string OperationName => "indices.delete_alias"; /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete an alias.
Removes a data stream or index from an alias. +/// +/// Delete an alias. +/// Removes a data stream or index from an alias. +/// /// public sealed partial class DeleteAliasRequestDescriptor : RequestDescriptor, DeleteAliasRequestParameters> { @@ -116,7 +134,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Delete an alias.
Removes a data stream or index from an alias. +/// +/// Delete an alias. +/// Removes a data stream or index from an alias. +/// /// public sealed partial class DeleteAliasRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteAliasResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteAliasResponse.g.cs index ef28a4af4c2..ae5ec7e2278 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteAliasResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteAliasResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class DeleteAliasResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteDataLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteDataLifecycleRequest.g.cs index f29f971b968..f0834933723 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteDataLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteDataLifecycleRequest.g.cs @@ -32,23 +32,32 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class DeleteDataLifecycleRequestParameters : RequestParameters { /// - /// Whether wildcard expressions should get expanded to open or closed indices (default: open) + /// + /// Whether wildcard expressions should get expanded to open or closed indices (default: open) + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Specify timeout for connection to master + /// + /// Specify timeout for connection to master + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit timestamp for the document + /// + /// Explicit timestamp for the document + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete data stream lifecycles.
Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. +/// +/// Delete data stream lifecycles. +/// Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. +/// /// public sealed partial class DeleteDataLifecycleRequest : PlainRequest { @@ -65,26 +74,35 @@ public DeleteDataLifecycleRequest(Elastic.Clients.Elasticsearch.DataStreamNames internal override string OperationName => "indices.delete_data_lifecycle"; /// - /// Whether wildcard expressions should get expanded to open or closed indices (default: open) + /// + /// Whether wildcard expressions should get expanded to open or closed indices (default: open) + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Specify timeout for connection to master + /// + /// Specify timeout for connection to master + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit timestamp for the document + /// + /// Explicit timestamp for the document + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete data stream lifecycles.
Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. +/// +/// Delete data stream lifecycles. +/// Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. +/// /// public sealed partial class DeleteDataLifecycleRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteDataLifecycleResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteDataLifecycleResponse.g.cs index 014b0f5e6fb..f9d2038fc50 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteDataLifecycleResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteDataLifecycleResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class DeleteDataLifecycleResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteDataStreamRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteDataStreamRequest.g.cs index 220d49a2cd7..2201248aa06 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteDataStreamRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteDataStreamRequest.g.cs @@ -32,13 +32,25 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class DeleteDataStreamRequestParameters : RequestParameters { /// - /// Type of data stream that wildcard patterns can match. Supports comma-separated values,such as `open,hidden`. + /// + /// Type of data stream that wildcard patterns can match. Supports comma-separated values,such as open,hidden. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } + + /// + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// + public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Delete data streams.
Deletes one or more data streams and their backing indices. +/// +/// Delete data streams. +/// Deletes one or more data streams and their backing indices. +/// /// public sealed partial class DeleteDataStreamRequest : PlainRequest { @@ -55,14 +67,27 @@ public DeleteDataStreamRequest(Elastic.Clients.Elasticsearch.DataStreamNames nam internal override string OperationName => "indices.delete_data_stream"; /// - /// Type of data stream that wildcard patterns can match. Supports comma-separated values,such as `open,hidden`. + /// + /// Type of data stream that wildcard patterns can match. Supports comma-separated values,such as open,hidden. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } + + /// + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Delete data streams.
Deletes one or more data streams and their backing indices. +/// +/// Delete data streams. +/// Deletes one or more data streams and their backing indices. +/// /// public sealed partial class DeleteDataStreamRequestDescriptor : RequestDescriptor { @@ -81,6 +106,7 @@ public DeleteDataStreamRequestDescriptor(Elastic.Clients.Elasticsearch.DataStrea internal override string OperationName => "indices.delete_data_stream"; public DeleteDataStreamRequestDescriptor ExpandWildcards(ICollection? expandWildcards) => Qs("expand_wildcards", expandWildcards); + public DeleteDataStreamRequestDescriptor MasterTimeout(Elastic.Clients.Elasticsearch.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); public DeleteDataStreamRequestDescriptor Name(Elastic.Clients.Elasticsearch.DataStreamNames name) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteDataStreamResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteDataStreamResponse.g.cs index 3cc16ad4ed6..fbecc62a90f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteDataStreamResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteDataStreamResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class DeleteDataStreamResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteIndexRequest.g.cs index 3665bdc5d29..5c1d0777b74 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteIndexRequest.g.cs @@ -32,33 +32,52 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class DeleteIndexRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete indices.
Deletes one or more indices. +/// +/// Delete indices. +/// Deletes one or more indices. +/// /// public sealed partial class DeleteIndexRequest : PlainRequest { @@ -75,38 +94,57 @@ public DeleteIndexRequest(Elastic.Clients.Elasticsearch.Indices indices) : base( internal override string OperationName => "indices.delete"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete indices.
Deletes one or more indices. +/// +/// Delete indices. +/// Deletes one or more indices. +/// /// public sealed partial class DeleteIndexRequestDescriptor : RequestDescriptor, DeleteIndexRequestParameters> { @@ -146,7 +184,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Delete indices.
Deletes one or more indices. +/// +/// Delete indices. +/// Deletes one or more indices. +/// /// public sealed partial class DeleteIndexRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteIndexResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteIndexResponse.g.cs index 5307c612903..1462583eece 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteIndexResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteIndexResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class DeleteIndexResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteIndexTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteIndexTemplateRequest.g.cs index 572b547eb8d..857a45e04ab 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteIndexTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteIndexTemplateRequest.g.cs @@ -32,18 +32,27 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class DeleteIndexTemplateRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete an index template.
The provided may contain multiple template names separated by a comma. If multiple template
names are specified then there is no wildcard support and the provided names should match completely with
existing templates. +/// +/// Delete an index template. +/// The provided <index-template> may contain multiple template names separated by a comma. If multiple template +/// names are specified then there is no wildcard support and the provided names should match completely with +/// existing templates. +/// /// public sealed partial class DeleteIndexTemplateRequest : PlainRequest { @@ -60,20 +69,29 @@ public DeleteIndexTemplateRequest(Elastic.Clients.Elasticsearch.Names name) : ba internal override string OperationName => "indices.delete_index_template"; /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete an index template.
The provided may contain multiple template names separated by a comma. If multiple template
names are specified then there is no wildcard support and the provided names should match completely with
existing templates. +/// +/// Delete an index template. +/// The provided <index-template> may contain multiple template names separated by a comma. If multiple template +/// names are specified then there is no wildcard support and the provided names should match completely with +/// existing templates. +/// /// public sealed partial class DeleteIndexTemplateRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteIndexTemplateResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteIndexTemplateResponse.g.cs index b8723fab17e..b80c8280abb 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteIndexTemplateResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteIndexTemplateResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class DeleteIndexTemplateResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteTemplateRequest.g.cs index 97bff0f8601..479970378dc 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteTemplateRequest.g.cs @@ -32,18 +32,26 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class DeleteTemplateRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Deletes a legacy index template. +/// +/// Deletes a legacy index template. +/// /// public sealed partial class DeleteTemplateRequest : PlainRequest { @@ -60,20 +68,28 @@ public DeleteTemplateRequest(Elastic.Clients.Elasticsearch.Name name) : base(r = internal override string OperationName => "indices.delete_template"; /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Deletes a legacy index template. +/// +/// Deletes a legacy index template. +/// /// public sealed partial class DeleteTemplateRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteTemplateResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteTemplateResponse.g.cs index f0aa7f43904..a4129c54a7c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteTemplateResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteTemplateResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class DeleteTemplateResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DiskUsageRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DiskUsageRequest.g.cs index c916372e341..b7d8d53cd8c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DiskUsageRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DiskUsageRequest.g.cs @@ -32,33 +32,51 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class DiskUsageRequestParameters : RequestParameters { /// - /// If false, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices.
For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, the API performs a flush before analysis.
If `false`, the response may not include uncommitted data. + /// + /// If true, the API performs a flush before analysis. + /// If false, the response may not include uncommitted data. + /// /// public bool? Flush { get => Q("flush"); set => Q("flush", value); } /// - /// If `true`, missing or closed indices are not included in the response. + /// + /// If true, missing or closed indices are not included in the response. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Analyzing field disk usage is resource-intensive.
To use the API, this parameter must be set to `true`. + /// + /// Analyzing field disk usage is resource-intensive. + /// To use the API, this parameter must be set to true. + /// /// public bool? RunExpensiveTasks { get => Q("run_expensive_tasks"); set => Q("run_expensive_tasks", value); } } /// -/// Analyzes the disk usage of each field of an index or data stream. +/// +/// Analyzes the disk usage of each field of an index or data stream. +/// /// public sealed partial class DiskUsageRequest : PlainRequest { @@ -75,38 +93,56 @@ public DiskUsageRequest(Elastic.Clients.Elasticsearch.Indices indices) : base(r internal override string OperationName => "indices.disk_usage"; /// - /// If false, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices.
For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, the API performs a flush before analysis.
If `false`, the response may not include uncommitted data. + /// + /// If true, the API performs a flush before analysis. + /// If false, the response may not include uncommitted data. + /// /// [JsonIgnore] public bool? Flush { get => Q("flush"); set => Q("flush", value); } /// - /// If `true`, missing or closed indices are not included in the response. + /// + /// If true, missing or closed indices are not included in the response. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Analyzing field disk usage is resource-intensive.
To use the API, this parameter must be set to `true`. + /// + /// Analyzing field disk usage is resource-intensive. + /// To use the API, this parameter must be set to true. + /// /// [JsonIgnore] public bool? RunExpensiveTasks { get => Q("run_expensive_tasks"); set => Q("run_expensive_tasks", value); } } /// -/// Analyzes the disk usage of each field of an index or data stream. +/// +/// Analyzes the disk usage of each field of an index or data stream. +/// /// public sealed partial class DiskUsageRequestDescriptor : RequestDescriptor, DiskUsageRequestParameters> { @@ -146,7 +182,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Analyzes the disk usage of each field of an index or data stream. +/// +/// Analyzes the disk usage of each field of an index or data stream. +/// /// public sealed partial class DiskUsageRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DownsampleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DownsampleRequest.g.cs index 47e14d6b8db..88a840fb4a3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DownsampleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DownsampleRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class DownsampleRequestParameters : RequestParameters } /// -/// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval. +/// +/// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. +/// /// public sealed partial class DownsampleRequest : PlainRequest, ISelfSerializable { @@ -60,7 +62,9 @@ void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions op } /// -/// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval. +/// +/// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. +/// /// public sealed partial class DownsampleRequestDescriptor : RequestDescriptor, DownsampleRequestParameters> { @@ -122,7 +126,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval. +/// +/// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. +/// /// public sealed partial class DownsampleRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsAliasRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsAliasRequest.g.cs index a1a3c31b28a..0b0eb3e4864 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsAliasRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsAliasRequest.g.cs @@ -32,28 +32,43 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class ExistsAliasRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, requests that include a missing data stream or index in the target indices or data streams return an error. + /// + /// If false, requests that include a missing data stream or index in the target indices or data streams return an error. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, the request retrieves information from the local node only. + /// + /// If true, the request retrieves information from the local node only. + /// /// public bool? Local { get => Q("local"); set => Q("local", value); } } /// -/// Check aliases.
Checks if one or more data stream or index aliases exist. +/// +/// Check aliases. +/// Checks if one or more data stream or index aliases exist. +/// /// public sealed partial class ExistsAliasRequest : PlainRequest { @@ -74,32 +89,47 @@ public ExistsAliasRequest(Elastic.Clients.Elasticsearch.Indices? indices, Elasti internal override string OperationName => "indices.exists_alias"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, requests that include a missing data stream or index in the target indices or data streams return an error. + /// + /// If false, requests that include a missing data stream or index in the target indices or data streams return an error. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, the request retrieves information from the local node only. + /// + /// If true, the request retrieves information from the local node only. + /// /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } } /// -/// Check aliases.
Checks if one or more data stream or index aliases exist. +/// +/// Check aliases. +/// Checks if one or more data stream or index aliases exist. +/// /// public sealed partial class ExistsAliasRequestDescriptor : RequestDescriptor, ExistsAliasRequestParameters> { @@ -144,7 +174,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Check aliases.
Checks if one or more data stream or index aliases exist. +/// +/// Check aliases. +/// Checks if one or more data stream or index aliases exist. +/// /// public sealed partial class ExistsAliasRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsIndexTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsIndexTemplateRequest.g.cs index 88adf29ff4d..4da34c198c7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsIndexTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsIndexTemplateRequest.g.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class ExistsIndexTemplateRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Returns information about whether a particular index template exists. +/// +/// Returns information about whether a particular index template exists. +/// /// public sealed partial class ExistsIndexTemplateRequest : PlainRequest { @@ -55,14 +59,18 @@ public ExistsIndexTemplateRequest(Elastic.Clients.Elasticsearch.Name name) : bas internal override string OperationName => "indices.exists_index_template"; /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Returns information about whether a particular index template exists. +/// +/// Returns information about whether a particular index template exists. +/// /// public sealed partial class ExistsIndexTemplateRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsRequest.g.cs index 1657ad76f4c..14e09bf7ce5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsRequest.g.cs @@ -32,38 +32,57 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class ExistsRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, return all default settings in the response. + /// + /// If true, return all default settings in the response. + /// /// public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// If `true`, the request retrieves information from the local node only. + /// + /// If true, the request retrieves information from the local node only. + /// /// public bool? Local { get => Q("local"); set => Q("local", value); } } /// -/// Check indices.
Checks if one or more indices, index aliases, or data streams exist. +/// +/// Check indices. +/// Checks if one or more indices, index aliases, or data streams exist. +/// /// public sealed partial class ExistsRequest : PlainRequest { @@ -80,44 +99,63 @@ public ExistsRequest(Elastic.Clients.Elasticsearch.Indices indices) : base(r => internal override string OperationName => "indices.exists"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// [JsonIgnore] public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, return all default settings in the response. + /// + /// If true, return all default settings in the response. + /// /// [JsonIgnore] public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// If `true`, the request retrieves information from the local node only. + /// + /// If true, the request retrieves information from the local node only. + /// /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } } /// -/// Check indices.
Checks if one or more indices, index aliases, or data streams exist. +/// +/// Check indices. +/// Checks if one or more indices, index aliases, or data streams exist. +/// /// public sealed partial class ExistsRequestDescriptor : RequestDescriptor, ExistsRequestParameters> { @@ -158,7 +196,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Check indices.
Checks if one or more indices, index aliases, or data streams exist. +/// +/// Check indices. +/// Checks if one or more indices, index aliases, or data streams exist. +/// /// public sealed partial class ExistsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsTemplateRequest.g.cs index 3365a999300..3cecc7f3df4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsTemplateRequest.g.cs @@ -32,23 +32,32 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class ExistsTemplateRequestParameters : RequestParameters { /// - /// Return settings in flat format (default: false) + /// + /// Return settings in flat format (default: false) + /// /// public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// Return local information, do not retrieve the state from master node (default: false) + /// + /// Return local information, do not retrieve the state from master node (default: false) + /// /// public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Check existence of index templates.
Returns information about whether a particular index template exists. +/// +/// Check existence of index templates. +/// Returns information about whether a particular index template exists. +/// /// public sealed partial class ExistsTemplateRequest : PlainRequest { @@ -65,26 +74,35 @@ public ExistsTemplateRequest(Elastic.Clients.Elasticsearch.Names name) : base(r internal override string OperationName => "indices.exists_template"; /// - /// Return settings in flat format (default: false) + /// + /// Return settings in flat format (default: false) + /// /// [JsonIgnore] public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// Return local information, do not retrieve the state from master node (default: false) + /// + /// Return local information, do not retrieve the state from master node (default: false) + /// /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Check existence of index templates.
Returns information about whether a particular index template exists. +/// +/// Check existence of index templates. +/// Returns information about whether a particular index template exists. +/// /// public sealed partial class ExistsTemplateRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExplainDataLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExplainDataLifecycleRequest.g.cs index 41060ed8c76..2d8f18822db 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExplainDataLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExplainDataLifecycleRequest.g.cs @@ -32,18 +32,25 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class ExplainDataLifecycleRequestParameters : RequestParameters { /// - /// indicates if the API should return the default values the system uses for the index's lifecycle + /// + /// indicates if the API should return the default values the system uses for the index's lifecycle + /// /// public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// Specify timeout for connection to master + /// + /// Specify timeout for connection to master + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. +/// +/// Get the status for a data stream lifecycle. +/// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. +/// /// public sealed partial class ExplainDataLifecycleRequest : PlainRequest { @@ -60,20 +67,27 @@ public ExplainDataLifecycleRequest(Elastic.Clients.Elasticsearch.Indices indices internal override string OperationName => "indices.explain_data_lifecycle"; /// - /// indicates if the API should return the default values the system uses for the index's lifecycle + /// + /// indicates if the API should return the default values the system uses for the index's lifecycle + /// /// [JsonIgnore] public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// Specify timeout for connection to master + /// + /// Specify timeout for connection to master + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. +/// +/// Get the status for a data stream lifecycle. +/// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. +/// /// public sealed partial class ExplainDataLifecycleRequestDescriptor : RequestDescriptor, ExplainDataLifecycleRequestParameters> { @@ -110,7 +124,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. +/// +/// Get the status for a data stream lifecycle. +/// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. +/// /// public sealed partial class ExplainDataLifecycleRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/FieldUsageStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/FieldUsageStatsRequest.g.cs index 58358f42140..1bfe86a6939 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/FieldUsageStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/FieldUsageStatsRequest.g.cs @@ -32,43 +32,66 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class FieldUsageStatsRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices.
For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// + /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// /// public Elastic.Clients.Elasticsearch.Fields? Fields { get => Q("fields"); set => Q("fields", value); } /// - /// If `true`, missing or closed indices are not included in the response. + /// + /// If true, missing or closed indices are not included in the response. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Returns field usage information for each shard and field of an index. +/// +/// Returns field usage information for each shard and field of an index. +/// /// public sealed partial class FieldUsageStatsRequest : PlainRequest { @@ -85,50 +108,73 @@ public FieldUsageStatsRequest(Elastic.Clients.Elasticsearch.Indices indices) : b internal override string OperationName => "indices.field_usage_stats"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices.
For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// + /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? Fields { get => Q("fields"); set => Q("fields", value); } /// - /// If `true`, missing or closed indices are not included in the response. + /// + /// If true, missing or closed indices are not included in the response. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Returns field usage information for each shard and field of an index. +/// +/// Returns field usage information for each shard and field of an index. +/// /// public sealed partial class FieldUsageStatsRequestDescriptor : RequestDescriptor, FieldUsageStatsRequestParameters> { @@ -170,7 +216,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns field usage information for each shard and field of an index. +/// +/// Returns field usage information for each shard and field of an index. +/// /// public sealed partial class FieldUsageStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/FlushRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/FlushRequest.g.cs index 2194f089487..8910e29affe 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/FlushRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/FlushRequest.g.cs @@ -32,33 +32,50 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class FlushRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, the request forces a flush even if there are no changes to commit to the index. + /// + /// If true, the request forces a flush even if there are no changes to commit to the index. + /// /// public bool? Force { get => Q("force"); set => Q("force", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, the flush operation blocks until execution when another flush operation is running.
If `false`, Elasticsearch returns an error if you request a flush when another flush operation is running. + /// + /// If true, the flush operation blocks until execution when another flush operation is running. + /// If false, Elasticsearch returns an error if you request a flush when another flush operation is running. + /// /// public bool? WaitIfOngoing { get => Q("wait_if_ongoing"); set => Q("wait_if_ongoing", value); } } /// -/// Flushes one or more data streams or indices. +/// +/// Flushes one or more data streams or indices. +/// /// public sealed partial class FlushRequest : PlainRequest { @@ -79,38 +96,55 @@ public FlushRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r => internal override string OperationName => "indices.flush"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, the request forces a flush even if there are no changes to commit to the index. + /// + /// If true, the request forces a flush even if there are no changes to commit to the index. + /// /// [JsonIgnore] public bool? Force { get => Q("force"); set => Q("force", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, the flush operation blocks until execution when another flush operation is running.
If `false`, Elasticsearch returns an error if you request a flush when another flush operation is running. + /// + /// If true, the flush operation blocks until execution when another flush operation is running. + /// If false, Elasticsearch returns an error if you request a flush when another flush operation is running. + /// /// [JsonIgnore] public bool? WaitIfOngoing { get => Q("wait_if_ongoing"); set => Q("wait_if_ongoing", value); } } /// -/// Flushes one or more data streams or indices. +/// +/// Flushes one or more data streams or indices. +/// /// public sealed partial class FlushRequestDescriptor : RequestDescriptor, FlushRequestParameters> { @@ -150,7 +184,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Flushes one or more data streams or indices. +/// +/// Flushes one or more data streams or indices. +/// /// public sealed partial class FlushRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ForcemergeRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ForcemergeRequest.g.cs index 4245584ec42..d1df3fca3d9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ForcemergeRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ForcemergeRequest.g.cs @@ -32,43 +32,59 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class ForcemergeRequestParameters : RequestParameters { /// - /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + /// + /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified) + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// + /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Specify whether the index should be flushed after performing the operation (default: true) + /// + /// Specify whether the index should be flushed after performing the operation (default: true) + /// /// public bool? Flush { get => Q("flush"); set => Q("flush", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// + /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// The number of segments the index should be merged into (default: dynamic) + /// + /// The number of segments the index should be merged into (default: dynamic) + /// /// public long? MaxNumSegments { get => Q("max_num_segments"); set => Q("max_num_segments", value); } /// - /// Specify whether the operation should only expunge deleted documents + /// + /// Specify whether the operation should only expunge deleted documents + /// /// public bool? OnlyExpungeDeletes { get => Q("only_expunge_deletes"); set => Q("only_expunge_deletes", value); } /// - /// Should the request wait until the force merge is completed. + /// + /// Should the request wait until the force merge is completed. + /// /// public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Performs the force merge operation on one or more indices. +/// +/// Performs the force merge operation on one or more indices. +/// /// public sealed partial class ForcemergeRequest : PlainRequest { @@ -89,50 +105,66 @@ public ForcemergeRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base( internal override string OperationName => "indices.forcemerge"; /// - /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + /// + /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified) + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// + /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Specify whether the index should be flushed after performing the operation (default: true) + /// + /// Specify whether the index should be flushed after performing the operation (default: true) + /// /// [JsonIgnore] public bool? Flush { get => Q("flush"); set => Q("flush", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// + /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// The number of segments the index should be merged into (default: dynamic) + /// + /// The number of segments the index should be merged into (default: dynamic) + /// /// [JsonIgnore] public long? MaxNumSegments { get => Q("max_num_segments"); set => Q("max_num_segments", value); } /// - /// Specify whether the operation should only expunge deleted documents + /// + /// Specify whether the operation should only expunge deleted documents + /// /// [JsonIgnore] public bool? OnlyExpungeDeletes { get => Q("only_expunge_deletes"); set => Q("only_expunge_deletes", value); } /// - /// Should the request wait until the force merge is completed. + /// + /// Should the request wait until the force merge is completed. + /// /// [JsonIgnore] public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Performs the force merge operation on one or more indices. +/// +/// Performs the force merge operation on one or more indices. +/// /// public sealed partial class ForcemergeRequestDescriptor : RequestDescriptor, ForcemergeRequestParameters> { @@ -174,7 +206,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Performs the force merge operation on one or more indices. +/// +/// Performs the force merge operation on one or more indices. +/// /// public sealed partial class ForcemergeRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ForcemergeResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ForcemergeResponse.g.cs index d4278ce4438..ee4f1dd2a71 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ForcemergeResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ForcemergeResponse.g.cs @@ -32,7 +32,10 @@ public sealed partial class ForcemergeResponse : ElasticsearchResponse public Elastic.Clients.Elasticsearch.ShardStatistics Shards { get; init; } /// - /// task contains a task id returned when wait_for_completion=false,
you can use the task_id to get the status of the task at _tasks/ + /// + /// task contains a task id returned when wait_for_completion=false, + /// you can use the task_id to get the status of the task at _tasks/<task_id> + /// /// [JsonInclude, JsonPropertyName("task")] public string? Task { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetAliasRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetAliasRequest.g.cs index 6fc70156cbd..20180f1f2f9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetAliasRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetAliasRequest.g.cs @@ -32,28 +32,43 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class GetAliasRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, the request retrieves information from the local node only. + /// + /// If true, the request retrieves information from the local node only. + /// /// public bool? Local { get => Q("local"); set => Q("local", value); } } /// -/// Get aliases.
Retrieves information for one or more data stream or index aliases. +/// +/// Get aliases. +/// Retrieves information for one or more data stream or index aliases. +/// /// public sealed partial class GetAliasRequest : PlainRequest { @@ -82,32 +97,47 @@ public GetAliasRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r internal override string OperationName => "indices.get_alias"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, the request retrieves information from the local node only. + /// + /// If true, the request retrieves information from the local node only. + /// /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } } /// -/// Get aliases.
Retrieves information for one or more data stream or index aliases. +/// +/// Get aliases. +/// Retrieves information for one or more data stream or index aliases. +/// /// public sealed partial class GetAliasRequestDescriptor : RequestDescriptor, GetAliasRequestParameters> { @@ -152,7 +182,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Get aliases.
Retrieves information for one or more data stream or index aliases. +/// +/// Get aliases. +/// Retrieves information for one or more data stream or index aliases. +/// /// public sealed partial class GetAliasRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetDataLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetDataLifecycleRequest.g.cs index 3914de09bf9..0d8b601bcf0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetDataLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetDataLifecycleRequest.g.cs @@ -32,18 +32,34 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class GetDataLifecycleRequestParameters : RequestParameters { /// - /// Type of data stream that wildcard patterns can match.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of data stream that wildcard patterns can match. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, return all default settings in the response. + /// + /// If true, return all default settings in the response. + /// /// public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } + + /// + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// + public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get data stream lifecycles.
Retrieves the data stream lifecycle configuration of one or more data streams. +/// +/// Get data stream lifecycles. +/// Retrieves the data stream lifecycle configuration of one or more data streams. +/// /// public sealed partial class GetDataLifecycleRequest : PlainRequest { @@ -60,20 +76,37 @@ public GetDataLifecycleRequest(Elastic.Clients.Elasticsearch.DataStreamNames nam internal override string OperationName => "indices.get_data_lifecycle"; /// - /// Type of data stream that wildcard patterns can match.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of data stream that wildcard patterns can match. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, return all default settings in the response. + /// + /// If true, return all default settings in the response. + /// /// [JsonIgnore] public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } + + /// + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get data stream lifecycles.
Retrieves the data stream lifecycle configuration of one or more data streams. +/// +/// Get data stream lifecycles. +/// Retrieves the data stream lifecycle configuration of one or more data streams. +/// /// public sealed partial class GetDataLifecycleRequestDescriptor : RequestDescriptor { @@ -93,6 +126,7 @@ public GetDataLifecycleRequestDescriptor(Elastic.Clients.Elasticsearch.DataStrea public GetDataLifecycleRequestDescriptor ExpandWildcards(ICollection? expandWildcards) => Qs("expand_wildcards", expandWildcards); public GetDataLifecycleRequestDescriptor IncludeDefaults(bool? includeDefaults = true) => Qs("include_defaults", includeDefaults); + public GetDataLifecycleRequestDescriptor MasterTimeout(Elastic.Clients.Elasticsearch.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); public GetDataLifecycleRequestDescriptor Name(Elastic.Clients.Elasticsearch.DataStreamNames name) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetDataStreamRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetDataStreamRequest.g.cs index e494dce85ac..6401716d076 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetDataStreamRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetDataStreamRequest.g.cs @@ -32,18 +32,33 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class GetDataStreamRequestParameters : RequestParameters { /// - /// Type of data stream that wildcard patterns can match.
Supports comma-separated values, such as `open,hidden`. + /// + /// Type of data stream that wildcard patterns can match. + /// Supports comma-separated values, such as open,hidden. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If true, returns all relevant default configurations for the index template. + /// + /// If true, returns all relevant default configurations for the index template. + /// /// public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } + + /// + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// + public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get data streams.
Retrieves information about one or more data streams. +/// +/// Get data streams. +/// Retrieves information about one or more data streams. +/// /// public sealed partial class GetDataStreamRequest : PlainRequest { @@ -64,20 +79,36 @@ public GetDataStreamRequest(Elastic.Clients.Elasticsearch.DataStreamNames? name) internal override string OperationName => "indices.get_data_stream"; /// - /// Type of data stream that wildcard patterns can match.
Supports comma-separated values, such as `open,hidden`. + /// + /// Type of data stream that wildcard patterns can match. + /// Supports comma-separated values, such as open,hidden. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If true, returns all relevant default configurations for the index template. + /// + /// If true, returns all relevant default configurations for the index template. + /// /// [JsonIgnore] public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } + + /// + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get data streams.
Retrieves information about one or more data streams. +/// +/// Get data streams. +/// Retrieves information about one or more data streams. +/// /// public sealed partial class GetDataStreamRequestDescriptor : RequestDescriptor { @@ -101,6 +132,7 @@ public GetDataStreamRequestDescriptor() public GetDataStreamRequestDescriptor ExpandWildcards(ICollection? expandWildcards) => Qs("expand_wildcards", expandWildcards); public GetDataStreamRequestDescriptor IncludeDefaults(bool? includeDefaults = true) => Qs("include_defaults", includeDefaults); + public GetDataStreamRequestDescriptor MasterTimeout(Elastic.Clients.Elasticsearch.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); public GetDataStreamRequestDescriptor Name(Elastic.Clients.Elasticsearch.DataStreamNames? name) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetFieldMappingRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetFieldMappingRequest.g.cs index b1c34bab6c0..7a5e9a9b217 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetFieldMappingRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetFieldMappingRequest.g.cs @@ -32,33 +32,51 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class GetFieldMappingRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, return all default settings in the response. + /// + /// If true, return all default settings in the response. + /// /// public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// If `true`, the request retrieves information from the local node only. + /// + /// If true, the request retrieves information from the local node only. + /// /// public bool? Local { get => Q("local"); set => Q("local", value); } } /// -/// Get mapping definitions.
Retrieves mapping definitions for one or more fields.
For data streams, the API retrieves field mappings for the stream’s backing indices. +/// +/// Get mapping definitions. +/// Retrieves mapping definitions for one or more fields. +/// For data streams, the API retrieves field mappings for the stream’s backing indices. +/// /// public sealed partial class GetFieldMappingRequest : PlainRequest { @@ -79,38 +97,56 @@ public GetFieldMappingRequest(Elastic.Clients.Elasticsearch.Indices? indices, El internal override string OperationName => "indices.get_field_mapping"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, return all default settings in the response. + /// + /// If true, return all default settings in the response. + /// /// [JsonIgnore] public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// If `true`, the request retrieves information from the local node only. + /// + /// If true, the request retrieves information from the local node only. + /// /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } } /// -/// Get mapping definitions.
Retrieves mapping definitions for one or more fields.
For data streams, the API retrieves field mappings for the stream’s backing indices. +/// +/// Get mapping definitions. +/// Retrieves mapping definitions for one or more fields. +/// For data streams, the API retrieves field mappings for the stream’s backing indices. +/// /// public sealed partial class GetFieldMappingRequestDescriptor : RequestDescriptor, GetFieldMappingRequestParameters> { @@ -156,7 +192,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Get mapping definitions.
Retrieves mapping definitions for one or more fields.
For data streams, the API retrieves field mappings for the stream’s backing indices. +/// +/// Get mapping definitions. +/// Retrieves mapping definitions for one or more fields. +/// For data streams, the API retrieves field mappings for the stream’s backing indices. +/// /// public sealed partial class GetFieldMappingRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetIndexRequest.g.cs index 1f8ac3e6f85..a8dacb0197f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetIndexRequest.g.cs @@ -32,48 +32,72 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class GetIndexRequestParameters : RequestParameters { /// - /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only
missing or closed indices. This behavior applies even if the request targets other open indices. For example,
a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only + /// missing or closed indices. This behavior applies even if the request targets other open indices. For example, + /// a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard expressions can match. If the request can target data streams, this argument
determines whether wildcard expressions match hidden data streams. Supports comma-separated values,
such as open,hidden. + /// + /// Type of index that wildcard expressions can match. If the request can target data streams, this argument + /// determines whether wildcard expressions match hidden data streams. Supports comma-separated values, + /// such as open,hidden. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Return only information on specified index features + /// + /// Return only information on specified index features + /// /// public ICollection? Features { get => Q?>("features"); set => Q("features", value); } /// - /// If true, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// If false, requests that target a missing index return an error. + /// + /// If false, requests that target a missing index return an error. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If true, return all default settings in the response. + /// + /// If true, return all default settings in the response. + /// /// public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + /// + /// If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + /// /// public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. +/// +/// Get index information. +/// Returns information about one or more indices. For data streams, the API returns information about the +/// stream’s backing indices. +/// /// public sealed partial class GetIndexRequest : PlainRequest { @@ -90,56 +114,80 @@ public GetIndexRequest(Elastic.Clients.Elasticsearch.Indices indices) : base(r = internal override string OperationName => "indices.get"; /// - /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only
missing or closed indices. This behavior applies even if the request targets other open indices. For example,
a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only + /// missing or closed indices. This behavior applies even if the request targets other open indices. For example, + /// a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard expressions can match. If the request can target data streams, this argument
determines whether wildcard expressions match hidden data streams. Supports comma-separated values,
such as open,hidden. + /// + /// Type of index that wildcard expressions can match. If the request can target data streams, this argument + /// determines whether wildcard expressions match hidden data streams. Supports comma-separated values, + /// such as open,hidden. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Return only information on specified index features + /// + /// Return only information on specified index features + /// /// [JsonIgnore] public ICollection? Features { get => Q?>("features"); set => Q("features", value); } /// - /// If true, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// [JsonIgnore] public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// If false, requests that target a missing index return an error. + /// + /// If false, requests that target a missing index return an error. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If true, return all default settings in the response. + /// + /// If true, return all default settings in the response. + /// /// [JsonIgnore] public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + /// + /// If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + /// /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. +/// +/// Get index information. +/// Returns information about one or more indices. For data streams, the API returns information about the +/// stream’s backing indices. +/// /// public sealed partial class GetIndexRequestDescriptor : RequestDescriptor, GetIndexRequestParameters> { @@ -182,7 +230,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. +/// +/// Get index information. +/// Returns information about one or more indices. For data streams, the API returns information about the +/// stream’s backing indices. +/// /// public sealed partial class GetIndexRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetIndexTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetIndexTemplateRequest.g.cs index e067c3d629c..de779fb2558 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetIndexTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetIndexTemplateRequest.g.cs @@ -32,28 +32,39 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class GetIndexTemplateRequestParameters : RequestParameters { /// - /// If true, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// If true, returns all relevant default configurations for the index template. + /// + /// If true, returns all relevant default configurations for the index template. + /// /// public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + /// + /// If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + /// /// public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get index templates.
Returns information about one or more index templates. +/// +/// Get index templates. +/// Returns information about one or more index templates. +/// /// public sealed partial class GetIndexTemplateRequest : PlainRequest { @@ -74,32 +85,43 @@ public GetIndexTemplateRequest(Elastic.Clients.Elasticsearch.Name? name) : base( internal override string OperationName => "indices.get_index_template"; /// - /// If true, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// [JsonIgnore] public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// If true, returns all relevant default configurations for the index template. + /// + /// If true, returns all relevant default configurations for the index template. + /// /// [JsonIgnore] public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + /// + /// If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + /// /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get index templates.
Returns information about one or more index templates. +/// +/// Get index templates. +/// Returns information about one or more index templates. +/// /// public sealed partial class GetIndexTemplateRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetIndicesSettingsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetIndicesSettingsRequest.g.cs index 7deda46e8dc..6bfe92db7bb 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetIndicesSettingsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetIndicesSettingsRequest.g.cs @@ -32,43 +32,70 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class GetIndicesSettingsRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index
alias, or `_all` value targets only missing or closed indices. This
behavior applies even if the request targets other open indices. For
example, a request targeting `foo*,bar*` returns an error if an index
starts with foo but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index + /// alias, or _all value targets only missing or closed indices. This + /// behavior applies even if the request targets other open indices. For + /// example, a request targeting foo*,bar* returns an error if an index + /// starts with foo but no index starts with bar. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, return all default settings in the response. + /// + /// If true, return all default settings in the response. + /// /// public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// If `true`, the request retrieves information from the local node only. If
`false`, information is retrieved from the master node. + /// + /// If true, the request retrieves information from the local node only. If + /// false, information is retrieved from the master node. + /// /// public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node. If no response is
received before the timeout expires, the request fails and returns an
error. + /// + /// Period to wait for a connection to the master node. If no response is + /// received before the timeout expires, the request fails and returns an + /// error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. +/// +/// Get index settings. +/// Returns setting information for one or more indices. For data streams, +/// returns setting information for the stream’s backing indices. +/// /// public sealed partial class GetIndicesSettingsRequest : PlainRequest { @@ -97,50 +124,77 @@ public GetIndicesSettingsRequest(Elastic.Clients.Elasticsearch.Names? name) : ba internal override string OperationName => "indices.get_settings"; /// - /// If `false`, the request returns an error if any wildcard expression, index
alias, or `_all` value targets only missing or closed indices. This
behavior applies even if the request targets other open indices. For
example, a request targeting `foo*,bar*` returns an error if an index
starts with foo but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index + /// alias, or _all value targets only missing or closed indices. This + /// behavior applies even if the request targets other open indices. For + /// example, a request targeting foo*,bar* returns an error if an index + /// starts with foo but no index starts with bar. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// [JsonIgnore] public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, return all default settings in the response. + /// + /// If true, return all default settings in the response. + /// /// [JsonIgnore] public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// If `true`, the request retrieves information from the local node only. If
`false`, information is retrieved from the master node. + /// + /// If true, the request retrieves information from the local node only. If + /// false, information is retrieved from the master node. + /// /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node. If no response is
received before the timeout expires, the request fails and returns an
error. + /// + /// Period to wait for a connection to the master node. If no response is + /// received before the timeout expires, the request fails and returns an + /// error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. +/// +/// Get index settings. +/// Returns setting information for one or more indices. For data streams, +/// returns setting information for the stream’s backing indices. +/// /// public sealed partial class GetIndicesSettingsRequestDescriptor : RequestDescriptor, GetIndicesSettingsRequestParameters> { @@ -188,7 +242,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. +/// +/// Get index settings. +/// Returns setting information for one or more indices. For data streams, +/// returns setting information for the stream’s backing indices. +/// /// public sealed partial class GetIndicesSettingsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetMappingRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetMappingRequest.g.cs index 4bc3d42adcb..133962fd9aa 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetMappingRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetMappingRequest.g.cs @@ -32,33 +32,52 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class GetMappingRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, the request retrieves information from the local node only. + /// + /// If true, the request retrieves information from the local node only. + /// /// public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. +/// +/// Get mapping definitions. +/// Retrieves mapping definitions for one or more indices. +/// For data streams, the API retrieves mappings for the stream’s backing indices. +/// /// public sealed partial class GetMappingRequest : PlainRequest { @@ -79,38 +98,57 @@ public GetMappingRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base( internal override string OperationName => "indices.get_mapping"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, the request retrieves information from the local node only. + /// + /// If true, the request retrieves information from the local node only. + /// /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. +/// +/// Get mapping definitions. +/// Retrieves mapping definitions for one or more indices. +/// For data streams, the API retrieves mappings for the stream’s backing indices. +/// /// public sealed partial class GetMappingRequestDescriptor : RequestDescriptor, GetMappingRequestParameters> { @@ -150,7 +188,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. +/// +/// Get mapping definitions. +/// Retrieves mapping definitions for one or more indices. +/// For data streams, the API retrieves mappings for the stream’s backing indices. +/// /// public sealed partial class GetMappingRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetTemplateRequest.g.cs index 1f20d7a1d04..91a2be09939 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetTemplateRequest.g.cs @@ -32,23 +32,33 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class GetTemplateRequestParameters : RequestParameters { /// - /// If `true`, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// If `true`, the request retrieves information from the local node only. + /// + /// If true, the request retrieves information from the local node only. + /// /// public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get index templates.
Retrieves information about one or more index templates. +/// +/// Get index templates. +/// Retrieves information about one or more index templates. +/// /// public sealed partial class GetTemplateRequest : PlainRequest { @@ -69,26 +79,36 @@ public GetTemplateRequest(Elastic.Clients.Elasticsearch.Names? name) : base(r => internal override string OperationName => "indices.get_template"; /// - /// If `true`, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// [JsonIgnore] public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// If `true`, the request retrieves information from the local node only. + /// + /// If true, the request retrieves information from the local node only. + /// /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Get index templates.
Retrieves information about one or more index templates. +/// +/// Get index templates. +/// Retrieves information about one or more index templates. +/// /// public sealed partial class GetTemplateRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/IndicesStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/IndicesStatsRequest.g.cs index 6e21bd21446..3f93d18cde6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/IndicesStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/IndicesStatsRequest.g.cs @@ -32,53 +32,76 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class IndicesStatsRequestParameters : RequestParameters { /// - /// Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + /// + /// Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + /// /// public Elastic.Clients.Elasticsearch.Fields? CompletionFields { get => Q("completion_fields"); set => Q("completion_fields", value); } /// - /// Type of index that wildcard patterns can match. If the request can target data streams, this argument
determines whether wildcard expressions match hidden data streams. Supports comma-separated values,
such as `open,hidden`. + /// + /// Type of index that wildcard patterns can match. If the request can target data streams, this argument + /// determines whether wildcard expressions match hidden data streams. Supports comma-separated values, + /// such as open,hidden. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + /// + /// Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + /// /// public Elastic.Clients.Elasticsearch.Fields? FielddataFields { get => Q("fielddata_fields"); set => Q("fielddata_fields", value); } /// - /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// + /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// /// public Elastic.Clients.Elasticsearch.Fields? Fields { get => Q("fields"); set => Q("fields", value); } /// - /// If true, statistics are not collected from closed indices. + /// + /// If true, statistics are not collected from closed indices. + /// /// public bool? ForbidClosedIndices { get => Q("forbid_closed_indices"); set => Q("forbid_closed_indices", value); } /// - /// Comma-separated list of search groups to include in the search statistics. + /// + /// Comma-separated list of search groups to include in the search statistics. + /// /// public ICollection? Groups { get => Q?>("groups"); set => Q("groups", value); } /// - /// If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + /// + /// If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + /// /// public bool? IncludeSegmentFileSizes { get => Q("include_segment_file_sizes"); set => Q("include_segment_file_sizes", value); } /// - /// If true, the response includes information from segments that are not loaded into memory. + /// + /// If true, the response includes information from segments that are not loaded into memory. + /// /// public bool? IncludeUnloadedSegments { get => Q("include_unloaded_segments"); set => Q("include_unloaded_segments", value); } /// - /// Indicates whether statistics are aggregated at the cluster, index, or shard level. + /// + /// Indicates whether statistics are aggregated at the cluster, index, or shard level. + /// /// public Elastic.Clients.Elasticsearch.Level? Level { get => Q("level"); set => Q("level", value); } } /// -/// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. +/// +/// Returns statistics for one or more indices. +/// For data streams, the API retrieves statistics for the stream’s backing indices. +/// /// public sealed partial class IndicesStatsRequest : PlainRequest { @@ -107,62 +130,85 @@ public IndicesStatsRequest(Elastic.Clients.Elasticsearch.Indices? indices, Elast internal override string OperationName => "indices.stats"; /// - /// Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + /// + /// Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? CompletionFields { get => Q("completion_fields"); set => Q("completion_fields", value); } /// - /// Type of index that wildcard patterns can match. If the request can target data streams, this argument
determines whether wildcard expressions match hidden data streams. Supports comma-separated values,
such as `open,hidden`. + /// + /// Type of index that wildcard patterns can match. If the request can target data streams, this argument + /// determines whether wildcard expressions match hidden data streams. Supports comma-separated values, + /// such as open,hidden. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + /// + /// Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? FielddataFields { get => Q("fielddata_fields"); set => Q("fielddata_fields", value); } /// - /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// + /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? Fields { get => Q("fields"); set => Q("fields", value); } /// - /// If true, statistics are not collected from closed indices. + /// + /// If true, statistics are not collected from closed indices. + /// /// [JsonIgnore] public bool? ForbidClosedIndices { get => Q("forbid_closed_indices"); set => Q("forbid_closed_indices", value); } /// - /// Comma-separated list of search groups to include in the search statistics. + /// + /// Comma-separated list of search groups to include in the search statistics. + /// /// [JsonIgnore] public ICollection? Groups { get => Q?>("groups"); set => Q("groups", value); } /// - /// If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + /// + /// If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + /// /// [JsonIgnore] public bool? IncludeSegmentFileSizes { get => Q("include_segment_file_sizes"); set => Q("include_segment_file_sizes", value); } /// - /// If true, the response includes information from segments that are not loaded into memory. + /// + /// If true, the response includes information from segments that are not loaded into memory. + /// /// [JsonIgnore] public bool? IncludeUnloadedSegments { get => Q("include_unloaded_segments"); set => Q("include_unloaded_segments", value); } /// - /// Indicates whether statistics are aggregated at the cluster, index, or shard level. + /// + /// Indicates whether statistics are aggregated at the cluster, index, or shard level. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Level? Level { get => Q("level"); set => Q("level", value); } } /// -/// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. +/// +/// Returns statistics for one or more indices. +/// For data streams, the API retrieves statistics for the stream’s backing indices. +/// /// public sealed partial class IndicesStatsRequestDescriptor : RequestDescriptor, IndicesStatsRequestParameters> { @@ -212,7 +258,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. +/// +/// Returns statistics for one or more indices. +/// For data streams, the API retrieves statistics for the stream’s backing indices. +/// /// public sealed partial class IndicesStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/MigrateToDataStreamRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/MigrateToDataStreamRequest.g.cs index c229dda2d71..b3c7378b8b1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/MigrateToDataStreamRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/MigrateToDataStreamRequest.g.cs @@ -31,10 +31,35 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class MigrateToDataStreamRequestParameters : RequestParameters { + /// + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// + public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } + + /// + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// + public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Convert an index alias to a data stream.
Converts an index alias to a data stream.
You must have a matching index template that is data stream enabled.
The alias must meet the following criteria:
The alias must have a write index;
All indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;
The alias must not have any filters;
The alias must not use custom routing.
If successful, the request removes the alias and creates a data stream with the same name.
The indices for the alias become hidden backing indices for the stream.
The write index for the alias becomes the write index for the stream. +/// +/// Convert an index alias to a data stream. +/// Converts an index alias to a data stream. +/// You must have a matching index template that is data stream enabled. +/// The alias must meet the following criteria: +/// The alias must have a write index; +/// All indices for the alias must have a @timestamp field mapping of a date or date_nanos field type; +/// The alias must not have any filters; +/// The alias must not use custom routing. +/// If successful, the request removes the alias and creates a data stream with the same name. +/// The indices for the alias become hidden backing indices for the stream. +/// The write index for the alias becomes the write index for the stream. +/// /// public sealed partial class MigrateToDataStreamRequest : PlainRequest { @@ -49,10 +74,38 @@ public MigrateToDataStreamRequest(Elastic.Clients.Elasticsearch.IndexName name) internal override bool SupportsBody => false; internal override string OperationName => "indices.migrate_to_data_stream"; + + /// + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } + + /// + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Convert an index alias to a data stream.
Converts an index alias to a data stream.
You must have a matching index template that is data stream enabled.
The alias must meet the following criteria:
The alias must have a write index;
All indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;
The alias must not have any filters;
The alias must not use custom routing.
If successful, the request removes the alias and creates a data stream with the same name.
The indices for the alias become hidden backing indices for the stream.
The write index for the alias becomes the write index for the stream. +/// +/// Convert an index alias to a data stream. +/// Converts an index alias to a data stream. +/// You must have a matching index template that is data stream enabled. +/// The alias must meet the following criteria: +/// The alias must have a write index; +/// All indices for the alias must have a @timestamp field mapping of a date or date_nanos field type; +/// The alias must not have any filters; +/// The alias must not use custom routing. +/// If successful, the request removes the alias and creates a data stream with the same name. +/// The indices for the alias become hidden backing indices for the stream. +/// The write index for the alias becomes the write index for the stream. +/// /// public sealed partial class MigrateToDataStreamRequestDescriptor : RequestDescriptor { @@ -70,6 +123,9 @@ public MigrateToDataStreamRequestDescriptor(Elastic.Clients.Elasticsearch.IndexN internal override string OperationName => "indices.migrate_to_data_stream"; + public MigrateToDataStreamRequestDescriptor MasterTimeout(Elastic.Clients.Elasticsearch.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); + public MigrateToDataStreamRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Duration? timeout) => Qs("timeout", timeout); + public MigrateToDataStreamRequestDescriptor Name(Elastic.Clients.Elasticsearch.IndexName name) { RouteValues.Required("name", name); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/MigrateToDataStreamResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/MigrateToDataStreamResponse.g.cs index b5c7b91cc7a..48d6aa2e95e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/MigrateToDataStreamResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/MigrateToDataStreamResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class MigrateToDataStreamResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ModifyDataStreamRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ModifyDataStreamRequest.g.cs index 7a5eda8ad79..4ce0c702852 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ModifyDataStreamRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ModifyDataStreamRequest.g.cs @@ -34,7 +34,10 @@ public sealed partial class ModifyDataStreamRequestParameters : RequestParameter } /// -/// Update data streams.
Performs one or more data stream modification actions in a single atomic operation. +/// +/// Update data streams. +/// Performs one or more data stream modification actions in a single atomic operation. +/// /// public sealed partial class ModifyDataStreamRequest : PlainRequest { @@ -47,14 +50,19 @@ public sealed partial class ModifyDataStreamRequest : PlainRequest "indices.modify_data_stream"; /// - /// Actions to perform. + /// + /// Actions to perform. + /// /// [JsonInclude, JsonPropertyName("actions")] public ICollection Actions { get; set; } } /// -/// Update data streams.
Performs one or more data stream modification actions in a single atomic operation. +/// +/// Update data streams. +/// Performs one or more data stream modification actions in a single atomic operation. +/// /// public sealed partial class ModifyDataStreamRequestDescriptor : RequestDescriptor { @@ -78,7 +86,9 @@ public ModifyDataStreamRequestDescriptor() private Action[] ActionsDescriptorActions { get; set; } /// - /// Actions to perform. + /// + /// Actions to perform. + /// /// public ModifyDataStreamRequestDescriptor Actions(ICollection actions) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ModifyDataStreamResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ModifyDataStreamResponse.g.cs index c7e42aec1f8..f55c2d8935d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ModifyDataStreamResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ModifyDataStreamResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class ModifyDataStreamResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/OpenIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/OpenIndexRequest.g.cs index 7bffd1e7475..660cf2282be 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/OpenIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/OpenIndexRequest.g.cs @@ -32,38 +32,60 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class OpenIndexRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Opens a closed index.
For data streams, the API opens any closed backing indices. +/// +/// Opens a closed index. +/// For data streams, the API opens any closed backing indices. +/// /// public sealed partial class OpenIndexRequest : PlainRequest { @@ -80,44 +102,66 @@ public OpenIndexRequest(Elastic.Clients.Elasticsearch.Indices indices) : base(r internal override string OperationName => "indices.open"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Opens a closed index.
For data streams, the API opens any closed backing indices. +/// +/// Opens a closed index. +/// For data streams, the API opens any closed backing indices. +/// /// public sealed partial class OpenIndexRequestDescriptor : RequestDescriptor, OpenIndexRequestParameters> { @@ -158,7 +202,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Opens a closed index.
For data streams, the API opens any closed backing indices. +/// +/// Opens a closed index. +/// For data streams, the API opens any closed backing indices. +/// /// public sealed partial class OpenIndexRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PromoteDataStreamRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PromoteDataStreamRequest.g.cs index a89d5cf7089..1e159e2413c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PromoteDataStreamRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PromoteDataStreamRequest.g.cs @@ -31,10 +31,18 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class PromoteDataStreamRequestParameters : RequestParameters { + /// + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// + public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Promotes a data stream from a replicated data stream managed by CCR to a regular data stream +/// +/// Promotes a data stream from a replicated data stream managed by CCR to a regular data stream +/// /// public sealed partial class PromoteDataStreamRequest : PlainRequest { @@ -49,10 +57,20 @@ public PromoteDataStreamRequest(Elastic.Clients.Elasticsearch.IndexName name) : internal override bool SupportsBody => false; internal override string OperationName => "indices.promote_data_stream"; + + /// + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Promotes a data stream from a replicated data stream managed by CCR to a regular data stream +/// +/// Promotes a data stream from a replicated data stream managed by CCR to a regular data stream +/// /// public sealed partial class PromoteDataStreamRequestDescriptor : RequestDescriptor { @@ -70,6 +88,8 @@ public PromoteDataStreamRequestDescriptor(Elastic.Clients.Elasticsearch.IndexNam internal override string OperationName => "indices.promote_data_stream"; + public PromoteDataStreamRequestDescriptor MasterTimeout(Elastic.Clients.Elasticsearch.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); + public PromoteDataStreamRequestDescriptor Name(Elastic.Clients.Elasticsearch.IndexName name) { RouteValues.Required("name", name); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutAliasRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutAliasRequest.g.cs index c543ad905be..59bf03cedaa 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutAliasRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutAliasRequest.g.cs @@ -32,18 +32,27 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class PutAliasRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Create or update an alias.
Adds a data stream or index to an alias. +/// +/// Create or update an alias. +/// Adds a data stream or index to an alias. +/// /// public sealed partial class PutAliasRequest : PlainRequest { @@ -60,50 +69,77 @@ public PutAliasRequest(Elastic.Clients.Elasticsearch.Indices indices, Elastic.Cl internal override string OperationName => "indices.put_alias"; /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Query used to limit documents the alias can access. + /// + /// Query used to limit documents the alias can access. + /// /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Filter { get; set; } /// - /// Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations.
Data stream aliases don’t support this parameter. + /// + /// Value used to route indexing operations to a specific shard. + /// If specified, this overwrites the routing value for indexing operations. + /// Data stream aliases don’t support this parameter. + /// /// [JsonInclude, JsonPropertyName("index_routing")] public Elastic.Clients.Elasticsearch.Routing? IndexRouting { get; set; } /// - /// If `true`, sets the write index or data stream for the alias.
If an alias points to multiple indices or data streams and `is_write_index` isn’t set, the alias rejects write requests.
If an index alias points to one index and `is_write_index` isn’t set, the index automatically acts as the write index.
Data stream aliases don’t automatically set a write data stream, even if the alias points to one data stream. + /// + /// If true, sets the write index or data stream for the alias. + /// If an alias points to multiple indices or data streams and is_write_index isn’t set, the alias rejects write requests. + /// If an index alias points to one index and is_write_index isn’t set, the index automatically acts as the write index. + /// Data stream aliases don’t automatically set a write data stream, even if the alias points to one data stream. + /// /// [JsonInclude, JsonPropertyName("is_write_index")] public bool? IsWriteIndex { get; set; } /// - /// Value used to route indexing and search operations to a specific shard.
Data stream aliases don’t support this parameter. + /// + /// Value used to route indexing and search operations to a specific shard. + /// Data stream aliases don’t support this parameter. + /// /// [JsonInclude, JsonPropertyName("routing")] public Elastic.Clients.Elasticsearch.Routing? Routing { get; set; } /// - /// Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations.
Data stream aliases don’t support this parameter. + /// + /// Value used to route search operations to a specific shard. + /// If specified, this overwrites the routing value for search operations. + /// Data stream aliases don’t support this parameter. + /// /// [JsonInclude, JsonPropertyName("search_routing")] public Elastic.Clients.Elasticsearch.Routing? SearchRouting { get; set; } } /// -/// Create or update an alias.
Adds a data stream or index to an alias. +/// +/// Create or update an alias. +/// Adds a data stream or index to an alias. +/// /// public sealed partial class PutAliasRequestDescriptor : RequestDescriptor, PutAliasRequestParameters> { @@ -149,7 +185,9 @@ public PutAliasRequestDescriptor Name(Elastic.Clients.Elasticsearch.N private Elastic.Clients.Elasticsearch.Routing? SearchRoutingValue { get; set; } /// - /// Query used to limit documents the alias can access. + /// + /// Query used to limit documents the alias can access. + /// /// public PutAliasRequestDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.Query? filter) { @@ -176,7 +214,11 @@ public PutAliasRequestDescriptor Filter(Action - /// Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations.
Data stream aliases don’t support this parameter. + /// + /// Value used to route indexing operations to a specific shard. + /// If specified, this overwrites the routing value for indexing operations. + /// Data stream aliases don’t support this parameter. + /// /// public PutAliasRequestDescriptor IndexRouting(Elastic.Clients.Elasticsearch.Routing? indexRouting) { @@ -185,7 +227,12 @@ public PutAliasRequestDescriptor IndexRouting(Elastic.Clients.Elastic } /// - /// If `true`, sets the write index or data stream for the alias.
If an alias points to multiple indices or data streams and `is_write_index` isn’t set, the alias rejects write requests.
If an index alias points to one index and `is_write_index` isn’t set, the index automatically acts as the write index.
Data stream aliases don’t automatically set a write data stream, even if the alias points to one data stream. + /// + /// If true, sets the write index or data stream for the alias. + /// If an alias points to multiple indices or data streams and is_write_index isn’t set, the alias rejects write requests. + /// If an index alias points to one index and is_write_index isn’t set, the index automatically acts as the write index. + /// Data stream aliases don’t automatically set a write data stream, even if the alias points to one data stream. + /// /// public PutAliasRequestDescriptor IsWriteIndex(bool? isWriteIndex = true) { @@ -194,7 +241,10 @@ public PutAliasRequestDescriptor IsWriteIndex(bool? isWriteIndex = tr } /// - /// Value used to route indexing and search operations to a specific shard.
Data stream aliases don’t support this parameter. + /// + /// Value used to route indexing and search operations to a specific shard. + /// Data stream aliases don’t support this parameter. + /// /// public PutAliasRequestDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? routing) { @@ -203,7 +253,11 @@ public PutAliasRequestDescriptor Routing(Elastic.Clients.Elasticsearc } /// - /// Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations.
Data stream aliases don’t support this parameter. + /// + /// Value used to route search operations to a specific shard. + /// If specified, this overwrites the routing value for search operations. + /// Data stream aliases don’t support this parameter. + /// /// public PutAliasRequestDescriptor SearchRouting(Elastic.Clients.Elasticsearch.Routing? searchRouting) { @@ -259,7 +313,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Create or update an alias.
Adds a data stream or index to an alias. +/// +/// Create or update an alias. +/// Adds a data stream or index to an alias. +/// /// public sealed partial class PutAliasRequestDescriptor : RequestDescriptor { @@ -301,7 +358,9 @@ public PutAliasRequestDescriptor Name(Elastic.Clients.Elasticsearch.Name name) private Elastic.Clients.Elasticsearch.Routing? SearchRoutingValue { get; set; } /// - /// Query used to limit documents the alias can access. + /// + /// Query used to limit documents the alias can access. + /// /// public PutAliasRequestDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.Query? filter) { @@ -328,7 +387,11 @@ public PutAliasRequestDescriptor Filter(Action - /// Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations.
Data stream aliases don’t support this parameter. + /// + /// Value used to route indexing operations to a specific shard. + /// If specified, this overwrites the routing value for indexing operations. + /// Data stream aliases don’t support this parameter. + /// /// public PutAliasRequestDescriptor IndexRouting(Elastic.Clients.Elasticsearch.Routing? indexRouting) { @@ -337,7 +400,12 @@ public PutAliasRequestDescriptor IndexRouting(Elastic.Clients.Elasticsearch.Rout } /// - /// If `true`, sets the write index or data stream for the alias.
If an alias points to multiple indices or data streams and `is_write_index` isn’t set, the alias rejects write requests.
If an index alias points to one index and `is_write_index` isn’t set, the index automatically acts as the write index.
Data stream aliases don’t automatically set a write data stream, even if the alias points to one data stream. + /// + /// If true, sets the write index or data stream for the alias. + /// If an alias points to multiple indices or data streams and is_write_index isn’t set, the alias rejects write requests. + /// If an index alias points to one index and is_write_index isn’t set, the index automatically acts as the write index. + /// Data stream aliases don’t automatically set a write data stream, even if the alias points to one data stream. + /// /// public PutAliasRequestDescriptor IsWriteIndex(bool? isWriteIndex = true) { @@ -346,7 +414,10 @@ public PutAliasRequestDescriptor IsWriteIndex(bool? isWriteIndex = true) } /// - /// Value used to route indexing and search operations to a specific shard.
Data stream aliases don’t support this parameter. + /// + /// Value used to route indexing and search operations to a specific shard. + /// Data stream aliases don’t support this parameter. + /// /// public PutAliasRequestDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? routing) { @@ -355,7 +426,11 @@ public PutAliasRequestDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? } /// - /// Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations.
Data stream aliases don’t support this parameter. + /// + /// Value used to route search operations to a specific shard. + /// If specified, this overwrites the routing value for search operations. + /// Data stream aliases don’t support this parameter. + /// /// public PutAliasRequestDescriptor SearchRouting(Elastic.Clients.Elasticsearch.Routing? searchRouting) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutAliasResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutAliasResponse.g.cs index 87b1cc6d102..4b2d5f8e957 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutAliasResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutAliasResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class PutAliasResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutDataLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutDataLifecycleRequest.g.cs index bd48e8a7886..a0c4dbcdd33 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutDataLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutDataLifecycleRequest.g.cs @@ -32,23 +32,37 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class PutDataLifecycleRequestParameters : RequestParameters { /// - /// Type of data stream that wildcard patterns can match.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `hidden`, `open`, `closed`, `none`. + /// + /// Type of data stream that wildcard patterns can match. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, hidden, open, closed, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Period to wait for a connection to the master node. If no response is
received before the timeout expires, the request fails and returns an
error. + /// + /// Period to wait for a connection to the master node. If no response is + /// received before the timeout expires, the request fails and returns an + /// error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Update data stream lifecycles.
Update the data stream lifecycle of the specified data streams. +/// +/// Update data stream lifecycles. +/// Update the data stream lifecycle of the specified data streams. +/// /// public sealed partial class PutDataLifecycleRequest : PlainRequest { @@ -65,38 +79,59 @@ public PutDataLifecycleRequest(Elastic.Clients.Elasticsearch.DataStreamNames nam internal override string OperationName => "indices.put_data_lifecycle"; /// - /// Type of data stream that wildcard patterns can match.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `hidden`, `open`, `closed`, `none`. + /// + /// Type of data stream that wildcard patterns can match. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, hidden, open, closed, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Period to wait for a connection to the master node. If no response is
received before the timeout expires, the request fails and returns an
error. + /// + /// Period to wait for a connection to the master node. If no response is + /// received before the timeout expires, the request fails and returns an + /// error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// If defined, every document added to this data stream will be stored at least for this time frame.
Any time after this duration the document could be deleted.
When empty, every document in this data stream will be stored indefinitely. + /// + /// If defined, every document added to this data stream will be stored at least for this time frame. + /// Any time after this duration the document could be deleted. + /// When empty, every document in this data stream will be stored indefinitely. + /// /// [JsonInclude, JsonPropertyName("data_retention")] public Elastic.Clients.Elasticsearch.Duration? DataRetention { get; set; } /// - /// If defined, every backing index will execute the configured downsampling configuration after the backing
index is not the data stream write index anymore. + /// + /// If defined, every backing index will execute the configured downsampling configuration after the backing + /// index is not the data stream write index anymore. + /// /// [JsonInclude, JsonPropertyName("downsampling")] public Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycleDownsampling? Downsampling { get; set; } } /// -/// Update data stream lifecycles.
Update the data stream lifecycle of the specified data streams. +/// +/// Update data stream lifecycles. +/// Update the data stream lifecycle of the specified data streams. +/// /// public sealed partial class PutDataLifecycleRequestDescriptor : RequestDescriptor { @@ -130,7 +165,11 @@ public PutDataLifecycleRequestDescriptor Name(Elastic.Clients.Elasticsearch.Data private Action DownsamplingDescriptorAction { get; set; } /// - /// If defined, every document added to this data stream will be stored at least for this time frame.
Any time after this duration the document could be deleted.
When empty, every document in this data stream will be stored indefinitely. + /// + /// If defined, every document added to this data stream will be stored at least for this time frame. + /// Any time after this duration the document could be deleted. + /// When empty, every document in this data stream will be stored indefinitely. + /// /// public PutDataLifecycleRequestDescriptor DataRetention(Elastic.Clients.Elasticsearch.Duration? dataRetention) { @@ -139,7 +178,10 @@ public PutDataLifecycleRequestDescriptor DataRetention(Elastic.Clients.Elasticse } /// - /// If defined, every backing index will execute the configured downsampling configuration after the backing
index is not the data stream write index anymore. + /// + /// If defined, every backing index will execute the configured downsampling configuration after the backing + /// index is not the data stream write index anymore. + /// /// public PutDataLifecycleRequestDescriptor Downsampling(Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycleDownsampling? downsampling) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutDataLifecycleResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutDataLifecycleResponse.g.cs index c0f909a7717..ba771b59fb4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutDataLifecycleResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutDataLifecycleResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class PutDataLifecycleResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutIndexTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutIndexTemplateRequest.g.cs index 4d168841066..ccffb40d5b5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutIndexTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutIndexTemplateRequest.g.cs @@ -32,23 +32,33 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class PutIndexTemplateRequestParameters : RequestParameters { /// - /// User defined reason for creating/updating the index template + /// + /// User defined reason for creating/updating the index template + /// /// public string? Cause { get => Q("cause"); set => Q("cause", value); } /// - /// If `true`, this request cannot replace or update existing index templates. + /// + /// If true, this request cannot replace or update existing index templates. + /// /// public bool? Create { get => Q("create"); set => Q("create", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. +/// +/// Create or update an index template. +/// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. +/// /// public sealed partial class PutIndexTemplateRequest : PlainRequest { @@ -65,86 +75,130 @@ public PutIndexTemplateRequest(Elastic.Clients.Elasticsearch.Name name) : base(r internal override string OperationName => "indices.put_index_template"; /// - /// User defined reason for creating/updating the index template + /// + /// User defined reason for creating/updating the index template + /// /// [JsonIgnore] public string? Cause { get => Q("cause"); set => Q("cause", value); } /// - /// If `true`, this request cannot replace or update existing index templates. + /// + /// If true, this request cannot replace or update existing index templates. + /// /// [JsonIgnore] public bool? Create { get => Q("create"); set => Q("create", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// This setting overrides the value of the `action.auto_create_index` cluster setting.
If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.
If set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + /// + /// This setting overrides the value of the action.auto_create_index cluster setting. + /// If set to true in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via actions.auto_create_index. + /// If set to false, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + /// /// [JsonInclude, JsonPropertyName("allow_auto_create")] public bool? AllowAutoCreate { get; set; } /// - /// An ordered list of component template names.
Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// + /// An ordered list of component template names. + /// Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// /// [JsonInclude, JsonPropertyName("composed_of")] public ICollection? ComposedOf { get; set; } /// - /// If this object is included, the template is used to create data streams and their backing indices.
Supports an empty object.
Data streams require a matching index template with a `data_stream` object. + /// + /// If this object is included, the template is used to create data streams and their backing indices. + /// Supports an empty object. + /// Data streams require a matching index template with a data_stream object. + /// /// [JsonInclude, JsonPropertyName("data_stream")] public Elastic.Clients.Elasticsearch.IndexManagement.DataStreamVisibility? DataStream { get; set; } /// - /// Marks this index template as deprecated. When creating or updating a non-deprecated index template
that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// + /// Marks this index template as deprecated. When creating or updating a non-deprecated index template + /// that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// /// [JsonInclude, JsonPropertyName("deprecated")] public bool? Deprecated { get; set; } /// - /// The configuration option ignore_missing_component_templates can be used when an index template
references a component template that might not exist + /// + /// The configuration option ignore_missing_component_templates can be used when an index template + /// references a component template that might not exist + /// /// [JsonInclude, JsonPropertyName("ignore_missing_component_templates")] public ICollection? IgnoreMissingComponentTemplates { get; set; } /// - /// Name of the index template to create. + /// + /// Name of the index template to create. + /// /// [JsonInclude, JsonPropertyName("index_patterns")] public Elastic.Clients.Elasticsearch.Indices? IndexPatterns { get; set; } /// - /// Optional user metadata about the index template.
May have any contents.
This map is not automatically generated by Elasticsearch. + /// + /// Optional user metadata about the index template. + /// May have any contents. + /// This map is not automatically generated by Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("_meta")] public IDictionary? Meta { get; set; } /// - /// Priority to determine index template precedence when a new data stream or index is created.
The index template with the highest priority is chosen.
If no priority is specified the template is treated as though it is of priority 0 (lowest priority).
This number is not automatically generated by Elasticsearch. + /// + /// Priority to determine index template precedence when a new data stream or index is created. + /// The index template with the highest priority is chosen. + /// If no priority is specified the template is treated as though it is of priority 0 (lowest priority). + /// This number is not automatically generated by Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("priority")] public long? Priority { get; set; } /// - /// Template to be applied.
It may optionally include an `aliases`, `mappings`, or `settings` configuration. + /// + /// Template to be applied. + /// It may optionally include an aliases, mappings, or settings configuration. + /// /// [JsonInclude, JsonPropertyName("template")] public Elastic.Clients.Elasticsearch.IndexManagement.IndexTemplateMapping? Template { get; set; } /// - /// Version number used to manage index templates externally.
This number is not automatically generated by Elasticsearch. + /// + /// Version number used to manage index templates externally. + /// This number is not automatically generated by Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("version")] public long? Version { get; set; } } /// -/// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. +/// +/// Create or update an index template. +/// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. +/// /// public sealed partial class PutIndexTemplateRequestDescriptor : RequestDescriptor, PutIndexTemplateRequestParameters> { @@ -188,7 +242,11 @@ public PutIndexTemplateRequestDescriptor Name(Elastic.Clients.Elastic private long? VersionValue { get; set; } /// - /// This setting overrides the value of the `action.auto_create_index` cluster setting.
If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.
If set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + /// + /// This setting overrides the value of the action.auto_create_index cluster setting. + /// If set to true in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via actions.auto_create_index. + /// If set to false, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + /// /// public PutIndexTemplateRequestDescriptor AllowAutoCreate(bool? allowAutoCreate = true) { @@ -197,7 +255,10 @@ public PutIndexTemplateRequestDescriptor AllowAutoCreate(bool? allowA } /// - /// An ordered list of component template names.
Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// + /// An ordered list of component template names. + /// Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// /// public PutIndexTemplateRequestDescriptor ComposedOf(ICollection? composedOf) { @@ -206,7 +267,11 @@ public PutIndexTemplateRequestDescriptor ComposedOf(ICollection - /// If this object is included, the template is used to create data streams and their backing indices.
Supports an empty object.
Data streams require a matching index template with a `data_stream` object. + /// + /// If this object is included, the template is used to create data streams and their backing indices. + /// Supports an empty object. + /// Data streams require a matching index template with a data_stream object. + /// /// public PutIndexTemplateRequestDescriptor DataStream(Elastic.Clients.Elasticsearch.IndexManagement.DataStreamVisibility? dataStream) { @@ -233,7 +298,10 @@ public PutIndexTemplateRequestDescriptor DataStream(Action - /// Marks this index template as deprecated. When creating or updating a non-deprecated index template
that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// + /// Marks this index template as deprecated. When creating or updating a non-deprecated index template + /// that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// /// public PutIndexTemplateRequestDescriptor Deprecated(bool? deprecated = true) { @@ -242,7 +310,10 @@ public PutIndexTemplateRequestDescriptor Deprecated(bool? deprecated } /// - /// The configuration option ignore_missing_component_templates can be used when an index template
references a component template that might not exist + /// + /// The configuration option ignore_missing_component_templates can be used when an index template + /// references a component template that might not exist + /// /// public PutIndexTemplateRequestDescriptor IgnoreMissingComponentTemplates(ICollection? ignoreMissingComponentTemplates) { @@ -251,7 +322,9 @@ public PutIndexTemplateRequestDescriptor IgnoreMissingComponentTempla } /// - /// Name of the index template to create. + /// + /// Name of the index template to create. + /// /// public PutIndexTemplateRequestDescriptor IndexPatterns(Elastic.Clients.Elasticsearch.Indices? indexPatterns) { @@ -260,7 +333,11 @@ public PutIndexTemplateRequestDescriptor IndexPatterns(Elastic.Client } /// - /// Optional user metadata about the index template.
May have any contents.
This map is not automatically generated by Elasticsearch. + /// + /// Optional user metadata about the index template. + /// May have any contents. + /// This map is not automatically generated by Elasticsearch. + /// /// public PutIndexTemplateRequestDescriptor Meta(Func, FluentDictionary> selector) { @@ -269,7 +346,12 @@ public PutIndexTemplateRequestDescriptor Meta(Func - /// Priority to determine index template precedence when a new data stream or index is created.
The index template with the highest priority is chosen.
If no priority is specified the template is treated as though it is of priority 0 (lowest priority).
This number is not automatically generated by Elasticsearch. + /// + /// Priority to determine index template precedence when a new data stream or index is created. + /// The index template with the highest priority is chosen. + /// If no priority is specified the template is treated as though it is of priority 0 (lowest priority). + /// This number is not automatically generated by Elasticsearch. + /// /// public PutIndexTemplateRequestDescriptor Priority(long? priority) { @@ -278,7 +360,10 @@ public PutIndexTemplateRequestDescriptor Priority(long? priority) } /// - /// Template to be applied.
It may optionally include an `aliases`, `mappings`, or `settings` configuration. + /// + /// Template to be applied. + /// It may optionally include an aliases, mappings, or settings configuration. + /// /// public PutIndexTemplateRequestDescriptor Template(Elastic.Clients.Elasticsearch.IndexManagement.IndexTemplateMapping? template) { @@ -305,7 +390,10 @@ public PutIndexTemplateRequestDescriptor Template(Action - /// Version number used to manage index templates externally.
This number is not automatically generated by Elasticsearch. + /// + /// Version number used to manage index templates externally. + /// This number is not automatically generated by Elasticsearch. + /// /// public PutIndexTemplateRequestDescriptor Version(long? version) { @@ -401,7 +489,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. +/// +/// Create or update an index template. +/// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. +/// /// public sealed partial class PutIndexTemplateRequestDescriptor : RequestDescriptor { @@ -445,7 +536,11 @@ public PutIndexTemplateRequestDescriptor Name(Elastic.Clients.Elasticsearch.Name private long? VersionValue { get; set; } /// - /// This setting overrides the value of the `action.auto_create_index` cluster setting.
If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.
If set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + /// + /// This setting overrides the value of the action.auto_create_index cluster setting. + /// If set to true in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via actions.auto_create_index. + /// If set to false, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + /// /// public PutIndexTemplateRequestDescriptor AllowAutoCreate(bool? allowAutoCreate = true) { @@ -454,7 +549,10 @@ public PutIndexTemplateRequestDescriptor AllowAutoCreate(bool? allowAutoCreate = } /// - /// An ordered list of component template names.
Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// + /// An ordered list of component template names. + /// Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// /// public PutIndexTemplateRequestDescriptor ComposedOf(ICollection? composedOf) { @@ -463,7 +561,11 @@ public PutIndexTemplateRequestDescriptor ComposedOf(ICollection - /// If this object is included, the template is used to create data streams and their backing indices.
Supports an empty object.
Data streams require a matching index template with a `data_stream` object. + /// + /// If this object is included, the template is used to create data streams and their backing indices. + /// Supports an empty object. + /// Data streams require a matching index template with a data_stream object. + /// /// public PutIndexTemplateRequestDescriptor DataStream(Elastic.Clients.Elasticsearch.IndexManagement.DataStreamVisibility? dataStream) { @@ -490,7 +592,10 @@ public PutIndexTemplateRequestDescriptor DataStream(Action - /// Marks this index template as deprecated. When creating or updating a non-deprecated index template
that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// + /// Marks this index template as deprecated. When creating or updating a non-deprecated index template + /// that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// /// public PutIndexTemplateRequestDescriptor Deprecated(bool? deprecated = true) { @@ -499,7 +604,10 @@ public PutIndexTemplateRequestDescriptor Deprecated(bool? deprecated = true) } /// - /// The configuration option ignore_missing_component_templates can be used when an index template
references a component template that might not exist + /// + /// The configuration option ignore_missing_component_templates can be used when an index template + /// references a component template that might not exist + /// /// public PutIndexTemplateRequestDescriptor IgnoreMissingComponentTemplates(ICollection? ignoreMissingComponentTemplates) { @@ -508,7 +616,9 @@ public PutIndexTemplateRequestDescriptor IgnoreMissingComponentTemplates(ICollec } /// - /// Name of the index template to create. + /// + /// Name of the index template to create. + /// /// public PutIndexTemplateRequestDescriptor IndexPatterns(Elastic.Clients.Elasticsearch.Indices? indexPatterns) { @@ -517,7 +627,11 @@ public PutIndexTemplateRequestDescriptor IndexPatterns(Elastic.Clients.Elasticse } /// - /// Optional user metadata about the index template.
May have any contents.
This map is not automatically generated by Elasticsearch. + /// + /// Optional user metadata about the index template. + /// May have any contents. + /// This map is not automatically generated by Elasticsearch. + /// /// public PutIndexTemplateRequestDescriptor Meta(Func, FluentDictionary> selector) { @@ -526,7 +640,12 @@ public PutIndexTemplateRequestDescriptor Meta(Func - /// Priority to determine index template precedence when a new data stream or index is created.
The index template with the highest priority is chosen.
If no priority is specified the template is treated as though it is of priority 0 (lowest priority).
This number is not automatically generated by Elasticsearch. + /// + /// Priority to determine index template precedence when a new data stream or index is created. + /// The index template with the highest priority is chosen. + /// If no priority is specified the template is treated as though it is of priority 0 (lowest priority). + /// This number is not automatically generated by Elasticsearch. + /// /// public PutIndexTemplateRequestDescriptor Priority(long? priority) { @@ -535,7 +654,10 @@ public PutIndexTemplateRequestDescriptor Priority(long? priority) } /// - /// Template to be applied.
It may optionally include an `aliases`, `mappings`, or `settings` configuration. + /// + /// Template to be applied. + /// It may optionally include an aliases, mappings, or settings configuration. + /// /// public PutIndexTemplateRequestDescriptor Template(Elastic.Clients.Elasticsearch.IndexManagement.IndexTemplateMapping? template) { @@ -562,7 +684,10 @@ public PutIndexTemplateRequestDescriptor Template(Action - /// Version number used to manage index templates externally.
This number is not automatically generated by Elasticsearch. + /// + /// Version number used to manage index templates externally. + /// This number is not automatically generated by Elasticsearch. + /// /// public PutIndexTemplateRequestDescriptor Version(long? version) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutIndexTemplateResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutIndexTemplateResponse.g.cs index 6e12915ef44..ca9c859e0ba 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutIndexTemplateResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutIndexTemplateResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class PutIndexTemplateResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutIndicesSettingsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutIndicesSettingsRequest.g.cs index 33a68aa7bc5..de404d34892 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutIndicesSettingsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutIndicesSettingsRequest.g.cs @@ -32,43 +32,71 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class PutIndicesSettingsRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index
alias, or `_all` value targets only missing or closed indices. This
behavior applies even if the request targets other open indices. For
example, a request targeting `foo*,bar*` returns an error if an index
starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index + /// alias, or _all value targets only missing or closed indices. This + /// behavior applies even if the request targets other open indices. For + /// example, a request targeting foo*,bar* returns an error if an index + /// starts with foo but no index starts with bar. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match. If the request can target
data streams, this argument determines whether wildcard expressions match
hidden data streams. Supports comma-separated values, such as
`open,hidden`. + /// + /// Type of index that wildcard patterns can match. If the request can target + /// data streams, this argument determines whether wildcard expressions match + /// hidden data streams. Supports comma-separated values, such as + /// open,hidden. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// If `true`, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Period to wait for a connection to the master node. If no response is
received before the timeout expires, the request fails and returns an
error. + /// + /// Period to wait for a connection to the master node. If no response is + /// received before the timeout expires, the request fails and returns an + /// error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// If `true`, existing index settings remain unchanged. + /// + /// If true, existing index settings remain unchanged. + /// /// public bool? PreserveExisting { get => Q("preserve_existing"); set => Q("preserve_existing", value); } /// - /// Period to wait for a response. If no response is received before the
timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the + /// timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. +/// +/// Update index settings. +/// Changes dynamic index settings in real time. For data streams, index setting +/// changes are applied to all backing indices by default. +/// /// public sealed partial class PutIndicesSettingsRequest : PlainRequest, ISelfSerializable { @@ -89,43 +117,67 @@ public PutIndicesSettingsRequest(Elastic.Clients.Elasticsearch.Indices? indices) internal override string OperationName => "indices.put_settings"; /// - /// If `false`, the request returns an error if any wildcard expression, index
alias, or `_all` value targets only missing or closed indices. This
behavior applies even if the request targets other open indices. For
example, a request targeting `foo*,bar*` returns an error if an index
starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index + /// alias, or _all value targets only missing or closed indices. This + /// behavior applies even if the request targets other open indices. For + /// example, a request targeting foo*,bar* returns an error if an index + /// starts with foo but no index starts with bar. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match. If the request can target
data streams, this argument determines whether wildcard expressions match
hidden data streams. Supports comma-separated values, such as
`open,hidden`. + /// + /// Type of index that wildcard patterns can match. If the request can target + /// data streams, this argument determines whether wildcard expressions match + /// hidden data streams. Supports comma-separated values, such as + /// open,hidden. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// [JsonIgnore] public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// If `true`, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Period to wait for a connection to the master node. If no response is
received before the timeout expires, the request fails and returns an
error. + /// + /// Period to wait for a connection to the master node. If no response is + /// received before the timeout expires, the request fails and returns an + /// error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// If `true`, existing index settings remain unchanged. + /// + /// If true, existing index settings remain unchanged. + /// /// [JsonIgnore] public bool? PreserveExisting { get => Q("preserve_existing"); set => Q("preserve_existing", value); } /// - /// Period to wait for a response. If no response is received before the
timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the + /// timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } @@ -139,7 +191,11 @@ void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions op } /// -/// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. +/// +/// Update index settings. +/// Changes dynamic index settings in real time. For data streams, index setting +/// changes are applied to all backing indices by default. +/// /// public sealed partial class PutIndicesSettingsRequestDescriptor : RequestDescriptor, PutIndicesSettingsRequestParameters> { @@ -204,7 +260,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. +/// +/// Update index settings. +/// Changes dynamic index settings in real time. For data streams, index setting +/// changes are applied to all backing indices by default. +/// /// public sealed partial class PutIndicesSettingsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutIndicesSettingsResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutIndicesSettingsResponse.g.cs index 56d556c345d..f5ada21c60d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutIndicesSettingsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutIndicesSettingsResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class PutIndicesSettingsResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutMappingRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutMappingRequest.g.cs index fa0b5356186..e4c430e686c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutMappingRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutMappingRequest.g.cs @@ -32,38 +32,61 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class PutMappingRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// If `true`, the mappings are applied only to the current write index for the target. + /// + /// If true, the mappings are applied only to the current write index for the target. + /// /// public bool? WriteIndexOnly { get => Q("write_index_only"); set => Q("write_index_only", value); } } /// -/// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. +/// +/// Update field mappings. +/// Adds new fields to an existing data stream or index. +/// You can also use this API to change the search settings of existing fields. +/// For data streams, these changes are applied to all backing indices by default. +/// /// public sealed partial class PutMappingRequest : PlainRequest { @@ -80,112 +103,177 @@ public PutMappingRequest(Elastic.Clients.Elasticsearch.Indices indices) : base(r internal override string OperationName => "indices.put_mapping"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// If `true`, the mappings are applied only to the current write index for the target. + /// + /// If true, the mappings are applied only to the current write index for the target. + /// /// [JsonIgnore] public bool? WriteIndexOnly { get => Q("write_index_only"); set => Q("write_index_only", value); } /// - /// Controls whether dynamic date detection is enabled. + /// + /// Controls whether dynamic date detection is enabled. + /// /// [JsonInclude, JsonPropertyName("date_detection")] public bool? DateDetection { get; set; } /// - /// Controls whether new fields are added dynamically. + /// + /// Controls whether new fields are added dynamically. + /// /// [JsonInclude, JsonPropertyName("dynamic")] public Elastic.Clients.Elasticsearch.Mapping.DynamicMapping? Dynamic { get; set; } /// - /// If date detection is enabled then new string fields are checked
against 'dynamic_date_formats' and if the value matches then
a new date field is added instead of string. + /// + /// If date detection is enabled then new string fields are checked + /// against 'dynamic_date_formats' and if the value matches then + /// a new date field is added instead of string. + /// /// [JsonInclude, JsonPropertyName("dynamic_date_formats")] public ICollection? DynamicDateFormats { get; set; } /// - /// Specify dynamic templates for the mapping. + /// + /// Specify dynamic templates for the mapping. + /// /// [JsonInclude, JsonPropertyName("dynamic_templates")] [SingleOrManyCollectionConverter(typeof(IReadOnlyDictionary))] public ICollection>? DynamicTemplates { get; set; } /// - /// Control whether field names are enabled for the index. + /// + /// Control whether field names are enabled for the index. + /// /// [JsonInclude, JsonPropertyName("_field_names")] public Elastic.Clients.Elasticsearch.Mapping.FieldNamesField? FieldNames { get; set; } /// - /// A mapping type can have custom meta data associated with it. These are
not used at all by Elasticsearch, but can be used to store
application-specific metadata. + /// + /// A mapping type can have custom meta data associated with it. These are + /// not used at all by Elasticsearch, but can be used to store + /// application-specific metadata. + /// /// [JsonInclude, JsonPropertyName("_meta")] public IDictionary? Meta { get; set; } /// - /// Automatically map strings into numeric data types for all fields. + /// + /// Automatically map strings into numeric data types for all fields. + /// /// [JsonInclude, JsonPropertyName("numeric_detection")] public bool? NumericDetection { get; set; } /// - /// Mapping for a field. For new fields, this mapping can include: - /// - Field name
- Field data type
- Mapping parameters + /// + /// Mapping for a field. For new fields, this mapping can include: + /// + /// + /// + /// + /// Field name + /// + /// + /// + /// + /// Field data type + /// + /// + /// + /// + /// Mapping parameters + /// + /// + /// /// [JsonInclude, JsonPropertyName("properties")] public Elastic.Clients.Elasticsearch.Mapping.Properties? Properties { get; set; } /// - /// Enable making a routing value required on indexed documents. + /// + /// Enable making a routing value required on indexed documents. + /// /// [JsonInclude, JsonPropertyName("_routing")] public Elastic.Clients.Elasticsearch.Mapping.RoutingField? Routing { get; set; } /// - /// Mapping of runtime fields for the index. + /// + /// Mapping of runtime fields for the index. + /// /// [JsonInclude, JsonPropertyName("runtime")] public IDictionary? Runtime { get; set; } /// - /// Control whether the _source field is enabled on the index. + /// + /// Control whether the _source field is enabled on the index. + /// /// [JsonInclude, JsonPropertyName("_source")] public Elastic.Clients.Elasticsearch.Mapping.SourceField? Source { get; set; } } /// -/// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. +/// +/// Update field mappings. +/// Adds new fields to an existing data stream or index. +/// You can also use this API to change the search settings of existing fields. +/// For data streams, these changes are applied to all backing indices by default. +/// /// public sealed partial class PutMappingRequestDescriptor : RequestDescriptor, PutMappingRequestParameters> { @@ -239,7 +327,9 @@ public PutMappingRequestDescriptor Indices(Elastic.Clients.Elasticsea private Action SourceDescriptorAction { get; set; } /// - /// Controls whether dynamic date detection is enabled. + /// + /// Controls whether dynamic date detection is enabled. + /// /// public PutMappingRequestDescriptor DateDetection(bool? dateDetection = true) { @@ -248,7 +338,9 @@ public PutMappingRequestDescriptor DateDetection(bool? dateDetection } /// - /// Controls whether new fields are added dynamically. + /// + /// Controls whether new fields are added dynamically. + /// /// public PutMappingRequestDescriptor Dynamic(Elastic.Clients.Elasticsearch.Mapping.DynamicMapping? dynamic) { @@ -257,7 +349,11 @@ public PutMappingRequestDescriptor Dynamic(Elastic.Clients.Elasticsea } /// - /// If date detection is enabled then new string fields are checked
against 'dynamic_date_formats' and if the value matches then
a new date field is added instead of string. + /// + /// If date detection is enabled then new string fields are checked + /// against 'dynamic_date_formats' and if the value matches then + /// a new date field is added instead of string. + /// /// public PutMappingRequestDescriptor DynamicDateFormats(ICollection? dynamicDateFormats) { @@ -266,7 +362,9 @@ public PutMappingRequestDescriptor DynamicDateFormats(ICollection - /// Specify dynamic templates for the mapping. + /// + /// Specify dynamic templates for the mapping. + /// /// public PutMappingRequestDescriptor DynamicTemplates(ICollection>? dynamicTemplates) { @@ -275,7 +373,9 @@ public PutMappingRequestDescriptor DynamicTemplates(ICollection - /// Control whether field names are enabled for the index. + /// + /// Control whether field names are enabled for the index. + /// /// public PutMappingRequestDescriptor FieldNames(Elastic.Clients.Elasticsearch.Mapping.FieldNamesField? fieldNames) { @@ -302,7 +402,11 @@ public PutMappingRequestDescriptor FieldNames(Action - /// A mapping type can have custom meta data associated with it. These are
not used at all by Elasticsearch, but can be used to store
application-specific metadata. + /// + /// A mapping type can have custom meta data associated with it. These are + /// not used at all by Elasticsearch, but can be used to store + /// application-specific metadata. + /// /// public PutMappingRequestDescriptor Meta(Func, FluentDictionary> selector) { @@ -311,7 +415,9 @@ public PutMappingRequestDescriptor Meta(Func - /// Automatically map strings into numeric data types for all fields. + /// + /// Automatically map strings into numeric data types for all fields. + /// /// public PutMappingRequestDescriptor NumericDetection(bool? numericDetection = true) { @@ -320,8 +426,26 @@ public PutMappingRequestDescriptor NumericDetection(bool? numericDete } /// - /// Mapping for a field. For new fields, this mapping can include: - /// - Field name
- Field data type
- Mapping parameters + /// + /// Mapping for a field. For new fields, this mapping can include: + /// + /// + /// + /// + /// Field name + /// + /// + /// + /// + /// Field data type + /// + /// + /// + /// + /// Mapping parameters + /// + /// + /// /// public PutMappingRequestDescriptor Properties(Elastic.Clients.Elasticsearch.Mapping.Properties? properties) { @@ -344,7 +468,9 @@ public PutMappingRequestDescriptor Properties(Action - /// Enable making a routing value required on indexed documents. + /// + /// Enable making a routing value required on indexed documents. + /// /// public PutMappingRequestDescriptor Routing(Elastic.Clients.Elasticsearch.Mapping.RoutingField? routing) { @@ -371,7 +497,9 @@ public PutMappingRequestDescriptor Routing(Action - /// Mapping of runtime fields for the index. + /// + /// Mapping of runtime fields for the index. + /// /// public PutMappingRequestDescriptor Runtime(Func>, FluentDescriptorDictionary>> selector) { @@ -380,7 +508,9 @@ public PutMappingRequestDescriptor Runtime(Func - /// Control whether the _source field is enabled on the index. + /// + /// Control whether the _source field is enabled on the index. + /// /// public PutMappingRequestDescriptor Source(Elastic.Clients.Elasticsearch.Mapping.SourceField? source) { @@ -510,7 +640,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. +/// +/// Update field mappings. +/// Adds new fields to an existing data stream or index. +/// You can also use this API to change the search settings of existing fields. +/// For data streams, these changes are applied to all backing indices by default. +/// /// public sealed partial class PutMappingRequestDescriptor : RequestDescriptor { @@ -560,7 +695,9 @@ public PutMappingRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indices private Action SourceDescriptorAction { get; set; } /// - /// Controls whether dynamic date detection is enabled. + /// + /// Controls whether dynamic date detection is enabled. + /// /// public PutMappingRequestDescriptor DateDetection(bool? dateDetection = true) { @@ -569,7 +706,9 @@ public PutMappingRequestDescriptor DateDetection(bool? dateDetection = true) } /// - /// Controls whether new fields are added dynamically. + /// + /// Controls whether new fields are added dynamically. + /// /// public PutMappingRequestDescriptor Dynamic(Elastic.Clients.Elasticsearch.Mapping.DynamicMapping? dynamic) { @@ -578,7 +717,11 @@ public PutMappingRequestDescriptor Dynamic(Elastic.Clients.Elasticsearch.Mapping } /// - /// If date detection is enabled then new string fields are checked
against 'dynamic_date_formats' and if the value matches then
a new date field is added instead of string. + /// + /// If date detection is enabled then new string fields are checked + /// against 'dynamic_date_formats' and if the value matches then + /// a new date field is added instead of string. + /// /// public PutMappingRequestDescriptor DynamicDateFormats(ICollection? dynamicDateFormats) { @@ -587,7 +730,9 @@ public PutMappingRequestDescriptor DynamicDateFormats(ICollection? dynam } /// - /// Specify dynamic templates for the mapping. + /// + /// Specify dynamic templates for the mapping. + /// /// public PutMappingRequestDescriptor DynamicTemplates(ICollection>? dynamicTemplates) { @@ -596,7 +741,9 @@ public PutMappingRequestDescriptor DynamicTemplates(ICollection - /// Control whether field names are enabled for the index. + /// + /// Control whether field names are enabled for the index. + /// /// public PutMappingRequestDescriptor FieldNames(Elastic.Clients.Elasticsearch.Mapping.FieldNamesField? fieldNames) { @@ -623,7 +770,11 @@ public PutMappingRequestDescriptor FieldNames(Action - /// A mapping type can have custom meta data associated with it. These are
not used at all by Elasticsearch, but can be used to store
application-specific metadata. + /// + /// A mapping type can have custom meta data associated with it. These are + /// not used at all by Elasticsearch, but can be used to store + /// application-specific metadata. + /// /// public PutMappingRequestDescriptor Meta(Func, FluentDictionary> selector) { @@ -632,7 +783,9 @@ public PutMappingRequestDescriptor Meta(Func, F } /// - /// Automatically map strings into numeric data types for all fields. + /// + /// Automatically map strings into numeric data types for all fields. + /// /// public PutMappingRequestDescriptor NumericDetection(bool? numericDetection = true) { @@ -641,8 +794,26 @@ public PutMappingRequestDescriptor NumericDetection(bool? numericDetection = tru } /// - /// Mapping for a field. For new fields, this mapping can include: - /// - Field name
- Field data type
- Mapping parameters + /// + /// Mapping for a field. For new fields, this mapping can include: + /// + /// + /// + /// + /// Field name + /// + /// + /// + /// + /// Field data type + /// + /// + /// + /// + /// Mapping parameters + /// + /// + /// /// public PutMappingRequestDescriptor Properties(Elastic.Clients.Elasticsearch.Mapping.Properties? properties) { @@ -665,7 +836,9 @@ public PutMappingRequestDescriptor Properties(Action - /// Enable making a routing value required on indexed documents. + /// + /// Enable making a routing value required on indexed documents. + /// /// public PutMappingRequestDescriptor Routing(Elastic.Clients.Elasticsearch.Mapping.RoutingField? routing) { @@ -692,7 +865,9 @@ public PutMappingRequestDescriptor Routing(Action - /// Mapping of runtime fields for the index. + /// + /// Mapping of runtime fields for the index. + /// /// public PutMappingRequestDescriptor Runtime(Func, FluentDescriptorDictionary> selector) { @@ -701,7 +876,9 @@ public PutMappingRequestDescriptor Runtime(Func - /// Control whether the _source field is enabled on the index. + /// + /// Control whether the _source field is enabled on the index. + /// /// public PutMappingRequestDescriptor Source(Elastic.Clients.Elasticsearch.Mapping.SourceField? source) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutMappingResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutMappingResponse.g.cs index db53aeee67d..ee2d54544d5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutMappingResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutMappingResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class PutMappingResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutTemplateRequest.g.cs index d96cd33e814..3bdebfcfa63 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutTemplateRequest.g.cs @@ -34,18 +34,26 @@ public sealed partial class PutTemplateRequestParameters : RequestParameters public string? Cause { get => Q("cause"); set => Q("cause", value); } /// - /// If true, this request cannot replace or update existing index templates. + /// + /// If true, this request cannot replace or update existing index templates. + /// /// public bool? Create { get => Q("create"); set => Q("create", value); } /// - /// Period to wait for a connection to the master node. If no response is
received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is + /// received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. +/// +/// Create or update an index template. +/// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. +/// /// public sealed partial class PutTemplateRequest : PlainRequest { @@ -65,58 +73,84 @@ public PutTemplateRequest(Elastic.Clients.Elasticsearch.Name name) : base(r => r public string? Cause { get => Q("cause"); set => Q("cause", value); } /// - /// If true, this request cannot replace or update existing index templates. + /// + /// If true, this request cannot replace or update existing index templates. + /// /// [JsonIgnore] public bool? Create { get => Q("create"); set => Q("create", value); } /// - /// Period to wait for a connection to the master node. If no response is
received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is + /// received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Aliases for the index. + /// + /// Aliases for the index. + /// /// [JsonInclude, JsonPropertyName("aliases")] public IDictionary? Aliases { get; set; } /// - /// Array of wildcard expressions used to match the names
of indices during creation. + /// + /// Array of wildcard expressions used to match the names + /// of indices during creation. + /// /// [JsonInclude, JsonPropertyName("index_patterns")] [SingleOrManyCollectionConverter(typeof(string))] public ICollection? IndexPatterns { get; set; } /// - /// Mapping for fields in the index. + /// + /// Mapping for fields in the index. + /// /// [JsonInclude, JsonPropertyName("mappings")] public Elastic.Clients.Elasticsearch.Mapping.TypeMapping? Mappings { get; set; } /// - /// Order in which Elasticsearch applies this template if index
matches multiple templates. - /// Templates with lower 'order' values are merged first. Templates with higher
'order' values are merged later, overriding templates with lower values. + /// + /// Order in which Elasticsearch applies this template if index + /// matches multiple templates. + /// + /// + /// Templates with lower 'order' values are merged first. Templates with higher + /// 'order' values are merged later, overriding templates with lower values. + /// /// [JsonInclude, JsonPropertyName("order")] public int? Order { get; set; } /// - /// Configuration options for the index. + /// + /// Configuration options for the index. + /// /// [JsonInclude, JsonPropertyName("settings")] public Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings? Settings { get; set; } /// - /// Version number used to manage index templates externally. This number
is not automatically generated by Elasticsearch. + /// + /// Version number used to manage index templates externally. This number + /// is not automatically generated by Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("version")] public long? Version { get; set; } } /// -/// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. +/// +/// Create or update an index template. +/// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. +/// /// public sealed partial class PutTemplateRequestDescriptor : RequestDescriptor, PutTemplateRequestParameters> { @@ -156,7 +190,9 @@ public PutTemplateRequestDescriptor Name(Elastic.Clients.Elasticsearc private long? VersionValue { get; set; } /// - /// Aliases for the index. + /// + /// Aliases for the index. + /// /// public PutTemplateRequestDescriptor Aliases(Func>, FluentDescriptorDictionary>> selector) { @@ -165,7 +201,10 @@ public PutTemplateRequestDescriptor Aliases(Func - /// Array of wildcard expressions used to match the names
of indices during creation. + /// + /// Array of wildcard expressions used to match the names + /// of indices during creation. + /// /// public PutTemplateRequestDescriptor IndexPatterns(ICollection? indexPatterns) { @@ -174,7 +213,9 @@ public PutTemplateRequestDescriptor IndexPatterns(ICollection } /// - /// Mapping for fields in the index. + /// + /// Mapping for fields in the index. + /// /// public PutTemplateRequestDescriptor Mappings(Elastic.Clients.Elasticsearch.Mapping.TypeMapping? mappings) { @@ -201,8 +242,14 @@ public PutTemplateRequestDescriptor Mappings(Action - /// Order in which Elasticsearch applies this template if index
matches multiple templates. - /// Templates with lower 'order' values are merged first. Templates with higher
'order' values are merged later, overriding templates with lower values. + /// + /// Order in which Elasticsearch applies this template if index + /// matches multiple templates. + /// + /// + /// Templates with lower 'order' values are merged first. Templates with higher + /// 'order' values are merged later, overriding templates with lower values. + /// /// public PutTemplateRequestDescriptor Order(int? order) { @@ -211,7 +258,9 @@ public PutTemplateRequestDescriptor Order(int? order) } /// - /// Configuration options for the index. + /// + /// Configuration options for the index. + /// /// public PutTemplateRequestDescriptor Settings(Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings? settings) { @@ -238,7 +287,10 @@ public PutTemplateRequestDescriptor Settings(Action - /// Version number used to manage index templates externally. This number
is not automatically generated by Elasticsearch. + /// + /// Version number used to manage index templates externally. This number + /// is not automatically generated by Elasticsearch. + /// /// public PutTemplateRequestDescriptor Version(long? version) { @@ -310,7 +362,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. +/// +/// Create or update an index template. +/// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. +/// /// public sealed partial class PutTemplateRequestDescriptor : RequestDescriptor { @@ -350,7 +405,9 @@ public PutTemplateRequestDescriptor Name(Elastic.Clients.Elasticsearch.Name name private long? VersionValue { get; set; } /// - /// Aliases for the index. + /// + /// Aliases for the index. + /// /// public PutTemplateRequestDescriptor Aliases(Func, FluentDescriptorDictionary> selector) { @@ -359,7 +416,10 @@ public PutTemplateRequestDescriptor Aliases(Func - /// Array of wildcard expressions used to match the names
of indices during creation. + /// + /// Array of wildcard expressions used to match the names + /// of indices during creation. + /// /// public PutTemplateRequestDescriptor IndexPatterns(ICollection? indexPatterns) { @@ -368,7 +428,9 @@ public PutTemplateRequestDescriptor IndexPatterns(ICollection? indexPatt } /// - /// Mapping for fields in the index. + /// + /// Mapping for fields in the index. + /// /// public PutTemplateRequestDescriptor Mappings(Elastic.Clients.Elasticsearch.Mapping.TypeMapping? mappings) { @@ -395,8 +457,14 @@ public PutTemplateRequestDescriptor Mappings(Action - /// Order in which Elasticsearch applies this template if index
matches multiple templates. - /// Templates with lower 'order' values are merged first. Templates with higher
'order' values are merged later, overriding templates with lower values. + /// + /// Order in which Elasticsearch applies this template if index + /// matches multiple templates. + /// + /// + /// Templates with lower 'order' values are merged first. Templates with higher + /// 'order' values are merged later, overriding templates with lower values. + /// /// public PutTemplateRequestDescriptor Order(int? order) { @@ -405,7 +473,9 @@ public PutTemplateRequestDescriptor Order(int? order) } /// - /// Configuration options for the index. + /// + /// Configuration options for the index. + /// /// public PutTemplateRequestDescriptor Settings(Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings? settings) { @@ -432,7 +502,10 @@ public PutTemplateRequestDescriptor Settings(Action - /// Version number used to manage index templates externally. This number
is not automatically generated by Elasticsearch. + /// + /// Version number used to manage index templates externally. This number + /// is not automatically generated by Elasticsearch. + /// /// public PutTemplateRequestDescriptor Version(long? version) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutTemplateResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutTemplateResponse.g.cs index 3d866680bdc..45918fda300 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutTemplateResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutTemplateResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class PutTemplateResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/RecoveryRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/RecoveryRequest.g.cs index 839eb4c1ce4..f7e459716e9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/RecoveryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/RecoveryRequest.g.cs @@ -32,18 +32,25 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class RecoveryRequestParameters : RequestParameters { /// - /// If `true`, the response only includes ongoing shard recoveries. + /// + /// If true, the response only includes ongoing shard recoveries. + /// /// public bool? ActiveOnly { get => Q("active_only"); set => Q("active_only", value); } /// - /// If `true`, the response includes detailed information about shard recoveries. + /// + /// If true, the response includes detailed information about shard recoveries. + /// /// public bool? Detailed { get => Q("detailed"); set => Q("detailed", value); } } /// -/// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. +/// +/// Returns information about ongoing and completed shard recoveries for one or more indices. +/// For data streams, the API returns information for the stream’s backing indices. +/// /// public sealed partial class RecoveryRequest : PlainRequest { @@ -64,20 +71,27 @@ public RecoveryRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r internal override string OperationName => "indices.recovery"; /// - /// If `true`, the response only includes ongoing shard recoveries. + /// + /// If true, the response only includes ongoing shard recoveries. + /// /// [JsonIgnore] public bool? ActiveOnly { get => Q("active_only"); set => Q("active_only", value); } /// - /// If `true`, the response includes detailed information about shard recoveries. + /// + /// If true, the response includes detailed information about shard recoveries. + /// /// [JsonIgnore] public bool? Detailed { get => Q("detailed"); set => Q("detailed", value); } } /// -/// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. +/// +/// Returns information about ongoing and completed shard recoveries for one or more indices. +/// For data streams, the API returns information for the stream’s backing indices. +/// /// public sealed partial class RecoveryRequestDescriptor : RequestDescriptor, RecoveryRequestParameters> { @@ -114,7 +128,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. +/// +/// Returns information about ongoing and completed shard recoveries for one or more indices. +/// For data streams, the API returns information for the stream’s backing indices. +/// /// public sealed partial class RecoveryRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/RefreshRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/RefreshRequest.g.cs index 8016b3832a9..8210dca5a4e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/RefreshRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/RefreshRequest.g.cs @@ -32,23 +32,37 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class RefreshRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } } /// -/// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. +/// +/// Refresh an index. +/// A refresh makes recent operations performed on one or more indices available for search. +/// For data streams, the API runs the refresh operation on the stream’s backing indices. +/// /// public sealed partial class RefreshRequest : PlainRequest { @@ -69,26 +83,40 @@ public RefreshRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r = internal override string OperationName => "indices.refresh"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } } /// -/// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. +/// +/// Refresh an index. +/// A refresh makes recent operations performed on one or more indices available for search. +/// For data streams, the API runs the refresh operation on the stream’s backing indices. +/// /// public sealed partial class RefreshRequestDescriptor : RequestDescriptor, RefreshRequestParameters> { @@ -126,7 +154,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. +/// +/// Refresh an index. +/// A refresh makes recent operations performed on one or more indices available for search. +/// For data streams, the API runs the refresh operation on the stream’s backing indices. +/// /// public sealed partial class RefreshRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ReloadSearchAnalyzersRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ReloadSearchAnalyzersRequest.g.cs index 204cb937960..8e620a97ea0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ReloadSearchAnalyzersRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ReloadSearchAnalyzersRequest.g.cs @@ -32,23 +32,31 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class ReloadSearchAnalyzersRequestParameters : RequestParameters { /// - /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + /// + /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified) + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// + /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// + /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } } /// -/// Reloads an index's search analyzers and their resources. +/// +/// Reloads an index's search analyzers and their resources. +/// /// public sealed partial class ReloadSearchAnalyzersRequest : PlainRequest { @@ -65,26 +73,34 @@ public ReloadSearchAnalyzersRequest(Elastic.Clients.Elasticsearch.Indices indice internal override string OperationName => "indices.reload_search_analyzers"; /// - /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + /// + /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified) + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// + /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// + /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } } /// -/// Reloads an index's search analyzers and their resources. +/// +/// Reloads an index's search analyzers and their resources. +/// /// public sealed partial class ReloadSearchAnalyzersRequestDescriptor : RequestDescriptor, ReloadSearchAnalyzersRequestParameters> { @@ -122,7 +138,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Reloads an index's search analyzers and their resources. +/// +/// Reloads an index's search analyzers and their resources. +/// /// public sealed partial class ReloadSearchAnalyzersRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ResolveClusterRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ResolveClusterRequest.g.cs index 256d8ae84bc..3e0b7cd6658 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ResolveClusterRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ResolveClusterRequest.g.cs @@ -32,28 +32,45 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class ResolveClusterRequestParameters : RequestParameters { /// - /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing
or closed indices. This behavior applies even if the request targets other open indices. For example, a request
targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing + /// or closed indices. This behavior applies even if the request targets other open indices. For example, a request + /// targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If true, concrete, expanded or aliased indices are ignored when frozen. Defaults to false. + /// + /// If true, concrete, expanded or aliased indices are ignored when frozen. Defaults to false. + /// /// public bool? IgnoreThrottled { get => Q("ignore_throttled"); set => Q("ignore_throttled", value); } /// - /// If false, the request returns an error if it targets a missing or closed index. Defaults to false. + /// + /// If false, the request returns an error if it targets a missing or closed index. Defaults to false. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } } /// -/// Resolves the specified index expressions to return information about each cluster, including
the local cluster, if included.
Multiple patterns and remote clusters are supported. +/// +/// Resolves the specified index expressions to return information about each cluster, including +/// the local cluster, if included. +/// Multiple patterns and remote clusters are supported. +/// /// public sealed partial class ResolveClusterRequest : PlainRequest { @@ -70,32 +87,49 @@ public ResolveClusterRequest(Elastic.Clients.Elasticsearch.Names name) : base(r internal override string OperationName => "indices.resolve_cluster"; /// - /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing
or closed indices. This behavior applies even if the request targets other open indices. For example, a request
targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing + /// or closed indices. This behavior applies even if the request targets other open indices. For example, a request + /// targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If true, concrete, expanded or aliased indices are ignored when frozen. Defaults to false. + /// + /// If true, concrete, expanded or aliased indices are ignored when frozen. Defaults to false. + /// /// [JsonIgnore] public bool? IgnoreThrottled { get => Q("ignore_throttled"); set => Q("ignore_throttled", value); } /// - /// If false, the request returns an error if it targets a missing or closed index. Defaults to false. + /// + /// If false, the request returns an error if it targets a missing or closed index. Defaults to false. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } } /// -/// Resolves the specified index expressions to return information about each cluster, including
the local cluster, if included.
Multiple patterns and remote clusters are supported. +/// +/// Resolves the specified index expressions to return information about each cluster, including +/// the local cluster, if included. +/// Multiple patterns and remote clusters are supported. +/// /// public sealed partial class ResolveClusterRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ResolveIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ResolveIndexRequest.g.cs index cbd3db9fb0a..7e23ca3f0b8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ResolveIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ResolveIndexRequest.g.cs @@ -32,13 +32,21 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class ResolveIndexRequestParameters : RequestParameters { /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } } /// -/// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams.
Multiple patterns and remote clusters are supported. +/// +/// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. +/// Multiple patterns and remote clusters are supported. +/// /// public sealed partial class ResolveIndexRequest : PlainRequest { @@ -55,14 +63,22 @@ public ResolveIndexRequest(Elastic.Clients.Elasticsearch.Names name) : base(r => internal override string OperationName => "indices.resolve_index"; /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } } /// -/// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams.
Multiple patterns and remote clusters are supported. +/// +/// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. +/// Multiple patterns and remote clusters are supported. +/// /// public sealed partial class ResolveIndexRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/RolloverRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/RolloverRequest.g.cs index 021ee59f194..e18eb9b6412 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/RolloverRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/RolloverRequest.g.cs @@ -32,28 +32,42 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class RolloverRequestParameters : RequestParameters { /// - /// If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover. + /// + /// If true, checks whether the current index satisfies the specified conditions but does not perform a rollover. + /// /// public bool? DryRun { get => Q("dry_run"); set => Q("dry_run", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Roll over to a new index.
Creates a new index for a data stream or index alias. +/// +/// Roll over to a new index. +/// Creates a new index for a data stream or index alias. +/// /// public sealed partial class RolloverRequest : PlainRequest { @@ -74,56 +88,85 @@ public RolloverRequest(Elastic.Clients.Elasticsearch.IndexAlias alias, Elastic.C internal override string OperationName => "indices.rollover"; /// - /// If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover. + /// + /// If true, checks whether the current index satisfies the specified conditions but does not perform a rollover. + /// /// [JsonIgnore] public bool? DryRun { get => Q("dry_run"); set => Q("dry_run", value); } /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } /// - /// Aliases for the target index.
Data streams do not support this parameter. + /// + /// Aliases for the target index. + /// Data streams do not support this parameter. + /// /// [JsonInclude, JsonPropertyName("aliases")] public IDictionary? Aliases { get; set; } /// - /// Conditions for the rollover.
If specified, Elasticsearch only performs the rollover if the current index satisfies these conditions.
If this parameter is not specified, Elasticsearch performs the rollover unconditionally.
If conditions are specified, at least one of them must be a `max_*` condition.
The index will rollover if any `max_*` condition is satisfied and all `min_*` conditions are satisfied. + /// + /// Conditions for the rollover. + /// If specified, Elasticsearch only performs the rollover if the current index satisfies these conditions. + /// If this parameter is not specified, Elasticsearch performs the rollover unconditionally. + /// If conditions are specified, at least one of them must be a max_* condition. + /// The index will rollover if any max_* condition is satisfied and all min_* conditions are satisfied. + /// /// [JsonInclude, JsonPropertyName("conditions")] public Elastic.Clients.Elasticsearch.IndexManagement.RolloverConditions? Conditions { get; set; } /// - /// Mapping for fields in the index.
If specified, this mapping can include field names, field data types, and mapping paramaters. + /// + /// Mapping for fields in the index. + /// If specified, this mapping can include field names, field data types, and mapping paramaters. + /// /// [JsonInclude, JsonPropertyName("mappings")] public Elastic.Clients.Elasticsearch.Mapping.TypeMapping? Mappings { get; set; } /// - /// Configuration options for the index.
Data streams do not support this parameter. + /// + /// Configuration options for the index. + /// Data streams do not support this parameter. + /// /// [JsonInclude, JsonPropertyName("settings")] public IDictionary? Settings { get; set; } } /// -/// Roll over to a new index.
Creates a new index for a data stream or index alias. +/// +/// Roll over to a new index. +/// Creates a new index for a data stream or index alias. +/// /// public sealed partial class RolloverRequestDescriptor : RequestDescriptor, RolloverRequestParameters> { @@ -172,7 +215,10 @@ public RolloverRequestDescriptor NewIndex(Elastic.Clients.Elasticsear private IDictionary? SettingsValue { get; set; } /// - /// Aliases for the target index.
Data streams do not support this parameter. + /// + /// Aliases for the target index. + /// Data streams do not support this parameter. + /// /// public RolloverRequestDescriptor Aliases(Func>, FluentDescriptorDictionary>> selector) { @@ -181,7 +227,13 @@ public RolloverRequestDescriptor Aliases(Func - /// Conditions for the rollover.
If specified, Elasticsearch only performs the rollover if the current index satisfies these conditions.
If this parameter is not specified, Elasticsearch performs the rollover unconditionally.
If conditions are specified, at least one of them must be a `max_*` condition.
The index will rollover if any `max_*` condition is satisfied and all `min_*` conditions are satisfied. + /// + /// Conditions for the rollover. + /// If specified, Elasticsearch only performs the rollover if the current index satisfies these conditions. + /// If this parameter is not specified, Elasticsearch performs the rollover unconditionally. + /// If conditions are specified, at least one of them must be a max_* condition. + /// The index will rollover if any max_* condition is satisfied and all min_* conditions are satisfied. + /// /// public RolloverRequestDescriptor Conditions(Elastic.Clients.Elasticsearch.IndexManagement.RolloverConditions? conditions) { @@ -208,7 +260,10 @@ public RolloverRequestDescriptor Conditions(Action - /// Mapping for fields in the index.
If specified, this mapping can include field names, field data types, and mapping paramaters. + /// + /// Mapping for fields in the index. + /// If specified, this mapping can include field names, field data types, and mapping paramaters. + /// /// public RolloverRequestDescriptor Mappings(Elastic.Clients.Elasticsearch.Mapping.TypeMapping? mappings) { @@ -235,7 +290,10 @@ public RolloverRequestDescriptor Mappings(Action - /// Configuration options for the index.
Data streams do not support this parameter. + /// + /// Configuration options for the index. + /// Data streams do not support this parameter. + /// /// public RolloverRequestDescriptor Settings(Func, FluentDictionary> selector) { @@ -295,7 +353,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Roll over to a new index.
Creates a new index for a data stream or index alias. +/// +/// Roll over to a new index. +/// Creates a new index for a data stream or index alias. +/// /// public sealed partial class RolloverRequestDescriptor : RequestDescriptor { @@ -344,7 +405,10 @@ public RolloverRequestDescriptor NewIndex(Elastic.Clients.Elasticsearch.IndexNam private IDictionary? SettingsValue { get; set; } /// - /// Aliases for the target index.
Data streams do not support this parameter. + /// + /// Aliases for the target index. + /// Data streams do not support this parameter. + /// /// public RolloverRequestDescriptor Aliases(Func, FluentDescriptorDictionary> selector) { @@ -353,7 +417,13 @@ public RolloverRequestDescriptor Aliases(Func - /// Conditions for the rollover.
If specified, Elasticsearch only performs the rollover if the current index satisfies these conditions.
If this parameter is not specified, Elasticsearch performs the rollover unconditionally.
If conditions are specified, at least one of them must be a `max_*` condition.
The index will rollover if any `max_*` condition is satisfied and all `min_*` conditions are satisfied. + /// + /// Conditions for the rollover. + /// If specified, Elasticsearch only performs the rollover if the current index satisfies these conditions. + /// If this parameter is not specified, Elasticsearch performs the rollover unconditionally. + /// If conditions are specified, at least one of them must be a max_* condition. + /// The index will rollover if any max_* condition is satisfied and all min_* conditions are satisfied. + /// /// public RolloverRequestDescriptor Conditions(Elastic.Clients.Elasticsearch.IndexManagement.RolloverConditions? conditions) { @@ -380,7 +450,10 @@ public RolloverRequestDescriptor Conditions(Action - /// Mapping for fields in the index.
If specified, this mapping can include field names, field data types, and mapping paramaters. + /// + /// Mapping for fields in the index. + /// If specified, this mapping can include field names, field data types, and mapping paramaters. + /// /// public RolloverRequestDescriptor Mappings(Elastic.Clients.Elasticsearch.Mapping.TypeMapping? mappings) { @@ -407,7 +480,10 @@ public RolloverRequestDescriptor Mappings(Action - /// Configuration options for the index.
Data streams do not support this parameter. + /// + /// Configuration options for the index. + /// Data streams do not support this parameter. + /// /// public RolloverRequestDescriptor Settings(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SegmentsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SegmentsRequest.g.cs index 0040eb05b5a..5069c6d6ecd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SegmentsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SegmentsRequest.g.cs @@ -32,28 +32,43 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class SegmentsRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, the request returns a verbose response. + /// + /// If true, the request returns a verbose response. + /// /// public bool? Verbose { get => Q("verbose"); set => Q("verbose", value); } } /// -/// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. +/// +/// Returns low-level information about the Lucene segments in index shards. +/// For data streams, the API returns information about the stream’s backing indices. +/// /// public sealed partial class SegmentsRequest : PlainRequest { @@ -74,32 +89,47 @@ public SegmentsRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r internal override string OperationName => "indices.segments"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, the request returns a verbose response. + /// + /// If true, the request returns a verbose response. + /// /// [JsonIgnore] public bool? Verbose { get => Q("verbose"); set => Q("verbose", value); } } /// -/// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. +/// +/// Returns low-level information about the Lucene segments in index shards. +/// For data streams, the API returns information about the stream’s backing indices. +/// /// public sealed partial class SegmentsRequestDescriptor : RequestDescriptor, SegmentsRequestParameters> { @@ -138,7 +168,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. +/// +/// Returns low-level information about the Lucene segments in index shards. +/// For data streams, the API returns information about the stream’s backing indices. +/// /// public sealed partial class SegmentsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ShardStoresRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ShardStoresRequest.g.cs index 56fa019cda4..2a24c32643c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ShardStoresRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ShardStoresRequest.g.cs @@ -32,28 +32,42 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class ShardStoresRequestParameters : RequestParameters { /// - /// If false, the request returns an error if any wildcard expression, index alias, or _all
value targets only missing or closed indices. This behavior applies even if the request
targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all + /// value targets only missing or closed indices. This behavior applies even if the request + /// targets other open indices. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match. If the request can target data streams,
this argument determines whether wildcard expressions match hidden data streams. + /// + /// Type of index that wildcard patterns can match. If the request can target data streams, + /// this argument determines whether wildcard expressions match hidden data streams. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If true, missing or closed indices are not included in the response. + /// + /// If true, missing or closed indices are not included in the response. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// List of shard health statuses used to limit the request. + /// + /// List of shard health statuses used to limit the request. + /// /// public ICollection? Status { get => Q?>("status"); set => Q("status", value); } } /// -/// Retrieves store information about replica shards in one or more indices.
For data streams, the API retrieves store information for the stream’s backing indices. +/// +/// Retrieves store information about replica shards in one or more indices. +/// For data streams, the API retrieves store information for the stream’s backing indices. +/// /// public sealed partial class ShardStoresRequest : PlainRequest { @@ -74,32 +88,46 @@ public ShardStoresRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base internal override string OperationName => "indices.shard_stores"; /// - /// If false, the request returns an error if any wildcard expression, index alias, or _all
value targets only missing or closed indices. This behavior applies even if the request
targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all + /// value targets only missing or closed indices. This behavior applies even if the request + /// targets other open indices. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match. If the request can target data streams,
this argument determines whether wildcard expressions match hidden data streams. + /// + /// Type of index that wildcard patterns can match. If the request can target data streams, + /// this argument determines whether wildcard expressions match hidden data streams. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If true, missing or closed indices are not included in the response. + /// + /// If true, missing or closed indices are not included in the response. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// List of shard health statuses used to limit the request. + /// + /// List of shard health statuses used to limit the request. + /// /// [JsonIgnore] public ICollection? Status { get => Q?>("status"); set => Q("status", value); } } /// -/// Retrieves store information about replica shards in one or more indices.
For data streams, the API retrieves store information for the stream’s backing indices. +/// +/// Retrieves store information about replica shards in one or more indices. +/// For data streams, the API retrieves store information for the stream’s backing indices. +/// /// public sealed partial class ShardStoresRequestDescriptor : RequestDescriptor, ShardStoresRequestParameters> { @@ -138,7 +166,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Retrieves store information about replica shards in one or more indices.
For data streams, the API retrieves store information for the stream’s backing indices. +/// +/// Retrieves store information about replica shards in one or more indices. +/// For data streams, the API retrieves store information for the stream’s backing indices. +/// /// public sealed partial class ShardStoresRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ShrinkIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ShrinkIndexRequest.g.cs index 1712f206011..74415c48e3a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ShrinkIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ShrinkIndexRequest.g.cs @@ -32,23 +32,34 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class ShrinkIndexRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Shrinks an existing index into a new index with fewer primary shards. +/// +/// Shrinks an existing index into a new index with fewer primary shards. +/// /// public sealed partial class ShrinkIndexRequest : PlainRequest { @@ -65,38 +76,54 @@ public ShrinkIndexRequest(Elastic.Clients.Elasticsearch.IndexName index, Elastic internal override string OperationName => "indices.shrink"; /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } /// - /// The key is the alias name.
Index alias names support date math. + /// + /// The key is the alias name. + /// Index alias names support date math. + /// /// [JsonInclude, JsonPropertyName("aliases")] public IDictionary? Aliases { get; set; } /// - /// Configuration options for the target index. + /// + /// Configuration options for the target index. + /// /// [JsonInclude, JsonPropertyName("settings")] public IDictionary? Settings { get; set; } } /// -/// Shrinks an existing index into a new index with fewer primary shards. +/// +/// Shrinks an existing index into a new index with fewer primary shards. +/// /// public sealed partial class ShrinkIndexRequestDescriptor : RequestDescriptor, ShrinkIndexRequestParameters> { @@ -134,7 +161,10 @@ public ShrinkIndexRequestDescriptor Target(Elastic.Clients.Elasticsea private IDictionary? SettingsValue { get; set; } /// - /// The key is the alias name.
Index alias names support date math. + /// + /// The key is the alias name. + /// Index alias names support date math. + /// /// public ShrinkIndexRequestDescriptor Aliases(Func>, FluentDescriptorDictionary>> selector) { @@ -143,7 +173,9 @@ public ShrinkIndexRequestDescriptor Aliases(Func - /// Configuration options for the target index. + /// + /// Configuration options for the target index. + /// /// public ShrinkIndexRequestDescriptor Settings(Func, FluentDictionary> selector) { @@ -171,7 +203,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Shrinks an existing index into a new index with fewer primary shards. +/// +/// Shrinks an existing index into a new index with fewer primary shards. +/// /// public sealed partial class ShrinkIndexRequestDescriptor : RequestDescriptor { @@ -209,7 +243,10 @@ public ShrinkIndexRequestDescriptor Target(Elastic.Clients.Elasticsearch.IndexNa private IDictionary? SettingsValue { get; set; } /// - /// The key is the alias name.
Index alias names support date math. + /// + /// The key is the alias name. + /// Index alias names support date math. + /// /// public ShrinkIndexRequestDescriptor Aliases(Func, FluentDescriptorDictionary> selector) { @@ -218,7 +255,9 @@ public ShrinkIndexRequestDescriptor Aliases(Func - /// Configuration options for the target index. + /// + /// Configuration options for the target index. + /// /// public ShrinkIndexRequestDescriptor Settings(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SimulateIndexTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SimulateIndexTemplateRequest.g.cs index 2f66f385148..a45a1e88d7a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SimulateIndexTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SimulateIndexTemplateRequest.g.cs @@ -32,18 +32,25 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class SimulateIndexTemplateRequestParameters : RequestParameters { /// - /// If true, returns all relevant default configurations for the index template. + /// + /// If true, returns all relevant default configurations for the index template. + /// /// public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Simulate an index.
Returns the index configuration that would be applied to the specified index from an existing index template. +/// +/// Simulate an index. +/// Returns the index configuration that would be applied to the specified index from an existing index template. +/// /// public sealed partial class SimulateIndexTemplateRequest : PlainRequest { @@ -60,20 +67,27 @@ public SimulateIndexTemplateRequest(Elastic.Clients.Elasticsearch.Name name) : b internal override string OperationName => "indices.simulate_index_template"; /// - /// If true, returns all relevant default configurations for the index template. + /// + /// If true, returns all relevant default configurations for the index template. + /// /// [JsonIgnore] public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Simulate an index.
Returns the index configuration that would be applied to the specified index from an existing index template. +/// +/// Simulate an index. +/// Returns the index configuration that would be applied to the specified index from an existing index template. +/// /// public sealed partial class SimulateIndexTemplateRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SimulateTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SimulateTemplateRequest.g.cs index 8786cb98dcc..bf03abe9939 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SimulateTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SimulateTemplateRequest.g.cs @@ -32,23 +32,32 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class SimulateTemplateRequestParameters : RequestParameters { /// - /// If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation. + /// + /// If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation. + /// /// public bool? Create { get => Q("create"); set => Q("create", value); } /// - /// If true, returns all relevant default configurations for the index template. + /// + /// If true, returns all relevant default configurations for the index template. + /// /// public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. +/// +/// Simulate an index template. +/// Returns the index configuration that would be applied by a particular index template. +/// /// public sealed partial class SimulateTemplateRequest : PlainRequest { @@ -69,86 +78,129 @@ public SimulateTemplateRequest(Elastic.Clients.Elasticsearch.Name? name) : base( internal override string OperationName => "indices.simulate_template"; /// - /// If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation. + /// + /// If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation. + /// /// [JsonIgnore] public bool? Create { get => Q("create"); set => Q("create", value); } /// - /// If true, returns all relevant default configurations for the index template. + /// + /// If true, returns all relevant default configurations for the index template. + /// /// [JsonIgnore] public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// This setting overrides the value of the `action.auto_create_index` cluster setting.
If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.
If set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + /// + /// This setting overrides the value of the action.auto_create_index cluster setting. + /// If set to true in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via actions.auto_create_index. + /// If set to false, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + /// /// [JsonInclude, JsonPropertyName("allow_auto_create")] public bool? AllowAutoCreate { get; set; } /// - /// An ordered list of component template names.
Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// + /// An ordered list of component template names. + /// Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// /// [JsonInclude, JsonPropertyName("composed_of")] public ICollection? ComposedOf { get; set; } /// - /// If this object is included, the template is used to create data streams and their backing indices.
Supports an empty object.
Data streams require a matching index template with a `data_stream` object. + /// + /// If this object is included, the template is used to create data streams and their backing indices. + /// Supports an empty object. + /// Data streams require a matching index template with a data_stream object. + /// /// [JsonInclude, JsonPropertyName("data_stream")] public Elastic.Clients.Elasticsearch.IndexManagement.DataStreamVisibility? DataStream { get; set; } /// - /// Marks this index template as deprecated. When creating or updating a non-deprecated index template
that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// + /// Marks this index template as deprecated. When creating or updating a non-deprecated index template + /// that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// /// [JsonInclude, JsonPropertyName("deprecated")] public bool? Deprecated { get; set; } /// - /// The configuration option ignore_missing_component_templates can be used when an index template
references a component template that might not exist + /// + /// The configuration option ignore_missing_component_templates can be used when an index template + /// references a component template that might not exist + /// /// [JsonInclude, JsonPropertyName("ignore_missing_component_templates")] public ICollection? IgnoreMissingComponentTemplates { get; set; } /// - /// Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation. + /// + /// Array of wildcard (*) expressions used to match the names of data streams and indices during creation. + /// /// [JsonInclude, JsonPropertyName("index_patterns")] public Elastic.Clients.Elasticsearch.Indices? IndexPatterns { get; set; } /// - /// Optional user metadata about the index template.
May have any contents.
This map is not automatically generated by Elasticsearch. + /// + /// Optional user metadata about the index template. + /// May have any contents. + /// This map is not automatically generated by Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("_meta")] public IDictionary? Meta { get; set; } /// - /// Priority to determine index template precedence when a new data stream or index is created.
The index template with the highest priority is chosen.
If no priority is specified the template is treated as though it is of priority 0 (lowest priority).
This number is not automatically generated by Elasticsearch. + /// + /// Priority to determine index template precedence when a new data stream or index is created. + /// The index template with the highest priority is chosen. + /// If no priority is specified the template is treated as though it is of priority 0 (lowest priority). + /// This number is not automatically generated by Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("priority")] public long? Priority { get; set; } /// - /// Template to be applied.
It may optionally include an `aliases`, `mappings`, or `settings` configuration. + /// + /// Template to be applied. + /// It may optionally include an aliases, mappings, or settings configuration. + /// /// [JsonInclude, JsonPropertyName("template")] public Elastic.Clients.Elasticsearch.IndexManagement.IndexTemplateMapping? Template { get; set; } /// - /// Version number used to manage index templates externally.
This number is not automatically generated by Elasticsearch. + /// + /// Version number used to manage index templates externally. + /// This number is not automatically generated by Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("version")] public long? Version { get; set; } } /// -/// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. +/// +/// Simulate an index template. +/// Returns the index configuration that would be applied by a particular index template. +/// /// public sealed partial class SimulateTemplateRequestDescriptor : RequestDescriptor, SimulateTemplateRequestParameters> { @@ -196,7 +248,11 @@ public SimulateTemplateRequestDescriptor Name(Elastic.Clients.Elastic private long? VersionValue { get; set; } /// - /// This setting overrides the value of the `action.auto_create_index` cluster setting.
If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.
If set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + /// + /// This setting overrides the value of the action.auto_create_index cluster setting. + /// If set to true in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via actions.auto_create_index. + /// If set to false, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + /// /// public SimulateTemplateRequestDescriptor AllowAutoCreate(bool? allowAutoCreate = true) { @@ -205,7 +261,10 @@ public SimulateTemplateRequestDescriptor AllowAutoCreate(bool? allowA } /// - /// An ordered list of component template names.
Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// + /// An ordered list of component template names. + /// Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// /// public SimulateTemplateRequestDescriptor ComposedOf(ICollection? composedOf) { @@ -214,7 +273,11 @@ public SimulateTemplateRequestDescriptor ComposedOf(ICollection - /// If this object is included, the template is used to create data streams and their backing indices.
Supports an empty object.
Data streams require a matching index template with a `data_stream` object. + /// + /// If this object is included, the template is used to create data streams and their backing indices. + /// Supports an empty object. + /// Data streams require a matching index template with a data_stream object. + /// /// public SimulateTemplateRequestDescriptor DataStream(Elastic.Clients.Elasticsearch.IndexManagement.DataStreamVisibility? dataStream) { @@ -241,7 +304,10 @@ public SimulateTemplateRequestDescriptor DataStream(Action - /// Marks this index template as deprecated. When creating or updating a non-deprecated index template
that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// + /// Marks this index template as deprecated. When creating or updating a non-deprecated index template + /// that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// /// public SimulateTemplateRequestDescriptor Deprecated(bool? deprecated = true) { @@ -250,7 +316,10 @@ public SimulateTemplateRequestDescriptor Deprecated(bool? deprecated } /// - /// The configuration option ignore_missing_component_templates can be used when an index template
references a component template that might not exist + /// + /// The configuration option ignore_missing_component_templates can be used when an index template + /// references a component template that might not exist + /// /// public SimulateTemplateRequestDescriptor IgnoreMissingComponentTemplates(ICollection? ignoreMissingComponentTemplates) { @@ -259,7 +328,9 @@ public SimulateTemplateRequestDescriptor IgnoreMissingComponentTempla } /// - /// Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation. + /// + /// Array of wildcard (*) expressions used to match the names of data streams and indices during creation. + /// /// public SimulateTemplateRequestDescriptor IndexPatterns(Elastic.Clients.Elasticsearch.Indices? indexPatterns) { @@ -268,7 +339,11 @@ public SimulateTemplateRequestDescriptor IndexPatterns(Elastic.Client } /// - /// Optional user metadata about the index template.
May have any contents.
This map is not automatically generated by Elasticsearch. + /// + /// Optional user metadata about the index template. + /// May have any contents. + /// This map is not automatically generated by Elasticsearch. + /// /// public SimulateTemplateRequestDescriptor Meta(Func, FluentDictionary> selector) { @@ -277,7 +352,12 @@ public SimulateTemplateRequestDescriptor Meta(Func - /// Priority to determine index template precedence when a new data stream or index is created.
The index template with the highest priority is chosen.
If no priority is specified the template is treated as though it is of priority 0 (lowest priority).
This number is not automatically generated by Elasticsearch. + /// + /// Priority to determine index template precedence when a new data stream or index is created. + /// The index template with the highest priority is chosen. + /// If no priority is specified the template is treated as though it is of priority 0 (lowest priority). + /// This number is not automatically generated by Elasticsearch. + /// /// public SimulateTemplateRequestDescriptor Priority(long? priority) { @@ -286,7 +366,10 @@ public SimulateTemplateRequestDescriptor Priority(long? priority) } /// - /// Template to be applied.
It may optionally include an `aliases`, `mappings`, or `settings` configuration. + /// + /// Template to be applied. + /// It may optionally include an aliases, mappings, or settings configuration. + /// /// public SimulateTemplateRequestDescriptor Template(Elastic.Clients.Elasticsearch.IndexManagement.IndexTemplateMapping? template) { @@ -313,7 +396,10 @@ public SimulateTemplateRequestDescriptor Template(Action - /// Version number used to manage index templates externally.
This number is not automatically generated by Elasticsearch. + /// + /// Version number used to manage index templates externally. + /// This number is not automatically generated by Elasticsearch. + /// /// public SimulateTemplateRequestDescriptor Version(long? version) { @@ -409,7 +495,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. +/// +/// Simulate an index template. +/// Returns the index configuration that would be applied by a particular index template. +/// /// public sealed partial class SimulateTemplateRequestDescriptor : RequestDescriptor { @@ -457,7 +546,11 @@ public SimulateTemplateRequestDescriptor Name(Elastic.Clients.Elasticsearch.Name private long? VersionValue { get; set; } /// - /// This setting overrides the value of the `action.auto_create_index` cluster setting.
If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.
If set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + /// + /// This setting overrides the value of the action.auto_create_index cluster setting. + /// If set to true in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via actions.auto_create_index. + /// If set to false, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + /// /// public SimulateTemplateRequestDescriptor AllowAutoCreate(bool? allowAutoCreate = true) { @@ -466,7 +559,10 @@ public SimulateTemplateRequestDescriptor AllowAutoCreate(bool? allowAutoCreate = } /// - /// An ordered list of component template names.
Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// + /// An ordered list of component template names. + /// Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// /// public SimulateTemplateRequestDescriptor ComposedOf(ICollection? composedOf) { @@ -475,7 +571,11 @@ public SimulateTemplateRequestDescriptor ComposedOf(ICollection - /// If this object is included, the template is used to create data streams and their backing indices.
Supports an empty object.
Data streams require a matching index template with a `data_stream` object. + /// + /// If this object is included, the template is used to create data streams and their backing indices. + /// Supports an empty object. + /// Data streams require a matching index template with a data_stream object. + /// /// public SimulateTemplateRequestDescriptor DataStream(Elastic.Clients.Elasticsearch.IndexManagement.DataStreamVisibility? dataStream) { @@ -502,7 +602,10 @@ public SimulateTemplateRequestDescriptor DataStream(Action - /// Marks this index template as deprecated. When creating or updating a non-deprecated index template
that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// + /// Marks this index template as deprecated. When creating or updating a non-deprecated index template + /// that uses deprecated components, Elasticsearch will emit a deprecation warning. + /// /// public SimulateTemplateRequestDescriptor Deprecated(bool? deprecated = true) { @@ -511,7 +614,10 @@ public SimulateTemplateRequestDescriptor Deprecated(bool? deprecated = true) } /// - /// The configuration option ignore_missing_component_templates can be used when an index template
references a component template that might not exist + /// + /// The configuration option ignore_missing_component_templates can be used when an index template + /// references a component template that might not exist + /// /// public SimulateTemplateRequestDescriptor IgnoreMissingComponentTemplates(ICollection? ignoreMissingComponentTemplates) { @@ -520,7 +626,9 @@ public SimulateTemplateRequestDescriptor IgnoreMissingComponentTemplates(ICollec } /// - /// Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation. + /// + /// Array of wildcard (*) expressions used to match the names of data streams and indices during creation. + /// /// public SimulateTemplateRequestDescriptor IndexPatterns(Elastic.Clients.Elasticsearch.Indices? indexPatterns) { @@ -529,7 +637,11 @@ public SimulateTemplateRequestDescriptor IndexPatterns(Elastic.Clients.Elasticse } /// - /// Optional user metadata about the index template.
May have any contents.
This map is not automatically generated by Elasticsearch. + /// + /// Optional user metadata about the index template. + /// May have any contents. + /// This map is not automatically generated by Elasticsearch. + /// /// public SimulateTemplateRequestDescriptor Meta(Func, FluentDictionary> selector) { @@ -538,7 +650,12 @@ public SimulateTemplateRequestDescriptor Meta(Func - /// Priority to determine index template precedence when a new data stream or index is created.
The index template with the highest priority is chosen.
If no priority is specified the template is treated as though it is of priority 0 (lowest priority).
This number is not automatically generated by Elasticsearch. + /// + /// Priority to determine index template precedence when a new data stream or index is created. + /// The index template with the highest priority is chosen. + /// If no priority is specified the template is treated as though it is of priority 0 (lowest priority). + /// This number is not automatically generated by Elasticsearch. + /// /// public SimulateTemplateRequestDescriptor Priority(long? priority) { @@ -547,7 +664,10 @@ public SimulateTemplateRequestDescriptor Priority(long? priority) } /// - /// Template to be applied.
It may optionally include an `aliases`, `mappings`, or `settings` configuration. + /// + /// Template to be applied. + /// It may optionally include an aliases, mappings, or settings configuration. + /// /// public SimulateTemplateRequestDescriptor Template(Elastic.Clients.Elasticsearch.IndexManagement.IndexTemplateMapping? template) { @@ -574,7 +694,10 @@ public SimulateTemplateRequestDescriptor Template(Action - /// Version number used to manage index templates externally.
This number is not automatically generated by Elasticsearch. + /// + /// Version number used to manage index templates externally. + /// This number is not automatically generated by Elasticsearch. + /// /// public SimulateTemplateRequestDescriptor Version(long? version) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SplitIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SplitIndexRequest.g.cs index a48971cb076..18d894522d7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SplitIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SplitIndexRequest.g.cs @@ -32,23 +32,34 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class SplitIndexRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Splits an existing index into a new index with more primary shards. +/// +/// Splits an existing index into a new index with more primary shards. +/// /// public sealed partial class SplitIndexRequest : PlainRequest { @@ -65,38 +76,53 @@ public SplitIndexRequest(Elastic.Clients.Elasticsearch.IndexName index, Elastic. internal override string OperationName => "indices.split"; /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } /// - /// Aliases for the resulting index. + /// + /// Aliases for the resulting index. + /// /// [JsonInclude, JsonPropertyName("aliases")] public IDictionary? Aliases { get; set; } /// - /// Configuration options for the target index. + /// + /// Configuration options for the target index. + /// /// [JsonInclude, JsonPropertyName("settings")] public IDictionary? Settings { get; set; } } /// -/// Splits an existing index into a new index with more primary shards. +/// +/// Splits an existing index into a new index with more primary shards. +/// /// public sealed partial class SplitIndexRequestDescriptor : RequestDescriptor, SplitIndexRequestParameters> { @@ -134,7 +160,9 @@ public SplitIndexRequestDescriptor Target(Elastic.Clients.Elasticsear private IDictionary? SettingsValue { get; set; } /// - /// Aliases for the resulting index. + /// + /// Aliases for the resulting index. + /// /// public SplitIndexRequestDescriptor Aliases(Func>, FluentDescriptorDictionary>> selector) { @@ -143,7 +171,9 @@ public SplitIndexRequestDescriptor Aliases(Func - /// Configuration options for the target index. + /// + /// Configuration options for the target index. + /// /// public SplitIndexRequestDescriptor Settings(Func, FluentDictionary> selector) { @@ -171,7 +201,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Splits an existing index into a new index with more primary shards. +/// +/// Splits an existing index into a new index with more primary shards. +/// /// public sealed partial class SplitIndexRequestDescriptor : RequestDescriptor { @@ -209,7 +241,9 @@ public SplitIndexRequestDescriptor Target(Elastic.Clients.Elasticsearch.IndexNam private IDictionary? SettingsValue { get; set; } /// - /// Aliases for the resulting index. + /// + /// Aliases for the resulting index. + /// /// public SplitIndexRequestDescriptor Aliases(Func, FluentDescriptorDictionary> selector) { @@ -218,7 +252,9 @@ public SplitIndexRequestDescriptor Aliases(Func - /// Configuration options for the target index. + /// + /// Configuration options for the target index. + /// /// public SplitIndexRequestDescriptor Settings(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/UpdateAliasesRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/UpdateAliasesRequest.g.cs index fdbc3e16e65..bcfebd4b591 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/UpdateAliasesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/UpdateAliasesRequest.g.cs @@ -32,18 +32,27 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class UpdateAliasesRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Create or update an alias.
Adds a data stream or index to an alias. +/// +/// Create or update an alias. +/// Adds a data stream or index to an alias. +/// /// public sealed partial class UpdateAliasesRequest : PlainRequest { @@ -56,26 +65,37 @@ public sealed partial class UpdateAliasesRequest : PlainRequest "indices.update_aliases"; /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Actions to perform. + /// + /// Actions to perform. + /// /// [JsonInclude, JsonPropertyName("actions")] public ICollection? Actions { get; set; } } /// -/// Create or update an alias.
Adds a data stream or index to an alias. +/// +/// Create or update an alias. +/// Adds a data stream or index to an alias. +/// /// public sealed partial class UpdateAliasesRequestDescriptor : RequestDescriptor, UpdateAliasesRequestParameters> { @@ -102,7 +122,9 @@ public UpdateAliasesRequestDescriptor() private Action>[] ActionsDescriptorActions { get; set; } /// - /// Actions to perform. + /// + /// Actions to perform. + /// /// public UpdateAliasesRequestDescriptor Actions(ICollection? actions) { @@ -179,7 +201,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Create or update an alias.
Adds a data stream or index to an alias. +/// +/// Create or update an alias. +/// Adds a data stream or index to an alias. +/// /// public sealed partial class UpdateAliasesRequestDescriptor : RequestDescriptor { @@ -206,7 +231,9 @@ public UpdateAliasesRequestDescriptor() private Action[] ActionsDescriptorActions { get; set; } /// - /// Actions to perform. + /// + /// Actions to perform. + /// /// public UpdateAliasesRequestDescriptor Actions(ICollection? actions) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/UpdateAliasesResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/UpdateAliasesResponse.g.cs index e0ab1fe35eb..5b7fd8e987a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/UpdateAliasesResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/UpdateAliasesResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class UpdateAliasesResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ValidateQueryRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ValidateQueryRequest.g.cs index 3563606e4fa..7f64b2e0edf 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ValidateQueryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ValidateQueryRequest.g.cs @@ -32,68 +32,101 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class ValidateQueryRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// If `true`, the validation is executed on all shards instead of one random shard per index. + /// + /// If true, the validation is executed on all shards instead of one random shard per index. + /// /// public bool? AllShards { get => Q("all_shards"); set => Q("all_shards", value); } /// - /// Analyzer to use for the query string.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// Analyzer to use for the query string. + /// This parameter can only be used when the q query string parameter is specified. + /// /// public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// - /// If `true`, wildcard and prefix queries are analyzed. + /// + /// If true, wildcard and prefix queries are analyzed. + /// /// public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } /// - /// The default operator for query string query: `AND` or `OR`. + /// + /// The default operator for query string query: AND or OR. + /// /// public Elastic.Clients.Elasticsearch.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } /// - /// Field to use as default where no field prefix is given in the query string.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// Field to use as default where no field prefix is given in the query string. + /// This parameter can only be used when the q query string parameter is specified. + /// /// public string? Df { get => Q("df"); set => Q("df", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, the response returns detailed information if an error has occurred. + /// + /// If true, the response returns detailed information if an error has occurred. + /// /// public bool? Explain { get => Q("explain"); set => Q("explain", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// + /// If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// /// public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// - /// Query in the Lucene query string syntax. + /// + /// Query in the Lucene query string syntax. + /// /// public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } /// - /// If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed. + /// + /// If true, returns a more detailed explanation showing the actual Lucene query that will be executed. + /// /// public bool? Rewrite { get => Q("rewrite"); set => Q("rewrite", value); } } /// -/// Validate a query.
Validates a query without running it. +/// +/// Validate a query. +/// Validates a query without running it. +/// /// public sealed partial class ValidateQueryRequest : PlainRequest { @@ -114,86 +147,121 @@ public ValidateQueryRequest(Elastic.Clients.Elasticsearch.Indices? indices) : ba internal override string OperationName => "indices.validate_query"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// If `true`, the validation is executed on all shards instead of one random shard per index. + /// + /// If true, the validation is executed on all shards instead of one random shard per index. + /// /// [JsonIgnore] public bool? AllShards { get => Q("all_shards"); set => Q("all_shards", value); } /// - /// Analyzer to use for the query string.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// Analyzer to use for the query string. + /// This parameter can only be used when the q query string parameter is specified. + /// /// [JsonIgnore] public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// - /// If `true`, wildcard and prefix queries are analyzed. + /// + /// If true, wildcard and prefix queries are analyzed. + /// /// [JsonIgnore] public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } /// - /// The default operator for query string query: `AND` or `OR`. + /// + /// The default operator for query string query: AND or OR. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } /// - /// Field to use as default where no field prefix is given in the query string.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// Field to use as default where no field prefix is given in the query string. + /// This parameter can only be used when the q query string parameter is specified. + /// /// [JsonIgnore] public string? Df { get => Q("df"); set => Q("df", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, the response returns detailed information if an error has occurred. + /// + /// If true, the response returns detailed information if an error has occurred. + /// /// [JsonIgnore] public bool? Explain { get => Q("explain"); set => Q("explain", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// + /// If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// /// [JsonIgnore] public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// - /// Query in the Lucene query string syntax. + /// + /// Query in the Lucene query string syntax. + /// /// [JsonIgnore] public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } /// - /// If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed. + /// + /// If true, returns a more detailed explanation showing the actual Lucene query that will be executed. + /// /// [JsonIgnore] public bool? Rewrite { get => Q("rewrite"); set => Q("rewrite", value); } /// - /// Query in the Lucene query string syntax. + /// + /// Query in the Lucene query string syntax. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Query { get; set; } } /// -/// Validate a query.
Validates a query without running it. +/// +/// Validate a query. +/// Validates a query without running it. +/// /// public sealed partial class ValidateQueryRequestDescriptor : RequestDescriptor, ValidateQueryRequestParameters> { @@ -239,7 +307,9 @@ public ValidateQueryRequestDescriptor Indices(Elastic.Clients.Elastic private Action> QueryDescriptorAction { get; set; } /// - /// Query in the Lucene query string syntax. + /// + /// Query in the Lucene query string syntax. + /// /// public ValidateQueryRequestDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -289,7 +359,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Validate a query.
Validates a query without running it. +/// +/// Validate a query. +/// Validates a query without running it. +/// /// public sealed partial class ValidateQueryRequestDescriptor : RequestDescriptor { @@ -335,7 +408,9 @@ public ValidateQueryRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indi private Action QueryDescriptorAction { get; set; } /// - /// Query in the Lucene query string syntax. + /// + /// Query in the Lucene query string syntax. + /// /// public ValidateQueryRequestDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexRequest.g.cs index 02ef796bac8..16aa975658b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexRequest.g.cs @@ -32,63 +32,99 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class IndexRequestParameters : RequestParameters { /// - /// Only perform the operation if the document has this primary term. + /// + /// Only perform the operation if the document has this primary term. + /// /// public long? IfPrimaryTerm { get => Q("if_primary_term"); set => Q("if_primary_term", value); } /// - /// Only perform the operation if the document has this sequence number. + /// + /// Only perform the operation if the document has this sequence number. + /// /// public long? IfSeqNo { get => Q("if_seq_no"); set => Q("if_seq_no", value); } /// - /// Set to create to only index the document if it does not already exist (put if absent).
If a document with the specified `_id` already exists, the indexing operation will fail.
Same as using the `/_create` endpoint.
Valid values: `index`, `create`.
If document id is specified, it defaults to `index`.
Otherwise, it defaults to `create`. + /// + /// Set to create to only index the document if it does not already exist (put if absent). + /// If a document with the specified _id already exists, the indexing operation will fail. + /// Same as using the <index>/_create endpoint. + /// Valid values: index, create. + /// If document id is specified, it defaults to index. + /// Otherwise, it defaults to create. + /// /// public Elastic.Clients.Elasticsearch.OpType? OpType { get => Q("op_type"); set => Q("op_type", value); } /// - /// ID of the pipeline to use to preprocess incoming documents.
If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.
If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// + /// ID of the pipeline to use to preprocess incoming documents. + /// If the index has a default ingest pipeline specified, then setting the value to _none disables the default ingest pipeline for this request. + /// If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// /// public string? Pipeline { get => Q("pipeline"); set => Q("pipeline", value); } /// - /// If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.
Valid values: `true`, `false`, `wait_for`. + /// + /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false do nothing with refreshes. + /// Valid values: true, false, wait_for. + /// /// public Elastic.Clients.Elasticsearch.Refresh? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// If `true`, the destination must be an index alias. + /// + /// If true, the destination must be an index alias. + /// /// public bool? RequireAlias { get => Q("require_alias"); set => Q("require_alias", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. + /// + /// Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Explicit version number for concurrency control.
The specified version must match the current version of the document for the request to succeed. + /// + /// Explicit version number for concurrency control. + /// The specified version must match the current version of the document for the request to succeed. + /// /// public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type: `external`, `external_gte`. + /// + /// Specific version type: external, external_gte. + /// /// public Elastic.Clients.Elasticsearch.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. +/// +/// Index a document. +/// Adds a JSON document to the specified data stream or index and makes it searchable. +/// If the target is an index and the document already exists, the request updates the document and increments its version. +/// /// public sealed partial class IndexRequest : PlainRequest, ISelfSerializable { @@ -109,67 +145,99 @@ public IndexRequest(Elastic.Clients.Elasticsearch.IndexName index) : base(r => r internal override string OperationName => "index"; /// - /// Only perform the operation if the document has this primary term. + /// + /// Only perform the operation if the document has this primary term. + /// /// [JsonIgnore] public long? IfPrimaryTerm { get => Q("if_primary_term"); set => Q("if_primary_term", value); } /// - /// Only perform the operation if the document has this sequence number. + /// + /// Only perform the operation if the document has this sequence number. + /// /// [JsonIgnore] public long? IfSeqNo { get => Q("if_seq_no"); set => Q("if_seq_no", value); } /// - /// Set to create to only index the document if it does not already exist (put if absent).
If a document with the specified `_id` already exists, the indexing operation will fail.
Same as using the `/_create` endpoint.
Valid values: `index`, `create`.
If document id is specified, it defaults to `index`.
Otherwise, it defaults to `create`. + /// + /// Set to create to only index the document if it does not already exist (put if absent). + /// If a document with the specified _id already exists, the indexing operation will fail. + /// Same as using the <index>/_create endpoint. + /// Valid values: index, create. + /// If document id is specified, it defaults to index. + /// Otherwise, it defaults to create. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.OpType? OpType { get => Q("op_type"); set => Q("op_type", value); } /// - /// ID of the pipeline to use to preprocess incoming documents.
If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.
If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// + /// ID of the pipeline to use to preprocess incoming documents. + /// If the index has a default ingest pipeline specified, then setting the value to _none disables the default ingest pipeline for this request. + /// If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// /// [JsonIgnore] public string? Pipeline { get => Q("pipeline"); set => Q("pipeline", value); } /// - /// If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.
Valid values: `true`, `false`, `wait_for`. + /// + /// If true, Elasticsearch refreshes the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false do nothing with refreshes. + /// Valid values: true, false, wait_for. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Refresh? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// If `true`, the destination must be an index alias. + /// + /// If true, the destination must be an index alias. + /// /// [JsonIgnore] public bool? RequireAlias { get => Q("require_alias"); set => Q("require_alias", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. + /// + /// Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Explicit version number for concurrency control.
The specified version must match the current version of the document for the request to succeed. + /// + /// Explicit version number for concurrency control. + /// The specified version must match the current version of the document for the request to succeed. + /// /// [JsonIgnore] public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type: `external`, `external_gte`. + /// + /// Specific version type: external, external_gte. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } @@ -183,7 +251,11 @@ void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions op } /// -/// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. +/// +/// Index a document. +/// Adds a JSON document to the specified data stream or index and makes it searchable. +/// If the target is an index and the document already exists, the request updates the document and increments its version. +/// /// public sealed partial class IndexRequestDescriptor : RequestDescriptor, IndexRequestParameters> { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Inference/DeleteInferenceRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Inference/DeleteInferenceRequest.g.cs index 1789b42921a..b9355fd78ad 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Inference/DeleteInferenceRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Inference/DeleteInferenceRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.Inference; public sealed partial class DeleteInferenceRequestParameters : RequestParameters { /// - /// When true, the endpoint is not deleted, and a list of ingest processors which reference this endpoint is returned + /// + /// When true, the endpoint is not deleted, and a list of ingest processors which reference this endpoint is returned + /// /// public bool? DryRun { get => Q("dry_run"); set => Q("dry_run", value); } /// - /// When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields + /// + /// When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields + /// /// public bool? Force { get => Q("force"); set => Q("force", value); } } /// -/// Delete an inference endpoint +/// +/// Delete an inference endpoint +/// /// public sealed partial class DeleteInferenceRequest : PlainRequest { @@ -64,20 +70,26 @@ public DeleteInferenceRequest(Elastic.Clients.Elasticsearch.Inference.TaskType? internal override string OperationName => "inference.delete"; /// - /// When true, the endpoint is not deleted, and a list of ingest processors which reference this endpoint is returned + /// + /// When true, the endpoint is not deleted, and a list of ingest processors which reference this endpoint is returned + /// /// [JsonIgnore] public bool? DryRun { get => Q("dry_run"); set => Q("dry_run", value); } /// - /// When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields + /// + /// When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields + /// /// [JsonIgnore] public bool? Force { get => Q("force"); set => Q("force", value); } } /// -/// Delete an inference endpoint +/// +/// Delete an inference endpoint +/// /// public sealed partial class DeleteInferenceRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Inference/DeleteInferenceResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Inference/DeleteInferenceResponse.g.cs index 98fe1534228..2e7e80f69d3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Inference/DeleteInferenceResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Inference/DeleteInferenceResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Inference; public sealed partial class DeleteInferenceResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Inference/GetInferenceRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Inference/GetInferenceRequest.g.cs index 21c2cfb89b8..d07d70e93b6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Inference/GetInferenceRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Inference/GetInferenceRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class GetInferenceRequestParameters : RequestParameters } /// -/// Get an inference endpoint +/// +/// Get an inference endpoint +/// /// public sealed partial class GetInferenceRequest : PlainRequest { @@ -60,7 +62,9 @@ public GetInferenceRequest(Elastic.Clients.Elasticsearch.Inference.TaskType? tas } /// -/// Get an inference endpoint +/// +/// Get an inference endpoint +/// /// public sealed partial class GetInferenceRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Inference/InferenceRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Inference/InferenceRequest.g.cs index 8c5c67af808..4f72aaacdfe 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Inference/InferenceRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Inference/InferenceRequest.g.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch.Inference; public sealed partial class InferenceRequestParameters : RequestParameters { /// - /// Specifies the amount of time to wait for the inference request to complete. + /// + /// Specifies the amount of time to wait for the inference request to complete. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Perform inference on the service +/// +/// Perform inference on the service +/// /// public sealed partial class InferenceRequest : PlainRequest { @@ -59,33 +63,45 @@ public InferenceRequest(Elastic.Clients.Elasticsearch.Inference.TaskType? taskTy internal override string OperationName => "inference.inference"; /// - /// Specifies the amount of time to wait for the inference request to complete. + /// + /// Specifies the amount of time to wait for the inference request to complete. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Inference input.
Either a string or an array of strings. + /// + /// Inference input. + /// Either a string or an array of strings. + /// /// [JsonInclude, JsonPropertyName("input")] [SingleOrManyCollectionConverter(typeof(string))] public ICollection Input { get; set; } /// - /// Query input, required for rerank task.
Not required for other tasks. + /// + /// Query input, required for rerank task. + /// Not required for other tasks. + /// /// [JsonInclude, JsonPropertyName("query")] public string? Query { get; set; } /// - /// Optional task settings + /// + /// Optional task settings + /// /// [JsonInclude, JsonPropertyName("task_settings")] public object? TaskSettings { get; set; } } /// -/// Perform inference on the service +/// +/// Perform inference on the service +/// /// public sealed partial class InferenceRequestDescriptor : RequestDescriptor { @@ -126,7 +142,10 @@ public InferenceRequestDescriptor TaskType(Elastic.Clients.Elasticsearch.Inferen private object? TaskSettingsValue { get; set; } /// - /// Inference input.
Either a string or an array of strings. + /// + /// Inference input. + /// Either a string or an array of strings. + /// /// public InferenceRequestDescriptor Input(ICollection input) { @@ -135,7 +154,10 @@ public InferenceRequestDescriptor Input(ICollection input) } /// - /// Query input, required for rerank task.
Not required for other tasks. + /// + /// Query input, required for rerank task. + /// Not required for other tasks. + /// /// public InferenceRequestDescriptor Query(string? query) { @@ -144,7 +166,9 @@ public InferenceRequestDescriptor Query(string? query) } /// - /// Optional task settings + /// + /// Optional task settings + /// /// public InferenceRequestDescriptor TaskSettings(object? taskSettings) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Inference/PutInferenceRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Inference/PutInferenceRequest.g.cs index e69e17d4cbe..6604bc0e8a1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Inference/PutInferenceRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Inference/PutInferenceRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class PutInferenceRequestParameters : RequestParameters } /// -/// Create an inference endpoint +/// +/// Create an inference endpoint +/// /// public sealed partial class PutInferenceRequest : PlainRequest, ISelfSerializable { @@ -64,7 +66,9 @@ void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions op } /// -/// Create an inference endpoint +/// +/// Create an inference endpoint +/// /// public sealed partial class PutInferenceRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Inference/PutInferenceResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Inference/PutInferenceResponse.g.cs index dc6a5867f96..f4c2535f6da 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Inference/PutInferenceResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Inference/PutInferenceResponse.g.cs @@ -29,31 +29,41 @@ namespace Elastic.Clients.Elasticsearch.Inference; public sealed partial class PutInferenceResponse : ElasticsearchResponse { /// - /// The inference Id + /// + /// The inference Id + /// /// [JsonInclude, JsonPropertyName("inference_id")] public string InferenceId { get; init; } /// - /// The service type + /// + /// The service type + /// /// [JsonInclude, JsonPropertyName("service")] public string Service { get; init; } /// - /// Settings specific to the service + /// + /// Settings specific to the service + /// /// [JsonInclude, JsonPropertyName("service_settings")] public object ServiceSettings { get; init; } /// - /// Task settings specific to the service and task type + /// + /// Task settings specific to the service and task type + /// /// [JsonInclude, JsonPropertyName("task_settings")] public object TaskSettings { get; init; } /// - /// The task type + /// + /// The task type + /// /// [JsonInclude, JsonPropertyName("task_type")] public Elastic.Clients.Elasticsearch.Inference.TaskType TaskType { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/InfoRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/InfoRequest.g.cs index 2b74fd663ba..5431bddec4b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/InfoRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/InfoRequest.g.cs @@ -34,7 +34,10 @@ public sealed partial class InfoRequestParameters : RequestParameters } /// -/// Get cluster info.
Returns basic information about the cluster. +/// +/// Get cluster info. +/// Returns basic information about the cluster. +/// /// public sealed partial class InfoRequest : PlainRequest { @@ -48,7 +51,10 @@ public sealed partial class InfoRequest : PlainRequest } /// -/// Get cluster info.
Returns basic information about the cluster. +/// +/// Get cluster info. +/// Returns basic information about the cluster. +/// /// public sealed partial class InfoRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/DeletePipelineRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/DeletePipelineRequest.g.cs index 72398cb5ee5..9aa43b44c66 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/DeletePipelineRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/DeletePipelineRequest.g.cs @@ -32,18 +32,26 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class DeletePipelineRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Deletes one or more existing ingest pipeline. +/// +/// Deletes one or more existing ingest pipeline. +/// /// public sealed partial class DeletePipelineRequest : PlainRequest { @@ -60,20 +68,28 @@ public DeletePipelineRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r. internal override string OperationName => "ingest.delete_pipeline"; /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Deletes one or more existing ingest pipeline. +/// +/// Deletes one or more existing ingest pipeline. +/// /// public sealed partial class DeletePipelineRequestDescriptor : RequestDescriptor, DeletePipelineRequestParameters> { @@ -106,7 +122,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Deletes one or more existing ingest pipeline. +/// +/// Deletes one or more existing ingest pipeline. +/// /// public sealed partial class DeletePipelineRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/DeletePipelineResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/DeletePipelineResponse.g.cs index 96935c5a750..a56624fd181 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/DeletePipelineResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/DeletePipelineResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class DeletePipelineResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GeoIpStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GeoIpStatsRequest.g.cs index 6ab0906acc3..bac9924090f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GeoIpStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GeoIpStatsRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class GeoIpStatsRequestParameters : RequestParameters } /// -/// Gets download statistics for GeoIP2 databases used with the geoip processor. +/// +/// Gets download statistics for GeoIP2 databases used with the geoip processor. +/// /// public sealed partial class GeoIpStatsRequest : PlainRequest { @@ -48,7 +50,9 @@ public sealed partial class GeoIpStatsRequest : PlainRequest -/// Gets download statistics for GeoIP2 databases used with the geoip processor. +/// +/// Gets download statistics for GeoIP2 databases used with the geoip processor. +/// /// public sealed partial class GeoIpStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GeoIpStatsResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GeoIpStatsResponse.g.cs index f502707ac22..dc229b51599 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GeoIpStatsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GeoIpStatsResponse.g.cs @@ -29,13 +29,17 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class GeoIpStatsResponse : ElasticsearchResponse { /// - /// Downloaded GeoIP2 databases for each node. + /// + /// Downloaded GeoIP2 databases for each node. + /// /// [JsonInclude, JsonPropertyName("nodes")] public IReadOnlyDictionary Nodes { get; init; } /// - /// Download statistics for all GeoIP2 databases. + /// + /// Download statistics for all GeoIP2 databases. + /// /// [JsonInclude, JsonPropertyName("stats")] public Elastic.Clients.Elasticsearch.Ingest.GeoIpDownloadStatistics Stats { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GetPipelineRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GetPipelineRequest.g.cs index 8c361a3306d..9f1c59e5a19 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GetPipelineRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GetPipelineRequest.g.cs @@ -32,18 +32,26 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class GetPipelineRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Return pipelines without their definitions (default: false) + /// + /// Return pipelines without their definitions (default: false) + /// /// public bool? Summary { get => Q("summary"); set => Q("summary", value); } } /// -/// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. +/// +/// Returns information about one or more ingest pipelines. +/// This API returns a local reference of the pipeline. +/// /// public sealed partial class GetPipelineRequest : PlainRequest { @@ -64,20 +72,28 @@ public GetPipelineRequest(Elastic.Clients.Elasticsearch.Id? id) : base(r => r.Op internal override string OperationName => "ingest.get_pipeline"; /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Return pipelines without their definitions (default: false) + /// + /// Return pipelines without their definitions (default: false) + /// /// [JsonIgnore] public bool? Summary { get => Q("summary"); set => Q("summary", value); } } /// -/// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. +/// +/// Returns information about one or more ingest pipelines. +/// This API returns a local reference of the pipeline. +/// /// public sealed partial class GetPipelineRequestDescriptor : RequestDescriptor, GetPipelineRequestParameters> { @@ -114,7 +130,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. +/// +/// Returns information about one or more ingest pipelines. +/// This API returns a local reference of the pipeline. +/// /// public sealed partial class GetPipelineRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/ProcessorGrokRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/ProcessorGrokRequest.g.cs index 3915afada9d..f1a27f9360a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/ProcessorGrokRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/ProcessorGrokRequest.g.cs @@ -34,7 +34,11 @@ public sealed partial class ProcessorGrokRequestParameters : RequestParameters } /// -/// Extracts structured fields out of a single text field within a document.
You choose which field to extract matched fields from, as well as the grok pattern you expect will match.
A grok pattern is like a regular expression that supports aliased expressions that can be reused. +/// +/// Extracts structured fields out of a single text field within a document. +/// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. +/// A grok pattern is like a regular expression that supports aliased expressions that can be reused. +/// /// public sealed partial class ProcessorGrokRequest : PlainRequest { @@ -48,7 +52,11 @@ public sealed partial class ProcessorGrokRequest : PlainRequest -/// Extracts structured fields out of a single text field within a document.
You choose which field to extract matched fields from, as well as the grok pattern you expect will match.
A grok pattern is like a regular expression that supports aliased expressions that can be reused. +/// +/// Extracts structured fields out of a single text field within a document. +/// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. +/// A grok pattern is like a regular expression that supports aliased expressions that can be reused. +/// /// public sealed partial class ProcessorGrokRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/PutPipelineRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/PutPipelineRequest.g.cs index 0f8b422897b..acbda2c17ac 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/PutPipelineRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/PutPipelineRequest.g.cs @@ -32,23 +32,32 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class PutPipelineRequestParameters : RequestParameters { /// - /// Required version for optimistic concurrency control for pipeline updates + /// + /// Required version for optimistic concurrency control for pipeline updates + /// /// public long? IfVersion { get => Q("if_version"); set => Q("if_version", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Creates or updates an ingest pipeline.
Changes made using this API take effect immediately. +/// +/// Creates or updates an ingest pipeline. +/// Changes made using this API take effect immediately. +/// /// public sealed partial class PutPipelineRequest : PlainRequest { @@ -65,56 +74,75 @@ public PutPipelineRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Req internal override string OperationName => "ingest.put_pipeline"; /// - /// Required version for optimistic concurrency control for pipeline updates + /// + /// Required version for optimistic concurrency control for pipeline updates + /// /// [JsonIgnore] public long? IfVersion { get => Q("if_version"); set => Q("if_version", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Description of the ingest pipeline. + /// + /// Description of the ingest pipeline. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch. + /// + /// Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("_meta")] public IDictionary? Meta { get; set; } /// - /// Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors. + /// + /// Processors to run immediately after a processor failure. Each processor supports a processor-level on_failure value. If a processor without an on_failure value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. + /// + /// Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. + /// /// [JsonInclude, JsonPropertyName("processors")] public ICollection? Processors { get; set; } /// - /// Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers. + /// + /// Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers. + /// /// [JsonInclude, JsonPropertyName("version")] public long? Version { get; set; } } /// -/// Creates or updates an ingest pipeline.
Changes made using this API take effect immediately. +/// +/// Creates or updates an ingest pipeline. +/// Changes made using this API take effect immediately. +/// /// public sealed partial class PutPipelineRequestDescriptor : RequestDescriptor, PutPipelineRequestParameters> { @@ -155,7 +183,9 @@ public PutPipelineRequestDescriptor Id(Elastic.Clients.Elasticsearch. private long? VersionValue { get; set; } /// - /// Description of the ingest pipeline. + /// + /// Description of the ingest pipeline. + /// /// public PutPipelineRequestDescriptor Description(string? description) { @@ -164,7 +194,9 @@ public PutPipelineRequestDescriptor Description(string? description) } /// - /// Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch. + /// + /// Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch. + /// /// public PutPipelineRequestDescriptor Meta(Func, FluentDictionary> selector) { @@ -173,7 +205,9 @@ public PutPipelineRequestDescriptor Meta(Func - /// Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors. + /// + /// Processors to run immediately after a processor failure. Each processor supports a processor-level on_failure value. If a processor without an on_failure value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors. + /// /// public PutPipelineRequestDescriptor OnFailure(ICollection? onFailure) { @@ -212,7 +246,9 @@ public PutPipelineRequestDescriptor OnFailure(params Action - /// Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. + /// + /// Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. + /// /// public PutPipelineRequestDescriptor Processors(ICollection? processors) { @@ -251,7 +287,9 @@ public PutPipelineRequestDescriptor Processors(params Action - /// Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers. + /// + /// Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers. + /// /// public PutPipelineRequestDescriptor Version(long? version) { @@ -347,7 +385,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Creates or updates an ingest pipeline.
Changes made using this API take effect immediately. +/// +/// Creates or updates an ingest pipeline. +/// Changes made using this API take effect immediately. +/// /// public sealed partial class PutPipelineRequestDescriptor : RequestDescriptor { @@ -388,7 +429,9 @@ public PutPipelineRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id id) private long? VersionValue { get; set; } /// - /// Description of the ingest pipeline. + /// + /// Description of the ingest pipeline. + /// /// public PutPipelineRequestDescriptor Description(string? description) { @@ -397,7 +440,9 @@ public PutPipelineRequestDescriptor Description(string? description) } /// - /// Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch. + /// + /// Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch. + /// /// public PutPipelineRequestDescriptor Meta(Func, FluentDictionary> selector) { @@ -406,7 +451,9 @@ public PutPipelineRequestDescriptor Meta(Func, } /// - /// Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors. + /// + /// Processors to run immediately after a processor failure. Each processor supports a processor-level on_failure value. If a processor without an on_failure value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors. + /// /// public PutPipelineRequestDescriptor OnFailure(ICollection? onFailure) { @@ -445,7 +492,9 @@ public PutPipelineRequestDescriptor OnFailure(params Action - /// Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. + /// + /// Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. + /// /// public PutPipelineRequestDescriptor Processors(ICollection? processors) { @@ -484,7 +533,9 @@ public PutPipelineRequestDescriptor Processors(params Action - /// Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers. + /// + /// Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers. + /// /// public PutPipelineRequestDescriptor Version(long? version) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/PutPipelineResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/PutPipelineResponse.g.cs index 985e039799a..e4f7017c4e6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/PutPipelineResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/PutPipelineResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class PutPipelineResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/SimulateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/SimulateRequest.g.cs index 025c9b805d6..4b2312514f4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/SimulateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/SimulateRequest.g.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class SimulateRequestParameters : RequestParameters { /// - /// If `true`, the response includes output data for each processor in the executed pipeline. + /// + /// If true, the response includes output data for each processor in the executed pipeline. + /// /// public bool? Verbose { get => Q("verbose"); set => Q("verbose", value); } } /// -/// Executes an ingest pipeline against a set of provided documents. +/// +/// Executes an ingest pipeline against a set of provided documents. +/// /// public sealed partial class SimulateRequest : PlainRequest { @@ -59,26 +63,36 @@ public SimulateRequest(Elastic.Clients.Elasticsearch.Id? id) : base(r => r.Optio internal override string OperationName => "ingest.simulate"; /// - /// If `true`, the response includes output data for each processor in the executed pipeline. + /// + /// If true, the response includes output data for each processor in the executed pipeline. + /// /// [JsonIgnore] public bool? Verbose { get => Q("verbose"); set => Q("verbose", value); } /// - /// Sample documents to test in the pipeline. + /// + /// Sample documents to test in the pipeline. + /// /// [JsonInclude, JsonPropertyName("docs")] public ICollection? Docs { get; set; } /// - /// Pipeline to test.
If you don’t specify the `pipeline` request path parameter, this parameter is required.
If you specify both this and the request path parameter, the API only uses the request path parameter. + /// + /// Pipeline to test. + /// If you don’t specify the pipeline request path parameter, this parameter is required. + /// If you specify both this and the request path parameter, the API only uses the request path parameter. + /// /// [JsonInclude, JsonPropertyName("pipeline")] public Elastic.Clients.Elasticsearch.Ingest.Pipeline? Pipeline { get; set; } } /// -/// Executes an ingest pipeline against a set of provided documents. +/// +/// Executes an ingest pipeline against a set of provided documents. +/// /// public sealed partial class SimulateRequestDescriptor : RequestDescriptor, SimulateRequestParameters> { @@ -117,7 +131,9 @@ public SimulateRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id? private Action> PipelineDescriptorAction { get; set; } /// - /// Sample documents to test in the pipeline. + /// + /// Sample documents to test in the pipeline. + /// /// public SimulateRequestDescriptor Docs(ICollection? docs) { @@ -156,7 +172,11 @@ public SimulateRequestDescriptor Docs(params Action - /// Pipeline to test.
If you don’t specify the `pipeline` request path parameter, this parameter is required.
If you specify both this and the request path parameter, the API only uses the request path parameter. + /// + /// Pipeline to test. + /// If you don’t specify the pipeline request path parameter, this parameter is required. + /// If you specify both this and the request path parameter, the API only uses the request path parameter. + /// /// public SimulateRequestDescriptor Pipeline(Elastic.Clients.Elasticsearch.Ingest.Pipeline? pipeline) { @@ -237,7 +257,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Executes an ingest pipeline against a set of provided documents. +/// +/// Executes an ingest pipeline against a set of provided documents. +/// /// public sealed partial class SimulateRequestDescriptor : RequestDescriptor { @@ -276,7 +298,9 @@ public SimulateRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) private Action PipelineDescriptorAction { get; set; } /// - /// Sample documents to test in the pipeline. + /// + /// Sample documents to test in the pipeline. + /// /// public SimulateRequestDescriptor Docs(ICollection? docs) { @@ -315,7 +339,11 @@ public SimulateRequestDescriptor Docs(params Action - /// Pipeline to test.
If you don’t specify the `pipeline` request path parameter, this parameter is required.
If you specify both this and the request path parameter, the API only uses the request path parameter. + /// + /// Pipeline to test. + /// If you don’t specify the pipeline request path parameter, this parameter is required. + /// If you specify both this and the request path parameter, the API only uses the request path parameter. + /// /// public SimulateRequestDescriptor Pipeline(Elastic.Clients.Elasticsearch.Ingest.Pipeline? pipeline) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/DeleteLicenseRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/DeleteLicenseRequest.g.cs index 6d85456825a..f595e9f1b03 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/DeleteLicenseRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/DeleteLicenseRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class DeleteLicenseRequestParameters : RequestParameters } /// -/// Deletes licensing information for the cluster +/// +/// Deletes licensing information for the cluster +/// /// public sealed partial class DeleteLicenseRequest : PlainRequest { @@ -48,7 +50,9 @@ public sealed partial class DeleteLicenseRequest : PlainRequest -/// Deletes licensing information for the cluster +/// +/// Deletes licensing information for the cluster +/// /// public sealed partial class DeleteLicenseRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/DeleteLicenseResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/DeleteLicenseResponse.g.cs index 137545b7db4..91e73fcccf5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/DeleteLicenseResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/DeleteLicenseResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.LicenseManagement; public sealed partial class DeleteLicenseResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/GetBasicStatusRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/GetBasicStatusRequest.g.cs index 4fa85de0c69..da5444fec6e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/GetBasicStatusRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/GetBasicStatusRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class GetBasicStatusRequestParameters : RequestParameters } /// -/// Retrieves information about the status of the basic license. +/// +/// Retrieves information about the status of the basic license. +/// /// public sealed partial class GetBasicStatusRequest : PlainRequest { @@ -48,7 +50,9 @@ public sealed partial class GetBasicStatusRequest : PlainRequest -/// Retrieves information about the status of the basic license. +/// +/// Retrieves information about the status of the basic license. +/// /// public sealed partial class GetBasicStatusRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/GetLicenseRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/GetLicenseRequest.g.cs index 68472889185..40a21880879 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/GetLicenseRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/GetLicenseRequest.g.cs @@ -32,13 +32,19 @@ namespace Elastic.Clients.Elasticsearch.LicenseManagement; public sealed partial class GetLicenseRequestParameters : RequestParameters { /// - /// Specifies whether to retrieve local information. The default value is `false`, which means the information is retrieved from the master node. + /// + /// Specifies whether to retrieve local information. The default value is false, which means the information is retrieved from the master node. + /// /// public bool? Local { get => Q("local"); set => Q("local", value); } } /// -/// Get license information.
Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires.
For more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions). +/// +/// Get license information. +/// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. +/// For more information about the different types of licenses, refer to Elastic Stack subscriptions. +/// /// public sealed partial class GetLicenseRequest : PlainRequest { @@ -51,14 +57,20 @@ public sealed partial class GetLicenseRequest : PlainRequest "license.get"; /// - /// Specifies whether to retrieve local information. The default value is `false`, which means the information is retrieved from the master node. + /// + /// Specifies whether to retrieve local information. The default value is false, which means the information is retrieved from the master node. + /// /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } } /// -/// Get license information.
Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires.
For more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions). +/// +/// Get license information. +/// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. +/// For more information about the different types of licenses, refer to Elastic Stack subscriptions. +/// /// public sealed partial class GetLicenseRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/GetTrialStatusRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/GetTrialStatusRequest.g.cs index 4c2f2611be4..a215fcc5198 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/GetTrialStatusRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/GetTrialStatusRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class GetTrialStatusRequestParameters : RequestParameters } /// -/// Retrieves information about the status of the trial license. +/// +/// Retrieves information about the status of the trial license. +/// /// public sealed partial class GetTrialStatusRequest : PlainRequest { @@ -48,7 +50,9 @@ public sealed partial class GetTrialStatusRequest : PlainRequest -/// Retrieves information about the status of the trial license. +/// +/// Retrieves information about the status of the trial license. +/// /// public sealed partial class GetTrialStatusRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/PostRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/PostRequest.g.cs index 7016fb05548..1cd5e374dde 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/PostRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/PostRequest.g.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch.LicenseManagement; public sealed partial class PostRequestParameters : RequestParameters { /// - /// Specifies whether you acknowledge the license changes. + /// + /// Specifies whether you acknowledge the license changes. + /// /// public bool? Acknowledge { get => Q("acknowledge"); set => Q("acknowledge", value); } } /// -/// Updates the license for the cluster. +/// +/// Updates the license for the cluster. +/// /// public sealed partial class PostRequest : PlainRequest { @@ -51,7 +55,9 @@ public sealed partial class PostRequest : PlainRequest internal override string OperationName => "license.post"; /// - /// Specifies whether you acknowledge the license changes. + /// + /// Specifies whether you acknowledge the license changes. + /// /// [JsonIgnore] public bool? Acknowledge { get => Q("acknowledge"); set => Q("acknowledge", value); } @@ -59,14 +65,18 @@ public sealed partial class PostRequest : PlainRequest public Elastic.Clients.Elasticsearch.LicenseManagement.License? License { get; set; } /// - /// A sequence of one or more JSON documents containing the license information. + /// + /// A sequence of one or more JSON documents containing the license information. + /// /// [JsonInclude, JsonPropertyName("licenses")] public ICollection? Licenses { get; set; } } /// -/// Updates the license for the cluster. +/// +/// Updates the license for the cluster. +/// /// public sealed partial class PostRequestDescriptor : RequestDescriptor { @@ -119,7 +129,9 @@ public PostRequestDescriptor License(Action - /// A sequence of one or more JSON documents containing the license information. + /// + /// A sequence of one or more JSON documents containing the license information. + /// /// public PostRequestDescriptor Licenses(ICollection? licenses) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/PostStartBasicRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/PostStartBasicRequest.g.cs index 04cee67761e..e1e159bab5e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/PostStartBasicRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/PostStartBasicRequest.g.cs @@ -32,13 +32,18 @@ namespace Elastic.Clients.Elasticsearch.LicenseManagement; public sealed partial class PostStartBasicRequestParameters : RequestParameters { /// - /// whether the user has acknowledged acknowledge messages (default: false) + /// + /// whether the user has acknowledged acknowledge messages (default: false) + /// /// public bool? Acknowledge { get => Q("acknowledge"); set => Q("acknowledge", value); } } /// -/// The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true.
To check the status of your basic license, use the following API: [Get basic status](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html). +/// +/// The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. +/// To check the status of your basic license, use the following API: Get basic status. +/// /// public sealed partial class PostStartBasicRequest : PlainRequest { @@ -51,14 +56,19 @@ public sealed partial class PostStartBasicRequest : PlainRequest "license.post_start_basic"; /// - /// whether the user has acknowledged acknowledge messages (default: false) + /// + /// whether the user has acknowledged acknowledge messages (default: false) + /// /// [JsonIgnore] public bool? Acknowledge { get => Q("acknowledge"); set => Q("acknowledge", value); } } /// -/// The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true.
To check the status of your basic license, use the following API: [Get basic status](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html). +/// +/// The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. +/// To check the status of your basic license, use the following API: Get basic status. +/// /// public sealed partial class PostStartBasicRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/PostStartTrialRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/PostStartTrialRequest.g.cs index 022a8830690..518b624883d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/PostStartTrialRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/PostStartTrialRequest.g.cs @@ -32,14 +32,18 @@ namespace Elastic.Clients.Elasticsearch.LicenseManagement; public sealed partial class PostStartTrialRequestParameters : RequestParameters { /// - /// whether the user has acknowledged acknowledge messages (default: false) + /// + /// whether the user has acknowledged acknowledge messages (default: false) + /// /// public bool? Acknowledge { get => Q("acknowledge"); set => Q("acknowledge", value); } public string? TypeQueryString { get => Q("type_query_string"); set => Q("type_query_string", value); } } /// -/// The start trial API enables you to start a 30-day trial, which gives access to all subscription features. +/// +/// The start trial API enables you to start a 30-day trial, which gives access to all subscription features. +/// /// public sealed partial class PostStartTrialRequest : PlainRequest { @@ -52,7 +56,9 @@ public sealed partial class PostStartTrialRequest : PlainRequest "license.post_start_trial"; /// - /// whether the user has acknowledged acknowledge messages (default: false) + /// + /// whether the user has acknowledged acknowledge messages (default: false) + /// /// [JsonIgnore] public bool? Acknowledge { get => Q("acknowledge"); set => Q("acknowledge", value); } @@ -61,7 +67,9 @@ public sealed partial class PostStartTrialRequest : PlainRequest -/// The start trial API enables you to start a 30-day trial, which gives access to all subscription features. +/// +/// The start trial API enables you to start a 30-day trial, which gives access to all subscription features. +/// /// public sealed partial class PostStartTrialRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ClearTrainedModelDeploymentCacheRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ClearTrainedModelDeploymentCacheRequest.g.cs index cfaf169ba62..afbdc507d44 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ClearTrainedModelDeploymentCacheRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ClearTrainedModelDeploymentCacheRequest.g.cs @@ -34,7 +34,13 @@ public sealed partial class ClearTrainedModelDeploymentCacheRequestParameters : } /// -/// Clear trained model deployment cache.
Cache will be cleared on all nodes where the trained model is assigned.
A trained model deployment may have an inference cache enabled.
As requests are handled by each allocated node, their responses may be cached on that individual node.
Calling this API clears the caches without restarting the deployment. +/// +/// Clear trained model deployment cache. +/// Cache will be cleared on all nodes where the trained model is assigned. +/// A trained model deployment may have an inference cache enabled. +/// As requests are handled by each allocated node, their responses may be cached on that individual node. +/// Calling this API clears the caches without restarting the deployment. +/// /// public sealed partial class ClearTrainedModelDeploymentCacheRequest : PlainRequest { @@ -52,7 +58,13 @@ public ClearTrainedModelDeploymentCacheRequest(Elastic.Clients.Elasticsearch.Id } /// -/// Clear trained model deployment cache.
Cache will be cleared on all nodes where the trained model is assigned.
A trained model deployment may have an inference cache enabled.
As requests are handled by each allocated node, their responses may be cached on that individual node.
Calling this API clears the caches without restarting the deployment. +/// +/// Clear trained model deployment cache. +/// Cache will be cleared on all nodes where the trained model is assigned. +/// A trained model deployment may have an inference cache enabled. +/// As requests are handled by each allocated node, their responses may be cached on that individual node. +/// Calling this API clears the caches without restarting the deployment. +/// /// public sealed partial class ClearTrainedModelDeploymentCacheRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/CloseJobRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/CloseJobRequest.g.cs index 87ce1ea26f8..6da942d59a6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/CloseJobRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/CloseJobRequest.g.cs @@ -34,7 +34,13 @@ public sealed partial class CloseJobRequestParameters : RequestParameters } /// -/// Close anomaly detection jobs.
A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.
When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.
If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.
When a datafeed that has a specified end date stops, it automatically closes its associated job. +/// +/// Close anomaly detection jobs. +/// A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results. +/// When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data. +/// If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. +/// When a datafeed that has a specified end date stops, it automatically closes its associated job. +/// /// public sealed partial class CloseJobRequest : PlainRequest { @@ -51,26 +57,38 @@ public CloseJobRequest(Elastic.Clients.Elasticsearch.Id jobId) : base(r => r.Req internal override string OperationName => "ml.close_job"; /// - /// Refer to the description for the `allow_no_match` query parameter. + /// + /// Refer to the description for the allow_no_match query parameter. + /// /// [JsonInclude, JsonPropertyName("allow_no_match")] public bool? AllowNoMatch { get; set; } /// - /// Refer to the descriptiion for the `force` query parameter. + /// + /// Refer to the descriptiion for the force query parameter. + /// /// [JsonInclude, JsonPropertyName("force")] public bool? Force { get; set; } /// - /// Refer to the description for the `timeout` query parameter. + /// + /// Refer to the description for the timeout query parameter. + /// /// [JsonInclude, JsonPropertyName("timeout")] public Elastic.Clients.Elasticsearch.Duration? Timeout { get; set; } } /// -/// Close anomaly detection jobs.
A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.
When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.
If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.
When a datafeed that has a specified end date stops, it automatically closes its associated job. +/// +/// Close anomaly detection jobs. +/// A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results. +/// When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data. +/// If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. +/// When a datafeed that has a specified end date stops, it automatically closes its associated job. +/// /// public sealed partial class CloseJobRequestDescriptor : RequestDescriptor { @@ -99,7 +117,9 @@ public CloseJobRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Id jobId) private Elastic.Clients.Elasticsearch.Duration? TimeoutValue { get; set; } /// - /// Refer to the description for the `allow_no_match` query parameter. + /// + /// Refer to the description for the allow_no_match query parameter. + /// /// public CloseJobRequestDescriptor AllowNoMatch(bool? allowNoMatch = true) { @@ -108,7 +128,9 @@ public CloseJobRequestDescriptor AllowNoMatch(bool? allowNoMatch = true) } /// - /// Refer to the descriptiion for the `force` query parameter. + /// + /// Refer to the descriptiion for the force query parameter. + /// /// public CloseJobRequestDescriptor Force(bool? force = true) { @@ -117,7 +139,9 @@ public CloseJobRequestDescriptor Force(bool? force = true) } /// - /// Refer to the description for the `timeout` query parameter. + /// + /// Refer to the description for the timeout query parameter. + /// /// public CloseJobRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Duration? timeout) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteCalendarEventRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteCalendarEventRequest.g.cs index 3acf3df73c9..95728aebc47 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteCalendarEventRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteCalendarEventRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class DeleteCalendarEventRequestParameters : RequestParame } /// -/// Delete events from a calendar. +/// +/// Delete events from a calendar. +/// /// public sealed partial class DeleteCalendarEventRequest : PlainRequest { @@ -52,7 +54,9 @@ public DeleteCalendarEventRequest(Elastic.Clients.Elasticsearch.Id calendarId, E } /// -/// Delete events from a calendar. +/// +/// Delete events from a calendar. +/// /// public sealed partial class DeleteCalendarEventRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteCalendarEventResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteCalendarEventResponse.g.cs index a8d36991da3..47d28a27405 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteCalendarEventResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteCalendarEventResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DeleteCalendarEventResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteCalendarJobRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteCalendarJobRequest.g.cs index b0d03c9939a..2efbbececf1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteCalendarJobRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteCalendarJobRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class DeleteCalendarJobRequestParameters : RequestParamete } /// -/// Delete anomaly jobs from a calendar. +/// +/// Delete anomaly jobs from a calendar. +/// /// public sealed partial class DeleteCalendarJobRequest : PlainRequest { @@ -52,7 +54,9 @@ public DeleteCalendarJobRequest(Elastic.Clients.Elasticsearch.Id calendarId, Ela } /// -/// Delete anomaly jobs from a calendar. +/// +/// Delete anomaly jobs from a calendar. +/// /// public sealed partial class DeleteCalendarJobRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteCalendarJobResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteCalendarJobResponse.g.cs index 0f3e3d32561..f79e96e6c83 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteCalendarJobResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteCalendarJobResponse.g.cs @@ -29,19 +29,25 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DeleteCalendarJobResponse : ElasticsearchResponse { /// - /// A string that uniquely identifies a calendar. + /// + /// A string that uniquely identifies a calendar. + /// /// [JsonInclude, JsonPropertyName("calendar_id")] public string CalendarId { get; init; } /// - /// A description of the calendar. + /// + /// A description of the calendar. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; init; } /// - /// A list of anomaly detection job identifiers or group names. + /// + /// A list of anomaly detection job identifiers or group names. + /// /// [JsonInclude, JsonPropertyName("job_ids")] [SingleOrManyCollectionConverter(typeof(string))] diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteCalendarRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteCalendarRequest.g.cs index 3cae39c71fc..63cd6cff4da 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteCalendarRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteCalendarRequest.g.cs @@ -34,7 +34,10 @@ public sealed partial class DeleteCalendarRequestParameters : RequestParameters } /// -/// Delete a calendar.
Removes all scheduled events from a calendar, then deletes it. +/// +/// Delete a calendar. +/// Removes all scheduled events from a calendar, then deletes it. +/// /// public sealed partial class DeleteCalendarRequest : PlainRequest { @@ -52,7 +55,10 @@ public DeleteCalendarRequest(Elastic.Clients.Elasticsearch.Id calendarId) : base } /// -/// Delete a calendar.
Removes all scheduled events from a calendar, then deletes it. +/// +/// Delete a calendar. +/// Removes all scheduled events from a calendar, then deletes it. +/// /// public sealed partial class DeleteCalendarRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteCalendarResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteCalendarResponse.g.cs index 758838f8437..f2439430e4c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteCalendarResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteCalendarResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DeleteCalendarResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteDataFrameAnalyticsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteDataFrameAnalyticsRequest.g.cs index 69a32038a4e..1ad508259e6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteDataFrameAnalyticsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteDataFrameAnalyticsRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DeleteDataFrameAnalyticsRequestParameters : RequestParameters { /// - /// If `true`, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job. + /// + /// If true, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job. + /// /// public bool? Force { get => Q("force"); set => Q("force", value); } /// - /// The time to wait for the job to be deleted. + /// + /// The time to wait for the job to be deleted. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete a data frame analytics job. +/// +/// Delete a data frame analytics job. +/// /// public sealed partial class DeleteDataFrameAnalyticsRequest : PlainRequest { @@ -60,20 +66,26 @@ public DeleteDataFrameAnalyticsRequest(Elastic.Clients.Elasticsearch.Id id) : ba internal override string OperationName => "ml.delete_data_frame_analytics"; /// - /// If `true`, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job. + /// + /// If true, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job. + /// /// [JsonIgnore] public bool? Force { get => Q("force"); set => Q("force", value); } /// - /// The time to wait for the job to be deleted. + /// + /// The time to wait for the job to be deleted. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete a data frame analytics job. +/// +/// Delete a data frame analytics job. +/// /// public sealed partial class DeleteDataFrameAnalyticsRequestDescriptor : RequestDescriptor, DeleteDataFrameAnalyticsRequestParameters> { @@ -106,7 +118,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Delete a data frame analytics job. +/// +/// Delete a data frame analytics job. +/// /// public sealed partial class DeleteDataFrameAnalyticsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteDataFrameAnalyticsResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteDataFrameAnalyticsResponse.g.cs index b453bd91c0c..78d91d8d7ff 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteDataFrameAnalyticsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteDataFrameAnalyticsResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DeleteDataFrameAnalyticsResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteDatafeedRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteDatafeedRequest.g.cs index 09bcc2bdd8a..f92596ee0ec 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteDatafeedRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteDatafeedRequest.g.cs @@ -32,13 +32,18 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DeleteDatafeedRequestParameters : RequestParameters { /// - /// Use to forcefully delete a started datafeed; this method is quicker than
stopping and deleting the datafeed. + /// + /// Use to forcefully delete a started datafeed; this method is quicker than + /// stopping and deleting the datafeed. + /// /// public bool? Force { get => Q("force"); set => Q("force", value); } } /// -/// Delete a datafeed. +/// +/// Delete a datafeed. +/// /// public sealed partial class DeleteDatafeedRequest : PlainRequest { @@ -55,14 +60,19 @@ public DeleteDatafeedRequest(Elastic.Clients.Elasticsearch.Id datafeedId) : base internal override string OperationName => "ml.delete_datafeed"; /// - /// Use to forcefully delete a started datafeed; this method is quicker than
stopping and deleting the datafeed. + /// + /// Use to forcefully delete a started datafeed; this method is quicker than + /// stopping and deleting the datafeed. + /// /// [JsonIgnore] public bool? Force { get => Q("force"); set => Q("force", value); } } /// -/// Delete a datafeed. +/// +/// Delete a datafeed. +/// /// public sealed partial class DeleteDatafeedRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteDatafeedResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteDatafeedResponse.g.cs index 7fe6cb1edb7..985d0ec763f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteDatafeedResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteDatafeedResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DeleteDatafeedResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteExpiredDataRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteExpiredDataRequest.g.cs index a1bcdea9ab1..b3b7187d76c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteExpiredDataRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteExpiredDataRequest.g.cs @@ -34,7 +34,17 @@ public sealed partial class DeleteExpiredDataRequestParameters : RequestParamete } /// -/// Delete expired ML data.
Deletes all job results, model snapshots and forecast data that have exceeded
their retention days period. Machine learning state documents that are not
associated with any job are also deleted.
You can limit the request to a single or set of anomaly detection jobs by
using a job identifier, a group name, a comma-separated list of jobs, or a
wildcard expression. You can delete expired data for all anomaly detection
jobs by using _all, by specifying * as the , or by omitting the
. +/// +/// Delete expired ML data. +/// Deletes all job results, model snapshots and forecast data that have exceeded +/// their retention days period. Machine learning state documents that are not +/// associated with any job are also deleted. +/// You can limit the request to a single or set of anomaly detection jobs by +/// using a job identifier, a group name, a comma-separated list of jobs, or a +/// wildcard expression. You can delete expired data for all anomaly detection +/// jobs by using _all, by specifying * as the <job_id>, or by omitting the +/// <job_id>. +/// /// public sealed partial class DeleteExpiredDataRequest : PlainRequest { @@ -55,20 +65,35 @@ public DeleteExpiredDataRequest(Elastic.Clients.Elasticsearch.Id? jobId) : base( internal override string OperationName => "ml.delete_expired_data"; /// - /// The desired requests per second for the deletion processes. The default
behavior is no throttling. + /// + /// The desired requests per second for the deletion processes. The default + /// behavior is no throttling. + /// /// [JsonInclude, JsonPropertyName("requests_per_second")] public float? RequestsPerSecond { get; set; } /// - /// How long can the underlying delete processes run until they are canceled. + /// + /// How long can the underlying delete processes run until they are canceled. + /// /// [JsonInclude, JsonPropertyName("timeout")] public Elastic.Clients.Elasticsearch.Duration? Timeout { get; set; } } /// -/// Delete expired ML data.
Deletes all job results, model snapshots and forecast data that have exceeded
their retention days period. Machine learning state documents that are not
associated with any job are also deleted.
You can limit the request to a single or set of anomaly detection jobs by
using a job identifier, a group name, a comma-separated list of jobs, or a
wildcard expression. You can delete expired data for all anomaly detection
jobs by using _all, by specifying * as the , or by omitting the
. +/// +/// Delete expired ML data. +/// Deletes all job results, model snapshots and forecast data that have exceeded +/// their retention days period. Machine learning state documents that are not +/// associated with any job are also deleted. +/// You can limit the request to a single or set of anomaly detection jobs by +/// using a job identifier, a group name, a comma-separated list of jobs, or a +/// wildcard expression. You can delete expired data for all anomaly detection +/// jobs by using _all, by specifying * as the <job_id>, or by omitting the +/// <job_id>. +/// /// public sealed partial class DeleteExpiredDataRequestDescriptor : RequestDescriptor { @@ -100,7 +125,10 @@ public DeleteExpiredDataRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Id private Elastic.Clients.Elasticsearch.Duration? TimeoutValue { get; set; } /// - /// The desired requests per second for the deletion processes. The default
behavior is no throttling. + /// + /// The desired requests per second for the deletion processes. The default + /// behavior is no throttling. + /// /// public DeleteExpiredDataRequestDescriptor RequestsPerSecond(float? requestsPerSecond) { @@ -109,7 +137,9 @@ public DeleteExpiredDataRequestDescriptor RequestsPerSecond(float? requestsPerSe } /// - /// How long can the underlying delete processes run until they are canceled. + /// + /// How long can the underlying delete processes run until they are canceled. + /// /// public DeleteExpiredDataRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Duration? timeout) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteFilterRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteFilterRequest.g.cs index 3dc19febe8d..4dd909d6d74 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteFilterRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteFilterRequest.g.cs @@ -34,7 +34,11 @@ public sealed partial class DeleteFilterRequestParameters : RequestParameters } /// -/// Delete a filter.
If an anomaly detection job references the filter, you cannot delete the
filter. You must update or delete the job before you can delete the filter. +/// +/// Delete a filter. +/// If an anomaly detection job references the filter, you cannot delete the +/// filter. You must update or delete the job before you can delete the filter. +/// /// public sealed partial class DeleteFilterRequest : PlainRequest { @@ -52,7 +56,11 @@ public DeleteFilterRequest(Elastic.Clients.Elasticsearch.Id filterId) : base(r = } /// -/// Delete a filter.
If an anomaly detection job references the filter, you cannot delete the
filter. You must update or delete the job before you can delete the filter. +/// +/// Delete a filter. +/// If an anomaly detection job references the filter, you cannot delete the +/// filter. You must update or delete the job before you can delete the filter. +/// /// public sealed partial class DeleteFilterRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteFilterResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteFilterResponse.g.cs index 83dfc664923..6d37a717058 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteFilterResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteFilterResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DeleteFilterResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteForecastRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteForecastRequest.g.cs index f5313e789e1..9c9caeeb374 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteForecastRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteForecastRequest.g.cs @@ -32,18 +32,33 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DeleteForecastRequestParameters : RequestParameters { /// - /// Specifies whether an error occurs when there are no forecasts. In
particular, if this parameter is set to `false` and there are no
forecasts associated with the job, attempts to delete all forecasts
return an error. + /// + /// Specifies whether an error occurs when there are no forecasts. In + /// particular, if this parameter is set to false and there are no + /// forecasts associated with the job, attempts to delete all forecasts + /// return an error. + /// /// public bool? AllowNoForecasts { get => Q("allow_no_forecasts"); set => Q("allow_no_forecasts", value); } /// - /// Specifies the period of time to wait for the completion of the delete
operation. When this period of time elapses, the API fails and returns an
error. + /// + /// Specifies the period of time to wait for the completion of the delete + /// operation. When this period of time elapses, the API fails and returns an + /// error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete forecasts from a job.
By default, forecasts are retained for 14 days. You can specify a
different retention period with the `expires_in` parameter in the forecast
jobs API. The delete forecast API enables you to delete one or more
forecasts before they expire. +/// +/// Delete forecasts from a job. +/// By default, forecasts are retained for 14 days. You can specify a +/// different retention period with the expires_in parameter in the forecast +/// jobs API. The delete forecast API enables you to delete one or more +/// forecasts before they expire. +/// /// public sealed partial class DeleteForecastRequest : PlainRequest { @@ -64,20 +79,35 @@ public DeleteForecastRequest(Elastic.Clients.Elasticsearch.Id jobId, Elastic.Cli internal override string OperationName => "ml.delete_forecast"; /// - /// Specifies whether an error occurs when there are no forecasts. In
particular, if this parameter is set to `false` and there are no
forecasts associated with the job, attempts to delete all forecasts
return an error. + /// + /// Specifies whether an error occurs when there are no forecasts. In + /// particular, if this parameter is set to false and there are no + /// forecasts associated with the job, attempts to delete all forecasts + /// return an error. + /// /// [JsonIgnore] public bool? AllowNoForecasts { get => Q("allow_no_forecasts"); set => Q("allow_no_forecasts", value); } /// - /// Specifies the period of time to wait for the completion of the delete
operation. When this period of time elapses, the API fails and returns an
error. + /// + /// Specifies the period of time to wait for the completion of the delete + /// operation. When this period of time elapses, the API fails and returns an + /// error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete forecasts from a job.
By default, forecasts are retained for 14 days. You can specify a
different retention period with the `expires_in` parameter in the forecast
jobs API. The delete forecast API enables you to delete one or more
forecasts before they expire. +/// +/// Delete forecasts from a job. +/// By default, forecasts are retained for 14 days. You can specify a +/// different retention period with the expires_in parameter in the forecast +/// jobs API. The delete forecast API enables you to delete one or more +/// forecasts before they expire. +/// /// public sealed partial class DeleteForecastRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteForecastResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteForecastResponse.g.cs index 1f0e8e5cb16..00b3f7ab79e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteForecastResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteForecastResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DeleteForecastResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteJobRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteJobRequest.g.cs index 72b46e3dace..20f3cd58d79 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteJobRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteJobRequest.g.cs @@ -32,23 +32,41 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DeleteJobRequestParameters : RequestParameters { /// - /// Specifies whether annotations that have been added by the
user should be deleted along with any auto-generated annotations when the job is
reset. + /// + /// Specifies whether annotations that have been added by the + /// user should be deleted along with any auto-generated annotations when the job is + /// reset. + /// /// public bool? DeleteUserAnnotations { get => Q("delete_user_annotations"); set => Q("delete_user_annotations", value); } /// - /// Use to forcefully delete an opened job; this method is quicker than
closing and deleting the job. + /// + /// Use to forcefully delete an opened job; this method is quicker than + /// closing and deleting the job. + /// /// public bool? Force { get => Q("force"); set => Q("force", value); } /// - /// Specifies whether the request should return immediately or wait until the
job deletion completes. + /// + /// Specifies whether the request should return immediately or wait until the + /// job deletion completes. + /// /// public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Delete an anomaly detection job.
All job configuration, model state and results are deleted.
It is not currently possible to delete multiple jobs using wildcards or a
comma separated list. If you delete a job that has a datafeed, the request
first tries to delete the datafeed. This behavior is equivalent to calling
the delete datafeed API with the same timeout and force parameters as the
delete job request. +/// +/// Delete an anomaly detection job. +/// All job configuration, model state and results are deleted. +/// It is not currently possible to delete multiple jobs using wildcards or a +/// comma separated list. If you delete a job that has a datafeed, the request +/// first tries to delete the datafeed. This behavior is equivalent to calling +/// the delete datafeed API with the same timeout and force parameters as the +/// delete job request. +/// /// public sealed partial class DeleteJobRequest : PlainRequest { @@ -65,26 +83,44 @@ public DeleteJobRequest(Elastic.Clients.Elasticsearch.Id jobId) : base(r => r.Re internal override string OperationName => "ml.delete_job"; /// - /// Specifies whether annotations that have been added by the
user should be deleted along with any auto-generated annotations when the job is
reset. + /// + /// Specifies whether annotations that have been added by the + /// user should be deleted along with any auto-generated annotations when the job is + /// reset. + /// /// [JsonIgnore] public bool? DeleteUserAnnotations { get => Q("delete_user_annotations"); set => Q("delete_user_annotations", value); } /// - /// Use to forcefully delete an opened job; this method is quicker than
closing and deleting the job. + /// + /// Use to forcefully delete an opened job; this method is quicker than + /// closing and deleting the job. + /// /// [JsonIgnore] public bool? Force { get => Q("force"); set => Q("force", value); } /// - /// Specifies whether the request should return immediately or wait until the
job deletion completes. + /// + /// Specifies whether the request should return immediately or wait until the + /// job deletion completes. + /// /// [JsonIgnore] public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Delete an anomaly detection job.
All job configuration, model state and results are deleted.
It is not currently possible to delete multiple jobs using wildcards or a
comma separated list. If you delete a job that has a datafeed, the request
first tries to delete the datafeed. This behavior is equivalent to calling
the delete datafeed API with the same timeout and force parameters as the
delete job request. +/// +/// Delete an anomaly detection job. +/// All job configuration, model state and results are deleted. +/// It is not currently possible to delete multiple jobs using wildcards or a +/// comma separated list. If you delete a job that has a datafeed, the request +/// first tries to delete the datafeed. This behavior is equivalent to calling +/// the delete datafeed API with the same timeout and force parameters as the +/// delete job request. +/// /// public sealed partial class DeleteJobRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteJobResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteJobResponse.g.cs index 0bc6b3a5475..94765430771 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteJobResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteJobResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DeleteJobResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteModelSnapshotRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteModelSnapshotRequest.g.cs index 10d6576215b..b976eb13e45 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteModelSnapshotRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteModelSnapshotRequest.g.cs @@ -34,7 +34,12 @@ public sealed partial class DeleteModelSnapshotRequestParameters : RequestParame } /// -/// Delete a model snapshot.
You cannot delete the active model snapshot. To delete that snapshot, first
revert to a different one. To identify the active model snapshot, refer to
the `model_snapshot_id` in the results from the get jobs API. +/// +/// Delete a model snapshot. +/// You cannot delete the active model snapshot. To delete that snapshot, first +/// revert to a different one. To identify the active model snapshot, refer to +/// the model_snapshot_id in the results from the get jobs API. +/// /// public sealed partial class DeleteModelSnapshotRequest : PlainRequest { @@ -52,7 +57,12 @@ public DeleteModelSnapshotRequest(Elastic.Clients.Elasticsearch.Id jobId, Elasti } /// -/// Delete a model snapshot.
You cannot delete the active model snapshot. To delete that snapshot, first
revert to a different one. To identify the active model snapshot, refer to
the `model_snapshot_id` in the results from the get jobs API. +/// +/// Delete a model snapshot. +/// You cannot delete the active model snapshot. To delete that snapshot, first +/// revert to a different one. To identify the active model snapshot, refer to +/// the model_snapshot_id in the results from the get jobs API. +/// /// public sealed partial class DeleteModelSnapshotRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteModelSnapshotResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteModelSnapshotResponse.g.cs index 46319a9c252..658f9205a22 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteModelSnapshotResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteModelSnapshotResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DeleteModelSnapshotResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteTrainedModelAliasRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteTrainedModelAliasRequest.g.cs index 05d1d5a7a58..84331216ff1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteTrainedModelAliasRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteTrainedModelAliasRequest.g.cs @@ -34,7 +34,12 @@ public sealed partial class DeleteTrainedModelAliasRequestParameters : RequestPa } /// -/// Delete a trained model alias.
This API deletes an existing model alias that refers to a trained model. If
the model alias is missing or refers to a model other than the one identified
by the `model_id`, this API returns an error. +/// +/// Delete a trained model alias. +/// This API deletes an existing model alias that refers to a trained model. If +/// the model alias is missing or refers to a model other than the one identified +/// by the model_id, this API returns an error. +/// /// public sealed partial class DeleteTrainedModelAliasRequest : PlainRequest { @@ -52,7 +57,12 @@ public DeleteTrainedModelAliasRequest(Elastic.Clients.Elasticsearch.Id modelId, } /// -/// Delete a trained model alias.
This API deletes an existing model alias that refers to a trained model. If
the model alias is missing or refers to a model other than the one identified
by the `model_id`, this API returns an error. +/// +/// Delete a trained model alias. +/// This API deletes an existing model alias that refers to a trained model. If +/// the model alias is missing or refers to a model other than the one identified +/// by the model_id, this API returns an error. +/// /// public sealed partial class DeleteTrainedModelAliasRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteTrainedModelAliasResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteTrainedModelAliasResponse.g.cs index 6bdcaf15fe5..9d8644ff51e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteTrainedModelAliasResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteTrainedModelAliasResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DeleteTrainedModelAliasResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteTrainedModelRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteTrainedModelRequest.g.cs index ef374ea4bfb..0cee8dafcb1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteTrainedModelRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteTrainedModelRequest.g.cs @@ -32,13 +32,18 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DeleteTrainedModelRequestParameters : RequestParameters { /// - /// Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment. + /// + /// Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment. + /// /// public bool? Force { get => Q("force"); set => Q("force", value); } } /// -/// Delete an unreferenced trained model.
The request deletes a trained inference model that is not referenced by an ingest pipeline. +/// +/// Delete an unreferenced trained model. +/// The request deletes a trained inference model that is not referenced by an ingest pipeline. +/// /// public sealed partial class DeleteTrainedModelRequest : PlainRequest { @@ -55,14 +60,19 @@ public DeleteTrainedModelRequest(Elastic.Clients.Elasticsearch.Id modelId) : bas internal override string OperationName => "ml.delete_trained_model"; /// - /// Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment. + /// + /// Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment. + /// /// [JsonIgnore] public bool? Force { get => Q("force"); set => Q("force", value); } } /// -/// Delete an unreferenced trained model.
The request deletes a trained inference model that is not referenced by an ingest pipeline. +/// +/// Delete an unreferenced trained model. +/// The request deletes a trained inference model that is not referenced by an ingest pipeline. +/// /// public sealed partial class DeleteTrainedModelRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteTrainedModelResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteTrainedModelResponse.g.cs index eb443b640fa..2a0564f9050 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteTrainedModelResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/DeleteTrainedModelResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DeleteTrainedModelResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/EstimateModelMemoryRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/EstimateModelMemoryRequest.g.cs index da34c31316e..7d75ba1bc9b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/EstimateModelMemoryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/EstimateModelMemoryRequest.g.cs @@ -34,7 +34,12 @@ public sealed partial class EstimateModelMemoryRequestParameters : RequestParame } /// -/// Estimate job model memory usage.
Makes an estimation of the memory usage for an anomaly detection job model.
It is based on analysis configuration details for the job and cardinality
estimates for the fields it references. +/// +/// Estimate job model memory usage. +/// Makes an estimation of the memory usage for an anomaly detection job model. +/// It is based on analysis configuration details for the job and cardinality +/// estimates for the fields it references. +/// /// public sealed partial class EstimateModelMemoryRequest : PlainRequest { @@ -47,26 +52,48 @@ public sealed partial class EstimateModelMemoryRequest : PlainRequest "ml.estimate_model_memory"; /// - /// For a list of the properties that you can specify in the
`analysis_config` component of the body of this API. + /// + /// For a list of the properties that you can specify in the + /// analysis_config component of the body of this API. + /// /// [JsonInclude, JsonPropertyName("analysis_config")] public Elastic.Clients.Elasticsearch.MachineLearning.AnalysisConfig? AnalysisConfig { get; set; } /// - /// Estimates of the highest cardinality in a single bucket that is observed
for influencer fields over the time period that the job analyzes data.
To produce a good answer, values must be provided for all influencer
fields. Providing values for fields that are not listed as `influencers`
has no effect on the estimation. + /// + /// Estimates of the highest cardinality in a single bucket that is observed + /// for influencer fields over the time period that the job analyzes data. + /// To produce a good answer, values must be provided for all influencer + /// fields. Providing values for fields that are not listed as influencers + /// has no effect on the estimation. + /// /// [JsonInclude, JsonPropertyName("max_bucket_cardinality")] public IDictionary? MaxBucketCardinality { get; set; } /// - /// Estimates of the cardinality that is observed for fields over the whole
time period that the job analyzes data. To produce a good answer, values
must be provided for fields referenced in the `by_field_name`,
`over_field_name` and `partition_field_name` of any detectors. Providing
values for other fields has no effect on the estimation. It can be
omitted from the request if no detectors have a `by_field_name`,
`over_field_name` or `partition_field_name`. + /// + /// Estimates of the cardinality that is observed for fields over the whole + /// time period that the job analyzes data. To produce a good answer, values + /// must be provided for fields referenced in the by_field_name, + /// over_field_name and partition_field_name of any detectors. Providing + /// values for other fields has no effect on the estimation. It can be + /// omitted from the request if no detectors have a by_field_name, + /// over_field_name or partition_field_name. + /// /// [JsonInclude, JsonPropertyName("overall_cardinality")] public IDictionary? OverallCardinality { get; set; } } /// -/// Estimate job model memory usage.
Makes an estimation of the memory usage for an anomaly detection job model.
It is based on analysis configuration details for the job and cardinality
estimates for the fields it references. +/// +/// Estimate job model memory usage. +/// Makes an estimation of the memory usage for an anomaly detection job model. +/// It is based on analysis configuration details for the job and cardinality +/// estimates for the fields it references. +/// /// public sealed partial class EstimateModelMemoryRequestDescriptor : RequestDescriptor, EstimateModelMemoryRequestParameters> { @@ -91,7 +118,10 @@ public EstimateModelMemoryRequestDescriptor() private IDictionary? OverallCardinalityValue { get; set; } /// - /// For a list of the properties that you can specify in the
`analysis_config` component of the body of this API. + /// + /// For a list of the properties that you can specify in the + /// analysis_config component of the body of this API. + /// /// public EstimateModelMemoryRequestDescriptor AnalysisConfig(Elastic.Clients.Elasticsearch.MachineLearning.AnalysisConfig? analysisConfig) { @@ -118,7 +148,13 @@ public EstimateModelMemoryRequestDescriptor AnalysisConfig(Action - /// Estimates of the highest cardinality in a single bucket that is observed
for influencer fields over the time period that the job analyzes data.
To produce a good answer, values must be provided for all influencer
fields. Providing values for fields that are not listed as `influencers`
has no effect on the estimation. + /// + /// Estimates of the highest cardinality in a single bucket that is observed + /// for influencer fields over the time period that the job analyzes data. + /// To produce a good answer, values must be provided for all influencer + /// fields. Providing values for fields that are not listed as influencers + /// has no effect on the estimation. + /// /// public EstimateModelMemoryRequestDescriptor MaxBucketCardinality(Func, FluentDictionary> selector) { @@ -127,7 +163,15 @@ public EstimateModelMemoryRequestDescriptor MaxBucketCardinality(Func } /// - /// Estimates of the cardinality that is observed for fields over the whole
time period that the job analyzes data. To produce a good answer, values
must be provided for fields referenced in the `by_field_name`,
`over_field_name` and `partition_field_name` of any detectors. Providing
values for other fields has no effect on the estimation. It can be
omitted from the request if no detectors have a `by_field_name`,
`over_field_name` or `partition_field_name`. + /// + /// Estimates of the cardinality that is observed for fields over the whole + /// time period that the job analyzes data. To produce a good answer, values + /// must be provided for fields referenced in the by_field_name, + /// over_field_name and partition_field_name of any detectors. Providing + /// values for other fields has no effect on the estimation. It can be + /// omitted from the request if no detectors have a by_field_name, + /// over_field_name or partition_field_name. + /// /// public EstimateModelMemoryRequestDescriptor OverallCardinality(Func, FluentDictionary> selector) { @@ -171,7 +215,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Estimate job model memory usage.
Makes an estimation of the memory usage for an anomaly detection job model.
It is based on analysis configuration details for the job and cardinality
estimates for the fields it references. +/// +/// Estimate job model memory usage. +/// Makes an estimation of the memory usage for an anomaly detection job model. +/// It is based on analysis configuration details for the job and cardinality +/// estimates for the fields it references. +/// /// public sealed partial class EstimateModelMemoryRequestDescriptor : RequestDescriptor { @@ -196,7 +245,10 @@ public EstimateModelMemoryRequestDescriptor() private IDictionary? OverallCardinalityValue { get; set; } /// - /// For a list of the properties that you can specify in the
`analysis_config` component of the body of this API. + /// + /// For a list of the properties that you can specify in the + /// analysis_config component of the body of this API. + /// /// public EstimateModelMemoryRequestDescriptor AnalysisConfig(Elastic.Clients.Elasticsearch.MachineLearning.AnalysisConfig? analysisConfig) { @@ -223,7 +275,13 @@ public EstimateModelMemoryRequestDescriptor AnalysisConfig(Action - /// Estimates of the highest cardinality in a single bucket that is observed
for influencer fields over the time period that the job analyzes data.
To produce a good answer, values must be provided for all influencer
fields. Providing values for fields that are not listed as `influencers`
has no effect on the estimation. + /// + /// Estimates of the highest cardinality in a single bucket that is observed + /// for influencer fields over the time period that the job analyzes data. + /// To produce a good answer, values must be provided for all influencer + /// fields. Providing values for fields that are not listed as influencers + /// has no effect on the estimation. + /// /// public EstimateModelMemoryRequestDescriptor MaxBucketCardinality(Func, FluentDictionary> selector) { @@ -232,7 +290,15 @@ public EstimateModelMemoryRequestDescriptor MaxBucketCardinality(Func - /// Estimates of the cardinality that is observed for fields over the whole
time period that the job analyzes data. To produce a good answer, values
must be provided for fields referenced in the `by_field_name`,
`over_field_name` and `partition_field_name` of any detectors. Providing
values for other fields has no effect on the estimation. It can be
omitted from the request if no detectors have a `by_field_name`,
`over_field_name` or `partition_field_name`. + /// + /// Estimates of the cardinality that is observed for fields over the whole + /// time period that the job analyzes data. To produce a good answer, values + /// must be provided for fields referenced in the by_field_name, + /// over_field_name and partition_field_name of any detectors. Providing + /// values for other fields has no effect on the estimation. It can be + /// omitted from the request if no detectors have a by_field_name, + /// over_field_name or partition_field_name. + /// /// public EstimateModelMemoryRequestDescriptor OverallCardinality(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/EvaluateDataFrameRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/EvaluateDataFrameRequest.g.cs index a704d661701..e1f537fdfcd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/EvaluateDataFrameRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/EvaluateDataFrameRequest.g.cs @@ -34,7 +34,13 @@ public sealed partial class EvaluateDataFrameRequestParameters : RequestParamete } /// -/// Evaluate data frame analytics.
The API packages together commonly used evaluation metrics for various types
of machine learning features. This has been designed for use on indexes
created by data frame analytics. Evaluation requires both a ground truth
field and an analytics result field to be present. +/// +/// Evaluate data frame analytics. +/// The API packages together commonly used evaluation metrics for various types +/// of machine learning features. This has been designed for use on indexes +/// created by data frame analytics. Evaluation requires both a ground truth +/// field and an analytics result field to be present. +/// /// public sealed partial class EvaluateDataFrameRequest : PlainRequest { @@ -47,26 +53,38 @@ public sealed partial class EvaluateDataFrameRequest : PlainRequest "ml.evaluate_data_frame"; /// - /// Defines the type of evaluation you want to perform. + /// + /// Defines the type of evaluation you want to perform. + /// /// [JsonInclude, JsonPropertyName("evaluation")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeEvaluation Evaluation { get; set; } /// - /// Defines the `index` in which the evaluation will be performed. + /// + /// Defines the index in which the evaluation will be performed. + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.IndexName Index { get; set; } /// - /// A query clause that retrieves a subset of data from the source index. + /// + /// A query clause that retrieves a subset of data from the source index. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Query { get; set; } } /// -/// Evaluate data frame analytics.
The API packages together commonly used evaluation metrics for various types
of machine learning features. This has been designed for use on indexes
created by data frame analytics. Evaluation requires both a ground truth
field and an analytics result field to be present. +/// +/// Evaluate data frame analytics. +/// The API packages together commonly used evaluation metrics for various types +/// of machine learning features. This has been designed for use on indexes +/// created by data frame analytics. Evaluation requires both a ground truth +/// field and an analytics result field to be present. +/// /// public sealed partial class EvaluateDataFrameRequestDescriptor : RequestDescriptor, EvaluateDataFrameRequestParameters> { @@ -93,7 +111,9 @@ public EvaluateDataFrameRequestDescriptor() private Action> QueryDescriptorAction { get; set; } /// - /// Defines the type of evaluation you want to perform. + /// + /// Defines the type of evaluation you want to perform. + /// /// public EvaluateDataFrameRequestDescriptor Evaluation(Elastic.Clients.Elasticsearch.MachineLearning.DataframeEvaluation evaluation) { @@ -120,7 +140,9 @@ public EvaluateDataFrameRequestDescriptor Evaluation(Action - /// Defines the `index` in which the evaluation will be performed. + /// + /// Defines the index in which the evaluation will be performed. + /// /// public EvaluateDataFrameRequestDescriptor Index(Elastic.Clients.Elasticsearch.IndexName index) { @@ -129,7 +151,9 @@ public EvaluateDataFrameRequestDescriptor Index(Elastic.Clients.Elast } /// - /// A query clause that retrieves a subset of data from the source index. + /// + /// A query clause that retrieves a subset of data from the source index. + /// /// public EvaluateDataFrameRequestDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -197,7 +221,13 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Evaluate data frame analytics.
The API packages together commonly used evaluation metrics for various types
of machine learning features. This has been designed for use on indexes
created by data frame analytics. Evaluation requires both a ground truth
field and an analytics result field to be present. +/// +/// Evaluate data frame analytics. +/// The API packages together commonly used evaluation metrics for various types +/// of machine learning features. This has been designed for use on indexes +/// created by data frame analytics. Evaluation requires both a ground truth +/// field and an analytics result field to be present. +/// /// public sealed partial class EvaluateDataFrameRequestDescriptor : RequestDescriptor { @@ -224,7 +254,9 @@ public EvaluateDataFrameRequestDescriptor() private Action QueryDescriptorAction { get; set; } /// - /// Defines the type of evaluation you want to perform. + /// + /// Defines the type of evaluation you want to perform. + /// /// public EvaluateDataFrameRequestDescriptor Evaluation(Elastic.Clients.Elasticsearch.MachineLearning.DataframeEvaluation evaluation) { @@ -251,7 +283,9 @@ public EvaluateDataFrameRequestDescriptor Evaluation(Action - /// Defines the `index` in which the evaluation will be performed. + /// + /// Defines the index in which the evaluation will be performed. + /// /// public EvaluateDataFrameRequestDescriptor Index(Elastic.Clients.Elasticsearch.IndexName index) { @@ -260,7 +294,9 @@ public EvaluateDataFrameRequestDescriptor Index(Elastic.Clients.Elasticsearch.In } /// - /// A query clause that retrieves a subset of data from the source index. + /// + /// A query clause that retrieves a subset of data from the source index. + /// /// public EvaluateDataFrameRequestDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ExplainDataFrameAnalyticsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ExplainDataFrameAnalyticsRequest.g.cs index f78900268ba..4666d9e8950 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ExplainDataFrameAnalyticsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ExplainDataFrameAnalyticsRequest.g.cs @@ -34,7 +34,25 @@ public sealed partial class ExplainDataFrameAnalyticsRequestParameters : Request } /// -/// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. +/// +/// Explain data frame analytics config. +/// This API provides explanations for a data frame analytics config that either +/// exists already or one that has not been created yet. The following +/// explanations are provided: +/// +/// +/// +/// +/// which fields are included or not in the analysis and why, +/// +/// +/// +/// +/// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. +/// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. +/// +/// +/// /// public sealed partial class ExplainDataFrameAnalyticsRequest : PlainRequest { @@ -55,56 +73,106 @@ public ExplainDataFrameAnalyticsRequest(Elastic.Clients.Elasticsearch.Id? id) : internal override string OperationName => "ml.explain_data_frame_analytics"; /// - /// Specifies whether this job can start when there is insufficient machine
learning node capacity for it to be immediately assigned to a node. + /// + /// Specifies whether this job can start when there is insufficient machine + /// learning node capacity for it to be immediately assigned to a node. + /// /// [JsonInclude, JsonPropertyName("allow_lazy_start")] public bool? AllowLazyStart { get; set; } /// - /// The analysis configuration, which contains the information necessary to
perform one of the following types of analysis: classification, outlier
detection, or regression. + /// + /// The analysis configuration, which contains the information necessary to + /// perform one of the following types of analysis: classification, outlier + /// detection, or regression. + /// /// [JsonInclude, JsonPropertyName("analysis")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalysis? Analysis { get; set; } /// - /// Specify includes and/or excludes patterns to select which fields will be
included in the analysis. The patterns specified in excludes are applied
last, therefore excludes takes precedence. In other words, if the same
field is specified in both includes and excludes, then the field will not
be included in the analysis. + /// + /// Specify includes and/or excludes patterns to select which fields will be + /// included in the analysis. The patterns specified in excludes are applied + /// last, therefore excludes takes precedence. In other words, if the same + /// field is specified in both includes and excludes, then the field will not + /// be included in the analysis. + /// /// [JsonInclude, JsonPropertyName("analyzed_fields")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalysisAnalyzedFields? AnalyzedFields { get; set; } /// - /// A description of the job. + /// + /// A description of the job. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The destination configuration, consisting of index and optionally
results_field (ml by default). + /// + /// The destination configuration, consisting of index and optionally + /// results_field (ml by default). + /// /// [JsonInclude, JsonPropertyName("dest")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalyticsDestination? Dest { get; set; } /// - /// The maximum number of threads to be used by the analysis. Using more
threads may decrease the time necessary to complete the analysis at the
cost of using more CPU. Note that the process may use additional threads
for operational functionality other than the analysis itself. + /// + /// The maximum number of threads to be used by the analysis. Using more + /// threads may decrease the time necessary to complete the analysis at the + /// cost of using more CPU. Note that the process may use additional threads + /// for operational functionality other than the analysis itself. + /// /// [JsonInclude, JsonPropertyName("max_num_threads")] public int? MaxNumThreads { get; set; } /// - /// The approximate maximum amount of memory resources that are permitted for
analytical processing. If your `elasticsearch.yml` file contains an
`xpack.ml.max_model_memory_limit` setting, an error occurs when you try to
create data frame analytics jobs that have `model_memory_limit` values
greater than that setting. + /// + /// The approximate maximum amount of memory resources that are permitted for + /// analytical processing. If your elasticsearch.yml file contains an + /// xpack.ml.max_model_memory_limit setting, an error occurs when you try to + /// create data frame analytics jobs that have model_memory_limit values + /// greater than that setting. + /// /// [JsonInclude, JsonPropertyName("model_memory_limit")] public string? ModelMemoryLimit { get; set; } /// - /// The configuration of how to source the analysis data. It requires an
index. Optionally, query and _source may be specified. + /// + /// The configuration of how to source the analysis data. It requires an + /// index. Optionally, query and _source may be specified. + /// /// [JsonInclude, JsonPropertyName("source")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalyticsSource? Source { get; set; } } /// -/// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. +/// +/// Explain data frame analytics config. +/// This API provides explanations for a data frame analytics config that either +/// exists already or one that has not been created yet. The following +/// explanations are provided: +/// +/// +/// +/// +/// which fields are included or not in the analysis and why, +/// +/// +/// +/// +/// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. +/// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. +/// +/// +/// /// public sealed partial class ExplainDataFrameAnalyticsRequestDescriptor : RequestDescriptor, ExplainDataFrameAnalyticsRequestParameters> { @@ -150,7 +218,10 @@ public ExplainDataFrameAnalyticsRequestDescriptor Id(Elastic.Clients. private Action> SourceDescriptorAction { get; set; } /// - /// Specifies whether this job can start when there is insufficient machine
learning node capacity for it to be immediately assigned to a node. + /// + /// Specifies whether this job can start when there is insufficient machine + /// learning node capacity for it to be immediately assigned to a node. + /// /// public ExplainDataFrameAnalyticsRequestDescriptor AllowLazyStart(bool? allowLazyStart = true) { @@ -159,7 +230,11 @@ public ExplainDataFrameAnalyticsRequestDescriptor AllowLazyStart(bool } /// - /// The analysis configuration, which contains the information necessary to
perform one of the following types of analysis: classification, outlier
detection, or regression. + /// + /// The analysis configuration, which contains the information necessary to + /// perform one of the following types of analysis: classification, outlier + /// detection, or regression. + /// /// public ExplainDataFrameAnalyticsRequestDescriptor Analysis(Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalysis? analysis) { @@ -186,7 +261,13 @@ public ExplainDataFrameAnalyticsRequestDescriptor Analysis(Action - /// Specify includes and/or excludes patterns to select which fields will be
included in the analysis. The patterns specified in excludes are applied
last, therefore excludes takes precedence. In other words, if the same
field is specified in both includes and excludes, then the field will not
be included in the analysis. + /// + /// Specify includes and/or excludes patterns to select which fields will be + /// included in the analysis. The patterns specified in excludes are applied + /// last, therefore excludes takes precedence. In other words, if the same + /// field is specified in both includes and excludes, then the field will not + /// be included in the analysis. + /// /// public ExplainDataFrameAnalyticsRequestDescriptor AnalyzedFields(Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalysisAnalyzedFields? analyzedFields) { @@ -213,7 +294,9 @@ public ExplainDataFrameAnalyticsRequestDescriptor AnalyzedFields(Acti } /// - /// A description of the job. + /// + /// A description of the job. + /// /// public ExplainDataFrameAnalyticsRequestDescriptor Description(string? description) { @@ -222,7 +305,10 @@ public ExplainDataFrameAnalyticsRequestDescriptor Description(string? } /// - /// The destination configuration, consisting of index and optionally
results_field (ml by default). + /// + /// The destination configuration, consisting of index and optionally + /// results_field (ml by default). + /// /// public ExplainDataFrameAnalyticsRequestDescriptor Dest(Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalyticsDestination? dest) { @@ -249,7 +335,12 @@ public ExplainDataFrameAnalyticsRequestDescriptor Dest(Action - /// The maximum number of threads to be used by the analysis. Using more
threads may decrease the time necessary to complete the analysis at the
cost of using more CPU. Note that the process may use additional threads
for operational functionality other than the analysis itself. + /// + /// The maximum number of threads to be used by the analysis. Using more + /// threads may decrease the time necessary to complete the analysis at the + /// cost of using more CPU. Note that the process may use additional threads + /// for operational functionality other than the analysis itself. + /// /// public ExplainDataFrameAnalyticsRequestDescriptor MaxNumThreads(int? maxNumThreads) { @@ -258,7 +349,13 @@ public ExplainDataFrameAnalyticsRequestDescriptor MaxNumThreads(int? } /// - /// The approximate maximum amount of memory resources that are permitted for
analytical processing. If your `elasticsearch.yml` file contains an
`xpack.ml.max_model_memory_limit` setting, an error occurs when you try to
create data frame analytics jobs that have `model_memory_limit` values
greater than that setting. + /// + /// The approximate maximum amount of memory resources that are permitted for + /// analytical processing. If your elasticsearch.yml file contains an + /// xpack.ml.max_model_memory_limit setting, an error occurs when you try to + /// create data frame analytics jobs that have model_memory_limit values + /// greater than that setting. + /// /// public ExplainDataFrameAnalyticsRequestDescriptor ModelMemoryLimit(string? modelMemoryLimit) { @@ -267,7 +364,10 @@ public ExplainDataFrameAnalyticsRequestDescriptor ModelMemoryLimit(st } /// - /// The configuration of how to source the analysis data. It requires an
index. Optionally, query and _source may be specified. + /// + /// The configuration of how to source the analysis data. It requires an + /// index. Optionally, query and _source may be specified. + /// /// public ExplainDataFrameAnalyticsRequestDescriptor Source(Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalyticsSource? source) { @@ -389,7 +489,25 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. +/// +/// Explain data frame analytics config. +/// This API provides explanations for a data frame analytics config that either +/// exists already or one that has not been created yet. The following +/// explanations are provided: +/// +/// +/// +/// +/// which fields are included or not in the analysis and why, +/// +/// +/// +/// +/// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. +/// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. +/// +/// +/// /// public sealed partial class ExplainDataFrameAnalyticsRequestDescriptor : RequestDescriptor { @@ -435,7 +553,10 @@ public ExplainDataFrameAnalyticsRequestDescriptor Id(Elastic.Clients.Elasticsear private Action SourceDescriptorAction { get; set; } /// - /// Specifies whether this job can start when there is insufficient machine
learning node capacity for it to be immediately assigned to a node. + /// + /// Specifies whether this job can start when there is insufficient machine + /// learning node capacity for it to be immediately assigned to a node. + /// /// public ExplainDataFrameAnalyticsRequestDescriptor AllowLazyStart(bool? allowLazyStart = true) { @@ -444,7 +565,11 @@ public ExplainDataFrameAnalyticsRequestDescriptor AllowLazyStart(bool? allowLazy } /// - /// The analysis configuration, which contains the information necessary to
perform one of the following types of analysis: classification, outlier
detection, or regression. + /// + /// The analysis configuration, which contains the information necessary to + /// perform one of the following types of analysis: classification, outlier + /// detection, or regression. + /// /// public ExplainDataFrameAnalyticsRequestDescriptor Analysis(Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalysis? analysis) { @@ -471,7 +596,13 @@ public ExplainDataFrameAnalyticsRequestDescriptor Analysis(Action - /// Specify includes and/or excludes patterns to select which fields will be
included in the analysis. The patterns specified in excludes are applied
last, therefore excludes takes precedence. In other words, if the same
field is specified in both includes and excludes, then the field will not
be included in the analysis. + /// + /// Specify includes and/or excludes patterns to select which fields will be + /// included in the analysis. The patterns specified in excludes are applied + /// last, therefore excludes takes precedence. In other words, if the same + /// field is specified in both includes and excludes, then the field will not + /// be included in the analysis. + /// /// public ExplainDataFrameAnalyticsRequestDescriptor AnalyzedFields(Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalysisAnalyzedFields? analyzedFields) { @@ -498,7 +629,9 @@ public ExplainDataFrameAnalyticsRequestDescriptor AnalyzedFields(Action - /// A description of the job. + /// + /// A description of the job. + /// /// public ExplainDataFrameAnalyticsRequestDescriptor Description(string? description) { @@ -507,7 +640,10 @@ public ExplainDataFrameAnalyticsRequestDescriptor Description(string? descriptio } /// - /// The destination configuration, consisting of index and optionally
results_field (ml by default). + /// + /// The destination configuration, consisting of index and optionally + /// results_field (ml by default). + /// /// public ExplainDataFrameAnalyticsRequestDescriptor Dest(Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalyticsDestination? dest) { @@ -534,7 +670,12 @@ public ExplainDataFrameAnalyticsRequestDescriptor Dest(Action - /// The maximum number of threads to be used by the analysis. Using more
threads may decrease the time necessary to complete the analysis at the
cost of using more CPU. Note that the process may use additional threads
for operational functionality other than the analysis itself. + /// + /// The maximum number of threads to be used by the analysis. Using more + /// threads may decrease the time necessary to complete the analysis at the + /// cost of using more CPU. Note that the process may use additional threads + /// for operational functionality other than the analysis itself. + /// /// public ExplainDataFrameAnalyticsRequestDescriptor MaxNumThreads(int? maxNumThreads) { @@ -543,7 +684,13 @@ public ExplainDataFrameAnalyticsRequestDescriptor MaxNumThreads(int? maxNumThrea } /// - /// The approximate maximum amount of memory resources that are permitted for
analytical processing. If your `elasticsearch.yml` file contains an
`xpack.ml.max_model_memory_limit` setting, an error occurs when you try to
create data frame analytics jobs that have `model_memory_limit` values
greater than that setting. + /// + /// The approximate maximum amount of memory resources that are permitted for + /// analytical processing. If your elasticsearch.yml file contains an + /// xpack.ml.max_model_memory_limit setting, an error occurs when you try to + /// create data frame analytics jobs that have model_memory_limit values + /// greater than that setting. + /// /// public ExplainDataFrameAnalyticsRequestDescriptor ModelMemoryLimit(string? modelMemoryLimit) { @@ -552,7 +699,10 @@ public ExplainDataFrameAnalyticsRequestDescriptor ModelMemoryLimit(string? model } /// - /// The configuration of how to source the analysis data. It requires an
index. Optionally, query and _source may be specified. + /// + /// The configuration of how to source the analysis data. It requires an + /// index. Optionally, query and _source may be specified. + /// /// public ExplainDataFrameAnalyticsRequestDescriptor Source(Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalyticsSource? source) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ExplainDataFrameAnalyticsResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ExplainDataFrameAnalyticsResponse.g.cs index ad528abbf72..9538fde34a2 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ExplainDataFrameAnalyticsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ExplainDataFrameAnalyticsResponse.g.cs @@ -29,13 +29,17 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class ExplainDataFrameAnalyticsResponse : ElasticsearchResponse { /// - /// An array of objects that explain selection for each field, sorted by the field names. + /// + /// An array of objects that explain selection for each field, sorted by the field names. + /// /// [JsonInclude, JsonPropertyName("field_selection")] public IReadOnlyCollection FieldSelection { get; init; } /// - /// An array of objects that explain selection for each field, sorted by the field names. + /// + /// An array of objects that explain selection for each field, sorted by the field names. + /// /// [JsonInclude, JsonPropertyName("memory_estimation")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalyticsMemoryEstimation MemoryEstimation { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/FlushJobRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/FlushJobRequest.g.cs index e809e475d54..12881bc3bd7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/FlushJobRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/FlushJobRequest.g.cs @@ -34,7 +34,17 @@ public sealed partial class FlushJobRequestParameters : RequestParameters } /// -/// Forces any buffered data to be processed by the job.
The flush jobs API is only applicable when sending data for analysis using
the post data API. Depending on the content of the buffer, then it might
additionally calculate new results. Both flush and close operations are
similar, however the flush is more efficient if you are expecting to send
more data for analysis. When flushing, the job remains open and is available
to continue analyzing data. A close operation additionally prunes and
persists the model state to disk and the job must be opened again before
analyzing further data. +/// +/// Forces any buffered data to be processed by the job. +/// The flush jobs API is only applicable when sending data for analysis using +/// the post data API. Depending on the content of the buffer, then it might +/// additionally calculate new results. Both flush and close operations are +/// similar, however the flush is more efficient if you are expecting to send +/// more data for analysis. When flushing, the job remains open and is available +/// to continue analyzing data. A close operation additionally prunes and +/// persists the model state to disk and the job must be opened again before +/// analyzing further data. +/// /// public sealed partial class FlushJobRequest : PlainRequest { @@ -51,38 +61,58 @@ public FlushJobRequest(Elastic.Clients.Elasticsearch.Id jobId) : base(r => r.Req internal override string OperationName => "ml.flush_job"; /// - /// Refer to the description for the `advance_time` query parameter. + /// + /// Refer to the description for the advance_time query parameter. + /// /// [JsonInclude, JsonPropertyName("advance_time")] public DateTimeOffset? AdvanceTime { get; set; } /// - /// Refer to the description for the `calc_interim` query parameter. + /// + /// Refer to the description for the calc_interim query parameter. + /// /// [JsonInclude, JsonPropertyName("calc_interim")] public bool? CalcInterim { get; set; } /// - /// Refer to the description for the `end` query parameter. + /// + /// Refer to the description for the end query parameter. + /// /// [JsonInclude, JsonPropertyName("end")] public DateTimeOffset? End { get; set; } /// - /// Refer to the description for the `skip_time` query parameter. + /// + /// Refer to the description for the skip_time query parameter. + /// /// [JsonInclude, JsonPropertyName("skip_time")] public DateTimeOffset? SkipTime { get; set; } /// - /// Refer to the description for the `start` query parameter. + /// + /// Refer to the description for the start query parameter. + /// /// [JsonInclude, JsonPropertyName("start")] public DateTimeOffset? Start { get; set; } } /// -/// Forces any buffered data to be processed by the job.
The flush jobs API is only applicable when sending data for analysis using
the post data API. Depending on the content of the buffer, then it might
additionally calculate new results. Both flush and close operations are
similar, however the flush is more efficient if you are expecting to send
more data for analysis. When flushing, the job remains open and is available
to continue analyzing data. A close operation additionally prunes and
persists the model state to disk and the job must be opened again before
analyzing further data. +/// +/// Forces any buffered data to be processed by the job. +/// The flush jobs API is only applicable when sending data for analysis using +/// the post data API. Depending on the content of the buffer, then it might +/// additionally calculate new results. Both flush and close operations are +/// similar, however the flush is more efficient if you are expecting to send +/// more data for analysis. When flushing, the job remains open and is available +/// to continue analyzing data. A close operation additionally prunes and +/// persists the model state to disk and the job must be opened again before +/// analyzing further data. +/// /// public sealed partial class FlushJobRequestDescriptor : RequestDescriptor { @@ -113,7 +143,9 @@ public FlushJobRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Id jobId) private DateTimeOffset? StartValue { get; set; } /// - /// Refer to the description for the `advance_time` query parameter. + /// + /// Refer to the description for the advance_time query parameter. + /// /// public FlushJobRequestDescriptor AdvanceTime(DateTimeOffset? advanceTime) { @@ -122,7 +154,9 @@ public FlushJobRequestDescriptor AdvanceTime(DateTimeOffset? advanceTime) } /// - /// Refer to the description for the `calc_interim` query parameter. + /// + /// Refer to the description for the calc_interim query parameter. + /// /// public FlushJobRequestDescriptor CalcInterim(bool? calcInterim = true) { @@ -131,7 +165,9 @@ public FlushJobRequestDescriptor CalcInterim(bool? calcInterim = true) } /// - /// Refer to the description for the `end` query parameter. + /// + /// Refer to the description for the end query parameter. + /// /// public FlushJobRequestDescriptor End(DateTimeOffset? end) { @@ -140,7 +176,9 @@ public FlushJobRequestDescriptor End(DateTimeOffset? end) } /// - /// Refer to the description for the `skip_time` query parameter. + /// + /// Refer to the description for the skip_time query parameter. + /// /// public FlushJobRequestDescriptor SkipTime(DateTimeOffset? skipTime) { @@ -149,7 +187,9 @@ public FlushJobRequestDescriptor SkipTime(DateTimeOffset? skipTime) } /// - /// Refer to the description for the `start` query parameter. + /// + /// Refer to the description for the start query parameter. + /// /// public FlushJobRequestDescriptor Start(DateTimeOffset? start) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/FlushJobResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/FlushJobResponse.g.cs index 15b7c579122..ad4776b1c49 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/FlushJobResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/FlushJobResponse.g.cs @@ -32,7 +32,10 @@ public sealed partial class FlushJobResponse : ElasticsearchResponse public bool Flushed { get; init; } /// - /// Provides the timestamp (in milliseconds since the epoch) of the end of
the last bucket that was processed. + /// + /// Provides the timestamp (in milliseconds since the epoch) of the end of + /// the last bucket that was processed. + /// /// [JsonInclude, JsonPropertyName("last_finalized_bucket_end")] public int? LastFinalizedBucketEnd { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ForecastRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ForecastRequest.g.cs index 2096e1459af..5edb692fe63 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ForecastRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ForecastRequest.g.cs @@ -34,8 +34,15 @@ public sealed partial class ForecastRequestParameters : RequestParameters } /// -/// Predicts the future behavior of a time series by using its historical
behavior. -/// Forecasts are not supported for jobs that perform population analysis; an
error occurs if you try to create a forecast for a job that has an
`over_field_name` in its configuration. +/// +/// Predicts the future behavior of a time series by using its historical +/// behavior. +/// +/// +/// Forecasts are not supported for jobs that perform population analysis; an +/// error occurs if you try to create a forecast for a job that has an +/// over_field_name in its configuration. +/// /// public sealed partial class ForecastRequest : PlainRequest { @@ -52,27 +59,40 @@ public ForecastRequest(Elastic.Clients.Elasticsearch.Id jobId) : base(r => r.Req internal override string OperationName => "ml.forecast"; /// - /// Refer to the description for the `duration` query parameter. + /// + /// Refer to the description for the duration query parameter. + /// /// [JsonInclude, JsonPropertyName("duration")] public Elastic.Clients.Elasticsearch.Duration? Duration { get; set; } /// - /// Refer to the description for the `expires_in` query parameter. + /// + /// Refer to the description for the expires_in query parameter. + /// /// [JsonInclude, JsonPropertyName("expires_in")] public Elastic.Clients.Elasticsearch.Duration? ExpiresIn { get; set; } /// - /// Refer to the description for the `max_model_memory` query parameter. + /// + /// Refer to the description for the max_model_memory query parameter. + /// /// [JsonInclude, JsonPropertyName("max_model_memory")] public string? MaxModelMemory { get; set; } } /// -/// Predicts the future behavior of a time series by using its historical
behavior. -/// Forecasts are not supported for jobs that perform population analysis; an
error occurs if you try to create a forecast for a job that has an
`over_field_name` in its configuration. +/// +/// Predicts the future behavior of a time series by using its historical +/// behavior. +/// +/// +/// Forecasts are not supported for jobs that perform population analysis; an +/// error occurs if you try to create a forecast for a job that has an +/// over_field_name in its configuration. +/// /// public sealed partial class ForecastRequestDescriptor : RequestDescriptor { @@ -101,7 +121,9 @@ public ForecastRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Id jobId) private string? MaxModelMemoryValue { get; set; } /// - /// Refer to the description for the `duration` query parameter. + /// + /// Refer to the description for the duration query parameter. + /// /// public ForecastRequestDescriptor Duration(Elastic.Clients.Elasticsearch.Duration? duration) { @@ -110,7 +132,9 @@ public ForecastRequestDescriptor Duration(Elastic.Clients.Elasticsearch.Duration } /// - /// Refer to the description for the `expires_in` query parameter. + /// + /// Refer to the description for the expires_in query parameter. + /// /// public ForecastRequestDescriptor ExpiresIn(Elastic.Clients.Elasticsearch.Duration? expiresIn) { @@ -119,7 +143,9 @@ public ForecastRequestDescriptor ExpiresIn(Elastic.Clients.Elasticsearch.Duratio } /// - /// Refer to the description for the `max_model_memory` query parameter. + /// + /// Refer to the description for the max_model_memory query parameter. + /// /// public ForecastRequestDescriptor MaxModelMemory(string? maxModelMemory) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetBucketsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetBucketsRequest.g.cs index eabf6d5c27e..57d7007e744 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetBucketsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetBucketsRequest.g.cs @@ -32,18 +32,25 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class GetBucketsRequestParameters : RequestParameters { /// - /// Skips the specified number of buckets. + /// + /// Skips the specified number of buckets. + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of buckets to obtain. + /// + /// Specifies the maximum number of buckets to obtain. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. +/// +/// Retrieves anomaly detection job results for one or more buckets. +/// The API presents a chronological view of the records, grouped by bucket. +/// /// public sealed partial class GetBucketsRequest : PlainRequest { @@ -64,43 +71,57 @@ public GetBucketsRequest(Elastic.Clients.Elasticsearch.Id jobId) : base(r => r.R internal override string OperationName => "ml.get_buckets"; /// - /// Skips the specified number of buckets. + /// + /// Skips the specified number of buckets. + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of buckets to obtain. + /// + /// Specifies the maximum number of buckets to obtain. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } /// - /// Refer to the description for the `anomaly_score` query parameter. + /// + /// Refer to the description for the anomaly_score query parameter. + /// /// [JsonInclude, JsonPropertyName("anomaly_score")] public double? AnomalyScore { get; set; } /// - /// Refer to the description for the `desc` query parameter. + /// + /// Refer to the description for the desc query parameter. + /// /// [JsonInclude, JsonPropertyName("desc")] public bool? Desc { get; set; } /// - /// Refer to the description for the `end` query parameter. + /// + /// Refer to the description for the end query parameter. + /// /// [JsonInclude, JsonPropertyName("end")] public DateTimeOffset? End { get; set; } /// - /// Refer to the description for the `exclude_interim` query parameter. + /// + /// Refer to the description for the exclude_interim query parameter. + /// /// [JsonInclude, JsonPropertyName("exclude_interim")] public bool? ExcludeInterim { get; set; } /// - /// Refer to the description for the `expand` query parameter. + /// + /// Refer to the description for the expand query parameter. + /// /// [JsonInclude, JsonPropertyName("expand")] public bool? Expand { get; set; } @@ -108,20 +129,27 @@ public GetBucketsRequest(Elastic.Clients.Elasticsearch.Id jobId) : base(r => r.R public Elastic.Clients.Elasticsearch.MachineLearning.Page? Page { get; set; } /// - /// Refer to the desription for the `sort` query parameter. + /// + /// Refer to the desription for the sort query parameter. + /// /// [JsonInclude, JsonPropertyName("sort")] public Elastic.Clients.Elasticsearch.Field? Sort { get; set; } /// - /// Refer to the description for the `start` query parameter. + /// + /// Refer to the description for the start query parameter. + /// /// [JsonInclude, JsonPropertyName("start")] public DateTimeOffset? Start { get; set; } } /// -/// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. +/// +/// Retrieves anomaly detection job results for one or more buckets. +/// The API presents a chronological view of the records, grouped by bucket. +/// /// public sealed partial class GetBucketsRequestDescriptor : RequestDescriptor, GetBucketsRequestParameters> { @@ -170,7 +198,9 @@ public GetBucketsRequestDescriptor Timestamp(DateTimeOffset? timestam private DateTimeOffset? StartValue { get; set; } /// - /// Refer to the description for the `anomaly_score` query parameter. + /// + /// Refer to the description for the anomaly_score query parameter. + /// /// public GetBucketsRequestDescriptor AnomalyScore(double? anomalyScore) { @@ -179,7 +209,9 @@ public GetBucketsRequestDescriptor AnomalyScore(double? anomalyScore) } /// - /// Refer to the description for the `desc` query parameter. + /// + /// Refer to the description for the desc query parameter. + /// /// public GetBucketsRequestDescriptor Desc(bool? desc = true) { @@ -188,7 +220,9 @@ public GetBucketsRequestDescriptor Desc(bool? desc = true) } /// - /// Refer to the description for the `end` query parameter. + /// + /// Refer to the description for the end query parameter. + /// /// public GetBucketsRequestDescriptor End(DateTimeOffset? end) { @@ -197,7 +231,9 @@ public GetBucketsRequestDescriptor End(DateTimeOffset? end) } /// - /// Refer to the description for the `exclude_interim` query parameter. + /// + /// Refer to the description for the exclude_interim query parameter. + /// /// public GetBucketsRequestDescriptor ExcludeInterim(bool? excludeInterim = true) { @@ -206,7 +242,9 @@ public GetBucketsRequestDescriptor ExcludeInterim(bool? excludeInteri } /// - /// Refer to the description for the `expand` query parameter. + /// + /// Refer to the description for the expand query parameter. + /// /// public GetBucketsRequestDescriptor Expand(bool? expand = true) { @@ -239,7 +277,9 @@ public GetBucketsRequestDescriptor Page(Action - /// Refer to the desription for the `sort` query parameter. + /// + /// Refer to the desription for the sort query parameter. + /// /// public GetBucketsRequestDescriptor Sort(Elastic.Clients.Elasticsearch.Field? sort) { @@ -248,7 +288,9 @@ public GetBucketsRequestDescriptor Sort(Elastic.Clients.Elasticsearch } /// - /// Refer to the desription for the `sort` query parameter. + /// + /// Refer to the desription for the sort query parameter. + /// /// public GetBucketsRequestDescriptor Sort(Expression> sort) { @@ -257,7 +299,9 @@ public GetBucketsRequestDescriptor Sort(Expression - /// Refer to the desription for the `sort` query parameter. + /// + /// Refer to the desription for the sort query parameter. + /// /// public GetBucketsRequestDescriptor Sort(Expression> sort) { @@ -266,7 +310,9 @@ public GetBucketsRequestDescriptor Sort(Expression - /// Refer to the description for the `start` query parameter. + /// + /// Refer to the description for the start query parameter. + /// /// public GetBucketsRequestDescriptor Start(DateTimeOffset? start) { @@ -340,7 +386,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. +/// +/// Retrieves anomaly detection job results for one or more buckets. +/// The API presents a chronological view of the records, grouped by bucket. +/// /// public sealed partial class GetBucketsRequestDescriptor : RequestDescriptor { @@ -389,7 +438,9 @@ public GetBucketsRequestDescriptor Timestamp(DateTimeOffset? timestamp) private DateTimeOffset? StartValue { get; set; } /// - /// Refer to the description for the `anomaly_score` query parameter. + /// + /// Refer to the description for the anomaly_score query parameter. + /// /// public GetBucketsRequestDescriptor AnomalyScore(double? anomalyScore) { @@ -398,7 +449,9 @@ public GetBucketsRequestDescriptor AnomalyScore(double? anomalyScore) } /// - /// Refer to the description for the `desc` query parameter. + /// + /// Refer to the description for the desc query parameter. + /// /// public GetBucketsRequestDescriptor Desc(bool? desc = true) { @@ -407,7 +460,9 @@ public GetBucketsRequestDescriptor Desc(bool? desc = true) } /// - /// Refer to the description for the `end` query parameter. + /// + /// Refer to the description for the end query parameter. + /// /// public GetBucketsRequestDescriptor End(DateTimeOffset? end) { @@ -416,7 +471,9 @@ public GetBucketsRequestDescriptor End(DateTimeOffset? end) } /// - /// Refer to the description for the `exclude_interim` query parameter. + /// + /// Refer to the description for the exclude_interim query parameter. + /// /// public GetBucketsRequestDescriptor ExcludeInterim(bool? excludeInterim = true) { @@ -425,7 +482,9 @@ public GetBucketsRequestDescriptor ExcludeInterim(bool? excludeInterim = true) } /// - /// Refer to the description for the `expand` query parameter. + /// + /// Refer to the description for the expand query parameter. + /// /// public GetBucketsRequestDescriptor Expand(bool? expand = true) { @@ -458,7 +517,9 @@ public GetBucketsRequestDescriptor Page(Action - /// Refer to the desription for the `sort` query parameter. + /// + /// Refer to the desription for the sort query parameter. + /// /// public GetBucketsRequestDescriptor Sort(Elastic.Clients.Elasticsearch.Field? sort) { @@ -467,7 +528,9 @@ public GetBucketsRequestDescriptor Sort(Elastic.Clients.Elasticsearch.Field? sor } /// - /// Refer to the desription for the `sort` query parameter. + /// + /// Refer to the desription for the sort query parameter. + /// /// public GetBucketsRequestDescriptor Sort(Expression> sort) { @@ -476,7 +539,9 @@ public GetBucketsRequestDescriptor Sort(Expression - /// Refer to the desription for the `sort` query parameter. + /// + /// Refer to the desription for the sort query parameter. + /// /// public GetBucketsRequestDescriptor Sort(Expression> sort) { @@ -485,7 +550,9 @@ public GetBucketsRequestDescriptor Sort(Expression - /// Refer to the description for the `start` query parameter. + /// + /// Refer to the description for the start query parameter. + /// /// public GetBucketsRequestDescriptor Start(DateTimeOffset? start) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetCalendarEventsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetCalendarEventsRequest.g.cs index 7603b8839e1..86d31a17c4f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetCalendarEventsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetCalendarEventsRequest.g.cs @@ -32,33 +32,45 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class GetCalendarEventsRequestParameters : RequestParameters { /// - /// Specifies to get events with timestamps earlier than this time. + /// + /// Specifies to get events with timestamps earlier than this time. + /// /// public DateTimeOffset? End { get => Q("end"); set => Q("end", value); } /// - /// Skips the specified number of events. + /// + /// Skips the specified number of events. + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies to get events for a specific anomaly detection job identifier or job group. It must be used with a calendar identifier of `_all` or `*`. + /// + /// Specifies to get events for a specific anomaly detection job identifier or job group. It must be used with a calendar identifier of _all or *. + /// /// public Elastic.Clients.Elasticsearch.Id? JobId { get => Q("job_id"); set => Q("job_id", value); } /// - /// Specifies the maximum number of events to obtain. + /// + /// Specifies the maximum number of events to obtain. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } /// - /// Specifies to get events with timestamps after this time. + /// + /// Specifies to get events with timestamps after this time. + /// /// public DateTimeOffset? Start { get => Q("start"); set => Q("start", value); } } /// -/// Retrieves information about the scheduled events in calendars. +/// +/// Retrieves information about the scheduled events in calendars. +/// /// public sealed partial class GetCalendarEventsRequest : PlainRequest { @@ -75,38 +87,50 @@ public GetCalendarEventsRequest(Elastic.Clients.Elasticsearch.Id calendarId) : b internal override string OperationName => "ml.get_calendar_events"; /// - /// Specifies to get events with timestamps earlier than this time. + /// + /// Specifies to get events with timestamps earlier than this time. + /// /// [JsonIgnore] public DateTimeOffset? End { get => Q("end"); set => Q("end", value); } /// - /// Skips the specified number of events. + /// + /// Skips the specified number of events. + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies to get events for a specific anomaly detection job identifier or job group. It must be used with a calendar identifier of `_all` or `*`. + /// + /// Specifies to get events for a specific anomaly detection job identifier or job group. It must be used with a calendar identifier of _all or *. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Id? JobId { get => Q("job_id"); set => Q("job_id", value); } /// - /// Specifies the maximum number of events to obtain. + /// + /// Specifies the maximum number of events to obtain. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } /// - /// Specifies to get events with timestamps after this time. + /// + /// Specifies to get events with timestamps after this time. + /// /// [JsonIgnore] public DateTimeOffset? Start { get => Q("start"); set => Q("start", value); } } /// -/// Retrieves information about the scheduled events in calendars. +/// +/// Retrieves information about the scheduled events in calendars. +/// /// public sealed partial class GetCalendarEventsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetCalendarsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetCalendarsRequest.g.cs index cdd39f489e3..fcaa3d872dc 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetCalendarsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetCalendarsRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class GetCalendarsRequestParameters : RequestParameters { /// - /// Skips the specified number of calendars. This parameter is supported only when you omit the calendar identifier. + /// + /// Skips the specified number of calendars. This parameter is supported only when you omit the calendar identifier. + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the calendar identifier. + /// + /// Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the calendar identifier. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Retrieves configuration information for calendars. +/// +/// Retrieves configuration information for calendars. +/// /// public sealed partial class GetCalendarsRequest : PlainRequest { @@ -64,26 +70,34 @@ public GetCalendarsRequest(Elastic.Clients.Elasticsearch.Id? calendarId) : base( internal override string OperationName => "ml.get_calendars"; /// - /// Skips the specified number of calendars. This parameter is supported only when you omit the calendar identifier. + /// + /// Skips the specified number of calendars. This parameter is supported only when you omit the calendar identifier. + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the calendar identifier. + /// + /// Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the calendar identifier. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } /// - /// This object is supported only when you omit the calendar identifier. + /// + /// This object is supported only when you omit the calendar identifier. + /// /// [JsonInclude, JsonPropertyName("page")] public Elastic.Clients.Elasticsearch.MachineLearning.Page? Page { get; set; } } /// -/// Retrieves configuration information for calendars. +/// +/// Retrieves configuration information for calendars. +/// /// public sealed partial class GetCalendarsRequestDescriptor : RequestDescriptor { @@ -119,7 +133,9 @@ public GetCalendarsRequestDescriptor CalendarId(Elastic.Clients.Elasticsearch.Id private Action PageDescriptorAction { get; set; } /// - /// This object is supported only when you omit the calendar identifier. + /// + /// This object is supported only when you omit the calendar identifier. + /// /// public GetCalendarsRequestDescriptor Page(Elastic.Clients.Elasticsearch.MachineLearning.Page? page) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetCategoriesRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetCategoriesRequest.g.cs index bca475cdf32..5182991fbf8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetCategoriesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetCategoriesRequest.g.cs @@ -32,23 +32,31 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class GetCategoriesRequestParameters : RequestParameters { /// - /// Skips the specified number of categories. + /// + /// Skips the specified number of categories. + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// Only return categories for the specified partition. + /// + /// Only return categories for the specified partition. + /// /// public string? PartitionFieldValue { get => Q("partition_field_value"); set => Q("partition_field_value", value); } /// - /// Specifies the maximum number of categories to obtain. + /// + /// Specifies the maximum number of categories to obtain. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Retrieves anomaly detection job results for one or more categories. +/// +/// Retrieves anomaly detection job results for one or more categories. +/// /// public sealed partial class GetCategoriesRequest : PlainRequest { @@ -69,32 +77,43 @@ public GetCategoriesRequest(Elastic.Clients.Elasticsearch.Id jobId) : base(r => internal override string OperationName => "ml.get_categories"; /// - /// Skips the specified number of categories. + /// + /// Skips the specified number of categories. + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// Only return categories for the specified partition. + /// + /// Only return categories for the specified partition. + /// /// [JsonIgnore] public string? PartitionFieldValue { get => Q("partition_field_value"); set => Q("partition_field_value", value); } /// - /// Specifies the maximum number of categories to obtain. + /// + /// Specifies the maximum number of categories to obtain. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } /// - /// Configures pagination.
This parameter has the `from` and `size` properties. + /// + /// Configures pagination. + /// This parameter has the from and size properties. + /// /// [JsonInclude, JsonPropertyName("page")] public Elastic.Clients.Elasticsearch.MachineLearning.Page? Page { get; set; } } /// -/// Retrieves anomaly detection job results for one or more categories. +/// +/// Retrieves anomaly detection job results for one or more categories. +/// /// public sealed partial class GetCategoriesRequestDescriptor : RequestDescriptor { @@ -137,7 +156,10 @@ public GetCategoriesRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Id job private Action PageDescriptorAction { get; set; } /// - /// Configures pagination.
This parameter has the `from` and `size` properties. + /// + /// Configures pagination. + /// This parameter has the from and size properties. + /// /// public GetCategoriesRequestDescriptor Page(Elastic.Clients.Elasticsearch.MachineLearning.Page? page) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetDataFrameAnalyticsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetDataFrameAnalyticsRequest.g.cs index 42d81e508d1..ac0e62374e0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetDataFrameAnalyticsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetDataFrameAnalyticsRequest.g.cs @@ -32,30 +32,67 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class GetDataFrameAnalyticsRequestParameters : RequestParameters { /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no data frame analytics
jobs that match.
2. Contains the `_all` string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// The default value returns an empty data_frame_analytics array when there
are no matches and the subset of results when there are partial matches.
If this parameter is `false`, the request returns a 404 status code when
there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no data frame analytics + /// jobs that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// The default value returns an empty data_frame_analytics array when there + /// are no matches and the subset of results when there are partial matches. + /// If this parameter is false, the request returns a 404 status code when + /// there are no matches or only partial matches. + /// /// public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Indicates if certain fields should be removed from the configuration on
retrieval. This allows the configuration to be in an acceptable format to
be retrieved and then added to another cluster. + /// + /// Indicates if certain fields should be removed from the configuration on + /// retrieval. This allows the configuration to be in an acceptable format to + /// be retrieved and then added to another cluster. + /// /// public bool? ExcludeGenerated { get => Q("exclude_generated"); set => Q("exclude_generated", value); } /// - /// Skips the specified number of data frame analytics jobs. + /// + /// Skips the specified number of data frame analytics jobs. + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of data frame analytics jobs to obtain. + /// + /// Specifies the maximum number of data frame analytics jobs to obtain. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. +/// +/// Retrieves configuration information for data frame analytics jobs. +/// You can get information for multiple data frame analytics jobs in a single +/// API request by using a comma-separated list of data frame analytics jobs or a +/// wildcard expression. +/// /// public sealed partial class GetDataFrameAnalyticsRequest : PlainRequest { @@ -76,34 +113,71 @@ public GetDataFrameAnalyticsRequest(Elastic.Clients.Elasticsearch.Id? id) : base internal override string OperationName => "ml.get_data_frame_analytics"; /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no data frame analytics
jobs that match.
2. Contains the `_all` string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// The default value returns an empty data_frame_analytics array when there
are no matches and the subset of results when there are partial matches.
If this parameter is `false`, the request returns a 404 status code when
there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no data frame analytics + /// jobs that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// The default value returns an empty data_frame_analytics array when there + /// are no matches and the subset of results when there are partial matches. + /// If this parameter is false, the request returns a 404 status code when + /// there are no matches or only partial matches. + /// /// [JsonIgnore] public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Indicates if certain fields should be removed from the configuration on
retrieval. This allows the configuration to be in an acceptable format to
be retrieved and then added to another cluster. + /// + /// Indicates if certain fields should be removed from the configuration on + /// retrieval. This allows the configuration to be in an acceptable format to + /// be retrieved and then added to another cluster. + /// /// [JsonIgnore] public bool? ExcludeGenerated { get => Q("exclude_generated"); set => Q("exclude_generated", value); } /// - /// Skips the specified number of data frame analytics jobs. + /// + /// Skips the specified number of data frame analytics jobs. + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of data frame analytics jobs to obtain. + /// + /// Specifies the maximum number of data frame analytics jobs to obtain. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. +/// +/// Retrieves configuration information for data frame analytics jobs. +/// You can get information for multiple data frame analytics jobs in a single +/// API request by using a comma-separated list of data frame analytics jobs or a +/// wildcard expression. +/// /// public sealed partial class GetDataFrameAnalyticsRequestDescriptor : RequestDescriptor, GetDataFrameAnalyticsRequestParameters> { @@ -142,7 +216,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. +/// +/// Retrieves configuration information for data frame analytics jobs. +/// You can get information for multiple data frame analytics jobs in a single +/// API request by using a comma-separated list of data frame analytics jobs or a +/// wildcard expression. +/// /// public sealed partial class GetDataFrameAnalyticsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetDataFrameAnalyticsResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetDataFrameAnalyticsResponse.g.cs index 060a4e1ff7e..da8f94fc4cb 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetDataFrameAnalyticsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetDataFrameAnalyticsResponse.g.cs @@ -32,7 +32,9 @@ public sealed partial class GetDataFrameAnalyticsResponse : ElasticsearchRespons public int Count { get; init; } /// - /// An array of data frame analytics job resources, which are sorted by the id value in ascending order. + /// + /// An array of data frame analytics job resources, which are sorted by the id value in ascending order. + /// /// [JsonInclude, JsonPropertyName("data_frame_analytics")] public IReadOnlyCollection DataFrameAnalytics { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetDataFrameAnalyticsStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetDataFrameAnalyticsStatsRequest.g.cs index 89d1fe9a70a..638ae9a4361 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetDataFrameAnalyticsStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetDataFrameAnalyticsStatsRequest.g.cs @@ -32,30 +32,62 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class GetDataFrameAnalyticsStatsRequestParameters : RequestParameters { /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no data frame analytics
jobs that match.
2. Contains the `_all` string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// The default value returns an empty data_frame_analytics array when there
are no matches and the subset of results when there are partial matches.
If this parameter is `false`, the request returns a 404 status code when
there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no data frame analytics + /// jobs that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// The default value returns an empty data_frame_analytics array when there + /// are no matches and the subset of results when there are partial matches. + /// If this parameter is false, the request returns a 404 status code when + /// there are no matches or only partial matches. + /// /// public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Skips the specified number of data frame analytics jobs. + /// + /// Skips the specified number of data frame analytics jobs. + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of data frame analytics jobs to obtain. + /// + /// Specifies the maximum number of data frame analytics jobs to obtain. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } /// - /// Defines whether the stats response should be verbose. + /// + /// Defines whether the stats response should be verbose. + /// /// public bool? Verbose { get => Q("verbose"); set => Q("verbose", value); } } /// -/// Retrieves usage information for data frame analytics jobs. +/// +/// Retrieves usage information for data frame analytics jobs. +/// /// public sealed partial class GetDataFrameAnalyticsStatsRequest : PlainRequest { @@ -76,34 +108,66 @@ public GetDataFrameAnalyticsStatsRequest(Elastic.Clients.Elasticsearch.Id? id) : internal override string OperationName => "ml.get_data_frame_analytics_stats"; /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no data frame analytics
jobs that match.
2. Contains the `_all` string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// The default value returns an empty data_frame_analytics array when there
are no matches and the subset of results when there are partial matches.
If this parameter is `false`, the request returns a 404 status code when
there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no data frame analytics + /// jobs that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// The default value returns an empty data_frame_analytics array when there + /// are no matches and the subset of results when there are partial matches. + /// If this parameter is false, the request returns a 404 status code when + /// there are no matches or only partial matches. + /// /// [JsonIgnore] public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Skips the specified number of data frame analytics jobs. + /// + /// Skips the specified number of data frame analytics jobs. + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of data frame analytics jobs to obtain. + /// + /// Specifies the maximum number of data frame analytics jobs to obtain. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } /// - /// Defines whether the stats response should be verbose. + /// + /// Defines whether the stats response should be verbose. + /// /// [JsonIgnore] public bool? Verbose { get => Q("verbose"); set => Q("verbose", value); } } /// -/// Retrieves usage information for data frame analytics jobs. +/// +/// Retrieves usage information for data frame analytics jobs. +/// /// public sealed partial class GetDataFrameAnalyticsStatsRequestDescriptor : RequestDescriptor, GetDataFrameAnalyticsStatsRequestParameters> { @@ -142,7 +206,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Retrieves usage information for data frame analytics jobs. +/// +/// Retrieves usage information for data frame analytics jobs. +/// /// public sealed partial class GetDataFrameAnalyticsStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetDataFrameAnalyticsStatsResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetDataFrameAnalyticsStatsResponse.g.cs index 2c0ec5bd968..fb6b005d405 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetDataFrameAnalyticsStatsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetDataFrameAnalyticsStatsResponse.g.cs @@ -32,7 +32,9 @@ public sealed partial class GetDataFrameAnalyticsStatsResponse : ElasticsearchRe public long Count { get; init; } /// - /// An array of objects that contain usage information for data frame analytics jobs, which are sorted by the id value in ascending order. + /// + /// An array of objects that contain usage information for data frame analytics jobs, which are sorted by the id value in ascending order. + /// /// [JsonInclude, JsonPropertyName("data_frame_analytics")] public IReadOnlyCollection DataFrameAnalytics { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetDatafeedStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetDatafeedStatsRequest.g.cs index 39f0a1089c3..e648fc82e34 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetDatafeedStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetDatafeedStatsRequest.g.cs @@ -32,15 +32,46 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class GetDatafeedStatsRequestParameters : RequestParameters { /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no datafeeds that match.
2. Contains the `_all` string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// The default value is `true`, which returns an empty `datafeeds` array
when there are no matches and the subset of results when there are
partial matches. If this parameter is `false`, the request returns a
`404` status code when there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no datafeeds that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// The default value is true, which returns an empty datafeeds array + /// when there are no matches and the subset of results when there are + /// partial matches. If this parameter is false, the request returns a + /// 404 status code when there are no matches or only partial matches. + /// /// public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } } /// -/// Retrieves usage information for datafeeds.
You can get statistics for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get statistics for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``. If the datafeed is stopped, the
only information you receive is the `datafeed_id` and the `state`.
This API returns a maximum of 10,000 datafeeds. +/// +/// Retrieves usage information for datafeeds. +/// You can get statistics for multiple datafeeds in a single API request by +/// using a comma-separated list of datafeeds or a wildcard expression. You can +/// get statistics for all datafeeds by using _all, by specifying * as the +/// <feed_id>, or by omitting the <feed_id>. If the datafeed is stopped, the +/// only information you receive is the datafeed_id and the state. +/// This API returns a maximum of 10,000 datafeeds. +/// /// public sealed partial class GetDatafeedStatsRequest : PlainRequest { @@ -61,16 +92,47 @@ public GetDatafeedStatsRequest(Elastic.Clients.Elasticsearch.Ids? datafeedId) : internal override string OperationName => "ml.get_datafeed_stats"; /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no datafeeds that match.
2. Contains the `_all` string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// The default value is `true`, which returns an empty `datafeeds` array
when there are no matches and the subset of results when there are
partial matches. If this parameter is `false`, the request returns a
`404` status code when there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no datafeeds that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// The default value is true, which returns an empty datafeeds array + /// when there are no matches and the subset of results when there are + /// partial matches. If this parameter is false, the request returns a + /// 404 status code when there are no matches or only partial matches. + /// /// [JsonIgnore] public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } } /// -/// Retrieves usage information for datafeeds.
You can get statistics for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get statistics for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``. If the datafeed is stopped, the
only information you receive is the `datafeed_id` and the `state`.
This API returns a maximum of 10,000 datafeeds. +/// +/// Retrieves usage information for datafeeds. +/// You can get statistics for multiple datafeeds in a single API request by +/// using a comma-separated list of datafeeds or a wildcard expression. You can +/// get statistics for all datafeeds by using _all, by specifying * as the +/// <feed_id>, or by omitting the <feed_id>. If the datafeed is stopped, the +/// only information you receive is the datafeed_id and the state. +/// This API returns a maximum of 10,000 datafeeds. +/// /// public sealed partial class GetDatafeedStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetDatafeedsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetDatafeedsRequest.g.cs index 51a7015c73d..5b577b0497d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetDatafeedsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetDatafeedsRequest.g.cs @@ -32,20 +32,54 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class GetDatafeedsRequestParameters : RequestParameters { /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no datafeeds that match.
2. Contains the `_all` string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// The default value is `true`, which returns an empty `datafeeds` array
when there are no matches and the subset of results when there are
partial matches. If this parameter is `false`, the request returns a
`404` status code when there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no datafeeds that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// The default value is true, which returns an empty datafeeds array + /// when there are no matches and the subset of results when there are + /// partial matches. If this parameter is false, the request returns a + /// 404 status code when there are no matches or only partial matches. + /// /// public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Indicates if certain fields should be removed from the configuration on
retrieval. This allows the configuration to be in an acceptable format to
be retrieved and then added to another cluster. + /// + /// Indicates if certain fields should be removed from the configuration on + /// retrieval. This allows the configuration to be in an acceptable format to + /// be retrieved and then added to another cluster. + /// /// public bool? ExcludeGenerated { get => Q("exclude_generated"); set => Q("exclude_generated", value); } } /// -/// Retrieves configuration information for datafeeds.
You can get information for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get information for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``.
This API returns a maximum of 10,000 datafeeds. +/// +/// Retrieves configuration information for datafeeds. +/// You can get information for multiple datafeeds in a single API request by +/// using a comma-separated list of datafeeds or a wildcard expression. You can +/// get information for all datafeeds by using _all, by specifying * as the +/// <feed_id>, or by omitting the <feed_id>. +/// This API returns a maximum of 10,000 datafeeds. +/// /// public sealed partial class GetDatafeedsRequest : PlainRequest { @@ -66,22 +100,56 @@ public GetDatafeedsRequest(Elastic.Clients.Elasticsearch.Ids? datafeedId) : base internal override string OperationName => "ml.get_datafeeds"; /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no datafeeds that match.
2. Contains the `_all` string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// The default value is `true`, which returns an empty `datafeeds` array
when there are no matches and the subset of results when there are
partial matches. If this parameter is `false`, the request returns a
`404` status code when there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no datafeeds that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// The default value is true, which returns an empty datafeeds array + /// when there are no matches and the subset of results when there are + /// partial matches. If this parameter is false, the request returns a + /// 404 status code when there are no matches or only partial matches. + /// /// [JsonIgnore] public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Indicates if certain fields should be removed from the configuration on
retrieval. This allows the configuration to be in an acceptable format to
be retrieved and then added to another cluster. + /// + /// Indicates if certain fields should be removed from the configuration on + /// retrieval. This allows the configuration to be in an acceptable format to + /// be retrieved and then added to another cluster. + /// /// [JsonIgnore] public bool? ExcludeGenerated { get => Q("exclude_generated"); set => Q("exclude_generated", value); } } /// -/// Retrieves configuration information for datafeeds.
You can get information for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get information for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``.
This API returns a maximum of 10,000 datafeeds. +/// +/// Retrieves configuration information for datafeeds. +/// You can get information for multiple datafeeds in a single API request by +/// using a comma-separated list of datafeeds or a wildcard expression. You can +/// get information for all datafeeds by using _all, by specifying * as the +/// <feed_id>, or by omitting the <feed_id>. +/// This API returns a maximum of 10,000 datafeeds. +/// /// public sealed partial class GetDatafeedsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetFiltersRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetFiltersRequest.g.cs index 89bcf0782b3..69d342e12a9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetFiltersRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetFiltersRequest.g.cs @@ -32,18 +32,25 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class GetFiltersRequestParameters : RequestParameters { /// - /// Skips the specified number of filters. + /// + /// Skips the specified number of filters. + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of filters to obtain. + /// + /// Specifies the maximum number of filters to obtain. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Retrieves filters.
You can get a single filter or all filters. +/// +/// Retrieves filters. +/// You can get a single filter or all filters. +/// /// public sealed partial class GetFiltersRequest : PlainRequest { @@ -64,20 +71,27 @@ public GetFiltersRequest(Elastic.Clients.Elasticsearch.Ids? filterId) : base(r = internal override string OperationName => "ml.get_filters"; /// - /// Skips the specified number of filters. + /// + /// Skips the specified number of filters. + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of filters to obtain. + /// + /// Specifies the maximum number of filters to obtain. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Retrieves filters.
You can get a single filter or all filters. +/// +/// Retrieves filters. +/// You can get a single filter or all filters. +/// /// public sealed partial class GetFiltersRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetInfluencersRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetInfluencersRequest.g.cs index 10ed37283b5..fd15802162c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetInfluencersRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetInfluencersRequest.g.cs @@ -32,48 +32,75 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class GetInfluencersRequestParameters : RequestParameters { /// - /// If true, the results are sorted in descending order. + /// + /// If true, the results are sorted in descending order. + /// /// public bool? Desc { get => Q("desc"); set => Q("desc", value); } /// - /// Returns influencers with timestamps earlier than this time.
The default value means it is unset and results are not limited to
specific timestamps. + /// + /// Returns influencers with timestamps earlier than this time. + /// The default value means it is unset and results are not limited to + /// specific timestamps. + /// /// public DateTimeOffset? End { get => Q("end"); set => Q("end", value); } /// - /// If true, the output excludes interim results. By default, interim results
are included. + /// + /// If true, the output excludes interim results. By default, interim results + /// are included. + /// /// public bool? ExcludeInterim { get => Q("exclude_interim"); set => Q("exclude_interim", value); } /// - /// Skips the specified number of influencers. + /// + /// Skips the specified number of influencers. + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// Returns influencers with anomaly scores greater than or equal to this
value. + /// + /// Returns influencers with anomaly scores greater than or equal to this + /// value. + /// /// public double? InfluencerScore { get => Q("influencer_score"); set => Q("influencer_score", value); } /// - /// Specifies the maximum number of influencers to obtain. + /// + /// Specifies the maximum number of influencers to obtain. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } /// - /// Specifies the sort field for the requested influencers. By default, the
influencers are sorted by the `influencer_score` value. + /// + /// Specifies the sort field for the requested influencers. By default, the + /// influencers are sorted by the influencer_score value. + /// /// public Elastic.Clients.Elasticsearch.Field? Sort { get => Q("sort"); set => Q("sort", value); } /// - /// Returns influencers with timestamps after this time. The default value
means it is unset and results are not limited to specific timestamps. + /// + /// Returns influencers with timestamps after this time. The default value + /// means it is unset and results are not limited to specific timestamps. + /// /// public DateTimeOffset? Start { get => Q("start"); set => Q("start", value); } } /// -/// Retrieves anomaly detection job results for one or more influencers.
Influencers are the entities that have contributed to, or are to blame for,
the anomalies. Influencer results are available only if an
`influencer_field_name` is specified in the job configuration. +/// +/// Retrieves anomaly detection job results for one or more influencers. +/// Influencers are the entities that have contributed to, or are to blame for, +/// the anomalies. Influencer results are available only if an +/// influencer_field_name is specified in the job configuration. +/// /// public sealed partial class GetInfluencersRequest : PlainRequest { @@ -90,62 +117,92 @@ public GetInfluencersRequest(Elastic.Clients.Elasticsearch.Id jobId) : base(r => internal override string OperationName => "ml.get_influencers"; /// - /// If true, the results are sorted in descending order. + /// + /// If true, the results are sorted in descending order. + /// /// [JsonIgnore] public bool? Desc { get => Q("desc"); set => Q("desc", value); } /// - /// Returns influencers with timestamps earlier than this time.
The default value means it is unset and results are not limited to
specific timestamps. + /// + /// Returns influencers with timestamps earlier than this time. + /// The default value means it is unset and results are not limited to + /// specific timestamps. + /// /// [JsonIgnore] public DateTimeOffset? End { get => Q("end"); set => Q("end", value); } /// - /// If true, the output excludes interim results. By default, interim results
are included. + /// + /// If true, the output excludes interim results. By default, interim results + /// are included. + /// /// [JsonIgnore] public bool? ExcludeInterim { get => Q("exclude_interim"); set => Q("exclude_interim", value); } /// - /// Skips the specified number of influencers. + /// + /// Skips the specified number of influencers. + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// Returns influencers with anomaly scores greater than or equal to this
value. + /// + /// Returns influencers with anomaly scores greater than or equal to this + /// value. + /// /// [JsonIgnore] public double? InfluencerScore { get => Q("influencer_score"); set => Q("influencer_score", value); } /// - /// Specifies the maximum number of influencers to obtain. + /// + /// Specifies the maximum number of influencers to obtain. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } /// - /// Specifies the sort field for the requested influencers. By default, the
influencers are sorted by the `influencer_score` value. + /// + /// Specifies the sort field for the requested influencers. By default, the + /// influencers are sorted by the influencer_score value. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Field? Sort { get => Q("sort"); set => Q("sort", value); } /// - /// Returns influencers with timestamps after this time. The default value
means it is unset and results are not limited to specific timestamps. + /// + /// Returns influencers with timestamps after this time. The default value + /// means it is unset and results are not limited to specific timestamps. + /// /// [JsonIgnore] public DateTimeOffset? Start { get => Q("start"); set => Q("start", value); } /// - /// Configures pagination.
This parameter has the `from` and `size` properties. + /// + /// Configures pagination. + /// This parameter has the from and size properties. + /// /// [JsonInclude, JsonPropertyName("page")] public Elastic.Clients.Elasticsearch.MachineLearning.Page? Page { get; set; } } /// -/// Retrieves anomaly detection job results for one or more influencers.
Influencers are the entities that have contributed to, or are to blame for,
the anomalies. Influencer results are available only if an
`influencer_field_name` is specified in the job configuration. +/// +/// Retrieves anomaly detection job results for one or more influencers. +/// Influencers are the entities that have contributed to, or are to blame for, +/// the anomalies. Influencer results are available only if an +/// influencer_field_name is specified in the job configuration. +/// /// public sealed partial class GetInfluencersRequestDescriptor : RequestDescriptor, GetInfluencersRequestParameters> { @@ -183,7 +240,10 @@ public GetInfluencersRequestDescriptor JobId(Elastic.Clients.Elastics private Action PageDescriptorAction { get; set; } /// - /// Configures pagination.
This parameter has the `from` and `size` properties. + /// + /// Configures pagination. + /// This parameter has the from and size properties. + /// /// public GetInfluencersRequestDescriptor Page(Elastic.Clients.Elasticsearch.MachineLearning.Page? page) { @@ -233,7 +293,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Retrieves anomaly detection job results for one or more influencers.
Influencers are the entities that have contributed to, or are to blame for,
the anomalies. Influencer results are available only if an
`influencer_field_name` is specified in the job configuration. +/// +/// Retrieves anomaly detection job results for one or more influencers. +/// Influencers are the entities that have contributed to, or are to blame for, +/// the anomalies. Influencer results are available only if an +/// influencer_field_name is specified in the job configuration. +/// /// public sealed partial class GetInfluencersRequestDescriptor : RequestDescriptor { @@ -271,7 +336,10 @@ public GetInfluencersRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Id jo private Action PageDescriptorAction { get; set; } /// - /// Configures pagination.
This parameter has the `from` and `size` properties. + /// + /// Configures pagination. + /// This parameter has the from and size properties. + /// /// public GetInfluencersRequestDescriptor Page(Elastic.Clients.Elasticsearch.MachineLearning.Page? page) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetInfluencersResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetInfluencersResponse.g.cs index f4291db8161..188949c02d9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetInfluencersResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetInfluencersResponse.g.cs @@ -32,7 +32,9 @@ public sealed partial class GetInfluencersResponse : ElasticsearchResponse public long Count { get; init; } /// - /// Array of influencer objects + /// + /// Array of influencer objects + /// /// [JsonInclude, JsonPropertyName("influencers")] public IReadOnlyCollection Influencers { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetJobStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetJobStatsRequest.g.cs index bc7d95fe739..57644630030 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetJobStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetJobStatsRequest.g.cs @@ -32,15 +32,40 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class GetJobStatsRequestParameters : RequestParameters { /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no jobs that match.
2. Contains the _all string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// If `true`, the API returns an empty `jobs` array when
there are no matches and the subset of results when there are partial
matches. If `false`, the API returns a `404` status
code when there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no jobs that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// If true, the API returns an empty jobs array when + /// there are no matches and the subset of results when there are partial + /// matches. If false, the API returns a 404 status + /// code when there are no matches or only partial matches. + /// /// public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } } /// -/// Retrieves usage information for anomaly detection jobs. +/// +/// Retrieves usage information for anomaly detection jobs. +/// /// public sealed partial class GetJobStatsRequest : PlainRequest { @@ -61,16 +86,41 @@ public GetJobStatsRequest(Elastic.Clients.Elasticsearch.Id? jobId) : base(r => r internal override string OperationName => "ml.get_job_stats"; /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no jobs that match.
2. Contains the _all string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// If `true`, the API returns an empty `jobs` array when
there are no matches and the subset of results when there are partial
matches. If `false`, the API returns a `404` status
code when there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no jobs that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// If true, the API returns an empty jobs array when + /// there are no matches and the subset of results when there are partial + /// matches. If false, the API returns a 404 status + /// code when there are no matches or only partial matches. + /// /// [JsonIgnore] public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } } /// -/// Retrieves usage information for anomaly detection jobs. +/// +/// Retrieves usage information for anomaly detection jobs. +/// /// public sealed partial class GetJobStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetJobsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetJobsRequest.g.cs index 02aa509d27f..09d15946ab8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetJobsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetJobsRequest.g.cs @@ -32,20 +32,53 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class GetJobsRequestParameters : RequestParameters { /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no jobs that match.
2. Contains the _all string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// The default value is `true`, which returns an empty `jobs` array when
there are no matches and the subset of results when there are partial
matches. If this parameter is `false`, the request returns a `404` status
code when there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no jobs that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// The default value is true, which returns an empty jobs array when + /// there are no matches and the subset of results when there are partial + /// matches. If this parameter is false, the request returns a 404 status + /// code when there are no matches or only partial matches. + /// /// public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Indicates if certain fields should be removed from the configuration on
retrieval. This allows the configuration to be in an acceptable format to
be retrieved and then added to another cluster. + /// + /// Indicates if certain fields should be removed from the configuration on + /// retrieval. This allows the configuration to be in an acceptable format to + /// be retrieved and then added to another cluster. + /// /// public bool? ExcludeGenerated { get => Q("exclude_generated"); set => Q("exclude_generated", value); } } /// -/// Retrieves configuration information for anomaly detection jobs.
You can get information for multiple anomaly detection jobs in a single API
request by using a group name, a comma-separated list of jobs, or a wildcard
expression. You can get information for all anomaly detection jobs by using
`_all`, by specifying `*` as the ``, or by omitting the ``. +/// +/// Retrieves configuration information for anomaly detection jobs. +/// You can get information for multiple anomaly detection jobs in a single API +/// request by using a group name, a comma-separated list of jobs, or a wildcard +/// expression. You can get information for all anomaly detection jobs by using +/// _all, by specifying * as the <job_id>, or by omitting the <job_id>. +/// /// public sealed partial class GetJobsRequest : PlainRequest { @@ -66,22 +99,55 @@ public GetJobsRequest(Elastic.Clients.Elasticsearch.Ids? jobId) : base(r => r.Op internal override string OperationName => "ml.get_jobs"; /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no jobs that match.
2. Contains the _all string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// The default value is `true`, which returns an empty `jobs` array when
there are no matches and the subset of results when there are partial
matches. If this parameter is `false`, the request returns a `404` status
code when there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no jobs that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// The default value is true, which returns an empty jobs array when + /// there are no matches and the subset of results when there are partial + /// matches. If this parameter is false, the request returns a 404 status + /// code when there are no matches or only partial matches. + /// /// [JsonIgnore] public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Indicates if certain fields should be removed from the configuration on
retrieval. This allows the configuration to be in an acceptable format to
be retrieved and then added to another cluster. + /// + /// Indicates if certain fields should be removed from the configuration on + /// retrieval. This allows the configuration to be in an acceptable format to + /// be retrieved and then added to another cluster. + /// /// [JsonIgnore] public bool? ExcludeGenerated { get => Q("exclude_generated"); set => Q("exclude_generated", value); } } /// -/// Retrieves configuration information for anomaly detection jobs.
You can get information for multiple anomaly detection jobs in a single API
request by using a group name, a comma-separated list of jobs, or a wildcard
expression. You can get information for all anomaly detection jobs by using
`_all`, by specifying `*` as the ``, or by omitting the ``. +/// +/// Retrieves configuration information for anomaly detection jobs. +/// You can get information for multiple anomaly detection jobs in a single API +/// request by using a group name, a comma-separated list of jobs, or a wildcard +/// expression. You can get information for all anomaly detection jobs by using +/// _all, by specifying * as the <job_id>, or by omitting the <job_id>. +/// /// public sealed partial class GetJobsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetMemoryStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetMemoryStatsRequest.g.cs index b4a34e23f65..c01881e8846 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetMemoryStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetMemoryStatsRequest.g.cs @@ -32,18 +32,27 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class GetMemoryStatsRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node. If no response is received before the timeout
expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout + /// expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request
fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request + /// fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Get information about how machine learning jobs and trained models are using memory,
on each node, both within the JVM heap, and natively, outside of the JVM. +/// +/// Get information about how machine learning jobs and trained models are using memory, +/// on each node, both within the JVM heap, and natively, outside of the JVM. +/// /// public sealed partial class GetMemoryStatsRequest : PlainRequest { @@ -64,20 +73,29 @@ public GetMemoryStatsRequest(Elastic.Clients.Elasticsearch.Id? nodeId) : base(r internal override string OperationName => "ml.get_memory_stats"; /// - /// Period to wait for a connection to the master node. If no response is received before the timeout
expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout + /// expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request
fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request + /// fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Get information about how machine learning jobs and trained models are using memory,
on each node, both within the JVM heap, and natively, outside of the JVM. +/// +/// Get information about how machine learning jobs and trained models are using memory, +/// on each node, both within the JVM heap, and natively, outside of the JVM. +/// /// public sealed partial class GetMemoryStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetModelSnapshotUpgradeStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetModelSnapshotUpgradeStatsRequest.g.cs index 87ca63dcc9c..c504e9d5b4d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetModelSnapshotUpgradeStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetModelSnapshotUpgradeStatsRequest.g.cs @@ -32,15 +32,39 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class GetModelSnapshotUpgradeStatsRequestParameters : RequestParameters { /// - /// Specifies what to do when the request: - /// - Contains wildcard expressions and there are no jobs that match.
- Contains the _all string or no identifiers and there are no matches.
- Contains wildcard expressions and there are only partial matches. - /// The default value is true, which returns an empty jobs array when there are no matches and the subset of results
when there are partial matches. If this parameter is false, the request returns a 404 status code when there are
no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no jobs that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// The default value is true, which returns an empty jobs array when there are no matches and the subset of results + /// when there are partial matches. If this parameter is false, the request returns a 404 status code when there are + /// no matches or only partial matches. + /// /// public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } } /// -/// Retrieves usage information for anomaly detection job model snapshot upgrades. +/// +/// Retrieves usage information for anomaly detection job model snapshot upgrades. +/// /// public sealed partial class GetModelSnapshotUpgradeStatsRequest : PlainRequest { @@ -57,16 +81,40 @@ public GetModelSnapshotUpgradeStatsRequest(Elastic.Clients.Elasticsearch.Id jobI internal override string OperationName => "ml.get_model_snapshot_upgrade_stats"; /// - /// Specifies what to do when the request: - /// - Contains wildcard expressions and there are no jobs that match.
- Contains the _all string or no identifiers and there are no matches.
- Contains wildcard expressions and there are only partial matches. - /// The default value is true, which returns an empty jobs array when there are no matches and the subset of results
when there are partial matches. If this parameter is false, the request returns a 404 status code when there are
no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no jobs that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// The default value is true, which returns an empty jobs array when there are no matches and the subset of results + /// when there are partial matches. If this parameter is false, the request returns a 404 status code when there are + /// no matches or only partial matches. + /// /// [JsonIgnore] public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } } /// -/// Retrieves usage information for anomaly detection job model snapshot upgrades. +/// +/// Retrieves usage information for anomaly detection job model snapshot upgrades. +/// /// public sealed partial class GetModelSnapshotUpgradeStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetModelSnapshotsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetModelSnapshotsRequest.g.cs index 43711302677..94accd61608 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetModelSnapshotsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetModelSnapshotsRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class GetModelSnapshotsRequestParameters : RequestParameters { /// - /// Skips the specified number of snapshots. + /// + /// Skips the specified number of snapshots. + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of snapshots to obtain. + /// + /// Specifies the maximum number of snapshots to obtain. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Retrieves information about model snapshots. +/// +/// Retrieves information about model snapshots. +/// /// public sealed partial class GetModelSnapshotsRequest : PlainRequest { @@ -64,25 +70,33 @@ public GetModelSnapshotsRequest(Elastic.Clients.Elasticsearch.Id jobId) : base(r internal override string OperationName => "ml.get_model_snapshots"; /// - /// Skips the specified number of snapshots. + /// + /// Skips the specified number of snapshots. + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of snapshots to obtain. + /// + /// Specifies the maximum number of snapshots to obtain. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } /// - /// Refer to the description for the `desc` query parameter. + /// + /// Refer to the description for the desc query parameter. + /// /// [JsonInclude, JsonPropertyName("desc")] public bool? Desc { get; set; } /// - /// Refer to the description for the `end` query parameter. + /// + /// Refer to the description for the end query parameter. + /// /// [JsonInclude, JsonPropertyName("end")] public DateTimeOffset? End { get; set; } @@ -90,20 +104,26 @@ public GetModelSnapshotsRequest(Elastic.Clients.Elasticsearch.Id jobId) : base(r public Elastic.Clients.Elasticsearch.MachineLearning.Page? Page { get; set; } /// - /// Refer to the description for the `sort` query parameter. + /// + /// Refer to the description for the sort query parameter. + /// /// [JsonInclude, JsonPropertyName("sort")] public Elastic.Clients.Elasticsearch.Field? Sort { get; set; } /// - /// Refer to the description for the `start` query parameter. + /// + /// Refer to the description for the start query parameter. + /// /// [JsonInclude, JsonPropertyName("start")] public DateTimeOffset? Start { get; set; } } /// -/// Retrieves information about model snapshots. +/// +/// Retrieves information about model snapshots. +/// /// public sealed partial class GetModelSnapshotsRequestDescriptor : RequestDescriptor, GetModelSnapshotsRequestParameters> { @@ -149,7 +169,9 @@ public GetModelSnapshotsRequestDescriptor SnapshotId(Elastic.Clients. private DateTimeOffset? StartValue { get; set; } /// - /// Refer to the description for the `desc` query parameter. + /// + /// Refer to the description for the desc query parameter. + /// /// public GetModelSnapshotsRequestDescriptor Desc(bool? desc = true) { @@ -158,7 +180,9 @@ public GetModelSnapshotsRequestDescriptor Desc(bool? desc = true) } /// - /// Refer to the description for the `end` query parameter. + /// + /// Refer to the description for the end query parameter. + /// /// public GetModelSnapshotsRequestDescriptor End(DateTimeOffset? end) { @@ -191,7 +215,9 @@ public GetModelSnapshotsRequestDescriptor Page(Action - /// Refer to the description for the `sort` query parameter. + /// + /// Refer to the description for the sort query parameter. + /// /// public GetModelSnapshotsRequestDescriptor Sort(Elastic.Clients.Elasticsearch.Field? sort) { @@ -200,7 +226,9 @@ public GetModelSnapshotsRequestDescriptor Sort(Elastic.Clients.Elasti } /// - /// Refer to the description for the `sort` query parameter. + /// + /// Refer to the description for the sort query parameter. + /// /// public GetModelSnapshotsRequestDescriptor Sort(Expression> sort) { @@ -209,7 +237,9 @@ public GetModelSnapshotsRequestDescriptor Sort(Expression - /// Refer to the description for the `sort` query parameter. + /// + /// Refer to the description for the sort query parameter. + /// /// public GetModelSnapshotsRequestDescriptor Sort(Expression> sort) { @@ -218,7 +248,9 @@ public GetModelSnapshotsRequestDescriptor Sort(Expression - /// Refer to the description for the `start` query parameter. + /// + /// Refer to the description for the start query parameter. + /// /// public GetModelSnapshotsRequestDescriptor Start(DateTimeOffset? start) { @@ -274,7 +306,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Retrieves information about model snapshots. +/// +/// Retrieves information about model snapshots. +/// /// public sealed partial class GetModelSnapshotsRequestDescriptor : RequestDescriptor { @@ -320,7 +354,9 @@ public GetModelSnapshotsRequestDescriptor SnapshotId(Elastic.Clients.Elasticsear private DateTimeOffset? StartValue { get; set; } /// - /// Refer to the description for the `desc` query parameter. + /// + /// Refer to the description for the desc query parameter. + /// /// public GetModelSnapshotsRequestDescriptor Desc(bool? desc = true) { @@ -329,7 +365,9 @@ public GetModelSnapshotsRequestDescriptor Desc(bool? desc = true) } /// - /// Refer to the description for the `end` query parameter. + /// + /// Refer to the description for the end query parameter. + /// /// public GetModelSnapshotsRequestDescriptor End(DateTimeOffset? end) { @@ -362,7 +400,9 @@ public GetModelSnapshotsRequestDescriptor Page(Action - /// Refer to the description for the `sort` query parameter. + /// + /// Refer to the description for the sort query parameter. + /// /// public GetModelSnapshotsRequestDescriptor Sort(Elastic.Clients.Elasticsearch.Field? sort) { @@ -371,7 +411,9 @@ public GetModelSnapshotsRequestDescriptor Sort(Elastic.Clients.Elasticsearch.Fie } /// - /// Refer to the description for the `sort` query parameter. + /// + /// Refer to the description for the sort query parameter. + /// /// public GetModelSnapshotsRequestDescriptor Sort(Expression> sort) { @@ -380,7 +422,9 @@ public GetModelSnapshotsRequestDescriptor Sort(Expression - /// Refer to the description for the `sort` query parameter. + /// + /// Refer to the description for the sort query parameter. + /// /// public GetModelSnapshotsRequestDescriptor Sort(Expression> sort) { @@ -389,7 +433,9 @@ public GetModelSnapshotsRequestDescriptor Sort(Expression - /// Refer to the description for the `start` query parameter. + /// + /// Refer to the description for the start query parameter. + /// /// public GetModelSnapshotsRequestDescriptor Start(DateTimeOffset? start) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetOverallBucketsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetOverallBucketsRequest.g.cs index adddfbabd8b..d9356c2da50 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetOverallBucketsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetOverallBucketsRequest.g.cs @@ -34,8 +34,26 @@ public sealed partial class GetOverallBucketsRequestParameters : RequestParamete } /// -/// Retrieves overall bucket results that summarize the bucket results of
multiple anomaly detection jobs. -/// The `overall_score` is calculated by combining the scores of all the
buckets within the overall bucket span. First, the maximum
`anomaly_score` per anomaly detection job in the overall bucket is
calculated. Then the `top_n` of those scores are averaged to result in
the `overall_score`. This means that you can fine-tune the
`overall_score` so that it is more or less sensitive to the number of
jobs that detect an anomaly at the same time. For example, if you set
`top_n` to `1`, the `overall_score` is the maximum bucket score in the
overall bucket. Alternatively, if you set `top_n` to the number of jobs,
the `overall_score` is high only when all jobs detect anomalies in that
overall bucket. If you set the `bucket_span` parameter (to a value
greater than its default), the `overall_score` is the maximum
`overall_score` of the overall buckets that have a span equal to the
jobs' largest bucket span. +/// +/// Retrieves overall bucket results that summarize the bucket results of +/// multiple anomaly detection jobs. +/// +/// +/// The overall_score is calculated by combining the scores of all the +/// buckets within the overall bucket span. First, the maximum +/// anomaly_score per anomaly detection job in the overall bucket is +/// calculated. Then the top_n of those scores are averaged to result in +/// the overall_score. This means that you can fine-tune the +/// overall_score so that it is more or less sensitive to the number of +/// jobs that detect an anomaly at the same time. For example, if you set +/// top_n to 1, the overall_score is the maximum bucket score in the +/// overall bucket. Alternatively, if you set top_n to the number of jobs, +/// the overall_score is high only when all jobs detect anomalies in that +/// overall bucket. If you set the bucket_span parameter (to a value +/// greater than its default), the overall_score is the maximum +/// overall_score of the overall buckets that have a span equal to the +/// jobs' largest bucket span. +/// /// public sealed partial class GetOverallBucketsRequest : PlainRequest { @@ -52,51 +70,83 @@ public GetOverallBucketsRequest(Elastic.Clients.Elasticsearch.Id jobId) : base(r internal override string OperationName => "ml.get_overall_buckets"; /// - /// Refer to the description for the `allow_no_match` query parameter. + /// + /// Refer to the description for the allow_no_match query parameter. + /// /// [JsonInclude, JsonPropertyName("allow_no_match")] public bool? AllowNoMatch { get; set; } /// - /// Refer to the description for the `bucket_span` query parameter. + /// + /// Refer to the description for the bucket_span query parameter. + /// /// [JsonInclude, JsonPropertyName("bucket_span")] public Elastic.Clients.Elasticsearch.Duration? BucketSpan { get; set; } /// - /// Refer to the description for the `end` query parameter. + /// + /// Refer to the description for the end query parameter. + /// /// [JsonInclude, JsonPropertyName("end")] public DateTimeOffset? End { get; set; } /// - /// Refer to the description for the `exclude_interim` query parameter. + /// + /// Refer to the description for the exclude_interim query parameter. + /// /// [JsonInclude, JsonPropertyName("exclude_interim")] public bool? ExcludeInterim { get; set; } /// - /// Refer to the description for the `overall_score` query parameter. + /// + /// Refer to the description for the overall_score query parameter. + /// /// [JsonInclude, JsonPropertyName("overall_score")] public object? OverallScore { get; set; } /// - /// Refer to the description for the `start` query parameter. + /// + /// Refer to the description for the start query parameter. + /// /// [JsonInclude, JsonPropertyName("start")] public DateTimeOffset? Start { get; set; } /// - /// Refer to the description for the `top_n` query parameter. + /// + /// Refer to the description for the top_n query parameter. + /// /// [JsonInclude, JsonPropertyName("top_n")] public int? TopN { get; set; } } /// -/// Retrieves overall bucket results that summarize the bucket results of
multiple anomaly detection jobs. -/// The `overall_score` is calculated by combining the scores of all the
buckets within the overall bucket span. First, the maximum
`anomaly_score` per anomaly detection job in the overall bucket is
calculated. Then the `top_n` of those scores are averaged to result in
the `overall_score`. This means that you can fine-tune the
`overall_score` so that it is more or less sensitive to the number of
jobs that detect an anomaly at the same time. For example, if you set
`top_n` to `1`, the `overall_score` is the maximum bucket score in the
overall bucket. Alternatively, if you set `top_n` to the number of jobs,
the `overall_score` is high only when all jobs detect anomalies in that
overall bucket. If you set the `bucket_span` parameter (to a value
greater than its default), the `overall_score` is the maximum
`overall_score` of the overall buckets that have a span equal to the
jobs' largest bucket span. +/// +/// Retrieves overall bucket results that summarize the bucket results of +/// multiple anomaly detection jobs. +/// +/// +/// The overall_score is calculated by combining the scores of all the +/// buckets within the overall bucket span. First, the maximum +/// anomaly_score per anomaly detection job in the overall bucket is +/// calculated. Then the top_n of those scores are averaged to result in +/// the overall_score. This means that you can fine-tune the +/// overall_score so that it is more or less sensitive to the number of +/// jobs that detect an anomaly at the same time. For example, if you set +/// top_n to 1, the overall_score is the maximum bucket score in the +/// overall bucket. Alternatively, if you set top_n to the number of jobs, +/// the overall_score is high only when all jobs detect anomalies in that +/// overall bucket. If you set the bucket_span parameter (to a value +/// greater than its default), the overall_score is the maximum +/// overall_score of the overall buckets that have a span equal to the +/// jobs' largest bucket span. +/// /// public sealed partial class GetOverallBucketsRequestDescriptor : RequestDescriptor { @@ -129,7 +179,9 @@ public GetOverallBucketsRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Id private int? TopNValue { get; set; } /// - /// Refer to the description for the `allow_no_match` query parameter. + /// + /// Refer to the description for the allow_no_match query parameter. + /// /// public GetOverallBucketsRequestDescriptor AllowNoMatch(bool? allowNoMatch = true) { @@ -138,7 +190,9 @@ public GetOverallBucketsRequestDescriptor AllowNoMatch(bool? allowNoMatch = true } /// - /// Refer to the description for the `bucket_span` query parameter. + /// + /// Refer to the description for the bucket_span query parameter. + /// /// public GetOverallBucketsRequestDescriptor BucketSpan(Elastic.Clients.Elasticsearch.Duration? bucketSpan) { @@ -147,7 +201,9 @@ public GetOverallBucketsRequestDescriptor BucketSpan(Elastic.Clients.Elasticsear } /// - /// Refer to the description for the `end` query parameter. + /// + /// Refer to the description for the end query parameter. + /// /// public GetOverallBucketsRequestDescriptor End(DateTimeOffset? end) { @@ -156,7 +212,9 @@ public GetOverallBucketsRequestDescriptor End(DateTimeOffset? end) } /// - /// Refer to the description for the `exclude_interim` query parameter. + /// + /// Refer to the description for the exclude_interim query parameter. + /// /// public GetOverallBucketsRequestDescriptor ExcludeInterim(bool? excludeInterim = true) { @@ -165,7 +223,9 @@ public GetOverallBucketsRequestDescriptor ExcludeInterim(bool? excludeInterim = } /// - /// Refer to the description for the `overall_score` query parameter. + /// + /// Refer to the description for the overall_score query parameter. + /// /// public GetOverallBucketsRequestDescriptor OverallScore(object? overallScore) { @@ -174,7 +234,9 @@ public GetOverallBucketsRequestDescriptor OverallScore(object? overallScore) } /// - /// Refer to the description for the `start` query parameter. + /// + /// Refer to the description for the start query parameter. + /// /// public GetOverallBucketsRequestDescriptor Start(DateTimeOffset? start) { @@ -183,7 +245,9 @@ public GetOverallBucketsRequestDescriptor Start(DateTimeOffset? start) } /// - /// Refer to the description for the `top_n` query parameter. + /// + /// Refer to the description for the top_n query parameter. + /// /// public GetOverallBucketsRequestDescriptor TopN(int? topN) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetOverallBucketsResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetOverallBucketsResponse.g.cs index 0583178b551..341db374b03 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetOverallBucketsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetOverallBucketsResponse.g.cs @@ -32,7 +32,9 @@ public sealed partial class GetOverallBucketsResponse : ElasticsearchResponse public long Count { get; init; } /// - /// Array of overall bucket objects + /// + /// Array of overall bucket objects + /// /// [JsonInclude, JsonPropertyName("overall_buckets")] public IReadOnlyCollection OverallBuckets { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetRecordsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetRecordsRequest.g.cs index 09c226f35ff..2d078d3e2e2 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetRecordsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetRecordsRequest.g.cs @@ -32,18 +32,34 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class GetRecordsRequestParameters : RequestParameters { /// - /// Skips the specified number of records. + /// + /// Skips the specified number of records. + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of records to obtain. + /// + /// Specifies the maximum number of records to obtain. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Retrieves anomaly records for an anomaly detection job.
Records contain the detailed analytical results. They describe the anomalous
activity that has been identified in the input data based on the detector
configuration.
There can be many anomaly records depending on the characteristics and size
of the input data. In practice, there are often too many to be able to
manually process them. The machine learning features therefore perform a
sophisticated aggregation of the anomaly records into buckets.
The number of record results depends on the number of anomalies found in each
bucket, which relates to the number of time series being modeled and the
number of detectors. +/// +/// Retrieves anomaly records for an anomaly detection job. +/// Records contain the detailed analytical results. They describe the anomalous +/// activity that has been identified in the input data based on the detector +/// configuration. +/// There can be many anomaly records depending on the characteristics and size +/// of the input data. In practice, there are often too many to be able to +/// manually process them. The machine learning features therefore perform a +/// sophisticated aggregation of the anomaly records into buckets. +/// The number of record results depends on the number of anomalies found in each +/// bucket, which relates to the number of time series being modeled and the +/// number of detectors. +/// /// public sealed partial class GetRecordsRequest : PlainRequest { @@ -60,31 +76,41 @@ public GetRecordsRequest(Elastic.Clients.Elasticsearch.Id jobId) : base(r => r.R internal override string OperationName => "ml.get_records"; /// - /// Skips the specified number of records. + /// + /// Skips the specified number of records. + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of records to obtain. + /// + /// Specifies the maximum number of records to obtain. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } /// - /// Refer to the description for the `desc` query parameter. + /// + /// Refer to the description for the desc query parameter. + /// /// [JsonInclude, JsonPropertyName("desc")] public bool? Desc { get; set; } /// - /// Refer to the description for the `end` query parameter. + /// + /// Refer to the description for the end query parameter. + /// /// [JsonInclude, JsonPropertyName("end")] public DateTimeOffset? End { get; set; } /// - /// Refer to the description for the `exclude_interim` query parameter. + /// + /// Refer to the description for the exclude_interim query parameter. + /// /// [JsonInclude, JsonPropertyName("exclude_interim")] public bool? ExcludeInterim { get; set; } @@ -92,26 +118,44 @@ public GetRecordsRequest(Elastic.Clients.Elasticsearch.Id jobId) : base(r => r.R public Elastic.Clients.Elasticsearch.MachineLearning.Page? Page { get; set; } /// - /// Refer to the description for the `record_score` query parameter. + /// + /// Refer to the description for the record_score query parameter. + /// /// [JsonInclude, JsonPropertyName("record_score")] public double? RecordScore { get; set; } /// - /// Refer to the description for the `sort` query parameter. + /// + /// Refer to the description for the sort query parameter. + /// /// [JsonInclude, JsonPropertyName("sort")] public Elastic.Clients.Elasticsearch.Field? Sort { get; set; } /// - /// Refer to the description for the `start` query parameter. + /// + /// Refer to the description for the start query parameter. + /// /// [JsonInclude, JsonPropertyName("start")] public DateTimeOffset? Start { get; set; } } /// -/// Retrieves anomaly records for an anomaly detection job.
Records contain the detailed analytical results. They describe the anomalous
activity that has been identified in the input data based on the detector
configuration.
There can be many anomaly records depending on the characteristics and size
of the input data. In practice, there are often too many to be able to
manually process them. The machine learning features therefore perform a
sophisticated aggregation of the anomaly records into buckets.
The number of record results depends on the number of anomalies found in each
bucket, which relates to the number of time series being modeled and the
number of detectors. +/// +/// Retrieves anomaly records for an anomaly detection job. +/// Records contain the detailed analytical results. They describe the anomalous +/// activity that has been identified in the input data based on the detector +/// configuration. +/// There can be many anomaly records depending on the characteristics and size +/// of the input data. In practice, there are often too many to be able to +/// manually process them. The machine learning features therefore perform a +/// sophisticated aggregation of the anomaly records into buckets. +/// The number of record results depends on the number of anomalies found in each +/// bucket, which relates to the number of time series being modeled and the +/// number of detectors. +/// /// public sealed partial class GetRecordsRequestDescriptor : RequestDescriptor, GetRecordsRequestParameters> { @@ -149,7 +193,9 @@ public GetRecordsRequestDescriptor JobId(Elastic.Clients.Elasticsearc private DateTimeOffset? StartValue { get; set; } /// - /// Refer to the description for the `desc` query parameter. + /// + /// Refer to the description for the desc query parameter. + /// /// public GetRecordsRequestDescriptor Desc(bool? desc = true) { @@ -158,7 +204,9 @@ public GetRecordsRequestDescriptor Desc(bool? desc = true) } /// - /// Refer to the description for the `end` query parameter. + /// + /// Refer to the description for the end query parameter. + /// /// public GetRecordsRequestDescriptor End(DateTimeOffset? end) { @@ -167,7 +215,9 @@ public GetRecordsRequestDescriptor End(DateTimeOffset? end) } /// - /// Refer to the description for the `exclude_interim` query parameter. + /// + /// Refer to the description for the exclude_interim query parameter. + /// /// public GetRecordsRequestDescriptor ExcludeInterim(bool? excludeInterim = true) { @@ -200,7 +250,9 @@ public GetRecordsRequestDescriptor Page(Action - /// Refer to the description for the `record_score` query parameter. + /// + /// Refer to the description for the record_score query parameter. + /// /// public GetRecordsRequestDescriptor RecordScore(double? recordScore) { @@ -209,7 +261,9 @@ public GetRecordsRequestDescriptor RecordScore(double? recordScore) } /// - /// Refer to the description for the `sort` query parameter. + /// + /// Refer to the description for the sort query parameter. + /// /// public GetRecordsRequestDescriptor Sort(Elastic.Clients.Elasticsearch.Field? sort) { @@ -218,7 +272,9 @@ public GetRecordsRequestDescriptor Sort(Elastic.Clients.Elasticsearch } /// - /// Refer to the description for the `sort` query parameter. + /// + /// Refer to the description for the sort query parameter. + /// /// public GetRecordsRequestDescriptor Sort(Expression> sort) { @@ -227,7 +283,9 @@ public GetRecordsRequestDescriptor Sort(Expression - /// Refer to the description for the `sort` query parameter. + /// + /// Refer to the description for the sort query parameter. + /// /// public GetRecordsRequestDescriptor Sort(Expression> sort) { @@ -236,7 +294,9 @@ public GetRecordsRequestDescriptor Sort(Expression - /// Refer to the description for the `start` query parameter. + /// + /// Refer to the description for the start query parameter. + /// /// public GetRecordsRequestDescriptor Start(DateTimeOffset? start) { @@ -304,7 +364,19 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Retrieves anomaly records for an anomaly detection job.
Records contain the detailed analytical results. They describe the anomalous
activity that has been identified in the input data based on the detector
configuration.
There can be many anomaly records depending on the characteristics and size
of the input data. In practice, there are often too many to be able to
manually process them. The machine learning features therefore perform a
sophisticated aggregation of the anomaly records into buckets.
The number of record results depends on the number of anomalies found in each
bucket, which relates to the number of time series being modeled and the
number of detectors. +/// +/// Retrieves anomaly records for an anomaly detection job. +/// Records contain the detailed analytical results. They describe the anomalous +/// activity that has been identified in the input data based on the detector +/// configuration. +/// There can be many anomaly records depending on the characteristics and size +/// of the input data. In practice, there are often too many to be able to +/// manually process them. The machine learning features therefore perform a +/// sophisticated aggregation of the anomaly records into buckets. +/// The number of record results depends on the number of anomalies found in each +/// bucket, which relates to the number of time series being modeled and the +/// number of detectors. +/// /// public sealed partial class GetRecordsRequestDescriptor : RequestDescriptor { @@ -342,7 +414,9 @@ public GetRecordsRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Id jobId) private DateTimeOffset? StartValue { get; set; } /// - /// Refer to the description for the `desc` query parameter. + /// + /// Refer to the description for the desc query parameter. + /// /// public GetRecordsRequestDescriptor Desc(bool? desc = true) { @@ -351,7 +425,9 @@ public GetRecordsRequestDescriptor Desc(bool? desc = true) } /// - /// Refer to the description for the `end` query parameter. + /// + /// Refer to the description for the end query parameter. + /// /// public GetRecordsRequestDescriptor End(DateTimeOffset? end) { @@ -360,7 +436,9 @@ public GetRecordsRequestDescriptor End(DateTimeOffset? end) } /// - /// Refer to the description for the `exclude_interim` query parameter. + /// + /// Refer to the description for the exclude_interim query parameter. + /// /// public GetRecordsRequestDescriptor ExcludeInterim(bool? excludeInterim = true) { @@ -393,7 +471,9 @@ public GetRecordsRequestDescriptor Page(Action - /// Refer to the description for the `record_score` query parameter. + /// + /// Refer to the description for the record_score query parameter. + /// /// public GetRecordsRequestDescriptor RecordScore(double? recordScore) { @@ -402,7 +482,9 @@ public GetRecordsRequestDescriptor RecordScore(double? recordScore) } /// - /// Refer to the description for the `sort` query parameter. + /// + /// Refer to the description for the sort query parameter. + /// /// public GetRecordsRequestDescriptor Sort(Elastic.Clients.Elasticsearch.Field? sort) { @@ -411,7 +493,9 @@ public GetRecordsRequestDescriptor Sort(Elastic.Clients.Elasticsearch.Field? sor } /// - /// Refer to the description for the `sort` query parameter. + /// + /// Refer to the description for the sort query parameter. + /// /// public GetRecordsRequestDescriptor Sort(Expression> sort) { @@ -420,7 +504,9 @@ public GetRecordsRequestDescriptor Sort(Expression - /// Refer to the description for the `sort` query parameter. + /// + /// Refer to the description for the sort query parameter. + /// /// public GetRecordsRequestDescriptor Sort(Expression> sort) { @@ -429,7 +515,9 @@ public GetRecordsRequestDescriptor Sort(Expression - /// Refer to the description for the `start` query parameter. + /// + /// Refer to the description for the start query parameter. + /// /// public GetRecordsRequestDescriptor Start(DateTimeOffset? start) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetTrainedModelsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetTrainedModelsRequest.g.cs index 1d6e1164ac4..5f2ad77b380 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetTrainedModelsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetTrainedModelsRequest.g.cs @@ -32,45 +32,86 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class GetTrainedModelsRequestParameters : RequestParameters { /// - /// Specifies what to do when the request: - /// - Contains wildcard expressions and there are no models that match.
- Contains the _all string or no identifiers and there are no matches.
- Contains wildcard expressions and there are only partial matches. - /// If true, it returns an empty array when there are no matches and the
subset of results when there are partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no models that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// If true, it returns an empty array when there are no matches and the + /// subset of results when there are partial matches. + /// /// public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Specifies whether the included model definition should be returned as a
JSON map (true) or in a custom compressed format (false). + /// + /// Specifies whether the included model definition should be returned as a + /// JSON map (true) or in a custom compressed format (false). + /// /// public bool? DecompressDefinition { get => Q("decompress_definition"); set => Q("decompress_definition", value); } /// - /// Indicates if certain fields should be removed from the configuration on
retrieval. This allows the configuration to be in an acceptable format to
be retrieved and then added to another cluster. + /// + /// Indicates if certain fields should be removed from the configuration on + /// retrieval. This allows the configuration to be in an acceptable format to + /// be retrieved and then added to another cluster. + /// /// public bool? ExcludeGenerated { get => Q("exclude_generated"); set => Q("exclude_generated", value); } /// - /// Skips the specified number of models. + /// + /// Skips the specified number of models. + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// A comma delimited string of optional fields to include in the response
body. + /// + /// A comma delimited string of optional fields to include in the response + /// body. + /// /// public Elastic.Clients.Elasticsearch.MachineLearning.Include? Include { get => Q("include"); set => Q("include", value); } /// - /// Specifies the maximum number of models to obtain. + /// + /// Specifies the maximum number of models to obtain. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } /// - /// A comma delimited string of tags. A trained model can have many tags, or
none. When supplied, only trained models that contain all the supplied
tags are returned. + /// + /// A comma delimited string of tags. A trained model can have many tags, or + /// none. When supplied, only trained models that contain all the supplied + /// tags are returned. + /// /// public ICollection? Tags { get => Q?>("tags"); set => Q("tags", value); } } /// -/// Retrieves configuration information for a trained model. +/// +/// Retrieves configuration information for a trained model. +/// /// public sealed partial class GetTrainedModelsRequest : PlainRequest { @@ -91,52 +132,93 @@ public GetTrainedModelsRequest(Elastic.Clients.Elasticsearch.Ids? modelId) : bas internal override string OperationName => "ml.get_trained_models"; /// - /// Specifies what to do when the request: - /// - Contains wildcard expressions and there are no models that match.
- Contains the _all string or no identifiers and there are no matches.
- Contains wildcard expressions and there are only partial matches. - /// If true, it returns an empty array when there are no matches and the
subset of results when there are partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no models that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// If true, it returns an empty array when there are no matches and the + /// subset of results when there are partial matches. + /// /// [JsonIgnore] public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Specifies whether the included model definition should be returned as a
JSON map (true) or in a custom compressed format (false). + /// + /// Specifies whether the included model definition should be returned as a + /// JSON map (true) or in a custom compressed format (false). + /// /// [JsonIgnore] public bool? DecompressDefinition { get => Q("decompress_definition"); set => Q("decompress_definition", value); } /// - /// Indicates if certain fields should be removed from the configuration on
retrieval. This allows the configuration to be in an acceptable format to
be retrieved and then added to another cluster. + /// + /// Indicates if certain fields should be removed from the configuration on + /// retrieval. This allows the configuration to be in an acceptable format to + /// be retrieved and then added to another cluster. + /// /// [JsonIgnore] public bool? ExcludeGenerated { get => Q("exclude_generated"); set => Q("exclude_generated", value); } /// - /// Skips the specified number of models. + /// + /// Skips the specified number of models. + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// A comma delimited string of optional fields to include in the response
body. + /// + /// A comma delimited string of optional fields to include in the response + /// body. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.MachineLearning.Include? Include { get => Q("include"); set => Q("include", value); } /// - /// Specifies the maximum number of models to obtain. + /// + /// Specifies the maximum number of models to obtain. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } /// - /// A comma delimited string of tags. A trained model can have many tags, or
none. When supplied, only trained models that contain all the supplied
tags are returned. + /// + /// A comma delimited string of tags. A trained model can have many tags, or + /// none. When supplied, only trained models that contain all the supplied + /// tags are returned. + /// /// [JsonIgnore] public ICollection? Tags { get => Q?>("tags"); set => Q("tags", value); } } /// -/// Retrieves configuration information for a trained model. +/// +/// Retrieves configuration information for a trained model. +/// /// public sealed partial class GetTrainedModelsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetTrainedModelsResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetTrainedModelsResponse.g.cs index a3d245c1d25..ec971e39178 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetTrainedModelsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetTrainedModelsResponse.g.cs @@ -32,7 +32,9 @@ public sealed partial class GetTrainedModelsResponse : ElasticsearchResponse public int Count { get; init; } /// - /// An array of trained model resources, which are sorted by the model_id value in ascending order. + /// + /// An array of trained model resources, which are sorted by the model_id value in ascending order. + /// /// [JsonInclude, JsonPropertyName("trained_model_configs")] public IReadOnlyCollection TrainedModelConfigs { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetTrainedModelsStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetTrainedModelsStatsRequest.g.cs index c753296b995..ea37cb4fc38 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetTrainedModelsStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetTrainedModelsStatsRequest.g.cs @@ -32,25 +32,53 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class GetTrainedModelsStatsRequestParameters : RequestParameters { /// - /// Specifies what to do when the request: - /// - Contains wildcard expressions and there are no models that match.
- Contains the _all string or no identifiers and there are no matches.
- Contains wildcard expressions and there are only partial matches. - /// If true, it returns an empty array when there are no matches and the
subset of results when there are partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no models that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// If true, it returns an empty array when there are no matches and the + /// subset of results when there are partial matches. + /// /// public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Skips the specified number of models. + /// + /// Skips the specified number of models. + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of models to obtain. + /// + /// Specifies the maximum number of models to obtain. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Retrieves usage information for trained models. You can get usage information for multiple trained
models in a single API request by using a comma-separated list of model IDs or a wildcard expression. +/// +/// Retrieves usage information for trained models. You can get usage information for multiple trained +/// models in a single API request by using a comma-separated list of model IDs or a wildcard expression. +/// /// public sealed partial class GetTrainedModelsStatsRequest : PlainRequest { @@ -71,28 +99,56 @@ public GetTrainedModelsStatsRequest(Elastic.Clients.Elasticsearch.Ids? modelId) internal override string OperationName => "ml.get_trained_models_stats"; /// - /// Specifies what to do when the request: - /// - Contains wildcard expressions and there are no models that match.
- Contains the _all string or no identifiers and there are no matches.
- Contains wildcard expressions and there are only partial matches. - /// If true, it returns an empty array when there are no matches and the
subset of results when there are partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no models that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// If true, it returns an empty array when there are no matches and the + /// subset of results when there are partial matches. + /// /// [JsonIgnore] public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Skips the specified number of models. + /// + /// Skips the specified number of models. + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of models to obtain. + /// + /// Specifies the maximum number of models to obtain. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Retrieves usage information for trained models. You can get usage information for multiple trained
models in a single API request by using a comma-separated list of model IDs or a wildcard expression. +/// +/// Retrieves usage information for trained models. You can get usage information for multiple trained +/// models in a single API request by using a comma-separated list of model IDs or a wildcard expression. +/// /// public sealed partial class GetTrainedModelsStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetTrainedModelsStatsResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetTrainedModelsStatsResponse.g.cs index 2fc3544348b..d49b5734363 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetTrainedModelsStatsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/GetTrainedModelsStatsResponse.g.cs @@ -29,13 +29,17 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class GetTrainedModelsStatsResponse : ElasticsearchResponse { /// - /// The total number of trained model statistics that matched the requested ID patterns. Could be higher than the number of items in the trained_model_stats array as the size of the array is restricted by the supplied size parameter. + /// + /// The total number of trained model statistics that matched the requested ID patterns. Could be higher than the number of items in the trained_model_stats array as the size of the array is restricted by the supplied size parameter. + /// /// [JsonInclude, JsonPropertyName("count")] public int Count { get; init; } /// - /// An array of trained model statistics, which are sorted by the model_id value in ascending order. + /// + /// An array of trained model statistics, which are sorted by the model_id value in ascending order. + /// /// [JsonInclude, JsonPropertyName("trained_model_stats")] public IReadOnlyCollection TrainedModelStats { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/InferTrainedModelRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/InferTrainedModelRequest.g.cs index 9209f758cd3..c304bbe91ec 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/InferTrainedModelRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/InferTrainedModelRequest.g.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class InferTrainedModelRequestParameters : RequestParameters { /// - /// Controls the amount of time to wait for inference results. + /// + /// Controls the amount of time to wait for inference results. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Evaluates a trained model. +/// +/// Evaluates a trained model. +/// /// public sealed partial class InferTrainedModelRequest : PlainRequest { @@ -55,26 +59,36 @@ public InferTrainedModelRequest(Elastic.Clients.Elasticsearch.Id modelId) : base internal override string OperationName => "ml.infer_trained_model"; /// - /// Controls the amount of time to wait for inference results. + /// + /// Controls the amount of time to wait for inference results. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// An array of objects to pass to the model for inference. The objects should contain a fields matching your
configured trained model input. Typically, for NLP models, the field name is `text_field`.
Currently, for NLP models, only a single value is allowed. + /// + /// An array of objects to pass to the model for inference. The objects should contain a fields matching your + /// configured trained model input. Typically, for NLP models, the field name is text_field. + /// Currently, for NLP models, only a single value is allowed. + /// /// [JsonInclude, JsonPropertyName("docs")] public ICollection> Docs { get; set; } /// - /// The inference configuration updates to apply on the API call + /// + /// The inference configuration updates to apply on the API call + /// /// [JsonInclude, JsonPropertyName("inference_config")] public Elastic.Clients.Elasticsearch.MachineLearning.InferenceConfigUpdate? InferenceConfig { get; set; } } /// -/// Evaluates a trained model. +/// +/// Evaluates a trained model. +/// /// public sealed partial class InferTrainedModelRequestDescriptor : RequestDescriptor, InferTrainedModelRequestParameters> { @@ -106,7 +120,11 @@ public InferTrainedModelRequestDescriptor ModelId(Elastic.Clients.Ela private Action> InferenceConfigDescriptorAction { get; set; } /// - /// An array of objects to pass to the model for inference. The objects should contain a fields matching your
configured trained model input. Typically, for NLP models, the field name is `text_field`.
Currently, for NLP models, only a single value is allowed. + /// + /// An array of objects to pass to the model for inference. The objects should contain a fields matching your + /// configured trained model input. Typically, for NLP models, the field name is text_field. + /// Currently, for NLP models, only a single value is allowed. + /// /// public InferTrainedModelRequestDescriptor Docs(ICollection> docs) { @@ -115,7 +133,9 @@ public InferTrainedModelRequestDescriptor Docs(ICollection - /// The inference configuration updates to apply on the API call + /// + /// The inference configuration updates to apply on the API call + /// /// public InferTrainedModelRequestDescriptor InferenceConfig(Elastic.Clients.Elasticsearch.MachineLearning.InferenceConfigUpdate? inferenceConfig) { @@ -167,7 +187,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Evaluates a trained model. +/// +/// Evaluates a trained model. +/// /// public sealed partial class InferTrainedModelRequestDescriptor : RequestDescriptor { @@ -199,7 +221,11 @@ public InferTrainedModelRequestDescriptor ModelId(Elastic.Clients.Elasticsearch. private Action InferenceConfigDescriptorAction { get; set; } /// - /// An array of objects to pass to the model for inference. The objects should contain a fields matching your
configured trained model input. Typically, for NLP models, the field name is `text_field`.
Currently, for NLP models, only a single value is allowed. + /// + /// An array of objects to pass to the model for inference. The objects should contain a fields matching your + /// configured trained model input. Typically, for NLP models, the field name is text_field. + /// Currently, for NLP models, only a single value is allowed. + /// /// public InferTrainedModelRequestDescriptor Docs(ICollection> docs) { @@ -208,7 +234,9 @@ public InferTrainedModelRequestDescriptor Docs(ICollection - /// The inference configuration updates to apply on the API call + /// + /// The inference configuration updates to apply on the API call + /// /// public InferTrainedModelRequestDescriptor InferenceConfig(Elastic.Clients.Elasticsearch.MachineLearning.InferenceConfigUpdate? inferenceConfig) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/MlInfoRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/MlInfoRequest.g.cs index 0115e340291..2bbb17547a4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/MlInfoRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/MlInfoRequest.g.cs @@ -34,7 +34,15 @@ public sealed partial class MlInfoRequestParameters : RequestParameters } /// -/// Returns defaults and limits used by machine learning.
This endpoint is designed to be used by a user interface that needs to fully
understand machine learning configurations where some options are not
specified, meaning that the defaults should be used. This endpoint may be
used to find out what those defaults are. It also provides information about
the maximum size of machine learning jobs that could run in the current
cluster configuration. +/// +/// Returns defaults and limits used by machine learning. +/// This endpoint is designed to be used by a user interface that needs to fully +/// understand machine learning configurations where some options are not +/// specified, meaning that the defaults should be used. This endpoint may be +/// used to find out what those defaults are. It also provides information about +/// the maximum size of machine learning jobs that could run in the current +/// cluster configuration. +/// /// public sealed partial class MlInfoRequest : PlainRequest { @@ -48,7 +56,15 @@ public sealed partial class MlInfoRequest : PlainRequest -/// Returns defaults and limits used by machine learning.
This endpoint is designed to be used by a user interface that needs to fully
understand machine learning configurations where some options are not
specified, meaning that the defaults should be used. This endpoint may be
used to find out what those defaults are. It also provides information about
the maximum size of machine learning jobs that could run in the current
cluster configuration. +/// +/// Returns defaults and limits used by machine learning. +/// This endpoint is designed to be used by a user interface that needs to fully +/// understand machine learning configurations where some options are not +/// specified, meaning that the defaults should be used. This endpoint may be +/// used to find out what those defaults are. It also provides information about +/// the maximum size of machine learning jobs that could run in the current +/// cluster configuration. +/// /// public sealed partial class MlInfoRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/OpenJobRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/OpenJobRequest.g.cs index 582feff4fe9..ef8d5864c0f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/OpenJobRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/OpenJobRequest.g.cs @@ -34,7 +34,16 @@ public sealed partial class OpenJobRequestParameters : RequestParameters } /// -/// Open anomaly detection jobs.
An anomaly detection job must be opened in order for it to be ready to
receive and analyze data. It can be opened and closed multiple times
throughout its lifecycle.
When you open a new job, it starts with an empty model.
When you open an existing job, the most recent model state is automatically
loaded. The job is ready to resume its analysis from where it left off, once
new data is received. +/// +/// Open anomaly detection jobs. +/// An anomaly detection job must be opened in order for it to be ready to +/// receive and analyze data. It can be opened and closed multiple times +/// throughout its lifecycle. +/// When you open a new job, it starts with an empty model. +/// When you open an existing job, the most recent model state is automatically +/// loaded. The job is ready to resume its analysis from where it left off, once +/// new data is received. +/// /// public sealed partial class OpenJobRequest : PlainRequest { @@ -51,14 +60,25 @@ public OpenJobRequest(Elastic.Clients.Elasticsearch.Id jobId) : base(r => r.Requ internal override string OperationName => "ml.open_job"; /// - /// Refer to the description for the `timeout` query parameter. + /// + /// Refer to the description for the timeout query parameter. + /// /// [JsonInclude, JsonPropertyName("timeout")] public Elastic.Clients.Elasticsearch.Duration? Timeout { get; set; } } /// -/// Open anomaly detection jobs.
An anomaly detection job must be opened in order for it to be ready to
receive and analyze data. It can be opened and closed multiple times
throughout its lifecycle.
When you open a new job, it starts with an empty model.
When you open an existing job, the most recent model state is automatically
loaded. The job is ready to resume its analysis from where it left off, once
new data is received. +/// +/// Open anomaly detection jobs. +/// An anomaly detection job must be opened in order for it to be ready to +/// receive and analyze data. It can be opened and closed multiple times +/// throughout its lifecycle. +/// When you open a new job, it starts with an empty model. +/// When you open an existing job, the most recent model state is automatically +/// loaded. The job is ready to resume its analysis from where it left off, once +/// new data is received. +/// /// public sealed partial class OpenJobRequestDescriptor : RequestDescriptor { @@ -85,7 +105,9 @@ public OpenJobRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Id jobId) private Elastic.Clients.Elasticsearch.Duration? TimeoutValue { get; set; } /// - /// Refer to the description for the `timeout` query parameter. + /// + /// Refer to the description for the timeout query parameter. + /// /// public OpenJobRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Duration? timeout) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/OpenJobResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/OpenJobResponse.g.cs index 80946336696..af8427ee8e5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/OpenJobResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/OpenJobResponse.g.cs @@ -29,7 +29,10 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class OpenJobResponse : ElasticsearchResponse { /// - /// The ID of the node that the job was started on. In serverless this will be the "serverless".
If the job is allowed to open lazily and has not yet been assigned to a node, this value is an empty string. + /// + /// The ID of the node that the job was started on. In serverless this will be the "serverless". + /// If the job is allowed to open lazily and has not yet been assigned to a node, this value is an empty string. + /// /// [JsonInclude, JsonPropertyName("node")] public string Node { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PostCalendarEventsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PostCalendarEventsRequest.g.cs index 075eda09e02..dcfa2c3ce5d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PostCalendarEventsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PostCalendarEventsRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class PostCalendarEventsRequestParameters : RequestParamet } /// -/// Adds scheduled events to a calendar. +/// +/// Adds scheduled events to a calendar. +/// /// public sealed partial class PostCalendarEventsRequest : PlainRequest { @@ -51,14 +53,18 @@ public PostCalendarEventsRequest(Elastic.Clients.Elasticsearch.Id calendarId) : internal override string OperationName => "ml.post_calendar_events"; /// - /// A list of one of more scheduled events. The event’s start and end times can be specified as integer milliseconds since the epoch or as a string in ISO 8601 format. + /// + /// A list of one of more scheduled events. The event’s start and end times can be specified as integer milliseconds since the epoch or as a string in ISO 8601 format. + /// /// [JsonInclude, JsonPropertyName("events")] public ICollection Events { get; set; } } /// -/// Adds scheduled events to a calendar. +/// +/// Adds scheduled events to a calendar. +/// /// public sealed partial class PostCalendarEventsRequestDescriptor : RequestDescriptor { @@ -88,7 +94,9 @@ public PostCalendarEventsRequestDescriptor CalendarId(Elastic.Clients.Elasticsea private Action[] EventsDescriptorActions { get; set; } /// - /// A list of one of more scheduled events. The event’s start and end times can be specified as integer milliseconds since the epoch or as a string in ISO 8601 format. + /// + /// A list of one of more scheduled events. The event’s start and end times can be specified as integer milliseconds since the epoch or as a string in ISO 8601 format. + /// /// public PostCalendarEventsRequestDescriptor Events(ICollection events) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PreviewDataFrameAnalyticsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PreviewDataFrameAnalyticsRequest.g.cs index 6a7db339c8b..14baf5f49df 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PreviewDataFrameAnalyticsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PreviewDataFrameAnalyticsRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class PreviewDataFrameAnalyticsRequestParameters : Request } /// -/// Previews the extracted features used by a data frame analytics config. +/// +/// Previews the extracted features used by a data frame analytics config. +/// /// public sealed partial class PreviewDataFrameAnalyticsRequest : PlainRequest { @@ -55,14 +57,20 @@ public PreviewDataFrameAnalyticsRequest(Elastic.Clients.Elasticsearch.Id? id) : internal override string OperationName => "ml.preview_data_frame_analytics"; /// - /// A data frame analytics config as described in create data frame analytics
jobs. Note that `id` and `dest` don’t need to be provided in the context of
this API. + /// + /// A data frame analytics config as described in create data frame analytics + /// jobs. Note that id and dest don’t need to be provided in the context of + /// this API. + /// /// [JsonInclude, JsonPropertyName("config")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframePreviewConfig? Config { get; set; } } /// -/// Previews the extracted features used by a data frame analytics config. +/// +/// Previews the extracted features used by a data frame analytics config. +/// /// public sealed partial class PreviewDataFrameAnalyticsRequestDescriptor : RequestDescriptor, PreviewDataFrameAnalyticsRequestParameters> { @@ -95,7 +103,11 @@ public PreviewDataFrameAnalyticsRequestDescriptor Id(Elastic.Clients. private Action> ConfigDescriptorAction { get; set; } /// - /// A data frame analytics config as described in create data frame analytics
jobs. Note that `id` and `dest` don’t need to be provided in the context of
this API. + /// + /// A data frame analytics config as described in create data frame analytics + /// jobs. Note that id and dest don’t need to be provided in the context of + /// this API. + /// /// public PreviewDataFrameAnalyticsRequestDescriptor Config(Elastic.Clients.Elasticsearch.MachineLearning.DataframePreviewConfig? config) { @@ -145,7 +157,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Previews the extracted features used by a data frame analytics config. +/// +/// Previews the extracted features used by a data frame analytics config. +/// /// public sealed partial class PreviewDataFrameAnalyticsRequestDescriptor : RequestDescriptor { @@ -178,7 +192,11 @@ public PreviewDataFrameAnalyticsRequestDescriptor Id(Elastic.Clients.Elasticsear private Action ConfigDescriptorAction { get; set; } /// - /// A data frame analytics config as described in create data frame analytics
jobs. Note that `id` and `dest` don’t need to be provided in the context of
this API. + /// + /// A data frame analytics config as described in create data frame analytics + /// jobs. Note that id and dest don’t need to be provided in the context of + /// this API. + /// /// public PreviewDataFrameAnalyticsRequestDescriptor Config(Elastic.Clients.Elasticsearch.MachineLearning.DataframePreviewConfig? config) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PreviewDataFrameAnalyticsResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PreviewDataFrameAnalyticsResponse.g.cs index 9e82f462ce5..3247772bece 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PreviewDataFrameAnalyticsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PreviewDataFrameAnalyticsResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class PreviewDataFrameAnalyticsResponse : ElasticsearchResponse { /// - /// An array of objects that contain feature name and value pairs. The features have been processed and indicate what will be sent to the model for training. + /// + /// An array of objects that contain feature name and value pairs. The features have been processed and indicate what will be sent to the model for training. + /// /// [JsonInclude, JsonPropertyName("feature_values")] public IReadOnlyCollection> FeatureValues { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutCalendarJobRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutCalendarJobRequest.g.cs index 36e341303ab..83a169273a1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutCalendarJobRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutCalendarJobRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class PutCalendarJobRequestParameters : RequestParameters } /// -/// Adds an anomaly detection job to a calendar. +/// +/// Adds an anomaly detection job to a calendar. +/// /// public sealed partial class PutCalendarJobRequest : PlainRequest { @@ -52,7 +54,9 @@ public PutCalendarJobRequest(Elastic.Clients.Elasticsearch.Id calendarId, Elasti } /// -/// Adds an anomaly detection job to a calendar. +/// +/// Adds an anomaly detection job to a calendar. +/// /// public sealed partial class PutCalendarJobRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutCalendarJobResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutCalendarJobResponse.g.cs index 790e9582f5f..6c5d6e9ec7c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutCalendarJobResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutCalendarJobResponse.g.cs @@ -29,19 +29,25 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class PutCalendarJobResponse : ElasticsearchResponse { /// - /// A string that uniquely identifies a calendar. + /// + /// A string that uniquely identifies a calendar. + /// /// [JsonInclude, JsonPropertyName("calendar_id")] public string CalendarId { get; init; } /// - /// A description of the calendar. + /// + /// A description of the calendar. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; init; } /// - /// A list of anomaly detection job identifiers or group names. + /// + /// A list of anomaly detection job identifiers or group names. + /// /// [JsonInclude, JsonPropertyName("job_ids")] [SingleOrManyCollectionConverter(typeof(string))] diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutCalendarRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutCalendarRequest.g.cs index 721793f7f21..15f94ccaa60 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutCalendarRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutCalendarRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class PutCalendarRequestParameters : RequestParameters } /// -/// Creates a calendar. +/// +/// Creates a calendar. +/// /// public sealed partial class PutCalendarRequest : PlainRequest { @@ -51,20 +53,26 @@ public PutCalendarRequest(Elastic.Clients.Elasticsearch.Id calendarId) : base(r internal override string OperationName => "ml.put_calendar"; /// - /// A description of the calendar. + /// + /// A description of the calendar. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// An array of anomaly detection job identifiers. + /// + /// An array of anomaly detection job identifiers. + /// /// [JsonInclude, JsonPropertyName("job_ids")] public ICollection? JobIds { get; set; } } /// -/// Creates a calendar. +/// +/// Creates a calendar. +/// /// public sealed partial class PutCalendarRequestDescriptor : RequestDescriptor { @@ -92,7 +100,9 @@ public PutCalendarRequestDescriptor CalendarId(Elastic.Clients.Elasticsearch.Id private ICollection? JobIdsValue { get; set; } /// - /// A description of the calendar. + /// + /// A description of the calendar. + /// /// public PutCalendarRequestDescriptor Description(string? description) { @@ -101,7 +111,9 @@ public PutCalendarRequestDescriptor Description(string? description) } /// - /// An array of anomaly detection job identifiers. + /// + /// An array of anomaly detection job identifiers. + /// /// public PutCalendarRequestDescriptor JobIds(ICollection? jobIds) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutCalendarResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutCalendarResponse.g.cs index 1f99d1ba02d..191a67ad6f5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutCalendarResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutCalendarResponse.g.cs @@ -29,19 +29,25 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class PutCalendarResponse : ElasticsearchResponse { /// - /// A string that uniquely identifies a calendar. + /// + /// A string that uniquely identifies a calendar. + /// /// [JsonInclude, JsonPropertyName("calendar_id")] public string CalendarId { get; init; } /// - /// A description of the calendar. + /// + /// A description of the calendar. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; init; } /// - /// A list of anomaly detection job identifiers or group names. + /// + /// A list of anomaly detection job identifiers or group names. + /// /// [JsonInclude, JsonPropertyName("job_ids")] [SingleOrManyCollectionConverter(typeof(string))] diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutDataFrameAnalyticsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutDataFrameAnalyticsRequest.g.cs index 87c5e3f8dcb..b9b16a3c3fe 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutDataFrameAnalyticsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutDataFrameAnalyticsRequest.g.cs @@ -34,7 +34,11 @@ public sealed partial class PutDataFrameAnalyticsRequestParameters : RequestPara } /// -/// Instantiates a data frame analytics job.
This API creates a data frame analytics job that performs an analysis on the
source indices and stores the outcome in a destination index. +/// +/// Instantiates a data frame analytics job. +/// This API creates a data frame analytics job that performs an analysis on the +/// source indices and stores the outcome in a destination index. +/// /// public sealed partial class PutDataFrameAnalyticsRequest : PlainRequest { @@ -51,31 +55,77 @@ public PutDataFrameAnalyticsRequest(Elastic.Clients.Elasticsearch.Id id) : base( internal override string OperationName => "ml.put_data_frame_analytics"; /// - /// Specifies whether this job can start when there is insufficient machine
learning node capacity for it to be immediately assigned to a node. If
set to `false` and a machine learning node with capacity to run the job
cannot be immediately found, the API returns an error. If set to `true`,
the API does not return an error; the job waits in the `starting` state
until sufficient machine learning node capacity is available. This
behavior is also affected by the cluster-wide
`xpack.ml.max_lazy_ml_nodes` setting. + /// + /// Specifies whether this job can start when there is insufficient machine + /// learning node capacity for it to be immediately assigned to a node. If + /// set to false and a machine learning node with capacity to run the job + /// cannot be immediately found, the API returns an error. If set to true, + /// the API does not return an error; the job waits in the starting state + /// until sufficient machine learning node capacity is available. This + /// behavior is also affected by the cluster-wide + /// xpack.ml.max_lazy_ml_nodes setting. + /// /// [JsonInclude, JsonPropertyName("allow_lazy_start")] public bool? AllowLazyStart { get; set; } /// - /// The analysis configuration, which contains the information necessary to
perform one of the following types of analysis: classification, outlier
detection, or regression. + /// + /// The analysis configuration, which contains the information necessary to + /// perform one of the following types of analysis: classification, outlier + /// detection, or regression. + /// /// [JsonInclude, JsonPropertyName("analysis")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalysis Analysis { get; set; } /// - /// Specifies `includes` and/or `excludes` patterns to select which fields
will be included in the analysis. The patterns specified in `excludes`
are applied last, therefore `excludes` takes precedence. In other words,
if the same field is specified in both `includes` and `excludes`, then
the field will not be included in the analysis. If `analyzed_fields` is
not set, only the relevant fields will be included. For example, all the
numeric fields for outlier detection.
The supported fields vary for each type of analysis. Outlier detection
requires numeric or `boolean` data to analyze. The algorithms don’t
support missing values therefore fields that have data types other than
numeric or boolean are ignored. Documents where included fields contain
missing values, null values, or an array are also ignored. Therefore the
`dest` index may contain documents that don’t have an outlier score.
Regression supports fields that are numeric, `boolean`, `text`,
`keyword`, and `ip` data types. It is also tolerant of missing values.
Fields that are supported are included in the analysis, other fields are
ignored. Documents where included fields contain an array with two or
more values are also ignored. Documents in the `dest` index that don’t
contain a results field are not included in the regression analysis.
Classification supports fields that are numeric, `boolean`, `text`,
`keyword`, and `ip` data types. It is also tolerant of missing values.
Fields that are supported are included in the analysis, other fields are
ignored. Documents where included fields contain an array with two or
more values are also ignored. Documents in the `dest` index that don’t
contain a results field are not included in the classification analysis.
Classification analysis can be improved by mapping ordinal variable
values to a single number. For example, in case of age ranges, you can
model the values as `0-14 = 0`, `15-24 = 1`, `25-34 = 2`, and so on. + /// + /// Specifies includes and/or excludes patterns to select which fields + /// will be included in the analysis. The patterns specified in excludes + /// are applied last, therefore excludes takes precedence. In other words, + /// if the same field is specified in both includes and excludes, then + /// the field will not be included in the analysis. If analyzed_fields is + /// not set, only the relevant fields will be included. For example, all the + /// numeric fields for outlier detection. + /// The supported fields vary for each type of analysis. Outlier detection + /// requires numeric or boolean data to analyze. The algorithms don’t + /// support missing values therefore fields that have data types other than + /// numeric or boolean are ignored. Documents where included fields contain + /// missing values, null values, or an array are also ignored. Therefore the + /// dest index may contain documents that don’t have an outlier score. + /// Regression supports fields that are numeric, boolean, text, + /// keyword, and ip data types. It is also tolerant of missing values. + /// Fields that are supported are included in the analysis, other fields are + /// ignored. Documents where included fields contain an array with two or + /// more values are also ignored. Documents in the dest index that don’t + /// contain a results field are not included in the regression analysis. + /// Classification supports fields that are numeric, boolean, text, + /// keyword, and ip data types. It is also tolerant of missing values. + /// Fields that are supported are included in the analysis, other fields are + /// ignored. Documents where included fields contain an array with two or + /// more values are also ignored. Documents in the dest index that don’t + /// contain a results field are not included in the classification analysis. + /// Classification analysis can be improved by mapping ordinal variable + /// values to a single number. For example, in case of age ranges, you can + /// model the values as 0-14 = 0, 15-24 = 1, 25-34 = 2, and so on. + /// /// [JsonInclude, JsonPropertyName("analyzed_fields")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalysisAnalyzedFields? AnalyzedFields { get; set; } /// - /// A description of the job. + /// + /// A description of the job. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The destination configuration. + /// + /// The destination configuration. + /// /// [JsonInclude, JsonPropertyName("dest")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalyticsDestination Dest { get; set; } @@ -83,19 +133,32 @@ public PutDataFrameAnalyticsRequest(Elastic.Clients.Elasticsearch.Id id) : base( public IDictionary>>? Headers { get; set; } /// - /// The maximum number of threads to be used by the analysis. Using more
threads may decrease the time necessary to complete the analysis at the
cost of using more CPU. Note that the process may use additional threads
for operational functionality other than the analysis itself. + /// + /// The maximum number of threads to be used by the analysis. Using more + /// threads may decrease the time necessary to complete the analysis at the + /// cost of using more CPU. Note that the process may use additional threads + /// for operational functionality other than the analysis itself. + /// /// [JsonInclude, JsonPropertyName("max_num_threads")] public int? MaxNumThreads { get; set; } /// - /// The approximate maximum amount of memory resources that are permitted for
analytical processing. If your `elasticsearch.yml` file contains an
`xpack.ml.max_model_memory_limit` setting, an error occurs when you try
to create data frame analytics jobs that have `model_memory_limit` values
greater than that setting. + /// + /// The approximate maximum amount of memory resources that are permitted for + /// analytical processing. If your elasticsearch.yml file contains an + /// xpack.ml.max_model_memory_limit setting, an error occurs when you try + /// to create data frame analytics jobs that have model_memory_limit values + /// greater than that setting. + /// /// [JsonInclude, JsonPropertyName("model_memory_limit")] public string? ModelMemoryLimit { get; set; } /// - /// The configuration of how to source the analysis data. + /// + /// The configuration of how to source the analysis data. + /// /// [JsonInclude, JsonPropertyName("source")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalyticsSource Source { get; set; } @@ -104,7 +167,11 @@ public PutDataFrameAnalyticsRequest(Elastic.Clients.Elasticsearch.Id id) : base( } /// -/// Instantiates a data frame analytics job.
This API creates a data frame analytics job that performs an analysis on the
source indices and stores the outcome in a destination index. +/// +/// Instantiates a data frame analytics job. +/// This API creates a data frame analytics job that performs an analysis on the +/// source indices and stores the outcome in a destination index. +/// /// public sealed partial class PutDataFrameAnalyticsRequestDescriptor : RequestDescriptor, PutDataFrameAnalyticsRequestParameters> { @@ -148,7 +215,16 @@ public PutDataFrameAnalyticsRequestDescriptor Id(Elastic.Clients.Elas private string? VersionValue { get; set; } /// - /// Specifies whether this job can start when there is insufficient machine
learning node capacity for it to be immediately assigned to a node. If
set to `false` and a machine learning node with capacity to run the job
cannot be immediately found, the API returns an error. If set to `true`,
the API does not return an error; the job waits in the `starting` state
until sufficient machine learning node capacity is available. This
behavior is also affected by the cluster-wide
`xpack.ml.max_lazy_ml_nodes` setting. + /// + /// Specifies whether this job can start when there is insufficient machine + /// learning node capacity for it to be immediately assigned to a node. If + /// set to false and a machine learning node with capacity to run the job + /// cannot be immediately found, the API returns an error. If set to true, + /// the API does not return an error; the job waits in the starting state + /// until sufficient machine learning node capacity is available. This + /// behavior is also affected by the cluster-wide + /// xpack.ml.max_lazy_ml_nodes setting. + /// /// public PutDataFrameAnalyticsRequestDescriptor AllowLazyStart(bool? allowLazyStart = true) { @@ -157,7 +233,11 @@ public PutDataFrameAnalyticsRequestDescriptor AllowLazyStart(bool? al } /// - /// The analysis configuration, which contains the information necessary to
perform one of the following types of analysis: classification, outlier
detection, or regression. + /// + /// The analysis configuration, which contains the information necessary to + /// perform one of the following types of analysis: classification, outlier + /// detection, or regression. + /// /// public PutDataFrameAnalyticsRequestDescriptor Analysis(Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalysis analysis) { @@ -184,7 +264,36 @@ public PutDataFrameAnalyticsRequestDescriptor Analysis(Action - /// Specifies `includes` and/or `excludes` patterns to select which fields
will be included in the analysis. The patterns specified in `excludes`
are applied last, therefore `excludes` takes precedence. In other words,
if the same field is specified in both `includes` and `excludes`, then
the field will not be included in the analysis. If `analyzed_fields` is
not set, only the relevant fields will be included. For example, all the
numeric fields for outlier detection.
The supported fields vary for each type of analysis. Outlier detection
requires numeric or `boolean` data to analyze. The algorithms don’t
support missing values therefore fields that have data types other than
numeric or boolean are ignored. Documents where included fields contain
missing values, null values, or an array are also ignored. Therefore the
`dest` index may contain documents that don’t have an outlier score.
Regression supports fields that are numeric, `boolean`, `text`,
`keyword`, and `ip` data types. It is also tolerant of missing values.
Fields that are supported are included in the analysis, other fields are
ignored. Documents where included fields contain an array with two or
more values are also ignored. Documents in the `dest` index that don’t
contain a results field are not included in the regression analysis.
Classification supports fields that are numeric, `boolean`, `text`,
`keyword`, and `ip` data types. It is also tolerant of missing values.
Fields that are supported are included in the analysis, other fields are
ignored. Documents where included fields contain an array with two or
more values are also ignored. Documents in the `dest` index that don’t
contain a results field are not included in the classification analysis.
Classification analysis can be improved by mapping ordinal variable
values to a single number. For example, in case of age ranges, you can
model the values as `0-14 = 0`, `15-24 = 1`, `25-34 = 2`, and so on. + /// + /// Specifies includes and/or excludes patterns to select which fields + /// will be included in the analysis. The patterns specified in excludes + /// are applied last, therefore excludes takes precedence. In other words, + /// if the same field is specified in both includes and excludes, then + /// the field will not be included in the analysis. If analyzed_fields is + /// not set, only the relevant fields will be included. For example, all the + /// numeric fields for outlier detection. + /// The supported fields vary for each type of analysis. Outlier detection + /// requires numeric or boolean data to analyze. The algorithms don’t + /// support missing values therefore fields that have data types other than + /// numeric or boolean are ignored. Documents where included fields contain + /// missing values, null values, or an array are also ignored. Therefore the + /// dest index may contain documents that don’t have an outlier score. + /// Regression supports fields that are numeric, boolean, text, + /// keyword, and ip data types. It is also tolerant of missing values. + /// Fields that are supported are included in the analysis, other fields are + /// ignored. Documents where included fields contain an array with two or + /// more values are also ignored. Documents in the dest index that don’t + /// contain a results field are not included in the regression analysis. + /// Classification supports fields that are numeric, boolean, text, + /// keyword, and ip data types. It is also tolerant of missing values. + /// Fields that are supported are included in the analysis, other fields are + /// ignored. Documents where included fields contain an array with two or + /// more values are also ignored. Documents in the dest index that don’t + /// contain a results field are not included in the classification analysis. + /// Classification analysis can be improved by mapping ordinal variable + /// values to a single number. For example, in case of age ranges, you can + /// model the values as 0-14 = 0, 15-24 = 1, 25-34 = 2, and so on. + /// /// public PutDataFrameAnalyticsRequestDescriptor AnalyzedFields(Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalysisAnalyzedFields? analyzedFields) { @@ -211,7 +320,9 @@ public PutDataFrameAnalyticsRequestDescriptor AnalyzedFields(Action - /// A description of the job. + /// + /// A description of the job. + /// /// public PutDataFrameAnalyticsRequestDescriptor Description(string? description) { @@ -220,7 +331,9 @@ public PutDataFrameAnalyticsRequestDescriptor Description(string? des } /// - /// The destination configuration. + /// + /// The destination configuration. + /// /// public PutDataFrameAnalyticsRequestDescriptor Dest(Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalyticsDestination dest) { @@ -253,7 +366,12 @@ public PutDataFrameAnalyticsRequestDescriptor Headers(Func - /// The maximum number of threads to be used by the analysis. Using more
threads may decrease the time necessary to complete the analysis at the
cost of using more CPU. Note that the process may use additional threads
for operational functionality other than the analysis itself. + /// + /// The maximum number of threads to be used by the analysis. Using more + /// threads may decrease the time necessary to complete the analysis at the + /// cost of using more CPU. Note that the process may use additional threads + /// for operational functionality other than the analysis itself. + /// /// public PutDataFrameAnalyticsRequestDescriptor MaxNumThreads(int? maxNumThreads) { @@ -262,7 +380,13 @@ public PutDataFrameAnalyticsRequestDescriptor MaxNumThreads(int? maxN } /// - /// The approximate maximum amount of memory resources that are permitted for
analytical processing. If your `elasticsearch.yml` file contains an
`xpack.ml.max_model_memory_limit` setting, an error occurs when you try
to create data frame analytics jobs that have `model_memory_limit` values
greater than that setting. + /// + /// The approximate maximum amount of memory resources that are permitted for + /// analytical processing. If your elasticsearch.yml file contains an + /// xpack.ml.max_model_memory_limit setting, an error occurs when you try + /// to create data frame analytics jobs that have model_memory_limit values + /// greater than that setting. + /// /// public PutDataFrameAnalyticsRequestDescriptor ModelMemoryLimit(string? modelMemoryLimit) { @@ -271,7 +395,9 @@ public PutDataFrameAnalyticsRequestDescriptor ModelMemoryLimit(string } /// - /// The configuration of how to source the analysis data. + /// + /// The configuration of how to source the analysis data. + /// /// public PutDataFrameAnalyticsRequestDescriptor Source(Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalyticsSource source) { @@ -411,7 +537,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Instantiates a data frame analytics job.
This API creates a data frame analytics job that performs an analysis on the
source indices and stores the outcome in a destination index. +/// +/// Instantiates a data frame analytics job. +/// This API creates a data frame analytics job that performs an analysis on the +/// source indices and stores the outcome in a destination index. +/// /// public sealed partial class PutDataFrameAnalyticsRequestDescriptor : RequestDescriptor { @@ -455,7 +585,16 @@ public PutDataFrameAnalyticsRequestDescriptor Id(Elastic.Clients.Elasticsearch.I private string? VersionValue { get; set; } /// - /// Specifies whether this job can start when there is insufficient machine
learning node capacity for it to be immediately assigned to a node. If
set to `false` and a machine learning node with capacity to run the job
cannot be immediately found, the API returns an error. If set to `true`,
the API does not return an error; the job waits in the `starting` state
until sufficient machine learning node capacity is available. This
behavior is also affected by the cluster-wide
`xpack.ml.max_lazy_ml_nodes` setting. + /// + /// Specifies whether this job can start when there is insufficient machine + /// learning node capacity for it to be immediately assigned to a node. If + /// set to false and a machine learning node with capacity to run the job + /// cannot be immediately found, the API returns an error. If set to true, + /// the API does not return an error; the job waits in the starting state + /// until sufficient machine learning node capacity is available. This + /// behavior is also affected by the cluster-wide + /// xpack.ml.max_lazy_ml_nodes setting. + /// /// public PutDataFrameAnalyticsRequestDescriptor AllowLazyStart(bool? allowLazyStart = true) { @@ -464,7 +603,11 @@ public PutDataFrameAnalyticsRequestDescriptor AllowLazyStart(bool? allowLazyStar } /// - /// The analysis configuration, which contains the information necessary to
perform one of the following types of analysis: classification, outlier
detection, or regression. + /// + /// The analysis configuration, which contains the information necessary to + /// perform one of the following types of analysis: classification, outlier + /// detection, or regression. + /// /// public PutDataFrameAnalyticsRequestDescriptor Analysis(Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalysis analysis) { @@ -491,7 +634,36 @@ public PutDataFrameAnalyticsRequestDescriptor Analysis(Action - /// Specifies `includes` and/or `excludes` patterns to select which fields
will be included in the analysis. The patterns specified in `excludes`
are applied last, therefore `excludes` takes precedence. In other words,
if the same field is specified in both `includes` and `excludes`, then
the field will not be included in the analysis. If `analyzed_fields` is
not set, only the relevant fields will be included. For example, all the
numeric fields for outlier detection.
The supported fields vary for each type of analysis. Outlier detection
requires numeric or `boolean` data to analyze. The algorithms don’t
support missing values therefore fields that have data types other than
numeric or boolean are ignored. Documents where included fields contain
missing values, null values, or an array are also ignored. Therefore the
`dest` index may contain documents that don’t have an outlier score.
Regression supports fields that are numeric, `boolean`, `text`,
`keyword`, and `ip` data types. It is also tolerant of missing values.
Fields that are supported are included in the analysis, other fields are
ignored. Documents where included fields contain an array with two or
more values are also ignored. Documents in the `dest` index that don’t
contain a results field are not included in the regression analysis.
Classification supports fields that are numeric, `boolean`, `text`,
`keyword`, and `ip` data types. It is also tolerant of missing values.
Fields that are supported are included in the analysis, other fields are
ignored. Documents where included fields contain an array with two or
more values are also ignored. Documents in the `dest` index that don’t
contain a results field are not included in the classification analysis.
Classification analysis can be improved by mapping ordinal variable
values to a single number. For example, in case of age ranges, you can
model the values as `0-14 = 0`, `15-24 = 1`, `25-34 = 2`, and so on. + /// + /// Specifies includes and/or excludes patterns to select which fields + /// will be included in the analysis. The patterns specified in excludes + /// are applied last, therefore excludes takes precedence. In other words, + /// if the same field is specified in both includes and excludes, then + /// the field will not be included in the analysis. If analyzed_fields is + /// not set, only the relevant fields will be included. For example, all the + /// numeric fields for outlier detection. + /// The supported fields vary for each type of analysis. Outlier detection + /// requires numeric or boolean data to analyze. The algorithms don’t + /// support missing values therefore fields that have data types other than + /// numeric or boolean are ignored. Documents where included fields contain + /// missing values, null values, or an array are also ignored. Therefore the + /// dest index may contain documents that don’t have an outlier score. + /// Regression supports fields that are numeric, boolean, text, + /// keyword, and ip data types. It is also tolerant of missing values. + /// Fields that are supported are included in the analysis, other fields are + /// ignored. Documents where included fields contain an array with two or + /// more values are also ignored. Documents in the dest index that don’t + /// contain a results field are not included in the regression analysis. + /// Classification supports fields that are numeric, boolean, text, + /// keyword, and ip data types. It is also tolerant of missing values. + /// Fields that are supported are included in the analysis, other fields are + /// ignored. Documents where included fields contain an array with two or + /// more values are also ignored. Documents in the dest index that don’t + /// contain a results field are not included in the classification analysis. + /// Classification analysis can be improved by mapping ordinal variable + /// values to a single number. For example, in case of age ranges, you can + /// model the values as 0-14 = 0, 15-24 = 1, 25-34 = 2, and so on. + /// /// public PutDataFrameAnalyticsRequestDescriptor AnalyzedFields(Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalysisAnalyzedFields? analyzedFields) { @@ -518,7 +690,9 @@ public PutDataFrameAnalyticsRequestDescriptor AnalyzedFields(Action - /// A description of the job. + /// + /// A description of the job. + /// /// public PutDataFrameAnalyticsRequestDescriptor Description(string? description) { @@ -527,7 +701,9 @@ public PutDataFrameAnalyticsRequestDescriptor Description(string? description) } /// - /// The destination configuration. + /// + /// The destination configuration. + /// /// public PutDataFrameAnalyticsRequestDescriptor Dest(Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalyticsDestination dest) { @@ -560,7 +736,12 @@ public PutDataFrameAnalyticsRequestDescriptor Headers(Func - /// The maximum number of threads to be used by the analysis. Using more
threads may decrease the time necessary to complete the analysis at the
cost of using more CPU. Note that the process may use additional threads
for operational functionality other than the analysis itself. + /// + /// The maximum number of threads to be used by the analysis. Using more + /// threads may decrease the time necessary to complete the analysis at the + /// cost of using more CPU. Note that the process may use additional threads + /// for operational functionality other than the analysis itself. + /// /// public PutDataFrameAnalyticsRequestDescriptor MaxNumThreads(int? maxNumThreads) { @@ -569,7 +750,13 @@ public PutDataFrameAnalyticsRequestDescriptor MaxNumThreads(int? maxNumThreads) } /// - /// The approximate maximum amount of memory resources that are permitted for
analytical processing. If your `elasticsearch.yml` file contains an
`xpack.ml.max_model_memory_limit` setting, an error occurs when you try
to create data frame analytics jobs that have `model_memory_limit` values
greater than that setting. + /// + /// The approximate maximum amount of memory resources that are permitted for + /// analytical processing. If your elasticsearch.yml file contains an + /// xpack.ml.max_model_memory_limit setting, an error occurs when you try + /// to create data frame analytics jobs that have model_memory_limit values + /// greater than that setting. + /// /// public PutDataFrameAnalyticsRequestDescriptor ModelMemoryLimit(string? modelMemoryLimit) { @@ -578,7 +765,9 @@ public PutDataFrameAnalyticsRequestDescriptor ModelMemoryLimit(string? modelMemo } /// - /// The configuration of how to source the analysis data. + /// + /// The configuration of how to source the analysis data. + /// /// public PutDataFrameAnalyticsRequestDescriptor Source(Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalyticsSource source) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutDatafeedRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutDatafeedRequest.g.cs index be5f831d7b1..a84884da085 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutDatafeedRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutDatafeedRequest.g.cs @@ -32,17 +32,25 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class PutDatafeedRequestParameters : RequestParameters { /// - /// If true, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the `_all`
string or when no indices are specified. + /// + /// If true, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the _all + /// string or when no indices are specified. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams. Supports comma-separated values. + /// + /// Type of index that wildcard patterns can match. If the request can target data streams, this argument determines + /// whether wildcard expressions match hidden data streams. Supports comma-separated values. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If true, unavailable indices (missing or closed) are ignored. + /// + /// If true, unavailable indices (missing or closed) are ignored. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } } @@ -240,7 +248,13 @@ public override void Write(Utf8JsonWriter writer, PutDatafeedRequest value, Json } /// -/// Instantiates a datafeed.
Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.
You can associate only one datafeed with each anomaly detection job.
The datafeed contains a query that runs at a defined interval (`frequency`).
If you are concerned about delayed data, you can add a delay (`query_delay') at each interval.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had
at the time of creation and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead.
You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. +/// +/// Instantiates a datafeed. +/// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. +/// You can associate only one datafeed with each anomaly detection job. +/// The datafeed contains a query that runs at a defined interval (frequency). +/// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. +/// /// [JsonConverter(typeof(PutDatafeedRequestConverter))] public sealed partial class PutDatafeedRequest : PlainRequest @@ -262,43 +276,71 @@ public PutDatafeedRequest() internal override string OperationName => "ml.put_datafeed"; /// - /// If true, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the `_all`
string or when no indices are specified. + /// + /// If true, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the _all + /// string or when no indices are specified. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams. Supports comma-separated values. + /// + /// Type of index that wildcard patterns can match. If the request can target data streams, this argument determines + /// whether wildcard expressions match hidden data streams. Supports comma-separated values. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If true, unavailable indices (missing or closed) are ignored. + /// + /// If true, unavailable indices (missing or closed) are ignored. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If set, the datafeed performs aggregation searches.
Support for aggregations is limited and should be used only with low cardinality data. + /// + /// If set, the datafeed performs aggregation searches. + /// Support for aggregations is limited and should be used only with low cardinality data. + /// /// [JsonInclude, JsonPropertyName("aggregations")] public IDictionary? Aggregations { get; set; } /// - /// Datafeeds might be required to search over long time periods, for several months or years.
This search is split into time chunks in order to ensure the load on Elasticsearch is managed.
Chunking configuration controls how the size of these time chunks are calculated;
it is an advanced configuration option. + /// + /// Datafeeds might be required to search over long time periods, for several months or years. + /// This search is split into time chunks in order to ensure the load on Elasticsearch is managed. + /// Chunking configuration controls how the size of these time chunks are calculated; + /// it is an advanced configuration option. + /// /// [JsonInclude, JsonPropertyName("chunking_config")] public Elastic.Clients.Elasticsearch.MachineLearning.ChunkingConfig? ChunkingConfig { get; set; } /// - /// Specifies whether the datafeed checks for missing data and the size of the window.
The datafeed can optionally search over indices that have already been read in an effort to determine whether
any data has subsequently been added to the index. If missing data is found, it is a good indication that the
`query_delay` is set too low and the data is being indexed after the datafeed has passed that moment in time.
This check runs only on real-time datafeeds. + /// + /// Specifies whether the datafeed checks for missing data and the size of the window. + /// The datafeed can optionally search over indices that have already been read in an effort to determine whether + /// any data has subsequently been added to the index. If missing data is found, it is a good indication that the + /// query_delay is set too low and the data is being indexed after the datafeed has passed that moment in time. + /// This check runs only on real-time datafeeds. + /// /// [JsonInclude, JsonPropertyName("delayed_data_check_config")] public Elastic.Clients.Elasticsearch.MachineLearning.DelayedDataCheckConfig? DelayedDataCheckConfig { get; set; } /// - /// The interval at which scheduled queries are made while the datafeed runs in real time.
The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible
fraction of the bucket span. When `frequency` is shorter than the bucket span, interim results for the last
(partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses
aggregations, this value must be divisible by the interval of the date histogram aggregation. + /// + /// The interval at which scheduled queries are made while the datafeed runs in real time. + /// The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible + /// fraction of the bucket span. When frequency is shorter than the bucket span, interim results for the last + /// (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses + /// aggregations, this value must be divisible by the interval of the date histogram aggregation. + /// /// [JsonInclude, JsonPropertyName("frequency")] public Elastic.Clients.Elasticsearch.Duration? Frequency { get; set; } @@ -306,62 +348,97 @@ public PutDatafeedRequest() public IDictionary>>? Headers { get; set; } /// - /// An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine
learning nodes must have the `remote_cluster_client` role. + /// + /// An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine + /// learning nodes must have the remote_cluster_client role. + /// /// [JsonInclude, JsonPropertyName("indices")] public Elastic.Clients.Elasticsearch.Indices? Indices { get; set; } /// - /// Specifies index expansion options that are used during search + /// + /// Specifies index expansion options that are used during search + /// /// [JsonInclude, JsonPropertyName("indices_options")] public Elastic.Clients.Elasticsearch.IndicesOptions? IndicesOptions { get; set; } /// - /// Identifier for the anomaly detection job. + /// + /// Identifier for the anomaly detection job. + /// /// [JsonInclude, JsonPropertyName("job_id")] public Elastic.Clients.Elasticsearch.Id? JobId { get; set; } /// - /// If a real-time datafeed has never seen any data (including during any initial training period), it automatically
stops and closes the associated job after this many real-time searches return no documents. In other words,
it stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no
end time that sees no data remains started until it is explicitly stopped. By default, it is not set. + /// + /// If a real-time datafeed has never seen any data (including during any initial training period), it automatically + /// stops and closes the associated job after this many real-time searches return no documents. In other words, + /// it stops after frequency times max_empty_searches of real-time operation. If not set, a datafeed with no + /// end time that sees no data remains started until it is explicitly stopped. By default, it is not set. + /// /// [JsonInclude, JsonPropertyName("max_empty_searches")] public int? MaxEmptySearches { get; set; } /// - /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an
Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this
object is passed verbatim to Elasticsearch. + /// + /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an + /// Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this + /// object is passed verbatim to Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Query { get; set; } /// - /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might
not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default
value is randomly selected between `60s` and `120s`. This randomness improves the query performance
when there are multiple jobs running on the same node. + /// + /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might + /// not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default + /// value is randomly selected between 60s and 120s. This randomness improves the query performance + /// when there are multiple jobs running on the same node. + /// /// [JsonInclude, JsonPropertyName("query_delay")] public Elastic.Clients.Elasticsearch.Duration? QueryDelay { get; set; } /// - /// Specifies runtime fields for the datafeed search. + /// + /// Specifies runtime fields for the datafeed search. + /// /// [JsonInclude, JsonPropertyName("runtime_mappings")] public IDictionary? RuntimeMappings { get; set; } /// - /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed.
The detector configuration objects in a job can contain functions that use these script fields. + /// + /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. + /// The detector configuration objects in a job can contain functions that use these script fields. + /// /// [JsonInclude, JsonPropertyName("script_fields")] public IDictionary? ScriptFields { get; set; } /// - /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations.
The maximum value is the value of `index.max_result_window`, which is 10,000 by default. + /// + /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. + /// The maximum value is the value of index.max_result_window, which is 10,000 by default. + /// /// [JsonInclude, JsonPropertyName("scroll_size")] public int? ScrollSize { get; set; } } /// -/// Instantiates a datafeed.
Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.
You can associate only one datafeed with each anomaly detection job.
The datafeed contains a query that runs at a defined interval (`frequency`).
If you are concerned about delayed data, you can add a delay (`query_delay') at each interval.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had
at the time of creation and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead.
You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. +/// +/// Instantiates a datafeed. +/// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. +/// You can associate only one datafeed with each anomaly detection job. +/// The datafeed contains a query that runs at a defined interval (frequency). +/// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. +/// /// public sealed partial class PutDatafeedRequestDescriptor : RequestDescriptor, PutDatafeedRequestParameters> { @@ -413,7 +490,10 @@ public PutDatafeedRequestDescriptor DatafeedId(Elastic.Clients.Elasti private int? ScrollSizeValue { get; set; } /// - /// If set, the datafeed performs aggregation searches.
Support for aggregations is limited and should be used only with low cardinality data. + /// + /// If set, the datafeed performs aggregation searches. + /// Support for aggregations is limited and should be used only with low cardinality data. + /// /// public PutDatafeedRequestDescriptor Aggregations(Func>, FluentDescriptorDictionary>> selector) { @@ -422,7 +502,12 @@ public PutDatafeedRequestDescriptor Aggregations(Func - /// Datafeeds might be required to search over long time periods, for several months or years.
This search is split into time chunks in order to ensure the load on Elasticsearch is managed.
Chunking configuration controls how the size of these time chunks are calculated;
it is an advanced configuration option. + /// + /// Datafeeds might be required to search over long time periods, for several months or years. + /// This search is split into time chunks in order to ensure the load on Elasticsearch is managed. + /// Chunking configuration controls how the size of these time chunks are calculated; + /// it is an advanced configuration option. + /// /// public PutDatafeedRequestDescriptor ChunkingConfig(Elastic.Clients.Elasticsearch.MachineLearning.ChunkingConfig? chunkingConfig) { @@ -449,7 +534,13 @@ public PutDatafeedRequestDescriptor ChunkingConfig(Action - /// Specifies whether the datafeed checks for missing data and the size of the window.
The datafeed can optionally search over indices that have already been read in an effort to determine whether
any data has subsequently been added to the index. If missing data is found, it is a good indication that the
`query_delay` is set too low and the data is being indexed after the datafeed has passed that moment in time.
This check runs only on real-time datafeeds. + /// + /// Specifies whether the datafeed checks for missing data and the size of the window. + /// The datafeed can optionally search over indices that have already been read in an effort to determine whether + /// any data has subsequently been added to the index. If missing data is found, it is a good indication that the + /// query_delay is set too low and the data is being indexed after the datafeed has passed that moment in time. + /// This check runs only on real-time datafeeds. + /// /// public PutDatafeedRequestDescriptor DelayedDataCheckConfig(Elastic.Clients.Elasticsearch.MachineLearning.DelayedDataCheckConfig? delayedDataCheckConfig) { @@ -476,7 +567,13 @@ public PutDatafeedRequestDescriptor DelayedDataCheckConfig(Action - /// The interval at which scheduled queries are made while the datafeed runs in real time.
The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible
fraction of the bucket span. When `frequency` is shorter than the bucket span, interim results for the last
(partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses
aggregations, this value must be divisible by the interval of the date histogram aggregation. + /// + /// The interval at which scheduled queries are made while the datafeed runs in real time. + /// The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible + /// fraction of the bucket span. When frequency is shorter than the bucket span, interim results for the last + /// (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses + /// aggregations, this value must be divisible by the interval of the date histogram aggregation. + /// /// public PutDatafeedRequestDescriptor Frequency(Elastic.Clients.Elasticsearch.Duration? frequency) { @@ -491,7 +588,10 @@ public PutDatafeedRequestDescriptor Headers(Func - /// An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine
learning nodes must have the `remote_cluster_client` role. + /// + /// An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine + /// learning nodes must have the remote_cluster_client role. + /// /// public PutDatafeedRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? indices) { @@ -500,7 +600,9 @@ public PutDatafeedRequestDescriptor Indices(Elastic.Clients.Elasticse } /// - /// Specifies index expansion options that are used during search + /// + /// Specifies index expansion options that are used during search + /// /// public PutDatafeedRequestDescriptor IndicesOptions(Elastic.Clients.Elasticsearch.IndicesOptions? indicesOptions) { @@ -527,7 +629,9 @@ public PutDatafeedRequestDescriptor IndicesOptions(Action - /// Identifier for the anomaly detection job. + /// + /// Identifier for the anomaly detection job. + /// /// public PutDatafeedRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Id? jobId) { @@ -536,7 +640,12 @@ public PutDatafeedRequestDescriptor JobId(Elastic.Clients.Elasticsear } /// - /// If a real-time datafeed has never seen any data (including during any initial training period), it automatically
stops and closes the associated job after this many real-time searches return no documents. In other words,
it stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no
end time that sees no data remains started until it is explicitly stopped. By default, it is not set. + /// + /// If a real-time datafeed has never seen any data (including during any initial training period), it automatically + /// stops and closes the associated job after this many real-time searches return no documents. In other words, + /// it stops after frequency times max_empty_searches of real-time operation. If not set, a datafeed with no + /// end time that sees no data remains started until it is explicitly stopped. By default, it is not set. + /// /// public PutDatafeedRequestDescriptor MaxEmptySearches(int? maxEmptySearches) { @@ -545,7 +654,11 @@ public PutDatafeedRequestDescriptor MaxEmptySearches(int? maxEmptySea } /// - /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an
Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this
object is passed verbatim to Elasticsearch. + /// + /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an + /// Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this + /// object is passed verbatim to Elasticsearch. + /// /// public PutDatafeedRequestDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -572,7 +685,12 @@ public PutDatafeedRequestDescriptor Query(Action - /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might
not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default
value is randomly selected between `60s` and `120s`. This randomness improves the query performance
when there are multiple jobs running on the same node. + /// + /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might + /// not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default + /// value is randomly selected between 60s and 120s. This randomness improves the query performance + /// when there are multiple jobs running on the same node. + /// /// public PutDatafeedRequestDescriptor QueryDelay(Elastic.Clients.Elasticsearch.Duration? queryDelay) { @@ -581,7 +699,9 @@ public PutDatafeedRequestDescriptor QueryDelay(Elastic.Clients.Elasti } /// - /// Specifies runtime fields for the datafeed search. + /// + /// Specifies runtime fields for the datafeed search. + /// /// public PutDatafeedRequestDescriptor RuntimeMappings(Func>, FluentDescriptorDictionary>> selector) { @@ -590,7 +710,10 @@ public PutDatafeedRequestDescriptor RuntimeMappings(Func - /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed.
The detector configuration objects in a job can contain functions that use these script fields. + /// + /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. + /// The detector configuration objects in a job can contain functions that use these script fields. + /// /// public PutDatafeedRequestDescriptor ScriptFields(Func, FluentDescriptorDictionary> selector) { @@ -599,7 +722,10 @@ public PutDatafeedRequestDescriptor ScriptFields(Func - /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations.
The maximum value is the value of `index.max_result_window`, which is 10,000 by default. + /// + /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. + /// The maximum value is the value of index.max_result_window, which is 10,000 by default. + /// /// public PutDatafeedRequestDescriptor ScrollSize(int? scrollSize) { @@ -739,7 +865,13 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Instantiates a datafeed.
Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.
You can associate only one datafeed with each anomaly detection job.
The datafeed contains a query that runs at a defined interval (`frequency`).
If you are concerned about delayed data, you can add a delay (`query_delay') at each interval.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had
at the time of creation and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead.
You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. +/// +/// Instantiates a datafeed. +/// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. +/// You can associate only one datafeed with each anomaly detection job. +/// The datafeed contains a query that runs at a defined interval (frequency). +/// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. +/// /// public sealed partial class PutDatafeedRequestDescriptor : RequestDescriptor { @@ -791,7 +923,10 @@ public PutDatafeedRequestDescriptor DatafeedId(Elastic.Clients.Elasticsearch.Id private int? ScrollSizeValue { get; set; } /// - /// If set, the datafeed performs aggregation searches.
Support for aggregations is limited and should be used only with low cardinality data. + /// + /// If set, the datafeed performs aggregation searches. + /// Support for aggregations is limited and should be used only with low cardinality data. + /// /// public PutDatafeedRequestDescriptor Aggregations(Func, FluentDescriptorDictionary> selector) { @@ -800,7 +935,12 @@ public PutDatafeedRequestDescriptor Aggregations(Func - /// Datafeeds might be required to search over long time periods, for several months or years.
This search is split into time chunks in order to ensure the load on Elasticsearch is managed.
Chunking configuration controls how the size of these time chunks are calculated;
it is an advanced configuration option. + /// + /// Datafeeds might be required to search over long time periods, for several months or years. + /// This search is split into time chunks in order to ensure the load on Elasticsearch is managed. + /// Chunking configuration controls how the size of these time chunks are calculated; + /// it is an advanced configuration option. + /// /// public PutDatafeedRequestDescriptor ChunkingConfig(Elastic.Clients.Elasticsearch.MachineLearning.ChunkingConfig? chunkingConfig) { @@ -827,7 +967,13 @@ public PutDatafeedRequestDescriptor ChunkingConfig(Action - /// Specifies whether the datafeed checks for missing data and the size of the window.
The datafeed can optionally search over indices that have already been read in an effort to determine whether
any data has subsequently been added to the index. If missing data is found, it is a good indication that the
`query_delay` is set too low and the data is being indexed after the datafeed has passed that moment in time.
This check runs only on real-time datafeeds. + /// + /// Specifies whether the datafeed checks for missing data and the size of the window. + /// The datafeed can optionally search over indices that have already been read in an effort to determine whether + /// any data has subsequently been added to the index. If missing data is found, it is a good indication that the + /// query_delay is set too low and the data is being indexed after the datafeed has passed that moment in time. + /// This check runs only on real-time datafeeds. + /// /// public PutDatafeedRequestDescriptor DelayedDataCheckConfig(Elastic.Clients.Elasticsearch.MachineLearning.DelayedDataCheckConfig? delayedDataCheckConfig) { @@ -854,7 +1000,13 @@ public PutDatafeedRequestDescriptor DelayedDataCheckConfig(Action - /// The interval at which scheduled queries are made while the datafeed runs in real time.
The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible
fraction of the bucket span. When `frequency` is shorter than the bucket span, interim results for the last
(partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses
aggregations, this value must be divisible by the interval of the date histogram aggregation. + /// + /// The interval at which scheduled queries are made while the datafeed runs in real time. + /// The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible + /// fraction of the bucket span. When frequency is shorter than the bucket span, interim results for the last + /// (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses + /// aggregations, this value must be divisible by the interval of the date histogram aggregation. + /// /// public PutDatafeedRequestDescriptor Frequency(Elastic.Clients.Elasticsearch.Duration? frequency) { @@ -869,7 +1021,10 @@ public PutDatafeedRequestDescriptor Headers(Func - /// An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine
learning nodes must have the `remote_cluster_client` role. + /// + /// An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine + /// learning nodes must have the remote_cluster_client role. + /// /// public PutDatafeedRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? indices) { @@ -878,7 +1033,9 @@ public PutDatafeedRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indice } /// - /// Specifies index expansion options that are used during search + /// + /// Specifies index expansion options that are used during search + /// /// public PutDatafeedRequestDescriptor IndicesOptions(Elastic.Clients.Elasticsearch.IndicesOptions? indicesOptions) { @@ -905,7 +1062,9 @@ public PutDatafeedRequestDescriptor IndicesOptions(Action - /// Identifier for the anomaly detection job. + /// + /// Identifier for the anomaly detection job. + /// /// public PutDatafeedRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Id? jobId) { @@ -914,7 +1073,12 @@ public PutDatafeedRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Id? jobI } /// - /// If a real-time datafeed has never seen any data (including during any initial training period), it automatically
stops and closes the associated job after this many real-time searches return no documents. In other words,
it stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no
end time that sees no data remains started until it is explicitly stopped. By default, it is not set. + /// + /// If a real-time datafeed has never seen any data (including during any initial training period), it automatically + /// stops and closes the associated job after this many real-time searches return no documents. In other words, + /// it stops after frequency times max_empty_searches of real-time operation. If not set, a datafeed with no + /// end time that sees no data remains started until it is explicitly stopped. By default, it is not set. + /// /// public PutDatafeedRequestDescriptor MaxEmptySearches(int? maxEmptySearches) { @@ -923,7 +1087,11 @@ public PutDatafeedRequestDescriptor MaxEmptySearches(int? maxEmptySearches) } /// - /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an
Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this
object is passed verbatim to Elasticsearch. + /// + /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an + /// Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this + /// object is passed verbatim to Elasticsearch. + /// /// public PutDatafeedRequestDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -950,7 +1118,12 @@ public PutDatafeedRequestDescriptor Query(Action - /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might
not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default
value is randomly selected between `60s` and `120s`. This randomness improves the query performance
when there are multiple jobs running on the same node. + /// + /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might + /// not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default + /// value is randomly selected between 60s and 120s. This randomness improves the query performance + /// when there are multiple jobs running on the same node. + /// /// public PutDatafeedRequestDescriptor QueryDelay(Elastic.Clients.Elasticsearch.Duration? queryDelay) { @@ -959,7 +1132,9 @@ public PutDatafeedRequestDescriptor QueryDelay(Elastic.Clients.Elasticsearch.Dur } /// - /// Specifies runtime fields for the datafeed search. + /// + /// Specifies runtime fields for the datafeed search. + /// /// public PutDatafeedRequestDescriptor RuntimeMappings(Func, FluentDescriptorDictionary> selector) { @@ -968,7 +1143,10 @@ public PutDatafeedRequestDescriptor RuntimeMappings(Func - /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed.
The detector configuration objects in a job can contain functions that use these script fields. + /// + /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. + /// The detector configuration objects in a job can contain functions that use these script fields. + /// /// public PutDatafeedRequestDescriptor ScriptFields(Func, FluentDescriptorDictionary> selector) { @@ -977,7 +1155,10 @@ public PutDatafeedRequestDescriptor ScriptFields(Func - /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations.
The maximum value is the value of `index.max_result_window`, which is 10,000 by default. + /// + /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. + /// The maximum value is the value of index.max_result_window, which is 10,000 by default. + /// /// public PutDatafeedRequestDescriptor ScrollSize(int? scrollSize) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutFilterRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutFilterRequest.g.cs index 708976653e8..93bc365a632 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutFilterRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutFilterRequest.g.cs @@ -34,7 +34,11 @@ public sealed partial class PutFilterRequestParameters : RequestParameters } /// -/// Instantiates a filter.
A filter contains a list of strings. It can be used by one or more anomaly detection jobs.
Specifically, filters are referenced in the `custom_rules` property of detector configuration objects. +/// +/// Instantiates a filter. +/// A filter contains a list of strings. It can be used by one or more anomaly detection jobs. +/// Specifically, filters are referenced in the custom_rules property of detector configuration objects. +/// /// public sealed partial class PutFilterRequest : PlainRequest { @@ -51,20 +55,29 @@ public PutFilterRequest(Elastic.Clients.Elasticsearch.Id filterId) : base(r => r internal override string OperationName => "ml.put_filter"; /// - /// A description of the filter. + /// + /// A description of the filter. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The items of the filter. A wildcard `*` can be used at the beginning or the end of an item.
Up to 10000 items are allowed in each filter. + /// + /// The items of the filter. A wildcard * can be used at the beginning or the end of an item. + /// Up to 10000 items are allowed in each filter. + /// /// [JsonInclude, JsonPropertyName("items")] public ICollection? Items { get; set; } } /// -/// Instantiates a filter.
A filter contains a list of strings. It can be used by one or more anomaly detection jobs.
Specifically, filters are referenced in the `custom_rules` property of detector configuration objects. +/// +/// Instantiates a filter. +/// A filter contains a list of strings. It can be used by one or more anomaly detection jobs. +/// Specifically, filters are referenced in the custom_rules property of detector configuration objects. +/// /// public sealed partial class PutFilterRequestDescriptor : RequestDescriptor { @@ -92,7 +105,9 @@ public PutFilterRequestDescriptor FilterId(Elastic.Clients.Elasticsearch.Id filt private ICollection? ItemsValue { get; set; } /// - /// A description of the filter. + /// + /// A description of the filter. + /// /// public PutFilterRequestDescriptor Description(string? description) { @@ -101,7 +116,10 @@ public PutFilterRequestDescriptor Description(string? description) } /// - /// The items of the filter. A wildcard `*` can be used at the beginning or the end of an item.
Up to 10000 items are allowed in each filter. + /// + /// The items of the filter. A wildcard * can be used at the beginning or the end of an item. + /// Up to 10000 items are allowed in each filter. + /// /// public PutFilterRequestDescriptor Items(ICollection? items) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutJobRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutJobRequest.g.cs index 0ad181e5ea6..b531852eac7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutJobRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutJobRequest.g.cs @@ -34,7 +34,10 @@ public sealed partial class PutJobRequestParameters : RequestParameters } /// -/// Create an anomaly detection job.
If you include a `datafeed_config`, you must have read index privileges on the source index. +/// +/// Create an anomaly detection job. +/// If you include a datafeed_config, you must have read index privileges on the source index. +/// /// public sealed partial class PutJobRequest : PlainRequest { @@ -51,98 +54,131 @@ public PutJobRequest(Elastic.Clients.Elasticsearch.Id jobId) : base(r => r.Requi internal override string OperationName => "ml.put_job"; /// - /// Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. By default, if a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this option is set to true, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available. + /// + /// Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. By default, if a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide xpack.ml.max_lazy_ml_nodes setting. If this option is set to true, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available. + /// /// [JsonInclude, JsonPropertyName("allow_lazy_open")] public bool? AllowLazyOpen { get; set; } /// - /// Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational. + /// + /// Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational. + /// /// [JsonInclude, JsonPropertyName("analysis_config")] public Elastic.Clients.Elasticsearch.MachineLearning.AnalysisConfig AnalysisConfig { get; set; } /// - /// Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes. + /// + /// Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes. + /// /// [JsonInclude, JsonPropertyName("analysis_limits")] public Elastic.Clients.Elasticsearch.MachineLearning.AnalysisLimits? AnalysisLimits { get; set; } /// - /// Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. For very large models (several GB), persistence could take 10-20 minutes, so do not set the `background_persist_interval` value too low. + /// + /// Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. For very large models (several GB), persistence could take 10-20 minutes, so do not set the background_persist_interval value too low. + /// /// [JsonInclude, JsonPropertyName("background_persist_interval")] public Elastic.Clients.Elasticsearch.Duration? BackgroundPersistInterval { get; set; } /// - /// Advanced configuration option. Contains custom meta data about the job. + /// + /// Advanced configuration option. Contains custom meta data about the job. + /// /// [JsonInclude, JsonPropertyName("custom_settings")] public object? CustomSettings { get; set; } /// - /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to `model_snapshot_retention_days`. + /// + /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to model_snapshot_retention_days. + /// /// [JsonInclude, JsonPropertyName("daily_model_snapshot_retention_after_days")] public long? DailyModelSnapshotRetentionAfterDays { get; set; } /// - /// Defines the format of the input data when you send data to the job by using the post data API. Note that when configure a datafeed, these properties are automatically set. When data is received via the post data API, it is not stored in Elasticsearch. Only the results for anomaly detection are retained. + /// + /// Defines the format of the input data when you send data to the job by using the post data API. Note that when configure a datafeed, these properties are automatically set. When data is received via the post data API, it is not stored in Elasticsearch. Only the results for anomaly detection are retained. + /// /// [JsonInclude, JsonPropertyName("data_description")] public Elastic.Clients.Elasticsearch.MachineLearning.DataDescription DataDescription { get; set; } /// - /// Defines a datafeed for the anomaly detection job. If Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. + /// + /// Defines a datafeed for the anomaly detection job. If Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. + /// /// [JsonInclude, JsonPropertyName("datafeed_config")] public Elastic.Clients.Elasticsearch.MachineLearning.DatafeedConfig? DatafeedConfig { get; set; } /// - /// A description of the job. + /// + /// A description of the job. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// A list of job groups. A job can belong to no groups or many. + /// + /// A list of job groups. A job can belong to no groups or many. + /// /// [JsonInclude, JsonPropertyName("groups")] public ICollection? Groups { get; set; } /// - /// This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced. + /// + /// This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced. + /// /// [JsonInclude, JsonPropertyName("model_plot_config")] public Elastic.Clients.Elasticsearch.MachineLearning.ModelPlotConfig? ModelPlotConfig { get; set; } /// - /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. By default, snapshots ten days older than the newest snapshot are deleted. + /// + /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. By default, snapshots ten days older than the newest snapshot are deleted. + /// /// [JsonInclude, JsonPropertyName("model_snapshot_retention_days")] public long? ModelSnapshotRetentionDays { get; set; } /// - /// Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. The default value is the longer of 30 days or 100 bucket spans. + /// + /// Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. The default value is the longer of 30 days or 100 bucket spans. + /// /// [JsonInclude, JsonPropertyName("renormalization_window_days")] public long? RenormalizationWindowDays { get; set; } /// - /// A text string that affects the name of the machine learning results index. By default, the job generates an index named `.ml-anomalies-shared`. + /// + /// A text string that affects the name of the machine learning results index. By default, the job generates an index named .ml-anomalies-shared. + /// /// [JsonInclude, JsonPropertyName("results_index_name")] public Elastic.Clients.Elasticsearch.IndexName? ResultsIndexName { get; set; } /// - /// Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained. Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. Annotations added by users are retained forever. + /// + /// Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained. Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. Annotations added by users are retained forever. + /// /// [JsonInclude, JsonPropertyName("results_retention_days")] public long? ResultsRetentionDays { get; set; } } /// -/// Create an anomaly detection job.
If you include a `datafeed_config`, you must have read index privileges on the source index. +/// +/// Create an anomaly detection job. +/// If you include a datafeed_config, you must have read index privileges on the source index. +/// /// public sealed partial class PutJobRequestDescriptor : RequestDescriptor, PutJobRequestParameters> { @@ -193,7 +229,9 @@ public PutJobRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Id private long? ResultsRetentionDaysValue { get; set; } /// - /// Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. By default, if a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this option is set to true, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available. + /// + /// Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. By default, if a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide xpack.ml.max_lazy_ml_nodes setting. If this option is set to true, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available. + /// /// public PutJobRequestDescriptor AllowLazyOpen(bool? allowLazyOpen = true) { @@ -202,7 +240,9 @@ public PutJobRequestDescriptor AllowLazyOpen(bool? allowLazyOpen = tr } /// - /// Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational. + /// + /// Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational. + /// /// public PutJobRequestDescriptor AnalysisConfig(Elastic.Clients.Elasticsearch.MachineLearning.AnalysisConfig analysisConfig) { @@ -229,7 +269,9 @@ public PutJobRequestDescriptor AnalysisConfig(Action - /// Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes. + /// + /// Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes. + /// /// public PutJobRequestDescriptor AnalysisLimits(Elastic.Clients.Elasticsearch.MachineLearning.AnalysisLimits? analysisLimits) { @@ -256,7 +298,9 @@ public PutJobRequestDescriptor AnalysisLimits(Action - /// Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. For very large models (several GB), persistence could take 10-20 minutes, so do not set the `background_persist_interval` value too low. + /// + /// Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. For very large models (several GB), persistence could take 10-20 minutes, so do not set the background_persist_interval value too low. + /// /// public PutJobRequestDescriptor BackgroundPersistInterval(Elastic.Clients.Elasticsearch.Duration? backgroundPersistInterval) { @@ -265,7 +309,9 @@ public PutJobRequestDescriptor BackgroundPersistInterval(Elastic.Clie } /// - /// Advanced configuration option. Contains custom meta data about the job. + /// + /// Advanced configuration option. Contains custom meta data about the job. + /// /// public PutJobRequestDescriptor CustomSettings(object? customSettings) { @@ -274,7 +320,9 @@ public PutJobRequestDescriptor CustomSettings(object? customSettings) } /// - /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to `model_snapshot_retention_days`. + /// + /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to model_snapshot_retention_days. + /// /// public PutJobRequestDescriptor DailyModelSnapshotRetentionAfterDays(long? dailyModelSnapshotRetentionAfterDays) { @@ -283,7 +331,9 @@ public PutJobRequestDescriptor DailyModelSnapshotRetentionAfterDays(l } /// - /// Defines the format of the input data when you send data to the job by using the post data API. Note that when configure a datafeed, these properties are automatically set. When data is received via the post data API, it is not stored in Elasticsearch. Only the results for anomaly detection are retained. + /// + /// Defines the format of the input data when you send data to the job by using the post data API. Note that when configure a datafeed, these properties are automatically set. When data is received via the post data API, it is not stored in Elasticsearch. Only the results for anomaly detection are retained. + /// /// public PutJobRequestDescriptor DataDescription(Elastic.Clients.Elasticsearch.MachineLearning.DataDescription dataDescription) { @@ -310,7 +360,9 @@ public PutJobRequestDescriptor DataDescription(Action - /// Defines a datafeed for the anomaly detection job. If Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. + /// + /// Defines a datafeed for the anomaly detection job. If Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. + /// /// public PutJobRequestDescriptor DatafeedConfig(Elastic.Clients.Elasticsearch.MachineLearning.DatafeedConfig? datafeedConfig) { @@ -337,7 +389,9 @@ public PutJobRequestDescriptor DatafeedConfig(Action - /// A description of the job. + /// + /// A description of the job. + /// /// public PutJobRequestDescriptor Description(string? description) { @@ -346,7 +400,9 @@ public PutJobRequestDescriptor Description(string? description) } /// - /// A list of job groups. A job can belong to no groups or many. + /// + /// A list of job groups. A job can belong to no groups or many. + /// /// public PutJobRequestDescriptor Groups(ICollection? groups) { @@ -355,7 +411,9 @@ public PutJobRequestDescriptor Groups(ICollection? groups) } /// - /// This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced. + /// + /// This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced. + /// /// public PutJobRequestDescriptor ModelPlotConfig(Elastic.Clients.Elasticsearch.MachineLearning.ModelPlotConfig? modelPlotConfig) { @@ -382,7 +440,9 @@ public PutJobRequestDescriptor ModelPlotConfig(Action - /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. By default, snapshots ten days older than the newest snapshot are deleted. + /// + /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. By default, snapshots ten days older than the newest snapshot are deleted. + /// /// public PutJobRequestDescriptor ModelSnapshotRetentionDays(long? modelSnapshotRetentionDays) { @@ -391,7 +451,9 @@ public PutJobRequestDescriptor ModelSnapshotRetentionDays(long? model } /// - /// Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. The default value is the longer of 30 days or 100 bucket spans. + /// + /// Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. The default value is the longer of 30 days or 100 bucket spans. + /// /// public PutJobRequestDescriptor RenormalizationWindowDays(long? renormalizationWindowDays) { @@ -400,7 +462,9 @@ public PutJobRequestDescriptor RenormalizationWindowDays(long? renorm } /// - /// A text string that affects the name of the machine learning results index. By default, the job generates an index named `.ml-anomalies-shared`. + /// + /// A text string that affects the name of the machine learning results index. By default, the job generates an index named .ml-anomalies-shared. + /// /// public PutJobRequestDescriptor ResultsIndexName(Elastic.Clients.Elasticsearch.IndexName? resultsIndexName) { @@ -409,7 +473,9 @@ public PutJobRequestDescriptor ResultsIndexName(Elastic.Clients.Elast } /// - /// Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained. Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. Annotations added by users are retained forever. + /// + /// Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained. Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. Annotations added by users are retained forever. + /// /// public PutJobRequestDescriptor ResultsRetentionDays(long? resultsRetentionDays) { @@ -565,7 +631,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Create an anomaly detection job.
If you include a `datafeed_config`, you must have read index privileges on the source index. +/// +/// Create an anomaly detection job. +/// If you include a datafeed_config, you must have read index privileges on the source index. +/// /// public sealed partial class PutJobRequestDescriptor : RequestDescriptor { @@ -616,7 +685,9 @@ public PutJobRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Id jobId) private long? ResultsRetentionDaysValue { get; set; } /// - /// Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. By default, if a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this option is set to true, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available. + /// + /// Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. By default, if a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide xpack.ml.max_lazy_ml_nodes setting. If this option is set to true, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available. + /// /// public PutJobRequestDescriptor AllowLazyOpen(bool? allowLazyOpen = true) { @@ -625,7 +696,9 @@ public PutJobRequestDescriptor AllowLazyOpen(bool? allowLazyOpen = true) } /// - /// Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational. + /// + /// Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational. + /// /// public PutJobRequestDescriptor AnalysisConfig(Elastic.Clients.Elasticsearch.MachineLearning.AnalysisConfig analysisConfig) { @@ -652,7 +725,9 @@ public PutJobRequestDescriptor AnalysisConfig(Action - /// Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes. + /// + /// Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes. + /// /// public PutJobRequestDescriptor AnalysisLimits(Elastic.Clients.Elasticsearch.MachineLearning.AnalysisLimits? analysisLimits) { @@ -679,7 +754,9 @@ public PutJobRequestDescriptor AnalysisLimits(Action - /// Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. For very large models (several GB), persistence could take 10-20 minutes, so do not set the `background_persist_interval` value too low. + /// + /// Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. For very large models (several GB), persistence could take 10-20 minutes, so do not set the background_persist_interval value too low. + /// /// public PutJobRequestDescriptor BackgroundPersistInterval(Elastic.Clients.Elasticsearch.Duration? backgroundPersistInterval) { @@ -688,7 +765,9 @@ public PutJobRequestDescriptor BackgroundPersistInterval(Elastic.Clients.Elastic } /// - /// Advanced configuration option. Contains custom meta data about the job. + /// + /// Advanced configuration option. Contains custom meta data about the job. + /// /// public PutJobRequestDescriptor CustomSettings(object? customSettings) { @@ -697,7 +776,9 @@ public PutJobRequestDescriptor CustomSettings(object? customSettings) } /// - /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to `model_snapshot_retention_days`. + /// + /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to model_snapshot_retention_days. + /// /// public PutJobRequestDescriptor DailyModelSnapshotRetentionAfterDays(long? dailyModelSnapshotRetentionAfterDays) { @@ -706,7 +787,9 @@ public PutJobRequestDescriptor DailyModelSnapshotRetentionAfterDays(long? dailyM } /// - /// Defines the format of the input data when you send data to the job by using the post data API. Note that when configure a datafeed, these properties are automatically set. When data is received via the post data API, it is not stored in Elasticsearch. Only the results for anomaly detection are retained. + /// + /// Defines the format of the input data when you send data to the job by using the post data API. Note that when configure a datafeed, these properties are automatically set. When data is received via the post data API, it is not stored in Elasticsearch. Only the results for anomaly detection are retained. + /// /// public PutJobRequestDescriptor DataDescription(Elastic.Clients.Elasticsearch.MachineLearning.DataDescription dataDescription) { @@ -733,7 +816,9 @@ public PutJobRequestDescriptor DataDescription(Action - /// Defines a datafeed for the anomaly detection job. If Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. + /// + /// Defines a datafeed for the anomaly detection job. If Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. + /// /// public PutJobRequestDescriptor DatafeedConfig(Elastic.Clients.Elasticsearch.MachineLearning.DatafeedConfig? datafeedConfig) { @@ -760,7 +845,9 @@ public PutJobRequestDescriptor DatafeedConfig(Action - /// A description of the job. + /// + /// A description of the job. + /// /// public PutJobRequestDescriptor Description(string? description) { @@ -769,7 +856,9 @@ public PutJobRequestDescriptor Description(string? description) } /// - /// A list of job groups. A job can belong to no groups or many. + /// + /// A list of job groups. A job can belong to no groups or many. + /// /// public PutJobRequestDescriptor Groups(ICollection? groups) { @@ -778,7 +867,9 @@ public PutJobRequestDescriptor Groups(ICollection? groups) } /// - /// This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced. + /// + /// This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced. + /// /// public PutJobRequestDescriptor ModelPlotConfig(Elastic.Clients.Elasticsearch.MachineLearning.ModelPlotConfig? modelPlotConfig) { @@ -805,7 +896,9 @@ public PutJobRequestDescriptor ModelPlotConfig(Action - /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. By default, snapshots ten days older than the newest snapshot are deleted. + /// + /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. By default, snapshots ten days older than the newest snapshot are deleted. + /// /// public PutJobRequestDescriptor ModelSnapshotRetentionDays(long? modelSnapshotRetentionDays) { @@ -814,7 +907,9 @@ public PutJobRequestDescriptor ModelSnapshotRetentionDays(long? modelSnapshotRet } /// - /// Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. The default value is the longer of 30 days or 100 bucket spans. + /// + /// Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. The default value is the longer of 30 days or 100 bucket spans. + /// /// public PutJobRequestDescriptor RenormalizationWindowDays(long? renormalizationWindowDays) { @@ -823,7 +918,9 @@ public PutJobRequestDescriptor RenormalizationWindowDays(long? renormalizationWi } /// - /// A text string that affects the name of the machine learning results index. By default, the job generates an index named `.ml-anomalies-shared`. + /// + /// A text string that affects the name of the machine learning results index. By default, the job generates an index named .ml-anomalies-shared. + /// /// public PutJobRequestDescriptor ResultsIndexName(Elastic.Clients.Elasticsearch.IndexName? resultsIndexName) { @@ -832,7 +929,9 @@ public PutJobRequestDescriptor ResultsIndexName(Elastic.Clients.Elasticsearch.In } /// - /// Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained. Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. Annotations added by users are retained forever. + /// + /// Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained. Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. Annotations added by users are retained forever. + /// /// public PutJobRequestDescriptor ResultsRetentionDays(long? resultsRetentionDays) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelAliasRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelAliasRequest.g.cs index 89893da547e..24f8ddf24cd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelAliasRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelAliasRequest.g.cs @@ -32,13 +32,34 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class PutTrainedModelAliasRequestParameters : RequestParameters { /// - /// Specifies whether the alias gets reassigned to the specified trained
model if it is already assigned to a different model. If the alias is
already assigned and this parameter is false, the API returns an error. + /// + /// Specifies whether the alias gets reassigned to the specified trained + /// model if it is already assigned to a different model. If the alias is + /// already assigned and this parameter is false, the API returns an error. + /// /// public bool? Reassign { get => Q("reassign"); set => Q("reassign", value); } } /// -/// Creates or updates a trained model alias. A trained model alias is a logical
name used to reference a single trained model.
You can use aliases instead of trained model identifiers to make it easier to
reference your models. For example, you can use aliases in inference
aggregations and processors.
An alias must be unique and refer to only a single trained model. However,
you can have multiple aliases for each trained model.
If you use this API to update an alias such that it references a different
trained model ID and the model uses a different type of data frame analytics,
an error occurs. For example, this situation occurs if you have a trained
model for regression analysis and a trained model for classification
analysis; you cannot reassign an alias from one type of trained model to
another.
If you use this API to update an alias and there are very few input fields in
common between the old and new trained models for the model alias, the API
returns a warning. +/// +/// Creates or updates a trained model alias. A trained model alias is a logical +/// name used to reference a single trained model. +/// You can use aliases instead of trained model identifiers to make it easier to +/// reference your models. For example, you can use aliases in inference +/// aggregations and processors. +/// An alias must be unique and refer to only a single trained model. However, +/// you can have multiple aliases for each trained model. +/// If you use this API to update an alias such that it references a different +/// trained model ID and the model uses a different type of data frame analytics, +/// an error occurs. For example, this situation occurs if you have a trained +/// model for regression analysis and a trained model for classification +/// analysis; you cannot reassign an alias from one type of trained model to +/// another. +/// If you use this API to update an alias and there are very few input fields in +/// common between the old and new trained models for the model alias, the API +/// returns a warning. +/// /// public sealed partial class PutTrainedModelAliasRequest : PlainRequest { @@ -55,14 +76,35 @@ public PutTrainedModelAliasRequest(Elastic.Clients.Elasticsearch.Id modelId, Ela internal override string OperationName => "ml.put_trained_model_alias"; /// - /// Specifies whether the alias gets reassigned to the specified trained
model if it is already assigned to a different model. If the alias is
already assigned and this parameter is false, the API returns an error. + /// + /// Specifies whether the alias gets reassigned to the specified trained + /// model if it is already assigned to a different model. If the alias is + /// already assigned and this parameter is false, the API returns an error. + /// /// [JsonIgnore] public bool? Reassign { get => Q("reassign"); set => Q("reassign", value); } } /// -/// Creates or updates a trained model alias. A trained model alias is a logical
name used to reference a single trained model.
You can use aliases instead of trained model identifiers to make it easier to
reference your models. For example, you can use aliases in inference
aggregations and processors.
An alias must be unique and refer to only a single trained model. However,
you can have multiple aliases for each trained model.
If you use this API to update an alias such that it references a different
trained model ID and the model uses a different type of data frame analytics,
an error occurs. For example, this situation occurs if you have a trained
model for regression analysis and a trained model for classification
analysis; you cannot reassign an alias from one type of trained model to
another.
If you use this API to update an alias and there are very few input fields in
common between the old and new trained models for the model alias, the API
returns a warning. +/// +/// Creates or updates a trained model alias. A trained model alias is a logical +/// name used to reference a single trained model. +/// You can use aliases instead of trained model identifiers to make it easier to +/// reference your models. For example, you can use aliases in inference +/// aggregations and processors. +/// An alias must be unique and refer to only a single trained model. However, +/// you can have multiple aliases for each trained model. +/// If you use this API to update an alias such that it references a different +/// trained model ID and the model uses a different type of data frame analytics, +/// an error occurs. For example, this situation occurs if you have a trained +/// model for regression analysis and a trained model for classification +/// analysis; you cannot reassign an alias from one type of trained model to +/// another. +/// If you use this API to update an alias and there are very few input fields in +/// common between the old and new trained models for the model alias, the API +/// returns a warning. +/// /// public sealed partial class PutTrainedModelAliasRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelAliasResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelAliasResponse.g.cs index ad0fe90c7d1..0e3e893281e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelAliasResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelAliasResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class PutTrainedModelAliasResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelDefinitionPartRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelDefinitionPartRequest.g.cs index 8a9308866b5..f847e437b78 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelDefinitionPartRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelDefinitionPartRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class PutTrainedModelDefinitionPartRequestParameters : Req } /// -/// Creates part of a trained model definition. +/// +/// Creates part of a trained model definition. +/// /// public sealed partial class PutTrainedModelDefinitionPartRequest : PlainRequest { @@ -51,26 +53,34 @@ public PutTrainedModelDefinitionPartRequest(Elastic.Clients.Elasticsearch.Id mod internal override string OperationName => "ml.put_trained_model_definition_part"; /// - /// The definition part for the model. Must be a base64 encoded string. + /// + /// The definition part for the model. Must be a base64 encoded string. + /// /// [JsonInclude, JsonPropertyName("definition")] public string Definition { get; set; } /// - /// The total uncompressed definition length in bytes. Not base64 encoded. + /// + /// The total uncompressed definition length in bytes. Not base64 encoded. + /// /// [JsonInclude, JsonPropertyName("total_definition_length")] public long TotalDefinitionLength { get; set; } /// - /// The total number of parts that will be uploaded. Must be greater than 0. + /// + /// The total number of parts that will be uploaded. Must be greater than 0. + /// /// [JsonInclude, JsonPropertyName("total_parts")] public int TotalParts { get; set; } } /// -/// Creates part of a trained model definition. +/// +/// Creates part of a trained model definition. +/// /// public sealed partial class PutTrainedModelDefinitionPartRequestDescriptor : RequestDescriptor { @@ -105,7 +115,9 @@ public PutTrainedModelDefinitionPartRequestDescriptor Part(int part) private int TotalPartsValue { get; set; } /// - /// The definition part for the model. Must be a base64 encoded string. + /// + /// The definition part for the model. Must be a base64 encoded string. + /// /// public PutTrainedModelDefinitionPartRequestDescriptor Definition(string definition) { @@ -114,7 +126,9 @@ public PutTrainedModelDefinitionPartRequestDescriptor Definition(string definiti } /// - /// The total uncompressed definition length in bytes. Not base64 encoded. + /// + /// The total uncompressed definition length in bytes. Not base64 encoded. + /// /// public PutTrainedModelDefinitionPartRequestDescriptor TotalDefinitionLength(long totalDefinitionLength) { @@ -123,7 +137,9 @@ public PutTrainedModelDefinitionPartRequestDescriptor TotalDefinitionLength(long } /// - /// The total number of parts that will be uploaded. Must be greater than 0. + /// + /// The total number of parts that will be uploaded. Must be greater than 0. + /// /// public PutTrainedModelDefinitionPartRequestDescriptor TotalParts(int totalParts) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelDefinitionPartResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelDefinitionPartResponse.g.cs index 2d95bb16a12..683d8780c23 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelDefinitionPartResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelDefinitionPartResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class PutTrainedModelDefinitionPartResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelRequest.g.cs index db3cb27c163..79cdd044b65 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelRequest.g.cs @@ -32,18 +32,27 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class PutTrainedModelRequestParameters : RequestParameters { /// - /// If set to `true` and a `compressed_definition` is provided,
the request defers definition decompression and skips relevant
validations. + /// + /// If set to true and a compressed_definition is provided, + /// the request defers definition decompression and skips relevant + /// validations. + /// /// public bool? DeferDefinitionDecompression { get => Q("defer_definition_decompression"); set => Q("defer_definition_decompression", value); } /// - /// Whether to wait for all child operations (e.g. model download)
to complete. + /// + /// Whether to wait for all child operations (e.g. model download) + /// to complete. + /// /// public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Enables you to supply a trained model that is not created by data frame analytics. +/// +/// Enables you to supply a trained model that is not created by data frame analytics. +/// /// public sealed partial class PutTrainedModelRequest : PlainRequest { @@ -60,86 +69,131 @@ public PutTrainedModelRequest(Elastic.Clients.Elasticsearch.Id modelId) : base(r internal override string OperationName => "ml.put_trained_model"; /// - /// If set to `true` and a `compressed_definition` is provided,
the request defers definition decompression and skips relevant
validations. + /// + /// If set to true and a compressed_definition is provided, + /// the request defers definition decompression and skips relevant + /// validations. + /// /// [JsonIgnore] public bool? DeferDefinitionDecompression { get => Q("defer_definition_decompression"); set => Q("defer_definition_decompression", value); } /// - /// Whether to wait for all child operations (e.g. model download)
to complete. + /// + /// Whether to wait for all child operations (e.g. model download) + /// to complete. + /// /// [JsonIgnore] public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } /// - /// The compressed (GZipped and Base64 encoded) inference definition of the
model. If compressed_definition is specified, then definition cannot be
specified. + /// + /// The compressed (GZipped and Base64 encoded) inference definition of the + /// model. If compressed_definition is specified, then definition cannot be + /// specified. + /// /// [JsonInclude, JsonPropertyName("compressed_definition")] public string? CompressedDefinition { get; set; } /// - /// The inference definition for the model. If definition is specified, then
compressed_definition cannot be specified. + /// + /// The inference definition for the model. If definition is specified, then + /// compressed_definition cannot be specified. + /// /// [JsonInclude, JsonPropertyName("definition")] public Elastic.Clients.Elasticsearch.MachineLearning.Definition? Definition { get; set; } /// - /// A human-readable description of the inference trained model. + /// + /// A human-readable description of the inference trained model. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The default configuration for inference. This can be either a regression
or classification configuration. It must match the underlying
definition.trained_model's target_type. For pre-packaged models such as
ELSER the config is not required. + /// + /// The default configuration for inference. This can be either a regression + /// or classification configuration. It must match the underlying + /// definition.trained_model's target_type. For pre-packaged models such as + /// ELSER the config is not required. + /// /// [JsonInclude, JsonPropertyName("inference_config")] public Elastic.Clients.Elasticsearch.MachineLearning.InferenceConfigCreate? InferenceConfig { get; set; } /// - /// The input field names for the model definition. + /// + /// The input field names for the model definition. + /// /// [JsonInclude, JsonPropertyName("input")] public Elastic.Clients.Elasticsearch.MachineLearning.Input? Input { get; set; } /// - /// An object map that contains metadata about the model. + /// + /// An object map that contains metadata about the model. + /// /// [JsonInclude, JsonPropertyName("metadata")] public object? Metadata { get; set; } /// - /// The estimated memory usage in bytes to keep the trained model in memory.
This property is supported only if defer_definition_decompression is true
or the model definition is not supplied. + /// + /// The estimated memory usage in bytes to keep the trained model in memory. + /// This property is supported only if defer_definition_decompression is true + /// or the model definition is not supplied. + /// /// [JsonInclude, JsonPropertyName("model_size_bytes")] public long? ModelSizeBytes { get; set; } /// - /// The model type. + /// + /// The model type. + /// /// [JsonInclude, JsonPropertyName("model_type")] public Elastic.Clients.Elasticsearch.MachineLearning.TrainedModelType? ModelType { get; set; } /// - /// The platform architecture (if applicable) of the trained mode. If the model
only works on one platform, because it is heavily optimized for a particular
processor architecture and OS combination, then this field specifies which.
The format of the string must match the platform identifiers used by Elasticsearch,
so one of, `linux-x86_64`, `linux-aarch64`, `darwin-x86_64`, `darwin-aarch64`,
or `windows-x86_64`. For portable models (those that work independent of processor
architecture or OS features), leave this field unset. + /// + /// The platform architecture (if applicable) of the trained mode. If the model + /// only works on one platform, because it is heavily optimized for a particular + /// processor architecture and OS combination, then this field specifies which. + /// The format of the string must match the platform identifiers used by Elasticsearch, + /// so one of, linux-x86_64, linux-aarch64, darwin-x86_64, darwin-aarch64, + /// or windows-x86_64. For portable models (those that work independent of processor + /// architecture or OS features), leave this field unset. + /// /// [JsonInclude, JsonPropertyName("platform_architecture")] public string? PlatformArchitecture { get; set; } /// - /// Optional prefix strings applied at inference + /// + /// Optional prefix strings applied at inference + /// /// [JsonInclude, JsonPropertyName("prefix_strings")] public Elastic.Clients.Elasticsearch.MachineLearning.TrainedModelPrefixStrings? PrefixStrings { get; set; } /// - /// An array of tags to organize the model. + /// + /// An array of tags to organize the model. + /// /// [JsonInclude, JsonPropertyName("tags")] public ICollection? Tags { get; set; } } /// -/// Enables you to supply a trained model that is not created by data frame analytics. +/// +/// Enables you to supply a trained model that is not created by data frame analytics. +/// /// public sealed partial class PutTrainedModelRequestDescriptor : RequestDescriptor, PutTrainedModelRequestParameters> { @@ -187,7 +241,11 @@ public PutTrainedModelRequestDescriptor ModelId(Elastic.Clients.Elast private ICollection? TagsValue { get; set; } /// - /// The compressed (GZipped and Base64 encoded) inference definition of the
model. If compressed_definition is specified, then definition cannot be
specified. + /// + /// The compressed (GZipped and Base64 encoded) inference definition of the + /// model. If compressed_definition is specified, then definition cannot be + /// specified. + /// /// public PutTrainedModelRequestDescriptor CompressedDefinition(string? compressedDefinition) { @@ -196,7 +254,10 @@ public PutTrainedModelRequestDescriptor CompressedDefinition(string? } /// - /// The inference definition for the model. If definition is specified, then
compressed_definition cannot be specified. + /// + /// The inference definition for the model. If definition is specified, then + /// compressed_definition cannot be specified. + /// /// public PutTrainedModelRequestDescriptor Definition(Elastic.Clients.Elasticsearch.MachineLearning.Definition? definition) { @@ -223,7 +284,9 @@ public PutTrainedModelRequestDescriptor Definition(Action - /// A human-readable description of the inference trained model. + /// + /// A human-readable description of the inference trained model. + /// /// public PutTrainedModelRequestDescriptor Description(string? description) { @@ -232,7 +295,12 @@ public PutTrainedModelRequestDescriptor Description(string? descripti } /// - /// The default configuration for inference. This can be either a regression
or classification configuration. It must match the underlying
definition.trained_model's target_type. For pre-packaged models such as
ELSER the config is not required. + /// + /// The default configuration for inference. This can be either a regression + /// or classification configuration. It must match the underlying + /// definition.trained_model's target_type. For pre-packaged models such as + /// ELSER the config is not required. + /// /// public PutTrainedModelRequestDescriptor InferenceConfig(Elastic.Clients.Elasticsearch.MachineLearning.InferenceConfigCreate? inferenceConfig) { @@ -259,7 +327,9 @@ public PutTrainedModelRequestDescriptor InferenceConfig(Action - /// The input field names for the model definition. + /// + /// The input field names for the model definition. + /// /// public PutTrainedModelRequestDescriptor Input(Elastic.Clients.Elasticsearch.MachineLearning.Input? input) { @@ -286,7 +356,9 @@ public PutTrainedModelRequestDescriptor Input(Action - /// An object map that contains metadata about the model. + /// + /// An object map that contains metadata about the model. + /// /// public PutTrainedModelRequestDescriptor Metadata(object? metadata) { @@ -295,7 +367,11 @@ public PutTrainedModelRequestDescriptor Metadata(object? metadata) } /// - /// The estimated memory usage in bytes to keep the trained model in memory.
This property is supported only if defer_definition_decompression is true
or the model definition is not supplied. + /// + /// The estimated memory usage in bytes to keep the trained model in memory. + /// This property is supported only if defer_definition_decompression is true + /// or the model definition is not supplied. + /// /// public PutTrainedModelRequestDescriptor ModelSizeBytes(long? modelSizeBytes) { @@ -304,7 +380,9 @@ public PutTrainedModelRequestDescriptor ModelSizeBytes(long? modelSiz } /// - /// The model type. + /// + /// The model type. + /// /// public PutTrainedModelRequestDescriptor ModelType(Elastic.Clients.Elasticsearch.MachineLearning.TrainedModelType? modelType) { @@ -313,7 +391,15 @@ public PutTrainedModelRequestDescriptor ModelType(Elastic.Clients.Ela } /// - /// The platform architecture (if applicable) of the trained mode. If the model
only works on one platform, because it is heavily optimized for a particular
processor architecture and OS combination, then this field specifies which.
The format of the string must match the platform identifiers used by Elasticsearch,
so one of, `linux-x86_64`, `linux-aarch64`, `darwin-x86_64`, `darwin-aarch64`,
or `windows-x86_64`. For portable models (those that work independent of processor
architecture or OS features), leave this field unset. + /// + /// The platform architecture (if applicable) of the trained mode. If the model + /// only works on one platform, because it is heavily optimized for a particular + /// processor architecture and OS combination, then this field specifies which. + /// The format of the string must match the platform identifiers used by Elasticsearch, + /// so one of, linux-x86_64, linux-aarch64, darwin-x86_64, darwin-aarch64, + /// or windows-x86_64. For portable models (those that work independent of processor + /// architecture or OS features), leave this field unset. + /// /// public PutTrainedModelRequestDescriptor PlatformArchitecture(string? platformArchitecture) { @@ -322,7 +408,9 @@ public PutTrainedModelRequestDescriptor PlatformArchitecture(string? } /// - /// Optional prefix strings applied at inference + /// + /// Optional prefix strings applied at inference + /// /// public PutTrainedModelRequestDescriptor PrefixStrings(Elastic.Clients.Elasticsearch.MachineLearning.TrainedModelPrefixStrings? prefixStrings) { @@ -349,7 +437,9 @@ public PutTrainedModelRequestDescriptor PrefixStrings(Action - /// An array of tags to organize the model. + /// + /// An array of tags to organize the model. + /// /// public PutTrainedModelRequestDescriptor Tags(ICollection? tags) { @@ -471,7 +561,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Enables you to supply a trained model that is not created by data frame analytics. +/// +/// Enables you to supply a trained model that is not created by data frame analytics. +/// /// public sealed partial class PutTrainedModelRequestDescriptor : RequestDescriptor { @@ -519,7 +611,11 @@ public PutTrainedModelRequestDescriptor ModelId(Elastic.Clients.Elasticsearch.Id private ICollection? TagsValue { get; set; } /// - /// The compressed (GZipped and Base64 encoded) inference definition of the
model. If compressed_definition is specified, then definition cannot be
specified. + /// + /// The compressed (GZipped and Base64 encoded) inference definition of the + /// model. If compressed_definition is specified, then definition cannot be + /// specified. + /// /// public PutTrainedModelRequestDescriptor CompressedDefinition(string? compressedDefinition) { @@ -528,7 +624,10 @@ public PutTrainedModelRequestDescriptor CompressedDefinition(string? compressedD } /// - /// The inference definition for the model. If definition is specified, then
compressed_definition cannot be specified. + /// + /// The inference definition for the model. If definition is specified, then + /// compressed_definition cannot be specified. + /// /// public PutTrainedModelRequestDescriptor Definition(Elastic.Clients.Elasticsearch.MachineLearning.Definition? definition) { @@ -555,7 +654,9 @@ public PutTrainedModelRequestDescriptor Definition(Action - /// A human-readable description of the inference trained model. + /// + /// A human-readable description of the inference trained model. + /// /// public PutTrainedModelRequestDescriptor Description(string? description) { @@ -564,7 +665,12 @@ public PutTrainedModelRequestDescriptor Description(string? description) } /// - /// The default configuration for inference. This can be either a regression
or classification configuration. It must match the underlying
definition.trained_model's target_type. For pre-packaged models such as
ELSER the config is not required. + /// + /// The default configuration for inference. This can be either a regression + /// or classification configuration. It must match the underlying + /// definition.trained_model's target_type. For pre-packaged models such as + /// ELSER the config is not required. + /// /// public PutTrainedModelRequestDescriptor InferenceConfig(Elastic.Clients.Elasticsearch.MachineLearning.InferenceConfigCreate? inferenceConfig) { @@ -591,7 +697,9 @@ public PutTrainedModelRequestDescriptor InferenceConfig(Action - /// The input field names for the model definition. + /// + /// The input field names for the model definition. + /// /// public PutTrainedModelRequestDescriptor Input(Elastic.Clients.Elasticsearch.MachineLearning.Input? input) { @@ -618,7 +726,9 @@ public PutTrainedModelRequestDescriptor Input(Action - /// An object map that contains metadata about the model. + /// + /// An object map that contains metadata about the model. + /// /// public PutTrainedModelRequestDescriptor Metadata(object? metadata) { @@ -627,7 +737,11 @@ public PutTrainedModelRequestDescriptor Metadata(object? metadata) } /// - /// The estimated memory usage in bytes to keep the trained model in memory.
This property is supported only if defer_definition_decompression is true
or the model definition is not supplied. + /// + /// The estimated memory usage in bytes to keep the trained model in memory. + /// This property is supported only if defer_definition_decompression is true + /// or the model definition is not supplied. + /// /// public PutTrainedModelRequestDescriptor ModelSizeBytes(long? modelSizeBytes) { @@ -636,7 +750,9 @@ public PutTrainedModelRequestDescriptor ModelSizeBytes(long? modelSizeBytes) } /// - /// The model type. + /// + /// The model type. + /// /// public PutTrainedModelRequestDescriptor ModelType(Elastic.Clients.Elasticsearch.MachineLearning.TrainedModelType? modelType) { @@ -645,7 +761,15 @@ public PutTrainedModelRequestDescriptor ModelType(Elastic.Clients.Elasticsearch. } /// - /// The platform architecture (if applicable) of the trained mode. If the model
only works on one platform, because it is heavily optimized for a particular
processor architecture and OS combination, then this field specifies which.
The format of the string must match the platform identifiers used by Elasticsearch,
so one of, `linux-x86_64`, `linux-aarch64`, `darwin-x86_64`, `darwin-aarch64`,
or `windows-x86_64`. For portable models (those that work independent of processor
architecture or OS features), leave this field unset. + /// + /// The platform architecture (if applicable) of the trained mode. If the model + /// only works on one platform, because it is heavily optimized for a particular + /// processor architecture and OS combination, then this field specifies which. + /// The format of the string must match the platform identifiers used by Elasticsearch, + /// so one of, linux-x86_64, linux-aarch64, darwin-x86_64, darwin-aarch64, + /// or windows-x86_64. For portable models (those that work independent of processor + /// architecture or OS features), leave this field unset. + /// /// public PutTrainedModelRequestDescriptor PlatformArchitecture(string? platformArchitecture) { @@ -654,7 +778,9 @@ public PutTrainedModelRequestDescriptor PlatformArchitecture(string? platformArc } /// - /// Optional prefix strings applied at inference + /// + /// Optional prefix strings applied at inference + /// /// public PutTrainedModelRequestDescriptor PrefixStrings(Elastic.Clients.Elasticsearch.MachineLearning.TrainedModelPrefixStrings? prefixStrings) { @@ -681,7 +807,9 @@ public PutTrainedModelRequestDescriptor PrefixStrings(Action - /// An array of tags to organize the model. + /// + /// An array of tags to organize the model. + /// /// public PutTrainedModelRequestDescriptor Tags(ICollection? tags) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelResponse.g.cs index 7c3cf04a8ee..2fdba4e3cb8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelResponse.g.cs @@ -32,61 +32,81 @@ public sealed partial class PutTrainedModelResponse : ElasticsearchResponse public string? CompressedDefinition { get; init; } /// - /// Information on the creator of the trained model. + /// + /// Information on the creator of the trained model. + /// /// [JsonInclude, JsonPropertyName("created_by")] public string? CreatedBy { get; init; } /// - /// The time when the trained model was created. + /// + /// The time when the trained model was created. + /// /// [JsonInclude, JsonPropertyName("create_time")] public DateTimeOffset? CreateTime { get; init; } /// - /// Any field map described in the inference configuration takes precedence. + /// + /// Any field map described in the inference configuration takes precedence. + /// /// [JsonInclude, JsonPropertyName("default_field_map")] public IReadOnlyDictionary? DefaultFieldMap { get; init; } /// - /// The free-text description of the trained model. + /// + /// The free-text description of the trained model. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; init; } /// - /// The estimated heap usage in bytes to keep the trained model in memory. + /// + /// The estimated heap usage in bytes to keep the trained model in memory. + /// /// [JsonInclude, JsonPropertyName("estimated_heap_memory_usage_bytes")] public int? EstimatedHeapMemoryUsageBytes { get; init; } /// - /// The estimated number of operations to use the trained model. + /// + /// The estimated number of operations to use the trained model. + /// /// [JsonInclude, JsonPropertyName("estimated_operations")] public int? EstimatedOperations { get; init; } /// - /// True if the full model definition is present. + /// + /// True if the full model definition is present. + /// /// [JsonInclude, JsonPropertyName("fully_defined")] public bool? FullyDefined { get; init; } /// - /// The default configuration for inference. This can be either a regression, classification, or one of the many NLP focused configurations. It must match the underlying definition.trained_model's target_type. For pre-packaged models such as ELSER the config is not required. + /// + /// The default configuration for inference. This can be either a regression, classification, or one of the many NLP focused configurations. It must match the underlying definition.trained_model's target_type. For pre-packaged models such as ELSER the config is not required. + /// /// [JsonInclude, JsonPropertyName("inference_config")] public Elastic.Clients.Elasticsearch.MachineLearning.InferenceConfigCreate? InferenceConfig { get; init; } /// - /// The input field names for the model definition. + /// + /// The input field names for the model definition. + /// /// [JsonInclude, JsonPropertyName("input")] public Elastic.Clients.Elasticsearch.MachineLearning.TrainedModelConfigInput Input { get; init; } /// - /// The license level of the trained model. + /// + /// The license level of the trained model. + /// /// [JsonInclude, JsonPropertyName("license_level")] public string? LicenseLevel { get; init; } @@ -94,13 +114,17 @@ public sealed partial class PutTrainedModelResponse : ElasticsearchResponse public Elastic.Clients.Elasticsearch.MachineLearning.TrainedModelLocation? Location { get; init; } /// - /// An object containing metadata about the trained model. For example, models created by data frame analytics contain analysis_config and input objects. + /// + /// An object containing metadata about the trained model. For example, models created by data frame analytics contain analysis_config and input objects. + /// /// [JsonInclude, JsonPropertyName("metadata")] public Elastic.Clients.Elasticsearch.MachineLearning.TrainedModelConfigMetadata? Metadata { get; init; } /// - /// Identifier for the trained model. + /// + /// Identifier for the trained model. + /// /// [JsonInclude, JsonPropertyName("model_id")] public string ModelId { get; init; } @@ -108,7 +132,9 @@ public sealed partial class PutTrainedModelResponse : ElasticsearchResponse public Elastic.Clients.Elasticsearch.ByteSize? ModelSizeBytes { get; init; } /// - /// The model type + /// + /// The model type + /// /// [JsonInclude, JsonPropertyName("model_type")] public Elastic.Clients.Elasticsearch.MachineLearning.TrainedModelType? ModelType { get; init; } @@ -116,13 +142,17 @@ public sealed partial class PutTrainedModelResponse : ElasticsearchResponse public Elastic.Clients.Elasticsearch.MachineLearning.TrainedModelPrefixStrings? PrefixStrings { get; init; } /// - /// A comma delimited string of tags. A trained model can have many tags, or none. + /// + /// A comma delimited string of tags. A trained model can have many tags, or none. + /// /// [JsonInclude, JsonPropertyName("tags")] public IReadOnlyCollection Tags { get; init; } /// - /// The Elasticsearch version number in which the trained model was created. + /// + /// The Elasticsearch version number in which the trained model was created. + /// /// [JsonInclude, JsonPropertyName("version")] public string? Version { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelVocabularyRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelVocabularyRequest.g.cs index f6477fa0f2f..c558f08ff14 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelVocabularyRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelVocabularyRequest.g.cs @@ -34,7 +34,11 @@ public sealed partial class PutTrainedModelVocabularyRequestParameters : Request } /// -/// Creates a trained model vocabulary.
This API is supported only for natural language processing (NLP) models.
The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition. +/// +/// Creates a trained model vocabulary. +/// This API is supported only for natural language processing (NLP) models. +/// The vocabulary is stored in the index as described in inference_config.*.vocabulary of the trained model definition. +/// /// public sealed partial class PutTrainedModelVocabularyRequest : PlainRequest { @@ -51,26 +55,36 @@ public PutTrainedModelVocabularyRequest(Elastic.Clients.Elasticsearch.Id modelId internal override string OperationName => "ml.put_trained_model_vocabulary"; /// - /// The optional model merges if required by the tokenizer. + /// + /// The optional model merges if required by the tokenizer. + /// /// [JsonInclude, JsonPropertyName("merges")] public ICollection? Merges { get; set; } /// - /// The optional vocabulary value scores if required by the tokenizer. + /// + /// The optional vocabulary value scores if required by the tokenizer. + /// /// [JsonInclude, JsonPropertyName("scores")] public ICollection? Scores { get; set; } /// - /// The model vocabulary, which must not be empty. + /// + /// The model vocabulary, which must not be empty. + /// /// [JsonInclude, JsonPropertyName("vocabulary")] public ICollection Vocabulary { get; set; } } /// -/// Creates a trained model vocabulary.
This API is supported only for natural language processing (NLP) models.
The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition. +/// +/// Creates a trained model vocabulary. +/// This API is supported only for natural language processing (NLP) models. +/// The vocabulary is stored in the index as described in inference_config.*.vocabulary of the trained model definition. +/// /// public sealed partial class PutTrainedModelVocabularyRequestDescriptor : RequestDescriptor { @@ -99,7 +113,9 @@ public PutTrainedModelVocabularyRequestDescriptor ModelId(Elastic.Clients.Elasti private ICollection VocabularyValue { get; set; } /// - /// The optional model merges if required by the tokenizer. + /// + /// The optional model merges if required by the tokenizer. + /// /// public PutTrainedModelVocabularyRequestDescriptor Merges(ICollection? merges) { @@ -108,7 +124,9 @@ public PutTrainedModelVocabularyRequestDescriptor Merges(ICollection? me } /// - /// The optional vocabulary value scores if required by the tokenizer. + /// + /// The optional vocabulary value scores if required by the tokenizer. + /// /// public PutTrainedModelVocabularyRequestDescriptor Scores(ICollection? scores) { @@ -117,7 +135,9 @@ public PutTrainedModelVocabularyRequestDescriptor Scores(ICollection? sc } /// - /// The model vocabulary, which must not be empty. + /// + /// The model vocabulary, which must not be empty. + /// /// public PutTrainedModelVocabularyRequestDescriptor Vocabulary(ICollection vocabulary) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelVocabularyResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelVocabularyResponse.g.cs index 8acbf4ee3c3..ad429dd3de8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelVocabularyResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelVocabularyResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class PutTrainedModelVocabularyResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ResetJobRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ResetJobRequest.g.cs index e0943d8e9e9..a2a61f2a823 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ResetJobRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ResetJobRequest.g.cs @@ -32,18 +32,31 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class ResetJobRequestParameters : RequestParameters { /// - /// Specifies whether annotations that have been added by the
user should be deleted along with any auto-generated annotations when the job is
reset. + /// + /// Specifies whether annotations that have been added by the + /// user should be deleted along with any auto-generated annotations when the job is + /// reset. + /// /// public bool? DeleteUserAnnotations { get => Q("delete_user_annotations"); set => Q("delete_user_annotations", value); } /// - /// Should this request wait until the operation has completed before
returning. + /// + /// Should this request wait until the operation has completed before + /// returning. + /// /// public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Resets an anomaly detection job.
All model state and results are deleted. The job is ready to start over as if
it had just been created.
It is not currently possible to reset multiple jobs using wildcards or a
comma separated list. +/// +/// Resets an anomaly detection job. +/// All model state and results are deleted. The job is ready to start over as if +/// it had just been created. +/// It is not currently possible to reset multiple jobs using wildcards or a +/// comma separated list. +/// /// public sealed partial class ResetJobRequest : PlainRequest { @@ -60,20 +73,33 @@ public ResetJobRequest(Elastic.Clients.Elasticsearch.Id jobId) : base(r => r.Req internal override string OperationName => "ml.reset_job"; /// - /// Specifies whether annotations that have been added by the
user should be deleted along with any auto-generated annotations when the job is
reset. + /// + /// Specifies whether annotations that have been added by the + /// user should be deleted along with any auto-generated annotations when the job is + /// reset. + /// /// [JsonIgnore] public bool? DeleteUserAnnotations { get => Q("delete_user_annotations"); set => Q("delete_user_annotations", value); } /// - /// Should this request wait until the operation has completed before
returning. + /// + /// Should this request wait until the operation has completed before + /// returning. + /// /// [JsonIgnore] public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Resets an anomaly detection job.
All model state and results are deleted. The job is ready to start over as if
it had just been created.
It is not currently possible to reset multiple jobs using wildcards or a
comma separated list. +/// +/// Resets an anomaly detection job. +/// All model state and results are deleted. The job is ready to start over as if +/// it had just been created. +/// It is not currently possible to reset multiple jobs using wildcards or a +/// comma separated list. +/// /// public sealed partial class ResetJobRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ResetJobResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ResetJobResponse.g.cs index 0e4d2efea7f..1376dc1be33 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ResetJobResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ResetJobResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class ResetJobResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/RevertModelSnapshotRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/RevertModelSnapshotRequest.g.cs index 8b7e8443ffe..f91ab400fb0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/RevertModelSnapshotRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/RevertModelSnapshotRequest.g.cs @@ -34,7 +34,16 @@ public sealed partial class RevertModelSnapshotRequestParameters : RequestParame } /// -/// Reverts to a specific snapshot.
The machine learning features react quickly to anomalous input, learning new
behaviors in data. Highly anomalous input increases the variance in the
models whilst the system learns whether this is a new step-change in behavior
or a one-off event. In the case where this anomalous input is known to be a
one-off, then it might be appropriate to reset the model state to a time
before this event. For example, you might consider reverting to a saved
snapshot after Black Friday or a critical system failure. +/// +/// Reverts to a specific snapshot. +/// The machine learning features react quickly to anomalous input, learning new +/// behaviors in data. Highly anomalous input increases the variance in the +/// models whilst the system learns whether this is a new step-change in behavior +/// or a one-off event. In the case where this anomalous input is known to be a +/// one-off, then it might be appropriate to reset the model state to a time +/// before this event. For example, you might consider reverting to a saved +/// snapshot after Black Friday or a critical system failure. +/// /// public sealed partial class RevertModelSnapshotRequest : PlainRequest { @@ -51,14 +60,25 @@ public RevertModelSnapshotRequest(Elastic.Clients.Elasticsearch.Id jobId, Elasti internal override string OperationName => "ml.revert_model_snapshot"; /// - /// Refer to the description for the `delete_intervening_results` query parameter. + /// + /// Refer to the description for the delete_intervening_results query parameter. + /// /// [JsonInclude, JsonPropertyName("delete_intervening_results")] public bool? DeleteInterveningResults { get; set; } } /// -/// Reverts to a specific snapshot.
The machine learning features react quickly to anomalous input, learning new
behaviors in data. Highly anomalous input increases the variance in the
models whilst the system learns whether this is a new step-change in behavior
or a one-off event. In the case where this anomalous input is known to be a
one-off, then it might be appropriate to reset the model state to a time
before this event. For example, you might consider reverting to a saved
snapshot after Black Friday or a critical system failure. +/// +/// Reverts to a specific snapshot. +/// The machine learning features react quickly to anomalous input, learning new +/// behaviors in data. Highly anomalous input increases the variance in the +/// models whilst the system learns whether this is a new step-change in behavior +/// or a one-off event. In the case where this anomalous input is known to be a +/// one-off, then it might be appropriate to reset the model state to a time +/// before this event. For example, you might consider reverting to a saved +/// snapshot after Black Friday or a critical system failure. +/// /// public sealed partial class RevertModelSnapshotRequestDescriptor : RequestDescriptor { @@ -91,7 +111,9 @@ public RevertModelSnapshotRequestDescriptor SnapshotId(Elastic.Clients.Elasticse private bool? DeleteInterveningResultsValue { get; set; } /// - /// Refer to the description for the `delete_intervening_results` query parameter. + /// + /// Refer to the description for the delete_intervening_results query parameter. + /// /// public RevertModelSnapshotRequestDescriptor DeleteInterveningResults(bool? deleteInterveningResults = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/SetUpgradeModeRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/SetUpgradeModeRequest.g.cs index 6e00c1bb4c3..0442743219d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/SetUpgradeModeRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/SetUpgradeModeRequest.g.cs @@ -32,18 +32,37 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class SetUpgradeModeRequestParameters : RequestParameters { /// - /// When `true`, it enables `upgrade_mode` which temporarily halts all job
and datafeed tasks and prohibits new job and datafeed tasks from
starting. + /// + /// When true, it enables upgrade_mode which temporarily halts all job + /// and datafeed tasks and prohibits new job and datafeed tasks from + /// starting. + /// /// public bool? Enabled { get => Q("enabled"); set => Q("enabled", value); } /// - /// The time to wait for the request to be completed. + /// + /// The time to wait for the request to be completed. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Sets a cluster wide upgrade_mode setting that prepares machine learning
indices for an upgrade.
When upgrading your cluster, in some circumstances you must restart your
nodes and reindex your machine learning indices. In those circumstances,
there must be no machine learning jobs running. You can close the machine
learning jobs, do the upgrade, then open all the jobs again. Alternatively,
you can use this API to temporarily halt tasks associated with the jobs and
datafeeds and prevent new jobs from opening. You can also use this API
during upgrades that do not require you to reindex your machine learning
indices, though stopping jobs is not a requirement in that case.
You can see the current value for the upgrade_mode setting by using the get
machine learning info API. +/// +/// Sets a cluster wide upgrade_mode setting that prepares machine learning +/// indices for an upgrade. +/// When upgrading your cluster, in some circumstances you must restart your +/// nodes and reindex your machine learning indices. In those circumstances, +/// there must be no machine learning jobs running. You can close the machine +/// learning jobs, do the upgrade, then open all the jobs again. Alternatively, +/// you can use this API to temporarily halt tasks associated with the jobs and +/// datafeeds and prevent new jobs from opening. You can also use this API +/// during upgrades that do not require you to reindex your machine learning +/// indices, though stopping jobs is not a requirement in that case. +/// You can see the current value for the upgrade_mode setting by using the get +/// machine learning info API. +/// /// public sealed partial class SetUpgradeModeRequest : PlainRequest { @@ -56,20 +75,39 @@ public sealed partial class SetUpgradeModeRequest : PlainRequest "ml.set_upgrade_mode"; /// - /// When `true`, it enables `upgrade_mode` which temporarily halts all job
and datafeed tasks and prohibits new job and datafeed tasks from
starting. + /// + /// When true, it enables upgrade_mode which temporarily halts all job + /// and datafeed tasks and prohibits new job and datafeed tasks from + /// starting. + /// /// [JsonIgnore] public bool? Enabled { get => Q("enabled"); set => Q("enabled", value); } /// - /// The time to wait for the request to be completed. + /// + /// The time to wait for the request to be completed. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Sets a cluster wide upgrade_mode setting that prepares machine learning
indices for an upgrade.
When upgrading your cluster, in some circumstances you must restart your
nodes and reindex your machine learning indices. In those circumstances,
there must be no machine learning jobs running. You can close the machine
learning jobs, do the upgrade, then open all the jobs again. Alternatively,
you can use this API to temporarily halt tasks associated with the jobs and
datafeeds and prevent new jobs from opening. You can also use this API
during upgrades that do not require you to reindex your machine learning
indices, though stopping jobs is not a requirement in that case.
You can see the current value for the upgrade_mode setting by using the get
machine learning info API. +/// +/// Sets a cluster wide upgrade_mode setting that prepares machine learning +/// indices for an upgrade. +/// When upgrading your cluster, in some circumstances you must restart your +/// nodes and reindex your machine learning indices. In those circumstances, +/// there must be no machine learning jobs running. You can close the machine +/// learning jobs, do the upgrade, then open all the jobs again. Alternatively, +/// you can use this API to temporarily halt tasks associated with the jobs and +/// datafeeds and prevent new jobs from opening. You can also use this API +/// during upgrades that do not require you to reindex your machine learning +/// indices, though stopping jobs is not a requirement in that case. +/// You can see the current value for the upgrade_mode setting by using the get +/// machine learning info API. +/// /// public sealed partial class SetUpgradeModeRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/SetUpgradeModeResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/SetUpgradeModeResponse.g.cs index ba87e130c59..2331ea78700 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/SetUpgradeModeResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/SetUpgradeModeResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class SetUpgradeModeResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StartDataFrameAnalyticsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StartDataFrameAnalyticsRequest.g.cs index 5fa61a21051..9d4791b3389 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StartDataFrameAnalyticsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StartDataFrameAnalyticsRequest.g.cs @@ -32,13 +32,29 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class StartDataFrameAnalyticsRequestParameters : RequestParameters { /// - /// Controls the amount of time to wait until the data frame analytics job
starts. + /// + /// Controls the amount of time to wait until the data frame analytics job + /// starts. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Starts a data frame analytics job.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle.
If the destination index does not exist, it is created automatically the
first time you start the data frame analytics job. The
`index.number_of_shards` and `index.number_of_replicas` settings for the
destination index are copied from the source index. If there are multiple
source indices, the destination index copies the highest setting values. The
mappings for the destination index are also copied from the source indices.
If there are any mapping conflicts, the job fails to start.
If the destination index exists, it is used as is. You can therefore set up
the destination index in advance with custom settings and mappings. +/// +/// Starts a data frame analytics job. +/// A data frame analytics job can be started and stopped multiple times +/// throughout its lifecycle. +/// If the destination index does not exist, it is created automatically the +/// first time you start the data frame analytics job. The +/// index.number_of_shards and index.number_of_replicas settings for the +/// destination index are copied from the source index. If there are multiple +/// source indices, the destination index copies the highest setting values. The +/// mappings for the destination index are also copied from the source indices. +/// If there are any mapping conflicts, the job fails to start. +/// If the destination index exists, it is used as is. You can therefore set up +/// the destination index in advance with custom settings and mappings. +/// /// public sealed partial class StartDataFrameAnalyticsRequest : PlainRequest { @@ -55,14 +71,30 @@ public StartDataFrameAnalyticsRequest(Elastic.Clients.Elasticsearch.Id id) : bas internal override string OperationName => "ml.start_data_frame_analytics"; /// - /// Controls the amount of time to wait until the data frame analytics job
starts. + /// + /// Controls the amount of time to wait until the data frame analytics job + /// starts. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Starts a data frame analytics job.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle.
If the destination index does not exist, it is created automatically the
first time you start the data frame analytics job. The
`index.number_of_shards` and `index.number_of_replicas` settings for the
destination index are copied from the source index. If there are multiple
source indices, the destination index copies the highest setting values. The
mappings for the destination index are also copied from the source indices.
If there are any mapping conflicts, the job fails to start.
If the destination index exists, it is used as is. You can therefore set up
the destination index in advance with custom settings and mappings. +/// +/// Starts a data frame analytics job. +/// A data frame analytics job can be started and stopped multiple times +/// throughout its lifecycle. +/// If the destination index does not exist, it is created automatically the +/// first time you start the data frame analytics job. The +/// index.number_of_shards and index.number_of_replicas settings for the +/// destination index are copied from the source index. If there are multiple +/// source indices, the destination index copies the highest setting values. The +/// mappings for the destination index are also copied from the source indices. +/// If there are any mapping conflicts, the job fails to start. +/// If the destination index exists, it is used as is. You can therefore set up +/// the destination index in advance with custom settings and mappings. +/// /// public sealed partial class StartDataFrameAnalyticsRequestDescriptor : RequestDescriptor, StartDataFrameAnalyticsRequestParameters> { @@ -94,7 +126,20 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Starts a data frame analytics job.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle.
If the destination index does not exist, it is created automatically the
first time you start the data frame analytics job. The
`index.number_of_shards` and `index.number_of_replicas` settings for the
destination index are copied from the source index. If there are multiple
source indices, the destination index copies the highest setting values. The
mappings for the destination index are also copied from the source indices.
If there are any mapping conflicts, the job fails to start.
If the destination index exists, it is used as is. You can therefore set up
the destination index in advance with custom settings and mappings. +/// +/// Starts a data frame analytics job. +/// A data frame analytics job can be started and stopped multiple times +/// throughout its lifecycle. +/// If the destination index does not exist, it is created automatically the +/// first time you start the data frame analytics job. The +/// index.number_of_shards and index.number_of_replicas settings for the +/// destination index are copied from the source index. If there are multiple +/// source indices, the destination index copies the highest setting values. The +/// mappings for the destination index are also copied from the source indices. +/// If there are any mapping conflicts, the job fails to start. +/// If the destination index exists, it is used as is. You can therefore set up +/// the destination index in advance with custom settings and mappings. +/// /// public sealed partial class StartDataFrameAnalyticsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StartDataFrameAnalyticsResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StartDataFrameAnalyticsResponse.g.cs index b4b1722342b..2285b69b809 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StartDataFrameAnalyticsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StartDataFrameAnalyticsResponse.g.cs @@ -32,7 +32,13 @@ public sealed partial class StartDataFrameAnalyticsResponse : ElasticsearchRespo public bool Acknowledged { get; init; } /// - /// The ID of the node that the job was started on. If the job is allowed to open lazily and has not yet been assigned to a node, this value is an empty string.
The node ID of the node the job has been assigned to, or
an empty string if it hasn't been assigned to a node. In
serverless if the job has been assigned to run then the
node ID will be "serverless". + /// + /// The ID of the node that the job was started on. If the job is allowed to open lazily and has not yet been assigned to a node, this value is an empty string. + /// The node ID of the node the job has been assigned to, or + /// an empty string if it hasn't been assigned to a node. In + /// serverless if the job has been assigned to run then the + /// node ID will be "serverless". + /// /// [JsonInclude, JsonPropertyName("node")] public string Node { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StartDatafeedRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StartDatafeedRequest.g.cs index 17bdf02d400..467e0882f38 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StartDatafeedRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StartDatafeedRequest.g.cs @@ -34,11 +34,25 @@ public sealed partial class StartDatafeedRequestParameters : RequestParameters } /// -/// Starts one or more datafeeds. -/// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. -/// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. -/// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.
If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. -/// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or
update it had at the time of creation or update and runs the query using those same roles. If you provided secondary
authorization headers when you created or updated the datafeed, those credentials are used instead. +/// +/// Starts one or more datafeeds. +/// +/// +/// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped +/// multiple times throughout its lifecycle. +/// +/// +/// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. +/// +/// +/// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped. +/// If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. +/// +/// +/// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or +/// update it had at the time of creation or update and runs the query using those same roles. If you provided secondary +/// authorization headers when you created or updated the datafeed, those credentials are used instead. +/// /// public sealed partial class StartDatafeedRequest : PlainRequest { @@ -55,30 +69,50 @@ public StartDatafeedRequest(Elastic.Clients.Elasticsearch.Id datafeedId) : base( internal override string OperationName => "ml.start_datafeed"; /// - /// Refer to the description for the `end` query parameter. + /// + /// Refer to the description for the end query parameter. + /// /// [JsonInclude, JsonPropertyName("end")] public DateTimeOffset? End { get; set; } /// - /// Refer to the description for the `start` query parameter. + /// + /// Refer to the description for the start query parameter. + /// /// [JsonInclude, JsonPropertyName("start")] public DateTimeOffset? Start { get; set; } /// - /// Refer to the description for the `timeout` query parameter. + /// + /// Refer to the description for the timeout query parameter. + /// /// [JsonInclude, JsonPropertyName("timeout")] public Elastic.Clients.Elasticsearch.Duration? Timeout { get; set; } } /// -/// Starts one or more datafeeds. -/// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. -/// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. -/// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.
If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. -/// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or
update it had at the time of creation or update and runs the query using those same roles. If you provided secondary
authorization headers when you created or updated the datafeed, those credentials are used instead. +/// +/// Starts one or more datafeeds. +/// +/// +/// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped +/// multiple times throughout its lifecycle. +/// +/// +/// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. +/// +/// +/// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped. +/// If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. +/// +/// +/// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or +/// update it had at the time of creation or update and runs the query using those same roles. If you provided secondary +/// authorization headers when you created or updated the datafeed, those credentials are used instead. +/// /// public sealed partial class StartDatafeedRequestDescriptor : RequestDescriptor { @@ -107,7 +141,9 @@ public StartDatafeedRequestDescriptor DatafeedId(Elastic.Clients.Elasticsearch.I private Elastic.Clients.Elasticsearch.Duration? TimeoutValue { get; set; } /// - /// Refer to the description for the `end` query parameter. + /// + /// Refer to the description for the end query parameter. + /// /// public StartDatafeedRequestDescriptor End(DateTimeOffset? end) { @@ -116,7 +152,9 @@ public StartDatafeedRequestDescriptor End(DateTimeOffset? end) } /// - /// Refer to the description for the `start` query parameter. + /// + /// Refer to the description for the start query parameter. + /// /// public StartDatafeedRequestDescriptor Start(DateTimeOffset? start) { @@ -125,7 +163,9 @@ public StartDatafeedRequestDescriptor Start(DateTimeOffset? start) } /// - /// Refer to the description for the `timeout` query parameter. + /// + /// Refer to the description for the timeout query parameter. + /// /// public StartDatafeedRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Duration? timeout) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StartDatafeedResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StartDatafeedResponse.g.cs index ce72f25268a..a8ff65cd2ea 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StartDatafeedResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StartDatafeedResponse.g.cs @@ -29,14 +29,19 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class StartDatafeedResponse : ElasticsearchResponse { /// - /// The ID of the node that the job was started on. In serverless this will be the "serverless".
If the job is allowed to open lazily and has not yet been assigned to a node, this value is an empty string. + /// + /// The ID of the node that the job was started on. In serverless this will be the "serverless". + /// If the job is allowed to open lazily and has not yet been assigned to a node, this value is an empty string. + /// /// [JsonInclude, JsonPropertyName("node")] [SingleOrManyCollectionConverter(typeof(string))] public IReadOnlyCollection Node { get; init; } /// - /// For a successful response, this value is always `true`. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("started")] public bool Started { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StartTrainedModelDeploymentRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StartTrainedModelDeploymentRequest.g.cs index 1b19bd129e7..29bfa9cf392 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StartTrainedModelDeploymentRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StartTrainedModelDeploymentRequest.g.cs @@ -32,48 +32,78 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class StartTrainedModelDeploymentRequestParameters : RequestParameters { /// - /// The inference cache size (in memory outside the JVM heap) per node for the model.
The default value is the same size as the `model_size_bytes`. To disable the cache,
`0b` can be provided. + /// + /// The inference cache size (in memory outside the JVM heap) per node for the model. + /// The default value is the same size as the model_size_bytes. To disable the cache, + /// 0b can be provided. + /// /// public Elastic.Clients.Elasticsearch.ByteSize? CacheSize { get => Q("cache_size"); set => Q("cache_size", value); } /// - /// A unique identifier for the deployment of the model. + /// + /// A unique identifier for the deployment of the model. + /// /// public string? DeploymentId { get => Q("deployment_id"); set => Q("deployment_id", value); } /// - /// The number of model allocations on each node where the model is deployed.
All allocations on a node share the same copy of the model in memory but use
a separate set of threads to evaluate the model.
Increasing this value generally increases the throughput.
If this setting is greater than the number of hardware threads
it will automatically be changed to a value less than the number of hardware threads. + /// + /// The number of model allocations on each node where the model is deployed. + /// All allocations on a node share the same copy of the model in memory but use + /// a separate set of threads to evaluate the model. + /// Increasing this value generally increases the throughput. + /// If this setting is greater than the number of hardware threads + /// it will automatically be changed to a value less than the number of hardware threads. + /// /// public int? NumberOfAllocations { get => Q("number_of_allocations"); set => Q("number_of_allocations", value); } /// - /// The deployment priority. + /// + /// The deployment priority. + /// /// public Elastic.Clients.Elasticsearch.MachineLearning.TrainingPriority? Priority { get => Q("priority"); set => Q("priority", value); } /// - /// Specifies the number of inference requests that are allowed in the queue. After the number of requests exceeds
this value, new requests are rejected with a 429 error. + /// + /// Specifies the number of inference requests that are allowed in the queue. After the number of requests exceeds + /// this value, new requests are rejected with a 429 error. + /// /// public int? QueueCapacity { get => Q("queue_capacity"); set => Q("queue_capacity", value); } /// - /// Sets the number of threads used by each model allocation during inference. This generally increases
the inference speed. The inference process is a compute-bound process; any number
greater than the number of available hardware threads on the machine does not increase the
inference speed. If this setting is greater than the number of hardware threads
it will automatically be changed to a value less than the number of hardware threads. + /// + /// Sets the number of threads used by each model allocation during inference. This generally increases + /// the inference speed. The inference process is a compute-bound process; any number + /// greater than the number of available hardware threads on the machine does not increase the + /// inference speed. If this setting is greater than the number of hardware threads + /// it will automatically be changed to a value less than the number of hardware threads. + /// /// public int? ThreadsPerAllocation { get => Q("threads_per_allocation"); set => Q("threads_per_allocation", value); } /// - /// Specifies the amount of time to wait for the model to deploy. + /// + /// Specifies the amount of time to wait for the model to deploy. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Specifies the allocation status to wait for before returning. + /// + /// Specifies the allocation status to wait for before returning. + /// /// public Elastic.Clients.Elasticsearch.MachineLearning.DeploymentAllocationState? WaitFor { get => Q("wait_for"); set => Q("wait_for", value); } } /// -/// Starts a trained model deployment, which allocates the model to every machine learning node. +/// +/// Starts a trained model deployment, which allocates the model to every machine learning node. +/// /// public sealed partial class StartTrainedModelDeploymentRequest : PlainRequest { @@ -90,56 +120,86 @@ public StartTrainedModelDeploymentRequest(Elastic.Clients.Elasticsearch.Id model internal override string OperationName => "ml.start_trained_model_deployment"; /// - /// The inference cache size (in memory outside the JVM heap) per node for the model.
The default value is the same size as the `model_size_bytes`. To disable the cache,
`0b` can be provided. + /// + /// The inference cache size (in memory outside the JVM heap) per node for the model. + /// The default value is the same size as the model_size_bytes. To disable the cache, + /// 0b can be provided. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.ByteSize? CacheSize { get => Q("cache_size"); set => Q("cache_size", value); } /// - /// A unique identifier for the deployment of the model. + /// + /// A unique identifier for the deployment of the model. + /// /// [JsonIgnore] public string? DeploymentId { get => Q("deployment_id"); set => Q("deployment_id", value); } /// - /// The number of model allocations on each node where the model is deployed.
All allocations on a node share the same copy of the model in memory but use
a separate set of threads to evaluate the model.
Increasing this value generally increases the throughput.
If this setting is greater than the number of hardware threads
it will automatically be changed to a value less than the number of hardware threads. + /// + /// The number of model allocations on each node where the model is deployed. + /// All allocations on a node share the same copy of the model in memory but use + /// a separate set of threads to evaluate the model. + /// Increasing this value generally increases the throughput. + /// If this setting is greater than the number of hardware threads + /// it will automatically be changed to a value less than the number of hardware threads. + /// /// [JsonIgnore] public int? NumberOfAllocations { get => Q("number_of_allocations"); set => Q("number_of_allocations", value); } /// - /// The deployment priority. + /// + /// The deployment priority. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.MachineLearning.TrainingPriority? Priority { get => Q("priority"); set => Q("priority", value); } /// - /// Specifies the number of inference requests that are allowed in the queue. After the number of requests exceeds
this value, new requests are rejected with a 429 error. + /// + /// Specifies the number of inference requests that are allowed in the queue. After the number of requests exceeds + /// this value, new requests are rejected with a 429 error. + /// /// [JsonIgnore] public int? QueueCapacity { get => Q("queue_capacity"); set => Q("queue_capacity", value); } /// - /// Sets the number of threads used by each model allocation during inference. This generally increases
the inference speed. The inference process is a compute-bound process; any number
greater than the number of available hardware threads on the machine does not increase the
inference speed. If this setting is greater than the number of hardware threads
it will automatically be changed to a value less than the number of hardware threads. + /// + /// Sets the number of threads used by each model allocation during inference. This generally increases + /// the inference speed. The inference process is a compute-bound process; any number + /// greater than the number of available hardware threads on the machine does not increase the + /// inference speed. If this setting is greater than the number of hardware threads + /// it will automatically be changed to a value less than the number of hardware threads. + /// /// [JsonIgnore] public int? ThreadsPerAllocation { get => Q("threads_per_allocation"); set => Q("threads_per_allocation", value); } /// - /// Specifies the amount of time to wait for the model to deploy. + /// + /// Specifies the amount of time to wait for the model to deploy. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Specifies the allocation status to wait for before returning. + /// + /// Specifies the allocation status to wait for before returning. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.MachineLearning.DeploymentAllocationState? WaitFor { get => Q("wait_for"); set => Q("wait_for", value); } } /// -/// Starts a trained model deployment, which allocates the model to every machine learning node. +/// +/// Starts a trained model deployment, which allocates the model to every machine learning node. +/// /// public sealed partial class StartTrainedModelDeploymentRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StopDataFrameAnalyticsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StopDataFrameAnalyticsRequest.g.cs index 564c737f2ec..9ac3ac16b78 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StopDataFrameAnalyticsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StopDataFrameAnalyticsRequest.g.cs @@ -32,25 +32,58 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class StopDataFrameAnalyticsRequestParameters : RequestParameters { /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no data frame analytics
jobs that match.
2. Contains the _all string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// The default value is true, which returns an empty data_frame_analytics
array when there are no matches and the subset of results when there are
partial matches. If this parameter is false, the request returns a 404
status code when there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no data frame analytics + /// jobs that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// The default value is true, which returns an empty data_frame_analytics + /// array when there are no matches and the subset of results when there are + /// partial matches. If this parameter is false, the request returns a 404 + /// status code when there are no matches or only partial matches. + /// /// public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// If true, the data frame analytics job is stopped forcefully. + /// + /// If true, the data frame analytics job is stopped forcefully. + /// /// public bool? Force { get => Q("force"); set => Q("force", value); } /// - /// Controls the amount of time to wait until the data frame analytics job
stops. Defaults to 20 seconds. + /// + /// Controls the amount of time to wait until the data frame analytics job + /// stops. Defaults to 20 seconds. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Stops one or more data frame analytics jobs.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle. +/// +/// Stops one or more data frame analytics jobs. +/// A data frame analytics job can be started and stopped multiple times +/// throughout its lifecycle. +/// /// public sealed partial class StopDataFrameAnalyticsRequest : PlainRequest { @@ -67,28 +100,61 @@ public StopDataFrameAnalyticsRequest(Elastic.Clients.Elasticsearch.Id id) : base internal override string OperationName => "ml.stop_data_frame_analytics"; /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no data frame analytics
jobs that match.
2. Contains the _all string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// The default value is true, which returns an empty data_frame_analytics
array when there are no matches and the subset of results when there are
partial matches. If this parameter is false, the request returns a 404
status code when there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no data frame analytics + /// jobs that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// The default value is true, which returns an empty data_frame_analytics + /// array when there are no matches and the subset of results when there are + /// partial matches. If this parameter is false, the request returns a 404 + /// status code when there are no matches or only partial matches. + /// /// [JsonIgnore] public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// If true, the data frame analytics job is stopped forcefully. + /// + /// If true, the data frame analytics job is stopped forcefully. + /// /// [JsonIgnore] public bool? Force { get => Q("force"); set => Q("force", value); } /// - /// Controls the amount of time to wait until the data frame analytics job
stops. Defaults to 20 seconds. + /// + /// Controls the amount of time to wait until the data frame analytics job + /// stops. Defaults to 20 seconds. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Stops one or more data frame analytics jobs.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle. +/// +/// Stops one or more data frame analytics jobs. +/// A data frame analytics job can be started and stopped multiple times +/// throughout its lifecycle. +/// /// public sealed partial class StopDataFrameAnalyticsRequestDescriptor : RequestDescriptor, StopDataFrameAnalyticsRequestParameters> { @@ -122,7 +188,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Stops one or more data frame analytics jobs.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle. +/// +/// Stops one or more data frame analytics jobs. +/// A data frame analytics job can be started and stopped multiple times +/// throughout its lifecycle. +/// /// public sealed partial class StopDataFrameAnalyticsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StopDatafeedRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StopDatafeedRequest.g.cs index c3bc6307a5f..ce76cb9ad5e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StopDatafeedRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StopDatafeedRequest.g.cs @@ -34,7 +34,11 @@ public sealed partial class StopDatafeedRequestParameters : RequestParameters } /// -/// Stops one or more datafeeds.
A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. +/// +/// Stops one or more datafeeds. +/// A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped +/// multiple times throughout its lifecycle. +/// /// public sealed partial class StopDatafeedRequest : PlainRequest { @@ -51,26 +55,36 @@ public StopDatafeedRequest(Elastic.Clients.Elasticsearch.Id datafeedId) : base(r internal override string OperationName => "ml.stop_datafeed"; /// - /// Refer to the description for the `allow_no_match` query parameter. + /// + /// Refer to the description for the allow_no_match query parameter. + /// /// [JsonInclude, JsonPropertyName("allow_no_match")] public bool? AllowNoMatch { get; set; } /// - /// Refer to the description for the `force` query parameter. + /// + /// Refer to the description for the force query parameter. + /// /// [JsonInclude, JsonPropertyName("force")] public bool? Force { get; set; } /// - /// Refer to the description for the `timeout` query parameter. + /// + /// Refer to the description for the timeout query parameter. + /// /// [JsonInclude, JsonPropertyName("timeout")] public Elastic.Clients.Elasticsearch.Duration? Timeout { get; set; } } /// -/// Stops one or more datafeeds.
A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. +/// +/// Stops one or more datafeeds. +/// A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped +/// multiple times throughout its lifecycle. +/// /// public sealed partial class StopDatafeedRequestDescriptor : RequestDescriptor { @@ -99,7 +113,9 @@ public StopDatafeedRequestDescriptor DatafeedId(Elastic.Clients.Elasticsearch.Id private Elastic.Clients.Elasticsearch.Duration? TimeoutValue { get; set; } /// - /// Refer to the description for the `allow_no_match` query parameter. + /// + /// Refer to the description for the allow_no_match query parameter. + /// /// public StopDatafeedRequestDescriptor AllowNoMatch(bool? allowNoMatch = true) { @@ -108,7 +124,9 @@ public StopDatafeedRequestDescriptor AllowNoMatch(bool? allowNoMatch = true) } /// - /// Refer to the description for the `force` query parameter. + /// + /// Refer to the description for the force query parameter. + /// /// public StopDatafeedRequestDescriptor Force(bool? force = true) { @@ -117,7 +135,9 @@ public StopDatafeedRequestDescriptor Force(bool? force = true) } /// - /// Refer to the description for the `timeout` query parameter. + /// + /// Refer to the description for the timeout query parameter. + /// /// public StopDatafeedRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Duration? timeout) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StopTrainedModelDeploymentRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StopTrainedModelDeploymentRequest.g.cs index 79f4acf9cbb..f5e462f27e6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StopTrainedModelDeploymentRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/StopTrainedModelDeploymentRequest.g.cs @@ -32,18 +32,28 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class StopTrainedModelDeploymentRequestParameters : RequestParameters { /// - /// Specifies what to do when the request: contains wildcard expressions and there are no deployments that match;
contains the `_all` string or no identifiers and there are no matches; or contains wildcard expressions and
there are only partial matches. By default, it returns an empty array when there are no matches and the subset of results when there are partial matches.
If `false`, the request returns a 404 status code when there are no matches or only partial matches. + /// + /// Specifies what to do when the request: contains wildcard expressions and there are no deployments that match; + /// contains the _all string or no identifiers and there are no matches; or contains wildcard expressions and + /// there are only partial matches. By default, it returns an empty array when there are no matches and the subset of results when there are partial matches. + /// If false, the request returns a 404 status code when there are no matches or only partial matches. + /// /// public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Forcefully stops the deployment, even if it is used by ingest pipelines. You can't use these pipelines until you
restart the model deployment. + /// + /// Forcefully stops the deployment, even if it is used by ingest pipelines. You can't use these pipelines until you + /// restart the model deployment. + /// /// public bool? Force { get => Q("force"); set => Q("force", value); } } /// -/// Stops a trained model deployment. +/// +/// Stops a trained model deployment. +/// /// public sealed partial class StopTrainedModelDeploymentRequest : PlainRequest { @@ -60,20 +70,30 @@ public StopTrainedModelDeploymentRequest(Elastic.Clients.Elasticsearch.Id modelI internal override string OperationName => "ml.stop_trained_model_deployment"; /// - /// Specifies what to do when the request: contains wildcard expressions and there are no deployments that match;
contains the `_all` string or no identifiers and there are no matches; or contains wildcard expressions and
there are only partial matches. By default, it returns an empty array when there are no matches and the subset of results when there are partial matches.
If `false`, the request returns a 404 status code when there are no matches or only partial matches. + /// + /// Specifies what to do when the request: contains wildcard expressions and there are no deployments that match; + /// contains the _all string or no identifiers and there are no matches; or contains wildcard expressions and + /// there are only partial matches. By default, it returns an empty array when there are no matches and the subset of results when there are partial matches. + /// If false, the request returns a 404 status code when there are no matches or only partial matches. + /// /// [JsonIgnore] public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Forcefully stops the deployment, even if it is used by ingest pipelines. You can't use these pipelines until you
restart the model deployment. + /// + /// Forcefully stops the deployment, even if it is used by ingest pipelines. You can't use these pipelines until you + /// restart the model deployment. + /// /// [JsonIgnore] public bool? Force { get => Q("force"); set => Q("force", value); } } /// -/// Stops a trained model deployment. +/// +/// Stops a trained model deployment. +/// /// public sealed partial class StopTrainedModelDeploymentRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpdateDataFrameAnalyticsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpdateDataFrameAnalyticsRequest.g.cs index c4f8ebbcbf2..448a2d91c5b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpdateDataFrameAnalyticsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpdateDataFrameAnalyticsRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class UpdateDataFrameAnalyticsRequestParameters : RequestP } /// -/// Updates an existing data frame analytics job. +/// +/// Updates an existing data frame analytics job. +/// /// public sealed partial class UpdateDataFrameAnalyticsRequest : PlainRequest { @@ -51,32 +53,50 @@ public UpdateDataFrameAnalyticsRequest(Elastic.Clients.Elasticsearch.Id id) : ba internal override string OperationName => "ml.update_data_frame_analytics"; /// - /// Specifies whether this job can start when there is insufficient machine
learning node capacity for it to be immediately assigned to a node. + /// + /// Specifies whether this job can start when there is insufficient machine + /// learning node capacity for it to be immediately assigned to a node. + /// /// [JsonInclude, JsonPropertyName("allow_lazy_start")] public bool? AllowLazyStart { get; set; } /// - /// A description of the job. + /// + /// A description of the job. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The maximum number of threads to be used by the analysis. Using more
threads may decrease the time necessary to complete the analysis at the
cost of using more CPU. Note that the process may use additional threads
for operational functionality other than the analysis itself. + /// + /// The maximum number of threads to be used by the analysis. Using more + /// threads may decrease the time necessary to complete the analysis at the + /// cost of using more CPU. Note that the process may use additional threads + /// for operational functionality other than the analysis itself. + /// /// [JsonInclude, JsonPropertyName("max_num_threads")] public int? MaxNumThreads { get; set; } /// - /// The approximate maximum amount of memory resources that are permitted for
analytical processing. If your `elasticsearch.yml` file contains an
`xpack.ml.max_model_memory_limit` setting, an error occurs when you try
to create data frame analytics jobs that have `model_memory_limit` values
greater than that setting. + /// + /// The approximate maximum amount of memory resources that are permitted for + /// analytical processing. If your elasticsearch.yml file contains an + /// xpack.ml.max_model_memory_limit setting, an error occurs when you try + /// to create data frame analytics jobs that have model_memory_limit values + /// greater than that setting. + /// /// [JsonInclude, JsonPropertyName("model_memory_limit")] public string? ModelMemoryLimit { get; set; } } /// -/// Updates an existing data frame analytics job. +/// +/// Updates an existing data frame analytics job. +/// /// public sealed partial class UpdateDataFrameAnalyticsRequestDescriptor : RequestDescriptor, UpdateDataFrameAnalyticsRequestParameters> { @@ -106,7 +126,10 @@ public UpdateDataFrameAnalyticsRequestDescriptor Id(Elastic.Clients.E private string? ModelMemoryLimitValue { get; set; } /// - /// Specifies whether this job can start when there is insufficient machine
learning node capacity for it to be immediately assigned to a node. + /// + /// Specifies whether this job can start when there is insufficient machine + /// learning node capacity for it to be immediately assigned to a node. + /// /// public UpdateDataFrameAnalyticsRequestDescriptor AllowLazyStart(bool? allowLazyStart = true) { @@ -115,7 +138,9 @@ public UpdateDataFrameAnalyticsRequestDescriptor AllowLazyStart(bool? } /// - /// A description of the job. + /// + /// A description of the job. + /// /// public UpdateDataFrameAnalyticsRequestDescriptor Description(string? description) { @@ -124,7 +149,12 @@ public UpdateDataFrameAnalyticsRequestDescriptor Description(string? } /// - /// The maximum number of threads to be used by the analysis. Using more
threads may decrease the time necessary to complete the analysis at the
cost of using more CPU. Note that the process may use additional threads
for operational functionality other than the analysis itself. + /// + /// The maximum number of threads to be used by the analysis. Using more + /// threads may decrease the time necessary to complete the analysis at the + /// cost of using more CPU. Note that the process may use additional threads + /// for operational functionality other than the analysis itself. + /// /// public UpdateDataFrameAnalyticsRequestDescriptor MaxNumThreads(int? maxNumThreads) { @@ -133,7 +163,13 @@ public UpdateDataFrameAnalyticsRequestDescriptor MaxNumThreads(int? m } /// - /// The approximate maximum amount of memory resources that are permitted for
analytical processing. If your `elasticsearch.yml` file contains an
`xpack.ml.max_model_memory_limit` setting, an error occurs when you try
to create data frame analytics jobs that have `model_memory_limit` values
greater than that setting. + /// + /// The approximate maximum amount of memory resources that are permitted for + /// analytical processing. If your elasticsearch.yml file contains an + /// xpack.ml.max_model_memory_limit setting, an error occurs when you try + /// to create data frame analytics jobs that have model_memory_limit values + /// greater than that setting. + /// /// public UpdateDataFrameAnalyticsRequestDescriptor ModelMemoryLimit(string? modelMemoryLimit) { @@ -173,7 +209,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Updates an existing data frame analytics job. +/// +/// Updates an existing data frame analytics job. +/// /// public sealed partial class UpdateDataFrameAnalyticsRequestDescriptor : RequestDescriptor { @@ -203,7 +241,10 @@ public UpdateDataFrameAnalyticsRequestDescriptor Id(Elastic.Clients.Elasticsearc private string? ModelMemoryLimitValue { get; set; } /// - /// Specifies whether this job can start when there is insufficient machine
learning node capacity for it to be immediately assigned to a node. + /// + /// Specifies whether this job can start when there is insufficient machine + /// learning node capacity for it to be immediately assigned to a node. + /// /// public UpdateDataFrameAnalyticsRequestDescriptor AllowLazyStart(bool? allowLazyStart = true) { @@ -212,7 +253,9 @@ public UpdateDataFrameAnalyticsRequestDescriptor AllowLazyStart(bool? allowLazyS } /// - /// A description of the job. + /// + /// A description of the job. + /// /// public UpdateDataFrameAnalyticsRequestDescriptor Description(string? description) { @@ -221,7 +264,12 @@ public UpdateDataFrameAnalyticsRequestDescriptor Description(string? description } /// - /// The maximum number of threads to be used by the analysis. Using more
threads may decrease the time necessary to complete the analysis at the
cost of using more CPU. Note that the process may use additional threads
for operational functionality other than the analysis itself. + /// + /// The maximum number of threads to be used by the analysis. Using more + /// threads may decrease the time necessary to complete the analysis at the + /// cost of using more CPU. Note that the process may use additional threads + /// for operational functionality other than the analysis itself. + /// /// public UpdateDataFrameAnalyticsRequestDescriptor MaxNumThreads(int? maxNumThreads) { @@ -230,7 +278,13 @@ public UpdateDataFrameAnalyticsRequestDescriptor MaxNumThreads(int? maxNumThread } /// - /// The approximate maximum amount of memory resources that are permitted for
analytical processing. If your `elasticsearch.yml` file contains an
`xpack.ml.max_model_memory_limit` setting, an error occurs when you try
to create data frame analytics jobs that have `model_memory_limit` values
greater than that setting. + /// + /// The approximate maximum amount of memory resources that are permitted for + /// analytical processing. If your elasticsearch.yml file contains an + /// xpack.ml.max_model_memory_limit setting, an error occurs when you try + /// to create data frame analytics jobs that have model_memory_limit values + /// greater than that setting. + /// /// public UpdateDataFrameAnalyticsRequestDescriptor ModelMemoryLimit(string? modelMemoryLimit) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpdateDatafeedRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpdateDatafeedRequest.g.cs index b1ddad51af0..07f335b4630 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpdateDatafeedRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpdateDatafeedRequest.g.cs @@ -32,18 +32,52 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class UpdateDatafeedRequestParameters : RequestParameters { /// - /// If `true`, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the
`_all` string or when no indices are specified. + /// + /// If true, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the + /// _all string or when no indices are specified. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams. Supports comma-separated values. Valid values are: - /// * `all`: Match any data stream or index, including hidden ones.
* `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
* `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or both.
* `none`: Wildcard patterns are not accepted.
* `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. + /// + /// Type of index that wildcard patterns can match. If the request can target data streams, this argument determines + /// whether wildcard expressions match hidden data streams. Supports comma-separated values. Valid values are: + /// + /// + /// + /// + /// all: Match any data stream or index, including hidden ones. + /// + /// + /// + /// + /// closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. + /// + /// + /// + /// + /// hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. + /// + /// + /// + /// + /// none: Wildcard patterns are not accepted. + /// + /// + /// + /// + /// open: Match open, non-hidden indices. Also matches any non-hidden data stream. + /// + /// + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, unavailable indices (missing or closed) are ignored. + /// + /// If true, unavailable indices (missing or closed) are ignored. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } } @@ -229,7 +263,13 @@ public override void Write(Utf8JsonWriter writer, UpdateDatafeedRequest value, J } /// -/// Updates the properties of a datafeed.
You must stop and start the datafeed for the changes to be applied.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at
the time of the update and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead. +/// +/// Updates the properties of a datafeed. +/// You must stop and start the datafeed for the changes to be applied. +/// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at +/// the time of the update and runs the query using those same roles. If you provide secondary authorization headers, +/// those credentials are used instead. +/// /// [JsonConverter(typeof(UpdateDatafeedRequestConverter))] public sealed partial class UpdateDatafeedRequest : PlainRequest @@ -251,56 +291,114 @@ public UpdateDatafeedRequest() internal override string OperationName => "ml.update_datafeed"; /// - /// If `true`, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the
`_all` string or when no indices are specified. + /// + /// If true, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the + /// _all string or when no indices are specified. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams. Supports comma-separated values. Valid values are: - /// * `all`: Match any data stream or index, including hidden ones.
* `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
* `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or both.
* `none`: Wildcard patterns are not accepted.
* `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. + /// + /// Type of index that wildcard patterns can match. If the request can target data streams, this argument determines + /// whether wildcard expressions match hidden data streams. Supports comma-separated values. Valid values are: + /// + /// + /// + /// + /// all: Match any data stream or index, including hidden ones. + /// + /// + /// + /// + /// closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. + /// + /// + /// + /// + /// hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. + /// + /// + /// + /// + /// none: Wildcard patterns are not accepted. + /// + /// + /// + /// + /// open: Match open, non-hidden indices. Also matches any non-hidden data stream. + /// + /// + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, unavailable indices (missing or closed) are ignored. + /// + /// If true, unavailable indices (missing or closed) are ignored. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only
with low cardinality data. + /// + /// If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only + /// with low cardinality data. + /// /// [JsonInclude, JsonPropertyName("aggregations")] public IDictionary? Aggregations { get; set; } /// - /// Datafeeds might search over long time periods, for several months or years. This search is split into time
chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of
these time chunks are calculated; it is an advanced configuration option. + /// + /// Datafeeds might search over long time periods, for several months or years. This search is split into time + /// chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of + /// these time chunks are calculated; it is an advanced configuration option. + /// /// [JsonInclude, JsonPropertyName("chunking_config")] public Elastic.Clients.Elasticsearch.MachineLearning.ChunkingConfig? ChunkingConfig { get; set; } /// - /// Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally
search over indices that have already been read in an effort to determine whether any data has subsequently been
added to the index. If missing data is found, it is a good indication that the `query_delay` is set too low and
the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time
datafeeds. + /// + /// Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally + /// search over indices that have already been read in an effort to determine whether any data has subsequently been + /// added to the index. If missing data is found, it is a good indication that the query_delay is set too low and + /// the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time + /// datafeeds. + /// /// [JsonInclude, JsonPropertyName("delayed_data_check_config")] public Elastic.Clients.Elasticsearch.MachineLearning.DelayedDataCheckConfig? DelayedDataCheckConfig { get; set; } /// - /// The interval at which scheduled queries are made while the datafeed runs in real time. The default value is
either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket
span. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are
written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value
must be divisible by the interval of the date histogram aggregation. + /// + /// The interval at which scheduled queries are made while the datafeed runs in real time. The default value is + /// either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket + /// span. When frequency is shorter than the bucket span, interim results for the last (partial) bucket are + /// written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value + /// must be divisible by the interval of the date histogram aggregation. + /// /// [JsonInclude, JsonPropertyName("frequency")] public Elastic.Clients.Elasticsearch.Duration? Frequency { get; set; } /// - /// An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine
learning nodes must have the `remote_cluster_client` role. + /// + /// An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine + /// learning nodes must have the remote_cluster_client role. + /// /// [JsonInclude, JsonPropertyName("indices")] public ICollection? Indices { get; set; } /// - /// Specifies index expansion options that are used during search. + /// + /// Specifies index expansion options that are used during search. + /// /// [JsonInclude, JsonPropertyName("indices_options")] public Elastic.Clients.Elasticsearch.IndicesOptions? IndicesOptions { get; set; } @@ -308,44 +406,76 @@ public UpdateDatafeedRequest() public Elastic.Clients.Elasticsearch.Id? JobId { get; set; } /// - /// If a real-time datafeed has never seen any data (including during any initial training period), it automatically
stops and closes the associated job after this many real-time searches return no documents. In other words,
it stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no
end time that sees no data remains started until it is explicitly stopped. By default, it is not set. + /// + /// If a real-time datafeed has never seen any data (including during any initial training period), it automatically + /// stops and closes the associated job after this many real-time searches return no documents. In other words, + /// it stops after frequency times max_empty_searches of real-time operation. If not set, a datafeed with no + /// end time that sees no data remains started until it is explicitly stopped. By default, it is not set. + /// /// [JsonInclude, JsonPropertyName("max_empty_searches")] public int? MaxEmptySearches { get; set; } /// - /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an
Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this
object is passed verbatim to Elasticsearch. Note that if you change the query, the analyzed data is also
changed. Therefore, the time required to learn might be long and the understandability of the results is
unpredictable. If you want to make significant changes to the source data, it is recommended that you
clone the job and datafeed and make the amendments in the clone. Let both run in parallel and close one
when you are satisfied with the results of the job. + /// + /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an + /// Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this + /// object is passed verbatim to Elasticsearch. Note that if you change the query, the analyzed data is also + /// changed. Therefore, the time required to learn might be long and the understandability of the results is + /// unpredictable. If you want to make significant changes to the source data, it is recommended that you + /// clone the job and datafeed and make the amendments in the clone. Let both run in parallel and close one + /// when you are satisfied with the results of the job. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Query { get; set; } /// - /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might
not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default
value is randomly selected between `60s` and `120s`. This randomness improves the query performance
when there are multiple jobs running on the same node. + /// + /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might + /// not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default + /// value is randomly selected between 60s and 120s. This randomness improves the query performance + /// when there are multiple jobs running on the same node. + /// /// [JsonInclude, JsonPropertyName("query_delay")] public Elastic.Clients.Elasticsearch.Duration? QueryDelay { get; set; } /// - /// Specifies runtime fields for the datafeed search. + /// + /// Specifies runtime fields for the datafeed search. + /// /// [JsonInclude, JsonPropertyName("runtime_mappings")] public IDictionary? RuntimeMappings { get; set; } /// - /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed.
The detector configuration objects in a job can contain functions that use these script fields. + /// + /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. + /// The detector configuration objects in a job can contain functions that use these script fields. + /// /// [JsonInclude, JsonPropertyName("script_fields")] public IDictionary? ScriptFields { get; set; } /// - /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations.
The maximum value is the value of `index.max_result_window`. + /// + /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. + /// The maximum value is the value of index.max_result_window. + /// /// [JsonInclude, JsonPropertyName("scroll_size")] public int? ScrollSize { get; set; } } /// -/// Updates the properties of a datafeed.
You must stop and start the datafeed for the changes to be applied.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at
the time of the update and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead. +/// +/// Updates the properties of a datafeed. +/// You must stop and start the datafeed for the changes to be applied. +/// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at +/// the time of the update and runs the query using those same roles. If you provide secondary authorization headers, +/// those credentials are used instead. +/// /// public sealed partial class UpdateDatafeedRequestDescriptor : RequestDescriptor, UpdateDatafeedRequestParameters> { @@ -396,7 +526,10 @@ public UpdateDatafeedRequestDescriptor DatafeedId(Elastic.Clients.Ela private int? ScrollSizeValue { get; set; } /// - /// If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only
with low cardinality data. + /// + /// If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only + /// with low cardinality data. + /// /// public UpdateDatafeedRequestDescriptor Aggregations(Func>, FluentDescriptorDictionary>> selector) { @@ -405,7 +538,11 @@ public UpdateDatafeedRequestDescriptor Aggregations(Func - /// Datafeeds might search over long time periods, for several months or years. This search is split into time
chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of
these time chunks are calculated; it is an advanced configuration option. + /// + /// Datafeeds might search over long time periods, for several months or years. This search is split into time + /// chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of + /// these time chunks are calculated; it is an advanced configuration option. + /// /// public UpdateDatafeedRequestDescriptor ChunkingConfig(Elastic.Clients.Elasticsearch.MachineLearning.ChunkingConfig? chunkingConfig) { @@ -432,7 +569,13 @@ public UpdateDatafeedRequestDescriptor ChunkingConfig(Action - /// Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally
search over indices that have already been read in an effort to determine whether any data has subsequently been
added to the index. If missing data is found, it is a good indication that the `query_delay` is set too low and
the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time
datafeeds. + /// + /// Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally + /// search over indices that have already been read in an effort to determine whether any data has subsequently been + /// added to the index. If missing data is found, it is a good indication that the query_delay is set too low and + /// the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time + /// datafeeds. + /// /// public UpdateDatafeedRequestDescriptor DelayedDataCheckConfig(Elastic.Clients.Elasticsearch.MachineLearning.DelayedDataCheckConfig? delayedDataCheckConfig) { @@ -459,7 +602,13 @@ public UpdateDatafeedRequestDescriptor DelayedDataCheckConfig(Action< } /// - /// The interval at which scheduled queries are made while the datafeed runs in real time. The default value is
either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket
span. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are
written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value
must be divisible by the interval of the date histogram aggregation. + /// + /// The interval at which scheduled queries are made while the datafeed runs in real time. The default value is + /// either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket + /// span. When frequency is shorter than the bucket span, interim results for the last (partial) bucket are + /// written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value + /// must be divisible by the interval of the date histogram aggregation. + /// /// public UpdateDatafeedRequestDescriptor Frequency(Elastic.Clients.Elasticsearch.Duration? frequency) { @@ -468,7 +617,10 @@ public UpdateDatafeedRequestDescriptor Frequency(Elastic.Clients.Elas } /// - /// An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine
learning nodes must have the `remote_cluster_client` role. + /// + /// An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine + /// learning nodes must have the remote_cluster_client role. + /// /// public UpdateDatafeedRequestDescriptor Indices(ICollection? indices) { @@ -477,7 +629,9 @@ public UpdateDatafeedRequestDescriptor Indices(ICollection? i } /// - /// Specifies index expansion options that are used during search. + /// + /// Specifies index expansion options that are used during search. + /// /// public UpdateDatafeedRequestDescriptor IndicesOptions(Elastic.Clients.Elasticsearch.IndicesOptions? indicesOptions) { @@ -510,7 +664,12 @@ public UpdateDatafeedRequestDescriptor JobId(Elastic.Clients.Elastics } /// - /// If a real-time datafeed has never seen any data (including during any initial training period), it automatically
stops and closes the associated job after this many real-time searches return no documents. In other words,
it stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no
end time that sees no data remains started until it is explicitly stopped. By default, it is not set. + /// + /// If a real-time datafeed has never seen any data (including during any initial training period), it automatically + /// stops and closes the associated job after this many real-time searches return no documents. In other words, + /// it stops after frequency times max_empty_searches of real-time operation. If not set, a datafeed with no + /// end time that sees no data remains started until it is explicitly stopped. By default, it is not set. + /// /// public UpdateDatafeedRequestDescriptor MaxEmptySearches(int? maxEmptySearches) { @@ -519,7 +678,15 @@ public UpdateDatafeedRequestDescriptor MaxEmptySearches(int? maxEmpty } /// - /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an
Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this
object is passed verbatim to Elasticsearch. Note that if you change the query, the analyzed data is also
changed. Therefore, the time required to learn might be long and the understandability of the results is
unpredictable. If you want to make significant changes to the source data, it is recommended that you
clone the job and datafeed and make the amendments in the clone. Let both run in parallel and close one
when you are satisfied with the results of the job. + /// + /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an + /// Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this + /// object is passed verbatim to Elasticsearch. Note that if you change the query, the analyzed data is also + /// changed. Therefore, the time required to learn might be long and the understandability of the results is + /// unpredictable. If you want to make significant changes to the source data, it is recommended that you + /// clone the job and datafeed and make the amendments in the clone. Let both run in parallel and close one + /// when you are satisfied with the results of the job. + /// /// public UpdateDatafeedRequestDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -546,7 +713,12 @@ public UpdateDatafeedRequestDescriptor Query(Action - /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might
not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default
value is randomly selected between `60s` and `120s`. This randomness improves the query performance
when there are multiple jobs running on the same node. + /// + /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might + /// not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default + /// value is randomly selected between 60s and 120s. This randomness improves the query performance + /// when there are multiple jobs running on the same node. + /// /// public UpdateDatafeedRequestDescriptor QueryDelay(Elastic.Clients.Elasticsearch.Duration? queryDelay) { @@ -555,7 +727,9 @@ public UpdateDatafeedRequestDescriptor QueryDelay(Elastic.Clients.Ela } /// - /// Specifies runtime fields for the datafeed search. + /// + /// Specifies runtime fields for the datafeed search. + /// /// public UpdateDatafeedRequestDescriptor RuntimeMappings(Func>, FluentDescriptorDictionary>> selector) { @@ -564,7 +738,10 @@ public UpdateDatafeedRequestDescriptor RuntimeMappings(Func - /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed.
The detector configuration objects in a job can contain functions that use these script fields. + /// + /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. + /// The detector configuration objects in a job can contain functions that use these script fields. + /// /// public UpdateDatafeedRequestDescriptor ScriptFields(Func, FluentDescriptorDictionary> selector) { @@ -573,7 +750,10 @@ public UpdateDatafeedRequestDescriptor ScriptFields(Func - /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations.
The maximum value is the value of `index.max_result_window`. + /// + /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. + /// The maximum value is the value of index.max_result_window. + /// /// public UpdateDatafeedRequestDescriptor ScrollSize(int? scrollSize) { @@ -707,7 +887,13 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Updates the properties of a datafeed.
You must stop and start the datafeed for the changes to be applied.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at
the time of the update and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead. +/// +/// Updates the properties of a datafeed. +/// You must stop and start the datafeed for the changes to be applied. +/// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at +/// the time of the update and runs the query using those same roles. If you provide secondary authorization headers, +/// those credentials are used instead. +/// /// public sealed partial class UpdateDatafeedRequestDescriptor : RequestDescriptor { @@ -758,7 +944,10 @@ public UpdateDatafeedRequestDescriptor DatafeedId(Elastic.Clients.Elasticsearch. private int? ScrollSizeValue { get; set; } /// - /// If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only
with low cardinality data. + /// + /// If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only + /// with low cardinality data. + /// /// public UpdateDatafeedRequestDescriptor Aggregations(Func, FluentDescriptorDictionary> selector) { @@ -767,7 +956,11 @@ public UpdateDatafeedRequestDescriptor Aggregations(Func - /// Datafeeds might search over long time periods, for several months or years. This search is split into time
chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of
these time chunks are calculated; it is an advanced configuration option. + /// + /// Datafeeds might search over long time periods, for several months or years. This search is split into time + /// chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of + /// these time chunks are calculated; it is an advanced configuration option. + /// /// public UpdateDatafeedRequestDescriptor ChunkingConfig(Elastic.Clients.Elasticsearch.MachineLearning.ChunkingConfig? chunkingConfig) { @@ -794,7 +987,13 @@ public UpdateDatafeedRequestDescriptor ChunkingConfig(Action - /// Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally
search over indices that have already been read in an effort to determine whether any data has subsequently been
added to the index. If missing data is found, it is a good indication that the `query_delay` is set too low and
the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time
datafeeds. + /// + /// Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally + /// search over indices that have already been read in an effort to determine whether any data has subsequently been + /// added to the index. If missing data is found, it is a good indication that the query_delay is set too low and + /// the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time + /// datafeeds. + /// /// public UpdateDatafeedRequestDescriptor DelayedDataCheckConfig(Elastic.Clients.Elasticsearch.MachineLearning.DelayedDataCheckConfig? delayedDataCheckConfig) { @@ -821,7 +1020,13 @@ public UpdateDatafeedRequestDescriptor DelayedDataCheckConfig(Action - /// The interval at which scheduled queries are made while the datafeed runs in real time. The default value is
either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket
span. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are
written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value
must be divisible by the interval of the date histogram aggregation. + /// + /// The interval at which scheduled queries are made while the datafeed runs in real time. The default value is + /// either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket + /// span. When frequency is shorter than the bucket span, interim results for the last (partial) bucket are + /// written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value + /// must be divisible by the interval of the date histogram aggregation. + /// /// public UpdateDatafeedRequestDescriptor Frequency(Elastic.Clients.Elasticsearch.Duration? frequency) { @@ -830,7 +1035,10 @@ public UpdateDatafeedRequestDescriptor Frequency(Elastic.Clients.Elasticsearch.D } /// - /// An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine
learning nodes must have the `remote_cluster_client` role. + /// + /// An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine + /// learning nodes must have the remote_cluster_client role. + /// /// public UpdateDatafeedRequestDescriptor Indices(ICollection? indices) { @@ -839,7 +1047,9 @@ public UpdateDatafeedRequestDescriptor Indices(ICollection? indices) } /// - /// Specifies index expansion options that are used during search. + /// + /// Specifies index expansion options that are used during search. + /// /// public UpdateDatafeedRequestDescriptor IndicesOptions(Elastic.Clients.Elasticsearch.IndicesOptions? indicesOptions) { @@ -872,7 +1082,12 @@ public UpdateDatafeedRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Id? j } /// - /// If a real-time datafeed has never seen any data (including during any initial training period), it automatically
stops and closes the associated job after this many real-time searches return no documents. In other words,
it stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no
end time that sees no data remains started until it is explicitly stopped. By default, it is not set. + /// + /// If a real-time datafeed has never seen any data (including during any initial training period), it automatically + /// stops and closes the associated job after this many real-time searches return no documents. In other words, + /// it stops after frequency times max_empty_searches of real-time operation. If not set, a datafeed with no + /// end time that sees no data remains started until it is explicitly stopped. By default, it is not set. + /// /// public UpdateDatafeedRequestDescriptor MaxEmptySearches(int? maxEmptySearches) { @@ -881,7 +1096,15 @@ public UpdateDatafeedRequestDescriptor MaxEmptySearches(int? maxEmptySearches) } /// - /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an
Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this
object is passed verbatim to Elasticsearch. Note that if you change the query, the analyzed data is also
changed. Therefore, the time required to learn might be long and the understandability of the results is
unpredictable. If you want to make significant changes to the source data, it is recommended that you
clone the job and datafeed and make the amendments in the clone. Let both run in parallel and close one
when you are satisfied with the results of the job. + /// + /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an + /// Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this + /// object is passed verbatim to Elasticsearch. Note that if you change the query, the analyzed data is also + /// changed. Therefore, the time required to learn might be long and the understandability of the results is + /// unpredictable. If you want to make significant changes to the source data, it is recommended that you + /// clone the job and datafeed and make the amendments in the clone. Let both run in parallel and close one + /// when you are satisfied with the results of the job. + /// /// public UpdateDatafeedRequestDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -908,7 +1131,12 @@ public UpdateDatafeedRequestDescriptor Query(Action - /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might
not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default
value is randomly selected between `60s` and `120s`. This randomness improves the query performance
when there are multiple jobs running on the same node. + /// + /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might + /// not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default + /// value is randomly selected between 60s and 120s. This randomness improves the query performance + /// when there are multiple jobs running on the same node. + /// /// public UpdateDatafeedRequestDescriptor QueryDelay(Elastic.Clients.Elasticsearch.Duration? queryDelay) { @@ -917,7 +1145,9 @@ public UpdateDatafeedRequestDescriptor QueryDelay(Elastic.Clients.Elasticsearch. } /// - /// Specifies runtime fields for the datafeed search. + /// + /// Specifies runtime fields for the datafeed search. + /// /// public UpdateDatafeedRequestDescriptor RuntimeMappings(Func, FluentDescriptorDictionary> selector) { @@ -926,7 +1156,10 @@ public UpdateDatafeedRequestDescriptor RuntimeMappings(Func - /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed.
The detector configuration objects in a job can contain functions that use these script fields. + /// + /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. + /// The detector configuration objects in a job can contain functions that use these script fields. + /// /// public UpdateDatafeedRequestDescriptor ScriptFields(Func, FluentDescriptorDictionary> selector) { @@ -935,7 +1168,10 @@ public UpdateDatafeedRequestDescriptor ScriptFields(Func - /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations.
The maximum value is the value of `index.max_result_window`. + /// + /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. + /// The maximum value is the value of index.max_result_window. + /// /// public UpdateDatafeedRequestDescriptor ScrollSize(int? scrollSize) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpdateFilterRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpdateFilterRequest.g.cs index 60f988ecd8e..148f677c166 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpdateFilterRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpdateFilterRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class UpdateFilterRequestParameters : RequestParameters } /// -/// Updates the description of a filter, adds items, or removes items from the list. +/// +/// Updates the description of a filter, adds items, or removes items from the list. +/// /// public sealed partial class UpdateFilterRequest : PlainRequest { @@ -51,26 +53,34 @@ public UpdateFilterRequest(Elastic.Clients.Elasticsearch.Id filterId) : base(r = internal override string OperationName => "ml.update_filter"; /// - /// The items to add to the filter. + /// + /// The items to add to the filter. + /// /// [JsonInclude, JsonPropertyName("add_items")] public ICollection? AddItems { get; set; } /// - /// A description for the filter. + /// + /// A description for the filter. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The items to remove from the filter. + /// + /// The items to remove from the filter. + /// /// [JsonInclude, JsonPropertyName("remove_items")] public ICollection? RemoveItems { get; set; } } /// -/// Updates the description of a filter, adds items, or removes items from the list. +/// +/// Updates the description of a filter, adds items, or removes items from the list. +/// /// public sealed partial class UpdateFilterRequestDescriptor : RequestDescriptor { @@ -99,7 +109,9 @@ public UpdateFilterRequestDescriptor FilterId(Elastic.Clients.Elasticsearch.Id f private ICollection? RemoveItemsValue { get; set; } /// - /// The items to add to the filter. + /// + /// The items to add to the filter. + /// /// public UpdateFilterRequestDescriptor AddItems(ICollection? addItems) { @@ -108,7 +120,9 @@ public UpdateFilterRequestDescriptor AddItems(ICollection? addItems) } /// - /// A description for the filter. + /// + /// A description for the filter. + /// /// public UpdateFilterRequestDescriptor Description(string? description) { @@ -117,7 +131,9 @@ public UpdateFilterRequestDescriptor Description(string? description) } /// - /// The items to remove from the filter. + /// + /// The items to remove from the filter. + /// /// public UpdateFilterRequestDescriptor RemoveItems(ICollection? removeItems) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpdateJobRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpdateJobRequest.g.cs index ac17cc4be02..5302b7bb992 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpdateJobRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpdateJobRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class UpdateJobRequestParameters : RequestParameters } /// -/// Updates certain properties of an anomaly detection job. +/// +/// Updates certain properties of an anomaly detection job. +/// /// public sealed partial class UpdateJobRequest : PlainRequest { @@ -51,7 +53,17 @@ public UpdateJobRequest(Elastic.Clients.Elasticsearch.Id jobId) : base(r => r.Re internal override string OperationName => "ml.update_job"; /// - /// Advanced configuration option. Specifies whether this job can open when
there is insufficient machine learning node capacity for it to be
immediately assigned to a node. If `false` and a machine learning node
with capacity to run the job cannot immediately be found, the open
anomaly detection jobs API returns an error. However, this is also
subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this
option is set to `true`, the open anomaly detection jobs API does not
return an error and the job waits in the opening state until sufficient
machine learning node capacity is available. + /// + /// Advanced configuration option. Specifies whether this job can open when + /// there is insufficient machine learning node capacity for it to be + /// immediately assigned to a node. If false and a machine learning node + /// with capacity to run the job cannot immediately be found, the open + /// anomaly detection jobs API returns an error. However, this is also + /// subject to the cluster-wide xpack.ml.max_lazy_ml_nodes setting. If this + /// option is set to true, the open anomaly detection jobs API does not + /// return an error and the job waits in the opening state until sufficient + /// machine learning node capacity is available. + /// /// [JsonInclude, JsonPropertyName("allow_lazy_open")] public bool? AllowLazyOpen { get; set; } @@ -59,7 +71,18 @@ public UpdateJobRequest(Elastic.Clients.Elasticsearch.Id jobId) : base(r => r.Re public Elastic.Clients.Elasticsearch.MachineLearning.AnalysisMemoryLimit? AnalysisLimits { get; set; } /// - /// Advanced configuration option. The time between each periodic persistence
of the model.
The default value is a randomized value between 3 to 4 hours, which
avoids all jobs persisting at exactly the same time. The smallest allowed
value is 1 hour.
For very large models (several GB), persistence could take 10-20 minutes,
so do not set the value too low.
If the job is open when you make the update, you must stop the datafeed,
close the job, then reopen the job and restart the datafeed for the
changes to take effect. + /// + /// Advanced configuration option. The time between each periodic persistence + /// of the model. + /// The default value is a randomized value between 3 to 4 hours, which + /// avoids all jobs persisting at exactly the same time. The smallest allowed + /// value is 1 hour. + /// For very large models (several GB), persistence could take 10-20 minutes, + /// so do not set the value too low. + /// If the job is open when you make the update, you must stop the datafeed, + /// close the job, then reopen the job and restart the datafeed for the + /// changes to take effect. + /// /// [JsonInclude, JsonPropertyName("background_persist_interval")] public Elastic.Clients.Elasticsearch.Duration? BackgroundPersistInterval { get; set; } @@ -67,31 +90,49 @@ public UpdateJobRequest(Elastic.Clients.Elasticsearch.Id jobId) : base(r => r.Re public ICollection? CategorizationFilters { get; set; } /// - /// Advanced configuration option. Contains custom meta data about the job.
For example, it can contain custom URL information as shown in Adding
custom URLs to machine learning results. + /// + /// Advanced configuration option. Contains custom meta data about the job. + /// For example, it can contain custom URL information as shown in Adding + /// custom URLs to machine learning results. + /// /// [JsonInclude, JsonPropertyName("custom_settings")] public IDictionary? CustomSettings { get; set; } /// - /// Advanced configuration option, which affects the automatic removal of old
model snapshots for this job. It specifies a period of time (in days)
after which only the first snapshot per day is retained. This period is
relative to the timestamp of the most recent snapshot for this job. Valid
values range from 0 to `model_snapshot_retention_days`. For jobs created
before version 7.8.0, the default value matches
`model_snapshot_retention_days`. + /// + /// Advanced configuration option, which affects the automatic removal of old + /// model snapshots for this job. It specifies a period of time (in days) + /// after which only the first snapshot per day is retained. This period is + /// relative to the timestamp of the most recent snapshot for this job. Valid + /// values range from 0 to model_snapshot_retention_days. For jobs created + /// before version 7.8.0, the default value matches + /// model_snapshot_retention_days. + /// /// [JsonInclude, JsonPropertyName("daily_model_snapshot_retention_after_days")] public long? DailyModelSnapshotRetentionAfterDays { get; set; } /// - /// A description of the job. + /// + /// A description of the job. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// An array of detector update objects. + /// + /// An array of detector update objects. + /// /// [JsonInclude, JsonPropertyName("detectors")] public ICollection? Detectors { get; set; } /// - /// A list of job groups. A job can belong to no groups or many. + /// + /// A list of job groups. A job can belong to no groups or many. + /// /// [JsonInclude, JsonPropertyName("groups")] public ICollection? Groups { get; set; } @@ -101,32 +142,51 @@ public UpdateJobRequest(Elastic.Clients.Elasticsearch.Id jobId) : base(r => r.Re public Elastic.Clients.Elasticsearch.Duration? ModelPruneWindow { get; set; } /// - /// Advanced configuration option, which affects the automatic removal of old
model snapshots for this job. It specifies the maximum period of time (in
days) that snapshots are retained. This period is relative to the
timestamp of the most recent snapshot for this job. + /// + /// Advanced configuration option, which affects the automatic removal of old + /// model snapshots for this job. It specifies the maximum period of time (in + /// days) that snapshots are retained. This period is relative to the + /// timestamp of the most recent snapshot for this job. + /// /// [JsonInclude, JsonPropertyName("model_snapshot_retention_days")] public long? ModelSnapshotRetentionDays { get; set; } /// - /// Settings related to how categorization interacts with partition fields. + /// + /// Settings related to how categorization interacts with partition fields. + /// /// [JsonInclude, JsonPropertyName("per_partition_categorization")] public Elastic.Clients.Elasticsearch.MachineLearning.PerPartitionCategorization? PerPartitionCategorization { get; set; } /// - /// Advanced configuration option. The period over which adjustments to the
score are applied, as new data is seen. + /// + /// Advanced configuration option. The period over which adjustments to the + /// score are applied, as new data is seen. + /// /// [JsonInclude, JsonPropertyName("renormalization_window_days")] public long? RenormalizationWindowDays { get; set; } /// - /// Advanced configuration option. The period of time (in days) that results
are retained. Age is calculated relative to the timestamp of the latest
bucket result. If this property has a non-null value, once per day at
00:30 (server time), results that are the specified number of days older
than the latest bucket result are deleted from Elasticsearch. The default
value is null, which means all results are retained. + /// + /// Advanced configuration option. The period of time (in days) that results + /// are retained. Age is calculated relative to the timestamp of the latest + /// bucket result. If this property has a non-null value, once per day at + /// 00:30 (server time), results that are the specified number of days older + /// than the latest bucket result are deleted from Elasticsearch. The default + /// value is null, which means all results are retained. + /// /// [JsonInclude, JsonPropertyName("results_retention_days")] public long? ResultsRetentionDays { get; set; } } /// -/// Updates certain properties of an anomaly detection job. +/// +/// Updates certain properties of an anomaly detection job. +/// /// public sealed partial class UpdateJobRequestDescriptor : RequestDescriptor, UpdateJobRequestParameters> { @@ -176,7 +236,17 @@ public UpdateJobRequestDescriptor JobId(Elastic.Clients.Elasticsearch private long? ResultsRetentionDaysValue { get; set; } /// - /// Advanced configuration option. Specifies whether this job can open when
there is insufficient machine learning node capacity for it to be
immediately assigned to a node. If `false` and a machine learning node
with capacity to run the job cannot immediately be found, the open
anomaly detection jobs API returns an error. However, this is also
subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this
option is set to `true`, the open anomaly detection jobs API does not
return an error and the job waits in the opening state until sufficient
machine learning node capacity is available. + /// + /// Advanced configuration option. Specifies whether this job can open when + /// there is insufficient machine learning node capacity for it to be + /// immediately assigned to a node. If false and a machine learning node + /// with capacity to run the job cannot immediately be found, the open + /// anomaly detection jobs API returns an error. However, this is also + /// subject to the cluster-wide xpack.ml.max_lazy_ml_nodes setting. If this + /// option is set to true, the open anomaly detection jobs API does not + /// return an error and the job waits in the opening state until sufficient + /// machine learning node capacity is available. + /// /// public UpdateJobRequestDescriptor AllowLazyOpen(bool? allowLazyOpen = true) { @@ -209,7 +279,18 @@ public UpdateJobRequestDescriptor AnalysisLimits(Action - /// Advanced configuration option. The time between each periodic persistence
of the model.
The default value is a randomized value between 3 to 4 hours, which
avoids all jobs persisting at exactly the same time. The smallest allowed
value is 1 hour.
For very large models (several GB), persistence could take 10-20 minutes,
so do not set the value too low.
If the job is open when you make the update, you must stop the datafeed,
close the job, then reopen the job and restart the datafeed for the
changes to take effect. + /// + /// Advanced configuration option. The time between each periodic persistence + /// of the model. + /// The default value is a randomized value between 3 to 4 hours, which + /// avoids all jobs persisting at exactly the same time. The smallest allowed + /// value is 1 hour. + /// For very large models (several GB), persistence could take 10-20 minutes, + /// so do not set the value too low. + /// If the job is open when you make the update, you must stop the datafeed, + /// close the job, then reopen the job and restart the datafeed for the + /// changes to take effect. + /// /// public UpdateJobRequestDescriptor BackgroundPersistInterval(Elastic.Clients.Elasticsearch.Duration? backgroundPersistInterval) { @@ -224,7 +305,11 @@ public UpdateJobRequestDescriptor CategorizationFilters(ICollection - /// Advanced configuration option. Contains custom meta data about the job.
For example, it can contain custom URL information as shown in Adding
custom URLs to machine learning results. + /// + /// Advanced configuration option. Contains custom meta data about the job. + /// For example, it can contain custom URL information as shown in Adding + /// custom URLs to machine learning results. + /// /// public UpdateJobRequestDescriptor CustomSettings(Func, FluentDictionary> selector) { @@ -233,7 +318,15 @@ public UpdateJobRequestDescriptor CustomSettings(Func - /// Advanced configuration option, which affects the automatic removal of old
model snapshots for this job. It specifies a period of time (in days)
after which only the first snapshot per day is retained. This period is
relative to the timestamp of the most recent snapshot for this job. Valid
values range from 0 to `model_snapshot_retention_days`. For jobs created
before version 7.8.0, the default value matches
`model_snapshot_retention_days`. + /// + /// Advanced configuration option, which affects the automatic removal of old + /// model snapshots for this job. It specifies a period of time (in days) + /// after which only the first snapshot per day is retained. This period is + /// relative to the timestamp of the most recent snapshot for this job. Valid + /// values range from 0 to model_snapshot_retention_days. For jobs created + /// before version 7.8.0, the default value matches + /// model_snapshot_retention_days. + /// /// public UpdateJobRequestDescriptor DailyModelSnapshotRetentionAfterDays(long? dailyModelSnapshotRetentionAfterDays) { @@ -242,7 +335,9 @@ public UpdateJobRequestDescriptor DailyModelSnapshotRetentionAfterDay } /// - /// A description of the job. + /// + /// A description of the job. + /// /// public UpdateJobRequestDescriptor Description(string? description) { @@ -251,7 +346,9 @@ public UpdateJobRequestDescriptor Description(string? description) } /// - /// An array of detector update objects. + /// + /// An array of detector update objects. + /// /// public UpdateJobRequestDescriptor Detectors(ICollection? detectors) { @@ -290,7 +387,9 @@ public UpdateJobRequestDescriptor Detectors(params Action - /// A list of job groups. A job can belong to no groups or many. + /// + /// A list of job groups. A job can belong to no groups or many. + /// /// public UpdateJobRequestDescriptor Groups(ICollection? groups) { @@ -329,7 +428,12 @@ public UpdateJobRequestDescriptor ModelPruneWindow(Elastic.Clients.El } /// - /// Advanced configuration option, which affects the automatic removal of old
model snapshots for this job. It specifies the maximum period of time (in
days) that snapshots are retained. This period is relative to the
timestamp of the most recent snapshot for this job. + /// + /// Advanced configuration option, which affects the automatic removal of old + /// model snapshots for this job. It specifies the maximum period of time (in + /// days) that snapshots are retained. This period is relative to the + /// timestamp of the most recent snapshot for this job. + /// /// public UpdateJobRequestDescriptor ModelSnapshotRetentionDays(long? modelSnapshotRetentionDays) { @@ -338,7 +442,9 @@ public UpdateJobRequestDescriptor ModelSnapshotRetentionDays(long? mo } /// - /// Settings related to how categorization interacts with partition fields. + /// + /// Settings related to how categorization interacts with partition fields. + /// /// public UpdateJobRequestDescriptor PerPartitionCategorization(Elastic.Clients.Elasticsearch.MachineLearning.PerPartitionCategorization? perPartitionCategorization) { @@ -365,7 +471,10 @@ public UpdateJobRequestDescriptor PerPartitionCategorization(Action - /// Advanced configuration option. The period over which adjustments to the
score are applied, as new data is seen. + /// + /// Advanced configuration option. The period over which adjustments to the + /// score are applied, as new data is seen. + /// /// public UpdateJobRequestDescriptor RenormalizationWindowDays(long? renormalizationWindowDays) { @@ -374,7 +483,14 @@ public UpdateJobRequestDescriptor RenormalizationWindowDays(long? ren } /// - /// Advanced configuration option. The period of time (in days) that results
are retained. Age is calculated relative to the timestamp of the latest
bucket result. If this property has a non-null value, once per day at
00:30 (server time), results that are the specified number of days older
than the latest bucket result are deleted from Elasticsearch. The default
value is null, which means all results are retained. + /// + /// Advanced configuration option. The period of time (in days) that results + /// are retained. Age is calculated relative to the timestamp of the latest + /// bucket result. If this property has a non-null value, once per day at + /// 00:30 (server time), results that are the specified number of days older + /// than the latest bucket result are deleted from Elasticsearch. The default + /// value is null, which means all results are retained. + /// /// public UpdateJobRequestDescriptor ResultsRetentionDays(long? resultsRetentionDays) { @@ -535,7 +651,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Updates certain properties of an anomaly detection job. +/// +/// Updates certain properties of an anomaly detection job. +/// /// public sealed partial class UpdateJobRequestDescriptor : RequestDescriptor { @@ -585,7 +703,17 @@ public UpdateJobRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Id jobId) private long? ResultsRetentionDaysValue { get; set; } /// - /// Advanced configuration option. Specifies whether this job can open when
there is insufficient machine learning node capacity for it to be
immediately assigned to a node. If `false` and a machine learning node
with capacity to run the job cannot immediately be found, the open
anomaly detection jobs API returns an error. However, this is also
subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this
option is set to `true`, the open anomaly detection jobs API does not
return an error and the job waits in the opening state until sufficient
machine learning node capacity is available. + /// + /// Advanced configuration option. Specifies whether this job can open when + /// there is insufficient machine learning node capacity for it to be + /// immediately assigned to a node. If false and a machine learning node + /// with capacity to run the job cannot immediately be found, the open + /// anomaly detection jobs API returns an error. However, this is also + /// subject to the cluster-wide xpack.ml.max_lazy_ml_nodes setting. If this + /// option is set to true, the open anomaly detection jobs API does not + /// return an error and the job waits in the opening state until sufficient + /// machine learning node capacity is available. + /// /// public UpdateJobRequestDescriptor AllowLazyOpen(bool? allowLazyOpen = true) { @@ -618,7 +746,18 @@ public UpdateJobRequestDescriptor AnalysisLimits(Action - /// Advanced configuration option. The time between each periodic persistence
of the model.
The default value is a randomized value between 3 to 4 hours, which
avoids all jobs persisting at exactly the same time. The smallest allowed
value is 1 hour.
For very large models (several GB), persistence could take 10-20 minutes,
so do not set the value too low.
If the job is open when you make the update, you must stop the datafeed,
close the job, then reopen the job and restart the datafeed for the
changes to take effect. + /// + /// Advanced configuration option. The time between each periodic persistence + /// of the model. + /// The default value is a randomized value between 3 to 4 hours, which + /// avoids all jobs persisting at exactly the same time. The smallest allowed + /// value is 1 hour. + /// For very large models (several GB), persistence could take 10-20 minutes, + /// so do not set the value too low. + /// If the job is open when you make the update, you must stop the datafeed, + /// close the job, then reopen the job and restart the datafeed for the + /// changes to take effect. + /// /// public UpdateJobRequestDescriptor BackgroundPersistInterval(Elastic.Clients.Elasticsearch.Duration? backgroundPersistInterval) { @@ -633,7 +772,11 @@ public UpdateJobRequestDescriptor CategorizationFilters(ICollection? cat } /// - /// Advanced configuration option. Contains custom meta data about the job.
For example, it can contain custom URL information as shown in Adding
custom URLs to machine learning results. + /// + /// Advanced configuration option. Contains custom meta data about the job. + /// For example, it can contain custom URL information as shown in Adding + /// custom URLs to machine learning results. + /// /// public UpdateJobRequestDescriptor CustomSettings(Func, FluentDictionary> selector) { @@ -642,7 +785,15 @@ public UpdateJobRequestDescriptor CustomSettings(Func - /// Advanced configuration option, which affects the automatic removal of old
model snapshots for this job. It specifies a period of time (in days)
after which only the first snapshot per day is retained. This period is
relative to the timestamp of the most recent snapshot for this job. Valid
values range from 0 to `model_snapshot_retention_days`. For jobs created
before version 7.8.0, the default value matches
`model_snapshot_retention_days`. + /// + /// Advanced configuration option, which affects the automatic removal of old + /// model snapshots for this job. It specifies a period of time (in days) + /// after which only the first snapshot per day is retained. This period is + /// relative to the timestamp of the most recent snapshot for this job. Valid + /// values range from 0 to model_snapshot_retention_days. For jobs created + /// before version 7.8.0, the default value matches + /// model_snapshot_retention_days. + /// /// public UpdateJobRequestDescriptor DailyModelSnapshotRetentionAfterDays(long? dailyModelSnapshotRetentionAfterDays) { @@ -651,7 +802,9 @@ public UpdateJobRequestDescriptor DailyModelSnapshotRetentionAfterDays(long? dai } /// - /// A description of the job. + /// + /// A description of the job. + /// /// public UpdateJobRequestDescriptor Description(string? description) { @@ -660,7 +813,9 @@ public UpdateJobRequestDescriptor Description(string? description) } /// - /// An array of detector update objects. + /// + /// An array of detector update objects. + /// /// public UpdateJobRequestDescriptor Detectors(ICollection? detectors) { @@ -699,7 +854,9 @@ public UpdateJobRequestDescriptor Detectors(params Action - /// A list of job groups. A job can belong to no groups or many. + /// + /// A list of job groups. A job can belong to no groups or many. + /// /// public UpdateJobRequestDescriptor Groups(ICollection? groups) { @@ -738,7 +895,12 @@ public UpdateJobRequestDescriptor ModelPruneWindow(Elastic.Clients.Elasticsearch } /// - /// Advanced configuration option, which affects the automatic removal of old
model snapshots for this job. It specifies the maximum period of time (in
days) that snapshots are retained. This period is relative to the
timestamp of the most recent snapshot for this job. + /// + /// Advanced configuration option, which affects the automatic removal of old + /// model snapshots for this job. It specifies the maximum period of time (in + /// days) that snapshots are retained. This period is relative to the + /// timestamp of the most recent snapshot for this job. + /// /// public UpdateJobRequestDescriptor ModelSnapshotRetentionDays(long? modelSnapshotRetentionDays) { @@ -747,7 +909,9 @@ public UpdateJobRequestDescriptor ModelSnapshotRetentionDays(long? modelSnapshot } /// - /// Settings related to how categorization interacts with partition fields. + /// + /// Settings related to how categorization interacts with partition fields. + /// /// public UpdateJobRequestDescriptor PerPartitionCategorization(Elastic.Clients.Elasticsearch.MachineLearning.PerPartitionCategorization? perPartitionCategorization) { @@ -774,7 +938,10 @@ public UpdateJobRequestDescriptor PerPartitionCategorization(Action - /// Advanced configuration option. The period over which adjustments to the
score are applied, as new data is seen. + /// + /// Advanced configuration option. The period over which adjustments to the + /// score are applied, as new data is seen. + /// /// public UpdateJobRequestDescriptor RenormalizationWindowDays(long? renormalizationWindowDays) { @@ -783,7 +950,14 @@ public UpdateJobRequestDescriptor RenormalizationWindowDays(long? renormalizatio } /// - /// Advanced configuration option. The period of time (in days) that results
are retained. Age is calculated relative to the timestamp of the latest
bucket result. If this property has a non-null value, once per day at
00:30 (server time), results that are the specified number of days older
than the latest bucket result are deleted from Elasticsearch. The default
value is null, which means all results are retained. + /// + /// Advanced configuration option. The period of time (in days) that results + /// are retained. Age is calculated relative to the timestamp of the latest + /// bucket result. If this property has a non-null value, once per day at + /// 00:30 (server time), results that are the specified number of days older + /// than the latest bucket result are deleted from Elasticsearch. The default + /// value is null, which means all results are retained. + /// /// public UpdateJobRequestDescriptor ResultsRetentionDays(long? resultsRetentionDays) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpdateModelSnapshotRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpdateModelSnapshotRequest.g.cs index f00d20aedc5..7f94d2c614a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpdateModelSnapshotRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpdateModelSnapshotRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class UpdateModelSnapshotRequestParameters : RequestParame } /// -/// Updates certain properties of a snapshot. +/// +/// Updates certain properties of a snapshot. +/// /// public sealed partial class UpdateModelSnapshotRequest : PlainRequest { @@ -51,20 +53,28 @@ public UpdateModelSnapshotRequest(Elastic.Clients.Elasticsearch.Id jobId, Elasti internal override string OperationName => "ml.update_model_snapshot"; /// - /// A description of the model snapshot. + /// + /// A description of the model snapshot. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// If `true`, this snapshot will not be deleted during automatic cleanup of
snapshots older than `model_snapshot_retention_days`. However, this
snapshot will be deleted when the job is deleted. + /// + /// If true, this snapshot will not be deleted during automatic cleanup of + /// snapshots older than model_snapshot_retention_days. However, this + /// snapshot will be deleted when the job is deleted. + /// /// [JsonInclude, JsonPropertyName("retain")] public bool? Retain { get; set; } } /// -/// Updates certain properties of a snapshot. +/// +/// Updates certain properties of a snapshot. +/// /// public sealed partial class UpdateModelSnapshotRequestDescriptor : RequestDescriptor { @@ -98,7 +108,9 @@ public UpdateModelSnapshotRequestDescriptor SnapshotId(Elastic.Clients.Elasticse private bool? RetainValue { get; set; } /// - /// A description of the model snapshot. + /// + /// A description of the model snapshot. + /// /// public UpdateModelSnapshotRequestDescriptor Description(string? description) { @@ -107,7 +119,11 @@ public UpdateModelSnapshotRequestDescriptor Description(string? description) } /// - /// If `true`, this snapshot will not be deleted during automatic cleanup of
snapshots older than `model_snapshot_retention_days`. However, this
snapshot will be deleted when the job is deleted. + /// + /// If true, this snapshot will not be deleted during automatic cleanup of + /// snapshots older than model_snapshot_retention_days. However, this + /// snapshot will be deleted when the job is deleted. + /// /// public UpdateModelSnapshotRequestDescriptor Retain(bool? retain = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpdateTrainedModelDeploymentRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpdateTrainedModelDeploymentRequest.g.cs index e2555c4430f..982c2cd9fc8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpdateTrainedModelDeploymentRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpdateTrainedModelDeploymentRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class UpdateTrainedModelDeploymentRequestParameters : Requ } /// -/// Starts a trained model deployment, which allocates the model to every machine learning node. +/// +/// Starts a trained model deployment, which allocates the model to every machine learning node. +/// /// public sealed partial class UpdateTrainedModelDeploymentRequest : PlainRequest { @@ -51,14 +53,23 @@ public UpdateTrainedModelDeploymentRequest(Elastic.Clients.Elasticsearch.Id mode internal override string OperationName => "ml.update_trained_model_deployment"; /// - /// The number of model allocations on each node where the model is deployed.
All allocations on a node share the same copy of the model in memory but use
a separate set of threads to evaluate the model.
Increasing this value generally increases the throughput.
If this setting is greater than the number of hardware threads
it will automatically be changed to a value less than the number of hardware threads. + /// + /// The number of model allocations on each node where the model is deployed. + /// All allocations on a node share the same copy of the model in memory but use + /// a separate set of threads to evaluate the model. + /// Increasing this value generally increases the throughput. + /// If this setting is greater than the number of hardware threads + /// it will automatically be changed to a value less than the number of hardware threads. + /// /// [JsonInclude, JsonPropertyName("number_of_allocations")] public int? NumberOfAllocations { get; set; } } /// -/// Starts a trained model deployment, which allocates the model to every machine learning node. +/// +/// Starts a trained model deployment, which allocates the model to every machine learning node. +/// /// public sealed partial class UpdateTrainedModelDeploymentRequestDescriptor : RequestDescriptor { @@ -85,7 +96,14 @@ public UpdateTrainedModelDeploymentRequestDescriptor ModelId(Elastic.Clients.Ela private int? NumberOfAllocationsValue { get; set; } /// - /// The number of model allocations on each node where the model is deployed.
All allocations on a node share the same copy of the model in memory but use
a separate set of threads to evaluate the model.
Increasing this value generally increases the throughput.
If this setting is greater than the number of hardware threads
it will automatically be changed to a value less than the number of hardware threads. + /// + /// The number of model allocations on each node where the model is deployed. + /// All allocations on a node share the same copy of the model in memory but use + /// a separate set of threads to evaluate the model. + /// Increasing this value generally increases the throughput. + /// If this setting is greater than the number of hardware threads + /// it will automatically be changed to a value less than the number of hardware threads. + /// /// public UpdateTrainedModelDeploymentRequestDescriptor NumberOfAllocations(int? numberOfAllocations) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpgradeJobSnapshotRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpgradeJobSnapshotRequest.g.cs index 2014df017fa..6b0349c7ffe 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpgradeJobSnapshotRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpgradeJobSnapshotRequest.g.cs @@ -32,18 +32,33 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class UpgradeJobSnapshotRequestParameters : RequestParameters { /// - /// Controls the time to wait for the request to complete. + /// + /// Controls the time to wait for the request to complete. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// When true, the API won’t respond until the upgrade is complete.
Otherwise, it responds as soon as the upgrade task is assigned to a node. + /// + /// When true, the API won’t respond until the upgrade is complete. + /// Otherwise, it responds as soon as the upgrade task is assigned to a node. + /// /// public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Upgrades an anomaly detection model snapshot to the latest major version.
Over time, older snapshot formats are deprecated and removed. Anomaly
detection jobs support only snapshots that are from the current or previous
major version.
This API provides a means to upgrade a snapshot to the current major version.
This aids in preparing the cluster for an upgrade to the next major version.
Only one snapshot per anomaly detection job can be upgraded at a time and the
upgraded snapshot cannot be the current snapshot of the anomaly detection
job. +/// +/// Upgrades an anomaly detection model snapshot to the latest major version. +/// Over time, older snapshot formats are deprecated and removed. Anomaly +/// detection jobs support only snapshots that are from the current or previous +/// major version. +/// This API provides a means to upgrade a snapshot to the current major version. +/// This aids in preparing the cluster for an upgrade to the next major version. +/// Only one snapshot per anomaly detection job can be upgraded at a time and the +/// upgraded snapshot cannot be the current snapshot of the anomaly detection +/// job. +/// /// public sealed partial class UpgradeJobSnapshotRequest : PlainRequest { @@ -60,20 +75,35 @@ public UpgradeJobSnapshotRequest(Elastic.Clients.Elasticsearch.Id jobId, Elastic internal override string OperationName => "ml.upgrade_job_snapshot"; /// - /// Controls the time to wait for the request to complete. + /// + /// Controls the time to wait for the request to complete. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// When true, the API won’t respond until the upgrade is complete.
Otherwise, it responds as soon as the upgrade task is assigned to a node. + /// + /// When true, the API won’t respond until the upgrade is complete. + /// Otherwise, it responds as soon as the upgrade task is assigned to a node. + /// /// [JsonIgnore] public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Upgrades an anomaly detection model snapshot to the latest major version.
Over time, older snapshot formats are deprecated and removed. Anomaly
detection jobs support only snapshots that are from the current or previous
major version.
This API provides a means to upgrade a snapshot to the current major version.
This aids in preparing the cluster for an upgrade to the next major version.
Only one snapshot per anomaly detection job can be upgraded at a time and the
upgraded snapshot cannot be the current snapshot of the anomaly detection
job. +/// +/// Upgrades an anomaly detection model snapshot to the latest major version. +/// Over time, older snapshot formats are deprecated and removed. Anomaly +/// detection jobs support only snapshots that are from the current or previous +/// major version. +/// This API provides a means to upgrade a snapshot to the current major version. +/// This aids in preparing the cluster for an upgrade to the next major version. +/// Only one snapshot per anomaly detection job can be upgraded at a time and the +/// upgraded snapshot cannot be the current snapshot of the anomaly detection +/// job. +/// /// public sealed partial class UpgradeJobSnapshotRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpgradeJobSnapshotResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpgradeJobSnapshotResponse.g.cs index 51315ffcabe..95e29dedea5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpgradeJobSnapshotResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpgradeJobSnapshotResponse.g.cs @@ -29,13 +29,17 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class UpgradeJobSnapshotResponse : ElasticsearchResponse { /// - /// When true, this means the task is complete. When false, it is still running. + /// + /// When true, this means the task is complete. When false, it is still running. + /// /// [JsonInclude, JsonPropertyName("completed")] public bool Completed { get; init; } /// - /// The ID of the node that the upgrade task was started on if it is still running. In serverless this will be the "serverless". + /// + /// The ID of the node that the upgrade task was started on if it is still running. In serverless this will be the "serverless". + /// /// [JsonInclude, JsonPropertyName("node")] public string Node { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ValidateDetectorRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ValidateDetectorRequest.g.cs index 6b6738b6e47..6e273c7a954 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ValidateDetectorRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ValidateDetectorRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class ValidateDetectorRequestParameters : RequestParameter } /// -/// Validates an anomaly detection detector. +/// +/// Validates an anomaly detection detector. +/// /// public sealed partial class ValidateDetectorRequest : PlainRequest, ISelfSerializable { @@ -56,7 +58,9 @@ void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions op } /// -/// Validates an anomaly detection detector. +/// +/// Validates an anomaly detection detector. +/// /// public sealed partial class ValidateDetectorRequestDescriptor : RequestDescriptor, ValidateDetectorRequestParameters> { @@ -106,7 +110,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Validates an anomaly detection detector. +/// +/// Validates an anomaly detection detector. +/// /// public sealed partial class ValidateDetectorRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ValidateDetectorResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ValidateDetectorResponse.g.cs index e9c159efb1d..3b016da7f28 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ValidateDetectorResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ValidateDetectorResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class ValidateDetectorResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ValidateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ValidateRequest.g.cs index fdf773f5e5a..39684ec9016 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ValidateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ValidateRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class ValidateRequestParameters : RequestParameters } /// -/// Validates an anomaly detection job. +/// +/// Validates an anomaly detection job. +/// /// public sealed partial class ValidateRequest : PlainRequest { @@ -67,7 +69,9 @@ public sealed partial class ValidateRequest : PlainRequest -/// Validates an anomaly detection job. +/// +/// Validates an anomaly detection job. +/// /// public sealed partial class ValidateRequestDescriptor : RequestDescriptor, ValidateRequestParameters> { @@ -331,7 +335,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Validates an anomaly detection job. +/// +/// Validates an anomaly detection job. +/// /// public sealed partial class ValidateRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ValidateResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ValidateResponse.g.cs index f0ca585fd42..09bd6cb03b7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ValidateResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ValidateResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class ValidateResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiGetRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiGetRequest.g.cs index 0529e06c25c..71c373196be 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiGetRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiGetRequest.g.cs @@ -32,53 +32,78 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class MultiGetRequestParameters : RequestParameters { /// - /// Should this request force synthetic _source?
Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance.
Fetches with this enabled will be slower the enabling synthetic source natively in the index. + /// + /// Should this request force synthetic _source? + /// Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. + /// Fetches with this enabled will be slower the enabling synthetic source natively in the index. + /// /// public bool? ForceSyntheticSource { get => Q("force_synthetic_source"); set => Q("force_synthetic_source", value); } /// - /// Specifies the node or shard the operation should be performed on. Random by default. + /// + /// Specifies the node or shard the operation should be performed on. Random by default. + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If `true`, the request is real-time as opposed to near-real-time. + /// + /// If true, the request is real-time as opposed to near-real-time. + /// /// public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } /// - /// If `true`, the request refreshes relevant shards before retrieving documents. + /// + /// If true, the request refreshes relevant shards before retrieving documents. + /// /// public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// True or false to return the `_source` field or not, or a list of fields to return. + /// + /// True or false to return the _source field or not, or a list of fields to return. + /// /// public Elastic.Clients.Elasticsearch.Core.Search.SourceConfigParam? Source { get => Q("_source"); set => Q("_source", value); } /// - /// A comma-separated list of source fields to exclude from the response.
You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. + /// + /// A comma-separated list of source fields to exclude from the response. + /// You can also use this parameter to exclude fields from the subset specified in _source_includes query parameter. + /// /// public Elastic.Clients.Elasticsearch.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response.
If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter.
If the `_source` parameter is `false`, this parameter is ignored. + /// + /// A comma-separated list of source fields to include in the response. + /// If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the _source_excludes query parameter. + /// If the _source parameter is false, this parameter is ignored. + /// /// public Elastic.Clients.Elasticsearch.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// If `true`, retrieves the document fields stored in the index rather than the document `_source`. + /// + /// If true, retrieves the document fields stored in the index rather than the document _source. + /// /// public Elastic.Clients.Elasticsearch.Fields? StoredFields { get => Q("stored_fields"); set => Q("stored_fields", value); } } /// -/// Allows to get multiple documents in one request. +/// +/// Allows to get multiple documents in one request. +/// /// public sealed partial class MultiGetRequest : PlainRequest { @@ -99,74 +124,103 @@ public MultiGetRequest(Elastic.Clients.Elasticsearch.IndexName? index) : base(r internal override string OperationName => "mget"; /// - /// Should this request force synthetic _source?
Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance.
Fetches with this enabled will be slower the enabling synthetic source natively in the index. + /// + /// Should this request force synthetic _source? + /// Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. + /// Fetches with this enabled will be slower the enabling synthetic source natively in the index. + /// /// [JsonIgnore] public bool? ForceSyntheticSource { get => Q("force_synthetic_source"); set => Q("force_synthetic_source", value); } /// - /// Specifies the node or shard the operation should be performed on. Random by default. + /// + /// Specifies the node or shard the operation should be performed on. Random by default. + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If `true`, the request is real-time as opposed to near-real-time. + /// + /// If true, the request is real-time as opposed to near-real-time. + /// /// [JsonIgnore] public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } /// - /// If `true`, the request refreshes relevant shards before retrieving documents. + /// + /// If true, the request refreshes relevant shards before retrieving documents. + /// /// [JsonIgnore] public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// True or false to return the `_source` field or not, or a list of fields to return. + /// + /// True or false to return the _source field or not, or a list of fields to return. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Core.Search.SourceConfigParam? Source { get => Q("_source"); set => Q("_source", value); } /// - /// A comma-separated list of source fields to exclude from the response.
You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. + /// + /// A comma-separated list of source fields to exclude from the response. + /// You can also use this parameter to exclude fields from the subset specified in _source_includes query parameter. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response.
If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter.
If the `_source` parameter is `false`, this parameter is ignored. + /// + /// A comma-separated list of source fields to include in the response. + /// If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the _source_excludes query parameter. + /// If the _source parameter is false, this parameter is ignored. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// If `true`, retrieves the document fields stored in the index rather than the document `_source`. + /// + /// If true, retrieves the document fields stored in the index rather than the document _source. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? StoredFields { get => Q("stored_fields"); set => Q("stored_fields", value); } /// - /// The documents you want to retrieve. Required if no index is specified in the request URI. + /// + /// The documents you want to retrieve. Required if no index is specified in the request URI. + /// /// [JsonInclude, JsonPropertyName("docs")] public ICollection? Docs { get; set; } /// - /// The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI. + /// + /// The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI. + /// /// [JsonInclude, JsonPropertyName("ids")] public Elastic.Clients.Elasticsearch.Ids? Ids { get; set; } } /// -/// Allows to get multiple documents in one request. +/// +/// Allows to get multiple documents in one request. +/// /// public sealed partial class MultiGetRequestDescriptor : RequestDescriptor, MultiGetRequestParameters> { @@ -211,7 +265,9 @@ public MultiGetRequestDescriptor Index(Elastic.Clients.Elasticsearch. private Elastic.Clients.Elasticsearch.Ids? IdsValue { get; set; } /// - /// The documents you want to retrieve. Required if no index is specified in the request URI. + /// + /// The documents you want to retrieve. Required if no index is specified in the request URI. + /// /// public MultiGetRequestDescriptor Docs(ICollection? docs) { @@ -250,7 +306,9 @@ public MultiGetRequestDescriptor Docs(params Action - /// The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI. + /// + /// The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI. + /// /// public MultiGetRequestDescriptor Ids(Elastic.Clients.Elasticsearch.Ids? ids) { @@ -303,7 +361,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Allows to get multiple documents in one request. +/// +/// Allows to get multiple documents in one request. +/// /// public sealed partial class MultiGetRequestDescriptor : RequestDescriptor { @@ -348,7 +408,9 @@ public MultiGetRequestDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? private Elastic.Clients.Elasticsearch.Ids? IdsValue { get; set; } /// - /// The documents you want to retrieve. Required if no index is specified in the request URI. + /// + /// The documents you want to retrieve. Required if no index is specified in the request URI. + /// /// public MultiGetRequestDescriptor Docs(ICollection? docs) { @@ -387,7 +449,9 @@ public MultiGetRequestDescriptor Docs(params Action - /// The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI. + /// + /// The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI. + /// /// public MultiGetRequestDescriptor Ids(Elastic.Clients.Elasticsearch.Ids? ids) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiSearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiSearchRequest.g.cs index d1359e9ced0..b255d3a68d4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiSearchRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiSearchRequest.g.cs @@ -34,68 +34,94 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class MultiSearchRequestParameters : RequestParameters { /// - /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. + /// + /// If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. + /// /// public bool? CcsMinimizeRoundtrips { get => Q("ccs_minimize_roundtrips"); set => Q("ccs_minimize_roundtrips", value); } /// - /// Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// + /// Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If true, concrete, expanded or aliased indices are ignored when frozen. + /// + /// If true, concrete, expanded or aliased indices are ignored when frozen. + /// /// public bool? IgnoreThrottled { get => Q("ignore_throttled"); set => Q("ignore_throttled", value); } /// - /// If true, missing or closed indices are not included in the response. + /// + /// If true, missing or closed indices are not included in the response. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Maximum number of concurrent searches the multi search API can execute. + /// + /// Maximum number of concurrent searches the multi search API can execute. + /// /// public long? MaxConcurrentSearches { get => Q("max_concurrent_searches"); set => Q("max_concurrent_searches", value); } /// - /// Maximum number of concurrent shard requests that each sub-search request executes per node. + /// + /// Maximum number of concurrent shard requests that each sub-search request executes per node. + /// /// public long? MaxConcurrentShardRequests { get => Q("max_concurrent_shard_requests"); set => Q("max_concurrent_shard_requests", value); } /// - /// Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint. + /// + /// Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint. + /// /// public long? PreFilterShardSize { get => Q("pre_filter_shard_size"); set => Q("pre_filter_shard_size", value); } /// - /// If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object. + /// + /// If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object. + /// /// public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } /// - /// Custom routing value used to route search operations to a specific shard. + /// + /// Custom routing value used to route search operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Indicates whether global term and document frequencies should be used when scoring returned documents. + /// + /// Indicates whether global term and document frequencies should be used when scoring returned documents. + /// /// public Elastic.Clients.Elasticsearch.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } /// - /// Specifies whether aggregation and suggester names should be prefixed by their respective types in the response. + /// + /// Specifies whether aggregation and suggester names should be prefixed by their respective types in the response. + /// /// public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } } /// -/// Allows to execute several search operations in one request. +/// +/// Allows to execute several search operations in one request. +/// /// public sealed partial class MultiSearchRequest : PlainRequest, IStreamSerializable { @@ -116,73 +142,97 @@ public MultiSearchRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base internal override string OperationName => "msearch"; /// - /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. + /// + /// If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. + /// /// [JsonIgnore] public bool? CcsMinimizeRoundtrips { get => Q("ccs_minimize_roundtrips"); set => Q("ccs_minimize_roundtrips", value); } /// - /// Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// + /// Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If true, concrete, expanded or aliased indices are ignored when frozen. + /// + /// If true, concrete, expanded or aliased indices are ignored when frozen. + /// /// [JsonIgnore] public bool? IgnoreThrottled { get => Q("ignore_throttled"); set => Q("ignore_throttled", value); } /// - /// If true, missing or closed indices are not included in the response. + /// + /// If true, missing or closed indices are not included in the response. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Maximum number of concurrent searches the multi search API can execute. + /// + /// Maximum number of concurrent searches the multi search API can execute. + /// /// [JsonIgnore] public long? MaxConcurrentSearches { get => Q("max_concurrent_searches"); set => Q("max_concurrent_searches", value); } /// - /// Maximum number of concurrent shard requests that each sub-search request executes per node. + /// + /// Maximum number of concurrent shard requests that each sub-search request executes per node. + /// /// [JsonIgnore] public long? MaxConcurrentShardRequests { get => Q("max_concurrent_shard_requests"); set => Q("max_concurrent_shard_requests", value); } /// - /// Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint. + /// + /// Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint. + /// /// [JsonIgnore] public long? PreFilterShardSize { get => Q("pre_filter_shard_size"); set => Q("pre_filter_shard_size", value); } /// - /// If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object. + /// + /// If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object. + /// /// [JsonIgnore] public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } /// - /// Custom routing value used to route search operations to a specific shard. + /// + /// Custom routing value used to route search operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Indicates whether global term and document frequencies should be used when scoring returned documents. + /// + /// Indicates whether global term and document frequencies should be used when scoring returned documents. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } /// - /// Specifies whether aggregation and suggester names should be prefixed by their respective types in the response. + /// + /// Specifies whether aggregation and suggester names should be prefixed by their respective types in the response. + /// /// [JsonIgnore] public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } @@ -212,7 +262,9 @@ async Task IStreamSerializable.SerializeAsync(Stream stream, IElasticsearchClien } /// -/// Allows to execute several search operations in one request. +/// +/// Allows to execute several search operations in one request. +/// /// public sealed partial class MultiSearchRequestDescriptor : RequestDescriptor, MultiSearchRequestParameters>, IStreamSerializable { @@ -289,7 +341,9 @@ public MultiSearchRequestDescriptor AddSearches(Elastic.Clients.Elast } /// -/// Allows to execute several search operations in one request. +/// +/// Allows to execute several search operations in one request. +/// /// public sealed partial class MultiSearchRequestDescriptor : RequestDescriptor, IStreamSerializable { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiSearchTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiSearchTemplateRequest.g.cs index 3de2b9c4abf..64ba00a8ed3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiSearchTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiSearchTemplateRequest.g.cs @@ -34,33 +34,47 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class MultiSearchTemplateRequestParameters : RequestParameters { /// - /// If `true`, network round-trips are minimized for cross-cluster search requests. + /// + /// If true, network round-trips are minimized for cross-cluster search requests. + /// /// public bool? CcsMinimizeRoundtrips { get => Q("ccs_minimize_roundtrips"); set => Q("ccs_minimize_roundtrips", value); } /// - /// Maximum number of concurrent searches the API can run. + /// + /// Maximum number of concurrent searches the API can run. + /// /// public long? MaxConcurrentSearches { get => Q("max_concurrent_searches"); set => Q("max_concurrent_searches", value); } /// - /// If `true`, the response returns `hits.total` as an integer.
If `false`, it returns `hits.total` as an object. + /// + /// If true, the response returns hits.total as an integer. + /// If false, it returns hits.total as an object. + /// /// public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } /// - /// The type of the search operation.
Available options: `query_then_fetch`, `dfs_query_then_fetch`. + /// + /// The type of the search operation. + /// Available options: query_then_fetch, dfs_query_then_fetch. + /// /// public Elastic.Clients.Elasticsearch.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } /// - /// If `true`, the response prefixes aggregation and suggester names with their respective types. + /// + /// If true, the response prefixes aggregation and suggester names with their respective types. + /// /// public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } } /// -/// Runs multiple templated searches with a single request. +/// +/// Runs multiple templated searches with a single request. +/// /// public sealed partial class MultiSearchTemplateRequest : PlainRequest, IStreamSerializable { @@ -81,31 +95,43 @@ public MultiSearchTemplateRequest(Elastic.Clients.Elasticsearch.Indices? indices internal override string OperationName => "msearch_template"; /// - /// If `true`, network round-trips are minimized for cross-cluster search requests. + /// + /// If true, network round-trips are minimized for cross-cluster search requests. + /// /// [JsonIgnore] public bool? CcsMinimizeRoundtrips { get => Q("ccs_minimize_roundtrips"); set => Q("ccs_minimize_roundtrips", value); } /// - /// Maximum number of concurrent searches the API can run. + /// + /// Maximum number of concurrent searches the API can run. + /// /// [JsonIgnore] public long? MaxConcurrentSearches { get => Q("max_concurrent_searches"); set => Q("max_concurrent_searches", value); } /// - /// If `true`, the response returns `hits.total` as an integer.
If `false`, it returns `hits.total` as an object. + /// + /// If true, the response returns hits.total as an integer. + /// If false, it returns hits.total as an object. + /// /// [JsonIgnore] public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } /// - /// The type of the search operation.
Available options: `query_then_fetch`, `dfs_query_then_fetch`. + /// + /// The type of the search operation. + /// Available options: query_then_fetch, dfs_query_then_fetch. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } /// - /// If `true`, the response prefixes aggregation and suggester names with their respective types. + /// + /// If true, the response prefixes aggregation and suggester names with their respective types. + /// /// [JsonIgnore] public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } @@ -135,7 +161,9 @@ async Task IStreamSerializable.SerializeAsync(Stream stream, IElasticsearchClien } /// -/// Runs multiple templated searches with a single request. +/// +/// Runs multiple templated searches with a single request. +/// /// public sealed partial class MultiSearchTemplateRequestDescriptor : RequestDescriptor, MultiSearchTemplateRequestParameters>, IStreamSerializable { @@ -205,7 +233,9 @@ public MultiSearchTemplateRequestDescriptor AddSearchTemplates(Elasti } /// -/// Runs multiple templated searches with a single request. +/// +/// Runs multiple templated searches with a single request. +/// /// public sealed partial class MultiSearchTemplateRequestDescriptor : RequestDescriptor, IStreamSerializable { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiTermVectorsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiTermVectorsRequest.g.cs index 8953c5d5039..448628b940e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiTermVectorsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiTermVectorsRequest.g.cs @@ -32,63 +32,89 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class MultiTermVectorsRequestParameters : RequestParameters { /// - /// Comma-separated list or wildcard expressions of fields to include in the statistics.
Used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. + /// + /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// Used as the default list unless a specific field list is provided in the completion_fields or fielddata_fields parameters. + /// /// public Elastic.Clients.Elasticsearch.Fields? Fields { get => Q("fields"); set => Q("fields", value); } /// - /// If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + /// + /// If true, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + /// /// public bool? FieldStatistics { get => Q("field_statistics"); set => Q("field_statistics", value); } /// - /// If `true`, the response includes term offsets. + /// + /// If true, the response includes term offsets. + /// /// public bool? Offsets { get => Q("offsets"); set => Q("offsets", value); } /// - /// If `true`, the response includes term payloads. + /// + /// If true, the response includes term payloads. + /// /// public bool? Payloads { get => Q("payloads"); set => Q("payloads", value); } /// - /// If `true`, the response includes term positions. + /// + /// If true, the response includes term positions. + /// /// public bool? Positions { get => Q("positions"); set => Q("positions", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If true, the request is real-time as opposed to near-real-time. + /// + /// If true, the request is real-time as opposed to near-real-time. + /// /// public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// If true, the response includes term frequency and document frequency. + /// + /// If true, the response includes term frequency and document frequency. + /// /// public bool? TermStatistics { get => Q("term_statistics"); set => Q("term_statistics", value); } /// - /// If `true`, returns the document version as part of a hit. + /// + /// If true, returns the document version as part of a hit. + /// /// public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type. + /// + /// Specific version type. + /// /// public Elastic.Clients.Elasticsearch.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } } /// -/// Returns multiple termvectors in one request. +/// +/// Returns multiple termvectors in one request. +/// /// public sealed partial class MultiTermVectorsRequest : PlainRequest { @@ -109,86 +135,116 @@ public MultiTermVectorsRequest(Elastic.Clients.Elasticsearch.IndexName? index) : internal override string OperationName => "mtermvectors"; /// - /// Comma-separated list or wildcard expressions of fields to include in the statistics.
Used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. + /// + /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// Used as the default list unless a specific field list is provided in the completion_fields or fielddata_fields parameters. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? Fields { get => Q("fields"); set => Q("fields", value); } /// - /// If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + /// + /// If true, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + /// /// [JsonIgnore] public bool? FieldStatistics { get => Q("field_statistics"); set => Q("field_statistics", value); } /// - /// If `true`, the response includes term offsets. + /// + /// If true, the response includes term offsets. + /// /// [JsonIgnore] public bool? Offsets { get => Q("offsets"); set => Q("offsets", value); } /// - /// If `true`, the response includes term payloads. + /// + /// If true, the response includes term payloads. + /// /// [JsonIgnore] public bool? Payloads { get => Q("payloads"); set => Q("payloads", value); } /// - /// If `true`, the response includes term positions. + /// + /// If true, the response includes term positions. + /// /// [JsonIgnore] public bool? Positions { get => Q("positions"); set => Q("positions", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If true, the request is real-time as opposed to near-real-time. + /// + /// If true, the request is real-time as opposed to near-real-time. + /// /// [JsonIgnore] public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// If true, the response includes term frequency and document frequency. + /// + /// If true, the response includes term frequency and document frequency. + /// /// [JsonIgnore] public bool? TermStatistics { get => Q("term_statistics"); set => Q("term_statistics", value); } /// - /// If `true`, returns the document version as part of a hit. + /// + /// If true, returns the document version as part of a hit. + /// /// [JsonIgnore] public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type. + /// + /// Specific version type. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } /// - /// Array of existing or artificial documents. + /// + /// Array of existing or artificial documents. + /// /// [JsonInclude, JsonPropertyName("docs")] public ICollection? Docs { get; set; } /// - /// Simplified syntax to specify documents by their ID if they're in the same index. + /// + /// Simplified syntax to specify documents by their ID if they're in the same index. + /// /// [JsonInclude, JsonPropertyName("ids")] public ICollection? Ids { get; set; } } /// -/// Returns multiple termvectors in one request. +/// +/// Returns multiple termvectors in one request. +/// /// public sealed partial class MultiTermVectorsRequestDescriptor : RequestDescriptor, MultiTermVectorsRequestParameters> { @@ -235,7 +291,9 @@ public MultiTermVectorsRequestDescriptor Index(Elastic.Clients.Elasti private ICollection? IdsValue { get; set; } /// - /// Array of existing or artificial documents. + /// + /// Array of existing or artificial documents. + /// /// public MultiTermVectorsRequestDescriptor Docs(ICollection? docs) { @@ -274,7 +332,9 @@ public MultiTermVectorsRequestDescriptor Docs(params Action - /// Simplified syntax to specify documents by their ID if they're in the same index. + /// + /// Simplified syntax to specify documents by their ID if they're in the same index. + /// /// public MultiTermVectorsRequestDescriptor Ids(ICollection? ids) { @@ -327,7 +387,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns multiple termvectors in one request. +/// +/// Returns multiple termvectors in one request. +/// /// public sealed partial class MultiTermVectorsRequestDescriptor : RequestDescriptor { @@ -374,7 +436,9 @@ public MultiTermVectorsRequestDescriptor Index(Elastic.Clients.Elasticsearch.Ind private ICollection? IdsValue { get; set; } /// - /// Array of existing or artificial documents. + /// + /// Array of existing or artificial documents. + /// /// public MultiTermVectorsRequestDescriptor Docs(ICollection? docs) { @@ -413,7 +477,9 @@ public MultiTermVectorsRequestDescriptor Docs(params Action - /// Simplified syntax to specify documents by their ID if they're in the same index. + /// + /// Simplified syntax to specify documents by their ID if they're in the same index. + /// /// public MultiTermVectorsRequestDescriptor Ids(ICollection? ids) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/ClearRepositoriesMeteringArchiveRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/ClearRepositoriesMeteringArchiveRequest.g.cs index 80e8073ac2b..7f88d078337 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/ClearRepositoriesMeteringArchiveRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/ClearRepositoriesMeteringArchiveRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class ClearRepositoriesMeteringArchiveRequestParameters : } /// -/// You can use this API to clear the archived repositories metering information in the cluster. +/// +/// You can use this API to clear the archived repositories metering information in the cluster. +/// /// public sealed partial class ClearRepositoriesMeteringArchiveRequest : PlainRequest { @@ -52,7 +54,9 @@ public ClearRepositoriesMeteringArchiveRequest(Elastic.Clients.Elasticsearch.Nod } /// -/// You can use this API to clear the archived repositories metering information in the cluster. +/// +/// You can use this API to clear the archived repositories metering information in the cluster. +/// /// public sealed partial class ClearRepositoriesMeteringArchiveRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/ClearRepositoriesMeteringArchiveResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/ClearRepositoriesMeteringArchiveResponse.g.cs index faf3fa4ce04..5b20e33dca1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/ClearRepositoriesMeteringArchiveResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/ClearRepositoriesMeteringArchiveResponse.g.cs @@ -29,19 +29,25 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class ClearRepositoriesMeteringArchiveResponse : ElasticsearchResponse { /// - /// Name of the cluster. Based on the [Cluster name setting](https://www.elastic.co/guide/en/elasticsearch/reference/current/important-settings.html#cluster-name). + /// + /// Name of the cluster. Based on the Cluster name setting. + /// /// [JsonInclude, JsonPropertyName("cluster_name")] public string ClusterName { get; init; } /// - /// Contains repositories metering information for the nodes selected by the request. + /// + /// Contains repositories metering information for the nodes selected by the request. + /// /// [JsonInclude, JsonPropertyName("nodes")] public IReadOnlyDictionary Nodes { get; init; } /// - /// Contains statistics about the number of nodes selected by the request’s node filters. + /// + /// Contains statistics about the number of nodes selected by the request’s node filters. + /// /// [JsonInclude, JsonPropertyName("_nodes")] public Elastic.Clients.Elasticsearch.NodeStatistics? NodeStats { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/GetRepositoriesMeteringInfoRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/GetRepositoriesMeteringInfoRequest.g.cs index 32a960b86fb..569f0cd6433 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/GetRepositoriesMeteringInfoRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/GetRepositoriesMeteringInfoRequest.g.cs @@ -34,7 +34,12 @@ public sealed partial class GetRepositoriesMeteringInfoRequestParameters : Reque } /// -/// You can use the cluster repositories metering API to retrieve repositories metering information in a cluster.
This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the
information needed to compute aggregations over a period of time. Additionally, the information exposed by this
API is volatile, meaning that it won’t be present after node restarts. +/// +/// You can use the cluster repositories metering API to retrieve repositories metering information in a cluster. +/// This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the +/// information needed to compute aggregations over a period of time. Additionally, the information exposed by this +/// API is volatile, meaning that it won’t be present after node restarts. +/// /// public sealed partial class GetRepositoriesMeteringInfoRequest : PlainRequest { @@ -52,7 +57,12 @@ public GetRepositoriesMeteringInfoRequest(Elastic.Clients.Elasticsearch.NodeIds } /// -/// You can use the cluster repositories metering API to retrieve repositories metering information in a cluster.
This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the
information needed to compute aggregations over a period of time. Additionally, the information exposed by this
API is volatile, meaning that it won’t be present after node restarts. +/// +/// You can use the cluster repositories metering API to retrieve repositories metering information in a cluster. +/// This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the +/// information needed to compute aggregations over a period of time. Additionally, the information exposed by this +/// API is volatile, meaning that it won’t be present after node restarts. +/// /// public sealed partial class GetRepositoriesMeteringInfoRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/GetRepositoriesMeteringInfoResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/GetRepositoriesMeteringInfoResponse.g.cs index e3526737654..5699dc4d2fb 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/GetRepositoriesMeteringInfoResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/GetRepositoriesMeteringInfoResponse.g.cs @@ -29,19 +29,25 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class GetRepositoriesMeteringInfoResponse : ElasticsearchResponse { /// - /// Name of the cluster. Based on the [Cluster name setting](https://www.elastic.co/guide/en/elasticsearch/reference/current/important-settings.html#cluster-name). + /// + /// Name of the cluster. Based on the Cluster name setting. + /// /// [JsonInclude, JsonPropertyName("cluster_name")] public string ClusterName { get; init; } /// - /// Contains repositories metering information for the nodes selected by the request. + /// + /// Contains repositories metering information for the nodes selected by the request. + /// /// [JsonInclude, JsonPropertyName("nodes")] public IReadOnlyDictionary Nodes { get; init; } /// - /// Contains statistics about the number of nodes selected by the request’s node filters. + /// + /// Contains statistics about the number of nodes selected by the request’s node filters. + /// /// [JsonInclude, JsonPropertyName("_nodes")] public Elastic.Clients.Elasticsearch.NodeStatistics? NodeStats { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/HotThreadsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/HotThreadsRequest.g.cs index 212869482e5..0c62060469c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/HotThreadsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/HotThreadsRequest.g.cs @@ -32,48 +32,71 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class HotThreadsRequestParameters : RequestParameters { /// - /// If true, known idle threads (e.g. waiting in a socket select, or to get
a task from an empty queue) are filtered out. + /// + /// If true, known idle threads (e.g. waiting in a socket select, or to get + /// a task from an empty queue) are filtered out. + /// /// public bool? IgnoreIdleThreads { get => Q("ignore_idle_threads"); set => Q("ignore_idle_threads", value); } /// - /// The interval to do the second sampling of threads. + /// + /// The interval to do the second sampling of threads. + /// /// public Elastic.Clients.Elasticsearch.Duration? Interval { get => Q("interval"); set => Q("interval", value); } /// - /// Period to wait for a connection to the master node. If no response
is received before the timeout expires, the request fails and
returns an error. + /// + /// Period to wait for a connection to the master node. If no response + /// is received before the timeout expires, the request fails and + /// returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Number of samples of thread stacktrace. + /// + /// Number of samples of thread stacktrace. + /// /// public long? Snapshots { get => Q("snapshots"); set => Q("snapshots", value); } /// - /// The sort order for 'cpu' type (default: total) + /// + /// The sort order for 'cpu' type (default: total) + /// /// public Elastic.Clients.Elasticsearch.ThreadType? Sort { get => Q("sort"); set => Q("sort", value); } /// - /// Specifies the number of hot threads to provide information for. + /// + /// Specifies the number of hot threads to provide information for. + /// /// public long? Threads { get => Q("threads"); set => Q("threads", value); } /// - /// Period to wait for a response. If no response is received
before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received + /// before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The type to sample. + /// + /// The type to sample. + /// /// public Elastic.Clients.Elasticsearch.ThreadType? Type { get => Q("type"); set => Q("type", value); } } /// -/// This API yields a breakdown of the hot threads on each selected node in the cluster.
The output is plain text with a breakdown of each node’s top hot threads. +/// +/// This API yields a breakdown of the hot threads on each selected node in the cluster. +/// The output is plain text with a breakdown of each node’s top hot threads. +/// /// public sealed partial class HotThreadsRequest : PlainRequest { @@ -94,56 +117,79 @@ public HotThreadsRequest(Elastic.Clients.Elasticsearch.NodeIds? nodeId) : base(r internal override string OperationName => "nodes.hot_threads"; /// - /// If true, known idle threads (e.g. waiting in a socket select, or to get
a task from an empty queue) are filtered out. + /// + /// If true, known idle threads (e.g. waiting in a socket select, or to get + /// a task from an empty queue) are filtered out. + /// /// [JsonIgnore] public bool? IgnoreIdleThreads { get => Q("ignore_idle_threads"); set => Q("ignore_idle_threads", value); } /// - /// The interval to do the second sampling of threads. + /// + /// The interval to do the second sampling of threads. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Interval { get => Q("interval"); set => Q("interval", value); } /// - /// Period to wait for a connection to the master node. If no response
is received before the timeout expires, the request fails and
returns an error. + /// + /// Period to wait for a connection to the master node. If no response + /// is received before the timeout expires, the request fails and + /// returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Number of samples of thread stacktrace. + /// + /// Number of samples of thread stacktrace. + /// /// [JsonIgnore] public long? Snapshots { get => Q("snapshots"); set => Q("snapshots", value); } /// - /// The sort order for 'cpu' type (default: total) + /// + /// The sort order for 'cpu' type (default: total) + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.ThreadType? Sort { get => Q("sort"); set => Q("sort", value); } /// - /// Specifies the number of hot threads to provide information for. + /// + /// Specifies the number of hot threads to provide information for. + /// /// [JsonIgnore] public long? Threads { get => Q("threads"); set => Q("threads", value); } /// - /// Period to wait for a response. If no response is received
before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received + /// before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The type to sample. + /// + /// The type to sample. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.ThreadType? Type { get => Q("type"); set => Q("type", value); } } /// -/// This API yields a breakdown of the hot threads on each selected node in the cluster.
The output is plain text with a breakdown of each node’s top hot threads. +/// +/// This API yields a breakdown of the hot threads on each selected node in the cluster. +/// The output is plain text with a breakdown of each node’s top hot threads. +/// /// public sealed partial class HotThreadsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesInfoRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesInfoRequest.g.cs index a928f948846..ac295843d91 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesInfoRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesInfoRequest.g.cs @@ -32,23 +32,31 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class NodesInfoRequestParameters : RequestParameters { /// - /// If true, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Returns cluster nodes information. +/// +/// Returns cluster nodes information. +/// /// public sealed partial class NodesInfoRequest : PlainRequest { @@ -77,26 +85,34 @@ public NodesInfoRequest(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic.C internal override string OperationName => "nodes.info"; /// - /// If true, returns settings in flat format. + /// + /// If true, returns settings in flat format. + /// /// [JsonIgnore] public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Returns cluster nodes information. +/// +/// Returns cluster nodes information. +/// /// public sealed partial class NodesInfoRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesInfoResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesInfoResponse.g.cs index d68d4fa9b2a..5ca252fad2f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesInfoResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesInfoResponse.g.cs @@ -34,7 +34,9 @@ public sealed partial class NodesInfoResponse : ElasticsearchResponse public IReadOnlyDictionary Nodes { get; init; } /// - /// Contains statistics about the number of nodes selected by the request’s node filters. + /// + /// Contains statistics about the number of nodes selected by the request’s node filters. + /// /// [JsonInclude, JsonPropertyName("_nodes")] public Elastic.Clients.Elasticsearch.NodeStatistics? NodeStats { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesStatsRequest.g.cs index be5862b28da..34a0e37d17f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesStatsRequest.g.cs @@ -32,58 +32,80 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class NodesStatsRequestParameters : RequestParameters { /// - /// Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + /// + /// Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + /// /// public Elastic.Clients.Elasticsearch.Fields? CompletionFields { get => Q("completion_fields"); set => Q("completion_fields", value); } /// - /// Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + /// + /// Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + /// /// public Elastic.Clients.Elasticsearch.Fields? FielddataFields { get => Q("fielddata_fields"); set => Q("fielddata_fields", value); } /// - /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// + /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// /// public Elastic.Clients.Elasticsearch.Fields? Fields { get => Q("fields"); set => Q("fields", value); } /// - /// Comma-separated list of search groups to include in the search statistics. + /// + /// Comma-separated list of search groups to include in the search statistics. + /// /// public bool? Groups { get => Q("groups"); set => Q("groups", value); } /// - /// If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + /// + /// If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + /// /// public bool? IncludeSegmentFileSizes { get => Q("include_segment_file_sizes"); set => Q("include_segment_file_sizes", value); } /// - /// If `true`, the response includes information from segments that are not loaded into memory. + /// + /// If true, the response includes information from segments that are not loaded into memory. + /// /// public bool? IncludeUnloadedSegments { get => Q("include_unloaded_segments"); set => Q("include_unloaded_segments", value); } /// - /// Indicates whether statistics are aggregated at the cluster, index, or shard level. + /// + /// Indicates whether statistics are aggregated at the cluster, index, or shard level. + /// /// public Elastic.Clients.Elasticsearch.Level? Level { get => Q("level"); set => Q("level", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// A comma-separated list of document types for the indexing index metric. + /// + /// A comma-separated list of document types for the indexing index metric. + /// /// public ICollection? Types { get => Q?>("types"); set => Q("types", value); } } /// -/// Returns cluster nodes statistics. +/// +/// Returns cluster nodes statistics. +/// /// public sealed partial class NodesStatsRequest : PlainRequest { @@ -120,68 +142,90 @@ public NodesStatsRequest(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic. internal override string OperationName => "nodes.stats"; /// - /// Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + /// + /// Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? CompletionFields { get => Q("completion_fields"); set => Q("completion_fields", value); } /// - /// Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + /// + /// Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? FielddataFields { get => Q("fielddata_fields"); set => Q("fielddata_fields", value); } /// - /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// + /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? Fields { get => Q("fields"); set => Q("fields", value); } /// - /// Comma-separated list of search groups to include in the search statistics. + /// + /// Comma-separated list of search groups to include in the search statistics. + /// /// [JsonIgnore] public bool? Groups { get => Q("groups"); set => Q("groups", value); } /// - /// If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + /// + /// If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + /// /// [JsonIgnore] public bool? IncludeSegmentFileSizes { get => Q("include_segment_file_sizes"); set => Q("include_segment_file_sizes", value); } /// - /// If `true`, the response includes information from segments that are not loaded into memory. + /// + /// If true, the response includes information from segments that are not loaded into memory. + /// /// [JsonIgnore] public bool? IncludeUnloadedSegments { get => Q("include_unloaded_segments"); set => Q("include_unloaded_segments", value); } /// - /// Indicates whether statistics are aggregated at the cluster, index, or shard level. + /// + /// Indicates whether statistics are aggregated at the cluster, index, or shard level. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Level? Level { get => Q("level"); set => Q("level", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// A comma-separated list of document types for the indexing index metric. + /// + /// A comma-separated list of document types for the indexing index metric. + /// /// [JsonIgnore] public ICollection? Types { get => Q?>("types"); set => Q("types", value); } } /// -/// Returns cluster nodes statistics. +/// +/// Returns cluster nodes statistics. +/// /// public sealed partial class NodesStatsRequestDescriptor : RequestDescriptor, NodesStatsRequestParameters> { @@ -238,7 +282,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns cluster nodes statistics. +/// +/// Returns cluster nodes statistics. +/// /// public sealed partial class NodesStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesStatsResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesStatsResponse.g.cs index 1f707d23f34..cb917ccc1c0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesStatsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesStatsResponse.g.cs @@ -34,7 +34,9 @@ public sealed partial class NodesStatsResponse : ElasticsearchResponse public IReadOnlyDictionary Nodes { get; init; } /// - /// Contains statistics about the number of nodes selected by the request’s node filters. + /// + /// Contains statistics about the number of nodes selected by the request’s node filters. + /// /// [JsonInclude, JsonPropertyName("_nodes")] public Elastic.Clients.Elasticsearch.NodeStatistics? NodeStats { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesUsageRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesUsageRequest.g.cs index a4f4bb0efa7..d379df24ca9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesUsageRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesUsageRequest.g.cs @@ -32,13 +32,18 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class NodesUsageRequestParameters : RequestParameters { /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Returns information on the usage of features. +/// +/// Returns information on the usage of features. +/// /// public sealed partial class NodesUsageRequest : PlainRequest { @@ -67,14 +72,19 @@ public NodesUsageRequest(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic. internal override string OperationName => "nodes.usage"; /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Returns information on the usage of features. +/// +/// Returns information on the usage of features. +/// /// public sealed partial class NodesUsageRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesUsageResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesUsageResponse.g.cs index a0c67acf133..daaa410f471 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesUsageResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesUsageResponse.g.cs @@ -34,7 +34,9 @@ public sealed partial class NodesUsageResponse : ElasticsearchResponse public IReadOnlyDictionary Nodes { get; init; } /// - /// Contains statistics about the number of nodes selected by the request’s node filters. + /// + /// Contains statistics about the number of nodes selected by the request’s node filters. + /// /// [JsonInclude, JsonPropertyName("_nodes")] public Elastic.Clients.Elasticsearch.NodeStatistics? NodeStats { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/ReloadSecureSettingsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/ReloadSecureSettingsRequest.g.cs index d3e12dab29b..54b9958a233 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/ReloadSecureSettingsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/ReloadSecureSettingsRequest.g.cs @@ -32,13 +32,18 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class ReloadSecureSettingsRequestParameters : RequestParameters { /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Reloads the keystore on nodes in the cluster. +/// +/// Reloads the keystore on nodes in the cluster. +/// /// public sealed partial class ReloadSecureSettingsRequest : PlainRequest { @@ -59,20 +64,27 @@ public ReloadSecureSettingsRequest(Elastic.Clients.Elasticsearch.NodeIds? nodeId internal override string OperationName => "nodes.reload_secure_settings"; /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The password for the Elasticsearch keystore. + /// + /// The password for the Elasticsearch keystore. + /// /// [JsonInclude, JsonPropertyName("secure_settings_password")] public string? SecureSettingsPassword { get; set; } } /// -/// Reloads the keystore on nodes in the cluster. +/// +/// Reloads the keystore on nodes in the cluster. +/// /// public sealed partial class ReloadSecureSettingsRequestDescriptor : RequestDescriptor { @@ -105,7 +117,9 @@ public ReloadSecureSettingsRequestDescriptor NodeId(Elastic.Clients.Elasticsearc private string? SecureSettingsPasswordValue { get; set; } /// - /// The password for the Elasticsearch keystore. + /// + /// The password for the Elasticsearch keystore. + /// /// public ReloadSecureSettingsRequestDescriptor SecureSettingsPassword(string? secureSettingsPassword) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/ReloadSecureSettingsResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/ReloadSecureSettingsResponse.g.cs index fb74d3b0184..0ad2ae88554 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/ReloadSecureSettingsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/ReloadSecureSettingsResponse.g.cs @@ -34,7 +34,9 @@ public sealed partial class ReloadSecureSettingsResponse : ElasticsearchResponse public IReadOnlyDictionary Nodes { get; init; } /// - /// Contains statistics about the number of nodes selected by the request’s node filters. + /// + /// Contains statistics about the number of nodes selected by the request’s node filters. + /// /// [JsonInclude, JsonPropertyName("_nodes")] public Elastic.Clients.Elasticsearch.NodeStatistics? NodeStats { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/OpenPointInTimeRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/OpenPointInTimeRequest.g.cs index 0e24bd4177a..70c7fbf99c4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/OpenPointInTimeRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/OpenPointInTimeRequest.g.cs @@ -32,33 +32,53 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class OpenPointInTimeRequestParameters : RequestParameters { /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Extends the time to live of the corresponding point in time. + /// + /// Extends the time to live of the corresponding point in time. + /// /// public Elastic.Clients.Elasticsearch.Duration KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } } /// -/// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. +/// +/// A search request by default executes against the most recent visible data of the target indices, +/// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the +/// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple +/// search requests using the same point in time. For example, if refreshes happen between +/// search_after requests, then the results of those requests might not be consistent as changes happening +/// between searches are only visible to the more recent point in time. +/// /// public sealed partial class OpenPointInTimeRequest : PlainRequest { @@ -75,38 +95,58 @@ public OpenPointInTimeRequest(Elastic.Clients.Elasticsearch.Indices indices) : b internal override string OperationName => "open_point_in_time"; /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Extends the time to live of the corresponding point in time. + /// + /// Extends the time to live of the corresponding point in time. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } } /// -/// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. +/// +/// A search request by default executes against the most recent visible data of the target indices, +/// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the +/// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple +/// search requests using the same point in time. For example, if refreshes happen between +/// search_after requests, then the results of those requests might not be consistent as changes happening +/// between searches are only visible to the more recent point in time. +/// /// public sealed partial class OpenPointInTimeRequestDescriptor : RequestDescriptor, OpenPointInTimeRequestParameters> { @@ -146,7 +186,14 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. +/// +/// A search request by default executes against the most recent visible data of the target indices, +/// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the +/// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple +/// search requests using the same point in time. For example, if refreshes happen between +/// search_after requests, then the results of those requests might not be consistent as changes happening +/// between searches are only visible to the more recent point in time. +/// /// public sealed partial class OpenPointInTimeRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/PingRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/PingRequest.g.cs index 243a71b8d4a..beaafdfa6b4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/PingRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/PingRequest.g.cs @@ -34,7 +34,10 @@ public sealed partial class PingRequestParameters : RequestParameters } /// -/// Ping the cluster.
Returns whether the cluster is running. +/// +/// Ping the cluster. +/// Returns whether the cluster is running. +/// /// public sealed partial class PingRequest : PlainRequest { @@ -48,7 +51,10 @@ public sealed partial class PingRequest : PlainRequest } /// -/// Ping the cluster.
Returns whether the cluster is running. +/// +/// Ping the cluster. +/// Returns whether the cluster is running. +/// /// public sealed partial class PingRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/PutScriptRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/PutScriptRequest.g.cs index f6751b5f096..d7bd298f7e4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/PutScriptRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/PutScriptRequest.g.cs @@ -32,18 +32,27 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class PutScriptRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// 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. +/// /// public sealed partial class PutScriptRequest : PlainRequest { @@ -64,26 +73,37 @@ public PutScriptRequest(Elastic.Clients.Elasticsearch.Id id, Elastic.Clients.Ela internal override string OperationName => "put_script"; /// - /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Contains the script or search template, its parameters, and its language. + /// + /// Contains the script or search template, its parameters, and its language. + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.StoredScript Script { get; set; } } /// -/// 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. +/// /// public sealed partial class PutScriptRequestDescriptor : RequestDescriptor, PutScriptRequestParameters> { @@ -125,7 +145,9 @@ public PutScriptRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id private Action ScriptDescriptorAction { get; set; } /// - /// Contains the script or search template, its parameters, and its language. + /// + /// Contains the script or search template, its parameters, and its language. + /// /// public PutScriptRequestDescriptor Script(Elastic.Clients.Elasticsearch.StoredScript script) { @@ -175,7 +197,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// 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. +/// /// public sealed partial class PutScriptRequestDescriptor : RequestDescriptor { @@ -217,7 +242,9 @@ public PutScriptRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id id) private Action ScriptDescriptorAction { get; set; } /// - /// Contains the script or search template, its parameters, and its language. + /// + /// Contains the script or search template, its parameters, and its language. + /// /// public PutScriptRequestDescriptor Script(Elastic.Clients.Elasticsearch.StoredScript script) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/PutScriptResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/PutScriptResponse.g.cs index 94467b97c47..7b863a48caa 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/PutScriptResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/PutScriptResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class PutScriptResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/DeleteRulesetRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/DeleteRulesetRequest.g.cs index 4eafd31e9d1..7d8fcd80b50 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/DeleteRulesetRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/DeleteRulesetRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class DeleteRulesetRequestParameters : RequestParameters } /// -/// Deletes a query ruleset. +/// +/// Deletes a query ruleset. +/// /// public sealed partial class DeleteRulesetRequest : PlainRequest { @@ -52,7 +54,9 @@ public DeleteRulesetRequest(Elastic.Clients.Elasticsearch.Id rulesetId) : base(r } /// -/// Deletes a query ruleset. +/// +/// Deletes a query ruleset. +/// /// public sealed partial class DeleteRulesetRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/DeleteRulesetResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/DeleteRulesetResponse.g.cs index bd5791b7db2..eb6ccc13ee9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/DeleteRulesetResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/DeleteRulesetResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.QueryRules; public sealed partial class DeleteRulesetResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/GetRulesetRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/GetRulesetRequest.g.cs index edea075b64e..86f6758bf21 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/GetRulesetRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/GetRulesetRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class GetRulesetRequestParameters : RequestParameters } /// -/// Returns the details about a query ruleset +/// +/// Returns the details about a query ruleset +/// /// public sealed partial class GetRulesetRequest : PlainRequest { @@ -52,7 +54,9 @@ public GetRulesetRequest(Elastic.Clients.Elasticsearch.Id rulesetId) : base(r => } /// -/// Returns the details about a query ruleset +/// +/// Returns the details about a query ruleset +/// /// public sealed partial class GetRulesetRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/GetRulesetResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/GetRulesetResponse.g.cs index 5b50050fe39..c0fef19badb 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/GetRulesetResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/GetRulesetResponse.g.cs @@ -29,13 +29,17 @@ namespace Elastic.Clients.Elasticsearch.QueryRules; public sealed partial class GetRulesetResponse : ElasticsearchResponse { /// - /// Rules associated with the query ruleset + /// + /// Rules associated with the query ruleset + /// /// [JsonInclude, JsonPropertyName("rules")] public IReadOnlyCollection Rules { get; init; } /// - /// Query Ruleset unique identifier + /// + /// Query Ruleset unique identifier + /// /// [JsonInclude, JsonPropertyName("ruleset_id")] public string RulesetId { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/ListRulesetsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/ListRulesetsRequest.g.cs index 2340836a6bd..08fa5109ef0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/ListRulesetsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/ListRulesetsRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.QueryRules; public sealed partial class ListRulesetsRequestParameters : RequestParameters { /// - /// Starting offset (default: 0) + /// + /// Starting offset (default: 0) + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// specifies a max number of results to get + /// + /// specifies a max number of results to get + /// /// public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Returns summarized information about existing query rulesets. +/// +/// Returns summarized information about existing query rulesets. +/// /// public sealed partial class ListRulesetsRequest : PlainRequest { @@ -56,20 +62,26 @@ public sealed partial class ListRulesetsRequest : PlainRequest "query_rules.list_rulesets"; /// - /// Starting offset (default: 0) + /// + /// Starting offset (default: 0) + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// specifies a max number of results to get + /// + /// specifies a max number of results to get + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Returns summarized information about existing query rulesets. +/// +/// Returns summarized information about existing query rulesets. +/// /// public sealed partial class ListRulesetsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/PutRulesetRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/PutRulesetRequest.g.cs index c86a73ac42e..a2085a858f7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/PutRulesetRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/PutRulesetRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class PutRulesetRequestParameters : RequestParameters } /// -/// Creates or updates a query ruleset. +/// +/// Creates or updates a query ruleset. +/// /// public sealed partial class PutRulesetRequest : PlainRequest { @@ -56,7 +58,9 @@ public PutRulesetRequest(Elastic.Clients.Elasticsearch.Id rulesetId) : base(r => } /// -/// Creates or updates a query ruleset. +/// +/// Creates or updates a query ruleset. +/// /// public sealed partial class PutRulesetRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/RankEvalRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/RankEvalRequest.g.cs index c5a343c35d4..c33e75d8303 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/RankEvalRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/RankEvalRequest.g.cs @@ -32,28 +32,38 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class RankEvalRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// + /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, missing or closed indices are not included in the response. + /// + /// If true, missing or closed indices are not included in the response. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Search operation type + /// + /// Search operation type + /// /// public string? SearchType { get => Q("search_type"); set => Q("search_type", value); } } /// -/// Enables you to evaluate the quality of ranked search results over a set of typical search queries. +/// +/// Enables you to evaluate the quality of ranked search results over a set of typical search queries. +/// /// public sealed partial class RankEvalRequest : PlainRequest { @@ -74,44 +84,58 @@ public RankEvalRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r internal override string OperationName => "rank_eval"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// + /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, missing or closed indices are not included in the response. + /// + /// If true, missing or closed indices are not included in the response. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Search operation type + /// + /// Search operation type + /// /// [JsonIgnore] public string? SearchType { get => Q("search_type"); set => Q("search_type", value); } /// - /// Definition of the evaluation metric to calculate. + /// + /// Definition of the evaluation metric to calculate. + /// /// [JsonInclude, JsonPropertyName("metric")] public Elastic.Clients.Elasticsearch.Core.RankEval.RankEvalMetric? Metric { get; set; } /// - /// A set of typical search requests, together with their provided ratings. + /// + /// A set of typical search requests, together with their provided ratings. + /// /// [JsonInclude, JsonPropertyName("requests")] public ICollection Requests { get; set; } } /// -/// Enables you to evaluate the quality of ranked search results over a set of typical search queries. +/// +/// Enables you to evaluate the quality of ranked search results over a set of typical search queries. +/// /// public sealed partial class RankEvalRequestDescriptor : RequestDescriptor, RankEvalRequestParameters> { @@ -153,7 +177,9 @@ public RankEvalRequestDescriptor Indices(Elastic.Clients.Elasticsearc private Action>[] RequestsDescriptorActions { get; set; } /// - /// Definition of the evaluation metric to calculate. + /// + /// Definition of the evaluation metric to calculate. + /// /// public RankEvalRequestDescriptor Metric(Elastic.Clients.Elasticsearch.Core.RankEval.RankEvalMetric? metric) { @@ -180,7 +206,9 @@ public RankEvalRequestDescriptor Metric(Action - /// A set of typical search requests, together with their provided ratings. + /// + /// A set of typical search requests, together with their provided ratings. + /// /// public RankEvalRequestDescriptor Requests(ICollection requests) { @@ -273,7 +301,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Enables you to evaluate the quality of ranked search results over a set of typical search queries. +/// +/// Enables you to evaluate the quality of ranked search results over a set of typical search queries. +/// /// public sealed partial class RankEvalRequestDescriptor : RequestDescriptor { @@ -315,7 +345,9 @@ public RankEvalRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? private Action[] RequestsDescriptorActions { get; set; } /// - /// Definition of the evaluation metric to calculate. + /// + /// Definition of the evaluation metric to calculate. + /// /// public RankEvalRequestDescriptor Metric(Elastic.Clients.Elasticsearch.Core.RankEval.RankEvalMetric? metric) { @@ -342,7 +374,9 @@ public RankEvalRequestDescriptor Metric(Action - /// A set of typical search requests, together with their provided ratings. + /// + /// A set of typical search requests, together with their provided ratings. + /// /// public RankEvalRequestDescriptor Requests(ICollection requests) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/RankEvalResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/RankEvalResponse.g.cs index 601af7c9338..c8fffdd414c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/RankEvalResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/RankEvalResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class RankEvalResponse : ElasticsearchResponse { /// - /// The details section contains one entry for every query in the original requests section, keyed by the search request id + /// + /// The details section contains one entry for every query in the original requests section, keyed by the search request id + /// /// [JsonInclude, JsonPropertyName("details")] public IReadOnlyDictionary Details { get; init; } @@ -37,7 +39,9 @@ public sealed partial class RankEvalResponse : ElasticsearchResponse public IReadOnlyDictionary Failures { get; init; } /// - /// The overall evaluation quality calculated by the defined metric + /// + /// The overall evaluation quality calculated by the defined metric + /// /// [JsonInclude, JsonPropertyName("metric_score")] public double MetricScore { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ReindexRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ReindexRequest.g.cs index 8a40d7d29af..f3e99551850 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ReindexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ReindexRequest.g.cs @@ -32,48 +32,70 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class ReindexRequestParameters : RequestParameters { /// - /// If `true`, the request refreshes affected shards to make this operation visible to search. + /// + /// If true, the request refreshes affected shards to make this operation visible to search. + /// /// public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// The throttle for this request in sub-requests per second.
Defaults to no throttle. + /// + /// The throttle for this request in sub-requests per second. + /// Defaults to no throttle. + /// /// public float? RequestsPerSecond { get => Q("requests_per_second"); set => Q("requests_per_second", value); } /// - /// If `true`, the destination must be an index alias. + /// + /// If true, the destination must be an index alias. + /// /// public bool? RequireAlias { get => Q("require_alias"); set => Q("require_alias", value); } /// - /// Specifies how long a consistent view of the index should be maintained for scrolled search. + /// + /// Specifies how long a consistent view of the index should be maintained for scrolled search. + /// /// public Elastic.Clients.Elasticsearch.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); } /// - /// The number of slices this task should be divided into.
Defaults to 1 slice, meaning the task isn’t sliced into subtasks. + /// + /// The number of slices this task should be divided into. + /// Defaults to 1 slice, meaning the task isn’t sliced into subtasks. + /// /// public Elastic.Clients.Elasticsearch.Slices? Slices { get => Q("slices"); set => Q("slices", value); } /// - /// Period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards. + /// + /// Period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } /// - /// If `true`, the request blocks until the operation is complete. + /// + /// If true, the request blocks until the operation is complete. + /// /// public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Reindex documents.
Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. +/// +/// Reindex documents. +/// Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. +/// /// public sealed partial class ReindexRequest : PlainRequest { @@ -86,73 +108,100 @@ public sealed partial class ReindexRequest : PlainRequest "reindex"; /// - /// If `true`, the request refreshes affected shards to make this operation visible to search. + /// + /// If true, the request refreshes affected shards to make this operation visible to search. + /// /// [JsonIgnore] public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// The throttle for this request in sub-requests per second.
Defaults to no throttle. + /// + /// The throttle for this request in sub-requests per second. + /// Defaults to no throttle. + /// /// [JsonIgnore] public float? RequestsPerSecond { get => Q("requests_per_second"); set => Q("requests_per_second", value); } /// - /// If `true`, the destination must be an index alias. + /// + /// If true, the destination must be an index alias. + /// /// [JsonIgnore] public bool? RequireAlias { get => Q("require_alias"); set => Q("require_alias", value); } /// - /// Specifies how long a consistent view of the index should be maintained for scrolled search. + /// + /// Specifies how long a consistent view of the index should be maintained for scrolled search. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); } /// - /// The number of slices this task should be divided into.
Defaults to 1 slice, meaning the task isn’t sliced into subtasks. + /// + /// The number of slices this task should be divided into. + /// Defaults to 1 slice, meaning the task isn’t sliced into subtasks. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Slices? Slices { get => Q("slices"); set => Q("slices", value); } /// - /// Period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards. + /// + /// Period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } /// - /// If `true`, the request blocks until the operation is complete. + /// + /// If true, the request blocks until the operation is complete. + /// /// [JsonIgnore] public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } /// - /// Set to proceed to continue reindexing even if there are conflicts. + /// + /// Set to proceed to continue reindexing even if there are conflicts. + /// /// [JsonInclude, JsonPropertyName("conflicts")] public Elastic.Clients.Elasticsearch.Conflicts? Conflicts { get; set; } /// - /// The destination you are copying to. + /// + /// The destination you are copying to. + /// /// [JsonInclude, JsonPropertyName("dest")] public Elastic.Clients.Elasticsearch.Core.Reindex.Destination Dest { get; set; } /// - /// The maximum number of documents to reindex. + /// + /// The maximum number of documents to reindex. + /// /// [JsonInclude, JsonPropertyName("max_docs")] public long? MaxDocs { get; set; } /// - /// The script to run to update the document source or metadata when reindexing. + /// + /// The script to run to update the document source or metadata when reindexing. + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Script? Script { get; set; } @@ -160,14 +209,19 @@ public sealed partial class ReindexRequest : PlainRequest - /// The source you are copying from. + /// + /// The source you are copying from. + /// /// [JsonInclude, JsonPropertyName("source")] public Elastic.Clients.Elasticsearch.Core.Reindex.Source Source { get; set; } } /// -/// Reindex documents.
Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. +/// +/// Reindex documents. +/// Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. +/// /// public sealed partial class ReindexRequestDescriptor : RequestDescriptor, ReindexRequestParameters> { @@ -208,7 +262,9 @@ public ReindexRequestDescriptor() private Action> SourceDescriptorAction { get; set; } /// - /// Set to proceed to continue reindexing even if there are conflicts. + /// + /// Set to proceed to continue reindexing even if there are conflicts. + /// /// public ReindexRequestDescriptor Conflicts(Elastic.Clients.Elasticsearch.Conflicts? conflicts) { @@ -217,7 +273,9 @@ public ReindexRequestDescriptor Conflicts(Elastic.Clients.Elasticsear } /// - /// The destination you are copying to. + /// + /// The destination you are copying to. + /// /// public ReindexRequestDescriptor Dest(Elastic.Clients.Elasticsearch.Core.Reindex.Destination dest) { @@ -244,7 +302,9 @@ public ReindexRequestDescriptor Dest(Action - /// The maximum number of documents to reindex. + /// + /// The maximum number of documents to reindex. + /// /// public ReindexRequestDescriptor MaxDocs(long? maxDocs) { @@ -253,7 +313,9 @@ public ReindexRequestDescriptor MaxDocs(long? maxDocs) } /// - /// The script to run to update the document source or metadata when reindexing. + /// + /// The script to run to update the document source or metadata when reindexing. + /// /// public ReindexRequestDescriptor Script(Elastic.Clients.Elasticsearch.Script? script) { @@ -286,7 +348,9 @@ public ReindexRequestDescriptor Size(long? size) } /// - /// The source you are copying from. + /// + /// The source you are copying from. + /// /// public ReindexRequestDescriptor Source(Elastic.Clients.Elasticsearch.Core.Reindex.Source source) { @@ -386,7 +450,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Reindex documents.
Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. +/// +/// Reindex documents. +/// Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. +/// /// public sealed partial class ReindexRequestDescriptor : RequestDescriptor { @@ -427,7 +494,9 @@ public ReindexRequestDescriptor() private Action SourceDescriptorAction { get; set; } /// - /// Set to proceed to continue reindexing even if there are conflicts. + /// + /// Set to proceed to continue reindexing even if there are conflicts. + /// /// public ReindexRequestDescriptor Conflicts(Elastic.Clients.Elasticsearch.Conflicts? conflicts) { @@ -436,7 +505,9 @@ public ReindexRequestDescriptor Conflicts(Elastic.Clients.Elasticsearch.Conflict } /// - /// The destination you are copying to. + /// + /// The destination you are copying to. + /// /// public ReindexRequestDescriptor Dest(Elastic.Clients.Elasticsearch.Core.Reindex.Destination dest) { @@ -463,7 +534,9 @@ public ReindexRequestDescriptor Dest(Action - /// The maximum number of documents to reindex. + /// + /// The maximum number of documents to reindex. + /// /// public ReindexRequestDescriptor MaxDocs(long? maxDocs) { @@ -472,7 +545,9 @@ public ReindexRequestDescriptor MaxDocs(long? maxDocs) } /// - /// The script to run to update the document source or metadata when reindexing. + /// + /// The script to run to update the document source or metadata when reindexing. + /// /// public ReindexRequestDescriptor Script(Elastic.Clients.Elasticsearch.Script? script) { @@ -505,7 +580,9 @@ public ReindexRequestDescriptor Size(long? size) } /// - /// The source you are copying from. + /// + /// The source you are copying from. + /// /// public ReindexRequestDescriptor Source(Elastic.Clients.Elasticsearch.Core.Reindex.Source source) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ReindexRethrottleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ReindexRethrottleRequest.g.cs index 99e11b67139..964bdd57eec 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ReindexRethrottleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ReindexRethrottleRequest.g.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class ReindexRethrottleRequestParameters : RequestParameters { /// - /// The throttle for this request in sub-requests per second. + /// + /// The throttle for this request in sub-requests per second. + /// /// public float? RequestsPerSecond { get => Q("requests_per_second"); set => Q("requests_per_second", value); } } /// -/// Copies documents from a source to a destination. +/// +/// Copies documents from a source to a destination. +/// /// public sealed partial class ReindexRethrottleRequest : PlainRequest { @@ -55,14 +59,18 @@ public ReindexRethrottleRequest(Elastic.Clients.Elasticsearch.Id taskId) : base( internal override string OperationName => "reindex_rethrottle"; /// - /// The throttle for this request in sub-requests per second. + /// + /// The throttle for this request in sub-requests per second. + /// /// [JsonIgnore] public float? RequestsPerSecond { get => Q("requests_per_second"); set => Q("requests_per_second", value); } } /// -/// Copies documents from a source to a destination. +/// +/// Copies documents from a source to a destination. +/// /// public sealed partial class ReindexRethrottleRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/RenderSearchTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/RenderSearchTemplateRequest.g.cs index 0e9288b351b..c57cc798307 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/RenderSearchTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/RenderSearchTemplateRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class RenderSearchTemplateRequestParameters : RequestParam } /// -/// Renders a search template as a search request body. +/// +/// Renders a search template as a search request body. +/// /// public sealed partial class RenderSearchTemplateRequest : PlainRequest { @@ -58,20 +60,31 @@ public RenderSearchTemplateRequest(Elastic.Clients.Elasticsearch.Id? id) : base( public string? File { get; set; } /// - /// Key-value pairs used to replace Mustache variables in the template.
The key is the variable name.
The value is the variable value. + /// + /// Key-value pairs used to replace Mustache variables in the template. + /// The key is the variable name. + /// The value is the variable value. + /// /// [JsonInclude, JsonPropertyName("params")] public IDictionary? Params { get; set; } /// - /// An inline search template.
Supports the same parameters as the search API's request body.
These parameters also support Mustache variables.
If no `id` or `` is specified, this parameter is required. + /// + /// An inline search template. + /// Supports the same parameters as the search API's request body. + /// These parameters also support Mustache variables. + /// If no id or <templated-id> is specified, this parameter is required. + /// /// [JsonInclude, JsonPropertyName("source")] public string? Source { get; set; } } /// -/// Renders a search template as a search request body. +/// +/// Renders a search template as a search request body. +/// /// public sealed partial class RenderSearchTemplateRequestDescriptor : RequestDescriptor, RenderSearchTemplateRequestParameters> { @@ -110,7 +123,11 @@ public RenderSearchTemplateRequestDescriptor File(string? file) } /// - /// Key-value pairs used to replace Mustache variables in the template.
The key is the variable name.
The value is the variable value. + /// + /// Key-value pairs used to replace Mustache variables in the template. + /// The key is the variable name. + /// The value is the variable value. + /// /// public RenderSearchTemplateRequestDescriptor Params(Func, FluentDictionary> selector) { @@ -119,7 +136,12 @@ public RenderSearchTemplateRequestDescriptor Params(Func - /// An inline search template.
Supports the same parameters as the search API's request body.
These parameters also support Mustache variables.
If no `id` or `` is specified, this parameter is required. + /// + /// An inline search template. + /// Supports the same parameters as the search API's request body. + /// These parameters also support Mustache variables. + /// If no id or <templated-id> is specified, this parameter is required. + /// /// public RenderSearchTemplateRequestDescriptor Source(string? source) { @@ -153,7 +175,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Renders a search template as a search request body. +/// +/// Renders a search template as a search request body. +/// /// public sealed partial class RenderSearchTemplateRequestDescriptor : RequestDescriptor { @@ -192,7 +216,11 @@ public RenderSearchTemplateRequestDescriptor File(string? file) } /// - /// Key-value pairs used to replace Mustache variables in the template.
The key is the variable name.
The value is the variable value. + /// + /// Key-value pairs used to replace Mustache variables in the template. + /// The key is the variable name. + /// The value is the variable value. + /// /// public RenderSearchTemplateRequestDescriptor Params(Func, FluentDictionary> selector) { @@ -201,7 +229,12 @@ public RenderSearchTemplateRequestDescriptor Params(Func - /// An inline search template.
Supports the same parameters as the search API's request body.
These parameters also support Mustache variables.
If no `id` or `` is specified, this parameter is required. + /// + /// An inline search template. + /// Supports the same parameters as the search API's request body. + /// These parameters also support Mustache variables. + /// If no id or <templated-id> is specified, this parameter is required. + /// /// public RenderSearchTemplateRequestDescriptor Source(string? source) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/DeleteJobRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/DeleteJobRequest.g.cs index 9a06a2f74e5..ba90b328ef7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/DeleteJobRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/DeleteJobRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class DeleteJobRequestParameters : RequestParameters } /// -/// Deletes an existing rollup job. +/// +/// Deletes an existing rollup job. +/// /// public sealed partial class DeleteJobRequest : PlainRequest { @@ -52,7 +54,9 @@ public DeleteJobRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Requi } /// -/// Deletes an existing rollup job. +/// +/// Deletes an existing rollup job. +/// /// public sealed partial class DeleteJobRequestDescriptor : RequestDescriptor, DeleteJobRequestParameters> { @@ -82,7 +86,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Deletes an existing rollup job. +/// +/// Deletes an existing rollup job. +/// /// public sealed partial class DeleteJobRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/GetJobsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/GetJobsRequest.g.cs index 96e9bdbd2aa..e00924a4de1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/GetJobsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/GetJobsRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class GetJobsRequestParameters : RequestParameters } /// -/// Retrieves the configuration, stats, and status of rollup jobs. +/// +/// Retrieves the configuration, stats, and status of rollup jobs. +/// /// public sealed partial class GetJobsRequest : PlainRequest { @@ -56,7 +58,9 @@ public GetJobsRequest(Elastic.Clients.Elasticsearch.Id? id) : base(r => r.Option } /// -/// Retrieves the configuration, stats, and status of rollup jobs. +/// +/// Retrieves the configuration, stats, and status of rollup jobs. +/// /// public sealed partial class GetJobsRequestDescriptor : RequestDescriptor, GetJobsRequestParameters> { @@ -90,7 +94,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Retrieves the configuration, stats, and status of rollup jobs. +/// +/// Retrieves the configuration, stats, and status of rollup jobs. +/// /// public sealed partial class GetJobsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/GetRollupCapsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/GetRollupCapsRequest.g.cs index d2d870f6b46..6f27f76a99e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/GetRollupCapsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/GetRollupCapsRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class GetRollupCapsRequestParameters : RequestParameters } /// -/// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. +/// +/// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. +/// /// public sealed partial class GetRollupCapsRequest : PlainRequest { @@ -56,7 +58,9 @@ public GetRollupCapsRequest(Elastic.Clients.Elasticsearch.Id? id) : base(r => r. } /// -/// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. +/// +/// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. +/// /// public sealed partial class GetRollupCapsRequestDescriptor : RequestDescriptor, GetRollupCapsRequestParameters> { @@ -90,7 +94,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. +/// +/// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. +/// /// public sealed partial class GetRollupCapsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/GetRollupIndexCapsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/GetRollupIndexCapsRequest.g.cs index 6c403eb36fe..0b3df7b26d9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/GetRollupIndexCapsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/GetRollupIndexCapsRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class GetRollupIndexCapsRequestParameters : RequestParamet } /// -/// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). +/// +/// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). +/// /// public sealed partial class GetRollupIndexCapsRequest : PlainRequest { @@ -52,7 +54,9 @@ public GetRollupIndexCapsRequest(Elastic.Clients.Elasticsearch.Ids index) : base } /// -/// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). +/// +/// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). +/// /// public sealed partial class GetRollupIndexCapsRequestDescriptor : RequestDescriptor, GetRollupIndexCapsRequestParameters> { @@ -82,7 +86,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). +/// +/// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). +/// /// public sealed partial class GetRollupIndexCapsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/PutJobRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/PutJobRequest.g.cs index 64c4cddfd43..d31d0c08652 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/PutJobRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/PutJobRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class PutJobRequestParameters : RequestParameters } /// -/// Creates a rollup job. +/// +/// Creates a rollup job. +/// /// public sealed partial class PutJobRequest : PlainRequest { @@ -51,13 +53,25 @@ public PutJobRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required internal override string OperationName => "rollup.put_job"; /// - /// A cron string which defines the intervals when the rollup job should be executed. When the interval
triggers, the indexer attempts to rollup the data in the index pattern. The cron pattern is unrelated
to the time interval of the data being rolled up. For example, you may wish to create hourly rollups
of your document but to only run the indexer on a daily basis at midnight, as defined by the cron. The
cron pattern is defined just like a Watcher cron schedule. + /// + /// A cron string which defines the intervals when the rollup job should be executed. When the interval + /// triggers, the indexer attempts to rollup the data in the index pattern. The cron pattern is unrelated + /// to the time interval of the data being rolled up. For example, you may wish to create hourly rollups + /// of your document but to only run the indexer on a daily basis at midnight, as defined by the cron. The + /// cron pattern is defined just like a Watcher cron schedule. + /// /// [JsonInclude, JsonPropertyName("cron")] public string Cron { get; set; } /// - /// Defines the grouping fields and aggregations that are defined for this rollup job. These fields will then be
available later for aggregating into buckets. These aggs and fields can be used in any combination. Think of
the groups configuration as defining a set of tools that can later be used in aggregations to partition the
data. Unlike raw data, we have to think ahead to which fields and aggregations might be used. Rollups provide
enough flexibility that you simply need to determine which fields are needed, not in what order they are needed. + /// + /// Defines the grouping fields and aggregations that are defined for this rollup job. These fields will then be + /// available later for aggregating into buckets. These aggs and fields can be used in any combination. Think of + /// the groups configuration as defining a set of tools that can later be used in aggregations to partition the + /// data. Unlike raw data, we have to think ahead to which fields and aggregations might be used. Rollups provide + /// enough flexibility that you simply need to determine which fields are needed, not in what order they are needed. + /// /// [JsonInclude, JsonPropertyName("groups")] public Elastic.Clients.Elasticsearch.Rollup.Groupings Groups { get; set; } @@ -65,38 +79,55 @@ public PutJobRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required public IDictionary>>? Headers { get; set; } /// - /// The index or index pattern to roll up. Supports wildcard-style patterns (`logstash-*`). The job attempts to
rollup the entire index or index-pattern. + /// + /// The index or index pattern to roll up. Supports wildcard-style patterns (logstash-*). The job attempts to + /// rollup the entire index or index-pattern. + /// /// [JsonInclude, JsonPropertyName("index_pattern")] public string IndexPattern { get; set; } /// - /// Defines the metrics to collect for each grouping tuple. By default, only the doc_counts are collected for each
group. To make rollup useful, you will often add metrics like averages, mins, maxes, etc. Metrics are defined
on a per-field basis and for each field you configure which metric should be collected. + /// + /// Defines the metrics to collect for each grouping tuple. By default, only the doc_counts are collected for each + /// group. To make rollup useful, you will often add metrics like averages, mins, maxes, etc. Metrics are defined + /// on a per-field basis and for each field you configure which metric should be collected. + /// /// [JsonInclude, JsonPropertyName("metrics")] public ICollection? Metrics { get; set; } /// - /// The number of bucket results that are processed on each iteration of the rollup indexer. A larger value tends
to execute faster, but requires more memory during processing. This value has no effect on how the data is
rolled up; it is merely used for tweaking the speed or memory cost of the indexer. + /// + /// The number of bucket results that are processed on each iteration of the rollup indexer. A larger value tends + /// to execute faster, but requires more memory during processing. This value has no effect on how the data is + /// rolled up; it is merely used for tweaking the speed or memory cost of the indexer. + /// /// [JsonInclude, JsonPropertyName("page_size")] public int PageSize { get; set; } /// - /// The index that contains the rollup results. The index can be shared with other rollup jobs. The data is stored so that it doesn’t interfere with unrelated jobs. + /// + /// The index that contains the rollup results. The index can be shared with other rollup jobs. The data is stored so that it doesn’t interfere with unrelated jobs. + /// /// [JsonInclude, JsonPropertyName("rollup_index")] public Elastic.Clients.Elasticsearch.IndexName RollupIndex { get; set; } /// - /// Time to wait for the request to complete. + /// + /// Time to wait for the request to complete. + /// /// [JsonInclude, JsonPropertyName("timeout")] public Elastic.Clients.Elasticsearch.Duration? Timeout { get; set; } } /// -/// Creates a rollup job. +/// +/// Creates a rollup job. +/// /// public sealed partial class PutJobRequestDescriptor : RequestDescriptor, PutJobRequestParameters> { @@ -135,7 +166,13 @@ public PutJobRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id id private Elastic.Clients.Elasticsearch.Duration? TimeoutValue { get; set; } /// - /// A cron string which defines the intervals when the rollup job should be executed. When the interval
triggers, the indexer attempts to rollup the data in the index pattern. The cron pattern is unrelated
to the time interval of the data being rolled up. For example, you may wish to create hourly rollups
of your document but to only run the indexer on a daily basis at midnight, as defined by the cron. The
cron pattern is defined just like a Watcher cron schedule. + /// + /// A cron string which defines the intervals when the rollup job should be executed. When the interval + /// triggers, the indexer attempts to rollup the data in the index pattern. The cron pattern is unrelated + /// to the time interval of the data being rolled up. For example, you may wish to create hourly rollups + /// of your document but to only run the indexer on a daily basis at midnight, as defined by the cron. The + /// cron pattern is defined just like a Watcher cron schedule. + /// /// public PutJobRequestDescriptor Cron(string cron) { @@ -144,7 +181,13 @@ public PutJobRequestDescriptor Cron(string cron) } /// - /// Defines the grouping fields and aggregations that are defined for this rollup job. These fields will then be
available later for aggregating into buckets. These aggs and fields can be used in any combination. Think of
the groups configuration as defining a set of tools that can later be used in aggregations to partition the
data. Unlike raw data, we have to think ahead to which fields and aggregations might be used. Rollups provide
enough flexibility that you simply need to determine which fields are needed, not in what order they are needed. + /// + /// Defines the grouping fields and aggregations that are defined for this rollup job. These fields will then be + /// available later for aggregating into buckets. These aggs and fields can be used in any combination. Think of + /// the groups configuration as defining a set of tools that can later be used in aggregations to partition the + /// data. Unlike raw data, we have to think ahead to which fields and aggregations might be used. Rollups provide + /// enough flexibility that you simply need to determine which fields are needed, not in what order they are needed. + /// /// public PutJobRequestDescriptor Groups(Elastic.Clients.Elasticsearch.Rollup.Groupings groups) { @@ -177,7 +220,10 @@ public PutJobRequestDescriptor Headers(Func - /// The index or index pattern to roll up. Supports wildcard-style patterns (`logstash-*`). The job attempts to
rollup the entire index or index-pattern. + /// + /// The index or index pattern to roll up. Supports wildcard-style patterns (logstash-*). The job attempts to + /// rollup the entire index or index-pattern. + /// /// public PutJobRequestDescriptor IndexPattern(string indexPattern) { @@ -186,7 +232,11 @@ public PutJobRequestDescriptor IndexPattern(string indexPattern) } /// - /// Defines the metrics to collect for each grouping tuple. By default, only the doc_counts are collected for each
group. To make rollup useful, you will often add metrics like averages, mins, maxes, etc. Metrics are defined
on a per-field basis and for each field you configure which metric should be collected. + /// + /// Defines the metrics to collect for each grouping tuple. By default, only the doc_counts are collected for each + /// group. To make rollup useful, you will often add metrics like averages, mins, maxes, etc. Metrics are defined + /// on a per-field basis and for each field you configure which metric should be collected. + /// /// public PutJobRequestDescriptor Metrics(ICollection? metrics) { @@ -225,7 +275,11 @@ public PutJobRequestDescriptor Metrics(params Action - /// The number of bucket results that are processed on each iteration of the rollup indexer. A larger value tends
to execute faster, but requires more memory during processing. This value has no effect on how the data is
rolled up; it is merely used for tweaking the speed or memory cost of the indexer. + /// + /// The number of bucket results that are processed on each iteration of the rollup indexer. A larger value tends + /// to execute faster, but requires more memory during processing. This value has no effect on how the data is + /// rolled up; it is merely used for tweaking the speed or memory cost of the indexer. + /// /// public PutJobRequestDescriptor PageSize(int pageSize) { @@ -234,7 +288,9 @@ public PutJobRequestDescriptor PageSize(int pageSize) } /// - /// The index that contains the rollup results. The index can be shared with other rollup jobs. The data is stored so that it doesn’t interfere with unrelated jobs. + /// + /// The index that contains the rollup results. The index can be shared with other rollup jobs. The data is stored so that it doesn’t interfere with unrelated jobs. + /// /// public PutJobRequestDescriptor RollupIndex(Elastic.Clients.Elasticsearch.IndexName rollupIndex) { @@ -243,7 +299,9 @@ public PutJobRequestDescriptor RollupIndex(Elastic.Clients.Elasticsea } /// - /// Time to wait for the request to complete. + /// + /// Time to wait for the request to complete. + /// /// public PutJobRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Duration? timeout) { @@ -326,7 +384,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Creates a rollup job. +/// +/// Creates a rollup job. +/// /// public sealed partial class PutJobRequestDescriptor : RequestDescriptor { @@ -365,7 +425,13 @@ public PutJobRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id id) private Elastic.Clients.Elasticsearch.Duration? TimeoutValue { get; set; } /// - /// A cron string which defines the intervals when the rollup job should be executed. When the interval
triggers, the indexer attempts to rollup the data in the index pattern. The cron pattern is unrelated
to the time interval of the data being rolled up. For example, you may wish to create hourly rollups
of your document but to only run the indexer on a daily basis at midnight, as defined by the cron. The
cron pattern is defined just like a Watcher cron schedule. + /// + /// A cron string which defines the intervals when the rollup job should be executed. When the interval + /// triggers, the indexer attempts to rollup the data in the index pattern. The cron pattern is unrelated + /// to the time interval of the data being rolled up. For example, you may wish to create hourly rollups + /// of your document but to only run the indexer on a daily basis at midnight, as defined by the cron. The + /// cron pattern is defined just like a Watcher cron schedule. + /// /// public PutJobRequestDescriptor Cron(string cron) { @@ -374,7 +440,13 @@ public PutJobRequestDescriptor Cron(string cron) } /// - /// Defines the grouping fields and aggregations that are defined for this rollup job. These fields will then be
available later for aggregating into buckets. These aggs and fields can be used in any combination. Think of
the groups configuration as defining a set of tools that can later be used in aggregations to partition the
data. Unlike raw data, we have to think ahead to which fields and aggregations might be used. Rollups provide
enough flexibility that you simply need to determine which fields are needed, not in what order they are needed. + /// + /// Defines the grouping fields and aggregations that are defined for this rollup job. These fields will then be + /// available later for aggregating into buckets. These aggs and fields can be used in any combination. Think of + /// the groups configuration as defining a set of tools that can later be used in aggregations to partition the + /// data. Unlike raw data, we have to think ahead to which fields and aggregations might be used. Rollups provide + /// enough flexibility that you simply need to determine which fields are needed, not in what order they are needed. + /// /// public PutJobRequestDescriptor Groups(Elastic.Clients.Elasticsearch.Rollup.Groupings groups) { @@ -407,7 +479,10 @@ public PutJobRequestDescriptor Headers(Func - /// The index or index pattern to roll up. Supports wildcard-style patterns (`logstash-*`). The job attempts to
rollup the entire index or index-pattern. + /// + /// The index or index pattern to roll up. Supports wildcard-style patterns (logstash-*). The job attempts to + /// rollup the entire index or index-pattern. + /// /// public PutJobRequestDescriptor IndexPattern(string indexPattern) { @@ -416,7 +491,11 @@ public PutJobRequestDescriptor IndexPattern(string indexPattern) } /// - /// Defines the metrics to collect for each grouping tuple. By default, only the doc_counts are collected for each
group. To make rollup useful, you will often add metrics like averages, mins, maxes, etc. Metrics are defined
on a per-field basis and for each field you configure which metric should be collected. + /// + /// Defines the metrics to collect for each grouping tuple. By default, only the doc_counts are collected for each + /// group. To make rollup useful, you will often add metrics like averages, mins, maxes, etc. Metrics are defined + /// on a per-field basis and for each field you configure which metric should be collected. + /// /// public PutJobRequestDescriptor Metrics(ICollection? metrics) { @@ -455,7 +534,11 @@ public PutJobRequestDescriptor Metrics(params Action - /// The number of bucket results that are processed on each iteration of the rollup indexer. A larger value tends
to execute faster, but requires more memory during processing. This value has no effect on how the data is
rolled up; it is merely used for tweaking the speed or memory cost of the indexer. + /// + /// The number of bucket results that are processed on each iteration of the rollup indexer. A larger value tends + /// to execute faster, but requires more memory during processing. This value has no effect on how the data is + /// rolled up; it is merely used for tweaking the speed or memory cost of the indexer. + /// /// public PutJobRequestDescriptor PageSize(int pageSize) { @@ -464,7 +547,9 @@ public PutJobRequestDescriptor PageSize(int pageSize) } /// - /// The index that contains the rollup results. The index can be shared with other rollup jobs. The data is stored so that it doesn’t interfere with unrelated jobs. + /// + /// The index that contains the rollup results. The index can be shared with other rollup jobs. The data is stored so that it doesn’t interfere with unrelated jobs. + /// /// public PutJobRequestDescriptor RollupIndex(Elastic.Clients.Elasticsearch.IndexName rollupIndex) { @@ -473,7 +558,9 @@ public PutJobRequestDescriptor RollupIndex(Elastic.Clients.Elasticsearch.IndexNa } /// - /// Time to wait for the request to complete. + /// + /// Time to wait for the request to complete. + /// /// public PutJobRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Duration? timeout) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/PutJobResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/PutJobResponse.g.cs index f778e93dd3b..4182c776136 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/PutJobResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/PutJobResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Rollup; public sealed partial class PutJobResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/RollupSearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/RollupSearchRequest.g.cs index c9f62965788..1b009faea0c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/RollupSearchRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/RollupSearchRequest.g.cs @@ -32,12 +32,16 @@ namespace Elastic.Clients.Elasticsearch.Rollup; public sealed partial class RollupSearchRequestParameters : RequestParameters { /// - /// Indicates whether hits.total should be rendered as an integer or an object in the rest search response + /// + /// Indicates whether hits.total should be rendered as an integer or an object in the rest search response + /// /// public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } /// - /// Specify whether aggregation and suggester names should be prefixed by their respective types in the response + /// + /// Specify whether aggregation and suggester names should be prefixed by their respective types in the response + /// /// public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } } @@ -103,7 +107,9 @@ public override void Write(Utf8JsonWriter writer, RollupSearchRequest value, Jso } /// -/// Enables searching rolled-up data using the standard Query DSL. +/// +/// Enables searching rolled-up data using the standard Query DSL. +/// /// [JsonConverter(typeof(RollupSearchRequestConverter))] public sealed partial class RollupSearchRequest : PlainRequest @@ -125,38 +131,50 @@ public RollupSearchRequest() internal override string OperationName => "rollup.rollup_search"; /// - /// Indicates whether hits.total should be rendered as an integer or an object in the rest search response + /// + /// Indicates whether hits.total should be rendered as an integer or an object in the rest search response + /// /// [JsonIgnore] public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } /// - /// Specify whether aggregation and suggester names should be prefixed by their respective types in the response + /// + /// Specify whether aggregation and suggester names should be prefixed by their respective types in the response + /// /// [JsonIgnore] public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } /// - /// Specifies aggregations. + /// + /// Specifies aggregations. + /// /// [JsonInclude, JsonPropertyName("aggregations")] public IDictionary? Aggregations { get; set; } /// - /// Specifies a DSL query. + /// + /// Specifies a DSL query. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Query { get; set; } /// - /// Must be zero if set, as rollups work on pre-aggregated data. + /// + /// Must be zero if set, as rollups work on pre-aggregated data. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } } /// -/// Enables searching rolled-up data using the standard Query DSL. +/// +/// Enables searching rolled-up data using the standard Query DSL. +/// /// public sealed partial class RollupSearchRequestDescriptor : RequestDescriptor, RollupSearchRequestParameters> { @@ -194,7 +212,9 @@ public RollupSearchRequestDescriptor Indices(Elastic.Clients.Elastics private int? SizeValue { get; set; } /// - /// Specifies aggregations. + /// + /// Specifies aggregations. + /// /// public RollupSearchRequestDescriptor Aggregations(Func>, FluentDescriptorDictionary>> selector) { @@ -203,7 +223,9 @@ public RollupSearchRequestDescriptor Aggregations(Func - /// Specifies a DSL query. + /// + /// Specifies a DSL query. + /// /// public RollupSearchRequestDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -230,7 +252,9 @@ public RollupSearchRequestDescriptor Query(Action - /// Must be zero if set, as rollups work on pre-aggregated data. + /// + /// Must be zero if set, as rollups work on pre-aggregated data. + /// /// public RollupSearchRequestDescriptor Size(int? size) { @@ -274,7 +298,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Enables searching rolled-up data using the standard Query DSL. +/// +/// Enables searching rolled-up data using the standard Query DSL. +/// /// public sealed partial class RollupSearchRequestDescriptor : RequestDescriptor { @@ -308,7 +334,9 @@ public RollupSearchRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indic private int? SizeValue { get; set; } /// - /// Specifies aggregations. + /// + /// Specifies aggregations. + /// /// public RollupSearchRequestDescriptor Aggregations(Func, FluentDescriptorDictionary> selector) { @@ -317,7 +345,9 @@ public RollupSearchRequestDescriptor Aggregations(Func - /// Specifies a DSL query. + /// + /// Specifies a DSL query. + /// /// public RollupSearchRequestDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -344,7 +374,9 @@ public RollupSearchRequestDescriptor Query(Action - /// Must be zero if set, as rollups work on pre-aggregated data. + /// + /// Must be zero if set, as rollups work on pre-aggregated data. + /// /// public RollupSearchRequestDescriptor Size(int? size) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/StartJobRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/StartJobRequest.g.cs index ff99c271936..7974557b569 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/StartJobRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/StartJobRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class StartJobRequestParameters : RequestParameters } /// -/// Starts an existing, stopped rollup job. +/// +/// Starts an existing, stopped rollup job. +/// /// public sealed partial class StartJobRequest : PlainRequest { @@ -52,7 +54,9 @@ public StartJobRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Requir } /// -/// Starts an existing, stopped rollup job. +/// +/// Starts an existing, stopped rollup job. +/// /// public sealed partial class StartJobRequestDescriptor : RequestDescriptor, StartJobRequestParameters> { @@ -82,7 +86,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Starts an existing, stopped rollup job. +/// +/// Starts an existing, stopped rollup job. +/// /// public sealed partial class StartJobRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/StopJobRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/StopJobRequest.g.cs index 55ae700dddb..ae497d7a765 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/StopJobRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/StopJobRequest.g.cs @@ -32,18 +32,26 @@ namespace Elastic.Clients.Elasticsearch.Rollup; public sealed partial class StopJobRequestParameters : RequestParameters { /// - /// If `wait_for_completion` is `true`, the API blocks for (at maximum) the specified duration while waiting for the job to stop.
If more than `timeout` time has passed, the API throws a timeout exception. + /// + /// If wait_for_completion is true, the API blocks for (at maximum) the specified duration while waiting for the job to stop. + /// If more than timeout time has passed, the API throws a timeout exception. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// If set to `true`, causes the API to block until the indexer state completely stops.
If set to `false`, the API returns immediately and the indexer is stopped asynchronously in the background. + /// + /// If set to true, causes the API to block until the indexer state completely stops. + /// If set to false, the API returns immediately and the indexer is stopped asynchronously in the background. + /// /// public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Stops an existing, started rollup job. +/// +/// Stops an existing, started rollup job. +/// /// public sealed partial class StopJobRequest : PlainRequest { @@ -60,20 +68,28 @@ public StopJobRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Require internal override string OperationName => "rollup.stop_job"; /// - /// If `wait_for_completion` is `true`, the API blocks for (at maximum) the specified duration while waiting for the job to stop.
If more than `timeout` time has passed, the API throws a timeout exception. + /// + /// If wait_for_completion is true, the API blocks for (at maximum) the specified duration while waiting for the job to stop. + /// If more than timeout time has passed, the API throws a timeout exception. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// If set to `true`, causes the API to block until the indexer state completely stops.
If set to `false`, the API returns immediately and the indexer is stopped asynchronously in the background. + /// + /// If set to true, causes the API to block until the indexer state completely stops. + /// If set to false, the API returns immediately and the indexer is stopped asynchronously in the background. + /// /// [JsonIgnore] public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Stops an existing, started rollup job. +/// +/// Stops an existing, started rollup job. +/// /// public sealed partial class StopJobRequestDescriptor : RequestDescriptor, StopJobRequestParameters> { @@ -106,7 +122,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Stops an existing, started rollup job. +/// +/// Stops an existing, started rollup job. +/// /// public sealed partial class StopJobRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ScriptsPainlessExecuteRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ScriptsPainlessExecuteRequest.g.cs index 77a41614ee8..df75176b920 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ScriptsPainlessExecuteRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ScriptsPainlessExecuteRequest.g.cs @@ -34,7 +34,10 @@ public sealed partial class ScriptsPainlessExecuteRequestParameters : RequestPar } /// -/// Run a script.
Runs a script and returns a result. +/// +/// Run a script. +/// Runs a script and returns a result. +/// /// public sealed partial class ScriptsPainlessExecuteRequest : PlainRequest { @@ -47,26 +50,35 @@ public sealed partial class ScriptsPainlessExecuteRequest : PlainRequest "scripts_painless_execute"; /// - /// The context that the script should run in. + /// + /// The context that the script should run in. + /// /// [JsonInclude, JsonPropertyName("context")] public string? Context { get; set; } /// - /// Additional parameters for the `context`. + /// + /// Additional parameters for the context. + /// /// [JsonInclude, JsonPropertyName("context_setup")] public Elastic.Clients.Elasticsearch.Core.ScriptsPainlessExecute.PainlessContextSetup? ContextSetup { get; set; } /// - /// The Painless script to execute. + /// + /// The Painless script to execute. + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Script? Script { get; set; } } /// -/// Run a script.
Runs a script and returns a result. +/// +/// Run a script. +/// Runs a script and returns a result. +/// /// public sealed partial class ScriptsPainlessExecuteRequestDescriptor : RequestDescriptor, ScriptsPainlessExecuteRequestParameters> { @@ -93,7 +105,9 @@ public ScriptsPainlessExecuteRequestDescriptor() private Action ScriptDescriptorAction { get; set; } /// - /// The context that the script should run in. + /// + /// The context that the script should run in. + /// /// public ScriptsPainlessExecuteRequestDescriptor Context(string? context) { @@ -102,7 +116,9 @@ public ScriptsPainlessExecuteRequestDescriptor Context(string? contex } /// - /// Additional parameters for the `context`. + /// + /// Additional parameters for the context. + /// /// public ScriptsPainlessExecuteRequestDescriptor ContextSetup(Elastic.Clients.Elasticsearch.Core.ScriptsPainlessExecute.PainlessContextSetup? contextSetup) { @@ -129,7 +145,9 @@ public ScriptsPainlessExecuteRequestDescriptor ContextSetup(Action - /// The Painless script to execute. + /// + /// The Painless script to execute. + /// /// public ScriptsPainlessExecuteRequestDescriptor Script(Elastic.Clients.Elasticsearch.Script? script) { @@ -201,7 +219,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Run a script.
Runs a script and returns a result. +/// +/// Run a script. +/// Runs a script and returns a result. +/// /// public sealed partial class ScriptsPainlessExecuteRequestDescriptor : RequestDescriptor { @@ -228,7 +249,9 @@ public ScriptsPainlessExecuteRequestDescriptor() private Action ScriptDescriptorAction { get; set; } /// - /// The context that the script should run in. + /// + /// The context that the script should run in. + /// /// public ScriptsPainlessExecuteRequestDescriptor Context(string? context) { @@ -237,7 +260,9 @@ public ScriptsPainlessExecuteRequestDescriptor Context(string? context) } /// - /// Additional parameters for the `context`. + /// + /// Additional parameters for the context. + /// /// public ScriptsPainlessExecuteRequestDescriptor ContextSetup(Elastic.Clients.Elasticsearch.Core.ScriptsPainlessExecute.PainlessContextSetup? contextSetup) { @@ -264,7 +289,9 @@ public ScriptsPainlessExecuteRequestDescriptor ContextSetup(Action - /// The Painless script to execute. + /// + /// The Painless script to execute. + /// /// public ScriptsPainlessExecuteRequestDescriptor Script(Elastic.Clients.Elasticsearch.Script? script) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ScrollRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ScrollRequest.g.cs index 1d3b63463e5..96182663489 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ScrollRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ScrollRequest.g.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class ScrollRequestParameters : RequestParameters { /// - /// If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object. + /// + /// If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object. + /// /// public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } } /// -/// Allows to retrieve a large numbers of results from a single search request. +/// +/// Allows to retrieve a large numbers of results from a single search request. +/// /// public sealed partial class ScrollRequest : PlainRequest { @@ -51,26 +55,34 @@ public sealed partial class ScrollRequest : PlainRequest "scroll"; /// - /// If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object. + /// + /// If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object. + /// /// [JsonIgnore] public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } /// - /// Period to retain the search context for scrolling. + /// + /// Period to retain the search context for scrolling. + /// /// [JsonInclude, JsonPropertyName("scroll")] public Elastic.Clients.Elasticsearch.Duration? Scroll { get; set; } /// - /// Scroll ID of the search. + /// + /// Scroll ID of the search. + /// /// [JsonInclude, JsonPropertyName("scroll_id")] public Elastic.Clients.Elasticsearch.ScrollId ScrollId { get; set; } } /// -/// Allows to retrieve a large numbers of results from a single search request. +/// +/// Allows to retrieve a large numbers of results from a single search request. +/// /// public sealed partial class ScrollRequestDescriptor : RequestDescriptor { @@ -94,7 +106,9 @@ public ScrollRequestDescriptor() private Elastic.Clients.Elasticsearch.ScrollId ScrollIdValue { get; set; } /// - /// Period to retain the search context for scrolling. + /// + /// Period to retain the search context for scrolling. + /// /// public ScrollRequestDescriptor Scroll(Elastic.Clients.Elasticsearch.Duration? scroll) { @@ -103,7 +117,9 @@ public ScrollRequestDescriptor Scroll(Elastic.Clients.Elasticsearch.Duration? sc } /// - /// Scroll ID of the search. + /// + /// Scroll ID of the search. + /// /// public ScrollRequestDescriptor ScrollId(Elastic.Clients.Elasticsearch.ScrollId scrollId) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/DeleteBehavioralAnalyticsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/DeleteBehavioralAnalyticsRequest.g.cs index 3c848aac01c..393dc6f1772 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/DeleteBehavioralAnalyticsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/DeleteBehavioralAnalyticsRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class DeleteBehavioralAnalyticsRequestParameters : Request } /// -/// Delete a behavioral analytics collection. +/// +/// Delete a behavioral analytics collection. +/// /// public sealed partial class DeleteBehavioralAnalyticsRequest : PlainRequest { @@ -52,7 +54,9 @@ public DeleteBehavioralAnalyticsRequest(Elastic.Clients.Elasticsearch.Name name) } /// -/// Delete a behavioral analytics collection. +/// +/// Delete a behavioral analytics collection. +/// /// public sealed partial class DeleteBehavioralAnalyticsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/DeleteBehavioralAnalyticsResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/DeleteBehavioralAnalyticsResponse.g.cs index ab81d612daa..815097e6f70 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/DeleteBehavioralAnalyticsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/DeleteBehavioralAnalyticsResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.SearchApplication; public sealed partial class DeleteBehavioralAnalyticsResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/DeleteSearchApplicationRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/DeleteSearchApplicationRequest.g.cs index 36f2af3b127..6eb2ed9f167 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/DeleteSearchApplicationRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/DeleteSearchApplicationRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class DeleteSearchApplicationRequestParameters : RequestPa } /// -/// Deletes a search application. +/// +/// Deletes a search application. +/// /// public sealed partial class DeleteSearchApplicationRequest : PlainRequest { @@ -52,7 +54,9 @@ public DeleteSearchApplicationRequest(Elastic.Clients.Elasticsearch.Name name) : } /// -/// Deletes a search application. +/// +/// Deletes a search application. +/// /// public sealed partial class DeleteSearchApplicationRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/DeleteSearchApplicationResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/DeleteSearchApplicationResponse.g.cs index 37e399e3af8..25ab747e186 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/DeleteSearchApplicationResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/DeleteSearchApplicationResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.SearchApplication; public sealed partial class DeleteSearchApplicationResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/GetBehavioralAnalyticsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/GetBehavioralAnalyticsRequest.g.cs index ae62e903854..a4916064d61 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/GetBehavioralAnalyticsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/GetBehavioralAnalyticsRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class GetBehavioralAnalyticsRequestParameters : RequestPar } /// -/// Returns the existing behavioral analytics collections. +/// +/// Returns the existing behavioral analytics collections. +/// /// public sealed partial class GetBehavioralAnalyticsRequest : PlainRequest { @@ -56,7 +58,9 @@ public GetBehavioralAnalyticsRequest(IReadOnlyCollection -/// Returns the existing behavioral analytics collections. +/// +/// Returns the existing behavioral analytics collections. +/// /// public sealed partial class GetBehavioralAnalyticsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/GetSearchApplicationRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/GetSearchApplicationRequest.g.cs index d6fb6079e1d..aa25bd1fe0d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/GetSearchApplicationRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/GetSearchApplicationRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class GetSearchApplicationRequestParameters : RequestParam } /// -/// Returns the details about a search application +/// +/// Returns the details about a search application +/// /// public sealed partial class GetSearchApplicationRequest : PlainRequest { @@ -52,7 +54,9 @@ public GetSearchApplicationRequest(Elastic.Clients.Elasticsearch.Name name) : ba } /// -/// Returns the details about a search application +/// +/// Returns the details about a search application +/// /// public sealed partial class GetSearchApplicationRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/GetSearchApplicationResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/GetSearchApplicationResponse.g.cs index a5048354032..13bcb8d5841 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/GetSearchApplicationResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/GetSearchApplicationResponse.g.cs @@ -29,31 +29,41 @@ namespace Elastic.Clients.Elasticsearch.SearchApplication; public sealed partial class GetSearchApplicationResponse : ElasticsearchResponse { /// - /// Analytics collection associated to the Search Application. + /// + /// Analytics collection associated to the Search Application. + /// /// [JsonInclude, JsonPropertyName("analytics_collection_name")] public string? AnalyticsCollectionName { get; init; } /// - /// Indices that are part of the Search Application. + /// + /// Indices that are part of the Search Application. + /// /// [JsonInclude, JsonPropertyName("indices")] public IReadOnlyCollection Indices { get; init; } /// - /// Search Application name. + /// + /// Search Application name. + /// /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } /// - /// Search template to use on search operations. + /// + /// Search template to use on search operations. + /// /// [JsonInclude, JsonPropertyName("template")] public Elastic.Clients.Elasticsearch.SearchApplication.SearchApplicationTemplate? Template { get; init; } /// - /// Last time the Search Application was updated. + /// + /// Last time the Search Application was updated. + /// /// [JsonInclude, JsonPropertyName("updated_at_millis")] public long UpdatedAtMillis { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/ListRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/ListRequest.g.cs index 5c9320ed8cf..8e216cde2e1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/ListRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/ListRequest.g.cs @@ -32,23 +32,31 @@ namespace Elastic.Clients.Elasticsearch.SearchApplication; public sealed partial class ListRequestParameters : RequestParameters { /// - /// Starting offset. + /// + /// Starting offset. + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// Query in the Lucene query string syntax. + /// + /// Query in the Lucene query string syntax. + /// /// public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } /// - /// Specifies a max number of results to get. + /// + /// Specifies a max number of results to get. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Returns the existing search applications. +/// +/// Returns the existing search applications. +/// /// public sealed partial class ListRequest : PlainRequest { @@ -61,26 +69,34 @@ public sealed partial class ListRequest : PlainRequest internal override string OperationName => "search_application.list"; /// - /// Starting offset. + /// + /// Starting offset. + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// Query in the Lucene query string syntax. + /// + /// Query in the Lucene query string syntax. + /// /// [JsonIgnore] public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } /// - /// Specifies a max number of results to get. + /// + /// Specifies a max number of results to get. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Returns the existing search applications. +/// +/// Returns the existing search applications. +/// /// public sealed partial class ListRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/PutBehavioralAnalyticsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/PutBehavioralAnalyticsRequest.g.cs index c2c08b2f4f8..32f48d14234 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/PutBehavioralAnalyticsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/PutBehavioralAnalyticsRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class PutBehavioralAnalyticsRequestParameters : RequestPar } /// -/// Creates a behavioral analytics collection. +/// +/// Creates a behavioral analytics collection. +/// /// public sealed partial class PutBehavioralAnalyticsRequest : PlainRequest { @@ -52,7 +54,9 @@ public PutBehavioralAnalyticsRequest(Elastic.Clients.Elasticsearch.Name name) : } /// -/// Creates a behavioral analytics collection. +/// +/// Creates a behavioral analytics collection. +/// /// public sealed partial class PutBehavioralAnalyticsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/PutBehavioralAnalyticsResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/PutBehavioralAnalyticsResponse.g.cs index fffbe4ac143..9ef176986b8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/PutBehavioralAnalyticsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/PutBehavioralAnalyticsResponse.g.cs @@ -29,13 +29,17 @@ namespace Elastic.Clients.Elasticsearch.SearchApplication; public sealed partial class PutBehavioralAnalyticsResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } /// - /// The name of the analytics collection created or updated + /// + /// The name of the analytics collection created or updated + /// /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/PutSearchApplicationRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/PutSearchApplicationRequest.g.cs index 86a4f15dd1a..44d43d407b8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/PutSearchApplicationRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/PutSearchApplicationRequest.g.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch.SearchApplication; public sealed partial class PutSearchApplicationRequestParameters : RequestParameters { /// - /// If `true`, this request cannot replace or update existing Search Applications. + /// + /// If true, this request cannot replace or update existing Search Applications. + /// /// public bool? Create { get => Q("create"); set => Q("create", value); } } /// -/// Creates or updates a search application. +/// +/// Creates or updates a search application. +/// /// public sealed partial class PutSearchApplicationRequest : PlainRequest, ISelfSerializable { @@ -55,7 +59,9 @@ public PutSearchApplicationRequest(Elastic.Clients.Elasticsearch.Name name) : ba internal override string OperationName => "search_application.put"; /// - /// If `true`, this request cannot replace or update existing Search Applications. + /// + /// If true, this request cannot replace or update existing Search Applications. + /// /// [JsonIgnore] public bool? Create { get => Q("create"); set => Q("create", value); } @@ -69,7 +75,9 @@ void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions op } /// -/// Creates or updates a search application. +/// +/// Creates or updates a search application. +/// /// public sealed partial class PutSearchApplicationRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/SearchApplicationSearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/SearchApplicationSearchRequest.g.cs index def7e6e2601..239437b7290 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/SearchApplicationSearchRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/SearchApplicationSearchRequest.g.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch.SearchApplication; public sealed partial class SearchApplicationSearchRequestParameters : RequestParameters { /// - /// Determines whether aggregation names are prefixed by their respective types in the response. + /// + /// Determines whether aggregation names are prefixed by their respective types in the response. + /// /// public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } } /// -/// Perform a search against a search application. +/// +/// Perform a search against a search application. +/// /// public sealed partial class SearchApplicationSearchRequest : PlainRequest { @@ -55,20 +59,26 @@ public SearchApplicationSearchRequest(Elastic.Clients.Elasticsearch.Name name) : internal override string OperationName => "search_application.search"; /// - /// Determines whether aggregation names are prefixed by their respective types in the response. + /// + /// Determines whether aggregation names are prefixed by their respective types in the response. + /// /// [JsonIgnore] public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } /// - /// Query parameters specific to this request, which will override any defaults specified in the template. + /// + /// Query parameters specific to this request, which will override any defaults specified in the template. + /// /// [JsonInclude, JsonPropertyName("params")] public IDictionary? Params { get; set; } } /// -/// Perform a search against a search application. +/// +/// Perform a search against a search application. +/// /// public sealed partial class SearchApplicationSearchRequestDescriptor : RequestDescriptor { @@ -97,7 +107,9 @@ public SearchApplicationSearchRequestDescriptor Name(Elastic.Clients.Elasticsear private IDictionary? ParamsValue { get; set; } /// - /// Query parameters specific to this request, which will override any defaults specified in the template. + /// + /// Query parameters specific to this request, which will override any defaults specified in the template. + /// /// public SearchApplicationSearchRequestDescriptor Params(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchMvtRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchMvtRequest.g.cs index 2e850c6442b..2528376f9a8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchMvtRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchMvtRequest.g.cs @@ -34,7 +34,10 @@ public sealed partial class SearchMvtRequestParameters : RequestParameters } /// -/// Search a vector tile.
Searches a vector tile for geospatial values. +/// +/// Search a vector tile. +/// Searches a vector tile for geospatial values. +/// /// public sealed partial class SearchMvtRequest : PlainRequest { @@ -51,95 +54,174 @@ public SearchMvtRequest(Elastic.Clients.Elasticsearch.Indices indices, Elastic.C internal override string OperationName => "search_mvt"; /// - /// Sub-aggregations for the geotile_grid. - /// Supports the following aggregation types:
- avg
- cardinality
- max
- min
- sum + /// + /// Sub-aggregations for the geotile_grid. + /// + /// + /// Supports the following aggregation types: + /// + /// + /// + /// + /// avg + /// + /// + /// + /// + /// cardinality + /// + /// + /// + /// + /// max + /// + /// + /// + /// + /// min + /// + /// + /// + /// + /// sum + /// + /// + /// /// [JsonInclude, JsonPropertyName("aggs")] public IDictionary? Aggs { get; set; } /// - /// Size, in pixels, of a clipping buffer outside the tile. This allows renderers
to avoid outline artifacts from geometries that extend past the extent of the tile. + /// + /// Size, in pixels, of a clipping buffer outside the tile. This allows renderers + /// to avoid outline artifacts from geometries that extend past the extent of the tile. + /// /// [JsonInclude, JsonPropertyName("buffer")] public int? Buffer { get; set; } /// - /// If false, the meta layer’s feature is the bounding box of the tile.
If true, the meta layer’s feature is a bounding box resulting from a
geo_bounds aggregation. The aggregation runs on values that intersect
the // tile with wrap_longitude set to false. The resulting
bounding box may be larger than the vector tile. + /// + /// If false, the meta layer’s feature is the bounding box of the tile. + /// If true, the meta layer’s feature is a bounding box resulting from a + /// geo_bounds aggregation. The aggregation runs on <field> values that intersect + /// the <zoom>/<x>/<y> tile with wrap_longitude set to false. The resulting + /// bounding box may be larger than the vector tile. + /// /// [JsonInclude, JsonPropertyName("exact_bounds")] public bool? ExactBounds { get; set; } /// - /// Size, in pixels, of a side of the tile. Vector tiles are square with equal sides. + /// + /// Size, in pixels, of a side of the tile. Vector tiles are square with equal sides. + /// /// [JsonInclude, JsonPropertyName("extent")] public int? Extent { get; set; } /// - /// Fields to return in the `hits` layer. Supports wildcards (`*`).
This parameter does not support fields with array values. Fields with array
values may return inconsistent results. + /// + /// Fields to return in the hits layer. Supports wildcards (*). + /// This parameter does not support fields with array values. Fields with array + /// values may return inconsistent results. + /// /// [JsonInclude, JsonPropertyName("fields")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] public Elastic.Clients.Elasticsearch.Fields? Fields { get; set; } /// - /// Aggregation used to create a grid for the `field`. + /// + /// Aggregation used to create a grid for the field. + /// /// [JsonInclude, JsonPropertyName("grid_agg")] public Elastic.Clients.Elasticsearch.Core.SearchMvt.GridAggregationType? GridAgg { get; set; } /// - /// Additional zoom levels available through the aggs layer. For example, if is 7
and grid_precision is 8, you can zoom in up to level 15. Accepts 0-8. If 0, results
don’t include the aggs layer. + /// + /// Additional zoom levels available through the aggs layer. For example, if <zoom> is 7 + /// and grid_precision is 8, you can zoom in up to level 15. Accepts 0-8. If 0, results + /// don’t include the aggs layer. + /// /// [JsonInclude, JsonPropertyName("grid_precision")] public int? GridPrecision { get; set; } /// - /// Determines the geometry type for features in the aggs layer. In the aggs layer,
each feature represents a geotile_grid cell. If 'grid' each feature is a Polygon
of the cells bounding box. If 'point' each feature is a Point that is the centroid
of the cell. + /// + /// Determines the geometry type for features in the aggs layer. In the aggs layer, + /// each feature represents a geotile_grid cell. If 'grid' each feature is a Polygon + /// of the cells bounding box. If 'point' each feature is a Point that is the centroid + /// of the cell. + /// /// [JsonInclude, JsonPropertyName("grid_type")] public Elastic.Clients.Elasticsearch.Core.SearchMvt.GridType? GridType { get; set; } /// - /// Query DSL used to filter documents for the search. + /// + /// Query DSL used to filter documents for the search. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Query { get; set; } /// - /// Defines one or more runtime fields in the search request. These fields take
precedence over mapped fields with the same name. + /// + /// Defines one or more runtime fields in the search request. These fields take + /// precedence over mapped fields with the same name. + /// /// [JsonInclude, JsonPropertyName("runtime_mappings")] public IDictionary? RuntimeMappings { get; set; } /// - /// Maximum number of features to return in the hits layer. Accepts 0-10000.
If 0, results don’t include the hits layer. + /// + /// Maximum number of features to return in the hits layer. Accepts 0-10000. + /// If 0, results don’t include the hits layer. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// Sorts features in the hits layer. By default, the API calculates a bounding
box for each feature. It sorts features based on this box’s diagonal length,
from longest to shortest. + /// + /// Sorts features in the hits layer. By default, the API calculates a bounding + /// box for each feature. It sorts features based on this box’s diagonal length, + /// from longest to shortest. + /// /// [JsonInclude, JsonPropertyName("sort")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.SortOptions))] public ICollection? Sort { get; set; } /// - /// Number of hits matching the query to count accurately. If `true`, the exact number
of hits is returned at the cost of some performance. If `false`, the response does
not include the total number of hits matching the query. + /// + /// Number of hits matching the query to count accurately. If true, the exact number + /// of hits is returned at the cost of some performance. If false, the response does + /// not include the total number of hits matching the query. + /// /// [JsonInclude, JsonPropertyName("track_total_hits")] public Elastic.Clients.Elasticsearch.Core.Search.TrackHits? TrackTotalHits { get; set; } /// - /// If `true`, the hits and aggs layers will contain additional point features representing
suggested label positions for the original features. + /// + /// If true, the hits and aggs layers will contain additional point features representing + /// suggested label positions for the original features. + /// /// [JsonInclude, JsonPropertyName("with_labels")] public bool? WithLabels { get; set; } } /// -/// Search a vector tile.
Searches a vector tile for geospatial values. +/// +/// Search a vector tile. +/// Searches a vector tile for geospatial values. +/// /// public sealed partial class SearchMvtRequestDescriptor : RequestDescriptor, SearchMvtRequestParameters> { @@ -212,8 +294,39 @@ public SearchMvtRequestDescriptor Zoom(int zoom) private bool? WithLabelsValue { get; set; } /// - /// Sub-aggregations for the geotile_grid. - /// Supports the following aggregation types:
- avg
- cardinality
- max
- min
- sum + /// + /// Sub-aggregations for the geotile_grid. + /// + /// + /// Supports the following aggregation types: + /// + /// + /// + /// + /// avg + /// + /// + /// + /// + /// cardinality + /// + /// + /// + /// + /// max + /// + /// + /// + /// + /// min + /// + /// + /// + /// + /// sum + /// + /// + /// /// public SearchMvtRequestDescriptor Aggs(Func>, FluentDescriptorDictionary>> selector) { @@ -222,7 +335,10 @@ public SearchMvtRequestDescriptor Aggs(Func - /// Size, in pixels, of a clipping buffer outside the tile. This allows renderers
to avoid outline artifacts from geometries that extend past the extent of the tile. + /// + /// Size, in pixels, of a clipping buffer outside the tile. This allows renderers + /// to avoid outline artifacts from geometries that extend past the extent of the tile. + /// /// public SearchMvtRequestDescriptor Buffer(int? buffer) { @@ -231,7 +347,13 @@ public SearchMvtRequestDescriptor Buffer(int? buffer) } /// - /// If false, the meta layer’s feature is the bounding box of the tile.
If true, the meta layer’s feature is a bounding box resulting from a
geo_bounds aggregation. The aggregation runs on values that intersect
the // tile with wrap_longitude set to false. The resulting
bounding box may be larger than the vector tile. + /// + /// If false, the meta layer’s feature is the bounding box of the tile. + /// If true, the meta layer’s feature is a bounding box resulting from a + /// geo_bounds aggregation. The aggregation runs on <field> values that intersect + /// the <zoom>/<x>/<y> tile with wrap_longitude set to false. The resulting + /// bounding box may be larger than the vector tile. + /// /// public SearchMvtRequestDescriptor ExactBounds(bool? exactBounds = true) { @@ -240,7 +362,9 @@ public SearchMvtRequestDescriptor ExactBounds(bool? exactBounds = tru } /// - /// Size, in pixels, of a side of the tile. Vector tiles are square with equal sides. + /// + /// Size, in pixels, of a side of the tile. Vector tiles are square with equal sides. + /// /// public SearchMvtRequestDescriptor Extent(int? extent) { @@ -249,7 +373,11 @@ public SearchMvtRequestDescriptor Extent(int? extent) } /// - /// Fields to return in the `hits` layer. Supports wildcards (`*`).
This parameter does not support fields with array values. Fields with array
values may return inconsistent results. + /// + /// Fields to return in the hits layer. Supports wildcards (*). + /// This parameter does not support fields with array values. Fields with array + /// values may return inconsistent results. + /// /// public SearchMvtRequestDescriptor Fields(Elastic.Clients.Elasticsearch.Fields? fields) { @@ -258,7 +386,9 @@ public SearchMvtRequestDescriptor Fields(Elastic.Clients.Elasticsearc } /// - /// Aggregation used to create a grid for the `field`. + /// + /// Aggregation used to create a grid for the field. + /// /// public SearchMvtRequestDescriptor GridAgg(Elastic.Clients.Elasticsearch.Core.SearchMvt.GridAggregationType? gridAgg) { @@ -267,7 +397,11 @@ public SearchMvtRequestDescriptor GridAgg(Elastic.Clients.Elasticsear } /// - /// Additional zoom levels available through the aggs layer. For example, if is 7
and grid_precision is 8, you can zoom in up to level 15. Accepts 0-8. If 0, results
don’t include the aggs layer. + /// + /// Additional zoom levels available through the aggs layer. For example, if <zoom> is 7 + /// and grid_precision is 8, you can zoom in up to level 15. Accepts 0-8. If 0, results + /// don’t include the aggs layer. + /// /// public SearchMvtRequestDescriptor GridPrecision(int? gridPrecision) { @@ -276,7 +410,12 @@ public SearchMvtRequestDescriptor GridPrecision(int? gridPrecision) } /// - /// Determines the geometry type for features in the aggs layer. In the aggs layer,
each feature represents a geotile_grid cell. If 'grid' each feature is a Polygon
of the cells bounding box. If 'point' each feature is a Point that is the centroid
of the cell. + /// + /// Determines the geometry type for features in the aggs layer. In the aggs layer, + /// each feature represents a geotile_grid cell. If 'grid' each feature is a Polygon + /// of the cells bounding box. If 'point' each feature is a Point that is the centroid + /// of the cell. + /// /// public SearchMvtRequestDescriptor GridType(Elastic.Clients.Elasticsearch.Core.SearchMvt.GridType? gridType) { @@ -285,7 +424,9 @@ public SearchMvtRequestDescriptor GridType(Elastic.Clients.Elasticsea } /// - /// Query DSL used to filter documents for the search. + /// + /// Query DSL used to filter documents for the search. + /// /// public SearchMvtRequestDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -312,7 +453,10 @@ public SearchMvtRequestDescriptor Query(Action - /// Defines one or more runtime fields in the search request. These fields take
precedence over mapped fields with the same name. + /// + /// Defines one or more runtime fields in the search request. These fields take + /// precedence over mapped fields with the same name. + /// /// public SearchMvtRequestDescriptor RuntimeMappings(Func>, FluentDescriptorDictionary>> selector) { @@ -321,7 +465,10 @@ public SearchMvtRequestDescriptor RuntimeMappings(Func - /// Maximum number of features to return in the hits layer. Accepts 0-10000.
If 0, results don’t include the hits layer. + /// + /// Maximum number of features to return in the hits layer. Accepts 0-10000. + /// If 0, results don’t include the hits layer. + /// /// public SearchMvtRequestDescriptor Size(int? size) { @@ -330,7 +477,11 @@ public SearchMvtRequestDescriptor Size(int? size) } /// - /// Sorts features in the hits layer. By default, the API calculates a bounding
box for each feature. It sorts features based on this box’s diagonal length,
from longest to shortest. + /// + /// Sorts features in the hits layer. By default, the API calculates a bounding + /// box for each feature. It sorts features based on this box’s diagonal length, + /// from longest to shortest. + /// /// public SearchMvtRequestDescriptor Sort(ICollection? sort) { @@ -369,7 +520,11 @@ public SearchMvtRequestDescriptor Sort(params Action - /// Number of hits matching the query to count accurately. If `true`, the exact number
of hits is returned at the cost of some performance. If `false`, the response does
not include the total number of hits matching the query. + /// + /// Number of hits matching the query to count accurately. If true, the exact number + /// of hits is returned at the cost of some performance. If false, the response does + /// not include the total number of hits matching the query. + /// /// public SearchMvtRequestDescriptor TrackTotalHits(Elastic.Clients.Elasticsearch.Core.Search.TrackHits? trackTotalHits) { @@ -378,7 +533,10 @@ public SearchMvtRequestDescriptor TrackTotalHits(Elastic.Clients.Elas } /// - /// If `true`, the hits and aggs layers will contain additional point features representing
suggested label positions for the original features. + /// + /// If true, the hits and aggs layers will contain additional point features representing + /// suggested label positions for the original features. + /// /// public SearchMvtRequestDescriptor WithLabels(bool? withLabels = true) { @@ -511,7 +669,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Search a vector tile.
Searches a vector tile for geospatial values. +/// +/// Search a vector tile. +/// Searches a vector tile for geospatial values. +/// /// public sealed partial class SearchMvtRequestDescriptor : RequestDescriptor { @@ -580,8 +741,39 @@ public SearchMvtRequestDescriptor Zoom(int zoom) private bool? WithLabelsValue { get; set; } /// - /// Sub-aggregations for the geotile_grid. - /// Supports the following aggregation types:
- avg
- cardinality
- max
- min
- sum + /// + /// Sub-aggregations for the geotile_grid. + /// + /// + /// Supports the following aggregation types: + /// + /// + /// + /// + /// avg + /// + /// + /// + /// + /// cardinality + /// + /// + /// + /// + /// max + /// + /// + /// + /// + /// min + /// + /// + /// + /// + /// sum + /// + /// + /// /// public SearchMvtRequestDescriptor Aggs(Func, FluentDescriptorDictionary> selector) { @@ -590,7 +782,10 @@ public SearchMvtRequestDescriptor Aggs(Func - /// Size, in pixels, of a clipping buffer outside the tile. This allows renderers
to avoid outline artifacts from geometries that extend past the extent of the tile. + /// + /// Size, in pixels, of a clipping buffer outside the tile. This allows renderers + /// to avoid outline artifacts from geometries that extend past the extent of the tile. + /// /// public SearchMvtRequestDescriptor Buffer(int? buffer) { @@ -599,7 +794,13 @@ public SearchMvtRequestDescriptor Buffer(int? buffer) } /// - /// If false, the meta layer’s feature is the bounding box of the tile.
If true, the meta layer’s feature is a bounding box resulting from a
geo_bounds aggregation. The aggregation runs on values that intersect
the // tile with wrap_longitude set to false. The resulting
bounding box may be larger than the vector tile. + /// + /// If false, the meta layer’s feature is the bounding box of the tile. + /// If true, the meta layer’s feature is a bounding box resulting from a + /// geo_bounds aggregation. The aggregation runs on <field> values that intersect + /// the <zoom>/<x>/<y> tile with wrap_longitude set to false. The resulting + /// bounding box may be larger than the vector tile. + /// /// public SearchMvtRequestDescriptor ExactBounds(bool? exactBounds = true) { @@ -608,7 +809,9 @@ public SearchMvtRequestDescriptor ExactBounds(bool? exactBounds = true) } /// - /// Size, in pixels, of a side of the tile. Vector tiles are square with equal sides. + /// + /// Size, in pixels, of a side of the tile. Vector tiles are square with equal sides. + /// /// public SearchMvtRequestDescriptor Extent(int? extent) { @@ -617,7 +820,11 @@ public SearchMvtRequestDescriptor Extent(int? extent) } /// - /// Fields to return in the `hits` layer. Supports wildcards (`*`).
This parameter does not support fields with array values. Fields with array
values may return inconsistent results. + /// + /// Fields to return in the hits layer. Supports wildcards (*). + /// This parameter does not support fields with array values. Fields with array + /// values may return inconsistent results. + /// /// public SearchMvtRequestDescriptor Fields(Elastic.Clients.Elasticsearch.Fields? fields) { @@ -626,7 +833,9 @@ public SearchMvtRequestDescriptor Fields(Elastic.Clients.Elasticsearch.Fields? f } /// - /// Aggregation used to create a grid for the `field`. + /// + /// Aggregation used to create a grid for the field. + /// /// public SearchMvtRequestDescriptor GridAgg(Elastic.Clients.Elasticsearch.Core.SearchMvt.GridAggregationType? gridAgg) { @@ -635,7 +844,11 @@ public SearchMvtRequestDescriptor GridAgg(Elastic.Clients.Elasticsearch.Core.Sea } /// - /// Additional zoom levels available through the aggs layer. For example, if is 7
and grid_precision is 8, you can zoom in up to level 15. Accepts 0-8. If 0, results
don’t include the aggs layer. + /// + /// Additional zoom levels available through the aggs layer. For example, if <zoom> is 7 + /// and grid_precision is 8, you can zoom in up to level 15. Accepts 0-8. If 0, results + /// don’t include the aggs layer. + /// /// public SearchMvtRequestDescriptor GridPrecision(int? gridPrecision) { @@ -644,7 +857,12 @@ public SearchMvtRequestDescriptor GridPrecision(int? gridPrecision) } /// - /// Determines the geometry type for features in the aggs layer. In the aggs layer,
each feature represents a geotile_grid cell. If 'grid' each feature is a Polygon
of the cells bounding box. If 'point' each feature is a Point that is the centroid
of the cell. + /// + /// Determines the geometry type for features in the aggs layer. In the aggs layer, + /// each feature represents a geotile_grid cell. If 'grid' each feature is a Polygon + /// of the cells bounding box. If 'point' each feature is a Point that is the centroid + /// of the cell. + /// /// public SearchMvtRequestDescriptor GridType(Elastic.Clients.Elasticsearch.Core.SearchMvt.GridType? gridType) { @@ -653,7 +871,9 @@ public SearchMvtRequestDescriptor GridType(Elastic.Clients.Elasticsearch.Core.Se } /// - /// Query DSL used to filter documents for the search. + /// + /// Query DSL used to filter documents for the search. + /// /// public SearchMvtRequestDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -680,7 +900,10 @@ public SearchMvtRequestDescriptor Query(Action - /// Defines one or more runtime fields in the search request. These fields take
precedence over mapped fields with the same name. + /// + /// Defines one or more runtime fields in the search request. These fields take + /// precedence over mapped fields with the same name. + /// /// public SearchMvtRequestDescriptor RuntimeMappings(Func, FluentDescriptorDictionary> selector) { @@ -689,7 +912,10 @@ public SearchMvtRequestDescriptor RuntimeMappings(Func - /// Maximum number of features to return in the hits layer. Accepts 0-10000.
If 0, results don’t include the hits layer. + /// + /// Maximum number of features to return in the hits layer. Accepts 0-10000. + /// If 0, results don’t include the hits layer. + /// /// public SearchMvtRequestDescriptor Size(int? size) { @@ -698,7 +924,11 @@ public SearchMvtRequestDescriptor Size(int? size) } /// - /// Sorts features in the hits layer. By default, the API calculates a bounding
box for each feature. It sorts features based on this box’s diagonal length,
from longest to shortest. + /// + /// Sorts features in the hits layer. By default, the API calculates a bounding + /// box for each feature. It sorts features based on this box’s diagonal length, + /// from longest to shortest. + /// /// public SearchMvtRequestDescriptor Sort(ICollection? sort) { @@ -737,7 +967,11 @@ public SearchMvtRequestDescriptor Sort(params Action - /// Number of hits matching the query to count accurately. If `true`, the exact number
of hits is returned at the cost of some performance. If `false`, the response does
not include the total number of hits matching the query. + /// + /// Number of hits matching the query to count accurately. If true, the exact number + /// of hits is returned at the cost of some performance. If false, the response does + /// not include the total number of hits matching the query. + /// /// public SearchMvtRequestDescriptor TrackTotalHits(Elastic.Clients.Elasticsearch.Core.Search.TrackHits? trackTotalHits) { @@ -746,7 +980,10 @@ public SearchMvtRequestDescriptor TrackTotalHits(Elastic.Clients.Elasticsearch.C } /// - /// If `true`, the hits and aggs layers will contain additional point features representing
suggested label positions for the original features. + /// + /// If true, the hits and aggs layers will contain additional point features representing + /// suggested label positions for the original features. + /// /// public SearchMvtRequestDescriptor WithLabels(bool? withLabels = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchRequest.g.cs index 5297a9563b8..c0126e9aec1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchRequest.g.cs @@ -32,152 +32,250 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class SearchRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices.
For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results. + /// + /// If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results. + /// /// public bool? AllowPartialSearchResults { get => Q("allow_partial_search_results"); set => Q("allow_partial_search_results", value); } /// - /// Analyzer to use for the query string.
This parameter can only be used when the q query string parameter is specified. + /// + /// Analyzer to use for the query string. + /// This parameter can only be used when the q query string parameter is specified. + /// /// public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// - /// If true, wildcard and prefix queries are analyzed.
This parameter can only be used when the q query string parameter is specified. + /// + /// If true, wildcard and prefix queries are analyzed. + /// This parameter can only be used when the q query string parameter is specified. + /// /// public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } /// - /// The number of shard results that should be reduced at once on the coordinating node.
This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large. + /// + /// The number of shard results that should be reduced at once on the coordinating node. + /// This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large. + /// /// public long? BatchedReduceSize { get => Q("batched_reduce_size"); set => Q("batched_reduce_size", value); } /// - /// If true, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. + /// + /// If true, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. + /// /// public bool? CcsMinimizeRoundtrips { get => Q("ccs_minimize_roundtrips"); set => Q("ccs_minimize_roundtrips", value); } /// - /// The default operator for query string query: AND or OR.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// The default operator for query string query: AND or OR. + /// This parameter can only be used when the q query string parameter is specified. + /// /// public Elastic.Clients.Elasticsearch.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } /// - /// Field to use as default where no field prefix is given in the query string.
This parameter can only be used when the q query string parameter is specified. + /// + /// Field to use as default where no field prefix is given in the query string. + /// This parameter can only be used when the q query string parameter is specified. + /// /// public string? Df { get => Q("df"); set => Q("df", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Should this request force synthetic _source?
Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance.
Fetches with this enabled will be slower the enabling synthetic source natively in the index. + /// + /// Should this request force synthetic _source? + /// Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. + /// Fetches with this enabled will be slower the enabling synthetic source natively in the index. + /// /// public bool? ForceSyntheticSource { get => Q("force_synthetic_source"); set => Q("force_synthetic_source", value); } /// - /// If `true`, concrete, expanded or aliased indices will be ignored when frozen. + /// + /// If true, concrete, expanded or aliased indices will be ignored when frozen. + /// /// public bool? IgnoreThrottled { get => Q("ignore_throttled"); set => Q("ignore_throttled", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// This parameter can only be used when the q query string parameter is specified. + /// /// public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// - /// Defines the number of concurrent shard requests per node this search executes concurrently.
This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests. + /// + /// Defines the number of concurrent shard requests per node this search executes concurrently. + /// This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests. + /// /// public long? MaxConcurrentShardRequests { get => Q("max_concurrent_shard_requests"); set => Q("max_concurrent_shard_requests", value); } /// - /// The minimum version of the node that can handle the request
Any handling node with a lower version will fail the request. + /// + /// The minimum version of the node that can handle the request + /// Any handling node with a lower version will fail the request. + /// /// public string? MinCompatibleShardNode { get => Q("min_compatible_shard_node"); set => Q("min_compatible_shard_node", value); } /// - /// Nodes and shards used for the search.
By default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are:
`_only_local` to run the search only on shards on the local node;
`_local` to, if possible, run the search on shards on the local node, or if not, select shards using the default method;
`_only_nodes:,` to run the search on only the specified nodes IDs, where, if suitable shards exist on more than one selected node, use shards on those nodes using the default method, or if none of the specified nodes are available, select shards from any available node using the default method;
`_prefer_nodes:,` to if possible, run the search on the specified nodes IDs, or if not, select shards using the default method;
`_shards:,` to run the search only on the specified shards;
`` (any string that does not start with `_`) to route searches with the same `` to the same shards in the same order. + /// + /// Nodes and shards used for the search. + /// By default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are: + /// _only_local to run the search only on shards on the local node; + /// _local to, if possible, run the search on shards on the local node, or if not, select shards using the default method; + /// _only_nodes:<node-id>,<node-id> to run the search on only the specified nodes IDs, where, if suitable shards exist on more than one selected node, use shards on those nodes using the default method, or if none of the specified nodes are available, select shards from any available node using the default method; + /// _prefer_nodes:<node-id>,<node-id> to if possible, run the search on the specified nodes IDs, or if not, select shards using the default method; + /// _shards:<shard>,<shard> to run the search only on the specified shards; + /// <custom-string> (any string that does not start with _) to route searches with the same <custom-string> to the same shards in the same order. + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold.
This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method (if date filters are mandatory to match but the shard bounds and the query are disjoint).
When unspecified, the pre-filter phase is executed if any of these conditions is met:
the request targets more than 128 shards;
the request targets one or more read-only index;
the primary sort of the query targets an indexed field. + /// + /// Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. + /// This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method (if date filters are mandatory to match but the shard bounds and the query are disjoint). + /// When unspecified, the pre-filter phase is executed if any of these conditions is met: + /// the request targets more than 128 shards; + /// the request targets one or more read-only index; + /// the primary sort of the query targets an indexed field. + /// /// public long? PreFilterShardSize { get => Q("pre_filter_shard_size"); set => Q("pre_filter_shard_size", value); } /// - /// Query in the Lucene query string syntax using query parameter search.
Query parameter searches do not support the full Elasticsearch Query DSL but are handy for testing. + /// + /// Query in the Lucene query string syntax using query parameter search. + /// Query parameter searches do not support the full Elasticsearch Query DSL but are handy for testing. + /// /// public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } /// - /// If `true`, the caching of search results is enabled for requests where `size` is `0`.
Defaults to index level settings. + /// + /// If true, the caching of search results is enabled for requests where size is 0. + /// Defaults to index level settings. + /// /// public bool? RequestCache { get => Q("request_cache"); set => Q("request_cache", value); } /// - /// Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response. + /// + /// Indicates whether hits.total should be rendered as an integer or an object in the rest search response. + /// /// public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Period to retain the search context for scrolling. See Scroll search results.
By default, this value cannot exceed `1d` (24 hours).
You can change this limit using the `search.max_keep_alive` cluster-level setting. + /// + /// Period to retain the search context for scrolling. See Scroll search results. + /// By default, this value cannot exceed 1d (24 hours). + /// You can change this limit using the search.max_keep_alive cluster-level setting. + /// /// public Elastic.Clients.Elasticsearch.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); } /// - /// How distributed term frequencies are calculated for relevance scoring. + /// + /// How distributed term frequencies are calculated for relevance scoring. + /// /// public Elastic.Clients.Elasticsearch.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } /// - /// A comma-separated list of source fields to exclude from the response.
You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.
If the `_source` parameter is `false`, this parameter is ignored. + /// + /// A comma-separated list of source fields to exclude from the response. + /// You can also use this parameter to exclude fields from the subset specified in _source_includes query parameter. + /// If the _source parameter is false, this parameter is ignored. + /// /// public Elastic.Clients.Elasticsearch.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response.
If this parameter is specified, only these source fields are returned.
You can exclude fields from this subset using the `_source_excludes` query parameter.
If the `_source` parameter is `false`, this parameter is ignored. + /// + /// A comma-separated list of source fields to include in the response. + /// If this parameter is specified, only these source fields are returned. + /// You can exclude fields from this subset using the _source_excludes query parameter. + /// If the _source parameter is false, this parameter is ignored. + /// /// public Elastic.Clients.Elasticsearch.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// Specifies which field to use for suggestions. + /// + /// Specifies which field to use for suggestions. + /// /// public Elastic.Clients.Elasticsearch.Field? SuggestField { get => Q("suggest_field"); set => Q("suggest_field", value); } /// - /// Specifies the suggest mode.
This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. + /// + /// Specifies the suggest mode. + /// This parameter can only be used when the suggest_field and suggest_text query string parameters are specified. + /// /// public Elastic.Clients.Elasticsearch.SuggestMode? SuggestMode { get => Q("suggest_mode"); set => Q("suggest_mode", value); } /// - /// Number of suggestions to return.
This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. + /// + /// Number of suggestions to return. + /// This parameter can only be used when the suggest_field and suggest_text query string parameters are specified. + /// /// public long? SuggestSize { get => Q("suggest_size"); set => Q("suggest_size", value); } /// - /// The source text for which the suggestions should be returned.
This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. + /// + /// The source text for which the suggestions should be returned. + /// This parameter can only be used when the suggest_field and suggest_text query string parameters are specified. + /// /// public string? SuggestText { get => Q("suggest_text"); set => Q("suggest_text", value); } /// - /// If `true`, aggregation and suggester names are be prefixed by their respective types in the response. + /// + /// If true, aggregation and suggester names are be prefixed by their respective types in the response. + /// /// public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } } @@ -615,7 +713,11 @@ public override void Write(Utf8JsonWriter writer, SearchRequest value, JsonSeria } /// -/// Returns search hits that match the query defined in the request.
You can provide search queries using the `q` query string parameter or the request body.
If both are specified, only the query parameter is used. +/// +/// Returns search hits that match the query defined in the request. +/// You can provide search queries using the q query string parameter or the request body. +/// If both are specified, only the query parameter is used. +/// /// [JsonConverter(typeof(SearchRequestConverter))] public partial class SearchRequest : PlainRequest @@ -637,396 +739,596 @@ public SearchRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r => internal override string OperationName => "search"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices.
For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results. + /// + /// If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results. + /// /// [JsonIgnore] public bool? AllowPartialSearchResults { get => Q("allow_partial_search_results"); set => Q("allow_partial_search_results", value); } /// - /// Analyzer to use for the query string.
This parameter can only be used when the q query string parameter is specified. + /// + /// Analyzer to use for the query string. + /// This parameter can only be used when the q query string parameter is specified. + /// /// [JsonIgnore] public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// - /// If true, wildcard and prefix queries are analyzed.
This parameter can only be used when the q query string parameter is specified. + /// + /// If true, wildcard and prefix queries are analyzed. + /// This parameter can only be used when the q query string parameter is specified. + /// /// [JsonIgnore] public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } /// - /// The number of shard results that should be reduced at once on the coordinating node.
This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large. + /// + /// The number of shard results that should be reduced at once on the coordinating node. + /// This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large. + /// /// [JsonIgnore] public long? BatchedReduceSize { get => Q("batched_reduce_size"); set => Q("batched_reduce_size", value); } /// - /// If true, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. + /// + /// If true, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. + /// /// [JsonIgnore] public bool? CcsMinimizeRoundtrips { get => Q("ccs_minimize_roundtrips"); set => Q("ccs_minimize_roundtrips", value); } /// - /// The default operator for query string query: AND or OR.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// The default operator for query string query: AND or OR. + /// This parameter can only be used when the q query string parameter is specified. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } /// - /// Field to use as default where no field prefix is given in the query string.
This parameter can only be used when the q query string parameter is specified. + /// + /// Field to use as default where no field prefix is given in the query string. + /// This parameter can only be used when the q query string parameter is specified. + /// /// [JsonIgnore] public string? Df { get => Q("df"); set => Q("df", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Should this request force synthetic _source?
Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance.
Fetches with this enabled will be slower the enabling synthetic source natively in the index. + /// + /// Should this request force synthetic _source? + /// Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. + /// Fetches with this enabled will be slower the enabling synthetic source natively in the index. + /// /// [JsonIgnore] public bool? ForceSyntheticSource { get => Q("force_synthetic_source"); set => Q("force_synthetic_source", value); } /// - /// If `true`, concrete, expanded or aliased indices will be ignored when frozen. + /// + /// If true, concrete, expanded or aliased indices will be ignored when frozen. + /// /// [JsonIgnore] public bool? IgnoreThrottled { get => Q("ignore_throttled"); set => Q("ignore_throttled", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.
This parameter can only be used when the `q` query string parameter is specified. + /// + /// If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// This parameter can only be used when the q query string parameter is specified. + /// /// [JsonIgnore] public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// - /// Defines the number of concurrent shard requests per node this search executes concurrently.
This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests. + /// + /// Defines the number of concurrent shard requests per node this search executes concurrently. + /// This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests. + /// /// [JsonIgnore] public long? MaxConcurrentShardRequests { get => Q("max_concurrent_shard_requests"); set => Q("max_concurrent_shard_requests", value); } /// - /// The minimum version of the node that can handle the request
Any handling node with a lower version will fail the request. + /// + /// The minimum version of the node that can handle the request + /// Any handling node with a lower version will fail the request. + /// /// [JsonIgnore] public string? MinCompatibleShardNode { get => Q("min_compatible_shard_node"); set => Q("min_compatible_shard_node", value); } /// - /// Nodes and shards used for the search.
By default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are:
`_only_local` to run the search only on shards on the local node;
`_local` to, if possible, run the search on shards on the local node, or if not, select shards using the default method;
`_only_nodes:,` to run the search on only the specified nodes IDs, where, if suitable shards exist on more than one selected node, use shards on those nodes using the default method, or if none of the specified nodes are available, select shards from any available node using the default method;
`_prefer_nodes:,` to if possible, run the search on the specified nodes IDs, or if not, select shards using the default method;
`_shards:,` to run the search only on the specified shards;
`` (any string that does not start with `_`) to route searches with the same `` to the same shards in the same order. + /// + /// Nodes and shards used for the search. + /// By default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are: + /// _only_local to run the search only on shards on the local node; + /// _local to, if possible, run the search on shards on the local node, or if not, select shards using the default method; + /// _only_nodes:<node-id>,<node-id> to run the search on only the specified nodes IDs, where, if suitable shards exist on more than one selected node, use shards on those nodes using the default method, or if none of the specified nodes are available, select shards from any available node using the default method; + /// _prefer_nodes:<node-id>,<node-id> to if possible, run the search on the specified nodes IDs, or if not, select shards using the default method; + /// _shards:<shard>,<shard> to run the search only on the specified shards; + /// <custom-string> (any string that does not start with _) to route searches with the same <custom-string> to the same shards in the same order. + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold.
This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method (if date filters are mandatory to match but the shard bounds and the query are disjoint).
When unspecified, the pre-filter phase is executed if any of these conditions is met:
the request targets more than 128 shards;
the request targets one or more read-only index;
the primary sort of the query targets an indexed field. + /// + /// Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. + /// This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method (if date filters are mandatory to match but the shard bounds and the query are disjoint). + /// When unspecified, the pre-filter phase is executed if any of these conditions is met: + /// the request targets more than 128 shards; + /// the request targets one or more read-only index; + /// the primary sort of the query targets an indexed field. + /// /// [JsonIgnore] public long? PreFilterShardSize { get => Q("pre_filter_shard_size"); set => Q("pre_filter_shard_size", value); } /// - /// Query in the Lucene query string syntax using query parameter search.
Query parameter searches do not support the full Elasticsearch Query DSL but are handy for testing. + /// + /// Query in the Lucene query string syntax using query parameter search. + /// Query parameter searches do not support the full Elasticsearch Query DSL but are handy for testing. + /// /// [JsonIgnore] public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } /// - /// If `true`, the caching of search results is enabled for requests where `size` is `0`.
Defaults to index level settings. + /// + /// If true, the caching of search results is enabled for requests where size is 0. + /// Defaults to index level settings. + /// /// [JsonIgnore] public bool? RequestCache { get => Q("request_cache"); set => Q("request_cache", value); } /// - /// Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response. + /// + /// Indicates whether hits.total should be rendered as an integer or an object in the rest search response. + /// /// [JsonIgnore] public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Period to retain the search context for scrolling. See Scroll search results.
By default, this value cannot exceed `1d` (24 hours).
You can change this limit using the `search.max_keep_alive` cluster-level setting. + /// + /// Period to retain the search context for scrolling. See Scroll search results. + /// By default, this value cannot exceed 1d (24 hours). + /// You can change this limit using the search.max_keep_alive cluster-level setting. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); } /// - /// How distributed term frequencies are calculated for relevance scoring. + /// + /// How distributed term frequencies are calculated for relevance scoring. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } /// - /// A comma-separated list of source fields to exclude from the response.
You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.
If the `_source` parameter is `false`, this parameter is ignored. + /// + /// A comma-separated list of source fields to exclude from the response. + /// You can also use this parameter to exclude fields from the subset specified in _source_includes query parameter. + /// If the _source parameter is false, this parameter is ignored. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A comma-separated list of source fields to include in the response.
If this parameter is specified, only these source fields are returned.
You can exclude fields from this subset using the `_source_excludes` query parameter.
If the `_source` parameter is `false`, this parameter is ignored. + /// + /// A comma-separated list of source fields to include in the response. + /// If this parameter is specified, only these source fields are returned. + /// You can exclude fields from this subset using the _source_excludes query parameter. + /// If the _source parameter is false, this parameter is ignored. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// Specifies which field to use for suggestions. + /// + /// Specifies which field to use for suggestions. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Field? SuggestField { get => Q("suggest_field"); set => Q("suggest_field", value); } /// - /// Specifies the suggest mode.
This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. + /// + /// Specifies the suggest mode. + /// This parameter can only be used when the suggest_field and suggest_text query string parameters are specified. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.SuggestMode? SuggestMode { get => Q("suggest_mode"); set => Q("suggest_mode", value); } /// - /// Number of suggestions to return.
This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. + /// + /// Number of suggestions to return. + /// This parameter can only be used when the suggest_field and suggest_text query string parameters are specified. + /// /// [JsonIgnore] public long? SuggestSize { get => Q("suggest_size"); set => Q("suggest_size", value); } /// - /// The source text for which the suggestions should be returned.
This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. + /// + /// The source text for which the suggestions should be returned. + /// This parameter can only be used when the suggest_field and suggest_text query string parameters are specified. + /// /// [JsonIgnore] public string? SuggestText { get => Q("suggest_text"); set => Q("suggest_text", value); } /// - /// If `true`, aggregation and suggester names are be prefixed by their respective types in the response. + /// + /// If true, aggregation and suggester names are be prefixed by their respective types in the response. + /// /// [JsonIgnore] public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } /// - /// Defines the aggregations that are run as part of the search request. + /// + /// Defines the aggregations that are run as part of the search request. + /// /// [JsonInclude, JsonPropertyName("aggregations")] public IDictionary? Aggregations { get; set; } /// - /// Collapses search results the values of the specified field. + /// + /// Collapses search results the values of the specified field. + /// /// [JsonInclude, JsonPropertyName("collapse")] public Elastic.Clients.Elasticsearch.Core.Search.FieldCollapse? Collapse { get; set; } /// - /// Array of wildcard (`*`) patterns.
The request returns doc values for field names matching these patterns in the `hits.fields` property of the response. + /// + /// Array of wildcard (*) patterns. + /// The request returns doc values for field names matching these patterns in the hits.fields property of the response. + /// /// [JsonInclude, JsonPropertyName("docvalue_fields")] public ICollection? DocvalueFields { get; set; } /// - /// If true, returns detailed information about score computation as part of a hit. + /// + /// If true, returns detailed information about score computation as part of a hit. + /// /// [JsonInclude, JsonPropertyName("explain")] public bool? Explain { get; set; } /// - /// Configuration of search extensions defined by Elasticsearch plugins. + /// + /// Configuration of search extensions defined by Elasticsearch plugins. + /// /// [JsonInclude, JsonPropertyName("ext")] public IDictionary? Ext { get; set; } /// - /// Array of wildcard (`*`) patterns.
The request returns values for field names matching these patterns in the `hits.fields` property of the response. + /// + /// Array of wildcard (*) patterns. + /// The request returns values for field names matching these patterns in the hits.fields property of the response. + /// /// [JsonInclude, JsonPropertyName("fields")] public ICollection? Fields { get; set; } /// - /// Starting document offset.
Needs to be non-negative.
By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.
To page through more hits, use the `search_after` parameter. + /// + /// Starting document offset. + /// Needs to be non-negative. + /// By default, you cannot page through more than 10,000 hits using the from and size parameters. + /// To page through more hits, use the search_after parameter. + /// /// [JsonInclude, JsonPropertyName("from")] public int? From { get; set; } /// - /// Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results. + /// + /// Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results. + /// /// [JsonInclude, JsonPropertyName("highlight")] public Elastic.Clients.Elasticsearch.Core.Search.Highlight? Highlight { get; set; } /// - /// Boosts the _score of documents from specified indices. + /// + /// Boosts the _score of documents from specified indices. + /// /// [JsonInclude, JsonPropertyName("indices_boost")] public ICollection>? IndicesBoost { get; set; } /// - /// Defines the approximate kNN search to run. + /// + /// Defines the approximate kNN search to run. + /// /// [JsonInclude, JsonPropertyName("knn")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.KnnSearch))] public ICollection? Knn { get; set; } /// - /// Minimum `_score` for matching documents.
Documents with a lower `_score` are not included in the search results. + /// + /// Minimum _score for matching documents. + /// Documents with a lower _score are not included in the search results. + /// /// [JsonInclude, JsonPropertyName("min_score")] public double? MinScore { get; set; } /// - /// Limits the search to a point in time (PIT).
If you provide a PIT, you cannot specify an `` in the request path. + /// + /// Limits the search to a point in time (PIT). + /// If you provide a PIT, you cannot specify an <index> in the request path. + /// /// [JsonInclude, JsonPropertyName("pit")] public Elastic.Clients.Elasticsearch.Core.Search.PointInTimeReference? Pit { get; set; } /// - /// Use the `post_filter` parameter to filter search results.
The search hits are filtered after the aggregations are calculated.
A post filter has no impact on the aggregation results. + /// + /// Use the post_filter parameter to filter search results. + /// The search hits are filtered after the aggregations are calculated. + /// A post filter has no impact on the aggregation results. + /// /// [JsonInclude, JsonPropertyName("post_filter")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? PostFilter { get; set; } /// - /// Set to `true` to return detailed timing information about the execution of individual components in a search request.
NOTE: This is a debugging tool and adds significant overhead to search execution. + /// + /// Set to true to return detailed timing information about the execution of individual components in a search request. + /// NOTE: This is a debugging tool and adds significant overhead to search execution. + /// /// [JsonInclude, JsonPropertyName("profile")] public bool? Profile { get; set; } /// - /// Defines the search definition using the Query DSL. + /// + /// Defines the search definition using the Query DSL. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Query { get; set; } /// - /// Defines the Reciprocal Rank Fusion (RRF) to use. + /// + /// Defines the Reciprocal Rank Fusion (RRF) to use. + /// /// [JsonInclude, JsonPropertyName("rank")] public Elastic.Clients.Elasticsearch.Rank? Rank { get; set; } /// - /// Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases. + /// + /// Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the query and post_filter phases. + /// /// [JsonInclude, JsonPropertyName("rescore")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Core.Search.Rescore))] public ICollection? Rescore { get; set; } /// - /// A retriever is a specification to describe top documents returned from a search. A retriever replaces other elements of the search API that also return top documents such as query and knn. + /// + /// A retriever is a specification to describe top documents returned from a search. A retriever replaces other elements of the search API that also return top documents such as query and knn. + /// /// [JsonInclude, JsonPropertyName("retriever")] public Elastic.Clients.Elasticsearch.Retriever? Retriever { get; set; } /// - /// Defines one or more runtime fields in the search request.
These fields take precedence over mapped fields with the same name. + /// + /// Defines one or more runtime fields in the search request. + /// These fields take precedence over mapped fields with the same name. + /// /// [JsonInclude, JsonPropertyName("runtime_mappings")] public IDictionary? RuntimeMappings { get; set; } /// - /// Retrieve a script evaluation (based on different fields) for each hit. + /// + /// Retrieve a script evaluation (based on different fields) for each hit. + /// /// [JsonInclude, JsonPropertyName("script_fields")] public IDictionary? ScriptFields { get; set; } /// - /// Used to retrieve the next page of hits using a set of sort values from the previous page. + /// + /// Used to retrieve the next page of hits using a set of sort values from the previous page. + /// /// [JsonInclude, JsonPropertyName("search_after")] public ICollection? SearchAfter { get; set; } /// - /// If `true`, returns sequence number and primary term of the last modification of each hit. + /// + /// If true, returns sequence number and primary term of the last modification of each hit. + /// /// [JsonInclude, JsonPropertyName("seq_no_primary_term")] public bool? SeqNoPrimaryTerm { get; set; } /// - /// The number of hits to return.
By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.
To page through more hits, use the `search_after` parameter. + /// + /// The number of hits to return. + /// By default, you cannot page through more than 10,000 hits using the from and size parameters. + /// To page through more hits, use the search_after parameter. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// Can be used to split a scrolled search into multiple slices that can be consumed independently. + /// + /// Can be used to split a scrolled search into multiple slices that can be consumed independently. + /// /// [JsonInclude, JsonPropertyName("slice")] public Elastic.Clients.Elasticsearch.SlicedScroll? Slice { get; set; } /// - /// A comma-separated list of : pairs. + /// + /// A comma-separated list of <field>:<direction> pairs. + /// /// [JsonInclude, JsonPropertyName("sort")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.SortOptions))] public ICollection? Sort { get; set; } /// - /// Indicates which source fields are returned for matching documents.
These fields are returned in the hits._source property of the search response. + /// + /// Indicates which source fields are returned for matching documents. + /// These fields are returned in the hits._source property of the search response. + /// /// [JsonInclude, JsonPropertyName("_source")] public Elastic.Clients.Elasticsearch.Core.Search.SourceConfig? Source { get; set; } /// - /// Stats groups to associate with the search.
Each group maintains a statistics aggregation for its associated searches.
You can retrieve these stats using the indices stats API. + /// + /// Stats groups to associate with the search. + /// Each group maintains a statistics aggregation for its associated searches. + /// You can retrieve these stats using the indices stats API. + /// /// [JsonInclude, JsonPropertyName("stats")] public ICollection? Stats { get; set; } /// - /// List of stored fields to return as part of a hit.
If no fields are specified, no stored fields are included in the response.
If this field is specified, the `_source` parameter defaults to `false`.
You can pass `_source: true` to return both source fields and stored fields in the search response. + /// + /// List of stored fields to return as part of a hit. + /// If no fields are specified, no stored fields are included in the response. + /// If this field is specified, the _source parameter defaults to false. + /// You can pass _source: true to return both source fields and stored fields in the search response. + /// /// [JsonInclude, JsonPropertyName("stored_fields")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] public Elastic.Clients.Elasticsearch.Fields? StoredFields { get; set; } /// - /// Defines a suggester that provides similar looking terms based on a provided text. + /// + /// Defines a suggester that provides similar looking terms based on a provided text. + /// /// [JsonInclude, JsonPropertyName("suggest")] public Elastic.Clients.Elasticsearch.Core.Search.Suggester? Suggest { get; set; } /// - /// Maximum number of documents to collect for each shard.
If a query reaches this limit, Elasticsearch terminates the query early.
Elasticsearch collects documents before sorting.
Use with caution.
Elasticsearch applies this parameter to each shard handling the request.
When possible, let Elasticsearch perform early termination automatically.
Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.
If set to `0` (default), the query does not terminate early. + /// + /// Maximum number of documents to collect for each shard. + /// If a query reaches this limit, Elasticsearch terminates the query early. + /// Elasticsearch collects documents before sorting. + /// Use with caution. + /// Elasticsearch applies this parameter to each shard handling the request. + /// When possible, let Elasticsearch perform early termination automatically. + /// Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + /// If set to 0 (default), the query does not terminate early. + /// /// [JsonInclude, JsonPropertyName("terminate_after")] public long? TerminateAfter { get; set; } /// - /// Specifies the period of time to wait for a response from each shard.
If no response is received before the timeout expires, the request fails and returns an error.
Defaults to no timeout. + /// + /// Specifies the period of time to wait for a response from each shard. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// Defaults to no timeout. + /// /// [JsonInclude, JsonPropertyName("timeout")] public string? Timeout { get; set; } /// - /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// + /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// /// [JsonInclude, JsonPropertyName("track_scores")] public bool? TrackScores { get; set; } /// - /// Number of hits matching the query to count accurately.
If `true`, the exact number of hits is returned at the cost of some performance.
If `false`, the response does not include the total number of hits matching the query. + /// + /// Number of hits matching the query to count accurately. + /// If true, the exact number of hits is returned at the cost of some performance. + /// If false, the response does not include the total number of hits matching the query. + /// /// [JsonInclude, JsonPropertyName("track_total_hits")] public Elastic.Clients.Elasticsearch.Core.Search.TrackHits? TrackTotalHits { get; set; } /// - /// If true, returns document version as part of a hit. + /// + /// If true, returns document version as part of a hit. + /// /// [JsonInclude, JsonPropertyName("version")] public bool? Version { get; set; } } /// -/// Returns search hits that match the query defined in the request.
You can provide search queries using the `q` query string parameter or the request body.
If both are specified, only the query parameter is used. +/// +/// Returns search hits that match the query defined in the request. +/// You can provide search queries using the q query string parameter or the request body. +/// If both are specified, only the query parameter is used. +/// /// public sealed partial class SearchRequestDescriptor : RequestDescriptor, SearchRequestParameters> { @@ -1154,7 +1456,9 @@ public SearchRequestDescriptor Indices(Elastic.Clients.Elasticsearch. private bool? VersionValue { get; set; } /// - /// Defines the aggregations that are run as part of the search request. + /// + /// Defines the aggregations that are run as part of the search request. + /// /// public SearchRequestDescriptor Aggregations(Func>, FluentDescriptorDictionary>> selector) { @@ -1163,7 +1467,9 @@ public SearchRequestDescriptor Aggregations(Func - /// Collapses search results the values of the specified field. + /// + /// Collapses search results the values of the specified field. + /// /// public SearchRequestDescriptor Collapse(Elastic.Clients.Elasticsearch.Core.Search.FieldCollapse? collapse) { @@ -1190,7 +1496,10 @@ public SearchRequestDescriptor Collapse(Action - /// Array of wildcard (`*`) patterns.
The request returns doc values for field names matching these patterns in the `hits.fields` property of the response. + /// + /// Array of wildcard (*) patterns. + /// The request returns doc values for field names matching these patterns in the hits.fields property of the response. + /// /// public SearchRequestDescriptor DocvalueFields(ICollection? docvalueFields) { @@ -1229,7 +1538,9 @@ public SearchRequestDescriptor DocvalueFields(params Action - /// If true, returns detailed information about score computation as part of a hit. + /// + /// If true, returns detailed information about score computation as part of a hit. + /// /// public SearchRequestDescriptor Explain(bool? explain = true) { @@ -1238,7 +1549,9 @@ public SearchRequestDescriptor Explain(bool? explain = true) } /// - /// Configuration of search extensions defined by Elasticsearch plugins. + /// + /// Configuration of search extensions defined by Elasticsearch plugins. + /// /// public SearchRequestDescriptor Ext(Func, FluentDictionary> selector) { @@ -1247,7 +1560,10 @@ public SearchRequestDescriptor Ext(Func - /// Array of wildcard (`*`) patterns.
The request returns values for field names matching these patterns in the `hits.fields` property of the response. + /// + /// Array of wildcard (*) patterns. + /// The request returns values for field names matching these patterns in the hits.fields property of the response. + /// /// public SearchRequestDescriptor Fields(ICollection? fields) { @@ -1286,7 +1602,12 @@ public SearchRequestDescriptor Fields(params Action - /// Starting document offset.
Needs to be non-negative.
By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.
To page through more hits, use the `search_after` parameter. + /// + /// Starting document offset. + /// Needs to be non-negative. + /// By default, you cannot page through more than 10,000 hits using the from and size parameters. + /// To page through more hits, use the search_after parameter. + /// /// public SearchRequestDescriptor From(int? from) { @@ -1295,7 +1616,9 @@ public SearchRequestDescriptor From(int? from) } /// - /// Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results. + /// + /// Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results. + /// /// public SearchRequestDescriptor Highlight(Elastic.Clients.Elasticsearch.Core.Search.Highlight? highlight) { @@ -1322,7 +1645,9 @@ public SearchRequestDescriptor Highlight(Action - /// Boosts the _score of documents from specified indices. + /// + /// Boosts the _score of documents from specified indices. + /// /// public SearchRequestDescriptor IndicesBoost(ICollection>? indicesBoost) { @@ -1331,7 +1656,9 @@ public SearchRequestDescriptor IndicesBoost(ICollection - /// Defines the approximate kNN search to run. + /// + /// Defines the approximate kNN search to run. + /// /// public SearchRequestDescriptor Knn(ICollection? knn) { @@ -1370,7 +1697,10 @@ public SearchRequestDescriptor Knn(params Action - /// Minimum `_score` for matching documents.
Documents with a lower `_score` are not included in the search results. + /// + /// Minimum _score for matching documents. + /// Documents with a lower _score are not included in the search results. + /// /// public SearchRequestDescriptor MinScore(double? minScore) { @@ -1379,7 +1709,10 @@ public SearchRequestDescriptor MinScore(double? minScore) } /// - /// Limits the search to a point in time (PIT).
If you provide a PIT, you cannot specify an `` in the request path. + /// + /// Limits the search to a point in time (PIT). + /// If you provide a PIT, you cannot specify an <index> in the request path. + /// /// public SearchRequestDescriptor Pit(Elastic.Clients.Elasticsearch.Core.Search.PointInTimeReference? pit) { @@ -1406,7 +1739,11 @@ public SearchRequestDescriptor Pit(Action - /// Use the `post_filter` parameter to filter search results.
The search hits are filtered after the aggregations are calculated.
A post filter has no impact on the aggregation results. + /// + /// Use the post_filter parameter to filter search results. + /// The search hits are filtered after the aggregations are calculated. + /// A post filter has no impact on the aggregation results. + /// /// public SearchRequestDescriptor PostFilter(Elastic.Clients.Elasticsearch.QueryDsl.Query? postFilter) { @@ -1433,7 +1770,10 @@ public SearchRequestDescriptor PostFilter(Action - /// Set to `true` to return detailed timing information about the execution of individual components in a search request.
NOTE: This is a debugging tool and adds significant overhead to search execution. + /// + /// Set to true to return detailed timing information about the execution of individual components in a search request. + /// NOTE: This is a debugging tool and adds significant overhead to search execution. + /// /// public SearchRequestDescriptor Profile(bool? profile = true) { @@ -1442,7 +1782,9 @@ public SearchRequestDescriptor Profile(bool? profile = true) } /// - /// Defines the search definition using the Query DSL. + /// + /// Defines the search definition using the Query DSL. + /// /// public SearchRequestDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -1469,7 +1811,9 @@ public SearchRequestDescriptor Query(Action - /// Defines the Reciprocal Rank Fusion (RRF) to use. + /// + /// Defines the Reciprocal Rank Fusion (RRF) to use. + /// /// public SearchRequestDescriptor Rank(Elastic.Clients.Elasticsearch.Rank? rank) { @@ -1496,7 +1840,9 @@ public SearchRequestDescriptor Rank(Action - /// Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases. + /// + /// Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the query and post_filter phases. + /// /// public SearchRequestDescriptor Rescore(ICollection? rescore) { @@ -1535,7 +1881,9 @@ public SearchRequestDescriptor Rescore(params Action - /// A retriever is a specification to describe top documents returned from a search. A retriever replaces other elements of the search API that also return top documents such as query and knn. + /// + /// A retriever is a specification to describe top documents returned from a search. A retriever replaces other elements of the search API that also return top documents such as query and knn. + /// /// public SearchRequestDescriptor Retriever(Elastic.Clients.Elasticsearch.Retriever? retriever) { @@ -1562,7 +1910,10 @@ public SearchRequestDescriptor Retriever(Action - /// Defines one or more runtime fields in the search request.
These fields take precedence over mapped fields with the same name. + /// + /// Defines one or more runtime fields in the search request. + /// These fields take precedence over mapped fields with the same name. + /// /// public SearchRequestDescriptor RuntimeMappings(Func>, FluentDescriptorDictionary>> selector) { @@ -1571,7 +1922,9 @@ public SearchRequestDescriptor RuntimeMappings(Func - /// Retrieve a script evaluation (based on different fields) for each hit. + /// + /// Retrieve a script evaluation (based on different fields) for each hit. + /// /// public SearchRequestDescriptor ScriptFields(Func, FluentDescriptorDictionary> selector) { @@ -1580,7 +1933,9 @@ public SearchRequestDescriptor ScriptFields(Func - /// Used to retrieve the next page of hits using a set of sort values from the previous page. + /// + /// Used to retrieve the next page of hits using a set of sort values from the previous page. + /// /// public SearchRequestDescriptor SearchAfter(ICollection? searchAfter) { @@ -1589,7 +1944,9 @@ public SearchRequestDescriptor SearchAfter(ICollection - /// If `true`, returns sequence number and primary term of the last modification of each hit. + /// + /// If true, returns sequence number and primary term of the last modification of each hit. + /// /// public SearchRequestDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = true) { @@ -1598,7 +1955,11 @@ public SearchRequestDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTer } /// - /// The number of hits to return.
By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.
To page through more hits, use the `search_after` parameter. + /// + /// The number of hits to return. + /// By default, you cannot page through more than 10,000 hits using the from and size parameters. + /// To page through more hits, use the search_after parameter. + /// /// public SearchRequestDescriptor Size(int? size) { @@ -1607,7 +1968,9 @@ public SearchRequestDescriptor Size(int? size) } /// - /// Can be used to split a scrolled search into multiple slices that can be consumed independently. + /// + /// Can be used to split a scrolled search into multiple slices that can be consumed independently. + /// /// public SearchRequestDescriptor Slice(Elastic.Clients.Elasticsearch.SlicedScroll? slice) { @@ -1634,7 +1997,9 @@ public SearchRequestDescriptor Slice(Action - /// A comma-separated list of : pairs. + /// + /// A comma-separated list of <field>:<direction> pairs. + /// /// public SearchRequestDescriptor Sort(ICollection? sort) { @@ -1673,7 +2038,10 @@ public SearchRequestDescriptor Sort(params Action - /// Indicates which source fields are returned for matching documents.
These fields are returned in the hits._source property of the search response. + /// + /// Indicates which source fields are returned for matching documents. + /// These fields are returned in the hits._source property of the search response. + /// /// public SearchRequestDescriptor Source(Elastic.Clients.Elasticsearch.Core.Search.SourceConfig? source) { @@ -1682,7 +2050,11 @@ public SearchRequestDescriptor Source(Elastic.Clients.Elasticsearch.C } /// - /// Stats groups to associate with the search.
Each group maintains a statistics aggregation for its associated searches.
You can retrieve these stats using the indices stats API. + /// + /// Stats groups to associate with the search. + /// Each group maintains a statistics aggregation for its associated searches. + /// You can retrieve these stats using the indices stats API. + /// /// public SearchRequestDescriptor Stats(ICollection? stats) { @@ -1691,7 +2063,12 @@ public SearchRequestDescriptor Stats(ICollection? stats) } /// - /// List of stored fields to return as part of a hit.
If no fields are specified, no stored fields are included in the response.
If this field is specified, the `_source` parameter defaults to `false`.
You can pass `_source: true` to return both source fields and stored fields in the search response. + /// + /// List of stored fields to return as part of a hit. + /// If no fields are specified, no stored fields are included in the response. + /// If this field is specified, the _source parameter defaults to false. + /// You can pass _source: true to return both source fields and stored fields in the search response. + /// /// public SearchRequestDescriptor StoredFields(Elastic.Clients.Elasticsearch.Fields? storedFields) { @@ -1700,7 +2077,9 @@ public SearchRequestDescriptor StoredFields(Elastic.Clients.Elasticse } /// - /// Defines a suggester that provides similar looking terms based on a provided text. + /// + /// Defines a suggester that provides similar looking terms based on a provided text. + /// /// public SearchRequestDescriptor Suggest(Elastic.Clients.Elasticsearch.Core.Search.Suggester? suggest) { @@ -1727,7 +2106,16 @@ public SearchRequestDescriptor Suggest(Action - /// Maximum number of documents to collect for each shard.
If a query reaches this limit, Elasticsearch terminates the query early.
Elasticsearch collects documents before sorting.
Use with caution.
Elasticsearch applies this parameter to each shard handling the request.
When possible, let Elasticsearch perform early termination automatically.
Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.
If set to `0` (default), the query does not terminate early. + /// + /// Maximum number of documents to collect for each shard. + /// If a query reaches this limit, Elasticsearch terminates the query early. + /// Elasticsearch collects documents before sorting. + /// Use with caution. + /// Elasticsearch applies this parameter to each shard handling the request. + /// When possible, let Elasticsearch perform early termination automatically. + /// Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + /// If set to 0 (default), the query does not terminate early. + /// /// public SearchRequestDescriptor TerminateAfter(long? terminateAfter) { @@ -1736,7 +2124,11 @@ public SearchRequestDescriptor TerminateAfter(long? terminateAfter) } /// - /// Specifies the period of time to wait for a response from each shard.
If no response is received before the timeout expires, the request fails and returns an error.
Defaults to no timeout. + /// + /// Specifies the period of time to wait for a response from each shard. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// Defaults to no timeout. + /// /// public SearchRequestDescriptor Timeout(string? timeout) { @@ -1745,7 +2137,9 @@ public SearchRequestDescriptor Timeout(string? timeout) } /// - /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// + /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// /// public SearchRequestDescriptor TrackScores(bool? trackScores = true) { @@ -1754,7 +2148,11 @@ public SearchRequestDescriptor TrackScores(bool? trackScores = true) } /// - /// Number of hits matching the query to count accurately.
If `true`, the exact number of hits is returned at the cost of some performance.
If `false`, the response does not include the total number of hits matching the query. + /// + /// Number of hits matching the query to count accurately. + /// If true, the exact number of hits is returned at the cost of some performance. + /// If false, the response does not include the total number of hits matching the query. + /// /// public SearchRequestDescriptor TrackTotalHits(Elastic.Clients.Elasticsearch.Core.Search.TrackHits? trackTotalHits) { @@ -1763,7 +2161,9 @@ public SearchRequestDescriptor TrackTotalHits(Elastic.Clients.Elastic } /// - /// If true, returns document version as part of a hit. + /// + /// If true, returns document version as part of a hit. + /// /// public SearchRequestDescriptor Version(bool? version = true) { @@ -2192,7 +2592,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns search hits that match the query defined in the request.
You can provide search queries using the `q` query string parameter or the request body.
If both are specified, only the query parameter is used. +/// +/// Returns search hits that match the query defined in the request. +/// You can provide search queries using the q query string parameter or the request body. +/// If both are specified, only the query parameter is used. +/// /// public sealed partial class SearchRequestDescriptor : RequestDescriptor { @@ -2320,7 +2724,9 @@ public SearchRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? in private bool? VersionValue { get; set; } /// - /// Defines the aggregations that are run as part of the search request. + /// + /// Defines the aggregations that are run as part of the search request. + /// /// public SearchRequestDescriptor Aggregations(Func, FluentDescriptorDictionary> selector) { @@ -2329,7 +2735,9 @@ public SearchRequestDescriptor Aggregations(Func - /// Collapses search results the values of the specified field. + /// + /// Collapses search results the values of the specified field. + /// /// public SearchRequestDescriptor Collapse(Elastic.Clients.Elasticsearch.Core.Search.FieldCollapse? collapse) { @@ -2356,7 +2764,10 @@ public SearchRequestDescriptor Collapse(Action - /// Array of wildcard (`*`) patterns.
The request returns doc values for field names matching these patterns in the `hits.fields` property of the response. + /// + /// Array of wildcard (*) patterns. + /// The request returns doc values for field names matching these patterns in the hits.fields property of the response. + /// /// public SearchRequestDescriptor DocvalueFields(ICollection? docvalueFields) { @@ -2395,7 +2806,9 @@ public SearchRequestDescriptor DocvalueFields(params Action - /// If true, returns detailed information about score computation as part of a hit. + /// + /// If true, returns detailed information about score computation as part of a hit. + /// /// public SearchRequestDescriptor Explain(bool? explain = true) { @@ -2404,7 +2817,9 @@ public SearchRequestDescriptor Explain(bool? explain = true) } /// - /// Configuration of search extensions defined by Elasticsearch plugins. + /// + /// Configuration of search extensions defined by Elasticsearch plugins. + /// /// public SearchRequestDescriptor Ext(Func, FluentDictionary> selector) { @@ -2413,7 +2828,10 @@ public SearchRequestDescriptor Ext(Func, Fluent } /// - /// Array of wildcard (`*`) patterns.
The request returns values for field names matching these patterns in the `hits.fields` property of the response. + /// + /// Array of wildcard (*) patterns. + /// The request returns values for field names matching these patterns in the hits.fields property of the response. + /// /// public SearchRequestDescriptor Fields(ICollection? fields) { @@ -2452,7 +2870,12 @@ public SearchRequestDescriptor Fields(params Action - /// Starting document offset.
Needs to be non-negative.
By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.
To page through more hits, use the `search_after` parameter. + /// + /// Starting document offset. + /// Needs to be non-negative. + /// By default, you cannot page through more than 10,000 hits using the from and size parameters. + /// To page through more hits, use the search_after parameter. + /// /// public SearchRequestDescriptor From(int? from) { @@ -2461,7 +2884,9 @@ public SearchRequestDescriptor From(int? from) } /// - /// Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results. + /// + /// Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results. + /// /// public SearchRequestDescriptor Highlight(Elastic.Clients.Elasticsearch.Core.Search.Highlight? highlight) { @@ -2488,7 +2913,9 @@ public SearchRequestDescriptor Highlight(Action - /// Boosts the _score of documents from specified indices. + /// + /// Boosts the _score of documents from specified indices. + /// /// public SearchRequestDescriptor IndicesBoost(ICollection>? indicesBoost) { @@ -2497,7 +2924,9 @@ public SearchRequestDescriptor IndicesBoost(ICollection - /// Defines the approximate kNN search to run. + /// + /// Defines the approximate kNN search to run. + /// /// public SearchRequestDescriptor Knn(ICollection? knn) { @@ -2536,7 +2965,10 @@ public SearchRequestDescriptor Knn(params Action - /// Minimum `_score` for matching documents.
Documents with a lower `_score` are not included in the search results. + /// + /// Minimum _score for matching documents. + /// Documents with a lower _score are not included in the search results. + /// /// public SearchRequestDescriptor MinScore(double? minScore) { @@ -2545,7 +2977,10 @@ public SearchRequestDescriptor MinScore(double? minScore) } /// - /// Limits the search to a point in time (PIT).
If you provide a PIT, you cannot specify an `` in the request path. + /// + /// Limits the search to a point in time (PIT). + /// If you provide a PIT, you cannot specify an <index> in the request path. + /// /// public SearchRequestDescriptor Pit(Elastic.Clients.Elasticsearch.Core.Search.PointInTimeReference? pit) { @@ -2572,7 +3007,11 @@ public SearchRequestDescriptor Pit(Action - /// Use the `post_filter` parameter to filter search results.
The search hits are filtered after the aggregations are calculated.
A post filter has no impact on the aggregation results. + /// + /// Use the post_filter parameter to filter search results. + /// The search hits are filtered after the aggregations are calculated. + /// A post filter has no impact on the aggregation results. + /// /// public SearchRequestDescriptor PostFilter(Elastic.Clients.Elasticsearch.QueryDsl.Query? postFilter) { @@ -2599,7 +3038,10 @@ public SearchRequestDescriptor PostFilter(Action - /// Set to `true` to return detailed timing information about the execution of individual components in a search request.
NOTE: This is a debugging tool and adds significant overhead to search execution. + /// + /// Set to true to return detailed timing information about the execution of individual components in a search request. + /// NOTE: This is a debugging tool and adds significant overhead to search execution. + /// /// public SearchRequestDescriptor Profile(bool? profile = true) { @@ -2608,7 +3050,9 @@ public SearchRequestDescriptor Profile(bool? profile = true) } /// - /// Defines the search definition using the Query DSL. + /// + /// Defines the search definition using the Query DSL. + /// /// public SearchRequestDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -2635,7 +3079,9 @@ public SearchRequestDescriptor Query(Action - /// Defines the Reciprocal Rank Fusion (RRF) to use. + /// + /// Defines the Reciprocal Rank Fusion (RRF) to use. + /// /// public SearchRequestDescriptor Rank(Elastic.Clients.Elasticsearch.Rank? rank) { @@ -2662,7 +3108,9 @@ public SearchRequestDescriptor Rank(Action - /// Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases. + /// + /// Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the query and post_filter phases. + /// /// public SearchRequestDescriptor Rescore(ICollection? rescore) { @@ -2701,7 +3149,9 @@ public SearchRequestDescriptor Rescore(params Action - /// A retriever is a specification to describe top documents returned from a search. A retriever replaces other elements of the search API that also return top documents such as query and knn. + /// + /// A retriever is a specification to describe top documents returned from a search. A retriever replaces other elements of the search API that also return top documents such as query and knn. + /// /// public SearchRequestDescriptor Retriever(Elastic.Clients.Elasticsearch.Retriever? retriever) { @@ -2728,7 +3178,10 @@ public SearchRequestDescriptor Retriever(Action - /// Defines one or more runtime fields in the search request.
These fields take precedence over mapped fields with the same name. + /// + /// Defines one or more runtime fields in the search request. + /// These fields take precedence over mapped fields with the same name. + /// /// public SearchRequestDescriptor RuntimeMappings(Func, FluentDescriptorDictionary> selector) { @@ -2737,7 +3190,9 @@ public SearchRequestDescriptor RuntimeMappings(Func - /// Retrieve a script evaluation (based on different fields) for each hit. + /// + /// Retrieve a script evaluation (based on different fields) for each hit. + /// /// public SearchRequestDescriptor ScriptFields(Func, FluentDescriptorDictionary> selector) { @@ -2746,7 +3201,9 @@ public SearchRequestDescriptor ScriptFields(Func - /// Used to retrieve the next page of hits using a set of sort values from the previous page. + /// + /// Used to retrieve the next page of hits using a set of sort values from the previous page. + /// /// public SearchRequestDescriptor SearchAfter(ICollection? searchAfter) { @@ -2755,7 +3212,9 @@ public SearchRequestDescriptor SearchAfter(ICollection - /// If `true`, returns sequence number and primary term of the last modification of each hit. + /// + /// If true, returns sequence number and primary term of the last modification of each hit. + /// /// public SearchRequestDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = true) { @@ -2764,7 +3223,11 @@ public SearchRequestDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = true) } /// - /// The number of hits to return.
By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.
To page through more hits, use the `search_after` parameter. + /// + /// The number of hits to return. + /// By default, you cannot page through more than 10,000 hits using the from and size parameters. + /// To page through more hits, use the search_after parameter. + /// /// public SearchRequestDescriptor Size(int? size) { @@ -2773,7 +3236,9 @@ public SearchRequestDescriptor Size(int? size) } /// - /// Can be used to split a scrolled search into multiple slices that can be consumed independently. + /// + /// Can be used to split a scrolled search into multiple slices that can be consumed independently. + /// /// public SearchRequestDescriptor Slice(Elastic.Clients.Elasticsearch.SlicedScroll? slice) { @@ -2800,7 +3265,9 @@ public SearchRequestDescriptor Slice(Action - /// A comma-separated list of : pairs. + /// + /// A comma-separated list of <field>:<direction> pairs. + /// /// public SearchRequestDescriptor Sort(ICollection? sort) { @@ -2839,7 +3306,10 @@ public SearchRequestDescriptor Sort(params Action - /// Indicates which source fields are returned for matching documents.
These fields are returned in the hits._source property of the search response. + /// + /// Indicates which source fields are returned for matching documents. + /// These fields are returned in the hits._source property of the search response. + /// /// public SearchRequestDescriptor Source(Elastic.Clients.Elasticsearch.Core.Search.SourceConfig? source) { @@ -2848,7 +3318,11 @@ public SearchRequestDescriptor Source(Elastic.Clients.Elasticsearch.Core.Search. } /// - /// Stats groups to associate with the search.
Each group maintains a statistics aggregation for its associated searches.
You can retrieve these stats using the indices stats API. + /// + /// Stats groups to associate with the search. + /// Each group maintains a statistics aggregation for its associated searches. + /// You can retrieve these stats using the indices stats API. + /// /// public SearchRequestDescriptor Stats(ICollection? stats) { @@ -2857,7 +3331,12 @@ public SearchRequestDescriptor Stats(ICollection? stats) } /// - /// List of stored fields to return as part of a hit.
If no fields are specified, no stored fields are included in the response.
If this field is specified, the `_source` parameter defaults to `false`.
You can pass `_source: true` to return both source fields and stored fields in the search response. + /// + /// List of stored fields to return as part of a hit. + /// If no fields are specified, no stored fields are included in the response. + /// If this field is specified, the _source parameter defaults to false. + /// You can pass _source: true to return both source fields and stored fields in the search response. + /// /// public SearchRequestDescriptor StoredFields(Elastic.Clients.Elasticsearch.Fields? storedFields) { @@ -2866,7 +3345,9 @@ public SearchRequestDescriptor StoredFields(Elastic.Clients.Elasticsearch.Fields } /// - /// Defines a suggester that provides similar looking terms based on a provided text. + /// + /// Defines a suggester that provides similar looking terms based on a provided text. + /// /// public SearchRequestDescriptor Suggest(Elastic.Clients.Elasticsearch.Core.Search.Suggester? suggest) { @@ -2893,7 +3374,16 @@ public SearchRequestDescriptor Suggest(Action - /// Maximum number of documents to collect for each shard.
If a query reaches this limit, Elasticsearch terminates the query early.
Elasticsearch collects documents before sorting.
Use with caution.
Elasticsearch applies this parameter to each shard handling the request.
When possible, let Elasticsearch perform early termination automatically.
Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.
If set to `0` (default), the query does not terminate early. + /// + /// Maximum number of documents to collect for each shard. + /// If a query reaches this limit, Elasticsearch terminates the query early. + /// Elasticsearch collects documents before sorting. + /// Use with caution. + /// Elasticsearch applies this parameter to each shard handling the request. + /// When possible, let Elasticsearch perform early termination automatically. + /// Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + /// If set to 0 (default), the query does not terminate early. + /// /// public SearchRequestDescriptor TerminateAfter(long? terminateAfter) { @@ -2902,7 +3392,11 @@ public SearchRequestDescriptor TerminateAfter(long? terminateAfter) } /// - /// Specifies the period of time to wait for a response from each shard.
If no response is received before the timeout expires, the request fails and returns an error.
Defaults to no timeout. + /// + /// Specifies the period of time to wait for a response from each shard. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// Defaults to no timeout. + /// /// public SearchRequestDescriptor Timeout(string? timeout) { @@ -2911,7 +3405,9 @@ public SearchRequestDescriptor Timeout(string? timeout) } /// - /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// + /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// /// public SearchRequestDescriptor TrackScores(bool? trackScores = true) { @@ -2920,7 +3416,11 @@ public SearchRequestDescriptor TrackScores(bool? trackScores = true) } /// - /// Number of hits matching the query to count accurately.
If `true`, the exact number of hits is returned at the cost of some performance.
If `false`, the response does not include the total number of hits matching the query. + /// + /// Number of hits matching the query to count accurately. + /// If true, the exact number of hits is returned at the cost of some performance. + /// If false, the response does not include the total number of hits matching the query. + /// /// public SearchRequestDescriptor TrackTotalHits(Elastic.Clients.Elasticsearch.Core.Search.TrackHits? trackTotalHits) { @@ -2929,7 +3429,9 @@ public SearchRequestDescriptor TrackTotalHits(Elastic.Clients.Elasticsearch.Core } /// - /// If true, returns document version as part of a hit. + /// + /// If true, returns document version as part of a hit. + /// /// public SearchRequestDescriptor Version(bool? version = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchShardsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchShardsRequest.g.cs index 409256a844f..de6e724e796 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchShardsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchShardsRequest.g.cs @@ -32,38 +32,58 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class SearchShardsRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices.
For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, the request retrieves information from the local node only. + /// + /// If true, the request retrieves information from the local node only. + /// /// public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } } /// -/// Returns information about the indices and shards that a search request would be executed against. +/// +/// Returns information about the indices and shards that a search request would be executed against. +/// /// public sealed partial class SearchShardsRequest : PlainRequest { @@ -84,44 +104,64 @@ public SearchShardsRequest(Elastic.Clients.Elasticsearch.Indices? indices) : bas internal override string OperationName => "search_shards"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices.
For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, the request retrieves information from the local node only. + /// + /// If true, the request retrieves information from the local node only. + /// /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } } /// -/// Returns information about the indices and shards that a search request would be executed against. +/// +/// Returns information about the indices and shards that a search request would be executed against. +/// /// public sealed partial class SearchShardsRequestDescriptor : RequestDescriptor, SearchShardsRequestParameters> { @@ -162,7 +202,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns information about the indices and shards that a search request would be executed against. +/// +/// Returns information about the indices and shards that a search request would be executed against. +/// /// public sealed partial class SearchShardsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchTemplateRequest.g.cs index c75a96a6bb2..00bf927d32c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchTemplateRequest.g.cs @@ -32,63 +32,94 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class SearchTemplateRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices.
For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// If `true`, network round-trips are minimized for cross-cluster search requests. + /// + /// If true, network round-trips are minimized for cross-cluster search requests. + /// /// public bool? CcsMinimizeRoundtrips { get => Q("ccs_minimize_roundtrips"); set => Q("ccs_minimize_roundtrips", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled. + /// + /// If true, specified concrete, expanded, or aliased indices are not included in the response when throttled. + /// /// public bool? IgnoreThrottled { get => Q("ignore_throttled"); set => Q("ignore_throttled", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If true, hits.total are rendered as an integer in the response. + /// + /// If true, hits.total are rendered as an integer in the response. + /// /// public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Specifies how long a consistent view of the index
should be maintained for scrolled search. + /// + /// Specifies how long a consistent view of the index + /// should be maintained for scrolled search. + /// /// public Elastic.Clients.Elasticsearch.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); } /// - /// The type of the search operation. + /// + /// The type of the search operation. + /// /// public Elastic.Clients.Elasticsearch.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } /// - /// If `true`, the response prefixes aggregation and suggester names with their respective types. + /// + /// If true, the response prefixes aggregation and suggester names with their respective types. + /// /// public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } } /// -/// Runs a search with a search template. +/// +/// Runs a search with a search template. +/// /// public sealed partial class SearchTemplateRequest : PlainRequest { @@ -109,104 +140,150 @@ public SearchTemplateRequest(Elastic.Clients.Elasticsearch.Indices? indices) : b internal override string OperationName => "search_template"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices.
For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// If `true`, network round-trips are minimized for cross-cluster search requests. + /// + /// If true, network round-trips are minimized for cross-cluster search requests. + /// /// [JsonIgnore] public bool? CcsMinimizeRoundtrips { get => Q("ccs_minimize_roundtrips"); set => Q("ccs_minimize_roundtrips", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled. + /// + /// If true, specified concrete, expanded, or aliased indices are not included in the response when throttled. + /// /// [JsonIgnore] public bool? IgnoreThrottled { get => Q("ignore_throttled"); set => Q("ignore_throttled", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If true, hits.total are rendered as an integer in the response. + /// + /// If true, hits.total are rendered as an integer in the response. + /// /// [JsonIgnore] public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Specifies how long a consistent view of the index
should be maintained for scrolled search. + /// + /// Specifies how long a consistent view of the index + /// should be maintained for scrolled search. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); } /// - /// The type of the search operation. + /// + /// The type of the search operation. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } /// - /// If `true`, the response prefixes aggregation and suggester names with their respective types. + /// + /// If true, the response prefixes aggregation and suggester names with their respective types. + /// /// [JsonIgnore] public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } /// - /// If `true`, returns detailed information about score calculation as part of each hit. + /// + /// If true, returns detailed information about score calculation as part of each hit. + /// /// [JsonInclude, JsonPropertyName("explain")] public bool? Explain { get; set; } /// - /// ID of the search template to use. If no source is specified,
this parameter is required. + /// + /// ID of the search template to use. If no source is specified, + /// this parameter is required. + /// /// [JsonInclude, JsonPropertyName("id")] public Elastic.Clients.Elasticsearch.Id? Id { get; set; } /// - /// Key-value pairs used to replace Mustache variables in the template.
The key is the variable name.
The value is the variable value. + /// + /// Key-value pairs used to replace Mustache variables in the template. + /// The key is the variable name. + /// The value is the variable value. + /// /// [JsonInclude, JsonPropertyName("params")] public IDictionary? Params { get; set; } /// - /// If `true`, the query execution is profiled. + /// + /// If true, the query execution is profiled. + /// /// [JsonInclude, JsonPropertyName("profile")] public bool? Profile { get; set; } /// - /// An inline search template. Supports the same parameters as the search API's
request body. Also supports Mustache variables. If no id is specified, this
parameter is required. + /// + /// An inline search template. Supports the same parameters as the search API's + /// request body. Also supports Mustache variables. If no id is specified, this + /// parameter is required. + /// /// [JsonInclude, JsonPropertyName("source")] public string? Source { get; set; } } /// -/// Runs a search with a search template. +/// +/// Runs a search with a search template. +/// /// public sealed partial class SearchTemplateRequestDescriptor : RequestDescriptor, SearchTemplateRequestParameters> { @@ -253,7 +330,9 @@ public SearchTemplateRequestDescriptor Indices(Elastic.Clients.Elasti private string? SourceValue { get; set; } /// - /// If `true`, returns detailed information about score calculation as part of each hit. + /// + /// If true, returns detailed information about score calculation as part of each hit. + /// /// public SearchTemplateRequestDescriptor Explain(bool? explain = true) { @@ -262,7 +341,10 @@ public SearchTemplateRequestDescriptor Explain(bool? explain = true) } /// - /// ID of the search template to use. If no source is specified,
this parameter is required. + /// + /// ID of the search template to use. If no source is specified, + /// this parameter is required. + /// /// public SearchTemplateRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) { @@ -271,7 +353,11 @@ public SearchTemplateRequestDescriptor Id(Elastic.Clients.Elasticsear } /// - /// Key-value pairs used to replace Mustache variables in the template.
The key is the variable name.
The value is the variable value. + /// + /// Key-value pairs used to replace Mustache variables in the template. + /// The key is the variable name. + /// The value is the variable value. + /// /// public SearchTemplateRequestDescriptor Params(Func, FluentDictionary> selector) { @@ -280,7 +366,9 @@ public SearchTemplateRequestDescriptor Params(Func - /// If `true`, the query execution is profiled. + /// + /// If true, the query execution is profiled. + /// /// public SearchTemplateRequestDescriptor Profile(bool? profile = true) { @@ -289,7 +377,11 @@ public SearchTemplateRequestDescriptor Profile(bool? profile = true) } /// - /// An inline search template. Supports the same parameters as the search API's
request body. Also supports Mustache variables. If no id is specified, this
parameter is required. + /// + /// An inline search template. Supports the same parameters as the search API's + /// request body. Also supports Mustache variables. If no id is specified, this + /// parameter is required. + /// /// public SearchTemplateRequestDescriptor Source(string? source) { @@ -335,7 +427,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Runs a search with a search template. +/// +/// Runs a search with a search template. +/// /// public sealed partial class SearchTemplateRequestDescriptor : RequestDescriptor { @@ -382,7 +476,9 @@ public SearchTemplateRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Ind private string? SourceValue { get; set; } /// - /// If `true`, returns detailed information about score calculation as part of each hit. + /// + /// If true, returns detailed information about score calculation as part of each hit. + /// /// public SearchTemplateRequestDescriptor Explain(bool? explain = true) { @@ -391,7 +487,10 @@ public SearchTemplateRequestDescriptor Explain(bool? explain = true) } /// - /// ID of the search template to use. If no source is specified,
this parameter is required. + /// + /// ID of the search template to use. If no source is specified, + /// this parameter is required. + /// /// public SearchTemplateRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) { @@ -400,7 +499,11 @@ public SearchTemplateRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) } /// - /// Key-value pairs used to replace Mustache variables in the template.
The key is the variable name.
The value is the variable value. + /// + /// Key-value pairs used to replace Mustache variables in the template. + /// The key is the variable name. + /// The value is the variable value. + /// /// public SearchTemplateRequestDescriptor Params(Func, FluentDictionary> selector) { @@ -409,7 +512,9 @@ public SearchTemplateRequestDescriptor Params(Func - /// If `true`, the query execution is profiled. + /// + /// If true, the query execution is profiled. + /// /// public SearchTemplateRequestDescriptor Profile(bool? profile = true) { @@ -418,7 +523,11 @@ public SearchTemplateRequestDescriptor Profile(bool? profile = true) } /// - /// An inline search template. Supports the same parameters as the search API's
request body. Also supports Mustache variables. If no id is specified, this
parameter is required. + /// + /// An inline search template. Supports the same parameters as the search API's + /// request body. Also supports Mustache variables. If no id is specified, this + /// parameter is required. + /// /// public SearchTemplateRequestDescriptor Source(string? source) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/CacheStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/CacheStatsRequest.g.cs index da503d32ac4..83ae3bdd257 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/CacheStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/CacheStatsRequest.g.cs @@ -35,7 +35,9 @@ public sealed partial class CacheStatsRequestParameters : RequestParameters } /// -/// Retrieve node-level cache statistics about searchable snapshots. +/// +/// Retrieve node-level cache statistics about searchable snapshots. +/// /// public sealed partial class CacheStatsRequest : PlainRequest { @@ -60,7 +62,9 @@ public CacheStatsRequest(Elastic.Clients.Elasticsearch.NodeIds? nodeId) : base(r } /// -/// Retrieve node-level cache statistics about searchable snapshots. +/// +/// Retrieve node-level cache statistics about searchable snapshots. +/// /// public sealed partial class CacheStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/ClearCacheRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/ClearCacheRequest.g.cs index 1fc04bdccae..9178c546e08 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/ClearCacheRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/ClearCacheRequest.g.cs @@ -32,23 +32,31 @@ namespace Elastic.Clients.Elasticsearch.SearchableSnapshots; public sealed partial class ClearCacheRequestParameters : RequestParameters { /// - /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + /// + /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified) + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// + /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// + /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } } /// -/// Clear the cache of searchable snapshots. +/// +/// Clear the cache of searchable snapshots. +/// /// public sealed partial class ClearCacheRequest : PlainRequest { @@ -69,26 +77,34 @@ public ClearCacheRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base( internal override string OperationName => "searchable_snapshots.clear_cache"; /// - /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + /// + /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified) + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// + /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// + /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } } /// -/// Clear the cache of searchable snapshots. +/// +/// Clear the cache of searchable snapshots. +/// /// public sealed partial class ClearCacheRequestDescriptor : RequestDescriptor, ClearCacheRequestParameters> { @@ -126,7 +142,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Clear the cache of searchable snapshots. +/// +/// Clear the cache of searchable snapshots. +/// /// public sealed partial class ClearCacheRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/MountRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/MountRequest.g.cs index 238698ea22e..b58b03e111a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/MountRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/MountRequest.g.cs @@ -32,23 +32,31 @@ namespace Elastic.Clients.Elasticsearch.SearchableSnapshots; public sealed partial class MountRequestParameters : RequestParameters { /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Selects the kind of local storage used to accelerate searches. Experimental, and defaults to `full_copy` + /// + /// Selects the kind of local storage used to accelerate searches. Experimental, and defaults to full_copy + /// /// public string? Storage { get => Q("storage"); set => Q("storage", value); } /// - /// Should this request wait until the operation has completed before returning + /// + /// Should this request wait until the operation has completed before returning + /// /// public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Mount a snapshot as a searchable index. +/// +/// Mount a snapshot as a searchable index. +/// /// public sealed partial class MountRequest : PlainRequest { @@ -65,19 +73,25 @@ public MountRequest(Elastic.Clients.Elasticsearch.Name repository, Elastic.Clien internal override string OperationName => "searchable_snapshots.mount"; /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Selects the kind of local storage used to accelerate searches. Experimental, and defaults to `full_copy` + /// + /// Selects the kind of local storage used to accelerate searches. Experimental, and defaults to full_copy + /// /// [JsonIgnore] public string? Storage { get => Q("storage"); set => Q("storage", value); } /// - /// Should this request wait until the operation has completed before returning + /// + /// Should this request wait until the operation has completed before returning + /// /// [JsonIgnore] public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } @@ -92,7 +106,9 @@ public MountRequest(Elastic.Clients.Elasticsearch.Name repository, Elastic.Clien } /// -/// Mount a snapshot as a searchable index. +/// +/// Mount a snapshot as a searchable index. +/// /// public sealed partial class MountRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/SearchableSnapshotsStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/SearchableSnapshotsStatsRequest.g.cs index d7306d64eca..bbfcd700251 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/SearchableSnapshotsStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/SearchableSnapshotsStatsRequest.g.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch.SearchableSnapshots; public sealed partial class SearchableSnapshotsStatsRequestParameters : RequestParameters { /// - /// Return stats aggregated at cluster, index or shard level + /// + /// Return stats aggregated at cluster, index or shard level + /// /// public Elastic.Clients.Elasticsearch.SearchableSnapshots.StatsLevel? Level { get => Q("level"); set => Q("level", value); } } /// -/// Retrieve shard-level statistics about searchable snapshots. +/// +/// Retrieve shard-level statistics about searchable snapshots. +/// /// public sealed partial class SearchableSnapshotsStatsRequest : PlainRequest { @@ -59,14 +63,18 @@ public SearchableSnapshotsStatsRequest(Elastic.Clients.Elasticsearch.Indices? in internal override string OperationName => "searchable_snapshots.stats"; /// - /// Return stats aggregated at cluster, index or shard level + /// + /// Return stats aggregated at cluster, index or shard level + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.SearchableSnapshots.StatsLevel? Level { get => Q("level"); set => Q("level", value); } } /// -/// Retrieve shard-level statistics about searchable snapshots. +/// +/// Retrieve shard-level statistics about searchable snapshots. +/// /// public sealed partial class SearchableSnapshotsStatsRequestDescriptor : RequestDescriptor, SearchableSnapshotsStatsRequestParameters> { @@ -102,7 +110,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Retrieve shard-level statistics about searchable snapshots. +/// +/// Retrieve shard-level statistics about searchable snapshots. +/// /// public sealed partial class SearchableSnapshotsStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CleanupRepositoryRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CleanupRepositoryRequest.g.cs index 952c3db565c..2f9ab9e7ffd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CleanupRepositoryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CleanupRepositoryRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.Snapshot; public sealed partial class CleanupRepositoryRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node. + /// + /// Period to wait for a connection to the master node. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. + /// + /// Period to wait for a response. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. +/// +/// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. +/// /// public sealed partial class CleanupRepositoryRequest : PlainRequest { @@ -60,20 +66,26 @@ public CleanupRepositoryRequest(Elastic.Clients.Elasticsearch.Name name) : base( internal override string OperationName => "snapshot.cleanup_repository"; /// - /// Period to wait for a connection to the master node. + /// + /// Period to wait for a connection to the master node. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. + /// + /// Period to wait for a response. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. +/// +/// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. +/// /// public sealed partial class CleanupRepositoryRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CleanupRepositoryResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CleanupRepositoryResponse.g.cs index 078e36a39c8..7a5a0dd0e26 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CleanupRepositoryResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CleanupRepositoryResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Snapshot; public sealed partial class CleanupRepositoryResponse : ElasticsearchResponse { /// - /// Statistics for cleanup operations. + /// + /// Statistics for cleanup operations. + /// /// [JsonInclude, JsonPropertyName("results")] public Elastic.Clients.Elasticsearch.Snapshot.CleanupRepositoryResults Results { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CloneSnapshotRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CloneSnapshotRequest.g.cs index 85811837d4b..f078fc9544c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CloneSnapshotRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CloneSnapshotRequest.g.cs @@ -32,14 +32,18 @@ namespace Elastic.Clients.Elasticsearch.Snapshot; public sealed partial class CloneSnapshotRequestParameters : RequestParameters { /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Clones indices from one snapshot into another snapshot in the same repository. +/// +/// Clones indices from one snapshot into another snapshot in the same repository. +/// /// public sealed partial class CloneSnapshotRequest : PlainRequest { @@ -56,7 +60,9 @@ public CloneSnapshotRequest(Elastic.Clients.Elasticsearch.Name repository, Elast internal override string OperationName => "snapshot.clone"; /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } @@ -67,7 +73,9 @@ public CloneSnapshotRequest(Elastic.Clients.Elasticsearch.Name repository, Elast } /// -/// Clones indices from one snapshot into another snapshot in the same repository. +/// +/// Clones indices from one snapshot into another snapshot in the same repository. +/// /// public sealed partial class CloneSnapshotRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CloneSnapshotResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CloneSnapshotResponse.g.cs index 995423a2865..28a6abe2a04 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CloneSnapshotResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CloneSnapshotResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Snapshot; public sealed partial class CloneSnapshotResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CreateRepositoryRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CreateRepositoryRequest.g.cs index e749c8f82a1..4e2f6b00770 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CreateRepositoryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CreateRepositoryRequest.g.cs @@ -32,23 +32,31 @@ namespace Elastic.Clients.Elasticsearch.Snapshot; public sealed partial class CreateRepositoryRequestParameters : RequestParameters { /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// + /// Explicit operation timeout + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Whether to verify the repository after creation + /// + /// Whether to verify the repository after creation + /// /// public bool? Verify { get => Q("verify"); set => Q("verify", value); } } /// -/// Creates a repository. +/// +/// Creates a repository. +/// /// public sealed partial class CreateRepositoryRequest : PlainRequest, ISelfSerializable { @@ -65,19 +73,25 @@ public CreateRepositoryRequest(Elastic.Clients.Elasticsearch.Name name) : base(r internal override string OperationName => "snapshot.create_repository"; /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// + /// Explicit operation timeout + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Whether to verify the repository after creation + /// + /// Whether to verify the repository after creation + /// /// [JsonIgnore] public bool? Verify { get => Q("verify"); set => Q("verify", value); } @@ -91,7 +105,9 @@ void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions op } /// -/// Creates a repository. +/// +/// Creates a repository. +/// /// public sealed partial class CreateRepositoryRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CreateRepositoryResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CreateRepositoryResponse.g.cs index 0f2b6b67437..cfe979a738f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CreateRepositoryResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CreateRepositoryResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Snapshot; public sealed partial class CreateRepositoryResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CreateSnapshotRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CreateSnapshotRequest.g.cs index f8646a5110c..8fe4a5c2229 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CreateSnapshotRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CreateSnapshotRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.Snapshot; public sealed partial class CreateSnapshotRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// If `true`, the request returns a response when the snapshot is complete. If `false`, the request returns a response when the snapshot initializes. + /// + /// If true, the request returns a response when the snapshot is complete. If false, the request returns a response when the snapshot initializes. + /// /// public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Creates a snapshot in a repository. +/// +/// Creates a snapshot in a repository. +/// /// public sealed partial class CreateSnapshotRequest : PlainRequest { @@ -60,56 +66,74 @@ public CreateSnapshotRequest(Elastic.Clients.Elasticsearch.Name repository, Elas internal override string OperationName => "snapshot.create"; /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// If `true`, the request returns a response when the snapshot is complete. If `false`, the request returns a response when the snapshot initializes. + /// + /// If true, the request returns a response when the snapshot is complete. If false, the request returns a response when the snapshot initializes. + /// /// [JsonIgnore] public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } /// - /// Feature states to include in the snapshot. Each feature state includes one or more system indices containing related data. You can view a list of eligible features using the get features API. If `include_global_state` is `true`, all current feature states are included by default. If `include_global_state` is `false`, no feature states are included by default. + /// + /// Feature states to include in the snapshot. Each feature state includes one or more system indices containing related data. You can view a list of eligible features using the get features API. If include_global_state is true, all current feature states are included by default. If include_global_state is false, no feature states are included by default. + /// /// [JsonInclude, JsonPropertyName("feature_states")] public ICollection? FeatureStates { get; set; } /// - /// If `true`, the request ignores data streams and indices in `indices` that are missing or closed. If `false`, the request returns an error for any data stream or index that is missing or closed. + /// + /// If true, the request ignores data streams and indices in indices that are missing or closed. If false, the request returns an error for any data stream or index that is missing or closed. + /// /// [JsonInclude, JsonPropertyName("ignore_unavailable")] public bool? IgnoreUnavailable { get; set; } /// - /// If `true`, the current cluster state is included in the snapshot. The cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies. It also includes data stored in system indices, such as Watches and task records (configurable via `feature_states`). + /// + /// If true, the current cluster state is included in the snapshot. The cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies. It also includes data stored in system indices, such as Watches and task records (configurable via feature_states). + /// /// [JsonInclude, JsonPropertyName("include_global_state")] public bool? IncludeGlobalState { get; set; } /// - /// Data streams and indices to include in the snapshot. Supports multi-target syntax. Includes all data streams and indices by default. + /// + /// Data streams and indices to include in the snapshot. Supports multi-target syntax. Includes all data streams and indices by default. + /// /// [JsonInclude, JsonPropertyName("indices")] public Elastic.Clients.Elasticsearch.Indices? Indices { get; set; } /// - /// Optional metadata for the snapshot. May have any contents. Must be less than 1024 bytes. This map is not automatically generated by Elasticsearch. + /// + /// Optional metadata for the snapshot. May have any contents. Must be less than 1024 bytes. This map is not automatically generated by Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("metadata")] public IDictionary? Metadata { get; set; } /// - /// If `true`, allows restoring a partial snapshot of indices with unavailable shards. Only shards that were successfully included in the snapshot will be restored. All missing shards will be recreated as empty. If `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available. + /// + /// If true, allows restoring a partial snapshot of indices with unavailable shards. Only shards that were successfully included in the snapshot will be restored. All missing shards will be recreated as empty. If false, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available. + /// /// [JsonInclude, JsonPropertyName("partial")] public bool? Partial { get; set; } } /// -/// Creates a snapshot in a repository. +/// +/// Creates a snapshot in a repository. +/// /// public sealed partial class CreateSnapshotRequestDescriptor : RequestDescriptor { @@ -150,7 +174,9 @@ public CreateSnapshotRequestDescriptor Snapshot(Elastic.Clients.Elasticsearch.Na private bool? PartialValue { get; set; } /// - /// Feature states to include in the snapshot. Each feature state includes one or more system indices containing related data. You can view a list of eligible features using the get features API. If `include_global_state` is `true`, all current feature states are included by default. If `include_global_state` is `false`, no feature states are included by default. + /// + /// Feature states to include in the snapshot. Each feature state includes one or more system indices containing related data. You can view a list of eligible features using the get features API. If include_global_state is true, all current feature states are included by default. If include_global_state is false, no feature states are included by default. + /// /// public CreateSnapshotRequestDescriptor FeatureStates(ICollection? featureStates) { @@ -159,7 +185,9 @@ public CreateSnapshotRequestDescriptor FeatureStates(ICollection? featur } /// - /// If `true`, the request ignores data streams and indices in `indices` that are missing or closed. If `false`, the request returns an error for any data stream or index that is missing or closed. + /// + /// If true, the request ignores data streams and indices in indices that are missing or closed. If false, the request returns an error for any data stream or index that is missing or closed. + /// /// public CreateSnapshotRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) { @@ -168,7 +196,9 @@ public CreateSnapshotRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable } /// - /// If `true`, the current cluster state is included in the snapshot. The cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies. It also includes data stored in system indices, such as Watches and task records (configurable via `feature_states`). + /// + /// If true, the current cluster state is included in the snapshot. The cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies. It also includes data stored in system indices, such as Watches and task records (configurable via feature_states). + /// /// public CreateSnapshotRequestDescriptor IncludeGlobalState(bool? includeGlobalState = true) { @@ -177,7 +207,9 @@ public CreateSnapshotRequestDescriptor IncludeGlobalState(bool? includeGlobalSta } /// - /// Data streams and indices to include in the snapshot. Supports multi-target syntax. Includes all data streams and indices by default. + /// + /// Data streams and indices to include in the snapshot. Supports multi-target syntax. Includes all data streams and indices by default. + /// /// public CreateSnapshotRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? indices) { @@ -186,7 +218,9 @@ public CreateSnapshotRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Ind } /// - /// Optional metadata for the snapshot. May have any contents. Must be less than 1024 bytes. This map is not automatically generated by Elasticsearch. + /// + /// Optional metadata for the snapshot. May have any contents. Must be less than 1024 bytes. This map is not automatically generated by Elasticsearch. + /// /// public CreateSnapshotRequestDescriptor Metadata(Func, FluentDictionary> selector) { @@ -195,7 +229,9 @@ public CreateSnapshotRequestDescriptor Metadata(Func - /// If `true`, allows restoring a partial snapshot of indices with unavailable shards. Only shards that were successfully included in the snapshot will be restored. All missing shards will be recreated as empty. If `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available. + /// + /// If true, allows restoring a partial snapshot of indices with unavailable shards. Only shards that were successfully included in the snapshot will be restored. All missing shards will be recreated as empty. If false, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available. + /// /// public CreateSnapshotRequestDescriptor Partial(bool? partial = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CreateSnapshotResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CreateSnapshotResponse.g.cs index e528c91718c..3afcb6e1a68 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CreateSnapshotResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CreateSnapshotResponse.g.cs @@ -29,13 +29,17 @@ namespace Elastic.Clients.Elasticsearch.Snapshot; public sealed partial class CreateSnapshotResponse : ElasticsearchResponse { /// - /// Equals `true` if the snapshot was accepted. Present when the request had `wait_for_completion` set to `false` + /// + /// Equals true if the snapshot was accepted. Present when the request had wait_for_completion set to false + /// /// [JsonInclude, JsonPropertyName("accepted")] public bool? Accepted { get; init; } /// - /// Snapshot information. Present when the request had `wait_for_completion` set to `true` + /// + /// Snapshot information. Present when the request had wait_for_completion set to true + /// /// [JsonInclude, JsonPropertyName("snapshot")] public Elastic.Clients.Elasticsearch.Snapshot.SnapshotInfo? Snapshot { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/DeleteRepositoryRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/DeleteRepositoryRequest.g.cs index 92a715ef386..9fda4025422 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/DeleteRepositoryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/DeleteRepositoryRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.Snapshot; public sealed partial class DeleteRepositoryRequestParameters : RequestParameters { /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// + /// Explicit operation timeout + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Deletes a repository. +/// +/// Deletes a repository. +/// /// public sealed partial class DeleteRepositoryRequest : PlainRequest { @@ -60,20 +66,26 @@ public DeleteRepositoryRequest(Elastic.Clients.Elasticsearch.Names name) : base( internal override string OperationName => "snapshot.delete_repository"; /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// + /// Explicit operation timeout + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Deletes a repository. +/// +/// Deletes a repository. +/// /// public sealed partial class DeleteRepositoryRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/DeleteRepositoryResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/DeleteRepositoryResponse.g.cs index e2c5db4a72a..0c043369220 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/DeleteRepositoryResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/DeleteRepositoryResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Snapshot; public sealed partial class DeleteRepositoryResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/DeleteSnapshotRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/DeleteSnapshotRequest.g.cs index 088eaf4ccbf..b21f1b922fe 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/DeleteSnapshotRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/DeleteSnapshotRequest.g.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch.Snapshot; public sealed partial class DeleteSnapshotRequestParameters : RequestParameters { /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Deletes one or more snapshots. +/// +/// Deletes one or more snapshots. +/// /// public sealed partial class DeleteSnapshotRequest : PlainRequest { @@ -55,14 +59,18 @@ public DeleteSnapshotRequest(Elastic.Clients.Elasticsearch.Name repository, Elas internal override string OperationName => "snapshot.delete"; /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Deletes one or more snapshots. +/// +/// Deletes one or more snapshots. +/// /// public sealed partial class DeleteSnapshotRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/DeleteSnapshotResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/DeleteSnapshotResponse.g.cs index b760579ca33..e1a69227318 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/DeleteSnapshotResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/DeleteSnapshotResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Snapshot; public sealed partial class DeleteSnapshotResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/GetRepositoryRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/GetRepositoryRequest.g.cs index b01d869090a..31c8c0b691d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/GetRepositoryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/GetRepositoryRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.Snapshot; public sealed partial class GetRepositoryRequestParameters : RequestParameters { /// - /// Return local information, do not retrieve the state from master node (default: false) + /// + /// Return local information, do not retrieve the state from master node (default: false) + /// /// public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Returns information about a repository. +/// +/// Returns information about a repository. +/// /// public sealed partial class GetRepositoryRequest : PlainRequest { @@ -64,20 +70,26 @@ public GetRepositoryRequest(Elastic.Clients.Elasticsearch.Names? name) : base(r internal override string OperationName => "snapshot.get_repository"; /// - /// Return local information, do not retrieve the state from master node (default: false) + /// + /// Return local information, do not retrieve the state from master node (default: false) + /// /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Returns information about a repository. +/// +/// Returns information about a repository. +/// /// public sealed partial class GetRepositoryRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/GetSnapshotRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/GetSnapshotRequest.g.cs index 2e6399db2b3..3491a21cb36 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/GetSnapshotRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/GetSnapshotRequest.g.cs @@ -32,73 +32,101 @@ namespace Elastic.Clients.Elasticsearch.Snapshot; public sealed partial class GetSnapshotRequestParameters : RequestParameters { /// - /// Offset identifier to start pagination from as returned by the next field in the response body. + /// + /// Offset identifier to start pagination from as returned by the next field in the response body. + /// /// public string? After { get => Q("after"); set => Q("after", value); } /// - /// Value of the current sort column at which to start retrieval. Can either be a string snapshot- or repository name when sorting by snapshot or repository name, a millisecond time value or a number when sorting by index- or shard count. + /// + /// Value of the current sort column at which to start retrieval. Can either be a string snapshot- or repository name when sorting by snapshot or repository name, a millisecond time value or a number when sorting by index- or shard count. + /// /// public string? FromSortValue { get => Q("from_sort_value"); set => Q("from_sort_value", value); } /// - /// If false, the request returns an error for any snapshots that are unavailable. + /// + /// If false, the request returns an error for any snapshots that are unavailable. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If true, returns the repository name in each snapshot. + /// + /// If true, returns the repository name in each snapshot. + /// /// public bool? IncludeRepository { get => Q("include_repository"); set => Q("include_repository", value); } /// - /// If true, returns additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index. Defaults to false, meaning that this information is omitted. + /// + /// If true, returns additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index. Defaults to false, meaning that this information is omitted. + /// /// public bool? IndexDetails { get => Q("index_details"); set => Q("index_details", value); } /// - /// If true, returns the name of each index in each snapshot. + /// + /// If true, returns the name of each index in each snapshot. + /// /// public bool? IndexNames { get => Q("index_names"); set => Q("index_names", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually exclusive with using the after parameter. Defaults to 0. + /// + /// Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually exclusive with using the after parameter. Defaults to 0. + /// /// public int? Offset { get => Q("offset"); set => Q("offset", value); } /// - /// Sort order. Valid values are asc for ascending and desc for descending order. Defaults to asc, meaning ascending order. + /// + /// Sort order. Valid values are asc for ascending and desc for descending order. Defaults to asc, meaning ascending order. + /// /// public Elastic.Clients.Elasticsearch.SortOrder? Order { get => Q("order"); set => Q("order", value); } /// - /// Maximum number of snapshots to return. Defaults to 0 which means return all that match the request without limit. + /// + /// Maximum number of snapshots to return. Defaults to 0 which means return all that match the request without limit. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } /// - /// Filter snapshots by a comma-separated list of SLM policy names that snapshots belong to. Also accepts wildcards (*) and combinations of wildcards followed by exclude patterns starting with -. To include snapshots not created by an SLM policy you can use the special pattern _none that will match all snapshots without an SLM policy. + /// + /// Filter snapshots by a comma-separated list of SLM policy names that snapshots belong to. Also accepts wildcards (*) and combinations of wildcards followed by exclude patterns starting with -. To include snapshots not created by an SLM policy you can use the special pattern _none that will match all snapshots without an SLM policy. + /// /// public Elastic.Clients.Elasticsearch.Name? SlmPolicyFilter { get => Q("slm_policy_filter"); set => Q("slm_policy_filter", value); } /// - /// Allows setting a sort order for the result. Defaults to start_time, i.e. sorting by snapshot start time stamp. + /// + /// Allows setting a sort order for the result. Defaults to start_time, i.e. sorting by snapshot start time stamp. + /// /// public Elastic.Clients.Elasticsearch.Snapshot.SnapshotSort? Sort { get => Q("sort"); set => Q("sort", value); } /// - /// If true, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted. + /// + /// If true, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted. + /// /// public bool? Verbose { get => Q("verbose"); set => Q("verbose", value); } } /// -/// Returns information about a snapshot. +/// +/// Returns information about a snapshot. +/// /// public sealed partial class GetSnapshotRequest : PlainRequest { @@ -115,86 +143,114 @@ public GetSnapshotRequest(Elastic.Clients.Elasticsearch.Name repository, Elastic internal override string OperationName => "snapshot.get"; /// - /// Offset identifier to start pagination from as returned by the next field in the response body. + /// + /// Offset identifier to start pagination from as returned by the next field in the response body. + /// /// [JsonIgnore] public string? After { get => Q("after"); set => Q("after", value); } /// - /// Value of the current sort column at which to start retrieval. Can either be a string snapshot- or repository name when sorting by snapshot or repository name, a millisecond time value or a number when sorting by index- or shard count. + /// + /// Value of the current sort column at which to start retrieval. Can either be a string snapshot- or repository name when sorting by snapshot or repository name, a millisecond time value or a number when sorting by index- or shard count. + /// /// [JsonIgnore] public string? FromSortValue { get => Q("from_sort_value"); set => Q("from_sort_value", value); } /// - /// If false, the request returns an error for any snapshots that are unavailable. + /// + /// If false, the request returns an error for any snapshots that are unavailable. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If true, returns the repository name in each snapshot. + /// + /// If true, returns the repository name in each snapshot. + /// /// [JsonIgnore] public bool? IncludeRepository { get => Q("include_repository"); set => Q("include_repository", value); } /// - /// If true, returns additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index. Defaults to false, meaning that this information is omitted. + /// + /// If true, returns additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index. Defaults to false, meaning that this information is omitted. + /// /// [JsonIgnore] public bool? IndexDetails { get => Q("index_details"); set => Q("index_details", value); } /// - /// If true, returns the name of each index in each snapshot. + /// + /// If true, returns the name of each index in each snapshot. + /// /// [JsonIgnore] public bool? IndexNames { get => Q("index_names"); set => Q("index_names", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually exclusive with using the after parameter. Defaults to 0. + /// + /// Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually exclusive with using the after parameter. Defaults to 0. + /// /// [JsonIgnore] public int? Offset { get => Q("offset"); set => Q("offset", value); } /// - /// Sort order. Valid values are asc for ascending and desc for descending order. Defaults to asc, meaning ascending order. + /// + /// Sort order. Valid values are asc for ascending and desc for descending order. Defaults to asc, meaning ascending order. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.SortOrder? Order { get => Q("order"); set => Q("order", value); } /// - /// Maximum number of snapshots to return. Defaults to 0 which means return all that match the request without limit. + /// + /// Maximum number of snapshots to return. Defaults to 0 which means return all that match the request without limit. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } /// - /// Filter snapshots by a comma-separated list of SLM policy names that snapshots belong to. Also accepts wildcards (*) and combinations of wildcards followed by exclude patterns starting with -. To include snapshots not created by an SLM policy you can use the special pattern _none that will match all snapshots without an SLM policy. + /// + /// Filter snapshots by a comma-separated list of SLM policy names that snapshots belong to. Also accepts wildcards (*) and combinations of wildcards followed by exclude patterns starting with -. To include snapshots not created by an SLM policy you can use the special pattern _none that will match all snapshots without an SLM policy. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Name? SlmPolicyFilter { get => Q("slm_policy_filter"); set => Q("slm_policy_filter", value); } /// - /// Allows setting a sort order for the result. Defaults to start_time, i.e. sorting by snapshot start time stamp. + /// + /// Allows setting a sort order for the result. Defaults to start_time, i.e. sorting by snapshot start time stamp. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Snapshot.SnapshotSort? Sort { get => Q("sort"); set => Q("sort", value); } /// - /// If true, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted. + /// + /// If true, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted. + /// /// [JsonIgnore] public bool? Verbose { get => Q("verbose"); set => Q("verbose", value); } } /// -/// Returns information about a snapshot. +/// +/// Returns information about a snapshot. +/// /// public sealed partial class GetSnapshotRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/GetSnapshotResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/GetSnapshotResponse.g.cs index 2534c13bb2f..929c06311cc 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/GetSnapshotResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/GetSnapshotResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Snapshot; public sealed partial class GetSnapshotResponse : ElasticsearchResponse { /// - /// The number of remaining snapshots that were not returned due to size limits and that can be fetched by additional requests using the next field value. + /// + /// The number of remaining snapshots that were not returned due to size limits and that can be fetched by additional requests using the next field value. + /// /// [JsonInclude, JsonPropertyName("remaining")] public int Remaining { get; init; } @@ -39,7 +41,9 @@ public sealed partial class GetSnapshotResponse : ElasticsearchResponse public IReadOnlyCollection? Snapshots { get; init; } /// - /// The total number of snapshots that match the request when ignoring size limit or after query parameter. + /// + /// The total number of snapshots that match the request when ignoring size limit or after query parameter. + /// /// [JsonInclude, JsonPropertyName("total")] public int Total { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/RestoreRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/RestoreRequest.g.cs index d9561d27ac1..e7d9235bbfc 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/RestoreRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/RestoreRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.Snapshot; public sealed partial class RestoreRequestParameters : RequestParameters { /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Should this request wait until the operation has completed before returning + /// + /// Should this request wait until the operation has completed before returning + /// /// public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Restores a snapshot. +/// +/// Restores a snapshot. +/// /// public sealed partial class RestoreRequest : PlainRequest { @@ -60,13 +66,17 @@ public RestoreRequest(Elastic.Clients.Elasticsearch.Name repository, Elastic.Cli internal override string OperationName => "snapshot.restore"; /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Should this request wait until the operation has completed before returning + /// + /// Should this request wait until the operation has completed before returning + /// /// [JsonIgnore] public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } @@ -93,7 +103,9 @@ public RestoreRequest(Elastic.Clients.Elasticsearch.Name repository, Elastic.Cli } /// -/// Restores a snapshot. +/// +/// Restores a snapshot. +/// /// public sealed partial class RestoreRequestDescriptor : RequestDescriptor, RestoreRequestParameters> { @@ -295,7 +307,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Restores a snapshot. +/// +/// Restores a snapshot. +/// /// public sealed partial class RestoreRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/SnapshotStatusRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/SnapshotStatusRequest.g.cs index f6226e8928e..9e92916588a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/SnapshotStatusRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/SnapshotStatusRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.Snapshot; public sealed partial class SnapshotStatusRequestParameters : RequestParameters { /// - /// Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown + /// + /// Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Returns information about the status of a snapshot. +/// +/// Returns information about the status of a snapshot. +/// /// public sealed partial class SnapshotStatusRequest : PlainRequest { @@ -68,20 +74,26 @@ public SnapshotStatusRequest(Elastic.Clients.Elasticsearch.Name? repository, Ela internal override string OperationName => "snapshot.status"; /// - /// Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown + /// + /// Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Returns information about the status of a snapshot. +/// +/// Returns information about the status of a snapshot. +/// /// public sealed partial class SnapshotStatusRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/VerifyRepositoryRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/VerifyRepositoryRequest.g.cs index b845d1fce53..38a5562fdf9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/VerifyRepositoryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/VerifyRepositoryRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.Snapshot; public sealed partial class VerifyRepositoryRequestParameters : RequestParameters { /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// + /// Explicit operation timeout + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Verifies a repository. +/// +/// Verifies a repository. +/// /// public sealed partial class VerifyRepositoryRequest : PlainRequest { @@ -60,20 +66,26 @@ public VerifyRepositoryRequest(Elastic.Clients.Elasticsearch.Name name) : base(r internal override string OperationName => "snapshot.verify_repository"; /// - /// Explicit operation timeout for connection to master node + /// + /// Explicit operation timeout for connection to master node + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// + /// Explicit operation timeout + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Verifies a repository. +/// +/// Verifies a repository. +/// /// public sealed partial class VerifyRepositoryRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/DeleteLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/DeleteLifecycleRequest.g.cs index 68f69c2b191..320ec5bffb7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/DeleteLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/DeleteLifecycleRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class DeleteLifecycleRequestParameters : RequestParameters } /// -/// Deletes an existing snapshot lifecycle policy. +/// +/// Deletes an existing snapshot lifecycle policy. +/// /// public sealed partial class DeleteLifecycleRequest : PlainRequest { @@ -52,7 +54,9 @@ public DeleteLifecycleRequest(Elastic.Clients.Elasticsearch.Name policyId) : bas } /// -/// Deletes an existing snapshot lifecycle policy. +/// +/// Deletes an existing snapshot lifecycle policy. +/// /// public sealed partial class DeleteLifecycleRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/DeleteLifecycleResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/DeleteLifecycleResponse.g.cs index b540cd23ed5..ca9286d517a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/DeleteLifecycleResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/DeleteLifecycleResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.SnapshotLifecycleManagement; public sealed partial class DeleteLifecycleResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/ExecuteLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/ExecuteLifecycleRequest.g.cs index 0c11cc3b6bd..bb8dc91cb3c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/ExecuteLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/ExecuteLifecycleRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class ExecuteLifecycleRequestParameters : RequestParameter } /// -/// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. +/// +/// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. +/// /// public sealed partial class ExecuteLifecycleRequest : PlainRequest { @@ -52,7 +54,9 @@ public ExecuteLifecycleRequest(Elastic.Clients.Elasticsearch.Name policyId) : ba } /// -/// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. +/// +/// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. +/// /// public sealed partial class ExecuteLifecycleRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/ExecuteRetentionRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/ExecuteRetentionRequest.g.cs index a605f8f3a73..3b1416913f0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/ExecuteRetentionRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/ExecuteRetentionRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class ExecuteRetentionRequestParameters : RequestParameter } /// -/// Deletes any snapshots that are expired according to the policy's retention rules. +/// +/// Deletes any snapshots that are expired according to the policy's retention rules. +/// /// public sealed partial class ExecuteRetentionRequest : PlainRequest { @@ -48,7 +50,9 @@ public sealed partial class ExecuteRetentionRequest : PlainRequest -/// Deletes any snapshots that are expired according to the policy's retention rules. +/// +/// Deletes any snapshots that are expired according to the policy's retention rules. +/// /// public sealed partial class ExecuteRetentionRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/ExecuteRetentionResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/ExecuteRetentionResponse.g.cs index e827287e1ce..42e6e3e5727 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/ExecuteRetentionResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/ExecuteRetentionResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.SnapshotLifecycleManagement; public sealed partial class ExecuteRetentionResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/GetLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/GetLifecycleRequest.g.cs index abdb7285eef..6d6625ca04a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/GetLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/GetLifecycleRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class GetLifecycleRequestParameters : RequestParameters } /// -/// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. +/// +/// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. +/// /// public sealed partial class GetLifecycleRequest : PlainRequest { @@ -56,7 +58,9 @@ public GetLifecycleRequest(Elastic.Clients.Elasticsearch.Names? policyId) : base } /// -/// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. +/// +/// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. +/// /// public sealed partial class GetLifecycleRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/GetSlmStatusRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/GetSlmStatusRequest.g.cs index 06c5c19cf36..8d1eab503a0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/GetSlmStatusRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/GetSlmStatusRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class GetSlmStatusRequestParameters : RequestParameters } /// -/// Retrieves the status of snapshot lifecycle management (SLM). +/// +/// Retrieves the status of snapshot lifecycle management (SLM). +/// /// public sealed partial class GetSlmStatusRequest : PlainRequest { @@ -48,7 +50,9 @@ public sealed partial class GetSlmStatusRequest : PlainRequest -/// Retrieves the status of snapshot lifecycle management (SLM). +/// +/// Retrieves the status of snapshot lifecycle management (SLM). +/// /// public sealed partial class GetSlmStatusRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/GetStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/GetStatsRequest.g.cs index 47a23e1ec72..84629bdb756 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/GetStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/GetStatsRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class GetStatsRequestParameters : RequestParameters } /// -/// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. +/// +/// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. +/// /// public sealed partial class GetStatsRequest : PlainRequest { @@ -48,7 +50,9 @@ public sealed partial class GetStatsRequest : PlainRequest -/// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. +/// +/// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. +/// /// public sealed partial class GetStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/PutLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/PutLifecycleRequest.g.cs index 911f794de86..ecfd86c5eb2 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/PutLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/PutLifecycleRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.SnapshotLifecycleManagement; public sealed partial class PutLifecycleRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Creates or updates a snapshot lifecycle policy. +/// +/// Creates or updates a snapshot lifecycle policy. +/// /// public sealed partial class PutLifecycleRequest : PlainRequest { @@ -60,50 +66,66 @@ public PutLifecycleRequest(Elastic.Clients.Elasticsearch.Name policyId) : base(r internal override string OperationName => "slm.put_lifecycle"; /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Configuration for each snapshot created by the policy. + /// + /// Configuration for each snapshot created by the policy. + /// /// [JsonInclude, JsonPropertyName("config")] public Elastic.Clients.Elasticsearch.SnapshotLifecycleManagement.SlmConfiguration? Config { get; set; } /// - /// Name automatically assigned to each snapshot created by the policy. Date math is supported. To prevent conflicting snapshot names, a UUID is automatically appended to each snapshot name. + /// + /// Name automatically assigned to each snapshot created by the policy. Date math is supported. To prevent conflicting snapshot names, a UUID is automatically appended to each snapshot name. + /// /// [JsonInclude, JsonPropertyName("name")] public Elastic.Clients.Elasticsearch.Name? Name { get; set; } /// - /// Repository used to store snapshots created by this policy. This repository must exist prior to the policy’s creation. You can create a repository using the snapshot repository API. + /// + /// Repository used to store snapshots created by this policy. This repository must exist prior to the policy’s creation. You can create a repository using the snapshot repository API. + /// /// [JsonInclude, JsonPropertyName("repository")] public string? Repository { get; set; } /// - /// Retention rules used to retain and delete snapshots created by the policy. + /// + /// Retention rules used to retain and delete snapshots created by the policy. + /// /// [JsonInclude, JsonPropertyName("retention")] public Elastic.Clients.Elasticsearch.SnapshotLifecycleManagement.Retention? Retention { get; set; } /// - /// Periodic or absolute schedule at which the policy creates snapshots. SLM applies schedule changes immediately. + /// + /// Periodic or absolute schedule at which the policy creates snapshots. SLM applies schedule changes immediately. + /// /// [JsonInclude, JsonPropertyName("schedule")] public string? Schedule { get; set; } } /// -/// Creates or updates a snapshot lifecycle policy. +/// +/// Creates or updates a snapshot lifecycle policy. +/// /// public sealed partial class PutLifecycleRequestDescriptor : RequestDescriptor { @@ -141,7 +163,9 @@ public PutLifecycleRequestDescriptor PolicyId(Elastic.Clients.Elasticsearch.Name private string? ScheduleValue { get; set; } /// - /// Configuration for each snapshot created by the policy. + /// + /// Configuration for each snapshot created by the policy. + /// /// public PutLifecycleRequestDescriptor Config(Elastic.Clients.Elasticsearch.SnapshotLifecycleManagement.SlmConfiguration? config) { @@ -168,7 +192,9 @@ public PutLifecycleRequestDescriptor Config(Action - /// Name automatically assigned to each snapshot created by the policy. Date math is supported. To prevent conflicting snapshot names, a UUID is automatically appended to each snapshot name. + /// + /// Name automatically assigned to each snapshot created by the policy. Date math is supported. To prevent conflicting snapshot names, a UUID is automatically appended to each snapshot name. + /// /// public PutLifecycleRequestDescriptor Name(Elastic.Clients.Elasticsearch.Name? name) { @@ -177,7 +203,9 @@ public PutLifecycleRequestDescriptor Name(Elastic.Clients.Elasticsearch.Name? na } /// - /// Repository used to store snapshots created by this policy. This repository must exist prior to the policy’s creation. You can create a repository using the snapshot repository API. + /// + /// Repository used to store snapshots created by this policy. This repository must exist prior to the policy’s creation. You can create a repository using the snapshot repository API. + /// /// public PutLifecycleRequestDescriptor Repository(string? repository) { @@ -186,7 +214,9 @@ public PutLifecycleRequestDescriptor Repository(string? repository) } /// - /// Retention rules used to retain and delete snapshots created by the policy. + /// + /// Retention rules used to retain and delete snapshots created by the policy. + /// /// public PutLifecycleRequestDescriptor Retention(Elastic.Clients.Elasticsearch.SnapshotLifecycleManagement.Retention? retention) { @@ -213,7 +243,9 @@ public PutLifecycleRequestDescriptor Retention(Action - /// Periodic or absolute schedule at which the policy creates snapshots. SLM applies schedule changes immediately. + /// + /// Periodic or absolute schedule at which the policy creates snapshots. SLM applies schedule changes immediately. + /// /// public PutLifecycleRequestDescriptor Schedule(string? schedule) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/PutLifecycleResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/PutLifecycleResponse.g.cs index 1d4b1704dda..e9eaecf826f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/PutLifecycleResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/PutLifecycleResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.SnapshotLifecycleManagement; public sealed partial class PutLifecycleResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/StartSlmRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/StartSlmRequest.g.cs index 5e8e0d3ce78..cf3d0e3fa1e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/StartSlmRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/StartSlmRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class StartSlmRequestParameters : RequestParameters } /// -/// Turns on snapshot lifecycle management (SLM). +/// +/// Turns on snapshot lifecycle management (SLM). +/// /// public sealed partial class StartSlmRequest : PlainRequest { @@ -48,7 +50,9 @@ public sealed partial class StartSlmRequest : PlainRequest -/// Turns on snapshot lifecycle management (SLM). +/// +/// Turns on snapshot lifecycle management (SLM). +/// /// public sealed partial class StartSlmRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/StartSlmResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/StartSlmResponse.g.cs index ab428155de2..8ebc963e7ac 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/StartSlmResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/StartSlmResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.SnapshotLifecycleManagement; public sealed partial class StartSlmResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/StopSlmRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/StopSlmRequest.g.cs index 4d236ed8087..ca7010957b7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/StopSlmRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/StopSlmRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class StopSlmRequestParameters : RequestParameters } /// -/// Turns off snapshot lifecycle management (SLM). +/// +/// Turns off snapshot lifecycle management (SLM). +/// /// public sealed partial class StopSlmRequest : PlainRequest { @@ -48,7 +50,9 @@ public sealed partial class StopSlmRequest : PlainRequest -/// Turns off snapshot lifecycle management (SLM). +/// +/// Turns off snapshot lifecycle management (SLM). +/// /// public sealed partial class StopSlmRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/StopSlmResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/StopSlmResponse.g.cs index a982f56ef95..c7f3fd2cc66 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/StopSlmResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/StopSlmResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.SnapshotLifecycleManagement; public sealed partial class StopSlmResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/ClearCursorRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/ClearCursorRequest.g.cs index 187a4b736fb..ed3b52ea2e3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/ClearCursorRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/ClearCursorRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class ClearCursorRequestParameters : RequestParameters } /// -/// Clears the SQL cursor +/// +/// Clears the SQL cursor +/// /// public sealed partial class ClearCursorRequest : PlainRequest { @@ -47,14 +49,18 @@ public sealed partial class ClearCursorRequest : PlainRequest "sql.clear_cursor"; /// - /// Cursor to clear. + /// + /// Cursor to clear. + /// /// [JsonInclude, JsonPropertyName("cursor")] public string Cursor { get; set; } } /// -/// Clears the SQL cursor +/// +/// Clears the SQL cursor +/// /// public sealed partial class ClearCursorRequestDescriptor : RequestDescriptor { @@ -75,7 +81,9 @@ public ClearCursorRequestDescriptor() private string CursorValue { get; set; } /// - /// Cursor to clear. + /// + /// Cursor to clear. + /// /// public ClearCursorRequestDescriptor Cursor(string cursor) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/DeleteAsyncRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/DeleteAsyncRequest.g.cs index d250f5c878b..1e27e791903 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/DeleteAsyncRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/DeleteAsyncRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class DeleteAsyncRequestParameters : RequestParameters } /// -/// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. +/// +/// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. +/// /// public sealed partial class DeleteAsyncRequest : PlainRequest { @@ -52,7 +54,9 @@ public DeleteAsyncRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Req } /// -/// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. +/// +/// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. +/// /// public sealed partial class DeleteAsyncRequestDescriptor : RequestDescriptor, DeleteAsyncRequestParameters> { @@ -82,7 +86,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. +/// +/// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. +/// /// public sealed partial class DeleteAsyncRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/DeleteAsyncResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/DeleteAsyncResponse.g.cs index b92f1b8198a..29fa3e3e14d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/DeleteAsyncResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/DeleteAsyncResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Sql; public sealed partial class DeleteAsyncResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/GetAsyncRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/GetAsyncRequest.g.cs index 9598caf649c..77c68f95956 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/GetAsyncRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/GetAsyncRequest.g.cs @@ -32,28 +32,41 @@ namespace Elastic.Clients.Elasticsearch.Sql; public sealed partial class GetAsyncRequestParameters : RequestParameters { /// - /// Separator for CSV results. The API only supports this parameter for CSV responses. + /// + /// Separator for CSV results. The API only supports this parameter for CSV responses. + /// /// public string? Delimiter { get => Q("delimiter"); set => Q("delimiter", value); } /// - /// Format for the response. You must specify a format using this parameter or the
Accept HTTP header. If you specify both, the API uses this parameter. + /// + /// Format for the response. You must specify a format using this parameter or the + /// Accept HTTP header. If you specify both, the API uses this parameter. + /// /// public string? Format { get => Q("format"); set => Q("format", value); } /// - /// Retention period for the search and its results. Defaults
to the `keep_alive` period for the original SQL search. + /// + /// Retention period for the search and its results. Defaults + /// to the keep_alive period for the original SQL search. + /// /// public Elastic.Clients.Elasticsearch.Duration? KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); } /// - /// Period to wait for complete results. Defaults to no timeout,
meaning the request waits for complete search results. + /// + /// Period to wait for complete results. Defaults to no timeout, + /// meaning the request waits for complete search results. + /// /// public Elastic.Clients.Elasticsearch.Duration? WaitForCompletionTimeout { get => Q("wait_for_completion_timeout"); set => Q("wait_for_completion_timeout", value); } } /// -/// Returns the current status and available results for an async SQL search or stored synchronous SQL search +/// +/// Returns the current status and available results for an async SQL search or stored synchronous SQL search +/// /// public sealed partial class GetAsyncRequest : PlainRequest { @@ -70,32 +83,45 @@ public GetAsyncRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Requir internal override string OperationName => "sql.get_async"; /// - /// Separator for CSV results. The API only supports this parameter for CSV responses. + /// + /// Separator for CSV results. The API only supports this parameter for CSV responses. + /// /// [JsonIgnore] public string? Delimiter { get => Q("delimiter"); set => Q("delimiter", value); } /// - /// Format for the response. You must specify a format using this parameter or the
Accept HTTP header. If you specify both, the API uses this parameter. + /// + /// Format for the response. You must specify a format using this parameter or the + /// Accept HTTP header. If you specify both, the API uses this parameter. + /// /// [JsonIgnore] public string? Format { get => Q("format"); set => Q("format", value); } /// - /// Retention period for the search and its results. Defaults
to the `keep_alive` period for the original SQL search. + /// + /// Retention period for the search and its results. Defaults + /// to the keep_alive period for the original SQL search. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); } /// - /// Period to wait for complete results. Defaults to no timeout,
meaning the request waits for complete search results. + /// + /// Period to wait for complete results. Defaults to no timeout, + /// meaning the request waits for complete search results. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? WaitForCompletionTimeout { get => Q("wait_for_completion_timeout"); set => Q("wait_for_completion_timeout", value); } } /// -/// Returns the current status and available results for an async SQL search or stored synchronous SQL search +/// +/// Returns the current status and available results for an async SQL search or stored synchronous SQL search +/// /// public sealed partial class GetAsyncRequestDescriptor : RequestDescriptor, GetAsyncRequestParameters> { @@ -130,7 +156,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns the current status and available results for an async SQL search or stored synchronous SQL search +/// +/// Returns the current status and available results for an async SQL search or stored synchronous SQL search +/// /// public sealed partial class GetAsyncRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/GetAsyncResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/GetAsyncResponse.g.cs index af11f8ec195..9762bd7bd96 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/GetAsyncResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/GetAsyncResponse.g.cs @@ -29,31 +29,51 @@ namespace Elastic.Clients.Elasticsearch.Sql; public sealed partial class GetAsyncResponse : ElasticsearchResponse { /// - /// Column headings for the search results. Each object is a column. + /// + /// Column headings for the search results. Each object is a column. + /// /// [JsonInclude, JsonPropertyName("columns")] public IReadOnlyCollection? Columns { get; init; } /// - /// Cursor for the next set of paginated results. For CSV, TSV, and
TXT responses, this value is returned in the `Cursor` HTTP header. + /// + /// Cursor for the next set of paginated results. For CSV, TSV, and + /// TXT responses, this value is returned in the Cursor HTTP header. + /// /// [JsonInclude, JsonPropertyName("cursor")] public string? Cursor { get; init; } /// - /// Identifier for the search. This value is only returned for async and saved
synchronous searches. For CSV, TSV, and TXT responses, this value is returned
in the `Async-ID` HTTP header. + /// + /// Identifier for the search. This value is only returned for async and saved + /// synchronous searches. For CSV, TSV, and TXT responses, this value is returned + /// in the Async-ID HTTP header. + /// /// [JsonInclude, JsonPropertyName("id")] public string Id { get; init; } /// - /// If `true`, the response does not contain complete search results. If `is_partial`
is `true` and `is_running` is `true`, the search is still running. If `is_partial`
is `true` but `is_running` is `false`, the results are partial due to a failure or
timeout. This value is only returned for async and saved synchronous searches.
For CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header. + /// + /// If true, the response does not contain complete search results. If is_partial + /// is true and is_running is true, the search is still running. If is_partial + /// is true but is_running is false, the results are partial due to a failure or + /// timeout. This value is only returned for async and saved synchronous searches. + /// For CSV, TSV, and TXT responses, this value is returned in the Async-partial HTTP header. + /// /// [JsonInclude, JsonPropertyName("is_partial")] public bool IsPartial { get; init; } /// - /// If `true`, the search is still running. If false, the search has finished.
This value is only returned for async and saved synchronous searches. For
CSV, TSV, and TXT responses, this value is returned in the `Async-partial`
HTTP header. + /// + /// If true, the search is still running. If false, the search has finished. + /// This value is only returned for async and saved synchronous searches. For + /// CSV, TSV, and TXT responses, this value is returned in the Async-partial + /// HTTP header. + /// /// [JsonInclude, JsonPropertyName("is_running")] public bool IsRunning { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/GetAsyncStatusRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/GetAsyncStatusRequest.g.cs index 68c73225eb6..5bf3a3783f6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/GetAsyncStatusRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/GetAsyncStatusRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class GetAsyncStatusRequestParameters : RequestParameters } /// -/// Returns the current status of an async SQL search or a stored synchronous SQL search +/// +/// Returns the current status of an async SQL search or a stored synchronous SQL search +/// /// public sealed partial class GetAsyncStatusRequest : PlainRequest { @@ -52,7 +54,9 @@ public GetAsyncStatusRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r. } /// -/// Returns the current status of an async SQL search or a stored synchronous SQL search +/// +/// Returns the current status of an async SQL search or a stored synchronous SQL search +/// /// public sealed partial class GetAsyncStatusRequestDescriptor : RequestDescriptor, GetAsyncStatusRequestParameters> { @@ -82,7 +86,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns the current status of an async SQL search or a stored synchronous SQL search +/// +/// Returns the current status of an async SQL search or a stored synchronous SQL search +/// /// public sealed partial class GetAsyncStatusRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/GetAsyncStatusResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/GetAsyncStatusResponse.g.cs index e303a6a947c..8dd9a09e22b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/GetAsyncStatusResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/GetAsyncStatusResponse.g.cs @@ -29,37 +29,54 @@ namespace Elastic.Clients.Elasticsearch.Sql; public sealed partial class GetAsyncStatusResponse : ElasticsearchResponse { /// - /// HTTP status code for the search. The API only returns this property for completed searches. + /// + /// HTTP status code for the search. The API only returns this property for completed searches. + /// /// [JsonInclude, JsonPropertyName("completion_status")] public int? CompletionStatus { get; init; } /// - /// Timestamp, in milliseconds since the Unix epoch, when Elasticsearch will delete
the search and its results, even if the search is still running. + /// + /// Timestamp, in milliseconds since the Unix epoch, when Elasticsearch will delete + /// the search and its results, even if the search is still running. + /// /// [JsonInclude, JsonPropertyName("expiration_time_in_millis")] public long ExpirationTimeInMillis { get; init; } /// - /// Identifier for the search. + /// + /// Identifier for the search. + /// /// [JsonInclude, JsonPropertyName("id")] public string Id { get; init; } /// - /// If `true`, the response does not contain complete search results. If `is_partial`
is `true` and `is_running` is `true`, the search is still running. If `is_partial`
is `true` but `is_running` is `false`, the results are partial due to a failure or
timeout. + /// + /// If true, the response does not contain complete search results. If is_partial + /// is true and is_running is true, the search is still running. If is_partial + /// is true but is_running is false, the results are partial due to a failure or + /// timeout. + /// /// [JsonInclude, JsonPropertyName("is_partial")] public bool IsPartial { get; init; } /// - /// If `true`, the search is still running. If `false`, the search has finished. + /// + /// If true, the search is still running. If false, the search has finished. + /// /// [JsonInclude, JsonPropertyName("is_running")] public bool IsRunning { get; init; } /// - /// Timestamp, in milliseconds since the Unix epoch, when the search started.
The API only returns this property for running searches. + /// + /// Timestamp, in milliseconds since the Unix epoch, when the search started. + /// The API only returns this property for running searches. + /// /// [JsonInclude, JsonPropertyName("start_time_in_millis")] public long StartTimeInMillis { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/QueryRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/QueryRequest.g.cs index fc57aa8fe74..3b9898c96f6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/QueryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/QueryRequest.g.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch.Sql; public sealed partial class QueryRequestParameters : RequestParameters { /// - /// Format for the response. + /// + /// Format for the response. + /// /// public string? Format { get => Q("format"); set => Q("format", value); } } /// -/// Executes a SQL request +/// +/// Executes a SQL request +/// /// public sealed partial class QueryRequest : PlainRequest { @@ -51,110 +55,149 @@ public sealed partial class QueryRequest : PlainRequest internal override string OperationName => "sql.query"; /// - /// Format for the response. + /// + /// Format for the response. + /// /// [JsonIgnore] public string? Format { get => Q("format"); set => Q("format", value); } /// - /// Default catalog (cluster) for queries. If unspecified, the queries execute on the data in the local cluster only. + /// + /// Default catalog (cluster) for queries. If unspecified, the queries execute on the data in the local cluster only. + /// /// [JsonInclude, JsonPropertyName("catalog")] public string? Catalog { get; set; } /// - /// If true, the results in a columnar fashion: one row represents all the values of a certain column from the current page of results. + /// + /// If true, the results in a columnar fashion: one row represents all the values of a certain column from the current page of results. + /// /// [JsonInclude, JsonPropertyName("columnar")] public bool? Columnar { get; set; } /// - /// Cursor used to retrieve a set of paginated results.
If you specify a cursor, the API only uses the `columnar` and `time_zone` request body parameters.
It ignores other request body parameters. + /// + /// Cursor used to retrieve a set of paginated results. + /// If you specify a cursor, the API only uses the columnar and time_zone request body parameters. + /// It ignores other request body parameters. + /// /// [JsonInclude, JsonPropertyName("cursor")] public string? Cursor { get; set; } /// - /// The maximum number of rows (or entries) to return in one response + /// + /// The maximum number of rows (or entries) to return in one response + /// /// [JsonInclude, JsonPropertyName("fetch_size")] public int? FetchSize { get; set; } /// - /// Throw an exception when encountering multiple values for a field (default) or be lenient and return the first value from the list (without any guarantees of what that will be - typically the first in natural ascending order). + /// + /// Throw an exception when encountering multiple values for a field (default) or be lenient and return the first value from the list (without any guarantees of what that will be - typically the first in natural ascending order). + /// /// [JsonInclude, JsonPropertyName("field_multi_value_leniency")] public bool? FieldMultiValueLeniency { get; set; } /// - /// Elasticsearch query DSL for additional filtering. + /// + /// Elasticsearch query DSL for additional filtering. + /// /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Filter { get; set; } /// - /// If true, the search can run on frozen indices. Defaults to false. + /// + /// If true, the search can run on frozen indices. Defaults to false. + /// /// [JsonInclude, JsonPropertyName("index_using_frozen")] public bool? IndexUsingFrozen { get; set; } /// - /// Retention period for an async or saved synchronous search. + /// + /// Retention period for an async or saved synchronous search. + /// /// [JsonInclude, JsonPropertyName("keep_alive")] public Elastic.Clients.Elasticsearch.Duration? KeepAlive { get; set; } /// - /// If true, Elasticsearch stores synchronous searches if you also specify the wait_for_completion_timeout parameter. If false, Elasticsearch only stores async searches that don’t finish before the wait_for_completion_timeout. + /// + /// If true, Elasticsearch stores synchronous searches if you also specify the wait_for_completion_timeout parameter. If false, Elasticsearch only stores async searches that don’t finish before the wait_for_completion_timeout. + /// /// [JsonInclude, JsonPropertyName("keep_on_completion")] public bool? KeepOnCompletion { get; set; } /// - /// The timeout before a pagination request fails. + /// + /// The timeout before a pagination request fails. + /// /// [JsonInclude, JsonPropertyName("page_timeout")] public Elastic.Clients.Elasticsearch.Duration? PageTimeout { get; set; } /// - /// Values for parameters in the query. + /// + /// Values for parameters in the query. + /// /// [JsonInclude, JsonPropertyName("params")] public IDictionary? Params { get; set; } /// - /// SQL query to run. + /// + /// SQL query to run. + /// /// [JsonInclude, JsonPropertyName("query")] public string? Query { get; set; } /// - /// The timeout before the request fails. + /// + /// The timeout before the request fails. + /// /// [JsonInclude, JsonPropertyName("request_timeout")] public Elastic.Clients.Elasticsearch.Duration? RequestTimeout { get; set; } /// - /// Defines one or more runtime fields in the search request. These fields take
precedence over mapped fields with the same name. + /// + /// Defines one or more runtime fields in the search request. These fields take + /// precedence over mapped fields with the same name. + /// /// [JsonInclude, JsonPropertyName("runtime_mappings")] public IDictionary? RuntimeMappings { get; set; } /// - /// ISO-8601 time zone ID for the search. + /// + /// ISO-8601 time zone ID for the search. + /// /// [JsonInclude, JsonPropertyName("time_zone")] public string? TimeZone { get; set; } /// - /// Period to wait for complete results. Defaults to no timeout, meaning the request waits for complete search results. If the search doesn’t finish within this period, the search becomes async. + /// + /// Period to wait for complete results. Defaults to no timeout, meaning the request waits for complete search results. If the search doesn’t finish within this period, the search becomes async. + /// /// [JsonInclude, JsonPropertyName("wait_for_completion_timeout")] public Elastic.Clients.Elasticsearch.Duration? WaitForCompletionTimeout { get; set; } } /// -/// Executes a SQL request +/// +/// Executes a SQL request +/// /// public sealed partial class QueryRequestDescriptor : RequestDescriptor, QueryRequestParameters> { @@ -194,7 +237,9 @@ public QueryRequestDescriptor() private Elastic.Clients.Elasticsearch.Duration? WaitForCompletionTimeoutValue { get; set; } /// - /// Default catalog (cluster) for queries. If unspecified, the queries execute on the data in the local cluster only. + /// + /// Default catalog (cluster) for queries. If unspecified, the queries execute on the data in the local cluster only. + /// /// public QueryRequestDescriptor Catalog(string? catalog) { @@ -203,7 +248,9 @@ public QueryRequestDescriptor Catalog(string? catalog) } /// - /// If true, the results in a columnar fashion: one row represents all the values of a certain column from the current page of results. + /// + /// If true, the results in a columnar fashion: one row represents all the values of a certain column from the current page of results. + /// /// public QueryRequestDescriptor Columnar(bool? columnar = true) { @@ -212,7 +259,11 @@ public QueryRequestDescriptor Columnar(bool? columnar = true) } /// - /// Cursor used to retrieve a set of paginated results.
If you specify a cursor, the API only uses the `columnar` and `time_zone` request body parameters.
It ignores other request body parameters. + /// + /// Cursor used to retrieve a set of paginated results. + /// If you specify a cursor, the API only uses the columnar and time_zone request body parameters. + /// It ignores other request body parameters. + /// /// public QueryRequestDescriptor Cursor(string? cursor) { @@ -221,7 +272,9 @@ public QueryRequestDescriptor Cursor(string? cursor) } /// - /// The maximum number of rows (or entries) to return in one response + /// + /// The maximum number of rows (or entries) to return in one response + /// /// public QueryRequestDescriptor FetchSize(int? fetchSize) { @@ -230,7 +283,9 @@ public QueryRequestDescriptor FetchSize(int? fetchSize) } /// - /// Throw an exception when encountering multiple values for a field (default) or be lenient and return the first value from the list (without any guarantees of what that will be - typically the first in natural ascending order). + /// + /// Throw an exception when encountering multiple values for a field (default) or be lenient and return the first value from the list (without any guarantees of what that will be - typically the first in natural ascending order). + /// /// public QueryRequestDescriptor FieldMultiValueLeniency(bool? fieldMultiValueLeniency = true) { @@ -239,7 +294,9 @@ public QueryRequestDescriptor FieldMultiValueLeniency(bool? fieldMult } /// - /// Elasticsearch query DSL for additional filtering. + /// + /// Elasticsearch query DSL for additional filtering. + /// /// public QueryRequestDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.Query? filter) { @@ -266,7 +323,9 @@ public QueryRequestDescriptor Filter(Action - /// If true, the search can run on frozen indices. Defaults to false. + /// + /// If true, the search can run on frozen indices. Defaults to false. + /// /// public QueryRequestDescriptor IndexUsingFrozen(bool? indexUsingFrozen = true) { @@ -275,7 +334,9 @@ public QueryRequestDescriptor IndexUsingFrozen(bool? indexUsingFrozen } /// - /// Retention period for an async or saved synchronous search. + /// + /// Retention period for an async or saved synchronous search. + /// /// public QueryRequestDescriptor KeepAlive(Elastic.Clients.Elasticsearch.Duration? keepAlive) { @@ -284,7 +345,9 @@ public QueryRequestDescriptor KeepAlive(Elastic.Clients.Elasticsearch } /// - /// If true, Elasticsearch stores synchronous searches if you also specify the wait_for_completion_timeout parameter. If false, Elasticsearch only stores async searches that don’t finish before the wait_for_completion_timeout. + /// + /// If true, Elasticsearch stores synchronous searches if you also specify the wait_for_completion_timeout parameter. If false, Elasticsearch only stores async searches that don’t finish before the wait_for_completion_timeout. + /// /// public QueryRequestDescriptor KeepOnCompletion(bool? keepOnCompletion = true) { @@ -293,7 +356,9 @@ public QueryRequestDescriptor KeepOnCompletion(bool? keepOnCompletion } /// - /// The timeout before a pagination request fails. + /// + /// The timeout before a pagination request fails. + /// /// public QueryRequestDescriptor PageTimeout(Elastic.Clients.Elasticsearch.Duration? pageTimeout) { @@ -302,7 +367,9 @@ public QueryRequestDescriptor PageTimeout(Elastic.Clients.Elasticsear } /// - /// Values for parameters in the query. + /// + /// Values for parameters in the query. + /// /// public QueryRequestDescriptor Params(Func, FluentDictionary> selector) { @@ -311,7 +378,9 @@ public QueryRequestDescriptor Params(Func - /// SQL query to run. + /// + /// SQL query to run. + /// /// public QueryRequestDescriptor Query(string? query) { @@ -320,7 +389,9 @@ public QueryRequestDescriptor Query(string? query) } /// - /// The timeout before the request fails. + /// + /// The timeout before the request fails. + /// /// public QueryRequestDescriptor RequestTimeout(Elastic.Clients.Elasticsearch.Duration? requestTimeout) { @@ -329,7 +400,10 @@ public QueryRequestDescriptor RequestTimeout(Elastic.Clients.Elastics } /// - /// Defines one or more runtime fields in the search request. These fields take
precedence over mapped fields with the same name. + /// + /// Defines one or more runtime fields in the search request. These fields take + /// precedence over mapped fields with the same name. + /// /// public QueryRequestDescriptor RuntimeMappings(Func>, FluentDescriptorDictionary>> selector) { @@ -338,7 +412,9 @@ public QueryRequestDescriptor RuntimeMappings(Func - /// ISO-8601 time zone ID for the search. + /// + /// ISO-8601 time zone ID for the search. + /// /// public QueryRequestDescriptor TimeZone(string? timeZone) { @@ -347,7 +423,9 @@ public QueryRequestDescriptor TimeZone(string? timeZone) } /// - /// Period to wait for complete results. Defaults to no timeout, meaning the request waits for complete search results. If the search doesn’t finish within this period, the search becomes async. + /// + /// Period to wait for complete results. Defaults to no timeout, meaning the request waits for complete search results. If the search doesn’t finish within this period, the search becomes async. + /// /// public QueryRequestDescriptor WaitForCompletionTimeout(Elastic.Clients.Elasticsearch.Duration? waitForCompletionTimeout) { @@ -469,7 +547,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Executes a SQL request +/// +/// Executes a SQL request +/// /// public sealed partial class QueryRequestDescriptor : RequestDescriptor { @@ -509,7 +589,9 @@ public QueryRequestDescriptor() private Elastic.Clients.Elasticsearch.Duration? WaitForCompletionTimeoutValue { get; set; } /// - /// Default catalog (cluster) for queries. If unspecified, the queries execute on the data in the local cluster only. + /// + /// Default catalog (cluster) for queries. If unspecified, the queries execute on the data in the local cluster only. + /// /// public QueryRequestDescriptor Catalog(string? catalog) { @@ -518,7 +600,9 @@ public QueryRequestDescriptor Catalog(string? catalog) } /// - /// If true, the results in a columnar fashion: one row represents all the values of a certain column from the current page of results. + /// + /// If true, the results in a columnar fashion: one row represents all the values of a certain column from the current page of results. + /// /// public QueryRequestDescriptor Columnar(bool? columnar = true) { @@ -527,7 +611,11 @@ public QueryRequestDescriptor Columnar(bool? columnar = true) } /// - /// Cursor used to retrieve a set of paginated results.
If you specify a cursor, the API only uses the `columnar` and `time_zone` request body parameters.
It ignores other request body parameters. + /// + /// Cursor used to retrieve a set of paginated results. + /// If you specify a cursor, the API only uses the columnar and time_zone request body parameters. + /// It ignores other request body parameters. + /// /// public QueryRequestDescriptor Cursor(string? cursor) { @@ -536,7 +624,9 @@ public QueryRequestDescriptor Cursor(string? cursor) } /// - /// The maximum number of rows (or entries) to return in one response + /// + /// The maximum number of rows (or entries) to return in one response + /// /// public QueryRequestDescriptor FetchSize(int? fetchSize) { @@ -545,7 +635,9 @@ public QueryRequestDescriptor FetchSize(int? fetchSize) } /// - /// Throw an exception when encountering multiple values for a field (default) or be lenient and return the first value from the list (without any guarantees of what that will be - typically the first in natural ascending order). + /// + /// Throw an exception when encountering multiple values for a field (default) or be lenient and return the first value from the list (without any guarantees of what that will be - typically the first in natural ascending order). + /// /// public QueryRequestDescriptor FieldMultiValueLeniency(bool? fieldMultiValueLeniency = true) { @@ -554,7 +646,9 @@ public QueryRequestDescriptor FieldMultiValueLeniency(bool? fieldMultiValueLenie } /// - /// Elasticsearch query DSL for additional filtering. + /// + /// Elasticsearch query DSL for additional filtering. + /// /// public QueryRequestDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.Query? filter) { @@ -581,7 +675,9 @@ public QueryRequestDescriptor Filter(Action - /// If true, the search can run on frozen indices. Defaults to false. + /// + /// If true, the search can run on frozen indices. Defaults to false. + /// /// public QueryRequestDescriptor IndexUsingFrozen(bool? indexUsingFrozen = true) { @@ -590,7 +686,9 @@ public QueryRequestDescriptor IndexUsingFrozen(bool? indexUsingFrozen = true) } /// - /// Retention period for an async or saved synchronous search. + /// + /// Retention period for an async or saved synchronous search. + /// /// public QueryRequestDescriptor KeepAlive(Elastic.Clients.Elasticsearch.Duration? keepAlive) { @@ -599,7 +697,9 @@ public QueryRequestDescriptor KeepAlive(Elastic.Clients.Elasticsearch.Duration? } /// - /// If true, Elasticsearch stores synchronous searches if you also specify the wait_for_completion_timeout parameter. If false, Elasticsearch only stores async searches that don’t finish before the wait_for_completion_timeout. + /// + /// If true, Elasticsearch stores synchronous searches if you also specify the wait_for_completion_timeout parameter. If false, Elasticsearch only stores async searches that don’t finish before the wait_for_completion_timeout. + /// /// public QueryRequestDescriptor KeepOnCompletion(bool? keepOnCompletion = true) { @@ -608,7 +708,9 @@ public QueryRequestDescriptor KeepOnCompletion(bool? keepOnCompletion = true) } /// - /// The timeout before a pagination request fails. + /// + /// The timeout before a pagination request fails. + /// /// public QueryRequestDescriptor PageTimeout(Elastic.Clients.Elasticsearch.Duration? pageTimeout) { @@ -617,7 +719,9 @@ public QueryRequestDescriptor PageTimeout(Elastic.Clients.Elasticsearch.Duration } /// - /// Values for parameters in the query. + /// + /// Values for parameters in the query. + /// /// public QueryRequestDescriptor Params(Func, FluentDictionary> selector) { @@ -626,7 +730,9 @@ public QueryRequestDescriptor Params(Func, Flue } /// - /// SQL query to run. + /// + /// SQL query to run. + /// /// public QueryRequestDescriptor Query(string? query) { @@ -635,7 +741,9 @@ public QueryRequestDescriptor Query(string? query) } /// - /// The timeout before the request fails. + /// + /// The timeout before the request fails. + /// /// public QueryRequestDescriptor RequestTimeout(Elastic.Clients.Elasticsearch.Duration? requestTimeout) { @@ -644,7 +752,10 @@ public QueryRequestDescriptor RequestTimeout(Elastic.Clients.Elasticsearch.Durat } /// - /// Defines one or more runtime fields in the search request. These fields take
precedence over mapped fields with the same name. + /// + /// Defines one or more runtime fields in the search request. These fields take + /// precedence over mapped fields with the same name. + /// /// public QueryRequestDescriptor RuntimeMappings(Func, FluentDescriptorDictionary> selector) { @@ -653,7 +764,9 @@ public QueryRequestDescriptor RuntimeMappings(Func - /// ISO-8601 time zone ID for the search. + /// + /// ISO-8601 time zone ID for the search. + /// /// public QueryRequestDescriptor TimeZone(string? timeZone) { @@ -662,7 +775,9 @@ public QueryRequestDescriptor TimeZone(string? timeZone) } /// - /// Period to wait for complete results. Defaults to no timeout, meaning the request waits for complete search results. If the search doesn’t finish within this period, the search becomes async. + /// + /// Period to wait for complete results. Defaults to no timeout, meaning the request waits for complete search results. If the search doesn’t finish within this period, the search becomes async. + /// /// public QueryRequestDescriptor WaitForCompletionTimeout(Elastic.Clients.Elasticsearch.Duration? waitForCompletionTimeout) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/QueryResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/QueryResponse.g.cs index 8641dce22c2..68a8c3c72ca 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/QueryResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/QueryResponse.g.cs @@ -29,31 +29,51 @@ namespace Elastic.Clients.Elasticsearch.Sql; public sealed partial class QueryResponse : ElasticsearchResponse { /// - /// Column headings for the search results. Each object is a column. + /// + /// Column headings for the search results. Each object is a column. + /// /// [JsonInclude, JsonPropertyName("columns")] public IReadOnlyCollection? Columns { get; init; } /// - /// Cursor for the next set of paginated results. For CSV, TSV, and
TXT responses, this value is returned in the `Cursor` HTTP header. + /// + /// Cursor for the next set of paginated results. For CSV, TSV, and + /// TXT responses, this value is returned in the Cursor HTTP header. + /// /// [JsonInclude, JsonPropertyName("cursor")] public string? Cursor { get; init; } /// - /// Identifier for the search. This value is only returned for async and saved
synchronous searches. For CSV, TSV, and TXT responses, this value is returned
in the `Async-ID` HTTP header. + /// + /// Identifier for the search. This value is only returned for async and saved + /// synchronous searches. For CSV, TSV, and TXT responses, this value is returned + /// in the Async-ID HTTP header. + /// /// [JsonInclude, JsonPropertyName("id")] public string? Id { get; init; } /// - /// If `true`, the response does not contain complete search results. If `is_partial`
is `true` and `is_running` is `true`, the search is still running. If `is_partial`
is `true` but `is_running` is `false`, the results are partial due to a failure or
timeout. This value is only returned for async and saved synchronous searches.
For CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header. + /// + /// If true, the response does not contain complete search results. If is_partial + /// is true and is_running is true, the search is still running. If is_partial + /// is true but is_running is false, the results are partial due to a failure or + /// timeout. This value is only returned for async and saved synchronous searches. + /// For CSV, TSV, and TXT responses, this value is returned in the Async-partial HTTP header. + /// /// [JsonInclude, JsonPropertyName("is_partial")] public bool? IsPartial { get; init; } /// - /// If `true`, the search is still running. If false, the search has finished.
This value is only returned for async and saved synchronous searches. For
CSV, TSV, and TXT responses, this value is returned in the `Async-partial`
HTTP header. + /// + /// If true, the search is still running. If false, the search has finished. + /// This value is only returned for async and saved synchronous searches. For + /// CSV, TSV, and TXT responses, this value is returned in the Async-partial + /// HTTP header. + /// /// [JsonInclude, JsonPropertyName("is_running")] public bool? IsRunning { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/TranslateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/TranslateRequest.g.cs index faea2e2b47e..0e985a24dce 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/TranslateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/TranslateRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class TranslateRequestParameters : RequestParameters } /// -/// Translates SQL into Elasticsearch queries +/// +/// Translates SQL into Elasticsearch queries +/// /// public sealed partial class TranslateRequest : PlainRequest { @@ -47,32 +49,42 @@ public sealed partial class TranslateRequest : PlainRequest "sql.translate"; /// - /// The maximum number of rows (or entries) to return in one response. + /// + /// The maximum number of rows (or entries) to return in one response. + /// /// [JsonInclude, JsonPropertyName("fetch_size")] public int? FetchSize { get; set; } /// - /// Elasticsearch query DSL for additional filtering. + /// + /// Elasticsearch query DSL for additional filtering. + /// /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Filter { get; set; } /// - /// SQL query to run. + /// + /// SQL query to run. + /// /// [JsonInclude, JsonPropertyName("query")] public string Query { get; set; } /// - /// ISO-8601 time zone ID for the search. + /// + /// ISO-8601 time zone ID for the search. + /// /// [JsonInclude, JsonPropertyName("time_zone")] public string? TimeZone { get; set; } } /// -/// Translates SQL into Elasticsearch queries +/// +/// Translates SQL into Elasticsearch queries +/// /// public sealed partial class TranslateRequestDescriptor : RequestDescriptor, TranslateRequestParameters> { @@ -98,7 +110,9 @@ public TranslateRequestDescriptor() private string? TimeZoneValue { get; set; } /// - /// The maximum number of rows (or entries) to return in one response. + /// + /// The maximum number of rows (or entries) to return in one response. + /// /// public TranslateRequestDescriptor FetchSize(int? fetchSize) { @@ -107,7 +121,9 @@ public TranslateRequestDescriptor FetchSize(int? fetchSize) } /// - /// Elasticsearch query DSL for additional filtering. + /// + /// Elasticsearch query DSL for additional filtering. + /// /// public TranslateRequestDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.Query? filter) { @@ -134,7 +150,9 @@ public TranslateRequestDescriptor Filter(Action - /// SQL query to run. + /// + /// SQL query to run. + /// /// public TranslateRequestDescriptor Query(string query) { @@ -143,7 +161,9 @@ public TranslateRequestDescriptor Query(string query) } /// - /// ISO-8601 time zone ID for the search. + /// + /// ISO-8601 time zone ID for the search. + /// /// public TranslateRequestDescriptor TimeZone(string? timeZone) { @@ -189,7 +209,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Translates SQL into Elasticsearch queries +/// +/// Translates SQL into Elasticsearch queries +/// /// public sealed partial class TranslateRequestDescriptor : RequestDescriptor { @@ -215,7 +237,9 @@ public TranslateRequestDescriptor() private string? TimeZoneValue { get; set; } /// - /// The maximum number of rows (or entries) to return in one response. + /// + /// The maximum number of rows (or entries) to return in one response. + /// /// public TranslateRequestDescriptor FetchSize(int? fetchSize) { @@ -224,7 +248,9 @@ public TranslateRequestDescriptor FetchSize(int? fetchSize) } /// - /// Elasticsearch query DSL for additional filtering. + /// + /// Elasticsearch query DSL for additional filtering. + /// /// public TranslateRequestDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.Query? filter) { @@ -251,7 +277,9 @@ public TranslateRequestDescriptor Filter(Action - /// SQL query to run. + /// + /// SQL query to run. + /// /// public TranslateRequestDescriptor Query(string query) { @@ -260,7 +288,9 @@ public TranslateRequestDescriptor Query(string query) } /// - /// ISO-8601 time zone ID for the search. + /// + /// ISO-8601 time zone ID for the search. + /// /// public TranslateRequestDescriptor TimeZone(string? timeZone) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/DeleteSynonymRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/DeleteSynonymRequest.g.cs index d59be417034..ecda4dafb10 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/DeleteSynonymRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/DeleteSynonymRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class DeleteSynonymRequestParameters : RequestParameters } /// -/// Deletes a synonym set +/// +/// Deletes a synonym set +/// /// public sealed partial class DeleteSynonymRequest : PlainRequest { @@ -52,7 +54,9 @@ public DeleteSynonymRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.R } /// -/// Deletes a synonym set +/// +/// Deletes a synonym set +/// /// public sealed partial class DeleteSynonymRequestDescriptor : RequestDescriptor, DeleteSynonymRequestParameters> { @@ -82,7 +86,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Deletes a synonym set +/// +/// Deletes a synonym set +/// /// public sealed partial class DeleteSynonymRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/DeleteSynonymResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/DeleteSynonymResponse.g.cs index 63dbf38a25e..484ef271a05 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/DeleteSynonymResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/DeleteSynonymResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Synonyms; public sealed partial class DeleteSynonymResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/DeleteSynonymRuleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/DeleteSynonymRuleRequest.g.cs index dbd0ab64a88..2e2e39a8d8c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/DeleteSynonymRuleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/DeleteSynonymRuleRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class DeleteSynonymRuleRequestParameters : RequestParamete } /// -/// Deletes a synonym rule in a synonym set +/// +/// Deletes a synonym rule in a synonym set +/// /// public sealed partial class DeleteSynonymRuleRequest : PlainRequest { @@ -52,7 +54,9 @@ public DeleteSynonymRuleRequest(Elastic.Clients.Elasticsearch.Id setId, Elastic. } /// -/// Deletes a synonym rule in a synonym set +/// +/// Deletes a synonym rule in a synonym set +/// /// public sealed partial class DeleteSynonymRuleRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/DeleteSynonymRuleResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/DeleteSynonymRuleResponse.g.cs index a180ef0b680..7a128cafa53 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/DeleteSynonymRuleResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/DeleteSynonymRuleResponse.g.cs @@ -29,13 +29,18 @@ namespace Elastic.Clients.Elasticsearch.Synonyms; public sealed partial class DeleteSynonymRuleResponse : ElasticsearchResponse { /// - /// Updating synonyms in a synonym set reloads the associated analyzers.
This is the analyzers reloading result + /// + /// Updating synonyms in a synonym set reloads the associated analyzers. + /// This is the analyzers reloading result + /// /// [JsonInclude, JsonPropertyName("reload_analyzers_details")] public Elastic.Clients.Elasticsearch.IndexManagement.ReloadResult ReloadAnalyzersDetails { get; init; } /// - /// Update operation result + /// + /// Update operation result + /// /// [JsonInclude, JsonPropertyName("result")] public Elastic.Clients.Elasticsearch.Result Result { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/GetSynonymRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/GetSynonymRequest.g.cs index 1ad8761eb80..8a9f327fa20 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/GetSynonymRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/GetSynonymRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.Synonyms; public sealed partial class GetSynonymRequestParameters : RequestParameters { /// - /// Starting offset for query rules to be retrieved + /// + /// Starting offset for query rules to be retrieved + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// specifies a max number of query rules to retrieve + /// + /// specifies a max number of query rules to retrieve + /// /// public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Retrieves a synonym set +/// +/// Retrieves a synonym set +/// /// public sealed partial class GetSynonymRequest : PlainRequest { @@ -60,20 +66,26 @@ public GetSynonymRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Requ internal override string OperationName => "synonyms.get_synonym"; /// - /// Starting offset for query rules to be retrieved + /// + /// Starting offset for query rules to be retrieved + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// specifies a max number of query rules to retrieve + /// + /// specifies a max number of query rules to retrieve + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Retrieves a synonym set +/// +/// Retrieves a synonym set +/// /// public sealed partial class GetSynonymRequestDescriptor : RequestDescriptor, GetSynonymRequestParameters> { @@ -106,7 +118,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Retrieves a synonym set +/// +/// Retrieves a synonym set +/// /// public sealed partial class GetSynonymRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/GetSynonymRuleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/GetSynonymRuleRequest.g.cs index 8fb770837a0..0743e1542f0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/GetSynonymRuleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/GetSynonymRuleRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class GetSynonymRuleRequestParameters : RequestParameters } /// -/// Retrieves a synonym rule from a synonym set +/// +/// Retrieves a synonym rule from a synonym set +/// /// public sealed partial class GetSynonymRuleRequest : PlainRequest { @@ -52,7 +54,9 @@ public GetSynonymRuleRequest(Elastic.Clients.Elasticsearch.Id setId, Elastic.Cli } /// -/// Retrieves a synonym rule from a synonym set +/// +/// Retrieves a synonym rule from a synonym set +/// /// public sealed partial class GetSynonymRuleRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/GetSynonymRuleResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/GetSynonymRuleResponse.g.cs index 4f6d014c49a..a6fc0854ce0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/GetSynonymRuleResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/GetSynonymRuleResponse.g.cs @@ -29,13 +29,17 @@ namespace Elastic.Clients.Elasticsearch.Synonyms; public sealed partial class GetSynonymRuleResponse : ElasticsearchResponse { /// - /// Synonym Rule identifier + /// + /// Synonym Rule identifier + /// /// [JsonInclude, JsonPropertyName("id")] public string Id { get; init; } /// - /// Synonyms, in Solr format, that conform the synonym rule. See https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#_solr_synonyms_2 + /// + /// Synonyms, in Solr format, that conform the synonym rule. See https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#_solr_synonyms_2 + /// /// [JsonInclude, JsonPropertyName("synonyms")] public string Synonyms { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/GetSynonymsSetsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/GetSynonymsSetsRequest.g.cs index 081be877899..fc9c8b16439 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/GetSynonymsSetsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/GetSynonymsSetsRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.Synonyms; public sealed partial class GetSynonymsSetsRequestParameters : RequestParameters { /// - /// Starting offset + /// + /// Starting offset + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// specifies a max number of results to get + /// + /// specifies a max number of results to get + /// /// public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Retrieves a summary of all defined synonym sets +/// +/// Retrieves a summary of all defined synonym sets +/// /// public sealed partial class GetSynonymsSetsRequest : PlainRequest { @@ -56,20 +62,26 @@ public sealed partial class GetSynonymsSetsRequest : PlainRequest "synonyms.get_synonyms_sets"; /// - /// Starting offset + /// + /// Starting offset + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// specifies a max number of results to get + /// + /// specifies a max number of results to get + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Retrieves a summary of all defined synonym sets +/// +/// Retrieves a summary of all defined synonym sets +/// /// public sealed partial class GetSynonymsSetsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/PutSynonymRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/PutSynonymRequest.g.cs index bc245ea8753..86306a6f239 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/PutSynonymRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/PutSynonymRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class PutSynonymRequestParameters : RequestParameters } /// -/// Creates or updates a synonym set. +/// +/// Creates or updates a synonym set. +/// /// public sealed partial class PutSynonymRequest : PlainRequest { @@ -51,14 +53,18 @@ public PutSynonymRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Requ internal override string OperationName => "synonyms.put_synonym"; /// - /// The synonym set information to update + /// + /// The synonym set information to update + /// /// [JsonInclude, JsonPropertyName("synonyms_set")] public ICollection SynonymsSet { get; set; } } /// -/// Creates or updates a synonym set. +/// +/// Creates or updates a synonym set. +/// /// public sealed partial class PutSynonymRequestDescriptor : RequestDescriptor, PutSynonymRequestParameters> { @@ -88,7 +94,9 @@ public PutSynonymRequestDescriptor Id(Elastic.Clients.Elasticsearch.I private Action[] SynonymsSetDescriptorActions { get; set; } /// - /// The synonym set information to update + /// + /// The synonym set information to update + /// /// public PutSynonymRequestDescriptor SynonymsSet(ICollection synonymsSet) { @@ -165,7 +173,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Creates or updates a synonym set. +/// +/// Creates or updates a synonym set. +/// /// public sealed partial class PutSynonymRequestDescriptor : RequestDescriptor { @@ -195,7 +205,9 @@ public PutSynonymRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id id) private Action[] SynonymsSetDescriptorActions { get; set; } /// - /// The synonym set information to update + /// + /// The synonym set information to update + /// /// public PutSynonymRequestDescriptor SynonymsSet(ICollection synonymsSet) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/PutSynonymRuleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/PutSynonymRuleRequest.g.cs index ef7febbf7f5..b884d81d6bf 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/PutSynonymRuleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/PutSynonymRuleRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class PutSynonymRuleRequestParameters : RequestParameters } /// -/// Creates or updates a synonym rule in a synonym set +/// +/// Creates or updates a synonym rule in a synonym set +/// /// public sealed partial class PutSynonymRuleRequest : PlainRequest { @@ -55,7 +57,9 @@ public PutSynonymRuleRequest(Elastic.Clients.Elasticsearch.Id setId, Elastic.Cli } /// -/// Creates or updates a synonym rule in a synonym set +/// +/// Creates or updates a synonym rule in a synonym set +/// /// public sealed partial class PutSynonymRuleRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/PutSynonymRuleResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/PutSynonymRuleResponse.g.cs index 2c225f8c9b9..652aebc8333 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/PutSynonymRuleResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/PutSynonymRuleResponse.g.cs @@ -29,13 +29,18 @@ namespace Elastic.Clients.Elasticsearch.Synonyms; public sealed partial class PutSynonymRuleResponse : ElasticsearchResponse { /// - /// Updating synonyms in a synonym set reloads the associated analyzers.
This is the analyzers reloading result + /// + /// Updating synonyms in a synonym set reloads the associated analyzers. + /// This is the analyzers reloading result + /// /// [JsonInclude, JsonPropertyName("reload_analyzers_details")] public Elastic.Clients.Elasticsearch.IndexManagement.ReloadResult ReloadAnalyzersDetails { get; init; } /// - /// Update operation result + /// + /// Update operation result + /// /// [JsonInclude, JsonPropertyName("result")] public Elastic.Clients.Elasticsearch.Result Result { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/CancelRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/CancelRequest.g.cs index 6990d3b124b..3ac3af276bb 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/CancelRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/CancelRequest.g.cs @@ -32,28 +32,38 @@ namespace Elastic.Clients.Elasticsearch.Tasks; public sealed partial class CancelRequestParameters : RequestParameters { /// - /// Comma-separated list or wildcard expression of actions used to limit the request. + /// + /// Comma-separated list or wildcard expression of actions used to limit the request. + /// /// public ICollection? Actions { get => Q?>("actions"); set => Q("actions", value); } /// - /// Comma-separated list of node IDs or names used to limit the request. + /// + /// Comma-separated list of node IDs or names used to limit the request. + /// /// public ICollection? Nodes { get => Q?>("nodes"); set => Q("nodes", value); } /// - /// Parent task ID used to limit the tasks. + /// + /// Parent task ID used to limit the tasks. + /// /// public string? ParentTaskId { get => Q("parent_task_id"); set => Q("parent_task_id", value); } /// - /// Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false + /// + /// Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false + /// /// public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Cancels a task, if it can be cancelled through an API. +/// +/// Cancels a task, if it can be cancelled through an API. +/// /// public sealed partial class CancelRequest : PlainRequest { @@ -74,32 +84,42 @@ public CancelRequest(Elastic.Clients.Elasticsearch.TaskId? taskId) : base(r => r internal override string OperationName => "tasks.cancel"; /// - /// Comma-separated list or wildcard expression of actions used to limit the request. + /// + /// Comma-separated list or wildcard expression of actions used to limit the request. + /// /// [JsonIgnore] public ICollection? Actions { get => Q?>("actions"); set => Q("actions", value); } /// - /// Comma-separated list of node IDs or names used to limit the request. + /// + /// Comma-separated list of node IDs or names used to limit the request. + /// /// [JsonIgnore] public ICollection? Nodes { get => Q?>("nodes"); set => Q("nodes", value); } /// - /// Parent task ID used to limit the tasks. + /// + /// Parent task ID used to limit the tasks. + /// /// [JsonIgnore] public string? ParentTaskId { get => Q("parent_task_id"); set => Q("parent_task_id", value); } /// - /// Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false + /// + /// Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false + /// /// [JsonIgnore] public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Cancels a task, if it can be cancelled through an API. +/// +/// Cancels a task, if it can be cancelled through an API. +/// /// public sealed partial class CancelRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/CancelResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/CancelResponse.g.cs index b96926cb3b3..42734dac9ee 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/CancelResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/CancelResponse.g.cs @@ -32,7 +32,9 @@ public sealed partial class CancelResponse : ElasticsearchResponse public IReadOnlyCollection? NodeFailures { get; init; } /// - /// Task information grouped by node, if `group_by` was set to `node` (the default). + /// + /// Task information grouped by node, if group_by was set to node (the default). + /// /// [JsonInclude, JsonPropertyName("nodes")] public IReadOnlyDictionary? Nodes { get; init; } @@ -40,7 +42,10 @@ public sealed partial class CancelResponse : ElasticsearchResponse public IReadOnlyCollection? TaskFailures { get; init; } /// - /// Either a flat list of tasks if `group_by` was set to `none`, or grouped by parents if
`group_by` was set to `parents`. + /// + /// Either a flat list of tasks if group_by was set to none, or grouped by parents if + /// group_by was set to parents. + /// /// [JsonInclude, JsonPropertyName("tasks")] public Elastic.Clients.Elasticsearch.Tasks.TaskInfos? Tasks { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/GetTasksRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/GetTasksRequest.g.cs index 94871bd48a6..11fdb657626 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/GetTasksRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/GetTasksRequest.g.cs @@ -32,18 +32,26 @@ namespace Elastic.Clients.Elasticsearch.Tasks; public sealed partial class GetTasksRequestParameters : RequestParameters { /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// If `true`, the request blocks until the task has completed. + /// + /// If true, the request blocks until the task has completed. + /// /// public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Get task information.
Returns information about the tasks currently executing in the cluster. +/// +/// Get task information. +/// Returns information about the tasks currently executing in the cluster. +/// /// public sealed partial class GetTasksRequest : PlainRequest { @@ -60,20 +68,28 @@ public GetTasksRequest(Elastic.Clients.Elasticsearch.Id taskId) : base(r => r.Re internal override string OperationName => "tasks.get"; /// - /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// If `true`, the request blocks until the task has completed. + /// + /// If true, the request blocks until the task has completed. + /// /// [JsonIgnore] public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Get task information.
Returns information about the tasks currently executing in the cluster. +/// +/// Get task information. +/// Returns information about the tasks currently executing in the cluster. +/// /// public sealed partial class GetTasksRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/ListRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/ListRequest.g.cs index 2a195656e59..1bc8c0ed85b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/ListRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/ListRequest.g.cs @@ -32,48 +32,66 @@ namespace Elastic.Clients.Elasticsearch.Tasks; public sealed partial class ListRequestParameters : RequestParameters { /// - /// Comma-separated list or wildcard expression of actions used to limit the request. + /// + /// Comma-separated list or wildcard expression of actions used to limit the request. + /// /// public ICollection? Actions { get => Q?>("actions"); set => Q("actions", value); } /// - /// If `true`, the response includes detailed information about shard recoveries. + /// + /// If true, the response includes detailed information about shard recoveries. + /// /// public bool? Detailed { get => Q("detailed"); set => Q("detailed", value); } /// - /// Key used to group tasks in the response. + /// + /// Key used to group tasks in the response. + /// /// public Elastic.Clients.Elasticsearch.Tasks.GroupBy? GroupBy { get => Q("group_by"); set => Q("group_by", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Comma-separated list of node IDs or names used to limit returned information. + /// + /// Comma-separated list of node IDs or names used to limit returned information. + /// /// public ICollection? NodeId { get => Q?>("node_id"); set => Q("node_id", value); } /// - /// Parent task ID used to limit returned information. To return all tasks, omit this parameter or use a value of `-1`. + /// + /// Parent task ID used to limit returned information. To return all tasks, omit this parameter or use a value of -1. + /// /// public Elastic.Clients.Elasticsearch.Id? ParentTaskId { get => Q("parent_task_id"); set => Q("parent_task_id", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// If `true`, the request blocks until the operation is complete. + /// + /// If true, the request blocks until the operation is complete. + /// /// public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// The task management API returns information about tasks currently executing on one or more nodes in the cluster. +/// +/// The task management API returns information about tasks currently executing on one or more nodes in the cluster. +/// /// public sealed partial class ListRequest : PlainRequest { @@ -86,56 +104,74 @@ public sealed partial class ListRequest : PlainRequest internal override string OperationName => "tasks.list"; /// - /// Comma-separated list or wildcard expression of actions used to limit the request. + /// + /// Comma-separated list or wildcard expression of actions used to limit the request. + /// /// [JsonIgnore] public ICollection? Actions { get => Q?>("actions"); set => Q("actions", value); } /// - /// If `true`, the response includes detailed information about shard recoveries. + /// + /// If true, the response includes detailed information about shard recoveries. + /// /// [JsonIgnore] public bool? Detailed { get => Q("detailed"); set => Q("detailed", value); } /// - /// Key used to group tasks in the response. + /// + /// Key used to group tasks in the response. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Tasks.GroupBy? GroupBy { get => Q("group_by"); set => Q("group_by", value); } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Comma-separated list of node IDs or names used to limit returned information. + /// + /// Comma-separated list of node IDs or names used to limit returned information. + /// /// [JsonIgnore] public ICollection? NodeId { get => Q?>("node_id"); set => Q("node_id", value); } /// - /// Parent task ID used to limit returned information. To return all tasks, omit this parameter or use a value of `-1`. + /// + /// Parent task ID used to limit returned information. To return all tasks, omit this parameter or use a value of -1. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Id? ParentTaskId { get => Q("parent_task_id"); set => Q("parent_task_id", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// If `true`, the request blocks until the operation is complete. + /// + /// If true, the request blocks until the operation is complete. + /// /// [JsonIgnore] public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// The task management API returns information about tasks currently executing on one or more nodes in the cluster. +/// +/// The task management API returns information about tasks currently executing on one or more nodes in the cluster. +/// /// public sealed partial class ListRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/ListResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/ListResponse.g.cs index 08bb3f2b16a..6eec10fe844 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/ListResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/ListResponse.g.cs @@ -32,7 +32,9 @@ public sealed partial class ListResponse : ElasticsearchResponse public IReadOnlyCollection? NodeFailures { get; init; } /// - /// Task information grouped by node, if `group_by` was set to `node` (the default). + /// + /// Task information grouped by node, if group_by was set to node (the default). + /// /// [JsonInclude, JsonPropertyName("nodes")] public IReadOnlyDictionary? Nodes { get; init; } @@ -40,7 +42,10 @@ public sealed partial class ListResponse : ElasticsearchResponse public IReadOnlyCollection? TaskFailures { get; init; } /// - /// Either a flat list of tasks if `group_by` was set to `none`, or grouped by parents if
`group_by` was set to `parents`. + /// + /// Either a flat list of tasks if group_by was set to none, or grouped by parents if + /// group_by was set to parents. + /// /// [JsonInclude, JsonPropertyName("tasks")] public Elastic.Clients.Elasticsearch.Tasks.TaskInfos? Tasks { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TermVectorsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TermVectorsRequest.g.cs index ec72c2d6ac5..3c27f0b5801 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TermVectorsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TermVectorsRequest.g.cs @@ -32,63 +32,90 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class TermVectorsRequestParameters : RequestParameters { /// - /// Comma-separated list or wildcard expressions of fields to include in the statistics.
Used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. + /// + /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// Used as the default list unless a specific field list is provided in the completion_fields or fielddata_fields parameters. + /// /// public Elastic.Clients.Elasticsearch.Fields? Fields { get => Q("fields"); set => Q("fields", value); } /// - /// If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + /// + /// If true, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + /// /// public bool? FieldStatistics { get => Q("field_statistics"); set => Q("field_statistics", value); } /// - /// If `true`, the response includes term offsets. + /// + /// If true, the response includes term offsets. + /// /// public bool? Offsets { get => Q("offsets"); set => Q("offsets", value); } /// - /// If `true`, the response includes term payloads. + /// + /// If true, the response includes term payloads. + /// /// public bool? Payloads { get => Q("payloads"); set => Q("payloads", value); } /// - /// If `true`, the response includes term positions. + /// + /// If true, the response includes term positions. + /// /// public bool? Positions { get => Q("positions"); set => Q("positions", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If true, the request is real-time as opposed to near-real-time. + /// + /// If true, the request is real-time as opposed to near-real-time. + /// /// public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// If `true`, the response includes term frequency and document frequency. + /// + /// If true, the response includes term frequency and document frequency. + /// /// public bool? TermStatistics { get => Q("term_statistics"); set => Q("term_statistics", value); } /// - /// If `true`, returns the document version as part of a hit. + /// + /// If true, returns the document version as part of a hit. + /// /// public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type. + /// + /// Specific version type. + /// /// public Elastic.Clients.Elasticsearch.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } } /// -/// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. +/// +/// Get term vector information. +/// Returns information and statistics about terms in the fields of a particular document. +/// /// public sealed partial class TermVectorsRequest : PlainRequest { @@ -109,93 +136,126 @@ public TermVectorsRequest(Elastic.Clients.Elasticsearch.IndexName index) : base( internal override string OperationName => "termvectors"; /// - /// Comma-separated list or wildcard expressions of fields to include in the statistics.
Used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. + /// + /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// Used as the default list unless a specific field list is provided in the completion_fields or fielddata_fields parameters. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? Fields { get => Q("fields"); set => Q("fields", value); } /// - /// If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + /// + /// If true, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + /// /// [JsonIgnore] public bool? FieldStatistics { get => Q("field_statistics"); set => Q("field_statistics", value); } /// - /// If `true`, the response includes term offsets. + /// + /// If true, the response includes term offsets. + /// /// [JsonIgnore] public bool? Offsets { get => Q("offsets"); set => Q("offsets", value); } /// - /// If `true`, the response includes term payloads. + /// + /// If true, the response includes term payloads. + /// /// [JsonIgnore] public bool? Payloads { get => Q("payloads"); set => Q("payloads", value); } /// - /// If `true`, the response includes term positions. + /// + /// If true, the response includes term positions. + /// /// [JsonIgnore] public bool? Positions { get => Q("positions"); set => Q("positions", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If true, the request is real-time as opposed to near-real-time. + /// + /// If true, the request is real-time as opposed to near-real-time. + /// /// [JsonIgnore] public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// If `true`, the response includes term frequency and document frequency. + /// + /// If true, the response includes term frequency and document frequency. + /// /// [JsonIgnore] public bool? TermStatistics { get => Q("term_statistics"); set => Q("term_statistics", value); } /// - /// If `true`, returns the document version as part of a hit. + /// + /// If true, returns the document version as part of a hit. + /// /// [JsonIgnore] public long? Version { get => Q("version"); set => Q("version", value); } /// - /// Specific version type. + /// + /// Specific version type. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } /// - /// An artificial document (a document not present in the index) for which you want to retrieve term vectors. + /// + /// An artificial document (a document not present in the index) for which you want to retrieve term vectors. + /// /// [JsonInclude, JsonPropertyName("doc")] [SourceConverter] public TDocument? Doc { get; set; } /// - /// Filter terms based on their tf-idf scores. + /// + /// Filter terms based on their tf-idf scores. + /// /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.Core.TermVectors.Filter? Filter { get; set; } /// - /// Overrides the default per-field analyzer. + /// + /// Overrides the default per-field analyzer. + /// /// [JsonInclude, JsonPropertyName("per_field_analyzer")] public IDictionary? PerFieldAnalyzer { get; set; } } /// -/// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. +/// +/// Get term vector information. +/// Returns information and statistics about terms in the fields of a particular document. +/// /// public sealed partial class TermVectorsRequestDescriptor : RequestDescriptor, TermVectorsRequestParameters> { @@ -264,7 +324,9 @@ public TermVectorsRequestDescriptor Index(Elastic.Clients.Elasticsear private IDictionary? PerFieldAnalyzerValue { get; set; } /// - /// An artificial document (a document not present in the index) for which you want to retrieve term vectors. + /// + /// An artificial document (a document not present in the index) for which you want to retrieve term vectors. + /// /// public TermVectorsRequestDescriptor Doc(TDocument? doc) { @@ -273,7 +335,9 @@ public TermVectorsRequestDescriptor Doc(TDocument? doc) } /// - /// Filter terms based on their tf-idf scores. + /// + /// Filter terms based on their tf-idf scores. + /// /// public TermVectorsRequestDescriptor Filter(Elastic.Clients.Elasticsearch.Core.TermVectors.Filter? filter) { @@ -300,7 +364,9 @@ public TermVectorsRequestDescriptor Filter(Action - /// Overrides the default per-field analyzer. + /// + /// Overrides the default per-field analyzer. + /// /// public TermVectorsRequestDescriptor PerFieldAnalyzer(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TermsEnumRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TermsEnumRequest.g.cs index a496a093563..ee29eb7ecc3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TermsEnumRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TermsEnumRequest.g.cs @@ -34,7 +34,9 @@ public sealed partial class TermsEnumRequestParameters : RequestParameters } /// -/// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. +/// +/// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. +/// /// public sealed partial class TermsEnumRequest : PlainRequest { @@ -51,19 +53,25 @@ public TermsEnumRequest(Elastic.Clients.Elasticsearch.IndexName index) : base(r internal override string OperationName => "terms_enum"; /// - /// When true the provided search string is matched against index terms without case sensitivity. + /// + /// When true the provided search string is matched against index terms without case sensitivity. + /// /// [JsonInclude, JsonPropertyName("case_insensitive")] public bool? CaseInsensitive { get; set; } /// - /// The string to match at the start of indexed terms. If not provided, all terms in the field are considered. + /// + /// The string to match at the start of indexed terms. If not provided, all terms in the field are considered. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Allows to filter an index shard if the provided query rewrites to match_none. + /// + /// Allows to filter an index shard if the provided query rewrites to match_none. + /// /// [JsonInclude, JsonPropertyName("index_filter")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? IndexFilter { get; set; } @@ -71,26 +79,34 @@ public TermsEnumRequest(Elastic.Clients.Elasticsearch.IndexName index) : base(r public string? SearchAfter { get; set; } /// - /// How many matching terms to return. + /// + /// How many matching terms to return. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// The string after which terms in the index should be returned. Allows for a form of pagination if the last result from one request is passed as the search_after parameter for a subsequent request. + /// + /// The string after which terms in the index should be returned. Allows for a form of pagination if the last result from one request is passed as the search_after parameter for a subsequent request. + /// /// [JsonInclude, JsonPropertyName("string")] public string? String { get; set; } /// - /// The maximum length of time to spend collecting results. Defaults to "1s" (one second). If the timeout is exceeded the complete flag set to false in the response and the results may be partial or empty. + /// + /// The maximum length of time to spend collecting results. Defaults to "1s" (one second). If the timeout is exceeded the complete flag set to false in the response and the results may be partial or empty. + /// /// [JsonInclude, JsonPropertyName("timeout")] public Elastic.Clients.Elasticsearch.Duration? Timeout { get; set; } } /// -/// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. +/// +/// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. +/// /// public sealed partial class TermsEnumRequestDescriptor : RequestDescriptor, TermsEnumRequestParameters> { @@ -129,7 +145,9 @@ public TermsEnumRequestDescriptor Index(Elastic.Clients.Elasticsearch private Elastic.Clients.Elasticsearch.Duration? TimeoutValue { get; set; } /// - /// When true the provided search string is matched against index terms without case sensitivity. + /// + /// When true the provided search string is matched against index terms without case sensitivity. + /// /// public TermsEnumRequestDescriptor CaseInsensitive(bool? caseInsensitive = true) { @@ -138,7 +156,9 @@ public TermsEnumRequestDescriptor CaseInsensitive(bool? caseInsensiti } /// - /// The string to match at the start of indexed terms. If not provided, all terms in the field are considered. + /// + /// The string to match at the start of indexed terms. If not provided, all terms in the field are considered. + /// /// public TermsEnumRequestDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -147,7 +167,9 @@ public TermsEnumRequestDescriptor Field(Elastic.Clients.Elasticsearch } /// - /// The string to match at the start of indexed terms. If not provided, all terms in the field are considered. + /// + /// The string to match at the start of indexed terms. If not provided, all terms in the field are considered. + /// /// public TermsEnumRequestDescriptor Field(Expression> field) { @@ -156,7 +178,9 @@ public TermsEnumRequestDescriptor Field(Expression - /// The string to match at the start of indexed terms. If not provided, all terms in the field are considered. + /// + /// The string to match at the start of indexed terms. If not provided, all terms in the field are considered. + /// /// public TermsEnumRequestDescriptor Field(Expression> field) { @@ -165,7 +189,9 @@ public TermsEnumRequestDescriptor Field(Expression - /// Allows to filter an index shard if the provided query rewrites to match_none. + /// + /// Allows to filter an index shard if the provided query rewrites to match_none. + /// /// public TermsEnumRequestDescriptor IndexFilter(Elastic.Clients.Elasticsearch.QueryDsl.Query? indexFilter) { @@ -198,7 +224,9 @@ public TermsEnumRequestDescriptor SearchAfter(string? searchAfter) } /// - /// How many matching terms to return. + /// + /// How many matching terms to return. + /// /// public TermsEnumRequestDescriptor Size(int? size) { @@ -207,7 +235,9 @@ public TermsEnumRequestDescriptor Size(int? size) } /// - /// The string after which terms in the index should be returned. Allows for a form of pagination if the last result from one request is passed as the search_after parameter for a subsequent request. + /// + /// The string after which terms in the index should be returned. Allows for a form of pagination if the last result from one request is passed as the search_after parameter for a subsequent request. + /// /// public TermsEnumRequestDescriptor String(string? value) { @@ -216,7 +246,9 @@ public TermsEnumRequestDescriptor String(string? value) } /// - /// The maximum length of time to spend collecting results. Defaults to "1s" (one second). If the timeout is exceeded the complete flag set to false in the response and the results may be partial or empty. + /// + /// The maximum length of time to spend collecting results. Defaults to "1s" (one second). If the timeout is exceeded the complete flag set to false in the response and the results may be partial or empty. + /// /// public TermsEnumRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Duration? timeout) { @@ -280,7 +312,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. +/// +/// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. +/// /// public sealed partial class TermsEnumRequestDescriptor : RequestDescriptor { @@ -315,7 +349,9 @@ public TermsEnumRequestDescriptor Index(Elastic.Clients.Elasticsearch.IndexName private Elastic.Clients.Elasticsearch.Duration? TimeoutValue { get; set; } /// - /// When true the provided search string is matched against index terms without case sensitivity. + /// + /// When true the provided search string is matched against index terms without case sensitivity. + /// /// public TermsEnumRequestDescriptor CaseInsensitive(bool? caseInsensitive = true) { @@ -324,7 +360,9 @@ public TermsEnumRequestDescriptor CaseInsensitive(bool? caseInsensitive = true) } /// - /// The string to match at the start of indexed terms. If not provided, all terms in the field are considered. + /// + /// The string to match at the start of indexed terms. If not provided, all terms in the field are considered. + /// /// public TermsEnumRequestDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -333,7 +371,9 @@ public TermsEnumRequestDescriptor Field(Elastic.Clients.Elasticsearch.Field fiel } /// - /// The string to match at the start of indexed terms. If not provided, all terms in the field are considered. + /// + /// The string to match at the start of indexed terms. If not provided, all terms in the field are considered. + /// /// public TermsEnumRequestDescriptor Field(Expression> field) { @@ -342,7 +382,9 @@ public TermsEnumRequestDescriptor Field(Expression - /// The string to match at the start of indexed terms. If not provided, all terms in the field are considered. + /// + /// The string to match at the start of indexed terms. If not provided, all terms in the field are considered. + /// /// public TermsEnumRequestDescriptor Field(Expression> field) { @@ -351,7 +393,9 @@ public TermsEnumRequestDescriptor Field(Expression - /// Allows to filter an index shard if the provided query rewrites to match_none. + /// + /// Allows to filter an index shard if the provided query rewrites to match_none. + /// /// public TermsEnumRequestDescriptor IndexFilter(Elastic.Clients.Elasticsearch.QueryDsl.Query? indexFilter) { @@ -384,7 +428,9 @@ public TermsEnumRequestDescriptor SearchAfter(string? searchAfter) } /// - /// How many matching terms to return. + /// + /// How many matching terms to return. + /// /// public TermsEnumRequestDescriptor Size(int? size) { @@ -393,7 +439,9 @@ public TermsEnumRequestDescriptor Size(int? size) } /// - /// The string after which terms in the index should be returned. Allows for a form of pagination if the last result from one request is passed as the search_after parameter for a subsequent request. + /// + /// The string after which terms in the index should be returned. Allows for a form of pagination if the last result from one request is passed as the search_after parameter for a subsequent request. + /// /// public TermsEnumRequestDescriptor String(string? value) { @@ -402,7 +450,9 @@ public TermsEnumRequestDescriptor String(string? value) } /// - /// The maximum length of time to spend collecting results. Defaults to "1s" (one second). If the timeout is exceeded the complete flag set to false in the response and the results may be partial or empty. + /// + /// The maximum length of time to spend collecting results. Defaults to "1s" (one second). If the timeout is exceeded the complete flag set to false in the response and the results may be partial or empty. + /// /// public TermsEnumRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Duration? timeout) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TextStructure/TestGrokPatternRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TextStructure/TestGrokPatternRequest.g.cs index 764ba1e5667..fedd469cdb3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TextStructure/TestGrokPatternRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TextStructure/TestGrokPatternRequest.g.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch.TextStructure; public sealed partial class TestGrokPatternRequestParameters : RequestParameters { /// - /// The mode of compatibility with ECS compliant Grok patterns (disabled or v1, default: disabled). + /// + /// The mode of compatibility with ECS compliant Grok patterns (disabled or v1, default: disabled). + /// /// public string? EcsCompatibility { get => Q("ecs_compatibility"); set => Q("ecs_compatibility", value); } } /// -/// Tests a Grok pattern on some text. +/// +/// Tests a Grok pattern on some text. +/// /// public sealed partial class TestGrokPatternRequest : PlainRequest { @@ -51,26 +55,34 @@ public sealed partial class TestGrokPatternRequest : PlainRequest "text_structure.test_grok_pattern"; /// - /// The mode of compatibility with ECS compliant Grok patterns (disabled or v1, default: disabled). + /// + /// The mode of compatibility with ECS compliant Grok patterns (disabled or v1, default: disabled). + /// /// [JsonIgnore] public string? EcsCompatibility { get => Q("ecs_compatibility"); set => Q("ecs_compatibility", value); } /// - /// Grok pattern to run on the text. + /// + /// Grok pattern to run on the text. + /// /// [JsonInclude, JsonPropertyName("grok_pattern")] public string GrokPattern { get; set; } /// - /// Lines of text to run the Grok pattern on. + /// + /// Lines of text to run the Grok pattern on. + /// /// [JsonInclude, JsonPropertyName("text")] public ICollection Text { get; set; } } /// -/// Tests a Grok pattern on some text. +/// +/// Tests a Grok pattern on some text. +/// /// public sealed partial class TestGrokPatternRequestDescriptor : RequestDescriptor { @@ -94,7 +106,9 @@ public TestGrokPatternRequestDescriptor() private ICollection TextValue { get; set; } /// - /// Grok pattern to run on the text. + /// + /// Grok pattern to run on the text. + /// /// public TestGrokPatternRequestDescriptor GrokPattern(string grokPattern) { @@ -103,7 +117,9 @@ public TestGrokPatternRequestDescriptor GrokPattern(string grokPattern) } /// - /// Lines of text to run the Grok pattern on. + /// + /// Lines of text to run the Grok pattern on. + /// /// public TestGrokPatternRequestDescriptor Text(ICollection text) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/DeleteTransformRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/DeleteTransformRequest.g.cs index 551c36dbae2..93a077fc786 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/DeleteTransformRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/DeleteTransformRequest.g.cs @@ -32,23 +32,34 @@ namespace Elastic.Clients.Elasticsearch.TransformManagement; public sealed partial class DeleteTransformRequestParameters : RequestParameters { /// - /// If this value is true, the destination index is deleted together with the transform. If false, the destination
index will not be deleted + /// + /// If this value is true, the destination index is deleted together with the transform. If false, the destination + /// index will not be deleted + /// /// public bool? DeleteDestIndex { get => Q("delete_dest_index"); set => Q("delete_dest_index", value); } /// - /// If this value is false, the transform must be stopped before it can be deleted. If true, the transform is
deleted regardless of its current state. + /// + /// If this value is false, the transform must be stopped before it can be deleted. If true, the transform is + /// deleted regardless of its current state. + /// /// public bool? Force { get => Q("force"); set => Q("force", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete a transform.
Deletes a transform. +/// +/// Delete a transform. +/// Deletes a transform. +/// /// public sealed partial class DeleteTransformRequest : PlainRequest { @@ -65,26 +76,37 @@ public DeleteTransformRequest(Elastic.Clients.Elasticsearch.Id transformId) : ba internal override string OperationName => "transform.delete_transform"; /// - /// If this value is true, the destination index is deleted together with the transform. If false, the destination
index will not be deleted + /// + /// If this value is true, the destination index is deleted together with the transform. If false, the destination + /// index will not be deleted + /// /// [JsonIgnore] public bool? DeleteDestIndex { get => Q("delete_dest_index"); set => Q("delete_dest_index", value); } /// - /// If this value is false, the transform must be stopped before it can be deleted. If true, the transform is
deleted regardless of its current state. + /// + /// If this value is false, the transform must be stopped before it can be deleted. If true, the transform is + /// deleted regardless of its current state. + /// /// [JsonIgnore] public bool? Force { get => Q("force"); set => Q("force", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Delete a transform.
Deletes a transform. +/// +/// Delete a transform. +/// Deletes a transform. +/// /// public sealed partial class DeleteTransformRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/DeleteTransformResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/DeleteTransformResponse.g.cs index 55eaa25dd3f..afcb0daed68 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/DeleteTransformResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/DeleteTransformResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.TransformManagement; public sealed partial class DeleteTransformResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/GetTransformRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/GetTransformRequest.g.cs index 76906cefa97..7aec1466cf4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/GetTransformRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/GetTransformRequest.g.cs @@ -32,30 +32,62 @@ namespace Elastic.Clients.Elasticsearch.TransformManagement; public sealed partial class GetTransformRequestParameters : RequestParameters { /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no transforms that match.
2. Contains the _all string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// If this parameter is false, the request returns a 404 status code when
there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no transforms that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// If this parameter is false, the request returns a 404 status code when + /// there are no matches or only partial matches. + /// /// public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Excludes fields that were automatically added when creating the
transform. This allows the configuration to be in an acceptable format to
be retrieved and then added to another cluster. + /// + /// Excludes fields that were automatically added when creating the + /// transform. This allows the configuration to be in an acceptable format to + /// be retrieved and then added to another cluster. + /// /// public bool? ExcludeGenerated { get => Q("exclude_generated"); set => Q("exclude_generated", value); } /// - /// Skips the specified number of transforms. + /// + /// Skips the specified number of transforms. + /// /// public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of transforms to obtain. + /// + /// Specifies the maximum number of transforms to obtain. + /// /// public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Get transforms.
Retrieves configuration information for transforms. +/// +/// Get transforms. +/// Retrieves configuration information for transforms. +/// /// public sealed partial class GetTransformRequest : PlainRequest { @@ -76,34 +108,66 @@ public GetTransformRequest(Elastic.Clients.Elasticsearch.Names? transformId) : b internal override string OperationName => "transform.get_transform"; /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no transforms that match.
2. Contains the _all string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// If this parameter is false, the request returns a 404 status code when
there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no transforms that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// If this parameter is false, the request returns a 404 status code when + /// there are no matches or only partial matches. + /// /// [JsonIgnore] public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Excludes fields that were automatically added when creating the
transform. This allows the configuration to be in an acceptable format to
be retrieved and then added to another cluster. + /// + /// Excludes fields that were automatically added when creating the + /// transform. This allows the configuration to be in an acceptable format to + /// be retrieved and then added to another cluster. + /// /// [JsonIgnore] public bool? ExcludeGenerated { get => Q("exclude_generated"); set => Q("exclude_generated", value); } /// - /// Skips the specified number of transforms. + /// + /// Skips the specified number of transforms. + /// /// [JsonIgnore] public int? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of transforms to obtain. + /// + /// Specifies the maximum number of transforms to obtain. + /// /// [JsonIgnore] public int? Size { get => Q("size"); set => Q("size", value); } } /// -/// Get transforms.
Retrieves configuration information for transforms. +/// +/// Get transforms. +/// Retrieves configuration information for transforms. +/// /// public sealed partial class GetTransformRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/GetTransformStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/GetTransformStatsRequest.g.cs index 1e2737c5637..7d91f1bd589 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/GetTransformStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/GetTransformStatsRequest.g.cs @@ -32,30 +32,60 @@ namespace Elastic.Clients.Elasticsearch.TransformManagement; public sealed partial class GetTransformStatsRequestParameters : RequestParameters { /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no transforms that match.
2. Contains the _all string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// If this parameter is false, the request returns a 404 status code when
there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no transforms that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// If this parameter is false, the request returns a 404 status code when + /// there are no matches or only partial matches. + /// /// public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Skips the specified number of transforms. + /// + /// Skips the specified number of transforms. + /// /// public long? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of transforms to obtain. + /// + /// Specifies the maximum number of transforms to obtain. + /// /// public long? Size { get => Q("size"); set => Q("size", value); } /// - /// Controls the time to wait for the stats + /// + /// Controls the time to wait for the stats + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Get transform stats.
Retrieves usage information for transforms. +/// +/// Get transform stats. +/// Retrieves usage information for transforms. +/// /// public sealed partial class GetTransformStatsRequest : PlainRequest { @@ -72,34 +102,64 @@ public GetTransformStatsRequest(Elastic.Clients.Elasticsearch.Names transformId) internal override string OperationName => "transform.get_transform_stats"; /// - /// Specifies what to do when the request: - /// 1. Contains wildcard expressions and there are no transforms that match.
2. Contains the _all string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches. - /// If this parameter is false, the request returns a 404 status code when
there are no matches or only partial matches. + /// + /// Specifies what to do when the request: + /// + /// + /// + /// + /// Contains wildcard expressions and there are no transforms that match. + /// + /// + /// + /// + /// Contains the _all string or no identifiers and there are no matches. + /// + /// + /// + /// + /// Contains wildcard expressions and there are only partial matches. + /// + /// + /// + /// + /// If this parameter is false, the request returns a 404 status code when + /// there are no matches or only partial matches. + /// /// [JsonIgnore] public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// Skips the specified number of transforms. + /// + /// Skips the specified number of transforms. + /// /// [JsonIgnore] public long? From { get => Q("from"); set => Q("from", value); } /// - /// Specifies the maximum number of transforms to obtain. + /// + /// Specifies the maximum number of transforms to obtain. + /// /// [JsonIgnore] public long? Size { get => Q("size"); set => Q("size", value); } /// - /// Controls the time to wait for the stats + /// + /// Controls the time to wait for the stats + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Get transform stats.
Retrieves usage information for transforms. +/// +/// Get transform stats. +/// Retrieves usage information for transforms. +/// /// public sealed partial class GetTransformStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/PreviewTransformRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/PreviewTransformRequest.g.cs index c1e5a1519b2..9d638131afa 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/PreviewTransformRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/PreviewTransformRequest.g.cs @@ -32,14 +32,24 @@ namespace Elastic.Clients.Elasticsearch.TransformManagement; public sealed partial class PreviewTransformRequestParameters : RequestParameters { /// - /// Period to wait for a response. If no response is received before the
timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the + /// timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Preview a transform.
Generates a preview of the results that you will get when you create a transform with the same configuration. -/// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also
generates a list of mappings and settings for the destination index. These values are determined based on the field
types of the source index and the transform aggregations. +/// +/// Preview a transform. +/// Generates a preview of the results that you will get when you create a transform with the same configuration. +/// +/// +/// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also +/// generates a list of mappings and settings for the destination index. These values are determined based on the field +/// types of the source index and the transform aggregations. +/// /// public sealed partial class PreviewTransformRequest : PlainRequest { @@ -60,69 +70,104 @@ public PreviewTransformRequest(Elastic.Clients.Elasticsearch.Id? transformId) : internal override string OperationName => "transform.preview_transform"; /// - /// Period to wait for a response. If no response is received before the
timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the + /// timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Free text description of the transform. + /// + /// Free text description of the transform. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The destination for the transform. + /// + /// The destination for the transform. + /// /// [JsonInclude, JsonPropertyName("dest")] public Elastic.Clients.Elasticsearch.TransformManagement.Destination? Dest { get; set; } /// - /// The interval between checks for changes in the source indices when the
transform is running continuously. Also determines the retry interval in
the event of transient failures while the transform is searching or
indexing. The minimum value is 1s and the maximum is 1h. + /// + /// The interval between checks for changes in the source indices when the + /// transform is running continuously. Also determines the retry interval in + /// the event of transient failures while the transform is searching or + /// indexing. The minimum value is 1s and the maximum is 1h. + /// /// [JsonInclude, JsonPropertyName("frequency")] public Elastic.Clients.Elasticsearch.Duration? Frequency { get; set; } /// - /// The latest method transforms the data by finding the latest document for
each unique key. + /// + /// The latest method transforms the data by finding the latest document for + /// each unique key. + /// /// [JsonInclude, JsonPropertyName("latest")] public Elastic.Clients.Elasticsearch.TransformManagement.Latest? Latest { get; set; } /// - /// The pivot method transforms the data by aggregating and grouping it.
These objects define the group by fields and the aggregation to reduce
the data. + /// + /// The pivot method transforms the data by aggregating and grouping it. + /// These objects define the group by fields and the aggregation to reduce + /// the data. + /// /// [JsonInclude, JsonPropertyName("pivot")] public Elastic.Clients.Elasticsearch.TransformManagement.Pivot? Pivot { get; set; } /// - /// Defines a retention policy for the transform. Data that meets the defined
criteria is deleted from the destination index. + /// + /// Defines a retention policy for the transform. Data that meets the defined + /// criteria is deleted from the destination index. + /// /// [JsonInclude, JsonPropertyName("retention_policy")] public Elastic.Clients.Elasticsearch.TransformManagement.RetentionPolicy? RetentionPolicy { get; set; } /// - /// Defines optional transform settings. + /// + /// Defines optional transform settings. + /// /// [JsonInclude, JsonPropertyName("settings")] public Elastic.Clients.Elasticsearch.TransformManagement.Settings? Settings { get; set; } /// - /// The source of the data for the transform. + /// + /// The source of the data for the transform. + /// /// [JsonInclude, JsonPropertyName("source")] public Elastic.Clients.Elasticsearch.TransformManagement.Source? Source { get; set; } /// - /// Defines the properties transforms require to run continuously. + /// + /// Defines the properties transforms require to run continuously. + /// /// [JsonInclude, JsonPropertyName("sync")] public Elastic.Clients.Elasticsearch.TransformManagement.Sync? Sync { get; set; } } /// -/// Preview a transform.
Generates a preview of the results that you will get when you create a transform with the same configuration. -/// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also
generates a list of mappings and settings for the destination index. These values are determined based on the field
types of the source index and the transform aggregations. +/// +/// Preview a transform. +/// Generates a preview of the results that you will get when you create a transform with the same configuration. +/// +/// +/// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also +/// generates a list of mappings and settings for the destination index. These values are determined based on the field +/// types of the source index and the transform aggregations. +/// /// public sealed partial class PreviewTransformRequestDescriptor : RequestDescriptor, PreviewTransformRequestParameters> { @@ -177,7 +222,9 @@ public PreviewTransformRequestDescriptor TransformId(Elastic.Clients. private Action> SyncDescriptorAction { get; set; } /// - /// Free text description of the transform. + /// + /// Free text description of the transform. + /// /// public PreviewTransformRequestDescriptor Description(string? description) { @@ -186,7 +233,9 @@ public PreviewTransformRequestDescriptor Description(string? descript } /// - /// The destination for the transform. + /// + /// The destination for the transform. + /// /// public PreviewTransformRequestDescriptor Dest(Elastic.Clients.Elasticsearch.TransformManagement.Destination? dest) { @@ -213,7 +262,12 @@ public PreviewTransformRequestDescriptor Dest(Action - /// The interval between checks for changes in the source indices when the
transform is running continuously. Also determines the retry interval in
the event of transient failures while the transform is searching or
indexing. The minimum value is 1s and the maximum is 1h. + /// + /// The interval between checks for changes in the source indices when the + /// transform is running continuously. Also determines the retry interval in + /// the event of transient failures while the transform is searching or + /// indexing. The minimum value is 1s and the maximum is 1h. + /// /// public PreviewTransformRequestDescriptor Frequency(Elastic.Clients.Elasticsearch.Duration? frequency) { @@ -222,7 +276,10 @@ public PreviewTransformRequestDescriptor Frequency(Elastic.Clients.El } /// - /// The latest method transforms the data by finding the latest document for
each unique key. + /// + /// The latest method transforms the data by finding the latest document for + /// each unique key. + /// /// public PreviewTransformRequestDescriptor Latest(Elastic.Clients.Elasticsearch.TransformManagement.Latest? latest) { @@ -249,7 +306,11 @@ public PreviewTransformRequestDescriptor Latest(Action - /// The pivot method transforms the data by aggregating and grouping it.
These objects define the group by fields and the aggregation to reduce
the data. + /// + /// The pivot method transforms the data by aggregating and grouping it. + /// These objects define the group by fields and the aggregation to reduce + /// the data. + /// /// public PreviewTransformRequestDescriptor Pivot(Elastic.Clients.Elasticsearch.TransformManagement.Pivot? pivot) { @@ -276,7 +337,10 @@ public PreviewTransformRequestDescriptor Pivot(Action - /// Defines a retention policy for the transform. Data that meets the defined
criteria is deleted from the destination index. + /// + /// Defines a retention policy for the transform. Data that meets the defined + /// criteria is deleted from the destination index. + /// /// public PreviewTransformRequestDescriptor RetentionPolicy(Elastic.Clients.Elasticsearch.TransformManagement.RetentionPolicy? retentionPolicy) { @@ -303,7 +367,9 @@ public PreviewTransformRequestDescriptor RetentionPolicy(Action - /// Defines optional transform settings. + /// + /// Defines optional transform settings. + /// /// public PreviewTransformRequestDescriptor Settings(Elastic.Clients.Elasticsearch.TransformManagement.Settings? settings) { @@ -330,7 +396,9 @@ public PreviewTransformRequestDescriptor Settings(Action - /// The source of the data for the transform. + /// + /// The source of the data for the transform. + /// /// public PreviewTransformRequestDescriptor Source(Elastic.Clients.Elasticsearch.TransformManagement.Source? source) { @@ -357,7 +425,9 @@ public PreviewTransformRequestDescriptor Source(Action - /// Defines the properties transforms require to run continuously. + /// + /// Defines the properties transforms require to run continuously. + /// /// public PreviewTransformRequestDescriptor Sync(Elastic.Clients.Elasticsearch.TransformManagement.Sync? sync) { @@ -515,8 +585,15 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Preview a transform.
Generates a preview of the results that you will get when you create a transform with the same configuration. -/// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also
generates a list of mappings and settings for the destination index. These values are determined based on the field
types of the source index and the transform aggregations. +/// +/// Preview a transform. +/// Generates a preview of the results that you will get when you create a transform with the same configuration. +/// +/// +/// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also +/// generates a list of mappings and settings for the destination index. These values are determined based on the field +/// types of the source index and the transform aggregations. +/// /// public sealed partial class PreviewTransformRequestDescriptor : RequestDescriptor { @@ -571,7 +648,9 @@ public PreviewTransformRequestDescriptor TransformId(Elastic.Clients.Elasticsear private Action SyncDescriptorAction { get; set; } /// - /// Free text description of the transform. + /// + /// Free text description of the transform. + /// /// public PreviewTransformRequestDescriptor Description(string? description) { @@ -580,7 +659,9 @@ public PreviewTransformRequestDescriptor Description(string? description) } /// - /// The destination for the transform. + /// + /// The destination for the transform. + /// /// public PreviewTransformRequestDescriptor Dest(Elastic.Clients.Elasticsearch.TransformManagement.Destination? dest) { @@ -607,7 +688,12 @@ public PreviewTransformRequestDescriptor Dest(Action - /// The interval between checks for changes in the source indices when the
transform is running continuously. Also determines the retry interval in
the event of transient failures while the transform is searching or
indexing. The minimum value is 1s and the maximum is 1h. + /// + /// The interval between checks for changes in the source indices when the + /// transform is running continuously. Also determines the retry interval in + /// the event of transient failures while the transform is searching or + /// indexing. The minimum value is 1s and the maximum is 1h. + /// /// public PreviewTransformRequestDescriptor Frequency(Elastic.Clients.Elasticsearch.Duration? frequency) { @@ -616,7 +702,10 @@ public PreviewTransformRequestDescriptor Frequency(Elastic.Clients.Elasticsearch } /// - /// The latest method transforms the data by finding the latest document for
each unique key. + /// + /// The latest method transforms the data by finding the latest document for + /// each unique key. + /// /// public PreviewTransformRequestDescriptor Latest(Elastic.Clients.Elasticsearch.TransformManagement.Latest? latest) { @@ -643,7 +732,11 @@ public PreviewTransformRequestDescriptor Latest(Action - /// The pivot method transforms the data by aggregating and grouping it.
These objects define the group by fields and the aggregation to reduce
the data. + /// + /// The pivot method transforms the data by aggregating and grouping it. + /// These objects define the group by fields and the aggregation to reduce + /// the data. + /// /// public PreviewTransformRequestDescriptor Pivot(Elastic.Clients.Elasticsearch.TransformManagement.Pivot? pivot) { @@ -670,7 +763,10 @@ public PreviewTransformRequestDescriptor Pivot(Action - /// Defines a retention policy for the transform. Data that meets the defined
criteria is deleted from the destination index. + /// + /// Defines a retention policy for the transform. Data that meets the defined + /// criteria is deleted from the destination index. + /// /// public PreviewTransformRequestDescriptor RetentionPolicy(Elastic.Clients.Elasticsearch.TransformManagement.RetentionPolicy? retentionPolicy) { @@ -697,7 +793,9 @@ public PreviewTransformRequestDescriptor RetentionPolicy(Action - /// Defines optional transform settings. + /// + /// Defines optional transform settings. + /// /// public PreviewTransformRequestDescriptor Settings(Elastic.Clients.Elasticsearch.TransformManagement.Settings? settings) { @@ -724,7 +822,9 @@ public PreviewTransformRequestDescriptor Settings(Action - /// The source of the data for the transform. + /// + /// The source of the data for the transform. + /// /// public PreviewTransformRequestDescriptor Source(Elastic.Clients.Elasticsearch.TransformManagement.Source? source) { @@ -751,7 +851,9 @@ public PreviewTransformRequestDescriptor Source(Action - /// Defines the properties transforms require to run continuously. + /// + /// Defines the properties transforms require to run continuously. + /// /// public PreviewTransformRequestDescriptor Sync(Elastic.Clients.Elasticsearch.TransformManagement.Sync? sync) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/PutTransformRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/PutTransformRequest.g.cs index 69e7bb76fc6..e015ccaf007 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/PutTransformRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/PutTransformRequest.g.cs @@ -32,22 +32,53 @@ namespace Elastic.Clients.Elasticsearch.TransformManagement; public sealed partial class PutTransformRequestParameters : RequestParameters { /// - /// When the transform is created, a series of validations occur to ensure its success. For example, there is a
check for the existence of the source indices and a check that the destination index is not part of the source
index pattern. You can use this parameter to skip the checks, for example when the source index does not exist
until after the transform is created. The validations are always run when you start the transform, however, with
the exception of privilege checks. + /// + /// When the transform is created, a series of validations occur to ensure its success. For example, there is a + /// check for the existence of the source indices and a check that the destination index is not part of the source + /// index pattern. You can use this parameter to skip the checks, for example when the source index does not exist + /// until after the transform is created. The validations are always run when you start the transform, however, with + /// the exception of privilege checks. + /// /// public bool? DeferValidation { get => Q("defer_validation"); set => Q("defer_validation", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Create a transform.
Creates a transform. -/// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as
a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
unique row per entity. -/// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If
you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in
the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values
in the latest object. -/// You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and
`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the
transform remembers which roles the user that created it had at the time of creation and uses those same roles. If
those roles do not have the required privileges on the source and destination indices, the transform fails when it
attempts unauthorized operations. -/// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any
`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not
give users any privileges on `.data-frame-internal*` indices. +/// +/// Create a transform. +/// Creates a transform. +/// +/// +/// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as +/// a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a +/// unique row per entity. +/// +/// +/// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If +/// you choose to use the pivot method for your transform, the entities are defined by the set of group_by fields in +/// the pivot object. If you choose to use the latest method, the entities are defined by the unique_key field values +/// in the latest object. +/// +/// +/// You must have create_index, index, and read privileges on the destination index and read and +/// view_index_metadata privileges on the source indices. When Elasticsearch security features are enabled, the +/// transform remembers which roles the user that created it had at the time of creation and uses those same roles. If +/// those roles do not have the required privileges on the source and destination indices, the transform fails when it +/// attempts unauthorized operations. +/// +/// +/// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any +/// .transform-internal* indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do +/// not give users any privileges on .transform-internal* indices. If you used transforms prior to 7.5, also do not +/// give users any privileges on .data-frame-internal* indices. +/// /// public sealed partial class PutTransformRequest : PlainRequest { @@ -64,84 +95,139 @@ public PutTransformRequest(Elastic.Clients.Elasticsearch.Id transformId) : base( internal override string OperationName => "transform.put_transform"; /// - /// When the transform is created, a series of validations occur to ensure its success. For example, there is a
check for the existence of the source indices and a check that the destination index is not part of the source
index pattern. You can use this parameter to skip the checks, for example when the source index does not exist
until after the transform is created. The validations are always run when you start the transform, however, with
the exception of privilege checks. + /// + /// When the transform is created, a series of validations occur to ensure its success. For example, there is a + /// check for the existence of the source indices and a check that the destination index is not part of the source + /// index pattern. You can use this parameter to skip the checks, for example when the source index does not exist + /// until after the transform is created. The validations are always run when you start the transform, however, with + /// the exception of privilege checks. + /// /// [JsonIgnore] public bool? DeferValidation { get => Q("defer_validation"); set => Q("defer_validation", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Free text description of the transform. + /// + /// Free text description of the transform. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The destination for the transform. + /// + /// The destination for the transform. + /// /// [JsonInclude, JsonPropertyName("dest")] public Elastic.Clients.Elasticsearch.TransformManagement.Destination Dest { get; set; } /// - /// The interval between checks for changes in the source indices when the transform is running continuously. Also
determines the retry interval in the event of transient failures while the transform is searching or indexing.
The minimum value is `1s` and the maximum is `1h`. + /// + /// The interval between checks for changes in the source indices when the transform is running continuously. Also + /// determines the retry interval in the event of transient failures while the transform is searching or indexing. + /// The minimum value is 1s and the maximum is 1h. + /// /// [JsonInclude, JsonPropertyName("frequency")] public Elastic.Clients.Elasticsearch.Duration? Frequency { get; set; } /// - /// The latest method transforms the data by finding the latest document for each unique key. + /// + /// The latest method transforms the data by finding the latest document for each unique key. + /// /// [JsonInclude, JsonPropertyName("latest")] public Elastic.Clients.Elasticsearch.TransformManagement.Latest? Latest { get; set; } /// - /// Defines optional transform metadata. + /// + /// Defines optional transform metadata. + /// /// [JsonInclude, JsonPropertyName("_meta")] public IDictionary? Meta { get; set; } /// - /// The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields
and the aggregation to reduce the data. + /// + /// The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields + /// and the aggregation to reduce the data. + /// /// [JsonInclude, JsonPropertyName("pivot")] public Elastic.Clients.Elasticsearch.TransformManagement.Pivot? Pivot { get; set; } /// - /// Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the
destination index. + /// + /// Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the + /// destination index. + /// /// [JsonInclude, JsonPropertyName("retention_policy")] public Elastic.Clients.Elasticsearch.TransformManagement.RetentionPolicy? RetentionPolicy { get; set; } /// - /// Defines optional transform settings. + /// + /// Defines optional transform settings. + /// /// [JsonInclude, JsonPropertyName("settings")] public Elastic.Clients.Elasticsearch.TransformManagement.Settings? Settings { get; set; } /// - /// The source of the data for the transform. + /// + /// The source of the data for the transform. + /// /// [JsonInclude, JsonPropertyName("source")] public Elastic.Clients.Elasticsearch.TransformManagement.Source Source { get; set; } /// - /// Defines the properties transforms require to run continuously. + /// + /// Defines the properties transforms require to run continuously. + /// /// [JsonInclude, JsonPropertyName("sync")] public Elastic.Clients.Elasticsearch.TransformManagement.Sync? Sync { get; set; } } /// -/// Create a transform.
Creates a transform. -/// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as
a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
unique row per entity. -/// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If
you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in
the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values
in the latest object. -/// You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and
`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the
transform remembers which roles the user that created it had at the time of creation and uses those same roles. If
those roles do not have the required privileges on the source and destination indices, the transform fails when it
attempts unauthorized operations. -/// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any
`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not
give users any privileges on `.data-frame-internal*` indices. +/// +/// Create a transform. +/// Creates a transform. +/// +/// +/// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as +/// a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a +/// unique row per entity. +/// +/// +/// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If +/// you choose to use the pivot method for your transform, the entities are defined by the set of group_by fields in +/// the pivot object. If you choose to use the latest method, the entities are defined by the unique_key field values +/// in the latest object. +/// +/// +/// You must have create_index, index, and read privileges on the destination index and read and +/// view_index_metadata privileges on the source indices. When Elasticsearch security features are enabled, the +/// transform remembers which roles the user that created it had at the time of creation and uses those same roles. If +/// those roles do not have the required privileges on the source and destination indices, the transform fails when it +/// attempts unauthorized operations. +/// +/// +/// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any +/// .transform-internal* indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do +/// not give users any privileges on .transform-internal* indices. If you used transforms prior to 7.5, also do not +/// give users any privileges on .data-frame-internal* indices. +/// /// public sealed partial class PutTransformRequestDescriptor : RequestDescriptor, PutTransformRequestParameters> { @@ -194,7 +280,9 @@ public PutTransformRequestDescriptor TransformId(Elastic.Clients.Elas private Action> SyncDescriptorAction { get; set; } /// - /// Free text description of the transform. + /// + /// Free text description of the transform. + /// /// public PutTransformRequestDescriptor Description(string? description) { @@ -203,7 +291,9 @@ public PutTransformRequestDescriptor Description(string? description) } /// - /// The destination for the transform. + /// + /// The destination for the transform. + /// /// public PutTransformRequestDescriptor Dest(Elastic.Clients.Elasticsearch.TransformManagement.Destination dest) { @@ -230,7 +320,11 @@ public PutTransformRequestDescriptor Dest(Action - /// The interval between checks for changes in the source indices when the transform is running continuously. Also
determines the retry interval in the event of transient failures while the transform is searching or indexing.
The minimum value is `1s` and the maximum is `1h`. + /// + /// The interval between checks for changes in the source indices when the transform is running continuously. Also + /// determines the retry interval in the event of transient failures while the transform is searching or indexing. + /// The minimum value is 1s and the maximum is 1h. + /// /// public PutTransformRequestDescriptor Frequency(Elastic.Clients.Elasticsearch.Duration? frequency) { @@ -239,7 +333,9 @@ public PutTransformRequestDescriptor Frequency(Elastic.Clients.Elasti } /// - /// The latest method transforms the data by finding the latest document for each unique key. + /// + /// The latest method transforms the data by finding the latest document for each unique key. + /// /// public PutTransformRequestDescriptor Latest(Elastic.Clients.Elasticsearch.TransformManagement.Latest? latest) { @@ -266,7 +362,9 @@ public PutTransformRequestDescriptor Latest(Action - /// Defines optional transform metadata. + /// + /// Defines optional transform metadata. + /// /// public PutTransformRequestDescriptor Meta(Func, FluentDictionary> selector) { @@ -275,7 +373,10 @@ public PutTransformRequestDescriptor Meta(Func - /// The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields
and the aggregation to reduce the data. + /// + /// The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields + /// and the aggregation to reduce the data. + /// /// public PutTransformRequestDescriptor Pivot(Elastic.Clients.Elasticsearch.TransformManagement.Pivot? pivot) { @@ -302,7 +403,10 @@ public PutTransformRequestDescriptor Pivot(Action - /// Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the
destination index. + /// + /// Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the + /// destination index. + /// /// public PutTransformRequestDescriptor RetentionPolicy(Elastic.Clients.Elasticsearch.TransformManagement.RetentionPolicy? retentionPolicy) { @@ -329,7 +433,9 @@ public PutTransformRequestDescriptor RetentionPolicy(Action - /// Defines optional transform settings. + /// + /// Defines optional transform settings. + /// /// public PutTransformRequestDescriptor Settings(Elastic.Clients.Elasticsearch.TransformManagement.Settings? settings) { @@ -356,7 +462,9 @@ public PutTransformRequestDescriptor Settings(Action - /// The source of the data for the transform. + /// + /// The source of the data for the transform. + /// /// public PutTransformRequestDescriptor Source(Elastic.Clients.Elasticsearch.TransformManagement.Source source) { @@ -383,7 +491,9 @@ public PutTransformRequestDescriptor Source(Action - /// Defines the properties transforms require to run continuously. + /// + /// Defines the properties transforms require to run continuously. + /// /// public PutTransformRequestDescriptor Sync(Elastic.Clients.Elasticsearch.TransformManagement.Sync? sync) { @@ -547,11 +657,34 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Create a transform.
Creates a transform. -/// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as
a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
unique row per entity. -/// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If
you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in
the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values
in the latest object. -/// You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and
`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the
transform remembers which roles the user that created it had at the time of creation and uses those same roles. If
those roles do not have the required privileges on the source and destination indices, the transform fails when it
attempts unauthorized operations. -/// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any
`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not
give users any privileges on `.data-frame-internal*` indices. +/// +/// Create a transform. +/// Creates a transform. +/// +/// +/// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as +/// a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a +/// unique row per entity. +/// +/// +/// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If +/// you choose to use the pivot method for your transform, the entities are defined by the set of group_by fields in +/// the pivot object. If you choose to use the latest method, the entities are defined by the unique_key field values +/// in the latest object. +/// +/// +/// You must have create_index, index, and read privileges on the destination index and read and +/// view_index_metadata privileges on the source indices. When Elasticsearch security features are enabled, the +/// transform remembers which roles the user that created it had at the time of creation and uses those same roles. If +/// those roles do not have the required privileges on the source and destination indices, the transform fails when it +/// attempts unauthorized operations. +/// +/// +/// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any +/// .transform-internal* indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do +/// not give users any privileges on .transform-internal* indices. If you used transforms prior to 7.5, also do not +/// give users any privileges on .data-frame-internal* indices. +/// /// public sealed partial class PutTransformRequestDescriptor : RequestDescriptor { @@ -604,7 +737,9 @@ public PutTransformRequestDescriptor TransformId(Elastic.Clients.Elasticsearch.I private Action SyncDescriptorAction { get; set; } /// - /// Free text description of the transform. + /// + /// Free text description of the transform. + /// /// public PutTransformRequestDescriptor Description(string? description) { @@ -613,7 +748,9 @@ public PutTransformRequestDescriptor Description(string? description) } /// - /// The destination for the transform. + /// + /// The destination for the transform. + /// /// public PutTransformRequestDescriptor Dest(Elastic.Clients.Elasticsearch.TransformManagement.Destination dest) { @@ -640,7 +777,11 @@ public PutTransformRequestDescriptor Dest(Action - /// The interval between checks for changes in the source indices when the transform is running continuously. Also
determines the retry interval in the event of transient failures while the transform is searching or indexing.
The minimum value is `1s` and the maximum is `1h`. + /// + /// The interval between checks for changes in the source indices when the transform is running continuously. Also + /// determines the retry interval in the event of transient failures while the transform is searching or indexing. + /// The minimum value is 1s and the maximum is 1h. + /// /// public PutTransformRequestDescriptor Frequency(Elastic.Clients.Elasticsearch.Duration? frequency) { @@ -649,7 +790,9 @@ public PutTransformRequestDescriptor Frequency(Elastic.Clients.Elasticsearch.Dur } /// - /// The latest method transforms the data by finding the latest document for each unique key. + /// + /// The latest method transforms the data by finding the latest document for each unique key. + /// /// public PutTransformRequestDescriptor Latest(Elastic.Clients.Elasticsearch.TransformManagement.Latest? latest) { @@ -676,7 +819,9 @@ public PutTransformRequestDescriptor Latest(Action - /// Defines optional transform metadata. + /// + /// Defines optional transform metadata. + /// /// public PutTransformRequestDescriptor Meta(Func, FluentDictionary> selector) { @@ -685,7 +830,10 @@ public PutTransformRequestDescriptor Meta(Func, } /// - /// The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields
and the aggregation to reduce the data. + /// + /// The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields + /// and the aggregation to reduce the data. + /// /// public PutTransformRequestDescriptor Pivot(Elastic.Clients.Elasticsearch.TransformManagement.Pivot? pivot) { @@ -712,7 +860,10 @@ public PutTransformRequestDescriptor Pivot(Action - /// Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the
destination index. + /// + /// Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the + /// destination index. + /// /// public PutTransformRequestDescriptor RetentionPolicy(Elastic.Clients.Elasticsearch.TransformManagement.RetentionPolicy? retentionPolicy) { @@ -739,7 +890,9 @@ public PutTransformRequestDescriptor RetentionPolicy(Action - /// Defines optional transform settings. + /// + /// Defines optional transform settings. + /// /// public PutTransformRequestDescriptor Settings(Elastic.Clients.Elasticsearch.TransformManagement.Settings? settings) { @@ -766,7 +919,9 @@ public PutTransformRequestDescriptor Settings(Action - /// The source of the data for the transform. + /// + /// The source of the data for the transform. + /// /// public PutTransformRequestDescriptor Source(Elastic.Clients.Elasticsearch.TransformManagement.Source source) { @@ -793,7 +948,9 @@ public PutTransformRequestDescriptor Source(Action - /// Defines the properties transforms require to run continuously. + /// + /// Defines the properties transforms require to run continuously. + /// /// public PutTransformRequestDescriptor Sync(Elastic.Clients.Elasticsearch.TransformManagement.Sync? sync) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/PutTransformResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/PutTransformResponse.g.cs index c14b5e365a2..10f7f7ec4f7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/PutTransformResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/PutTransformResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.TransformManagement; public sealed partial class PutTransformResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/ResetTransformRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/ResetTransformRequest.g.cs index 2c2cf47ad5f..1167b2393b5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/ResetTransformRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/ResetTransformRequest.g.cs @@ -32,13 +32,21 @@ namespace Elastic.Clients.Elasticsearch.TransformManagement; public sealed partial class ResetTransformRequestParameters : RequestParameters { /// - /// If this value is `true`, the transform is reset regardless of its current state. If it's `false`, the transform
must be stopped before it can be reset. + /// + /// If this value is true, the transform is reset regardless of its current state. If it's false, the transform + /// must be stopped before it can be reset. + /// /// public bool? Force { get => Q("force"); set => Q("force", value); } } /// -/// Reset a transform.
Resets a transform.
Before you can reset it, you must stop it; alternatively, use the `force` query parameter.
If the destination index was created by the transform, it is deleted. +/// +/// Reset a transform. +/// Resets a transform. +/// Before you can reset it, you must stop it; alternatively, use the force query parameter. +/// If the destination index was created by the transform, it is deleted. +/// /// public sealed partial class ResetTransformRequest : PlainRequest { @@ -55,14 +63,22 @@ public ResetTransformRequest(Elastic.Clients.Elasticsearch.Id transformId) : bas internal override string OperationName => "transform.reset_transform"; /// - /// If this value is `true`, the transform is reset regardless of its current state. If it's `false`, the transform
must be stopped before it can be reset. + /// + /// If this value is true, the transform is reset regardless of its current state. If it's false, the transform + /// must be stopped before it can be reset. + /// /// [JsonIgnore] public bool? Force { get => Q("force"); set => Q("force", value); } } /// -/// Reset a transform.
Resets a transform.
Before you can reset it, you must stop it; alternatively, use the `force` query parameter.
If the destination index was created by the transform, it is deleted. +/// +/// Reset a transform. +/// Resets a transform. +/// Before you can reset it, you must stop it; alternatively, use the force query parameter. +/// If the destination index was created by the transform, it is deleted. +/// /// public sealed partial class ResetTransformRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/ResetTransformResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/ResetTransformResponse.g.cs index 4d3024e377a..fa10ee989c7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/ResetTransformResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/ResetTransformResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.TransformManagement; public sealed partial class ResetTransformResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/ScheduleNowTransformRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/ScheduleNowTransformRequest.g.cs index 2ab78e08502..2c98a5a62b8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/ScheduleNowTransformRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/ScheduleNowTransformRequest.g.cs @@ -32,14 +32,24 @@ namespace Elastic.Clients.Elasticsearch.TransformManagement; public sealed partial class ScheduleNowTransformRequestParameters : RequestParameters { /// - /// Controls the time to wait for the scheduling to take place + /// + /// Controls the time to wait for the scheduling to take place + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Schedule a transform to start now.
Instantly runs a transform to process data. -/// If you _schedule_now a transform, it will process the new data instantly,
without waiting for the configured frequency interval. After _schedule_now API is called,
the transform will be processed again at now + frequency unless _schedule_now API
is called again in the meantime. +/// +/// Schedule a transform to start now. +/// Instantly runs a transform to process data. +/// +/// +/// If you _schedule_now a transform, it will process the new data instantly, +/// without waiting for the configured frequency interval. After _schedule_now API is called, +/// the transform will be processed again at now + frequency unless _schedule_now API +/// is called again in the meantime. +/// /// public sealed partial class ScheduleNowTransformRequest : PlainRequest { @@ -56,15 +66,25 @@ public ScheduleNowTransformRequest(Elastic.Clients.Elasticsearch.Id transformId) internal override string OperationName => "transform.schedule_now_transform"; /// - /// Controls the time to wait for the scheduling to take place + /// + /// Controls the time to wait for the scheduling to take place + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Schedule a transform to start now.
Instantly runs a transform to process data. -/// If you _schedule_now a transform, it will process the new data instantly,
without waiting for the configured frequency interval. After _schedule_now API is called,
the transform will be processed again at now + frequency unless _schedule_now API
is called again in the meantime. +/// +/// Schedule a transform to start now. +/// Instantly runs a transform to process data. +/// +/// +/// If you _schedule_now a transform, it will process the new data instantly, +/// without waiting for the configured frequency interval. After _schedule_now API is called, +/// the transform will be processed again at now + frequency unless _schedule_now API +/// is called again in the meantime. +/// /// public sealed partial class ScheduleNowTransformRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/ScheduleNowTransformResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/ScheduleNowTransformResponse.g.cs index 60eaffa0acb..93f527a6b0c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/ScheduleNowTransformResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/ScheduleNowTransformResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.TransformManagement; public sealed partial class ScheduleNowTransformResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/StartTransformRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/StartTransformRequest.g.cs index 3632edab3ac..f918131e06f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/StartTransformRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/StartTransformRequest.g.cs @@ -32,20 +32,42 @@ namespace Elastic.Clients.Elasticsearch.TransformManagement; public sealed partial class StartTransformRequestParameters : RequestParameters { /// - /// Restricts the set of transformed entities to those changed after this time. Relative times like now-30d are supported. Only applicable for continuous transforms. + /// + /// Restricts the set of transformed entities to those changed after this time. Relative times like now-30d are supported. Only applicable for continuous transforms. + /// /// public string? From { get => Q("from"); set => Q("from", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Start a transform.
Starts a transform. -/// When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is
set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping
definitions for the destination index from the source indices and the transform aggregations. If fields in the
destination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),
the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce
mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you
start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings
in a pivot transform. -/// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you
created the transform, they occur when you start the transform—​with the exception of privilege checks. When
Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the
time of creation and uses those same roles. If those roles do not have the required privileges on the source and
destination indices, the transform fails when it attempts unauthorized operations. +/// +/// Start a transform. +/// Starts a transform. +/// +/// +/// When you start a transform, it creates the destination index if it does not already exist. The number_of_shards is +/// set to 1 and the auto_expand_replicas is set to 0-1. If it is a pivot transform, it deduces the mapping +/// definitions for the destination index from the source indices and the transform aggregations. If fields in the +/// destination index are derived from scripts (as in the case of scripted_metric or bucket_script aggregations), +/// the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce +/// mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you +/// start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings +/// in a pivot transform. +/// +/// +/// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you +/// created the transform, they occur when you start the transform—​with the exception of privilege checks. When +/// Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the +/// time of creation and uses those same roles. If those roles do not have the required privileges on the source and +/// destination indices, the transform fails when it attempts unauthorized operations. +/// /// public sealed partial class StartTransformRequest : PlainRequest { @@ -62,22 +84,44 @@ public StartTransformRequest(Elastic.Clients.Elasticsearch.Id transformId) : bas internal override string OperationName => "transform.start_transform"; /// - /// Restricts the set of transformed entities to those changed after this time. Relative times like now-30d are supported. Only applicable for continuous transforms. + /// + /// Restricts the set of transformed entities to those changed after this time. Relative times like now-30d are supported. Only applicable for continuous transforms. + /// /// [JsonIgnore] public string? From { get => Q("from"); set => Q("from", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Start a transform.
Starts a transform. -/// When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is
set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping
definitions for the destination index from the source indices and the transform aggregations. If fields in the
destination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),
the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce
mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you
start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings
in a pivot transform. -/// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you
created the transform, they occur when you start the transform—​with the exception of privilege checks. When
Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the
time of creation and uses those same roles. If those roles do not have the required privileges on the source and
destination indices, the transform fails when it attempts unauthorized operations. +/// +/// Start a transform. +/// Starts a transform. +/// +/// +/// When you start a transform, it creates the destination index if it does not already exist. The number_of_shards is +/// set to 1 and the auto_expand_replicas is set to 0-1. If it is a pivot transform, it deduces the mapping +/// definitions for the destination index from the source indices and the transform aggregations. If fields in the +/// destination index are derived from scripts (as in the case of scripted_metric or bucket_script aggregations), +/// the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce +/// mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you +/// start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings +/// in a pivot transform. +/// +/// +/// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you +/// created the transform, they occur when you start the transform—​with the exception of privilege checks. When +/// Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the +/// time of creation and uses those same roles. If those roles do not have the required privileges on the source and +/// destination indices, the transform fails when it attempts unauthorized operations. +/// /// public sealed partial class StartTransformRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/StartTransformResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/StartTransformResponse.g.cs index 207d6084148..04f75c1be41 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/StartTransformResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/StartTransformResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.TransformManagement; public sealed partial class StartTransformResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/StopTransformRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/StopTransformRequest.g.cs index bac535541e8..f07921f11be 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/StopTransformRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/StopTransformRequest.g.cs @@ -32,35 +32,59 @@ namespace Elastic.Clients.Elasticsearch.TransformManagement; public sealed partial class StopTransformRequestParameters : RequestParameters { /// - /// Specifies what to do when the request: contains wildcard expressions and there are no transforms that match;
contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there
are only partial matches. - /// If it is true, the API returns a successful acknowledgement message when there are no matches. When there are
only partial matches, the API stops the appropriate transforms. - /// If it is false, the request returns a 404 status code when there are no matches or only partial matches. + /// + /// Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; + /// contains the _all string or no identifiers and there are no matches; contains wildcard expressions and there + /// are only partial matches. + /// + /// + /// If it is true, the API returns a successful acknowledgement message when there are no matches. When there are + /// only partial matches, the API stops the appropriate transforms. + /// + /// + /// If it is false, the request returns a 404 status code when there are no matches or only partial matches. + /// /// public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// If it is true, the API forcefully stops the transforms. + /// + /// If it is true, the API forcefully stops the transforms. + /// /// public bool? Force { get => Q("force"); set => Q("force", value); } /// - /// Period to wait for a response when `wait_for_completion` is `true`. If no response is received before the
timeout expires, the request returns a timeout exception. However, the request continues processing and
eventually moves the transform to a STOPPED state. + /// + /// Period to wait for a response when wait_for_completion is true. If no response is received before the + /// timeout expires, the request returns a timeout exception. However, the request continues processing and + /// eventually moves the transform to a STOPPED state. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// If it is true, the transform does not completely stop until the current checkpoint is completed. If it is false,
the transform stops as soon as possible. + /// + /// If it is true, the transform does not completely stop until the current checkpoint is completed. If it is false, + /// the transform stops as soon as possible. + /// /// public bool? WaitForCheckpoint { get => Q("wait_for_checkpoint"); set => Q("wait_for_checkpoint", value); } /// - /// If it is true, the API blocks until the indexer state completely stops. If it is false, the API returns
immediately and the indexer is stopped asynchronously in the background. + /// + /// If it is true, the API blocks until the indexer state completely stops. If it is false, the API returns + /// immediately and the indexer is stopped asynchronously in the background. + /// /// public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Stop transforms.
Stops one or more transforms. +/// +/// Stop transforms. +/// Stops one or more transforms. +/// /// public sealed partial class StopTransformRequest : PlainRequest { @@ -77,40 +101,64 @@ public StopTransformRequest(Elastic.Clients.Elasticsearch.Name transformId) : ba internal override string OperationName => "transform.stop_transform"; /// - /// Specifies what to do when the request: contains wildcard expressions and there are no transforms that match;
contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there
are only partial matches. - /// If it is true, the API returns a successful acknowledgement message when there are no matches. When there are
only partial matches, the API stops the appropriate transforms. - /// If it is false, the request returns a 404 status code when there are no matches or only partial matches. + /// + /// Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; + /// contains the _all string or no identifiers and there are no matches; contains wildcard expressions and there + /// are only partial matches. + /// + /// + /// If it is true, the API returns a successful acknowledgement message when there are no matches. When there are + /// only partial matches, the API stops the appropriate transforms. + /// + /// + /// If it is false, the request returns a 404 status code when there are no matches or only partial matches. + /// /// [JsonIgnore] public bool? AllowNoMatch { get => Q("allow_no_match"); set => Q("allow_no_match", value); } /// - /// If it is true, the API forcefully stops the transforms. + /// + /// If it is true, the API forcefully stops the transforms. + /// /// [JsonIgnore] public bool? Force { get => Q("force"); set => Q("force", value); } /// - /// Period to wait for a response when `wait_for_completion` is `true`. If no response is received before the
timeout expires, the request returns a timeout exception. However, the request continues processing and
eventually moves the transform to a STOPPED state. + /// + /// Period to wait for a response when wait_for_completion is true. If no response is received before the + /// timeout expires, the request returns a timeout exception. However, the request continues processing and + /// eventually moves the transform to a STOPPED state. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// If it is true, the transform does not completely stop until the current checkpoint is completed. If it is false,
the transform stops as soon as possible. + /// + /// If it is true, the transform does not completely stop until the current checkpoint is completed. If it is false, + /// the transform stops as soon as possible. + /// /// [JsonIgnore] public bool? WaitForCheckpoint { get => Q("wait_for_checkpoint"); set => Q("wait_for_checkpoint", value); } /// - /// If it is true, the API blocks until the indexer state completely stops. If it is false, the API returns
immediately and the indexer is stopped asynchronously in the background. + /// + /// If it is true, the API blocks until the indexer state completely stops. If it is false, the API returns + /// immediately and the indexer is stopped asynchronously in the background. + /// /// [JsonIgnore] public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// Stop transforms.
Stops one or more transforms. +/// +/// Stop transforms. +/// Stops one or more transforms. +/// /// public sealed partial class StopTransformRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/StopTransformResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/StopTransformResponse.g.cs index 9bfe1cbfb90..05fbc4e6609 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/StopTransformResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/StopTransformResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.TransformManagement; public sealed partial class StopTransformResponse : ElasticsearchResponse { /// - /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// /// [JsonInclude, JsonPropertyName("acknowledged")] public bool Acknowledged { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/UpdateTransformRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/UpdateTransformRequest.g.cs index 4145b40b652..ca1dfce0368 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/UpdateTransformRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/UpdateTransformRequest.g.cs @@ -32,19 +32,35 @@ namespace Elastic.Clients.Elasticsearch.TransformManagement; public sealed partial class UpdateTransformRequestParameters : RequestParameters { /// - /// When true, deferrable validations are not run. This behavior may be
desired if the source index does not exist until after the transform is
created. + /// + /// When true, deferrable validations are not run. This behavior may be + /// desired if the source index does not exist until after the transform is + /// created. + /// /// public bool? DeferValidation { get => Q("defer_validation"); set => Q("defer_validation", value); } /// - /// Period to wait for a response. If no response is received before the
timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the + /// timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Update a transform.
Updates certain properties of a transform. -/// All updated properties except `description` do not take effect until after the transform starts the next checkpoint,
thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`
privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When
Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the
time of update and runs with those privileges. +/// +/// Update a transform. +/// Updates certain properties of a transform. +/// +/// +/// All updated properties except description do not take effect until after the transform starts the next checkpoint, +/// thus there is data consistency in each checkpoint. To use this API, you must have read and view_index_metadata +/// privileges for the source indices. You must also have index and read privileges for the destination index. When +/// Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the +/// time of update and runs with those privileges. +/// /// public sealed partial class UpdateTransformRequest : PlainRequest { @@ -61,69 +77,105 @@ public UpdateTransformRequest(Elastic.Clients.Elasticsearch.Id transformId) : ba internal override string OperationName => "transform.update_transform"; /// - /// When true, deferrable validations are not run. This behavior may be
desired if the source index does not exist until after the transform is
created. + /// + /// When true, deferrable validations are not run. This behavior may be + /// desired if the source index does not exist until after the transform is + /// created. + /// /// [JsonIgnore] public bool? DeferValidation { get => Q("defer_validation"); set => Q("defer_validation", value); } /// - /// Period to wait for a response. If no response is received before the
timeout expires, the request fails and returns an error. + /// + /// Period to wait for a response. If no response is received before the + /// timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Free text description of the transform. + /// + /// Free text description of the transform. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The destination for the transform. + /// + /// The destination for the transform. + /// /// [JsonInclude, JsonPropertyName("dest")] public Elastic.Clients.Elasticsearch.TransformManagement.Destination? Dest { get; set; } /// - /// The interval between checks for changes in the source indices when the
transform is running continuously. Also determines the retry interval in
the event of transient failures while the transform is searching or
indexing. The minimum value is 1s and the maximum is 1h. + /// + /// The interval between checks for changes in the source indices when the + /// transform is running continuously. Also determines the retry interval in + /// the event of transient failures while the transform is searching or + /// indexing. The minimum value is 1s and the maximum is 1h. + /// /// [JsonInclude, JsonPropertyName("frequency")] public Elastic.Clients.Elasticsearch.Duration? Frequency { get; set; } /// - /// Defines optional transform metadata. + /// + /// Defines optional transform metadata. + /// /// [JsonInclude, JsonPropertyName("_meta")] public IDictionary? Meta { get; set; } /// - /// Defines a retention policy for the transform. Data that meets the defined
criteria is deleted from the destination index. + /// + /// Defines a retention policy for the transform. Data that meets the defined + /// criteria is deleted from the destination index. + /// /// [JsonInclude, JsonPropertyName("retention_policy")] public Elastic.Clients.Elasticsearch.TransformManagement.RetentionPolicy? RetentionPolicy { get; set; } /// - /// Defines optional transform settings. + /// + /// Defines optional transform settings. + /// /// [JsonInclude, JsonPropertyName("settings")] public Elastic.Clients.Elasticsearch.TransformManagement.Settings? Settings { get; set; } /// - /// The source of the data for the transform. + /// + /// The source of the data for the transform. + /// /// [JsonInclude, JsonPropertyName("source")] public Elastic.Clients.Elasticsearch.TransformManagement.Source? Source { get; set; } /// - /// Defines the properties transforms require to run continuously. + /// + /// Defines the properties transforms require to run continuously. + /// /// [JsonInclude, JsonPropertyName("sync")] public Elastic.Clients.Elasticsearch.TransformManagement.Sync? Sync { get; set; } } /// -/// Update a transform.
Updates certain properties of a transform. -/// All updated properties except `description` do not take effect until after the transform starts the next checkpoint,
thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`
privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When
Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the
time of update and runs with those privileges. +/// +/// Update a transform. +/// Updates certain properties of a transform. +/// +/// +/// All updated properties except description do not take effect until after the transform starts the next checkpoint, +/// thus there is data consistency in each checkpoint. To use this API, you must have read and view_index_metadata +/// privileges for the source indices. You must also have index and read privileges for the destination index. When +/// Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the +/// time of update and runs with those privileges. +/// /// public sealed partial class UpdateTransformRequestDescriptor : RequestDescriptor, UpdateTransformRequestParameters> { @@ -170,7 +222,9 @@ public UpdateTransformRequestDescriptor TransformId(Elastic.Clients.E private Action> SyncDescriptorAction { get; set; } /// - /// Free text description of the transform. + /// + /// Free text description of the transform. + /// /// public UpdateTransformRequestDescriptor Description(string? description) { @@ -179,7 +233,9 @@ public UpdateTransformRequestDescriptor Description(string? descripti } /// - /// The destination for the transform. + /// + /// The destination for the transform. + /// /// public UpdateTransformRequestDescriptor Dest(Elastic.Clients.Elasticsearch.TransformManagement.Destination? dest) { @@ -206,7 +262,12 @@ public UpdateTransformRequestDescriptor Dest(Action - /// The interval between checks for changes in the source indices when the
transform is running continuously. Also determines the retry interval in
the event of transient failures while the transform is searching or
indexing. The minimum value is 1s and the maximum is 1h. + /// + /// The interval between checks for changes in the source indices when the + /// transform is running continuously. Also determines the retry interval in + /// the event of transient failures while the transform is searching or + /// indexing. The minimum value is 1s and the maximum is 1h. + /// /// public UpdateTransformRequestDescriptor Frequency(Elastic.Clients.Elasticsearch.Duration? frequency) { @@ -215,7 +276,9 @@ public UpdateTransformRequestDescriptor Frequency(Elastic.Clients.Ela } /// - /// Defines optional transform metadata. + /// + /// Defines optional transform metadata. + /// /// public UpdateTransformRequestDescriptor Meta(Func, FluentDictionary> selector) { @@ -224,7 +287,10 @@ public UpdateTransformRequestDescriptor Meta(Func - /// Defines a retention policy for the transform. Data that meets the defined
criteria is deleted from the destination index. + /// + /// Defines a retention policy for the transform. Data that meets the defined + /// criteria is deleted from the destination index. + /// /// public UpdateTransformRequestDescriptor RetentionPolicy(Elastic.Clients.Elasticsearch.TransformManagement.RetentionPolicy? retentionPolicy) { @@ -251,7 +317,9 @@ public UpdateTransformRequestDescriptor RetentionPolicy(Action - /// Defines optional transform settings. + /// + /// Defines optional transform settings. + /// /// public UpdateTransformRequestDescriptor Settings(Elastic.Clients.Elasticsearch.TransformManagement.Settings? settings) { @@ -278,7 +346,9 @@ public UpdateTransformRequestDescriptor Settings(Action - /// The source of the data for the transform. + /// + /// The source of the data for the transform. + /// /// public UpdateTransformRequestDescriptor Source(Elastic.Clients.Elasticsearch.TransformManagement.Source? source) { @@ -305,7 +375,9 @@ public UpdateTransformRequestDescriptor Source(Action - /// Defines the properties transforms require to run continuously. + /// + /// Defines the properties transforms require to run continuously. + /// /// public UpdateTransformRequestDescriptor Sync(Elastic.Clients.Elasticsearch.TransformManagement.Sync? sync) { @@ -437,8 +509,17 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Update a transform.
Updates certain properties of a transform. -/// All updated properties except `description` do not take effect until after the transform starts the next checkpoint,
thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`
privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When
Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the
time of update and runs with those privileges. +/// +/// Update a transform. +/// Updates certain properties of a transform. +/// +/// +/// All updated properties except description do not take effect until after the transform starts the next checkpoint, +/// thus there is data consistency in each checkpoint. To use this API, you must have read and view_index_metadata +/// privileges for the source indices. You must also have index and read privileges for the destination index. When +/// Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the +/// time of update and runs with those privileges. +/// /// public sealed partial class UpdateTransformRequestDescriptor : RequestDescriptor { @@ -485,7 +566,9 @@ public UpdateTransformRequestDescriptor TransformId(Elastic.Clients.Elasticsearc private Action SyncDescriptorAction { get; set; } /// - /// Free text description of the transform. + /// + /// Free text description of the transform. + /// /// public UpdateTransformRequestDescriptor Description(string? description) { @@ -494,7 +577,9 @@ public UpdateTransformRequestDescriptor Description(string? description) } /// - /// The destination for the transform. + /// + /// The destination for the transform. + /// /// public UpdateTransformRequestDescriptor Dest(Elastic.Clients.Elasticsearch.TransformManagement.Destination? dest) { @@ -521,7 +606,12 @@ public UpdateTransformRequestDescriptor Dest(Action - /// The interval between checks for changes in the source indices when the
transform is running continuously. Also determines the retry interval in
the event of transient failures while the transform is searching or
indexing. The minimum value is 1s and the maximum is 1h. + /// + /// The interval between checks for changes in the source indices when the + /// transform is running continuously. Also determines the retry interval in + /// the event of transient failures while the transform is searching or + /// indexing. The minimum value is 1s and the maximum is 1h. + /// /// public UpdateTransformRequestDescriptor Frequency(Elastic.Clients.Elasticsearch.Duration? frequency) { @@ -530,7 +620,9 @@ public UpdateTransformRequestDescriptor Frequency(Elastic.Clients.Elasticsearch. } /// - /// Defines optional transform metadata. + /// + /// Defines optional transform metadata. + /// /// public UpdateTransformRequestDescriptor Meta(Func, FluentDictionary> selector) { @@ -539,7 +631,10 @@ public UpdateTransformRequestDescriptor Meta(Func - /// Defines a retention policy for the transform. Data that meets the defined
criteria is deleted from the destination index. + /// + /// Defines a retention policy for the transform. Data that meets the defined + /// criteria is deleted from the destination index. + /// /// public UpdateTransformRequestDescriptor RetentionPolicy(Elastic.Clients.Elasticsearch.TransformManagement.RetentionPolicy? retentionPolicy) { @@ -566,7 +661,9 @@ public UpdateTransformRequestDescriptor RetentionPolicy(Action - /// Defines optional transform settings. + /// + /// Defines optional transform settings. + /// /// public UpdateTransformRequestDescriptor Settings(Elastic.Clients.Elasticsearch.TransformManagement.Settings? settings) { @@ -593,7 +690,9 @@ public UpdateTransformRequestDescriptor Settings(Action - /// The source of the data for the transform. + /// + /// The source of the data for the transform. + /// /// public UpdateTransformRequestDescriptor Source(Elastic.Clients.Elasticsearch.TransformManagement.Source? source) { @@ -620,7 +719,9 @@ public UpdateTransformRequestDescriptor Source(Action - /// Defines the properties transforms require to run continuously. + /// + /// Defines the properties transforms require to run continuously. + /// /// public UpdateTransformRequestDescriptor Sync(Elastic.Clients.Elasticsearch.TransformManagement.Sync? sync) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/UpgradeTransformsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/UpgradeTransformsRequest.g.cs index fa141d83fd9..0a5ee29800c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/UpgradeTransformsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/UpgradeTransformsRequest.g.cs @@ -32,18 +32,30 @@ namespace Elastic.Clients.Elasticsearch.TransformManagement; public sealed partial class UpgradeTransformsRequestParameters : RequestParameters { /// - /// When true, the request checks for updates but does not run them. + /// + /// When true, the request checks for updates but does not run them. + /// /// public bool? DryRun { get => Q("dry_run"); set => Q("dry_run", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and
returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and + /// returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Upgrades all transforms.
This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It
also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not
affect the source and destination indices. The upgrade also does not affect the roles that transforms use when
Elasticsearch security features are enabled; the role used to read source data and write to the destination index
remains unchanged. +/// +/// Upgrades all transforms. +/// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It +/// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not +/// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when +/// Elasticsearch security features are enabled; the role used to read source data and write to the destination index +/// remains unchanged. +/// /// public sealed partial class UpgradeTransformsRequest : PlainRequest { @@ -56,20 +68,32 @@ public sealed partial class UpgradeTransformsRequest : PlainRequest "transform.upgrade_transforms"; /// - /// When true, the request checks for updates but does not run them. + /// + /// When true, the request checks for updates but does not run them. + /// /// [JsonIgnore] public bool? DryRun { get => Q("dry_run"); set => Q("dry_run", value); } /// - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and
returns an error. + /// + /// Period to wait for a response. If no response is received before the timeout expires, the request fails and + /// returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Upgrades all transforms.
This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It
also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not
affect the source and destination indices. The upgrade also does not affect the roles that transforms use when
Elasticsearch security features are enabled; the role used to read source data and write to the destination index
remains unchanged. +/// +/// Upgrades all transforms. +/// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It +/// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not +/// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when +/// Elasticsearch security features are enabled; the role used to read source data and write to the destination index +/// remains unchanged. +/// /// public sealed partial class UpgradeTransformsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/UpgradeTransformsResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/UpgradeTransformsResponse.g.cs index 3e4d9644b00..d2e39135530 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/UpgradeTransformsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/UpgradeTransformsResponse.g.cs @@ -29,19 +29,25 @@ namespace Elastic.Clients.Elasticsearch.TransformManagement; public sealed partial class UpgradeTransformsResponse : ElasticsearchResponse { /// - /// The number of transforms that need to be upgraded. + /// + /// The number of transforms that need to be upgraded. + /// /// [JsonInclude, JsonPropertyName("needs_update")] public int NeedsUpdate { get; init; } /// - /// The number of transforms that don’t require upgrading. + /// + /// The number of transforms that don’t require upgrading. + /// /// [JsonInclude, JsonPropertyName("no_action")] public int NoAction { get; init; } /// - /// The number of transforms that have been upgraded. + /// + /// The number of transforms that have been upgraded. + /// /// [JsonInclude, JsonPropertyName("updated")] public int Updated { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/UpdateByQueryRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/UpdateByQueryRequest.g.cs index 325929f35f6..05010dd573b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/UpdateByQueryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/UpdateByQueryRequest.g.cs @@ -32,148 +32,223 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class UpdateByQueryRequestParameters : RequestParameters { /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices.
For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Analyzer to use for the query string. + /// + /// Analyzer to use for the query string. + /// /// public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// - /// If `true`, wildcard and prefix queries are analyzed. + /// + /// If true, wildcard and prefix queries are analyzed. + /// /// public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } /// - /// The default operator for query string query: `AND` or `OR`. + /// + /// The default operator for query string query: AND or OR. + /// /// public Elastic.Clients.Elasticsearch.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } /// - /// Field to use as default where no field prefix is given in the query string. + /// + /// Field to use as default where no field prefix is given in the query string. + /// /// public string? Df { get => Q("df"); set => Q("df", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Starting offset (default: 0) + /// + /// Starting offset (default: 0) + /// /// public long? From { get => Q("from"); set => Q("from", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// + /// If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// /// public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// - /// ID of the pipeline to use to preprocess incoming documents.
If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.
If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// + /// ID of the pipeline to use to preprocess incoming documents. + /// If the index has a default ingest pipeline specified, then setting the value to _none disables the default ingest pipeline for this request. + /// If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// /// public string? Pipeline { get => Q("pipeline"); set => Q("pipeline", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If `true`, Elasticsearch refreshes affected shards to make the operation visible to search. + /// + /// If true, Elasticsearch refreshes affected shards to make the operation visible to search. + /// /// public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// If `true`, the request cache is used for this request. + /// + /// If true, the request cache is used for this request. + /// /// public bool? RequestCache { get => Q("request_cache"); set => Q("request_cache", value); } /// - /// The throttle for this request in sub-requests per second. + /// + /// The throttle for this request in sub-requests per second. + /// /// public float? RequestsPerSecond { get => Q("requests_per_second"); set => Q("requests_per_second", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Period to retain the search context for scrolling. + /// + /// Period to retain the search context for scrolling. + /// /// public Elastic.Clients.Elasticsearch.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); } /// - /// Size of the scroll request that powers the operation. + /// + /// Size of the scroll request that powers the operation. + /// /// public long? ScrollSize { get => Q("scroll_size"); set => Q("scroll_size", value); } /// - /// Explicit timeout for each search request. + /// + /// Explicit timeout for each search request. + /// /// public Elastic.Clients.Elasticsearch.Duration? SearchTimeout { get => Q("search_timeout"); set => Q("search_timeout", value); } /// - /// The type of the search operation. Available options: `query_then_fetch`, `dfs_query_then_fetch`. + /// + /// The type of the search operation. Available options: query_then_fetch, dfs_query_then_fetch. + /// /// public Elastic.Clients.Elasticsearch.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } /// - /// The number of slices this task should be divided into. + /// + /// The number of slices this task should be divided into. + /// /// public Elastic.Clients.Elasticsearch.Slices? Slices { get => Q("slices"); set => Q("slices", value); } /// - /// A comma-separated list of : pairs. + /// + /// A comma-separated list of <field>:<direction> pairs. + /// /// public ICollection? Sort { get => Q?>("sort"); set => Q("sort", value); } /// - /// Specific `tag` of the request for logging and statistical purposes. + /// + /// Specific tag of the request for logging and statistical purposes. + /// /// public ICollection? Stats { get => Q?>("stats"); set => Q("stats", value); } /// - /// Maximum number of documents to collect for each shard.
If a query reaches this limit, Elasticsearch terminates the query early.
Elasticsearch collects documents before sorting.
Use with caution.
Elasticsearch applies this parameter to each shard handling the request.
When possible, let Elasticsearch perform early termination automatically.
Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + /// + /// Maximum number of documents to collect for each shard. + /// If a query reaches this limit, Elasticsearch terminates the query early. + /// Elasticsearch collects documents before sorting. + /// Use with caution. + /// Elasticsearch applies this parameter to each shard handling the request. + /// When possible, let Elasticsearch perform early termination automatically. + /// Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + /// /// public long? TerminateAfter { get => Q("terminate_after"); set => Q("terminate_after", value); } /// - /// Period each update request waits for the following operations: dynamic mapping updates, waiting for active shards. + /// + /// Period each update request waits for the following operations: dynamic mapping updates, waiting for active shards. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// If `true`, returns the document version as part of a hit. + /// + /// If true, returns the document version as part of a hit. + /// /// public bool? Version { get => Q("version"); set => Q("version", value); } /// - /// Should the document increment the version number (internal) on hit or not (reindex) + /// + /// Should the document increment the version number (internal) on hit or not (reindex) + /// /// public bool? VersionType { get => Q("version_type"); set => Q("version_type", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } /// - /// If `true`, the request blocks until the operation is complete. + /// + /// If true, the request blocks until the operation is complete. + /// /// public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } /// -/// 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. +/// /// public sealed partial class UpdateByQueryRequest : PlainRequest { @@ -190,206 +265,291 @@ public UpdateByQueryRequest(Elastic.Clients.Elasticsearch.Indices indices) : bas internal override string OperationName => "update_by_query"; /// - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices.
For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. + /// This behavior applies even if the request targets other open indices. + /// For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Analyzer to use for the query string. + /// + /// Analyzer to use for the query string. + /// /// [JsonIgnore] public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// - /// If `true`, wildcard and prefix queries are analyzed. + /// + /// If true, wildcard and prefix queries are analyzed. + /// /// [JsonIgnore] public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } /// - /// The default operator for query string query: `AND` or `OR`. + /// + /// The default operator for query string query: AND or OR. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } /// - /// Field to use as default where no field prefix is given in the query string. + /// + /// Field to use as default where no field prefix is given in the query string. + /// /// [JsonIgnore] public string? Df { get => Q("df"); set => Q("df", value); } /// - /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + /// + /// Type of index that wildcard patterns can match. + /// If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + /// Supports comma-separated values, such as open,hidden. + /// Valid values are: all, open, closed, hidden, none. + /// /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Starting offset (default: 0) + /// + /// Starting offset (default: 0) + /// /// [JsonIgnore] public long? From { get => Q("from"); set => Q("from", value); } /// - /// If `false`, the request returns an error if it targets a missing or closed index. + /// + /// If false, the request returns an error if it targets a missing or closed index. + /// /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// + /// If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + /// /// [JsonIgnore] public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// - /// ID of the pipeline to use to preprocess incoming documents.
If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.
If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// + /// ID of the pipeline to use to preprocess incoming documents. + /// If the index has a default ingest pipeline specified, then setting the value to _none disables the default ingest pipeline for this request. + /// If a final pipeline is configured it will always run, regardless of the value of this parameter. + /// /// [JsonIgnore] public string? Pipeline { get => Q("pipeline"); set => Q("pipeline", value); } /// - /// Specifies the node or shard the operation should be performed on.
Random by default. + /// + /// Specifies the node or shard the operation should be performed on. + /// Random by default. + /// /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// If `true`, Elasticsearch refreshes affected shards to make the operation visible to search. + /// + /// If true, Elasticsearch refreshes affected shards to make the operation visible to search. + /// /// [JsonIgnore] public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// If `true`, the request cache is used for this request. + /// + /// If true, the request cache is used for this request. + /// /// [JsonIgnore] public bool? RequestCache { get => Q("request_cache"); set => Q("request_cache", value); } /// - /// The throttle for this request in sub-requests per second. + /// + /// The throttle for this request in sub-requests per second. + /// /// [JsonIgnore] public float? RequestsPerSecond { get => Q("requests_per_second"); set => Q("requests_per_second", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Period to retain the search context for scrolling. + /// + /// Period to retain the search context for scrolling. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); } /// - /// Size of the scroll request that powers the operation. + /// + /// Size of the scroll request that powers the operation. + /// /// [JsonIgnore] public long? ScrollSize { get => Q("scroll_size"); set => Q("scroll_size", value); } /// - /// Explicit timeout for each search request. + /// + /// Explicit timeout for each search request. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? SearchTimeout { get => Q("search_timeout"); set => Q("search_timeout", value); } /// - /// The type of the search operation. Available options: `query_then_fetch`, `dfs_query_then_fetch`. + /// + /// The type of the search operation. Available options: query_then_fetch, dfs_query_then_fetch. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } /// - /// The number of slices this task should be divided into. + /// + /// The number of slices this task should be divided into. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Slices? Slices { get => Q("slices"); set => Q("slices", value); } /// - /// A comma-separated list of : pairs. + /// + /// A comma-separated list of <field>:<direction> pairs. + /// /// [JsonIgnore] public ICollection? Sort { get => Q?>("sort"); set => Q("sort", value); } /// - /// Specific `tag` of the request for logging and statistical purposes. + /// + /// Specific tag of the request for logging and statistical purposes. + /// /// [JsonIgnore] public ICollection? Stats { get => Q?>("stats"); set => Q("stats", value); } /// - /// Maximum number of documents to collect for each shard.
If a query reaches this limit, Elasticsearch terminates the query early.
Elasticsearch collects documents before sorting.
Use with caution.
Elasticsearch applies this parameter to each shard handling the request.
When possible, let Elasticsearch perform early termination automatically.
Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + /// + /// Maximum number of documents to collect for each shard. + /// If a query reaches this limit, Elasticsearch terminates the query early. + /// Elasticsearch collects documents before sorting. + /// Use with caution. + /// Elasticsearch applies this parameter to each shard handling the request. + /// When possible, let Elasticsearch perform early termination automatically. + /// Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + /// /// [JsonIgnore] public long? TerminateAfter { get => Q("terminate_after"); set => Q("terminate_after", value); } /// - /// Period each update request waits for the following operations: dynamic mapping updates, waiting for active shards. + /// + /// Period each update request waits for the following operations: dynamic mapping updates, waiting for active shards. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// If `true`, returns the document version as part of a hit. + /// + /// If true, returns the document version as part of a hit. + /// /// [JsonIgnore] public bool? Version { get => Q("version"); set => Q("version", value); } /// - /// Should the document increment the version number (internal) on hit or not (reindex) + /// + /// Should the document increment the version number (internal) on hit or not (reindex) + /// /// [JsonIgnore] public bool? VersionType { get => Q("version_type"); set => Q("version_type", value); } /// - /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + /// + /// The number of shard copies that must be active before proceeding with the operation. + /// Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } /// - /// If `true`, the request blocks until the operation is complete. + /// + /// If true, the request blocks until the operation is complete. + /// /// [JsonIgnore] public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } /// - /// What to do if update by query hits version conflicts: `abort` or `proceed`. + /// + /// What to do if update by query hits version conflicts: abort or proceed. + /// /// [JsonInclude, JsonPropertyName("conflicts")] public Elastic.Clients.Elasticsearch.Conflicts? Conflicts { get; set; } /// - /// The maximum number of documents to update. + /// + /// The maximum number of documents to update. + /// /// [JsonInclude, JsonPropertyName("max_docs")] public long? MaxDocs { get; set; } /// - /// Specifies the documents to update using the Query DSL. + /// + /// Specifies the documents to update using the Query DSL. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Query { get; set; } /// - /// The script to run to update the document source or metadata when updating. + /// + /// The script to run to update the document source or metadata when updating. + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Script? Script { get; set; } /// - /// Slice the request manually using the provided slice ID and total number of slices. + /// + /// Slice the request manually using the provided slice ID and total number of slices. + /// /// [JsonInclude, JsonPropertyName("slice")] public Elastic.Clients.Elasticsearch.SlicedScroll? Slice { get; set; } } /// -/// 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. +/// /// public sealed partial class UpdateByQueryRequestDescriptor : RequestDescriptor, UpdateByQueryRequestParameters> { @@ -459,7 +619,9 @@ public UpdateByQueryRequestDescriptor Indices(Elastic.Clients.Elastic private Action> SliceDescriptorAction { get; set; } /// - /// What to do if update by query hits version conflicts: `abort` or `proceed`. + /// + /// What to do if update by query hits version conflicts: abort or proceed. + /// /// public UpdateByQueryRequestDescriptor Conflicts(Elastic.Clients.Elasticsearch.Conflicts? conflicts) { @@ -468,7 +630,9 @@ public UpdateByQueryRequestDescriptor Conflicts(Elastic.Clients.Elast } /// - /// The maximum number of documents to update. + /// + /// The maximum number of documents to update. + /// /// public UpdateByQueryRequestDescriptor MaxDocs(long? maxDocs) { @@ -477,7 +641,9 @@ public UpdateByQueryRequestDescriptor MaxDocs(long? maxDocs) } /// - /// Specifies the documents to update using the Query DSL. + /// + /// Specifies the documents to update using the Query DSL. + /// /// public UpdateByQueryRequestDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -504,7 +670,9 @@ public UpdateByQueryRequestDescriptor Query(Action - /// The script to run to update the document source or metadata when updating. + /// + /// The script to run to update the document source or metadata when updating. + /// /// public UpdateByQueryRequestDescriptor Script(Elastic.Clients.Elasticsearch.Script? script) { @@ -531,7 +699,9 @@ public UpdateByQueryRequestDescriptor Script(Action - /// Slice the request manually using the provided slice ID and total number of slices. + /// + /// Slice the request manually using the provided slice ID and total number of slices. + /// /// public UpdateByQueryRequestDescriptor Slice(Elastic.Clients.Elasticsearch.SlicedScroll? slice) { @@ -625,7 +795,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// 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. +/// /// public sealed partial class UpdateByQueryRequestDescriptor : RequestDescriptor { @@ -691,7 +865,9 @@ public UpdateByQueryRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indi private Action SliceDescriptorAction { get; set; } /// - /// What to do if update by query hits version conflicts: `abort` or `proceed`. + /// + /// What to do if update by query hits version conflicts: abort or proceed. + /// /// public UpdateByQueryRequestDescriptor Conflicts(Elastic.Clients.Elasticsearch.Conflicts? conflicts) { @@ -700,7 +876,9 @@ public UpdateByQueryRequestDescriptor Conflicts(Elastic.Clients.Elasticsearch.Co } /// - /// The maximum number of documents to update. + /// + /// The maximum number of documents to update. + /// /// public UpdateByQueryRequestDescriptor MaxDocs(long? maxDocs) { @@ -709,7 +887,9 @@ public UpdateByQueryRequestDescriptor MaxDocs(long? maxDocs) } /// - /// Specifies the documents to update using the Query DSL. + /// + /// Specifies the documents to update using the Query DSL. + /// /// public UpdateByQueryRequestDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -736,7 +916,9 @@ public UpdateByQueryRequestDescriptor Query(Action - /// The script to run to update the document source or metadata when updating. + /// + /// The script to run to update the document source or metadata when updating. + /// /// public UpdateByQueryRequestDescriptor Script(Elastic.Clients.Elasticsearch.Script? script) { @@ -763,7 +945,9 @@ public UpdateByQueryRequestDescriptor Script(Action - /// Slice the request manually using the provided slice ID and total number of slices. + /// + /// Slice the request manually using the provided slice ID and total number of slices. + /// /// public UpdateByQueryRequestDescriptor Slice(Elastic.Clients.Elasticsearch.SlicedScroll? slice) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/UpdateByQueryRethrottleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/UpdateByQueryRethrottleRequest.g.cs index 947e1dbb817..c4bc0ab4d92 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/UpdateByQueryRethrottleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/UpdateByQueryRethrottleRequest.g.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class UpdateByQueryRethrottleRequestParameters : RequestParameters { /// - /// The throttle for this request in sub-requests per second. + /// + /// The throttle for this request in sub-requests per second. + /// /// public float? RequestsPerSecond { get => Q("requests_per_second"); set => Q("requests_per_second", value); } } /// -/// Changes the number of requests per second for a particular Update By Query operation. +/// +/// Changes the number of requests per second for a particular Update By Query operation. +/// /// public sealed partial class UpdateByQueryRethrottleRequest : PlainRequest { @@ -55,14 +59,18 @@ public UpdateByQueryRethrottleRequest(Elastic.Clients.Elasticsearch.Id taskId) : internal override string OperationName => "update_by_query_rethrottle"; /// - /// The throttle for this request in sub-requests per second. + /// + /// The throttle for this request in sub-requests per second. + /// /// [JsonIgnore] public float? RequestsPerSecond { get => Q("requests_per_second"); set => Q("requests_per_second", value); } } /// -/// Changes the number of requests per second for a particular Update By Query operation. +/// +/// Changes the number of requests per second for a particular Update By Query operation. +/// /// public sealed partial class UpdateByQueryRethrottleRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/UpdateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/UpdateRequest.g.cs index 8102d62408e..818525a2fe8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/UpdateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/UpdateRequest.g.cs @@ -32,63 +32,94 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class UpdateRequestParameters : RequestParameters { /// - /// Only perform the operation if the document has this primary term. + /// + /// Only perform the operation if the document has this primary term. + /// /// public long? IfPrimaryTerm { get => Q("if_primary_term"); set => Q("if_primary_term", value); } /// - /// Only perform the operation if the document has this sequence number. + /// + /// Only perform the operation if the document has this sequence number. + /// /// public long? IfSeqNo { get => Q("if_seq_no"); set => Q("if_seq_no", value); } /// - /// The script language. + /// + /// The script language. + /// /// public string? Lang { get => Q("lang"); set => Q("lang", value); } /// - /// If 'true', Elasticsearch refreshes the affected shards to make this operation
visible to search, if 'wait_for' then wait for a refresh to make this operation
visible to search, if 'false' do nothing with refreshes. + /// + /// If 'true', Elasticsearch refreshes the affected shards to make this operation + /// visible to search, if 'wait_for' then wait for a refresh to make this operation + /// visible to search, if 'false' do nothing with refreshes. + /// /// public Elastic.Clients.Elasticsearch.Refresh? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// If true, the destination must be an index alias. + /// + /// If true, the destination must be an index alias. + /// /// public bool? RequireAlias { get => Q("require_alias"); set => Q("require_alias", value); } /// - /// Specify how many times should the operation be retried when a conflict occurs. + /// + /// Specify how many times should the operation be retried when a conflict occurs. + /// /// public int? RetryOnConflict { get => Q("retry_on_conflict"); set => Q("retry_on_conflict", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Specify the source fields you want to exclude. + /// + /// Specify the source fields you want to exclude. + /// /// public Elastic.Clients.Elasticsearch.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// Specify the source fields you want to retrieve. + /// + /// Specify the source fields you want to retrieve. + /// /// public Elastic.Clients.Elasticsearch.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// Period to wait for dynamic mapping updates and active shards.
This guarantees Elasticsearch waits for at least the timeout before failing.
The actual wait time could be longer, particularly when multiple waits occur. + /// + /// Period to wait for dynamic mapping updates and active shards. + /// This guarantees Elasticsearch waits for at least the timeout before failing. + /// The actual wait time could be longer, particularly when multiple waits occur. + /// /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operations.
Set to 'all' or any positive integer up to the total number of shards in the index
(number_of_replicas+1). Defaults to 1 meaning the primary shard. + /// + /// The number of shard copies that must be active before proceeding with the operations. + /// Set to 'all' or any positive integer up to the total number of shards in the index + /// (number_of_replicas+1). Defaults to 1 meaning the primary shard. + /// /// public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Update a document.
Updates a document by running a script or passing a partial document. +/// +/// Update a document. +/// Updates a document by running a script or passing a partial document. +/// /// public sealed partial class UpdateRequest : PlainRequest { @@ -105,110 +136,155 @@ public UpdateRequest(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clie internal override string OperationName => "update"; /// - /// Only perform the operation if the document has this primary term. + /// + /// Only perform the operation if the document has this primary term. + /// /// [JsonIgnore] public long? IfPrimaryTerm { get => Q("if_primary_term"); set => Q("if_primary_term", value); } /// - /// Only perform the operation if the document has this sequence number. + /// + /// Only perform the operation if the document has this sequence number. + /// /// [JsonIgnore] public long? IfSeqNo { get => Q("if_seq_no"); set => Q("if_seq_no", value); } /// - /// The script language. + /// + /// The script language. + /// /// [JsonIgnore] public string? Lang { get => Q("lang"); set => Q("lang", value); } /// - /// If 'true', Elasticsearch refreshes the affected shards to make this operation
visible to search, if 'wait_for' then wait for a refresh to make this operation
visible to search, if 'false' do nothing with refreshes. + /// + /// If 'true', Elasticsearch refreshes the affected shards to make this operation + /// visible to search, if 'wait_for' then wait for a refresh to make this operation + /// visible to search, if 'false' do nothing with refreshes. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Refresh? Refresh { get => Q("refresh"); set => Q("refresh", value); } /// - /// If true, the destination must be an index alias. + /// + /// If true, the destination must be an index alias. + /// /// [JsonIgnore] public bool? RequireAlias { get => Q("require_alias"); set => Q("require_alias", value); } /// - /// Specify how many times should the operation be retried when a conflict occurs. + /// + /// Specify how many times should the operation be retried when a conflict occurs. + /// /// [JsonIgnore] public int? RetryOnConflict { get => Q("retry_on_conflict"); set => Q("retry_on_conflict", value); } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Specify the source fields you want to exclude. + /// + /// Specify the source fields you want to exclude. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// Specify the source fields you want to retrieve. + /// + /// Specify the source fields you want to retrieve. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// Period to wait for dynamic mapping updates and active shards.
This guarantees Elasticsearch waits for at least the timeout before failing.
The actual wait time could be longer, particularly when multiple waits occur. + /// + /// Period to wait for dynamic mapping updates and active shards. + /// This guarantees Elasticsearch waits for at least the timeout before failing. + /// The actual wait time could be longer, particularly when multiple waits occur. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// The number of shard copies that must be active before proceeding with the operations.
Set to 'all' or any positive integer up to the total number of shards in the index
(number_of_replicas+1). Defaults to 1 meaning the primary shard. + /// + /// The number of shard copies that must be active before proceeding with the operations. + /// Set to 'all' or any positive integer up to the total number of shards in the index + /// (number_of_replicas+1). Defaults to 1 meaning the primary shard. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } /// - /// Set to false to disable setting 'result' in the response
to 'noop' if no change to the document occurred. + /// + /// Set to false to disable setting 'result' in the response + /// to 'noop' if no change to the document occurred. + /// /// [JsonInclude, JsonPropertyName("detect_noop")] public bool? DetectNoop { get; set; } /// - /// A partial update to an existing document. + /// + /// A partial update to an existing document. + /// /// [JsonInclude, JsonPropertyName("doc")] [SourceConverter] public TPartialDocument? Doc { get; set; } /// - /// Set to true to use the contents of 'doc' as the value of 'upsert' + /// + /// Set to true to use the contents of 'doc' as the value of 'upsert' + /// /// [JsonInclude, JsonPropertyName("doc_as_upsert")] public bool? DocAsUpsert { get; set; } /// - /// Script to execute to update the document. + /// + /// Script to execute to update the document. + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Script? Script { get; set; } /// - /// Set to true to execute the script whether or not the document exists. + /// + /// Set to true to execute the script whether or not the document exists. + /// /// [JsonInclude, JsonPropertyName("scripted_upsert")] public bool? ScriptedUpsert { get; set; } /// - /// Set to false to disable source retrieval. You can also specify a comma-separated
list of the fields you want to retrieve. + /// + /// Set to false to disable source retrieval. You can also specify a comma-separated + /// list of the fields you want to retrieve. + /// /// [JsonInclude, JsonPropertyName("_source")] public Elastic.Clients.Elasticsearch.Core.Search.SourceConfig? Source { get; set; } /// - /// If the document does not already exist, the contents of 'upsert' are inserted as a
new document. If the document exists, the 'script' is executed. + /// + /// If the document does not already exist, the contents of 'upsert' are inserted as a + /// new document. If the document exists, the 'script' is executed. + /// /// [JsonInclude, JsonPropertyName("upsert")] [SourceConverter] @@ -216,7 +292,10 @@ public UpdateRequest(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clie } /// -/// Update a document.
Updates a document by running a script or passing a partial document. +/// +/// Update a document. +/// Updates a document by running a script or passing a partial document. +/// /// public sealed partial class UpdateRequestDescriptor : RequestDescriptor, UpdateRequestParameters> { @@ -285,7 +364,10 @@ public UpdateRequestDescriptor Index(Elastic.Client private TDocument? UpsertValue { get; set; } /// - /// Set to false to disable setting 'result' in the response
to 'noop' if no change to the document occurred. + /// + /// Set to false to disable setting 'result' in the response + /// to 'noop' if no change to the document occurred. + /// /// public UpdateRequestDescriptor DetectNoop(bool? detectNoop = true) { @@ -294,7 +376,9 @@ public UpdateRequestDescriptor DetectNoop(bool? det } /// - /// A partial update to an existing document. + /// + /// A partial update to an existing document. + /// /// public UpdateRequestDescriptor Doc(TPartialDocument? doc) { @@ -303,7 +387,9 @@ public UpdateRequestDescriptor Doc(TPartialDocument } /// - /// Set to true to use the contents of 'doc' as the value of 'upsert' + /// + /// Set to true to use the contents of 'doc' as the value of 'upsert' + /// /// public UpdateRequestDescriptor DocAsUpsert(bool? docAsUpsert = true) { @@ -312,7 +398,9 @@ public UpdateRequestDescriptor DocAsUpsert(bool? do } /// - /// Script to execute to update the document. + /// + /// Script to execute to update the document. + /// /// public UpdateRequestDescriptor Script(Elastic.Clients.Elasticsearch.Script? script) { @@ -339,7 +427,9 @@ public UpdateRequestDescriptor Script(Action - /// Set to true to execute the script whether or not the document exists. + /// + /// Set to true to execute the script whether or not the document exists. + /// /// public UpdateRequestDescriptor ScriptedUpsert(bool? scriptedUpsert = true) { @@ -348,7 +438,10 @@ public UpdateRequestDescriptor ScriptedUpsert(bool? } /// - /// Set to false to disable source retrieval. You can also specify a comma-separated
list of the fields you want to retrieve. + /// + /// Set to false to disable source retrieval. You can also specify a comma-separated + /// list of the fields you want to retrieve. + /// /// public UpdateRequestDescriptor Source(Elastic.Clients.Elasticsearch.Core.Search.SourceConfig? source) { @@ -357,7 +450,10 @@ public UpdateRequestDescriptor Source(Elastic.Clien } /// - /// If the document does not already exist, the contents of 'upsert' are inserted as a
new document. If the document exists, the 'script' is executed. + /// + /// If the document does not already exist, the contents of 'upsert' are inserted as a + /// new document. If the document exists, the 'script' is executed. + /// /// public UpdateRequestDescriptor Upsert(TDocument? upsert) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Xpack/XpackInfoRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Xpack/XpackInfoRequest.g.cs index 28dd6858af4..651d7111d85 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Xpack/XpackInfoRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Xpack/XpackInfoRequest.g.cs @@ -32,18 +32,24 @@ namespace Elastic.Clients.Elasticsearch.Xpack; public sealed partial class XpackInfoRequestParameters : RequestParameters { /// - /// If this param is used it must be set to true + /// + /// If this param is used it must be set to true + /// /// public bool? AcceptEnterprise { get => Q("accept_enterprise"); set => Q("accept_enterprise", value); } /// - /// A comma-separated list of the information categories to include in the response. For example, `build,license,features`. + /// + /// A comma-separated list of the information categories to include in the response. For example, build,license,features. + /// /// public ICollection? Categories { get => Q?>("categories"); set => Q("categories", value); } } /// -/// Provides general information about the installed X-Pack features. +/// +/// Provides general information about the installed X-Pack features. +/// /// public sealed partial class XpackInfoRequest : PlainRequest { @@ -56,20 +62,26 @@ public sealed partial class XpackInfoRequest : PlainRequest "xpack.info"; /// - /// If this param is used it must be set to true + /// + /// If this param is used it must be set to true + /// /// [JsonIgnore] public bool? AcceptEnterprise { get => Q("accept_enterprise"); set => Q("accept_enterprise", value); } /// - /// A comma-separated list of the information categories to include in the response. For example, `build,license,features`. + /// + /// A comma-separated list of the information categories to include in the response. For example, build,license,features. + /// /// [JsonIgnore] public ICollection? Categories { get => Q?>("categories"); set => Q("categories", value); } } /// -/// Provides general information about the installed X-Pack features. +/// +/// Provides general information about the installed X-Pack features. +/// /// public sealed partial class XpackInfoRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Xpack/XpackUsageRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Xpack/XpackUsageRequest.g.cs index 1bda14f4162..099348c72fb 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Xpack/XpackUsageRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Xpack/XpackUsageRequest.g.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch.Xpack; public sealed partial class XpackUsageRequestParameters : RequestParameters { /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// This API provides information about which features are currently enabled and available under the current license and some usage statistics. +/// +/// This API provides information about which features are currently enabled and available under the current license and some usage statistics. +/// /// public sealed partial class XpackUsageRequest : PlainRequest { @@ -51,14 +55,18 @@ public sealed partial class XpackUsageRequest : PlainRequest "xpack.usage"; /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// + /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// This API provides information about which features are currently enabled and available under the current license and some usage statistics. +/// +/// This API provides information about which features are currently enabled and available under the current license and some usage statistics. +/// /// public sealed partial class XpackUsageRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.AsyncSearch.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.AsyncSearch.g.cs index 882a3323a6c..7a6947663b3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.AsyncSearch.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.AsyncSearch.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.AsyncSearch; public partial class AsyncSearchNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected AsyncSearchNamespacedClient() : base() { @@ -38,7 +40,12 @@ internal AsyncSearchNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// Deletes an async search by identifier.
If the search is still running, the search request will be cancelled.
Otherwise, the saved search results are deleted.
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. + /// + /// Deletes an async search by identifier. + /// If the search is still running, the search request will be cancelled. + /// Otherwise, the saved search results are deleted. + /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -49,7 +56,12 @@ public virtual DeleteAsyncSearchResponse Delete(DeleteAsyncSearchRequest request } /// - /// Deletes an async search by identifier.
If the search is still running, the search request will be cancelled.
Otherwise, the saved search results are deleted.
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. + /// + /// Deletes an async search by identifier. + /// If the search is still running, the search request will be cancelled. + /// Otherwise, the saved search results are deleted. + /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteAsyncSearchRequest request, CancellationToken cancellationToken = default) @@ -59,7 +71,12 @@ public virtual Task DeleteAsync(DeleteAsyncSearchRequ } /// - /// Deletes an async search by identifier.
If the search is still running, the search request will be cancelled.
Otherwise, the saved search results are deleted.
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. + /// + /// Deletes an async search by identifier. + /// If the search is still running, the search request will be cancelled. + /// Otherwise, the saved search results are deleted. + /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -70,7 +87,12 @@ public virtual DeleteAsyncSearchResponse Delete(DeleteAsyncSearchRequ } /// - /// Deletes an async search by identifier.
If the search is still running, the search request will be cancelled.
Otherwise, the saved search results are deleted.
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. + /// + /// Deletes an async search by identifier. + /// If the search is still running, the search request will be cancelled. + /// Otherwise, the saved search results are deleted. + /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -82,7 +104,12 @@ public virtual DeleteAsyncSearchResponse Delete(Elastic.Clients.Elast } /// - /// Deletes an async search by identifier.
If the search is still running, the search request will be cancelled.
Otherwise, the saved search results are deleted.
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. + /// + /// Deletes an async search by identifier. + /// If the search is still running, the search request will be cancelled. + /// Otherwise, the saved search results are deleted. + /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -95,7 +122,12 @@ public virtual DeleteAsyncSearchResponse Delete(Elastic.Clients.Elast } /// - /// Deletes an async search by identifier.
If the search is still running, the search request will be cancelled.
Otherwise, the saved search results are deleted.
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. + /// + /// Deletes an async search by identifier. + /// If the search is still running, the search request will be cancelled. + /// Otherwise, the saved search results are deleted. + /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -106,7 +138,12 @@ public virtual DeleteAsyncSearchResponse Delete(DeleteAsyncSearchRequestDescript } /// - /// Deletes an async search by identifier.
If the search is still running, the search request will be cancelled.
Otherwise, the saved search results are deleted.
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. + /// + /// Deletes an async search by identifier. + /// If the search is still running, the search request will be cancelled. + /// Otherwise, the saved search results are deleted. + /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -118,7 +155,12 @@ public virtual DeleteAsyncSearchResponse Delete(Elastic.Clients.Elasticsearch.Id } /// - /// Deletes an async search by identifier.
If the search is still running, the search request will be cancelled.
Otherwise, the saved search results are deleted.
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. + /// + /// Deletes an async search by identifier. + /// If the search is still running, the search request will be cancelled. + /// Otherwise, the saved search results are deleted. + /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -131,7 +173,12 @@ public virtual DeleteAsyncSearchResponse Delete(Elastic.Clients.Elasticsearch.Id } /// - /// Deletes an async search by identifier.
If the search is still running, the search request will be cancelled.
Otherwise, the saved search results are deleted.
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. + /// + /// Deletes an async search by identifier. + /// If the search is still running, the search request will be cancelled. + /// Otherwise, the saved search results are deleted. + /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteAsyncSearchRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -141,7 +188,12 @@ public virtual Task DeleteAsync(DeleteAsyn } /// - /// Deletes an async search by identifier.
If the search is still running, the search request will be cancelled.
Otherwise, the saved search results are deleted.
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. + /// + /// Deletes an async search by identifier. + /// If the search is still running, the search request will be cancelled. + /// Otherwise, the saved search results are deleted. + /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -152,7 +204,12 @@ public virtual Task DeleteAsync(Elastic.Cl } /// - /// Deletes an async search by identifier.
If the search is still running, the search request will be cancelled.
Otherwise, the saved search results are deleted.
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. + /// + /// Deletes an async search by identifier. + /// If the search is still running, the search request will be cancelled. + /// Otherwise, the saved search results are deleted. + /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -164,7 +221,12 @@ public virtual Task DeleteAsync(Elastic.Cl } /// - /// Deletes an async search by identifier.
If the search is still running, the search request will be cancelled.
Otherwise, the saved search results are deleted.
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. + /// + /// Deletes an async search by identifier. + /// If the search is still running, the search request will be cancelled. + /// Otherwise, the saved search results are deleted. + /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteAsyncSearchRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -174,7 +236,12 @@ public virtual Task DeleteAsync(DeleteAsyncSearchRequ } /// - /// Deletes an async search by identifier.
If the search is still running, the search request will be cancelled.
Otherwise, the saved search results are deleted.
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. + /// + /// Deletes an async search by identifier. + /// If the search is still running, the search request will be cancelled. + /// Otherwise, the saved search results are deleted. + /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -185,7 +252,12 @@ public virtual Task DeleteAsync(Elastic.Clients.Elast } /// - /// Deletes an async search by identifier.
If the search is still running, the search request will be cancelled.
Otherwise, the saved search results are deleted.
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. + /// + /// Deletes an async search by identifier. + /// If the search is still running, the search request will be cancelled. + /// Otherwise, the saved search results are deleted. + /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -197,7 +269,10 @@ public virtual Task DeleteAsync(Elastic.Clients.Elast } /// - /// Retrieves the results of a previously submitted async search request given its identifier.
If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. + /// + /// Retrieves the results of a previously submitted async search request given its identifier. + /// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -208,7 +283,10 @@ public virtual GetAsyncSearchResponse Get(GetAsyncSearchRe } /// - /// Retrieves the results of a previously submitted async search request given its identifier.
If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. + /// + /// Retrieves the results of a previously submitted async search request given its identifier. + /// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(GetAsyncSearchRequest request, CancellationToken cancellationToken = default) @@ -218,7 +296,10 @@ public virtual Task> GetAsync(GetAs } /// - /// Retrieves the results of a previously submitted async search request given its identifier.
If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. + /// + /// Retrieves the results of a previously submitted async search request given its identifier. + /// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -229,7 +310,10 @@ public virtual GetAsyncSearchResponse Get(GetAsyncSearchRe } /// - /// Retrieves the results of a previously submitted async search request given its identifier.
If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. + /// + /// Retrieves the results of a previously submitted async search request given its identifier. + /// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -241,7 +325,10 @@ public virtual GetAsyncSearchResponse Get(Elastic.Clients. } /// - /// Retrieves the results of a previously submitted async search request given its identifier.
If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. + /// + /// Retrieves the results of a previously submitted async search request given its identifier. + /// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -254,7 +341,10 @@ public virtual GetAsyncSearchResponse Get(Elastic.Clients. } /// - /// Retrieves the results of a previously submitted async search request given its identifier.
If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. + /// + /// Retrieves the results of a previously submitted async search request given its identifier. + /// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(GetAsyncSearchRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -264,7 +354,10 @@ public virtual Task> GetAsync(GetAs } /// - /// Retrieves the results of a previously submitted async search request given its identifier.
If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. + /// + /// Retrieves the results of a previously submitted async search request given its identifier. + /// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -275,7 +368,10 @@ public virtual Task> GetAsync(Elast } /// - /// Retrieves the results of a previously submitted async search request given its identifier.
If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. + /// + /// Retrieves the results of a previously submitted async search request given its identifier. + /// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -287,7 +383,11 @@ public virtual Task> GetAsync(Elast } /// - /// Get async search status
Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. + /// + /// Get async search status + /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -298,7 +398,11 @@ public virtual AsyncSearchStatusResponse Status(AsyncSearchStatusRequest request } /// - /// Get async search status
Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. + /// + /// Get async search status + /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(AsyncSearchStatusRequest request, CancellationToken cancellationToken = default) @@ -308,7 +412,11 @@ public virtual Task StatusAsync(AsyncSearchStatusRequ } /// - /// Get async search status
Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. + /// + /// Get async search status + /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -319,7 +427,11 @@ public virtual AsyncSearchStatusResponse Status(AsyncSearchStatusRequ } /// - /// Get async search status
Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. + /// + /// Get async search status + /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -331,7 +443,11 @@ public virtual AsyncSearchStatusResponse Status(Elastic.Clients.Elast } /// - /// Get async search status
Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. + /// + /// Get async search status + /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -344,7 +460,11 @@ public virtual AsyncSearchStatusResponse Status(Elastic.Clients.Elast } /// - /// Get async search status
Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. + /// + /// Get async search status + /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -355,7 +475,11 @@ public virtual AsyncSearchStatusResponse Status(AsyncSearchStatusRequestDescript } /// - /// Get async search status
Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. + /// + /// Get async search status + /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -367,7 +491,11 @@ public virtual AsyncSearchStatusResponse Status(Elastic.Clients.Elasticsearch.Id } /// - /// Get async search status
Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. + /// + /// Get async search status + /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -380,7 +508,11 @@ public virtual AsyncSearchStatusResponse Status(Elastic.Clients.Elasticsearch.Id } /// - /// Get async search status
Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. + /// + /// Get async search status + /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(AsyncSearchStatusRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -390,7 +522,11 @@ public virtual Task StatusAsync(AsyncSearc } /// - /// Get async search status
Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. + /// + /// Get async search status + /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -401,7 +537,11 @@ public virtual Task StatusAsync(Elastic.Cl } /// - /// Get async search status
Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. + /// + /// Get async search status + /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -413,7 +553,11 @@ public virtual Task StatusAsync(Elastic.Cl } /// - /// Get async search status
Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. + /// + /// Get async search status + /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(AsyncSearchStatusRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -423,7 +567,11 @@ public virtual Task StatusAsync(AsyncSearchStatusRequ } /// - /// Get async search status
Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. + /// + /// Get async search status + /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -434,7 +582,11 @@ public virtual Task StatusAsync(Elastic.Clients.Elast } /// - /// Get async search status
Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. + /// + /// Get async search status + /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -446,7 +598,13 @@ public virtual Task StatusAsync(Elastic.Clients.Elast } /// - /// Runs a search request asynchronously.
When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.
Warning: Async search does not support scroll nor search requests that only include the suggest section.
By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. + /// + /// Runs a search request asynchronously. + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. + /// Warning: Async search does not support scroll nor search requests that only include the suggest section. + /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -457,7 +615,13 @@ public virtual SubmitAsyncSearchResponse Submit(SubmitAsyn } /// - /// Runs a search request asynchronously.
When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.
Warning: Async search does not support scroll nor search requests that only include the suggest section.
By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. + /// + /// Runs a search request asynchronously. + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. + /// Warning: Async search does not support scroll nor search requests that only include the suggest section. + /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SubmitAsync(SubmitAsyncSearchRequest request, CancellationToken cancellationToken = default) @@ -467,7 +631,13 @@ public virtual Task> SubmitAsync } /// - /// Runs a search request asynchronously.
When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.
Warning: Async search does not support scroll nor search requests that only include the suggest section.
By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. + /// + /// Runs a search request asynchronously. + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. + /// Warning: Async search does not support scroll nor search requests that only include the suggest section. + /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -478,7 +648,13 @@ public virtual SubmitAsyncSearchResponse Submit(SubmitAsyn } /// - /// Runs a search request asynchronously.
When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.
Warning: Async search does not support scroll nor search requests that only include the suggest section.
By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. + /// + /// Runs a search request asynchronously. + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. + /// Warning: Async search does not support scroll nor search requests that only include the suggest section. + /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -490,7 +666,13 @@ public virtual SubmitAsyncSearchResponse Submit(Elastic.Cl } /// - /// Runs a search request asynchronously.
When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.
Warning: Async search does not support scroll nor search requests that only include the suggest section.
By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. + /// + /// Runs a search request asynchronously. + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. + /// Warning: Async search does not support scroll nor search requests that only include the suggest section. + /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -503,7 +685,13 @@ public virtual SubmitAsyncSearchResponse Submit(Elastic.Cl } /// - /// Runs a search request asynchronously.
When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.
Warning: Async search does not support scroll nor search requests that only include the suggest section.
By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. + /// + /// Runs a search request asynchronously. + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. + /// Warning: Async search does not support scroll nor search requests that only include the suggest section. + /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -515,7 +703,13 @@ public virtual SubmitAsyncSearchResponse Submit() } /// - /// Runs a search request asynchronously.
When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.
Warning: Async search does not support scroll nor search requests that only include the suggest section.
By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. + /// + /// Runs a search request asynchronously. + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. + /// Warning: Async search does not support scroll nor search requests that only include the suggest section. + /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -528,7 +722,13 @@ public virtual SubmitAsyncSearchResponse Submit(Action - /// Runs a search request asynchronously.
When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.
Warning: Async search does not support scroll nor search requests that only include the suggest section.
By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. + /// + /// Runs a search request asynchronously. + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. + /// Warning: Async search does not support scroll nor search requests that only include the suggest section. + /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SubmitAsync(SubmitAsyncSearchRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -538,7 +738,13 @@ public virtual Task> SubmitAsync } /// - /// Runs a search request asynchronously.
When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.
Warning: Async search does not support scroll nor search requests that only include the suggest section.
By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. + /// + /// Runs a search request asynchronously. + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. + /// Warning: Async search does not support scroll nor search requests that only include the suggest section. + /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SubmitAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -549,7 +755,13 @@ public virtual Task> SubmitAsync } /// - /// Runs a search request asynchronously.
When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.
Warning: Async search does not support scroll nor search requests that only include the suggest section.
By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. + /// + /// Runs a search request asynchronously. + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. + /// Warning: Async search does not support scroll nor search requests that only include the suggest section. + /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SubmitAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -561,7 +773,13 @@ public virtual Task> SubmitAsync } /// - /// Runs a search request asynchronously.
When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.
Warning: Async search does not support scroll nor search requests that only include the suggest section.
By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. + /// + /// Runs a search request asynchronously. + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. + /// Warning: Async search does not support scroll nor search requests that only include the suggest section. + /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SubmitAsync(CancellationToken cancellationToken = default) @@ -572,7 +790,13 @@ public virtual Task> SubmitAsync } /// - /// Runs a search request asynchronously.
When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.
Warning: Async search does not support scroll nor search requests that only include the suggest section.
By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. + /// + /// Runs a search request asynchronously. + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. + /// Warning: Async search does not support scroll nor search requests that only include the suggest section. + /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SubmitAsync(Action> configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ccr.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ccr.g.cs index 5c852ca0820..a6389cf2645 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ccr.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ccr.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.CrossClusterReplication; public partial class CrossClusterReplicationNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected CrossClusterReplicationNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal CrossClusterReplicationNamespacedClient(ElasticsearchClient client) : b } /// - /// Deletes auto-follow patterns. + /// + /// Deletes auto-follow patterns. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -49,7 +53,9 @@ public virtual DeleteAutoFollowPatternResponse DeleteAutoFollowPattern(DeleteAut } /// - /// Deletes auto-follow patterns. + /// + /// Deletes auto-follow patterns. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAutoFollowPatternAsync(DeleteAutoFollowPatternRequest request, CancellationToken cancellationToken = default) @@ -59,7 +65,9 @@ public virtual Task DeleteAutoFollowPatternAsyn } /// - /// Deletes auto-follow patterns. + /// + /// Deletes auto-follow patterns. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -70,7 +78,9 @@ public virtual DeleteAutoFollowPatternResponse DeleteAutoFollowPattern(DeleteAut } /// - /// Deletes auto-follow patterns. + /// + /// Deletes auto-follow patterns. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -82,7 +92,9 @@ public virtual DeleteAutoFollowPatternResponse DeleteAutoFollowPattern(Elastic.C } /// - /// Deletes auto-follow patterns. + /// + /// Deletes auto-follow patterns. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -95,7 +107,9 @@ public virtual DeleteAutoFollowPatternResponse DeleteAutoFollowPattern(Elastic.C } /// - /// Deletes auto-follow patterns. + /// + /// Deletes auto-follow patterns. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAutoFollowPatternAsync(DeleteAutoFollowPatternRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -105,7 +119,9 @@ public virtual Task DeleteAutoFollowPatternAsyn } /// - /// Deletes auto-follow patterns. + /// + /// Deletes auto-follow patterns. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAutoFollowPatternAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) @@ -116,7 +132,9 @@ public virtual Task DeleteAutoFollowPatternAsyn } /// - /// Deletes auto-follow patterns. + /// + /// Deletes auto-follow patterns. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAutoFollowPatternAsync(Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -128,7 +146,9 @@ public virtual Task DeleteAutoFollowPatternAsyn } /// - /// Creates a new follower index configured to follow the referenced leader index. + /// + /// Creates a new follower index configured to follow the referenced leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -139,7 +159,9 @@ public virtual FollowResponse Follow(FollowRequest request) } /// - /// Creates a new follower index configured to follow the referenced leader index. + /// + /// Creates a new follower index configured to follow the referenced leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowAsync(FollowRequest request, CancellationToken cancellationToken = default) @@ -149,7 +171,9 @@ public virtual Task FollowAsync(FollowRequest request, Cancellat } /// - /// Creates a new follower index configured to follow the referenced leader index. + /// + /// Creates a new follower index configured to follow the referenced leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -160,7 +184,9 @@ public virtual FollowResponse Follow(FollowRequestDescriptor - /// Creates a new follower index configured to follow the referenced leader index. + /// + /// Creates a new follower index configured to follow the referenced leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -172,7 +198,9 @@ public virtual FollowResponse Follow(Elastic.Clients.Elasticsearch.In } /// - /// Creates a new follower index configured to follow the referenced leader index. + /// + /// Creates a new follower index configured to follow the referenced leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -185,7 +213,9 @@ public virtual FollowResponse Follow(Elastic.Clients.Elasticsearch.In } /// - /// Creates a new follower index configured to follow the referenced leader index. + /// + /// Creates a new follower index configured to follow the referenced leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -197,7 +227,9 @@ public virtual FollowResponse Follow() } /// - /// Creates a new follower index configured to follow the referenced leader index. + /// + /// Creates a new follower index configured to follow the referenced leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -210,7 +242,9 @@ public virtual FollowResponse Follow(Action - /// Creates a new follower index configured to follow the referenced leader index. + /// + /// Creates a new follower index configured to follow the referenced leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -221,7 +255,9 @@ public virtual FollowResponse Follow(FollowRequestDescriptor descriptor) } /// - /// Creates a new follower index configured to follow the referenced leader index. + /// + /// Creates a new follower index configured to follow the referenced leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -233,7 +269,9 @@ public virtual FollowResponse Follow(Elastic.Clients.Elasticsearch.IndexName ind } /// - /// Creates a new follower index configured to follow the referenced leader index. + /// + /// Creates a new follower index configured to follow the referenced leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -246,7 +284,9 @@ public virtual FollowResponse Follow(Elastic.Clients.Elasticsearch.IndexName ind } /// - /// Creates a new follower index configured to follow the referenced leader index. + /// + /// Creates a new follower index configured to follow the referenced leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowAsync(FollowRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -256,7 +296,9 @@ public virtual Task FollowAsync(FollowRequestDescript } /// - /// Creates a new follower index configured to follow the referenced leader index. + /// + /// Creates a new follower index configured to follow the referenced leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -267,7 +309,9 @@ public virtual Task FollowAsync(Elastic.Clients.Elast } /// - /// Creates a new follower index configured to follow the referenced leader index. + /// + /// Creates a new follower index configured to follow the referenced leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowAsync(Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -279,7 +323,9 @@ public virtual Task FollowAsync(Elastic.Clients.Elast } /// - /// Creates a new follower index configured to follow the referenced leader index. + /// + /// Creates a new follower index configured to follow the referenced leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowAsync(CancellationToken cancellationToken = default) @@ -290,7 +336,9 @@ public virtual Task FollowAsync(CancellationToken can } /// - /// Creates a new follower index configured to follow the referenced leader index. + /// + /// Creates a new follower index configured to follow the referenced leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -302,7 +350,9 @@ public virtual Task FollowAsync(Action - /// Creates a new follower index configured to follow the referenced leader index. + /// + /// Creates a new follower index configured to follow the referenced leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowAsync(FollowRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -312,7 +362,9 @@ public virtual Task FollowAsync(FollowRequestDescriptor descript } /// - /// Creates a new follower index configured to follow the referenced leader index. + /// + /// Creates a new follower index configured to follow the referenced leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -323,7 +375,9 @@ public virtual Task FollowAsync(Elastic.Clients.Elasticsearch.In } /// - /// Creates a new follower index configured to follow the referenced leader index. + /// + /// Creates a new follower index configured to follow the referenced leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowAsync(Elastic.Clients.Elasticsearch.IndexName index, Action configureRequest, CancellationToken cancellationToken = default) @@ -335,7 +389,9 @@ public virtual Task FollowAsync(Elastic.Clients.Elasticsearch.In } /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// + /// Retrieves information about all follower indices, including parameters and status for each follower index + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -346,7 +402,9 @@ public virtual FollowInfoResponse FollowInfo(FollowInfoRequest request) } /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// + /// Retrieves information about all follower indices, including parameters and status for each follower index + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowInfoAsync(FollowInfoRequest request, CancellationToken cancellationToken = default) @@ -356,7 +414,9 @@ public virtual Task FollowInfoAsync(FollowInfoRequest reques } /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// + /// Retrieves information about all follower indices, including parameters and status for each follower index + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -367,7 +427,9 @@ public virtual FollowInfoResponse FollowInfo(FollowInfoRequestDescrip } /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// + /// Retrieves information about all follower indices, including parameters and status for each follower index + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -379,7 +441,9 @@ public virtual FollowInfoResponse FollowInfo(Elastic.Clients.Elastics } /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// + /// Retrieves information about all follower indices, including parameters and status for each follower index + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -392,7 +456,9 @@ public virtual FollowInfoResponse FollowInfo(Elastic.Clients.Elastics } /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// + /// Retrieves information about all follower indices, including parameters and status for each follower index + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -404,7 +470,9 @@ public virtual FollowInfoResponse FollowInfo() } /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// + /// Retrieves information about all follower indices, including parameters and status for each follower index + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -417,7 +485,9 @@ public virtual FollowInfoResponse FollowInfo(Action - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// + /// Retrieves information about all follower indices, including parameters and status for each follower index + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -428,7 +498,9 @@ public virtual FollowInfoResponse FollowInfo(FollowInfoRequestDescriptor descrip } /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// + /// Retrieves information about all follower indices, including parameters and status for each follower index + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -440,7 +512,9 @@ public virtual FollowInfoResponse FollowInfo(Elastic.Clients.Elasticsearch.Indic } /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// + /// Retrieves information about all follower indices, including parameters and status for each follower index + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -453,7 +527,9 @@ public virtual FollowInfoResponse FollowInfo(Elastic.Clients.Elasticsearch.Indic } /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// + /// Retrieves information about all follower indices, including parameters and status for each follower index + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowInfoAsync(FollowInfoRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -463,7 +539,9 @@ public virtual Task FollowInfoAsync(FollowInfoReq } /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// + /// Retrieves information about all follower indices, including parameters and status for each follower index + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowInfoAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -474,7 +552,9 @@ public virtual Task FollowInfoAsync(Elastic.Clien } /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// + /// Retrieves information about all follower indices, including parameters and status for each follower index + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowInfoAsync(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -486,7 +566,9 @@ public virtual Task FollowInfoAsync(Elastic.Clien } /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// + /// Retrieves information about all follower indices, including parameters and status for each follower index + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowInfoAsync(CancellationToken cancellationToken = default) @@ -497,7 +579,9 @@ public virtual Task FollowInfoAsync(CancellationT } /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// + /// Retrieves information about all follower indices, including parameters and status for each follower index + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowInfoAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -509,7 +593,9 @@ public virtual Task FollowInfoAsync(Action - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// + /// Retrieves information about all follower indices, including parameters and status for each follower index + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowInfoAsync(FollowInfoRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -519,7 +605,9 @@ public virtual Task FollowInfoAsync(FollowInfoRequestDescrip } /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// + /// Retrieves information about all follower indices, including parameters and status for each follower index + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowInfoAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -530,7 +618,9 @@ public virtual Task FollowInfoAsync(Elastic.Clients.Elastics } /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// + /// Retrieves information about all follower indices, including parameters and status for each follower index + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowInfoAsync(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -542,7 +632,9 @@ public virtual Task FollowInfoAsync(Elastic.Clients.Elastics } /// - /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// + /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -553,7 +645,9 @@ public virtual FollowStatsResponse FollowStats(FollowStatsRequest request) } /// - /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// + /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowStatsAsync(FollowStatsRequest request, CancellationToken cancellationToken = default) @@ -563,7 +657,9 @@ public virtual Task FollowStatsAsync(FollowStatsRequest req } /// - /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// + /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -574,7 +670,9 @@ public virtual FollowStatsResponse FollowStats(FollowStatsRequestDesc } /// - /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// + /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -586,7 +684,9 @@ public virtual FollowStatsResponse FollowStats(Elastic.Clients.Elasti } /// - /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// + /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -599,7 +699,9 @@ public virtual FollowStatsResponse FollowStats(Elastic.Clients.Elasti } /// - /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// + /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -611,7 +713,9 @@ public virtual FollowStatsResponse FollowStats() } /// - /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// + /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -624,7 +728,9 @@ public virtual FollowStatsResponse FollowStats(Action - /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// + /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -635,7 +741,9 @@ public virtual FollowStatsResponse FollowStats(FollowStatsRequestDescriptor desc } /// - /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// + /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -647,7 +755,9 @@ public virtual FollowStatsResponse FollowStats(Elastic.Clients.Elasticsearch.Ind } /// - /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// + /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -660,7 +770,9 @@ public virtual FollowStatsResponse FollowStats(Elastic.Clients.Elasticsearch.Ind } /// - /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// + /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowStatsAsync(FollowStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -670,7 +782,9 @@ public virtual Task FollowStatsAsync(FollowStats } /// - /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// + /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowStatsAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -681,7 +795,9 @@ public virtual Task FollowStatsAsync(Elastic.Cli } /// - /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// + /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowStatsAsync(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -693,7 +809,9 @@ public virtual Task FollowStatsAsync(Elastic.Cli } /// - /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// + /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowStatsAsync(CancellationToken cancellationToken = default) @@ -704,7 +822,9 @@ public virtual Task FollowStatsAsync(Cancellatio } /// - /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// + /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowStatsAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -716,7 +836,9 @@ public virtual Task FollowStatsAsync(Action - /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// + /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowStatsAsync(FollowStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -726,7 +848,9 @@ public virtual Task FollowStatsAsync(FollowStatsRequestDesc } /// - /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// + /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowStatsAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -737,7 +861,9 @@ public virtual Task FollowStatsAsync(Elastic.Clients.Elasti } /// - /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// + /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowStatsAsync(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -749,7 +875,9 @@ public virtual Task FollowStatsAsync(Elastic.Clients.Elasti } /// - /// Removes the follower retention leases from the leader. + /// + /// Removes the follower retention leases from the leader. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -760,7 +888,9 @@ public virtual ForgetFollowerResponse ForgetFollower(ForgetFollowerRequest reque } /// - /// Removes the follower retention leases from the leader. + /// + /// Removes the follower retention leases from the leader. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForgetFollowerAsync(ForgetFollowerRequest request, CancellationToken cancellationToken = default) @@ -770,7 +900,9 @@ public virtual Task ForgetFollowerAsync(ForgetFollowerRe } /// - /// Removes the follower retention leases from the leader. + /// + /// Removes the follower retention leases from the leader. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -781,7 +913,9 @@ public virtual ForgetFollowerResponse ForgetFollower(ForgetFollowerRe } /// - /// Removes the follower retention leases from the leader. + /// + /// Removes the follower retention leases from the leader. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -793,7 +927,9 @@ public virtual ForgetFollowerResponse ForgetFollower(Elastic.Clients. } /// - /// Removes the follower retention leases from the leader. + /// + /// Removes the follower retention leases from the leader. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -806,7 +942,9 @@ public virtual ForgetFollowerResponse ForgetFollower(Elastic.Clients. } /// - /// Removes the follower retention leases from the leader. + /// + /// Removes the follower retention leases from the leader. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -818,7 +956,9 @@ public virtual ForgetFollowerResponse ForgetFollower() } /// - /// Removes the follower retention leases from the leader. + /// + /// Removes the follower retention leases from the leader. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -831,7 +971,9 @@ public virtual ForgetFollowerResponse ForgetFollower(Action - /// Removes the follower retention leases from the leader. + /// + /// Removes the follower retention leases from the leader. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -842,7 +984,9 @@ public virtual ForgetFollowerResponse ForgetFollower(ForgetFollowerRequestDescri } /// - /// Removes the follower retention leases from the leader. + /// + /// Removes the follower retention leases from the leader. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -854,7 +998,9 @@ public virtual ForgetFollowerResponse ForgetFollower(Elastic.Clients.Elasticsear } /// - /// Removes the follower retention leases from the leader. + /// + /// Removes the follower retention leases from the leader. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -867,7 +1013,9 @@ public virtual ForgetFollowerResponse ForgetFollower(Elastic.Clients.Elasticsear } /// - /// Removes the follower retention leases from the leader. + /// + /// Removes the follower retention leases from the leader. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForgetFollowerAsync(ForgetFollowerRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -877,7 +1025,9 @@ public virtual Task ForgetFollowerAsync(Forge } /// - /// Removes the follower retention leases from the leader. + /// + /// Removes the follower retention leases from the leader. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForgetFollowerAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -888,7 +1038,9 @@ public virtual Task ForgetFollowerAsync(Elast } /// - /// Removes the follower retention leases from the leader. + /// + /// Removes the follower retention leases from the leader. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForgetFollowerAsync(Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -900,7 +1052,9 @@ public virtual Task ForgetFollowerAsync(Elast } /// - /// Removes the follower retention leases from the leader. + /// + /// Removes the follower retention leases from the leader. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForgetFollowerAsync(CancellationToken cancellationToken = default) @@ -911,7 +1065,9 @@ public virtual Task ForgetFollowerAsync(Cance } /// - /// Removes the follower retention leases from the leader. + /// + /// Removes the follower retention leases from the leader. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForgetFollowerAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -923,7 +1079,9 @@ public virtual Task ForgetFollowerAsync(Actio } /// - /// Removes the follower retention leases from the leader. + /// + /// Removes the follower retention leases from the leader. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForgetFollowerAsync(ForgetFollowerRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -933,7 +1091,9 @@ public virtual Task ForgetFollowerAsync(ForgetFollowerRe } /// - /// Removes the follower retention leases from the leader. + /// + /// Removes the follower retention leases from the leader. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForgetFollowerAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -944,7 +1104,9 @@ public virtual Task ForgetFollowerAsync(Elastic.Clients. } /// - /// Removes the follower retention leases from the leader. + /// + /// Removes the follower retention leases from the leader. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForgetFollowerAsync(Elastic.Clients.Elasticsearch.IndexName index, Action configureRequest, CancellationToken cancellationToken = default) @@ -956,7 +1118,9 @@ public virtual Task ForgetFollowerAsync(Elastic.Clients. } /// - /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// + /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -967,7 +1131,9 @@ public virtual GetAutoFollowPatternResponse GetAutoFollowPattern(GetAutoFollowPa } /// - /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// + /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAutoFollowPatternAsync(GetAutoFollowPatternRequest request, CancellationToken cancellationToken = default) @@ -977,7 +1143,9 @@ public virtual Task GetAutoFollowPatternAsync(GetA } /// - /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// + /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -988,7 +1156,9 @@ public virtual GetAutoFollowPatternResponse GetAutoFollowPattern(GetAutoFollowPa } /// - /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// + /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1000,7 +1170,9 @@ public virtual GetAutoFollowPatternResponse GetAutoFollowPattern(Elastic.Clients } /// - /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// + /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1013,7 +1185,9 @@ public virtual GetAutoFollowPatternResponse GetAutoFollowPattern(Elastic.Clients } /// - /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// + /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1025,7 +1199,9 @@ public virtual GetAutoFollowPatternResponse GetAutoFollowPattern() } /// - /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// + /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1038,7 +1214,9 @@ public virtual GetAutoFollowPatternResponse GetAutoFollowPattern(Action - /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// + /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAutoFollowPatternAsync(GetAutoFollowPatternRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1048,7 +1226,9 @@ public virtual Task GetAutoFollowPatternAsync(GetA } /// - /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// + /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAutoFollowPatternAsync(Elastic.Clients.Elasticsearch.Name? name, CancellationToken cancellationToken = default) @@ -1059,7 +1239,9 @@ public virtual Task GetAutoFollowPatternAsync(Elas } /// - /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// + /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAutoFollowPatternAsync(Elastic.Clients.Elasticsearch.Name? name, Action configureRequest, CancellationToken cancellationToken = default) @@ -1071,7 +1253,9 @@ public virtual Task GetAutoFollowPatternAsync(Elas } /// - /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// + /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAutoFollowPatternAsync(CancellationToken cancellationToken = default) @@ -1082,7 +1266,9 @@ public virtual Task GetAutoFollowPatternAsync(Canc } /// - /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// + /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAutoFollowPatternAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -1094,7 +1280,9 @@ public virtual Task GetAutoFollowPatternAsync(Acti } /// - /// Pauses an auto-follow pattern + /// + /// Pauses an auto-follow pattern + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1105,7 +1293,9 @@ public virtual PauseAutoFollowPatternResponse PauseAutoFollowPattern(PauseAutoFo } /// - /// Pauses an auto-follow pattern + /// + /// Pauses an auto-follow pattern + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PauseAutoFollowPatternAsync(PauseAutoFollowPatternRequest request, CancellationToken cancellationToken = default) @@ -1115,7 +1305,9 @@ public virtual Task PauseAutoFollowPatternAsync( } /// - /// Pauses an auto-follow pattern + /// + /// Pauses an auto-follow pattern + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1126,7 +1318,9 @@ public virtual PauseAutoFollowPatternResponse PauseAutoFollowPattern(PauseAutoFo } /// - /// Pauses an auto-follow pattern + /// + /// Pauses an auto-follow pattern + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1138,7 +1332,9 @@ public virtual PauseAutoFollowPatternResponse PauseAutoFollowPattern(Elastic.Cli } /// - /// Pauses an auto-follow pattern + /// + /// Pauses an auto-follow pattern + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1151,7 +1347,9 @@ public virtual PauseAutoFollowPatternResponse PauseAutoFollowPattern(Elastic.Cli } /// - /// Pauses an auto-follow pattern + /// + /// Pauses an auto-follow pattern + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PauseAutoFollowPatternAsync(PauseAutoFollowPatternRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1161,7 +1359,9 @@ public virtual Task PauseAutoFollowPatternAsync( } /// - /// Pauses an auto-follow pattern + /// + /// Pauses an auto-follow pattern + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PauseAutoFollowPatternAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) @@ -1172,7 +1372,9 @@ public virtual Task PauseAutoFollowPatternAsync( } /// - /// Pauses an auto-follow pattern + /// + /// Pauses an auto-follow pattern + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PauseAutoFollowPatternAsync(Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -1184,7 +1386,9 @@ public virtual Task PauseAutoFollowPatternAsync( } /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// + /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1195,7 +1399,9 @@ public virtual PauseFollowResponse PauseFollow(PauseFollowRequest request) } /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// + /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PauseFollowAsync(PauseFollowRequest request, CancellationToken cancellationToken = default) @@ -1205,7 +1411,9 @@ public virtual Task PauseFollowAsync(PauseFollowRequest req } /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// + /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1216,7 +1424,9 @@ public virtual PauseFollowResponse PauseFollow(PauseFollowRequestDesc } /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// + /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1228,7 +1438,9 @@ public virtual PauseFollowResponse PauseFollow(Elastic.Clients.Elasti } /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// + /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1241,7 +1453,9 @@ public virtual PauseFollowResponse PauseFollow(Elastic.Clients.Elasti } /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// + /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1253,7 +1467,9 @@ public virtual PauseFollowResponse PauseFollow() } /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// + /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1266,7 +1482,9 @@ public virtual PauseFollowResponse PauseFollow(Action - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// + /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1277,7 +1495,9 @@ public virtual PauseFollowResponse PauseFollow(PauseFollowRequestDescriptor desc } /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// + /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1289,7 +1509,9 @@ public virtual PauseFollowResponse PauseFollow(Elastic.Clients.Elasticsearch.Ind } /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// + /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1302,7 +1524,9 @@ public virtual PauseFollowResponse PauseFollow(Elastic.Clients.Elasticsearch.Ind } /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// + /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PauseFollowAsync(PauseFollowRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1312,7 +1536,9 @@ public virtual Task PauseFollowAsync(PauseFollow } /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// + /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PauseFollowAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -1323,7 +1549,9 @@ public virtual Task PauseFollowAsync(Elastic.Cli } /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// + /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PauseFollowAsync(Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1335,7 +1563,9 @@ public virtual Task PauseFollowAsync(Elastic.Cli } /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// + /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PauseFollowAsync(CancellationToken cancellationToken = default) @@ -1346,7 +1576,9 @@ public virtual Task PauseFollowAsync(Cancellatio } /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// + /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PauseFollowAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -1358,7 +1590,9 @@ public virtual Task PauseFollowAsync(Action - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// + /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PauseFollowAsync(PauseFollowRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1368,7 +1602,9 @@ public virtual Task PauseFollowAsync(PauseFollowRequestDesc } /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// + /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PauseFollowAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -1379,7 +1615,9 @@ public virtual Task PauseFollowAsync(Elastic.Clients.Elasti } /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// + /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PauseFollowAsync(Elastic.Clients.Elasticsearch.IndexName index, Action configureRequest, CancellationToken cancellationToken = default) @@ -1391,7 +1629,9 @@ public virtual Task PauseFollowAsync(Elastic.Clients.Elasti } /// - /// Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. + /// + /// Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1402,7 +1642,9 @@ public virtual PutAutoFollowPatternResponse PutAutoFollowPattern(PutAutoFollowPa } /// - /// Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. + /// + /// Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAutoFollowPatternAsync(PutAutoFollowPatternRequest request, CancellationToken cancellationToken = default) @@ -1412,7 +1654,9 @@ public virtual Task PutAutoFollowPatternAsync(PutA } /// - /// Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. + /// + /// Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1423,7 +1667,9 @@ public virtual PutAutoFollowPatternResponse PutAutoFollowPattern(PutAutoFollowPa } /// - /// Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. + /// + /// Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1435,7 +1681,9 @@ public virtual PutAutoFollowPatternResponse PutAutoFollowPattern(Elastic.Clients } /// - /// Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. + /// + /// Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1448,7 +1696,9 @@ public virtual PutAutoFollowPatternResponse PutAutoFollowPattern(Elastic.Clients } /// - /// Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. + /// + /// Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAutoFollowPatternAsync(PutAutoFollowPatternRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1458,7 +1708,9 @@ public virtual Task PutAutoFollowPatternAsync(PutA } /// - /// Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. + /// + /// Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAutoFollowPatternAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) @@ -1469,7 +1721,9 @@ public virtual Task PutAutoFollowPatternAsync(Elas } /// - /// Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. + /// + /// Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAutoFollowPatternAsync(Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -1481,7 +1735,9 @@ public virtual Task PutAutoFollowPatternAsync(Elas } /// - /// Resumes an auto-follow pattern that has been paused + /// + /// Resumes an auto-follow pattern that has been paused + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1492,7 +1748,9 @@ public virtual ResumeAutoFollowPatternResponse ResumeAutoFollowPattern(ResumeAut } /// - /// Resumes an auto-follow pattern that has been paused + /// + /// Resumes an auto-follow pattern that has been paused + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResumeAutoFollowPatternAsync(ResumeAutoFollowPatternRequest request, CancellationToken cancellationToken = default) @@ -1502,7 +1760,9 @@ public virtual Task ResumeAutoFollowPatternAsyn } /// - /// Resumes an auto-follow pattern that has been paused + /// + /// Resumes an auto-follow pattern that has been paused + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1513,7 +1773,9 @@ public virtual ResumeAutoFollowPatternResponse ResumeAutoFollowPattern(ResumeAut } /// - /// Resumes an auto-follow pattern that has been paused + /// + /// Resumes an auto-follow pattern that has been paused + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1525,7 +1787,9 @@ public virtual ResumeAutoFollowPatternResponse ResumeAutoFollowPattern(Elastic.C } /// - /// Resumes an auto-follow pattern that has been paused + /// + /// Resumes an auto-follow pattern that has been paused + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1538,7 +1802,9 @@ public virtual ResumeAutoFollowPatternResponse ResumeAutoFollowPattern(Elastic.C } /// - /// Resumes an auto-follow pattern that has been paused + /// + /// Resumes an auto-follow pattern that has been paused + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResumeAutoFollowPatternAsync(ResumeAutoFollowPatternRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1548,7 +1814,9 @@ public virtual Task ResumeAutoFollowPatternAsyn } /// - /// Resumes an auto-follow pattern that has been paused + /// + /// Resumes an auto-follow pattern that has been paused + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResumeAutoFollowPatternAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) @@ -1559,7 +1827,9 @@ public virtual Task ResumeAutoFollowPatternAsyn } /// - /// Resumes an auto-follow pattern that has been paused + /// + /// Resumes an auto-follow pattern that has been paused + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResumeAutoFollowPatternAsync(Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -1571,7 +1841,9 @@ public virtual Task ResumeAutoFollowPatternAsyn } /// - /// Resumes a follower index that has been paused + /// + /// Resumes a follower index that has been paused + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1582,7 +1854,9 @@ public virtual ResumeFollowResponse ResumeFollow(ResumeFollowRequest request) } /// - /// Resumes a follower index that has been paused + /// + /// Resumes a follower index that has been paused + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResumeFollowAsync(ResumeFollowRequest request, CancellationToken cancellationToken = default) @@ -1592,7 +1866,9 @@ public virtual Task ResumeFollowAsync(ResumeFollowRequest } /// - /// Resumes a follower index that has been paused + /// + /// Resumes a follower index that has been paused + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1603,7 +1879,9 @@ public virtual ResumeFollowResponse ResumeFollow(ResumeFollowRequestD } /// - /// Resumes a follower index that has been paused + /// + /// Resumes a follower index that has been paused + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1615,7 +1893,9 @@ public virtual ResumeFollowResponse ResumeFollow(Elastic.Clients.Elas } /// - /// Resumes a follower index that has been paused + /// + /// Resumes a follower index that has been paused + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1628,7 +1908,9 @@ public virtual ResumeFollowResponse ResumeFollow(Elastic.Clients.Elas } /// - /// Resumes a follower index that has been paused + /// + /// Resumes a follower index that has been paused + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1640,7 +1922,9 @@ public virtual ResumeFollowResponse ResumeFollow() } /// - /// Resumes a follower index that has been paused + /// + /// Resumes a follower index that has been paused + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1653,7 +1937,9 @@ public virtual ResumeFollowResponse ResumeFollow(Action - /// Resumes a follower index that has been paused + /// + /// Resumes a follower index that has been paused + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1664,7 +1950,9 @@ public virtual ResumeFollowResponse ResumeFollow(ResumeFollowRequestDescriptor d } /// - /// Resumes a follower index that has been paused + /// + /// Resumes a follower index that has been paused + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1676,7 +1964,9 @@ public virtual ResumeFollowResponse ResumeFollow(Elastic.Clients.Elasticsearch.I } /// - /// Resumes a follower index that has been paused + /// + /// Resumes a follower index that has been paused + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1689,7 +1979,9 @@ public virtual ResumeFollowResponse ResumeFollow(Elastic.Clients.Elasticsearch.I } /// - /// Resumes a follower index that has been paused + /// + /// Resumes a follower index that has been paused + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResumeFollowAsync(ResumeFollowRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1699,7 +1991,9 @@ public virtual Task ResumeFollowAsync(ResumeFol } /// - /// Resumes a follower index that has been paused + /// + /// Resumes a follower index that has been paused + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResumeFollowAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -1710,7 +2004,9 @@ public virtual Task ResumeFollowAsync(Elastic.C } /// - /// Resumes a follower index that has been paused + /// + /// Resumes a follower index that has been paused + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResumeFollowAsync(Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1722,7 +2018,9 @@ public virtual Task ResumeFollowAsync(Elastic.C } /// - /// Resumes a follower index that has been paused + /// + /// Resumes a follower index that has been paused + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResumeFollowAsync(CancellationToken cancellationToken = default) @@ -1733,7 +2031,9 @@ public virtual Task ResumeFollowAsync(Cancellat } /// - /// Resumes a follower index that has been paused + /// + /// Resumes a follower index that has been paused + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResumeFollowAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -1745,7 +2045,9 @@ public virtual Task ResumeFollowAsync(Action - /// Resumes a follower index that has been paused + /// + /// Resumes a follower index that has been paused + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResumeFollowAsync(ResumeFollowRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1755,7 +2057,9 @@ public virtual Task ResumeFollowAsync(ResumeFollowRequestD } /// - /// Resumes a follower index that has been paused + /// + /// Resumes a follower index that has been paused + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResumeFollowAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -1766,7 +2070,9 @@ public virtual Task ResumeFollowAsync(Elastic.Clients.Elas } /// - /// Resumes a follower index that has been paused + /// + /// Resumes a follower index that has been paused + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResumeFollowAsync(Elastic.Clients.Elasticsearch.IndexName index, Action configureRequest, CancellationToken cancellationToken = default) @@ -1778,7 +2084,9 @@ public virtual Task ResumeFollowAsync(Elastic.Clients.Elas } /// - /// Gets all stats related to cross-cluster replication. + /// + /// Gets all stats related to cross-cluster replication. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1789,7 +2097,9 @@ public virtual CcrStatsResponse Stats(CcrStatsRequest request) } /// - /// Gets all stats related to cross-cluster replication. + /// + /// Gets all stats related to cross-cluster replication. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(CcrStatsRequest request, CancellationToken cancellationToken = default) @@ -1799,7 +2109,9 @@ public virtual Task StatsAsync(CcrStatsRequest request, Cancel } /// - /// Gets all stats related to cross-cluster replication. + /// + /// Gets all stats related to cross-cluster replication. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1810,7 +2122,9 @@ public virtual CcrStatsResponse Stats(CcrStatsRequestDescriptor descriptor) } /// - /// Gets all stats related to cross-cluster replication. + /// + /// Gets all stats related to cross-cluster replication. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1822,7 +2136,9 @@ public virtual CcrStatsResponse Stats() } /// - /// Gets all stats related to cross-cluster replication. + /// + /// Gets all stats related to cross-cluster replication. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1835,7 +2151,9 @@ public virtual CcrStatsResponse Stats(Action configur } /// - /// Gets all stats related to cross-cluster replication. + /// + /// Gets all stats related to cross-cluster replication. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(CcrStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1845,7 +2163,9 @@ public virtual Task StatsAsync(CcrStatsRequestDescriptor descr } /// - /// Gets all stats related to cross-cluster replication. + /// + /// Gets all stats related to cross-cluster replication. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(CancellationToken cancellationToken = default) @@ -1856,7 +2176,9 @@ public virtual Task StatsAsync(CancellationToken cancellationT } /// - /// Gets all stats related to cross-cluster replication. + /// + /// Gets all stats related to cross-cluster replication. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -1868,7 +2190,9 @@ public virtual Task StatsAsync(Action - /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// + /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1879,7 +2203,9 @@ public virtual UnfollowResponse Unfollow(UnfollowRequest request) } /// - /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// + /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UnfollowAsync(UnfollowRequest request, CancellationToken cancellationToken = default) @@ -1889,7 +2215,9 @@ public virtual Task UnfollowAsync(UnfollowRequest request, Can } /// - /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// + /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1900,7 +2228,9 @@ public virtual UnfollowResponse Unfollow(UnfollowRequestDescriptor - /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// + /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1912,7 +2242,9 @@ public virtual UnfollowResponse Unfollow(Elastic.Clients.Elasticsearc } /// - /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// + /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1925,7 +2257,9 @@ public virtual UnfollowResponse Unfollow(Elastic.Clients.Elasticsearc } /// - /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// + /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1937,7 +2271,9 @@ public virtual UnfollowResponse Unfollow() } /// - /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// + /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1950,7 +2286,9 @@ public virtual UnfollowResponse Unfollow(Action - /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// + /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1961,7 +2299,9 @@ public virtual UnfollowResponse Unfollow(UnfollowRequestDescriptor descriptor) } /// - /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// + /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1973,7 +2313,9 @@ public virtual UnfollowResponse Unfollow(Elastic.Clients.Elasticsearch.IndexName } /// - /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// + /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1986,7 +2328,9 @@ public virtual UnfollowResponse Unfollow(Elastic.Clients.Elasticsearch.IndexName } /// - /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// + /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UnfollowAsync(UnfollowRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1996,7 +2340,9 @@ public virtual Task UnfollowAsync(UnfollowRequestDe } /// - /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// + /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UnfollowAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -2007,7 +2353,9 @@ public virtual Task UnfollowAsync(Elastic.Clients.E } /// - /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// + /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UnfollowAsync(Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2019,7 +2367,9 @@ public virtual Task UnfollowAsync(Elastic.Clients.E } /// - /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// + /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UnfollowAsync(CancellationToken cancellationToken = default) @@ -2030,7 +2380,9 @@ public virtual Task UnfollowAsync(CancellationToken } /// - /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// + /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UnfollowAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -2042,7 +2394,9 @@ public virtual Task UnfollowAsync(Action - /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// + /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UnfollowAsync(UnfollowRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2052,7 +2406,9 @@ public virtual Task UnfollowAsync(UnfollowRequestDescriptor de } /// - /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// + /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UnfollowAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -2063,7 +2419,9 @@ public virtual Task UnfollowAsync(Elastic.Clients.Elasticsearc } /// - /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// + /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UnfollowAsync(Elastic.Clients.Elasticsearch.IndexName index, Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Cluster.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Cluster.g.cs index 2e38773fed1..403230de812 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Cluster.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Cluster.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public partial class ClusterNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected ClusterNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal ClusterNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// Provides explanations for shard allocations in the cluster. + /// + /// Provides explanations for shard allocations in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -49,7 +53,9 @@ public virtual AllocationExplainResponse AllocationExplain(AllocationExplainRequ } /// - /// Provides explanations for shard allocations in the cluster. + /// + /// Provides explanations for shard allocations in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AllocationExplainAsync(AllocationExplainRequest request, CancellationToken cancellationToken = default) @@ -59,7 +65,9 @@ public virtual Task AllocationExplainAsync(Allocation } /// - /// Provides explanations for shard allocations in the cluster. + /// + /// Provides explanations for shard allocations in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -70,7 +78,9 @@ public virtual AllocationExplainResponse AllocationExplain(AllocationExplainRequ } /// - /// Provides explanations for shard allocations in the cluster. + /// + /// Provides explanations for shard allocations in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -82,7 +92,9 @@ public virtual AllocationExplainResponse AllocationExplain() } /// - /// Provides explanations for shard allocations in the cluster. + /// + /// Provides explanations for shard allocations in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -95,7 +107,9 @@ public virtual AllocationExplainResponse AllocationExplain(Action - /// Provides explanations for shard allocations in the cluster. + /// + /// Provides explanations for shard allocations in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AllocationExplainAsync(AllocationExplainRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -105,7 +119,9 @@ public virtual Task AllocationExplainAsync(Allocation } /// - /// Provides explanations for shard allocations in the cluster. + /// + /// Provides explanations for shard allocations in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AllocationExplainAsync(CancellationToken cancellationToken = default) @@ -116,7 +132,9 @@ public virtual Task AllocationExplainAsync(Cancellati } /// - /// Provides explanations for shard allocations in the cluster. + /// + /// Provides explanations for shard allocations in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AllocationExplainAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -128,7 +146,11 @@ public virtual Task AllocationExplainAsync(Action - /// Delete component templates.
Deletes component templates.
Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. + /// + /// Delete component templates. + /// Deletes component templates. + /// Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -139,7 +161,11 @@ public virtual DeleteComponentTemplateResponse DeleteComponentTemplate(DeleteCom } /// - /// Delete component templates.
Deletes component templates.
Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. + /// + /// Delete component templates. + /// Deletes component templates. + /// Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteComponentTemplateAsync(DeleteComponentTemplateRequest request, CancellationToken cancellationToken = default) @@ -149,7 +175,11 @@ public virtual Task DeleteComponentTemplateAsyn } /// - /// Delete component templates.
Deletes component templates.
Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. + /// + /// Delete component templates. + /// Deletes component templates. + /// Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -160,7 +190,11 @@ public virtual DeleteComponentTemplateResponse DeleteComponentTemplate(DeleteCom } /// - /// Delete component templates.
Deletes component templates.
Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. + /// + /// Delete component templates. + /// Deletes component templates. + /// Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -172,7 +206,11 @@ public virtual DeleteComponentTemplateResponse DeleteComponentTemplate(Elastic.C } /// - /// Delete component templates.
Deletes component templates.
Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. + /// + /// Delete component templates. + /// Deletes component templates. + /// Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -185,7 +223,11 @@ public virtual DeleteComponentTemplateResponse DeleteComponentTemplate(Elastic.C } /// - /// Delete component templates.
Deletes component templates.
Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. + /// + /// Delete component templates. + /// Deletes component templates. + /// Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteComponentTemplateAsync(DeleteComponentTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -195,7 +237,11 @@ public virtual Task DeleteComponentTemplateAsyn } /// - /// Delete component templates.
Deletes component templates.
Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. + /// + /// Delete component templates. + /// Deletes component templates. + /// Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteComponentTemplateAsync(Elastic.Clients.Elasticsearch.Names name, CancellationToken cancellationToken = default) @@ -206,7 +252,11 @@ public virtual Task DeleteComponentTemplateAsyn } /// - /// Delete component templates.
Deletes component templates.
Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. + /// + /// Delete component templates. + /// Deletes component templates. + /// Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteComponentTemplateAsync(Elastic.Clients.Elasticsearch.Names name, Action configureRequest, CancellationToken cancellationToken = default) @@ -218,7 +268,9 @@ public virtual Task DeleteComponentTemplateAsyn } /// - /// Clears cluster voting config exclusions. + /// + /// Clears cluster voting config exclusions. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -229,7 +281,9 @@ public virtual DeleteVotingConfigExclusionsResponse DeleteVotingConfigExclusions } /// - /// Clears cluster voting config exclusions. + /// + /// Clears cluster voting config exclusions. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteVotingConfigExclusionsAsync(DeleteVotingConfigExclusionsRequest request, CancellationToken cancellationToken = default) @@ -239,7 +293,9 @@ public virtual Task DeleteVotingConfigExcl } /// - /// Clears cluster voting config exclusions. + /// + /// Clears cluster voting config exclusions. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -250,7 +306,9 @@ public virtual DeleteVotingConfigExclusionsResponse DeleteVotingConfigExclusions } /// - /// Clears cluster voting config exclusions. + /// + /// Clears cluster voting config exclusions. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -262,7 +320,9 @@ public virtual DeleteVotingConfigExclusionsResponse DeleteVotingConfigExclusions } /// - /// Clears cluster voting config exclusions. + /// + /// Clears cluster voting config exclusions. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -275,7 +335,9 @@ public virtual DeleteVotingConfigExclusionsResponse DeleteVotingConfigExclusions } /// - /// Clears cluster voting config exclusions. + /// + /// Clears cluster voting config exclusions. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteVotingConfigExclusionsAsync(DeleteVotingConfigExclusionsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -285,7 +347,9 @@ public virtual Task DeleteVotingConfigExcl } /// - /// Clears cluster voting config exclusions. + /// + /// Clears cluster voting config exclusions. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteVotingConfigExclusionsAsync(CancellationToken cancellationToken = default) @@ -296,7 +360,9 @@ public virtual Task DeleteVotingConfigExcl } /// - /// Clears cluster voting config exclusions. + /// + /// Clears cluster voting config exclusions. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteVotingConfigExclusionsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -308,7 +374,10 @@ public virtual Task DeleteVotingConfigExcl } /// - /// Check component templates.
Returns information about whether a particular component template exists. + /// + /// Check component templates. + /// Returns information about whether a particular component template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -319,7 +388,10 @@ public virtual ExistsComponentTemplateResponse ExistsComponentTemplate(ExistsCom } /// - /// Check component templates.
Returns information about whether a particular component template exists. + /// + /// Check component templates. + /// Returns information about whether a particular component template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsComponentTemplateAsync(ExistsComponentTemplateRequest request, CancellationToken cancellationToken = default) @@ -329,7 +401,10 @@ public virtual Task ExistsComponentTemplateAsyn } /// - /// Check component templates.
Returns information about whether a particular component template exists. + /// + /// Check component templates. + /// Returns information about whether a particular component template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -340,7 +415,10 @@ public virtual ExistsComponentTemplateResponse ExistsComponentTemplate(ExistsCom } /// - /// Check component templates.
Returns information about whether a particular component template exists. + /// + /// Check component templates. + /// Returns information about whether a particular component template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -352,7 +430,10 @@ public virtual ExistsComponentTemplateResponse ExistsComponentTemplate(Elastic.C } /// - /// Check component templates.
Returns information about whether a particular component template exists. + /// + /// Check component templates. + /// Returns information about whether a particular component template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -365,7 +446,10 @@ public virtual ExistsComponentTemplateResponse ExistsComponentTemplate(Elastic.C } /// - /// Check component templates.
Returns information about whether a particular component template exists. + /// + /// Check component templates. + /// Returns information about whether a particular component template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsComponentTemplateAsync(ExistsComponentTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -375,7 +459,10 @@ public virtual Task ExistsComponentTemplateAsyn } /// - /// Check component templates.
Returns information about whether a particular component template exists. + /// + /// Check component templates. + /// Returns information about whether a particular component template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsComponentTemplateAsync(Elastic.Clients.Elasticsearch.Names name, CancellationToken cancellationToken = default) @@ -386,7 +473,10 @@ public virtual Task ExistsComponentTemplateAsyn } /// - /// Check component templates.
Returns information about whether a particular component template exists. + /// + /// Check component templates. + /// Returns information about whether a particular component template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsComponentTemplateAsync(Elastic.Clients.Elasticsearch.Names name, Action configureRequest, CancellationToken cancellationToken = default) @@ -398,7 +488,10 @@ public virtual Task ExistsComponentTemplateAsyn } /// - /// Get component templates.
Retrieves information about component templates. + /// + /// Get component templates. + /// Retrieves information about component templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -409,7 +502,10 @@ public virtual GetComponentTemplateResponse GetComponentTemplate(GetComponentTem } /// - /// Get component templates.
Retrieves information about component templates. + /// + /// Get component templates. + /// Retrieves information about component templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetComponentTemplateAsync(GetComponentTemplateRequest request, CancellationToken cancellationToken = default) @@ -419,7 +515,10 @@ public virtual Task GetComponentTemplateAsync(GetC } /// - /// Get component templates.
Retrieves information about component templates. + /// + /// Get component templates. + /// Retrieves information about component templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -430,7 +529,10 @@ public virtual GetComponentTemplateResponse GetComponentTemplate(GetComponentTem } /// - /// Get component templates.
Retrieves information about component templates. + /// + /// Get component templates. + /// Retrieves information about component templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -442,7 +544,10 @@ public virtual GetComponentTemplateResponse GetComponentTemplate(Elastic.Clients } /// - /// Get component templates.
Retrieves information about component templates. + /// + /// Get component templates. + /// Retrieves information about component templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -455,7 +560,10 @@ public virtual GetComponentTemplateResponse GetComponentTemplate(Elastic.Clients } /// - /// Get component templates.
Retrieves information about component templates. + /// + /// Get component templates. + /// Retrieves information about component templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -467,7 +575,10 @@ public virtual GetComponentTemplateResponse GetComponentTemplate() } /// - /// Get component templates.
Retrieves information about component templates. + /// + /// Get component templates. + /// Retrieves information about component templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -480,7 +591,10 @@ public virtual GetComponentTemplateResponse GetComponentTemplate(Action - /// Get component templates.
Retrieves information about component templates. + /// + /// Get component templates. + /// Retrieves information about component templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetComponentTemplateAsync(GetComponentTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -490,7 +604,10 @@ public virtual Task GetComponentTemplateAsync(GetC } /// - /// Get component templates.
Retrieves information about component templates. + /// + /// Get component templates. + /// Retrieves information about component templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetComponentTemplateAsync(Elastic.Clients.Elasticsearch.Name? name, CancellationToken cancellationToken = default) @@ -501,7 +618,10 @@ public virtual Task GetComponentTemplateAsync(Elas } /// - /// Get component templates.
Retrieves information about component templates. + /// + /// Get component templates. + /// Retrieves information about component templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetComponentTemplateAsync(Elastic.Clients.Elasticsearch.Name? name, Action configureRequest, CancellationToken cancellationToken = default) @@ -513,7 +633,10 @@ public virtual Task GetComponentTemplateAsync(Elas } /// - /// Get component templates.
Retrieves information about component templates. + /// + /// Get component templates. + /// Retrieves information about component templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetComponentTemplateAsync(CancellationToken cancellationToken = default) @@ -524,7 +647,10 @@ public virtual Task GetComponentTemplateAsync(Canc } /// - /// Get component templates.
Retrieves information about component templates. + /// + /// Get component templates. + /// Retrieves information about component templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetComponentTemplateAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -536,7 +662,10 @@ public virtual Task GetComponentTemplateAsync(Acti } /// - /// Returns cluster-wide settings.
By default, it returns only settings that have been explicitly defined. + /// + /// Returns cluster-wide settings. + /// By default, it returns only settings that have been explicitly defined. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -547,7 +676,10 @@ public virtual GetClusterSettingsResponse GetSettings(GetClusterSettingsRequest } /// - /// Returns cluster-wide settings.
By default, it returns only settings that have been explicitly defined. + /// + /// Returns cluster-wide settings. + /// By default, it returns only settings that have been explicitly defined. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(GetClusterSettingsRequest request, CancellationToken cancellationToken = default) @@ -557,7 +689,10 @@ public virtual Task GetSettingsAsync(GetClusterSetti } /// - /// Returns cluster-wide settings.
By default, it returns only settings that have been explicitly defined. + /// + /// Returns cluster-wide settings. + /// By default, it returns only settings that have been explicitly defined. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -568,7 +703,10 @@ public virtual GetClusterSettingsResponse GetSettings(GetClusterSettingsRequestD } /// - /// Returns cluster-wide settings.
By default, it returns only settings that have been explicitly defined. + /// + /// Returns cluster-wide settings. + /// By default, it returns only settings that have been explicitly defined. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -580,7 +718,10 @@ public virtual GetClusterSettingsResponse GetSettings() } /// - /// Returns cluster-wide settings.
By default, it returns only settings that have been explicitly defined. + /// + /// Returns cluster-wide settings. + /// By default, it returns only settings that have been explicitly defined. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -593,7 +734,10 @@ public virtual GetClusterSettingsResponse GetSettings(Action - /// Returns cluster-wide settings.
By default, it returns only settings that have been explicitly defined. + /// + /// Returns cluster-wide settings. + /// By default, it returns only settings that have been explicitly defined. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(GetClusterSettingsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -603,7 +747,10 @@ public virtual Task GetSettingsAsync(GetClusterSetti } /// - /// Returns cluster-wide settings.
By default, it returns only settings that have been explicitly defined. + /// + /// Returns cluster-wide settings. + /// By default, it returns only settings that have been explicitly defined. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(CancellationToken cancellationToken = default) @@ -614,7 +761,10 @@ public virtual Task GetSettingsAsync(CancellationTok } /// - /// Returns cluster-wide settings.
By default, it returns only settings that have been explicitly defined. + /// + /// Returns cluster-wide settings. + /// By default, it returns only settings that have been explicitly defined. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -626,7 +776,10 @@ public virtual Task GetSettingsAsync(Action - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -637,7 +790,10 @@ public virtual HealthResponse Health(HealthRequest request) } /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(HealthRequest request, CancellationToken cancellationToken = default) @@ -647,7 +803,10 @@ public virtual Task HealthAsync(HealthRequest request, Cancellat } /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -658,7 +817,10 @@ public virtual HealthResponse Health(HealthRequestDescriptor - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -670,7 +832,10 @@ public virtual HealthResponse Health(Elastic.Clients.Elasticsearch.In } /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -683,7 +848,10 @@ public virtual HealthResponse Health(Elastic.Clients.Elasticsearch.In } /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -695,7 +863,10 @@ public virtual HealthResponse Health() } /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -708,7 +879,10 @@ public virtual HealthResponse Health(Action - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -719,7 +893,10 @@ public virtual HealthResponse Health(HealthRequestDescriptor descriptor) } /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -731,7 +908,10 @@ public virtual HealthResponse Health(Elastic.Clients.Elasticsearch.Indices? indi } /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -744,7 +924,10 @@ public virtual HealthResponse Health(Elastic.Clients.Elasticsearch.Indices? indi } /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -756,7 +939,10 @@ public virtual HealthResponse Health() } /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -769,7 +955,10 @@ public virtual HealthResponse Health(Action configureRe } /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(HealthRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -779,7 +968,10 @@ public virtual Task HealthAsync(HealthRequestDescript } /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -790,7 +982,10 @@ public virtual Task HealthAsync(Elastic.Clients.Elast } /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -802,7 +997,10 @@ public virtual Task HealthAsync(Elastic.Clients.Elast } /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(CancellationToken cancellationToken = default) @@ -813,7 +1011,10 @@ public virtual Task HealthAsync(CancellationToken can } /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -825,7 +1026,10 @@ public virtual Task HealthAsync(Action - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(HealthRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -835,7 +1039,10 @@ public virtual Task HealthAsync(HealthRequestDescriptor descript } /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -846,7 +1053,10 @@ public virtual Task HealthAsync(Elastic.Clients.Elasticsearch.In } /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -858,7 +1068,10 @@ public virtual Task HealthAsync(Elastic.Clients.Elasticsearch.In } /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(CancellationToken cancellationToken = default) @@ -869,7 +1082,10 @@ public virtual Task HealthAsync(CancellationToken cancellationTo } /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// + /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. + /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -881,7 +1097,10 @@ public virtual Task HealthAsync(Action } /// - /// Get cluster info.
Returns basic information about the cluster. + /// + /// Get cluster info. + /// Returns basic information about the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -892,7 +1111,10 @@ public virtual ClusterInfoResponse Info(ClusterInfoRequest request) } /// - /// Get cluster info.
Returns basic information about the cluster. + /// + /// Get cluster info. + /// Returns basic information about the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(ClusterInfoRequest request, CancellationToken cancellationToken = default) @@ -902,7 +1124,10 @@ public virtual Task InfoAsync(ClusterInfoRequest request, C } /// - /// Get cluster info.
Returns basic information about the cluster. + /// + /// Get cluster info. + /// Returns basic information about the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -913,7 +1138,10 @@ public virtual ClusterInfoResponse Info(ClusterInfoRequestDescriptor descriptor) } /// - /// Get cluster info.
Returns basic information about the cluster. + /// + /// Get cluster info. + /// Returns basic information about the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -925,7 +1153,10 @@ public virtual ClusterInfoResponse Info(IReadOnlyCollection - /// Get cluster info.
Returns basic information about the cluster. + /// + /// Get cluster info. + /// Returns basic information about the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -938,7 +1169,10 @@ public virtual ClusterInfoResponse Info(IReadOnlyCollection - /// Get cluster info.
Returns basic information about the cluster. + /// + /// Get cluster info. + /// Returns basic information about the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(ClusterInfoRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -948,7 +1182,10 @@ public virtual Task InfoAsync(ClusterInfoRequestDescriptor } /// - /// Get cluster info.
Returns basic information about the cluster. + /// + /// Get cluster info. + /// Returns basic information about the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(IReadOnlyCollection target, CancellationToken cancellationToken = default) @@ -959,7 +1196,10 @@ public virtual Task InfoAsync(IReadOnlyCollection - /// Get cluster info.
Returns basic information about the cluster. + /// + /// Get cluster info. + /// Returns basic information about the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(IReadOnlyCollection target, Action configureRequest, CancellationToken cancellationToken = default) @@ -971,7 +1211,12 @@ public virtual Task InfoAsync(IReadOnlyCollection - /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed.
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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests.
However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. + /// + /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. + /// 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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. + /// However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -982,7 +1227,12 @@ public virtual PendingTasksResponse PendingTasks(PendingTasksRequest request) } /// - /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed.
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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests.
However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. + /// + /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. + /// 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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. + /// However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PendingTasksAsync(PendingTasksRequest request, CancellationToken cancellationToken = default) @@ -992,7 +1242,12 @@ public virtual Task PendingTasksAsync(PendingTasksRequest } /// - /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed.
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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests.
However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. + /// + /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. + /// 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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. + /// However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1003,7 +1258,12 @@ public virtual PendingTasksResponse PendingTasks(PendingTasksRequestDescriptor d } /// - /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed.
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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests.
However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. + /// + /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. + /// 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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. + /// However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1015,7 +1275,12 @@ public virtual PendingTasksResponse PendingTasks() } /// - /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed.
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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests.
However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. + /// + /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. + /// 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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. + /// However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1028,7 +1293,12 @@ public virtual PendingTasksResponse PendingTasks(Action - /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed.
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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests.
However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. + /// + /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. + /// 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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. + /// However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PendingTasksAsync(PendingTasksRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1038,7 +1308,12 @@ public virtual Task PendingTasksAsync(PendingTasksRequestD } /// - /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed.
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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests.
However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. + /// + /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. + /// 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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. + /// However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PendingTasksAsync(CancellationToken cancellationToken = default) @@ -1049,7 +1324,12 @@ public virtual Task PendingTasksAsync(CancellationToken ca } /// - /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed.
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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests.
However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. + /// + /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. + /// 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 include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. + /// However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PendingTasksAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -1061,7 +1341,9 @@ public virtual Task PendingTasksAsync(Action - /// Updates the cluster voting config exclusions by node ids or node names. + /// + /// Updates the cluster voting config exclusions by node ids or node names. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1072,7 +1354,9 @@ public virtual PostVotingConfigExclusionsResponse PostVotingConfigExclusions(Pos } /// - /// Updates the cluster voting config exclusions by node ids or node names. + /// + /// Updates the cluster voting config exclusions by node ids or node names. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostVotingConfigExclusionsAsync(PostVotingConfigExclusionsRequest request, CancellationToken cancellationToken = default) @@ -1082,7 +1366,9 @@ public virtual Task PostVotingConfigExclusio } /// - /// Updates the cluster voting config exclusions by node ids or node names. + /// + /// Updates the cluster voting config exclusions by node ids or node names. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1093,7 +1379,9 @@ public virtual PostVotingConfigExclusionsResponse PostVotingConfigExclusions(Pos } /// - /// Updates the cluster voting config exclusions by node ids or node names. + /// + /// Updates the cluster voting config exclusions by node ids or node names. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1105,7 +1393,9 @@ public virtual PostVotingConfigExclusionsResponse PostVotingConfigExclusions() } /// - /// Updates the cluster voting config exclusions by node ids or node names. + /// + /// Updates the cluster voting config exclusions by node ids or node names. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1118,7 +1408,9 @@ public virtual PostVotingConfigExclusionsResponse PostVotingConfigExclusions(Act } /// - /// Updates the cluster voting config exclusions by node ids or node names. + /// + /// Updates the cluster voting config exclusions by node ids or node names. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostVotingConfigExclusionsAsync(PostVotingConfigExclusionsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1128,7 +1420,9 @@ public virtual Task PostVotingConfigExclusio } /// - /// Updates the cluster voting config exclusions by node ids or node names. + /// + /// Updates the cluster voting config exclusions by node ids or node names. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostVotingConfigExclusionsAsync(CancellationToken cancellationToken = default) @@ -1139,7 +1433,9 @@ public virtual Task PostVotingConfigExclusio } /// - /// Updates the cluster voting config exclusions by node ids or node names. + /// + /// Updates the cluster voting config exclusions by node ids or node names. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostVotingConfigExclusionsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -1151,11 +1447,28 @@ public virtual Task PostVotingConfigExclusio } /// - /// Create or update a component template.
Creates or updates 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 `composed_of` list.
Component templates are only applied to new data streams and indices as part of a matching index template. - /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. - /// Component templates are only used during index creation.
For data streams, this includes data stream creation and the creation of a stream’s backing indices.
Changes to component templates do not affect existing indices, including a stream’s backing indices. - /// You can use C-style `/* *\/` block comments in component templates.
You can include comments anywhere in the request body except before the opening curly bracket. + /// + /// Create or update a component template. + /// Creates or updates 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 composed_of list. + /// Component templates are only applied to new data streams and indices as part of a matching index template. + /// + /// + /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. + /// + /// + /// Component templates are only used during index creation. + /// For data streams, this includes data stream creation and the creation of a stream’s backing indices. + /// Changes to component templates do not affect existing indices, including a stream’s backing indices. + /// + /// + /// You can use C-style /* *\/ block comments in component templates. + /// You can include comments anywhere in the request body except before the opening curly bracket. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1166,11 +1479,28 @@ public virtual PutComponentTemplateResponse PutComponentTemplate(PutComponentTem } /// - /// Create or update a component template.
Creates or updates 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 `composed_of` list.
Component templates are only applied to new data streams and indices as part of a matching index template. - /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. - /// Component templates are only used during index creation.
For data streams, this includes data stream creation and the creation of a stream’s backing indices.
Changes to component templates do not affect existing indices, including a stream’s backing indices. - /// You can use C-style `/* *\/` block comments in component templates.
You can include comments anywhere in the request body except before the opening curly bracket. + /// + /// Create or update a component template. + /// Creates or updates 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 composed_of list. + /// Component templates are only applied to new data streams and indices as part of a matching index template. + /// + /// + /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. + /// + /// + /// Component templates are only used during index creation. + /// For data streams, this includes data stream creation and the creation of a stream’s backing indices. + /// Changes to component templates do not affect existing indices, including a stream’s backing indices. + /// + /// + /// You can use C-style /* *\/ block comments in component templates. + /// You can include comments anywhere in the request body except before the opening curly bracket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutComponentTemplateAsync(PutComponentTemplateRequest request, CancellationToken cancellationToken = default) @@ -1180,11 +1510,28 @@ public virtual Task PutComponentTemplateAsync(PutC } /// - /// Create or update a component template.
Creates or updates 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 `composed_of` list.
Component templates are only applied to new data streams and indices as part of a matching index template. - /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. - /// Component templates are only used during index creation.
For data streams, this includes data stream creation and the creation of a stream’s backing indices.
Changes to component templates do not affect existing indices, including a stream’s backing indices. - /// You can use C-style `/* *\/` block comments in component templates.
You can include comments anywhere in the request body except before the opening curly bracket. + /// + /// Create or update a component template. + /// Creates or updates 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 composed_of list. + /// Component templates are only applied to new data streams and indices as part of a matching index template. + /// + /// + /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. + /// + /// + /// Component templates are only used during index creation. + /// For data streams, this includes data stream creation and the creation of a stream’s backing indices. + /// Changes to component templates do not affect existing indices, including a stream’s backing indices. + /// + /// + /// You can use C-style /* *\/ block comments in component templates. + /// You can include comments anywhere in the request body except before the opening curly bracket. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1195,11 +1542,28 @@ public virtual PutComponentTemplateResponse PutComponentTemplate(PutC } /// - /// Create or update a component template.
Creates or updates 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 `composed_of` list.
Component templates are only applied to new data streams and indices as part of a matching index template. - /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. - /// Component templates are only used during index creation.
For data streams, this includes data stream creation and the creation of a stream’s backing indices.
Changes to component templates do not affect existing indices, including a stream’s backing indices. - /// You can use C-style `/* *\/` block comments in component templates.
You can include comments anywhere in the request body except before the opening curly bracket. + /// + /// Create or update a component template. + /// Creates or updates 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 composed_of list. + /// Component templates are only applied to new data streams and indices as part of a matching index template. + /// + /// + /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. + /// + /// + /// Component templates are only used during index creation. + /// For data streams, this includes data stream creation and the creation of a stream’s backing indices. + /// Changes to component templates do not affect existing indices, including a stream’s backing indices. + /// + /// + /// You can use C-style /* *\/ block comments in component templates. + /// You can include comments anywhere in the request body except before the opening curly bracket. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1211,11 +1575,28 @@ public virtual PutComponentTemplateResponse PutComponentTemplate(Elas } /// - /// Create or update a component template.
Creates or updates 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 `composed_of` list.
Component templates are only applied to new data streams and indices as part of a matching index template. - /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. - /// Component templates are only used during index creation.
For data streams, this includes data stream creation and the creation of a stream’s backing indices.
Changes to component templates do not affect existing indices, including a stream’s backing indices. - /// You can use C-style `/* *\/` block comments in component templates.
You can include comments anywhere in the request body except before the opening curly bracket. + /// + /// Create or update a component template. + /// Creates or updates 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 composed_of list. + /// Component templates are only applied to new data streams and indices as part of a matching index template. + /// + /// + /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. + /// + /// + /// Component templates are only used during index creation. + /// For data streams, this includes data stream creation and the creation of a stream’s backing indices. + /// Changes to component templates do not affect existing indices, including a stream’s backing indices. + /// + /// + /// You can use C-style /* *\/ block comments in component templates. + /// You can include comments anywhere in the request body except before the opening curly bracket. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1228,11 +1609,28 @@ public virtual PutComponentTemplateResponse PutComponentTemplate(Elas } /// - /// Create or update a component template.
Creates or updates 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 `composed_of` list.
Component templates are only applied to new data streams and indices as part of a matching index template. - /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. - /// Component templates are only used during index creation.
For data streams, this includes data stream creation and the creation of a stream’s backing indices.
Changes to component templates do not affect existing indices, including a stream’s backing indices. - /// You can use C-style `/* *\/` block comments in component templates.
You can include comments anywhere in the request body except before the opening curly bracket. + /// + /// Create or update a component template. + /// Creates or updates 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 composed_of list. + /// Component templates are only applied to new data streams and indices as part of a matching index template. + /// + /// + /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. + /// + /// + /// Component templates are only used during index creation. + /// For data streams, this includes data stream creation and the creation of a stream’s backing indices. + /// Changes to component templates do not affect existing indices, including a stream’s backing indices. + /// + /// + /// You can use C-style /* *\/ block comments in component templates. + /// You can include comments anywhere in the request body except before the opening curly bracket. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1243,11 +1641,28 @@ public virtual PutComponentTemplateResponse PutComponentTemplate(PutComponentTem } /// - /// Create or update a component template.
Creates or updates 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 `composed_of` list.
Component templates are only applied to new data streams and indices as part of a matching index template. - /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. - /// Component templates are only used during index creation.
For data streams, this includes data stream creation and the creation of a stream’s backing indices.
Changes to component templates do not affect existing indices, including a stream’s backing indices. - /// You can use C-style `/* *\/` block comments in component templates.
You can include comments anywhere in the request body except before the opening curly bracket. + /// + /// Create or update a component template. + /// Creates or updates 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 composed_of list. + /// Component templates are only applied to new data streams and indices as part of a matching index template. + /// + /// + /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. + /// + /// + /// Component templates are only used during index creation. + /// For data streams, this includes data stream creation and the creation of a stream’s backing indices. + /// Changes to component templates do not affect existing indices, including a stream’s backing indices. + /// + /// + /// You can use C-style /* *\/ block comments in component templates. + /// You can include comments anywhere in the request body except before the opening curly bracket. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1259,11 +1674,28 @@ public virtual PutComponentTemplateResponse PutComponentTemplate(Elastic.Clients } /// - /// Create or update a component template.
Creates or updates 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 `composed_of` list.
Component templates are only applied to new data streams and indices as part of a matching index template. - /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. - /// Component templates are only used during index creation.
For data streams, this includes data stream creation and the creation of a stream’s backing indices.
Changes to component templates do not affect existing indices, including a stream’s backing indices. - /// You can use C-style `/* *\/` block comments in component templates.
You can include comments anywhere in the request body except before the opening curly bracket. + /// + /// Create or update a component template. + /// Creates or updates 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 composed_of list. + /// Component templates are only applied to new data streams and indices as part of a matching index template. + /// + /// + /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. + /// + /// + /// Component templates are only used during index creation. + /// For data streams, this includes data stream creation and the creation of a stream’s backing indices. + /// Changes to component templates do not affect existing indices, including a stream’s backing indices. + /// + /// + /// You can use C-style /* *\/ block comments in component templates. + /// You can include comments anywhere in the request body except before the opening curly bracket. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1276,11 +1708,28 @@ public virtual PutComponentTemplateResponse PutComponentTemplate(Elastic.Clients } /// - /// Create or update a component template.
Creates or updates 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 `composed_of` list.
Component templates are only applied to new data streams and indices as part of a matching index template. - /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. - /// Component templates are only used during index creation.
For data streams, this includes data stream creation and the creation of a stream’s backing indices.
Changes to component templates do not affect existing indices, including a stream’s backing indices. - /// You can use C-style `/* *\/` block comments in component templates.
You can include comments anywhere in the request body except before the opening curly bracket. + /// + /// Create or update a component template. + /// Creates or updates 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 composed_of list. + /// Component templates are only applied to new data streams and indices as part of a matching index template. + /// + /// + /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. + /// + /// + /// Component templates are only used during index creation. + /// For data streams, this includes data stream creation and the creation of a stream’s backing indices. + /// Changes to component templates do not affect existing indices, including a stream’s backing indices. + /// + /// + /// You can use C-style /* *\/ block comments in component templates. + /// You can include comments anywhere in the request body except before the opening curly bracket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutComponentTemplateAsync(PutComponentTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1290,11 +1739,28 @@ public virtual Task PutComponentTemplateAsync - /// Create or update a component template.
Creates or updates 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 `composed_of` list.
Component templates are only applied to new data streams and indices as part of a matching index template. - /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. - /// Component templates are only used during index creation.
For data streams, this includes data stream creation and the creation of a stream’s backing indices.
Changes to component templates do not affect existing indices, including a stream’s backing indices. - /// You can use C-style `/* *\/` block comments in component templates.
You can include comments anywhere in the request body except before the opening curly bracket. + /// + /// Create or update a component template. + /// Creates or updates 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 composed_of list. + /// Component templates are only applied to new data streams and indices as part of a matching index template. + /// + /// + /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. + /// + /// + /// Component templates are only used during index creation. + /// For data streams, this includes data stream creation and the creation of a stream’s backing indices. + /// Changes to component templates do not affect existing indices, including a stream’s backing indices. + /// + /// + /// You can use C-style /* *\/ block comments in component templates. + /// You can include comments anywhere in the request body except before the opening curly bracket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutComponentTemplateAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) @@ -1305,11 +1771,28 @@ public virtual Task PutComponentTemplateAsync - /// Create or update a component template.
Creates or updates 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 `composed_of` list.
Component templates are only applied to new data streams and indices as part of a matching index template. - /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. - /// Component templates are only used during index creation.
For data streams, this includes data stream creation and the creation of a stream’s backing indices.
Changes to component templates do not affect existing indices, including a stream’s backing indices. - /// You can use C-style `/* *\/` block comments in component templates.
You can include comments anywhere in the request body except before the opening curly bracket. + /// + /// Create or update a component template. + /// Creates or updates 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 composed_of list. + /// Component templates are only applied to new data streams and indices as part of a matching index template. + /// + /// + /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. + /// + /// + /// Component templates are only used during index creation. + /// For data streams, this includes data stream creation and the creation of a stream’s backing indices. + /// Changes to component templates do not affect existing indices, including a stream’s backing indices. + /// + /// + /// You can use C-style /* *\/ block comments in component templates. + /// You can include comments anywhere in the request body except before the opening curly bracket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutComponentTemplateAsync(Elastic.Clients.Elasticsearch.Name name, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1321,11 +1804,28 @@ public virtual Task PutComponentTemplateAsync - /// Create or update a component template.
Creates or updates 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 `composed_of` list.
Component templates are only applied to new data streams and indices as part of a matching index template. - /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. - /// Component templates are only used during index creation.
For data streams, this includes data stream creation and the creation of a stream’s backing indices.
Changes to component templates do not affect existing indices, including a stream’s backing indices. - /// You can use C-style `/* *\/` block comments in component templates.
You can include comments anywhere in the request body except before the opening curly bracket. + /// + /// Create or update a component template. + /// Creates or updates 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 composed_of list. + /// Component templates are only applied to new data streams and indices as part of a matching index template. + /// + /// + /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. + /// + /// + /// Component templates are only used during index creation. + /// For data streams, this includes data stream creation and the creation of a stream’s backing indices. + /// Changes to component templates do not affect existing indices, including a stream’s backing indices. + /// + /// + /// You can use C-style /* *\/ block comments in component templates. + /// You can include comments anywhere in the request body except before the opening curly bracket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutComponentTemplateAsync(PutComponentTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1335,11 +1835,28 @@ public virtual Task PutComponentTemplateAsync(PutC } /// - /// Create or update a component template.
Creates or updates 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 `composed_of` list.
Component templates are only applied to new data streams and indices as part of a matching index template. - /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. - /// Component templates are only used during index creation.
For data streams, this includes data stream creation and the creation of a stream’s backing indices.
Changes to component templates do not affect existing indices, including a stream’s backing indices. - /// You can use C-style `/* *\/` block comments in component templates.
You can include comments anywhere in the request body except before the opening curly bracket. + /// + /// Create or update a component template. + /// Creates or updates 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 composed_of list. + /// Component templates are only applied to new data streams and indices as part of a matching index template. + /// + /// + /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. + /// + /// + /// Component templates are only used during index creation. + /// For data streams, this includes data stream creation and the creation of a stream’s backing indices. + /// Changes to component templates do not affect existing indices, including a stream’s backing indices. + /// + /// + /// You can use C-style /* *\/ block comments in component templates. + /// You can include comments anywhere in the request body except before the opening curly bracket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutComponentTemplateAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) @@ -1350,11 +1867,28 @@ public virtual Task PutComponentTemplateAsync(Elas } /// - /// Create or update a component template.
Creates or updates 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 `composed_of` list.
Component templates are only applied to new data streams and indices as part of a matching index template. - /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. - /// Component templates are only used during index creation.
For data streams, this includes data stream creation and the creation of a stream’s backing indices.
Changes to component templates do not affect existing indices, including a stream’s backing indices. - /// You can use C-style `/* *\/` block comments in component templates.
You can include comments anywhere in the request body except before the opening curly bracket. + /// + /// Create or update a component template. + /// Creates or updates 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 composed_of list. + /// Component templates are only applied to new data streams and indices as part of a matching index template. + /// + /// + /// Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. + /// + /// + /// Component templates are only used during index creation. + /// For data streams, this includes data stream creation and the creation of a stream’s backing indices. + /// Changes to component templates do not affect existing indices, including a stream’s backing indices. + /// + /// + /// You can use C-style /* *\/ block comments in component templates. + /// You can include comments anywhere in the request body except before the opening curly bracket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutComponentTemplateAsync(Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -1366,7 +1900,10 @@ public virtual Task PutComponentTemplateAsync(Elas } /// - /// Returns cluster statistics.
It returns 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). + /// + /// Returns cluster statistics. + /// It returns 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). + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1377,7 +1914,10 @@ public virtual ClusterStatsResponse Stats(ClusterStatsRequest request) } /// - /// Returns cluster statistics.
It returns 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). + /// + /// Returns cluster statistics. + /// It returns 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). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(ClusterStatsRequest request, CancellationToken cancellationToken = default) @@ -1387,7 +1927,10 @@ public virtual Task StatsAsync(ClusterStatsRequest request } /// - /// Returns cluster statistics.
It returns 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). + /// + /// Returns cluster statistics. + /// It returns 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). + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1398,7 +1941,10 @@ public virtual ClusterStatsResponse Stats(ClusterStatsRequestDescriptor descript } /// - /// Returns cluster statistics.
It returns 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). + /// + /// Returns cluster statistics. + /// It returns 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). + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1410,7 +1956,10 @@ public virtual ClusterStatsResponse Stats(Elastic.Clients.Elasticsearch.NodeIds? } /// - /// Returns cluster statistics.
It returns 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). + /// + /// Returns cluster statistics. + /// It returns 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). + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1423,7 +1972,10 @@ public virtual ClusterStatsResponse Stats(Elastic.Clients.Elasticsearch.NodeIds? } /// - /// Returns cluster statistics.
It returns 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). + /// + /// Returns cluster statistics. + /// It returns 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). + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1435,7 +1987,10 @@ public virtual ClusterStatsResponse Stats() } /// - /// Returns cluster statistics.
It returns 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). + /// + /// Returns cluster statistics. + /// It returns 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). + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1448,7 +2003,10 @@ public virtual ClusterStatsResponse Stats(Action } /// - /// Returns cluster statistics.
It returns 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). + /// + /// Returns cluster statistics. + /// It returns 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). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(ClusterStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1458,7 +2016,10 @@ public virtual Task StatsAsync(ClusterStatsRequestDescript } /// - /// Returns cluster statistics.
It returns 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). + /// + /// Returns cluster statistics. + /// It returns 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). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.NodeIds? nodeId, CancellationToken cancellationToken = default) @@ -1469,7 +2030,10 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsear } /// - /// Returns cluster statistics.
It returns 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). + /// + /// Returns cluster statistics. + /// It returns 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). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Action configureRequest, CancellationToken cancellationToken = default) @@ -1481,7 +2045,10 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsear } /// - /// Returns cluster statistics.
It returns 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). + /// + /// Returns cluster statistics. + /// It returns 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). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(CancellationToken cancellationToken = default) @@ -1492,7 +2059,10 @@ public virtual Task StatsAsync(CancellationToken cancellat } /// - /// Returns cluster statistics.
It returns 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). + /// + /// Returns cluster statistics. + /// It returns 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). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.DanglingIndices.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.DanglingIndices.g.cs index d9cb203295c..f4bed190814 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.DanglingIndices.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.DanglingIndices.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.DanglingIndices; public partial class DanglingIndicesNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected DanglingIndicesNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal DanglingIndicesNamespacedClient(ElasticsearchClient client) : base(clie } /// - /// Returns all dangling indices. + /// + /// Returns all dangling indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -49,7 +53,9 @@ public virtual ListDanglingIndicesResponse ListDanglingIndices(ListDanglingIndic } /// - /// Returns all dangling indices. + /// + /// Returns all dangling indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ListDanglingIndicesAsync(ListDanglingIndicesRequest request, CancellationToken cancellationToken = default) @@ -59,7 +65,9 @@ public virtual Task ListDanglingIndicesAsync(ListDa } /// - /// Returns all dangling indices. + /// + /// Returns all dangling indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -70,7 +78,9 @@ public virtual ListDanglingIndicesResponse ListDanglingIndices(ListDanglingIndic } /// - /// Returns all dangling indices. + /// + /// Returns all dangling indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -82,7 +92,9 @@ public virtual ListDanglingIndicesResponse ListDanglingIndices() } /// - /// Returns all dangling indices. + /// + /// Returns all dangling indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -95,7 +107,9 @@ public virtual ListDanglingIndicesResponse ListDanglingIndices(Action - /// Returns all dangling indices. + /// + /// Returns all dangling indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ListDanglingIndicesAsync(ListDanglingIndicesRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -105,7 +119,9 @@ public virtual Task ListDanglingIndicesAsync(ListDa } /// - /// Returns all dangling indices. + /// + /// Returns all dangling indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ListDanglingIndicesAsync(CancellationToken cancellationToken = default) @@ -116,7 +132,9 @@ public virtual Task ListDanglingIndicesAsync(Cancel } /// - /// Returns all dangling indices. + /// + /// Returns all dangling indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ListDanglingIndicesAsync(Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Enrich.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Enrich.g.cs index 2f2496e756e..9b1d2a49d43 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Enrich.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Enrich.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Enrich; public partial class EnrichNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected EnrichNamespacedClient() : base() { @@ -38,7 +40,10 @@ internal EnrichNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// Delete an enrich policy.
Deletes an existing enrich policy and its enrich index. + /// + /// Delete an enrich policy. + /// Deletes an existing enrich policy and its enrich index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -49,7 +54,10 @@ public virtual DeletePolicyResponse DeletePolicy(DeletePolicyRequest request) } /// - /// Delete an enrich policy.
Deletes an existing enrich policy and its enrich index. + /// + /// Delete an enrich policy. + /// Deletes an existing enrich policy and its enrich index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeletePolicyAsync(DeletePolicyRequest request, CancellationToken cancellationToken = default) @@ -59,7 +67,10 @@ public virtual Task DeletePolicyAsync(DeletePolicyRequest } /// - /// Delete an enrich policy.
Deletes an existing enrich policy and its enrich index. + /// + /// Delete an enrich policy. + /// Deletes an existing enrich policy and its enrich index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -70,7 +81,10 @@ public virtual DeletePolicyResponse DeletePolicy(DeletePolicyRequestDescriptor d } /// - /// Delete an enrich policy.
Deletes an existing enrich policy and its enrich index. + /// + /// Delete an enrich policy. + /// Deletes an existing enrich policy and its enrich index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -82,7 +96,10 @@ public virtual DeletePolicyResponse DeletePolicy(Elastic.Clients.Elasticsearch.N } /// - /// Delete an enrich policy.
Deletes an existing enrich policy and its enrich index. + /// + /// Delete an enrich policy. + /// Deletes an existing enrich policy and its enrich index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -95,7 +112,10 @@ public virtual DeletePolicyResponse DeletePolicy(Elastic.Clients.Elasticsearch.N } /// - /// Delete an enrich policy.
Deletes an existing enrich policy and its enrich index. + /// + /// Delete an enrich policy. + /// Deletes an existing enrich policy and its enrich index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeletePolicyAsync(DeletePolicyRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -105,7 +125,10 @@ public virtual Task DeletePolicyAsync(DeletePolicyRequestD } /// - /// Delete an enrich policy.
Deletes an existing enrich policy and its enrich index. + /// + /// Delete an enrich policy. + /// Deletes an existing enrich policy and its enrich index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeletePolicyAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) @@ -116,7 +139,10 @@ public virtual Task DeletePolicyAsync(Elastic.Clients.Elas } /// - /// Delete an enrich policy.
Deletes an existing enrich policy and its enrich index. + /// + /// Delete an enrich policy. + /// Deletes an existing enrich policy and its enrich index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeletePolicyAsync(Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -128,7 +154,9 @@ public virtual Task DeletePolicyAsync(Elastic.Clients.Elas } /// - /// Creates the enrich index for an existing enrich policy. + /// + /// Creates the enrich index for an existing enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -139,7 +167,9 @@ public virtual ExecutePolicyResponse ExecutePolicy(ExecutePolicyRequest request) } /// - /// Creates the enrich index for an existing enrich policy. + /// + /// Creates the enrich index for an existing enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExecutePolicyAsync(ExecutePolicyRequest request, CancellationToken cancellationToken = default) @@ -149,7 +179,9 @@ public virtual Task ExecutePolicyAsync(ExecutePolicyReque } /// - /// Creates the enrich index for an existing enrich policy. + /// + /// Creates the enrich index for an existing enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -160,7 +192,9 @@ public virtual ExecutePolicyResponse ExecutePolicy(ExecutePolicyRequestDescripto } /// - /// Creates the enrich index for an existing enrich policy. + /// + /// Creates the enrich index for an existing enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -172,7 +206,9 @@ public virtual ExecutePolicyResponse ExecutePolicy(Elastic.Clients.Elasticsearch } /// - /// Creates the enrich index for an existing enrich policy. + /// + /// Creates the enrich index for an existing enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -185,7 +221,9 @@ public virtual ExecutePolicyResponse ExecutePolicy(Elastic.Clients.Elasticsearch } /// - /// Creates the enrich index for an existing enrich policy. + /// + /// Creates the enrich index for an existing enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExecutePolicyAsync(ExecutePolicyRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -195,7 +233,9 @@ public virtual Task ExecutePolicyAsync(ExecutePolicyReque } /// - /// Creates the enrich index for an existing enrich policy. + /// + /// Creates the enrich index for an existing enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExecutePolicyAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) @@ -206,7 +246,9 @@ public virtual Task ExecutePolicyAsync(Elastic.Clients.El } /// - /// Creates the enrich index for an existing enrich policy. + /// + /// Creates the enrich index for an existing enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExecutePolicyAsync(Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -218,7 +260,10 @@ public virtual Task ExecutePolicyAsync(Elastic.Clients.El } /// - /// Get an enrich policy.
Returns information about an enrich policy. + /// + /// Get an enrich policy. + /// Returns information about an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -229,7 +274,10 @@ public virtual GetPolicyResponse GetPolicy(GetPolicyRequest request) } /// - /// Get an enrich policy.
Returns information about an enrich policy. + /// + /// Get an enrich policy. + /// Returns information about an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPolicyAsync(GetPolicyRequest request, CancellationToken cancellationToken = default) @@ -239,7 +287,10 @@ public virtual Task GetPolicyAsync(GetPolicyRequest request, } /// - /// Get an enrich policy.
Returns information about an enrich policy. + /// + /// Get an enrich policy. + /// Returns information about an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -250,7 +301,10 @@ public virtual GetPolicyResponse GetPolicy(GetPolicyRequestDescriptor descriptor } /// - /// Get an enrich policy.
Returns information about an enrich policy. + /// + /// Get an enrich policy. + /// Returns information about an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -262,7 +316,10 @@ public virtual GetPolicyResponse GetPolicy(Elastic.Clients.Elasticsearch.Names? } /// - /// Get an enrich policy.
Returns information about an enrich policy. + /// + /// Get an enrich policy. + /// Returns information about an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -275,7 +332,10 @@ public virtual GetPolicyResponse GetPolicy(Elastic.Clients.Elasticsearch.Names? } /// - /// Get an enrich policy.
Returns information about an enrich policy. + /// + /// Get an enrich policy. + /// Returns information about an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -287,7 +347,10 @@ public virtual GetPolicyResponse GetPolicy() } /// - /// Get an enrich policy.
Returns information about an enrich policy. + /// + /// Get an enrich policy. + /// Returns information about an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -300,7 +363,10 @@ public virtual GetPolicyResponse GetPolicy(Action co } /// - /// Get an enrich policy.
Returns information about an enrich policy. + /// + /// Get an enrich policy. + /// Returns information about an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPolicyAsync(GetPolicyRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -310,7 +376,10 @@ public virtual Task GetPolicyAsync(GetPolicyRequestDescriptor } /// - /// Get an enrich policy.
Returns information about an enrich policy. + /// + /// Get an enrich policy. + /// Returns information about an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPolicyAsync(Elastic.Clients.Elasticsearch.Names? name, CancellationToken cancellationToken = default) @@ -321,7 +390,10 @@ public virtual Task GetPolicyAsync(Elastic.Clients.Elasticsea } /// - /// Get an enrich policy.
Returns information about an enrich policy. + /// + /// Get an enrich policy. + /// Returns information about an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPolicyAsync(Elastic.Clients.Elasticsearch.Names? name, Action configureRequest, CancellationToken cancellationToken = default) @@ -333,7 +405,10 @@ public virtual Task GetPolicyAsync(Elastic.Clients.Elasticsea } /// - /// Get an enrich policy.
Returns information about an enrich policy. + /// + /// Get an enrich policy. + /// Returns information about an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPolicyAsync(CancellationToken cancellationToken = default) @@ -344,7 +419,10 @@ public virtual Task GetPolicyAsync(CancellationToken cancella } /// - /// Get an enrich policy.
Returns information about an enrich policy. + /// + /// Get an enrich policy. + /// Returns information about an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPolicyAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -356,7 +434,10 @@ public virtual Task GetPolicyAsync(Action - /// Create an enrich policy.
Creates an enrich policy. + /// + /// Create an enrich policy. + /// Creates an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -367,7 +448,10 @@ public virtual PutPolicyResponse PutPolicy(PutPolicyRequest request) } /// - /// Create an enrich policy.
Creates an enrich policy. + /// + /// Create an enrich policy. + /// Creates an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPolicyAsync(PutPolicyRequest request, CancellationToken cancellationToken = default) @@ -377,7 +461,10 @@ public virtual Task PutPolicyAsync(PutPolicyRequest request, } /// - /// Create an enrich policy.
Creates an enrich policy. + /// + /// Create an enrich policy. + /// Creates an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -388,7 +475,10 @@ public virtual PutPolicyResponse PutPolicy(PutPolicyRequestDescriptor } /// - /// Create an enrich policy.
Creates an enrich policy. + /// + /// Create an enrich policy. + /// Creates an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -400,7 +490,10 @@ public virtual PutPolicyResponse PutPolicy(Elastic.Clients.Elasticsea } /// - /// Create an enrich policy.
Creates an enrich policy. + /// + /// Create an enrich policy. + /// Creates an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -413,7 +506,10 @@ public virtual PutPolicyResponse PutPolicy(Elastic.Clients.Elasticsea } /// - /// Create an enrich policy.
Creates an enrich policy. + /// + /// Create an enrich policy. + /// Creates an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -424,7 +520,10 @@ public virtual PutPolicyResponse PutPolicy(PutPolicyRequestDescriptor descriptor } /// - /// Create an enrich policy.
Creates an enrich policy. + /// + /// Create an enrich policy. + /// Creates an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -436,7 +535,10 @@ public virtual PutPolicyResponse PutPolicy(Elastic.Clients.Elasticsearch.Name na } /// - /// Create an enrich policy.
Creates an enrich policy. + /// + /// Create an enrich policy. + /// Creates an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -449,7 +551,10 @@ public virtual PutPolicyResponse PutPolicy(Elastic.Clients.Elasticsearch.Name na } /// - /// Create an enrich policy.
Creates an enrich policy. + /// + /// Create an enrich policy. + /// Creates an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPolicyAsync(PutPolicyRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -459,7 +564,10 @@ public virtual Task PutPolicyAsync(PutPolicyReques } /// - /// Create an enrich policy.
Creates an enrich policy. + /// + /// Create an enrich policy. + /// Creates an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPolicyAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) @@ -470,7 +578,10 @@ public virtual Task PutPolicyAsync(Elastic.Clients } /// - /// Create an enrich policy.
Creates an enrich policy. + /// + /// Create an enrich policy. + /// Creates an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPolicyAsync(Elastic.Clients.Elasticsearch.Name name, Action> configureRequest, CancellationToken cancellationToken = default) @@ -482,7 +593,10 @@ public virtual Task PutPolicyAsync(Elastic.Clients } /// - /// Create an enrich policy.
Creates an enrich policy. + /// + /// Create an enrich policy. + /// Creates an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPolicyAsync(PutPolicyRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -492,7 +606,10 @@ public virtual Task PutPolicyAsync(PutPolicyRequestDescriptor } /// - /// Create an enrich policy.
Creates an enrich policy. + /// + /// Create an enrich policy. + /// Creates an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPolicyAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) @@ -503,7 +620,10 @@ public virtual Task PutPolicyAsync(Elastic.Clients.Elasticsea } /// - /// Create an enrich policy.
Creates an enrich policy. + /// + /// Create an enrich policy. + /// Creates an enrich policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPolicyAsync(Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -515,7 +635,10 @@ public virtual Task PutPolicyAsync(Elastic.Clients.Elasticsea } /// - /// Get enrich stats.
Returns enrich coordinator statistics and information about enrich policies that are currently executing. + /// + /// Get enrich stats. + /// Returns enrich coordinator statistics and information about enrich policies that are currently executing. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -526,7 +649,10 @@ public virtual EnrichStatsResponse Stats(EnrichStatsRequest request) } /// - /// Get enrich stats.
Returns enrich coordinator statistics and information about enrich policies that are currently executing. + /// + /// Get enrich stats. + /// Returns enrich coordinator statistics and information about enrich policies that are currently executing. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(EnrichStatsRequest request, CancellationToken cancellationToken = default) @@ -536,7 +662,10 @@ public virtual Task StatsAsync(EnrichStatsRequest request, } /// - /// Get enrich stats.
Returns enrich coordinator statistics and information about enrich policies that are currently executing. + /// + /// Get enrich stats. + /// Returns enrich coordinator statistics and information about enrich policies that are currently executing. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -547,7 +676,10 @@ public virtual EnrichStatsResponse Stats(EnrichStatsRequestDescriptor descriptor } /// - /// Get enrich stats.
Returns enrich coordinator statistics and information about enrich policies that are currently executing. + /// + /// Get enrich stats. + /// Returns enrich coordinator statistics and information about enrich policies that are currently executing. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -559,7 +691,10 @@ public virtual EnrichStatsResponse Stats() } /// - /// Get enrich stats.
Returns enrich coordinator statistics and information about enrich policies that are currently executing. + /// + /// Get enrich stats. + /// Returns enrich coordinator statistics and information about enrich policies that are currently executing. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -572,7 +707,10 @@ public virtual EnrichStatsResponse Stats(Action co } /// - /// Get enrich stats.
Returns enrich coordinator statistics and information about enrich policies that are currently executing. + /// + /// Get enrich stats. + /// Returns enrich coordinator statistics and information about enrich policies that are currently executing. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(EnrichStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -582,7 +720,10 @@ public virtual Task StatsAsync(EnrichStatsRequestDescriptor } /// - /// Get enrich stats.
Returns enrich coordinator statistics and information about enrich policies that are currently executing. + /// + /// Get enrich stats. + /// Returns enrich coordinator statistics and information about enrich policies that are currently executing. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(CancellationToken cancellationToken = default) @@ -593,7 +734,10 @@ public virtual Task StatsAsync(CancellationToken cancellati } /// - /// Get enrich stats.
Returns enrich coordinator statistics and information about enrich policies that are currently executing. + /// + /// Get enrich stats. + /// Returns enrich coordinator statistics and information about enrich policies that are currently executing. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Eql.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Eql.g.cs index 0df46758d62..5fc3a064dde 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Eql.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Eql.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Eql; public partial class EqlNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected EqlNamespacedClient() : base() { @@ -38,7 +40,10 @@ internal EqlNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// Deletes an async EQL search or a stored synchronous EQL search.
The API also deletes results for the search. + /// + /// Deletes an async EQL search or a stored synchronous EQL search. + /// The API also deletes results for the search. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -49,7 +54,10 @@ public virtual EqlDeleteResponse Delete(EqlDeleteRequest request) } /// - /// Deletes an async EQL search or a stored synchronous EQL search.
The API also deletes results for the search. + /// + /// Deletes an async EQL search or a stored synchronous EQL search. + /// The API also deletes results for the search. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(EqlDeleteRequest request, CancellationToken cancellationToken = default) @@ -59,7 +67,10 @@ public virtual Task DeleteAsync(EqlDeleteRequest request, Can } /// - /// Deletes an async EQL search or a stored synchronous EQL search.
The API also deletes results for the search. + /// + /// Deletes an async EQL search or a stored synchronous EQL search. + /// The API also deletes results for the search. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -70,7 +81,10 @@ public virtual EqlDeleteResponse Delete(EqlDeleteRequestDescriptor - /// Deletes an async EQL search or a stored synchronous EQL search.
The API also deletes results for the search. + /// + /// Deletes an async EQL search or a stored synchronous EQL search. + /// The API also deletes results for the search. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -82,7 +96,10 @@ public virtual EqlDeleteResponse Delete(Elastic.Clients.Elasticsearch } /// - /// Deletes an async EQL search or a stored synchronous EQL search.
The API also deletes results for the search. + /// + /// Deletes an async EQL search or a stored synchronous EQL search. + /// The API also deletes results for the search. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -95,7 +112,10 @@ public virtual EqlDeleteResponse Delete(Elastic.Clients.Elasticsearch } /// - /// Deletes an async EQL search or a stored synchronous EQL search.
The API also deletes results for the search. + /// + /// Deletes an async EQL search or a stored synchronous EQL search. + /// The API also deletes results for the search. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -106,7 +126,10 @@ public virtual EqlDeleteResponse Delete(EqlDeleteRequestDescriptor descriptor) } /// - /// Deletes an async EQL search or a stored synchronous EQL search.
The API also deletes results for the search. + /// + /// Deletes an async EQL search or a stored synchronous EQL search. + /// The API also deletes results for the search. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -118,7 +141,10 @@ public virtual EqlDeleteResponse Delete(Elastic.Clients.Elasticsearch.Id id) } /// - /// Deletes an async EQL search or a stored synchronous EQL search.
The API also deletes results for the search. + /// + /// Deletes an async EQL search or a stored synchronous EQL search. + /// The API also deletes results for the search. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -131,7 +157,10 @@ public virtual EqlDeleteResponse Delete(Elastic.Clients.Elasticsearch.Id id, Act } /// - /// Deletes an async EQL search or a stored synchronous EQL search.
The API also deletes results for the search. + /// + /// Deletes an async EQL search or a stored synchronous EQL search. + /// The API also deletes results for the search. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(EqlDeleteRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -141,7 +170,10 @@ public virtual Task DeleteAsync(EqlDeleteRequestDe } /// - /// Deletes an async EQL search or a stored synchronous EQL search.
The API also deletes results for the search. + /// + /// Deletes an async EQL search or a stored synchronous EQL search. + /// The API also deletes results for the search. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -152,7 +184,10 @@ public virtual Task DeleteAsync(Elastic.Clients.El } /// - /// Deletes an async EQL search or a stored synchronous EQL search.
The API also deletes results for the search. + /// + /// Deletes an async EQL search or a stored synchronous EQL search. + /// The API also deletes results for the search. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -164,7 +199,10 @@ public virtual Task DeleteAsync(Elastic.Clients.El } /// - /// Deletes an async EQL search or a stored synchronous EQL search.
The API also deletes results for the search. + /// + /// Deletes an async EQL search or a stored synchronous EQL search. + /// The API also deletes results for the search. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(EqlDeleteRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -174,7 +212,10 @@ public virtual Task DeleteAsync(EqlDeleteRequestDescriptor de } /// - /// Deletes an async EQL search or a stored synchronous EQL search.
The API also deletes results for the search. + /// + /// Deletes an async EQL search or a stored synchronous EQL search. + /// The API also deletes results for the search. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -185,7 +226,10 @@ public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch } /// - /// Deletes an async EQL search or a stored synchronous EQL search.
The API also deletes results for the search. + /// + /// Deletes an async EQL search or a stored synchronous EQL search. + /// The API also deletes results for the search. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -197,7 +241,9 @@ public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch } /// - /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + /// + /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -208,7 +254,9 @@ public virtual EqlGetResponse Get(EqlGetRequest request) } /// - /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + /// + /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(EqlGetRequest request, CancellationToken cancellationToken = default) @@ -218,7 +266,9 @@ public virtual Task> GetAsync(EqlGetRequest reque } /// - /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + /// + /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -229,7 +279,9 @@ public virtual EqlGetResponse Get(EqlGetRequestDescriptor - /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + /// + /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -241,7 +293,9 @@ public virtual EqlGetResponse Get(Elastic.Clients.Elasticsearch. } /// - /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + /// + /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -254,7 +308,9 @@ public virtual EqlGetResponse Get(Elastic.Clients.Elasticsearch. } /// - /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + /// + /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(EqlGetRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -264,7 +320,9 @@ public virtual Task> GetAsync(EqlGetRequestDescri } /// - /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + /// + /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -275,7 +333,9 @@ public virtual Task> GetAsync(Elastic.Clients.Ela } /// - /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + /// + /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -287,7 +347,9 @@ public virtual Task> GetAsync(Elastic.Clients.Ela } /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// + /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -298,7 +360,9 @@ public virtual GetEqlStatusResponse GetStatus(GetEqlStatusRequest request) } /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// + /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(GetEqlStatusRequest request, CancellationToken cancellationToken = default) @@ -308,7 +372,9 @@ public virtual Task GetStatusAsync(GetEqlStatusRequest req } /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// + /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -319,7 +385,9 @@ public virtual GetEqlStatusResponse GetStatus(GetEqlStatusRequestDesc } /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// + /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -331,7 +399,9 @@ public virtual GetEqlStatusResponse GetStatus(Elastic.Clients.Elastic } /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// + /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -344,7 +414,9 @@ public virtual GetEqlStatusResponse GetStatus(Elastic.Clients.Elastic } /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// + /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -355,7 +427,9 @@ public virtual GetEqlStatusResponse GetStatus(GetEqlStatusRequestDescriptor desc } /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// + /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -367,7 +441,9 @@ public virtual GetEqlStatusResponse GetStatus(Elastic.Clients.Elasticsearch.Id i } /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// + /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -380,7 +456,9 @@ public virtual GetEqlStatusResponse GetStatus(Elastic.Clients.Elasticsearch.Id i } /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// + /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(GetEqlStatusRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -390,7 +468,9 @@ public virtual Task GetStatusAsync(GetEqlStatus } /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// + /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -401,7 +481,9 @@ public virtual Task GetStatusAsync(Elastic.Clie } /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// + /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -413,7 +495,9 @@ public virtual Task GetStatusAsync(Elastic.Clie } /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// + /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(GetEqlStatusRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -423,7 +507,9 @@ public virtual Task GetStatusAsync(GetEqlStatusRequestDesc } /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// + /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -434,7 +520,9 @@ public virtual Task GetStatusAsync(Elastic.Clients.Elastic } /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// + /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -446,7 +534,9 @@ public virtual Task GetStatusAsync(Elastic.Clients.Elastic } /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// + /// Returns results matching a query expressed in Event Query Language (EQL) + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -457,7 +547,9 @@ public virtual EqlSearchResponse Search(EqlSearchRequest request } /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// + /// Returns results matching a query expressed in Event Query Language (EQL) + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchAsync(EqlSearchRequest request, CancellationToken cancellationToken = default) @@ -467,7 +559,9 @@ public virtual Task> SearchAsync(EqlSearchRequ } /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// + /// Returns results matching a query expressed in Event Query Language (EQL) + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -478,7 +572,9 @@ public virtual EqlSearchResponse Search(EqlSearchRequestDescript } /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// + /// Returns results matching a query expressed in Event Query Language (EQL) + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -490,7 +586,9 @@ public virtual EqlSearchResponse Search(Elastic.Clients.Elastics } /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// + /// Returns results matching a query expressed in Event Query Language (EQL) + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -503,7 +601,9 @@ public virtual EqlSearchResponse Search(Elastic.Clients.Elastics } /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// + /// Returns results matching a query expressed in Event Query Language (EQL) + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -515,7 +615,9 @@ public virtual EqlSearchResponse Search() } /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// + /// Returns results matching a query expressed in Event Query Language (EQL) + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -528,7 +630,9 @@ public virtual EqlSearchResponse Search(Action - /// Returns results matching a query expressed in Event Query Language (EQL) + /// + /// Returns results matching a query expressed in Event Query Language (EQL) + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchAsync(EqlSearchRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -538,7 +642,9 @@ public virtual Task> SearchAsync(EqlSearchRequ } /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// + /// Returns results matching a query expressed in Event Query Language (EQL) + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -549,7 +655,9 @@ public virtual Task> SearchAsync(Elastic.Clien } /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// + /// Returns results matching a query expressed in Event Query Language (EQL) + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchAsync(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -561,7 +669,9 @@ public virtual Task> SearchAsync(Elastic.Clien } /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// + /// Returns results matching a query expressed in Event Query Language (EQL) + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchAsync(CancellationToken cancellationToken = default) @@ -572,7 +682,9 @@ public virtual Task> SearchAsync(CancellationT } /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// + /// Returns results matching a query expressed in Event Query Language (EQL) + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchAsync(Action> configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Esql.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Esql.g.cs index 3c467a2963b..bb12af89fb3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Esql.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Esql.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Esql; public partial class EsqlNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected EsqlNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal EsqlNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// Executes an ES|QL request + /// + /// Executes an ES|QL request + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -49,7 +53,9 @@ public virtual EsqlQueryResponse Query(EsqlQueryRequest request) } /// - /// Executes an ES|QL request + /// + /// Executes an ES|QL request + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(EsqlQueryRequest request, CancellationToken cancellationToken = default) @@ -59,7 +65,9 @@ public virtual Task QueryAsync(EsqlQueryRequest request, Canc } /// - /// Executes an ES|QL request + /// + /// Executes an ES|QL request + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -70,7 +78,9 @@ public virtual EsqlQueryResponse Query(EsqlQueryRequestDescriptor - /// Executes an ES|QL request + /// + /// Executes an ES|QL request + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -82,7 +92,9 @@ public virtual EsqlQueryResponse Query() } /// - /// Executes an ES|QL request + /// + /// Executes an ES|QL request + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -95,7 +107,9 @@ public virtual EsqlQueryResponse Query(Action - /// Executes an ES|QL request + /// + /// Executes an ES|QL request + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -106,7 +120,9 @@ public virtual EsqlQueryResponse Query(EsqlQueryRequestDescriptor descriptor) } /// - /// Executes an ES|QL request + /// + /// Executes an ES|QL request + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -118,7 +134,9 @@ public virtual EsqlQueryResponse Query() } /// - /// Executes an ES|QL request + /// + /// Executes an ES|QL request + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -131,7 +149,9 @@ public virtual EsqlQueryResponse Query(Action config } /// - /// Executes an ES|QL request + /// + /// Executes an ES|QL request + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(EsqlQueryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -141,7 +161,9 @@ public virtual Task QueryAsync(EsqlQueryRequestDes } /// - /// Executes an ES|QL request + /// + /// Executes an ES|QL request + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(CancellationToken cancellationToken = default) @@ -152,7 +174,9 @@ public virtual Task QueryAsync(CancellationToken c } /// - /// Executes an ES|QL request + /// + /// Executes an ES|QL request + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -164,7 +188,9 @@ public virtual Task QueryAsync(Action - /// Executes an ES|QL request + /// + /// Executes an ES|QL request + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(EsqlQueryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -174,7 +200,9 @@ public virtual Task QueryAsync(EsqlQueryRequestDescriptor des } /// - /// Executes an ES|QL request + /// + /// Executes an ES|QL request + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(CancellationToken cancellationToken = default) @@ -185,7 +213,9 @@ public virtual Task QueryAsync(CancellationToken cancellation } /// - /// Executes an ES|QL request + /// + /// Executes an ES|QL request + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Features.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Features.g.cs index 63e5b5b23ef..bc25559f2d8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Features.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Features.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Features; public partial class FeaturesNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected FeaturesNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal FeaturesNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot + /// + /// Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -49,7 +53,9 @@ public virtual GetFeaturesResponse GetFeatures(GetFeaturesRequest request) } /// - /// Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot + /// + /// Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetFeaturesAsync(GetFeaturesRequest request, CancellationToken cancellationToken = default) @@ -59,7 +65,9 @@ public virtual Task GetFeaturesAsync(GetFeaturesRequest req } /// - /// Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot + /// + /// Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -70,7 +78,9 @@ public virtual GetFeaturesResponse GetFeatures(GetFeaturesRequestDescriptor desc } /// - /// Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot + /// + /// Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -82,7 +92,9 @@ public virtual GetFeaturesResponse GetFeatures() } /// - /// Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot + /// + /// Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -95,7 +107,9 @@ public virtual GetFeaturesResponse GetFeatures(Action - /// Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot + /// + /// Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetFeaturesAsync(GetFeaturesRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -105,7 +119,9 @@ public virtual Task GetFeaturesAsync(GetFeaturesRequestDesc } /// - /// Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot + /// + /// Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetFeaturesAsync(CancellationToken cancellationToken = default) @@ -116,7 +132,9 @@ public virtual Task GetFeaturesAsync(CancellationToken canc } /// - /// Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot + /// + /// Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetFeaturesAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -128,7 +146,9 @@ public virtual Task GetFeaturesAsync(Action - /// Resets the internal state of features, usually by deleting system indices + /// + /// Resets the internal state of features, usually by deleting system indices + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -139,7 +159,9 @@ public virtual ResetFeaturesResponse ResetFeatures(ResetFeaturesRequest request) } /// - /// Resets the internal state of features, usually by deleting system indices + /// + /// Resets the internal state of features, usually by deleting system indices + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResetFeaturesAsync(ResetFeaturesRequest request, CancellationToken cancellationToken = default) @@ -149,7 +171,9 @@ public virtual Task ResetFeaturesAsync(ResetFeaturesReque } /// - /// Resets the internal state of features, usually by deleting system indices + /// + /// Resets the internal state of features, usually by deleting system indices + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -160,7 +184,9 @@ public virtual ResetFeaturesResponse ResetFeatures(ResetFeaturesRequestDescripto } /// - /// Resets the internal state of features, usually by deleting system indices + /// + /// Resets the internal state of features, usually by deleting system indices + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -172,7 +198,9 @@ public virtual ResetFeaturesResponse ResetFeatures() } /// - /// Resets the internal state of features, usually by deleting system indices + /// + /// Resets the internal state of features, usually by deleting system indices + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -185,7 +213,9 @@ public virtual ResetFeaturesResponse ResetFeatures(Action - /// Resets the internal state of features, usually by deleting system indices + /// + /// Resets the internal state of features, usually by deleting system indices + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResetFeaturesAsync(ResetFeaturesRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -195,7 +225,9 @@ public virtual Task ResetFeaturesAsync(ResetFeaturesReque } /// - /// Resets the internal state of features, usually by deleting system indices + /// + /// Resets the internal state of features, usually by deleting system indices + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResetFeaturesAsync(CancellationToken cancellationToken = default) @@ -206,7 +238,9 @@ public virtual Task ResetFeaturesAsync(CancellationToken } /// - /// Resets the internal state of features, usually by deleting system indices + /// + /// Resets the internal state of features, usually by deleting system indices + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResetFeaturesAsync(Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Graph.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Graph.g.cs index 0f9228cb8f0..bbe5008837a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Graph.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Graph.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Graph; public partial class GraphNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected GraphNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal GraphNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// + /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -49,7 +53,9 @@ public virtual ExploreResponse Explore(ExploreRequest request) } /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// + /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(ExploreRequest request, CancellationToken cancellationToken = default) @@ -59,7 +65,9 @@ public virtual Task ExploreAsync(ExploreRequest request, Cancel } /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// + /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -70,7 +78,9 @@ public virtual ExploreResponse Explore(ExploreRequestDescriptor - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// + /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -82,7 +92,9 @@ public virtual ExploreResponse Explore(Elastic.Clients.Elasticsearch. } /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// + /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -95,7 +107,9 @@ public virtual ExploreResponse Explore(Elastic.Clients.Elasticsearch. } /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// + /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -107,7 +121,9 @@ public virtual ExploreResponse Explore() } /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// + /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -120,7 +136,9 @@ public virtual ExploreResponse Explore(Action - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// + /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -131,7 +149,9 @@ public virtual ExploreResponse Explore(ExploreRequestDescriptor descriptor) } /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// + /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -143,7 +163,9 @@ public virtual ExploreResponse Explore(Elastic.Clients.Elasticsearch.Indices ind } /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// + /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -156,7 +178,9 @@ public virtual ExploreResponse Explore(Elastic.Clients.Elasticsearch.Indices ind } /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// + /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(ExploreRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -166,7 +190,9 @@ public virtual Task ExploreAsync(ExploreRequestDescr } /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// + /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -177,7 +203,9 @@ public virtual Task ExploreAsync(Elastic.Clients.Ela } /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// + /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -189,7 +217,9 @@ public virtual Task ExploreAsync(Elastic.Clients.Ela } /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// + /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(CancellationToken cancellationToken = default) @@ -200,7 +230,9 @@ public virtual Task ExploreAsync(CancellationToken c } /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// + /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -212,7 +244,9 @@ public virtual Task ExploreAsync(Action - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// + /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(ExploreRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -222,7 +256,9 @@ public virtual Task ExploreAsync(ExploreRequestDescriptor descr } /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// + /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -233,7 +269,9 @@ public virtual Task ExploreAsync(Elastic.Clients.Elasticsearch. } /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// + /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ilm.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ilm.g.cs index 545af57ccc0..9088cb19413 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ilm.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ilm.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.IndexLifecycleManagement; public partial class IndexLifecycleManagementNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected IndexLifecycleManagementNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal IndexLifecycleManagementNamespacedClient(ElasticsearchClient client) : } /// - /// Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. + /// + /// Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -49,7 +53,9 @@ public virtual DeleteLifecycleResponse DeleteLifecycle(DeleteLifecycleRequest re } /// - /// Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. + /// + /// Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteLifecycleAsync(DeleteLifecycleRequest request, CancellationToken cancellationToken = default) @@ -59,7 +65,9 @@ public virtual Task DeleteLifecycleAsync(DeleteLifecycl } /// - /// Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. + /// + /// Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -70,7 +78,9 @@ public virtual DeleteLifecycleResponse DeleteLifecycle(DeleteLifecycleRequestDes } /// - /// Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. + /// + /// Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -82,7 +92,9 @@ public virtual DeleteLifecycleResponse DeleteLifecycle(Elastic.Clients.Elasticse } /// - /// Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. + /// + /// Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -95,7 +107,9 @@ public virtual DeleteLifecycleResponse DeleteLifecycle(Elastic.Clients.Elasticse } /// - /// Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. + /// + /// Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteLifecycleAsync(DeleteLifecycleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -105,7 +119,9 @@ public virtual Task DeleteLifecycleAsync(DeleteLifecycl } /// - /// Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. + /// + /// Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteLifecycleAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) @@ -116,7 +132,9 @@ public virtual Task DeleteLifecycleAsync(Elastic.Client } /// - /// Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. + /// + /// Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteLifecycleAsync(Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -128,7 +146,9 @@ public virtual Task DeleteLifecycleAsync(Elastic.Client } /// - /// Retrieves a lifecycle policy. + /// + /// Retrieves a lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -139,7 +159,9 @@ public virtual GetLifecycleResponse GetLifecycle(GetLifecycleRequest request) } /// - /// Retrieves a lifecycle policy. + /// + /// Retrieves a lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetLifecycleAsync(GetLifecycleRequest request, CancellationToken cancellationToken = default) @@ -149,7 +171,9 @@ public virtual Task GetLifecycleAsync(GetLifecycleRequest } /// - /// Retrieves a lifecycle policy. + /// + /// Retrieves a lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -160,7 +184,9 @@ public virtual GetLifecycleResponse GetLifecycle(GetLifecycleRequestDescriptor d } /// - /// Retrieves a lifecycle policy. + /// + /// Retrieves a lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -172,7 +198,9 @@ public virtual GetLifecycleResponse GetLifecycle(Elastic.Clients.Elasticsearch.N } /// - /// Retrieves a lifecycle policy. + /// + /// Retrieves a lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -185,7 +213,9 @@ public virtual GetLifecycleResponse GetLifecycle(Elastic.Clients.Elasticsearch.N } /// - /// Retrieves a lifecycle policy. + /// + /// Retrieves a lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -197,7 +227,9 @@ public virtual GetLifecycleResponse GetLifecycle() } /// - /// Retrieves a lifecycle policy. + /// + /// Retrieves a lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -210,7 +242,9 @@ public virtual GetLifecycleResponse GetLifecycle(Action - /// Retrieves a lifecycle policy. + /// + /// Retrieves a lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetLifecycleAsync(GetLifecycleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -220,7 +254,9 @@ public virtual Task GetLifecycleAsync(GetLifecycleRequestD } /// - /// Retrieves a lifecycle policy. + /// + /// Retrieves a lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetLifecycleAsync(Elastic.Clients.Elasticsearch.Name? name, CancellationToken cancellationToken = default) @@ -231,7 +267,9 @@ public virtual Task GetLifecycleAsync(Elastic.Clients.Elas } /// - /// Retrieves a lifecycle policy. + /// + /// Retrieves a lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetLifecycleAsync(Elastic.Clients.Elasticsearch.Name? name, Action configureRequest, CancellationToken cancellationToken = default) @@ -243,7 +281,9 @@ public virtual Task GetLifecycleAsync(Elastic.Clients.Elas } /// - /// Retrieves a lifecycle policy. + /// + /// Retrieves a lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetLifecycleAsync(CancellationToken cancellationToken = default) @@ -254,7 +294,9 @@ public virtual Task GetLifecycleAsync(CancellationToken ca } /// - /// Retrieves a lifecycle policy. + /// + /// Retrieves a lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetLifecycleAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -266,7 +308,9 @@ public virtual Task GetLifecycleAsync(Action - /// Retrieves the current index lifecycle management (ILM) status. + /// + /// Retrieves the current index lifecycle management (ILM) status. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -277,7 +321,9 @@ public virtual GetIlmStatusResponse GetStatus(GetIlmStatusRequest request) } /// - /// Retrieves the current index lifecycle management (ILM) status. + /// + /// Retrieves the current index lifecycle management (ILM) status. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(GetIlmStatusRequest request, CancellationToken cancellationToken = default) @@ -287,7 +333,9 @@ public virtual Task GetStatusAsync(GetIlmStatusRequest req } /// - /// Retrieves the current index lifecycle management (ILM) status. + /// + /// Retrieves the current index lifecycle management (ILM) status. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -298,7 +346,9 @@ public virtual GetIlmStatusResponse GetStatus(GetIlmStatusRequestDescriptor desc } /// - /// Retrieves the current index lifecycle management (ILM) status. + /// + /// Retrieves the current index lifecycle management (ILM) status. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -310,7 +360,9 @@ public virtual GetIlmStatusResponse GetStatus() } /// - /// Retrieves the current index lifecycle management (ILM) status. + /// + /// Retrieves the current index lifecycle management (ILM) status. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -323,7 +375,9 @@ public virtual GetIlmStatusResponse GetStatus(Action - /// Retrieves the current index lifecycle management (ILM) status. + /// + /// Retrieves the current index lifecycle management (ILM) status. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(GetIlmStatusRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -333,7 +387,9 @@ public virtual Task GetStatusAsync(GetIlmStatusRequestDesc } /// - /// Retrieves the current index lifecycle management (ILM) status. + /// + /// Retrieves the current index lifecycle management (ILM) status. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(CancellationToken cancellationToken = default) @@ -344,7 +400,9 @@ public virtual Task GetStatusAsync(CancellationToken cance } /// - /// Retrieves the current index lifecycle management (ILM) status. + /// + /// Retrieves the current index lifecycle management (ILM) status. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -356,7 +414,11 @@ public virtual Task GetStatusAsync(Action - /// Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and
attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+
Using node roles enables ILM to automatically move the indices between data tiers. + /// + /// Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and + /// attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+ + /// Using node roles enables ILM to automatically move the indices between data tiers. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -367,7 +429,11 @@ public virtual MigrateToDataTiersResponse MigrateToDataTiers(MigrateToDataTiersR } /// - /// Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and
attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+
Using node roles enables ILM to automatically move the indices between data tiers. + /// + /// Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and + /// attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+ + /// Using node roles enables ILM to automatically move the indices between data tiers. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MigrateToDataTiersAsync(MigrateToDataTiersRequest request, CancellationToken cancellationToken = default) @@ -377,7 +443,11 @@ public virtual Task MigrateToDataTiersAsync(MigrateT } /// - /// Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and
attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+
Using node roles enables ILM to automatically move the indices between data tiers. + /// + /// Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and + /// attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+ + /// Using node roles enables ILM to automatically move the indices between data tiers. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -388,7 +458,11 @@ public virtual MigrateToDataTiersResponse MigrateToDataTiers(MigrateToDataTiersR } /// - /// Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and
attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+
Using node roles enables ILM to automatically move the indices between data tiers. + /// + /// Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and + /// attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+ + /// Using node roles enables ILM to automatically move the indices between data tiers. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -400,7 +474,11 @@ public virtual MigrateToDataTiersResponse MigrateToDataTiers() } /// - /// Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and
attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+
Using node roles enables ILM to automatically move the indices between data tiers. + /// + /// Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and + /// attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+ + /// Using node roles enables ILM to automatically move the indices between data tiers. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -413,7 +491,11 @@ public virtual MigrateToDataTiersResponse MigrateToDataTiers(Action - /// Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and
attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+
Using node roles enables ILM to automatically move the indices between data tiers. + /// + /// Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and + /// attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+ + /// Using node roles enables ILM to automatically move the indices between data tiers. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MigrateToDataTiersAsync(MigrateToDataTiersRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -423,7 +505,11 @@ public virtual Task MigrateToDataTiersAsync(MigrateT } /// - /// Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and
attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+
Using node roles enables ILM to automatically move the indices between data tiers. + /// + /// Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and + /// attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+ + /// Using node roles enables ILM to automatically move the indices between data tiers. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MigrateToDataTiersAsync(CancellationToken cancellationToken = default) @@ -434,7 +520,11 @@ public virtual Task MigrateToDataTiersAsync(Cancella } /// - /// Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and
attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+
Using node roles enables ILM to automatically move the indices between data tiers. + /// + /// Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and + /// attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+ + /// Using node roles enables ILM to automatically move the indices between data tiers. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MigrateToDataTiersAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -446,7 +536,9 @@ public virtual Task MigrateToDataTiersAsync(Action - /// Manually moves an index into the specified step and executes that step. + /// + /// Manually moves an index into the specified step and executes that step. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -457,7 +549,9 @@ public virtual MoveToStepResponse MoveToStep(MoveToStepRequest request) } /// - /// Manually moves an index into the specified step and executes that step. + /// + /// Manually moves an index into the specified step and executes that step. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MoveToStepAsync(MoveToStepRequest request, CancellationToken cancellationToken = default) @@ -467,7 +561,9 @@ public virtual Task MoveToStepAsync(MoveToStepRequest reques } /// - /// Manually moves an index into the specified step and executes that step. + /// + /// Manually moves an index into the specified step and executes that step. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -478,7 +574,9 @@ public virtual MoveToStepResponse MoveToStep(MoveToStepRequestDescrip } /// - /// Manually moves an index into the specified step and executes that step. + /// + /// Manually moves an index into the specified step and executes that step. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -490,7 +588,9 @@ public virtual MoveToStepResponse MoveToStep(Elastic.Clients.Elastics } /// - /// Manually moves an index into the specified step and executes that step. + /// + /// Manually moves an index into the specified step and executes that step. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -503,7 +603,9 @@ public virtual MoveToStepResponse MoveToStep(Elastic.Clients.Elastics } /// - /// Manually moves an index into the specified step and executes that step. + /// + /// Manually moves an index into the specified step and executes that step. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -515,7 +617,9 @@ public virtual MoveToStepResponse MoveToStep() } /// - /// Manually moves an index into the specified step and executes that step. + /// + /// Manually moves an index into the specified step and executes that step. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -528,7 +632,9 @@ public virtual MoveToStepResponse MoveToStep(Action - /// Manually moves an index into the specified step and executes that step. + /// + /// Manually moves an index into the specified step and executes that step. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -539,7 +645,9 @@ public virtual MoveToStepResponse MoveToStep(MoveToStepRequestDescriptor descrip } /// - /// Manually moves an index into the specified step and executes that step. + /// + /// Manually moves an index into the specified step and executes that step. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -551,7 +659,9 @@ public virtual MoveToStepResponse MoveToStep(Elastic.Clients.Elasticsearch.Index } /// - /// Manually moves an index into the specified step and executes that step. + /// + /// Manually moves an index into the specified step and executes that step. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -564,7 +674,9 @@ public virtual MoveToStepResponse MoveToStep(Elastic.Clients.Elasticsearch.Index } /// - /// Manually moves an index into the specified step and executes that step. + /// + /// Manually moves an index into the specified step and executes that step. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MoveToStepAsync(MoveToStepRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -574,7 +686,9 @@ public virtual Task MoveToStepAsync(MoveToStepReq } /// - /// Manually moves an index into the specified step and executes that step. + /// + /// Manually moves an index into the specified step and executes that step. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MoveToStepAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -585,7 +699,9 @@ public virtual Task MoveToStepAsync(Elastic.Clien } /// - /// Manually moves an index into the specified step and executes that step. + /// + /// Manually moves an index into the specified step and executes that step. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MoveToStepAsync(Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -597,7 +713,9 @@ public virtual Task MoveToStepAsync(Elastic.Clien } /// - /// Manually moves an index into the specified step and executes that step. + /// + /// Manually moves an index into the specified step and executes that step. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MoveToStepAsync(CancellationToken cancellationToken = default) @@ -608,7 +726,9 @@ public virtual Task MoveToStepAsync(CancellationT } /// - /// Manually moves an index into the specified step and executes that step. + /// + /// Manually moves an index into the specified step and executes that step. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MoveToStepAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -620,7 +740,9 @@ public virtual Task MoveToStepAsync(Action - /// Manually moves an index into the specified step and executes that step. + /// + /// Manually moves an index into the specified step and executes that step. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MoveToStepAsync(MoveToStepRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -630,7 +752,9 @@ public virtual Task MoveToStepAsync(MoveToStepRequestDescrip } /// - /// Manually moves an index into the specified step and executes that step. + /// + /// Manually moves an index into the specified step and executes that step. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MoveToStepAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -641,7 +765,9 @@ public virtual Task MoveToStepAsync(Elastic.Clients.Elastics } /// - /// Manually moves an index into the specified step and executes that step. + /// + /// Manually moves an index into the specified step and executes that step. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MoveToStepAsync(Elastic.Clients.Elasticsearch.IndexName index, Action configureRequest, CancellationToken cancellationToken = default) @@ -653,7 +779,9 @@ public virtual Task MoveToStepAsync(Elastic.Clients.Elastics } /// - /// Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. + /// + /// Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -664,7 +792,9 @@ public virtual PutLifecycleResponse PutLifecycle(PutLifecycleRequest request) } /// - /// Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. + /// + /// Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutLifecycleAsync(PutLifecycleRequest request, CancellationToken cancellationToken = default) @@ -674,7 +804,9 @@ public virtual Task PutLifecycleAsync(PutLifecycleRequest } /// - /// Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. + /// + /// Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -685,7 +817,9 @@ public virtual PutLifecycleResponse PutLifecycle(PutLifecycleRequestDescriptor d } /// - /// Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. + /// + /// Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -697,7 +831,9 @@ public virtual PutLifecycleResponse PutLifecycle(Elastic.Clients.Elasticsearch.N } /// - /// Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. + /// + /// Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -710,7 +846,9 @@ public virtual PutLifecycleResponse PutLifecycle(Elastic.Clients.Elasticsearch.N } /// - /// Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. + /// + /// Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutLifecycleAsync(PutLifecycleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -720,7 +858,9 @@ public virtual Task PutLifecycleAsync(PutLifecycleRequestD } /// - /// Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. + /// + /// Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutLifecycleAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) @@ -731,7 +871,9 @@ public virtual Task PutLifecycleAsync(Elastic.Clients.Elas } /// - /// Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. + /// + /// Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutLifecycleAsync(Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -743,7 +885,9 @@ public virtual Task PutLifecycleAsync(Elastic.Clients.Elas } /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// + /// Removes the assigned lifecycle policy and stops managing the specified index + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -754,7 +898,9 @@ public virtual RemovePolicyResponse RemovePolicy(RemovePolicyRequest request) } /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// + /// Removes the assigned lifecycle policy and stops managing the specified index + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RemovePolicyAsync(RemovePolicyRequest request, CancellationToken cancellationToken = default) @@ -764,7 +910,9 @@ public virtual Task RemovePolicyAsync(RemovePolicyRequest } /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// + /// Removes the assigned lifecycle policy and stops managing the specified index + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -775,7 +923,9 @@ public virtual RemovePolicyResponse RemovePolicy(RemovePolicyRequestD } /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// + /// Removes the assigned lifecycle policy and stops managing the specified index + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -787,7 +937,9 @@ public virtual RemovePolicyResponse RemovePolicy(Elastic.Clients.Elas } /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// + /// Removes the assigned lifecycle policy and stops managing the specified index + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -800,7 +952,9 @@ public virtual RemovePolicyResponse RemovePolicy(Elastic.Clients.Elas } /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// + /// Removes the assigned lifecycle policy and stops managing the specified index + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -812,7 +966,9 @@ public virtual RemovePolicyResponse RemovePolicy() } /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// + /// Removes the assigned lifecycle policy and stops managing the specified index + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -825,7 +981,9 @@ public virtual RemovePolicyResponse RemovePolicy(Action - /// Removes the assigned lifecycle policy and stops managing the specified index + /// + /// Removes the assigned lifecycle policy and stops managing the specified index + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -836,7 +994,9 @@ public virtual RemovePolicyResponse RemovePolicy(RemovePolicyRequestDescriptor d } /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// + /// Removes the assigned lifecycle policy and stops managing the specified index + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -848,7 +1008,9 @@ public virtual RemovePolicyResponse RemovePolicy(Elastic.Clients.Elasticsearch.I } /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// + /// Removes the assigned lifecycle policy and stops managing the specified index + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -861,7 +1023,9 @@ public virtual RemovePolicyResponse RemovePolicy(Elastic.Clients.Elasticsearch.I } /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// + /// Removes the assigned lifecycle policy and stops managing the specified index + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RemovePolicyAsync(RemovePolicyRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -871,7 +1035,9 @@ public virtual Task RemovePolicyAsync(RemovePol } /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// + /// Removes the assigned lifecycle policy and stops managing the specified index + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RemovePolicyAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -882,7 +1048,9 @@ public virtual Task RemovePolicyAsync(Elastic.C } /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// + /// Removes the assigned lifecycle policy and stops managing the specified index + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RemovePolicyAsync(Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -894,7 +1062,9 @@ public virtual Task RemovePolicyAsync(Elastic.C } /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// + /// Removes the assigned lifecycle policy and stops managing the specified index + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RemovePolicyAsync(CancellationToken cancellationToken = default) @@ -905,7 +1075,9 @@ public virtual Task RemovePolicyAsync(Cancellat } /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// + /// Removes the assigned lifecycle policy and stops managing the specified index + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RemovePolicyAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -917,7 +1089,9 @@ public virtual Task RemovePolicyAsync(Action - /// Removes the assigned lifecycle policy and stops managing the specified index + /// + /// Removes the assigned lifecycle policy and stops managing the specified index + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RemovePolicyAsync(RemovePolicyRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -927,7 +1101,9 @@ public virtual Task RemovePolicyAsync(RemovePolicyRequestD } /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// + /// Removes the assigned lifecycle policy and stops managing the specified index + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RemovePolicyAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -938,7 +1114,9 @@ public virtual Task RemovePolicyAsync(Elastic.Clients.Elas } /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// + /// Removes the assigned lifecycle policy and stops managing the specified index + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RemovePolicyAsync(Elastic.Clients.Elasticsearch.IndexName index, Action configureRequest, CancellationToken cancellationToken = default) @@ -950,7 +1128,9 @@ public virtual Task RemovePolicyAsync(Elastic.Clients.Elas } /// - /// Retries executing the policy for an index that is in the ERROR step. + /// + /// Retries executing the policy for an index that is in the ERROR step. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -961,7 +1141,9 @@ public virtual RetryResponse Retry(RetryRequest request) } /// - /// Retries executing the policy for an index that is in the ERROR step. + /// + /// Retries executing the policy for an index that is in the ERROR step. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RetryAsync(RetryRequest request, CancellationToken cancellationToken = default) @@ -971,7 +1153,9 @@ public virtual Task RetryAsync(RetryRequest request, Cancellation } /// - /// Retries executing the policy for an index that is in the ERROR step. + /// + /// Retries executing the policy for an index that is in the ERROR step. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -982,7 +1166,9 @@ public virtual RetryResponse Retry(RetryRequestDescriptor } /// - /// Retries executing the policy for an index that is in the ERROR step. + /// + /// Retries executing the policy for an index that is in the ERROR step. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -994,7 +1180,9 @@ public virtual RetryResponse Retry(Elastic.Clients.Elasticsearch.Inde } /// - /// Retries executing the policy for an index that is in the ERROR step. + /// + /// Retries executing the policy for an index that is in the ERROR step. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1007,7 +1195,9 @@ public virtual RetryResponse Retry(Elastic.Clients.Elasticsearch.Inde } /// - /// Retries executing the policy for an index that is in the ERROR step. + /// + /// Retries executing the policy for an index that is in the ERROR step. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1019,7 +1209,9 @@ public virtual RetryResponse Retry() } /// - /// Retries executing the policy for an index that is in the ERROR step. + /// + /// Retries executing the policy for an index that is in the ERROR step. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1032,7 +1224,9 @@ public virtual RetryResponse Retry(Action - /// Retries executing the policy for an index that is in the ERROR step. + /// + /// Retries executing the policy for an index that is in the ERROR step. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1043,7 +1237,9 @@ public virtual RetryResponse Retry(RetryRequestDescriptor descriptor) } /// - /// Retries executing the policy for an index that is in the ERROR step. + /// + /// Retries executing the policy for an index that is in the ERROR step. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1055,7 +1251,9 @@ public virtual RetryResponse Retry(Elastic.Clients.Elasticsearch.IndexName index } /// - /// Retries executing the policy for an index that is in the ERROR step. + /// + /// Retries executing the policy for an index that is in the ERROR step. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1068,7 +1266,9 @@ public virtual RetryResponse Retry(Elastic.Clients.Elasticsearch.IndexName index } /// - /// Retries executing the policy for an index that is in the ERROR step. + /// + /// Retries executing the policy for an index that is in the ERROR step. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RetryAsync(RetryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1078,7 +1278,9 @@ public virtual Task RetryAsync(RetryRequestDescriptor< } /// - /// Retries executing the policy for an index that is in the ERROR step. + /// + /// Retries executing the policy for an index that is in the ERROR step. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RetryAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -1089,7 +1291,9 @@ public virtual Task RetryAsync(Elastic.Clients.Elastic } /// - /// Retries executing the policy for an index that is in the ERROR step. + /// + /// Retries executing the policy for an index that is in the ERROR step. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RetryAsync(Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1101,7 +1305,9 @@ public virtual Task RetryAsync(Elastic.Clients.Elastic } /// - /// Retries executing the policy for an index that is in the ERROR step. + /// + /// Retries executing the policy for an index that is in the ERROR step. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RetryAsync(CancellationToken cancellationToken = default) @@ -1112,7 +1318,9 @@ public virtual Task RetryAsync(CancellationToken cance } /// - /// Retries executing the policy for an index that is in the ERROR step. + /// + /// Retries executing the policy for an index that is in the ERROR step. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RetryAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -1124,7 +1332,9 @@ public virtual Task RetryAsync(Action - /// Retries executing the policy for an index that is in the ERROR step. + /// + /// Retries executing the policy for an index that is in the ERROR step. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RetryAsync(RetryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1134,7 +1344,9 @@ public virtual Task RetryAsync(RetryRequestDescriptor descriptor, } /// - /// Retries executing the policy for an index that is in the ERROR step. + /// + /// Retries executing the policy for an index that is in the ERROR step. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RetryAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -1145,7 +1357,9 @@ public virtual Task RetryAsync(Elastic.Clients.Elasticsearch.Inde } /// - /// Retries executing the policy for an index that is in the ERROR step. + /// + /// Retries executing the policy for an index that is in the ERROR step. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RetryAsync(Elastic.Clients.Elasticsearch.IndexName index, Action configureRequest, CancellationToken cancellationToken = default) @@ -1157,7 +1371,9 @@ public virtual Task RetryAsync(Elastic.Clients.Elasticsearch.Inde } /// - /// Start the index lifecycle management (ILM) plugin. + /// + /// Start the index lifecycle management (ILM) plugin. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1168,7 +1384,9 @@ public virtual StartIlmResponse Start(StartIlmRequest request) } /// - /// Start the index lifecycle management (ILM) plugin. + /// + /// Start the index lifecycle management (ILM) plugin. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartAsync(StartIlmRequest request, CancellationToken cancellationToken = default) @@ -1178,7 +1396,9 @@ public virtual Task StartAsync(StartIlmRequest request, Cancel } /// - /// Start the index lifecycle management (ILM) plugin. + /// + /// Start the index lifecycle management (ILM) plugin. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1189,7 +1409,9 @@ public virtual StartIlmResponse Start(StartIlmRequestDescriptor descriptor) } /// - /// Start the index lifecycle management (ILM) plugin. + /// + /// Start the index lifecycle management (ILM) plugin. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1201,7 +1423,9 @@ public virtual StartIlmResponse Start() } /// - /// Start the index lifecycle management (ILM) plugin. + /// + /// Start the index lifecycle management (ILM) plugin. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1214,7 +1438,9 @@ public virtual StartIlmResponse Start(Action configur } /// - /// Start the index lifecycle management (ILM) plugin. + /// + /// Start the index lifecycle management (ILM) plugin. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartAsync(StartIlmRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1224,7 +1450,9 @@ public virtual Task StartAsync(StartIlmRequestDescriptor descr } /// - /// Start the index lifecycle management (ILM) plugin. + /// + /// Start the index lifecycle management (ILM) plugin. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartAsync(CancellationToken cancellationToken = default) @@ -1235,7 +1463,9 @@ public virtual Task StartAsync(CancellationToken cancellationT } /// - /// Start the index lifecycle management (ILM) plugin. + /// + /// Start the index lifecycle management (ILM) plugin. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -1247,7 +1477,9 @@ public virtual Task StartAsync(Action - /// Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin + /// + /// Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1258,7 +1490,9 @@ public virtual StopIlmResponse Stop(StopIlmRequest request) } /// - /// Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin + /// + /// Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopAsync(StopIlmRequest request, CancellationToken cancellationToken = default) @@ -1268,7 +1502,9 @@ public virtual Task StopAsync(StopIlmRequest request, Cancellat } /// - /// Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin + /// + /// Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1279,7 +1515,9 @@ public virtual StopIlmResponse Stop(StopIlmRequestDescriptor descriptor) } /// - /// Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin + /// + /// Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1291,7 +1529,9 @@ public virtual StopIlmResponse Stop() } /// - /// Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin + /// + /// Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1304,7 +1544,9 @@ public virtual StopIlmResponse Stop(Action configureRe } /// - /// Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin + /// + /// Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopAsync(StopIlmRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1314,7 +1556,9 @@ public virtual Task StopAsync(StopIlmRequestDescriptor descript } /// - /// Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin + /// + /// Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopAsync(CancellationToken cancellationToken = default) @@ -1325,7 +1569,9 @@ public virtual Task StopAsync(CancellationToken cancellationTok } /// - /// Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin + /// + /// Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopAsync(Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Indices.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Indices.g.cs index 58aa134b846..2a92aa190e6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Indices.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Indices.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public partial class IndicesNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected IndicesNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal IndicesNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -49,7 +53,9 @@ public virtual AnalyzeIndexResponse Analyze(AnalyzeIndexRequest request) } /// - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(AnalyzeIndexRequest request, CancellationToken cancellationToken = default) @@ -59,7 +65,9 @@ public virtual Task AnalyzeAsync(AnalyzeIndexRequest reque } /// - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -70,7 +78,9 @@ public virtual AnalyzeIndexResponse Analyze(AnalyzeIndexRequestDescri } /// - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -82,7 +92,9 @@ public virtual AnalyzeIndexResponse Analyze(Elastic.Clients.Elasticse } /// - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -95,7 +107,9 @@ public virtual AnalyzeIndexResponse Analyze(Elastic.Clients.Elasticse } /// - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -107,7 +121,9 @@ public virtual AnalyzeIndexResponse Analyze() } /// - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -120,7 +136,9 @@ public virtual AnalyzeIndexResponse Analyze(Action - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -131,7 +149,9 @@ public virtual AnalyzeIndexResponse Analyze(AnalyzeIndexRequestDescriptor descri } /// - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -143,7 +163,9 @@ public virtual AnalyzeIndexResponse Analyze(Elastic.Clients.Elasticsearch.IndexN } /// - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -156,7 +178,9 @@ public virtual AnalyzeIndexResponse Analyze(Elastic.Clients.Elasticsearch.IndexN } /// - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -168,7 +192,9 @@ public virtual AnalyzeIndexResponse Analyze() } /// - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -181,7 +207,9 @@ public virtual AnalyzeIndexResponse Analyze(Action - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(AnalyzeIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -191,7 +219,9 @@ public virtual Task AnalyzeAsync(AnalyzeIndexRe } /// - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(Elastic.Clients.Elasticsearch.IndexName? index, CancellationToken cancellationToken = default) @@ -202,7 +232,9 @@ public virtual Task AnalyzeAsync(Elastic.Client } /// - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(Elastic.Clients.Elasticsearch.IndexName? index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -214,7 +246,9 @@ public virtual Task AnalyzeAsync(Elastic.Client } /// - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(CancellationToken cancellationToken = default) @@ -225,7 +259,9 @@ public virtual Task AnalyzeAsync(CancellationTo } /// - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -237,7 +273,9 @@ public virtual Task AnalyzeAsync(Action - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(AnalyzeIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -247,7 +285,9 @@ public virtual Task AnalyzeAsync(AnalyzeIndexRequestDescri } /// - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(Elastic.Clients.Elasticsearch.IndexName? index, CancellationToken cancellationToken = default) @@ -258,7 +298,9 @@ public virtual Task AnalyzeAsync(Elastic.Clients.Elasticse } /// - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(Elastic.Clients.Elasticsearch.IndexName? index, Action configureRequest, CancellationToken cancellationToken = default) @@ -270,7 +312,9 @@ public virtual Task AnalyzeAsync(Elastic.Clients.Elasticse } /// - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(CancellationToken cancellationToken = default) @@ -281,7 +325,9 @@ public virtual Task AnalyzeAsync(CancellationToken cancell } /// - /// Performs analysis on a text string and returns the resulting tokens. + /// + /// Performs analysis on a text string and returns the resulting tokens. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -293,7 +339,10 @@ public virtual Task AnalyzeAsync(Action - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -304,7 +353,10 @@ public virtual ClearCacheResponse ClearCache(ClearCacheRequest request) } /// - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(ClearCacheRequest request, CancellationToken cancellationToken = default) @@ -314,7 +366,10 @@ public virtual Task ClearCacheAsync(ClearCacheRequest reques } /// - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -325,7 +380,10 @@ public virtual ClearCacheResponse ClearCache(ClearCacheRequestDescrip } /// - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -337,7 +395,10 @@ public virtual ClearCacheResponse ClearCache(Elastic.Clients.Elastics } /// - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -350,7 +411,10 @@ public virtual ClearCacheResponse ClearCache(Elastic.Clients.Elastics } /// - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -362,7 +426,10 @@ public virtual ClearCacheResponse ClearCache() } /// - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -375,7 +442,10 @@ public virtual ClearCacheResponse ClearCache(Action - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -386,7 +456,10 @@ public virtual ClearCacheResponse ClearCache(ClearCacheRequestDescriptor descrip } /// - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -398,7 +471,10 @@ public virtual ClearCacheResponse ClearCache(Elastic.Clients.Elasticsearch.Indic } /// - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -411,7 +487,10 @@ public virtual ClearCacheResponse ClearCache(Elastic.Clients.Elasticsearch.Indic } /// - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -423,7 +502,10 @@ public virtual ClearCacheResponse ClearCache() } /// - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -436,7 +518,10 @@ public virtual ClearCacheResponse ClearCache(Action } /// - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(ClearCacheRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -446,7 +531,10 @@ public virtual Task ClearCacheAsync(ClearCacheReq } /// - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -457,7 +545,10 @@ public virtual Task ClearCacheAsync(Elastic.Clien } /// - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -469,7 +560,10 @@ public virtual Task ClearCacheAsync(Elastic.Clien } /// - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(CancellationToken cancellationToken = default) @@ -480,7 +574,10 @@ public virtual Task ClearCacheAsync(CancellationT } /// - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -492,7 +589,10 @@ public virtual Task ClearCacheAsync(Action - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(ClearCacheRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -502,7 +602,10 @@ public virtual Task ClearCacheAsync(ClearCacheRequestDescrip } /// - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -513,7 +616,10 @@ public virtual Task ClearCacheAsync(Elastic.Clients.Elastics } /// - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -525,7 +631,10 @@ public virtual Task ClearCacheAsync(Elastic.Clients.Elastics } /// - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(CancellationToken cancellationToken = default) @@ -536,7 +645,10 @@ public virtual Task ClearCacheAsync(CancellationToken cancel } /// - /// Clears the caches of one or more indices.
For data streams, the API clears the caches of the stream’s backing indices. + /// + /// Clears the caches of one or more indices. + /// For data streams, the API clears the caches of the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -548,7 +660,9 @@ public virtual Task ClearCacheAsync(Action - /// Clones an existing index. + /// + /// Clones an existing index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -559,7 +673,9 @@ public virtual CloneIndexResponse Clone(CloneIndexRequest request) } /// - /// Clones an existing index. + /// + /// Clones an existing index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloneAsync(CloneIndexRequest request, CancellationToken cancellationToken = default) @@ -569,7 +685,9 @@ public virtual Task CloneAsync(CloneIndexRequest request, Ca } /// - /// Clones an existing index. + /// + /// Clones an existing index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -580,7 +698,9 @@ public virtual CloneIndexResponse Clone(CloneIndexRequestDescriptor - /// Clones an existing index. + /// + /// Clones an existing index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -592,7 +712,9 @@ public virtual CloneIndexResponse Clone(Elastic.Clients.Elasticsearch } /// - /// Clones an existing index. + /// + /// Clones an existing index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -605,7 +727,9 @@ public virtual CloneIndexResponse Clone(Elastic.Clients.Elasticsearch } /// - /// Clones an existing index. + /// + /// Clones an existing index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -617,7 +741,9 @@ public virtual CloneIndexResponse Clone(Elastic.Clients.Elasticsearch } /// - /// Clones an existing index. + /// + /// Clones an existing index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -630,7 +756,9 @@ public virtual CloneIndexResponse Clone(Elastic.Clients.Elasticsearch } /// - /// Clones an existing index. + /// + /// Clones an existing index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -641,7 +769,9 @@ public virtual CloneIndexResponse Clone(CloneIndexRequestDescriptor descriptor) } /// - /// Clones an existing index. + /// + /// Clones an existing index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -653,7 +783,9 @@ public virtual CloneIndexResponse Clone(Elastic.Clients.Elasticsearch.IndexName } /// - /// Clones an existing index. + /// + /// Clones an existing index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -666,7 +798,9 @@ public virtual CloneIndexResponse Clone(Elastic.Clients.Elasticsearch.IndexName } /// - /// Clones an existing index. + /// + /// Clones an existing index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloneAsync(CloneIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -676,7 +810,9 @@ public virtual Task CloneAsync(CloneIndexRequestD } /// - /// Clones an existing index. + /// + /// Clones an existing index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloneAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Name target, CancellationToken cancellationToken = default) @@ -687,7 +823,9 @@ public virtual Task CloneAsync(Elastic.Clients.El } /// - /// Clones an existing index. + /// + /// Clones an existing index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloneAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Name target, Action> configureRequest, CancellationToken cancellationToken = default) @@ -699,7 +837,9 @@ public virtual Task CloneAsync(Elastic.Clients.El } /// - /// Clones an existing index. + /// + /// Clones an existing index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloneAsync(Elastic.Clients.Elasticsearch.Name target, CancellationToken cancellationToken = default) @@ -710,7 +850,9 @@ public virtual Task CloneAsync(Elastic.Clients.El } /// - /// Clones an existing index. + /// + /// Clones an existing index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloneAsync(Elastic.Clients.Elasticsearch.Name target, Action> configureRequest, CancellationToken cancellationToken = default) @@ -722,7 +864,9 @@ public virtual Task CloneAsync(Elastic.Clients.El } /// - /// Clones an existing index. + /// + /// Clones an existing index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloneAsync(CloneIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -732,7 +876,9 @@ public virtual Task CloneAsync(CloneIndexRequestDescriptor d } /// - /// Clones an existing index. + /// + /// Clones an existing index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloneAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Name target, CancellationToken cancellationToken = default) @@ -743,7 +889,9 @@ public virtual Task CloneAsync(Elastic.Clients.Elasticsearch } /// - /// Clones an existing index. + /// + /// Clones an existing index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloneAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Name target, Action configureRequest, CancellationToken cancellationToken = default) @@ -755,7 +903,9 @@ public virtual Task CloneAsync(Elastic.Clients.Elasticsearch } /// - /// Closes an index. + /// + /// Closes an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -766,7 +916,9 @@ public virtual CloseIndexResponse Close(CloseIndexRequest request) } /// - /// Closes an index. + /// + /// Closes an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(CloseIndexRequest request, CancellationToken cancellationToken = default) @@ -776,7 +928,9 @@ public virtual Task CloseAsync(CloseIndexRequest request, Ca } /// - /// Closes an index. + /// + /// Closes an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -787,7 +941,9 @@ public virtual CloseIndexResponse Close(CloseIndexRequestDescriptor - /// Closes an index. + /// + /// Closes an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -799,7 +955,9 @@ public virtual CloseIndexResponse Close(Elastic.Clients.Elasticsearch } /// - /// Closes an index. + /// + /// Closes an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -812,7 +970,9 @@ public virtual CloseIndexResponse Close(Elastic.Clients.Elasticsearch } /// - /// Closes an index. + /// + /// Closes an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -824,7 +984,9 @@ public virtual CloseIndexResponse Close() } /// - /// Closes an index. + /// + /// Closes an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -837,7 +999,9 @@ public virtual CloseIndexResponse Close(Action - /// Closes an index. + /// + /// Closes an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -848,7 +1012,9 @@ public virtual CloseIndexResponse Close(CloseIndexRequestDescriptor descriptor) } /// - /// Closes an index. + /// + /// Closes an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -860,7 +1026,9 @@ public virtual CloseIndexResponse Close(Elastic.Clients.Elasticsearch.Indices in } /// - /// Closes an index. + /// + /// Closes an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -873,7 +1041,9 @@ public virtual CloseIndexResponse Close(Elastic.Clients.Elasticsearch.Indices in } /// - /// Closes an index. + /// + /// Closes an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(CloseIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -883,7 +1053,9 @@ public virtual Task CloseAsync(CloseIndexRequestD } /// - /// Closes an index. + /// + /// Closes an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -894,7 +1066,9 @@ public virtual Task CloseAsync(Elastic.Clients.El } /// - /// Closes an index. + /// + /// Closes an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -906,7 +1080,9 @@ public virtual Task CloseAsync(Elastic.Clients.El } /// - /// Closes an index. + /// + /// Closes an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(CancellationToken cancellationToken = default) @@ -917,7 +1093,9 @@ public virtual Task CloseAsync(CancellationToken } /// - /// Closes an index. + /// + /// Closes an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -929,7 +1107,9 @@ public virtual Task CloseAsync(Action - /// Closes an index. + /// + /// Closes an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(CloseIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -939,7 +1119,9 @@ public virtual Task CloseAsync(CloseIndexRequestDescriptor d } /// - /// Closes an index. + /// + /// Closes an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -950,7 +1132,9 @@ public virtual Task CloseAsync(Elastic.Clients.Elasticsearch } /// - /// Closes an index. + /// + /// Closes an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -962,7 +1146,10 @@ public virtual Task CloseAsync(Elastic.Clients.Elasticsearch } /// - /// Create an index.
Creates a new index. + /// + /// Create an index. + /// Creates a new index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -973,7 +1160,10 @@ public virtual CreateIndexResponse Create(CreateIndexRequest request) } /// - /// Create an index.
Creates a new index. + /// + /// Create an index. + /// Creates a new index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(CreateIndexRequest request, CancellationToken cancellationToken = default) @@ -983,7 +1173,10 @@ public virtual Task CreateAsync(CreateIndexRequest request, } /// - /// Create an index.
Creates a new index. + /// + /// Create an index. + /// Creates a new index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -994,7 +1187,10 @@ public virtual CreateIndexResponse Create(CreateIndexRequestDescripto } /// - /// Create an index.
Creates a new index. + /// + /// Create an index. + /// Creates a new index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1006,7 +1202,10 @@ public virtual CreateIndexResponse Create(Elastic.Clients.Elasticsear } /// - /// Create an index.
Creates a new index. + /// + /// Create an index. + /// Creates a new index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1019,7 +1218,10 @@ public virtual CreateIndexResponse Create(Elastic.Clients.Elasticsear } /// - /// Create an index.
Creates a new index. + /// + /// Create an index. + /// Creates a new index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1031,7 +1233,10 @@ public virtual CreateIndexResponse Create() } /// - /// Create an index.
Creates a new index. + /// + /// Create an index. + /// Creates a new index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1044,7 +1249,10 @@ public virtual CreateIndexResponse Create(Action - /// Create an index.
Creates a new index. + /// + /// Create an index. + /// Creates a new index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1055,7 +1263,10 @@ public virtual CreateIndexResponse Create(CreateIndexRequestDescriptor descripto } /// - /// Create an index.
Creates a new index. + /// + /// Create an index. + /// Creates a new index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1067,7 +1278,10 @@ public virtual CreateIndexResponse Create(Elastic.Clients.Elasticsearch.IndexNam } /// - /// Create an index.
Creates a new index. + /// + /// Create an index. + /// Creates a new index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1080,7 +1294,10 @@ public virtual CreateIndexResponse Create(Elastic.Clients.Elasticsearch.IndexNam } /// - /// Create an index.
Creates a new index. + /// + /// Create an index. + /// Creates a new index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(CreateIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1090,7 +1307,10 @@ public virtual Task CreateAsync(CreateIndexReque } /// - /// Create an index.
Creates a new index. + /// + /// Create an index. + /// Creates a new index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -1101,7 +1321,10 @@ public virtual Task CreateAsync(Elastic.Clients. } /// - /// Create an index.
Creates a new index. + /// + /// Create an index. + /// Creates a new index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1113,7 +1336,10 @@ public virtual Task CreateAsync(Elastic.Clients. } /// - /// Create an index.
Creates a new index. + /// + /// Create an index. + /// Creates a new index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(CancellationToken cancellationToken = default) @@ -1124,7 +1350,10 @@ public virtual Task CreateAsync(CancellationToke } /// - /// Create an index.
Creates a new index. + /// + /// Create an index. + /// Creates a new index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -1136,7 +1365,10 @@ public virtual Task CreateAsync(Action - /// Create an index.
Creates a new index. + /// + /// Create an index. + /// Creates a new index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(CreateIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1146,7 +1378,10 @@ public virtual Task CreateAsync(CreateIndexRequestDescripto } /// - /// Create an index.
Creates a new index. + /// + /// Create an index. + /// Creates a new index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -1157,7 +1392,10 @@ public virtual Task CreateAsync(Elastic.Clients.Elasticsear } /// - /// Create an index.
Creates a new index. + /// + /// Create an index. + /// Creates a new index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(Elastic.Clients.Elasticsearch.IndexName index, Action configureRequest, CancellationToken cancellationToken = default) @@ -1169,7 +1407,11 @@ public virtual Task CreateAsync(Elastic.Clients.Elasticsear } /// - /// Create a data stream.
Creates a data stream.
You must have a matching index template with data stream enabled. + /// + /// Create a data stream. + /// Creates a data stream. + /// You must have a matching index template with data stream enabled. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1180,7 +1422,11 @@ public virtual CreateDataStreamResponse CreateDataStream(CreateDataStreamRequest } /// - /// Create a data stream.
Creates a data stream.
You must have a matching index template with data stream enabled. + /// + /// Create a data stream. + /// Creates a data stream. + /// You must have a matching index template with data stream enabled. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateDataStreamAsync(CreateDataStreamRequest request, CancellationToken cancellationToken = default) @@ -1190,7 +1436,11 @@ public virtual Task CreateDataStreamAsync(CreateDataSt } /// - /// Create a data stream.
Creates a data stream.
You must have a matching index template with data stream enabled. + /// + /// Create a data stream. + /// Creates a data stream. + /// You must have a matching index template with data stream enabled. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1201,7 +1451,11 @@ public virtual CreateDataStreamResponse CreateDataStream(CreateDataStreamRequest } /// - /// Create a data stream.
Creates a data stream.
You must have a matching index template with data stream enabled. + /// + /// Create a data stream. + /// Creates a data stream. + /// You must have a matching index template with data stream enabled. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1213,7 +1467,11 @@ public virtual CreateDataStreamResponse CreateDataStream(Elastic.Clients.Elastic } /// - /// Create a data stream.
Creates a data stream.
You must have a matching index template with data stream enabled. + /// + /// Create a data stream. + /// Creates a data stream. + /// You must have a matching index template with data stream enabled. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1226,7 +1484,11 @@ public virtual CreateDataStreamResponse CreateDataStream(Elastic.Clients.Elastic } /// - /// Create a data stream.
Creates a data stream.
You must have a matching index template with data stream enabled. + /// + /// Create a data stream. + /// Creates a data stream. + /// You must have a matching index template with data stream enabled. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateDataStreamAsync(CreateDataStreamRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1236,7 +1498,11 @@ public virtual Task CreateDataStreamAsync(CreateDataSt } /// - /// Create a data stream.
Creates a data stream.
You must have a matching index template with data stream enabled. + /// + /// Create a data stream. + /// Creates a data stream. + /// You must have a matching index template with data stream enabled. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateDataStreamAsync(Elastic.Clients.Elasticsearch.DataStreamName name, CancellationToken cancellationToken = default) @@ -1247,7 +1513,11 @@ public virtual Task CreateDataStreamAsync(Elastic.Clie } /// - /// Create a data stream.
Creates a data stream.
You must have a matching index template with data stream enabled. + /// + /// Create a data stream. + /// Creates a data stream. + /// You must have a matching index template with data stream enabled. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateDataStreamAsync(Elastic.Clients.Elasticsearch.DataStreamName name, Action configureRequest, CancellationToken cancellationToken = default) @@ -1259,7 +1529,10 @@ public virtual Task CreateDataStreamAsync(Elastic.Clie } /// - /// Get data stream stats.
Retrieves statistics for one or more data streams. + /// + /// Get data stream stats. + /// Retrieves statistics for one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1270,7 +1543,10 @@ public virtual DataStreamsStatsResponse DataStreamsStats(DataStreamsStatsRequest } /// - /// Get data stream stats.
Retrieves statistics for one or more data streams. + /// + /// Get data stream stats. + /// Retrieves statistics for one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DataStreamsStatsAsync(DataStreamsStatsRequest request, CancellationToken cancellationToken = default) @@ -1280,7 +1556,10 @@ public virtual Task DataStreamsStatsAsync(DataStreamsS } /// - /// Get data stream stats.
Retrieves statistics for one or more data streams. + /// + /// Get data stream stats. + /// Retrieves statistics for one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1291,7 +1570,10 @@ public virtual DataStreamsStatsResponse DataStreamsStats(DataStreamsStatsRequest } /// - /// Get data stream stats.
Retrieves statistics for one or more data streams. + /// + /// Get data stream stats. + /// Retrieves statistics for one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1303,7 +1585,10 @@ public virtual DataStreamsStatsResponse DataStreamsStats(Elastic.Clients.Elastic } /// - /// Get data stream stats.
Retrieves statistics for one or more data streams. + /// + /// Get data stream stats. + /// Retrieves statistics for one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1316,7 +1601,10 @@ public virtual DataStreamsStatsResponse DataStreamsStats(Elastic.Clients.Elastic } /// - /// Get data stream stats.
Retrieves statistics for one or more data streams. + /// + /// Get data stream stats. + /// Retrieves statistics for one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1328,7 +1616,10 @@ public virtual DataStreamsStatsResponse DataStreamsStats() } /// - /// Get data stream stats.
Retrieves statistics for one or more data streams. + /// + /// Get data stream stats. + /// Retrieves statistics for one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1341,7 +1632,10 @@ public virtual DataStreamsStatsResponse DataStreamsStats(Action - /// Get data stream stats.
Retrieves statistics for one or more data streams. + /// + /// Get data stream stats. + /// Retrieves statistics for one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DataStreamsStatsAsync(DataStreamsStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1351,7 +1645,10 @@ public virtual Task DataStreamsStatsAsync(DataStreamsS } /// - /// Get data stream stats.
Retrieves statistics for one or more data streams. + /// + /// Get data stream stats. + /// Retrieves statistics for one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DataStreamsStatsAsync(Elastic.Clients.Elasticsearch.IndexName? name, CancellationToken cancellationToken = default) @@ -1362,7 +1659,10 @@ public virtual Task DataStreamsStatsAsync(Elastic.Clie } /// - /// Get data stream stats.
Retrieves statistics for one or more data streams. + /// + /// Get data stream stats. + /// Retrieves statistics for one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DataStreamsStatsAsync(Elastic.Clients.Elasticsearch.IndexName? name, Action configureRequest, CancellationToken cancellationToken = default) @@ -1374,7 +1674,10 @@ public virtual Task DataStreamsStatsAsync(Elastic.Clie } /// - /// Get data stream stats.
Retrieves statistics for one or more data streams. + /// + /// Get data stream stats. + /// Retrieves statistics for one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DataStreamsStatsAsync(CancellationToken cancellationToken = default) @@ -1385,7 +1688,10 @@ public virtual Task DataStreamsStatsAsync(Cancellation } /// - /// Get data stream stats.
Retrieves statistics for one or more data streams. + /// + /// Get data stream stats. + /// Retrieves statistics for one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DataStreamsStatsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -1397,7 +1703,10 @@ public virtual Task DataStreamsStatsAsync(Action - /// Delete indices.
Deletes one or more indices. + /// + /// Delete indices. + /// Deletes one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1408,7 +1717,10 @@ public virtual DeleteIndexResponse Delete(DeleteIndexRequest request) } /// - /// Delete indices.
Deletes one or more indices. + /// + /// Delete indices. + /// Deletes one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteIndexRequest request, CancellationToken cancellationToken = default) @@ -1418,7 +1730,10 @@ public virtual Task DeleteAsync(DeleteIndexRequest request, } /// - /// Delete indices.
Deletes one or more indices. + /// + /// Delete indices. + /// Deletes one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1429,7 +1744,10 @@ public virtual DeleteIndexResponse Delete(DeleteIndexRequestDescripto } /// - /// Delete indices.
Deletes one or more indices. + /// + /// Delete indices. + /// Deletes one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1441,7 +1759,10 @@ public virtual DeleteIndexResponse Delete(Elastic.Clients.Elasticsear } /// - /// Delete indices.
Deletes one or more indices. + /// + /// Delete indices. + /// Deletes one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1454,7 +1775,10 @@ public virtual DeleteIndexResponse Delete(Elastic.Clients.Elasticsear } /// - /// Delete indices.
Deletes one or more indices. + /// + /// Delete indices. + /// Deletes one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1466,7 +1790,10 @@ public virtual DeleteIndexResponse Delete() } /// - /// Delete indices.
Deletes one or more indices. + /// + /// Delete indices. + /// Deletes one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1479,7 +1806,10 @@ public virtual DeleteIndexResponse Delete(Action - /// Delete indices.
Deletes one or more indices. + /// + /// Delete indices. + /// Deletes one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1490,7 +1820,10 @@ public virtual DeleteIndexResponse Delete(DeleteIndexRequestDescriptor descripto } /// - /// Delete indices.
Deletes one or more indices. + /// + /// Delete indices. + /// Deletes one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1502,7 +1835,10 @@ public virtual DeleteIndexResponse Delete(Elastic.Clients.Elasticsearch.Indices } /// - /// Delete indices.
Deletes one or more indices. + /// + /// Delete indices. + /// Deletes one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1515,7 +1851,10 @@ public virtual DeleteIndexResponse Delete(Elastic.Clients.Elasticsearch.Indices } /// - /// Delete indices.
Deletes one or more indices. + /// + /// Delete indices. + /// Deletes one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1525,7 +1864,10 @@ public virtual Task DeleteAsync(DeleteIndexReque } /// - /// Delete indices.
Deletes one or more indices. + /// + /// Delete indices. + /// Deletes one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -1536,7 +1878,10 @@ public virtual Task DeleteAsync(Elastic.Clients. } /// - /// Delete indices.
Deletes one or more indices. + /// + /// Delete indices. + /// Deletes one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1548,7 +1893,10 @@ public virtual Task DeleteAsync(Elastic.Clients. } /// - /// Delete indices.
Deletes one or more indices. + /// + /// Delete indices. + /// Deletes one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(CancellationToken cancellationToken = default) @@ -1559,7 +1907,10 @@ public virtual Task DeleteAsync(CancellationToke } /// - /// Delete indices.
Deletes one or more indices. + /// + /// Delete indices. + /// Deletes one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -1571,7 +1922,10 @@ public virtual Task DeleteAsync(Action - /// Delete indices.
Deletes one or more indices. + /// + /// Delete indices. + /// Deletes one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1581,7 +1935,10 @@ public virtual Task DeleteAsync(DeleteIndexRequestDescripto } /// - /// Delete indices.
Deletes one or more indices. + /// + /// Delete indices. + /// Deletes one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -1592,7 +1949,10 @@ public virtual Task DeleteAsync(Elastic.Clients.Elasticsear } /// - /// Delete indices.
Deletes one or more indices. + /// + /// Delete indices. + /// Deletes one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -1604,7 +1964,10 @@ public virtual Task DeleteAsync(Elastic.Clients.Elasticsear } /// - /// Delete an alias.
Removes a data stream or index from an alias. + /// + /// Delete an alias. + /// Removes a data stream or index from an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1615,7 +1978,10 @@ public virtual DeleteAliasResponse DeleteAlias(DeleteAliasRequest request) } /// - /// Delete an alias.
Removes a data stream or index from an alias. + /// + /// Delete an alias. + /// Removes a data stream or index from an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAliasAsync(DeleteAliasRequest request, CancellationToken cancellationToken = default) @@ -1625,7 +1991,10 @@ public virtual Task DeleteAliasAsync(DeleteAliasRequest req } /// - /// Delete an alias.
Removes a data stream or index from an alias. + /// + /// Delete an alias. + /// Removes a data stream or index from an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1636,7 +2005,10 @@ public virtual DeleteAliasResponse DeleteAlias(DeleteAliasRequestDesc } /// - /// Delete an alias.
Removes a data stream or index from an alias. + /// + /// Delete an alias. + /// Removes a data stream or index from an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1648,7 +2020,10 @@ public virtual DeleteAliasResponse DeleteAlias(Elastic.Clients.Elasti } /// - /// Delete an alias.
Removes a data stream or index from an alias. + /// + /// Delete an alias. + /// Removes a data stream or index from an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1661,7 +2036,10 @@ public virtual DeleteAliasResponse DeleteAlias(Elastic.Clients.Elasti } /// - /// Delete an alias.
Removes a data stream or index from an alias. + /// + /// Delete an alias. + /// Removes a data stream or index from an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1673,7 +2051,10 @@ public virtual DeleteAliasResponse DeleteAlias(Elastic.Clients.Elasti } /// - /// Delete an alias.
Removes a data stream or index from an alias. + /// + /// Delete an alias. + /// Removes a data stream or index from an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1686,7 +2067,10 @@ public virtual DeleteAliasResponse DeleteAlias(Elastic.Clients.Elasti } /// - /// Delete an alias.
Removes a data stream or index from an alias. + /// + /// Delete an alias. + /// Removes a data stream or index from an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1697,7 +2081,10 @@ public virtual DeleteAliasResponse DeleteAlias(DeleteAliasRequestDescriptor desc } /// - /// Delete an alias.
Removes a data stream or index from an alias. + /// + /// Delete an alias. + /// Removes a data stream or index from an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1709,7 +2096,10 @@ public virtual DeleteAliasResponse DeleteAlias(Elastic.Clients.Elasticsearch.Ind } /// - /// Delete an alias.
Removes a data stream or index from an alias. + /// + /// Delete an alias. + /// Removes a data stream or index from an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1722,7 +2112,10 @@ public virtual DeleteAliasResponse DeleteAlias(Elastic.Clients.Elasticsearch.Ind } /// - /// Delete an alias.
Removes a data stream or index from an alias. + /// + /// Delete an alias. + /// Removes a data stream or index from an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAliasAsync(DeleteAliasRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1732,7 +2125,10 @@ public virtual Task DeleteAliasAsync(DeleteAlias } /// - /// Delete an alias.
Removes a data stream or index from an alias. + /// + /// Delete an alias. + /// Removes a data stream or index from an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAliasAsync(Elastic.Clients.Elasticsearch.Indices indices, Elastic.Clients.Elasticsearch.Names name, CancellationToken cancellationToken = default) @@ -1743,7 +2139,10 @@ public virtual Task DeleteAliasAsync(Elastic.Cli } /// - /// Delete an alias.
Removes a data stream or index from an alias. + /// + /// Delete an alias. + /// Removes a data stream or index from an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAliasAsync(Elastic.Clients.Elasticsearch.Indices indices, Elastic.Clients.Elasticsearch.Names name, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1755,7 +2154,10 @@ public virtual Task DeleteAliasAsync(Elastic.Cli } /// - /// Delete an alias.
Removes a data stream or index from an alias. + /// + /// Delete an alias. + /// Removes a data stream or index from an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAliasAsync(Elastic.Clients.Elasticsearch.Names name, CancellationToken cancellationToken = default) @@ -1766,7 +2168,10 @@ public virtual Task DeleteAliasAsync(Elastic.Cli } /// - /// Delete an alias.
Removes a data stream or index from an alias. + /// + /// Delete an alias. + /// Removes a data stream or index from an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAliasAsync(Elastic.Clients.Elasticsearch.Names name, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1778,7 +2183,10 @@ public virtual Task DeleteAliasAsync(Elastic.Cli } /// - /// Delete an alias.
Removes a data stream or index from an alias. + /// + /// Delete an alias. + /// Removes a data stream or index from an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAliasAsync(DeleteAliasRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1788,7 +2196,10 @@ public virtual Task DeleteAliasAsync(DeleteAliasRequestDesc } /// - /// Delete an alias.
Removes a data stream or index from an alias. + /// + /// Delete an alias. + /// Removes a data stream or index from an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAliasAsync(Elastic.Clients.Elasticsearch.Indices indices, Elastic.Clients.Elasticsearch.Names name, CancellationToken cancellationToken = default) @@ -1799,7 +2210,10 @@ public virtual Task DeleteAliasAsync(Elastic.Clients.Elasti } /// - /// Delete an alias.
Removes a data stream or index from an alias. + /// + /// Delete an alias. + /// Removes a data stream or index from an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAliasAsync(Elastic.Clients.Elasticsearch.Indices indices, Elastic.Clients.Elasticsearch.Names name, Action configureRequest, CancellationToken cancellationToken = default) @@ -1811,7 +2225,10 @@ public virtual Task DeleteAliasAsync(Elastic.Clients.Elasti } /// - /// Delete data stream lifecycles.
Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. + /// + /// Delete data stream lifecycles. + /// Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1822,7 +2239,10 @@ public virtual DeleteDataLifecycleResponse DeleteDataLifecycle(DeleteDataLifecyc } /// - /// Delete data stream lifecycles.
Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. + /// + /// Delete data stream lifecycles. + /// Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataLifecycleAsync(DeleteDataLifecycleRequest request, CancellationToken cancellationToken = default) @@ -1832,7 +2252,10 @@ public virtual Task DeleteDataLifecycleAsync(Delete } /// - /// Delete data stream lifecycles.
Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. + /// + /// Delete data stream lifecycles. + /// Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1843,7 +2266,10 @@ public virtual DeleteDataLifecycleResponse DeleteDataLifecycle(DeleteDataLifecyc } /// - /// Delete data stream lifecycles.
Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. + /// + /// Delete data stream lifecycles. + /// Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1855,7 +2281,10 @@ public virtual DeleteDataLifecycleResponse DeleteDataLifecycle(Elastic.Clients.E } /// - /// Delete data stream lifecycles.
Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. + /// + /// Delete data stream lifecycles. + /// Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1868,7 +2297,10 @@ public virtual DeleteDataLifecycleResponse DeleteDataLifecycle(Elastic.Clients.E } /// - /// Delete data stream lifecycles.
Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. + /// + /// Delete data stream lifecycles. + /// Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataLifecycleAsync(DeleteDataLifecycleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1878,7 +2310,10 @@ public virtual Task DeleteDataLifecycleAsync(Delete } /// - /// Delete data stream lifecycles.
Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. + /// + /// Delete data stream lifecycles. + /// Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataLifecycleAsync(Elastic.Clients.Elasticsearch.DataStreamNames name, CancellationToken cancellationToken = default) @@ -1889,7 +2324,10 @@ public virtual Task DeleteDataLifecycleAsync(Elasti } /// - /// Delete data stream lifecycles.
Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. + /// + /// Delete data stream lifecycles. + /// Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataLifecycleAsync(Elastic.Clients.Elasticsearch.DataStreamNames name, Action configureRequest, CancellationToken cancellationToken = default) @@ -1901,7 +2339,10 @@ public virtual Task DeleteDataLifecycleAsync(Elasti } /// - /// Delete data streams.
Deletes one or more data streams and their backing indices. + /// + /// Delete data streams. + /// Deletes one or more data streams and their backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1912,7 +2353,10 @@ public virtual DeleteDataStreamResponse DeleteDataStream(DeleteDataStreamRequest } /// - /// Delete data streams.
Deletes one or more data streams and their backing indices. + /// + /// Delete data streams. + /// Deletes one or more data streams and their backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataStreamAsync(DeleteDataStreamRequest request, CancellationToken cancellationToken = default) @@ -1922,7 +2366,10 @@ public virtual Task DeleteDataStreamAsync(DeleteDataSt } /// - /// Delete data streams.
Deletes one or more data streams and their backing indices. + /// + /// Delete data streams. + /// Deletes one or more data streams and their backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1933,7 +2380,10 @@ public virtual DeleteDataStreamResponse DeleteDataStream(DeleteDataStreamRequest } /// - /// Delete data streams.
Deletes one or more data streams and their backing indices. + /// + /// Delete data streams. + /// Deletes one or more data streams and their backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1945,7 +2395,10 @@ public virtual DeleteDataStreamResponse DeleteDataStream(Elastic.Clients.Elastic } /// - /// Delete data streams.
Deletes one or more data streams and their backing indices. + /// + /// Delete data streams. + /// Deletes one or more data streams and their backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1958,7 +2411,10 @@ public virtual DeleteDataStreamResponse DeleteDataStream(Elastic.Clients.Elastic } /// - /// Delete data streams.
Deletes one or more data streams and their backing indices. + /// + /// Delete data streams. + /// Deletes one or more data streams and their backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataStreamAsync(DeleteDataStreamRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1968,7 +2424,10 @@ public virtual Task DeleteDataStreamAsync(DeleteDataSt } /// - /// Delete data streams.
Deletes one or more data streams and their backing indices. + /// + /// Delete data streams. + /// Deletes one or more data streams and their backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataStreamAsync(Elastic.Clients.Elasticsearch.DataStreamNames name, CancellationToken cancellationToken = default) @@ -1979,7 +2438,10 @@ public virtual Task DeleteDataStreamAsync(Elastic.Clie } /// - /// Delete data streams.
Deletes one or more data streams and their backing indices. + /// + /// Delete data streams. + /// Deletes one or more data streams and their backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataStreamAsync(Elastic.Clients.Elasticsearch.DataStreamNames name, Action configureRequest, CancellationToken cancellationToken = default) @@ -1991,7 +2453,12 @@ public virtual Task DeleteDataStreamAsync(Elastic.Clie } /// - /// Delete an index template.
The provided may contain multiple template names separated by a comma. If multiple template
names are specified then there is no wildcard support and the provided names should match completely with
existing templates. + /// + /// Delete an index template. + /// The provided <index-template> may contain multiple template names separated by a comma. If multiple template + /// names are specified then there is no wildcard support and the provided names should match completely with + /// existing templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2002,7 +2469,12 @@ public virtual DeleteIndexTemplateResponse DeleteIndexTemplate(DeleteIndexTempla } /// - /// Delete an index template.
The provided may contain multiple template names separated by a comma. If multiple template
names are specified then there is no wildcard support and the provided names should match completely with
existing templates. + /// + /// Delete an index template. + /// The provided <index-template> may contain multiple template names separated by a comma. If multiple template + /// names are specified then there is no wildcard support and the provided names should match completely with + /// existing templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteIndexTemplateAsync(DeleteIndexTemplateRequest request, CancellationToken cancellationToken = default) @@ -2012,7 +2484,12 @@ public virtual Task DeleteIndexTemplateAsync(Delete } /// - /// Delete an index template.
The provided may contain multiple template names separated by a comma. If multiple template
names are specified then there is no wildcard support and the provided names should match completely with
existing templates. + /// + /// Delete an index template. + /// The provided <index-template> may contain multiple template names separated by a comma. If multiple template + /// names are specified then there is no wildcard support and the provided names should match completely with + /// existing templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2023,7 +2500,12 @@ public virtual DeleteIndexTemplateResponse DeleteIndexTemplate(DeleteIndexTempla } /// - /// Delete an index template.
The provided may contain multiple template names separated by a comma. If multiple template
names are specified then there is no wildcard support and the provided names should match completely with
existing templates. + /// + /// Delete an index template. + /// The provided <index-template> may contain multiple template names separated by a comma. If multiple template + /// names are specified then there is no wildcard support and the provided names should match completely with + /// existing templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2035,7 +2517,12 @@ public virtual DeleteIndexTemplateResponse DeleteIndexTemplate(Elastic.Clients.E } /// - /// Delete an index template.
The provided may contain multiple template names separated by a comma. If multiple template
names are specified then there is no wildcard support and the provided names should match completely with
existing templates. + /// + /// Delete an index template. + /// The provided <index-template> may contain multiple template names separated by a comma. If multiple template + /// names are specified then there is no wildcard support and the provided names should match completely with + /// existing templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2048,7 +2535,12 @@ public virtual DeleteIndexTemplateResponse DeleteIndexTemplate(Elastic.Clients.E } /// - /// Delete an index template.
The provided may contain multiple template names separated by a comma. If multiple template
names are specified then there is no wildcard support and the provided names should match completely with
existing templates. + /// + /// Delete an index template. + /// The provided <index-template> may contain multiple template names separated by a comma. If multiple template + /// names are specified then there is no wildcard support and the provided names should match completely with + /// existing templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteIndexTemplateAsync(DeleteIndexTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2058,7 +2550,12 @@ public virtual Task DeleteIndexTemplateAsync(Delete } /// - /// Delete an index template.
The provided may contain multiple template names separated by a comma. If multiple template
names are specified then there is no wildcard support and the provided names should match completely with
existing templates. + /// + /// Delete an index template. + /// The provided <index-template> may contain multiple template names separated by a comma. If multiple template + /// names are specified then there is no wildcard support and the provided names should match completely with + /// existing templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteIndexTemplateAsync(Elastic.Clients.Elasticsearch.Names name, CancellationToken cancellationToken = default) @@ -2069,7 +2566,12 @@ public virtual Task DeleteIndexTemplateAsync(Elasti } /// - /// Delete an index template.
The provided may contain multiple template names separated by a comma. If multiple template
names are specified then there is no wildcard support and the provided names should match completely with
existing templates. + /// + /// Delete an index template. + /// The provided <index-template> may contain multiple template names separated by a comma. If multiple template + /// names are specified then there is no wildcard support and the provided names should match completely with + /// existing templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteIndexTemplateAsync(Elastic.Clients.Elasticsearch.Names name, Action configureRequest, CancellationToken cancellationToken = default) @@ -2081,7 +2583,9 @@ public virtual Task DeleteIndexTemplateAsync(Elasti } /// - /// Deletes a legacy index template. + /// + /// Deletes a legacy index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2092,7 +2596,9 @@ public virtual DeleteTemplateResponse DeleteTemplate(DeleteTemplateRequest reque } /// - /// Deletes a legacy index template. + /// + /// Deletes a legacy index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteTemplateAsync(DeleteTemplateRequest request, CancellationToken cancellationToken = default) @@ -2102,7 +2608,9 @@ public virtual Task DeleteTemplateAsync(DeleteTemplateRe } /// - /// Deletes a legacy index template. + /// + /// Deletes a legacy index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2113,7 +2621,9 @@ public virtual DeleteTemplateResponse DeleteTemplate(DeleteTemplateRequestDescri } /// - /// Deletes a legacy index template. + /// + /// Deletes a legacy index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2125,7 +2635,9 @@ public virtual DeleteTemplateResponse DeleteTemplate(Elastic.Clients.Elasticsear } /// - /// Deletes a legacy index template. + /// + /// Deletes a legacy index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2138,7 +2650,9 @@ public virtual DeleteTemplateResponse DeleteTemplate(Elastic.Clients.Elasticsear } /// - /// Deletes a legacy index template. + /// + /// Deletes a legacy index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteTemplateAsync(DeleteTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2148,7 +2662,9 @@ public virtual Task DeleteTemplateAsync(DeleteTemplateRe } /// - /// Deletes a legacy index template. + /// + /// Deletes a legacy index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteTemplateAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) @@ -2159,7 +2675,9 @@ public virtual Task DeleteTemplateAsync(Elastic.Clients. } /// - /// Deletes a legacy index template. + /// + /// Deletes a legacy index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteTemplateAsync(Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -2171,7 +2689,9 @@ public virtual Task DeleteTemplateAsync(Elastic.Clients. } /// - /// Analyzes the disk usage of each field of an index or data stream. + /// + /// Analyzes the disk usage of each field of an index or data stream. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2182,7 +2702,9 @@ public virtual DiskUsageResponse DiskUsage(DiskUsageRequest request) } /// - /// Analyzes the disk usage of each field of an index or data stream. + /// + /// Analyzes the disk usage of each field of an index or data stream. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DiskUsageAsync(DiskUsageRequest request, CancellationToken cancellationToken = default) @@ -2192,7 +2714,9 @@ public virtual Task DiskUsageAsync(DiskUsageRequest request, } /// - /// Analyzes the disk usage of each field of an index or data stream. + /// + /// Analyzes the disk usage of each field of an index or data stream. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2203,7 +2727,9 @@ public virtual DiskUsageResponse DiskUsage(DiskUsageRequestDescriptor } /// - /// Analyzes the disk usage of each field of an index or data stream. + /// + /// Analyzes the disk usage of each field of an index or data stream. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2215,7 +2741,9 @@ public virtual DiskUsageResponse DiskUsage(Elastic.Clients.Elasticsea } /// - /// Analyzes the disk usage of each field of an index or data stream. + /// + /// Analyzes the disk usage of each field of an index or data stream. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2228,7 +2756,9 @@ public virtual DiskUsageResponse DiskUsage(Elastic.Clients.Elasticsea } /// - /// Analyzes the disk usage of each field of an index or data stream. + /// + /// Analyzes the disk usage of each field of an index or data stream. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2240,7 +2770,9 @@ public virtual DiskUsageResponse DiskUsage() } /// - /// Analyzes the disk usage of each field of an index or data stream. + /// + /// Analyzes the disk usage of each field of an index or data stream. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2253,7 +2785,9 @@ public virtual DiskUsageResponse DiskUsage(Action - /// Analyzes the disk usage of each field of an index or data stream. + /// + /// Analyzes the disk usage of each field of an index or data stream. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2264,7 +2798,9 @@ public virtual DiskUsageResponse DiskUsage(DiskUsageRequestDescriptor descriptor } /// - /// Analyzes the disk usage of each field of an index or data stream. + /// + /// Analyzes the disk usage of each field of an index or data stream. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2276,7 +2812,9 @@ public virtual DiskUsageResponse DiskUsage(Elastic.Clients.Elasticsearch.Indices } /// - /// Analyzes the disk usage of each field of an index or data stream. + /// + /// Analyzes the disk usage of each field of an index or data stream. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2289,7 +2827,9 @@ public virtual DiskUsageResponse DiskUsage(Elastic.Clients.Elasticsearch.Indices } /// - /// Analyzes the disk usage of each field of an index or data stream. + /// + /// Analyzes the disk usage of each field of an index or data stream. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DiskUsageAsync(DiskUsageRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2299,7 +2839,9 @@ public virtual Task DiskUsageAsync(DiskUsageReques } /// - /// Analyzes the disk usage of each field of an index or data stream. + /// + /// Analyzes the disk usage of each field of an index or data stream. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DiskUsageAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -2310,7 +2852,9 @@ public virtual Task DiskUsageAsync(Elastic.Clients } /// - /// Analyzes the disk usage of each field of an index or data stream. + /// + /// Analyzes the disk usage of each field of an index or data stream. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DiskUsageAsync(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2322,7 +2866,9 @@ public virtual Task DiskUsageAsync(Elastic.Clients } /// - /// Analyzes the disk usage of each field of an index or data stream. + /// + /// Analyzes the disk usage of each field of an index or data stream. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DiskUsageAsync(CancellationToken cancellationToken = default) @@ -2333,7 +2879,9 @@ public virtual Task DiskUsageAsync(CancellationTok } /// - /// Analyzes the disk usage of each field of an index or data stream. + /// + /// Analyzes the disk usage of each field of an index or data stream. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DiskUsageAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -2345,7 +2893,9 @@ public virtual Task DiskUsageAsync(Action - /// Analyzes the disk usage of each field of an index or data stream. + /// + /// Analyzes the disk usage of each field of an index or data stream. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DiskUsageAsync(DiskUsageRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2355,7 +2905,9 @@ public virtual Task DiskUsageAsync(DiskUsageRequestDescriptor } /// - /// Analyzes the disk usage of each field of an index or data stream. + /// + /// Analyzes the disk usage of each field of an index or data stream. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DiskUsageAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -2366,7 +2918,9 @@ public virtual Task DiskUsageAsync(Elastic.Clients.Elasticsea } /// - /// Analyzes the disk usage of each field of an index or data stream. + /// + /// Analyzes the disk usage of each field of an index or data stream. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DiskUsageAsync(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -2378,7 +2932,9 @@ public virtual Task DiskUsageAsync(Elastic.Clients.Elasticsea } /// - /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval. + /// + /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2389,7 +2945,9 @@ public virtual DownsampleResponse Downsample(DownsampleRequest request) } /// - /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval. + /// + /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DownsampleAsync(DownsampleRequest request, CancellationToken cancellationToken = default) @@ -2399,7 +2957,9 @@ public virtual Task DownsampleAsync(DownsampleRequest reques } /// - /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval. + /// + /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2410,7 +2970,9 @@ public virtual DownsampleResponse Downsample(DownsampleRequestDescrip } /// - /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval. + /// + /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2422,7 +2984,9 @@ public virtual DownsampleResponse Downsample(Elastic.Clients.Elastics } /// - /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval. + /// + /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2435,7 +2999,9 @@ public virtual DownsampleResponse Downsample(Elastic.Clients.Elastics } /// - /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval. + /// + /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2446,7 +3012,9 @@ public virtual DownsampleResponse Downsample(DownsampleRequestDescriptor descrip } /// - /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval. + /// + /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2458,7 +3026,9 @@ public virtual DownsampleResponse Downsample(Elastic.Clients.Elasticsearch.Index } /// - /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval. + /// + /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2471,7 +3041,9 @@ public virtual DownsampleResponse Downsample(Elastic.Clients.Elasticsearch.Index } /// - /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval. + /// + /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DownsampleAsync(DownsampleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2481,7 +3053,9 @@ public virtual Task DownsampleAsync(DownsampleReq } /// - /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval. + /// + /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DownsampleAsync(Elastic.Clients.Elasticsearch.IndexManagement.DownsampleConfig config, Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName targetIndex, CancellationToken cancellationToken = default) @@ -2492,7 +3066,9 @@ public virtual Task DownsampleAsync(Elastic.Clien } /// - /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval. + /// + /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DownsampleAsync(Elastic.Clients.Elasticsearch.IndexManagement.DownsampleConfig config, Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName targetIndex, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2504,7 +3080,9 @@ public virtual Task DownsampleAsync(Elastic.Clien } /// - /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval. + /// + /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DownsampleAsync(DownsampleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2514,7 +3092,9 @@ public virtual Task DownsampleAsync(DownsampleRequestDescrip } /// - /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval. + /// + /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DownsampleAsync(Elastic.Clients.Elasticsearch.IndexManagement.DownsampleConfig config, Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName targetIndex, CancellationToken cancellationToken = default) @@ -2525,7 +3105,9 @@ public virtual Task DownsampleAsync(Elastic.Clients.Elastics } /// - /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval. + /// + /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DownsampleAsync(Elastic.Clients.Elasticsearch.IndexManagement.DownsampleConfig config, Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName targetIndex, Action configureRequest, CancellationToken cancellationToken = default) @@ -2537,7 +3119,10 @@ public virtual Task DownsampleAsync(Elastic.Clients.Elastics } /// - /// Check indices.
Checks if one or more indices, index aliases, or data streams exist. + /// + /// Check indices. + /// Checks if one or more indices, index aliases, or data streams exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2548,7 +3133,10 @@ public virtual ExistsResponse Exists(ExistsRequest request) } /// - /// Check indices.
Checks if one or more indices, index aliases, or data streams exist. + /// + /// Check indices. + /// Checks if one or more indices, index aliases, or data streams exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(ExistsRequest request, CancellationToken cancellationToken = default) @@ -2558,7 +3146,10 @@ public virtual Task ExistsAsync(ExistsRequest request, Cancellat } /// - /// Check indices.
Checks if one or more indices, index aliases, or data streams exist. + /// + /// Check indices. + /// Checks if one or more indices, index aliases, or data streams exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2569,7 +3160,10 @@ public virtual ExistsResponse Exists(ExistsRequestDescriptor - /// Check indices.
Checks if one or more indices, index aliases, or data streams exist. + /// + /// Check indices. + /// Checks if one or more indices, index aliases, or data streams exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2581,7 +3175,10 @@ public virtual ExistsResponse Exists(Elastic.Clients.Elasticsearch.In } /// - /// Check indices.
Checks if one or more indices, index aliases, or data streams exist. + /// + /// Check indices. + /// Checks if one or more indices, index aliases, or data streams exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2594,7 +3191,10 @@ public virtual ExistsResponse Exists(Elastic.Clients.Elasticsearch.In } /// - /// Check indices.
Checks if one or more indices, index aliases, or data streams exist. + /// + /// Check indices. + /// Checks if one or more indices, index aliases, or data streams exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2606,7 +3206,10 @@ public virtual ExistsResponse Exists() } /// - /// Check indices.
Checks if one or more indices, index aliases, or data streams exist. + /// + /// Check indices. + /// Checks if one or more indices, index aliases, or data streams exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2619,7 +3222,10 @@ public virtual ExistsResponse Exists(Action - /// Check indices.
Checks if one or more indices, index aliases, or data streams exist. + /// + /// Check indices. + /// Checks if one or more indices, index aliases, or data streams exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2630,7 +3236,10 @@ public virtual ExistsResponse Exists(ExistsRequestDescriptor descriptor) } /// - /// Check indices.
Checks if one or more indices, index aliases, or data streams exist. + /// + /// Check indices. + /// Checks if one or more indices, index aliases, or data streams exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2642,7 +3251,10 @@ public virtual ExistsResponse Exists(Elastic.Clients.Elasticsearch.Indices indic } /// - /// Check indices.
Checks if one or more indices, index aliases, or data streams exist. + /// + /// Check indices. + /// Checks if one or more indices, index aliases, or data streams exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2655,7 +3267,10 @@ public virtual ExistsResponse Exists(Elastic.Clients.Elasticsearch.Indices indic } /// - /// Check indices.
Checks if one or more indices, index aliases, or data streams exist. + /// + /// Check indices. + /// Checks if one or more indices, index aliases, or data streams exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(ExistsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2665,7 +3280,10 @@ public virtual Task ExistsAsync(ExistsRequestDescript } /// - /// Check indices.
Checks if one or more indices, index aliases, or data streams exist. + /// + /// Check indices. + /// Checks if one or more indices, index aliases, or data streams exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -2676,7 +3294,10 @@ public virtual Task ExistsAsync(Elastic.Clients.Elast } /// - /// Check indices.
Checks if one or more indices, index aliases, or data streams exist. + /// + /// Check indices. + /// Checks if one or more indices, index aliases, or data streams exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2688,7 +3309,10 @@ public virtual Task ExistsAsync(Elastic.Clients.Elast } /// - /// Check indices.
Checks if one or more indices, index aliases, or data streams exist. + /// + /// Check indices. + /// Checks if one or more indices, index aliases, or data streams exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(CancellationToken cancellationToken = default) @@ -2699,7 +3323,10 @@ public virtual Task ExistsAsync(CancellationToken can } /// - /// Check indices.
Checks if one or more indices, index aliases, or data streams exist. + /// + /// Check indices. + /// Checks if one or more indices, index aliases, or data streams exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -2711,7 +3338,10 @@ public virtual Task ExistsAsync(Action - /// Check indices.
Checks if one or more indices, index aliases, or data streams exist. + /// + /// Check indices. + /// Checks if one or more indices, index aliases, or data streams exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(ExistsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2721,7 +3351,10 @@ public virtual Task ExistsAsync(ExistsRequestDescriptor descript } /// - /// Check indices.
Checks if one or more indices, index aliases, or data streams exist. + /// + /// Check indices. + /// Checks if one or more indices, index aliases, or data streams exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -2732,7 +3365,10 @@ public virtual Task ExistsAsync(Elastic.Clients.Elasticsearch.In } /// - /// Check indices.
Checks if one or more indices, index aliases, or data streams exist. + /// + /// Check indices. + /// Checks if one or more indices, index aliases, or data streams exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -2744,7 +3380,10 @@ public virtual Task ExistsAsync(Elastic.Clients.Elasticsearch.In } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2755,7 +3394,10 @@ public virtual ExistsAliasResponse ExistsAlias(ExistsAliasRequest request) } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAliasAsync(ExistsAliasRequest request, CancellationToken cancellationToken = default) @@ -2765,7 +3407,10 @@ public virtual Task ExistsAliasAsync(ExistsAliasRequest req } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2776,7 +3421,10 @@ public virtual ExistsAliasResponse ExistsAlias(ExistsAliasRequestDesc } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2788,7 +3436,10 @@ public virtual ExistsAliasResponse ExistsAlias(Elastic.Clients.Elasti } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2801,7 +3452,10 @@ public virtual ExistsAliasResponse ExistsAlias(Elastic.Clients.Elasti } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2813,7 +3467,10 @@ public virtual ExistsAliasResponse ExistsAlias(Elastic.Clients.Elasti } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2826,7 +3483,10 @@ public virtual ExistsAliasResponse ExistsAlias(Elastic.Clients.Elasti } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2837,7 +3497,10 @@ public virtual ExistsAliasResponse ExistsAlias(ExistsAliasRequestDescriptor desc } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2849,7 +3512,10 @@ public virtual ExistsAliasResponse ExistsAlias(Elastic.Clients.Elasticsearch.Ind } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2862,7 +3528,10 @@ public virtual ExistsAliasResponse ExistsAlias(Elastic.Clients.Elasticsearch.Ind } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2874,7 +3543,10 @@ public virtual ExistsAliasResponse ExistsAlias(Elastic.Clients.Elasticsearch.Nam } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2887,7 +3559,10 @@ public virtual ExistsAliasResponse ExistsAlias(Elastic.Clients.Elasticsearch.Nam } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAliasAsync(ExistsAliasRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2897,7 +3572,10 @@ public virtual Task ExistsAliasAsync(ExistsAlias } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAliasAsync(Elastic.Clients.Elasticsearch.Indices? indices, Elastic.Clients.Elasticsearch.Names name, CancellationToken cancellationToken = default) @@ -2908,7 +3586,10 @@ public virtual Task ExistsAliasAsync(Elastic.Cli } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAliasAsync(Elastic.Clients.Elasticsearch.Indices? indices, Elastic.Clients.Elasticsearch.Names name, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2920,7 +3601,10 @@ public virtual Task ExistsAliasAsync(Elastic.Cli } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAliasAsync(Elastic.Clients.Elasticsearch.Names name, CancellationToken cancellationToken = default) @@ -2931,7 +3615,10 @@ public virtual Task ExistsAliasAsync(Elastic.Cli } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAliasAsync(Elastic.Clients.Elasticsearch.Names name, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2943,7 +3630,10 @@ public virtual Task ExistsAliasAsync(Elastic.Cli } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAliasAsync(ExistsAliasRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2953,7 +3643,10 @@ public virtual Task ExistsAliasAsync(ExistsAliasRequestDesc } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAliasAsync(Elastic.Clients.Elasticsearch.Indices? indices, Elastic.Clients.Elasticsearch.Names name, CancellationToken cancellationToken = default) @@ -2964,7 +3657,10 @@ public virtual Task ExistsAliasAsync(Elastic.Clients.Elasti } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAliasAsync(Elastic.Clients.Elasticsearch.Indices? indices, Elastic.Clients.Elasticsearch.Names name, Action configureRequest, CancellationToken cancellationToken = default) @@ -2976,7 +3672,10 @@ public virtual Task ExistsAliasAsync(Elastic.Clients.Elasti } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAliasAsync(Elastic.Clients.Elasticsearch.Names name, CancellationToken cancellationToken = default) @@ -2987,7 +3686,10 @@ public virtual Task ExistsAliasAsync(Elastic.Clients.Elasti } /// - /// Check aliases.
Checks if one or more data stream or index aliases exist. + /// + /// Check aliases. + /// Checks if one or more data stream or index aliases exist. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAliasAsync(Elastic.Clients.Elasticsearch.Names name, Action configureRequest, CancellationToken cancellationToken = default) @@ -2999,7 +3701,9 @@ public virtual Task ExistsAliasAsync(Elastic.Clients.Elasti } /// - /// Returns information about whether a particular index template exists. + /// + /// Returns information about whether a particular index template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3010,7 +3714,9 @@ public virtual ExistsIndexTemplateResponse ExistsIndexTemplate(ExistsIndexTempla } /// - /// Returns information about whether a particular index template exists. + /// + /// Returns information about whether a particular index template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsIndexTemplateAsync(ExistsIndexTemplateRequest request, CancellationToken cancellationToken = default) @@ -3020,7 +3726,9 @@ public virtual Task ExistsIndexTemplateAsync(Exists } /// - /// Returns information about whether a particular index template exists. + /// + /// Returns information about whether a particular index template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3031,7 +3739,9 @@ public virtual ExistsIndexTemplateResponse ExistsIndexTemplate(ExistsIndexTempla } /// - /// Returns information about whether a particular index template exists. + /// + /// Returns information about whether a particular index template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3043,7 +3753,9 @@ public virtual ExistsIndexTemplateResponse ExistsIndexTemplate(Elastic.Clients.E } /// - /// Returns information about whether a particular index template exists. + /// + /// Returns information about whether a particular index template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3056,7 +3768,9 @@ public virtual ExistsIndexTemplateResponse ExistsIndexTemplate(Elastic.Clients.E } /// - /// Returns information about whether a particular index template exists. + /// + /// Returns information about whether a particular index template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsIndexTemplateAsync(ExistsIndexTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3066,7 +3780,9 @@ public virtual Task ExistsIndexTemplateAsync(Exists } /// - /// Returns information about whether a particular index template exists. + /// + /// Returns information about whether a particular index template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsIndexTemplateAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) @@ -3077,7 +3793,9 @@ public virtual Task ExistsIndexTemplateAsync(Elasti } /// - /// Returns information about whether a particular index template exists. + /// + /// Returns information about whether a particular index template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsIndexTemplateAsync(Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -3089,7 +3807,10 @@ public virtual Task ExistsIndexTemplateAsync(Elasti } /// - /// Check existence of index templates.
Returns information about whether a particular index template exists. + /// + /// Check existence of index templates. + /// Returns information about whether a particular index template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3100,7 +3821,10 @@ public virtual ExistsTemplateResponse ExistsTemplate(ExistsTemplateRequest reque } /// - /// Check existence of index templates.
Returns information about whether a particular index template exists. + /// + /// Check existence of index templates. + /// Returns information about whether a particular index template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsTemplateAsync(ExistsTemplateRequest request, CancellationToken cancellationToken = default) @@ -3110,7 +3834,10 @@ public virtual Task ExistsTemplateAsync(ExistsTemplateRe } /// - /// Check existence of index templates.
Returns information about whether a particular index template exists. + /// + /// Check existence of index templates. + /// Returns information about whether a particular index template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3121,7 +3848,10 @@ public virtual ExistsTemplateResponse ExistsTemplate(ExistsTemplateRequestDescri } /// - /// Check existence of index templates.
Returns information about whether a particular index template exists. + /// + /// Check existence of index templates. + /// Returns information about whether a particular index template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3133,7 +3863,10 @@ public virtual ExistsTemplateResponse ExistsTemplate(Elastic.Clients.Elasticsear } /// - /// Check existence of index templates.
Returns information about whether a particular index template exists. + /// + /// Check existence of index templates. + /// Returns information about whether a particular index template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3146,7 +3879,10 @@ public virtual ExistsTemplateResponse ExistsTemplate(Elastic.Clients.Elasticsear } /// - /// Check existence of index templates.
Returns information about whether a particular index template exists. + /// + /// Check existence of index templates. + /// Returns information about whether a particular index template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsTemplateAsync(ExistsTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3156,7 +3892,10 @@ public virtual Task ExistsTemplateAsync(ExistsTemplateRe } /// - /// Check existence of index templates.
Returns information about whether a particular index template exists. + /// + /// Check existence of index templates. + /// Returns information about whether a particular index template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsTemplateAsync(Elastic.Clients.Elasticsearch.Names name, CancellationToken cancellationToken = default) @@ -3167,7 +3906,10 @@ public virtual Task ExistsTemplateAsync(Elastic.Clients. } /// - /// Check existence of index templates.
Returns information about whether a particular index template exists. + /// + /// Check existence of index templates. + /// Returns information about whether a particular index template exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsTemplateAsync(Elastic.Clients.Elasticsearch.Names name, Action configureRequest, CancellationToken cancellationToken = default) @@ -3179,7 +3921,10 @@ public virtual Task ExistsTemplateAsync(Elastic.Clients. } /// - /// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// + /// Get the status for a data stream lifecycle. + /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3190,7 +3935,10 @@ public virtual ExplainDataLifecycleResponse ExplainDataLifecycle(ExplainDataLife } /// - /// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// + /// Get the status for a data stream lifecycle. + /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataLifecycleAsync(ExplainDataLifecycleRequest request, CancellationToken cancellationToken = default) @@ -3200,7 +3948,10 @@ public virtual Task ExplainDataLifecycleAsync(Expl } /// - /// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// + /// Get the status for a data stream lifecycle. + /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3211,7 +3962,10 @@ public virtual ExplainDataLifecycleResponse ExplainDataLifecycle(Expl } /// - /// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// + /// Get the status for a data stream lifecycle. + /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3223,7 +3977,10 @@ public virtual ExplainDataLifecycleResponse ExplainDataLifecycle(Elas } /// - /// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// + /// Get the status for a data stream lifecycle. + /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3236,7 +3993,10 @@ public virtual ExplainDataLifecycleResponse ExplainDataLifecycle(Elas } /// - /// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// + /// Get the status for a data stream lifecycle. + /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3248,7 +4008,10 @@ public virtual ExplainDataLifecycleResponse ExplainDataLifecycle() } /// - /// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// + /// Get the status for a data stream lifecycle. + /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3261,7 +4024,10 @@ public virtual ExplainDataLifecycleResponse ExplainDataLifecycle(Acti } /// - /// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// + /// Get the status for a data stream lifecycle. + /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3272,7 +4038,10 @@ public virtual ExplainDataLifecycleResponse ExplainDataLifecycle(ExplainDataLife } /// - /// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// + /// Get the status for a data stream lifecycle. + /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3284,7 +4053,10 @@ public virtual ExplainDataLifecycleResponse ExplainDataLifecycle(Elastic.Clients } /// - /// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// + /// Get the status for a data stream lifecycle. + /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3297,7 +4069,10 @@ public virtual ExplainDataLifecycleResponse ExplainDataLifecycle(Elastic.Clients } /// - /// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// + /// Get the status for a data stream lifecycle. + /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataLifecycleAsync(ExplainDataLifecycleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3307,7 +4082,10 @@ public virtual Task ExplainDataLifecycleAsync - /// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// + /// Get the status for a data stream lifecycle. + /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataLifecycleAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -3318,7 +4096,10 @@ public virtual Task ExplainDataLifecycleAsync - /// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// + /// Get the status for a data stream lifecycle. + /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataLifecycleAsync(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3330,7 +4111,10 @@ public virtual Task ExplainDataLifecycleAsync - /// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// + /// Get the status for a data stream lifecycle. + /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataLifecycleAsync(CancellationToken cancellationToken = default) @@ -3341,7 +4125,10 @@ public virtual Task ExplainDataLifecycleAsync - /// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// + /// Get the status for a data stream lifecycle. + /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataLifecycleAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -3353,7 +4140,10 @@ public virtual Task ExplainDataLifecycleAsync - /// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// + /// Get the status for a data stream lifecycle. + /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataLifecycleAsync(ExplainDataLifecycleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3363,7 +4153,10 @@ public virtual Task ExplainDataLifecycleAsync(Expl } /// - /// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// + /// Get the status for a data stream lifecycle. + /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataLifecycleAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -3374,7 +4167,10 @@ public virtual Task ExplainDataLifecycleAsync(Elas } /// - /// Get the status for a data stream lifecycle.
Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// + /// Get the status for a data stream lifecycle. + /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataLifecycleAsync(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -3386,7 +4182,9 @@ public virtual Task ExplainDataLifecycleAsync(Elas } /// - /// Returns field usage information for each shard and field of an index. + /// + /// Returns field usage information for each shard and field of an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3397,7 +4195,9 @@ public virtual FieldUsageStatsResponse FieldUsageStats(FieldUsageStatsRequest re } /// - /// Returns field usage information for each shard and field of an index. + /// + /// Returns field usage information for each shard and field of an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldUsageStatsAsync(FieldUsageStatsRequest request, CancellationToken cancellationToken = default) @@ -3407,7 +4207,9 @@ public virtual Task FieldUsageStatsAsync(FieldUsageStat } /// - /// Returns field usage information for each shard and field of an index. + /// + /// Returns field usage information for each shard and field of an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3418,7 +4220,9 @@ public virtual FieldUsageStatsResponse FieldUsageStats(FieldUsageStat } /// - /// Returns field usage information for each shard and field of an index. + /// + /// Returns field usage information for each shard and field of an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3430,7 +4234,9 @@ public virtual FieldUsageStatsResponse FieldUsageStats(Elastic.Client } /// - /// Returns field usage information for each shard and field of an index. + /// + /// Returns field usage information for each shard and field of an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3443,7 +4249,9 @@ public virtual FieldUsageStatsResponse FieldUsageStats(Elastic.Client } /// - /// Returns field usage information for each shard and field of an index. + /// + /// Returns field usage information for each shard and field of an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3455,7 +4263,9 @@ public virtual FieldUsageStatsResponse FieldUsageStats() } /// - /// Returns field usage information for each shard and field of an index. + /// + /// Returns field usage information for each shard and field of an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3468,7 +4278,9 @@ public virtual FieldUsageStatsResponse FieldUsageStats(Action - /// Returns field usage information for each shard and field of an index. + /// + /// Returns field usage information for each shard and field of an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3479,7 +4291,9 @@ public virtual FieldUsageStatsResponse FieldUsageStats(FieldUsageStatsRequestDes } /// - /// Returns field usage information for each shard and field of an index. + /// + /// Returns field usage information for each shard and field of an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3491,7 +4305,9 @@ public virtual FieldUsageStatsResponse FieldUsageStats(Elastic.Clients.Elasticse } /// - /// Returns field usage information for each shard and field of an index. + /// + /// Returns field usage information for each shard and field of an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3504,7 +4320,9 @@ public virtual FieldUsageStatsResponse FieldUsageStats(Elastic.Clients.Elasticse } /// - /// Returns field usage information for each shard and field of an index. + /// + /// Returns field usage information for each shard and field of an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldUsageStatsAsync(FieldUsageStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3514,7 +4332,9 @@ public virtual Task FieldUsageStatsAsync(Fie } /// - /// Returns field usage information for each shard and field of an index. + /// + /// Returns field usage information for each shard and field of an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldUsageStatsAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -3525,7 +4345,9 @@ public virtual Task FieldUsageStatsAsync(Ela } /// - /// Returns field usage information for each shard and field of an index. + /// + /// Returns field usage information for each shard and field of an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldUsageStatsAsync(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3537,7 +4359,9 @@ public virtual Task FieldUsageStatsAsync(Ela } /// - /// Returns field usage information for each shard and field of an index. + /// + /// Returns field usage information for each shard and field of an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldUsageStatsAsync(CancellationToken cancellationToken = default) @@ -3548,7 +4372,9 @@ public virtual Task FieldUsageStatsAsync(Can } /// - /// Returns field usage information for each shard and field of an index. + /// + /// Returns field usage information for each shard and field of an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldUsageStatsAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -3560,7 +4386,9 @@ public virtual Task FieldUsageStatsAsync(Act } /// - /// Returns field usage information for each shard and field of an index. + /// + /// Returns field usage information for each shard and field of an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldUsageStatsAsync(FieldUsageStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3570,7 +4398,9 @@ public virtual Task FieldUsageStatsAsync(FieldUsageStat } /// - /// Returns field usage information for each shard and field of an index. + /// + /// Returns field usage information for each shard and field of an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldUsageStatsAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -3581,7 +4411,9 @@ public virtual Task FieldUsageStatsAsync(Elastic.Client } /// - /// Returns field usage information for each shard and field of an index. + /// + /// Returns field usage information for each shard and field of an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldUsageStatsAsync(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -3593,7 +4425,9 @@ public virtual Task FieldUsageStatsAsync(Elastic.Client } /// - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3604,7 +4438,9 @@ public virtual FlushResponse Flush(FlushRequest request) } /// - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(FlushRequest request, CancellationToken cancellationToken = default) @@ -3614,7 +4450,9 @@ public virtual Task FlushAsync(FlushRequest request, Cancellation } /// - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3625,7 +4463,9 @@ public virtual FlushResponse Flush(FlushRequestDescriptor } /// - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3637,7 +4477,9 @@ public virtual FlushResponse Flush(Elastic.Clients.Elasticsearch.Indi } /// - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3650,7 +4492,9 @@ public virtual FlushResponse Flush(Elastic.Clients.Elasticsearch.Indi } /// - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3662,7 +4506,9 @@ public virtual FlushResponse Flush() } /// - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3675,7 +4521,9 @@ public virtual FlushResponse Flush(Action - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3686,7 +4534,9 @@ public virtual FlushResponse Flush(FlushRequestDescriptor descriptor) } /// - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3698,7 +4548,9 @@ public virtual FlushResponse Flush(Elastic.Clients.Elasticsearch.Indices? indice } /// - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3711,7 +4563,9 @@ public virtual FlushResponse Flush(Elastic.Clients.Elasticsearch.Indices? indice } /// - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3723,7 +4577,9 @@ public virtual FlushResponse Flush() } /// - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3736,7 +4592,9 @@ public virtual FlushResponse Flush(Action configureReque } /// - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(FlushRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3746,7 +4604,9 @@ public virtual Task FlushAsync(FlushRequestDescriptor< } /// - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -3757,7 +4617,9 @@ public virtual Task FlushAsync(Elastic.Clients.Elastic } /// - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3769,7 +4631,9 @@ public virtual Task FlushAsync(Elastic.Clients.Elastic } /// - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(CancellationToken cancellationToken = default) @@ -3780,7 +4644,9 @@ public virtual Task FlushAsync(CancellationToken cance } /// - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -3792,7 +4658,9 @@ public virtual Task FlushAsync(Action - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(FlushRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3802,7 +4670,9 @@ public virtual Task FlushAsync(FlushRequestDescriptor descriptor, } /// - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -3813,7 +4683,9 @@ public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Indi } /// - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -3825,7 +4697,9 @@ public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Indi } /// - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(CancellationToken cancellationToken = default) @@ -3836,7 +4710,9 @@ public virtual Task FlushAsync(CancellationToken cancellationToke } /// - /// Flushes one or more data streams or indices. + /// + /// Flushes one or more data streams or indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -3848,7 +4724,9 @@ public virtual Task FlushAsync(Action con } /// - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3859,7 +4737,9 @@ public virtual ForcemergeResponse Forcemerge(ForcemergeRequest request) } /// - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForcemergeAsync(ForcemergeRequest request, CancellationToken cancellationToken = default) @@ -3869,7 +4749,9 @@ public virtual Task ForcemergeAsync(ForcemergeRequest reques } /// - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3880,7 +4762,9 @@ public virtual ForcemergeResponse Forcemerge(ForcemergeRequestDescrip } /// - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3892,7 +4776,9 @@ public virtual ForcemergeResponse Forcemerge(Elastic.Clients.Elastics } /// - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3905,7 +4791,9 @@ public virtual ForcemergeResponse Forcemerge(Elastic.Clients.Elastics } /// - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3917,7 +4805,9 @@ public virtual ForcemergeResponse Forcemerge() } /// - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3930,7 +4820,9 @@ public virtual ForcemergeResponse Forcemerge(Action - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3941,7 +4833,9 @@ public virtual ForcemergeResponse Forcemerge(ForcemergeRequestDescriptor descrip } /// - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3953,7 +4847,9 @@ public virtual ForcemergeResponse Forcemerge(Elastic.Clients.Elasticsearch.Indic } /// - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3966,7 +4862,9 @@ public virtual ForcemergeResponse Forcemerge(Elastic.Clients.Elasticsearch.Indic } /// - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3978,7 +4876,9 @@ public virtual ForcemergeResponse Forcemerge() } /// - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3991,7 +4891,9 @@ public virtual ForcemergeResponse Forcemerge(Action } /// - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForcemergeAsync(ForcemergeRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4001,7 +4903,9 @@ public virtual Task ForcemergeAsync(ForcemergeReq } /// - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForcemergeAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -4012,7 +4916,9 @@ public virtual Task ForcemergeAsync(Elastic.Clien } /// - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForcemergeAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -4024,7 +4930,9 @@ public virtual Task ForcemergeAsync(Elastic.Clien } /// - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForcemergeAsync(CancellationToken cancellationToken = default) @@ -4035,7 +4943,9 @@ public virtual Task ForcemergeAsync(CancellationT } /// - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForcemergeAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -4047,7 +4957,9 @@ public virtual Task ForcemergeAsync(Action - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForcemergeAsync(ForcemergeRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4057,7 +4969,9 @@ public virtual Task ForcemergeAsync(ForcemergeRequestDescrip } /// - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForcemergeAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -4068,7 +4982,9 @@ public virtual Task ForcemergeAsync(Elastic.Clients.Elastics } /// - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForcemergeAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -4080,7 +4996,9 @@ public virtual Task ForcemergeAsync(Elastic.Clients.Elastics } /// - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForcemergeAsync(CancellationToken cancellationToken = default) @@ -4091,7 +5009,9 @@ public virtual Task ForcemergeAsync(CancellationToken cancel } /// - /// Performs the force merge operation on one or more indices. + /// + /// Performs the force merge operation on one or more indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForcemergeAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -4103,7 +5023,11 @@ public virtual Task ForcemergeAsync(Action - /// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. + /// + /// Get index information. + /// Returns information about one or more indices. For data streams, the API returns information about the + /// stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4114,7 +5038,11 @@ public virtual GetIndexResponse Get(GetIndexRequest request) } /// - /// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. + /// + /// Get index information. + /// Returns information about one or more indices. For data streams, the API returns information about the + /// stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(GetIndexRequest request, CancellationToken cancellationToken = default) @@ -4124,7 +5052,11 @@ public virtual Task GetAsync(GetIndexRequest request, Cancella } /// - /// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. + /// + /// Get index information. + /// Returns information about one or more indices. For data streams, the API returns information about the + /// stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4135,7 +5067,11 @@ public virtual GetIndexResponse Get(GetIndexRequestDescriptor - /// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. + /// + /// Get index information. + /// Returns information about one or more indices. For data streams, the API returns information about the + /// stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4147,7 +5083,11 @@ public virtual GetIndexResponse Get(Elastic.Clients.Elasticsearch.Ind } /// - /// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. + /// + /// Get index information. + /// Returns information about one or more indices. For data streams, the API returns information about the + /// stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4160,7 +5100,11 @@ public virtual GetIndexResponse Get(Elastic.Clients.Elasticsearch.Ind } /// - /// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. + /// + /// Get index information. + /// Returns information about one or more indices. For data streams, the API returns information about the + /// stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4172,7 +5116,11 @@ public virtual GetIndexResponse Get() } /// - /// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. + /// + /// Get index information. + /// Returns information about one or more indices. For data streams, the API returns information about the + /// stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4185,7 +5133,11 @@ public virtual GetIndexResponse Get(Action - /// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. + /// + /// Get index information. + /// Returns information about one or more indices. For data streams, the API returns information about the + /// stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4196,7 +5148,11 @@ public virtual GetIndexResponse Get(GetIndexRequestDescriptor descriptor) } /// - /// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. + /// + /// Get index information. + /// Returns information about one or more indices. For data streams, the API returns information about the + /// stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4208,7 +5164,11 @@ public virtual GetIndexResponse Get(Elastic.Clients.Elasticsearch.Indices indice } /// - /// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. + /// + /// Get index information. + /// Returns information about one or more indices. For data streams, the API returns information about the + /// stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4221,7 +5181,11 @@ public virtual GetIndexResponse Get(Elastic.Clients.Elasticsearch.Indices indice } /// - /// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. + /// + /// Get index information. + /// Returns information about one or more indices. For data streams, the API returns information about the + /// stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(GetIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4231,7 +5195,11 @@ public virtual Task GetAsync(GetIndexRequestDescrip } /// - /// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. + /// + /// Get index information. + /// Returns information about one or more indices. For data streams, the API returns information about the + /// stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -4242,7 +5210,11 @@ public virtual Task GetAsync(Elastic.Clients.Elasti } /// - /// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. + /// + /// Get index information. + /// Returns information about one or more indices. For data streams, the API returns information about the + /// stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -4254,7 +5226,11 @@ public virtual Task GetAsync(Elastic.Clients.Elasti } /// - /// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. + /// + /// Get index information. + /// Returns information about one or more indices. For data streams, the API returns information about the + /// stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(CancellationToken cancellationToken = default) @@ -4265,7 +5241,11 @@ public virtual Task GetAsync(CancellationToken canc } /// - /// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. + /// + /// Get index information. + /// Returns information about one or more indices. For data streams, the API returns information about the + /// stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -4277,7 +5257,11 @@ public virtual Task GetAsync(Action - /// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. + /// + /// Get index information. + /// Returns information about one or more indices. For data streams, the API returns information about the + /// stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(GetIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4287,7 +5271,11 @@ public virtual Task GetAsync(GetIndexRequestDescriptor descrip } /// - /// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. + /// + /// Get index information. + /// Returns information about one or more indices. For data streams, the API returns information about the + /// stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -4298,7 +5286,11 @@ public virtual Task GetAsync(Elastic.Clients.Elasticsearch.Ind } /// - /// Get index information.
Returns information about one or more indices. For data streams, the API returns information about the
stream’s backing indices. + /// + /// Get index information. + /// Returns information about one or more indices. For data streams, the API returns information about the + /// stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -4310,7 +5302,10 @@ public virtual Task GetAsync(Elastic.Clients.Elasticsearch.Ind } /// - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4321,7 +5316,10 @@ public virtual GetAliasResponse GetAlias(GetAliasRequest request) } /// - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAliasAsync(GetAliasRequest request, CancellationToken cancellationToken = default) @@ -4331,7 +5329,10 @@ public virtual Task GetAliasAsync(GetAliasRequest request, Can } /// - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4342,7 +5343,10 @@ public virtual GetAliasResponse GetAlias(GetAliasRequestDescriptor - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4354,7 +5358,10 @@ public virtual GetAliasResponse GetAlias(Elastic.Clients.Elasticsearc } /// - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4367,7 +5374,10 @@ public virtual GetAliasResponse GetAlias(Elastic.Clients.Elasticsearc } /// - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4379,7 +5389,10 @@ public virtual GetAliasResponse GetAlias() } /// - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4392,7 +5405,10 @@ public virtual GetAliasResponse GetAlias(Action - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4403,7 +5419,10 @@ public virtual GetAliasResponse GetAlias(GetAliasRequestDescriptor descriptor) } /// - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4415,7 +5434,10 @@ public virtual GetAliasResponse GetAlias(Elastic.Clients.Elasticsearch.Indices? } /// - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4428,7 +5450,10 @@ public virtual GetAliasResponse GetAlias(Elastic.Clients.Elasticsearch.Indices? } /// - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4440,7 +5465,10 @@ public virtual GetAliasResponse GetAlias() } /// - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4453,7 +5481,10 @@ public virtual GetAliasResponse GetAlias(Action confi } /// - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAliasAsync(GetAliasRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4463,7 +5494,10 @@ public virtual Task GetAliasAsync(GetAliasRequestDe } /// - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAliasAsync(Elastic.Clients.Elasticsearch.Indices? indices, Elastic.Clients.Elasticsearch.Names? name, CancellationToken cancellationToken = default) @@ -4474,7 +5508,10 @@ public virtual Task GetAliasAsync(Elastic.Clients.E } /// - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAliasAsync(Elastic.Clients.Elasticsearch.Indices? indices, Elastic.Clients.Elasticsearch.Names? name, Action> configureRequest, CancellationToken cancellationToken = default) @@ -4486,7 +5523,10 @@ public virtual Task GetAliasAsync(Elastic.Clients.E } /// - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAliasAsync(CancellationToken cancellationToken = default) @@ -4497,7 +5537,10 @@ public virtual Task GetAliasAsync(CancellationToken } /// - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAliasAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -4509,7 +5552,10 @@ public virtual Task GetAliasAsync(Action - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAliasAsync(GetAliasRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4519,7 +5565,10 @@ public virtual Task GetAliasAsync(GetAliasRequestDescriptor de } /// - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAliasAsync(Elastic.Clients.Elasticsearch.Indices? indices, Elastic.Clients.Elasticsearch.Names? name, CancellationToken cancellationToken = default) @@ -4530,7 +5579,10 @@ public virtual Task GetAliasAsync(Elastic.Clients.Elasticsearc } /// - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAliasAsync(Elastic.Clients.Elasticsearch.Indices? indices, Elastic.Clients.Elasticsearch.Names? name, Action configureRequest, CancellationToken cancellationToken = default) @@ -4542,7 +5594,10 @@ public virtual Task GetAliasAsync(Elastic.Clients.Elasticsearc } /// - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAliasAsync(CancellationToken cancellationToken = default) @@ -4553,7 +5608,10 @@ public virtual Task GetAliasAsync(CancellationToken cancellati } /// - /// Get aliases.
Retrieves information for one or more data stream or index aliases. + /// + /// Get aliases. + /// Retrieves information for one or more data stream or index aliases. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAliasAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -4565,7 +5623,10 @@ public virtual Task GetAliasAsync(Action - /// Get data stream lifecycles.
Retrieves the data stream lifecycle configuration of one or more data streams. + /// + /// Get data stream lifecycles. + /// Retrieves the data stream lifecycle configuration of one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4576,7 +5637,10 @@ public virtual GetDataLifecycleResponse GetDataLifecycle(GetDataLifecycleRequest } /// - /// Get data stream lifecycles.
Retrieves the data stream lifecycle configuration of one or more data streams. + /// + /// Get data stream lifecycles. + /// Retrieves the data stream lifecycle configuration of one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataLifecycleAsync(GetDataLifecycleRequest request, CancellationToken cancellationToken = default) @@ -4586,7 +5650,10 @@ public virtual Task GetDataLifecycleAsync(GetDataLifec } /// - /// Get data stream lifecycles.
Retrieves the data stream lifecycle configuration of one or more data streams. + /// + /// Get data stream lifecycles. + /// Retrieves the data stream lifecycle configuration of one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4597,7 +5664,10 @@ public virtual GetDataLifecycleResponse GetDataLifecycle(GetDataLifecycleRequest } /// - /// Get data stream lifecycles.
Retrieves the data stream lifecycle configuration of one or more data streams. + /// + /// Get data stream lifecycles. + /// Retrieves the data stream lifecycle configuration of one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4609,7 +5679,10 @@ public virtual GetDataLifecycleResponse GetDataLifecycle(Elastic.Clients.Elastic } /// - /// Get data stream lifecycles.
Retrieves the data stream lifecycle configuration of one or more data streams. + /// + /// Get data stream lifecycles. + /// Retrieves the data stream lifecycle configuration of one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4622,7 +5695,10 @@ public virtual GetDataLifecycleResponse GetDataLifecycle(Elastic.Clients.Elastic } /// - /// Get data stream lifecycles.
Retrieves the data stream lifecycle configuration of one or more data streams. + /// + /// Get data stream lifecycles. + /// Retrieves the data stream lifecycle configuration of one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataLifecycleAsync(GetDataLifecycleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4632,7 +5708,10 @@ public virtual Task GetDataLifecycleAsync(GetDataLifec } /// - /// Get data stream lifecycles.
Retrieves the data stream lifecycle configuration of one or more data streams. + /// + /// Get data stream lifecycles. + /// Retrieves the data stream lifecycle configuration of one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataLifecycleAsync(Elastic.Clients.Elasticsearch.DataStreamNames name, CancellationToken cancellationToken = default) @@ -4643,7 +5722,10 @@ public virtual Task GetDataLifecycleAsync(Elastic.Clie } /// - /// Get data stream lifecycles.
Retrieves the data stream lifecycle configuration of one or more data streams. + /// + /// Get data stream lifecycles. + /// Retrieves the data stream lifecycle configuration of one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataLifecycleAsync(Elastic.Clients.Elasticsearch.DataStreamNames name, Action configureRequest, CancellationToken cancellationToken = default) @@ -4655,7 +5737,10 @@ public virtual Task GetDataLifecycleAsync(Elastic.Clie } /// - /// Get data streams.
Retrieves information about one or more data streams. + /// + /// Get data streams. + /// Retrieves information about one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4666,7 +5751,10 @@ public virtual GetDataStreamResponse GetDataStream(GetDataStreamRequest request) } /// - /// Get data streams.
Retrieves information about one or more data streams. + /// + /// Get data streams. + /// Retrieves information about one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataStreamAsync(GetDataStreamRequest request, CancellationToken cancellationToken = default) @@ -4676,7 +5764,10 @@ public virtual Task GetDataStreamAsync(GetDataStreamReque } /// - /// Get data streams.
Retrieves information about one or more data streams. + /// + /// Get data streams. + /// Retrieves information about one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4687,7 +5778,10 @@ public virtual GetDataStreamResponse GetDataStream(GetDataStreamRequestDescripto } /// - /// Get data streams.
Retrieves information about one or more data streams. + /// + /// Get data streams. + /// Retrieves information about one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4699,7 +5793,10 @@ public virtual GetDataStreamResponse GetDataStream(Elastic.Clients.Elasticsearch } /// - /// Get data streams.
Retrieves information about one or more data streams. + /// + /// Get data streams. + /// Retrieves information about one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4712,7 +5809,10 @@ public virtual GetDataStreamResponse GetDataStream(Elastic.Clients.Elasticsearch } /// - /// Get data streams.
Retrieves information about one or more data streams. + /// + /// Get data streams. + /// Retrieves information about one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4724,7 +5824,10 @@ public virtual GetDataStreamResponse GetDataStream() } /// - /// Get data streams.
Retrieves information about one or more data streams. + /// + /// Get data streams. + /// Retrieves information about one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4737,7 +5840,10 @@ public virtual GetDataStreamResponse GetDataStream(Action - /// Get data streams.
Retrieves information about one or more data streams. + /// + /// Get data streams. + /// Retrieves information about one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataStreamAsync(GetDataStreamRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4747,7 +5853,10 @@ public virtual Task GetDataStreamAsync(GetDataStreamReque } /// - /// Get data streams.
Retrieves information about one or more data streams. + /// + /// Get data streams. + /// Retrieves information about one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataStreamAsync(Elastic.Clients.Elasticsearch.DataStreamNames? name, CancellationToken cancellationToken = default) @@ -4758,7 +5867,10 @@ public virtual Task GetDataStreamAsync(Elastic.Clients.El } /// - /// Get data streams.
Retrieves information about one or more data streams. + /// + /// Get data streams. + /// Retrieves information about one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataStreamAsync(Elastic.Clients.Elasticsearch.DataStreamNames? name, Action configureRequest, CancellationToken cancellationToken = default) @@ -4770,7 +5882,10 @@ public virtual Task GetDataStreamAsync(Elastic.Clients.El } /// - /// Get data streams.
Retrieves information about one or more data streams. + /// + /// Get data streams. + /// Retrieves information about one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataStreamAsync(CancellationToken cancellationToken = default) @@ -4781,7 +5896,10 @@ public virtual Task GetDataStreamAsync(CancellationToken } /// - /// Get data streams.
Retrieves information about one or more data streams. + /// + /// Get data streams. + /// Retrieves information about one or more data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataStreamAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -4793,7 +5911,11 @@ public virtual Task GetDataStreamAsync(Action - /// Get mapping definitions.
Retrieves mapping definitions for one or more fields.
For data streams, the API retrieves field mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more fields. + /// For data streams, the API retrieves field mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4804,7 +5926,11 @@ public virtual GetFieldMappingResponse GetFieldMapping(GetFieldMappingRequest re } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more fields.
For data streams, the API retrieves field mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more fields. + /// For data streams, the API retrieves field mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetFieldMappingAsync(GetFieldMappingRequest request, CancellationToken cancellationToken = default) @@ -4814,7 +5940,11 @@ public virtual Task GetFieldMappingAsync(GetFieldMappin } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more fields.
For data streams, the API retrieves field mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more fields. + /// For data streams, the API retrieves field mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4825,7 +5955,11 @@ public virtual GetFieldMappingResponse GetFieldMapping(GetFieldMappin } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more fields.
For data streams, the API retrieves field mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more fields. + /// For data streams, the API retrieves field mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4837,7 +5971,11 @@ public virtual GetFieldMappingResponse GetFieldMapping(Elastic.Client } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more fields.
For data streams, the API retrieves field mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more fields. + /// For data streams, the API retrieves field mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4850,7 +5988,11 @@ public virtual GetFieldMappingResponse GetFieldMapping(Elastic.Client } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more fields.
For data streams, the API retrieves field mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more fields. + /// For data streams, the API retrieves field mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4862,7 +6004,11 @@ public virtual GetFieldMappingResponse GetFieldMapping(Elastic.Client } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more fields.
For data streams, the API retrieves field mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more fields. + /// For data streams, the API retrieves field mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4875,7 +6021,11 @@ public virtual GetFieldMappingResponse GetFieldMapping(Elastic.Client } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more fields.
For data streams, the API retrieves field mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more fields. + /// For data streams, the API retrieves field mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4886,7 +6036,11 @@ public virtual GetFieldMappingResponse GetFieldMapping(GetFieldMappingRequestDes } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more fields.
For data streams, the API retrieves field mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more fields. + /// For data streams, the API retrieves field mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4898,7 +6052,11 @@ public virtual GetFieldMappingResponse GetFieldMapping(Elastic.Clients.Elasticse } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more fields.
For data streams, the API retrieves field mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more fields. + /// For data streams, the API retrieves field mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4911,7 +6069,11 @@ public virtual GetFieldMappingResponse GetFieldMapping(Elastic.Clients.Elasticse } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more fields.
For data streams, the API retrieves field mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more fields. + /// For data streams, the API retrieves field mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4923,7 +6085,11 @@ public virtual GetFieldMappingResponse GetFieldMapping(Elastic.Clients.Elasticse } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more fields.
For data streams, the API retrieves field mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more fields. + /// For data streams, the API retrieves field mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4936,7 +6102,11 @@ public virtual GetFieldMappingResponse GetFieldMapping(Elastic.Clients.Elasticse } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more fields.
For data streams, the API retrieves field mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more fields. + /// For data streams, the API retrieves field mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetFieldMappingAsync(GetFieldMappingRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4946,7 +6116,11 @@ public virtual Task GetFieldMappingAsync(Get } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more fields.
For data streams, the API retrieves field mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more fields. + /// For data streams, the API retrieves field mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetFieldMappingAsync(Elastic.Clients.Elasticsearch.Indices? indices, Elastic.Clients.Elasticsearch.Fields fields, CancellationToken cancellationToken = default) @@ -4957,7 +6131,11 @@ public virtual Task GetFieldMappingAsync(Ela } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more fields.
For data streams, the API retrieves field mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more fields. + /// For data streams, the API retrieves field mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetFieldMappingAsync(Elastic.Clients.Elasticsearch.Indices? indices, Elastic.Clients.Elasticsearch.Fields fields, Action> configureRequest, CancellationToken cancellationToken = default) @@ -4969,7 +6147,11 @@ public virtual Task GetFieldMappingAsync(Ela } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more fields.
For data streams, the API retrieves field mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more fields. + /// For data streams, the API retrieves field mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetFieldMappingAsync(Elastic.Clients.Elasticsearch.Fields fields, CancellationToken cancellationToken = default) @@ -4980,7 +6162,11 @@ public virtual Task GetFieldMappingAsync(Ela } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more fields.
For data streams, the API retrieves field mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more fields. + /// For data streams, the API retrieves field mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetFieldMappingAsync(Elastic.Clients.Elasticsearch.Fields fields, Action> configureRequest, CancellationToken cancellationToken = default) @@ -4992,7 +6178,11 @@ public virtual Task GetFieldMappingAsync(Ela } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more fields.
For data streams, the API retrieves field mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more fields. + /// For data streams, the API retrieves field mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetFieldMappingAsync(GetFieldMappingRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -5002,7 +6192,11 @@ public virtual Task GetFieldMappingAsync(GetFieldMappin } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more fields.
For data streams, the API retrieves field mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more fields. + /// For data streams, the API retrieves field mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetFieldMappingAsync(Elastic.Clients.Elasticsearch.Indices? indices, Elastic.Clients.Elasticsearch.Fields fields, CancellationToken cancellationToken = default) @@ -5013,7 +6207,11 @@ public virtual Task GetFieldMappingAsync(Elastic.Client } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more fields.
For data streams, the API retrieves field mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more fields. + /// For data streams, the API retrieves field mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetFieldMappingAsync(Elastic.Clients.Elasticsearch.Indices? indices, Elastic.Clients.Elasticsearch.Fields fields, Action configureRequest, CancellationToken cancellationToken = default) @@ -5025,7 +6223,11 @@ public virtual Task GetFieldMappingAsync(Elastic.Client } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more fields.
For data streams, the API retrieves field mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more fields. + /// For data streams, the API retrieves field mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetFieldMappingAsync(Elastic.Clients.Elasticsearch.Fields fields, CancellationToken cancellationToken = default) @@ -5036,7 +6238,11 @@ public virtual Task GetFieldMappingAsync(Elastic.Client } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more fields.
For data streams, the API retrieves field mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more fields. + /// For data streams, the API retrieves field mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetFieldMappingAsync(Elastic.Clients.Elasticsearch.Fields fields, Action configureRequest, CancellationToken cancellationToken = default) @@ -5048,7 +6254,10 @@ public virtual Task GetFieldMappingAsync(Elastic.Client } /// - /// Get index templates.
Returns information about one or more index templates. + /// + /// Get index templates. + /// Returns information about one or more index templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5059,7 +6268,10 @@ public virtual GetIndexTemplateResponse GetIndexTemplate(GetIndexTemplateRequest } /// - /// Get index templates.
Returns information about one or more index templates. + /// + /// Get index templates. + /// Returns information about one or more index templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetIndexTemplateAsync(GetIndexTemplateRequest request, CancellationToken cancellationToken = default) @@ -5069,7 +6281,10 @@ public virtual Task GetIndexTemplateAsync(GetIndexTemp } /// - /// Get index templates.
Returns information about one or more index templates. + /// + /// Get index templates. + /// Returns information about one or more index templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5080,7 +6295,10 @@ public virtual GetIndexTemplateResponse GetIndexTemplate(GetIndexTemplateRequest } /// - /// Get index templates.
Returns information about one or more index templates. + /// + /// Get index templates. + /// Returns information about one or more index templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5092,7 +6310,10 @@ public virtual GetIndexTemplateResponse GetIndexTemplate(Elastic.Clients.Elastic } /// - /// Get index templates.
Returns information about one or more index templates. + /// + /// Get index templates. + /// Returns information about one or more index templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5105,7 +6326,10 @@ public virtual GetIndexTemplateResponse GetIndexTemplate(Elastic.Clients.Elastic } /// - /// Get index templates.
Returns information about one or more index templates. + /// + /// Get index templates. + /// Returns information about one or more index templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5117,7 +6341,10 @@ public virtual GetIndexTemplateResponse GetIndexTemplate() } /// - /// Get index templates.
Returns information about one or more index templates. + /// + /// Get index templates. + /// Returns information about one or more index templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5130,7 +6357,10 @@ public virtual GetIndexTemplateResponse GetIndexTemplate(Action - /// Get index templates.
Returns information about one or more index templates. + /// + /// Get index templates. + /// Returns information about one or more index templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetIndexTemplateAsync(GetIndexTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -5140,7 +6370,10 @@ public virtual Task GetIndexTemplateAsync(GetIndexTemp } /// - /// Get index templates.
Returns information about one or more index templates. + /// + /// Get index templates. + /// Returns information about one or more index templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetIndexTemplateAsync(Elastic.Clients.Elasticsearch.Name? name, CancellationToken cancellationToken = default) @@ -5151,7 +6384,10 @@ public virtual Task GetIndexTemplateAsync(Elastic.Clie } /// - /// Get index templates.
Returns information about one or more index templates. + /// + /// Get index templates. + /// Returns information about one or more index templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetIndexTemplateAsync(Elastic.Clients.Elasticsearch.Name? name, Action configureRequest, CancellationToken cancellationToken = default) @@ -5163,7 +6399,10 @@ public virtual Task GetIndexTemplateAsync(Elastic.Clie } /// - /// Get index templates.
Returns information about one or more index templates. + /// + /// Get index templates. + /// Returns information about one or more index templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetIndexTemplateAsync(CancellationToken cancellationToken = default) @@ -5174,7 +6413,10 @@ public virtual Task GetIndexTemplateAsync(Cancellation } /// - /// Get index templates.
Returns information about one or more index templates. + /// + /// Get index templates. + /// Returns information about one or more index templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetIndexTemplateAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -5186,7 +6428,11 @@ public virtual Task GetIndexTemplateAsync(Action - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5197,7 +6443,11 @@ public virtual GetMappingResponse GetMapping(GetMappingRequest request) } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMappingAsync(GetMappingRequest request, CancellationToken cancellationToken = default) @@ -5207,7 +6457,11 @@ public virtual Task GetMappingAsync(GetMappingRequest reques } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5218,7 +6472,11 @@ public virtual GetMappingResponse GetMapping(GetMappingRequestDescrip } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5230,7 +6488,11 @@ public virtual GetMappingResponse GetMapping(Elastic.Clients.Elastics } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5243,7 +6505,11 @@ public virtual GetMappingResponse GetMapping(Elastic.Clients.Elastics } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5255,7 +6521,11 @@ public virtual GetMappingResponse GetMapping() } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5268,7 +6538,11 @@ public virtual GetMappingResponse GetMapping(Action - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5279,7 +6553,11 @@ public virtual GetMappingResponse GetMapping(GetMappingRequestDescriptor descrip } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5291,7 +6569,11 @@ public virtual GetMappingResponse GetMapping(Elastic.Clients.Elasticsearch.Indic } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5304,7 +6586,11 @@ public virtual GetMappingResponse GetMapping(Elastic.Clients.Elasticsearch.Indic } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5316,7 +6602,11 @@ public virtual GetMappingResponse GetMapping() } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5329,7 +6619,11 @@ public virtual GetMappingResponse GetMapping(Action } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMappingAsync(GetMappingRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -5339,7 +6633,11 @@ public virtual Task GetMappingAsync(GetMappingReq } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMappingAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -5350,7 +6648,11 @@ public virtual Task GetMappingAsync(Elastic.Clien } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMappingAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -5362,7 +6664,11 @@ public virtual Task GetMappingAsync(Elastic.Clien } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMappingAsync(CancellationToken cancellationToken = default) @@ -5373,7 +6679,11 @@ public virtual Task GetMappingAsync(CancellationT } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMappingAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -5385,7 +6695,11 @@ public virtual Task GetMappingAsync(Action - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMappingAsync(GetMappingRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -5395,7 +6709,11 @@ public virtual Task GetMappingAsync(GetMappingRequestDescrip } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMappingAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -5406,7 +6724,11 @@ public virtual Task GetMappingAsync(Elastic.Clients.Elastics } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMappingAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -5418,7 +6740,11 @@ public virtual Task GetMappingAsync(Elastic.Clients.Elastics } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMappingAsync(CancellationToken cancellationToken = default) @@ -5429,7 +6755,11 @@ public virtual Task GetMappingAsync(CancellationToken cancel } /// - /// Get mapping definitions.
Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. + /// + /// Get mapping definitions. + /// Retrieves mapping definitions for one or more indices. + /// For data streams, the API retrieves mappings for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMappingAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -5441,7 +6771,11 @@ public virtual Task GetMappingAsync(Action - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5452,7 +6786,11 @@ public virtual GetIndicesSettingsResponse GetSettings(GetIndicesSettingsRequest } /// - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(GetIndicesSettingsRequest request, CancellationToken cancellationToken = default) @@ -5462,7 +6800,11 @@ public virtual Task GetSettingsAsync(GetIndicesSetti } /// - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5473,7 +6815,11 @@ public virtual GetIndicesSettingsResponse GetSettings(GetIndicesSetti } /// - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5485,7 +6831,11 @@ public virtual GetIndicesSettingsResponse GetSettings(Elastic.Clients } /// - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5498,7 +6848,11 @@ public virtual GetIndicesSettingsResponse GetSettings(Elastic.Clients } /// - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5510,7 +6864,11 @@ public virtual GetIndicesSettingsResponse GetSettings() } /// - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5523,7 +6881,11 @@ public virtual GetIndicesSettingsResponse GetSettings(Action - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5534,7 +6896,11 @@ public virtual GetIndicesSettingsResponse GetSettings(GetIndicesSettingsRequestD } /// - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5546,7 +6912,11 @@ public virtual GetIndicesSettingsResponse GetSettings(Elastic.Clients.Elasticsea } /// - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5559,7 +6929,11 @@ public virtual GetIndicesSettingsResponse GetSettings(Elastic.Clients.Elasticsea } /// - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5571,7 +6945,11 @@ public virtual GetIndicesSettingsResponse GetSettings() } /// - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5584,7 +6962,11 @@ public virtual GetIndicesSettingsResponse GetSettings(Action - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(GetIndicesSettingsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -5594,7 +6976,11 @@ public virtual Task GetSettingsAsync(GetI } /// - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(Elastic.Clients.Elasticsearch.Indices? indices, Elastic.Clients.Elasticsearch.Names? name, CancellationToken cancellationToken = default) @@ -5605,7 +6991,11 @@ public virtual Task GetSettingsAsync(Elas } /// - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(Elastic.Clients.Elasticsearch.Indices? indices, Elastic.Clients.Elasticsearch.Names? name, Action> configureRequest, CancellationToken cancellationToken = default) @@ -5617,7 +7007,11 @@ public virtual Task GetSettingsAsync(Elas } /// - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(CancellationToken cancellationToken = default) @@ -5628,7 +7022,11 @@ public virtual Task GetSettingsAsync(Canc } /// - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -5640,7 +7038,11 @@ public virtual Task GetSettingsAsync(Acti } /// - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(GetIndicesSettingsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -5650,7 +7052,11 @@ public virtual Task GetSettingsAsync(GetIndicesSetti } /// - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(Elastic.Clients.Elasticsearch.Indices? indices, Elastic.Clients.Elasticsearch.Names? name, CancellationToken cancellationToken = default) @@ -5661,7 +7067,11 @@ public virtual Task GetSettingsAsync(Elastic.Clients } /// - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(Elastic.Clients.Elasticsearch.Indices? indices, Elastic.Clients.Elasticsearch.Names? name, Action configureRequest, CancellationToken cancellationToken = default) @@ -5673,7 +7083,11 @@ public virtual Task GetSettingsAsync(Elastic.Clients } /// - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(CancellationToken cancellationToken = default) @@ -5684,7 +7098,11 @@ public virtual Task GetSettingsAsync(CancellationTok } /// - /// Get index settings.
Returns setting information for one or more indices. For data streams,
returns setting information for the stream’s backing indices. + /// + /// Get index settings. + /// Returns setting information for one or more indices. For data streams, + /// returns setting information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -5696,7 +7114,10 @@ public virtual Task GetSettingsAsync(Action - /// Get index templates.
Retrieves information about one or more index templates. + /// + /// Get index templates. + /// Retrieves information about one or more index templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5707,7 +7128,10 @@ public virtual GetTemplateResponse GetTemplate(GetTemplateRequest request) } /// - /// Get index templates.
Retrieves information about one or more index templates. + /// + /// Get index templates. + /// Retrieves information about one or more index templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTemplateAsync(GetTemplateRequest request, CancellationToken cancellationToken = default) @@ -5717,7 +7141,10 @@ public virtual Task GetTemplateAsync(GetTemplateRequest req } /// - /// Get index templates.
Retrieves information about one or more index templates. + /// + /// Get index templates. + /// Retrieves information about one or more index templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5728,7 +7155,10 @@ public virtual GetTemplateResponse GetTemplate(GetTemplateRequestDescriptor desc } /// - /// Get index templates.
Retrieves information about one or more index templates. + /// + /// Get index templates. + /// Retrieves information about one or more index templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5740,7 +7170,10 @@ public virtual GetTemplateResponse GetTemplate(Elastic.Clients.Elasticsearch.Nam } /// - /// Get index templates.
Retrieves information about one or more index templates. + /// + /// Get index templates. + /// Retrieves information about one or more index templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5753,7 +7186,10 @@ public virtual GetTemplateResponse GetTemplate(Elastic.Clients.Elasticsearch.Nam } /// - /// Get index templates.
Retrieves information about one or more index templates. + /// + /// Get index templates. + /// Retrieves information about one or more index templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5765,7 +7201,10 @@ public virtual GetTemplateResponse GetTemplate() } /// - /// Get index templates.
Retrieves information about one or more index templates. + /// + /// Get index templates. + /// Retrieves information about one or more index templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5778,7 +7217,10 @@ public virtual GetTemplateResponse GetTemplate(Action - /// Get index templates.
Retrieves information about one or more index templates. + /// + /// Get index templates. + /// Retrieves information about one or more index templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTemplateAsync(GetTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -5788,7 +7230,10 @@ public virtual Task GetTemplateAsync(GetTemplateRequestDesc } /// - /// Get index templates.
Retrieves information about one or more index templates. + /// + /// Get index templates. + /// Retrieves information about one or more index templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTemplateAsync(Elastic.Clients.Elasticsearch.Names? name, CancellationToken cancellationToken = default) @@ -5799,7 +7244,10 @@ public virtual Task GetTemplateAsync(Elastic.Clients.Elasti } /// - /// Get index templates.
Retrieves information about one or more index templates. + /// + /// Get index templates. + /// Retrieves information about one or more index templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTemplateAsync(Elastic.Clients.Elasticsearch.Names? name, Action configureRequest, CancellationToken cancellationToken = default) @@ -5811,7 +7259,10 @@ public virtual Task GetTemplateAsync(Elastic.Clients.Elasti } /// - /// Get index templates.
Retrieves information about one or more index templates. + /// + /// Get index templates. + /// Retrieves information about one or more index templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTemplateAsync(CancellationToken cancellationToken = default) @@ -5822,7 +7273,10 @@ public virtual Task GetTemplateAsync(CancellationToken canc } /// - /// Get index templates.
Retrieves information about one or more index templates. + /// + /// Get index templates. + /// Retrieves information about one or more index templates. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTemplateAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -5834,7 +7288,19 @@ public virtual Task GetTemplateAsync(Action - /// Convert an index alias to a data stream.
Converts an index alias to a data stream.
You must have a matching index template that is data stream enabled.
The alias must meet the following criteria:
The alias must have a write index;
All indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;
The alias must not have any filters;
The alias must not use custom routing.
If successful, the request removes the alias and creates a data stream with the same name.
The indices for the alias become hidden backing indices for the stream.
The write index for the alias becomes the write index for the stream. + /// + /// Convert an index alias to a data stream. + /// Converts an index alias to a data stream. + /// You must have a matching index template that is data stream enabled. + /// The alias must meet the following criteria: + /// The alias must have a write index; + /// All indices for the alias must have a @timestamp field mapping of a date or date_nanos field type; + /// The alias must not have any filters; + /// The alias must not use custom routing. + /// If successful, the request removes the alias and creates a data stream with the same name. + /// The indices for the alias become hidden backing indices for the stream. + /// The write index for the alias becomes the write index for the stream. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5845,7 +7311,19 @@ public virtual MigrateToDataStreamResponse MigrateToDataStream(MigrateToDataStre } /// - /// Convert an index alias to a data stream.
Converts an index alias to a data stream.
You must have a matching index template that is data stream enabled.
The alias must meet the following criteria:
The alias must have a write index;
All indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;
The alias must not have any filters;
The alias must not use custom routing.
If successful, the request removes the alias and creates a data stream with the same name.
The indices for the alias become hidden backing indices for the stream.
The write index for the alias becomes the write index for the stream. + /// + /// Convert an index alias to a data stream. + /// Converts an index alias to a data stream. + /// You must have a matching index template that is data stream enabled. + /// The alias must meet the following criteria: + /// The alias must have a write index; + /// All indices for the alias must have a @timestamp field mapping of a date or date_nanos field type; + /// The alias must not have any filters; + /// The alias must not use custom routing. + /// If successful, the request removes the alias and creates a data stream with the same name. + /// The indices for the alias become hidden backing indices for the stream. + /// The write index for the alias becomes the write index for the stream. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MigrateToDataStreamAsync(MigrateToDataStreamRequest request, CancellationToken cancellationToken = default) @@ -5855,7 +7333,19 @@ public virtual Task MigrateToDataStreamAsync(Migrat } /// - /// Convert an index alias to a data stream.
Converts an index alias to a data stream.
You must have a matching index template that is data stream enabled.
The alias must meet the following criteria:
The alias must have a write index;
All indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;
The alias must not have any filters;
The alias must not use custom routing.
If successful, the request removes the alias and creates a data stream with the same name.
The indices for the alias become hidden backing indices for the stream.
The write index for the alias becomes the write index for the stream. + /// + /// Convert an index alias to a data stream. + /// Converts an index alias to a data stream. + /// You must have a matching index template that is data stream enabled. + /// The alias must meet the following criteria: + /// The alias must have a write index; + /// All indices for the alias must have a @timestamp field mapping of a date or date_nanos field type; + /// The alias must not have any filters; + /// The alias must not use custom routing. + /// If successful, the request removes the alias and creates a data stream with the same name. + /// The indices for the alias become hidden backing indices for the stream. + /// The write index for the alias becomes the write index for the stream. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5866,7 +7356,19 @@ public virtual MigrateToDataStreamResponse MigrateToDataStream(MigrateToDataStre } /// - /// Convert an index alias to a data stream.
Converts an index alias to a data stream.
You must have a matching index template that is data stream enabled.
The alias must meet the following criteria:
The alias must have a write index;
All indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;
The alias must not have any filters;
The alias must not use custom routing.
If successful, the request removes the alias and creates a data stream with the same name.
The indices for the alias become hidden backing indices for the stream.
The write index for the alias becomes the write index for the stream. + /// + /// Convert an index alias to a data stream. + /// Converts an index alias to a data stream. + /// You must have a matching index template that is data stream enabled. + /// The alias must meet the following criteria: + /// The alias must have a write index; + /// All indices for the alias must have a @timestamp field mapping of a date or date_nanos field type; + /// The alias must not have any filters; + /// The alias must not use custom routing. + /// If successful, the request removes the alias and creates a data stream with the same name. + /// The indices for the alias become hidden backing indices for the stream. + /// The write index for the alias becomes the write index for the stream. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5878,7 +7380,19 @@ public virtual MigrateToDataStreamResponse MigrateToDataStream(Elastic.Clients.E } /// - /// Convert an index alias to a data stream.
Converts an index alias to a data stream.
You must have a matching index template that is data stream enabled.
The alias must meet the following criteria:
The alias must have a write index;
All indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;
The alias must not have any filters;
The alias must not use custom routing.
If successful, the request removes the alias and creates a data stream with the same name.
The indices for the alias become hidden backing indices for the stream.
The write index for the alias becomes the write index for the stream. + /// + /// Convert an index alias to a data stream. + /// Converts an index alias to a data stream. + /// You must have a matching index template that is data stream enabled. + /// The alias must meet the following criteria: + /// The alias must have a write index; + /// All indices for the alias must have a @timestamp field mapping of a date or date_nanos field type; + /// The alias must not have any filters; + /// The alias must not use custom routing. + /// If successful, the request removes the alias and creates a data stream with the same name. + /// The indices for the alias become hidden backing indices for the stream. + /// The write index for the alias becomes the write index for the stream. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5891,7 +7405,19 @@ public virtual MigrateToDataStreamResponse MigrateToDataStream(Elastic.Clients.E } /// - /// Convert an index alias to a data stream.
Converts an index alias to a data stream.
You must have a matching index template that is data stream enabled.
The alias must meet the following criteria:
The alias must have a write index;
All indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;
The alias must not have any filters;
The alias must not use custom routing.
If successful, the request removes the alias and creates a data stream with the same name.
The indices for the alias become hidden backing indices for the stream.
The write index for the alias becomes the write index for the stream. + /// + /// Convert an index alias to a data stream. + /// Converts an index alias to a data stream. + /// You must have a matching index template that is data stream enabled. + /// The alias must meet the following criteria: + /// The alias must have a write index; + /// All indices for the alias must have a @timestamp field mapping of a date or date_nanos field type; + /// The alias must not have any filters; + /// The alias must not use custom routing. + /// If successful, the request removes the alias and creates a data stream with the same name. + /// The indices for the alias become hidden backing indices for the stream. + /// The write index for the alias becomes the write index for the stream. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MigrateToDataStreamAsync(MigrateToDataStreamRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -5901,7 +7427,19 @@ public virtual Task MigrateToDataStreamAsync(Migrat } /// - /// Convert an index alias to a data stream.
Converts an index alias to a data stream.
You must have a matching index template that is data stream enabled.
The alias must meet the following criteria:
The alias must have a write index;
All indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;
The alias must not have any filters;
The alias must not use custom routing.
If successful, the request removes the alias and creates a data stream with the same name.
The indices for the alias become hidden backing indices for the stream.
The write index for the alias becomes the write index for the stream. + /// + /// Convert an index alias to a data stream. + /// Converts an index alias to a data stream. + /// You must have a matching index template that is data stream enabled. + /// The alias must meet the following criteria: + /// The alias must have a write index; + /// All indices for the alias must have a @timestamp field mapping of a date or date_nanos field type; + /// The alias must not have any filters; + /// The alias must not use custom routing. + /// If successful, the request removes the alias and creates a data stream with the same name. + /// The indices for the alias become hidden backing indices for the stream. + /// The write index for the alias becomes the write index for the stream. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MigrateToDataStreamAsync(Elastic.Clients.Elasticsearch.IndexName name, CancellationToken cancellationToken = default) @@ -5912,7 +7450,19 @@ public virtual Task MigrateToDataStreamAsync(Elasti } /// - /// Convert an index alias to a data stream.
Converts an index alias to a data stream.
You must have a matching index template that is data stream enabled.
The alias must meet the following criteria:
The alias must have a write index;
All indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;
The alias must not have any filters;
The alias must not use custom routing.
If successful, the request removes the alias and creates a data stream with the same name.
The indices for the alias become hidden backing indices for the stream.
The write index for the alias becomes the write index for the stream. + /// + /// Convert an index alias to a data stream. + /// Converts an index alias to a data stream. + /// You must have a matching index template that is data stream enabled. + /// The alias must meet the following criteria: + /// The alias must have a write index; + /// All indices for the alias must have a @timestamp field mapping of a date or date_nanos field type; + /// The alias must not have any filters; + /// The alias must not use custom routing. + /// If successful, the request removes the alias and creates a data stream with the same name. + /// The indices for the alias become hidden backing indices for the stream. + /// The write index for the alias becomes the write index for the stream. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MigrateToDataStreamAsync(Elastic.Clients.Elasticsearch.IndexName name, Action configureRequest, CancellationToken cancellationToken = default) @@ -5924,7 +7474,10 @@ public virtual Task MigrateToDataStreamAsync(Elasti } /// - /// Update data streams.
Performs one or more data stream modification actions in a single atomic operation. + /// + /// Update data streams. + /// Performs one or more data stream modification actions in a single atomic operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5935,7 +7488,10 @@ public virtual ModifyDataStreamResponse ModifyDataStream(ModifyDataStreamRequest } /// - /// Update data streams.
Performs one or more data stream modification actions in a single atomic operation. + /// + /// Update data streams. + /// Performs one or more data stream modification actions in a single atomic operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ModifyDataStreamAsync(ModifyDataStreamRequest request, CancellationToken cancellationToken = default) @@ -5945,7 +7501,10 @@ public virtual Task ModifyDataStreamAsync(ModifyDataSt } /// - /// Update data streams.
Performs one or more data stream modification actions in a single atomic operation. + /// + /// Update data streams. + /// Performs one or more data stream modification actions in a single atomic operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5956,7 +7515,10 @@ public virtual ModifyDataStreamResponse ModifyDataStream(ModifyDataStreamRequest } /// - /// Update data streams.
Performs one or more data stream modification actions in a single atomic operation. + /// + /// Update data streams. + /// Performs one or more data stream modification actions in a single atomic operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5968,7 +7530,10 @@ public virtual ModifyDataStreamResponse ModifyDataStream() } /// - /// Update data streams.
Performs one or more data stream modification actions in a single atomic operation. + /// + /// Update data streams. + /// Performs one or more data stream modification actions in a single atomic operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5981,7 +7546,10 @@ public virtual ModifyDataStreamResponse ModifyDataStream(Action - /// Update data streams.
Performs one or more data stream modification actions in a single atomic operation. + /// + /// Update data streams. + /// Performs one or more data stream modification actions in a single atomic operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ModifyDataStreamAsync(ModifyDataStreamRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -5991,7 +7559,10 @@ public virtual Task ModifyDataStreamAsync(ModifyDataSt } /// - /// Update data streams.
Performs one or more data stream modification actions in a single atomic operation. + /// + /// Update data streams. + /// Performs one or more data stream modification actions in a single atomic operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ModifyDataStreamAsync(CancellationToken cancellationToken = default) @@ -6002,7 +7573,10 @@ public virtual Task ModifyDataStreamAsync(Cancellation } /// - /// Update data streams.
Performs one or more data stream modification actions in a single atomic operation. + /// + /// Update data streams. + /// Performs one or more data stream modification actions in a single atomic operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ModifyDataStreamAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -6014,7 +7588,10 @@ public virtual Task ModifyDataStreamAsync(Action - /// Opens a closed index.
For data streams, the API opens any closed backing indices. + /// + /// Opens a closed index. + /// For data streams, the API opens any closed backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6025,7 +7602,10 @@ public virtual OpenIndexResponse Open(OpenIndexRequest request) } /// - /// Opens a closed index.
For data streams, the API opens any closed backing indices. + /// + /// Opens a closed index. + /// For data streams, the API opens any closed backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenAsync(OpenIndexRequest request, CancellationToken cancellationToken = default) @@ -6035,7 +7615,10 @@ public virtual Task OpenAsync(OpenIndexRequest request, Cance } /// - /// Opens a closed index.
For data streams, the API opens any closed backing indices. + /// + /// Opens a closed index. + /// For data streams, the API opens any closed backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6046,7 +7629,10 @@ public virtual OpenIndexResponse Open(OpenIndexRequestDescriptor - /// Opens a closed index.
For data streams, the API opens any closed backing indices. + /// + /// Opens a closed index. + /// For data streams, the API opens any closed backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6058,7 +7644,10 @@ public virtual OpenIndexResponse Open(Elastic.Clients.Elasticsearch.I } /// - /// Opens a closed index.
For data streams, the API opens any closed backing indices. + /// + /// Opens a closed index. + /// For data streams, the API opens any closed backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6071,7 +7660,10 @@ public virtual OpenIndexResponse Open(Elastic.Clients.Elasticsearch.I } /// - /// Opens a closed index.
For data streams, the API opens any closed backing indices. + /// + /// Opens a closed index. + /// For data streams, the API opens any closed backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6083,7 +7675,10 @@ public virtual OpenIndexResponse Open() } /// - /// Opens a closed index.
For data streams, the API opens any closed backing indices. + /// + /// Opens a closed index. + /// For data streams, the API opens any closed backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6096,7 +7691,10 @@ public virtual OpenIndexResponse Open(Action - /// Opens a closed index.
For data streams, the API opens any closed backing indices. + /// + /// Opens a closed index. + /// For data streams, the API opens any closed backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6107,7 +7705,10 @@ public virtual OpenIndexResponse Open(OpenIndexRequestDescriptor descriptor) } /// - /// Opens a closed index.
For data streams, the API opens any closed backing indices. + /// + /// Opens a closed index. + /// For data streams, the API opens any closed backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6119,7 +7720,10 @@ public virtual OpenIndexResponse Open(Elastic.Clients.Elasticsearch.Indices indi } /// - /// Opens a closed index.
For data streams, the API opens any closed backing indices. + /// + /// Opens a closed index. + /// For data streams, the API opens any closed backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6132,7 +7736,10 @@ public virtual OpenIndexResponse Open(Elastic.Clients.Elasticsearch.Indices indi } /// - /// Opens a closed index.
For data streams, the API opens any closed backing indices. + /// + /// Opens a closed index. + /// For data streams, the API opens any closed backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenAsync(OpenIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6142,7 +7749,10 @@ public virtual Task OpenAsync(OpenIndexRequestDesc } /// - /// Opens a closed index.
For data streams, the API opens any closed backing indices. + /// + /// Opens a closed index. + /// For data streams, the API opens any closed backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -6153,7 +7763,10 @@ public virtual Task OpenAsync(Elastic.Clients.Elas } /// - /// Opens a closed index.
For data streams, the API opens any closed backing indices. + /// + /// Opens a closed index. + /// For data streams, the API opens any closed backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenAsync(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -6165,7 +7778,10 @@ public virtual Task OpenAsync(Elastic.Clients.Elas } /// - /// Opens a closed index.
For data streams, the API opens any closed backing indices. + /// + /// Opens a closed index. + /// For data streams, the API opens any closed backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenAsync(CancellationToken cancellationToken = default) @@ -6176,7 +7792,10 @@ public virtual Task OpenAsync(CancellationToken ca } /// - /// Opens a closed index.
For data streams, the API opens any closed backing indices. + /// + /// Opens a closed index. + /// For data streams, the API opens any closed backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -6188,7 +7807,10 @@ public virtual Task OpenAsync(Action - /// Opens a closed index.
For data streams, the API opens any closed backing indices. + /// + /// Opens a closed index. + /// For data streams, the API opens any closed backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenAsync(OpenIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6198,7 +7820,10 @@ public virtual Task OpenAsync(OpenIndexRequestDescriptor desc } /// - /// Opens a closed index.
For data streams, the API opens any closed backing indices. + /// + /// Opens a closed index. + /// For data streams, the API opens any closed backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -6209,7 +7834,10 @@ public virtual Task OpenAsync(Elastic.Clients.Elasticsearch.I } /// - /// Opens a closed index.
For data streams, the API opens any closed backing indices. + /// + /// Opens a closed index. + /// For data streams, the API opens any closed backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenAsync(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -6221,7 +7849,9 @@ public virtual Task OpenAsync(Elastic.Clients.Elasticsearch.I } /// - /// Promotes a data stream from a replicated data stream managed by CCR to a regular data stream + /// + /// Promotes a data stream from a replicated data stream managed by CCR to a regular data stream + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6232,7 +7862,9 @@ public virtual PromoteDataStreamResponse PromoteDataStream(PromoteDataStreamRequ } /// - /// Promotes a data stream from a replicated data stream managed by CCR to a regular data stream + /// + /// Promotes a data stream from a replicated data stream managed by CCR to a regular data stream + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PromoteDataStreamAsync(PromoteDataStreamRequest request, CancellationToken cancellationToken = default) @@ -6242,7 +7874,9 @@ public virtual Task PromoteDataStreamAsync(PromoteDat } /// - /// Promotes a data stream from a replicated data stream managed by CCR to a regular data stream + /// + /// Promotes a data stream from a replicated data stream managed by CCR to a regular data stream + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6253,7 +7887,9 @@ public virtual PromoteDataStreamResponse PromoteDataStream(PromoteDataStreamRequ } /// - /// Promotes a data stream from a replicated data stream managed by CCR to a regular data stream + /// + /// Promotes a data stream from a replicated data stream managed by CCR to a regular data stream + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6265,7 +7901,9 @@ public virtual PromoteDataStreamResponse PromoteDataStream(Elastic.Clients.Elast } /// - /// Promotes a data stream from a replicated data stream managed by CCR to a regular data stream + /// + /// Promotes a data stream from a replicated data stream managed by CCR to a regular data stream + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6278,7 +7916,9 @@ public virtual PromoteDataStreamResponse PromoteDataStream(Elastic.Clients.Elast } /// - /// Promotes a data stream from a replicated data stream managed by CCR to a regular data stream + /// + /// Promotes a data stream from a replicated data stream managed by CCR to a regular data stream + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PromoteDataStreamAsync(PromoteDataStreamRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6288,7 +7928,9 @@ public virtual Task PromoteDataStreamAsync(PromoteDat } /// - /// Promotes a data stream from a replicated data stream managed by CCR to a regular data stream + /// + /// Promotes a data stream from a replicated data stream managed by CCR to a regular data stream + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PromoteDataStreamAsync(Elastic.Clients.Elasticsearch.IndexName name, CancellationToken cancellationToken = default) @@ -6299,7 +7941,9 @@ public virtual Task PromoteDataStreamAsync(Elastic.Cl } /// - /// Promotes a data stream from a replicated data stream managed by CCR to a regular data stream + /// + /// Promotes a data stream from a replicated data stream managed by CCR to a regular data stream + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PromoteDataStreamAsync(Elastic.Clients.Elasticsearch.IndexName name, Action configureRequest, CancellationToken cancellationToken = default) @@ -6311,7 +7955,10 @@ public virtual Task PromoteDataStreamAsync(Elastic.Cl } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6322,7 +7969,10 @@ public virtual PutAliasResponse PutAlias(PutAliasRequest request) } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAliasAsync(PutAliasRequest request, CancellationToken cancellationToken = default) @@ -6332,7 +7982,10 @@ public virtual Task PutAliasAsync(PutAliasRequest request, Can } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6343,7 +7996,10 @@ public virtual PutAliasResponse PutAlias(PutAliasRequestDescriptor - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6355,7 +8011,10 @@ public virtual PutAliasResponse PutAlias(Elastic.Clients.Elasticsearc } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6368,7 +8027,10 @@ public virtual PutAliasResponse PutAlias(Elastic.Clients.Elasticsearc } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6380,7 +8042,10 @@ public virtual PutAliasResponse PutAlias(Elastic.Clients.Elasticsearc } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6393,7 +8058,10 @@ public virtual PutAliasResponse PutAlias(Elastic.Clients.Elasticsearc } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6404,7 +8072,10 @@ public virtual PutAliasResponse PutAlias(PutAliasRequestDescriptor descriptor) } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6416,7 +8087,10 @@ public virtual PutAliasResponse PutAlias(Elastic.Clients.Elasticsearch.Indices i } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6429,7 +8103,10 @@ public virtual PutAliasResponse PutAlias(Elastic.Clients.Elasticsearch.Indices i } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAliasAsync(PutAliasRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6439,7 +8116,10 @@ public virtual Task PutAliasAsync(PutAliasRequestDe } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAliasAsync(Elastic.Clients.Elasticsearch.Indices indices, Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) @@ -6450,7 +8130,10 @@ public virtual Task PutAliasAsync(Elastic.Clients.E } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAliasAsync(Elastic.Clients.Elasticsearch.Indices indices, Elastic.Clients.Elasticsearch.Name name, Action> configureRequest, CancellationToken cancellationToken = default) @@ -6462,7 +8145,10 @@ public virtual Task PutAliasAsync(Elastic.Clients.E } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAliasAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) @@ -6473,7 +8159,10 @@ public virtual Task PutAliasAsync(Elastic.Clients.E } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAliasAsync(Elastic.Clients.Elasticsearch.Name name, Action> configureRequest, CancellationToken cancellationToken = default) @@ -6485,7 +8174,10 @@ public virtual Task PutAliasAsync(Elastic.Clients.E } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAliasAsync(PutAliasRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6495,7 +8187,10 @@ public virtual Task PutAliasAsync(PutAliasRequestDescriptor de } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAliasAsync(Elastic.Clients.Elasticsearch.Indices indices, Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) @@ -6506,7 +8201,10 @@ public virtual Task PutAliasAsync(Elastic.Clients.Elasticsearc } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAliasAsync(Elastic.Clients.Elasticsearch.Indices indices, Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -6518,7 +8216,10 @@ public virtual Task PutAliasAsync(Elastic.Clients.Elasticsearc } /// - /// Update data stream lifecycles.
Update the data stream lifecycle of the specified data streams. + /// + /// Update data stream lifecycles. + /// Update the data stream lifecycle of the specified data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6529,7 +8230,10 @@ public virtual PutDataLifecycleResponse PutDataLifecycle(PutDataLifecycleRequest } /// - /// Update data stream lifecycles.
Update the data stream lifecycle of the specified data streams. + /// + /// Update data stream lifecycles. + /// Update the data stream lifecycle of the specified data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataLifecycleAsync(PutDataLifecycleRequest request, CancellationToken cancellationToken = default) @@ -6539,7 +8243,10 @@ public virtual Task PutDataLifecycleAsync(PutDataLifec } /// - /// Update data stream lifecycles.
Update the data stream lifecycle of the specified data streams. + /// + /// Update data stream lifecycles. + /// Update the data stream lifecycle of the specified data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6550,7 +8257,10 @@ public virtual PutDataLifecycleResponse PutDataLifecycle(PutDataLifecycleRequest } /// - /// Update data stream lifecycles.
Update the data stream lifecycle of the specified data streams. + /// + /// Update data stream lifecycles. + /// Update the data stream lifecycle of the specified data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6562,7 +8272,10 @@ public virtual PutDataLifecycleResponse PutDataLifecycle(Elastic.Clients.Elastic } /// - /// Update data stream lifecycles.
Update the data stream lifecycle of the specified data streams. + /// + /// Update data stream lifecycles. + /// Update the data stream lifecycle of the specified data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6575,7 +8288,10 @@ public virtual PutDataLifecycleResponse PutDataLifecycle(Elastic.Clients.Elastic } /// - /// Update data stream lifecycles.
Update the data stream lifecycle of the specified data streams. + /// + /// Update data stream lifecycles. + /// Update the data stream lifecycle of the specified data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataLifecycleAsync(PutDataLifecycleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6585,7 +8301,10 @@ public virtual Task PutDataLifecycleAsync(PutDataLifec } /// - /// Update data stream lifecycles.
Update the data stream lifecycle of the specified data streams. + /// + /// Update data stream lifecycles. + /// Update the data stream lifecycle of the specified data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataLifecycleAsync(Elastic.Clients.Elasticsearch.DataStreamNames name, CancellationToken cancellationToken = default) @@ -6596,7 +8315,10 @@ public virtual Task PutDataLifecycleAsync(Elastic.Clie } /// - /// Update data stream lifecycles.
Update the data stream lifecycle of the specified data streams. + /// + /// Update data stream lifecycles. + /// Update the data stream lifecycle of the specified data streams. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataLifecycleAsync(Elastic.Clients.Elasticsearch.DataStreamNames name, Action configureRequest, CancellationToken cancellationToken = default) @@ -6608,7 +8330,10 @@ public virtual Task PutDataLifecycleAsync(Elastic.Clie } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6619,7 +8344,10 @@ public virtual PutIndexTemplateResponse PutIndexTemplate(PutIndexTemplateRequest } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutIndexTemplateAsync(PutIndexTemplateRequest request, CancellationToken cancellationToken = default) @@ -6629,7 +8357,10 @@ public virtual Task PutIndexTemplateAsync(PutIndexTemp } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6640,7 +8371,10 @@ public virtual PutIndexTemplateResponse PutIndexTemplate(PutIndexTemp } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6652,7 +8386,10 @@ public virtual PutIndexTemplateResponse PutIndexTemplate(Elastic.Clie } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6665,7 +8402,10 @@ public virtual PutIndexTemplateResponse PutIndexTemplate(Elastic.Clie } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6676,7 +8416,10 @@ public virtual PutIndexTemplateResponse PutIndexTemplate(PutIndexTemplateRequest } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6688,7 +8431,10 @@ public virtual PutIndexTemplateResponse PutIndexTemplate(Elastic.Clients.Elastic } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6701,7 +8447,10 @@ public virtual PutIndexTemplateResponse PutIndexTemplate(Elastic.Clients.Elastic } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutIndexTemplateAsync(PutIndexTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6711,7 +8460,10 @@ public virtual Task PutIndexTemplateAsync(P } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutIndexTemplateAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) @@ -6722,7 +8474,10 @@ public virtual Task PutIndexTemplateAsync(E } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutIndexTemplateAsync(Elastic.Clients.Elasticsearch.Name name, Action> configureRequest, CancellationToken cancellationToken = default) @@ -6734,7 +8489,10 @@ public virtual Task PutIndexTemplateAsync(E } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutIndexTemplateAsync(PutIndexTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6744,7 +8502,10 @@ public virtual Task PutIndexTemplateAsync(PutIndexTemp } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutIndexTemplateAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) @@ -6755,7 +8516,10 @@ public virtual Task PutIndexTemplateAsync(Elastic.Clie } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutIndexTemplateAsync(Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -6767,7 +8531,12 @@ public virtual Task PutIndexTemplateAsync(Elastic.Clie } /// - /// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. + /// + /// Update field mappings. + /// Adds new fields to an existing data stream or index. + /// You can also use this API to change the search settings of existing fields. + /// For data streams, these changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6778,7 +8547,12 @@ public virtual PutMappingResponse PutMapping(PutMappingRequest request) } /// - /// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. + /// + /// Update field mappings. + /// Adds new fields to an existing data stream or index. + /// You can also use this API to change the search settings of existing fields. + /// For data streams, these changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutMappingAsync(PutMappingRequest request, CancellationToken cancellationToken = default) @@ -6788,7 +8562,12 @@ public virtual Task PutMappingAsync(PutMappingRequest reques } /// - /// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. + /// + /// Update field mappings. + /// Adds new fields to an existing data stream or index. + /// You can also use this API to change the search settings of existing fields. + /// For data streams, these changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6799,7 +8578,12 @@ public virtual PutMappingResponse PutMapping(PutMappingRequestDescrip } /// - /// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. + /// + /// Update field mappings. + /// Adds new fields to an existing data stream or index. + /// You can also use this API to change the search settings of existing fields. + /// For data streams, these changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6811,7 +8595,12 @@ public virtual PutMappingResponse PutMapping(Elastic.Clients.Elastics } /// - /// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. + /// + /// Update field mappings. + /// Adds new fields to an existing data stream or index. + /// You can also use this API to change the search settings of existing fields. + /// For data streams, these changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6824,7 +8613,12 @@ public virtual PutMappingResponse PutMapping(Elastic.Clients.Elastics } /// - /// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. + /// + /// Update field mappings. + /// Adds new fields to an existing data stream or index. + /// You can also use this API to change the search settings of existing fields. + /// For data streams, these changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6836,7 +8630,12 @@ public virtual PutMappingResponse PutMapping() } /// - /// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. + /// + /// Update field mappings. + /// Adds new fields to an existing data stream or index. + /// You can also use this API to change the search settings of existing fields. + /// For data streams, these changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6849,7 +8648,12 @@ public virtual PutMappingResponse PutMapping(Action - /// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. + /// + /// Update field mappings. + /// Adds new fields to an existing data stream or index. + /// You can also use this API to change the search settings of existing fields. + /// For data streams, these changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6860,7 +8664,12 @@ public virtual PutMappingResponse PutMapping(PutMappingRequestDescriptor descrip } /// - /// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. + /// + /// Update field mappings. + /// Adds new fields to an existing data stream or index. + /// You can also use this API to change the search settings of existing fields. + /// For data streams, these changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6872,7 +8681,12 @@ public virtual PutMappingResponse PutMapping(Elastic.Clients.Elasticsearch.Indic } /// - /// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. + /// + /// Update field mappings. + /// Adds new fields to an existing data stream or index. + /// You can also use this API to change the search settings of existing fields. + /// For data streams, these changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6885,7 +8699,12 @@ public virtual PutMappingResponse PutMapping(Elastic.Clients.Elasticsearch.Indic } /// - /// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. + /// + /// Update field mappings. + /// Adds new fields to an existing data stream or index. + /// You can also use this API to change the search settings of existing fields. + /// For data streams, these changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutMappingAsync(PutMappingRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6895,7 +8714,12 @@ public virtual Task PutMappingAsync(PutMappingReq } /// - /// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. + /// + /// Update field mappings. + /// Adds new fields to an existing data stream or index. + /// You can also use this API to change the search settings of existing fields. + /// For data streams, these changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutMappingAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -6906,7 +8730,12 @@ public virtual Task PutMappingAsync(Elastic.Clien } /// - /// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. + /// + /// Update field mappings. + /// Adds new fields to an existing data stream or index. + /// You can also use this API to change the search settings of existing fields. + /// For data streams, these changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutMappingAsync(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -6918,7 +8747,12 @@ public virtual Task PutMappingAsync(Elastic.Clien } /// - /// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. + /// + /// Update field mappings. + /// Adds new fields to an existing data stream or index. + /// You can also use this API to change the search settings of existing fields. + /// For data streams, these changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutMappingAsync(CancellationToken cancellationToken = default) @@ -6929,7 +8763,12 @@ public virtual Task PutMappingAsync(CancellationT } /// - /// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. + /// + /// Update field mappings. + /// Adds new fields to an existing data stream or index. + /// You can also use this API to change the search settings of existing fields. + /// For data streams, these changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutMappingAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -6941,7 +8780,12 @@ public virtual Task PutMappingAsync(Action - /// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. + /// + /// Update field mappings. + /// Adds new fields to an existing data stream or index. + /// You can also use this API to change the search settings of existing fields. + /// For data streams, these changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutMappingAsync(PutMappingRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6951,7 +8795,12 @@ public virtual Task PutMappingAsync(PutMappingRequestDescrip } /// - /// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. + /// + /// Update field mappings. + /// Adds new fields to an existing data stream or index. + /// You can also use this API to change the search settings of existing fields. + /// For data streams, these changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutMappingAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -6962,7 +8811,12 @@ public virtual Task PutMappingAsync(Elastic.Clients.Elastics } /// - /// Update field mappings.
Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. + /// + /// Update field mappings. + /// Adds new fields to an existing data stream or index. + /// You can also use this API to change the search settings of existing fields. + /// For data streams, these changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutMappingAsync(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -6974,7 +8828,11 @@ public virtual Task PutMappingAsync(Elastic.Clients.Elastics } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6985,7 +8843,11 @@ public virtual PutIndicesSettingsResponse PutSettings(PutIndicesSettingsRequest } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSettingsAsync(PutIndicesSettingsRequest request, CancellationToken cancellationToken = default) @@ -6995,7 +8857,11 @@ public virtual Task PutSettingsAsync(PutIndicesSetti } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7006,7 +8872,11 @@ public virtual PutIndicesSettingsResponse PutSettings(PutIndicesSetti } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7018,7 +8888,11 @@ public virtual PutIndicesSettingsResponse PutSettings(Elastic.Clients } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7031,7 +8905,11 @@ public virtual PutIndicesSettingsResponse PutSettings(Elastic.Clients } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7043,7 +8921,11 @@ public virtual PutIndicesSettingsResponse PutSettings(Elastic.Clients } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7056,7 +8938,11 @@ public virtual PutIndicesSettingsResponse PutSettings(Elastic.Clients } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7067,7 +8953,11 @@ public virtual PutIndicesSettingsResponse PutSettings(PutIndicesSettingsRequestD } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7079,7 +8969,11 @@ public virtual PutIndicesSettingsResponse PutSettings(Elastic.Clients.Elasticsea } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7092,7 +8986,11 @@ public virtual PutIndicesSettingsResponse PutSettings(Elastic.Clients.Elasticsea } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7104,7 +9002,11 @@ public virtual PutIndicesSettingsResponse PutSettings(Elastic.Clients.Elasticsea } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7117,7 +9019,11 @@ public virtual PutIndicesSettingsResponse PutSettings(Elastic.Clients.Elasticsea } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSettingsAsync(PutIndicesSettingsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -7127,7 +9033,11 @@ public virtual Task PutSettingsAsync(PutI } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSettingsAsync(Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings settings, Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -7138,7 +9048,11 @@ public virtual Task PutSettingsAsync(Elas } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSettingsAsync(Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings settings, Elastic.Clients.Elasticsearch.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -7150,7 +9064,11 @@ public virtual Task PutSettingsAsync(Elas } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSettingsAsync(Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings settings, CancellationToken cancellationToken = default) @@ -7161,7 +9079,11 @@ public virtual Task PutSettingsAsync(Elas } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSettingsAsync(Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings settings, Action> configureRequest, CancellationToken cancellationToken = default) @@ -7173,7 +9095,11 @@ public virtual Task PutSettingsAsync(Elas } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSettingsAsync(PutIndicesSettingsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -7183,7 +9109,11 @@ public virtual Task PutSettingsAsync(PutIndicesSetti } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSettingsAsync(Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings settings, Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -7194,7 +9124,11 @@ public virtual Task PutSettingsAsync(Elastic.Clients } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSettingsAsync(Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings settings, Elastic.Clients.Elasticsearch.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -7206,7 +9140,11 @@ public virtual Task PutSettingsAsync(Elastic.Clients } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSettingsAsync(Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings settings, CancellationToken cancellationToken = default) @@ -7217,7 +9155,11 @@ public virtual Task PutSettingsAsync(Elastic.Clients } /// - /// Update index settings.
Changes dynamic index settings in real time. For data streams, index setting
changes are applied to all backing indices by default. + /// + /// Update index settings. + /// Changes dynamic index settings in real time. For data streams, index setting + /// changes are applied to all backing indices by default. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSettingsAsync(Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings settings, Action configureRequest, CancellationToken cancellationToken = default) @@ -7229,7 +9171,10 @@ public virtual Task PutSettingsAsync(Elastic.Clients } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7240,7 +9185,10 @@ public virtual PutTemplateResponse PutTemplate(PutTemplateRequest request) } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTemplateAsync(PutTemplateRequest request, CancellationToken cancellationToken = default) @@ -7250,7 +9198,10 @@ public virtual Task PutTemplateAsync(PutTemplateRequest req } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7261,7 +9212,10 @@ public virtual PutTemplateResponse PutTemplate(PutTemplateRequestDesc } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7273,7 +9227,10 @@ public virtual PutTemplateResponse PutTemplate(Elastic.Clients.Elasti } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7286,7 +9243,10 @@ public virtual PutTemplateResponse PutTemplate(Elastic.Clients.Elasti } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7297,7 +9257,10 @@ public virtual PutTemplateResponse PutTemplate(PutTemplateRequestDescriptor desc } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7309,7 +9272,10 @@ public virtual PutTemplateResponse PutTemplate(Elastic.Clients.Elasticsearch.Nam } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7322,7 +9288,10 @@ public virtual PutTemplateResponse PutTemplate(Elastic.Clients.Elasticsearch.Nam } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTemplateAsync(PutTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -7332,7 +9301,10 @@ public virtual Task PutTemplateAsync(PutTemplate } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTemplateAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) @@ -7343,7 +9315,10 @@ public virtual Task PutTemplateAsync(Elastic.Cli } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTemplateAsync(Elastic.Clients.Elasticsearch.Name name, Action> configureRequest, CancellationToken cancellationToken = default) @@ -7355,7 +9330,10 @@ public virtual Task PutTemplateAsync(Elastic.Cli } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTemplateAsync(PutTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -7365,7 +9343,10 @@ public virtual Task PutTemplateAsync(PutTemplateRequestDesc } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTemplateAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) @@ -7376,7 +9357,10 @@ public virtual Task PutTemplateAsync(Elastic.Clients.Elasti } /// - /// Create or update an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// + /// Create or update an index template. + /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTemplateAsync(Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -7388,7 +9372,10 @@ public virtual Task PutTemplateAsync(Elastic.Clients.Elasti } /// - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7399,7 +9386,10 @@ public virtual RecoveryResponse Recovery(RecoveryRequest request) } /// - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RecoveryAsync(RecoveryRequest request, CancellationToken cancellationToken = default) @@ -7409,7 +9399,10 @@ public virtual Task RecoveryAsync(RecoveryRequest request, Can } /// - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7420,7 +9413,10 @@ public virtual RecoveryResponse Recovery(RecoveryRequestDescriptor - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7432,7 +9428,10 @@ public virtual RecoveryResponse Recovery(Elastic.Clients.Elasticsearc } /// - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7445,7 +9444,10 @@ public virtual RecoveryResponse Recovery(Elastic.Clients.Elasticsearc } /// - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7457,7 +9459,10 @@ public virtual RecoveryResponse Recovery() } /// - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7470,7 +9475,10 @@ public virtual RecoveryResponse Recovery(Action - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7481,7 +9489,10 @@ public virtual RecoveryResponse Recovery(RecoveryRequestDescriptor descriptor) } /// - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7493,7 +9504,10 @@ public virtual RecoveryResponse Recovery(Elastic.Clients.Elasticsearch.Indices? } /// - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7506,7 +9520,10 @@ public virtual RecoveryResponse Recovery(Elastic.Clients.Elasticsearch.Indices? } /// - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7518,7 +9535,10 @@ public virtual RecoveryResponse Recovery() } /// - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7531,7 +9551,10 @@ public virtual RecoveryResponse Recovery(Action confi } /// - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RecoveryAsync(RecoveryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -7541,7 +9564,10 @@ public virtual Task RecoveryAsync(RecoveryRequestDe } /// - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RecoveryAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -7552,7 +9578,10 @@ public virtual Task RecoveryAsync(Elastic.Clients.E } /// - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RecoveryAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -7564,7 +9593,10 @@ public virtual Task RecoveryAsync(Elastic.Clients.E } /// - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RecoveryAsync(CancellationToken cancellationToken = default) @@ -7575,7 +9607,10 @@ public virtual Task RecoveryAsync(CancellationToken } /// - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RecoveryAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -7587,7 +9622,10 @@ public virtual Task RecoveryAsync(Action - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RecoveryAsync(RecoveryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -7597,7 +9635,10 @@ public virtual Task RecoveryAsync(RecoveryRequestDescriptor de } /// - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RecoveryAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -7608,7 +9649,10 @@ public virtual Task RecoveryAsync(Elastic.Clients.Elasticsearc } /// - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RecoveryAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -7620,7 +9664,10 @@ public virtual Task RecoveryAsync(Elastic.Clients.Elasticsearc } /// - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RecoveryAsync(CancellationToken cancellationToken = default) @@ -7631,7 +9678,10 @@ public virtual Task RecoveryAsync(CancellationToken cancellati } /// - /// Returns information about ongoing and completed shard recoveries for one or more indices.
For data streams, the API returns information for the stream’s backing indices. + /// + /// Returns information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RecoveryAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -7643,7 +9693,11 @@ public virtual Task RecoveryAsync(Action - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7654,7 +9708,11 @@ public virtual RefreshResponse Refresh(RefreshRequest request) } /// - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RefreshAsync(RefreshRequest request, CancellationToken cancellationToken = default) @@ -7664,7 +9722,11 @@ public virtual Task RefreshAsync(RefreshRequest request, Cancel } /// - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7675,7 +9737,11 @@ public virtual RefreshResponse Refresh(RefreshRequestDescriptor - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7687,7 +9753,11 @@ public virtual RefreshResponse Refresh(Elastic.Clients.Elasticsearch. } /// - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7700,7 +9770,11 @@ public virtual RefreshResponse Refresh(Elastic.Clients.Elasticsearch. } /// - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7712,7 +9786,11 @@ public virtual RefreshResponse Refresh() } /// - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7725,7 +9803,11 @@ public virtual RefreshResponse Refresh(Action - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7736,7 +9818,11 @@ public virtual RefreshResponse Refresh(RefreshRequestDescriptor descriptor) } /// - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7748,7 +9834,11 @@ public virtual RefreshResponse Refresh(Elastic.Clients.Elasticsearch.Indices? in } /// - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7761,7 +9851,11 @@ public virtual RefreshResponse Refresh(Elastic.Clients.Elasticsearch.Indices? in } /// - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7773,7 +9867,11 @@ public virtual RefreshResponse Refresh() } /// - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7786,7 +9884,11 @@ public virtual RefreshResponse Refresh(Action configur } /// - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RefreshAsync(RefreshRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -7796,7 +9898,11 @@ public virtual Task RefreshAsync(RefreshRequestDescr } /// - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RefreshAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -7807,7 +9913,11 @@ public virtual Task RefreshAsync(Elastic.Clients.Ela } /// - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RefreshAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -7819,7 +9929,11 @@ public virtual Task RefreshAsync(Elastic.Clients.Ela } /// - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RefreshAsync(CancellationToken cancellationToken = default) @@ -7830,7 +9944,11 @@ public virtual Task RefreshAsync(CancellationToken c } /// - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RefreshAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -7842,7 +9960,11 @@ public virtual Task RefreshAsync(Action - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RefreshAsync(RefreshRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -7852,7 +9974,11 @@ public virtual Task RefreshAsync(RefreshRequestDescriptor descr } /// - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RefreshAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -7863,7 +9989,11 @@ public virtual Task RefreshAsync(Elastic.Clients.Elasticsearch. } /// - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RefreshAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -7875,7 +10005,11 @@ public virtual Task RefreshAsync(Elastic.Clients.Elasticsearch. } /// - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RefreshAsync(CancellationToken cancellationToken = default) @@ -7886,7 +10020,11 @@ public virtual Task RefreshAsync(CancellationToken cancellation } /// - /// Refresh an index.
A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. + /// + /// Refresh an index. + /// A refresh makes recent operations performed on one or more indices available for search. + /// For data streams, the API runs the refresh operation on the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RefreshAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -7898,7 +10036,9 @@ public virtual Task RefreshAsync(Action - /// Reloads an index's search analyzers and their resources. + /// + /// Reloads an index's search analyzers and their resources. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7909,7 +10049,9 @@ public virtual ReloadSearchAnalyzersResponse ReloadSearchAnalyzers(ReloadSearchA } /// - /// Reloads an index's search analyzers and their resources. + /// + /// Reloads an index's search analyzers and their resources. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReloadSearchAnalyzersAsync(ReloadSearchAnalyzersRequest request, CancellationToken cancellationToken = default) @@ -7919,7 +10061,9 @@ public virtual Task ReloadSearchAnalyzersAsync(Re } /// - /// Reloads an index's search analyzers and their resources. + /// + /// Reloads an index's search analyzers and their resources. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7930,7 +10074,9 @@ public virtual ReloadSearchAnalyzersResponse ReloadSearchAnalyzers(Re } /// - /// Reloads an index's search analyzers and their resources. + /// + /// Reloads an index's search analyzers and their resources. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7942,7 +10088,9 @@ public virtual ReloadSearchAnalyzersResponse ReloadSearchAnalyzers(El } /// - /// Reloads an index's search analyzers and their resources. + /// + /// Reloads an index's search analyzers and their resources. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7955,7 +10103,9 @@ public virtual ReloadSearchAnalyzersResponse ReloadSearchAnalyzers(El } /// - /// Reloads an index's search analyzers and their resources. + /// + /// Reloads an index's search analyzers and their resources. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7967,7 +10117,9 @@ public virtual ReloadSearchAnalyzersResponse ReloadSearchAnalyzers() } /// - /// Reloads an index's search analyzers and their resources. + /// + /// Reloads an index's search analyzers and their resources. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7980,7 +10132,9 @@ public virtual ReloadSearchAnalyzersResponse ReloadSearchAnalyzers(Ac } /// - /// Reloads an index's search analyzers and their resources. + /// + /// Reloads an index's search analyzers and their resources. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7991,7 +10145,9 @@ public virtual ReloadSearchAnalyzersResponse ReloadSearchAnalyzers(ReloadSearchA } /// - /// Reloads an index's search analyzers and their resources. + /// + /// Reloads an index's search analyzers and their resources. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8003,7 +10159,9 @@ public virtual ReloadSearchAnalyzersResponse ReloadSearchAnalyzers(Elastic.Clien } /// - /// Reloads an index's search analyzers and their resources. + /// + /// Reloads an index's search analyzers and their resources. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8016,7 +10174,9 @@ public virtual ReloadSearchAnalyzersResponse ReloadSearchAnalyzers(Elastic.Clien } /// - /// Reloads an index's search analyzers and their resources. + /// + /// Reloads an index's search analyzers and their resources. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReloadSearchAnalyzersAsync(ReloadSearchAnalyzersRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -8026,7 +10186,9 @@ public virtual Task ReloadSearchAnalyzersAsync - /// Reloads an index's search analyzers and their resources. + /// + /// Reloads an index's search analyzers and their resources. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReloadSearchAnalyzersAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -8037,7 +10199,9 @@ public virtual Task ReloadSearchAnalyzersAsync - /// Reloads an index's search analyzers and their resources. + /// + /// Reloads an index's search analyzers and their resources. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReloadSearchAnalyzersAsync(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -8049,7 +10213,9 @@ public virtual Task ReloadSearchAnalyzersAsync - /// Reloads an index's search analyzers and their resources. + /// + /// Reloads an index's search analyzers and their resources. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReloadSearchAnalyzersAsync(CancellationToken cancellationToken = default) @@ -8060,7 +10226,9 @@ public virtual Task ReloadSearchAnalyzersAsync - /// Reloads an index's search analyzers and their resources. + /// + /// Reloads an index's search analyzers and their resources. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReloadSearchAnalyzersAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -8072,7 +10240,9 @@ public virtual Task ReloadSearchAnalyzersAsync - /// Reloads an index's search analyzers and their resources. + /// + /// Reloads an index's search analyzers and their resources. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReloadSearchAnalyzersAsync(ReloadSearchAnalyzersRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -8082,7 +10252,9 @@ public virtual Task ReloadSearchAnalyzersAsync(Re } /// - /// Reloads an index's search analyzers and their resources. + /// + /// Reloads an index's search analyzers and their resources. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReloadSearchAnalyzersAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -8093,7 +10265,9 @@ public virtual Task ReloadSearchAnalyzersAsync(El } /// - /// Reloads an index's search analyzers and their resources. + /// + /// Reloads an index's search analyzers and their resources. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReloadSearchAnalyzersAsync(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -8105,7 +10279,11 @@ public virtual Task ReloadSearchAnalyzersAsync(El } /// - /// Resolves the specified index expressions to return information about each cluster, including
the local cluster, if included.
Multiple patterns and remote clusters are supported. + /// + /// Resolves the specified index expressions to return information about each cluster, including + /// the local cluster, if included. + /// Multiple patterns and remote clusters are supported. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8116,7 +10294,11 @@ public virtual ResolveClusterResponse ResolveCluster(ResolveClusterRequest reque } /// - /// Resolves the specified index expressions to return information about each cluster, including
the local cluster, if included.
Multiple patterns and remote clusters are supported. + /// + /// Resolves the specified index expressions to return information about each cluster, including + /// the local cluster, if included. + /// Multiple patterns and remote clusters are supported. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResolveClusterAsync(ResolveClusterRequest request, CancellationToken cancellationToken = default) @@ -8126,7 +10308,11 @@ public virtual Task ResolveClusterAsync(ResolveClusterRe } /// - /// Resolves the specified index expressions to return information about each cluster, including
the local cluster, if included.
Multiple patterns and remote clusters are supported. + /// + /// Resolves the specified index expressions to return information about each cluster, including + /// the local cluster, if included. + /// Multiple patterns and remote clusters are supported. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8137,7 +10323,11 @@ public virtual ResolveClusterResponse ResolveCluster(ResolveClusterRequestDescri } /// - /// Resolves the specified index expressions to return information about each cluster, including
the local cluster, if included.
Multiple patterns and remote clusters are supported. + /// + /// Resolves the specified index expressions to return information about each cluster, including + /// the local cluster, if included. + /// Multiple patterns and remote clusters are supported. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8149,7 +10339,11 @@ public virtual ResolveClusterResponse ResolveCluster(Elastic.Clients.Elasticsear } /// - /// Resolves the specified index expressions to return information about each cluster, including
the local cluster, if included.
Multiple patterns and remote clusters are supported. + /// + /// Resolves the specified index expressions to return information about each cluster, including + /// the local cluster, if included. + /// Multiple patterns and remote clusters are supported. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8162,7 +10356,11 @@ public virtual ResolveClusterResponse ResolveCluster(Elastic.Clients.Elasticsear } /// - /// Resolves the specified index expressions to return information about each cluster, including
the local cluster, if included.
Multiple patterns and remote clusters are supported. + /// + /// Resolves the specified index expressions to return information about each cluster, including + /// the local cluster, if included. + /// Multiple patterns and remote clusters are supported. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResolveClusterAsync(ResolveClusterRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -8172,7 +10370,11 @@ public virtual Task ResolveClusterAsync(ResolveClusterRe } /// - /// Resolves the specified index expressions to return information about each cluster, including
the local cluster, if included.
Multiple patterns and remote clusters are supported. + /// + /// Resolves the specified index expressions to return information about each cluster, including + /// the local cluster, if included. + /// Multiple patterns and remote clusters are supported. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResolveClusterAsync(Elastic.Clients.Elasticsearch.Names name, CancellationToken cancellationToken = default) @@ -8183,7 +10385,11 @@ public virtual Task ResolveClusterAsync(Elastic.Clients. } /// - /// Resolves the specified index expressions to return information about each cluster, including
the local cluster, if included.
Multiple patterns and remote clusters are supported. + /// + /// Resolves the specified index expressions to return information about each cluster, including + /// the local cluster, if included. + /// Multiple patterns and remote clusters are supported. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResolveClusterAsync(Elastic.Clients.Elasticsearch.Names name, Action configureRequest, CancellationToken cancellationToken = default) @@ -8195,7 +10401,10 @@ public virtual Task ResolveClusterAsync(Elastic.Clients. } /// - /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams.
Multiple patterns and remote clusters are supported. + /// + /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. + /// Multiple patterns and remote clusters are supported. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8206,7 +10415,10 @@ public virtual ResolveIndexResponse ResolveIndex(ResolveIndexRequest request) } /// - /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams.
Multiple patterns and remote clusters are supported. + /// + /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. + /// Multiple patterns and remote clusters are supported. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResolveIndexAsync(ResolveIndexRequest request, CancellationToken cancellationToken = default) @@ -8216,7 +10428,10 @@ public virtual Task ResolveIndexAsync(ResolveIndexRequest } /// - /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams.
Multiple patterns and remote clusters are supported. + /// + /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. + /// Multiple patterns and remote clusters are supported. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8227,7 +10442,10 @@ public virtual ResolveIndexResponse ResolveIndex(ResolveIndexRequestDescriptor d } /// - /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams.
Multiple patterns and remote clusters are supported. + /// + /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. + /// Multiple patterns and remote clusters are supported. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8239,7 +10457,10 @@ public virtual ResolveIndexResponse ResolveIndex(Elastic.Clients.Elasticsearch.N } /// - /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams.
Multiple patterns and remote clusters are supported. + /// + /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. + /// Multiple patterns and remote clusters are supported. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8252,7 +10473,10 @@ public virtual ResolveIndexResponse ResolveIndex(Elastic.Clients.Elasticsearch.N } /// - /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams.
Multiple patterns and remote clusters are supported. + /// + /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. + /// Multiple patterns and remote clusters are supported. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResolveIndexAsync(ResolveIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -8262,7 +10486,10 @@ public virtual Task ResolveIndexAsync(ResolveIndexRequestD } /// - /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams.
Multiple patterns and remote clusters are supported. + /// + /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. + /// Multiple patterns and remote clusters are supported. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResolveIndexAsync(Elastic.Clients.Elasticsearch.Names name, CancellationToken cancellationToken = default) @@ -8273,7 +10500,10 @@ public virtual Task ResolveIndexAsync(Elastic.Clients.Elas } /// - /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams.
Multiple patterns and remote clusters are supported. + /// + /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. + /// Multiple patterns and remote clusters are supported. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResolveIndexAsync(Elastic.Clients.Elasticsearch.Names name, Action configureRequest, CancellationToken cancellationToken = default) @@ -8285,7 +10515,10 @@ public virtual Task ResolveIndexAsync(Elastic.Clients.Elas } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8296,7 +10529,10 @@ public virtual RolloverResponse Rollover(RolloverRequest request) } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(RolloverRequest request, CancellationToken cancellationToken = default) @@ -8306,7 +10542,10 @@ public virtual Task RolloverAsync(RolloverRequest request, Can } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8317,7 +10556,10 @@ public virtual RolloverResponse Rollover(RolloverRequestDescriptor - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8329,7 +10571,10 @@ public virtual RolloverResponse Rollover(Elastic.Clients.Elasticsearc } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8342,7 +10587,10 @@ public virtual RolloverResponse Rollover(Elastic.Clients.Elasticsearc } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8354,7 +10602,10 @@ public virtual RolloverResponse Rollover(Elastic.Clients.Elasticsearc } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8367,7 +10618,10 @@ public virtual RolloverResponse Rollover(Elastic.Clients.Elasticsearc } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8378,7 +10632,10 @@ public virtual RolloverResponse Rollover(RolloverRequestDescriptor descriptor) } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8390,7 +10647,10 @@ public virtual RolloverResponse Rollover(Elastic.Clients.Elasticsearch.IndexAlia } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8403,7 +10663,10 @@ public virtual RolloverResponse Rollover(Elastic.Clients.Elasticsearch.IndexAlia } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8415,7 +10678,10 @@ public virtual RolloverResponse Rollover(Elastic.Clients.Elasticsearch.IndexAlia } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8428,7 +10694,10 @@ public virtual RolloverResponse Rollover(Elastic.Clients.Elasticsearch.IndexAlia } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(RolloverRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -8438,7 +10707,10 @@ public virtual Task RolloverAsync(RolloverRequestDe } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.IndexAlias alias, Elastic.Clients.Elasticsearch.IndexName? newIndex, CancellationToken cancellationToken = default) @@ -8449,7 +10721,10 @@ public virtual Task RolloverAsync(Elastic.Clients.E } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.IndexAlias alias, Elastic.Clients.Elasticsearch.IndexName? newIndex, Action> configureRequest, CancellationToken cancellationToken = default) @@ -8461,7 +10736,10 @@ public virtual Task RolloverAsync(Elastic.Clients.E } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.IndexAlias alias, CancellationToken cancellationToken = default) @@ -8472,7 +10750,10 @@ public virtual Task RolloverAsync(Elastic.Clients.E } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.IndexAlias alias, Action> configureRequest, CancellationToken cancellationToken = default) @@ -8484,7 +10765,10 @@ public virtual Task RolloverAsync(Elastic.Clients.E } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(RolloverRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -8494,7 +10778,10 @@ public virtual Task RolloverAsync(RolloverRequestDescriptor de } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.IndexAlias alias, Elastic.Clients.Elasticsearch.IndexName? newIndex, CancellationToken cancellationToken = default) @@ -8505,7 +10792,10 @@ public virtual Task RolloverAsync(Elastic.Clients.Elasticsearc } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.IndexAlias alias, Elastic.Clients.Elasticsearch.IndexName? newIndex, Action configureRequest, CancellationToken cancellationToken = default) @@ -8517,7 +10807,10 @@ public virtual Task RolloverAsync(Elastic.Clients.Elasticsearc } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.IndexAlias alias, CancellationToken cancellationToken = default) @@ -8528,7 +10821,10 @@ public virtual Task RolloverAsync(Elastic.Clients.Elasticsearc } /// - /// Roll over to a new index.
Creates a new index for a data stream or index alias. + /// + /// Roll over to a new index. + /// Creates a new index for a data stream or index alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.IndexAlias alias, Action configureRequest, CancellationToken cancellationToken = default) @@ -8540,7 +10836,10 @@ public virtual Task RolloverAsync(Elastic.Clients.Elasticsearc } /// - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8551,7 +10850,10 @@ public virtual SegmentsResponse Segments(SegmentsRequest request) } /// - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SegmentsAsync(SegmentsRequest request, CancellationToken cancellationToken = default) @@ -8561,7 +10863,10 @@ public virtual Task SegmentsAsync(SegmentsRequest request, Can } /// - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8572,7 +10877,10 @@ public virtual SegmentsResponse Segments(SegmentsRequestDescriptor - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8584,7 +10892,10 @@ public virtual SegmentsResponse Segments(Elastic.Clients.Elasticsearc } /// - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8597,7 +10908,10 @@ public virtual SegmentsResponse Segments(Elastic.Clients.Elasticsearc } /// - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8609,7 +10923,10 @@ public virtual SegmentsResponse Segments() } /// - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8622,7 +10939,10 @@ public virtual SegmentsResponse Segments(Action - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8633,7 +10953,10 @@ public virtual SegmentsResponse Segments(SegmentsRequestDescriptor descriptor) } /// - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8645,7 +10968,10 @@ public virtual SegmentsResponse Segments(Elastic.Clients.Elasticsearch.Indices? } /// - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8658,7 +10984,10 @@ public virtual SegmentsResponse Segments(Elastic.Clients.Elasticsearch.Indices? } /// - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8670,7 +10999,10 @@ public virtual SegmentsResponse Segments() } /// - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8683,7 +11015,10 @@ public virtual SegmentsResponse Segments(Action confi } /// - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SegmentsAsync(SegmentsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -8693,7 +11028,10 @@ public virtual Task SegmentsAsync(SegmentsRequestDe } /// - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SegmentsAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -8704,7 +11042,10 @@ public virtual Task SegmentsAsync(Elastic.Clients.E } /// - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SegmentsAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -8716,7 +11057,10 @@ public virtual Task SegmentsAsync(Elastic.Clients.E } /// - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SegmentsAsync(CancellationToken cancellationToken = default) @@ -8727,7 +11071,10 @@ public virtual Task SegmentsAsync(CancellationToken } /// - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SegmentsAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -8739,7 +11086,10 @@ public virtual Task SegmentsAsync(Action - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SegmentsAsync(SegmentsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -8749,7 +11099,10 @@ public virtual Task SegmentsAsync(SegmentsRequestDescriptor de } /// - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SegmentsAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -8760,7 +11113,10 @@ public virtual Task SegmentsAsync(Elastic.Clients.Elasticsearc } /// - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SegmentsAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -8772,7 +11128,10 @@ public virtual Task SegmentsAsync(Elastic.Clients.Elasticsearc } /// - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SegmentsAsync(CancellationToken cancellationToken = default) @@ -8783,7 +11142,10 @@ public virtual Task SegmentsAsync(CancellationToken cancellati } /// - /// Returns low-level information about the Lucene segments in index shards.
For data streams, the API returns information about the stream’s backing indices. + /// + /// Returns low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SegmentsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -8795,7 +11157,10 @@ public virtual Task SegmentsAsync(Action - /// Retrieves store information about replica shards in one or more indices.
For data streams, the API retrieves store information for the stream’s backing indices. + /// + /// Retrieves store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8806,7 +11171,10 @@ public virtual ShardStoresResponse ShardStores(ShardStoresRequest request) } /// - /// Retrieves store information about replica shards in one or more indices.
For data streams, the API retrieves store information for the stream’s backing indices. + /// + /// Retrieves store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ShardStoresAsync(ShardStoresRequest request, CancellationToken cancellationToken = default) @@ -8816,7 +11184,10 @@ public virtual Task ShardStoresAsync(ShardStoresRequest req } /// - /// Retrieves store information about replica shards in one or more indices.
For data streams, the API retrieves store information for the stream’s backing indices. + /// + /// Retrieves store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8827,7 +11198,10 @@ public virtual ShardStoresResponse ShardStores(ShardStoresRequestDesc } /// - /// Retrieves store information about replica shards in one or more indices.
For data streams, the API retrieves store information for the stream’s backing indices. + /// + /// Retrieves store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8839,7 +11213,10 @@ public virtual ShardStoresResponse ShardStores(Elastic.Clients.Elasti } /// - /// Retrieves store information about replica shards in one or more indices.
For data streams, the API retrieves store information for the stream’s backing indices. + /// + /// Retrieves store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8852,7 +11229,10 @@ public virtual ShardStoresResponse ShardStores(Elastic.Clients.Elasti } /// - /// Retrieves store information about replica shards in one or more indices.
For data streams, the API retrieves store information for the stream’s backing indices. + /// + /// Retrieves store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8864,7 +11244,10 @@ public virtual ShardStoresResponse ShardStores() } /// - /// Retrieves store information about replica shards in one or more indices.
For data streams, the API retrieves store information for the stream’s backing indices. + /// + /// Retrieves store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8877,7 +11260,10 @@ public virtual ShardStoresResponse ShardStores(Action - /// Retrieves store information about replica shards in one or more indices.
For data streams, the API retrieves store information for the stream’s backing indices. + /// + /// Retrieves store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8888,7 +11274,10 @@ public virtual ShardStoresResponse ShardStores(ShardStoresRequestDescriptor desc } /// - /// Retrieves store information about replica shards in one or more indices.
For data streams, the API retrieves store information for the stream’s backing indices. + /// + /// Retrieves store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8900,7 +11289,10 @@ public virtual ShardStoresResponse ShardStores(Elastic.Clients.Elasticsearch.Ind } /// - /// Retrieves store information about replica shards in one or more indices.
For data streams, the API retrieves store information for the stream’s backing indices. + /// + /// Retrieves store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8913,7 +11305,10 @@ public virtual ShardStoresResponse ShardStores(Elastic.Clients.Elasticsearch.Ind } /// - /// Retrieves store information about replica shards in one or more indices.
For data streams, the API retrieves store information for the stream’s backing indices. + /// + /// Retrieves store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8925,7 +11320,10 @@ public virtual ShardStoresResponse ShardStores() } /// - /// Retrieves store information about replica shards in one or more indices.
For data streams, the API retrieves store information for the stream’s backing indices. + /// + /// Retrieves store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8938,7 +11336,10 @@ public virtual ShardStoresResponse ShardStores(Action - /// Retrieves store information about replica shards in one or more indices.
For data streams, the API retrieves store information for the stream’s backing indices. + /// + /// Retrieves store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ShardStoresAsync(ShardStoresRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -8948,7 +11349,10 @@ public virtual Task ShardStoresAsync(ShardStores } /// - /// Retrieves store information about replica shards in one or more indices.
For data streams, the API retrieves store information for the stream’s backing indices. + /// + /// Retrieves store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ShardStoresAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -8959,7 +11363,10 @@ public virtual Task ShardStoresAsync(Elastic.Cli } /// - /// Retrieves store information about replica shards in one or more indices.
For data streams, the API retrieves store information for the stream’s backing indices. + /// + /// Retrieves store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ShardStoresAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -8971,7 +11378,10 @@ public virtual Task ShardStoresAsync(Elastic.Cli } /// - /// Retrieves store information about replica shards in one or more indices.
For data streams, the API retrieves store information for the stream’s backing indices. + /// + /// Retrieves store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ShardStoresAsync(CancellationToken cancellationToken = default) @@ -8982,7 +11392,10 @@ public virtual Task ShardStoresAsync(Cancellatio } /// - /// Retrieves store information about replica shards in one or more indices.
For data streams, the API retrieves store information for the stream’s backing indices. + /// + /// Retrieves store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ShardStoresAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -8994,7 +11407,10 @@ public virtual Task ShardStoresAsync(Action - /// Retrieves store information about replica shards in one or more indices.
For data streams, the API retrieves store information for the stream’s backing indices. + /// + /// Retrieves store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ShardStoresAsync(ShardStoresRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -9004,7 +11420,10 @@ public virtual Task ShardStoresAsync(ShardStoresRequestDesc } /// - /// Retrieves store information about replica shards in one or more indices.
For data streams, the API retrieves store information for the stream’s backing indices. + /// + /// Retrieves store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ShardStoresAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -9015,7 +11434,10 @@ public virtual Task ShardStoresAsync(Elastic.Clients.Elasti } /// - /// Retrieves store information about replica shards in one or more indices.
For data streams, the API retrieves store information for the stream’s backing indices. + /// + /// Retrieves store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ShardStoresAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -9027,7 +11449,10 @@ public virtual Task ShardStoresAsync(Elastic.Clients.Elasti } /// - /// Retrieves store information about replica shards in one or more indices.
For data streams, the API retrieves store information for the stream’s backing indices. + /// + /// Retrieves store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ShardStoresAsync(CancellationToken cancellationToken = default) @@ -9038,7 +11463,10 @@ public virtual Task ShardStoresAsync(CancellationToken canc } /// - /// Retrieves store information about replica shards in one or more indices.
For data streams, the API retrieves store information for the stream’s backing indices. + /// + /// Retrieves store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ShardStoresAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -9050,7 +11478,9 @@ public virtual Task ShardStoresAsync(Action - /// Shrinks an existing index into a new index with fewer primary shards. + /// + /// Shrinks an existing index into a new index with fewer primary shards. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9061,7 +11491,9 @@ public virtual ShrinkIndexResponse Shrink(ShrinkIndexRequest request) } /// - /// Shrinks an existing index into a new index with fewer primary shards. + /// + /// Shrinks an existing index into a new index with fewer primary shards. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ShrinkAsync(ShrinkIndexRequest request, CancellationToken cancellationToken = default) @@ -9071,7 +11503,9 @@ public virtual Task ShrinkAsync(ShrinkIndexRequest request, } /// - /// Shrinks an existing index into a new index with fewer primary shards. + /// + /// Shrinks an existing index into a new index with fewer primary shards. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9082,7 +11516,9 @@ public virtual ShrinkIndexResponse Shrink(ShrinkIndexRequestDescripto } /// - /// Shrinks an existing index into a new index with fewer primary shards. + /// + /// Shrinks an existing index into a new index with fewer primary shards. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9094,7 +11530,9 @@ public virtual ShrinkIndexResponse Shrink(Elastic.Clients.Elasticsear } /// - /// Shrinks an existing index into a new index with fewer primary shards. + /// + /// Shrinks an existing index into a new index with fewer primary shards. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9107,7 +11545,9 @@ public virtual ShrinkIndexResponse Shrink(Elastic.Clients.Elasticsear } /// - /// Shrinks an existing index into a new index with fewer primary shards. + /// + /// Shrinks an existing index into a new index with fewer primary shards. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9118,7 +11558,9 @@ public virtual ShrinkIndexResponse Shrink(ShrinkIndexRequestDescriptor descripto } /// - /// Shrinks an existing index into a new index with fewer primary shards. + /// + /// Shrinks an existing index into a new index with fewer primary shards. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9130,7 +11572,9 @@ public virtual ShrinkIndexResponse Shrink(Elastic.Clients.Elasticsearch.IndexNam } /// - /// Shrinks an existing index into a new index with fewer primary shards. + /// + /// Shrinks an existing index into a new index with fewer primary shards. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9143,7 +11587,9 @@ public virtual ShrinkIndexResponse Shrink(Elastic.Clients.Elasticsearch.IndexNam } /// - /// Shrinks an existing index into a new index with fewer primary shards. + /// + /// Shrinks an existing index into a new index with fewer primary shards. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ShrinkAsync(ShrinkIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -9153,7 +11599,9 @@ public virtual Task ShrinkAsync(ShrinkIndexReque } /// - /// Shrinks an existing index into a new index with fewer primary shards. + /// + /// Shrinks an existing index into a new index with fewer primary shards. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ShrinkAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName target, CancellationToken cancellationToken = default) @@ -9164,7 +11612,9 @@ public virtual Task ShrinkAsync(Elastic.Clients. } /// - /// Shrinks an existing index into a new index with fewer primary shards. + /// + /// Shrinks an existing index into a new index with fewer primary shards. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ShrinkAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName target, Action> configureRequest, CancellationToken cancellationToken = default) @@ -9176,7 +11626,9 @@ public virtual Task ShrinkAsync(Elastic.Clients. } /// - /// Shrinks an existing index into a new index with fewer primary shards. + /// + /// Shrinks an existing index into a new index with fewer primary shards. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ShrinkAsync(ShrinkIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -9186,7 +11638,9 @@ public virtual Task ShrinkAsync(ShrinkIndexRequestDescripto } /// - /// Shrinks an existing index into a new index with fewer primary shards. + /// + /// Shrinks an existing index into a new index with fewer primary shards. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ShrinkAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName target, CancellationToken cancellationToken = default) @@ -9197,7 +11651,9 @@ public virtual Task ShrinkAsync(Elastic.Clients.Elasticsear } /// - /// Shrinks an existing index into a new index with fewer primary shards. + /// + /// Shrinks an existing index into a new index with fewer primary shards. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ShrinkAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName target, Action configureRequest, CancellationToken cancellationToken = default) @@ -9209,7 +11665,10 @@ public virtual Task ShrinkAsync(Elastic.Clients.Elasticsear } /// - /// Simulate an index.
Returns the index configuration that would be applied to the specified index from an existing index template. + /// + /// Simulate an index. + /// Returns the index configuration that would be applied to the specified index from an existing index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9220,7 +11679,10 @@ public virtual SimulateIndexTemplateResponse SimulateIndexTemplate(SimulateIndex } /// - /// Simulate an index.
Returns the index configuration that would be applied to the specified index from an existing index template. + /// + /// Simulate an index. + /// Returns the index configuration that would be applied to the specified index from an existing index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateIndexTemplateAsync(SimulateIndexTemplateRequest request, CancellationToken cancellationToken = default) @@ -9230,7 +11692,10 @@ public virtual Task SimulateIndexTemplateAsync(Si } /// - /// Simulate an index.
Returns the index configuration that would be applied to the specified index from an existing index template. + /// + /// Simulate an index. + /// Returns the index configuration that would be applied to the specified index from an existing index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9241,7 +11706,10 @@ public virtual SimulateIndexTemplateResponse SimulateIndexTemplate(SimulateIndex } /// - /// Simulate an index.
Returns the index configuration that would be applied to the specified index from an existing index template. + /// + /// Simulate an index. + /// Returns the index configuration that would be applied to the specified index from an existing index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9253,7 +11721,10 @@ public virtual SimulateIndexTemplateResponse SimulateIndexTemplate(Elastic.Clien } /// - /// Simulate an index.
Returns the index configuration that would be applied to the specified index from an existing index template. + /// + /// Simulate an index. + /// Returns the index configuration that would be applied to the specified index from an existing index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9266,7 +11737,10 @@ public virtual SimulateIndexTemplateResponse SimulateIndexTemplate(Elastic.Clien } /// - /// Simulate an index.
Returns the index configuration that would be applied to the specified index from an existing index template. + /// + /// Simulate an index. + /// Returns the index configuration that would be applied to the specified index from an existing index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateIndexTemplateAsync(SimulateIndexTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -9276,7 +11750,10 @@ public virtual Task SimulateIndexTemplateAsync(Si } /// - /// Simulate an index.
Returns the index configuration that would be applied to the specified index from an existing index template. + /// + /// Simulate an index. + /// Returns the index configuration that would be applied to the specified index from an existing index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateIndexTemplateAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) @@ -9287,7 +11764,10 @@ public virtual Task SimulateIndexTemplateAsync(El } /// - /// Simulate an index.
Returns the index configuration that would be applied to the specified index from an existing index template. + /// + /// Simulate an index. + /// Returns the index configuration that would be applied to the specified index from an existing index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateIndexTemplateAsync(Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -9299,7 +11779,10 @@ public virtual Task SimulateIndexTemplateAsync(El } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9310,7 +11793,10 @@ public virtual SimulateTemplateResponse SimulateTemplate(SimulateTemplateRequest } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateTemplateAsync(SimulateTemplateRequest request, CancellationToken cancellationToken = default) @@ -9320,7 +11806,10 @@ public virtual Task SimulateTemplateAsync(SimulateTemp } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9331,7 +11820,10 @@ public virtual SimulateTemplateResponse SimulateTemplate(SimulateTemp } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9343,7 +11835,10 @@ public virtual SimulateTemplateResponse SimulateTemplate(Elastic.Clie } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9356,7 +11851,10 @@ public virtual SimulateTemplateResponse SimulateTemplate(Elastic.Clie } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9368,7 +11866,10 @@ public virtual SimulateTemplateResponse SimulateTemplate() } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9381,7 +11882,10 @@ public virtual SimulateTemplateResponse SimulateTemplate(Action - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9392,7 +11896,10 @@ public virtual SimulateTemplateResponse SimulateTemplate(SimulateTemplateRequest } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9404,7 +11911,10 @@ public virtual SimulateTemplateResponse SimulateTemplate(Elastic.Clients.Elastic } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9417,7 +11927,10 @@ public virtual SimulateTemplateResponse SimulateTemplate(Elastic.Clients.Elastic } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9429,7 +11942,10 @@ public virtual SimulateTemplateResponse SimulateTemplate() } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9442,7 +11958,10 @@ public virtual SimulateTemplateResponse SimulateTemplate(Action - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateTemplateAsync(SimulateTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -9452,7 +11971,10 @@ public virtual Task SimulateTemplateAsync(S } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateTemplateAsync(Elastic.Clients.Elasticsearch.Name? name, CancellationToken cancellationToken = default) @@ -9463,7 +11985,10 @@ public virtual Task SimulateTemplateAsync(E } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateTemplateAsync(Elastic.Clients.Elasticsearch.Name? name, Action> configureRequest, CancellationToken cancellationToken = default) @@ -9475,7 +12000,10 @@ public virtual Task SimulateTemplateAsync(E } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateTemplateAsync(CancellationToken cancellationToken = default) @@ -9486,7 +12014,10 @@ public virtual Task SimulateTemplateAsync(C } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateTemplateAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -9498,7 +12029,10 @@ public virtual Task SimulateTemplateAsync(A } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateTemplateAsync(SimulateTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -9508,7 +12042,10 @@ public virtual Task SimulateTemplateAsync(SimulateTemp } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateTemplateAsync(Elastic.Clients.Elasticsearch.Name? name, CancellationToken cancellationToken = default) @@ -9519,7 +12056,10 @@ public virtual Task SimulateTemplateAsync(Elastic.Clie } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateTemplateAsync(Elastic.Clients.Elasticsearch.Name? name, Action configureRequest, CancellationToken cancellationToken = default) @@ -9531,7 +12071,10 @@ public virtual Task SimulateTemplateAsync(Elastic.Clie } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateTemplateAsync(CancellationToken cancellationToken = default) @@ -9542,7 +12085,10 @@ public virtual Task SimulateTemplateAsync(Cancellation } /// - /// Simulate an index template.
Returns the index configuration that would be applied by a particular index template. + /// + /// Simulate an index template. + /// Returns the index configuration that would be applied by a particular index template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateTemplateAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -9554,7 +12100,9 @@ public virtual Task SimulateTemplateAsync(Action - /// Splits an existing index into a new index with more primary shards. + /// + /// Splits an existing index into a new index with more primary shards. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9565,7 +12113,9 @@ public virtual SplitIndexResponse Split(SplitIndexRequest request) } /// - /// Splits an existing index into a new index with more primary shards. + /// + /// Splits an existing index into a new index with more primary shards. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SplitAsync(SplitIndexRequest request, CancellationToken cancellationToken = default) @@ -9575,7 +12125,9 @@ public virtual Task SplitAsync(SplitIndexRequest request, Ca } /// - /// Splits an existing index into a new index with more primary shards. + /// + /// Splits an existing index into a new index with more primary shards. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9586,7 +12138,9 @@ public virtual SplitIndexResponse Split(SplitIndexRequestDescriptor - /// Splits an existing index into a new index with more primary shards. + /// + /// Splits an existing index into a new index with more primary shards. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9598,7 +12152,9 @@ public virtual SplitIndexResponse Split(Elastic.Clients.Elasticsearch } /// - /// Splits an existing index into a new index with more primary shards. + /// + /// Splits an existing index into a new index with more primary shards. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9611,7 +12167,9 @@ public virtual SplitIndexResponse Split(Elastic.Clients.Elasticsearch } /// - /// Splits an existing index into a new index with more primary shards. + /// + /// Splits an existing index into a new index with more primary shards. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9622,7 +12180,9 @@ public virtual SplitIndexResponse Split(SplitIndexRequestDescriptor descriptor) } /// - /// Splits an existing index into a new index with more primary shards. + /// + /// Splits an existing index into a new index with more primary shards. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9634,7 +12194,9 @@ public virtual SplitIndexResponse Split(Elastic.Clients.Elasticsearch.IndexName } /// - /// Splits an existing index into a new index with more primary shards. + /// + /// Splits an existing index into a new index with more primary shards. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9647,7 +12209,9 @@ public virtual SplitIndexResponse Split(Elastic.Clients.Elasticsearch.IndexName } /// - /// Splits an existing index into a new index with more primary shards. + /// + /// Splits an existing index into a new index with more primary shards. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SplitAsync(SplitIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -9657,7 +12221,9 @@ public virtual Task SplitAsync(SplitIndexRequestD } /// - /// Splits an existing index into a new index with more primary shards. + /// + /// Splits an existing index into a new index with more primary shards. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SplitAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName target, CancellationToken cancellationToken = default) @@ -9668,7 +12234,9 @@ public virtual Task SplitAsync(Elastic.Clients.El } /// - /// Splits an existing index into a new index with more primary shards. + /// + /// Splits an existing index into a new index with more primary shards. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SplitAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName target, Action> configureRequest, CancellationToken cancellationToken = default) @@ -9680,7 +12248,9 @@ public virtual Task SplitAsync(Elastic.Clients.El } /// - /// Splits an existing index into a new index with more primary shards. + /// + /// Splits an existing index into a new index with more primary shards. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SplitAsync(SplitIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -9690,7 +12260,9 @@ public virtual Task SplitAsync(SplitIndexRequestDescriptor d } /// - /// Splits an existing index into a new index with more primary shards. + /// + /// Splits an existing index into a new index with more primary shards. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SplitAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName target, CancellationToken cancellationToken = default) @@ -9701,7 +12273,9 @@ public virtual Task SplitAsync(Elastic.Clients.Elasticsearch } /// - /// Splits an existing index into a new index with more primary shards. + /// + /// Splits an existing index into a new index with more primary shards. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SplitAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName target, Action configureRequest, CancellationToken cancellationToken = default) @@ -9713,7 +12287,10 @@ public virtual Task SplitAsync(Elastic.Clients.Elasticsearch } /// - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9724,7 +12301,10 @@ public virtual IndicesStatsResponse Stats(IndicesStatsRequest request) } /// - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(IndicesStatsRequest request, CancellationToken cancellationToken = default) @@ -9734,7 +12314,10 @@ public virtual Task StatsAsync(IndicesStatsRequest request } /// - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9745,7 +12328,10 @@ public virtual IndicesStatsResponse Stats(IndicesStatsRequestDescript } /// - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9757,7 +12343,10 @@ public virtual IndicesStatsResponse Stats(Elastic.Clients.Elasticsear } /// - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9770,7 +12359,10 @@ public virtual IndicesStatsResponse Stats(Elastic.Clients.Elasticsear } /// - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9782,7 +12374,10 @@ public virtual IndicesStatsResponse Stats() } /// - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9795,7 +12390,10 @@ public virtual IndicesStatsResponse Stats(Action - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9806,7 +12404,10 @@ public virtual IndicesStatsResponse Stats(IndicesStatsRequestDescriptor descript } /// - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9818,7 +12419,10 @@ public virtual IndicesStatsResponse Stats(Elastic.Clients.Elasticsearch.Indices? } /// - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9831,7 +12435,10 @@ public virtual IndicesStatsResponse Stats(Elastic.Clients.Elasticsearch.Indices? } /// - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9843,7 +12450,10 @@ public virtual IndicesStatsResponse Stats() } /// - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9856,7 +12466,10 @@ public virtual IndicesStatsResponse Stats(Action } /// - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(IndicesStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -9866,7 +12479,10 @@ public virtual Task StatsAsync(IndicesStatsRequ } /// - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.Indices? indices, Elastic.Clients.Elasticsearch.Metrics? metric, CancellationToken cancellationToken = default) @@ -9877,7 +12493,10 @@ public virtual Task StatsAsync(Elastic.Clients. } /// - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.Indices? indices, Elastic.Clients.Elasticsearch.Metrics? metric, Action> configureRequest, CancellationToken cancellationToken = default) @@ -9889,7 +12508,10 @@ public virtual Task StatsAsync(Elastic.Clients. } /// - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(CancellationToken cancellationToken = default) @@ -9900,7 +12522,10 @@ public virtual Task StatsAsync(CancellationToke } /// - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -9912,7 +12537,10 @@ public virtual Task StatsAsync(Action - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(IndicesStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -9922,7 +12550,10 @@ public virtual Task StatsAsync(IndicesStatsRequestDescript } /// - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.Indices? indices, Elastic.Clients.Elasticsearch.Metrics? metric, CancellationToken cancellationToken = default) @@ -9933,7 +12564,10 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsear } /// - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.Indices? indices, Elastic.Clients.Elasticsearch.Metrics? metric, Action configureRequest, CancellationToken cancellationToken = default) @@ -9945,7 +12579,10 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsear } /// - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(CancellationToken cancellationToken = default) @@ -9956,7 +12593,10 @@ public virtual Task StatsAsync(CancellationToken cancellat } /// - /// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. + /// + /// Returns statistics for one or more indices. + /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -9968,7 +12608,10 @@ public virtual Task StatsAsync(Action - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9979,7 +12622,10 @@ public virtual UpdateAliasesResponse UpdateAliases(UpdateAliasesRequest request) } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateAliasesAsync(UpdateAliasesRequest request, CancellationToken cancellationToken = default) @@ -9989,7 +12635,10 @@ public virtual Task UpdateAliasesAsync(UpdateAliasesReque } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -10000,7 +12649,10 @@ public virtual UpdateAliasesResponse UpdateAliases(UpdateAliasesReque } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -10012,7 +12664,10 @@ public virtual UpdateAliasesResponse UpdateAliases() } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -10025,7 +12680,10 @@ public virtual UpdateAliasesResponse UpdateAliases(Action - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -10036,7 +12694,10 @@ public virtual UpdateAliasesResponse UpdateAliases(UpdateAliasesRequestDescripto } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -10048,7 +12709,10 @@ public virtual UpdateAliasesResponse UpdateAliases() } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -10061,7 +12725,10 @@ public virtual UpdateAliasesResponse UpdateAliases(Action - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateAliasesAsync(UpdateAliasesRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -10071,7 +12738,10 @@ public virtual Task UpdateAliasesAsync(UpdateA } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateAliasesAsync(CancellationToken cancellationToken = default) @@ -10082,7 +12752,10 @@ public virtual Task UpdateAliasesAsync(Cancell } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateAliasesAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -10094,7 +12767,10 @@ public virtual Task UpdateAliasesAsync(Action< } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateAliasesAsync(UpdateAliasesRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -10104,7 +12780,10 @@ public virtual Task UpdateAliasesAsync(UpdateAliasesReque } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateAliasesAsync(CancellationToken cancellationToken = default) @@ -10115,7 +12794,10 @@ public virtual Task UpdateAliasesAsync(CancellationToken } /// - /// Create or update an alias.
Adds a data stream or index to an alias. + /// + /// Create or update an alias. + /// Adds a data stream or index to an alias. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateAliasesAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -10127,7 +12809,10 @@ public virtual Task UpdateAliasesAsync(Action - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -10138,7 +12823,10 @@ public virtual ValidateQueryResponse ValidateQuery(ValidateQueryRequest request) } /// - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateQueryAsync(ValidateQueryRequest request, CancellationToken cancellationToken = default) @@ -10148,7 +12836,10 @@ public virtual Task ValidateQueryAsync(ValidateQueryReque } /// - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -10159,7 +12850,10 @@ public virtual ValidateQueryResponse ValidateQuery(ValidateQueryReque } /// - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -10171,7 +12865,10 @@ public virtual ValidateQueryResponse ValidateQuery(Elastic.Clients.El } /// - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -10184,7 +12881,10 @@ public virtual ValidateQueryResponse ValidateQuery(Elastic.Clients.El } /// - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -10196,7 +12896,10 @@ public virtual ValidateQueryResponse ValidateQuery() } /// - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -10209,7 +12912,10 @@ public virtual ValidateQueryResponse ValidateQuery(Action - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -10220,7 +12926,10 @@ public virtual ValidateQueryResponse ValidateQuery(ValidateQueryRequestDescripto } /// - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -10232,7 +12941,10 @@ public virtual ValidateQueryResponse ValidateQuery(Elastic.Clients.Elasticsearch } /// - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -10245,7 +12957,10 @@ public virtual ValidateQueryResponse ValidateQuery(Elastic.Clients.Elasticsearch } /// - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -10257,7 +12972,10 @@ public virtual ValidateQueryResponse ValidateQuery() } /// - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -10270,7 +12988,10 @@ public virtual ValidateQueryResponse ValidateQuery(Action - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateQueryAsync(ValidateQueryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -10280,7 +13001,10 @@ public virtual Task ValidateQueryAsync(Validat } /// - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateQueryAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -10291,7 +13015,10 @@ public virtual Task ValidateQueryAsync(Elastic } /// - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateQueryAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -10303,7 +13030,10 @@ public virtual Task ValidateQueryAsync(Elastic } /// - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateQueryAsync(CancellationToken cancellationToken = default) @@ -10314,7 +13044,10 @@ public virtual Task ValidateQueryAsync(Cancell } /// - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateQueryAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -10326,7 +13059,10 @@ public virtual Task ValidateQueryAsync(Action< } /// - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateQueryAsync(ValidateQueryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -10336,7 +13072,10 @@ public virtual Task ValidateQueryAsync(ValidateQueryReque } /// - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateQueryAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -10347,7 +13086,10 @@ public virtual Task ValidateQueryAsync(Elastic.Clients.El } /// - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateQueryAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -10359,7 +13101,10 @@ public virtual Task ValidateQueryAsync(Elastic.Clients.El } /// - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateQueryAsync(CancellationToken cancellationToken = default) @@ -10370,7 +13115,10 @@ public virtual Task ValidateQueryAsync(CancellationToken } /// - /// Validate a query.
Validates a query without running it. + /// + /// Validate a query. + /// Validates a query without running it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateQueryAsync(Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Inference.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Inference.g.cs index 90d4f1f5238..d6d2bd5eb7b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Inference.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Inference.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Inference; public partial class InferenceNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected InferenceNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal InferenceNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// Delete an inference endpoint + /// + /// Delete an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -49,7 +53,9 @@ public virtual DeleteInferenceResponse Delete(DeleteInferenceRequest request) } /// - /// Delete an inference endpoint + /// + /// Delete an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteInferenceRequest request, CancellationToken cancellationToken = default) @@ -59,7 +65,9 @@ public virtual Task DeleteAsync(DeleteInferenceRequest } /// - /// Delete an inference endpoint + /// + /// Delete an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -70,7 +78,9 @@ public virtual DeleteInferenceResponse Delete(DeleteInferenceRequestDescriptor d } /// - /// Delete an inference endpoint + /// + /// Delete an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -82,7 +92,9 @@ public virtual DeleteInferenceResponse Delete(Elastic.Clients.Elasticsearch.Infe } /// - /// Delete an inference endpoint + /// + /// Delete an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -95,7 +107,9 @@ public virtual DeleteInferenceResponse Delete(Elastic.Clients.Elasticsearch.Infe } /// - /// Delete an inference endpoint + /// + /// Delete an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -107,7 +121,9 @@ public virtual DeleteInferenceResponse Delete(Elastic.Clients.Elasticsearch.Id i } /// - /// Delete an inference endpoint + /// + /// Delete an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -120,7 +136,9 @@ public virtual DeleteInferenceResponse Delete(Elastic.Clients.Elasticsearch.Id i } /// - /// Delete an inference endpoint + /// + /// Delete an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteInferenceRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -130,7 +148,9 @@ public virtual Task DeleteAsync(DeleteInferenceRequestD } /// - /// Delete an inference endpoint + /// + /// Delete an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Inference.TaskType? taskType, Elastic.Clients.Elasticsearch.Id inferenceId, CancellationToken cancellationToken = default) @@ -141,7 +161,9 @@ public virtual Task DeleteAsync(Elastic.Clients.Elastic } /// - /// Delete an inference endpoint + /// + /// Delete an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Inference.TaskType? taskType, Elastic.Clients.Elasticsearch.Id inferenceId, Action configureRequest, CancellationToken cancellationToken = default) @@ -153,7 +175,9 @@ public virtual Task DeleteAsync(Elastic.Clients.Elastic } /// - /// Delete an inference endpoint + /// + /// Delete an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Id inferenceId, CancellationToken cancellationToken = default) @@ -164,7 +188,9 @@ public virtual Task DeleteAsync(Elastic.Clients.Elastic } /// - /// Delete an inference endpoint + /// + /// Delete an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Id inferenceId, Action configureRequest, CancellationToken cancellationToken = default) @@ -176,7 +202,9 @@ public virtual Task DeleteAsync(Elastic.Clients.Elastic } /// - /// Get an inference endpoint + /// + /// Get an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -187,7 +215,9 @@ public virtual GetInferenceResponse Get(GetInferenceRequest request) } /// - /// Get an inference endpoint + /// + /// Get an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(GetInferenceRequest request, CancellationToken cancellationToken = default) @@ -197,7 +227,9 @@ public virtual Task GetAsync(GetInferenceRequest request, } /// - /// Get an inference endpoint + /// + /// Get an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -208,7 +240,9 @@ public virtual GetInferenceResponse Get(GetInferenceRequestDescriptor descriptor } /// - /// Get an inference endpoint + /// + /// Get an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -220,7 +254,9 @@ public virtual GetInferenceResponse Get(Elastic.Clients.Elasticsearch.Inference. } /// - /// Get an inference endpoint + /// + /// Get an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -233,7 +269,9 @@ public virtual GetInferenceResponse Get(Elastic.Clients.Elasticsearch.Inference. } /// - /// Get an inference endpoint + /// + /// Get an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -245,7 +283,9 @@ public virtual GetInferenceResponse Get() } /// - /// Get an inference endpoint + /// + /// Get an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -258,7 +298,9 @@ public virtual GetInferenceResponse Get(Action co } /// - /// Get an inference endpoint + /// + /// Get an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(GetInferenceRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -268,7 +310,9 @@ public virtual Task GetAsync(GetInferenceRequestDescriptor } /// - /// Get an inference endpoint + /// + /// Get an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(Elastic.Clients.Elasticsearch.Inference.TaskType? taskType, Elastic.Clients.Elasticsearch.Id? inferenceId, CancellationToken cancellationToken = default) @@ -279,7 +323,9 @@ public virtual Task GetAsync(Elastic.Clients.Elasticsearch } /// - /// Get an inference endpoint + /// + /// Get an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(Elastic.Clients.Elasticsearch.Inference.TaskType? taskType, Elastic.Clients.Elasticsearch.Id? inferenceId, Action configureRequest, CancellationToken cancellationToken = default) @@ -291,7 +337,9 @@ public virtual Task GetAsync(Elastic.Clients.Elasticsearch } /// - /// Get an inference endpoint + /// + /// Get an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(CancellationToken cancellationToken = default) @@ -302,7 +350,9 @@ public virtual Task GetAsync(CancellationToken cancellatio } /// - /// Get an inference endpoint + /// + /// Get an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -314,7 +364,9 @@ public virtual Task GetAsync(Action - /// Perform inference on the service + /// + /// Perform inference on the service + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -325,7 +377,9 @@ public virtual InferenceResponse Inference(InferenceRequest request) } /// - /// Perform inference on the service + /// + /// Perform inference on the service + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InferenceAsync(InferenceRequest request, CancellationToken cancellationToken = default) @@ -335,7 +389,9 @@ public virtual Task InferenceAsync(InferenceRequest request, } /// - /// Perform inference on the service + /// + /// Perform inference on the service + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -346,7 +402,9 @@ public virtual InferenceResponse Inference(InferenceRequestDescriptor descriptor } /// - /// Perform inference on the service + /// + /// Perform inference on the service + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -358,7 +416,9 @@ public virtual InferenceResponse Inference(Elastic.Clients.Elasticsearch.Inferen } /// - /// Perform inference on the service + /// + /// Perform inference on the service + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -371,7 +431,9 @@ public virtual InferenceResponse Inference(Elastic.Clients.Elasticsearch.Inferen } /// - /// Perform inference on the service + /// + /// Perform inference on the service + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -383,7 +445,9 @@ public virtual InferenceResponse Inference(Elastic.Clients.Elasticsearch.Id infe } /// - /// Perform inference on the service + /// + /// Perform inference on the service + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -396,7 +460,9 @@ public virtual InferenceResponse Inference(Elastic.Clients.Elasticsearch.Id infe } /// - /// Perform inference on the service + /// + /// Perform inference on the service + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InferenceAsync(InferenceRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -406,7 +472,9 @@ public virtual Task InferenceAsync(InferenceRequestDescriptor } /// - /// Perform inference on the service + /// + /// Perform inference on the service + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InferenceAsync(Elastic.Clients.Elasticsearch.Inference.TaskType? taskType, Elastic.Clients.Elasticsearch.Id inferenceId, CancellationToken cancellationToken = default) @@ -417,7 +485,9 @@ public virtual Task InferenceAsync(Elastic.Clients.Elasticsea } /// - /// Perform inference on the service + /// + /// Perform inference on the service + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InferenceAsync(Elastic.Clients.Elasticsearch.Inference.TaskType? taskType, Elastic.Clients.Elasticsearch.Id inferenceId, Action configureRequest, CancellationToken cancellationToken = default) @@ -429,7 +499,9 @@ public virtual Task InferenceAsync(Elastic.Clients.Elasticsea } /// - /// Perform inference on the service + /// + /// Perform inference on the service + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InferenceAsync(Elastic.Clients.Elasticsearch.Id inferenceId, CancellationToken cancellationToken = default) @@ -440,7 +512,9 @@ public virtual Task InferenceAsync(Elastic.Clients.Elasticsea } /// - /// Perform inference on the service + /// + /// Perform inference on the service + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InferenceAsync(Elastic.Clients.Elasticsearch.Id inferenceId, Action configureRequest, CancellationToken cancellationToken = default) @@ -452,7 +526,9 @@ public virtual Task InferenceAsync(Elastic.Clients.Elasticsea } /// - /// Create an inference endpoint + /// + /// Create an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -463,7 +539,9 @@ public virtual PutInferenceResponse Put(PutInferenceRequest request) } /// - /// Create an inference endpoint + /// + /// Create an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAsync(PutInferenceRequest request, CancellationToken cancellationToken = default) @@ -473,7 +551,9 @@ public virtual Task PutAsync(PutInferenceRequest request, } /// - /// Create an inference endpoint + /// + /// Create an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -484,7 +564,9 @@ public virtual PutInferenceResponse Put(PutInferenceRequestDescriptor descriptor } /// - /// Create an inference endpoint + /// + /// Create an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -496,7 +578,9 @@ public virtual PutInferenceResponse Put(Elastic.Clients.Elasticsearch.Inference. } /// - /// Create an inference endpoint + /// + /// Create an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -509,7 +593,9 @@ public virtual PutInferenceResponse Put(Elastic.Clients.Elasticsearch.Inference. } /// - /// Create an inference endpoint + /// + /// Create an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -521,7 +607,9 @@ public virtual PutInferenceResponse Put(Elastic.Clients.Elasticsearch.Inference. } /// - /// Create an inference endpoint + /// + /// Create an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -534,7 +622,9 @@ public virtual PutInferenceResponse Put(Elastic.Clients.Elasticsearch.Inference. } /// - /// Create an inference endpoint + /// + /// Create an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAsync(PutInferenceRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -544,7 +634,9 @@ public virtual Task PutAsync(PutInferenceRequestDescriptor } /// - /// Create an inference endpoint + /// + /// Create an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAsync(Elastic.Clients.Elasticsearch.Inference.InferenceEndpoint inferenceConfig, Elastic.Clients.Elasticsearch.Inference.TaskType? taskType, Elastic.Clients.Elasticsearch.Id inferenceId, CancellationToken cancellationToken = default) @@ -555,7 +647,9 @@ public virtual Task PutAsync(Elastic.Clients.Elasticsearch } /// - /// Create an inference endpoint + /// + /// Create an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAsync(Elastic.Clients.Elasticsearch.Inference.InferenceEndpoint inferenceConfig, Elastic.Clients.Elasticsearch.Inference.TaskType? taskType, Elastic.Clients.Elasticsearch.Id inferenceId, Action configureRequest, CancellationToken cancellationToken = default) @@ -567,7 +661,9 @@ public virtual Task PutAsync(Elastic.Clients.Elasticsearch } /// - /// Create an inference endpoint + /// + /// Create an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAsync(Elastic.Clients.Elasticsearch.Inference.InferenceEndpoint inferenceConfig, Elastic.Clients.Elasticsearch.Id inferenceId, CancellationToken cancellationToken = default) @@ -578,7 +674,9 @@ public virtual Task PutAsync(Elastic.Clients.Elasticsearch } /// - /// Create an inference endpoint + /// + /// Create an inference endpoint + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAsync(Elastic.Clients.Elasticsearch.Inference.InferenceEndpoint inferenceConfig, Elastic.Clients.Elasticsearch.Id inferenceId, Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ingest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ingest.g.cs index 16030cb6793..86a38064532 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ingest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ingest.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public partial class IngestNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected IngestNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal IngestNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// Deletes one or more existing ingest pipeline. + /// + /// Deletes one or more existing ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -49,7 +53,9 @@ public virtual DeletePipelineResponse DeletePipeline(DeletePipelineRequest reque } /// - /// Deletes one or more existing ingest pipeline. + /// + /// Deletes one or more existing ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeletePipelineAsync(DeletePipelineRequest request, CancellationToken cancellationToken = default) @@ -59,7 +65,9 @@ public virtual Task DeletePipelineAsync(DeletePipelineRe } /// - /// Deletes one or more existing ingest pipeline. + /// + /// Deletes one or more existing ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -70,7 +78,9 @@ public virtual DeletePipelineResponse DeletePipeline(DeletePipelineRe } /// - /// Deletes one or more existing ingest pipeline. + /// + /// Deletes one or more existing ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -82,7 +92,9 @@ public virtual DeletePipelineResponse DeletePipeline(Elastic.Clients. } /// - /// Deletes one or more existing ingest pipeline. + /// + /// Deletes one or more existing ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -95,7 +107,9 @@ public virtual DeletePipelineResponse DeletePipeline(Elastic.Clients. } /// - /// Deletes one or more existing ingest pipeline. + /// + /// Deletes one or more existing ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -106,7 +120,9 @@ public virtual DeletePipelineResponse DeletePipeline(DeletePipelineRequestDescri } /// - /// Deletes one or more existing ingest pipeline. + /// + /// Deletes one or more existing ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -118,7 +134,9 @@ public virtual DeletePipelineResponse DeletePipeline(Elastic.Clients.Elasticsear } /// - /// Deletes one or more existing ingest pipeline. + /// + /// Deletes one or more existing ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -131,7 +149,9 @@ public virtual DeletePipelineResponse DeletePipeline(Elastic.Clients.Elasticsear } /// - /// Deletes one or more existing ingest pipeline. + /// + /// Deletes one or more existing ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeletePipelineAsync(DeletePipelineRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -141,7 +161,9 @@ public virtual Task DeletePipelineAsync(Delet } /// - /// Deletes one or more existing ingest pipeline. + /// + /// Deletes one or more existing ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeletePipelineAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -152,7 +174,9 @@ public virtual Task DeletePipelineAsync(Elast } /// - /// Deletes one or more existing ingest pipeline. + /// + /// Deletes one or more existing ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeletePipelineAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -164,7 +188,9 @@ public virtual Task DeletePipelineAsync(Elast } /// - /// Deletes one or more existing ingest pipeline. + /// + /// Deletes one or more existing ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeletePipelineAsync(DeletePipelineRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -174,7 +200,9 @@ public virtual Task DeletePipelineAsync(DeletePipelineRe } /// - /// Deletes one or more existing ingest pipeline. + /// + /// Deletes one or more existing ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeletePipelineAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -185,7 +213,9 @@ public virtual Task DeletePipelineAsync(Elastic.Clients. } /// - /// Deletes one or more existing ingest pipeline. + /// + /// Deletes one or more existing ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeletePipelineAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -197,7 +227,9 @@ public virtual Task DeletePipelineAsync(Elastic.Clients. } /// - /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// + /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -208,7 +240,9 @@ public virtual GeoIpStatsResponse GeoIpStats(GeoIpStatsRequest request) } /// - /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// + /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GeoIpStatsAsync(GeoIpStatsRequest request, CancellationToken cancellationToken = default) @@ -218,7 +252,9 @@ public virtual Task GeoIpStatsAsync(GeoIpStatsRequest reques } /// - /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// + /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -229,7 +265,9 @@ public virtual GeoIpStatsResponse GeoIpStats(GeoIpStatsRequestDescriptor descrip } /// - /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// + /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -241,7 +279,9 @@ public virtual GeoIpStatsResponse GeoIpStats() } /// - /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// + /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -254,7 +294,9 @@ public virtual GeoIpStatsResponse GeoIpStats(Action } /// - /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// + /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GeoIpStatsAsync(GeoIpStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -264,7 +306,9 @@ public virtual Task GeoIpStatsAsync(GeoIpStatsRequestDescrip } /// - /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// + /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GeoIpStatsAsync(CancellationToken cancellationToken = default) @@ -275,7 +319,9 @@ public virtual Task GeoIpStatsAsync(CancellationToken cancel } /// - /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// + /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GeoIpStatsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -287,7 +333,10 @@ public virtual Task GeoIpStatsAsync(Action - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -298,7 +347,10 @@ public virtual GetPipelineResponse GetPipeline(GetPipelineRequest request) } /// - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPipelineAsync(GetPipelineRequest request, CancellationToken cancellationToken = default) @@ -308,7 +360,10 @@ public virtual Task GetPipelineAsync(GetPipelineRequest req } /// - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -319,7 +374,10 @@ public virtual GetPipelineResponse GetPipeline(GetPipelineRequestDesc } /// - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -331,7 +389,10 @@ public virtual GetPipelineResponse GetPipeline(Elastic.Clients.Elasti } /// - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -344,7 +405,10 @@ public virtual GetPipelineResponse GetPipeline(Elastic.Clients.Elasti } /// - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -356,7 +420,10 @@ public virtual GetPipelineResponse GetPipeline() } /// - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -369,7 +436,10 @@ public virtual GetPipelineResponse GetPipeline(Action - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -380,7 +450,10 @@ public virtual GetPipelineResponse GetPipeline(GetPipelineRequestDescriptor desc } /// - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -392,7 +465,10 @@ public virtual GetPipelineResponse GetPipeline(Elastic.Clients.Elasticsearch.Id? } /// - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -405,7 +481,10 @@ public virtual GetPipelineResponse GetPipeline(Elastic.Clients.Elasticsearch.Id? } /// - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -417,7 +496,10 @@ public virtual GetPipelineResponse GetPipeline() } /// - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -430,7 +512,10 @@ public virtual GetPipelineResponse GetPipeline(Action - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPipelineAsync(GetPipelineRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -440,7 +525,10 @@ public virtual Task GetPipelineAsync(GetPipeline } /// - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPipelineAsync(Elastic.Clients.Elasticsearch.Id? id, CancellationToken cancellationToken = default) @@ -451,7 +539,10 @@ public virtual Task GetPipelineAsync(Elastic.Cli } /// - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPipelineAsync(Elastic.Clients.Elasticsearch.Id? id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -463,7 +554,10 @@ public virtual Task GetPipelineAsync(Elastic.Cli } /// - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPipelineAsync(CancellationToken cancellationToken = default) @@ -474,7 +568,10 @@ public virtual Task GetPipelineAsync(Cancellatio } /// - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPipelineAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -486,7 +583,10 @@ public virtual Task GetPipelineAsync(Action - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPipelineAsync(GetPipelineRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -496,7 +596,10 @@ public virtual Task GetPipelineAsync(GetPipelineRequestDesc } /// - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPipelineAsync(Elastic.Clients.Elasticsearch.Id? id, CancellationToken cancellationToken = default) @@ -507,7 +610,10 @@ public virtual Task GetPipelineAsync(Elastic.Clients.Elasti } /// - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPipelineAsync(Elastic.Clients.Elasticsearch.Id? id, Action configureRequest, CancellationToken cancellationToken = default) @@ -519,7 +625,10 @@ public virtual Task GetPipelineAsync(Elastic.Clients.Elasti } /// - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPipelineAsync(CancellationToken cancellationToken = default) @@ -530,7 +639,10 @@ public virtual Task GetPipelineAsync(CancellationToken canc } /// - /// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. + /// + /// Returns information about one or more ingest pipelines. + /// This API returns a local reference of the pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetPipelineAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -542,7 +654,11 @@ public virtual Task GetPipelineAsync(Action - /// Extracts structured fields out of a single text field within a document.
You choose which field to extract matched fields from, as well as the grok pattern you expect will match.
A grok pattern is like a regular expression that supports aliased expressions that can be reused. + /// + /// Extracts structured fields out of a single text field within a document. + /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. + /// A grok pattern is like a regular expression that supports aliased expressions that can be reused. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -553,7 +669,11 @@ public virtual ProcessorGrokResponse ProcessorGrok(ProcessorGrokRequest request) } /// - /// Extracts structured fields out of a single text field within a document.
You choose which field to extract matched fields from, as well as the grok pattern you expect will match.
A grok pattern is like a regular expression that supports aliased expressions that can be reused. + /// + /// Extracts structured fields out of a single text field within a document. + /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. + /// A grok pattern is like a regular expression that supports aliased expressions that can be reused. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ProcessorGrokAsync(ProcessorGrokRequest request, CancellationToken cancellationToken = default) @@ -563,7 +683,11 @@ public virtual Task ProcessorGrokAsync(ProcessorGrokReque } /// - /// Extracts structured fields out of a single text field within a document.
You choose which field to extract matched fields from, as well as the grok pattern you expect will match.
A grok pattern is like a regular expression that supports aliased expressions that can be reused. + /// + /// Extracts structured fields out of a single text field within a document. + /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. + /// A grok pattern is like a regular expression that supports aliased expressions that can be reused. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -574,7 +698,11 @@ public virtual ProcessorGrokResponse ProcessorGrok(ProcessorGrokRequestDescripto } /// - /// Extracts structured fields out of a single text field within a document.
You choose which field to extract matched fields from, as well as the grok pattern you expect will match.
A grok pattern is like a regular expression that supports aliased expressions that can be reused. + /// + /// Extracts structured fields out of a single text field within a document. + /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. + /// A grok pattern is like a regular expression that supports aliased expressions that can be reused. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -586,7 +714,11 @@ public virtual ProcessorGrokResponse ProcessorGrok() } /// - /// Extracts structured fields out of a single text field within a document.
You choose which field to extract matched fields from, as well as the grok pattern you expect will match.
A grok pattern is like a regular expression that supports aliased expressions that can be reused. + /// + /// Extracts structured fields out of a single text field within a document. + /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. + /// A grok pattern is like a regular expression that supports aliased expressions that can be reused. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -599,7 +731,11 @@ public virtual ProcessorGrokResponse ProcessorGrok(Action - /// Extracts structured fields out of a single text field within a document.
You choose which field to extract matched fields from, as well as the grok pattern you expect will match.
A grok pattern is like a regular expression that supports aliased expressions that can be reused. + /// + /// Extracts structured fields out of a single text field within a document. + /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. + /// A grok pattern is like a regular expression that supports aliased expressions that can be reused. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ProcessorGrokAsync(ProcessorGrokRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -609,7 +745,11 @@ public virtual Task ProcessorGrokAsync(ProcessorGrokReque } /// - /// Extracts structured fields out of a single text field within a document.
You choose which field to extract matched fields from, as well as the grok pattern you expect will match.
A grok pattern is like a regular expression that supports aliased expressions that can be reused. + /// + /// Extracts structured fields out of a single text field within a document. + /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. + /// A grok pattern is like a regular expression that supports aliased expressions that can be reused. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ProcessorGrokAsync(CancellationToken cancellationToken = default) @@ -620,7 +760,11 @@ public virtual Task ProcessorGrokAsync(CancellationToken } /// - /// Extracts structured fields out of a single text field within a document.
You choose which field to extract matched fields from, as well as the grok pattern you expect will match.
A grok pattern is like a regular expression that supports aliased expressions that can be reused. + /// + /// Extracts structured fields out of a single text field within a document. + /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. + /// A grok pattern is like a regular expression that supports aliased expressions that can be reused. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ProcessorGrokAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -632,7 +776,10 @@ public virtual Task ProcessorGrokAsync(Action - /// Creates or updates an ingest pipeline.
Changes made using this API take effect immediately. + /// + /// Creates or updates an ingest pipeline. + /// Changes made using this API take effect immediately. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -643,7 +790,10 @@ public virtual PutPipelineResponse PutPipeline(PutPipelineRequest request) } /// - /// Creates or updates an ingest pipeline.
Changes made using this API take effect immediately. + /// + /// Creates or updates an ingest pipeline. + /// Changes made using this API take effect immediately. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPipelineAsync(PutPipelineRequest request, CancellationToken cancellationToken = default) @@ -653,7 +803,10 @@ public virtual Task PutPipelineAsync(PutPipelineRequest req } /// - /// Creates or updates an ingest pipeline.
Changes made using this API take effect immediately. + /// + /// Creates or updates an ingest pipeline. + /// Changes made using this API take effect immediately. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -664,7 +817,10 @@ public virtual PutPipelineResponse PutPipeline(PutPipelineRequestDesc } /// - /// Creates or updates an ingest pipeline.
Changes made using this API take effect immediately. + /// + /// Creates or updates an ingest pipeline. + /// Changes made using this API take effect immediately. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -676,7 +832,10 @@ public virtual PutPipelineResponse PutPipeline(Elastic.Clients.Elasti } /// - /// Creates or updates an ingest pipeline.
Changes made using this API take effect immediately. + /// + /// Creates or updates an ingest pipeline. + /// Changes made using this API take effect immediately. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -689,7 +848,10 @@ public virtual PutPipelineResponse PutPipeline(Elastic.Clients.Elasti } /// - /// Creates or updates an ingest pipeline.
Changes made using this API take effect immediately. + /// + /// Creates or updates an ingest pipeline. + /// Changes made using this API take effect immediately. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -700,7 +862,10 @@ public virtual PutPipelineResponse PutPipeline(PutPipelineRequestDescriptor desc } /// - /// Creates or updates an ingest pipeline.
Changes made using this API take effect immediately. + /// + /// Creates or updates an ingest pipeline. + /// Changes made using this API take effect immediately. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -712,7 +877,10 @@ public virtual PutPipelineResponse PutPipeline(Elastic.Clients.Elasticsearch.Id } /// - /// Creates or updates an ingest pipeline.
Changes made using this API take effect immediately. + /// + /// Creates or updates an ingest pipeline. + /// Changes made using this API take effect immediately. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -725,7 +893,10 @@ public virtual PutPipelineResponse PutPipeline(Elastic.Clients.Elasticsearch.Id } /// - /// Creates or updates an ingest pipeline.
Changes made using this API take effect immediately. + /// + /// Creates or updates an ingest pipeline. + /// Changes made using this API take effect immediately. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPipelineAsync(PutPipelineRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -735,7 +906,10 @@ public virtual Task PutPipelineAsync(PutPipeline } /// - /// Creates or updates an ingest pipeline.
Changes made using this API take effect immediately. + /// + /// Creates or updates an ingest pipeline. + /// Changes made using this API take effect immediately. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPipelineAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -746,7 +920,10 @@ public virtual Task PutPipelineAsync(Elastic.Cli } /// - /// Creates or updates an ingest pipeline.
Changes made using this API take effect immediately. + /// + /// Creates or updates an ingest pipeline. + /// Changes made using this API take effect immediately. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPipelineAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -758,7 +935,10 @@ public virtual Task PutPipelineAsync(Elastic.Cli } /// - /// Creates or updates an ingest pipeline.
Changes made using this API take effect immediately. + /// + /// Creates or updates an ingest pipeline. + /// Changes made using this API take effect immediately. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPipelineAsync(PutPipelineRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -768,7 +948,10 @@ public virtual Task PutPipelineAsync(PutPipelineRequestDesc } /// - /// Creates or updates an ingest pipeline.
Changes made using this API take effect immediately. + /// + /// Creates or updates an ingest pipeline. + /// Changes made using this API take effect immediately. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPipelineAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -779,7 +962,10 @@ public virtual Task PutPipelineAsync(Elastic.Clients.Elasti } /// - /// Creates or updates an ingest pipeline.
Changes made using this API take effect immediately. + /// + /// Creates or updates an ingest pipeline. + /// Changes made using this API take effect immediately. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPipelineAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -791,7 +977,9 @@ public virtual Task PutPipelineAsync(Elastic.Clients.Elasti } /// - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -802,7 +990,9 @@ public virtual SimulateResponse Simulate(SimulateRequest request) } /// - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateAsync(SimulateRequest request, CancellationToken cancellationToken = default) @@ -812,7 +1002,9 @@ public virtual Task SimulateAsync(SimulateRequest request, Can } /// - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -823,7 +1015,9 @@ public virtual SimulateResponse Simulate(SimulateRequestDescriptor - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -835,7 +1029,9 @@ public virtual SimulateResponse Simulate(Elastic.Clients.Elasticsearc } /// - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -848,7 +1044,9 @@ public virtual SimulateResponse Simulate(Elastic.Clients.Elasticsearc } /// - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -860,7 +1058,9 @@ public virtual SimulateResponse Simulate() } /// - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -873,7 +1073,9 @@ public virtual SimulateResponse Simulate(Action - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -884,7 +1086,9 @@ public virtual SimulateResponse Simulate(SimulateRequestDescriptor descriptor) } /// - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -896,7 +1100,9 @@ public virtual SimulateResponse Simulate(Elastic.Clients.Elasticsearch.Id? id) } /// - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -909,7 +1115,9 @@ public virtual SimulateResponse Simulate(Elastic.Clients.Elasticsearch.Id? id, A } /// - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -921,7 +1129,9 @@ public virtual SimulateResponse Simulate() } /// - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -934,7 +1144,9 @@ public virtual SimulateResponse Simulate(Action confi } /// - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateAsync(SimulateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -944,7 +1156,9 @@ public virtual Task SimulateAsync(SimulateRequestDe } /// - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateAsync(Elastic.Clients.Elasticsearch.Id? id, CancellationToken cancellationToken = default) @@ -955,7 +1169,9 @@ public virtual Task SimulateAsync(Elastic.Clients.E } /// - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateAsync(Elastic.Clients.Elasticsearch.Id? id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -967,7 +1183,9 @@ public virtual Task SimulateAsync(Elastic.Clients.E } /// - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateAsync(CancellationToken cancellationToken = default) @@ -978,7 +1196,9 @@ public virtual Task SimulateAsync(CancellationToken } /// - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -990,7 +1210,9 @@ public virtual Task SimulateAsync(Action - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateAsync(SimulateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1000,7 +1222,9 @@ public virtual Task SimulateAsync(SimulateRequestDescriptor de } /// - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateAsync(Elastic.Clients.Elasticsearch.Id? id, CancellationToken cancellationToken = default) @@ -1011,7 +1235,9 @@ public virtual Task SimulateAsync(Elastic.Clients.Elasticsearc } /// - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateAsync(Elastic.Clients.Elasticsearch.Id? id, Action configureRequest, CancellationToken cancellationToken = default) @@ -1023,7 +1249,9 @@ public virtual Task SimulateAsync(Elastic.Clients.Elasticsearc } /// - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateAsync(CancellationToken cancellationToken = default) @@ -1034,7 +1262,9 @@ public virtual Task SimulateAsync(CancellationToken cancellati } /// - /// Executes an ingest pipeline against a set of provided documents. + /// + /// Executes an ingest pipeline against a set of provided documents. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SimulateAsync(Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.License.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.License.g.cs index c448f7cd991..d1a8a6d4843 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.License.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.License.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.LicenseManagement; public partial class LicenseManagementNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected LicenseManagementNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal LicenseManagementNamespacedClient(ElasticsearchClient client) : base(cl } /// - /// Deletes licensing information for the cluster + /// + /// Deletes licensing information for the cluster + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -49,7 +53,9 @@ public virtual DeleteLicenseResponse Delete(DeleteLicenseRequest request) } /// - /// Deletes licensing information for the cluster + /// + /// Deletes licensing information for the cluster + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteLicenseRequest request, CancellationToken cancellationToken = default) @@ -59,7 +65,9 @@ public virtual Task DeleteAsync(DeleteLicenseRequest requ } /// - /// Deletes licensing information for the cluster + /// + /// Deletes licensing information for the cluster + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -70,7 +78,9 @@ public virtual DeleteLicenseResponse Delete(DeleteLicenseRequestDescriptor descr } /// - /// Deletes licensing information for the cluster + /// + /// Deletes licensing information for the cluster + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -82,7 +92,9 @@ public virtual DeleteLicenseResponse Delete() } /// - /// Deletes licensing information for the cluster + /// + /// Deletes licensing information for the cluster + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -95,7 +107,9 @@ public virtual DeleteLicenseResponse Delete(Action - /// Deletes licensing information for the cluster + /// + /// Deletes licensing information for the cluster + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteLicenseRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -105,7 +119,9 @@ public virtual Task DeleteAsync(DeleteLicenseRequestDescr } /// - /// Deletes licensing information for the cluster + /// + /// Deletes licensing information for the cluster + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(CancellationToken cancellationToken = default) @@ -116,7 +132,9 @@ public virtual Task DeleteAsync(CancellationToken cancell } /// - /// Deletes licensing information for the cluster + /// + /// Deletes licensing information for the cluster + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -128,7 +146,11 @@ public virtual Task DeleteAsync(Action - /// Get license information.
Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires.
For more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions). + /// + /// Get license information. + /// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. + /// For more information about the different types of licenses, refer to Elastic Stack subscriptions. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -139,7 +161,11 @@ public virtual GetLicenseResponse Get(GetLicenseRequest request) } /// - /// Get license information.
Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires.
For more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions). + /// + /// Get license information. + /// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. + /// For more information about the different types of licenses, refer to Elastic Stack subscriptions. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(GetLicenseRequest request, CancellationToken cancellationToken = default) @@ -149,7 +175,11 @@ public virtual Task GetAsync(GetLicenseRequest request, Canc } /// - /// Get license information.
Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires.
For more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions). + /// + /// Get license information. + /// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. + /// For more information about the different types of licenses, refer to Elastic Stack subscriptions. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -160,7 +190,11 @@ public virtual GetLicenseResponse Get(GetLicenseRequestDescriptor descriptor) } /// - /// Get license information.
Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires.
For more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions). + /// + /// Get license information. + /// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. + /// For more information about the different types of licenses, refer to Elastic Stack subscriptions. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -172,7 +206,11 @@ public virtual GetLicenseResponse Get() } /// - /// Get license information.
Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires.
For more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions). + /// + /// Get license information. + /// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. + /// For more information about the different types of licenses, refer to Elastic Stack subscriptions. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -185,7 +223,11 @@ public virtual GetLicenseResponse Get(Action config } /// - /// Get license information.
Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires.
For more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions). + /// + /// Get license information. + /// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. + /// For more information about the different types of licenses, refer to Elastic Stack subscriptions. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(GetLicenseRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -195,7 +237,11 @@ public virtual Task GetAsync(GetLicenseRequestDescriptor des } /// - /// Get license information.
Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires.
For more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions). + /// + /// Get license information. + /// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. + /// For more information about the different types of licenses, refer to Elastic Stack subscriptions. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(CancellationToken cancellationToken = default) @@ -206,7 +252,11 @@ public virtual Task GetAsync(CancellationToken cancellationT } /// - /// Get license information.
Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires.
For more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions). + /// + /// Get license information. + /// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. + /// For more information about the different types of licenses, refer to Elastic Stack subscriptions. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -218,7 +268,9 @@ public virtual Task GetAsync(Action - /// Retrieves information about the status of the basic license. + /// + /// Retrieves information about the status of the basic license. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -229,7 +281,9 @@ public virtual GetBasicStatusResponse GetBasicStatus(GetBasicStatusRequest reque } /// - /// Retrieves information about the status of the basic license. + /// + /// Retrieves information about the status of the basic license. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBasicStatusAsync(GetBasicStatusRequest request, CancellationToken cancellationToken = default) @@ -239,7 +293,9 @@ public virtual Task GetBasicStatusAsync(GetBasicStatusRe } /// - /// Retrieves information about the status of the basic license. + /// + /// Retrieves information about the status of the basic license. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -250,7 +306,9 @@ public virtual GetBasicStatusResponse GetBasicStatus(GetBasicStatusRequestDescri } /// - /// Retrieves information about the status of the basic license. + /// + /// Retrieves information about the status of the basic license. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -262,7 +320,9 @@ public virtual GetBasicStatusResponse GetBasicStatus() } /// - /// Retrieves information about the status of the basic license. + /// + /// Retrieves information about the status of the basic license. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -275,7 +335,9 @@ public virtual GetBasicStatusResponse GetBasicStatus(Action - /// Retrieves information about the status of the basic license. + /// + /// Retrieves information about the status of the basic license. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBasicStatusAsync(GetBasicStatusRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -285,7 +347,9 @@ public virtual Task GetBasicStatusAsync(GetBasicStatusRe } /// - /// Retrieves information about the status of the basic license. + /// + /// Retrieves information about the status of the basic license. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBasicStatusAsync(CancellationToken cancellationToken = default) @@ -296,7 +360,9 @@ public virtual Task GetBasicStatusAsync(CancellationToke } /// - /// Retrieves information about the status of the basic license. + /// + /// Retrieves information about the status of the basic license. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBasicStatusAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -308,7 +374,9 @@ public virtual Task GetBasicStatusAsync(Action - /// Retrieves information about the status of the trial license. + /// + /// Retrieves information about the status of the trial license. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -319,7 +387,9 @@ public virtual GetTrialStatusResponse GetTrialStatus(GetTrialStatusRequest reque } /// - /// Retrieves information about the status of the trial license. + /// + /// Retrieves information about the status of the trial license. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTrialStatusAsync(GetTrialStatusRequest request, CancellationToken cancellationToken = default) @@ -329,7 +399,9 @@ public virtual Task GetTrialStatusAsync(GetTrialStatusRe } /// - /// Retrieves information about the status of the trial license. + /// + /// Retrieves information about the status of the trial license. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -340,7 +412,9 @@ public virtual GetTrialStatusResponse GetTrialStatus(GetTrialStatusRequestDescri } /// - /// Retrieves information about the status of the trial license. + /// + /// Retrieves information about the status of the trial license. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -352,7 +426,9 @@ public virtual GetTrialStatusResponse GetTrialStatus() } /// - /// Retrieves information about the status of the trial license. + /// + /// Retrieves information about the status of the trial license. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -365,7 +441,9 @@ public virtual GetTrialStatusResponse GetTrialStatus(Action - /// Retrieves information about the status of the trial license. + /// + /// Retrieves information about the status of the trial license. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTrialStatusAsync(GetTrialStatusRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -375,7 +453,9 @@ public virtual Task GetTrialStatusAsync(GetTrialStatusRe } /// - /// Retrieves information about the status of the trial license. + /// + /// Retrieves information about the status of the trial license. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTrialStatusAsync(CancellationToken cancellationToken = default) @@ -386,7 +466,9 @@ public virtual Task GetTrialStatusAsync(CancellationToke } /// - /// Retrieves information about the status of the trial license. + /// + /// Retrieves information about the status of the trial license. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTrialStatusAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -398,7 +480,9 @@ public virtual Task GetTrialStatusAsync(Action - /// Updates the license for the cluster. + /// + /// Updates the license for the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -409,7 +493,9 @@ public virtual PostResponse Post(PostRequest request) } /// - /// Updates the license for the cluster. + /// + /// Updates the license for the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostAsync(PostRequest request, CancellationToken cancellationToken = default) @@ -419,7 +505,9 @@ public virtual Task PostAsync(PostRequest request, CancellationTok } /// - /// Updates the license for the cluster. + /// + /// Updates the license for the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -430,7 +518,9 @@ public virtual PostResponse Post(PostRequestDescriptor descriptor) } /// - /// Updates the license for the cluster. + /// + /// Updates the license for the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -442,7 +532,9 @@ public virtual PostResponse Post() } /// - /// Updates the license for the cluster. + /// + /// Updates the license for the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -455,7 +547,9 @@ public virtual PostResponse Post(Action configureRequest) } /// - /// Updates the license for the cluster. + /// + /// Updates the license for the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostAsync(PostRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -465,7 +559,9 @@ public virtual Task PostAsync(PostRequestDescriptor descriptor, Ca } /// - /// Updates the license for the cluster. + /// + /// Updates the license for the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostAsync(CancellationToken cancellationToken = default) @@ -476,7 +572,9 @@ public virtual Task PostAsync(CancellationToken cancellationToken } /// - /// Updates the license for the cluster. + /// + /// Updates the license for the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -488,7 +586,10 @@ public virtual Task PostAsync(Action config } /// - /// The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true.
To check the status of your basic license, use the following API: [Get basic status](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html). + /// + /// The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. + /// To check the status of your basic license, use the following API: Get basic status. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -499,7 +600,10 @@ public virtual PostStartBasicResponse PostStartBasic(PostStartBasicRequest reque } /// - /// The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true.
To check the status of your basic license, use the following API: [Get basic status](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html). + /// + /// The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. + /// To check the status of your basic license, use the following API: Get basic status. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostStartBasicAsync(PostStartBasicRequest request, CancellationToken cancellationToken = default) @@ -509,7 +613,10 @@ public virtual Task PostStartBasicAsync(PostStartBasicRe } /// - /// The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true.
To check the status of your basic license, use the following API: [Get basic status](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html). + /// + /// The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. + /// To check the status of your basic license, use the following API: Get basic status. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -520,7 +627,10 @@ public virtual PostStartBasicResponse PostStartBasic(PostStartBasicRequestDescri } /// - /// The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true.
To check the status of your basic license, use the following API: [Get basic status](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html). + /// + /// The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. + /// To check the status of your basic license, use the following API: Get basic status. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -532,7 +642,10 @@ public virtual PostStartBasicResponse PostStartBasic() } /// - /// The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true.
To check the status of your basic license, use the following API: [Get basic status](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html). + /// + /// The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. + /// To check the status of your basic license, use the following API: Get basic status. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -545,7 +658,10 @@ public virtual PostStartBasicResponse PostStartBasic(Action - /// The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true.
To check the status of your basic license, use the following API: [Get basic status](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html). + /// + /// The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. + /// To check the status of your basic license, use the following API: Get basic status. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostStartBasicAsync(PostStartBasicRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -555,7 +671,10 @@ public virtual Task PostStartBasicAsync(PostStartBasicRe } /// - /// The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true.
To check the status of your basic license, use the following API: [Get basic status](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html). + /// + /// The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. + /// To check the status of your basic license, use the following API: Get basic status. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostStartBasicAsync(CancellationToken cancellationToken = default) @@ -566,7 +685,10 @@ public virtual Task PostStartBasicAsync(CancellationToke } /// - /// The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true.
To check the status of your basic license, use the following API: [Get basic status](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html). + /// + /// The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. + /// To check the status of your basic license, use the following API: Get basic status. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostStartBasicAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -578,7 +700,9 @@ public virtual Task PostStartBasicAsync(Action - /// The start trial API enables you to start a 30-day trial, which gives access to all subscription features. + /// + /// The start trial API enables you to start a 30-day trial, which gives access to all subscription features. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -589,7 +713,9 @@ public virtual PostStartTrialResponse PostStartTrial(PostStartTrialRequest reque } /// - /// The start trial API enables you to start a 30-day trial, which gives access to all subscription features. + /// + /// The start trial API enables you to start a 30-day trial, which gives access to all subscription features. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostStartTrialAsync(PostStartTrialRequest request, CancellationToken cancellationToken = default) @@ -599,7 +725,9 @@ public virtual Task PostStartTrialAsync(PostStartTrialRe } /// - /// The start trial API enables you to start a 30-day trial, which gives access to all subscription features. + /// + /// The start trial API enables you to start a 30-day trial, which gives access to all subscription features. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -610,7 +738,9 @@ public virtual PostStartTrialResponse PostStartTrial(PostStartTrialRequestDescri } /// - /// The start trial API enables you to start a 30-day trial, which gives access to all subscription features. + /// + /// The start trial API enables you to start a 30-day trial, which gives access to all subscription features. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -622,7 +752,9 @@ public virtual PostStartTrialResponse PostStartTrial() } /// - /// The start trial API enables you to start a 30-day trial, which gives access to all subscription features. + /// + /// The start trial API enables you to start a 30-day trial, which gives access to all subscription features. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -635,7 +767,9 @@ public virtual PostStartTrialResponse PostStartTrial(Action - /// The start trial API enables you to start a 30-day trial, which gives access to all subscription features. + /// + /// The start trial API enables you to start a 30-day trial, which gives access to all subscription features. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostStartTrialAsync(PostStartTrialRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -645,7 +779,9 @@ public virtual Task PostStartTrialAsync(PostStartTrialRe } /// - /// The start trial API enables you to start a 30-day trial, which gives access to all subscription features. + /// + /// The start trial API enables you to start a 30-day trial, which gives access to all subscription features. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostStartTrialAsync(CancellationToken cancellationToken = default) @@ -656,7 +792,9 @@ public virtual Task PostStartTrialAsync(CancellationToke } /// - /// The start trial API enables you to start a 30-day trial, which gives access to all subscription features. + /// + /// The start trial API enables you to start a 30-day trial, which gives access to all subscription features. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostStartTrialAsync(Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ml.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ml.g.cs index bb955282839..00ae7870604 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ml.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ml.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public partial class MachineLearningNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected MachineLearningNamespacedClient() : base() { @@ -38,7 +40,13 @@ internal MachineLearningNamespacedClient(ElasticsearchClient client) : base(clie } /// - /// Clear trained model deployment cache.
Cache will be cleared on all nodes where the trained model is assigned.
A trained model deployment may have an inference cache enabled.
As requests are handled by each allocated node, their responses may be cached on that individual node.
Calling this API clears the caches without restarting the deployment. + /// + /// Clear trained model deployment cache. + /// Cache will be cleared on all nodes where the trained model is assigned. + /// A trained model deployment may have an inference cache enabled. + /// As requests are handled by each allocated node, their responses may be cached on that individual node. + /// Calling this API clears the caches without restarting the deployment. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -49,7 +57,13 @@ public virtual ClearTrainedModelDeploymentCacheResponse ClearTrainedModelDeploym } /// - /// Clear trained model deployment cache.
Cache will be cleared on all nodes where the trained model is assigned.
A trained model deployment may have an inference cache enabled.
As requests are handled by each allocated node, their responses may be cached on that individual node.
Calling this API clears the caches without restarting the deployment. + /// + /// Clear trained model deployment cache. + /// Cache will be cleared on all nodes where the trained model is assigned. + /// A trained model deployment may have an inference cache enabled. + /// As requests are handled by each allocated node, their responses may be cached on that individual node. + /// Calling this API clears the caches without restarting the deployment. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearTrainedModelDeploymentCacheAsync(ClearTrainedModelDeploymentCacheRequest request, CancellationToken cancellationToken = default) @@ -59,7 +73,13 @@ public virtual Task ClearTrainedModelD } /// - /// Clear trained model deployment cache.
Cache will be cleared on all nodes where the trained model is assigned.
A trained model deployment may have an inference cache enabled.
As requests are handled by each allocated node, their responses may be cached on that individual node.
Calling this API clears the caches without restarting the deployment. + /// + /// Clear trained model deployment cache. + /// Cache will be cleared on all nodes where the trained model is assigned. + /// A trained model deployment may have an inference cache enabled. + /// As requests are handled by each allocated node, their responses may be cached on that individual node. + /// Calling this API clears the caches without restarting the deployment. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -70,7 +90,13 @@ public virtual ClearTrainedModelDeploymentCacheResponse ClearTrainedModelDeploym } /// - /// Clear trained model deployment cache.
Cache will be cleared on all nodes where the trained model is assigned.
A trained model deployment may have an inference cache enabled.
As requests are handled by each allocated node, their responses may be cached on that individual node.
Calling this API clears the caches without restarting the deployment. + /// + /// Clear trained model deployment cache. + /// Cache will be cleared on all nodes where the trained model is assigned. + /// A trained model deployment may have an inference cache enabled. + /// As requests are handled by each allocated node, their responses may be cached on that individual node. + /// Calling this API clears the caches without restarting the deployment. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -82,7 +108,13 @@ public virtual ClearTrainedModelDeploymentCacheResponse ClearTrainedModelDeploym } /// - /// Clear trained model deployment cache.
Cache will be cleared on all nodes where the trained model is assigned.
A trained model deployment may have an inference cache enabled.
As requests are handled by each allocated node, their responses may be cached on that individual node.
Calling this API clears the caches without restarting the deployment. + /// + /// Clear trained model deployment cache. + /// Cache will be cleared on all nodes where the trained model is assigned. + /// A trained model deployment may have an inference cache enabled. + /// As requests are handled by each allocated node, their responses may be cached on that individual node. + /// Calling this API clears the caches without restarting the deployment. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -95,7 +127,13 @@ public virtual ClearTrainedModelDeploymentCacheResponse ClearTrainedModelDeploym } /// - /// Clear trained model deployment cache.
Cache will be cleared on all nodes where the trained model is assigned.
A trained model deployment may have an inference cache enabled.
As requests are handled by each allocated node, their responses may be cached on that individual node.
Calling this API clears the caches without restarting the deployment. + /// + /// Clear trained model deployment cache. + /// Cache will be cleared on all nodes where the trained model is assigned. + /// A trained model deployment may have an inference cache enabled. + /// As requests are handled by each allocated node, their responses may be cached on that individual node. + /// Calling this API clears the caches without restarting the deployment. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearTrainedModelDeploymentCacheAsync(ClearTrainedModelDeploymentCacheRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -105,7 +143,13 @@ public virtual Task ClearTrainedModelD } /// - /// Clear trained model deployment cache.
Cache will be cleared on all nodes where the trained model is assigned.
A trained model deployment may have an inference cache enabled.
As requests are handled by each allocated node, their responses may be cached on that individual node.
Calling this API clears the caches without restarting the deployment. + /// + /// Clear trained model deployment cache. + /// Cache will be cleared on all nodes where the trained model is assigned. + /// A trained model deployment may have an inference cache enabled. + /// As requests are handled by each allocated node, their responses may be cached on that individual node. + /// Calling this API clears the caches without restarting the deployment. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearTrainedModelDeploymentCacheAsync(Elastic.Clients.Elasticsearch.Id modelId, CancellationToken cancellationToken = default) @@ -116,7 +160,13 @@ public virtual Task ClearTrainedModelD } /// - /// Clear trained model deployment cache.
Cache will be cleared on all nodes where the trained model is assigned.
A trained model deployment may have an inference cache enabled.
As requests are handled by each allocated node, their responses may be cached on that individual node.
Calling this API clears the caches without restarting the deployment. + /// + /// Clear trained model deployment cache. + /// Cache will be cleared on all nodes where the trained model is assigned. + /// A trained model deployment may have an inference cache enabled. + /// As requests are handled by each allocated node, their responses may be cached on that individual node. + /// Calling this API clears the caches without restarting the deployment. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearTrainedModelDeploymentCacheAsync(Elastic.Clients.Elasticsearch.Id modelId, Action configureRequest, CancellationToken cancellationToken = default) @@ -128,7 +178,13 @@ public virtual Task ClearTrainedModelD } /// - /// Close anomaly detection jobs.
A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.
When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.
If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.
When a datafeed that has a specified end date stops, it automatically closes its associated job. + /// + /// Close anomaly detection jobs. + /// A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results. + /// When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data. + /// If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. + /// When a datafeed that has a specified end date stops, it automatically closes its associated job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -139,7 +195,13 @@ public virtual CloseJobResponse CloseJob(CloseJobRequest request) } /// - /// Close anomaly detection jobs.
A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.
When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.
If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.
When a datafeed that has a specified end date stops, it automatically closes its associated job. + /// + /// Close anomaly detection jobs. + /// A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results. + /// When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data. + /// If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. + /// When a datafeed that has a specified end date stops, it automatically closes its associated job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseJobAsync(CloseJobRequest request, CancellationToken cancellationToken = default) @@ -149,7 +211,13 @@ public virtual Task CloseJobAsync(CloseJobRequest request, Can } /// - /// Close anomaly detection jobs.
A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.
When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.
If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.
When a datafeed that has a specified end date stops, it automatically closes its associated job. + /// + /// Close anomaly detection jobs. + /// A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results. + /// When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data. + /// If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. + /// When a datafeed that has a specified end date stops, it automatically closes its associated job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -160,7 +228,13 @@ public virtual CloseJobResponse CloseJob(CloseJobRequestDescriptor descriptor) } /// - /// Close anomaly detection jobs.
A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.
When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.
If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.
When a datafeed that has a specified end date stops, it automatically closes its associated job. + /// + /// Close anomaly detection jobs. + /// A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results. + /// When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data. + /// If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. + /// When a datafeed that has a specified end date stops, it automatically closes its associated job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -172,7 +246,13 @@ public virtual CloseJobResponse CloseJob(Elastic.Clients.Elasticsearch.Id jobId) } /// - /// Close anomaly detection jobs.
A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.
When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.
If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.
When a datafeed that has a specified end date stops, it automatically closes its associated job. + /// + /// Close anomaly detection jobs. + /// A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results. + /// When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data. + /// If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. + /// When a datafeed that has a specified end date stops, it automatically closes its associated job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -185,7 +265,13 @@ public virtual CloseJobResponse CloseJob(Elastic.Clients.Elasticsearch.Id jobId, } /// - /// Close anomaly detection jobs.
A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.
When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.
If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.
When a datafeed that has a specified end date stops, it automatically closes its associated job. + /// + /// Close anomaly detection jobs. + /// A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results. + /// When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data. + /// If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. + /// When a datafeed that has a specified end date stops, it automatically closes its associated job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseJobAsync(CloseJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -195,7 +281,13 @@ public virtual Task CloseJobAsync(CloseJobRequestDescriptor de } /// - /// Close anomaly detection jobs.
A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.
When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.
If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.
When a datafeed that has a specified end date stops, it automatically closes its associated job. + /// + /// Close anomaly detection jobs. + /// A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results. + /// When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data. + /// If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. + /// When a datafeed that has a specified end date stops, it automatically closes its associated job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseJobAsync(Elastic.Clients.Elasticsearch.Id jobId, CancellationToken cancellationToken = default) @@ -206,7 +298,13 @@ public virtual Task CloseJobAsync(Elastic.Clients.Elasticsearc } /// - /// Close anomaly detection jobs.
A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.
When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.
If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.
When a datafeed that has a specified end date stops, it automatically closes its associated job. + /// + /// Close anomaly detection jobs. + /// A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results. + /// When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data. + /// If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. + /// When a datafeed that has a specified end date stops, it automatically closes its associated job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseJobAsync(Elastic.Clients.Elasticsearch.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -218,7 +316,10 @@ public virtual Task CloseJobAsync(Elastic.Clients.Elasticsearc } /// - /// Delete a calendar.
Removes all scheduled events from a calendar, then deletes it. + /// + /// Delete a calendar. + /// Removes all scheduled events from a calendar, then deletes it. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -229,7 +330,10 @@ public virtual DeleteCalendarResponse DeleteCalendar(DeleteCalendarRequest reque } /// - /// Delete a calendar.
Removes all scheduled events from a calendar, then deletes it. + /// + /// Delete a calendar. + /// Removes all scheduled events from a calendar, then deletes it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarAsync(DeleteCalendarRequest request, CancellationToken cancellationToken = default) @@ -239,7 +343,10 @@ public virtual Task DeleteCalendarAsync(DeleteCalendarRe } /// - /// Delete a calendar.
Removes all scheduled events from a calendar, then deletes it. + /// + /// Delete a calendar. + /// Removes all scheduled events from a calendar, then deletes it. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -250,7 +357,10 @@ public virtual DeleteCalendarResponse DeleteCalendar(DeleteCalendarRequestDescri } /// - /// Delete a calendar.
Removes all scheduled events from a calendar, then deletes it. + /// + /// Delete a calendar. + /// Removes all scheduled events from a calendar, then deletes it. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -262,7 +372,10 @@ public virtual DeleteCalendarResponse DeleteCalendar(Elastic.Clients.Elasticsear } /// - /// Delete a calendar.
Removes all scheduled events from a calendar, then deletes it. + /// + /// Delete a calendar. + /// Removes all scheduled events from a calendar, then deletes it. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -275,7 +388,10 @@ public virtual DeleteCalendarResponse DeleteCalendar(Elastic.Clients.Elasticsear } /// - /// Delete a calendar.
Removes all scheduled events from a calendar, then deletes it. + /// + /// Delete a calendar. + /// Removes all scheduled events from a calendar, then deletes it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarAsync(DeleteCalendarRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -285,7 +401,10 @@ public virtual Task DeleteCalendarAsync(DeleteCalendarRe } /// - /// Delete a calendar.
Removes all scheduled events from a calendar, then deletes it. + /// + /// Delete a calendar. + /// Removes all scheduled events from a calendar, then deletes it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarAsync(Elastic.Clients.Elasticsearch.Id calendarId, CancellationToken cancellationToken = default) @@ -296,7 +415,10 @@ public virtual Task DeleteCalendarAsync(Elastic.Clients. } /// - /// Delete a calendar.
Removes all scheduled events from a calendar, then deletes it. + /// + /// Delete a calendar. + /// Removes all scheduled events from a calendar, then deletes it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarAsync(Elastic.Clients.Elasticsearch.Id calendarId, Action configureRequest, CancellationToken cancellationToken = default) @@ -308,7 +430,9 @@ public virtual Task DeleteCalendarAsync(Elastic.Clients. } /// - /// Delete events from a calendar. + /// + /// Delete events from a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -319,7 +443,9 @@ public virtual DeleteCalendarEventResponse DeleteCalendarEvent(DeleteCalendarEve } /// - /// Delete events from a calendar. + /// + /// Delete events from a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarEventAsync(DeleteCalendarEventRequest request, CancellationToken cancellationToken = default) @@ -329,7 +455,9 @@ public virtual Task DeleteCalendarEventAsync(Delete } /// - /// Delete events from a calendar. + /// + /// Delete events from a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -340,7 +468,9 @@ public virtual DeleteCalendarEventResponse DeleteCalendarEvent(DeleteCalendarEve } /// - /// Delete events from a calendar. + /// + /// Delete events from a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -352,7 +482,9 @@ public virtual DeleteCalendarEventResponse DeleteCalendarEvent(Elastic.Clients.E } /// - /// Delete events from a calendar. + /// + /// Delete events from a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -365,7 +497,9 @@ public virtual DeleteCalendarEventResponse DeleteCalendarEvent(Elastic.Clients.E } /// - /// Delete events from a calendar. + /// + /// Delete events from a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarEventAsync(DeleteCalendarEventRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -375,7 +509,9 @@ public virtual Task DeleteCalendarEventAsync(Delete } /// - /// Delete events from a calendar. + /// + /// Delete events from a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarEventAsync(Elastic.Clients.Elasticsearch.Id calendarId, Elastic.Clients.Elasticsearch.Id eventId, CancellationToken cancellationToken = default) @@ -386,7 +522,9 @@ public virtual Task DeleteCalendarEventAsync(Elasti } /// - /// Delete events from a calendar. + /// + /// Delete events from a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarEventAsync(Elastic.Clients.Elasticsearch.Id calendarId, Elastic.Clients.Elasticsearch.Id eventId, Action configureRequest, CancellationToken cancellationToken = default) @@ -398,7 +536,9 @@ public virtual Task DeleteCalendarEventAsync(Elasti } /// - /// Delete anomaly jobs from a calendar. + /// + /// Delete anomaly jobs from a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -409,7 +549,9 @@ public virtual DeleteCalendarJobResponse DeleteCalendarJob(DeleteCalendarJobRequ } /// - /// Delete anomaly jobs from a calendar. + /// + /// Delete anomaly jobs from a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarJobAsync(DeleteCalendarJobRequest request, CancellationToken cancellationToken = default) @@ -419,7 +561,9 @@ public virtual Task DeleteCalendarJobAsync(DeleteCale } /// - /// Delete anomaly jobs from a calendar. + /// + /// Delete anomaly jobs from a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -430,7 +574,9 @@ public virtual DeleteCalendarJobResponse DeleteCalendarJob(DeleteCalendarJobRequ } /// - /// Delete anomaly jobs from a calendar. + /// + /// Delete anomaly jobs from a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -442,7 +588,9 @@ public virtual DeleteCalendarJobResponse DeleteCalendarJob(Elastic.Clients.Elast } /// - /// Delete anomaly jobs from a calendar. + /// + /// Delete anomaly jobs from a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -455,7 +603,9 @@ public virtual DeleteCalendarJobResponse DeleteCalendarJob(Elastic.Clients.Elast } /// - /// Delete anomaly jobs from a calendar. + /// + /// Delete anomaly jobs from a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarJobAsync(DeleteCalendarJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -465,7 +615,9 @@ public virtual Task DeleteCalendarJobAsync(DeleteCale } /// - /// Delete anomaly jobs from a calendar. + /// + /// Delete anomaly jobs from a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarJobAsync(Elastic.Clients.Elasticsearch.Id calendarId, Elastic.Clients.Elasticsearch.Ids jobId, CancellationToken cancellationToken = default) @@ -476,7 +628,9 @@ public virtual Task DeleteCalendarJobAsync(Elastic.Cl } /// - /// Delete anomaly jobs from a calendar. + /// + /// Delete anomaly jobs from a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarJobAsync(Elastic.Clients.Elasticsearch.Id calendarId, Elastic.Clients.Elasticsearch.Ids jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -488,7 +642,9 @@ public virtual Task DeleteCalendarJobAsync(Elastic.Cl } /// - /// Delete a datafeed. + /// + /// Delete a datafeed. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -499,7 +655,9 @@ public virtual DeleteDatafeedResponse DeleteDatafeed(DeleteDatafeedRequest reque } /// - /// Delete a datafeed. + /// + /// Delete a datafeed. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDatafeedAsync(DeleteDatafeedRequest request, CancellationToken cancellationToken = default) @@ -509,7 +667,9 @@ public virtual Task DeleteDatafeedAsync(DeleteDatafeedRe } /// - /// Delete a datafeed. + /// + /// Delete a datafeed. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -520,7 +680,9 @@ public virtual DeleteDatafeedResponse DeleteDatafeed(DeleteDatafeedRequestDescri } /// - /// Delete a datafeed. + /// + /// Delete a datafeed. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -532,7 +694,9 @@ public virtual DeleteDatafeedResponse DeleteDatafeed(Elastic.Clients.Elasticsear } /// - /// Delete a datafeed. + /// + /// Delete a datafeed. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -545,7 +709,9 @@ public virtual DeleteDatafeedResponse DeleteDatafeed(Elastic.Clients.Elasticsear } /// - /// Delete a datafeed. + /// + /// Delete a datafeed. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDatafeedAsync(DeleteDatafeedRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -555,7 +721,9 @@ public virtual Task DeleteDatafeedAsync(DeleteDatafeedRe } /// - /// Delete a datafeed. + /// + /// Delete a datafeed. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDatafeedAsync(Elastic.Clients.Elasticsearch.Id datafeedId, CancellationToken cancellationToken = default) @@ -566,7 +734,9 @@ public virtual Task DeleteDatafeedAsync(Elastic.Clients. } /// - /// Delete a datafeed. + /// + /// Delete a datafeed. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDatafeedAsync(Elastic.Clients.Elasticsearch.Id datafeedId, Action configureRequest, CancellationToken cancellationToken = default) @@ -578,7 +748,9 @@ public virtual Task DeleteDatafeedAsync(Elastic.Clients. } /// - /// Delete a data frame analytics job. + /// + /// Delete a data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -589,7 +761,9 @@ public virtual DeleteDataFrameAnalyticsResponse DeleteDataFrameAnalytics(DeleteD } /// - /// Delete a data frame analytics job. + /// + /// Delete a data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataFrameAnalyticsAsync(DeleteDataFrameAnalyticsRequest request, CancellationToken cancellationToken = default) @@ -599,7 +773,9 @@ public virtual Task DeleteDataFrameAnalyticsAs } /// - /// Delete a data frame analytics job. + /// + /// Delete a data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -610,7 +786,9 @@ public virtual DeleteDataFrameAnalyticsResponse DeleteDataFrameAnalytics - /// Delete a data frame analytics job. + /// + /// Delete a data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -622,7 +800,9 @@ public virtual DeleteDataFrameAnalyticsResponse DeleteDataFrameAnalytics - /// Delete a data frame analytics job. + /// + /// Delete a data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -635,7 +815,9 @@ public virtual DeleteDataFrameAnalyticsResponse DeleteDataFrameAnalytics - /// Delete a data frame analytics job. + /// + /// Delete a data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -646,7 +828,9 @@ public virtual DeleteDataFrameAnalyticsResponse DeleteDataFrameAnalytics(DeleteD } /// - /// Delete a data frame analytics job. + /// + /// Delete a data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -658,7 +842,9 @@ public virtual DeleteDataFrameAnalyticsResponse DeleteDataFrameAnalytics(Elastic } /// - /// Delete a data frame analytics job. + /// + /// Delete a data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -671,7 +857,9 @@ public virtual DeleteDataFrameAnalyticsResponse DeleteDataFrameAnalytics(Elastic } /// - /// Delete a data frame analytics job. + /// + /// Delete a data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataFrameAnalyticsAsync(DeleteDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -681,7 +869,9 @@ public virtual Task DeleteDataFrameAnalyticsAs } /// - /// Delete a data frame analytics job. + /// + /// Delete a data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -692,7 +882,9 @@ public virtual Task DeleteDataFrameAnalyticsAs } /// - /// Delete a data frame analytics job. + /// + /// Delete a data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -704,7 +896,9 @@ public virtual Task DeleteDataFrameAnalyticsAs } /// - /// Delete a data frame analytics job. + /// + /// Delete a data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataFrameAnalyticsAsync(DeleteDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -714,7 +908,9 @@ public virtual Task DeleteDataFrameAnalyticsAs } /// - /// Delete a data frame analytics job. + /// + /// Delete a data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -725,7 +921,9 @@ public virtual Task DeleteDataFrameAnalyticsAs } /// - /// Delete a data frame analytics job. + /// + /// Delete a data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -737,7 +935,17 @@ public virtual Task DeleteDataFrameAnalyticsAs } /// - /// Delete expired ML data.
Deletes all job results, model snapshots and forecast data that have exceeded
their retention days period. Machine learning state documents that are not
associated with any job are also deleted.
You can limit the request to a single or set of anomaly detection jobs by
using a job identifier, a group name, a comma-separated list of jobs, or a
wildcard expression. You can delete expired data for all anomaly detection
jobs by using _all, by specifying * as the , or by omitting the
. + /// + /// Delete expired ML data. + /// Deletes all job results, model snapshots and forecast data that have exceeded + /// their retention days period. Machine learning state documents that are not + /// associated with any job are also deleted. + /// You can limit the request to a single or set of anomaly detection jobs by + /// using a job identifier, a group name, a comma-separated list of jobs, or a + /// wildcard expression. You can delete expired data for all anomaly detection + /// jobs by using _all, by specifying * as the <job_id>, or by omitting the + /// <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -748,7 +956,17 @@ public virtual DeleteExpiredDataResponse DeleteExpiredData(DeleteExpiredDataRequ } /// - /// Delete expired ML data.
Deletes all job results, model snapshots and forecast data that have exceeded
their retention days period. Machine learning state documents that are not
associated with any job are also deleted.
You can limit the request to a single or set of anomaly detection jobs by
using a job identifier, a group name, a comma-separated list of jobs, or a
wildcard expression. You can delete expired data for all anomaly detection
jobs by using _all, by specifying * as the , or by omitting the
. + /// + /// Delete expired ML data. + /// Deletes all job results, model snapshots and forecast data that have exceeded + /// their retention days period. Machine learning state documents that are not + /// associated with any job are also deleted. + /// You can limit the request to a single or set of anomaly detection jobs by + /// using a job identifier, a group name, a comma-separated list of jobs, or a + /// wildcard expression. You can delete expired data for all anomaly detection + /// jobs by using _all, by specifying * as the <job_id>, or by omitting the + /// <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteExpiredDataAsync(DeleteExpiredDataRequest request, CancellationToken cancellationToken = default) @@ -758,7 +976,17 @@ public virtual Task DeleteExpiredDataAsync(DeleteExpi } /// - /// Delete expired ML data.
Deletes all job results, model snapshots and forecast data that have exceeded
their retention days period. Machine learning state documents that are not
associated with any job are also deleted.
You can limit the request to a single or set of anomaly detection jobs by
using a job identifier, a group name, a comma-separated list of jobs, or a
wildcard expression. You can delete expired data for all anomaly detection
jobs by using _all, by specifying * as the , or by omitting the
. + /// + /// Delete expired ML data. + /// Deletes all job results, model snapshots and forecast data that have exceeded + /// their retention days period. Machine learning state documents that are not + /// associated with any job are also deleted. + /// You can limit the request to a single or set of anomaly detection jobs by + /// using a job identifier, a group name, a comma-separated list of jobs, or a + /// wildcard expression. You can delete expired data for all anomaly detection + /// jobs by using _all, by specifying * as the <job_id>, or by omitting the + /// <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -769,7 +997,17 @@ public virtual DeleteExpiredDataResponse DeleteExpiredData(DeleteExpiredDataRequ } /// - /// Delete expired ML data.
Deletes all job results, model snapshots and forecast data that have exceeded
their retention days period. Machine learning state documents that are not
associated with any job are also deleted.
You can limit the request to a single or set of anomaly detection jobs by
using a job identifier, a group name, a comma-separated list of jobs, or a
wildcard expression. You can delete expired data for all anomaly detection
jobs by using _all, by specifying * as the , or by omitting the
. + /// + /// Delete expired ML data. + /// Deletes all job results, model snapshots and forecast data that have exceeded + /// their retention days period. Machine learning state documents that are not + /// associated with any job are also deleted. + /// You can limit the request to a single or set of anomaly detection jobs by + /// using a job identifier, a group name, a comma-separated list of jobs, or a + /// wildcard expression. You can delete expired data for all anomaly detection + /// jobs by using _all, by specifying * as the <job_id>, or by omitting the + /// <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -781,7 +1019,17 @@ public virtual DeleteExpiredDataResponse DeleteExpiredData(Elastic.Clients.Elast } /// - /// Delete expired ML data.
Deletes all job results, model snapshots and forecast data that have exceeded
their retention days period. Machine learning state documents that are not
associated with any job are also deleted.
You can limit the request to a single or set of anomaly detection jobs by
using a job identifier, a group name, a comma-separated list of jobs, or a
wildcard expression. You can delete expired data for all anomaly detection
jobs by using _all, by specifying * as the , or by omitting the
. + /// + /// Delete expired ML data. + /// Deletes all job results, model snapshots and forecast data that have exceeded + /// their retention days period. Machine learning state documents that are not + /// associated with any job are also deleted. + /// You can limit the request to a single or set of anomaly detection jobs by + /// using a job identifier, a group name, a comma-separated list of jobs, or a + /// wildcard expression. You can delete expired data for all anomaly detection + /// jobs by using _all, by specifying * as the <job_id>, or by omitting the + /// <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -794,7 +1042,17 @@ public virtual DeleteExpiredDataResponse DeleteExpiredData(Elastic.Clients.Elast } /// - /// Delete expired ML data.
Deletes all job results, model snapshots and forecast data that have exceeded
their retention days period. Machine learning state documents that are not
associated with any job are also deleted.
You can limit the request to a single or set of anomaly detection jobs by
using a job identifier, a group name, a comma-separated list of jobs, or a
wildcard expression. You can delete expired data for all anomaly detection
jobs by using _all, by specifying * as the , or by omitting the
. + /// + /// Delete expired ML data. + /// Deletes all job results, model snapshots and forecast data that have exceeded + /// their retention days period. Machine learning state documents that are not + /// associated with any job are also deleted. + /// You can limit the request to a single or set of anomaly detection jobs by + /// using a job identifier, a group name, a comma-separated list of jobs, or a + /// wildcard expression. You can delete expired data for all anomaly detection + /// jobs by using _all, by specifying * as the <job_id>, or by omitting the + /// <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -806,7 +1064,17 @@ public virtual DeleteExpiredDataResponse DeleteExpiredData() } /// - /// Delete expired ML data.
Deletes all job results, model snapshots and forecast data that have exceeded
their retention days period. Machine learning state documents that are not
associated with any job are also deleted.
You can limit the request to a single or set of anomaly detection jobs by
using a job identifier, a group name, a comma-separated list of jobs, or a
wildcard expression. You can delete expired data for all anomaly detection
jobs by using _all, by specifying * as the , or by omitting the
. + /// + /// Delete expired ML data. + /// Deletes all job results, model snapshots and forecast data that have exceeded + /// their retention days period. Machine learning state documents that are not + /// associated with any job are also deleted. + /// You can limit the request to a single or set of anomaly detection jobs by + /// using a job identifier, a group name, a comma-separated list of jobs, or a + /// wildcard expression. You can delete expired data for all anomaly detection + /// jobs by using _all, by specifying * as the <job_id>, or by omitting the + /// <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -819,7 +1087,17 @@ public virtual DeleteExpiredDataResponse DeleteExpiredData(Action - /// Delete expired ML data.
Deletes all job results, model snapshots and forecast data that have exceeded
their retention days period. Machine learning state documents that are not
associated with any job are also deleted.
You can limit the request to a single or set of anomaly detection jobs by
using a job identifier, a group name, a comma-separated list of jobs, or a
wildcard expression. You can delete expired data for all anomaly detection
jobs by using _all, by specifying * as the , or by omitting the
. + /// + /// Delete expired ML data. + /// Deletes all job results, model snapshots and forecast data that have exceeded + /// their retention days period. Machine learning state documents that are not + /// associated with any job are also deleted. + /// You can limit the request to a single or set of anomaly detection jobs by + /// using a job identifier, a group name, a comma-separated list of jobs, or a + /// wildcard expression. You can delete expired data for all anomaly detection + /// jobs by using _all, by specifying * as the <job_id>, or by omitting the + /// <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteExpiredDataAsync(DeleteExpiredDataRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -829,7 +1107,17 @@ public virtual Task DeleteExpiredDataAsync(DeleteExpi } /// - /// Delete expired ML data.
Deletes all job results, model snapshots and forecast data that have exceeded
their retention days period. Machine learning state documents that are not
associated with any job are also deleted.
You can limit the request to a single or set of anomaly detection jobs by
using a job identifier, a group name, a comma-separated list of jobs, or a
wildcard expression. You can delete expired data for all anomaly detection
jobs by using _all, by specifying * as the , or by omitting the
. + /// + /// Delete expired ML data. + /// Deletes all job results, model snapshots and forecast data that have exceeded + /// their retention days period. Machine learning state documents that are not + /// associated with any job are also deleted. + /// You can limit the request to a single or set of anomaly detection jobs by + /// using a job identifier, a group name, a comma-separated list of jobs, or a + /// wildcard expression. You can delete expired data for all anomaly detection + /// jobs by using _all, by specifying * as the <job_id>, or by omitting the + /// <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteExpiredDataAsync(Elastic.Clients.Elasticsearch.Id? jobId, CancellationToken cancellationToken = default) @@ -840,7 +1128,17 @@ public virtual Task DeleteExpiredDataAsync(Elastic.Cl } /// - /// Delete expired ML data.
Deletes all job results, model snapshots and forecast data that have exceeded
their retention days period. Machine learning state documents that are not
associated with any job are also deleted.
You can limit the request to a single or set of anomaly detection jobs by
using a job identifier, a group name, a comma-separated list of jobs, or a
wildcard expression. You can delete expired data for all anomaly detection
jobs by using _all, by specifying * as the , or by omitting the
. + /// + /// Delete expired ML data. + /// Deletes all job results, model snapshots and forecast data that have exceeded + /// their retention days period. Machine learning state documents that are not + /// associated with any job are also deleted. + /// You can limit the request to a single or set of anomaly detection jobs by + /// using a job identifier, a group name, a comma-separated list of jobs, or a + /// wildcard expression. You can delete expired data for all anomaly detection + /// jobs by using _all, by specifying * as the <job_id>, or by omitting the + /// <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteExpiredDataAsync(Elastic.Clients.Elasticsearch.Id? jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -852,7 +1150,17 @@ public virtual Task DeleteExpiredDataAsync(Elastic.Cl } /// - /// Delete expired ML data.
Deletes all job results, model snapshots and forecast data that have exceeded
their retention days period. Machine learning state documents that are not
associated with any job are also deleted.
You can limit the request to a single or set of anomaly detection jobs by
using a job identifier, a group name, a comma-separated list of jobs, or a
wildcard expression. You can delete expired data for all anomaly detection
jobs by using _all, by specifying * as the , or by omitting the
. + /// + /// Delete expired ML data. + /// Deletes all job results, model snapshots and forecast data that have exceeded + /// their retention days period. Machine learning state documents that are not + /// associated with any job are also deleted. + /// You can limit the request to a single or set of anomaly detection jobs by + /// using a job identifier, a group name, a comma-separated list of jobs, or a + /// wildcard expression. You can delete expired data for all anomaly detection + /// jobs by using _all, by specifying * as the <job_id>, or by omitting the + /// <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteExpiredDataAsync(CancellationToken cancellationToken = default) @@ -863,7 +1171,17 @@ public virtual Task DeleteExpiredDataAsync(Cancellati } /// - /// Delete expired ML data.
Deletes all job results, model snapshots and forecast data that have exceeded
their retention days period. Machine learning state documents that are not
associated with any job are also deleted.
You can limit the request to a single or set of anomaly detection jobs by
using a job identifier, a group name, a comma-separated list of jobs, or a
wildcard expression. You can delete expired data for all anomaly detection
jobs by using _all, by specifying * as the , or by omitting the
. + /// + /// Delete expired ML data. + /// Deletes all job results, model snapshots and forecast data that have exceeded + /// their retention days period. Machine learning state documents that are not + /// associated with any job are also deleted. + /// You can limit the request to a single or set of anomaly detection jobs by + /// using a job identifier, a group name, a comma-separated list of jobs, or a + /// wildcard expression. You can delete expired data for all anomaly detection + /// jobs by using _all, by specifying * as the <job_id>, or by omitting the + /// <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteExpiredDataAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -875,7 +1193,11 @@ public virtual Task DeleteExpiredDataAsync(Action - /// Delete a filter.
If an anomaly detection job references the filter, you cannot delete the
filter. You must update or delete the job before you can delete the filter. + /// + /// Delete a filter. + /// If an anomaly detection job references the filter, you cannot delete the + /// filter. You must update or delete the job before you can delete the filter. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -886,7 +1208,11 @@ public virtual DeleteFilterResponse DeleteFilter(DeleteFilterRequest request) } /// - /// Delete a filter.
If an anomaly detection job references the filter, you cannot delete the
filter. You must update or delete the job before you can delete the filter. + /// + /// Delete a filter. + /// If an anomaly detection job references the filter, you cannot delete the + /// filter. You must update or delete the job before you can delete the filter. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteFilterAsync(DeleteFilterRequest request, CancellationToken cancellationToken = default) @@ -896,7 +1222,11 @@ public virtual Task DeleteFilterAsync(DeleteFilterRequest } /// - /// Delete a filter.
If an anomaly detection job references the filter, you cannot delete the
filter. You must update or delete the job before you can delete the filter. + /// + /// Delete a filter. + /// If an anomaly detection job references the filter, you cannot delete the + /// filter. You must update or delete the job before you can delete the filter. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -907,7 +1237,11 @@ public virtual DeleteFilterResponse DeleteFilter(DeleteFilterRequestDescriptor d } /// - /// Delete a filter.
If an anomaly detection job references the filter, you cannot delete the
filter. You must update or delete the job before you can delete the filter. + /// + /// Delete a filter. + /// If an anomaly detection job references the filter, you cannot delete the + /// filter. You must update or delete the job before you can delete the filter. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -919,7 +1253,11 @@ public virtual DeleteFilterResponse DeleteFilter(Elastic.Clients.Elasticsearch.I } /// - /// Delete a filter.
If an anomaly detection job references the filter, you cannot delete the
filter. You must update or delete the job before you can delete the filter. + /// + /// Delete a filter. + /// If an anomaly detection job references the filter, you cannot delete the + /// filter. You must update or delete the job before you can delete the filter. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -932,7 +1270,11 @@ public virtual DeleteFilterResponse DeleteFilter(Elastic.Clients.Elasticsearch.I } /// - /// Delete a filter.
If an anomaly detection job references the filter, you cannot delete the
filter. You must update or delete the job before you can delete the filter. + /// + /// Delete a filter. + /// If an anomaly detection job references the filter, you cannot delete the + /// filter. You must update or delete the job before you can delete the filter. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteFilterAsync(DeleteFilterRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -942,7 +1284,11 @@ public virtual Task DeleteFilterAsync(DeleteFilterRequestD } /// - /// Delete a filter.
If an anomaly detection job references the filter, you cannot delete the
filter. You must update or delete the job before you can delete the filter. + /// + /// Delete a filter. + /// If an anomaly detection job references the filter, you cannot delete the + /// filter. You must update or delete the job before you can delete the filter. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteFilterAsync(Elastic.Clients.Elasticsearch.Id filterId, CancellationToken cancellationToken = default) @@ -953,7 +1299,11 @@ public virtual Task DeleteFilterAsync(Elastic.Clients.Elas } /// - /// Delete a filter.
If an anomaly detection job references the filter, you cannot delete the
filter. You must update or delete the job before you can delete the filter. + /// + /// Delete a filter. + /// If an anomaly detection job references the filter, you cannot delete the + /// filter. You must update or delete the job before you can delete the filter. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteFilterAsync(Elastic.Clients.Elasticsearch.Id filterId, Action configureRequest, CancellationToken cancellationToken = default) @@ -965,7 +1315,13 @@ public virtual Task DeleteFilterAsync(Elastic.Clients.Elas } /// - /// Delete forecasts from a job.
By default, forecasts are retained for 14 days. You can specify a
different retention period with the `expires_in` parameter in the forecast
jobs API. The delete forecast API enables you to delete one or more
forecasts before they expire. + /// + /// Delete forecasts from a job. + /// By default, forecasts are retained for 14 days. You can specify a + /// different retention period with the expires_in parameter in the forecast + /// jobs API. The delete forecast API enables you to delete one or more + /// forecasts before they expire. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -976,7 +1332,13 @@ public virtual DeleteForecastResponse DeleteForecast(DeleteForecastRequest reque } /// - /// Delete forecasts from a job.
By default, forecasts are retained for 14 days. You can specify a
different retention period with the `expires_in` parameter in the forecast
jobs API. The delete forecast API enables you to delete one or more
forecasts before they expire. + /// + /// Delete forecasts from a job. + /// By default, forecasts are retained for 14 days. You can specify a + /// different retention period with the expires_in parameter in the forecast + /// jobs API. The delete forecast API enables you to delete one or more + /// forecasts before they expire. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteForecastAsync(DeleteForecastRequest request, CancellationToken cancellationToken = default) @@ -986,7 +1348,13 @@ public virtual Task DeleteForecastAsync(DeleteForecastRe } /// - /// Delete forecasts from a job.
By default, forecasts are retained for 14 days. You can specify a
different retention period with the `expires_in` parameter in the forecast
jobs API. The delete forecast API enables you to delete one or more
forecasts before they expire. + /// + /// Delete forecasts from a job. + /// By default, forecasts are retained for 14 days. You can specify a + /// different retention period with the expires_in parameter in the forecast + /// jobs API. The delete forecast API enables you to delete one or more + /// forecasts before they expire. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -997,7 +1365,13 @@ public virtual DeleteForecastResponse DeleteForecast(DeleteForecastRequestDescri } /// - /// Delete forecasts from a job.
By default, forecasts are retained for 14 days. You can specify a
different retention period with the `expires_in` parameter in the forecast
jobs API. The delete forecast API enables you to delete one or more
forecasts before they expire. + /// + /// Delete forecasts from a job. + /// By default, forecasts are retained for 14 days. You can specify a + /// different retention period with the expires_in parameter in the forecast + /// jobs API. The delete forecast API enables you to delete one or more + /// forecasts before they expire. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1009,7 +1383,13 @@ public virtual DeleteForecastResponse DeleteForecast(Elastic.Clients.Elasticsear } /// - /// Delete forecasts from a job.
By default, forecasts are retained for 14 days. You can specify a
different retention period with the `expires_in` parameter in the forecast
jobs API. The delete forecast API enables you to delete one or more
forecasts before they expire. + /// + /// Delete forecasts from a job. + /// By default, forecasts are retained for 14 days. You can specify a + /// different retention period with the expires_in parameter in the forecast + /// jobs API. The delete forecast API enables you to delete one or more + /// forecasts before they expire. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1022,7 +1402,13 @@ public virtual DeleteForecastResponse DeleteForecast(Elastic.Clients.Elasticsear } /// - /// Delete forecasts from a job.
By default, forecasts are retained for 14 days. You can specify a
different retention period with the `expires_in` parameter in the forecast
jobs API. The delete forecast API enables you to delete one or more
forecasts before they expire. + /// + /// Delete forecasts from a job. + /// By default, forecasts are retained for 14 days. You can specify a + /// different retention period with the expires_in parameter in the forecast + /// jobs API. The delete forecast API enables you to delete one or more + /// forecasts before they expire. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1034,7 +1420,13 @@ public virtual DeleteForecastResponse DeleteForecast(Elastic.Clients.Elasticsear } /// - /// Delete forecasts from a job.
By default, forecasts are retained for 14 days. You can specify a
different retention period with the `expires_in` parameter in the forecast
jobs API. The delete forecast API enables you to delete one or more
forecasts before they expire. + /// + /// Delete forecasts from a job. + /// By default, forecasts are retained for 14 days. You can specify a + /// different retention period with the expires_in parameter in the forecast + /// jobs API. The delete forecast API enables you to delete one or more + /// forecasts before they expire. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1047,7 +1439,13 @@ public virtual DeleteForecastResponse DeleteForecast(Elastic.Clients.Elasticsear } /// - /// Delete forecasts from a job.
By default, forecasts are retained for 14 days. You can specify a
different retention period with the `expires_in` parameter in the forecast
jobs API. The delete forecast API enables you to delete one or more
forecasts before they expire. + /// + /// Delete forecasts from a job. + /// By default, forecasts are retained for 14 days. You can specify a + /// different retention period with the expires_in parameter in the forecast + /// jobs API. The delete forecast API enables you to delete one or more + /// forecasts before they expire. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteForecastAsync(DeleteForecastRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1057,7 +1455,13 @@ public virtual Task DeleteForecastAsync(DeleteForecastRe } /// - /// Delete forecasts from a job.
By default, forecasts are retained for 14 days. You can specify a
different retention period with the `expires_in` parameter in the forecast
jobs API. The delete forecast API enables you to delete one or more
forecasts before they expire. + /// + /// Delete forecasts from a job. + /// By default, forecasts are retained for 14 days. You can specify a + /// different retention period with the expires_in parameter in the forecast + /// jobs API. The delete forecast API enables you to delete one or more + /// forecasts before they expire. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteForecastAsync(Elastic.Clients.Elasticsearch.Id jobId, Elastic.Clients.Elasticsearch.Id? forecastId, CancellationToken cancellationToken = default) @@ -1068,7 +1472,13 @@ public virtual Task DeleteForecastAsync(Elastic.Clients. } /// - /// Delete forecasts from a job.
By default, forecasts are retained for 14 days. You can specify a
different retention period with the `expires_in` parameter in the forecast
jobs API. The delete forecast API enables you to delete one or more
forecasts before they expire. + /// + /// Delete forecasts from a job. + /// By default, forecasts are retained for 14 days. You can specify a + /// different retention period with the expires_in parameter in the forecast + /// jobs API. The delete forecast API enables you to delete one or more + /// forecasts before they expire. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteForecastAsync(Elastic.Clients.Elasticsearch.Id jobId, Elastic.Clients.Elasticsearch.Id? forecastId, Action configureRequest, CancellationToken cancellationToken = default) @@ -1080,7 +1490,13 @@ public virtual Task DeleteForecastAsync(Elastic.Clients. } /// - /// Delete forecasts from a job.
By default, forecasts are retained for 14 days. You can specify a
different retention period with the `expires_in` parameter in the forecast
jobs API. The delete forecast API enables you to delete one or more
forecasts before they expire. + /// + /// Delete forecasts from a job. + /// By default, forecasts are retained for 14 days. You can specify a + /// different retention period with the expires_in parameter in the forecast + /// jobs API. The delete forecast API enables you to delete one or more + /// forecasts before they expire. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteForecastAsync(Elastic.Clients.Elasticsearch.Id jobId, CancellationToken cancellationToken = default) @@ -1091,7 +1507,13 @@ public virtual Task DeleteForecastAsync(Elastic.Clients. } /// - /// Delete forecasts from a job.
By default, forecasts are retained for 14 days. You can specify a
different retention period with the `expires_in` parameter in the forecast
jobs API. The delete forecast API enables you to delete one or more
forecasts before they expire. + /// + /// Delete forecasts from a job. + /// By default, forecasts are retained for 14 days. You can specify a + /// different retention period with the expires_in parameter in the forecast + /// jobs API. The delete forecast API enables you to delete one or more + /// forecasts before they expire. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteForecastAsync(Elastic.Clients.Elasticsearch.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -1103,7 +1525,15 @@ public virtual Task DeleteForecastAsync(Elastic.Clients. } /// - /// Delete an anomaly detection job.
All job configuration, model state and results are deleted.
It is not currently possible to delete multiple jobs using wildcards or a
comma separated list. If you delete a job that has a datafeed, the request
first tries to delete the datafeed. This behavior is equivalent to calling
the delete datafeed API with the same timeout and force parameters as the
delete job request. + /// + /// Delete an anomaly detection job. + /// All job configuration, model state and results are deleted. + /// It is not currently possible to delete multiple jobs using wildcards or a + /// comma separated list. If you delete a job that has a datafeed, the request + /// first tries to delete the datafeed. This behavior is equivalent to calling + /// the delete datafeed API with the same timeout and force parameters as the + /// delete job request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1114,7 +1544,15 @@ public virtual DeleteJobResponse DeleteJob(DeleteJobRequest request) } /// - /// Delete an anomaly detection job.
All job configuration, model state and results are deleted.
It is not currently possible to delete multiple jobs using wildcards or a
comma separated list. If you delete a job that has a datafeed, the request
first tries to delete the datafeed. This behavior is equivalent to calling
the delete datafeed API with the same timeout and force parameters as the
delete job request. + /// + /// Delete an anomaly detection job. + /// All job configuration, model state and results are deleted. + /// It is not currently possible to delete multiple jobs using wildcards or a + /// comma separated list. If you delete a job that has a datafeed, the request + /// first tries to delete the datafeed. This behavior is equivalent to calling + /// the delete datafeed API with the same timeout and force parameters as the + /// delete job request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteJobAsync(DeleteJobRequest request, CancellationToken cancellationToken = default) @@ -1124,7 +1562,15 @@ public virtual Task DeleteJobAsync(DeleteJobRequest request, } /// - /// Delete an anomaly detection job.
All job configuration, model state and results are deleted.
It is not currently possible to delete multiple jobs using wildcards or a
comma separated list. If you delete a job that has a datafeed, the request
first tries to delete the datafeed. This behavior is equivalent to calling
the delete datafeed API with the same timeout and force parameters as the
delete job request. + /// + /// Delete an anomaly detection job. + /// All job configuration, model state and results are deleted. + /// It is not currently possible to delete multiple jobs using wildcards or a + /// comma separated list. If you delete a job that has a datafeed, the request + /// first tries to delete the datafeed. This behavior is equivalent to calling + /// the delete datafeed API with the same timeout and force parameters as the + /// delete job request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1135,7 +1581,15 @@ public virtual DeleteJobResponse DeleteJob(DeleteJobRequestDescriptor descriptor } /// - /// Delete an anomaly detection job.
All job configuration, model state and results are deleted.
It is not currently possible to delete multiple jobs using wildcards or a
comma separated list. If you delete a job that has a datafeed, the request
first tries to delete the datafeed. This behavior is equivalent to calling
the delete datafeed API with the same timeout and force parameters as the
delete job request. + /// + /// Delete an anomaly detection job. + /// All job configuration, model state and results are deleted. + /// It is not currently possible to delete multiple jobs using wildcards or a + /// comma separated list. If you delete a job that has a datafeed, the request + /// first tries to delete the datafeed. This behavior is equivalent to calling + /// the delete datafeed API with the same timeout and force parameters as the + /// delete job request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1147,7 +1601,15 @@ public virtual DeleteJobResponse DeleteJob(Elastic.Clients.Elasticsearch.Id jobI } /// - /// Delete an anomaly detection job.
All job configuration, model state and results are deleted.
It is not currently possible to delete multiple jobs using wildcards or a
comma separated list. If you delete a job that has a datafeed, the request
first tries to delete the datafeed. This behavior is equivalent to calling
the delete datafeed API with the same timeout and force parameters as the
delete job request. + /// + /// Delete an anomaly detection job. + /// All job configuration, model state and results are deleted. + /// It is not currently possible to delete multiple jobs using wildcards or a + /// comma separated list. If you delete a job that has a datafeed, the request + /// first tries to delete the datafeed. This behavior is equivalent to calling + /// the delete datafeed API with the same timeout and force parameters as the + /// delete job request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1160,7 +1622,15 @@ public virtual DeleteJobResponse DeleteJob(Elastic.Clients.Elasticsearch.Id jobI } /// - /// Delete an anomaly detection job.
All job configuration, model state and results are deleted.
It is not currently possible to delete multiple jobs using wildcards or a
comma separated list. If you delete a job that has a datafeed, the request
first tries to delete the datafeed. This behavior is equivalent to calling
the delete datafeed API with the same timeout and force parameters as the
delete job request. + /// + /// Delete an anomaly detection job. + /// All job configuration, model state and results are deleted. + /// It is not currently possible to delete multiple jobs using wildcards or a + /// comma separated list. If you delete a job that has a datafeed, the request + /// first tries to delete the datafeed. This behavior is equivalent to calling + /// the delete datafeed API with the same timeout and force parameters as the + /// delete job request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteJobAsync(DeleteJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1170,7 +1640,15 @@ public virtual Task DeleteJobAsync(DeleteJobRequestDescriptor } /// - /// Delete an anomaly detection job.
All job configuration, model state and results are deleted.
It is not currently possible to delete multiple jobs using wildcards or a
comma separated list. If you delete a job that has a datafeed, the request
first tries to delete the datafeed. This behavior is equivalent to calling
the delete datafeed API with the same timeout and force parameters as the
delete job request. + /// + /// Delete an anomaly detection job. + /// All job configuration, model state and results are deleted. + /// It is not currently possible to delete multiple jobs using wildcards or a + /// comma separated list. If you delete a job that has a datafeed, the request + /// first tries to delete the datafeed. This behavior is equivalent to calling + /// the delete datafeed API with the same timeout and force parameters as the + /// delete job request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteJobAsync(Elastic.Clients.Elasticsearch.Id jobId, CancellationToken cancellationToken = default) @@ -1181,7 +1659,15 @@ public virtual Task DeleteJobAsync(Elastic.Clients.Elasticsea } /// - /// Delete an anomaly detection job.
All job configuration, model state and results are deleted.
It is not currently possible to delete multiple jobs using wildcards or a
comma separated list. If you delete a job that has a datafeed, the request
first tries to delete the datafeed. This behavior is equivalent to calling
the delete datafeed API with the same timeout and force parameters as the
delete job request. + /// + /// Delete an anomaly detection job. + /// All job configuration, model state and results are deleted. + /// It is not currently possible to delete multiple jobs using wildcards or a + /// comma separated list. If you delete a job that has a datafeed, the request + /// first tries to delete the datafeed. This behavior is equivalent to calling + /// the delete datafeed API with the same timeout and force parameters as the + /// delete job request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteJobAsync(Elastic.Clients.Elasticsearch.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -1193,7 +1679,12 @@ public virtual Task DeleteJobAsync(Elastic.Clients.Elasticsea } /// - /// Delete a model snapshot.
You cannot delete the active model snapshot. To delete that snapshot, first
revert to a different one. To identify the active model snapshot, refer to
the `model_snapshot_id` in the results from the get jobs API. + /// + /// Delete a model snapshot. + /// You cannot delete the active model snapshot. To delete that snapshot, first + /// revert to a different one. To identify the active model snapshot, refer to + /// the model_snapshot_id in the results from the get jobs API. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1204,7 +1695,12 @@ public virtual DeleteModelSnapshotResponse DeleteModelSnapshot(DeleteModelSnapsh } /// - /// Delete a model snapshot.
You cannot delete the active model snapshot. To delete that snapshot, first
revert to a different one. To identify the active model snapshot, refer to
the `model_snapshot_id` in the results from the get jobs API. + /// + /// Delete a model snapshot. + /// You cannot delete the active model snapshot. To delete that snapshot, first + /// revert to a different one. To identify the active model snapshot, refer to + /// the model_snapshot_id in the results from the get jobs API. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteModelSnapshotAsync(DeleteModelSnapshotRequest request, CancellationToken cancellationToken = default) @@ -1214,7 +1710,12 @@ public virtual Task DeleteModelSnapshotAsync(Delete } /// - /// Delete a model snapshot.
You cannot delete the active model snapshot. To delete that snapshot, first
revert to a different one. To identify the active model snapshot, refer to
the `model_snapshot_id` in the results from the get jobs API. + /// + /// Delete a model snapshot. + /// You cannot delete the active model snapshot. To delete that snapshot, first + /// revert to a different one. To identify the active model snapshot, refer to + /// the model_snapshot_id in the results from the get jobs API. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1225,7 +1726,12 @@ public virtual DeleteModelSnapshotResponse DeleteModelSnapshot(DeleteModelSnapsh } /// - /// Delete a model snapshot.
You cannot delete the active model snapshot. To delete that snapshot, first
revert to a different one. To identify the active model snapshot, refer to
the `model_snapshot_id` in the results from the get jobs API. + /// + /// Delete a model snapshot. + /// You cannot delete the active model snapshot. To delete that snapshot, first + /// revert to a different one. To identify the active model snapshot, refer to + /// the model_snapshot_id in the results from the get jobs API. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1237,7 +1743,12 @@ public virtual DeleteModelSnapshotResponse DeleteModelSnapshot(Elastic.Clients.E } /// - /// Delete a model snapshot.
You cannot delete the active model snapshot. To delete that snapshot, first
revert to a different one. To identify the active model snapshot, refer to
the `model_snapshot_id` in the results from the get jobs API. + /// + /// Delete a model snapshot. + /// You cannot delete the active model snapshot. To delete that snapshot, first + /// revert to a different one. To identify the active model snapshot, refer to + /// the model_snapshot_id in the results from the get jobs API. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1250,7 +1761,12 @@ public virtual DeleteModelSnapshotResponse DeleteModelSnapshot(Elastic.Clients.E } /// - /// Delete a model snapshot.
You cannot delete the active model snapshot. To delete that snapshot, first
revert to a different one. To identify the active model snapshot, refer to
the `model_snapshot_id` in the results from the get jobs API. + /// + /// Delete a model snapshot. + /// You cannot delete the active model snapshot. To delete that snapshot, first + /// revert to a different one. To identify the active model snapshot, refer to + /// the model_snapshot_id in the results from the get jobs API. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteModelSnapshotAsync(DeleteModelSnapshotRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1260,7 +1776,12 @@ public virtual Task DeleteModelSnapshotAsync(Delete } /// - /// Delete a model snapshot.
You cannot delete the active model snapshot. To delete that snapshot, first
revert to a different one. To identify the active model snapshot, refer to
the `model_snapshot_id` in the results from the get jobs API. + /// + /// Delete a model snapshot. + /// You cannot delete the active model snapshot. To delete that snapshot, first + /// revert to a different one. To identify the active model snapshot, refer to + /// the model_snapshot_id in the results from the get jobs API. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteModelSnapshotAsync(Elastic.Clients.Elasticsearch.Id jobId, Elastic.Clients.Elasticsearch.Id snapshotId, CancellationToken cancellationToken = default) @@ -1271,7 +1792,12 @@ public virtual Task DeleteModelSnapshotAsync(Elasti } /// - /// Delete a model snapshot.
You cannot delete the active model snapshot. To delete that snapshot, first
revert to a different one. To identify the active model snapshot, refer to
the `model_snapshot_id` in the results from the get jobs API. + /// + /// Delete a model snapshot. + /// You cannot delete the active model snapshot. To delete that snapshot, first + /// revert to a different one. To identify the active model snapshot, refer to + /// the model_snapshot_id in the results from the get jobs API. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteModelSnapshotAsync(Elastic.Clients.Elasticsearch.Id jobId, Elastic.Clients.Elasticsearch.Id snapshotId, Action configureRequest, CancellationToken cancellationToken = default) @@ -1283,7 +1809,10 @@ public virtual Task DeleteModelSnapshotAsync(Elasti } /// - /// Delete an unreferenced trained model.
The request deletes a trained inference model that is not referenced by an ingest pipeline. + /// + /// Delete an unreferenced trained model. + /// The request deletes a trained inference model that is not referenced by an ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1294,7 +1823,10 @@ public virtual DeleteTrainedModelResponse DeleteTrainedModel(DeleteTrainedModelR } /// - /// Delete an unreferenced trained model.
The request deletes a trained inference model that is not referenced by an ingest pipeline. + /// + /// Delete an unreferenced trained model. + /// The request deletes a trained inference model that is not referenced by an ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteTrainedModelAsync(DeleteTrainedModelRequest request, CancellationToken cancellationToken = default) @@ -1304,7 +1836,10 @@ public virtual Task DeleteTrainedModelAsync(DeleteTr } /// - /// Delete an unreferenced trained model.
The request deletes a trained inference model that is not referenced by an ingest pipeline. + /// + /// Delete an unreferenced trained model. + /// The request deletes a trained inference model that is not referenced by an ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1315,7 +1850,10 @@ public virtual DeleteTrainedModelResponse DeleteTrainedModel(DeleteTrainedModelR } /// - /// Delete an unreferenced trained model.
The request deletes a trained inference model that is not referenced by an ingest pipeline. + /// + /// Delete an unreferenced trained model. + /// The request deletes a trained inference model that is not referenced by an ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1327,7 +1865,10 @@ public virtual DeleteTrainedModelResponse DeleteTrainedModel(Elastic.Clients.Ela } /// - /// Delete an unreferenced trained model.
The request deletes a trained inference model that is not referenced by an ingest pipeline. + /// + /// Delete an unreferenced trained model. + /// The request deletes a trained inference model that is not referenced by an ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1340,7 +1881,10 @@ public virtual DeleteTrainedModelResponse DeleteTrainedModel(Elastic.Clients.Ela } /// - /// Delete an unreferenced trained model.
The request deletes a trained inference model that is not referenced by an ingest pipeline. + /// + /// Delete an unreferenced trained model. + /// The request deletes a trained inference model that is not referenced by an ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteTrainedModelAsync(DeleteTrainedModelRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1350,7 +1894,10 @@ public virtual Task DeleteTrainedModelAsync(DeleteTr } /// - /// Delete an unreferenced trained model.
The request deletes a trained inference model that is not referenced by an ingest pipeline. + /// + /// Delete an unreferenced trained model. + /// The request deletes a trained inference model that is not referenced by an ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteTrainedModelAsync(Elastic.Clients.Elasticsearch.Id modelId, CancellationToken cancellationToken = default) @@ -1361,7 +1908,10 @@ public virtual Task DeleteTrainedModelAsync(Elastic. } /// - /// Delete an unreferenced trained model.
The request deletes a trained inference model that is not referenced by an ingest pipeline. + /// + /// Delete an unreferenced trained model. + /// The request deletes a trained inference model that is not referenced by an ingest pipeline. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteTrainedModelAsync(Elastic.Clients.Elasticsearch.Id modelId, Action configureRequest, CancellationToken cancellationToken = default) @@ -1373,7 +1923,12 @@ public virtual Task DeleteTrainedModelAsync(Elastic. } /// - /// Delete a trained model alias.
This API deletes an existing model alias that refers to a trained model. If
the model alias is missing or refers to a model other than the one identified
by the `model_id`, this API returns an error. + /// + /// Delete a trained model alias. + /// This API deletes an existing model alias that refers to a trained model. If + /// the model alias is missing or refers to a model other than the one identified + /// by the model_id, this API returns an error. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1384,7 +1939,12 @@ public virtual DeleteTrainedModelAliasResponse DeleteTrainedModelAlias(DeleteTra } /// - /// Delete a trained model alias.
This API deletes an existing model alias that refers to a trained model. If
the model alias is missing or refers to a model other than the one identified
by the `model_id`, this API returns an error. + /// + /// Delete a trained model alias. + /// This API deletes an existing model alias that refers to a trained model. If + /// the model alias is missing or refers to a model other than the one identified + /// by the model_id, this API returns an error. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteTrainedModelAliasAsync(DeleteTrainedModelAliasRequest request, CancellationToken cancellationToken = default) @@ -1394,7 +1954,12 @@ public virtual Task DeleteTrainedModelAliasAsyn } /// - /// Delete a trained model alias.
This API deletes an existing model alias that refers to a trained model. If
the model alias is missing or refers to a model other than the one identified
by the `model_id`, this API returns an error. + /// + /// Delete a trained model alias. + /// This API deletes an existing model alias that refers to a trained model. If + /// the model alias is missing or refers to a model other than the one identified + /// by the model_id, this API returns an error. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1405,7 +1970,12 @@ public virtual DeleteTrainedModelAliasResponse DeleteTrainedModelAlias(DeleteTra } /// - /// Delete a trained model alias.
This API deletes an existing model alias that refers to a trained model. If
the model alias is missing or refers to a model other than the one identified
by the `model_id`, this API returns an error. + /// + /// Delete a trained model alias. + /// This API deletes an existing model alias that refers to a trained model. If + /// the model alias is missing or refers to a model other than the one identified + /// by the model_id, this API returns an error. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1417,7 +1987,12 @@ public virtual DeleteTrainedModelAliasResponse DeleteTrainedModelAlias(Elastic.C } /// - /// Delete a trained model alias.
This API deletes an existing model alias that refers to a trained model. If
the model alias is missing or refers to a model other than the one identified
by the `model_id`, this API returns an error. + /// + /// Delete a trained model alias. + /// This API deletes an existing model alias that refers to a trained model. If + /// the model alias is missing or refers to a model other than the one identified + /// by the model_id, this API returns an error. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1430,7 +2005,12 @@ public virtual DeleteTrainedModelAliasResponse DeleteTrainedModelAlias(Elastic.C } /// - /// Delete a trained model alias.
This API deletes an existing model alias that refers to a trained model. If
the model alias is missing or refers to a model other than the one identified
by the `model_id`, this API returns an error. + /// + /// Delete a trained model alias. + /// This API deletes an existing model alias that refers to a trained model. If + /// the model alias is missing or refers to a model other than the one identified + /// by the model_id, this API returns an error. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteTrainedModelAliasAsync(DeleteTrainedModelAliasRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1440,7 +2020,12 @@ public virtual Task DeleteTrainedModelAliasAsyn } /// - /// Delete a trained model alias.
This API deletes an existing model alias that refers to a trained model. If
the model alias is missing or refers to a model other than the one identified
by the `model_id`, this API returns an error. + /// + /// Delete a trained model alias. + /// This API deletes an existing model alias that refers to a trained model. If + /// the model alias is missing or refers to a model other than the one identified + /// by the model_id, this API returns an error. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteTrainedModelAliasAsync(Elastic.Clients.Elasticsearch.Id modelId, Elastic.Clients.Elasticsearch.Name modelAlias, CancellationToken cancellationToken = default) @@ -1451,7 +2036,12 @@ public virtual Task DeleteTrainedModelAliasAsyn } /// - /// Delete a trained model alias.
This API deletes an existing model alias that refers to a trained model. If
the model alias is missing or refers to a model other than the one identified
by the `model_id`, this API returns an error. + /// + /// Delete a trained model alias. + /// This API deletes an existing model alias that refers to a trained model. If + /// the model alias is missing or refers to a model other than the one identified + /// by the model_id, this API returns an error. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteTrainedModelAliasAsync(Elastic.Clients.Elasticsearch.Id modelId, Elastic.Clients.Elasticsearch.Name modelAlias, Action configureRequest, CancellationToken cancellationToken = default) @@ -1463,7 +2053,12 @@ public virtual Task DeleteTrainedModelAliasAsyn } /// - /// Estimate job model memory usage.
Makes an estimation of the memory usage for an anomaly detection job model.
It is based on analysis configuration details for the job and cardinality
estimates for the fields it references. + /// + /// Estimate job model memory usage. + /// Makes an estimation of the memory usage for an anomaly detection job model. + /// It is based on analysis configuration details for the job and cardinality + /// estimates for the fields it references. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1474,7 +2069,12 @@ public virtual EstimateModelMemoryResponse EstimateModelMemory(EstimateModelMemo } /// - /// Estimate job model memory usage.
Makes an estimation of the memory usage for an anomaly detection job model.
It is based on analysis configuration details for the job and cardinality
estimates for the fields it references. + /// + /// Estimate job model memory usage. + /// Makes an estimation of the memory usage for an anomaly detection job model. + /// It is based on analysis configuration details for the job and cardinality + /// estimates for the fields it references. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task EstimateModelMemoryAsync(EstimateModelMemoryRequest request, CancellationToken cancellationToken = default) @@ -1484,7 +2084,12 @@ public virtual Task EstimateModelMemoryAsync(Estima } /// - /// Estimate job model memory usage.
Makes an estimation of the memory usage for an anomaly detection job model.
It is based on analysis configuration details for the job and cardinality
estimates for the fields it references. + /// + /// Estimate job model memory usage. + /// Makes an estimation of the memory usage for an anomaly detection job model. + /// It is based on analysis configuration details for the job and cardinality + /// estimates for the fields it references. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1495,7 +2100,12 @@ public virtual EstimateModelMemoryResponse EstimateModelMemory(Estima } /// - /// Estimate job model memory usage.
Makes an estimation of the memory usage for an anomaly detection job model.
It is based on analysis configuration details for the job and cardinality
estimates for the fields it references. + /// + /// Estimate job model memory usage. + /// Makes an estimation of the memory usage for an anomaly detection job model. + /// It is based on analysis configuration details for the job and cardinality + /// estimates for the fields it references. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1507,7 +2117,12 @@ public virtual EstimateModelMemoryResponse EstimateModelMemory() } /// - /// Estimate job model memory usage.
Makes an estimation of the memory usage for an anomaly detection job model.
It is based on analysis configuration details for the job and cardinality
estimates for the fields it references. + /// + /// Estimate job model memory usage. + /// Makes an estimation of the memory usage for an anomaly detection job model. + /// It is based on analysis configuration details for the job and cardinality + /// estimates for the fields it references. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1520,7 +2135,12 @@ public virtual EstimateModelMemoryResponse EstimateModelMemory(Action } /// - /// Estimate job model memory usage.
Makes an estimation of the memory usage for an anomaly detection job model.
It is based on analysis configuration details for the job and cardinality
estimates for the fields it references. + /// + /// Estimate job model memory usage. + /// Makes an estimation of the memory usage for an anomaly detection job model. + /// It is based on analysis configuration details for the job and cardinality + /// estimates for the fields it references. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1531,7 +2151,12 @@ public virtual EstimateModelMemoryResponse EstimateModelMemory(EstimateModelMemo } /// - /// Estimate job model memory usage.
Makes an estimation of the memory usage for an anomaly detection job model.
It is based on analysis configuration details for the job and cardinality
estimates for the fields it references. + /// + /// Estimate job model memory usage. + /// Makes an estimation of the memory usage for an anomaly detection job model. + /// It is based on analysis configuration details for the job and cardinality + /// estimates for the fields it references. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1543,7 +2168,12 @@ public virtual EstimateModelMemoryResponse EstimateModelMemory() } /// - /// Estimate job model memory usage.
Makes an estimation of the memory usage for an anomaly detection job model.
It is based on analysis configuration details for the job and cardinality
estimates for the fields it references. + /// + /// Estimate job model memory usage. + /// Makes an estimation of the memory usage for an anomaly detection job model. + /// It is based on analysis configuration details for the job and cardinality + /// estimates for the fields it references. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1556,7 +2186,12 @@ public virtual EstimateModelMemoryResponse EstimateModelMemory(Action - /// Estimate job model memory usage.
Makes an estimation of the memory usage for an anomaly detection job model.
It is based on analysis configuration details for the job and cardinality
estimates for the fields it references. + /// + /// Estimate job model memory usage. + /// Makes an estimation of the memory usage for an anomaly detection job model. + /// It is based on analysis configuration details for the job and cardinality + /// estimates for the fields it references. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task EstimateModelMemoryAsync(EstimateModelMemoryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1566,7 +2201,12 @@ public virtual Task EstimateModelMemoryAsync - /// Estimate job model memory usage.
Makes an estimation of the memory usage for an anomaly detection job model.
It is based on analysis configuration details for the job and cardinality
estimates for the fields it references. + /// + /// Estimate job model memory usage. + /// Makes an estimation of the memory usage for an anomaly detection job model. + /// It is based on analysis configuration details for the job and cardinality + /// estimates for the fields it references. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task EstimateModelMemoryAsync(CancellationToken cancellationToken = default) @@ -1577,7 +2217,12 @@ public virtual Task EstimateModelMemoryAsync - /// Estimate job model memory usage.
Makes an estimation of the memory usage for an anomaly detection job model.
It is based on analysis configuration details for the job and cardinality
estimates for the fields it references. + /// + /// Estimate job model memory usage. + /// Makes an estimation of the memory usage for an anomaly detection job model. + /// It is based on analysis configuration details for the job and cardinality + /// estimates for the fields it references. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task EstimateModelMemoryAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -1589,7 +2234,12 @@ public virtual Task EstimateModelMemoryAsync - /// Estimate job model memory usage.
Makes an estimation of the memory usage for an anomaly detection job model.
It is based on analysis configuration details for the job and cardinality
estimates for the fields it references. + /// + /// Estimate job model memory usage. + /// Makes an estimation of the memory usage for an anomaly detection job model. + /// It is based on analysis configuration details for the job and cardinality + /// estimates for the fields it references. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task EstimateModelMemoryAsync(EstimateModelMemoryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1599,7 +2249,12 @@ public virtual Task EstimateModelMemoryAsync(Estima } /// - /// Estimate job model memory usage.
Makes an estimation of the memory usage for an anomaly detection job model.
It is based on analysis configuration details for the job and cardinality
estimates for the fields it references. + /// + /// Estimate job model memory usage. + /// Makes an estimation of the memory usage for an anomaly detection job model. + /// It is based on analysis configuration details for the job and cardinality + /// estimates for the fields it references. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task EstimateModelMemoryAsync(CancellationToken cancellationToken = default) @@ -1610,7 +2265,12 @@ public virtual Task EstimateModelMemoryAsync(Cancel } /// - /// Estimate job model memory usage.
Makes an estimation of the memory usage for an anomaly detection job model.
It is based on analysis configuration details for the job and cardinality
estimates for the fields it references. + /// + /// Estimate job model memory usage. + /// Makes an estimation of the memory usage for an anomaly detection job model. + /// It is based on analysis configuration details for the job and cardinality + /// estimates for the fields it references. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task EstimateModelMemoryAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -1622,7 +2282,13 @@ public virtual Task EstimateModelMemoryAsync(Action } /// - /// Evaluate data frame analytics.
The API packages together commonly used evaluation metrics for various types
of machine learning features. This has been designed for use on indexes
created by data frame analytics. Evaluation requires both a ground truth
field and an analytics result field to be present. + /// + /// Evaluate data frame analytics. + /// The API packages together commonly used evaluation metrics for various types + /// of machine learning features. This has been designed for use on indexes + /// created by data frame analytics. Evaluation requires both a ground truth + /// field and an analytics result field to be present. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1633,7 +2299,13 @@ public virtual EvaluateDataFrameResponse EvaluateDataFrame(EvaluateDataFrameRequ } /// - /// Evaluate data frame analytics.
The API packages together commonly used evaluation metrics for various types
of machine learning features. This has been designed for use on indexes
created by data frame analytics. Evaluation requires both a ground truth
field and an analytics result field to be present. + /// + /// Evaluate data frame analytics. + /// The API packages together commonly used evaluation metrics for various types + /// of machine learning features. This has been designed for use on indexes + /// created by data frame analytics. Evaluation requires both a ground truth + /// field and an analytics result field to be present. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task EvaluateDataFrameAsync(EvaluateDataFrameRequest request, CancellationToken cancellationToken = default) @@ -1643,7 +2315,13 @@ public virtual Task EvaluateDataFrameAsync(EvaluateDa } /// - /// Evaluate data frame analytics.
The API packages together commonly used evaluation metrics for various types
of machine learning features. This has been designed for use on indexes
created by data frame analytics. Evaluation requires both a ground truth
field and an analytics result field to be present. + /// + /// Evaluate data frame analytics. + /// The API packages together commonly used evaluation metrics for various types + /// of machine learning features. This has been designed for use on indexes + /// created by data frame analytics. Evaluation requires both a ground truth + /// field and an analytics result field to be present. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1654,7 +2332,13 @@ public virtual EvaluateDataFrameResponse EvaluateDataFrame(EvaluateDa } /// - /// Evaluate data frame analytics.
The API packages together commonly used evaluation metrics for various types
of machine learning features. This has been designed for use on indexes
created by data frame analytics. Evaluation requires both a ground truth
field and an analytics result field to be present. + /// + /// Evaluate data frame analytics. + /// The API packages together commonly used evaluation metrics for various types + /// of machine learning features. This has been designed for use on indexes + /// created by data frame analytics. Evaluation requires both a ground truth + /// field and an analytics result field to be present. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1666,7 +2350,13 @@ public virtual EvaluateDataFrameResponse EvaluateDataFrame() } /// - /// Evaluate data frame analytics.
The API packages together commonly used evaluation metrics for various types
of machine learning features. This has been designed for use on indexes
created by data frame analytics. Evaluation requires both a ground truth
field and an analytics result field to be present. + /// + /// Evaluate data frame analytics. + /// The API packages together commonly used evaluation metrics for various types + /// of machine learning features. This has been designed for use on indexes + /// created by data frame analytics. Evaluation requires both a ground truth + /// field and an analytics result field to be present. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1679,7 +2369,13 @@ public virtual EvaluateDataFrameResponse EvaluateDataFrame(Action - /// Evaluate data frame analytics.
The API packages together commonly used evaluation metrics for various types
of machine learning features. This has been designed for use on indexes
created by data frame analytics. Evaluation requires both a ground truth
field and an analytics result field to be present. + /// + /// Evaluate data frame analytics. + /// The API packages together commonly used evaluation metrics for various types + /// of machine learning features. This has been designed for use on indexes + /// created by data frame analytics. Evaluation requires both a ground truth + /// field and an analytics result field to be present. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1690,7 +2386,13 @@ public virtual EvaluateDataFrameResponse EvaluateDataFrame(EvaluateDataFrameRequ } /// - /// Evaluate data frame analytics.
The API packages together commonly used evaluation metrics for various types
of machine learning features. This has been designed for use on indexes
created by data frame analytics. Evaluation requires both a ground truth
field and an analytics result field to be present. + /// + /// Evaluate data frame analytics. + /// The API packages together commonly used evaluation metrics for various types + /// of machine learning features. This has been designed for use on indexes + /// created by data frame analytics. Evaluation requires both a ground truth + /// field and an analytics result field to be present. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1702,7 +2404,13 @@ public virtual EvaluateDataFrameResponse EvaluateDataFrame() } /// - /// Evaluate data frame analytics.
The API packages together commonly used evaluation metrics for various types
of machine learning features. This has been designed for use on indexes
created by data frame analytics. Evaluation requires both a ground truth
field and an analytics result field to be present. + /// + /// Evaluate data frame analytics. + /// The API packages together commonly used evaluation metrics for various types + /// of machine learning features. This has been designed for use on indexes + /// created by data frame analytics. Evaluation requires both a ground truth + /// field and an analytics result field to be present. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1715,7 +2423,13 @@ public virtual EvaluateDataFrameResponse EvaluateDataFrame(Action - /// Evaluate data frame analytics.
The API packages together commonly used evaluation metrics for various types
of machine learning features. This has been designed for use on indexes
created by data frame analytics. Evaluation requires both a ground truth
field and an analytics result field to be present. + /// + /// Evaluate data frame analytics. + /// The API packages together commonly used evaluation metrics for various types + /// of machine learning features. This has been designed for use on indexes + /// created by data frame analytics. Evaluation requires both a ground truth + /// field and an analytics result field to be present. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task EvaluateDataFrameAsync(EvaluateDataFrameRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1725,7 +2439,13 @@ public virtual Task EvaluateDataFrameAsync } /// - /// Evaluate data frame analytics.
The API packages together commonly used evaluation metrics for various types
of machine learning features. This has been designed for use on indexes
created by data frame analytics. Evaluation requires both a ground truth
field and an analytics result field to be present. + /// + /// Evaluate data frame analytics. + /// The API packages together commonly used evaluation metrics for various types + /// of machine learning features. This has been designed for use on indexes + /// created by data frame analytics. Evaluation requires both a ground truth + /// field and an analytics result field to be present. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task EvaluateDataFrameAsync(CancellationToken cancellationToken = default) @@ -1736,7 +2456,13 @@ public virtual Task EvaluateDataFrameAsync } /// - /// Evaluate data frame analytics.
The API packages together commonly used evaluation metrics for various types
of machine learning features. This has been designed for use on indexes
created by data frame analytics. Evaluation requires both a ground truth
field and an analytics result field to be present. + /// + /// Evaluate data frame analytics. + /// The API packages together commonly used evaluation metrics for various types + /// of machine learning features. This has been designed for use on indexes + /// created by data frame analytics. Evaluation requires both a ground truth + /// field and an analytics result field to be present. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task EvaluateDataFrameAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -1748,7 +2474,13 @@ public virtual Task EvaluateDataFrameAsync } /// - /// Evaluate data frame analytics.
The API packages together commonly used evaluation metrics for various types
of machine learning features. This has been designed for use on indexes
created by data frame analytics. Evaluation requires both a ground truth
field and an analytics result field to be present. + /// + /// Evaluate data frame analytics. + /// The API packages together commonly used evaluation metrics for various types + /// of machine learning features. This has been designed for use on indexes + /// created by data frame analytics. Evaluation requires both a ground truth + /// field and an analytics result field to be present. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task EvaluateDataFrameAsync(EvaluateDataFrameRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1758,7 +2490,13 @@ public virtual Task EvaluateDataFrameAsync(EvaluateDa } /// - /// Evaluate data frame analytics.
The API packages together commonly used evaluation metrics for various types
of machine learning features. This has been designed for use on indexes
created by data frame analytics. Evaluation requires both a ground truth
field and an analytics result field to be present. + /// + /// Evaluate data frame analytics. + /// The API packages together commonly used evaluation metrics for various types + /// of machine learning features. This has been designed for use on indexes + /// created by data frame analytics. Evaluation requires both a ground truth + /// field and an analytics result field to be present. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task EvaluateDataFrameAsync(CancellationToken cancellationToken = default) @@ -1769,7 +2507,13 @@ public virtual Task EvaluateDataFrameAsync(Cancellati } /// - /// Evaluate data frame analytics.
The API packages together commonly used evaluation metrics for various types
of machine learning features. This has been designed for use on indexes
created by data frame analytics. Evaluation requires both a ground truth
field and an analytics result field to be present. + /// + /// Evaluate data frame analytics. + /// The API packages together commonly used evaluation metrics for various types + /// of machine learning features. This has been designed for use on indexes + /// created by data frame analytics. Evaluation requires both a ground truth + /// field and an analytics result field to be present. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task EvaluateDataFrameAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -1781,7 +2525,25 @@ public virtual Task EvaluateDataFrameAsync(Action - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1792,7 +2554,25 @@ public virtual ExplainDataFrameAnalyticsResponse ExplainDataFrameAnalytics(Expla } /// - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataFrameAnalyticsAsync(ExplainDataFrameAnalyticsRequest request, CancellationToken cancellationToken = default) @@ -1802,7 +2582,25 @@ public virtual Task ExplainDataFrameAnalytics } /// - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1813,7 +2611,25 @@ public virtual ExplainDataFrameAnalyticsResponse ExplainDataFrameAnalytics - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1825,7 +2641,25 @@ public virtual ExplainDataFrameAnalyticsResponse ExplainDataFrameAnalytics - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1838,7 +2672,25 @@ public virtual ExplainDataFrameAnalyticsResponse ExplainDataFrameAnalytics - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1850,7 +2702,25 @@ public virtual ExplainDataFrameAnalyticsResponse ExplainDataFrameAnalytics - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1863,7 +2733,25 @@ public virtual ExplainDataFrameAnalyticsResponse ExplainDataFrameAnalytics - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1874,7 +2762,25 @@ public virtual ExplainDataFrameAnalyticsResponse ExplainDataFrameAnalytics(Expla } /// - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1886,7 +2792,25 @@ public virtual ExplainDataFrameAnalyticsResponse ExplainDataFrameAnalytics(Elast } /// - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1899,7 +2823,25 @@ public virtual ExplainDataFrameAnalyticsResponse ExplainDataFrameAnalytics(Elast } /// - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1911,7 +2853,25 @@ public virtual ExplainDataFrameAnalyticsResponse ExplainDataFrameAnalytics() } /// - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1924,7 +2884,25 @@ public virtual ExplainDataFrameAnalyticsResponse ExplainDataFrameAnalytics(Actio } /// - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataFrameAnalyticsAsync(ExplainDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1934,7 +2912,25 @@ public virtual Task ExplainDataFrameAnalytics } /// - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id? id, CancellationToken cancellationToken = default) @@ -1945,7 +2941,25 @@ public virtual Task ExplainDataFrameAnalytics } /// - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id? id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1957,7 +2971,25 @@ public virtual Task ExplainDataFrameAnalytics } /// - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataFrameAnalyticsAsync(CancellationToken cancellationToken = default) @@ -1968,7 +3000,25 @@ public virtual Task ExplainDataFrameAnalytics } /// - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataFrameAnalyticsAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -1980,7 +3030,25 @@ public virtual Task ExplainDataFrameAnalytics } /// - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataFrameAnalyticsAsync(ExplainDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1990,7 +3058,25 @@ public virtual Task ExplainDataFrameAnalytics } /// - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id? id, CancellationToken cancellationToken = default) @@ -2001,7 +3087,25 @@ public virtual Task ExplainDataFrameAnalytics } /// - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id? id, Action configureRequest, CancellationToken cancellationToken = default) @@ -2013,7 +3117,25 @@ public virtual Task ExplainDataFrameAnalytics } /// - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataFrameAnalyticsAsync(CancellationToken cancellationToken = default) @@ -2024,7 +3146,25 @@ public virtual Task ExplainDataFrameAnalytics } /// - /// Explain data frame analytics config.
This API provides explanations for a data frame analytics config that either
exists already or one that has not been created yet. The following
explanations are provided:
* which fields are included or not in the analysis and why,
* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// Explain data frame analytics config. + /// This API provides explanations for a data frame analytics config that either + /// exists already or one that has not been created yet. The following + /// explanations are provided: + /// + /// + /// + /// + /// which fields are included or not in the analysis and why, + /// + /// + /// + /// + /// how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + /// If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExplainDataFrameAnalyticsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -2036,7 +3176,17 @@ public virtual Task ExplainDataFrameAnalytics } /// - /// Forces any buffered data to be processed by the job.
The flush jobs API is only applicable when sending data for analysis using
the post data API. Depending on the content of the buffer, then it might
additionally calculate new results. Both flush and close operations are
similar, however the flush is more efficient if you are expecting to send
more data for analysis. When flushing, the job remains open and is available
to continue analyzing data. A close operation additionally prunes and
persists the model state to disk and the job must be opened again before
analyzing further data. + /// + /// Forces any buffered data to be processed by the job. + /// The flush jobs API is only applicable when sending data for analysis using + /// the post data API. Depending on the content of the buffer, then it might + /// additionally calculate new results. Both flush and close operations are + /// similar, however the flush is more efficient if you are expecting to send + /// more data for analysis. When flushing, the job remains open and is available + /// to continue analyzing data. A close operation additionally prunes and + /// persists the model state to disk and the job must be opened again before + /// analyzing further data. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2047,7 +3197,17 @@ public virtual FlushJobResponse FlushJob(FlushJobRequest request) } /// - /// Forces any buffered data to be processed by the job.
The flush jobs API is only applicable when sending data for analysis using
the post data API. Depending on the content of the buffer, then it might
additionally calculate new results. Both flush and close operations are
similar, however the flush is more efficient if you are expecting to send
more data for analysis. When flushing, the job remains open and is available
to continue analyzing data. A close operation additionally prunes and
persists the model state to disk and the job must be opened again before
analyzing further data. + /// + /// Forces any buffered data to be processed by the job. + /// The flush jobs API is only applicable when sending data for analysis using + /// the post data API. Depending on the content of the buffer, then it might + /// additionally calculate new results. Both flush and close operations are + /// similar, however the flush is more efficient if you are expecting to send + /// more data for analysis. When flushing, the job remains open and is available + /// to continue analyzing data. A close operation additionally prunes and + /// persists the model state to disk and the job must be opened again before + /// analyzing further data. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushJobAsync(FlushJobRequest request, CancellationToken cancellationToken = default) @@ -2057,7 +3217,17 @@ public virtual Task FlushJobAsync(FlushJobRequest request, Can } /// - /// Forces any buffered data to be processed by the job.
The flush jobs API is only applicable when sending data for analysis using
the post data API. Depending on the content of the buffer, then it might
additionally calculate new results. Both flush and close operations are
similar, however the flush is more efficient if you are expecting to send
more data for analysis. When flushing, the job remains open and is available
to continue analyzing data. A close operation additionally prunes and
persists the model state to disk and the job must be opened again before
analyzing further data. + /// + /// Forces any buffered data to be processed by the job. + /// The flush jobs API is only applicable when sending data for analysis using + /// the post data API. Depending on the content of the buffer, then it might + /// additionally calculate new results. Both flush and close operations are + /// similar, however the flush is more efficient if you are expecting to send + /// more data for analysis. When flushing, the job remains open and is available + /// to continue analyzing data. A close operation additionally prunes and + /// persists the model state to disk and the job must be opened again before + /// analyzing further data. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2068,7 +3238,17 @@ public virtual FlushJobResponse FlushJob(FlushJobRequestDescriptor descriptor) } /// - /// Forces any buffered data to be processed by the job.
The flush jobs API is only applicable when sending data for analysis using
the post data API. Depending on the content of the buffer, then it might
additionally calculate new results. Both flush and close operations are
similar, however the flush is more efficient if you are expecting to send
more data for analysis. When flushing, the job remains open and is available
to continue analyzing data. A close operation additionally prunes and
persists the model state to disk and the job must be opened again before
analyzing further data. + /// + /// Forces any buffered data to be processed by the job. + /// The flush jobs API is only applicable when sending data for analysis using + /// the post data API. Depending on the content of the buffer, then it might + /// additionally calculate new results. Both flush and close operations are + /// similar, however the flush is more efficient if you are expecting to send + /// more data for analysis. When flushing, the job remains open and is available + /// to continue analyzing data. A close operation additionally prunes and + /// persists the model state to disk and the job must be opened again before + /// analyzing further data. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2080,7 +3260,17 @@ public virtual FlushJobResponse FlushJob(Elastic.Clients.Elasticsearch.Id jobId) } /// - /// Forces any buffered data to be processed by the job.
The flush jobs API is only applicable when sending data for analysis using
the post data API. Depending on the content of the buffer, then it might
additionally calculate new results. Both flush and close operations are
similar, however the flush is more efficient if you are expecting to send
more data for analysis. When flushing, the job remains open and is available
to continue analyzing data. A close operation additionally prunes and
persists the model state to disk and the job must be opened again before
analyzing further data. + /// + /// Forces any buffered data to be processed by the job. + /// The flush jobs API is only applicable when sending data for analysis using + /// the post data API. Depending on the content of the buffer, then it might + /// additionally calculate new results. Both flush and close operations are + /// similar, however the flush is more efficient if you are expecting to send + /// more data for analysis. When flushing, the job remains open and is available + /// to continue analyzing data. A close operation additionally prunes and + /// persists the model state to disk and the job must be opened again before + /// analyzing further data. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2093,7 +3283,17 @@ public virtual FlushJobResponse FlushJob(Elastic.Clients.Elasticsearch.Id jobId, } /// - /// Forces any buffered data to be processed by the job.
The flush jobs API is only applicable when sending data for analysis using
the post data API. Depending on the content of the buffer, then it might
additionally calculate new results. Both flush and close operations are
similar, however the flush is more efficient if you are expecting to send
more data for analysis. When flushing, the job remains open and is available
to continue analyzing data. A close operation additionally prunes and
persists the model state to disk and the job must be opened again before
analyzing further data. + /// + /// Forces any buffered data to be processed by the job. + /// The flush jobs API is only applicable when sending data for analysis using + /// the post data API. Depending on the content of the buffer, then it might + /// additionally calculate new results. Both flush and close operations are + /// similar, however the flush is more efficient if you are expecting to send + /// more data for analysis. When flushing, the job remains open and is available + /// to continue analyzing data. A close operation additionally prunes and + /// persists the model state to disk and the job must be opened again before + /// analyzing further data. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushJobAsync(FlushJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2103,7 +3303,17 @@ public virtual Task FlushJobAsync(FlushJobRequestDescriptor de } /// - /// Forces any buffered data to be processed by the job.
The flush jobs API is only applicable when sending data for analysis using
the post data API. Depending on the content of the buffer, then it might
additionally calculate new results. Both flush and close operations are
similar, however the flush is more efficient if you are expecting to send
more data for analysis. When flushing, the job remains open and is available
to continue analyzing data. A close operation additionally prunes and
persists the model state to disk and the job must be opened again before
analyzing further data. + /// + /// Forces any buffered data to be processed by the job. + /// The flush jobs API is only applicable when sending data for analysis using + /// the post data API. Depending on the content of the buffer, then it might + /// additionally calculate new results. Both flush and close operations are + /// similar, however the flush is more efficient if you are expecting to send + /// more data for analysis. When flushing, the job remains open and is available + /// to continue analyzing data. A close operation additionally prunes and + /// persists the model state to disk and the job must be opened again before + /// analyzing further data. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushJobAsync(Elastic.Clients.Elasticsearch.Id jobId, CancellationToken cancellationToken = default) @@ -2114,7 +3324,17 @@ public virtual Task FlushJobAsync(Elastic.Clients.Elasticsearc } /// - /// Forces any buffered data to be processed by the job.
The flush jobs API is only applicable when sending data for analysis using
the post data API. Depending on the content of the buffer, then it might
additionally calculate new results. Both flush and close operations are
similar, however the flush is more efficient if you are expecting to send
more data for analysis. When flushing, the job remains open and is available
to continue analyzing data. A close operation additionally prunes and
persists the model state to disk and the job must be opened again before
analyzing further data. + /// + /// Forces any buffered data to be processed by the job. + /// The flush jobs API is only applicable when sending data for analysis using + /// the post data API. Depending on the content of the buffer, then it might + /// additionally calculate new results. Both flush and close operations are + /// similar, however the flush is more efficient if you are expecting to send + /// more data for analysis. When flushing, the job remains open and is available + /// to continue analyzing data. A close operation additionally prunes and + /// persists the model state to disk and the job must be opened again before + /// analyzing further data. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushJobAsync(Elastic.Clients.Elasticsearch.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -2126,8 +3346,15 @@ public virtual Task FlushJobAsync(Elastic.Clients.Elasticsearc } /// - /// Predicts the future behavior of a time series by using its historical
behavior. - /// Forecasts are not supported for jobs that perform population analysis; an
error occurs if you try to create a forecast for a job that has an
`over_field_name` in its configuration. + /// + /// Predicts the future behavior of a time series by using its historical + /// behavior. + /// + /// + /// Forecasts are not supported for jobs that perform population analysis; an + /// error occurs if you try to create a forecast for a job that has an + /// over_field_name in its configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2138,8 +3365,15 @@ public virtual ForecastResponse Forecast(ForecastRequest request) } /// - /// Predicts the future behavior of a time series by using its historical
behavior. - /// Forecasts are not supported for jobs that perform population analysis; an
error occurs if you try to create a forecast for a job that has an
`over_field_name` in its configuration. + /// + /// Predicts the future behavior of a time series by using its historical + /// behavior. + /// + /// + /// Forecasts are not supported for jobs that perform population analysis; an + /// error occurs if you try to create a forecast for a job that has an + /// over_field_name in its configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForecastAsync(ForecastRequest request, CancellationToken cancellationToken = default) @@ -2149,8 +3383,15 @@ public virtual Task ForecastAsync(ForecastRequest request, Can } /// - /// Predicts the future behavior of a time series by using its historical
behavior. - /// Forecasts are not supported for jobs that perform population analysis; an
error occurs if you try to create a forecast for a job that has an
`over_field_name` in its configuration. + /// + /// Predicts the future behavior of a time series by using its historical + /// behavior. + /// + /// + /// Forecasts are not supported for jobs that perform population analysis; an + /// error occurs if you try to create a forecast for a job that has an + /// over_field_name in its configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2161,8 +3402,15 @@ public virtual ForecastResponse Forecast(ForecastRequestDescriptor descriptor) } /// - /// Predicts the future behavior of a time series by using its historical
behavior. - /// Forecasts are not supported for jobs that perform population analysis; an
error occurs if you try to create a forecast for a job that has an
`over_field_name` in its configuration. + /// + /// Predicts the future behavior of a time series by using its historical + /// behavior. + /// + /// + /// Forecasts are not supported for jobs that perform population analysis; an + /// error occurs if you try to create a forecast for a job that has an + /// over_field_name in its configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2174,8 +3422,15 @@ public virtual ForecastResponse Forecast(Elastic.Clients.Elasticsearch.Id jobId) } /// - /// Predicts the future behavior of a time series by using its historical
behavior. - /// Forecasts are not supported for jobs that perform population analysis; an
error occurs if you try to create a forecast for a job that has an
`over_field_name` in its configuration. + /// + /// Predicts the future behavior of a time series by using its historical + /// behavior. + /// + /// + /// Forecasts are not supported for jobs that perform population analysis; an + /// error occurs if you try to create a forecast for a job that has an + /// over_field_name in its configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2188,8 +3443,15 @@ public virtual ForecastResponse Forecast(Elastic.Clients.Elasticsearch.Id jobId, } /// - /// Predicts the future behavior of a time series by using its historical
behavior. - /// Forecasts are not supported for jobs that perform population analysis; an
error occurs if you try to create a forecast for a job that has an
`over_field_name` in its configuration. + /// + /// Predicts the future behavior of a time series by using its historical + /// behavior. + /// + /// + /// Forecasts are not supported for jobs that perform population analysis; an + /// error occurs if you try to create a forecast for a job that has an + /// over_field_name in its configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForecastAsync(ForecastRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2199,8 +3461,15 @@ public virtual Task ForecastAsync(ForecastRequestDescriptor de } /// - /// Predicts the future behavior of a time series by using its historical
behavior. - /// Forecasts are not supported for jobs that perform population analysis; an
error occurs if you try to create a forecast for a job that has an
`over_field_name` in its configuration. + /// + /// Predicts the future behavior of a time series by using its historical + /// behavior. + /// + /// + /// Forecasts are not supported for jobs that perform population analysis; an + /// error occurs if you try to create a forecast for a job that has an + /// over_field_name in its configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForecastAsync(Elastic.Clients.Elasticsearch.Id jobId, CancellationToken cancellationToken = default) @@ -2211,8 +3480,15 @@ public virtual Task ForecastAsync(Elastic.Clients.Elasticsearc } /// - /// Predicts the future behavior of a time series by using its historical
behavior. - /// Forecasts are not supported for jobs that perform population analysis; an
error occurs if you try to create a forecast for a job that has an
`over_field_name` in its configuration. + /// + /// Predicts the future behavior of a time series by using its historical + /// behavior. + /// + /// + /// Forecasts are not supported for jobs that perform population analysis; an + /// error occurs if you try to create a forecast for a job that has an + /// over_field_name in its configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForecastAsync(Elastic.Clients.Elasticsearch.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -2224,7 +3500,10 @@ public virtual Task ForecastAsync(Elastic.Clients.Elasticsearc } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2235,7 +3514,10 @@ public virtual GetBucketsResponse GetBuckets(GetBucketsRequest request) } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBucketsAsync(GetBucketsRequest request, CancellationToken cancellationToken = default) @@ -2245,7 +3527,10 @@ public virtual Task GetBucketsAsync(GetBucketsRequest reques } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2256,7 +3541,10 @@ public virtual GetBucketsResponse GetBuckets(GetBucketsRequestDescrip } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2268,7 +3556,10 @@ public virtual GetBucketsResponse GetBuckets(Elastic.Clients.Elastics } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2281,7 +3572,10 @@ public virtual GetBucketsResponse GetBuckets(Elastic.Clients.Elastics } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2293,7 +3587,10 @@ public virtual GetBucketsResponse GetBuckets(Elastic.Clients.Elastics } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2306,7 +3603,10 @@ public virtual GetBucketsResponse GetBuckets(Elastic.Clients.Elastics } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2317,7 +3617,10 @@ public virtual GetBucketsResponse GetBuckets(GetBucketsRequestDescriptor descrip } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2329,7 +3632,10 @@ public virtual GetBucketsResponse GetBuckets(Elastic.Clients.Elasticsearch.Id jo } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2342,7 +3648,10 @@ public virtual GetBucketsResponse GetBuckets(Elastic.Clients.Elasticsearch.Id jo } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2354,7 +3663,10 @@ public virtual GetBucketsResponse GetBuckets(Elastic.Clients.Elasticsearch.Id jo } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2367,7 +3679,10 @@ public virtual GetBucketsResponse GetBuckets(Elastic.Clients.Elasticsearch.Id jo } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBucketsAsync(GetBucketsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2377,7 +3692,10 @@ public virtual Task GetBucketsAsync(GetBucketsReq } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBucketsAsync(Elastic.Clients.Elasticsearch.Id jobId, DateTimeOffset? timestamp, CancellationToken cancellationToken = default) @@ -2388,7 +3706,10 @@ public virtual Task GetBucketsAsync(Elastic.Clien } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBucketsAsync(Elastic.Clients.Elasticsearch.Id jobId, DateTimeOffset? timestamp, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2400,7 +3721,10 @@ public virtual Task GetBucketsAsync(Elastic.Clien } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBucketsAsync(Elastic.Clients.Elasticsearch.Id jobId, CancellationToken cancellationToken = default) @@ -2411,7 +3735,10 @@ public virtual Task GetBucketsAsync(Elastic.Clien } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBucketsAsync(Elastic.Clients.Elasticsearch.Id jobId, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2423,7 +3750,10 @@ public virtual Task GetBucketsAsync(Elastic.Clien } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBucketsAsync(GetBucketsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2433,7 +3763,10 @@ public virtual Task GetBucketsAsync(GetBucketsRequestDescrip } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBucketsAsync(Elastic.Clients.Elasticsearch.Id jobId, DateTimeOffset? timestamp, CancellationToken cancellationToken = default) @@ -2444,7 +3777,10 @@ public virtual Task GetBucketsAsync(Elastic.Clients.Elastics } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBucketsAsync(Elastic.Clients.Elasticsearch.Id jobId, DateTimeOffset? timestamp, Action configureRequest, CancellationToken cancellationToken = default) @@ -2456,7 +3792,10 @@ public virtual Task GetBucketsAsync(Elastic.Clients.Elastics } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBucketsAsync(Elastic.Clients.Elasticsearch.Id jobId, CancellationToken cancellationToken = default) @@ -2467,7 +3806,10 @@ public virtual Task GetBucketsAsync(Elastic.Clients.Elastics } /// - /// Retrieves anomaly detection job results for one or more buckets.
The API presents a chronological view of the records, grouped by bucket. + /// + /// Retrieves anomaly detection job results for one or more buckets. + /// The API presents a chronological view of the records, grouped by bucket. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBucketsAsync(Elastic.Clients.Elasticsearch.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -2479,7 +3821,9 @@ public virtual Task GetBucketsAsync(Elastic.Clients.Elastics } /// - /// Retrieves information about the scheduled events in calendars. + /// + /// Retrieves information about the scheduled events in calendars. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2490,7 +3834,9 @@ public virtual GetCalendarEventsResponse GetCalendarEvents(GetCalendarEventsRequ } /// - /// Retrieves information about the scheduled events in calendars. + /// + /// Retrieves information about the scheduled events in calendars. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCalendarEventsAsync(GetCalendarEventsRequest request, CancellationToken cancellationToken = default) @@ -2500,7 +3846,9 @@ public virtual Task GetCalendarEventsAsync(GetCalenda } /// - /// Retrieves information about the scheduled events in calendars. + /// + /// Retrieves information about the scheduled events in calendars. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2511,7 +3859,9 @@ public virtual GetCalendarEventsResponse GetCalendarEvents(GetCalendarEventsRequ } /// - /// Retrieves information about the scheduled events in calendars. + /// + /// Retrieves information about the scheduled events in calendars. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2523,7 +3873,9 @@ public virtual GetCalendarEventsResponse GetCalendarEvents(Elastic.Clients.Elast } /// - /// Retrieves information about the scheduled events in calendars. + /// + /// Retrieves information about the scheduled events in calendars. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2536,7 +3888,9 @@ public virtual GetCalendarEventsResponse GetCalendarEvents(Elastic.Clients.Elast } /// - /// Retrieves information about the scheduled events in calendars. + /// + /// Retrieves information about the scheduled events in calendars. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCalendarEventsAsync(GetCalendarEventsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2546,7 +3900,9 @@ public virtual Task GetCalendarEventsAsync(GetCalenda } /// - /// Retrieves information about the scheduled events in calendars. + /// + /// Retrieves information about the scheduled events in calendars. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCalendarEventsAsync(Elastic.Clients.Elasticsearch.Id calendarId, CancellationToken cancellationToken = default) @@ -2557,7 +3913,9 @@ public virtual Task GetCalendarEventsAsync(Elastic.Cl } /// - /// Retrieves information about the scheduled events in calendars. + /// + /// Retrieves information about the scheduled events in calendars. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCalendarEventsAsync(Elastic.Clients.Elasticsearch.Id calendarId, Action configureRequest, CancellationToken cancellationToken = default) @@ -2569,7 +3927,9 @@ public virtual Task GetCalendarEventsAsync(Elastic.Cl } /// - /// Retrieves configuration information for calendars. + /// + /// Retrieves configuration information for calendars. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2580,7 +3940,9 @@ public virtual GetCalendarsResponse GetCalendars(GetCalendarsRequest request) } /// - /// Retrieves configuration information for calendars. + /// + /// Retrieves configuration information for calendars. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCalendarsAsync(GetCalendarsRequest request, CancellationToken cancellationToken = default) @@ -2590,7 +3952,9 @@ public virtual Task GetCalendarsAsync(GetCalendarsRequest } /// - /// Retrieves configuration information for calendars. + /// + /// Retrieves configuration information for calendars. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2601,7 +3965,9 @@ public virtual GetCalendarsResponse GetCalendars(GetCalendarsRequestDescriptor d } /// - /// Retrieves configuration information for calendars. + /// + /// Retrieves configuration information for calendars. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2613,7 +3979,9 @@ public virtual GetCalendarsResponse GetCalendars(Elastic.Clients.Elasticsearch.I } /// - /// Retrieves configuration information for calendars. + /// + /// Retrieves configuration information for calendars. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2626,7 +3994,9 @@ public virtual GetCalendarsResponse GetCalendars(Elastic.Clients.Elasticsearch.I } /// - /// Retrieves configuration information for calendars. + /// + /// Retrieves configuration information for calendars. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2638,7 +4008,9 @@ public virtual GetCalendarsResponse GetCalendars() } /// - /// Retrieves configuration information for calendars. + /// + /// Retrieves configuration information for calendars. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2651,7 +4023,9 @@ public virtual GetCalendarsResponse GetCalendars(Action - /// Retrieves configuration information for calendars. + /// + /// Retrieves configuration information for calendars. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCalendarsAsync(GetCalendarsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2661,7 +4035,9 @@ public virtual Task GetCalendarsAsync(GetCalendarsRequestD } /// - /// Retrieves configuration information for calendars. + /// + /// Retrieves configuration information for calendars. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCalendarsAsync(Elastic.Clients.Elasticsearch.Id? calendarId, CancellationToken cancellationToken = default) @@ -2672,7 +4048,9 @@ public virtual Task GetCalendarsAsync(Elastic.Clients.Elas } /// - /// Retrieves configuration information for calendars. + /// + /// Retrieves configuration information for calendars. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCalendarsAsync(Elastic.Clients.Elasticsearch.Id? calendarId, Action configureRequest, CancellationToken cancellationToken = default) @@ -2684,7 +4062,9 @@ public virtual Task GetCalendarsAsync(Elastic.Clients.Elas } /// - /// Retrieves configuration information for calendars. + /// + /// Retrieves configuration information for calendars. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCalendarsAsync(CancellationToken cancellationToken = default) @@ -2695,7 +4075,9 @@ public virtual Task GetCalendarsAsync(CancellationToken ca } /// - /// Retrieves configuration information for calendars. + /// + /// Retrieves configuration information for calendars. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCalendarsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -2707,7 +4089,9 @@ public virtual Task GetCalendarsAsync(Action - /// Retrieves anomaly detection job results for one or more categories. + /// + /// Retrieves anomaly detection job results for one or more categories. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2718,7 +4102,9 @@ public virtual GetCategoriesResponse GetCategories(GetCategoriesRequest request) } /// - /// Retrieves anomaly detection job results for one or more categories. + /// + /// Retrieves anomaly detection job results for one or more categories. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCategoriesAsync(GetCategoriesRequest request, CancellationToken cancellationToken = default) @@ -2728,7 +4114,9 @@ public virtual Task GetCategoriesAsync(GetCategoriesReque } /// - /// Retrieves anomaly detection job results for one or more categories. + /// + /// Retrieves anomaly detection job results for one or more categories. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2739,7 +4127,9 @@ public virtual GetCategoriesResponse GetCategories(GetCategoriesRequestDescripto } /// - /// Retrieves anomaly detection job results for one or more categories. + /// + /// Retrieves anomaly detection job results for one or more categories. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2751,7 +4141,9 @@ public virtual GetCategoriesResponse GetCategories(Elastic.Clients.Elasticsearch } /// - /// Retrieves anomaly detection job results for one or more categories. + /// + /// Retrieves anomaly detection job results for one or more categories. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2764,7 +4156,9 @@ public virtual GetCategoriesResponse GetCategories(Elastic.Clients.Elasticsearch } /// - /// Retrieves anomaly detection job results for one or more categories. + /// + /// Retrieves anomaly detection job results for one or more categories. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2776,7 +4170,9 @@ public virtual GetCategoriesResponse GetCategories(Elastic.Clients.Elasticsearch } /// - /// Retrieves anomaly detection job results for one or more categories. + /// + /// Retrieves anomaly detection job results for one or more categories. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2789,7 +4185,9 @@ public virtual GetCategoriesResponse GetCategories(Elastic.Clients.Elasticsearch } /// - /// Retrieves anomaly detection job results for one or more categories. + /// + /// Retrieves anomaly detection job results for one or more categories. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCategoriesAsync(GetCategoriesRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2799,7 +4197,9 @@ public virtual Task GetCategoriesAsync(GetCategoriesReque } /// - /// Retrieves anomaly detection job results for one or more categories. + /// + /// Retrieves anomaly detection job results for one or more categories. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCategoriesAsync(Elastic.Clients.Elasticsearch.Id jobId, string? categoryId, CancellationToken cancellationToken = default) @@ -2810,7 +4210,9 @@ public virtual Task GetCategoriesAsync(Elastic.Clients.El } /// - /// Retrieves anomaly detection job results for one or more categories. + /// + /// Retrieves anomaly detection job results for one or more categories. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCategoriesAsync(Elastic.Clients.Elasticsearch.Id jobId, string? categoryId, Action configureRequest, CancellationToken cancellationToken = default) @@ -2822,7 +4224,9 @@ public virtual Task GetCategoriesAsync(Elastic.Clients.El } /// - /// Retrieves anomaly detection job results for one or more categories. + /// + /// Retrieves anomaly detection job results for one or more categories. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCategoriesAsync(Elastic.Clients.Elasticsearch.Id jobId, CancellationToken cancellationToken = default) @@ -2833,7 +4237,9 @@ public virtual Task GetCategoriesAsync(Elastic.Clients.El } /// - /// Retrieves anomaly detection job results for one or more categories. + /// + /// Retrieves anomaly detection job results for one or more categories. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetCategoriesAsync(Elastic.Clients.Elasticsearch.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -2845,7 +4251,14 @@ public virtual Task GetCategoriesAsync(Elastic.Clients.El } /// - /// Retrieves configuration information for datafeeds.
You can get information for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get information for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves configuration information for datafeeds. + /// You can get information for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get information for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2856,7 +4269,14 @@ public virtual GetDatafeedsResponse GetDatafeeds(GetDatafeedsRequest request) } /// - /// Retrieves configuration information for datafeeds.
You can get information for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get information for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves configuration information for datafeeds. + /// You can get information for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get information for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDatafeedsAsync(GetDatafeedsRequest request, CancellationToken cancellationToken = default) @@ -2866,7 +4286,14 @@ public virtual Task GetDatafeedsAsync(GetDatafeedsRequest } /// - /// Retrieves configuration information for datafeeds.
You can get information for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get information for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves configuration information for datafeeds. + /// You can get information for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get information for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2877,7 +4304,14 @@ public virtual GetDatafeedsResponse GetDatafeeds(GetDatafeedsRequestDescriptor d } /// - /// Retrieves configuration information for datafeeds.
You can get information for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get information for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves configuration information for datafeeds. + /// You can get information for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get information for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2889,7 +4323,14 @@ public virtual GetDatafeedsResponse GetDatafeeds(Elastic.Clients.Elasticsearch.I } /// - /// Retrieves configuration information for datafeeds.
You can get information for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get information for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves configuration information for datafeeds. + /// You can get information for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get information for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2902,7 +4343,14 @@ public virtual GetDatafeedsResponse GetDatafeeds(Elastic.Clients.Elasticsearch.I } /// - /// Retrieves configuration information for datafeeds.
You can get information for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get information for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves configuration information for datafeeds. + /// You can get information for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get information for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2914,7 +4362,14 @@ public virtual GetDatafeedsResponse GetDatafeeds() } /// - /// Retrieves configuration information for datafeeds.
You can get information for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get information for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves configuration information for datafeeds. + /// You can get information for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get information for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2927,7 +4382,14 @@ public virtual GetDatafeedsResponse GetDatafeeds(Action - /// Retrieves configuration information for datafeeds.
You can get information for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get information for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves configuration information for datafeeds. + /// You can get information for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get information for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDatafeedsAsync(GetDatafeedsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2937,7 +4399,14 @@ public virtual Task GetDatafeedsAsync(GetDatafeedsRequestD } /// - /// Retrieves configuration information for datafeeds.
You can get information for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get information for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves configuration information for datafeeds. + /// You can get information for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get information for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDatafeedsAsync(Elastic.Clients.Elasticsearch.Ids? datafeedId, CancellationToken cancellationToken = default) @@ -2948,7 +4417,14 @@ public virtual Task GetDatafeedsAsync(Elastic.Clients.Elas } /// - /// Retrieves configuration information for datafeeds.
You can get information for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get information for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves configuration information for datafeeds. + /// You can get information for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get information for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDatafeedsAsync(Elastic.Clients.Elasticsearch.Ids? datafeedId, Action configureRequest, CancellationToken cancellationToken = default) @@ -2960,7 +4436,14 @@ public virtual Task GetDatafeedsAsync(Elastic.Clients.Elas } /// - /// Retrieves configuration information for datafeeds.
You can get information for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get information for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves configuration information for datafeeds. + /// You can get information for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get information for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDatafeedsAsync(CancellationToken cancellationToken = default) @@ -2971,7 +4454,14 @@ public virtual Task GetDatafeedsAsync(CancellationToken ca } /// - /// Retrieves configuration information for datafeeds.
You can get information for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get information for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves configuration information for datafeeds. + /// You can get information for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get information for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDatafeedsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -2983,7 +4473,15 @@ public virtual Task GetDatafeedsAsync(Action - /// Retrieves usage information for datafeeds.
You can get statistics for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get statistics for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``. If the datafeed is stopped, the
only information you receive is the `datafeed_id` and the `state`.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves usage information for datafeeds. + /// You can get statistics for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get statistics for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. If the datafeed is stopped, the + /// only information you receive is the datafeed_id and the state. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2994,7 +4492,15 @@ public virtual GetDatafeedStatsResponse GetDatafeedStats(GetDatafeedStatsRequest } /// - /// Retrieves usage information for datafeeds.
You can get statistics for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get statistics for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``. If the datafeed is stopped, the
only information you receive is the `datafeed_id` and the `state`.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves usage information for datafeeds. + /// You can get statistics for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get statistics for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. If the datafeed is stopped, the + /// only information you receive is the datafeed_id and the state. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDatafeedStatsAsync(GetDatafeedStatsRequest request, CancellationToken cancellationToken = default) @@ -3004,7 +4510,15 @@ public virtual Task GetDatafeedStatsAsync(GetDatafeedS } /// - /// Retrieves usage information for datafeeds.
You can get statistics for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get statistics for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``. If the datafeed is stopped, the
only information you receive is the `datafeed_id` and the `state`.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves usage information for datafeeds. + /// You can get statistics for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get statistics for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. If the datafeed is stopped, the + /// only information you receive is the datafeed_id and the state. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3015,7 +4529,15 @@ public virtual GetDatafeedStatsResponse GetDatafeedStats(GetDatafeedStatsRequest } /// - /// Retrieves usage information for datafeeds.
You can get statistics for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get statistics for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``. If the datafeed is stopped, the
only information you receive is the `datafeed_id` and the `state`.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves usage information for datafeeds. + /// You can get statistics for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get statistics for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. If the datafeed is stopped, the + /// only information you receive is the datafeed_id and the state. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3027,7 +4549,15 @@ public virtual GetDatafeedStatsResponse GetDatafeedStats(Elastic.Clients.Elastic } /// - /// Retrieves usage information for datafeeds.
You can get statistics for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get statistics for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``. If the datafeed is stopped, the
only information you receive is the `datafeed_id` and the `state`.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves usage information for datafeeds. + /// You can get statistics for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get statistics for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. If the datafeed is stopped, the + /// only information you receive is the datafeed_id and the state. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3040,7 +4570,15 @@ public virtual GetDatafeedStatsResponse GetDatafeedStats(Elastic.Clients.Elastic } /// - /// Retrieves usage information for datafeeds.
You can get statistics for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get statistics for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``. If the datafeed is stopped, the
only information you receive is the `datafeed_id` and the `state`.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves usage information for datafeeds. + /// You can get statistics for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get statistics for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. If the datafeed is stopped, the + /// only information you receive is the datafeed_id and the state. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3052,7 +4590,15 @@ public virtual GetDatafeedStatsResponse GetDatafeedStats() } /// - /// Retrieves usage information for datafeeds.
You can get statistics for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get statistics for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``. If the datafeed is stopped, the
only information you receive is the `datafeed_id` and the `state`.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves usage information for datafeeds. + /// You can get statistics for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get statistics for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. If the datafeed is stopped, the + /// only information you receive is the datafeed_id and the state. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3065,7 +4611,15 @@ public virtual GetDatafeedStatsResponse GetDatafeedStats(Action - /// Retrieves usage information for datafeeds.
You can get statistics for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get statistics for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``. If the datafeed is stopped, the
only information you receive is the `datafeed_id` and the `state`.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves usage information for datafeeds. + /// You can get statistics for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get statistics for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. If the datafeed is stopped, the + /// only information you receive is the datafeed_id and the state. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDatafeedStatsAsync(GetDatafeedStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3075,7 +4629,15 @@ public virtual Task GetDatafeedStatsAsync(GetDatafeedS } /// - /// Retrieves usage information for datafeeds.
You can get statistics for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get statistics for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``. If the datafeed is stopped, the
only information you receive is the `datafeed_id` and the `state`.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves usage information for datafeeds. + /// You can get statistics for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get statistics for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. If the datafeed is stopped, the + /// only information you receive is the datafeed_id and the state. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDatafeedStatsAsync(Elastic.Clients.Elasticsearch.Ids? datafeedId, CancellationToken cancellationToken = default) @@ -3086,7 +4648,15 @@ public virtual Task GetDatafeedStatsAsync(Elastic.Clie } /// - /// Retrieves usage information for datafeeds.
You can get statistics for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get statistics for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``. If the datafeed is stopped, the
only information you receive is the `datafeed_id` and the `state`.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves usage information for datafeeds. + /// You can get statistics for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get statistics for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. If the datafeed is stopped, the + /// only information you receive is the datafeed_id and the state. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDatafeedStatsAsync(Elastic.Clients.Elasticsearch.Ids? datafeedId, Action configureRequest, CancellationToken cancellationToken = default) @@ -3098,7 +4668,15 @@ public virtual Task GetDatafeedStatsAsync(Elastic.Clie } /// - /// Retrieves usage information for datafeeds.
You can get statistics for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get statistics for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``. If the datafeed is stopped, the
only information you receive is the `datafeed_id` and the `state`.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves usage information for datafeeds. + /// You can get statistics for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get statistics for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. If the datafeed is stopped, the + /// only information you receive is the datafeed_id and the state. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDatafeedStatsAsync(CancellationToken cancellationToken = default) @@ -3109,7 +4687,15 @@ public virtual Task GetDatafeedStatsAsync(Cancellation } /// - /// Retrieves usage information for datafeeds.
You can get statistics for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get statistics for all datafeeds by using `_all`, by specifying `*` as the
``, or by omitting the ``. If the datafeed is stopped, the
only information you receive is the `datafeed_id` and the `state`.
This API returns a maximum of 10,000 datafeeds. + /// + /// Retrieves usage information for datafeeds. + /// You can get statistics for multiple datafeeds in a single API request by + /// using a comma-separated list of datafeeds or a wildcard expression. You can + /// get statistics for all datafeeds by using _all, by specifying * as the + /// <feed_id>, or by omitting the <feed_id>. If the datafeed is stopped, the + /// only information you receive is the datafeed_id and the state. + /// This API returns a maximum of 10,000 datafeeds. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDatafeedStatsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -3121,7 +4707,12 @@ public virtual Task GetDatafeedStatsAsync(Action - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3132,7 +4723,12 @@ public virtual GetDataFrameAnalyticsResponse GetDataFrameAnalytics(GetDataFrameA } /// - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsAsync(GetDataFrameAnalyticsRequest request, CancellationToken cancellationToken = default) @@ -3142,7 +4738,12 @@ public virtual Task GetDataFrameAnalyticsAsync(Ge } /// - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3153,7 +4754,12 @@ public virtual GetDataFrameAnalyticsResponse GetDataFrameAnalytics(Ge } /// - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3165,7 +4771,12 @@ public virtual GetDataFrameAnalyticsResponse GetDataFrameAnalytics(El } /// - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3178,7 +4789,12 @@ public virtual GetDataFrameAnalyticsResponse GetDataFrameAnalytics(El } /// - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3190,7 +4806,12 @@ public virtual GetDataFrameAnalyticsResponse GetDataFrameAnalytics() } /// - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3203,7 +4824,12 @@ public virtual GetDataFrameAnalyticsResponse GetDataFrameAnalytics(Ac } /// - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3214,7 +4840,12 @@ public virtual GetDataFrameAnalyticsResponse GetDataFrameAnalytics(GetDataFrameA } /// - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3226,7 +4857,12 @@ public virtual GetDataFrameAnalyticsResponse GetDataFrameAnalytics(Elastic.Clien } /// - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3239,7 +4875,12 @@ public virtual GetDataFrameAnalyticsResponse GetDataFrameAnalytics(Elastic.Clien } /// - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3251,7 +4892,12 @@ public virtual GetDataFrameAnalyticsResponse GetDataFrameAnalytics() } /// - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3264,7 +4910,12 @@ public virtual GetDataFrameAnalyticsResponse GetDataFrameAnalytics(Action - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsAsync(GetDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3274,7 +4925,12 @@ public virtual Task GetDataFrameAnalyticsAsync - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id? id, CancellationToken cancellationToken = default) @@ -3285,7 +4941,12 @@ public virtual Task GetDataFrameAnalyticsAsync - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id? id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3297,7 +4958,12 @@ public virtual Task GetDataFrameAnalyticsAsync - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsAsync(CancellationToken cancellationToken = default) @@ -3308,7 +4974,12 @@ public virtual Task GetDataFrameAnalyticsAsync - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -3320,7 +4991,12 @@ public virtual Task GetDataFrameAnalyticsAsync - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsAsync(GetDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3330,7 +5006,12 @@ public virtual Task GetDataFrameAnalyticsAsync(Ge } /// - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id? id, CancellationToken cancellationToken = default) @@ -3341,7 +5022,12 @@ public virtual Task GetDataFrameAnalyticsAsync(El } /// - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id? id, Action configureRequest, CancellationToken cancellationToken = default) @@ -3353,7 +5039,12 @@ public virtual Task GetDataFrameAnalyticsAsync(El } /// - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsAsync(CancellationToken cancellationToken = default) @@ -3364,7 +5055,12 @@ public virtual Task GetDataFrameAnalyticsAsync(Ca } /// - /// Retrieves configuration information for data frame analytics jobs.
You can get information for multiple data frame analytics jobs in a single
API request by using a comma-separated list of data frame analytics jobs or a
wildcard expression. + /// + /// Retrieves configuration information for data frame analytics jobs. + /// You can get information for multiple data frame analytics jobs in a single + /// API request by using a comma-separated list of data frame analytics jobs or a + /// wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -3376,7 +5072,9 @@ public virtual Task GetDataFrameAnalyticsAsync(Ac } /// - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3387,7 +5085,9 @@ public virtual GetDataFrameAnalyticsStatsResponse GetDataFrameAnalyticsStats(Get } /// - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsStatsAsync(GetDataFrameAnalyticsStatsRequest request, CancellationToken cancellationToken = default) @@ -3397,7 +5097,9 @@ public virtual Task GetDataFrameAnalyticsSta } /// - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3408,7 +5110,9 @@ public virtual GetDataFrameAnalyticsStatsResponse GetDataFrameAnalyticsStats - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3420,7 +5124,9 @@ public virtual GetDataFrameAnalyticsStatsResponse GetDataFrameAnalyticsStats - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3433,7 +5139,9 @@ public virtual GetDataFrameAnalyticsStatsResponse GetDataFrameAnalyticsStats - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3445,7 +5153,9 @@ public virtual GetDataFrameAnalyticsStatsResponse GetDataFrameAnalyticsStats - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3458,7 +5168,9 @@ public virtual GetDataFrameAnalyticsStatsResponse GetDataFrameAnalyticsStats - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3469,7 +5181,9 @@ public virtual GetDataFrameAnalyticsStatsResponse GetDataFrameAnalyticsStats(Get } /// - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3481,7 +5195,9 @@ public virtual GetDataFrameAnalyticsStatsResponse GetDataFrameAnalyticsStats(Ela } /// - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3494,7 +5210,9 @@ public virtual GetDataFrameAnalyticsStatsResponse GetDataFrameAnalyticsStats(Ela } /// - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3506,7 +5224,9 @@ public virtual GetDataFrameAnalyticsStatsResponse GetDataFrameAnalyticsStats() } /// - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3519,7 +5239,9 @@ public virtual GetDataFrameAnalyticsStatsResponse GetDataFrameAnalyticsStats(Act } /// - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsStatsAsync(GetDataFrameAnalyticsStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3529,7 +5251,9 @@ public virtual Task GetDataFrameAnalyticsSta } /// - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsStatsAsync(Elastic.Clients.Elasticsearch.Id? id, CancellationToken cancellationToken = default) @@ -3540,7 +5264,9 @@ public virtual Task GetDataFrameAnalyticsSta } /// - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsStatsAsync(Elastic.Clients.Elasticsearch.Id? id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3552,7 +5278,9 @@ public virtual Task GetDataFrameAnalyticsSta } /// - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsStatsAsync(CancellationToken cancellationToken = default) @@ -3563,7 +5291,9 @@ public virtual Task GetDataFrameAnalyticsSta } /// - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsStatsAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -3575,7 +5305,9 @@ public virtual Task GetDataFrameAnalyticsSta } /// - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsStatsAsync(GetDataFrameAnalyticsStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3585,7 +5317,9 @@ public virtual Task GetDataFrameAnalyticsSta } /// - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsStatsAsync(Elastic.Clients.Elasticsearch.Id? id, CancellationToken cancellationToken = default) @@ -3596,7 +5330,9 @@ public virtual Task GetDataFrameAnalyticsSta } /// - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsStatsAsync(Elastic.Clients.Elasticsearch.Id? id, Action configureRequest, CancellationToken cancellationToken = default) @@ -3608,7 +5344,9 @@ public virtual Task GetDataFrameAnalyticsSta } /// - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsStatsAsync(CancellationToken cancellationToken = default) @@ -3619,7 +5357,9 @@ public virtual Task GetDataFrameAnalyticsSta } /// - /// Retrieves usage information for data frame analytics jobs. + /// + /// Retrieves usage information for data frame analytics jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetDataFrameAnalyticsStatsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -3631,7 +5371,10 @@ public virtual Task GetDataFrameAnalyticsSta } /// - /// Retrieves filters.
You can get a single filter or all filters. + /// + /// Retrieves filters. + /// You can get a single filter or all filters. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3642,7 +5385,10 @@ public virtual GetFiltersResponse GetFilters(GetFiltersRequest request) } /// - /// Retrieves filters.
You can get a single filter or all filters. + /// + /// Retrieves filters. + /// You can get a single filter or all filters. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetFiltersAsync(GetFiltersRequest request, CancellationToken cancellationToken = default) @@ -3652,7 +5398,10 @@ public virtual Task GetFiltersAsync(GetFiltersRequest reques } /// - /// Retrieves filters.
You can get a single filter or all filters. + /// + /// Retrieves filters. + /// You can get a single filter or all filters. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3663,7 +5412,10 @@ public virtual GetFiltersResponse GetFilters(GetFiltersRequestDescriptor descrip } /// - /// Retrieves filters.
You can get a single filter or all filters. + /// + /// Retrieves filters. + /// You can get a single filter or all filters. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3675,7 +5427,10 @@ public virtual GetFiltersResponse GetFilters(Elastic.Clients.Elasticsearch.Ids? } /// - /// Retrieves filters.
You can get a single filter or all filters. + /// + /// Retrieves filters. + /// You can get a single filter or all filters. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3688,7 +5443,10 @@ public virtual GetFiltersResponse GetFilters(Elastic.Clients.Elasticsearch.Ids? } /// - /// Retrieves filters.
You can get a single filter or all filters. + /// + /// Retrieves filters. + /// You can get a single filter or all filters. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3700,7 +5458,10 @@ public virtual GetFiltersResponse GetFilters() } /// - /// Retrieves filters.
You can get a single filter or all filters. + /// + /// Retrieves filters. + /// You can get a single filter or all filters. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3713,7 +5474,10 @@ public virtual GetFiltersResponse GetFilters(Action } /// - /// Retrieves filters.
You can get a single filter or all filters. + /// + /// Retrieves filters. + /// You can get a single filter or all filters. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetFiltersAsync(GetFiltersRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3723,7 +5487,10 @@ public virtual Task GetFiltersAsync(GetFiltersRequestDescrip } /// - /// Retrieves filters.
You can get a single filter or all filters. + /// + /// Retrieves filters. + /// You can get a single filter or all filters. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetFiltersAsync(Elastic.Clients.Elasticsearch.Ids? filterId, CancellationToken cancellationToken = default) @@ -3734,7 +5501,10 @@ public virtual Task GetFiltersAsync(Elastic.Clients.Elastics } /// - /// Retrieves filters.
You can get a single filter or all filters. + /// + /// Retrieves filters. + /// You can get a single filter or all filters. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetFiltersAsync(Elastic.Clients.Elasticsearch.Ids? filterId, Action configureRequest, CancellationToken cancellationToken = default) @@ -3746,7 +5516,10 @@ public virtual Task GetFiltersAsync(Elastic.Clients.Elastics } /// - /// Retrieves filters.
You can get a single filter or all filters. + /// + /// Retrieves filters. + /// You can get a single filter or all filters. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetFiltersAsync(CancellationToken cancellationToken = default) @@ -3757,7 +5530,10 @@ public virtual Task GetFiltersAsync(CancellationToken cancel } /// - /// Retrieves filters.
You can get a single filter or all filters. + /// + /// Retrieves filters. + /// You can get a single filter or all filters. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetFiltersAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -3769,7 +5545,12 @@ public virtual Task GetFiltersAsync(Action - /// Retrieves anomaly detection job results for one or more influencers.
Influencers are the entities that have contributed to, or are to blame for,
the anomalies. Influencer results are available only if an
`influencer_field_name` is specified in the job configuration. + /// + /// Retrieves anomaly detection job results for one or more influencers. + /// Influencers are the entities that have contributed to, or are to blame for, + /// the anomalies. Influencer results are available only if an + /// influencer_field_name is specified in the job configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3780,7 +5561,12 @@ public virtual GetInfluencersResponse GetInfluencers(GetInfluencersRequest reque } /// - /// Retrieves anomaly detection job results for one or more influencers.
Influencers are the entities that have contributed to, or are to blame for,
the anomalies. Influencer results are available only if an
`influencer_field_name` is specified in the job configuration. + /// + /// Retrieves anomaly detection job results for one or more influencers. + /// Influencers are the entities that have contributed to, or are to blame for, + /// the anomalies. Influencer results are available only if an + /// influencer_field_name is specified in the job configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetInfluencersAsync(GetInfluencersRequest request, CancellationToken cancellationToken = default) @@ -3790,7 +5576,12 @@ public virtual Task GetInfluencersAsync(GetInfluencersRe } /// - /// Retrieves anomaly detection job results for one or more influencers.
Influencers are the entities that have contributed to, or are to blame for,
the anomalies. Influencer results are available only if an
`influencer_field_name` is specified in the job configuration. + /// + /// Retrieves anomaly detection job results for one or more influencers. + /// Influencers are the entities that have contributed to, or are to blame for, + /// the anomalies. Influencer results are available only if an + /// influencer_field_name is specified in the job configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3801,7 +5592,12 @@ public virtual GetInfluencersResponse GetInfluencers(GetInfluencersRe } /// - /// Retrieves anomaly detection job results for one or more influencers.
Influencers are the entities that have contributed to, or are to blame for,
the anomalies. Influencer results are available only if an
`influencer_field_name` is specified in the job configuration. + /// + /// Retrieves anomaly detection job results for one or more influencers. + /// Influencers are the entities that have contributed to, or are to blame for, + /// the anomalies. Influencer results are available only if an + /// influencer_field_name is specified in the job configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3813,7 +5609,12 @@ public virtual GetInfluencersResponse GetInfluencers(Elastic.Clients. } /// - /// Retrieves anomaly detection job results for one or more influencers.
Influencers are the entities that have contributed to, or are to blame for,
the anomalies. Influencer results are available only if an
`influencer_field_name` is specified in the job configuration. + /// + /// Retrieves anomaly detection job results for one or more influencers. + /// Influencers are the entities that have contributed to, or are to blame for, + /// the anomalies. Influencer results are available only if an + /// influencer_field_name is specified in the job configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3826,7 +5627,12 @@ public virtual GetInfluencersResponse GetInfluencers(Elastic.Clients. } /// - /// Retrieves anomaly detection job results for one or more influencers.
Influencers are the entities that have contributed to, or are to blame for,
the anomalies. Influencer results are available only if an
`influencer_field_name` is specified in the job configuration. + /// + /// Retrieves anomaly detection job results for one or more influencers. + /// Influencers are the entities that have contributed to, or are to blame for, + /// the anomalies. Influencer results are available only if an + /// influencer_field_name is specified in the job configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3837,7 +5643,12 @@ public virtual GetInfluencersResponse GetInfluencers(GetInfluencersRequestDescri } /// - /// Retrieves anomaly detection job results for one or more influencers.
Influencers are the entities that have contributed to, or are to blame for,
the anomalies. Influencer results are available only if an
`influencer_field_name` is specified in the job configuration. + /// + /// Retrieves anomaly detection job results for one or more influencers. + /// Influencers are the entities that have contributed to, or are to blame for, + /// the anomalies. Influencer results are available only if an + /// influencer_field_name is specified in the job configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3849,7 +5660,12 @@ public virtual GetInfluencersResponse GetInfluencers(Elastic.Clients.Elasticsear } /// - /// Retrieves anomaly detection job results for one or more influencers.
Influencers are the entities that have contributed to, or are to blame for,
the anomalies. Influencer results are available only if an
`influencer_field_name` is specified in the job configuration. + /// + /// Retrieves anomaly detection job results for one or more influencers. + /// Influencers are the entities that have contributed to, or are to blame for, + /// the anomalies. Influencer results are available only if an + /// influencer_field_name is specified in the job configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3862,7 +5678,12 @@ public virtual GetInfluencersResponse GetInfluencers(Elastic.Clients.Elasticsear } /// - /// Retrieves anomaly detection job results for one or more influencers.
Influencers are the entities that have contributed to, or are to blame for,
the anomalies. Influencer results are available only if an
`influencer_field_name` is specified in the job configuration. + /// + /// Retrieves anomaly detection job results for one or more influencers. + /// Influencers are the entities that have contributed to, or are to blame for, + /// the anomalies. Influencer results are available only if an + /// influencer_field_name is specified in the job configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetInfluencersAsync(GetInfluencersRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3872,7 +5693,12 @@ public virtual Task GetInfluencersAsync(GetIn } /// - /// Retrieves anomaly detection job results for one or more influencers.
Influencers are the entities that have contributed to, or are to blame for,
the anomalies. Influencer results are available only if an
`influencer_field_name` is specified in the job configuration. + /// + /// Retrieves anomaly detection job results for one or more influencers. + /// Influencers are the entities that have contributed to, or are to blame for, + /// the anomalies. Influencer results are available only if an + /// influencer_field_name is specified in the job configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetInfluencersAsync(Elastic.Clients.Elasticsearch.Id jobId, CancellationToken cancellationToken = default) @@ -3883,7 +5709,12 @@ public virtual Task GetInfluencersAsync(Elast } /// - /// Retrieves anomaly detection job results for one or more influencers.
Influencers are the entities that have contributed to, or are to blame for,
the anomalies. Influencer results are available only if an
`influencer_field_name` is specified in the job configuration. + /// + /// Retrieves anomaly detection job results for one or more influencers. + /// Influencers are the entities that have contributed to, or are to blame for, + /// the anomalies. Influencer results are available only if an + /// influencer_field_name is specified in the job configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetInfluencersAsync(Elastic.Clients.Elasticsearch.Id jobId, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3895,7 +5726,12 @@ public virtual Task GetInfluencersAsync(Elast } /// - /// Retrieves anomaly detection job results for one or more influencers.
Influencers are the entities that have contributed to, or are to blame for,
the anomalies. Influencer results are available only if an
`influencer_field_name` is specified in the job configuration. + /// + /// Retrieves anomaly detection job results for one or more influencers. + /// Influencers are the entities that have contributed to, or are to blame for, + /// the anomalies. Influencer results are available only if an + /// influencer_field_name is specified in the job configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetInfluencersAsync(GetInfluencersRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3905,7 +5741,12 @@ public virtual Task GetInfluencersAsync(GetInfluencersRe } /// - /// Retrieves anomaly detection job results for one or more influencers.
Influencers are the entities that have contributed to, or are to blame for,
the anomalies. Influencer results are available only if an
`influencer_field_name` is specified in the job configuration. + /// + /// Retrieves anomaly detection job results for one or more influencers. + /// Influencers are the entities that have contributed to, or are to blame for, + /// the anomalies. Influencer results are available only if an + /// influencer_field_name is specified in the job configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetInfluencersAsync(Elastic.Clients.Elasticsearch.Id jobId, CancellationToken cancellationToken = default) @@ -3916,7 +5757,12 @@ public virtual Task GetInfluencersAsync(Elastic.Clients. } /// - /// Retrieves anomaly detection job results for one or more influencers.
Influencers are the entities that have contributed to, or are to blame for,
the anomalies. Influencer results are available only if an
`influencer_field_name` is specified in the job configuration. + /// + /// Retrieves anomaly detection job results for one or more influencers. + /// Influencers are the entities that have contributed to, or are to blame for, + /// the anomalies. Influencer results are available only if an + /// influencer_field_name is specified in the job configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetInfluencersAsync(Elastic.Clients.Elasticsearch.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -3928,7 +5774,13 @@ public virtual Task GetInfluencersAsync(Elastic.Clients. } /// - /// Retrieves configuration information for anomaly detection jobs.
You can get information for multiple anomaly detection jobs in a single API
request by using a group name, a comma-separated list of jobs, or a wildcard
expression. You can get information for all anomaly detection jobs by using
`_all`, by specifying `*` as the ``, or by omitting the ``. + /// + /// Retrieves configuration information for anomaly detection jobs. + /// You can get information for multiple anomaly detection jobs in a single API + /// request by using a group name, a comma-separated list of jobs, or a wildcard + /// expression. You can get information for all anomaly detection jobs by using + /// _all, by specifying * as the <job_id>, or by omitting the <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3939,7 +5791,13 @@ public virtual GetJobsResponse GetJobs(GetJobsRequest request) } /// - /// Retrieves configuration information for anomaly detection jobs.
You can get information for multiple anomaly detection jobs in a single API
request by using a group name, a comma-separated list of jobs, or a wildcard
expression. You can get information for all anomaly detection jobs by using
`_all`, by specifying `*` as the ``, or by omitting the ``. + /// + /// Retrieves configuration information for anomaly detection jobs. + /// You can get information for multiple anomaly detection jobs in a single API + /// request by using a group name, a comma-separated list of jobs, or a wildcard + /// expression. You can get information for all anomaly detection jobs by using + /// _all, by specifying * as the <job_id>, or by omitting the <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobsAsync(GetJobsRequest request, CancellationToken cancellationToken = default) @@ -3949,7 +5807,13 @@ public virtual Task GetJobsAsync(GetJobsRequest request, Cancel } /// - /// Retrieves configuration information for anomaly detection jobs.
You can get information for multiple anomaly detection jobs in a single API
request by using a group name, a comma-separated list of jobs, or a wildcard
expression. You can get information for all anomaly detection jobs by using
`_all`, by specifying `*` as the ``, or by omitting the ``. + /// + /// Retrieves configuration information for anomaly detection jobs. + /// You can get information for multiple anomaly detection jobs in a single API + /// request by using a group name, a comma-separated list of jobs, or a wildcard + /// expression. You can get information for all anomaly detection jobs by using + /// _all, by specifying * as the <job_id>, or by omitting the <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3960,7 +5824,13 @@ public virtual GetJobsResponse GetJobs(GetJobsRequestDescriptor descriptor) } /// - /// Retrieves configuration information for anomaly detection jobs.
You can get information for multiple anomaly detection jobs in a single API
request by using a group name, a comma-separated list of jobs, or a wildcard
expression. You can get information for all anomaly detection jobs by using
`_all`, by specifying `*` as the ``, or by omitting the ``. + /// + /// Retrieves configuration information for anomaly detection jobs. + /// You can get information for multiple anomaly detection jobs in a single API + /// request by using a group name, a comma-separated list of jobs, or a wildcard + /// expression. You can get information for all anomaly detection jobs by using + /// _all, by specifying * as the <job_id>, or by omitting the <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3972,7 +5842,13 @@ public virtual GetJobsResponse GetJobs(Elastic.Clients.Elasticsearch.Ids? jobId) } /// - /// Retrieves configuration information for anomaly detection jobs.
You can get information for multiple anomaly detection jobs in a single API
request by using a group name, a comma-separated list of jobs, or a wildcard
expression. You can get information for all anomaly detection jobs by using
`_all`, by specifying `*` as the ``, or by omitting the ``. + /// + /// Retrieves configuration information for anomaly detection jobs. + /// You can get information for multiple anomaly detection jobs in a single API + /// request by using a group name, a comma-separated list of jobs, or a wildcard + /// expression. You can get information for all anomaly detection jobs by using + /// _all, by specifying * as the <job_id>, or by omitting the <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3985,7 +5861,13 @@ public virtual GetJobsResponse GetJobs(Elastic.Clients.Elasticsearch.Ids? jobId, } /// - /// Retrieves configuration information for anomaly detection jobs.
You can get information for multiple anomaly detection jobs in a single API
request by using a group name, a comma-separated list of jobs, or a wildcard
expression. You can get information for all anomaly detection jobs by using
`_all`, by specifying `*` as the ``, or by omitting the ``. + /// + /// Retrieves configuration information for anomaly detection jobs. + /// You can get information for multiple anomaly detection jobs in a single API + /// request by using a group name, a comma-separated list of jobs, or a wildcard + /// expression. You can get information for all anomaly detection jobs by using + /// _all, by specifying * as the <job_id>, or by omitting the <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3997,7 +5879,13 @@ public virtual GetJobsResponse GetJobs() } /// - /// Retrieves configuration information for anomaly detection jobs.
You can get information for multiple anomaly detection jobs in a single API
request by using a group name, a comma-separated list of jobs, or a wildcard
expression. You can get information for all anomaly detection jobs by using
`_all`, by specifying `*` as the ``, or by omitting the ``. + /// + /// Retrieves configuration information for anomaly detection jobs. + /// You can get information for multiple anomaly detection jobs in a single API + /// request by using a group name, a comma-separated list of jobs, or a wildcard + /// expression. You can get information for all anomaly detection jobs by using + /// _all, by specifying * as the <job_id>, or by omitting the <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4010,7 +5898,13 @@ public virtual GetJobsResponse GetJobs(Action configur } /// - /// Retrieves configuration information for anomaly detection jobs.
You can get information for multiple anomaly detection jobs in a single API
request by using a group name, a comma-separated list of jobs, or a wildcard
expression. You can get information for all anomaly detection jobs by using
`_all`, by specifying `*` as the ``, or by omitting the ``. + /// + /// Retrieves configuration information for anomaly detection jobs. + /// You can get information for multiple anomaly detection jobs in a single API + /// request by using a group name, a comma-separated list of jobs, or a wildcard + /// expression. You can get information for all anomaly detection jobs by using + /// _all, by specifying * as the <job_id>, or by omitting the <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobsAsync(GetJobsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4020,7 +5914,13 @@ public virtual Task GetJobsAsync(GetJobsRequestDescriptor descr } /// - /// Retrieves configuration information for anomaly detection jobs.
You can get information for multiple anomaly detection jobs in a single API
request by using a group name, a comma-separated list of jobs, or a wildcard
expression. You can get information for all anomaly detection jobs by using
`_all`, by specifying `*` as the ``, or by omitting the ``. + /// + /// Retrieves configuration information for anomaly detection jobs. + /// You can get information for multiple anomaly detection jobs in a single API + /// request by using a group name, a comma-separated list of jobs, or a wildcard + /// expression. You can get information for all anomaly detection jobs by using + /// _all, by specifying * as the <job_id>, or by omitting the <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobsAsync(Elastic.Clients.Elasticsearch.Ids? jobId, CancellationToken cancellationToken = default) @@ -4031,7 +5931,13 @@ public virtual Task GetJobsAsync(Elastic.Clients.Elasticsearch. } /// - /// Retrieves configuration information for anomaly detection jobs.
You can get information for multiple anomaly detection jobs in a single API
request by using a group name, a comma-separated list of jobs, or a wildcard
expression. You can get information for all anomaly detection jobs by using
`_all`, by specifying `*` as the ``, or by omitting the ``. + /// + /// Retrieves configuration information for anomaly detection jobs. + /// You can get information for multiple anomaly detection jobs in a single API + /// request by using a group name, a comma-separated list of jobs, or a wildcard + /// expression. You can get information for all anomaly detection jobs by using + /// _all, by specifying * as the <job_id>, or by omitting the <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobsAsync(Elastic.Clients.Elasticsearch.Ids? jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -4043,7 +5949,13 @@ public virtual Task GetJobsAsync(Elastic.Clients.Elasticsearch. } /// - /// Retrieves configuration information for anomaly detection jobs.
You can get information for multiple anomaly detection jobs in a single API
request by using a group name, a comma-separated list of jobs, or a wildcard
expression. You can get information for all anomaly detection jobs by using
`_all`, by specifying `*` as the ``, or by omitting the ``. + /// + /// Retrieves configuration information for anomaly detection jobs. + /// You can get information for multiple anomaly detection jobs in a single API + /// request by using a group name, a comma-separated list of jobs, or a wildcard + /// expression. You can get information for all anomaly detection jobs by using + /// _all, by specifying * as the <job_id>, or by omitting the <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobsAsync(CancellationToken cancellationToken = default) @@ -4054,7 +5966,13 @@ public virtual Task GetJobsAsync(CancellationToken cancellation } /// - /// Retrieves configuration information for anomaly detection jobs.
You can get information for multiple anomaly detection jobs in a single API
request by using a group name, a comma-separated list of jobs, or a wildcard
expression. You can get information for all anomaly detection jobs by using
`_all`, by specifying `*` as the ``, or by omitting the ``. + /// + /// Retrieves configuration information for anomaly detection jobs. + /// You can get information for multiple anomaly detection jobs in a single API + /// request by using a group name, a comma-separated list of jobs, or a wildcard + /// expression. You can get information for all anomaly detection jobs by using + /// _all, by specifying * as the <job_id>, or by omitting the <job_id>. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -4066,7 +5984,9 @@ public virtual Task GetJobsAsync(Action - /// Retrieves usage information for anomaly detection jobs. + /// + /// Retrieves usage information for anomaly detection jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4077,7 +5997,9 @@ public virtual GetJobStatsResponse GetJobStats(GetJobStatsRequest request) } /// - /// Retrieves usage information for anomaly detection jobs. + /// + /// Retrieves usage information for anomaly detection jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobStatsAsync(GetJobStatsRequest request, CancellationToken cancellationToken = default) @@ -4087,7 +6009,9 @@ public virtual Task GetJobStatsAsync(GetJobStatsRequest req } /// - /// Retrieves usage information for anomaly detection jobs. + /// + /// Retrieves usage information for anomaly detection jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4098,7 +6022,9 @@ public virtual GetJobStatsResponse GetJobStats(GetJobStatsRequestDescriptor desc } /// - /// Retrieves usage information for anomaly detection jobs. + /// + /// Retrieves usage information for anomaly detection jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4110,7 +6036,9 @@ public virtual GetJobStatsResponse GetJobStats(Elastic.Clients.Elasticsearch.Id? } /// - /// Retrieves usage information for anomaly detection jobs. + /// + /// Retrieves usage information for anomaly detection jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4123,7 +6051,9 @@ public virtual GetJobStatsResponse GetJobStats(Elastic.Clients.Elasticsearch.Id? } /// - /// Retrieves usage information for anomaly detection jobs. + /// + /// Retrieves usage information for anomaly detection jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4135,7 +6065,9 @@ public virtual GetJobStatsResponse GetJobStats() } /// - /// Retrieves usage information for anomaly detection jobs. + /// + /// Retrieves usage information for anomaly detection jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4148,7 +6080,9 @@ public virtual GetJobStatsResponse GetJobStats(Action - /// Retrieves usage information for anomaly detection jobs. + /// + /// Retrieves usage information for anomaly detection jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobStatsAsync(GetJobStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4158,7 +6092,9 @@ public virtual Task GetJobStatsAsync(GetJobStatsRequestDesc } /// - /// Retrieves usage information for anomaly detection jobs. + /// + /// Retrieves usage information for anomaly detection jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobStatsAsync(Elastic.Clients.Elasticsearch.Id? jobId, CancellationToken cancellationToken = default) @@ -4169,7 +6105,9 @@ public virtual Task GetJobStatsAsync(Elastic.Clients.Elasti } /// - /// Retrieves usage information for anomaly detection jobs. + /// + /// Retrieves usage information for anomaly detection jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobStatsAsync(Elastic.Clients.Elasticsearch.Id? jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -4181,7 +6119,9 @@ public virtual Task GetJobStatsAsync(Elastic.Clients.Elasti } /// - /// Retrieves usage information for anomaly detection jobs. + /// + /// Retrieves usage information for anomaly detection jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobStatsAsync(CancellationToken cancellationToken = default) @@ -4192,7 +6132,9 @@ public virtual Task GetJobStatsAsync(CancellationToken canc } /// - /// Retrieves usage information for anomaly detection jobs. + /// + /// Retrieves usage information for anomaly detection jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobStatsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -4204,7 +6146,10 @@ public virtual Task GetJobStatsAsync(Action - /// Get information about how machine learning jobs and trained models are using memory,
on each node, both within the JVM heap, and natively, outside of the JVM. + /// + /// Get information about how machine learning jobs and trained models are using memory, + /// on each node, both within the JVM heap, and natively, outside of the JVM. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4215,7 +6160,10 @@ public virtual GetMemoryStatsResponse GetMemoryStats(GetMemoryStatsRequest reque } /// - /// Get information about how machine learning jobs and trained models are using memory,
on each node, both within the JVM heap, and natively, outside of the JVM. + /// + /// Get information about how machine learning jobs and trained models are using memory, + /// on each node, both within the JVM heap, and natively, outside of the JVM. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMemoryStatsAsync(GetMemoryStatsRequest request, CancellationToken cancellationToken = default) @@ -4225,7 +6173,10 @@ public virtual Task GetMemoryStatsAsync(GetMemoryStatsRe } /// - /// Get information about how machine learning jobs and trained models are using memory,
on each node, both within the JVM heap, and natively, outside of the JVM. + /// + /// Get information about how machine learning jobs and trained models are using memory, + /// on each node, both within the JVM heap, and natively, outside of the JVM. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4236,7 +6187,10 @@ public virtual GetMemoryStatsResponse GetMemoryStats(GetMemoryStatsRequestDescri } /// - /// Get information about how machine learning jobs and trained models are using memory,
on each node, both within the JVM heap, and natively, outside of the JVM. + /// + /// Get information about how machine learning jobs and trained models are using memory, + /// on each node, both within the JVM heap, and natively, outside of the JVM. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4248,7 +6202,10 @@ public virtual GetMemoryStatsResponse GetMemoryStats(Elastic.Clients.Elasticsear } /// - /// Get information about how machine learning jobs and trained models are using memory,
on each node, both within the JVM heap, and natively, outside of the JVM. + /// + /// Get information about how machine learning jobs and trained models are using memory, + /// on each node, both within the JVM heap, and natively, outside of the JVM. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4261,7 +6218,10 @@ public virtual GetMemoryStatsResponse GetMemoryStats(Elastic.Clients.Elasticsear } /// - /// Get information about how machine learning jobs and trained models are using memory,
on each node, both within the JVM heap, and natively, outside of the JVM. + /// + /// Get information about how machine learning jobs and trained models are using memory, + /// on each node, both within the JVM heap, and natively, outside of the JVM. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4273,7 +6233,10 @@ public virtual GetMemoryStatsResponse GetMemoryStats() } /// - /// Get information about how machine learning jobs and trained models are using memory,
on each node, both within the JVM heap, and natively, outside of the JVM. + /// + /// Get information about how machine learning jobs and trained models are using memory, + /// on each node, both within the JVM heap, and natively, outside of the JVM. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4286,7 +6249,10 @@ public virtual GetMemoryStatsResponse GetMemoryStats(Action - /// Get information about how machine learning jobs and trained models are using memory,
on each node, both within the JVM heap, and natively, outside of the JVM. + /// + /// Get information about how machine learning jobs and trained models are using memory, + /// on each node, both within the JVM heap, and natively, outside of the JVM. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMemoryStatsAsync(GetMemoryStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4296,7 +6262,10 @@ public virtual Task GetMemoryStatsAsync(GetMemoryStatsRe } /// - /// Get information about how machine learning jobs and trained models are using memory,
on each node, both within the JVM heap, and natively, outside of the JVM. + /// + /// Get information about how machine learning jobs and trained models are using memory, + /// on each node, both within the JVM heap, and natively, outside of the JVM. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMemoryStatsAsync(Elastic.Clients.Elasticsearch.Id? nodeId, CancellationToken cancellationToken = default) @@ -4307,7 +6276,10 @@ public virtual Task GetMemoryStatsAsync(Elastic.Clients. } /// - /// Get information about how machine learning jobs and trained models are using memory,
on each node, both within the JVM heap, and natively, outside of the JVM. + /// + /// Get information about how machine learning jobs and trained models are using memory, + /// on each node, both within the JVM heap, and natively, outside of the JVM. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMemoryStatsAsync(Elastic.Clients.Elasticsearch.Id? nodeId, Action configureRequest, CancellationToken cancellationToken = default) @@ -4319,7 +6291,10 @@ public virtual Task GetMemoryStatsAsync(Elastic.Clients. } /// - /// Get information about how machine learning jobs and trained models are using memory,
on each node, both within the JVM heap, and natively, outside of the JVM. + /// + /// Get information about how machine learning jobs and trained models are using memory, + /// on each node, both within the JVM heap, and natively, outside of the JVM. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMemoryStatsAsync(CancellationToken cancellationToken = default) @@ -4330,7 +6305,10 @@ public virtual Task GetMemoryStatsAsync(CancellationToke } /// - /// Get information about how machine learning jobs and trained models are using memory,
on each node, both within the JVM heap, and natively, outside of the JVM. + /// + /// Get information about how machine learning jobs and trained models are using memory, + /// on each node, both within the JVM heap, and natively, outside of the JVM. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetMemoryStatsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -4342,7 +6320,9 @@ public virtual Task GetMemoryStatsAsync(Action - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4353,7 +6333,9 @@ public virtual GetModelSnapshotsResponse GetModelSnapshots(GetModelSnapshotsRequ } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetModelSnapshotsAsync(GetModelSnapshotsRequest request, CancellationToken cancellationToken = default) @@ -4363,7 +6345,9 @@ public virtual Task GetModelSnapshotsAsync(GetModelSn } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4374,7 +6358,9 @@ public virtual GetModelSnapshotsResponse GetModelSnapshots(GetModelSn } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4386,7 +6372,9 @@ public virtual GetModelSnapshotsResponse GetModelSnapshots(Elastic.Cl } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4399,7 +6387,9 @@ public virtual GetModelSnapshotsResponse GetModelSnapshots(Elastic.Cl } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4411,7 +6401,9 @@ public virtual GetModelSnapshotsResponse GetModelSnapshots(Elastic.Cl } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4424,7 +6416,9 @@ public virtual GetModelSnapshotsResponse GetModelSnapshots(Elastic.Cl } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4435,7 +6429,9 @@ public virtual GetModelSnapshotsResponse GetModelSnapshots(GetModelSnapshotsRequ } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4447,7 +6443,9 @@ public virtual GetModelSnapshotsResponse GetModelSnapshots(Elastic.Clients.Elast } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4460,7 +6458,9 @@ public virtual GetModelSnapshotsResponse GetModelSnapshots(Elastic.Clients.Elast } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4472,7 +6472,9 @@ public virtual GetModelSnapshotsResponse GetModelSnapshots(Elastic.Clients.Elast } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4485,7 +6487,9 @@ public virtual GetModelSnapshotsResponse GetModelSnapshots(Elastic.Clients.Elast } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetModelSnapshotsAsync(GetModelSnapshotsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4495,7 +6499,9 @@ public virtual Task GetModelSnapshotsAsync } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetModelSnapshotsAsync(Elastic.Clients.Elasticsearch.Id jobId, Elastic.Clients.Elasticsearch.Id? snapshotId, CancellationToken cancellationToken = default) @@ -4506,7 +6512,9 @@ public virtual Task GetModelSnapshotsAsync } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetModelSnapshotsAsync(Elastic.Clients.Elasticsearch.Id jobId, Elastic.Clients.Elasticsearch.Id? snapshotId, Action> configureRequest, CancellationToken cancellationToken = default) @@ -4518,7 +6526,9 @@ public virtual Task GetModelSnapshotsAsync } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetModelSnapshotsAsync(Elastic.Clients.Elasticsearch.Id jobId, CancellationToken cancellationToken = default) @@ -4529,7 +6539,9 @@ public virtual Task GetModelSnapshotsAsync } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetModelSnapshotsAsync(Elastic.Clients.Elasticsearch.Id jobId, Action> configureRequest, CancellationToken cancellationToken = default) @@ -4541,7 +6553,9 @@ public virtual Task GetModelSnapshotsAsync } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetModelSnapshotsAsync(GetModelSnapshotsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4551,7 +6565,9 @@ public virtual Task GetModelSnapshotsAsync(GetModelSn } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetModelSnapshotsAsync(Elastic.Clients.Elasticsearch.Id jobId, Elastic.Clients.Elasticsearch.Id? snapshotId, CancellationToken cancellationToken = default) @@ -4562,7 +6578,9 @@ public virtual Task GetModelSnapshotsAsync(Elastic.Cl } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetModelSnapshotsAsync(Elastic.Clients.Elasticsearch.Id jobId, Elastic.Clients.Elasticsearch.Id? snapshotId, Action configureRequest, CancellationToken cancellationToken = default) @@ -4574,7 +6592,9 @@ public virtual Task GetModelSnapshotsAsync(Elastic.Cl } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetModelSnapshotsAsync(Elastic.Clients.Elasticsearch.Id jobId, CancellationToken cancellationToken = default) @@ -4585,7 +6605,9 @@ public virtual Task GetModelSnapshotsAsync(Elastic.Cl } /// - /// Retrieves information about model snapshots. + /// + /// Retrieves information about model snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetModelSnapshotsAsync(Elastic.Clients.Elasticsearch.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -4597,7 +6619,9 @@ public virtual Task GetModelSnapshotsAsync(Elastic.Cl } /// - /// Retrieves usage information for anomaly detection job model snapshot upgrades. + /// + /// Retrieves usage information for anomaly detection job model snapshot upgrades. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4608,7 +6632,9 @@ public virtual GetModelSnapshotUpgradeStatsResponse GetModelSnapshotUpgradeStats } /// - /// Retrieves usage information for anomaly detection job model snapshot upgrades. + /// + /// Retrieves usage information for anomaly detection job model snapshot upgrades. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetModelSnapshotUpgradeStatsAsync(GetModelSnapshotUpgradeStatsRequest request, CancellationToken cancellationToken = default) @@ -4618,7 +6644,9 @@ public virtual Task GetModelSnapshotUpgrad } /// - /// Retrieves usage information for anomaly detection job model snapshot upgrades. + /// + /// Retrieves usage information for anomaly detection job model snapshot upgrades. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4629,7 +6657,9 @@ public virtual GetModelSnapshotUpgradeStatsResponse GetModelSnapshotUpgradeStats } /// - /// Retrieves usage information for anomaly detection job model snapshot upgrades. + /// + /// Retrieves usage information for anomaly detection job model snapshot upgrades. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4641,7 +6671,9 @@ public virtual GetModelSnapshotUpgradeStatsResponse GetModelSnapshotUpgradeStats } /// - /// Retrieves usage information for anomaly detection job model snapshot upgrades. + /// + /// Retrieves usage information for anomaly detection job model snapshot upgrades. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4654,7 +6686,9 @@ public virtual GetModelSnapshotUpgradeStatsResponse GetModelSnapshotUpgradeStats } /// - /// Retrieves usage information for anomaly detection job model snapshot upgrades. + /// + /// Retrieves usage information for anomaly detection job model snapshot upgrades. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetModelSnapshotUpgradeStatsAsync(GetModelSnapshotUpgradeStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4664,7 +6698,9 @@ public virtual Task GetModelSnapshotUpgrad } /// - /// Retrieves usage information for anomaly detection job model snapshot upgrades. + /// + /// Retrieves usage information for anomaly detection job model snapshot upgrades. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetModelSnapshotUpgradeStatsAsync(Elastic.Clients.Elasticsearch.Id jobId, Elastic.Clients.Elasticsearch.Id snapshotId, CancellationToken cancellationToken = default) @@ -4675,7 +6711,9 @@ public virtual Task GetModelSnapshotUpgrad } /// - /// Retrieves usage information for anomaly detection job model snapshot upgrades. + /// + /// Retrieves usage information for anomaly detection job model snapshot upgrades. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetModelSnapshotUpgradeStatsAsync(Elastic.Clients.Elasticsearch.Id jobId, Elastic.Clients.Elasticsearch.Id snapshotId, Action configureRequest, CancellationToken cancellationToken = default) @@ -4687,8 +6725,26 @@ public virtual Task GetModelSnapshotUpgrad } /// - /// Retrieves overall bucket results that summarize the bucket results of
multiple anomaly detection jobs. - /// The `overall_score` is calculated by combining the scores of all the
buckets within the overall bucket span. First, the maximum
`anomaly_score` per anomaly detection job in the overall bucket is
calculated. Then the `top_n` of those scores are averaged to result in
the `overall_score`. This means that you can fine-tune the
`overall_score` so that it is more or less sensitive to the number of
jobs that detect an anomaly at the same time. For example, if you set
`top_n` to `1`, the `overall_score` is the maximum bucket score in the
overall bucket. Alternatively, if you set `top_n` to the number of jobs,
the `overall_score` is high only when all jobs detect anomalies in that
overall bucket. If you set the `bucket_span` parameter (to a value
greater than its default), the `overall_score` is the maximum
`overall_score` of the overall buckets that have a span equal to the
jobs' largest bucket span. + /// + /// Retrieves overall bucket results that summarize the bucket results of + /// multiple anomaly detection jobs. + /// + /// + /// The overall_score is calculated by combining the scores of all the + /// buckets within the overall bucket span. First, the maximum + /// anomaly_score per anomaly detection job in the overall bucket is + /// calculated. Then the top_n of those scores are averaged to result in + /// the overall_score. This means that you can fine-tune the + /// overall_score so that it is more or less sensitive to the number of + /// jobs that detect an anomaly at the same time. For example, if you set + /// top_n to 1, the overall_score is the maximum bucket score in the + /// overall bucket. Alternatively, if you set top_n to the number of jobs, + /// the overall_score is high only when all jobs detect anomalies in that + /// overall bucket. If you set the bucket_span parameter (to a value + /// greater than its default), the overall_score is the maximum + /// overall_score of the overall buckets that have a span equal to the + /// jobs' largest bucket span. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4699,8 +6755,26 @@ public virtual GetOverallBucketsResponse GetOverallBuckets(GetOverallBucketsRequ } /// - /// Retrieves overall bucket results that summarize the bucket results of
multiple anomaly detection jobs. - /// The `overall_score` is calculated by combining the scores of all the
buckets within the overall bucket span. First, the maximum
`anomaly_score` per anomaly detection job in the overall bucket is
calculated. Then the `top_n` of those scores are averaged to result in
the `overall_score`. This means that you can fine-tune the
`overall_score` so that it is more or less sensitive to the number of
jobs that detect an anomaly at the same time. For example, if you set
`top_n` to `1`, the `overall_score` is the maximum bucket score in the
overall bucket. Alternatively, if you set `top_n` to the number of jobs,
the `overall_score` is high only when all jobs detect anomalies in that
overall bucket. If you set the `bucket_span` parameter (to a value
greater than its default), the `overall_score` is the maximum
`overall_score` of the overall buckets that have a span equal to the
jobs' largest bucket span. + /// + /// Retrieves overall bucket results that summarize the bucket results of + /// multiple anomaly detection jobs. + /// + /// + /// The overall_score is calculated by combining the scores of all the + /// buckets within the overall bucket span. First, the maximum + /// anomaly_score per anomaly detection job in the overall bucket is + /// calculated. Then the top_n of those scores are averaged to result in + /// the overall_score. This means that you can fine-tune the + /// overall_score so that it is more or less sensitive to the number of + /// jobs that detect an anomaly at the same time. For example, if you set + /// top_n to 1, the overall_score is the maximum bucket score in the + /// overall bucket. Alternatively, if you set top_n to the number of jobs, + /// the overall_score is high only when all jobs detect anomalies in that + /// overall bucket. If you set the bucket_span parameter (to a value + /// greater than its default), the overall_score is the maximum + /// overall_score of the overall buckets that have a span equal to the + /// jobs' largest bucket span. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetOverallBucketsAsync(GetOverallBucketsRequest request, CancellationToken cancellationToken = default) @@ -4710,8 +6784,26 @@ public virtual Task GetOverallBucketsAsync(GetOverall } /// - /// Retrieves overall bucket results that summarize the bucket results of
multiple anomaly detection jobs. - /// The `overall_score` is calculated by combining the scores of all the
buckets within the overall bucket span. First, the maximum
`anomaly_score` per anomaly detection job in the overall bucket is
calculated. Then the `top_n` of those scores are averaged to result in
the `overall_score`. This means that you can fine-tune the
`overall_score` so that it is more or less sensitive to the number of
jobs that detect an anomaly at the same time. For example, if you set
`top_n` to `1`, the `overall_score` is the maximum bucket score in the
overall bucket. Alternatively, if you set `top_n` to the number of jobs,
the `overall_score` is high only when all jobs detect anomalies in that
overall bucket. If you set the `bucket_span` parameter (to a value
greater than its default), the `overall_score` is the maximum
`overall_score` of the overall buckets that have a span equal to the
jobs' largest bucket span. + /// + /// Retrieves overall bucket results that summarize the bucket results of + /// multiple anomaly detection jobs. + /// + /// + /// The overall_score is calculated by combining the scores of all the + /// buckets within the overall bucket span. First, the maximum + /// anomaly_score per anomaly detection job in the overall bucket is + /// calculated. Then the top_n of those scores are averaged to result in + /// the overall_score. This means that you can fine-tune the + /// overall_score so that it is more or less sensitive to the number of + /// jobs that detect an anomaly at the same time. For example, if you set + /// top_n to 1, the overall_score is the maximum bucket score in the + /// overall bucket. Alternatively, if you set top_n to the number of jobs, + /// the overall_score is high only when all jobs detect anomalies in that + /// overall bucket. If you set the bucket_span parameter (to a value + /// greater than its default), the overall_score is the maximum + /// overall_score of the overall buckets that have a span equal to the + /// jobs' largest bucket span. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4722,8 +6814,26 @@ public virtual GetOverallBucketsResponse GetOverallBuckets(GetOverallBucketsRequ } /// - /// Retrieves overall bucket results that summarize the bucket results of
multiple anomaly detection jobs. - /// The `overall_score` is calculated by combining the scores of all the
buckets within the overall bucket span. First, the maximum
`anomaly_score` per anomaly detection job in the overall bucket is
calculated. Then the `top_n` of those scores are averaged to result in
the `overall_score`. This means that you can fine-tune the
`overall_score` so that it is more or less sensitive to the number of
jobs that detect an anomaly at the same time. For example, if you set
`top_n` to `1`, the `overall_score` is the maximum bucket score in the
overall bucket. Alternatively, if you set `top_n` to the number of jobs,
the `overall_score` is high only when all jobs detect anomalies in that
overall bucket. If you set the `bucket_span` parameter (to a value
greater than its default), the `overall_score` is the maximum
`overall_score` of the overall buckets that have a span equal to the
jobs' largest bucket span. + /// + /// Retrieves overall bucket results that summarize the bucket results of + /// multiple anomaly detection jobs. + /// + /// + /// The overall_score is calculated by combining the scores of all the + /// buckets within the overall bucket span. First, the maximum + /// anomaly_score per anomaly detection job in the overall bucket is + /// calculated. Then the top_n of those scores are averaged to result in + /// the overall_score. This means that you can fine-tune the + /// overall_score so that it is more or less sensitive to the number of + /// jobs that detect an anomaly at the same time. For example, if you set + /// top_n to 1, the overall_score is the maximum bucket score in the + /// overall bucket. Alternatively, if you set top_n to the number of jobs, + /// the overall_score is high only when all jobs detect anomalies in that + /// overall bucket. If you set the bucket_span parameter (to a value + /// greater than its default), the overall_score is the maximum + /// overall_score of the overall buckets that have a span equal to the + /// jobs' largest bucket span. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4735,8 +6845,26 @@ public virtual GetOverallBucketsResponse GetOverallBuckets(Elastic.Clients.Elast } /// - /// Retrieves overall bucket results that summarize the bucket results of
multiple anomaly detection jobs. - /// The `overall_score` is calculated by combining the scores of all the
buckets within the overall bucket span. First, the maximum
`anomaly_score` per anomaly detection job in the overall bucket is
calculated. Then the `top_n` of those scores are averaged to result in
the `overall_score`. This means that you can fine-tune the
`overall_score` so that it is more or less sensitive to the number of
jobs that detect an anomaly at the same time. For example, if you set
`top_n` to `1`, the `overall_score` is the maximum bucket score in the
overall bucket. Alternatively, if you set `top_n` to the number of jobs,
the `overall_score` is high only when all jobs detect anomalies in that
overall bucket. If you set the `bucket_span` parameter (to a value
greater than its default), the `overall_score` is the maximum
`overall_score` of the overall buckets that have a span equal to the
jobs' largest bucket span. + /// + /// Retrieves overall bucket results that summarize the bucket results of + /// multiple anomaly detection jobs. + /// + /// + /// The overall_score is calculated by combining the scores of all the + /// buckets within the overall bucket span. First, the maximum + /// anomaly_score per anomaly detection job in the overall bucket is + /// calculated. Then the top_n of those scores are averaged to result in + /// the overall_score. This means that you can fine-tune the + /// overall_score so that it is more or less sensitive to the number of + /// jobs that detect an anomaly at the same time. For example, if you set + /// top_n to 1, the overall_score is the maximum bucket score in the + /// overall bucket. Alternatively, if you set top_n to the number of jobs, + /// the overall_score is high only when all jobs detect anomalies in that + /// overall bucket. If you set the bucket_span parameter (to a value + /// greater than its default), the overall_score is the maximum + /// overall_score of the overall buckets that have a span equal to the + /// jobs' largest bucket span. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4749,8 +6877,26 @@ public virtual GetOverallBucketsResponse GetOverallBuckets(Elastic.Clients.Elast } /// - /// Retrieves overall bucket results that summarize the bucket results of
multiple anomaly detection jobs. - /// The `overall_score` is calculated by combining the scores of all the
buckets within the overall bucket span. First, the maximum
`anomaly_score` per anomaly detection job in the overall bucket is
calculated. Then the `top_n` of those scores are averaged to result in
the `overall_score`. This means that you can fine-tune the
`overall_score` so that it is more or less sensitive to the number of
jobs that detect an anomaly at the same time. For example, if you set
`top_n` to `1`, the `overall_score` is the maximum bucket score in the
overall bucket. Alternatively, if you set `top_n` to the number of jobs,
the `overall_score` is high only when all jobs detect anomalies in that
overall bucket. If you set the `bucket_span` parameter (to a value
greater than its default), the `overall_score` is the maximum
`overall_score` of the overall buckets that have a span equal to the
jobs' largest bucket span. + /// + /// Retrieves overall bucket results that summarize the bucket results of + /// multiple anomaly detection jobs. + /// + /// + /// The overall_score is calculated by combining the scores of all the + /// buckets within the overall bucket span. First, the maximum + /// anomaly_score per anomaly detection job in the overall bucket is + /// calculated. Then the top_n of those scores are averaged to result in + /// the overall_score. This means that you can fine-tune the + /// overall_score so that it is more or less sensitive to the number of + /// jobs that detect an anomaly at the same time. For example, if you set + /// top_n to 1, the overall_score is the maximum bucket score in the + /// overall bucket. Alternatively, if you set top_n to the number of jobs, + /// the overall_score is high only when all jobs detect anomalies in that + /// overall bucket. If you set the bucket_span parameter (to a value + /// greater than its default), the overall_score is the maximum + /// overall_score of the overall buckets that have a span equal to the + /// jobs' largest bucket span. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetOverallBucketsAsync(GetOverallBucketsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4760,8 +6906,26 @@ public virtual Task GetOverallBucketsAsync(GetOverall } /// - /// Retrieves overall bucket results that summarize the bucket results of
multiple anomaly detection jobs. - /// The `overall_score` is calculated by combining the scores of all the
buckets within the overall bucket span. First, the maximum
`anomaly_score` per anomaly detection job in the overall bucket is
calculated. Then the `top_n` of those scores are averaged to result in
the `overall_score`. This means that you can fine-tune the
`overall_score` so that it is more or less sensitive to the number of
jobs that detect an anomaly at the same time. For example, if you set
`top_n` to `1`, the `overall_score` is the maximum bucket score in the
overall bucket. Alternatively, if you set `top_n` to the number of jobs,
the `overall_score` is high only when all jobs detect anomalies in that
overall bucket. If you set the `bucket_span` parameter (to a value
greater than its default), the `overall_score` is the maximum
`overall_score` of the overall buckets that have a span equal to the
jobs' largest bucket span. + /// + /// Retrieves overall bucket results that summarize the bucket results of + /// multiple anomaly detection jobs. + /// + /// + /// The overall_score is calculated by combining the scores of all the + /// buckets within the overall bucket span. First, the maximum + /// anomaly_score per anomaly detection job in the overall bucket is + /// calculated. Then the top_n of those scores are averaged to result in + /// the overall_score. This means that you can fine-tune the + /// overall_score so that it is more or less sensitive to the number of + /// jobs that detect an anomaly at the same time. For example, if you set + /// top_n to 1, the overall_score is the maximum bucket score in the + /// overall bucket. Alternatively, if you set top_n to the number of jobs, + /// the overall_score is high only when all jobs detect anomalies in that + /// overall bucket. If you set the bucket_span parameter (to a value + /// greater than its default), the overall_score is the maximum + /// overall_score of the overall buckets that have a span equal to the + /// jobs' largest bucket span. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetOverallBucketsAsync(Elastic.Clients.Elasticsearch.Id jobId, CancellationToken cancellationToken = default) @@ -4772,8 +6936,26 @@ public virtual Task GetOverallBucketsAsync(Elastic.Cl } /// - /// Retrieves overall bucket results that summarize the bucket results of
multiple anomaly detection jobs. - /// The `overall_score` is calculated by combining the scores of all the
buckets within the overall bucket span. First, the maximum
`anomaly_score` per anomaly detection job in the overall bucket is
calculated. Then the `top_n` of those scores are averaged to result in
the `overall_score`. This means that you can fine-tune the
`overall_score` so that it is more or less sensitive to the number of
jobs that detect an anomaly at the same time. For example, if you set
`top_n` to `1`, the `overall_score` is the maximum bucket score in the
overall bucket. Alternatively, if you set `top_n` to the number of jobs,
the `overall_score` is high only when all jobs detect anomalies in that
overall bucket. If you set the `bucket_span` parameter (to a value
greater than its default), the `overall_score` is the maximum
`overall_score` of the overall buckets that have a span equal to the
jobs' largest bucket span. + /// + /// Retrieves overall bucket results that summarize the bucket results of + /// multiple anomaly detection jobs. + /// + /// + /// The overall_score is calculated by combining the scores of all the + /// buckets within the overall bucket span. First, the maximum + /// anomaly_score per anomaly detection job in the overall bucket is + /// calculated. Then the top_n of those scores are averaged to result in + /// the overall_score. This means that you can fine-tune the + /// overall_score so that it is more or less sensitive to the number of + /// jobs that detect an anomaly at the same time. For example, if you set + /// top_n to 1, the overall_score is the maximum bucket score in the + /// overall bucket. Alternatively, if you set top_n to the number of jobs, + /// the overall_score is high only when all jobs detect anomalies in that + /// overall bucket. If you set the bucket_span parameter (to a value + /// greater than its default), the overall_score is the maximum + /// overall_score of the overall buckets that have a span equal to the + /// jobs' largest bucket span. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetOverallBucketsAsync(Elastic.Clients.Elasticsearch.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -4785,7 +6967,19 @@ public virtual Task GetOverallBucketsAsync(Elastic.Cl } /// - /// Retrieves anomaly records for an anomaly detection job.
Records contain the detailed analytical results. They describe the anomalous
activity that has been identified in the input data based on the detector
configuration.
There can be many anomaly records depending on the characteristics and size
of the input data. In practice, there are often too many to be able to
manually process them. The machine learning features therefore perform a
sophisticated aggregation of the anomaly records into buckets.
The number of record results depends on the number of anomalies found in each
bucket, which relates to the number of time series being modeled and the
number of detectors. + /// + /// Retrieves anomaly records for an anomaly detection job. + /// Records contain the detailed analytical results. They describe the anomalous + /// activity that has been identified in the input data based on the detector + /// configuration. + /// There can be many anomaly records depending on the characteristics and size + /// of the input data. In practice, there are often too many to be able to + /// manually process them. The machine learning features therefore perform a + /// sophisticated aggregation of the anomaly records into buckets. + /// The number of record results depends on the number of anomalies found in each + /// bucket, which relates to the number of time series being modeled and the + /// number of detectors. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4796,7 +6990,19 @@ public virtual GetRecordsResponse GetRecords(GetRecordsRequest request) } /// - /// Retrieves anomaly records for an anomaly detection job.
Records contain the detailed analytical results. They describe the anomalous
activity that has been identified in the input data based on the detector
configuration.
There can be many anomaly records depending on the characteristics and size
of the input data. In practice, there are often too many to be able to
manually process them. The machine learning features therefore perform a
sophisticated aggregation of the anomaly records into buckets.
The number of record results depends on the number of anomalies found in each
bucket, which relates to the number of time series being modeled and the
number of detectors. + /// + /// Retrieves anomaly records for an anomaly detection job. + /// Records contain the detailed analytical results. They describe the anomalous + /// activity that has been identified in the input data based on the detector + /// configuration. + /// There can be many anomaly records depending on the characteristics and size + /// of the input data. In practice, there are often too many to be able to + /// manually process them. The machine learning features therefore perform a + /// sophisticated aggregation of the anomaly records into buckets. + /// The number of record results depends on the number of anomalies found in each + /// bucket, which relates to the number of time series being modeled and the + /// number of detectors. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRecordsAsync(GetRecordsRequest request, CancellationToken cancellationToken = default) @@ -4806,7 +7012,19 @@ public virtual Task GetRecordsAsync(GetRecordsRequest reques } /// - /// Retrieves anomaly records for an anomaly detection job.
Records contain the detailed analytical results. They describe the anomalous
activity that has been identified in the input data based on the detector
configuration.
There can be many anomaly records depending on the characteristics and size
of the input data. In practice, there are often too many to be able to
manually process them. The machine learning features therefore perform a
sophisticated aggregation of the anomaly records into buckets.
The number of record results depends on the number of anomalies found in each
bucket, which relates to the number of time series being modeled and the
number of detectors. + /// + /// Retrieves anomaly records for an anomaly detection job. + /// Records contain the detailed analytical results. They describe the anomalous + /// activity that has been identified in the input data based on the detector + /// configuration. + /// There can be many anomaly records depending on the characteristics and size + /// of the input data. In practice, there are often too many to be able to + /// manually process them. The machine learning features therefore perform a + /// sophisticated aggregation of the anomaly records into buckets. + /// The number of record results depends on the number of anomalies found in each + /// bucket, which relates to the number of time series being modeled and the + /// number of detectors. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4817,7 +7035,19 @@ public virtual GetRecordsResponse GetRecords(GetRecordsRequestDescrip } /// - /// Retrieves anomaly records for an anomaly detection job.
Records contain the detailed analytical results. They describe the anomalous
activity that has been identified in the input data based on the detector
configuration.
There can be many anomaly records depending on the characteristics and size
of the input data. In practice, there are often too many to be able to
manually process them. The machine learning features therefore perform a
sophisticated aggregation of the anomaly records into buckets.
The number of record results depends on the number of anomalies found in each
bucket, which relates to the number of time series being modeled and the
number of detectors. + /// + /// Retrieves anomaly records for an anomaly detection job. + /// Records contain the detailed analytical results. They describe the anomalous + /// activity that has been identified in the input data based on the detector + /// configuration. + /// There can be many anomaly records depending on the characteristics and size + /// of the input data. In practice, there are often too many to be able to + /// manually process them. The machine learning features therefore perform a + /// sophisticated aggregation of the anomaly records into buckets. + /// The number of record results depends on the number of anomalies found in each + /// bucket, which relates to the number of time series being modeled and the + /// number of detectors. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4829,7 +7059,19 @@ public virtual GetRecordsResponse GetRecords(Elastic.Clients.Elastics } /// - /// Retrieves anomaly records for an anomaly detection job.
Records contain the detailed analytical results. They describe the anomalous
activity that has been identified in the input data based on the detector
configuration.
There can be many anomaly records depending on the characteristics and size
of the input data. In practice, there are often too many to be able to
manually process them. The machine learning features therefore perform a
sophisticated aggregation of the anomaly records into buckets.
The number of record results depends on the number of anomalies found in each
bucket, which relates to the number of time series being modeled and the
number of detectors. + /// + /// Retrieves anomaly records for an anomaly detection job. + /// Records contain the detailed analytical results. They describe the anomalous + /// activity that has been identified in the input data based on the detector + /// configuration. + /// There can be many anomaly records depending on the characteristics and size + /// of the input data. In practice, there are often too many to be able to + /// manually process them. The machine learning features therefore perform a + /// sophisticated aggregation of the anomaly records into buckets. + /// The number of record results depends on the number of anomalies found in each + /// bucket, which relates to the number of time series being modeled and the + /// number of detectors. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4842,7 +7084,19 @@ public virtual GetRecordsResponse GetRecords(Elastic.Clients.Elastics } /// - /// Retrieves anomaly records for an anomaly detection job.
Records contain the detailed analytical results. They describe the anomalous
activity that has been identified in the input data based on the detector
configuration.
There can be many anomaly records depending on the characteristics and size
of the input data. In practice, there are often too many to be able to
manually process them. The machine learning features therefore perform a
sophisticated aggregation of the anomaly records into buckets.
The number of record results depends on the number of anomalies found in each
bucket, which relates to the number of time series being modeled and the
number of detectors. + /// + /// Retrieves anomaly records for an anomaly detection job. + /// Records contain the detailed analytical results. They describe the anomalous + /// activity that has been identified in the input data based on the detector + /// configuration. + /// There can be many anomaly records depending on the characteristics and size + /// of the input data. In practice, there are often too many to be able to + /// manually process them. The machine learning features therefore perform a + /// sophisticated aggregation of the anomaly records into buckets. + /// The number of record results depends on the number of anomalies found in each + /// bucket, which relates to the number of time series being modeled and the + /// number of detectors. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4853,7 +7107,19 @@ public virtual GetRecordsResponse GetRecords(GetRecordsRequestDescriptor descrip } /// - /// Retrieves anomaly records for an anomaly detection job.
Records contain the detailed analytical results. They describe the anomalous
activity that has been identified in the input data based on the detector
configuration.
There can be many anomaly records depending on the characteristics and size
of the input data. In practice, there are often too many to be able to
manually process them. The machine learning features therefore perform a
sophisticated aggregation of the anomaly records into buckets.
The number of record results depends on the number of anomalies found in each
bucket, which relates to the number of time series being modeled and the
number of detectors. + /// + /// Retrieves anomaly records for an anomaly detection job. + /// Records contain the detailed analytical results. They describe the anomalous + /// activity that has been identified in the input data based on the detector + /// configuration. + /// There can be many anomaly records depending on the characteristics and size + /// of the input data. In practice, there are often too many to be able to + /// manually process them. The machine learning features therefore perform a + /// sophisticated aggregation of the anomaly records into buckets. + /// The number of record results depends on the number of anomalies found in each + /// bucket, which relates to the number of time series being modeled and the + /// number of detectors. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4865,7 +7131,19 @@ public virtual GetRecordsResponse GetRecords(Elastic.Clients.Elasticsearch.Id jo } /// - /// Retrieves anomaly records for an anomaly detection job.
Records contain the detailed analytical results. They describe the anomalous
activity that has been identified in the input data based on the detector
configuration.
There can be many anomaly records depending on the characteristics and size
of the input data. In practice, there are often too many to be able to
manually process them. The machine learning features therefore perform a
sophisticated aggregation of the anomaly records into buckets.
The number of record results depends on the number of anomalies found in each
bucket, which relates to the number of time series being modeled and the
number of detectors. + /// + /// Retrieves anomaly records for an anomaly detection job. + /// Records contain the detailed analytical results. They describe the anomalous + /// activity that has been identified in the input data based on the detector + /// configuration. + /// There can be many anomaly records depending on the characteristics and size + /// of the input data. In practice, there are often too many to be able to + /// manually process them. The machine learning features therefore perform a + /// sophisticated aggregation of the anomaly records into buckets. + /// The number of record results depends on the number of anomalies found in each + /// bucket, which relates to the number of time series being modeled and the + /// number of detectors. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4878,7 +7156,19 @@ public virtual GetRecordsResponse GetRecords(Elastic.Clients.Elasticsearch.Id jo } /// - /// Retrieves anomaly records for an anomaly detection job.
Records contain the detailed analytical results. They describe the anomalous
activity that has been identified in the input data based on the detector
configuration.
There can be many anomaly records depending on the characteristics and size
of the input data. In practice, there are often too many to be able to
manually process them. The machine learning features therefore perform a
sophisticated aggregation of the anomaly records into buckets.
The number of record results depends on the number of anomalies found in each
bucket, which relates to the number of time series being modeled and the
number of detectors. + /// + /// Retrieves anomaly records for an anomaly detection job. + /// Records contain the detailed analytical results. They describe the anomalous + /// activity that has been identified in the input data based on the detector + /// configuration. + /// There can be many anomaly records depending on the characteristics and size + /// of the input data. In practice, there are often too many to be able to + /// manually process them. The machine learning features therefore perform a + /// sophisticated aggregation of the anomaly records into buckets. + /// The number of record results depends on the number of anomalies found in each + /// bucket, which relates to the number of time series being modeled and the + /// number of detectors. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRecordsAsync(GetRecordsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4888,7 +7178,19 @@ public virtual Task GetRecordsAsync(GetRecordsReq } /// - /// Retrieves anomaly records for an anomaly detection job.
Records contain the detailed analytical results. They describe the anomalous
activity that has been identified in the input data based on the detector
configuration.
There can be many anomaly records depending on the characteristics and size
of the input data. In practice, there are often too many to be able to
manually process them. The machine learning features therefore perform a
sophisticated aggregation of the anomaly records into buckets.
The number of record results depends on the number of anomalies found in each
bucket, which relates to the number of time series being modeled and the
number of detectors. + /// + /// Retrieves anomaly records for an anomaly detection job. + /// Records contain the detailed analytical results. They describe the anomalous + /// activity that has been identified in the input data based on the detector + /// configuration. + /// There can be many anomaly records depending on the characteristics and size + /// of the input data. In practice, there are often too many to be able to + /// manually process them. The machine learning features therefore perform a + /// sophisticated aggregation of the anomaly records into buckets. + /// The number of record results depends on the number of anomalies found in each + /// bucket, which relates to the number of time series being modeled and the + /// number of detectors. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRecordsAsync(Elastic.Clients.Elasticsearch.Id jobId, CancellationToken cancellationToken = default) @@ -4899,7 +7201,19 @@ public virtual Task GetRecordsAsync(Elastic.Clien } /// - /// Retrieves anomaly records for an anomaly detection job.
Records contain the detailed analytical results. They describe the anomalous
activity that has been identified in the input data based on the detector
configuration.
There can be many anomaly records depending on the characteristics and size
of the input data. In practice, there are often too many to be able to
manually process them. The machine learning features therefore perform a
sophisticated aggregation of the anomaly records into buckets.
The number of record results depends on the number of anomalies found in each
bucket, which relates to the number of time series being modeled and the
number of detectors. + /// + /// Retrieves anomaly records for an anomaly detection job. + /// Records contain the detailed analytical results. They describe the anomalous + /// activity that has been identified in the input data based on the detector + /// configuration. + /// There can be many anomaly records depending on the characteristics and size + /// of the input data. In practice, there are often too many to be able to + /// manually process them. The machine learning features therefore perform a + /// sophisticated aggregation of the anomaly records into buckets. + /// The number of record results depends on the number of anomalies found in each + /// bucket, which relates to the number of time series being modeled and the + /// number of detectors. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRecordsAsync(Elastic.Clients.Elasticsearch.Id jobId, Action> configureRequest, CancellationToken cancellationToken = default) @@ -4911,7 +7225,19 @@ public virtual Task GetRecordsAsync(Elastic.Clien } /// - /// Retrieves anomaly records for an anomaly detection job.
Records contain the detailed analytical results. They describe the anomalous
activity that has been identified in the input data based on the detector
configuration.
There can be many anomaly records depending on the characteristics and size
of the input data. In practice, there are often too many to be able to
manually process them. The machine learning features therefore perform a
sophisticated aggregation of the anomaly records into buckets.
The number of record results depends on the number of anomalies found in each
bucket, which relates to the number of time series being modeled and the
number of detectors. + /// + /// Retrieves anomaly records for an anomaly detection job. + /// Records contain the detailed analytical results. They describe the anomalous + /// activity that has been identified in the input data based on the detector + /// configuration. + /// There can be many anomaly records depending on the characteristics and size + /// of the input data. In practice, there are often too many to be able to + /// manually process them. The machine learning features therefore perform a + /// sophisticated aggregation of the anomaly records into buckets. + /// The number of record results depends on the number of anomalies found in each + /// bucket, which relates to the number of time series being modeled and the + /// number of detectors. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRecordsAsync(GetRecordsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4921,7 +7247,19 @@ public virtual Task GetRecordsAsync(GetRecordsRequestDescrip } /// - /// Retrieves anomaly records for an anomaly detection job.
Records contain the detailed analytical results. They describe the anomalous
activity that has been identified in the input data based on the detector
configuration.
There can be many anomaly records depending on the characteristics and size
of the input data. In practice, there are often too many to be able to
manually process them. The machine learning features therefore perform a
sophisticated aggregation of the anomaly records into buckets.
The number of record results depends on the number of anomalies found in each
bucket, which relates to the number of time series being modeled and the
number of detectors. + /// + /// Retrieves anomaly records for an anomaly detection job. + /// Records contain the detailed analytical results. They describe the anomalous + /// activity that has been identified in the input data based on the detector + /// configuration. + /// There can be many anomaly records depending on the characteristics and size + /// of the input data. In practice, there are often too many to be able to + /// manually process them. The machine learning features therefore perform a + /// sophisticated aggregation of the anomaly records into buckets. + /// The number of record results depends on the number of anomalies found in each + /// bucket, which relates to the number of time series being modeled and the + /// number of detectors. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRecordsAsync(Elastic.Clients.Elasticsearch.Id jobId, CancellationToken cancellationToken = default) @@ -4932,7 +7270,19 @@ public virtual Task GetRecordsAsync(Elastic.Clients.Elastics } /// - /// Retrieves anomaly records for an anomaly detection job.
Records contain the detailed analytical results. They describe the anomalous
activity that has been identified in the input data based on the detector
configuration.
There can be many anomaly records depending on the characteristics and size
of the input data. In practice, there are often too many to be able to
manually process them. The machine learning features therefore perform a
sophisticated aggregation of the anomaly records into buckets.
The number of record results depends on the number of anomalies found in each
bucket, which relates to the number of time series being modeled and the
number of detectors. + /// + /// Retrieves anomaly records for an anomaly detection job. + /// Records contain the detailed analytical results. They describe the anomalous + /// activity that has been identified in the input data based on the detector + /// configuration. + /// There can be many anomaly records depending on the characteristics and size + /// of the input data. In practice, there are often too many to be able to + /// manually process them. The machine learning features therefore perform a + /// sophisticated aggregation of the anomaly records into buckets. + /// The number of record results depends on the number of anomalies found in each + /// bucket, which relates to the number of time series being modeled and the + /// number of detectors. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRecordsAsync(Elastic.Clients.Elasticsearch.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -4944,7 +7294,9 @@ public virtual Task GetRecordsAsync(Elastic.Clients.Elastics } /// - /// Retrieves configuration information for a trained model. + /// + /// Retrieves configuration information for a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4955,7 +7307,9 @@ public virtual GetTrainedModelsResponse GetTrainedModels(GetTrainedModelsRequest } /// - /// Retrieves configuration information for a trained model. + /// + /// Retrieves configuration information for a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTrainedModelsAsync(GetTrainedModelsRequest request, CancellationToken cancellationToken = default) @@ -4965,7 +7319,9 @@ public virtual Task GetTrainedModelsAsync(GetTrainedMo } /// - /// Retrieves configuration information for a trained model. + /// + /// Retrieves configuration information for a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4976,7 +7332,9 @@ public virtual GetTrainedModelsResponse GetTrainedModels(GetTrainedModelsRequest } /// - /// Retrieves configuration information for a trained model. + /// + /// Retrieves configuration information for a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4988,7 +7346,9 @@ public virtual GetTrainedModelsResponse GetTrainedModels(Elastic.Clients.Elastic } /// - /// Retrieves configuration information for a trained model. + /// + /// Retrieves configuration information for a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5001,7 +7361,9 @@ public virtual GetTrainedModelsResponse GetTrainedModels(Elastic.Clients.Elastic } /// - /// Retrieves configuration information for a trained model. + /// + /// Retrieves configuration information for a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5013,7 +7375,9 @@ public virtual GetTrainedModelsResponse GetTrainedModels() } /// - /// Retrieves configuration information for a trained model. + /// + /// Retrieves configuration information for a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5026,7 +7390,9 @@ public virtual GetTrainedModelsResponse GetTrainedModels(Action - /// Retrieves configuration information for a trained model. + /// + /// Retrieves configuration information for a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTrainedModelsAsync(GetTrainedModelsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -5036,7 +7402,9 @@ public virtual Task GetTrainedModelsAsync(GetTrainedMo } /// - /// Retrieves configuration information for a trained model. + /// + /// Retrieves configuration information for a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTrainedModelsAsync(Elastic.Clients.Elasticsearch.Ids? modelId, CancellationToken cancellationToken = default) @@ -5047,7 +7415,9 @@ public virtual Task GetTrainedModelsAsync(Elastic.Clie } /// - /// Retrieves configuration information for a trained model. + /// + /// Retrieves configuration information for a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTrainedModelsAsync(Elastic.Clients.Elasticsearch.Ids? modelId, Action configureRequest, CancellationToken cancellationToken = default) @@ -5059,7 +7429,9 @@ public virtual Task GetTrainedModelsAsync(Elastic.Clie } /// - /// Retrieves configuration information for a trained model. + /// + /// Retrieves configuration information for a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTrainedModelsAsync(CancellationToken cancellationToken = default) @@ -5070,7 +7442,9 @@ public virtual Task GetTrainedModelsAsync(Cancellation } /// - /// Retrieves configuration information for a trained model. + /// + /// Retrieves configuration information for a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTrainedModelsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -5082,7 +7456,10 @@ public virtual Task GetTrainedModelsAsync(Action - /// Retrieves usage information for trained models. You can get usage information for multiple trained
models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// + /// Retrieves usage information for trained models. You can get usage information for multiple trained + /// models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5093,7 +7470,10 @@ public virtual GetTrainedModelsStatsResponse GetTrainedModelsStats(GetTrainedMod } /// - /// Retrieves usage information for trained models. You can get usage information for multiple trained
models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// + /// Retrieves usage information for trained models. You can get usage information for multiple trained + /// models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTrainedModelsStatsAsync(GetTrainedModelsStatsRequest request, CancellationToken cancellationToken = default) @@ -5103,7 +7483,10 @@ public virtual Task GetTrainedModelsStatsAsync(Ge } /// - /// Retrieves usage information for trained models. You can get usage information for multiple trained
models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// + /// Retrieves usage information for trained models. You can get usage information for multiple trained + /// models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5114,7 +7497,10 @@ public virtual GetTrainedModelsStatsResponse GetTrainedModelsStats(GetTrainedMod } /// - /// Retrieves usage information for trained models. You can get usage information for multiple trained
models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// + /// Retrieves usage information for trained models. You can get usage information for multiple trained + /// models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5126,7 +7512,10 @@ public virtual GetTrainedModelsStatsResponse GetTrainedModelsStats(Elastic.Clien } /// - /// Retrieves usage information for trained models. You can get usage information for multiple trained
models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// + /// Retrieves usage information for trained models. You can get usage information for multiple trained + /// models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5139,7 +7528,10 @@ public virtual GetTrainedModelsStatsResponse GetTrainedModelsStats(Elastic.Clien } /// - /// Retrieves usage information for trained models. You can get usage information for multiple trained
models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// + /// Retrieves usage information for trained models. You can get usage information for multiple trained + /// models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5151,7 +7543,10 @@ public virtual GetTrainedModelsStatsResponse GetTrainedModelsStats() } /// - /// Retrieves usage information for trained models. You can get usage information for multiple trained
models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// + /// Retrieves usage information for trained models. You can get usage information for multiple trained + /// models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5164,7 +7559,10 @@ public virtual GetTrainedModelsStatsResponse GetTrainedModelsStats(Action - /// Retrieves usage information for trained models. You can get usage information for multiple trained
models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// + /// Retrieves usage information for trained models. You can get usage information for multiple trained + /// models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTrainedModelsStatsAsync(GetTrainedModelsStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -5174,7 +7572,10 @@ public virtual Task GetTrainedModelsStatsAsync(Ge } /// - /// Retrieves usage information for trained models. You can get usage information for multiple trained
models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// + /// Retrieves usage information for trained models. You can get usage information for multiple trained + /// models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTrainedModelsStatsAsync(Elastic.Clients.Elasticsearch.Ids? modelId, CancellationToken cancellationToken = default) @@ -5185,7 +7586,10 @@ public virtual Task GetTrainedModelsStatsAsync(El } /// - /// Retrieves usage information for trained models. You can get usage information for multiple trained
models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// + /// Retrieves usage information for trained models. You can get usage information for multiple trained + /// models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTrainedModelsStatsAsync(Elastic.Clients.Elasticsearch.Ids? modelId, Action configureRequest, CancellationToken cancellationToken = default) @@ -5197,7 +7601,10 @@ public virtual Task GetTrainedModelsStatsAsync(El } /// - /// Retrieves usage information for trained models. You can get usage information for multiple trained
models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// + /// Retrieves usage information for trained models. You can get usage information for multiple trained + /// models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTrainedModelsStatsAsync(CancellationToken cancellationToken = default) @@ -5208,7 +7615,10 @@ public virtual Task GetTrainedModelsStatsAsync(Ca } /// - /// Retrieves usage information for trained models. You can get usage information for multiple trained
models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// + /// Retrieves usage information for trained models. You can get usage information for multiple trained + /// models in a single API request by using a comma-separated list of model IDs or a wildcard expression. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTrainedModelsStatsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -5220,7 +7630,9 @@ public virtual Task GetTrainedModelsStatsAsync(Ac } /// - /// Evaluates a trained model. + /// + /// Evaluates a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5231,7 +7643,9 @@ public virtual InferTrainedModelResponse InferTrainedModel(InferTrainedModelRequ } /// - /// Evaluates a trained model. + /// + /// Evaluates a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InferTrainedModelAsync(InferTrainedModelRequest request, CancellationToken cancellationToken = default) @@ -5241,7 +7655,9 @@ public virtual Task InferTrainedModelAsync(InferTrain } /// - /// Evaluates a trained model. + /// + /// Evaluates a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5252,7 +7668,9 @@ public virtual InferTrainedModelResponse InferTrainedModel(InferTrain } /// - /// Evaluates a trained model. + /// + /// Evaluates a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5264,7 +7682,9 @@ public virtual InferTrainedModelResponse InferTrainedModel(Elastic.Cl } /// - /// Evaluates a trained model. + /// + /// Evaluates a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5277,7 +7697,9 @@ public virtual InferTrainedModelResponse InferTrainedModel(Elastic.Cl } /// - /// Evaluates a trained model. + /// + /// Evaluates a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5288,7 +7710,9 @@ public virtual InferTrainedModelResponse InferTrainedModel(InferTrainedModelRequ } /// - /// Evaluates a trained model. + /// + /// Evaluates a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5300,7 +7724,9 @@ public virtual InferTrainedModelResponse InferTrainedModel(Elastic.Clients.Elast } /// - /// Evaluates a trained model. + /// + /// Evaluates a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5313,7 +7739,9 @@ public virtual InferTrainedModelResponse InferTrainedModel(Elastic.Clients.Elast } /// - /// Evaluates a trained model. + /// + /// Evaluates a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InferTrainedModelAsync(InferTrainedModelRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -5323,7 +7751,9 @@ public virtual Task InferTrainedModelAsync } /// - /// Evaluates a trained model. + /// + /// Evaluates a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InferTrainedModelAsync(Elastic.Clients.Elasticsearch.Id modelId, CancellationToken cancellationToken = default) @@ -5334,7 +7764,9 @@ public virtual Task InferTrainedModelAsync } /// - /// Evaluates a trained model. + /// + /// Evaluates a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InferTrainedModelAsync(Elastic.Clients.Elasticsearch.Id modelId, Action> configureRequest, CancellationToken cancellationToken = default) @@ -5346,7 +7778,9 @@ public virtual Task InferTrainedModelAsync } /// - /// Evaluates a trained model. + /// + /// Evaluates a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InferTrainedModelAsync(InferTrainedModelRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -5356,7 +7790,9 @@ public virtual Task InferTrainedModelAsync(InferTrain } /// - /// Evaluates a trained model. + /// + /// Evaluates a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InferTrainedModelAsync(Elastic.Clients.Elasticsearch.Id modelId, CancellationToken cancellationToken = default) @@ -5367,7 +7803,9 @@ public virtual Task InferTrainedModelAsync(Elastic.Cl } /// - /// Evaluates a trained model. + /// + /// Evaluates a trained model. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InferTrainedModelAsync(Elastic.Clients.Elasticsearch.Id modelId, Action configureRequest, CancellationToken cancellationToken = default) @@ -5379,7 +7817,15 @@ public virtual Task InferTrainedModelAsync(Elastic.Cl } /// - /// Returns defaults and limits used by machine learning.
This endpoint is designed to be used by a user interface that needs to fully
understand machine learning configurations where some options are not
specified, meaning that the defaults should be used. This endpoint may be
used to find out what those defaults are. It also provides information about
the maximum size of machine learning jobs that could run in the current
cluster configuration. + /// + /// Returns defaults and limits used by machine learning. + /// This endpoint is designed to be used by a user interface that needs to fully + /// understand machine learning configurations where some options are not + /// specified, meaning that the defaults should be used. This endpoint may be + /// used to find out what those defaults are. It also provides information about + /// the maximum size of machine learning jobs that could run in the current + /// cluster configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5390,7 +7836,15 @@ public virtual MlInfoResponse Info(MlInfoRequest request) } /// - /// Returns defaults and limits used by machine learning.
This endpoint is designed to be used by a user interface that needs to fully
understand machine learning configurations where some options are not
specified, meaning that the defaults should be used. This endpoint may be
used to find out what those defaults are. It also provides information about
the maximum size of machine learning jobs that could run in the current
cluster configuration. + /// + /// Returns defaults and limits used by machine learning. + /// This endpoint is designed to be used by a user interface that needs to fully + /// understand machine learning configurations where some options are not + /// specified, meaning that the defaults should be used. This endpoint may be + /// used to find out what those defaults are. It also provides information about + /// the maximum size of machine learning jobs that could run in the current + /// cluster configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(MlInfoRequest request, CancellationToken cancellationToken = default) @@ -5400,7 +7854,15 @@ public virtual Task InfoAsync(MlInfoRequest request, Cancellatio } /// - /// Returns defaults and limits used by machine learning.
This endpoint is designed to be used by a user interface that needs to fully
understand machine learning configurations where some options are not
specified, meaning that the defaults should be used. This endpoint may be
used to find out what those defaults are. It also provides information about
the maximum size of machine learning jobs that could run in the current
cluster configuration. + /// + /// Returns defaults and limits used by machine learning. + /// This endpoint is designed to be used by a user interface that needs to fully + /// understand machine learning configurations where some options are not + /// specified, meaning that the defaults should be used. This endpoint may be + /// used to find out what those defaults are. It also provides information about + /// the maximum size of machine learning jobs that could run in the current + /// cluster configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5411,7 +7873,15 @@ public virtual MlInfoResponse Info(MlInfoRequestDescriptor descriptor) } /// - /// Returns defaults and limits used by machine learning.
This endpoint is designed to be used by a user interface that needs to fully
understand machine learning configurations where some options are not
specified, meaning that the defaults should be used. This endpoint may be
used to find out what those defaults are. It also provides information about
the maximum size of machine learning jobs that could run in the current
cluster configuration. + /// + /// Returns defaults and limits used by machine learning. + /// This endpoint is designed to be used by a user interface that needs to fully + /// understand machine learning configurations where some options are not + /// specified, meaning that the defaults should be used. This endpoint may be + /// used to find out what those defaults are. It also provides information about + /// the maximum size of machine learning jobs that could run in the current + /// cluster configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5423,7 +7893,15 @@ public virtual MlInfoResponse Info() } /// - /// Returns defaults and limits used by machine learning.
This endpoint is designed to be used by a user interface that needs to fully
understand machine learning configurations where some options are not
specified, meaning that the defaults should be used. This endpoint may be
used to find out what those defaults are. It also provides information about
the maximum size of machine learning jobs that could run in the current
cluster configuration. + /// + /// Returns defaults and limits used by machine learning. + /// This endpoint is designed to be used by a user interface that needs to fully + /// understand machine learning configurations where some options are not + /// specified, meaning that the defaults should be used. This endpoint may be + /// used to find out what those defaults are. It also provides information about + /// the maximum size of machine learning jobs that could run in the current + /// cluster configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5436,7 +7914,15 @@ public virtual MlInfoResponse Info(Action configureRequ } /// - /// Returns defaults and limits used by machine learning.
This endpoint is designed to be used by a user interface that needs to fully
understand machine learning configurations where some options are not
specified, meaning that the defaults should be used. This endpoint may be
used to find out what those defaults are. It also provides information about
the maximum size of machine learning jobs that could run in the current
cluster configuration. + /// + /// Returns defaults and limits used by machine learning. + /// This endpoint is designed to be used by a user interface that needs to fully + /// understand machine learning configurations where some options are not + /// specified, meaning that the defaults should be used. This endpoint may be + /// used to find out what those defaults are. It also provides information about + /// the maximum size of machine learning jobs that could run in the current + /// cluster configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(MlInfoRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -5446,7 +7932,15 @@ public virtual Task InfoAsync(MlInfoRequestDescriptor descriptor } /// - /// Returns defaults and limits used by machine learning.
This endpoint is designed to be used by a user interface that needs to fully
understand machine learning configurations where some options are not
specified, meaning that the defaults should be used. This endpoint may be
used to find out what those defaults are. It also provides information about
the maximum size of machine learning jobs that could run in the current
cluster configuration. + /// + /// Returns defaults and limits used by machine learning. + /// This endpoint is designed to be used by a user interface that needs to fully + /// understand machine learning configurations where some options are not + /// specified, meaning that the defaults should be used. This endpoint may be + /// used to find out what those defaults are. It also provides information about + /// the maximum size of machine learning jobs that could run in the current + /// cluster configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(CancellationToken cancellationToken = default) @@ -5457,7 +7951,15 @@ public virtual Task InfoAsync(CancellationToken cancellationToke } /// - /// Returns defaults and limits used by machine learning.
This endpoint is designed to be used by a user interface that needs to fully
understand machine learning configurations where some options are not
specified, meaning that the defaults should be used. This endpoint may be
used to find out what those defaults are. It also provides information about
the maximum size of machine learning jobs that could run in the current
cluster configuration. + /// + /// Returns defaults and limits used by machine learning. + /// This endpoint is designed to be used by a user interface that needs to fully + /// understand machine learning configurations where some options are not + /// specified, meaning that the defaults should be used. This endpoint may be + /// used to find out what those defaults are. It also provides information about + /// the maximum size of machine learning jobs that could run in the current + /// cluster configuration. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -5469,7 +7971,16 @@ public virtual Task InfoAsync(Action co } /// - /// Open anomaly detection jobs.
An anomaly detection job must be opened in order for it to be ready to
receive and analyze data. It can be opened and closed multiple times
throughout its lifecycle.
When you open a new job, it starts with an empty model.
When you open an existing job, the most recent model state is automatically
loaded. The job is ready to resume its analysis from where it left off, once
new data is received. + /// + /// Open anomaly detection jobs. + /// An anomaly detection job must be opened in order for it to be ready to + /// receive and analyze data. It can be opened and closed multiple times + /// throughout its lifecycle. + /// When you open a new job, it starts with an empty model. + /// When you open an existing job, the most recent model state is automatically + /// loaded. The job is ready to resume its analysis from where it left off, once + /// new data is received. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5480,7 +7991,16 @@ public virtual OpenJobResponse OpenJob(OpenJobRequest request) } /// - /// Open anomaly detection jobs.
An anomaly detection job must be opened in order for it to be ready to
receive and analyze data. It can be opened and closed multiple times
throughout its lifecycle.
When you open a new job, it starts with an empty model.
When you open an existing job, the most recent model state is automatically
loaded. The job is ready to resume its analysis from where it left off, once
new data is received. + /// + /// Open anomaly detection jobs. + /// An anomaly detection job must be opened in order for it to be ready to + /// receive and analyze data. It can be opened and closed multiple times + /// throughout its lifecycle. + /// When you open a new job, it starts with an empty model. + /// When you open an existing job, the most recent model state is automatically + /// loaded. The job is ready to resume its analysis from where it left off, once + /// new data is received. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenJobAsync(OpenJobRequest request, CancellationToken cancellationToken = default) @@ -5490,7 +8010,16 @@ public virtual Task OpenJobAsync(OpenJobRequest request, Cancel } /// - /// Open anomaly detection jobs.
An anomaly detection job must be opened in order for it to be ready to
receive and analyze data. It can be opened and closed multiple times
throughout its lifecycle.
When you open a new job, it starts with an empty model.
When you open an existing job, the most recent model state is automatically
loaded. The job is ready to resume its analysis from where it left off, once
new data is received. + /// + /// Open anomaly detection jobs. + /// An anomaly detection job must be opened in order for it to be ready to + /// receive and analyze data. It can be opened and closed multiple times + /// throughout its lifecycle. + /// When you open a new job, it starts with an empty model. + /// When you open an existing job, the most recent model state is automatically + /// loaded. The job is ready to resume its analysis from where it left off, once + /// new data is received. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5501,7 +8030,16 @@ public virtual OpenJobResponse OpenJob(OpenJobRequestDescriptor descriptor) } /// - /// Open anomaly detection jobs.
An anomaly detection job must be opened in order for it to be ready to
receive and analyze data. It can be opened and closed multiple times
throughout its lifecycle.
When you open a new job, it starts with an empty model.
When you open an existing job, the most recent model state is automatically
loaded. The job is ready to resume its analysis from where it left off, once
new data is received. + /// + /// Open anomaly detection jobs. + /// An anomaly detection job must be opened in order for it to be ready to + /// receive and analyze data. It can be opened and closed multiple times + /// throughout its lifecycle. + /// When you open a new job, it starts with an empty model. + /// When you open an existing job, the most recent model state is automatically + /// loaded. The job is ready to resume its analysis from where it left off, once + /// new data is received. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5513,7 +8051,16 @@ public virtual OpenJobResponse OpenJob(Elastic.Clients.Elasticsearch.Id jobId) } /// - /// Open anomaly detection jobs.
An anomaly detection job must be opened in order for it to be ready to
receive and analyze data. It can be opened and closed multiple times
throughout its lifecycle.
When you open a new job, it starts with an empty model.
When you open an existing job, the most recent model state is automatically
loaded. The job is ready to resume its analysis from where it left off, once
new data is received. + /// + /// Open anomaly detection jobs. + /// An anomaly detection job must be opened in order for it to be ready to + /// receive and analyze data. It can be opened and closed multiple times + /// throughout its lifecycle. + /// When you open a new job, it starts with an empty model. + /// When you open an existing job, the most recent model state is automatically + /// loaded. The job is ready to resume its analysis from where it left off, once + /// new data is received. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5526,7 +8073,16 @@ public virtual OpenJobResponse OpenJob(Elastic.Clients.Elasticsearch.Id jobId, A } /// - /// Open anomaly detection jobs.
An anomaly detection job must be opened in order for it to be ready to
receive and analyze data. It can be opened and closed multiple times
throughout its lifecycle.
When you open a new job, it starts with an empty model.
When you open an existing job, the most recent model state is automatically
loaded. The job is ready to resume its analysis from where it left off, once
new data is received. + /// + /// Open anomaly detection jobs. + /// An anomaly detection job must be opened in order for it to be ready to + /// receive and analyze data. It can be opened and closed multiple times + /// throughout its lifecycle. + /// When you open a new job, it starts with an empty model. + /// When you open an existing job, the most recent model state is automatically + /// loaded. The job is ready to resume its analysis from where it left off, once + /// new data is received. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenJobAsync(OpenJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -5536,7 +8092,16 @@ public virtual Task OpenJobAsync(OpenJobRequestDescriptor descr } /// - /// Open anomaly detection jobs.
An anomaly detection job must be opened in order for it to be ready to
receive and analyze data. It can be opened and closed multiple times
throughout its lifecycle.
When you open a new job, it starts with an empty model.
When you open an existing job, the most recent model state is automatically
loaded. The job is ready to resume its analysis from where it left off, once
new data is received. + /// + /// Open anomaly detection jobs. + /// An anomaly detection job must be opened in order for it to be ready to + /// receive and analyze data. It can be opened and closed multiple times + /// throughout its lifecycle. + /// When you open a new job, it starts with an empty model. + /// When you open an existing job, the most recent model state is automatically + /// loaded. The job is ready to resume its analysis from where it left off, once + /// new data is received. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenJobAsync(Elastic.Clients.Elasticsearch.Id jobId, CancellationToken cancellationToken = default) @@ -5547,7 +8112,16 @@ public virtual Task OpenJobAsync(Elastic.Clients.Elasticsearch. } /// - /// Open anomaly detection jobs.
An anomaly detection job must be opened in order for it to be ready to
receive and analyze data. It can be opened and closed multiple times
throughout its lifecycle.
When you open a new job, it starts with an empty model.
When you open an existing job, the most recent model state is automatically
loaded. The job is ready to resume its analysis from where it left off, once
new data is received. + /// + /// Open anomaly detection jobs. + /// An anomaly detection job must be opened in order for it to be ready to + /// receive and analyze data. It can be opened and closed multiple times + /// throughout its lifecycle. + /// When you open a new job, it starts with an empty model. + /// When you open an existing job, the most recent model state is automatically + /// loaded. The job is ready to resume its analysis from where it left off, once + /// new data is received. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenJobAsync(Elastic.Clients.Elasticsearch.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -5559,7 +8133,9 @@ public virtual Task OpenJobAsync(Elastic.Clients.Elasticsearch. } /// - /// Adds scheduled events to a calendar. + /// + /// Adds scheduled events to a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5570,7 +8146,9 @@ public virtual PostCalendarEventsResponse PostCalendarEvents(PostCalendarEventsR } /// - /// Adds scheduled events to a calendar. + /// + /// Adds scheduled events to a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostCalendarEventsAsync(PostCalendarEventsRequest request, CancellationToken cancellationToken = default) @@ -5580,7 +8158,9 @@ public virtual Task PostCalendarEventsAsync(PostCale } /// - /// Adds scheduled events to a calendar. + /// + /// Adds scheduled events to a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5591,7 +8171,9 @@ public virtual PostCalendarEventsResponse PostCalendarEvents(PostCalendarEventsR } /// - /// Adds scheduled events to a calendar. + /// + /// Adds scheduled events to a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5603,7 +8185,9 @@ public virtual PostCalendarEventsResponse PostCalendarEvents(Elastic.Clients.Ela } /// - /// Adds scheduled events to a calendar. + /// + /// Adds scheduled events to a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5616,7 +8200,9 @@ public virtual PostCalendarEventsResponse PostCalendarEvents(Elastic.Clients.Ela } /// - /// Adds scheduled events to a calendar. + /// + /// Adds scheduled events to a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostCalendarEventsAsync(PostCalendarEventsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -5626,7 +8212,9 @@ public virtual Task PostCalendarEventsAsync(PostCale } /// - /// Adds scheduled events to a calendar. + /// + /// Adds scheduled events to a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostCalendarEventsAsync(Elastic.Clients.Elasticsearch.Id calendarId, CancellationToken cancellationToken = default) @@ -5637,7 +8225,9 @@ public virtual Task PostCalendarEventsAsync(Elastic. } /// - /// Adds scheduled events to a calendar. + /// + /// Adds scheduled events to a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostCalendarEventsAsync(Elastic.Clients.Elasticsearch.Id calendarId, Action configureRequest, CancellationToken cancellationToken = default) @@ -5649,7 +8239,9 @@ public virtual Task PostCalendarEventsAsync(Elastic. } /// - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5660,7 +8252,9 @@ public virtual PreviewDataFrameAnalyticsResponse PreviewDataFrameAnalytics(Previ } /// - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PreviewDataFrameAnalyticsAsync(PreviewDataFrameAnalyticsRequest request, CancellationToken cancellationToken = default) @@ -5670,7 +8264,9 @@ public virtual Task PreviewDataFrameAnalytics } /// - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5681,7 +8277,9 @@ public virtual PreviewDataFrameAnalyticsResponse PreviewDataFrameAnalytics - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5693,7 +8291,9 @@ public virtual PreviewDataFrameAnalyticsResponse PreviewDataFrameAnalytics - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5706,7 +8306,9 @@ public virtual PreviewDataFrameAnalyticsResponse PreviewDataFrameAnalytics - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5718,7 +8320,9 @@ public virtual PreviewDataFrameAnalyticsResponse PreviewDataFrameAnalytics - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5731,7 +8335,9 @@ public virtual PreviewDataFrameAnalyticsResponse PreviewDataFrameAnalytics - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5742,7 +8348,9 @@ public virtual PreviewDataFrameAnalyticsResponse PreviewDataFrameAnalytics(Previ } /// - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5754,7 +8362,9 @@ public virtual PreviewDataFrameAnalyticsResponse PreviewDataFrameAnalytics(Elast } /// - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5767,7 +8377,9 @@ public virtual PreviewDataFrameAnalyticsResponse PreviewDataFrameAnalytics(Elast } /// - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5779,7 +8391,9 @@ public virtual PreviewDataFrameAnalyticsResponse PreviewDataFrameAnalytics() } /// - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5792,7 +8406,9 @@ public virtual PreviewDataFrameAnalyticsResponse PreviewDataFrameAnalytics(Actio } /// - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PreviewDataFrameAnalyticsAsync(PreviewDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -5802,7 +8418,9 @@ public virtual Task PreviewDataFrameAnalytics } /// - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PreviewDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id? id, CancellationToken cancellationToken = default) @@ -5813,7 +8431,9 @@ public virtual Task PreviewDataFrameAnalytics } /// - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PreviewDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id? id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -5825,7 +8445,9 @@ public virtual Task PreviewDataFrameAnalytics } /// - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PreviewDataFrameAnalyticsAsync(CancellationToken cancellationToken = default) @@ -5836,7 +8458,9 @@ public virtual Task PreviewDataFrameAnalytics } /// - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PreviewDataFrameAnalyticsAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -5848,7 +8472,9 @@ public virtual Task PreviewDataFrameAnalytics } /// - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PreviewDataFrameAnalyticsAsync(PreviewDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -5858,7 +8484,9 @@ public virtual Task PreviewDataFrameAnalytics } /// - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PreviewDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id? id, CancellationToken cancellationToken = default) @@ -5869,7 +8497,9 @@ public virtual Task PreviewDataFrameAnalytics } /// - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PreviewDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id? id, Action configureRequest, CancellationToken cancellationToken = default) @@ -5881,7 +8511,9 @@ public virtual Task PreviewDataFrameAnalytics } /// - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PreviewDataFrameAnalyticsAsync(CancellationToken cancellationToken = default) @@ -5892,7 +8524,9 @@ public virtual Task PreviewDataFrameAnalytics } /// - /// Previews the extracted features used by a data frame analytics config. + /// + /// Previews the extracted features used by a data frame analytics config. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PreviewDataFrameAnalyticsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -5904,7 +8538,9 @@ public virtual Task PreviewDataFrameAnalytics } /// - /// Creates a calendar. + /// + /// Creates a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5915,7 +8551,9 @@ public virtual PutCalendarResponse PutCalendar(PutCalendarRequest request) } /// - /// Creates a calendar. + /// + /// Creates a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutCalendarAsync(PutCalendarRequest request, CancellationToken cancellationToken = default) @@ -5925,7 +8563,9 @@ public virtual Task PutCalendarAsync(PutCalendarRequest req } /// - /// Creates a calendar. + /// + /// Creates a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5936,7 +8576,9 @@ public virtual PutCalendarResponse PutCalendar(PutCalendarRequestDescriptor desc } /// - /// Creates a calendar. + /// + /// Creates a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5948,7 +8590,9 @@ public virtual PutCalendarResponse PutCalendar(Elastic.Clients.Elasticsearch.Id } /// - /// Creates a calendar. + /// + /// Creates a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5961,7 +8605,9 @@ public virtual PutCalendarResponse PutCalendar(Elastic.Clients.Elasticsearch.Id } /// - /// Creates a calendar. + /// + /// Creates a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutCalendarAsync(PutCalendarRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -5971,7 +8617,9 @@ public virtual Task PutCalendarAsync(PutCalendarRequestDesc } /// - /// Creates a calendar. + /// + /// Creates a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutCalendarAsync(Elastic.Clients.Elasticsearch.Id calendarId, CancellationToken cancellationToken = default) @@ -5982,7 +8630,9 @@ public virtual Task PutCalendarAsync(Elastic.Clients.Elasti } /// - /// Creates a calendar. + /// + /// Creates a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutCalendarAsync(Elastic.Clients.Elasticsearch.Id calendarId, Action configureRequest, CancellationToken cancellationToken = default) @@ -5994,7 +8644,9 @@ public virtual Task PutCalendarAsync(Elastic.Clients.Elasti } /// - /// Adds an anomaly detection job to a calendar. + /// + /// Adds an anomaly detection job to a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6005,7 +8657,9 @@ public virtual PutCalendarJobResponse PutCalendarJob(PutCalendarJobRequest reque } /// - /// Adds an anomaly detection job to a calendar. + /// + /// Adds an anomaly detection job to a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutCalendarJobAsync(PutCalendarJobRequest request, CancellationToken cancellationToken = default) @@ -6015,7 +8669,9 @@ public virtual Task PutCalendarJobAsync(PutCalendarJobRe } /// - /// Adds an anomaly detection job to a calendar. + /// + /// Adds an anomaly detection job to a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6026,7 +8682,9 @@ public virtual PutCalendarJobResponse PutCalendarJob(PutCalendarJobRequestDescri } /// - /// Adds an anomaly detection job to a calendar. + /// + /// Adds an anomaly detection job to a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6038,7 +8696,9 @@ public virtual PutCalendarJobResponse PutCalendarJob(Elastic.Clients.Elasticsear } /// - /// Adds an anomaly detection job to a calendar. + /// + /// Adds an anomaly detection job to a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6051,7 +8711,9 @@ public virtual PutCalendarJobResponse PutCalendarJob(Elastic.Clients.Elasticsear } /// - /// Adds an anomaly detection job to a calendar. + /// + /// Adds an anomaly detection job to a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutCalendarJobAsync(PutCalendarJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6061,7 +8723,9 @@ public virtual Task PutCalendarJobAsync(PutCalendarJobRe } /// - /// Adds an anomaly detection job to a calendar. + /// + /// Adds an anomaly detection job to a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutCalendarJobAsync(Elastic.Clients.Elasticsearch.Id calendarId, Elastic.Clients.Elasticsearch.Ids jobId, CancellationToken cancellationToken = default) @@ -6072,7 +8736,9 @@ public virtual Task PutCalendarJobAsync(Elastic.Clients. } /// - /// Adds an anomaly detection job to a calendar. + /// + /// Adds an anomaly detection job to a calendar. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutCalendarJobAsync(Elastic.Clients.Elasticsearch.Id calendarId, Elastic.Clients.Elasticsearch.Ids jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -6084,7 +8750,13 @@ public virtual Task PutCalendarJobAsync(Elastic.Clients. } /// - /// Instantiates a datafeed.
Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.
You can associate only one datafeed with each anomaly detection job.
The datafeed contains a query that runs at a defined interval (`frequency`).
If you are concerned about delayed data, you can add a delay (`query_delay') at each interval.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had
at the time of creation and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead.
You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. + /// + /// Instantiates a datafeed. + /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. + /// You can associate only one datafeed with each anomaly detection job. + /// The datafeed contains a query that runs at a defined interval (frequency). + /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6095,7 +8767,13 @@ public virtual PutDatafeedResponse PutDatafeed(PutDatafeedRequest request) } /// - /// Instantiates a datafeed.
Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.
You can associate only one datafeed with each anomaly detection job.
The datafeed contains a query that runs at a defined interval (`frequency`).
If you are concerned about delayed data, you can add a delay (`query_delay') at each interval.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had
at the time of creation and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead.
You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. + /// + /// Instantiates a datafeed. + /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. + /// You can associate only one datafeed with each anomaly detection job. + /// The datafeed contains a query that runs at a defined interval (frequency). + /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDatafeedAsync(PutDatafeedRequest request, CancellationToken cancellationToken = default) @@ -6105,7 +8783,13 @@ public virtual Task PutDatafeedAsync(PutDatafeedRequest req } /// - /// Instantiates a datafeed.
Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.
You can associate only one datafeed with each anomaly detection job.
The datafeed contains a query that runs at a defined interval (`frequency`).
If you are concerned about delayed data, you can add a delay (`query_delay') at each interval.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had
at the time of creation and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead.
You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. + /// + /// Instantiates a datafeed. + /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. + /// You can associate only one datafeed with each anomaly detection job. + /// The datafeed contains a query that runs at a defined interval (frequency). + /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6116,7 +8800,13 @@ public virtual PutDatafeedResponse PutDatafeed(PutDatafeedRequestDesc } /// - /// Instantiates a datafeed.
Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.
You can associate only one datafeed with each anomaly detection job.
The datafeed contains a query that runs at a defined interval (`frequency`).
If you are concerned about delayed data, you can add a delay (`query_delay') at each interval.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had
at the time of creation and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead.
You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. + /// + /// Instantiates a datafeed. + /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. + /// You can associate only one datafeed with each anomaly detection job. + /// The datafeed contains a query that runs at a defined interval (frequency). + /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6128,7 +8818,13 @@ public virtual PutDatafeedResponse PutDatafeed(Elastic.Clients.Elasti } /// - /// Instantiates a datafeed.
Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.
You can associate only one datafeed with each anomaly detection job.
The datafeed contains a query that runs at a defined interval (`frequency`).
If you are concerned about delayed data, you can add a delay (`query_delay') at each interval.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had
at the time of creation and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead.
You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. + /// + /// Instantiates a datafeed. + /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. + /// You can associate only one datafeed with each anomaly detection job. + /// The datafeed contains a query that runs at a defined interval (frequency). + /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6141,7 +8837,13 @@ public virtual PutDatafeedResponse PutDatafeed(Elastic.Clients.Elasti } /// - /// Instantiates a datafeed.
Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.
You can associate only one datafeed with each anomaly detection job.
The datafeed contains a query that runs at a defined interval (`frequency`).
If you are concerned about delayed data, you can add a delay (`query_delay') at each interval.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had
at the time of creation and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead.
You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. + /// + /// Instantiates a datafeed. + /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. + /// You can associate only one datafeed with each anomaly detection job. + /// The datafeed contains a query that runs at a defined interval (frequency). + /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6152,7 +8854,13 @@ public virtual PutDatafeedResponse PutDatafeed(PutDatafeedRequestDescriptor desc } /// - /// Instantiates a datafeed.
Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.
You can associate only one datafeed with each anomaly detection job.
The datafeed contains a query that runs at a defined interval (`frequency`).
If you are concerned about delayed data, you can add a delay (`query_delay') at each interval.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had
at the time of creation and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead.
You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. + /// + /// Instantiates a datafeed. + /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. + /// You can associate only one datafeed with each anomaly detection job. + /// The datafeed contains a query that runs at a defined interval (frequency). + /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6164,7 +8872,13 @@ public virtual PutDatafeedResponse PutDatafeed(Elastic.Clients.Elasticsearch.Id } /// - /// Instantiates a datafeed.
Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.
You can associate only one datafeed with each anomaly detection job.
The datafeed contains a query that runs at a defined interval (`frequency`).
If you are concerned about delayed data, you can add a delay (`query_delay') at each interval.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had
at the time of creation and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead.
You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. + /// + /// Instantiates a datafeed. + /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. + /// You can associate only one datafeed with each anomaly detection job. + /// The datafeed contains a query that runs at a defined interval (frequency). + /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6177,7 +8891,13 @@ public virtual PutDatafeedResponse PutDatafeed(Elastic.Clients.Elasticsearch.Id } /// - /// Instantiates a datafeed.
Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.
You can associate only one datafeed with each anomaly detection job.
The datafeed contains a query that runs at a defined interval (`frequency`).
If you are concerned about delayed data, you can add a delay (`query_delay') at each interval.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had
at the time of creation and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead.
You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. + /// + /// Instantiates a datafeed. + /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. + /// You can associate only one datafeed with each anomaly detection job. + /// The datafeed contains a query that runs at a defined interval (frequency). + /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDatafeedAsync(PutDatafeedRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6187,7 +8907,13 @@ public virtual Task PutDatafeedAsync(PutDatafeed } /// - /// Instantiates a datafeed.
Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.
You can associate only one datafeed with each anomaly detection job.
The datafeed contains a query that runs at a defined interval (`frequency`).
If you are concerned about delayed data, you can add a delay (`query_delay') at each interval.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had
at the time of creation and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead.
You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. + /// + /// Instantiates a datafeed. + /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. + /// You can associate only one datafeed with each anomaly detection job. + /// The datafeed contains a query that runs at a defined interval (frequency). + /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDatafeedAsync(Elastic.Clients.Elasticsearch.Id datafeedId, CancellationToken cancellationToken = default) @@ -6198,7 +8924,13 @@ public virtual Task PutDatafeedAsync(Elastic.Cli } /// - /// Instantiates a datafeed.
Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.
You can associate only one datafeed with each anomaly detection job.
The datafeed contains a query that runs at a defined interval (`frequency`).
If you are concerned about delayed data, you can add a delay (`query_delay') at each interval.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had
at the time of creation and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead.
You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. + /// + /// Instantiates a datafeed. + /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. + /// You can associate only one datafeed with each anomaly detection job. + /// The datafeed contains a query that runs at a defined interval (frequency). + /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDatafeedAsync(Elastic.Clients.Elasticsearch.Id datafeedId, Action> configureRequest, CancellationToken cancellationToken = default) @@ -6210,7 +8942,13 @@ public virtual Task PutDatafeedAsync(Elastic.Cli } /// - /// Instantiates a datafeed.
Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.
You can associate only one datafeed with each anomaly detection job.
The datafeed contains a query that runs at a defined interval (`frequency`).
If you are concerned about delayed data, you can add a delay (`query_delay') at each interval.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had
at the time of creation and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead.
You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. + /// + /// Instantiates a datafeed. + /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. + /// You can associate only one datafeed with each anomaly detection job. + /// The datafeed contains a query that runs at a defined interval (frequency). + /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDatafeedAsync(PutDatafeedRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6220,7 +8958,13 @@ public virtual Task PutDatafeedAsync(PutDatafeedRequestDesc } /// - /// Instantiates a datafeed.
Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.
You can associate only one datafeed with each anomaly detection job.
The datafeed contains a query that runs at a defined interval (`frequency`).
If you are concerned about delayed data, you can add a delay (`query_delay') at each interval.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had
at the time of creation and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead.
You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. + /// + /// Instantiates a datafeed. + /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. + /// You can associate only one datafeed with each anomaly detection job. + /// The datafeed contains a query that runs at a defined interval (frequency). + /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDatafeedAsync(Elastic.Clients.Elasticsearch.Id datafeedId, CancellationToken cancellationToken = default) @@ -6231,7 +8975,13 @@ public virtual Task PutDatafeedAsync(Elastic.Clients.Elasti } /// - /// Instantiates a datafeed.
Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.
You can associate only one datafeed with each anomaly detection job.
The datafeed contains a query that runs at a defined interval (`frequency`).
If you are concerned about delayed data, you can add a delay (`query_delay') at each interval.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had
at the time of creation and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead.
You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. + /// + /// Instantiates a datafeed. + /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. + /// You can associate only one datafeed with each anomaly detection job. + /// The datafeed contains a query that runs at a defined interval (frequency). + /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDatafeedAsync(Elastic.Clients.Elasticsearch.Id datafeedId, Action configureRequest, CancellationToken cancellationToken = default) @@ -6243,7 +8993,11 @@ public virtual Task PutDatafeedAsync(Elastic.Clients.Elasti } /// - /// Instantiates a data frame analytics job.
This API creates a data frame analytics job that performs an analysis on the
source indices and stores the outcome in a destination index. + /// + /// Instantiates a data frame analytics job. + /// This API creates a data frame analytics job that performs an analysis on the + /// source indices and stores the outcome in a destination index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6254,7 +9008,11 @@ public virtual PutDataFrameAnalyticsResponse PutDataFrameAnalytics(PutDataFrameA } /// - /// Instantiates a data frame analytics job.
This API creates a data frame analytics job that performs an analysis on the
source indices and stores the outcome in a destination index. + /// + /// Instantiates a data frame analytics job. + /// This API creates a data frame analytics job that performs an analysis on the + /// source indices and stores the outcome in a destination index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataFrameAnalyticsAsync(PutDataFrameAnalyticsRequest request, CancellationToken cancellationToken = default) @@ -6264,7 +9022,11 @@ public virtual Task PutDataFrameAnalyticsAsync(Pu } /// - /// Instantiates a data frame analytics job.
This API creates a data frame analytics job that performs an analysis on the
source indices and stores the outcome in a destination index. + /// + /// Instantiates a data frame analytics job. + /// This API creates a data frame analytics job that performs an analysis on the + /// source indices and stores the outcome in a destination index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6275,7 +9037,11 @@ public virtual PutDataFrameAnalyticsResponse PutDataFrameAnalytics(Pu } /// - /// Instantiates a data frame analytics job.
This API creates a data frame analytics job that performs an analysis on the
source indices and stores the outcome in a destination index. + /// + /// Instantiates a data frame analytics job. + /// This API creates a data frame analytics job that performs an analysis on the + /// source indices and stores the outcome in a destination index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6287,7 +9053,11 @@ public virtual PutDataFrameAnalyticsResponse PutDataFrameAnalytics(El } /// - /// Instantiates a data frame analytics job.
This API creates a data frame analytics job that performs an analysis on the
source indices and stores the outcome in a destination index. + /// + /// Instantiates a data frame analytics job. + /// This API creates a data frame analytics job that performs an analysis on the + /// source indices and stores the outcome in a destination index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6300,7 +9070,11 @@ public virtual PutDataFrameAnalyticsResponse PutDataFrameAnalytics(El } /// - /// Instantiates a data frame analytics job.
This API creates a data frame analytics job that performs an analysis on the
source indices and stores the outcome in a destination index. + /// + /// Instantiates a data frame analytics job. + /// This API creates a data frame analytics job that performs an analysis on the + /// source indices and stores the outcome in a destination index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6311,7 +9085,11 @@ public virtual PutDataFrameAnalyticsResponse PutDataFrameAnalytics(PutDataFrameA } /// - /// Instantiates a data frame analytics job.
This API creates a data frame analytics job that performs an analysis on the
source indices and stores the outcome in a destination index. + /// + /// Instantiates a data frame analytics job. + /// This API creates a data frame analytics job that performs an analysis on the + /// source indices and stores the outcome in a destination index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6323,7 +9101,11 @@ public virtual PutDataFrameAnalyticsResponse PutDataFrameAnalytics(Elastic.Clien } /// - /// Instantiates a data frame analytics job.
This API creates a data frame analytics job that performs an analysis on the
source indices and stores the outcome in a destination index. + /// + /// Instantiates a data frame analytics job. + /// This API creates a data frame analytics job that performs an analysis on the + /// source indices and stores the outcome in a destination index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6336,7 +9118,11 @@ public virtual PutDataFrameAnalyticsResponse PutDataFrameAnalytics(Elastic.Clien } /// - /// Instantiates a data frame analytics job.
This API creates a data frame analytics job that performs an analysis on the
source indices and stores the outcome in a destination index. + /// + /// Instantiates a data frame analytics job. + /// This API creates a data frame analytics job that performs an analysis on the + /// source indices and stores the outcome in a destination index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataFrameAnalyticsAsync(PutDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6346,7 +9132,11 @@ public virtual Task PutDataFrameAnalyticsAsync - /// Instantiates a data frame analytics job.
This API creates a data frame analytics job that performs an analysis on the
source indices and stores the outcome in a destination index. + /// + /// Instantiates a data frame analytics job. + /// This API creates a data frame analytics job that performs an analysis on the + /// source indices and stores the outcome in a destination index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -6357,7 +9147,11 @@ public virtual Task PutDataFrameAnalyticsAsync - /// Instantiates a data frame analytics job.
This API creates a data frame analytics job that performs an analysis on the
source indices and stores the outcome in a destination index. + /// + /// Instantiates a data frame analytics job. + /// This API creates a data frame analytics job that performs an analysis on the + /// source indices and stores the outcome in a destination index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -6369,7 +9163,11 @@ public virtual Task PutDataFrameAnalyticsAsync - /// Instantiates a data frame analytics job.
This API creates a data frame analytics job that performs an analysis on the
source indices and stores the outcome in a destination index. + /// + /// Instantiates a data frame analytics job. + /// This API creates a data frame analytics job that performs an analysis on the + /// source indices and stores the outcome in a destination index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataFrameAnalyticsAsync(PutDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6379,7 +9177,11 @@ public virtual Task PutDataFrameAnalyticsAsync(Pu } /// - /// Instantiates a data frame analytics job.
This API creates a data frame analytics job that performs an analysis on the
source indices and stores the outcome in a destination index. + /// + /// Instantiates a data frame analytics job. + /// This API creates a data frame analytics job that performs an analysis on the + /// source indices and stores the outcome in a destination index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -6390,7 +9192,11 @@ public virtual Task PutDataFrameAnalyticsAsync(El } /// - /// Instantiates a data frame analytics job.
This API creates a data frame analytics job that performs an analysis on the
source indices and stores the outcome in a destination index. + /// + /// Instantiates a data frame analytics job. + /// This API creates a data frame analytics job that performs an analysis on the + /// source indices and stores the outcome in a destination index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -6402,7 +9208,11 @@ public virtual Task PutDataFrameAnalyticsAsync(El } /// - /// Instantiates a filter.
A filter contains a list of strings. It can be used by one or more anomaly detection jobs.
Specifically, filters are referenced in the `custom_rules` property of detector configuration objects. + /// + /// Instantiates a filter. + /// A filter contains a list of strings. It can be used by one or more anomaly detection jobs. + /// Specifically, filters are referenced in the custom_rules property of detector configuration objects. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6413,7 +9223,11 @@ public virtual PutFilterResponse PutFilter(PutFilterRequest request) } /// - /// Instantiates a filter.
A filter contains a list of strings. It can be used by one or more anomaly detection jobs.
Specifically, filters are referenced in the `custom_rules` property of detector configuration objects. + /// + /// Instantiates a filter. + /// A filter contains a list of strings. It can be used by one or more anomaly detection jobs. + /// Specifically, filters are referenced in the custom_rules property of detector configuration objects. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutFilterAsync(PutFilterRequest request, CancellationToken cancellationToken = default) @@ -6423,7 +9237,11 @@ public virtual Task PutFilterAsync(PutFilterRequest request, } /// - /// Instantiates a filter.
A filter contains a list of strings. It can be used by one or more anomaly detection jobs.
Specifically, filters are referenced in the `custom_rules` property of detector configuration objects. + /// + /// Instantiates a filter. + /// A filter contains a list of strings. It can be used by one or more anomaly detection jobs. + /// Specifically, filters are referenced in the custom_rules property of detector configuration objects. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6434,7 +9252,11 @@ public virtual PutFilterResponse PutFilter(PutFilterRequestDescriptor descriptor } /// - /// Instantiates a filter.
A filter contains a list of strings. It can be used by one or more anomaly detection jobs.
Specifically, filters are referenced in the `custom_rules` property of detector configuration objects. + /// + /// Instantiates a filter. + /// A filter contains a list of strings. It can be used by one or more anomaly detection jobs. + /// Specifically, filters are referenced in the custom_rules property of detector configuration objects. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6446,7 +9268,11 @@ public virtual PutFilterResponse PutFilter(Elastic.Clients.Elasticsearch.Id filt } /// - /// Instantiates a filter.
A filter contains a list of strings. It can be used by one or more anomaly detection jobs.
Specifically, filters are referenced in the `custom_rules` property of detector configuration objects. + /// + /// Instantiates a filter. + /// A filter contains a list of strings. It can be used by one or more anomaly detection jobs. + /// Specifically, filters are referenced in the custom_rules property of detector configuration objects. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6459,7 +9285,11 @@ public virtual PutFilterResponse PutFilter(Elastic.Clients.Elasticsearch.Id filt } /// - /// Instantiates a filter.
A filter contains a list of strings. It can be used by one or more anomaly detection jobs.
Specifically, filters are referenced in the `custom_rules` property of detector configuration objects. + /// + /// Instantiates a filter. + /// A filter contains a list of strings. It can be used by one or more anomaly detection jobs. + /// Specifically, filters are referenced in the custom_rules property of detector configuration objects. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutFilterAsync(PutFilterRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6469,7 +9299,11 @@ public virtual Task PutFilterAsync(PutFilterRequestDescriptor } /// - /// Instantiates a filter.
A filter contains a list of strings. It can be used by one or more anomaly detection jobs.
Specifically, filters are referenced in the `custom_rules` property of detector configuration objects. + /// + /// Instantiates a filter. + /// A filter contains a list of strings. It can be used by one or more anomaly detection jobs. + /// Specifically, filters are referenced in the custom_rules property of detector configuration objects. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutFilterAsync(Elastic.Clients.Elasticsearch.Id filterId, CancellationToken cancellationToken = default) @@ -6480,7 +9314,11 @@ public virtual Task PutFilterAsync(Elastic.Clients.Elasticsea } /// - /// Instantiates a filter.
A filter contains a list of strings. It can be used by one or more anomaly detection jobs.
Specifically, filters are referenced in the `custom_rules` property of detector configuration objects. + /// + /// Instantiates a filter. + /// A filter contains a list of strings. It can be used by one or more anomaly detection jobs. + /// Specifically, filters are referenced in the custom_rules property of detector configuration objects. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutFilterAsync(Elastic.Clients.Elasticsearch.Id filterId, Action configureRequest, CancellationToken cancellationToken = default) @@ -6492,7 +9330,10 @@ public virtual Task PutFilterAsync(Elastic.Clients.Elasticsea } /// - /// Create an anomaly detection job.
If you include a `datafeed_config`, you must have read index privileges on the source index. + /// + /// Create an anomaly detection job. + /// If you include a datafeed_config, you must have read index privileges on the source index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6503,7 +9344,10 @@ public virtual PutJobResponse PutJob(PutJobRequest request) } /// - /// Create an anomaly detection job.
If you include a `datafeed_config`, you must have read index privileges on the source index. + /// + /// Create an anomaly detection job. + /// If you include a datafeed_config, you must have read index privileges on the source index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutJobAsync(PutJobRequest request, CancellationToken cancellationToken = default) @@ -6513,7 +9357,10 @@ public virtual Task PutJobAsync(PutJobRequest request, Cancellat } /// - /// Create an anomaly detection job.
If you include a `datafeed_config`, you must have read index privileges on the source index. + /// + /// Create an anomaly detection job. + /// If you include a datafeed_config, you must have read index privileges on the source index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6524,7 +9371,10 @@ public virtual PutJobResponse PutJob(PutJobRequestDescriptor - /// Create an anomaly detection job.
If you include a `datafeed_config`, you must have read index privileges on the source index. + /// + /// Create an anomaly detection job. + /// If you include a datafeed_config, you must have read index privileges on the source index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6536,7 +9386,10 @@ public virtual PutJobResponse PutJob(Elastic.Clients.Elasticsearch.Id } /// - /// Create an anomaly detection job.
If you include a `datafeed_config`, you must have read index privileges on the source index. + /// + /// Create an anomaly detection job. + /// If you include a datafeed_config, you must have read index privileges on the source index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6549,7 +9402,10 @@ public virtual PutJobResponse PutJob(Elastic.Clients.Elasticsearch.Id } /// - /// Create an anomaly detection job.
If you include a `datafeed_config`, you must have read index privileges on the source index. + /// + /// Create an anomaly detection job. + /// If you include a datafeed_config, you must have read index privileges on the source index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6560,7 +9416,10 @@ public virtual PutJobResponse PutJob(PutJobRequestDescriptor descriptor) } /// - /// Create an anomaly detection job.
If you include a `datafeed_config`, you must have read index privileges on the source index. + /// + /// Create an anomaly detection job. + /// If you include a datafeed_config, you must have read index privileges on the source index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6572,7 +9431,10 @@ public virtual PutJobResponse PutJob(Elastic.Clients.Elasticsearch.Id jobId) } /// - /// Create an anomaly detection job.
If you include a `datafeed_config`, you must have read index privileges on the source index. + /// + /// Create an anomaly detection job. + /// If you include a datafeed_config, you must have read index privileges on the source index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6585,7 +9447,10 @@ public virtual PutJobResponse PutJob(Elastic.Clients.Elasticsearch.Id jobId, Act } /// - /// Create an anomaly detection job.
If you include a `datafeed_config`, you must have read index privileges on the source index. + /// + /// Create an anomaly detection job. + /// If you include a datafeed_config, you must have read index privileges on the source index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutJobAsync(PutJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6595,7 +9460,10 @@ public virtual Task PutJobAsync(PutJobRequestDescript } /// - /// Create an anomaly detection job.
If you include a `datafeed_config`, you must have read index privileges on the source index. + /// + /// Create an anomaly detection job. + /// If you include a datafeed_config, you must have read index privileges on the source index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutJobAsync(Elastic.Clients.Elasticsearch.Id jobId, CancellationToken cancellationToken = default) @@ -6606,7 +9474,10 @@ public virtual Task PutJobAsync(Elastic.Clients.Elast } /// - /// Create an anomaly detection job.
If you include a `datafeed_config`, you must have read index privileges on the source index. + /// + /// Create an anomaly detection job. + /// If you include a datafeed_config, you must have read index privileges on the source index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutJobAsync(Elastic.Clients.Elasticsearch.Id jobId, Action> configureRequest, CancellationToken cancellationToken = default) @@ -6618,7 +9489,10 @@ public virtual Task PutJobAsync(Elastic.Clients.Elast } /// - /// Create an anomaly detection job.
If you include a `datafeed_config`, you must have read index privileges on the source index. + /// + /// Create an anomaly detection job. + /// If you include a datafeed_config, you must have read index privileges on the source index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutJobAsync(PutJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6628,7 +9502,10 @@ public virtual Task PutJobAsync(PutJobRequestDescriptor descript } /// - /// Create an anomaly detection job.
If you include a `datafeed_config`, you must have read index privileges on the source index. + /// + /// Create an anomaly detection job. + /// If you include a datafeed_config, you must have read index privileges on the source index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutJobAsync(Elastic.Clients.Elasticsearch.Id jobId, CancellationToken cancellationToken = default) @@ -6639,7 +9516,10 @@ public virtual Task PutJobAsync(Elastic.Clients.Elasticsearch.Id } /// - /// Create an anomaly detection job.
If you include a `datafeed_config`, you must have read index privileges on the source index. + /// + /// Create an anomaly detection job. + /// If you include a datafeed_config, you must have read index privileges on the source index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutJobAsync(Elastic.Clients.Elasticsearch.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -6651,7 +9531,9 @@ public virtual Task PutJobAsync(Elastic.Clients.Elasticsearch.Id } /// - /// Enables you to supply a trained model that is not created by data frame analytics. + /// + /// Enables you to supply a trained model that is not created by data frame analytics. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6662,7 +9544,9 @@ public virtual PutTrainedModelResponse PutTrainedModel(PutTrainedModelRequest re } /// - /// Enables you to supply a trained model that is not created by data frame analytics. + /// + /// Enables you to supply a trained model that is not created by data frame analytics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelAsync(PutTrainedModelRequest request, CancellationToken cancellationToken = default) @@ -6672,7 +9556,9 @@ public virtual Task PutTrainedModelAsync(PutTrainedMode } /// - /// Enables you to supply a trained model that is not created by data frame analytics. + /// + /// Enables you to supply a trained model that is not created by data frame analytics. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6683,7 +9569,9 @@ public virtual PutTrainedModelResponse PutTrainedModel(PutTrainedMode } /// - /// Enables you to supply a trained model that is not created by data frame analytics. + /// + /// Enables you to supply a trained model that is not created by data frame analytics. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6695,7 +9583,9 @@ public virtual PutTrainedModelResponse PutTrainedModel(Elastic.Client } /// - /// Enables you to supply a trained model that is not created by data frame analytics. + /// + /// Enables you to supply a trained model that is not created by data frame analytics. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6708,7 +9598,9 @@ public virtual PutTrainedModelResponse PutTrainedModel(Elastic.Client } /// - /// Enables you to supply a trained model that is not created by data frame analytics. + /// + /// Enables you to supply a trained model that is not created by data frame analytics. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6719,7 +9611,9 @@ public virtual PutTrainedModelResponse PutTrainedModel(PutTrainedModelRequestDes } /// - /// Enables you to supply a trained model that is not created by data frame analytics. + /// + /// Enables you to supply a trained model that is not created by data frame analytics. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6731,7 +9625,9 @@ public virtual PutTrainedModelResponse PutTrainedModel(Elastic.Clients.Elasticse } /// - /// Enables you to supply a trained model that is not created by data frame analytics. + /// + /// Enables you to supply a trained model that is not created by data frame analytics. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6744,7 +9640,9 @@ public virtual PutTrainedModelResponse PutTrainedModel(Elastic.Clients.Elasticse } /// - /// Enables you to supply a trained model that is not created by data frame analytics. + /// + /// Enables you to supply a trained model that is not created by data frame analytics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelAsync(PutTrainedModelRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6754,7 +9652,9 @@ public virtual Task PutTrainedModelAsync(Put } /// - /// Enables you to supply a trained model that is not created by data frame analytics. + /// + /// Enables you to supply a trained model that is not created by data frame analytics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelAsync(Elastic.Clients.Elasticsearch.Id modelId, CancellationToken cancellationToken = default) @@ -6765,7 +9665,9 @@ public virtual Task PutTrainedModelAsync(Ela } /// - /// Enables you to supply a trained model that is not created by data frame analytics. + /// + /// Enables you to supply a trained model that is not created by data frame analytics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelAsync(Elastic.Clients.Elasticsearch.Id modelId, Action> configureRequest, CancellationToken cancellationToken = default) @@ -6777,7 +9679,9 @@ public virtual Task PutTrainedModelAsync(Ela } /// - /// Enables you to supply a trained model that is not created by data frame analytics. + /// + /// Enables you to supply a trained model that is not created by data frame analytics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelAsync(PutTrainedModelRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6787,7 +9691,9 @@ public virtual Task PutTrainedModelAsync(PutTrainedMode } /// - /// Enables you to supply a trained model that is not created by data frame analytics. + /// + /// Enables you to supply a trained model that is not created by data frame analytics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelAsync(Elastic.Clients.Elasticsearch.Id modelId, CancellationToken cancellationToken = default) @@ -6798,7 +9704,9 @@ public virtual Task PutTrainedModelAsync(Elastic.Client } /// - /// Enables you to supply a trained model that is not created by data frame analytics. + /// + /// Enables you to supply a trained model that is not created by data frame analytics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelAsync(Elastic.Clients.Elasticsearch.Id modelId, Action configureRequest, CancellationToken cancellationToken = default) @@ -6810,7 +9718,24 @@ public virtual Task PutTrainedModelAsync(Elastic.Client } /// - /// Creates or updates a trained model alias. A trained model alias is a logical
name used to reference a single trained model.
You can use aliases instead of trained model identifiers to make it easier to
reference your models. For example, you can use aliases in inference
aggregations and processors.
An alias must be unique and refer to only a single trained model. However,
you can have multiple aliases for each trained model.
If you use this API to update an alias such that it references a different
trained model ID and the model uses a different type of data frame analytics,
an error occurs. For example, this situation occurs if you have a trained
model for regression analysis and a trained model for classification
analysis; you cannot reassign an alias from one type of trained model to
another.
If you use this API to update an alias and there are very few input fields in
common between the old and new trained models for the model alias, the API
returns a warning. + /// + /// Creates or updates a trained model alias. A trained model alias is a logical + /// name used to reference a single trained model. + /// You can use aliases instead of trained model identifiers to make it easier to + /// reference your models. For example, you can use aliases in inference + /// aggregations and processors. + /// An alias must be unique and refer to only a single trained model. However, + /// you can have multiple aliases for each trained model. + /// If you use this API to update an alias such that it references a different + /// trained model ID and the model uses a different type of data frame analytics, + /// an error occurs. For example, this situation occurs if you have a trained + /// model for regression analysis and a trained model for classification + /// analysis; you cannot reassign an alias from one type of trained model to + /// another. + /// If you use this API to update an alias and there are very few input fields in + /// common between the old and new trained models for the model alias, the API + /// returns a warning. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6821,7 +9746,24 @@ public virtual PutTrainedModelAliasResponse PutTrainedModelAlias(PutTrainedModel } /// - /// Creates or updates a trained model alias. A trained model alias is a logical
name used to reference a single trained model.
You can use aliases instead of trained model identifiers to make it easier to
reference your models. For example, you can use aliases in inference
aggregations and processors.
An alias must be unique and refer to only a single trained model. However,
you can have multiple aliases for each trained model.
If you use this API to update an alias such that it references a different
trained model ID and the model uses a different type of data frame analytics,
an error occurs. For example, this situation occurs if you have a trained
model for regression analysis and a trained model for classification
analysis; you cannot reassign an alias from one type of trained model to
another.
If you use this API to update an alias and there are very few input fields in
common between the old and new trained models for the model alias, the API
returns a warning. + /// + /// Creates or updates a trained model alias. A trained model alias is a logical + /// name used to reference a single trained model. + /// You can use aliases instead of trained model identifiers to make it easier to + /// reference your models. For example, you can use aliases in inference + /// aggregations and processors. + /// An alias must be unique and refer to only a single trained model. However, + /// you can have multiple aliases for each trained model. + /// If you use this API to update an alias such that it references a different + /// trained model ID and the model uses a different type of data frame analytics, + /// an error occurs. For example, this situation occurs if you have a trained + /// model for regression analysis and a trained model for classification + /// analysis; you cannot reassign an alias from one type of trained model to + /// another. + /// If you use this API to update an alias and there are very few input fields in + /// common between the old and new trained models for the model alias, the API + /// returns a warning. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelAliasAsync(PutTrainedModelAliasRequest request, CancellationToken cancellationToken = default) @@ -6831,7 +9773,24 @@ public virtual Task PutTrainedModelAliasAsync(PutT } /// - /// Creates or updates a trained model alias. A trained model alias is a logical
name used to reference a single trained model.
You can use aliases instead of trained model identifiers to make it easier to
reference your models. For example, you can use aliases in inference
aggregations and processors.
An alias must be unique and refer to only a single trained model. However,
you can have multiple aliases for each trained model.
If you use this API to update an alias such that it references a different
trained model ID and the model uses a different type of data frame analytics,
an error occurs. For example, this situation occurs if you have a trained
model for regression analysis and a trained model for classification
analysis; you cannot reassign an alias from one type of trained model to
another.
If you use this API to update an alias and there are very few input fields in
common between the old and new trained models for the model alias, the API
returns a warning. + /// + /// Creates or updates a trained model alias. A trained model alias is a logical + /// name used to reference a single trained model. + /// You can use aliases instead of trained model identifiers to make it easier to + /// reference your models. For example, you can use aliases in inference + /// aggregations and processors. + /// An alias must be unique and refer to only a single trained model. However, + /// you can have multiple aliases for each trained model. + /// If you use this API to update an alias such that it references a different + /// trained model ID and the model uses a different type of data frame analytics, + /// an error occurs. For example, this situation occurs if you have a trained + /// model for regression analysis and a trained model for classification + /// analysis; you cannot reassign an alias from one type of trained model to + /// another. + /// If you use this API to update an alias and there are very few input fields in + /// common between the old and new trained models for the model alias, the API + /// returns a warning. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6842,7 +9801,24 @@ public virtual PutTrainedModelAliasResponse PutTrainedModelAlias(PutTrainedModel } /// - /// Creates or updates a trained model alias. A trained model alias is a logical
name used to reference a single trained model.
You can use aliases instead of trained model identifiers to make it easier to
reference your models. For example, you can use aliases in inference
aggregations and processors.
An alias must be unique and refer to only a single trained model. However,
you can have multiple aliases for each trained model.
If you use this API to update an alias such that it references a different
trained model ID and the model uses a different type of data frame analytics,
an error occurs. For example, this situation occurs if you have a trained
model for regression analysis and a trained model for classification
analysis; you cannot reassign an alias from one type of trained model to
another.
If you use this API to update an alias and there are very few input fields in
common between the old and new trained models for the model alias, the API
returns a warning. + /// + /// Creates or updates a trained model alias. A trained model alias is a logical + /// name used to reference a single trained model. + /// You can use aliases instead of trained model identifiers to make it easier to + /// reference your models. For example, you can use aliases in inference + /// aggregations and processors. + /// An alias must be unique and refer to only a single trained model. However, + /// you can have multiple aliases for each trained model. + /// If you use this API to update an alias such that it references a different + /// trained model ID and the model uses a different type of data frame analytics, + /// an error occurs. For example, this situation occurs if you have a trained + /// model for regression analysis and a trained model for classification + /// analysis; you cannot reassign an alias from one type of trained model to + /// another. + /// If you use this API to update an alias and there are very few input fields in + /// common between the old and new trained models for the model alias, the API + /// returns a warning. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6854,7 +9830,24 @@ public virtual PutTrainedModelAliasResponse PutTrainedModelAlias(Elastic.Clients } /// - /// Creates or updates a trained model alias. A trained model alias is a logical
name used to reference a single trained model.
You can use aliases instead of trained model identifiers to make it easier to
reference your models. For example, you can use aliases in inference
aggregations and processors.
An alias must be unique and refer to only a single trained model. However,
you can have multiple aliases for each trained model.
If you use this API to update an alias such that it references a different
trained model ID and the model uses a different type of data frame analytics,
an error occurs. For example, this situation occurs if you have a trained
model for regression analysis and a trained model for classification
analysis; you cannot reassign an alias from one type of trained model to
another.
If you use this API to update an alias and there are very few input fields in
common between the old and new trained models for the model alias, the API
returns a warning. + /// + /// Creates or updates a trained model alias. A trained model alias is a logical + /// name used to reference a single trained model. + /// You can use aliases instead of trained model identifiers to make it easier to + /// reference your models. For example, you can use aliases in inference + /// aggregations and processors. + /// An alias must be unique and refer to only a single trained model. However, + /// you can have multiple aliases for each trained model. + /// If you use this API to update an alias such that it references a different + /// trained model ID and the model uses a different type of data frame analytics, + /// an error occurs. For example, this situation occurs if you have a trained + /// model for regression analysis and a trained model for classification + /// analysis; you cannot reassign an alias from one type of trained model to + /// another. + /// If you use this API to update an alias and there are very few input fields in + /// common between the old and new trained models for the model alias, the API + /// returns a warning. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6867,7 +9860,24 @@ public virtual PutTrainedModelAliasResponse PutTrainedModelAlias(Elastic.Clients } /// - /// Creates or updates a trained model alias. A trained model alias is a logical
name used to reference a single trained model.
You can use aliases instead of trained model identifiers to make it easier to
reference your models. For example, you can use aliases in inference
aggregations and processors.
An alias must be unique and refer to only a single trained model. However,
you can have multiple aliases for each trained model.
If you use this API to update an alias such that it references a different
trained model ID and the model uses a different type of data frame analytics,
an error occurs. For example, this situation occurs if you have a trained
model for regression analysis and a trained model for classification
analysis; you cannot reassign an alias from one type of trained model to
another.
If you use this API to update an alias and there are very few input fields in
common between the old and new trained models for the model alias, the API
returns a warning. + /// + /// Creates or updates a trained model alias. A trained model alias is a logical + /// name used to reference a single trained model. + /// You can use aliases instead of trained model identifiers to make it easier to + /// reference your models. For example, you can use aliases in inference + /// aggregations and processors. + /// An alias must be unique and refer to only a single trained model. However, + /// you can have multiple aliases for each trained model. + /// If you use this API to update an alias such that it references a different + /// trained model ID and the model uses a different type of data frame analytics, + /// an error occurs. For example, this situation occurs if you have a trained + /// model for regression analysis and a trained model for classification + /// analysis; you cannot reassign an alias from one type of trained model to + /// another. + /// If you use this API to update an alias and there are very few input fields in + /// common between the old and new trained models for the model alias, the API + /// returns a warning. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelAliasAsync(PutTrainedModelAliasRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6877,7 +9887,24 @@ public virtual Task PutTrainedModelAliasAsync(PutT } /// - /// Creates or updates a trained model alias. A trained model alias is a logical
name used to reference a single trained model.
You can use aliases instead of trained model identifiers to make it easier to
reference your models. For example, you can use aliases in inference
aggregations and processors.
An alias must be unique and refer to only a single trained model. However,
you can have multiple aliases for each trained model.
If you use this API to update an alias such that it references a different
trained model ID and the model uses a different type of data frame analytics,
an error occurs. For example, this situation occurs if you have a trained
model for regression analysis and a trained model for classification
analysis; you cannot reassign an alias from one type of trained model to
another.
If you use this API to update an alias and there are very few input fields in
common between the old and new trained models for the model alias, the API
returns a warning. + /// + /// Creates or updates a trained model alias. A trained model alias is a logical + /// name used to reference a single trained model. + /// You can use aliases instead of trained model identifiers to make it easier to + /// reference your models. For example, you can use aliases in inference + /// aggregations and processors. + /// An alias must be unique and refer to only a single trained model. However, + /// you can have multiple aliases for each trained model. + /// If you use this API to update an alias such that it references a different + /// trained model ID and the model uses a different type of data frame analytics, + /// an error occurs. For example, this situation occurs if you have a trained + /// model for regression analysis and a trained model for classification + /// analysis; you cannot reassign an alias from one type of trained model to + /// another. + /// If you use this API to update an alias and there are very few input fields in + /// common between the old and new trained models for the model alias, the API + /// returns a warning. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelAliasAsync(Elastic.Clients.Elasticsearch.Id modelId, Elastic.Clients.Elasticsearch.Name modelAlias, CancellationToken cancellationToken = default) @@ -6888,7 +9915,24 @@ public virtual Task PutTrainedModelAliasAsync(Elas } /// - /// Creates or updates a trained model alias. A trained model alias is a logical
name used to reference a single trained model.
You can use aliases instead of trained model identifiers to make it easier to
reference your models. For example, you can use aliases in inference
aggregations and processors.
An alias must be unique and refer to only a single trained model. However,
you can have multiple aliases for each trained model.
If you use this API to update an alias such that it references a different
trained model ID and the model uses a different type of data frame analytics,
an error occurs. For example, this situation occurs if you have a trained
model for regression analysis and a trained model for classification
analysis; you cannot reassign an alias from one type of trained model to
another.
If you use this API to update an alias and there are very few input fields in
common between the old and new trained models for the model alias, the API
returns a warning. + /// + /// Creates or updates a trained model alias. A trained model alias is a logical + /// name used to reference a single trained model. + /// You can use aliases instead of trained model identifiers to make it easier to + /// reference your models. For example, you can use aliases in inference + /// aggregations and processors. + /// An alias must be unique and refer to only a single trained model. However, + /// you can have multiple aliases for each trained model. + /// If you use this API to update an alias such that it references a different + /// trained model ID and the model uses a different type of data frame analytics, + /// an error occurs. For example, this situation occurs if you have a trained + /// model for regression analysis and a trained model for classification + /// analysis; you cannot reassign an alias from one type of trained model to + /// another. + /// If you use this API to update an alias and there are very few input fields in + /// common between the old and new trained models for the model alias, the API + /// returns a warning. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelAliasAsync(Elastic.Clients.Elasticsearch.Id modelId, Elastic.Clients.Elasticsearch.Name modelAlias, Action configureRequest, CancellationToken cancellationToken = default) @@ -6900,7 +9944,9 @@ public virtual Task PutTrainedModelAliasAsync(Elas } /// - /// Creates part of a trained model definition. + /// + /// Creates part of a trained model definition. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6911,7 +9957,9 @@ public virtual PutTrainedModelDefinitionPartResponse PutTrainedModelDefinitionPa } /// - /// Creates part of a trained model definition. + /// + /// Creates part of a trained model definition. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelDefinitionPartAsync(PutTrainedModelDefinitionPartRequest request, CancellationToken cancellationToken = default) @@ -6921,7 +9969,9 @@ public virtual Task PutTrainedModelDefini } /// - /// Creates part of a trained model definition. + /// + /// Creates part of a trained model definition. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6932,7 +9982,9 @@ public virtual PutTrainedModelDefinitionPartResponse PutTrainedModelDefinitionPa } /// - /// Creates part of a trained model definition. + /// + /// Creates part of a trained model definition. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6944,7 +9996,9 @@ public virtual PutTrainedModelDefinitionPartResponse PutTrainedModelDefinitionPa } /// - /// Creates part of a trained model definition. + /// + /// Creates part of a trained model definition. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6957,7 +10011,9 @@ public virtual PutTrainedModelDefinitionPartResponse PutTrainedModelDefinitionPa } /// - /// Creates part of a trained model definition. + /// + /// Creates part of a trained model definition. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelDefinitionPartAsync(PutTrainedModelDefinitionPartRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6967,7 +10023,9 @@ public virtual Task PutTrainedModelDefini } /// - /// Creates part of a trained model definition. + /// + /// Creates part of a trained model definition. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelDefinitionPartAsync(Elastic.Clients.Elasticsearch.Id modelId, int part, CancellationToken cancellationToken = default) @@ -6978,7 +10036,9 @@ public virtual Task PutTrainedModelDefini } /// - /// Creates part of a trained model definition. + /// + /// Creates part of a trained model definition. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelDefinitionPartAsync(Elastic.Clients.Elasticsearch.Id modelId, int part, Action configureRequest, CancellationToken cancellationToken = default) @@ -6990,7 +10050,11 @@ public virtual Task PutTrainedModelDefini } /// - /// Creates a trained model vocabulary.
This API is supported only for natural language processing (NLP) models.
The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition. + /// + /// Creates a trained model vocabulary. + /// This API is supported only for natural language processing (NLP) models. + /// The vocabulary is stored in the index as described in inference_config.*.vocabulary of the trained model definition. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7001,7 +10065,11 @@ public virtual PutTrainedModelVocabularyResponse PutTrainedModelVocabulary(PutTr } /// - /// Creates a trained model vocabulary.
This API is supported only for natural language processing (NLP) models.
The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition. + /// + /// Creates a trained model vocabulary. + /// This API is supported only for natural language processing (NLP) models. + /// The vocabulary is stored in the index as described in inference_config.*.vocabulary of the trained model definition. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelVocabularyAsync(PutTrainedModelVocabularyRequest request, CancellationToken cancellationToken = default) @@ -7011,7 +10079,11 @@ public virtual Task PutTrainedModelVocabulary } /// - /// Creates a trained model vocabulary.
This API is supported only for natural language processing (NLP) models.
The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition. + /// + /// Creates a trained model vocabulary. + /// This API is supported only for natural language processing (NLP) models. + /// The vocabulary is stored in the index as described in inference_config.*.vocabulary of the trained model definition. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7022,7 +10094,11 @@ public virtual PutTrainedModelVocabularyResponse PutTrainedModelVocabulary(PutTr } /// - /// Creates a trained model vocabulary.
This API is supported only for natural language processing (NLP) models.
The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition. + /// + /// Creates a trained model vocabulary. + /// This API is supported only for natural language processing (NLP) models. + /// The vocabulary is stored in the index as described in inference_config.*.vocabulary of the trained model definition. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7034,7 +10110,11 @@ public virtual PutTrainedModelVocabularyResponse PutTrainedModelVocabulary(Elast } /// - /// Creates a trained model vocabulary.
This API is supported only for natural language processing (NLP) models.
The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition. + /// + /// Creates a trained model vocabulary. + /// This API is supported only for natural language processing (NLP) models. + /// The vocabulary is stored in the index as described in inference_config.*.vocabulary of the trained model definition. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7047,7 +10127,11 @@ public virtual PutTrainedModelVocabularyResponse PutTrainedModelVocabulary(Elast } /// - /// Creates a trained model vocabulary.
This API is supported only for natural language processing (NLP) models.
The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition. + /// + /// Creates a trained model vocabulary. + /// This API is supported only for natural language processing (NLP) models. + /// The vocabulary is stored in the index as described in inference_config.*.vocabulary of the trained model definition. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelVocabularyAsync(PutTrainedModelVocabularyRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -7057,7 +10141,11 @@ public virtual Task PutTrainedModelVocabulary } /// - /// Creates a trained model vocabulary.
This API is supported only for natural language processing (NLP) models.
The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition. + /// + /// Creates a trained model vocabulary. + /// This API is supported only for natural language processing (NLP) models. + /// The vocabulary is stored in the index as described in inference_config.*.vocabulary of the trained model definition. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelVocabularyAsync(Elastic.Clients.Elasticsearch.Id modelId, CancellationToken cancellationToken = default) @@ -7068,7 +10156,11 @@ public virtual Task PutTrainedModelVocabulary } /// - /// Creates a trained model vocabulary.
This API is supported only for natural language processing (NLP) models.
The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition. + /// + /// Creates a trained model vocabulary. + /// This API is supported only for natural language processing (NLP) models. + /// The vocabulary is stored in the index as described in inference_config.*.vocabulary of the trained model definition. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTrainedModelVocabularyAsync(Elastic.Clients.Elasticsearch.Id modelId, Action configureRequest, CancellationToken cancellationToken = default) @@ -7080,7 +10172,13 @@ public virtual Task PutTrainedModelVocabulary } /// - /// Resets an anomaly detection job.
All model state and results are deleted. The job is ready to start over as if
it had just been created.
It is not currently possible to reset multiple jobs using wildcards or a
comma separated list. + /// + /// Resets an anomaly detection job. + /// All model state and results are deleted. The job is ready to start over as if + /// it had just been created. + /// It is not currently possible to reset multiple jobs using wildcards or a + /// comma separated list. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7091,7 +10189,13 @@ public virtual ResetJobResponse ResetJob(ResetJobRequest request) } /// - /// Resets an anomaly detection job.
All model state and results are deleted. The job is ready to start over as if
it had just been created.
It is not currently possible to reset multiple jobs using wildcards or a
comma separated list. + /// + /// Resets an anomaly detection job. + /// All model state and results are deleted. The job is ready to start over as if + /// it had just been created. + /// It is not currently possible to reset multiple jobs using wildcards or a + /// comma separated list. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResetJobAsync(ResetJobRequest request, CancellationToken cancellationToken = default) @@ -7101,7 +10205,13 @@ public virtual Task ResetJobAsync(ResetJobRequest request, Can } /// - /// Resets an anomaly detection job.
All model state and results are deleted. The job is ready to start over as if
it had just been created.
It is not currently possible to reset multiple jobs using wildcards or a
comma separated list. + /// + /// Resets an anomaly detection job. + /// All model state and results are deleted. The job is ready to start over as if + /// it had just been created. + /// It is not currently possible to reset multiple jobs using wildcards or a + /// comma separated list. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7112,7 +10222,13 @@ public virtual ResetJobResponse ResetJob(ResetJobRequestDescriptor descriptor) } /// - /// Resets an anomaly detection job.
All model state and results are deleted. The job is ready to start over as if
it had just been created.
It is not currently possible to reset multiple jobs using wildcards or a
comma separated list. + /// + /// Resets an anomaly detection job. + /// All model state and results are deleted. The job is ready to start over as if + /// it had just been created. + /// It is not currently possible to reset multiple jobs using wildcards or a + /// comma separated list. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7124,7 +10240,13 @@ public virtual ResetJobResponse ResetJob(Elastic.Clients.Elasticsearch.Id jobId) } /// - /// Resets an anomaly detection job.
All model state and results are deleted. The job is ready to start over as if
it had just been created.
It is not currently possible to reset multiple jobs using wildcards or a
comma separated list. + /// + /// Resets an anomaly detection job. + /// All model state and results are deleted. The job is ready to start over as if + /// it had just been created. + /// It is not currently possible to reset multiple jobs using wildcards or a + /// comma separated list. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7137,7 +10259,13 @@ public virtual ResetJobResponse ResetJob(Elastic.Clients.Elasticsearch.Id jobId, } /// - /// Resets an anomaly detection job.
All model state and results are deleted. The job is ready to start over as if
it had just been created.
It is not currently possible to reset multiple jobs using wildcards or a
comma separated list. + /// + /// Resets an anomaly detection job. + /// All model state and results are deleted. The job is ready to start over as if + /// it had just been created. + /// It is not currently possible to reset multiple jobs using wildcards or a + /// comma separated list. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResetJobAsync(ResetJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -7147,7 +10275,13 @@ public virtual Task ResetJobAsync(ResetJobRequestDescriptor de } /// - /// Resets an anomaly detection job.
All model state and results are deleted. The job is ready to start over as if
it had just been created.
It is not currently possible to reset multiple jobs using wildcards or a
comma separated list. + /// + /// Resets an anomaly detection job. + /// All model state and results are deleted. The job is ready to start over as if + /// it had just been created. + /// It is not currently possible to reset multiple jobs using wildcards or a + /// comma separated list. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResetJobAsync(Elastic.Clients.Elasticsearch.Id jobId, CancellationToken cancellationToken = default) @@ -7158,7 +10292,13 @@ public virtual Task ResetJobAsync(Elastic.Clients.Elasticsearc } /// - /// Resets an anomaly detection job.
All model state and results are deleted. The job is ready to start over as if
it had just been created.
It is not currently possible to reset multiple jobs using wildcards or a
comma separated list. + /// + /// Resets an anomaly detection job. + /// All model state and results are deleted. The job is ready to start over as if + /// it had just been created. + /// It is not currently possible to reset multiple jobs using wildcards or a + /// comma separated list. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResetJobAsync(Elastic.Clients.Elasticsearch.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -7170,7 +10310,16 @@ public virtual Task ResetJobAsync(Elastic.Clients.Elasticsearc } /// - /// Reverts to a specific snapshot.
The machine learning features react quickly to anomalous input, learning new
behaviors in data. Highly anomalous input increases the variance in the
models whilst the system learns whether this is a new step-change in behavior
or a one-off event. In the case where this anomalous input is known to be a
one-off, then it might be appropriate to reset the model state to a time
before this event. For example, you might consider reverting to a saved
snapshot after Black Friday or a critical system failure. + /// + /// Reverts to a specific snapshot. + /// The machine learning features react quickly to anomalous input, learning new + /// behaviors in data. Highly anomalous input increases the variance in the + /// models whilst the system learns whether this is a new step-change in behavior + /// or a one-off event. In the case where this anomalous input is known to be a + /// one-off, then it might be appropriate to reset the model state to a time + /// before this event. For example, you might consider reverting to a saved + /// snapshot after Black Friday or a critical system failure. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7181,7 +10330,16 @@ public virtual RevertModelSnapshotResponse RevertModelSnapshot(RevertModelSnapsh } /// - /// Reverts to a specific snapshot.
The machine learning features react quickly to anomalous input, learning new
behaviors in data. Highly anomalous input increases the variance in the
models whilst the system learns whether this is a new step-change in behavior
or a one-off event. In the case where this anomalous input is known to be a
one-off, then it might be appropriate to reset the model state to a time
before this event. For example, you might consider reverting to a saved
snapshot after Black Friday or a critical system failure. + /// + /// Reverts to a specific snapshot. + /// The machine learning features react quickly to anomalous input, learning new + /// behaviors in data. Highly anomalous input increases the variance in the + /// models whilst the system learns whether this is a new step-change in behavior + /// or a one-off event. In the case where this anomalous input is known to be a + /// one-off, then it might be appropriate to reset the model state to a time + /// before this event. For example, you might consider reverting to a saved + /// snapshot after Black Friday or a critical system failure. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RevertModelSnapshotAsync(RevertModelSnapshotRequest request, CancellationToken cancellationToken = default) @@ -7191,7 +10349,16 @@ public virtual Task RevertModelSnapshotAsync(Revert } /// - /// Reverts to a specific snapshot.
The machine learning features react quickly to anomalous input, learning new
behaviors in data. Highly anomalous input increases the variance in the
models whilst the system learns whether this is a new step-change in behavior
or a one-off event. In the case where this anomalous input is known to be a
one-off, then it might be appropriate to reset the model state to a time
before this event. For example, you might consider reverting to a saved
snapshot after Black Friday or a critical system failure. + /// + /// Reverts to a specific snapshot. + /// The machine learning features react quickly to anomalous input, learning new + /// behaviors in data. Highly anomalous input increases the variance in the + /// models whilst the system learns whether this is a new step-change in behavior + /// or a one-off event. In the case where this anomalous input is known to be a + /// one-off, then it might be appropriate to reset the model state to a time + /// before this event. For example, you might consider reverting to a saved + /// snapshot after Black Friday or a critical system failure. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7202,7 +10369,16 @@ public virtual RevertModelSnapshotResponse RevertModelSnapshot(RevertModelSnapsh } /// - /// Reverts to a specific snapshot.
The machine learning features react quickly to anomalous input, learning new
behaviors in data. Highly anomalous input increases the variance in the
models whilst the system learns whether this is a new step-change in behavior
or a one-off event. In the case where this anomalous input is known to be a
one-off, then it might be appropriate to reset the model state to a time
before this event. For example, you might consider reverting to a saved
snapshot after Black Friday or a critical system failure. + /// + /// Reverts to a specific snapshot. + /// The machine learning features react quickly to anomalous input, learning new + /// behaviors in data. Highly anomalous input increases the variance in the + /// models whilst the system learns whether this is a new step-change in behavior + /// or a one-off event. In the case where this anomalous input is known to be a + /// one-off, then it might be appropriate to reset the model state to a time + /// before this event. For example, you might consider reverting to a saved + /// snapshot after Black Friday or a critical system failure. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7214,7 +10390,16 @@ public virtual RevertModelSnapshotResponse RevertModelSnapshot(Elastic.Clients.E } /// - /// Reverts to a specific snapshot.
The machine learning features react quickly to anomalous input, learning new
behaviors in data. Highly anomalous input increases the variance in the
models whilst the system learns whether this is a new step-change in behavior
or a one-off event. In the case where this anomalous input is known to be a
one-off, then it might be appropriate to reset the model state to a time
before this event. For example, you might consider reverting to a saved
snapshot after Black Friday or a critical system failure. + /// + /// Reverts to a specific snapshot. + /// The machine learning features react quickly to anomalous input, learning new + /// behaviors in data. Highly anomalous input increases the variance in the + /// models whilst the system learns whether this is a new step-change in behavior + /// or a one-off event. In the case where this anomalous input is known to be a + /// one-off, then it might be appropriate to reset the model state to a time + /// before this event. For example, you might consider reverting to a saved + /// snapshot after Black Friday or a critical system failure. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7227,7 +10412,16 @@ public virtual RevertModelSnapshotResponse RevertModelSnapshot(Elastic.Clients.E } /// - /// Reverts to a specific snapshot.
The machine learning features react quickly to anomalous input, learning new
behaviors in data. Highly anomalous input increases the variance in the
models whilst the system learns whether this is a new step-change in behavior
or a one-off event. In the case where this anomalous input is known to be a
one-off, then it might be appropriate to reset the model state to a time
before this event. For example, you might consider reverting to a saved
snapshot after Black Friday or a critical system failure. + /// + /// Reverts to a specific snapshot. + /// The machine learning features react quickly to anomalous input, learning new + /// behaviors in data. Highly anomalous input increases the variance in the + /// models whilst the system learns whether this is a new step-change in behavior + /// or a one-off event. In the case where this anomalous input is known to be a + /// one-off, then it might be appropriate to reset the model state to a time + /// before this event. For example, you might consider reverting to a saved + /// snapshot after Black Friday or a critical system failure. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RevertModelSnapshotAsync(RevertModelSnapshotRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -7237,7 +10431,16 @@ public virtual Task RevertModelSnapshotAsync(Revert } /// - /// Reverts to a specific snapshot.
The machine learning features react quickly to anomalous input, learning new
behaviors in data. Highly anomalous input increases the variance in the
models whilst the system learns whether this is a new step-change in behavior
or a one-off event. In the case where this anomalous input is known to be a
one-off, then it might be appropriate to reset the model state to a time
before this event. For example, you might consider reverting to a saved
snapshot after Black Friday or a critical system failure. + /// + /// Reverts to a specific snapshot. + /// The machine learning features react quickly to anomalous input, learning new + /// behaviors in data. Highly anomalous input increases the variance in the + /// models whilst the system learns whether this is a new step-change in behavior + /// or a one-off event. In the case where this anomalous input is known to be a + /// one-off, then it might be appropriate to reset the model state to a time + /// before this event. For example, you might consider reverting to a saved + /// snapshot after Black Friday or a critical system failure. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RevertModelSnapshotAsync(Elastic.Clients.Elasticsearch.Id jobId, Elastic.Clients.Elasticsearch.Id snapshotId, CancellationToken cancellationToken = default) @@ -7248,7 +10451,16 @@ public virtual Task RevertModelSnapshotAsync(Elasti } /// - /// Reverts to a specific snapshot.
The machine learning features react quickly to anomalous input, learning new
behaviors in data. Highly anomalous input increases the variance in the
models whilst the system learns whether this is a new step-change in behavior
or a one-off event. In the case where this anomalous input is known to be a
one-off, then it might be appropriate to reset the model state to a time
before this event. For example, you might consider reverting to a saved
snapshot after Black Friday or a critical system failure. + /// + /// Reverts to a specific snapshot. + /// The machine learning features react quickly to anomalous input, learning new + /// behaviors in data. Highly anomalous input increases the variance in the + /// models whilst the system learns whether this is a new step-change in behavior + /// or a one-off event. In the case where this anomalous input is known to be a + /// one-off, then it might be appropriate to reset the model state to a time + /// before this event. For example, you might consider reverting to a saved + /// snapshot after Black Friday or a critical system failure. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RevertModelSnapshotAsync(Elastic.Clients.Elasticsearch.Id jobId, Elastic.Clients.Elasticsearch.Id snapshotId, Action configureRequest, CancellationToken cancellationToken = default) @@ -7260,7 +10472,20 @@ public virtual Task RevertModelSnapshotAsync(Elasti } /// - /// Sets a cluster wide upgrade_mode setting that prepares machine learning
indices for an upgrade.
When upgrading your cluster, in some circumstances you must restart your
nodes and reindex your machine learning indices. In those circumstances,
there must be no machine learning jobs running. You can close the machine
learning jobs, do the upgrade, then open all the jobs again. Alternatively,
you can use this API to temporarily halt tasks associated with the jobs and
datafeeds and prevent new jobs from opening. You can also use this API
during upgrades that do not require you to reindex your machine learning
indices, though stopping jobs is not a requirement in that case.
You can see the current value for the upgrade_mode setting by using the get
machine learning info API. + /// + /// Sets a cluster wide upgrade_mode setting that prepares machine learning + /// indices for an upgrade. + /// When upgrading your cluster, in some circumstances you must restart your + /// nodes and reindex your machine learning indices. In those circumstances, + /// there must be no machine learning jobs running. You can close the machine + /// learning jobs, do the upgrade, then open all the jobs again. Alternatively, + /// you can use this API to temporarily halt tasks associated with the jobs and + /// datafeeds and prevent new jobs from opening. You can also use this API + /// during upgrades that do not require you to reindex your machine learning + /// indices, though stopping jobs is not a requirement in that case. + /// You can see the current value for the upgrade_mode setting by using the get + /// machine learning info API. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7271,7 +10496,20 @@ public virtual SetUpgradeModeResponse SetUpgradeMode(SetUpgradeModeRequest reque } /// - /// Sets a cluster wide upgrade_mode setting that prepares machine learning
indices for an upgrade.
When upgrading your cluster, in some circumstances you must restart your
nodes and reindex your machine learning indices. In those circumstances,
there must be no machine learning jobs running. You can close the machine
learning jobs, do the upgrade, then open all the jobs again. Alternatively,
you can use this API to temporarily halt tasks associated with the jobs and
datafeeds and prevent new jobs from opening. You can also use this API
during upgrades that do not require you to reindex your machine learning
indices, though stopping jobs is not a requirement in that case.
You can see the current value for the upgrade_mode setting by using the get
machine learning info API. + /// + /// Sets a cluster wide upgrade_mode setting that prepares machine learning + /// indices for an upgrade. + /// When upgrading your cluster, in some circumstances you must restart your + /// nodes and reindex your machine learning indices. In those circumstances, + /// there must be no machine learning jobs running. You can close the machine + /// learning jobs, do the upgrade, then open all the jobs again. Alternatively, + /// you can use this API to temporarily halt tasks associated with the jobs and + /// datafeeds and prevent new jobs from opening. You can also use this API + /// during upgrades that do not require you to reindex your machine learning + /// indices, though stopping jobs is not a requirement in that case. + /// You can see the current value for the upgrade_mode setting by using the get + /// machine learning info API. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SetUpgradeModeAsync(SetUpgradeModeRequest request, CancellationToken cancellationToken = default) @@ -7281,7 +10519,20 @@ public virtual Task SetUpgradeModeAsync(SetUpgradeModeRe } /// - /// Sets a cluster wide upgrade_mode setting that prepares machine learning
indices for an upgrade.
When upgrading your cluster, in some circumstances you must restart your
nodes and reindex your machine learning indices. In those circumstances,
there must be no machine learning jobs running. You can close the machine
learning jobs, do the upgrade, then open all the jobs again. Alternatively,
you can use this API to temporarily halt tasks associated with the jobs and
datafeeds and prevent new jobs from opening. You can also use this API
during upgrades that do not require you to reindex your machine learning
indices, though stopping jobs is not a requirement in that case.
You can see the current value for the upgrade_mode setting by using the get
machine learning info API. + /// + /// Sets a cluster wide upgrade_mode setting that prepares machine learning + /// indices for an upgrade. + /// When upgrading your cluster, in some circumstances you must restart your + /// nodes and reindex your machine learning indices. In those circumstances, + /// there must be no machine learning jobs running. You can close the machine + /// learning jobs, do the upgrade, then open all the jobs again. Alternatively, + /// you can use this API to temporarily halt tasks associated with the jobs and + /// datafeeds and prevent new jobs from opening. You can also use this API + /// during upgrades that do not require you to reindex your machine learning + /// indices, though stopping jobs is not a requirement in that case. + /// You can see the current value for the upgrade_mode setting by using the get + /// machine learning info API. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7292,7 +10543,20 @@ public virtual SetUpgradeModeResponse SetUpgradeMode(SetUpgradeModeRequestDescri } /// - /// Sets a cluster wide upgrade_mode setting that prepares machine learning
indices for an upgrade.
When upgrading your cluster, in some circumstances you must restart your
nodes and reindex your machine learning indices. In those circumstances,
there must be no machine learning jobs running. You can close the machine
learning jobs, do the upgrade, then open all the jobs again. Alternatively,
you can use this API to temporarily halt tasks associated with the jobs and
datafeeds and prevent new jobs from opening. You can also use this API
during upgrades that do not require you to reindex your machine learning
indices, though stopping jobs is not a requirement in that case.
You can see the current value for the upgrade_mode setting by using the get
machine learning info API. + /// + /// Sets a cluster wide upgrade_mode setting that prepares machine learning + /// indices for an upgrade. + /// When upgrading your cluster, in some circumstances you must restart your + /// nodes and reindex your machine learning indices. In those circumstances, + /// there must be no machine learning jobs running. You can close the machine + /// learning jobs, do the upgrade, then open all the jobs again. Alternatively, + /// you can use this API to temporarily halt tasks associated with the jobs and + /// datafeeds and prevent new jobs from opening. You can also use this API + /// during upgrades that do not require you to reindex your machine learning + /// indices, though stopping jobs is not a requirement in that case. + /// You can see the current value for the upgrade_mode setting by using the get + /// machine learning info API. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7304,7 +10568,20 @@ public virtual SetUpgradeModeResponse SetUpgradeMode() } /// - /// Sets a cluster wide upgrade_mode setting that prepares machine learning
indices for an upgrade.
When upgrading your cluster, in some circumstances you must restart your
nodes and reindex your machine learning indices. In those circumstances,
there must be no machine learning jobs running. You can close the machine
learning jobs, do the upgrade, then open all the jobs again. Alternatively,
you can use this API to temporarily halt tasks associated with the jobs and
datafeeds and prevent new jobs from opening. You can also use this API
during upgrades that do not require you to reindex your machine learning
indices, though stopping jobs is not a requirement in that case.
You can see the current value for the upgrade_mode setting by using the get
machine learning info API. + /// + /// Sets a cluster wide upgrade_mode setting that prepares machine learning + /// indices for an upgrade. + /// When upgrading your cluster, in some circumstances you must restart your + /// nodes and reindex your machine learning indices. In those circumstances, + /// there must be no machine learning jobs running. You can close the machine + /// learning jobs, do the upgrade, then open all the jobs again. Alternatively, + /// you can use this API to temporarily halt tasks associated with the jobs and + /// datafeeds and prevent new jobs from opening. You can also use this API + /// during upgrades that do not require you to reindex your machine learning + /// indices, though stopping jobs is not a requirement in that case. + /// You can see the current value for the upgrade_mode setting by using the get + /// machine learning info API. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7317,7 +10594,20 @@ public virtual SetUpgradeModeResponse SetUpgradeMode(Action - /// Sets a cluster wide upgrade_mode setting that prepares machine learning
indices for an upgrade.
When upgrading your cluster, in some circumstances you must restart your
nodes and reindex your machine learning indices. In those circumstances,
there must be no machine learning jobs running. You can close the machine
learning jobs, do the upgrade, then open all the jobs again. Alternatively,
you can use this API to temporarily halt tasks associated with the jobs and
datafeeds and prevent new jobs from opening. You can also use this API
during upgrades that do not require you to reindex your machine learning
indices, though stopping jobs is not a requirement in that case.
You can see the current value for the upgrade_mode setting by using the get
machine learning info API. + /// + /// Sets a cluster wide upgrade_mode setting that prepares machine learning + /// indices for an upgrade. + /// When upgrading your cluster, in some circumstances you must restart your + /// nodes and reindex your machine learning indices. In those circumstances, + /// there must be no machine learning jobs running. You can close the machine + /// learning jobs, do the upgrade, then open all the jobs again. Alternatively, + /// you can use this API to temporarily halt tasks associated with the jobs and + /// datafeeds and prevent new jobs from opening. You can also use this API + /// during upgrades that do not require you to reindex your machine learning + /// indices, though stopping jobs is not a requirement in that case. + /// You can see the current value for the upgrade_mode setting by using the get + /// machine learning info API. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SetUpgradeModeAsync(SetUpgradeModeRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -7327,7 +10617,20 @@ public virtual Task SetUpgradeModeAsync(SetUpgradeModeRe } /// - /// Sets a cluster wide upgrade_mode setting that prepares machine learning
indices for an upgrade.
When upgrading your cluster, in some circumstances you must restart your
nodes and reindex your machine learning indices. In those circumstances,
there must be no machine learning jobs running. You can close the machine
learning jobs, do the upgrade, then open all the jobs again. Alternatively,
you can use this API to temporarily halt tasks associated with the jobs and
datafeeds and prevent new jobs from opening. You can also use this API
during upgrades that do not require you to reindex your machine learning
indices, though stopping jobs is not a requirement in that case.
You can see the current value for the upgrade_mode setting by using the get
machine learning info API. + /// + /// Sets a cluster wide upgrade_mode setting that prepares machine learning + /// indices for an upgrade. + /// When upgrading your cluster, in some circumstances you must restart your + /// nodes and reindex your machine learning indices. In those circumstances, + /// there must be no machine learning jobs running. You can close the machine + /// learning jobs, do the upgrade, then open all the jobs again. Alternatively, + /// you can use this API to temporarily halt tasks associated with the jobs and + /// datafeeds and prevent new jobs from opening. You can also use this API + /// during upgrades that do not require you to reindex your machine learning + /// indices, though stopping jobs is not a requirement in that case. + /// You can see the current value for the upgrade_mode setting by using the get + /// machine learning info API. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SetUpgradeModeAsync(CancellationToken cancellationToken = default) @@ -7338,7 +10641,20 @@ public virtual Task SetUpgradeModeAsync(CancellationToke } /// - /// Sets a cluster wide upgrade_mode setting that prepares machine learning
indices for an upgrade.
When upgrading your cluster, in some circumstances you must restart your
nodes and reindex your machine learning indices. In those circumstances,
there must be no machine learning jobs running. You can close the machine
learning jobs, do the upgrade, then open all the jobs again. Alternatively,
you can use this API to temporarily halt tasks associated with the jobs and
datafeeds and prevent new jobs from opening. You can also use this API
during upgrades that do not require you to reindex your machine learning
indices, though stopping jobs is not a requirement in that case.
You can see the current value for the upgrade_mode setting by using the get
machine learning info API. + /// + /// Sets a cluster wide upgrade_mode setting that prepares machine learning + /// indices for an upgrade. + /// When upgrading your cluster, in some circumstances you must restart your + /// nodes and reindex your machine learning indices. In those circumstances, + /// there must be no machine learning jobs running. You can close the machine + /// learning jobs, do the upgrade, then open all the jobs again. Alternatively, + /// you can use this API to temporarily halt tasks associated with the jobs and + /// datafeeds and prevent new jobs from opening. You can also use this API + /// during upgrades that do not require you to reindex your machine learning + /// indices, though stopping jobs is not a requirement in that case. + /// You can see the current value for the upgrade_mode setting by using the get + /// machine learning info API. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SetUpgradeModeAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -7350,11 +10666,25 @@ public virtual Task SetUpgradeModeAsync(Action - /// Starts one or more datafeeds. - /// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. - /// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. - /// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.
If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. - /// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or
update it had at the time of creation or update and runs the query using those same roles. If you provided secondary
authorization headers when you created or updated the datafeed, those credentials are used instead. + /// + /// Starts one or more datafeeds. + /// + /// + /// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped + /// multiple times throughout its lifecycle. + /// + /// + /// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. + /// + /// + /// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped. + /// If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. + /// + /// + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or + /// update it had at the time of creation or update and runs the query using those same roles. If you provided secondary + /// authorization headers when you created or updated the datafeed, those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7365,11 +10695,25 @@ public virtual StartDatafeedResponse StartDatafeed(StartDatafeedRequest request) } /// - /// Starts one or more datafeeds. - /// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. - /// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. - /// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.
If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. - /// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or
update it had at the time of creation or update and runs the query using those same roles. If you provided secondary
authorization headers when you created or updated the datafeed, those credentials are used instead. + /// + /// Starts one or more datafeeds. + /// + /// + /// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped + /// multiple times throughout its lifecycle. + /// + /// + /// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. + /// + /// + /// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped. + /// If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. + /// + /// + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or + /// update it had at the time of creation or update and runs the query using those same roles. If you provided secondary + /// authorization headers when you created or updated the datafeed, those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartDatafeedAsync(StartDatafeedRequest request, CancellationToken cancellationToken = default) @@ -7379,11 +10723,25 @@ public virtual Task StartDatafeedAsync(StartDatafeedReque } /// - /// Starts one or more datafeeds. - /// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. - /// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. - /// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.
If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. - /// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or
update it had at the time of creation or update and runs the query using those same roles. If you provided secondary
authorization headers when you created or updated the datafeed, those credentials are used instead. + /// + /// Starts one or more datafeeds. + /// + /// + /// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped + /// multiple times throughout its lifecycle. + /// + /// + /// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. + /// + /// + /// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped. + /// If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. + /// + /// + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or + /// update it had at the time of creation or update and runs the query using those same roles. If you provided secondary + /// authorization headers when you created or updated the datafeed, those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7394,11 +10752,25 @@ public virtual StartDatafeedResponse StartDatafeed(StartDatafeedRequestDescripto } /// - /// Starts one or more datafeeds. - /// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. - /// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. - /// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.
If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. - /// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or
update it had at the time of creation or update and runs the query using those same roles. If you provided secondary
authorization headers when you created or updated the datafeed, those credentials are used instead. + /// + /// Starts one or more datafeeds. + /// + /// + /// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped + /// multiple times throughout its lifecycle. + /// + /// + /// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. + /// + /// + /// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped. + /// If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. + /// + /// + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or + /// update it had at the time of creation or update and runs the query using those same roles. If you provided secondary + /// authorization headers when you created or updated the datafeed, those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7410,11 +10782,25 @@ public virtual StartDatafeedResponse StartDatafeed(Elastic.Clients.Elasticsearch } /// - /// Starts one or more datafeeds. - /// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. - /// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. - /// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.
If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. - /// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or
update it had at the time of creation or update and runs the query using those same roles. If you provided secondary
authorization headers when you created or updated the datafeed, those credentials are used instead. + /// + /// Starts one or more datafeeds. + /// + /// + /// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped + /// multiple times throughout its lifecycle. + /// + /// + /// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. + /// + /// + /// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped. + /// If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. + /// + /// + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or + /// update it had at the time of creation or update and runs the query using those same roles. If you provided secondary + /// authorization headers when you created or updated the datafeed, those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7427,11 +10813,25 @@ public virtual StartDatafeedResponse StartDatafeed(Elastic.Clients.Elasticsearch } /// - /// Starts one or more datafeeds. - /// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. - /// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. - /// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.
If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. - /// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or
update it had at the time of creation or update and runs the query using those same roles. If you provided secondary
authorization headers when you created or updated the datafeed, those credentials are used instead. + /// + /// Starts one or more datafeeds. + /// + /// + /// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped + /// multiple times throughout its lifecycle. + /// + /// + /// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. + /// + /// + /// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped. + /// If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. + /// + /// + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or + /// update it had at the time of creation or update and runs the query using those same roles. If you provided secondary + /// authorization headers when you created or updated the datafeed, those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartDatafeedAsync(StartDatafeedRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -7441,11 +10841,25 @@ public virtual Task StartDatafeedAsync(StartDatafeedReque } /// - /// Starts one or more datafeeds. - /// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. - /// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. - /// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.
If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. - /// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or
update it had at the time of creation or update and runs the query using those same roles. If you provided secondary
authorization headers when you created or updated the datafeed, those credentials are used instead. + /// + /// Starts one or more datafeeds. + /// + /// + /// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped + /// multiple times throughout its lifecycle. + /// + /// + /// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. + /// + /// + /// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped. + /// If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. + /// + /// + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or + /// update it had at the time of creation or update and runs the query using those same roles. If you provided secondary + /// authorization headers when you created or updated the datafeed, those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartDatafeedAsync(Elastic.Clients.Elasticsearch.Id datafeedId, CancellationToken cancellationToken = default) @@ -7456,11 +10870,25 @@ public virtual Task StartDatafeedAsync(Elastic.Clients.El } /// - /// Starts one or more datafeeds. - /// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. - /// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. - /// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.
If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. - /// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or
update it had at the time of creation or update and runs the query using those same roles. If you provided secondary
authorization headers when you created or updated the datafeed, those credentials are used instead. + /// + /// Starts one or more datafeeds. + /// + /// + /// A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped + /// multiple times throughout its lifecycle. + /// + /// + /// Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. + /// + /// + /// If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped. + /// If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. + /// + /// + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or + /// update it had at the time of creation or update and runs the query using those same roles. If you provided secondary + /// authorization headers when you created or updated the datafeed, those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartDatafeedAsync(Elastic.Clients.Elasticsearch.Id datafeedId, Action configureRequest, CancellationToken cancellationToken = default) @@ -7472,7 +10900,20 @@ public virtual Task StartDatafeedAsync(Elastic.Clients.El } /// - /// Starts a data frame analytics job.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle.
If the destination index does not exist, it is created automatically the
first time you start the data frame analytics job. The
`index.number_of_shards` and `index.number_of_replicas` settings for the
destination index are copied from the source index. If there are multiple
source indices, the destination index copies the highest setting values. The
mappings for the destination index are also copied from the source indices.
If there are any mapping conflicts, the job fails to start.
If the destination index exists, it is used as is. You can therefore set up
the destination index in advance with custom settings and mappings. + /// + /// Starts a data frame analytics job. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// If the destination index does not exist, it is created automatically the + /// first time you start the data frame analytics job. The + /// index.number_of_shards and index.number_of_replicas settings for the + /// destination index are copied from the source index. If there are multiple + /// source indices, the destination index copies the highest setting values. The + /// mappings for the destination index are also copied from the source indices. + /// If there are any mapping conflicts, the job fails to start. + /// If the destination index exists, it is used as is. You can therefore set up + /// the destination index in advance with custom settings and mappings. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7483,7 +10924,20 @@ public virtual StartDataFrameAnalyticsResponse StartDataFrameAnalytics(StartData } /// - /// Starts a data frame analytics job.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle.
If the destination index does not exist, it is created automatically the
first time you start the data frame analytics job. The
`index.number_of_shards` and `index.number_of_replicas` settings for the
destination index are copied from the source index. If there are multiple
source indices, the destination index copies the highest setting values. The
mappings for the destination index are also copied from the source indices.
If there are any mapping conflicts, the job fails to start.
If the destination index exists, it is used as is. You can therefore set up
the destination index in advance with custom settings and mappings. + /// + /// Starts a data frame analytics job. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// If the destination index does not exist, it is created automatically the + /// first time you start the data frame analytics job. The + /// index.number_of_shards and index.number_of_replicas settings for the + /// destination index are copied from the source index. If there are multiple + /// source indices, the destination index copies the highest setting values. The + /// mappings for the destination index are also copied from the source indices. + /// If there are any mapping conflicts, the job fails to start. + /// If the destination index exists, it is used as is. You can therefore set up + /// the destination index in advance with custom settings and mappings. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartDataFrameAnalyticsAsync(StartDataFrameAnalyticsRequest request, CancellationToken cancellationToken = default) @@ -7493,7 +10947,20 @@ public virtual Task StartDataFrameAnalyticsAsyn } /// - /// Starts a data frame analytics job.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle.
If the destination index does not exist, it is created automatically the
first time you start the data frame analytics job. The
`index.number_of_shards` and `index.number_of_replicas` settings for the
destination index are copied from the source index. If there are multiple
source indices, the destination index copies the highest setting values. The
mappings for the destination index are also copied from the source indices.
If there are any mapping conflicts, the job fails to start.
If the destination index exists, it is used as is. You can therefore set up
the destination index in advance with custom settings and mappings. + /// + /// Starts a data frame analytics job. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// If the destination index does not exist, it is created automatically the + /// first time you start the data frame analytics job. The + /// index.number_of_shards and index.number_of_replicas settings for the + /// destination index are copied from the source index. If there are multiple + /// source indices, the destination index copies the highest setting values. The + /// mappings for the destination index are also copied from the source indices. + /// If there are any mapping conflicts, the job fails to start. + /// If the destination index exists, it is used as is. You can therefore set up + /// the destination index in advance with custom settings and mappings. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7504,7 +10971,20 @@ public virtual StartDataFrameAnalyticsResponse StartDataFrameAnalytics - /// Starts a data frame analytics job.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle.
If the destination index does not exist, it is created automatically the
first time you start the data frame analytics job. The
`index.number_of_shards` and `index.number_of_replicas` settings for the
destination index are copied from the source index. If there are multiple
source indices, the destination index copies the highest setting values. The
mappings for the destination index are also copied from the source indices.
If there are any mapping conflicts, the job fails to start.
If the destination index exists, it is used as is. You can therefore set up
the destination index in advance with custom settings and mappings. + /// + /// Starts a data frame analytics job. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// If the destination index does not exist, it is created automatically the + /// first time you start the data frame analytics job. The + /// index.number_of_shards and index.number_of_replicas settings for the + /// destination index are copied from the source index. If there are multiple + /// source indices, the destination index copies the highest setting values. The + /// mappings for the destination index are also copied from the source indices. + /// If there are any mapping conflicts, the job fails to start. + /// If the destination index exists, it is used as is. You can therefore set up + /// the destination index in advance with custom settings and mappings. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7516,7 +10996,20 @@ public virtual StartDataFrameAnalyticsResponse StartDataFrameAnalytics - /// Starts a data frame analytics job.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle.
If the destination index does not exist, it is created automatically the
first time you start the data frame analytics job. The
`index.number_of_shards` and `index.number_of_replicas` settings for the
destination index are copied from the source index. If there are multiple
source indices, the destination index copies the highest setting values. The
mappings for the destination index are also copied from the source indices.
If there are any mapping conflicts, the job fails to start.
If the destination index exists, it is used as is. You can therefore set up
the destination index in advance with custom settings and mappings. + /// + /// Starts a data frame analytics job. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// If the destination index does not exist, it is created automatically the + /// first time you start the data frame analytics job. The + /// index.number_of_shards and index.number_of_replicas settings for the + /// destination index are copied from the source index. If there are multiple + /// source indices, the destination index copies the highest setting values. The + /// mappings for the destination index are also copied from the source indices. + /// If there are any mapping conflicts, the job fails to start. + /// If the destination index exists, it is used as is. You can therefore set up + /// the destination index in advance with custom settings and mappings. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7529,7 +11022,20 @@ public virtual StartDataFrameAnalyticsResponse StartDataFrameAnalytics - /// Starts a data frame analytics job.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle.
If the destination index does not exist, it is created automatically the
first time you start the data frame analytics job. The
`index.number_of_shards` and `index.number_of_replicas` settings for the
destination index are copied from the source index. If there are multiple
source indices, the destination index copies the highest setting values. The
mappings for the destination index are also copied from the source indices.
If there are any mapping conflicts, the job fails to start.
If the destination index exists, it is used as is. You can therefore set up
the destination index in advance with custom settings and mappings. + /// + /// Starts a data frame analytics job. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// If the destination index does not exist, it is created automatically the + /// first time you start the data frame analytics job. The + /// index.number_of_shards and index.number_of_replicas settings for the + /// destination index are copied from the source index. If there are multiple + /// source indices, the destination index copies the highest setting values. The + /// mappings for the destination index are also copied from the source indices. + /// If there are any mapping conflicts, the job fails to start. + /// If the destination index exists, it is used as is. You can therefore set up + /// the destination index in advance with custom settings and mappings. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7540,7 +11046,20 @@ public virtual StartDataFrameAnalyticsResponse StartDataFrameAnalytics(StartData } /// - /// Starts a data frame analytics job.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle.
If the destination index does not exist, it is created automatically the
first time you start the data frame analytics job. The
`index.number_of_shards` and `index.number_of_replicas` settings for the
destination index are copied from the source index. If there are multiple
source indices, the destination index copies the highest setting values. The
mappings for the destination index are also copied from the source indices.
If there are any mapping conflicts, the job fails to start.
If the destination index exists, it is used as is. You can therefore set up
the destination index in advance with custom settings and mappings. + /// + /// Starts a data frame analytics job. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// If the destination index does not exist, it is created automatically the + /// first time you start the data frame analytics job. The + /// index.number_of_shards and index.number_of_replicas settings for the + /// destination index are copied from the source index. If there are multiple + /// source indices, the destination index copies the highest setting values. The + /// mappings for the destination index are also copied from the source indices. + /// If there are any mapping conflicts, the job fails to start. + /// If the destination index exists, it is used as is. You can therefore set up + /// the destination index in advance with custom settings and mappings. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7552,7 +11071,20 @@ public virtual StartDataFrameAnalyticsResponse StartDataFrameAnalytics(Elastic.C } /// - /// Starts a data frame analytics job.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle.
If the destination index does not exist, it is created automatically the
first time you start the data frame analytics job. The
`index.number_of_shards` and `index.number_of_replicas` settings for the
destination index are copied from the source index. If there are multiple
source indices, the destination index copies the highest setting values. The
mappings for the destination index are also copied from the source indices.
If there are any mapping conflicts, the job fails to start.
If the destination index exists, it is used as is. You can therefore set up
the destination index in advance with custom settings and mappings. + /// + /// Starts a data frame analytics job. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// If the destination index does not exist, it is created automatically the + /// first time you start the data frame analytics job. The + /// index.number_of_shards and index.number_of_replicas settings for the + /// destination index are copied from the source index. If there are multiple + /// source indices, the destination index copies the highest setting values. The + /// mappings for the destination index are also copied from the source indices. + /// If there are any mapping conflicts, the job fails to start. + /// If the destination index exists, it is used as is. You can therefore set up + /// the destination index in advance with custom settings and mappings. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7565,7 +11097,20 @@ public virtual StartDataFrameAnalyticsResponse StartDataFrameAnalytics(Elastic.C } /// - /// Starts a data frame analytics job.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle.
If the destination index does not exist, it is created automatically the
first time you start the data frame analytics job. The
`index.number_of_shards` and `index.number_of_replicas` settings for the
destination index are copied from the source index. If there are multiple
source indices, the destination index copies the highest setting values. The
mappings for the destination index are also copied from the source indices.
If there are any mapping conflicts, the job fails to start.
If the destination index exists, it is used as is. You can therefore set up
the destination index in advance with custom settings and mappings. + /// + /// Starts a data frame analytics job. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// If the destination index does not exist, it is created automatically the + /// first time you start the data frame analytics job. The + /// index.number_of_shards and index.number_of_replicas settings for the + /// destination index are copied from the source index. If there are multiple + /// source indices, the destination index copies the highest setting values. The + /// mappings for the destination index are also copied from the source indices. + /// If there are any mapping conflicts, the job fails to start. + /// If the destination index exists, it is used as is. You can therefore set up + /// the destination index in advance with custom settings and mappings. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartDataFrameAnalyticsAsync(StartDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -7575,7 +11120,20 @@ public virtual Task StartDataFrameAnalyticsAsyn } /// - /// Starts a data frame analytics job.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle.
If the destination index does not exist, it is created automatically the
first time you start the data frame analytics job. The
`index.number_of_shards` and `index.number_of_replicas` settings for the
destination index are copied from the source index. If there are multiple
source indices, the destination index copies the highest setting values. The
mappings for the destination index are also copied from the source indices.
If there are any mapping conflicts, the job fails to start.
If the destination index exists, it is used as is. You can therefore set up
the destination index in advance with custom settings and mappings. + /// + /// Starts a data frame analytics job. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// If the destination index does not exist, it is created automatically the + /// first time you start the data frame analytics job. The + /// index.number_of_shards and index.number_of_replicas settings for the + /// destination index are copied from the source index. If there are multiple + /// source indices, the destination index copies the highest setting values. The + /// mappings for the destination index are also copied from the source indices. + /// If there are any mapping conflicts, the job fails to start. + /// If the destination index exists, it is used as is. You can therefore set up + /// the destination index in advance with custom settings and mappings. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -7586,7 +11144,20 @@ public virtual Task StartDataFrameAnalyticsAsyn } /// - /// Starts a data frame analytics job.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle.
If the destination index does not exist, it is created automatically the
first time you start the data frame analytics job. The
`index.number_of_shards` and `index.number_of_replicas` settings for the
destination index are copied from the source index. If there are multiple
source indices, the destination index copies the highest setting values. The
mappings for the destination index are also copied from the source indices.
If there are any mapping conflicts, the job fails to start.
If the destination index exists, it is used as is. You can therefore set up
the destination index in advance with custom settings and mappings. + /// + /// Starts a data frame analytics job. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// If the destination index does not exist, it is created automatically the + /// first time you start the data frame analytics job. The + /// index.number_of_shards and index.number_of_replicas settings for the + /// destination index are copied from the source index. If there are multiple + /// source indices, the destination index copies the highest setting values. The + /// mappings for the destination index are also copied from the source indices. + /// If there are any mapping conflicts, the job fails to start. + /// If the destination index exists, it is used as is. You can therefore set up + /// the destination index in advance with custom settings and mappings. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -7598,7 +11169,20 @@ public virtual Task StartDataFrameAnalyticsAsyn } /// - /// Starts a data frame analytics job.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle.
If the destination index does not exist, it is created automatically the
first time you start the data frame analytics job. The
`index.number_of_shards` and `index.number_of_replicas` settings for the
destination index are copied from the source index. If there are multiple
source indices, the destination index copies the highest setting values. The
mappings for the destination index are also copied from the source indices.
If there are any mapping conflicts, the job fails to start.
If the destination index exists, it is used as is. You can therefore set up
the destination index in advance with custom settings and mappings. + /// + /// Starts a data frame analytics job. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// If the destination index does not exist, it is created automatically the + /// first time you start the data frame analytics job. The + /// index.number_of_shards and index.number_of_replicas settings for the + /// destination index are copied from the source index. If there are multiple + /// source indices, the destination index copies the highest setting values. The + /// mappings for the destination index are also copied from the source indices. + /// If there are any mapping conflicts, the job fails to start. + /// If the destination index exists, it is used as is. You can therefore set up + /// the destination index in advance with custom settings and mappings. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartDataFrameAnalyticsAsync(StartDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -7608,7 +11192,20 @@ public virtual Task StartDataFrameAnalyticsAsyn } /// - /// Starts a data frame analytics job.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle.
If the destination index does not exist, it is created automatically the
first time you start the data frame analytics job. The
`index.number_of_shards` and `index.number_of_replicas` settings for the
destination index are copied from the source index. If there are multiple
source indices, the destination index copies the highest setting values. The
mappings for the destination index are also copied from the source indices.
If there are any mapping conflicts, the job fails to start.
If the destination index exists, it is used as is. You can therefore set up
the destination index in advance with custom settings and mappings. + /// + /// Starts a data frame analytics job. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// If the destination index does not exist, it is created automatically the + /// first time you start the data frame analytics job. The + /// index.number_of_shards and index.number_of_replicas settings for the + /// destination index are copied from the source index. If there are multiple + /// source indices, the destination index copies the highest setting values. The + /// mappings for the destination index are also copied from the source indices. + /// If there are any mapping conflicts, the job fails to start. + /// If the destination index exists, it is used as is. You can therefore set up + /// the destination index in advance with custom settings and mappings. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -7619,7 +11216,20 @@ public virtual Task StartDataFrameAnalyticsAsyn } /// - /// Starts a data frame analytics job.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle.
If the destination index does not exist, it is created automatically the
first time you start the data frame analytics job. The
`index.number_of_shards` and `index.number_of_replicas` settings for the
destination index are copied from the source index. If there are multiple
source indices, the destination index copies the highest setting values. The
mappings for the destination index are also copied from the source indices.
If there are any mapping conflicts, the job fails to start.
If the destination index exists, it is used as is. You can therefore set up
the destination index in advance with custom settings and mappings. + /// + /// Starts a data frame analytics job. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// If the destination index does not exist, it is created automatically the + /// first time you start the data frame analytics job. The + /// index.number_of_shards and index.number_of_replicas settings for the + /// destination index are copied from the source index. If there are multiple + /// source indices, the destination index copies the highest setting values. The + /// mappings for the destination index are also copied from the source indices. + /// If there are any mapping conflicts, the job fails to start. + /// If the destination index exists, it is used as is. You can therefore set up + /// the destination index in advance with custom settings and mappings. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -7631,7 +11241,9 @@ public virtual Task StartDataFrameAnalyticsAsyn } /// - /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// + /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7642,7 +11254,9 @@ public virtual StartTrainedModelDeploymentResponse StartTrainedModelDeployment(S } /// - /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// + /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartTrainedModelDeploymentAsync(StartTrainedModelDeploymentRequest request, CancellationToken cancellationToken = default) @@ -7652,7 +11266,9 @@ public virtual Task StartTrainedModelDeploy } /// - /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// + /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7663,7 +11279,9 @@ public virtual StartTrainedModelDeploymentResponse StartTrainedModelDeployment(S } /// - /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// + /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7675,7 +11293,9 @@ public virtual StartTrainedModelDeploymentResponse StartTrainedModelDeployment(E } /// - /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// + /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7688,7 +11308,9 @@ public virtual StartTrainedModelDeploymentResponse StartTrainedModelDeployment(E } /// - /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// + /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartTrainedModelDeploymentAsync(StartTrainedModelDeploymentRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -7698,7 +11320,9 @@ public virtual Task StartTrainedModelDeploy } /// - /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// + /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartTrainedModelDeploymentAsync(Elastic.Clients.Elasticsearch.Id modelId, CancellationToken cancellationToken = default) @@ -7709,7 +11333,9 @@ public virtual Task StartTrainedModelDeploy } /// - /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// + /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartTrainedModelDeploymentAsync(Elastic.Clients.Elasticsearch.Id modelId, Action configureRequest, CancellationToken cancellationToken = default) @@ -7721,7 +11347,11 @@ public virtual Task StartTrainedModelDeploy } /// - /// Stops one or more datafeeds.
A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. + /// + /// Stops one or more datafeeds. + /// A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped + /// multiple times throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7732,7 +11362,11 @@ public virtual StopDatafeedResponse StopDatafeed(StopDatafeedRequest request) } /// - /// Stops one or more datafeeds.
A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. + /// + /// Stops one or more datafeeds. + /// A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped + /// multiple times throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopDatafeedAsync(StopDatafeedRequest request, CancellationToken cancellationToken = default) @@ -7742,7 +11376,11 @@ public virtual Task StopDatafeedAsync(StopDatafeedRequest } /// - /// Stops one or more datafeeds.
A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. + /// + /// Stops one or more datafeeds. + /// A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped + /// multiple times throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7753,7 +11391,11 @@ public virtual StopDatafeedResponse StopDatafeed(StopDatafeedRequestDescriptor d } /// - /// Stops one or more datafeeds.
A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. + /// + /// Stops one or more datafeeds. + /// A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped + /// multiple times throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7765,7 +11407,11 @@ public virtual StopDatafeedResponse StopDatafeed(Elastic.Clients.Elasticsearch.I } /// - /// Stops one or more datafeeds.
A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. + /// + /// Stops one or more datafeeds. + /// A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped + /// multiple times throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7778,7 +11424,11 @@ public virtual StopDatafeedResponse StopDatafeed(Elastic.Clients.Elasticsearch.I } /// - /// Stops one or more datafeeds.
A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. + /// + /// Stops one or more datafeeds. + /// A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped + /// multiple times throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopDatafeedAsync(StopDatafeedRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -7788,7 +11438,11 @@ public virtual Task StopDatafeedAsync(StopDatafeedRequestD } /// - /// Stops one or more datafeeds.
A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. + /// + /// Stops one or more datafeeds. + /// A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped + /// multiple times throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopDatafeedAsync(Elastic.Clients.Elasticsearch.Id datafeedId, CancellationToken cancellationToken = default) @@ -7799,7 +11453,11 @@ public virtual Task StopDatafeedAsync(Elastic.Clients.Elas } /// - /// Stops one or more datafeeds.
A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped
multiple times throughout its lifecycle. + /// + /// Stops one or more datafeeds. + /// A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped + /// multiple times throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopDatafeedAsync(Elastic.Clients.Elasticsearch.Id datafeedId, Action configureRequest, CancellationToken cancellationToken = default) @@ -7811,7 +11469,11 @@ public virtual Task StopDatafeedAsync(Elastic.Clients.Elas } /// - /// Stops one or more data frame analytics jobs.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle. + /// + /// Stops one or more data frame analytics jobs. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7822,7 +11484,11 @@ public virtual StopDataFrameAnalyticsResponse StopDataFrameAnalytics(StopDataFra } /// - /// Stops one or more data frame analytics jobs.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle. + /// + /// Stops one or more data frame analytics jobs. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopDataFrameAnalyticsAsync(StopDataFrameAnalyticsRequest request, CancellationToken cancellationToken = default) @@ -7832,7 +11498,11 @@ public virtual Task StopDataFrameAnalyticsAsync( } /// - /// Stops one or more data frame analytics jobs.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle. + /// + /// Stops one or more data frame analytics jobs. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7843,7 +11513,11 @@ public virtual StopDataFrameAnalyticsResponse StopDataFrameAnalytics( } /// - /// Stops one or more data frame analytics jobs.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle. + /// + /// Stops one or more data frame analytics jobs. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7855,7 +11529,11 @@ public virtual StopDataFrameAnalyticsResponse StopDataFrameAnalytics( } /// - /// Stops one or more data frame analytics jobs.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle. + /// + /// Stops one or more data frame analytics jobs. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7868,7 +11546,11 @@ public virtual StopDataFrameAnalyticsResponse StopDataFrameAnalytics( } /// - /// Stops one or more data frame analytics jobs.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle. + /// + /// Stops one or more data frame analytics jobs. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7879,7 +11561,11 @@ public virtual StopDataFrameAnalyticsResponse StopDataFrameAnalytics(StopDataFra } /// - /// Stops one or more data frame analytics jobs.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle. + /// + /// Stops one or more data frame analytics jobs. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7891,7 +11577,11 @@ public virtual StopDataFrameAnalyticsResponse StopDataFrameAnalytics(Elastic.Cli } /// - /// Stops one or more data frame analytics jobs.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle. + /// + /// Stops one or more data frame analytics jobs. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7904,7 +11594,11 @@ public virtual StopDataFrameAnalyticsResponse StopDataFrameAnalytics(Elastic.Cli } /// - /// Stops one or more data frame analytics jobs.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle. + /// + /// Stops one or more data frame analytics jobs. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopDataFrameAnalyticsAsync(StopDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -7914,7 +11608,11 @@ public virtual Task StopDataFrameAnalyticsAsync< } /// - /// Stops one or more data frame analytics jobs.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle. + /// + /// Stops one or more data frame analytics jobs. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -7925,7 +11623,11 @@ public virtual Task StopDataFrameAnalyticsAsync< } /// - /// Stops one or more data frame analytics jobs.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle. + /// + /// Stops one or more data frame analytics jobs. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -7937,7 +11639,11 @@ public virtual Task StopDataFrameAnalyticsAsync< } /// - /// Stops one or more data frame analytics jobs.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle. + /// + /// Stops one or more data frame analytics jobs. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopDataFrameAnalyticsAsync(StopDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -7947,7 +11653,11 @@ public virtual Task StopDataFrameAnalyticsAsync( } /// - /// Stops one or more data frame analytics jobs.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle. + /// + /// Stops one or more data frame analytics jobs. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -7958,7 +11668,11 @@ public virtual Task StopDataFrameAnalyticsAsync( } /// - /// Stops one or more data frame analytics jobs.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle. + /// + /// Stops one or more data frame analytics jobs. + /// A data frame analytics job can be started and stopped multiple times + /// throughout its lifecycle. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -7970,7 +11684,9 @@ public virtual Task StopDataFrameAnalyticsAsync( } /// - /// Stops a trained model deployment. + /// + /// Stops a trained model deployment. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7981,7 +11697,9 @@ public virtual StopTrainedModelDeploymentResponse StopTrainedModelDeployment(Sto } /// - /// Stops a trained model deployment. + /// + /// Stops a trained model deployment. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopTrainedModelDeploymentAsync(StopTrainedModelDeploymentRequest request, CancellationToken cancellationToken = default) @@ -7991,7 +11709,9 @@ public virtual Task StopTrainedModelDeployme } /// - /// Stops a trained model deployment. + /// + /// Stops a trained model deployment. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8002,7 +11722,9 @@ public virtual StopTrainedModelDeploymentResponse StopTrainedModelDeployment(Sto } /// - /// Stops a trained model deployment. + /// + /// Stops a trained model deployment. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8014,7 +11736,9 @@ public virtual StopTrainedModelDeploymentResponse StopTrainedModelDeployment(Ela } /// - /// Stops a trained model deployment. + /// + /// Stops a trained model deployment. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8027,7 +11751,9 @@ public virtual StopTrainedModelDeploymentResponse StopTrainedModelDeployment(Ela } /// - /// Stops a trained model deployment. + /// + /// Stops a trained model deployment. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopTrainedModelDeploymentAsync(StopTrainedModelDeploymentRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -8037,7 +11763,9 @@ public virtual Task StopTrainedModelDeployme } /// - /// Stops a trained model deployment. + /// + /// Stops a trained model deployment. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopTrainedModelDeploymentAsync(Elastic.Clients.Elasticsearch.Id modelId, CancellationToken cancellationToken = default) @@ -8048,7 +11776,9 @@ public virtual Task StopTrainedModelDeployme } /// - /// Stops a trained model deployment. + /// + /// Stops a trained model deployment. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopTrainedModelDeploymentAsync(Elastic.Clients.Elasticsearch.Id modelId, Action configureRequest, CancellationToken cancellationToken = default) @@ -8060,7 +11790,13 @@ public virtual Task StopTrainedModelDeployme } /// - /// Updates the properties of a datafeed.
You must stop and start the datafeed for the changes to be applied.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at
the time of the update and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead. + /// + /// Updates the properties of a datafeed. + /// You must stop and start the datafeed for the changes to be applied. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at + /// the time of the update and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8071,7 +11807,13 @@ public virtual UpdateDatafeedResponse UpdateDatafeed(UpdateDatafeedRequest reque } /// - /// Updates the properties of a datafeed.
You must stop and start the datafeed for the changes to be applied.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at
the time of the update and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead. + /// + /// Updates the properties of a datafeed. + /// You must stop and start the datafeed for the changes to be applied. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at + /// the time of the update and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateDatafeedAsync(UpdateDatafeedRequest request, CancellationToken cancellationToken = default) @@ -8081,7 +11823,13 @@ public virtual Task UpdateDatafeedAsync(UpdateDatafeedRe } /// - /// Updates the properties of a datafeed.
You must stop and start the datafeed for the changes to be applied.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at
the time of the update and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead. + /// + /// Updates the properties of a datafeed. + /// You must stop and start the datafeed for the changes to be applied. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at + /// the time of the update and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8092,7 +11840,13 @@ public virtual UpdateDatafeedResponse UpdateDatafeed(UpdateDatafeedRe } /// - /// Updates the properties of a datafeed.
You must stop and start the datafeed for the changes to be applied.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at
the time of the update and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead. + /// + /// Updates the properties of a datafeed. + /// You must stop and start the datafeed for the changes to be applied. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at + /// the time of the update and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8104,7 +11858,13 @@ public virtual UpdateDatafeedResponse UpdateDatafeed(Elastic.Clients. } /// - /// Updates the properties of a datafeed.
You must stop and start the datafeed for the changes to be applied.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at
the time of the update and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead. + /// + /// Updates the properties of a datafeed. + /// You must stop and start the datafeed for the changes to be applied. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at + /// the time of the update and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8117,7 +11877,13 @@ public virtual UpdateDatafeedResponse UpdateDatafeed(Elastic.Clients. } /// - /// Updates the properties of a datafeed.
You must stop and start the datafeed for the changes to be applied.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at
the time of the update and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead. + /// + /// Updates the properties of a datafeed. + /// You must stop and start the datafeed for the changes to be applied. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at + /// the time of the update and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8128,7 +11894,13 @@ public virtual UpdateDatafeedResponse UpdateDatafeed(UpdateDatafeedRequestDescri } /// - /// Updates the properties of a datafeed.
You must stop and start the datafeed for the changes to be applied.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at
the time of the update and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead. + /// + /// Updates the properties of a datafeed. + /// You must stop and start the datafeed for the changes to be applied. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at + /// the time of the update and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8140,7 +11912,13 @@ public virtual UpdateDatafeedResponse UpdateDatafeed(Elastic.Clients.Elasticsear } /// - /// Updates the properties of a datafeed.
You must stop and start the datafeed for the changes to be applied.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at
the time of the update and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead. + /// + /// Updates the properties of a datafeed. + /// You must stop and start the datafeed for the changes to be applied. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at + /// the time of the update and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8153,7 +11931,13 @@ public virtual UpdateDatafeedResponse UpdateDatafeed(Elastic.Clients.Elasticsear } /// - /// Updates the properties of a datafeed.
You must stop and start the datafeed for the changes to be applied.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at
the time of the update and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead. + /// + /// Updates the properties of a datafeed. + /// You must stop and start the datafeed for the changes to be applied. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at + /// the time of the update and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateDatafeedAsync(UpdateDatafeedRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -8163,7 +11947,13 @@ public virtual Task UpdateDatafeedAsync(Updat } /// - /// Updates the properties of a datafeed.
You must stop and start the datafeed for the changes to be applied.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at
the time of the update and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead. + /// + /// Updates the properties of a datafeed. + /// You must stop and start the datafeed for the changes to be applied. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at + /// the time of the update and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateDatafeedAsync(Elastic.Clients.Elasticsearch.Id datafeedId, CancellationToken cancellationToken = default) @@ -8174,7 +11964,13 @@ public virtual Task UpdateDatafeedAsync(Elast } /// - /// Updates the properties of a datafeed.
You must stop and start the datafeed for the changes to be applied.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at
the time of the update and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead. + /// + /// Updates the properties of a datafeed. + /// You must stop and start the datafeed for the changes to be applied. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at + /// the time of the update and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateDatafeedAsync(Elastic.Clients.Elasticsearch.Id datafeedId, Action> configureRequest, CancellationToken cancellationToken = default) @@ -8186,7 +11982,13 @@ public virtual Task UpdateDatafeedAsync(Elast } /// - /// Updates the properties of a datafeed.
You must stop and start the datafeed for the changes to be applied.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at
the time of the update and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead. + /// + /// Updates the properties of a datafeed. + /// You must stop and start the datafeed for the changes to be applied. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at + /// the time of the update and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateDatafeedAsync(UpdateDatafeedRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -8196,7 +11998,13 @@ public virtual Task UpdateDatafeedAsync(UpdateDatafeedRe } /// - /// Updates the properties of a datafeed.
You must stop and start the datafeed for the changes to be applied.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at
the time of the update and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead. + /// + /// Updates the properties of a datafeed. + /// You must stop and start the datafeed for the changes to be applied. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at + /// the time of the update and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateDatafeedAsync(Elastic.Clients.Elasticsearch.Id datafeedId, CancellationToken cancellationToken = default) @@ -8207,7 +12015,13 @@ public virtual Task UpdateDatafeedAsync(Elastic.Clients. } /// - /// Updates the properties of a datafeed.
You must stop and start the datafeed for the changes to be applied.
When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at
the time of the update and runs the query using those same roles. If you provide secondary authorization headers,
those credentials are used instead. + /// + /// Updates the properties of a datafeed. + /// You must stop and start the datafeed for the changes to be applied. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at + /// the time of the update and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateDatafeedAsync(Elastic.Clients.Elasticsearch.Id datafeedId, Action configureRequest, CancellationToken cancellationToken = default) @@ -8219,7 +12033,9 @@ public virtual Task UpdateDatafeedAsync(Elastic.Clients. } /// - /// Updates an existing data frame analytics job. + /// + /// Updates an existing data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8230,7 +12046,9 @@ public virtual UpdateDataFrameAnalyticsResponse UpdateDataFrameAnalytics(UpdateD } /// - /// Updates an existing data frame analytics job. + /// + /// Updates an existing data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateDataFrameAnalyticsAsync(UpdateDataFrameAnalyticsRequest request, CancellationToken cancellationToken = default) @@ -8240,7 +12058,9 @@ public virtual Task UpdateDataFrameAnalyticsAs } /// - /// Updates an existing data frame analytics job. + /// + /// Updates an existing data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8251,7 +12071,9 @@ public virtual UpdateDataFrameAnalyticsResponse UpdateDataFrameAnalytics - /// Updates an existing data frame analytics job. + /// + /// Updates an existing data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8263,7 +12085,9 @@ public virtual UpdateDataFrameAnalyticsResponse UpdateDataFrameAnalytics - /// Updates an existing data frame analytics job. + /// + /// Updates an existing data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8276,7 +12100,9 @@ public virtual UpdateDataFrameAnalyticsResponse UpdateDataFrameAnalytics - /// Updates an existing data frame analytics job. + /// + /// Updates an existing data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8287,7 +12113,9 @@ public virtual UpdateDataFrameAnalyticsResponse UpdateDataFrameAnalytics(UpdateD } /// - /// Updates an existing data frame analytics job. + /// + /// Updates an existing data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8299,7 +12127,9 @@ public virtual UpdateDataFrameAnalyticsResponse UpdateDataFrameAnalytics(Elastic } /// - /// Updates an existing data frame analytics job. + /// + /// Updates an existing data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8312,7 +12142,9 @@ public virtual UpdateDataFrameAnalyticsResponse UpdateDataFrameAnalytics(Elastic } /// - /// Updates an existing data frame analytics job. + /// + /// Updates an existing data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateDataFrameAnalyticsAsync(UpdateDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -8322,7 +12154,9 @@ public virtual Task UpdateDataFrameAnalyticsAs } /// - /// Updates an existing data frame analytics job. + /// + /// Updates an existing data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -8333,7 +12167,9 @@ public virtual Task UpdateDataFrameAnalyticsAs } /// - /// Updates an existing data frame analytics job. + /// + /// Updates an existing data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -8345,7 +12181,9 @@ public virtual Task UpdateDataFrameAnalyticsAs } /// - /// Updates an existing data frame analytics job. + /// + /// Updates an existing data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateDataFrameAnalyticsAsync(UpdateDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -8355,7 +12193,9 @@ public virtual Task UpdateDataFrameAnalyticsAs } /// - /// Updates an existing data frame analytics job. + /// + /// Updates an existing data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -8366,7 +12206,9 @@ public virtual Task UpdateDataFrameAnalyticsAs } /// - /// Updates an existing data frame analytics job. + /// + /// Updates an existing data frame analytics job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -8378,7 +12220,9 @@ public virtual Task UpdateDataFrameAnalyticsAs } /// - /// Updates the description of a filter, adds items, or removes items from the list. + /// + /// Updates the description of a filter, adds items, or removes items from the list. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8389,7 +12233,9 @@ public virtual UpdateFilterResponse UpdateFilter(UpdateFilterRequest request) } /// - /// Updates the description of a filter, adds items, or removes items from the list. + /// + /// Updates the description of a filter, adds items, or removes items from the list. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateFilterAsync(UpdateFilterRequest request, CancellationToken cancellationToken = default) @@ -8399,7 +12245,9 @@ public virtual Task UpdateFilterAsync(UpdateFilterRequest } /// - /// Updates the description of a filter, adds items, or removes items from the list. + /// + /// Updates the description of a filter, adds items, or removes items from the list. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8410,7 +12258,9 @@ public virtual UpdateFilterResponse UpdateFilter(UpdateFilterRequestDescriptor d } /// - /// Updates the description of a filter, adds items, or removes items from the list. + /// + /// Updates the description of a filter, adds items, or removes items from the list. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8422,7 +12272,9 @@ public virtual UpdateFilterResponse UpdateFilter(Elastic.Clients.Elasticsearch.I } /// - /// Updates the description of a filter, adds items, or removes items from the list. + /// + /// Updates the description of a filter, adds items, or removes items from the list. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8435,7 +12287,9 @@ public virtual UpdateFilterResponse UpdateFilter(Elastic.Clients.Elasticsearch.I } /// - /// Updates the description of a filter, adds items, or removes items from the list. + /// + /// Updates the description of a filter, adds items, or removes items from the list. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateFilterAsync(UpdateFilterRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -8445,7 +12299,9 @@ public virtual Task UpdateFilterAsync(UpdateFilterRequestD } /// - /// Updates the description of a filter, adds items, or removes items from the list. + /// + /// Updates the description of a filter, adds items, or removes items from the list. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateFilterAsync(Elastic.Clients.Elasticsearch.Id filterId, CancellationToken cancellationToken = default) @@ -8456,7 +12312,9 @@ public virtual Task UpdateFilterAsync(Elastic.Clients.Elas } /// - /// Updates the description of a filter, adds items, or removes items from the list. + /// + /// Updates the description of a filter, adds items, or removes items from the list. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateFilterAsync(Elastic.Clients.Elasticsearch.Id filterId, Action configureRequest, CancellationToken cancellationToken = default) @@ -8468,7 +12326,9 @@ public virtual Task UpdateFilterAsync(Elastic.Clients.Elas } /// - /// Updates certain properties of an anomaly detection job. + /// + /// Updates certain properties of an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8479,7 +12339,9 @@ public virtual UpdateJobResponse UpdateJob(UpdateJobRequest request) } /// - /// Updates certain properties of an anomaly detection job. + /// + /// Updates certain properties of an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateJobAsync(UpdateJobRequest request, CancellationToken cancellationToken = default) @@ -8489,7 +12351,9 @@ public virtual Task UpdateJobAsync(UpdateJobRequest request, } /// - /// Updates certain properties of an anomaly detection job. + /// + /// Updates certain properties of an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8500,7 +12364,9 @@ public virtual UpdateJobResponse UpdateJob(UpdateJobRequestDescriptor } /// - /// Updates certain properties of an anomaly detection job. + /// + /// Updates certain properties of an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8512,7 +12378,9 @@ public virtual UpdateJobResponse UpdateJob(Elastic.Clients.Elasticsea } /// - /// Updates certain properties of an anomaly detection job. + /// + /// Updates certain properties of an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8525,7 +12393,9 @@ public virtual UpdateJobResponse UpdateJob(Elastic.Clients.Elasticsea } /// - /// Updates certain properties of an anomaly detection job. + /// + /// Updates certain properties of an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8536,7 +12406,9 @@ public virtual UpdateJobResponse UpdateJob(UpdateJobRequestDescriptor descriptor } /// - /// Updates certain properties of an anomaly detection job. + /// + /// Updates certain properties of an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8548,7 +12420,9 @@ public virtual UpdateJobResponse UpdateJob(Elastic.Clients.Elasticsearch.Id jobI } /// - /// Updates certain properties of an anomaly detection job. + /// + /// Updates certain properties of an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8561,7 +12435,9 @@ public virtual UpdateJobResponse UpdateJob(Elastic.Clients.Elasticsearch.Id jobI } /// - /// Updates certain properties of an anomaly detection job. + /// + /// Updates certain properties of an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateJobAsync(UpdateJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -8571,7 +12447,9 @@ public virtual Task UpdateJobAsync(UpdateJobReques } /// - /// Updates certain properties of an anomaly detection job. + /// + /// Updates certain properties of an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateJobAsync(Elastic.Clients.Elasticsearch.Id jobId, CancellationToken cancellationToken = default) @@ -8582,7 +12460,9 @@ public virtual Task UpdateJobAsync(Elastic.Clients } /// - /// Updates certain properties of an anomaly detection job. + /// + /// Updates certain properties of an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateJobAsync(Elastic.Clients.Elasticsearch.Id jobId, Action> configureRequest, CancellationToken cancellationToken = default) @@ -8594,7 +12474,9 @@ public virtual Task UpdateJobAsync(Elastic.Clients } /// - /// Updates certain properties of an anomaly detection job. + /// + /// Updates certain properties of an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateJobAsync(UpdateJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -8604,7 +12486,9 @@ public virtual Task UpdateJobAsync(UpdateJobRequestDescriptor } /// - /// Updates certain properties of an anomaly detection job. + /// + /// Updates certain properties of an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateJobAsync(Elastic.Clients.Elasticsearch.Id jobId, CancellationToken cancellationToken = default) @@ -8615,7 +12499,9 @@ public virtual Task UpdateJobAsync(Elastic.Clients.Elasticsea } /// - /// Updates certain properties of an anomaly detection job. + /// + /// Updates certain properties of an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateJobAsync(Elastic.Clients.Elasticsearch.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) @@ -8627,7 +12513,9 @@ public virtual Task UpdateJobAsync(Elastic.Clients.Elasticsea } /// - /// Updates certain properties of a snapshot. + /// + /// Updates certain properties of a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8638,7 +12526,9 @@ public virtual UpdateModelSnapshotResponse UpdateModelSnapshot(UpdateModelSnapsh } /// - /// Updates certain properties of a snapshot. + /// + /// Updates certain properties of a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateModelSnapshotAsync(UpdateModelSnapshotRequest request, CancellationToken cancellationToken = default) @@ -8648,7 +12538,9 @@ public virtual Task UpdateModelSnapshotAsync(Update } /// - /// Updates certain properties of a snapshot. + /// + /// Updates certain properties of a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8659,7 +12551,9 @@ public virtual UpdateModelSnapshotResponse UpdateModelSnapshot(UpdateModelSnapsh } /// - /// Updates certain properties of a snapshot. + /// + /// Updates certain properties of a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8671,7 +12565,9 @@ public virtual UpdateModelSnapshotResponse UpdateModelSnapshot(Elastic.Clients.E } /// - /// Updates certain properties of a snapshot. + /// + /// Updates certain properties of a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8684,7 +12580,9 @@ public virtual UpdateModelSnapshotResponse UpdateModelSnapshot(Elastic.Clients.E } /// - /// Updates certain properties of a snapshot. + /// + /// Updates certain properties of a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateModelSnapshotAsync(UpdateModelSnapshotRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -8694,7 +12592,9 @@ public virtual Task UpdateModelSnapshotAsync(Update } /// - /// Updates certain properties of a snapshot. + /// + /// Updates certain properties of a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateModelSnapshotAsync(Elastic.Clients.Elasticsearch.Id jobId, Elastic.Clients.Elasticsearch.Id snapshotId, CancellationToken cancellationToken = default) @@ -8705,7 +12605,9 @@ public virtual Task UpdateModelSnapshotAsync(Elasti } /// - /// Updates certain properties of a snapshot. + /// + /// Updates certain properties of a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateModelSnapshotAsync(Elastic.Clients.Elasticsearch.Id jobId, Elastic.Clients.Elasticsearch.Id snapshotId, Action configureRequest, CancellationToken cancellationToken = default) @@ -8717,7 +12619,9 @@ public virtual Task UpdateModelSnapshotAsync(Elasti } /// - /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// + /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8728,7 +12632,9 @@ public virtual UpdateTrainedModelDeploymentResponse UpdateTrainedModelDeployment } /// - /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// + /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateTrainedModelDeploymentAsync(UpdateTrainedModelDeploymentRequest request, CancellationToken cancellationToken = default) @@ -8738,7 +12644,9 @@ public virtual Task UpdateTrainedModelDepl } /// - /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// + /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8749,7 +12657,9 @@ public virtual UpdateTrainedModelDeploymentResponse UpdateTrainedModelDeployment } /// - /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// + /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8761,7 +12671,9 @@ public virtual UpdateTrainedModelDeploymentResponse UpdateTrainedModelDeployment } /// - /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// + /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8774,7 +12686,9 @@ public virtual UpdateTrainedModelDeploymentResponse UpdateTrainedModelDeployment } /// - /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// + /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateTrainedModelDeploymentAsync(UpdateTrainedModelDeploymentRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -8784,7 +12698,9 @@ public virtual Task UpdateTrainedModelDepl } /// - /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// + /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateTrainedModelDeploymentAsync(Elastic.Clients.Elasticsearch.Id modelId, CancellationToken cancellationToken = default) @@ -8795,7 +12711,9 @@ public virtual Task UpdateTrainedModelDepl } /// - /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// + /// Starts a trained model deployment, which allocates the model to every machine learning node. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateTrainedModelDeploymentAsync(Elastic.Clients.Elasticsearch.Id modelId, Action configureRequest, CancellationToken cancellationToken = default) @@ -8807,7 +12725,17 @@ public virtual Task UpdateTrainedModelDepl } /// - /// Upgrades an anomaly detection model snapshot to the latest major version.
Over time, older snapshot formats are deprecated and removed. Anomaly
detection jobs support only snapshots that are from the current or previous
major version.
This API provides a means to upgrade a snapshot to the current major version.
This aids in preparing the cluster for an upgrade to the next major version.
Only one snapshot per anomaly detection job can be upgraded at a time and the
upgraded snapshot cannot be the current snapshot of the anomaly detection
job. + /// + /// Upgrades an anomaly detection model snapshot to the latest major version. + /// Over time, older snapshot formats are deprecated and removed. Anomaly + /// detection jobs support only snapshots that are from the current or previous + /// major version. + /// This API provides a means to upgrade a snapshot to the current major version. + /// This aids in preparing the cluster for an upgrade to the next major version. + /// Only one snapshot per anomaly detection job can be upgraded at a time and the + /// upgraded snapshot cannot be the current snapshot of the anomaly detection + /// job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8818,7 +12746,17 @@ public virtual UpgradeJobSnapshotResponse UpgradeJobSnapshot(UpgradeJobSnapshotR } /// - /// Upgrades an anomaly detection model snapshot to the latest major version.
Over time, older snapshot formats are deprecated and removed. Anomaly
detection jobs support only snapshots that are from the current or previous
major version.
This API provides a means to upgrade a snapshot to the current major version.
This aids in preparing the cluster for an upgrade to the next major version.
Only one snapshot per anomaly detection job can be upgraded at a time and the
upgraded snapshot cannot be the current snapshot of the anomaly detection
job. + /// + /// Upgrades an anomaly detection model snapshot to the latest major version. + /// Over time, older snapshot formats are deprecated and removed. Anomaly + /// detection jobs support only snapshots that are from the current or previous + /// major version. + /// This API provides a means to upgrade a snapshot to the current major version. + /// This aids in preparing the cluster for an upgrade to the next major version. + /// Only one snapshot per anomaly detection job can be upgraded at a time and the + /// upgraded snapshot cannot be the current snapshot of the anomaly detection + /// job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpgradeJobSnapshotAsync(UpgradeJobSnapshotRequest request, CancellationToken cancellationToken = default) @@ -8828,7 +12766,17 @@ public virtual Task UpgradeJobSnapshotAsync(UpgradeJ } /// - /// Upgrades an anomaly detection model snapshot to the latest major version.
Over time, older snapshot formats are deprecated and removed. Anomaly
detection jobs support only snapshots that are from the current or previous
major version.
This API provides a means to upgrade a snapshot to the current major version.
This aids in preparing the cluster for an upgrade to the next major version.
Only one snapshot per anomaly detection job can be upgraded at a time and the
upgraded snapshot cannot be the current snapshot of the anomaly detection
job. + /// + /// Upgrades an anomaly detection model snapshot to the latest major version. + /// Over time, older snapshot formats are deprecated and removed. Anomaly + /// detection jobs support only snapshots that are from the current or previous + /// major version. + /// This API provides a means to upgrade a snapshot to the current major version. + /// This aids in preparing the cluster for an upgrade to the next major version. + /// Only one snapshot per anomaly detection job can be upgraded at a time and the + /// upgraded snapshot cannot be the current snapshot of the anomaly detection + /// job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8839,7 +12787,17 @@ public virtual UpgradeJobSnapshotResponse UpgradeJobSnapshot(UpgradeJobSnapshotR } /// - /// Upgrades an anomaly detection model snapshot to the latest major version.
Over time, older snapshot formats are deprecated and removed. Anomaly
detection jobs support only snapshots that are from the current or previous
major version.
This API provides a means to upgrade a snapshot to the current major version.
This aids in preparing the cluster for an upgrade to the next major version.
Only one snapshot per anomaly detection job can be upgraded at a time and the
upgraded snapshot cannot be the current snapshot of the anomaly detection
job. + /// + /// Upgrades an anomaly detection model snapshot to the latest major version. + /// Over time, older snapshot formats are deprecated and removed. Anomaly + /// detection jobs support only snapshots that are from the current or previous + /// major version. + /// This API provides a means to upgrade a snapshot to the current major version. + /// This aids in preparing the cluster for an upgrade to the next major version. + /// Only one snapshot per anomaly detection job can be upgraded at a time and the + /// upgraded snapshot cannot be the current snapshot of the anomaly detection + /// job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8851,7 +12809,17 @@ public virtual UpgradeJobSnapshotResponse UpgradeJobSnapshot(Elastic.Clients.Ela } /// - /// Upgrades an anomaly detection model snapshot to the latest major version.
Over time, older snapshot formats are deprecated and removed. Anomaly
detection jobs support only snapshots that are from the current or previous
major version.
This API provides a means to upgrade a snapshot to the current major version.
This aids in preparing the cluster for an upgrade to the next major version.
Only one snapshot per anomaly detection job can be upgraded at a time and the
upgraded snapshot cannot be the current snapshot of the anomaly detection
job. + /// + /// Upgrades an anomaly detection model snapshot to the latest major version. + /// Over time, older snapshot formats are deprecated and removed. Anomaly + /// detection jobs support only snapshots that are from the current or previous + /// major version. + /// This API provides a means to upgrade a snapshot to the current major version. + /// This aids in preparing the cluster for an upgrade to the next major version. + /// Only one snapshot per anomaly detection job can be upgraded at a time and the + /// upgraded snapshot cannot be the current snapshot of the anomaly detection + /// job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8864,7 +12832,17 @@ public virtual UpgradeJobSnapshotResponse UpgradeJobSnapshot(Elastic.Clients.Ela } /// - /// Upgrades an anomaly detection model snapshot to the latest major version.
Over time, older snapshot formats are deprecated and removed. Anomaly
detection jobs support only snapshots that are from the current or previous
major version.
This API provides a means to upgrade a snapshot to the current major version.
This aids in preparing the cluster for an upgrade to the next major version.
Only one snapshot per anomaly detection job can be upgraded at a time and the
upgraded snapshot cannot be the current snapshot of the anomaly detection
job. + /// + /// Upgrades an anomaly detection model snapshot to the latest major version. + /// Over time, older snapshot formats are deprecated and removed. Anomaly + /// detection jobs support only snapshots that are from the current or previous + /// major version. + /// This API provides a means to upgrade a snapshot to the current major version. + /// This aids in preparing the cluster for an upgrade to the next major version. + /// Only one snapshot per anomaly detection job can be upgraded at a time and the + /// upgraded snapshot cannot be the current snapshot of the anomaly detection + /// job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpgradeJobSnapshotAsync(UpgradeJobSnapshotRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -8874,7 +12852,17 @@ public virtual Task UpgradeJobSnapshotAsync(UpgradeJ } /// - /// Upgrades an anomaly detection model snapshot to the latest major version.
Over time, older snapshot formats are deprecated and removed. Anomaly
detection jobs support only snapshots that are from the current or previous
major version.
This API provides a means to upgrade a snapshot to the current major version.
This aids in preparing the cluster for an upgrade to the next major version.
Only one snapshot per anomaly detection job can be upgraded at a time and the
upgraded snapshot cannot be the current snapshot of the anomaly detection
job. + /// + /// Upgrades an anomaly detection model snapshot to the latest major version. + /// Over time, older snapshot formats are deprecated and removed. Anomaly + /// detection jobs support only snapshots that are from the current or previous + /// major version. + /// This API provides a means to upgrade a snapshot to the current major version. + /// This aids in preparing the cluster for an upgrade to the next major version. + /// Only one snapshot per anomaly detection job can be upgraded at a time and the + /// upgraded snapshot cannot be the current snapshot of the anomaly detection + /// job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpgradeJobSnapshotAsync(Elastic.Clients.Elasticsearch.Id jobId, Elastic.Clients.Elasticsearch.Id snapshotId, CancellationToken cancellationToken = default) @@ -8885,7 +12873,17 @@ public virtual Task UpgradeJobSnapshotAsync(Elastic. } /// - /// Upgrades an anomaly detection model snapshot to the latest major version.
Over time, older snapshot formats are deprecated and removed. Anomaly
detection jobs support only snapshots that are from the current or previous
major version.
This API provides a means to upgrade a snapshot to the current major version.
This aids in preparing the cluster for an upgrade to the next major version.
Only one snapshot per anomaly detection job can be upgraded at a time and the
upgraded snapshot cannot be the current snapshot of the anomaly detection
job. + /// + /// Upgrades an anomaly detection model snapshot to the latest major version. + /// Over time, older snapshot formats are deprecated and removed. Anomaly + /// detection jobs support only snapshots that are from the current or previous + /// major version. + /// This API provides a means to upgrade a snapshot to the current major version. + /// This aids in preparing the cluster for an upgrade to the next major version. + /// Only one snapshot per anomaly detection job can be upgraded at a time and the + /// upgraded snapshot cannot be the current snapshot of the anomaly detection + /// job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpgradeJobSnapshotAsync(Elastic.Clients.Elasticsearch.Id jobId, Elastic.Clients.Elasticsearch.Id snapshotId, Action configureRequest, CancellationToken cancellationToken = default) @@ -8897,7 +12895,9 @@ public virtual Task UpgradeJobSnapshotAsync(Elastic. } /// - /// Validates an anomaly detection job. + /// + /// Validates an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8908,7 +12908,9 @@ public virtual ValidateResponse Validate(ValidateRequest request) } /// - /// Validates an anomaly detection job. + /// + /// Validates an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateAsync(ValidateRequest request, CancellationToken cancellationToken = default) @@ -8918,7 +12920,9 @@ public virtual Task ValidateAsync(ValidateRequest request, Can } /// - /// Validates an anomaly detection job. + /// + /// Validates an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8929,7 +12933,9 @@ public virtual ValidateResponse Validate(ValidateRequestDescriptor - /// Validates an anomaly detection job. + /// + /// Validates an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8941,7 +12947,9 @@ public virtual ValidateResponse Validate() } /// - /// Validates an anomaly detection job. + /// + /// Validates an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8954,7 +12962,9 @@ public virtual ValidateResponse Validate(Action - /// Validates an anomaly detection job. + /// + /// Validates an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8965,7 +12975,9 @@ public virtual ValidateResponse Validate(ValidateRequestDescriptor descriptor) } /// - /// Validates an anomaly detection job. + /// + /// Validates an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8977,7 +12989,9 @@ public virtual ValidateResponse Validate() } /// - /// Validates an anomaly detection job. + /// + /// Validates an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8990,7 +13004,9 @@ public virtual ValidateResponse Validate(Action confi } /// - /// Validates an anomaly detection job. + /// + /// Validates an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateAsync(ValidateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -9000,7 +13016,9 @@ public virtual Task ValidateAsync(ValidateRequestDe } /// - /// Validates an anomaly detection job. + /// + /// Validates an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateAsync(CancellationToken cancellationToken = default) @@ -9011,7 +13029,9 @@ public virtual Task ValidateAsync(CancellationToken } /// - /// Validates an anomaly detection job. + /// + /// Validates an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -9023,7 +13043,9 @@ public virtual Task ValidateAsync(Action - /// Validates an anomaly detection job. + /// + /// Validates an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateAsync(ValidateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -9033,7 +13055,9 @@ public virtual Task ValidateAsync(ValidateRequestDescriptor de } /// - /// Validates an anomaly detection job. + /// + /// Validates an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateAsync(CancellationToken cancellationToken = default) @@ -9044,7 +13068,9 @@ public virtual Task ValidateAsync(CancellationToken cancellati } /// - /// Validates an anomaly detection job. + /// + /// Validates an anomaly detection job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -9056,7 +13082,9 @@ public virtual Task ValidateAsync(Action - /// Validates an anomaly detection detector. + /// + /// Validates an anomaly detection detector. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9067,7 +13095,9 @@ public virtual ValidateDetectorResponse ValidateDetector(ValidateDetectorRequest } /// - /// Validates an anomaly detection detector. + /// + /// Validates an anomaly detection detector. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateDetectorAsync(ValidateDetectorRequest request, CancellationToken cancellationToken = default) @@ -9077,7 +13107,9 @@ public virtual Task ValidateDetectorAsync(ValidateDete } /// - /// Validates an anomaly detection detector. + /// + /// Validates an anomaly detection detector. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9088,7 +13120,9 @@ public virtual ValidateDetectorResponse ValidateDetector(ValidateDete } /// - /// Validates an anomaly detection detector. + /// + /// Validates an anomaly detection detector. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9100,7 +13134,9 @@ public virtual ValidateDetectorResponse ValidateDetector(Elastic.Clie } /// - /// Validates an anomaly detection detector. + /// + /// Validates an anomaly detection detector. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9113,7 +13149,9 @@ public virtual ValidateDetectorResponse ValidateDetector(Elastic.Clie } /// - /// Validates an anomaly detection detector. + /// + /// Validates an anomaly detection detector. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9124,7 +13162,9 @@ public virtual ValidateDetectorResponse ValidateDetector(ValidateDetectorRequest } /// - /// Validates an anomaly detection detector. + /// + /// Validates an anomaly detection detector. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9136,7 +13176,9 @@ public virtual ValidateDetectorResponse ValidateDetector(Elastic.Clients.Elastic } /// - /// Validates an anomaly detection detector. + /// + /// Validates an anomaly detection detector. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -9149,7 +13191,9 @@ public virtual ValidateDetectorResponse ValidateDetector(Elastic.Clients.Elastic } /// - /// Validates an anomaly detection detector. + /// + /// Validates an anomaly detection detector. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateDetectorAsync(ValidateDetectorRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -9159,7 +13203,9 @@ public virtual Task ValidateDetectorAsync(V } /// - /// Validates an anomaly detection detector. + /// + /// Validates an anomaly detection detector. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateDetectorAsync(Elastic.Clients.Elasticsearch.MachineLearning.Detector detector, CancellationToken cancellationToken = default) @@ -9170,7 +13216,9 @@ public virtual Task ValidateDetectorAsync(E } /// - /// Validates an anomaly detection detector. + /// + /// Validates an anomaly detection detector. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateDetectorAsync(Elastic.Clients.Elasticsearch.MachineLearning.Detector detector, Action> configureRequest, CancellationToken cancellationToken = default) @@ -9182,7 +13230,9 @@ public virtual Task ValidateDetectorAsync(E } /// - /// Validates an anomaly detection detector. + /// + /// Validates an anomaly detection detector. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateDetectorAsync(ValidateDetectorRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -9192,7 +13242,9 @@ public virtual Task ValidateDetectorAsync(ValidateDete } /// - /// Validates an anomaly detection detector. + /// + /// Validates an anomaly detection detector. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateDetectorAsync(Elastic.Clients.Elasticsearch.MachineLearning.Detector detector, CancellationToken cancellationToken = default) @@ -9203,7 +13255,9 @@ public virtual Task ValidateDetectorAsync(Elastic.Clie } /// - /// Validates an anomaly detection detector. + /// + /// Validates an anomaly detection detector. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ValidateDetectorAsync(Elastic.Clients.Elasticsearch.MachineLearning.Detector detector, Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Nodes.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Nodes.g.cs index d206a9559d8..4b2fa88c489 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Nodes.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Nodes.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public partial class NodesNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected NodesNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal NodesNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// You can use this API to clear the archived repositories metering information in the cluster. + /// + /// You can use this API to clear the archived repositories metering information in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -49,7 +53,9 @@ public virtual ClearRepositoriesMeteringArchiveResponse ClearRepositoriesMeterin } /// - /// You can use this API to clear the archived repositories metering information in the cluster. + /// + /// You can use this API to clear the archived repositories metering information in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearRepositoriesMeteringArchiveAsync(ClearRepositoriesMeteringArchiveRequest request, CancellationToken cancellationToken = default) @@ -59,7 +65,9 @@ public virtual Task ClearRepositoriesM } /// - /// You can use this API to clear the archived repositories metering information in the cluster. + /// + /// You can use this API to clear the archived repositories metering information in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -70,7 +78,9 @@ public virtual ClearRepositoriesMeteringArchiveResponse ClearRepositoriesMeterin } /// - /// You can use this API to clear the archived repositories metering information in the cluster. + /// + /// You can use this API to clear the archived repositories metering information in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -82,7 +92,9 @@ public virtual ClearRepositoriesMeteringArchiveResponse ClearRepositoriesMeterin } /// - /// You can use this API to clear the archived repositories metering information in the cluster. + /// + /// You can use this API to clear the archived repositories metering information in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -95,7 +107,9 @@ public virtual ClearRepositoriesMeteringArchiveResponse ClearRepositoriesMeterin } /// - /// You can use this API to clear the archived repositories metering information in the cluster. + /// + /// You can use this API to clear the archived repositories metering information in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearRepositoriesMeteringArchiveAsync(ClearRepositoriesMeteringArchiveRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -105,7 +119,9 @@ public virtual Task ClearRepositoriesM } /// - /// You can use this API to clear the archived repositories metering information in the cluster. + /// + /// You can use this API to clear the archived repositories metering information in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearRepositoriesMeteringArchiveAsync(Elastic.Clients.Elasticsearch.NodeIds nodeId, long maxArchiveVersion, CancellationToken cancellationToken = default) @@ -116,7 +132,9 @@ public virtual Task ClearRepositoriesM } /// - /// You can use this API to clear the archived repositories metering information in the cluster. + /// + /// You can use this API to clear the archived repositories metering information in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearRepositoriesMeteringArchiveAsync(Elastic.Clients.Elasticsearch.NodeIds nodeId, long maxArchiveVersion, Action configureRequest, CancellationToken cancellationToken = default) @@ -128,7 +146,12 @@ public virtual Task ClearRepositoriesM } /// - /// You can use the cluster repositories metering API to retrieve repositories metering information in a cluster.
This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the
information needed to compute aggregations over a period of time. Additionally, the information exposed by this
API is volatile, meaning that it won’t be present after node restarts. + /// + /// You can use the cluster repositories metering API to retrieve repositories metering information in a cluster. + /// This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the + /// information needed to compute aggregations over a period of time. Additionally, the information exposed by this + /// API is volatile, meaning that it won’t be present after node restarts. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -139,7 +162,12 @@ public virtual GetRepositoriesMeteringInfoResponse GetRepositoriesMeteringInfo(G } /// - /// You can use the cluster repositories metering API to retrieve repositories metering information in a cluster.
This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the
information needed to compute aggregations over a period of time. Additionally, the information exposed by this
API is volatile, meaning that it won’t be present after node restarts. + /// + /// You can use the cluster repositories metering API to retrieve repositories metering information in a cluster. + /// This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the + /// information needed to compute aggregations over a period of time. Additionally, the information exposed by this + /// API is volatile, meaning that it won’t be present after node restarts. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRepositoriesMeteringInfoAsync(GetRepositoriesMeteringInfoRequest request, CancellationToken cancellationToken = default) @@ -149,7 +177,12 @@ public virtual Task GetRepositoriesMetering } /// - /// You can use the cluster repositories metering API to retrieve repositories metering information in a cluster.
This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the
information needed to compute aggregations over a period of time. Additionally, the information exposed by this
API is volatile, meaning that it won’t be present after node restarts. + /// + /// You can use the cluster repositories metering API to retrieve repositories metering information in a cluster. + /// This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the + /// information needed to compute aggregations over a period of time. Additionally, the information exposed by this + /// API is volatile, meaning that it won’t be present after node restarts. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -160,7 +193,12 @@ public virtual GetRepositoriesMeteringInfoResponse GetRepositoriesMeteringInfo(G } /// - /// You can use the cluster repositories metering API to retrieve repositories metering information in a cluster.
This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the
information needed to compute aggregations over a period of time. Additionally, the information exposed by this
API is volatile, meaning that it won’t be present after node restarts. + /// + /// You can use the cluster repositories metering API to retrieve repositories metering information in a cluster. + /// This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the + /// information needed to compute aggregations over a period of time. Additionally, the information exposed by this + /// API is volatile, meaning that it won’t be present after node restarts. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -172,7 +210,12 @@ public virtual GetRepositoriesMeteringInfoResponse GetRepositoriesMeteringInfo(E } /// - /// You can use the cluster repositories metering API to retrieve repositories metering information in a cluster.
This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the
information needed to compute aggregations over a period of time. Additionally, the information exposed by this
API is volatile, meaning that it won’t be present after node restarts. + /// + /// You can use the cluster repositories metering API to retrieve repositories metering information in a cluster. + /// This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the + /// information needed to compute aggregations over a period of time. Additionally, the information exposed by this + /// API is volatile, meaning that it won’t be present after node restarts. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -185,7 +228,12 @@ public virtual GetRepositoriesMeteringInfoResponse GetRepositoriesMeteringInfo(E } /// - /// You can use the cluster repositories metering API to retrieve repositories metering information in a cluster.
This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the
information needed to compute aggregations over a period of time. Additionally, the information exposed by this
API is volatile, meaning that it won’t be present after node restarts. + /// + /// You can use the cluster repositories metering API to retrieve repositories metering information in a cluster. + /// This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the + /// information needed to compute aggregations over a period of time. Additionally, the information exposed by this + /// API is volatile, meaning that it won’t be present after node restarts. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRepositoriesMeteringInfoAsync(GetRepositoriesMeteringInfoRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -195,7 +243,12 @@ public virtual Task GetRepositoriesMetering } /// - /// You can use the cluster repositories metering API to retrieve repositories metering information in a cluster.
This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the
information needed to compute aggregations over a period of time. Additionally, the information exposed by this
API is volatile, meaning that it won’t be present after node restarts. + /// + /// You can use the cluster repositories metering API to retrieve repositories metering information in a cluster. + /// This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the + /// information needed to compute aggregations over a period of time. Additionally, the information exposed by this + /// API is volatile, meaning that it won’t be present after node restarts. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRepositoriesMeteringInfoAsync(Elastic.Clients.Elasticsearch.NodeIds nodeId, CancellationToken cancellationToken = default) @@ -206,7 +259,12 @@ public virtual Task GetRepositoriesMetering } /// - /// You can use the cluster repositories metering API to retrieve repositories metering information in a cluster.
This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the
information needed to compute aggregations over a period of time. Additionally, the information exposed by this
API is volatile, meaning that it won’t be present after node restarts. + /// + /// You can use the cluster repositories metering API to retrieve repositories metering information in a cluster. + /// This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the + /// information needed to compute aggregations over a period of time. Additionally, the information exposed by this + /// API is volatile, meaning that it won’t be present after node restarts. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRepositoriesMeteringInfoAsync(Elastic.Clients.Elasticsearch.NodeIds nodeId, Action configureRequest, CancellationToken cancellationToken = default) @@ -218,7 +276,10 @@ public virtual Task GetRepositoriesMetering } /// - /// This API yields a breakdown of the hot threads on each selected node in the cluster.
The output is plain text with a breakdown of each node’s top hot threads. + /// + /// This API yields a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of each node’s top hot threads. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -229,7 +290,10 @@ public virtual HotThreadsResponse HotThreads(HotThreadsRequest request) } /// - /// This API yields a breakdown of the hot threads on each selected node in the cluster.
The output is plain text with a breakdown of each node’s top hot threads. + /// + /// This API yields a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of each node’s top hot threads. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HotThreadsAsync(HotThreadsRequest request, CancellationToken cancellationToken = default) @@ -239,7 +303,10 @@ public virtual Task HotThreadsAsync(HotThreadsRequest reques } /// - /// This API yields a breakdown of the hot threads on each selected node in the cluster.
The output is plain text with a breakdown of each node’s top hot threads. + /// + /// This API yields a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of each node’s top hot threads. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -250,7 +317,10 @@ public virtual HotThreadsResponse HotThreads(HotThreadsRequestDescriptor descrip } /// - /// This API yields a breakdown of the hot threads on each selected node in the cluster.
The output is plain text with a breakdown of each node’s top hot threads. + /// + /// This API yields a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of each node’s top hot threads. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -262,7 +332,10 @@ public virtual HotThreadsResponse HotThreads(Elastic.Clients.Elasticsearch.NodeI } /// - /// This API yields a breakdown of the hot threads on each selected node in the cluster.
The output is plain text with a breakdown of each node’s top hot threads. + /// + /// This API yields a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of each node’s top hot threads. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -275,7 +348,10 @@ public virtual HotThreadsResponse HotThreads(Elastic.Clients.Elasticsearch.NodeI } /// - /// This API yields a breakdown of the hot threads on each selected node in the cluster.
The output is plain text with a breakdown of each node’s top hot threads. + /// + /// This API yields a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of each node’s top hot threads. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -287,7 +363,10 @@ public virtual HotThreadsResponse HotThreads() } /// - /// This API yields a breakdown of the hot threads on each selected node in the cluster.
The output is plain text with a breakdown of each node’s top hot threads. + /// + /// This API yields a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of each node’s top hot threads. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -300,7 +379,10 @@ public virtual HotThreadsResponse HotThreads(Action } /// - /// This API yields a breakdown of the hot threads on each selected node in the cluster.
The output is plain text with a breakdown of each node’s top hot threads. + /// + /// This API yields a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of each node’s top hot threads. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HotThreadsAsync(HotThreadsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -310,7 +392,10 @@ public virtual Task HotThreadsAsync(HotThreadsRequestDescrip } /// - /// This API yields a breakdown of the hot threads on each selected node in the cluster.
The output is plain text with a breakdown of each node’s top hot threads. + /// + /// This API yields a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of each node’s top hot threads. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HotThreadsAsync(Elastic.Clients.Elasticsearch.NodeIds? nodeId, CancellationToken cancellationToken = default) @@ -321,7 +406,10 @@ public virtual Task HotThreadsAsync(Elastic.Clients.Elastics } /// - /// This API yields a breakdown of the hot threads on each selected node in the cluster.
The output is plain text with a breakdown of each node’s top hot threads. + /// + /// This API yields a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of each node’s top hot threads. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HotThreadsAsync(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Action configureRequest, CancellationToken cancellationToken = default) @@ -333,7 +421,10 @@ public virtual Task HotThreadsAsync(Elastic.Clients.Elastics } /// - /// This API yields a breakdown of the hot threads on each selected node in the cluster.
The output is plain text with a breakdown of each node’s top hot threads. + /// + /// This API yields a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of each node’s top hot threads. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HotThreadsAsync(CancellationToken cancellationToken = default) @@ -344,7 +435,10 @@ public virtual Task HotThreadsAsync(CancellationToken cancel } /// - /// This API yields a breakdown of the hot threads on each selected node in the cluster.
The output is plain text with a breakdown of each node’s top hot threads. + /// + /// This API yields a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of each node’s top hot threads. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HotThreadsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -356,7 +450,9 @@ public virtual Task HotThreadsAsync(Action - /// Returns cluster nodes information. + /// + /// Returns cluster nodes information. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -367,7 +463,9 @@ public virtual NodesInfoResponse Info(NodesInfoRequest request) } /// - /// Returns cluster nodes information. + /// + /// Returns cluster nodes information. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(NodesInfoRequest request, CancellationToken cancellationToken = default) @@ -377,7 +475,9 @@ public virtual Task InfoAsync(NodesInfoRequest request, Cance } /// - /// Returns cluster nodes information. + /// + /// Returns cluster nodes information. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -388,7 +488,9 @@ public virtual NodesInfoResponse Info(NodesInfoRequestDescriptor descriptor) } /// - /// Returns cluster nodes information. + /// + /// Returns cluster nodes information. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -400,7 +502,9 @@ public virtual NodesInfoResponse Info(Elastic.Clients.Elasticsearch.NodeIds? nod } /// - /// Returns cluster nodes information. + /// + /// Returns cluster nodes information. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -413,7 +517,9 @@ public virtual NodesInfoResponse Info(Elastic.Clients.Elasticsearch.NodeIds? nod } /// - /// Returns cluster nodes information. + /// + /// Returns cluster nodes information. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -425,7 +531,9 @@ public virtual NodesInfoResponse Info() } /// - /// Returns cluster nodes information. + /// + /// Returns cluster nodes information. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -438,7 +546,9 @@ public virtual NodesInfoResponse Info(Action configu } /// - /// Returns cluster nodes information. + /// + /// Returns cluster nodes information. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(NodesInfoRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -448,7 +558,9 @@ public virtual Task InfoAsync(NodesInfoRequestDescriptor desc } /// - /// Returns cluster nodes information. + /// + /// Returns cluster nodes information. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Metrics? metric, CancellationToken cancellationToken = default) @@ -459,7 +571,9 @@ public virtual Task InfoAsync(Elastic.Clients.Elasticsearch.N } /// - /// Returns cluster nodes information. + /// + /// Returns cluster nodes information. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Metrics? metric, Action configureRequest, CancellationToken cancellationToken = default) @@ -471,7 +585,9 @@ public virtual Task InfoAsync(Elastic.Clients.Elasticsearch.N } /// - /// Returns cluster nodes information. + /// + /// Returns cluster nodes information. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(CancellationToken cancellationToken = default) @@ -482,7 +598,9 @@ public virtual Task InfoAsync(CancellationToken cancellationT } /// - /// Returns cluster nodes information. + /// + /// Returns cluster nodes information. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -494,7 +612,9 @@ public virtual Task InfoAsync(Action - /// Reloads the keystore on nodes in the cluster. + /// + /// Reloads the keystore on nodes in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -505,7 +625,9 @@ public virtual ReloadSecureSettingsResponse ReloadSecureSettings(ReloadSecureSet } /// - /// Reloads the keystore on nodes in the cluster. + /// + /// Reloads the keystore on nodes in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReloadSecureSettingsAsync(ReloadSecureSettingsRequest request, CancellationToken cancellationToken = default) @@ -515,7 +637,9 @@ public virtual Task ReloadSecureSettingsAsync(Relo } /// - /// Reloads the keystore on nodes in the cluster. + /// + /// Reloads the keystore on nodes in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -526,7 +650,9 @@ public virtual ReloadSecureSettingsResponse ReloadSecureSettings(ReloadSecureSet } /// - /// Reloads the keystore on nodes in the cluster. + /// + /// Reloads the keystore on nodes in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -538,7 +664,9 @@ public virtual ReloadSecureSettingsResponse ReloadSecureSettings(Elastic.Clients } /// - /// Reloads the keystore on nodes in the cluster. + /// + /// Reloads the keystore on nodes in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -551,7 +679,9 @@ public virtual ReloadSecureSettingsResponse ReloadSecureSettings(Elastic.Clients } /// - /// Reloads the keystore on nodes in the cluster. + /// + /// Reloads the keystore on nodes in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -563,7 +693,9 @@ public virtual ReloadSecureSettingsResponse ReloadSecureSettings() } /// - /// Reloads the keystore on nodes in the cluster. + /// + /// Reloads the keystore on nodes in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -576,7 +708,9 @@ public virtual ReloadSecureSettingsResponse ReloadSecureSettings(Action - /// Reloads the keystore on nodes in the cluster. + /// + /// Reloads the keystore on nodes in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReloadSecureSettingsAsync(ReloadSecureSettingsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -586,7 +720,9 @@ public virtual Task ReloadSecureSettingsAsync(Relo } /// - /// Reloads the keystore on nodes in the cluster. + /// + /// Reloads the keystore on nodes in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReloadSecureSettingsAsync(Elastic.Clients.Elasticsearch.NodeIds? nodeId, CancellationToken cancellationToken = default) @@ -597,7 +733,9 @@ public virtual Task ReloadSecureSettingsAsync(Elas } /// - /// Reloads the keystore on nodes in the cluster. + /// + /// Reloads the keystore on nodes in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReloadSecureSettingsAsync(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Action configureRequest, CancellationToken cancellationToken = default) @@ -609,7 +747,9 @@ public virtual Task ReloadSecureSettingsAsync(Elas } /// - /// Reloads the keystore on nodes in the cluster. + /// + /// Reloads the keystore on nodes in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReloadSecureSettingsAsync(CancellationToken cancellationToken = default) @@ -620,7 +760,9 @@ public virtual Task ReloadSecureSettingsAsync(Canc } /// - /// Reloads the keystore on nodes in the cluster. + /// + /// Reloads the keystore on nodes in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReloadSecureSettingsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -632,7 +774,9 @@ public virtual Task ReloadSecureSettingsAsync(Acti } /// - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -643,7 +787,9 @@ public virtual NodesStatsResponse Stats(NodesStatsRequest request) } /// - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(NodesStatsRequest request, CancellationToken cancellationToken = default) @@ -653,7 +799,9 @@ public virtual Task StatsAsync(NodesStatsRequest request, Ca } /// - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -664,7 +812,9 @@ public virtual NodesStatsResponse Stats(NodesStatsRequestDescriptor - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -676,7 +826,9 @@ public virtual NodesStatsResponse Stats(Elastic.Clients.Elasticsearch } /// - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -689,7 +841,9 @@ public virtual NodesStatsResponse Stats(Elastic.Clients.Elasticsearch } /// - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -701,7 +855,9 @@ public virtual NodesStatsResponse Stats() } /// - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -714,7 +870,9 @@ public virtual NodesStatsResponse Stats(Action - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -725,7 +883,9 @@ public virtual NodesStatsResponse Stats(NodesStatsRequestDescriptor descriptor) } /// - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -737,7 +897,9 @@ public virtual NodesStatsResponse Stats(Elastic.Clients.Elasticsearch.NodeIds? n } /// - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -750,7 +912,9 @@ public virtual NodesStatsResponse Stats(Elastic.Clients.Elasticsearch.NodeIds? n } /// - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -762,7 +926,9 @@ public virtual NodesStatsResponse Stats() } /// - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -775,7 +941,9 @@ public virtual NodesStatsResponse Stats(Action conf } /// - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(NodesStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -785,7 +953,9 @@ public virtual Task StatsAsync(NodesStatsRequestD } /// - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Metrics? metric, Elastic.Clients.Elasticsearch.Metrics? indexMetric, CancellationToken cancellationToken = default) @@ -796,7 +966,9 @@ public virtual Task StatsAsync(Elastic.Clients.El } /// - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Metrics? metric, Elastic.Clients.Elasticsearch.Metrics? indexMetric, Action> configureRequest, CancellationToken cancellationToken = default) @@ -808,7 +980,9 @@ public virtual Task StatsAsync(Elastic.Clients.El } /// - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(CancellationToken cancellationToken = default) @@ -819,7 +993,9 @@ public virtual Task StatsAsync(CancellationToken } /// - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -831,7 +1007,9 @@ public virtual Task StatsAsync(Action - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(NodesStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -841,7 +1019,9 @@ public virtual Task StatsAsync(NodesStatsRequestDescriptor d } /// - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Metrics? metric, Elastic.Clients.Elasticsearch.Metrics? indexMetric, CancellationToken cancellationToken = default) @@ -852,7 +1032,9 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsearch } /// - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Metrics? metric, Elastic.Clients.Elasticsearch.Metrics? indexMetric, Action configureRequest, CancellationToken cancellationToken = default) @@ -864,7 +1046,9 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsearch } /// - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(CancellationToken cancellationToken = default) @@ -875,7 +1059,9 @@ public virtual Task StatsAsync(CancellationToken cancellatio } /// - /// Returns cluster nodes statistics. + /// + /// Returns cluster nodes statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -887,7 +1073,9 @@ public virtual Task StatsAsync(Action - /// Returns information on the usage of features. + /// + /// Returns information on the usage of features. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -898,7 +1086,9 @@ public virtual NodesUsageResponse Usage(NodesUsageRequest request) } /// - /// Returns information on the usage of features. + /// + /// Returns information on the usage of features. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(NodesUsageRequest request, CancellationToken cancellationToken = default) @@ -908,7 +1098,9 @@ public virtual Task UsageAsync(NodesUsageRequest request, Ca } /// - /// Returns information on the usage of features. + /// + /// Returns information on the usage of features. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -919,7 +1111,9 @@ public virtual NodesUsageResponse Usage(NodesUsageRequestDescriptor descriptor) } /// - /// Returns information on the usage of features. + /// + /// Returns information on the usage of features. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -931,7 +1125,9 @@ public virtual NodesUsageResponse Usage(Elastic.Clients.Elasticsearch.NodeIds? n } /// - /// Returns information on the usage of features. + /// + /// Returns information on the usage of features. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -944,7 +1140,9 @@ public virtual NodesUsageResponse Usage(Elastic.Clients.Elasticsearch.NodeIds? n } /// - /// Returns information on the usage of features. + /// + /// Returns information on the usage of features. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -956,7 +1154,9 @@ public virtual NodesUsageResponse Usage() } /// - /// Returns information on the usage of features. + /// + /// Returns information on the usage of features. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -969,7 +1169,9 @@ public virtual NodesUsageResponse Usage(Action conf } /// - /// Returns information on the usage of features. + /// + /// Returns information on the usage of features. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(NodesUsageRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -979,7 +1181,9 @@ public virtual Task UsageAsync(NodesUsageRequestDescriptor d } /// - /// Returns information on the usage of features. + /// + /// Returns information on the usage of features. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Metrics? metric, CancellationToken cancellationToken = default) @@ -990,7 +1194,9 @@ public virtual Task UsageAsync(Elastic.Clients.Elasticsearch } /// - /// Returns information on the usage of features. + /// + /// Returns information on the usage of features. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Metrics? metric, Action configureRequest, CancellationToken cancellationToken = default) @@ -1002,7 +1208,9 @@ public virtual Task UsageAsync(Elastic.Clients.Elasticsearch } /// - /// Returns information on the usage of features. + /// + /// Returns information on the usage of features. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(CancellationToken cancellationToken = default) @@ -1013,7 +1221,9 @@ public virtual Task UsageAsync(CancellationToken cancellatio } /// - /// Returns information on the usage of features. + /// + /// Returns information on the usage of features. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.QueryRules.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.QueryRules.g.cs index 76e75f38ede..0a400749631 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.QueryRules.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.QueryRules.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.QueryRules; public partial class QueryRulesNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected QueryRulesNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal QueryRulesNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// Deletes a query ruleset. + /// + /// Deletes a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -49,7 +53,9 @@ public virtual DeleteRulesetResponse DeleteRuleset(DeleteRulesetRequest request) } /// - /// Deletes a query ruleset. + /// + /// Deletes a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteRulesetAsync(DeleteRulesetRequest request, CancellationToken cancellationToken = default) @@ -59,7 +65,9 @@ public virtual Task DeleteRulesetAsync(DeleteRulesetReque } /// - /// Deletes a query ruleset. + /// + /// Deletes a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -70,7 +78,9 @@ public virtual DeleteRulesetResponse DeleteRuleset(DeleteRulesetRequestDescripto } /// - /// Deletes a query ruleset. + /// + /// Deletes a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -82,7 +92,9 @@ public virtual DeleteRulesetResponse DeleteRuleset(Elastic.Clients.Elasticsearch } /// - /// Deletes a query ruleset. + /// + /// Deletes a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -95,7 +107,9 @@ public virtual DeleteRulesetResponse DeleteRuleset(Elastic.Clients.Elasticsearch } /// - /// Deletes a query ruleset. + /// + /// Deletes a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteRulesetAsync(DeleteRulesetRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -105,7 +119,9 @@ public virtual Task DeleteRulesetAsync(DeleteRulesetReque } /// - /// Deletes a query ruleset. + /// + /// Deletes a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteRulesetAsync(Elastic.Clients.Elasticsearch.Id rulesetId, CancellationToken cancellationToken = default) @@ -116,7 +132,9 @@ public virtual Task DeleteRulesetAsync(Elastic.Clients.El } /// - /// Deletes a query ruleset. + /// + /// Deletes a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteRulesetAsync(Elastic.Clients.Elasticsearch.Id rulesetId, Action configureRequest, CancellationToken cancellationToken = default) @@ -128,7 +146,9 @@ public virtual Task DeleteRulesetAsync(Elastic.Clients.El } /// - /// Returns the details about a query ruleset + /// + /// Returns the details about a query ruleset + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -139,7 +159,9 @@ public virtual GetRulesetResponse GetRuleset(GetRulesetRequest request) } /// - /// Returns the details about a query ruleset + /// + /// Returns the details about a query ruleset + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRulesetAsync(GetRulesetRequest request, CancellationToken cancellationToken = default) @@ -149,7 +171,9 @@ public virtual Task GetRulesetAsync(GetRulesetRequest reques } /// - /// Returns the details about a query ruleset + /// + /// Returns the details about a query ruleset + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -160,7 +184,9 @@ public virtual GetRulesetResponse GetRuleset(GetRulesetRequestDescriptor descrip } /// - /// Returns the details about a query ruleset + /// + /// Returns the details about a query ruleset + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -172,7 +198,9 @@ public virtual GetRulesetResponse GetRuleset(Elastic.Clients.Elasticsearch.Id ru } /// - /// Returns the details about a query ruleset + /// + /// Returns the details about a query ruleset + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -185,7 +213,9 @@ public virtual GetRulesetResponse GetRuleset(Elastic.Clients.Elasticsearch.Id ru } /// - /// Returns the details about a query ruleset + /// + /// Returns the details about a query ruleset + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRulesetAsync(GetRulesetRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -195,7 +225,9 @@ public virtual Task GetRulesetAsync(GetRulesetRequestDescrip } /// - /// Returns the details about a query ruleset + /// + /// Returns the details about a query ruleset + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRulesetAsync(Elastic.Clients.Elasticsearch.Id rulesetId, CancellationToken cancellationToken = default) @@ -206,7 +238,9 @@ public virtual Task GetRulesetAsync(Elastic.Clients.Elastics } /// - /// Returns the details about a query ruleset + /// + /// Returns the details about a query ruleset + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRulesetAsync(Elastic.Clients.Elasticsearch.Id rulesetId, Action configureRequest, CancellationToken cancellationToken = default) @@ -218,7 +252,9 @@ public virtual Task GetRulesetAsync(Elastic.Clients.Elastics } /// - /// Returns summarized information about existing query rulesets. + /// + /// Returns summarized information about existing query rulesets. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -229,7 +265,9 @@ public virtual ListRulesetsResponse ListRulesets(ListRulesetsRequest request) } /// - /// Returns summarized information about existing query rulesets. + /// + /// Returns summarized information about existing query rulesets. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ListRulesetsAsync(ListRulesetsRequest request, CancellationToken cancellationToken = default) @@ -239,7 +277,9 @@ public virtual Task ListRulesetsAsync(ListRulesetsRequest } /// - /// Returns summarized information about existing query rulesets. + /// + /// Returns summarized information about existing query rulesets. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -250,7 +290,9 @@ public virtual ListRulesetsResponse ListRulesets(ListRulesetsRequestDescriptor d } /// - /// Returns summarized information about existing query rulesets. + /// + /// Returns summarized information about existing query rulesets. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -262,7 +304,9 @@ public virtual ListRulesetsResponse ListRulesets() } /// - /// Returns summarized information about existing query rulesets. + /// + /// Returns summarized information about existing query rulesets. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -275,7 +319,9 @@ public virtual ListRulesetsResponse ListRulesets(Action - /// Returns summarized information about existing query rulesets. + /// + /// Returns summarized information about existing query rulesets. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ListRulesetsAsync(ListRulesetsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -285,7 +331,9 @@ public virtual Task ListRulesetsAsync(ListRulesetsRequestD } /// - /// Returns summarized information about existing query rulesets. + /// + /// Returns summarized information about existing query rulesets. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ListRulesetsAsync(CancellationToken cancellationToken = default) @@ -296,7 +344,9 @@ public virtual Task ListRulesetsAsync(CancellationToken ca } /// - /// Returns summarized information about existing query rulesets. + /// + /// Returns summarized information about existing query rulesets. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ListRulesetsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -308,7 +358,9 @@ public virtual Task ListRulesetsAsync(Action - /// Creates or updates a query ruleset. + /// + /// Creates or updates a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -319,7 +371,9 @@ public virtual PutRulesetResponse PutRuleset(PutRulesetRequest request) } /// - /// Creates or updates a query ruleset. + /// + /// Creates or updates a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutRulesetAsync(PutRulesetRequest request, CancellationToken cancellationToken = default) @@ -329,7 +383,9 @@ public virtual Task PutRulesetAsync(PutRulesetRequest reques } /// - /// Creates or updates a query ruleset. + /// + /// Creates or updates a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -340,7 +396,9 @@ public virtual PutRulesetResponse PutRuleset(PutRulesetRequestDescriptor descrip } /// - /// Creates or updates a query ruleset. + /// + /// Creates or updates a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -352,7 +410,9 @@ public virtual PutRulesetResponse PutRuleset(Elastic.Clients.Elasticsearch.Id ru } /// - /// Creates or updates a query ruleset. + /// + /// Creates or updates a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -365,7 +425,9 @@ public virtual PutRulesetResponse PutRuleset(Elastic.Clients.Elasticsearch.Id ru } /// - /// Creates or updates a query ruleset. + /// + /// Creates or updates a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutRulesetAsync(PutRulesetRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -375,7 +437,9 @@ public virtual Task PutRulesetAsync(PutRulesetRequestDescrip } /// - /// Creates or updates a query ruleset. + /// + /// Creates or updates a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutRulesetAsync(Elastic.Clients.Elasticsearch.Id rulesetId, CancellationToken cancellationToken = default) @@ -386,7 +450,9 @@ public virtual Task PutRulesetAsync(Elastic.Clients.Elastics } /// - /// Creates or updates a query ruleset. + /// + /// Creates or updates a query ruleset. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutRulesetAsync(Elastic.Clients.Elasticsearch.Id rulesetId, Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Rollup.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Rollup.g.cs index 24fb17490d3..eb80088fdb7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Rollup.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Rollup.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Rollup; public partial class RollupNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected RollupNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal RollupNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// Deletes an existing rollup job. + /// + /// Deletes an existing rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -49,7 +53,9 @@ public virtual DeleteJobResponse DeleteJob(DeleteJobRequest request) } /// - /// Deletes an existing rollup job. + /// + /// Deletes an existing rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteJobAsync(DeleteJobRequest request, CancellationToken cancellationToken = default) @@ -59,7 +65,9 @@ public virtual Task DeleteJobAsync(DeleteJobRequest request, } /// - /// Deletes an existing rollup job. + /// + /// Deletes an existing rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -70,7 +78,9 @@ public virtual DeleteJobResponse DeleteJob(DeleteJobRequestDescriptor } /// - /// Deletes an existing rollup job. + /// + /// Deletes an existing rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -82,7 +92,9 @@ public virtual DeleteJobResponse DeleteJob(Elastic.Clients.Elasticsea } /// - /// Deletes an existing rollup job. + /// + /// Deletes an existing rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -95,7 +107,9 @@ public virtual DeleteJobResponse DeleteJob(Elastic.Clients.Elasticsea } /// - /// Deletes an existing rollup job. + /// + /// Deletes an existing rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -106,7 +120,9 @@ public virtual DeleteJobResponse DeleteJob(DeleteJobRequestDescriptor descriptor } /// - /// Deletes an existing rollup job. + /// + /// Deletes an existing rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -118,7 +134,9 @@ public virtual DeleteJobResponse DeleteJob(Elastic.Clients.Elasticsearch.Id id) } /// - /// Deletes an existing rollup job. + /// + /// Deletes an existing rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -131,7 +149,9 @@ public virtual DeleteJobResponse DeleteJob(Elastic.Clients.Elasticsearch.Id id, } /// - /// Deletes an existing rollup job. + /// + /// Deletes an existing rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteJobAsync(DeleteJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -141,7 +161,9 @@ public virtual Task DeleteJobAsync(DeleteJobReques } /// - /// Deletes an existing rollup job. + /// + /// Deletes an existing rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteJobAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -152,7 +174,9 @@ public virtual Task DeleteJobAsync(Elastic.Clients } /// - /// Deletes an existing rollup job. + /// + /// Deletes an existing rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteJobAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -164,7 +188,9 @@ public virtual Task DeleteJobAsync(Elastic.Clients } /// - /// Deletes an existing rollup job. + /// + /// Deletes an existing rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteJobAsync(DeleteJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -174,7 +200,9 @@ public virtual Task DeleteJobAsync(DeleteJobRequestDescriptor } /// - /// Deletes an existing rollup job. + /// + /// Deletes an existing rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteJobAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -185,7 +213,9 @@ public virtual Task DeleteJobAsync(Elastic.Clients.Elasticsea } /// - /// Deletes an existing rollup job. + /// + /// Deletes an existing rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteJobAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -197,7 +227,9 @@ public virtual Task DeleteJobAsync(Elastic.Clients.Elasticsea } /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// + /// Retrieves the configuration, stats, and status of rollup jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -208,7 +240,9 @@ public virtual GetJobsResponse GetJobs(GetJobsRequest request) } /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// + /// Retrieves the configuration, stats, and status of rollup jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobsAsync(GetJobsRequest request, CancellationToken cancellationToken = default) @@ -218,7 +252,9 @@ public virtual Task GetJobsAsync(GetJobsRequest request, Cancel } /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// + /// Retrieves the configuration, stats, and status of rollup jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -229,7 +265,9 @@ public virtual GetJobsResponse GetJobs(GetJobsRequestDescriptor - /// Retrieves the configuration, stats, and status of rollup jobs. + /// + /// Retrieves the configuration, stats, and status of rollup jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -241,7 +279,9 @@ public virtual GetJobsResponse GetJobs(Elastic.Clients.Elasticsearch. } /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// + /// Retrieves the configuration, stats, and status of rollup jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -254,7 +294,9 @@ public virtual GetJobsResponse GetJobs(Elastic.Clients.Elasticsearch. } /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// + /// Retrieves the configuration, stats, and status of rollup jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -266,7 +308,9 @@ public virtual GetJobsResponse GetJobs() } /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// + /// Retrieves the configuration, stats, and status of rollup jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -279,7 +323,9 @@ public virtual GetJobsResponse GetJobs(Action - /// Retrieves the configuration, stats, and status of rollup jobs. + /// + /// Retrieves the configuration, stats, and status of rollup jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -290,7 +336,9 @@ public virtual GetJobsResponse GetJobs(GetJobsRequestDescriptor descriptor) } /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// + /// Retrieves the configuration, stats, and status of rollup jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -302,7 +350,9 @@ public virtual GetJobsResponse GetJobs(Elastic.Clients.Elasticsearch.Id? id) } /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// + /// Retrieves the configuration, stats, and status of rollup jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -315,7 +365,9 @@ public virtual GetJobsResponse GetJobs(Elastic.Clients.Elasticsearch.Id? id, Act } /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// + /// Retrieves the configuration, stats, and status of rollup jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -327,7 +379,9 @@ public virtual GetJobsResponse GetJobs() } /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// + /// Retrieves the configuration, stats, and status of rollup jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -340,7 +394,9 @@ public virtual GetJobsResponse GetJobs(Action configur } /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// + /// Retrieves the configuration, stats, and status of rollup jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobsAsync(GetJobsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -350,7 +406,9 @@ public virtual Task GetJobsAsync(GetJobsRequestDescr } /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// + /// Retrieves the configuration, stats, and status of rollup jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobsAsync(Elastic.Clients.Elasticsearch.Id? id, CancellationToken cancellationToken = default) @@ -361,7 +419,9 @@ public virtual Task GetJobsAsync(Elastic.Clients.Ela } /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// + /// Retrieves the configuration, stats, and status of rollup jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobsAsync(Elastic.Clients.Elasticsearch.Id? id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -373,7 +433,9 @@ public virtual Task GetJobsAsync(Elastic.Clients.Ela } /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// + /// Retrieves the configuration, stats, and status of rollup jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobsAsync(CancellationToken cancellationToken = default) @@ -384,7 +446,9 @@ public virtual Task GetJobsAsync(CancellationToken c } /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// + /// Retrieves the configuration, stats, and status of rollup jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobsAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -396,7 +460,9 @@ public virtual Task GetJobsAsync(Action - /// Retrieves the configuration, stats, and status of rollup jobs. + /// + /// Retrieves the configuration, stats, and status of rollup jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobsAsync(GetJobsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -406,7 +472,9 @@ public virtual Task GetJobsAsync(GetJobsRequestDescriptor descr } /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// + /// Retrieves the configuration, stats, and status of rollup jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobsAsync(Elastic.Clients.Elasticsearch.Id? id, CancellationToken cancellationToken = default) @@ -417,7 +485,9 @@ public virtual Task GetJobsAsync(Elastic.Clients.Elasticsearch. } /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// + /// Retrieves the configuration, stats, and status of rollup jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobsAsync(Elastic.Clients.Elasticsearch.Id? id, Action configureRequest, CancellationToken cancellationToken = default) @@ -429,7 +499,9 @@ public virtual Task GetJobsAsync(Elastic.Clients.Elasticsearch. } /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// + /// Retrieves the configuration, stats, and status of rollup jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobsAsync(CancellationToken cancellationToken = default) @@ -440,7 +512,9 @@ public virtual Task GetJobsAsync(CancellationToken cancellation } /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// + /// Retrieves the configuration, stats, and status of rollup jobs. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetJobsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -452,7 +526,9 @@ public virtual Task GetJobsAsync(Action - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -463,7 +539,9 @@ public virtual GetRollupCapsResponse GetRollupCaps(GetRollupCapsRequest request) } /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupCapsAsync(GetRollupCapsRequest request, CancellationToken cancellationToken = default) @@ -473,7 +551,9 @@ public virtual Task GetRollupCapsAsync(GetRollupCapsReque } /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -484,7 +564,9 @@ public virtual GetRollupCapsResponse GetRollupCaps(GetRollupCapsReque } /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -496,7 +578,9 @@ public virtual GetRollupCapsResponse GetRollupCaps(Elastic.Clients.El } /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -509,7 +593,9 @@ public virtual GetRollupCapsResponse GetRollupCaps(Elastic.Clients.El } /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -521,7 +607,9 @@ public virtual GetRollupCapsResponse GetRollupCaps() } /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -534,7 +622,9 @@ public virtual GetRollupCapsResponse GetRollupCaps(Action - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -545,7 +635,9 @@ public virtual GetRollupCapsResponse GetRollupCaps(GetRollupCapsRequestDescripto } /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -557,7 +649,9 @@ public virtual GetRollupCapsResponse GetRollupCaps(Elastic.Clients.Elasticsearch } /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -570,7 +664,9 @@ public virtual GetRollupCapsResponse GetRollupCaps(Elastic.Clients.Elasticsearch } /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -582,7 +678,9 @@ public virtual GetRollupCapsResponse GetRollupCaps() } /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -595,7 +693,9 @@ public virtual GetRollupCapsResponse GetRollupCaps(Action - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupCapsAsync(GetRollupCapsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -605,7 +705,9 @@ public virtual Task GetRollupCapsAsync(GetRoll } /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupCapsAsync(Elastic.Clients.Elasticsearch.Id? id, CancellationToken cancellationToken = default) @@ -616,7 +718,9 @@ public virtual Task GetRollupCapsAsync(Elastic } /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupCapsAsync(Elastic.Clients.Elasticsearch.Id? id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -628,7 +732,9 @@ public virtual Task GetRollupCapsAsync(Elastic } /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupCapsAsync(CancellationToken cancellationToken = default) @@ -639,7 +745,9 @@ public virtual Task GetRollupCapsAsync(Cancell } /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupCapsAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -651,7 +759,9 @@ public virtual Task GetRollupCapsAsync(Action< } /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupCapsAsync(GetRollupCapsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -661,7 +771,9 @@ public virtual Task GetRollupCapsAsync(GetRollupCapsReque } /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupCapsAsync(Elastic.Clients.Elasticsearch.Id? id, CancellationToken cancellationToken = default) @@ -672,7 +784,9 @@ public virtual Task GetRollupCapsAsync(Elastic.Clients.El } /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupCapsAsync(Elastic.Clients.Elasticsearch.Id? id, Action configureRequest, CancellationToken cancellationToken = default) @@ -684,7 +798,9 @@ public virtual Task GetRollupCapsAsync(Elastic.Clients.El } /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupCapsAsync(CancellationToken cancellationToken = default) @@ -695,7 +811,9 @@ public virtual Task GetRollupCapsAsync(CancellationToken } /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupCapsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -707,7 +825,9 @@ public virtual Task GetRollupCapsAsync(Action - /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// + /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -718,7 +838,9 @@ public virtual GetRollupIndexCapsResponse GetRollupIndexCaps(GetRollupIndexCapsR } /// - /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// + /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupIndexCapsAsync(GetRollupIndexCapsRequest request, CancellationToken cancellationToken = default) @@ -728,7 +850,9 @@ public virtual Task GetRollupIndexCapsAsync(GetRollu } /// - /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// + /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -739,7 +863,9 @@ public virtual GetRollupIndexCapsResponse GetRollupIndexCaps(GetRollu } /// - /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// + /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -751,7 +877,9 @@ public virtual GetRollupIndexCapsResponse GetRollupIndexCaps(Elastic. } /// - /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// + /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -764,7 +892,9 @@ public virtual GetRollupIndexCapsResponse GetRollupIndexCaps(Elastic. } /// - /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// + /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -775,7 +905,9 @@ public virtual GetRollupIndexCapsResponse GetRollupIndexCaps(GetRollupIndexCapsR } /// - /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// + /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -787,7 +919,9 @@ public virtual GetRollupIndexCapsResponse GetRollupIndexCaps(Elastic.Clients.Ela } /// - /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// + /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -800,7 +934,9 @@ public virtual GetRollupIndexCapsResponse GetRollupIndexCaps(Elastic.Clients.Ela } /// - /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// + /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupIndexCapsAsync(GetRollupIndexCapsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -810,7 +946,9 @@ public virtual Task GetRollupIndexCapsAsync - /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// + /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupIndexCapsAsync(Elastic.Clients.Elasticsearch.Ids index, CancellationToken cancellationToken = default) @@ -821,7 +959,9 @@ public virtual Task GetRollupIndexCapsAsync - /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// + /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupIndexCapsAsync(Elastic.Clients.Elasticsearch.Ids index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -833,7 +973,9 @@ public virtual Task GetRollupIndexCapsAsync - /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// + /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupIndexCapsAsync(GetRollupIndexCapsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -843,7 +985,9 @@ public virtual Task GetRollupIndexCapsAsync(GetRollu } /// - /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// + /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupIndexCapsAsync(Elastic.Clients.Elasticsearch.Ids index, CancellationToken cancellationToken = default) @@ -854,7 +998,9 @@ public virtual Task GetRollupIndexCapsAsync(Elastic. } /// - /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// + /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupIndexCapsAsync(Elastic.Clients.Elasticsearch.Ids index, Action configureRequest, CancellationToken cancellationToken = default) @@ -866,7 +1012,9 @@ public virtual Task GetRollupIndexCapsAsync(Elastic. } /// - /// Creates a rollup job. + /// + /// Creates a rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -877,7 +1025,9 @@ public virtual PutJobResponse PutJob(PutJobRequest request) } /// - /// Creates a rollup job. + /// + /// Creates a rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutJobAsync(PutJobRequest request, CancellationToken cancellationToken = default) @@ -887,7 +1037,9 @@ public virtual Task PutJobAsync(PutJobRequest request, Cancellat } /// - /// Creates a rollup job. + /// + /// Creates a rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -898,7 +1050,9 @@ public virtual PutJobResponse PutJob(PutJobRequestDescriptor - /// Creates a rollup job. + /// + /// Creates a rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -910,7 +1064,9 @@ public virtual PutJobResponse PutJob(Elastic.Clients.Elasticsearch.Id } /// - /// Creates a rollup job. + /// + /// Creates a rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -923,7 +1079,9 @@ public virtual PutJobResponse PutJob(Elastic.Clients.Elasticsearch.Id } /// - /// Creates a rollup job. + /// + /// Creates a rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -934,7 +1092,9 @@ public virtual PutJobResponse PutJob(PutJobRequestDescriptor descriptor) } /// - /// Creates a rollup job. + /// + /// Creates a rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -946,7 +1106,9 @@ public virtual PutJobResponse PutJob(Elastic.Clients.Elasticsearch.Id id) } /// - /// Creates a rollup job. + /// + /// Creates a rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -959,7 +1121,9 @@ public virtual PutJobResponse PutJob(Elastic.Clients.Elasticsearch.Id id, Action } /// - /// Creates a rollup job. + /// + /// Creates a rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutJobAsync(PutJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -969,7 +1133,9 @@ public virtual Task PutJobAsync(PutJobRequestDescript } /// - /// Creates a rollup job. + /// + /// Creates a rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutJobAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -980,7 +1146,9 @@ public virtual Task PutJobAsync(Elastic.Clients.Elast } /// - /// Creates a rollup job. + /// + /// Creates a rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutJobAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -992,7 +1160,9 @@ public virtual Task PutJobAsync(Elastic.Clients.Elast } /// - /// Creates a rollup job. + /// + /// Creates a rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutJobAsync(PutJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1002,7 +1172,9 @@ public virtual Task PutJobAsync(PutJobRequestDescriptor descript } /// - /// Creates a rollup job. + /// + /// Creates a rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutJobAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -1013,7 +1185,9 @@ public virtual Task PutJobAsync(Elastic.Clients.Elasticsearch.Id } /// - /// Creates a rollup job. + /// + /// Creates a rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutJobAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -1025,7 +1199,9 @@ public virtual Task PutJobAsync(Elastic.Clients.Elasticsearch.Id } /// - /// Enables searching rolled-up data using the standard Query DSL. + /// + /// Enables searching rolled-up data using the standard Query DSL. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1036,7 +1212,9 @@ public virtual RollupSearchResponse RollupSearch(RollupSea } /// - /// Enables searching rolled-up data using the standard Query DSL. + /// + /// Enables searching rolled-up data using the standard Query DSL. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> RollupSearchAsync(RollupSearchRequest request, CancellationToken cancellationToken = default) @@ -1046,7 +1224,9 @@ public virtual Task> RollupSearchAsync - /// Enables searching rolled-up data using the standard Query DSL. + /// + /// Enables searching rolled-up data using the standard Query DSL. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1057,7 +1237,9 @@ public virtual RollupSearchResponse RollupSearch(RollupSea } /// - /// Enables searching rolled-up data using the standard Query DSL. + /// + /// Enables searching rolled-up data using the standard Query DSL. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1069,7 +1251,9 @@ public virtual RollupSearchResponse RollupSearch(Elastic.C } /// - /// Enables searching rolled-up data using the standard Query DSL. + /// + /// Enables searching rolled-up data using the standard Query DSL. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1082,7 +1266,9 @@ public virtual RollupSearchResponse RollupSearch(Elastic.C } /// - /// Enables searching rolled-up data using the standard Query DSL. + /// + /// Enables searching rolled-up data using the standard Query DSL. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1094,7 +1280,9 @@ public virtual RollupSearchResponse RollupSearch() } /// - /// Enables searching rolled-up data using the standard Query DSL. + /// + /// Enables searching rolled-up data using the standard Query DSL. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1107,7 +1295,9 @@ public virtual RollupSearchResponse RollupSearch(Action - /// Enables searching rolled-up data using the standard Query DSL. + /// + /// Enables searching rolled-up data using the standard Query DSL. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> RollupSearchAsync(RollupSearchRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1117,7 +1307,9 @@ public virtual Task> RollupSearchAsync - /// Enables searching rolled-up data using the standard Query DSL. + /// + /// Enables searching rolled-up data using the standard Query DSL. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> RollupSearchAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -1128,7 +1320,9 @@ public virtual Task> RollupSearchAsync - /// Enables searching rolled-up data using the standard Query DSL. + /// + /// Enables searching rolled-up data using the standard Query DSL. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> RollupSearchAsync(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1140,7 +1334,9 @@ public virtual Task> RollupSearchAsync - /// Enables searching rolled-up data using the standard Query DSL. + /// + /// Enables searching rolled-up data using the standard Query DSL. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> RollupSearchAsync(CancellationToken cancellationToken = default) @@ -1151,7 +1347,9 @@ public virtual Task> RollupSearchAsync - /// Enables searching rolled-up data using the standard Query DSL. + /// + /// Enables searching rolled-up data using the standard Query DSL. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> RollupSearchAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -1163,7 +1361,9 @@ public virtual Task> RollupSearchAsync - /// Starts an existing, stopped rollup job. + /// + /// Starts an existing, stopped rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1174,7 +1374,9 @@ public virtual StartJobResponse StartJob(StartJobRequest request) } /// - /// Starts an existing, stopped rollup job. + /// + /// Starts an existing, stopped rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartJobAsync(StartJobRequest request, CancellationToken cancellationToken = default) @@ -1184,7 +1386,9 @@ public virtual Task StartJobAsync(StartJobRequest request, Can } /// - /// Starts an existing, stopped rollup job. + /// + /// Starts an existing, stopped rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1195,7 +1399,9 @@ public virtual StartJobResponse StartJob(StartJobRequestDescriptor - /// Starts an existing, stopped rollup job. + /// + /// Starts an existing, stopped rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1207,7 +1413,9 @@ public virtual StartJobResponse StartJob(Elastic.Clients.Elasticsearc } /// - /// Starts an existing, stopped rollup job. + /// + /// Starts an existing, stopped rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1220,7 +1428,9 @@ public virtual StartJobResponse StartJob(Elastic.Clients.Elasticsearc } /// - /// Starts an existing, stopped rollup job. + /// + /// Starts an existing, stopped rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1231,7 +1441,9 @@ public virtual StartJobResponse StartJob(StartJobRequestDescriptor descriptor) } /// - /// Starts an existing, stopped rollup job. + /// + /// Starts an existing, stopped rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1243,7 +1455,9 @@ public virtual StartJobResponse StartJob(Elastic.Clients.Elasticsearch.Id id) } /// - /// Starts an existing, stopped rollup job. + /// + /// Starts an existing, stopped rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1256,7 +1470,9 @@ public virtual StartJobResponse StartJob(Elastic.Clients.Elasticsearch.Id id, Ac } /// - /// Starts an existing, stopped rollup job. + /// + /// Starts an existing, stopped rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartJobAsync(StartJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1266,7 +1482,9 @@ public virtual Task StartJobAsync(StartJobRequestDe } /// - /// Starts an existing, stopped rollup job. + /// + /// Starts an existing, stopped rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartJobAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -1277,7 +1495,9 @@ public virtual Task StartJobAsync(Elastic.Clients.E } /// - /// Starts an existing, stopped rollup job. + /// + /// Starts an existing, stopped rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartJobAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1289,7 +1509,9 @@ public virtual Task StartJobAsync(Elastic.Clients.E } /// - /// Starts an existing, stopped rollup job. + /// + /// Starts an existing, stopped rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartJobAsync(StartJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1299,7 +1521,9 @@ public virtual Task StartJobAsync(StartJobRequestDescriptor de } /// - /// Starts an existing, stopped rollup job. + /// + /// Starts an existing, stopped rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartJobAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -1310,7 +1534,9 @@ public virtual Task StartJobAsync(Elastic.Clients.Elasticsearc } /// - /// Starts an existing, stopped rollup job. + /// + /// Starts an existing, stopped rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartJobAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -1322,7 +1548,9 @@ public virtual Task StartJobAsync(Elastic.Clients.Elasticsearc } /// - /// Stops an existing, started rollup job. + /// + /// Stops an existing, started rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1333,7 +1561,9 @@ public virtual StopJobResponse StopJob(StopJobRequest request) } /// - /// Stops an existing, started rollup job. + /// + /// Stops an existing, started rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopJobAsync(StopJobRequest request, CancellationToken cancellationToken = default) @@ -1343,7 +1573,9 @@ public virtual Task StopJobAsync(StopJobRequest request, Cancel } /// - /// Stops an existing, started rollup job. + /// + /// Stops an existing, started rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1354,7 +1586,9 @@ public virtual StopJobResponse StopJob(StopJobRequestDescriptor - /// Stops an existing, started rollup job. + /// + /// Stops an existing, started rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1366,7 +1600,9 @@ public virtual StopJobResponse StopJob(Elastic.Clients.Elasticsearch. } /// - /// Stops an existing, started rollup job. + /// + /// Stops an existing, started rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1379,7 +1615,9 @@ public virtual StopJobResponse StopJob(Elastic.Clients.Elasticsearch. } /// - /// Stops an existing, started rollup job. + /// + /// Stops an existing, started rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1390,7 +1628,9 @@ public virtual StopJobResponse StopJob(StopJobRequestDescriptor descriptor) } /// - /// Stops an existing, started rollup job. + /// + /// Stops an existing, started rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1402,7 +1642,9 @@ public virtual StopJobResponse StopJob(Elastic.Clients.Elasticsearch.Id id) } /// - /// Stops an existing, started rollup job. + /// + /// Stops an existing, started rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1415,7 +1657,9 @@ public virtual StopJobResponse StopJob(Elastic.Clients.Elasticsearch.Id id, Acti } /// - /// Stops an existing, started rollup job. + /// + /// Stops an existing, started rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopJobAsync(StopJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1425,7 +1669,9 @@ public virtual Task StopJobAsync(StopJobRequestDescr } /// - /// Stops an existing, started rollup job. + /// + /// Stops an existing, started rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopJobAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -1436,7 +1682,9 @@ public virtual Task StopJobAsync(Elastic.Clients.Ela } /// - /// Stops an existing, started rollup job. + /// + /// Stops an existing, started rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopJobAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1448,7 +1696,9 @@ public virtual Task StopJobAsync(Elastic.Clients.Ela } /// - /// Stops an existing, started rollup job. + /// + /// Stops an existing, started rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopJobAsync(StopJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1458,7 +1708,9 @@ public virtual Task StopJobAsync(StopJobRequestDescriptor descr } /// - /// Stops an existing, started rollup job. + /// + /// Stops an existing, started rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopJobAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -1469,7 +1721,9 @@ public virtual Task StopJobAsync(Elastic.Clients.Elasticsearch. } /// - /// Stops an existing, started rollup job. + /// + /// Stops an existing, started rollup job. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopJobAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.SearchApplication.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.SearchApplication.g.cs index c7a1ca9b004..559e5cdd430 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.SearchApplication.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.SearchApplication.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.SearchApplication; public partial class SearchApplicationNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected SearchApplicationNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal SearchApplicationNamespacedClient(ElasticsearchClient client) : base(cl } /// - /// Deletes a search application. + /// + /// Deletes a search application. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -49,7 +53,9 @@ public virtual DeleteSearchApplicationResponse Delete(DeleteSearchApplicationReq } /// - /// Deletes a search application. + /// + /// Deletes a search application. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteSearchApplicationRequest request, CancellationToken cancellationToken = default) @@ -59,7 +65,9 @@ public virtual Task DeleteAsync(DeleteSearchApp } /// - /// Deletes a search application. + /// + /// Deletes a search application. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -70,7 +78,9 @@ public virtual DeleteSearchApplicationResponse Delete(DeleteSearchApplicationReq } /// - /// Deletes a search application. + /// + /// Deletes a search application. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -82,7 +92,9 @@ public virtual DeleteSearchApplicationResponse Delete(Elastic.Clients.Elasticsea } /// - /// Deletes a search application. + /// + /// Deletes a search application. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -95,7 +107,9 @@ public virtual DeleteSearchApplicationResponse Delete(Elastic.Clients.Elasticsea } /// - /// Deletes a search application. + /// + /// Deletes a search application. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteSearchApplicationRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -105,7 +119,9 @@ public virtual Task DeleteAsync(DeleteSearchApp } /// - /// Deletes a search application. + /// + /// Deletes a search application. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) @@ -116,7 +132,9 @@ public virtual Task DeleteAsync(Elastic.Clients } /// - /// Deletes a search application. + /// + /// Deletes a search application. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -128,7 +146,9 @@ public virtual Task DeleteAsync(Elastic.Clients } /// - /// Delete a behavioral analytics collection. + /// + /// Delete a behavioral analytics collection. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -139,7 +159,9 @@ public virtual DeleteBehavioralAnalyticsResponse DeleteBehavioralAnalytics(Delet } /// - /// Delete a behavioral analytics collection. + /// + /// Delete a behavioral analytics collection. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteBehavioralAnalyticsAsync(DeleteBehavioralAnalyticsRequest request, CancellationToken cancellationToken = default) @@ -149,7 +171,9 @@ public virtual Task DeleteBehavioralAnalytics } /// - /// Delete a behavioral analytics collection. + /// + /// Delete a behavioral analytics collection. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -160,7 +184,9 @@ public virtual DeleteBehavioralAnalyticsResponse DeleteBehavioralAnalytics(Delet } /// - /// Delete a behavioral analytics collection. + /// + /// Delete a behavioral analytics collection. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -172,7 +198,9 @@ public virtual DeleteBehavioralAnalyticsResponse DeleteBehavioralAnalytics(Elast } /// - /// Delete a behavioral analytics collection. + /// + /// Delete a behavioral analytics collection. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -185,7 +213,9 @@ public virtual DeleteBehavioralAnalyticsResponse DeleteBehavioralAnalytics(Elast } /// - /// Delete a behavioral analytics collection. + /// + /// Delete a behavioral analytics collection. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteBehavioralAnalyticsAsync(DeleteBehavioralAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -195,7 +225,9 @@ public virtual Task DeleteBehavioralAnalytics } /// - /// Delete a behavioral analytics collection. + /// + /// Delete a behavioral analytics collection. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteBehavioralAnalyticsAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) @@ -206,7 +238,9 @@ public virtual Task DeleteBehavioralAnalytics } /// - /// Delete a behavioral analytics collection. + /// + /// Delete a behavioral analytics collection. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteBehavioralAnalyticsAsync(Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -218,7 +252,9 @@ public virtual Task DeleteBehavioralAnalytics } /// - /// Returns the details about a search application + /// + /// Returns the details about a search application + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -229,7 +265,9 @@ public virtual GetSearchApplicationResponse Get(GetSearchApplicationRequest requ } /// - /// Returns the details about a search application + /// + /// Returns the details about a search application + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(GetSearchApplicationRequest request, CancellationToken cancellationToken = default) @@ -239,7 +277,9 @@ public virtual Task GetAsync(GetSearchApplicationR } /// - /// Returns the details about a search application + /// + /// Returns the details about a search application + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -250,7 +290,9 @@ public virtual GetSearchApplicationResponse Get(GetSearchApplicationRequestDescr } /// - /// Returns the details about a search application + /// + /// Returns the details about a search application + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -262,7 +304,9 @@ public virtual GetSearchApplicationResponse Get(Elastic.Clients.Elasticsearch.Na } /// - /// Returns the details about a search application + /// + /// Returns the details about a search application + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -275,7 +319,9 @@ public virtual GetSearchApplicationResponse Get(Elastic.Clients.Elasticsearch.Na } /// - /// Returns the details about a search application + /// + /// Returns the details about a search application + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(GetSearchApplicationRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -285,7 +331,9 @@ public virtual Task GetAsync(GetSearchApplicationR } /// - /// Returns the details about a search application + /// + /// Returns the details about a search application + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) @@ -296,7 +344,9 @@ public virtual Task GetAsync(Elastic.Clients.Elast } /// - /// Returns the details about a search application + /// + /// Returns the details about a search application + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -308,7 +358,9 @@ public virtual Task GetAsync(Elastic.Clients.Elast } /// - /// Returns the existing behavioral analytics collections. + /// + /// Returns the existing behavioral analytics collections. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -319,7 +371,9 @@ public virtual GetBehavioralAnalyticsResponse GetBehavioralAnalytics(GetBehavior } /// - /// Returns the existing behavioral analytics collections. + /// + /// Returns the existing behavioral analytics collections. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBehavioralAnalyticsAsync(GetBehavioralAnalyticsRequest request, CancellationToken cancellationToken = default) @@ -329,7 +383,9 @@ public virtual Task GetBehavioralAnalyticsAsync( } /// - /// Returns the existing behavioral analytics collections. + /// + /// Returns the existing behavioral analytics collections. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -340,7 +396,9 @@ public virtual GetBehavioralAnalyticsResponse GetBehavioralAnalytics(GetBehavior } /// - /// Returns the existing behavioral analytics collections. + /// + /// Returns the existing behavioral analytics collections. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -352,7 +410,9 @@ public virtual GetBehavioralAnalyticsResponse GetBehavioralAnalytics(IReadOnlyCo } /// - /// Returns the existing behavioral analytics collections. + /// + /// Returns the existing behavioral analytics collections. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -365,7 +425,9 @@ public virtual GetBehavioralAnalyticsResponse GetBehavioralAnalytics(IReadOnlyCo } /// - /// Returns the existing behavioral analytics collections. + /// + /// Returns the existing behavioral analytics collections. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -377,7 +439,9 @@ public virtual GetBehavioralAnalyticsResponse GetBehavioralAnalytics() } /// - /// Returns the existing behavioral analytics collections. + /// + /// Returns the existing behavioral analytics collections. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -390,7 +454,9 @@ public virtual GetBehavioralAnalyticsResponse GetBehavioralAnalytics(Action - /// Returns the existing behavioral analytics collections. + /// + /// Returns the existing behavioral analytics collections. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBehavioralAnalyticsAsync(GetBehavioralAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -400,7 +466,9 @@ public virtual Task GetBehavioralAnalyticsAsync( } /// - /// Returns the existing behavioral analytics collections. + /// + /// Returns the existing behavioral analytics collections. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBehavioralAnalyticsAsync(IReadOnlyCollection? name, CancellationToken cancellationToken = default) @@ -411,7 +479,9 @@ public virtual Task GetBehavioralAnalyticsAsync( } /// - /// Returns the existing behavioral analytics collections. + /// + /// Returns the existing behavioral analytics collections. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBehavioralAnalyticsAsync(IReadOnlyCollection? name, Action configureRequest, CancellationToken cancellationToken = default) @@ -423,7 +493,9 @@ public virtual Task GetBehavioralAnalyticsAsync( } /// - /// Returns the existing behavioral analytics collections. + /// + /// Returns the existing behavioral analytics collections. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBehavioralAnalyticsAsync(CancellationToken cancellationToken = default) @@ -434,7 +506,9 @@ public virtual Task GetBehavioralAnalyticsAsync( } /// - /// Returns the existing behavioral analytics collections. + /// + /// Returns the existing behavioral analytics collections. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetBehavioralAnalyticsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -446,7 +520,9 @@ public virtual Task GetBehavioralAnalyticsAsync( } /// - /// Returns the existing search applications. + /// + /// Returns the existing search applications. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -457,7 +533,9 @@ public virtual ListResponse List(ListRequest request) } /// - /// Returns the existing search applications. + /// + /// Returns the existing search applications. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ListAsync(ListRequest request, CancellationToken cancellationToken = default) @@ -467,7 +545,9 @@ public virtual Task ListAsync(ListRequest request, CancellationTok } /// - /// Returns the existing search applications. + /// + /// Returns the existing search applications. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -478,7 +558,9 @@ public virtual ListResponse List(ListRequestDescriptor descriptor) } /// - /// Returns the existing search applications. + /// + /// Returns the existing search applications. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -490,7 +572,9 @@ public virtual ListResponse List() } /// - /// Returns the existing search applications. + /// + /// Returns the existing search applications. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -503,7 +587,9 @@ public virtual ListResponse List(Action configureRequest) } /// - /// Returns the existing search applications. + /// + /// Returns the existing search applications. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ListAsync(ListRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -513,7 +599,9 @@ public virtual Task ListAsync(ListRequestDescriptor descriptor, Ca } /// - /// Returns the existing search applications. + /// + /// Returns the existing search applications. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ListAsync(CancellationToken cancellationToken = default) @@ -524,7 +612,9 @@ public virtual Task ListAsync(CancellationToken cancellationToken } /// - /// Returns the existing search applications. + /// + /// Returns the existing search applications. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ListAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -536,7 +626,9 @@ public virtual Task ListAsync(Action config } /// - /// Creates or updates a search application. + /// + /// Creates or updates a search application. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -547,7 +639,9 @@ public virtual PutSearchApplicationResponse Put(PutSearchApplicationRequest requ } /// - /// Creates or updates a search application. + /// + /// Creates or updates a search application. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAsync(PutSearchApplicationRequest request, CancellationToken cancellationToken = default) @@ -557,7 +651,9 @@ public virtual Task PutAsync(PutSearchApplicationR } /// - /// Creates or updates a search application. + /// + /// Creates or updates a search application. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -568,7 +664,9 @@ public virtual PutSearchApplicationResponse Put(PutSearchApplicationRequestDescr } /// - /// Creates or updates a search application. + /// + /// Creates or updates a search application. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -580,7 +678,9 @@ public virtual PutSearchApplicationResponse Put(Elastic.Clients.Elasticsearch.Se } /// - /// Creates or updates a search application. + /// + /// Creates or updates a search application. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -593,7 +693,9 @@ public virtual PutSearchApplicationResponse Put(Elastic.Clients.Elasticsearch.Se } /// - /// Creates or updates a search application. + /// + /// Creates or updates a search application. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAsync(PutSearchApplicationRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -603,7 +705,9 @@ public virtual Task PutAsync(PutSearchApplicationR } /// - /// Creates or updates a search application. + /// + /// Creates or updates a search application. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAsync(Elastic.Clients.Elasticsearch.SearchApplication.SearchApplication searchApplication, Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) @@ -614,7 +718,9 @@ public virtual Task PutAsync(Elastic.Clients.Elast } /// - /// Creates or updates a search application. + /// + /// Creates or updates a search application. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAsync(Elastic.Clients.Elasticsearch.SearchApplication.SearchApplication searchApplication, Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -626,7 +732,9 @@ public virtual Task PutAsync(Elastic.Clients.Elast } /// - /// Creates a behavioral analytics collection. + /// + /// Creates a behavioral analytics collection. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -637,7 +745,9 @@ public virtual PutBehavioralAnalyticsResponse PutBehavioralAnalytics(PutBehavior } /// - /// Creates a behavioral analytics collection. + /// + /// Creates a behavioral analytics collection. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutBehavioralAnalyticsAsync(PutBehavioralAnalyticsRequest request, CancellationToken cancellationToken = default) @@ -647,7 +757,9 @@ public virtual Task PutBehavioralAnalyticsAsync( } /// - /// Creates a behavioral analytics collection. + /// + /// Creates a behavioral analytics collection. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -658,7 +770,9 @@ public virtual PutBehavioralAnalyticsResponse PutBehavioralAnalytics(PutBehavior } /// - /// Creates a behavioral analytics collection. + /// + /// Creates a behavioral analytics collection. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -670,7 +784,9 @@ public virtual PutBehavioralAnalyticsResponse PutBehavioralAnalytics(Elastic.Cli } /// - /// Creates a behavioral analytics collection. + /// + /// Creates a behavioral analytics collection. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -683,7 +799,9 @@ public virtual PutBehavioralAnalyticsResponse PutBehavioralAnalytics(Elastic.Cli } /// - /// Creates a behavioral analytics collection. + /// + /// Creates a behavioral analytics collection. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutBehavioralAnalyticsAsync(PutBehavioralAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -693,7 +811,9 @@ public virtual Task PutBehavioralAnalyticsAsync( } /// - /// Creates a behavioral analytics collection. + /// + /// Creates a behavioral analytics collection. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutBehavioralAnalyticsAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) @@ -704,7 +824,9 @@ public virtual Task PutBehavioralAnalyticsAsync( } /// - /// Creates a behavioral analytics collection. + /// + /// Creates a behavioral analytics collection. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutBehavioralAnalyticsAsync(Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -716,7 +838,9 @@ public virtual Task PutBehavioralAnalyticsAsync( } /// - /// Perform a search against a search application. + /// + /// Perform a search against a search application. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -727,7 +851,9 @@ public virtual SearchApplicationSearchResponse Search(Sear } /// - /// Perform a search against a search application. + /// + /// Perform a search against a search application. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchAsync(SearchApplicationSearchRequest request, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.SearchableSnapshots.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.SearchableSnapshots.g.cs index 6d503c6adbd..945240c26f2 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.SearchableSnapshots.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.SearchableSnapshots.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.SearchableSnapshots; public partial class SearchableSnapshotsNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected SearchableSnapshotsNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal SearchableSnapshotsNamespacedClient(ElasticsearchClient client) : base( } /// - /// Retrieve node-level cache statistics about searchable snapshots. + /// + /// Retrieve node-level cache statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -49,7 +53,9 @@ public virtual CacheStatsResponse CacheStats(CacheStatsRequest request) } /// - /// Retrieve node-level cache statistics about searchable snapshots. + /// + /// Retrieve node-level cache statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CacheStatsAsync(CacheStatsRequest request, CancellationToken cancellationToken = default) @@ -59,7 +65,9 @@ public virtual Task CacheStatsAsync(CacheStatsRequest reques } /// - /// Retrieve node-level cache statistics about searchable snapshots. + /// + /// Retrieve node-level cache statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -70,7 +78,9 @@ public virtual CacheStatsResponse CacheStats(CacheStatsRequestDescriptor descrip } /// - /// Retrieve node-level cache statistics about searchable snapshots. + /// + /// Retrieve node-level cache statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -82,7 +92,9 @@ public virtual CacheStatsResponse CacheStats(Elastic.Clients.Elasticsearch.NodeI } /// - /// Retrieve node-level cache statistics about searchable snapshots. + /// + /// Retrieve node-level cache statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -95,7 +107,9 @@ public virtual CacheStatsResponse CacheStats(Elastic.Clients.Elasticsearch.NodeI } /// - /// Retrieve node-level cache statistics about searchable snapshots. + /// + /// Retrieve node-level cache statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -107,7 +121,9 @@ public virtual CacheStatsResponse CacheStats() } /// - /// Retrieve node-level cache statistics about searchable snapshots. + /// + /// Retrieve node-level cache statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -120,7 +136,9 @@ public virtual CacheStatsResponse CacheStats(Action } /// - /// Retrieve node-level cache statistics about searchable snapshots. + /// + /// Retrieve node-level cache statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CacheStatsAsync(CacheStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -130,7 +148,9 @@ public virtual Task CacheStatsAsync(CacheStatsRequestDescrip } /// - /// Retrieve node-level cache statistics about searchable snapshots. + /// + /// Retrieve node-level cache statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CacheStatsAsync(Elastic.Clients.Elasticsearch.NodeIds? nodeId, CancellationToken cancellationToken = default) @@ -141,7 +161,9 @@ public virtual Task CacheStatsAsync(Elastic.Clients.Elastics } /// - /// Retrieve node-level cache statistics about searchable snapshots. + /// + /// Retrieve node-level cache statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CacheStatsAsync(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Action configureRequest, CancellationToken cancellationToken = default) @@ -153,7 +175,9 @@ public virtual Task CacheStatsAsync(Elastic.Clients.Elastics } /// - /// Retrieve node-level cache statistics about searchable snapshots. + /// + /// Retrieve node-level cache statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CacheStatsAsync(CancellationToken cancellationToken = default) @@ -164,7 +188,9 @@ public virtual Task CacheStatsAsync(CancellationToken cancel } /// - /// Retrieve node-level cache statistics about searchable snapshots. + /// + /// Retrieve node-level cache statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CacheStatsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -176,7 +202,9 @@ public virtual Task CacheStatsAsync(Action - /// Clear the cache of searchable snapshots. + /// + /// Clear the cache of searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -187,7 +215,9 @@ public virtual ClearCacheResponse ClearCache(ClearCacheRequest request) } /// - /// Clear the cache of searchable snapshots. + /// + /// Clear the cache of searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(ClearCacheRequest request, CancellationToken cancellationToken = default) @@ -197,7 +227,9 @@ public virtual Task ClearCacheAsync(ClearCacheRequest reques } /// - /// Clear the cache of searchable snapshots. + /// + /// Clear the cache of searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -208,7 +240,9 @@ public virtual ClearCacheResponse ClearCache(ClearCacheRequestDescrip } /// - /// Clear the cache of searchable snapshots. + /// + /// Clear the cache of searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -220,7 +254,9 @@ public virtual ClearCacheResponse ClearCache(Elastic.Clients.Elastics } /// - /// Clear the cache of searchable snapshots. + /// + /// Clear the cache of searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -233,7 +269,9 @@ public virtual ClearCacheResponse ClearCache(Elastic.Clients.Elastics } /// - /// Clear the cache of searchable snapshots. + /// + /// Clear the cache of searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -245,7 +283,9 @@ public virtual ClearCacheResponse ClearCache() } /// - /// Clear the cache of searchable snapshots. + /// + /// Clear the cache of searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -258,7 +298,9 @@ public virtual ClearCacheResponse ClearCache(Action - /// Clear the cache of searchable snapshots. + /// + /// Clear the cache of searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -269,7 +311,9 @@ public virtual ClearCacheResponse ClearCache(ClearCacheRequestDescriptor descrip } /// - /// Clear the cache of searchable snapshots. + /// + /// Clear the cache of searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -281,7 +325,9 @@ public virtual ClearCacheResponse ClearCache(Elastic.Clients.Elasticsearch.Indic } /// - /// Clear the cache of searchable snapshots. + /// + /// Clear the cache of searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -294,7 +340,9 @@ public virtual ClearCacheResponse ClearCache(Elastic.Clients.Elasticsearch.Indic } /// - /// Clear the cache of searchable snapshots. + /// + /// Clear the cache of searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -306,7 +354,9 @@ public virtual ClearCacheResponse ClearCache() } /// - /// Clear the cache of searchable snapshots. + /// + /// Clear the cache of searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -319,7 +369,9 @@ public virtual ClearCacheResponse ClearCache(Action } /// - /// Clear the cache of searchable snapshots. + /// + /// Clear the cache of searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(ClearCacheRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -329,7 +381,9 @@ public virtual Task ClearCacheAsync(ClearCacheReq } /// - /// Clear the cache of searchable snapshots. + /// + /// Clear the cache of searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -340,7 +394,9 @@ public virtual Task ClearCacheAsync(Elastic.Clien } /// - /// Clear the cache of searchable snapshots. + /// + /// Clear the cache of searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -352,7 +408,9 @@ public virtual Task ClearCacheAsync(Elastic.Clien } /// - /// Clear the cache of searchable snapshots. + /// + /// Clear the cache of searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(CancellationToken cancellationToken = default) @@ -363,7 +421,9 @@ public virtual Task ClearCacheAsync(CancellationT } /// - /// Clear the cache of searchable snapshots. + /// + /// Clear the cache of searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -375,7 +435,9 @@ public virtual Task ClearCacheAsync(Action - /// Clear the cache of searchable snapshots. + /// + /// Clear the cache of searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(ClearCacheRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -385,7 +447,9 @@ public virtual Task ClearCacheAsync(ClearCacheRequestDescrip } /// - /// Clear the cache of searchable snapshots. + /// + /// Clear the cache of searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -396,7 +460,9 @@ public virtual Task ClearCacheAsync(Elastic.Clients.Elastics } /// - /// Clear the cache of searchable snapshots. + /// + /// Clear the cache of searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -408,7 +474,9 @@ public virtual Task ClearCacheAsync(Elastic.Clients.Elastics } /// - /// Clear the cache of searchable snapshots. + /// + /// Clear the cache of searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(CancellationToken cancellationToken = default) @@ -419,7 +487,9 @@ public virtual Task ClearCacheAsync(CancellationToken cancel } /// - /// Clear the cache of searchable snapshots. + /// + /// Clear the cache of searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCacheAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -431,7 +501,9 @@ public virtual Task ClearCacheAsync(Action - /// Mount a snapshot as a searchable index. + /// + /// Mount a snapshot as a searchable index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -442,7 +514,9 @@ public virtual MountResponse Mount(MountRequest request) } /// - /// Mount a snapshot as a searchable index. + /// + /// Mount a snapshot as a searchable index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MountAsync(MountRequest request, CancellationToken cancellationToken = default) @@ -452,7 +526,9 @@ public virtual Task MountAsync(MountRequest request, Cancellation } /// - /// Mount a snapshot as a searchable index. + /// + /// Mount a snapshot as a searchable index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -463,7 +539,9 @@ public virtual MountResponse Mount(MountRequestDescriptor descriptor) } /// - /// Mount a snapshot as a searchable index. + /// + /// Mount a snapshot as a searchable index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -475,7 +553,9 @@ public virtual MountResponse Mount(Elastic.Clients.Elasticsearch.Name repository } /// - /// Mount a snapshot as a searchable index. + /// + /// Mount a snapshot as a searchable index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -488,7 +568,9 @@ public virtual MountResponse Mount(Elastic.Clients.Elasticsearch.Name repository } /// - /// Mount a snapshot as a searchable index. + /// + /// Mount a snapshot as a searchable index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MountAsync(MountRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -498,7 +580,9 @@ public virtual Task MountAsync(MountRequestDescriptor descriptor, } /// - /// Mount a snapshot as a searchable index. + /// + /// Mount a snapshot as a searchable index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MountAsync(Elastic.Clients.Elasticsearch.Name repository, Elastic.Clients.Elasticsearch.Name snapshot, CancellationToken cancellationToken = default) @@ -509,7 +593,9 @@ public virtual Task MountAsync(Elastic.Clients.Elasticsearch.Name } /// - /// Mount a snapshot as a searchable index. + /// + /// Mount a snapshot as a searchable index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MountAsync(Elastic.Clients.Elasticsearch.Name repository, Elastic.Clients.Elasticsearch.Name snapshot, Action configureRequest, CancellationToken cancellationToken = default) @@ -521,7 +607,9 @@ public virtual Task MountAsync(Elastic.Clients.Elasticsearch.Name } /// - /// Retrieve shard-level statistics about searchable snapshots. + /// + /// Retrieve shard-level statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -532,7 +620,9 @@ public virtual SearchableSnapshotsStatsResponse Stats(SearchableSnapshotsStatsRe } /// - /// Retrieve shard-level statistics about searchable snapshots. + /// + /// Retrieve shard-level statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(SearchableSnapshotsStatsRequest request, CancellationToken cancellationToken = default) @@ -542,7 +632,9 @@ public virtual Task StatsAsync(SearchableSnaps } /// - /// Retrieve shard-level statistics about searchable snapshots. + /// + /// Retrieve shard-level statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -553,7 +645,9 @@ public virtual SearchableSnapshotsStatsResponse Stats(SearchableSnaps } /// - /// Retrieve shard-level statistics about searchable snapshots. + /// + /// Retrieve shard-level statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -565,7 +659,9 @@ public virtual SearchableSnapshotsStatsResponse Stats(Elastic.Clients } /// - /// Retrieve shard-level statistics about searchable snapshots. + /// + /// Retrieve shard-level statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -578,7 +674,9 @@ public virtual SearchableSnapshotsStatsResponse Stats(Elastic.Clients } /// - /// Retrieve shard-level statistics about searchable snapshots. + /// + /// Retrieve shard-level statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -590,7 +688,9 @@ public virtual SearchableSnapshotsStatsResponse Stats() } /// - /// Retrieve shard-level statistics about searchable snapshots. + /// + /// Retrieve shard-level statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -603,7 +703,9 @@ public virtual SearchableSnapshotsStatsResponse Stats(Action - /// Retrieve shard-level statistics about searchable snapshots. + /// + /// Retrieve shard-level statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -614,7 +716,9 @@ public virtual SearchableSnapshotsStatsResponse Stats(SearchableSnapshotsStatsRe } /// - /// Retrieve shard-level statistics about searchable snapshots. + /// + /// Retrieve shard-level statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -626,7 +730,9 @@ public virtual SearchableSnapshotsStatsResponse Stats(Elastic.Clients.Elasticsea } /// - /// Retrieve shard-level statistics about searchable snapshots. + /// + /// Retrieve shard-level statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -639,7 +745,9 @@ public virtual SearchableSnapshotsStatsResponse Stats(Elastic.Clients.Elasticsea } /// - /// Retrieve shard-level statistics about searchable snapshots. + /// + /// Retrieve shard-level statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -651,7 +759,9 @@ public virtual SearchableSnapshotsStatsResponse Stats() } /// - /// Retrieve shard-level statistics about searchable snapshots. + /// + /// Retrieve shard-level statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -664,7 +774,9 @@ public virtual SearchableSnapshotsStatsResponse Stats(Action - /// Retrieve shard-level statistics about searchable snapshots. + /// + /// Retrieve shard-level statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(SearchableSnapshotsStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -674,7 +786,9 @@ public virtual Task StatsAsync(Sear } /// - /// Retrieve shard-level statistics about searchable snapshots. + /// + /// Retrieve shard-level statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -685,7 +799,9 @@ public virtual Task StatsAsync(Elas } /// - /// Retrieve shard-level statistics about searchable snapshots. + /// + /// Retrieve shard-level statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -697,7 +813,9 @@ public virtual Task StatsAsync(Elas } /// - /// Retrieve shard-level statistics about searchable snapshots. + /// + /// Retrieve shard-level statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(CancellationToken cancellationToken = default) @@ -708,7 +826,9 @@ public virtual Task StatsAsync(Canc } /// - /// Retrieve shard-level statistics about searchable snapshots. + /// + /// Retrieve shard-level statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -720,7 +840,9 @@ public virtual Task StatsAsync(Acti } /// - /// Retrieve shard-level statistics about searchable snapshots. + /// + /// Retrieve shard-level statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(SearchableSnapshotsStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -730,7 +852,9 @@ public virtual Task StatsAsync(SearchableSnaps } /// - /// Retrieve shard-level statistics about searchable snapshots. + /// + /// Retrieve shard-level statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -741,7 +865,9 @@ public virtual Task StatsAsync(Elastic.Clients } /// - /// Retrieve shard-level statistics about searchable snapshots. + /// + /// Retrieve shard-level statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -753,7 +879,9 @@ public virtual Task StatsAsync(Elastic.Clients } /// - /// Retrieve shard-level statistics about searchable snapshots. + /// + /// Retrieve shard-level statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(CancellationToken cancellationToken = default) @@ -764,7 +892,9 @@ public virtual Task StatsAsync(CancellationTok } /// - /// Retrieve shard-level statistics about searchable snapshots. + /// + /// Retrieve shard-level statistics about searchable snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Slm.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Slm.g.cs index 672404b2111..04763164837 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Slm.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Slm.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.SnapshotLifecycleManagement; public partial class SnapshotLifecycleManagementNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected SnapshotLifecycleManagementNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal SnapshotLifecycleManagementNamespacedClient(ElasticsearchClient client) } /// - /// Deletes an existing snapshot lifecycle policy. + /// + /// Deletes an existing snapshot lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -49,7 +53,9 @@ public virtual DeleteLifecycleResponse DeleteLifecycle(DeleteLifecycleRequest re } /// - /// Deletes an existing snapshot lifecycle policy. + /// + /// Deletes an existing snapshot lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteLifecycleAsync(DeleteLifecycleRequest request, CancellationToken cancellationToken = default) @@ -59,7 +65,9 @@ public virtual Task DeleteLifecycleAsync(DeleteLifecycl } /// - /// Deletes an existing snapshot lifecycle policy. + /// + /// Deletes an existing snapshot lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -70,7 +78,9 @@ public virtual DeleteLifecycleResponse DeleteLifecycle(DeleteLifecycleRequestDes } /// - /// Deletes an existing snapshot lifecycle policy. + /// + /// Deletes an existing snapshot lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -82,7 +92,9 @@ public virtual DeleteLifecycleResponse DeleteLifecycle(Elastic.Clients.Elasticse } /// - /// Deletes an existing snapshot lifecycle policy. + /// + /// Deletes an existing snapshot lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -95,7 +107,9 @@ public virtual DeleteLifecycleResponse DeleteLifecycle(Elastic.Clients.Elasticse } /// - /// Deletes an existing snapshot lifecycle policy. + /// + /// Deletes an existing snapshot lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteLifecycleAsync(DeleteLifecycleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -105,7 +119,9 @@ public virtual Task DeleteLifecycleAsync(DeleteLifecycl } /// - /// Deletes an existing snapshot lifecycle policy. + /// + /// Deletes an existing snapshot lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteLifecycleAsync(Elastic.Clients.Elasticsearch.Name policyId, CancellationToken cancellationToken = default) @@ -116,7 +132,9 @@ public virtual Task DeleteLifecycleAsync(Elastic.Client } /// - /// Deletes an existing snapshot lifecycle policy. + /// + /// Deletes an existing snapshot lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteLifecycleAsync(Elastic.Clients.Elasticsearch.Name policyId, Action configureRequest, CancellationToken cancellationToken = default) @@ -128,7 +146,9 @@ public virtual Task DeleteLifecycleAsync(Elastic.Client } /// - /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// + /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -139,7 +159,9 @@ public virtual ExecuteLifecycleResponse ExecuteLifecycle(ExecuteLifecycleRequest } /// - /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// + /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExecuteLifecycleAsync(ExecuteLifecycleRequest request, CancellationToken cancellationToken = default) @@ -149,7 +171,9 @@ public virtual Task ExecuteLifecycleAsync(ExecuteLifec } /// - /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// + /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -160,7 +184,9 @@ public virtual ExecuteLifecycleResponse ExecuteLifecycle(ExecuteLifecycleRequest } /// - /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// + /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -172,7 +198,9 @@ public virtual ExecuteLifecycleResponse ExecuteLifecycle(Elastic.Clients.Elastic } /// - /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// + /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -185,7 +213,9 @@ public virtual ExecuteLifecycleResponse ExecuteLifecycle(Elastic.Clients.Elastic } /// - /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// + /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExecuteLifecycleAsync(ExecuteLifecycleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -195,7 +225,9 @@ public virtual Task ExecuteLifecycleAsync(ExecuteLifec } /// - /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// + /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExecuteLifecycleAsync(Elastic.Clients.Elasticsearch.Name policyId, CancellationToken cancellationToken = default) @@ -206,7 +238,9 @@ public virtual Task ExecuteLifecycleAsync(Elastic.Clie } /// - /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// + /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExecuteLifecycleAsync(Elastic.Clients.Elasticsearch.Name policyId, Action configureRequest, CancellationToken cancellationToken = default) @@ -218,7 +252,9 @@ public virtual Task ExecuteLifecycleAsync(Elastic.Clie } /// - /// Deletes any snapshots that are expired according to the policy's retention rules. + /// + /// Deletes any snapshots that are expired according to the policy's retention rules. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -229,7 +265,9 @@ public virtual ExecuteRetentionResponse ExecuteRetention(ExecuteRetentionRequest } /// - /// Deletes any snapshots that are expired according to the policy's retention rules. + /// + /// Deletes any snapshots that are expired according to the policy's retention rules. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExecuteRetentionAsync(ExecuteRetentionRequest request, CancellationToken cancellationToken = default) @@ -239,7 +277,9 @@ public virtual Task ExecuteRetentionAsync(ExecuteReten } /// - /// Deletes any snapshots that are expired according to the policy's retention rules. + /// + /// Deletes any snapshots that are expired according to the policy's retention rules. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -250,7 +290,9 @@ public virtual ExecuteRetentionResponse ExecuteRetention(ExecuteRetentionRequest } /// - /// Deletes any snapshots that are expired according to the policy's retention rules. + /// + /// Deletes any snapshots that are expired according to the policy's retention rules. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -262,7 +304,9 @@ public virtual ExecuteRetentionResponse ExecuteRetention() } /// - /// Deletes any snapshots that are expired according to the policy's retention rules. + /// + /// Deletes any snapshots that are expired according to the policy's retention rules. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -275,7 +319,9 @@ public virtual ExecuteRetentionResponse ExecuteRetention(Action - /// Deletes any snapshots that are expired according to the policy's retention rules. + /// + /// Deletes any snapshots that are expired according to the policy's retention rules. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExecuteRetentionAsync(ExecuteRetentionRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -285,7 +331,9 @@ public virtual Task ExecuteRetentionAsync(ExecuteReten } /// - /// Deletes any snapshots that are expired according to the policy's retention rules. + /// + /// Deletes any snapshots that are expired according to the policy's retention rules. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExecuteRetentionAsync(CancellationToken cancellationToken = default) @@ -296,7 +344,9 @@ public virtual Task ExecuteRetentionAsync(Cancellation } /// - /// Deletes any snapshots that are expired according to the policy's retention rules. + /// + /// Deletes any snapshots that are expired according to the policy's retention rules. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExecuteRetentionAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -308,7 +358,9 @@ public virtual Task ExecuteRetentionAsync(Action - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// + /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -319,7 +371,9 @@ public virtual GetLifecycleResponse GetLifecycle(GetLifecycleRequest request) } /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// + /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetLifecycleAsync(GetLifecycleRequest request, CancellationToken cancellationToken = default) @@ -329,7 +383,9 @@ public virtual Task GetLifecycleAsync(GetLifecycleRequest } /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// + /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -340,7 +396,9 @@ public virtual GetLifecycleResponse GetLifecycle(GetLifecycleRequestDescriptor d } /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// + /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -352,7 +410,9 @@ public virtual GetLifecycleResponse GetLifecycle(Elastic.Clients.Elasticsearch.N } /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// + /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -365,7 +425,9 @@ public virtual GetLifecycleResponse GetLifecycle(Elastic.Clients.Elasticsearch.N } /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// + /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -377,7 +439,9 @@ public virtual GetLifecycleResponse GetLifecycle() } /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// + /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -390,7 +454,9 @@ public virtual GetLifecycleResponse GetLifecycle(Action - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// + /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetLifecycleAsync(GetLifecycleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -400,7 +466,9 @@ public virtual Task GetLifecycleAsync(GetLifecycleRequestD } /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// + /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetLifecycleAsync(Elastic.Clients.Elasticsearch.Names? policyId, CancellationToken cancellationToken = default) @@ -411,7 +479,9 @@ public virtual Task GetLifecycleAsync(Elastic.Clients.Elas } /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// + /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetLifecycleAsync(Elastic.Clients.Elasticsearch.Names? policyId, Action configureRequest, CancellationToken cancellationToken = default) @@ -423,7 +493,9 @@ public virtual Task GetLifecycleAsync(Elastic.Clients.Elas } /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// + /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetLifecycleAsync(CancellationToken cancellationToken = default) @@ -434,7 +506,9 @@ public virtual Task GetLifecycleAsync(CancellationToken ca } /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// + /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetLifecycleAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -446,7 +520,9 @@ public virtual Task GetLifecycleAsync(Action - /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// + /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -457,7 +533,9 @@ public virtual GetStatsResponse GetStats(GetStatsRequest request) } /// - /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// + /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatsAsync(GetStatsRequest request, CancellationToken cancellationToken = default) @@ -467,7 +545,9 @@ public virtual Task GetStatsAsync(GetStatsRequest request, Can } /// - /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// + /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -478,7 +558,9 @@ public virtual GetStatsResponse GetStats(GetStatsRequestDescriptor descriptor) } /// - /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// + /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -490,7 +572,9 @@ public virtual GetStatsResponse GetStats() } /// - /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// + /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -503,7 +587,9 @@ public virtual GetStatsResponse GetStats(Action confi } /// - /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// + /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatsAsync(GetStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -513,7 +599,9 @@ public virtual Task GetStatsAsync(GetStatsRequestDescriptor de } /// - /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// + /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatsAsync(CancellationToken cancellationToken = default) @@ -524,7 +612,9 @@ public virtual Task GetStatsAsync(CancellationToken cancellati } /// - /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// + /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -536,7 +626,9 @@ public virtual Task GetStatsAsync(Action - /// Retrieves the status of snapshot lifecycle management (SLM). + /// + /// Retrieves the status of snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -547,7 +639,9 @@ public virtual GetSlmStatusResponse GetStatus(GetSlmStatusRequest request) } /// - /// Retrieves the status of snapshot lifecycle management (SLM). + /// + /// Retrieves the status of snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(GetSlmStatusRequest request, CancellationToken cancellationToken = default) @@ -557,7 +651,9 @@ public virtual Task GetStatusAsync(GetSlmStatusRequest req } /// - /// Retrieves the status of snapshot lifecycle management (SLM). + /// + /// Retrieves the status of snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -568,7 +664,9 @@ public virtual GetSlmStatusResponse GetStatus(GetSlmStatusRequestDescriptor desc } /// - /// Retrieves the status of snapshot lifecycle management (SLM). + /// + /// Retrieves the status of snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -580,7 +678,9 @@ public virtual GetSlmStatusResponse GetStatus() } /// - /// Retrieves the status of snapshot lifecycle management (SLM). + /// + /// Retrieves the status of snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -593,7 +693,9 @@ public virtual GetSlmStatusResponse GetStatus(Action - /// Retrieves the status of snapshot lifecycle management (SLM). + /// + /// Retrieves the status of snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(GetSlmStatusRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -603,7 +705,9 @@ public virtual Task GetStatusAsync(GetSlmStatusRequestDesc } /// - /// Retrieves the status of snapshot lifecycle management (SLM). + /// + /// Retrieves the status of snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(CancellationToken cancellationToken = default) @@ -614,7 +718,9 @@ public virtual Task GetStatusAsync(CancellationToken cance } /// - /// Retrieves the status of snapshot lifecycle management (SLM). + /// + /// Retrieves the status of snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -626,7 +732,9 @@ public virtual Task GetStatusAsync(Action - /// Creates or updates a snapshot lifecycle policy. + /// + /// Creates or updates a snapshot lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -637,7 +745,9 @@ public virtual PutLifecycleResponse PutLifecycle(PutLifecycleRequest request) } /// - /// Creates or updates a snapshot lifecycle policy. + /// + /// Creates or updates a snapshot lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutLifecycleAsync(PutLifecycleRequest request, CancellationToken cancellationToken = default) @@ -647,7 +757,9 @@ public virtual Task PutLifecycleAsync(PutLifecycleRequest } /// - /// Creates or updates a snapshot lifecycle policy. + /// + /// Creates or updates a snapshot lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -658,7 +770,9 @@ public virtual PutLifecycleResponse PutLifecycle(PutLifecycleRequestDescriptor d } /// - /// Creates or updates a snapshot lifecycle policy. + /// + /// Creates or updates a snapshot lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -670,7 +784,9 @@ public virtual PutLifecycleResponse PutLifecycle(Elastic.Clients.Elasticsearch.N } /// - /// Creates or updates a snapshot lifecycle policy. + /// + /// Creates or updates a snapshot lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -683,7 +799,9 @@ public virtual PutLifecycleResponse PutLifecycle(Elastic.Clients.Elasticsearch.N } /// - /// Creates or updates a snapshot lifecycle policy. + /// + /// Creates or updates a snapshot lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutLifecycleAsync(PutLifecycleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -693,7 +811,9 @@ public virtual Task PutLifecycleAsync(PutLifecycleRequestD } /// - /// Creates or updates a snapshot lifecycle policy. + /// + /// Creates or updates a snapshot lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutLifecycleAsync(Elastic.Clients.Elasticsearch.Name policyId, CancellationToken cancellationToken = default) @@ -704,7 +824,9 @@ public virtual Task PutLifecycleAsync(Elastic.Clients.Elas } /// - /// Creates or updates a snapshot lifecycle policy. + /// + /// Creates or updates a snapshot lifecycle policy. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutLifecycleAsync(Elastic.Clients.Elasticsearch.Name policyId, Action configureRequest, CancellationToken cancellationToken = default) @@ -716,7 +838,9 @@ public virtual Task PutLifecycleAsync(Elastic.Clients.Elas } /// - /// Turns on snapshot lifecycle management (SLM). + /// + /// Turns on snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -727,7 +851,9 @@ public virtual StartSlmResponse Start(StartSlmRequest request) } /// - /// Turns on snapshot lifecycle management (SLM). + /// + /// Turns on snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartAsync(StartSlmRequest request, CancellationToken cancellationToken = default) @@ -737,7 +863,9 @@ public virtual Task StartAsync(StartSlmRequest request, Cancel } /// - /// Turns on snapshot lifecycle management (SLM). + /// + /// Turns on snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -748,7 +876,9 @@ public virtual StartSlmResponse Start(StartSlmRequestDescriptor descriptor) } /// - /// Turns on snapshot lifecycle management (SLM). + /// + /// Turns on snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -760,7 +890,9 @@ public virtual StartSlmResponse Start() } /// - /// Turns on snapshot lifecycle management (SLM). + /// + /// Turns on snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -773,7 +905,9 @@ public virtual StartSlmResponse Start(Action configur } /// - /// Turns on snapshot lifecycle management (SLM). + /// + /// Turns on snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartAsync(StartSlmRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -783,7 +917,9 @@ public virtual Task StartAsync(StartSlmRequestDescriptor descr } /// - /// Turns on snapshot lifecycle management (SLM). + /// + /// Turns on snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartAsync(CancellationToken cancellationToken = default) @@ -794,7 +930,9 @@ public virtual Task StartAsync(CancellationToken cancellationT } /// - /// Turns on snapshot lifecycle management (SLM). + /// + /// Turns on snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -806,7 +944,9 @@ public virtual Task StartAsync(Action - /// Turns off snapshot lifecycle management (SLM). + /// + /// Turns off snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -817,7 +957,9 @@ public virtual StopSlmResponse Stop(StopSlmRequest request) } /// - /// Turns off snapshot lifecycle management (SLM). + /// + /// Turns off snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopAsync(StopSlmRequest request, CancellationToken cancellationToken = default) @@ -827,7 +969,9 @@ public virtual Task StopAsync(StopSlmRequest request, Cancellat } /// - /// Turns off snapshot lifecycle management (SLM). + /// + /// Turns off snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -838,7 +982,9 @@ public virtual StopSlmResponse Stop(StopSlmRequestDescriptor descriptor) } /// - /// Turns off snapshot lifecycle management (SLM). + /// + /// Turns off snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -850,7 +996,9 @@ public virtual StopSlmResponse Stop() } /// - /// Turns off snapshot lifecycle management (SLM). + /// + /// Turns off snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -863,7 +1011,9 @@ public virtual StopSlmResponse Stop(Action configureRe } /// - /// Turns off snapshot lifecycle management (SLM). + /// + /// Turns off snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopAsync(StopSlmRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -873,7 +1023,9 @@ public virtual Task StopAsync(StopSlmRequestDescriptor descript } /// - /// Turns off snapshot lifecycle management (SLM). + /// + /// Turns off snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopAsync(CancellationToken cancellationToken = default) @@ -884,7 +1036,9 @@ public virtual Task StopAsync(CancellationToken cancellationTok } /// - /// Turns off snapshot lifecycle management (SLM). + /// + /// Turns off snapshot lifecycle management (SLM). + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopAsync(Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Snapshot.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Snapshot.g.cs index 3e63779df81..cc63541ea80 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Snapshot.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Snapshot.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Snapshot; public partial class SnapshotNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected SnapshotNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal SnapshotNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// + /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -49,7 +53,9 @@ public virtual CleanupRepositoryResponse CleanupRepository(CleanupRepositoryRequ } /// - /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// + /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CleanupRepositoryAsync(CleanupRepositoryRequest request, CancellationToken cancellationToken = default) @@ -59,7 +65,9 @@ public virtual Task CleanupRepositoryAsync(CleanupRep } /// - /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// + /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -70,7 +78,9 @@ public virtual CleanupRepositoryResponse CleanupRepository(CleanupRepositoryRequ } /// - /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// + /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -82,7 +92,9 @@ public virtual CleanupRepositoryResponse CleanupRepository(Elastic.Clients.Elast } /// - /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// + /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -95,7 +107,9 @@ public virtual CleanupRepositoryResponse CleanupRepository(Elastic.Clients.Elast } /// - /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// + /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CleanupRepositoryAsync(CleanupRepositoryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -105,7 +119,9 @@ public virtual Task CleanupRepositoryAsync(CleanupRep } /// - /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// + /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CleanupRepositoryAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) @@ -116,7 +132,9 @@ public virtual Task CleanupRepositoryAsync(Elastic.Cl } /// - /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// + /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CleanupRepositoryAsync(Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -128,7 +146,9 @@ public virtual Task CleanupRepositoryAsync(Elastic.Cl } /// - /// Clones indices from one snapshot into another snapshot in the same repository. + /// + /// Clones indices from one snapshot into another snapshot in the same repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -139,7 +159,9 @@ public virtual CloneSnapshotResponse Clone(CloneSnapshotRequest request) } /// - /// Clones indices from one snapshot into another snapshot in the same repository. + /// + /// Clones indices from one snapshot into another snapshot in the same repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloneAsync(CloneSnapshotRequest request, CancellationToken cancellationToken = default) @@ -149,7 +171,9 @@ public virtual Task CloneAsync(CloneSnapshotRequest reque } /// - /// Clones indices from one snapshot into another snapshot in the same repository. + /// + /// Clones indices from one snapshot into another snapshot in the same repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -160,7 +184,9 @@ public virtual CloneSnapshotResponse Clone(CloneSnapshotRequestDescriptor descri } /// - /// Clones indices from one snapshot into another snapshot in the same repository. + /// + /// Clones indices from one snapshot into another snapshot in the same repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -172,7 +198,9 @@ public virtual CloneSnapshotResponse Clone(Elastic.Clients.Elasticsearch.Name re } /// - /// Clones indices from one snapshot into another snapshot in the same repository. + /// + /// Clones indices from one snapshot into another snapshot in the same repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -185,7 +213,9 @@ public virtual CloneSnapshotResponse Clone(Elastic.Clients.Elasticsearch.Name re } /// - /// Clones indices from one snapshot into another snapshot in the same repository. + /// + /// Clones indices from one snapshot into another snapshot in the same repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloneAsync(CloneSnapshotRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -195,7 +225,9 @@ public virtual Task CloneAsync(CloneSnapshotRequestDescri } /// - /// Clones indices from one snapshot into another snapshot in the same repository. + /// + /// Clones indices from one snapshot into another snapshot in the same repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloneAsync(Elastic.Clients.Elasticsearch.Name repository, Elastic.Clients.Elasticsearch.Name snapshot, Elastic.Clients.Elasticsearch.Name targetSnapshot, CancellationToken cancellationToken = default) @@ -206,7 +238,9 @@ public virtual Task CloneAsync(Elastic.Clients.Elasticsea } /// - /// Clones indices from one snapshot into another snapshot in the same repository. + /// + /// Clones indices from one snapshot into another snapshot in the same repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloneAsync(Elastic.Clients.Elasticsearch.Name repository, Elastic.Clients.Elasticsearch.Name snapshot, Elastic.Clients.Elasticsearch.Name targetSnapshot, Action configureRequest, CancellationToken cancellationToken = default) @@ -218,7 +252,9 @@ public virtual Task CloneAsync(Elastic.Clients.Elasticsea } /// - /// Creates a snapshot in a repository. + /// + /// Creates a snapshot in a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -229,7 +265,9 @@ public virtual CreateSnapshotResponse Create(CreateSnapshotRequest request) } /// - /// Creates a snapshot in a repository. + /// + /// Creates a snapshot in a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(CreateSnapshotRequest request, CancellationToken cancellationToken = default) @@ -239,7 +277,9 @@ public virtual Task CreateAsync(CreateSnapshotRequest re } /// - /// Creates a snapshot in a repository. + /// + /// Creates a snapshot in a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -250,7 +290,9 @@ public virtual CreateSnapshotResponse Create(CreateSnapshotRequestDescriptor des } /// - /// Creates a snapshot in a repository. + /// + /// Creates a snapshot in a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -262,7 +304,9 @@ public virtual CreateSnapshotResponse Create(Elastic.Clients.Elasticsearch.Name } /// - /// Creates a snapshot in a repository. + /// + /// Creates a snapshot in a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -275,7 +319,9 @@ public virtual CreateSnapshotResponse Create(Elastic.Clients.Elasticsearch.Name } /// - /// Creates a snapshot in a repository. + /// + /// Creates a snapshot in a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(CreateSnapshotRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -285,7 +331,9 @@ public virtual Task CreateAsync(CreateSnapshotRequestDes } /// - /// Creates a snapshot in a repository. + /// + /// Creates a snapshot in a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(Elastic.Clients.Elasticsearch.Name repository, Elastic.Clients.Elasticsearch.Name snapshot, CancellationToken cancellationToken = default) @@ -296,7 +344,9 @@ public virtual Task CreateAsync(Elastic.Clients.Elastics } /// - /// Creates a snapshot in a repository. + /// + /// Creates a snapshot in a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(Elastic.Clients.Elasticsearch.Name repository, Elastic.Clients.Elasticsearch.Name snapshot, Action configureRequest, CancellationToken cancellationToken = default) @@ -308,7 +358,9 @@ public virtual Task CreateAsync(Elastic.Clients.Elastics } /// - /// Creates a repository. + /// + /// Creates a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -319,7 +371,9 @@ public virtual CreateRepositoryResponse CreateRepository(CreateRepositoryRequest } /// - /// Creates a repository. + /// + /// Creates a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateRepositoryAsync(CreateRepositoryRequest request, CancellationToken cancellationToken = default) @@ -329,7 +383,9 @@ public virtual Task CreateRepositoryAsync(CreateReposi } /// - /// Creates a repository. + /// + /// Creates a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -340,7 +396,9 @@ public virtual CreateRepositoryResponse CreateRepository(CreateRepositoryRequest } /// - /// Creates a repository. + /// + /// Creates a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -352,7 +410,9 @@ public virtual CreateRepositoryResponse CreateRepository(Elastic.Clients.Elastic } /// - /// Creates a repository. + /// + /// Creates a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -365,7 +425,9 @@ public virtual CreateRepositoryResponse CreateRepository(Elastic.Clients.Elastic } /// - /// Creates a repository. + /// + /// Creates a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateRepositoryAsync(CreateRepositoryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -375,7 +437,9 @@ public virtual Task CreateRepositoryAsync(CreateReposi } /// - /// Creates a repository. + /// + /// Creates a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateRepositoryAsync(Elastic.Clients.Elasticsearch.Snapshot.IRepository repository, Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) @@ -386,7 +450,9 @@ public virtual Task CreateRepositoryAsync(Elastic.Clie } /// - /// Creates a repository. + /// + /// Creates a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateRepositoryAsync(Elastic.Clients.Elasticsearch.Snapshot.IRepository repository, Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) @@ -398,7 +464,9 @@ public virtual Task CreateRepositoryAsync(Elastic.Clie } /// - /// Deletes one or more snapshots. + /// + /// Deletes one or more snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -409,7 +477,9 @@ public virtual DeleteSnapshotResponse Delete(DeleteSnapshotRequest request) } /// - /// Deletes one or more snapshots. + /// + /// Deletes one or more snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteSnapshotRequest request, CancellationToken cancellationToken = default) @@ -419,7 +489,9 @@ public virtual Task DeleteAsync(DeleteSnapshotRequest re } /// - /// Deletes one or more snapshots. + /// + /// Deletes one or more snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -430,7 +502,9 @@ public virtual DeleteSnapshotResponse Delete(DeleteSnapshotRequestDescriptor des } /// - /// Deletes one or more snapshots. + /// + /// Deletes one or more snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -442,7 +516,9 @@ public virtual DeleteSnapshotResponse Delete(Elastic.Clients.Elasticsearch.Name } /// - /// Deletes one or more snapshots. + /// + /// Deletes one or more snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -455,7 +531,9 @@ public virtual DeleteSnapshotResponse Delete(Elastic.Clients.Elasticsearch.Name } /// - /// Deletes one or more snapshots. + /// + /// Deletes one or more snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteSnapshotRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -465,7 +543,9 @@ public virtual Task DeleteAsync(DeleteSnapshotRequestDes } /// - /// Deletes one or more snapshots. + /// + /// Deletes one or more snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Name repository, Elastic.Clients.Elasticsearch.Name snapshot, CancellationToken cancellationToken = default) @@ -476,7 +556,9 @@ public virtual Task DeleteAsync(Elastic.Clients.Elastics } /// - /// Deletes one or more snapshots. + /// + /// Deletes one or more snapshots. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Name repository, Elastic.Clients.Elasticsearch.Name snapshot, Action configureRequest, CancellationToken cancellationToken = default) @@ -488,7 +570,9 @@ public virtual Task DeleteAsync(Elastic.Clients.Elastics } /// - /// Deletes a repository. + /// + /// Deletes a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -499,7 +583,9 @@ public virtual DeleteRepositoryResponse DeleteRepository(DeleteRepositoryRequest } /// - /// Deletes a repository. + /// + /// Deletes a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteRepositoryAsync(DeleteRepositoryRequest request, CancellationToken cancellationToken = default) @@ -509,7 +595,9 @@ public virtual Task DeleteRepositoryAsync(DeleteReposi } /// - /// Deletes a repository. + /// + /// Deletes a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -520,7 +608,9 @@ public virtual DeleteRepositoryResponse DeleteRepository(DeleteRepositoryRequest } /// - /// Deletes a repository. + /// + /// Deletes a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -532,7 +622,9 @@ public virtual DeleteRepositoryResponse DeleteRepository(Elastic.Clients.Elastic } /// - /// Deletes a repository. + /// + /// Deletes a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -545,7 +637,9 @@ public virtual DeleteRepositoryResponse DeleteRepository(Elastic.Clients.Elastic } /// - /// Deletes a repository. + /// + /// Deletes a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteRepositoryAsync(DeleteRepositoryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -555,7 +649,9 @@ public virtual Task DeleteRepositoryAsync(DeleteReposi } /// - /// Deletes a repository. + /// + /// Deletes a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteRepositoryAsync(Elastic.Clients.Elasticsearch.Names name, CancellationToken cancellationToken = default) @@ -566,7 +662,9 @@ public virtual Task DeleteRepositoryAsync(Elastic.Clie } /// - /// Deletes a repository. + /// + /// Deletes a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteRepositoryAsync(Elastic.Clients.Elasticsearch.Names name, Action configureRequest, CancellationToken cancellationToken = default) @@ -578,7 +676,9 @@ public virtual Task DeleteRepositoryAsync(Elastic.Clie } /// - /// Returns information about a snapshot. + /// + /// Returns information about a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -589,7 +689,9 @@ public virtual GetSnapshotResponse Get(GetSnapshotRequest request) } /// - /// Returns information about a snapshot. + /// + /// Returns information about a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(GetSnapshotRequest request, CancellationToken cancellationToken = default) @@ -599,7 +701,9 @@ public virtual Task GetAsync(GetSnapshotRequest request, Ca } /// - /// Returns information about a snapshot. + /// + /// Returns information about a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -610,7 +714,9 @@ public virtual GetSnapshotResponse Get(GetSnapshotRequestDescriptor descriptor) } /// - /// Returns information about a snapshot. + /// + /// Returns information about a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -622,7 +728,9 @@ public virtual GetSnapshotResponse Get(Elastic.Clients.Elasticsearch.Name reposi } /// - /// Returns information about a snapshot. + /// + /// Returns information about a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -635,7 +743,9 @@ public virtual GetSnapshotResponse Get(Elastic.Clients.Elasticsearch.Name reposi } /// - /// Returns information about a snapshot. + /// + /// Returns information about a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(GetSnapshotRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -645,7 +755,9 @@ public virtual Task GetAsync(GetSnapshotRequestDescriptor d } /// - /// Returns information about a snapshot. + /// + /// Returns information about a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(Elastic.Clients.Elasticsearch.Name repository, Elastic.Clients.Elasticsearch.Names snapshot, CancellationToken cancellationToken = default) @@ -656,7 +768,9 @@ public virtual Task GetAsync(Elastic.Clients.Elasticsearch. } /// - /// Returns information about a snapshot. + /// + /// Returns information about a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(Elastic.Clients.Elasticsearch.Name repository, Elastic.Clients.Elasticsearch.Names snapshot, Action configureRequest, CancellationToken cancellationToken = default) @@ -668,7 +782,9 @@ public virtual Task GetAsync(Elastic.Clients.Elasticsearch. } /// - /// Returns information about a repository. + /// + /// Returns information about a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -679,7 +795,9 @@ public virtual GetRepositoryResponse GetRepository(GetRepositoryRequest request) } /// - /// Returns information about a repository. + /// + /// Returns information about a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRepositoryAsync(GetRepositoryRequest request, CancellationToken cancellationToken = default) @@ -689,7 +807,9 @@ public virtual Task GetRepositoryAsync(GetRepositoryReque } /// - /// Returns information about a repository. + /// + /// Returns information about a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -700,7 +820,9 @@ public virtual GetRepositoryResponse GetRepository(GetRepositoryRequestDescripto } /// - /// Returns information about a repository. + /// + /// Returns information about a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -712,7 +834,9 @@ public virtual GetRepositoryResponse GetRepository(Elastic.Clients.Elasticsearch } /// - /// Returns information about a repository. + /// + /// Returns information about a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -725,7 +849,9 @@ public virtual GetRepositoryResponse GetRepository(Elastic.Clients.Elasticsearch } /// - /// Returns information about a repository. + /// + /// Returns information about a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -737,7 +863,9 @@ public virtual GetRepositoryResponse GetRepository() } /// - /// Returns information about a repository. + /// + /// Returns information about a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -750,7 +878,9 @@ public virtual GetRepositoryResponse GetRepository(Action - /// Returns information about a repository. + /// + /// Returns information about a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRepositoryAsync(GetRepositoryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -760,7 +890,9 @@ public virtual Task GetRepositoryAsync(GetRepositoryReque } /// - /// Returns information about a repository. + /// + /// Returns information about a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRepositoryAsync(Elastic.Clients.Elasticsearch.Names? name, CancellationToken cancellationToken = default) @@ -771,7 +903,9 @@ public virtual Task GetRepositoryAsync(Elastic.Clients.El } /// - /// Returns information about a repository. + /// + /// Returns information about a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRepositoryAsync(Elastic.Clients.Elasticsearch.Names? name, Action configureRequest, CancellationToken cancellationToken = default) @@ -783,7 +917,9 @@ public virtual Task GetRepositoryAsync(Elastic.Clients.El } /// - /// Returns information about a repository. + /// + /// Returns information about a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRepositoryAsync(CancellationToken cancellationToken = default) @@ -794,7 +930,9 @@ public virtual Task GetRepositoryAsync(CancellationToken } /// - /// Returns information about a repository. + /// + /// Returns information about a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRepositoryAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -806,7 +944,9 @@ public virtual Task GetRepositoryAsync(Action - /// Restores a snapshot. + /// + /// Restores a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -817,7 +957,9 @@ public virtual RestoreResponse Restore(RestoreRequest request) } /// - /// Restores a snapshot. + /// + /// Restores a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RestoreAsync(RestoreRequest request, CancellationToken cancellationToken = default) @@ -827,7 +969,9 @@ public virtual Task RestoreAsync(RestoreRequest request, Cancel } /// - /// Restores a snapshot. + /// + /// Restores a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -838,7 +982,9 @@ public virtual RestoreResponse Restore(RestoreRequestDescriptor - /// Restores a snapshot. + /// + /// Restores a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -850,7 +996,9 @@ public virtual RestoreResponse Restore(Elastic.Clients.Elasticsearch. } /// - /// Restores a snapshot. + /// + /// Restores a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -863,7 +1011,9 @@ public virtual RestoreResponse Restore(Elastic.Clients.Elasticsearch. } /// - /// Restores a snapshot. + /// + /// Restores a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -874,7 +1024,9 @@ public virtual RestoreResponse Restore(RestoreRequestDescriptor descriptor) } /// - /// Restores a snapshot. + /// + /// Restores a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -886,7 +1038,9 @@ public virtual RestoreResponse Restore(Elastic.Clients.Elasticsearch.Name reposi } /// - /// Restores a snapshot. + /// + /// Restores a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -899,7 +1053,9 @@ public virtual RestoreResponse Restore(Elastic.Clients.Elasticsearch.Name reposi } /// - /// Restores a snapshot. + /// + /// Restores a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RestoreAsync(RestoreRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -909,7 +1065,9 @@ public virtual Task RestoreAsync(RestoreRequestDescr } /// - /// Restores a snapshot. + /// + /// Restores a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RestoreAsync(Elastic.Clients.Elasticsearch.Name repository, Elastic.Clients.Elasticsearch.Name snapshot, CancellationToken cancellationToken = default) @@ -920,7 +1078,9 @@ public virtual Task RestoreAsync(Elastic.Clients.Ela } /// - /// Restores a snapshot. + /// + /// Restores a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RestoreAsync(Elastic.Clients.Elasticsearch.Name repository, Elastic.Clients.Elasticsearch.Name snapshot, Action> configureRequest, CancellationToken cancellationToken = default) @@ -932,7 +1092,9 @@ public virtual Task RestoreAsync(Elastic.Clients.Ela } /// - /// Restores a snapshot. + /// + /// Restores a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RestoreAsync(RestoreRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -942,7 +1104,9 @@ public virtual Task RestoreAsync(RestoreRequestDescriptor descr } /// - /// Restores a snapshot. + /// + /// Restores a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RestoreAsync(Elastic.Clients.Elasticsearch.Name repository, Elastic.Clients.Elasticsearch.Name snapshot, CancellationToken cancellationToken = default) @@ -953,7 +1117,9 @@ public virtual Task RestoreAsync(Elastic.Clients.Elasticsearch. } /// - /// Restores a snapshot. + /// + /// Restores a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RestoreAsync(Elastic.Clients.Elasticsearch.Name repository, Elastic.Clients.Elasticsearch.Name snapshot, Action configureRequest, CancellationToken cancellationToken = default) @@ -965,7 +1131,9 @@ public virtual Task RestoreAsync(Elastic.Clients.Elasticsearch. } /// - /// Returns information about the status of a snapshot. + /// + /// Returns information about the status of a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -976,7 +1144,9 @@ public virtual SnapshotStatusResponse Status(SnapshotStatusRequest request) } /// - /// Returns information about the status of a snapshot. + /// + /// Returns information about the status of a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(SnapshotStatusRequest request, CancellationToken cancellationToken = default) @@ -986,7 +1156,9 @@ public virtual Task StatusAsync(SnapshotStatusRequest re } /// - /// Returns information about the status of a snapshot. + /// + /// Returns information about the status of a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -997,7 +1169,9 @@ public virtual SnapshotStatusResponse Status(SnapshotStatusRequestDescriptor des } /// - /// Returns information about the status of a snapshot. + /// + /// Returns information about the status of a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1009,7 +1183,9 @@ public virtual SnapshotStatusResponse Status(Elastic.Clients.Elasticsearch.Name? } /// - /// Returns information about the status of a snapshot. + /// + /// Returns information about the status of a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1022,7 +1198,9 @@ public virtual SnapshotStatusResponse Status(Elastic.Clients.Elasticsearch.Name? } /// - /// Returns information about the status of a snapshot. + /// + /// Returns information about the status of a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1034,7 +1212,9 @@ public virtual SnapshotStatusResponse Status() } /// - /// Returns information about the status of a snapshot. + /// + /// Returns information about the status of a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1047,7 +1227,9 @@ public virtual SnapshotStatusResponse Status(Action - /// Returns information about the status of a snapshot. + /// + /// Returns information about the status of a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(SnapshotStatusRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1057,7 +1239,9 @@ public virtual Task StatusAsync(SnapshotStatusRequestDes } /// - /// Returns information about the status of a snapshot. + /// + /// Returns information about the status of a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(Elastic.Clients.Elasticsearch.Name? repository, Elastic.Clients.Elasticsearch.Names? snapshot, CancellationToken cancellationToken = default) @@ -1068,7 +1252,9 @@ public virtual Task StatusAsync(Elastic.Clients.Elastics } /// - /// Returns information about the status of a snapshot. + /// + /// Returns information about the status of a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(Elastic.Clients.Elasticsearch.Name? repository, Elastic.Clients.Elasticsearch.Names? snapshot, Action configureRequest, CancellationToken cancellationToken = default) @@ -1080,7 +1266,9 @@ public virtual Task StatusAsync(Elastic.Clients.Elastics } /// - /// Returns information about the status of a snapshot. + /// + /// Returns information about the status of a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(CancellationToken cancellationToken = default) @@ -1091,7 +1279,9 @@ public virtual Task StatusAsync(CancellationToken cancel } /// - /// Returns information about the status of a snapshot. + /// + /// Returns information about the status of a snapshot. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -1103,7 +1293,9 @@ public virtual Task StatusAsync(Action - /// Verifies a repository. + /// + /// Verifies a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1114,7 +1306,9 @@ public virtual VerifyRepositoryResponse VerifyRepository(VerifyRepositoryRequest } /// - /// Verifies a repository. + /// + /// Verifies a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task VerifyRepositoryAsync(VerifyRepositoryRequest request, CancellationToken cancellationToken = default) @@ -1124,7 +1318,9 @@ public virtual Task VerifyRepositoryAsync(VerifyReposi } /// - /// Verifies a repository. + /// + /// Verifies a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1135,7 +1331,9 @@ public virtual VerifyRepositoryResponse VerifyRepository(VerifyRepositoryRequest } /// - /// Verifies a repository. + /// + /// Verifies a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1147,7 +1345,9 @@ public virtual VerifyRepositoryResponse VerifyRepository(Elastic.Clients.Elastic } /// - /// Verifies a repository. + /// + /// Verifies a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1160,7 +1360,9 @@ public virtual VerifyRepositoryResponse VerifyRepository(Elastic.Clients.Elastic } /// - /// Verifies a repository. + /// + /// Verifies a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task VerifyRepositoryAsync(VerifyRepositoryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1170,7 +1372,9 @@ public virtual Task VerifyRepositoryAsync(VerifyReposi } /// - /// Verifies a repository. + /// + /// Verifies a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task VerifyRepositoryAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) @@ -1181,7 +1385,9 @@ public virtual Task VerifyRepositoryAsync(Elastic.Clie } /// - /// Verifies a repository. + /// + /// Verifies a repository. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task VerifyRepositoryAsync(Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Sql.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Sql.g.cs index 445377253b1..8f663c7b8b0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Sql.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Sql.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Sql; public partial class SqlNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected SqlNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal SqlNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// Clears the SQL cursor + /// + /// Clears the SQL cursor + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -49,7 +53,9 @@ public virtual ClearCursorResponse ClearCursor(ClearCursorRequest request) } /// - /// Clears the SQL cursor + /// + /// Clears the SQL cursor + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCursorAsync(ClearCursorRequest request, CancellationToken cancellationToken = default) @@ -59,7 +65,9 @@ public virtual Task ClearCursorAsync(ClearCursorRequest req } /// - /// Clears the SQL cursor + /// + /// Clears the SQL cursor + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -70,7 +78,9 @@ public virtual ClearCursorResponse ClearCursor(ClearCursorRequestDescriptor desc } /// - /// Clears the SQL cursor + /// + /// Clears the SQL cursor + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -82,7 +92,9 @@ public virtual ClearCursorResponse ClearCursor() } /// - /// Clears the SQL cursor + /// + /// Clears the SQL cursor + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -95,7 +107,9 @@ public virtual ClearCursorResponse ClearCursor(Action - /// Clears the SQL cursor + /// + /// Clears the SQL cursor + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCursorAsync(ClearCursorRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -105,7 +119,9 @@ public virtual Task ClearCursorAsync(ClearCursorRequestDesc } /// - /// Clears the SQL cursor + /// + /// Clears the SQL cursor + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCursorAsync(CancellationToken cancellationToken = default) @@ -116,7 +132,9 @@ public virtual Task ClearCursorAsync(CancellationToken canc } /// - /// Clears the SQL cursor + /// + /// Clears the SQL cursor + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearCursorAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -128,7 +146,9 @@ public virtual Task ClearCursorAsync(Action - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// + /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -139,7 +159,9 @@ public virtual DeleteAsyncResponse DeleteAsync(DeleteAsyncRequest request) } /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// + /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsyncAsync(DeleteAsyncRequest request, CancellationToken cancellationToken = default) @@ -149,7 +171,9 @@ public virtual Task DeleteAsyncAsync(DeleteAsyncRequest req } /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// + /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -160,7 +184,9 @@ public virtual DeleteAsyncResponse DeleteAsync(DeleteAsyncRequestDesc } /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// + /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -172,7 +198,9 @@ public virtual DeleteAsyncResponse DeleteAsync(Elastic.Clients.Elasti } /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// + /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -185,7 +213,9 @@ public virtual DeleteAsyncResponse DeleteAsync(Elastic.Clients.Elasti } /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// + /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -196,7 +226,9 @@ public virtual DeleteAsyncResponse DeleteAsync(DeleteAsyncRequestDescriptor desc } /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// + /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -208,7 +240,9 @@ public virtual DeleteAsyncResponse DeleteAsync(Elastic.Clients.Elasticsearch.Id } /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// + /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -221,7 +255,9 @@ public virtual DeleteAsyncResponse DeleteAsync(Elastic.Clients.Elasticsearch.Id } /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// + /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsyncAsync(DeleteAsyncRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -231,7 +267,9 @@ public virtual Task DeleteAsyncAsync(DeleteAsync } /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// + /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsyncAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -242,7 +280,9 @@ public virtual Task DeleteAsyncAsync(Elastic.Cli } /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// + /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsyncAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -254,7 +294,9 @@ public virtual Task DeleteAsyncAsync(Elastic.Cli } /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// + /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsyncAsync(DeleteAsyncRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -264,7 +306,9 @@ public virtual Task DeleteAsyncAsync(DeleteAsyncRequestDesc } /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// + /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsyncAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -275,7 +319,9 @@ public virtual Task DeleteAsyncAsync(Elastic.Clients.Elasti } /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// + /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsyncAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -287,7 +333,9 @@ public virtual Task DeleteAsyncAsync(Elastic.Clients.Elasti } /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// + /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -298,7 +346,9 @@ public virtual GetAsyncResponse GetAsync(GetAsyncRequest request) } /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// + /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsyncAsync(GetAsyncRequest request, CancellationToken cancellationToken = default) @@ -308,7 +358,9 @@ public virtual Task GetAsyncAsync(GetAsyncRequest request, Can } /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// + /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -319,7 +371,9 @@ public virtual GetAsyncResponse GetAsync(GetAsyncRequestDescriptor - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// + /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -331,7 +385,9 @@ public virtual GetAsyncResponse GetAsync(Elastic.Clients.Elasticsearc } /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// + /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -344,7 +400,9 @@ public virtual GetAsyncResponse GetAsync(Elastic.Clients.Elasticsearc } /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// + /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -355,7 +413,9 @@ public virtual GetAsyncResponse GetAsync(GetAsyncRequestDescriptor descriptor) } /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// + /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -367,7 +427,9 @@ public virtual GetAsyncResponse GetAsync(Elastic.Clients.Elasticsearch.Id id) } /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// + /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -380,7 +442,9 @@ public virtual GetAsyncResponse GetAsync(Elastic.Clients.Elasticsearch.Id id, Ac } /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// + /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsyncAsync(GetAsyncRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -390,7 +454,9 @@ public virtual Task GetAsyncAsync(GetAsyncRequestDe } /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// + /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsyncAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -401,7 +467,9 @@ public virtual Task GetAsyncAsync(Elastic.Clients.E } /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// + /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsyncAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -413,7 +481,9 @@ public virtual Task GetAsyncAsync(Elastic.Clients.E } /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// + /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsyncAsync(GetAsyncRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -423,7 +493,9 @@ public virtual Task GetAsyncAsync(GetAsyncRequestDescriptor de } /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// + /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsyncAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -434,7 +506,9 @@ public virtual Task GetAsyncAsync(Elastic.Clients.Elasticsearc } /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// + /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsyncAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -446,7 +520,9 @@ public virtual Task GetAsyncAsync(Elastic.Clients.Elasticsearc } /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// + /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -457,7 +533,9 @@ public virtual GetAsyncStatusResponse GetAsyncStatus(GetAsyncStatusRequest reque } /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// + /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsyncStatusAsync(GetAsyncStatusRequest request, CancellationToken cancellationToken = default) @@ -467,7 +545,9 @@ public virtual Task GetAsyncStatusAsync(GetAsyncStatusRe } /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// + /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -478,7 +558,9 @@ public virtual GetAsyncStatusResponse GetAsyncStatus(GetAsyncStatusRe } /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// + /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -490,7 +572,9 @@ public virtual GetAsyncStatusResponse GetAsyncStatus(Elastic.Clients. } /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// + /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -503,7 +587,9 @@ public virtual GetAsyncStatusResponse GetAsyncStatus(Elastic.Clients. } /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// + /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -514,7 +600,9 @@ public virtual GetAsyncStatusResponse GetAsyncStatus(GetAsyncStatusRequestDescri } /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// + /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -526,7 +614,9 @@ public virtual GetAsyncStatusResponse GetAsyncStatus(Elastic.Clients.Elasticsear } /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// + /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -539,7 +629,9 @@ public virtual GetAsyncStatusResponse GetAsyncStatus(Elastic.Clients.Elasticsear } /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// + /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsyncStatusAsync(GetAsyncStatusRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -549,7 +641,9 @@ public virtual Task GetAsyncStatusAsync(GetAs } /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// + /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsyncStatusAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -560,7 +654,9 @@ public virtual Task GetAsyncStatusAsync(Elast } /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// + /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsyncStatusAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -572,7 +668,9 @@ public virtual Task GetAsyncStatusAsync(Elast } /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// + /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsyncStatusAsync(GetAsyncStatusRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -582,7 +680,9 @@ public virtual Task GetAsyncStatusAsync(GetAsyncStatusRe } /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// + /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsyncStatusAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -593,7 +693,9 @@ public virtual Task GetAsyncStatusAsync(Elastic.Clients. } /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// + /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsyncStatusAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -605,7 +707,9 @@ public virtual Task GetAsyncStatusAsync(Elastic.Clients. } /// - /// Executes a SQL request + /// + /// Executes a SQL request + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -616,7 +720,9 @@ public virtual QueryResponse Query(QueryRequest request) } /// - /// Executes a SQL request + /// + /// Executes a SQL request + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(QueryRequest request, CancellationToken cancellationToken = default) @@ -626,7 +732,9 @@ public virtual Task QueryAsync(QueryRequest request, Cancellation } /// - /// Executes a SQL request + /// + /// Executes a SQL request + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -637,7 +745,9 @@ public virtual QueryResponse Query(QueryRequestDescriptor } /// - /// Executes a SQL request + /// + /// Executes a SQL request + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -649,7 +759,9 @@ public virtual QueryResponse Query() } /// - /// Executes a SQL request + /// + /// Executes a SQL request + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -662,7 +774,9 @@ public virtual QueryResponse Query(Action - /// Executes a SQL request + /// + /// Executes a SQL request + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -673,7 +787,9 @@ public virtual QueryResponse Query(QueryRequestDescriptor descriptor) } /// - /// Executes a SQL request + /// + /// Executes a SQL request + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -685,7 +801,9 @@ public virtual QueryResponse Query() } /// - /// Executes a SQL request + /// + /// Executes a SQL request + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -698,7 +816,9 @@ public virtual QueryResponse Query(Action configureReque } /// - /// Executes a SQL request + /// + /// Executes a SQL request + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(QueryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -708,7 +828,9 @@ public virtual Task QueryAsync(QueryRequestDescriptor< } /// - /// Executes a SQL request + /// + /// Executes a SQL request + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(CancellationToken cancellationToken = default) @@ -719,7 +841,9 @@ public virtual Task QueryAsync(CancellationToken cance } /// - /// Executes a SQL request + /// + /// Executes a SQL request + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -731,7 +855,9 @@ public virtual Task QueryAsync(Action - /// Executes a SQL request + /// + /// Executes a SQL request + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(QueryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -741,7 +867,9 @@ public virtual Task QueryAsync(QueryRequestDescriptor descriptor, } /// - /// Executes a SQL request + /// + /// Executes a SQL request + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(CancellationToken cancellationToken = default) @@ -752,7 +880,9 @@ public virtual Task QueryAsync(CancellationToken cancellationToke } /// - /// Executes a SQL request + /// + /// Executes a SQL request + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -764,7 +894,9 @@ public virtual Task QueryAsync(Action con } /// - /// Translates SQL into Elasticsearch queries + /// + /// Translates SQL into Elasticsearch queries + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -775,7 +907,9 @@ public virtual TranslateResponse Translate(TranslateRequest request) } /// - /// Translates SQL into Elasticsearch queries + /// + /// Translates SQL into Elasticsearch queries + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TranslateAsync(TranslateRequest request, CancellationToken cancellationToken = default) @@ -785,7 +919,9 @@ public virtual Task TranslateAsync(TranslateRequest request, } /// - /// Translates SQL into Elasticsearch queries + /// + /// Translates SQL into Elasticsearch queries + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -796,7 +932,9 @@ public virtual TranslateResponse Translate(TranslateRequestDescriptor } /// - /// Translates SQL into Elasticsearch queries + /// + /// Translates SQL into Elasticsearch queries + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -808,7 +946,9 @@ public virtual TranslateResponse Translate() } /// - /// Translates SQL into Elasticsearch queries + /// + /// Translates SQL into Elasticsearch queries + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -821,7 +961,9 @@ public virtual TranslateResponse Translate(Action - /// Translates SQL into Elasticsearch queries + /// + /// Translates SQL into Elasticsearch queries + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -832,7 +974,9 @@ public virtual TranslateResponse Translate(TranslateRequestDescriptor descriptor } /// - /// Translates SQL into Elasticsearch queries + /// + /// Translates SQL into Elasticsearch queries + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -844,7 +988,9 @@ public virtual TranslateResponse Translate() } /// - /// Translates SQL into Elasticsearch queries + /// + /// Translates SQL into Elasticsearch queries + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -857,7 +1003,9 @@ public virtual TranslateResponse Translate(Action co } /// - /// Translates SQL into Elasticsearch queries + /// + /// Translates SQL into Elasticsearch queries + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TranslateAsync(TranslateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -867,7 +1015,9 @@ public virtual Task TranslateAsync(TranslateReques } /// - /// Translates SQL into Elasticsearch queries + /// + /// Translates SQL into Elasticsearch queries + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TranslateAsync(CancellationToken cancellationToken = default) @@ -878,7 +1028,9 @@ public virtual Task TranslateAsync(CancellationTok } /// - /// Translates SQL into Elasticsearch queries + /// + /// Translates SQL into Elasticsearch queries + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TranslateAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -890,7 +1042,9 @@ public virtual Task TranslateAsync(Action - /// Translates SQL into Elasticsearch queries + /// + /// Translates SQL into Elasticsearch queries + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TranslateAsync(TranslateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -900,7 +1054,9 @@ public virtual Task TranslateAsync(TranslateRequestDescriptor } /// - /// Translates SQL into Elasticsearch queries + /// + /// Translates SQL into Elasticsearch queries + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TranslateAsync(CancellationToken cancellationToken = default) @@ -911,7 +1067,9 @@ public virtual Task TranslateAsync(CancellationToken cancella } /// - /// Translates SQL into Elasticsearch queries + /// + /// Translates SQL into Elasticsearch queries + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TranslateAsync(Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Synonyms.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Synonyms.g.cs index fcc19ce2c2f..ffd5944ce64 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Synonyms.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Synonyms.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Synonyms; public partial class SynonymsNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected SynonymsNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal SynonymsNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// Deletes a synonym set + /// + /// Deletes a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -49,7 +53,9 @@ public virtual DeleteSynonymResponse DeleteSynonym(DeleteSynonymRequest request) } /// - /// Deletes a synonym set + /// + /// Deletes a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteSynonymAsync(DeleteSynonymRequest request, CancellationToken cancellationToken = default) @@ -59,7 +65,9 @@ public virtual Task DeleteSynonymAsync(DeleteSynonymReque } /// - /// Deletes a synonym set + /// + /// Deletes a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -70,7 +78,9 @@ public virtual DeleteSynonymResponse DeleteSynonym(DeleteSynonymReque } /// - /// Deletes a synonym set + /// + /// Deletes a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -82,7 +92,9 @@ public virtual DeleteSynonymResponse DeleteSynonym(Elastic.Clients.El } /// - /// Deletes a synonym set + /// + /// Deletes a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -95,7 +107,9 @@ public virtual DeleteSynonymResponse DeleteSynonym(Elastic.Clients.El } /// - /// Deletes a synonym set + /// + /// Deletes a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -106,7 +120,9 @@ public virtual DeleteSynonymResponse DeleteSynonym(DeleteSynonymRequestDescripto } /// - /// Deletes a synonym set + /// + /// Deletes a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -118,7 +134,9 @@ public virtual DeleteSynonymResponse DeleteSynonym(Elastic.Clients.Elasticsearch } /// - /// Deletes a synonym set + /// + /// Deletes a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -131,7 +149,9 @@ public virtual DeleteSynonymResponse DeleteSynonym(Elastic.Clients.Elasticsearch } /// - /// Deletes a synonym set + /// + /// Deletes a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteSynonymAsync(DeleteSynonymRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -141,7 +161,9 @@ public virtual Task DeleteSynonymAsync(DeleteS } /// - /// Deletes a synonym set + /// + /// Deletes a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteSynonymAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -152,7 +174,9 @@ public virtual Task DeleteSynonymAsync(Elastic } /// - /// Deletes a synonym set + /// + /// Deletes a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteSynonymAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -164,7 +188,9 @@ public virtual Task DeleteSynonymAsync(Elastic } /// - /// Deletes a synonym set + /// + /// Deletes a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteSynonymAsync(DeleteSynonymRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -174,7 +200,9 @@ public virtual Task DeleteSynonymAsync(DeleteSynonymReque } /// - /// Deletes a synonym set + /// + /// Deletes a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteSynonymAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -185,7 +213,9 @@ public virtual Task DeleteSynonymAsync(Elastic.Clients.El } /// - /// Deletes a synonym set + /// + /// Deletes a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteSynonymAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -197,7 +227,9 @@ public virtual Task DeleteSynonymAsync(Elastic.Clients.El } /// - /// Deletes a synonym rule in a synonym set + /// + /// Deletes a synonym rule in a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -208,7 +240,9 @@ public virtual DeleteSynonymRuleResponse DeleteSynonymRule(DeleteSynonymRuleRequ } /// - /// Deletes a synonym rule in a synonym set + /// + /// Deletes a synonym rule in a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteSynonymRuleAsync(DeleteSynonymRuleRequest request, CancellationToken cancellationToken = default) @@ -218,7 +252,9 @@ public virtual Task DeleteSynonymRuleAsync(DeleteSyno } /// - /// Deletes a synonym rule in a synonym set + /// + /// Deletes a synonym rule in a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -229,7 +265,9 @@ public virtual DeleteSynonymRuleResponse DeleteSynonymRule(DeleteSynonymRuleRequ } /// - /// Deletes a synonym rule in a synonym set + /// + /// Deletes a synonym rule in a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -241,7 +279,9 @@ public virtual DeleteSynonymRuleResponse DeleteSynonymRule(Elastic.Clients.Elast } /// - /// Deletes a synonym rule in a synonym set + /// + /// Deletes a synonym rule in a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -254,7 +294,9 @@ public virtual DeleteSynonymRuleResponse DeleteSynonymRule(Elastic.Clients.Elast } /// - /// Deletes a synonym rule in a synonym set + /// + /// Deletes a synonym rule in a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteSynonymRuleAsync(DeleteSynonymRuleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -264,7 +306,9 @@ public virtual Task DeleteSynonymRuleAsync(DeleteSyno } /// - /// Deletes a synonym rule in a synonym set + /// + /// Deletes a synonym rule in a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteSynonymRuleAsync(Elastic.Clients.Elasticsearch.Id setId, Elastic.Clients.Elasticsearch.Id ruleId, CancellationToken cancellationToken = default) @@ -275,7 +319,9 @@ public virtual Task DeleteSynonymRuleAsync(Elastic.Cl } /// - /// Deletes a synonym rule in a synonym set + /// + /// Deletes a synonym rule in a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteSynonymRuleAsync(Elastic.Clients.Elasticsearch.Id setId, Elastic.Clients.Elasticsearch.Id ruleId, Action configureRequest, CancellationToken cancellationToken = default) @@ -287,7 +333,9 @@ public virtual Task DeleteSynonymRuleAsync(Elastic.Cl } /// - /// Retrieves a synonym set + /// + /// Retrieves a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -298,7 +346,9 @@ public virtual GetSynonymResponse GetSynonym(GetSynonymRequest request) } /// - /// Retrieves a synonym set + /// + /// Retrieves a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSynonymAsync(GetSynonymRequest request, CancellationToken cancellationToken = default) @@ -308,7 +358,9 @@ public virtual Task GetSynonymAsync(GetSynonymRequest reques } /// - /// Retrieves a synonym set + /// + /// Retrieves a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -319,7 +371,9 @@ public virtual GetSynonymResponse GetSynonym(GetSynonymRequestDescrip } /// - /// Retrieves a synonym set + /// + /// Retrieves a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -331,7 +385,9 @@ public virtual GetSynonymResponse GetSynonym(Elastic.Clients.Elastics } /// - /// Retrieves a synonym set + /// + /// Retrieves a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -344,7 +400,9 @@ public virtual GetSynonymResponse GetSynonym(Elastic.Clients.Elastics } /// - /// Retrieves a synonym set + /// + /// Retrieves a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -355,7 +413,9 @@ public virtual GetSynonymResponse GetSynonym(GetSynonymRequestDescriptor descrip } /// - /// Retrieves a synonym set + /// + /// Retrieves a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -367,7 +427,9 @@ public virtual GetSynonymResponse GetSynonym(Elastic.Clients.Elasticsearch.Id id } /// - /// Retrieves a synonym set + /// + /// Retrieves a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -380,7 +442,9 @@ public virtual GetSynonymResponse GetSynonym(Elastic.Clients.Elasticsearch.Id id } /// - /// Retrieves a synonym set + /// + /// Retrieves a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSynonymAsync(GetSynonymRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -390,7 +454,9 @@ public virtual Task GetSynonymAsync(GetSynonymReq } /// - /// Retrieves a synonym set + /// + /// Retrieves a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSynonymAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -401,7 +467,9 @@ public virtual Task GetSynonymAsync(Elastic.Clien } /// - /// Retrieves a synonym set + /// + /// Retrieves a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSynonymAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -413,7 +481,9 @@ public virtual Task GetSynonymAsync(Elastic.Clien } /// - /// Retrieves a synonym set + /// + /// Retrieves a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSynonymAsync(GetSynonymRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -423,7 +493,9 @@ public virtual Task GetSynonymAsync(GetSynonymRequestDescrip } /// - /// Retrieves a synonym set + /// + /// Retrieves a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSynonymAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -434,7 +506,9 @@ public virtual Task GetSynonymAsync(Elastic.Clients.Elastics } /// - /// Retrieves a synonym set + /// + /// Retrieves a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSynonymAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -446,7 +520,9 @@ public virtual Task GetSynonymAsync(Elastic.Clients.Elastics } /// - /// Retrieves a synonym rule from a synonym set + /// + /// Retrieves a synonym rule from a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -457,7 +533,9 @@ public virtual GetSynonymRuleResponse GetSynonymRule(GetSynonymRuleRequest reque } /// - /// Retrieves a synonym rule from a synonym set + /// + /// Retrieves a synonym rule from a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSynonymRuleAsync(GetSynonymRuleRequest request, CancellationToken cancellationToken = default) @@ -467,7 +545,9 @@ public virtual Task GetSynonymRuleAsync(GetSynonymRuleRe } /// - /// Retrieves a synonym rule from a synonym set + /// + /// Retrieves a synonym rule from a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -478,7 +558,9 @@ public virtual GetSynonymRuleResponse GetSynonymRule(GetSynonymRuleRequestDescri } /// - /// Retrieves a synonym rule from a synonym set + /// + /// Retrieves a synonym rule from a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -490,7 +572,9 @@ public virtual GetSynonymRuleResponse GetSynonymRule(Elastic.Clients.Elasticsear } /// - /// Retrieves a synonym rule from a synonym set + /// + /// Retrieves a synonym rule from a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -503,7 +587,9 @@ public virtual GetSynonymRuleResponse GetSynonymRule(Elastic.Clients.Elasticsear } /// - /// Retrieves a synonym rule from a synonym set + /// + /// Retrieves a synonym rule from a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSynonymRuleAsync(GetSynonymRuleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -513,7 +599,9 @@ public virtual Task GetSynonymRuleAsync(GetSynonymRuleRe } /// - /// Retrieves a synonym rule from a synonym set + /// + /// Retrieves a synonym rule from a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSynonymRuleAsync(Elastic.Clients.Elasticsearch.Id setId, Elastic.Clients.Elasticsearch.Id ruleId, CancellationToken cancellationToken = default) @@ -524,7 +612,9 @@ public virtual Task GetSynonymRuleAsync(Elastic.Clients. } /// - /// Retrieves a synonym rule from a synonym set + /// + /// Retrieves a synonym rule from a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSynonymRuleAsync(Elastic.Clients.Elasticsearch.Id setId, Elastic.Clients.Elasticsearch.Id ruleId, Action configureRequest, CancellationToken cancellationToken = default) @@ -536,7 +626,9 @@ public virtual Task GetSynonymRuleAsync(Elastic.Clients. } /// - /// Retrieves a summary of all defined synonym sets + /// + /// Retrieves a summary of all defined synonym sets + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -547,7 +639,9 @@ public virtual GetSynonymsSetsResponse GetSynonymsSets(GetSynonymsSetsRequest re } /// - /// Retrieves a summary of all defined synonym sets + /// + /// Retrieves a summary of all defined synonym sets + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSynonymsSetsAsync(GetSynonymsSetsRequest request, CancellationToken cancellationToken = default) @@ -557,7 +651,9 @@ public virtual Task GetSynonymsSetsAsync(GetSynonymsSet } /// - /// Retrieves a summary of all defined synonym sets + /// + /// Retrieves a summary of all defined synonym sets + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -568,7 +664,9 @@ public virtual GetSynonymsSetsResponse GetSynonymsSets(GetSynonymsSetsRequestDes } /// - /// Retrieves a summary of all defined synonym sets + /// + /// Retrieves a summary of all defined synonym sets + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -580,7 +678,9 @@ public virtual GetSynonymsSetsResponse GetSynonymsSets() } /// - /// Retrieves a summary of all defined synonym sets + /// + /// Retrieves a summary of all defined synonym sets + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -593,7 +693,9 @@ public virtual GetSynonymsSetsResponse GetSynonymsSets(Action - /// Retrieves a summary of all defined synonym sets + /// + /// Retrieves a summary of all defined synonym sets + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSynonymsSetsAsync(GetSynonymsSetsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -603,7 +705,9 @@ public virtual Task GetSynonymsSetsAsync(GetSynonymsSet } /// - /// Retrieves a summary of all defined synonym sets + /// + /// Retrieves a summary of all defined synonym sets + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSynonymsSetsAsync(CancellationToken cancellationToken = default) @@ -614,7 +718,9 @@ public virtual Task GetSynonymsSetsAsync(CancellationTo } /// - /// Retrieves a summary of all defined synonym sets + /// + /// Retrieves a summary of all defined synonym sets + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSynonymsSetsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -626,7 +732,9 @@ public virtual Task GetSynonymsSetsAsync(Action - /// Creates or updates a synonym set. + /// + /// Creates or updates a synonym set. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -637,7 +745,9 @@ public virtual PutSynonymResponse PutSynonym(PutSynonymRequest request) } /// - /// Creates or updates a synonym set. + /// + /// Creates or updates a synonym set. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSynonymAsync(PutSynonymRequest request, CancellationToken cancellationToken = default) @@ -647,7 +757,9 @@ public virtual Task PutSynonymAsync(PutSynonymRequest reques } /// - /// Creates or updates a synonym set. + /// + /// Creates or updates a synonym set. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -658,7 +770,9 @@ public virtual PutSynonymResponse PutSynonym(PutSynonymRequestDescrip } /// - /// Creates or updates a synonym set. + /// + /// Creates or updates a synonym set. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -670,7 +784,9 @@ public virtual PutSynonymResponse PutSynonym(Elastic.Clients.Elastics } /// - /// Creates or updates a synonym set. + /// + /// Creates or updates a synonym set. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -683,7 +799,9 @@ public virtual PutSynonymResponse PutSynonym(Elastic.Clients.Elastics } /// - /// Creates or updates a synonym set. + /// + /// Creates or updates a synonym set. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -694,7 +812,9 @@ public virtual PutSynonymResponse PutSynonym(PutSynonymRequestDescriptor descrip } /// - /// Creates or updates a synonym set. + /// + /// Creates or updates a synonym set. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -706,7 +826,9 @@ public virtual PutSynonymResponse PutSynonym(Elastic.Clients.Elasticsearch.Id id } /// - /// Creates or updates a synonym set. + /// + /// Creates or updates a synonym set. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -719,7 +841,9 @@ public virtual PutSynonymResponse PutSynonym(Elastic.Clients.Elasticsearch.Id id } /// - /// Creates or updates a synonym set. + /// + /// Creates or updates a synonym set. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSynonymAsync(PutSynonymRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -729,7 +853,9 @@ public virtual Task PutSynonymAsync(PutSynonymReq } /// - /// Creates or updates a synonym set. + /// + /// Creates or updates a synonym set. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSynonymAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -740,7 +866,9 @@ public virtual Task PutSynonymAsync(Elastic.Clien } /// - /// Creates or updates a synonym set. + /// + /// Creates or updates a synonym set. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSynonymAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -752,7 +880,9 @@ public virtual Task PutSynonymAsync(Elastic.Clien } /// - /// Creates or updates a synonym set. + /// + /// Creates or updates a synonym set. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSynonymAsync(PutSynonymRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -762,7 +892,9 @@ public virtual Task PutSynonymAsync(PutSynonymRequestDescrip } /// - /// Creates or updates a synonym set. + /// + /// Creates or updates a synonym set. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSynonymAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -773,7 +905,9 @@ public virtual Task PutSynonymAsync(Elastic.Clients.Elastics } /// - /// Creates or updates a synonym set. + /// + /// Creates or updates a synonym set. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSynonymAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -785,7 +919,9 @@ public virtual Task PutSynonymAsync(Elastic.Clients.Elastics } /// - /// Creates or updates a synonym rule in a synonym set + /// + /// Creates or updates a synonym rule in a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -796,7 +932,9 @@ public virtual PutSynonymRuleResponse PutSynonymRule(PutSynonymRuleRequest reque } /// - /// Creates or updates a synonym rule in a synonym set + /// + /// Creates or updates a synonym rule in a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSynonymRuleAsync(PutSynonymRuleRequest request, CancellationToken cancellationToken = default) @@ -806,7 +944,9 @@ public virtual Task PutSynonymRuleAsync(PutSynonymRuleRe } /// - /// Creates or updates a synonym rule in a synonym set + /// + /// Creates or updates a synonym rule in a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -817,7 +957,9 @@ public virtual PutSynonymRuleResponse PutSynonymRule(PutSynonymRuleRequestDescri } /// - /// Creates or updates a synonym rule in a synonym set + /// + /// Creates or updates a synonym rule in a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -829,7 +971,9 @@ public virtual PutSynonymRuleResponse PutSynonymRule(Elastic.Clients.Elasticsear } /// - /// Creates or updates a synonym rule in a synonym set + /// + /// Creates or updates a synonym rule in a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -842,7 +986,9 @@ public virtual PutSynonymRuleResponse PutSynonymRule(Elastic.Clients.Elasticsear } /// - /// Creates or updates a synonym rule in a synonym set + /// + /// Creates or updates a synonym rule in a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSynonymRuleAsync(PutSynonymRuleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -852,7 +998,9 @@ public virtual Task PutSynonymRuleAsync(PutSynonymRuleRe } /// - /// Creates or updates a synonym rule in a synonym set + /// + /// Creates or updates a synonym rule in a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSynonymRuleAsync(Elastic.Clients.Elasticsearch.Id setId, Elastic.Clients.Elasticsearch.Id ruleId, CancellationToken cancellationToken = default) @@ -863,7 +1011,9 @@ public virtual Task PutSynonymRuleAsync(Elastic.Clients. } /// - /// Creates or updates a synonym rule in a synonym set + /// + /// Creates or updates a synonym rule in a synonym set + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutSynonymRuleAsync(Elastic.Clients.Elasticsearch.Id setId, Elastic.Clients.Elasticsearch.Id ruleId, Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Tasks.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Tasks.g.cs index f8e6b6e63b7..a31f622b0da 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Tasks.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Tasks.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Tasks; public partial class TasksNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected TasksNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal TasksNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// Cancels a task, if it can be cancelled through an API. + /// + /// Cancels a task, if it can be cancelled through an API. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -49,7 +53,9 @@ public virtual CancelResponse Cancel(CancelRequest request) } /// - /// Cancels a task, if it can be cancelled through an API. + /// + /// Cancels a task, if it can be cancelled through an API. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CancelAsync(CancelRequest request, CancellationToken cancellationToken = default) @@ -59,7 +65,9 @@ public virtual Task CancelAsync(CancelRequest request, Cancellat } /// - /// Cancels a task, if it can be cancelled through an API. + /// + /// Cancels a task, if it can be cancelled through an API. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -70,7 +78,9 @@ public virtual CancelResponse Cancel(CancelRequestDescriptor descriptor) } /// - /// Cancels a task, if it can be cancelled through an API. + /// + /// Cancels a task, if it can be cancelled through an API. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -82,7 +92,9 @@ public virtual CancelResponse Cancel(Elastic.Clients.Elasticsearch.TaskId? taskI } /// - /// Cancels a task, if it can be cancelled through an API. + /// + /// Cancels a task, if it can be cancelled through an API. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -95,7 +107,9 @@ public virtual CancelResponse Cancel(Elastic.Clients.Elasticsearch.TaskId? taskI } /// - /// Cancels a task, if it can be cancelled through an API. + /// + /// Cancels a task, if it can be cancelled through an API. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -107,7 +121,9 @@ public virtual CancelResponse Cancel() } /// - /// Cancels a task, if it can be cancelled through an API. + /// + /// Cancels a task, if it can be cancelled through an API. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -120,7 +136,9 @@ public virtual CancelResponse Cancel(Action configureRe } /// - /// Cancels a task, if it can be cancelled through an API. + /// + /// Cancels a task, if it can be cancelled through an API. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CancelAsync(CancelRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -130,7 +148,9 @@ public virtual Task CancelAsync(CancelRequestDescriptor descript } /// - /// Cancels a task, if it can be cancelled through an API. + /// + /// Cancels a task, if it can be cancelled through an API. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CancelAsync(Elastic.Clients.Elasticsearch.TaskId? taskId, CancellationToken cancellationToken = default) @@ -141,7 +161,9 @@ public virtual Task CancelAsync(Elastic.Clients.Elasticsearch.Ta } /// - /// Cancels a task, if it can be cancelled through an API. + /// + /// Cancels a task, if it can be cancelled through an API. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CancelAsync(Elastic.Clients.Elasticsearch.TaskId? taskId, Action configureRequest, CancellationToken cancellationToken = default) @@ -153,7 +175,9 @@ public virtual Task CancelAsync(Elastic.Clients.Elasticsearch.Ta } /// - /// Cancels a task, if it can be cancelled through an API. + /// + /// Cancels a task, if it can be cancelled through an API. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CancelAsync(CancellationToken cancellationToken = default) @@ -164,7 +188,9 @@ public virtual Task CancelAsync(CancellationToken cancellationTo } /// - /// Cancels a task, if it can be cancelled through an API. + /// + /// Cancels a task, if it can be cancelled through an API. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CancelAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -176,7 +202,10 @@ public virtual Task CancelAsync(Action } /// - /// Get task information.
Returns information about the tasks currently executing in the cluster. + /// + /// Get task information. + /// Returns information about the tasks currently executing in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -187,7 +216,10 @@ public virtual GetTasksResponse Get(GetTasksRequest request) } /// - /// Get task information.
Returns information about the tasks currently executing in the cluster. + /// + /// Get task information. + /// Returns information about the tasks currently executing in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(GetTasksRequest request, CancellationToken cancellationToken = default) @@ -197,7 +229,10 @@ public virtual Task GetAsync(GetTasksRequest request, Cancella } /// - /// Get task information.
Returns information about the tasks currently executing in the cluster. + /// + /// Get task information. + /// Returns information about the tasks currently executing in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -208,7 +243,10 @@ public virtual GetTasksResponse Get(GetTasksRequestDescriptor descriptor) } /// - /// Get task information.
Returns information about the tasks currently executing in the cluster. + /// + /// Get task information. + /// Returns information about the tasks currently executing in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -220,7 +258,10 @@ public virtual GetTasksResponse Get(Elastic.Clients.Elasticsearch.Id taskId) } /// - /// Get task information.
Returns information about the tasks currently executing in the cluster. + /// + /// Get task information. + /// Returns information about the tasks currently executing in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -233,7 +274,10 @@ public virtual GetTasksResponse Get(Elastic.Clients.Elasticsearch.Id taskId, Act } /// - /// Get task information.
Returns information about the tasks currently executing in the cluster. + /// + /// Get task information. + /// Returns information about the tasks currently executing in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(GetTasksRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -243,7 +287,10 @@ public virtual Task GetAsync(GetTasksRequestDescriptor descrip } /// - /// Get task information.
Returns information about the tasks currently executing in the cluster. + /// + /// Get task information. + /// Returns information about the tasks currently executing in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(Elastic.Clients.Elasticsearch.Id taskId, CancellationToken cancellationToken = default) @@ -254,7 +301,10 @@ public virtual Task GetAsync(Elastic.Clients.Elasticsearch.Id } /// - /// Get task information.
Returns information about the tasks currently executing in the cluster. + /// + /// Get task information. + /// Returns information about the tasks currently executing in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(Elastic.Clients.Elasticsearch.Id taskId, Action configureRequest, CancellationToken cancellationToken = default) @@ -266,7 +316,9 @@ public virtual Task GetAsync(Elastic.Clients.Elasticsearch.Id } /// - /// The task management API returns information about tasks currently executing on one or more nodes in the cluster. + /// + /// The task management API returns information about tasks currently executing on one or more nodes in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -277,7 +329,9 @@ public virtual ListResponse List(ListRequest request) } /// - /// The task management API returns information about tasks currently executing on one or more nodes in the cluster. + /// + /// The task management API returns information about tasks currently executing on one or more nodes in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ListAsync(ListRequest request, CancellationToken cancellationToken = default) @@ -287,7 +341,9 @@ public virtual Task ListAsync(ListRequest request, CancellationTok } /// - /// The task management API returns information about tasks currently executing on one or more nodes in the cluster. + /// + /// The task management API returns information about tasks currently executing on one or more nodes in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -298,7 +354,9 @@ public virtual ListResponse List(ListRequestDescriptor descriptor) } /// - /// The task management API returns information about tasks currently executing on one or more nodes in the cluster. + /// + /// The task management API returns information about tasks currently executing on one or more nodes in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -310,7 +368,9 @@ public virtual ListResponse List() } /// - /// The task management API returns information about tasks currently executing on one or more nodes in the cluster. + /// + /// The task management API returns information about tasks currently executing on one or more nodes in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -323,7 +383,9 @@ public virtual ListResponse List(Action configureRequest) } /// - /// The task management API returns information about tasks currently executing on one or more nodes in the cluster. + /// + /// The task management API returns information about tasks currently executing on one or more nodes in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ListAsync(ListRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -333,7 +395,9 @@ public virtual Task ListAsync(ListRequestDescriptor descriptor, Ca } /// - /// The task management API returns information about tasks currently executing on one or more nodes in the cluster. + /// + /// The task management API returns information about tasks currently executing on one or more nodes in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ListAsync(CancellationToken cancellationToken = default) @@ -344,7 +408,9 @@ public virtual Task ListAsync(CancellationToken cancellationToken } /// - /// The task management API returns information about tasks currently executing on one or more nodes in the cluster. + /// + /// The task management API returns information about tasks currently executing on one or more nodes in the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ListAsync(Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.TextStructure.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.TextStructure.g.cs index f038b7b10f7..191291118f4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.TextStructure.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.TextStructure.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.TextStructure; public partial class TextStructureNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected TextStructureNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal TextStructureNamespacedClient(ElasticsearchClient client) : base(client } /// - /// Tests a Grok pattern on some text. + /// + /// Tests a Grok pattern on some text. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -49,7 +53,9 @@ public virtual TestGrokPatternResponse TestGrokPattern(TestGrokPatternRequest re } /// - /// Tests a Grok pattern on some text. + /// + /// Tests a Grok pattern on some text. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TestGrokPatternAsync(TestGrokPatternRequest request, CancellationToken cancellationToken = default) @@ -59,7 +65,9 @@ public virtual Task TestGrokPatternAsync(TestGrokPatter } /// - /// Tests a Grok pattern on some text. + /// + /// Tests a Grok pattern on some text. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -70,7 +78,9 @@ public virtual TestGrokPatternResponse TestGrokPattern(TestGrokPatternRequestDes } /// - /// Tests a Grok pattern on some text. + /// + /// Tests a Grok pattern on some text. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -82,7 +92,9 @@ public virtual TestGrokPatternResponse TestGrokPattern() } /// - /// Tests a Grok pattern on some text. + /// + /// Tests a Grok pattern on some text. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -95,7 +107,9 @@ public virtual TestGrokPatternResponse TestGrokPattern(Action - /// Tests a Grok pattern on some text. + /// + /// Tests a Grok pattern on some text. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TestGrokPatternAsync(TestGrokPatternRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -105,7 +119,9 @@ public virtual Task TestGrokPatternAsync(TestGrokPatter } /// - /// Tests a Grok pattern on some text. + /// + /// Tests a Grok pattern on some text. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TestGrokPatternAsync(CancellationToken cancellationToken = default) @@ -116,7 +132,9 @@ public virtual Task TestGrokPatternAsync(CancellationTo } /// - /// Tests a Grok pattern on some text. + /// + /// Tests a Grok pattern on some text. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TestGrokPatternAsync(Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Transform.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Transform.g.cs index 45b4770a469..e4d6ae90c2f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Transform.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Transform.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.TransformManagement; public partial class TransformManagementNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected TransformManagementNamespacedClient() : base() { @@ -38,7 +40,10 @@ internal TransformManagementNamespacedClient(ElasticsearchClient client) : base( } /// - /// Delete a transform.
Deletes a transform. + /// + /// Delete a transform. + /// Deletes a transform. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -49,7 +54,10 @@ public virtual DeleteTransformResponse DeleteTransform(DeleteTransformRequest re } /// - /// Delete a transform.
Deletes a transform. + /// + /// Delete a transform. + /// Deletes a transform. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteTransformAsync(DeleteTransformRequest request, CancellationToken cancellationToken = default) @@ -59,7 +67,10 @@ public virtual Task DeleteTransformAsync(DeleteTransfor } /// - /// Delete a transform.
Deletes a transform. + /// + /// Delete a transform. + /// Deletes a transform. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -70,7 +81,10 @@ public virtual DeleteTransformResponse DeleteTransform(DeleteTransformRequestDes } /// - /// Delete a transform.
Deletes a transform. + /// + /// Delete a transform. + /// Deletes a transform. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -82,7 +96,10 @@ public virtual DeleteTransformResponse DeleteTransform(Elastic.Clients.Elasticse } /// - /// Delete a transform.
Deletes a transform. + /// + /// Delete a transform. + /// Deletes a transform. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -95,7 +112,10 @@ public virtual DeleteTransformResponse DeleteTransform(Elastic.Clients.Elasticse } /// - /// Delete a transform.
Deletes a transform. + /// + /// Delete a transform. + /// Deletes a transform. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteTransformAsync(DeleteTransformRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -105,7 +125,10 @@ public virtual Task DeleteTransformAsync(DeleteTransfor } /// - /// Delete a transform.
Deletes a transform. + /// + /// Delete a transform. + /// Deletes a transform. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteTransformAsync(Elastic.Clients.Elasticsearch.Id transformId, CancellationToken cancellationToken = default) @@ -116,7 +139,10 @@ public virtual Task DeleteTransformAsync(Elastic.Client } /// - /// Delete a transform.
Deletes a transform. + /// + /// Delete a transform. + /// Deletes a transform. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteTransformAsync(Elastic.Clients.Elasticsearch.Id transformId, Action configureRequest, CancellationToken cancellationToken = default) @@ -128,7 +154,10 @@ public virtual Task DeleteTransformAsync(Elastic.Client } /// - /// Get transforms.
Retrieves configuration information for transforms. + /// + /// Get transforms. + /// Retrieves configuration information for transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -139,7 +168,10 @@ public virtual GetTransformResponse GetTransform(GetTransformRequest request) } /// - /// Get transforms.
Retrieves configuration information for transforms. + /// + /// Get transforms. + /// Retrieves configuration information for transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTransformAsync(GetTransformRequest request, CancellationToken cancellationToken = default) @@ -149,7 +181,10 @@ public virtual Task GetTransformAsync(GetTransformRequest } /// - /// Get transforms.
Retrieves configuration information for transforms. + /// + /// Get transforms. + /// Retrieves configuration information for transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -160,7 +195,10 @@ public virtual GetTransformResponse GetTransform(GetTransformRequestDescriptor d } /// - /// Get transforms.
Retrieves configuration information for transforms. + /// + /// Get transforms. + /// Retrieves configuration information for transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -172,7 +210,10 @@ public virtual GetTransformResponse GetTransform(Elastic.Clients.Elasticsearch.N } /// - /// Get transforms.
Retrieves configuration information for transforms. + /// + /// Get transforms. + /// Retrieves configuration information for transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -185,7 +226,10 @@ public virtual GetTransformResponse GetTransform(Elastic.Clients.Elasticsearch.N } /// - /// Get transforms.
Retrieves configuration information for transforms. + /// + /// Get transforms. + /// Retrieves configuration information for transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -197,7 +241,10 @@ public virtual GetTransformResponse GetTransform() } /// - /// Get transforms.
Retrieves configuration information for transforms. + /// + /// Get transforms. + /// Retrieves configuration information for transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -210,7 +257,10 @@ public virtual GetTransformResponse GetTransform(Action - /// Get transforms.
Retrieves configuration information for transforms. + /// + /// Get transforms. + /// Retrieves configuration information for transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTransformAsync(GetTransformRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -220,7 +270,10 @@ public virtual Task GetTransformAsync(GetTransformRequestD } /// - /// Get transforms.
Retrieves configuration information for transforms. + /// + /// Get transforms. + /// Retrieves configuration information for transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTransformAsync(Elastic.Clients.Elasticsearch.Names? transformId, CancellationToken cancellationToken = default) @@ -231,7 +284,10 @@ public virtual Task GetTransformAsync(Elastic.Clients.Elas } /// - /// Get transforms.
Retrieves configuration information for transforms. + /// + /// Get transforms. + /// Retrieves configuration information for transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTransformAsync(Elastic.Clients.Elasticsearch.Names? transformId, Action configureRequest, CancellationToken cancellationToken = default) @@ -243,7 +299,10 @@ public virtual Task GetTransformAsync(Elastic.Clients.Elas } /// - /// Get transforms.
Retrieves configuration information for transforms. + /// + /// Get transforms. + /// Retrieves configuration information for transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTransformAsync(CancellationToken cancellationToken = default) @@ -254,7 +313,10 @@ public virtual Task GetTransformAsync(CancellationToken ca } /// - /// Get transforms.
Retrieves configuration information for transforms. + /// + /// Get transforms. + /// Retrieves configuration information for transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTransformAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -266,7 +328,10 @@ public virtual Task GetTransformAsync(Action - /// Get transform stats.
Retrieves usage information for transforms. + /// + /// Get transform stats. + /// Retrieves usage information for transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -277,7 +342,10 @@ public virtual GetTransformStatsResponse GetTransformStats(GetTransformStatsRequ } /// - /// Get transform stats.
Retrieves usage information for transforms. + /// + /// Get transform stats. + /// Retrieves usage information for transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTransformStatsAsync(GetTransformStatsRequest request, CancellationToken cancellationToken = default) @@ -287,7 +355,10 @@ public virtual Task GetTransformStatsAsync(GetTransfo } /// - /// Get transform stats.
Retrieves usage information for transforms. + /// + /// Get transform stats. + /// Retrieves usage information for transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -298,7 +369,10 @@ public virtual GetTransformStatsResponse GetTransformStats(GetTransformStatsRequ } /// - /// Get transform stats.
Retrieves usage information for transforms. + /// + /// Get transform stats. + /// Retrieves usage information for transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -310,7 +384,10 @@ public virtual GetTransformStatsResponse GetTransformStats(Elastic.Clients.Elast } /// - /// Get transform stats.
Retrieves usage information for transforms. + /// + /// Get transform stats. + /// Retrieves usage information for transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -323,7 +400,10 @@ public virtual GetTransformStatsResponse GetTransformStats(Elastic.Clients.Elast } /// - /// Get transform stats.
Retrieves usage information for transforms. + /// + /// Get transform stats. + /// Retrieves usage information for transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTransformStatsAsync(GetTransformStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -333,7 +413,10 @@ public virtual Task GetTransformStatsAsync(GetTransfo } /// - /// Get transform stats.
Retrieves usage information for transforms. + /// + /// Get transform stats. + /// Retrieves usage information for transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTransformStatsAsync(Elastic.Clients.Elasticsearch.Names transformId, CancellationToken cancellationToken = default) @@ -344,7 +427,10 @@ public virtual Task GetTransformStatsAsync(Elastic.Cl } /// - /// Get transform stats.
Retrieves usage information for transforms. + /// + /// Get transform stats. + /// Retrieves usage information for transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetTransformStatsAsync(Elastic.Clients.Elasticsearch.Names transformId, Action configureRequest, CancellationToken cancellationToken = default) @@ -356,8 +442,15 @@ public virtual Task GetTransformStatsAsync(Elastic.Cl } /// - /// Preview a transform.
Generates a preview of the results that you will get when you create a transform with the same configuration. - /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also
generates a list of mappings and settings for the destination index. These values are determined based on the field
types of the source index and the transform aggregations. + /// + /// Preview a transform. + /// Generates a preview of the results that you will get when you create a transform with the same configuration. + /// + /// + /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also + /// generates a list of mappings and settings for the destination index. These values are determined based on the field + /// types of the source index and the transform aggregations. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -368,8 +461,15 @@ public virtual PreviewTransformResponse PreviewTransform } /// - /// Preview a transform.
Generates a preview of the results that you will get when you create a transform with the same configuration. - /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also
generates a list of mappings and settings for the destination index. These values are determined based on the field
types of the source index and the transform aggregations. + /// + /// Preview a transform. + /// Generates a preview of the results that you will get when you create a transform with the same configuration. + /// + /// + /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also + /// generates a list of mappings and settings for the destination index. These values are determined based on the field + /// types of the source index and the transform aggregations. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> PreviewTransformAsync(PreviewTransformRequest request, CancellationToken cancellationToken = default) @@ -379,8 +479,15 @@ public virtual Task> PreviewTransformAsync< } /// - /// Preview a transform.
Generates a preview of the results that you will get when you create a transform with the same configuration. - /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also
generates a list of mappings and settings for the destination index. These values are determined based on the field
types of the source index and the transform aggregations. + /// + /// Preview a transform. + /// Generates a preview of the results that you will get when you create a transform with the same configuration. + /// + /// + /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also + /// generates a list of mappings and settings for the destination index. These values are determined based on the field + /// types of the source index and the transform aggregations. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -391,8 +498,15 @@ public virtual PreviewTransformResponse PreviewTransform } /// - /// Preview a transform.
Generates a preview of the results that you will get when you create a transform with the same configuration. - /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also
generates a list of mappings and settings for the destination index. These values are determined based on the field
types of the source index and the transform aggregations. + /// + /// Preview a transform. + /// Generates a preview of the results that you will get when you create a transform with the same configuration. + /// + /// + /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also + /// generates a list of mappings and settings for the destination index. These values are determined based on the field + /// types of the source index and the transform aggregations. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -404,8 +518,15 @@ public virtual PreviewTransformResponse PreviewTransform } /// - /// Preview a transform.
Generates a preview of the results that you will get when you create a transform with the same configuration. - /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also
generates a list of mappings and settings for the destination index. These values are determined based on the field
types of the source index and the transform aggregations. + /// + /// Preview a transform. + /// Generates a preview of the results that you will get when you create a transform with the same configuration. + /// + /// + /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also + /// generates a list of mappings and settings for the destination index. These values are determined based on the field + /// types of the source index and the transform aggregations. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -418,8 +539,15 @@ public virtual PreviewTransformResponse PreviewTransform } /// - /// Preview a transform.
Generates a preview of the results that you will get when you create a transform with the same configuration. - /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also
generates a list of mappings and settings for the destination index. These values are determined based on the field
types of the source index and the transform aggregations. + /// + /// Preview a transform. + /// Generates a preview of the results that you will get when you create a transform with the same configuration. + /// + /// + /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also + /// generates a list of mappings and settings for the destination index. These values are determined based on the field + /// types of the source index and the transform aggregations. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -431,8 +559,15 @@ public virtual PreviewTransformResponse PreviewTransform } /// - /// Preview a transform.
Generates a preview of the results that you will get when you create a transform with the same configuration. - /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also
generates a list of mappings and settings for the destination index. These values are determined based on the field
types of the source index and the transform aggregations. + /// + /// Preview a transform. + /// Generates a preview of the results that you will get when you create a transform with the same configuration. + /// + /// + /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also + /// generates a list of mappings and settings for the destination index. These values are determined based on the field + /// types of the source index and the transform aggregations. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -445,8 +580,15 @@ public virtual PreviewTransformResponse PreviewTransform } /// - /// Preview a transform.
Generates a preview of the results that you will get when you create a transform with the same configuration. - /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also
generates a list of mappings and settings for the destination index. These values are determined based on the field
types of the source index and the transform aggregations. + /// + /// Preview a transform. + /// Generates a preview of the results that you will get when you create a transform with the same configuration. + /// + /// + /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also + /// generates a list of mappings and settings for the destination index. These values are determined based on the field + /// types of the source index and the transform aggregations. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> PreviewTransformAsync(PreviewTransformRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -456,8 +598,15 @@ public virtual Task> PreviewTransformAsync< } /// - /// Preview a transform.
Generates a preview of the results that you will get when you create a transform with the same configuration. - /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also
generates a list of mappings and settings for the destination index. These values are determined based on the field
types of the source index and the transform aggregations. + /// + /// Preview a transform. + /// Generates a preview of the results that you will get when you create a transform with the same configuration. + /// + /// + /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also + /// generates a list of mappings and settings for the destination index. These values are determined based on the field + /// types of the source index and the transform aggregations. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> PreviewTransformAsync(Elastic.Clients.Elasticsearch.Id? transformId, CancellationToken cancellationToken = default) @@ -468,8 +617,15 @@ public virtual Task> PreviewTransformAsync< } /// - /// Preview a transform.
Generates a preview of the results that you will get when you create a transform with the same configuration. - /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also
generates a list of mappings and settings for the destination index. These values are determined based on the field
types of the source index and the transform aggregations. + /// + /// Preview a transform. + /// Generates a preview of the results that you will get when you create a transform with the same configuration. + /// + /// + /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also + /// generates a list of mappings and settings for the destination index. These values are determined based on the field + /// types of the source index and the transform aggregations. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> PreviewTransformAsync(Elastic.Clients.Elasticsearch.Id? transformId, Action> configureRequest, CancellationToken cancellationToken = default) @@ -481,8 +637,15 @@ public virtual Task> PreviewTransformAsync< } /// - /// Preview a transform.
Generates a preview of the results that you will get when you create a transform with the same configuration. - /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also
generates a list of mappings and settings for the destination index. These values are determined based on the field
types of the source index and the transform aggregations. + /// + /// Preview a transform. + /// Generates a preview of the results that you will get when you create a transform with the same configuration. + /// + /// + /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also + /// generates a list of mappings and settings for the destination index. These values are determined based on the field + /// types of the source index and the transform aggregations. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> PreviewTransformAsync(CancellationToken cancellationToken = default) @@ -493,8 +656,15 @@ public virtual Task> PreviewTransformAsync< } /// - /// Preview a transform.
Generates a preview of the results that you will get when you create a transform with the same configuration. - /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also
generates a list of mappings and settings for the destination index. These values are determined based on the field
types of the source index and the transform aggregations. + /// + /// Preview a transform. + /// Generates a preview of the results that you will get when you create a transform with the same configuration. + /// + /// + /// It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also + /// generates a list of mappings and settings for the destination index. These values are determined based on the field + /// types of the source index and the transform aggregations. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> PreviewTransformAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -506,11 +676,34 @@ public virtual Task> PreviewTransformAsync< } /// - /// Create a transform.
Creates a transform. - /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as
a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
unique row per entity. - /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If
you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in
the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values
in the latest object. - /// You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and
`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the
transform remembers which roles the user that created it had at the time of creation and uses those same roles. If
those roles do not have the required privileges on the source and destination indices, the transform fails when it
attempts unauthorized operations. - /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any
`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not
give users any privileges on `.data-frame-internal*` indices. + /// + /// Create a transform. + /// Creates a transform. + /// + /// + /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as + /// a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a + /// unique row per entity. + /// + /// + /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If + /// you choose to use the pivot method for your transform, the entities are defined by the set of group_by fields in + /// the pivot object. If you choose to use the latest method, the entities are defined by the unique_key field values + /// in the latest object. + /// + /// + /// You must have create_index, index, and read privileges on the destination index and read and + /// view_index_metadata privileges on the source indices. When Elasticsearch security features are enabled, the + /// transform remembers which roles the user that created it had at the time of creation and uses those same roles. If + /// those roles do not have the required privileges on the source and destination indices, the transform fails when it + /// attempts unauthorized operations. + /// + /// + /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any + /// .transform-internal* indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do + /// not give users any privileges on .transform-internal* indices. If you used transforms prior to 7.5, also do not + /// give users any privileges on .data-frame-internal* indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -521,11 +714,34 @@ public virtual PutTransformResponse PutTransform(PutTransformRequest request) } /// - /// Create a transform.
Creates a transform. - /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as
a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
unique row per entity. - /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If
you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in
the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values
in the latest object. - /// You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and
`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the
transform remembers which roles the user that created it had at the time of creation and uses those same roles. If
those roles do not have the required privileges on the source and destination indices, the transform fails when it
attempts unauthorized operations. - /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any
`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not
give users any privileges on `.data-frame-internal*` indices. + /// + /// Create a transform. + /// Creates a transform. + /// + /// + /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as + /// a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a + /// unique row per entity. + /// + /// + /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If + /// you choose to use the pivot method for your transform, the entities are defined by the set of group_by fields in + /// the pivot object. If you choose to use the latest method, the entities are defined by the unique_key field values + /// in the latest object. + /// + /// + /// You must have create_index, index, and read privileges on the destination index and read and + /// view_index_metadata privileges on the source indices. When Elasticsearch security features are enabled, the + /// transform remembers which roles the user that created it had at the time of creation and uses those same roles. If + /// those roles do not have the required privileges on the source and destination indices, the transform fails when it + /// attempts unauthorized operations. + /// + /// + /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any + /// .transform-internal* indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do + /// not give users any privileges on .transform-internal* indices. If you used transforms prior to 7.5, also do not + /// give users any privileges on .data-frame-internal* indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTransformAsync(PutTransformRequest request, CancellationToken cancellationToken = default) @@ -535,11 +751,34 @@ public virtual Task PutTransformAsync(PutTransformRequest } /// - /// Create a transform.
Creates a transform. - /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as
a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
unique row per entity. - /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If
you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in
the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values
in the latest object. - /// You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and
`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the
transform remembers which roles the user that created it had at the time of creation and uses those same roles. If
those roles do not have the required privileges on the source and destination indices, the transform fails when it
attempts unauthorized operations. - /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any
`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not
give users any privileges on `.data-frame-internal*` indices. + /// + /// Create a transform. + /// Creates a transform. + /// + /// + /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as + /// a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a + /// unique row per entity. + /// + /// + /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If + /// you choose to use the pivot method for your transform, the entities are defined by the set of group_by fields in + /// the pivot object. If you choose to use the latest method, the entities are defined by the unique_key field values + /// in the latest object. + /// + /// + /// You must have create_index, index, and read privileges on the destination index and read and + /// view_index_metadata privileges on the source indices. When Elasticsearch security features are enabled, the + /// transform remembers which roles the user that created it had at the time of creation and uses those same roles. If + /// those roles do not have the required privileges on the source and destination indices, the transform fails when it + /// attempts unauthorized operations. + /// + /// + /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any + /// .transform-internal* indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do + /// not give users any privileges on .transform-internal* indices. If you used transforms prior to 7.5, also do not + /// give users any privileges on .data-frame-internal* indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -550,11 +789,34 @@ public virtual PutTransformResponse PutTransform(PutTransformRequestD } /// - /// Create a transform.
Creates a transform. - /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as
a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
unique row per entity. - /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If
you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in
the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values
in the latest object. - /// You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and
`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the
transform remembers which roles the user that created it had at the time of creation and uses those same roles. If
those roles do not have the required privileges on the source and destination indices, the transform fails when it
attempts unauthorized operations. - /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any
`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not
give users any privileges on `.data-frame-internal*` indices. + /// + /// Create a transform. + /// Creates a transform. + /// + /// + /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as + /// a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a + /// unique row per entity. + /// + /// + /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If + /// you choose to use the pivot method for your transform, the entities are defined by the set of group_by fields in + /// the pivot object. If you choose to use the latest method, the entities are defined by the unique_key field values + /// in the latest object. + /// + /// + /// You must have create_index, index, and read privileges on the destination index and read and + /// view_index_metadata privileges on the source indices. When Elasticsearch security features are enabled, the + /// transform remembers which roles the user that created it had at the time of creation and uses those same roles. If + /// those roles do not have the required privileges on the source and destination indices, the transform fails when it + /// attempts unauthorized operations. + /// + /// + /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any + /// .transform-internal* indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do + /// not give users any privileges on .transform-internal* indices. If you used transforms prior to 7.5, also do not + /// give users any privileges on .data-frame-internal* indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -566,11 +828,34 @@ public virtual PutTransformResponse PutTransform(Elastic.Clients.Elas } /// - /// Create a transform.
Creates a transform. - /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as
a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
unique row per entity. - /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If
you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in
the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values
in the latest object. - /// You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and
`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the
transform remembers which roles the user that created it had at the time of creation and uses those same roles. If
those roles do not have the required privileges on the source and destination indices, the transform fails when it
attempts unauthorized operations. - /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any
`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not
give users any privileges on `.data-frame-internal*` indices. + /// + /// Create a transform. + /// Creates a transform. + /// + /// + /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as + /// a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a + /// unique row per entity. + /// + /// + /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If + /// you choose to use the pivot method for your transform, the entities are defined by the set of group_by fields in + /// the pivot object. If you choose to use the latest method, the entities are defined by the unique_key field values + /// in the latest object. + /// + /// + /// You must have create_index, index, and read privileges on the destination index and read and + /// view_index_metadata privileges on the source indices. When Elasticsearch security features are enabled, the + /// transform remembers which roles the user that created it had at the time of creation and uses those same roles. If + /// those roles do not have the required privileges on the source and destination indices, the transform fails when it + /// attempts unauthorized operations. + /// + /// + /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any + /// .transform-internal* indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do + /// not give users any privileges on .transform-internal* indices. If you used transforms prior to 7.5, also do not + /// give users any privileges on .data-frame-internal* indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -583,11 +868,34 @@ public virtual PutTransformResponse PutTransform(Elastic.Clients.Elas } /// - /// Create a transform.
Creates a transform. - /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as
a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
unique row per entity. - /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If
you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in
the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values
in the latest object. - /// You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and
`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the
transform remembers which roles the user that created it had at the time of creation and uses those same roles. If
those roles do not have the required privileges on the source and destination indices, the transform fails when it
attempts unauthorized operations. - /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any
`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not
give users any privileges on `.data-frame-internal*` indices. + /// + /// Create a transform. + /// Creates a transform. + /// + /// + /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as + /// a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a + /// unique row per entity. + /// + /// + /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If + /// you choose to use the pivot method for your transform, the entities are defined by the set of group_by fields in + /// the pivot object. If you choose to use the latest method, the entities are defined by the unique_key field values + /// in the latest object. + /// + /// + /// You must have create_index, index, and read privileges on the destination index and read and + /// view_index_metadata privileges on the source indices. When Elasticsearch security features are enabled, the + /// transform remembers which roles the user that created it had at the time of creation and uses those same roles. If + /// those roles do not have the required privileges on the source and destination indices, the transform fails when it + /// attempts unauthorized operations. + /// + /// + /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any + /// .transform-internal* indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do + /// not give users any privileges on .transform-internal* indices. If you used transforms prior to 7.5, also do not + /// give users any privileges on .data-frame-internal* indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -598,11 +906,34 @@ public virtual PutTransformResponse PutTransform(PutTransformRequestDescriptor d } /// - /// Create a transform.
Creates a transform. - /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as
a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
unique row per entity. - /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If
you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in
the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values
in the latest object. - /// You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and
`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the
transform remembers which roles the user that created it had at the time of creation and uses those same roles. If
those roles do not have the required privileges on the source and destination indices, the transform fails when it
attempts unauthorized operations. - /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any
`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not
give users any privileges on `.data-frame-internal*` indices. + /// + /// Create a transform. + /// Creates a transform. + /// + /// + /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as + /// a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a + /// unique row per entity. + /// + /// + /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If + /// you choose to use the pivot method for your transform, the entities are defined by the set of group_by fields in + /// the pivot object. If you choose to use the latest method, the entities are defined by the unique_key field values + /// in the latest object. + /// + /// + /// You must have create_index, index, and read privileges on the destination index and read and + /// view_index_metadata privileges on the source indices. When Elasticsearch security features are enabled, the + /// transform remembers which roles the user that created it had at the time of creation and uses those same roles. If + /// those roles do not have the required privileges on the source and destination indices, the transform fails when it + /// attempts unauthorized operations. + /// + /// + /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any + /// .transform-internal* indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do + /// not give users any privileges on .transform-internal* indices. If you used transforms prior to 7.5, also do not + /// give users any privileges on .data-frame-internal* indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -614,11 +945,34 @@ public virtual PutTransformResponse PutTransform(Elastic.Clients.Elasticsearch.I } /// - /// Create a transform.
Creates a transform. - /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as
a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
unique row per entity. - /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If
you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in
the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values
in the latest object. - /// You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and
`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the
transform remembers which roles the user that created it had at the time of creation and uses those same roles. If
those roles do not have the required privileges on the source and destination indices, the transform fails when it
attempts unauthorized operations. - /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any
`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not
give users any privileges on `.data-frame-internal*` indices. + /// + /// Create a transform. + /// Creates a transform. + /// + /// + /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as + /// a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a + /// unique row per entity. + /// + /// + /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If + /// you choose to use the pivot method for your transform, the entities are defined by the set of group_by fields in + /// the pivot object. If you choose to use the latest method, the entities are defined by the unique_key field values + /// in the latest object. + /// + /// + /// You must have create_index, index, and read privileges on the destination index and read and + /// view_index_metadata privileges on the source indices. When Elasticsearch security features are enabled, the + /// transform remembers which roles the user that created it had at the time of creation and uses those same roles. If + /// those roles do not have the required privileges on the source and destination indices, the transform fails when it + /// attempts unauthorized operations. + /// + /// + /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any + /// .transform-internal* indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do + /// not give users any privileges on .transform-internal* indices. If you used transforms prior to 7.5, also do not + /// give users any privileges on .data-frame-internal* indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -631,11 +985,34 @@ public virtual PutTransformResponse PutTransform(Elastic.Clients.Elasticsearch.I } /// - /// Create a transform.
Creates a transform. - /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as
a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
unique row per entity. - /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If
you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in
the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values
in the latest object. - /// You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and
`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the
transform remembers which roles the user that created it had at the time of creation and uses those same roles. If
those roles do not have the required privileges on the source and destination indices, the transform fails when it
attempts unauthorized operations. - /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any
`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not
give users any privileges on `.data-frame-internal*` indices. + /// + /// Create a transform. + /// Creates a transform. + /// + /// + /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as + /// a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a + /// unique row per entity. + /// + /// + /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If + /// you choose to use the pivot method for your transform, the entities are defined by the set of group_by fields in + /// the pivot object. If you choose to use the latest method, the entities are defined by the unique_key field values + /// in the latest object. + /// + /// + /// You must have create_index, index, and read privileges on the destination index and read and + /// view_index_metadata privileges on the source indices. When Elasticsearch security features are enabled, the + /// transform remembers which roles the user that created it had at the time of creation and uses those same roles. If + /// those roles do not have the required privileges on the source and destination indices, the transform fails when it + /// attempts unauthorized operations. + /// + /// + /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any + /// .transform-internal* indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do + /// not give users any privileges on .transform-internal* indices. If you used transforms prior to 7.5, also do not + /// give users any privileges on .data-frame-internal* indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTransformAsync(PutTransformRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -645,11 +1022,34 @@ public virtual Task PutTransformAsync(PutTransf } /// - /// Create a transform.
Creates a transform. - /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as
a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
unique row per entity. - /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If
you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in
the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values
in the latest object. - /// You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and
`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the
transform remembers which roles the user that created it had at the time of creation and uses those same roles. If
those roles do not have the required privileges on the source and destination indices, the transform fails when it
attempts unauthorized operations. - /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any
`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not
give users any privileges on `.data-frame-internal*` indices. + /// + /// Create a transform. + /// Creates a transform. + /// + /// + /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as + /// a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a + /// unique row per entity. + /// + /// + /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If + /// you choose to use the pivot method for your transform, the entities are defined by the set of group_by fields in + /// the pivot object. If you choose to use the latest method, the entities are defined by the unique_key field values + /// in the latest object. + /// + /// + /// You must have create_index, index, and read privileges on the destination index and read and + /// view_index_metadata privileges on the source indices. When Elasticsearch security features are enabled, the + /// transform remembers which roles the user that created it had at the time of creation and uses those same roles. If + /// those roles do not have the required privileges on the source and destination indices, the transform fails when it + /// attempts unauthorized operations. + /// + /// + /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any + /// .transform-internal* indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do + /// not give users any privileges on .transform-internal* indices. If you used transforms prior to 7.5, also do not + /// give users any privileges on .data-frame-internal* indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTransformAsync(Elastic.Clients.Elasticsearch.Id transformId, CancellationToken cancellationToken = default) @@ -660,11 +1060,34 @@ public virtual Task PutTransformAsync(Elastic.C } /// - /// Create a transform.
Creates a transform. - /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as
a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
unique row per entity. - /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If
you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in
the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values
in the latest object. - /// You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and
`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the
transform remembers which roles the user that created it had at the time of creation and uses those same roles. If
those roles do not have the required privileges on the source and destination indices, the transform fails when it
attempts unauthorized operations. - /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any
`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not
give users any privileges on `.data-frame-internal*` indices. + /// + /// Create a transform. + /// Creates a transform. + /// + /// + /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as + /// a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a + /// unique row per entity. + /// + /// + /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If + /// you choose to use the pivot method for your transform, the entities are defined by the set of group_by fields in + /// the pivot object. If you choose to use the latest method, the entities are defined by the unique_key field values + /// in the latest object. + /// + /// + /// You must have create_index, index, and read privileges on the destination index and read and + /// view_index_metadata privileges on the source indices. When Elasticsearch security features are enabled, the + /// transform remembers which roles the user that created it had at the time of creation and uses those same roles. If + /// those roles do not have the required privileges on the source and destination indices, the transform fails when it + /// attempts unauthorized operations. + /// + /// + /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any + /// .transform-internal* indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do + /// not give users any privileges on .transform-internal* indices. If you used transforms prior to 7.5, also do not + /// give users any privileges on .data-frame-internal* indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTransformAsync(Elastic.Clients.Elasticsearch.Id transformId, Action> configureRequest, CancellationToken cancellationToken = default) @@ -676,11 +1099,34 @@ public virtual Task PutTransformAsync(Elastic.C } /// - /// Create a transform.
Creates a transform. - /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as
a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
unique row per entity. - /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If
you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in
the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values
in the latest object. - /// You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and
`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the
transform remembers which roles the user that created it had at the time of creation and uses those same roles. If
those roles do not have the required privileges on the source and destination indices, the transform fails when it
attempts unauthorized operations. - /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any
`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not
give users any privileges on `.data-frame-internal*` indices. + /// + /// Create a transform. + /// Creates a transform. + /// + /// + /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as + /// a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a + /// unique row per entity. + /// + /// + /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If + /// you choose to use the pivot method for your transform, the entities are defined by the set of group_by fields in + /// the pivot object. If you choose to use the latest method, the entities are defined by the unique_key field values + /// in the latest object. + /// + /// + /// You must have create_index, index, and read privileges on the destination index and read and + /// view_index_metadata privileges on the source indices. When Elasticsearch security features are enabled, the + /// transform remembers which roles the user that created it had at the time of creation and uses those same roles. If + /// those roles do not have the required privileges on the source and destination indices, the transform fails when it + /// attempts unauthorized operations. + /// + /// + /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any + /// .transform-internal* indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do + /// not give users any privileges on .transform-internal* indices. If you used transforms prior to 7.5, also do not + /// give users any privileges on .data-frame-internal* indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTransformAsync(PutTransformRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -690,11 +1136,34 @@ public virtual Task PutTransformAsync(PutTransformRequestD } /// - /// Create a transform.
Creates a transform. - /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as
a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
unique row per entity. - /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If
you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in
the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values
in the latest object. - /// You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and
`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the
transform remembers which roles the user that created it had at the time of creation and uses those same roles. If
those roles do not have the required privileges on the source and destination indices, the transform fails when it
attempts unauthorized operations. - /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any
`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not
give users any privileges on `.data-frame-internal*` indices. + /// + /// Create a transform. + /// Creates a transform. + /// + /// + /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as + /// a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a + /// unique row per entity. + /// + /// + /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If + /// you choose to use the pivot method for your transform, the entities are defined by the set of group_by fields in + /// the pivot object. If you choose to use the latest method, the entities are defined by the unique_key field values + /// in the latest object. + /// + /// + /// You must have create_index, index, and read privileges on the destination index and read and + /// view_index_metadata privileges on the source indices. When Elasticsearch security features are enabled, the + /// transform remembers which roles the user that created it had at the time of creation and uses those same roles. If + /// those roles do not have the required privileges on the source and destination indices, the transform fails when it + /// attempts unauthorized operations. + /// + /// + /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any + /// .transform-internal* indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do + /// not give users any privileges on .transform-internal* indices. If you used transforms prior to 7.5, also do not + /// give users any privileges on .data-frame-internal* indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTransformAsync(Elastic.Clients.Elasticsearch.Id transformId, CancellationToken cancellationToken = default) @@ -705,11 +1174,34 @@ public virtual Task PutTransformAsync(Elastic.Clients.Elas } /// - /// Create a transform.
Creates a transform. - /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as
a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
unique row per entity. - /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If
you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in
the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values
in the latest object. - /// You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and
`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the
transform remembers which roles the user that created it had at the time of creation and uses those same roles. If
those roles do not have the required privileges on the source and destination indices, the transform fails when it
attempts unauthorized operations. - /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any
`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not
give users any privileges on `.data-frame-internal*` indices. + /// + /// Create a transform. + /// Creates a transform. + /// + /// + /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as + /// a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a + /// unique row per entity. + /// + /// + /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If + /// you choose to use the pivot method for your transform, the entities are defined by the set of group_by fields in + /// the pivot object. If you choose to use the latest method, the entities are defined by the unique_key field values + /// in the latest object. + /// + /// + /// You must have create_index, index, and read privileges on the destination index and read and + /// view_index_metadata privileges on the source indices. When Elasticsearch security features are enabled, the + /// transform remembers which roles the user that created it had at the time of creation and uses those same roles. If + /// those roles do not have the required privileges on the source and destination indices, the transform fails when it + /// attempts unauthorized operations. + /// + /// + /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any + /// .transform-internal* indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do + /// not give users any privileges on .transform-internal* indices. If you used transforms prior to 7.5, also do not + /// give users any privileges on .data-frame-internal* indices. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutTransformAsync(Elastic.Clients.Elasticsearch.Id transformId, Action configureRequest, CancellationToken cancellationToken = default) @@ -721,7 +1213,12 @@ public virtual Task PutTransformAsync(Elastic.Clients.Elas } /// - /// Reset a transform.
Resets a transform.
Before you can reset it, you must stop it; alternatively, use the `force` query parameter.
If the destination index was created by the transform, it is deleted. + /// + /// Reset a transform. + /// Resets a transform. + /// Before you can reset it, you must stop it; alternatively, use the force query parameter. + /// If the destination index was created by the transform, it is deleted. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -732,7 +1229,12 @@ public virtual ResetTransformResponse ResetTransform(ResetTransformRequest reque } /// - /// Reset a transform.
Resets a transform.
Before you can reset it, you must stop it; alternatively, use the `force` query parameter.
If the destination index was created by the transform, it is deleted. + /// + /// Reset a transform. + /// Resets a transform. + /// Before you can reset it, you must stop it; alternatively, use the force query parameter. + /// If the destination index was created by the transform, it is deleted. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResetTransformAsync(ResetTransformRequest request, CancellationToken cancellationToken = default) @@ -742,7 +1244,12 @@ public virtual Task ResetTransformAsync(ResetTransformRe } /// - /// Reset a transform.
Resets a transform.
Before you can reset it, you must stop it; alternatively, use the `force` query parameter.
If the destination index was created by the transform, it is deleted. + /// + /// Reset a transform. + /// Resets a transform. + /// Before you can reset it, you must stop it; alternatively, use the force query parameter. + /// If the destination index was created by the transform, it is deleted. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -753,7 +1260,12 @@ public virtual ResetTransformResponse ResetTransform(ResetTransformRequestDescri } /// - /// Reset a transform.
Resets a transform.
Before you can reset it, you must stop it; alternatively, use the `force` query parameter.
If the destination index was created by the transform, it is deleted. + /// + /// Reset a transform. + /// Resets a transform. + /// Before you can reset it, you must stop it; alternatively, use the force query parameter. + /// If the destination index was created by the transform, it is deleted. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -765,7 +1277,12 @@ public virtual ResetTransformResponse ResetTransform(Elastic.Clients.Elasticsear } /// - /// Reset a transform.
Resets a transform.
Before you can reset it, you must stop it; alternatively, use the `force` query parameter.
If the destination index was created by the transform, it is deleted. + /// + /// Reset a transform. + /// Resets a transform. + /// Before you can reset it, you must stop it; alternatively, use the force query parameter. + /// If the destination index was created by the transform, it is deleted. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -778,7 +1295,12 @@ public virtual ResetTransformResponse ResetTransform(Elastic.Clients.Elasticsear } /// - /// Reset a transform.
Resets a transform.
Before you can reset it, you must stop it; alternatively, use the `force` query parameter.
If the destination index was created by the transform, it is deleted. + /// + /// Reset a transform. + /// Resets a transform. + /// Before you can reset it, you must stop it; alternatively, use the force query parameter. + /// If the destination index was created by the transform, it is deleted. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResetTransformAsync(ResetTransformRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -788,7 +1310,12 @@ public virtual Task ResetTransformAsync(ResetTransformRe } /// - /// Reset a transform.
Resets a transform.
Before you can reset it, you must stop it; alternatively, use the `force` query parameter.
If the destination index was created by the transform, it is deleted. + /// + /// Reset a transform. + /// Resets a transform. + /// Before you can reset it, you must stop it; alternatively, use the force query parameter. + /// If the destination index was created by the transform, it is deleted. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResetTransformAsync(Elastic.Clients.Elasticsearch.Id transformId, CancellationToken cancellationToken = default) @@ -799,7 +1326,12 @@ public virtual Task ResetTransformAsync(Elastic.Clients. } /// - /// Reset a transform.
Resets a transform.
Before you can reset it, you must stop it; alternatively, use the `force` query parameter.
If the destination index was created by the transform, it is deleted. + /// + /// Reset a transform. + /// Resets a transform. + /// Before you can reset it, you must stop it; alternatively, use the force query parameter. + /// If the destination index was created by the transform, it is deleted. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResetTransformAsync(Elastic.Clients.Elasticsearch.Id transformId, Action configureRequest, CancellationToken cancellationToken = default) @@ -811,8 +1343,16 @@ public virtual Task ResetTransformAsync(Elastic.Clients. } /// - /// Schedule a transform to start now.
Instantly runs a transform to process data. - /// If you _schedule_now a transform, it will process the new data instantly,
without waiting for the configured frequency interval. After _schedule_now API is called,
the transform will be processed again at now + frequency unless _schedule_now API
is called again in the meantime. + /// + /// Schedule a transform to start now. + /// Instantly runs a transform to process data. + /// + /// + /// If you _schedule_now a transform, it will process the new data instantly, + /// without waiting for the configured frequency interval. After _schedule_now API is called, + /// the transform will be processed again at now + frequency unless _schedule_now API + /// is called again in the meantime. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -823,8 +1363,16 @@ public virtual ScheduleNowTransformResponse ScheduleNowTransform(ScheduleNowTran } /// - /// Schedule a transform to start now.
Instantly runs a transform to process data. - /// If you _schedule_now a transform, it will process the new data instantly,
without waiting for the configured frequency interval. After _schedule_now API is called,
the transform will be processed again at now + frequency unless _schedule_now API
is called again in the meantime. + /// + /// Schedule a transform to start now. + /// Instantly runs a transform to process data. + /// + /// + /// If you _schedule_now a transform, it will process the new data instantly, + /// without waiting for the configured frequency interval. After _schedule_now API is called, + /// the transform will be processed again at now + frequency unless _schedule_now API + /// is called again in the meantime. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ScheduleNowTransformAsync(ScheduleNowTransformRequest request, CancellationToken cancellationToken = default) @@ -834,8 +1382,16 @@ public virtual Task ScheduleNowTransformAsync(Sche } /// - /// Schedule a transform to start now.
Instantly runs a transform to process data. - /// If you _schedule_now a transform, it will process the new data instantly,
without waiting for the configured frequency interval. After _schedule_now API is called,
the transform will be processed again at now + frequency unless _schedule_now API
is called again in the meantime. + /// + /// Schedule a transform to start now. + /// Instantly runs a transform to process data. + /// + /// + /// If you _schedule_now a transform, it will process the new data instantly, + /// without waiting for the configured frequency interval. After _schedule_now API is called, + /// the transform will be processed again at now + frequency unless _schedule_now API + /// is called again in the meantime. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -846,8 +1402,16 @@ public virtual ScheduleNowTransformResponse ScheduleNowTransform(ScheduleNowTran } /// - /// Schedule a transform to start now.
Instantly runs a transform to process data. - /// If you _schedule_now a transform, it will process the new data instantly,
without waiting for the configured frequency interval. After _schedule_now API is called,
the transform will be processed again at now + frequency unless _schedule_now API
is called again in the meantime. + /// + /// Schedule a transform to start now. + /// Instantly runs a transform to process data. + /// + /// + /// If you _schedule_now a transform, it will process the new data instantly, + /// without waiting for the configured frequency interval. After _schedule_now API is called, + /// the transform will be processed again at now + frequency unless _schedule_now API + /// is called again in the meantime. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -859,8 +1423,16 @@ public virtual ScheduleNowTransformResponse ScheduleNowTransform(Elastic.Clients } /// - /// Schedule a transform to start now.
Instantly runs a transform to process data. - /// If you _schedule_now a transform, it will process the new data instantly,
without waiting for the configured frequency interval. After _schedule_now API is called,
the transform will be processed again at now + frequency unless _schedule_now API
is called again in the meantime. + /// + /// Schedule a transform to start now. + /// Instantly runs a transform to process data. + /// + /// + /// If you _schedule_now a transform, it will process the new data instantly, + /// without waiting for the configured frequency interval. After _schedule_now API is called, + /// the transform will be processed again at now + frequency unless _schedule_now API + /// is called again in the meantime. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -873,8 +1445,16 @@ public virtual ScheduleNowTransformResponse ScheduleNowTransform(Elastic.Clients } /// - /// Schedule a transform to start now.
Instantly runs a transform to process data. - /// If you _schedule_now a transform, it will process the new data instantly,
without waiting for the configured frequency interval. After _schedule_now API is called,
the transform will be processed again at now + frequency unless _schedule_now API
is called again in the meantime. + /// + /// Schedule a transform to start now. + /// Instantly runs a transform to process data. + /// + /// + /// If you _schedule_now a transform, it will process the new data instantly, + /// without waiting for the configured frequency interval. After _schedule_now API is called, + /// the transform will be processed again at now + frequency unless _schedule_now API + /// is called again in the meantime. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ScheduleNowTransformAsync(ScheduleNowTransformRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -884,8 +1464,16 @@ public virtual Task ScheduleNowTransformAsync(Sche } /// - /// Schedule a transform to start now.
Instantly runs a transform to process data. - /// If you _schedule_now a transform, it will process the new data instantly,
without waiting for the configured frequency interval. After _schedule_now API is called,
the transform will be processed again at now + frequency unless _schedule_now API
is called again in the meantime. + /// + /// Schedule a transform to start now. + /// Instantly runs a transform to process data. + /// + /// + /// If you _schedule_now a transform, it will process the new data instantly, + /// without waiting for the configured frequency interval. After _schedule_now API is called, + /// the transform will be processed again at now + frequency unless _schedule_now API + /// is called again in the meantime. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ScheduleNowTransformAsync(Elastic.Clients.Elasticsearch.Id transformId, CancellationToken cancellationToken = default) @@ -896,8 +1484,16 @@ public virtual Task ScheduleNowTransformAsync(Elas } /// - /// Schedule a transform to start now.
Instantly runs a transform to process data. - /// If you _schedule_now a transform, it will process the new data instantly,
without waiting for the configured frequency interval. After _schedule_now API is called,
the transform will be processed again at now + frequency unless _schedule_now API
is called again in the meantime. + /// + /// Schedule a transform to start now. + /// Instantly runs a transform to process data. + /// + /// + /// If you _schedule_now a transform, it will process the new data instantly, + /// without waiting for the configured frequency interval. After _schedule_now API is called, + /// the transform will be processed again at now + frequency unless _schedule_now API + /// is called again in the meantime. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ScheduleNowTransformAsync(Elastic.Clients.Elasticsearch.Id transformId, Action configureRequest, CancellationToken cancellationToken = default) @@ -909,9 +1505,27 @@ public virtual Task ScheduleNowTransformAsync(Elas } /// - /// Start a transform.
Starts a transform. - /// When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is
set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping
definitions for the destination index from the source indices and the transform aggregations. If fields in the
destination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),
the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce
mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you
start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings
in a pivot transform. - /// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you
created the transform, they occur when you start the transform—​with the exception of privilege checks. When
Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the
time of creation and uses those same roles. If those roles do not have the required privileges on the source and
destination indices, the transform fails when it attempts unauthorized operations. + /// + /// Start a transform. + /// Starts a transform. + /// + /// + /// When you start a transform, it creates the destination index if it does not already exist. The number_of_shards is + /// set to 1 and the auto_expand_replicas is set to 0-1. If it is a pivot transform, it deduces the mapping + /// definitions for the destination index from the source indices and the transform aggregations. If fields in the + /// destination index are derived from scripts (as in the case of scripted_metric or bucket_script aggregations), + /// the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce + /// mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you + /// start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings + /// in a pivot transform. + /// + /// + /// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you + /// created the transform, they occur when you start the transform—​with the exception of privilege checks. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the + /// time of creation and uses those same roles. If those roles do not have the required privileges on the source and + /// destination indices, the transform fails when it attempts unauthorized operations. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -922,9 +1536,27 @@ public virtual StartTransformResponse StartTransform(StartTransformRequest reque } /// - /// Start a transform.
Starts a transform. - /// When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is
set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping
definitions for the destination index from the source indices and the transform aggregations. If fields in the
destination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),
the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce
mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you
start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings
in a pivot transform. - /// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you
created the transform, they occur when you start the transform—​with the exception of privilege checks. When
Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the
time of creation and uses those same roles. If those roles do not have the required privileges on the source and
destination indices, the transform fails when it attempts unauthorized operations. + /// + /// Start a transform. + /// Starts a transform. + /// + /// + /// When you start a transform, it creates the destination index if it does not already exist. The number_of_shards is + /// set to 1 and the auto_expand_replicas is set to 0-1. If it is a pivot transform, it deduces the mapping + /// definitions for the destination index from the source indices and the transform aggregations. If fields in the + /// destination index are derived from scripts (as in the case of scripted_metric or bucket_script aggregations), + /// the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce + /// mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you + /// start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings + /// in a pivot transform. + /// + /// + /// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you + /// created the transform, they occur when you start the transform—​with the exception of privilege checks. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the + /// time of creation and uses those same roles. If those roles do not have the required privileges on the source and + /// destination indices, the transform fails when it attempts unauthorized operations. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartTransformAsync(StartTransformRequest request, CancellationToken cancellationToken = default) @@ -934,9 +1566,27 @@ public virtual Task StartTransformAsync(StartTransformRe } /// - /// Start a transform.
Starts a transform. - /// When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is
set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping
definitions for the destination index from the source indices and the transform aggregations. If fields in the
destination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),
the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce
mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you
start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings
in a pivot transform. - /// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you
created the transform, they occur when you start the transform—​with the exception of privilege checks. When
Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the
time of creation and uses those same roles. If those roles do not have the required privileges on the source and
destination indices, the transform fails when it attempts unauthorized operations. + /// + /// Start a transform. + /// Starts a transform. + /// + /// + /// When you start a transform, it creates the destination index if it does not already exist. The number_of_shards is + /// set to 1 and the auto_expand_replicas is set to 0-1. If it is a pivot transform, it deduces the mapping + /// definitions for the destination index from the source indices and the transform aggregations. If fields in the + /// destination index are derived from scripts (as in the case of scripted_metric or bucket_script aggregations), + /// the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce + /// mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you + /// start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings + /// in a pivot transform. + /// + /// + /// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you + /// created the transform, they occur when you start the transform—​with the exception of privilege checks. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the + /// time of creation and uses those same roles. If those roles do not have the required privileges on the source and + /// destination indices, the transform fails when it attempts unauthorized operations. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -947,9 +1597,27 @@ public virtual StartTransformResponse StartTransform(StartTransformRequestDescri } /// - /// Start a transform.
Starts a transform. - /// When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is
set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping
definitions for the destination index from the source indices and the transform aggregations. If fields in the
destination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),
the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce
mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you
start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings
in a pivot transform. - /// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you
created the transform, they occur when you start the transform—​with the exception of privilege checks. When
Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the
time of creation and uses those same roles. If those roles do not have the required privileges on the source and
destination indices, the transform fails when it attempts unauthorized operations. + /// + /// Start a transform. + /// Starts a transform. + /// + /// + /// When you start a transform, it creates the destination index if it does not already exist. The number_of_shards is + /// set to 1 and the auto_expand_replicas is set to 0-1. If it is a pivot transform, it deduces the mapping + /// definitions for the destination index from the source indices and the transform aggregations. If fields in the + /// destination index are derived from scripts (as in the case of scripted_metric or bucket_script aggregations), + /// the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce + /// mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you + /// start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings + /// in a pivot transform. + /// + /// + /// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you + /// created the transform, they occur when you start the transform—​with the exception of privilege checks. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the + /// time of creation and uses those same roles. If those roles do not have the required privileges on the source and + /// destination indices, the transform fails when it attempts unauthorized operations. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -961,9 +1629,27 @@ public virtual StartTransformResponse StartTransform(Elastic.Clients.Elasticsear } /// - /// Start a transform.
Starts a transform. - /// When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is
set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping
definitions for the destination index from the source indices and the transform aggregations. If fields in the
destination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),
the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce
mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you
start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings
in a pivot transform. - /// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you
created the transform, they occur when you start the transform—​with the exception of privilege checks. When
Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the
time of creation and uses those same roles. If those roles do not have the required privileges on the source and
destination indices, the transform fails when it attempts unauthorized operations. + /// + /// Start a transform. + /// Starts a transform. + /// + /// + /// When you start a transform, it creates the destination index if it does not already exist. The number_of_shards is + /// set to 1 and the auto_expand_replicas is set to 0-1. If it is a pivot transform, it deduces the mapping + /// definitions for the destination index from the source indices and the transform aggregations. If fields in the + /// destination index are derived from scripts (as in the case of scripted_metric or bucket_script aggregations), + /// the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce + /// mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you + /// start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings + /// in a pivot transform. + /// + /// + /// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you + /// created the transform, they occur when you start the transform—​with the exception of privilege checks. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the + /// time of creation and uses those same roles. If those roles do not have the required privileges on the source and + /// destination indices, the transform fails when it attempts unauthorized operations. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -976,9 +1662,27 @@ public virtual StartTransformResponse StartTransform(Elastic.Clients.Elasticsear } /// - /// Start a transform.
Starts a transform. - /// When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is
set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping
definitions for the destination index from the source indices and the transform aggregations. If fields in the
destination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),
the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce
mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you
start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings
in a pivot transform. - /// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you
created the transform, they occur when you start the transform—​with the exception of privilege checks. When
Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the
time of creation and uses those same roles. If those roles do not have the required privileges on the source and
destination indices, the transform fails when it attempts unauthorized operations. + /// + /// Start a transform. + /// Starts a transform. + /// + /// + /// When you start a transform, it creates the destination index if it does not already exist. The number_of_shards is + /// set to 1 and the auto_expand_replicas is set to 0-1. If it is a pivot transform, it deduces the mapping + /// definitions for the destination index from the source indices and the transform aggregations. If fields in the + /// destination index are derived from scripts (as in the case of scripted_metric or bucket_script aggregations), + /// the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce + /// mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you + /// start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings + /// in a pivot transform. + /// + /// + /// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you + /// created the transform, they occur when you start the transform—​with the exception of privilege checks. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the + /// time of creation and uses those same roles. If those roles do not have the required privileges on the source and + /// destination indices, the transform fails when it attempts unauthorized operations. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartTransformAsync(StartTransformRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -988,9 +1692,27 @@ public virtual Task StartTransformAsync(StartTransformRe } /// - /// Start a transform.
Starts a transform. - /// When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is
set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping
definitions for the destination index from the source indices and the transform aggregations. If fields in the
destination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),
the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce
mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you
start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings
in a pivot transform. - /// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you
created the transform, they occur when you start the transform—​with the exception of privilege checks. When
Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the
time of creation and uses those same roles. If those roles do not have the required privileges on the source and
destination indices, the transform fails when it attempts unauthorized operations. + /// + /// Start a transform. + /// Starts a transform. + /// + /// + /// When you start a transform, it creates the destination index if it does not already exist. The number_of_shards is + /// set to 1 and the auto_expand_replicas is set to 0-1. If it is a pivot transform, it deduces the mapping + /// definitions for the destination index from the source indices and the transform aggregations. If fields in the + /// destination index are derived from scripts (as in the case of scripted_metric or bucket_script aggregations), + /// the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce + /// mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you + /// start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings + /// in a pivot transform. + /// + /// + /// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you + /// created the transform, they occur when you start the transform—​with the exception of privilege checks. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the + /// time of creation and uses those same roles. If those roles do not have the required privileges on the source and + /// destination indices, the transform fails when it attempts unauthorized operations. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartTransformAsync(Elastic.Clients.Elasticsearch.Id transformId, CancellationToken cancellationToken = default) @@ -1001,9 +1723,27 @@ public virtual Task StartTransformAsync(Elastic.Clients. } /// - /// Start a transform.
Starts a transform. - /// When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is
set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping
definitions for the destination index from the source indices and the transform aggregations. If fields in the
destination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),
the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce
mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you
start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings
in a pivot transform. - /// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you
created the transform, they occur when you start the transform—​with the exception of privilege checks. When
Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the
time of creation and uses those same roles. If those roles do not have the required privileges on the source and
destination indices, the transform fails when it attempts unauthorized operations. + /// + /// Start a transform. + /// Starts a transform. + /// + /// + /// When you start a transform, it creates the destination index if it does not already exist. The number_of_shards is + /// set to 1 and the auto_expand_replicas is set to 0-1. If it is a pivot transform, it deduces the mapping + /// definitions for the destination index from the source indices and the transform aggregations. If fields in the + /// destination index are derived from scripts (as in the case of scripted_metric or bucket_script aggregations), + /// the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce + /// mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you + /// start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings + /// in a pivot transform. + /// + /// + /// When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you + /// created the transform, they occur when you start the transform—​with the exception of privilege checks. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the + /// time of creation and uses those same roles. If those roles do not have the required privileges on the source and + /// destination indices, the transform fails when it attempts unauthorized operations. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StartTransformAsync(Elastic.Clients.Elasticsearch.Id transformId, Action configureRequest, CancellationToken cancellationToken = default) @@ -1015,7 +1755,10 @@ public virtual Task StartTransformAsync(Elastic.Clients. } /// - /// Stop transforms.
Stops one or more transforms. + /// + /// Stop transforms. + /// Stops one or more transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1026,7 +1769,10 @@ public virtual StopTransformResponse StopTransform(StopTransformRequest request) } /// - /// Stop transforms.
Stops one or more transforms. + /// + /// Stop transforms. + /// Stops one or more transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopTransformAsync(StopTransformRequest request, CancellationToken cancellationToken = default) @@ -1036,7 +1782,10 @@ public virtual Task StopTransformAsync(StopTransformReque } /// - /// Stop transforms.
Stops one or more transforms. + /// + /// Stop transforms. + /// Stops one or more transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1047,7 +1796,10 @@ public virtual StopTransformResponse StopTransform(StopTransformRequestDescripto } /// - /// Stop transforms.
Stops one or more transforms. + /// + /// Stop transforms. + /// Stops one or more transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1059,7 +1811,10 @@ public virtual StopTransformResponse StopTransform(Elastic.Clients.Elasticsearch } /// - /// Stop transforms.
Stops one or more transforms. + /// + /// Stop transforms. + /// Stops one or more transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1072,7 +1827,10 @@ public virtual StopTransformResponse StopTransform(Elastic.Clients.Elasticsearch } /// - /// Stop transforms.
Stops one or more transforms. + /// + /// Stop transforms. + /// Stops one or more transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopTransformAsync(StopTransformRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1082,7 +1840,10 @@ public virtual Task StopTransformAsync(StopTransformReque } /// - /// Stop transforms.
Stops one or more transforms. + /// + /// Stop transforms. + /// Stops one or more transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopTransformAsync(Elastic.Clients.Elasticsearch.Name transformId, CancellationToken cancellationToken = default) @@ -1093,7 +1854,10 @@ public virtual Task StopTransformAsync(Elastic.Clients.El } /// - /// Stop transforms.
Stops one or more transforms. + /// + /// Stop transforms. + /// Stops one or more transforms. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StopTransformAsync(Elastic.Clients.Elasticsearch.Name transformId, Action configureRequest, CancellationToken cancellationToken = default) @@ -1105,8 +1869,17 @@ public virtual Task StopTransformAsync(Elastic.Clients.El } /// - /// Update a transform.
Updates certain properties of a transform. - /// All updated properties except `description` do not take effect until after the transform starts the next checkpoint,
thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`
privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When
Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the
time of update and runs with those privileges. + /// + /// Update a transform. + /// Updates certain properties of a transform. + /// + /// + /// All updated properties except description do not take effect until after the transform starts the next checkpoint, + /// thus there is data consistency in each checkpoint. To use this API, you must have read and view_index_metadata + /// privileges for the source indices. You must also have index and read privileges for the destination index. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the + /// time of update and runs with those privileges. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1117,8 +1890,17 @@ public virtual UpdateTransformResponse UpdateTransform(UpdateTransformRequest re } /// - /// Update a transform.
Updates certain properties of a transform. - /// All updated properties except `description` do not take effect until after the transform starts the next checkpoint,
thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`
privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When
Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the
time of update and runs with those privileges. + /// + /// Update a transform. + /// Updates certain properties of a transform. + /// + /// + /// All updated properties except description do not take effect until after the transform starts the next checkpoint, + /// thus there is data consistency in each checkpoint. To use this API, you must have read and view_index_metadata + /// privileges for the source indices. You must also have index and read privileges for the destination index. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the + /// time of update and runs with those privileges. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateTransformAsync(UpdateTransformRequest request, CancellationToken cancellationToken = default) @@ -1128,8 +1910,17 @@ public virtual Task UpdateTransformAsync(UpdateTransfor } /// - /// Update a transform.
Updates certain properties of a transform. - /// All updated properties except `description` do not take effect until after the transform starts the next checkpoint,
thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`
privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When
Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the
time of update and runs with those privileges. + /// + /// Update a transform. + /// Updates certain properties of a transform. + /// + /// + /// All updated properties except description do not take effect until after the transform starts the next checkpoint, + /// thus there is data consistency in each checkpoint. To use this API, you must have read and view_index_metadata + /// privileges for the source indices. You must also have index and read privileges for the destination index. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the + /// time of update and runs with those privileges. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1140,8 +1931,17 @@ public virtual UpdateTransformResponse UpdateTransform(UpdateTransfor } /// - /// Update a transform.
Updates certain properties of a transform. - /// All updated properties except `description` do not take effect until after the transform starts the next checkpoint,
thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`
privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When
Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the
time of update and runs with those privileges. + /// + /// Update a transform. + /// Updates certain properties of a transform. + /// + /// + /// All updated properties except description do not take effect until after the transform starts the next checkpoint, + /// thus there is data consistency in each checkpoint. To use this API, you must have read and view_index_metadata + /// privileges for the source indices. You must also have index and read privileges for the destination index. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the + /// time of update and runs with those privileges. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1153,8 +1953,17 @@ public virtual UpdateTransformResponse UpdateTransform(Elastic.Client } /// - /// Update a transform.
Updates certain properties of a transform. - /// All updated properties except `description` do not take effect until after the transform starts the next checkpoint,
thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`
privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When
Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the
time of update and runs with those privileges. + /// + /// Update a transform. + /// Updates certain properties of a transform. + /// + /// + /// All updated properties except description do not take effect until after the transform starts the next checkpoint, + /// thus there is data consistency in each checkpoint. To use this API, you must have read and view_index_metadata + /// privileges for the source indices. You must also have index and read privileges for the destination index. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the + /// time of update and runs with those privileges. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1167,8 +1976,17 @@ public virtual UpdateTransformResponse UpdateTransform(Elastic.Client } /// - /// Update a transform.
Updates certain properties of a transform. - /// All updated properties except `description` do not take effect until after the transform starts the next checkpoint,
thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`
privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When
Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the
time of update and runs with those privileges. + /// + /// Update a transform. + /// Updates certain properties of a transform. + /// + /// + /// All updated properties except description do not take effect until after the transform starts the next checkpoint, + /// thus there is data consistency in each checkpoint. To use this API, you must have read and view_index_metadata + /// privileges for the source indices. You must also have index and read privileges for the destination index. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the + /// time of update and runs with those privileges. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1179,8 +1997,17 @@ public virtual UpdateTransformResponse UpdateTransform(UpdateTransformRequestDes } /// - /// Update a transform.
Updates certain properties of a transform. - /// All updated properties except `description` do not take effect until after the transform starts the next checkpoint,
thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`
privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When
Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the
time of update and runs with those privileges. + /// + /// Update a transform. + /// Updates certain properties of a transform. + /// + /// + /// All updated properties except description do not take effect until after the transform starts the next checkpoint, + /// thus there is data consistency in each checkpoint. To use this API, you must have read and view_index_metadata + /// privileges for the source indices. You must also have index and read privileges for the destination index. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the + /// time of update and runs with those privileges. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1192,8 +2019,17 @@ public virtual UpdateTransformResponse UpdateTransform(Elastic.Clients.Elasticse } /// - /// Update a transform.
Updates certain properties of a transform. - /// All updated properties except `description` do not take effect until after the transform starts the next checkpoint,
thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`
privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When
Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the
time of update and runs with those privileges. + /// + /// Update a transform. + /// Updates certain properties of a transform. + /// + /// + /// All updated properties except description do not take effect until after the transform starts the next checkpoint, + /// thus there is data consistency in each checkpoint. To use this API, you must have read and view_index_metadata + /// privileges for the source indices. You must also have index and read privileges for the destination index. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the + /// time of update and runs with those privileges. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1206,8 +2042,17 @@ public virtual UpdateTransformResponse UpdateTransform(Elastic.Clients.Elasticse } /// - /// Update a transform.
Updates certain properties of a transform. - /// All updated properties except `description` do not take effect until after the transform starts the next checkpoint,
thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`
privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When
Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the
time of update and runs with those privileges. + /// + /// Update a transform. + /// Updates certain properties of a transform. + /// + /// + /// All updated properties except description do not take effect until after the transform starts the next checkpoint, + /// thus there is data consistency in each checkpoint. To use this API, you must have read and view_index_metadata + /// privileges for the source indices. You must also have index and read privileges for the destination index. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the + /// time of update and runs with those privileges. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateTransformAsync(UpdateTransformRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1217,8 +2062,17 @@ public virtual Task UpdateTransformAsync(Upd } /// - /// Update a transform.
Updates certain properties of a transform. - /// All updated properties except `description` do not take effect until after the transform starts the next checkpoint,
thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`
privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When
Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the
time of update and runs with those privileges. + /// + /// Update a transform. + /// Updates certain properties of a transform. + /// + /// + /// All updated properties except description do not take effect until after the transform starts the next checkpoint, + /// thus there is data consistency in each checkpoint. To use this API, you must have read and view_index_metadata + /// privileges for the source indices. You must also have index and read privileges for the destination index. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the + /// time of update and runs with those privileges. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateTransformAsync(Elastic.Clients.Elasticsearch.Id transformId, CancellationToken cancellationToken = default) @@ -1229,8 +2083,17 @@ public virtual Task UpdateTransformAsync(Ela } /// - /// Update a transform.
Updates certain properties of a transform. - /// All updated properties except `description` do not take effect until after the transform starts the next checkpoint,
thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`
privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When
Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the
time of update and runs with those privileges. + /// + /// Update a transform. + /// Updates certain properties of a transform. + /// + /// + /// All updated properties except description do not take effect until after the transform starts the next checkpoint, + /// thus there is data consistency in each checkpoint. To use this API, you must have read and view_index_metadata + /// privileges for the source indices. You must also have index and read privileges for the destination index. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the + /// time of update and runs with those privileges. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateTransformAsync(Elastic.Clients.Elasticsearch.Id transformId, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1242,8 +2105,17 @@ public virtual Task UpdateTransformAsync(Ela } /// - /// Update a transform.
Updates certain properties of a transform. - /// All updated properties except `description` do not take effect until after the transform starts the next checkpoint,
thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`
privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When
Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the
time of update and runs with those privileges. + /// + /// Update a transform. + /// Updates certain properties of a transform. + /// + /// + /// All updated properties except description do not take effect until after the transform starts the next checkpoint, + /// thus there is data consistency in each checkpoint. To use this API, you must have read and view_index_metadata + /// privileges for the source indices. You must also have index and read privileges for the destination index. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the + /// time of update and runs with those privileges. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateTransformAsync(UpdateTransformRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1253,8 +2125,17 @@ public virtual Task UpdateTransformAsync(UpdateTransfor } /// - /// Update a transform.
Updates certain properties of a transform. - /// All updated properties except `description` do not take effect until after the transform starts the next checkpoint,
thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`
privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When
Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the
time of update and runs with those privileges. + /// + /// Update a transform. + /// Updates certain properties of a transform. + /// + /// + /// All updated properties except description do not take effect until after the transform starts the next checkpoint, + /// thus there is data consistency in each checkpoint. To use this API, you must have read and view_index_metadata + /// privileges for the source indices. You must also have index and read privileges for the destination index. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the + /// time of update and runs with those privileges. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateTransformAsync(Elastic.Clients.Elasticsearch.Id transformId, CancellationToken cancellationToken = default) @@ -1265,8 +2146,17 @@ public virtual Task UpdateTransformAsync(Elastic.Client } /// - /// Update a transform.
Updates certain properties of a transform. - /// All updated properties except `description` do not take effect until after the transform starts the next checkpoint,
thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`
privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When
Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the
time of update and runs with those privileges. + /// + /// Update a transform. + /// Updates certain properties of a transform. + /// + /// + /// All updated properties except description do not take effect until after the transform starts the next checkpoint, + /// thus there is data consistency in each checkpoint. To use this API, you must have read and view_index_metadata + /// privileges for the source indices. You must also have index and read privileges for the destination index. When + /// Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the + /// time of update and runs with those privileges. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateTransformAsync(Elastic.Clients.Elasticsearch.Id transformId, Action configureRequest, CancellationToken cancellationToken = default) @@ -1278,7 +2168,14 @@ public virtual Task UpdateTransformAsync(Elastic.Client } /// - /// Upgrades all transforms.
This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It
also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not
affect the source and destination indices. The upgrade also does not affect the roles that transforms use when
Elasticsearch security features are enabled; the role used to read source data and write to the destination index
remains unchanged. + /// + /// Upgrades all transforms. + /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It + /// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not + /// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when + /// Elasticsearch security features are enabled; the role used to read source data and write to the destination index + /// remains unchanged. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1289,7 +2186,14 @@ public virtual UpgradeTransformsResponse UpgradeTransforms(UpgradeTransformsRequ } /// - /// Upgrades all transforms.
This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It
also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not
affect the source and destination indices. The upgrade also does not affect the roles that transforms use when
Elasticsearch security features are enabled; the role used to read source data and write to the destination index
remains unchanged. + /// + /// Upgrades all transforms. + /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It + /// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not + /// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when + /// Elasticsearch security features are enabled; the role used to read source data and write to the destination index + /// remains unchanged. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpgradeTransformsAsync(UpgradeTransformsRequest request, CancellationToken cancellationToken = default) @@ -1299,7 +2203,14 @@ public virtual Task UpgradeTransformsAsync(UpgradeTra } /// - /// Upgrades all transforms.
This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It
also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not
affect the source and destination indices. The upgrade also does not affect the roles that transforms use when
Elasticsearch security features are enabled; the role used to read source data and write to the destination index
remains unchanged. + /// + /// Upgrades all transforms. + /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It + /// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not + /// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when + /// Elasticsearch security features are enabled; the role used to read source data and write to the destination index + /// remains unchanged. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1310,7 +2221,14 @@ public virtual UpgradeTransformsResponse UpgradeTransforms(UpgradeTransformsRequ } /// - /// Upgrades all transforms.
This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It
also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not
affect the source and destination indices. The upgrade also does not affect the roles that transforms use when
Elasticsearch security features are enabled; the role used to read source data and write to the destination index
remains unchanged. + /// + /// Upgrades all transforms. + /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It + /// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not + /// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when + /// Elasticsearch security features are enabled; the role used to read source data and write to the destination index + /// remains unchanged. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1322,7 +2240,14 @@ public virtual UpgradeTransformsResponse UpgradeTransforms() } /// - /// Upgrades all transforms.
This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It
also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not
affect the source and destination indices. The upgrade also does not affect the roles that transforms use when
Elasticsearch security features are enabled; the role used to read source data and write to the destination index
remains unchanged. + /// + /// Upgrades all transforms. + /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It + /// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not + /// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when + /// Elasticsearch security features are enabled; the role used to read source data and write to the destination index + /// remains unchanged. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1335,7 +2260,14 @@ public virtual UpgradeTransformsResponse UpgradeTransforms(Action - /// Upgrades all transforms.
This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It
also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not
affect the source and destination indices. The upgrade also does not affect the roles that transforms use when
Elasticsearch security features are enabled; the role used to read source data and write to the destination index
remains unchanged. + /// + /// Upgrades all transforms. + /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It + /// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not + /// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when + /// Elasticsearch security features are enabled; the role used to read source data and write to the destination index + /// remains unchanged. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpgradeTransformsAsync(UpgradeTransformsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1345,7 +2277,14 @@ public virtual Task UpgradeTransformsAsync(UpgradeTra } /// - /// Upgrades all transforms.
This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It
also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not
affect the source and destination indices. The upgrade also does not affect the roles that transforms use when
Elasticsearch security features are enabled; the role used to read source data and write to the destination index
remains unchanged. + /// + /// Upgrades all transforms. + /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It + /// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not + /// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when + /// Elasticsearch security features are enabled; the role used to read source data and write to the destination index + /// remains unchanged. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpgradeTransformsAsync(CancellationToken cancellationToken = default) @@ -1356,7 +2295,14 @@ public virtual Task UpgradeTransformsAsync(Cancellati } /// - /// Upgrades all transforms.
This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It
also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not
affect the source and destination indices. The upgrade also does not affect the roles that transforms use when
Elasticsearch security features are enabled; the role used to read source data and write to the destination index
remains unchanged. + /// + /// Upgrades all transforms. + /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It + /// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not + /// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when + /// Elasticsearch security features are enabled; the role used to read source data and write to the destination index + /// remains unchanged. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpgradeTransformsAsync(Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Xpack.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Xpack.g.cs index b058b88239c..6b26591803c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Xpack.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Xpack.g.cs @@ -27,7 +27,9 @@ namespace Elastic.Clients.Elasticsearch.Xpack; public partial class XpackNamespacedClient : NamespacedClientProxy { /// - /// Initializes a new instance of the class for mocking. + /// + /// Initializes a new instance of the class for mocking. + /// /// protected XpackNamespacedClient() : base() { @@ -38,7 +40,9 @@ internal XpackNamespacedClient(ElasticsearchClient client) : base(client) } /// - /// Provides general information about the installed X-Pack features. + /// + /// Provides general information about the installed X-Pack features. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -49,7 +53,9 @@ public virtual XpackInfoResponse Info(XpackInfoRequest request) } /// - /// Provides general information about the installed X-Pack features. + /// + /// Provides general information about the installed X-Pack features. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(XpackInfoRequest request, CancellationToken cancellationToken = default) @@ -59,7 +65,9 @@ public virtual Task InfoAsync(XpackInfoRequest request, Cance } /// - /// Provides general information about the installed X-Pack features. + /// + /// Provides general information about the installed X-Pack features. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -70,7 +78,9 @@ public virtual XpackInfoResponse Info(XpackInfoRequestDescriptor descriptor) } /// - /// Provides general information about the installed X-Pack features. + /// + /// Provides general information about the installed X-Pack features. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -82,7 +92,9 @@ public virtual XpackInfoResponse Info() } /// - /// Provides general information about the installed X-Pack features. + /// + /// Provides general information about the installed X-Pack features. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -95,7 +107,9 @@ public virtual XpackInfoResponse Info(Action configu } /// - /// Provides general information about the installed X-Pack features. + /// + /// Provides general information about the installed X-Pack features. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(XpackInfoRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -105,7 +119,9 @@ public virtual Task InfoAsync(XpackInfoRequestDescriptor desc } /// - /// Provides general information about the installed X-Pack features. + /// + /// Provides general information about the installed X-Pack features. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(CancellationToken cancellationToken = default) @@ -116,7 +132,9 @@ public virtual Task InfoAsync(CancellationToken cancellationT } /// - /// Provides general information about the installed X-Pack features. + /// + /// Provides general information about the installed X-Pack features. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -128,7 +146,9 @@ public virtual Task InfoAsync(Action - /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// + /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -139,7 +159,9 @@ public virtual XpackUsageResponse Usage(XpackUsageRequest request) } /// - /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// + /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(XpackUsageRequest request, CancellationToken cancellationToken = default) @@ -149,7 +171,9 @@ public virtual Task UsageAsync(XpackUsageRequest request, Ca } /// - /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// + /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -160,7 +184,9 @@ public virtual XpackUsageResponse Usage(XpackUsageRequestDescriptor descriptor) } /// - /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// + /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -172,7 +198,9 @@ public virtual XpackUsageResponse Usage() } /// - /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// + /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -185,7 +213,9 @@ public virtual XpackUsageResponse Usage(Action conf } /// - /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// + /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(XpackUsageRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -195,7 +225,9 @@ public virtual Task UsageAsync(XpackUsageRequestDescriptor d } /// - /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// + /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(CancellationToken cancellationToken = default) @@ -206,7 +238,9 @@ public virtual Task UsageAsync(CancellationToken cancellatio } /// - /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// + /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.g.cs index d29694374f2..9439fd34de1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.g.cs @@ -116,7 +116,11 @@ private partial void SetupNamespaces() } /// - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -127,7 +131,11 @@ public virtual BulkResponse Bulk(BulkRequest request) } /// - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(BulkRequest request, CancellationToken cancellationToken = default) @@ -137,7 +145,11 @@ public virtual Task BulkAsync(BulkRequest request, CancellationTok } /// - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -148,7 +160,11 @@ public virtual BulkResponse Bulk(BulkRequestDescriptor des } /// - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -160,7 +176,11 @@ public virtual BulkResponse Bulk(Elastic.Clients.Elasticsearch.IndexN } /// - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -173,7 +193,11 @@ public virtual BulkResponse Bulk(Elastic.Clients.Elasticsearch.IndexN } /// - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -185,7 +209,11 @@ public virtual BulkResponse Bulk() } /// - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -198,7 +226,11 @@ public virtual BulkResponse Bulk(Action - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -209,7 +241,11 @@ public virtual BulkResponse Bulk(BulkRequestDescriptor descriptor) } /// - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -221,7 +257,11 @@ public virtual BulkResponse Bulk(Elastic.Clients.Elasticsearch.IndexName? index) } /// - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -234,7 +274,11 @@ public virtual BulkResponse Bulk(Elastic.Clients.Elasticsearch.IndexName? index, } /// - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -246,7 +290,11 @@ public virtual BulkResponse Bulk() } /// - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -259,7 +307,11 @@ public virtual BulkResponse Bulk(Action configureRequest) } /// - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(BulkRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -269,7 +321,11 @@ public virtual Task BulkAsync(BulkRequestDescriptor - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(Elastic.Clients.Elasticsearch.IndexName? index, CancellationToken cancellationToken = default) @@ -280,7 +336,11 @@ public virtual Task BulkAsync(Elastic.Clients.Elasticse } /// - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(Elastic.Clients.Elasticsearch.IndexName? index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -292,7 +352,11 @@ public virtual Task BulkAsync(Elastic.Clients.Elasticse } /// - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(CancellationToken cancellationToken = default) @@ -303,7 +367,11 @@ public virtual Task BulkAsync(CancellationToken cancell } /// - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -315,7 +383,11 @@ public virtual Task BulkAsync(Action - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(BulkRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -325,7 +397,11 @@ public virtual Task BulkAsync(BulkRequestDescriptor descriptor, Ca } /// - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(Elastic.Clients.Elasticsearch.IndexName? index, CancellationToken cancellationToken = default) @@ -336,7 +412,11 @@ public virtual Task BulkAsync(Elastic.Clients.Elasticsearch.IndexN } /// - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(Elastic.Clients.Elasticsearch.IndexName? index, Action configureRequest, CancellationToken cancellationToken = default) @@ -348,7 +428,11 @@ public virtual Task BulkAsync(Elastic.Clients.Elasticsearch.IndexN } /// - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(CancellationToken cancellationToken = default) @@ -359,7 +443,11 @@ public virtual Task BulkAsync(CancellationToken cancellationToken } /// - /// Bulk index or delete documents.
Performs multiple indexing or delete operations in a single API call.
This reduces overhead and can greatly increase indexing speed. + /// + /// Bulk index or delete documents. + /// Performs multiple indexing or delete operations in a single API call. + /// This reduces overhead and can greatly increase indexing speed. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -371,7 +459,9 @@ public virtual Task BulkAsync(Action config } /// - /// Clears the search context and results for a scrolling search. + /// + /// Clears the search context and results for a scrolling search. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -382,7 +472,9 @@ public virtual ClearScrollResponse ClearScroll(ClearScrollRequest request) } /// - /// Clears the search context and results for a scrolling search. + /// + /// Clears the search context and results for a scrolling search. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearScrollAsync(ClearScrollRequest request, CancellationToken cancellationToken = default) @@ -392,7 +484,9 @@ public virtual Task ClearScrollAsync(ClearScrollRequest req } /// - /// Clears the search context and results for a scrolling search. + /// + /// Clears the search context and results for a scrolling search. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -403,7 +497,9 @@ public virtual ClearScrollResponse ClearScroll(ClearScrollRequestDescriptor desc } /// - /// Clears the search context and results for a scrolling search. + /// + /// Clears the search context and results for a scrolling search. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -415,7 +511,9 @@ public virtual ClearScrollResponse ClearScroll() } /// - /// Clears the search context and results for a scrolling search. + /// + /// Clears the search context and results for a scrolling search. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -428,7 +526,9 @@ public virtual ClearScrollResponse ClearScroll(Action - /// Clears the search context and results for a scrolling search. + /// + /// Clears the search context and results for a scrolling search. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearScrollAsync(ClearScrollRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -438,7 +538,9 @@ public virtual Task ClearScrollAsync(ClearScrollRequestDesc } /// - /// Clears the search context and results for a scrolling search. + /// + /// Clears the search context and results for a scrolling search. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearScrollAsync(CancellationToken cancellationToken = default) @@ -449,7 +551,9 @@ public virtual Task ClearScrollAsync(CancellationToken canc } /// - /// Clears the search context and results for a scrolling search. + /// + /// Clears the search context and results for a scrolling search. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearScrollAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -461,7 +565,9 @@ public virtual Task ClearScrollAsync(Action - /// Closes a point-in-time. + /// + /// Closes a point-in-time. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -472,7 +578,9 @@ public virtual ClosePointInTimeResponse ClosePointInTime(ClosePointInTimeRequest } /// - /// Closes a point-in-time. + /// + /// Closes a point-in-time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClosePointInTimeAsync(ClosePointInTimeRequest request, CancellationToken cancellationToken = default) @@ -482,7 +590,9 @@ public virtual Task ClosePointInTimeAsync(ClosePointIn } /// - /// Closes a point-in-time. + /// + /// Closes a point-in-time. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -493,7 +603,9 @@ public virtual ClosePointInTimeResponse ClosePointInTime(ClosePointInTimeRequest } /// - /// Closes a point-in-time. + /// + /// Closes a point-in-time. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -505,7 +617,9 @@ public virtual ClosePointInTimeResponse ClosePointInTime() } /// - /// Closes a point-in-time. + /// + /// Closes a point-in-time. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -518,7 +632,9 @@ public virtual ClosePointInTimeResponse ClosePointInTime(Action - /// Closes a point-in-time. + /// + /// Closes a point-in-time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClosePointInTimeAsync(ClosePointInTimeRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -528,7 +644,9 @@ public virtual Task ClosePointInTimeAsync(ClosePointIn } /// - /// Closes a point-in-time. + /// + /// Closes a point-in-time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClosePointInTimeAsync(CancellationToken cancellationToken = default) @@ -539,7 +657,9 @@ public virtual Task ClosePointInTimeAsync(Cancellation } /// - /// Closes a point-in-time. + /// + /// Closes a point-in-time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClosePointInTimeAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -551,7 +671,9 @@ public virtual Task ClosePointInTimeAsync(Action - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -562,7 +684,9 @@ public virtual CountResponse Count(CountRequest request) } /// - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CountAsync(CountRequest request, CancellationToken cancellationToken = default) @@ -572,7 +696,9 @@ public virtual Task CountAsync(CountRequest request, Cancellation } /// - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -583,7 +709,9 @@ public virtual CountResponse Count(CountRequestDescriptor } /// - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -595,7 +723,9 @@ public virtual CountResponse Count(Elastic.Clients.Elasticsearch.Indi } /// - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -608,7 +738,9 @@ public virtual CountResponse Count(Elastic.Clients.Elasticsearch.Indi } /// - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -620,7 +752,9 @@ public virtual CountResponse Count() } /// - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -633,7 +767,9 @@ public virtual CountResponse Count(Action - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -644,7 +780,9 @@ public virtual CountResponse Count(CountRequestDescriptor descriptor) } /// - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -656,7 +794,9 @@ public virtual CountResponse Count(Elastic.Clients.Elasticsearch.Indices? indice } /// - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -669,7 +809,9 @@ public virtual CountResponse Count(Elastic.Clients.Elasticsearch.Indices? indice } /// - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -681,7 +823,9 @@ public virtual CountResponse Count() } /// - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -694,7 +838,9 @@ public virtual CountResponse Count(Action configureReque } /// - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CountAsync(CountRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -704,7 +850,9 @@ public virtual Task CountAsync(CountRequestDescriptor< } /// - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CountAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -715,7 +863,9 @@ public virtual Task CountAsync(Elastic.Clients.Elastic } /// - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CountAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -727,7 +877,9 @@ public virtual Task CountAsync(Elastic.Clients.Elastic } /// - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CountAsync(CancellationToken cancellationToken = default) @@ -738,7 +890,9 @@ public virtual Task CountAsync(CancellationToken cance } /// - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CountAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -750,7 +904,9 @@ public virtual Task CountAsync(Action - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CountAsync(CountRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -760,7 +916,9 @@ public virtual Task CountAsync(CountRequestDescriptor descriptor, } /// - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CountAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -771,7 +929,9 @@ public virtual Task CountAsync(Elastic.Clients.Elasticsearch.Indi } /// - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CountAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -783,7 +943,9 @@ public virtual Task CountAsync(Elastic.Clients.Elasticsearch.Indi } /// - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CountAsync(CancellationToken cancellationToken = default) @@ -794,7 +956,9 @@ public virtual Task CountAsync(CancellationToken cancellationToke } /// - /// Returns number of documents matching a query. + /// + /// Returns number of documents matching a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CountAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -806,7 +970,11 @@ public virtual Task CountAsync(Action con } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -817,7 +985,11 @@ public virtual CreateResponse Create(CreateRequest request } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(CreateRequest request, CancellationToken cancellationToken = default) @@ -827,7 +999,11 @@ public virtual Task CreateAsync(CreateRequest - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -838,7 +1014,11 @@ public virtual CreateResponse Create(CreateRequestDescriptor - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -850,7 +1030,11 @@ public virtual CreateResponse Create(TDocument document, Elastic.Clie } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -863,7 +1047,11 @@ public virtual CreateResponse Create(TDocument document, Elastic.Clie } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -875,7 +1063,11 @@ public virtual CreateResponse Create(TDocument document) } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -888,7 +1080,11 @@ public virtual CreateResponse Create(TDocument document, Action - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -900,7 +1096,11 @@ public virtual CreateResponse Create(TDocument document, Elastic.Clie } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -913,7 +1113,11 @@ public virtual CreateResponse Create(TDocument document, Elastic.Clie } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -925,7 +1129,11 @@ public virtual CreateResponse Create(TDocument document, Elastic.Clie } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -938,7 +1146,11 @@ public virtual CreateResponse Create(TDocument document, Elastic.Clie } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(CreateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -948,7 +1160,11 @@ public virtual Task CreateAsync(CreateRequestDescript } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(TDocument document, Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -959,7 +1175,11 @@ public virtual Task CreateAsync(TDocument document, E } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(TDocument document, Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -971,7 +1191,11 @@ public virtual Task CreateAsync(TDocument document, E } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(TDocument document, CancellationToken cancellationToken = default) @@ -982,7 +1206,11 @@ public virtual Task CreateAsync(TDocument document, C } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(TDocument document, Action> configureRequest, CancellationToken cancellationToken = default) @@ -994,7 +1222,11 @@ public virtual Task CreateAsync(TDocument document, A } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(TDocument document, Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -1005,7 +1237,11 @@ public virtual Task CreateAsync(TDocument document, E } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(TDocument document, Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1017,7 +1253,11 @@ public virtual Task CreateAsync(TDocument document, E } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(TDocument document, Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -1028,7 +1268,11 @@ public virtual Task CreateAsync(TDocument document, E } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(TDocument document, Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1040,7 +1284,10 @@ public virtual Task CreateAsync(TDocument document, E } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1051,7 +1298,10 @@ public virtual DeleteResponse Delete(DeleteRequest request) } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteRequest request, CancellationToken cancellationToken = default) @@ -1061,7 +1311,10 @@ public virtual Task DeleteAsync(DeleteRequest request, Cancellat } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1072,7 +1325,10 @@ public virtual DeleteResponse Delete(DeleteRequestDescriptor - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1084,7 +1340,10 @@ public virtual DeleteResponse Delete(Elastic.Clients.Elasticsearch.In } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1097,7 +1356,10 @@ public virtual DeleteResponse Delete(Elastic.Clients.Elasticsearch.In } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1109,7 +1371,10 @@ public virtual DeleteResponse Delete(TDocument document) } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1122,7 +1387,10 @@ public virtual DeleteResponse Delete(TDocument document, Action - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1134,7 +1402,10 @@ public virtual DeleteResponse Delete(TDocument document, Elastic.Clie } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1147,7 +1418,10 @@ public virtual DeleteResponse Delete(TDocument document, Elastic.Clie } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1159,7 +1433,10 @@ public virtual DeleteResponse Delete(TDocument document, Elastic.Clie } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1172,7 +1449,10 @@ public virtual DeleteResponse Delete(TDocument document, Elastic.Clie } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1184,7 +1464,10 @@ public virtual DeleteResponse Delete(Elastic.Clients.Elasticsearch.Id } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1197,7 +1480,10 @@ public virtual DeleteResponse Delete(Elastic.Clients.Elasticsearch.Id } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1208,7 +1494,10 @@ public virtual DeleteResponse Delete(DeleteRequestDescriptor descriptor) } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1220,7 +1509,10 @@ public virtual DeleteResponse Delete(Elastic.Clients.Elasticsearch.IndexName ind } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1233,7 +1525,10 @@ public virtual DeleteResponse Delete(Elastic.Clients.Elasticsearch.IndexName ind } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1243,7 +1538,10 @@ public virtual Task DeleteAsync(DeleteRequestDescript } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -1254,7 +1552,10 @@ public virtual Task DeleteAsync(Elastic.Clients.Elast } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1266,7 +1567,10 @@ public virtual Task DeleteAsync(Elastic.Clients.Elast } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(TDocument document, CancellationToken cancellationToken = default) @@ -1277,7 +1581,10 @@ public virtual Task DeleteAsync(TDocument document, C } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(TDocument document, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1289,7 +1596,10 @@ public virtual Task DeleteAsync(TDocument document, A } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(TDocument document, Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -1300,7 +1610,10 @@ public virtual Task DeleteAsync(TDocument document, E } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(TDocument document, Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1312,7 +1625,10 @@ public virtual Task DeleteAsync(TDocument document, E } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(TDocument document, Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -1323,7 +1639,10 @@ public virtual Task DeleteAsync(TDocument document, E } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(TDocument document, Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1335,7 +1654,10 @@ public virtual Task DeleteAsync(TDocument document, E } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -1346,7 +1668,10 @@ public virtual Task DeleteAsync(Elastic.Clients.Elast } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1358,7 +1683,10 @@ public virtual Task DeleteAsync(Elastic.Clients.Elast } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1368,7 +1696,10 @@ public virtual Task DeleteAsync(DeleteRequestDescriptor descript } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -1379,7 +1710,10 @@ public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.In } /// - /// Delete a document.
Removes a JSON document from the specified index. + /// + /// Delete a document. + /// Removes a JSON document from the specified index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -1391,7 +1725,10 @@ public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.In } /// - /// Delete documents.
Deletes documents that match the specified query. + /// + /// Delete documents. + /// Deletes documents that match the specified query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1402,7 +1739,10 @@ public virtual DeleteByQueryResponse DeleteByQuery(DeleteByQueryRequest request) } /// - /// Delete documents.
Deletes documents that match the specified query. + /// + /// Delete documents. + /// Deletes documents that match the specified query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteByQueryAsync(DeleteByQueryRequest request, CancellationToken cancellationToken = default) @@ -1412,7 +1752,10 @@ public virtual Task DeleteByQueryAsync(DeleteByQueryReque } /// - /// Delete documents.
Deletes documents that match the specified query. + /// + /// Delete documents. + /// Deletes documents that match the specified query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1423,7 +1766,10 @@ public virtual DeleteByQueryResponse DeleteByQuery(DeleteByQueryReque } /// - /// Delete documents.
Deletes documents that match the specified query. + /// + /// Delete documents. + /// Deletes documents that match the specified query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1435,7 +1781,10 @@ public virtual DeleteByQueryResponse DeleteByQuery(Elastic.Clients.El } /// - /// Delete documents.
Deletes documents that match the specified query. + /// + /// Delete documents. + /// Deletes documents that match the specified query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1448,7 +1797,10 @@ public virtual DeleteByQueryResponse DeleteByQuery(Elastic.Clients.El } /// - /// Delete documents.
Deletes documents that match the specified query. + /// + /// Delete documents. + /// Deletes documents that match the specified query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1460,7 +1812,10 @@ public virtual DeleteByQueryResponse DeleteByQuery() } /// - /// Delete documents.
Deletes documents that match the specified query. + /// + /// Delete documents. + /// Deletes documents that match the specified query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1473,7 +1828,10 @@ public virtual DeleteByQueryResponse DeleteByQuery(Action - /// Delete documents.
Deletes documents that match the specified query. + /// + /// Delete documents. + /// Deletes documents that match the specified query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1484,7 +1842,10 @@ public virtual DeleteByQueryResponse DeleteByQuery(DeleteByQueryRequestDescripto } /// - /// Delete documents.
Deletes documents that match the specified query. + /// + /// Delete documents. + /// Deletes documents that match the specified query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1496,7 +1857,10 @@ public virtual DeleteByQueryResponse DeleteByQuery(Elastic.Clients.Elasticsearch } /// - /// Delete documents.
Deletes documents that match the specified query. + /// + /// Delete documents. + /// Deletes documents that match the specified query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1509,7 +1873,10 @@ public virtual DeleteByQueryResponse DeleteByQuery(Elastic.Clients.Elasticsearch } /// - /// Delete documents.
Deletes documents that match the specified query. + /// + /// Delete documents. + /// Deletes documents that match the specified query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteByQueryAsync(DeleteByQueryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1519,7 +1886,10 @@ public virtual Task DeleteByQueryAsync(DeleteB } /// - /// Delete documents.
Deletes documents that match the specified query. + /// + /// Delete documents. + /// Deletes documents that match the specified query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteByQueryAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -1530,7 +1900,10 @@ public virtual Task DeleteByQueryAsync(Elastic } /// - /// Delete documents.
Deletes documents that match the specified query. + /// + /// Delete documents. + /// Deletes documents that match the specified query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteByQueryAsync(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1542,7 +1915,10 @@ public virtual Task DeleteByQueryAsync(Elastic } /// - /// Delete documents.
Deletes documents that match the specified query. + /// + /// Delete documents. + /// Deletes documents that match the specified query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteByQueryAsync(CancellationToken cancellationToken = default) @@ -1553,7 +1929,10 @@ public virtual Task DeleteByQueryAsync(Cancell } /// - /// Delete documents.
Deletes documents that match the specified query. + /// + /// Delete documents. + /// Deletes documents that match the specified query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteByQueryAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -1565,7 +1944,10 @@ public virtual Task DeleteByQueryAsync(Action< } /// - /// Delete documents.
Deletes documents that match the specified query. + /// + /// Delete documents. + /// Deletes documents that match the specified query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteByQueryAsync(DeleteByQueryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1575,7 +1957,10 @@ public virtual Task DeleteByQueryAsync(DeleteByQueryReque } /// - /// Delete documents.
Deletes documents that match the specified query. + /// + /// Delete documents. + /// Deletes documents that match the specified query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteByQueryAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -1586,7 +1971,10 @@ public virtual Task DeleteByQueryAsync(Elastic.Clients.El } /// - /// Delete documents.
Deletes documents that match the specified query. + /// + /// Delete documents. + /// Deletes documents that match the specified query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteByQueryAsync(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -1598,7 +1986,9 @@ public virtual Task DeleteByQueryAsync(Elastic.Clients.El } /// - /// Changes the number of requests per second for a particular Delete By Query operation. + /// + /// Changes the number of requests per second for a particular Delete By Query operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1609,7 +1999,9 @@ public virtual DeleteByQueryRethrottleResponse DeleteByQueryRethrottle(DeleteByQ } /// - /// Changes the number of requests per second for a particular Delete By Query operation. + /// + /// Changes the number of requests per second for a particular Delete By Query operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteByQueryRethrottleAsync(DeleteByQueryRethrottleRequest request, CancellationToken cancellationToken = default) @@ -1619,7 +2011,9 @@ public virtual Task DeleteByQueryRethrottleAsyn } /// - /// Changes the number of requests per second for a particular Delete By Query operation. + /// + /// Changes the number of requests per second for a particular Delete By Query operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1630,7 +2024,9 @@ public virtual DeleteByQueryRethrottleResponse DeleteByQueryRethrottle(DeleteByQ } /// - /// Changes the number of requests per second for a particular Delete By Query operation. + /// + /// Changes the number of requests per second for a particular Delete By Query operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1642,7 +2038,9 @@ public virtual DeleteByQueryRethrottleResponse DeleteByQueryRethrottle(Elastic.C } /// - /// Changes the number of requests per second for a particular Delete By Query operation. + /// + /// Changes the number of requests per second for a particular Delete By Query operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1655,7 +2053,9 @@ public virtual DeleteByQueryRethrottleResponse DeleteByQueryRethrottle(Elastic.C } /// - /// Changes the number of requests per second for a particular Delete By Query operation. + /// + /// Changes the number of requests per second for a particular Delete By Query operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteByQueryRethrottleAsync(DeleteByQueryRethrottleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1665,7 +2065,9 @@ public virtual Task DeleteByQueryRethrottleAsyn } /// - /// Changes the number of requests per second for a particular Delete By Query operation. + /// + /// Changes the number of requests per second for a particular Delete By Query operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteByQueryRethrottleAsync(Elastic.Clients.Elasticsearch.TaskId taskId, CancellationToken cancellationToken = default) @@ -1676,7 +2078,9 @@ public virtual Task DeleteByQueryRethrottleAsyn } /// - /// Changes the number of requests per second for a particular Delete By Query operation. + /// + /// Changes the number of requests per second for a particular Delete By Query operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteByQueryRethrottleAsync(Elastic.Clients.Elasticsearch.TaskId taskId, Action configureRequest, CancellationToken cancellationToken = default) @@ -1688,7 +2092,10 @@ public virtual Task DeleteByQueryRethrottleAsyn } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1699,7 +2106,10 @@ public virtual DeleteScriptResponse DeleteScript(DeleteScriptRequest request) } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteScriptAsync(DeleteScriptRequest request, CancellationToken cancellationToken = default) @@ -1709,7 +2119,10 @@ public virtual Task DeleteScriptAsync(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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1720,7 +2133,10 @@ public virtual DeleteScriptResponse DeleteScript(DeleteScriptRequestD } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1732,7 +2148,10 @@ public virtual DeleteScriptResponse DeleteScript(Elastic.Clients.Elas } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1745,7 +2164,10 @@ public virtual DeleteScriptResponse DeleteScript(Elastic.Clients.Elas } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1756,7 +2178,10 @@ public virtual DeleteScriptResponse DeleteScript(DeleteScriptRequestDescriptor d } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1768,7 +2193,10 @@ public virtual DeleteScriptResponse DeleteScript(Elastic.Clients.Elasticsearch.I } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1781,7 +2209,10 @@ public virtual DeleteScriptResponse DeleteScript(Elastic.Clients.Elasticsearch.I } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteScriptAsync(DeleteScriptRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1791,7 +2222,10 @@ public virtual Task DeleteScriptAsync(DeleteScr } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteScriptAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -1802,7 +2236,10 @@ public virtual Task DeleteScriptAsync(Elastic.C } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteScriptAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -1814,7 +2251,10 @@ public virtual Task DeleteScriptAsync(Elastic.C } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteScriptAsync(DeleteScriptRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -1824,7 +2264,10 @@ public virtual Task DeleteScriptAsync(DeleteScriptRequestD } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteScriptAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -1835,7 +2278,10 @@ public virtual Task DeleteScriptAsync(Elastic.Clients.Elas } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteScriptAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -1847,7 +2293,10 @@ public virtual Task DeleteScriptAsync(Elastic.Clients.Elas } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1858,7 +2307,10 @@ public virtual ExistsResponse Exists(ExistsRequest request) } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(ExistsRequest request, CancellationToken cancellationToken = default) @@ -1868,7 +2320,10 @@ public virtual Task ExistsAsync(ExistsRequest request, Cancellat } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1879,7 +2334,10 @@ public virtual ExistsResponse Exists(ExistsRequestDescriptor - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1891,7 +2349,10 @@ public virtual ExistsResponse Exists(Elastic.Clients.Elasticsearch.In } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1904,7 +2365,10 @@ public virtual ExistsResponse Exists(Elastic.Clients.Elasticsearch.In } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1916,7 +2380,10 @@ public virtual ExistsResponse Exists(TDocument document) } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1929,7 +2396,10 @@ public virtual ExistsResponse Exists(TDocument document, Action - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1941,7 +2411,10 @@ public virtual ExistsResponse Exists(TDocument document, Elastic.Clie } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1954,7 +2427,10 @@ public virtual ExistsResponse Exists(TDocument document, Elastic.Clie } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1966,7 +2442,10 @@ public virtual ExistsResponse Exists(TDocument document, Elastic.Clie } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1979,7 +2458,10 @@ public virtual ExistsResponse Exists(TDocument document, Elastic.Clie } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -1991,7 +2473,10 @@ public virtual ExistsResponse Exists(Elastic.Clients.Elasticsearch.Id } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2004,7 +2489,10 @@ public virtual ExistsResponse Exists(Elastic.Clients.Elasticsearch.Id } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2015,7 +2503,10 @@ public virtual ExistsResponse Exists(ExistsRequestDescriptor descriptor) } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2027,7 +2518,10 @@ public virtual ExistsResponse Exists(Elastic.Clients.Elasticsearch.IndexName ind } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2040,7 +2534,10 @@ public virtual ExistsResponse Exists(Elastic.Clients.Elasticsearch.IndexName ind } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(ExistsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2050,7 +2547,10 @@ public virtual Task ExistsAsync(ExistsRequestDescript } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -2061,7 +2561,10 @@ public virtual Task ExistsAsync(Elastic.Clients.Elast } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2073,7 +2576,10 @@ public virtual Task ExistsAsync(Elastic.Clients.Elast } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(TDocument document, CancellationToken cancellationToken = default) @@ -2084,7 +2590,10 @@ public virtual Task ExistsAsync(TDocument document, C } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(TDocument document, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2096,7 +2605,10 @@ public virtual Task ExistsAsync(TDocument document, A } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(TDocument document, Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -2107,7 +2619,10 @@ public virtual Task ExistsAsync(TDocument document, E } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(TDocument document, Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2119,7 +2634,10 @@ public virtual Task ExistsAsync(TDocument document, E } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(TDocument document, Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -2130,7 +2648,10 @@ public virtual Task ExistsAsync(TDocument document, E } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(TDocument document, Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2142,7 +2663,10 @@ public virtual Task ExistsAsync(TDocument document, E } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -2153,7 +2677,10 @@ public virtual Task ExistsAsync(Elastic.Clients.Elast } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2165,7 +2692,10 @@ public virtual Task ExistsAsync(Elastic.Clients.Elast } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(ExistsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2175,7 +2705,10 @@ public virtual Task ExistsAsync(ExistsRequestDescriptor descript } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -2186,7 +2719,10 @@ public virtual Task ExistsAsync(Elastic.Clients.Elasticsearch.In } /// - /// Check a document.
Checks if a specified document exists. + /// + /// Check a document. + /// Checks if a specified document exists. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -2198,7 +2734,10 @@ public virtual Task ExistsAsync(Elastic.Clients.Elasticsearch.In } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2209,7 +2748,10 @@ public virtual ExistsSourceResponse ExistsSource(ExistsSourceRequest request) } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsSourceAsync(ExistsSourceRequest request, CancellationToken cancellationToken = default) @@ -2219,7 +2761,10 @@ public virtual Task ExistsSourceAsync(ExistsSourceRequest } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2230,7 +2775,10 @@ public virtual ExistsSourceResponse ExistsSource(ExistsSourceRequestD } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2242,7 +2790,10 @@ public virtual ExistsSourceResponse ExistsSource(Elastic.Clients.Elas } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2255,7 +2806,10 @@ public virtual ExistsSourceResponse ExistsSource(Elastic.Clients.Elas } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2267,7 +2821,10 @@ public virtual ExistsSourceResponse ExistsSource(TDocument document) } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2280,7 +2837,10 @@ public virtual ExistsSourceResponse ExistsSource(TDocument document, } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2292,7 +2852,10 @@ public virtual ExistsSourceResponse ExistsSource(TDocument document, } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2305,7 +2868,10 @@ public virtual ExistsSourceResponse ExistsSource(TDocument document, } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2317,7 +2883,10 @@ public virtual ExistsSourceResponse ExistsSource(TDocument document, } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2330,7 +2899,10 @@ public virtual ExistsSourceResponse ExistsSource(TDocument document, } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2342,7 +2914,10 @@ public virtual ExistsSourceResponse ExistsSource(Elastic.Clients.Elas } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2355,7 +2930,10 @@ public virtual ExistsSourceResponse ExistsSource(Elastic.Clients.Elas } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2366,7 +2944,10 @@ public virtual ExistsSourceResponse ExistsSource(ExistsSourceRequestDescriptor d } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2378,7 +2959,10 @@ public virtual ExistsSourceResponse ExistsSource(Elastic.Clients.Elasticsearch.I } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2391,7 +2975,10 @@ public virtual ExistsSourceResponse ExistsSource(Elastic.Clients.Elasticsearch.I } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsSourceAsync(ExistsSourceRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2401,7 +2988,10 @@ public virtual Task ExistsSourceAsync(ExistsSou } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsSourceAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -2412,7 +3002,10 @@ public virtual Task ExistsSourceAsync(Elastic.C } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsSourceAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2424,7 +3017,10 @@ public virtual Task ExistsSourceAsync(Elastic.C } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsSourceAsync(TDocument document, CancellationToken cancellationToken = default) @@ -2435,7 +3031,10 @@ public virtual Task ExistsSourceAsync(TDocument } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsSourceAsync(TDocument document, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2447,7 +3046,10 @@ public virtual Task ExistsSourceAsync(TDocument } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsSourceAsync(TDocument document, Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -2458,7 +3060,10 @@ public virtual Task ExistsSourceAsync(TDocument } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsSourceAsync(TDocument document, Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2470,7 +3075,10 @@ public virtual Task ExistsSourceAsync(TDocument } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsSourceAsync(TDocument document, Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -2481,7 +3089,10 @@ public virtual Task ExistsSourceAsync(TDocument } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsSourceAsync(TDocument document, Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2493,7 +3104,10 @@ public virtual Task ExistsSourceAsync(TDocument } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsSourceAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -2504,7 +3118,10 @@ public virtual Task ExistsSourceAsync(Elastic.C } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsSourceAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2516,7 +3133,10 @@ public virtual Task ExistsSourceAsync(Elastic.C } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsSourceAsync(ExistsSourceRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2526,7 +3146,10 @@ public virtual Task ExistsSourceAsync(ExistsSourceRequestD } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsSourceAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -2537,7 +3160,10 @@ public virtual Task ExistsSourceAsync(Elastic.Clients.Elas } /// - /// Check for a document source.
Checks if a document's `_source` is stored. + /// + /// Check for a document source. + /// Checks if a document's _source is stored. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsSourceAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -2549,7 +3175,10 @@ public virtual Task ExistsSourceAsync(Elastic.Clients.Elas } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2560,7 +3189,10 @@ public virtual ExplainResponse Explain(ExplainRequest requ } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> ExplainAsync(ExplainRequest request, CancellationToken cancellationToken = default) @@ -2570,7 +3202,10 @@ public virtual Task> ExplainAsync(ExplainR } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2581,7 +3216,10 @@ public virtual ExplainResponse Explain(ExplainRequestDescr } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2593,7 +3231,10 @@ public virtual ExplainResponse Explain(Elastic.Clients.Ela } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2606,7 +3247,10 @@ public virtual ExplainResponse Explain(Elastic.Clients.Ela } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2618,7 +3262,10 @@ public virtual ExplainResponse Explain(TDocument document) } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2631,7 +3278,10 @@ public virtual ExplainResponse Explain(TDocument document, } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2643,7 +3293,10 @@ public virtual ExplainResponse Explain(TDocument document, } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2656,7 +3309,10 @@ public virtual ExplainResponse Explain(TDocument document, } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2668,7 +3324,10 @@ public virtual ExplainResponse Explain(TDocument document, } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2681,7 +3340,10 @@ public virtual ExplainResponse Explain(TDocument document, } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2693,7 +3355,10 @@ public virtual ExplainResponse Explain(Elastic.Clients.Ela } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2706,7 +3371,10 @@ public virtual ExplainResponse Explain(Elastic.Clients.Ela } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> ExplainAsync(ExplainRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2716,7 +3384,10 @@ public virtual Task> ExplainAsync(ExplainR } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> ExplainAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -2727,7 +3398,10 @@ public virtual Task> ExplainAsync(Elastic. } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> ExplainAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2739,7 +3413,10 @@ public virtual Task> ExplainAsync(Elastic. } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> ExplainAsync(TDocument document, CancellationToken cancellationToken = default) @@ -2750,7 +3427,10 @@ public virtual Task> ExplainAsync(TDocumen } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> ExplainAsync(TDocument document, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2762,7 +3442,10 @@ public virtual Task> ExplainAsync(TDocumen } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> ExplainAsync(TDocument document, Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -2773,7 +3456,10 @@ public virtual Task> ExplainAsync(TDocumen } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> ExplainAsync(TDocument document, Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2785,7 +3471,10 @@ public virtual Task> ExplainAsync(TDocumen } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> ExplainAsync(TDocument document, Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -2796,7 +3485,10 @@ public virtual Task> ExplainAsync(TDocumen } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> ExplainAsync(TDocument document, Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2808,7 +3500,10 @@ public virtual Task> ExplainAsync(TDocumen } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> ExplainAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -2819,7 +3514,10 @@ public virtual Task> ExplainAsync(Elastic. } /// - /// Explain a document match result.
Returns information about why a specific document matches, or doesn’t match, a query. + /// + /// Explain a document match result. + /// Returns information about why a specific document matches, or doesn’t match, a query. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> ExplainAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -2831,7 +3529,11 @@ public virtual Task> ExplainAsync(Elastic. } /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2842,7 +3544,11 @@ public virtual FieldCapsResponse FieldCaps(FieldCapsRequest request) } /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldCapsAsync(FieldCapsRequest request, CancellationToken cancellationToken = default) @@ -2852,7 +3558,11 @@ public virtual Task FieldCapsAsync(FieldCapsRequest request, } /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2863,7 +3573,11 @@ public virtual FieldCapsResponse FieldCaps(FieldCapsRequestDescriptor } /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2875,7 +3589,11 @@ public virtual FieldCapsResponse FieldCaps(Elastic.Clients.Elasticsea } /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2888,7 +3606,11 @@ public virtual FieldCapsResponse FieldCaps(Elastic.Clients.Elasticsea } /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2900,7 +3622,11 @@ public virtual FieldCapsResponse FieldCaps() } /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2913,7 +3639,11 @@ public virtual FieldCapsResponse FieldCaps(Action - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2924,7 +3654,11 @@ public virtual FieldCapsResponse FieldCaps(FieldCapsRequestDescriptor descriptor } /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2936,7 +3670,11 @@ public virtual FieldCapsResponse FieldCaps(Elastic.Clients.Elasticsearch.Indices } /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2949,7 +3687,11 @@ public virtual FieldCapsResponse FieldCaps(Elastic.Clients.Elasticsearch.Indices } /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2961,7 +3703,11 @@ public virtual FieldCapsResponse FieldCaps() } /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -2974,7 +3720,11 @@ public virtual FieldCapsResponse FieldCaps(Action co } /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldCapsAsync(FieldCapsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -2984,7 +3734,11 @@ public virtual Task FieldCapsAsync(FieldCapsReques } /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldCapsAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -2995,7 +3749,11 @@ public virtual Task FieldCapsAsync(Elastic.Clients } /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldCapsAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3007,7 +3765,11 @@ public virtual Task FieldCapsAsync(Elastic.Clients } /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldCapsAsync(CancellationToken cancellationToken = default) @@ -3018,7 +3780,11 @@ public virtual Task FieldCapsAsync(CancellationTok } /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldCapsAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -3030,7 +3796,11 @@ public virtual Task FieldCapsAsync(Action - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldCapsAsync(FieldCapsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3040,7 +3810,11 @@ public virtual Task FieldCapsAsync(FieldCapsRequestDescriptor } /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldCapsAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -3051,7 +3825,11 @@ public virtual Task FieldCapsAsync(Elastic.Clients.Elasticsea } /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldCapsAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -3063,7 +3841,11 @@ public virtual Task FieldCapsAsync(Elastic.Clients.Elasticsea } /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldCapsAsync(CancellationToken cancellationToken = default) @@ -3074,7 +3856,11 @@ public virtual Task FieldCapsAsync(CancellationToken cancella } /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices.
The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
of keyword is returned as any other field that belongs to the `keyword` family. + /// + /// The field capabilities API returns the information about the capabilities of fields among multiple indices. + /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type + /// of keyword is returned as any other field that belongs to the keyword family. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FieldCapsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -3086,7 +3872,10 @@ public virtual Task FieldCapsAsync(Action - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3097,7 +3886,10 @@ public virtual GetResponse Get(GetRequest request) } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(GetRequest request, CancellationToken cancellationToken = default) @@ -3107,7 +3899,10 @@ public virtual Task> GetAsync(GetRequest reque } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3118,7 +3913,10 @@ public virtual GetResponse Get(GetRequestDescriptor - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3130,7 +3928,10 @@ public virtual GetResponse Get(Elastic.Clients.Elasticsear } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3143,7 +3944,10 @@ public virtual GetResponse Get(Elastic.Clients.Elasticsear } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3155,7 +3959,10 @@ public virtual GetResponse Get(TDocument document) } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3168,7 +3975,10 @@ public virtual GetResponse Get(TDocument document, Action< } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3180,7 +3990,10 @@ public virtual GetResponse Get(TDocument document, Elastic } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3193,7 +4006,10 @@ public virtual GetResponse Get(TDocument document, Elastic } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3205,7 +4021,10 @@ public virtual GetResponse Get(TDocument document, Elastic } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3218,7 +4037,10 @@ public virtual GetResponse Get(TDocument document, Elastic } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3230,7 +4052,10 @@ public virtual GetResponse Get(Elastic.Clients.Elasticsear } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3243,7 +4068,10 @@ public virtual GetResponse Get(Elastic.Clients.Elasticsear } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(GetRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3253,7 +4081,10 @@ public virtual Task> GetAsync(GetRequestDescri } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -3264,7 +4095,10 @@ public virtual Task> GetAsync(Elastic.Clients. } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3276,7 +4110,10 @@ public virtual Task> GetAsync(Elastic.Clients. } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(TDocument document, CancellationToken cancellationToken = default) @@ -3287,7 +4124,10 @@ public virtual Task> GetAsync(TDocument docume } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(TDocument document, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3299,7 +4139,10 @@ public virtual Task> GetAsync(TDocument docume } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(TDocument document, Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -3310,7 +4153,10 @@ public virtual Task> GetAsync(TDocument docume } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(TDocument document, Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3322,7 +4168,10 @@ public virtual Task> GetAsync(TDocument docume } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(TDocument document, Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -3333,7 +4182,10 @@ public virtual Task> GetAsync(TDocument docume } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(TDocument document, Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3345,7 +4197,10 @@ public virtual Task> GetAsync(TDocument docume } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -3356,7 +4211,10 @@ public virtual Task> GetAsync(Elastic.Clients. } /// - /// Get a document by its ID.
Retrieves the document with the specified ID from an index. + /// + /// Get a document by its ID. + /// Retrieves the document with the specified ID from an index. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3368,7 +4226,10 @@ public virtual Task> GetAsync(Elastic.Clients. } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3379,7 +4240,10 @@ public virtual GetScriptResponse 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetScriptAsync(GetScriptRequest request, CancellationToken cancellationToken = default) @@ -3389,7 +4253,10 @@ public virtual Task GetScriptAsync(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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3400,7 +4267,10 @@ public virtual GetScriptResponse GetScript(GetScriptRequestDescriptor } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3412,7 +4282,10 @@ public virtual GetScriptResponse GetScript(Elastic.Clients.Elasticsea } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3425,7 +4298,10 @@ public virtual GetScriptResponse GetScript(Elastic.Clients.Elasticsea } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3436,7 +4312,10 @@ public virtual GetScriptResponse GetScript(GetScriptRequestDescriptor descriptor } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3448,7 +4327,10 @@ public virtual GetScriptResponse GetScript(Elastic.Clients.Elasticsearch.Id id) } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3461,7 +4343,10 @@ public virtual GetScriptResponse GetScript(Elastic.Clients.Elasticsearch.Id id, } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetScriptAsync(GetScriptRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3471,7 +4356,10 @@ public virtual Task GetScriptAsync(GetScriptReques } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetScriptAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -3482,7 +4370,10 @@ public virtual Task GetScriptAsync(Elastic.Clients } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetScriptAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3494,7 +4385,10 @@ public virtual Task GetScriptAsync(Elastic.Clients } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetScriptAsync(GetScriptRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3504,7 +4398,10 @@ public virtual Task GetScriptAsync(GetScriptRequestDescriptor } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetScriptAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -3515,7 +4412,10 @@ public virtual Task GetScriptAsync(Elastic.Clients.Elasticsea } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetScriptAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -3527,7 +4427,9 @@ public virtual Task GetScriptAsync(Elastic.Clients.Elasticsea } /// - /// Returns all script contexts. + /// + /// Returns all script contexts. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3538,7 +4440,9 @@ public virtual GetScriptContextResponse GetScriptContext(GetScriptContextRequest } /// - /// Returns all script contexts. + /// + /// Returns all script contexts. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetScriptContextAsync(GetScriptContextRequest request, CancellationToken cancellationToken = default) @@ -3548,7 +4452,9 @@ public virtual Task GetScriptContextAsync(GetScriptCon } /// - /// Returns all script contexts. + /// + /// Returns all script contexts. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3559,7 +4465,9 @@ public virtual GetScriptContextResponse GetScriptContext(GetScriptContextRequest } /// - /// Returns all script contexts. + /// + /// Returns all script contexts. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3571,7 +4479,9 @@ public virtual GetScriptContextResponse GetScriptContext() } /// - /// Returns all script contexts. + /// + /// Returns all script contexts. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3584,7 +4494,9 @@ public virtual GetScriptContextResponse GetScriptContext(Action - /// Returns all script contexts. + /// + /// Returns all script contexts. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetScriptContextAsync(GetScriptContextRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3594,7 +4506,9 @@ public virtual Task GetScriptContextAsync(GetScriptCon } /// - /// Returns all script contexts. + /// + /// Returns all script contexts. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetScriptContextAsync(CancellationToken cancellationToken = default) @@ -3605,7 +4519,9 @@ public virtual Task GetScriptContextAsync(Cancellation } /// - /// Returns all script contexts. + /// + /// Returns all script contexts. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetScriptContextAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -3617,7 +4533,9 @@ public virtual Task GetScriptContextAsync(Action - /// Returns available script types, languages and contexts + /// + /// Returns available script types, languages and contexts + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3628,7 +4546,9 @@ public virtual GetScriptLanguagesResponse GetScriptLanguages(GetScriptLanguagesR } /// - /// Returns available script types, languages and contexts + /// + /// Returns available script types, languages and contexts + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetScriptLanguagesAsync(GetScriptLanguagesRequest request, CancellationToken cancellationToken = default) @@ -3638,7 +4558,9 @@ public virtual Task GetScriptLanguagesAsync(GetScrip } /// - /// Returns available script types, languages and contexts + /// + /// Returns available script types, languages and contexts + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3649,7 +4571,9 @@ public virtual GetScriptLanguagesResponse GetScriptLanguages(GetScriptLanguagesR } /// - /// Returns available script types, languages and contexts + /// + /// Returns available script types, languages and contexts + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3661,7 +4585,9 @@ public virtual GetScriptLanguagesResponse GetScriptLanguages() } /// - /// Returns available script types, languages and contexts + /// + /// Returns available script types, languages and contexts + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3674,7 +4600,9 @@ public virtual GetScriptLanguagesResponse GetScriptLanguages(Action - /// Returns available script types, languages and contexts + /// + /// Returns available script types, languages and contexts + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetScriptLanguagesAsync(GetScriptLanguagesRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3684,7 +4612,9 @@ public virtual Task GetScriptLanguagesAsync(GetScrip } /// - /// Returns available script types, languages and contexts + /// + /// Returns available script types, languages and contexts + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetScriptLanguagesAsync(CancellationToken cancellationToken = default) @@ -3695,7 +4625,9 @@ public virtual Task GetScriptLanguagesAsync(Cancella } /// - /// Returns available script types, languages and contexts + /// + /// Returns available script types, languages and contexts + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetScriptLanguagesAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -3707,7 +4639,10 @@ public virtual Task GetScriptLanguagesAsync(Action - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3718,7 +4653,10 @@ public virtual GetSourceResponse GetSource(GetSourceReques } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetSourceAsync(GetSourceRequest request, CancellationToken cancellationToken = default) @@ -3728,7 +4666,10 @@ public virtual Task> GetSourceAsync(GetS } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3739,7 +4680,10 @@ public virtual GetSourceResponse GetSource(GetSourceReques } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3751,7 +4695,10 @@ public virtual GetSourceResponse GetSource(Elastic.Clients } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3764,7 +4711,10 @@ public virtual GetSourceResponse GetSource(Elastic.Clients } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3776,7 +4726,10 @@ public virtual GetSourceResponse GetSource(TDocument docum } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3789,7 +4742,10 @@ public virtual GetSourceResponse GetSource(TDocument docum } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3801,7 +4757,10 @@ public virtual GetSourceResponse GetSource(TDocument docum } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3814,7 +4773,10 @@ public virtual GetSourceResponse GetSource(TDocument docum } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3826,7 +4788,10 @@ public virtual GetSourceResponse GetSource(TDocument docum } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3839,7 +4804,10 @@ public virtual GetSourceResponse GetSource(TDocument docum } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3851,7 +4819,10 @@ public virtual GetSourceResponse GetSource(Elastic.Clients } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -3864,7 +4835,10 @@ public virtual GetSourceResponse GetSource(Elastic.Clients } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetSourceAsync(GetSourceRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -3874,7 +4848,10 @@ public virtual Task> GetSourceAsync(GetS } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetSourceAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -3885,7 +4862,10 @@ public virtual Task> GetSourceAsync(Elas } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetSourceAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3897,7 +4877,10 @@ public virtual Task> GetSourceAsync(Elas } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetSourceAsync(TDocument document, CancellationToken cancellationToken = default) @@ -3908,7 +4891,10 @@ public virtual Task> GetSourceAsync(TDoc } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetSourceAsync(TDocument document, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3920,7 +4906,10 @@ public virtual Task> GetSourceAsync(TDoc } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetSourceAsync(TDocument document, Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -3931,7 +4920,10 @@ public virtual Task> GetSourceAsync(TDoc } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetSourceAsync(TDocument document, Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3943,7 +4935,10 @@ public virtual Task> GetSourceAsync(TDoc } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetSourceAsync(TDocument document, Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -3954,7 +4949,10 @@ public virtual Task> GetSourceAsync(TDoc } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetSourceAsync(TDocument document, Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3966,7 +4964,10 @@ public virtual Task> GetSourceAsync(TDoc } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetSourceAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -3977,7 +4978,10 @@ public virtual Task> GetSourceAsync(Elas } /// - /// Get a document's source.
Returns the source of a document. + /// + /// Get a document's source. + /// Returns the source of a document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetSourceAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -3989,7 +4993,9 @@ public virtual Task> GetSourceAsync(Elas } /// - /// Returns the health of the cluster. + /// + /// Returns the health of the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4000,7 +5006,9 @@ public virtual HealthReportResponse HealthReport(HealthReportRequest request) } /// - /// Returns the health of the cluster. + /// + /// Returns the health of the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthReportAsync(HealthReportRequest request, CancellationToken cancellationToken = default) @@ -4010,7 +5018,9 @@ public virtual Task HealthReportAsync(HealthReportRequest } /// - /// Returns the health of the cluster. + /// + /// Returns the health of the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4021,7 +5031,9 @@ public virtual HealthReportResponse HealthReport(HealthReportRequestDescriptor d } /// - /// Returns the health of the cluster. + /// + /// Returns the health of the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4033,7 +5045,9 @@ public virtual HealthReportResponse HealthReport(IReadOnlyCollection? fe } /// - /// Returns the health of the cluster. + /// + /// Returns the health of the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4046,7 +5060,9 @@ public virtual HealthReportResponse HealthReport(IReadOnlyCollection? fe } /// - /// Returns the health of the cluster. + /// + /// Returns the health of the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4058,7 +5074,9 @@ public virtual HealthReportResponse HealthReport() } /// - /// Returns the health of the cluster. + /// + /// Returns the health of the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4071,7 +5089,9 @@ public virtual HealthReportResponse HealthReport(Action - /// Returns the health of the cluster. + /// + /// Returns the health of the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthReportAsync(HealthReportRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4081,7 +5101,9 @@ public virtual Task HealthReportAsync(HealthReportRequestD } /// - /// Returns the health of the cluster. + /// + /// Returns the health of the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthReportAsync(IReadOnlyCollection? feature, CancellationToken cancellationToken = default) @@ -4092,7 +5114,9 @@ public virtual Task HealthReportAsync(IReadOnlyCollection< } /// - /// Returns the health of the cluster. + /// + /// Returns the health of the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthReportAsync(IReadOnlyCollection? feature, Action configureRequest, CancellationToken cancellationToken = default) @@ -4104,7 +5128,9 @@ public virtual Task HealthReportAsync(IReadOnlyCollection< } /// - /// Returns the health of the cluster. + /// + /// Returns the health of the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthReportAsync(CancellationToken cancellationToken = default) @@ -4115,7 +5141,9 @@ public virtual Task HealthReportAsync(CancellationToken ca } /// - /// Returns the health of the cluster. + /// + /// Returns the health of the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthReportAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -4127,7 +5155,11 @@ public virtual Task HealthReportAsync(Action - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4138,7 +5170,11 @@ public virtual IndexResponse Index(IndexRequest request) } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task IndexAsync(IndexRequest request, CancellationToken cancellationToken = default) @@ -4148,7 +5184,11 @@ public virtual Task IndexAsync(IndexRequest } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4159,7 +5199,11 @@ public virtual IndexResponse Index(IndexRequestDescriptor } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4171,7 +5215,11 @@ public virtual IndexResponse Index(TDocument document, Elastic.Client } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4184,7 +5232,11 @@ public virtual IndexResponse Index(TDocument document, Elastic.Client } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4196,7 +5248,11 @@ public virtual IndexResponse Index(TDocument document) } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4209,7 +5265,11 @@ public virtual IndexResponse Index(TDocument document, Action - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4221,7 +5281,11 @@ public virtual IndexResponse Index(TDocument document, Elastic.Client } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4234,7 +5298,11 @@ public virtual IndexResponse Index(TDocument document, Elastic.Client } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4246,7 +5314,11 @@ public virtual IndexResponse Index(TDocument document, Elastic.Client } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4259,7 +5331,11 @@ public virtual IndexResponse Index(TDocument document, Elastic.Client } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task IndexAsync(IndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4269,7 +5345,11 @@ public virtual Task IndexAsync(IndexRequestDescriptor< } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task IndexAsync(TDocument document, Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Id? id, CancellationToken cancellationToken = default) @@ -4280,7 +5360,11 @@ public virtual Task IndexAsync(TDocument document, Ela } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task IndexAsync(TDocument document, Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Id? id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -4292,7 +5376,11 @@ public virtual Task IndexAsync(TDocument document, Ela } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task IndexAsync(TDocument document, CancellationToken cancellationToken = default) @@ -4303,7 +5391,11 @@ public virtual Task IndexAsync(TDocument document, Can } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task IndexAsync(TDocument document, Action> configureRequest, CancellationToken cancellationToken = default) @@ -4315,7 +5407,11 @@ public virtual Task IndexAsync(TDocument document, Act } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task IndexAsync(TDocument document, Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -4326,7 +5422,11 @@ public virtual Task IndexAsync(TDocument document, Ela } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task IndexAsync(TDocument document, Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -4338,7 +5438,11 @@ public virtual Task IndexAsync(TDocument document, Ela } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task IndexAsync(TDocument document, Elastic.Clients.Elasticsearch.Id? id, CancellationToken cancellationToken = default) @@ -4349,7 +5453,11 @@ public virtual Task IndexAsync(TDocument document, Ela } /// - /// Index a document.
Adds a JSON document to the specified data stream or index and makes it searchable.
If the target is an index and the document already exists, the request updates the document and increments its version. + /// + /// Index a document. + /// Adds a JSON document to the specified data stream or index and makes it searchable. + /// If the target is an index and the document already exists, the request updates the document and increments its version. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task IndexAsync(TDocument document, Elastic.Clients.Elasticsearch.Id? id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -4361,7 +5469,10 @@ public virtual Task IndexAsync(TDocument document, Ela } /// - /// Get cluster info.
Returns basic information about the cluster. + /// + /// Get cluster info. + /// Returns basic information about the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4372,7 +5483,10 @@ public virtual InfoResponse Info(InfoRequest request) } /// - /// Get cluster info.
Returns basic information about the cluster. + /// + /// Get cluster info. + /// Returns basic information about the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(InfoRequest request, CancellationToken cancellationToken = default) @@ -4382,7 +5496,10 @@ public virtual Task InfoAsync(InfoRequest request, CancellationTok } /// - /// Get cluster info.
Returns basic information about the cluster. + /// + /// Get cluster info. + /// Returns basic information about the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4393,7 +5510,10 @@ public virtual InfoResponse Info(InfoRequestDescriptor descriptor) } /// - /// Get cluster info.
Returns basic information about the cluster. + /// + /// Get cluster info. + /// Returns basic information about the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4405,7 +5525,10 @@ public virtual InfoResponse Info() } /// - /// Get cluster info.
Returns basic information about the cluster. + /// + /// Get cluster info. + /// Returns basic information about the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4418,7 +5541,10 @@ public virtual InfoResponse Info(Action configureRequest) } /// - /// Get cluster info.
Returns basic information about the cluster. + /// + /// Get cluster info. + /// Returns basic information about the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(InfoRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4428,7 +5554,10 @@ public virtual Task InfoAsync(InfoRequestDescriptor descriptor, Ca } /// - /// Get cluster info.
Returns basic information about the cluster. + /// + /// Get cluster info. + /// Returns basic information about the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(CancellationToken cancellationToken = default) @@ -4439,7 +5568,10 @@ public virtual Task InfoAsync(CancellationToken cancellationToken } /// - /// Get cluster info.
Returns basic information about the cluster. + /// + /// Get cluster info. + /// Returns basic information about the cluster. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -4451,7 +5583,9 @@ public virtual Task InfoAsync(Action config } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4462,7 +5596,9 @@ public virtual MultiTermVectorsResponse Mtermvectors(MultiTermVectorsRequest req } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MtermvectorsAsync(MultiTermVectorsRequest request, CancellationToken cancellationToken = default) @@ -4472,7 +5608,9 @@ public virtual Task MtermvectorsAsync(MultiTermVectors } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4483,7 +5621,9 @@ public virtual MultiTermVectorsResponse Mtermvectors(MultiTermVectors } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4495,7 +5635,9 @@ public virtual MultiTermVectorsResponse Mtermvectors(Elastic.Clients. } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4508,7 +5650,9 @@ public virtual MultiTermVectorsResponse Mtermvectors(Elastic.Clients. } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4520,7 +5664,9 @@ public virtual MultiTermVectorsResponse Mtermvectors() } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4533,7 +5679,9 @@ public virtual MultiTermVectorsResponse Mtermvectors(Action - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4544,7 +5692,9 @@ public virtual MultiTermVectorsResponse Mtermvectors(MultiTermVectorsRequestDesc } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4556,7 +5706,9 @@ public virtual MultiTermVectorsResponse Mtermvectors(Elastic.Clients.Elasticsear } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4569,7 +5721,9 @@ public virtual MultiTermVectorsResponse Mtermvectors(Elastic.Clients.Elasticsear } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4581,7 +5735,9 @@ public virtual MultiTermVectorsResponse Mtermvectors() } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4594,7 +5750,9 @@ public virtual MultiTermVectorsResponse Mtermvectors(Action - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MtermvectorsAsync(MultiTermVectorsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4604,7 +5762,9 @@ public virtual Task MtermvectorsAsync(Multi } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MtermvectorsAsync(Elastic.Clients.Elasticsearch.IndexName? index, CancellationToken cancellationToken = default) @@ -4615,7 +5775,9 @@ public virtual Task MtermvectorsAsync(Elast } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MtermvectorsAsync(Elastic.Clients.Elasticsearch.IndexName? index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -4627,7 +5789,9 @@ public virtual Task MtermvectorsAsync(Elast } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MtermvectorsAsync(CancellationToken cancellationToken = default) @@ -4638,7 +5802,9 @@ public virtual Task MtermvectorsAsync(Cance } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MtermvectorsAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -4650,7 +5816,9 @@ public virtual Task MtermvectorsAsync(Actio } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MtermvectorsAsync(MultiTermVectorsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4660,7 +5828,9 @@ public virtual Task MtermvectorsAsync(MultiTermVectors } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MtermvectorsAsync(Elastic.Clients.Elasticsearch.IndexName? index, CancellationToken cancellationToken = default) @@ -4671,7 +5841,9 @@ public virtual Task MtermvectorsAsync(Elastic.Clients. } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MtermvectorsAsync(Elastic.Clients.Elasticsearch.IndexName? index, Action configureRequest, CancellationToken cancellationToken = default) @@ -4683,7 +5855,9 @@ public virtual Task MtermvectorsAsync(Elastic.Clients. } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MtermvectorsAsync(CancellationToken cancellationToken = default) @@ -4694,7 +5868,9 @@ public virtual Task MtermvectorsAsync(CancellationToke } /// - /// Returns multiple termvectors in one request. + /// + /// Returns multiple termvectors in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MtermvectorsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -4706,7 +5882,9 @@ public virtual Task MtermvectorsAsync(Action - /// Allows to get multiple documents in one request. + /// + /// Allows to get multiple documents in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4717,7 +5895,9 @@ public virtual MultiGetResponse MultiGet(MultiGetRequest r } /// - /// Allows to get multiple documents in one request. + /// + /// Allows to get multiple documents in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiGetAsync(MultiGetRequest request, CancellationToken cancellationToken = default) @@ -4727,7 +5907,9 @@ public virtual Task> MultiGetAsync(MultiG } /// - /// Allows to get multiple documents in one request. + /// + /// Allows to get multiple documents in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4738,7 +5920,9 @@ public virtual MultiGetResponse MultiGet(MultiGetRequestDe } /// - /// Allows to get multiple documents in one request. + /// + /// Allows to get multiple documents in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4750,7 +5934,9 @@ public virtual MultiGetResponse MultiGet(Elastic.Clients.E } /// - /// Allows to get multiple documents in one request. + /// + /// Allows to get multiple documents in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4763,7 +5949,9 @@ public virtual MultiGetResponse MultiGet(Elastic.Clients.E } /// - /// Allows to get multiple documents in one request. + /// + /// Allows to get multiple documents in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4775,7 +5963,9 @@ public virtual MultiGetResponse MultiGet() } /// - /// Allows to get multiple documents in one request. + /// + /// Allows to get multiple documents in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4788,7 +5978,9 @@ public virtual MultiGetResponse MultiGet(Action - /// Allows to get multiple documents in one request. + /// + /// Allows to get multiple documents in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiGetAsync(MultiGetRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4798,7 +5990,9 @@ public virtual Task> MultiGetAsync(MultiG } /// - /// Allows to get multiple documents in one request. + /// + /// Allows to get multiple documents in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiGetAsync(Elastic.Clients.Elasticsearch.IndexName? index, CancellationToken cancellationToken = default) @@ -4809,7 +6003,9 @@ public virtual Task> MultiGetAsync(Elasti } /// - /// Allows to get multiple documents in one request. + /// + /// Allows to get multiple documents in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiGetAsync(Elastic.Clients.Elasticsearch.IndexName? index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -4821,7 +6017,9 @@ public virtual Task> MultiGetAsync(Elasti } /// - /// Allows to get multiple documents in one request. + /// + /// Allows to get multiple documents in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiGetAsync(CancellationToken cancellationToken = default) @@ -4832,7 +6030,9 @@ public virtual Task> MultiGetAsync(Cancel } /// - /// Allows to get multiple documents in one request. + /// + /// Allows to get multiple documents in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiGetAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -4844,7 +6044,9 @@ public virtual Task> MultiGetAsync(Action } /// - /// Allows to execute several search operations in one request. + /// + /// Allows to execute several search operations in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4855,7 +6057,9 @@ public virtual MultiSearchResponse MultiSearch(MultiSearch } /// - /// Allows to execute several search operations in one request. + /// + /// Allows to execute several search operations in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiSearchAsync(MultiSearchRequest request, CancellationToken cancellationToken = default) @@ -4865,7 +6069,9 @@ public virtual Task> MultiSearchAsync( } /// - /// Allows to execute several search operations in one request. + /// + /// Allows to execute several search operations in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4876,7 +6082,9 @@ public virtual MultiSearchResponse MultiSearch(MultiSearch } /// - /// Allows to execute several search operations in one request. + /// + /// Allows to execute several search operations in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4888,7 +6096,9 @@ public virtual MultiSearchResponse MultiSearch(Elastic.Cli } /// - /// Allows to execute several search operations in one request. + /// + /// Allows to execute several search operations in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4901,7 +6111,9 @@ public virtual MultiSearchResponse MultiSearch(Elastic.Cli } /// - /// Allows to execute several search operations in one request. + /// + /// Allows to execute several search operations in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4913,7 +6125,9 @@ public virtual MultiSearchResponse MultiSearch() } /// - /// Allows to execute several search operations in one request. + /// + /// Allows to execute several search operations in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4926,7 +6140,9 @@ public virtual MultiSearchResponse MultiSearch(Action - /// Allows to execute several search operations in one request. + /// + /// Allows to execute several search operations in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiSearchAsync(MultiSearchRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -4936,7 +6152,9 @@ public virtual Task> MultiSearchAsync( } /// - /// Allows to execute several search operations in one request. + /// + /// Allows to execute several search operations in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiSearchAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -4947,7 +6165,9 @@ public virtual Task> MultiSearchAsync( } /// - /// Allows to execute several search operations in one request. + /// + /// Allows to execute several search operations in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiSearchAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -4959,7 +6179,9 @@ public virtual Task> MultiSearchAsync( } /// - /// Allows to execute several search operations in one request. + /// + /// Allows to execute several search operations in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiSearchAsync(CancellationToken cancellationToken = default) @@ -4970,7 +6192,9 @@ public virtual Task> MultiSearchAsync( } /// - /// Allows to execute several search operations in one request. + /// + /// Allows to execute several search operations in one request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiSearchAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -4982,7 +6206,9 @@ public virtual Task> MultiSearchAsync( } /// - /// Runs multiple templated searches with a single request. + /// + /// Runs multiple templated searches with a single request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -4993,7 +6219,9 @@ public virtual MultiSearchTemplateResponse MultiSearchTemplate - /// Runs multiple templated searches with a single request. + /// + /// Runs multiple templated searches with a single request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiSearchTemplateAsync(MultiSearchTemplateRequest request, CancellationToken cancellationToken = default) @@ -5003,7 +6231,9 @@ public virtual Task> MultiSearchTemplateA } /// - /// Runs multiple templated searches with a single request. + /// + /// Runs multiple templated searches with a single request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5014,7 +6244,9 @@ public virtual MultiSearchTemplateResponse MultiSearchTemplate - /// Runs multiple templated searches with a single request. + /// + /// Runs multiple templated searches with a single request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5026,7 +6258,9 @@ public virtual MultiSearchTemplateResponse MultiSearchTemplate - /// Runs multiple templated searches with a single request. + /// + /// Runs multiple templated searches with a single request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5039,7 +6273,9 @@ public virtual MultiSearchTemplateResponse MultiSearchTemplate - /// Runs multiple templated searches with a single request. + /// + /// Runs multiple templated searches with a single request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5051,7 +6287,9 @@ public virtual MultiSearchTemplateResponse MultiSearchTemplate - /// Runs multiple templated searches with a single request. + /// + /// Runs multiple templated searches with a single request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5064,7 +6302,9 @@ public virtual MultiSearchTemplateResponse MultiSearchTemplate - /// Runs multiple templated searches with a single request. + /// + /// Runs multiple templated searches with a single request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiSearchTemplateAsync(MultiSearchTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -5074,7 +6314,9 @@ public virtual Task> MultiSearchTemplateA } /// - /// Runs multiple templated searches with a single request. + /// + /// Runs multiple templated searches with a single request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiSearchTemplateAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -5085,7 +6327,9 @@ public virtual Task> MultiSearchTemplateA } /// - /// Runs multiple templated searches with a single request. + /// + /// Runs multiple templated searches with a single request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiSearchTemplateAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -5097,7 +6341,9 @@ public virtual Task> MultiSearchTemplateA } /// - /// Runs multiple templated searches with a single request. + /// + /// Runs multiple templated searches with a single request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiSearchTemplateAsync(CancellationToken cancellationToken = default) @@ -5108,7 +6354,9 @@ public virtual Task> MultiSearchTemplateA } /// - /// Runs multiple templated searches with a single request. + /// + /// Runs multiple templated searches with a single request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> MultiSearchTemplateAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -5120,7 +6368,14 @@ public virtual Task> MultiSearchTemplateA } /// - /// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. + /// + /// A search request by default executes against the most recent visible data of the target indices, + /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the + /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple + /// search requests using the same point in time. For example, if refreshes happen between + /// search_after requests, then the results of those requests might not be consistent as changes happening + /// between searches are only visible to the more recent point in time. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5131,7 +6386,14 @@ public virtual OpenPointInTimeResponse OpenPointInTime(OpenPointInTimeRequest re } /// - /// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. + /// + /// A search request by default executes against the most recent visible data of the target indices, + /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the + /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple + /// search requests using the same point in time. For example, if refreshes happen between + /// search_after requests, then the results of those requests might not be consistent as changes happening + /// between searches are only visible to the more recent point in time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(OpenPointInTimeRequest request, CancellationToken cancellationToken = default) @@ -5141,7 +6403,14 @@ public virtual Task OpenPointInTimeAsync(OpenPointInTim } /// - /// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. + /// + /// A search request by default executes against the most recent visible data of the target indices, + /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the + /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple + /// search requests using the same point in time. For example, if refreshes happen between + /// search_after requests, then the results of those requests might not be consistent as changes happening + /// between searches are only visible to the more recent point in time. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5152,7 +6421,14 @@ public virtual OpenPointInTimeResponse OpenPointInTime(OpenPointInTim } /// - /// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. + /// + /// A search request by default executes against the most recent visible data of the target indices, + /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the + /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple + /// search requests using the same point in time. For example, if refreshes happen between + /// search_after requests, then the results of those requests might not be consistent as changes happening + /// between searches are only visible to the more recent point in time. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5164,7 +6440,14 @@ public virtual OpenPointInTimeResponse OpenPointInTime(Elastic.Client } /// - /// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. + /// + /// A search request by default executes against the most recent visible data of the target indices, + /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the + /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple + /// search requests using the same point in time. For example, if refreshes happen between + /// search_after requests, then the results of those requests might not be consistent as changes happening + /// between searches are only visible to the more recent point in time. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5177,7 +6460,14 @@ public virtual OpenPointInTimeResponse OpenPointInTime(Elastic.Client } /// - /// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. + /// + /// A search request by default executes against the most recent visible data of the target indices, + /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the + /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple + /// search requests using the same point in time. For example, if refreshes happen between + /// search_after requests, then the results of those requests might not be consistent as changes happening + /// between searches are only visible to the more recent point in time. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5189,7 +6479,14 @@ public virtual OpenPointInTimeResponse OpenPointInTime() } /// - /// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. + /// + /// A search request by default executes against the most recent visible data of the target indices, + /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the + /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple + /// search requests using the same point in time. For example, if refreshes happen between + /// search_after requests, then the results of those requests might not be consistent as changes happening + /// between searches are only visible to the more recent point in time. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5202,7 +6499,14 @@ public virtual OpenPointInTimeResponse OpenPointInTime(Action - /// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. + /// + /// A search request by default executes against the most recent visible data of the target indices, + /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the + /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple + /// search requests using the same point in time. For example, if refreshes happen between + /// search_after requests, then the results of those requests might not be consistent as changes happening + /// between searches are only visible to the more recent point in time. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5213,7 +6517,14 @@ public virtual OpenPointInTimeResponse OpenPointInTime(OpenPointInTimeRequestDes } /// - /// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. + /// + /// A search request by default executes against the most recent visible data of the target indices, + /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the + /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple + /// search requests using the same point in time. For example, if refreshes happen between + /// search_after requests, then the results of those requests might not be consistent as changes happening + /// between searches are only visible to the more recent point in time. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5225,7 +6536,14 @@ public virtual OpenPointInTimeResponse OpenPointInTime(Elastic.Clients.Elasticse } /// - /// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. + /// + /// A search request by default executes against the most recent visible data of the target indices, + /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the + /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple + /// search requests using the same point in time. For example, if refreshes happen between + /// search_after requests, then the results of those requests might not be consistent as changes happening + /// between searches are only visible to the more recent point in time. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5238,7 +6556,14 @@ public virtual OpenPointInTimeResponse OpenPointInTime(Elastic.Clients.Elasticse } /// - /// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. + /// + /// A search request by default executes against the most recent visible data of the target indices, + /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the + /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple + /// search requests using the same point in time. For example, if refreshes happen between + /// search_after requests, then the results of those requests might not be consistent as changes happening + /// between searches are only visible to the more recent point in time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(OpenPointInTimeRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -5248,7 +6573,14 @@ public virtual Task OpenPointInTimeAsync(Ope } /// - /// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. + /// + /// A search request by default executes against the most recent visible data of the target indices, + /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the + /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple + /// search requests using the same point in time. For example, if refreshes happen between + /// search_after requests, then the results of those requests might not be consistent as changes happening + /// between searches are only visible to the more recent point in time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -5259,7 +6591,14 @@ public virtual Task OpenPointInTimeAsync(Ela } /// - /// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. + /// + /// A search request by default executes against the most recent visible data of the target indices, + /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the + /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple + /// search requests using the same point in time. For example, if refreshes happen between + /// search_after requests, then the results of those requests might not be consistent as changes happening + /// between searches are only visible to the more recent point in time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -5271,7 +6610,14 @@ public virtual Task OpenPointInTimeAsync(Ela } /// - /// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. + /// + /// A search request by default executes against the most recent visible data of the target indices, + /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the + /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple + /// search requests using the same point in time. For example, if refreshes happen between + /// search_after requests, then the results of those requests might not be consistent as changes happening + /// between searches are only visible to the more recent point in time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(CancellationToken cancellationToken = default) @@ -5282,7 +6628,14 @@ public virtual Task OpenPointInTimeAsync(Can } /// - /// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. + /// + /// A search request by default executes against the most recent visible data of the target indices, + /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the + /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple + /// search requests using the same point in time. For example, if refreshes happen between + /// search_after requests, then the results of those requests might not be consistent as changes happening + /// between searches are only visible to the more recent point in time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -5294,7 +6647,14 @@ public virtual Task OpenPointInTimeAsync(Act } /// - /// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. + /// + /// A search request by default executes against the most recent visible data of the target indices, + /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the + /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple + /// search requests using the same point in time. For example, if refreshes happen between + /// search_after requests, then the results of those requests might not be consistent as changes happening + /// between searches are only visible to the more recent point in time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(OpenPointInTimeRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -5304,7 +6664,14 @@ public virtual Task OpenPointInTimeAsync(OpenPointInTim } /// - /// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. + /// + /// A search request by default executes against the most recent visible data of the target indices, + /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the + /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple + /// search requests using the same point in time. For example, if refreshes happen between + /// search_after requests, then the results of those requests might not be consistent as changes happening + /// between searches are only visible to the more recent point in time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -5315,7 +6682,14 @@ public virtual Task OpenPointInTimeAsync(Elastic.Client } /// - /// A search request by default executes against the most recent visible data of the target indices,
which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
search requests using the same point in time. For example, if refreshes happen between
`search_after` requests, then the results of those requests might not be consistent as changes happening
between searches are only visible to the more recent point in time. + /// + /// A search request by default executes against the most recent visible data of the target indices, + /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the + /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple + /// search requests using the same point in time. For example, if refreshes happen between + /// search_after requests, then the results of those requests might not be consistent as changes happening + /// between searches are only visible to the more recent point in time. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -5327,7 +6701,10 @@ public virtual Task OpenPointInTimeAsync(Elastic.Client } /// - /// Ping the cluster.
Returns whether the cluster is running. + /// + /// Ping the cluster. + /// Returns whether the cluster is running. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5338,7 +6715,10 @@ public virtual PingResponse Ping(PingRequest request) } /// - /// Ping the cluster.
Returns whether the cluster is running. + /// + /// Ping the cluster. + /// Returns whether the cluster is running. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PingAsync(PingRequest request, CancellationToken cancellationToken = default) @@ -5348,7 +6728,10 @@ public virtual Task PingAsync(PingRequest request, CancellationTok } /// - /// Ping the cluster.
Returns whether the cluster is running. + /// + /// Ping the cluster. + /// Returns whether the cluster is running. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5359,7 +6742,10 @@ public virtual PingResponse Ping(PingRequestDescriptor descriptor) } /// - /// Ping the cluster.
Returns whether the cluster is running. + /// + /// Ping the cluster. + /// Returns whether the cluster is running. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5371,7 +6757,10 @@ public virtual PingResponse Ping() } /// - /// Ping the cluster.
Returns whether the cluster is running. + /// + /// Ping the cluster. + /// Returns whether the cluster is running. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5384,7 +6773,10 @@ public virtual PingResponse Ping(Action configureRequest) } /// - /// Ping the cluster.
Returns whether the cluster is running. + /// + /// Ping the cluster. + /// Returns whether the cluster is running. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PingAsync(PingRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -5394,7 +6786,10 @@ public virtual Task PingAsync(PingRequestDescriptor descriptor, Ca } /// - /// Ping the cluster.
Returns whether the cluster is running. + /// + /// Ping the cluster. + /// Returns whether the cluster is running. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PingAsync(CancellationToken cancellationToken = default) @@ -5405,7 +6800,10 @@ public virtual Task PingAsync(CancellationToken cancellationToken } /// - /// Ping the cluster.
Returns whether the cluster is running. + /// + /// Ping the cluster. + /// Returns whether the cluster is running. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PingAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -5417,7 +6815,10 @@ public virtual Task PingAsync(Action config } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5428,7 +6829,10 @@ public virtual PutScriptResponse 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutScriptAsync(PutScriptRequest request, CancellationToken cancellationToken = default) @@ -5438,7 +6842,10 @@ public virtual Task PutScriptAsync(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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5449,7 +6856,10 @@ public virtual PutScriptResponse PutScript(PutScriptRequestDescriptor } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5461,7 +6871,10 @@ public virtual PutScriptResponse PutScript(Elastic.Clients.Elasticsea } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5474,7 +6887,10 @@ public virtual PutScriptResponse PutScript(Elastic.Clients.Elasticsea } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5486,7 +6902,10 @@ public virtual PutScriptResponse PutScript(Elastic.Clients.Elasticsea } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5499,7 +6918,10 @@ public virtual PutScriptResponse PutScript(Elastic.Clients.Elasticsea } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5510,7 +6932,10 @@ public virtual PutScriptResponse PutScript(PutScriptRequestDescriptor descriptor } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5522,7 +6947,10 @@ public virtual PutScriptResponse PutScript(Elastic.Clients.Elasticsearch.Id id, } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5535,7 +6963,10 @@ public virtual PutScriptResponse PutScript(Elastic.Clients.Elasticsearch.Id id, } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5547,7 +6978,10 @@ public virtual PutScriptResponse PutScript(Elastic.Clients.Elasticsearch.Id id) } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5560,7 +6994,10 @@ public virtual PutScriptResponse PutScript(Elastic.Clients.Elasticsearch.Id id, } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutScriptAsync(PutScriptRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -5570,7 +7007,10 @@ public virtual Task PutScriptAsync(PutScriptReques } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutScriptAsync(Elastic.Clients.Elasticsearch.Id id, Elastic.Clients.Elasticsearch.Name? context, CancellationToken cancellationToken = default) @@ -5581,7 +7021,10 @@ public virtual Task PutScriptAsync(Elastic.Clients } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutScriptAsync(Elastic.Clients.Elasticsearch.Id id, Elastic.Clients.Elasticsearch.Name? context, Action> configureRequest, CancellationToken cancellationToken = default) @@ -5593,7 +7036,10 @@ public virtual Task PutScriptAsync(Elastic.Clients } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutScriptAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -5604,7 +7050,10 @@ public virtual Task PutScriptAsync(Elastic.Clients } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutScriptAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -5616,7 +7065,10 @@ public virtual Task PutScriptAsync(Elastic.Clients } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutScriptAsync(PutScriptRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -5626,7 +7078,10 @@ public virtual Task PutScriptAsync(PutScriptRequestDescriptor } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutScriptAsync(Elastic.Clients.Elasticsearch.Id id, Elastic.Clients.Elasticsearch.Name? context, CancellationToken cancellationToken = default) @@ -5637,7 +7092,10 @@ public virtual Task PutScriptAsync(Elastic.Clients.Elasticsea } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutScriptAsync(Elastic.Clients.Elasticsearch.Id id, Elastic.Clients.Elasticsearch.Name? context, Action configureRequest, CancellationToken cancellationToken = default) @@ -5649,7 +7107,10 @@ public virtual Task PutScriptAsync(Elastic.Clients.Elasticsea } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutScriptAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -5660,7 +7121,10 @@ public virtual Task PutScriptAsync(Elastic.Clients.Elasticsea } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutScriptAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -5672,7 +7136,9 @@ public virtual Task PutScriptAsync(Elastic.Clients.Elasticsea } /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5683,7 +7149,9 @@ public virtual RankEvalResponse RankEval(RankEvalRequest request) } /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RankEvalAsync(RankEvalRequest request, CancellationToken cancellationToken = default) @@ -5693,7 +7161,9 @@ public virtual Task RankEvalAsync(RankEvalRequest request, Can } /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5704,7 +7174,9 @@ public virtual RankEvalResponse RankEval(RankEvalRequestDescriptor - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5716,7 +7188,9 @@ public virtual RankEvalResponse RankEval(Elastic.Clients.Elasticsearc } /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5729,7 +7203,9 @@ public virtual RankEvalResponse RankEval(Elastic.Clients.Elasticsearc } /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5741,7 +7217,9 @@ public virtual RankEvalResponse RankEval() } /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5754,7 +7232,9 @@ public virtual RankEvalResponse RankEval(Action - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5765,7 +7245,9 @@ public virtual RankEvalResponse RankEval(RankEvalRequestDescriptor descriptor) } /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5777,7 +7259,9 @@ public virtual RankEvalResponse RankEval(Elastic.Clients.Elasticsearch.Indices? } /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5790,7 +7274,9 @@ public virtual RankEvalResponse RankEval(Elastic.Clients.Elasticsearch.Indices? } /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5802,7 +7288,9 @@ public virtual RankEvalResponse RankEval() } /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5815,7 +7303,9 @@ public virtual RankEvalResponse RankEval(Action confi } /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RankEvalAsync(RankEvalRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -5825,7 +7315,9 @@ public virtual Task RankEvalAsync(RankEvalRequestDe } /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RankEvalAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -5836,7 +7328,9 @@ public virtual Task RankEvalAsync(Elastic.Clients.E } /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RankEvalAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -5848,7 +7342,9 @@ public virtual Task RankEvalAsync(Elastic.Clients.E } /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RankEvalAsync(CancellationToken cancellationToken = default) @@ -5859,7 +7355,9 @@ public virtual Task RankEvalAsync(CancellationToken } /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RankEvalAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -5871,7 +7369,9 @@ public virtual Task RankEvalAsync(Action - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RankEvalAsync(RankEvalRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -5881,7 +7381,9 @@ public virtual Task RankEvalAsync(RankEvalRequestDescriptor de } /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RankEvalAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -5892,7 +7394,9 @@ public virtual Task RankEvalAsync(Elastic.Clients.Elasticsearc } /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RankEvalAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -5904,7 +7408,9 @@ public virtual Task RankEvalAsync(Elastic.Clients.Elasticsearc } /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RankEvalAsync(CancellationToken cancellationToken = default) @@ -5915,7 +7421,9 @@ public virtual Task RankEvalAsync(CancellationToken cancellati } /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// + /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RankEvalAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -5927,7 +7435,10 @@ public virtual Task RankEvalAsync(Action - /// Reindex documents.
Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// + /// Reindex documents. + /// Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5938,7 +7449,10 @@ public virtual ReindexResponse Reindex(ReindexRequest request) } /// - /// Reindex documents.
Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// + /// Reindex documents. + /// Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReindexAsync(ReindexRequest request, CancellationToken cancellationToken = default) @@ -5948,7 +7462,10 @@ public virtual Task ReindexAsync(ReindexRequest request, Cancel } /// - /// Reindex documents.
Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// + /// Reindex documents. + /// Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5959,7 +7476,10 @@ public virtual ReindexResponse Reindex(ReindexRequestDescriptor - /// Reindex documents.
Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// + /// Reindex documents. + /// Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5971,7 +7491,10 @@ public virtual ReindexResponse Reindex() } /// - /// Reindex documents.
Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// + /// Reindex documents. + /// Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5984,7 +7507,10 @@ public virtual ReindexResponse Reindex(Action - /// Reindex documents.
Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// + /// Reindex documents. + /// Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -5995,7 +7521,10 @@ public virtual ReindexResponse Reindex(ReindexRequestDescriptor descriptor) } /// - /// Reindex documents.
Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// + /// Reindex documents. + /// Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6007,7 +7536,10 @@ public virtual ReindexResponse Reindex() } /// - /// Reindex documents.
Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// + /// Reindex documents. + /// Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6020,7 +7552,10 @@ public virtual ReindexResponse Reindex(Action configur } /// - /// Reindex documents.
Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// + /// Reindex documents. + /// Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReindexAsync(ReindexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6030,7 +7565,10 @@ public virtual Task ReindexAsync(ReindexRequestDescr } /// - /// Reindex documents.
Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// + /// Reindex documents. + /// Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReindexAsync(CancellationToken cancellationToken = default) @@ -6041,7 +7579,10 @@ public virtual Task ReindexAsync(CancellationToken c } /// - /// Reindex documents.
Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// + /// Reindex documents. + /// Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReindexAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -6053,7 +7594,10 @@ public virtual Task ReindexAsync(Action - /// Reindex documents.
Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// + /// Reindex documents. + /// Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReindexAsync(ReindexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6063,7 +7607,10 @@ public virtual Task ReindexAsync(ReindexRequestDescriptor descr } /// - /// Reindex documents.
Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// + /// Reindex documents. + /// Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReindexAsync(CancellationToken cancellationToken = default) @@ -6074,7 +7621,10 @@ public virtual Task ReindexAsync(CancellationToken cancellation } /// - /// Reindex documents.
Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// + /// Reindex documents. + /// Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReindexAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -6086,7 +7636,9 @@ public virtual Task ReindexAsync(Action - /// Copies documents from a source to a destination. + /// + /// Copies documents from a source to a destination. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6097,7 +7649,9 @@ public virtual ReindexRethrottleResponse ReindexRethrottle(ReindexRethrottleRequ } /// - /// Copies documents from a source to a destination. + /// + /// Copies documents from a source to a destination. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReindexRethrottleAsync(ReindexRethrottleRequest request, CancellationToken cancellationToken = default) @@ -6107,7 +7661,9 @@ public virtual Task ReindexRethrottleAsync(ReindexRet } /// - /// Copies documents from a source to a destination. + /// + /// Copies documents from a source to a destination. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6118,7 +7674,9 @@ public virtual ReindexRethrottleResponse ReindexRethrottle(ReindexRethrottleRequ } /// - /// Copies documents from a source to a destination. + /// + /// Copies documents from a source to a destination. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6130,7 +7688,9 @@ public virtual ReindexRethrottleResponse ReindexRethrottle(Elastic.Clients.Elast } /// - /// Copies documents from a source to a destination. + /// + /// Copies documents from a source to a destination. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6143,7 +7703,9 @@ public virtual ReindexRethrottleResponse ReindexRethrottle(Elastic.Clients.Elast } /// - /// Copies documents from a source to a destination. + /// + /// Copies documents from a source to a destination. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReindexRethrottleAsync(ReindexRethrottleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6153,7 +7715,9 @@ public virtual Task ReindexRethrottleAsync(ReindexRet } /// - /// Copies documents from a source to a destination. + /// + /// Copies documents from a source to a destination. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReindexRethrottleAsync(Elastic.Clients.Elasticsearch.Id taskId, CancellationToken cancellationToken = default) @@ -6164,7 +7728,9 @@ public virtual Task ReindexRethrottleAsync(Elastic.Cl } /// - /// Copies documents from a source to a destination. + /// + /// Copies documents from a source to a destination. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ReindexRethrottleAsync(Elastic.Clients.Elasticsearch.Id taskId, Action configureRequest, CancellationToken cancellationToken = default) @@ -6176,7 +7742,9 @@ public virtual Task ReindexRethrottleAsync(Elastic.Cl } /// - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6187,7 +7755,9 @@ public virtual RenderSearchTemplateResponse RenderSearchTemplate(RenderSearchTem } /// - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RenderSearchTemplateAsync(RenderSearchTemplateRequest request, CancellationToken cancellationToken = default) @@ -6197,7 +7767,9 @@ public virtual Task RenderSearchTemplateAsync(Rend } /// - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6208,7 +7780,9 @@ public virtual RenderSearchTemplateResponse RenderSearchTemplate(Rend } /// - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6220,7 +7794,9 @@ public virtual RenderSearchTemplateResponse RenderSearchTemplate(Elas } /// - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6233,7 +7809,9 @@ public virtual RenderSearchTemplateResponse RenderSearchTemplate(Elas } /// - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6245,7 +7823,9 @@ public virtual RenderSearchTemplateResponse RenderSearchTemplate() } /// - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6258,7 +7838,9 @@ public virtual RenderSearchTemplateResponse RenderSearchTemplate(Acti } /// - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6269,7 +7851,9 @@ public virtual RenderSearchTemplateResponse RenderSearchTemplate(RenderSearchTem } /// - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6281,7 +7865,9 @@ public virtual RenderSearchTemplateResponse RenderSearchTemplate(Elastic.Clients } /// - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6294,7 +7880,9 @@ public virtual RenderSearchTemplateResponse RenderSearchTemplate(Elastic.Clients } /// - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6306,7 +7894,9 @@ public virtual RenderSearchTemplateResponse RenderSearchTemplate() } /// - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6319,7 +7909,9 @@ public virtual RenderSearchTemplateResponse RenderSearchTemplate(Action - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RenderSearchTemplateAsync(RenderSearchTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6329,7 +7921,9 @@ public virtual Task RenderSearchTemplateAsync - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RenderSearchTemplateAsync(Elastic.Clients.Elasticsearch.Id? id, CancellationToken cancellationToken = default) @@ -6340,7 +7934,9 @@ public virtual Task RenderSearchTemplateAsync - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RenderSearchTemplateAsync(Elastic.Clients.Elasticsearch.Id? id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -6352,7 +7948,9 @@ public virtual Task RenderSearchTemplateAsync - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RenderSearchTemplateAsync(CancellationToken cancellationToken = default) @@ -6363,7 +7961,9 @@ public virtual Task RenderSearchTemplateAsync - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RenderSearchTemplateAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -6375,7 +7975,9 @@ public virtual Task RenderSearchTemplateAsync - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RenderSearchTemplateAsync(RenderSearchTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6385,7 +7987,9 @@ public virtual Task RenderSearchTemplateAsync(Rend } /// - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RenderSearchTemplateAsync(Elastic.Clients.Elasticsearch.Id? id, CancellationToken cancellationToken = default) @@ -6396,7 +8000,9 @@ public virtual Task RenderSearchTemplateAsync(Elas } /// - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RenderSearchTemplateAsync(Elastic.Clients.Elasticsearch.Id? id, Action configureRequest, CancellationToken cancellationToken = default) @@ -6408,7 +8014,9 @@ public virtual Task RenderSearchTemplateAsync(Elas } /// - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RenderSearchTemplateAsync(CancellationToken cancellationToken = default) @@ -6419,7 +8027,9 @@ public virtual Task RenderSearchTemplateAsync(Canc } /// - /// Renders a search template as a search request body. + /// + /// Renders a search template as a search request body. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RenderSearchTemplateAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -6431,7 +8041,10 @@ public virtual Task RenderSearchTemplateAsync(Acti } /// - /// Run a script.
Runs a script and returns a result. + /// + /// Run a script. + /// Runs a script and returns a result. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6442,7 +8055,10 @@ public virtual ScriptsPainlessExecuteResponse ScriptsPainlessExecute - /// Run a script.
Runs a script and returns a result. + /// + /// Run a script. + /// Runs a script and returns a result. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> ScriptsPainlessExecuteAsync(ScriptsPainlessExecuteRequest request, CancellationToken cancellationToken = default) @@ -6452,7 +8068,10 @@ public virtual Task> ScriptsPainlessExec } /// - /// Run a script.
Runs a script and returns a result. + /// + /// Run a script. + /// Runs a script and returns a result. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6463,7 +8082,10 @@ public virtual ScriptsPainlessExecuteResponse ScriptsPainlessExecute - /// Run a script.
Runs a script and returns a result. + /// + /// Run a script. + /// Runs a script and returns a result. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6475,7 +8097,10 @@ public virtual ScriptsPainlessExecuteResponse ScriptsPainlessExecute - /// Run a script.
Runs a script and returns a result. + /// + /// Run a script. + /// Runs a script and returns a result. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6488,7 +8113,10 @@ public virtual ScriptsPainlessExecuteResponse ScriptsPainlessExecute - /// Run a script.
Runs a script and returns a result. + /// + /// Run a script. + /// Runs a script and returns a result. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> ScriptsPainlessExecuteAsync(ScriptsPainlessExecuteRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6498,7 +8126,10 @@ public virtual Task> ScriptsPainlessExec } /// - /// Run a script.
Runs a script and returns a result. + /// + /// Run a script. + /// Runs a script and returns a result. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> ScriptsPainlessExecuteAsync(CancellationToken cancellationToken = default) @@ -6509,7 +8140,10 @@ public virtual Task> ScriptsPainlessExec } /// - /// Run a script.
Runs a script and returns a result. + /// + /// Run a script. + /// Runs a script and returns a result. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> ScriptsPainlessExecuteAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -6521,7 +8155,9 @@ public virtual Task> ScriptsPainlessExec } /// - /// Allows to retrieve a large numbers of results from a single search request. + /// + /// Allows to retrieve a large numbers of results from a single search request. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6532,7 +8168,9 @@ public virtual ScrollResponse Scroll(ScrollRequest request } /// - /// Allows to retrieve a large numbers of results from a single search request. + /// + /// Allows to retrieve a large numbers of results from a single search request. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> ScrollAsync(ScrollRequest request, CancellationToken cancellationToken = default) @@ -6542,7 +8180,11 @@ public virtual Task> ScrollAsync(ScrollRequ } /// - /// Returns search hits that match the query defined in the request.
You can provide search queries using the `q` query string parameter or the request body.
If both are specified, only the query parameter is used. + /// + /// Returns search hits that match the query defined in the request. + /// You can provide search queries using the q query string parameter or the request body. + /// If both are specified, only the query parameter is used. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6553,7 +8195,11 @@ public virtual SearchResponse Search(SearchRequest request } /// - /// Returns search hits that match the query defined in the request.
You can provide search queries using the `q` query string parameter or the request body.
If both are specified, only the query parameter is used. + /// + /// Returns search hits that match the query defined in the request. + /// You can provide search queries using the q query string parameter or the request body. + /// If both are specified, only the query parameter is used. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchAsync(SearchRequest request, CancellationToken cancellationToken = default) @@ -6563,7 +8209,11 @@ public virtual Task> SearchAsync(SearchRequ } /// - /// Returns search hits that match the query defined in the request.
You can provide search queries using the `q` query string parameter or the request body.
If both are specified, only the query parameter is used. + /// + /// Returns search hits that match the query defined in the request. + /// You can provide search queries using the q query string parameter or the request body. + /// If both are specified, only the query parameter is used. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6574,7 +8224,11 @@ public virtual SearchResponse Search(SearchRequestDescript } /// - /// Returns search hits that match the query defined in the request.
You can provide search queries using the `q` query string parameter or the request body.
If both are specified, only the query parameter is used. + /// + /// Returns search hits that match the query defined in the request. + /// You can provide search queries using the q query string parameter or the request body. + /// If both are specified, only the query parameter is used. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6586,7 +8240,11 @@ public virtual SearchResponse Search(Elastic.Clients.Elast } /// - /// Returns search hits that match the query defined in the request.
You can provide search queries using the `q` query string parameter or the request body.
If both are specified, only the query parameter is used. + /// + /// Returns search hits that match the query defined in the request. + /// You can provide search queries using the q query string parameter or the request body. + /// If both are specified, only the query parameter is used. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6599,7 +8257,11 @@ public virtual SearchResponse Search(Elastic.Clients.Elast } /// - /// Returns search hits that match the query defined in the request.
You can provide search queries using the `q` query string parameter or the request body.
If both are specified, only the query parameter is used. + /// + /// Returns search hits that match the query defined in the request. + /// You can provide search queries using the q query string parameter or the request body. + /// If both are specified, only the query parameter is used. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6611,7 +8273,11 @@ public virtual SearchResponse Search() } /// - /// Returns search hits that match the query defined in the request.
You can provide search queries using the `q` query string parameter or the request body.
If both are specified, only the query parameter is used. + /// + /// Returns search hits that match the query defined in the request. + /// You can provide search queries using the q query string parameter or the request body. + /// If both are specified, only the query parameter is used. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6624,7 +8290,11 @@ public virtual SearchResponse Search(Action - /// Returns search hits that match the query defined in the request.
You can provide search queries using the `q` query string parameter or the request body.
If both are specified, only the query parameter is used. + /// + /// Returns search hits that match the query defined in the request. + /// You can provide search queries using the q query string parameter or the request body. + /// If both are specified, only the query parameter is used. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchAsync(SearchRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6634,7 +8304,11 @@ public virtual Task> SearchAsync(SearchRequ } /// - /// Returns search hits that match the query defined in the request.
You can provide search queries using the `q` query string parameter or the request body.
If both are specified, only the query parameter is used. + /// + /// Returns search hits that match the query defined in the request. + /// You can provide search queries using the q query string parameter or the request body. + /// If both are specified, only the query parameter is used. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -6645,7 +8319,11 @@ public virtual Task> SearchAsync(Elastic.Cl } /// - /// Returns search hits that match the query defined in the request.
You can provide search queries using the `q` query string parameter or the request body.
If both are specified, only the query parameter is used. + /// + /// Returns search hits that match the query defined in the request. + /// You can provide search queries using the q query string parameter or the request body. + /// If both are specified, only the query parameter is used. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -6657,7 +8335,11 @@ public virtual Task> SearchAsync(Elastic.Cl } /// - /// Returns search hits that match the query defined in the request.
You can provide search queries using the `q` query string parameter or the request body.
If both are specified, only the query parameter is used. + /// + /// Returns search hits that match the query defined in the request. + /// You can provide search queries using the q query string parameter or the request body. + /// If both are specified, only the query parameter is used. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchAsync(CancellationToken cancellationToken = default) @@ -6668,7 +8350,11 @@ public virtual Task> SearchAsync(Cancellati } /// - /// Returns search hits that match the query defined in the request.
You can provide search queries using the `q` query string parameter or the request body.
If both are specified, only the query parameter is used. + /// + /// Returns search hits that match the query defined in the request. + /// You can provide search queries using the q query string parameter or the request body. + /// If both are specified, only the query parameter is used. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -6680,7 +8366,10 @@ public virtual Task> SearchAsync(Action - /// Search a vector tile.
Searches a vector tile for geospatial values. + /// + /// Search a vector tile. + /// Searches a vector tile for geospatial values. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6691,7 +8380,10 @@ public virtual SearchMvtResponse SearchMvt(SearchMvtRequest request) } /// - /// Search a vector tile.
Searches a vector tile for geospatial values. + /// + /// Search a vector tile. + /// Searches a vector tile for geospatial values. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SearchMvtAsync(SearchMvtRequest request, CancellationToken cancellationToken = default) @@ -6701,7 +8393,10 @@ public virtual Task SearchMvtAsync(SearchMvtRequest request, } /// - /// Search a vector tile.
Searches a vector tile for geospatial values. + /// + /// Search a vector tile. + /// Searches a vector tile for geospatial values. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6712,7 +8407,10 @@ public virtual SearchMvtResponse SearchMvt(SearchMvtRequestDescriptor } /// - /// Search a vector tile.
Searches a vector tile for geospatial values. + /// + /// Search a vector tile. + /// Searches a vector tile for geospatial values. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6724,7 +8422,10 @@ public virtual SearchMvtResponse SearchMvt(Elastic.Clients.Elasticsea } /// - /// Search a vector tile.
Searches a vector tile for geospatial values. + /// + /// Search a vector tile. + /// Searches a vector tile for geospatial values. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6737,7 +8438,10 @@ public virtual SearchMvtResponse SearchMvt(Elastic.Clients.Elasticsea } /// - /// Search a vector tile.
Searches a vector tile for geospatial values. + /// + /// Search a vector tile. + /// Searches a vector tile for geospatial values. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6749,7 +8453,10 @@ public virtual SearchMvtResponse SearchMvt(Elastic.Clients.Elasticsea } /// - /// Search a vector tile.
Searches a vector tile for geospatial values. + /// + /// Search a vector tile. + /// Searches a vector tile for geospatial values. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6762,7 +8469,10 @@ public virtual SearchMvtResponse SearchMvt(Elastic.Clients.Elasticsea } /// - /// Search a vector tile.
Searches a vector tile for geospatial values. + /// + /// Search a vector tile. + /// Searches a vector tile for geospatial values. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6773,7 +8483,10 @@ public virtual SearchMvtResponse SearchMvt(SearchMvtRequestDescriptor descriptor } /// - /// Search a vector tile.
Searches a vector tile for geospatial values. + /// + /// Search a vector tile. + /// Searches a vector tile for geospatial values. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6785,7 +8498,10 @@ public virtual SearchMvtResponse SearchMvt(Elastic.Clients.Elasticsearch.Indices } /// - /// Search a vector tile.
Searches a vector tile for geospatial values. + /// + /// Search a vector tile. + /// Searches a vector tile for geospatial values. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6798,7 +8514,10 @@ public virtual SearchMvtResponse SearchMvt(Elastic.Clients.Elasticsearch.Indices } /// - /// Search a vector tile.
Searches a vector tile for geospatial values. + /// + /// Search a vector tile. + /// Searches a vector tile for geospatial values. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SearchMvtAsync(SearchMvtRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6808,7 +8527,10 @@ public virtual Task SearchMvtAsync(SearchMvtReques } /// - /// Search a vector tile.
Searches a vector tile for geospatial values. + /// + /// Search a vector tile. + /// Searches a vector tile for geospatial values. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SearchMvtAsync(Elastic.Clients.Elasticsearch.Indices indices, Elastic.Clients.Elasticsearch.Field field, int zoom, int x, int y, CancellationToken cancellationToken = default) @@ -6819,7 +8541,10 @@ public virtual Task SearchMvtAsync(Elastic.Clients } /// - /// Search a vector tile.
Searches a vector tile for geospatial values. + /// + /// Search a vector tile. + /// Searches a vector tile for geospatial values. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SearchMvtAsync(Elastic.Clients.Elasticsearch.Indices indices, Elastic.Clients.Elasticsearch.Field field, int zoom, int x, int y, Action> configureRequest, CancellationToken cancellationToken = default) @@ -6831,7 +8556,10 @@ public virtual Task SearchMvtAsync(Elastic.Clients } /// - /// Search a vector tile.
Searches a vector tile for geospatial values. + /// + /// Search a vector tile. + /// Searches a vector tile for geospatial values. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SearchMvtAsync(Elastic.Clients.Elasticsearch.Field field, int zoom, int x, int y, CancellationToken cancellationToken = default) @@ -6842,7 +8570,10 @@ public virtual Task SearchMvtAsync(Elastic.Clients } /// - /// Search a vector tile.
Searches a vector tile for geospatial values. + /// + /// Search a vector tile. + /// Searches a vector tile for geospatial values. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SearchMvtAsync(Elastic.Clients.Elasticsearch.Field field, int zoom, int x, int y, Action> configureRequest, CancellationToken cancellationToken = default) @@ -6854,7 +8585,10 @@ public virtual Task SearchMvtAsync(Elastic.Clients } /// - /// Search a vector tile.
Searches a vector tile for geospatial values. + /// + /// Search a vector tile. + /// Searches a vector tile for geospatial values. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SearchMvtAsync(SearchMvtRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -6864,7 +8598,10 @@ public virtual Task SearchMvtAsync(SearchMvtRequestDescriptor } /// - /// Search a vector tile.
Searches a vector tile for geospatial values. + /// + /// Search a vector tile. + /// Searches a vector tile for geospatial values. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SearchMvtAsync(Elastic.Clients.Elasticsearch.Indices indices, Elastic.Clients.Elasticsearch.Field field, int zoom, int x, int y, CancellationToken cancellationToken = default) @@ -6875,7 +8612,10 @@ public virtual Task SearchMvtAsync(Elastic.Clients.Elasticsea } /// - /// Search a vector tile.
Searches a vector tile for geospatial values. + /// + /// Search a vector tile. + /// Searches a vector tile for geospatial values. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SearchMvtAsync(Elastic.Clients.Elasticsearch.Indices indices, Elastic.Clients.Elasticsearch.Field field, int zoom, int x, int y, Action configureRequest, CancellationToken cancellationToken = default) @@ -6887,7 +8627,9 @@ public virtual Task SearchMvtAsync(Elastic.Clients.Elasticsea } /// - /// Returns information about the indices and shards that a search request would be executed against. + /// + /// Returns information about the indices and shards that a search request would be executed against. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6898,7 +8640,9 @@ public virtual SearchShardsResponse SearchShards(SearchShardsRequest request) } /// - /// Returns information about the indices and shards that a search request would be executed against. + /// + /// Returns information about the indices and shards that a search request would be executed against. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SearchShardsAsync(SearchShardsRequest request, CancellationToken cancellationToken = default) @@ -6908,7 +8652,9 @@ public virtual Task SearchShardsAsync(SearchShardsRequest } /// - /// Returns information about the indices and shards that a search request would be executed against. + /// + /// Returns information about the indices and shards that a search request would be executed against. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6919,7 +8665,9 @@ public virtual SearchShardsResponse SearchShards(SearchShardsRequestD } /// - /// Returns information about the indices and shards that a search request would be executed against. + /// + /// Returns information about the indices and shards that a search request would be executed against. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6931,7 +8679,9 @@ public virtual SearchShardsResponse SearchShards(Elastic.Clients.Elas } /// - /// Returns information about the indices and shards that a search request would be executed against. + /// + /// Returns information about the indices and shards that a search request would be executed against. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6944,7 +8694,9 @@ public virtual SearchShardsResponse SearchShards(Elastic.Clients.Elas } /// - /// Returns information about the indices and shards that a search request would be executed against. + /// + /// Returns information about the indices and shards that a search request would be executed against. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6956,7 +8708,9 @@ public virtual SearchShardsResponse SearchShards() } /// - /// Returns information about the indices and shards that a search request would be executed against. + /// + /// Returns information about the indices and shards that a search request would be executed against. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6969,7 +8723,9 @@ public virtual SearchShardsResponse SearchShards(Action - /// Returns information about the indices and shards that a search request would be executed against. + /// + /// Returns information about the indices and shards that a search request would be executed against. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6980,7 +8736,9 @@ public virtual SearchShardsResponse SearchShards(SearchShardsRequestDescriptor d } /// - /// Returns information about the indices and shards that a search request would be executed against. + /// + /// Returns information about the indices and shards that a search request would be executed against. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -6992,7 +8750,9 @@ public virtual SearchShardsResponse SearchShards(Elastic.Clients.Elasticsearch.I } /// - /// Returns information about the indices and shards that a search request would be executed against. + /// + /// Returns information about the indices and shards that a search request would be executed against. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7005,7 +8765,9 @@ public virtual SearchShardsResponse SearchShards(Elastic.Clients.Elasticsearch.I } /// - /// Returns information about the indices and shards that a search request would be executed against. + /// + /// Returns information about the indices and shards that a search request would be executed against. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7017,7 +8779,9 @@ public virtual SearchShardsResponse SearchShards() } /// - /// Returns information about the indices and shards that a search request would be executed against. + /// + /// Returns information about the indices and shards that a search request would be executed against. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7030,7 +8794,9 @@ public virtual SearchShardsResponse SearchShards(Action - /// Returns information about the indices and shards that a search request would be executed against. + /// + /// Returns information about the indices and shards that a search request would be executed against. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SearchShardsAsync(SearchShardsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -7040,7 +8806,9 @@ public virtual Task SearchShardsAsync(SearchSha } /// - /// Returns information about the indices and shards that a search request would be executed against. + /// + /// Returns information about the indices and shards that a search request would be executed against. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SearchShardsAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -7051,7 +8819,9 @@ public virtual Task SearchShardsAsync(Elastic.C } /// - /// Returns information about the indices and shards that a search request would be executed against. + /// + /// Returns information about the indices and shards that a search request would be executed against. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SearchShardsAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -7063,7 +8833,9 @@ public virtual Task SearchShardsAsync(Elastic.C } /// - /// Returns information about the indices and shards that a search request would be executed against. + /// + /// Returns information about the indices and shards that a search request would be executed against. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SearchShardsAsync(CancellationToken cancellationToken = default) @@ -7074,7 +8846,9 @@ public virtual Task SearchShardsAsync(Cancellat } /// - /// Returns information about the indices and shards that a search request would be executed against. + /// + /// Returns information about the indices and shards that a search request would be executed against. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SearchShardsAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -7086,7 +8860,9 @@ public virtual Task SearchShardsAsync(Action - /// Returns information about the indices and shards that a search request would be executed against. + /// + /// Returns information about the indices and shards that a search request would be executed against. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SearchShardsAsync(SearchShardsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -7096,7 +8872,9 @@ public virtual Task SearchShardsAsync(SearchShardsRequestD } /// - /// Returns information about the indices and shards that a search request would be executed against. + /// + /// Returns information about the indices and shards that a search request would be executed against. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SearchShardsAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -7107,7 +8885,9 @@ public virtual Task SearchShardsAsync(Elastic.Clients.Elas } /// - /// Returns information about the indices and shards that a search request would be executed against. + /// + /// Returns information about the indices and shards that a search request would be executed against. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SearchShardsAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -7119,7 +8899,9 @@ public virtual Task SearchShardsAsync(Elastic.Clients.Elas } /// - /// Returns information about the indices and shards that a search request would be executed against. + /// + /// Returns information about the indices and shards that a search request would be executed against. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SearchShardsAsync(CancellationToken cancellationToken = default) @@ -7130,7 +8912,9 @@ public virtual Task SearchShardsAsync(CancellationToken ca } /// - /// Returns information about the indices and shards that a search request would be executed against. + /// + /// Returns information about the indices and shards that a search request would be executed against. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SearchShardsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -7142,7 +8926,9 @@ public virtual Task SearchShardsAsync(Action - /// Runs a search with a search template. + /// + /// Runs a search with a search template. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7153,7 +8939,9 @@ public virtual SearchTemplateResponse SearchTemplate(Searc } /// - /// Runs a search with a search template. + /// + /// Runs a search with a search template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchTemplateAsync(SearchTemplateRequest request, CancellationToken cancellationToken = default) @@ -7163,7 +8951,9 @@ public virtual Task> SearchTemplateAsync - /// Runs a search with a search template. + /// + /// Runs a search with a search template. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7174,7 +8964,9 @@ public virtual SearchTemplateResponse SearchTemplate(Searc } /// - /// Runs a search with a search template. + /// + /// Runs a search with a search template. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7186,7 +8978,9 @@ public virtual SearchTemplateResponse SearchTemplate(Elast } /// - /// Runs a search with a search template. + /// + /// Runs a search with a search template. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7199,7 +8993,9 @@ public virtual SearchTemplateResponse SearchTemplate(Elast } /// - /// Runs a search with a search template. + /// + /// Runs a search with a search template. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7211,7 +9007,9 @@ public virtual SearchTemplateResponse SearchTemplate() } /// - /// Runs a search with a search template. + /// + /// Runs a search with a search template. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7224,7 +9022,9 @@ public virtual SearchTemplateResponse SearchTemplate(Actio } /// - /// Runs a search with a search template. + /// + /// Runs a search with a search template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchTemplateAsync(SearchTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -7234,7 +9034,9 @@ public virtual Task> SearchTemplateAsync - /// Runs a search with a search template. + /// + /// Runs a search with a search template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchTemplateAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) @@ -7245,7 +9047,9 @@ public virtual Task> SearchTemplateAsync - /// Runs a search with a search template. + /// + /// Runs a search with a search template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchTemplateAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -7257,7 +9061,9 @@ public virtual Task> SearchTemplateAsync - /// Runs a search with a search template. + /// + /// Runs a search with a search template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchTemplateAsync(CancellationToken cancellationToken = default) @@ -7268,7 +9074,9 @@ public virtual Task> SearchTemplateAsync - /// Runs a search with a search template. + /// + /// Runs a search with a search template. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SearchTemplateAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -7280,7 +9088,9 @@ public virtual Task> SearchTemplateAsync - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7291,7 +9101,9 @@ public virtual TermsEnumResponse TermsEnum(TermsEnumRequest request) } /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermsEnumAsync(TermsEnumRequest request, CancellationToken cancellationToken = default) @@ -7301,7 +9113,9 @@ public virtual Task TermsEnumAsync(TermsEnumRequest request, } /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7312,7 +9126,9 @@ public virtual TermsEnumResponse TermsEnum(TermsEnumRequestDescriptor } /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7324,7 +9140,9 @@ public virtual TermsEnumResponse TermsEnum(Elastic.Clients.Elasticsea } /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7337,7 +9155,9 @@ public virtual TermsEnumResponse TermsEnum(Elastic.Clients.Elasticsea } /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7349,7 +9169,9 @@ public virtual TermsEnumResponse TermsEnum() } /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7362,7 +9184,9 @@ public virtual TermsEnumResponse TermsEnum(Action - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7373,7 +9197,9 @@ public virtual TermsEnumResponse TermsEnum(TermsEnumRequestDescriptor descriptor } /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7385,7 +9211,9 @@ public virtual TermsEnumResponse TermsEnum(Elastic.Clients.Elasticsearch.IndexNa } /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7398,7 +9226,9 @@ public virtual TermsEnumResponse TermsEnum(Elastic.Clients.Elasticsearch.IndexNa } /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermsEnumAsync(TermsEnumRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -7408,7 +9238,9 @@ public virtual Task TermsEnumAsync(TermsEnumReques } /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermsEnumAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -7419,7 +9251,9 @@ public virtual Task TermsEnumAsync(Elastic.Clients } /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermsEnumAsync(Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -7431,7 +9265,9 @@ public virtual Task TermsEnumAsync(Elastic.Clients } /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermsEnumAsync(CancellationToken cancellationToken = default) @@ -7442,7 +9278,9 @@ public virtual Task TermsEnumAsync(CancellationTok } /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermsEnumAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -7454,7 +9292,9 @@ public virtual Task TermsEnumAsync(Action - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermsEnumAsync(TermsEnumRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -7464,7 +9304,9 @@ public virtual Task TermsEnumAsync(TermsEnumRequestDescriptor } /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermsEnumAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -7475,7 +9317,9 @@ public virtual Task TermsEnumAsync(Elastic.Clients.Elasticsea } /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermsEnumAsync(Elastic.Clients.Elasticsearch.IndexName index, Action configureRequest, CancellationToken cancellationToken = default) @@ -7487,7 +9331,10 @@ public virtual Task TermsEnumAsync(Elastic.Clients.Elasticsea } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7498,7 +9345,10 @@ public virtual TermVectorsResponse Termvectors(TermVectorsRequest - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermvectorsAsync(TermVectorsRequest request, CancellationToken cancellationToken = default) @@ -7508,7 +9358,10 @@ public virtual Task TermvectorsAsync(TermVectors } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7519,7 +9372,10 @@ public virtual TermVectorsResponse Termvectors(TermVectorsRequestDesc } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7531,7 +9387,10 @@ public virtual TermVectorsResponse Termvectors(Elastic.Clients.Elasti } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7544,7 +9403,10 @@ public virtual TermVectorsResponse Termvectors(Elastic.Clients.Elasti } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7556,7 +9418,10 @@ public virtual TermVectorsResponse Termvectors(Elastic.Clients.Elasti } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7569,7 +9434,10 @@ public virtual TermVectorsResponse Termvectors(Elastic.Clients.Elasti } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7581,7 +9449,10 @@ public virtual TermVectorsResponse Termvectors(TDocument document) } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7594,7 +9465,10 @@ public virtual TermVectorsResponse Termvectors(TDocument document, Ac } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7606,7 +9480,10 @@ public virtual TermVectorsResponse Termvectors(TDocument document, El } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7619,7 +9496,10 @@ public virtual TermVectorsResponse Termvectors(TDocument document, El } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7631,7 +9511,10 @@ public virtual TermVectorsResponse Termvectors(TDocument document, El } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7644,7 +9527,10 @@ public virtual TermVectorsResponse Termvectors(TDocument document, El } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7656,7 +9542,10 @@ public virtual TermVectorsResponse Termvectors(Elastic.Clients.Elasti } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7669,7 +9558,10 @@ public virtual TermVectorsResponse Termvectors(Elastic.Clients.Elasti } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermvectorsAsync(TermVectorsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -7679,7 +9571,10 @@ public virtual Task TermvectorsAsync(TermVectors } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermvectorsAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Id? id, CancellationToken cancellationToken = default) @@ -7690,7 +9585,10 @@ public virtual Task TermvectorsAsync(Elastic.Cli } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermvectorsAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Id? id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -7702,7 +9600,10 @@ public virtual Task TermvectorsAsync(Elastic.Cli } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermvectorsAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -7713,7 +9614,10 @@ public virtual Task TermvectorsAsync(Elastic.Cli } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermvectorsAsync(Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -7725,7 +9629,10 @@ public virtual Task TermvectorsAsync(Elastic.Cli } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermvectorsAsync(TDocument document, CancellationToken cancellationToken = default) @@ -7736,7 +9643,10 @@ public virtual Task TermvectorsAsync(TDocument d } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermvectorsAsync(TDocument document, Action> configureRequest, CancellationToken cancellationToken = default) @@ -7748,7 +9658,10 @@ public virtual Task TermvectorsAsync(TDocument d } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermvectorsAsync(TDocument document, Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -7759,7 +9672,10 @@ public virtual Task TermvectorsAsync(TDocument d } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermvectorsAsync(TDocument document, Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -7771,7 +9687,10 @@ public virtual Task TermvectorsAsync(TDocument d } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermvectorsAsync(TDocument document, Elastic.Clients.Elasticsearch.Id? id, CancellationToken cancellationToken = default) @@ -7782,7 +9701,10 @@ public virtual Task TermvectorsAsync(TDocument d } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermvectorsAsync(TDocument document, Elastic.Clients.Elasticsearch.Id? id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -7794,7 +9716,10 @@ public virtual Task TermvectorsAsync(TDocument d } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermvectorsAsync(Elastic.Clients.Elasticsearch.Id? id, CancellationToken cancellationToken = default) @@ -7805,7 +9730,10 @@ public virtual Task TermvectorsAsync(Elastic.Cli } /// - /// Get term vector information.
Returns information and statistics about terms in the fields of a particular document. + /// + /// Get term vector information. + /// Returns information and statistics about terms in the fields of a particular document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task TermvectorsAsync(Elastic.Clients.Elasticsearch.Id? id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -7817,7 +9745,10 @@ public virtual Task TermvectorsAsync(Elastic.Cli } /// - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7828,7 +9759,10 @@ public virtual UpdateResponse Update(Upd } /// - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> UpdateAsync(UpdateRequest request, CancellationToken cancellationToken = default) @@ -7838,7 +9772,10 @@ public virtual Task> UpdateAsync - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7849,7 +9786,10 @@ public virtual UpdateResponse Update(Upd } /// - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7861,7 +9801,10 @@ public virtual UpdateResponse Update(Ela } /// - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7874,7 +9817,10 @@ public virtual UpdateResponse Update(Ela } /// - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7886,7 +9832,10 @@ public virtual UpdateResponse Update(TDo } /// - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7899,7 +9848,10 @@ public virtual UpdateResponse Update(TDo } /// - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7911,7 +9863,10 @@ public virtual UpdateResponse Update(TDo } /// - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7924,7 +9879,10 @@ public virtual UpdateResponse Update(TDo } /// - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7936,7 +9894,10 @@ public virtual UpdateResponse Update(TDo } /// - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7949,7 +9910,10 @@ public virtual UpdateResponse Update(TDo } /// - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7961,7 +9925,10 @@ public virtual UpdateResponse Update(Ela } /// - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -7974,7 +9941,10 @@ public virtual UpdateResponse Update(Ela } /// - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> UpdateAsync(UpdateRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -7984,7 +9954,10 @@ public virtual Task> UpdateAsync - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> UpdateAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -7995,7 +9968,10 @@ public virtual Task> UpdateAsync - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> UpdateAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -8007,7 +9983,10 @@ public virtual Task> UpdateAsync - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> UpdateAsync(TDocument document, CancellationToken cancellationToken = default) @@ -8018,7 +9997,10 @@ public virtual Task> UpdateAsync - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> UpdateAsync(TDocument document, Action> configureRequest, CancellationToken cancellationToken = default) @@ -8030,7 +10012,10 @@ public virtual Task> UpdateAsync - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> UpdateAsync(TDocument document, Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) @@ -8041,7 +10026,10 @@ public virtual Task> UpdateAsync - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> UpdateAsync(TDocument document, Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -8053,7 +10041,10 @@ public virtual Task> UpdateAsync - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> UpdateAsync(TDocument document, Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -8064,7 +10055,10 @@ public virtual Task> UpdateAsync - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> UpdateAsync(TDocument document, Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -8076,7 +10070,10 @@ public virtual Task> UpdateAsync - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> UpdateAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -8087,7 +10084,10 @@ public virtual Task> UpdateAsync - /// Update a document.
Updates a document by running a script or passing a partial document. + /// + /// Update a document. + /// Updates a document by running a script or passing a partial document. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> UpdateAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -8099,7 +10099,11 @@ public virtual Task> UpdateAsync - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8110,7 +10114,11 @@ public virtual 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateByQueryAsync(UpdateByQueryRequest request, CancellationToken cancellationToken = default) @@ -8120,7 +10128,11 @@ public virtual Task UpdateByQueryAsync(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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8131,7 +10143,11 @@ public virtual UpdateByQueryResponse 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8143,7 +10159,11 @@ public virtual UpdateByQueryResponse UpdateByQuery(Elastic.Clients.El } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8156,7 +10176,11 @@ public virtual UpdateByQueryResponse UpdateByQuery(Elastic.Clients.El } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8168,7 +10192,11 @@ public virtual UpdateByQueryResponse UpdateByQuery() } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8181,7 +10209,11 @@ public virtual UpdateByQueryResponse UpdateByQuery(Action - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8192,7 +10224,11 @@ public virtual UpdateByQueryResponse UpdateByQuery(UpdateByQueryRequestDescripto } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8204,7 +10240,11 @@ public virtual UpdateByQueryResponse UpdateByQuery(Elastic.Clients.Elasticsearch } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8217,7 +10257,11 @@ public virtual UpdateByQueryResponse UpdateByQuery(Elastic.Clients.Elasticsearch } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateByQueryAsync(UpdateByQueryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -8227,7 +10271,11 @@ public virtual Task UpdateByQueryAsync(UpdateB } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateByQueryAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -8238,7 +10286,11 @@ public virtual Task UpdateByQueryAsync(Elastic } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateByQueryAsync(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) @@ -8250,7 +10302,11 @@ public virtual Task UpdateByQueryAsync(Elastic } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateByQueryAsync(CancellationToken cancellationToken = default) @@ -8261,7 +10317,11 @@ public virtual Task UpdateByQueryAsync(Cancell } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateByQueryAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -8273,7 +10333,11 @@ public virtual Task UpdateByQueryAsync(Action< } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateByQueryAsync(UpdateByQueryRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -8283,7 +10347,11 @@ public virtual Task UpdateByQueryAsync(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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateByQueryAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) @@ -8294,7 +10362,11 @@ public virtual Task UpdateByQueryAsync(Elastic.Clients.El } /// - /// 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. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateByQueryAsync(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) @@ -8306,7 +10378,9 @@ public virtual Task UpdateByQueryAsync(Elastic.Clients.El } /// - /// Changes the number of requests per second for a particular Update By Query operation. + /// + /// Changes the number of requests per second for a particular Update By Query operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8317,7 +10391,9 @@ public virtual UpdateByQueryRethrottleResponse UpdateByQueryRethrottle(UpdateByQ } /// - /// Changes the number of requests per second for a particular Update By Query operation. + /// + /// Changes the number of requests per second for a particular Update By Query operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateByQueryRethrottleAsync(UpdateByQueryRethrottleRequest request, CancellationToken cancellationToken = default) @@ -8327,7 +10403,9 @@ public virtual Task UpdateByQueryRethrottleAsyn } /// - /// Changes the number of requests per second for a particular Update By Query operation. + /// + /// Changes the number of requests per second for a particular Update By Query operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8338,7 +10416,9 @@ public virtual UpdateByQueryRethrottleResponse UpdateByQueryRethrottle(UpdateByQ } /// - /// Changes the number of requests per second for a particular Update By Query operation. + /// + /// Changes the number of requests per second for a particular Update By Query operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8350,7 +10430,9 @@ public virtual UpdateByQueryRethrottleResponse UpdateByQueryRethrottle(Elastic.C } /// - /// Changes the number of requests per second for a particular Update By Query operation. + /// + /// Changes the number of requests per second for a particular Update By Query operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -8363,7 +10445,9 @@ public virtual UpdateByQueryRethrottleResponse UpdateByQueryRethrottle(Elastic.C } /// - /// Changes the number of requests per second for a particular Update By Query operation. + /// + /// Changes the number of requests per second for a particular Update By Query operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateByQueryRethrottleAsync(UpdateByQueryRethrottleRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -8373,7 +10457,9 @@ public virtual Task UpdateByQueryRethrottleAsyn } /// - /// Changes the number of requests per second for a particular Update By Query operation. + /// + /// Changes the number of requests per second for a particular Update By Query operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateByQueryRethrottleAsync(Elastic.Clients.Elasticsearch.Id taskId, CancellationToken cancellationToken = default) @@ -8384,7 +10470,9 @@ public virtual Task UpdateByQueryRethrottleAsyn } /// - /// Changes the number of requests per second for a particular Update By Query operation. + /// + /// Changes the number of requests per second for a particular Update By Query operation. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UpdateByQueryRethrottleAsync(Elastic.Clients.Elasticsearch.Id taskId, Action configureRequest, CancellationToken cancellationToken = default) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AdjacencyMatrixAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AdjacencyMatrixAggregation.g.cs index 096a966d9d0..b4eb14cefbe 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AdjacencyMatrixAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AdjacencyMatrixAggregation.g.cs @@ -30,13 +30,18 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class AdjacencyMatrixAggregation { /// - /// Filters used to create buckets.
At least one filter is required. + /// + /// Filters used to create buckets. + /// At least one filter is required. + /// /// [JsonInclude, JsonPropertyName("filters")] public IDictionary? Filters { get; set; } /// - /// Separator used to concatenate filter names. Defaults to &. + /// + /// Separator used to concatenate filter names. Defaults to &. + /// /// [JsonInclude, JsonPropertyName("separator")] public string? Separator { get; set; } @@ -56,7 +61,10 @@ public AdjacencyMatrixAggregationDescriptor() : base() private string? SeparatorValue { get; set; } /// - /// Filters used to create buckets.
At least one filter is required. + /// + /// Filters used to create buckets. + /// At least one filter is required. + /// /// public AdjacencyMatrixAggregationDescriptor Filters(Func>, FluentDescriptorDictionary>> selector) { @@ -65,7 +73,9 @@ public AdjacencyMatrixAggregationDescriptor Filters(Func - /// Separator used to concatenate filter names. Defaults to &. + /// + /// Separator used to concatenate filter names. Defaults to &. + /// /// public AdjacencyMatrixAggregationDescriptor Separator(string? separator) { @@ -104,7 +114,10 @@ public AdjacencyMatrixAggregationDescriptor() : base() private string? SeparatorValue { get; set; } /// - /// Filters used to create buckets.
At least one filter is required. + /// + /// Filters used to create buckets. + /// At least one filter is required. + /// /// public AdjacencyMatrixAggregationDescriptor Filters(Func, FluentDescriptorDictionary> selector) { @@ -113,7 +126,9 @@ public AdjacencyMatrixAggregationDescriptor Filters(Func - /// Separator used to concatenate filter names. Defaults to &. + /// + /// Separator used to concatenate filter names. Defaults to &. + /// /// public AdjacencyMatrixAggregationDescriptor Separator(string? separator) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AdjacencyMatrixBucket.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AdjacencyMatrixBucket.g.cs index ef4d7576b8b..f238c0e248c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AdjacencyMatrixBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AdjacencyMatrixBucket.g.cs @@ -77,7 +77,9 @@ public override void Write(Utf8JsonWriter writer, AdjacencyMatrixBucket value, J public sealed partial class AdjacencyMatrixBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/Aggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/Aggregation.g.cs index 67154d8caa9..e6aae808b89 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/Aggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/Aggregation.g.cs @@ -123,7 +123,10 @@ internal Aggregation(string variantName, object variant) public static Aggregation WeightedAvg(Elastic.Clients.Elasticsearch.Aggregations.WeightedAverageAggregation weightedAverageAggregation) => new Aggregation("weighted_avg", weightedAverageAggregation); /// - /// Sub-aggregations for this aggregation.
Only applies to bucket aggregations. + /// + /// Sub-aggregations for this aggregation. + /// Only applies to bucket aggregations. + /// /// [JsonInclude, JsonPropertyName("aggregations")] public IDictionary? Aggregations { get; set; } @@ -1003,7 +1006,10 @@ private AggregationDescriptor Set(object variant, string variantName) private IDictionary? MetaValue { get; set; } /// - /// Sub-aggregations for this aggregation.
Only applies to bucket aggregations. + /// + /// Sub-aggregations for this aggregation. + /// Only applies to bucket aggregations. + /// /// public AggregationDescriptor Aggregations(Func>, FluentDescriptorDictionary>> selector) { @@ -1235,7 +1241,10 @@ private AggregationDescriptor Set(object variant, string variantName) private IDictionary? MetaValue { get; set; } /// - /// Sub-aggregations for this aggregation.
Only applies to bucket aggregations. + /// + /// Sub-aggregations for this aggregation. + /// Only applies to bucket aggregations. + /// /// public AggregationDescriptor Aggregations(Func, FluentDescriptorDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AggregationRange.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AggregationRange.g.cs index 882f5c1ef9b..7ecc60c320f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AggregationRange.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AggregationRange.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class AggregationRange { /// - /// Start of the range (inclusive). + /// + /// Start of the range (inclusive). + /// /// [JsonInclude, JsonPropertyName("from")] public double? From { get; set; } /// - /// Custom key to return the range with. + /// + /// Custom key to return the range with. + /// /// [JsonInclude, JsonPropertyName("key")] public string? Key { get; set; } /// - /// End of the range (exclusive). + /// + /// End of the range (exclusive). + /// /// [JsonInclude, JsonPropertyName("to")] public double? To { get; set; } @@ -61,7 +67,9 @@ public AggregationRangeDescriptor() : base() private double? ToValue { get; set; } /// - /// Start of the range (inclusive). + /// + /// Start of the range (inclusive). + /// /// public AggregationRangeDescriptor From(double? from) { @@ -70,7 +78,9 @@ public AggregationRangeDescriptor From(double? from) } /// - /// Custom key to return the range with. + /// + /// Custom key to return the range with. + /// /// public AggregationRangeDescriptor Key(string? key) { @@ -79,7 +89,9 @@ public AggregationRangeDescriptor Key(string? key) } /// - /// End of the range (exclusive). + /// + /// End of the range (exclusive). + /// /// public AggregationRangeDescriptor To(double? to) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AutoDateHistogramAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AutoDateHistogramAggregation.g.cs index b6ba180ea7a..75840287e84 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AutoDateHistogramAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AutoDateHistogramAggregation.g.cs @@ -30,37 +30,52 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class AutoDateHistogramAggregation { /// - /// The target number of buckets. + /// + /// The target number of buckets. + /// /// [JsonInclude, JsonPropertyName("buckets")] public int? Buckets { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } /// - /// The date format used to format `key_as_string` in the response.
If no `format` is specified, the first date format specified in the field mapping is used. + /// + /// The date format used to format key_as_string in the response. + /// If no format is specified, the first date format specified in the field mapping is used. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// The minimum rounding interval.
This can make the collection process more efficient, as the aggregation will not attempt to round at any interval lower than `minimum_interval`. + /// + /// The minimum rounding interval. + /// This can make the collection process more efficient, as the aggregation will not attempt to round at any interval lower than minimum_interval. + /// /// [JsonInclude, JsonPropertyName("minimum_interval")] public Elastic.Clients.Elasticsearch.Aggregations.MinimumInterval? MinimumInterval { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public DateTimeOffset? Missing { get; set; } /// - /// Time zone specified as a ISO 8601 UTC offset. + /// + /// Time zone specified as a ISO 8601 UTC offset. + /// /// [JsonInclude, JsonPropertyName("offset")] public string? Offset { get; set; } @@ -70,7 +85,9 @@ public sealed partial class AutoDateHistogramAggregation public Elastic.Clients.Elasticsearch.Script? Script { get; set; } /// - /// Time zone ID. + /// + /// Time zone ID. + /// /// [JsonInclude, JsonPropertyName("time_zone")] public string? TimeZone { get; set; } @@ -99,7 +116,9 @@ public AutoDateHistogramAggregationDescriptor() : base() private string? TimeZoneValue { get; set; } /// - /// The target number of buckets. + /// + /// The target number of buckets. + /// /// public AutoDateHistogramAggregationDescriptor Buckets(int? buckets) { @@ -108,7 +127,9 @@ public AutoDateHistogramAggregationDescriptor Buckets(int? buckets) } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public AutoDateHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -117,7 +138,9 @@ public AutoDateHistogramAggregationDescriptor Field(Elastic.Clients.E } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public AutoDateHistogramAggregationDescriptor Field(Expression> field) { @@ -126,7 +149,9 @@ public AutoDateHistogramAggregationDescriptor Field(Expressio } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public AutoDateHistogramAggregationDescriptor Field(Expression> field) { @@ -135,7 +160,10 @@ public AutoDateHistogramAggregationDescriptor Field(Expression - /// The date format used to format `key_as_string` in the response.
If no `format` is specified, the first date format specified in the field mapping is used. + /// + /// The date format used to format key_as_string in the response. + /// If no format is specified, the first date format specified in the field mapping is used. + /// /// public AutoDateHistogramAggregationDescriptor Format(string? format) { @@ -144,7 +172,10 @@ public AutoDateHistogramAggregationDescriptor Format(string? format) } /// - /// The minimum rounding interval.
This can make the collection process more efficient, as the aggregation will not attempt to round at any interval lower than `minimum_interval`. + /// + /// The minimum rounding interval. + /// This can make the collection process more efficient, as the aggregation will not attempt to round at any interval lower than minimum_interval. + /// /// public AutoDateHistogramAggregationDescriptor MinimumInterval(Elastic.Clients.Elasticsearch.Aggregations.MinimumInterval? minimumInterval) { @@ -153,7 +184,10 @@ public AutoDateHistogramAggregationDescriptor MinimumInterval(Elastic } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public AutoDateHistogramAggregationDescriptor Missing(DateTimeOffset? missing) { @@ -162,7 +196,9 @@ public AutoDateHistogramAggregationDescriptor Missing(DateTimeOffset? } /// - /// Time zone specified as a ISO 8601 UTC offset. + /// + /// Time zone specified as a ISO 8601 UTC offset. + /// /// public AutoDateHistogramAggregationDescriptor Offset(string? offset) { @@ -201,7 +237,9 @@ public AutoDateHistogramAggregationDescriptor Script(Action - /// Time zone ID. + /// + /// Time zone ID. + /// /// public AutoDateHistogramAggregationDescriptor TimeZone(string? timeZone) { @@ -301,7 +339,9 @@ public AutoDateHistogramAggregationDescriptor() : base() private string? TimeZoneValue { get; set; } /// - /// The target number of buckets. + /// + /// The target number of buckets. + /// /// public AutoDateHistogramAggregationDescriptor Buckets(int? buckets) { @@ -310,7 +350,9 @@ public AutoDateHistogramAggregationDescriptor Buckets(int? buckets) } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public AutoDateHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -319,7 +361,9 @@ public AutoDateHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearc } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public AutoDateHistogramAggregationDescriptor Field(Expression> field) { @@ -328,7 +372,9 @@ public AutoDateHistogramAggregationDescriptor Field(Expressio } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public AutoDateHistogramAggregationDescriptor Field(Expression> field) { @@ -337,7 +383,10 @@ public AutoDateHistogramAggregationDescriptor Field(Expression - /// The date format used to format `key_as_string` in the response.
If no `format` is specified, the first date format specified in the field mapping is used. + /// + /// The date format used to format key_as_string in the response. + /// If no format is specified, the first date format specified in the field mapping is used. + /// /// public AutoDateHistogramAggregationDescriptor Format(string? format) { @@ -346,7 +395,10 @@ public AutoDateHistogramAggregationDescriptor Format(string? format) } /// - /// The minimum rounding interval.
This can make the collection process more efficient, as the aggregation will not attempt to round at any interval lower than `minimum_interval`. + /// + /// The minimum rounding interval. + /// This can make the collection process more efficient, as the aggregation will not attempt to round at any interval lower than minimum_interval. + /// /// public AutoDateHistogramAggregationDescriptor MinimumInterval(Elastic.Clients.Elasticsearch.Aggregations.MinimumInterval? minimumInterval) { @@ -355,7 +407,10 @@ public AutoDateHistogramAggregationDescriptor MinimumInterval(Elastic.Clients.El } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public AutoDateHistogramAggregationDescriptor Missing(DateTimeOffset? missing) { @@ -364,7 +419,9 @@ public AutoDateHistogramAggregationDescriptor Missing(DateTimeOffset? missing) } /// - /// Time zone specified as a ISO 8601 UTC offset. + /// + /// Time zone specified as a ISO 8601 UTC offset. + /// /// public AutoDateHistogramAggregationDescriptor Offset(string? offset) { @@ -403,7 +460,9 @@ public AutoDateHistogramAggregationDescriptor Script(Action - /// Time zone ID. + /// + /// Time zone ID. + /// /// public AutoDateHistogramAggregationDescriptor TimeZone(string? timeZone) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AverageAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AverageAggregate.g.cs index ffc0f39d6c0..c143e3b2a1b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AverageAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AverageAggregate.g.cs @@ -33,7 +33,10 @@ public sealed partial class AverageAggregate : IAggregate public IReadOnlyDictionary? Meta { get; init; } /// - /// The metric value. A missing value generally means that there was no data to aggregate,
unless specified otherwise. + /// + /// The metric value. A missing value generally means that there was no data to aggregate, + /// unless specified otherwise. + /// /// [JsonInclude, JsonPropertyName("value")] public double? Value { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AverageAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AverageAggregation.g.cs index b24e7c43bc6..a07651b4526 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AverageAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AverageAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class AverageAggregation { /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } @@ -38,7 +40,10 @@ public sealed partial class AverageAggregation public string? Format { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.FieldValue? Missing { get; set; } @@ -64,7 +69,9 @@ public AverageAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public AverageAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -73,7 +80,9 @@ public AverageAggregationDescriptor Field(Elastic.Clients.Elasticsear } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public AverageAggregationDescriptor Field(Expression> field) { @@ -82,7 +91,9 @@ public AverageAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public AverageAggregationDescriptor Field(Expression> field) { @@ -97,7 +108,10 @@ public AverageAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public AverageAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -186,7 +200,9 @@ public AverageAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public AverageAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -195,7 +211,9 @@ public AverageAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? f } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public AverageAggregationDescriptor Field(Expression> field) { @@ -204,7 +222,9 @@ public AverageAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public AverageAggregationDescriptor Field(Expression> field) { @@ -219,7 +239,10 @@ public AverageAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public AverageAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AverageBucketAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AverageBucketAggregation.g.cs index 6034498a3ea..452c11ba9cf 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AverageBucketAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AverageBucketAggregation.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class AverageBucketAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? GapPolicy { get; set; } @@ -63,7 +70,9 @@ public AverageBucketAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? GapPolicyValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public AverageBucketAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? bucketsPath) { @@ -72,7 +81,10 @@ public AverageBucketAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsea } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public AverageBucketAggregationDescriptor Format(string? format) { @@ -81,7 +93,9 @@ public AverageBucketAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public AverageBucketAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? gapPolicy) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BoxplotAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BoxplotAggregation.g.cs index 2ff725f6139..b2d25b27e62 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BoxplotAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BoxplotAggregation.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class BoxplotAggregation { /// - /// Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. + /// + /// Limits the maximum number of nodes used by the underlying TDigest algorithm to 20 * compression, enabling control of memory usage and approximation error. + /// /// [JsonInclude, JsonPropertyName("compression")] public double? Compression { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.FieldValue? Missing { get; set; } @@ -68,7 +75,9 @@ public BoxplotAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. + /// + /// Limits the maximum number of nodes used by the underlying TDigest algorithm to 20 * compression, enabling control of memory usage and approximation error. + /// /// public BoxplotAggregationDescriptor Compression(double? compression) { @@ -77,7 +86,9 @@ public BoxplotAggregationDescriptor Compression(double? compression) } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public BoxplotAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -86,7 +97,9 @@ public BoxplotAggregationDescriptor Field(Elastic.Clients.Elasticsear } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public BoxplotAggregationDescriptor Field(Expression> field) { @@ -95,7 +108,9 @@ public BoxplotAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public BoxplotAggregationDescriptor Field(Expression> field) { @@ -104,7 +119,10 @@ public BoxplotAggregationDescriptor Field(Expression - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public BoxplotAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -193,7 +211,9 @@ public BoxplotAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. + /// + /// Limits the maximum number of nodes used by the underlying TDigest algorithm to 20 * compression, enabling control of memory usage and approximation error. + /// /// public BoxplotAggregationDescriptor Compression(double? compression) { @@ -202,7 +222,9 @@ public BoxplotAggregationDescriptor Compression(double? compression) } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public BoxplotAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -211,7 +233,9 @@ public BoxplotAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? f } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public BoxplotAggregationDescriptor Field(Expression> field) { @@ -220,7 +244,9 @@ public BoxplotAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public BoxplotAggregationDescriptor Field(Expression> field) { @@ -229,7 +255,10 @@ public BoxplotAggregationDescriptor Field(Expression - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public BoxplotAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketCorrelationAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketCorrelationAggregation.g.cs index 7b2858b619d..0a76c59d32a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketCorrelationAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketCorrelationAggregation.g.cs @@ -28,18 +28,24 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; /// -/// A sibling pipeline aggregation which executes a correlation function on the configured sibling multi-bucket aggregation. +/// +/// A sibling pipeline aggregation which executes a correlation function on the configured sibling multi-bucket aggregation. +/// /// public sealed partial class BucketCorrelationAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// The correlation function to execute. + /// + /// The correlation function to execute. + /// /// [JsonInclude, JsonPropertyName("function")] public Elastic.Clients.Elasticsearch.Aggregations.BucketCorrelationFunction Function { get; set; } @@ -48,7 +54,9 @@ public sealed partial class BucketCorrelationAggregation } /// -/// A sibling pipeline aggregation which executes a correlation function on the configured sibling multi-bucket aggregation. +/// +/// A sibling pipeline aggregation which executes a correlation function on the configured sibling multi-bucket aggregation. +/// /// public sealed partial class BucketCorrelationAggregationDescriptor : SerializableDescriptor { @@ -64,7 +72,9 @@ public BucketCorrelationAggregationDescriptor() : base() private Action FunctionDescriptorAction { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public BucketCorrelationAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? bucketsPath) { @@ -73,7 +83,9 @@ public BucketCorrelationAggregationDescriptor BucketsPath(Elastic.Clients.Elasti } /// - /// The correlation function to execute. + /// + /// The correlation function to execute. + /// /// public BucketCorrelationAggregationDescriptor Function(Elastic.Clients.Elasticsearch.Aggregations.BucketCorrelationFunction function) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketCorrelationFunction.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketCorrelationFunction.g.cs index 04da7a8c17f..a27215a8c96 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketCorrelationFunction.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketCorrelationFunction.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class BucketCorrelationFunction { /// - /// The configuration to calculate a count correlation. This function is designed for determining the correlation of a term value and a given metric. + /// + /// The configuration to calculate a count correlation. This function is designed for determining the correlation of a term value and a given metric. + /// /// [JsonInclude, JsonPropertyName("count_correlation")] public Elastic.Clients.Elasticsearch.Aggregations.BucketCorrelationFunctionCountCorrelation CountCorrelation { get; set; } @@ -49,7 +51,9 @@ public BucketCorrelationFunctionDescriptor() : base() private Action CountCorrelationDescriptorAction { get; set; } /// - /// The configuration to calculate a count correlation. This function is designed for determining the correlation of a term value and a given metric. + /// + /// The configuration to calculate a count correlation. This function is designed for determining the correlation of a term value and a given metric. + /// /// public BucketCorrelationFunctionDescriptor CountCorrelation(Elastic.Clients.Elasticsearch.Aggregations.BucketCorrelationFunctionCountCorrelation countCorrelation) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketCorrelationFunctionCountCorrelation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketCorrelationFunctionCountCorrelation.g.cs index 139775ed635..951c1099ce3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketCorrelationFunctionCountCorrelation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketCorrelationFunctionCountCorrelation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class BucketCorrelationFunctionCountCorrelation { /// - /// The indicator with which to correlate the configured `bucket_path` values. + /// + /// The indicator with which to correlate the configured bucket_path values. + /// /// [JsonInclude, JsonPropertyName("indicator")] public Elastic.Clients.Elasticsearch.Aggregations.BucketCorrelationFunctionCountCorrelationIndicator Indicator { get; set; } @@ -49,7 +51,9 @@ public BucketCorrelationFunctionCountCorrelationDescriptor() : base() private Action IndicatorDescriptorAction { get; set; } /// - /// The indicator with which to correlate the configured `bucket_path` values. + /// + /// The indicator with which to correlate the configured bucket_path values. + /// /// public BucketCorrelationFunctionCountCorrelationDescriptor Indicator(Elastic.Clients.Elasticsearch.Aggregations.BucketCorrelationFunctionCountCorrelationIndicator indicator) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketCorrelationFunctionCountCorrelationIndicator.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketCorrelationFunctionCountCorrelationIndicator.g.cs index a0b96bef1e0..2f006df7bb8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketCorrelationFunctionCountCorrelationIndicator.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketCorrelationFunctionCountCorrelationIndicator.g.cs @@ -30,19 +30,30 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class BucketCorrelationFunctionCountCorrelationIndicator { /// - /// The total number of documents that initially created the expectations. It’s required to be greater
than or equal to the sum of all values in the buckets_path as this is the originating superset of data
to which the term values are correlated. + /// + /// The total number of documents that initially created the expectations. It’s required to be greater + /// than or equal to the sum of all values in the buckets_path as this is the originating superset of data + /// to which the term values are correlated. + /// /// [JsonInclude, JsonPropertyName("doc_count")] public int DocCount { get; set; } /// - /// An array of numbers with which to correlate the configured `bucket_path` values.
The length of this value must always equal the number of buckets returned by the `bucket_path`. + /// + /// An array of numbers with which to correlate the configured bucket_path values. + /// The length of this value must always equal the number of buckets returned by the bucket_path. + /// /// [JsonInclude, JsonPropertyName("expectations")] public ICollection Expectations { get; set; } /// - /// An array of fractions to use when averaging and calculating variance. This should be used if
the pre-calculated data and the buckets_path have known gaps. The length of fractions, if provided,
must equal expectations. + /// + /// An array of fractions to use when averaging and calculating variance. This should be used if + /// the pre-calculated data and the buckets_path have known gaps. The length of fractions, if provided, + /// must equal expectations. + /// /// [JsonInclude, JsonPropertyName("fractions")] public ICollection? Fractions { get; set; } @@ -61,7 +72,11 @@ public BucketCorrelationFunctionCountCorrelationIndicatorDescriptor() : base() private ICollection? FractionsValue { get; set; } /// - /// The total number of documents that initially created the expectations. It’s required to be greater
than or equal to the sum of all values in the buckets_path as this is the originating superset of data
to which the term values are correlated. + /// + /// The total number of documents that initially created the expectations. It’s required to be greater + /// than or equal to the sum of all values in the buckets_path as this is the originating superset of data + /// to which the term values are correlated. + /// /// public BucketCorrelationFunctionCountCorrelationIndicatorDescriptor DocCount(int docCount) { @@ -70,7 +85,10 @@ public BucketCorrelationFunctionCountCorrelationIndicatorDescriptor DocCount(int } /// - /// An array of numbers with which to correlate the configured `bucket_path` values.
The length of this value must always equal the number of buckets returned by the `bucket_path`. + /// + /// An array of numbers with which to correlate the configured bucket_path values. + /// The length of this value must always equal the number of buckets returned by the bucket_path. + /// /// public BucketCorrelationFunctionCountCorrelationIndicatorDescriptor Expectations(ICollection expectations) { @@ -79,7 +97,11 @@ public BucketCorrelationFunctionCountCorrelationIndicatorDescriptor Expectations } /// - /// An array of fractions to use when averaging and calculating variance. This should be used if
the pre-calculated data and the buckets_path have known gaps. The length of fractions, if provided,
must equal expectations. + /// + /// An array of fractions to use when averaging and calculating variance. This should be used if + /// the pre-calculated data and the buckets_path have known gaps. The length of fractions, if provided, + /// must equal expectations. + /// /// public BucketCorrelationFunctionCountCorrelationIndicatorDescriptor Fractions(ICollection? fractions) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketKsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketKsAggregation.g.cs index bd0c4e3293c..c7b09fb91d9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketKsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketKsAggregation.g.cs @@ -28,30 +28,57 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; /// -/// A sibling pipeline aggregation which executes a two sample Kolmogorov–Smirnov test (referred
to as a "K-S test" from now on) against a provided distribution, and the distribution implied
by the documents counts in the configured sibling aggregation. Specifically, for some metric,
assuming that the percentile intervals of the metric are known beforehand or have been computed
by an aggregation, then one would use range aggregation for the sibling to compute the p-value
of the distribution difference between the metric and the restriction of that metric to a subset
of the documents. A natural use case is if the sibling aggregation range aggregation nested in a
terms aggregation, in which case one compares the overall distribution of metric to its restriction
to each term. +/// +/// A sibling pipeline aggregation which executes a two sample Kolmogorov–Smirnov test (referred +/// to as a "K-S test" from now on) against a provided distribution, and the distribution implied +/// by the documents counts in the configured sibling aggregation. Specifically, for some metric, +/// assuming that the percentile intervals of the metric are known beforehand or have been computed +/// by an aggregation, then one would use range aggregation for the sibling to compute the p-value +/// of the distribution difference between the metric and the restriction of that metric to a subset +/// of the documents. A natural use case is if the sibling aggregation range aggregation nested in a +/// terms aggregation, in which case one compares the overall distribution of metric to its restriction +/// to each term. +/// /// public sealed partial class BucketKsAggregation { /// - /// A list of string values indicating which K-S test alternative to calculate. The valid values
are: "greater", "less", "two_sided". This parameter is key for determining the K-S statistic used
when calculating the K-S test. Default value is all possible alternative hypotheses. + /// + /// A list of string values indicating which K-S test alternative to calculate. The valid values + /// are: "greater", "less", "two_sided". This parameter is key for determining the K-S statistic used + /// when calculating the K-S test. Default value is all possible alternative hypotheses. + /// /// [JsonInclude, JsonPropertyName("alternative")] public ICollection? Alternative { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// A list of doubles indicating the distribution of the samples with which to compare to the `buckets_path` results.
In typical usage this is the overall proportion of documents in each bucket, which is compared with the actual
document proportions in each bucket from the sibling aggregation counts. The default is to assume that overall
documents are uniformly distributed on these buckets, which they would be if one used equal percentiles of a
metric to define the bucket end points. + /// + /// A list of doubles indicating the distribution of the samples with which to compare to the buckets_path results. + /// In typical usage this is the overall proportion of documents in each bucket, which is compared with the actual + /// document proportions in each bucket from the sibling aggregation counts. The default is to assume that overall + /// documents are uniformly distributed on these buckets, which they would be if one used equal percentiles of a + /// metric to define the bucket end points. + /// /// [JsonInclude, JsonPropertyName("fractions")] public ICollection? Fractions { get; set; } /// - /// Indicates the sampling methodology when calculating the K-S test. Note, this is sampling of the returned values.
This determines the cumulative distribution function (CDF) points used comparing the two samples. Default is
`upper_tail`, which emphasizes the upper end of the CDF points. Valid options are: `upper_tail`, `uniform`,
and `lower_tail`. + /// + /// Indicates the sampling methodology when calculating the K-S test. Note, this is sampling of the returned values. + /// This determines the cumulative distribution function (CDF) points used comparing the two samples. Default is + /// upper_tail, which emphasizes the upper end of the CDF points. Valid options are: upper_tail, uniform, + /// and lower_tail. + /// /// [JsonInclude, JsonPropertyName("sampling_method")] public string? SamplingMethod { get; set; } @@ -60,7 +87,17 @@ public sealed partial class BucketKsAggregation } /// -/// A sibling pipeline aggregation which executes a two sample Kolmogorov–Smirnov test (referred
to as a "K-S test" from now on) against a provided distribution, and the distribution implied
by the documents counts in the configured sibling aggregation. Specifically, for some metric,
assuming that the percentile intervals of the metric are known beforehand or have been computed
by an aggregation, then one would use range aggregation for the sibling to compute the p-value
of the distribution difference between the metric and the restriction of that metric to a subset
of the documents. A natural use case is if the sibling aggregation range aggregation nested in a
terms aggregation, in which case one compares the overall distribution of metric to its restriction
to each term. +/// +/// A sibling pipeline aggregation which executes a two sample Kolmogorov–Smirnov test (referred +/// to as a "K-S test" from now on) against a provided distribution, and the distribution implied +/// by the documents counts in the configured sibling aggregation. Specifically, for some metric, +/// assuming that the percentile intervals of the metric are known beforehand or have been computed +/// by an aggregation, then one would use range aggregation for the sibling to compute the p-value +/// of the distribution difference between the metric and the restriction of that metric to a subset +/// of the documents. A natural use case is if the sibling aggregation range aggregation nested in a +/// terms aggregation, in which case one compares the overall distribution of metric to its restriction +/// to each term. +/// /// public sealed partial class BucketKsAggregationDescriptor : SerializableDescriptor { @@ -76,7 +113,11 @@ public BucketKsAggregationDescriptor() : base() private string? SamplingMethodValue { get; set; } /// - /// A list of string values indicating which K-S test alternative to calculate. The valid values
are: "greater", "less", "two_sided". This parameter is key for determining the K-S statistic used
when calculating the K-S test. Default value is all possible alternative hypotheses. + /// + /// A list of string values indicating which K-S test alternative to calculate. The valid values + /// are: "greater", "less", "two_sided". This parameter is key for determining the K-S statistic used + /// when calculating the K-S test. Default value is all possible alternative hypotheses. + /// /// public BucketKsAggregationDescriptor Alternative(ICollection? alternative) { @@ -85,7 +126,9 @@ public BucketKsAggregationDescriptor Alternative(ICollection? alternativ } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public BucketKsAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? bucketsPath) { @@ -94,7 +137,13 @@ public BucketKsAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.A } /// - /// A list of doubles indicating the distribution of the samples with which to compare to the `buckets_path` results.
In typical usage this is the overall proportion of documents in each bucket, which is compared with the actual
document proportions in each bucket from the sibling aggregation counts. The default is to assume that overall
documents are uniformly distributed on these buckets, which they would be if one used equal percentiles of a
metric to define the bucket end points. + /// + /// A list of doubles indicating the distribution of the samples with which to compare to the buckets_path results. + /// In typical usage this is the overall proportion of documents in each bucket, which is compared with the actual + /// document proportions in each bucket from the sibling aggregation counts. The default is to assume that overall + /// documents are uniformly distributed on these buckets, which they would be if one used equal percentiles of a + /// metric to define the bucket end points. + /// /// public BucketKsAggregationDescriptor Fractions(ICollection? fractions) { @@ -103,7 +152,12 @@ public BucketKsAggregationDescriptor Fractions(ICollection? fractions) } /// - /// Indicates the sampling methodology when calculating the K-S test. Note, this is sampling of the returned values.
This determines the cumulative distribution function (CDF) points used comparing the two samples. Default is
`upper_tail`, which emphasizes the upper end of the CDF points. Valid options are: `upper_tail`, `uniform`,
and `lower_tail`. + /// + /// Indicates the sampling methodology when calculating the K-S test. Note, this is sampling of the returned values. + /// This determines the cumulative distribution function (CDF) points used comparing the two samples. Default is + /// upper_tail, which emphasizes the upper end of the CDF points. Valid options are: upper_tail, uniform, + /// and lower_tail. + /// /// public BucketKsAggregationDescriptor SamplingMethod(string? samplingMethod) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketMetricValueAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketMetricValueAggregate.g.cs index 0eec8453ffc..1a32f623f8b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketMetricValueAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketMetricValueAggregate.g.cs @@ -35,7 +35,10 @@ public sealed partial class BucketMetricValueAggregate : IAggregate public IReadOnlyDictionary? Meta { get; init; } /// - /// The metric value. A missing value generally means that there was no data to aggregate,
unless specified otherwise. + /// + /// The metric value. A missing value generally means that there was no data to aggregate, + /// unless specified otherwise. + /// /// [JsonInclude, JsonPropertyName("value")] public double? Value { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketScriptAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketScriptAggregation.g.cs index 4a5b9ad1eb7..8ed84cf8630 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketScriptAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketScriptAggregation.g.cs @@ -30,25 +30,34 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class BucketScriptAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? GapPolicy { get; set; } /// - /// The script to run for this aggregation. + /// + /// The script to run for this aggregation. + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Script? Script { get; set; } @@ -72,7 +81,9 @@ public BucketScriptAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public BucketScriptAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? bucketsPath) { @@ -81,7 +92,10 @@ public BucketScriptAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsear } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public BucketScriptAggregationDescriptor Format(string? format) { @@ -90,7 +104,9 @@ public BucketScriptAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public BucketScriptAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? gapPolicy) { @@ -99,7 +115,9 @@ public BucketScriptAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch } /// - /// The script to run for this aggregation. + /// + /// The script to run for this aggregation. + /// /// public BucketScriptAggregationDescriptor Script(Elastic.Clients.Elasticsearch.Script? script) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketSelectorAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketSelectorAggregation.g.cs index 8b8a82dba2e..7fcaa48e287 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketSelectorAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketSelectorAggregation.g.cs @@ -30,25 +30,34 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class BucketSelectorAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? GapPolicy { get; set; } /// - /// The script to run for this aggregation. + /// + /// The script to run for this aggregation. + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Script? Script { get; set; } @@ -72,7 +81,9 @@ public BucketSelectorAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public BucketSelectorAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? bucketsPath) { @@ -81,7 +92,10 @@ public BucketSelectorAggregationDescriptor BucketsPath(Elastic.Clients.Elasticse } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public BucketSelectorAggregationDescriptor Format(string? format) { @@ -90,7 +104,9 @@ public BucketSelectorAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public BucketSelectorAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? gapPolicy) { @@ -99,7 +115,9 @@ public BucketSelectorAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsear } /// - /// The script to run for this aggregation. + /// + /// The script to run for this aggregation. + /// /// public BucketSelectorAggregationDescriptor Script(Elastic.Clients.Elasticsearch.Script? script) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketSortAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketSortAggregation.g.cs index d7514003fc5..85b70e68f2b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketSortAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketSortAggregation.g.cs @@ -30,25 +30,34 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class BucketSortAggregation { /// - /// Buckets in positions prior to `from` will be truncated. + /// + /// Buckets in positions prior to from will be truncated. + /// /// [JsonInclude, JsonPropertyName("from")] public int? From { get; set; } /// - /// The policy to apply when gaps are found in the data. + /// + /// The policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? GapPolicy { get; set; } /// - /// The number of buckets to return.
Defaults to all buckets of the parent aggregation. + /// + /// The number of buckets to return. + /// Defaults to all buckets of the parent aggregation. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// The list of fields to sort on. + /// + /// The list of fields to sort on. + /// /// [JsonInclude, JsonPropertyName("sort")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.SortOptions))] @@ -74,7 +83,9 @@ public BucketSortAggregationDescriptor() : base() private Action>[] SortDescriptorActions { get; set; } /// - /// Buckets in positions prior to `from` will be truncated. + /// + /// Buckets in positions prior to from will be truncated. + /// /// public BucketSortAggregationDescriptor From(int? from) { @@ -83,7 +94,9 @@ public BucketSortAggregationDescriptor From(int? from) } /// - /// The policy to apply when gaps are found in the data. + /// + /// The policy to apply when gaps are found in the data. + /// /// public BucketSortAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? gapPolicy) { @@ -92,7 +105,10 @@ public BucketSortAggregationDescriptor GapPolicy(Elastic.Clients.Elas } /// - /// The number of buckets to return.
Defaults to all buckets of the parent aggregation. + /// + /// The number of buckets to return. + /// Defaults to all buckets of the parent aggregation. + /// /// public BucketSortAggregationDescriptor Size(int? size) { @@ -101,7 +117,9 @@ public BucketSortAggregationDescriptor Size(int? size) } /// - /// The list of fields to sort on. + /// + /// The list of fields to sort on. + /// /// public BucketSortAggregationDescriptor Sort(ICollection? sort) { @@ -210,7 +228,9 @@ public BucketSortAggregationDescriptor() : base() private Action[] SortDescriptorActions { get; set; } /// - /// Buckets in positions prior to `from` will be truncated. + /// + /// Buckets in positions prior to from will be truncated. + /// /// public BucketSortAggregationDescriptor From(int? from) { @@ -219,7 +239,9 @@ public BucketSortAggregationDescriptor From(int? from) } /// - /// The policy to apply when gaps are found in the data. + /// + /// The policy to apply when gaps are found in the data. + /// /// public BucketSortAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? gapPolicy) { @@ -228,7 +250,10 @@ public BucketSortAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.A } /// - /// The number of buckets to return.
Defaults to all buckets of the parent aggregation. + /// + /// The number of buckets to return. + /// Defaults to all buckets of the parent aggregation. + /// /// public BucketSortAggregationDescriptor Size(int? size) { @@ -237,7 +262,9 @@ public BucketSortAggregationDescriptor Size(int? size) } /// - /// The list of fields to sort on. + /// + /// The list of fields to sort on. + /// /// public BucketSortAggregationDescriptor Sort(ICollection? sort) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/Buckets.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/Buckets.g.cs index 98d0e84b572..f1357abc016 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/Buckets.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/Buckets.g.cs @@ -31,7 +31,10 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; /// -/// Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for
the different buckets, the result is a dictionary. +/// +/// Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for +/// the different buckets, the result is a dictionary. +/// /// public sealed partial class Buckets : Union, IReadOnlyCollection> { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CardinalityAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CardinalityAggregation.g.cs index 095661a4a70..8ad316d222e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CardinalityAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CardinalityAggregation.g.cs @@ -30,25 +30,35 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class CardinalityAggregation { /// - /// Mechanism by which cardinality aggregations is run. + /// + /// Mechanism by which cardinality aggregations is run. + /// /// [JsonInclude, JsonPropertyName("execution_hint")] public Elastic.Clients.Elasticsearch.Aggregations.CardinalityExecutionMode? ExecutionHint { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.FieldValue? Missing { get; set; } /// - /// A unique count below which counts are expected to be close to accurate.
This allows to trade memory for accuracy. + /// + /// A unique count below which counts are expected to be close to accurate. + /// This allows to trade memory for accuracy. + /// /// [JsonInclude, JsonPropertyName("precision_threshold")] public int? PrecisionThreshold { get; set; } @@ -78,7 +88,9 @@ public CardinalityAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// Mechanism by which cardinality aggregations is run. + /// + /// Mechanism by which cardinality aggregations is run. + /// /// public CardinalityAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsearch.Aggregations.CardinalityExecutionMode? executionHint) { @@ -87,7 +99,9 @@ public CardinalityAggregationDescriptor ExecutionHint(Elastic.Clients } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public CardinalityAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -96,7 +110,9 @@ public CardinalityAggregationDescriptor Field(Elastic.Clients.Elastic } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public CardinalityAggregationDescriptor Field(Expression> field) { @@ -105,7 +121,9 @@ public CardinalityAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public CardinalityAggregationDescriptor Field(Expression> field) { @@ -114,7 +132,10 @@ public CardinalityAggregationDescriptor Field(Expression - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public CardinalityAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -123,7 +144,10 @@ public CardinalityAggregationDescriptor Missing(Elastic.Clients.Elast } /// - /// A unique count below which counts are expected to be close to accurate.
This allows to trade memory for accuracy. + /// + /// A unique count below which counts are expected to be close to accurate. + /// This allows to trade memory for accuracy. + /// /// public CardinalityAggregationDescriptor PrecisionThreshold(int? precisionThreshold) { @@ -232,7 +256,9 @@ public CardinalityAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// Mechanism by which cardinality aggregations is run. + /// + /// Mechanism by which cardinality aggregations is run. + /// /// public CardinalityAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsearch.Aggregations.CardinalityExecutionMode? executionHint) { @@ -241,7 +267,9 @@ public CardinalityAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsea } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public CardinalityAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -250,7 +278,9 @@ public CardinalityAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Fiel } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public CardinalityAggregationDescriptor Field(Expression> field) { @@ -259,7 +289,9 @@ public CardinalityAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public CardinalityAggregationDescriptor Field(Expression> field) { @@ -268,7 +300,10 @@ public CardinalityAggregationDescriptor Field(Expression - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public CardinalityAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -277,7 +312,10 @@ public CardinalityAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Fi } /// - /// A unique count below which counts are expected to be close to accurate.
This allows to trade memory for accuracy. + /// + /// A unique count below which counts are expected to be close to accurate. + /// This allows to trade memory for accuracy. + /// /// public CardinalityAggregationDescriptor PrecisionThreshold(int? precisionThreshold) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CategorizeTextAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CategorizeTextAggregation.g.cs index 8debe9bb892..a5e2dd5fc50 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CategorizeTextAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CategorizeTextAggregation.g.cs @@ -28,66 +28,104 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; /// -/// A multi-bucket aggregation that groups semi-structured text into buckets. Each text
field is re-analyzed using a custom analyzer. The resulting tokens are then categorized
creating buckets of similarly formatted text values. This aggregation works best with machine
generated text like system logs. Only the first 100 analyzed tokens are used to categorize the text. +/// +/// A multi-bucket aggregation that groups semi-structured text into buckets. Each text +/// field is re-analyzed using a custom analyzer. The resulting tokens are then categorized +/// creating buckets of similarly formatted text values. This aggregation works best with machine +/// generated text like system logs. Only the first 100 analyzed tokens are used to categorize the text. +/// /// public sealed partial class CategorizeTextAggregation { /// - /// The categorization analyzer specifies how the text is analyzed and tokenized before being categorized.
The syntax is very similar to that used to define the analyzer in the [Analyze endpoint](https://www.elastic.co/guide/en/elasticsearch/reference/8.0/indices-analyze.html). This property
cannot be used at the same time as categorization_filters. + /// + /// The categorization analyzer specifies how the text is analyzed and tokenized before being categorized. + /// The syntax is very similar to that used to define the analyzer in the Analyze endpoint. This property + /// cannot be used at the same time as categorization_filters. + /// /// [JsonInclude, JsonPropertyName("categorization_analyzer")] public Elastic.Clients.Elasticsearch.Aggregations.CategorizeTextAnalyzer? CategorizationAnalyzer { get; set; } /// - /// This property expects an array of regular expressions. The expressions are used to filter out matching
sequences from the categorization field values. You can use this functionality to fine tune the categorization
by excluding sequences from consideration when categories are defined. For example, you can exclude SQL
statements that appear in your log files. This property cannot be used at the same time as categorization_analyzer.
If you only want to define simple regular expression filters that are applied prior to tokenization, setting
this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering,
use the categorization_analyzer property instead and include the filters as pattern_replace character filters. + /// + /// This property expects an array of regular expressions. The expressions are used to filter out matching + /// sequences from the categorization field values. You can use this functionality to fine tune the categorization + /// by excluding sequences from consideration when categories are defined. For example, you can exclude SQL + /// statements that appear in your log files. This property cannot be used at the same time as categorization_analyzer. + /// If you only want to define simple regular expression filters that are applied prior to tokenization, setting + /// this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, + /// use the categorization_analyzer property instead and include the filters as pattern_replace character filters. + /// /// [JsonInclude, JsonPropertyName("categorization_filters")] public ICollection? CategorizationFilters { get; set; } /// - /// The semi-structured text field to categorize. + /// + /// The semi-structured text field to categorize. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// The maximum number of token positions to match on before attempting to merge categories. Larger
values will use more memory and create narrower categories. Max allowed value is 100. + /// + /// The maximum number of token positions to match on before attempting to merge categories. Larger + /// values will use more memory and create narrower categories. Max allowed value is 100. + /// /// [JsonInclude, JsonPropertyName("max_matched_tokens")] public int? MaxMatchedTokens { get; set; } /// - /// The maximum number of unique tokens at any position up to max_matched_tokens. Must be larger than 1.
Smaller values use less memory and create fewer categories. Larger values will use more memory and
create narrower categories. Max allowed value is 100. + /// + /// The maximum number of unique tokens at any position up to max_matched_tokens. Must be larger than 1. + /// Smaller values use less memory and create fewer categories. Larger values will use more memory and + /// create narrower categories. Max allowed value is 100. + /// /// [JsonInclude, JsonPropertyName("max_unique_tokens")] public int? MaxUniqueTokens { get; set; } /// - /// The minimum number of documents in a bucket to be returned to the results. + /// + /// The minimum number of documents in a bucket to be returned to the results. + /// /// [JsonInclude, JsonPropertyName("min_doc_count")] public int? MinDocCount { get; set; } /// - /// The minimum number of documents in a bucket to be returned from the shard before merging. + /// + /// The minimum number of documents in a bucket to be returned from the shard before merging. + /// /// [JsonInclude, JsonPropertyName("shard_min_doc_count")] public int? ShardMinDocCount { get; set; } /// - /// The number of categorization buckets to return from each shard before merging all the results. + /// + /// The number of categorization buckets to return from each shard before merging all the results. + /// /// [JsonInclude, JsonPropertyName("shard_size")] public int? ShardSize { get; set; } /// - /// The minimum percentage of tokens that must match for text to be added to the category bucket. Must
be between 1 and 100. The larger the value the narrower the categories. Larger values will increase memory
usage and create narrower categories. + /// + /// The minimum percentage of tokens that must match for text to be added to the category bucket. Must + /// be between 1 and 100. The larger the value the narrower the categories. Larger values will increase memory + /// usage and create narrower categories. + /// /// [JsonInclude, JsonPropertyName("similarity_threshold")] public int? SimilarityThreshold { get; set; } /// - /// The number of buckets to return. + /// + /// The number of buckets to return. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } @@ -96,7 +134,12 @@ public sealed partial class CategorizeTextAggregation } /// -/// A multi-bucket aggregation that groups semi-structured text into buckets. Each text
field is re-analyzed using a custom analyzer. The resulting tokens are then categorized
creating buckets of similarly formatted text values. This aggregation works best with machine
generated text like system logs. Only the first 100 analyzed tokens are used to categorize the text. +/// +/// A multi-bucket aggregation that groups semi-structured text into buckets. Each text +/// field is re-analyzed using a custom analyzer. The resulting tokens are then categorized +/// creating buckets of similarly formatted text values. This aggregation works best with machine +/// generated text like system logs. Only the first 100 analyzed tokens are used to categorize the text. +/// /// public sealed partial class CategorizeTextAggregationDescriptor : SerializableDescriptor> { @@ -118,7 +161,11 @@ public CategorizeTextAggregationDescriptor() : base() private int? SizeValue { get; set; } /// - /// The categorization analyzer specifies how the text is analyzed and tokenized before being categorized.
The syntax is very similar to that used to define the analyzer in the [Analyze endpoint](https://www.elastic.co/guide/en/elasticsearch/reference/8.0/indices-analyze.html). This property
cannot be used at the same time as categorization_filters. + /// + /// The categorization analyzer specifies how the text is analyzed and tokenized before being categorized. + /// The syntax is very similar to that used to define the analyzer in the Analyze endpoint. This property + /// cannot be used at the same time as categorization_filters. + /// /// public CategorizeTextAggregationDescriptor CategorizationAnalyzer(Elastic.Clients.Elasticsearch.Aggregations.CategorizeTextAnalyzer? categorizationAnalyzer) { @@ -127,7 +174,15 @@ public CategorizeTextAggregationDescriptor CategorizationAnalyzer(Ela } /// - /// This property expects an array of regular expressions. The expressions are used to filter out matching
sequences from the categorization field values. You can use this functionality to fine tune the categorization
by excluding sequences from consideration when categories are defined. For example, you can exclude SQL
statements that appear in your log files. This property cannot be used at the same time as categorization_analyzer.
If you only want to define simple regular expression filters that are applied prior to tokenization, setting
this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering,
use the categorization_analyzer property instead and include the filters as pattern_replace character filters. + /// + /// This property expects an array of regular expressions. The expressions are used to filter out matching + /// sequences from the categorization field values. You can use this functionality to fine tune the categorization + /// by excluding sequences from consideration when categories are defined. For example, you can exclude SQL + /// statements that appear in your log files. This property cannot be used at the same time as categorization_analyzer. + /// If you only want to define simple regular expression filters that are applied prior to tokenization, setting + /// this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, + /// use the categorization_analyzer property instead and include the filters as pattern_replace character filters. + /// /// public CategorizeTextAggregationDescriptor CategorizationFilters(ICollection? categorizationFilters) { @@ -136,7 +191,9 @@ public CategorizeTextAggregationDescriptor CategorizationFilters(ICol } /// - /// The semi-structured text field to categorize. + /// + /// The semi-structured text field to categorize. + /// /// public CategorizeTextAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -145,7 +202,9 @@ public CategorizeTextAggregationDescriptor Field(Elastic.Clients.Elas } /// - /// The semi-structured text field to categorize. + /// + /// The semi-structured text field to categorize. + /// /// public CategorizeTextAggregationDescriptor Field(Expression> field) { @@ -154,7 +213,9 @@ public CategorizeTextAggregationDescriptor Field(Expression - /// The semi-structured text field to categorize. + /// + /// The semi-structured text field to categorize. + /// /// public CategorizeTextAggregationDescriptor Field(Expression> field) { @@ -163,7 +224,10 @@ public CategorizeTextAggregationDescriptor Field(Expression - /// The maximum number of token positions to match on before attempting to merge categories. Larger
values will use more memory and create narrower categories. Max allowed value is 100. + /// + /// The maximum number of token positions to match on before attempting to merge categories. Larger + /// values will use more memory and create narrower categories. Max allowed value is 100. + /// /// public CategorizeTextAggregationDescriptor MaxMatchedTokens(int? maxMatchedTokens) { @@ -172,7 +236,11 @@ public CategorizeTextAggregationDescriptor MaxMatchedTokens(int? maxM } /// - /// The maximum number of unique tokens at any position up to max_matched_tokens. Must be larger than 1.
Smaller values use less memory and create fewer categories. Larger values will use more memory and
create narrower categories. Max allowed value is 100. + /// + /// The maximum number of unique tokens at any position up to max_matched_tokens. Must be larger than 1. + /// Smaller values use less memory and create fewer categories. Larger values will use more memory and + /// create narrower categories. Max allowed value is 100. + /// /// public CategorizeTextAggregationDescriptor MaxUniqueTokens(int? maxUniqueTokens) { @@ -181,7 +249,9 @@ public CategorizeTextAggregationDescriptor MaxUniqueTokens(int? maxUn } /// - /// The minimum number of documents in a bucket to be returned to the results. + /// + /// The minimum number of documents in a bucket to be returned to the results. + /// /// public CategorizeTextAggregationDescriptor MinDocCount(int? minDocCount) { @@ -190,7 +260,9 @@ public CategorizeTextAggregationDescriptor MinDocCount(int? minDocCou } /// - /// The minimum number of documents in a bucket to be returned from the shard before merging. + /// + /// The minimum number of documents in a bucket to be returned from the shard before merging. + /// /// public CategorizeTextAggregationDescriptor ShardMinDocCount(int? shardMinDocCount) { @@ -199,7 +271,9 @@ public CategorizeTextAggregationDescriptor ShardMinDocCount(int? shar } /// - /// The number of categorization buckets to return from each shard before merging all the results. + /// + /// The number of categorization buckets to return from each shard before merging all the results. + /// /// public CategorizeTextAggregationDescriptor ShardSize(int? shardSize) { @@ -208,7 +282,11 @@ public CategorizeTextAggregationDescriptor ShardSize(int? shardSize) } /// - /// The minimum percentage of tokens that must match for text to be added to the category bucket. Must
be between 1 and 100. The larger the value the narrower the categories. Larger values will increase memory
usage and create narrower categories. + /// + /// The minimum percentage of tokens that must match for text to be added to the category bucket. Must + /// be between 1 and 100. The larger the value the narrower the categories. Larger values will increase memory + /// usage and create narrower categories. + /// /// public CategorizeTextAggregationDescriptor SimilarityThreshold(int? similarityThreshold) { @@ -217,7 +295,9 @@ public CategorizeTextAggregationDescriptor SimilarityThreshold(int? s } /// - /// The number of buckets to return. + /// + /// The number of buckets to return. + /// /// public CategorizeTextAggregationDescriptor Size(int? size) { @@ -289,7 +369,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// A multi-bucket aggregation that groups semi-structured text into buckets. Each text
field is re-analyzed using a custom analyzer. The resulting tokens are then categorized
creating buckets of similarly formatted text values. This aggregation works best with machine
generated text like system logs. Only the first 100 analyzed tokens are used to categorize the text. +/// +/// A multi-bucket aggregation that groups semi-structured text into buckets. Each text +/// field is re-analyzed using a custom analyzer. The resulting tokens are then categorized +/// creating buckets of similarly formatted text values. This aggregation works best with machine +/// generated text like system logs. Only the first 100 analyzed tokens are used to categorize the text. +/// /// public sealed partial class CategorizeTextAggregationDescriptor : SerializableDescriptor { @@ -311,7 +396,11 @@ public CategorizeTextAggregationDescriptor() : base() private int? SizeValue { get; set; } /// - /// The categorization analyzer specifies how the text is analyzed and tokenized before being categorized.
The syntax is very similar to that used to define the analyzer in the [Analyze endpoint](https://www.elastic.co/guide/en/elasticsearch/reference/8.0/indices-analyze.html). This property
cannot be used at the same time as categorization_filters. + /// + /// The categorization analyzer specifies how the text is analyzed and tokenized before being categorized. + /// The syntax is very similar to that used to define the analyzer in the Analyze endpoint. This property + /// cannot be used at the same time as categorization_filters. + /// /// public CategorizeTextAggregationDescriptor CategorizationAnalyzer(Elastic.Clients.Elasticsearch.Aggregations.CategorizeTextAnalyzer? categorizationAnalyzer) { @@ -320,7 +409,15 @@ public CategorizeTextAggregationDescriptor CategorizationAnalyzer(Elastic.Client } /// - /// This property expects an array of regular expressions. The expressions are used to filter out matching
sequences from the categorization field values. You can use this functionality to fine tune the categorization
by excluding sequences from consideration when categories are defined. For example, you can exclude SQL
statements that appear in your log files. This property cannot be used at the same time as categorization_analyzer.
If you only want to define simple regular expression filters that are applied prior to tokenization, setting
this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering,
use the categorization_analyzer property instead and include the filters as pattern_replace character filters. + /// + /// This property expects an array of regular expressions. The expressions are used to filter out matching + /// sequences from the categorization field values. You can use this functionality to fine tune the categorization + /// by excluding sequences from consideration when categories are defined. For example, you can exclude SQL + /// statements that appear in your log files. This property cannot be used at the same time as categorization_analyzer. + /// If you only want to define simple regular expression filters that are applied prior to tokenization, setting + /// this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, + /// use the categorization_analyzer property instead and include the filters as pattern_replace character filters. + /// /// public CategorizeTextAggregationDescriptor CategorizationFilters(ICollection? categorizationFilters) { @@ -329,7 +426,9 @@ public CategorizeTextAggregationDescriptor CategorizationFilters(ICollection - /// The semi-structured text field to categorize. + /// + /// The semi-structured text field to categorize. + /// /// public CategorizeTextAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -338,7 +437,9 @@ public CategorizeTextAggregationDescriptor Field(Elastic.Clients.Elasticsearch.F } /// - /// The semi-structured text field to categorize. + /// + /// The semi-structured text field to categorize. + /// /// public CategorizeTextAggregationDescriptor Field(Expression> field) { @@ -347,7 +448,9 @@ public CategorizeTextAggregationDescriptor Field(Expression - /// The semi-structured text field to categorize. + /// + /// The semi-structured text field to categorize. + /// /// public CategorizeTextAggregationDescriptor Field(Expression> field) { @@ -356,7 +459,10 @@ public CategorizeTextAggregationDescriptor Field(Expression - /// The maximum number of token positions to match on before attempting to merge categories. Larger
values will use more memory and create narrower categories. Max allowed value is 100. + /// + /// The maximum number of token positions to match on before attempting to merge categories. Larger + /// values will use more memory and create narrower categories. Max allowed value is 100. + /// /// public CategorizeTextAggregationDescriptor MaxMatchedTokens(int? maxMatchedTokens) { @@ -365,7 +471,11 @@ public CategorizeTextAggregationDescriptor MaxMatchedTokens(int? maxMatchedToken } /// - /// The maximum number of unique tokens at any position up to max_matched_tokens. Must be larger than 1.
Smaller values use less memory and create fewer categories. Larger values will use more memory and
create narrower categories. Max allowed value is 100. + /// + /// The maximum number of unique tokens at any position up to max_matched_tokens. Must be larger than 1. + /// Smaller values use less memory and create fewer categories. Larger values will use more memory and + /// create narrower categories. Max allowed value is 100. + /// /// public CategorizeTextAggregationDescriptor MaxUniqueTokens(int? maxUniqueTokens) { @@ -374,7 +484,9 @@ public CategorizeTextAggregationDescriptor MaxUniqueTokens(int? maxUniqueTokens) } /// - /// The minimum number of documents in a bucket to be returned to the results. + /// + /// The minimum number of documents in a bucket to be returned to the results. + /// /// public CategorizeTextAggregationDescriptor MinDocCount(int? minDocCount) { @@ -383,7 +495,9 @@ public CategorizeTextAggregationDescriptor MinDocCount(int? minDocCount) } /// - /// The minimum number of documents in a bucket to be returned from the shard before merging. + /// + /// The minimum number of documents in a bucket to be returned from the shard before merging. + /// /// public CategorizeTextAggregationDescriptor ShardMinDocCount(int? shardMinDocCount) { @@ -392,7 +506,9 @@ public CategorizeTextAggregationDescriptor ShardMinDocCount(int? shardMinDocCoun } /// - /// The number of categorization buckets to return from each shard before merging all the results. + /// + /// The number of categorization buckets to return from each shard before merging all the results. + /// /// public CategorizeTextAggregationDescriptor ShardSize(int? shardSize) { @@ -401,7 +517,11 @@ public CategorizeTextAggregationDescriptor ShardSize(int? shardSize) } /// - /// The minimum percentage of tokens that must match for text to be added to the category bucket. Must
be between 1 and 100. The larger the value the narrower the categories. Larger values will increase memory
usage and create narrower categories. + /// + /// The minimum percentage of tokens that must match for text to be added to the category bucket. Must + /// be between 1 and 100. The larger the value the narrower the categories. Larger values will increase memory + /// usage and create narrower categories. + /// /// public CategorizeTextAggregationDescriptor SimilarityThreshold(int? similarityThreshold) { @@ -410,7 +530,9 @@ public CategorizeTextAggregationDescriptor SimilarityThreshold(int? similarityTh } /// - /// The number of buckets to return. + /// + /// The number of buckets to return. + /// /// public CategorizeTextAggregationDescriptor Size(int? size) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ChiSquareHeuristic.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ChiSquareHeuristic.g.cs index dabf5f57d95..c26d8eb168e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ChiSquareHeuristic.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ChiSquareHeuristic.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class ChiSquareHeuristic { /// - /// Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. + /// + /// Set to false if you defined a custom background filter that represents a different set of documents that you want to compare to. + /// /// [JsonInclude, JsonPropertyName("background_is_superset")] public bool BackgroundIsSuperset { get; set; } /// - /// Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset. + /// + /// Set to false to filter out the terms that appear less often in the subset than in documents outside the subset. + /// /// [JsonInclude, JsonPropertyName("include_negatives")] public bool IncludeNegatives { get; set; } @@ -54,7 +58,9 @@ public ChiSquareHeuristicDescriptor() : base() private bool IncludeNegativesValue { get; set; } /// - /// Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. + /// + /// Set to false if you defined a custom background filter that represents a different set of documents that you want to compare to. + /// /// public ChiSquareHeuristicDescriptor BackgroundIsSuperset(bool backgroundIsSuperset = true) { @@ -63,7 +69,9 @@ public ChiSquareHeuristicDescriptor BackgroundIsSuperset(bool backgroundIsSupers } /// - /// Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset. + /// + /// Set to false to filter out the terms that appear less often in the subset than in documents outside the subset. + /// /// public ChiSquareHeuristicDescriptor IncludeNegatives(bool includeNegatives = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ChildrenAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ChildrenAggregate.g.cs index 26563345807..072e2c3f5ca 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ChildrenAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ChildrenAggregate.g.cs @@ -77,7 +77,9 @@ public override void Write(Utf8JsonWriter writer, ChildrenAggregate value, JsonS public sealed partial class ChildrenAggregate : IAggregate { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ChildrenAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ChildrenAggregation.g.cs index 97ff0214d1e..422d80fff3e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ChildrenAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ChildrenAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class ChildrenAggregation { /// - /// The child type that should be selected. + /// + /// The child type that should be selected. + /// /// [JsonInclude, JsonPropertyName("type")] public string? Type { get; set; } @@ -49,7 +51,9 @@ public ChildrenAggregationDescriptor() : base() private string? TypeValue { get; set; } /// - /// The child type that should be selected. + /// + /// The child type that should be selected. + /// /// public ChildrenAggregationDescriptor Type(string? type) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeAggregation.g.cs index 07143d83cff..3cfcb876337 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeAggregation.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class CompositeAggregation { /// - /// When paginating, use the `after_key` value returned in the previous response to retrieve the next page. + /// + /// When paginating, use the after_key value returned in the previous response to retrieve the next page. + /// /// [JsonInclude, JsonPropertyName("after")] public IDictionary? After { get; set; } /// - /// The number of composite buckets that should be returned. + /// + /// The number of composite buckets that should be returned. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// The value sources used to build composite buckets.
Keys are returned in the order of the `sources` definition. + /// + /// The value sources used to build composite buckets. + /// Keys are returned in the order of the sources definition. + /// /// [JsonInclude, JsonPropertyName("sources")] public ICollection>? Sources { get; set; } @@ -63,7 +70,9 @@ public CompositeAggregationDescriptor() : base() private ICollection>? SourcesValue { get; set; } /// - /// When paginating, use the `after_key` value returned in the previous response to retrieve the next page. + /// + /// When paginating, use the after_key value returned in the previous response to retrieve the next page. + /// /// public CompositeAggregationDescriptor After(Func, FluentDictionary> selector) { @@ -72,7 +81,9 @@ public CompositeAggregationDescriptor After(Func - /// The number of composite buckets that should be returned. + /// + /// The number of composite buckets that should be returned. + /// /// public CompositeAggregationDescriptor Size(int? size) { @@ -81,7 +92,10 @@ public CompositeAggregationDescriptor Size(int? size) } /// - /// The value sources used to build composite buckets.
Keys are returned in the order of the `sources` definition. + /// + /// The value sources used to build composite buckets. + /// Keys are returned in the order of the sources definition. + /// /// public CompositeAggregationDescriptor Sources(ICollection>? sources) { @@ -127,7 +141,9 @@ public CompositeAggregationDescriptor() : base() private ICollection>? SourcesValue { get; set; } /// - /// When paginating, use the `after_key` value returned in the previous response to retrieve the next page. + /// + /// When paginating, use the after_key value returned in the previous response to retrieve the next page. + /// /// public CompositeAggregationDescriptor After(Func, FluentDictionary> selector) { @@ -136,7 +152,9 @@ public CompositeAggregationDescriptor After(Func - /// The number of composite buckets that should be returned. + /// + /// The number of composite buckets that should be returned. + /// /// public CompositeAggregationDescriptor Size(int? size) { @@ -145,7 +163,10 @@ public CompositeAggregationDescriptor Size(int? size) } /// - /// The value sources used to build composite buckets.
Keys are returned in the order of the `sources` definition. + /// + /// The value sources used to build composite buckets. + /// Keys are returned in the order of the sources definition. + /// /// public CompositeAggregationDescriptor Sources(ICollection>? sources) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeAggregationSource.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeAggregationSource.g.cs index 823f0f245e7..7febc6ed01e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeAggregationSource.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeAggregationSource.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class CompositeAggregationSource { /// - /// A date histogram aggregation. + /// + /// A date histogram aggregation. + /// /// [JsonInclude, JsonPropertyName("date_histogram")] public Elastic.Clients.Elasticsearch.Aggregations.CompositeDateHistogramAggregation? DateHistogram { get; set; } /// - /// A geotile grid aggregation. + /// + /// A geotile grid aggregation. + /// /// [JsonInclude, JsonPropertyName("geotile_grid")] public Elastic.Clients.Elasticsearch.Aggregations.CompositeGeoTileGridAggregation? GeotileGrid { get; set; } /// - /// A histogram aggregation. + /// + /// A histogram aggregation. + /// /// [JsonInclude, JsonPropertyName("histogram")] public Elastic.Clients.Elasticsearch.Aggregations.CompositeHistogramAggregation? Histogram { get; set; } /// - /// A terms aggregation. + /// + /// A terms aggregation. + /// /// [JsonInclude, JsonPropertyName("terms")] public Elastic.Clients.Elasticsearch.Aggregations.CompositeTermsAggregation? Terms { get; set; } @@ -76,7 +84,9 @@ public CompositeAggregationSourceDescriptor() : base() private Action> TermsDescriptorAction { get; set; } /// - /// A date histogram aggregation. + /// + /// A date histogram aggregation. + /// /// public CompositeAggregationSourceDescriptor DateHistogram(Elastic.Clients.Elasticsearch.Aggregations.CompositeDateHistogramAggregation? dateHistogram) { @@ -103,7 +113,9 @@ public CompositeAggregationSourceDescriptor DateHistogram(Action - /// A geotile grid aggregation. + /// + /// A geotile grid aggregation. + /// /// public CompositeAggregationSourceDescriptor GeotileGrid(Elastic.Clients.Elasticsearch.Aggregations.CompositeGeoTileGridAggregation? geotileGrid) { @@ -130,7 +142,9 @@ public CompositeAggregationSourceDescriptor GeotileGrid(Action - /// A histogram aggregation. + /// + /// A histogram aggregation. + /// /// public CompositeAggregationSourceDescriptor Histogram(Elastic.Clients.Elasticsearch.Aggregations.CompositeHistogramAggregation? histogram) { @@ -157,7 +171,9 @@ public CompositeAggregationSourceDescriptor Histogram(Action - /// A terms aggregation. + /// + /// A terms aggregation. + /// /// public CompositeAggregationSourceDescriptor Terms(Elastic.Clients.Elasticsearch.Aggregations.CompositeTermsAggregation? terms) { @@ -276,7 +292,9 @@ public CompositeAggregationSourceDescriptor() : base() private Action TermsDescriptorAction { get; set; } /// - /// A date histogram aggregation. + /// + /// A date histogram aggregation. + /// /// public CompositeAggregationSourceDescriptor DateHistogram(Elastic.Clients.Elasticsearch.Aggregations.CompositeDateHistogramAggregation? dateHistogram) { @@ -303,7 +321,9 @@ public CompositeAggregationSourceDescriptor DateHistogram(Action - /// A geotile grid aggregation. + /// + /// A geotile grid aggregation. + /// /// public CompositeAggregationSourceDescriptor GeotileGrid(Elastic.Clients.Elasticsearch.Aggregations.CompositeGeoTileGridAggregation? geotileGrid) { @@ -330,7 +350,9 @@ public CompositeAggregationSourceDescriptor GeotileGrid(Action - /// A histogram aggregation. + /// + /// A histogram aggregation. + /// /// public CompositeAggregationSourceDescriptor Histogram(Elastic.Clients.Elasticsearch.Aggregations.CompositeHistogramAggregation? histogram) { @@ -357,7 +379,9 @@ public CompositeAggregationSourceDescriptor Histogram(Action - /// A terms aggregation. + /// + /// A terms aggregation. + /// /// public CompositeAggregationSourceDescriptor Terms(Elastic.Clients.Elasticsearch.Aggregations.CompositeTermsAggregation? terms) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeBucket.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeBucket.g.cs index 05712794cc6..42e67f51da3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeBucket.g.cs @@ -77,7 +77,9 @@ public override void Write(Utf8JsonWriter writer, CompositeBucket value, JsonSer public sealed partial class CompositeBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeDateHistogramAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeDateHistogramAggregation.g.cs index 6fe86c4421e..9cd68283ed9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeDateHistogramAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeDateHistogramAggregation.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class CompositeDateHistogramAggregation { /// - /// Either `calendar_interval` or `fixed_interval` must be present + /// + /// Either calendar_interval or fixed_interval must be present + /// /// [JsonInclude, JsonPropertyName("calendar_interval")] public string? CalendarInterval { get; set; } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } /// - /// Either `calendar_interval` or `fixed_interval` must be present + /// + /// Either calendar_interval or fixed_interval must be present + /// /// [JsonInclude, JsonPropertyName("fixed_interval")] public string? FixedInterval { get; set; } @@ -58,7 +64,9 @@ public sealed partial class CompositeDateHistogramAggregation public Elastic.Clients.Elasticsearch.SortOrder? Order { get; set; } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Script? Script { get; set; } @@ -91,7 +99,9 @@ public CompositeDateHistogramAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Aggregations.ValueType? ValueTypeValue { get; set; } /// - /// Either `calendar_interval` or `fixed_interval` must be present + /// + /// Either calendar_interval or fixed_interval must be present + /// /// public CompositeDateHistogramAggregationDescriptor CalendarInterval(string? calendarInterval) { @@ -100,7 +110,9 @@ public CompositeDateHistogramAggregationDescriptor CalendarInterval(s } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeDateHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -109,7 +121,9 @@ public CompositeDateHistogramAggregationDescriptor Field(Elastic.Clie } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeDateHistogramAggregationDescriptor Field(Expression> field) { @@ -118,7 +132,9 @@ public CompositeDateHistogramAggregationDescriptor Field(Expr } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeDateHistogramAggregationDescriptor Field(Expression> field) { @@ -127,7 +143,9 @@ public CompositeDateHistogramAggregationDescriptor Field(Expression - /// Either `calendar_interval` or `fixed_interval` must be present + /// + /// Either calendar_interval or fixed_interval must be present + /// /// public CompositeDateHistogramAggregationDescriptor FixedInterval(string? fixedInterval) { @@ -166,7 +184,9 @@ public CompositeDateHistogramAggregationDescriptor Order(Elastic.Clie } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeDateHistogramAggregationDescriptor Script(Elastic.Clients.Elasticsearch.Script? script) { @@ -310,7 +330,9 @@ public CompositeDateHistogramAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Aggregations.ValueType? ValueTypeValue { get; set; } /// - /// Either `calendar_interval` or `fixed_interval` must be present + /// + /// Either calendar_interval or fixed_interval must be present + /// /// public CompositeDateHistogramAggregationDescriptor CalendarInterval(string? calendarInterval) { @@ -319,7 +341,9 @@ public CompositeDateHistogramAggregationDescriptor CalendarInterval(string? cale } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeDateHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -328,7 +352,9 @@ public CompositeDateHistogramAggregationDescriptor Field(Elastic.Clients.Elastic } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeDateHistogramAggregationDescriptor Field(Expression> field) { @@ -337,7 +363,9 @@ public CompositeDateHistogramAggregationDescriptor Field(Expr } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeDateHistogramAggregationDescriptor Field(Expression> field) { @@ -346,7 +374,9 @@ public CompositeDateHistogramAggregationDescriptor Field(Expression - /// Either `calendar_interval` or `fixed_interval` must be present + /// + /// Either calendar_interval or fixed_interval must be present + /// /// public CompositeDateHistogramAggregationDescriptor FixedInterval(string? fixedInterval) { @@ -385,7 +415,9 @@ public CompositeDateHistogramAggregationDescriptor Order(Elastic.Clients.Elastic } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeDateHistogramAggregationDescriptor Script(Elastic.Clients.Elasticsearch.Script? script) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeGeoTileGridAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeGeoTileGridAggregation.g.cs index 33e54ddce2d..c1c56cea1c8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeGeoTileGridAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeGeoTileGridAggregation.g.cs @@ -33,7 +33,9 @@ public sealed partial class CompositeGeoTileGridAggregation public Elastic.Clients.Elasticsearch.GeoBounds? Bounds { get; set; } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } @@ -47,7 +49,9 @@ public sealed partial class CompositeGeoTileGridAggregation public int? Precision { get; set; } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Script? Script { get; set; } @@ -81,7 +85,9 @@ public CompositeGeoTileGridAggregationDescriptor Bounds(Elastic.Clien } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeGeoTileGridAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -90,7 +96,9 @@ public CompositeGeoTileGridAggregationDescriptor Field(Elastic.Client } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeGeoTileGridAggregationDescriptor Field(Expression> field) { @@ -99,7 +107,9 @@ public CompositeGeoTileGridAggregationDescriptor Field(Expres } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeGeoTileGridAggregationDescriptor Field(Expression> field) { @@ -132,7 +142,9 @@ public CompositeGeoTileGridAggregationDescriptor Precision(int? preci } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeGeoTileGridAggregationDescriptor Script(Elastic.Clients.Elasticsearch.Script? script) { @@ -255,7 +267,9 @@ public CompositeGeoTileGridAggregationDescriptor Bounds(Elastic.Clients.Elastics } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeGeoTileGridAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -264,7 +278,9 @@ public CompositeGeoTileGridAggregationDescriptor Field(Elastic.Clients.Elasticse } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeGeoTileGridAggregationDescriptor Field(Expression> field) { @@ -273,7 +289,9 @@ public CompositeGeoTileGridAggregationDescriptor Field(Expres } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeGeoTileGridAggregationDescriptor Field(Expression> field) { @@ -306,7 +324,9 @@ public CompositeGeoTileGridAggregationDescriptor Precision(int? precision) } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeGeoTileGridAggregationDescriptor Script(Elastic.Clients.Elasticsearch.Script? script) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeHistogramAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeHistogramAggregation.g.cs index c7ff17dbde2..e6d78a571bd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeHistogramAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeHistogramAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class CompositeHistogramAggregation { /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } @@ -44,7 +46,9 @@ public sealed partial class CompositeHistogramAggregation public Elastic.Clients.Elasticsearch.SortOrder? Order { get; set; } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Script? Script { get; set; } @@ -71,7 +75,9 @@ public CompositeHistogramAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Aggregations.ValueType? ValueTypeValue { get; set; } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -80,7 +86,9 @@ public CompositeHistogramAggregationDescriptor Field(Elastic.Clients. } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeHistogramAggregationDescriptor Field(Expression> field) { @@ -89,7 +97,9 @@ public CompositeHistogramAggregationDescriptor Field(Expressi } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeHistogramAggregationDescriptor Field(Expression> field) { @@ -122,7 +132,9 @@ public CompositeHistogramAggregationDescriptor Order(Elastic.Clients. } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeHistogramAggregationDescriptor Script(Elastic.Clients.Elasticsearch.Script? script) { @@ -228,7 +240,9 @@ public CompositeHistogramAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Aggregations.ValueType? ValueTypeValue { get; set; } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -237,7 +251,9 @@ public CompositeHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsear } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeHistogramAggregationDescriptor Field(Expression> field) { @@ -246,7 +262,9 @@ public CompositeHistogramAggregationDescriptor Field(Expressi } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeHistogramAggregationDescriptor Field(Expression> field) { @@ -279,7 +297,9 @@ public CompositeHistogramAggregationDescriptor Order(Elastic.Clients.Elasticsear } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeHistogramAggregationDescriptor Script(Elastic.Clients.Elasticsearch.Script? script) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeTermsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeTermsAggregation.g.cs index ba3da52cf05..eb18ae41998 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeTermsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeTermsAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class CompositeTermsAggregation { /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } @@ -42,7 +44,9 @@ public sealed partial class CompositeTermsAggregation public Elastic.Clients.Elasticsearch.SortOrder? Order { get; set; } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Script? Script { get; set; } @@ -68,7 +72,9 @@ public CompositeTermsAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Aggregations.ValueType? ValueTypeValue { get; set; } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeTermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -77,7 +83,9 @@ public CompositeTermsAggregationDescriptor Field(Elastic.Clients.Elas } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeTermsAggregationDescriptor Field(Expression> field) { @@ -86,7 +94,9 @@ public CompositeTermsAggregationDescriptor Field(Expression - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeTermsAggregationDescriptor Field(Expression> field) { @@ -113,7 +123,9 @@ public CompositeTermsAggregationDescriptor Order(Elastic.Clients.Elas } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeTermsAggregationDescriptor Script(Elastic.Clients.Elasticsearch.Script? script) { @@ -216,7 +228,9 @@ public CompositeTermsAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Aggregations.ValueType? ValueTypeValue { get; set; } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeTermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -225,7 +239,9 @@ public CompositeTermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.F } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeTermsAggregationDescriptor Field(Expression> field) { @@ -234,7 +250,9 @@ public CompositeTermsAggregationDescriptor Field(Expression - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeTermsAggregationDescriptor Field(Expression> field) { @@ -261,7 +279,9 @@ public CompositeTermsAggregationDescriptor Order(Elastic.Clients.Elasticsearch.S } /// - /// Either `field` or `script` must be present + /// + /// Either field or script must be present + /// /// public CompositeTermsAggregationDescriptor Script(Elastic.Clients.Elasticsearch.Script? script) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CumulativeCardinalityAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CumulativeCardinalityAggregate.g.cs index 1374d38c459..5c0dcba229a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CumulativeCardinalityAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CumulativeCardinalityAggregate.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; /// -/// Result of the `cumulative_cardinality` aggregation +/// +/// Result of the cumulative_cardinality aggregation +/// /// public sealed partial class CumulativeCardinalityAggregate : IAggregate { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CumulativeCardinalityAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CumulativeCardinalityAggregation.g.cs index 807e9178de4..e9372ff0f6c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CumulativeCardinalityAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CumulativeCardinalityAggregation.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class CumulativeCardinalityAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? GapPolicy { get; set; } @@ -63,7 +70,9 @@ public CumulativeCardinalityAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? GapPolicyValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public CumulativeCardinalityAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? bucketsPath) { @@ -72,7 +81,10 @@ public CumulativeCardinalityAggregationDescriptor BucketsPath(Elastic.Clients.El } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public CumulativeCardinalityAggregationDescriptor Format(string? format) { @@ -81,7 +93,9 @@ public CumulativeCardinalityAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public CumulativeCardinalityAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? gapPolicy) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CumulativeSumAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CumulativeSumAggregation.g.cs index 873331377a9..a9f64699c3e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CumulativeSumAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CumulativeSumAggregation.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class CumulativeSumAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? GapPolicy { get; set; } @@ -63,7 +70,9 @@ public CumulativeSumAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? GapPolicyValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public CumulativeSumAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? bucketsPath) { @@ -72,7 +81,10 @@ public CumulativeSumAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsea } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public CumulativeSumAggregationDescriptor Format(string? format) { @@ -81,7 +93,9 @@ public CumulativeSumAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public CumulativeSumAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? gapPolicy) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateHistogramAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateHistogramAggregation.g.cs index 7ccfcf4158d..a42bd78fdb7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateHistogramAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateHistogramAggregation.g.cs @@ -30,61 +30,85 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class DateHistogramAggregation { /// - /// Calendar-aware interval.
Can be specified using the unit name, such as `month`, or as a single unit quantity, such as `1M`. + /// + /// Calendar-aware interval. + /// Can be specified using the unit name, such as month, or as a single unit quantity, such as 1M. + /// /// [JsonInclude, JsonPropertyName("calendar_interval")] public Elastic.Clients.Elasticsearch.Aggregations.CalendarInterval? CalendarInterval { get; set; } /// - /// Enables extending the bounds of the histogram beyond the data itself. + /// + /// Enables extending the bounds of the histogram beyond the data itself. + /// /// [JsonInclude, JsonPropertyName("extended_bounds")] public Elastic.Clients.Elasticsearch.Aggregations.ExtendedBoundsDate? ExtendedBounds { get; set; } /// - /// The date field whose values are use to build a histogram. + /// + /// The date field whose values are use to build a histogram. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } /// - /// Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar. + /// + /// Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar. + /// /// [JsonInclude, JsonPropertyName("fixed_interval")] public Elastic.Clients.Elasticsearch.Duration? FixedInterval { get; set; } /// - /// The date format used to format `key_as_string` in the response.
If no `format` is specified, the first date format specified in the field mapping is used. + /// + /// The date format used to format key_as_string in the response. + /// If no format is specified, the first date format specified in the field mapping is used. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Limits the histogram to specified bounds. + /// + /// Limits the histogram to specified bounds. + /// /// [JsonInclude, JsonPropertyName("hard_bounds")] public Elastic.Clients.Elasticsearch.Aggregations.ExtendedBoundsDate? HardBounds { get; set; } /// - /// Only returns buckets that have `min_doc_count` number of documents.
By default, all buckets between the first bucket that matches documents and the last one are returned. + /// + /// Only returns buckets that have min_doc_count number of documents. + /// By default, all buckets between the first bucket that matches documents and the last one are returned. + /// /// [JsonInclude, JsonPropertyName("min_doc_count")] public int? MinDocCount { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public DateTimeOffset? Missing { get; set; } /// - /// Changes the start value of each bucket by the specified positive (`+`) or negative offset (`-`) duration. + /// + /// Changes the start value of each bucket by the specified positive (+) or negative offset (-) duration. + /// /// [JsonInclude, JsonPropertyName("offset")] public Elastic.Clients.Elasticsearch.Duration? Offset { get; set; } /// - /// The sort order of the returned buckets. + /// + /// The sort order of the returned buckets. + /// /// [JsonInclude, JsonPropertyName("order")] [SingleOrManyCollectionConverter(typeof(KeyValuePair))] @@ -95,7 +119,10 @@ public sealed partial class DateHistogramAggregation public Elastic.Clients.Elasticsearch.Script? Script { get; set; } /// - /// Time zone used for bucketing and rounding.
Defaults to Coordinated Universal Time (UTC). + /// + /// Time zone used for bucketing and rounding. + /// Defaults to Coordinated Universal Time (UTC). + /// /// [JsonInclude, JsonPropertyName("time_zone")] public string? TimeZone { get; set; } @@ -133,7 +160,10 @@ public DateHistogramAggregationDescriptor() : base() private string? TimeZoneValue { get; set; } /// - /// Calendar-aware interval.
Can be specified using the unit name, such as `month`, or as a single unit quantity, such as `1M`. + /// + /// Calendar-aware interval. + /// Can be specified using the unit name, such as month, or as a single unit quantity, such as 1M. + /// /// public DateHistogramAggregationDescriptor CalendarInterval(Elastic.Clients.Elasticsearch.Aggregations.CalendarInterval? calendarInterval) { @@ -142,7 +172,9 @@ public DateHistogramAggregationDescriptor CalendarInterval(Elastic.Cl } /// - /// Enables extending the bounds of the histogram beyond the data itself. + /// + /// Enables extending the bounds of the histogram beyond the data itself. + /// /// public DateHistogramAggregationDescriptor ExtendedBounds(Elastic.Clients.Elasticsearch.Aggregations.ExtendedBoundsDate? extendedBounds) { @@ -169,7 +201,9 @@ public DateHistogramAggregationDescriptor ExtendedBounds(Action - /// The date field whose values are use to build a histogram. + /// + /// The date field whose values are use to build a histogram. + /// /// public DateHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -178,7 +212,9 @@ public DateHistogramAggregationDescriptor Field(Elastic.Clients.Elast } /// - /// The date field whose values are use to build a histogram. + /// + /// The date field whose values are use to build a histogram. + /// /// public DateHistogramAggregationDescriptor Field(Expression> field) { @@ -187,7 +223,9 @@ public DateHistogramAggregationDescriptor Field(Expression - /// The date field whose values are use to build a histogram. + /// + /// The date field whose values are use to build a histogram. + /// /// public DateHistogramAggregationDescriptor Field(Expression> field) { @@ -196,7 +234,9 @@ public DateHistogramAggregationDescriptor Field(Expression - /// Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar. + /// + /// Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar. + /// /// public DateHistogramAggregationDescriptor FixedInterval(Elastic.Clients.Elasticsearch.Duration? fixedInterval) { @@ -205,7 +245,10 @@ public DateHistogramAggregationDescriptor FixedInterval(Elastic.Clien } /// - /// The date format used to format `key_as_string` in the response.
If no `format` is specified, the first date format specified in the field mapping is used. + /// + /// The date format used to format key_as_string in the response. + /// If no format is specified, the first date format specified in the field mapping is used. + /// /// public DateHistogramAggregationDescriptor Format(string? format) { @@ -214,7 +257,9 @@ public DateHistogramAggregationDescriptor Format(string? format) } /// - /// Limits the histogram to specified bounds. + /// + /// Limits the histogram to specified bounds. + /// /// public DateHistogramAggregationDescriptor HardBounds(Elastic.Clients.Elasticsearch.Aggregations.ExtendedBoundsDate? hardBounds) { @@ -241,7 +286,10 @@ public DateHistogramAggregationDescriptor HardBounds(Action - /// Only returns buckets that have `min_doc_count` number of documents.
By default, all buckets between the first bucket that matches documents and the last one are returned. + /// + /// Only returns buckets that have min_doc_count number of documents. + /// By default, all buckets between the first bucket that matches documents and the last one are returned. + /// /// public DateHistogramAggregationDescriptor MinDocCount(int? minDocCount) { @@ -250,7 +298,10 @@ public DateHistogramAggregationDescriptor MinDocCount(int? minDocCoun } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public DateHistogramAggregationDescriptor Missing(DateTimeOffset? missing) { @@ -259,7 +310,9 @@ public DateHistogramAggregationDescriptor Missing(DateTimeOffset? mis } /// - /// Changes the start value of each bucket by the specified positive (`+`) or negative offset (`-`) duration. + /// + /// Changes the start value of each bucket by the specified positive (+) or negative offset (-) duration. + /// /// public DateHistogramAggregationDescriptor Offset(Elastic.Clients.Elasticsearch.Duration? offset) { @@ -268,7 +321,9 @@ public DateHistogramAggregationDescriptor Offset(Elastic.Clients.Elas } /// - /// The sort order of the returned buckets. + /// + /// The sort order of the returned buckets. + /// /// public DateHistogramAggregationDescriptor Order(ICollection>? order) { @@ -307,7 +362,10 @@ public DateHistogramAggregationDescriptor Script(Action - /// Time zone used for bucketing and rounding.
Defaults to Coordinated Universal Time (UTC). + /// + /// Time zone used for bucketing and rounding. + /// Defaults to Coordinated Universal Time (UTC). + /// /// public DateHistogramAggregationDescriptor TimeZone(string? timeZone) { @@ -459,7 +517,10 @@ public DateHistogramAggregationDescriptor() : base() private string? TimeZoneValue { get; set; } /// - /// Calendar-aware interval.
Can be specified using the unit name, such as `month`, or as a single unit quantity, such as `1M`. + /// + /// Calendar-aware interval. + /// Can be specified using the unit name, such as month, or as a single unit quantity, such as 1M. + /// /// public DateHistogramAggregationDescriptor CalendarInterval(Elastic.Clients.Elasticsearch.Aggregations.CalendarInterval? calendarInterval) { @@ -468,7 +529,9 @@ public DateHistogramAggregationDescriptor CalendarInterval(Elastic.Clients.Elast } /// - /// Enables extending the bounds of the histogram beyond the data itself. + /// + /// Enables extending the bounds of the histogram beyond the data itself. + /// /// public DateHistogramAggregationDescriptor ExtendedBounds(Elastic.Clients.Elasticsearch.Aggregations.ExtendedBoundsDate? extendedBounds) { @@ -495,7 +558,9 @@ public DateHistogramAggregationDescriptor ExtendedBounds(Action - /// The date field whose values are use to build a histogram. + /// + /// The date field whose values are use to build a histogram. + /// /// public DateHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -504,7 +569,9 @@ public DateHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Fi } /// - /// The date field whose values are use to build a histogram. + /// + /// The date field whose values are use to build a histogram. + /// /// public DateHistogramAggregationDescriptor Field(Expression> field) { @@ -513,7 +580,9 @@ public DateHistogramAggregationDescriptor Field(Expression - /// The date field whose values are use to build a histogram. + /// + /// The date field whose values are use to build a histogram. + /// /// public DateHistogramAggregationDescriptor Field(Expression> field) { @@ -522,7 +591,9 @@ public DateHistogramAggregationDescriptor Field(Expression - /// Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar. + /// + /// Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar. + /// /// public DateHistogramAggregationDescriptor FixedInterval(Elastic.Clients.Elasticsearch.Duration? fixedInterval) { @@ -531,7 +602,10 @@ public DateHistogramAggregationDescriptor FixedInterval(Elastic.Clients.Elastics } /// - /// The date format used to format `key_as_string` in the response.
If no `format` is specified, the first date format specified in the field mapping is used. + /// + /// The date format used to format key_as_string in the response. + /// If no format is specified, the first date format specified in the field mapping is used. + /// /// public DateHistogramAggregationDescriptor Format(string? format) { @@ -540,7 +614,9 @@ public DateHistogramAggregationDescriptor Format(string? format) } /// - /// Limits the histogram to specified bounds. + /// + /// Limits the histogram to specified bounds. + /// /// public DateHistogramAggregationDescriptor HardBounds(Elastic.Clients.Elasticsearch.Aggregations.ExtendedBoundsDate? hardBounds) { @@ -567,7 +643,10 @@ public DateHistogramAggregationDescriptor HardBounds(Action - /// Only returns buckets that have `min_doc_count` number of documents.
By default, all buckets between the first bucket that matches documents and the last one are returned. + /// + /// Only returns buckets that have min_doc_count number of documents. + /// By default, all buckets between the first bucket that matches documents and the last one are returned. + /// /// public DateHistogramAggregationDescriptor MinDocCount(int? minDocCount) { @@ -576,7 +655,10 @@ public DateHistogramAggregationDescriptor MinDocCount(int? minDocCount) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public DateHistogramAggregationDescriptor Missing(DateTimeOffset? missing) { @@ -585,7 +667,9 @@ public DateHistogramAggregationDescriptor Missing(DateTimeOffset? missing) } /// - /// Changes the start value of each bucket by the specified positive (`+`) or negative offset (`-`) duration. + /// + /// Changes the start value of each bucket by the specified positive (+) or negative offset (-) duration. + /// /// public DateHistogramAggregationDescriptor Offset(Elastic.Clients.Elasticsearch.Duration? offset) { @@ -594,7 +678,9 @@ public DateHistogramAggregationDescriptor Offset(Elastic.Clients.Elasticsearch.D } /// - /// The sort order of the returned buckets. + /// + /// The sort order of the returned buckets. + /// /// public DateHistogramAggregationDescriptor Order(ICollection>? order) { @@ -633,7 +719,10 @@ public DateHistogramAggregationDescriptor Script(Action - /// Time zone used for bucketing and rounding.
Defaults to Coordinated Universal Time (UTC). + /// + /// Time zone used for bucketing and rounding. + /// Defaults to Coordinated Universal Time (UTC). + /// /// public DateHistogramAggregationDescriptor TimeZone(string? timeZone) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateHistogramBucket.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateHistogramBucket.g.cs index c35be0f08c5..1c4587a37dd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateHistogramBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateHistogramBucket.g.cs @@ -84,7 +84,9 @@ public override void Write(Utf8JsonWriter writer, DateHistogramBucket value, Jso public sealed partial class DateHistogramBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateRangeAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateRangeAggregate.g.cs index ced271ee75c..7c01bcdd83e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateRangeAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateRangeAggregate.g.cs @@ -28,7 +28,10 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; /// -/// Result of a `date_range` aggregation. Same format as a for a `range` aggregation: `from` and `to`
in `buckets` are milliseconds since the Epoch, represented as a floating point number. +/// +/// Result of a date_range aggregation. Same format as a for a range aggregation: from and to +/// in buckets are milliseconds since the Epoch, represented as a floating point number. +/// /// public sealed partial class DateRangeAggregate : IAggregate { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateRangeAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateRangeAggregation.g.cs index adfb42d3aa7..a7b33392e97 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateRangeAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateRangeAggregation.g.cs @@ -30,31 +30,42 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class DateRangeAggregation { /// - /// The date field whose values are use to build ranges. + /// + /// The date field whose values are use to build ranges. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } /// - /// The date format used to format `from` and `to` in the response. + /// + /// The date format used to format from and to in the response. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.FieldValue? Missing { get; set; } /// - /// Array of date ranges. + /// + /// Array of date ranges. + /// /// [JsonInclude, JsonPropertyName("ranges")] public ICollection? Ranges { get; set; } /// - /// Time zone used to convert dates from another time zone to UTC. + /// + /// Time zone used to convert dates from another time zone to UTC. + /// /// [JsonInclude, JsonPropertyName("time_zone")] public string? TimeZone { get; set; } @@ -80,7 +91,9 @@ public DateRangeAggregationDescriptor() : base() private string? TimeZoneValue { get; set; } /// - /// The date field whose values are use to build ranges. + /// + /// The date field whose values are use to build ranges. + /// /// public DateRangeAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -89,7 +102,9 @@ public DateRangeAggregationDescriptor Field(Elastic.Clients.Elasticse } /// - /// The date field whose values are use to build ranges. + /// + /// The date field whose values are use to build ranges. + /// /// public DateRangeAggregationDescriptor Field(Expression> field) { @@ -98,7 +113,9 @@ public DateRangeAggregationDescriptor Field(Expression - /// The date field whose values are use to build ranges. + /// + /// The date field whose values are use to build ranges. + /// /// public DateRangeAggregationDescriptor Field(Expression> field) { @@ -107,7 +124,9 @@ public DateRangeAggregationDescriptor Field(Expression - /// The date format used to format `from` and `to` in the response. + /// + /// The date format used to format from and to in the response. + /// /// public DateRangeAggregationDescriptor Format(string? format) { @@ -116,7 +135,10 @@ public DateRangeAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public DateRangeAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -125,7 +147,9 @@ public DateRangeAggregationDescriptor Missing(Elastic.Clients.Elastic } /// - /// Array of date ranges. + /// + /// Array of date ranges. + /// /// public DateRangeAggregationDescriptor Ranges(ICollection? ranges) { @@ -164,7 +188,9 @@ public DateRangeAggregationDescriptor Ranges(params Action - /// Time zone used to convert dates from another time zone to UTC. + /// + /// Time zone used to convert dates from another time zone to UTC. + /// /// public DateRangeAggregationDescriptor TimeZone(string? timeZone) { @@ -252,7 +278,9 @@ public DateRangeAggregationDescriptor() : base() private string? TimeZoneValue { get; set; } /// - /// The date field whose values are use to build ranges. + /// + /// The date field whose values are use to build ranges. + /// /// public DateRangeAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -261,7 +289,9 @@ public DateRangeAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? } /// - /// The date field whose values are use to build ranges. + /// + /// The date field whose values are use to build ranges. + /// /// public DateRangeAggregationDescriptor Field(Expression> field) { @@ -270,7 +300,9 @@ public DateRangeAggregationDescriptor Field(Expression - /// The date field whose values are use to build ranges. + /// + /// The date field whose values are use to build ranges. + /// /// public DateRangeAggregationDescriptor Field(Expression> field) { @@ -279,7 +311,9 @@ public DateRangeAggregationDescriptor Field(Expression - /// The date format used to format `from` and `to` in the response. + /// + /// The date format used to format from and to in the response. + /// /// public DateRangeAggregationDescriptor Format(string? format) { @@ -288,7 +322,10 @@ public DateRangeAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public DateRangeAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -297,7 +334,9 @@ public DateRangeAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Fiel } /// - /// Array of date ranges. + /// + /// Array of date ranges. + /// /// public DateRangeAggregationDescriptor Ranges(ICollection? ranges) { @@ -336,7 +375,9 @@ public DateRangeAggregationDescriptor Ranges(params Action - /// Time zone used to convert dates from another time zone to UTC. + /// + /// Time zone used to convert dates from another time zone to UTC. + /// /// public DateRangeAggregationDescriptor TimeZone(string? timeZone) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateRangeExpression.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateRangeExpression.g.cs index 419c5bde87f..08a25bf89b4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateRangeExpression.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateRangeExpression.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class DateRangeExpression { /// - /// Start of the range (inclusive). + /// + /// Start of the range (inclusive). + /// /// [JsonInclude, JsonPropertyName("from")] public Elastic.Clients.Elasticsearch.Aggregations.FieldDateMath? From { get; set; } /// - /// Custom key to return the range with. + /// + /// Custom key to return the range with. + /// /// [JsonInclude, JsonPropertyName("key")] public string? Key { get; set; } /// - /// End of the range (exclusive). + /// + /// End of the range (exclusive). + /// /// [JsonInclude, JsonPropertyName("to")] public Elastic.Clients.Elasticsearch.Aggregations.FieldDateMath? To { get; set; } @@ -61,7 +67,9 @@ public DateRangeExpressionDescriptor() : base() private Elastic.Clients.Elasticsearch.Aggregations.FieldDateMath? ToValue { get; set; } /// - /// Start of the range (inclusive). + /// + /// Start of the range (inclusive). + /// /// public DateRangeExpressionDescriptor From(Elastic.Clients.Elasticsearch.Aggregations.FieldDateMath? from) { @@ -70,7 +78,9 @@ public DateRangeExpressionDescriptor From(Elastic.Clients.Elasticsearch.Aggregat } /// - /// Custom key to return the range with. + /// + /// Custom key to return the range with. + /// /// public DateRangeExpressionDescriptor Key(string? key) { @@ -79,7 +89,9 @@ public DateRangeExpressionDescriptor Key(string? key) } /// - /// End of the range (exclusive). + /// + /// End of the range (exclusive). + /// /// public DateRangeExpressionDescriptor To(Elastic.Clients.Elasticsearch.Aggregations.FieldDateMath? to) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DerivativeAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DerivativeAggregate.g.cs index a003dec3f63..6773162c7ea 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DerivativeAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DerivativeAggregate.g.cs @@ -37,7 +37,10 @@ public sealed partial class DerivativeAggregate : IAggregate public string? NormalizedValueAsString { get; init; } /// - /// The metric value. A missing value generally means that there was no data to aggregate,
unless specified otherwise. + /// + /// The metric value. A missing value generally means that there was no data to aggregate, + /// unless specified otherwise. + /// /// [JsonInclude, JsonPropertyName("value")] public double? Value { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DerivativeAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DerivativeAggregation.g.cs index a235397f19e..60adc0b08dd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DerivativeAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DerivativeAggregation.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class DerivativeAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? GapPolicy { get; set; } @@ -63,7 +70,9 @@ public DerivativeAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? GapPolicyValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public DerivativeAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? bucketsPath) { @@ -72,7 +81,10 @@ public DerivativeAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public DerivativeAggregationDescriptor Format(string? format) { @@ -81,7 +93,9 @@ public DerivativeAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public DerivativeAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? gapPolicy) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DiversifiedSamplerAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DiversifiedSamplerAggregation.g.cs index 4f1fa362f16..8c4d8a5b40e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DiversifiedSamplerAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DiversifiedSamplerAggregation.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class DiversifiedSamplerAggregation { /// - /// The type of value used for de-duplication. + /// + /// The type of value used for de-duplication. + /// /// [JsonInclude, JsonPropertyName("execution_hint")] public Elastic.Clients.Elasticsearch.Aggregations.SamplerAggregationExecutionHint? ExecutionHint { get; set; } /// - /// The field used to provide values used for de-duplication. + /// + /// The field used to provide values used for de-duplication. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } /// - /// Limits how many documents are permitted per choice of de-duplicating value. + /// + /// Limits how many documents are permitted per choice of de-duplicating value. + /// /// [JsonInclude, JsonPropertyName("max_docs_per_value")] public int? MaxDocsPerValue { get; set; } @@ -50,7 +56,9 @@ public sealed partial class DiversifiedSamplerAggregation public Elastic.Clients.Elasticsearch.Script? Script { get; set; } /// - /// Limits how many top-scoring documents are collected in the sample processed on each shard. + /// + /// Limits how many top-scoring documents are collected in the sample processed on each shard. + /// /// [JsonInclude, JsonPropertyName("shard_size")] public int? ShardSize { get; set; } @@ -75,7 +83,9 @@ public DiversifiedSamplerAggregationDescriptor() : base() private int? ShardSizeValue { get; set; } /// - /// The type of value used for de-duplication. + /// + /// The type of value used for de-duplication. + /// /// public DiversifiedSamplerAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsearch.Aggregations.SamplerAggregationExecutionHint? executionHint) { @@ -84,7 +94,9 @@ public DiversifiedSamplerAggregationDescriptor ExecutionHint(Elastic. } /// - /// The field used to provide values used for de-duplication. + /// + /// The field used to provide values used for de-duplication. + /// /// public DiversifiedSamplerAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -93,7 +105,9 @@ public DiversifiedSamplerAggregationDescriptor Field(Elastic.Clients. } /// - /// The field used to provide values used for de-duplication. + /// + /// The field used to provide values used for de-duplication. + /// /// public DiversifiedSamplerAggregationDescriptor Field(Expression> field) { @@ -102,7 +116,9 @@ public DiversifiedSamplerAggregationDescriptor Field(Expressi } /// - /// The field used to provide values used for de-duplication. + /// + /// The field used to provide values used for de-duplication. + /// /// public DiversifiedSamplerAggregationDescriptor Field(Expression> field) { @@ -111,7 +127,9 @@ public DiversifiedSamplerAggregationDescriptor Field(Expression - /// Limits how many documents are permitted per choice of de-duplicating value. + /// + /// Limits how many documents are permitted per choice of de-duplicating value. + /// /// public DiversifiedSamplerAggregationDescriptor MaxDocsPerValue(int? maxDocsPerValue) { @@ -144,7 +162,9 @@ public DiversifiedSamplerAggregationDescriptor Script(Action - /// Limits how many top-scoring documents are collected in the sample processed on each shard. + /// + /// Limits how many top-scoring documents are collected in the sample processed on each shard. + /// /// public DiversifiedSamplerAggregationDescriptor ShardSize(int? shardSize) { @@ -216,7 +236,9 @@ public DiversifiedSamplerAggregationDescriptor() : base() private int? ShardSizeValue { get; set; } /// - /// The type of value used for de-duplication. + /// + /// The type of value used for de-duplication. + /// /// public DiversifiedSamplerAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsearch.Aggregations.SamplerAggregationExecutionHint? executionHint) { @@ -225,7 +247,9 @@ public DiversifiedSamplerAggregationDescriptor ExecutionHint(Elastic.Clients.Ela } /// - /// The field used to provide values used for de-duplication. + /// + /// The field used to provide values used for de-duplication. + /// /// public DiversifiedSamplerAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -234,7 +258,9 @@ public DiversifiedSamplerAggregationDescriptor Field(Elastic.Clients.Elasticsear } /// - /// The field used to provide values used for de-duplication. + /// + /// The field used to provide values used for de-duplication. + /// /// public DiversifiedSamplerAggregationDescriptor Field(Expression> field) { @@ -243,7 +269,9 @@ public DiversifiedSamplerAggregationDescriptor Field(Expressi } /// - /// The field used to provide values used for de-duplication. + /// + /// The field used to provide values used for de-duplication. + /// /// public DiversifiedSamplerAggregationDescriptor Field(Expression> field) { @@ -252,7 +280,9 @@ public DiversifiedSamplerAggregationDescriptor Field(Expression - /// Limits how many documents are permitted per choice of de-duplicating value. + /// + /// Limits how many documents are permitted per choice of de-duplicating value. + /// /// public DiversifiedSamplerAggregationDescriptor MaxDocsPerValue(int? maxDocsPerValue) { @@ -285,7 +315,9 @@ public DiversifiedSamplerAggregationDescriptor Script(Action - /// Limits how many top-scoring documents are collected in the sample processed on each shard. + /// + /// Limits how many top-scoring documents are collected in the sample processed on each shard. + /// /// public DiversifiedSamplerAggregationDescriptor ShardSize(int? shardSize) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DoubleTermsAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DoubleTermsAggregate.g.cs index 02b3177f06c..cab1c43b3f6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DoubleTermsAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DoubleTermsAggregate.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; /// -/// Result of a `terms` aggregation when the field is some kind of decimal number like a float, double, or distance. +/// +/// Result of a terms aggregation when the field is some kind of decimal number like a float, double, or distance. +/// /// public sealed partial class DoubleTermsAggregate : IAggregate { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DoubleTermsBucket.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DoubleTermsBucket.g.cs index 4f0693806b4..7b41be3afc5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DoubleTermsBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DoubleTermsBucket.g.cs @@ -91,7 +91,9 @@ public override void Write(Utf8JsonWriter writer, DoubleTermsBucket value, JsonS public sealed partial class DoubleTermsBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ExtendedBoundsDate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ExtendedBoundsDate.g.cs index 325c1685fd5..52f80df3091 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ExtendedBoundsDate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ExtendedBoundsDate.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class ExtendedBoundsDate { /// - /// Maximum value for the bound. + /// + /// Maximum value for the bound. + /// /// [JsonInclude, JsonPropertyName("max")] public Elastic.Clients.Elasticsearch.Aggregations.FieldDateMath? Max { get; set; } /// - /// Minimum value for the bound. + /// + /// Minimum value for the bound. + /// /// [JsonInclude, JsonPropertyName("min")] public Elastic.Clients.Elasticsearch.Aggregations.FieldDateMath? Min { get; set; } @@ -54,7 +58,9 @@ public ExtendedBoundsDateDescriptor() : base() private Elastic.Clients.Elasticsearch.Aggregations.FieldDateMath? MinValue { get; set; } /// - /// Maximum value for the bound. + /// + /// Maximum value for the bound. + /// /// public ExtendedBoundsDateDescriptor Max(Elastic.Clients.Elasticsearch.Aggregations.FieldDateMath? max) { @@ -63,7 +69,9 @@ public ExtendedBoundsDateDescriptor Max(Elastic.Clients.Elasticsearch.Aggregatio } /// - /// Minimum value for the bound. + /// + /// Minimum value for the bound. + /// /// public ExtendedBoundsDateDescriptor Min(Elastic.Clients.Elasticsearch.Aggregations.FieldDateMath? min) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ExtendedBoundsFloat.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ExtendedBoundsFloat.g.cs index b8b20fcb67a..8d642caa723 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ExtendedBoundsFloat.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ExtendedBoundsFloat.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class ExtendedBoundsFloat { /// - /// Maximum value for the bound. + /// + /// Maximum value for the bound. + /// /// [JsonInclude, JsonPropertyName("max")] public float? Max { get; set; } /// - /// Minimum value for the bound. + /// + /// Minimum value for the bound. + /// /// [JsonInclude, JsonPropertyName("min")] public float? Min { get; set; } @@ -54,7 +58,9 @@ public ExtendedBoundsFloatDescriptor() : base() private float? MinValue { get; set; } /// - /// Maximum value for the bound. + /// + /// Maximum value for the bound. + /// /// public ExtendedBoundsFloatDescriptor Max(float? max) { @@ -63,7 +69,9 @@ public ExtendedBoundsFloatDescriptor Max(float? max) } /// - /// Minimum value for the bound. + /// + /// Minimum value for the bound. + /// /// public ExtendedBoundsFloatDescriptor Min(float? min) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ExtendedStatsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ExtendedStatsAggregation.g.cs index ca030c1c2c4..05ce54ab37d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ExtendedStatsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ExtendedStatsAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class ExtendedStatsAggregation { /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } @@ -38,7 +40,10 @@ public sealed partial class ExtendedStatsAggregation public string? Format { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.FieldValue? Missing { get; set; } @@ -46,7 +51,9 @@ public sealed partial class ExtendedStatsAggregation public Elastic.Clients.Elasticsearch.Script? Script { get; set; } /// - /// The number of standard deviations above/below the mean to display. + /// + /// The number of standard deviations above/below the mean to display. + /// /// [JsonInclude, JsonPropertyName("sigma")] public double? Sigma { get; set; } @@ -71,7 +78,9 @@ public ExtendedStatsAggregationDescriptor() : base() private double? SigmaValue { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ExtendedStatsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -80,7 +89,9 @@ public ExtendedStatsAggregationDescriptor Field(Elastic.Clients.Elast } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ExtendedStatsAggregationDescriptor Field(Expression> field) { @@ -89,7 +100,9 @@ public ExtendedStatsAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ExtendedStatsAggregationDescriptor Field(Expression> field) { @@ -104,7 +117,10 @@ public ExtendedStatsAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public ExtendedStatsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -137,7 +153,9 @@ public ExtendedStatsAggregationDescriptor Script(Action - /// The number of standard deviations above/below the mean to display. + /// + /// The number of standard deviations above/below the mean to display. + /// /// public ExtendedStatsAggregationDescriptor Sigma(double? sigma) { @@ -209,7 +227,9 @@ public ExtendedStatsAggregationDescriptor() : base() private double? SigmaValue { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ExtendedStatsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -218,7 +238,9 @@ public ExtendedStatsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Fi } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ExtendedStatsAggregationDescriptor Field(Expression> field) { @@ -227,7 +249,9 @@ public ExtendedStatsAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ExtendedStatsAggregationDescriptor Field(Expression> field) { @@ -242,7 +266,10 @@ public ExtendedStatsAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public ExtendedStatsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -275,7 +302,9 @@ public ExtendedStatsAggregationDescriptor Script(Action - /// The number of standard deviations above/below the mean to display. + /// + /// The number of standard deviations above/below the mean to display. + /// /// public ExtendedStatsAggregationDescriptor Sigma(double? sigma) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ExtendedStatsBucketAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ExtendedStatsBucketAggregation.g.cs index 71f19ed653c..c4e7f55711a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ExtendedStatsBucketAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ExtendedStatsBucketAggregation.g.cs @@ -30,25 +30,34 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class ExtendedStatsBucketAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? GapPolicy { get; set; } /// - /// The number of standard deviations above/below the mean to display. + /// + /// The number of standard deviations above/below the mean to display. + /// /// [JsonInclude, JsonPropertyName("sigma")] public double? Sigma { get; set; } @@ -70,7 +79,9 @@ public ExtendedStatsBucketAggregationDescriptor() : base() private double? SigmaValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public ExtendedStatsBucketAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? bucketsPath) { @@ -79,7 +90,10 @@ public ExtendedStatsBucketAggregationDescriptor BucketsPath(Elastic.Clients.Elas } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public ExtendedStatsBucketAggregationDescriptor Format(string? format) { @@ -88,7 +102,9 @@ public ExtendedStatsBucketAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public ExtendedStatsBucketAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? gapPolicy) { @@ -97,7 +113,9 @@ public ExtendedStatsBucketAggregationDescriptor GapPolicy(Elastic.Clients.Elasti } /// - /// The number of standard deviations above/below the mean to display. + /// + /// The number of standard deviations above/below the mean to display. + /// /// public ExtendedStatsBucketAggregationDescriptor Sigma(double? sigma) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FieldDateMath.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FieldDateMath.g.cs index c86090484b5..1d37920bad0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FieldDateMath.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FieldDateMath.g.cs @@ -31,7 +31,10 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; /// -/// A date range limit, represented either as a DateMath expression or a number expressed
according to the target field's precision. +/// +/// A date range limit, represented either as a DateMath expression or a number expressed +/// according to the target field's precision. +/// /// public sealed partial class FieldDateMath : Union { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FilterAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FilterAggregate.g.cs index b441704f28f..20dac2acc0f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FilterAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FilterAggregate.g.cs @@ -77,7 +77,9 @@ public override void Write(Utf8JsonWriter writer, FilterAggregate value, JsonSer public sealed partial class FilterAggregate : IAggregate { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FiltersAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FiltersAggregation.g.cs index 1c905391a04..0f257ca25b2 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FiltersAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FiltersAggregation.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class FiltersAggregation { /// - /// Collection of queries from which to build buckets. + /// + /// Collection of queries from which to build buckets. + /// /// [JsonInclude, JsonPropertyName("filters")] public Elastic.Clients.Elasticsearch.Aggregations.Buckets? Filters { get; set; } /// - /// Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters. + /// + /// Set to true to add a bucket to the response which will contain all documents that do not match any of the given filters. + /// /// [JsonInclude, JsonPropertyName("other_bucket")] public bool? OtherBucket { get; set; } /// - /// The key with which the other bucket is returned. + /// + /// The key with which the other bucket is returned. + /// /// [JsonInclude, JsonPropertyName("other_bucket_key")] public string? OtherBucketKey { get; set; } @@ -63,7 +69,9 @@ public FiltersAggregationDescriptor() : base() private string? OtherBucketKeyValue { get; set; } /// - /// Collection of queries from which to build buckets. + /// + /// Collection of queries from which to build buckets. + /// /// public FiltersAggregationDescriptor Filters(Elastic.Clients.Elasticsearch.Aggregations.Buckets? filters) { @@ -72,7 +80,9 @@ public FiltersAggregationDescriptor Filters(Elastic.Clients.Elasticse } /// - /// Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters. + /// + /// Set to true to add a bucket to the response which will contain all documents that do not match any of the given filters. + /// /// public FiltersAggregationDescriptor OtherBucket(bool? otherBucket = true) { @@ -81,7 +91,9 @@ public FiltersAggregationDescriptor OtherBucket(bool? otherBucket = t } /// - /// The key with which the other bucket is returned. + /// + /// The key with which the other bucket is returned. + /// /// public FiltersAggregationDescriptor OtherBucketKey(string? otherBucketKey) { @@ -127,7 +139,9 @@ public FiltersAggregationDescriptor() : base() private string? OtherBucketKeyValue { get; set; } /// - /// Collection of queries from which to build buckets. + /// + /// Collection of queries from which to build buckets. + /// /// public FiltersAggregationDescriptor Filters(Elastic.Clients.Elasticsearch.Aggregations.Buckets? filters) { @@ -136,7 +150,9 @@ public FiltersAggregationDescriptor Filters(Elastic.Clients.Elasticsearch.Aggreg } /// - /// Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters. + /// + /// Set to true to add a bucket to the response which will contain all documents that do not match any of the given filters. + /// /// public FiltersAggregationDescriptor OtherBucket(bool? otherBucket = true) { @@ -145,7 +161,9 @@ public FiltersAggregationDescriptor OtherBucket(bool? otherBucket = true) } /// - /// The key with which the other bucket is returned. + /// + /// The key with which the other bucket is returned. + /// /// public FiltersAggregationDescriptor OtherBucketKey(string? otherBucketKey) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FiltersBucket.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FiltersBucket.g.cs index 74114646062..3551b48bfdb 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FiltersBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FiltersBucket.g.cs @@ -70,7 +70,9 @@ public override void Write(Utf8JsonWriter writer, FiltersBucket value, JsonSeria public sealed partial class FiltersBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FrequentItemSetsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FrequentItemSetsAggregation.g.cs index 71a49965742..7e90a6ceca1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FrequentItemSetsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FrequentItemSetsAggregation.g.cs @@ -30,31 +30,41 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class FrequentItemSetsAggregation { /// - /// Fields to analyze. + /// + /// Fields to analyze. + /// /// [JsonInclude, JsonPropertyName("fields")] public ICollection Fields { get; set; } /// - /// Query that filters documents from analysis. + /// + /// Query that filters documents from analysis. + /// /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Filter { get; set; } /// - /// The minimum size of one item set. + /// + /// The minimum size of one item set. + /// /// [JsonInclude, JsonPropertyName("minimum_set_size")] public int? MinimumSetSize { get; set; } /// - /// The minimum support of one item set. + /// + /// The minimum support of one item set. + /// /// [JsonInclude, JsonPropertyName("minimum_support")] public double? MinimumSupport { get; set; } /// - /// The number of top item sets to return. + /// + /// The number of top item sets to return. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } @@ -82,7 +92,9 @@ public FrequentItemSetsAggregationDescriptor() : base() private int? SizeValue { get; set; } /// - /// Fields to analyze. + /// + /// Fields to analyze. + /// /// public FrequentItemSetsAggregationDescriptor Fields(ICollection fields) { @@ -121,7 +133,9 @@ public FrequentItemSetsAggregationDescriptor Fields(params Action - /// Query that filters documents from analysis. + /// + /// Query that filters documents from analysis. + /// /// public FrequentItemSetsAggregationDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.Query? filter) { @@ -148,7 +162,9 @@ public FrequentItemSetsAggregationDescriptor Filter(Action - /// The minimum size of one item set. + /// + /// The minimum size of one item set. + /// /// public FrequentItemSetsAggregationDescriptor MinimumSetSize(int? minimumSetSize) { @@ -157,7 +173,9 @@ public FrequentItemSetsAggregationDescriptor MinimumSetSize(int? mini } /// - /// The minimum support of one item set. + /// + /// The minimum support of one item set. + /// /// public FrequentItemSetsAggregationDescriptor MinimumSupport(double? minimumSupport) { @@ -166,7 +184,9 @@ public FrequentItemSetsAggregationDescriptor MinimumSupport(double? m } /// - /// The number of top item sets to return. + /// + /// The number of top item sets to return. + /// /// public FrequentItemSetsAggregationDescriptor Size(int? size) { @@ -266,7 +286,9 @@ public FrequentItemSetsAggregationDescriptor() : base() private int? SizeValue { get; set; } /// - /// Fields to analyze. + /// + /// Fields to analyze. + /// /// public FrequentItemSetsAggregationDescriptor Fields(ICollection fields) { @@ -305,7 +327,9 @@ public FrequentItemSetsAggregationDescriptor Fields(params Action - /// Query that filters documents from analysis. + /// + /// Query that filters documents from analysis. + /// /// public FrequentItemSetsAggregationDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.Query? filter) { @@ -332,7 +356,9 @@ public FrequentItemSetsAggregationDescriptor Filter(Action - /// The minimum size of one item set. + /// + /// The minimum size of one item set. + /// /// public FrequentItemSetsAggregationDescriptor MinimumSetSize(int? minimumSetSize) { @@ -341,7 +367,9 @@ public FrequentItemSetsAggregationDescriptor MinimumSetSize(int? minimumSetSize) } /// - /// The minimum support of one item set. + /// + /// The minimum support of one item set. + /// /// public FrequentItemSetsAggregationDescriptor MinimumSupport(double? minimumSupport) { @@ -350,7 +378,9 @@ public FrequentItemSetsAggregationDescriptor MinimumSupport(double? minimumSuppo } /// - /// The number of top item sets to return. + /// + /// The number of top item sets to return. + /// /// public FrequentItemSetsAggregationDescriptor Size(int? size) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FrequentItemSetsBucket.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FrequentItemSetsBucket.g.cs index 1bda9e601e7..88ff41a35f0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FrequentItemSetsBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FrequentItemSetsBucket.g.cs @@ -84,7 +84,9 @@ public override void Write(Utf8JsonWriter writer, FrequentItemSetsBucket value, public sealed partial class FrequentItemSetsBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FrequentItemSetsField.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FrequentItemSetsField.g.cs index bf08d600056..82bfc4b407b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FrequentItemSetsField.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FrequentItemSetsField.g.cs @@ -30,7 +30,10 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class FrequentItemSetsField { /// - /// Values to exclude.
Can be regular expression strings or arrays of strings of exact terms. + /// + /// Values to exclude. + /// Can be regular expression strings or arrays of strings of exact terms. + /// /// [JsonInclude, JsonPropertyName("exclude")] public Elastic.Clients.Elasticsearch.Aggregations.TermsExclude? Exclude { get; set; } @@ -38,7 +41,10 @@ public sealed partial class FrequentItemSetsField public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Values to include.
Can be regular expression strings or arrays of strings of exact terms. + /// + /// Values to include. + /// Can be regular expression strings or arrays of strings of exact terms. + /// /// [JsonInclude, JsonPropertyName("include")] public Elastic.Clients.Elasticsearch.Aggregations.TermsInclude? Include { get; set; } @@ -57,7 +63,10 @@ public FrequentItemSetsFieldDescriptor() : base() private Elastic.Clients.Elasticsearch.Aggregations.TermsInclude? IncludeValue { get; set; } /// - /// Values to exclude.
Can be regular expression strings or arrays of strings of exact terms. + /// + /// Values to exclude. + /// Can be regular expression strings or arrays of strings of exact terms. + /// /// public FrequentItemSetsFieldDescriptor Exclude(Elastic.Clients.Elasticsearch.Aggregations.TermsExclude? exclude) { @@ -84,7 +93,10 @@ public FrequentItemSetsFieldDescriptor Field(Expression - /// Values to include.
Can be regular expression strings or arrays of strings of exact terms. + /// + /// Values to include. + /// Can be regular expression strings or arrays of strings of exact terms. + /// /// public FrequentItemSetsFieldDescriptor Include(Elastic.Clients.Elasticsearch.Aggregations.TermsInclude? include) { @@ -126,7 +138,10 @@ public FrequentItemSetsFieldDescriptor() : base() private Elastic.Clients.Elasticsearch.Aggregations.TermsInclude? IncludeValue { get; set; } /// - /// Values to exclude.
Can be regular expression strings or arrays of strings of exact terms. + /// + /// Values to exclude. + /// Can be regular expression strings or arrays of strings of exact terms. + /// /// public FrequentItemSetsFieldDescriptor Exclude(Elastic.Clients.Elasticsearch.Aggregations.TermsExclude? exclude) { @@ -153,7 +168,10 @@ public FrequentItemSetsFieldDescriptor Field(Expression - /// Values to include.
Can be regular expression strings or arrays of strings of exact terms. + /// + /// Values to include. + /// Can be regular expression strings or arrays of strings of exact terms. + /// /// public FrequentItemSetsFieldDescriptor Include(Elastic.Clients.Elasticsearch.Aggregations.TermsInclude? include) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoBoundsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoBoundsAggregation.g.cs index fa49254f3b5..1c51951de0e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoBoundsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoBoundsAggregation.g.cs @@ -30,13 +30,18 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class GeoBoundsAggregation { /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.FieldValue? Missing { get; set; } @@ -44,7 +49,9 @@ public sealed partial class GeoBoundsAggregation public Elastic.Clients.Elasticsearch.Script? Script { get; set; } /// - /// Specifies whether the bounding box should be allowed to overlap the international date line. + /// + /// Specifies whether the bounding box should be allowed to overlap the international date line. + /// /// [JsonInclude, JsonPropertyName("wrap_longitude")] public bool? WrapLongitude { get; set; } @@ -68,7 +75,9 @@ public GeoBoundsAggregationDescriptor() : base() private bool? WrapLongitudeValue { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public GeoBoundsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -77,7 +86,9 @@ public GeoBoundsAggregationDescriptor Field(Elastic.Clients.Elasticse } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public GeoBoundsAggregationDescriptor Field(Expression> field) { @@ -86,7 +97,9 @@ public GeoBoundsAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public GeoBoundsAggregationDescriptor Field(Expression> field) { @@ -95,7 +108,10 @@ public GeoBoundsAggregationDescriptor Field(Expression - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public GeoBoundsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -128,7 +144,9 @@ public GeoBoundsAggregationDescriptor Script(Action - /// Specifies whether the bounding box should be allowed to overlap the international date line. + /// + /// Specifies whether the bounding box should be allowed to overlap the international date line. + /// /// public GeoBoundsAggregationDescriptor WrapLongitude(bool? wrapLongitude = true) { @@ -193,7 +211,9 @@ public GeoBoundsAggregationDescriptor() : base() private bool? WrapLongitudeValue { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public GeoBoundsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -202,7 +222,9 @@ public GeoBoundsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public GeoBoundsAggregationDescriptor Field(Expression> field) { @@ -211,7 +233,9 @@ public GeoBoundsAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public GeoBoundsAggregationDescriptor Field(Expression> field) { @@ -220,7 +244,10 @@ public GeoBoundsAggregationDescriptor Field(Expression - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public GeoBoundsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -253,7 +280,9 @@ public GeoBoundsAggregationDescriptor Script(Action - /// Specifies whether the bounding box should be allowed to overlap the international date line. + /// + /// Specifies whether the bounding box should be allowed to overlap the international date line. + /// /// public GeoBoundsAggregationDescriptor WrapLongitude(bool? wrapLongitude = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoCentroidAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoCentroidAggregation.g.cs index 9de0a6a8ac4..4f7ccf8b05b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoCentroidAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoCentroidAggregation.g.cs @@ -33,7 +33,9 @@ public sealed partial class GeoCentroidAggregation public long? Count { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } @@ -41,7 +43,10 @@ public sealed partial class GeoCentroidAggregation public Elastic.Clients.Elasticsearch.GeoLocation? Location { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.FieldValue? Missing { get; set; } @@ -74,7 +79,9 @@ public GeoCentroidAggregationDescriptor Count(long? count) } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public GeoCentroidAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -83,7 +90,9 @@ public GeoCentroidAggregationDescriptor Field(Elastic.Clients.Elastic } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public GeoCentroidAggregationDescriptor Field(Expression> field) { @@ -92,7 +101,9 @@ public GeoCentroidAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public GeoCentroidAggregationDescriptor Field(Expression> field) { @@ -107,7 +118,10 @@ public GeoCentroidAggregationDescriptor Location(Elastic.Clients.Elas } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public GeoCentroidAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -209,7 +223,9 @@ public GeoCentroidAggregationDescriptor Count(long? count) } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public GeoCentroidAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -218,7 +234,9 @@ public GeoCentroidAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Fiel } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public GeoCentroidAggregationDescriptor Field(Expression> field) { @@ -227,7 +245,9 @@ public GeoCentroidAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public GeoCentroidAggregationDescriptor Field(Expression> field) { @@ -242,7 +262,10 @@ public GeoCentroidAggregationDescriptor Location(Elastic.Clients.Elasticsearch.G } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public GeoCentroidAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoDistanceAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoDistanceAggregate.g.cs index e4ffb22ff65..b3d316f4f5e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoDistanceAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoDistanceAggregate.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; /// -/// Result of a `geo_distance` aggregation. The unit for `from` and `to` is meters by default. +/// +/// Result of a geo_distance aggregation. The unit for from and to is meters by default. +/// /// public sealed partial class GeoDistanceAggregate : IAggregate { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoDistanceAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoDistanceAggregation.g.cs index c0ee48a89be..42cb774003a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoDistanceAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoDistanceAggregation.g.cs @@ -30,31 +30,41 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class GeoDistanceAggregation { /// - /// The distance calculation type. + /// + /// The distance calculation type. + /// /// [JsonInclude, JsonPropertyName("distance_type")] public Elastic.Clients.Elasticsearch.GeoDistanceType? DistanceType { get; set; } /// - /// A field of type `geo_point` used to evaluate the distance. + /// + /// A field of type geo_point used to evaluate the distance. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } /// - /// The origin used to evaluate the distance. + /// + /// The origin used to evaluate the distance. + /// /// [JsonInclude, JsonPropertyName("origin")] public Elastic.Clients.Elasticsearch.GeoLocation? Origin { get; set; } /// - /// An array of ranges used to bucket documents. + /// + /// An array of ranges used to bucket documents. + /// /// [JsonInclude, JsonPropertyName("ranges")] public ICollection? Ranges { get; set; } /// - /// The distance unit. + /// + /// The distance unit. + /// /// [JsonInclude, JsonPropertyName("unit")] public Elastic.Clients.Elasticsearch.DistanceUnit? Unit { get; set; } @@ -80,7 +90,9 @@ public GeoDistanceAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.DistanceUnit? UnitValue { get; set; } /// - /// The distance calculation type. + /// + /// The distance calculation type. + /// /// public GeoDistanceAggregationDescriptor DistanceType(Elastic.Clients.Elasticsearch.GeoDistanceType? distanceType) { @@ -89,7 +101,9 @@ public GeoDistanceAggregationDescriptor DistanceType(Elastic.Clients. } /// - /// A field of type `geo_point` used to evaluate the distance. + /// + /// A field of type geo_point used to evaluate the distance. + /// /// public GeoDistanceAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -98,7 +112,9 @@ public GeoDistanceAggregationDescriptor Field(Elastic.Clients.Elastic } /// - /// A field of type `geo_point` used to evaluate the distance. + /// + /// A field of type geo_point used to evaluate the distance. + /// /// public GeoDistanceAggregationDescriptor Field(Expression> field) { @@ -107,7 +123,9 @@ public GeoDistanceAggregationDescriptor Field(Expression - /// A field of type `geo_point` used to evaluate the distance. + /// + /// A field of type geo_point used to evaluate the distance. + /// /// public GeoDistanceAggregationDescriptor Field(Expression> field) { @@ -116,7 +134,9 @@ public GeoDistanceAggregationDescriptor Field(Expression - /// The origin used to evaluate the distance. + /// + /// The origin used to evaluate the distance. + /// /// public GeoDistanceAggregationDescriptor Origin(Elastic.Clients.Elasticsearch.GeoLocation? origin) { @@ -125,7 +145,9 @@ public GeoDistanceAggregationDescriptor Origin(Elastic.Clients.Elasti } /// - /// An array of ranges used to bucket documents. + /// + /// An array of ranges used to bucket documents. + /// /// public GeoDistanceAggregationDescriptor Ranges(ICollection? ranges) { @@ -164,7 +186,9 @@ public GeoDistanceAggregationDescriptor Ranges(params Action - /// The distance unit. + /// + /// The distance unit. + /// /// public GeoDistanceAggregationDescriptor Unit(Elastic.Clients.Elasticsearch.DistanceUnit? unit) { @@ -252,7 +276,9 @@ public GeoDistanceAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.DistanceUnit? UnitValue { get; set; } /// - /// The distance calculation type. + /// + /// The distance calculation type. + /// /// public GeoDistanceAggregationDescriptor DistanceType(Elastic.Clients.Elasticsearch.GeoDistanceType? distanceType) { @@ -261,7 +287,9 @@ public GeoDistanceAggregationDescriptor DistanceType(Elastic.Clients.Elasticsear } /// - /// A field of type `geo_point` used to evaluate the distance. + /// + /// A field of type geo_point used to evaluate the distance. + /// /// public GeoDistanceAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -270,7 +298,9 @@ public GeoDistanceAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Fiel } /// - /// A field of type `geo_point` used to evaluate the distance. + /// + /// A field of type geo_point used to evaluate the distance. + /// /// public GeoDistanceAggregationDescriptor Field(Expression> field) { @@ -279,7 +309,9 @@ public GeoDistanceAggregationDescriptor Field(Expression - /// A field of type `geo_point` used to evaluate the distance. + /// + /// A field of type geo_point used to evaluate the distance. + /// /// public GeoDistanceAggregationDescriptor Field(Expression> field) { @@ -288,7 +320,9 @@ public GeoDistanceAggregationDescriptor Field(Expression - /// The origin used to evaluate the distance. + /// + /// The origin used to evaluate the distance. + /// /// public GeoDistanceAggregationDescriptor Origin(Elastic.Clients.Elasticsearch.GeoLocation? origin) { @@ -297,7 +331,9 @@ public GeoDistanceAggregationDescriptor Origin(Elastic.Clients.Elasticsearch.Geo } /// - /// An array of ranges used to bucket documents. + /// + /// An array of ranges used to bucket documents. + /// /// public GeoDistanceAggregationDescriptor Ranges(ICollection? ranges) { @@ -336,7 +372,9 @@ public GeoDistanceAggregationDescriptor Ranges(params Action - /// The distance unit. + /// + /// The distance unit. + /// /// public GeoDistanceAggregationDescriptor Unit(Elastic.Clients.Elasticsearch.DistanceUnit? unit) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoLineAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoLineAggregation.g.cs index 18ec3bb8eed..2c70354932b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoLineAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoLineAggregation.g.cs @@ -30,31 +30,43 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class GeoLineAggregation { /// - /// When `true`, returns an additional array of the sort values in the feature properties. + /// + /// When true, returns an additional array of the sort values in the feature properties. + /// /// [JsonInclude, JsonPropertyName("include_sort")] public bool? IncludeSort { get; set; } /// - /// The name of the geo_point field. + /// + /// The name of the geo_point field. + /// /// [JsonInclude, JsonPropertyName("point")] public Elastic.Clients.Elasticsearch.Aggregations.GeoLinePoint Point { get; set; } /// - /// The maximum length of the line represented in the aggregation.
Valid sizes are between 1 and 10000. + /// + /// The maximum length of the line represented in the aggregation. + /// Valid sizes are between 1 and 10000. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// The name of the numeric field to use as the sort key for ordering the points.
When the `geo_line` aggregation is nested inside a `time_series` aggregation, this field defaults to `@timestamp`, and any other value will result in error. + /// + /// The name of the numeric field to use as the sort key for ordering the points. + /// When the geo_line aggregation is nested inside a time_series aggregation, this field defaults to @timestamp, and any other value will result in error. + /// /// [JsonInclude, JsonPropertyName("sort")] public Elastic.Clients.Elasticsearch.Aggregations.GeoLineSort Sort { get; set; } /// - /// The order in which the line is sorted (ascending or descending). + /// + /// The order in which the line is sorted (ascending or descending). + /// /// [JsonInclude, JsonPropertyName("sort_order")] public Elastic.Clients.Elasticsearch.SortOrder? SortOrder { get; set; } @@ -79,7 +91,9 @@ public GeoLineAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.SortOrder? SortOrderValue { get; set; } /// - /// When `true`, returns an additional array of the sort values in the feature properties. + /// + /// When true, returns an additional array of the sort values in the feature properties. + /// /// public GeoLineAggregationDescriptor IncludeSort(bool? includeSort = true) { @@ -88,7 +102,9 @@ public GeoLineAggregationDescriptor IncludeSort(bool? includeSort = t } /// - /// The name of the geo_point field. + /// + /// The name of the geo_point field. + /// /// public GeoLineAggregationDescriptor Point(Elastic.Clients.Elasticsearch.Aggregations.GeoLinePoint point) { @@ -115,7 +131,10 @@ public GeoLineAggregationDescriptor Point(Action - /// The maximum length of the line represented in the aggregation.
Valid sizes are between 1 and 10000. + /// + /// The maximum length of the line represented in the aggregation. + /// Valid sizes are between 1 and 10000. + /// /// public GeoLineAggregationDescriptor Size(int? size) { @@ -124,7 +143,10 @@ public GeoLineAggregationDescriptor Size(int? size) } /// - /// The name of the numeric field to use as the sort key for ordering the points.
When the `geo_line` aggregation is nested inside a `time_series` aggregation, this field defaults to `@timestamp`, and any other value will result in error. + /// + /// The name of the numeric field to use as the sort key for ordering the points. + /// When the geo_line aggregation is nested inside a time_series aggregation, this field defaults to @timestamp, and any other value will result in error. + /// /// public GeoLineAggregationDescriptor Sort(Elastic.Clients.Elasticsearch.Aggregations.GeoLineSort sort) { @@ -151,7 +173,9 @@ public GeoLineAggregationDescriptor Sort(Action - /// The order in which the line is sorted (ascending or descending). + /// + /// The order in which the line is sorted (ascending or descending). + /// /// public GeoLineAggregationDescriptor SortOrder(Elastic.Clients.Elasticsearch.SortOrder? sortOrder) { @@ -235,7 +259,9 @@ public GeoLineAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.SortOrder? SortOrderValue { get; set; } /// - /// When `true`, returns an additional array of the sort values in the feature properties. + /// + /// When true, returns an additional array of the sort values in the feature properties. + /// /// public GeoLineAggregationDescriptor IncludeSort(bool? includeSort = true) { @@ -244,7 +270,9 @@ public GeoLineAggregationDescriptor IncludeSort(bool? includeSort = true) } /// - /// The name of the geo_point field. + /// + /// The name of the geo_point field. + /// /// public GeoLineAggregationDescriptor Point(Elastic.Clients.Elasticsearch.Aggregations.GeoLinePoint point) { @@ -271,7 +299,10 @@ public GeoLineAggregationDescriptor Point(Action - /// The maximum length of the line represented in the aggregation.
Valid sizes are between 1 and 10000. + /// + /// The maximum length of the line represented in the aggregation. + /// Valid sizes are between 1 and 10000. + /// /// public GeoLineAggregationDescriptor Size(int? size) { @@ -280,7 +311,10 @@ public GeoLineAggregationDescriptor Size(int? size) } /// - /// The name of the numeric field to use as the sort key for ordering the points.
When the `geo_line` aggregation is nested inside a `time_series` aggregation, this field defaults to `@timestamp`, and any other value will result in error. + /// + /// The name of the numeric field to use as the sort key for ordering the points. + /// When the geo_line aggregation is nested inside a time_series aggregation, this field defaults to @timestamp, and any other value will result in error. + /// /// public GeoLineAggregationDescriptor Sort(Elastic.Clients.Elasticsearch.Aggregations.GeoLineSort sort) { @@ -307,7 +341,9 @@ public GeoLineAggregationDescriptor Sort(Action - /// The order in which the line is sorted (ascending or descending). + /// + /// The order in which the line is sorted (ascending or descending). + /// /// public GeoLineAggregationDescriptor SortOrder(Elastic.Clients.Elasticsearch.SortOrder? sortOrder) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoLinePoint.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoLinePoint.g.cs index 467e14abe96..3800c0f8963 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoLinePoint.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoLinePoint.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class GeoLinePoint { /// - /// The name of the geo_point field. + /// + /// The name of the geo_point field. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } @@ -47,7 +49,9 @@ public GeoLinePointDescriptor() : base() private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } /// - /// The name of the geo_point field. + /// + /// The name of the geo_point field. + /// /// public GeoLinePointDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -56,7 +60,9 @@ public GeoLinePointDescriptor Field(Elastic.Clients.Elasticsearch.Fie } /// - /// The name of the geo_point field. + /// + /// The name of the geo_point field. + /// /// public GeoLinePointDescriptor Field(Expression> field) { @@ -65,7 +71,9 @@ public GeoLinePointDescriptor Field(Expression - /// The name of the geo_point field. + /// + /// The name of the geo_point field. + /// /// public GeoLinePointDescriptor Field(Expression> field) { @@ -93,7 +101,9 @@ public GeoLinePointDescriptor() : base() private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } /// - /// The name of the geo_point field. + /// + /// The name of the geo_point field. + /// /// public GeoLinePointDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -102,7 +112,9 @@ public GeoLinePointDescriptor Field(Elastic.Clients.Elasticsearch.Field field) } /// - /// The name of the geo_point field. + /// + /// The name of the geo_point field. + /// /// public GeoLinePointDescriptor Field(Expression> field) { @@ -111,7 +123,9 @@ public GeoLinePointDescriptor Field(Expression - /// The name of the geo_point field. + /// + /// The name of the geo_point field. + /// /// public GeoLinePointDescriptor Field(Expression> field) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoLineSort.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoLineSort.g.cs index abe11727992..6cccb6934e7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoLineSort.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoLineSort.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class GeoLineSort { /// - /// The name of the numeric field to use as the sort key for ordering the points. + /// + /// The name of the numeric field to use as the sort key for ordering the points. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } @@ -47,7 +49,9 @@ public GeoLineSortDescriptor() : base() private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } /// - /// The name of the numeric field to use as the sort key for ordering the points. + /// + /// The name of the numeric field to use as the sort key for ordering the points. + /// /// public GeoLineSortDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -56,7 +60,9 @@ public GeoLineSortDescriptor Field(Elastic.Clients.Elasticsearch.Fiel } /// - /// The name of the numeric field to use as the sort key for ordering the points. + /// + /// The name of the numeric field to use as the sort key for ordering the points. + /// /// public GeoLineSortDescriptor Field(Expression> field) { @@ -65,7 +71,9 @@ public GeoLineSortDescriptor Field(Expression - /// The name of the numeric field to use as the sort key for ordering the points. + /// + /// The name of the numeric field to use as the sort key for ordering the points. + /// /// public GeoLineSortDescriptor Field(Expression> field) { @@ -93,7 +101,9 @@ public GeoLineSortDescriptor() : base() private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } /// - /// The name of the numeric field to use as the sort key for ordering the points. + /// + /// The name of the numeric field to use as the sort key for ordering the points. + /// /// public GeoLineSortDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -102,7 +112,9 @@ public GeoLineSortDescriptor Field(Elastic.Clients.Elasticsearch.Field field) } /// - /// The name of the numeric field to use as the sort key for ordering the points. + /// + /// The name of the numeric field to use as the sort key for ordering the points. + /// /// public GeoLineSortDescriptor Field(Expression> field) { @@ -111,7 +123,9 @@ public GeoLineSortDescriptor Field(Expression - /// The name of the numeric field to use as the sort key for ordering the points. + /// + /// The name of the numeric field to use as the sort key for ordering the points. + /// /// public GeoLineSortDescriptor Field(Expression> field) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeohashGridAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeohashGridAggregation.g.cs index 1431e944bc1..964185a3020 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeohashGridAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeohashGridAggregation.g.cs @@ -30,31 +30,43 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class GeohashGridAggregation { /// - /// The bounding box to filter the points in each bucket. + /// + /// The bounding box to filter the points in each bucket. + /// /// [JsonInclude, JsonPropertyName("bounds")] public Elastic.Clients.Elasticsearch.GeoBounds? Bounds { get; set; } /// - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohash_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geohash_grid aggregates all array values. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } /// - /// The string length of the geohashes used to define cells/buckets in the results. + /// + /// The string length of the geohashes used to define cells/buckets in the results. + /// /// [JsonInclude, JsonPropertyName("precision")] public Elastic.Clients.Elasticsearch.GeohashPrecision? Precision { get; set; } /// - /// Allows for more accurate counting of the top cells returned in the final result the aggregation.
Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. + /// + /// Allows for more accurate counting of the top cells returned in the final result the aggregation. + /// Defaults to returning max(10,(size x number-of-shards)) buckets from each shard. + /// /// [JsonInclude, JsonPropertyName("shard_size")] public int? ShardSize { get; set; } /// - /// The maximum number of geohash buckets to return. + /// + /// The maximum number of geohash buckets to return. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } @@ -77,7 +89,9 @@ public GeohashGridAggregationDescriptor() : base() private int? SizeValue { get; set; } /// - /// The bounding box to filter the points in each bucket. + /// + /// The bounding box to filter the points in each bucket. + /// /// public GeohashGridAggregationDescriptor Bounds(Elastic.Clients.Elasticsearch.GeoBounds? bounds) { @@ -86,7 +100,10 @@ public GeohashGridAggregationDescriptor Bounds(Elastic.Clients.Elasti } /// - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohash_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geohash_grid aggregates all array values. + /// /// public GeohashGridAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -95,7 +112,10 @@ public GeohashGridAggregationDescriptor Field(Elastic.Clients.Elastic } /// - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohash_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geohash_grid aggregates all array values. + /// /// public GeohashGridAggregationDescriptor Field(Expression> field) { @@ -104,7 +124,10 @@ public GeohashGridAggregationDescriptor Field(Expression - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohash_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geohash_grid aggregates all array values. + /// /// public GeohashGridAggregationDescriptor Field(Expression> field) { @@ -113,7 +136,9 @@ public GeohashGridAggregationDescriptor Field(Expression - /// The string length of the geohashes used to define cells/buckets in the results. + /// + /// The string length of the geohashes used to define cells/buckets in the results. + /// /// public GeohashGridAggregationDescriptor Precision(Elastic.Clients.Elasticsearch.GeohashPrecision? precision) { @@ -122,7 +147,10 @@ public GeohashGridAggregationDescriptor Precision(Elastic.Clients.Ela } /// - /// Allows for more accurate counting of the top cells returned in the final result the aggregation.
Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. + /// + /// Allows for more accurate counting of the top cells returned in the final result the aggregation. + /// Defaults to returning max(10,(size x number-of-shards)) buckets from each shard. + /// /// public GeohashGridAggregationDescriptor ShardSize(int? shardSize) { @@ -131,7 +159,9 @@ public GeohashGridAggregationDescriptor ShardSize(int? shardSize) } /// - /// The maximum number of geohash buckets to return. + /// + /// The maximum number of geohash buckets to return. + /// /// public GeohashGridAggregationDescriptor Size(int? size) { @@ -191,7 +221,9 @@ public GeohashGridAggregationDescriptor() : base() private int? SizeValue { get; set; } /// - /// The bounding box to filter the points in each bucket. + /// + /// The bounding box to filter the points in each bucket. + /// /// public GeohashGridAggregationDescriptor Bounds(Elastic.Clients.Elasticsearch.GeoBounds? bounds) { @@ -200,7 +232,10 @@ public GeohashGridAggregationDescriptor Bounds(Elastic.Clients.Elasticsearch.Geo } /// - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohash_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geohash_grid aggregates all array values. + /// /// public GeohashGridAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -209,7 +244,10 @@ public GeohashGridAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Fiel } /// - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohash_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geohash_grid aggregates all array values. + /// /// public GeohashGridAggregationDescriptor Field(Expression> field) { @@ -218,7 +256,10 @@ public GeohashGridAggregationDescriptor Field(Expression - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohash_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geohash_grid aggregates all array values. + /// /// public GeohashGridAggregationDescriptor Field(Expression> field) { @@ -227,7 +268,9 @@ public GeohashGridAggregationDescriptor Field(Expression - /// The string length of the geohashes used to define cells/buckets in the results. + /// + /// The string length of the geohashes used to define cells/buckets in the results. + /// /// public GeohashGridAggregationDescriptor Precision(Elastic.Clients.Elasticsearch.GeohashPrecision? precision) { @@ -236,7 +279,10 @@ public GeohashGridAggregationDescriptor Precision(Elastic.Clients.Elasticsearch. } /// - /// Allows for more accurate counting of the top cells returned in the final result the aggregation.
Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. + /// + /// Allows for more accurate counting of the top cells returned in the final result the aggregation. + /// Defaults to returning max(10,(size x number-of-shards)) buckets from each shard. + /// /// public GeohashGridAggregationDescriptor ShardSize(int? shardSize) { @@ -245,7 +291,9 @@ public GeohashGridAggregationDescriptor ShardSize(int? shardSize) } /// - /// The maximum number of geohash buckets to return. + /// + /// The maximum number of geohash buckets to return. + /// /// public GeohashGridAggregationDescriptor Size(int? size) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeohashGridBucket.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeohashGridBucket.g.cs index 8afc6c8acb4..8a8a6bc482c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeohashGridBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeohashGridBucket.g.cs @@ -77,7 +77,9 @@ public override void Write(Utf8JsonWriter writer, GeohashGridBucket value, JsonS public sealed partial class GeohashGridBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeohexGridAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeohexGridAggregation.g.cs index a1d3cc77361..658aeeb8cdb 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeohexGridAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeohexGridAggregation.g.cs @@ -30,31 +30,43 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class GeohexGridAggregation { /// - /// Bounding box used to filter the geo-points in each bucket. + /// + /// Bounding box used to filter the geo-points in each bucket. + /// /// [JsonInclude, JsonPropertyName("bounds")] public Elastic.Clients.Elasticsearch.GeoBounds? Bounds { get; set; } /// - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohex_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geohex_grid aggregates all array values. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Integer zoom of the key used to defined cells or buckets
in the results. Value should be between 0-15. + /// + /// Integer zoom of the key used to defined cells or buckets + /// in the results. Value should be between 0-15. + /// /// [JsonInclude, JsonPropertyName("precision")] public int? Precision { get; set; } /// - /// Number of buckets returned from each shard. + /// + /// Number of buckets returned from each shard. + /// /// [JsonInclude, JsonPropertyName("shard_size")] public int? ShardSize { get; set; } /// - /// Maximum number of buckets to return. + /// + /// Maximum number of buckets to return. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } @@ -77,7 +89,9 @@ public GeohexGridAggregationDescriptor() : base() private int? SizeValue { get; set; } /// - /// Bounding box used to filter the geo-points in each bucket. + /// + /// Bounding box used to filter the geo-points in each bucket. + /// /// public GeohexGridAggregationDescriptor Bounds(Elastic.Clients.Elasticsearch.GeoBounds? bounds) { @@ -86,7 +100,10 @@ public GeohexGridAggregationDescriptor Bounds(Elastic.Clients.Elastic } /// - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohex_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geohex_grid aggregates all array values. + /// /// public GeohexGridAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -95,7 +112,10 @@ public GeohexGridAggregationDescriptor Field(Elastic.Clients.Elastics } /// - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohex_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geohex_grid aggregates all array values. + /// /// public GeohexGridAggregationDescriptor Field(Expression> field) { @@ -104,7 +124,10 @@ public GeohexGridAggregationDescriptor Field(Expression - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohex_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geohex_grid aggregates all array values. + /// /// public GeohexGridAggregationDescriptor Field(Expression> field) { @@ -113,7 +136,10 @@ public GeohexGridAggregationDescriptor Field(Expression - /// Integer zoom of the key used to defined cells or buckets
in the results. Value should be between 0-15. + /// + /// Integer zoom of the key used to defined cells or buckets + /// in the results. Value should be between 0-15. + /// /// public GeohexGridAggregationDescriptor Precision(int? precision) { @@ -122,7 +148,9 @@ public GeohexGridAggregationDescriptor Precision(int? precision) } /// - /// Number of buckets returned from each shard. + /// + /// Number of buckets returned from each shard. + /// /// public GeohexGridAggregationDescriptor ShardSize(int? shardSize) { @@ -131,7 +159,9 @@ public GeohexGridAggregationDescriptor ShardSize(int? shardSize) } /// - /// Maximum number of buckets to return. + /// + /// Maximum number of buckets to return. + /// /// public GeohexGridAggregationDescriptor Size(int? size) { @@ -187,7 +217,9 @@ public GeohexGridAggregationDescriptor() : base() private int? SizeValue { get; set; } /// - /// Bounding box used to filter the geo-points in each bucket. + /// + /// Bounding box used to filter the geo-points in each bucket. + /// /// public GeohexGridAggregationDescriptor Bounds(Elastic.Clients.Elasticsearch.GeoBounds? bounds) { @@ -196,7 +228,10 @@ public GeohexGridAggregationDescriptor Bounds(Elastic.Clients.Elasticsearch.GeoB } /// - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohex_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geohex_grid aggregates all array values. + /// /// public GeohexGridAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -205,7 +240,10 @@ public GeohexGridAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field } /// - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohex_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geohex_grid aggregates all array values. + /// /// public GeohexGridAggregationDescriptor Field(Expression> field) { @@ -214,7 +252,10 @@ public GeohexGridAggregationDescriptor Field(Expression - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohex_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geohex_grid aggregates all array values. + /// /// public GeohexGridAggregationDescriptor Field(Expression> field) { @@ -223,7 +264,10 @@ public GeohexGridAggregationDescriptor Field(Expression - /// Integer zoom of the key used to defined cells or buckets
in the results. Value should be between 0-15. + /// + /// Integer zoom of the key used to defined cells or buckets + /// in the results. Value should be between 0-15. + /// /// public GeohexGridAggregationDescriptor Precision(int? precision) { @@ -232,7 +276,9 @@ public GeohexGridAggregationDescriptor Precision(int? precision) } /// - /// Number of buckets returned from each shard. + /// + /// Number of buckets returned from each shard. + /// /// public GeohexGridAggregationDescriptor ShardSize(int? shardSize) { @@ -241,7 +287,9 @@ public GeohexGridAggregationDescriptor ShardSize(int? shardSize) } /// - /// Maximum number of buckets to return. + /// + /// Maximum number of buckets to return. + /// /// public GeohexGridAggregationDescriptor Size(int? size) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeohexGridBucket.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeohexGridBucket.g.cs index 8ade2177d76..4863f027671 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeohexGridBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeohexGridBucket.g.cs @@ -77,7 +77,9 @@ public override void Write(Utf8JsonWriter writer, GeohexGridBucket value, JsonSe public sealed partial class GeohexGridBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeotileGridAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeotileGridAggregation.g.cs index 1e6111fa89a..3c76309dae2 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeotileGridAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeotileGridAggregation.g.cs @@ -30,31 +30,44 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class GeotileGridAggregation { /// - /// A bounding box to filter the geo-points or geo-shapes in each bucket. + /// + /// A bounding box to filter the geo-points or geo-shapes in each bucket. + /// /// [JsonInclude, JsonPropertyName("bounds")] public Elastic.Clients.Elasticsearch.GeoBounds? Bounds { get; set; } /// - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geotile_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geotile_grid aggregates all array values. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } /// - /// Integer zoom of the key used to define cells/buckets in the results.
Values outside of the range [0,29] will be rejected. + /// + /// Integer zoom of the key used to define cells/buckets in the results. + /// Values outside of the range [0,29] will be rejected. + /// /// [JsonInclude, JsonPropertyName("precision")] public double? Precision { get; set; } /// - /// Allows for more accurate counting of the top cells returned in the final result the aggregation.
Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. + /// + /// Allows for more accurate counting of the top cells returned in the final result the aggregation. + /// Defaults to returning max(10,(size x number-of-shards)) buckets from each shard. + /// /// [JsonInclude, JsonPropertyName("shard_size")] public int? ShardSize { get; set; } /// - /// The maximum number of buckets to return. + /// + /// The maximum number of buckets to return. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } @@ -78,7 +91,9 @@ public GeotileGridAggregationDescriptor() : base() private int? SizeValue { get; set; } /// - /// A bounding box to filter the geo-points or geo-shapes in each bucket. + /// + /// A bounding box to filter the geo-points or geo-shapes in each bucket. + /// /// public GeotileGridAggregationDescriptor Bounds(Elastic.Clients.Elasticsearch.GeoBounds? bounds) { @@ -87,7 +102,10 @@ public GeotileGridAggregationDescriptor Bounds(Elastic.Clients.Elasti } /// - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geotile_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geotile_grid aggregates all array values. + /// /// public GeotileGridAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -96,7 +114,10 @@ public GeotileGridAggregationDescriptor Field(Elastic.Clients.Elastic } /// - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geotile_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geotile_grid aggregates all array values. + /// /// public GeotileGridAggregationDescriptor Field(Expression> field) { @@ -105,7 +126,10 @@ public GeotileGridAggregationDescriptor Field(Expression - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geotile_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geotile_grid aggregates all array values. + /// /// public GeotileGridAggregationDescriptor Field(Expression> field) { @@ -114,7 +138,10 @@ public GeotileGridAggregationDescriptor Field(Expression - /// Integer zoom of the key used to define cells/buckets in the results.
Values outside of the range [0,29] will be rejected. + /// + /// Integer zoom of the key used to define cells/buckets in the results. + /// Values outside of the range [0,29] will be rejected. + /// /// public GeotileGridAggregationDescriptor Precision(double? precision) { @@ -123,7 +150,10 @@ public GeotileGridAggregationDescriptor Precision(double? precision) } /// - /// Allows for more accurate counting of the top cells returned in the final result the aggregation.
Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. + /// + /// Allows for more accurate counting of the top cells returned in the final result the aggregation. + /// Defaults to returning max(10,(size x number-of-shards)) buckets from each shard. + /// /// public GeotileGridAggregationDescriptor ShardSize(int? shardSize) { @@ -132,7 +162,9 @@ public GeotileGridAggregationDescriptor ShardSize(int? shardSize) } /// - /// The maximum number of buckets to return. + /// + /// The maximum number of buckets to return. + /// /// public GeotileGridAggregationDescriptor Size(int? size) { @@ -192,7 +224,9 @@ public GeotileGridAggregationDescriptor() : base() private int? SizeValue { get; set; } /// - /// A bounding box to filter the geo-points or geo-shapes in each bucket. + /// + /// A bounding box to filter the geo-points or geo-shapes in each bucket. + /// /// public GeotileGridAggregationDescriptor Bounds(Elastic.Clients.Elasticsearch.GeoBounds? bounds) { @@ -201,7 +235,10 @@ public GeotileGridAggregationDescriptor Bounds(Elastic.Clients.Elasticsearch.Geo } /// - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geotile_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geotile_grid aggregates all array values. + /// /// public GeotileGridAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -210,7 +247,10 @@ public GeotileGridAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Fiel } /// - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geotile_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geotile_grid aggregates all array values. + /// /// public GeotileGridAggregationDescriptor Field(Expression> field) { @@ -219,7 +259,10 @@ public GeotileGridAggregationDescriptor Field(Expression - /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geotile_grid` aggregates all array values. + /// + /// Field containing indexed geo_point or geo_shape values. + /// If the field contains an array, geotile_grid aggregates all array values. + /// /// public GeotileGridAggregationDescriptor Field(Expression> field) { @@ -228,7 +271,10 @@ public GeotileGridAggregationDescriptor Field(Expression - /// Integer zoom of the key used to define cells/buckets in the results.
Values outside of the range [0,29] will be rejected. + /// + /// Integer zoom of the key used to define cells/buckets in the results. + /// Values outside of the range [0,29] will be rejected. + /// /// public GeotileGridAggregationDescriptor Precision(double? precision) { @@ -237,7 +283,10 @@ public GeotileGridAggregationDescriptor Precision(double? precision) } /// - /// Allows for more accurate counting of the top cells returned in the final result the aggregation.
Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. + /// + /// Allows for more accurate counting of the top cells returned in the final result the aggregation. + /// Defaults to returning max(10,(size x number-of-shards)) buckets from each shard. + /// /// public GeotileGridAggregationDescriptor ShardSize(int? shardSize) { @@ -246,7 +295,9 @@ public GeotileGridAggregationDescriptor ShardSize(int? shardSize) } /// - /// The maximum number of buckets to return. + /// + /// The maximum number of buckets to return. + /// /// public GeotileGridAggregationDescriptor Size(int? size) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeotileGridBucket.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeotileGridBucket.g.cs index c3046f22f92..8c03fbf568d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeotileGridBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeotileGridBucket.g.cs @@ -77,7 +77,9 @@ public override void Write(Utf8JsonWriter writer, GeotileGridBucket value, JsonS public sealed partial class GeotileGridBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GlobalAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GlobalAggregate.g.cs index 3abc0ec6ae5..6ba1c78191d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GlobalAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GlobalAggregate.g.cs @@ -77,7 +77,9 @@ public override void Write(Utf8JsonWriter writer, GlobalAggregate value, JsonSer public sealed partial class GlobalAggregate : IAggregate { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GoogleNormalizedDistanceHeuristic.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GoogleNormalizedDistanceHeuristic.g.cs index 892bcf25808..725f20b364a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GoogleNormalizedDistanceHeuristic.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GoogleNormalizedDistanceHeuristic.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class GoogleNormalizedDistanceHeuristic { /// - /// Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. + /// + /// Set to false if you defined a custom background filter that represents a different set of documents that you want to compare to. + /// /// [JsonInclude, JsonPropertyName("background_is_superset")] public bool? BackgroundIsSuperset { get; set; } @@ -47,7 +49,9 @@ public GoogleNormalizedDistanceHeuristicDescriptor() : base() private bool? BackgroundIsSupersetValue { get; set; } /// - /// Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. + /// + /// Set to false if you defined a custom background filter that represents a different set of documents that you want to compare to. + /// /// public GoogleNormalizedDistanceHeuristicDescriptor BackgroundIsSuperset(bool? backgroundIsSuperset = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/HdrMethod.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/HdrMethod.g.cs index 2ec10b55d2a..b52e346f43e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/HdrMethod.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/HdrMethod.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class HdrMethod { /// - /// Specifies the resolution of values for the histogram in number of significant digits. + /// + /// Specifies the resolution of values for the histogram in number of significant digits. + /// /// [JsonInclude, JsonPropertyName("number_of_significant_value_digits")] public int? NumberOfSignificantValueDigits { get; set; } @@ -47,7 +49,9 @@ public HdrMethodDescriptor() : base() private int? NumberOfSignificantValueDigitsValue { get; set; } /// - /// Specifies the resolution of values for the histogram in number of significant digits. + /// + /// Specifies the resolution of values for the histogram in number of significant digits. + /// /// public HdrMethodDescriptor NumberOfSignificantValueDigits(int? numberOfSignificantValueDigits) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/HistogramAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/HistogramAggregation.g.cs index c7c7855c064..cd3c90e0d08 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/HistogramAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/HistogramAggregation.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class HistogramAggregation { /// - /// Enables extending the bounds of the histogram beyond the data itself. + /// + /// Enables extending the bounds of the histogram beyond the data itself. + /// /// [JsonInclude, JsonPropertyName("extended_bounds")] public Elastic.Clients.Elasticsearch.Aggregations.ExtendedBoundsFloat? ExtendedBounds { get; set; } /// - /// The name of the field to aggregate on. + /// + /// The name of the field to aggregate on. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } @@ -44,37 +48,55 @@ public sealed partial class HistogramAggregation public string? Format { get; set; } /// - /// Limits the range of buckets in the histogram.
It is particularly useful in the case of open data ranges that can result in a very large number of buckets. + /// + /// Limits the range of buckets in the histogram. + /// It is particularly useful in the case of open data ranges that can result in a very large number of buckets. + /// /// [JsonInclude, JsonPropertyName("hard_bounds")] public Elastic.Clients.Elasticsearch.Aggregations.ExtendedBoundsFloat? HardBounds { get; set; } /// - /// The interval for the buckets.
Must be a positive decimal. + /// + /// The interval for the buckets. + /// Must be a positive decimal. + /// /// [JsonInclude, JsonPropertyName("interval")] public double? Interval { get; set; } /// - /// Only returns buckets that have `min_doc_count` number of documents.
By default, the response will fill gaps in the histogram with empty buckets. + /// + /// Only returns buckets that have min_doc_count number of documents. + /// By default, the response will fill gaps in the histogram with empty buckets. + /// /// [JsonInclude, JsonPropertyName("min_doc_count")] public int? MinDocCount { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public double? Missing { get; set; } /// - /// By default, the bucket keys start with 0 and then continue in even spaced steps of `interval`.
The bucket boundaries can be shifted by using the `offset` option. + /// + /// By default, the bucket keys start with 0 and then continue in even spaced steps of interval. + /// The bucket boundaries can be shifted by using the offset option. + /// /// [JsonInclude, JsonPropertyName("offset")] public double? Offset { get; set; } /// - /// The sort order of the returned buckets.
By default, the returned buckets are sorted by their key ascending. + /// + /// The sort order of the returned buckets. + /// By default, the returned buckets are sorted by their key ascending. + /// /// [JsonInclude, JsonPropertyName("order")] [SingleOrManyCollectionConverter(typeof(KeyValuePair))] @@ -112,7 +134,9 @@ public HistogramAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// Enables extending the bounds of the histogram beyond the data itself. + /// + /// Enables extending the bounds of the histogram beyond the data itself. + /// /// public HistogramAggregationDescriptor ExtendedBounds(Elastic.Clients.Elasticsearch.Aggregations.ExtendedBoundsFloat? extendedBounds) { @@ -139,7 +163,9 @@ public HistogramAggregationDescriptor ExtendedBounds(Action - /// The name of the field to aggregate on. + /// + /// The name of the field to aggregate on. + /// /// public HistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -148,7 +174,9 @@ public HistogramAggregationDescriptor Field(Elastic.Clients.Elasticse } /// - /// The name of the field to aggregate on. + /// + /// The name of the field to aggregate on. + /// /// public HistogramAggregationDescriptor Field(Expression> field) { @@ -157,7 +185,9 @@ public HistogramAggregationDescriptor Field(Expression - /// The name of the field to aggregate on. + /// + /// The name of the field to aggregate on. + /// /// public HistogramAggregationDescriptor Field(Expression> field) { @@ -172,7 +202,10 @@ public HistogramAggregationDescriptor Format(string? format) } /// - /// Limits the range of buckets in the histogram.
It is particularly useful in the case of open data ranges that can result in a very large number of buckets. + /// + /// Limits the range of buckets in the histogram. + /// It is particularly useful in the case of open data ranges that can result in a very large number of buckets. + /// /// public HistogramAggregationDescriptor HardBounds(Elastic.Clients.Elasticsearch.Aggregations.ExtendedBoundsFloat? hardBounds) { @@ -199,7 +232,10 @@ public HistogramAggregationDescriptor HardBounds(Action - /// The interval for the buckets.
Must be a positive decimal. + /// + /// The interval for the buckets. + /// Must be a positive decimal. + /// /// public HistogramAggregationDescriptor Interval(double? interval) { @@ -208,7 +244,10 @@ public HistogramAggregationDescriptor Interval(double? interval) } /// - /// Only returns buckets that have `min_doc_count` number of documents.
By default, the response will fill gaps in the histogram with empty buckets. + /// + /// Only returns buckets that have min_doc_count number of documents. + /// By default, the response will fill gaps in the histogram with empty buckets. + /// /// public HistogramAggregationDescriptor MinDocCount(int? minDocCount) { @@ -217,7 +256,10 @@ public HistogramAggregationDescriptor MinDocCount(int? minDocCount) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public HistogramAggregationDescriptor Missing(double? missing) { @@ -226,7 +268,10 @@ public HistogramAggregationDescriptor Missing(double? missing) } /// - /// By default, the bucket keys start with 0 and then continue in even spaced steps of `interval`.
The bucket boundaries can be shifted by using the `offset` option. + /// + /// By default, the bucket keys start with 0 and then continue in even spaced steps of interval. + /// The bucket boundaries can be shifted by using the offset option. + /// /// public HistogramAggregationDescriptor Offset(double? offset) { @@ -235,7 +280,10 @@ public HistogramAggregationDescriptor Offset(double? offset) } /// - /// The sort order of the returned buckets.
By default, the returned buckets are sorted by their key ascending. + /// + /// The sort order of the returned buckets. + /// By default, the returned buckets are sorted by their key ascending. + /// /// public HistogramAggregationDescriptor Order(ICollection>? order) { @@ -390,7 +438,9 @@ public HistogramAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// Enables extending the bounds of the histogram beyond the data itself. + /// + /// Enables extending the bounds of the histogram beyond the data itself. + /// /// public HistogramAggregationDescriptor ExtendedBounds(Elastic.Clients.Elasticsearch.Aggregations.ExtendedBoundsFloat? extendedBounds) { @@ -417,7 +467,9 @@ public HistogramAggregationDescriptor ExtendedBounds(Action - /// The name of the field to aggregate on. + /// + /// The name of the field to aggregate on. + /// /// public HistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -426,7 +478,9 @@ public HistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? } /// - /// The name of the field to aggregate on. + /// + /// The name of the field to aggregate on. + /// /// public HistogramAggregationDescriptor Field(Expression> field) { @@ -435,7 +489,9 @@ public HistogramAggregationDescriptor Field(Expression - /// The name of the field to aggregate on. + /// + /// The name of the field to aggregate on. + /// /// public HistogramAggregationDescriptor Field(Expression> field) { @@ -450,7 +506,10 @@ public HistogramAggregationDescriptor Format(string? format) } /// - /// Limits the range of buckets in the histogram.
It is particularly useful in the case of open data ranges that can result in a very large number of buckets. + /// + /// Limits the range of buckets in the histogram. + /// It is particularly useful in the case of open data ranges that can result in a very large number of buckets. + /// /// public HistogramAggregationDescriptor HardBounds(Elastic.Clients.Elasticsearch.Aggregations.ExtendedBoundsFloat? hardBounds) { @@ -477,7 +536,10 @@ public HistogramAggregationDescriptor HardBounds(Action - /// The interval for the buckets.
Must be a positive decimal. + /// + /// The interval for the buckets. + /// Must be a positive decimal. + /// /// public HistogramAggregationDescriptor Interval(double? interval) { @@ -486,7 +548,10 @@ public HistogramAggregationDescriptor Interval(double? interval) } /// - /// Only returns buckets that have `min_doc_count` number of documents.
By default, the response will fill gaps in the histogram with empty buckets. + /// + /// Only returns buckets that have min_doc_count number of documents. + /// By default, the response will fill gaps in the histogram with empty buckets. + /// /// public HistogramAggregationDescriptor MinDocCount(int? minDocCount) { @@ -495,7 +560,10 @@ public HistogramAggregationDescriptor MinDocCount(int? minDocCount) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public HistogramAggregationDescriptor Missing(double? missing) { @@ -504,7 +572,10 @@ public HistogramAggregationDescriptor Missing(double? missing) } /// - /// By default, the bucket keys start with 0 and then continue in even spaced steps of `interval`.
The bucket boundaries can be shifted by using the `offset` option. + /// + /// By default, the bucket keys start with 0 and then continue in even spaced steps of interval. + /// The bucket boundaries can be shifted by using the offset option. + /// /// public HistogramAggregationDescriptor Offset(double? offset) { @@ -513,7 +584,10 @@ public HistogramAggregationDescriptor Offset(double? offset) } /// - /// The sort order of the returned buckets.
By default, the returned buckets are sorted by their key ascending. + /// + /// The sort order of the returned buckets. + /// By default, the returned buckets are sorted by their key ascending. + /// /// public HistogramAggregationDescriptor Order(ICollection>? order) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/HistogramBucket.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/HistogramBucket.g.cs index 25fa6901a3f..e1641587177 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/HistogramBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/HistogramBucket.g.cs @@ -84,7 +84,9 @@ public override void Write(Utf8JsonWriter writer, HistogramBucket value, JsonSer public sealed partial class HistogramBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/InferenceAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/InferenceAggregate.g.cs index 385f6342927..19e7421f99a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/InferenceAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/InferenceAggregate.g.cs @@ -93,7 +93,9 @@ public override void Write(Utf8JsonWriter writer, InferenceAggregate value, Json public sealed partial class InferenceAggregate : IAggregate { /// - /// Additional data + /// + /// Additional data + /// /// public IReadOnlyDictionary Data { get; init; } public IReadOnlyCollection? FeatureImportance { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/InferenceAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/InferenceAggregation.g.cs index a4e7fdbc96a..f1c1f7af2de 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/InferenceAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/InferenceAggregation.g.cs @@ -30,31 +30,42 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class InferenceAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? GapPolicy { get; set; } /// - /// Contains the inference type and its options. + /// + /// Contains the inference type and its options. + /// /// [JsonInclude, JsonPropertyName("inference_config")] public Elastic.Clients.Elasticsearch.Aggregations.InferenceConfig? InferenceConfig { get; set; } /// - /// The ID or alias for the trained model. + /// + /// The ID or alias for the trained model. + /// /// [JsonInclude, JsonPropertyName("model_id")] public Elastic.Clients.Elasticsearch.Name ModelId { get; set; } @@ -79,7 +90,9 @@ public InferenceAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Name ModelIdValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public InferenceAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? bucketsPath) { @@ -88,7 +101,10 @@ public InferenceAggregationDescriptor BucketsPath(Elastic.Clients.Ela } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public InferenceAggregationDescriptor Format(string? format) { @@ -97,7 +113,9 @@ public InferenceAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public InferenceAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? gapPolicy) { @@ -106,7 +124,9 @@ public InferenceAggregationDescriptor GapPolicy(Elastic.Clients.Elast } /// - /// Contains the inference type and its options. + /// + /// Contains the inference type and its options. + /// /// public InferenceAggregationDescriptor InferenceConfig(Elastic.Clients.Elasticsearch.Aggregations.InferenceConfig? inferenceConfig) { @@ -133,7 +153,9 @@ public InferenceAggregationDescriptor InferenceConfig(Action - /// The ID or alias for the trained model. + /// + /// The ID or alias for the trained model. + /// /// public InferenceAggregationDescriptor ModelId(Elastic.Clients.Elasticsearch.Name modelId) { @@ -201,7 +223,9 @@ public InferenceAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Name ModelIdValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public InferenceAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? bucketsPath) { @@ -210,7 +234,10 @@ public InferenceAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch. } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public InferenceAggregationDescriptor Format(string? format) { @@ -219,7 +246,9 @@ public InferenceAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public InferenceAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? gapPolicy) { @@ -228,7 +257,9 @@ public InferenceAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Ag } /// - /// Contains the inference type and its options. + /// + /// Contains the inference type and its options. + /// /// public InferenceAggregationDescriptor InferenceConfig(Elastic.Clients.Elasticsearch.Aggregations.InferenceConfig? inferenceConfig) { @@ -255,7 +286,9 @@ public InferenceAggregationDescriptor InferenceConfig(Action - /// The ID or alias for the trained model. + /// + /// The ID or alias for the trained model. + /// /// public InferenceAggregationDescriptor ModelId(Elastic.Clients.Elasticsearch.Name modelId) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpPrefixAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpPrefixAggregation.g.cs index 8b5080d41d0..4ef58f528ef 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpPrefixAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpPrefixAggregation.g.cs @@ -30,31 +30,42 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class IpPrefixAggregation { /// - /// Defines whether the prefix length is appended to IP address keys in the response. + /// + /// Defines whether the prefix length is appended to IP address keys in the response. + /// /// [JsonInclude, JsonPropertyName("append_prefix_length")] public bool? AppendPrefixLength { get; set; } /// - /// The IP address field to aggregation on. The field mapping type must be `ip`. + /// + /// The IP address field to aggregation on. The field mapping type must be ip. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Defines whether the prefix applies to IPv6 addresses. + /// + /// Defines whether the prefix applies to IPv6 addresses. + /// /// [JsonInclude, JsonPropertyName("is_ipv6")] public bool? IsIpv6 { get; set; } /// - /// Minimum number of documents in a bucket for it to be included in the response. + /// + /// Minimum number of documents in a bucket for it to be included in the response. + /// /// [JsonInclude, JsonPropertyName("min_doc_count")] public long? MinDocCount { get; set; } /// - /// Length of the network prefix. For IPv4 addresses the accepted range is [0, 32].
For IPv6 addresses the accepted range is [0, 128]. + /// + /// Length of the network prefix. For IPv4 addresses the accepted range is [0, 32]. + /// For IPv6 addresses the accepted range is [0, 128]. + /// /// [JsonInclude, JsonPropertyName("prefix_length")] public int PrefixLength { get; set; } @@ -77,7 +88,9 @@ public IpPrefixAggregationDescriptor() : base() private int PrefixLengthValue { get; set; } /// - /// Defines whether the prefix length is appended to IP address keys in the response. + /// + /// Defines whether the prefix length is appended to IP address keys in the response. + /// /// public IpPrefixAggregationDescriptor AppendPrefixLength(bool? appendPrefixLength = true) { @@ -86,7 +99,9 @@ public IpPrefixAggregationDescriptor AppendPrefixLength(bool? appendP } /// - /// The IP address field to aggregation on. The field mapping type must be `ip`. + /// + /// The IP address field to aggregation on. The field mapping type must be ip. + /// /// public IpPrefixAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -95,7 +110,9 @@ public IpPrefixAggregationDescriptor Field(Elastic.Clients.Elasticsea } /// - /// The IP address field to aggregation on. The field mapping type must be `ip`. + /// + /// The IP address field to aggregation on. The field mapping type must be ip. + /// /// public IpPrefixAggregationDescriptor Field(Expression> field) { @@ -104,7 +121,9 @@ public IpPrefixAggregationDescriptor Field(Expression - /// The IP address field to aggregation on. The field mapping type must be `ip`. + /// + /// The IP address field to aggregation on. The field mapping type must be ip. + /// /// public IpPrefixAggregationDescriptor Field(Expression> field) { @@ -113,7 +132,9 @@ public IpPrefixAggregationDescriptor Field(Expression - /// Defines whether the prefix applies to IPv6 addresses. + /// + /// Defines whether the prefix applies to IPv6 addresses. + /// /// public IpPrefixAggregationDescriptor IsIpv6(bool? isIpv6 = true) { @@ -122,7 +143,9 @@ public IpPrefixAggregationDescriptor IsIpv6(bool? isIpv6 = true) } /// - /// Minimum number of documents in a bucket for it to be included in the response. + /// + /// Minimum number of documents in a bucket for it to be included in the response. + /// /// public IpPrefixAggregationDescriptor MinDocCount(long? minDocCount) { @@ -131,7 +154,10 @@ public IpPrefixAggregationDescriptor MinDocCount(long? minDocCount) } /// - /// Length of the network prefix. For IPv4 addresses the accepted range is [0, 32].
For IPv6 addresses the accepted range is [0, 128]. + /// + /// Length of the network prefix. For IPv4 addresses the accepted range is [0, 32]. + /// For IPv6 addresses the accepted range is [0, 128]. + /// /// public IpPrefixAggregationDescriptor PrefixLength(int prefixLength) { @@ -183,7 +209,9 @@ public IpPrefixAggregationDescriptor() : base() private int PrefixLengthValue { get; set; } /// - /// Defines whether the prefix length is appended to IP address keys in the response. + /// + /// Defines whether the prefix length is appended to IP address keys in the response. + /// /// public IpPrefixAggregationDescriptor AppendPrefixLength(bool? appendPrefixLength = true) { @@ -192,7 +220,9 @@ public IpPrefixAggregationDescriptor AppendPrefixLength(bool? appendPrefixLength } /// - /// The IP address field to aggregation on. The field mapping type must be `ip`. + /// + /// The IP address field to aggregation on. The field mapping type must be ip. + /// /// public IpPrefixAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -201,7 +231,9 @@ public IpPrefixAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field f } /// - /// The IP address field to aggregation on. The field mapping type must be `ip`. + /// + /// The IP address field to aggregation on. The field mapping type must be ip. + /// /// public IpPrefixAggregationDescriptor Field(Expression> field) { @@ -210,7 +242,9 @@ public IpPrefixAggregationDescriptor Field(Expression - /// The IP address field to aggregation on. The field mapping type must be `ip`. + /// + /// The IP address field to aggregation on. The field mapping type must be ip. + /// /// public IpPrefixAggregationDescriptor Field(Expression> field) { @@ -219,7 +253,9 @@ public IpPrefixAggregationDescriptor Field(Expression - /// Defines whether the prefix applies to IPv6 addresses. + /// + /// Defines whether the prefix applies to IPv6 addresses. + /// /// public IpPrefixAggregationDescriptor IsIpv6(bool? isIpv6 = true) { @@ -228,7 +264,9 @@ public IpPrefixAggregationDescriptor IsIpv6(bool? isIpv6 = true) } /// - /// Minimum number of documents in a bucket for it to be included in the response. + /// + /// Minimum number of documents in a bucket for it to be included in the response. + /// /// public IpPrefixAggregationDescriptor MinDocCount(long? minDocCount) { @@ -237,7 +275,10 @@ public IpPrefixAggregationDescriptor MinDocCount(long? minDocCount) } /// - /// Length of the network prefix. For IPv4 addresses the accepted range is [0, 32].
For IPv6 addresses the accepted range is [0, 128]. + /// + /// Length of the network prefix. For IPv4 addresses the accepted range is [0, 32]. + /// For IPv6 addresses the accepted range is [0, 128]. + /// /// public IpPrefixAggregationDescriptor PrefixLength(int prefixLength) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpPrefixBucket.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpPrefixBucket.g.cs index 1951ce3aff7..e03c5122173 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpPrefixBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpPrefixBucket.g.cs @@ -98,7 +98,9 @@ public override void Write(Utf8JsonWriter writer, IpPrefixBucket value, JsonSeri public sealed partial class IpPrefixBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpRangeAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpRangeAggregation.g.cs index 5eecd393048..c00cc402c45 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpRangeAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpRangeAggregation.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class IpRangeAggregation { /// - /// The date field whose values are used to build ranges. + /// + /// The date field whose values are used to build ranges. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } /// - /// Array of IP ranges. + /// + /// Array of IP ranges. + /// /// [JsonInclude, JsonPropertyName("ranges")] public ICollection? Ranges { get; set; } @@ -59,7 +63,9 @@ public IpRangeAggregationDescriptor() : base() private Action[] RangesDescriptorActions { get; set; } /// - /// The date field whose values are used to build ranges. + /// + /// The date field whose values are used to build ranges. + /// /// public IpRangeAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -68,7 +74,9 @@ public IpRangeAggregationDescriptor Field(Elastic.Clients.Elasticsear } /// - /// The date field whose values are used to build ranges. + /// + /// The date field whose values are used to build ranges. + /// /// public IpRangeAggregationDescriptor Field(Expression> field) { @@ -77,7 +85,9 @@ public IpRangeAggregationDescriptor Field(Expression - /// The date field whose values are used to build ranges. + /// + /// The date field whose values are used to build ranges. + /// /// public IpRangeAggregationDescriptor Field(Expression> field) { @@ -86,7 +96,9 @@ public IpRangeAggregationDescriptor Field(Expression - /// Array of IP ranges. + /// + /// Array of IP ranges. + /// /// public IpRangeAggregationDescriptor Ranges(ICollection? ranges) { @@ -183,7 +195,9 @@ public IpRangeAggregationDescriptor() : base() private Action[] RangesDescriptorActions { get; set; } /// - /// The date field whose values are used to build ranges. + /// + /// The date field whose values are used to build ranges. + /// /// public IpRangeAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -192,7 +206,9 @@ public IpRangeAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? f } /// - /// The date field whose values are used to build ranges. + /// + /// The date field whose values are used to build ranges. + /// /// public IpRangeAggregationDescriptor Field(Expression> field) { @@ -201,7 +217,9 @@ public IpRangeAggregationDescriptor Field(Expression - /// The date field whose values are used to build ranges. + /// + /// The date field whose values are used to build ranges. + /// /// public IpRangeAggregationDescriptor Field(Expression> field) { @@ -210,7 +228,9 @@ public IpRangeAggregationDescriptor Field(Expression - /// Array of IP ranges. + /// + /// Array of IP ranges. + /// /// public IpRangeAggregationDescriptor Ranges(ICollection? ranges) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpRangeAggregationRange.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpRangeAggregationRange.g.cs index 22713397185..e54995c1ddc 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpRangeAggregationRange.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpRangeAggregationRange.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class IpRangeAggregationRange { /// - /// Start of the range. + /// + /// Start of the range. + /// /// [JsonInclude, JsonPropertyName("from")] public string? From { get; set; } /// - /// IP range defined as a CIDR mask. + /// + /// IP range defined as a CIDR mask. + /// /// [JsonInclude, JsonPropertyName("mask")] public string? Mask { get; set; } /// - /// End of the range. + /// + /// End of the range. + /// /// [JsonInclude, JsonPropertyName("to")] public string? To { get; set; } @@ -61,7 +67,9 @@ public IpRangeAggregationRangeDescriptor() : base() private string? ToValue { get; set; } /// - /// Start of the range. + /// + /// Start of the range. + /// /// public IpRangeAggregationRangeDescriptor From(string? from) { @@ -70,7 +78,9 @@ public IpRangeAggregationRangeDescriptor From(string? from) } /// - /// IP range defined as a CIDR mask. + /// + /// IP range defined as a CIDR mask. + /// /// public IpRangeAggregationRangeDescriptor Mask(string? mask) { @@ -79,7 +89,9 @@ public IpRangeAggregationRangeDescriptor Mask(string? mask) } /// - /// End of the range. + /// + /// End of the range. + /// /// public IpRangeAggregationRangeDescriptor To(string? to) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpRangeBucket.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpRangeBucket.g.cs index 52d15d17247..ea2b231722d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpRangeBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpRangeBucket.g.cs @@ -91,7 +91,9 @@ public override void Write(Utf8JsonWriter writer, IpRangeBucket value, JsonSeria public sealed partial class IpRangeBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/LongRareTermsAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/LongRareTermsAggregate.g.cs index 1905d7aae1f..13fa685df54 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/LongRareTermsAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/LongRareTermsAggregate.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; /// -/// Result of the `rare_terms` aggregation when the field is some kind of whole number like a integer, long, or a date. +/// +/// Result of the rare_terms aggregation when the field is some kind of whole number like a integer, long, or a date. +/// /// public sealed partial class LongRareTermsAggregate : IAggregate { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/LongRareTermsBucket.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/LongRareTermsBucket.g.cs index b7ff5d5bf10..11dc48330e5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/LongRareTermsBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/LongRareTermsBucket.g.cs @@ -84,7 +84,9 @@ public override void Write(Utf8JsonWriter writer, LongRareTermsBucket value, Jso public sealed partial class LongRareTermsBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/LongTermsAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/LongTermsAggregate.g.cs index 6ce24c9bf9a..11c3ad82fae 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/LongTermsAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/LongTermsAggregate.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; /// -/// Result of a `terms` aggregation when the field is some kind of whole number like a integer, long, or a date. +/// +/// Result of a terms aggregation when the field is some kind of whole number like a integer, long, or a date. +/// /// public sealed partial class LongTermsAggregate : IAggregate { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/LongTermsBucket.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/LongTermsBucket.g.cs index 67a084ff82f..e6e6265dbfa 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/LongTermsBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/LongTermsBucket.g.cs @@ -91,7 +91,9 @@ public override void Write(Utf8JsonWriter writer, LongTermsBucket value, JsonSer public sealed partial class LongTermsBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MatrixStatsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MatrixStatsAggregation.g.cs index ea7e1d83c30..db56e60d7af 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MatrixStatsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MatrixStatsAggregation.g.cs @@ -30,20 +30,27 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class MatrixStatsAggregation { /// - /// An array of fields for computing the statistics. + /// + /// An array of fields for computing the statistics. + /// /// [JsonInclude, JsonPropertyName("fields")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] public Elastic.Clients.Elasticsearch.Fields? Fields { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public IDictionary? Missing { get; set; } /// - /// Array value the aggregation will use for array or multi-valued fields. + /// + /// Array value the aggregation will use for array or multi-valued fields. + /// /// [JsonInclude, JsonPropertyName("mode")] public Elastic.Clients.Elasticsearch.SortMode? Mode { get; set; } @@ -64,7 +71,9 @@ public MatrixStatsAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.SortMode? ModeValue { get; set; } /// - /// An array of fields for computing the statistics. + /// + /// An array of fields for computing the statistics. + /// /// public MatrixStatsAggregationDescriptor Fields(Elastic.Clients.Elasticsearch.Fields? fields) { @@ -73,7 +82,10 @@ public MatrixStatsAggregationDescriptor Fields(Elastic.Clients.Elasti } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public MatrixStatsAggregationDescriptor Missing(Func, FluentDictionary> selector) { @@ -82,7 +94,9 @@ public MatrixStatsAggregationDescriptor Missing(Func - /// Array value the aggregation will use for array or multi-valued fields. + /// + /// Array value the aggregation will use for array or multi-valued fields. + /// /// public MatrixStatsAggregationDescriptor Mode(Elastic.Clients.Elasticsearch.SortMode? mode) { @@ -128,7 +142,9 @@ public MatrixStatsAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.SortMode? ModeValue { get; set; } /// - /// An array of fields for computing the statistics. + /// + /// An array of fields for computing the statistics. + /// /// public MatrixStatsAggregationDescriptor Fields(Elastic.Clients.Elasticsearch.Fields? fields) { @@ -137,7 +153,10 @@ public MatrixStatsAggregationDescriptor Fields(Elastic.Clients.Elasticsearch.Fie } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public MatrixStatsAggregationDescriptor Missing(Func, FluentDictionary> selector) { @@ -146,7 +165,9 @@ public MatrixStatsAggregationDescriptor Missing(Func - /// Array value the aggregation will use for array or multi-valued fields. + /// + /// Array value the aggregation will use for array or multi-valued fields. + /// /// public MatrixStatsAggregationDescriptor Mode(Elastic.Clients.Elasticsearch.SortMode? mode) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MaxAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MaxAggregate.g.cs index 366cc29ff0c..cddda334221 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MaxAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MaxAggregate.g.cs @@ -33,7 +33,10 @@ public sealed partial class MaxAggregate : IAggregate public IReadOnlyDictionary? Meta { get; init; } /// - /// The metric value. A missing value generally means that there was no data to aggregate,
unless specified otherwise. + /// + /// The metric value. A missing value generally means that there was no data to aggregate, + /// unless specified otherwise. + /// /// [JsonInclude, JsonPropertyName("value")] public double? Value { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MaxAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MaxAggregation.g.cs index c6129261344..1d145ce30ef 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MaxAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MaxAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class MaxAggregation { /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } @@ -38,7 +40,10 @@ public sealed partial class MaxAggregation public string? Format { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.FieldValue? Missing { get; set; } @@ -64,7 +69,9 @@ public MaxAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MaxAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -73,7 +80,9 @@ public MaxAggregationDescriptor Field(Elastic.Clients.Elasticsearch.F } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MaxAggregationDescriptor Field(Expression> field) { @@ -82,7 +91,9 @@ public MaxAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MaxAggregationDescriptor Field(Expression> field) { @@ -97,7 +108,10 @@ public MaxAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public MaxAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -186,7 +200,9 @@ public MaxAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MaxAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -195,7 +211,9 @@ public MaxAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MaxAggregationDescriptor Field(Expression> field) { @@ -204,7 +222,9 @@ public MaxAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MaxAggregationDescriptor Field(Expression> field) { @@ -219,7 +239,10 @@ public MaxAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public MaxAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MaxBucketAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MaxBucketAggregation.g.cs index 6d6497192d4..e5e62b7dfac 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MaxBucketAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MaxBucketAggregation.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class MaxBucketAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? GapPolicy { get; set; } @@ -63,7 +70,9 @@ public MaxBucketAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? GapPolicyValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public MaxBucketAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? bucketsPath) { @@ -72,7 +81,10 @@ public MaxBucketAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch. } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public MaxBucketAggregationDescriptor Format(string? format) { @@ -81,7 +93,9 @@ public MaxBucketAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public MaxBucketAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? gapPolicy) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MedianAbsoluteDeviationAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MedianAbsoluteDeviationAggregate.g.cs index c4c5b91f0e6..4d868eea1db 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MedianAbsoluteDeviationAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MedianAbsoluteDeviationAggregate.g.cs @@ -33,7 +33,10 @@ public sealed partial class MedianAbsoluteDeviationAggregate : IAggregate public IReadOnlyDictionary? Meta { get; init; } /// - /// The metric value. A missing value generally means that there was no data to aggregate,
unless specified otherwise. + /// + /// The metric value. A missing value generally means that there was no data to aggregate, + /// unless specified otherwise. + /// /// [JsonInclude, JsonPropertyName("value")] public double? Value { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MedianAbsoluteDeviationAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MedianAbsoluteDeviationAggregation.g.cs index 779a72a004a..1ec93f86afe 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MedianAbsoluteDeviationAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MedianAbsoluteDeviationAggregation.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class MedianAbsoluteDeviationAggregation { /// - /// Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. + /// + /// Limits the maximum number of nodes used by the underlying TDigest algorithm to 20 * compression, enabling control of memory usage and approximation error. + /// /// [JsonInclude, JsonPropertyName("compression")] public double? Compression { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } @@ -44,7 +48,10 @@ public sealed partial class MedianAbsoluteDeviationAggregation public string? Format { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.FieldValue? Missing { get; set; } @@ -71,7 +78,9 @@ public MedianAbsoluteDeviationAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. + /// + /// Limits the maximum number of nodes used by the underlying TDigest algorithm to 20 * compression, enabling control of memory usage and approximation error. + /// /// public MedianAbsoluteDeviationAggregationDescriptor Compression(double? compression) { @@ -80,7 +89,9 @@ public MedianAbsoluteDeviationAggregationDescriptor Compression(doubl } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MedianAbsoluteDeviationAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -89,7 +100,9 @@ public MedianAbsoluteDeviationAggregationDescriptor Field(Elastic.Cli } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MedianAbsoluteDeviationAggregationDescriptor Field(Expression> field) { @@ -98,7 +111,9 @@ public MedianAbsoluteDeviationAggregationDescriptor Field(Exp } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MedianAbsoluteDeviationAggregationDescriptor Field(Expression> field) { @@ -113,7 +128,10 @@ public MedianAbsoluteDeviationAggregationDescriptor Format(string? fo } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public MedianAbsoluteDeviationAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -209,7 +227,9 @@ public MedianAbsoluteDeviationAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. + /// + /// Limits the maximum number of nodes used by the underlying TDigest algorithm to 20 * compression, enabling control of memory usage and approximation error. + /// /// public MedianAbsoluteDeviationAggregationDescriptor Compression(double? compression) { @@ -218,7 +238,9 @@ public MedianAbsoluteDeviationAggregationDescriptor Compression(double? compress } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MedianAbsoluteDeviationAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -227,7 +249,9 @@ public MedianAbsoluteDeviationAggregationDescriptor Field(Elastic.Clients.Elasti } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MedianAbsoluteDeviationAggregationDescriptor Field(Expression> field) { @@ -236,7 +260,9 @@ public MedianAbsoluteDeviationAggregationDescriptor Field(Exp } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MedianAbsoluteDeviationAggregationDescriptor Field(Expression> field) { @@ -251,7 +277,10 @@ public MedianAbsoluteDeviationAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public MedianAbsoluteDeviationAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MinAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MinAggregate.g.cs index d850b5efa0a..08ab4f8d939 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MinAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MinAggregate.g.cs @@ -33,7 +33,10 @@ public sealed partial class MinAggregate : IAggregate public IReadOnlyDictionary? Meta { get; init; } /// - /// The metric value. A missing value generally means that there was no data to aggregate,
unless specified otherwise. + /// + /// The metric value. A missing value generally means that there was no data to aggregate, + /// unless specified otherwise. + /// /// [JsonInclude, JsonPropertyName("value")] public double? Value { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MinAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MinAggregation.g.cs index b6010108d0d..6cd439a0fc9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MinAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MinAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class MinAggregation { /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } @@ -38,7 +40,10 @@ public sealed partial class MinAggregation public string? Format { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.FieldValue? Missing { get; set; } @@ -64,7 +69,9 @@ public MinAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MinAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -73,7 +80,9 @@ public MinAggregationDescriptor Field(Elastic.Clients.Elasticsearch.F } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MinAggregationDescriptor Field(Expression> field) { @@ -82,7 +91,9 @@ public MinAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MinAggregationDescriptor Field(Expression> field) { @@ -97,7 +108,10 @@ public MinAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public MinAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -186,7 +200,9 @@ public MinAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MinAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -195,7 +211,9 @@ public MinAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MinAggregationDescriptor Field(Expression> field) { @@ -204,7 +222,9 @@ public MinAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public MinAggregationDescriptor Field(Expression> field) { @@ -219,7 +239,10 @@ public MinAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public MinAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MinBucketAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MinBucketAggregation.g.cs index a331084d307..4b85cf978ee 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MinBucketAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MinBucketAggregation.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class MinBucketAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? GapPolicy { get; set; } @@ -63,7 +70,9 @@ public MinBucketAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? GapPolicyValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public MinBucketAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? bucketsPath) { @@ -72,7 +81,10 @@ public MinBucketAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch. } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public MinBucketAggregationDescriptor Format(string? format) { @@ -81,7 +93,9 @@ public MinBucketAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public MinBucketAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? gapPolicy) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MissingAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MissingAggregate.g.cs index 7fbf55c6165..230547ba313 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MissingAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MissingAggregate.g.cs @@ -77,7 +77,9 @@ public override void Write(Utf8JsonWriter writer, MissingAggregate value, JsonSe public sealed partial class MissingAggregate : IAggregate { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MissingAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MissingAggregation.g.cs index e13dd5d5d01..238864d41ac 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MissingAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MissingAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class MissingAggregation { /// - /// The name of the field. + /// + /// The name of the field. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } @@ -52,7 +54,9 @@ public MissingAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.FieldValue? MissingValue { get; set; } /// - /// The name of the field. + /// + /// The name of the field. + /// /// public MissingAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -61,7 +65,9 @@ public MissingAggregationDescriptor Field(Elastic.Clients.Elasticsear } /// - /// The name of the field. + /// + /// The name of the field. + /// /// public MissingAggregationDescriptor Field(Expression> field) { @@ -70,7 +76,9 @@ public MissingAggregationDescriptor Field(Expression - /// The name of the field. + /// + /// The name of the field. + /// /// public MissingAggregationDescriptor Field(Expression> field) { @@ -115,7 +123,9 @@ public MissingAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.FieldValue? MissingValue { get; set; } /// - /// The name of the field. + /// + /// The name of the field. + /// /// public MissingAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -124,7 +134,9 @@ public MissingAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? f } /// - /// The name of the field. + /// + /// The name of the field. + /// /// public MissingAggregationDescriptor Field(Expression> field) { @@ -133,7 +145,9 @@ public MissingAggregationDescriptor Field(Expression - /// The name of the field. + /// + /// The name of the field. + /// /// public MissingAggregationDescriptor Field(Expression> field) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MovingFunctionAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MovingFunctionAggregation.g.cs index 025f1dee3dd..92a3f7483c3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MovingFunctionAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MovingFunctionAggregation.g.cs @@ -30,37 +30,51 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class MovingFunctionAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? GapPolicy { get; set; } /// - /// The script that should be executed on each window of data. + /// + /// The script that should be executed on each window of data. + /// /// [JsonInclude, JsonPropertyName("script")] public string? Script { get; set; } /// - /// By default, the window consists of the last n values excluding the current bucket.
Increasing `shift` by 1, moves the starting window position by 1 to the right. + /// + /// By default, the window consists of the last n values excluding the current bucket. + /// Increasing shift by 1, moves the starting window position by 1 to the right. + /// /// [JsonInclude, JsonPropertyName("shift")] public int? Shift { get; set; } /// - /// The size of window to "slide" across the histogram. + /// + /// The size of window to "slide" across the histogram. + /// /// [JsonInclude, JsonPropertyName("window")] public int? Window { get; set; } @@ -84,7 +98,9 @@ public MovingFunctionAggregationDescriptor() : base() private int? WindowValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public MovingFunctionAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? bucketsPath) { @@ -93,7 +109,10 @@ public MovingFunctionAggregationDescriptor BucketsPath(Elastic.Clients.Elasticse } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public MovingFunctionAggregationDescriptor Format(string? format) { @@ -102,7 +121,9 @@ public MovingFunctionAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public MovingFunctionAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? gapPolicy) { @@ -111,7 +132,9 @@ public MovingFunctionAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsear } /// - /// The script that should be executed on each window of data. + /// + /// The script that should be executed on each window of data. + /// /// public MovingFunctionAggregationDescriptor Script(string? script) { @@ -120,7 +143,10 @@ public MovingFunctionAggregationDescriptor Script(string? script) } /// - /// By default, the window consists of the last n values excluding the current bucket.
Increasing `shift` by 1, moves the starting window position by 1 to the right. + /// + /// By default, the window consists of the last n values excluding the current bucket. + /// Increasing shift by 1, moves the starting window position by 1 to the right. + /// /// public MovingFunctionAggregationDescriptor Shift(int? shift) { @@ -129,7 +155,9 @@ public MovingFunctionAggregationDescriptor Shift(int? shift) } /// - /// The size of window to "slide" across the histogram. + /// + /// The size of window to "slide" across the histogram. + /// /// public MovingFunctionAggregationDescriptor Window(int? window) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MovingPercentilesAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MovingPercentilesAggregation.g.cs index 771055962a0..d6b9038ef83 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MovingPercentilesAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MovingPercentilesAggregation.g.cs @@ -30,31 +30,43 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class MovingPercentilesAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? GapPolicy { get; set; } /// - /// By default, the window consists of the last n values excluding the current bucket.
Increasing `shift` by 1, moves the starting window position by 1 to the right. + /// + /// By default, the window consists of the last n values excluding the current bucket. + /// Increasing shift by 1, moves the starting window position by 1 to the right. + /// /// [JsonInclude, JsonPropertyName("shift")] public int? Shift { get; set; } /// - /// The size of window to "slide" across the histogram. + /// + /// The size of window to "slide" across the histogram. + /// /// [JsonInclude, JsonPropertyName("window")] public int? Window { get; set; } @@ -77,7 +89,9 @@ public MovingPercentilesAggregationDescriptor() : base() private int? WindowValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public MovingPercentilesAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? bucketsPath) { @@ -86,7 +100,10 @@ public MovingPercentilesAggregationDescriptor BucketsPath(Elastic.Clients.Elasti } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public MovingPercentilesAggregationDescriptor Format(string? format) { @@ -95,7 +112,9 @@ public MovingPercentilesAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public MovingPercentilesAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? gapPolicy) { @@ -104,7 +123,10 @@ public MovingPercentilesAggregationDescriptor GapPolicy(Elastic.Clients.Elastics } /// - /// By default, the window consists of the last n values excluding the current bucket.
Increasing `shift` by 1, moves the starting window position by 1 to the right. + /// + /// By default, the window consists of the last n values excluding the current bucket. + /// Increasing shift by 1, moves the starting window position by 1 to the right. + /// /// public MovingPercentilesAggregationDescriptor Shift(int? shift) { @@ -113,7 +135,9 @@ public MovingPercentilesAggregationDescriptor Shift(int? shift) } /// - /// The size of window to "slide" across the histogram. + /// + /// The size of window to "slide" across the histogram. + /// /// public MovingPercentilesAggregationDescriptor Window(int? window) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MultiTermLookup.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MultiTermLookup.g.cs index 143c0588606..c803a21b918 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MultiTermLookup.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MultiTermLookup.g.cs @@ -30,13 +30,18 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class MultiTermLookup { /// - /// A fields from which to retrieve terms. + /// + /// A fields from which to retrieve terms. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.FieldValue? Missing { get; set; } @@ -54,7 +59,9 @@ public MultiTermLookupDescriptor() : base() private Elastic.Clients.Elasticsearch.FieldValue? MissingValue { get; set; } /// - /// A fields from which to retrieve terms. + /// + /// A fields from which to retrieve terms. + /// /// public MultiTermLookupDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -63,7 +70,9 @@ public MultiTermLookupDescriptor Field(Elastic.Clients.Elasticsearch. } /// - /// A fields from which to retrieve terms. + /// + /// A fields from which to retrieve terms. + /// /// public MultiTermLookupDescriptor Field(Expression> field) { @@ -72,7 +81,9 @@ public MultiTermLookupDescriptor Field(Expression - /// A fields from which to retrieve terms. + /// + /// A fields from which to retrieve terms. + /// /// public MultiTermLookupDescriptor Field(Expression> field) { @@ -81,7 +92,10 @@ public MultiTermLookupDescriptor Field(Expression - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public MultiTermLookupDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -116,7 +130,9 @@ public MultiTermLookupDescriptor() : base() private Elastic.Clients.Elasticsearch.FieldValue? MissingValue { get; set; } /// - /// A fields from which to retrieve terms. + /// + /// A fields from which to retrieve terms. + /// /// public MultiTermLookupDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -125,7 +141,9 @@ public MultiTermLookupDescriptor Field(Elastic.Clients.Elasticsearch.Field field } /// - /// A fields from which to retrieve terms. + /// + /// A fields from which to retrieve terms. + /// /// public MultiTermLookupDescriptor Field(Expression> field) { @@ -134,7 +152,9 @@ public MultiTermLookupDescriptor Field(Expression - /// A fields from which to retrieve terms. + /// + /// A fields from which to retrieve terms. + /// /// public MultiTermLookupDescriptor Field(Expression> field) { @@ -143,7 +163,10 @@ public MultiTermLookupDescriptor Field(Expression - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public MultiTermLookupDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MultiTermsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MultiTermsAggregation.g.cs index e411ed59a76..962a8a079e2 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MultiTermsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MultiTermsAggregation.g.cs @@ -30,50 +30,68 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class MultiTermsAggregation { /// - /// Specifies the strategy for data collection. + /// + /// Specifies the strategy for data collection. + /// /// [JsonInclude, JsonPropertyName("collect_mode")] public Elastic.Clients.Elasticsearch.Aggregations.TermsAggregationCollectMode? CollectMode { get; set; } /// - /// The minimum number of documents in a bucket for it to be returned. + /// + /// The minimum number of documents in a bucket for it to be returned. + /// /// [JsonInclude, JsonPropertyName("min_doc_count")] public long? MinDocCount { get; set; } /// - /// Specifies the sort order of the buckets.
Defaults to sorting by descending document count. + /// + /// Specifies the sort order of the buckets. + /// Defaults to sorting by descending document count. + /// /// [JsonInclude, JsonPropertyName("order")] [SingleOrManyCollectionConverter(typeof(KeyValuePair))] public ICollection>? Order { get; set; } /// - /// The minimum number of documents in a bucket on each shard for it to be returned. + /// + /// The minimum number of documents in a bucket on each shard for it to be returned. + /// /// [JsonInclude, JsonPropertyName("shard_min_doc_count")] public long? ShardMinDocCount { get; set; } /// - /// The number of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// + /// The number of candidate terms produced by each shard. + /// By default, shard_size will be automatically estimated based on the number of shards and the size parameter. + /// /// [JsonInclude, JsonPropertyName("shard_size")] public int? ShardSize { get; set; } /// - /// Calculates the doc count error on per term basis. + /// + /// Calculates the doc count error on per term basis. + /// /// [JsonInclude, JsonPropertyName("show_term_doc_count_error")] public bool? ShowTermDocCountError { get; set; } /// - /// The number of term buckets should be returned out of the overall terms list. + /// + /// The number of term buckets should be returned out of the overall terms list. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// The field from which to generate sets of terms. + /// + /// The field from which to generate sets of terms. + /// /// [JsonInclude, JsonPropertyName("terms")] public ICollection Terms { get; set; } @@ -102,7 +120,9 @@ public MultiTermsAggregationDescriptor() : base() private Action>[] TermsDescriptorActions { get; set; } /// - /// Specifies the strategy for data collection. + /// + /// Specifies the strategy for data collection. + /// /// public MultiTermsAggregationDescriptor CollectMode(Elastic.Clients.Elasticsearch.Aggregations.TermsAggregationCollectMode? collectMode) { @@ -111,7 +131,9 @@ public MultiTermsAggregationDescriptor CollectMode(Elastic.Clients.El } /// - /// The minimum number of documents in a bucket for it to be returned. + /// + /// The minimum number of documents in a bucket for it to be returned. + /// /// public MultiTermsAggregationDescriptor MinDocCount(long? minDocCount) { @@ -120,7 +142,10 @@ public MultiTermsAggregationDescriptor MinDocCount(long? minDocCount) } /// - /// Specifies the sort order of the buckets.
Defaults to sorting by descending document count. + /// + /// Specifies the sort order of the buckets. + /// Defaults to sorting by descending document count. + /// /// public MultiTermsAggregationDescriptor Order(ICollection>? order) { @@ -129,7 +154,9 @@ public MultiTermsAggregationDescriptor Order(ICollection - /// The minimum number of documents in a bucket on each shard for it to be returned. + /// + /// The minimum number of documents in a bucket on each shard for it to be returned. + /// /// public MultiTermsAggregationDescriptor ShardMinDocCount(long? shardMinDocCount) { @@ -138,7 +165,10 @@ public MultiTermsAggregationDescriptor ShardMinDocCount(long? shardMi } /// - /// The number of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// + /// The number of candidate terms produced by each shard. + /// By default, shard_size will be automatically estimated based on the number of shards and the size parameter. + /// /// public MultiTermsAggregationDescriptor ShardSize(int? shardSize) { @@ -147,7 +177,9 @@ public MultiTermsAggregationDescriptor ShardSize(int? shardSize) } /// - /// Calculates the doc count error on per term basis. + /// + /// Calculates the doc count error on per term basis. + /// /// public MultiTermsAggregationDescriptor ShowTermDocCountError(bool? showTermDocCountError = true) { @@ -156,7 +188,9 @@ public MultiTermsAggregationDescriptor ShowTermDocCountError(bool? sh } /// - /// The number of term buckets should be returned out of the overall terms list. + /// + /// The number of term buckets should be returned out of the overall terms list. + /// /// public MultiTermsAggregationDescriptor Size(int? size) { @@ -165,7 +199,9 @@ public MultiTermsAggregationDescriptor Size(int? size) } /// - /// The field from which to generate sets of terms. + /// + /// The field from which to generate sets of terms. + /// /// public MultiTermsAggregationDescriptor Terms(ICollection terms) { @@ -304,7 +340,9 @@ public MultiTermsAggregationDescriptor() : base() private Action[] TermsDescriptorActions { get; set; } /// - /// Specifies the strategy for data collection. + /// + /// Specifies the strategy for data collection. + /// /// public MultiTermsAggregationDescriptor CollectMode(Elastic.Clients.Elasticsearch.Aggregations.TermsAggregationCollectMode? collectMode) { @@ -313,7 +351,9 @@ public MultiTermsAggregationDescriptor CollectMode(Elastic.Clients.Elasticsearch } /// - /// The minimum number of documents in a bucket for it to be returned. + /// + /// The minimum number of documents in a bucket for it to be returned. + /// /// public MultiTermsAggregationDescriptor MinDocCount(long? minDocCount) { @@ -322,7 +362,10 @@ public MultiTermsAggregationDescriptor MinDocCount(long? minDocCount) } /// - /// Specifies the sort order of the buckets.
Defaults to sorting by descending document count. + /// + /// Specifies the sort order of the buckets. + /// Defaults to sorting by descending document count. + /// /// public MultiTermsAggregationDescriptor Order(ICollection>? order) { @@ -331,7 +374,9 @@ public MultiTermsAggregationDescriptor Order(ICollection - /// The minimum number of documents in a bucket on each shard for it to be returned. + /// + /// The minimum number of documents in a bucket on each shard for it to be returned. + /// /// public MultiTermsAggregationDescriptor ShardMinDocCount(long? shardMinDocCount) { @@ -340,7 +385,10 @@ public MultiTermsAggregationDescriptor ShardMinDocCount(long? shardMinDocCount) } /// - /// The number of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// + /// The number of candidate terms produced by each shard. + /// By default, shard_size will be automatically estimated based on the number of shards and the size parameter. + /// /// public MultiTermsAggregationDescriptor ShardSize(int? shardSize) { @@ -349,7 +397,9 @@ public MultiTermsAggregationDescriptor ShardSize(int? shardSize) } /// - /// Calculates the doc count error on per term basis. + /// + /// Calculates the doc count error on per term basis. + /// /// public MultiTermsAggregationDescriptor ShowTermDocCountError(bool? showTermDocCountError = true) { @@ -358,7 +408,9 @@ public MultiTermsAggregationDescriptor ShowTermDocCountError(bool? showTermDocCo } /// - /// The number of term buckets should be returned out of the overall terms list. + /// + /// The number of term buckets should be returned out of the overall terms list. + /// /// public MultiTermsAggregationDescriptor Size(int? size) { @@ -367,7 +419,9 @@ public MultiTermsAggregationDescriptor Size(int? size) } /// - /// The field from which to generate sets of terms. + /// + /// The field from which to generate sets of terms. + /// /// public MultiTermsAggregationDescriptor Terms(ICollection terms) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MultiTermsBucket.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MultiTermsBucket.g.cs index 55be961f991..003b8283ea2 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MultiTermsBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MultiTermsBucket.g.cs @@ -91,7 +91,9 @@ public override void Write(Utf8JsonWriter writer, MultiTermsBucket value, JsonSe public sealed partial class MultiTermsBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MutualInformationHeuristic.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MutualInformationHeuristic.g.cs index 5ad6254071b..56c66c3e276 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MutualInformationHeuristic.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MutualInformationHeuristic.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class MutualInformationHeuristic { /// - /// Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. + /// + /// Set to false if you defined a custom background filter that represents a different set of documents that you want to compare to. + /// /// [JsonInclude, JsonPropertyName("background_is_superset")] public bool? BackgroundIsSuperset { get; set; } /// - /// Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset. + /// + /// Set to false to filter out the terms that appear less often in the subset than in documents outside the subset. + /// /// [JsonInclude, JsonPropertyName("include_negatives")] public bool? IncludeNegatives { get; set; } @@ -54,7 +58,9 @@ public MutualInformationHeuristicDescriptor() : base() private bool? IncludeNegativesValue { get; set; } /// - /// Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. + /// + /// Set to false if you defined a custom background filter that represents a different set of documents that you want to compare to. + /// /// public MutualInformationHeuristicDescriptor BackgroundIsSuperset(bool? backgroundIsSuperset = true) { @@ -63,7 +69,9 @@ public MutualInformationHeuristicDescriptor BackgroundIsSuperset(bool? backgroun } /// - /// Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset. + /// + /// Set to false to filter out the terms that appear less often in the subset than in documents outside the subset. + /// /// public MutualInformationHeuristicDescriptor IncludeNegatives(bool? includeNegatives = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/NestedAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/NestedAggregate.g.cs index 153c7c8d2dd..e38814bec14 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/NestedAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/NestedAggregate.g.cs @@ -77,7 +77,9 @@ public override void Write(Utf8JsonWriter writer, NestedAggregate value, JsonSer public sealed partial class NestedAggregate : IAggregate { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/NestedAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/NestedAggregation.g.cs index c97b51e2570..1ff452ee03b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/NestedAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/NestedAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class NestedAggregation { /// - /// The path to the field of type `nested`. + /// + /// The path to the field of type nested. + /// /// [JsonInclude, JsonPropertyName("path")] public Elastic.Clients.Elasticsearch.Field? Path { get; set; } @@ -49,7 +51,9 @@ public NestedAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? PathValue { get; set; } /// - /// The path to the field of type `nested`. + /// + /// The path to the field of type nested. + /// /// public NestedAggregationDescriptor Path(Elastic.Clients.Elasticsearch.Field? path) { @@ -58,7 +62,9 @@ public NestedAggregationDescriptor Path(Elastic.Clients.Elasticsearch } /// - /// The path to the field of type `nested`. + /// + /// The path to the field of type nested. + /// /// public NestedAggregationDescriptor Path(Expression> path) { @@ -67,7 +73,9 @@ public NestedAggregationDescriptor Path(Expression - /// The path to the field of type `nested`. + /// + /// The path to the field of type nested. + /// /// public NestedAggregationDescriptor Path(Expression> path) { @@ -99,7 +107,9 @@ public NestedAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? PathValue { get; set; } /// - /// The path to the field of type `nested`. + /// + /// The path to the field of type nested. + /// /// public NestedAggregationDescriptor Path(Elastic.Clients.Elasticsearch.Field? path) { @@ -108,7 +118,9 @@ public NestedAggregationDescriptor Path(Elastic.Clients.Elasticsearch.Field? pat } /// - /// The path to the field of type `nested`. + /// + /// The path to the field of type nested. + /// /// public NestedAggregationDescriptor Path(Expression> path) { @@ -117,7 +129,9 @@ public NestedAggregationDescriptor Path(Expression - /// The path to the field of type `nested`. + /// + /// The path to the field of type nested. + /// /// public NestedAggregationDescriptor Path(Expression> path) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/NormalizeAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/NormalizeAggregation.g.cs index 2079668f6f7..59aabd2e38f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/NormalizeAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/NormalizeAggregation.g.cs @@ -30,25 +30,34 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class NormalizeAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? GapPolicy { get; set; } /// - /// The specific method to apply. + /// + /// The specific method to apply. + /// /// [JsonInclude, JsonPropertyName("method")] public Elastic.Clients.Elasticsearch.Aggregations.NormalizeMethod? Method { get; set; } @@ -70,7 +79,9 @@ public NormalizeAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Aggregations.NormalizeMethod? MethodValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public NormalizeAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? bucketsPath) { @@ -79,7 +90,10 @@ public NormalizeAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch. } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public NormalizeAggregationDescriptor Format(string? format) { @@ -88,7 +102,9 @@ public NormalizeAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public NormalizeAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? gapPolicy) { @@ -97,7 +113,9 @@ public NormalizeAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Ag } /// - /// The specific method to apply. + /// + /// The specific method to apply. + /// /// public NormalizeAggregationDescriptor Method(Elastic.Clients.Elasticsearch.Aggregations.NormalizeMethod? method) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ParentAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ParentAggregate.g.cs index 97aec7ff4ae..33739b8289d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ParentAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ParentAggregate.g.cs @@ -77,7 +77,9 @@ public override void Write(Utf8JsonWriter writer, ParentAggregate value, JsonSer public sealed partial class ParentAggregate : IAggregate { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ParentAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ParentAggregation.g.cs index 17ec89288c3..86ea1f4cc6b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ParentAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ParentAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class ParentAggregation { /// - /// The child type that should be selected. + /// + /// The child type that should be selected. + /// /// [JsonInclude, JsonPropertyName("type")] public string? Type { get; set; } @@ -49,7 +51,9 @@ public ParentAggregationDescriptor() : base() private string? TypeValue { get; set; } /// - /// The child type that should be selected. + /// + /// The child type that should be selected. + /// /// public ParentAggregationDescriptor Type(string? type) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/PercentileRanksAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/PercentileRanksAggregation.g.cs index 7efbd4083d8..e16896f0edb 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/PercentileRanksAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/PercentileRanksAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class PercentileRanksAggregation { /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } @@ -38,13 +40,18 @@ public sealed partial class PercentileRanksAggregation public string? Format { get; set; } /// - /// Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks. + /// + /// Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks. + /// /// [JsonInclude, JsonPropertyName("hdr")] public Elastic.Clients.Elasticsearch.Aggregations.HdrMethod? Hdr { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.FieldValue? Missing { get; set; } @@ -52,13 +59,17 @@ public sealed partial class PercentileRanksAggregation public Elastic.Clients.Elasticsearch.Script? Script { get; set; } /// - /// Sets parameters for the default TDigest algorithm used to calculate percentile ranks. + /// + /// Sets parameters for the default TDigest algorithm used to calculate percentile ranks. + /// /// [JsonInclude, JsonPropertyName("tdigest")] public Elastic.Clients.Elasticsearch.Aggregations.TDigest? TDigest { get; set; } /// - /// An array of values for which to calculate the percentile ranks. + /// + /// An array of values for which to calculate the percentile ranks. + /// /// [JsonInclude, JsonPropertyName("values")] public ICollection? Values { get; set; } @@ -89,7 +100,9 @@ public PercentileRanksAggregationDescriptor() : base() private ICollection? ValuesValue { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public PercentileRanksAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -98,7 +111,9 @@ public PercentileRanksAggregationDescriptor Field(Elastic.Clients.Ela } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public PercentileRanksAggregationDescriptor Field(Expression> field) { @@ -107,7 +122,9 @@ public PercentileRanksAggregationDescriptor Field(Expression< } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public PercentileRanksAggregationDescriptor Field(Expression> field) { @@ -122,7 +139,9 @@ public PercentileRanksAggregationDescriptor Format(string? format) } /// - /// Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks. + /// + /// Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks. + /// /// public PercentileRanksAggregationDescriptor Hdr(Elastic.Clients.Elasticsearch.Aggregations.HdrMethod? hdr) { @@ -149,7 +168,10 @@ public PercentileRanksAggregationDescriptor Hdr(Action - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public PercentileRanksAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -182,7 +204,9 @@ public PercentileRanksAggregationDescriptor Script(Action - /// Sets parameters for the default TDigest algorithm used to calculate percentile ranks. + /// + /// Sets parameters for the default TDigest algorithm used to calculate percentile ranks. + /// /// public PercentileRanksAggregationDescriptor TDigest(Elastic.Clients.Elasticsearch.Aggregations.TDigest? tDigest) { @@ -209,7 +233,9 @@ public PercentileRanksAggregationDescriptor TDigest(Action - /// An array of values for which to calculate the percentile ranks. + /// + /// An array of values for which to calculate the percentile ranks. + /// /// public PercentileRanksAggregationDescriptor Values(ICollection? values) { @@ -319,7 +345,9 @@ public PercentileRanksAggregationDescriptor() : base() private ICollection? ValuesValue { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public PercentileRanksAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -328,7 +356,9 @@ public PercentileRanksAggregationDescriptor Field(Elastic.Clients.Elasticsearch. } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public PercentileRanksAggregationDescriptor Field(Expression> field) { @@ -337,7 +367,9 @@ public PercentileRanksAggregationDescriptor Field(Expression< } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public PercentileRanksAggregationDescriptor Field(Expression> field) { @@ -352,7 +384,9 @@ public PercentileRanksAggregationDescriptor Format(string? format) } /// - /// Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks. + /// + /// Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks. + /// /// public PercentileRanksAggregationDescriptor Hdr(Elastic.Clients.Elasticsearch.Aggregations.HdrMethod? hdr) { @@ -379,7 +413,10 @@ public PercentileRanksAggregationDescriptor Hdr(Action - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public PercentileRanksAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -412,7 +449,9 @@ public PercentileRanksAggregationDescriptor Script(Action - /// Sets parameters for the default TDigest algorithm used to calculate percentile ranks. + /// + /// Sets parameters for the default TDigest algorithm used to calculate percentile ranks. + /// /// public PercentileRanksAggregationDescriptor TDigest(Elastic.Clients.Elasticsearch.Aggregations.TDigest? tDigest) { @@ -439,7 +478,9 @@ public PercentileRanksAggregationDescriptor TDigest(Action - /// An array of values for which to calculate the percentile ranks. + /// + /// An array of values for which to calculate the percentile ranks. + /// /// public PercentileRanksAggregationDescriptor Values(ICollection? values) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/PercentilesAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/PercentilesAggregation.g.cs index 10b8f88b01d..e7cc08f5b56 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/PercentilesAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/PercentilesAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class PercentilesAggregation { /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } @@ -38,19 +40,26 @@ public sealed partial class PercentilesAggregation public string? Format { get; set; } /// - /// Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles. + /// + /// Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles. + /// /// [JsonInclude, JsonPropertyName("hdr")] public Elastic.Clients.Elasticsearch.Aggregations.HdrMethod? Hdr { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.FieldValue? Missing { get; set; } /// - /// The percentiles to calculate. + /// + /// The percentiles to calculate. + /// /// [JsonInclude, JsonPropertyName("percents")] public ICollection? Percents { get; set; } @@ -58,7 +67,9 @@ public sealed partial class PercentilesAggregation public Elastic.Clients.Elasticsearch.Script? Script { get; set; } /// - /// Sets parameters for the default TDigest algorithm used to calculate percentiles. + /// + /// Sets parameters for the default TDigest algorithm used to calculate percentiles. + /// /// [JsonInclude, JsonPropertyName("tdigest")] public Elastic.Clients.Elasticsearch.Aggregations.TDigest? TDigest { get; set; } @@ -89,7 +100,9 @@ public PercentilesAggregationDescriptor() : base() private Action TDigestDescriptorAction { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public PercentilesAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -98,7 +111,9 @@ public PercentilesAggregationDescriptor Field(Elastic.Clients.Elastic } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public PercentilesAggregationDescriptor Field(Expression> field) { @@ -107,7 +122,9 @@ public PercentilesAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public PercentilesAggregationDescriptor Field(Expression> field) { @@ -122,7 +139,9 @@ public PercentilesAggregationDescriptor Format(string? format) } /// - /// Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles. + /// + /// Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles. + /// /// public PercentilesAggregationDescriptor Hdr(Elastic.Clients.Elasticsearch.Aggregations.HdrMethod? hdr) { @@ -149,7 +168,10 @@ public PercentilesAggregationDescriptor Hdr(Action - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public PercentilesAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -158,7 +180,9 @@ public PercentilesAggregationDescriptor Missing(Elastic.Clients.Elast } /// - /// The percentiles to calculate. + /// + /// The percentiles to calculate. + /// /// public PercentilesAggregationDescriptor Percents(ICollection? percents) { @@ -191,7 +215,9 @@ public PercentilesAggregationDescriptor Script(Action - /// Sets parameters for the default TDigest algorithm used to calculate percentiles. + /// + /// Sets parameters for the default TDigest algorithm used to calculate percentiles. + /// /// public PercentilesAggregationDescriptor TDigest(Elastic.Clients.Elasticsearch.Aggregations.TDigest? tDigest) { @@ -319,7 +345,9 @@ public PercentilesAggregationDescriptor() : base() private Action TDigestDescriptorAction { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public PercentilesAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -328,7 +356,9 @@ public PercentilesAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Fiel } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public PercentilesAggregationDescriptor Field(Expression> field) { @@ -337,7 +367,9 @@ public PercentilesAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public PercentilesAggregationDescriptor Field(Expression> field) { @@ -352,7 +384,9 @@ public PercentilesAggregationDescriptor Format(string? format) } /// - /// Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles. + /// + /// Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles. + /// /// public PercentilesAggregationDescriptor Hdr(Elastic.Clients.Elasticsearch.Aggregations.HdrMethod? hdr) { @@ -379,7 +413,10 @@ public PercentilesAggregationDescriptor Hdr(Action - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public PercentilesAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -388,7 +425,9 @@ public PercentilesAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Fi } /// - /// The percentiles to calculate. + /// + /// The percentiles to calculate. + /// /// public PercentilesAggregationDescriptor Percents(ICollection? percents) { @@ -421,7 +460,9 @@ public PercentilesAggregationDescriptor Script(Action - /// Sets parameters for the default TDigest algorithm used to calculate percentiles. + /// + /// Sets parameters for the default TDigest algorithm used to calculate percentiles. + /// /// public PercentilesAggregationDescriptor TDigest(Elastic.Clients.Elasticsearch.Aggregations.TDigest? tDigest) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/PercentilesBucketAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/PercentilesBucketAggregation.g.cs index 446d66badd0..330062d26a0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/PercentilesBucketAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/PercentilesBucketAggregation.g.cs @@ -30,25 +30,34 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class PercentilesBucketAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? GapPolicy { get; set; } /// - /// The list of percentiles to calculate. + /// + /// The list of percentiles to calculate. + /// /// [JsonInclude, JsonPropertyName("percents")] public ICollection? Percents { get; set; } @@ -70,7 +79,9 @@ public PercentilesBucketAggregationDescriptor() : base() private ICollection? PercentsValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public PercentilesBucketAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? bucketsPath) { @@ -79,7 +90,10 @@ public PercentilesBucketAggregationDescriptor BucketsPath(Elastic.Clients.Elasti } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public PercentilesBucketAggregationDescriptor Format(string? format) { @@ -88,7 +102,9 @@ public PercentilesBucketAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public PercentilesBucketAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? gapPolicy) { @@ -97,7 +113,9 @@ public PercentilesBucketAggregationDescriptor GapPolicy(Elastic.Clients.Elastics } /// - /// The list of percentiles to calculate. + /// + /// The list of percentiles to calculate. + /// /// public PercentilesBucketAggregationDescriptor Percents(ICollection? percents) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/RangeAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/RangeAggregation.g.cs index 0af977b78fa..e3f55879c16 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/RangeAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/RangeAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class RangeAggregation { /// - /// The date field whose values are use to build ranges. + /// + /// The date field whose values are use to build ranges. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } @@ -38,13 +40,18 @@ public sealed partial class RangeAggregation public string? Format { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public int? Missing { get; set; } /// - /// An array of ranges used to bucket documents. + /// + /// An array of ranges used to bucket documents. + /// /// [JsonInclude, JsonPropertyName("ranges")] public ICollection? Ranges { get; set; } @@ -74,7 +81,9 @@ public RangeAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The date field whose values are use to build ranges. + /// + /// The date field whose values are use to build ranges. + /// /// public RangeAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -83,7 +92,9 @@ public RangeAggregationDescriptor Field(Elastic.Clients.Elasticsearch } /// - /// The date field whose values are use to build ranges. + /// + /// The date field whose values are use to build ranges. + /// /// public RangeAggregationDescriptor Field(Expression> field) { @@ -92,7 +103,9 @@ public RangeAggregationDescriptor Field(Expression - /// The date field whose values are use to build ranges. + /// + /// The date field whose values are use to build ranges. + /// /// public RangeAggregationDescriptor Field(Expression> field) { @@ -107,7 +120,10 @@ public RangeAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public RangeAggregationDescriptor Missing(int? missing) { @@ -116,7 +132,9 @@ public RangeAggregationDescriptor Missing(int? missing) } /// - /// An array of ranges used to bucket documents. + /// + /// An array of ranges used to bucket documents. + /// /// public RangeAggregationDescriptor Ranges(ICollection? ranges) { @@ -270,7 +288,9 @@ public RangeAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The date field whose values are use to build ranges. + /// + /// The date field whose values are use to build ranges. + /// /// public RangeAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -279,7 +299,9 @@ public RangeAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? fie } /// - /// The date field whose values are use to build ranges. + /// + /// The date field whose values are use to build ranges. + /// /// public RangeAggregationDescriptor Field(Expression> field) { @@ -288,7 +310,9 @@ public RangeAggregationDescriptor Field(Expression - /// The date field whose values are use to build ranges. + /// + /// The date field whose values are use to build ranges. + /// /// public RangeAggregationDescriptor Field(Expression> field) { @@ -303,7 +327,10 @@ public RangeAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public RangeAggregationDescriptor Missing(int? missing) { @@ -312,7 +339,9 @@ public RangeAggregationDescriptor Missing(int? missing) } /// - /// An array of ranges used to bucket documents. + /// + /// An array of ranges used to bucket documents. + /// /// public RangeAggregationDescriptor Ranges(ICollection? ranges) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/RangeBucket.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/RangeBucket.g.cs index 1aa80c3ce06..b8079e6ad04 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/RangeBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/RangeBucket.g.cs @@ -105,7 +105,9 @@ public override void Write(Utf8JsonWriter writer, RangeBucket value, JsonSeriali public sealed partial class RangeBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } @@ -113,7 +115,9 @@ public sealed partial class RangeBucket public string? FromAsString { get; init; } /// - /// The bucket key. Present if the aggregation is _not_ keyed + /// + /// The bucket key. Present if the aggregation is not keyed + /// /// public string? Key { get; init; } public double? To { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/RareTermsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/RareTermsAggregation.g.cs index 6a3439317a5..f5d82496329 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/RareTermsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/RareTermsAggregation.g.cs @@ -30,37 +30,51 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class RareTermsAggregation { /// - /// Terms that should be excluded from the aggregation. + /// + /// Terms that should be excluded from the aggregation. + /// /// [JsonInclude, JsonPropertyName("exclude")] public Elastic.Clients.Elasticsearch.Aggregations.TermsExclude? Exclude { get; set; } /// - /// The field from which to return rare terms. + /// + /// The field from which to return rare terms. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } /// - /// Terms that should be included in the aggregation. + /// + /// Terms that should be included in the aggregation. + /// /// [JsonInclude, JsonPropertyName("include")] public Elastic.Clients.Elasticsearch.Aggregations.TermsInclude? Include { get; set; } /// - /// The maximum number of documents a term should appear in. + /// + /// The maximum number of documents a term should appear in. + /// /// [JsonInclude, JsonPropertyName("max_doc_count")] public long? MaxDocCount { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.FieldValue? Missing { get; set; } /// - /// The precision of the internal CuckooFilters.
Smaller precision leads to better approximation, but higher memory usage. + /// + /// The precision of the internal CuckooFilters. + /// Smaller precision leads to better approximation, but higher memory usage. + /// /// [JsonInclude, JsonPropertyName("precision")] public double? Precision { get; set; } @@ -87,7 +101,9 @@ public RareTermsAggregationDescriptor() : base() private string? ValueTypeValue { get; set; } /// - /// Terms that should be excluded from the aggregation. + /// + /// Terms that should be excluded from the aggregation. + /// /// public RareTermsAggregationDescriptor Exclude(Elastic.Clients.Elasticsearch.Aggregations.TermsExclude? exclude) { @@ -96,7 +112,9 @@ public RareTermsAggregationDescriptor Exclude(Elastic.Clients.Elastic } /// - /// The field from which to return rare terms. + /// + /// The field from which to return rare terms. + /// /// public RareTermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -105,7 +123,9 @@ public RareTermsAggregationDescriptor Field(Elastic.Clients.Elasticse } /// - /// The field from which to return rare terms. + /// + /// The field from which to return rare terms. + /// /// public RareTermsAggregationDescriptor Field(Expression> field) { @@ -114,7 +134,9 @@ public RareTermsAggregationDescriptor Field(Expression - /// The field from which to return rare terms. + /// + /// The field from which to return rare terms. + /// /// public RareTermsAggregationDescriptor Field(Expression> field) { @@ -123,7 +145,9 @@ public RareTermsAggregationDescriptor Field(Expression - /// Terms that should be included in the aggregation. + /// + /// Terms that should be included in the aggregation. + /// /// public RareTermsAggregationDescriptor Include(Elastic.Clients.Elasticsearch.Aggregations.TermsInclude? include) { @@ -132,7 +156,9 @@ public RareTermsAggregationDescriptor Include(Elastic.Clients.Elastic } /// - /// The maximum number of documents a term should appear in. + /// + /// The maximum number of documents a term should appear in. + /// /// public RareTermsAggregationDescriptor MaxDocCount(long? maxDocCount) { @@ -141,7 +167,10 @@ public RareTermsAggregationDescriptor MaxDocCount(long? maxDocCount) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public RareTermsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -150,7 +179,10 @@ public RareTermsAggregationDescriptor Missing(Elastic.Clients.Elastic } /// - /// The precision of the internal CuckooFilters.
Smaller precision leads to better approximation, but higher memory usage. + /// + /// The precision of the internal CuckooFilters. + /// Smaller precision leads to better approximation, but higher memory usage. + /// /// public RareTermsAggregationDescriptor Precision(double? precision) { @@ -230,7 +262,9 @@ public RareTermsAggregationDescriptor() : base() private string? ValueTypeValue { get; set; } /// - /// Terms that should be excluded from the aggregation. + /// + /// Terms that should be excluded from the aggregation. + /// /// public RareTermsAggregationDescriptor Exclude(Elastic.Clients.Elasticsearch.Aggregations.TermsExclude? exclude) { @@ -239,7 +273,9 @@ public RareTermsAggregationDescriptor Exclude(Elastic.Clients.Elasticsearch.Aggr } /// - /// The field from which to return rare terms. + /// + /// The field from which to return rare terms. + /// /// public RareTermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -248,7 +284,9 @@ public RareTermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? } /// - /// The field from which to return rare terms. + /// + /// The field from which to return rare terms. + /// /// public RareTermsAggregationDescriptor Field(Expression> field) { @@ -257,7 +295,9 @@ public RareTermsAggregationDescriptor Field(Expression - /// The field from which to return rare terms. + /// + /// The field from which to return rare terms. + /// /// public RareTermsAggregationDescriptor Field(Expression> field) { @@ -266,7 +306,9 @@ public RareTermsAggregationDescriptor Field(Expression - /// Terms that should be included in the aggregation. + /// + /// Terms that should be included in the aggregation. + /// /// public RareTermsAggregationDescriptor Include(Elastic.Clients.Elasticsearch.Aggregations.TermsInclude? include) { @@ -275,7 +317,9 @@ public RareTermsAggregationDescriptor Include(Elastic.Clients.Elasticsearch.Aggr } /// - /// The maximum number of documents a term should appear in. + /// + /// The maximum number of documents a term should appear in. + /// /// public RareTermsAggregationDescriptor MaxDocCount(long? maxDocCount) { @@ -284,7 +328,10 @@ public RareTermsAggregationDescriptor MaxDocCount(long? maxDocCount) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public RareTermsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -293,7 +340,10 @@ public RareTermsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.Fiel } /// - /// The precision of the internal CuckooFilters.
Smaller precision leads to better approximation, but higher memory usage. + /// + /// The precision of the internal CuckooFilters. + /// Smaller precision leads to better approximation, but higher memory usage. + /// /// public RareTermsAggregationDescriptor Precision(double? precision) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/RateAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/RateAggregation.g.cs index 9a92f31ece2..b2523611ade 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/RateAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/RateAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class RateAggregation { /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } @@ -38,13 +40,18 @@ public sealed partial class RateAggregation public string? Format { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.FieldValue? Missing { get; set; } /// - /// How the rate is calculated. + /// + /// How the rate is calculated. + /// /// [JsonInclude, JsonPropertyName("mode")] public Elastic.Clients.Elasticsearch.Aggregations.RateMode? Mode { get; set; } @@ -52,7 +59,10 @@ public sealed partial class RateAggregation public Elastic.Clients.Elasticsearch.Script? Script { get; set; } /// - /// The interval used to calculate the rate.
By default, the interval of the `date_histogram` is used. + /// + /// The interval used to calculate the rate. + /// By default, the interval of the date_histogram is used. + /// /// [JsonInclude, JsonPropertyName("unit")] public Elastic.Clients.Elasticsearch.Aggregations.CalendarInterval? Unit { get; set; } @@ -78,7 +88,9 @@ public RateAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Aggregations.CalendarInterval? UnitValue { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public RateAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -87,7 +99,9 @@ public RateAggregationDescriptor Field(Elastic.Clients.Elasticsearch. } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public RateAggregationDescriptor Field(Expression> field) { @@ -96,7 +110,9 @@ public RateAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public RateAggregationDescriptor Field(Expression> field) { @@ -111,7 +127,10 @@ public RateAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public RateAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -120,7 +139,9 @@ public RateAggregationDescriptor Missing(Elastic.Clients.Elasticsearc } /// - /// How the rate is calculated. + /// + /// How the rate is calculated. + /// /// public RateAggregationDescriptor Mode(Elastic.Clients.Elasticsearch.Aggregations.RateMode? mode) { @@ -153,7 +174,10 @@ public RateAggregationDescriptor Script(Action - /// The interval used to calculate the rate.
By default, the interval of the `date_histogram` is used. + /// + /// The interval used to calculate the rate. + /// By default, the interval of the date_histogram is used. + /// /// public RateAggregationDescriptor Unit(Elastic.Clients.Elasticsearch.Aggregations.CalendarInterval? unit) { @@ -232,7 +256,9 @@ public RateAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Aggregations.CalendarInterval? UnitValue { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public RateAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -241,7 +267,9 @@ public RateAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? fiel } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public RateAggregationDescriptor Field(Expression> field) { @@ -250,7 +278,9 @@ public RateAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public RateAggregationDescriptor Field(Expression> field) { @@ -265,7 +295,10 @@ public RateAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public RateAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -274,7 +307,9 @@ public RateAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValu } /// - /// How the rate is calculated. + /// + /// How the rate is calculated. + /// /// public RateAggregationDescriptor Mode(Elastic.Clients.Elasticsearch.Aggregations.RateMode? mode) { @@ -307,7 +342,10 @@ public RateAggregationDescriptor Script(Action - /// The interval used to calculate the rate.
By default, the interval of the `date_histogram` is used. + /// + /// The interval used to calculate the rate. + /// By default, the interval of the date_histogram is used. + /// /// public RateAggregationDescriptor Unit(Elastic.Clients.Elasticsearch.Aggregations.CalendarInterval? unit) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ReverseNestedAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ReverseNestedAggregate.g.cs index 3c156d208ba..ec6aff078dd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ReverseNestedAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ReverseNestedAggregate.g.cs @@ -77,7 +77,9 @@ public override void Write(Utf8JsonWriter writer, ReverseNestedAggregate value, public sealed partial class ReverseNestedAggregate : IAggregate { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ReverseNestedAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ReverseNestedAggregation.g.cs index 0f94a910916..3f9755d0878 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ReverseNestedAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ReverseNestedAggregation.g.cs @@ -30,7 +30,10 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class ReverseNestedAggregation { /// - /// Defines the nested object field that should be joined back to.
The default is empty, which means that it joins back to the root/main document level. + /// + /// Defines the nested object field that should be joined back to. + /// The default is empty, which means that it joins back to the root/main document level. + /// /// [JsonInclude, JsonPropertyName("path")] public Elastic.Clients.Elasticsearch.Field? Path { get; set; } @@ -49,7 +52,10 @@ public ReverseNestedAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? PathValue { get; set; } /// - /// Defines the nested object field that should be joined back to.
The default is empty, which means that it joins back to the root/main document level. + /// + /// Defines the nested object field that should be joined back to. + /// The default is empty, which means that it joins back to the root/main document level. + /// /// public ReverseNestedAggregationDescriptor Path(Elastic.Clients.Elasticsearch.Field? path) { @@ -58,7 +64,10 @@ public ReverseNestedAggregationDescriptor Path(Elastic.Clients.Elasti } /// - /// Defines the nested object field that should be joined back to.
The default is empty, which means that it joins back to the root/main document level. + /// + /// Defines the nested object field that should be joined back to. + /// The default is empty, which means that it joins back to the root/main document level. + /// /// public ReverseNestedAggregationDescriptor Path(Expression> path) { @@ -67,7 +76,10 @@ public ReverseNestedAggregationDescriptor Path(Expression - /// Defines the nested object field that should be joined back to.
The default is empty, which means that it joins back to the root/main document level. + /// + /// Defines the nested object field that should be joined back to. + /// The default is empty, which means that it joins back to the root/main document level. + /// /// public ReverseNestedAggregationDescriptor Path(Expression> path) { @@ -99,7 +111,10 @@ public ReverseNestedAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? PathValue { get; set; } /// - /// Defines the nested object field that should be joined back to.
The default is empty, which means that it joins back to the root/main document level. + /// + /// Defines the nested object field that should be joined back to. + /// The default is empty, which means that it joins back to the root/main document level. + /// /// public ReverseNestedAggregationDescriptor Path(Elastic.Clients.Elasticsearch.Field? path) { @@ -108,7 +123,10 @@ public ReverseNestedAggregationDescriptor Path(Elastic.Clients.Elasticsearch.Fie } /// - /// Defines the nested object field that should be joined back to.
The default is empty, which means that it joins back to the root/main document level. + /// + /// Defines the nested object field that should be joined back to. + /// The default is empty, which means that it joins back to the root/main document level. + /// /// public ReverseNestedAggregationDescriptor Path(Expression> path) { @@ -117,7 +135,10 @@ public ReverseNestedAggregationDescriptor Path(Expression - /// Defines the nested object field that should be joined back to.
The default is empty, which means that it joins back to the root/main document level. + /// + /// Defines the nested object field that should be joined back to. + /// The default is empty, which means that it joins back to the root/main document level. + /// /// public ReverseNestedAggregationDescriptor Path(Expression> path) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SamplerAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SamplerAggregate.g.cs index c89e4060567..422f7d9a8df 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SamplerAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SamplerAggregate.g.cs @@ -77,7 +77,9 @@ public override void Write(Utf8JsonWriter writer, SamplerAggregate value, JsonSe public sealed partial class SamplerAggregate : IAggregate { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SamplerAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SamplerAggregation.g.cs index e0a9497b3fa..3b92cce5ee1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SamplerAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SamplerAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class SamplerAggregation { /// - /// Limits how many top-scoring documents are collected in the sample processed on each shard. + /// + /// Limits how many top-scoring documents are collected in the sample processed on each shard. + /// /// [JsonInclude, JsonPropertyName("shard_size")] public int? ShardSize { get; set; } @@ -49,7 +51,9 @@ public SamplerAggregationDescriptor() : base() private int? ShardSizeValue { get; set; } /// - /// Limits how many top-scoring documents are collected in the sample processed on each shard. + /// + /// Limits how many top-scoring documents are collected in the sample processed on each shard. + /// /// public SamplerAggregationDescriptor ShardSize(int? shardSize) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ScriptedMetricAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ScriptedMetricAggregation.g.cs index 9ac6361d939..ef63f9aebf7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ScriptedMetricAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ScriptedMetricAggregation.g.cs @@ -30,43 +30,63 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class ScriptedMetricAggregation { /// - /// Runs once on each shard after document collection is complete.
Allows the aggregation to consolidate the state returned from each shard. + /// + /// Runs once on each shard after document collection is complete. + /// Allows the aggregation to consolidate the state returned from each shard. + /// /// [JsonInclude, JsonPropertyName("combine_script")] public Elastic.Clients.Elasticsearch.Script? CombineScript { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } /// - /// Runs prior to any collection of documents.
Allows the aggregation to set up any initial state. + /// + /// Runs prior to any collection of documents. + /// Allows the aggregation to set up any initial state. + /// /// [JsonInclude, JsonPropertyName("init_script")] public Elastic.Clients.Elasticsearch.Script? InitScript { get; set; } /// - /// Run once per document collected.
If no `combine_script` is specified, the resulting state needs to be stored in the `state` object. + /// + /// Run once per document collected. + /// If no combine_script is specified, the resulting state needs to be stored in the state object. + /// /// [JsonInclude, JsonPropertyName("map_script")] public Elastic.Clients.Elasticsearch.Script? MapScript { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.FieldValue? Missing { get; set; } /// - /// A global object with script parameters for `init`, `map` and `combine` scripts.
It is shared between the scripts. + /// + /// A global object with script parameters for init, map and combine scripts. + /// It is shared between the scripts. + /// /// [JsonInclude, JsonPropertyName("params")] public IDictionary? Params { get; set; } /// - /// Runs once on the coordinating node after all shards have returned their results.
The script is provided with access to a variable `states`, which is an array of the result of the `combine_script` on each shard. + /// + /// Runs once on the coordinating node after all shards have returned their results. + /// The script is provided with access to a variable states, which is an array of the result of the combine_script on each shard. + /// /// [JsonInclude, JsonPropertyName("reduce_script")] public Elastic.Clients.Elasticsearch.Script? ReduceScript { get; set; } @@ -104,7 +124,10 @@ public ScriptedMetricAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// Runs once on each shard after document collection is complete.
Allows the aggregation to consolidate the state returned from each shard. + /// + /// Runs once on each shard after document collection is complete. + /// Allows the aggregation to consolidate the state returned from each shard. + /// /// public ScriptedMetricAggregationDescriptor CombineScript(Elastic.Clients.Elasticsearch.Script? combineScript) { @@ -131,7 +154,9 @@ public ScriptedMetricAggregationDescriptor CombineScript(Action - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ScriptedMetricAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -140,7 +165,9 @@ public ScriptedMetricAggregationDescriptor Field(Elastic.Clients.Elas } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ScriptedMetricAggregationDescriptor Field(Expression> field) { @@ -149,7 +176,9 @@ public ScriptedMetricAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ScriptedMetricAggregationDescriptor Field(Expression> field) { @@ -158,7 +187,10 @@ public ScriptedMetricAggregationDescriptor Field(Expression - /// Runs prior to any collection of documents.
Allows the aggregation to set up any initial state. + /// + /// Runs prior to any collection of documents. + /// Allows the aggregation to set up any initial state. + /// /// public ScriptedMetricAggregationDescriptor InitScript(Elastic.Clients.Elasticsearch.Script? initScript) { @@ -185,7 +217,10 @@ public ScriptedMetricAggregationDescriptor InitScript(Action - /// Run once per document collected.
If no `combine_script` is specified, the resulting state needs to be stored in the `state` object. + /// + /// Run once per document collected. + /// If no combine_script is specified, the resulting state needs to be stored in the state object. + /// /// public ScriptedMetricAggregationDescriptor MapScript(Elastic.Clients.Elasticsearch.Script? mapScript) { @@ -212,7 +247,10 @@ public ScriptedMetricAggregationDescriptor MapScript(Action - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public ScriptedMetricAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -221,7 +259,10 @@ public ScriptedMetricAggregationDescriptor Missing(Elastic.Clients.El } /// - /// A global object with script parameters for `init`, `map` and `combine` scripts.
It is shared between the scripts. + /// + /// A global object with script parameters for init, map and combine scripts. + /// It is shared between the scripts. + /// /// public ScriptedMetricAggregationDescriptor Params(Func, FluentDictionary> selector) { @@ -230,7 +271,10 @@ public ScriptedMetricAggregationDescriptor Params(Func - /// Runs once on the coordinating node after all shards have returned their results.
The script is provided with access to a variable `states`, which is an array of the result of the `combine_script` on each shard. + /// + /// Runs once on the coordinating node after all shards have returned their results. + /// The script is provided with access to a variable states, which is an array of the result of the combine_script on each shard. + /// /// public ScriptedMetricAggregationDescriptor ReduceScript(Elastic.Clients.Elasticsearch.Script? reduceScript) { @@ -413,7 +457,10 @@ public ScriptedMetricAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// Runs once on each shard after document collection is complete.
Allows the aggregation to consolidate the state returned from each shard. + /// + /// Runs once on each shard after document collection is complete. + /// Allows the aggregation to consolidate the state returned from each shard. + /// /// public ScriptedMetricAggregationDescriptor CombineScript(Elastic.Clients.Elasticsearch.Script? combineScript) { @@ -440,7 +487,9 @@ public ScriptedMetricAggregationDescriptor CombineScript(Action - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ScriptedMetricAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -449,7 +498,9 @@ public ScriptedMetricAggregationDescriptor Field(Elastic.Clients.Elasticsearch.F } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ScriptedMetricAggregationDescriptor Field(Expression> field) { @@ -458,7 +509,9 @@ public ScriptedMetricAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ScriptedMetricAggregationDescriptor Field(Expression> field) { @@ -467,7 +520,10 @@ public ScriptedMetricAggregationDescriptor Field(Expression - /// Runs prior to any collection of documents.
Allows the aggregation to set up any initial state. + /// + /// Runs prior to any collection of documents. + /// Allows the aggregation to set up any initial state. + /// /// public ScriptedMetricAggregationDescriptor InitScript(Elastic.Clients.Elasticsearch.Script? initScript) { @@ -494,7 +550,10 @@ public ScriptedMetricAggregationDescriptor InitScript(Action - /// Run once per document collected.
If no `combine_script` is specified, the resulting state needs to be stored in the `state` object. + /// + /// Run once per document collected. + /// If no combine_script is specified, the resulting state needs to be stored in the state object. + /// /// public ScriptedMetricAggregationDescriptor MapScript(Elastic.Clients.Elasticsearch.Script? mapScript) { @@ -521,7 +580,10 @@ public ScriptedMetricAggregationDescriptor MapScript(Action - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public ScriptedMetricAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -530,7 +592,10 @@ public ScriptedMetricAggregationDescriptor Missing(Elastic.Clients.Elasticsearch } /// - /// A global object with script parameters for `init`, `map` and `combine` scripts.
It is shared between the scripts. + /// + /// A global object with script parameters for init, map and combine scripts. + /// It is shared between the scripts. + /// /// public ScriptedMetricAggregationDescriptor Params(Func, FluentDictionary> selector) { @@ -539,7 +604,10 @@ public ScriptedMetricAggregationDescriptor Params(Func - /// Runs once on the coordinating node after all shards have returned their results.
The script is provided with access to a variable `states`, which is an array of the result of the `combine_script` on each shard. + /// + /// Runs once on the coordinating node after all shards have returned their results. + /// The script is provided with access to a variable states, which is an array of the result of the combine_script on each shard. + /// /// public ScriptedMetricAggregationDescriptor ReduceScript(Elastic.Clients.Elasticsearch.Script? reduceScript) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SerialDifferencingAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SerialDifferencingAggregation.g.cs index b0f35b6ab92..1d825be30c2 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SerialDifferencingAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SerialDifferencingAggregation.g.cs @@ -30,25 +30,35 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class SerialDifferencingAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? GapPolicy { get; set; } /// - /// The historical bucket to subtract from the current value.
Must be a positive, non-zero integer. + /// + /// The historical bucket to subtract from the current value. + /// Must be a positive, non-zero integer. + /// /// [JsonInclude, JsonPropertyName("lag")] public int? Lag { get; set; } @@ -70,7 +80,9 @@ public SerialDifferencingAggregationDescriptor() : base() private int? LagValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public SerialDifferencingAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? bucketsPath) { @@ -79,7 +91,10 @@ public SerialDifferencingAggregationDescriptor BucketsPath(Elastic.Clients.Elast } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public SerialDifferencingAggregationDescriptor Format(string? format) { @@ -88,7 +103,9 @@ public SerialDifferencingAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public SerialDifferencingAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? gapPolicy) { @@ -97,7 +114,10 @@ public SerialDifferencingAggregationDescriptor GapPolicy(Elastic.Clients.Elastic } /// - /// The historical bucket to subtract from the current value.
Must be a positive, non-zero integer. + /// + /// The historical bucket to subtract from the current value. + /// Must be a positive, non-zero integer. + /// /// public SerialDifferencingAggregationDescriptor Lag(int? lag) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SignificantLongTermsBucket.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SignificantLongTermsBucket.g.cs index f8e0a042f6a..bc249c8d098 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SignificantLongTermsBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SignificantLongTermsBucket.g.cs @@ -98,7 +98,9 @@ public override void Write(Utf8JsonWriter writer, SignificantLongTermsBucket val public sealed partial class SignificantLongTermsBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary Aggregations { get; init; } public long BgCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SignificantStringTermsBucket.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SignificantStringTermsBucket.g.cs index ef3e9ce86de..557a647c326 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SignificantStringTermsBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SignificantStringTermsBucket.g.cs @@ -91,7 +91,9 @@ public override void Write(Utf8JsonWriter writer, SignificantStringTermsBucket v public sealed partial class SignificantStringTermsBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary Aggregations { get; init; } public long BgCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SignificantTermsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SignificantTermsAggregation.g.cs index cace1814f7e..5f4223ea8a1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SignificantTermsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SignificantTermsAggregation.g.cs @@ -30,91 +30,123 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class SignificantTermsAggregation { /// - /// A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. + /// + /// A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. + /// /// [JsonInclude, JsonPropertyName("background_filter")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? BackgroundFilter { get; set; } /// - /// Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. + /// + /// Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. + /// /// [JsonInclude, JsonPropertyName("chi_square")] public Elastic.Clients.Elasticsearch.Aggregations.ChiSquareHeuristic? ChiSquare { get; set; } /// - /// Terms to exclude. + /// + /// Terms to exclude. + /// /// [JsonInclude, JsonPropertyName("exclude")] public Elastic.Clients.Elasticsearch.Aggregations.TermsExclude? Exclude { get; set; } /// - /// Mechanism by which the aggregation should be executed: using field values directly or using global ordinals. + /// + /// Mechanism by which the aggregation should be executed: using field values directly or using global ordinals. + /// /// [JsonInclude, JsonPropertyName("execution_hint")] public Elastic.Clients.Elasticsearch.Aggregations.TermsAggregationExecutionHint? ExecutionHint { get; set; } /// - /// The field from which to return significant terms. + /// + /// The field from which to return significant terms. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } /// - /// Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + /// + /// Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + /// /// [JsonInclude, JsonPropertyName("gnd")] public Elastic.Clients.Elasticsearch.Aggregations.GoogleNormalizedDistanceHeuristic? Gnd { get; set; } /// - /// Terms to include. + /// + /// Terms to include. + /// /// [JsonInclude, JsonPropertyName("include")] public Elastic.Clients.Elasticsearch.Aggregations.TermsInclude? Include { get; set; } /// - /// Use JLH score as the significance score. + /// + /// Use JLH score as the significance score. + /// /// [JsonInclude, JsonPropertyName("jlh")] public Elastic.Clients.Elasticsearch.EmptyObject? Jlh { get; set; } /// - /// Only return terms that are found in more than `min_doc_count` hits. + /// + /// Only return terms that are found in more than min_doc_count hits. + /// /// [JsonInclude, JsonPropertyName("min_doc_count")] public long? MinDocCount { get; set; } /// - /// Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. + /// + /// Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. + /// /// [JsonInclude, JsonPropertyName("mutual_information")] public Elastic.Clients.Elasticsearch.Aggregations.MutualInformationHeuristic? MutualInformation { get; set; } /// - /// A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. + /// + /// A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. + /// /// [JsonInclude, JsonPropertyName("percentage")] public Elastic.Clients.Elasticsearch.Aggregations.PercentageScoreHeuristic? Percentage { get; set; } /// - /// Customized score, implemented via a script. + /// + /// Customized score, implemented via a script. + /// /// [JsonInclude, JsonPropertyName("script_heuristic")] public Elastic.Clients.Elasticsearch.Aggregations.ScriptedHeuristic? ScriptHeuristic { get; set; } /// - /// Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`.
Terms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. + /// + /// Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the min_doc_count. + /// Terms will only be considered if their local shard frequency within the set is higher than the shard_min_doc_count. + /// /// [JsonInclude, JsonPropertyName("shard_min_doc_count")] public long? ShardMinDocCount { get; set; } /// - /// Can be used to control the volumes of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// + /// Can be used to control the volumes of candidate terms produced by each shard. + /// By default, shard_size will be automatically estimated based on the number of shards and the size parameter. + /// /// [JsonInclude, JsonPropertyName("shard_size")] public int? ShardSize { get; set; } /// - /// The number of buckets returned out of the overall terms list. + /// + /// The number of buckets returned out of the overall terms list. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } @@ -161,7 +193,9 @@ public SignificantTermsAggregationDescriptor() : base() private int? SizeValue { get; set; } /// - /// A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. + /// + /// A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. + /// /// public SignificantTermsAggregationDescriptor BackgroundFilter(Elastic.Clients.Elasticsearch.QueryDsl.Query? backgroundFilter) { @@ -188,7 +222,9 @@ public SignificantTermsAggregationDescriptor BackgroundFilter(Action< } /// - /// Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. + /// + /// Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. + /// /// public SignificantTermsAggregationDescriptor ChiSquare(Elastic.Clients.Elasticsearch.Aggregations.ChiSquareHeuristic? chiSquare) { @@ -215,7 +251,9 @@ public SignificantTermsAggregationDescriptor ChiSquare(Action - /// Terms to exclude. + /// + /// Terms to exclude. + /// /// public SignificantTermsAggregationDescriptor Exclude(Elastic.Clients.Elasticsearch.Aggregations.TermsExclude? exclude) { @@ -224,7 +262,9 @@ public SignificantTermsAggregationDescriptor Exclude(Elastic.Clients. } /// - /// Mechanism by which the aggregation should be executed: using field values directly or using global ordinals. + /// + /// Mechanism by which the aggregation should be executed: using field values directly or using global ordinals. + /// /// public SignificantTermsAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsearch.Aggregations.TermsAggregationExecutionHint? executionHint) { @@ -233,7 +273,9 @@ public SignificantTermsAggregationDescriptor ExecutionHint(Elastic.Cl } /// - /// The field from which to return significant terms. + /// + /// The field from which to return significant terms. + /// /// public SignificantTermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -242,7 +284,9 @@ public SignificantTermsAggregationDescriptor Field(Elastic.Clients.El } /// - /// The field from which to return significant terms. + /// + /// The field from which to return significant terms. + /// /// public SignificantTermsAggregationDescriptor Field(Expression> field) { @@ -251,7 +295,9 @@ public SignificantTermsAggregationDescriptor Field(Expression } /// - /// The field from which to return significant terms. + /// + /// The field from which to return significant terms. + /// /// public SignificantTermsAggregationDescriptor Field(Expression> field) { @@ -260,7 +306,9 @@ public SignificantTermsAggregationDescriptor Field(Expression - /// Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + /// + /// Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + /// /// public SignificantTermsAggregationDescriptor Gnd(Elastic.Clients.Elasticsearch.Aggregations.GoogleNormalizedDistanceHeuristic? gnd) { @@ -287,7 +335,9 @@ public SignificantTermsAggregationDescriptor Gnd(Action - /// Terms to include. + /// + /// Terms to include. + /// /// public SignificantTermsAggregationDescriptor Include(Elastic.Clients.Elasticsearch.Aggregations.TermsInclude? include) { @@ -296,7 +346,9 @@ public SignificantTermsAggregationDescriptor Include(Elastic.Clients. } /// - /// Use JLH score as the significance score. + /// + /// Use JLH score as the significance score. + /// /// public SignificantTermsAggregationDescriptor Jlh(Elastic.Clients.Elasticsearch.EmptyObject? jlh) { @@ -323,7 +375,9 @@ public SignificantTermsAggregationDescriptor Jlh(Action - /// Only return terms that are found in more than `min_doc_count` hits. + /// + /// Only return terms that are found in more than min_doc_count hits. + /// /// public SignificantTermsAggregationDescriptor MinDocCount(long? minDocCount) { @@ -332,7 +386,9 @@ public SignificantTermsAggregationDescriptor MinDocCount(long? minDoc } /// - /// Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. + /// + /// Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. + /// /// public SignificantTermsAggregationDescriptor MutualInformation(Elastic.Clients.Elasticsearch.Aggregations.MutualInformationHeuristic? mutualInformation) { @@ -359,7 +415,9 @@ public SignificantTermsAggregationDescriptor MutualInformation(Action } /// - /// A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. + /// + /// A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. + /// /// public SignificantTermsAggregationDescriptor Percentage(Elastic.Clients.Elasticsearch.Aggregations.PercentageScoreHeuristic? percentage) { @@ -386,7 +444,9 @@ public SignificantTermsAggregationDescriptor Percentage(Action - /// Customized score, implemented via a script. + /// + /// Customized score, implemented via a script. + /// /// public SignificantTermsAggregationDescriptor ScriptHeuristic(Elastic.Clients.Elasticsearch.Aggregations.ScriptedHeuristic? scriptHeuristic) { @@ -413,7 +473,10 @@ public SignificantTermsAggregationDescriptor ScriptHeuristic(Action - /// Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`.
Terms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. + /// + /// Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the min_doc_count. + /// Terms will only be considered if their local shard frequency within the set is higher than the shard_min_doc_count. + /// /// public SignificantTermsAggregationDescriptor ShardMinDocCount(long? shardMinDocCount) { @@ -422,7 +485,10 @@ public SignificantTermsAggregationDescriptor ShardMinDocCount(long? s } /// - /// Can be used to control the volumes of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// + /// Can be used to control the volumes of candidate terms produced by each shard. + /// By default, shard_size will be automatically estimated based on the number of shards and the size parameter. + /// /// public SignificantTermsAggregationDescriptor ShardSize(int? shardSize) { @@ -431,7 +497,9 @@ public SignificantTermsAggregationDescriptor ShardSize(int? shardSize } /// - /// The number of buckets returned out of the overall terms list. + /// + /// The number of buckets returned out of the overall terms list. + /// /// public SignificantTermsAggregationDescriptor Size(int? size) { @@ -645,7 +713,9 @@ public SignificantTermsAggregationDescriptor() : base() private int? SizeValue { get; set; } /// - /// A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. + /// + /// A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. + /// /// public SignificantTermsAggregationDescriptor BackgroundFilter(Elastic.Clients.Elasticsearch.QueryDsl.Query? backgroundFilter) { @@ -672,7 +742,9 @@ public SignificantTermsAggregationDescriptor BackgroundFilter(Action - /// Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. + /// + /// Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. + /// /// public SignificantTermsAggregationDescriptor ChiSquare(Elastic.Clients.Elasticsearch.Aggregations.ChiSquareHeuristic? chiSquare) { @@ -699,7 +771,9 @@ public SignificantTermsAggregationDescriptor ChiSquare(Action - /// Terms to exclude. + /// + /// Terms to exclude. + /// /// public SignificantTermsAggregationDescriptor Exclude(Elastic.Clients.Elasticsearch.Aggregations.TermsExclude? exclude) { @@ -708,7 +782,9 @@ public SignificantTermsAggregationDescriptor Exclude(Elastic.Clients.Elasticsear } /// - /// Mechanism by which the aggregation should be executed: using field values directly or using global ordinals. + /// + /// Mechanism by which the aggregation should be executed: using field values directly or using global ordinals. + /// /// public SignificantTermsAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsearch.Aggregations.TermsAggregationExecutionHint? executionHint) { @@ -717,7 +793,9 @@ public SignificantTermsAggregationDescriptor ExecutionHint(Elastic.Clients.Elast } /// - /// The field from which to return significant terms. + /// + /// The field from which to return significant terms. + /// /// public SignificantTermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -726,7 +804,9 @@ public SignificantTermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch } /// - /// The field from which to return significant terms. + /// + /// The field from which to return significant terms. + /// /// public SignificantTermsAggregationDescriptor Field(Expression> field) { @@ -735,7 +815,9 @@ public SignificantTermsAggregationDescriptor Field(Expression } /// - /// The field from which to return significant terms. + /// + /// The field from which to return significant terms. + /// /// public SignificantTermsAggregationDescriptor Field(Expression> field) { @@ -744,7 +826,9 @@ public SignificantTermsAggregationDescriptor Field(Expression - /// Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + /// + /// Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + /// /// public SignificantTermsAggregationDescriptor Gnd(Elastic.Clients.Elasticsearch.Aggregations.GoogleNormalizedDistanceHeuristic? gnd) { @@ -771,7 +855,9 @@ public SignificantTermsAggregationDescriptor Gnd(Action - /// Terms to include. + /// + /// Terms to include. + /// /// public SignificantTermsAggregationDescriptor Include(Elastic.Clients.Elasticsearch.Aggregations.TermsInclude? include) { @@ -780,7 +866,9 @@ public SignificantTermsAggregationDescriptor Include(Elastic.Clients.Elasticsear } /// - /// Use JLH score as the significance score. + /// + /// Use JLH score as the significance score. + /// /// public SignificantTermsAggregationDescriptor Jlh(Elastic.Clients.Elasticsearch.EmptyObject? jlh) { @@ -807,7 +895,9 @@ public SignificantTermsAggregationDescriptor Jlh(Action - /// Only return terms that are found in more than `min_doc_count` hits. + /// + /// Only return terms that are found in more than min_doc_count hits. + /// /// public SignificantTermsAggregationDescriptor MinDocCount(long? minDocCount) { @@ -816,7 +906,9 @@ public SignificantTermsAggregationDescriptor MinDocCount(long? minDocCount) } /// - /// Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. + /// + /// Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. + /// /// public SignificantTermsAggregationDescriptor MutualInformation(Elastic.Clients.Elasticsearch.Aggregations.MutualInformationHeuristic? mutualInformation) { @@ -843,7 +935,9 @@ public SignificantTermsAggregationDescriptor MutualInformation(Action - /// A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. + /// + /// A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. + /// /// public SignificantTermsAggregationDescriptor Percentage(Elastic.Clients.Elasticsearch.Aggregations.PercentageScoreHeuristic? percentage) { @@ -870,7 +964,9 @@ public SignificantTermsAggregationDescriptor Percentage(Action - /// Customized score, implemented via a script. + /// + /// Customized score, implemented via a script. + /// /// public SignificantTermsAggregationDescriptor ScriptHeuristic(Elastic.Clients.Elasticsearch.Aggregations.ScriptedHeuristic? scriptHeuristic) { @@ -897,7 +993,10 @@ public SignificantTermsAggregationDescriptor ScriptHeuristic(Action - /// Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`.
Terms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. + /// + /// Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the min_doc_count. + /// Terms will only be considered if their local shard frequency within the set is higher than the shard_min_doc_count. + /// /// public SignificantTermsAggregationDescriptor ShardMinDocCount(long? shardMinDocCount) { @@ -906,7 +1005,10 @@ public SignificantTermsAggregationDescriptor ShardMinDocCount(long? shardMinDocC } /// - /// Can be used to control the volumes of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// + /// Can be used to control the volumes of candidate terms produced by each shard. + /// By default, shard_size will be automatically estimated based on the number of shards and the size parameter. + /// /// public SignificantTermsAggregationDescriptor ShardSize(int? shardSize) { @@ -915,7 +1017,9 @@ public SignificantTermsAggregationDescriptor ShardSize(int? shardSize) } /// - /// The number of buckets returned out of the overall terms list. + /// + /// The number of buckets returned out of the overall terms list. + /// /// public SignificantTermsAggregationDescriptor Size(int? size) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SignificantTextAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SignificantTextAggregation.g.cs index b86fdf06ac4..09fa408e2cf 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SignificantTextAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SignificantTextAggregation.g.cs @@ -30,103 +30,139 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class SignificantTextAggregation { /// - /// A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. + /// + /// A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. + /// /// [JsonInclude, JsonPropertyName("background_filter")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? BackgroundFilter { get; set; } /// - /// Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. + /// + /// Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. + /// /// [JsonInclude, JsonPropertyName("chi_square")] public Elastic.Clients.Elasticsearch.Aggregations.ChiSquareHeuristic? ChiSquare { get; set; } /// - /// Values to exclude. + /// + /// Values to exclude. + /// /// [JsonInclude, JsonPropertyName("exclude")] public Elastic.Clients.Elasticsearch.Aggregations.TermsExclude? Exclude { get; set; } /// - /// Determines whether the aggregation will use field values directly or global ordinals. + /// + /// Determines whether the aggregation will use field values directly or global ordinals. + /// /// [JsonInclude, JsonPropertyName("execution_hint")] public Elastic.Clients.Elasticsearch.Aggregations.TermsAggregationExecutionHint? ExecutionHint { get; set; } /// - /// The field from which to return significant text. + /// + /// The field from which to return significant text. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } /// - /// Whether to out duplicate text to deal with noisy data. + /// + /// Whether to out duplicate text to deal with noisy data. + /// /// [JsonInclude, JsonPropertyName("filter_duplicate_text")] public bool? FilterDuplicateText { get; set; } /// - /// Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + /// + /// Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + /// /// [JsonInclude, JsonPropertyName("gnd")] public Elastic.Clients.Elasticsearch.Aggregations.GoogleNormalizedDistanceHeuristic? Gnd { get; set; } /// - /// Values to include. + /// + /// Values to include. + /// /// [JsonInclude, JsonPropertyName("include")] public Elastic.Clients.Elasticsearch.Aggregations.TermsInclude? Include { get; set; } /// - /// Use JLH score as the significance score. + /// + /// Use JLH score as the significance score. + /// /// [JsonInclude, JsonPropertyName("jlh")] public Elastic.Clients.Elasticsearch.EmptyObject? Jlh { get; set; } /// - /// Only return values that are found in more than `min_doc_count` hits. + /// + /// Only return values that are found in more than min_doc_count hits. + /// /// [JsonInclude, JsonPropertyName("min_doc_count")] public long? MinDocCount { get; set; } /// - /// Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. + /// + /// Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. + /// /// [JsonInclude, JsonPropertyName("mutual_information")] public Elastic.Clients.Elasticsearch.Aggregations.MutualInformationHeuristic? MutualInformation { get; set; } /// - /// A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. + /// + /// A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. + /// /// [JsonInclude, JsonPropertyName("percentage")] public Elastic.Clients.Elasticsearch.Aggregations.PercentageScoreHeuristic? Percentage { get; set; } /// - /// Customized score, implemented via a script. + /// + /// Customized score, implemented via a script. + /// /// [JsonInclude, JsonPropertyName("script_heuristic")] public Elastic.Clients.Elasticsearch.Aggregations.ScriptedHeuristic? ScriptHeuristic { get; set; } /// - /// Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the min_doc_count.
Values will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. + /// + /// Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the min_doc_count. + /// Values will only be considered if their local shard frequency within the set is higher than the shard_min_doc_count. + /// /// [JsonInclude, JsonPropertyName("shard_min_doc_count")] public long? ShardMinDocCount { get; set; } /// - /// The number of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// + /// The number of candidate terms produced by each shard. + /// By default, shard_size will be automatically estimated based on the number of shards and the size parameter. + /// /// [JsonInclude, JsonPropertyName("shard_size")] public int? ShardSize { get; set; } /// - /// The number of buckets returned out of the overall terms list. + /// + /// The number of buckets returned out of the overall terms list. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// Overrides the JSON `_source` fields from which text will be analyzed. + /// + /// Overrides the JSON _source fields from which text will be analyzed. + /// /// [JsonInclude, JsonPropertyName("source_fields")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] @@ -176,7 +212,9 @@ public SignificantTextAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Fields? SourceFieldsValue { get; set; } /// - /// A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. + /// + /// A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. + /// /// public SignificantTextAggregationDescriptor BackgroundFilter(Elastic.Clients.Elasticsearch.QueryDsl.Query? backgroundFilter) { @@ -203,7 +241,9 @@ public SignificantTextAggregationDescriptor BackgroundFilter(Action - /// Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. + /// + /// Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. + /// /// public SignificantTextAggregationDescriptor ChiSquare(Elastic.Clients.Elasticsearch.Aggregations.ChiSquareHeuristic? chiSquare) { @@ -230,7 +270,9 @@ public SignificantTextAggregationDescriptor ChiSquare(Action - /// Values to exclude. + /// + /// Values to exclude. + /// /// public SignificantTextAggregationDescriptor Exclude(Elastic.Clients.Elasticsearch.Aggregations.TermsExclude? exclude) { @@ -239,7 +281,9 @@ public SignificantTextAggregationDescriptor Exclude(Elastic.Clients.E } /// - /// Determines whether the aggregation will use field values directly or global ordinals. + /// + /// Determines whether the aggregation will use field values directly or global ordinals. + /// /// public SignificantTextAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsearch.Aggregations.TermsAggregationExecutionHint? executionHint) { @@ -248,7 +292,9 @@ public SignificantTextAggregationDescriptor ExecutionHint(Elastic.Cli } /// - /// The field from which to return significant text. + /// + /// The field from which to return significant text. + /// /// public SignificantTextAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -257,7 +303,9 @@ public SignificantTextAggregationDescriptor Field(Elastic.Clients.Ela } /// - /// The field from which to return significant text. + /// + /// The field from which to return significant text. + /// /// public SignificantTextAggregationDescriptor Field(Expression> field) { @@ -266,7 +314,9 @@ public SignificantTextAggregationDescriptor Field(Expression< } /// - /// The field from which to return significant text. + /// + /// The field from which to return significant text. + /// /// public SignificantTextAggregationDescriptor Field(Expression> field) { @@ -275,7 +325,9 @@ public SignificantTextAggregationDescriptor Field(Expression - /// Whether to out duplicate text to deal with noisy data. + /// + /// Whether to out duplicate text to deal with noisy data. + /// /// public SignificantTextAggregationDescriptor FilterDuplicateText(bool? filterDuplicateText = true) { @@ -284,7 +336,9 @@ public SignificantTextAggregationDescriptor FilterDuplicateText(bool? } /// - /// Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + /// + /// Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + /// /// public SignificantTextAggregationDescriptor Gnd(Elastic.Clients.Elasticsearch.Aggregations.GoogleNormalizedDistanceHeuristic? gnd) { @@ -311,7 +365,9 @@ public SignificantTextAggregationDescriptor Gnd(Action - /// Values to include. + /// + /// Values to include. + /// /// public SignificantTextAggregationDescriptor Include(Elastic.Clients.Elasticsearch.Aggregations.TermsInclude? include) { @@ -320,7 +376,9 @@ public SignificantTextAggregationDescriptor Include(Elastic.Clients.E } /// - /// Use JLH score as the significance score. + /// + /// Use JLH score as the significance score. + /// /// public SignificantTextAggregationDescriptor Jlh(Elastic.Clients.Elasticsearch.EmptyObject? jlh) { @@ -347,7 +405,9 @@ public SignificantTextAggregationDescriptor Jlh(Action - /// Only return values that are found in more than `min_doc_count` hits. + /// + /// Only return values that are found in more than min_doc_count hits. + /// /// public SignificantTextAggregationDescriptor MinDocCount(long? minDocCount) { @@ -356,7 +416,9 @@ public SignificantTextAggregationDescriptor MinDocCount(long? minDocC } /// - /// Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. + /// + /// Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. + /// /// public SignificantTextAggregationDescriptor MutualInformation(Elastic.Clients.Elasticsearch.Aggregations.MutualInformationHeuristic? mutualInformation) { @@ -383,7 +445,9 @@ public SignificantTextAggregationDescriptor MutualInformation(Action< } /// - /// A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. + /// + /// A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. + /// /// public SignificantTextAggregationDescriptor Percentage(Elastic.Clients.Elasticsearch.Aggregations.PercentageScoreHeuristic? percentage) { @@ -410,7 +474,9 @@ public SignificantTextAggregationDescriptor Percentage(Action - /// Customized score, implemented via a script. + /// + /// Customized score, implemented via a script. + /// /// public SignificantTextAggregationDescriptor ScriptHeuristic(Elastic.Clients.Elasticsearch.Aggregations.ScriptedHeuristic? scriptHeuristic) { @@ -437,7 +503,10 @@ public SignificantTextAggregationDescriptor ScriptHeuristic(Action - /// Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the min_doc_count.
Values will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. + /// + /// Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the min_doc_count. + /// Values will only be considered if their local shard frequency within the set is higher than the shard_min_doc_count. + /// /// public SignificantTextAggregationDescriptor ShardMinDocCount(long? shardMinDocCount) { @@ -446,7 +515,10 @@ public SignificantTextAggregationDescriptor ShardMinDocCount(long? sh } /// - /// The number of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// + /// The number of candidate terms produced by each shard. + /// By default, shard_size will be automatically estimated based on the number of shards and the size parameter. + /// /// public SignificantTextAggregationDescriptor ShardSize(int? shardSize) { @@ -455,7 +527,9 @@ public SignificantTextAggregationDescriptor ShardSize(int? shardSize) } /// - /// The number of buckets returned out of the overall terms list. + /// + /// The number of buckets returned out of the overall terms list. + /// /// public SignificantTextAggregationDescriptor Size(int? size) { @@ -464,7 +538,9 @@ public SignificantTextAggregationDescriptor Size(int? size) } /// - /// Overrides the JSON `_source` fields from which text will be analyzed. + /// + /// Overrides the JSON _source fields from which text will be analyzed. + /// /// public SignificantTextAggregationDescriptor SourceFields(Elastic.Clients.Elasticsearch.Fields? sourceFields) { @@ -692,7 +768,9 @@ public SignificantTextAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Fields? SourceFieldsValue { get; set; } /// - /// A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. + /// + /// A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. + /// /// public SignificantTextAggregationDescriptor BackgroundFilter(Elastic.Clients.Elasticsearch.QueryDsl.Query? backgroundFilter) { @@ -719,7 +797,9 @@ public SignificantTextAggregationDescriptor BackgroundFilter(Action - /// Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. + /// + /// Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. + /// /// public SignificantTextAggregationDescriptor ChiSquare(Elastic.Clients.Elasticsearch.Aggregations.ChiSquareHeuristic? chiSquare) { @@ -746,7 +826,9 @@ public SignificantTextAggregationDescriptor ChiSquare(Action - /// Values to exclude. + /// + /// Values to exclude. + /// /// public SignificantTextAggregationDescriptor Exclude(Elastic.Clients.Elasticsearch.Aggregations.TermsExclude? exclude) { @@ -755,7 +837,9 @@ public SignificantTextAggregationDescriptor Exclude(Elastic.Clients.Elasticsearc } /// - /// Determines whether the aggregation will use field values directly or global ordinals. + /// + /// Determines whether the aggregation will use field values directly or global ordinals. + /// /// public SignificantTextAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsearch.Aggregations.TermsAggregationExecutionHint? executionHint) { @@ -764,7 +848,9 @@ public SignificantTextAggregationDescriptor ExecutionHint(Elastic.Clients.Elasti } /// - /// The field from which to return significant text. + /// + /// The field from which to return significant text. + /// /// public SignificantTextAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -773,7 +859,9 @@ public SignificantTextAggregationDescriptor Field(Elastic.Clients.Elasticsearch. } /// - /// The field from which to return significant text. + /// + /// The field from which to return significant text. + /// /// public SignificantTextAggregationDescriptor Field(Expression> field) { @@ -782,7 +870,9 @@ public SignificantTextAggregationDescriptor Field(Expression< } /// - /// The field from which to return significant text. + /// + /// The field from which to return significant text. + /// /// public SignificantTextAggregationDescriptor Field(Expression> field) { @@ -791,7 +881,9 @@ public SignificantTextAggregationDescriptor Field(Expression - /// Whether to out duplicate text to deal with noisy data. + /// + /// Whether to out duplicate text to deal with noisy data. + /// /// public SignificantTextAggregationDescriptor FilterDuplicateText(bool? filterDuplicateText = true) { @@ -800,7 +892,9 @@ public SignificantTextAggregationDescriptor FilterDuplicateText(bool? filterDupl } /// - /// Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + /// + /// Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + /// /// public SignificantTextAggregationDescriptor Gnd(Elastic.Clients.Elasticsearch.Aggregations.GoogleNormalizedDistanceHeuristic? gnd) { @@ -827,7 +921,9 @@ public SignificantTextAggregationDescriptor Gnd(Action - /// Values to include. + /// + /// Values to include. + /// /// public SignificantTextAggregationDescriptor Include(Elastic.Clients.Elasticsearch.Aggregations.TermsInclude? include) { @@ -836,7 +932,9 @@ public SignificantTextAggregationDescriptor Include(Elastic.Clients.Elasticsearc } /// - /// Use JLH score as the significance score. + /// + /// Use JLH score as the significance score. + /// /// public SignificantTextAggregationDescriptor Jlh(Elastic.Clients.Elasticsearch.EmptyObject? jlh) { @@ -863,7 +961,9 @@ public SignificantTextAggregationDescriptor Jlh(Action - /// Only return values that are found in more than `min_doc_count` hits. + /// + /// Only return values that are found in more than min_doc_count hits. + /// /// public SignificantTextAggregationDescriptor MinDocCount(long? minDocCount) { @@ -872,7 +972,9 @@ public SignificantTextAggregationDescriptor MinDocCount(long? minDocCount) } /// - /// Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. + /// + /// Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. + /// /// public SignificantTextAggregationDescriptor MutualInformation(Elastic.Clients.Elasticsearch.Aggregations.MutualInformationHeuristic? mutualInformation) { @@ -899,7 +1001,9 @@ public SignificantTextAggregationDescriptor MutualInformation(Action - /// A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. + /// + /// A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. + /// /// public SignificantTextAggregationDescriptor Percentage(Elastic.Clients.Elasticsearch.Aggregations.PercentageScoreHeuristic? percentage) { @@ -926,7 +1030,9 @@ public SignificantTextAggregationDescriptor Percentage(Action - /// Customized score, implemented via a script. + /// + /// Customized score, implemented via a script. + /// /// public SignificantTextAggregationDescriptor ScriptHeuristic(Elastic.Clients.Elasticsearch.Aggregations.ScriptedHeuristic? scriptHeuristic) { @@ -953,7 +1059,10 @@ public SignificantTextAggregationDescriptor ScriptHeuristic(Action - /// Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the min_doc_count.
Values will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. + /// + /// Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the min_doc_count. + /// Values will only be considered if their local shard frequency within the set is higher than the shard_min_doc_count. + /// /// public SignificantTextAggregationDescriptor ShardMinDocCount(long? shardMinDocCount) { @@ -962,7 +1071,10 @@ public SignificantTextAggregationDescriptor ShardMinDocCount(long? shardMinDocCo } /// - /// The number of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// + /// The number of candidate terms produced by each shard. + /// By default, shard_size will be automatically estimated based on the number of shards and the size parameter. + /// /// public SignificantTextAggregationDescriptor ShardSize(int? shardSize) { @@ -971,7 +1083,9 @@ public SignificantTextAggregationDescriptor ShardSize(int? shardSize) } /// - /// The number of buckets returned out of the overall terms list. + /// + /// The number of buckets returned out of the overall terms list. + /// /// public SignificantTextAggregationDescriptor Size(int? size) { @@ -980,7 +1094,9 @@ public SignificantTextAggregationDescriptor Size(int? size) } /// - /// Overrides the JSON `_source` fields from which text will be analyzed. + /// + /// Overrides the JSON _source fields from which text will be analyzed. + /// /// public SignificantTextAggregationDescriptor SourceFields(Elastic.Clients.Elasticsearch.Fields? sourceFields) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SimpleValueAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SimpleValueAggregate.g.cs index 896a16297e5..00e7be7375c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SimpleValueAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SimpleValueAggregate.g.cs @@ -33,7 +33,10 @@ public sealed partial class SimpleValueAggregate : IAggregate public IReadOnlyDictionary? Meta { get; init; } /// - /// The metric value. A missing value generally means that there was no data to aggregate,
unless specified otherwise. + /// + /// The metric value. A missing value generally means that there was no data to aggregate, + /// unless specified otherwise. + /// /// [JsonInclude, JsonPropertyName("value")] public double? Value { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StatsAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StatsAggregate.g.cs index 641097ff092..35562889db5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StatsAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StatsAggregate.g.cs @@ -28,7 +28,10 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; /// -/// Statistics aggregation result. `min`, `max` and `avg` are missing if there were no values to process
(`count` is zero). +/// +/// Statistics aggregation result. min, max and avg are missing if there were no values to process +/// (count is zero). +/// /// public sealed partial class StatsAggregate : IAggregate { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StatsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StatsAggregation.g.cs index 4fe406f5d1b..6d8b229d3e0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StatsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StatsAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class StatsAggregation { /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } @@ -38,7 +40,10 @@ public sealed partial class StatsAggregation public string? Format { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.FieldValue? Missing { get; set; } @@ -64,7 +69,9 @@ public StatsAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public StatsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -73,7 +80,9 @@ public StatsAggregationDescriptor Field(Elastic.Clients.Elasticsearch } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public StatsAggregationDescriptor Field(Expression> field) { @@ -82,7 +91,9 @@ public StatsAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public StatsAggregationDescriptor Field(Expression> field) { @@ -97,7 +108,10 @@ public StatsAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public StatsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -186,7 +200,9 @@ public StatsAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public StatsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -195,7 +211,9 @@ public StatsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? fie } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public StatsAggregationDescriptor Field(Expression> field) { @@ -204,7 +222,9 @@ public StatsAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public StatsAggregationDescriptor Field(Expression> field) { @@ -219,7 +239,10 @@ public StatsAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public StatsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StatsBucketAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StatsBucketAggregation.g.cs index 9562ae23ea5..b49f6b54603 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StatsBucketAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StatsBucketAggregation.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class StatsBucketAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? GapPolicy { get; set; } @@ -63,7 +70,9 @@ public StatsBucketAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? GapPolicyValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public StatsBucketAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? bucketsPath) { @@ -72,7 +81,10 @@ public StatsBucketAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearc } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public StatsBucketAggregationDescriptor Format(string? format) { @@ -81,7 +93,9 @@ public StatsBucketAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public StatsBucketAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? gapPolicy) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StringRareTermsAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StringRareTermsAggregate.g.cs index c8ffbb7a3d8..405760fb953 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StringRareTermsAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StringRareTermsAggregate.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; /// -/// Result of the `rare_terms` aggregation when the field is a string. +/// +/// Result of the rare_terms aggregation when the field is a string. +/// /// public sealed partial class StringRareTermsAggregate : IAggregate { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StringRareTermsBucket.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StringRareTermsBucket.g.cs index da5515554e0..f704ddde80d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StringRareTermsBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StringRareTermsBucket.g.cs @@ -77,7 +77,9 @@ public override void Write(Utf8JsonWriter writer, StringRareTermsBucket value, J public sealed partial class StringRareTermsBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StringStatsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StringStatsAggregation.g.cs index ba8084b58ad..5a449e0b8c7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StringStatsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StringStatsAggregation.g.cs @@ -30,13 +30,18 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class StringStatsAggregation { /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.FieldValue? Missing { get; set; } @@ -44,7 +49,9 @@ public sealed partial class StringStatsAggregation public Elastic.Clients.Elasticsearch.Script? Script { get; set; } /// - /// Shows the probability distribution for all characters. + /// + /// Shows the probability distribution for all characters. + /// /// [JsonInclude, JsonPropertyName("show_distribution")] public bool? ShowDistribution { get; set; } @@ -68,7 +75,9 @@ public StringStatsAggregationDescriptor() : base() private bool? ShowDistributionValue { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public StringStatsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -77,7 +86,9 @@ public StringStatsAggregationDescriptor Field(Elastic.Clients.Elastic } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public StringStatsAggregationDescriptor Field(Expression> field) { @@ -86,7 +97,9 @@ public StringStatsAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public StringStatsAggregationDescriptor Field(Expression> field) { @@ -95,7 +108,10 @@ public StringStatsAggregationDescriptor Field(Expression - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public StringStatsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -128,7 +144,9 @@ public StringStatsAggregationDescriptor Script(Action - /// Shows the probability distribution for all characters. + /// + /// Shows the probability distribution for all characters. + /// /// public StringStatsAggregationDescriptor ShowDistribution(bool? showDistribution = true) { @@ -193,7 +211,9 @@ public StringStatsAggregationDescriptor() : base() private bool? ShowDistributionValue { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public StringStatsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -202,7 +222,9 @@ public StringStatsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Fiel } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public StringStatsAggregationDescriptor Field(Expression> field) { @@ -211,7 +233,9 @@ public StringStatsAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public StringStatsAggregationDescriptor Field(Expression> field) { @@ -220,7 +244,10 @@ public StringStatsAggregationDescriptor Field(Expression - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public StringStatsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -253,7 +280,9 @@ public StringStatsAggregationDescriptor Script(Action - /// Shows the probability distribution for all characters. + /// + /// Shows the probability distribution for all characters. + /// /// public StringStatsAggregationDescriptor ShowDistribution(bool? showDistribution = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StringTermsAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StringTermsAggregate.g.cs index c62df21b75a..91cc63038f0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StringTermsAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StringTermsAggregate.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; /// -/// Result of a `terms` aggregation when the field is a string. +/// +/// Result of a terms aggregation when the field is a string. +/// /// public sealed partial class StringTermsAggregate : IAggregate { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StringTermsBucket.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StringTermsBucket.g.cs index 662c555cbb5..72ce873ca08 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StringTermsBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StringTermsBucket.g.cs @@ -84,7 +84,9 @@ public override void Write(Utf8JsonWriter writer, StringTermsBucket value, JsonS public sealed partial class StringTermsBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SumAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SumAggregate.g.cs index 37e8b722a52..23cb1250502 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SumAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SumAggregate.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; /// -/// Sum aggregation result. `value` is always present and is zero if there were no values to process. +/// +/// Sum aggregation result. value is always present and is zero if there were no values to process. +/// /// public sealed partial class SumAggregate : IAggregate { @@ -36,7 +38,10 @@ public sealed partial class SumAggregate : IAggregate public IReadOnlyDictionary? Meta { get; init; } /// - /// The metric value. A missing value generally means that there was no data to aggregate,
unless specified otherwise. + /// + /// The metric value. A missing value generally means that there was no data to aggregate, + /// unless specified otherwise. + /// /// [JsonInclude, JsonPropertyName("value")] public double? Value { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SumAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SumAggregation.g.cs index 73f9f38e87d..cd574e0104a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SumAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SumAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class SumAggregation { /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } @@ -38,7 +40,10 @@ public sealed partial class SumAggregation public string? Format { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.FieldValue? Missing { get; set; } @@ -64,7 +69,9 @@ public SumAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public SumAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -73,7 +80,9 @@ public SumAggregationDescriptor Field(Elastic.Clients.Elasticsearch.F } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public SumAggregationDescriptor Field(Expression> field) { @@ -82,7 +91,9 @@ public SumAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public SumAggregationDescriptor Field(Expression> field) { @@ -97,7 +108,10 @@ public SumAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public SumAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -186,7 +200,9 @@ public SumAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public SumAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -195,7 +211,9 @@ public SumAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public SumAggregationDescriptor Field(Expression> field) { @@ -204,7 +222,9 @@ public SumAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public SumAggregationDescriptor Field(Expression> field) { @@ -219,7 +239,10 @@ public SumAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public SumAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SumBucketAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SumBucketAggregation.g.cs index ce715b4cc80..62d742e21e0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SumBucketAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SumBucketAggregation.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class SumBucketAggregation { /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// [JsonInclude, JsonPropertyName("buckets_path")] public Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? BucketsPath { get; set; } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// [JsonInclude, JsonPropertyName("gap_policy")] public Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? GapPolicy { get; set; } @@ -63,7 +70,9 @@ public SumBucketAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? GapPolicyValue { get; set; } /// - /// Path to the buckets that contain one set of values to correlate. + /// + /// Path to the buckets that contain one set of values to correlate. + /// /// public SumBucketAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? bucketsPath) { @@ -72,7 +81,10 @@ public SumBucketAggregationDescriptor BucketsPath(Elastic.Clients.Elasticsearch. } /// - /// `DecimalFormat` pattern for the output value.
If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + /// + /// DecimalFormat pattern for the output value. + /// If specified, the formatted value is returned in the aggregation’s value_as_string property. + /// /// public SumBucketAggregationDescriptor Format(string? format) { @@ -81,7 +93,9 @@ public SumBucketAggregationDescriptor Format(string? format) } /// - /// Policy to apply when gaps are found in the data. + /// + /// Policy to apply when gaps are found in the data. + /// /// public SumBucketAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? gapPolicy) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TDigest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TDigest.g.cs index 5ac8d211326..cacf562c892 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TDigest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TDigest.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class TDigest { /// - /// Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. + /// + /// Limits the maximum number of nodes used by the underlying TDigest algorithm to 20 * compression, enabling control of memory usage and approximation error. + /// /// [JsonInclude, JsonPropertyName("compression")] public int? Compression { get; set; } @@ -47,7 +49,9 @@ public TDigestDescriptor() : base() private int? CompressionValue { get; set; } /// - /// Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. + /// + /// Limits the maximum number of nodes used by the underlying TDigest algorithm to 20 * compression, enabling control of memory usage and approximation error. + /// /// public TDigestDescriptor Compression(int? compression) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TTestAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TTestAggregation.g.cs index 4e44151543f..7ef4ebb1ed1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TTestAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TTestAggregation.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class TTestAggregation { /// - /// Test population A. + /// + /// Test population A. + /// /// [JsonInclude, JsonPropertyName("a")] public Elastic.Clients.Elasticsearch.Aggregations.TestPopulation? a { get; set; } /// - /// Test population B. + /// + /// Test population B. + /// /// [JsonInclude, JsonPropertyName("b")] public Elastic.Clients.Elasticsearch.Aggregations.TestPopulation? b { get; set; } /// - /// The type of test. + /// + /// The type of test. + /// /// [JsonInclude, JsonPropertyName("type")] public Elastic.Clients.Elasticsearch.Aggregations.TTestType? Type { get; set; } @@ -67,7 +73,9 @@ public TTestAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Aggregations.TTestType? TypeValue { get; set; } /// - /// Test population A. + /// + /// Test population A. + /// /// public TTestAggregationDescriptor a(Elastic.Clients.Elasticsearch.Aggregations.TestPopulation? a) { @@ -94,7 +102,9 @@ public TTestAggregationDescriptor a(Action - /// Test population B. + /// + /// Test population B. + /// /// public TTestAggregationDescriptor b(Elastic.Clients.Elasticsearch.Aggregations.TestPopulation? b) { @@ -121,7 +131,9 @@ public TTestAggregationDescriptor b(Action - /// The type of test. + /// + /// The type of test. + /// /// public TTestAggregationDescriptor Type(Elastic.Clients.Elasticsearch.Aggregations.TTestType? type) { @@ -191,7 +203,9 @@ public TTestAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Aggregations.TTestType? TypeValue { get; set; } /// - /// Test population A. + /// + /// Test population A. + /// /// public TTestAggregationDescriptor a(Elastic.Clients.Elasticsearch.Aggregations.TestPopulation? a) { @@ -218,7 +232,9 @@ public TTestAggregationDescriptor a(Action - /// Test population B. + /// + /// Test population B. + /// /// public TTestAggregationDescriptor b(Elastic.Clients.Elasticsearch.Aggregations.TestPopulation? b) { @@ -245,7 +261,9 @@ public TTestAggregationDescriptor b(Action - /// The type of test. + /// + /// The type of test. + /// /// public TTestAggregationDescriptor Type(Elastic.Clients.Elasticsearch.Aggregations.TTestType? type) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TermsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TermsAggregation.g.cs index 04adea30f82..3239f08c0e8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TermsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TermsAggregation.g.cs @@ -30,25 +30,34 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class TermsAggregation { /// - /// Determines how child aggregations should be calculated: breadth-first or depth-first. + /// + /// Determines how child aggregations should be calculated: breadth-first or depth-first. + /// /// [JsonInclude, JsonPropertyName("collect_mode")] public Elastic.Clients.Elasticsearch.Aggregations.TermsAggregationCollectMode? CollectMode { get; set; } /// - /// Values to exclude.
Accepts regular expressions and partitions. + /// + /// Values to exclude. + /// Accepts regular expressions and partitions. + /// /// [JsonInclude, JsonPropertyName("exclude")] public Elastic.Clients.Elasticsearch.Aggregations.TermsExclude? Exclude { get; set; } /// - /// Determines whether the aggregation will use field values directly or global ordinals. + /// + /// Determines whether the aggregation will use field values directly or global ordinals. + /// /// [JsonInclude, JsonPropertyName("execution_hint")] public Elastic.Clients.Elasticsearch.Aggregations.TermsAggregationExecutionHint? ExecutionHint { get; set; } /// - /// The field from which to return terms. + /// + /// The field from which to return terms. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } @@ -56,19 +65,27 @@ public sealed partial class TermsAggregation public string? Format { get; set; } /// - /// Values to include.
Accepts regular expressions and partitions. + /// + /// Values to include. + /// Accepts regular expressions and partitions. + /// /// [JsonInclude, JsonPropertyName("include")] public Elastic.Clients.Elasticsearch.Aggregations.TermsInclude? Include { get; set; } /// - /// Only return values that are found in more than `min_doc_count` hits. + /// + /// Only return values that are found in more than min_doc_count hits. + /// /// [JsonInclude, JsonPropertyName("min_doc_count")] public int? MinDocCount { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.FieldValue? Missing { get; set; } @@ -78,7 +95,10 @@ public sealed partial class TermsAggregation public Elastic.Clients.Elasticsearch.Aggregations.MissingOrder? MissingOrder { get; set; } /// - /// Specifies the sort order of the buckets.
Defaults to sorting by descending document count. + /// + /// Specifies the sort order of the buckets. + /// Defaults to sorting by descending document count. + /// /// [JsonInclude, JsonPropertyName("order")] [SingleOrManyCollectionConverter(typeof(KeyValuePair))] @@ -87,31 +107,43 @@ public sealed partial class TermsAggregation public Elastic.Clients.Elasticsearch.Script? Script { get; set; } /// - /// Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`.
Terms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. + /// + /// Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the min_doc_count. + /// Terms will only be considered if their local shard frequency within the set is higher than the shard_min_doc_count. + /// /// [JsonInclude, JsonPropertyName("shard_min_doc_count")] public long? ShardMinDocCount { get; set; } /// - /// The number of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// + /// The number of candidate terms produced by each shard. + /// By default, shard_size will be automatically estimated based on the number of shards and the size parameter. + /// /// [JsonInclude, JsonPropertyName("shard_size")] public int? ShardSize { get; set; } /// - /// Set to `true` to return the `doc_count_error_upper_bound`, which is an upper bound to the error on the `doc_count` returned by each shard. + /// + /// Set to true to return the doc_count_error_upper_bound, which is an upper bound to the error on the doc_count returned by each shard. + /// /// [JsonInclude, JsonPropertyName("show_term_doc_count_error")] public bool? ShowTermDocCountError { get; set; } /// - /// The number of buckets returned out of the overall terms list. + /// + /// The number of buckets returned out of the overall terms list. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// Coerced unmapped fields into the specified type. + /// + /// Coerced unmapped fields into the specified type. + /// /// [JsonInclude, JsonPropertyName("value_type")] public string? ValueType { get; set; } @@ -149,7 +181,9 @@ public TermsAggregationDescriptor() : base() private string? ValueTypeValue { get; set; } /// - /// Determines how child aggregations should be calculated: breadth-first or depth-first. + /// + /// Determines how child aggregations should be calculated: breadth-first or depth-first. + /// /// public TermsAggregationDescriptor CollectMode(Elastic.Clients.Elasticsearch.Aggregations.TermsAggregationCollectMode? collectMode) { @@ -158,7 +192,10 @@ public TermsAggregationDescriptor CollectMode(Elastic.Clients.Elastic } /// - /// Values to exclude.
Accepts regular expressions and partitions. + /// + /// Values to exclude. + /// Accepts regular expressions and partitions. + /// /// public TermsAggregationDescriptor Exclude(Elastic.Clients.Elasticsearch.Aggregations.TermsExclude? exclude) { @@ -167,7 +204,9 @@ public TermsAggregationDescriptor Exclude(Elastic.Clients.Elasticsear } /// - /// Determines whether the aggregation will use field values directly or global ordinals. + /// + /// Determines whether the aggregation will use field values directly or global ordinals. + /// /// public TermsAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsearch.Aggregations.TermsAggregationExecutionHint? executionHint) { @@ -176,7 +215,9 @@ public TermsAggregationDescriptor ExecutionHint(Elastic.Clients.Elast } /// - /// The field from which to return terms. + /// + /// The field from which to return terms. + /// /// public TermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -185,7 +226,9 @@ public TermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch } /// - /// The field from which to return terms. + /// + /// The field from which to return terms. + /// /// public TermsAggregationDescriptor Field(Expression> field) { @@ -194,7 +237,9 @@ public TermsAggregationDescriptor Field(Expression - /// The field from which to return terms. + /// + /// The field from which to return terms. + /// /// public TermsAggregationDescriptor Field(Expression> field) { @@ -209,7 +254,10 @@ public TermsAggregationDescriptor Format(string? format) } /// - /// Values to include.
Accepts regular expressions and partitions. + /// + /// Values to include. + /// Accepts regular expressions and partitions. + /// /// public TermsAggregationDescriptor Include(Elastic.Clients.Elasticsearch.Aggregations.TermsInclude? include) { @@ -218,7 +266,9 @@ public TermsAggregationDescriptor Include(Elastic.Clients.Elasticsear } /// - /// Only return values that are found in more than `min_doc_count` hits. + /// + /// Only return values that are found in more than min_doc_count hits. + /// /// public TermsAggregationDescriptor MinDocCount(int? minDocCount) { @@ -227,7 +277,10 @@ public TermsAggregationDescriptor MinDocCount(int? minDocCount) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public TermsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -248,7 +301,10 @@ public TermsAggregationDescriptor MissingOrder(Elastic.Clients.Elasti } /// - /// Specifies the sort order of the buckets.
Defaults to sorting by descending document count. + /// + /// Specifies the sort order of the buckets. + /// Defaults to sorting by descending document count. + /// /// public TermsAggregationDescriptor Order(ICollection>? order) { @@ -281,7 +337,10 @@ public TermsAggregationDescriptor Script(Action - /// Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`.
Terms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. + /// + /// Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the min_doc_count. + /// Terms will only be considered if their local shard frequency within the set is higher than the shard_min_doc_count. + /// /// public TermsAggregationDescriptor ShardMinDocCount(long? shardMinDocCount) { @@ -290,7 +349,10 @@ public TermsAggregationDescriptor ShardMinDocCount(long? shardMinDocC } /// - /// The number of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// + /// The number of candidate terms produced by each shard. + /// By default, shard_size will be automatically estimated based on the number of shards and the size parameter. + /// /// public TermsAggregationDescriptor ShardSize(int? shardSize) { @@ -299,7 +361,9 @@ public TermsAggregationDescriptor ShardSize(int? shardSize) } /// - /// Set to `true` to return the `doc_count_error_upper_bound`, which is an upper bound to the error on the `doc_count` returned by each shard. + /// + /// Set to true to return the doc_count_error_upper_bound, which is an upper bound to the error on the doc_count returned by each shard. + /// /// public TermsAggregationDescriptor ShowTermDocCountError(bool? showTermDocCountError = true) { @@ -308,7 +372,9 @@ public TermsAggregationDescriptor ShowTermDocCountError(bool? showTer } /// - /// The number of buckets returned out of the overall terms list. + /// + /// The number of buckets returned out of the overall terms list. + /// /// public TermsAggregationDescriptor Size(int? size) { @@ -317,7 +383,9 @@ public TermsAggregationDescriptor Size(int? size) } /// - /// Coerced unmapped fields into the specified type. + /// + /// Coerced unmapped fields into the specified type. + /// /// public TermsAggregationDescriptor ValueType(string? valueType) { @@ -473,7 +541,9 @@ public TermsAggregationDescriptor() : base() private string? ValueTypeValue { get; set; } /// - /// Determines how child aggregations should be calculated: breadth-first or depth-first. + /// + /// Determines how child aggregations should be calculated: breadth-first or depth-first. + /// /// public TermsAggregationDescriptor CollectMode(Elastic.Clients.Elasticsearch.Aggregations.TermsAggregationCollectMode? collectMode) { @@ -482,7 +552,10 @@ public TermsAggregationDescriptor CollectMode(Elastic.Clients.Elasticsearch.Aggr } /// - /// Values to exclude.
Accepts regular expressions and partitions. + /// + /// Values to exclude. + /// Accepts regular expressions and partitions. + /// /// public TermsAggregationDescriptor Exclude(Elastic.Clients.Elasticsearch.Aggregations.TermsExclude? exclude) { @@ -491,7 +564,9 @@ public TermsAggregationDescriptor Exclude(Elastic.Clients.Elasticsearch.Aggregat } /// - /// Determines whether the aggregation will use field values directly or global ordinals. + /// + /// Determines whether the aggregation will use field values directly or global ordinals. + /// /// public TermsAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsearch.Aggregations.TermsAggregationExecutionHint? executionHint) { @@ -500,7 +575,9 @@ public TermsAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsearch.Ag } /// - /// The field from which to return terms. + /// + /// The field from which to return terms. + /// /// public TermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -509,7 +586,9 @@ public TermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? fie } /// - /// The field from which to return terms. + /// + /// The field from which to return terms. + /// /// public TermsAggregationDescriptor Field(Expression> field) { @@ -518,7 +597,9 @@ public TermsAggregationDescriptor Field(Expression - /// The field from which to return terms. + /// + /// The field from which to return terms. + /// /// public TermsAggregationDescriptor Field(Expression> field) { @@ -533,7 +614,10 @@ public TermsAggregationDescriptor Format(string? format) } /// - /// Values to include.
Accepts regular expressions and partitions. + /// + /// Values to include. + /// Accepts regular expressions and partitions. + /// /// public TermsAggregationDescriptor Include(Elastic.Clients.Elasticsearch.Aggregations.TermsInclude? include) { @@ -542,7 +626,9 @@ public TermsAggregationDescriptor Include(Elastic.Clients.Elasticsearch.Aggregat } /// - /// Only return values that are found in more than `min_doc_count` hits. + /// + /// Only return values that are found in more than min_doc_count hits. + /// /// public TermsAggregationDescriptor MinDocCount(int? minDocCount) { @@ -551,7 +637,10 @@ public TermsAggregationDescriptor MinDocCount(int? minDocCount) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public TermsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -572,7 +661,10 @@ public TermsAggregationDescriptor MissingOrder(Elastic.Clients.Elasticsearch.Agg } /// - /// Specifies the sort order of the buckets.
Defaults to sorting by descending document count. + /// + /// Specifies the sort order of the buckets. + /// Defaults to sorting by descending document count. + /// /// public TermsAggregationDescriptor Order(ICollection>? order) { @@ -605,7 +697,10 @@ public TermsAggregationDescriptor Script(Action - /// Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`.
Terms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. + /// + /// Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the min_doc_count. + /// Terms will only be considered if their local shard frequency within the set is higher than the shard_min_doc_count. + /// /// public TermsAggregationDescriptor ShardMinDocCount(long? shardMinDocCount) { @@ -614,7 +709,10 @@ public TermsAggregationDescriptor ShardMinDocCount(long? shardMinDocCount) } /// - /// The number of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// + /// The number of candidate terms produced by each shard. + /// By default, shard_size will be automatically estimated based on the number of shards and the size parameter. + /// /// public TermsAggregationDescriptor ShardSize(int? shardSize) { @@ -623,7 +721,9 @@ public TermsAggregationDescriptor ShardSize(int? shardSize) } /// - /// Set to `true` to return the `doc_count_error_upper_bound`, which is an upper bound to the error on the `doc_count` returned by each shard. + /// + /// Set to true to return the doc_count_error_upper_bound, which is an upper bound to the error on the doc_count returned by each shard. + /// /// public TermsAggregationDescriptor ShowTermDocCountError(bool? showTermDocCountError = true) { @@ -632,7 +732,9 @@ public TermsAggregationDescriptor ShowTermDocCountError(bool? showTermDocCountEr } /// - /// The number of buckets returned out of the overall terms list. + /// + /// The number of buckets returned out of the overall terms list. + /// /// public TermsAggregationDescriptor Size(int? size) { @@ -641,7 +743,9 @@ public TermsAggregationDescriptor Size(int? size) } /// - /// Coerced unmapped fields into the specified type. + /// + /// Coerced unmapped fields into the specified type. + /// /// public TermsAggregationDescriptor ValueType(string? valueType) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TestPopulation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TestPopulation.g.cs index 504f723cad3..dd0b83b9cac 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TestPopulation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TestPopulation.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class TestPopulation { /// - /// The field to aggregate. + /// + /// The field to aggregate. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// A filter used to define a set of records to run unpaired t-test on. + /// + /// A filter used to define a set of records to run unpaired t-test on. + /// /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Filter { get; set; } @@ -61,7 +65,9 @@ public TestPopulationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field to aggregate. + /// + /// The field to aggregate. + /// /// public TestPopulationDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -70,7 +76,9 @@ public TestPopulationDescriptor Field(Elastic.Clients.Elasticsearch.F } /// - /// The field to aggregate. + /// + /// The field to aggregate. + /// /// public TestPopulationDescriptor Field(Expression> field) { @@ -79,7 +87,9 @@ public TestPopulationDescriptor Field(Expression - /// The field to aggregate. + /// + /// The field to aggregate. + /// /// public TestPopulationDescriptor Field(Expression> field) { @@ -88,7 +98,9 @@ public TestPopulationDescriptor Field(Expression - /// A filter used to define a set of records to run unpaired t-test on. + /// + /// A filter used to define a set of records to run unpaired t-test on. + /// /// public TestPopulationDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.Query? filter) { @@ -196,7 +208,9 @@ public TestPopulationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field to aggregate. + /// + /// The field to aggregate. + /// /// public TestPopulationDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -205,7 +219,9 @@ public TestPopulationDescriptor Field(Elastic.Clients.Elasticsearch.Field field) } /// - /// The field to aggregate. + /// + /// The field to aggregate. + /// /// public TestPopulationDescriptor Field(Expression> field) { @@ -214,7 +230,9 @@ public TestPopulationDescriptor Field(Expression - /// The field to aggregate. + /// + /// The field to aggregate. + /// /// public TestPopulationDescriptor Field(Expression> field) { @@ -223,7 +241,9 @@ public TestPopulationDescriptor Field(Expression - /// A filter used to define a set of records to run unpaired t-test on. + /// + /// A filter used to define a set of records to run unpaired t-test on. + /// /// public TestPopulationDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.Query? filter) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TopHitsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TopHitsAggregation.g.cs index ae4e933661b..60bdfb33f43 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TopHitsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TopHitsAggregation.g.cs @@ -30,43 +30,59 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class TopHitsAggregation { /// - /// Fields for which to return doc values. + /// + /// Fields for which to return doc values. + /// /// [JsonInclude, JsonPropertyName("docvalue_fields")] public ICollection? DocvalueFields { get; set; } /// - /// If `true`, returns detailed information about score computation as part of a hit. + /// + /// If true, returns detailed information about score computation as part of a hit. + /// /// [JsonInclude, JsonPropertyName("explain")] public bool? Explain { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } /// - /// Array of wildcard (*) patterns. The request returns values for field names
matching these patterns in the hits.fields property of the response. + /// + /// Array of wildcard (*) patterns. The request returns values for field names + /// matching these patterns in the hits.fields property of the response. + /// /// [JsonInclude, JsonPropertyName("fields")] public ICollection? Fields { get; set; } /// - /// Starting document offset. + /// + /// Starting document offset. + /// /// [JsonInclude, JsonPropertyName("from")] public int? From { get; set; } /// - /// Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in the search results. + /// + /// Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in the search results. + /// /// [JsonInclude, JsonPropertyName("highlight")] public Elastic.Clients.Elasticsearch.Core.Search.Highlight? Highlight { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.FieldValue? Missing { get; set; } @@ -74,51 +90,68 @@ public sealed partial class TopHitsAggregation public Elastic.Clients.Elasticsearch.Script? Script { get; set; } /// - /// Returns the result of one or more script evaluations for each hit. + /// + /// Returns the result of one or more script evaluations for each hit. + /// /// [JsonInclude, JsonPropertyName("script_fields")] public IDictionary? ScriptFields { get; set; } /// - /// If `true`, returns sequence number and primary term of the last modification of each hit. + /// + /// If true, returns sequence number and primary term of the last modification of each hit. + /// /// [JsonInclude, JsonPropertyName("seq_no_primary_term")] public bool? SeqNoPrimaryTerm { get; set; } /// - /// The maximum number of top matching hits to return per bucket. + /// + /// The maximum number of top matching hits to return per bucket. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// Sort order of the top matching hits.
By default, the hits are sorted by the score of the main query. + /// + /// Sort order of the top matching hits. + /// By default, the hits are sorted by the score of the main query. + /// /// [JsonInclude, JsonPropertyName("sort")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.SortOptions))] public ICollection? Sort { get; set; } /// - /// Selects the fields of the source that are returned. + /// + /// Selects the fields of the source that are returned. + /// /// [JsonInclude, JsonPropertyName("_source")] public Elastic.Clients.Elasticsearch.Core.Search.SourceConfig? Source { get; set; } /// - /// Returns values for the specified stored fields (fields that use the `store` mapping option). + /// + /// Returns values for the specified stored fields (fields that use the store mapping option). + /// /// [JsonInclude, JsonPropertyName("stored_fields")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] public Elastic.Clients.Elasticsearch.Fields? StoredFields { get; set; } /// - /// If `true`, calculates and returns document scores, even if the scores are not used for sorting. + /// + /// If true, calculates and returns document scores, even if the scores are not used for sorting. + /// /// [JsonInclude, JsonPropertyName("track_scores")] public bool? TrackScores { get; set; } /// - /// If `true`, returns document version as part of a hit. + /// + /// If true, returns document version as part of a hit. + /// /// [JsonInclude, JsonPropertyName("version")] public bool? Version { get; set; } @@ -165,7 +198,9 @@ public TopHitsAggregationDescriptor() : base() private bool? VersionValue { get; set; } /// - /// Fields for which to return doc values. + /// + /// Fields for which to return doc values. + /// /// public TopHitsAggregationDescriptor DocvalueFields(ICollection? docvalueFields) { @@ -204,7 +239,9 @@ public TopHitsAggregationDescriptor DocvalueFields(params Action - /// If `true`, returns detailed information about score computation as part of a hit. + /// + /// If true, returns detailed information about score computation as part of a hit. + /// /// public TopHitsAggregationDescriptor Explain(bool? explain = true) { @@ -213,7 +250,9 @@ public TopHitsAggregationDescriptor Explain(bool? explain = true) } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public TopHitsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -222,7 +261,9 @@ public TopHitsAggregationDescriptor Field(Elastic.Clients.Elasticsear } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public TopHitsAggregationDescriptor Field(Expression> field) { @@ -231,7 +272,9 @@ public TopHitsAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public TopHitsAggregationDescriptor Field(Expression> field) { @@ -240,7 +283,10 @@ public TopHitsAggregationDescriptor Field(Expression - /// Array of wildcard (*) patterns. The request returns values for field names
matching these patterns in the hits.fields property of the response. + /// + /// Array of wildcard (*) patterns. The request returns values for field names + /// matching these patterns in the hits.fields property of the response. + /// /// public TopHitsAggregationDescriptor Fields(ICollection? fields) { @@ -279,7 +325,9 @@ public TopHitsAggregationDescriptor Fields(params Action - /// Starting document offset. + /// + /// Starting document offset. + /// /// public TopHitsAggregationDescriptor From(int? from) { @@ -288,7 +336,9 @@ public TopHitsAggregationDescriptor From(int? from) } /// - /// Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in the search results. + /// + /// Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in the search results. + /// /// public TopHitsAggregationDescriptor Highlight(Elastic.Clients.Elasticsearch.Core.Search.Highlight? highlight) { @@ -315,7 +365,10 @@ public TopHitsAggregationDescriptor Highlight(Action - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public TopHitsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -348,7 +401,9 @@ public TopHitsAggregationDescriptor Script(Action - /// Returns the result of one or more script evaluations for each hit. + /// + /// Returns the result of one or more script evaluations for each hit. + /// /// public TopHitsAggregationDescriptor ScriptFields(Func, FluentDescriptorDictionary> selector) { @@ -357,7 +412,9 @@ public TopHitsAggregationDescriptor ScriptFields(Func - /// If `true`, returns sequence number and primary term of the last modification of each hit. + /// + /// If true, returns sequence number and primary term of the last modification of each hit. + /// /// public TopHitsAggregationDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = true) { @@ -366,7 +423,9 @@ public TopHitsAggregationDescriptor SeqNoPrimaryTerm(bool? seqNoPrima } /// - /// The maximum number of top matching hits to return per bucket. + /// + /// The maximum number of top matching hits to return per bucket. + /// /// public TopHitsAggregationDescriptor Size(int? size) { @@ -375,7 +434,10 @@ public TopHitsAggregationDescriptor Size(int? size) } /// - /// Sort order of the top matching hits.
By default, the hits are sorted by the score of the main query. + /// + /// Sort order of the top matching hits. + /// By default, the hits are sorted by the score of the main query. + /// /// public TopHitsAggregationDescriptor Sort(ICollection? sort) { @@ -414,7 +476,9 @@ public TopHitsAggregationDescriptor Sort(params Action - /// Selects the fields of the source that are returned. + /// + /// Selects the fields of the source that are returned. + /// /// public TopHitsAggregationDescriptor Source(Elastic.Clients.Elasticsearch.Core.Search.SourceConfig? source) { @@ -423,7 +487,9 @@ public TopHitsAggregationDescriptor Source(Elastic.Clients.Elasticsea } /// - /// Returns values for the specified stored fields (fields that use the `store` mapping option). + /// + /// Returns values for the specified stored fields (fields that use the store mapping option). + /// /// public TopHitsAggregationDescriptor StoredFields(Elastic.Clients.Elasticsearch.Fields? storedFields) { @@ -432,7 +498,9 @@ public TopHitsAggregationDescriptor StoredFields(Elastic.Clients.Elas } /// - /// If `true`, calculates and returns document scores, even if the scores are not used for sorting. + /// + /// If true, calculates and returns document scores, even if the scores are not used for sorting. + /// /// public TopHitsAggregationDescriptor TrackScores(bool? trackScores = true) { @@ -441,7 +509,9 @@ public TopHitsAggregationDescriptor TrackScores(bool? trackScores = t } /// - /// If `true`, returns document version as part of a hit. + /// + /// If true, returns document version as part of a hit. + /// /// public TopHitsAggregationDescriptor Version(bool? version = true) { @@ -684,7 +754,9 @@ public TopHitsAggregationDescriptor() : base() private bool? VersionValue { get; set; } /// - /// Fields for which to return doc values. + /// + /// Fields for which to return doc values. + /// /// public TopHitsAggregationDescriptor DocvalueFields(ICollection? docvalueFields) { @@ -723,7 +795,9 @@ public TopHitsAggregationDescriptor DocvalueFields(params Action - /// If `true`, returns detailed information about score computation as part of a hit. + /// + /// If true, returns detailed information about score computation as part of a hit. + /// /// public TopHitsAggregationDescriptor Explain(bool? explain = true) { @@ -732,7 +806,9 @@ public TopHitsAggregationDescriptor Explain(bool? explain = true) } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public TopHitsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -741,7 +817,9 @@ public TopHitsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? f } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public TopHitsAggregationDescriptor Field(Expression> field) { @@ -750,7 +828,9 @@ public TopHitsAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public TopHitsAggregationDescriptor Field(Expression> field) { @@ -759,7 +839,10 @@ public TopHitsAggregationDescriptor Field(Expression - /// Array of wildcard (*) patterns. The request returns values for field names
matching these patterns in the hits.fields property of the response. + /// + /// Array of wildcard (*) patterns. The request returns values for field names + /// matching these patterns in the hits.fields property of the response. + /// /// public TopHitsAggregationDescriptor Fields(ICollection? fields) { @@ -798,7 +881,9 @@ public TopHitsAggregationDescriptor Fields(params Action - /// Starting document offset. + /// + /// Starting document offset. + /// /// public TopHitsAggregationDescriptor From(int? from) { @@ -807,7 +892,9 @@ public TopHitsAggregationDescriptor From(int? from) } /// - /// Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in the search results. + /// + /// Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in the search results. + /// /// public TopHitsAggregationDescriptor Highlight(Elastic.Clients.Elasticsearch.Core.Search.Highlight? highlight) { @@ -834,7 +921,10 @@ public TopHitsAggregationDescriptor Highlight(Action - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public TopHitsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -867,7 +957,9 @@ public TopHitsAggregationDescriptor Script(Action - /// Returns the result of one or more script evaluations for each hit. + /// + /// Returns the result of one or more script evaluations for each hit. + /// /// public TopHitsAggregationDescriptor ScriptFields(Func, FluentDescriptorDictionary> selector) { @@ -876,7 +968,9 @@ public TopHitsAggregationDescriptor ScriptFields(Func - /// If `true`, returns sequence number and primary term of the last modification of each hit. + /// + /// If true, returns sequence number and primary term of the last modification of each hit. + /// /// public TopHitsAggregationDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = true) { @@ -885,7 +979,9 @@ public TopHitsAggregationDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = tr } /// - /// The maximum number of top matching hits to return per bucket. + /// + /// The maximum number of top matching hits to return per bucket. + /// /// public TopHitsAggregationDescriptor Size(int? size) { @@ -894,7 +990,10 @@ public TopHitsAggregationDescriptor Size(int? size) } /// - /// Sort order of the top matching hits.
By default, the hits are sorted by the score of the main query. + /// + /// Sort order of the top matching hits. + /// By default, the hits are sorted by the score of the main query. + /// /// public TopHitsAggregationDescriptor Sort(ICollection? sort) { @@ -933,7 +1032,9 @@ public TopHitsAggregationDescriptor Sort(params Action - /// Selects the fields of the source that are returned. + /// + /// Selects the fields of the source that are returned. + /// /// public TopHitsAggregationDescriptor Source(Elastic.Clients.Elasticsearch.Core.Search.SourceConfig? source) { @@ -942,7 +1043,9 @@ public TopHitsAggregationDescriptor Source(Elastic.Clients.Elasticsearch.Core.Se } /// - /// Returns values for the specified stored fields (fields that use the `store` mapping option). + /// + /// Returns values for the specified stored fields (fields that use the store mapping option). + /// /// public TopHitsAggregationDescriptor StoredFields(Elastic.Clients.Elasticsearch.Fields? storedFields) { @@ -951,7 +1054,9 @@ public TopHitsAggregationDescriptor StoredFields(Elastic.Clients.Elasticsearch.F } /// - /// If `true`, calculates and returns document scores, even if the scores are not used for sorting. + /// + /// If true, calculates and returns document scores, even if the scores are not used for sorting. + /// /// public TopHitsAggregationDescriptor TrackScores(bool? trackScores = true) { @@ -960,7 +1065,9 @@ public TopHitsAggregationDescriptor TrackScores(bool? trackScores = true) } /// - /// If `true`, returns document version as part of a hit. + /// + /// If true, returns document version as part of a hit. + /// /// public TopHitsAggregationDescriptor Version(bool? version = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TopMetricsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TopMetricsAggregation.g.cs index 947eb5c21eb..d063b3c1be9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TopMetricsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TopMetricsAggregation.g.cs @@ -30,20 +30,27 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class TopMetricsAggregation { /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } /// - /// The fields of the top document to return. + /// + /// The fields of the top document to return. + /// /// [JsonInclude, JsonPropertyName("metrics")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Aggregations.TopMetricsValue))] public ICollection? Metrics { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.FieldValue? Missing { get; set; } @@ -51,13 +58,17 @@ public sealed partial class TopMetricsAggregation public Elastic.Clients.Elasticsearch.Script? Script { get; set; } /// - /// The number of top documents from which to return metrics. + /// + /// The number of top documents from which to return metrics. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// The sort order of the documents. + /// + /// The sort order of the documents. + /// /// [JsonInclude, JsonPropertyName("sort")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.SortOptions))] @@ -90,7 +101,9 @@ public TopMetricsAggregationDescriptor() : base() private Action>[] SortDescriptorActions { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public TopMetricsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -99,7 +112,9 @@ public TopMetricsAggregationDescriptor Field(Elastic.Clients.Elastics } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public TopMetricsAggregationDescriptor Field(Expression> field) { @@ -108,7 +123,9 @@ public TopMetricsAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public TopMetricsAggregationDescriptor Field(Expression> field) { @@ -117,7 +134,9 @@ public TopMetricsAggregationDescriptor Field(Expression - /// The fields of the top document to return. + /// + /// The fields of the top document to return. + /// /// public TopMetricsAggregationDescriptor Metrics(ICollection? metrics) { @@ -156,7 +175,10 @@ public TopMetricsAggregationDescriptor Metrics(params Action - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public TopMetricsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -189,7 +211,9 @@ public TopMetricsAggregationDescriptor Script(Action - /// The number of top documents from which to return metrics. + /// + /// The number of top documents from which to return metrics. + /// /// public TopMetricsAggregationDescriptor Size(int? size) { @@ -198,7 +222,9 @@ public TopMetricsAggregationDescriptor Size(int? size) } /// - /// The sort order of the documents. + /// + /// The sort order of the documents. + /// /// public TopMetricsAggregationDescriptor Sort(ICollection? sort) { @@ -359,7 +385,9 @@ public TopMetricsAggregationDescriptor() : base() private Action[] SortDescriptorActions { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public TopMetricsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -368,7 +396,9 @@ public TopMetricsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public TopMetricsAggregationDescriptor Field(Expression> field) { @@ -377,7 +407,9 @@ public TopMetricsAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public TopMetricsAggregationDescriptor Field(Expression> field) { @@ -386,7 +418,9 @@ public TopMetricsAggregationDescriptor Field(Expression - /// The fields of the top document to return. + /// + /// The fields of the top document to return. + /// /// public TopMetricsAggregationDescriptor Metrics(ICollection? metrics) { @@ -425,7 +459,10 @@ public TopMetricsAggregationDescriptor Metrics(params Action - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public TopMetricsAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -458,7 +495,9 @@ public TopMetricsAggregationDescriptor Script(Action - /// The number of top documents from which to return metrics. + /// + /// The number of top documents from which to return metrics. + /// /// public TopMetricsAggregationDescriptor Size(int? size) { @@ -467,7 +506,9 @@ public TopMetricsAggregationDescriptor Size(int? size) } /// - /// The sort order of the documents. + /// + /// The sort order of the documents. + /// /// public TopMetricsAggregationDescriptor Sort(ICollection? sort) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TopMetricsValue.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TopMetricsValue.g.cs index 699672837d7..134fa12ce8c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TopMetricsValue.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TopMetricsValue.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class TopMetricsValue { /// - /// A field to return as a metric. + /// + /// A field to return as a metric. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } @@ -47,7 +49,9 @@ public TopMetricsValueDescriptor() : base() private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } /// - /// A field to return as a metric. + /// + /// A field to return as a metric. + /// /// public TopMetricsValueDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -56,7 +60,9 @@ public TopMetricsValueDescriptor Field(Elastic.Clients.Elasticsearch. } /// - /// A field to return as a metric. + /// + /// A field to return as a metric. + /// /// public TopMetricsValueDescriptor Field(Expression> field) { @@ -65,7 +71,9 @@ public TopMetricsValueDescriptor Field(Expression - /// A field to return as a metric. + /// + /// A field to return as a metric. + /// /// public TopMetricsValueDescriptor Field(Expression> field) { @@ -93,7 +101,9 @@ public TopMetricsValueDescriptor() : base() private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } /// - /// A field to return as a metric. + /// + /// A field to return as a metric. + /// /// public TopMetricsValueDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -102,7 +112,9 @@ public TopMetricsValueDescriptor Field(Elastic.Clients.Elasticsearch.Field field } /// - /// A field to return as a metric. + /// + /// A field to return as a metric. + /// /// public TopMetricsValueDescriptor Field(Expression> field) { @@ -111,7 +123,9 @@ public TopMetricsValueDescriptor Field(Expression - /// A field to return as a metric. + /// + /// A field to return as a metric. + /// /// public TopMetricsValueDescriptor Field(Expression> field) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/UnmappedRareTermsAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/UnmappedRareTermsAggregate.g.cs index dec97725d22..65f49279fe6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/UnmappedRareTermsAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/UnmappedRareTermsAggregate.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; /// -/// Result of a `rare_terms` aggregation when the field is unmapped. `buckets` is always empty. +/// +/// Result of a rare_terms aggregation when the field is unmapped. buckets is always empty. +/// /// public sealed partial class UnmappedRareTermsAggregate : IAggregate { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/UnmappedSamplerAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/UnmappedSamplerAggregate.g.cs index 73a799bd7b5..49e77c3a953 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/UnmappedSamplerAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/UnmappedSamplerAggregate.g.cs @@ -77,7 +77,9 @@ public override void Write(Utf8JsonWriter writer, UnmappedSamplerAggregate value public sealed partial class UnmappedSamplerAggregate : IAggregate { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/UnmappedSignificantTermsAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/UnmappedSignificantTermsAggregate.g.cs index 1af0aedf52c..61265ed8a92 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/UnmappedSignificantTermsAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/UnmappedSignificantTermsAggregate.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; /// -/// Result of the `significant_terms` aggregation on an unmapped field. `buckets` is always empty. +/// +/// Result of the significant_terms aggregation on an unmapped field. buckets is always empty. +/// /// public sealed partial class UnmappedSignificantTermsAggregate : IAggregate { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/UnmappedTermsAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/UnmappedTermsAggregate.g.cs index 6d02dd1b04f..58914563b27 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/UnmappedTermsAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/UnmappedTermsAggregate.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; /// -/// Result of a `terms` aggregation when the field is unmapped. `buckets` is always empty. +/// +/// Result of a terms aggregation when the field is unmapped. buckets is always empty. +/// /// public sealed partial class UnmappedTermsAggregate : IAggregate { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ValueCountAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ValueCountAggregate.g.cs index 5821a7ca436..697e951c703 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ValueCountAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ValueCountAggregate.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; /// -/// Value count aggregation result. `value` is always present. +/// +/// Value count aggregation result. value is always present. +/// /// public sealed partial class ValueCountAggregate : IAggregate { @@ -36,7 +38,10 @@ public sealed partial class ValueCountAggregate : IAggregate public IReadOnlyDictionary? Meta { get; init; } /// - /// The metric value. A missing value generally means that there was no data to aggregate,
unless specified otherwise. + /// + /// The metric value. A missing value generally means that there was no data to aggregate, + /// unless specified otherwise. + /// /// [JsonInclude, JsonPropertyName("value")] public double? Value { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ValueCountAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ValueCountAggregation.g.cs index e3c62bcae87..ef59862b18a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ValueCountAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ValueCountAggregation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class ValueCountAggregation { /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } @@ -38,7 +40,10 @@ public sealed partial class ValueCountAggregation public string? Format { get; set; } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// [JsonInclude, JsonPropertyName("missing")] public Elastic.Clients.Elasticsearch.FieldValue? Missing { get; set; } @@ -64,7 +69,9 @@ public ValueCountAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ValueCountAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -73,7 +80,9 @@ public ValueCountAggregationDescriptor Field(Elastic.Clients.Elastics } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ValueCountAggregationDescriptor Field(Expression> field) { @@ -82,7 +91,9 @@ public ValueCountAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ValueCountAggregationDescriptor Field(Expression> field) { @@ -97,7 +108,10 @@ public ValueCountAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public ValueCountAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { @@ -186,7 +200,9 @@ public ValueCountAggregationDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ValueCountAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -195,7 +211,9 @@ public ValueCountAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field } /// - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ValueCountAggregationDescriptor Field(Expression> field) { @@ -204,7 +222,9 @@ public ValueCountAggregationDescriptor Field(Expression - /// The field on which to run the aggregation. + /// + /// The field on which to run the aggregation. + /// /// public ValueCountAggregationDescriptor Field(Expression> field) { @@ -219,7 +239,10 @@ public ValueCountAggregationDescriptor Format(string? format) } /// - /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// + /// The value to apply to documents that do not have a value. + /// By default, documents without a value are ignored. + /// /// public ValueCountAggregationDescriptor Missing(Elastic.Clients.Elasticsearch.FieldValue? missing) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/VariableWidthHistogramAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/VariableWidthHistogramAggregation.g.cs index ce7af28261b..1181ffd16fc 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/VariableWidthHistogramAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/VariableWidthHistogramAggregation.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class VariableWidthHistogramAggregation { /// - /// The target number of buckets. + /// + /// The target number of buckets. + /// /// [JsonInclude, JsonPropertyName("buckets")] public int? Buckets { get; set; } /// - /// The name of the field. + /// + /// The name of the field. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } /// - /// Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run.
Defaults to `min(10 * shard_size, 50000)`. + /// + /// Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run. + /// Defaults to min(10 * shard_size, 50000). + /// /// [JsonInclude, JsonPropertyName("initial_buffer")] public int? InitialBuffer { get; set; } @@ -50,7 +57,10 @@ public sealed partial class VariableWidthHistogramAggregation public Elastic.Clients.Elasticsearch.Script? Script { get; set; } /// - /// The number of buckets that the coordinating node will request from each shard.
Defaults to `buckets * 50`. + /// + /// The number of buckets that the coordinating node will request from each shard. + /// Defaults to buckets * 50. + /// /// [JsonInclude, JsonPropertyName("shard_size")] public int? ShardSize { get; set; } @@ -75,7 +85,9 @@ public VariableWidthHistogramAggregationDescriptor() : base() private int? ShardSizeValue { get; set; } /// - /// The target number of buckets. + /// + /// The target number of buckets. + /// /// public VariableWidthHistogramAggregationDescriptor Buckets(int? buckets) { @@ -84,7 +96,9 @@ public VariableWidthHistogramAggregationDescriptor Buckets(int? bucke } /// - /// The name of the field. + /// + /// The name of the field. + /// /// public VariableWidthHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -93,7 +107,9 @@ public VariableWidthHistogramAggregationDescriptor Field(Elastic.Clie } /// - /// The name of the field. + /// + /// The name of the field. + /// /// public VariableWidthHistogramAggregationDescriptor Field(Expression> field) { @@ -102,7 +118,9 @@ public VariableWidthHistogramAggregationDescriptor Field(Expr } /// - /// The name of the field. + /// + /// The name of the field. + /// /// public VariableWidthHistogramAggregationDescriptor Field(Expression> field) { @@ -111,7 +129,10 @@ public VariableWidthHistogramAggregationDescriptor Field(Expression - /// Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run.
Defaults to `min(10 * shard_size, 50000)`. + /// + /// Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run. + /// Defaults to min(10 * shard_size, 50000). + /// /// public VariableWidthHistogramAggregationDescriptor InitialBuffer(int? initialBuffer) { @@ -144,7 +165,10 @@ public VariableWidthHistogramAggregationDescriptor Script(Action - /// The number of buckets that the coordinating node will request from each shard.
Defaults to `buckets * 50`. + /// + /// The number of buckets that the coordinating node will request from each shard. + /// Defaults to buckets * 50. + /// /// public VariableWidthHistogramAggregationDescriptor ShardSize(int? shardSize) { @@ -216,7 +240,9 @@ public VariableWidthHistogramAggregationDescriptor() : base() private int? ShardSizeValue { get; set; } /// - /// The target number of buckets. + /// + /// The target number of buckets. + /// /// public VariableWidthHistogramAggregationDescriptor Buckets(int? buckets) { @@ -225,7 +251,9 @@ public VariableWidthHistogramAggregationDescriptor Buckets(int? buckets) } /// - /// The name of the field. + /// + /// The name of the field. + /// /// public VariableWidthHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -234,7 +262,9 @@ public VariableWidthHistogramAggregationDescriptor Field(Elastic.Clients.Elastic } /// - /// The name of the field. + /// + /// The name of the field. + /// /// public VariableWidthHistogramAggregationDescriptor Field(Expression> field) { @@ -243,7 +273,9 @@ public VariableWidthHistogramAggregationDescriptor Field(Expr } /// - /// The name of the field. + /// + /// The name of the field. + /// /// public VariableWidthHistogramAggregationDescriptor Field(Expression> field) { @@ -252,7 +284,10 @@ public VariableWidthHistogramAggregationDescriptor Field(Expression - /// Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run.
Defaults to `min(10 * shard_size, 50000)`. + /// + /// Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run. + /// Defaults to min(10 * shard_size, 50000). + /// /// public VariableWidthHistogramAggregationDescriptor InitialBuffer(int? initialBuffer) { @@ -285,7 +320,10 @@ public VariableWidthHistogramAggregationDescriptor Script(Action - /// The number of buckets that the coordinating node will request from each shard.
Defaults to `buckets * 50`. + /// + /// The number of buckets that the coordinating node will request from each shard. + /// Defaults to buckets * 50. + /// /// public VariableWidthHistogramAggregationDescriptor ShardSize(int? shardSize) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/VariableWidthHistogramBucket.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/VariableWidthHistogramBucket.g.cs index 496f411ee6f..4d1f82516da 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/VariableWidthHistogramBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/VariableWidthHistogramBucket.g.cs @@ -112,7 +112,9 @@ public override void Write(Utf8JsonWriter writer, VariableWidthHistogramBucket v public sealed partial class VariableWidthHistogramBucket { /// - /// Nested aggregations + /// + /// Nested aggregations + /// /// public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary Aggregations { get; init; } public long DocCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/WeightedAverageAggregate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/WeightedAverageAggregate.g.cs index fcb2b8330e7..673773b6806 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/WeightedAverageAggregate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/WeightedAverageAggregate.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; /// -/// Weighted average aggregation result. `value` is missing if the weight was set to zero. +/// +/// Weighted average aggregation result. value is missing if the weight was set to zero. +/// /// public sealed partial class WeightedAverageAggregate : IAggregate { @@ -36,7 +38,10 @@ public sealed partial class WeightedAverageAggregate : IAggregate public IReadOnlyDictionary? Meta { get; init; } /// - /// The metric value. A missing value generally means that there was no data to aggregate,
unless specified otherwise. + /// + /// The metric value. A missing value generally means that there was no data to aggregate, + /// unless specified otherwise. + /// /// [JsonInclude, JsonPropertyName("value")] public double? Value { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/WeightedAverageAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/WeightedAverageAggregation.g.cs index 2ca7d53ff28..b7c6a2d1923 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/WeightedAverageAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/WeightedAverageAggregation.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class WeightedAverageAggregation { /// - /// A numeric response formatter. + /// + /// A numeric response formatter. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// Configuration for the field that provides the values. + /// + /// Configuration for the field that provides the values. + /// /// [JsonInclude, JsonPropertyName("value")] public Elastic.Clients.Elasticsearch.Aggregations.WeightedAverageValue? Value { get; set; } @@ -44,7 +48,9 @@ public sealed partial class WeightedAverageAggregation public Elastic.Clients.Elasticsearch.Aggregations.ValueType? ValueType { get; set; } /// - /// Configuration for the field or script that provides the weights. + /// + /// Configuration for the field or script that provides the weights. + /// /// [JsonInclude, JsonPropertyName("weight")] public Elastic.Clients.Elasticsearch.Aggregations.WeightedAverageValue? Weight { get; set; } @@ -70,7 +76,9 @@ public WeightedAverageAggregationDescriptor() : base() private Action> WeightDescriptorAction { get; set; } /// - /// A numeric response formatter. + /// + /// A numeric response formatter. + /// /// public WeightedAverageAggregationDescriptor Format(string? format) { @@ -79,7 +87,9 @@ public WeightedAverageAggregationDescriptor Format(string? format) } /// - /// Configuration for the field that provides the values. + /// + /// Configuration for the field that provides the values. + /// /// public WeightedAverageAggregationDescriptor Value(Elastic.Clients.Elasticsearch.Aggregations.WeightedAverageValue? value) { @@ -112,7 +122,9 @@ public WeightedAverageAggregationDescriptor ValueType(Elastic.Clients } /// - /// Configuration for the field or script that provides the weights. + /// + /// Configuration for the field or script that provides the weights. + /// /// public WeightedAverageAggregationDescriptor Weight(Elastic.Clients.Elasticsearch.Aggregations.WeightedAverageValue? weight) { @@ -207,7 +219,9 @@ public WeightedAverageAggregationDescriptor() : base() private Action WeightDescriptorAction { get; set; } /// - /// A numeric response formatter. + /// + /// A numeric response formatter. + /// /// public WeightedAverageAggregationDescriptor Format(string? format) { @@ -216,7 +230,9 @@ public WeightedAverageAggregationDescriptor Format(string? format) } /// - /// Configuration for the field that provides the values. + /// + /// Configuration for the field that provides the values. + /// /// public WeightedAverageAggregationDescriptor Value(Elastic.Clients.Elasticsearch.Aggregations.WeightedAverageValue? value) { @@ -249,7 +265,9 @@ public WeightedAverageAggregationDescriptor ValueType(Elastic.Clients.Elasticsea } /// - /// Configuration for the field or script that provides the weights. + /// + /// Configuration for the field or script that provides the weights. + /// /// public WeightedAverageAggregationDescriptor Weight(Elastic.Clients.Elasticsearch.Aggregations.WeightedAverageValue? weight) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/WeightedAverageValue.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/WeightedAverageValue.g.cs index 9c5549a2bbb..23d3bf02096 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/WeightedAverageValue.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/WeightedAverageValue.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class WeightedAverageValue { /// - /// The field from which to extract the values or weights. + /// + /// The field from which to extract the values or weights. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } /// - /// A value or weight to use if the field is missing. + /// + /// A value or weight to use if the field is missing. + /// /// [JsonInclude, JsonPropertyName("missing")] public double? Missing { get; set; } @@ -59,7 +63,9 @@ public WeightedAverageValueDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field from which to extract the values or weights. + /// + /// The field from which to extract the values or weights. + /// /// public WeightedAverageValueDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -68,7 +74,9 @@ public WeightedAverageValueDescriptor Field(Elastic.Clients.Elasticse } /// - /// The field from which to extract the values or weights. + /// + /// The field from which to extract the values or weights. + /// /// public WeightedAverageValueDescriptor Field(Expression> field) { @@ -77,7 +85,9 @@ public WeightedAverageValueDescriptor Field(Expression - /// The field from which to extract the values or weights. + /// + /// The field from which to extract the values or weights. + /// /// public WeightedAverageValueDescriptor Field(Expression> field) { @@ -86,7 +96,9 @@ public WeightedAverageValueDescriptor Field(Expression - /// A value or weight to use if the field is missing. + /// + /// A value or weight to use if the field is missing. + /// /// public WeightedAverageValueDescriptor Missing(double? missing) { @@ -168,7 +180,9 @@ public WeightedAverageValueDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The field from which to extract the values or weights. + /// + /// The field from which to extract the values or weights. + /// /// public WeightedAverageValueDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { @@ -177,7 +191,9 @@ public WeightedAverageValueDescriptor Field(Elastic.Clients.Elasticsearch.Field? } /// - /// The field from which to extract the values or weights. + /// + /// The field from which to extract the values or weights. + /// /// public WeightedAverageValueDescriptor Field(Expression> field) { @@ -186,7 +202,9 @@ public WeightedAverageValueDescriptor Field(Expression - /// The field from which to extract the values or weights. + /// + /// The field from which to extract the values or weights. + /// /// public WeightedAverageValueDescriptor Field(Expression> field) { @@ -195,7 +213,9 @@ public WeightedAverageValueDescriptor Field(Expression - /// A value or weight to use if the field is missing. + /// + /// A value or weight to use if the field is missing. + /// /// public WeightedAverageValueDescriptor Missing(double? missing) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/AsyncSearch/AsyncSearch.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/AsyncSearch/AsyncSearch.g.cs index 0f15a14c2ed..bcaf721928d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/AsyncSearch/AsyncSearch.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/AsyncSearch/AsyncSearch.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.AsyncSearch; public sealed partial class AsyncSearch { /// - /// Partial aggregations results, coming from the shards that have already completed the execution of the query. + /// + /// Partial aggregations results, coming from the shards that have already completed the execution of the query. + /// /// [JsonInclude, JsonPropertyName("aggregations")] public Elastic.Clients.Elasticsearch.Aggregations.AggregateDictionary? Aggregations { get; init; } @@ -44,7 +46,10 @@ public sealed partial class AsyncSearch public double? MaxScore { get; init; } /// - /// Indicates how many reductions of the results have been performed.
If this number increases compared to the last retrieved results for a get asynch search request, you can expect additional results included in the search response. + /// + /// Indicates how many reductions of the results have been performed. + /// If this number increases compared to the last retrieved results for a get asynch search request, you can expect additional results included in the search response. + /// /// [JsonInclude, JsonPropertyName("num_reduce_phases")] public long? NumReducePhases { get; init; } @@ -56,7 +61,10 @@ public sealed partial class AsyncSearch public Elastic.Clients.Elasticsearch.ScrollId? ScrollId { get; init; } /// - /// Indicates how many shards have run the query.
Note that in order for shard results to be included in the search response, they need to be reduced first. + /// + /// Indicates how many shards have run the query. + /// Note that in order for shard results to be included in the search response, they need to be reduced first. + /// /// [JsonInclude, JsonPropertyName("_shards")] public Elastic.Clients.Elasticsearch.ShardStatistics Shards { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/CharFilterTypes.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/CharFilterTypes.g.cs index 17bced9a419..744da73f590 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/CharFilterTypes.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/CharFilterTypes.g.cs @@ -30,49 +30,65 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class CharFilterTypes { /// - /// Contains statistics about analyzer types used in selected nodes. + /// + /// Contains statistics about analyzer types used in selected nodes. + /// /// [JsonInclude, JsonPropertyName("analyzer_types")] public IReadOnlyCollection AnalyzerTypes { get; init; } /// - /// Contains statistics about built-in analyzers used in selected nodes. + /// + /// Contains statistics about built-in analyzers used in selected nodes. + /// /// [JsonInclude, JsonPropertyName("built_in_analyzers")] public IReadOnlyCollection BuiltInAnalyzers { get; init; } /// - /// Contains statistics about built-in character filters used in selected nodes. + /// + /// Contains statistics about built-in character filters used in selected nodes. + /// /// [JsonInclude, JsonPropertyName("built_in_char_filters")] public IReadOnlyCollection BuiltInCharFilters { get; init; } /// - /// Contains statistics about built-in token filters used in selected nodes. + /// + /// Contains statistics about built-in token filters used in selected nodes. + /// /// [JsonInclude, JsonPropertyName("built_in_filters")] public IReadOnlyCollection BuiltInFilters { get; init; } /// - /// Contains statistics about built-in tokenizers used in selected nodes. + /// + /// Contains statistics about built-in tokenizers used in selected nodes. + /// /// [JsonInclude, JsonPropertyName("built_in_tokenizers")] public IReadOnlyCollection BuiltInTokenizers { get; init; } /// - /// Contains statistics about character filter types used in selected nodes. + /// + /// Contains statistics about character filter types used in selected nodes. + /// /// [JsonInclude, JsonPropertyName("char_filter_types")] public IReadOnlyCollection CharFilterTypes2 { get; init; } /// - /// Contains statistics about token filter types used in selected nodes. + /// + /// Contains statistics about token filter types used in selected nodes. + /// /// [JsonInclude, JsonPropertyName("filter_types")] public IReadOnlyCollection FilterTypes { get; init; } /// - /// Contains statistics about tokenizer types used in selected nodes. + /// + /// Contains statistics about tokenizer types used in selected nodes. + /// /// [JsonInclude, JsonPropertyName("tokenizer_types")] public IReadOnlyCollection TokenizerTypes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterFileSystem.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterFileSystem.g.cs index 1520f8c552a..fb80ef4af77 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterFileSystem.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterFileSystem.g.cs @@ -30,19 +30,27 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterFileSystem { /// - /// Total number of bytes available to JVM in file stores across all selected nodes.
Depending on operating system or process-level restrictions, this number may be less than `nodes.fs.free_in_byes`.
This is the actual amount of free disk space the selected Elasticsearch nodes can use. + /// + /// Total number of bytes available to JVM in file stores across all selected nodes. + /// Depending on operating system or process-level restrictions, this number may be less than nodes.fs.free_in_byes. + /// This is the actual amount of free disk space the selected Elasticsearch nodes can use. + /// /// [JsonInclude, JsonPropertyName("available_in_bytes")] public long AvailableInBytes { get; init; } /// - /// Total number of unallocated bytes in file stores across all selected nodes. + /// + /// Total number of unallocated bytes in file stores across all selected nodes. + /// /// [JsonInclude, JsonPropertyName("free_in_bytes")] public long FreeInBytes { get; init; } /// - /// Total size, in bytes, of all file stores across all selected nodes. + /// + /// Total size, in bytes, of all file stores across all selected nodes. + /// /// [JsonInclude, JsonPropertyName("total_in_bytes")] public long TotalInBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterIndices.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterIndices.g.cs index 2698e53a175..7d491e75a90 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterIndices.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterIndices.g.cs @@ -30,67 +30,89 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterIndices { /// - /// Contains statistics about analyzers and analyzer components used in selected nodes. + /// + /// Contains statistics about analyzers and analyzer components used in selected nodes. + /// /// [JsonInclude, JsonPropertyName("analysis")] public Elastic.Clients.Elasticsearch.Cluster.CharFilterTypes Analysis { get; init; } /// - /// Contains statistics about memory used for completion in selected nodes. + /// + /// Contains statistics about memory used for completion in selected nodes. + /// /// [JsonInclude, JsonPropertyName("completion")] public Elastic.Clients.Elasticsearch.CompletionStats Completion { get; init; } /// - /// Total number of indices with shards assigned to selected nodes. + /// + /// Total number of indices with shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("count")] public long Count { get; init; } /// - /// Contains counts for documents in selected nodes. + /// + /// Contains counts for documents in selected nodes. + /// /// [JsonInclude, JsonPropertyName("docs")] public Elastic.Clients.Elasticsearch.DocStats Docs { get; init; } /// - /// Contains statistics about the field data cache of selected nodes. + /// + /// Contains statistics about the field data cache of selected nodes. + /// /// [JsonInclude, JsonPropertyName("fielddata")] public Elastic.Clients.Elasticsearch.FielddataStats Fielddata { get; init; } /// - /// Contains statistics about field mappings in selected nodes. + /// + /// Contains statistics about field mappings in selected nodes. + /// /// [JsonInclude, JsonPropertyName("mappings")] public Elastic.Clients.Elasticsearch.Cluster.FieldTypesMappings Mappings { get; init; } /// - /// Contains statistics about the query cache of selected nodes. + /// + /// Contains statistics about the query cache of selected nodes. + /// /// [JsonInclude, JsonPropertyName("query_cache")] public Elastic.Clients.Elasticsearch.QueryCacheStats QueryCache { get; init; } /// - /// Contains statistics about segments in selected nodes. + /// + /// Contains statistics about segments in selected nodes. + /// /// [JsonInclude, JsonPropertyName("segments")] public Elastic.Clients.Elasticsearch.SegmentsStats Segments { get; init; } /// - /// Contains statistics about indices with shards assigned to selected nodes. + /// + /// Contains statistics about indices with shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("shards")] public Elastic.Clients.Elasticsearch.Cluster.ClusterIndicesShards Shards { get; init; } /// - /// Contains statistics about the size of shards assigned to selected nodes. + /// + /// Contains statistics about the size of shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("store")] public Elastic.Clients.Elasticsearch.StoreStats Store { get; init; } /// - /// Contains statistics about analyzers and analyzer components used in selected nodes. + /// + /// Contains statistics about analyzers and analyzer components used in selected nodes. + /// /// [JsonInclude, JsonPropertyName("versions")] public IReadOnlyCollection? Versions { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterIndicesShards.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterIndicesShards.g.cs index a6fdebac6fa..c5b582bb4c7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterIndicesShards.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterIndicesShards.g.cs @@ -28,30 +28,40 @@ namespace Elastic.Clients.Elasticsearch.Cluster; /// -/// Contains statistics about shards assigned to selected nodes. +/// +/// Contains statistics about shards assigned to selected nodes. +/// /// public sealed partial class ClusterIndicesShards { /// - /// Contains statistics about shards assigned to selected nodes. + /// + /// Contains statistics about shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.Cluster.ClusterIndicesShardsIndex? Index { get; init; } /// - /// Number of primary shards assigned to selected nodes. + /// + /// Number of primary shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("primaries")] public double? Primaries { get; init; } /// - /// Ratio of replica shards to primary shards across all selected nodes. + /// + /// Ratio of replica shards to primary shards across all selected nodes. + /// /// [JsonInclude, JsonPropertyName("replication")] public double? Replication { get; init; } /// - /// Total number of shards assigned to selected nodes. + /// + /// Total number of shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("total")] public double? Total { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterIndicesShardsIndex.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterIndicesShardsIndex.g.cs index d4f90e81e2b..e8f861d298a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterIndicesShardsIndex.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterIndicesShardsIndex.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterIndicesShardsIndex { /// - /// Contains statistics about the number of primary shards assigned to selected nodes. + /// + /// Contains statistics about the number of primary shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("primaries")] public Elastic.Clients.Elasticsearch.Cluster.ClusterShardMetrics Primaries { get; init; } /// - /// Contains statistics about the number of replication shards assigned to selected nodes. + /// + /// Contains statistics about the number of replication shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("replication")] public Elastic.Clients.Elasticsearch.Cluster.ClusterShardMetrics Replication { get; init; } /// - /// Contains statistics about the number of shards assigned to selected nodes. + /// + /// Contains statistics about the number of shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("shards")] public Elastic.Clients.Elasticsearch.Cluster.ClusterShardMetrics Shards { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterJvm.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterJvm.g.cs index b9688f7a581..8c0a40c889c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterJvm.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterJvm.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterJvm { /// - /// Uptime duration, in milliseconds, since JVM last started. + /// + /// Uptime duration, in milliseconds, since JVM last started. + /// /// [JsonInclude, JsonPropertyName("max_uptime_in_millis")] public long MaxUptimeInMillis { get; init; } /// - /// Contains statistics about memory used by selected nodes. + /// + /// Contains statistics about memory used by selected nodes. + /// /// [JsonInclude, JsonPropertyName("mem")] public Elastic.Clients.Elasticsearch.Cluster.ClusterJvmMemory Mem { get; init; } /// - /// Number of active threads in use by JVM across all selected nodes. + /// + /// Number of active threads in use by JVM across all selected nodes. + /// /// [JsonInclude, JsonPropertyName("threads")] public long Threads { get; init; } /// - /// Contains statistics about the JVM versions used by selected nodes. + /// + /// Contains statistics about the JVM versions used by selected nodes. + /// /// [JsonInclude, JsonPropertyName("versions")] public IReadOnlyCollection Versions { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterJvmMemory.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterJvmMemory.g.cs index 05928d59d94..44c88757a16 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterJvmMemory.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterJvmMemory.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterJvmMemory { /// - /// Maximum amount of memory, in bytes, available for use by the heap across all selected nodes. + /// + /// Maximum amount of memory, in bytes, available for use by the heap across all selected nodes. + /// /// [JsonInclude, JsonPropertyName("heap_max_in_bytes")] public long HeapMaxInBytes { get; init; } /// - /// Memory, in bytes, currently in use by the heap across all selected nodes. + /// + /// Memory, in bytes, currently in use by the heap across all selected nodes. + /// /// [JsonInclude, JsonPropertyName("heap_used_in_bytes")] public long HeapUsedInBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterJvmVersion.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterJvmVersion.g.cs index c360c172f70..1fee52d6cb7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterJvmVersion.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterJvmVersion.g.cs @@ -30,43 +30,58 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterJvmVersion { /// - /// Always `true`. All distributions come with a bundled Java Development Kit (JDK). + /// + /// Always true. All distributions come with a bundled Java Development Kit (JDK). + /// /// [JsonInclude, JsonPropertyName("bundled_jdk")] public bool BundledJdk { get; init; } /// - /// Total number of selected nodes using JVM. + /// + /// Total number of selected nodes using JVM. + /// /// [JsonInclude, JsonPropertyName("count")] public int Count { get; init; } /// - /// If `true`, a bundled JDK is in use by JVM. + /// + /// If true, a bundled JDK is in use by JVM. + /// /// [JsonInclude, JsonPropertyName("using_bundled_jdk")] public bool UsingBundledJdk { get; init; } /// - /// Version of JVM used by one or more selected nodes. + /// + /// Version of JVM used by one or more selected nodes. + /// /// [JsonInclude, JsonPropertyName("version")] public string Version { get; init; } /// - /// Name of the JVM. + /// + /// Name of the JVM. + /// /// [JsonInclude, JsonPropertyName("vm_name")] public string VmName { get; init; } /// - /// Vendor of the JVM. + /// + /// Vendor of the JVM. + /// /// [JsonInclude, JsonPropertyName("vm_vendor")] public string VmVendor { get; init; } /// - /// Full version number of JVM.
The full version number includes a plus sign (+) followed by the build number. + /// + /// Full version number of JVM. + /// The full version number includes a plus sign (+) followed by the build number. + /// /// [JsonInclude, JsonPropertyName("vm_version")] public string VmVersion { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterNetworkTypes.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterNetworkTypes.g.cs index 5ecb02648b8..2a75ea8e1ea 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterNetworkTypes.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterNetworkTypes.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterNetworkTypes { /// - /// Contains statistics about the HTTP network types used by selected nodes. + /// + /// Contains statistics about the HTTP network types used by selected nodes. + /// /// [JsonInclude, JsonPropertyName("http_types")] public IReadOnlyDictionary HttpTypes { get; init; } /// - /// Contains statistics about the transport network types used by selected nodes. + /// + /// Contains statistics about the transport network types used by selected nodes. + /// /// [JsonInclude, JsonPropertyName("transport_types")] public IReadOnlyDictionary TransportTypes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterNodes.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterNodes.g.cs index 35ff984d11f..23d6d9e9673 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterNodes.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterNodes.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterNodes { /// - /// Contains counts for nodes selected by the request’s node filters. + /// + /// Contains counts for nodes selected by the request’s node filters. + /// /// [JsonInclude, JsonPropertyName("count")] public Elastic.Clients.Elasticsearch.Cluster.ClusterNodeCount Count { get; init; } /// - /// Contains statistics about the discovery types used by selected nodes. + /// + /// Contains statistics about the discovery types used by selected nodes. + /// /// [JsonInclude, JsonPropertyName("discovery_types")] public IReadOnlyDictionary DiscoveryTypes { get; init; } /// - /// Contains statistics about file stores by selected nodes. + /// + /// Contains statistics about file stores by selected nodes. + /// /// [JsonInclude, JsonPropertyName("fs")] public Elastic.Clients.Elasticsearch.Cluster.ClusterFileSystem Fs { get; init; } @@ -52,43 +58,58 @@ public sealed partial class ClusterNodes public Elastic.Clients.Elasticsearch.Cluster.ClusterIngest Ingest { get; init; } /// - /// Contains statistics about the Java Virtual Machines (JVMs) used by selected nodes. + /// + /// Contains statistics about the Java Virtual Machines (JVMs) used by selected nodes. + /// /// [JsonInclude, JsonPropertyName("jvm")] public Elastic.Clients.Elasticsearch.Cluster.ClusterJvm Jvm { get; init; } /// - /// Contains statistics about the transport and HTTP networks used by selected nodes. + /// + /// Contains statistics about the transport and HTTP networks used by selected nodes. + /// /// [JsonInclude, JsonPropertyName("network_types")] public Elastic.Clients.Elasticsearch.Cluster.ClusterNetworkTypes NetworkTypes { get; init; } /// - /// Contains statistics about the operating systems used by selected nodes. + /// + /// Contains statistics about the operating systems used by selected nodes. + /// /// [JsonInclude, JsonPropertyName("os")] public Elastic.Clients.Elasticsearch.Cluster.ClusterOperatingSystem Os { get; init; } /// - /// Contains statistics about Elasticsearch distributions installed on selected nodes. + /// + /// Contains statistics about Elasticsearch distributions installed on selected nodes. + /// /// [JsonInclude, JsonPropertyName("packaging_types")] public IReadOnlyCollection PackagingTypes { get; init; } /// - /// Contains statistics about installed plugins and modules by selected nodes.
If no plugins or modules are installed, this array is empty. + /// + /// Contains statistics about installed plugins and modules by selected nodes. + /// If no plugins or modules are installed, this array is empty. + /// /// [JsonInclude, JsonPropertyName("plugins")] public IReadOnlyCollection Plugins { get; init; } /// - /// Contains statistics about processes used by selected nodes. + /// + /// Contains statistics about processes used by selected nodes. + /// /// [JsonInclude, JsonPropertyName("process")] public Elastic.Clients.Elasticsearch.Cluster.ClusterProcess Process { get; init; } /// - /// Array of Elasticsearch versions used on selected nodes. + /// + /// Array of Elasticsearch versions used on selected nodes. + /// /// [JsonInclude, JsonPropertyName("versions")] public IReadOnlyCollection Versions { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystem.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystem.g.cs index 029e26f088c..d27fc5c2e87 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystem.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystem.g.cs @@ -30,37 +30,51 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterOperatingSystem { /// - /// Number of processors used to calculate thread pool size across all selected nodes.
This number can be set with the processors setting of a node and defaults to the number of processors reported by the operating system.
In both cases, this number will never be larger than 32. + /// + /// Number of processors used to calculate thread pool size across all selected nodes. + /// This number can be set with the processors setting of a node and defaults to the number of processors reported by the operating system. + /// In both cases, this number will never be larger than 32. + /// /// [JsonInclude, JsonPropertyName("allocated_processors")] public int AllocatedProcessors { get; init; } /// - /// Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes. + /// + /// Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes. + /// /// [JsonInclude, JsonPropertyName("architectures")] public IReadOnlyCollection? Architectures { get; init; } /// - /// Number of processors available to JVM across all selected nodes. + /// + /// Number of processors available to JVM across all selected nodes. + /// /// [JsonInclude, JsonPropertyName("available_processors")] public int AvailableProcessors { get; init; } /// - /// Contains statistics about memory used by selected nodes. + /// + /// Contains statistics about memory used by selected nodes. + /// /// [JsonInclude, JsonPropertyName("mem")] public Elastic.Clients.Elasticsearch.Cluster.OperatingSystemMemoryInfo Mem { get; init; } /// - /// Contains statistics about operating systems used by selected nodes. + /// + /// Contains statistics about operating systems used by selected nodes. + /// /// [JsonInclude, JsonPropertyName("names")] public IReadOnlyCollection Names { get; init; } /// - /// Contains statistics about operating systems used by selected nodes. + /// + /// Contains statistics about operating systems used by selected nodes. + /// /// [JsonInclude, JsonPropertyName("pretty_names")] public IReadOnlyCollection PrettyNames { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystemArchitecture.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystemArchitecture.g.cs index e0232890c56..b56a049a1a7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystemArchitecture.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystemArchitecture.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterOperatingSystemArchitecture { /// - /// Name of an architecture used by one or more selected nodes. + /// + /// Name of an architecture used by one or more selected nodes. + /// /// [JsonInclude, JsonPropertyName("arch")] public string Arch { get; init; } /// - /// Number of selected nodes using the architecture. + /// + /// Number of selected nodes using the architecture. + /// /// [JsonInclude, JsonPropertyName("count")] public int Count { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystemName.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystemName.g.cs index 1e419f37b88..ec8775a23e6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystemName.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystemName.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterOperatingSystemName { /// - /// Number of selected nodes using the operating system. + /// + /// Number of selected nodes using the operating system. + /// /// [JsonInclude, JsonPropertyName("count")] public int Count { get; init; } /// - /// Name of an operating system used by one or more selected nodes. + /// + /// Name of an operating system used by one or more selected nodes. + /// /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystemPrettyName.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystemPrettyName.g.cs index 0fb1da09475..aba9ca2ea97 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystemPrettyName.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystemPrettyName.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterOperatingSystemPrettyName { /// - /// Number of selected nodes using the operating system. + /// + /// Number of selected nodes using the operating system. + /// /// [JsonInclude, JsonPropertyName("count")] public int Count { get; init; } /// - /// Human-readable name of an operating system used by one or more selected nodes. + /// + /// Human-readable name of an operating system used by one or more selected nodes. + /// /// [JsonInclude, JsonPropertyName("pretty_name")] public string PrettyName { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterProcess.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterProcess.g.cs index 084fcb1f8d5..02380edf8ab 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterProcess.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterProcess.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterProcess { /// - /// Contains statistics about CPU used by selected nodes. + /// + /// Contains statistics about CPU used by selected nodes. + /// /// [JsonInclude, JsonPropertyName("cpu")] public Elastic.Clients.Elasticsearch.Cluster.ClusterProcessCpu Cpu { get; init; } /// - /// Contains statistics about open file descriptors in selected nodes. + /// + /// Contains statistics about open file descriptors in selected nodes. + /// /// [JsonInclude, JsonPropertyName("open_file_descriptors")] public Elastic.Clients.Elasticsearch.Cluster.ClusterProcessOpenFileDescriptors OpenFileDescriptors { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterProcessCpu.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterProcessCpu.g.cs index 512a670fe20..b55d135943c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterProcessCpu.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterProcessCpu.g.cs @@ -30,7 +30,10 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterProcessCpu { /// - /// Percentage of CPU used across all selected nodes.
Returns `-1` if not supported. + /// + /// Percentage of CPU used across all selected nodes. + /// Returns -1 if not supported. + /// /// [JsonInclude, JsonPropertyName("percent")] public int Percent { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterProcessOpenFileDescriptors.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterProcessOpenFileDescriptors.g.cs index 80eb0e8e1dd..86fce288f02 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterProcessOpenFileDescriptors.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterProcessOpenFileDescriptors.g.cs @@ -30,19 +30,28 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterProcessOpenFileDescriptors { /// - /// Average number of concurrently open file descriptors.
Returns `-1` if not supported. + /// + /// Average number of concurrently open file descriptors. + /// Returns -1 if not supported. + /// /// [JsonInclude, JsonPropertyName("avg")] public long Avg { get; init; } /// - /// Maximum number of concurrently open file descriptors allowed across all selected nodes.
Returns `-1` if not supported. + /// + /// Maximum number of concurrently open file descriptors allowed across all selected nodes. + /// Returns -1 if not supported. + /// /// [JsonInclude, JsonPropertyName("max")] public long Max { get; init; } /// - /// Minimum number of concurrently open file descriptors across all selected nodes.
Returns -1 if not supported. + /// + /// Minimum number of concurrently open file descriptors across all selected nodes. + /// Returns -1 if not supported. + /// /// [JsonInclude, JsonPropertyName("min")] public long Min { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterShardMetrics.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterShardMetrics.g.cs index 1298dcb194d..7c2dcb2f0ff 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterShardMetrics.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterShardMetrics.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterShardMetrics { /// - /// Mean number of shards in an index, counting only shards assigned to selected nodes. + /// + /// Mean number of shards in an index, counting only shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("avg")] public double Avg { get; init; } /// - /// Maximum number of shards in an index, counting only shards assigned to selected nodes. + /// + /// Maximum number of shards in an index, counting only shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("max")] public double Max { get; init; } /// - /// Minimum number of shards in an index, counting only shards assigned to selected nodes. + /// + /// Minimum number of shards in an index, counting only shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("min")] public double Min { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/FieldTypes.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/FieldTypes.g.cs index 7b314d7427e..5df2efc5a7e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/FieldTypes.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/FieldTypes.g.cs @@ -30,43 +30,57 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class FieldTypes { /// - /// The number of occurrences of the field type in selected nodes. + /// + /// The number of occurrences of the field type in selected nodes. + /// /// [JsonInclude, JsonPropertyName("count")] public int Count { get; init; } /// - /// The number of indices containing the field type in selected nodes. + /// + /// The number of indices containing the field type in selected nodes. + /// /// [JsonInclude, JsonPropertyName("index_count")] public int IndexCount { get; init; } /// - /// For dense_vector field types, number of indexed vector types in selected nodes. + /// + /// For dense_vector field types, number of indexed vector types in selected nodes. + /// /// [JsonInclude, JsonPropertyName("indexed_vector_count")] public long? IndexedVectorCount { get; init; } /// - /// For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes. + /// + /// For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes. + /// /// [JsonInclude, JsonPropertyName("indexed_vector_dim_max")] public long? IndexedVectorDimMax { get; init; } /// - /// For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes. + /// + /// For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes. + /// /// [JsonInclude, JsonPropertyName("indexed_vector_dim_min")] public long? IndexedVectorDimMin { get; init; } /// - /// The name for the field type in selected nodes. + /// + /// The name for the field type in selected nodes. + /// /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } /// - /// The number of fields that declare a script. + /// + /// The number of fields that declare a script. + /// /// [JsonInclude, JsonPropertyName("script_count")] public int? ScriptCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/FieldTypesMappings.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/FieldTypesMappings.g.cs index ece0cddbc33..8e9caeac638 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/FieldTypesMappings.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/FieldTypesMappings.g.cs @@ -30,37 +30,49 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class FieldTypesMappings { /// - /// Contains statistics about field data types used in selected nodes. + /// + /// Contains statistics about field data types used in selected nodes. + /// /// [JsonInclude, JsonPropertyName("field_types")] public IReadOnlyCollection FieldTypes { get; init; } /// - /// Contains statistics about runtime field data types used in selected nodes. + /// + /// Contains statistics about runtime field data types used in selected nodes. + /// /// [JsonInclude, JsonPropertyName("runtime_field_types")] public IReadOnlyCollection? RuntimeFieldTypes { get; init; } /// - /// Total number of fields in all non-system indices, accounting for mapping deduplication. + /// + /// Total number of fields in all non-system indices, accounting for mapping deduplication. + /// /// [JsonInclude, JsonPropertyName("total_deduplicated_field_count")] public int? TotalDeduplicatedFieldCount { get; init; } /// - /// Total size of all mappings after deduplication and compression. + /// + /// Total size of all mappings after deduplication and compression. + /// /// [JsonInclude, JsonPropertyName("total_deduplicated_mapping_size")] public Elastic.Clients.Elasticsearch.ByteSize? TotalDeduplicatedMappingSize { get; init; } /// - /// Total size of all mappings, in bytes, after deduplication and compression. + /// + /// Total size of all mappings, in bytes, after deduplication and compression. + /// /// [JsonInclude, JsonPropertyName("total_deduplicated_mapping_size_in_bytes")] public long? TotalDeduplicatedMappingSizeInBytes { get; init; } /// - /// Total number of fields in all non-system indices. + /// + /// Total number of fields in all non-system indices. + /// /// [JsonInclude, JsonPropertyName("total_field_count")] public int? TotalFieldCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/NodePackagingType.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/NodePackagingType.g.cs index 6037b569013..c2593e716a5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/NodePackagingType.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/NodePackagingType.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class NodePackagingType { /// - /// Number of selected nodes using the distribution flavor and file type. + /// + /// Number of selected nodes using the distribution flavor and file type. + /// /// [JsonInclude, JsonPropertyName("count")] public int Count { get; init; } /// - /// Type of Elasticsearch distribution. This is always `default`. + /// + /// Type of Elasticsearch distribution. This is always default. + /// /// [JsonInclude, JsonPropertyName("flavor")] public string Flavor { get; init; } /// - /// File type (such as `tar` or `zip`) used for the distribution package. + /// + /// File type (such as tar or zip) used for the distribution package. + /// /// [JsonInclude, JsonPropertyName("type")] public string Type { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/OperatingSystemMemoryInfo.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/OperatingSystemMemoryInfo.g.cs index d781186a519..c3a476e45f1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/OperatingSystemMemoryInfo.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/OperatingSystemMemoryInfo.g.cs @@ -30,37 +30,49 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class OperatingSystemMemoryInfo { /// - /// Total amount, in bytes, of memory across all selected nodes, but using the value specified using the `es.total_memory_bytes` system property instead of measured total memory for those nodes where that system property was set. + /// + /// Total amount, in bytes, of memory across all selected nodes, but using the value specified using the es.total_memory_bytes system property instead of measured total memory for those nodes where that system property was set. + /// /// [JsonInclude, JsonPropertyName("adjusted_total_in_bytes")] public long? AdjustedTotalInBytes { get; init; } /// - /// Amount, in bytes, of free physical memory across all selected nodes. + /// + /// Amount, in bytes, of free physical memory across all selected nodes. + /// /// [JsonInclude, JsonPropertyName("free_in_bytes")] public long FreeInBytes { get; init; } /// - /// Percentage of free physical memory across all selected nodes. + /// + /// Percentage of free physical memory across all selected nodes. + /// /// [JsonInclude, JsonPropertyName("free_percent")] public int FreePercent { get; init; } /// - /// Total amount, in bytes, of physical memory across all selected nodes. + /// + /// Total amount, in bytes, of physical memory across all selected nodes. + /// /// [JsonInclude, JsonPropertyName("total_in_bytes")] public long TotalInBytes { get; init; } /// - /// Amount, in bytes, of physical memory in use across all selected nodes. + /// + /// Amount, in bytes, of physical memory in use across all selected nodes. + /// /// [JsonInclude, JsonPropertyName("used_in_bytes")] public long UsedInBytes { get; init; } /// - /// Percentage of physical memory in use across all selected nodes. + /// + /// Percentage of physical memory in use across all selected nodes. + /// /// [JsonInclude, JsonPropertyName("used_percent")] public int UsedPercent { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/PendingTask.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/PendingTask.g.cs index bb419d5f265..582157faa70 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/PendingTask.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/PendingTask.g.cs @@ -30,37 +30,50 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class PendingTask { /// - /// Indicates whether the pending tasks are currently executing or not. + /// + /// Indicates whether the pending tasks are currently executing or not. + /// /// [JsonInclude, JsonPropertyName("executing")] public bool Executing { get; init; } /// - /// The number that represents when the task has been inserted into the task queue. + /// + /// The number that represents when the task has been inserted into the task queue. + /// /// [JsonInclude, JsonPropertyName("insert_order")] public int InsertOrder { get; init; } /// - /// The priority of the pending task.
The valid priorities in descending priority order are: `IMMEDIATE` > `URGENT` > `HIGH` > `NORMAL` > `LOW` > `LANGUID`. + /// + /// The priority of the pending task. + /// The valid priorities in descending priority order are: IMMEDIATE > URGENT > HIGH > NORMAL > LOW > LANGUID. + /// /// [JsonInclude, JsonPropertyName("priority")] public string Priority { get; init; } /// - /// A general description of the cluster task that may include a reason and origin. + /// + /// A general description of the cluster task that may include a reason and origin. + /// /// [JsonInclude, JsonPropertyName("source")] public string Source { get; init; } /// - /// The time since the task is waiting for being performed. + /// + /// The time since the task is waiting for being performed. + /// /// [JsonInclude, JsonPropertyName("time_in_queue")] public Elastic.Clients.Elasticsearch.Duration? TimeInQueue { get; init; } /// - /// The time expressed in milliseconds since the task is waiting for being performed. + /// + /// The time expressed in milliseconds since the task is waiting for being performed. + /// /// [JsonInclude, JsonPropertyName("time_in_queue_millis")] public long TimeInQueueMillis { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/RuntimeFieldTypes.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/RuntimeFieldTypes.g.cs index 1ef4a777843..dc7d130b72c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/RuntimeFieldTypes.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/RuntimeFieldTypes.g.cs @@ -30,85 +30,113 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class RuntimeFieldTypes { /// - /// Maximum number of characters for a single runtime field script. + /// + /// Maximum number of characters for a single runtime field script. + /// /// [JsonInclude, JsonPropertyName("chars_max")] public int CharsMax { get; init; } /// - /// Total number of characters for the scripts that define the current runtime field data type. + /// + /// Total number of characters for the scripts that define the current runtime field data type. + /// /// [JsonInclude, JsonPropertyName("chars_total")] public int CharsTotal { get; init; } /// - /// Number of runtime fields mapped to the field data type in selected nodes. + /// + /// Number of runtime fields mapped to the field data type in selected nodes. + /// /// [JsonInclude, JsonPropertyName("count")] public int Count { get; init; } /// - /// Maximum number of accesses to doc_values for a single runtime field script + /// + /// Maximum number of accesses to doc_values for a single runtime field script + /// /// [JsonInclude, JsonPropertyName("doc_max")] public int DocMax { get; init; } /// - /// Total number of accesses to doc_values for the scripts that define the current runtime field data type. + /// + /// Total number of accesses to doc_values for the scripts that define the current runtime field data type. + /// /// [JsonInclude, JsonPropertyName("doc_total")] public int DocTotal { get; init; } /// - /// Number of indices containing a mapping of the runtime field data type in selected nodes. + /// + /// Number of indices containing a mapping of the runtime field data type in selected nodes. + /// /// [JsonInclude, JsonPropertyName("index_count")] public int IndexCount { get; init; } /// - /// Script languages used for the runtime fields scripts. + /// + /// Script languages used for the runtime fields scripts. + /// /// [JsonInclude, JsonPropertyName("lang")] public IReadOnlyCollection Lang { get; init; } /// - /// Maximum number of lines for a single runtime field script. + /// + /// Maximum number of lines for a single runtime field script. + /// /// [JsonInclude, JsonPropertyName("lines_max")] public int LinesMax { get; init; } /// - /// Total number of lines for the scripts that define the current runtime field data type. + /// + /// Total number of lines for the scripts that define the current runtime field data type. + /// /// [JsonInclude, JsonPropertyName("lines_total")] public int LinesTotal { get; init; } /// - /// Field data type used in selected nodes. + /// + /// Field data type used in selected nodes. + /// /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } /// - /// Number of runtime fields that don’t declare a script. + /// + /// Number of runtime fields that don’t declare a script. + /// /// [JsonInclude, JsonPropertyName("scriptless_count")] public int ScriptlessCount { get; init; } /// - /// Number of runtime fields that shadow an indexed field. + /// + /// Number of runtime fields that shadow an indexed field. + /// /// [JsonInclude, JsonPropertyName("shadowed_count")] public int ShadowedCount { get; init; } /// - /// Maximum number of accesses to _source for a single runtime field script. + /// + /// Maximum number of accesses to _source for a single runtime field script. + /// /// [JsonInclude, JsonPropertyName("source_max")] public int SourceMax { get; init; } /// - /// Total number of accesses to _source for the scripts that define the current runtime field data type. + /// + /// Total number of accesses to _source for the scripts that define the current runtime field data type. + /// /// [JsonInclude, JsonPropertyName("source_total")] public int SourceTotal { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/CompletionStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/CompletionStats.g.cs index 1c1b2e852d8..00c49f9380c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/CompletionStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/CompletionStats.g.cs @@ -34,13 +34,17 @@ public sealed partial class CompletionStats public IReadOnlyDictionary? Fields { get; init; } /// - /// Total amount of memory used for completion across all shards assigned to selected nodes. + /// + /// Total amount of memory used for completion across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("size")] public Elastic.Clients.Elasticsearch.ByteSize? Size { get; init; } /// - /// Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes. + /// + /// Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("size_in_bytes")] public long SizeInBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Bulk/ResponseItem.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Bulk/ResponseItem.g.cs index 94ff7034f3d..fa67e544390 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Bulk/ResponseItem.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Bulk/ResponseItem.g.cs @@ -30,7 +30,10 @@ namespace Elastic.Clients.Elasticsearch.Core.Bulk; public partial class ResponseItem { /// - /// Contains additional information about the failed operation.
The parameter is only returned for failed operations. + /// + /// Contains additional information about the failed operation. + /// The parameter is only returned for failed operations. + /// /// [JsonInclude, JsonPropertyName("error")] public Elastic.Clients.Elasticsearch.ErrorCause? Error { get; init; } @@ -40,49 +43,69 @@ public partial class ResponseItem public Elastic.Clients.Elasticsearch.InlineGet>? Get { get; init; } /// - /// The document ID associated with the operation. + /// + /// The document ID associated with the operation. + /// /// [JsonInclude, JsonPropertyName("_id")] public string? Id { get; init; } /// - /// Name of the index associated with the operation.
If the operation targeted a data stream, this is the backing index into which the document was written. + /// + /// Name of the index associated with the operation. + /// If the operation targeted a data stream, this is the backing index into which the document was written. + /// /// [JsonInclude, JsonPropertyName("_index")] public string Index { get; init; } /// - /// The primary term assigned to the document for the operation. + /// + /// The primary term assigned to the document for the operation. + /// /// [JsonInclude, JsonPropertyName("_primary_term")] public long? PrimaryTerm { get; init; } /// - /// Result of the operation.
Successful values are `created`, `deleted`, and `updated`. + /// + /// Result of the operation. + /// Successful values are created, deleted, and updated. + /// /// [JsonInclude, JsonPropertyName("result")] public string? Result { get; init; } /// - /// The sequence number assigned to the document for the operation.
Sequence numbers are used to ensure an older version of a document doesn’t overwrite a newer version. + /// + /// The sequence number assigned to the document for the operation. + /// Sequence numbers are used to ensure an older version of a document doesn’t overwrite a newer version. + /// /// [JsonInclude, JsonPropertyName("_seq_no")] public long? SeqNo { get; init; } /// - /// Contains shard information for the operation. + /// + /// Contains shard information for the operation. + /// /// [JsonInclude, JsonPropertyName("_shards")] public Elastic.Clients.Elasticsearch.ShardStatistics? Shards { get; init; } /// - /// HTTP status code returned for the operation. + /// + /// HTTP status code returned for the operation. + /// /// [JsonInclude, JsonPropertyName("status")] public int Status { get; init; } /// - /// The document version associated with the operation.
The document version is incremented each time the document is updated. + /// + /// The document version associated with the operation. + /// The document version is incremented each time the document is updated. + /// /// [JsonInclude, JsonPropertyName("_version")] public long? Version { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Context.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Context.g.cs index 17462b44bf8..ef078650fed 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Context.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Context.g.cs @@ -31,7 +31,9 @@ namespace Elastic.Clients.Elasticsearch.Core.Search; /// -/// Text or location that we want similar documents for or a lookup to a document's field for the text. +/// +/// Text or location that we want similar documents for or a lookup to a document's field for the text. +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class Context : Union diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/FieldCaps/FieldCapability.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/FieldCaps/FieldCapability.g.cs index ba84e5a9626..7305368830a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/FieldCaps/FieldCapability.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/FieldCaps/FieldCapability.g.cs @@ -30,70 +30,95 @@ namespace Elastic.Clients.Elasticsearch.Core.FieldCaps; public sealed partial class FieldCapability { /// - /// Whether this field can be aggregated on all indices. + /// + /// Whether this field can be aggregated on all indices. + /// /// [JsonInclude, JsonPropertyName("aggregatable")] public bool Aggregatable { get; init; } /// - /// The list of indices where this field has the same type family, or null if all indices have the same type family for the field. + /// + /// The list of indices where this field has the same type family, or null if all indices have the same type family for the field. + /// /// [JsonInclude, JsonPropertyName("indices")] [SingleOrManyCollectionConverter(typeof(string))] public IReadOnlyCollection? Indices { get; init; } /// - /// Merged metadata across all indices as a map of string keys to arrays of values. A value length of 1 indicates that all indices had the same value for this key, while a length of 2 or more indicates that not all indices had the same value for this key. + /// + /// Merged metadata across all indices as a map of string keys to arrays of values. A value length of 1 indicates that all indices had the same value for this key, while a length of 2 or more indicates that not all indices had the same value for this key. + /// /// [JsonInclude, JsonPropertyName("meta")] public IReadOnlyDictionary? Meta { get; init; } /// - /// Whether this field is registered as a metadata field. + /// + /// Whether this field is registered as a metadata field. + /// /// [JsonInclude, JsonPropertyName("metadata_field")] public bool? MetadataField { get; init; } /// - /// The list of indices where this field is present if these indices
don’t have the same `time_series_metric` value for this field. + /// + /// The list of indices where this field is present if these indices + /// don’t have the same time_series_metric value for this field. + /// /// [JsonInclude, JsonPropertyName("metric_conflicts_indices")] public IReadOnlyCollection? MetricConflictsIndices { get; init; } /// - /// The list of indices where this field is not aggregatable, or null if all indices have the same definition for the field. + /// + /// The list of indices where this field is not aggregatable, or null if all indices have the same definition for the field. + /// /// [JsonInclude, JsonPropertyName("non_aggregatable_indices")] [SingleOrManyCollectionConverter(typeof(string))] public IReadOnlyCollection? NonAggregatableIndices { get; init; } /// - /// If this list is present in response then some indices have the
field marked as a dimension and other indices, the ones in this list, do not. + /// + /// If this list is present in response then some indices have the + /// field marked as a dimension and other indices, the ones in this list, do not. + /// /// [JsonInclude, JsonPropertyName("non_dimension_indices")] public IReadOnlyCollection? NonDimensionIndices { get; init; } /// - /// The list of indices where this field is not searchable, or null if all indices have the same definition for the field. + /// + /// The list of indices where this field is not searchable, or null if all indices have the same definition for the field. + /// /// [JsonInclude, JsonPropertyName("non_searchable_indices")] [SingleOrManyCollectionConverter(typeof(string))] public IReadOnlyCollection? NonSearchableIndices { get; init; } /// - /// Whether this field is indexed for search on all indices. + /// + /// Whether this field is indexed for search on all indices. + /// /// [JsonInclude, JsonPropertyName("searchable")] public bool Searchable { get; init; } /// - /// Whether this field is used as a time series dimension. + /// + /// Whether this field is used as a time series dimension. + /// /// [JsonInclude, JsonPropertyName("time_series_dimension")] public bool? TimeSeriesDimension { get; init; } /// - /// Contains metric type if this fields is used as a time series
metrics, absent if the field is not used as metric. + /// + /// Contains metric type if this fields is used as a time series + /// metrics, absent if the field is not used as metric. + /// /// [JsonInclude, JsonPropertyName("time_series_metric")] public Elastic.Clients.Elasticsearch.Mapping.TimeSeriesMetricType? TimeSeriesMetric { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/DiskIndicator.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/DiskIndicator.g.cs index 94dd2069b99..53fbb4a5483 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/DiskIndicator.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/DiskIndicator.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Core.HealthReport; /// -/// DISK +/// +/// DISK +/// /// public sealed partial class DiskIndicator { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/IlmIndicator.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/IlmIndicator.g.cs index a0b048add39..2ce6200c9c4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/IlmIndicator.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/IlmIndicator.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Core.HealthReport; /// -/// ILM +/// +/// ILM +/// /// public sealed partial class IlmIndicator { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/MasterIsStableIndicator.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/MasterIsStableIndicator.g.cs index e3b581d3eb5..d1c50ea6a48 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/MasterIsStableIndicator.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/MasterIsStableIndicator.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Core.HealthReport; /// -/// MASTER_IS_STABLE +/// +/// MASTER_IS_STABLE +/// /// public sealed partial class MasterIsStableIndicator { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/RepositoryIntegrityIndicator.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/RepositoryIntegrityIndicator.g.cs index b0aa9374480..0ba36efc6b1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/RepositoryIntegrityIndicator.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/RepositoryIntegrityIndicator.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Core.HealthReport; /// -/// REPOSITORY_INTEGRITY +/// +/// REPOSITORY_INTEGRITY +/// /// public sealed partial class RepositoryIntegrityIndicator { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/ShardsAvailabilityIndicator.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/ShardsAvailabilityIndicator.g.cs index 05a9717ab1b..79d430ca52c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/ShardsAvailabilityIndicator.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/ShardsAvailabilityIndicator.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Core.HealthReport; /// -/// SHARDS_AVAILABILITY +/// +/// SHARDS_AVAILABILITY +/// /// public sealed partial class ShardsAvailabilityIndicator { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/ShardsCapacityIndicator.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/ShardsCapacityIndicator.g.cs index 5bd41d86ba9..6b1e54b0a0f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/ShardsCapacityIndicator.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/ShardsCapacityIndicator.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Core.HealthReport; /// -/// SHARDS_CAPACITY +/// +/// SHARDS_CAPACITY +/// /// public sealed partial class ShardsCapacityIndicator { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/SlmIndicator.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/SlmIndicator.g.cs index 7247adddb53..e8ce7e202e7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/SlmIndicator.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/SlmIndicator.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Core.HealthReport; /// -/// SLM +/// +/// SLM +/// /// public sealed partial class SlmIndicator { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/MGet/MultiGetOperation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/MGet/MultiGetOperation.g.cs index d5b80a2b1da..eb20a84fc6e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/MGet/MultiGetOperation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/MGet/MultiGetOperation.g.cs @@ -30,31 +30,41 @@ namespace Elastic.Clients.Elasticsearch.Core.MGet; public sealed partial class MultiGetOperation { /// - /// The unique document ID. + /// + /// The unique document ID. + /// /// [JsonInclude, JsonPropertyName("_id")] public Elastic.Clients.Elasticsearch.Id Id { get; set; } /// - /// The index that contains the document. + /// + /// The index that contains the document. + /// /// [JsonInclude, JsonPropertyName("_index")] public Elastic.Clients.Elasticsearch.IndexName? Index { get; set; } /// - /// The key for the primary shard the document resides on. Required if routing is used during indexing. + /// + /// The key for the primary shard the document resides on. Required if routing is used during indexing. + /// /// [JsonInclude, JsonPropertyName("routing")] public Elastic.Clients.Elasticsearch.Routing? Routing { get; set; } /// - /// If `false`, excludes all _source fields. + /// + /// If false, excludes all _source fields. + /// /// [JsonInclude, JsonPropertyName("_source")] public Elastic.Clients.Elasticsearch.Core.Search.SourceConfig? Source { get; set; } /// - /// The stored fields you want to retrieve. + /// + /// The stored fields you want to retrieve. + /// /// [JsonInclude, JsonPropertyName("stored_fields")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] @@ -82,7 +92,9 @@ public MultiGetOperationDescriptor() : base() private Elastic.Clients.Elasticsearch.VersionType? VersionTypeValue { get; set; } /// - /// The unique document ID. + /// + /// The unique document ID. + /// /// public MultiGetOperationDescriptor Id(Elastic.Clients.Elasticsearch.Id id) { @@ -91,7 +103,9 @@ public MultiGetOperationDescriptor Id(Elastic.Clients.Elasticsearch.I } /// - /// The index that contains the document. + /// + /// The index that contains the document. + /// /// public MultiGetOperationDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? index) { @@ -100,7 +114,9 @@ public MultiGetOperationDescriptor Index(Elastic.Clients.Elasticsearc } /// - /// The key for the primary shard the document resides on. Required if routing is used during indexing. + /// + /// The key for the primary shard the document resides on. Required if routing is used during indexing. + /// /// public MultiGetOperationDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? routing) { @@ -109,7 +125,9 @@ public MultiGetOperationDescriptor Routing(Elastic.Clients.Elasticsea } /// - /// If `false`, excludes all _source fields. + /// + /// If false, excludes all _source fields. + /// /// public MultiGetOperationDescriptor Source(Elastic.Clients.Elasticsearch.Core.Search.SourceConfig? source) { @@ -118,7 +136,9 @@ public MultiGetOperationDescriptor Source(Elastic.Clients.Elasticsear } /// - /// The stored fields you want to retrieve. + /// + /// The stored fields you want to retrieve. + /// /// public MultiGetOperationDescriptor StoredFields(Elastic.Clients.Elasticsearch.Fields? storedFields) { @@ -200,7 +220,9 @@ public MultiGetOperationDescriptor() : base() private Elastic.Clients.Elasticsearch.VersionType? VersionTypeValue { get; set; } /// - /// The unique document ID. + /// + /// The unique document ID. + /// /// public MultiGetOperationDescriptor Id(Elastic.Clients.Elasticsearch.Id id) { @@ -209,7 +231,9 @@ public MultiGetOperationDescriptor Id(Elastic.Clients.Elasticsearch.Id id) } /// - /// The index that contains the document. + /// + /// The index that contains the document. + /// /// public MultiGetOperationDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? index) { @@ -218,7 +242,9 @@ public MultiGetOperationDescriptor Index(Elastic.Clients.Elasticsearch.IndexName } /// - /// The key for the primary shard the document resides on. Required if routing is used during indexing. + /// + /// The key for the primary shard the document resides on. Required if routing is used during indexing. + /// /// public MultiGetOperationDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? routing) { @@ -227,7 +253,9 @@ public MultiGetOperationDescriptor Routing(Elastic.Clients.Elasticsearch.Routing } /// - /// If `false`, excludes all _source fields. + /// + /// If false, excludes all _source fields. + /// /// public MultiGetOperationDescriptor Source(Elastic.Clients.Elasticsearch.Core.Search.SourceConfig? source) { @@ -236,7 +264,9 @@ public MultiGetOperationDescriptor Source(Elastic.Clients.Elasticsearch.Core.Sea } /// - /// The stored fields you want to retrieve. + /// + /// The stored fields you want to retrieve. + /// /// public MultiGetOperationDescriptor StoredFields(Elastic.Clients.Elasticsearch.Fields? storedFields) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/MSearch/MultisearchBody.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/MSearch/MultisearchBody.g.cs index 014d82faeb3..eba508a1054 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/MSearch/MultisearchBody.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/MSearch/MultisearchBody.g.cs @@ -430,119 +430,186 @@ public sealed partial class MultisearchBody public Elastic.Clients.Elasticsearch.Core.Search.FieldCollapse? Collapse { get; set; } /// - /// Array of wildcard (*) patterns. The request returns doc values for field
names matching these patterns in the hits.fields property of the response. + /// + /// Array of wildcard (*) patterns. The request returns doc values for field + /// names matching these patterns in the hits.fields property of the response. + /// /// public ICollection? DocvalueFields { get; set; } /// - /// If true, returns detailed information about score computation as part of a hit. + /// + /// If true, returns detailed information about score computation as part of a hit. + /// /// public bool? Explain { get; set; } /// - /// Configuration of search extensions defined by Elasticsearch plugins. + /// + /// Configuration of search extensions defined by Elasticsearch plugins. + /// /// public IDictionary? Ext { get; set; } /// - /// Array of wildcard (*) patterns. The request returns values for field names
matching these patterns in the hits.fields property of the response. + /// + /// Array of wildcard (*) patterns. The request returns values for field names + /// matching these patterns in the hits.fields property of the response. + /// /// public ICollection? Fields { get; set; } /// - /// Starting document offset. By default, you cannot page through more than 10,000
hits using the from and size parameters. To page through more hits, use the
search_after parameter. + /// + /// Starting document offset. By default, you cannot page through more than 10,000 + /// hits using the from and size parameters. To page through more hits, use the + /// search_after parameter. + /// /// public int? From { get; set; } public Elastic.Clients.Elasticsearch.Core.Search.Highlight? Highlight { get; set; } /// - /// Boosts the _score of documents from specified indices. + /// + /// Boosts the _score of documents from specified indices. + /// /// public ICollection>? IndicesBoost { get; set; } /// - /// Defines the approximate kNN search to run. + /// + /// Defines the approximate kNN search to run. + /// /// public ICollection? Knn { get; set; } /// - /// Minimum _score for matching documents. Documents with a lower _score are
not included in the search results. + /// + /// Minimum _score for matching documents. Documents with a lower _score are + /// not included in the search results. + /// /// public double? MinScore { get; set; } /// - /// Limits the search to a point in time (PIT). If you provide a PIT, you
cannot specify an in the request path. + /// + /// Limits the search to a point in time (PIT). If you provide a PIT, you + /// cannot specify an <index> in the request path. + /// /// public Elastic.Clients.Elasticsearch.Core.Search.PointInTimeReference? Pit { get; set; } public Elastic.Clients.Elasticsearch.QueryDsl.Query? PostFilter { get; set; } public bool? Profile { get; set; } /// - /// Defines the search definition using the Query DSL. + /// + /// Defines the search definition using the Query DSL. + /// /// public Elastic.Clients.Elasticsearch.QueryDsl.Query? Query { get; set; } public ICollection? Rescore { get; set; } /// - /// Defines one or more runtime fields in the search request. These fields take
precedence over mapped fields with the same name. + /// + /// Defines one or more runtime fields in the search request. These fields take + /// precedence over mapped fields with the same name. + /// /// public IDictionary? RuntimeMappings { get; set; } /// - /// Retrieve a script evaluation (based on different fields) for each hit. + /// + /// Retrieve a script evaluation (based on different fields) for each hit. + /// /// public IDictionary? ScriptFields { get; set; } public ICollection? SearchAfter { get; set; } /// - /// If true, returns sequence number and primary term of the last modification
of each hit. See Optimistic concurrency control. + /// + /// If true, returns sequence number and primary term of the last modification + /// of each hit. See Optimistic concurrency control. + /// /// public bool? SeqNoPrimaryTerm { get; set; } /// - /// The number of hits to return. By default, you cannot page through more
than 10,000 hits using the from and size parameters. To page through more
hits, use the search_after parameter. + /// + /// The number of hits to return. By default, you cannot page through more + /// than 10,000 hits using the from and size parameters. To page through more + /// hits, use the search_after parameter. + /// /// public int? Size { get; set; } public ICollection? Sort { get; set; } /// - /// Indicates which source fields are returned for matching documents. These
fields are returned in the hits._source property of the search response. + /// + /// Indicates which source fields are returned for matching documents. These + /// fields are returned in the hits._source property of the search response. + /// /// public Elastic.Clients.Elasticsearch.Core.Search.SourceConfig? Source { get; set; } /// - /// Stats groups to associate with the search. Each group maintains a statistics
aggregation for its associated searches. You can retrieve these stats using
the indices stats API. + /// + /// Stats groups to associate with the search. Each group maintains a statistics + /// aggregation for its associated searches. You can retrieve these stats using + /// the indices stats API. + /// /// public ICollection? Stats { get; set; } /// - /// List of stored fields to return as part of a hit. If no fields are specified,
no stored fields are included in the response. If this field is specified, the _source
parameter defaults to false. You can pass _source: true to return both source fields
and stored fields in the search response. + /// + /// List of stored fields to return as part of a hit. If no fields are specified, + /// no stored fields are included in the response. If this field is specified, the _source + /// parameter defaults to false. You can pass _source: true to return both source fields + /// and stored fields in the search response. + /// /// public Elastic.Clients.Elasticsearch.Fields? StoredFields { get; set; } public Elastic.Clients.Elasticsearch.Core.Search.Suggester? Suggest { get; set; } /// - /// Maximum number of documents to collect for each shard. If a query reaches this
limit, Elasticsearch terminates the query early. Elasticsearch collects documents
before sorting. Defaults to 0, which does not terminate query execution early. + /// + /// Maximum number of documents to collect for each shard. If a query reaches this + /// limit, Elasticsearch terminates the query early. Elasticsearch collects documents + /// before sorting. Defaults to 0, which does not terminate query execution early. + /// /// public long? TerminateAfter { get; set; } /// - /// Specifies the period of time to wait for a response from each shard. If no response
is received before the timeout expires, the request fails and returns an error.
Defaults to no timeout. + /// + /// Specifies the period of time to wait for a response from each shard. If no response + /// is received before the timeout expires, the request fails and returns an error. + /// Defaults to no timeout. + /// /// public string? Timeout { get; set; } /// - /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// + /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// /// public bool? TrackScores { get; set; } /// - /// Number of hits matching the query to count accurately. If true, the exact
number of hits is returned at the cost of some performance. If false, the
response does not include the total number of hits matching the query.
Defaults to 10,000 hits. + /// + /// Number of hits matching the query to count accurately. If true, the exact + /// number of hits is returned at the cost of some performance. If false, the + /// response does not include the total number of hits matching the query. + /// Defaults to 10,000 hits. + /// /// public Elastic.Clients.Elasticsearch.Core.Search.TrackHits? TrackTotalHits { get; set; } /// - /// If true, returns document version as part of a hit. + /// + /// If true, returns document version as part of a hit. + /// /// public bool? Version { get; set; } } @@ -645,7 +712,10 @@ public MultisearchBodyDescriptor Collapse(Action - /// Array of wildcard (*) patterns. The request returns doc values for field
names matching these patterns in the hits.fields property of the response. + /// + /// Array of wildcard (*) patterns. The request returns doc values for field + /// names matching these patterns in the hits.fields property of the response. + /// /// public MultisearchBodyDescriptor DocvalueFields(ICollection? docvalueFields) { @@ -684,7 +754,9 @@ public MultisearchBodyDescriptor DocvalueFields(params Action - /// If true, returns detailed information about score computation as part of a hit. + /// + /// If true, returns detailed information about score computation as part of a hit. + /// /// public MultisearchBodyDescriptor Explain(bool? explain = true) { @@ -693,7 +765,9 @@ public MultisearchBodyDescriptor Explain(bool? explain = true) } /// - /// Configuration of search extensions defined by Elasticsearch plugins. + /// + /// Configuration of search extensions defined by Elasticsearch plugins. + /// /// public MultisearchBodyDescriptor Ext(Func, FluentDictionary> selector) { @@ -702,7 +776,10 @@ public MultisearchBodyDescriptor Ext(Func - /// Array of wildcard (*) patterns. The request returns values for field names
matching these patterns in the hits.fields property of the response. + /// + /// Array of wildcard (*) patterns. The request returns values for field names + /// matching these patterns in the hits.fields property of the response. + /// /// public MultisearchBodyDescriptor Fields(ICollection? fields) { @@ -741,7 +818,11 @@ public MultisearchBodyDescriptor Fields(params Action - /// Starting document offset. By default, you cannot page through more than 10,000
hits using the from and size parameters. To page through more hits, use the
search_after parameter. + /// + /// Starting document offset. By default, you cannot page through more than 10,000 + /// hits using the from and size parameters. To page through more hits, use the + /// search_after parameter. + /// /// public MultisearchBodyDescriptor From(int? from) { @@ -774,7 +855,9 @@ public MultisearchBodyDescriptor Highlight(Action - /// Boosts the _score of documents from specified indices. + /// + /// Boosts the _score of documents from specified indices. + /// /// public MultisearchBodyDescriptor IndicesBoost(ICollection>? indicesBoost) { @@ -783,7 +866,9 @@ public MultisearchBodyDescriptor IndicesBoost(ICollection - /// Defines the approximate kNN search to run. + /// + /// Defines the approximate kNN search to run. + /// /// public MultisearchBodyDescriptor Knn(ICollection? knn) { @@ -822,7 +907,10 @@ public MultisearchBodyDescriptor Knn(params Action - /// Minimum _score for matching documents. Documents with a lower _score are
not included in the search results. + /// + /// Minimum _score for matching documents. Documents with a lower _score are + /// not included in the search results. + /// /// public MultisearchBodyDescriptor MinScore(double? minScore) { @@ -831,7 +919,10 @@ public MultisearchBodyDescriptor MinScore(double? minScore) } /// - /// Limits the search to a point in time (PIT). If you provide a PIT, you
cannot specify an in the request path. + /// + /// Limits the search to a point in time (PIT). If you provide a PIT, you + /// cannot specify an <index> in the request path. + /// /// public MultisearchBodyDescriptor Pit(Elastic.Clients.Elasticsearch.Core.Search.PointInTimeReference? pit) { @@ -888,7 +979,9 @@ public MultisearchBodyDescriptor Profile(bool? profile = true) } /// - /// Defines the search definition using the Query DSL. + /// + /// Defines the search definition using the Query DSL. + /// /// public MultisearchBodyDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -951,7 +1044,10 @@ public MultisearchBodyDescriptor Rescore(params Action - /// Defines one or more runtime fields in the search request. These fields take
precedence over mapped fields with the same name. + /// + /// Defines one or more runtime fields in the search request. These fields take + /// precedence over mapped fields with the same name. + /// /// public MultisearchBodyDescriptor RuntimeMappings(Func>, FluentDescriptorDictionary>> selector) { @@ -960,7 +1056,9 @@ public MultisearchBodyDescriptor RuntimeMappings(Func - /// Retrieve a script evaluation (based on different fields) for each hit. + /// + /// Retrieve a script evaluation (based on different fields) for each hit. + /// /// public MultisearchBodyDescriptor ScriptFields(Func, FluentDescriptorDictionary> selector) { @@ -975,7 +1073,10 @@ public MultisearchBodyDescriptor SearchAfter(ICollection - /// If true, returns sequence number and primary term of the last modification
of each hit. See Optimistic concurrency control. + /// + /// If true, returns sequence number and primary term of the last modification + /// of each hit. See Optimistic concurrency control. + /// /// public MultisearchBodyDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = true) { @@ -984,7 +1085,11 @@ public MultisearchBodyDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryT } /// - /// The number of hits to return. By default, you cannot page through more
than 10,000 hits using the from and size parameters. To page through more
hits, use the search_after parameter. + /// + /// The number of hits to return. By default, you cannot page through more + /// than 10,000 hits using the from and size parameters. To page through more + /// hits, use the search_after parameter. + /// /// public MultisearchBodyDescriptor Size(int? size) { @@ -1029,7 +1134,10 @@ public MultisearchBodyDescriptor Sort(params Action - /// Indicates which source fields are returned for matching documents. These
fields are returned in the hits._source property of the search response. + /// + /// Indicates which source fields are returned for matching documents. These + /// fields are returned in the hits._source property of the search response. + /// /// public MultisearchBodyDescriptor Source(Elastic.Clients.Elasticsearch.Core.Search.SourceConfig? source) { @@ -1038,7 +1146,11 @@ public MultisearchBodyDescriptor Source(Elastic.Clients.Elasticsearch } /// - /// Stats groups to associate with the search. Each group maintains a statistics
aggregation for its associated searches. You can retrieve these stats using
the indices stats API. + /// + /// Stats groups to associate with the search. Each group maintains a statistics + /// aggregation for its associated searches. You can retrieve these stats using + /// the indices stats API. + /// /// public MultisearchBodyDescriptor Stats(ICollection? stats) { @@ -1047,7 +1159,12 @@ public MultisearchBodyDescriptor Stats(ICollection? stats) } /// - /// List of stored fields to return as part of a hit. If no fields are specified,
no stored fields are included in the response. If this field is specified, the _source
parameter defaults to false. You can pass _source: true to return both source fields
and stored fields in the search response. + /// + /// List of stored fields to return as part of a hit. If no fields are specified, + /// no stored fields are included in the response. If this field is specified, the _source + /// parameter defaults to false. You can pass _source: true to return both source fields + /// and stored fields in the search response. + /// /// public MultisearchBodyDescriptor StoredFields(Elastic.Clients.Elasticsearch.Fields? storedFields) { @@ -1080,7 +1197,11 @@ public MultisearchBodyDescriptor Suggest(Action - /// Maximum number of documents to collect for each shard. If a query reaches this
limit, Elasticsearch terminates the query early. Elasticsearch collects documents
before sorting. Defaults to 0, which does not terminate query execution early. + /// + /// Maximum number of documents to collect for each shard. If a query reaches this + /// limit, Elasticsearch terminates the query early. Elasticsearch collects documents + /// before sorting. Defaults to 0, which does not terminate query execution early. + /// /// public MultisearchBodyDescriptor TerminateAfter(long? terminateAfter) { @@ -1089,7 +1210,11 @@ public MultisearchBodyDescriptor TerminateAfter(long? terminateAfter) } /// - /// Specifies the period of time to wait for a response from each shard. If no response
is received before the timeout expires, the request fails and returns an error.
Defaults to no timeout. + /// + /// Specifies the period of time to wait for a response from each shard. If no response + /// is received before the timeout expires, the request fails and returns an error. + /// Defaults to no timeout. + /// /// public MultisearchBodyDescriptor Timeout(string? timeout) { @@ -1098,7 +1223,9 @@ public MultisearchBodyDescriptor Timeout(string? timeout) } /// - /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// + /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// /// public MultisearchBodyDescriptor TrackScores(bool? trackScores = true) { @@ -1107,7 +1234,12 @@ public MultisearchBodyDescriptor TrackScores(bool? trackScores = true } /// - /// Number of hits matching the query to count accurately. If true, the exact
number of hits is returned at the cost of some performance. If false, the
response does not include the total number of hits matching the query.
Defaults to 10,000 hits. + /// + /// Number of hits matching the query to count accurately. If true, the exact + /// number of hits is returned at the cost of some performance. If false, the + /// response does not include the total number of hits matching the query. + /// Defaults to 10,000 hits. + /// /// public MultisearchBodyDescriptor TrackTotalHits(Elastic.Clients.Elasticsearch.Core.Search.TrackHits? trackTotalHits) { @@ -1116,7 +1248,9 @@ public MultisearchBodyDescriptor TrackTotalHits(Elastic.Clients.Elast } /// - /// If true, returns document version as part of a hit. + /// + /// If true, returns document version as part of a hit. + /// /// public MultisearchBodyDescriptor Version(bool? version = true) { @@ -1594,7 +1728,10 @@ public MultisearchBodyDescriptor Collapse(Action - /// Array of wildcard (*) patterns. The request returns doc values for field
names matching these patterns in the hits.fields property of the response. + /// + /// Array of wildcard (*) patterns. The request returns doc values for field + /// names matching these patterns in the hits.fields property of the response. + /// /// public MultisearchBodyDescriptor DocvalueFields(ICollection? docvalueFields) { @@ -1633,7 +1770,9 @@ public MultisearchBodyDescriptor DocvalueFields(params Action - /// If true, returns detailed information about score computation as part of a hit. + /// + /// If true, returns detailed information about score computation as part of a hit. + /// /// public MultisearchBodyDescriptor Explain(bool? explain = true) { @@ -1642,7 +1781,9 @@ public MultisearchBodyDescriptor Explain(bool? explain = true) } /// - /// Configuration of search extensions defined by Elasticsearch plugins. + /// + /// Configuration of search extensions defined by Elasticsearch plugins. + /// /// public MultisearchBodyDescriptor Ext(Func, FluentDictionary> selector) { @@ -1651,7 +1792,10 @@ public MultisearchBodyDescriptor Ext(Func, Flue } /// - /// Array of wildcard (*) patterns. The request returns values for field names
matching these patterns in the hits.fields property of the response. + /// + /// Array of wildcard (*) patterns. The request returns values for field names + /// matching these patterns in the hits.fields property of the response. + /// /// public MultisearchBodyDescriptor Fields(ICollection? fields) { @@ -1690,7 +1834,11 @@ public MultisearchBodyDescriptor Fields(params Action - /// Starting document offset. By default, you cannot page through more than 10,000
hits using the from and size parameters. To page through more hits, use the
search_after parameter. + /// + /// Starting document offset. By default, you cannot page through more than 10,000 + /// hits using the from and size parameters. To page through more hits, use the + /// search_after parameter. + /// /// public MultisearchBodyDescriptor From(int? from) { @@ -1723,7 +1871,9 @@ public MultisearchBodyDescriptor Highlight(Action - /// Boosts the _score of documents from specified indices. + /// + /// Boosts the _score of documents from specified indices. + /// /// public MultisearchBodyDescriptor IndicesBoost(ICollection>? indicesBoost) { @@ -1732,7 +1882,9 @@ public MultisearchBodyDescriptor IndicesBoost(ICollection - /// Defines the approximate kNN search to run. + /// + /// Defines the approximate kNN search to run. + /// /// public MultisearchBodyDescriptor Knn(ICollection? knn) { @@ -1771,7 +1923,10 @@ public MultisearchBodyDescriptor Knn(params Action - /// Minimum _score for matching documents. Documents with a lower _score are
not included in the search results. + /// + /// Minimum _score for matching documents. Documents with a lower _score are + /// not included in the search results. + /// /// public MultisearchBodyDescriptor MinScore(double? minScore) { @@ -1780,7 +1935,10 @@ public MultisearchBodyDescriptor MinScore(double? minScore) } /// - /// Limits the search to a point in time (PIT). If you provide a PIT, you
cannot specify an in the request path. + /// + /// Limits the search to a point in time (PIT). If you provide a PIT, you + /// cannot specify an <index> in the request path. + /// /// public MultisearchBodyDescriptor Pit(Elastic.Clients.Elasticsearch.Core.Search.PointInTimeReference? pit) { @@ -1837,7 +1995,9 @@ public MultisearchBodyDescriptor Profile(bool? profile = true) } /// - /// Defines the search definition using the Query DSL. + /// + /// Defines the search definition using the Query DSL. + /// /// public MultisearchBodyDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -1900,7 +2060,10 @@ public MultisearchBodyDescriptor Rescore(params Action - /// Defines one or more runtime fields in the search request. These fields take
precedence over mapped fields with the same name. + /// + /// Defines one or more runtime fields in the search request. These fields take + /// precedence over mapped fields with the same name. + /// /// public MultisearchBodyDescriptor RuntimeMappings(Func, FluentDescriptorDictionary> selector) { @@ -1909,7 +2072,9 @@ public MultisearchBodyDescriptor RuntimeMappings(Func - /// Retrieve a script evaluation (based on different fields) for each hit. + /// + /// Retrieve a script evaluation (based on different fields) for each hit. + /// /// public MultisearchBodyDescriptor ScriptFields(Func, FluentDescriptorDictionary> selector) { @@ -1924,7 +2089,10 @@ public MultisearchBodyDescriptor SearchAfter(ICollection - /// If true, returns sequence number and primary term of the last modification
of each hit. See Optimistic concurrency control. + /// + /// If true, returns sequence number and primary term of the last modification + /// of each hit. See Optimistic concurrency control. + /// /// public MultisearchBodyDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = true) { @@ -1933,7 +2101,11 @@ public MultisearchBodyDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = true) } /// - /// The number of hits to return. By default, you cannot page through more
than 10,000 hits using the from and size parameters. To page through more
hits, use the search_after parameter. + /// + /// The number of hits to return. By default, you cannot page through more + /// than 10,000 hits using the from and size parameters. To page through more + /// hits, use the search_after parameter. + /// /// public MultisearchBodyDescriptor Size(int? size) { @@ -1978,7 +2150,10 @@ public MultisearchBodyDescriptor Sort(params Action - /// Indicates which source fields are returned for matching documents. These
fields are returned in the hits._source property of the search response. + /// + /// Indicates which source fields are returned for matching documents. These + /// fields are returned in the hits._source property of the search response. + /// /// public MultisearchBodyDescriptor Source(Elastic.Clients.Elasticsearch.Core.Search.SourceConfig? source) { @@ -1987,7 +2162,11 @@ public MultisearchBodyDescriptor Source(Elastic.Clients.Elasticsearch.Core.Searc } /// - /// Stats groups to associate with the search. Each group maintains a statistics
aggregation for its associated searches. You can retrieve these stats using
the indices stats API. + /// + /// Stats groups to associate with the search. Each group maintains a statistics + /// aggregation for its associated searches. You can retrieve these stats using + /// the indices stats API. + /// /// public MultisearchBodyDescriptor Stats(ICollection? stats) { @@ -1996,7 +2175,12 @@ public MultisearchBodyDescriptor Stats(ICollection? stats) } /// - /// List of stored fields to return as part of a hit. If no fields are specified,
no stored fields are included in the response. If this field is specified, the _source
parameter defaults to false. You can pass _source: true to return both source fields
and stored fields in the search response. + /// + /// List of stored fields to return as part of a hit. If no fields are specified, + /// no stored fields are included in the response. If this field is specified, the _source + /// parameter defaults to false. You can pass _source: true to return both source fields + /// and stored fields in the search response. + /// /// public MultisearchBodyDescriptor StoredFields(Elastic.Clients.Elasticsearch.Fields? storedFields) { @@ -2029,7 +2213,11 @@ public MultisearchBodyDescriptor Suggest(Action - /// Maximum number of documents to collect for each shard. If a query reaches this
limit, Elasticsearch terminates the query early. Elasticsearch collects documents
before sorting. Defaults to 0, which does not terminate query execution early. + /// + /// Maximum number of documents to collect for each shard. If a query reaches this + /// limit, Elasticsearch terminates the query early. Elasticsearch collects documents + /// before sorting. Defaults to 0, which does not terminate query execution early. + /// /// public MultisearchBodyDescriptor TerminateAfter(long? terminateAfter) { @@ -2038,7 +2226,11 @@ public MultisearchBodyDescriptor TerminateAfter(long? terminateAfter) } /// - /// Specifies the period of time to wait for a response from each shard. If no response
is received before the timeout expires, the request fails and returns an error.
Defaults to no timeout. + /// + /// Specifies the period of time to wait for a response from each shard. If no response + /// is received before the timeout expires, the request fails and returns an error. + /// Defaults to no timeout. + /// /// public MultisearchBodyDescriptor Timeout(string? timeout) { @@ -2047,7 +2239,9 @@ public MultisearchBodyDescriptor Timeout(string? timeout) } /// - /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// + /// If true, calculate and return document scores, even if the scores are not used for sorting. + /// /// public MultisearchBodyDescriptor TrackScores(bool? trackScores = true) { @@ -2056,7 +2250,12 @@ public MultisearchBodyDescriptor TrackScores(bool? trackScores = true) } /// - /// Number of hits matching the query to count accurately. If true, the exact
number of hits is returned at the cost of some performance. If false, the
response does not include the total number of hits matching the query.
Defaults to 10,000 hits. + /// + /// Number of hits matching the query to count accurately. If true, the exact + /// number of hits is returned at the cost of some performance. If false, the + /// response does not include the total number of hits matching the query. + /// Defaults to 10,000 hits. + /// /// public MultisearchBodyDescriptor TrackTotalHits(Elastic.Clients.Elasticsearch.Core.Search.TrackHits? trackTotalHits) { @@ -2065,7 +2264,9 @@ public MultisearchBodyDescriptor TrackTotalHits(Elastic.Clients.Elasticsearch.Co } /// - /// If true, returns document version as part of a hit. + /// + /// If true, returns document version as part of a hit. + /// /// public MultisearchBodyDescriptor Version(bool? version = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/MSearch/MultisearchHeader.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/MSearch/MultisearchHeader.g.cs index 07fb9e14616..c9ff671b68d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/MSearch/MultisearchHeader.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/MSearch/MultisearchHeader.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.Core.MSearch; /// -/// Contains parameters used to limit or change the subsequent search body request. +/// +/// Contains parameters used to limit or change the subsequent search body request. +/// /// public sealed partial class MultisearchHeader { @@ -58,7 +60,9 @@ public sealed partial class MultisearchHeader } /// -/// Contains parameters used to limit or change the subsequent search body request. +/// +/// Contains parameters used to limit or change the subsequent search body request. +/// /// public sealed partial class MultisearchHeaderDescriptor : SerializableDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/MSearchTemplate/TemplateConfig.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/MSearchTemplate/TemplateConfig.g.cs index 32dc96175e2..c9586c9b995 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/MSearchTemplate/TemplateConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/MSearchTemplate/TemplateConfig.g.cs @@ -30,31 +30,46 @@ namespace Elastic.Clients.Elasticsearch.Core.MSearchTemplate; public sealed partial class TemplateConfig { /// - /// If `true`, returns detailed information about score calculation as part of each hit. + /// + /// If true, returns detailed information about score calculation as part of each hit. + /// /// [JsonInclude, JsonPropertyName("explain")] public bool? Explain { get; init; } /// - /// ID of the search template to use. If no source is specified,
this parameter is required. + /// + /// ID of the search template to use. If no source is specified, + /// this parameter is required. + /// /// [JsonInclude, JsonPropertyName("id")] public Elastic.Clients.Elasticsearch.Id? Id { get; init; } /// - /// Key-value pairs used to replace Mustache variables in the template.
The key is the variable name.
The value is the variable value. + /// + /// Key-value pairs used to replace Mustache variables in the template. + /// The key is the variable name. + /// The value is the variable value. + /// /// [JsonInclude, JsonPropertyName("params")] public IReadOnlyDictionary? Params { get; init; } /// - /// If `true`, the query execution is profiled. + /// + /// If true, the query execution is profiled. + /// /// [JsonInclude, JsonPropertyName("profile")] public bool? Profile { get; init; } /// - /// An inline search template. Supports the same parameters as the search API's
request body. Also supports Mustache variables. If no id is specified, this
parameter is required. + /// + /// An inline search template. Supports the same parameters as the search API's + /// request body. Also supports Mustache variables. If no id is specified, this + /// parameter is required. + /// /// [JsonInclude, JsonPropertyName("source")] public string? Source { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Mtermvectors/MultiTermVectorsOperation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Mtermvectors/MultiTermVectorsOperation.g.cs index c6032c1bf9a..a21f16a7f7d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Mtermvectors/MultiTermVectorsOperation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Mtermvectors/MultiTermVectorsOperation.g.cs @@ -30,80 +30,107 @@ namespace Elastic.Clients.Elasticsearch.Core.Mtermvectors; public sealed partial class MultiTermVectorsOperation { /// - /// An artificial document (a document not present in the index) for which you want to retrieve term vectors. + /// + /// An artificial document (a document not present in the index) for which you want to retrieve term vectors. + /// /// [JsonInclude, JsonPropertyName("doc")] public object? Doc { get; set; } /// - /// Comma-separated list or wildcard expressions of fields to include in the statistics.
Used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. + /// + /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// Used as the default list unless a specific field list is provided in the completion_fields or fielddata_fields parameters. + /// /// [JsonInclude, JsonPropertyName("fields")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] public Elastic.Clients.Elasticsearch.Fields? Fields { get; set; } /// - /// If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + /// + /// If true, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + /// /// [JsonInclude, JsonPropertyName("field_statistics")] public bool? FieldStatistics { get; set; } /// - /// Filter terms based on their tf-idf scores. + /// + /// Filter terms based on their tf-idf scores. + /// /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.Core.TermVectors.Filter? Filter { get; set; } /// - /// The ID of the document. + /// + /// The ID of the document. + /// /// [JsonInclude, JsonPropertyName("_id")] public Elastic.Clients.Elasticsearch.Id? Id { get; set; } /// - /// The index of the document. + /// + /// The index of the document. + /// /// [JsonInclude, JsonPropertyName("_index")] public Elastic.Clients.Elasticsearch.IndexName? Index { get; set; } /// - /// If `true`, the response includes term offsets. + /// + /// If true, the response includes term offsets. + /// /// [JsonInclude, JsonPropertyName("offsets")] public bool? Offsets { get; set; } /// - /// If `true`, the response includes term payloads. + /// + /// If true, the response includes term payloads. + /// /// [JsonInclude, JsonPropertyName("payloads")] public bool? Payloads { get; set; } /// - /// If `true`, the response includes term positions. + /// + /// If true, the response includes term positions. + /// /// [JsonInclude, JsonPropertyName("positions")] public bool? Positions { get; set; } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// [JsonInclude, JsonPropertyName("routing")] public Elastic.Clients.Elasticsearch.Routing? Routing { get; set; } /// - /// If true, the response includes term frequency and document frequency. + /// + /// If true, the response includes term frequency and document frequency. + /// /// [JsonInclude, JsonPropertyName("term_statistics")] public bool? TermStatistics { get; set; } /// - /// If `true`, returns the document version as part of a hit. + /// + /// If true, returns the document version as part of a hit. + /// /// [JsonInclude, JsonPropertyName("version")] public long? Version { get; set; } /// - /// Specific version type. + /// + /// Specific version type. + /// /// [JsonInclude, JsonPropertyName("version_type")] public Elastic.Clients.Elasticsearch.VersionType? VersionType { get; set; } @@ -134,7 +161,9 @@ public MultiTermVectorsOperationDescriptor() : base() private Elastic.Clients.Elasticsearch.VersionType? VersionTypeValue { get; set; } /// - /// An artificial document (a document not present in the index) for which you want to retrieve term vectors. + /// + /// An artificial document (a document not present in the index) for which you want to retrieve term vectors. + /// /// public MultiTermVectorsOperationDescriptor Doc(object? doc) { @@ -143,7 +172,10 @@ public MultiTermVectorsOperationDescriptor Doc(object? doc) } /// - /// Comma-separated list or wildcard expressions of fields to include in the statistics.
Used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. + /// + /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// Used as the default list unless a specific field list is provided in the completion_fields or fielddata_fields parameters. + /// /// public MultiTermVectorsOperationDescriptor Fields(Elastic.Clients.Elasticsearch.Fields? fields) { @@ -152,7 +184,9 @@ public MultiTermVectorsOperationDescriptor Fields(Elastic.Clients.Ela } /// - /// If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + /// + /// If true, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + /// /// public MultiTermVectorsOperationDescriptor FieldStatistics(bool? fieldStatistics = true) { @@ -161,7 +195,9 @@ public MultiTermVectorsOperationDescriptor FieldStatistics(bool? fiel } /// - /// Filter terms based on their tf-idf scores. + /// + /// Filter terms based on their tf-idf scores. + /// /// public MultiTermVectorsOperationDescriptor Filter(Elastic.Clients.Elasticsearch.Core.TermVectors.Filter? filter) { @@ -188,7 +224,9 @@ public MultiTermVectorsOperationDescriptor Filter(Action - /// The ID of the document. + /// + /// The ID of the document. + /// /// public MultiTermVectorsOperationDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) { @@ -197,7 +235,9 @@ public MultiTermVectorsOperationDescriptor Id(Elastic.Clients.Elastic } /// - /// The index of the document. + /// + /// The index of the document. + /// /// public MultiTermVectorsOperationDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? index) { @@ -206,7 +246,9 @@ public MultiTermVectorsOperationDescriptor Index(Elastic.Clients.Elas } /// - /// If `true`, the response includes term offsets. + /// + /// If true, the response includes term offsets. + /// /// public MultiTermVectorsOperationDescriptor Offsets(bool? offsets = true) { @@ -215,7 +257,9 @@ public MultiTermVectorsOperationDescriptor Offsets(bool? offsets = tr } /// - /// If `true`, the response includes term payloads. + /// + /// If true, the response includes term payloads. + /// /// public MultiTermVectorsOperationDescriptor Payloads(bool? payloads = true) { @@ -224,7 +268,9 @@ public MultiTermVectorsOperationDescriptor Payloads(bool? payloads = } /// - /// If `true`, the response includes term positions. + /// + /// If true, the response includes term positions. + /// /// public MultiTermVectorsOperationDescriptor Positions(bool? positions = true) { @@ -233,7 +279,9 @@ public MultiTermVectorsOperationDescriptor Positions(bool? positions } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public MultiTermVectorsOperationDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? routing) { @@ -242,7 +290,9 @@ public MultiTermVectorsOperationDescriptor Routing(Elastic.Clients.El } /// - /// If true, the response includes term frequency and document frequency. + /// + /// If true, the response includes term frequency and document frequency. + /// /// public MultiTermVectorsOperationDescriptor TermStatistics(bool? termStatistics = true) { @@ -251,7 +301,9 @@ public MultiTermVectorsOperationDescriptor TermStatistics(bool? termS } /// - /// If `true`, returns the document version as part of a hit. + /// + /// If true, returns the document version as part of a hit. + /// /// public MultiTermVectorsOperationDescriptor Version(long? version) { @@ -260,7 +312,9 @@ public MultiTermVectorsOperationDescriptor Version(long? version) } /// - /// Specific version type. + /// + /// Specific version type. + /// /// public MultiTermVectorsOperationDescriptor VersionType(Elastic.Clients.Elasticsearch.VersionType? versionType) { @@ -388,7 +442,9 @@ public MultiTermVectorsOperationDescriptor() : base() private Elastic.Clients.Elasticsearch.VersionType? VersionTypeValue { get; set; } /// - /// An artificial document (a document not present in the index) for which you want to retrieve term vectors. + /// + /// An artificial document (a document not present in the index) for which you want to retrieve term vectors. + /// /// public MultiTermVectorsOperationDescriptor Doc(object? doc) { @@ -397,7 +453,10 @@ public MultiTermVectorsOperationDescriptor Doc(object? doc) } /// - /// Comma-separated list or wildcard expressions of fields to include in the statistics.
Used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. + /// + /// Comma-separated list or wildcard expressions of fields to include in the statistics. + /// Used as the default list unless a specific field list is provided in the completion_fields or fielddata_fields parameters. + /// /// public MultiTermVectorsOperationDescriptor Fields(Elastic.Clients.Elasticsearch.Fields? fields) { @@ -406,7 +465,9 @@ public MultiTermVectorsOperationDescriptor Fields(Elastic.Clients.Elasticsearch. } /// - /// If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + /// + /// If true, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + /// /// public MultiTermVectorsOperationDescriptor FieldStatistics(bool? fieldStatistics = true) { @@ -415,7 +476,9 @@ public MultiTermVectorsOperationDescriptor FieldStatistics(bool? fieldStatistics } /// - /// Filter terms based on their tf-idf scores. + /// + /// Filter terms based on their tf-idf scores. + /// /// public MultiTermVectorsOperationDescriptor Filter(Elastic.Clients.Elasticsearch.Core.TermVectors.Filter? filter) { @@ -442,7 +505,9 @@ public MultiTermVectorsOperationDescriptor Filter(Action - /// The ID of the document. + /// + /// The ID of the document. + /// /// public MultiTermVectorsOperationDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) { @@ -451,7 +516,9 @@ public MultiTermVectorsOperationDescriptor Id(Elastic.Clients.Elasticsearch.Id? } /// - /// The index of the document. + /// + /// The index of the document. + /// /// public MultiTermVectorsOperationDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? index) { @@ -460,7 +527,9 @@ public MultiTermVectorsOperationDescriptor Index(Elastic.Clients.Elasticsearch.I } /// - /// If `true`, the response includes term offsets. + /// + /// If true, the response includes term offsets. + /// /// public MultiTermVectorsOperationDescriptor Offsets(bool? offsets = true) { @@ -469,7 +538,9 @@ public MultiTermVectorsOperationDescriptor Offsets(bool? offsets = true) } /// - /// If `true`, the response includes term payloads. + /// + /// If true, the response includes term payloads. + /// /// public MultiTermVectorsOperationDescriptor Payloads(bool? payloads = true) { @@ -478,7 +549,9 @@ public MultiTermVectorsOperationDescriptor Payloads(bool? payloads = true) } /// - /// If `true`, the response includes term positions. + /// + /// If true, the response includes term positions. + /// /// public MultiTermVectorsOperationDescriptor Positions(bool? positions = true) { @@ -487,7 +560,9 @@ public MultiTermVectorsOperationDescriptor Positions(bool? positions = true) } /// - /// Custom value used to route operations to a specific shard. + /// + /// Custom value used to route operations to a specific shard. + /// /// public MultiTermVectorsOperationDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? routing) { @@ -496,7 +571,9 @@ public MultiTermVectorsOperationDescriptor Routing(Elastic.Clients.Elasticsearch } /// - /// If true, the response includes term frequency and document frequency. + /// + /// If true, the response includes term frequency and document frequency. + /// /// public MultiTermVectorsOperationDescriptor TermStatistics(bool? termStatistics = true) { @@ -505,7 +582,9 @@ public MultiTermVectorsOperationDescriptor TermStatistics(bool? termStatistics = } /// - /// If `true`, returns the document version as part of a hit. + /// + /// If true, returns the document version as part of a hit. + /// /// public MultiTermVectorsOperationDescriptor Version(long? version) { @@ -514,7 +593,9 @@ public MultiTermVectorsOperationDescriptor Version(long? version) } /// - /// Specific version type. + /// + /// Specific version type. + /// /// public MultiTermVectorsOperationDescriptor VersionType(Elastic.Clients.Elasticsearch.VersionType? versionType) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/DocumentRating.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/DocumentRating.g.cs index fe2eb5a7d45..02090ba79cd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/DocumentRating.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/DocumentRating.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Core.RankEval; public sealed partial class DocumentRating { /// - /// The document ID. + /// + /// The document ID. + /// /// [JsonInclude, JsonPropertyName("_id")] public Elastic.Clients.Elasticsearch.Id Id { get; set; } /// - /// The document’s index. For data streams, this should be the document’s backing index. + /// + /// The document’s index. For data streams, this should be the document’s backing index. + /// /// [JsonInclude, JsonPropertyName("_index")] public Elastic.Clients.Elasticsearch.IndexName Index { get; set; } /// - /// The document’s relevance with regard to this search request. + /// + /// The document’s relevance with regard to this search request. + /// /// [JsonInclude, JsonPropertyName("rating")] public int Rating { get; set; } @@ -61,7 +67,9 @@ public DocumentRatingDescriptor() : base() private int RatingValue { get; set; } /// - /// The document ID. + /// + /// The document ID. + /// /// public DocumentRatingDescriptor Id(Elastic.Clients.Elasticsearch.Id id) { @@ -70,7 +78,9 @@ public DocumentRatingDescriptor Id(Elastic.Clients.Elasticsearch.Id id) } /// - /// The document’s index. For data streams, this should be the document’s backing index. + /// + /// The document’s index. For data streams, this should be the document’s backing index. + /// /// public DocumentRatingDescriptor Index(Elastic.Clients.Elasticsearch.IndexName index) { @@ -79,7 +89,9 @@ public DocumentRatingDescriptor Index(Elastic.Clients.Elasticsearch.IndexName in } /// - /// The document’s relevance with regard to this search request. + /// + /// The document’s relevance with regard to this search request. + /// /// public DocumentRatingDescriptor Rating(int rating) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricDetail.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricDetail.g.cs index 37891769118..6e45be39364 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricDetail.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricDetail.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.Core.RankEval; public sealed partial class RankEvalMetricDetail { /// - /// The hits section shows a grouping of the search results with their supplied ratings + /// + /// The hits section shows a grouping of the search results with their supplied ratings + /// /// [JsonInclude, JsonPropertyName("hits")] public IReadOnlyCollection Hits { get; init; } /// - /// The metric_details give additional information about the calculated quality metric (e.g. how many of the retrieved documents were relevant). The content varies for each metric but allows for better interpretation of the results + /// + /// The metric_details give additional information about the calculated quality metric (e.g. how many of the retrieved documents were relevant). The content varies for each metric but allows for better interpretation of the results + /// /// [JsonInclude, JsonPropertyName("metric_details")] public IReadOnlyDictionary> MetricDetails { get; init; } /// - /// The metric_score in the details section shows the contribution of this query to the global quality metric score + /// + /// The metric_score in the details section shows the contribution of this query to the global quality metric score + /// /// [JsonInclude, JsonPropertyName("metric_score")] public double MetricScore { get; init; } /// - /// The unrated_docs section contains an _index and _id entry for each document in the search result for this query that didn’t have a ratings value. This can be used to ask the user to supply ratings for these documents + /// + /// The unrated_docs section contains an _index and _id entry for each document in the search result for this query that didn’t have a ratings value. This can be used to ask the user to supply ratings for these documents + /// /// [JsonInclude, JsonPropertyName("unrated_docs")] public IReadOnlyCollection UnratedDocs { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricDiscountedCumulativeGain.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricDiscountedCumulativeGain.g.cs index 088dbd22faf..826d382f757 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricDiscountedCumulativeGain.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricDiscountedCumulativeGain.g.cs @@ -28,26 +28,34 @@ namespace Elastic.Clients.Elasticsearch.Core.RankEval; /// -/// Discounted cumulative gain (DCG) +/// +/// Discounted cumulative gain (DCG) +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricDiscountedCumulativeGain { /// - /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// + /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// /// [JsonInclude, JsonPropertyName("k")] public int? k { get; set; } /// - /// If set to true, this metric will calculate the Normalized DCG. + /// + /// If set to true, this metric will calculate the Normalized DCG. + /// /// [JsonInclude, JsonPropertyName("normalize")] public bool? Normalize { get; set; } } /// -/// Discounted cumulative gain (DCG) +/// +/// Discounted cumulative gain (DCG) +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricDiscountedCumulativeGainDescriptor : SerializableDescriptor @@ -62,7 +70,9 @@ public RankEvalMetricDiscountedCumulativeGainDescriptor() : base() private bool? NormalizeValue { get; set; } /// - /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// + /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// /// public RankEvalMetricDiscountedCumulativeGainDescriptor k(int? k) { @@ -71,7 +81,9 @@ public RankEvalMetricDiscountedCumulativeGainDescriptor k(int? k) } /// - /// If set to true, this metric will calculate the Normalized DCG. + /// + /// If set to true, this metric will calculate the Normalized DCG. + /// /// public RankEvalMetricDiscountedCumulativeGainDescriptor Normalize(bool? normalize = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricExpectedReciprocalRank.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricExpectedReciprocalRank.g.cs index 2e64982ee01..3254a83b773 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricExpectedReciprocalRank.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricExpectedReciprocalRank.g.cs @@ -28,26 +28,34 @@ namespace Elastic.Clients.Elasticsearch.Core.RankEval; /// -/// Expected Reciprocal Rank (ERR) +/// +/// Expected Reciprocal Rank (ERR) +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricExpectedReciprocalRank { /// - /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// + /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// /// [JsonInclude, JsonPropertyName("k")] public int? k { get; set; } /// - /// The highest relevance grade used in the user-supplied relevance judgments. + /// + /// The highest relevance grade used in the user-supplied relevance judgments. + /// /// [JsonInclude, JsonPropertyName("maximum_relevance")] public int MaximumRelevance { get; set; } } /// -/// Expected Reciprocal Rank (ERR) +/// +/// Expected Reciprocal Rank (ERR) +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricExpectedReciprocalRankDescriptor : SerializableDescriptor @@ -62,7 +70,9 @@ public RankEvalMetricExpectedReciprocalRankDescriptor() : base() private int MaximumRelevanceValue { get; set; } /// - /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// + /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// /// public RankEvalMetricExpectedReciprocalRankDescriptor k(int? k) { @@ -71,7 +81,9 @@ public RankEvalMetricExpectedReciprocalRankDescriptor k(int? k) } /// - /// The highest relevance grade used in the user-supplied relevance judgments. + /// + /// The highest relevance grade used in the user-supplied relevance judgments. + /// /// public RankEvalMetricExpectedReciprocalRankDescriptor MaximumRelevance(int maximumRelevance) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricMeanReciprocalRank.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricMeanReciprocalRank.g.cs index a7f9059b224..c4db14312ee 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricMeanReciprocalRank.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricMeanReciprocalRank.g.cs @@ -28,26 +28,34 @@ namespace Elastic.Clients.Elasticsearch.Core.RankEval; /// -/// Mean Reciprocal Rank +/// +/// Mean Reciprocal Rank +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricMeanReciprocalRank { /// - /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// + /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// /// [JsonInclude, JsonPropertyName("k")] public int? k { get; set; } /// - /// Sets the rating threshold above which documents are considered to be "relevant". + /// + /// Sets the rating threshold above which documents are considered to be "relevant". + /// /// [JsonInclude, JsonPropertyName("relevant_rating_threshold")] public int? RelevantRatingThreshold { get; set; } } /// -/// Mean Reciprocal Rank +/// +/// Mean Reciprocal Rank +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricMeanReciprocalRankDescriptor : SerializableDescriptor @@ -62,7 +70,9 @@ public RankEvalMetricMeanReciprocalRankDescriptor() : base() private int? RelevantRatingThresholdValue { get; set; } /// - /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// + /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// /// public RankEvalMetricMeanReciprocalRankDescriptor k(int? k) { @@ -71,7 +81,9 @@ public RankEvalMetricMeanReciprocalRankDescriptor k(int? k) } /// - /// Sets the rating threshold above which documents are considered to be "relevant". + /// + /// Sets the rating threshold above which documents are considered to be "relevant". + /// /// public RankEvalMetricMeanReciprocalRankDescriptor RelevantRatingThreshold(int? relevantRatingThreshold) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricPrecision.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricPrecision.g.cs index 3261416b437..c3e05cf1752 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricPrecision.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricPrecision.g.cs @@ -28,32 +28,42 @@ namespace Elastic.Clients.Elasticsearch.Core.RankEval; /// -/// Precision at K (P@k) +/// +/// Precision at K (P@k) +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricPrecision { /// - /// Controls how unlabeled documents in the search results are counted. If set to true, unlabeled documents are ignored and neither count as relevant or irrelevant. Set to false (the default), they are treated as irrelevant. + /// + /// Controls how unlabeled documents in the search results are counted. If set to true, unlabeled documents are ignored and neither count as relevant or irrelevant. Set to false (the default), they are treated as irrelevant. + /// /// [JsonInclude, JsonPropertyName("ignore_unlabeled")] public bool? IgnoreUnlabeled { get; set; } /// - /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// + /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// /// [JsonInclude, JsonPropertyName("k")] public int? k { get; set; } /// - /// Sets the rating threshold above which documents are considered to be "relevant". + /// + /// Sets the rating threshold above which documents are considered to be "relevant". + /// /// [JsonInclude, JsonPropertyName("relevant_rating_threshold")] public int? RelevantRatingThreshold { get; set; } } /// -/// Precision at K (P@k) +/// +/// Precision at K (P@k) +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricPrecisionDescriptor : SerializableDescriptor @@ -69,7 +79,9 @@ public RankEvalMetricPrecisionDescriptor() : base() private int? RelevantRatingThresholdValue { get; set; } /// - /// Controls how unlabeled documents in the search results are counted. If set to true, unlabeled documents are ignored and neither count as relevant or irrelevant. Set to false (the default), they are treated as irrelevant. + /// + /// Controls how unlabeled documents in the search results are counted. If set to true, unlabeled documents are ignored and neither count as relevant or irrelevant. Set to false (the default), they are treated as irrelevant. + /// /// public RankEvalMetricPrecisionDescriptor IgnoreUnlabeled(bool? ignoreUnlabeled = true) { @@ -78,7 +90,9 @@ public RankEvalMetricPrecisionDescriptor IgnoreUnlabeled(bool? ignoreUnlabeled = } /// - /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// + /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// /// public RankEvalMetricPrecisionDescriptor k(int? k) { @@ -87,7 +101,9 @@ public RankEvalMetricPrecisionDescriptor k(int? k) } /// - /// Sets the rating threshold above which documents are considered to be "relevant". + /// + /// Sets the rating threshold above which documents are considered to be "relevant". + /// /// public RankEvalMetricPrecisionDescriptor RelevantRatingThreshold(int? relevantRatingThreshold) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricRecall.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricRecall.g.cs index 548f0ac7705..9b74ed76b40 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricRecall.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricRecall.g.cs @@ -28,26 +28,34 @@ namespace Elastic.Clients.Elasticsearch.Core.RankEval; /// -/// Recall at K (R@k) +/// +/// Recall at K (R@k) +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricRecall { /// - /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// + /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// /// [JsonInclude, JsonPropertyName("k")] public int? k { get; set; } /// - /// Sets the rating threshold above which documents are considered to be "relevant". + /// + /// Sets the rating threshold above which documents are considered to be "relevant". + /// /// [JsonInclude, JsonPropertyName("relevant_rating_threshold")] public int? RelevantRatingThreshold { get; set; } } /// -/// Recall at K (R@k) +/// +/// Recall at K (R@k) +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricRecallDescriptor : SerializableDescriptor @@ -62,7 +70,9 @@ public RankEvalMetricRecallDescriptor() : base() private int? RelevantRatingThresholdValue { get; set; } /// - /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// + /// Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + /// /// public RankEvalMetricRecallDescriptor k(int? k) { @@ -71,7 +81,9 @@ public RankEvalMetricRecallDescriptor k(int? k) } /// - /// Sets the rating threshold above which documents are considered to be "relevant". + /// + /// Sets the rating threshold above which documents are considered to be "relevant". + /// /// public RankEvalMetricRecallDescriptor RelevantRatingThreshold(int? relevantRatingThreshold) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalRequestItem.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalRequestItem.g.cs index 0ddce6ace19..d84d81c7bdc 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalRequestItem.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalRequestItem.g.cs @@ -30,31 +30,41 @@ namespace Elastic.Clients.Elasticsearch.Core.RankEval; public sealed partial class RankEvalRequestItem { /// - /// The search request’s ID, used to group result details later. + /// + /// The search request’s ID, used to group result details later. + /// /// [JsonInclude, JsonPropertyName("id")] public Elastic.Clients.Elasticsearch.Id Id { get; set; } /// - /// The search template parameters. + /// + /// The search template parameters. + /// /// [JsonInclude, JsonPropertyName("params")] public IDictionary? Params { get; set; } /// - /// List of document ratings + /// + /// List of document ratings + /// /// [JsonInclude, JsonPropertyName("ratings")] public ICollection Ratings { get; set; } /// - /// The query being evaluated. + /// + /// The query being evaluated. + /// /// [JsonInclude, JsonPropertyName("request")] public Elastic.Clients.Elasticsearch.Core.RankEval.RankEvalQuery? Request { get; set; } /// - /// The search template Id + /// + /// The search template Id + /// /// [JsonInclude, JsonPropertyName("template_id")] public Elastic.Clients.Elasticsearch.Id? TemplateId { get; set; } @@ -80,7 +90,9 @@ public RankEvalRequestItemDescriptor() : base() private Elastic.Clients.Elasticsearch.Id? TemplateIdValue { get; set; } /// - /// The search request’s ID, used to group result details later. + /// + /// The search request’s ID, used to group result details later. + /// /// public RankEvalRequestItemDescriptor Id(Elastic.Clients.Elasticsearch.Id id) { @@ -89,7 +101,9 @@ public RankEvalRequestItemDescriptor Id(Elastic.Clients.Elasticsearch } /// - /// The search template parameters. + /// + /// The search template parameters. + /// /// public RankEvalRequestItemDescriptor Params(Func, FluentDictionary> selector) { @@ -98,7 +112,9 @@ public RankEvalRequestItemDescriptor Params(Func - /// List of document ratings + /// + /// List of document ratings + /// /// public RankEvalRequestItemDescriptor Ratings(ICollection ratings) { @@ -137,7 +153,9 @@ public RankEvalRequestItemDescriptor Ratings(params Action - /// The query being evaluated. + /// + /// The query being evaluated. + /// /// public RankEvalRequestItemDescriptor Request(Elastic.Clients.Elasticsearch.Core.RankEval.RankEvalQuery? request) { @@ -164,7 +182,9 @@ public RankEvalRequestItemDescriptor Request(Action - /// The search template Id + /// + /// The search template Id + /// /// public RankEvalRequestItemDescriptor TemplateId(Elastic.Clients.Elasticsearch.Id? templateId) { @@ -260,7 +280,9 @@ public RankEvalRequestItemDescriptor() : base() private Elastic.Clients.Elasticsearch.Id? TemplateIdValue { get; set; } /// - /// The search request’s ID, used to group result details later. + /// + /// The search request’s ID, used to group result details later. + /// /// public RankEvalRequestItemDescriptor Id(Elastic.Clients.Elasticsearch.Id id) { @@ -269,7 +291,9 @@ public RankEvalRequestItemDescriptor Id(Elastic.Clients.Elasticsearch.Id id) } /// - /// The search template parameters. + /// + /// The search template parameters. + /// /// public RankEvalRequestItemDescriptor Params(Func, FluentDictionary> selector) { @@ -278,7 +302,9 @@ public RankEvalRequestItemDescriptor Params(Func - /// List of document ratings + /// + /// List of document ratings + /// /// public RankEvalRequestItemDescriptor Ratings(ICollection ratings) { @@ -317,7 +343,9 @@ public RankEvalRequestItemDescriptor Ratings(params Action - /// The query being evaluated. + /// + /// The query being evaluated. + /// /// public RankEvalRequestItemDescriptor Request(Elastic.Clients.Elasticsearch.Core.RankEval.RankEvalQuery? request) { @@ -344,7 +372,9 @@ public RankEvalRequestItemDescriptor Request(Action - /// The search template Id + /// + /// The search template Id + /// /// public RankEvalRequestItemDescriptor TemplateId(Elastic.Clients.Elasticsearch.Id? templateId) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Reindex/Destination.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Reindex/Destination.g.cs index f6f26050217..c2cec5cccf6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Reindex/Destination.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Reindex/Destination.g.cs @@ -30,31 +30,43 @@ namespace Elastic.Clients.Elasticsearch.Core.Reindex; public sealed partial class Destination { /// - /// The name of the data stream, index, or index alias you are copying to. + /// + /// The name of the data stream, index, or index alias you are copying to. + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.IndexName Index { get; set; } /// - /// Set to `create` to only index documents that do not already exist.
Important: To reindex to a data stream destination, this argument must be `create`. + /// + /// Set to create to only index documents that do not already exist. + /// Important: To reindex to a data stream destination, this argument must be create. + /// /// [JsonInclude, JsonPropertyName("op_type")] public Elastic.Clients.Elasticsearch.OpType? OpType { get; set; } /// - /// The name of the pipeline to use. + /// + /// The name of the pipeline to use. + /// /// [JsonInclude, JsonPropertyName("pipeline")] public string? Pipeline { get; set; } /// - /// By default, a document's routing is preserved unless it’s changed by the script.
Set to `discard` to set routing to `null`, or `=value` to route using the specified `value`. + /// + /// By default, a document's routing is preserved unless it’s changed by the script. + /// Set to discard to set routing to null, or =value to route using the specified value. + /// /// [JsonInclude, JsonPropertyName("routing")] public Elastic.Clients.Elasticsearch.Routing? Routing { get; set; } /// - /// The versioning to use for the indexing operation. + /// + /// The versioning to use for the indexing operation. + /// /// [JsonInclude, JsonPropertyName("version_type")] public Elastic.Clients.Elasticsearch.VersionType? VersionType { get; set; } @@ -75,7 +87,9 @@ public DestinationDescriptor() : base() private Elastic.Clients.Elasticsearch.VersionType? VersionTypeValue { get; set; } /// - /// The name of the data stream, index, or index alias you are copying to. + /// + /// The name of the data stream, index, or index alias you are copying to. + /// /// public DestinationDescriptor Index(Elastic.Clients.Elasticsearch.IndexName index) { @@ -84,7 +98,10 @@ public DestinationDescriptor Index(Elastic.Clients.Elasticsearch.IndexName index } /// - /// Set to `create` to only index documents that do not already exist.
Important: To reindex to a data stream destination, this argument must be `create`. + /// + /// Set to create to only index documents that do not already exist. + /// Important: To reindex to a data stream destination, this argument must be create. + /// /// public DestinationDescriptor OpType(Elastic.Clients.Elasticsearch.OpType? opType) { @@ -93,7 +110,9 @@ public DestinationDescriptor OpType(Elastic.Clients.Elasticsearch.OpType? opType } /// - /// The name of the pipeline to use. + /// + /// The name of the pipeline to use. + /// /// public DestinationDescriptor Pipeline(string? pipeline) { @@ -102,7 +121,10 @@ public DestinationDescriptor Pipeline(string? pipeline) } /// - /// By default, a document's routing is preserved unless it’s changed by the script.
Set to `discard` to set routing to `null`, or `=value` to route using the specified `value`. + /// + /// By default, a document's routing is preserved unless it’s changed by the script. + /// Set to discard to set routing to null, or =value to route using the specified value. + /// /// public DestinationDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? routing) { @@ -111,7 +133,9 @@ public DestinationDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? rout } /// - /// The versioning to use for the indexing operation. + /// + /// The versioning to use for the indexing operation. + /// /// public DestinationDescriptor VersionType(Elastic.Clients.Elasticsearch.VersionType? versionType) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Reindex/RemoteSource.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Reindex/RemoteSource.g.cs index 2e9f3c34a5a..db2b38bbd22 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Reindex/RemoteSource.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Reindex/RemoteSource.g.cs @@ -30,37 +30,50 @@ namespace Elastic.Clients.Elasticsearch.Core.Reindex; public sealed partial class RemoteSource { /// - /// The remote connection timeout.
Defaults to 30 seconds. + /// + /// The remote connection timeout. + /// Defaults to 30 seconds. + /// /// [JsonInclude, JsonPropertyName("connect_timeout")] public Elastic.Clients.Elasticsearch.Duration? ConnectTimeout { get; set; } /// - /// An object containing the headers of the request. + /// + /// An object containing the headers of the request. + /// /// [JsonInclude, JsonPropertyName("headers")] public IDictionary? Headers { get; set; } /// - /// The URL for the remote instance of Elasticsearch that you want to index from. + /// + /// The URL for the remote instance of Elasticsearch that you want to index from. + /// /// [JsonInclude, JsonPropertyName("host")] public string Host { get; set; } /// - /// The password to use for authentication with the remote host. + /// + /// The password to use for authentication with the remote host. + /// /// [JsonInclude, JsonPropertyName("password")] public string? Password { get; set; } /// - /// The remote socket read timeout. Defaults to 30 seconds. + /// + /// The remote socket read timeout. Defaults to 30 seconds. + /// /// [JsonInclude, JsonPropertyName("socket_timeout")] public Elastic.Clients.Elasticsearch.Duration? SocketTimeout { get; set; } /// - /// The username to use for authentication with the remote host. + /// + /// The username to use for authentication with the remote host. + /// /// [JsonInclude, JsonPropertyName("username")] public Elastic.Clients.Elasticsearch.Username? Username { get; set; } @@ -82,7 +95,10 @@ public RemoteSourceDescriptor() : base() private Elastic.Clients.Elasticsearch.Username? UsernameValue { get; set; } /// - /// The remote connection timeout.
Defaults to 30 seconds. + /// + /// The remote connection timeout. + /// Defaults to 30 seconds. + /// /// public RemoteSourceDescriptor ConnectTimeout(Elastic.Clients.Elasticsearch.Duration? connectTimeout) { @@ -91,7 +107,9 @@ public RemoteSourceDescriptor ConnectTimeout(Elastic.Clients.Elasticsearch.Durat } /// - /// An object containing the headers of the request. + /// + /// An object containing the headers of the request. + /// /// public RemoteSourceDescriptor Headers(Func, FluentDictionary> selector) { @@ -100,7 +118,9 @@ public RemoteSourceDescriptor Headers(Func, Flu } /// - /// The URL for the remote instance of Elasticsearch that you want to index from. + /// + /// The URL for the remote instance of Elasticsearch that you want to index from. + /// /// public RemoteSourceDescriptor Host(string host) { @@ -109,7 +129,9 @@ public RemoteSourceDescriptor Host(string host) } /// - /// The password to use for authentication with the remote host. + /// + /// The password to use for authentication with the remote host. + /// /// public RemoteSourceDescriptor Password(string? password) { @@ -118,7 +140,9 @@ public RemoteSourceDescriptor Password(string? password) } /// - /// The remote socket read timeout. Defaults to 30 seconds. + /// + /// The remote socket read timeout. Defaults to 30 seconds. + /// /// public RemoteSourceDescriptor SocketTimeout(Elastic.Clients.Elasticsearch.Duration? socketTimeout) { @@ -127,7 +151,9 @@ public RemoteSourceDescriptor SocketTimeout(Elastic.Clients.Elasticsearch.Durati } /// - /// The username to use for authentication with the remote host. + /// + /// The username to use for authentication with the remote host. + /// /// public RemoteSourceDescriptor Username(Elastic.Clients.Elasticsearch.Username? username) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Reindex/Source.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Reindex/Source.g.cs index 7983b8f970a..0c75aa06abf 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Reindex/Source.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Reindex/Source.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Core.Reindex; public sealed partial class Source { /// - /// The name of the data stream, index, or alias you are copying from.
Accepts a comma-separated list to reindex from multiple sources. + /// + /// The name of the data stream, index, or alias you are copying from. + /// Accepts a comma-separated list to reindex from multiple sources. + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.Indices Indices { get; set; } /// - /// Specifies the documents to reindex using the Query DSL. + /// + /// Specifies the documents to reindex using the Query DSL. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Query { get; set; } /// - /// A remote instance of Elasticsearch that you want to index from. + /// + /// A remote instance of Elasticsearch that you want to index from. + /// /// [JsonInclude, JsonPropertyName("remote")] public Elastic.Clients.Elasticsearch.Core.Reindex.RemoteSource? Remote { get; set; } @@ -50,13 +57,18 @@ public sealed partial class Source public IDictionary? RuntimeMappings { get; set; } /// - /// The number of documents to index per batch.
Use when indexing from remote to ensure that the batches fit within the on-heap buffer, which defaults to a maximum size of 100 MB. + /// + /// The number of documents to index per batch. + /// Use when indexing from remote to ensure that the batches fit within the on-heap buffer, which defaults to a maximum size of 100 MB. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// Slice the reindex request manually using the provided slice ID and total number of slices. + /// + /// Slice the reindex request manually using the provided slice ID and total number of slices. + /// /// [JsonInclude, JsonPropertyName("slice")] public Elastic.Clients.Elasticsearch.SlicedScroll? Slice { get; set; } @@ -65,7 +77,10 @@ public sealed partial class Source public ICollection? Sort { get; set; } /// - /// If `true` reindexes all source fields.
Set to a list to reindex select fields. + /// + /// If true reindexes all source fields. + /// Set to a list to reindex select fields. + /// /// [JsonInclude, JsonPropertyName("_source")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] @@ -99,7 +114,10 @@ public SourceDescriptor() : base() private Elastic.Clients.Elasticsearch.Fields? SourceFieldsValue { get; set; } /// - /// The name of the data stream, index, or alias you are copying from.
Accepts a comma-separated list to reindex from multiple sources. + /// + /// The name of the data stream, index, or alias you are copying from. + /// Accepts a comma-separated list to reindex from multiple sources. + /// /// public SourceDescriptor Indices(Elastic.Clients.Elasticsearch.Indices indices) { @@ -108,7 +126,9 @@ public SourceDescriptor Indices(Elastic.Clients.Elasticsearch.Indices } /// - /// Specifies the documents to reindex using the Query DSL. + /// + /// Specifies the documents to reindex using the Query DSL. + /// /// public SourceDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -135,7 +155,9 @@ public SourceDescriptor Query(Action - /// A remote instance of Elasticsearch that you want to index from. + /// + /// A remote instance of Elasticsearch that you want to index from. + /// /// public SourceDescriptor Remote(Elastic.Clients.Elasticsearch.Core.Reindex.RemoteSource? remote) { @@ -168,7 +190,10 @@ public SourceDescriptor RuntimeMappings(Func - /// The number of documents to index per batch.
Use when indexing from remote to ensure that the batches fit within the on-heap buffer, which defaults to a maximum size of 100 MB. + /// + /// The number of documents to index per batch. + /// Use when indexing from remote to ensure that the batches fit within the on-heap buffer, which defaults to a maximum size of 100 MB. + /// /// public SourceDescriptor Size(int? size) { @@ -177,7 +202,9 @@ public SourceDescriptor Size(int? size) } /// - /// Slice the reindex request manually using the provided slice ID and total number of slices. + /// + /// Slice the reindex request manually using the provided slice ID and total number of slices. + /// /// public SourceDescriptor Slice(Elastic.Clients.Elasticsearch.SlicedScroll? slice) { @@ -240,7 +267,10 @@ public SourceDescriptor Sort(params Action - /// If `true` reindexes all source fields.
Set to a list to reindex select fields. + /// + /// If true reindexes all source fields. + /// Set to a list to reindex select fields. + /// /// public SourceDescriptor SourceFields(Elastic.Clients.Elasticsearch.Fields? sourceFields) { @@ -379,7 +409,10 @@ public SourceDescriptor() : base() private Elastic.Clients.Elasticsearch.Fields? SourceFieldsValue { get; set; } /// - /// The name of the data stream, index, or alias you are copying from.
Accepts a comma-separated list to reindex from multiple sources. + /// + /// The name of the data stream, index, or alias you are copying from. + /// Accepts a comma-separated list to reindex from multiple sources. + /// /// public SourceDescriptor Indices(Elastic.Clients.Elasticsearch.Indices indices) { @@ -388,7 +421,9 @@ public SourceDescriptor Indices(Elastic.Clients.Elasticsearch.Indices indices) } /// - /// Specifies the documents to reindex using the Query DSL. + /// + /// Specifies the documents to reindex using the Query DSL. + /// /// public SourceDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -415,7 +450,9 @@ public SourceDescriptor Query(Action - /// A remote instance of Elasticsearch that you want to index from. + /// + /// A remote instance of Elasticsearch that you want to index from. + /// /// public SourceDescriptor Remote(Elastic.Clients.Elasticsearch.Core.Reindex.RemoteSource? remote) { @@ -448,7 +485,10 @@ public SourceDescriptor RuntimeMappings(Func - /// The number of documents to index per batch.
Use when indexing from remote to ensure that the batches fit within the on-heap buffer, which defaults to a maximum size of 100 MB. + /// + /// The number of documents to index per batch. + /// Use when indexing from remote to ensure that the batches fit within the on-heap buffer, which defaults to a maximum size of 100 MB. + /// /// public SourceDescriptor Size(int? size) { @@ -457,7 +497,9 @@ public SourceDescriptor Size(int? size) } /// - /// Slice the reindex request manually using the provided slice ID and total number of slices. + /// + /// Slice the reindex request manually using the provided slice ID and total number of slices. + /// /// public SourceDescriptor Slice(Elastic.Clients.Elasticsearch.SlicedScroll? slice) { @@ -520,7 +562,10 @@ public SourceDescriptor Sort(params Action - /// If `true` reindexes all source fields.
Set to a list to reindex select fields. + /// + /// If true reindexes all source fields. + /// Set to a list to reindex select fields. + /// /// public SourceDescriptor SourceFields(Elastic.Clients.Elasticsearch.Fields? sourceFields) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/ReindexRethrottle/ReindexStatus.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/ReindexRethrottle/ReindexStatus.g.cs index 5d43ec4ef83..d9257364663 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/ReindexRethrottle/ReindexStatus.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/ReindexRethrottle/ReindexStatus.g.cs @@ -30,37 +30,49 @@ namespace Elastic.Clients.Elasticsearch.Core.ReindexRethrottle; public sealed partial class ReindexStatus { /// - /// The number of scroll responses pulled back by the reindex. + /// + /// The number of scroll responses pulled back by the reindex. + /// /// [JsonInclude, JsonPropertyName("batches")] public long Batches { get; init; } /// - /// The number of documents that were successfully created. + /// + /// The number of documents that were successfully created. + /// /// [JsonInclude, JsonPropertyName("created")] public long Created { get; init; } /// - /// The number of documents that were successfully deleted. + /// + /// The number of documents that were successfully deleted. + /// /// [JsonInclude, JsonPropertyName("deleted")] public long Deleted { get; init; } /// - /// The number of documents that were ignored because the script used for the reindex returned a `noop` value for `ctx.op`. + /// + /// The number of documents that were ignored because the script used for the reindex returned a noop value for ctx.op. + /// /// [JsonInclude, JsonPropertyName("noops")] public long Noops { get; init; } /// - /// The number of requests per second effectively executed during the reindex. + /// + /// The number of requests per second effectively executed during the reindex. + /// /// [JsonInclude, JsonPropertyName("requests_per_second")] public float RequestsPerSecond { get; init; } /// - /// The number of retries attempted by reindex. `bulk` is the number of bulk actions retried and `search` is the number of search actions retried. + /// + /// The number of retries attempted by reindex. bulk is the number of bulk actions retried and search is the number of search actions retried. + /// /// [JsonInclude, JsonPropertyName("retries")] public Elastic.Clients.Elasticsearch.Retries Retries { get; init; } @@ -68,7 +80,9 @@ public sealed partial class ReindexStatus public Elastic.Clients.Elasticsearch.Duration? Throttled { get; init; } /// - /// Number of milliseconds the request slept to conform to `requests_per_second`. + /// + /// Number of milliseconds the request slept to conform to requests_per_second. + /// /// [JsonInclude, JsonPropertyName("throttled_millis")] public long ThrottledMillis { get; init; } @@ -76,25 +90,34 @@ public sealed partial class ReindexStatus public Elastic.Clients.Elasticsearch.Duration? ThrottledUntil { get; init; } /// - /// This field should always be equal to zero in a `_reindex` response.
It only has meaning when using the Task API, where it indicates the next time (in milliseconds since epoch) a throttled request will be executed again in order to conform to `requests_per_second`. + /// + /// This field should always be equal to zero in a _reindex response. + /// It only has meaning when using the Task API, where it indicates the next time (in milliseconds since epoch) a throttled request will be executed again in order to conform to requests_per_second. + /// /// [JsonInclude, JsonPropertyName("throttled_until_millis")] public long ThrottledUntilMillis { get; init; } /// - /// The number of documents that were successfully processed. + /// + /// The number of documents that were successfully processed. + /// /// [JsonInclude, JsonPropertyName("total")] public long Total { get; init; } /// - /// The number of documents that were successfully updated, for example, a document with same ID already existed prior to reindex updating it. + /// + /// The number of documents that were successfully updated, for example, a document with same ID already existed prior to reindex updating it. + /// /// [JsonInclude, JsonPropertyName("updated")] public long Updated { get; init; } /// - /// The number of version conflicts that reindex hits. + /// + /// The number of version conflicts that reindex hits. + /// /// [JsonInclude, JsonPropertyName("version_conflicts")] public long VersionConflicts { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/ScriptsPainlessExecute/PainlessContextSetup.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/ScriptsPainlessExecute/PainlessContextSetup.g.cs index b42ab101517..78e4cfb84f9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/ScriptsPainlessExecute/PainlessContextSetup.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/ScriptsPainlessExecute/PainlessContextSetup.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Core.ScriptsPainlessExecute; public sealed partial class PainlessContextSetup { /// - /// Document that’s temporarily indexed in-memory and accessible from the script. + /// + /// Document that’s temporarily indexed in-memory and accessible from the script. + /// /// [JsonInclude, JsonPropertyName("document")] public object Document { get; set; } /// - /// Index containing a mapping that’s compatible with the indexed document.
You may specify a remote index by prefixing the index with the remote cluster alias. + /// + /// Index containing a mapping that’s compatible with the indexed document. + /// You may specify a remote index by prefixing the index with the remote cluster alias. + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.IndexName Index { get; set; } /// - /// Use this parameter to specify a query for computing a score. + /// + /// Use this parameter to specify a query for computing a score. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query Query { get; set; } @@ -63,7 +70,9 @@ public PainlessContextSetupDescriptor() : base() private Action> QueryDescriptorAction { get; set; } /// - /// Document that’s temporarily indexed in-memory and accessible from the script. + /// + /// Document that’s temporarily indexed in-memory and accessible from the script. + /// /// public PainlessContextSetupDescriptor Document(object document) { @@ -72,7 +81,10 @@ public PainlessContextSetupDescriptor Document(object document) } /// - /// Index containing a mapping that’s compatible with the indexed document.
You may specify a remote index by prefixing the index with the remote cluster alias. + /// + /// Index containing a mapping that’s compatible with the indexed document. + /// You may specify a remote index by prefixing the index with the remote cluster alias. + /// /// public PainlessContextSetupDescriptor Index(Elastic.Clients.Elasticsearch.IndexName index) { @@ -81,7 +93,9 @@ public PainlessContextSetupDescriptor Index(Elastic.Clients.Elasticse } /// - /// Use this parameter to specify a query for computing a score. + /// + /// Use this parameter to specify a query for computing a score. + /// /// public PainlessContextSetupDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query query) { @@ -149,7 +163,9 @@ public PainlessContextSetupDescriptor() : base() private Action QueryDescriptorAction { get; set; } /// - /// Document that’s temporarily indexed in-memory and accessible from the script. + /// + /// Document that’s temporarily indexed in-memory and accessible from the script. + /// /// public PainlessContextSetupDescriptor Document(object document) { @@ -158,7 +174,10 @@ public PainlessContextSetupDescriptor Document(object document) } /// - /// Index containing a mapping that’s compatible with the indexed document.
You may specify a remote index by prefixing the index with the remote cluster alias. + /// + /// Index containing a mapping that’s compatible with the indexed document. + /// You may specify a remote index by prefixing the index with the remote cluster alias. + /// /// public PainlessContextSetupDescriptor Index(Elastic.Clients.Elasticsearch.IndexName index) { @@ -167,7 +186,9 @@ public PainlessContextSetupDescriptor Index(Elastic.Clients.Elasticsearch.IndexN } /// - /// Use this parameter to specify a query for computing a score. + /// + /// Use this parameter to specify a query for computing a score. + /// /// public PainlessContextSetupDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query query) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/CompletionContext.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/CompletionContext.g.cs index 71a4722506f..7e8b2f44500 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/CompletionContext.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/CompletionContext.g.cs @@ -30,31 +30,46 @@ namespace Elastic.Clients.Elasticsearch.Core.Search; public sealed partial class CompletionContext { /// - /// The factor by which the score of the suggestion should be boosted.
The score is computed by multiplying the boost with the suggestion weight. + /// + /// The factor by which the score of the suggestion should be boosted. + /// The score is computed by multiplying the boost with the suggestion weight. + /// /// [JsonInclude, JsonPropertyName("boost")] public double? Boost { get; set; } /// - /// The value of the category to filter/boost on. + /// + /// The value of the category to filter/boost on. + /// /// [JsonInclude, JsonPropertyName("context")] public Elastic.Clients.Elasticsearch.Core.Search.Context Context { get; set; } /// - /// An array of precision values at which neighboring geohashes should be taken into account.
Precision value can be a distance value (`5m`, `10km`, etc.) or a raw geohash precision (`1`..`12`).
Defaults to generating neighbors for index time precision level. + /// + /// An array of precision values at which neighboring geohashes should be taken into account. + /// Precision value can be a distance value (5m, 10km, etc.) or a raw geohash precision (1..12). + /// Defaults to generating neighbors for index time precision level. + /// /// [JsonInclude, JsonPropertyName("neighbours")] public ICollection? Neighbours { get; set; } /// - /// The precision of the geohash to encode the query geo point.
Can be specified as a distance value (`5m`, `10km`, etc.), or as a raw geohash precision (`1`..`12`).
Defaults to index time precision level. + /// + /// The precision of the geohash to encode the query geo point. + /// Can be specified as a distance value (5m, 10km, etc.), or as a raw geohash precision (1..12). + /// Defaults to index time precision level. + /// /// [JsonInclude, JsonPropertyName("precision")] public Elastic.Clients.Elasticsearch.GeohashPrecision? Precision { get; set; } /// - /// Whether the category value should be treated as a prefix or not. + /// + /// Whether the category value should be treated as a prefix or not. + /// /// [JsonInclude, JsonPropertyName("prefix")] public bool? Prefix { get; set; } @@ -75,7 +90,10 @@ public CompletionContextDescriptor() : base() private bool? PrefixValue { get; set; } /// - /// The factor by which the score of the suggestion should be boosted.
The score is computed by multiplying the boost with the suggestion weight. + /// + /// The factor by which the score of the suggestion should be boosted. + /// The score is computed by multiplying the boost with the suggestion weight. + /// /// public CompletionContextDescriptor Boost(double? boost) { @@ -84,7 +102,9 @@ public CompletionContextDescriptor Boost(double? boost) } /// - /// The value of the category to filter/boost on. + /// + /// The value of the category to filter/boost on. + /// /// public CompletionContextDescriptor Context(Elastic.Clients.Elasticsearch.Core.Search.Context context) { @@ -93,7 +113,11 @@ public CompletionContextDescriptor Context(Elastic.Clients.Elasticsearch.Core.Se } /// - /// An array of precision values at which neighboring geohashes should be taken into account.
Precision value can be a distance value (`5m`, `10km`, etc.) or a raw geohash precision (`1`..`12`).
Defaults to generating neighbors for index time precision level. + /// + /// An array of precision values at which neighboring geohashes should be taken into account. + /// Precision value can be a distance value (5m, 10km, etc.) or a raw geohash precision (1..12). + /// Defaults to generating neighbors for index time precision level. + /// /// public CompletionContextDescriptor Neighbours(ICollection? neighbours) { @@ -102,7 +126,11 @@ public CompletionContextDescriptor Neighbours(ICollection - /// The precision of the geohash to encode the query geo point.
Can be specified as a distance value (`5m`, `10km`, etc.), or as a raw geohash precision (`1`..`12`).
Defaults to index time precision level. + /// + /// The precision of the geohash to encode the query geo point. + /// Can be specified as a distance value (5m, 10km, etc.), or as a raw geohash precision (1..12). + /// Defaults to index time precision level. + /// /// public CompletionContextDescriptor Precision(Elastic.Clients.Elasticsearch.GeohashPrecision? precision) { @@ -111,7 +139,9 @@ public CompletionContextDescriptor Precision(Elastic.Clients.Elasticsearch.Geoha } /// - /// Whether the category value should be treated as a prefix or not. + /// + /// Whether the category value should be treated as a prefix or not. + /// /// public CompletionContextDescriptor Prefix(bool? prefix = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/CompletionSuggester.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/CompletionSuggester.g.cs index a9b9195ce03..29e84a56d33 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/CompletionSuggester.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/CompletionSuggester.g.cs @@ -30,43 +30,59 @@ namespace Elastic.Clients.Elasticsearch.Core.Search; public sealed partial class CompletionSuggester { /// - /// The analyzer to analyze the suggest text with.
Defaults to the search analyzer of the suggest field. + /// + /// The analyzer to analyze the suggest text with. + /// Defaults to the search analyzer of the suggest field. + /// /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } /// - /// A value, geo point object, or a geo hash string to filter or boost the suggestion on. + /// + /// A value, geo point object, or a geo hash string to filter or boost the suggestion on. + /// /// [JsonInclude, JsonPropertyName("contexts")] public IDictionary>>? Contexts { get; set; } /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Enables fuzziness, meaning you can have a typo in your search and still get results back. + /// + /// Enables fuzziness, meaning you can have a typo in your search and still get results back. + /// /// [JsonInclude, JsonPropertyName("fuzzy")] public Elastic.Clients.Elasticsearch.Core.Search.SuggestFuzziness? Fuzzy { get; set; } /// - /// A regex query that expresses a prefix as a regular expression. + /// + /// A regex query that expresses a prefix as a regular expression. + /// /// [JsonInclude, JsonPropertyName("regex")] public Elastic.Clients.Elasticsearch.Core.Search.RegexOptions? Regex { get; set; } /// - /// The maximum corrections to be returned per suggest text token. + /// + /// The maximum corrections to be returned per suggest text token. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// Whether duplicate suggestions should be filtered out. + /// + /// Whether duplicate suggestions should be filtered out. + /// /// [JsonInclude, JsonPropertyName("skip_duplicates")] public bool? SkipDuplicates { get; set; } @@ -95,7 +111,10 @@ public CompletionSuggesterDescriptor() : base() private bool? SkipDuplicatesValue { get; set; } /// - /// The analyzer to analyze the suggest text with.
Defaults to the search analyzer of the suggest field. + /// + /// The analyzer to analyze the suggest text with. + /// Defaults to the search analyzer of the suggest field. + /// /// public CompletionSuggesterDescriptor Analyzer(string? analyzer) { @@ -104,7 +123,9 @@ public CompletionSuggesterDescriptor Analyzer(string? analyzer) } /// - /// A value, geo point object, or a geo hash string to filter or boost the suggestion on. + /// + /// A value, geo point object, or a geo hash string to filter or boost the suggestion on. + /// /// public CompletionSuggesterDescriptor Contexts(Func>>, FluentDictionary>>> selector) { @@ -113,7 +134,10 @@ public CompletionSuggesterDescriptor Contexts(Func - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public CompletionSuggesterDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -122,7 +146,10 @@ public CompletionSuggesterDescriptor Field(Elastic.Clients.Elasticsea } /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public CompletionSuggesterDescriptor Field(Expression> field) { @@ -131,7 +158,10 @@ public CompletionSuggesterDescriptor Field(Expression - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public CompletionSuggesterDescriptor Field(Expression> field) { @@ -140,7 +170,9 @@ public CompletionSuggesterDescriptor Field(Expression - /// Enables fuzziness, meaning you can have a typo in your search and still get results back. + /// + /// Enables fuzziness, meaning you can have a typo in your search and still get results back. + /// /// public CompletionSuggesterDescriptor Fuzzy(Elastic.Clients.Elasticsearch.Core.Search.SuggestFuzziness? fuzzy) { @@ -167,7 +199,9 @@ public CompletionSuggesterDescriptor Fuzzy(Action - /// A regex query that expresses a prefix as a regular expression. + /// + /// A regex query that expresses a prefix as a regular expression. + /// /// public CompletionSuggesterDescriptor Regex(Elastic.Clients.Elasticsearch.Core.Search.RegexOptions? regex) { @@ -194,7 +228,9 @@ public CompletionSuggesterDescriptor Regex(Action - /// The maximum corrections to be returned per suggest text token. + /// + /// The maximum corrections to be returned per suggest text token. + /// /// public CompletionSuggesterDescriptor Size(int? size) { @@ -203,7 +239,9 @@ public CompletionSuggesterDescriptor Size(int? size) } /// - /// Whether duplicate suggestions should be filtered out. + /// + /// Whether duplicate suggestions should be filtered out. + /// /// public CompletionSuggesterDescriptor SkipDuplicates(bool? skipDuplicates = true) { @@ -297,7 +335,10 @@ public CompletionSuggesterDescriptor() : base() private bool? SkipDuplicatesValue { get; set; } /// - /// The analyzer to analyze the suggest text with.
Defaults to the search analyzer of the suggest field. + /// + /// The analyzer to analyze the suggest text with. + /// Defaults to the search analyzer of the suggest field. + /// /// public CompletionSuggesterDescriptor Analyzer(string? analyzer) { @@ -306,7 +347,9 @@ public CompletionSuggesterDescriptor Analyzer(string? analyzer) } /// - /// A value, geo point object, or a geo hash string to filter or boost the suggestion on. + /// + /// A value, geo point object, or a geo hash string to filter or boost the suggestion on. + /// /// public CompletionSuggesterDescriptor Contexts(Func>>, FluentDictionary>>> selector) { @@ -315,7 +358,10 @@ public CompletionSuggesterDescriptor Contexts(Func - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public CompletionSuggesterDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -324,7 +370,10 @@ public CompletionSuggesterDescriptor Field(Elastic.Clients.Elasticsearch.Field f } /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public CompletionSuggesterDescriptor Field(Expression> field) { @@ -333,7 +382,10 @@ public CompletionSuggesterDescriptor Field(Expression - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public CompletionSuggesterDescriptor Field(Expression> field) { @@ -342,7 +394,9 @@ public CompletionSuggesterDescriptor Field(Expression - /// Enables fuzziness, meaning you can have a typo in your search and still get results back. + /// + /// Enables fuzziness, meaning you can have a typo in your search and still get results back. + /// /// public CompletionSuggesterDescriptor Fuzzy(Elastic.Clients.Elasticsearch.Core.Search.SuggestFuzziness? fuzzy) { @@ -369,7 +423,9 @@ public CompletionSuggesterDescriptor Fuzzy(Action - /// A regex query that expresses a prefix as a regular expression. + /// + /// A regex query that expresses a prefix as a regular expression. + /// /// public CompletionSuggesterDescriptor Regex(Elastic.Clients.Elasticsearch.Core.Search.RegexOptions? regex) { @@ -396,7 +452,9 @@ public CompletionSuggesterDescriptor Regex(Action - /// The maximum corrections to be returned per suggest text token. + /// + /// The maximum corrections to be returned per suggest text token. + /// /// public CompletionSuggesterDescriptor Size(int? size) { @@ -405,7 +463,9 @@ public CompletionSuggesterDescriptor Size(int? size) } /// - /// Whether duplicate suggestions should be filtered out. + /// + /// Whether duplicate suggestions should be filtered out. + /// /// public CompletionSuggesterDescriptor SkipDuplicates(bool? skipDuplicates = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/DirectGenerator.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/DirectGenerator.g.cs index 1591eeb4831..a6c312dca6d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/DirectGenerator.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/DirectGenerator.g.cs @@ -30,67 +30,100 @@ namespace Elastic.Clients.Elasticsearch.Core.Search; public sealed partial class DirectGenerator { /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// The maximum edit distance candidate suggestions can have in order to be considered as a suggestion.
Can only be `1` or `2`. + /// + /// The maximum edit distance candidate suggestions can have in order to be considered as a suggestion. + /// Can only be 1 or 2. + /// /// [JsonInclude, JsonPropertyName("max_edits")] public int? MaxEdits { get; set; } /// - /// A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level.
Can improve accuracy at the cost of performance. + /// + /// A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level. + /// Can improve accuracy at the cost of performance. + /// /// [JsonInclude, JsonPropertyName("max_inspections")] public float? MaxInspections { get; set; } /// - /// The maximum threshold in number of documents in which a suggest text token can exist in order to be included.
This can be used to exclude high frequency terms — which are usually spelled correctly — from being spellchecked.
Can be a relative percentage number (for example `0.4`) or an absolute number to represent document frequencies.
If a value higher than 1 is specified, then fractional can not be specified. + /// + /// The maximum threshold in number of documents in which a suggest text token can exist in order to be included. + /// This can be used to exclude high frequency terms — which are usually spelled correctly — from being spellchecked. + /// Can be a relative percentage number (for example 0.4) or an absolute number to represent document frequencies. + /// If a value higher than 1 is specified, then fractional can not be specified. + /// /// [JsonInclude, JsonPropertyName("max_term_freq")] public float? MaxTermFreq { get; set; } /// - /// The minimal threshold in number of documents a suggestion should appear in.
This can improve quality by only suggesting high frequency terms.
Can be specified as an absolute number or as a relative percentage of number of documents.
If a value higher than 1 is specified, the number cannot be fractional. + /// + /// The minimal threshold in number of documents a suggestion should appear in. + /// This can improve quality by only suggesting high frequency terms. + /// Can be specified as an absolute number or as a relative percentage of number of documents. + /// If a value higher than 1 is specified, the number cannot be fractional. + /// /// [JsonInclude, JsonPropertyName("min_doc_freq")] public float? MinDocFreq { get; set; } /// - /// The minimum length a suggest text term must have in order to be included. + /// + /// The minimum length a suggest text term must have in order to be included. + /// /// [JsonInclude, JsonPropertyName("min_word_length")] public int? MinWordLength { get; set; } /// - /// A filter (analyzer) that is applied to each of the generated tokens before they are passed to the actual phrase scorer. + /// + /// A filter (analyzer) that is applied to each of the generated tokens before they are passed to the actual phrase scorer. + /// /// [JsonInclude, JsonPropertyName("post_filter")] public string? PostFilter { get; set; } /// - /// A filter (analyzer) that is applied to each of the tokens passed to this candidate generator.
This filter is applied to the original token before candidates are generated. + /// + /// A filter (analyzer) that is applied to each of the tokens passed to this candidate generator. + /// This filter is applied to the original token before candidates are generated. + /// /// [JsonInclude, JsonPropertyName("pre_filter")] public string? PreFilter { get; set; } /// - /// The number of minimal prefix characters that must match in order be a candidate suggestions.
Increasing this number improves spellcheck performance. + /// + /// The number of minimal prefix characters that must match in order be a candidate suggestions. + /// Increasing this number improves spellcheck performance. + /// /// [JsonInclude, JsonPropertyName("prefix_length")] public int? PrefixLength { get; set; } /// - /// The maximum corrections to be returned per suggest text token. + /// + /// The maximum corrections to be returned per suggest text token. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// Controls what suggestions are included on the suggestions generated on each shard. + /// + /// Controls what suggestions are included on the suggestions generated on each shard. + /// /// [JsonInclude, JsonPropertyName("suggest_mode")] public Elastic.Clients.Elasticsearch.SuggestMode? SuggestMode { get; set; } @@ -117,7 +150,10 @@ public DirectGeneratorDescriptor() : base() private Elastic.Clients.Elasticsearch.SuggestMode? SuggestModeValue { get; set; } /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public DirectGeneratorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -126,7 +162,10 @@ public DirectGeneratorDescriptor Field(Elastic.Clients.Elasticsearch. } /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public DirectGeneratorDescriptor Field(Expression> field) { @@ -135,7 +174,10 @@ public DirectGeneratorDescriptor Field(Expression - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public DirectGeneratorDescriptor Field(Expression> field) { @@ -144,7 +186,10 @@ public DirectGeneratorDescriptor Field(Expression - /// The maximum edit distance candidate suggestions can have in order to be considered as a suggestion.
Can only be `1` or `2`. + /// + /// The maximum edit distance candidate suggestions can have in order to be considered as a suggestion. + /// Can only be 1 or 2. + /// /// public DirectGeneratorDescriptor MaxEdits(int? maxEdits) { @@ -153,7 +198,10 @@ public DirectGeneratorDescriptor MaxEdits(int? maxEdits) } /// - /// A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level.
Can improve accuracy at the cost of performance. + /// + /// A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level. + /// Can improve accuracy at the cost of performance. + /// /// public DirectGeneratorDescriptor MaxInspections(float? maxInspections) { @@ -162,7 +210,12 @@ public DirectGeneratorDescriptor MaxInspections(float? maxInspections } /// - /// The maximum threshold in number of documents in which a suggest text token can exist in order to be included.
This can be used to exclude high frequency terms — which are usually spelled correctly — from being spellchecked.
Can be a relative percentage number (for example `0.4`) or an absolute number to represent document frequencies.
If a value higher than 1 is specified, then fractional can not be specified. + /// + /// The maximum threshold in number of documents in which a suggest text token can exist in order to be included. + /// This can be used to exclude high frequency terms — which are usually spelled correctly — from being spellchecked. + /// Can be a relative percentage number (for example 0.4) or an absolute number to represent document frequencies. + /// If a value higher than 1 is specified, then fractional can not be specified. + /// /// public DirectGeneratorDescriptor MaxTermFreq(float? maxTermFreq) { @@ -171,7 +224,12 @@ public DirectGeneratorDescriptor MaxTermFreq(float? maxTermFreq) } /// - /// The minimal threshold in number of documents a suggestion should appear in.
This can improve quality by only suggesting high frequency terms.
Can be specified as an absolute number or as a relative percentage of number of documents.
If a value higher than 1 is specified, the number cannot be fractional. + /// + /// The minimal threshold in number of documents a suggestion should appear in. + /// This can improve quality by only suggesting high frequency terms. + /// Can be specified as an absolute number or as a relative percentage of number of documents. + /// If a value higher than 1 is specified, the number cannot be fractional. + /// /// public DirectGeneratorDescriptor MinDocFreq(float? minDocFreq) { @@ -180,7 +238,9 @@ public DirectGeneratorDescriptor MinDocFreq(float? minDocFreq) } /// - /// The minimum length a suggest text term must have in order to be included. + /// + /// The minimum length a suggest text term must have in order to be included. + /// /// public DirectGeneratorDescriptor MinWordLength(int? minWordLength) { @@ -189,7 +249,9 @@ public DirectGeneratorDescriptor MinWordLength(int? minWordLength) } /// - /// A filter (analyzer) that is applied to each of the generated tokens before they are passed to the actual phrase scorer. + /// + /// A filter (analyzer) that is applied to each of the generated tokens before they are passed to the actual phrase scorer. + /// /// public DirectGeneratorDescriptor PostFilter(string? postFilter) { @@ -198,7 +260,10 @@ public DirectGeneratorDescriptor PostFilter(string? postFilter) } /// - /// A filter (analyzer) that is applied to each of the tokens passed to this candidate generator.
This filter is applied to the original token before candidates are generated. + /// + /// A filter (analyzer) that is applied to each of the tokens passed to this candidate generator. + /// This filter is applied to the original token before candidates are generated. + /// /// public DirectGeneratorDescriptor PreFilter(string? preFilter) { @@ -207,7 +272,10 @@ public DirectGeneratorDescriptor PreFilter(string? preFilter) } /// - /// The number of minimal prefix characters that must match in order be a candidate suggestions.
Increasing this number improves spellcheck performance. + /// + /// The number of minimal prefix characters that must match in order be a candidate suggestions. + /// Increasing this number improves spellcheck performance. + /// /// public DirectGeneratorDescriptor PrefixLength(int? prefixLength) { @@ -216,7 +284,9 @@ public DirectGeneratorDescriptor PrefixLength(int? prefixLength) } /// - /// The maximum corrections to be returned per suggest text token. + /// + /// The maximum corrections to be returned per suggest text token. + /// /// public DirectGeneratorDescriptor Size(int? size) { @@ -225,7 +295,9 @@ public DirectGeneratorDescriptor Size(int? size) } /// - /// Controls what suggestions are included on the suggestions generated on each shard. + /// + /// Controls what suggestions are included on the suggestions generated on each shard. + /// /// public DirectGeneratorDescriptor SuggestMode(Elastic.Clients.Elasticsearch.SuggestMode? suggestMode) { @@ -323,7 +395,10 @@ public DirectGeneratorDescriptor() : base() private Elastic.Clients.Elasticsearch.SuggestMode? SuggestModeValue { get; set; } /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public DirectGeneratorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -332,7 +407,10 @@ public DirectGeneratorDescriptor Field(Elastic.Clients.Elasticsearch.Field field } /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public DirectGeneratorDescriptor Field(Expression> field) { @@ -341,7 +419,10 @@ public DirectGeneratorDescriptor Field(Expression - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public DirectGeneratorDescriptor Field(Expression> field) { @@ -350,7 +431,10 @@ public DirectGeneratorDescriptor Field(Expression - /// The maximum edit distance candidate suggestions can have in order to be considered as a suggestion.
Can only be `1` or `2`. + /// + /// The maximum edit distance candidate suggestions can have in order to be considered as a suggestion. + /// Can only be 1 or 2. + /// /// public DirectGeneratorDescriptor MaxEdits(int? maxEdits) { @@ -359,7 +443,10 @@ public DirectGeneratorDescriptor MaxEdits(int? maxEdits) } /// - /// A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level.
Can improve accuracy at the cost of performance. + /// + /// A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level. + /// Can improve accuracy at the cost of performance. + /// /// public DirectGeneratorDescriptor MaxInspections(float? maxInspections) { @@ -368,7 +455,12 @@ public DirectGeneratorDescriptor MaxInspections(float? maxInspections) } /// - /// The maximum threshold in number of documents in which a suggest text token can exist in order to be included.
This can be used to exclude high frequency terms — which are usually spelled correctly — from being spellchecked.
Can be a relative percentage number (for example `0.4`) or an absolute number to represent document frequencies.
If a value higher than 1 is specified, then fractional can not be specified. + /// + /// The maximum threshold in number of documents in which a suggest text token can exist in order to be included. + /// This can be used to exclude high frequency terms — which are usually spelled correctly — from being spellchecked. + /// Can be a relative percentage number (for example 0.4) or an absolute number to represent document frequencies. + /// If a value higher than 1 is specified, then fractional can not be specified. + /// /// public DirectGeneratorDescriptor MaxTermFreq(float? maxTermFreq) { @@ -377,7 +469,12 @@ public DirectGeneratorDescriptor MaxTermFreq(float? maxTermFreq) } /// - /// The minimal threshold in number of documents a suggestion should appear in.
This can improve quality by only suggesting high frequency terms.
Can be specified as an absolute number or as a relative percentage of number of documents.
If a value higher than 1 is specified, the number cannot be fractional. + /// + /// The minimal threshold in number of documents a suggestion should appear in. + /// This can improve quality by only suggesting high frequency terms. + /// Can be specified as an absolute number or as a relative percentage of number of documents. + /// If a value higher than 1 is specified, the number cannot be fractional. + /// /// public DirectGeneratorDescriptor MinDocFreq(float? minDocFreq) { @@ -386,7 +483,9 @@ public DirectGeneratorDescriptor MinDocFreq(float? minDocFreq) } /// - /// The minimum length a suggest text term must have in order to be included. + /// + /// The minimum length a suggest text term must have in order to be included. + /// /// public DirectGeneratorDescriptor MinWordLength(int? minWordLength) { @@ -395,7 +494,9 @@ public DirectGeneratorDescriptor MinWordLength(int? minWordLength) } /// - /// A filter (analyzer) that is applied to each of the generated tokens before they are passed to the actual phrase scorer. + /// + /// A filter (analyzer) that is applied to each of the generated tokens before they are passed to the actual phrase scorer. + /// /// public DirectGeneratorDescriptor PostFilter(string? postFilter) { @@ -404,7 +505,10 @@ public DirectGeneratorDescriptor PostFilter(string? postFilter) } /// - /// A filter (analyzer) that is applied to each of the tokens passed to this candidate generator.
This filter is applied to the original token before candidates are generated. + /// + /// A filter (analyzer) that is applied to each of the tokens passed to this candidate generator. + /// This filter is applied to the original token before candidates are generated. + /// /// public DirectGeneratorDescriptor PreFilter(string? preFilter) { @@ -413,7 +517,10 @@ public DirectGeneratorDescriptor PreFilter(string? preFilter) } /// - /// The number of minimal prefix characters that must match in order be a candidate suggestions.
Increasing this number improves spellcheck performance. + /// + /// The number of minimal prefix characters that must match in order be a candidate suggestions. + /// Increasing this number improves spellcheck performance. + /// /// public DirectGeneratorDescriptor PrefixLength(int? prefixLength) { @@ -422,7 +529,9 @@ public DirectGeneratorDescriptor PrefixLength(int? prefixLength) } /// - /// The maximum corrections to be returned per suggest text token. + /// + /// The maximum corrections to be returned per suggest text token. + /// /// public DirectGeneratorDescriptor Size(int? size) { @@ -431,7 +540,9 @@ public DirectGeneratorDescriptor Size(int? size) } /// - /// Controls what suggestions are included on the suggestions generated on each shard. + /// + /// Controls what suggestions are included on the suggestions generated on each shard. + /// /// public DirectGeneratorDescriptor SuggestMode(Elastic.Clients.Elasticsearch.SuggestMode? suggestMode) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/FieldCollapse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/FieldCollapse.g.cs index 4c5323cfc58..06fbcd812b5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/FieldCollapse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/FieldCollapse.g.cs @@ -33,20 +33,26 @@ public sealed partial class FieldCollapse public Elastic.Clients.Elasticsearch.Core.Search.FieldCollapse? Collapse { get; set; } /// - /// The field to collapse the result set on + /// + /// The field to collapse the result set on + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// The number of inner hits and their sort order + /// + /// The number of inner hits and their sort order + /// /// [JsonInclude, JsonPropertyName("inner_hits")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Core.Search.InnerHits))] public ICollection? InnerHits { get; set; } /// - /// The number of concurrent requests allowed to retrieve the inner_hits per group + /// + /// The number of concurrent requests allowed to retrieve the inner_hits per group + /// /// [JsonInclude, JsonPropertyName("max_concurrent_group_searches")] public int? MaxConcurrentGroupSearches { get; set; } @@ -95,7 +101,9 @@ public FieldCollapseDescriptor Collapse(Action - /// The field to collapse the result set on + /// + /// The field to collapse the result set on + /// /// public FieldCollapseDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -104,7 +112,9 @@ public FieldCollapseDescriptor Field(Elastic.Clients.Elasticsearch.Fi } /// - /// The field to collapse the result set on + /// + /// The field to collapse the result set on + /// /// public FieldCollapseDescriptor Field(Expression> field) { @@ -113,7 +123,9 @@ public FieldCollapseDescriptor Field(Expression - /// The field to collapse the result set on + /// + /// The field to collapse the result set on + /// /// public FieldCollapseDescriptor Field(Expression> field) { @@ -122,7 +134,9 @@ public FieldCollapseDescriptor Field(Expression - /// The number of inner hits and their sort order + /// + /// The number of inner hits and their sort order + /// /// public FieldCollapseDescriptor InnerHits(ICollection? innerHits) { @@ -161,7 +175,9 @@ public FieldCollapseDescriptor InnerHits(params Action - /// The number of concurrent requests allowed to retrieve the inner_hits per group + /// + /// The number of concurrent requests allowed to retrieve the inner_hits per group + /// /// public FieldCollapseDescriptor MaxConcurrentGroupSearches(int? maxConcurrentGroupSearches) { @@ -272,7 +288,9 @@ public FieldCollapseDescriptor Collapse(Action - /// The field to collapse the result set on + /// + /// The field to collapse the result set on + /// /// public FieldCollapseDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -281,7 +299,9 @@ public FieldCollapseDescriptor Field(Elastic.Clients.Elasticsearch.Field field) } /// - /// The field to collapse the result set on + /// + /// The field to collapse the result set on + /// /// public FieldCollapseDescriptor Field(Expression> field) { @@ -290,7 +310,9 @@ public FieldCollapseDescriptor Field(Expression - /// The field to collapse the result set on + /// + /// The field to collapse the result set on + /// /// public FieldCollapseDescriptor Field(Expression> field) { @@ -299,7 +321,9 @@ public FieldCollapseDescriptor Field(Expression - /// The number of inner hits and their sort order + /// + /// The number of inner hits and their sort order + /// /// public FieldCollapseDescriptor InnerHits(ICollection? innerHits) { @@ -338,7 +362,9 @@ public FieldCollapseDescriptor InnerHits(params Action - /// The number of concurrent requests allowed to retrieve the inner_hits per group + /// + /// The number of concurrent requests allowed to retrieve the inner_hits per group + /// /// public FieldCollapseDescriptor MaxConcurrentGroupSearches(int? maxConcurrentGroupSearches) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/FieldSuggester.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/FieldSuggester.g.cs index 7fbc46ff7ba..eb342fd32f5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/FieldSuggester.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/FieldSuggester.g.cs @@ -51,19 +51,26 @@ internal FieldSuggester(string variantName, object variant) public static FieldSuggester Term(Elastic.Clients.Elasticsearch.Core.Search.TermSuggester termSuggester) => new FieldSuggester("term", termSuggester); /// - /// Prefix used to search for suggestions. + /// + /// Prefix used to search for suggestions. + /// /// [JsonInclude, JsonPropertyName("prefix")] public string? Prefix { get; set; } /// - /// A prefix expressed as a regular expression. + /// + /// A prefix expressed as a regular expression. + /// /// [JsonInclude, JsonPropertyName("regex")] public string? Regex { get; set; } /// - /// The text to use as input for the suggester.
Needs to be set globally or per suggestion. + /// + /// The text to use as input for the suggester. + /// Needs to be set globally or per suggestion. + /// /// [JsonInclude, JsonPropertyName("text")] public string? Text { get; set; } @@ -236,7 +243,9 @@ private FieldSuggesterDescriptor Set(object variant, string variantNa private string? TextValue { get; set; } /// - /// Prefix used to search for suggestions. + /// + /// Prefix used to search for suggestions. + /// /// public FieldSuggesterDescriptor Prefix(string? prefix) { @@ -245,7 +254,9 @@ public FieldSuggesterDescriptor Prefix(string? prefix) } /// - /// A prefix expressed as a regular expression. + /// + /// A prefix expressed as a regular expression. + /// /// public FieldSuggesterDescriptor Regex(string? regex) { @@ -254,7 +265,10 @@ public FieldSuggesterDescriptor Regex(string? regex) } /// - /// The text to use as input for the suggester.
Needs to be set globally or per suggestion. + /// + /// The text to use as input for the suggester. + /// Needs to be set globally or per suggestion. + /// /// public FieldSuggesterDescriptor Text(string? text) { @@ -343,7 +357,9 @@ private FieldSuggesterDescriptor Set(object variant, string variantName) private string? TextValue { get; set; } /// - /// Prefix used to search for suggestions. + /// + /// Prefix used to search for suggestions. + /// /// public FieldSuggesterDescriptor Prefix(string? prefix) { @@ -352,7 +368,9 @@ public FieldSuggesterDescriptor Prefix(string? prefix) } /// - /// A prefix expressed as a regular expression. + /// + /// A prefix expressed as a regular expression. + /// /// public FieldSuggesterDescriptor Regex(string? regex) { @@ -361,7 +379,10 @@ public FieldSuggesterDescriptor Regex(string? regex) } /// - /// The text to use as input for the suggester.
Needs to be set globally or per suggestion. + /// + /// The text to use as input for the suggester. + /// Needs to be set globally or per suggestion. + /// /// public FieldSuggesterDescriptor Text(string? text) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/Highlight.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/Highlight.g.cs index 3c2039c54f3..0955a3e17ea 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/Highlight.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/Highlight.g.cs @@ -30,25 +30,36 @@ namespace Elastic.Clients.Elasticsearch.Core.Search; public sealed partial class Highlight { /// - /// A string that contains each boundary character. + /// + /// A string that contains each boundary character. + /// /// [JsonInclude, JsonPropertyName("boundary_chars")] public string? BoundaryChars { get; set; } /// - /// How far to scan for boundary characters. + /// + /// How far to scan for boundary characters. + /// /// [JsonInclude, JsonPropertyName("boundary_max_scan")] public int? BoundaryMaxScan { get; set; } /// - /// Specifies how to break the highlighted fragments: chars, sentence, or word.
Only valid for the unified and fvh highlighters.
Defaults to `sentence` for the `unified` highlighter. Defaults to `chars` for the `fvh` highlighter. + /// + /// Specifies how to break the highlighted fragments: chars, sentence, or word. + /// Only valid for the unified and fvh highlighters. + /// Defaults to sentence for the unified highlighter. Defaults to chars for the fvh highlighter. + /// /// [JsonInclude, JsonPropertyName("boundary_scanner")] public Elastic.Clients.Elasticsearch.Core.Search.BoundaryScanner? BoundaryScanner { get; set; } /// - /// Controls which locale is used to search for sentence and word boundaries.
This parameter takes a form of a language tag, for example: `"en-US"`, `"fr-FR"`, `"ja-JP"`. + /// + /// Controls which locale is used to search for sentence and word boundaries. + /// This parameter takes a form of a language tag, for example: "en-US", "fr-FR", "ja-JP". + /// /// [JsonInclude, JsonPropertyName("boundary_scanner_locale")] public string? BoundaryScannerLocale { get; set; } @@ -58,13 +69,18 @@ public sealed partial class Highlight public IDictionary Fields { get; set; } /// - /// Specifies how text should be broken up in highlight snippets: `simple` or `span`.
Only valid for the `plain` highlighter. + /// + /// Specifies how text should be broken up in highlight snippets: simple or span. + /// Only valid for the plain highlighter. + /// /// [JsonInclude, JsonPropertyName("fragmenter")] public Elastic.Clients.Elasticsearch.Core.Search.HighlighterFragmenter? Fragmenter { get; set; } /// - /// The size of the highlighted fragment in characters. + /// + /// The size of the highlighted fragment in characters. + /// /// [JsonInclude, JsonPropertyName("fragment_size")] public int? FragmentSize { get; set; } @@ -72,13 +88,20 @@ public sealed partial class Highlight public bool? HighlightFilter { get; set; } /// - /// Highlight matches for a query other than the search query.
This is especially useful if you use a rescore query because those are not taken into account by highlighting by default. + /// + /// Highlight matches for a query other than the search query. + /// This is especially useful if you use a rescore query because those are not taken into account by highlighting by default. + /// /// [JsonInclude, JsonPropertyName("highlight_query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? HighlightQuery { get; set; } /// - /// If set to a non-negative value, highlighting stops at this defined maximum limit.
The rest of the text is not processed, thus not highlighted and no error is returned
The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it’s set to lower value than the query setting. + /// + /// If set to a non-negative value, highlighting stops at this defined maximum limit. + /// The rest of the text is not processed, thus not highlighted and no error is returned + /// The max_analyzed_offset query setting does not override the index.highlight.max_analyzed_offset setting, which prevails when it’s set to lower value than the query setting. + /// /// [JsonInclude, JsonPropertyName("max_analyzed_offset")] public int? MaxAnalyzedOffset { get; set; } @@ -86,13 +109,21 @@ public sealed partial class Highlight public int? MaxFragmentLength { get; set; } /// - /// The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. + /// + /// The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. + /// /// [JsonInclude, JsonPropertyName("no_match_size")] public int? NoMatchSize { get; set; } /// - /// The maximum number of fragments to return.
If the number of fragments is set to `0`, no fragments are returned.
Instead, the entire field contents are highlighted and returned.
This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required.
If `number_of_fragments` is `0`, `fragment_size` is ignored. + /// + /// The maximum number of fragments to return. + /// If the number of fragments is set to 0, no fragments are returned. + /// Instead, the entire field contents are highlighted and returned. + /// This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. + /// If number_of_fragments is 0, fragment_size is ignored. + /// /// [JsonInclude, JsonPropertyName("number_of_fragments")] public int? NumberOfFragments { get; set; } @@ -100,37 +131,58 @@ public sealed partial class Highlight public IDictionary? Options { get; set; } /// - /// Sorts highlighted fragments by score when set to `score`.
By default, fragments will be output in the order they appear in the field (order: `none`).
Setting this option to `score` will output the most relevant fragments first.
Each highlighter applies its own logic to compute relevancy scores. + /// + /// Sorts highlighted fragments by score when set to score. + /// By default, fragments will be output in the order they appear in the field (order: none). + /// Setting this option to score will output the most relevant fragments first. + /// Each highlighter applies its own logic to compute relevancy scores. + /// /// [JsonInclude, JsonPropertyName("order")] public Elastic.Clients.Elasticsearch.Core.Search.HighlighterOrder? Order { get; set; } /// - /// Controls the number of matching phrases in a document that are considered.
Prevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory.
When using `matched_fields`, `phrase_limit` phrases per matched field are considered. Raising the limit increases query time and consumes more memory.
Only supported by the `fvh` highlighter. + /// + /// Controls the number of matching phrases in a document that are considered. + /// Prevents the fvh highlighter from analyzing too many phrases and consuming too much memory. + /// When using matched_fields, phrase_limit phrases per matched field are considered. Raising the limit increases query time and consumes more memory. + /// Only supported by the fvh highlighter. + /// /// [JsonInclude, JsonPropertyName("phrase_limit")] public int? PhraseLimit { get; set; } /// - /// Use in conjunction with `pre_tags` to define the HTML tags to use for the highlighted text.
By default, highlighted text is wrapped in `` and `` tags. + /// + /// Use in conjunction with pre_tags to define the HTML tags to use for the highlighted text. + /// By default, highlighted text is wrapped in <em> and </em> tags. + /// /// [JsonInclude, JsonPropertyName("post_tags")] public ICollection? PostTags { get; set; } /// - /// Use in conjunction with `post_tags` to define the HTML tags to use for the highlighted text.
By default, highlighted text is wrapped in `` and `` tags. + /// + /// Use in conjunction with post_tags to define the HTML tags to use for the highlighted text. + /// By default, highlighted text is wrapped in <em> and </em> tags. + /// /// [JsonInclude, JsonPropertyName("pre_tags")] public ICollection? PreTags { get; set; } /// - /// By default, only fields that contains a query match are highlighted.
Set to `false` to highlight all fields. + /// + /// By default, only fields that contains a query match are highlighted. + /// Set to false to highlight all fields. + /// /// [JsonInclude, JsonPropertyName("require_field_match")] public bool? RequireFieldMatch { get; set; } /// - /// Set to `styled` to use the built-in tag schema. + /// + /// Set to styled to use the built-in tag schema. + /// /// [JsonInclude, JsonPropertyName("tags_schema")] public Elastic.Clients.Elasticsearch.Core.Search.HighlighterTagsSchema? TagsSchema { get; set; } @@ -172,7 +224,9 @@ public HighlightDescriptor() : base() private Elastic.Clients.Elasticsearch.Core.Search.HighlighterType? TypeValue { get; set; } /// - /// A string that contains each boundary character. + /// + /// A string that contains each boundary character. + /// /// public HighlightDescriptor BoundaryChars(string? boundaryChars) { @@ -181,7 +235,9 @@ public HighlightDescriptor BoundaryChars(string? boundaryChars) } /// - /// How far to scan for boundary characters. + /// + /// How far to scan for boundary characters. + /// /// public HighlightDescriptor BoundaryMaxScan(int? boundaryMaxScan) { @@ -190,7 +246,11 @@ public HighlightDescriptor BoundaryMaxScan(int? boundaryMaxScan) } /// - /// Specifies how to break the highlighted fragments: chars, sentence, or word.
Only valid for the unified and fvh highlighters.
Defaults to `sentence` for the `unified` highlighter. Defaults to `chars` for the `fvh` highlighter. + /// + /// Specifies how to break the highlighted fragments: chars, sentence, or word. + /// Only valid for the unified and fvh highlighters. + /// Defaults to sentence for the unified highlighter. Defaults to chars for the fvh highlighter. + /// /// public HighlightDescriptor BoundaryScanner(Elastic.Clients.Elasticsearch.Core.Search.BoundaryScanner? boundaryScanner) { @@ -199,7 +259,10 @@ public HighlightDescriptor BoundaryScanner(Elastic.Clients.Elasticsea } /// - /// Controls which locale is used to search for sentence and word boundaries.
This parameter takes a form of a language tag, for example: `"en-US"`, `"fr-FR"`, `"ja-JP"`. + /// + /// Controls which locale is used to search for sentence and word boundaries. + /// This parameter takes a form of a language tag, for example: "en-US", "fr-FR", "ja-JP". + /// /// public HighlightDescriptor BoundaryScannerLocale(string? boundaryScannerLocale) { @@ -220,7 +283,10 @@ public HighlightDescriptor Fields(Func - /// Specifies how text should be broken up in highlight snippets: `simple` or `span`.
Only valid for the `plain` highlighter. + /// + /// Specifies how text should be broken up in highlight snippets: simple or span. + /// Only valid for the plain highlighter. + /// /// public HighlightDescriptor Fragmenter(Elastic.Clients.Elasticsearch.Core.Search.HighlighterFragmenter? fragmenter) { @@ -229,7 +295,9 @@ public HighlightDescriptor Fragmenter(Elastic.Clients.Elasticsearch.C } /// - /// The size of the highlighted fragment in characters. + /// + /// The size of the highlighted fragment in characters. + /// /// public HighlightDescriptor FragmentSize(int? fragmentSize) { @@ -244,7 +312,10 @@ public HighlightDescriptor HighlightFilter(bool? highlightFilter = tr } /// - /// Highlight matches for a query other than the search query.
This is especially useful if you use a rescore query because those are not taken into account by highlighting by default. + /// + /// Highlight matches for a query other than the search query. + /// This is especially useful if you use a rescore query because those are not taken into account by highlighting by default. + /// /// public HighlightDescriptor HighlightQuery(Elastic.Clients.Elasticsearch.QueryDsl.Query? highlightQuery) { @@ -271,7 +342,11 @@ public HighlightDescriptor HighlightQuery(Action - /// If set to a non-negative value, highlighting stops at this defined maximum limit.
The rest of the text is not processed, thus not highlighted and no error is returned
The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it’s set to lower value than the query setting. + /// + /// If set to a non-negative value, highlighting stops at this defined maximum limit. + /// The rest of the text is not processed, thus not highlighted and no error is returned + /// The max_analyzed_offset query setting does not override the index.highlight.max_analyzed_offset setting, which prevails when it’s set to lower value than the query setting. + /// /// public HighlightDescriptor MaxAnalyzedOffset(int? maxAnalyzedOffset) { @@ -286,7 +361,9 @@ public HighlightDescriptor MaxFragmentLength(int? maxFragmentLength) } /// - /// The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. + /// + /// The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. + /// /// public HighlightDescriptor NoMatchSize(int? noMatchSize) { @@ -295,7 +372,13 @@ public HighlightDescriptor NoMatchSize(int? noMatchSize) } /// - /// The maximum number of fragments to return.
If the number of fragments is set to `0`, no fragments are returned.
Instead, the entire field contents are highlighted and returned.
This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required.
If `number_of_fragments` is `0`, `fragment_size` is ignored. + /// + /// The maximum number of fragments to return. + /// If the number of fragments is set to 0, no fragments are returned. + /// Instead, the entire field contents are highlighted and returned. + /// This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. + /// If number_of_fragments is 0, fragment_size is ignored. + /// /// public HighlightDescriptor NumberOfFragments(int? numberOfFragments) { @@ -310,7 +393,12 @@ public HighlightDescriptor Options(Func - /// Sorts highlighted fragments by score when set to `score`.
By default, fragments will be output in the order they appear in the field (order: `none`).
Setting this option to `score` will output the most relevant fragments first.
Each highlighter applies its own logic to compute relevancy scores. + /// + /// Sorts highlighted fragments by score when set to score. + /// By default, fragments will be output in the order they appear in the field (order: none). + /// Setting this option to score will output the most relevant fragments first. + /// Each highlighter applies its own logic to compute relevancy scores. + /// /// public HighlightDescriptor Order(Elastic.Clients.Elasticsearch.Core.Search.HighlighterOrder? order) { @@ -319,7 +407,12 @@ public HighlightDescriptor Order(Elastic.Clients.Elasticsearch.Core.S } /// - /// Controls the number of matching phrases in a document that are considered.
Prevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory.
When using `matched_fields`, `phrase_limit` phrases per matched field are considered. Raising the limit increases query time and consumes more memory.
Only supported by the `fvh` highlighter. + /// + /// Controls the number of matching phrases in a document that are considered. + /// Prevents the fvh highlighter from analyzing too many phrases and consuming too much memory. + /// When using matched_fields, phrase_limit phrases per matched field are considered. Raising the limit increases query time and consumes more memory. + /// Only supported by the fvh highlighter. + /// /// public HighlightDescriptor PhraseLimit(int? phraseLimit) { @@ -328,7 +421,10 @@ public HighlightDescriptor PhraseLimit(int? phraseLimit) } /// - /// Use in conjunction with `pre_tags` to define the HTML tags to use for the highlighted text.
By default, highlighted text is wrapped in `` and `` tags. + /// + /// Use in conjunction with pre_tags to define the HTML tags to use for the highlighted text. + /// By default, highlighted text is wrapped in <em> and </em> tags. + /// /// public HighlightDescriptor PostTags(ICollection? postTags) { @@ -337,7 +433,10 @@ public HighlightDescriptor PostTags(ICollection? postTags) } /// - /// Use in conjunction with `post_tags` to define the HTML tags to use for the highlighted text.
By default, highlighted text is wrapped in `` and `` tags. + /// + /// Use in conjunction with post_tags to define the HTML tags to use for the highlighted text. + /// By default, highlighted text is wrapped in <em> and </em> tags. + /// /// public HighlightDescriptor PreTags(ICollection? preTags) { @@ -346,7 +445,10 @@ public HighlightDescriptor PreTags(ICollection? preTags) } /// - /// By default, only fields that contains a query match are highlighted.
Set to `false` to highlight all fields. + /// + /// By default, only fields that contains a query match are highlighted. + /// Set to false to highlight all fields. + /// /// public HighlightDescriptor RequireFieldMatch(bool? requireFieldMatch = true) { @@ -355,7 +457,9 @@ public HighlightDescriptor RequireFieldMatch(bool? requireFieldMatch } /// - /// Set to `styled` to use the built-in tag schema. + /// + /// Set to styled to use the built-in tag schema. + /// /// public HighlightDescriptor TagsSchema(Elastic.Clients.Elasticsearch.Core.Search.HighlighterTagsSchema? tagsSchema) { @@ -548,7 +652,9 @@ public HighlightDescriptor() : base() private Elastic.Clients.Elasticsearch.Core.Search.HighlighterType? TypeValue { get; set; } /// - /// A string that contains each boundary character. + /// + /// A string that contains each boundary character. + /// /// public HighlightDescriptor BoundaryChars(string? boundaryChars) { @@ -557,7 +663,9 @@ public HighlightDescriptor BoundaryChars(string? boundaryChars) } /// - /// How far to scan for boundary characters. + /// + /// How far to scan for boundary characters. + /// /// public HighlightDescriptor BoundaryMaxScan(int? boundaryMaxScan) { @@ -566,7 +674,11 @@ public HighlightDescriptor BoundaryMaxScan(int? boundaryMaxScan) } /// - /// Specifies how to break the highlighted fragments: chars, sentence, or word.
Only valid for the unified and fvh highlighters.
Defaults to `sentence` for the `unified` highlighter. Defaults to `chars` for the `fvh` highlighter. + /// + /// Specifies how to break the highlighted fragments: chars, sentence, or word. + /// Only valid for the unified and fvh highlighters. + /// Defaults to sentence for the unified highlighter. Defaults to chars for the fvh highlighter. + /// /// public HighlightDescriptor BoundaryScanner(Elastic.Clients.Elasticsearch.Core.Search.BoundaryScanner? boundaryScanner) { @@ -575,7 +687,10 @@ public HighlightDescriptor BoundaryScanner(Elastic.Clients.Elasticsearch.Core.Se } /// - /// Controls which locale is used to search for sentence and word boundaries.
This parameter takes a form of a language tag, for example: `"en-US"`, `"fr-FR"`, `"ja-JP"`. + /// + /// Controls which locale is used to search for sentence and word boundaries. + /// This parameter takes a form of a language tag, for example: "en-US", "fr-FR", "ja-JP". + /// /// public HighlightDescriptor BoundaryScannerLocale(string? boundaryScannerLocale) { @@ -596,7 +711,10 @@ public HighlightDescriptor Fields(Func - /// Specifies how text should be broken up in highlight snippets: `simple` or `span`.
Only valid for the `plain` highlighter. + /// + /// Specifies how text should be broken up in highlight snippets: simple or span. + /// Only valid for the plain highlighter. + /// /// public HighlightDescriptor Fragmenter(Elastic.Clients.Elasticsearch.Core.Search.HighlighterFragmenter? fragmenter) { @@ -605,7 +723,9 @@ public HighlightDescriptor Fragmenter(Elastic.Clients.Elasticsearch.Core.Search. } /// - /// The size of the highlighted fragment in characters. + /// + /// The size of the highlighted fragment in characters. + /// /// public HighlightDescriptor FragmentSize(int? fragmentSize) { @@ -620,7 +740,10 @@ public HighlightDescriptor HighlightFilter(bool? highlightFilter = true) } /// - /// Highlight matches for a query other than the search query.
This is especially useful if you use a rescore query because those are not taken into account by highlighting by default. + /// + /// Highlight matches for a query other than the search query. + /// This is especially useful if you use a rescore query because those are not taken into account by highlighting by default. + /// /// public HighlightDescriptor HighlightQuery(Elastic.Clients.Elasticsearch.QueryDsl.Query? highlightQuery) { @@ -647,7 +770,11 @@ public HighlightDescriptor HighlightQuery(Action - /// If set to a non-negative value, highlighting stops at this defined maximum limit.
The rest of the text is not processed, thus not highlighted and no error is returned
The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it’s set to lower value than the query setting. + /// + /// If set to a non-negative value, highlighting stops at this defined maximum limit. + /// The rest of the text is not processed, thus not highlighted and no error is returned + /// The max_analyzed_offset query setting does not override the index.highlight.max_analyzed_offset setting, which prevails when it’s set to lower value than the query setting. + /// /// public HighlightDescriptor MaxAnalyzedOffset(int? maxAnalyzedOffset) { @@ -662,7 +789,9 @@ public HighlightDescriptor MaxFragmentLength(int? maxFragmentLength) } /// - /// The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. + /// + /// The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. + /// /// public HighlightDescriptor NoMatchSize(int? noMatchSize) { @@ -671,7 +800,13 @@ public HighlightDescriptor NoMatchSize(int? noMatchSize) } /// - /// The maximum number of fragments to return.
If the number of fragments is set to `0`, no fragments are returned.
Instead, the entire field contents are highlighted and returned.
This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required.
If `number_of_fragments` is `0`, `fragment_size` is ignored. + /// + /// The maximum number of fragments to return. + /// If the number of fragments is set to 0, no fragments are returned. + /// Instead, the entire field contents are highlighted and returned. + /// This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. + /// If number_of_fragments is 0, fragment_size is ignored. + /// /// public HighlightDescriptor NumberOfFragments(int? numberOfFragments) { @@ -686,7 +821,12 @@ public HighlightDescriptor Options(Func, Fluent } /// - /// Sorts highlighted fragments by score when set to `score`.
By default, fragments will be output in the order they appear in the field (order: `none`).
Setting this option to `score` will output the most relevant fragments first.
Each highlighter applies its own logic to compute relevancy scores. + /// + /// Sorts highlighted fragments by score when set to score. + /// By default, fragments will be output in the order they appear in the field (order: none). + /// Setting this option to score will output the most relevant fragments first. + /// Each highlighter applies its own logic to compute relevancy scores. + /// /// public HighlightDescriptor Order(Elastic.Clients.Elasticsearch.Core.Search.HighlighterOrder? order) { @@ -695,7 +835,12 @@ public HighlightDescriptor Order(Elastic.Clients.Elasticsearch.Core.Search.Highl } /// - /// Controls the number of matching phrases in a document that are considered.
Prevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory.
When using `matched_fields`, `phrase_limit` phrases per matched field are considered. Raising the limit increases query time and consumes more memory.
Only supported by the `fvh` highlighter. + /// + /// Controls the number of matching phrases in a document that are considered. + /// Prevents the fvh highlighter from analyzing too many phrases and consuming too much memory. + /// When using matched_fields, phrase_limit phrases per matched field are considered. Raising the limit increases query time and consumes more memory. + /// Only supported by the fvh highlighter. + /// /// public HighlightDescriptor PhraseLimit(int? phraseLimit) { @@ -704,7 +849,10 @@ public HighlightDescriptor PhraseLimit(int? phraseLimit) } /// - /// Use in conjunction with `pre_tags` to define the HTML tags to use for the highlighted text.
By default, highlighted text is wrapped in `` and `` tags. + /// + /// Use in conjunction with pre_tags to define the HTML tags to use for the highlighted text. + /// By default, highlighted text is wrapped in <em> and </em> tags. + /// /// public HighlightDescriptor PostTags(ICollection? postTags) { @@ -713,7 +861,10 @@ public HighlightDescriptor PostTags(ICollection? postTags) } /// - /// Use in conjunction with `post_tags` to define the HTML tags to use for the highlighted text.
By default, highlighted text is wrapped in `` and `` tags. + /// + /// Use in conjunction with post_tags to define the HTML tags to use for the highlighted text. + /// By default, highlighted text is wrapped in <em> and </em> tags. + /// /// public HighlightDescriptor PreTags(ICollection? preTags) { @@ -722,7 +873,10 @@ public HighlightDescriptor PreTags(ICollection? preTags) } /// - /// By default, only fields that contains a query match are highlighted.
Set to `false` to highlight all fields. + /// + /// By default, only fields that contains a query match are highlighted. + /// Set to false to highlight all fields. + /// /// public HighlightDescriptor RequireFieldMatch(bool? requireFieldMatch = true) { @@ -731,7 +885,9 @@ public HighlightDescriptor RequireFieldMatch(bool? requireFieldMatch = true) } /// - /// Set to `styled` to use the built-in tag schema. + /// + /// Set to styled to use the built-in tag schema. + /// /// public HighlightDescriptor TagsSchema(Elastic.Clients.Elasticsearch.Core.Search.HighlighterTagsSchema? tagsSchema) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/HighlightField.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/HighlightField.g.cs index e7bdb7cc7c3..973bd53575a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/HighlightField.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/HighlightField.g.cs @@ -33,31 +33,45 @@ public sealed partial class HighlightField public Elastic.Clients.Elasticsearch.Analysis.IAnalyzer? Analyzer { get; set; } /// - /// A string that contains each boundary character. + /// + /// A string that contains each boundary character. + /// /// [JsonInclude, JsonPropertyName("boundary_chars")] public string? BoundaryChars { get; set; } /// - /// How far to scan for boundary characters. + /// + /// How far to scan for boundary characters. + /// /// [JsonInclude, JsonPropertyName("boundary_max_scan")] public int? BoundaryMaxScan { get; set; } /// - /// Specifies how to break the highlighted fragments: chars, sentence, or word.
Only valid for the unified and fvh highlighters.
Defaults to `sentence` for the `unified` highlighter. Defaults to `chars` for the `fvh` highlighter. + /// + /// Specifies how to break the highlighted fragments: chars, sentence, or word. + /// Only valid for the unified and fvh highlighters. + /// Defaults to sentence for the unified highlighter. Defaults to chars for the fvh highlighter. + /// /// [JsonInclude, JsonPropertyName("boundary_scanner")] public Elastic.Clients.Elasticsearch.Core.Search.BoundaryScanner? BoundaryScanner { get; set; } /// - /// Controls which locale is used to search for sentence and word boundaries.
This parameter takes a form of a language tag, for example: `"en-US"`, `"fr-FR"`, `"ja-JP"`. + /// + /// Controls which locale is used to search for sentence and word boundaries. + /// This parameter takes a form of a language tag, for example: "en-US", "fr-FR", "ja-JP". + /// /// [JsonInclude, JsonPropertyName("boundary_scanner_locale")] public string? BoundaryScannerLocale { get; set; } /// - /// Specifies how text should be broken up in highlight snippets: `simple` or `span`.
Only valid for the `plain` highlighter. + /// + /// Specifies how text should be broken up in highlight snippets: simple or span. + /// Only valid for the plain highlighter. + /// /// [JsonInclude, JsonPropertyName("fragmenter")] public Elastic.Clients.Elasticsearch.Core.Search.HighlighterFragmenter? Fragmenter { get; set; } @@ -65,7 +79,9 @@ public sealed partial class HighlightField public int? FragmentOffset { get; set; } /// - /// The size of the highlighted fragment in characters. + /// + /// The size of the highlighted fragment in characters. + /// /// [JsonInclude, JsonPropertyName("fragment_size")] public int? FragmentSize { get; set; } @@ -73,7 +89,10 @@ public sealed partial class HighlightField public bool? HighlightFilter { get; set; } /// - /// Highlight matches for a query other than the search query.
This is especially useful if you use a rescore query because those are not taken into account by highlighting by default. + /// + /// Highlight matches for a query other than the search query. + /// This is especially useful if you use a rescore query because those are not taken into account by highlighting by default. + /// /// [JsonInclude, JsonPropertyName("highlight_query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? HighlightQuery { get; set; } @@ -82,7 +101,11 @@ public sealed partial class HighlightField public Elastic.Clients.Elasticsearch.Fields? MatchedFields { get; set; } /// - /// If set to a non-negative value, highlighting stops at this defined maximum limit.
The rest of the text is not processed, thus not highlighted and no error is returned
The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it’s set to lower value than the query setting. + /// + /// If set to a non-negative value, highlighting stops at this defined maximum limit. + /// The rest of the text is not processed, thus not highlighted and no error is returned + /// The max_analyzed_offset query setting does not override the index.highlight.max_analyzed_offset setting, which prevails when it’s set to lower value than the query setting. + /// /// [JsonInclude, JsonPropertyName("max_analyzed_offset")] public int? MaxAnalyzedOffset { get; set; } @@ -90,13 +113,21 @@ public sealed partial class HighlightField public int? MaxFragmentLength { get; set; } /// - /// The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. + /// + /// The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. + /// /// [JsonInclude, JsonPropertyName("no_match_size")] public int? NoMatchSize { get; set; } /// - /// The maximum number of fragments to return.
If the number of fragments is set to `0`, no fragments are returned.
Instead, the entire field contents are highlighted and returned.
This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required.
If `number_of_fragments` is `0`, `fragment_size` is ignored. + /// + /// The maximum number of fragments to return. + /// If the number of fragments is set to 0, no fragments are returned. + /// Instead, the entire field contents are highlighted and returned. + /// This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. + /// If number_of_fragments is 0, fragment_size is ignored. + /// /// [JsonInclude, JsonPropertyName("number_of_fragments")] public int? NumberOfFragments { get; set; } @@ -104,37 +135,58 @@ public sealed partial class HighlightField public IDictionary? Options { get; set; } /// - /// Sorts highlighted fragments by score when set to `score`.
By default, fragments will be output in the order they appear in the field (order: `none`).
Setting this option to `score` will output the most relevant fragments first.
Each highlighter applies its own logic to compute relevancy scores. + /// + /// Sorts highlighted fragments by score when set to score. + /// By default, fragments will be output in the order they appear in the field (order: none). + /// Setting this option to score will output the most relevant fragments first. + /// Each highlighter applies its own logic to compute relevancy scores. + /// /// [JsonInclude, JsonPropertyName("order")] public Elastic.Clients.Elasticsearch.Core.Search.HighlighterOrder? Order { get; set; } /// - /// Controls the number of matching phrases in a document that are considered.
Prevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory.
When using `matched_fields`, `phrase_limit` phrases per matched field are considered. Raising the limit increases query time and consumes more memory.
Only supported by the `fvh` highlighter. + /// + /// Controls the number of matching phrases in a document that are considered. + /// Prevents the fvh highlighter from analyzing too many phrases and consuming too much memory. + /// When using matched_fields, phrase_limit phrases per matched field are considered. Raising the limit increases query time and consumes more memory. + /// Only supported by the fvh highlighter. + /// /// [JsonInclude, JsonPropertyName("phrase_limit")] public int? PhraseLimit { get; set; } /// - /// Use in conjunction with `pre_tags` to define the HTML tags to use for the highlighted text.
By default, highlighted text is wrapped in `` and `` tags. + /// + /// Use in conjunction with pre_tags to define the HTML tags to use for the highlighted text. + /// By default, highlighted text is wrapped in <em> and </em> tags. + /// /// [JsonInclude, JsonPropertyName("post_tags")] public ICollection? PostTags { get; set; } /// - /// Use in conjunction with `post_tags` to define the HTML tags to use for the highlighted text.
By default, highlighted text is wrapped in `` and `` tags. + /// + /// Use in conjunction with post_tags to define the HTML tags to use for the highlighted text. + /// By default, highlighted text is wrapped in <em> and </em> tags. + /// /// [JsonInclude, JsonPropertyName("pre_tags")] public ICollection? PreTags { get; set; } /// - /// By default, only fields that contains a query match are highlighted.
Set to `false` to highlight all fields. + /// + /// By default, only fields that contains a query match are highlighted. + /// Set to false to highlight all fields. + /// /// [JsonInclude, JsonPropertyName("require_field_match")] public bool? RequireFieldMatch { get; set; } /// - /// Set to `styled` to use the built-in tag schema. + /// + /// Set to styled to use the built-in tag schema. + /// /// [JsonInclude, JsonPropertyName("tags_schema")] public Elastic.Clients.Elasticsearch.Core.Search.HighlighterTagsSchema? TagsSchema { get; set; } @@ -183,7 +235,9 @@ public HighlightFieldDescriptor Analyzer(Elastic.Clients.Elasticsearc } /// - /// A string that contains each boundary character. + /// + /// A string that contains each boundary character. + /// /// public HighlightFieldDescriptor BoundaryChars(string? boundaryChars) { @@ -192,7 +246,9 @@ public HighlightFieldDescriptor BoundaryChars(string? boundaryChars) } /// - /// How far to scan for boundary characters. + /// + /// How far to scan for boundary characters. + /// /// public HighlightFieldDescriptor BoundaryMaxScan(int? boundaryMaxScan) { @@ -201,7 +257,11 @@ public HighlightFieldDescriptor BoundaryMaxScan(int? boundaryMaxScan) } /// - /// Specifies how to break the highlighted fragments: chars, sentence, or word.
Only valid for the unified and fvh highlighters.
Defaults to `sentence` for the `unified` highlighter. Defaults to `chars` for the `fvh` highlighter. + /// + /// Specifies how to break the highlighted fragments: chars, sentence, or word. + /// Only valid for the unified and fvh highlighters. + /// Defaults to sentence for the unified highlighter. Defaults to chars for the fvh highlighter. + /// /// public HighlightFieldDescriptor BoundaryScanner(Elastic.Clients.Elasticsearch.Core.Search.BoundaryScanner? boundaryScanner) { @@ -210,7 +270,10 @@ public HighlightFieldDescriptor BoundaryScanner(Elastic.Clients.Elast } /// - /// Controls which locale is used to search for sentence and word boundaries.
This parameter takes a form of a language tag, for example: `"en-US"`, `"fr-FR"`, `"ja-JP"`. + /// + /// Controls which locale is used to search for sentence and word boundaries. + /// This parameter takes a form of a language tag, for example: "en-US", "fr-FR", "ja-JP". + /// /// public HighlightFieldDescriptor BoundaryScannerLocale(string? boundaryScannerLocale) { @@ -219,7 +282,10 @@ public HighlightFieldDescriptor BoundaryScannerLocale(string? boundar } /// - /// Specifies how text should be broken up in highlight snippets: `simple` or `span`.
Only valid for the `plain` highlighter. + /// + /// Specifies how text should be broken up in highlight snippets: simple or span. + /// Only valid for the plain highlighter. + /// /// public HighlightFieldDescriptor Fragmenter(Elastic.Clients.Elasticsearch.Core.Search.HighlighterFragmenter? fragmenter) { @@ -234,7 +300,9 @@ public HighlightFieldDescriptor FragmentOffset(int? fragmentOffset) } /// - /// The size of the highlighted fragment in characters. + /// + /// The size of the highlighted fragment in characters. + /// /// public HighlightFieldDescriptor FragmentSize(int? fragmentSize) { @@ -249,7 +317,10 @@ public HighlightFieldDescriptor HighlightFilter(bool? highlightFilter } /// - /// Highlight matches for a query other than the search query.
This is especially useful if you use a rescore query because those are not taken into account by highlighting by default. + /// + /// Highlight matches for a query other than the search query. + /// This is especially useful if you use a rescore query because those are not taken into account by highlighting by default. + /// /// public HighlightFieldDescriptor HighlightQuery(Elastic.Clients.Elasticsearch.QueryDsl.Query? highlightQuery) { @@ -282,7 +353,11 @@ public HighlightFieldDescriptor MatchedFields(Elastic.Clients.Elastic } /// - /// If set to a non-negative value, highlighting stops at this defined maximum limit.
The rest of the text is not processed, thus not highlighted and no error is returned
The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it’s set to lower value than the query setting. + /// + /// If set to a non-negative value, highlighting stops at this defined maximum limit. + /// The rest of the text is not processed, thus not highlighted and no error is returned + /// The max_analyzed_offset query setting does not override the index.highlight.max_analyzed_offset setting, which prevails when it’s set to lower value than the query setting. + /// /// public HighlightFieldDescriptor MaxAnalyzedOffset(int? maxAnalyzedOffset) { @@ -297,7 +372,9 @@ public HighlightFieldDescriptor MaxFragmentLength(int? maxFragmentLen } /// - /// The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. + /// + /// The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. + /// /// public HighlightFieldDescriptor NoMatchSize(int? noMatchSize) { @@ -306,7 +383,13 @@ public HighlightFieldDescriptor NoMatchSize(int? noMatchSize) } /// - /// The maximum number of fragments to return.
If the number of fragments is set to `0`, no fragments are returned.
Instead, the entire field contents are highlighted and returned.
This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required.
If `number_of_fragments` is `0`, `fragment_size` is ignored. + /// + /// The maximum number of fragments to return. + /// If the number of fragments is set to 0, no fragments are returned. + /// Instead, the entire field contents are highlighted and returned. + /// This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. + /// If number_of_fragments is 0, fragment_size is ignored. + /// /// public HighlightFieldDescriptor NumberOfFragments(int? numberOfFragments) { @@ -321,7 +404,12 @@ public HighlightFieldDescriptor Options(Func - /// Sorts highlighted fragments by score when set to `score`.
By default, fragments will be output in the order they appear in the field (order: `none`).
Setting this option to `score` will output the most relevant fragments first.
Each highlighter applies its own logic to compute relevancy scores. + /// + /// Sorts highlighted fragments by score when set to score. + /// By default, fragments will be output in the order they appear in the field (order: none). + /// Setting this option to score will output the most relevant fragments first. + /// Each highlighter applies its own logic to compute relevancy scores. + /// /// public HighlightFieldDescriptor Order(Elastic.Clients.Elasticsearch.Core.Search.HighlighterOrder? order) { @@ -330,7 +418,12 @@ public HighlightFieldDescriptor Order(Elastic.Clients.Elasticsearch.C } /// - /// Controls the number of matching phrases in a document that are considered.
Prevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory.
When using `matched_fields`, `phrase_limit` phrases per matched field are considered. Raising the limit increases query time and consumes more memory.
Only supported by the `fvh` highlighter. + /// + /// Controls the number of matching phrases in a document that are considered. + /// Prevents the fvh highlighter from analyzing too many phrases and consuming too much memory. + /// When using matched_fields, phrase_limit phrases per matched field are considered. Raising the limit increases query time and consumes more memory. + /// Only supported by the fvh highlighter. + /// /// public HighlightFieldDescriptor PhraseLimit(int? phraseLimit) { @@ -339,7 +432,10 @@ public HighlightFieldDescriptor PhraseLimit(int? phraseLimit) } /// - /// Use in conjunction with `pre_tags` to define the HTML tags to use for the highlighted text.
By default, highlighted text is wrapped in `` and `` tags. + /// + /// Use in conjunction with pre_tags to define the HTML tags to use for the highlighted text. + /// By default, highlighted text is wrapped in <em> and </em> tags. + /// /// public HighlightFieldDescriptor PostTags(ICollection? postTags) { @@ -348,7 +444,10 @@ public HighlightFieldDescriptor PostTags(ICollection? postTag } /// - /// Use in conjunction with `post_tags` to define the HTML tags to use for the highlighted text.
By default, highlighted text is wrapped in `` and `` tags. + /// + /// Use in conjunction with post_tags to define the HTML tags to use for the highlighted text. + /// By default, highlighted text is wrapped in <em> and </em> tags. + /// /// public HighlightFieldDescriptor PreTags(ICollection? preTags) { @@ -357,7 +456,10 @@ public HighlightFieldDescriptor PreTags(ICollection? preTags) } /// - /// By default, only fields that contains a query match are highlighted.
Set to `false` to highlight all fields. + /// + /// By default, only fields that contains a query match are highlighted. + /// Set to false to highlight all fields. + /// /// public HighlightFieldDescriptor RequireFieldMatch(bool? requireFieldMatch = true) { @@ -366,7 +468,9 @@ public HighlightFieldDescriptor RequireFieldMatch(bool? requireFieldM } /// - /// Set to `styled` to use the built-in tag schema. + /// + /// Set to styled to use the built-in tag schema. + /// /// public HighlightFieldDescriptor TagsSchema(Elastic.Clients.Elasticsearch.Core.Search.HighlighterTagsSchema? tagsSchema) { @@ -576,7 +680,9 @@ public HighlightFieldDescriptor Analyzer(Elastic.Clients.Elasticsearch.Analysis. } /// - /// A string that contains each boundary character. + /// + /// A string that contains each boundary character. + /// /// public HighlightFieldDescriptor BoundaryChars(string? boundaryChars) { @@ -585,7 +691,9 @@ public HighlightFieldDescriptor BoundaryChars(string? boundaryChars) } /// - /// How far to scan for boundary characters. + /// + /// How far to scan for boundary characters. + /// /// public HighlightFieldDescriptor BoundaryMaxScan(int? boundaryMaxScan) { @@ -594,7 +702,11 @@ public HighlightFieldDescriptor BoundaryMaxScan(int? boundaryMaxScan) } /// - /// Specifies how to break the highlighted fragments: chars, sentence, or word.
Only valid for the unified and fvh highlighters.
Defaults to `sentence` for the `unified` highlighter. Defaults to `chars` for the `fvh` highlighter. + /// + /// Specifies how to break the highlighted fragments: chars, sentence, or word. + /// Only valid for the unified and fvh highlighters. + /// Defaults to sentence for the unified highlighter. Defaults to chars for the fvh highlighter. + /// /// public HighlightFieldDescriptor BoundaryScanner(Elastic.Clients.Elasticsearch.Core.Search.BoundaryScanner? boundaryScanner) { @@ -603,7 +715,10 @@ public HighlightFieldDescriptor BoundaryScanner(Elastic.Clients.Elasticsearch.Co } /// - /// Controls which locale is used to search for sentence and word boundaries.
This parameter takes a form of a language tag, for example: `"en-US"`, `"fr-FR"`, `"ja-JP"`. + /// + /// Controls which locale is used to search for sentence and word boundaries. + /// This parameter takes a form of a language tag, for example: "en-US", "fr-FR", "ja-JP". + /// /// public HighlightFieldDescriptor BoundaryScannerLocale(string? boundaryScannerLocale) { @@ -612,7 +727,10 @@ public HighlightFieldDescriptor BoundaryScannerLocale(string? boundaryScannerLoc } /// - /// Specifies how text should be broken up in highlight snippets: `simple` or `span`.
Only valid for the `plain` highlighter. + /// + /// Specifies how text should be broken up in highlight snippets: simple or span. + /// Only valid for the plain highlighter. + /// /// public HighlightFieldDescriptor Fragmenter(Elastic.Clients.Elasticsearch.Core.Search.HighlighterFragmenter? fragmenter) { @@ -627,7 +745,9 @@ public HighlightFieldDescriptor FragmentOffset(int? fragmentOffset) } /// - /// The size of the highlighted fragment in characters. + /// + /// The size of the highlighted fragment in characters. + /// /// public HighlightFieldDescriptor FragmentSize(int? fragmentSize) { @@ -642,7 +762,10 @@ public HighlightFieldDescriptor HighlightFilter(bool? highlightFilter = true) } /// - /// Highlight matches for a query other than the search query.
This is especially useful if you use a rescore query because those are not taken into account by highlighting by default. + /// + /// Highlight matches for a query other than the search query. + /// This is especially useful if you use a rescore query because those are not taken into account by highlighting by default. + /// /// public HighlightFieldDescriptor HighlightQuery(Elastic.Clients.Elasticsearch.QueryDsl.Query? highlightQuery) { @@ -675,7 +798,11 @@ public HighlightFieldDescriptor MatchedFields(Elastic.Clients.Elasticsearch.Fiel } /// - /// If set to a non-negative value, highlighting stops at this defined maximum limit.
The rest of the text is not processed, thus not highlighted and no error is returned
The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it’s set to lower value than the query setting. + /// + /// If set to a non-negative value, highlighting stops at this defined maximum limit. + /// The rest of the text is not processed, thus not highlighted and no error is returned + /// The max_analyzed_offset query setting does not override the index.highlight.max_analyzed_offset setting, which prevails when it’s set to lower value than the query setting. + /// /// public HighlightFieldDescriptor MaxAnalyzedOffset(int? maxAnalyzedOffset) { @@ -690,7 +817,9 @@ public HighlightFieldDescriptor MaxFragmentLength(int? maxFragmentLength) } /// - /// The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. + /// + /// The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. + /// /// public HighlightFieldDescriptor NoMatchSize(int? noMatchSize) { @@ -699,7 +828,13 @@ public HighlightFieldDescriptor NoMatchSize(int? noMatchSize) } /// - /// The maximum number of fragments to return.
If the number of fragments is set to `0`, no fragments are returned.
Instead, the entire field contents are highlighted and returned.
This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required.
If `number_of_fragments` is `0`, `fragment_size` is ignored. + /// + /// The maximum number of fragments to return. + /// If the number of fragments is set to 0, no fragments are returned. + /// Instead, the entire field contents are highlighted and returned. + /// This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. + /// If number_of_fragments is 0, fragment_size is ignored. + /// /// public HighlightFieldDescriptor NumberOfFragments(int? numberOfFragments) { @@ -714,7 +849,12 @@ public HighlightFieldDescriptor Options(Func, F } /// - /// Sorts highlighted fragments by score when set to `score`.
By default, fragments will be output in the order they appear in the field (order: `none`).
Setting this option to `score` will output the most relevant fragments first.
Each highlighter applies its own logic to compute relevancy scores. + /// + /// Sorts highlighted fragments by score when set to score. + /// By default, fragments will be output in the order they appear in the field (order: none). + /// Setting this option to score will output the most relevant fragments first. + /// Each highlighter applies its own logic to compute relevancy scores. + /// /// public HighlightFieldDescriptor Order(Elastic.Clients.Elasticsearch.Core.Search.HighlighterOrder? order) { @@ -723,7 +863,12 @@ public HighlightFieldDescriptor Order(Elastic.Clients.Elasticsearch.Core.Search. } /// - /// Controls the number of matching phrases in a document that are considered.
Prevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory.
When using `matched_fields`, `phrase_limit` phrases per matched field are considered. Raising the limit increases query time and consumes more memory.
Only supported by the `fvh` highlighter. + /// + /// Controls the number of matching phrases in a document that are considered. + /// Prevents the fvh highlighter from analyzing too many phrases and consuming too much memory. + /// When using matched_fields, phrase_limit phrases per matched field are considered. Raising the limit increases query time and consumes more memory. + /// Only supported by the fvh highlighter. + /// /// public HighlightFieldDescriptor PhraseLimit(int? phraseLimit) { @@ -732,7 +877,10 @@ public HighlightFieldDescriptor PhraseLimit(int? phraseLimit) } /// - /// Use in conjunction with `pre_tags` to define the HTML tags to use for the highlighted text.
By default, highlighted text is wrapped in `` and `` tags. + /// + /// Use in conjunction with pre_tags to define the HTML tags to use for the highlighted text. + /// By default, highlighted text is wrapped in <em> and </em> tags. + /// /// public HighlightFieldDescriptor PostTags(ICollection? postTags) { @@ -741,7 +889,10 @@ public HighlightFieldDescriptor PostTags(ICollection? postTags) } /// - /// Use in conjunction with `post_tags` to define the HTML tags to use for the highlighted text.
By default, highlighted text is wrapped in `` and `` tags. + /// + /// Use in conjunction with post_tags to define the HTML tags to use for the highlighted text. + /// By default, highlighted text is wrapped in <em> and </em> tags. + /// /// public HighlightFieldDescriptor PreTags(ICollection? preTags) { @@ -750,7 +901,10 @@ public HighlightFieldDescriptor PreTags(ICollection? preTags) } /// - /// By default, only fields that contains a query match are highlighted.
Set to `false` to highlight all fields. + /// + /// By default, only fields that contains a query match are highlighted. + /// Set to false to highlight all fields. + /// /// public HighlightFieldDescriptor RequireFieldMatch(bool? requireFieldMatch = true) { @@ -759,7 +913,9 @@ public HighlightFieldDescriptor RequireFieldMatch(bool? requireFieldMatch = true } /// - /// Set to `styled` to use the built-in tag schema. + /// + /// Set to styled to use the built-in tag schema. + /// /// public HighlightFieldDescriptor TagsSchema(Elastic.Clients.Elasticsearch.Core.Search.HighlighterTagsSchema? tagsSchema) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/HitsMetadata.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/HitsMetadata.g.cs index 91fd4e06a0b..78f5579d8de 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/HitsMetadata.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/HitsMetadata.g.cs @@ -35,7 +35,9 @@ public sealed partial class HitsMetadata public double? MaxScore { get; init; } /// - /// Total hit count information, present only if `track_total_hits` wasn't `false` in the search request. + /// + /// Total hit count information, present only if track_total_hits wasn't false in the search request. + /// /// [JsonInclude, JsonPropertyName("total")] public Union? Total { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/InnerHits.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/InnerHits.g.cs index eff79da0f2d..f896031d7d9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/InnerHits.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/InnerHits.g.cs @@ -40,7 +40,9 @@ public sealed partial class InnerHits public Elastic.Clients.Elasticsearch.Fields? Fields { get; set; } /// - /// Inner hit starting document offset. + /// + /// Inner hit starting document offset. + /// /// [JsonInclude, JsonPropertyName("from")] public int? From { get; set; } @@ -50,7 +52,10 @@ public sealed partial class InnerHits public bool? IgnoreUnmapped { get; set; } /// - /// The name for the particular inner hit definition in the response.
Useful when a search request contains multiple inner hits. + /// + /// The name for the particular inner hit definition in the response. + /// Useful when a search request contains multiple inner hits. + /// /// [JsonInclude, JsonPropertyName("name")] public Elastic.Clients.Elasticsearch.Name? Name { get; set; } @@ -60,13 +65,18 @@ public sealed partial class InnerHits public bool? SeqNoPrimaryTerm { get; set; } /// - /// The maximum number of hits to return per `inner_hits`. + /// + /// The maximum number of hits to return per inner_hits. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// How the inner hits should be sorted per `inner_hits`.
By default, inner hits are sorted by score. + /// + /// How the inner hits should be sorted per inner_hits. + /// By default, inner hits are sorted by score. + /// /// [JsonInclude, JsonPropertyName("sort")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.SortOptions))] @@ -190,7 +200,9 @@ public InnerHitsDescriptor Fields(Elastic.Clients.Elasticsearch.Field } /// - /// Inner hit starting document offset. + /// + /// Inner hit starting document offset. + /// /// public InnerHitsDescriptor From(int? from) { @@ -229,7 +241,10 @@ public InnerHitsDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true } /// - /// The name for the particular inner hit definition in the response.
Useful when a search request contains multiple inner hits. + /// + /// The name for the particular inner hit definition in the response. + /// Useful when a search request contains multiple inner hits. + /// /// public InnerHitsDescriptor Name(Elastic.Clients.Elasticsearch.Name? name) { @@ -250,7 +265,9 @@ public InnerHitsDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = } /// - /// The maximum number of hits to return per `inner_hits`. + /// + /// The maximum number of hits to return per inner_hits. + /// /// public InnerHitsDescriptor Size(int? size) { @@ -259,7 +276,10 @@ public InnerHitsDescriptor Size(int? size) } /// - /// How the inner hits should be sorted per `inner_hits`.
By default, inner hits are sorted by score. + /// + /// How the inner hits should be sorted per inner_hits. + /// By default, inner hits are sorted by score. + /// /// public InnerHitsDescriptor Sort(ICollection? sort) { @@ -600,7 +620,9 @@ public InnerHitsDescriptor Fields(Elastic.Clients.Elasticsearch.Fields? fields) } /// - /// Inner hit starting document offset. + /// + /// Inner hit starting document offset. + /// /// public InnerHitsDescriptor From(int? from) { @@ -639,7 +661,10 @@ public InnerHitsDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) } /// - /// The name for the particular inner hit definition in the response.
Useful when a search request contains multiple inner hits. + /// + /// The name for the particular inner hit definition in the response. + /// Useful when a search request contains multiple inner hits. + /// /// public InnerHitsDescriptor Name(Elastic.Clients.Elasticsearch.Name? name) { @@ -660,7 +685,9 @@ public InnerHitsDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = true) } /// - /// The maximum number of hits to return per `inner_hits`. + /// + /// The maximum number of hits to return per inner_hits. + /// /// public InnerHitsDescriptor Size(int? size) { @@ -669,7 +696,10 @@ public InnerHitsDescriptor Size(int? size) } /// - /// How the inner hits should be sorted per `inner_hits`.
By default, inner hits are sorted by score. + /// + /// How the inner hits should be sorted per inner_hits. + /// By default, inner hits are sorted by score. + /// /// public InnerHitsDescriptor Sort(ICollection? sort) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/LaplaceSmoothingModel.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/LaplaceSmoothingModel.g.cs index 9d4bc0f501a..6b52da5cfb0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/LaplaceSmoothingModel.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/LaplaceSmoothingModel.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Core.Search; public sealed partial class LaplaceSmoothingModel { /// - /// A constant that is added to all counts to balance weights. + /// + /// A constant that is added to all counts to balance weights. + /// /// [JsonInclude, JsonPropertyName("alpha")] public double Alpha { get; set; } @@ -49,7 +51,9 @@ public LaplaceSmoothingModelDescriptor() : base() private double AlphaValue { get; set; } /// - /// A constant that is added to all counts to balance weights. + /// + /// A constant that is added to all counts to balance weights. + /// /// public LaplaceSmoothingModelDescriptor Alpha(double alpha) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/LearningToRank.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/LearningToRank.g.cs index 49d52298813..f40e62d4290 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/LearningToRank.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/LearningToRank.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Core.Search; public sealed partial class LearningToRank { /// - /// The unique identifier of the trained model uploaded to Elasticsearch + /// + /// The unique identifier of the trained model uploaded to Elasticsearch + /// /// [JsonInclude, JsonPropertyName("model_id")] public string ModelId { get; set; } /// - /// Named parameters to be passed to the query templates used for feature + /// + /// Named parameters to be passed to the query templates used for feature + /// /// [JsonInclude, JsonPropertyName("params")] public IDictionary? Params { get; set; } @@ -56,7 +60,9 @@ public LearningToRankDescriptor() : base() private IDictionary? ParamsValue { get; set; } /// - /// The unique identifier of the trained model uploaded to Elasticsearch + /// + /// The unique identifier of the trained model uploaded to Elasticsearch + /// /// public LearningToRankDescriptor ModelId(string modelId) { @@ -65,7 +71,9 @@ public LearningToRankDescriptor ModelId(string modelId) } /// - /// Named parameters to be passed to the query templates used for feature + /// + /// Named parameters to be passed to the query templates used for feature + /// /// public LearningToRankDescriptor Params(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/PhraseSuggestCollate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/PhraseSuggestCollate.g.cs index 08714bfc153..326b084edbb 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/PhraseSuggestCollate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/PhraseSuggestCollate.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Core.Search; public sealed partial class PhraseSuggestCollate { /// - /// Parameters to use if the query is templated. + /// + /// Parameters to use if the query is templated. + /// /// [JsonInclude, JsonPropertyName("params")] public IDictionary? Params { get; set; } /// - /// Returns all suggestions with an extra `collate_match` option indicating whether the generated phrase matched any document. + /// + /// Returns all suggestions with an extra collate_match option indicating whether the generated phrase matched any document. + /// /// [JsonInclude, JsonPropertyName("prune")] public bool? Prune { get; set; } /// - /// A collate query that is run once for every suggestion. + /// + /// A collate query that is run once for every suggestion. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.Core.Search.PhraseSuggestCollateQuery Query { get; set; } @@ -63,7 +69,9 @@ public PhraseSuggestCollateDescriptor() : base() private Action QueryDescriptorAction { get; set; } /// - /// Parameters to use if the query is templated. + /// + /// Parameters to use if the query is templated. + /// /// public PhraseSuggestCollateDescriptor Params(Func, FluentDictionary> selector) { @@ -72,7 +80,9 @@ public PhraseSuggestCollateDescriptor Params(Func - /// Returns all suggestions with an extra `collate_match` option indicating whether the generated phrase matched any document. + /// + /// Returns all suggestions with an extra collate_match option indicating whether the generated phrase matched any document. + /// /// public PhraseSuggestCollateDescriptor Prune(bool? prune = true) { @@ -81,7 +91,9 @@ public PhraseSuggestCollateDescriptor Prune(bool? prune = true) } /// - /// A collate query that is run once for every suggestion. + /// + /// A collate query that is run once for every suggestion. + /// /// public PhraseSuggestCollateDescriptor Query(Elastic.Clients.Elasticsearch.Core.Search.PhraseSuggestCollateQuery query) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/PhraseSuggestCollateQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/PhraseSuggestCollateQuery.g.cs index 8b18eaec54b..fc167a5cb80 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/PhraseSuggestCollateQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/PhraseSuggestCollateQuery.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Core.Search; public sealed partial class PhraseSuggestCollateQuery { /// - /// The search template ID. + /// + /// The search template ID. + /// /// [JsonInclude, JsonPropertyName("id")] public Elastic.Clients.Elasticsearch.Id? Id { get; set; } /// - /// The query source. + /// + /// The query source. + /// /// [JsonInclude, JsonPropertyName("source")] public string? Source { get; set; } @@ -54,7 +58,9 @@ public PhraseSuggestCollateQueryDescriptor() : base() private string? SourceValue { get; set; } /// - /// The search template ID. + /// + /// The search template ID. + /// /// public PhraseSuggestCollateQueryDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) { @@ -63,7 +69,9 @@ public PhraseSuggestCollateQueryDescriptor Id(Elastic.Clients.Elasticsearch.Id? } /// - /// The query source. + /// + /// The query source. + /// /// public PhraseSuggestCollateQueryDescriptor Source(string? source) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/PhraseSuggestHighlight.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/PhraseSuggestHighlight.g.cs index 9337f52bb92..c6f5d6a5e6a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/PhraseSuggestHighlight.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/PhraseSuggestHighlight.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Core.Search; public sealed partial class PhraseSuggestHighlight { /// - /// Use in conjunction with `pre_tag` to define the HTML tags to use for the highlighted text. + /// + /// Use in conjunction with pre_tag to define the HTML tags to use for the highlighted text. + /// /// [JsonInclude, JsonPropertyName("post_tag")] public string PostTag { get; set; } /// - /// Use in conjunction with `post_tag` to define the HTML tags to use for the highlighted text. + /// + /// Use in conjunction with post_tag to define the HTML tags to use for the highlighted text. + /// /// [JsonInclude, JsonPropertyName("pre_tag")] public string PreTag { get; set; } @@ -54,7 +58,9 @@ public PhraseSuggestHighlightDescriptor() : base() private string PreTagValue { get; set; } /// - /// Use in conjunction with `pre_tag` to define the HTML tags to use for the highlighted text. + /// + /// Use in conjunction with pre_tag to define the HTML tags to use for the highlighted text. + /// /// public PhraseSuggestHighlightDescriptor PostTag(string postTag) { @@ -63,7 +69,9 @@ public PhraseSuggestHighlightDescriptor PostTag(string postTag) } /// - /// Use in conjunction with `post_tag` to define the HTML tags to use for the highlighted text. + /// + /// Use in conjunction with post_tag to define the HTML tags to use for the highlighted text. + /// /// public PhraseSuggestHighlightDescriptor PreTag(string preTag) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/PhraseSuggester.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/PhraseSuggester.g.cs index 5ec2ea6a966..0c7492fe497 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/PhraseSuggester.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/PhraseSuggester.g.cs @@ -30,31 +30,44 @@ namespace Elastic.Clients.Elasticsearch.Core.Search; public sealed partial class PhraseSuggester { /// - /// The analyzer to analyze the suggest text with.
Defaults to the search analyzer of the suggest field. + /// + /// The analyzer to analyze the suggest text with. + /// Defaults to the search analyzer of the suggest field. + /// /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } /// - /// Checks each suggestion against the specified query to prune suggestions for which no matching docs exist in the index. + /// + /// Checks each suggestion against the specified query to prune suggestions for which no matching docs exist in the index. + /// /// [JsonInclude, JsonPropertyName("collate")] public Elastic.Clients.Elasticsearch.Core.Search.PhraseSuggestCollate? Collate { get; set; } /// - /// Defines a factor applied to the input phrases score, which is used as a threshold for other suggest candidates.
Only candidates that score higher than the threshold will be included in the result. + /// + /// Defines a factor applied to the input phrases score, which is used as a threshold for other suggest candidates. + /// Only candidates that score higher than the threshold will be included in the result. + /// /// [JsonInclude, JsonPropertyName("confidence")] public double? Confidence { get; set; } /// - /// A list of candidate generators that produce a list of possible terms per term in the given text. + /// + /// A list of candidate generators that produce a list of possible terms per term in the given text. + /// /// [JsonInclude, JsonPropertyName("direct_generator")] public ICollection? DirectGenerator { get; set; } /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } @@ -62,55 +75,79 @@ public sealed partial class PhraseSuggester public bool? ForceUnigrams { get; set; } /// - /// Sets max size of the n-grams (shingles) in the field.
If the field doesn’t contain n-grams (shingles), this should be omitted or set to `1`.
If the field uses a shingle filter, the `gram_size` is set to the `max_shingle_size` if not explicitly set. + /// + /// Sets max size of the n-grams (shingles) in the field. + /// If the field doesn’t contain n-grams (shingles), this should be omitted or set to 1. + /// If the field uses a shingle filter, the gram_size is set to the max_shingle_size if not explicitly set. + /// /// [JsonInclude, JsonPropertyName("gram_size")] public int? GramSize { get; set; } /// - /// Sets up suggestion highlighting.
If not provided, no highlighted field is returned. + /// + /// Sets up suggestion highlighting. + /// If not provided, no highlighted field is returned. + /// /// [JsonInclude, JsonPropertyName("highlight")] public Elastic.Clients.Elasticsearch.Core.Search.PhraseSuggestHighlight? Highlight { get; set; } /// - /// The maximum percentage of the terms considered to be misspellings in order to form a correction.
This method accepts a float value in the range `[0..1)` as a fraction of the actual query terms or a number `>=1` as an absolute number of query terms. + /// + /// The maximum percentage of the terms considered to be misspellings in order to form a correction. + /// This method accepts a float value in the range [0..1) as a fraction of the actual query terms or a number >=1 as an absolute number of query terms. + /// /// [JsonInclude, JsonPropertyName("max_errors")] public double? MaxErrors { get; set; } /// - /// The likelihood of a term being misspelled even if the term exists in the dictionary. + /// + /// The likelihood of a term being misspelled even if the term exists in the dictionary. + /// /// [JsonInclude, JsonPropertyName("real_word_error_likelihood")] public double? RealWordErrorLikelihood { get; set; } /// - /// The separator that is used to separate terms in the bigram field.
If not set, the whitespace character is used as a separator. + /// + /// The separator that is used to separate terms in the bigram field. + /// If not set, the whitespace character is used as a separator. + /// /// [JsonInclude, JsonPropertyName("separator")] public string? Separator { get; set; } /// - /// Sets the maximum number of suggested terms to be retrieved from each individual shard. + /// + /// Sets the maximum number of suggested terms to be retrieved from each individual shard. + /// /// [JsonInclude, JsonPropertyName("shard_size")] public int? ShardSize { get; set; } /// - /// The maximum corrections to be returned per suggest text token. + /// + /// The maximum corrections to be returned per suggest text token. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// The smoothing model used to balance weight between infrequent grams (grams (shingles) are not existing in the index) and frequent grams (appear at least once in the index).
The default model is Stupid Backoff. + /// + /// The smoothing model used to balance weight between infrequent grams (grams (shingles) are not existing in the index) and frequent grams (appear at least once in the index). + /// The default model is Stupid Backoff. + /// /// [JsonInclude, JsonPropertyName("smoothing")] public Elastic.Clients.Elasticsearch.Core.Search.SmoothingModel? Smoothing { get; set; } /// - /// The text/query to provide suggestions for. + /// + /// The text/query to provide suggestions for. + /// /// [JsonInclude, JsonPropertyName("text")] public string? Text { get; set; } @@ -155,7 +192,10 @@ public PhraseSuggesterDescriptor() : base() private int? TokenLimitValue { get; set; } /// - /// The analyzer to analyze the suggest text with.
Defaults to the search analyzer of the suggest field. + /// + /// The analyzer to analyze the suggest text with. + /// Defaults to the search analyzer of the suggest field. + /// /// public PhraseSuggesterDescriptor Analyzer(string? analyzer) { @@ -164,7 +204,9 @@ public PhraseSuggesterDescriptor Analyzer(string? analyzer) } /// - /// Checks each suggestion against the specified query to prune suggestions for which no matching docs exist in the index. + /// + /// Checks each suggestion against the specified query to prune suggestions for which no matching docs exist in the index. + /// /// public PhraseSuggesterDescriptor Collate(Elastic.Clients.Elasticsearch.Core.Search.PhraseSuggestCollate? collate) { @@ -191,7 +233,10 @@ public PhraseSuggesterDescriptor Collate(Action - /// Defines a factor applied to the input phrases score, which is used as a threshold for other suggest candidates.
Only candidates that score higher than the threshold will be included in the result. + /// + /// Defines a factor applied to the input phrases score, which is used as a threshold for other suggest candidates. + /// Only candidates that score higher than the threshold will be included in the result. + /// /// public PhraseSuggesterDescriptor Confidence(double? confidence) { @@ -200,7 +245,9 @@ public PhraseSuggesterDescriptor Confidence(double? confidence) } /// - /// A list of candidate generators that produce a list of possible terms per term in the given text. + /// + /// A list of candidate generators that produce a list of possible terms per term in the given text. + /// /// public PhraseSuggesterDescriptor DirectGenerator(ICollection? directGenerator) { @@ -239,7 +286,10 @@ public PhraseSuggesterDescriptor DirectGenerator(params Action - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public PhraseSuggesterDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -248,7 +298,10 @@ public PhraseSuggesterDescriptor Field(Elastic.Clients.Elasticsearch. } /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public PhraseSuggesterDescriptor Field(Expression> field) { @@ -257,7 +310,10 @@ public PhraseSuggesterDescriptor Field(Expression - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public PhraseSuggesterDescriptor Field(Expression> field) { @@ -272,7 +328,11 @@ public PhraseSuggesterDescriptor ForceUnigrams(bool? forceUnigrams = } /// - /// Sets max size of the n-grams (shingles) in the field.
If the field doesn’t contain n-grams (shingles), this should be omitted or set to `1`.
If the field uses a shingle filter, the `gram_size` is set to the `max_shingle_size` if not explicitly set. + /// + /// Sets max size of the n-grams (shingles) in the field. + /// If the field doesn’t contain n-grams (shingles), this should be omitted or set to 1. + /// If the field uses a shingle filter, the gram_size is set to the max_shingle_size if not explicitly set. + /// /// public PhraseSuggesterDescriptor GramSize(int? gramSize) { @@ -281,7 +341,10 @@ public PhraseSuggesterDescriptor GramSize(int? gramSize) } /// - /// Sets up suggestion highlighting.
If not provided, no highlighted field is returned. + /// + /// Sets up suggestion highlighting. + /// If not provided, no highlighted field is returned. + /// /// public PhraseSuggesterDescriptor Highlight(Elastic.Clients.Elasticsearch.Core.Search.PhraseSuggestHighlight? highlight) { @@ -308,7 +371,10 @@ public PhraseSuggesterDescriptor Highlight(Action - /// The maximum percentage of the terms considered to be misspellings in order to form a correction.
This method accepts a float value in the range `[0..1)` as a fraction of the actual query terms or a number `>=1` as an absolute number of query terms. + /// + /// The maximum percentage of the terms considered to be misspellings in order to form a correction. + /// This method accepts a float value in the range [0..1) as a fraction of the actual query terms or a number >=1 as an absolute number of query terms. + /// /// public PhraseSuggesterDescriptor MaxErrors(double? maxErrors) { @@ -317,7 +383,9 @@ public PhraseSuggesterDescriptor MaxErrors(double? maxErrors) } /// - /// The likelihood of a term being misspelled even if the term exists in the dictionary. + /// + /// The likelihood of a term being misspelled even if the term exists in the dictionary. + /// /// public PhraseSuggesterDescriptor RealWordErrorLikelihood(double? realWordErrorLikelihood) { @@ -326,7 +394,10 @@ public PhraseSuggesterDescriptor RealWordErrorLikelihood(double? real } /// - /// The separator that is used to separate terms in the bigram field.
If not set, the whitespace character is used as a separator. + /// + /// The separator that is used to separate terms in the bigram field. + /// If not set, the whitespace character is used as a separator. + /// /// public PhraseSuggesterDescriptor Separator(string? separator) { @@ -335,7 +406,9 @@ public PhraseSuggesterDescriptor Separator(string? separator) } /// - /// Sets the maximum number of suggested terms to be retrieved from each individual shard. + /// + /// Sets the maximum number of suggested terms to be retrieved from each individual shard. + /// /// public PhraseSuggesterDescriptor ShardSize(int? shardSize) { @@ -344,7 +417,9 @@ public PhraseSuggesterDescriptor ShardSize(int? shardSize) } /// - /// The maximum corrections to be returned per suggest text token. + /// + /// The maximum corrections to be returned per suggest text token. + /// /// public PhraseSuggesterDescriptor Size(int? size) { @@ -353,7 +428,10 @@ public PhraseSuggesterDescriptor Size(int? size) } /// - /// The smoothing model used to balance weight between infrequent grams (grams (shingles) are not existing in the index) and frequent grams (appear at least once in the index).
The default model is Stupid Backoff. + /// + /// The smoothing model used to balance weight between infrequent grams (grams (shingles) are not existing in the index) and frequent grams (appear at least once in the index). + /// The default model is Stupid Backoff. + /// /// public PhraseSuggesterDescriptor Smoothing(Elastic.Clients.Elasticsearch.Core.Search.SmoothingModel? smoothing) { @@ -380,7 +458,9 @@ public PhraseSuggesterDescriptor Smoothing(Action - /// The text/query to provide suggestions for. + /// + /// The text/query to provide suggestions for. + /// /// public PhraseSuggesterDescriptor Text(string? text) { @@ -583,7 +663,10 @@ public PhraseSuggesterDescriptor() : base() private int? TokenLimitValue { get; set; } /// - /// The analyzer to analyze the suggest text with.
Defaults to the search analyzer of the suggest field. + /// + /// The analyzer to analyze the suggest text with. + /// Defaults to the search analyzer of the suggest field. + /// /// public PhraseSuggesterDescriptor Analyzer(string? analyzer) { @@ -592,7 +675,9 @@ public PhraseSuggesterDescriptor Analyzer(string? analyzer) } /// - /// Checks each suggestion against the specified query to prune suggestions for which no matching docs exist in the index. + /// + /// Checks each suggestion against the specified query to prune suggestions for which no matching docs exist in the index. + /// /// public PhraseSuggesterDescriptor Collate(Elastic.Clients.Elasticsearch.Core.Search.PhraseSuggestCollate? collate) { @@ -619,7 +704,10 @@ public PhraseSuggesterDescriptor Collate(Action - /// Defines a factor applied to the input phrases score, which is used as a threshold for other suggest candidates.
Only candidates that score higher than the threshold will be included in the result. + /// + /// Defines a factor applied to the input phrases score, which is used as a threshold for other suggest candidates. + /// Only candidates that score higher than the threshold will be included in the result. + /// /// public PhraseSuggesterDescriptor Confidence(double? confidence) { @@ -628,7 +716,9 @@ public PhraseSuggesterDescriptor Confidence(double? confidence) } /// - /// A list of candidate generators that produce a list of possible terms per term in the given text. + /// + /// A list of candidate generators that produce a list of possible terms per term in the given text. + /// /// public PhraseSuggesterDescriptor DirectGenerator(ICollection? directGenerator) { @@ -667,7 +757,10 @@ public PhraseSuggesterDescriptor DirectGenerator(params Action - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public PhraseSuggesterDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -676,7 +769,10 @@ public PhraseSuggesterDescriptor Field(Elastic.Clients.Elasticsearch.Field field } /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public PhraseSuggesterDescriptor Field(Expression> field) { @@ -685,7 +781,10 @@ public PhraseSuggesterDescriptor Field(Expression - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public PhraseSuggesterDescriptor Field(Expression> field) { @@ -700,7 +799,11 @@ public PhraseSuggesterDescriptor ForceUnigrams(bool? forceUnigrams = true) } /// - /// Sets max size of the n-grams (shingles) in the field.
If the field doesn’t contain n-grams (shingles), this should be omitted or set to `1`.
If the field uses a shingle filter, the `gram_size` is set to the `max_shingle_size` if not explicitly set. + /// + /// Sets max size of the n-grams (shingles) in the field. + /// If the field doesn’t contain n-grams (shingles), this should be omitted or set to 1. + /// If the field uses a shingle filter, the gram_size is set to the max_shingle_size if not explicitly set. + /// /// public PhraseSuggesterDescriptor GramSize(int? gramSize) { @@ -709,7 +812,10 @@ public PhraseSuggesterDescriptor GramSize(int? gramSize) } /// - /// Sets up suggestion highlighting.
If not provided, no highlighted field is returned. + /// + /// Sets up suggestion highlighting. + /// If not provided, no highlighted field is returned. + /// /// public PhraseSuggesterDescriptor Highlight(Elastic.Clients.Elasticsearch.Core.Search.PhraseSuggestHighlight? highlight) { @@ -736,7 +842,10 @@ public PhraseSuggesterDescriptor Highlight(Action - /// The maximum percentage of the terms considered to be misspellings in order to form a correction.
This method accepts a float value in the range `[0..1)` as a fraction of the actual query terms or a number `>=1` as an absolute number of query terms. + /// + /// The maximum percentage of the terms considered to be misspellings in order to form a correction. + /// This method accepts a float value in the range [0..1) as a fraction of the actual query terms or a number >=1 as an absolute number of query terms. + /// /// public PhraseSuggesterDescriptor MaxErrors(double? maxErrors) { @@ -745,7 +854,9 @@ public PhraseSuggesterDescriptor MaxErrors(double? maxErrors) } /// - /// The likelihood of a term being misspelled even if the term exists in the dictionary. + /// + /// The likelihood of a term being misspelled even if the term exists in the dictionary. + /// /// public PhraseSuggesterDescriptor RealWordErrorLikelihood(double? realWordErrorLikelihood) { @@ -754,7 +865,10 @@ public PhraseSuggesterDescriptor RealWordErrorLikelihood(double? realWordErrorLi } /// - /// The separator that is used to separate terms in the bigram field.
If not set, the whitespace character is used as a separator. + /// + /// The separator that is used to separate terms in the bigram field. + /// If not set, the whitespace character is used as a separator. + /// /// public PhraseSuggesterDescriptor Separator(string? separator) { @@ -763,7 +877,9 @@ public PhraseSuggesterDescriptor Separator(string? separator) } /// - /// Sets the maximum number of suggested terms to be retrieved from each individual shard. + /// + /// Sets the maximum number of suggested terms to be retrieved from each individual shard. + /// /// public PhraseSuggesterDescriptor ShardSize(int? shardSize) { @@ -772,7 +888,9 @@ public PhraseSuggesterDescriptor ShardSize(int? shardSize) } /// - /// The maximum corrections to be returned per suggest text token. + /// + /// The maximum corrections to be returned per suggest text token. + /// /// public PhraseSuggesterDescriptor Size(int? size) { @@ -781,7 +899,10 @@ public PhraseSuggesterDescriptor Size(int? size) } /// - /// The smoothing model used to balance weight between infrequent grams (grams (shingles) are not existing in the index) and frequent grams (appear at least once in the index).
The default model is Stupid Backoff. + /// + /// The smoothing model used to balance weight between infrequent grams (grams (shingles) are not existing in the index) and frequent grams (appear at least once in the index). + /// The default model is Stupid Backoff. + /// /// public PhraseSuggesterDescriptor Smoothing(Elastic.Clients.Elasticsearch.Core.Search.SmoothingModel? smoothing) { @@ -808,7 +929,9 @@ public PhraseSuggesterDescriptor Smoothing(Action - /// The text/query to provide suggestions for. + /// + /// The text/query to provide suggestions for. + /// /// public PhraseSuggesterDescriptor Text(string? text) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/RegexOptions.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/RegexOptions.g.cs index 46b8536c9c7..dbf837cfbb7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/RegexOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/RegexOptions.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Core.Search; public sealed partial class RegexOptions { /// - /// Optional operators for the regular expression. + /// + /// Optional operators for the regular expression. + /// /// [JsonInclude, JsonPropertyName("flags")] public object? Flags { get; set; } /// - /// Maximum number of automaton states required for the query. + /// + /// Maximum number of automaton states required for the query. + /// /// [JsonInclude, JsonPropertyName("max_determinized_states")] public int? MaxDeterminizedStates { get; set; } @@ -54,7 +58,9 @@ public RegexOptionsDescriptor() : base() private int? MaxDeterminizedStatesValue { get; set; } /// - /// Optional operators for the regular expression. + /// + /// Optional operators for the regular expression. + /// /// public RegexOptionsDescriptor Flags(object? flags) { @@ -63,7 +69,9 @@ public RegexOptionsDescriptor Flags(object? flags) } /// - /// Maximum number of automaton states required for the query. + /// + /// Maximum number of automaton states required for the query. + /// /// public RegexOptionsDescriptor MaxDeterminizedStates(int? maxDeterminizedStates) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/RescoreQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/RescoreQuery.g.cs index 5ab3908627f..ff7b9c82982 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/RescoreQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/RescoreQuery.g.cs @@ -30,25 +30,34 @@ namespace Elastic.Clients.Elasticsearch.Core.Search; public sealed partial class RescoreQuery { /// - /// The query to use for rescoring.
This query is only run on the Top-K results returned by the `query` and `post_filter` phases. + /// + /// The query to use for rescoring. + /// This query is only run on the Top-K results returned by the query and post_filter phases. + /// /// [JsonInclude, JsonPropertyName("rescore_query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query Query { get; set; } /// - /// Relative importance of the original query versus the rescore query. + /// + /// Relative importance of the original query versus the rescore query. + /// /// [JsonInclude, JsonPropertyName("query_weight")] public double? QueryWeight { get; set; } /// - /// Relative importance of the rescore query versus the original query. + /// + /// Relative importance of the rescore query versus the original query. + /// /// [JsonInclude, JsonPropertyName("rescore_query_weight")] public double? RescoreQueryWeight { get; set; } /// - /// Determines how scores are combined. + /// + /// Determines how scores are combined. + /// /// [JsonInclude, JsonPropertyName("score_mode")] public Elastic.Clients.Elasticsearch.Core.Search.ScoreMode? ScoreMode { get; set; } @@ -72,7 +81,10 @@ public RescoreQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Core.Search.ScoreMode? ScoreModeValue { get; set; } /// - /// The query to use for rescoring.
This query is only run on the Top-K results returned by the `query` and `post_filter` phases. + /// + /// The query to use for rescoring. + /// This query is only run on the Top-K results returned by the query and post_filter phases. + /// /// public RescoreQueryDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query query) { @@ -99,7 +111,9 @@ public RescoreQueryDescriptor Query(Action - /// Relative importance of the original query versus the rescore query. + /// + /// Relative importance of the original query versus the rescore query. + /// /// public RescoreQueryDescriptor QueryWeight(double? queryWeight) { @@ -108,7 +122,9 @@ public RescoreQueryDescriptor QueryWeight(double? queryWeight) } /// - /// Relative importance of the rescore query versus the original query. + /// + /// Relative importance of the rescore query versus the original query. + /// /// public RescoreQueryDescriptor RescoreQueryWeight(double? rescoreQueryWeight) { @@ -117,7 +133,9 @@ public RescoreQueryDescriptor RescoreQueryWeight(double? rescoreQuery } /// - /// Determines how scores are combined. + /// + /// Determines how scores are combined. + /// /// public RescoreQueryDescriptor ScoreMode(Elastic.Clients.Elasticsearch.Core.Search.ScoreMode? scoreMode) { @@ -182,7 +200,10 @@ public RescoreQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Core.Search.ScoreMode? ScoreModeValue { get; set; } /// - /// The query to use for rescoring.
This query is only run on the Top-K results returned by the `query` and `post_filter` phases. + /// + /// The query to use for rescoring. + /// This query is only run on the Top-K results returned by the query and post_filter phases. + /// /// public RescoreQueryDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query query) { @@ -209,7 +230,9 @@ public RescoreQueryDescriptor Query(Action - /// Relative importance of the original query versus the rescore query. + /// + /// Relative importance of the original query versus the rescore query. + /// /// public RescoreQueryDescriptor QueryWeight(double? queryWeight) { @@ -218,7 +241,9 @@ public RescoreQueryDescriptor QueryWeight(double? queryWeight) } /// - /// Relative importance of the rescore query versus the original query. + /// + /// Relative importance of the rescore query versus the original query. + /// /// public RescoreQueryDescriptor RescoreQueryWeight(double? rescoreQueryWeight) { @@ -227,7 +252,9 @@ public RescoreQueryDescriptor RescoreQueryWeight(double? rescoreQueryWeight) } /// - /// Determines how scores are combined. + /// + /// Determines how scores are combined. + /// /// public RescoreQueryDescriptor ScoreMode(Elastic.Clients.Elasticsearch.Core.Search.ScoreMode? scoreMode) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/StupidBackoffSmoothingModel.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/StupidBackoffSmoothingModel.g.cs index 85e73ba2a51..0e355f7b7e9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/StupidBackoffSmoothingModel.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/StupidBackoffSmoothingModel.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Core.Search; public sealed partial class StupidBackoffSmoothingModel { /// - /// A constant factor that the lower order n-gram model is discounted by. + /// + /// A constant factor that the lower order n-gram model is discounted by. + /// /// [JsonInclude, JsonPropertyName("discount")] public double Discount { get; set; } @@ -49,7 +51,9 @@ public StupidBackoffSmoothingModelDescriptor() : base() private double DiscountValue { get; set; } /// - /// A constant factor that the lower order n-gram model is discounted by. + /// + /// A constant factor that the lower order n-gram model is discounted by. + /// /// public StupidBackoffSmoothingModelDescriptor Discount(double discount) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/SuggestFuzziness.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/SuggestFuzziness.g.cs index 4338dd8fd93..a6647a7ab42 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/SuggestFuzziness.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/SuggestFuzziness.g.cs @@ -30,31 +30,42 @@ namespace Elastic.Clients.Elasticsearch.Core.Search; public sealed partial class SuggestFuzziness { /// - /// The fuzziness factor. + /// + /// The fuzziness factor. + /// /// [JsonInclude, JsonPropertyName("fuzziness")] public Elastic.Clients.Elasticsearch.Fuzziness? Fuzziness { get; set; } /// - /// Minimum length of the input before fuzzy suggestions are returned. + /// + /// Minimum length of the input before fuzzy suggestions are returned. + /// /// [JsonInclude, JsonPropertyName("min_length")] public int? MinLength { get; set; } /// - /// Minimum length of the input, which is not checked for fuzzy alternatives. + /// + /// Minimum length of the input, which is not checked for fuzzy alternatives. + /// /// [JsonInclude, JsonPropertyName("prefix_length")] public int? PrefixLength { get; set; } /// - /// If set to `true`, transpositions are counted as one change instead of two. + /// + /// If set to true, transpositions are counted as one change instead of two. + /// /// [JsonInclude, JsonPropertyName("transpositions")] public bool? Transpositions { get; set; } /// - /// If `true`, all measurements (like fuzzy edit distance, transpositions, and lengths) are measured in Unicode code points instead of in bytes.
This is slightly slower than raw bytes. + /// + /// If true, all measurements (like fuzzy edit distance, transpositions, and lengths) are measured in Unicode code points instead of in bytes. + /// This is slightly slower than raw bytes. + /// /// [JsonInclude, JsonPropertyName("unicode_aware")] public bool? UnicodeAware { get; set; } @@ -75,7 +86,9 @@ public SuggestFuzzinessDescriptor() : base() private bool? UnicodeAwareValue { get; set; } /// - /// The fuzziness factor. + /// + /// The fuzziness factor. + /// /// public SuggestFuzzinessDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzziness? fuzziness) { @@ -84,7 +97,9 @@ public SuggestFuzzinessDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzzin } /// - /// Minimum length of the input before fuzzy suggestions are returned. + /// + /// Minimum length of the input before fuzzy suggestions are returned. + /// /// public SuggestFuzzinessDescriptor MinLength(int? minLength) { @@ -93,7 +108,9 @@ public SuggestFuzzinessDescriptor MinLength(int? minLength) } /// - /// Minimum length of the input, which is not checked for fuzzy alternatives. + /// + /// Minimum length of the input, which is not checked for fuzzy alternatives. + /// /// public SuggestFuzzinessDescriptor PrefixLength(int? prefixLength) { @@ -102,7 +119,9 @@ public SuggestFuzzinessDescriptor PrefixLength(int? prefixLength) } /// - /// If set to `true`, transpositions are counted as one change instead of two. + /// + /// If set to true, transpositions are counted as one change instead of two. + /// /// public SuggestFuzzinessDescriptor Transpositions(bool? transpositions = true) { @@ -111,7 +130,10 @@ public SuggestFuzzinessDescriptor Transpositions(bool? transpositions = true) } /// - /// If `true`, all measurements (like fuzzy edit distance, transpositions, and lengths) are measured in Unicode code points instead of in bytes.
This is slightly slower than raw bytes. + /// + /// If true, all measurements (like fuzzy edit distance, transpositions, and lengths) are measured in Unicode code points instead of in bytes. + /// This is slightly slower than raw bytes. + /// /// public SuggestFuzzinessDescriptor UnicodeAware(bool? unicodeAware = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/Suggester.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/Suggester.g.cs index 92796cf62dd..4c45bb505e6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/Suggester.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/Suggester.g.cs @@ -82,12 +82,16 @@ public override void Write(Utf8JsonWriter writer, Suggester value, JsonSerialize public sealed partial class Suggester { /// - /// The named suggesters + /// + /// The named suggesters + /// /// public IDictionary Suggesters { get; set; } /// - /// Global suggest text, to avoid repetition when the same text is used in several suggesters + /// + /// Global suggest text, to avoid repetition when the same text is used in several suggesters + /// /// public string? Text { get; set; } } @@ -104,7 +108,9 @@ public SuggesterDescriptor() : base() private string? TextValue { get; set; } /// - /// The named suggesters + /// + /// The named suggesters + /// /// public SuggesterDescriptor Suggesters(Func>, FluentDescriptorDictionary>> selector) { @@ -113,7 +119,9 @@ public SuggesterDescriptor Suggesters(Func - /// Global suggest text, to avoid repetition when the same text is used in several suggesters + /// + /// Global suggest text, to avoid repetition when the same text is used in several suggesters + /// /// public SuggesterDescriptor Text(string? text) { @@ -155,7 +163,9 @@ public SuggesterDescriptor() : base() private string? TextValue { get; set; } /// - /// The named suggesters + /// + /// The named suggesters + /// /// public SuggesterDescriptor Suggesters(Func, FluentDescriptorDictionary> selector) { @@ -164,7 +174,9 @@ public SuggesterDescriptor Suggesters(Func - /// Global suggest text, to avoid repetition when the same text is used in several suggesters + /// + /// Global suggest text, to avoid repetition when the same text is used in several suggesters + /// /// public SuggesterDescriptor Text(string? text) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/TermSuggester.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/TermSuggester.g.cs index 8f5493f7326..5e92afac9c4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/TermSuggester.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/TermSuggester.g.cs @@ -30,13 +30,19 @@ namespace Elastic.Clients.Elasticsearch.Core.Search; public sealed partial class TermSuggester { /// - /// The analyzer to analyze the suggest text with.
Defaults to the search analyzer of the suggest field. + /// + /// The analyzer to analyze the suggest text with. + /// Defaults to the search analyzer of the suggest field. + /// /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } @@ -44,73 +50,106 @@ public sealed partial class TermSuggester public bool? LowercaseTerms { get; set; } /// - /// The maximum edit distance candidate suggestions can have in order to be considered as a suggestion.
Can only be `1` or `2`. + /// + /// The maximum edit distance candidate suggestions can have in order to be considered as a suggestion. + /// Can only be 1 or 2. + /// /// [JsonInclude, JsonPropertyName("max_edits")] public int? MaxEdits { get; set; } /// - /// A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level.
Can improve accuracy at the cost of performance. + /// + /// A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level. + /// Can improve accuracy at the cost of performance. + /// /// [JsonInclude, JsonPropertyName("max_inspections")] public int? MaxInspections { get; set; } /// - /// The maximum threshold in number of documents in which a suggest text token can exist in order to be included.
Can be a relative percentage number (for example `0.4`) or an absolute number to represent document frequencies.
If a value higher than 1 is specified, then fractional can not be specified. + /// + /// The maximum threshold in number of documents in which a suggest text token can exist in order to be included. + /// Can be a relative percentage number (for example 0.4) or an absolute number to represent document frequencies. + /// If a value higher than 1 is specified, then fractional can not be specified. + /// /// [JsonInclude, JsonPropertyName("max_term_freq")] public float? MaxTermFreq { get; set; } /// - /// The minimal threshold in number of documents a suggestion should appear in.
This can improve quality by only suggesting high frequency terms.
Can be specified as an absolute number or as a relative percentage of number of documents.
If a value higher than 1 is specified, then the number cannot be fractional. + /// + /// The minimal threshold in number of documents a suggestion should appear in. + /// This can improve quality by only suggesting high frequency terms. + /// Can be specified as an absolute number or as a relative percentage of number of documents. + /// If a value higher than 1 is specified, then the number cannot be fractional. + /// /// [JsonInclude, JsonPropertyName("min_doc_freq")] public float? MinDocFreq { get; set; } /// - /// The minimum length a suggest text term must have in order to be included. + /// + /// The minimum length a suggest text term must have in order to be included. + /// /// [JsonInclude, JsonPropertyName("min_word_length")] public int? MinWordLength { get; set; } /// - /// The number of minimal prefix characters that must match in order be a candidate for suggestions.
Increasing this number improves spellcheck performance. + /// + /// The number of minimal prefix characters that must match in order be a candidate for suggestions. + /// Increasing this number improves spellcheck performance. + /// /// [JsonInclude, JsonPropertyName("prefix_length")] public int? PrefixLength { get; set; } /// - /// Sets the maximum number of suggestions to be retrieved from each individual shard. + /// + /// Sets the maximum number of suggestions to be retrieved from each individual shard. + /// /// [JsonInclude, JsonPropertyName("shard_size")] public int? ShardSize { get; set; } /// - /// The maximum corrections to be returned per suggest text token. + /// + /// The maximum corrections to be returned per suggest text token. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } /// - /// Defines how suggestions should be sorted per suggest text term. + /// + /// Defines how suggestions should be sorted per suggest text term. + /// /// [JsonInclude, JsonPropertyName("sort")] public Elastic.Clients.Elasticsearch.Core.Search.SuggestSort? Sort { get; set; } /// - /// The string distance implementation to use for comparing how similar suggested terms are. + /// + /// The string distance implementation to use for comparing how similar suggested terms are. + /// /// [JsonInclude, JsonPropertyName("string_distance")] public Elastic.Clients.Elasticsearch.Core.Search.StringDistance? StringDistance { get; set; } /// - /// Controls what suggestions are included or controls for what suggest text terms, suggestions should be suggested. + /// + /// Controls what suggestions are included or controls for what suggest text terms, suggestions should be suggested. + /// /// [JsonInclude, JsonPropertyName("suggest_mode")] public Elastic.Clients.Elasticsearch.SuggestMode? SuggestMode { get; set; } /// - /// The suggest text.
Needs to be set globally or per suggestion. + /// + /// The suggest text. + /// Needs to be set globally or per suggestion. + /// /// [JsonInclude, JsonPropertyName("text")] public string? Text { get; set; } @@ -143,7 +182,10 @@ public TermSuggesterDescriptor() : base() private string? TextValue { get; set; } /// - /// The analyzer to analyze the suggest text with.
Defaults to the search analyzer of the suggest field. + /// + /// The analyzer to analyze the suggest text with. + /// Defaults to the search analyzer of the suggest field. + /// /// public TermSuggesterDescriptor Analyzer(string? analyzer) { @@ -152,7 +194,10 @@ public TermSuggesterDescriptor Analyzer(string? analyzer) } /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public TermSuggesterDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -161,7 +206,10 @@ public TermSuggesterDescriptor Field(Elastic.Clients.Elasticsearch.Fi } /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public TermSuggesterDescriptor Field(Expression> field) { @@ -170,7 +218,10 @@ public TermSuggesterDescriptor Field(Expression - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public TermSuggesterDescriptor Field(Expression> field) { @@ -185,7 +236,10 @@ public TermSuggesterDescriptor LowercaseTerms(bool? lowercaseTerms = } /// - /// The maximum edit distance candidate suggestions can have in order to be considered as a suggestion.
Can only be `1` or `2`. + /// + /// The maximum edit distance candidate suggestions can have in order to be considered as a suggestion. + /// Can only be 1 or 2. + /// /// public TermSuggesterDescriptor MaxEdits(int? maxEdits) { @@ -194,7 +248,10 @@ public TermSuggesterDescriptor MaxEdits(int? maxEdits) } /// - /// A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level.
Can improve accuracy at the cost of performance. + /// + /// A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level. + /// Can improve accuracy at the cost of performance. + /// /// public TermSuggesterDescriptor MaxInspections(int? maxInspections) { @@ -203,7 +260,11 @@ public TermSuggesterDescriptor MaxInspections(int? maxInspections) } /// - /// The maximum threshold in number of documents in which a suggest text token can exist in order to be included.
Can be a relative percentage number (for example `0.4`) or an absolute number to represent document frequencies.
If a value higher than 1 is specified, then fractional can not be specified. + /// + /// The maximum threshold in number of documents in which a suggest text token can exist in order to be included. + /// Can be a relative percentage number (for example 0.4) or an absolute number to represent document frequencies. + /// If a value higher than 1 is specified, then fractional can not be specified. + /// /// public TermSuggesterDescriptor MaxTermFreq(float? maxTermFreq) { @@ -212,7 +273,12 @@ public TermSuggesterDescriptor MaxTermFreq(float? maxTermFreq) } /// - /// The minimal threshold in number of documents a suggestion should appear in.
This can improve quality by only suggesting high frequency terms.
Can be specified as an absolute number or as a relative percentage of number of documents.
If a value higher than 1 is specified, then the number cannot be fractional. + /// + /// The minimal threshold in number of documents a suggestion should appear in. + /// This can improve quality by only suggesting high frequency terms. + /// Can be specified as an absolute number or as a relative percentage of number of documents. + /// If a value higher than 1 is specified, then the number cannot be fractional. + /// /// public TermSuggesterDescriptor MinDocFreq(float? minDocFreq) { @@ -221,7 +287,9 @@ public TermSuggesterDescriptor MinDocFreq(float? minDocFreq) } /// - /// The minimum length a suggest text term must have in order to be included. + /// + /// The minimum length a suggest text term must have in order to be included. + /// /// public TermSuggesterDescriptor MinWordLength(int? minWordLength) { @@ -230,7 +298,10 @@ public TermSuggesterDescriptor MinWordLength(int? minWordLength) } /// - /// The number of minimal prefix characters that must match in order be a candidate for suggestions.
Increasing this number improves spellcheck performance. + /// + /// The number of minimal prefix characters that must match in order be a candidate for suggestions. + /// Increasing this number improves spellcheck performance. + /// /// public TermSuggesterDescriptor PrefixLength(int? prefixLength) { @@ -239,7 +310,9 @@ public TermSuggesterDescriptor PrefixLength(int? prefixLength) } /// - /// Sets the maximum number of suggestions to be retrieved from each individual shard. + /// + /// Sets the maximum number of suggestions to be retrieved from each individual shard. + /// /// public TermSuggesterDescriptor ShardSize(int? shardSize) { @@ -248,7 +321,9 @@ public TermSuggesterDescriptor ShardSize(int? shardSize) } /// - /// The maximum corrections to be returned per suggest text token. + /// + /// The maximum corrections to be returned per suggest text token. + /// /// public TermSuggesterDescriptor Size(int? size) { @@ -257,7 +332,9 @@ public TermSuggesterDescriptor Size(int? size) } /// - /// Defines how suggestions should be sorted per suggest text term. + /// + /// Defines how suggestions should be sorted per suggest text term. + /// /// public TermSuggesterDescriptor Sort(Elastic.Clients.Elasticsearch.Core.Search.SuggestSort? sort) { @@ -266,7 +343,9 @@ public TermSuggesterDescriptor Sort(Elastic.Clients.Elasticsearch.Cor } /// - /// The string distance implementation to use for comparing how similar suggested terms are. + /// + /// The string distance implementation to use for comparing how similar suggested terms are. + /// /// public TermSuggesterDescriptor StringDistance(Elastic.Clients.Elasticsearch.Core.Search.StringDistance? stringDistance) { @@ -275,7 +354,9 @@ public TermSuggesterDescriptor StringDistance(Elastic.Clients.Elastic } /// - /// Controls what suggestions are included or controls for what suggest text terms, suggestions should be suggested. + /// + /// Controls what suggestions are included or controls for what suggest text terms, suggestions should be suggested. + /// /// public TermSuggesterDescriptor SuggestMode(Elastic.Clients.Elasticsearch.SuggestMode? suggestMode) { @@ -284,7 +365,10 @@ public TermSuggesterDescriptor SuggestMode(Elastic.Clients.Elasticsea } /// - /// The suggest text.
Needs to be set globally or per suggestion. + /// + /// The suggest text. + /// Needs to be set globally or per suggestion. + /// /// public TermSuggesterDescriptor Text(string? text) { @@ -410,7 +494,10 @@ public TermSuggesterDescriptor() : base() private string? TextValue { get; set; } /// - /// The analyzer to analyze the suggest text with.
Defaults to the search analyzer of the suggest field. + /// + /// The analyzer to analyze the suggest text with. + /// Defaults to the search analyzer of the suggest field. + /// /// public TermSuggesterDescriptor Analyzer(string? analyzer) { @@ -419,7 +506,10 @@ public TermSuggesterDescriptor Analyzer(string? analyzer) } /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public TermSuggesterDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -428,7 +518,10 @@ public TermSuggesterDescriptor Field(Elastic.Clients.Elasticsearch.Field field) } /// - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public TermSuggesterDescriptor Field(Expression> field) { @@ -437,7 +530,10 @@ public TermSuggesterDescriptor Field(Expression - /// The field to fetch the candidate suggestions from.
Needs to be set globally or per suggestion. + /// + /// The field to fetch the candidate suggestions from. + /// Needs to be set globally or per suggestion. + /// /// public TermSuggesterDescriptor Field(Expression> field) { @@ -452,7 +548,10 @@ public TermSuggesterDescriptor LowercaseTerms(bool? lowercaseTerms = true) } /// - /// The maximum edit distance candidate suggestions can have in order to be considered as a suggestion.
Can only be `1` or `2`. + /// + /// The maximum edit distance candidate suggestions can have in order to be considered as a suggestion. + /// Can only be 1 or 2. + /// /// public TermSuggesterDescriptor MaxEdits(int? maxEdits) { @@ -461,7 +560,10 @@ public TermSuggesterDescriptor MaxEdits(int? maxEdits) } /// - /// A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level.
Can improve accuracy at the cost of performance. + /// + /// A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level. + /// Can improve accuracy at the cost of performance. + /// /// public TermSuggesterDescriptor MaxInspections(int? maxInspections) { @@ -470,7 +572,11 @@ public TermSuggesterDescriptor MaxInspections(int? maxInspections) } /// - /// The maximum threshold in number of documents in which a suggest text token can exist in order to be included.
Can be a relative percentage number (for example `0.4`) or an absolute number to represent document frequencies.
If a value higher than 1 is specified, then fractional can not be specified. + /// + /// The maximum threshold in number of documents in which a suggest text token can exist in order to be included. + /// Can be a relative percentage number (for example 0.4) or an absolute number to represent document frequencies. + /// If a value higher than 1 is specified, then fractional can not be specified. + /// /// public TermSuggesterDescriptor MaxTermFreq(float? maxTermFreq) { @@ -479,7 +585,12 @@ public TermSuggesterDescriptor MaxTermFreq(float? maxTermFreq) } /// - /// The minimal threshold in number of documents a suggestion should appear in.
This can improve quality by only suggesting high frequency terms.
Can be specified as an absolute number or as a relative percentage of number of documents.
If a value higher than 1 is specified, then the number cannot be fractional. + /// + /// The minimal threshold in number of documents a suggestion should appear in. + /// This can improve quality by only suggesting high frequency terms. + /// Can be specified as an absolute number or as a relative percentage of number of documents. + /// If a value higher than 1 is specified, then the number cannot be fractional. + /// /// public TermSuggesterDescriptor MinDocFreq(float? minDocFreq) { @@ -488,7 +599,9 @@ public TermSuggesterDescriptor MinDocFreq(float? minDocFreq) } /// - /// The minimum length a suggest text term must have in order to be included. + /// + /// The minimum length a suggest text term must have in order to be included. + /// /// public TermSuggesterDescriptor MinWordLength(int? minWordLength) { @@ -497,7 +610,10 @@ public TermSuggesterDescriptor MinWordLength(int? minWordLength) } /// - /// The number of minimal prefix characters that must match in order be a candidate for suggestions.
Increasing this number improves spellcheck performance. + /// + /// The number of minimal prefix characters that must match in order be a candidate for suggestions. + /// Increasing this number improves spellcheck performance. + /// /// public TermSuggesterDescriptor PrefixLength(int? prefixLength) { @@ -506,7 +622,9 @@ public TermSuggesterDescriptor PrefixLength(int? prefixLength) } /// - /// Sets the maximum number of suggestions to be retrieved from each individual shard. + /// + /// Sets the maximum number of suggestions to be retrieved from each individual shard. + /// /// public TermSuggesterDescriptor ShardSize(int? shardSize) { @@ -515,7 +633,9 @@ public TermSuggesterDescriptor ShardSize(int? shardSize) } /// - /// The maximum corrections to be returned per suggest text token. + /// + /// The maximum corrections to be returned per suggest text token. + /// /// public TermSuggesterDescriptor Size(int? size) { @@ -524,7 +644,9 @@ public TermSuggesterDescriptor Size(int? size) } /// - /// Defines how suggestions should be sorted per suggest text term. + /// + /// Defines how suggestions should be sorted per suggest text term. + /// /// public TermSuggesterDescriptor Sort(Elastic.Clients.Elasticsearch.Core.Search.SuggestSort? sort) { @@ -533,7 +655,9 @@ public TermSuggesterDescriptor Sort(Elastic.Clients.Elasticsearch.Core.Search.Su } /// - /// The string distance implementation to use for comparing how similar suggested terms are. + /// + /// The string distance implementation to use for comparing how similar suggested terms are. + /// /// public TermSuggesterDescriptor StringDistance(Elastic.Clients.Elasticsearch.Core.Search.StringDistance? stringDistance) { @@ -542,7 +666,9 @@ public TermSuggesterDescriptor StringDistance(Elastic.Clients.Elasticsearch.Core } /// - /// Controls what suggestions are included or controls for what suggest text terms, suggestions should be suggested. + /// + /// Controls what suggestions are included or controls for what suggest text terms, suggestions should be suggested. + /// /// public TermSuggesterDescriptor SuggestMode(Elastic.Clients.Elasticsearch.SuggestMode? suggestMode) { @@ -551,7 +677,10 @@ public TermSuggesterDescriptor SuggestMode(Elastic.Clients.Elasticsearch.Suggest } /// - /// The suggest text.
Needs to be set globally or per suggestion. + /// + /// The suggest text. + /// Needs to be set globally or per suggestion. + /// /// public TermSuggesterDescriptor Text(string? text) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/SourceConfig.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/SourceConfig.g.cs index 955cd0de4f5..e64dca28647 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/SourceConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/SourceConfig.g.cs @@ -31,7 +31,9 @@ namespace Elastic.Clients.Elasticsearch.Core.Search; /// -/// Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered. +/// +/// Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered. +/// /// public sealed partial class SourceConfig : Union { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/SourceConfigParam.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/SourceConfigParam.g.cs index 9640a20a0cd..6779a77007f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/SourceConfigParam.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/SourceConfigParam.g.cs @@ -31,7 +31,10 @@ namespace Elastic.Clients.Elasticsearch.Core.Search; /// -/// Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.
Used as a query parameter along with the `_source_includes` and `_source_excludes` parameters. +/// +/// Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered. +/// Used as a query parameter along with the _source_includes and _source_excludes parameters. +/// /// public sealed partial class SourceConfigParam : Union { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/TermVectors/Filter.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/TermVectors/Filter.g.cs index 42d83a398ac..6b5fbf32507 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/TermVectors/Filter.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/TermVectors/Filter.g.cs @@ -30,43 +30,60 @@ namespace Elastic.Clients.Elasticsearch.Core.TermVectors; public sealed partial class Filter { /// - /// Ignore words which occur in more than this many docs.
Defaults to unbounded. + /// + /// Ignore words which occur in more than this many docs. + /// Defaults to unbounded. + /// /// [JsonInclude, JsonPropertyName("max_doc_freq")] public int? MaxDocFreq { get; set; } /// - /// Maximum number of terms that must be returned per field. + /// + /// Maximum number of terms that must be returned per field. + /// /// [JsonInclude, JsonPropertyName("max_num_terms")] public int? MaxNumTerms { get; set; } /// - /// Ignore words with more than this frequency in the source doc.
Defaults to unbounded. + /// + /// Ignore words with more than this frequency in the source doc. + /// Defaults to unbounded. + /// /// [JsonInclude, JsonPropertyName("max_term_freq")] public int? MaxTermFreq { get; set; } /// - /// The maximum word length above which words will be ignored.
Defaults to unbounded. + /// + /// The maximum word length above which words will be ignored. + /// Defaults to unbounded. + /// /// [JsonInclude, JsonPropertyName("max_word_length")] public int? MaxWordLength { get; set; } /// - /// Ignore terms which do not occur in at least this many docs. + /// + /// Ignore terms which do not occur in at least this many docs. + /// /// [JsonInclude, JsonPropertyName("min_doc_freq")] public int? MinDocFreq { get; set; } /// - /// Ignore words with less than this frequency in the source doc. + /// + /// Ignore words with less than this frequency in the source doc. + /// /// [JsonInclude, JsonPropertyName("min_term_freq")] public int? MinTermFreq { get; set; } /// - /// The minimum word length below which words will be ignored. + /// + /// The minimum word length below which words will be ignored. + /// /// [JsonInclude, JsonPropertyName("min_word_length")] public int? MinWordLength { get; set; } @@ -89,7 +106,10 @@ public FilterDescriptor() : base() private int? MinWordLengthValue { get; set; } /// - /// Ignore words which occur in more than this many docs.
Defaults to unbounded. + /// + /// Ignore words which occur in more than this many docs. + /// Defaults to unbounded. + /// /// public FilterDescriptor MaxDocFreq(int? maxDocFreq) { @@ -98,7 +118,9 @@ public FilterDescriptor MaxDocFreq(int? maxDocFreq) } /// - /// Maximum number of terms that must be returned per field. + /// + /// Maximum number of terms that must be returned per field. + /// /// public FilterDescriptor MaxNumTerms(int? maxNumTerms) { @@ -107,7 +129,10 @@ public FilterDescriptor MaxNumTerms(int? maxNumTerms) } /// - /// Ignore words with more than this frequency in the source doc.
Defaults to unbounded. + /// + /// Ignore words with more than this frequency in the source doc. + /// Defaults to unbounded. + /// /// public FilterDescriptor MaxTermFreq(int? maxTermFreq) { @@ -116,7 +141,10 @@ public FilterDescriptor MaxTermFreq(int? maxTermFreq) } /// - /// The maximum word length above which words will be ignored.
Defaults to unbounded. + /// + /// The maximum word length above which words will be ignored. + /// Defaults to unbounded. + /// /// public FilterDescriptor MaxWordLength(int? maxWordLength) { @@ -125,7 +153,9 @@ public FilterDescriptor MaxWordLength(int? maxWordLength) } /// - /// Ignore terms which do not occur in at least this many docs. + /// + /// Ignore terms which do not occur in at least this many docs. + /// /// public FilterDescriptor MinDocFreq(int? minDocFreq) { @@ -134,7 +164,9 @@ public FilterDescriptor MinDocFreq(int? minDocFreq) } /// - /// Ignore words with less than this frequency in the source doc. + /// + /// Ignore words with less than this frequency in the source doc. + /// /// public FilterDescriptor MinTermFreq(int? minTermFreq) { @@ -143,7 +175,9 @@ public FilterDescriptor MinTermFreq(int? minTermFreq) } /// - /// The minimum word length below which words will be ignored. + /// + /// The minimum word length below which words will be ignored. + /// /// public FilterDescriptor MinWordLength(int? minWordLength) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/TrackHits.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/TrackHits.g.cs index d10b1238bae..0d62aee06e5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/TrackHits.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/TrackHits.g.cs @@ -31,7 +31,12 @@ namespace Elastic.Clients.Elasticsearch.Core.Search; /// -/// Number of hits matching the query to count accurately. If true, the exact
number of hits is returned at the cost of some performance. If false, the
response does not include the total number of hits matching the query.
Defaults to 10,000 hits. +/// +/// Number of hits matching the query to count accurately. If true, the exact +/// number of hits is returned at the cost of some performance. If false, the +/// response does not include the total number of hits matching the query. +/// Defaults to 10,000 hits. +/// /// public sealed partial class TrackHits : Union { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/CrossClusterReplication/AutoFollowPatternSummary.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/CrossClusterReplication/AutoFollowPatternSummary.g.cs index 93228b4c4fb..2847fd3a10c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/CrossClusterReplication/AutoFollowPatternSummary.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/CrossClusterReplication/AutoFollowPatternSummary.g.cs @@ -33,31 +33,41 @@ public sealed partial class AutoFollowPatternSummary public bool Active { get; init; } /// - /// The name of follower index. + /// + /// The name of follower index. + /// /// [JsonInclude, JsonPropertyName("follow_index_pattern")] public string? FollowIndexPattern { get; init; } /// - /// An array of simple index patterns that can be used to exclude indices from being auto-followed. + /// + /// An array of simple index patterns that can be used to exclude indices from being auto-followed. + /// /// [JsonInclude, JsonPropertyName("leader_index_exclusion_patterns")] public IReadOnlyCollection LeaderIndexExclusionPatterns { get; init; } /// - /// An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field. + /// + /// An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field. + /// /// [JsonInclude, JsonPropertyName("leader_index_patterns")] public IReadOnlyCollection LeaderIndexPatterns { get; init; } /// - /// The maximum number of outstanding reads requests from the remote cluster. + /// + /// The maximum number of outstanding reads requests from the remote cluster. + /// /// [JsonInclude, JsonPropertyName("max_outstanding_read_requests")] public int MaxOutstandingReadRequests { get; init; } /// - /// The remote cluster containing the leader indices to match against. + /// + /// The remote cluster containing the leader indices to match against. + /// /// [JsonInclude, JsonPropertyName("remote_cluster")] public string RemoteCluster { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/DocStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/DocStats.g.cs index 81d06bb0719..02fb98ac034 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/DocStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/DocStats.g.cs @@ -30,13 +30,20 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class DocStats { /// - /// Total number of non-deleted documents across all primary shards assigned to selected nodes.
This number is based on documents in Lucene segments and may include documents from nested fields. + /// + /// Total number of non-deleted documents across all primary shards assigned to selected nodes. + /// This number is based on documents in Lucene segments and may include documents from nested fields. + /// /// [JsonInclude, JsonPropertyName("count")] public long Count { get; init; } /// - /// Total number of deleted documents across all primary shards assigned to selected nodes.
This number is based on documents in Lucene segments.
Elasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged. + /// + /// Total number of deleted documents across all primary shards assigned to selected nodes. + /// This number is based on documents in Lucene segments. + /// Elasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged. + /// /// [JsonInclude, JsonPropertyName("deleted")] public long? Deleted { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/ElasticsearchVersionMinInfo.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/ElasticsearchVersionMinInfo.g.cs index 998131b05e4..d81337ce137 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/ElasticsearchVersionMinInfo.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/ElasticsearchVersionMinInfo.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch; /// -/// Reduced (minimal) info ElasticsearchVersion +/// +/// Reduced (minimal) info ElasticsearchVersion +/// /// public sealed partial class ElasticsearchVersionMinInfo { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/EmptyObject.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/EmptyObject.g.cs index 159260b6097..d31eb58444e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/EmptyObject.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/EmptyObject.g.cs @@ -28,14 +28,18 @@ namespace Elastic.Clients.Elasticsearch; /// -/// For empty Class assignments +/// +/// For empty Class assignments +/// /// public sealed partial class EmptyObject { } /// -/// For empty Class assignments +/// +/// For empty Class assignments +/// /// public sealed partial class EmptyObjectDescriptor : SerializableDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Aggregations.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Aggregations.g.cs index 870f3b656d7..bb501a37b36 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Aggregations.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Aggregations.g.cs @@ -124,27 +124,37 @@ public override void Write(Utf8JsonWriter writer, CalendarInterval value, JsonSe public enum CardinalityExecutionMode { /// - /// Run the aggregation by using segment ordinal values and resolving those values after each segment. + /// + /// Run the aggregation by using segment ordinal values and resolving those values after each segment. + /// /// [EnumMember(Value = "segment_ordinals")] SegmentOrdinals, /// - /// Heuristic-based mode, default in Elasticsearch 8.4 and later. + /// + /// Heuristic-based mode, default in Elasticsearch 8.4 and later. + /// /// [EnumMember(Value = "save_time_heuristic")] SaveTimeHeuristic, /// - /// Heuristic-based mode, default in Elasticsearch 8.3 and earlier. + /// + /// Heuristic-based mode, default in Elasticsearch 8.3 and earlier. + /// /// [EnumMember(Value = "save_memory_heuristic")] SaveMemoryHeuristic, /// - /// Run the aggregation by using global ordinals of the field and resolving those values after finishing a shard. + /// + /// Run the aggregation by using global ordinals of the field and resolving those values after finishing a shard. + /// /// [EnumMember(Value = "global_ordinals")] GlobalOrdinals, /// - /// Run the aggregation by using field values directly. + /// + /// Run the aggregation by using field values directly. + /// /// [EnumMember(Value = "direct")] Direct @@ -202,17 +212,25 @@ public override void Write(Utf8JsonWriter writer, CardinalityExecutionMode value public enum GapPolicy { /// - /// Treats missing data as if the bucket does not exist. It will skip the bucket and
continue calculating using the next available value. + /// + /// Treats missing data as if the bucket does not exist. It will skip the bucket and + /// continue calculating using the next available value. + /// /// [EnumMember(Value = "skip")] Skip, /// - /// Similar to skip, except if the metric provides a non-null, non-NaN value this value is used,
otherwise the empty bucket is skipped. + /// + /// Similar to skip, except if the metric provides a non-null, non-NaN value this value is used, + /// otherwise the empty bucket is skipped. + /// /// [EnumMember(Value = "keep_values")] KeepValues, /// - /// Replace missing values with a zero (0) and pipeline aggregation computation will proceed as normal. + /// + /// Replace missing values with a zero (0) and pipeline aggregation computation will proceed as normal. + /// /// [EnumMember(Value = "insert_zeros")] InsertZeros @@ -379,32 +397,44 @@ public override void Write(Utf8JsonWriter writer, MissingOrder value, JsonSerial public enum NormalizeMethod { /// - /// This method normalizes such that each value represents how far it is from the mean relative to the standard deviation. + /// + /// This method normalizes such that each value represents how far it is from the mean relative to the standard deviation. + /// /// [EnumMember(Value = "z-score")] ZScore, /// - /// This method normalizes such that each value is exponentiated and relative to the sum of the exponents of the original values. + /// + /// This method normalizes such that each value is exponentiated and relative to the sum of the exponents of the original values. + /// /// [EnumMember(Value = "softmax")] Softmax, /// - /// This method rescales the data such that the minimum number is 0, and the maximum number is 100, with the rest normalized linearly in-between. + /// + /// This method rescales the data such that the minimum number is 0, and the maximum number is 100, with the rest normalized linearly in-between. + /// /// [EnumMember(Value = "rescale_0_100")] Rescale0100, /// - /// This method rescales the data such that the minimum number is 0, and the maximum number is 1, with the rest normalized linearly in-between. + /// + /// This method rescales the data such that the minimum number is 0, and the maximum number is 1, with the rest normalized linearly in-between. + /// /// [EnumMember(Value = "rescale_0_1")] Rescale01, /// - /// This method normalizes each value so that it represents a percentage of the total sum it attributes to. + /// + /// This method normalizes each value so that it represents a percentage of the total sum it attributes to. + /// /// [EnumMember(Value = "percent_of_sum")] PercentOfSum, /// - /// This method normalizes such that each value is normalized by how much it differs from the average. + /// + /// This method normalizes such that each value is normalized by how much it differs from the average. + /// /// [EnumMember(Value = "mean")] Mean @@ -467,12 +497,16 @@ public override void Write(Utf8JsonWriter writer, NormalizeMethod value, JsonSer public enum RateMode { /// - /// Uses the number of values of the field. + /// + /// Uses the number of values of the field. + /// /// [EnumMember(Value = "value_count")] ValueCount, /// - /// Calculates the sum of all values of the field. + /// + /// Calculates the sum of all values of the field. + /// /// [EnumMember(Value = "sum")] Sum @@ -515,17 +549,23 @@ public override void Write(Utf8JsonWriter writer, RateMode value, JsonSerializer public enum SamplerAggregationExecutionHint { /// - /// Hold field values directly. + /// + /// Hold field values directly. + /// /// [EnumMember(Value = "map")] Map, /// - /// Hold ordinals of the field as determined by the Lucene index. + /// + /// Hold ordinals of the field as determined by the Lucene index. + /// /// [EnumMember(Value = "global_ordinals")] GlobalOrdinals, /// - /// Hold hashes of the field values - with potential for hash collisions. + /// + /// Hold hashes of the field values - with potential for hash collisions. + /// /// [EnumMember(Value = "bytes_hash")] BytesHash @@ -573,12 +613,16 @@ public override void Write(Utf8JsonWriter writer, SamplerAggregationExecutionHin public enum TermsAggregationCollectMode { /// - /// Expands all branches of the aggregation tree in one depth-first pass, before any pruning occurs. + /// + /// Expands all branches of the aggregation tree in one depth-first pass, before any pruning occurs. + /// /// [EnumMember(Value = "depth_first")] DepthFirst, /// - /// Caches the set of documents that fall into the uppermost buckets for subsequent replay. + /// + /// Caches the set of documents that fall into the uppermost buckets for subsequent replay. + /// /// [EnumMember(Value = "breadth_first")] BreadthFirst @@ -677,17 +721,23 @@ public override void Write(Utf8JsonWriter writer, TermsAggregationExecutionHint public enum TTestType { /// - /// Performs paired t-test. + /// + /// Performs paired t-test. + /// /// [EnumMember(Value = "paired")] Paired, /// - /// Performs two-sample equal variance test. + /// + /// Performs two-sample equal variance test. + /// /// [EnumMember(Value = "homoscedastic")] Homoscedastic, /// - /// Performs two-sample unequal variance test. + /// + /// Performs two-sample unequal variance test. + /// /// [EnumMember(Value = "heteroscedastic")] Heteroscedastic diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Core.Search.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Core.Search.g.cs index b37e6c1cf59..d585ddc3ee1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Core.Search.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Core.Search.g.cs @@ -32,17 +32,29 @@ namespace Elastic.Clients.Elasticsearch.Core.Search; public enum BoundaryScanner { /// - /// Break highlighted fragments at the next word boundary, as determined by Java’s `BreakIterator`.
You can specify the locale to use with `boundary_scanner_locale`. + /// + /// Break highlighted fragments at the next word boundary, as determined by Java’s BreakIterator. + /// You can specify the locale to use with boundary_scanner_locale. + /// /// [EnumMember(Value = "word")] Word, /// - /// Break highlighted fragments at the next sentence boundary, as determined by Java’s `BreakIterator`.
You can specify the locale to use with `boundary_scanner_locale`.
When used with the `unified` highlighter, the `sentence` scanner splits sentences bigger than `fragment_size` at the first word boundary next to fragment_size.
You can set `fragment_size` to `0` to never split any sentence. + /// + /// Break highlighted fragments at the next sentence boundary, as determined by Java’s BreakIterator. + /// You can specify the locale to use with boundary_scanner_locale. + /// When used with the unified highlighter, the sentence scanner splits sentences bigger than fragment_size at the first word boundary next to fragment_size. + /// You can set fragment_size to 0 to never split any sentence. + /// /// [EnumMember(Value = "sentence")] Sentence, /// - /// Use the characters specified by `boundary_chars` as highlighting boundaries.
The `boundary_max_scan` setting controls how far to scan for boundary characters.
Only valid for the `fvh` highlighter. + /// + /// Use the characters specified by boundary_chars as highlighting boundaries. + /// The boundary_max_scan setting controls how far to scan for boundary characters. + /// Only valid for the fvh highlighter. + /// /// [EnumMember(Value = "chars")] Chars @@ -250,17 +262,23 @@ public override void Write(Utf8JsonWriter writer, HighlighterTagsSchema value, J public readonly string Value { get; } /// - /// The unified highlighter uses the Lucene Unified Highlighter. + /// + /// The unified highlighter uses the Lucene Unified Highlighter. + /// /// public static HighlighterType Unified { get; } = new HighlighterType("unified"); /// - /// The `plain` highlighter uses the standard Lucene highlighter + /// + /// The plain highlighter uses the standard Lucene highlighter + /// /// public static HighlighterType Plain { get; } = new HighlighterType("plain"); /// - /// The fvh highlighter uses the Lucene Fast Vector highlighter. + /// + /// The fvh highlighter uses the Lucene Fast Vector highlighter. + /// /// public static HighlighterType FastVector { get; } = new HighlighterType("fvh"); @@ -281,27 +299,38 @@ public override void Write(Utf8JsonWriter writer, HighlighterTagsSchema value, J public enum ScoreMode { /// - /// Add the original score and the rescore query score. + /// + /// Add the original score and the rescore query score. + /// /// [EnumMember(Value = "total")] Total, /// - /// Multiply the original score by the rescore query score.
Useful for `function` query rescores. + /// + /// Multiply the original score by the rescore query score. + /// Useful for function query rescores. + /// /// [EnumMember(Value = "multiply")] Multiply, /// - /// Take the min of the original score and the rescore query score. + /// + /// Take the min of the original score and the rescore query score. + /// /// [EnumMember(Value = "min")] Min, /// - /// Take the max of original score and the rescore query score. + /// + /// Take the max of original score and the rescore query score. + /// /// [EnumMember(Value = "max")] Max, /// - /// Average the original score and the rescore query score. + /// + /// Average the original score and the rescore query score. + /// /// [EnumMember(Value = "avg")] Avg @@ -359,27 +388,37 @@ public override void Write(Utf8JsonWriter writer, ScoreMode value, JsonSerialize public enum StringDistance { /// - /// String distance algorithm based on character n-grams. + /// + /// String distance algorithm based on character n-grams. + /// /// [EnumMember(Value = "ngram")] Ngram, /// - /// String distance algorithm based on the Levenshtein edit distance algorithm. + /// + /// String distance algorithm based on the Levenshtein edit distance algorithm. + /// /// [EnumMember(Value = "levenshtein")] Levenshtein, /// - /// String distance algorithm based on Jaro-Winkler algorithm. + /// + /// String distance algorithm based on Jaro-Winkler algorithm. + /// /// [EnumMember(Value = "jaro_winkler")] JaroWinkler, /// - /// Based on the Damerau-Levenshtein algorithm, but highly optimized for comparing string distance for terms inside the index. + /// + /// Based on the Damerau-Levenshtein algorithm, but highly optimized for comparing string distance for terms inside the index. + /// /// [EnumMember(Value = "internal")] Internal, /// - /// String distance algorithm based on Damerau-Levenshtein algorithm. + /// + /// String distance algorithm based on Damerau-Levenshtein algorithm. + /// /// [EnumMember(Value = "damerau_levenshtein")] DamerauLevenshtein @@ -437,12 +476,16 @@ public override void Write(Utf8JsonWriter writer, StringDistance value, JsonSeri public enum SuggestSort { /// - /// Sort by score first, then document frequency and then the term itself. + /// + /// Sort by score first, then document frequency and then the term itself. + /// /// [EnumMember(Value = "score")] Score, /// - /// Sort by document frequency first, then similarity score and then the term itself. + /// + /// Sort by document frequency first, then similarity score and then the term itself. + /// /// [EnumMember(Value = "frequency")] Frequency @@ -485,12 +528,16 @@ public override void Write(Utf8JsonWriter writer, SuggestSort value, JsonSeriali public enum TotalHitsRelation { /// - /// Lower bound, including returned events or sequences + /// + /// Lower bound, including returned events or sequences + /// /// [EnumMember(Value = "gte")] Gte, /// - /// Accurate + /// + /// Accurate + /// /// [EnumMember(Value = "eq")] Eq diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Eql.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Eql.g.cs index 3db6d5e445a..d4d3772640b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Eql.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Eql.g.cs @@ -32,12 +32,16 @@ namespace Elastic.Clients.Elasticsearch.Eql; public enum ResultPosition { /// - /// Return the most recent matches, similar to the Unix tail command. + /// + /// Return the most recent matches, similar to the Unix tail command. + /// /// [EnumMember(Value = "tail")] Tail, /// - /// Return the earliest matches, similar to the Unix head command. + /// + /// Return the earliest matches, similar to the Unix head command. + /// /// [EnumMember(Value = "head")] Head diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.IndexManagement.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.IndexManagement.g.cs index 13f2a771681..a5fbdb62bbf 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.IndexManagement.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.IndexManagement.g.cs @@ -610,22 +610,30 @@ public override void Write(Utf8JsonWriter writer, ShardStoreAllocation value, Js public enum ShardStoreStatus { /// - /// One or more replica shards are unassigned. + /// + /// One or more replica shards are unassigned. + /// /// [EnumMember(Value = "yellow")] Yellow, /// - /// The primary shard is unassigned. + /// + /// The primary shard is unassigned. + /// /// [EnumMember(Value = "red")] Red, /// - /// The primary shard and all replica shards are assigned. + /// + /// The primary shard and all replica shards are assigned. + /// /// [EnumMember(Value = "green")] Green, /// - /// Return all shards, regardless of health status. + /// + /// Return all shards, regardless of health status. + /// /// [EnumMember(Value = "all")] All @@ -684,22 +692,38 @@ public override void Write(Utf8JsonWriter writer, ShardStoreStatus value, JsonSe public readonly string Value { get; } /// - /// The NIO FS type stores the shard index on the file system (maps to Lucene NIOFSDirectory) using NIO. It allows multiple
threads to read from the same file concurrently. It is not recommended on Windows because of a bug in the SUN Java
implementation and disables some optimizations for heap memory usage. + /// + /// The NIO FS type stores the shard index on the file system (maps to Lucene NIOFSDirectory) using NIO. It allows multiple + /// threads to read from the same file concurrently. It is not recommended on Windows because of a bug in the SUN Java + /// implementation and disables some optimizations for heap memory usage. + /// /// public static StorageType Niofs { get; } = new StorageType("niofs"); /// - /// The MMap FS type stores the shard index on the file system (maps to Lucene MMapDirectory) by mapping a file into
memory (mmap). Memory mapping uses up a portion of the virtual memory address space in your process equal to the size
of the file being mapped. Before using this class, be sure you have allowed plenty of virtual address space. + /// + /// The MMap FS type stores the shard index on the file system (maps to Lucene MMapDirectory) by mapping a file into + /// memory (mmap). Memory mapping uses up a portion of the virtual memory address space in your process equal to the size + /// of the file being mapped. Before using this class, be sure you have allowed plenty of virtual address space. + /// /// public static StorageType Mmapfs { get; } = new StorageType("mmapfs"); /// - /// The hybridfs type is a hybrid of niofs and mmapfs, which chooses the best file system type for each type of file
based on the read access pattern. Currently only the Lucene term dictionary, norms and doc values files are memory
mapped. All other files are opened using Lucene NIOFSDirectory. Similarly to mmapfs be sure you have allowed
plenty of virtual address space. + /// + /// The hybridfs type is a hybrid of niofs and mmapfs, which chooses the best file system type for each type of file + /// based on the read access pattern. Currently only the Lucene term dictionary, norms and doc values files are memory + /// mapped. All other files are opened using Lucene NIOFSDirectory. Similarly to mmapfs be sure you have allowed + /// plenty of virtual address space. + /// /// public static StorageType Hybridfs { get; } = new StorageType("hybridfs"); /// - /// Default file system implementation. This will pick the best implementation depending on the operating environment, which
is currently hybridfs on all supported systems but is subject to change. + /// + /// Default file system implementation. This will pick the best implementation depending on the operating environment, which + /// is currently hybridfs on all supported systems but is subject to change. + /// /// public static StorageType Fs { get; } = new StorageType("fs"); @@ -720,12 +744,18 @@ public override void Write(Utf8JsonWriter writer, ShardStoreStatus value, JsonSe public enum TranslogDurability { /// - /// (default) fsync and commit after every request. In the event of hardware failure, all acknowledged writes
will already have been committed to disk. + /// + /// (default) fsync and commit after every request. In the event of hardware failure, all acknowledged writes + /// will already have been committed to disk. + /// /// [EnumMember(Value = "request")] Request, /// - /// fsync and commit in the background every sync_interval. In the event of a failure, all acknowledged writes
since the last automatic commit will be discarded. + /// + /// fsync and commit in the background every sync_interval. In the event of a failure, all acknowledged writes + /// since the last automatic commit will be discarded. + /// /// [EnumMember(Value = "async")] Async diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Ingest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Ingest.g.cs index 2bc8f8cd44d..5dc8701708d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Ingest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Ingest.g.cs @@ -109,12 +109,16 @@ public override void Write(Utf8JsonWriter writer, ConvertType value, JsonSeriali public enum JsonProcessorConflictStrategy { /// - /// Root fields that conflict with fields from the parsed JSON will be overridden. + /// + /// Root fields that conflict with fields from the parsed JSON will be overridden. + /// /// [EnumMember(Value = "replace")] Replace, /// - /// Conflicting fields will be merged. + /// + /// Conflicting fields will be merged. + /// /// [EnumMember(Value = "merge")] Merge diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.MachineLearning.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.MachineLearning.g.cs index fb792f55fc5..5b046096bd0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.MachineLearning.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.MachineLearning.g.cs @@ -354,17 +354,23 @@ public override void Write(Utf8JsonWriter writer, DataframeState value, JsonSeri public enum DeploymentAllocationState { /// - /// Trained model deployment is starting but it is not yet deployed on any nodes. + /// + /// Trained model deployment is starting but it is not yet deployed on any nodes. + /// /// [EnumMember(Value = "starting")] Starting, /// - /// The trained model is started on at least one node. + /// + /// The trained model is started on at least one node. + /// /// [EnumMember(Value = "started")] Started, /// - /// Trained model deployment has started on all valid nodes. + /// + /// Trained model deployment has started on all valid nodes. + /// /// [EnumMember(Value = "fully_allocated")] FullyAllocated @@ -468,17 +474,23 @@ public override void Write(Utf8JsonWriter writer, DeploymentAssignmentState valu public enum DeploymentState { /// - /// The deployment is preparing to stop and deallocate the model from the relevant nodes. + /// + /// The deployment is preparing to stop and deallocate the model from the relevant nodes. + /// /// [EnumMember(Value = "stopping")] Stopping, /// - /// The deployment has recently started but is not yet usable; the model is not allocated on any nodes. + /// + /// The deployment has recently started but is not yet usable; the model is not allocated on any nodes. + /// /// [EnumMember(Value = "starting")] Starting, /// - /// The deployment is usable; at least one node has the model allocated. + /// + /// The deployment is usable; at least one node has the model allocated. + /// /// [EnumMember(Value = "started")] Started @@ -624,27 +636,42 @@ public override void Write(Utf8JsonWriter writer, FilterType value, JsonSerializ public enum Include { /// - /// Includes the total feature importance for the training data set. The
baseline and total feature importance values are returned in the metadata
field in the response body. + /// + /// Includes the total feature importance for the training data set. The + /// baseline and total feature importance values are returned in the metadata + /// field in the response body. + /// /// [EnumMember(Value = "total_feature_importance")] TotalFeatureImportance, /// - /// Includes the information about hyperparameters used to train the model.
This information consists of the value, the absolute and relative
importance of the hyperparameter as well as an indicator of whether it was
specified by the user or tuned during hyperparameter optimization. + /// + /// Includes the information about hyperparameters used to train the model. + /// This information consists of the value, the absolute and relative + /// importance of the hyperparameter as well as an indicator of whether it was + /// specified by the user or tuned during hyperparameter optimization. + /// /// [EnumMember(Value = "hyperparameters")] Hyperparameters, /// - /// Includes the baseline for feature importance values. + /// + /// Includes the baseline for feature importance values. + /// /// [EnumMember(Value = "feature_importance_baseline")] FeatureImportanceBaseline, /// - /// Includes the model definition status. + /// + /// Includes the model definition status. + /// /// [EnumMember(Value = "definition_status")] DefinitionStatus, /// - /// Includes the model definition. + /// + /// Includes the model definition. + /// /// [EnumMember(Value = "definition")] Definition @@ -751,27 +778,40 @@ public override void Write(Utf8JsonWriter writer, JobBlockedReason value, JsonSe public enum JobState { /// - /// The job open action is in progress and has not yet completed. + /// + /// The job open action is in progress and has not yet completed. + /// /// [EnumMember(Value = "opening")] Opening, /// - /// The job is available to receive and process data. + /// + /// The job is available to receive and process data. + /// /// [EnumMember(Value = "opened")] Opened, /// - /// The job did not finish successfully due to an error.
This situation can occur due to invalid input data, a fatal error occurring during the analysis, or an external interaction such as the process being killed by the Linux out of memory (OOM) killer.
If the job had irrevocably failed, it must be force closed and then deleted.
If the datafeed can be corrected, the job can be closed and then re-opened. + /// + /// The job did not finish successfully due to an error. + /// This situation can occur due to invalid input data, a fatal error occurring during the analysis, or an external interaction such as the process being killed by the Linux out of memory (OOM) killer. + /// If the job had irrevocably failed, it must be force closed and then deleted. + /// If the datafeed can be corrected, the job can be closed and then re-opened. + /// /// [EnumMember(Value = "failed")] Failed, /// - /// The job close action is in progress and has not yet completed. A closing job cannot accept further data. + /// + /// The job close action is in progress and has not yet completed. A closing job cannot accept further data. + /// /// [EnumMember(Value = "closing")] Closing, /// - /// The job finished successfully with its model state persisted. The job must be opened before it can accept further data. + /// + /// The job finished successfully with its model state persisted. The job must be opened before it can accept further data. + /// /// [EnumMember(Value = "closed")] Closed @@ -878,27 +918,37 @@ public override void Write(Utf8JsonWriter writer, MemoryStatus value, JsonSerial public enum RoutingState { /// - /// The trained model is being deallocated from this node. + /// + /// The trained model is being deallocated from this node. + /// /// [EnumMember(Value = "stopping")] Stopping, /// - /// The trained model is fully deallocated from this node. + /// + /// The trained model is fully deallocated from this node. + /// /// [EnumMember(Value = "stopped")] Stopped, /// - /// The trained model is attempting to allocate on this node; inference requests are not yet accepted. + /// + /// The trained model is attempting to allocate on this node; inference requests are not yet accepted. + /// /// [EnumMember(Value = "starting")] Starting, /// - /// The trained model is allocated and ready to accept inference requests. + /// + /// The trained model is allocated and ready to accept inference requests. + /// /// [EnumMember(Value = "started")] Started, /// - /// The allocation attempt failed. + /// + /// The allocation attempt failed. + /// /// [EnumMember(Value = "failed")] Failed @@ -956,12 +1006,16 @@ public override void Write(Utf8JsonWriter writer, RoutingState value, JsonSerial public enum RuleAction { /// - /// The result will not be created. Unless you also specify `skip_model_update`, the model will be updated as usual with the corresponding series value. + /// + /// The result will not be created. Unless you also specify skip_model_update, the model will be updated as usual with the corresponding series value. + /// /// [EnumMember(Value = "skip_result")] SkipResult, /// - /// The value for that series will not be used to update the model. Unless you also specify `skip_result`, the results will be created as usual. This action is suitable when certain values are expected to be consistently anomalous and they affect the model in a way that negatively impacts the rest of the results. + /// + /// The value for that series will not be used to update the model. Unless you also specify skip_result, the results will be created as usual. This action is suitable when certain values are expected to be consistently anomalous and they affect the model in a way that negatively impacts the rest of the results. + /// /// [EnumMember(Value = "skip_model_update")] SkipModelUpdate @@ -1109,17 +1163,24 @@ public override void Write(Utf8JsonWriter writer, TokenizationTruncate value, Js public enum TrainedModelType { /// - /// The model definition is an ensemble model of decision trees. + /// + /// The model definition is an ensemble model of decision trees. + /// /// [EnumMember(Value = "tree_ensemble")] TreeEnsemble, /// - /// The stored definition is a PyTorch (specifically a TorchScript) model.
Currently only NLP models are supported. + /// + /// The stored definition is a PyTorch (specifically a TorchScript) model. + /// Currently only NLP models are supported. + /// /// [EnumMember(Value = "pytorch")] Pytorch, /// - /// A special type reserved for language identification models. + /// + /// A special type reserved for language identification models. + /// /// [EnumMember(Value = "lang_ident")] LangIdent diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Mapping.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Mapping.g.cs index 9ec96956348..cfbbedf34a4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Mapping.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Mapping.g.cs @@ -759,7 +759,10 @@ public override void Write(Utf8JsonWriter writer, RuntimeFieldType value, JsonSe public enum SourceFieldMode { /// - /// Instead of storing source documents on disk exactly as you send them,
Elasticsearch can reconstruct source content on the fly upon retrieval. + /// + /// Instead of storing source documents on disk exactly as you send them, + /// Elasticsearch can reconstruct source content on the fly upon retrieval. + /// /// [EnumMember(Value = "synthetic")] Synthetic, diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.NoNamespace.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.NoNamespace.g.cs index df0e2ad5c41..f2c5c6202bc 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.NoNamespace.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.NoNamespace.g.cs @@ -158,12 +158,16 @@ public override void Write(Utf8JsonWriter writer, ClusterSearchStatus value, Jso public enum Conflicts { /// - /// Continue reindexing even if there are conflicts. + /// + /// Continue reindexing even if there are conflicts. + /// /// [EnumMember(Value = "proceed")] Proceed, /// - /// Stop reindexing if there are conflicts. + /// + /// Stop reindexing if there are conflicts. + /// /// [EnumMember(Value = "abort")] Abort @@ -472,27 +476,37 @@ public override void Write(Utf8JsonWriter writer, DistanceUnit value, JsonSerial public enum ExpandWildcard { /// - /// Match open, non-hidden indices. Also matches any non-hidden data stream. + /// + /// Match open, non-hidden indices. Also matches any non-hidden data stream. + /// /// [EnumMember(Value = "open")] Open, /// - /// Wildcard expressions are not accepted. + /// + /// Wildcard expressions are not accepted. + /// /// [EnumMember(Value = "none")] None, /// - /// Match hidden data streams and hidden indices. Must be combined with open, closed, or both. + /// + /// Match hidden data streams and hidden indices. Must be combined with open, closed, or both. + /// /// [EnumMember(Value = "hidden")] Hidden, /// - /// Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. + /// + /// Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. + /// /// [EnumMember(Value = "closed")] Closed, /// - /// Match any data stream or index, including hidden ones. + /// + /// Match any data stream or index, including hidden ones. + /// /// [EnumMember(Value = "all")] All @@ -606,12 +620,16 @@ public override void Write(Utf8JsonWriter writer, FieldSortNumericType value, Js public enum GeoDistanceType { /// - /// The `plane` calculation is faster but less accurate. + /// + /// The plane calculation is faster but less accurate. + /// /// [EnumMember(Value = "plane")] Plane, /// - /// The `arc` calculation is the most accurate. + /// + /// The arc calculation is the most accurate. + /// /// [EnumMember(Value = "arc")] Arc @@ -654,22 +672,31 @@ public override void Write(Utf8JsonWriter writer, GeoDistanceType value, JsonSer public enum GeoShapeRelation { /// - /// Return all documents whose `geo_shape` or `geo_point` field is within the query geometry.
Line geometries are not supported. + /// + /// Return all documents whose geo_shape or geo_point field is within the query geometry. + /// Line geometries are not supported. + /// /// [EnumMember(Value = "within")] Within, /// - /// Return all documents whose `geo_shape` or `geo_point` field intersects the query geometry. + /// + /// Return all documents whose geo_shape or geo_point field intersects the query geometry. + /// /// [EnumMember(Value = "intersects")] Intersects, /// - /// Return all documents whose `geo_shape` or `geo_point` field has nothing in common with the query geometry. + /// + /// Return all documents whose geo_shape or geo_point field has nothing in common with the query geometry. + /// /// [EnumMember(Value = "disjoint")] Disjoint, /// - /// Return all documents whose `geo_shape` or `geo_point` field contains the query geometry. + /// + /// Return all documents whose geo_shape or geo_point field contains the query geometry. + /// /// [EnumMember(Value = "contains")] Contains @@ -722,17 +749,23 @@ public override void Write(Utf8JsonWriter writer, GeoShapeRelation value, JsonSe public enum HealthStatus { /// - /// All primary shards are assigned, but one or more replica shards are unassigned. If a node in the cluster fails, some data could be unavailable until that node is repaired. + /// + /// All primary shards are assigned, but one or more replica shards are unassigned. If a node in the cluster fails, some data could be unavailable until that node is repaired. + /// /// [EnumMember(Value = "yellow")] Yellow, /// - /// One or more primary shards are unassigned, so some data is unavailable. This can occur briefly during cluster startup as primary shards are assigned. + /// + /// One or more primary shards are unassigned, so some data is unavailable. This can occur briefly during cluster startup as primary shards are assigned. + /// /// [EnumMember(Value = "red")] Red, /// - /// All shards are assigned. + /// + /// All shards are assigned. + /// /// [EnumMember(Value = "green")] Green @@ -1223,22 +1256,30 @@ public override void Write(Utf8JsonWriter writer, Result value, JsonSerializerOp public readonly string Value { get; } /// - /// Painless scripting language, purpose-built for Elasticsearch. + /// + /// Painless scripting language, purpose-built for Elasticsearch. + /// /// public static ScriptLanguage Painless { get; } = new ScriptLanguage("painless"); /// - /// Mustache templated, used for templates. + /// + /// Mustache templated, used for templates. + /// /// public static ScriptLanguage Mustache { get; } = new ScriptLanguage("mustache"); /// - /// Expert Java API + /// + /// Expert Java API + /// /// public static ScriptLanguage Java { get; } = new ScriptLanguage("java"); /// - /// Lucene’s expressions language, compiles a JavaScript expression to bytecode. + /// + /// Lucene’s expressions language, compiles a JavaScript expression to bytecode. + /// /// public static ScriptLanguage Expression { get; } = new ScriptLanguage("expression"); @@ -1308,12 +1349,16 @@ public override void Write(Utf8JsonWriter writer, ScriptSortType value, JsonSeri public enum SearchType { /// - /// Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate. + /// + /// Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate. + /// /// [EnumMember(Value = "query_then_fetch")] QueryThenFetch, /// - /// Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate. + /// + /// Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate. + /// /// [EnumMember(Value = "dfs_query_then_fetch")] DfsQueryThenFetch @@ -1356,7 +1401,9 @@ public override void Write(Utf8JsonWriter writer, SearchType value, JsonSerializ public enum SlicesCalculation { /// - /// Let Elasticsearch choose a reasonable number for most data streams and indices. + /// + /// Let Elasticsearch choose a reasonable number for most data streams and indices. + /// /// [EnumMember(Value = "auto")] Auto @@ -1457,12 +1504,16 @@ public override void Write(Utf8JsonWriter writer, SortMode value, JsonSerializer public enum SortOrder { /// - /// Descending (largest to smallest) + /// + /// Descending (largest to smallest) + /// /// [EnumMember(Value = "desc")] Desc, /// - /// Ascending (smallest to largest) + /// + /// Ascending (smallest to largest) + /// /// [EnumMember(Value = "asc")] Asc @@ -1505,17 +1556,23 @@ public override void Write(Utf8JsonWriter writer, SortOrder value, JsonSerialize public enum SuggestMode { /// - /// Only suggest terms that occur in more docs on the shard than the original term. + /// + /// Only suggest terms that occur in more docs on the shard than the original term. + /// /// [EnumMember(Value = "popular")] Popular, /// - /// Only generate suggestions for terms that are not in the shard. + /// + /// Only generate suggestions for terms that are not in the shard. + /// /// [EnumMember(Value = "missing")] Missing, /// - /// Suggest any matching suggestions based on terms in the suggest text. + /// + /// Suggest any matching suggestions based on terms in the suggest text. + /// /// [EnumMember(Value = "always")] Always @@ -1703,19 +1760,27 @@ public override void Write(Utf8JsonWriter writer, TimeUnit value, JsonSerializer public enum VersionType { /// - /// Use internal versioning that starts at 1 and increments with each update or delete. + /// + /// Use internal versioning that starts at 1 and increments with each update or delete. + /// /// [EnumMember(Value = "internal")] Internal, [EnumMember(Value = "force")] Force, /// - /// Only index the document if the given version is equal or higher than the version of the stored document or if there is no existing document.
Note: the external_gte version type is meant for special use cases and should be used with care.
If used incorrectly, it can result in loss of data. + /// + /// Only index the document if the given version is equal or higher than the version of the stored document or if there is no existing document. + /// Note: the external_gte version type is meant for special use cases and should be used with care. + /// If used incorrectly, it can result in loss of data. + /// /// [EnumMember(Value = "external_gte")] ExternalGte, /// - /// Only index the document if the given version is strictly higher than the version of the stored document or if there is no existing document. + /// + /// Only index the document if the given version is strictly higher than the version of the stored document or if there is no existing document. + /// /// [EnumMember(Value = "external")] External diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.QueryDsl.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.QueryDsl.g.cs index bb3f57e10cc..3af92fe8e4b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.QueryDsl.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.QueryDsl.g.cs @@ -137,12 +137,16 @@ public override void Write(Utf8JsonWriter writer, CombinedFieldsOperator value, public enum CombinedFieldsZeroTerms { /// - /// No documents are returned if the analyzer removes all tokens. + /// + /// No documents are returned if the analyzer removes all tokens. + /// /// [EnumMember(Value = "none")] None, /// - /// Returns all documents, similar to a `match_all` query. + /// + /// Returns all documents, similar to a match_all query. + /// /// [EnumMember(Value = "all")] All @@ -185,52 +189,74 @@ public override void Write(Utf8JsonWriter writer, CombinedFieldsZeroTerms value, public enum FieldValueFactorModifier { /// - /// Square the field value (multiply it by itself). + /// + /// Square the field value (multiply it by itself). + /// /// [EnumMember(Value = "square")] Square, /// - /// Take the square root of the field value. + /// + /// Take the square root of the field value. + /// /// [EnumMember(Value = "sqrt")] Sqrt, /// - /// Reciprocate the field value, same as `1/x` where `x` is the field’s value. + /// + /// Reciprocate the field value, same as 1/x where x is the field’s value. + /// /// [EnumMember(Value = "reciprocal")] Reciprocal, /// - /// Do not apply any multiplier to the field value. + /// + /// Do not apply any multiplier to the field value. + /// /// [EnumMember(Value = "none")] None, /// - /// Add 2 to the field value and take the common logarithm. + /// + /// Add 2 to the field value and take the common logarithm. + /// /// [EnumMember(Value = "log2p")] Log2p, /// - /// Add 1 to the field value and take the common logarithm. + /// + /// Add 1 to the field value and take the common logarithm. + /// /// [EnumMember(Value = "log1p")] Log1p, /// - /// Take the common logarithm of the field value.
Because this function will return a negative value and cause an error if used on values between 0 and 1, it is recommended to use `log1p` instead. + /// + /// Take the common logarithm of the field value. + /// Because this function will return a negative value and cause an error if used on values between 0 and 1, it is recommended to use log1p instead. + /// /// [EnumMember(Value = "log")] Log, /// - /// Add 2 to the field value and take the natural logarithm. + /// + /// Add 2 to the field value and take the natural logarithm. + /// /// [EnumMember(Value = "ln2p")] Ln2p, /// - /// Add 1 to the field value and take the natural logarithm. + /// + /// Add 1 to the field value and take the natural logarithm. + /// /// [EnumMember(Value = "ln1p")] Ln1p, /// - /// Take the natural logarithm of the field value.
Because this function will return a negative value and cause an error if used on values between 0 and 1, it is recommended to use `ln1p` instead. + /// + /// Take the natural logarithm of the field value. + /// Because this function will return a negative value and cause an error if used on values between 0 and 1, it is recommended to use ln1p instead. + /// /// [EnumMember(Value = "ln")] Ln @@ -313,32 +339,45 @@ public override void Write(Utf8JsonWriter writer, FieldValueFactorModifier value public enum FunctionBoostMode { /// - /// Query score and function score are added + /// + /// Query score and function score are added + /// /// [EnumMember(Value = "sum")] Sum, /// - /// Only the function score is used.
The query score is ignored. + /// + /// Only the function score is used. + /// The query score is ignored. + /// /// [EnumMember(Value = "replace")] Replace, /// - /// Query score and function score are multiplied + /// + /// Query score and function score are multiplied + /// /// [EnumMember(Value = "multiply")] Multiply, /// - /// Min of query score and function score + /// + /// Min of query score and function score + /// /// [EnumMember(Value = "min")] Min, /// - /// Max of query score and function score + /// + /// Max of query score and function score + /// /// [EnumMember(Value = "max")] Max, /// - /// Query score and function score are averaged + /// + /// Query score and function score are averaged + /// /// [EnumMember(Value = "avg")] Avg @@ -401,32 +440,44 @@ public override void Write(Utf8JsonWriter writer, FunctionBoostMode value, JsonS public enum FunctionScoreMode { /// - /// Scores are summed. + /// + /// Scores are summed. + /// /// [EnumMember(Value = "sum")] Sum, /// - /// Scores are multiplied. + /// + /// Scores are multiplied. + /// /// [EnumMember(Value = "multiply")] Multiply, /// - /// Minimum score is used. + /// + /// Minimum score is used. + /// /// [EnumMember(Value = "min")] Min, /// - /// Maximum score is used. + /// + /// Maximum score is used. + /// /// [EnumMember(Value = "max")] Max, /// - /// The first function that has a matching filter is applied. + /// + /// The first function that has a matching filter is applied. + /// /// [EnumMember(Value = "first")] First, /// - /// Scores are averaged. + /// + /// Scores are averaged. + /// /// [EnumMember(Value = "avg")] Avg @@ -491,12 +542,16 @@ public enum GeoValidationMethod [EnumMember(Value = "strict")] Strict, /// - /// Accept geo points with invalid latitude or longitude. + /// + /// Accept geo points with invalid latitude or longitude. + /// /// [EnumMember(Value = "ignore_malformed")] IgnoreMalformed, /// - /// Accept geo points with invalid latitude or longitude and additionally try and infer correct coordinates. + /// + /// Accept geo points with invalid latitude or longitude and additionally try and infer correct coordinates. + /// /// [EnumMember(Value = "coerce")] Coerce @@ -544,22 +599,30 @@ public override void Write(Utf8JsonWriter writer, GeoValidationMethod value, Jso public enum MultiValueMode { /// - /// Distance is the sum of all distances. + /// + /// Distance is the sum of all distances. + /// /// [EnumMember(Value = "sum")] Sum, /// - /// Distance is the minimum distance. + /// + /// Distance is the minimum distance. + /// /// [EnumMember(Value = "min")] Min, /// - /// Distance is the maximum distance. + /// + /// Distance is the maximum distance. + /// /// [EnumMember(Value = "max")] Max, /// - /// Distance is the average distance. + /// + /// Distance is the average distance. + /// /// [EnumMember(Value = "avg")] Avg @@ -656,17 +719,23 @@ public override void Write(Utf8JsonWriter writer, Operator value, JsonSerializer public enum RangeRelation { /// - /// Matches documents with a range field value entirely within the query’s range. + /// + /// Matches documents with a range field value entirely within the query’s range. + /// /// [EnumMember(Value = "within")] Within, /// - /// Matches documents with a range field value that intersects the query’s range. + /// + /// Matches documents with a range field value that intersects the query’s range. + /// /// [EnumMember(Value = "intersects")] Intersects, /// - /// Matches documents with a range field value that entirely contains the query’s range. + /// + /// Matches documents with a range field value that entirely contains the query’s range. + /// /// [EnumMember(Value = "contains")] Contains @@ -715,67 +784,95 @@ public override void Write(Utf8JsonWriter writer, RangeRelation value, JsonSeria public enum SimpleQueryStringFlag { /// - /// Enables whitespace as split characters. + /// + /// Enables whitespace as split characters. + /// /// [EnumMember(Value = "WHITESPACE")] Whitespace = 1 << 0, /// - /// Enables the `~N` operator, after a phrase where `N` is maximum number of positions allowed between matching tokens.
Synonymous to `NEAR`. + /// + /// Enables the ~N operator, after a phrase where N is maximum number of positions allowed between matching tokens. + /// Synonymous to NEAR. + /// /// [EnumMember(Value = "SLOP")] Slop = 1 << 1, /// - /// Enables the `*` prefix operator. + /// + /// Enables the * prefix operator. + /// /// [EnumMember(Value = "PREFIX")] Prefix = 1 << 2, /// - /// Enables the `(` and `)` operators to control operator precedence. + /// + /// Enables the ( and ) operators to control operator precedence. + /// /// [EnumMember(Value = "PRECEDENCE")] Precedence = 1 << 3, /// - /// Enables the `"` quotes operator used to search for phrases. + /// + /// Enables the " quotes operator used to search for phrases. + /// /// [EnumMember(Value = "PHRASE")] Phrase = 1 << 4, /// - /// Enables the `\|` OR operator. + /// + /// Enables the \| OR operator. + /// /// [EnumMember(Value = "OR")] Or = 1 << 5, /// - /// Enables the `-` NOT operator. + /// + /// Enables the - NOT operator. + /// /// [EnumMember(Value = "NOT")] Not = 1 << 6, /// - /// Disables all operators. + /// + /// Disables all operators. + /// /// [EnumMember(Value = "NONE")] None = 1 << 7, /// - /// Enables the `~N` operator, after a phrase where `N` is the maximum number of positions allowed between matching tokens.
Synonymous to `SLOP`. + /// + /// Enables the ~N operator, after a phrase where N is the maximum number of positions allowed between matching tokens. + /// Synonymous to SLOP. + /// /// [EnumMember(Value = "NEAR")] Near = 1 << 8, /// - /// Enables the `~N` operator after a word, where `N` is an integer denoting the allowed edit distance for matching. + /// + /// Enables the ~N operator after a word, where N is an integer denoting the allowed edit distance for matching. + /// /// [EnumMember(Value = "FUZZY")] Fuzzy = 1 << 9, /// - /// Enables `\` as an escape character. + /// + /// Enables \ as an escape character. + /// /// [EnumMember(Value = "ESCAPE")] Escape = 1 << 10, /// - /// Enables the `+` AND operator. + /// + /// Enables the + AND operator. + /// /// [EnumMember(Value = "AND")] And = 1 << 11, /// - /// Enables all optional operators. + /// + /// Enables all optional operators. + /// /// [EnumMember(Value = "ALL")] All = 1 << 12 @@ -867,32 +964,45 @@ public override void Write(Utf8JsonWriter writer, SimpleQueryStringFlag value, J public enum TextQueryType { /// - /// Runs a `match_phrase_prefix` query on each field and uses the `_score` from the best field. + /// + /// Runs a match_phrase_prefix query on each field and uses the _score from the best field. + /// /// [EnumMember(Value = "phrase_prefix")] PhrasePrefix, /// - /// Runs a `match_phrase` query on each field and uses the `_score` from the best field. + /// + /// Runs a match_phrase query on each field and uses the _score from the best field. + /// /// [EnumMember(Value = "phrase")] Phrase, /// - /// Finds documents that match any field and combines the `_score` from each field. + /// + /// Finds documents that match any field and combines the _score from each field. + /// /// [EnumMember(Value = "most_fields")] MostFields, /// - /// Treats fields with the same analyzer as though they were one big field.
Looks for each word in any field. + /// + /// Treats fields with the same analyzer as though they were one big field. + /// Looks for each word in any field. + /// /// [EnumMember(Value = "cross_fields")] CrossFields, /// - /// Creates a `match_bool_prefix` query on each field and combines the `_score` from each field. + /// + /// Creates a match_bool_prefix query on each field and combines the _score from each field. + /// /// [EnumMember(Value = "bool_prefix")] BoolPrefix, /// - /// Finds documents that match any field, but uses the `_score` from the best field. + /// + /// Finds documents that match any field, but uses the _score from the best field. + /// /// [EnumMember(Value = "best_fields")] BestFields @@ -955,12 +1065,16 @@ public override void Write(Utf8JsonWriter writer, TextQueryType value, JsonSeria public enum ZeroTermsQuery { /// - /// No documents are returned if the `analyzer` removes all tokens. + /// + /// No documents are returned if the analyzer removes all tokens. + /// /// [EnumMember(Value = "none")] None, /// - /// Returns all documents, similar to a `match_all` query. + /// + /// Returns all documents, similar to a match_all query. + /// /// [EnumMember(Value = "all")] All diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Snapshot.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Snapshot.g.cs index 3a75691f980..f6ecd4edf17 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Snapshot.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Snapshot.g.cs @@ -32,27 +32,37 @@ namespace Elastic.Clients.Elasticsearch.Snapshot; public enum ShardsStatsStage { /// - /// Number of shards in the snapshot that are in the started stage of being stored in the repository. + /// + /// Number of shards in the snapshot that are in the started stage of being stored in the repository. + /// /// [EnumMember(Value = "STARTED")] Started, /// - /// Number of shards in the snapshot that are in the initializing stage of being stored in the repository. + /// + /// Number of shards in the snapshot that are in the initializing stage of being stored in the repository. + /// /// [EnumMember(Value = "INIT")] Init, /// - /// Number of shards in the snapshot that are in the finalizing stage of being stored in the repository. + /// + /// Number of shards in the snapshot that are in the finalizing stage of being stored in the repository. + /// /// [EnumMember(Value = "FINALIZE")] Finalize, /// - /// Number of shards in the snapshot that were not successfully stored in the repository. + /// + /// Number of shards in the snapshot that were not successfully stored in the repository. + /// /// [EnumMember(Value = "FAILURE")] Failure, /// - /// Number of shards in the snapshot that were successfully stored in the repository. + /// + /// Number of shards in the snapshot that were successfully stored in the repository. + /// /// [EnumMember(Value = "DONE")] Done diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Tasks.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Tasks.g.cs index fae9e44b256..23950271dfa 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Tasks.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Tasks.g.cs @@ -32,17 +32,23 @@ namespace Elastic.Clients.Elasticsearch.Tasks; public enum GroupBy { /// - /// Parent task ID + /// + /// Parent task ID + /// /// [EnumMember(Value = "parents")] Parents, /// - /// Do not group tasks. + /// + /// Do not group tasks. + /// /// [EnumMember(Value = "none")] None, /// - /// Node ID + /// + /// Node ID + /// /// [EnumMember(Value = "nodes")] Nodes diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Eql/EqlHits.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Eql/EqlHits.g.cs index c0ea7cc9f90..87713b7a04f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Eql/EqlHits.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Eql/EqlHits.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Eql; public sealed partial class EqlHits { /// - /// Contains events matching the query. Each object represents a matching event. + /// + /// Contains events matching the query. Each object represents a matching event. + /// /// [JsonInclude, JsonPropertyName("events")] public IReadOnlyCollection>? Events { get; init; } /// - /// Contains event sequences matching the query. Each object represents a matching sequence. This parameter is only returned for EQL queries containing a sequence. + /// + /// Contains event sequences matching the query. Each object represents a matching sequence. This parameter is only returned for EQL queries containing a sequence. + /// /// [JsonInclude, JsonPropertyName("sequences")] public IReadOnlyCollection>? Sequences { get; init; } /// - /// Metadata about the number of matching events or sequences. + /// + /// Metadata about the number of matching events or sequences. + /// /// [JsonInclude, JsonPropertyName("total")] public Elastic.Clients.Elasticsearch.Core.Search.TotalHits? Total { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Eql/HitsEvent.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Eql/HitsEvent.g.cs index 5a7223007d0..6ec2792b4d5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Eql/HitsEvent.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Eql/HitsEvent.g.cs @@ -34,25 +34,33 @@ public sealed partial class HitsEvent public IReadOnlyDictionary>? Fields { get; init; } /// - /// Unique identifier for the event. This ID is only unique within the index. + /// + /// Unique identifier for the event. This ID is only unique within the index. + /// /// [JsonInclude, JsonPropertyName("_id")] public string Id { get; init; } /// - /// Name of the index containing the event. + /// + /// Name of the index containing the event. + /// /// [JsonInclude, JsonPropertyName("_index")] public string Index { get; init; } /// - /// Set to `true` for events in a timespan-constrained sequence that do not meet a given condition. + /// + /// Set to true for events in a timespan-constrained sequence that do not meet a given condition. + /// /// [JsonInclude, JsonPropertyName("missing")] public bool? Missing { get; init; } /// - /// Original JSON body passed for the event at index time. + /// + /// Original JSON body passed for the event at index time. + /// /// [JsonInclude, JsonPropertyName("_source")] [SourceConverter] diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Eql/HitsSequence.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Eql/HitsSequence.g.cs index ae42054abf8..a2f67ae5619 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Eql/HitsSequence.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Eql/HitsSequence.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Eql; public sealed partial class HitsSequence { /// - /// Contains events matching the query. Each object represents a matching event. + /// + /// Contains events matching the query. Each object represents a matching event. + /// /// [JsonInclude, JsonPropertyName("events")] public IReadOnlyCollection> Events { get; init; } /// - /// Shared field values used to constrain matches in the sequence. These are defined using the by keyword in the EQL query syntax. + /// + /// Shared field values used to constrain matches in the sequence. These are defined using the by keyword in the EQL query syntax. + /// /// [JsonInclude, JsonPropertyName("join_keys")] public IReadOnlyCollection? JoinKeys { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/ErrorCause.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/ErrorCause.g.cs index 07bc0e4616e..55ae6e38d10 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/ErrorCause.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/ErrorCause.g.cs @@ -97,7 +97,10 @@ public override void Write(Utf8JsonWriter writer, ErrorCause value, JsonSerializ } /// -/// Cause and details about a request failure. This class defines the properties common to all error types.
Additional details are also provided, that depend on the error type. +/// +/// Cause and details about a request failure. This class defines the properties common to all error types. +/// Additional details are also provided, that depend on the error type. +/// /// [JsonConverter(typeof(ErrorCauseConverter))] public sealed partial class ErrorCause @@ -105,24 +108,32 @@ public sealed partial class ErrorCause public Elastic.Clients.Elasticsearch.ErrorCause? CausedBy { get; init; } /// - /// Additional details about the error + /// + /// Additional details about the error + /// /// public IReadOnlyDictionary Metadata { get; init; } /// - /// A human-readable explanation of the error, in english + /// + /// A human-readable explanation of the error, in english + /// /// public string? Reason { get; init; } public IReadOnlyCollection? RootCause { get; init; } /// - /// The server stack trace. Present only if the `error_trace=true` parameter was sent with the request. + /// + /// The server stack trace. Present only if the error_trace=true parameter was sent with the request. + /// /// public string? StackTrace { get; init; } public IReadOnlyCollection? Suppressed { get; init; } /// - /// The type of error + /// + /// The type of error + /// /// public string Type { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/ErrorResponseBase.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/ErrorResponseBase.g.cs index 2a0aa2d99f7..2fc8953500c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/ErrorResponseBase.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/ErrorResponseBase.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch; /// -/// The response returned by Elasticsearch when request execution did not succeed. +/// +/// The response returned by Elasticsearch when request execution did not succeed. +/// /// public sealed partial class ErrorResponseBase { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/GeoBounds.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/GeoBounds.g.cs index c6f75e0e6f3..be1e7b57175 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/GeoBounds.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/GeoBounds.g.cs @@ -31,7 +31,31 @@ namespace Elastic.Clients.Elasticsearch; /// -/// A geo bounding box. It can be represented in various ways:
- as 4 top/bottom/left/right coordinates
- as 2 top_left / bottom_right points
- as 2 top_right / bottom_left points
- as a WKT bounding box +/// +/// A geo bounding box. It can be represented in various ways: +/// +/// +/// +/// +/// as 4 top/bottom/left/right coordinates +/// +/// +/// +/// +/// as 2 top_left / bottom_right points +/// +/// +/// +/// +/// as 2 top_right / bottom_left points +/// +/// +/// +/// +/// as a WKT bounding box +/// +/// +/// /// [JsonConverter(typeof(GeoBoundsConverter))] public sealed partial class GeoBounds : IComplexUnion diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/GeoLine.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/GeoLine.g.cs index 7af28fe1bdc..126a6f621f7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/GeoLine.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/GeoLine.g.cs @@ -28,18 +28,24 @@ namespace Elastic.Clients.Elasticsearch; /// -/// A GeoJson GeoLine. +/// +/// A GeoJson GeoLine. +/// /// public sealed partial class GeoLine { /// - /// Array of `[lon, lat]` coordinates + /// + /// Array of [lon, lat] coordinates + /// /// [JsonInclude, JsonPropertyName("coordinates")] public IReadOnlyCollection> Coordinates { get; init; } /// - /// Always `"LineString"` + /// + /// Always "LineString" + /// /// [JsonInclude, JsonPropertyName("type")] public string Type { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/GeoLocation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/GeoLocation.g.cs index 5a676ecb138..6688041ea3a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/GeoLocation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/GeoLocation.g.cs @@ -31,7 +31,31 @@ namespace Elastic.Clients.Elasticsearch; /// -/// A latitude/longitude as a 2 dimensional point. It can be represented in various ways:
- as a `{lat, long}` object
- as a geo hash value
- as a `[lon, lat]` array
- as a string in `", "` or WKT point formats +/// +/// A latitude/longitude as a 2 dimensional point. It can be represented in various ways: +/// +/// +/// +/// +/// as a {lat, long} object +/// +/// +/// +/// +/// as a geo hash value +/// +/// +/// +/// +/// as a [lon, lat] array +/// +/// +/// +/// +/// as a string in "<lat>, <lon>" or WKT point formats +/// +/// +/// /// [JsonConverter(typeof(GeoLocationConverter))] public sealed partial class GeoLocation : IComplexUnion diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/GeohashPrecision.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/GeohashPrecision.g.cs index 36df32d2914..63c4fc0fb88 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/GeohashPrecision.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/GeohashPrecision.g.cs @@ -31,7 +31,9 @@ namespace Elastic.Clients.Elasticsearch; /// -/// A precision that can be expressed as a geohash length between 1 and 12, or a distance measure like "1km", "10m". +/// +/// A precision that can be expressed as a geohash length between 1 and 12, or a distance measure like "1km", "10m". +/// /// public sealed partial class GeohashPrecision : Union { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Graph/ExploreControls.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Graph/ExploreControls.g.cs index d85d33d5d2d..938e767082a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Graph/ExploreControls.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Graph/ExploreControls.g.cs @@ -30,25 +30,39 @@ namespace Elastic.Clients.Elasticsearch.Graph; public sealed partial class ExploreControls { /// - /// To avoid the top-matching documents sample being dominated by a single source of results, it is sometimes necessary to request diversity in the sample.
You can do this by selecting a single-value field and setting a maximum number of documents per value for that field. + /// + /// To avoid the top-matching documents sample being dominated by a single source of results, it is sometimes necessary to request diversity in the sample. + /// You can do this by selecting a single-value field and setting a maximum number of documents per value for that field. + /// /// [JsonInclude, JsonPropertyName("sample_diversity")] public Elastic.Clients.Elasticsearch.Graph.SampleDiversity? SampleDiversity { get; set; } /// - /// Each hop considers a sample of the best-matching documents on each shard.
Using samples improves the speed of execution and keeps exploration focused on meaningfully-connected terms.
Very small values (less than 50) might not provide sufficient weight-of-evidence to identify significant connections between terms.
Very large sample sizes can dilute the quality of the results and increase execution times. + /// + /// Each hop considers a sample of the best-matching documents on each shard. + /// Using samples improves the speed of execution and keeps exploration focused on meaningfully-connected terms. + /// Very small values (less than 50) might not provide sufficient weight-of-evidence to identify significant connections between terms. + /// Very large sample sizes can dilute the quality of the results and increase execution times. + /// /// [JsonInclude, JsonPropertyName("sample_size")] public int? SampleSize { get; set; } /// - /// The length of time in milliseconds after which exploration will be halted and the results gathered so far are returned.
This timeout is honored on a best-effort basis.
Execution might overrun this timeout if, for example, a long pause is encountered while FieldData is loaded for a field. + /// + /// The length of time in milliseconds after which exploration will be halted and the results gathered so far are returned. + /// This timeout is honored on a best-effort basis. + /// Execution might overrun this timeout if, for example, a long pause is encountered while FieldData is loaded for a field. + /// /// [JsonInclude, JsonPropertyName("timeout")] public Elastic.Clients.Elasticsearch.Duration? Timeout { get; set; } /// - /// Filters associated terms so only those that are significantly associated with your query are included. + /// + /// Filters associated terms so only those that are significantly associated with your query are included. + /// /// [JsonInclude, JsonPropertyName("use_significance")] public bool UseSignificance { get; set; } @@ -70,7 +84,10 @@ public ExploreControlsDescriptor() : base() private bool UseSignificanceValue { get; set; } /// - /// To avoid the top-matching documents sample being dominated by a single source of results, it is sometimes necessary to request diversity in the sample.
You can do this by selecting a single-value field and setting a maximum number of documents per value for that field. + /// + /// To avoid the top-matching documents sample being dominated by a single source of results, it is sometimes necessary to request diversity in the sample. + /// You can do this by selecting a single-value field and setting a maximum number of documents per value for that field. + /// /// public ExploreControlsDescriptor SampleDiversity(Elastic.Clients.Elasticsearch.Graph.SampleDiversity? sampleDiversity) { @@ -97,7 +114,12 @@ public ExploreControlsDescriptor SampleDiversity(Action - /// Each hop considers a sample of the best-matching documents on each shard.
Using samples improves the speed of execution and keeps exploration focused on meaningfully-connected terms.
Very small values (less than 50) might not provide sufficient weight-of-evidence to identify significant connections between terms.
Very large sample sizes can dilute the quality of the results and increase execution times. + /// + /// Each hop considers a sample of the best-matching documents on each shard. + /// Using samples improves the speed of execution and keeps exploration focused on meaningfully-connected terms. + /// Very small values (less than 50) might not provide sufficient weight-of-evidence to identify significant connections between terms. + /// Very large sample sizes can dilute the quality of the results and increase execution times. + /// /// public ExploreControlsDescriptor SampleSize(int? sampleSize) { @@ -106,7 +128,11 @@ public ExploreControlsDescriptor SampleSize(int? sampleSize) } /// - /// The length of time in milliseconds after which exploration will be halted and the results gathered so far are returned.
This timeout is honored on a best-effort basis.
Execution might overrun this timeout if, for example, a long pause is encountered while FieldData is loaded for a field. + /// + /// The length of time in milliseconds after which exploration will be halted and the results gathered so far are returned. + /// This timeout is honored on a best-effort basis. + /// Execution might overrun this timeout if, for example, a long pause is encountered while FieldData is loaded for a field. + /// /// public ExploreControlsDescriptor Timeout(Elastic.Clients.Elasticsearch.Duration? timeout) { @@ -115,7 +141,9 @@ public ExploreControlsDescriptor Timeout(Elastic.Clients.Elasticsearc } /// - /// Filters associated terms so only those that are significantly associated with your query are included. + /// + /// Filters associated terms so only those that are significantly associated with your query are included. + /// /// public ExploreControlsDescriptor UseSignificance(bool useSignificance = true) { @@ -176,7 +204,10 @@ public ExploreControlsDescriptor() : base() private bool UseSignificanceValue { get; set; } /// - /// To avoid the top-matching documents sample being dominated by a single source of results, it is sometimes necessary to request diversity in the sample.
You can do this by selecting a single-value field and setting a maximum number of documents per value for that field. + /// + /// To avoid the top-matching documents sample being dominated by a single source of results, it is sometimes necessary to request diversity in the sample. + /// You can do this by selecting a single-value field and setting a maximum number of documents per value for that field. + /// /// public ExploreControlsDescriptor SampleDiversity(Elastic.Clients.Elasticsearch.Graph.SampleDiversity? sampleDiversity) { @@ -203,7 +234,12 @@ public ExploreControlsDescriptor SampleDiversity(Action - /// Each hop considers a sample of the best-matching documents on each shard.
Using samples improves the speed of execution and keeps exploration focused on meaningfully-connected terms.
Very small values (less than 50) might not provide sufficient weight-of-evidence to identify significant connections between terms.
Very large sample sizes can dilute the quality of the results and increase execution times. + /// + /// Each hop considers a sample of the best-matching documents on each shard. + /// Using samples improves the speed of execution and keeps exploration focused on meaningfully-connected terms. + /// Very small values (less than 50) might not provide sufficient weight-of-evidence to identify significant connections between terms. + /// Very large sample sizes can dilute the quality of the results and increase execution times. + /// /// public ExploreControlsDescriptor SampleSize(int? sampleSize) { @@ -212,7 +248,11 @@ public ExploreControlsDescriptor SampleSize(int? sampleSize) } /// - /// The length of time in milliseconds after which exploration will be halted and the results gathered so far are returned.
This timeout is honored on a best-effort basis.
Execution might overrun this timeout if, for example, a long pause is encountered while FieldData is loaded for a field. + /// + /// The length of time in milliseconds after which exploration will be halted and the results gathered so far are returned. + /// This timeout is honored on a best-effort basis. + /// Execution might overrun this timeout if, for example, a long pause is encountered while FieldData is loaded for a field. + /// /// public ExploreControlsDescriptor Timeout(Elastic.Clients.Elasticsearch.Duration? timeout) { @@ -221,7 +261,9 @@ public ExploreControlsDescriptor Timeout(Elastic.Clients.Elasticsearch.Duration? } /// - /// Filters associated terms so only those that are significantly associated with your query are included. + /// + /// Filters associated terms so only those that are significantly associated with your query are included. + /// /// public ExploreControlsDescriptor UseSignificance(bool useSignificance = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Graph/Hop.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Graph/Hop.g.cs index 8d5480f9ef8..6fc41e9426f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Graph/Hop.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Graph/Hop.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Graph; public sealed partial class Hop { /// - /// Specifies one or more fields from which you want to extract terms that are associated with the specified vertices. + /// + /// Specifies one or more fields from which you want to extract terms that are associated with the specified vertices. + /// /// [JsonInclude, JsonPropertyName("connections")] public Elastic.Clients.Elasticsearch.Graph.Hop? Connections { get; set; } /// - /// An optional guiding query that constrains the Graph API as it explores connected terms. + /// + /// An optional guiding query that constrains the Graph API as it explores connected terms. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query Query { get; set; } /// - /// Contains the fields you are interested in. + /// + /// Contains the fields you are interested in. + /// /// [JsonInclude, JsonPropertyName("vertices")] public ICollection Vertices { get; set; } @@ -68,7 +74,9 @@ public HopDescriptor() : base() private Action>[] VerticesDescriptorActions { get; set; } /// - /// Specifies one or more fields from which you want to extract terms that are associated with the specified vertices. + /// + /// Specifies one or more fields from which you want to extract terms that are associated with the specified vertices. + /// /// public HopDescriptor Connections(Elastic.Clients.Elasticsearch.Graph.Hop? connections) { @@ -95,7 +103,9 @@ public HopDescriptor Connections(Action - /// An optional guiding query that constrains the Graph API as it explores connected terms. + /// + /// An optional guiding query that constrains the Graph API as it explores connected terms. + /// /// public HopDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query query) { @@ -122,7 +132,9 @@ public HopDescriptor Query(Action - /// Contains the fields you are interested in. + /// + /// Contains the fields you are interested in. + /// /// public HopDescriptor Vertices(ICollection vertices) { @@ -250,7 +262,9 @@ public HopDescriptor() : base() private Action[] VerticesDescriptorActions { get; set; } /// - /// Specifies one or more fields from which you want to extract terms that are associated with the specified vertices. + /// + /// Specifies one or more fields from which you want to extract terms that are associated with the specified vertices. + /// /// public HopDescriptor Connections(Elastic.Clients.Elasticsearch.Graph.Hop? connections) { @@ -277,7 +291,9 @@ public HopDescriptor Connections(Action - /// An optional guiding query that constrains the Graph API as it explores connected terms. + /// + /// An optional guiding query that constrains the Graph API as it explores connected terms. + /// /// public HopDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query query) { @@ -304,7 +320,9 @@ public HopDescriptor Query(Action - /// Contains the fields you are interested in. + /// + /// Contains the fields you are interested in. + /// /// public HopDescriptor Vertices(ICollection vertices) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Graph/VertexDefinition.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Graph/VertexDefinition.g.cs index ba863d2919e..10866647fd7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Graph/VertexDefinition.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Graph/VertexDefinition.g.cs @@ -30,37 +30,50 @@ namespace Elastic.Clients.Elasticsearch.Graph; public sealed partial class VertexDefinition { /// - /// Prevents the specified terms from being included in the results. + /// + /// Prevents the specified terms from being included in the results. + /// /// [JsonInclude, JsonPropertyName("exclude")] public ICollection? Exclude { get; set; } /// - /// Identifies a field in the documents of interest. + /// + /// Identifies a field in the documents of interest. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Identifies the terms of interest that form the starting points from which you want to spider out. + /// + /// Identifies the terms of interest that form the starting points from which you want to spider out. + /// /// [JsonInclude, JsonPropertyName("include")] public ICollection? Include { get; set; } /// - /// Specifies how many documents must contain a pair of terms before it is considered to be a useful connection.
This setting acts as a certainty threshold. + /// + /// Specifies how many documents must contain a pair of terms before it is considered to be a useful connection. + /// This setting acts as a certainty threshold. + /// /// [JsonInclude, JsonPropertyName("min_doc_count")] public long? MinDocCount { get; set; } /// - /// Controls how many documents on a particular shard have to contain a pair of terms before the connection is returned for global consideration. + /// + /// Controls how many documents on a particular shard have to contain a pair of terms before the connection is returned for global consideration. + /// /// [JsonInclude, JsonPropertyName("shard_min_doc_count")] public long? ShardMinDocCount { get; set; } /// - /// Specifies the maximum number of vertex terms returned for each field. + /// + /// Specifies the maximum number of vertex terms returned for each field. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } @@ -85,7 +98,9 @@ public VertexDefinitionDescriptor() : base() private int? SizeValue { get; set; } /// - /// Prevents the specified terms from being included in the results. + /// + /// Prevents the specified terms from being included in the results. + /// /// public VertexDefinitionDescriptor Exclude(ICollection? exclude) { @@ -94,7 +109,9 @@ public VertexDefinitionDescriptor Exclude(ICollection? exclud } /// - /// Identifies a field in the documents of interest. + /// + /// Identifies a field in the documents of interest. + /// /// public VertexDefinitionDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -103,7 +120,9 @@ public VertexDefinitionDescriptor Field(Elastic.Clients.Elasticsearch } /// - /// Identifies a field in the documents of interest. + /// + /// Identifies a field in the documents of interest. + /// /// public VertexDefinitionDescriptor Field(Expression> field) { @@ -112,7 +131,9 @@ public VertexDefinitionDescriptor Field(Expression - /// Identifies a field in the documents of interest. + /// + /// Identifies a field in the documents of interest. + /// /// public VertexDefinitionDescriptor Field(Expression> field) { @@ -121,7 +142,9 @@ public VertexDefinitionDescriptor Field(Expression - /// Identifies the terms of interest that form the starting points from which you want to spider out. + /// + /// Identifies the terms of interest that form the starting points from which you want to spider out. + /// /// public VertexDefinitionDescriptor Include(ICollection? include) { @@ -160,7 +183,10 @@ public VertexDefinitionDescriptor Include(params Action - /// Specifies how many documents must contain a pair of terms before it is considered to be a useful connection.
This setting acts as a certainty threshold. + /// + /// Specifies how many documents must contain a pair of terms before it is considered to be a useful connection. + /// This setting acts as a certainty threshold. + /// /// public VertexDefinitionDescriptor MinDocCount(long? minDocCount) { @@ -169,7 +195,9 @@ public VertexDefinitionDescriptor MinDocCount(long? minDocCount) } /// - /// Controls how many documents on a particular shard have to contain a pair of terms before the connection is returned for global consideration. + /// + /// Controls how many documents on a particular shard have to contain a pair of terms before the connection is returned for global consideration. + /// /// public VertexDefinitionDescriptor ShardMinDocCount(long? shardMinDocCount) { @@ -178,7 +206,9 @@ public VertexDefinitionDescriptor ShardMinDocCount(long? shardMinDocC } /// - /// Specifies the maximum number of vertex terms returned for each field. + /// + /// Specifies the maximum number of vertex terms returned for each field. + /// /// public VertexDefinitionDescriptor Size(int? size) { @@ -269,7 +299,9 @@ public VertexDefinitionDescriptor() : base() private int? SizeValue { get; set; } /// - /// Prevents the specified terms from being included in the results. + /// + /// Prevents the specified terms from being included in the results. + /// /// public VertexDefinitionDescriptor Exclude(ICollection? exclude) { @@ -278,7 +310,9 @@ public VertexDefinitionDescriptor Exclude(ICollection? exclude) } /// - /// Identifies a field in the documents of interest. + /// + /// Identifies a field in the documents of interest. + /// /// public VertexDefinitionDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -287,7 +321,9 @@ public VertexDefinitionDescriptor Field(Elastic.Clients.Elasticsearch.Field fiel } /// - /// Identifies a field in the documents of interest. + /// + /// Identifies a field in the documents of interest. + /// /// public VertexDefinitionDescriptor Field(Expression> field) { @@ -296,7 +332,9 @@ public VertexDefinitionDescriptor Field(Expression - /// Identifies a field in the documents of interest. + /// + /// Identifies a field in the documents of interest. + /// /// public VertexDefinitionDescriptor Field(Expression> field) { @@ -305,7 +343,9 @@ public VertexDefinitionDescriptor Field(Expression - /// Identifies the terms of interest that form the starting points from which you want to spider out. + /// + /// Identifies the terms of interest that form the starting points from which you want to spider out. + /// /// public VertexDefinitionDescriptor Include(ICollection? include) { @@ -344,7 +384,10 @@ public VertexDefinitionDescriptor Include(params Action - /// Specifies how many documents must contain a pair of terms before it is considered to be a useful connection.
This setting acts as a certainty threshold. + /// + /// Specifies how many documents must contain a pair of terms before it is considered to be a useful connection. + /// This setting acts as a certainty threshold. + /// /// public VertexDefinitionDescriptor MinDocCount(long? minDocCount) { @@ -353,7 +396,9 @@ public VertexDefinitionDescriptor MinDocCount(long? minDocCount) } /// - /// Controls how many documents on a particular shard have to contain a pair of terms before the connection is returned for global consideration. + /// + /// Controls how many documents on a particular shard have to contain a pair of terms before the connection is returned for global consideration. + /// /// public VertexDefinitionDescriptor ShardMinDocCount(long? shardMinDocCount) { @@ -362,7 +407,9 @@ public VertexDefinitionDescriptor ShardMinDocCount(long? shardMinDocCount) } /// - /// Specifies the maximum number of vertex terms returned for each field. + /// + /// Specifies the maximum number of vertex terms returned for each field. + /// /// public VertexDefinitionDescriptor Size(int? size) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexLifecycleManagement/Actions.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexLifecycleManagement/Actions.g.cs index 211040550d3..b809226b35d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexLifecycleManagement/Actions.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexLifecycleManagement/Actions.g.cs @@ -30,73 +30,97 @@ namespace Elastic.Clients.Elasticsearch.IndexLifecycleManagement; public sealed partial class Actions { /// - /// Phases allowed: warm, cold. + /// + /// Phases allowed: warm, cold. + /// /// [JsonInclude, JsonPropertyName("allocate")] public Elastic.Clients.Elasticsearch.IndexLifecycleManagement.AllocateAction? Allocate { get; set; } /// - /// Phases allowed: delete. + /// + /// Phases allowed: delete. + /// /// [JsonInclude, JsonPropertyName("delete")] public Elastic.Clients.Elasticsearch.IndexLifecycleManagement.DeleteAction? Delete { get; set; } /// - /// Phases allowed: hot, warm, cold. + /// + /// Phases allowed: hot, warm, cold. + /// /// [JsonInclude, JsonPropertyName("downsample")] public Elastic.Clients.Elasticsearch.IndexLifecycleManagement.DownsampleAction? Downsample { get; set; } /// - /// Phases allowed: hot, warm. + /// + /// Phases allowed: hot, warm. + /// /// [JsonInclude, JsonPropertyName("forcemerge")] public Elastic.Clients.Elasticsearch.IndexLifecycleManagement.ForceMergeAction? Forcemerge { get; set; } /// - /// Phases allowed: warm, cold. + /// + /// Phases allowed: warm, cold. + /// /// [JsonInclude, JsonPropertyName("migrate")] public Elastic.Clients.Elasticsearch.IndexLifecycleManagement.MigrateAction? Migrate { get; set; } /// - /// Phases allowed: hot, warm, cold. + /// + /// Phases allowed: hot, warm, cold. + /// /// [JsonInclude, JsonPropertyName("readonly")] public Elastic.Clients.Elasticsearch.EmptyObject? Readonly { get; set; } /// - /// Phases allowed: hot. + /// + /// Phases allowed: hot. + /// /// [JsonInclude, JsonPropertyName("rollover")] public Elastic.Clients.Elasticsearch.IndexLifecycleManagement.RolloverAction? Rollover { get; set; } /// - /// Phases allowed: hot, cold, frozen. + /// + /// Phases allowed: hot, cold, frozen. + /// /// [JsonInclude, JsonPropertyName("searchable_snapshot")] public Elastic.Clients.Elasticsearch.IndexLifecycleManagement.SearchableSnapshotAction? SearchableSnapshot { get; set; } /// - /// Phases allowed: hot, warm, cold. + /// + /// Phases allowed: hot, warm, cold. + /// /// [JsonInclude, JsonPropertyName("set_priority")] public Elastic.Clients.Elasticsearch.IndexLifecycleManagement.SetPriorityAction? SetPriority { get; set; } /// - /// Phases allowed: hot, warm. + /// + /// Phases allowed: hot, warm. + /// /// [JsonInclude, JsonPropertyName("shrink")] public Elastic.Clients.Elasticsearch.IndexLifecycleManagement.ShrinkAction? Shrink { get; set; } /// - /// Phases allowed: hot, warm, cold, frozen. + /// + /// Phases allowed: hot, warm, cold, frozen. + /// /// [JsonInclude, JsonPropertyName("unfollow")] public Elastic.Clients.Elasticsearch.EmptyObject? Unfollow { get; set; } /// - /// Phases allowed: delete. + /// + /// Phases allowed: delete. + /// /// [JsonInclude, JsonPropertyName("wait_for_snapshot")] public Elastic.Clients.Elasticsearch.IndexLifecycleManagement.WaitForSnapshotAction? WaitForSnapshot { get; set; } @@ -148,7 +172,9 @@ public ActionsDescriptor() : base() private Action WaitForSnapshotDescriptorAction { get; set; } /// - /// Phases allowed: warm, cold. + /// + /// Phases allowed: warm, cold. + /// /// public ActionsDescriptor Allocate(Elastic.Clients.Elasticsearch.IndexLifecycleManagement.AllocateAction? allocate) { @@ -175,7 +201,9 @@ public ActionsDescriptor Allocate(Action - /// Phases allowed: delete. + /// + /// Phases allowed: delete. + /// /// public ActionsDescriptor Delete(Elastic.Clients.Elasticsearch.IndexLifecycleManagement.DeleteAction? delete) { @@ -202,7 +230,9 @@ public ActionsDescriptor Delete(Action - /// Phases allowed: hot, warm, cold. + /// + /// Phases allowed: hot, warm, cold. + /// /// public ActionsDescriptor Downsample(Elastic.Clients.Elasticsearch.IndexLifecycleManagement.DownsampleAction? downsample) { @@ -229,7 +259,9 @@ public ActionsDescriptor Downsample(Action - /// Phases allowed: hot, warm. + /// + /// Phases allowed: hot, warm. + /// /// public ActionsDescriptor Forcemerge(Elastic.Clients.Elasticsearch.IndexLifecycleManagement.ForceMergeAction? forcemerge) { @@ -256,7 +288,9 @@ public ActionsDescriptor Forcemerge(Action - /// Phases allowed: warm, cold. + /// + /// Phases allowed: warm, cold. + /// /// public ActionsDescriptor Migrate(Elastic.Clients.Elasticsearch.IndexLifecycleManagement.MigrateAction? migrate) { @@ -283,7 +317,9 @@ public ActionsDescriptor Migrate(Action - /// Phases allowed: hot, warm, cold. + /// + /// Phases allowed: hot, warm, cold. + /// /// public ActionsDescriptor Readonly(Elastic.Clients.Elasticsearch.EmptyObject? value) { @@ -310,7 +346,9 @@ public ActionsDescriptor Readonly(Action - /// Phases allowed: hot. + /// + /// Phases allowed: hot. + /// /// public ActionsDescriptor Rollover(Elastic.Clients.Elasticsearch.IndexLifecycleManagement.RolloverAction? rollover) { @@ -337,7 +375,9 @@ public ActionsDescriptor Rollover(Action - /// Phases allowed: hot, cold, frozen. + /// + /// Phases allowed: hot, cold, frozen. + /// /// public ActionsDescriptor SearchableSnapshot(Elastic.Clients.Elasticsearch.IndexLifecycleManagement.SearchableSnapshotAction? searchableSnapshot) { @@ -364,7 +404,9 @@ public ActionsDescriptor SearchableSnapshot(Action - /// Phases allowed: hot, warm, cold. + /// + /// Phases allowed: hot, warm, cold. + /// /// public ActionsDescriptor SetPriority(Elastic.Clients.Elasticsearch.IndexLifecycleManagement.SetPriorityAction? setPriority) { @@ -391,7 +433,9 @@ public ActionsDescriptor SetPriority(Action - /// Phases allowed: hot, warm. + /// + /// Phases allowed: hot, warm. + /// /// public ActionsDescriptor Shrink(Elastic.Clients.Elasticsearch.IndexLifecycleManagement.ShrinkAction? shrink) { @@ -418,7 +462,9 @@ public ActionsDescriptor Shrink(Action - /// Phases allowed: hot, warm, cold, frozen. + /// + /// Phases allowed: hot, warm, cold, frozen. + /// /// public ActionsDescriptor Unfollow(Elastic.Clients.Elasticsearch.EmptyObject? unfollow) { @@ -445,7 +491,9 @@ public ActionsDescriptor Unfollow(Action - /// Phases allowed: delete. + /// + /// Phases allowed: delete. + /// /// public ActionsDescriptor WaitForSnapshot(Elastic.Clients.Elasticsearch.IndexLifecycleManagement.WaitForSnapshotAction? waitForSnapshot) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/AddAction.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/AddAction.g.cs index a19b36de1b9..b2238856538 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/AddAction.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/AddAction.g.cs @@ -30,68 +30,99 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class AddAction { /// - /// Alias for the action.
Index alias names support date math. + /// + /// Alias for the action. + /// Index alias names support date math. + /// /// [JsonInclude, JsonPropertyName("alias")] public Elastic.Clients.Elasticsearch.IndexAlias? Alias { get; set; } /// - /// Aliases for the action.
Index alias names support date math. + /// + /// Aliases for the action. + /// Index alias names support date math. + /// /// [JsonInclude, JsonPropertyName("aliases")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.IndexAlias))] public ICollection? Aliases { get; set; } /// - /// Query used to limit documents the alias can access. + /// + /// Query used to limit documents the alias can access. + /// /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Filter { get; set; } /// - /// Data stream or index for the action.
Supports wildcards (`*`). + /// + /// Data stream or index for the action. + /// Supports wildcards (*). + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.IndexName? Index { get; set; } /// - /// Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations.
Data stream aliases don’t support this parameter. + /// + /// Value used to route indexing operations to a specific shard. + /// If specified, this overwrites the routing value for indexing operations. + /// Data stream aliases don’t support this parameter. + /// /// [JsonInclude, JsonPropertyName("index_routing")] public Elastic.Clients.Elasticsearch.Routing? IndexRouting { get; set; } /// - /// Data streams or indices for the action.
Supports wildcards (`*`). + /// + /// Data streams or indices for the action. + /// Supports wildcards (*). + /// /// [JsonInclude, JsonPropertyName("indices")] public Elastic.Clients.Elasticsearch.Indices? Indices { get; set; } /// - /// If `true`, the alias is hidden. + /// + /// If true, the alias is hidden. + /// /// [JsonInclude, JsonPropertyName("is_hidden")] public bool? IsHidden { get; set; } /// - /// If `true`, sets the write index or data stream for the alias. + /// + /// If true, sets the write index or data stream for the alias. + /// /// [JsonInclude, JsonPropertyName("is_write_index")] public bool? IsWriteIndex { get; set; } /// - /// If `true`, the alias must exist to perform the action. + /// + /// If true, the alias must exist to perform the action. + /// /// [JsonInclude, JsonPropertyName("must_exist")] public bool? MustExist { get; set; } /// - /// Value used to route indexing and search operations to a specific shard.
Data stream aliases don’t support this parameter. + /// + /// Value used to route indexing and search operations to a specific shard. + /// Data stream aliases don’t support this parameter. + /// /// [JsonInclude, JsonPropertyName("routing")] public Elastic.Clients.Elasticsearch.Routing? Routing { get; set; } /// - /// Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations.
Data stream aliases don’t support this parameter. + /// + /// Value used to route search operations to a specific shard. + /// If specified, this overwrites the routing value for search operations. + /// Data stream aliases don’t support this parameter. + /// /// [JsonInclude, JsonPropertyName("search_routing")] public Elastic.Clients.Elasticsearch.Routing? SearchRouting { get; set; } @@ -122,7 +153,10 @@ public AddActionDescriptor() : base() private Elastic.Clients.Elasticsearch.Routing? SearchRoutingValue { get; set; } /// - /// Alias for the action.
Index alias names support date math. + /// + /// Alias for the action. + /// Index alias names support date math. + /// /// public AddActionDescriptor Alias(Elastic.Clients.Elasticsearch.IndexAlias? alias) { @@ -131,7 +165,10 @@ public AddActionDescriptor Alias(Elastic.Clients.Elasticsearch.IndexA } /// - /// Aliases for the action.
Index alias names support date math. + /// + /// Aliases for the action. + /// Index alias names support date math. + /// /// public AddActionDescriptor Aliases(ICollection? aliases) { @@ -140,7 +177,9 @@ public AddActionDescriptor Aliases(ICollection - /// Query used to limit documents the alias can access. + /// + /// Query used to limit documents the alias can access. + /// /// public AddActionDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.Query? filter) { @@ -167,7 +206,10 @@ public AddActionDescriptor Filter(Action - /// Data stream or index for the action.
Supports wildcards (`*`). + /// + /// Data stream or index for the action. + /// Supports wildcards (*). + /// /// public AddActionDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? index) { @@ -176,7 +218,11 @@ public AddActionDescriptor Index(Elastic.Clients.Elasticsearch.IndexN } /// - /// Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations.
Data stream aliases don’t support this parameter. + /// + /// Value used to route indexing operations to a specific shard. + /// If specified, this overwrites the routing value for indexing operations. + /// Data stream aliases don’t support this parameter. + /// /// public AddActionDescriptor IndexRouting(Elastic.Clients.Elasticsearch.Routing? indexRouting) { @@ -185,7 +231,10 @@ public AddActionDescriptor IndexRouting(Elastic.Clients.Elasticsearch } /// - /// Data streams or indices for the action.
Supports wildcards (`*`). + /// + /// Data streams or indices for the action. + /// Supports wildcards (*). + /// /// public AddActionDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? indices) { @@ -194,7 +243,9 @@ public AddActionDescriptor Indices(Elastic.Clients.Elasticsearch.Indi } /// - /// If `true`, the alias is hidden. + /// + /// If true, the alias is hidden. + /// /// public AddActionDescriptor IsHidden(bool? isHidden = true) { @@ -203,7 +254,9 @@ public AddActionDescriptor IsHidden(bool? isHidden = true) } /// - /// If `true`, sets the write index or data stream for the alias. + /// + /// If true, sets the write index or data stream for the alias. + /// /// public AddActionDescriptor IsWriteIndex(bool? isWriteIndex = true) { @@ -212,7 +265,9 @@ public AddActionDescriptor IsWriteIndex(bool? isWriteIndex = true) } /// - /// If `true`, the alias must exist to perform the action. + /// + /// If true, the alias must exist to perform the action. + /// /// public AddActionDescriptor MustExist(bool? mustExist = true) { @@ -221,7 +276,10 @@ public AddActionDescriptor MustExist(bool? mustExist = true) } /// - /// Value used to route indexing and search operations to a specific shard.
Data stream aliases don’t support this parameter. + /// + /// Value used to route indexing and search operations to a specific shard. + /// Data stream aliases don’t support this parameter. + /// /// public AddActionDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? routing) { @@ -230,7 +288,11 @@ public AddActionDescriptor Routing(Elastic.Clients.Elasticsearch.Rout } /// - /// Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations.
Data stream aliases don’t support this parameter. + /// + /// Value used to route search operations to a specific shard. + /// If specified, this overwrites the routing value for search operations. + /// Data stream aliases don’t support this parameter. + /// /// public AddActionDescriptor SearchRouting(Elastic.Clients.Elasticsearch.Routing? searchRouting) { @@ -344,7 +406,10 @@ public AddActionDescriptor() : base() private Elastic.Clients.Elasticsearch.Routing? SearchRoutingValue { get; set; } /// - /// Alias for the action.
Index alias names support date math. + /// + /// Alias for the action. + /// Index alias names support date math. + /// /// public AddActionDescriptor Alias(Elastic.Clients.Elasticsearch.IndexAlias? alias) { @@ -353,7 +418,10 @@ public AddActionDescriptor Alias(Elastic.Clients.Elasticsearch.IndexAlias? alias } /// - /// Aliases for the action.
Index alias names support date math. + /// + /// Aliases for the action. + /// Index alias names support date math. + /// /// public AddActionDescriptor Aliases(ICollection? aliases) { @@ -362,7 +430,9 @@ public AddActionDescriptor Aliases(ICollection - /// Query used to limit documents the alias can access. + /// + /// Query used to limit documents the alias can access. + /// /// public AddActionDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.Query? filter) { @@ -389,7 +459,10 @@ public AddActionDescriptor Filter(Action - /// Data stream or index for the action.
Supports wildcards (`*`). + /// + /// Data stream or index for the action. + /// Supports wildcards (*). + /// /// public AddActionDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? index) { @@ -398,7 +471,11 @@ public AddActionDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? index) } /// - /// Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations.
Data stream aliases don’t support this parameter. + /// + /// Value used to route indexing operations to a specific shard. + /// If specified, this overwrites the routing value for indexing operations. + /// Data stream aliases don’t support this parameter. + /// /// public AddActionDescriptor IndexRouting(Elastic.Clients.Elasticsearch.Routing? indexRouting) { @@ -407,7 +484,10 @@ public AddActionDescriptor IndexRouting(Elastic.Clients.Elasticsearch.Routing? i } /// - /// Data streams or indices for the action.
Supports wildcards (`*`). + /// + /// Data streams or indices for the action. + /// Supports wildcards (*). + /// /// public AddActionDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? indices) { @@ -416,7 +496,9 @@ public AddActionDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? indice } /// - /// If `true`, the alias is hidden. + /// + /// If true, the alias is hidden. + /// /// public AddActionDescriptor IsHidden(bool? isHidden = true) { @@ -425,7 +507,9 @@ public AddActionDescriptor IsHidden(bool? isHidden = true) } /// - /// If `true`, sets the write index or data stream for the alias. + /// + /// If true, sets the write index or data stream for the alias. + /// /// public AddActionDescriptor IsWriteIndex(bool? isWriteIndex = true) { @@ -434,7 +518,9 @@ public AddActionDescriptor IsWriteIndex(bool? isWriteIndex = true) } /// - /// If `true`, the alias must exist to perform the action. + /// + /// If true, the alias must exist to perform the action. + /// /// public AddActionDescriptor MustExist(bool? mustExist = true) { @@ -443,7 +529,10 @@ public AddActionDescriptor MustExist(bool? mustExist = true) } /// - /// Value used to route indexing and search operations to a specific shard.
Data stream aliases don’t support this parameter. + /// + /// Value used to route indexing and search operations to a specific shard. + /// Data stream aliases don’t support this parameter. + /// /// public AddActionDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? routing) { @@ -452,7 +541,11 @@ public AddActionDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? routin } /// - /// Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations.
Data stream aliases don’t support this parameter. + /// + /// Value used to route search operations to a specific shard. + /// If specified, this overwrites the routing value for search operations. + /// Data stream aliases don’t support this parameter. + /// /// public AddActionDescriptor SearchRouting(Elastic.Clients.Elasticsearch.Routing? searchRouting) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/Alias.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/Alias.g.cs index c28d915ab18..a643a43f98a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/Alias.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/Alias.g.cs @@ -30,37 +30,52 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class Alias { /// - /// Query used to limit documents the alias can access. + /// + /// Query used to limit documents the alias can access. + /// /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Filter { get; set; } /// - /// Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations. + /// + /// Value used to route indexing operations to a specific shard. + /// If specified, this overwrites the routing value for indexing operations. + /// /// [JsonInclude, JsonPropertyName("index_routing")] public Elastic.Clients.Elasticsearch.Routing? IndexRouting { get; set; } /// - /// If `true`, the alias is hidden.
All indices for the alias must have the same `is_hidden` value. + /// + /// If true, the alias is hidden. + /// All indices for the alias must have the same is_hidden value. + /// /// [JsonInclude, JsonPropertyName("is_hidden")] public bool? IsHidden { get; set; } /// - /// If `true`, the index is the write index for the alias. + /// + /// If true, the index is the write index for the alias. + /// /// [JsonInclude, JsonPropertyName("is_write_index")] public bool? IsWriteIndex { get; set; } /// - /// Value used to route indexing and search operations to a specific shard. + /// + /// Value used to route indexing and search operations to a specific shard. + /// /// [JsonInclude, JsonPropertyName("routing")] public Elastic.Clients.Elasticsearch.Routing? Routing { get; set; } /// - /// Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations. + /// + /// Value used to route search operations to a specific shard. + /// If specified, this overwrites the routing value for search operations. + /// /// [JsonInclude, JsonPropertyName("search_routing")] public Elastic.Clients.Elasticsearch.Routing? SearchRouting { get; set; } @@ -84,7 +99,9 @@ public AliasDescriptor() : base() private Elastic.Clients.Elasticsearch.Routing? SearchRoutingValue { get; set; } /// - /// Query used to limit documents the alias can access. + /// + /// Query used to limit documents the alias can access. + /// /// public AliasDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.Query? filter) { @@ -111,7 +128,10 @@ public AliasDescriptor Filter(Action - /// Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations. + /// + /// Value used to route indexing operations to a specific shard. + /// If specified, this overwrites the routing value for indexing operations. + /// /// public AliasDescriptor IndexRouting(Elastic.Clients.Elasticsearch.Routing? indexRouting) { @@ -120,7 +140,10 @@ public AliasDescriptor IndexRouting(Elastic.Clients.Elasticsearch.Rou } /// - /// If `true`, the alias is hidden.
All indices for the alias must have the same `is_hidden` value. + /// + /// If true, the alias is hidden. + /// All indices for the alias must have the same is_hidden value. + /// /// public AliasDescriptor IsHidden(bool? isHidden = true) { @@ -129,7 +152,9 @@ public AliasDescriptor IsHidden(bool? isHidden = true) } /// - /// If `true`, the index is the write index for the alias. + /// + /// If true, the index is the write index for the alias. + /// /// public AliasDescriptor IsWriteIndex(bool? isWriteIndex = true) { @@ -138,7 +163,9 @@ public AliasDescriptor IsWriteIndex(bool? isWriteIndex = true) } /// - /// Value used to route indexing and search operations to a specific shard. + /// + /// Value used to route indexing and search operations to a specific shard. + /// /// public AliasDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? routing) { @@ -147,7 +174,10 @@ public AliasDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? } /// - /// Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations. + /// + /// Value used to route search operations to a specific shard. + /// If specified, this overwrites the routing value for search operations. + /// /// public AliasDescriptor SearchRouting(Elastic.Clients.Elasticsearch.Routing? searchRouting) { @@ -226,7 +256,9 @@ public AliasDescriptor() : base() private Elastic.Clients.Elasticsearch.Routing? SearchRoutingValue { get; set; } /// - /// Query used to limit documents the alias can access. + /// + /// Query used to limit documents the alias can access. + /// /// public AliasDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.Query? filter) { @@ -253,7 +285,10 @@ public AliasDescriptor Filter(Action - /// Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations. + /// + /// Value used to route indexing operations to a specific shard. + /// If specified, this overwrites the routing value for indexing operations. + /// /// public AliasDescriptor IndexRouting(Elastic.Clients.Elasticsearch.Routing? indexRouting) { @@ -262,7 +297,10 @@ public AliasDescriptor IndexRouting(Elastic.Clients.Elasticsearch.Routing? index } /// - /// If `true`, the alias is hidden.
All indices for the alias must have the same `is_hidden` value. + /// + /// If true, the alias is hidden. + /// All indices for the alias must have the same is_hidden value. + /// /// public AliasDescriptor IsHidden(bool? isHidden = true) { @@ -271,7 +309,9 @@ public AliasDescriptor IsHidden(bool? isHidden = true) } /// - /// If `true`, the index is the write index for the alias. + /// + /// If true, the index is the write index for the alias. + /// /// public AliasDescriptor IsWriteIndex(bool? isWriteIndex = true) { @@ -280,7 +320,9 @@ public AliasDescriptor IsWriteIndex(bool? isWriteIndex = true) } /// - /// Value used to route indexing and search operations to a specific shard. + /// + /// Value used to route indexing and search operations to a specific shard. + /// /// public AliasDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? routing) { @@ -289,7 +331,10 @@ public AliasDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? routing) } /// - /// Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations. + /// + /// Value used to route search operations to a specific shard. + /// If specified, this overwrites the routing value for search operations. + /// /// public AliasDescriptor SearchRouting(Elastic.Clients.Elasticsearch.Routing? searchRouting) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/AliasDefinition.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/AliasDefinition.g.cs index 1fd430bcd7e..e777aab041b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/AliasDefinition.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/AliasDefinition.g.cs @@ -30,37 +30,52 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class AliasDefinition { /// - /// Query used to limit documents the alias can access. + /// + /// Query used to limit documents the alias can access. + /// /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Filter { get; init; } /// - /// Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations. + /// + /// Value used to route indexing operations to a specific shard. + /// If specified, this overwrites the routing value for indexing operations. + /// /// [JsonInclude, JsonPropertyName("index_routing")] public string? IndexRouting { get; init; } /// - /// If `true`, the alias is hidden.
All indices for the alias must have the same `is_hidden` value. + /// + /// If true, the alias is hidden. + /// All indices for the alias must have the same is_hidden value. + /// /// [JsonInclude, JsonPropertyName("is_hidden")] public bool? IsHidden { get; init; } /// - /// If `true`, the index is the write index for the alias. + /// + /// If true, the index is the write index for the alias. + /// /// [JsonInclude, JsonPropertyName("is_write_index")] public bool? IsWriteIndex { get; init; } /// - /// Value used to route indexing and search operations to a specific shard. + /// + /// Value used to route indexing and search operations to a specific shard. + /// /// [JsonInclude, JsonPropertyName("routing")] public string? Routing { get; init; } /// - /// Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations. + /// + /// Value used to route search operations to a specific shard. + /// If specified, this overwrites the routing value for search operations. + /// /// [JsonInclude, JsonPropertyName("search_routing")] public string? SearchRouting { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStream.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStream.g.cs index 3ac4603747d..fd16fe596b6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStream.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStream.g.cs @@ -30,91 +30,128 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class DataStream { /// - /// If `true`, the data stream allows custom routing on write request. + /// + /// If true, the data stream allows custom routing on write request. + /// /// [JsonInclude, JsonPropertyName("allow_custom_routing")] public bool? AllowCustomRouting { get; init; } /// - /// Current generation for the data stream. This number acts as a cumulative count of the stream’s rollovers, starting at 1. + /// + /// Current generation for the data stream. This number acts as a cumulative count of the stream’s rollovers, starting at 1. + /// /// [JsonInclude, JsonPropertyName("generation")] public int Generation { get; init; } /// - /// If `true`, the data stream is hidden. + /// + /// If true, the data stream is hidden. + /// /// [JsonInclude, JsonPropertyName("hidden")] public bool Hidden { get; init; } /// - /// Name of the current ILM lifecycle policy in the stream’s matching index template.
This lifecycle policy is set in the `index.lifecycle.name` setting.
If the template does not include a lifecycle policy, this property is not included in the response.
NOTE: A data stream’s backing indices may be assigned different lifecycle policies. To retrieve the lifecycle policy for individual backing indices, use the get index settings API. + /// + /// Name of the current ILM lifecycle policy in the stream’s matching index template. + /// This lifecycle policy is set in the index.lifecycle.name setting. + /// If the template does not include a lifecycle policy, this property is not included in the response. + /// NOTE: A data stream’s backing indices may be assigned different lifecycle policies. To retrieve the lifecycle policy for individual backing indices, use the get index settings API. + /// /// [JsonInclude, JsonPropertyName("ilm_policy")] public string? IlmPolicy { get; init; } /// - /// Array of objects containing information about the data stream’s backing indices.
The last item in this array contains information about the stream’s current write index. + /// + /// Array of objects containing information about the data stream’s backing indices. + /// The last item in this array contains information about the stream’s current write index. + /// /// [JsonInclude, JsonPropertyName("indices")] public IReadOnlyCollection Indices { get; init; } /// - /// Contains the configuration for the data stream lifecycle of this data stream. + /// + /// Contains the configuration for the data stream lifecycle of this data stream. + /// /// [JsonInclude, JsonPropertyName("lifecycle")] public Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycleWithRollover? Lifecycle { get; init; } /// - /// Custom metadata for the stream, copied from the `_meta` object of the stream’s matching index template.
If empty, the response omits this property. + /// + /// Custom metadata for the stream, copied from the _meta object of the stream’s matching index template. + /// If empty, the response omits this property. + /// /// [JsonInclude, JsonPropertyName("_meta")] public IReadOnlyDictionary? Meta { get; init; } /// - /// Name of the data stream. + /// + /// Name of the data stream. + /// /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } /// - /// Name of the lifecycle system that'll manage the next generation of the data stream. + /// + /// Name of the lifecycle system that'll manage the next generation of the data stream. + /// /// [JsonInclude, JsonPropertyName("next_generation_managed_by")] public Elastic.Clients.Elasticsearch.IndexManagement.ManagedBy NextGenerationManagedBy { get; init; } /// - /// Indicates if ILM should take precedence over DSL in case both are configured to managed this data stream. + /// + /// Indicates if ILM should take precedence over DSL in case both are configured to managed this data stream. + /// /// [JsonInclude, JsonPropertyName("prefer_ilm")] public bool PreferIlm { get; init; } /// - /// If `true`, the data stream is created and managed by cross-cluster replication and the local cluster can not write into this data stream or change its mappings. + /// + /// If true, the data stream is created and managed by cross-cluster replication and the local cluster can not write into this data stream or change its mappings. + /// /// [JsonInclude, JsonPropertyName("replicated")] public bool? Replicated { get; init; } /// - /// Health status of the data stream.
This health status is based on the state of the primary and replica shards of the stream’s backing indices. + /// + /// Health status of the data stream. + /// This health status is based on the state of the primary and replica shards of the stream’s backing indices. + /// /// [JsonInclude, JsonPropertyName("status")] public Elastic.Clients.Elasticsearch.HealthStatus Status { get; init; } /// - /// If `true`, the data stream is created and managed by an Elastic stack component and cannot be modified through normal user interaction. + /// + /// If true, the data stream is created and managed by an Elastic stack component and cannot be modified through normal user interaction. + /// /// [JsonInclude, JsonPropertyName("system")] public bool? System { get; init; } /// - /// Name of the index template used to create the data stream’s backing indices.
The template’s index pattern must match the name of this data stream. + /// + /// Name of the index template used to create the data stream’s backing indices. + /// The template’s index pattern must match the name of this data stream. + /// /// [JsonInclude, JsonPropertyName("template")] public string Template { get; init; } /// - /// Information about the `@timestamp` field in the data stream. + /// + /// Information about the @timestamp field in the data stream. + /// /// [JsonInclude, JsonPropertyName("timestamp_field")] public Elastic.Clients.Elasticsearch.IndexManagement.DataStreamTimestampField TimestampField { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamIndex.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamIndex.g.cs index 8f458d9304d..5a6fbd08b40 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamIndex.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamIndex.g.cs @@ -30,31 +30,41 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class DataStreamIndex { /// - /// Name of the current ILM lifecycle policy configured for this backing index. + /// + /// Name of the current ILM lifecycle policy configured for this backing index. + /// /// [JsonInclude, JsonPropertyName("ilm_policy")] public string? IlmPolicy { get; init; } /// - /// Name of the backing index. + /// + /// Name of the backing index. + /// /// [JsonInclude, JsonPropertyName("index_name")] public string IndexName { get; init; } /// - /// Universally unique identifier (UUID) for the index. + /// + /// Universally unique identifier (UUID) for the index. + /// /// [JsonInclude, JsonPropertyName("index_uuid")] public string IndexUuid { get; init; } /// - /// Name of the lifecycle system that's currently managing this backing index. + /// + /// Name of the lifecycle system that's currently managing this backing index. + /// /// [JsonInclude, JsonPropertyName("managed_by")] public Elastic.Clients.Elasticsearch.IndexManagement.ManagedBy ManagedBy { get; init; } /// - /// Indicates if ILM should take precedence over DSL in case both are configured to manage this index. + /// + /// Indicates if ILM should take precedence over DSL in case both are configured to manage this index. + /// /// [JsonInclude, JsonPropertyName("prefer_ilm")] public bool PreferIlm { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamLifecycle.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamLifecycle.g.cs index 337bcd74498..bde86c5aa76 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamLifecycle.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamLifecycle.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; /// -/// Data stream lifecycle denotes that a data stream is managed by the data stream lifecycle and contains the configuration. +/// +/// Data stream lifecycle denotes that a data stream is managed by the data stream lifecycle and contains the configuration. +/// /// public sealed partial class DataStreamLifecycle { @@ -39,7 +41,9 @@ public sealed partial class DataStreamLifecycle } /// -/// Data stream lifecycle denotes that a data stream is managed by the data stream lifecycle and contains the configuration. +/// +/// Data stream lifecycle denotes that a data stream is managed by the data stream lifecycle and contains the configuration. +/// /// public sealed partial class DataStreamLifecycleDescriptor : SerializableDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamLifecycleDownsampling.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamLifecycleDownsampling.g.cs index a8f7ae5585c..30cbf55d219 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamLifecycleDownsampling.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamLifecycleDownsampling.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class DataStreamLifecycleDownsampling { /// - /// The list of downsampling rounds to execute as part of this downsampling configuration + /// + /// The list of downsampling rounds to execute as part of this downsampling configuration + /// /// [JsonInclude, JsonPropertyName("rounds")] public ICollection Rounds { get; set; } @@ -50,7 +52,9 @@ public DataStreamLifecycleDownsamplingDescriptor() : base() private Action[] RoundsDescriptorActions { get; set; } /// - /// The list of downsampling rounds to execute as part of this downsampling configuration + /// + /// The list of downsampling rounds to execute as part of this downsampling configuration + /// /// public DataStreamLifecycleDownsamplingDescriptor Rounds(ICollection rounds) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamLifecycleWithRollover.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamLifecycleWithRollover.g.cs index cf04d0d0e25..67be908fbd6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamLifecycleWithRollover.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamLifecycleWithRollover.g.cs @@ -28,24 +28,37 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; /// -/// Data stream lifecycle with rollover can be used to display the configuration including the default rollover conditions,
if asked. +/// +/// Data stream lifecycle with rollover can be used to display the configuration including the default rollover conditions, +/// if asked. +/// /// public sealed partial class DataStreamLifecycleWithRollover { /// - /// If defined, every document added to this data stream will be stored at least for this time frame.
Any time after this duration the document could be deleted.
When empty, every document in this data stream will be stored indefinitely. + /// + /// If defined, every document added to this data stream will be stored at least for this time frame. + /// Any time after this duration the document could be deleted. + /// When empty, every document in this data stream will be stored indefinitely. + /// /// [JsonInclude, JsonPropertyName("data_retention")] public Elastic.Clients.Elasticsearch.Duration? DataRetention { get; init; } /// - /// The downsampling configuration to execute for the managed backing index after rollover. + /// + /// The downsampling configuration to execute for the managed backing index after rollover. + /// /// [JsonInclude, JsonPropertyName("downsampling")] public Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycleDownsampling? Downsampling { get; init; } /// - /// The conditions which will trigger the rollover of a backing index as configured by the cluster setting `cluster.lifecycle.default.rollover`.
This property is an implementation detail and it will only be retrieved when the query param `include_defaults` is set to true.
The contents of this field are subject to change. + /// + /// The conditions which will trigger the rollover of a backing index as configured by the cluster setting cluster.lifecycle.default.rollover. + /// This property is an implementation detail and it will only be retrieved when the query param include_defaults is set to true. + /// The contents of this field are subject to change. + /// /// [JsonInclude, JsonPropertyName("rollover")] public Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycleRolloverConditions? Rollover { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamTimestampField.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamTimestampField.g.cs index 137127633b8..4cdb9fd1daa 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamTimestampField.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamTimestampField.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class DataStreamTimestampField { /// - /// Name of the timestamp field for the data stream, which must be `@timestamp`. The `@timestamp` field must be included in every document indexed to the data stream. + /// + /// Name of the timestamp field for the data stream, which must be @timestamp. The @timestamp field must be included in every document indexed to the data stream. + /// /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamsStatsItem.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamsStatsItem.g.cs index 26e30d448d7..5b8640e9fb8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamsStatsItem.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamsStatsItem.g.cs @@ -30,31 +30,46 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class DataStreamsStatsItem { /// - /// Current number of backing indices for the data stream. + /// + /// Current number of backing indices for the data stream. + /// /// [JsonInclude, JsonPropertyName("backing_indices")] public int BackingIndices { get; init; } /// - /// Name of the data stream. + /// + /// Name of the data stream. + /// /// [JsonInclude, JsonPropertyName("data_stream")] public string DataStream { get; init; } /// - /// The data stream’s highest `@timestamp` value, converted to milliseconds since the Unix epoch.
NOTE: This timestamp is provided as a best effort.
The data stream may contain `@timestamp` values higher than this if one or more of the following conditions are met:
The stream contains closed backing indices;
Backing indices with a lower generation contain higher `@timestamp` values. + /// + /// The data stream’s highest @timestamp value, converted to milliseconds since the Unix epoch. + /// NOTE: This timestamp is provided as a best effort. + /// The data stream may contain @timestamp values higher than this if one or more of the following conditions are met: + /// The stream contains closed backing indices; + /// Backing indices with a lower generation contain higher @timestamp values. + /// /// [JsonInclude, JsonPropertyName("maximum_timestamp")] public long MaximumTimestamp { get; init; } /// - /// Total size of all shards for the data stream’s backing indices.
This parameter is only returned if the `human` query parameter is `true`. + /// + /// Total size of all shards for the data stream’s backing indices. + /// This parameter is only returned if the human query parameter is true. + /// /// [JsonInclude, JsonPropertyName("store_size")] public Elastic.Clients.Elasticsearch.ByteSize? StoreSize { get; init; } /// - /// Total size, in bytes, of all shards for the data stream’s backing indices. + /// + /// Total size, in bytes, of all shards for the data stream’s backing indices. + /// /// [JsonInclude, JsonPropertyName("store_size_bytes")] public long StoreSizeBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DownsampleConfig.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DownsampleConfig.g.cs index 3e5c4e518f3..a6c920a16d8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DownsampleConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DownsampleConfig.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class DownsampleConfig { /// - /// The interval at which to aggregate the original time series index. + /// + /// The interval at which to aggregate the original time series index. + /// /// [JsonInclude, JsonPropertyName("fixed_interval")] public string FixedInterval { get; set; } @@ -47,7 +49,9 @@ public DownsampleConfigDescriptor() : base() private string FixedIntervalValue { get; set; } /// - /// The interval at which to aggregate the original time series index. + /// + /// The interval at which to aggregate the original time series index. + /// /// public DownsampleConfigDescriptor FixedInterval(string fixedInterval) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DownsamplingRound.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DownsamplingRound.g.cs index 6d4164323bd..7b63a71e9cb 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DownsamplingRound.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DownsamplingRound.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class DownsamplingRound { /// - /// The duration since rollover when this downsampling round should execute + /// + /// The duration since rollover when this downsampling round should execute + /// /// [JsonInclude, JsonPropertyName("after")] public Elastic.Clients.Elasticsearch.Duration After { get; set; } /// - /// The downsample configuration to execute. + /// + /// The downsample configuration to execute. + /// /// [JsonInclude, JsonPropertyName("config")] public Elastic.Clients.Elasticsearch.IndexManagement.DownsampleConfig Config { get; set; } @@ -56,7 +60,9 @@ public DownsamplingRoundDescriptor() : base() private Action ConfigDescriptorAction { get; set; } /// - /// The duration since rollover when this downsampling round should execute + /// + /// The duration since rollover when this downsampling round should execute + /// /// public DownsamplingRoundDescriptor After(Elastic.Clients.Elasticsearch.Duration after) { @@ -65,7 +71,9 @@ public DownsamplingRoundDescriptor After(Elastic.Clients.Elasticsearch.Duration } /// - /// The downsample configuration to execute. + /// + /// The downsample configuration to execute. + /// /// public DownsamplingRoundDescriptor Config(Elastic.Clients.Elasticsearch.IndexManagement.DownsampleConfig config) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/ExplainAnalyzeToken.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/ExplainAnalyzeToken.g.cs index b3c5e49d986..266cfa6e3c0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/ExplainAnalyzeToken.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/ExplainAnalyzeToken.g.cs @@ -121,7 +121,9 @@ public override void Write(Utf8JsonWriter writer, ExplainAnalyzeToken value, Jso public sealed partial class ExplainAnalyzeToken { /// - /// Additional tokenizer-specific attributes + /// + /// Additional tokenizer-specific attributes + /// /// public IReadOnlyDictionary Attributes { get; init; } public string Bytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexAndDataStreamAction.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexAndDataStreamAction.g.cs index a71afabe4d6..495d9f3a994 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexAndDataStreamAction.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexAndDataStreamAction.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class IndexAndDataStreamAction { /// - /// Data stream targeted by the action. + /// + /// Data stream targeted by the action. + /// /// [JsonInclude, JsonPropertyName("data_stream")] public Elastic.Clients.Elasticsearch.DataStreamName DataStream { get; set; } /// - /// Index for the action. + /// + /// Index for the action. + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.IndexName Index { get; set; } @@ -54,7 +58,9 @@ public IndexAndDataStreamActionDescriptor() : base() private Elastic.Clients.Elasticsearch.IndexName IndexValue { get; set; } /// - /// Data stream targeted by the action. + /// + /// Data stream targeted by the action. + /// /// public IndexAndDataStreamActionDescriptor DataStream(Elastic.Clients.Elasticsearch.DataStreamName dataStream) { @@ -63,7 +69,9 @@ public IndexAndDataStreamActionDescriptor DataStream(Elastic.Clients.Elasticsear } /// - /// Index for the action. + /// + /// Index for the action. + /// /// public IndexAndDataStreamActionDescriptor Index(Elastic.Clients.Elasticsearch.IndexName index) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexSettings.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexSettings.g.cs index fcd2f450e01..413a5276c83 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexSettings.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexSettings.g.cs @@ -747,7 +747,9 @@ public sealed partial class IndexSettings public Elastic.Clients.Elasticsearch.IndexManagement.IndexSettingsAnalysis? Analysis { get; set; } /// - /// Settings to define analyzers, tokenizers, token filters and character filters. + /// + /// Settings to define analyzers, tokenizers, token filters and character filters. + /// /// public Elastic.Clients.Elasticsearch.IndexManagement.SettingsAnalyze? Analyze { get; set; } public string? AutoExpandReplicas { get; set; } @@ -765,7 +767,9 @@ public sealed partial class IndexSettings public Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings? Index { get; set; } /// - /// Configure indexing back pressure limits. + /// + /// Configure indexing back pressure limits. + /// /// public Elastic.Clients.Elasticsearch.IndexManagement.IndexingPressure? IndexingPressure { get; set; } public Elastic.Clients.Elasticsearch.IndexManagement.IndexingSlowlogSettings? IndexingSlowlog { get; set; } @@ -773,7 +777,9 @@ public sealed partial class IndexSettings public bool? LoadFixedBitsetFiltersEagerly { get; set; } /// - /// Enable or disable dynamic mapping for an index. + /// + /// Enable or disable dynamic mapping for an index. + /// /// public Elastic.Clients.Elasticsearch.IndexManagement.MappingLimitSettings? Mapping { get; set; } public int? MaxDocvalueFieldsSearch { get; set; } @@ -794,7 +800,9 @@ public sealed partial class IndexSettings public object? NumberOfShards { get; set; } /// - /// Additional settings not covered in this type. Unless these settings are defined by a plugin, please open an issue on the [Elasticsearch API specification](https://github.com/elastic/elasticsearch-specification) so that they can be added in a future release + /// + /// Additional settings not covered in this type. Unless these settings are defined by a plugin, please open an issue on the Elasticsearch API specification so that they can be added in a future release + /// /// public IDictionary OtherSettings { get; set; } public object? Priority { get; set; } @@ -809,14 +817,18 @@ public sealed partial class IndexSettings public Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings? Settings { get; set; } /// - /// Configure custom similarity settings to customize how search results are scored. + /// + /// Configure custom similarity settings to customize how search results are scored. + /// /// public Elastic.Clients.Elasticsearch.IndexManagement.SettingsSimilarities? Similarity { get; set; } public Elastic.Clients.Elasticsearch.IndexManagement.SoftDeletes? SoftDeletes { get; set; } public Elastic.Clients.Elasticsearch.IndexManagement.IndexSegmentSort? Sort { get; set; } /// - /// The store module allows you to control how index data is stored and accessed on disk. + /// + /// The store module allows you to control how index data is stored and accessed on disk. + /// /// public Elastic.Clients.Elasticsearch.IndexManagement.Storage? Store { get; set; } public Elastic.Clients.Elasticsearch.IndexManagement.IndexSettingsTimeSeries? TimeSeries { get; set; } @@ -963,7 +975,9 @@ public IndexSettingsDescriptor Analysis(Action - /// Settings to define analyzers, tokenizers, token filters and character filters. + /// + /// Settings to define analyzers, tokenizers, token filters and character filters. + /// /// public IndexSettingsDescriptor Analyze(Elastic.Clients.Elasticsearch.IndexManagement.SettingsAnalyze? analyze) { @@ -1122,7 +1136,9 @@ public IndexSettingsDescriptor Index(Action - /// Configure indexing back pressure limits. + /// + /// Configure indexing back pressure limits. + /// /// public IndexSettingsDescriptor IndexingPressure(Elastic.Clients.Elasticsearch.IndexManagement.IndexingPressure? indexingPressure) { @@ -1203,7 +1219,9 @@ public IndexSettingsDescriptor LoadFixedBitsetFiltersEagerly(bool? lo } /// - /// Enable or disable dynamic mapping for an index. + /// + /// Enable or disable dynamic mapping for an index. + /// /// public IndexSettingsDescriptor Mapping(Elastic.Clients.Elasticsearch.IndexManagement.MappingLimitSettings? mapping) { @@ -1344,7 +1362,9 @@ public IndexSettingsDescriptor NumberOfShards(object? numberOfShards) } /// - /// Additional settings not covered in this type. Unless these settings are defined by a plugin, please open an issue on the [Elasticsearch API specification](https://github.com/elastic/elasticsearch-specification) so that they can be added in a future release + /// + /// Additional settings not covered in this type. Unless these settings are defined by a plugin, please open an issue on the Elasticsearch API specification so that they can be added in a future release + /// /// public IndexSettingsDescriptor OtherSettings(Func, FluentDictionary> selector) { @@ -1503,7 +1523,9 @@ public IndexSettingsDescriptor Settings(Action - /// Configure custom similarity settings to customize how search results are scored. + /// + /// Configure custom similarity settings to customize how search results are scored. + /// /// public IndexSettingsDescriptor Similarity(Elastic.Clients.Elasticsearch.IndexManagement.SettingsSimilarities? similarity) { @@ -1574,7 +1596,9 @@ public IndexSettingsDescriptor Sort(Action - /// The store module allows you to control how index data is stored and accessed on disk. + /// + /// The store module allows you to control how index data is stored and accessed on disk. + /// /// public IndexSettingsDescriptor Store(Elastic.Clients.Elasticsearch.IndexManagement.Storage? store) { @@ -2388,7 +2412,9 @@ public IndexSettingsDescriptor Analysis(Action - /// Settings to define analyzers, tokenizers, token filters and character filters. + /// + /// Settings to define analyzers, tokenizers, token filters and character filters. + /// /// public IndexSettingsDescriptor Analyze(Elastic.Clients.Elasticsearch.IndexManagement.SettingsAnalyze? analyze) { @@ -2547,7 +2573,9 @@ public IndexSettingsDescriptor Index(Action - /// Configure indexing back pressure limits. + /// + /// Configure indexing back pressure limits. + /// /// public IndexSettingsDescriptor IndexingPressure(Elastic.Clients.Elasticsearch.IndexManagement.IndexingPressure? indexingPressure) { @@ -2628,7 +2656,9 @@ public IndexSettingsDescriptor LoadFixedBitsetFiltersEagerly(bool? loadFixedBits } /// - /// Enable or disable dynamic mapping for an index. + /// + /// Enable or disable dynamic mapping for an index. + /// /// public IndexSettingsDescriptor Mapping(Elastic.Clients.Elasticsearch.IndexManagement.MappingLimitSettings? mapping) { @@ -2769,7 +2799,9 @@ public IndexSettingsDescriptor NumberOfShards(object? numberOfShards) } /// - /// Additional settings not covered in this type. Unless these settings are defined by a plugin, please open an issue on the [Elasticsearch API specification](https://github.com/elastic/elasticsearch-specification) so that they can be added in a future release + /// + /// Additional settings not covered in this type. Unless these settings are defined by a plugin, please open an issue on the Elasticsearch API specification so that they can be added in a future release + /// /// public IndexSettingsDescriptor OtherSettings(Func, FluentDictionary> selector) { @@ -2928,7 +2960,9 @@ public IndexSettingsDescriptor Settings(Action - /// Configure custom similarity settings to customize how search results are scored. + /// + /// Configure custom similarity settings to customize how search results are scored. + /// /// public IndexSettingsDescriptor Similarity(Elastic.Clients.Elasticsearch.IndexManagement.SettingsSimilarities? similarity) { @@ -2999,7 +3033,9 @@ public IndexSettingsDescriptor Sort(Action - /// The store module allows you to control how index data is stored and accessed on disk. + /// + /// The store module allows you to control how index data is stored and accessed on disk. + /// /// public IndexSettingsDescriptor Store(Elastic.Clients.Elasticsearch.IndexManagement.Storage? store) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexSettingsLifecycle.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexSettingsLifecycle.g.cs index d2b7edca03d..74651d5ea79 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexSettingsLifecycle.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexSettingsLifecycle.g.cs @@ -30,31 +30,49 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class IndexSettingsLifecycle { /// - /// Indicates whether or not the index has been rolled over. Automatically set to true when ILM completes the rollover action.
You can explicitly set it to skip rollover. + /// + /// Indicates whether or not the index has been rolled over. Automatically set to true when ILM completes the rollover action. + /// You can explicitly set it to skip rollover. + /// /// [JsonInclude, JsonPropertyName("indexing_complete")] public bool? IndexingComplete { get; set; } /// - /// The name of the policy to use to manage the index. For information about how Elasticsearch applies policy changes, see Policy updates. + /// + /// The name of the policy to use to manage the index. For information about how Elasticsearch applies policy changes, see Policy updates. + /// /// [JsonInclude, JsonPropertyName("name")] public Elastic.Clients.Elasticsearch.Name? Name { get; set; } /// - /// If specified, this is the timestamp used to calculate the index age for its phase transitions. Use this setting
if you create a new index that contains old data and want to use the original creation date to calculate the index
age. Specified as a Unix epoch value in milliseconds. + /// + /// If specified, this is the timestamp used to calculate the index age for its phase transitions. Use this setting + /// if you create a new index that contains old data and want to use the original creation date to calculate the index + /// age. Specified as a Unix epoch value in milliseconds. + /// /// [JsonInclude, JsonPropertyName("origination_date")] public long? OriginationDate { get; set; } /// - /// Set to true to parse the origination date from the index name. This origination date is used to calculate the index age
for its phase transitions. The index name must match the pattern ^.*-{date_format}-\\d+, where the date_format is
yyyy.MM.dd and the trailing digits are optional. An index that was rolled over would normally match the full format,
for example logs-2016.10.31-000002). If the index name doesn’t match the pattern, index creation fails. + /// + /// Set to true to parse the origination date from the index name. This origination date is used to calculate the index age + /// for its phase transitions. The index name must match the pattern ^.*-{date_format}-\d+, where the date_format is + /// yyyy.MM.dd and the trailing digits are optional. An index that was rolled over would normally match the full format, + /// for example logs-2016.10.31-000002). If the index name doesn’t match the pattern, index creation fails. + /// /// [JsonInclude, JsonPropertyName("parse_origination_date")] public bool? ParseOriginationDate { get; set; } /// - /// The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action.
When the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more
information about rolling indices, see Rollover. + /// + /// The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action. + /// When the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more + /// information about rolling indices, see Rollover. + /// /// [JsonInclude, JsonPropertyName("rollover_alias")] public string? RolloverAlias { get; set; } @@ -80,7 +98,10 @@ public IndexSettingsLifecycleDescriptor() : base() private Action StepDescriptorAction { get; set; } /// - /// Indicates whether or not the index has been rolled over. Automatically set to true when ILM completes the rollover action.
You can explicitly set it to skip rollover. + /// + /// Indicates whether or not the index has been rolled over. Automatically set to true when ILM completes the rollover action. + /// You can explicitly set it to skip rollover. + /// /// public IndexSettingsLifecycleDescriptor IndexingComplete(bool? indexingComplete = true) { @@ -89,7 +110,9 @@ public IndexSettingsLifecycleDescriptor IndexingComplete(bool? indexingComplete } /// - /// The name of the policy to use to manage the index. For information about how Elasticsearch applies policy changes, see Policy updates. + /// + /// The name of the policy to use to manage the index. For information about how Elasticsearch applies policy changes, see Policy updates. + /// /// public IndexSettingsLifecycleDescriptor Name(Elastic.Clients.Elasticsearch.Name? name) { @@ -98,7 +121,11 @@ public IndexSettingsLifecycleDescriptor Name(Elastic.Clients.Elasticsearch.Name? } /// - /// If specified, this is the timestamp used to calculate the index age for its phase transitions. Use this setting
if you create a new index that contains old data and want to use the original creation date to calculate the index
age. Specified as a Unix epoch value in milliseconds. + /// + /// If specified, this is the timestamp used to calculate the index age for its phase transitions. Use this setting + /// if you create a new index that contains old data and want to use the original creation date to calculate the index + /// age. Specified as a Unix epoch value in milliseconds. + /// /// public IndexSettingsLifecycleDescriptor OriginationDate(long? originationDate) { @@ -107,7 +134,12 @@ public IndexSettingsLifecycleDescriptor OriginationDate(long? originationDate) } /// - /// Set to true to parse the origination date from the index name. This origination date is used to calculate the index age
for its phase transitions. The index name must match the pattern ^.*-{date_format}-\\d+, where the date_format is
yyyy.MM.dd and the trailing digits are optional. An index that was rolled over would normally match the full format,
for example logs-2016.10.31-000002). If the index name doesn’t match the pattern, index creation fails. + /// + /// Set to true to parse the origination date from the index name. This origination date is used to calculate the index age + /// for its phase transitions. The index name must match the pattern ^.*-{date_format}-\d+, where the date_format is + /// yyyy.MM.dd and the trailing digits are optional. An index that was rolled over would normally match the full format, + /// for example logs-2016.10.31-000002). If the index name doesn’t match the pattern, index creation fails. + /// /// public IndexSettingsLifecycleDescriptor ParseOriginationDate(bool? parseOriginationDate = true) { @@ -116,7 +148,11 @@ public IndexSettingsLifecycleDescriptor ParseOriginationDate(bool? parseOriginat } /// - /// The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action.
When the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more
information about rolling indices, see Rollover. + /// + /// The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action. + /// When the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more + /// information about rolling indices, see Rollover. + /// /// public IndexSettingsLifecycleDescriptor RolloverAlias(string? rolloverAlias) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexSettingsLifecycleStep.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexSettingsLifecycleStep.g.cs index f196298ed72..426ad2f8254 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexSettingsLifecycleStep.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexSettingsLifecycleStep.g.cs @@ -30,7 +30,10 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class IndexSettingsLifecycleStep { /// - /// Time to wait for the cluster to resolve allocation issues during an ILM shrink action. Must be greater than 1h (1 hour).
See Shard allocation for shrink. + /// + /// Time to wait for the cluster to resolve allocation issues during an ILM shrink action. Must be greater than 1h (1 hour). + /// See Shard allocation for shrink. + /// /// [JsonInclude, JsonPropertyName("wait_time_threshold")] public Elastic.Clients.Elasticsearch.Duration? WaitTimeThreshold { get; set; } @@ -47,7 +50,10 @@ public IndexSettingsLifecycleStepDescriptor() : base() private Elastic.Clients.Elasticsearch.Duration? WaitTimeThresholdValue { get; set; } /// - /// Time to wait for the cluster to resolve allocation issues during an ILM shrink action. Must be greater than 1h (1 hour).
See Shard allocation for shrink. + /// + /// Time to wait for the cluster to resolve allocation issues during an ILM shrink action. Must be greater than 1h (1 hour). + /// See Shard allocation for shrink. + /// /// public IndexSettingsLifecycleStepDescriptor WaitTimeThreshold(Elastic.Clients.Elasticsearch.Duration? waitTimeThreshold) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexState.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexState.g.cs index b0510903d0a..5329a4108a0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexState.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexState.g.cs @@ -35,13 +35,17 @@ public sealed partial class IndexState public Elastic.Clients.Elasticsearch.DataStreamName? DataStream { get; set; } /// - /// Default settings, included when the request's `include_default` is `true`. + /// + /// Default settings, included when the request's include_default is true. + /// /// [JsonInclude, JsonPropertyName("defaults")] public Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings? Defaults { get; set; } /// - /// Data stream lifecycle applicable if this is a data stream. + /// + /// Data stream lifecycle applicable if this is a data stream. + /// /// [JsonInclude, JsonPropertyName("lifecycle")] public Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycle? Lifecycle { get; set; } @@ -87,7 +91,9 @@ public IndexStateDescriptor DataStream(Elastic.Clients.Elasticsearch. } /// - /// Default settings, included when the request's `include_default` is `true`. + /// + /// Default settings, included when the request's include_default is true. + /// /// public IndexStateDescriptor Defaults(Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings? defaults) { @@ -114,7 +120,9 @@ public IndexStateDescriptor Defaults(Action - /// Data stream lifecycle applicable if this is a data stream. + /// + /// Data stream lifecycle applicable if this is a data stream. + /// /// public IndexStateDescriptor Lifecycle(Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycle? lifecycle) { @@ -307,7 +315,9 @@ public IndexStateDescriptor DataStream(Elastic.Clients.Elasticsearch.DataStreamN } /// - /// Default settings, included when the request's `include_default` is `true`. + /// + /// Default settings, included when the request's include_default is true. + /// /// public IndexStateDescriptor Defaults(Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings? defaults) { @@ -334,7 +344,9 @@ public IndexStateDescriptor Defaults(Action - /// Data stream lifecycle applicable if this is a data stream. + /// + /// Data stream lifecycle applicable if this is a data stream. + /// /// public IndexStateDescriptor Lifecycle(Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycle? lifecycle) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexStats.g.cs index 4407016db84..b069740dddc 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexStats.g.cs @@ -33,85 +33,113 @@ public sealed partial class IndexStats public Elastic.Clients.Elasticsearch.BulkStats? Bulk { get; init; } /// - /// Contains statistics about completions across all shards assigned to the node. + /// + /// Contains statistics about completions across all shards assigned to the node. + /// /// [JsonInclude, JsonPropertyName("completion")] public Elastic.Clients.Elasticsearch.CompletionStats? Completion { get; init; } /// - /// Contains statistics about documents across all primary shards assigned to the node. + /// + /// Contains statistics about documents across all primary shards assigned to the node. + /// /// [JsonInclude, JsonPropertyName("docs")] public Elastic.Clients.Elasticsearch.DocStats? Docs { get; init; } /// - /// Contains statistics about the field data cache across all shards assigned to the node. + /// + /// Contains statistics about the field data cache across all shards assigned to the node. + /// /// [JsonInclude, JsonPropertyName("fielddata")] public Elastic.Clients.Elasticsearch.FielddataStats? Fielddata { get; init; } /// - /// Contains statistics about flush operations for the node. + /// + /// Contains statistics about flush operations for the node. + /// /// [JsonInclude, JsonPropertyName("flush")] public Elastic.Clients.Elasticsearch.FlushStats? Flush { get; init; } /// - /// Contains statistics about get operations for the node. + /// + /// Contains statistics about get operations for the node. + /// /// [JsonInclude, JsonPropertyName("get")] public Elastic.Clients.Elasticsearch.GetStats? Get { get; init; } /// - /// Contains statistics about indexing operations for the node. + /// + /// Contains statistics about indexing operations for the node. + /// /// [JsonInclude, JsonPropertyName("indexing")] public Elastic.Clients.Elasticsearch.IndexingStats? Indexing { get; init; } /// - /// Contains statistics about indices operations for the node. + /// + /// Contains statistics about indices operations for the node. + /// /// [JsonInclude, JsonPropertyName("indices")] public Elastic.Clients.Elasticsearch.IndexManagement.IndicesStats? Indices { get; init; } /// - /// Contains statistics about merge operations for the node. + /// + /// Contains statistics about merge operations for the node. + /// /// [JsonInclude, JsonPropertyName("merges")] public Elastic.Clients.Elasticsearch.MergesStats? Merges { get; init; } /// - /// Contains statistics about the query cache across all shards assigned to the node. + /// + /// Contains statistics about the query cache across all shards assigned to the node. + /// /// [JsonInclude, JsonPropertyName("query_cache")] public Elastic.Clients.Elasticsearch.QueryCacheStats? QueryCache { get; init; } /// - /// Contains statistics about recovery operations for the node. + /// + /// Contains statistics about recovery operations for the node. + /// /// [JsonInclude, JsonPropertyName("recovery")] public Elastic.Clients.Elasticsearch.RecoveryStats? Recovery { get; init; } /// - /// Contains statistics about refresh operations for the node. + /// + /// Contains statistics about refresh operations for the node. + /// /// [JsonInclude, JsonPropertyName("refresh")] public Elastic.Clients.Elasticsearch.RefreshStats? Refresh { get; init; } /// - /// Contains statistics about the request cache across all shards assigned to the node. + /// + /// Contains statistics about the request cache across all shards assigned to the node. + /// /// [JsonInclude, JsonPropertyName("request_cache")] public Elastic.Clients.Elasticsearch.RequestCacheStats? RequestCache { get; init; } /// - /// Contains statistics about search operations for the node. + /// + /// Contains statistics about search operations for the node. + /// /// [JsonInclude, JsonPropertyName("search")] public Elastic.Clients.Elasticsearch.SearchStats? Search { get; init; } /// - /// Contains statistics about segments across all shards assigned to the node. + /// + /// Contains statistics about segments across all shards assigned to the node. + /// /// [JsonInclude, JsonPropertyName("segments")] public Elastic.Clients.Elasticsearch.SegmentsStats? Segments { get; init; } @@ -119,19 +147,25 @@ public sealed partial class IndexStats public Elastic.Clients.Elasticsearch.IndexManagement.ShardsTotalStats? ShardStats { get; init; } /// - /// Contains statistics about the size of shards assigned to the node. + /// + /// Contains statistics about the size of shards assigned to the node. + /// /// [JsonInclude, JsonPropertyName("store")] public Elastic.Clients.Elasticsearch.StoreStats? Store { get; init; } /// - /// Contains statistics about transaction log operations for the node. + /// + /// Contains statistics about transaction log operations for the node. + /// /// [JsonInclude, JsonPropertyName("translog")] public Elastic.Clients.Elasticsearch.TranslogStats? Translog { get; init; } /// - /// Contains statistics about index warming operations for the node. + /// + /// Contains statistics about index warming operations for the node. + /// /// [JsonInclude, JsonPropertyName("warmer")] public Elastic.Clients.Elasticsearch.WarmerStats? Warmer { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexTemplate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexTemplate.g.cs index 773c53217ca..7b5cf8d780c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexTemplate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexTemplate.g.cs @@ -33,44 +33,67 @@ public sealed partial class IndexTemplate public bool? AllowAutoCreate { get; init; } /// - /// An ordered list of component template names.
Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// + /// An ordered list of component template names. + /// Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// /// [JsonInclude, JsonPropertyName("composed_of")] public IReadOnlyCollection ComposedOf { get; init; } /// - /// If this object is included, the template is used to create data streams and their backing indices.
Supports an empty object.
Data streams require a matching index template with a `data_stream` object. + /// + /// If this object is included, the template is used to create data streams and their backing indices. + /// Supports an empty object. + /// Data streams require a matching index template with a data_stream object. + /// /// [JsonInclude, JsonPropertyName("data_stream")] public Elastic.Clients.Elasticsearch.IndexManagement.IndexTemplateDataStreamConfiguration? DataStream { get; init; } /// - /// Name of the index template. + /// + /// Name of the index template. + /// /// [JsonInclude, JsonPropertyName("index_patterns")] [SingleOrManyCollectionConverter(typeof(string))] public IReadOnlyCollection IndexPatterns { get; init; } /// - /// Optional user metadata about the index template. May have any contents.
This map is not automatically generated by Elasticsearch. + /// + /// Optional user metadata about the index template. May have any contents. + /// This map is not automatically generated by Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("_meta")] public IReadOnlyDictionary? Meta { get; init; } /// - /// Priority to determine index template precedence when a new data stream or index is created.
The index template with the highest priority is chosen.
If no priority is specified the template is treated as though it is of priority 0 (lowest priority).
This number is not automatically generated by Elasticsearch. + /// + /// Priority to determine index template precedence when a new data stream or index is created. + /// The index template with the highest priority is chosen. + /// If no priority is specified the template is treated as though it is of priority 0 (lowest priority). + /// This number is not automatically generated by Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("priority")] public long? Priority { get; init; } /// - /// Template to be applied.
It may optionally include an `aliases`, `mappings`, or `settings` configuration. + /// + /// Template to be applied. + /// It may optionally include an aliases, mappings, or settings configuration. + /// /// [JsonInclude, JsonPropertyName("template")] public Elastic.Clients.Elasticsearch.IndexManagement.IndexTemplateSummary? Template { get; init; } /// - /// Version number used to manage index templates externally.
This number is not automatically generated by Elasticsearch. + /// + /// Version number used to manage index templates externally. + /// This number is not automatically generated by Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("version")] public long? Version { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexTemplateDataStreamConfiguration.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexTemplateDataStreamConfiguration.g.cs index a81d35c5bd8..c8d05104c87 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexTemplateDataStreamConfiguration.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexTemplateDataStreamConfiguration.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class IndexTemplateDataStreamConfiguration { /// - /// If true, the data stream supports custom routing. + /// + /// If true, the data stream supports custom routing. + /// /// [JsonInclude, JsonPropertyName("allow_custom_routing")] public bool? AllowCustomRouting { get; init; } /// - /// If true, the data stream is hidden. + /// + /// If true, the data stream is hidden. + /// /// [JsonInclude, JsonPropertyName("hidden")] public bool? Hidden { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexTemplateMapping.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexTemplateMapping.g.cs index 80c1dabbd47..39b1b8a0161 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexTemplateMapping.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexTemplateMapping.g.cs @@ -30,7 +30,12 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class IndexTemplateMapping { /// - /// Aliases to add.
If the index template includes a `data_stream` object, these are data stream aliases.
Otherwise, these are index aliases.
Data stream aliases ignore the `index_routing`, `routing`, and `search_routing` options. + /// + /// Aliases to add. + /// If the index template includes a data_stream object, these are data stream aliases. + /// Otherwise, these are index aliases. + /// Data stream aliases ignore the index_routing, routing, and search_routing options. + /// /// [JsonInclude, JsonPropertyName("aliases")] public IDictionary? Aliases { get; set; } @@ -38,13 +43,18 @@ public sealed partial class IndexTemplateMapping public Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycle? Lifecycle { get; set; } /// - /// Mapping for fields in the index.
If specified, this mapping can include field names, field data types, and mapping parameters. + /// + /// Mapping for fields in the index. + /// If specified, this mapping can include field names, field data types, and mapping parameters. + /// /// [JsonInclude, JsonPropertyName("mappings")] public Elastic.Clients.Elasticsearch.Mapping.TypeMapping? Mappings { get; set; } /// - /// Configuration options for the index. + /// + /// Configuration options for the index. + /// /// [JsonInclude, JsonPropertyName("settings")] public Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings? Settings { get; set; } @@ -70,7 +80,12 @@ public IndexTemplateMappingDescriptor() : base() private Action> SettingsDescriptorAction { get; set; } /// - /// Aliases to add.
If the index template includes a `data_stream` object, these are data stream aliases.
Otherwise, these are index aliases.
Data stream aliases ignore the `index_routing`, `routing`, and `search_routing` options. + /// + /// Aliases to add. + /// If the index template includes a data_stream object, these are data stream aliases. + /// Otherwise, these are index aliases. + /// Data stream aliases ignore the index_routing, routing, and search_routing options. + /// /// public IndexTemplateMappingDescriptor Aliases(Func>, FluentDescriptorDictionary>> selector) { @@ -103,7 +118,10 @@ public IndexTemplateMappingDescriptor Lifecycle(Action - /// Mapping for fields in the index.
If specified, this mapping can include field names, field data types, and mapping parameters. + /// + /// Mapping for fields in the index. + /// If specified, this mapping can include field names, field data types, and mapping parameters. + /// /// public IndexTemplateMappingDescriptor Mappings(Elastic.Clients.Elasticsearch.Mapping.TypeMapping? mappings) { @@ -130,7 +148,9 @@ public IndexTemplateMappingDescriptor Mappings(Action - /// Configuration options for the index. + /// + /// Configuration options for the index. + /// /// public IndexTemplateMappingDescriptor Settings(Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings? settings) { @@ -237,7 +257,12 @@ public IndexTemplateMappingDescriptor() : base() private Action SettingsDescriptorAction { get; set; } /// - /// Aliases to add.
If the index template includes a `data_stream` object, these are data stream aliases.
Otherwise, these are index aliases.
Data stream aliases ignore the `index_routing`, `routing`, and `search_routing` options. + /// + /// Aliases to add. + /// If the index template includes a data_stream object, these are data stream aliases. + /// Otherwise, these are index aliases. + /// Data stream aliases ignore the index_routing, routing, and search_routing options. + /// /// public IndexTemplateMappingDescriptor Aliases(Func, FluentDescriptorDictionary> selector) { @@ -270,7 +295,10 @@ public IndexTemplateMappingDescriptor Lifecycle(Action - /// Mapping for fields in the index.
If specified, this mapping can include field names, field data types, and mapping parameters. + /// + /// Mapping for fields in the index. + /// If specified, this mapping can include field names, field data types, and mapping parameters. + /// /// public IndexTemplateMappingDescriptor Mappings(Elastic.Clients.Elasticsearch.Mapping.TypeMapping? mappings) { @@ -297,7 +325,9 @@ public IndexTemplateMappingDescriptor Mappings(Action - /// Configuration options for the index. + /// + /// Configuration options for the index. + /// /// public IndexTemplateMappingDescriptor Settings(Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings? settings) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexTemplateSummary.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexTemplateSummary.g.cs index 76101931399..be455d697cb 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexTemplateSummary.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexTemplateSummary.g.cs @@ -30,7 +30,12 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class IndexTemplateSummary { /// - /// Aliases to add.
If the index template includes a `data_stream` object, these are data stream aliases.
Otherwise, these are index aliases.
Data stream aliases ignore the `index_routing`, `routing`, and `search_routing` options. + /// + /// Aliases to add. + /// If the index template includes a data_stream object, these are data stream aliases. + /// Otherwise, these are index aliases. + /// Data stream aliases ignore the index_routing, routing, and search_routing options. + /// /// [JsonInclude, JsonPropertyName("aliases")] [ReadOnlyIndexNameDictionaryConverter(typeof(Elastic.Clients.Elasticsearch.IndexManagement.Alias))] @@ -39,13 +44,18 @@ public sealed partial class IndexTemplateSummary public Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycleWithRollover? Lifecycle { get; init; } /// - /// Mapping for fields in the index.
If specified, this mapping can include field names, field data types, and mapping parameters. + /// + /// Mapping for fields in the index. + /// If specified, this mapping can include field names, field data types, and mapping parameters. + /// /// [JsonInclude, JsonPropertyName("mappings")] public Elastic.Clients.Elasticsearch.Mapping.TypeMapping? Mappings { get; init; } /// - /// Configuration options for the index. + /// + /// Configuration options for the index. + /// /// [JsonInclude, JsonPropertyName("settings")] public Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings? Settings { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexingPressureMemory.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexingPressureMemory.g.cs index 09d7e1c2386..2c1bfc3d6f6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexingPressureMemory.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexingPressureMemory.g.cs @@ -30,7 +30,11 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class IndexingPressureMemory { /// - /// Number of outstanding bytes that may be consumed by indexing requests. When this limit is reached or exceeded,
the node will reject new coordinating and primary operations. When replica operations consume 1.5x this limit,
the node will reject new replica operations. Defaults to 10% of the heap. + /// + /// Number of outstanding bytes that may be consumed by indexing requests. When this limit is reached or exceeded, + /// the node will reject new coordinating and primary operations. When replica operations consume 1.5x this limit, + /// the node will reject new replica operations. Defaults to 10% of the heap. + /// /// [JsonInclude, JsonPropertyName("limit")] public int? Limit { get; set; } @@ -47,7 +51,11 @@ public IndexingPressureMemoryDescriptor() : base() private int? LimitValue { get; set; } /// - /// Number of outstanding bytes that may be consumed by indexing requests. When this limit is reached or exceeded,
the node will reject new coordinating and primary operations. When replica operations consume 1.5x this limit,
the node will reject new replica operations. Defaults to 10% of the heap. + /// + /// Number of outstanding bytes that may be consumed by indexing requests. When this limit is reached or exceeded, + /// the node will reject new coordinating and primary operations. When replica operations consume 1.5x this limit, + /// the node will reject new replica operations. Defaults to 10% of the heap. + /// /// public IndexingPressureMemoryDescriptor Limit(int? limit) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexingSlowlogTresholds.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexingSlowlogTresholds.g.cs index c0ed99e6543..7bcf5ae689a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexingSlowlogTresholds.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexingSlowlogTresholds.g.cs @@ -30,7 +30,10 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class IndexingSlowlogTresholds { /// - /// The indexing slow log, similar in functionality to the search slow log. The log file name ends with `_index_indexing_slowlog.json`.
Log and the thresholds are configured in the same way as the search slowlog. + /// + /// The indexing slow log, similar in functionality to the search slow log. The log file name ends with _index_indexing_slowlog.json. + /// Log and the thresholds are configured in the same way as the search slowlog. + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.IndexManagement.SlowlogTresholdLevels? Index { get; set; } @@ -49,7 +52,10 @@ public IndexingSlowlogTresholdsDescriptor() : base() private Action IndexDescriptorAction { get; set; } /// - /// The indexing slow log, similar in functionality to the search slow log. The log file name ends with `_index_indexing_slowlog.json`.
Log and the thresholds are configured in the same way as the search slowlog. + /// + /// The indexing slow log, similar in functionality to the search slow log. The log file name ends with _index_indexing_slowlog.json. + /// Log and the thresholds are configured in the same way as the search slowlog. + /// /// public IndexingSlowlogTresholdsDescriptor Index(Elastic.Clients.Elasticsearch.IndexManagement.SlowlogTresholdLevels? index) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettings.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettings.g.cs index 09db8830744..f3896c871f4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettings.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettings.g.cs @@ -28,7 +28,9 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; /// -/// Mapping Limit Settings +/// +/// Mapping Limit Settings +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class MappingLimitSettings @@ -52,7 +54,9 @@ public sealed partial class MappingLimitSettings } /// -/// Mapping Limit Settings +/// +/// Mapping Limit Settings +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class MappingLimitSettingsDescriptor : SerializableDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettingsDepth.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettingsDepth.g.cs index c1954010b44..45d8387916c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettingsDepth.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettingsDepth.g.cs @@ -30,7 +30,10 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class MappingLimitSettingsDepth { /// - /// The maximum depth for a field, which is measured as the number of inner objects. For instance, if all fields are defined
at the root object level, then the depth is 1. If there is one object mapping, then the depth is 2, etc. + /// + /// The maximum depth for a field, which is measured as the number of inner objects. For instance, if all fields are defined + /// at the root object level, then the depth is 1. If there is one object mapping, then the depth is 2, etc. + /// /// [JsonInclude, JsonPropertyName("limit")] public long? Limit { get; set; } @@ -47,7 +50,10 @@ public MappingLimitSettingsDepthDescriptor() : base() private long? LimitValue { get; set; } /// - /// The maximum depth for a field, which is measured as the number of inner objects. For instance, if all fields are defined
at the root object level, then the depth is 1. If there is one object mapping, then the depth is 2, etc. + /// + /// The maximum depth for a field, which is measured as the number of inner objects. For instance, if all fields are defined + /// at the root object level, then the depth is 1. If there is one object mapping, then the depth is 2, etc. + /// /// public MappingLimitSettingsDepthDescriptor Limit(long? limit) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettingsDimensionFields.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettingsDimensionFields.g.cs index 659cd568dbc..b809a923150 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettingsDimensionFields.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettingsDimensionFields.g.cs @@ -30,7 +30,10 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class MappingLimitSettingsDimensionFields { /// - /// [preview] This functionality is in technical preview and may be changed or removed in a future release.
Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. + /// + /// [preview] This functionality is in technical preview and may be changed or removed in a future release. + /// Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. + /// /// [JsonInclude, JsonPropertyName("limit")] public long? Limit { get; set; } @@ -47,7 +50,10 @@ public MappingLimitSettingsDimensionFieldsDescriptor() : base() private long? LimitValue { get; set; } /// - /// [preview] This functionality is in technical preview and may be changed or removed in a future release.
Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. + /// + /// [preview] This functionality is in technical preview and may be changed or removed in a future release. + /// Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. + /// /// public MappingLimitSettingsDimensionFieldsDescriptor Limit(long? limit) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettingsFieldNameLength.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettingsFieldNameLength.g.cs index 2e89e4c0046..c4e64623d03 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettingsFieldNameLength.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettingsFieldNameLength.g.cs @@ -30,7 +30,11 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class MappingLimitSettingsFieldNameLength { /// - /// Setting for the maximum length of a field name. This setting isn’t really something that addresses mappings explosion but
might still be useful if you want to limit the field length. It usually shouldn’t be necessary to set this setting. The
default is okay unless a user starts to add a huge number of fields with really long names. Default is `Long.MAX_VALUE` (no limit). + /// + /// Setting for the maximum length of a field name. This setting isn’t really something that addresses mappings explosion but + /// might still be useful if you want to limit the field length. It usually shouldn’t be necessary to set this setting. The + /// default is okay unless a user starts to add a huge number of fields with really long names. Default is Long.MAX_VALUE (no limit). + /// /// [JsonInclude, JsonPropertyName("limit")] public long? Limit { get; set; } @@ -47,7 +51,11 @@ public MappingLimitSettingsFieldNameLengthDescriptor() : base() private long? LimitValue { get; set; } /// - /// Setting for the maximum length of a field name. This setting isn’t really something that addresses mappings explosion but
might still be useful if you want to limit the field length. It usually shouldn’t be necessary to set this setting. The
default is okay unless a user starts to add a huge number of fields with really long names. Default is `Long.MAX_VALUE` (no limit). + /// + /// Setting for the maximum length of a field name. This setting isn’t really something that addresses mappings explosion but + /// might still be useful if you want to limit the field length. It usually shouldn’t be necessary to set this setting. The + /// default is okay unless a user starts to add a huge number of fields with really long names. Default is Long.MAX_VALUE (no limit). + /// /// public MappingLimitSettingsFieldNameLengthDescriptor Limit(long? limit) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettingsNestedFields.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettingsNestedFields.g.cs index ebf47c2380b..c6331ffc1e2 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettingsNestedFields.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettingsNestedFields.g.cs @@ -30,7 +30,11 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class MappingLimitSettingsNestedFields { /// - /// The maximum number of distinct nested mappings in an index. The nested type should only be used in special cases, when
arrays of objects need to be queried independently of each other. To safeguard against poorly designed mappings, this
setting limits the number of unique nested types per index. + /// + /// The maximum number of distinct nested mappings in an index. The nested type should only be used in special cases, when + /// arrays of objects need to be queried independently of each other. To safeguard against poorly designed mappings, this + /// setting limits the number of unique nested types per index. + /// /// [JsonInclude, JsonPropertyName("limit")] public long? Limit { get; set; } @@ -47,7 +51,11 @@ public MappingLimitSettingsNestedFieldsDescriptor() : base() private long? LimitValue { get; set; } /// - /// The maximum number of distinct nested mappings in an index. The nested type should only be used in special cases, when
arrays of objects need to be queried independently of each other. To safeguard against poorly designed mappings, this
setting limits the number of unique nested types per index. + /// + /// The maximum number of distinct nested mappings in an index. The nested type should only be used in special cases, when + /// arrays of objects need to be queried independently of each other. To safeguard against poorly designed mappings, this + /// setting limits the number of unique nested types per index. + /// /// public MappingLimitSettingsNestedFieldsDescriptor Limit(long? limit) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettingsNestedObjects.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettingsNestedObjects.g.cs index ba5beae243e..9da47c0321f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettingsNestedObjects.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettingsNestedObjects.g.cs @@ -30,7 +30,10 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class MappingLimitSettingsNestedObjects { /// - /// The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps
to prevent out of memory errors when a document contains too many nested objects. + /// + /// The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps + /// to prevent out of memory errors when a document contains too many nested objects. + /// /// [JsonInclude, JsonPropertyName("limit")] public long? Limit { get; set; } @@ -47,7 +50,10 @@ public MappingLimitSettingsNestedObjectsDescriptor() : base() private long? LimitValue { get; set; } /// - /// The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps
to prevent out of memory errors when a document contains too many nested objects. + /// + /// The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps + /// to prevent out of memory errors when a document contains too many nested objects. + /// /// public MappingLimitSettingsNestedObjectsDescriptor Limit(long? limit) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettingsTotalFields.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettingsTotalFields.g.cs index c2134fe5d6d..388e699a94a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettingsTotalFields.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettingsTotalFields.g.cs @@ -30,13 +30,23 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class MappingLimitSettingsTotalFields { /// - /// This setting determines what happens when a dynamically mapped field would exceed the total fields limit. When set
to false (the default), the index request of the document that tries to add a dynamic field to the mapping will fail
with the message Limit of total fields [X] has been exceeded. When set to true, the index request will not fail.
Instead, fields that would exceed the limit are not added to the mapping, similar to dynamic: false.
The fields that were not added to the mapping will be added to the _ignored field. + /// + /// This setting determines what happens when a dynamically mapped field would exceed the total fields limit. When set + /// to false (the default), the index request of the document that tries to add a dynamic field to the mapping will fail + /// with the message Limit of total fields [X] has been exceeded. When set to true, the index request will not fail. + /// Instead, fields that would exceed the limit are not added to the mapping, similar to dynamic: false. + /// The fields that were not added to the mapping will be added to the _ignored field. + /// /// [JsonInclude, JsonPropertyName("ignore_dynamic_beyond_limit")] public bool? IgnoreDynamicBeyondLimit { get; set; } /// - /// The maximum number of fields in an index. Field and object mappings, as well as field aliases count towards this limit.
The limit is in place to prevent mappings and searches from becoming too large. Higher values can lead to performance
degradations and memory issues, especially in clusters with a high load or few resources. + /// + /// The maximum number of fields in an index. Field and object mappings, as well as field aliases count towards this limit. + /// The limit is in place to prevent mappings and searches from becoming too large. Higher values can lead to performance + /// degradations and memory issues, especially in clusters with a high load or few resources. + /// /// [JsonInclude, JsonPropertyName("limit")] public long? Limit { get; set; } @@ -54,7 +64,13 @@ public MappingLimitSettingsTotalFieldsDescriptor() : base() private long? LimitValue { get; set; } /// - /// This setting determines what happens when a dynamically mapped field would exceed the total fields limit. When set
to false (the default), the index request of the document that tries to add a dynamic field to the mapping will fail
with the message Limit of total fields [X] has been exceeded. When set to true, the index request will not fail.
Instead, fields that would exceed the limit are not added to the mapping, similar to dynamic: false.
The fields that were not added to the mapping will be added to the _ignored field. + /// + /// This setting determines what happens when a dynamically mapped field would exceed the total fields limit. When set + /// to false (the default), the index request of the document that tries to add a dynamic field to the mapping will fail + /// with the message Limit of total fields [X] has been exceeded. When set to true, the index request will not fail. + /// Instead, fields that would exceed the limit are not added to the mapping, similar to dynamic: false. + /// The fields that were not added to the mapping will be added to the _ignored field. + /// /// public MappingLimitSettingsTotalFieldsDescriptor IgnoreDynamicBeyondLimit(bool? ignoreDynamicBeyondLimit = true) { @@ -63,7 +79,11 @@ public MappingLimitSettingsTotalFieldsDescriptor IgnoreDynamicBeyondLimit(bool? } /// - /// The maximum number of fields in an index. Field and object mappings, as well as field aliases count towards this limit.
The limit is in place to prevent mappings and searches from becoming too large. Higher values can lead to performance
degradations and memory issues, especially in clusters with a high load or few resources. + /// + /// The maximum number of fields in an index. Field and object mappings, as well as field aliases count towards this limit. + /// The limit is in place to prevent mappings and searches from becoming too large. Higher values can lead to performance + /// degradations and memory issues, especially in clusters with a high load or few resources. + /// /// public MappingLimitSettingsTotalFieldsDescriptor Limit(long? limit) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/RemoveAction.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/RemoveAction.g.cs index 89090e051af..fc2de9dd136 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/RemoveAction.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/RemoveAction.g.cs @@ -30,32 +30,46 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class RemoveAction { /// - /// Alias for the action.
Index alias names support date math. + /// + /// Alias for the action. + /// Index alias names support date math. + /// /// [JsonInclude, JsonPropertyName("alias")] public Elastic.Clients.Elasticsearch.IndexAlias? Alias { get; set; } /// - /// Aliases for the action.
Index alias names support date math. + /// + /// Aliases for the action. + /// Index alias names support date math. + /// /// [JsonInclude, JsonPropertyName("aliases")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.IndexAlias))] public ICollection? Aliases { get; set; } /// - /// Data stream or index for the action.
Supports wildcards (`*`). + /// + /// Data stream or index for the action. + /// Supports wildcards (*). + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.IndexName? Index { get; set; } /// - /// Data streams or indices for the action.
Supports wildcards (`*`). + /// + /// Data streams or indices for the action. + /// Supports wildcards (*). + /// /// [JsonInclude, JsonPropertyName("indices")] public Elastic.Clients.Elasticsearch.Indices? Indices { get; set; } /// - /// If `true`, the alias must exist to perform the action. + /// + /// If true, the alias must exist to perform the action. + /// /// [JsonInclude, JsonPropertyName("must_exist")] public bool? MustExist { get; set; } @@ -78,7 +92,10 @@ public RemoveActionDescriptor() : base() private bool? MustExistValue { get; set; } /// - /// Alias for the action.
Index alias names support date math. + /// + /// Alias for the action. + /// Index alias names support date math. + /// /// public RemoveActionDescriptor Alias(Elastic.Clients.Elasticsearch.IndexAlias? alias) { @@ -87,7 +104,10 @@ public RemoveActionDescriptor Alias(Elastic.Clients.Elasticsearch.IndexAlias? al } /// - /// Aliases for the action.
Index alias names support date math. + /// + /// Aliases for the action. + /// Index alias names support date math. + /// /// public RemoveActionDescriptor Aliases(ICollection? aliases) { @@ -96,7 +116,10 @@ public RemoveActionDescriptor Aliases(ICollection - /// Data stream or index for the action.
Supports wildcards (`*`). + /// + /// Data stream or index for the action. + /// Supports wildcards (*). + /// /// public RemoveActionDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? index) { @@ -105,7 +128,10 @@ public RemoveActionDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? ind } /// - /// Data streams or indices for the action.
Supports wildcards (`*`). + /// + /// Data streams or indices for the action. + /// Supports wildcards (*). + /// /// public RemoveActionDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? indices) { @@ -114,7 +140,9 @@ public RemoveActionDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? ind } /// - /// If `true`, the alias must exist to perform the action. + /// + /// If true, the alias must exist to perform the action. + /// /// public RemoveActionDescriptor MustExist(bool? mustExist = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/RemoveIndexAction.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/RemoveIndexAction.g.cs index 7d7b1586d04..795a0b6aac6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/RemoveIndexAction.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/RemoveIndexAction.g.cs @@ -30,19 +30,27 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class RemoveIndexAction { /// - /// Data stream or index for the action.
Supports wildcards (`*`). + /// + /// Data stream or index for the action. + /// Supports wildcards (*). + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.IndexName? Index { get; set; } /// - /// Data streams or indices for the action.
Supports wildcards (`*`). + /// + /// Data streams or indices for the action. + /// Supports wildcards (*). + /// /// [JsonInclude, JsonPropertyName("indices")] public Elastic.Clients.Elasticsearch.Indices? Indices { get; set; } /// - /// If `true`, the alias must exist to perform the action. + /// + /// If true, the alias must exist to perform the action. + /// /// [JsonInclude, JsonPropertyName("must_exist")] public bool? MustExist { get; set; } @@ -63,7 +71,10 @@ public RemoveIndexActionDescriptor() : base() private bool? MustExistValue { get; set; } /// - /// Data stream or index for the action.
Supports wildcards (`*`). + /// + /// Data stream or index for the action. + /// Supports wildcards (*). + /// /// public RemoveIndexActionDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? index) { @@ -72,7 +83,10 @@ public RemoveIndexActionDescriptor Index(Elastic.Clients.Elasticsearch.IndexName } /// - /// Data streams or indices for the action.
Supports wildcards (`*`). + /// + /// Data streams or indices for the action. + /// Supports wildcards (*). + /// /// public RemoveIndexActionDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? indices) { @@ -81,7 +95,9 @@ public RemoveIndexActionDescriptor Indices(Elastic.Clients.Elasticsearch.Indices } /// - /// If `true`, the alias must exist to perform the action. + /// + /// If true, the alias must exist to perform the action. + /// /// public RemoveIndexActionDescriptor MustExist(bool? mustExist = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/ResolveClusterInfo.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/ResolveClusterInfo.g.cs index a6c8ee1555a..80a4821a300 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/ResolveClusterInfo.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/ResolveClusterInfo.g.cs @@ -28,36 +28,50 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; /// -/// Provides information about each cluster request relevant to doing a cross-cluster search. +/// +/// Provides information about each cluster request relevant to doing a cross-cluster search. +/// /// public sealed partial class ResolveClusterInfo { /// - /// Whether the remote cluster is connected to the local (querying) cluster. + /// + /// Whether the remote cluster is connected to the local (querying) cluster. + /// /// [JsonInclude, JsonPropertyName("connected")] public bool Connected { get; init; } /// - /// Provides error messages that are likely to occur if you do a search with this index expression
on the specified cluster (e.g., lack of security privileges to query an index). + /// + /// Provides error messages that are likely to occur if you do a search with this index expression + /// on the specified cluster (e.g., lack of security privileges to query an index). + /// /// [JsonInclude, JsonPropertyName("error")] public string? Error { get; init; } /// - /// Whether the index expression provided in the request matches any indices, aliases or data streams
on the cluster. + /// + /// Whether the index expression provided in the request matches any indices, aliases or data streams + /// on the cluster. + /// /// [JsonInclude, JsonPropertyName("matching_indices")] public bool? MatchingIndices { get; init; } /// - /// The skip_unavailable setting for a remote cluster. + /// + /// The skip_unavailable setting for a remote cluster. + /// /// [JsonInclude, JsonPropertyName("skip_unavailable")] public bool SkipUnavailable { get; init; } /// - /// Provides version information about the cluster. + /// + /// Provides version information about the cluster. + /// /// [JsonInclude, JsonPropertyName("version")] public Elastic.Clients.Elasticsearch.ElasticsearchVersionMinInfo? Version { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/SoftDeletes.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/SoftDeletes.g.cs index 4ce2a5f168c..9f4ba2342ab 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/SoftDeletes.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/SoftDeletes.g.cs @@ -30,13 +30,20 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class SoftDeletes { /// - /// Indicates whether soft deletes are enabled on the index. + /// + /// Indicates whether soft deletes are enabled on the index. + /// /// [JsonInclude, JsonPropertyName("enabled")] public bool? Enabled { get; set; } /// - /// The maximum period to retain a shard history retention lease before it is considered expired.
Shard history retention leases ensure that soft deletes are retained during merges on the Lucene
index. If a soft delete is merged away before it can be replicated to a follower the following
process will fail due to incomplete history on the leader. + /// + /// The maximum period to retain a shard history retention lease before it is considered expired. + /// Shard history retention leases ensure that soft deletes are retained during merges on the Lucene + /// index. If a soft delete is merged away before it can be replicated to a follower the following + /// process will fail due to incomplete history on the leader. + /// /// [JsonInclude, JsonPropertyName("retention_lease")] public Elastic.Clients.Elasticsearch.IndexManagement.RetentionLease? RetentionLease { get; set; } @@ -56,7 +63,9 @@ public SoftDeletesDescriptor() : base() private Action RetentionLeaseDescriptorAction { get; set; } /// - /// Indicates whether soft deletes are enabled on the index. + /// + /// Indicates whether soft deletes are enabled on the index. + /// /// public SoftDeletesDescriptor Enabled(bool? enabled = true) { @@ -65,7 +74,12 @@ public SoftDeletesDescriptor Enabled(bool? enabled = true) } /// - /// The maximum period to retain a shard history retention lease before it is considered expired.
Shard history retention leases ensure that soft deletes are retained during merges on the Lucene
index. If a soft delete is merged away before it can be replicated to a follower the following
process will fail due to incomplete history on the leader. + /// + /// The maximum period to retain a shard history retention lease before it is considered expired. + /// Shard history retention leases ensure that soft deletes are retained during merges on the Lucene + /// index. If a soft delete is merged away before it can be replicated to a follower the following + /// process will fail due to incomplete history on the leader. + /// /// public SoftDeletesDescriptor RetentionLease(Elastic.Clients.Elasticsearch.IndexManagement.RetentionLease? retentionLease) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/Storage.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/Storage.g.cs index e7ff302bc37..91daa31894b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/Storage.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/Storage.g.cs @@ -30,7 +30,12 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class Storage { /// - /// You can restrict the use of the mmapfs and the related hybridfs store type via the setting node.store.allow_mmap.
This is a boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This
setting is useful, for example, if you are in an environment where you can not control the ability to create a lot
of memory maps so you need disable the ability to use memory-mapping. + /// + /// You can restrict the use of the mmapfs and the related hybridfs store type via the setting node.store.allow_mmap. + /// This is a boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This + /// setting is useful, for example, if you are in an environment where you can not control the ability to create a lot + /// of memory maps so you need disable the ability to use memory-mapping. + /// /// [JsonInclude, JsonPropertyName("allow_mmap")] public bool? AllowMmap { get; set; } @@ -50,7 +55,12 @@ public StorageDescriptor() : base() private Elastic.Clients.Elasticsearch.IndexManagement.StorageType TypeValue { get; set; } /// - /// You can restrict the use of the mmapfs and the related hybridfs store type via the setting node.store.allow_mmap.
This is a boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This
setting is useful, for example, if you are in an environment where you can not control the ability to create a lot
of memory maps so you need disable the ability to use memory-mapping. + /// + /// You can restrict the use of the mmapfs and the related hybridfs store type via the setting node.store.allow_mmap. + /// This is a boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This + /// setting is useful, for example, if you are in an environment where you can not control the ability to create a lot + /// of memory maps so you need disable the ability to use memory-mapping. + /// /// public StorageDescriptor AllowMmap(bool? allowMmap = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/Translog.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/Translog.g.cs index 779e0d87702..e3fd1ff06c7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/Translog.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/Translog.g.cs @@ -30,13 +30,21 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class Translog { /// - /// Whether or not to `fsync` and commit the translog after every index, delete, update, or bulk request. + /// + /// Whether or not to fsync and commit the translog after every index, delete, update, or bulk request. + /// /// [JsonInclude, JsonPropertyName("durability")] public Elastic.Clients.Elasticsearch.IndexManagement.TranslogDurability? Durability { get; set; } /// - /// The translog stores all operations that are not yet safely persisted in Lucene (i.e., are not
part of a Lucene commit point). Although these operations are available for reads, they will need
to be replayed if the shard was stopped and had to be recovered. This setting controls the
maximum total size of these operations, to prevent recoveries from taking too long. Once the
maximum size has been reached a flush will happen, generating a new Lucene commit point. + /// + /// The translog stores all operations that are not yet safely persisted in Lucene (i.e., are not + /// part of a Lucene commit point). Although these operations are available for reads, they will need + /// to be replayed if the shard was stopped and had to be recovered. This setting controls the + /// maximum total size of these operations, to prevent recoveries from taking too long. Once the + /// maximum size has been reached a flush will happen, generating a new Lucene commit point. + /// /// [JsonInclude, JsonPropertyName("flush_threshold_size")] public Elastic.Clients.Elasticsearch.ByteSize? FlushThresholdSize { get; set; } @@ -44,7 +52,10 @@ public sealed partial class Translog public Elastic.Clients.Elasticsearch.IndexManagement.TranslogRetention? Retention { get; set; } /// - /// How often the translog is fsynced to disk and committed, regardless of write operations.
Values less than 100ms are not allowed. + /// + /// How often the translog is fsynced to disk and committed, regardless of write operations. + /// Values less than 100ms are not allowed. + /// /// [JsonInclude, JsonPropertyName("sync_interval")] public Elastic.Clients.Elasticsearch.Duration? SyncInterval { get; set; } @@ -66,7 +77,9 @@ public TranslogDescriptor() : base() private Elastic.Clients.Elasticsearch.Duration? SyncIntervalValue { get; set; } /// - /// Whether or not to `fsync` and commit the translog after every index, delete, update, or bulk request. + /// + /// Whether or not to fsync and commit the translog after every index, delete, update, or bulk request. + /// /// public TranslogDescriptor Durability(Elastic.Clients.Elasticsearch.IndexManagement.TranslogDurability? durability) { @@ -75,7 +88,13 @@ public TranslogDescriptor Durability(Elastic.Clients.Elasticsearch.IndexManageme } /// - /// The translog stores all operations that are not yet safely persisted in Lucene (i.e., are not
part of a Lucene commit point). Although these operations are available for reads, they will need
to be replayed if the shard was stopped and had to be recovered. This setting controls the
maximum total size of these operations, to prevent recoveries from taking too long. Once the
maximum size has been reached a flush will happen, generating a new Lucene commit point. + /// + /// The translog stores all operations that are not yet safely persisted in Lucene (i.e., are not + /// part of a Lucene commit point). Although these operations are available for reads, they will need + /// to be replayed if the shard was stopped and had to be recovered. This setting controls the + /// maximum total size of these operations, to prevent recoveries from taking too long. Once the + /// maximum size has been reached a flush will happen, generating a new Lucene commit point. + /// /// public TranslogDescriptor FlushThresholdSize(Elastic.Clients.Elasticsearch.ByteSize? flushThresholdSize) { @@ -108,7 +127,10 @@ public TranslogDescriptor Retention(Action - /// How often the translog is fsynced to disk and committed, regardless of write operations.
Values less than 100ms are not allowed. + /// + /// How often the translog is fsynced to disk and committed, regardless of write operations. + /// Values less than 100ms are not allowed. + /// /// public TranslogDescriptor SyncInterval(Elastic.Clients.Elasticsearch.Duration? syncInterval) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/TranslogRetention.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/TranslogRetention.g.cs index b86b56ec6f9..d454410965f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/TranslogRetention.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/TranslogRetention.g.cs @@ -30,13 +30,25 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class TranslogRetention { /// - /// This controls the maximum duration for which translog files are kept by each shard. Keeping more
translog files increases the chance of performing an operation based sync when recovering replicas. If
the translog files are not sufficient, replica recovery will fall back to a file based sync. This setting
is ignored, and should not be set, if soft deletes are enabled. Soft deletes are enabled by default in
indices created in Elasticsearch versions 7.0.0 and later. + /// + /// This controls the maximum duration for which translog files are kept by each shard. Keeping more + /// translog files increases the chance of performing an operation based sync when recovering replicas. If + /// the translog files are not sufficient, replica recovery will fall back to a file based sync. This setting + /// is ignored, and should not be set, if soft deletes are enabled. Soft deletes are enabled by default in + /// indices created in Elasticsearch versions 7.0.0 and later. + /// /// [JsonInclude, JsonPropertyName("age")] public Elastic.Clients.Elasticsearch.Duration? Age { get; set; } /// - /// This controls the total size of translog files to keep for each shard. Keeping more translog files increases
the chance of performing an operation based sync when recovering a replica. If the translog files are not
sufficient, replica recovery will fall back to a file based sync. This setting is ignored, and should not be
set, if soft deletes are enabled. Soft deletes are enabled by default in indices created in Elasticsearch
versions 7.0.0 and later. + /// + /// This controls the total size of translog files to keep for each shard. Keeping more translog files increases + /// the chance of performing an operation based sync when recovering a replica. If the translog files are not + /// sufficient, replica recovery will fall back to a file based sync. This setting is ignored, and should not be + /// set, if soft deletes are enabled. Soft deletes are enabled by default in indices created in Elasticsearch + /// versions 7.0.0 and later. + /// /// [JsonInclude, JsonPropertyName("size")] public Elastic.Clients.Elasticsearch.ByteSize? Size { get; set; } @@ -54,7 +66,13 @@ public TranslogRetentionDescriptor() : base() private Elastic.Clients.Elasticsearch.ByteSize? SizeValue { get; set; } /// - /// This controls the maximum duration for which translog files are kept by each shard. Keeping more
translog files increases the chance of performing an operation based sync when recovering replicas. If
the translog files are not sufficient, replica recovery will fall back to a file based sync. This setting
is ignored, and should not be set, if soft deletes are enabled. Soft deletes are enabled by default in
indices created in Elasticsearch versions 7.0.0 and later. + /// + /// This controls the maximum duration for which translog files are kept by each shard. Keeping more + /// translog files increases the chance of performing an operation based sync when recovering replicas. If + /// the translog files are not sufficient, replica recovery will fall back to a file based sync. This setting + /// is ignored, and should not be set, if soft deletes are enabled. Soft deletes are enabled by default in + /// indices created in Elasticsearch versions 7.0.0 and later. + /// /// public TranslogRetentionDescriptor Age(Elastic.Clients.Elasticsearch.Duration? age) { @@ -63,7 +81,13 @@ public TranslogRetentionDescriptor Age(Elastic.Clients.Elasticsearch.Duration? a } /// - /// This controls the total size of translog files to keep for each shard. Keeping more translog files increases
the chance of performing an operation based sync when recovering a replica. If the translog files are not
sufficient, replica recovery will fall back to a file based sync. This setting is ignored, and should not be
set, if soft deletes are enabled. Soft deletes are enabled by default in indices created in Elasticsearch
versions 7.0.0 and later. + /// + /// This controls the total size of translog files to keep for each shard. Keeping more translog files increases + /// the chance of performing an operation based sync when recovering a replica. If the translog files are not + /// sufficient, replica recovery will fall back to a file based sync. This setting is ignored, and should not be + /// set, if soft deletes are enabled. Soft deletes are enabled by default in indices created in Elasticsearch + /// versions 7.0.0 and later. + /// /// public TranslogRetentionDescriptor Size(Elastic.Clients.Elasticsearch.ByteSize? size) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndicesOptions.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndicesOptions.g.cs index 1fe3bf56a27..39dafca28b2 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndicesOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndicesOptions.g.cs @@ -28,38 +28,56 @@ namespace Elastic.Clients.Elasticsearch; /// -/// Controls how to deal with unavailable concrete indices (closed or missing), how wildcard expressions are expanded
to actual indices (all, closed or open indices) and how to deal with wildcard expressions that resolve to no indices. +/// +/// Controls how to deal with unavailable concrete indices (closed or missing), how wildcard expressions are expanded +/// to actual indices (all, closed or open indices) and how to deal with wildcard expressions that resolve to no indices. +/// /// public sealed partial class IndicesOptions { /// - /// If false, the request returns an error if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices. This behavior applies even if the request targets other open indices. For example,
a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only + /// missing or closed indices. This behavior applies even if the request targets other open indices. For example, + /// a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// [JsonInclude, JsonPropertyName("allow_no_indices")] public bool? AllowNoIndices { get; set; } /// - /// Type of index that wildcard patterns can match. If the request can target data streams, this argument
determines whether wildcard expressions match hidden data streams. Supports comma-separated values,
such as `open,hidden`. + /// + /// Type of index that wildcard patterns can match. If the request can target data streams, this argument + /// determines whether wildcard expressions match hidden data streams. Supports comma-separated values, + /// such as open,hidden. + /// /// [JsonInclude, JsonPropertyName("expand_wildcards")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.ExpandWildcard))] public ICollection? ExpandWildcards { get; set; } /// - /// If true, concrete, expanded or aliased indices are ignored when frozen. + /// + /// If true, concrete, expanded or aliased indices are ignored when frozen. + /// /// [JsonInclude, JsonPropertyName("ignore_throttled")] public bool? IgnoreThrottled { get; set; } /// - /// If true, missing or closed indices are not included in the response. + /// + /// If true, missing or closed indices are not included in the response. + /// /// [JsonInclude, JsonPropertyName("ignore_unavailable")] public bool? IgnoreUnavailable { get; set; } } /// -/// Controls how to deal with unavailable concrete indices (closed or missing), how wildcard expressions are expanded
to actual indices (all, closed or open indices) and how to deal with wildcard expressions that resolve to no indices. +/// +/// Controls how to deal with unavailable concrete indices (closed or missing), how wildcard expressions are expanded +/// to actual indices (all, closed or open indices) and how to deal with wildcard expressions that resolve to no indices. +/// /// public sealed partial class IndicesOptionsDescriptor : SerializableDescriptor { @@ -75,7 +93,11 @@ public IndicesOptionsDescriptor() : base() private bool? IgnoreUnavailableValue { get; set; } /// - /// If false, the request returns an error if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices. This behavior applies even if the request targets other open indices. For example,
a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// + /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only + /// missing or closed indices. This behavior applies even if the request targets other open indices. For example, + /// a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// /// public IndicesOptionsDescriptor AllowNoIndices(bool? allowNoIndices = true) { @@ -84,7 +106,11 @@ public IndicesOptionsDescriptor AllowNoIndices(bool? allowNoIndices = true) } /// - /// Type of index that wildcard patterns can match. If the request can target data streams, this argument
determines whether wildcard expressions match hidden data streams. Supports comma-separated values,
such as `open,hidden`. + /// + /// Type of index that wildcard patterns can match. If the request can target data streams, this argument + /// determines whether wildcard expressions match hidden data streams. Supports comma-separated values, + /// such as open,hidden. + /// /// public IndicesOptionsDescriptor ExpandWildcards(ICollection? expandWildcards) { @@ -93,7 +119,9 @@ public IndicesOptionsDescriptor ExpandWildcards(ICollection - /// If true, concrete, expanded or aliased indices are ignored when frozen. + /// + /// If true, concrete, expanded or aliased indices are ignored when frozen. + /// /// public IndicesOptionsDescriptor IgnoreThrottled(bool? ignoreThrottled = true) { @@ -102,7 +130,9 @@ public IndicesOptionsDescriptor IgnoreThrottled(bool? ignoreThrottled = true) } /// - /// If true, missing or closed indices are not included in the response. + /// + /// If true, missing or closed indices are not included in the response. + /// /// public IndicesOptionsDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Inference/InferenceEndpoint.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Inference/InferenceEndpoint.g.cs index 23c71668389..a1e9cf57801 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Inference/InferenceEndpoint.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Inference/InferenceEndpoint.g.cs @@ -28,31 +28,41 @@ namespace Elastic.Clients.Elasticsearch.Inference; /// -/// Configuration options when storing the inference endpoint +/// +/// Configuration options when storing the inference endpoint +/// /// public sealed partial class InferenceEndpoint { /// - /// The service type + /// + /// The service type + /// /// [JsonInclude, JsonPropertyName("service")] public string Service { get; set; } /// - /// Settings specific to the service + /// + /// Settings specific to the service + /// /// [JsonInclude, JsonPropertyName("service_settings")] public object ServiceSettings { get; set; } /// - /// Task settings specific to the service and task type + /// + /// Task settings specific to the service and task type + /// /// [JsonInclude, JsonPropertyName("task_settings")] public object TaskSettings { get; set; } } /// -/// Configuration options when storing the inference endpoint +/// +/// Configuration options when storing the inference endpoint +/// /// public sealed partial class InferenceEndpointDescriptor : SerializableDescriptor { @@ -67,7 +77,9 @@ public InferenceEndpointDescriptor() : base() private object TaskSettingsValue { get; set; } /// - /// The service type + /// + /// The service type + /// /// public InferenceEndpointDescriptor Service(string service) { @@ -76,7 +88,9 @@ public InferenceEndpointDescriptor Service(string service) } /// - /// Settings specific to the service + /// + /// Settings specific to the service + /// /// public InferenceEndpointDescriptor ServiceSettings(object serviceSettings) { @@ -85,7 +99,9 @@ public InferenceEndpointDescriptor ServiceSettings(object serviceSettings) } /// - /// Task settings specific to the service and task type + /// + /// Task settings specific to the service and task type + /// /// public InferenceEndpointDescriptor TaskSettings(object taskSettings) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Inference/InferenceEndpointInfo.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Inference/InferenceEndpointInfo.g.cs index 2b92e3219c3..2863e2dea74 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Inference/InferenceEndpointInfo.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Inference/InferenceEndpointInfo.g.cs @@ -28,36 +28,48 @@ namespace Elastic.Clients.Elasticsearch.Inference; /// -/// Represents an inference endpoint as returned by the GET API +/// +/// Represents an inference endpoint as returned by the GET API +/// /// public sealed partial class InferenceEndpointInfo { /// - /// The inference Id + /// + /// The inference Id + /// /// [JsonInclude, JsonPropertyName("inference_id")] public string InferenceId { get; init; } /// - /// The service type + /// + /// The service type + /// /// [JsonInclude, JsonPropertyName("service")] public string Service { get; init; } /// - /// Settings specific to the service + /// + /// Settings specific to the service + /// /// [JsonInclude, JsonPropertyName("service_settings")] public object ServiceSettings { get; init; } /// - /// Task settings specific to the service and task type + /// + /// Task settings specific to the service and task type + /// /// [JsonInclude, JsonPropertyName("task_settings")] public object TaskSettings { get; init; } /// - /// The task type + /// + /// The task type + /// /// [JsonInclude, JsonPropertyName("task_type")] public Elastic.Clients.Elasticsearch.Inference.TaskType TaskType { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/AppendProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/AppendProcessor.g.cs index 82b25d44e1b..d89839c4c0b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/AppendProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/AppendProcessor.g.cs @@ -30,49 +30,68 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class AppendProcessor { /// - /// If `false`, the processor does not append values already present in the field. + /// + /// If false, the processor does not append values already present in the field. + /// /// [JsonInclude, JsonPropertyName("allow_duplicates")] public bool? AllowDuplicates { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to be appended to.
Supports template snippets. + /// + /// The field to be appended to. + /// Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The value to be appended. Supports template snippets. + /// + /// The value to be appended. Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("value")] public ICollection Value { get; set; } @@ -101,7 +120,9 @@ public AppendProcessorDescriptor() : base() private ICollection ValueValue { get; set; } /// - /// If `false`, the processor does not append values already present in the field. + /// + /// If false, the processor does not append values already present in the field. + /// /// public AppendProcessorDescriptor AllowDuplicates(bool? allowDuplicates = true) { @@ -110,7 +131,10 @@ public AppendProcessorDescriptor AllowDuplicates(bool? allowDuplicate } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public AppendProcessorDescriptor Description(string? description) { @@ -119,7 +143,10 @@ public AppendProcessorDescriptor Description(string? description) } /// - /// The field to be appended to.
Supports template snippets. + /// + /// The field to be appended to. + /// Supports template snippets. + /// /// public AppendProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -128,7 +155,10 @@ public AppendProcessorDescriptor Field(Elastic.Clients.Elasticsearch. } /// - /// The field to be appended to.
Supports template snippets. + /// + /// The field to be appended to. + /// Supports template snippets. + /// /// public AppendProcessorDescriptor Field(Expression> field) { @@ -137,7 +167,10 @@ public AppendProcessorDescriptor Field(Expression - /// The field to be appended to.
Supports template snippets. + /// + /// The field to be appended to. + /// Supports template snippets. + /// /// public AppendProcessorDescriptor Field(Expression> field) { @@ -146,7 +179,9 @@ public AppendProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public AppendProcessorDescriptor If(string? value) { @@ -155,7 +190,9 @@ public AppendProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public AppendProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -164,7 +201,9 @@ public AppendProcessorDescriptor IgnoreFailure(bool? ignoreFailure = } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public AppendProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -203,7 +242,10 @@ public AppendProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public AppendProcessorDescriptor Tag(string? tag) { @@ -212,7 +254,9 @@ public AppendProcessorDescriptor Tag(string? tag) } /// - /// The value to be appended. Supports template snippets. + /// + /// The value to be appended. Supports template snippets. + /// /// public AppendProcessorDescriptor Value(ICollection value) { @@ -313,7 +357,9 @@ public AppendProcessorDescriptor() : base() private ICollection ValueValue { get; set; } /// - /// If `false`, the processor does not append values already present in the field. + /// + /// If false, the processor does not append values already present in the field. + /// /// public AppendProcessorDescriptor AllowDuplicates(bool? allowDuplicates = true) { @@ -322,7 +368,10 @@ public AppendProcessorDescriptor AllowDuplicates(bool? allowDuplicates = true) } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public AppendProcessorDescriptor Description(string? description) { @@ -331,7 +380,10 @@ public AppendProcessorDescriptor Description(string? description) } /// - /// The field to be appended to.
Supports template snippets. + /// + /// The field to be appended to. + /// Supports template snippets. + /// /// public AppendProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -340,7 +392,10 @@ public AppendProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field } /// - /// The field to be appended to.
Supports template snippets. + /// + /// The field to be appended to. + /// Supports template snippets. + /// /// public AppendProcessorDescriptor Field(Expression> field) { @@ -349,7 +404,10 @@ public AppendProcessorDescriptor Field(Expression - /// The field to be appended to.
Supports template snippets. + /// + /// The field to be appended to. + /// Supports template snippets. + /// /// public AppendProcessorDescriptor Field(Expression> field) { @@ -358,7 +416,9 @@ public AppendProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public AppendProcessorDescriptor If(string? value) { @@ -367,7 +427,9 @@ public AppendProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public AppendProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -376,7 +438,9 @@ public AppendProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public AppendProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -415,7 +479,10 @@ public AppendProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public AppendProcessorDescriptor Tag(string? tag) { @@ -424,7 +491,9 @@ public AppendProcessorDescriptor Tag(string? tag) } /// - /// The value to be appended. Supports template snippets. + /// + /// The value to be appended. Supports template snippets. + /// /// public AppendProcessorDescriptor Value(ICollection value) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/AttachmentProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/AttachmentProcessor.g.cs index 62d5488fcc5..9f18faaab3c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/AttachmentProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/AttachmentProcessor.g.cs @@ -30,79 +30,110 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class AttachmentProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to get the base64 encoded field from. + /// + /// The field to get the base64 encoded field from. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and field does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// The number of chars being used for extraction to prevent huge fields.
Use `-1` for no limit. + /// + /// The number of chars being used for extraction to prevent huge fields. + /// Use -1 for no limit. + /// /// [JsonInclude, JsonPropertyName("indexed_chars")] public long? IndexedChars { get; set; } /// - /// Field name from which you can overwrite the number of chars being used for extraction. + /// + /// Field name from which you can overwrite the number of chars being used for extraction. + /// /// [JsonInclude, JsonPropertyName("indexed_chars_field")] public Elastic.Clients.Elasticsearch.Field? IndexedCharsField { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Array of properties to select to be stored.
Can be `content`, `title`, `name`, `author`, `keywords`, `date`, `content_type`, `content_length`, `language`. + /// + /// Array of properties to select to be stored. + /// Can be content, title, name, author, keywords, date, content_type, content_length, language. + /// /// [JsonInclude, JsonPropertyName("properties")] public ICollection? Properties { get; set; } /// - /// If true, the binary field will be removed from the document + /// + /// If true, the binary field will be removed from the document + /// /// [JsonInclude, JsonPropertyName("remove_binary")] public bool? RemoveBinary { get; set; } /// - /// Field containing the name of the resource to decode.
If specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection. + /// + /// Field containing the name of the resource to decode. + /// If specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection. + /// /// [JsonInclude, JsonPropertyName("resource_name")] public string? ResourceName { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field that will hold the attachment information. + /// + /// The field that will hold the attachment information. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } @@ -136,7 +167,10 @@ public AttachmentProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public AttachmentProcessorDescriptor Description(string? description) { @@ -145,7 +179,9 @@ public AttachmentProcessorDescriptor Description(string? description) } /// - /// The field to get the base64 encoded field from. + /// + /// The field to get the base64 encoded field from. + /// /// public AttachmentProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -154,7 +190,9 @@ public AttachmentProcessorDescriptor Field(Elastic.Clients.Elasticsea } /// - /// The field to get the base64 encoded field from. + /// + /// The field to get the base64 encoded field from. + /// /// public AttachmentProcessorDescriptor Field(Expression> field) { @@ -163,7 +201,9 @@ public AttachmentProcessorDescriptor Field(Expression - /// The field to get the base64 encoded field from. + /// + /// The field to get the base64 encoded field from. + /// /// public AttachmentProcessorDescriptor Field(Expression> field) { @@ -172,7 +212,9 @@ public AttachmentProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public AttachmentProcessorDescriptor If(string? value) { @@ -181,7 +223,9 @@ public AttachmentProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public AttachmentProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -190,7 +234,9 @@ public AttachmentProcessorDescriptor IgnoreFailure(bool? ignoreFailur } /// - /// If `true` and field does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public AttachmentProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -199,7 +245,10 @@ public AttachmentProcessorDescriptor IgnoreMissing(bool? ignoreMissin } /// - /// The number of chars being used for extraction to prevent huge fields.
Use `-1` for no limit. + /// + /// The number of chars being used for extraction to prevent huge fields. + /// Use -1 for no limit. + /// /// public AttachmentProcessorDescriptor IndexedChars(long? indexedChars) { @@ -208,7 +257,9 @@ public AttachmentProcessorDescriptor IndexedChars(long? indexedChars) } /// - /// Field name from which you can overwrite the number of chars being used for extraction. + /// + /// Field name from which you can overwrite the number of chars being used for extraction. + /// /// public AttachmentProcessorDescriptor IndexedCharsField(Elastic.Clients.Elasticsearch.Field? indexedCharsField) { @@ -217,7 +268,9 @@ public AttachmentProcessorDescriptor IndexedCharsField(Elastic.Client } /// - /// Field name from which you can overwrite the number of chars being used for extraction. + /// + /// Field name from which you can overwrite the number of chars being used for extraction. + /// /// public AttachmentProcessorDescriptor IndexedCharsField(Expression> indexedCharsField) { @@ -226,7 +279,9 @@ public AttachmentProcessorDescriptor IndexedCharsField(Expres } /// - /// Field name from which you can overwrite the number of chars being used for extraction. + /// + /// Field name from which you can overwrite the number of chars being used for extraction. + /// /// public AttachmentProcessorDescriptor IndexedCharsField(Expression> indexedCharsField) { @@ -235,7 +290,9 @@ public AttachmentProcessorDescriptor IndexedCharsField(Expression - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public AttachmentProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -274,7 +331,10 @@ public AttachmentProcessorDescriptor OnFailure(params Action - /// Array of properties to select to be stored.
Can be `content`, `title`, `name`, `author`, `keywords`, `date`, `content_type`, `content_length`, `language`. + /// + /// Array of properties to select to be stored. + /// Can be content, title, name, author, keywords, date, content_type, content_length, language. + /// /// public AttachmentProcessorDescriptor Properties(ICollection? properties) { @@ -283,7 +343,9 @@ public AttachmentProcessorDescriptor Properties(ICollection? } /// - /// If true, the binary field will be removed from the document + /// + /// If true, the binary field will be removed from the document + /// /// public AttachmentProcessorDescriptor RemoveBinary(bool? removeBinary = true) { @@ -292,7 +354,10 @@ public AttachmentProcessorDescriptor RemoveBinary(bool? removeBinary } /// - /// Field containing the name of the resource to decode.
If specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection. + /// + /// Field containing the name of the resource to decode. + /// If specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection. + /// /// public AttachmentProcessorDescriptor ResourceName(string? resourceName) { @@ -301,7 +366,10 @@ public AttachmentProcessorDescriptor ResourceName(string? resourceNam } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public AttachmentProcessorDescriptor Tag(string? tag) { @@ -310,7 +378,9 @@ public AttachmentProcessorDescriptor Tag(string? tag) } /// - /// The field that will hold the attachment information. + /// + /// The field that will hold the attachment information. + /// /// public AttachmentProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -319,7 +389,9 @@ public AttachmentProcessorDescriptor TargetField(Elastic.Clients.Elas } /// - /// The field that will hold the attachment information. + /// + /// The field that will hold the attachment information. + /// /// public AttachmentProcessorDescriptor TargetField(Expression> targetField) { @@ -328,7 +400,9 @@ public AttachmentProcessorDescriptor TargetField(Expression - /// The field that will hold the attachment information. + /// + /// The field that will hold the attachment information. + /// /// public AttachmentProcessorDescriptor TargetField(Expression> targetField) { @@ -468,7 +542,10 @@ public AttachmentProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public AttachmentProcessorDescriptor Description(string? description) { @@ -477,7 +554,9 @@ public AttachmentProcessorDescriptor Description(string? description) } /// - /// The field to get the base64 encoded field from. + /// + /// The field to get the base64 encoded field from. + /// /// public AttachmentProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -486,7 +565,9 @@ public AttachmentProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field f } /// - /// The field to get the base64 encoded field from. + /// + /// The field to get the base64 encoded field from. + /// /// public AttachmentProcessorDescriptor Field(Expression> field) { @@ -495,7 +576,9 @@ public AttachmentProcessorDescriptor Field(Expression - /// The field to get the base64 encoded field from. + /// + /// The field to get the base64 encoded field from. + /// /// public AttachmentProcessorDescriptor Field(Expression> field) { @@ -504,7 +587,9 @@ public AttachmentProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public AttachmentProcessorDescriptor If(string? value) { @@ -513,7 +598,9 @@ public AttachmentProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public AttachmentProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -522,7 +609,9 @@ public AttachmentProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and field does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public AttachmentProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -531,7 +620,10 @@ public AttachmentProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// The number of chars being used for extraction to prevent huge fields.
Use `-1` for no limit. + /// + /// The number of chars being used for extraction to prevent huge fields. + /// Use -1 for no limit. + /// /// public AttachmentProcessorDescriptor IndexedChars(long? indexedChars) { @@ -540,7 +632,9 @@ public AttachmentProcessorDescriptor IndexedChars(long? indexedChars) } /// - /// Field name from which you can overwrite the number of chars being used for extraction. + /// + /// Field name from which you can overwrite the number of chars being used for extraction. + /// /// public AttachmentProcessorDescriptor IndexedCharsField(Elastic.Clients.Elasticsearch.Field? indexedCharsField) { @@ -549,7 +643,9 @@ public AttachmentProcessorDescriptor IndexedCharsField(Elastic.Clients.Elasticse } /// - /// Field name from which you can overwrite the number of chars being used for extraction. + /// + /// Field name from which you can overwrite the number of chars being used for extraction. + /// /// public AttachmentProcessorDescriptor IndexedCharsField(Expression> indexedCharsField) { @@ -558,7 +654,9 @@ public AttachmentProcessorDescriptor IndexedCharsField(Expres } /// - /// Field name from which you can overwrite the number of chars being used for extraction. + /// + /// Field name from which you can overwrite the number of chars being used for extraction. + /// /// public AttachmentProcessorDescriptor IndexedCharsField(Expression> indexedCharsField) { @@ -567,7 +665,9 @@ public AttachmentProcessorDescriptor IndexedCharsField(Expression - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public AttachmentProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -606,7 +706,10 @@ public AttachmentProcessorDescriptor OnFailure(params Action - /// Array of properties to select to be stored.
Can be `content`, `title`, `name`, `author`, `keywords`, `date`, `content_type`, `content_length`, `language`. + /// + /// Array of properties to select to be stored. + /// Can be content, title, name, author, keywords, date, content_type, content_length, language. + /// /// public AttachmentProcessorDescriptor Properties(ICollection? properties) { @@ -615,7 +718,9 @@ public AttachmentProcessorDescriptor Properties(ICollection? properties) } /// - /// If true, the binary field will be removed from the document + /// + /// If true, the binary field will be removed from the document + /// /// public AttachmentProcessorDescriptor RemoveBinary(bool? removeBinary = true) { @@ -624,7 +729,10 @@ public AttachmentProcessorDescriptor RemoveBinary(bool? removeBinary = true) } /// - /// Field containing the name of the resource to decode.
If specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection. + /// + /// Field containing the name of the resource to decode. + /// If specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection. + /// /// public AttachmentProcessorDescriptor ResourceName(string? resourceName) { @@ -633,7 +741,10 @@ public AttachmentProcessorDescriptor ResourceName(string? resourceName) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public AttachmentProcessorDescriptor Tag(string? tag) { @@ -642,7 +753,9 @@ public AttachmentProcessorDescriptor Tag(string? tag) } /// - /// The field that will hold the attachment information. + /// + /// The field that will hold the attachment information. + /// /// public AttachmentProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -651,7 +764,9 @@ public AttachmentProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.F } /// - /// The field that will hold the attachment information. + /// + /// The field that will hold the attachment information. + /// /// public AttachmentProcessorDescriptor TargetField(Expression> targetField) { @@ -660,7 +775,9 @@ public AttachmentProcessorDescriptor TargetField(Expression - /// The field that will hold the attachment information. + /// + /// The field that will hold the attachment information. + /// /// public AttachmentProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/BytesProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/BytesProcessor.g.cs index 74929c7fab8..09f2d5320ed 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/BytesProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/BytesProcessor.g.cs @@ -30,49 +30,68 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class BytesProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to convert. + /// + /// The field to convert. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } @@ -101,7 +120,10 @@ public BytesProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public BytesProcessorDescriptor Description(string? description) { @@ -110,7 +132,9 @@ public BytesProcessorDescriptor Description(string? description) } /// - /// The field to convert. + /// + /// The field to convert. + /// /// public BytesProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -119,7 +143,9 @@ public BytesProcessorDescriptor Field(Elastic.Clients.Elasticsearch.F } /// - /// The field to convert. + /// + /// The field to convert. + /// /// public BytesProcessorDescriptor Field(Expression> field) { @@ -128,7 +154,9 @@ public BytesProcessorDescriptor Field(Expression - /// The field to convert. + /// + /// The field to convert. + /// /// public BytesProcessorDescriptor Field(Expression> field) { @@ -137,7 +165,9 @@ public BytesProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public BytesProcessorDescriptor If(string? value) { @@ -146,7 +176,9 @@ public BytesProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public BytesProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -155,7 +187,9 @@ public BytesProcessorDescriptor IgnoreFailure(bool? ignoreFailure = t } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public BytesProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -164,7 +198,9 @@ public BytesProcessorDescriptor IgnoreMissing(bool? ignoreMissing = t } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public BytesProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -203,7 +239,10 @@ public BytesProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public BytesProcessorDescriptor Tag(string? tag) { @@ -212,7 +251,10 @@ public BytesProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public BytesProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -221,7 +263,10 @@ public BytesProcessorDescriptor TargetField(Elastic.Clients.Elasticse } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public BytesProcessorDescriptor TargetField(Expression> targetField) { @@ -230,7 +275,10 @@ public BytesProcessorDescriptor TargetField(Expression - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public BytesProcessorDescriptor TargetField(Expression> targetField) { @@ -335,7 +383,10 @@ public BytesProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public BytesProcessorDescriptor Description(string? description) { @@ -344,7 +395,9 @@ public BytesProcessorDescriptor Description(string? description) } /// - /// The field to convert. + /// + /// The field to convert. + /// /// public BytesProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -353,7 +406,9 @@ public BytesProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) } /// - /// The field to convert. + /// + /// The field to convert. + /// /// public BytesProcessorDescriptor Field(Expression> field) { @@ -362,7 +417,9 @@ public BytesProcessorDescriptor Field(Expression - /// The field to convert. + /// + /// The field to convert. + /// /// public BytesProcessorDescriptor Field(Expression> field) { @@ -371,7 +428,9 @@ public BytesProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public BytesProcessorDescriptor If(string? value) { @@ -380,7 +439,9 @@ public BytesProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public BytesProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -389,7 +450,9 @@ public BytesProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public BytesProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -398,7 +461,9 @@ public BytesProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public BytesProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -437,7 +502,10 @@ public BytesProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public BytesProcessorDescriptor Tag(string? tag) { @@ -446,7 +514,10 @@ public BytesProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public BytesProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -455,7 +526,10 @@ public BytesProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public BytesProcessorDescriptor TargetField(Expression> targetField) { @@ -464,7 +538,10 @@ public BytesProcessorDescriptor TargetField(Expression - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public BytesProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/CircleProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/CircleProcessor.g.cs index 303356ba6cf..b18cd987e1c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/CircleProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/CircleProcessor.g.cs @@ -30,61 +30,84 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class CircleProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for `geo_shape`, unit-less for `shape`). + /// + /// The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for geo_shape, unit-less for shape). + /// /// [JsonInclude, JsonPropertyName("error_distance")] public double ErrorDistance { get; set; } /// - /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// + /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Which field mapping type is to be used when processing the circle: `geo_shape` or `shape`. + /// + /// Which field mapping type is to be used when processing the circle: geo_shape or shape. + /// /// [JsonInclude, JsonPropertyName("shape_type")] public Elastic.Clients.Elasticsearch.Ingest.ShapeType ShapeType { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field to assign the polygon shape to
By default, the field is updated in-place. + /// + /// The field to assign the polygon shape to + /// By default, the field is updated in-place. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } @@ -115,7 +138,10 @@ public CircleProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public CircleProcessorDescriptor Description(string? description) { @@ -124,7 +150,9 @@ public CircleProcessorDescriptor Description(string? description) } /// - /// The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for `geo_shape`, unit-less for `shape`). + /// + /// The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for geo_shape, unit-less for shape). + /// /// public CircleProcessorDescriptor ErrorDistance(double errorDistance) { @@ -133,7 +161,9 @@ public CircleProcessorDescriptor ErrorDistance(double errorDistance) } /// - /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// + /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// /// public CircleProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -142,7 +172,9 @@ public CircleProcessorDescriptor Field(Elastic.Clients.Elasticsearch. } /// - /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// + /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// /// public CircleProcessorDescriptor Field(Expression> field) { @@ -151,7 +183,9 @@ public CircleProcessorDescriptor Field(Expression - /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// + /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// /// public CircleProcessorDescriptor Field(Expression> field) { @@ -160,7 +194,9 @@ public CircleProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public CircleProcessorDescriptor If(string? value) { @@ -169,7 +205,9 @@ public CircleProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public CircleProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -178,7 +216,9 @@ public CircleProcessorDescriptor IgnoreFailure(bool? ignoreFailure = } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public CircleProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -187,7 +227,9 @@ public CircleProcessorDescriptor IgnoreMissing(bool? ignoreMissing = } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public CircleProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -226,7 +268,9 @@ public CircleProcessorDescriptor OnFailure(params Action - /// Which field mapping type is to be used when processing the circle: `geo_shape` or `shape`. + /// + /// Which field mapping type is to be used when processing the circle: geo_shape or shape. + /// /// public CircleProcessorDescriptor ShapeType(Elastic.Clients.Elasticsearch.Ingest.ShapeType shapeType) { @@ -235,7 +279,10 @@ public CircleProcessorDescriptor ShapeType(Elastic.Clients.Elasticsea } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public CircleProcessorDescriptor Tag(string? tag) { @@ -244,7 +291,10 @@ public CircleProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the polygon shape to
By default, the field is updated in-place. + /// + /// The field to assign the polygon shape to + /// By default, the field is updated in-place. + /// /// public CircleProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -253,7 +303,10 @@ public CircleProcessorDescriptor TargetField(Elastic.Clients.Elastics } /// - /// The field to assign the polygon shape to
By default, the field is updated in-place. + /// + /// The field to assign the polygon shape to + /// By default, the field is updated in-place. + /// /// public CircleProcessorDescriptor TargetField(Expression> targetField) { @@ -262,7 +315,10 @@ public CircleProcessorDescriptor TargetField(Expression - /// The field to assign the polygon shape to
By default, the field is updated in-place. + /// + /// The field to assign the polygon shape to + /// By default, the field is updated in-place. + /// /// public CircleProcessorDescriptor TargetField(Expression> targetField) { @@ -373,7 +429,10 @@ public CircleProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public CircleProcessorDescriptor Description(string? description) { @@ -382,7 +441,9 @@ public CircleProcessorDescriptor Description(string? description) } /// - /// The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for `geo_shape`, unit-less for `shape`). + /// + /// The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for geo_shape, unit-less for shape). + /// /// public CircleProcessorDescriptor ErrorDistance(double errorDistance) { @@ -391,7 +452,9 @@ public CircleProcessorDescriptor ErrorDistance(double errorDistance) } /// - /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// + /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// /// public CircleProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -400,7 +463,9 @@ public CircleProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field } /// - /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// + /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// /// public CircleProcessorDescriptor Field(Expression> field) { @@ -409,7 +474,9 @@ public CircleProcessorDescriptor Field(Expression - /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// + /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// /// public CircleProcessorDescriptor Field(Expression> field) { @@ -418,7 +485,9 @@ public CircleProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public CircleProcessorDescriptor If(string? value) { @@ -427,7 +496,9 @@ public CircleProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public CircleProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -436,7 +507,9 @@ public CircleProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public CircleProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -445,7 +518,9 @@ public CircleProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public CircleProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -484,7 +559,9 @@ public CircleProcessorDescriptor OnFailure(params Action - /// Which field mapping type is to be used when processing the circle: `geo_shape` or `shape`. + /// + /// Which field mapping type is to be used when processing the circle: geo_shape or shape. + /// /// public CircleProcessorDescriptor ShapeType(Elastic.Clients.Elasticsearch.Ingest.ShapeType shapeType) { @@ -493,7 +570,10 @@ public CircleProcessorDescriptor ShapeType(Elastic.Clients.Elasticsearch.Ingest. } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public CircleProcessorDescriptor Tag(string? tag) { @@ -502,7 +582,10 @@ public CircleProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the polygon shape to
By default, the field is updated in-place. + /// + /// The field to assign the polygon shape to + /// By default, the field is updated in-place. + /// /// public CircleProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -511,7 +594,10 @@ public CircleProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field } /// - /// The field to assign the polygon shape to
By default, the field is updated in-place. + /// + /// The field to assign the polygon shape to + /// By default, the field is updated in-place. + /// /// public CircleProcessorDescriptor TargetField(Expression> targetField) { @@ -520,7 +606,10 @@ public CircleProcessorDescriptor TargetField(Expression - /// The field to assign the polygon shape to
By default, the field is updated in-place. + /// + /// The field to assign the polygon shape to + /// By default, the field is updated in-place. + /// /// public CircleProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/ConvertProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/ConvertProcessor.g.cs index 34b4102e8ee..ccf9b55b880 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/ConvertProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/ConvertProcessor.g.cs @@ -30,55 +30,76 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class ConvertProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field whose value is to be converted. + /// + /// The field whose value is to be converted. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field to assign the converted value to.
By default, the `field` is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } /// - /// The type to convert the existing value to. + /// + /// The type to convert the existing value to. + /// /// [JsonInclude, JsonPropertyName("type")] public Elastic.Clients.Elasticsearch.Ingest.ConvertType Type { get; set; } @@ -108,7 +129,10 @@ public ConvertProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Ingest.ConvertType TypeValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public ConvertProcessorDescriptor Description(string? description) { @@ -117,7 +141,9 @@ public ConvertProcessorDescriptor Description(string? description) } /// - /// The field whose value is to be converted. + /// + /// The field whose value is to be converted. + /// /// public ConvertProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -126,7 +152,9 @@ public ConvertProcessorDescriptor Field(Elastic.Clients.Elasticsearch } /// - /// The field whose value is to be converted. + /// + /// The field whose value is to be converted. + /// /// public ConvertProcessorDescriptor Field(Expression> field) { @@ -135,7 +163,9 @@ public ConvertProcessorDescriptor Field(Expression - /// The field whose value is to be converted. + /// + /// The field whose value is to be converted. + /// /// public ConvertProcessorDescriptor Field(Expression> field) { @@ -144,7 +174,9 @@ public ConvertProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public ConvertProcessorDescriptor If(string? value) { @@ -153,7 +185,9 @@ public ConvertProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public ConvertProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -162,7 +196,9 @@ public ConvertProcessorDescriptor IgnoreFailure(bool? ignoreFailure = } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public ConvertProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -171,7 +207,9 @@ public ConvertProcessorDescriptor IgnoreMissing(bool? ignoreMissing = } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public ConvertProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -210,7 +248,10 @@ public ConvertProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public ConvertProcessorDescriptor Tag(string? tag) { @@ -219,7 +260,10 @@ public ConvertProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the converted value to.
By default, the `field` is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public ConvertProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -228,7 +272,10 @@ public ConvertProcessorDescriptor TargetField(Elastic.Clients.Elastic } /// - /// The field to assign the converted value to.
By default, the `field` is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public ConvertProcessorDescriptor TargetField(Expression> targetField) { @@ -237,7 +284,10 @@ public ConvertProcessorDescriptor TargetField(Expression - /// The field to assign the converted value to.
By default, the `field` is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public ConvertProcessorDescriptor TargetField(Expression> targetField) { @@ -246,7 +296,9 @@ public ConvertProcessorDescriptor TargetField(Expression - /// The type to convert the existing value to. + /// + /// The type to convert the existing value to. + /// /// public ConvertProcessorDescriptor Type(Elastic.Clients.Elasticsearch.Ingest.ConvertType type) { @@ -354,7 +406,10 @@ public ConvertProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Ingest.ConvertType TypeValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public ConvertProcessorDescriptor Description(string? description) { @@ -363,7 +418,9 @@ public ConvertProcessorDescriptor Description(string? description) } /// - /// The field whose value is to be converted. + /// + /// The field whose value is to be converted. + /// /// public ConvertProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -372,7 +429,9 @@ public ConvertProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field fiel } /// - /// The field whose value is to be converted. + /// + /// The field whose value is to be converted. + /// /// public ConvertProcessorDescriptor Field(Expression> field) { @@ -381,7 +440,9 @@ public ConvertProcessorDescriptor Field(Expression - /// The field whose value is to be converted. + /// + /// The field whose value is to be converted. + /// /// public ConvertProcessorDescriptor Field(Expression> field) { @@ -390,7 +451,9 @@ public ConvertProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public ConvertProcessorDescriptor If(string? value) { @@ -399,7 +462,9 @@ public ConvertProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public ConvertProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -408,7 +473,9 @@ public ConvertProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public ConvertProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -417,7 +484,9 @@ public ConvertProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public ConvertProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -456,7 +525,10 @@ public ConvertProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public ConvertProcessorDescriptor Tag(string? tag) { @@ -465,7 +537,10 @@ public ConvertProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the converted value to.
By default, the `field` is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public ConvertProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -474,7 +549,10 @@ public ConvertProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Fiel } /// - /// The field to assign the converted value to.
By default, the `field` is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public ConvertProcessorDescriptor TargetField(Expression> targetField) { @@ -483,7 +561,10 @@ public ConvertProcessorDescriptor TargetField(Expression - /// The field to assign the converted value to.
By default, the `field` is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public ConvertProcessorDescriptor TargetField(Expression> targetField) { @@ -492,7 +573,9 @@ public ConvertProcessorDescriptor TargetField(Expression - /// The type to convert the existing value to. + /// + /// The type to convert the existing value to. + /// /// public ConvertProcessorDescriptor Type(Elastic.Clients.Elasticsearch.Ingest.ConvertType type) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/CsvProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/CsvProcessor.g.cs index 6017497a9a9..a5d99c2209f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/CsvProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/CsvProcessor.g.cs @@ -30,74 +30,102 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class CsvProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// Value used to fill empty fields.
Empty fields are skipped if this is not provided.
An empty field is one with no value (2 consecutive separators) or empty quotes (`""`). + /// + /// Value used to fill empty fields. + /// Empty fields are skipped if this is not provided. + /// An empty field is one with no value (2 consecutive separators) or empty quotes (""). + /// /// [JsonInclude, JsonPropertyName("empty_value")] public object? EmptyValue { get; set; } /// - /// The field to extract data from. + /// + /// The field to extract data from. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Quote used in CSV, has to be single character string. + /// + /// Quote used in CSV, has to be single character string. + /// /// [JsonInclude, JsonPropertyName("quote")] public string? Quote { get; set; } /// - /// Separator used in CSV, has to be single character string. + /// + /// Separator used in CSV, has to be single character string. + /// /// [JsonInclude, JsonPropertyName("separator")] public string? Separator { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The array of fields to assign extracted values to. + /// + /// The array of fields to assign extracted values to. + /// /// [JsonInclude, JsonPropertyName("target_fields")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] public Elastic.Clients.Elasticsearch.Fields TargetFields { get; set; } /// - /// Trim whitespaces in unquoted fields. + /// + /// Trim whitespaces in unquoted fields. + /// /// [JsonInclude, JsonPropertyName("trim")] public bool? Trim { get; set; } @@ -130,7 +158,10 @@ public CsvProcessorDescriptor() : base() private bool? TrimValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public CsvProcessorDescriptor Description(string? description) { @@ -139,7 +170,11 @@ public CsvProcessorDescriptor Description(string? description) } /// - /// Value used to fill empty fields.
Empty fields are skipped if this is not provided.
An empty field is one with no value (2 consecutive separators) or empty quotes (`""`). + /// + /// Value used to fill empty fields. + /// Empty fields are skipped if this is not provided. + /// An empty field is one with no value (2 consecutive separators) or empty quotes (""). + /// /// public CsvProcessorDescriptor EmptyValue(object? emptyValue) { @@ -148,7 +183,9 @@ public CsvProcessorDescriptor EmptyValue(object? emptyValue) } /// - /// The field to extract data from. + /// + /// The field to extract data from. + /// /// public CsvProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -157,7 +194,9 @@ public CsvProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Fie } /// - /// The field to extract data from. + /// + /// The field to extract data from. + /// /// public CsvProcessorDescriptor Field(Expression> field) { @@ -166,7 +205,9 @@ public CsvProcessorDescriptor Field(Expression - /// The field to extract data from. + /// + /// The field to extract data from. + /// /// public CsvProcessorDescriptor Field(Expression> field) { @@ -175,7 +216,9 @@ public CsvProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public CsvProcessorDescriptor If(string? value) { @@ -184,7 +227,9 @@ public CsvProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public CsvProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -193,7 +238,9 @@ public CsvProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tru } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public CsvProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -202,7 +249,9 @@ public CsvProcessorDescriptor IgnoreMissing(bool? ignoreMissing = tru } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public CsvProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -241,7 +290,9 @@ public CsvProcessorDescriptor OnFailure(params Action - /// Quote used in CSV, has to be single character string. + /// + /// Quote used in CSV, has to be single character string. + /// /// public CsvProcessorDescriptor Quote(string? quote) { @@ -250,7 +301,9 @@ public CsvProcessorDescriptor Quote(string? quote) } /// - /// Separator used in CSV, has to be single character string. + /// + /// Separator used in CSV, has to be single character string. + /// /// public CsvProcessorDescriptor Separator(string? separator) { @@ -259,7 +312,10 @@ public CsvProcessorDescriptor Separator(string? separator) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public CsvProcessorDescriptor Tag(string? tag) { @@ -268,7 +324,9 @@ public CsvProcessorDescriptor Tag(string? tag) } /// - /// The array of fields to assign extracted values to. + /// + /// The array of fields to assign extracted values to. + /// /// public CsvProcessorDescriptor TargetFields(Elastic.Clients.Elasticsearch.Fields targetFields) { @@ -277,7 +335,9 @@ public CsvProcessorDescriptor TargetFields(Elastic.Clients.Elasticsea } /// - /// Trim whitespaces in unquoted fields. + /// + /// Trim whitespaces in unquoted fields. + /// /// public CsvProcessorDescriptor Trim(bool? trim = true) { @@ -406,7 +466,10 @@ public CsvProcessorDescriptor() : base() private bool? TrimValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public CsvProcessorDescriptor Description(string? description) { @@ -415,7 +478,11 @@ public CsvProcessorDescriptor Description(string? description) } /// - /// Value used to fill empty fields.
Empty fields are skipped if this is not provided.
An empty field is one with no value (2 consecutive separators) or empty quotes (`""`). + /// + /// Value used to fill empty fields. + /// Empty fields are skipped if this is not provided. + /// An empty field is one with no value (2 consecutive separators) or empty quotes (""). + /// /// public CsvProcessorDescriptor EmptyValue(object? emptyValue) { @@ -424,7 +491,9 @@ public CsvProcessorDescriptor EmptyValue(object? emptyValue) } /// - /// The field to extract data from. + /// + /// The field to extract data from. + /// /// public CsvProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -433,7 +502,9 @@ public CsvProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) } /// - /// The field to extract data from. + /// + /// The field to extract data from. + /// /// public CsvProcessorDescriptor Field(Expression> field) { @@ -442,7 +513,9 @@ public CsvProcessorDescriptor Field(Expression - /// The field to extract data from. + /// + /// The field to extract data from. + /// /// public CsvProcessorDescriptor Field(Expression> field) { @@ -451,7 +524,9 @@ public CsvProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public CsvProcessorDescriptor If(string? value) { @@ -460,7 +535,9 @@ public CsvProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public CsvProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -469,7 +546,9 @@ public CsvProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public CsvProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -478,7 +557,9 @@ public CsvProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public CsvProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -517,7 +598,9 @@ public CsvProcessorDescriptor OnFailure(params Action - /// Quote used in CSV, has to be single character string. + /// + /// Quote used in CSV, has to be single character string. + /// /// public CsvProcessorDescriptor Quote(string? quote) { @@ -526,7 +609,9 @@ public CsvProcessorDescriptor Quote(string? quote) } /// - /// Separator used in CSV, has to be single character string. + /// + /// Separator used in CSV, has to be single character string. + /// /// public CsvProcessorDescriptor Separator(string? separator) { @@ -535,7 +620,10 @@ public CsvProcessorDescriptor Separator(string? separator) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public CsvProcessorDescriptor Tag(string? tag) { @@ -544,7 +632,9 @@ public CsvProcessorDescriptor Tag(string? tag) } /// - /// The array of fields to assign extracted values to. + /// + /// The array of fields to assign extracted values to. + /// /// public CsvProcessorDescriptor TargetFields(Elastic.Clients.Elasticsearch.Fields targetFields) { @@ -553,7 +643,9 @@ public CsvProcessorDescriptor TargetFields(Elastic.Clients.Elasticsearch.Fields } /// - /// Trim whitespaces in unquoted fields. + /// + /// Trim whitespaces in unquoted fields. + /// /// public CsvProcessorDescriptor Trim(bool? trim = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DateIndexNameProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DateIndexNameProcessor.g.cs index 3e2143aa790..19b233d62e0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DateIndexNameProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DateIndexNameProcessor.g.cs @@ -30,73 +30,105 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class DateIndexNameProcessor { /// - /// An array of the expected date formats for parsing dates / timestamps in the document being preprocessed.
Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + /// + /// An array of the expected date formats for parsing dates / timestamps in the document being preprocessed. + /// Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + /// /// [JsonInclude, JsonPropertyName("date_formats")] public ICollection DateFormats { get; set; } /// - /// How to round the date when formatting the date into the index name. Valid values are:
`y` (year), `M` (month), `w` (week), `d` (day), `h` (hour), `m` (minute) and `s` (second).
Supports template snippets. + /// + /// How to round the date when formatting the date into the index name. Valid values are: + /// y (year), M (month), w (week), d (day), h (hour), m (minute) and s (second). + /// Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("date_rounding")] public string DateRounding { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to get the date or timestamp from. + /// + /// The field to get the date or timestamp from. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// The format to be used when printing the parsed date into the index name.
A valid java time pattern is expected here.
Supports template snippets. + /// + /// The format to be used when printing the parsed date into the index name. + /// A valid java time pattern is expected here. + /// Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("index_name_format")] public string? IndexNameFormat { get; set; } /// - /// A prefix of the index name to be prepended before the printed date.
Supports template snippets. + /// + /// A prefix of the index name to be prepended before the printed date. + /// Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("index_name_prefix")] public string? IndexNamePrefix { get; set; } /// - /// The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days. + /// + /// The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days. + /// /// [JsonInclude, JsonPropertyName("locale")] public string? Locale { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names. + /// + /// The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names. + /// /// [JsonInclude, JsonPropertyName("timezone")] public string? Timezone { get; set; } @@ -129,7 +161,10 @@ public DateIndexNameProcessorDescriptor() : base() private string? TimezoneValue { get; set; } /// - /// An array of the expected date formats for parsing dates / timestamps in the document being preprocessed.
Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + /// + /// An array of the expected date formats for parsing dates / timestamps in the document being preprocessed. + /// Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + /// /// public DateIndexNameProcessorDescriptor DateFormats(ICollection dateFormats) { @@ -138,7 +173,11 @@ public DateIndexNameProcessorDescriptor DateFormats(ICollection - /// How to round the date when formatting the date into the index name. Valid values are:
`y` (year), `M` (month), `w` (week), `d` (day), `h` (hour), `m` (minute) and `s` (second).
Supports template snippets. + /// + /// How to round the date when formatting the date into the index name. Valid values are: + /// y (year), M (month), w (week), d (day), h (hour), m (minute) and s (second). + /// Supports template snippets. + /// /// public DateIndexNameProcessorDescriptor DateRounding(string dateRounding) { @@ -147,7 +186,10 @@ public DateIndexNameProcessorDescriptor DateRounding(string dateRound } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public DateIndexNameProcessorDescriptor Description(string? description) { @@ -156,7 +198,9 @@ public DateIndexNameProcessorDescriptor Description(string? descripti } /// - /// The field to get the date or timestamp from. + /// + /// The field to get the date or timestamp from. + /// /// public DateIndexNameProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -165,7 +209,9 @@ public DateIndexNameProcessorDescriptor Field(Elastic.Clients.Elastic } /// - /// The field to get the date or timestamp from. + /// + /// The field to get the date or timestamp from. + /// /// public DateIndexNameProcessorDescriptor Field(Expression> field) { @@ -174,7 +220,9 @@ public DateIndexNameProcessorDescriptor Field(Expression - /// The field to get the date or timestamp from. + /// + /// The field to get the date or timestamp from. + /// /// public DateIndexNameProcessorDescriptor Field(Expression> field) { @@ -183,7 +231,9 @@ public DateIndexNameProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public DateIndexNameProcessorDescriptor If(string? value) { @@ -192,7 +242,9 @@ public DateIndexNameProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public DateIndexNameProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -201,7 +253,11 @@ public DateIndexNameProcessorDescriptor IgnoreFailure(bool? ignoreFai } /// - /// The format to be used when printing the parsed date into the index name.
A valid java time pattern is expected here.
Supports template snippets. + /// + /// The format to be used when printing the parsed date into the index name. + /// A valid java time pattern is expected here. + /// Supports template snippets. + /// /// public DateIndexNameProcessorDescriptor IndexNameFormat(string? indexNameFormat) { @@ -210,7 +266,10 @@ public DateIndexNameProcessorDescriptor IndexNameFormat(string? index } /// - /// A prefix of the index name to be prepended before the printed date.
Supports template snippets. + /// + /// A prefix of the index name to be prepended before the printed date. + /// Supports template snippets. + /// /// public DateIndexNameProcessorDescriptor IndexNamePrefix(string? indexNamePrefix) { @@ -219,7 +278,9 @@ public DateIndexNameProcessorDescriptor IndexNamePrefix(string? index } /// - /// The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days. + /// + /// The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days. + /// /// public DateIndexNameProcessorDescriptor Locale(string? locale) { @@ -228,7 +289,9 @@ public DateIndexNameProcessorDescriptor Locale(string? locale) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public DateIndexNameProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -267,7 +330,10 @@ public DateIndexNameProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public DateIndexNameProcessorDescriptor Tag(string? tag) { @@ -276,7 +342,9 @@ public DateIndexNameProcessorDescriptor Tag(string? tag) } /// - /// The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names. + /// + /// The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names. + /// /// public DateIndexNameProcessorDescriptor Timezone(string? timezone) { @@ -401,7 +469,10 @@ public DateIndexNameProcessorDescriptor() : base() private string? TimezoneValue { get; set; } /// - /// An array of the expected date formats for parsing dates / timestamps in the document being preprocessed.
Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + /// + /// An array of the expected date formats for parsing dates / timestamps in the document being preprocessed. + /// Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + /// /// public DateIndexNameProcessorDescriptor DateFormats(ICollection dateFormats) { @@ -410,7 +481,11 @@ public DateIndexNameProcessorDescriptor DateFormats(ICollection dateForm } /// - /// How to round the date when formatting the date into the index name. Valid values are:
`y` (year), `M` (month), `w` (week), `d` (day), `h` (hour), `m` (minute) and `s` (second).
Supports template snippets. + /// + /// How to round the date when formatting the date into the index name. Valid values are: + /// y (year), M (month), w (week), d (day), h (hour), m (minute) and s (second). + /// Supports template snippets. + /// /// public DateIndexNameProcessorDescriptor DateRounding(string dateRounding) { @@ -419,7 +494,10 @@ public DateIndexNameProcessorDescriptor DateRounding(string dateRounding) } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public DateIndexNameProcessorDescriptor Description(string? description) { @@ -428,7 +506,9 @@ public DateIndexNameProcessorDescriptor Description(string? description) } /// - /// The field to get the date or timestamp from. + /// + /// The field to get the date or timestamp from. + /// /// public DateIndexNameProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -437,7 +517,9 @@ public DateIndexNameProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Fiel } /// - /// The field to get the date or timestamp from. + /// + /// The field to get the date or timestamp from. + /// /// public DateIndexNameProcessorDescriptor Field(Expression> field) { @@ -446,7 +528,9 @@ public DateIndexNameProcessorDescriptor Field(Expression - /// The field to get the date or timestamp from. + /// + /// The field to get the date or timestamp from. + /// /// public DateIndexNameProcessorDescriptor Field(Expression> field) { @@ -455,7 +539,9 @@ public DateIndexNameProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public DateIndexNameProcessorDescriptor If(string? value) { @@ -464,7 +550,9 @@ public DateIndexNameProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public DateIndexNameProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -473,7 +561,11 @@ public DateIndexNameProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true } /// - /// The format to be used when printing the parsed date into the index name.
A valid java time pattern is expected here.
Supports template snippets. + /// + /// The format to be used when printing the parsed date into the index name. + /// A valid java time pattern is expected here. + /// Supports template snippets. + /// /// public DateIndexNameProcessorDescriptor IndexNameFormat(string? indexNameFormat) { @@ -482,7 +574,10 @@ public DateIndexNameProcessorDescriptor IndexNameFormat(string? indexNameFormat) } /// - /// A prefix of the index name to be prepended before the printed date.
Supports template snippets. + /// + /// A prefix of the index name to be prepended before the printed date. + /// Supports template snippets. + /// /// public DateIndexNameProcessorDescriptor IndexNamePrefix(string? indexNamePrefix) { @@ -491,7 +586,9 @@ public DateIndexNameProcessorDescriptor IndexNamePrefix(string? indexNamePrefix) } /// - /// The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days. + /// + /// The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days. + /// /// public DateIndexNameProcessorDescriptor Locale(string? locale) { @@ -500,7 +597,9 @@ public DateIndexNameProcessorDescriptor Locale(string? locale) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public DateIndexNameProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -539,7 +638,10 @@ public DateIndexNameProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public DateIndexNameProcessorDescriptor Tag(string? tag) { @@ -548,7 +650,9 @@ public DateIndexNameProcessorDescriptor Tag(string? tag) } /// - /// The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names. + /// + /// The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names. + /// /// public DateIndexNameProcessorDescriptor Timezone(string? timezone) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DateProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DateProcessor.g.cs index be58b9531fc..cc093530e31 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DateProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DateProcessor.g.cs @@ -30,61 +30,86 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class DateProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to get the date from. + /// + /// The field to get the date from. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// An array of the expected date formats.
Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + /// + /// An array of the expected date formats. + /// Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + /// /// [JsonInclude, JsonPropertyName("formats")] public ICollection Formats { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// The locale to use when parsing the date, relevant when parsing month names or week days.
Supports template snippets. + /// + /// The locale to use when parsing the date, relevant when parsing month names or week days. + /// Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("locale")] public string? Locale { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field that will hold the parsed date. + /// + /// The field that will hold the parsed date. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } /// - /// The timezone to use when parsing the date.
Supports template snippets. + /// + /// The timezone to use when parsing the date. + /// Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("timezone")] public string? Timezone { get; set; } @@ -115,7 +140,10 @@ public DateProcessorDescriptor() : base() private string? TimezoneValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public DateProcessorDescriptor Description(string? description) { @@ -124,7 +152,9 @@ public DateProcessorDescriptor Description(string? description) } /// - /// The field to get the date from. + /// + /// The field to get the date from. + /// /// public DateProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -133,7 +163,9 @@ public DateProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Fi } /// - /// The field to get the date from. + /// + /// The field to get the date from. + /// /// public DateProcessorDescriptor Field(Expression> field) { @@ -142,7 +174,9 @@ public DateProcessorDescriptor Field(Expression - /// The field to get the date from. + /// + /// The field to get the date from. + /// /// public DateProcessorDescriptor Field(Expression> field) { @@ -151,7 +185,10 @@ public DateProcessorDescriptor Field(Expression - /// An array of the expected date formats.
Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + /// + /// An array of the expected date formats. + /// Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + /// /// public DateProcessorDescriptor Formats(ICollection formats) { @@ -160,7 +197,9 @@ public DateProcessorDescriptor Formats(ICollection formats) } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public DateProcessorDescriptor If(string? value) { @@ -169,7 +208,9 @@ public DateProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public DateProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -178,7 +219,10 @@ public DateProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tr } /// - /// The locale to use when parsing the date, relevant when parsing month names or week days.
Supports template snippets. + /// + /// The locale to use when parsing the date, relevant when parsing month names or week days. + /// Supports template snippets. + /// /// public DateProcessorDescriptor Locale(string? locale) { @@ -187,7 +231,9 @@ public DateProcessorDescriptor Locale(string? locale) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public DateProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -226,7 +272,10 @@ public DateProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public DateProcessorDescriptor Tag(string? tag) { @@ -235,7 +284,9 @@ public DateProcessorDescriptor Tag(string? tag) } /// - /// The field that will hold the parsed date. + /// + /// The field that will hold the parsed date. + /// /// public DateProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -244,7 +295,9 @@ public DateProcessorDescriptor TargetField(Elastic.Clients.Elasticsea } /// - /// The field that will hold the parsed date. + /// + /// The field that will hold the parsed date. + /// /// public DateProcessorDescriptor TargetField(Expression> targetField) { @@ -253,7 +306,9 @@ public DateProcessorDescriptor TargetField(Expression - /// The field that will hold the parsed date. + /// + /// The field that will hold the parsed date. + /// /// public DateProcessorDescriptor TargetField(Expression> targetField) { @@ -262,7 +317,10 @@ public DateProcessorDescriptor TargetField(Expression - /// The timezone to use when parsing the date.
Supports template snippets. + /// + /// The timezone to use when parsing the date. + /// Supports template snippets. + /// /// public DateProcessorDescriptor Timezone(string? timezone) { @@ -377,7 +435,10 @@ public DateProcessorDescriptor() : base() private string? TimezoneValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public DateProcessorDescriptor Description(string? description) { @@ -386,7 +447,9 @@ public DateProcessorDescriptor Description(string? description) } /// - /// The field to get the date from. + /// + /// The field to get the date from. + /// /// public DateProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -395,7 +458,9 @@ public DateProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) } /// - /// The field to get the date from. + /// + /// The field to get the date from. + /// /// public DateProcessorDescriptor Field(Expression> field) { @@ -404,7 +469,9 @@ public DateProcessorDescriptor Field(Expression - /// The field to get the date from. + /// + /// The field to get the date from. + /// /// public DateProcessorDescriptor Field(Expression> field) { @@ -413,7 +480,10 @@ public DateProcessorDescriptor Field(Expression - /// An array of the expected date formats.
Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + /// + /// An array of the expected date formats. + /// Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + /// /// public DateProcessorDescriptor Formats(ICollection formats) { @@ -422,7 +492,9 @@ public DateProcessorDescriptor Formats(ICollection formats) } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public DateProcessorDescriptor If(string? value) { @@ -431,7 +503,9 @@ public DateProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public DateProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -440,7 +514,10 @@ public DateProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// The locale to use when parsing the date, relevant when parsing month names or week days.
Supports template snippets. + /// + /// The locale to use when parsing the date, relevant when parsing month names or week days. + /// Supports template snippets. + /// /// public DateProcessorDescriptor Locale(string? locale) { @@ -449,7 +526,9 @@ public DateProcessorDescriptor Locale(string? locale) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public DateProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -488,7 +567,10 @@ public DateProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public DateProcessorDescriptor Tag(string? tag) { @@ -497,7 +579,9 @@ public DateProcessorDescriptor Tag(string? tag) } /// - /// The field that will hold the parsed date. + /// + /// The field that will hold the parsed date. + /// /// public DateProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -506,7 +590,9 @@ public DateProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? } /// - /// The field that will hold the parsed date. + /// + /// The field that will hold the parsed date. + /// /// public DateProcessorDescriptor TargetField(Expression> targetField) { @@ -515,7 +601,9 @@ public DateProcessorDescriptor TargetField(Expression - /// The field that will hold the parsed date. + /// + /// The field that will hold the parsed date. + /// /// public DateProcessorDescriptor TargetField(Expression> targetField) { @@ -524,7 +612,10 @@ public DateProcessorDescriptor TargetField(Expression - /// The timezone to use when parsing the date.
Supports template snippets. + /// + /// The timezone to use when parsing the date. + /// Supports template snippets. + /// /// public DateProcessorDescriptor Timezone(string? timezone) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DissectProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DissectProcessor.g.cs index c2358a320d4..ef9bc68d98d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DissectProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DissectProcessor.g.cs @@ -30,55 +30,75 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class DissectProcessor { /// - /// The character(s) that separate the appended fields. + /// + /// The character(s) that separate the appended fields. + /// /// [JsonInclude, JsonPropertyName("append_separator")] public string? AppendSeparator { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to dissect. + /// + /// The field to dissect. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// The pattern to apply to the field. + /// + /// The pattern to apply to the field. + /// /// [JsonInclude, JsonPropertyName("pattern")] public string Pattern { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } @@ -108,7 +128,9 @@ public DissectProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// The character(s) that separate the appended fields. + /// + /// The character(s) that separate the appended fields. + /// /// public DissectProcessorDescriptor AppendSeparator(string? appendSeparator) { @@ -117,7 +139,10 @@ public DissectProcessorDescriptor AppendSeparator(string? appendSepar } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public DissectProcessorDescriptor Description(string? description) { @@ -126,7 +151,9 @@ public DissectProcessorDescriptor Description(string? description) } /// - /// The field to dissect. + /// + /// The field to dissect. + /// /// public DissectProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -135,7 +162,9 @@ public DissectProcessorDescriptor Field(Elastic.Clients.Elasticsearch } /// - /// The field to dissect. + /// + /// The field to dissect. + /// /// public DissectProcessorDescriptor Field(Expression> field) { @@ -144,7 +173,9 @@ public DissectProcessorDescriptor Field(Expression - /// The field to dissect. + /// + /// The field to dissect. + /// /// public DissectProcessorDescriptor Field(Expression> field) { @@ -153,7 +184,9 @@ public DissectProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public DissectProcessorDescriptor If(string? value) { @@ -162,7 +195,9 @@ public DissectProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public DissectProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -171,7 +206,9 @@ public DissectProcessorDescriptor IgnoreFailure(bool? ignoreFailure = } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public DissectProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -180,7 +217,9 @@ public DissectProcessorDescriptor IgnoreMissing(bool? ignoreMissing = } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public DissectProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -219,7 +258,9 @@ public DissectProcessorDescriptor OnFailure(params Action - /// The pattern to apply to the field. + /// + /// The pattern to apply to the field. + /// /// public DissectProcessorDescriptor Pattern(string pattern) { @@ -228,7 +269,10 @@ public DissectProcessorDescriptor Pattern(string pattern) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public DissectProcessorDescriptor Tag(string? tag) { @@ -336,7 +380,9 @@ public DissectProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// The character(s) that separate the appended fields. + /// + /// The character(s) that separate the appended fields. + /// /// public DissectProcessorDescriptor AppendSeparator(string? appendSeparator) { @@ -345,7 +391,10 @@ public DissectProcessorDescriptor AppendSeparator(string? appendSeparator) } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public DissectProcessorDescriptor Description(string? description) { @@ -354,7 +403,9 @@ public DissectProcessorDescriptor Description(string? description) } /// - /// The field to dissect. + /// + /// The field to dissect. + /// /// public DissectProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -363,7 +414,9 @@ public DissectProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field fiel } /// - /// The field to dissect. + /// + /// The field to dissect. + /// /// public DissectProcessorDescriptor Field(Expression> field) { @@ -372,7 +425,9 @@ public DissectProcessorDescriptor Field(Expression - /// The field to dissect. + /// + /// The field to dissect. + /// /// public DissectProcessorDescriptor Field(Expression> field) { @@ -381,7 +436,9 @@ public DissectProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public DissectProcessorDescriptor If(string? value) { @@ -390,7 +447,9 @@ public DissectProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public DissectProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -399,7 +458,9 @@ public DissectProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public DissectProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -408,7 +469,9 @@ public DissectProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public DissectProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -447,7 +510,9 @@ public DissectProcessorDescriptor OnFailure(params Action - /// The pattern to apply to the field. + /// + /// The pattern to apply to the field. + /// /// public DissectProcessorDescriptor Pattern(string pattern) { @@ -456,7 +521,10 @@ public DissectProcessorDescriptor Pattern(string pattern) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public DissectProcessorDescriptor Tag(string? tag) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Document.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Document.g.cs index 33ace55d86c..13e443abcda 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Document.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Document.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class Document { /// - /// Unique identifier for the document.
This ID must be unique within the `_index`. + /// + /// Unique identifier for the document. + /// This ID must be unique within the _index. + /// /// [JsonInclude, JsonPropertyName("_id")] public Elastic.Clients.Elasticsearch.Id? Id { get; set; } /// - /// Name of the index containing the document. + /// + /// Name of the index containing the document. + /// /// [JsonInclude, JsonPropertyName("_index")] public Elastic.Clients.Elasticsearch.IndexName? Index { get; set; } /// - /// JSON body for the document. + /// + /// JSON body for the document. + /// /// [JsonInclude, JsonPropertyName("_source")] public object Source { get; set; } @@ -61,7 +68,10 @@ public DocumentDescriptor() : base() private object SourceValue { get; set; } /// - /// Unique identifier for the document.
This ID must be unique within the `_index`. + /// + /// Unique identifier for the document. + /// This ID must be unique within the _index. + /// /// public DocumentDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) { @@ -70,7 +80,9 @@ public DocumentDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) } /// - /// Name of the index containing the document. + /// + /// Name of the index containing the document. + /// /// public DocumentDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? index) { @@ -79,7 +91,9 @@ public DocumentDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? index) } /// - /// JSON body for the document. + /// + /// JSON body for the document. + /// /// public DocumentDescriptor Source(object source) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DocumentSimulation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DocumentSimulation.g.cs index 9ef769a952c..8d048ce6754 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DocumentSimulation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DocumentSimulation.g.cs @@ -104,34 +104,46 @@ public override void Write(Utf8JsonWriter writer, DocumentSimulation value, Json } /// -/// The simulated document, with optional metadata. +/// +/// The simulated document, with optional metadata. +/// /// [JsonConverter(typeof(DocumentSimulationConverter))] public sealed partial class DocumentSimulation { /// - /// Unique identifier for the document. This ID must be unique within the `_index`. + /// + /// Unique identifier for the document. This ID must be unique within the _index. + /// /// public string Id { get; init; } /// - /// Name of the index containing the document. + /// + /// Name of the index containing the document. + /// /// public string Index { get; init; } public Elastic.Clients.Elasticsearch.Ingest.IngestInfo Ingest { get; init; } /// - /// Additional metadata + /// + /// Additional metadata + /// /// public IReadOnlyDictionary Metadata { get; init; } /// - /// Value used to send the document to a specific primary shard. + /// + /// Value used to send the document to a specific primary shard. + /// /// public string? Routing { get; init; } /// - /// JSON body for the document. + /// + /// JSON body for the document. + /// /// public IReadOnlyDictionary Source { get; init; } public long? Version { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DotExpanderProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DotExpanderProcessor.g.cs index 768c22ca0a0..43b03668fd3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DotExpanderProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DotExpanderProcessor.g.cs @@ -30,43 +30,61 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class DotExpanderProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to expand into an object field.
If set to `*`, all top-level fields will be expanded. + /// + /// The field to expand into an object field. + /// If set to *, all top-level fields will be expanded. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// The field that contains the field to expand.
Only required if the field to expand is part another object field, because the `field` option can only understand leaf fields. + /// + /// The field that contains the field to expand. + /// Only required if the field to expand is part another object field, because the field option can only understand leaf fields. + /// /// [JsonInclude, JsonPropertyName("path")] public string? Path { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } @@ -94,7 +112,10 @@ public DotExpanderProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public DotExpanderProcessorDescriptor Description(string? description) { @@ -103,7 +124,10 @@ public DotExpanderProcessorDescriptor Description(string? description } /// - /// The field to expand into an object field.
If set to `*`, all top-level fields will be expanded. + /// + /// The field to expand into an object field. + /// If set to *, all top-level fields will be expanded. + /// /// public DotExpanderProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -112,7 +136,10 @@ public DotExpanderProcessorDescriptor Field(Elastic.Clients.Elasticse } /// - /// The field to expand into an object field.
If set to `*`, all top-level fields will be expanded. + /// + /// The field to expand into an object field. + /// If set to *, all top-level fields will be expanded. + /// /// public DotExpanderProcessorDescriptor Field(Expression> field) { @@ -121,7 +148,10 @@ public DotExpanderProcessorDescriptor Field(Expression - /// The field to expand into an object field.
If set to `*`, all top-level fields will be expanded. + /// + /// The field to expand into an object field. + /// If set to *, all top-level fields will be expanded. + /// /// public DotExpanderProcessorDescriptor Field(Expression> field) { @@ -130,7 +160,9 @@ public DotExpanderProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public DotExpanderProcessorDescriptor If(string? value) { @@ -139,7 +171,9 @@ public DotExpanderProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public DotExpanderProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -148,7 +182,9 @@ public DotExpanderProcessorDescriptor IgnoreFailure(bool? ignoreFailu } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public DotExpanderProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -187,7 +223,10 @@ public DotExpanderProcessorDescriptor OnFailure(params Action - /// The field that contains the field to expand.
Only required if the field to expand is part another object field, because the `field` option can only understand leaf fields. + /// + /// The field that contains the field to expand. + /// Only required if the field to expand is part another object field, because the field option can only understand leaf fields. + /// /// public DotExpanderProcessorDescriptor Path(string? path) { @@ -196,7 +235,10 @@ public DotExpanderProcessorDescriptor Path(string? path) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public DotExpanderProcessorDescriptor Tag(string? tag) { @@ -294,7 +336,10 @@ public DotExpanderProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public DotExpanderProcessorDescriptor Description(string? description) { @@ -303,7 +348,10 @@ public DotExpanderProcessorDescriptor Description(string? description) } /// - /// The field to expand into an object field.
If set to `*`, all top-level fields will be expanded. + /// + /// The field to expand into an object field. + /// If set to *, all top-level fields will be expanded. + /// /// public DotExpanderProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -312,7 +360,10 @@ public DotExpanderProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field } /// - /// The field to expand into an object field.
If set to `*`, all top-level fields will be expanded. + /// + /// The field to expand into an object field. + /// If set to *, all top-level fields will be expanded. + /// /// public DotExpanderProcessorDescriptor Field(Expression> field) { @@ -321,7 +372,10 @@ public DotExpanderProcessorDescriptor Field(Expression - /// The field to expand into an object field.
If set to `*`, all top-level fields will be expanded. + /// + /// The field to expand into an object field. + /// If set to *, all top-level fields will be expanded. + /// /// public DotExpanderProcessorDescriptor Field(Expression> field) { @@ -330,7 +384,9 @@ public DotExpanderProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public DotExpanderProcessorDescriptor If(string? value) { @@ -339,7 +395,9 @@ public DotExpanderProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public DotExpanderProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -348,7 +406,9 @@ public DotExpanderProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public DotExpanderProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -387,7 +447,10 @@ public DotExpanderProcessorDescriptor OnFailure(params Action - /// The field that contains the field to expand.
Only required if the field to expand is part another object field, because the `field` option can only understand leaf fields. + /// + /// The field that contains the field to expand. + /// Only required if the field to expand is part another object field, because the field option can only understand leaf fields. + /// /// public DotExpanderProcessorDescriptor Path(string? path) { @@ -396,7 +459,10 @@ public DotExpanderProcessorDescriptor Path(string? path) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public DotExpanderProcessorDescriptor Tag(string? tag) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DropProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DropProcessor.g.cs index 7d226a61a92..9dc80e64627 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DropProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DropProcessor.g.cs @@ -30,31 +30,43 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class DropProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } @@ -80,7 +92,10 @@ public DropProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public DropProcessorDescriptor Description(string? description) { @@ -89,7 +104,9 @@ public DropProcessorDescriptor Description(string? description) } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public DropProcessorDescriptor If(string? value) { @@ -98,7 +115,9 @@ public DropProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public DropProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -107,7 +126,9 @@ public DropProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tr } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public DropProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -146,7 +167,10 @@ public DropProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public DropProcessorDescriptor Tag(string? tag) { @@ -234,7 +258,10 @@ public DropProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public DropProcessorDescriptor Description(string? description) { @@ -243,7 +270,9 @@ public DropProcessorDescriptor Description(string? description) } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public DropProcessorDescriptor If(string? value) { @@ -252,7 +281,9 @@ public DropProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public DropProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -261,7 +292,9 @@ public DropProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public DropProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -300,7 +333,10 @@ public DropProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public DropProcessorDescriptor Tag(string? tag) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/EnrichProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/EnrichProcessor.g.cs index 0f99bc18368..36af3be5431 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/EnrichProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/EnrichProcessor.g.cs @@ -30,73 +30,105 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class EnrichProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field in the input document that matches the policies match_field used to retrieve the enrichment data.
Supports template snippets. + /// + /// The field in the input document that matches the policies match_field used to retrieve the enrichment data. + /// Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// The maximum number of matched documents to include under the configured target field.
The `target_field` will be turned into a json array if `max_matches` is higher than 1, otherwise `target_field` will become a json object.
In order to avoid documents getting too large, the maximum allowed value is 128. + /// + /// The maximum number of matched documents to include under the configured target field. + /// The target_field will be turned into a json array if max_matches is higher than 1, otherwise target_field will become a json object. + /// In order to avoid documents getting too large, the maximum allowed value is 128. + /// /// [JsonInclude, JsonPropertyName("max_matches")] public int? MaxMatches { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// If processor will update fields with pre-existing non-null-valued field.
When set to `false`, such fields will not be touched. + /// + /// If processor will update fields with pre-existing non-null-valued field. + /// When set to false, such fields will not be touched. + /// /// [JsonInclude, JsonPropertyName("override")] public bool? Override { get; set; } /// - /// The name of the enrich policy to use. + /// + /// The name of the enrich policy to use. + /// /// [JsonInclude, JsonPropertyName("policy_name")] public string PolicyName { get; set; } /// - /// A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index.
This option is only used for `geo_match` enrich policy types. + /// + /// A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index. + /// This option is only used for geo_match enrich policy types. + /// /// [JsonInclude, JsonPropertyName("shape_relation")] public Elastic.Clients.Elasticsearch.GeoShapeRelation? ShapeRelation { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// Field added to incoming documents to contain enrich data. This field contains both the `match_field` and `enrich_fields` specified in the enrich policy.
Supports template snippets. + /// + /// Field added to incoming documents to contain enrich data. This field contains both the match_field and enrich_fields specified in the enrich policy. + /// Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field TargetField { get; set; } @@ -129,7 +161,10 @@ public EnrichProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public EnrichProcessorDescriptor Description(string? description) { @@ -138,7 +173,10 @@ public EnrichProcessorDescriptor Description(string? description) } /// - /// The field in the input document that matches the policies match_field used to retrieve the enrichment data.
Supports template snippets. + /// + /// The field in the input document that matches the policies match_field used to retrieve the enrichment data. + /// Supports template snippets. + /// /// public EnrichProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -147,7 +185,10 @@ public EnrichProcessorDescriptor Field(Elastic.Clients.Elasticsearch. } /// - /// The field in the input document that matches the policies match_field used to retrieve the enrichment data.
Supports template snippets. + /// + /// The field in the input document that matches the policies match_field used to retrieve the enrichment data. + /// Supports template snippets. + /// /// public EnrichProcessorDescriptor Field(Expression> field) { @@ -156,7 +197,10 @@ public EnrichProcessorDescriptor Field(Expression - /// The field in the input document that matches the policies match_field used to retrieve the enrichment data.
Supports template snippets. + /// + /// The field in the input document that matches the policies match_field used to retrieve the enrichment data. + /// Supports template snippets. + /// /// public EnrichProcessorDescriptor Field(Expression> field) { @@ -165,7 +209,9 @@ public EnrichProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public EnrichProcessorDescriptor If(string? value) { @@ -174,7 +220,9 @@ public EnrichProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public EnrichProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -183,7 +231,9 @@ public EnrichProcessorDescriptor IgnoreFailure(bool? ignoreFailure = } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public EnrichProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -192,7 +242,11 @@ public EnrichProcessorDescriptor IgnoreMissing(bool? ignoreMissing = } /// - /// The maximum number of matched documents to include under the configured target field.
The `target_field` will be turned into a json array if `max_matches` is higher than 1, otherwise `target_field` will become a json object.
In order to avoid documents getting too large, the maximum allowed value is 128. + /// + /// The maximum number of matched documents to include under the configured target field. + /// The target_field will be turned into a json array if max_matches is higher than 1, otherwise target_field will become a json object. + /// In order to avoid documents getting too large, the maximum allowed value is 128. + /// /// public EnrichProcessorDescriptor MaxMatches(int? maxMatches) { @@ -201,7 +255,9 @@ public EnrichProcessorDescriptor MaxMatches(int? maxMatches) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public EnrichProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -240,7 +296,10 @@ public EnrichProcessorDescriptor OnFailure(params Action - /// If processor will update fields with pre-existing non-null-valued field.
When set to `false`, such fields will not be touched. + /// + /// If processor will update fields with pre-existing non-null-valued field. + /// When set to false, such fields will not be touched. + /// /// public EnrichProcessorDescriptor Override(bool? value = true) { @@ -249,7 +308,9 @@ public EnrichProcessorDescriptor Override(bool? value = true) } /// - /// The name of the enrich policy to use. + /// + /// The name of the enrich policy to use. + /// /// public EnrichProcessorDescriptor PolicyName(string policyName) { @@ -258,7 +319,10 @@ public EnrichProcessorDescriptor PolicyName(string policyName) } /// - /// A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index.
This option is only used for `geo_match` enrich policy types. + /// + /// A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index. + /// This option is only used for geo_match enrich policy types. + /// /// public EnrichProcessorDescriptor ShapeRelation(Elastic.Clients.Elasticsearch.GeoShapeRelation? shapeRelation) { @@ -267,7 +331,10 @@ public EnrichProcessorDescriptor ShapeRelation(Elastic.Clients.Elasti } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public EnrichProcessorDescriptor Tag(string? tag) { @@ -276,7 +343,10 @@ public EnrichProcessorDescriptor Tag(string? tag) } /// - /// Field added to incoming documents to contain enrich data. This field contains both the `match_field` and `enrich_fields` specified in the enrich policy.
Supports template snippets. + /// + /// Field added to incoming documents to contain enrich data. This field contains both the match_field and enrich_fields specified in the enrich policy. + /// Supports template snippets. + /// /// public EnrichProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field targetField) { @@ -285,7 +355,10 @@ public EnrichProcessorDescriptor TargetField(Elastic.Clients.Elastics } /// - /// Field added to incoming documents to contain enrich data. This field contains both the `match_field` and `enrich_fields` specified in the enrich policy.
Supports template snippets. + /// + /// Field added to incoming documents to contain enrich data. This field contains both the match_field and enrich_fields specified in the enrich policy. + /// Supports template snippets. + /// /// public EnrichProcessorDescriptor TargetField(Expression> targetField) { @@ -294,7 +367,10 @@ public EnrichProcessorDescriptor TargetField(Expression - /// Field added to incoming documents to contain enrich data. This field contains both the `match_field` and `enrich_fields` specified in the enrich policy.
Supports template snippets. + /// + /// Field added to incoming documents to contain enrich data. This field contains both the match_field and enrich_fields specified in the enrich policy. + /// Supports template snippets. + /// /// public EnrichProcessorDescriptor TargetField(Expression> targetField) { @@ -419,7 +495,10 @@ public EnrichProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public EnrichProcessorDescriptor Description(string? description) { @@ -428,7 +507,10 @@ public EnrichProcessorDescriptor Description(string? description) } /// - /// The field in the input document that matches the policies match_field used to retrieve the enrichment data.
Supports template snippets. + /// + /// The field in the input document that matches the policies match_field used to retrieve the enrichment data. + /// Supports template snippets. + /// /// public EnrichProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -437,7 +519,10 @@ public EnrichProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field } /// - /// The field in the input document that matches the policies match_field used to retrieve the enrichment data.
Supports template snippets. + /// + /// The field in the input document that matches the policies match_field used to retrieve the enrichment data. + /// Supports template snippets. + /// /// public EnrichProcessorDescriptor Field(Expression> field) { @@ -446,7 +531,10 @@ public EnrichProcessorDescriptor Field(Expression - /// The field in the input document that matches the policies match_field used to retrieve the enrichment data.
Supports template snippets. + /// + /// The field in the input document that matches the policies match_field used to retrieve the enrichment data. + /// Supports template snippets. + /// /// public EnrichProcessorDescriptor Field(Expression> field) { @@ -455,7 +543,9 @@ public EnrichProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public EnrichProcessorDescriptor If(string? value) { @@ -464,7 +554,9 @@ public EnrichProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public EnrichProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -473,7 +565,9 @@ public EnrichProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public EnrichProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -482,7 +576,11 @@ public EnrichProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// The maximum number of matched documents to include under the configured target field.
The `target_field` will be turned into a json array if `max_matches` is higher than 1, otherwise `target_field` will become a json object.
In order to avoid documents getting too large, the maximum allowed value is 128. + /// + /// The maximum number of matched documents to include under the configured target field. + /// The target_field will be turned into a json array if max_matches is higher than 1, otherwise target_field will become a json object. + /// In order to avoid documents getting too large, the maximum allowed value is 128. + /// /// public EnrichProcessorDescriptor MaxMatches(int? maxMatches) { @@ -491,7 +589,9 @@ public EnrichProcessorDescriptor MaxMatches(int? maxMatches) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public EnrichProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -530,7 +630,10 @@ public EnrichProcessorDescriptor OnFailure(params Action - /// If processor will update fields with pre-existing non-null-valued field.
When set to `false`, such fields will not be touched. + /// + /// If processor will update fields with pre-existing non-null-valued field. + /// When set to false, such fields will not be touched. + /// /// public EnrichProcessorDescriptor Override(bool? value = true) { @@ -539,7 +642,9 @@ public EnrichProcessorDescriptor Override(bool? value = true) } /// - /// The name of the enrich policy to use. + /// + /// The name of the enrich policy to use. + /// /// public EnrichProcessorDescriptor PolicyName(string policyName) { @@ -548,7 +653,10 @@ public EnrichProcessorDescriptor PolicyName(string policyName) } /// - /// A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index.
This option is only used for `geo_match` enrich policy types. + /// + /// A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index. + /// This option is only used for geo_match enrich policy types. + /// /// public EnrichProcessorDescriptor ShapeRelation(Elastic.Clients.Elasticsearch.GeoShapeRelation? shapeRelation) { @@ -557,7 +665,10 @@ public EnrichProcessorDescriptor ShapeRelation(Elastic.Clients.Elasticsearch.Geo } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public EnrichProcessorDescriptor Tag(string? tag) { @@ -566,7 +677,10 @@ public EnrichProcessorDescriptor Tag(string? tag) } /// - /// Field added to incoming documents to contain enrich data. This field contains both the `match_field` and `enrich_fields` specified in the enrich policy.
Supports template snippets. + /// + /// Field added to incoming documents to contain enrich data. This field contains both the match_field and enrich_fields specified in the enrich policy. + /// Supports template snippets. + /// /// public EnrichProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field targetField) { @@ -575,7 +689,10 @@ public EnrichProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field } /// - /// Field added to incoming documents to contain enrich data. This field contains both the `match_field` and `enrich_fields` specified in the enrich policy.
Supports template snippets. + /// + /// Field added to incoming documents to contain enrich data. This field contains both the match_field and enrich_fields specified in the enrich policy. + /// Supports template snippets. + /// /// public EnrichProcessorDescriptor TargetField(Expression> targetField) { @@ -584,7 +701,10 @@ public EnrichProcessorDescriptor TargetField(Expression - /// Field added to incoming documents to contain enrich data. This field contains both the `match_field` and `enrich_fields` specified in the enrich policy.
Supports template snippets. + /// + /// Field added to incoming documents to contain enrich data. This field contains both the match_field and enrich_fields specified in the enrich policy. + /// Supports template snippets. + /// /// public EnrichProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/FailProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/FailProcessor.g.cs index ccc81d986e1..5f072ad8050 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/FailProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/FailProcessor.g.cs @@ -30,37 +30,52 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class FailProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// The error message thrown by the processor.
Supports template snippets. + /// + /// The error message thrown by the processor. + /// Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("message")] public string Message { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } @@ -87,7 +102,10 @@ public FailProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public FailProcessorDescriptor Description(string? description) { @@ -96,7 +114,9 @@ public FailProcessorDescriptor Description(string? description) } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public FailProcessorDescriptor If(string? value) { @@ -105,7 +125,9 @@ public FailProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public FailProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -114,7 +136,10 @@ public FailProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tr } /// - /// The error message thrown by the processor.
Supports template snippets. + /// + /// The error message thrown by the processor. + /// Supports template snippets. + /// /// public FailProcessorDescriptor Message(string message) { @@ -123,7 +148,9 @@ public FailProcessorDescriptor Message(string message) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public FailProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -162,7 +189,10 @@ public FailProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public FailProcessorDescriptor Tag(string? tag) { @@ -253,7 +283,10 @@ public FailProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public FailProcessorDescriptor Description(string? description) { @@ -262,7 +295,9 @@ public FailProcessorDescriptor Description(string? description) } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public FailProcessorDescriptor If(string? value) { @@ -271,7 +306,9 @@ public FailProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public FailProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -280,7 +317,10 @@ public FailProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// The error message thrown by the processor.
Supports template snippets. + /// + /// The error message thrown by the processor. + /// Supports template snippets. + /// /// public FailProcessorDescriptor Message(string message) { @@ -289,7 +329,9 @@ public FailProcessorDescriptor Message(string message) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public FailProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -328,7 +370,10 @@ public FailProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public FailProcessorDescriptor Tag(string? tag) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/ForeachProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/ForeachProcessor.g.cs index 0693cacbf48..eed79aa6e2c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/ForeachProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/ForeachProcessor.g.cs @@ -30,49 +30,67 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class ForeachProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// Field containing array or object values. + /// + /// Field containing array or object values. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true`, the processor silently exits without changing the document if the `field` is `null` or missing. + /// + /// If true, the processor silently exits without changing the document if the field is null or missing. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Ingest processor to run on each element. + /// + /// Ingest processor to run on each element. + /// /// [JsonInclude, JsonPropertyName("processor")] public Elastic.Clients.Elasticsearch.Ingest.Processor Processor { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } @@ -103,7 +121,10 @@ public ForeachProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public ForeachProcessorDescriptor Description(string? description) { @@ -112,7 +133,9 @@ public ForeachProcessorDescriptor Description(string? description) } /// - /// Field containing array or object values. + /// + /// Field containing array or object values. + /// /// public ForeachProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -121,7 +144,9 @@ public ForeachProcessorDescriptor Field(Elastic.Clients.Elasticsearch } /// - /// Field containing array or object values. + /// + /// Field containing array or object values. + /// /// public ForeachProcessorDescriptor Field(Expression> field) { @@ -130,7 +155,9 @@ public ForeachProcessorDescriptor Field(Expression - /// Field containing array or object values. + /// + /// Field containing array or object values. + /// /// public ForeachProcessorDescriptor Field(Expression> field) { @@ -139,7 +166,9 @@ public ForeachProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public ForeachProcessorDescriptor If(string? value) { @@ -148,7 +177,9 @@ public ForeachProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public ForeachProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -157,7 +188,9 @@ public ForeachProcessorDescriptor IgnoreFailure(bool? ignoreFailure = } /// - /// If `true`, the processor silently exits without changing the document if the `field` is `null` or missing. + /// + /// If true, the processor silently exits without changing the document if the field is null or missing. + /// /// public ForeachProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -166,7 +199,9 @@ public ForeachProcessorDescriptor IgnoreMissing(bool? ignoreMissing = } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public ForeachProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -205,7 +240,9 @@ public ForeachProcessorDescriptor OnFailure(params Action - /// Ingest processor to run on each element. + /// + /// Ingest processor to run on each element. + /// /// public ForeachProcessorDescriptor Processor(Elastic.Clients.Elasticsearch.Ingest.Processor processor) { @@ -232,7 +269,10 @@ public ForeachProcessorDescriptor Processor(Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public ForeachProcessorDescriptor Tag(string? tag) { @@ -349,7 +389,10 @@ public ForeachProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public ForeachProcessorDescriptor Description(string? description) { @@ -358,7 +401,9 @@ public ForeachProcessorDescriptor Description(string? description) } /// - /// Field containing array or object values. + /// + /// Field containing array or object values. + /// /// public ForeachProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -367,7 +412,9 @@ public ForeachProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field fiel } /// - /// Field containing array or object values. + /// + /// Field containing array or object values. + /// /// public ForeachProcessorDescriptor Field(Expression> field) { @@ -376,7 +423,9 @@ public ForeachProcessorDescriptor Field(Expression - /// Field containing array or object values. + /// + /// Field containing array or object values. + /// /// public ForeachProcessorDescriptor Field(Expression> field) { @@ -385,7 +434,9 @@ public ForeachProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public ForeachProcessorDescriptor If(string? value) { @@ -394,7 +445,9 @@ public ForeachProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public ForeachProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -403,7 +456,9 @@ public ForeachProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true`, the processor silently exits without changing the document if the `field` is `null` or missing. + /// + /// If true, the processor silently exits without changing the document if the field is null or missing. + /// /// public ForeachProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -412,7 +467,9 @@ public ForeachProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public ForeachProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -451,7 +508,9 @@ public ForeachProcessorDescriptor OnFailure(params Action - /// Ingest processor to run on each element. + /// + /// Ingest processor to run on each element. + /// /// public ForeachProcessorDescriptor Processor(Elastic.Clients.Elasticsearch.Ingest.Processor processor) { @@ -478,7 +537,10 @@ public ForeachProcessorDescriptor Processor(Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public ForeachProcessorDescriptor Tag(string? tag) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GeoIpDownloadStatistics.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GeoIpDownloadStatistics.g.cs index fe08271caa8..971f5f2353e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GeoIpDownloadStatistics.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GeoIpDownloadStatistics.g.cs @@ -30,31 +30,41 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class GeoIpDownloadStatistics { /// - /// Current number of databases available for use. + /// + /// Current number of databases available for use. + /// /// [JsonInclude, JsonPropertyName("database_count")] public int DatabaseCount { get; init; } /// - /// Total number of failed database downloads. + /// + /// Total number of failed database downloads. + /// /// [JsonInclude, JsonPropertyName("failed_downloads")] public int FailedDownloads { get; init; } /// - /// Total number of database updates skipped. + /// + /// Total number of database updates skipped. + /// /// [JsonInclude, JsonPropertyName("skipped_updates")] public int SkippedUpdates { get; init; } /// - /// Total number of successful database downloads. + /// + /// Total number of successful database downloads. + /// /// [JsonInclude, JsonPropertyName("successful_downloads")] public int SuccessfulDownloads { get; init; } /// - /// Total milliseconds spent downloading databases. + /// + /// Total milliseconds spent downloading databases. + /// /// [JsonInclude, JsonPropertyName("total_download_time")] public long TotalDownloadTime { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GeoIpNodeDatabaseName.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GeoIpNodeDatabaseName.g.cs index 58308819128..d634d346834 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GeoIpNodeDatabaseName.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GeoIpNodeDatabaseName.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class GeoIpNodeDatabaseName { /// - /// Name of the database. + /// + /// Name of the database. + /// /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GeoIpNodeDatabases.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GeoIpNodeDatabases.g.cs index cab399570d9..2624f7e5f33 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GeoIpNodeDatabases.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GeoIpNodeDatabases.g.cs @@ -28,18 +28,24 @@ namespace Elastic.Clients.Elasticsearch.Ingest; /// -/// Downloaded databases for the node. The field key is the node ID. +/// +/// Downloaded databases for the node. The field key is the node ID. +/// /// public sealed partial class GeoIpNodeDatabases { /// - /// Downloaded databases for the node. + /// + /// Downloaded databases for the node. + /// /// [JsonInclude, JsonPropertyName("databases")] public IReadOnlyCollection Databases { get; init; } /// - /// Downloaded database files, including related license files. Elasticsearch stores these files in the node’s temporary directory: $ES_TMPDIR/geoip-databases/. + /// + /// Downloaded database files, including related license files. Elasticsearch stores these files in the node’s temporary directory: $ES_TMPDIR/geoip-databases/<node_id>. + /// /// [JsonInclude, JsonPropertyName("files_in_temp")] public IReadOnlyCollection FilesInTemp { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GeoIpProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GeoIpProcessor.g.cs index 80f17e1b727..dcb30a270f1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GeoIpProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GeoIpProcessor.g.cs @@ -30,67 +30,91 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class GeoIpProcessor { /// - /// The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. + /// + /// The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. + /// /// [JsonInclude, JsonPropertyName("database_file")] public string? DatabaseFile { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to get the ip address from for the geographical lookup. + /// + /// The field to get the ip address from for the geographical lookup. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// If `true`, only the first found geoip data will be returned, even if the field contains an array. + /// + /// If true, only the first found geoip data will be returned, even if the field contains an array. + /// /// [JsonInclude, JsonPropertyName("first_only")] public bool? FirstOnly { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Controls what properties are added to the `target_field` based on the geoip lookup. + /// + /// Controls what properties are added to the target_field based on the geoip lookup. + /// /// [JsonInclude, JsonPropertyName("properties")] public ICollection? Properties { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field that will hold the geographical information looked up from the MaxMind database. + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } @@ -122,7 +146,9 @@ public GeoIpProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } /// - /// The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. + /// + /// The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. + /// /// public GeoIpProcessorDescriptor DatabaseFile(string? databaseFile) { @@ -131,7 +157,10 @@ public GeoIpProcessorDescriptor DatabaseFile(string? databaseFile) } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public GeoIpProcessorDescriptor Description(string? description) { @@ -140,7 +169,9 @@ public GeoIpProcessorDescriptor Description(string? description) } /// - /// The field to get the ip address from for the geographical lookup. + /// + /// The field to get the ip address from for the geographical lookup. + /// /// public GeoIpProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -149,7 +180,9 @@ public GeoIpProcessorDescriptor Field(Elastic.Clients.Elasticsearch.F } /// - /// The field to get the ip address from for the geographical lookup. + /// + /// The field to get the ip address from for the geographical lookup. + /// /// public GeoIpProcessorDescriptor Field(Expression> field) { @@ -158,7 +191,9 @@ public GeoIpProcessorDescriptor Field(Expression - /// The field to get the ip address from for the geographical lookup. + /// + /// The field to get the ip address from for the geographical lookup. + /// /// public GeoIpProcessorDescriptor Field(Expression> field) { @@ -167,7 +202,9 @@ public GeoIpProcessorDescriptor Field(Expression - /// If `true`, only the first found geoip data will be returned, even if the field contains an array. + /// + /// If true, only the first found geoip data will be returned, even if the field contains an array. + /// /// public GeoIpProcessorDescriptor FirstOnly(bool? firstOnly = true) { @@ -176,7 +213,9 @@ public GeoIpProcessorDescriptor FirstOnly(bool? firstOnly = true) } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public GeoIpProcessorDescriptor If(string? value) { @@ -185,7 +224,9 @@ public GeoIpProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public GeoIpProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -194,7 +235,9 @@ public GeoIpProcessorDescriptor IgnoreFailure(bool? ignoreFailure = t } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public GeoIpProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -203,7 +246,9 @@ public GeoIpProcessorDescriptor IgnoreMissing(bool? ignoreMissing = t } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public GeoIpProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -242,7 +287,9 @@ public GeoIpProcessorDescriptor OnFailure(params Action - /// Controls what properties are added to the `target_field` based on the geoip lookup. + /// + /// Controls what properties are added to the target_field based on the geoip lookup. + /// /// public GeoIpProcessorDescriptor Properties(ICollection? properties) { @@ -251,7 +298,10 @@ public GeoIpProcessorDescriptor Properties(ICollection? prope } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public GeoIpProcessorDescriptor Tag(string? tag) { @@ -260,7 +310,9 @@ public GeoIpProcessorDescriptor Tag(string? tag) } /// - /// The field that will hold the geographical information looked up from the MaxMind database. + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// /// public GeoIpProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -269,7 +321,9 @@ public GeoIpProcessorDescriptor TargetField(Elastic.Clients.Elasticse } /// - /// The field that will hold the geographical information looked up from the MaxMind database. + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// /// public GeoIpProcessorDescriptor TargetField(Expression> targetField) { @@ -278,7 +332,9 @@ public GeoIpProcessorDescriptor TargetField(Expression - /// The field that will hold the geographical information looked up from the MaxMind database. + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// /// public GeoIpProcessorDescriptor TargetField(Expression> targetField) { @@ -404,7 +460,9 @@ public GeoIpProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } /// - /// The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. + /// + /// The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. + /// /// public GeoIpProcessorDescriptor DatabaseFile(string? databaseFile) { @@ -413,7 +471,10 @@ public GeoIpProcessorDescriptor DatabaseFile(string? databaseFile) } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public GeoIpProcessorDescriptor Description(string? description) { @@ -422,7 +483,9 @@ public GeoIpProcessorDescriptor Description(string? description) } /// - /// The field to get the ip address from for the geographical lookup. + /// + /// The field to get the ip address from for the geographical lookup. + /// /// public GeoIpProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -431,7 +494,9 @@ public GeoIpProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) } /// - /// The field to get the ip address from for the geographical lookup. + /// + /// The field to get the ip address from for the geographical lookup. + /// /// public GeoIpProcessorDescriptor Field(Expression> field) { @@ -440,7 +505,9 @@ public GeoIpProcessorDescriptor Field(Expression - /// The field to get the ip address from for the geographical lookup. + /// + /// The field to get the ip address from for the geographical lookup. + /// /// public GeoIpProcessorDescriptor Field(Expression> field) { @@ -449,7 +516,9 @@ public GeoIpProcessorDescriptor Field(Expression - /// If `true`, only the first found geoip data will be returned, even if the field contains an array. + /// + /// If true, only the first found geoip data will be returned, even if the field contains an array. + /// /// public GeoIpProcessorDescriptor FirstOnly(bool? firstOnly = true) { @@ -458,7 +527,9 @@ public GeoIpProcessorDescriptor FirstOnly(bool? firstOnly = true) } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public GeoIpProcessorDescriptor If(string? value) { @@ -467,7 +538,9 @@ public GeoIpProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public GeoIpProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -476,7 +549,9 @@ public GeoIpProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public GeoIpProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -485,7 +560,9 @@ public GeoIpProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public GeoIpProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -524,7 +601,9 @@ public GeoIpProcessorDescriptor OnFailure(params Action - /// Controls what properties are added to the `target_field` based on the geoip lookup. + /// + /// Controls what properties are added to the target_field based on the geoip lookup. + /// /// public GeoIpProcessorDescriptor Properties(ICollection? properties) { @@ -533,7 +612,10 @@ public GeoIpProcessorDescriptor Properties(ICollection? properties) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public GeoIpProcessorDescriptor Tag(string? tag) { @@ -542,7 +624,9 @@ public GeoIpProcessorDescriptor Tag(string? tag) } /// - /// The field that will hold the geographical information looked up from the MaxMind database. + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// /// public GeoIpProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -551,7 +635,9 @@ public GeoIpProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? } /// - /// The field that will hold the geographical information looked up from the MaxMind database. + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// /// public GeoIpProcessorDescriptor TargetField(Expression> targetField) { @@ -560,7 +646,9 @@ public GeoIpProcessorDescriptor TargetField(Expression - /// The field that will hold the geographical information looked up from the MaxMind database. + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// /// public GeoIpProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GrokProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GrokProcessor.g.cs index 4418f7c5b65..07e9afcca33 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GrokProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GrokProcessor.g.cs @@ -30,61 +30,85 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class GrokProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to use for grok expression parsing. + /// + /// The field to use for grok expression parsing. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor.
Patterns matching existing names will override the pre-existing definition. + /// + /// A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor. + /// Patterns matching existing names will override the pre-existing definition. + /// /// [JsonInclude, JsonPropertyName("pattern_definitions")] public IDictionary? PatternDefinitions { get; set; } /// - /// An ordered list of grok expression to match and extract named captures with.
Returns on the first expression in the list that matches. + /// + /// An ordered list of grok expression to match and extract named captures with. + /// Returns on the first expression in the list that matches. + /// /// [JsonInclude, JsonPropertyName("patterns")] public ICollection Patterns { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// When `true`, `_ingest._grok_match_index` will be inserted into your matched document’s metadata with the index into the pattern found in `patterns` that matched. + /// + /// When true, _ingest._grok_match_index will be inserted into your matched document’s metadata with the index into the pattern found in patterns that matched. + /// /// [JsonInclude, JsonPropertyName("trace_match")] public bool? TraceMatch { get; set; } @@ -115,7 +139,10 @@ public GrokProcessorDescriptor() : base() private bool? TraceMatchValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public GrokProcessorDescriptor Description(string? description) { @@ -124,7 +151,9 @@ public GrokProcessorDescriptor Description(string? description) } /// - /// The field to use for grok expression parsing. + /// + /// The field to use for grok expression parsing. + /// /// public GrokProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -133,7 +162,9 @@ public GrokProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Fi } /// - /// The field to use for grok expression parsing. + /// + /// The field to use for grok expression parsing. + /// /// public GrokProcessorDescriptor Field(Expression> field) { @@ -142,7 +173,9 @@ public GrokProcessorDescriptor Field(Expression - /// The field to use for grok expression parsing. + /// + /// The field to use for grok expression parsing. + /// /// public GrokProcessorDescriptor Field(Expression> field) { @@ -151,7 +184,9 @@ public GrokProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public GrokProcessorDescriptor If(string? value) { @@ -160,7 +195,9 @@ public GrokProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public GrokProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -169,7 +206,9 @@ public GrokProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tr } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public GrokProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -178,7 +217,9 @@ public GrokProcessorDescriptor IgnoreMissing(bool? ignoreMissing = tr } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public GrokProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -217,7 +258,10 @@ public GrokProcessorDescriptor OnFailure(params Action - /// A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor.
Patterns matching existing names will override the pre-existing definition. + /// + /// A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor. + /// Patterns matching existing names will override the pre-existing definition. + /// /// public GrokProcessorDescriptor PatternDefinitions(Func, FluentDictionary> selector) { @@ -226,7 +270,10 @@ public GrokProcessorDescriptor PatternDefinitions(Func - /// An ordered list of grok expression to match and extract named captures with.
Returns on the first expression in the list that matches. + /// + /// An ordered list of grok expression to match and extract named captures with. + /// Returns on the first expression in the list that matches. + /// /// public GrokProcessorDescriptor Patterns(ICollection patterns) { @@ -235,7 +282,10 @@ public GrokProcessorDescriptor Patterns(ICollection patterns) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public GrokProcessorDescriptor Tag(string? tag) { @@ -244,7 +294,9 @@ public GrokProcessorDescriptor Tag(string? tag) } /// - /// When `true`, `_ingest._grok_match_index` will be inserted into your matched document’s metadata with the index into the pattern found in `patterns` that matched. + /// + /// When true, _ingest._grok_match_index will be inserted into your matched document’s metadata with the index into the pattern found in patterns that matched. + /// /// public GrokProcessorDescriptor TraceMatch(bool? traceMatch = true) { @@ -359,7 +411,10 @@ public GrokProcessorDescriptor() : base() private bool? TraceMatchValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public GrokProcessorDescriptor Description(string? description) { @@ -368,7 +423,9 @@ public GrokProcessorDescriptor Description(string? description) } /// - /// The field to use for grok expression parsing. + /// + /// The field to use for grok expression parsing. + /// /// public GrokProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -377,7 +434,9 @@ public GrokProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) } /// - /// The field to use for grok expression parsing. + /// + /// The field to use for grok expression parsing. + /// /// public GrokProcessorDescriptor Field(Expression> field) { @@ -386,7 +445,9 @@ public GrokProcessorDescriptor Field(Expression - /// The field to use for grok expression parsing. + /// + /// The field to use for grok expression parsing. + /// /// public GrokProcessorDescriptor Field(Expression> field) { @@ -395,7 +456,9 @@ public GrokProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public GrokProcessorDescriptor If(string? value) { @@ -404,7 +467,9 @@ public GrokProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public GrokProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -413,7 +478,9 @@ public GrokProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public GrokProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -422,7 +489,9 @@ public GrokProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public GrokProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -461,7 +530,10 @@ public GrokProcessorDescriptor OnFailure(params Action - /// A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor.
Patterns matching existing names will override the pre-existing definition. + /// + /// A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor. + /// Patterns matching existing names will override the pre-existing definition. + /// /// public GrokProcessorDescriptor PatternDefinitions(Func, FluentDictionary> selector) { @@ -470,7 +542,10 @@ public GrokProcessorDescriptor PatternDefinitions(Func - /// An ordered list of grok expression to match and extract named captures with.
Returns on the first expression in the list that matches. + /// + /// An ordered list of grok expression to match and extract named captures with. + /// Returns on the first expression in the list that matches. + /// /// public GrokProcessorDescriptor Patterns(ICollection patterns) { @@ -479,7 +554,10 @@ public GrokProcessorDescriptor Patterns(ICollection patterns) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public GrokProcessorDescriptor Tag(string? tag) { @@ -488,7 +566,9 @@ public GrokProcessorDescriptor Tag(string? tag) } /// - /// When `true`, `_ingest._grok_match_index` will be inserted into your matched document’s metadata with the index into the pattern found in `patterns` that matched. + /// + /// When true, _ingest._grok_match_index will be inserted into your matched document’s metadata with the index into the pattern found in patterns that matched. + /// /// public GrokProcessorDescriptor TraceMatch(bool? traceMatch = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GsubProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GsubProcessor.g.cs index 30bf4eb067c..a20854d181a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GsubProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GsubProcessor.g.cs @@ -30,61 +30,84 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class GsubProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to apply the replacement to. + /// + /// The field to apply the replacement to. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// The pattern to be replaced. + /// + /// The pattern to be replaced. + /// /// [JsonInclude, JsonPropertyName("pattern")] public string Pattern { get; set; } /// - /// The string to replace the matching patterns with. + /// + /// The string to replace the matching patterns with. + /// /// [JsonInclude, JsonPropertyName("replacement")] public string Replacement { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field to assign the converted value to
By default, the `field` is updated in-place. + /// + /// The field to assign the converted value to + /// By default, the field is updated in-place. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } @@ -115,7 +138,10 @@ public GsubProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public GsubProcessorDescriptor Description(string? description) { @@ -124,7 +150,9 @@ public GsubProcessorDescriptor Description(string? description) } /// - /// The field to apply the replacement to. + /// + /// The field to apply the replacement to. + /// /// public GsubProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -133,7 +161,9 @@ public GsubProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Fi } /// - /// The field to apply the replacement to. + /// + /// The field to apply the replacement to. + /// /// public GsubProcessorDescriptor Field(Expression> field) { @@ -142,7 +172,9 @@ public GsubProcessorDescriptor Field(Expression - /// The field to apply the replacement to. + /// + /// The field to apply the replacement to. + /// /// public GsubProcessorDescriptor Field(Expression> field) { @@ -151,7 +183,9 @@ public GsubProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public GsubProcessorDescriptor If(string? value) { @@ -160,7 +194,9 @@ public GsubProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public GsubProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -169,7 +205,9 @@ public GsubProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tr } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public GsubProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -178,7 +216,9 @@ public GsubProcessorDescriptor IgnoreMissing(bool? ignoreMissing = tr } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public GsubProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -217,7 +257,9 @@ public GsubProcessorDescriptor OnFailure(params Action - /// The pattern to be replaced. + /// + /// The pattern to be replaced. + /// /// public GsubProcessorDescriptor Pattern(string pattern) { @@ -226,7 +268,9 @@ public GsubProcessorDescriptor Pattern(string pattern) } /// - /// The string to replace the matching patterns with. + /// + /// The string to replace the matching patterns with. + /// /// public GsubProcessorDescriptor Replacement(string replacement) { @@ -235,7 +279,10 @@ public GsubProcessorDescriptor Replacement(string replacement) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public GsubProcessorDescriptor Tag(string? tag) { @@ -244,7 +291,10 @@ public GsubProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the converted value to
By default, the `field` is updated in-place. + /// + /// The field to assign the converted value to + /// By default, the field is updated in-place. + /// /// public GsubProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -253,7 +303,10 @@ public GsubProcessorDescriptor TargetField(Elastic.Clients.Elasticsea } /// - /// The field to assign the converted value to
By default, the `field` is updated in-place. + /// + /// The field to assign the converted value to + /// By default, the field is updated in-place. + /// /// public GsubProcessorDescriptor TargetField(Expression> targetField) { @@ -262,7 +315,10 @@ public GsubProcessorDescriptor TargetField(Expression - /// The field to assign the converted value to
By default, the `field` is updated in-place. + /// + /// The field to assign the converted value to + /// By default, the field is updated in-place. + /// /// public GsubProcessorDescriptor TargetField(Expression> targetField) { @@ -373,7 +429,10 @@ public GsubProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public GsubProcessorDescriptor Description(string? description) { @@ -382,7 +441,9 @@ public GsubProcessorDescriptor Description(string? description) } /// - /// The field to apply the replacement to. + /// + /// The field to apply the replacement to. + /// /// public GsubProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -391,7 +452,9 @@ public GsubProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) } /// - /// The field to apply the replacement to. + /// + /// The field to apply the replacement to. + /// /// public GsubProcessorDescriptor Field(Expression> field) { @@ -400,7 +463,9 @@ public GsubProcessorDescriptor Field(Expression - /// The field to apply the replacement to. + /// + /// The field to apply the replacement to. + /// /// public GsubProcessorDescriptor Field(Expression> field) { @@ -409,7 +474,9 @@ public GsubProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public GsubProcessorDescriptor If(string? value) { @@ -418,7 +485,9 @@ public GsubProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public GsubProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -427,7 +496,9 @@ public GsubProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public GsubProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -436,7 +507,9 @@ public GsubProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public GsubProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -475,7 +548,9 @@ public GsubProcessorDescriptor OnFailure(params Action - /// The pattern to be replaced. + /// + /// The pattern to be replaced. + /// /// public GsubProcessorDescriptor Pattern(string pattern) { @@ -484,7 +559,9 @@ public GsubProcessorDescriptor Pattern(string pattern) } /// - /// The string to replace the matching patterns with. + /// + /// The string to replace the matching patterns with. + /// /// public GsubProcessorDescriptor Replacement(string replacement) { @@ -493,7 +570,10 @@ public GsubProcessorDescriptor Replacement(string replacement) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public GsubProcessorDescriptor Tag(string? tag) { @@ -502,7 +582,10 @@ public GsubProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the converted value to
By default, the `field` is updated in-place. + /// + /// The field to assign the converted value to + /// By default, the field is updated in-place. + /// /// public GsubProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -511,7 +594,10 @@ public GsubProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? } /// - /// The field to assign the converted value to
By default, the `field` is updated in-place. + /// + /// The field to assign the converted value to + /// By default, the field is updated in-place. + /// /// public GsubProcessorDescriptor TargetField(Expression> targetField) { @@ -520,7 +606,10 @@ public GsubProcessorDescriptor TargetField(Expression - /// The field to assign the converted value to
By default, the `field` is updated in-place. + /// + /// The field to assign the converted value to + /// By default, the field is updated in-place. + /// /// public GsubProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/InferenceConfigClassification.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/InferenceConfigClassification.g.cs index fd88216ad2d..29e911ac49c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/InferenceConfigClassification.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/InferenceConfigClassification.g.cs @@ -30,31 +30,42 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class InferenceConfigClassification { /// - /// Specifies the number of top class predictions to return. + /// + /// Specifies the number of top class predictions to return. + /// /// [JsonInclude, JsonPropertyName("num_top_classes")] public int? NumTopClasses { get; set; } /// - /// Specifies the maximum number of feature importance values per document. + /// + /// Specifies the maximum number of feature importance values per document. + /// /// [JsonInclude, JsonPropertyName("num_top_feature_importance_values")] public int? NumTopFeatureImportanceValues { get; set; } /// - /// Specifies the type of the predicted field to write.
Valid values are: `string`, `number`, `boolean`. + /// + /// Specifies the type of the predicted field to write. + /// Valid values are: string, number, boolean. + /// /// [JsonInclude, JsonPropertyName("prediction_field_type")] public string? PredictionFieldType { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// /// [JsonInclude, JsonPropertyName("results_field")] public Elastic.Clients.Elasticsearch.Field? ResultsField { get; set; } /// - /// Specifies the field to which the top classes are written. + /// + /// Specifies the field to which the top classes are written. + /// /// [JsonInclude, JsonPropertyName("top_classes_results_field")] public Elastic.Clients.Elasticsearch.Field? TopClassesResultsField { get; set; } @@ -77,7 +88,9 @@ public InferenceConfigClassificationDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TopClassesResultsFieldValue { get; set; } /// - /// Specifies the number of top class predictions to return. + /// + /// Specifies the number of top class predictions to return. + /// /// public InferenceConfigClassificationDescriptor NumTopClasses(int? numTopClasses) { @@ -86,7 +99,9 @@ public InferenceConfigClassificationDescriptor NumTopClasses(int? num } /// - /// Specifies the maximum number of feature importance values per document. + /// + /// Specifies the maximum number of feature importance values per document. + /// /// public InferenceConfigClassificationDescriptor NumTopFeatureImportanceValues(int? numTopFeatureImportanceValues) { @@ -95,7 +110,10 @@ public InferenceConfigClassificationDescriptor NumTopFeatureImportanc } /// - /// Specifies the type of the predicted field to write.
Valid values are: `string`, `number`, `boolean`. + /// + /// Specifies the type of the predicted field to write. + /// Valid values are: string, number, boolean. + /// /// public InferenceConfigClassificationDescriptor PredictionFieldType(string? predictionFieldType) { @@ -104,7 +122,9 @@ public InferenceConfigClassificationDescriptor PredictionFieldType(st } /// - /// The field that is added to incoming documents to contain the inference prediction. + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// /// public InferenceConfigClassificationDescriptor ResultsField(Elastic.Clients.Elasticsearch.Field? resultsField) { @@ -113,7 +133,9 @@ public InferenceConfigClassificationDescriptor ResultsField(Elastic.C } /// - /// The field that is added to incoming documents to contain the inference prediction. + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// /// public InferenceConfigClassificationDescriptor ResultsField(Expression> resultsField) { @@ -122,7 +144,9 @@ public InferenceConfigClassificationDescriptor ResultsField(E } /// - /// The field that is added to incoming documents to contain the inference prediction. + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// /// public InferenceConfigClassificationDescriptor ResultsField(Expression> resultsField) { @@ -131,7 +155,9 @@ public InferenceConfigClassificationDescriptor ResultsField(Expressio } /// - /// Specifies the field to which the top classes are written. + /// + /// Specifies the field to which the top classes are written. + /// /// public InferenceConfigClassificationDescriptor TopClassesResultsField(Elastic.Clients.Elasticsearch.Field? topClassesResultsField) { @@ -140,7 +166,9 @@ public InferenceConfigClassificationDescriptor TopClassesResultsField } /// - /// Specifies the field to which the top classes are written. + /// + /// Specifies the field to which the top classes are written. + /// /// public InferenceConfigClassificationDescriptor TopClassesResultsField(Expression> topClassesResultsField) { @@ -149,7 +177,9 @@ public InferenceConfigClassificationDescriptor TopClassesResultsField } /// - /// Specifies the field to which the top classes are written. + /// + /// Specifies the field to which the top classes are written. + /// /// public InferenceConfigClassificationDescriptor TopClassesResultsField(Expression> topClassesResultsField) { @@ -209,7 +239,9 @@ public InferenceConfigClassificationDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TopClassesResultsFieldValue { get; set; } /// - /// Specifies the number of top class predictions to return. + /// + /// Specifies the number of top class predictions to return. + /// /// public InferenceConfigClassificationDescriptor NumTopClasses(int? numTopClasses) { @@ -218,7 +250,9 @@ public InferenceConfigClassificationDescriptor NumTopClasses(int? numTopClasses) } /// - /// Specifies the maximum number of feature importance values per document. + /// + /// Specifies the maximum number of feature importance values per document. + /// /// public InferenceConfigClassificationDescriptor NumTopFeatureImportanceValues(int? numTopFeatureImportanceValues) { @@ -227,7 +261,10 @@ public InferenceConfigClassificationDescriptor NumTopFeatureImportanceValues(int } /// - /// Specifies the type of the predicted field to write.
Valid values are: `string`, `number`, `boolean`. + /// + /// Specifies the type of the predicted field to write. + /// Valid values are: string, number, boolean. + /// /// public InferenceConfigClassificationDescriptor PredictionFieldType(string? predictionFieldType) { @@ -236,7 +273,9 @@ public InferenceConfigClassificationDescriptor PredictionFieldType(string? predi } /// - /// The field that is added to incoming documents to contain the inference prediction. + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// /// public InferenceConfigClassificationDescriptor ResultsField(Elastic.Clients.Elasticsearch.Field? resultsField) { @@ -245,7 +284,9 @@ public InferenceConfigClassificationDescriptor ResultsField(Elastic.Clients.Elas } /// - /// The field that is added to incoming documents to contain the inference prediction. + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// /// public InferenceConfigClassificationDescriptor ResultsField(Expression> resultsField) { @@ -254,7 +295,9 @@ public InferenceConfigClassificationDescriptor ResultsField(E } /// - /// The field that is added to incoming documents to contain the inference prediction. + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// /// public InferenceConfigClassificationDescriptor ResultsField(Expression> resultsField) { @@ -263,7 +306,9 @@ public InferenceConfigClassificationDescriptor ResultsField(Expressio } /// - /// Specifies the field to which the top classes are written. + /// + /// Specifies the field to which the top classes are written. + /// /// public InferenceConfigClassificationDescriptor TopClassesResultsField(Elastic.Clients.Elasticsearch.Field? topClassesResultsField) { @@ -272,7 +317,9 @@ public InferenceConfigClassificationDescriptor TopClassesResultsField(Elastic.Cl } /// - /// Specifies the field to which the top classes are written. + /// + /// Specifies the field to which the top classes are written. + /// /// public InferenceConfigClassificationDescriptor TopClassesResultsField(Expression> topClassesResultsField) { @@ -281,7 +328,9 @@ public InferenceConfigClassificationDescriptor TopClassesResultsField - /// Specifies the field to which the top classes are written. + /// + /// Specifies the field to which the top classes are written. + /// /// public InferenceConfigClassificationDescriptor TopClassesResultsField(Expression> topClassesResultsField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/InferenceConfigRegression.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/InferenceConfigRegression.g.cs index 1120139ecbb..25fd91b2faa 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/InferenceConfigRegression.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/InferenceConfigRegression.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class InferenceConfigRegression { /// - /// Specifies the maximum number of feature importance values per document. + /// + /// Specifies the maximum number of feature importance values per document. + /// /// [JsonInclude, JsonPropertyName("num_top_feature_importance_values")] public int? NumTopFeatureImportanceValues { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// /// [JsonInclude, JsonPropertyName("results_field")] public Elastic.Clients.Elasticsearch.Field? ResultsField { get; set; } @@ -56,7 +60,9 @@ public InferenceConfigRegressionDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? ResultsFieldValue { get; set; } /// - /// Specifies the maximum number of feature importance values per document. + /// + /// Specifies the maximum number of feature importance values per document. + /// /// public InferenceConfigRegressionDescriptor NumTopFeatureImportanceValues(int? numTopFeatureImportanceValues) { @@ -65,7 +71,9 @@ public InferenceConfigRegressionDescriptor NumTopFeatureImportanceVal } /// - /// The field that is added to incoming documents to contain the inference prediction. + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// /// public InferenceConfigRegressionDescriptor ResultsField(Elastic.Clients.Elasticsearch.Field? resultsField) { @@ -74,7 +82,9 @@ public InferenceConfigRegressionDescriptor ResultsField(Elastic.Clien } /// - /// The field that is added to incoming documents to contain the inference prediction. + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// /// public InferenceConfigRegressionDescriptor ResultsField(Expression> resultsField) { @@ -83,7 +93,9 @@ public InferenceConfigRegressionDescriptor ResultsField(Expre } /// - /// The field that is added to incoming documents to contain the inference prediction. + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// /// public InferenceConfigRegressionDescriptor ResultsField(Expression> resultsField) { @@ -122,7 +134,9 @@ public InferenceConfigRegressionDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? ResultsFieldValue { get; set; } /// - /// Specifies the maximum number of feature importance values per document. + /// + /// Specifies the maximum number of feature importance values per document. + /// /// public InferenceConfigRegressionDescriptor NumTopFeatureImportanceValues(int? numTopFeatureImportanceValues) { @@ -131,7 +145,9 @@ public InferenceConfigRegressionDescriptor NumTopFeatureImportanceValues(int? nu } /// - /// The field that is added to incoming documents to contain the inference prediction. + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// /// public InferenceConfigRegressionDescriptor ResultsField(Elastic.Clients.Elasticsearch.Field? resultsField) { @@ -140,7 +156,9 @@ public InferenceConfigRegressionDescriptor ResultsField(Elastic.Clients.Elastics } /// - /// The field that is added to incoming documents to contain the inference prediction. + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// /// public InferenceConfigRegressionDescriptor ResultsField(Expression> resultsField) { @@ -149,7 +167,9 @@ public InferenceConfigRegressionDescriptor ResultsField(Expre } /// - /// The field that is added to incoming documents to contain the inference prediction. + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// /// public InferenceConfigRegressionDescriptor ResultsField(Expression> resultsField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/InferenceProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/InferenceProcessor.g.cs index 527b4c3120a..66ef214621d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/InferenceProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/InferenceProcessor.g.cs @@ -30,55 +30,76 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class InferenceProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// Maps the document field names to the known field names of the model.
This mapping takes precedence over any default mappings provided in the model configuration. + /// + /// Maps the document field names to the known field names of the model. + /// This mapping takes precedence over any default mappings provided in the model configuration. + /// /// [JsonInclude, JsonPropertyName("field_map")] public IDictionary? FieldMap { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// Contains the inference type and its options. + /// + /// Contains the inference type and its options. + /// /// [JsonInclude, JsonPropertyName("inference_config")] public Elastic.Clients.Elasticsearch.Ingest.InferenceConfig? InferenceConfig { get; set; } /// - /// The ID or alias for the trained model, or the ID of the deployment. + /// + /// The ID or alias for the trained model, or the ID of the deployment. + /// /// [JsonInclude, JsonPropertyName("model_id")] public Elastic.Clients.Elasticsearch.Id ModelId { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// Field added to incoming documents to contain results objects. + /// + /// Field added to incoming documents to contain results objects. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } @@ -110,7 +131,10 @@ public InferenceProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public InferenceProcessorDescriptor Description(string? description) { @@ -119,7 +143,10 @@ public InferenceProcessorDescriptor Description(string? description) } /// - /// Maps the document field names to the known field names of the model.
This mapping takes precedence over any default mappings provided in the model configuration. + /// + /// Maps the document field names to the known field names of the model. + /// This mapping takes precedence over any default mappings provided in the model configuration. + /// /// public InferenceProcessorDescriptor FieldMap(Func, FluentDictionary> selector) { @@ -128,7 +155,9 @@ public InferenceProcessorDescriptor FieldMap(Func - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public InferenceProcessorDescriptor If(string? value) { @@ -137,7 +166,9 @@ public InferenceProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public InferenceProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -146,7 +177,9 @@ public InferenceProcessorDescriptor IgnoreFailure(bool? ignoreFailure } /// - /// Contains the inference type and its options. + /// + /// Contains the inference type and its options. + /// /// public InferenceProcessorDescriptor InferenceConfig(Elastic.Clients.Elasticsearch.Ingest.InferenceConfig? inferenceConfig) { @@ -173,7 +206,9 @@ public InferenceProcessorDescriptor InferenceConfig(Action - /// The ID or alias for the trained model, or the ID of the deployment. + /// + /// The ID or alias for the trained model, or the ID of the deployment. + /// /// public InferenceProcessorDescriptor ModelId(Elastic.Clients.Elasticsearch.Id modelId) { @@ -182,7 +217,9 @@ public InferenceProcessorDescriptor ModelId(Elastic.Clients.Elasticse } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public InferenceProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -221,7 +258,10 @@ public InferenceProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public InferenceProcessorDescriptor Tag(string? tag) { @@ -230,7 +270,9 @@ public InferenceProcessorDescriptor Tag(string? tag) } /// - /// Field added to incoming documents to contain results objects. + /// + /// Field added to incoming documents to contain results objects. + /// /// public InferenceProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -239,7 +281,9 @@ public InferenceProcessorDescriptor TargetField(Elastic.Clients.Elast } /// - /// Field added to incoming documents to contain results objects. + /// + /// Field added to incoming documents to contain results objects. + /// /// public InferenceProcessorDescriptor TargetField(Expression> targetField) { @@ -248,7 +292,9 @@ public InferenceProcessorDescriptor TargetField(Expression - /// Field added to incoming documents to contain results objects. + /// + /// Field added to incoming documents to contain results objects. + /// /// public InferenceProcessorDescriptor TargetField(Expression> targetField) { @@ -372,7 +418,10 @@ public InferenceProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public InferenceProcessorDescriptor Description(string? description) { @@ -381,7 +430,10 @@ public InferenceProcessorDescriptor Description(string? description) } /// - /// Maps the document field names to the known field names of the model.
This mapping takes precedence over any default mappings provided in the model configuration. + /// + /// Maps the document field names to the known field names of the model. + /// This mapping takes precedence over any default mappings provided in the model configuration. + /// /// public InferenceProcessorDescriptor FieldMap(Func, FluentDictionary> selector) { @@ -390,7 +442,9 @@ public InferenceProcessorDescriptor FieldMap(Func - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public InferenceProcessorDescriptor If(string? value) { @@ -399,7 +453,9 @@ public InferenceProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public InferenceProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -408,7 +464,9 @@ public InferenceProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// Contains the inference type and its options. + /// + /// Contains the inference type and its options. + /// /// public InferenceProcessorDescriptor InferenceConfig(Elastic.Clients.Elasticsearch.Ingest.InferenceConfig? inferenceConfig) { @@ -435,7 +493,9 @@ public InferenceProcessorDescriptor InferenceConfig(Action - /// The ID or alias for the trained model, or the ID of the deployment. + /// + /// The ID or alias for the trained model, or the ID of the deployment. + /// /// public InferenceProcessorDescriptor ModelId(Elastic.Clients.Elasticsearch.Id modelId) { @@ -444,7 +504,9 @@ public InferenceProcessorDescriptor ModelId(Elastic.Clients.Elasticsearch.Id mod } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public InferenceProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -483,7 +545,10 @@ public InferenceProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public InferenceProcessorDescriptor Tag(string? tag) { @@ -492,7 +557,9 @@ public InferenceProcessorDescriptor Tag(string? tag) } /// - /// Field added to incoming documents to contain results objects. + /// + /// Field added to incoming documents to contain results objects. + /// /// public InferenceProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -501,7 +568,9 @@ public InferenceProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Fi } /// - /// Field added to incoming documents to contain results objects. + /// + /// Field added to incoming documents to contain results objects. + /// /// public InferenceProcessorDescriptor TargetField(Expression> targetField) { @@ -510,7 +579,9 @@ public InferenceProcessorDescriptor TargetField(Expression - /// Field added to incoming documents to contain results objects. + /// + /// Field added to incoming documents to contain results objects. + /// /// public InferenceProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/JoinProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/JoinProcessor.g.cs index f69fce9de6b..5f0069755fe 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/JoinProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/JoinProcessor.g.cs @@ -30,49 +30,68 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class JoinProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// Field containing array values to join. + /// + /// Field containing array values to join. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// The separator character. + /// + /// The separator character. + /// /// [JsonInclude, JsonPropertyName("separator")] public string Separator { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field to assign the joined value to.
By default, the field is updated in-place. + /// + /// The field to assign the joined value to. + /// By default, the field is updated in-place. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } @@ -101,7 +120,10 @@ public JoinProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public JoinProcessorDescriptor Description(string? description) { @@ -110,7 +132,9 @@ public JoinProcessorDescriptor Description(string? description) } /// - /// Field containing array values to join. + /// + /// Field containing array values to join. + /// /// public JoinProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -119,7 +143,9 @@ public JoinProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Fi } /// - /// Field containing array values to join. + /// + /// Field containing array values to join. + /// /// public JoinProcessorDescriptor Field(Expression> field) { @@ -128,7 +154,9 @@ public JoinProcessorDescriptor Field(Expression - /// Field containing array values to join. + /// + /// Field containing array values to join. + /// /// public JoinProcessorDescriptor Field(Expression> field) { @@ -137,7 +165,9 @@ public JoinProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public JoinProcessorDescriptor If(string? value) { @@ -146,7 +176,9 @@ public JoinProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public JoinProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -155,7 +187,9 @@ public JoinProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tr } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public JoinProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -194,7 +228,9 @@ public JoinProcessorDescriptor OnFailure(params Action - /// The separator character. + /// + /// The separator character. + /// /// public JoinProcessorDescriptor Separator(string separator) { @@ -203,7 +239,10 @@ public JoinProcessorDescriptor Separator(string separator) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public JoinProcessorDescriptor Tag(string? tag) { @@ -212,7 +251,10 @@ public JoinProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the joined value to.
By default, the field is updated in-place. + /// + /// The field to assign the joined value to. + /// By default, the field is updated in-place. + /// /// public JoinProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -221,7 +263,10 @@ public JoinProcessorDescriptor TargetField(Elastic.Clients.Elasticsea } /// - /// The field to assign the joined value to.
By default, the field is updated in-place. + /// + /// The field to assign the joined value to. + /// By default, the field is updated in-place. + /// /// public JoinProcessorDescriptor TargetField(Expression> targetField) { @@ -230,7 +275,10 @@ public JoinProcessorDescriptor TargetField(Expression - /// The field to assign the joined value to.
By default, the field is updated in-place. + /// + /// The field to assign the joined value to. + /// By default, the field is updated in-place. + /// /// public JoinProcessorDescriptor TargetField(Expression> targetField) { @@ -331,7 +379,10 @@ public JoinProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public JoinProcessorDescriptor Description(string? description) { @@ -340,7 +391,9 @@ public JoinProcessorDescriptor Description(string? description) } /// - /// Field containing array values to join. + /// + /// Field containing array values to join. + /// /// public JoinProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -349,7 +402,9 @@ public JoinProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) } /// - /// Field containing array values to join. + /// + /// Field containing array values to join. + /// /// public JoinProcessorDescriptor Field(Expression> field) { @@ -358,7 +413,9 @@ public JoinProcessorDescriptor Field(Expression - /// Field containing array values to join. + /// + /// Field containing array values to join. + /// /// public JoinProcessorDescriptor Field(Expression> field) { @@ -367,7 +424,9 @@ public JoinProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public JoinProcessorDescriptor If(string? value) { @@ -376,7 +435,9 @@ public JoinProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public JoinProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -385,7 +446,9 @@ public JoinProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public JoinProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -424,7 +487,9 @@ public JoinProcessorDescriptor OnFailure(params Action - /// The separator character. + /// + /// The separator character. + /// /// public JoinProcessorDescriptor Separator(string separator) { @@ -433,7 +498,10 @@ public JoinProcessorDescriptor Separator(string separator) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public JoinProcessorDescriptor Tag(string? tag) { @@ -442,7 +510,10 @@ public JoinProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the joined value to.
By default, the field is updated in-place. + /// + /// The field to assign the joined value to. + /// By default, the field is updated in-place. + /// /// public JoinProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -451,7 +522,10 @@ public JoinProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? } /// - /// The field to assign the joined value to.
By default, the field is updated in-place. + /// + /// The field to assign the joined value to. + /// By default, the field is updated in-place. + /// /// public JoinProcessorDescriptor TargetField(Expression> targetField) { @@ -460,7 +534,10 @@ public JoinProcessorDescriptor TargetField(Expression - /// The field to assign the joined value to.
By default, the field is updated in-place. + /// + /// The field to assign the joined value to. + /// By default, the field is updated in-place. + /// /// public JoinProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/JsonProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/JsonProcessor.g.cs index b965598dc84..5193ee0ff15 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/JsonProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/JsonProcessor.g.cs @@ -30,61 +30,88 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class JsonProcessor { /// - /// Flag that forces the parsed JSON to be added at the top level of the document.
`target_field` must not be set when this option is chosen. + /// + /// Flag that forces the parsed JSON to be added at the top level of the document. + /// target_field must not be set when this option is chosen. + /// /// [JsonInclude, JsonPropertyName("add_to_root")] public bool? AddToRoot { get; set; } /// - /// When set to `replace`, root fields that conflict with fields from the parsed JSON will be overridden.
When set to `merge`, conflicting fields will be merged.
Only applicable `if add_to_root` is set to true. + /// + /// When set to replace, root fields that conflict with fields from the parsed JSON will be overridden. + /// When set to merge, conflicting fields will be merged. + /// Only applicable if add_to_root is set to true. + /// /// [JsonInclude, JsonPropertyName("add_to_root_conflict_strategy")] public Elastic.Clients.Elasticsearch.Ingest.JsonProcessorConflictStrategy? AddToRootConflictStrategy { get; set; } /// - /// When set to `true`, the JSON parser will not fail if the JSON contains duplicate keys.
Instead, the last encountered value for any duplicate key wins. + /// + /// When set to true, the JSON parser will not fail if the JSON contains duplicate keys. + /// Instead, the last encountered value for any duplicate key wins. + /// /// [JsonInclude, JsonPropertyName("allow_duplicate_keys")] public bool? AllowDuplicateKeys { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to be parsed. + /// + /// The field to be parsed. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field that the converted structured object will be written into.
Any existing content in this field will be overwritten. + /// + /// The field that the converted structured object will be written into. + /// Any existing content in this field will be overwritten. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } @@ -115,7 +142,10 @@ public JsonProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } /// - /// Flag that forces the parsed JSON to be added at the top level of the document.
`target_field` must not be set when this option is chosen. + /// + /// Flag that forces the parsed JSON to be added at the top level of the document. + /// target_field must not be set when this option is chosen. + /// /// public JsonProcessorDescriptor AddToRoot(bool? addToRoot = true) { @@ -124,7 +154,11 @@ public JsonProcessorDescriptor AddToRoot(bool? addToRoot = true) } /// - /// When set to `replace`, root fields that conflict with fields from the parsed JSON will be overridden.
When set to `merge`, conflicting fields will be merged.
Only applicable `if add_to_root` is set to true. + /// + /// When set to replace, root fields that conflict with fields from the parsed JSON will be overridden. + /// When set to merge, conflicting fields will be merged. + /// Only applicable if add_to_root is set to true. + /// /// public JsonProcessorDescriptor AddToRootConflictStrategy(Elastic.Clients.Elasticsearch.Ingest.JsonProcessorConflictStrategy? addToRootConflictStrategy) { @@ -133,7 +167,10 @@ public JsonProcessorDescriptor AddToRootConflictStrategy(Elastic.Clie } /// - /// When set to `true`, the JSON parser will not fail if the JSON contains duplicate keys.
Instead, the last encountered value for any duplicate key wins. + /// + /// When set to true, the JSON parser will not fail if the JSON contains duplicate keys. + /// Instead, the last encountered value for any duplicate key wins. + /// /// public JsonProcessorDescriptor AllowDuplicateKeys(bool? allowDuplicateKeys = true) { @@ -142,7 +179,10 @@ public JsonProcessorDescriptor AllowDuplicateKeys(bool? allowDuplicat } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public JsonProcessorDescriptor Description(string? description) { @@ -151,7 +191,9 @@ public JsonProcessorDescriptor Description(string? description) } /// - /// The field to be parsed. + /// + /// The field to be parsed. + /// /// public JsonProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -160,7 +202,9 @@ public JsonProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Fi } /// - /// The field to be parsed. + /// + /// The field to be parsed. + /// /// public JsonProcessorDescriptor Field(Expression> field) { @@ -169,7 +213,9 @@ public JsonProcessorDescriptor Field(Expression - /// The field to be parsed. + /// + /// The field to be parsed. + /// /// public JsonProcessorDescriptor Field(Expression> field) { @@ -178,7 +224,9 @@ public JsonProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public JsonProcessorDescriptor If(string? value) { @@ -187,7 +235,9 @@ public JsonProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public JsonProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -196,7 +246,9 @@ public JsonProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tr } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public JsonProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -235,7 +287,10 @@ public JsonProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public JsonProcessorDescriptor Tag(string? tag) { @@ -244,7 +299,10 @@ public JsonProcessorDescriptor Tag(string? tag) } /// - /// The field that the converted structured object will be written into.
Any existing content in this field will be overwritten. + /// + /// The field that the converted structured object will be written into. + /// Any existing content in this field will be overwritten. + /// /// public JsonProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -253,7 +311,10 @@ public JsonProcessorDescriptor TargetField(Elastic.Clients.Elasticsea } /// - /// The field that the converted structured object will be written into.
Any existing content in this field will be overwritten. + /// + /// The field that the converted structured object will be written into. + /// Any existing content in this field will be overwritten. + /// /// public JsonProcessorDescriptor TargetField(Expression> targetField) { @@ -262,7 +323,10 @@ public JsonProcessorDescriptor TargetField(Expression - /// The field that the converted structured object will be written into.
Any existing content in this field will be overwritten. + /// + /// The field that the converted structured object will be written into. + /// Any existing content in this field will be overwritten. + /// /// public JsonProcessorDescriptor TargetField(Expression> targetField) { @@ -381,7 +445,10 @@ public JsonProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } /// - /// Flag that forces the parsed JSON to be added at the top level of the document.
`target_field` must not be set when this option is chosen. + /// + /// Flag that forces the parsed JSON to be added at the top level of the document. + /// target_field must not be set when this option is chosen. + /// /// public JsonProcessorDescriptor AddToRoot(bool? addToRoot = true) { @@ -390,7 +457,11 @@ public JsonProcessorDescriptor AddToRoot(bool? addToRoot = true) } /// - /// When set to `replace`, root fields that conflict with fields from the parsed JSON will be overridden.
When set to `merge`, conflicting fields will be merged.
Only applicable `if add_to_root` is set to true. + /// + /// When set to replace, root fields that conflict with fields from the parsed JSON will be overridden. + /// When set to merge, conflicting fields will be merged. + /// Only applicable if add_to_root is set to true. + /// /// public JsonProcessorDescriptor AddToRootConflictStrategy(Elastic.Clients.Elasticsearch.Ingest.JsonProcessorConflictStrategy? addToRootConflictStrategy) { @@ -399,7 +470,10 @@ public JsonProcessorDescriptor AddToRootConflictStrategy(Elastic.Clients.Elastic } /// - /// When set to `true`, the JSON parser will not fail if the JSON contains duplicate keys.
Instead, the last encountered value for any duplicate key wins. + /// + /// When set to true, the JSON parser will not fail if the JSON contains duplicate keys. + /// Instead, the last encountered value for any duplicate key wins. + /// /// public JsonProcessorDescriptor AllowDuplicateKeys(bool? allowDuplicateKeys = true) { @@ -408,7 +482,10 @@ public JsonProcessorDescriptor AllowDuplicateKeys(bool? allowDuplicateKeys = tru } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public JsonProcessorDescriptor Description(string? description) { @@ -417,7 +494,9 @@ public JsonProcessorDescriptor Description(string? description) } /// - /// The field to be parsed. + /// + /// The field to be parsed. + /// /// public JsonProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -426,7 +505,9 @@ public JsonProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) } /// - /// The field to be parsed. + /// + /// The field to be parsed. + /// /// public JsonProcessorDescriptor Field(Expression> field) { @@ -435,7 +516,9 @@ public JsonProcessorDescriptor Field(Expression - /// The field to be parsed. + /// + /// The field to be parsed. + /// /// public JsonProcessorDescriptor Field(Expression> field) { @@ -444,7 +527,9 @@ public JsonProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public JsonProcessorDescriptor If(string? value) { @@ -453,7 +538,9 @@ public JsonProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public JsonProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -462,7 +549,9 @@ public JsonProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public JsonProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -501,7 +590,10 @@ public JsonProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public JsonProcessorDescriptor Tag(string? tag) { @@ -510,7 +602,10 @@ public JsonProcessorDescriptor Tag(string? tag) } /// - /// The field that the converted structured object will be written into.
Any existing content in this field will be overwritten. + /// + /// The field that the converted structured object will be written into. + /// Any existing content in this field will be overwritten. + /// /// public JsonProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -519,7 +614,10 @@ public JsonProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? } /// - /// The field that the converted structured object will be written into.
Any existing content in this field will be overwritten. + /// + /// The field that the converted structured object will be written into. + /// Any existing content in this field will be overwritten. + /// /// public JsonProcessorDescriptor TargetField(Expression> targetField) { @@ -528,7 +626,10 @@ public JsonProcessorDescriptor TargetField(Expression - /// The field that the converted structured object will be written into.
Any existing content in this field will be overwritten. + /// + /// The field that the converted structured object will be written into. + /// Any existing content in this field will be overwritten. + /// /// public JsonProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/KeyValueProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/KeyValueProcessor.g.cs index 44e9fa5eede..db7604b7d3f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/KeyValueProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/KeyValueProcessor.g.cs @@ -30,97 +30,135 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class KeyValueProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// List of keys to exclude from document. + /// + /// List of keys to exclude from document. + /// /// [JsonInclude, JsonPropertyName("exclude_keys")] public ICollection? ExcludeKeys { get; set; } /// - /// The field to be parsed.
Supports template snippets. + /// + /// The field to be parsed. + /// Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Regex pattern to use for splitting key-value pairs. + /// + /// Regex pattern to use for splitting key-value pairs. + /// /// [JsonInclude, JsonPropertyName("field_split")] public string FieldSplit { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// List of keys to filter and insert into document.
Defaults to including all keys. + /// + /// List of keys to filter and insert into document. + /// Defaults to including all keys. + /// /// [JsonInclude, JsonPropertyName("include_keys")] public ICollection? IncludeKeys { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Prefix to be added to extracted keys. + /// + /// Prefix to be added to extracted keys. + /// /// [JsonInclude, JsonPropertyName("prefix")] public string? Prefix { get; set; } /// - /// If `true`. strip brackets `()`, `<>`, `[]` as well as quotes `'` and `"` from extracted values. + /// + /// If true. strip brackets (), <>, [] as well as quotes ' and " from extracted values. + /// /// [JsonInclude, JsonPropertyName("strip_brackets")] public bool? StripBrackets { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field to insert the extracted keys into.
Defaults to the root of the document.
Supports template snippets. + /// + /// The field to insert the extracted keys into. + /// Defaults to the root of the document. + /// Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } /// - /// String of characters to trim from extracted keys. + /// + /// String of characters to trim from extracted keys. + /// /// [JsonInclude, JsonPropertyName("trim_key")] public string? TrimKey { get; set; } /// - /// String of characters to trim from extracted values. + /// + /// String of characters to trim from extracted values. + /// /// [JsonInclude, JsonPropertyName("trim_value")] public string? TrimValue { get; set; } /// - /// Regex pattern to use for splitting the key from the value within a key-value pair. + /// + /// Regex pattern to use for splitting the key from the value within a key-value pair. + /// /// [JsonInclude, JsonPropertyName("value_split")] public string ValueSplit { get; set; } @@ -157,7 +195,10 @@ public KeyValueProcessorDescriptor() : base() private string ValueSplitValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public KeyValueProcessorDescriptor Description(string? description) { @@ -166,7 +207,9 @@ public KeyValueProcessorDescriptor Description(string? description) } /// - /// List of keys to exclude from document. + /// + /// List of keys to exclude from document. + /// /// public KeyValueProcessorDescriptor ExcludeKeys(ICollection? excludeKeys) { @@ -175,7 +218,10 @@ public KeyValueProcessorDescriptor ExcludeKeys(ICollection? e } /// - /// The field to be parsed.
Supports template snippets. + /// + /// The field to be parsed. + /// Supports template snippets. + /// /// public KeyValueProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -184,7 +230,10 @@ public KeyValueProcessorDescriptor Field(Elastic.Clients.Elasticsearc } /// - /// The field to be parsed.
Supports template snippets. + /// + /// The field to be parsed. + /// Supports template snippets. + /// /// public KeyValueProcessorDescriptor Field(Expression> field) { @@ -193,7 +242,10 @@ public KeyValueProcessorDescriptor Field(Expression - /// The field to be parsed.
Supports template snippets. + /// + /// The field to be parsed. + /// Supports template snippets. + /// /// public KeyValueProcessorDescriptor Field(Expression> field) { @@ -202,7 +254,9 @@ public KeyValueProcessorDescriptor Field(Expression - /// Regex pattern to use for splitting key-value pairs. + /// + /// Regex pattern to use for splitting key-value pairs. + /// /// public KeyValueProcessorDescriptor FieldSplit(string fieldSplit) { @@ -211,7 +265,9 @@ public KeyValueProcessorDescriptor FieldSplit(string fieldSplit) } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public KeyValueProcessorDescriptor If(string? value) { @@ -220,7 +276,9 @@ public KeyValueProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public KeyValueProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -229,7 +287,9 @@ public KeyValueProcessorDescriptor IgnoreFailure(bool? ignoreFailure } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public KeyValueProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -238,7 +298,10 @@ public KeyValueProcessorDescriptor IgnoreMissing(bool? ignoreMissing } /// - /// List of keys to filter and insert into document.
Defaults to including all keys. + /// + /// List of keys to filter and insert into document. + /// Defaults to including all keys. + /// /// public KeyValueProcessorDescriptor IncludeKeys(ICollection? includeKeys) { @@ -247,7 +310,9 @@ public KeyValueProcessorDescriptor IncludeKeys(ICollection? i } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public KeyValueProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -286,7 +351,9 @@ public KeyValueProcessorDescriptor OnFailure(params Action - /// Prefix to be added to extracted keys. + /// + /// Prefix to be added to extracted keys. + /// /// public KeyValueProcessorDescriptor Prefix(string? prefix) { @@ -295,7 +362,9 @@ public KeyValueProcessorDescriptor Prefix(string? prefix) } /// - /// If `true`. strip brackets `()`, `<>`, `[]` as well as quotes `'` and `"` from extracted values. + /// + /// If true. strip brackets (), <>, [] as well as quotes ' and " from extracted values. + /// /// public KeyValueProcessorDescriptor StripBrackets(bool? stripBrackets = true) { @@ -304,7 +373,10 @@ public KeyValueProcessorDescriptor StripBrackets(bool? stripBrackets } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public KeyValueProcessorDescriptor Tag(string? tag) { @@ -313,7 +385,11 @@ public KeyValueProcessorDescriptor Tag(string? tag) } /// - /// The field to insert the extracted keys into.
Defaults to the root of the document.
Supports template snippets. + /// + /// The field to insert the extracted keys into. + /// Defaults to the root of the document. + /// Supports template snippets. + /// /// public KeyValueProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -322,7 +398,11 @@ public KeyValueProcessorDescriptor TargetField(Elastic.Clients.Elasti } /// - /// The field to insert the extracted keys into.
Defaults to the root of the document.
Supports template snippets. + /// + /// The field to insert the extracted keys into. + /// Defaults to the root of the document. + /// Supports template snippets. + /// /// public KeyValueProcessorDescriptor TargetField(Expression> targetField) { @@ -331,7 +411,11 @@ public KeyValueProcessorDescriptor TargetField(Expression - /// The field to insert the extracted keys into.
Defaults to the root of the document.
Supports template snippets. + /// + /// The field to insert the extracted keys into. + /// Defaults to the root of the document. + /// Supports template snippets. + /// /// public KeyValueProcessorDescriptor TargetField(Expression> targetField) { @@ -340,7 +424,9 @@ public KeyValueProcessorDescriptor TargetField(Expression - /// String of characters to trim from extracted keys. + /// + /// String of characters to trim from extracted keys. + /// /// public KeyValueProcessorDescriptor TrimKey(string? trimKey) { @@ -349,7 +435,9 @@ public KeyValueProcessorDescriptor TrimKey(string? trimKey) } /// - /// String of characters to trim from extracted values. + /// + /// String of characters to trim from extracted values. + /// /// public KeyValueProcessorDescriptor TrimValue(string? trimValue) { @@ -358,7 +446,9 @@ public KeyValueProcessorDescriptor TrimValue(string? trimValue) } /// - /// Regex pattern to use for splitting the key from the value within a key-value pair. + /// + /// Regex pattern to use for splitting the key from the value within a key-value pair. + /// /// public KeyValueProcessorDescriptor ValueSplit(string valueSplit) { @@ -511,7 +601,10 @@ public KeyValueProcessorDescriptor() : base() private string ValueSplitValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public KeyValueProcessorDescriptor Description(string? description) { @@ -520,7 +613,9 @@ public KeyValueProcessorDescriptor Description(string? description) } /// - /// List of keys to exclude from document. + /// + /// List of keys to exclude from document. + /// /// public KeyValueProcessorDescriptor ExcludeKeys(ICollection? excludeKeys) { @@ -529,7 +624,10 @@ public KeyValueProcessorDescriptor ExcludeKeys(ICollection? excludeKeys) } /// - /// The field to be parsed.
Supports template snippets. + /// + /// The field to be parsed. + /// Supports template snippets. + /// /// public KeyValueProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -538,7 +636,10 @@ public KeyValueProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field fie } /// - /// The field to be parsed.
Supports template snippets. + /// + /// The field to be parsed. + /// Supports template snippets. + /// /// public KeyValueProcessorDescriptor Field(Expression> field) { @@ -547,7 +648,10 @@ public KeyValueProcessorDescriptor Field(Expression - /// The field to be parsed.
Supports template snippets. + /// + /// The field to be parsed. + /// Supports template snippets. + /// /// public KeyValueProcessorDescriptor Field(Expression> field) { @@ -556,7 +660,9 @@ public KeyValueProcessorDescriptor Field(Expression - /// Regex pattern to use for splitting key-value pairs. + /// + /// Regex pattern to use for splitting key-value pairs. + /// /// public KeyValueProcessorDescriptor FieldSplit(string fieldSplit) { @@ -565,7 +671,9 @@ public KeyValueProcessorDescriptor FieldSplit(string fieldSplit) } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public KeyValueProcessorDescriptor If(string? value) { @@ -574,7 +682,9 @@ public KeyValueProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public KeyValueProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -583,7 +693,9 @@ public KeyValueProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public KeyValueProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -592,7 +704,10 @@ public KeyValueProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// List of keys to filter and insert into document.
Defaults to including all keys. + /// + /// List of keys to filter and insert into document. + /// Defaults to including all keys. + /// /// public KeyValueProcessorDescriptor IncludeKeys(ICollection? includeKeys) { @@ -601,7 +716,9 @@ public KeyValueProcessorDescriptor IncludeKeys(ICollection? includeKeys) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public KeyValueProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -640,7 +757,9 @@ public KeyValueProcessorDescriptor OnFailure(params Action - /// Prefix to be added to extracted keys. + /// + /// Prefix to be added to extracted keys. + /// /// public KeyValueProcessorDescriptor Prefix(string? prefix) { @@ -649,7 +768,9 @@ public KeyValueProcessorDescriptor Prefix(string? prefix) } /// - /// If `true`. strip brackets `()`, `<>`, `[]` as well as quotes `'` and `"` from extracted values. + /// + /// If true. strip brackets (), <>, [] as well as quotes ' and " from extracted values. + /// /// public KeyValueProcessorDescriptor StripBrackets(bool? stripBrackets = true) { @@ -658,7 +779,10 @@ public KeyValueProcessorDescriptor StripBrackets(bool? stripBrackets = true) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public KeyValueProcessorDescriptor Tag(string? tag) { @@ -667,7 +791,11 @@ public KeyValueProcessorDescriptor Tag(string? tag) } /// - /// The field to insert the extracted keys into.
Defaults to the root of the document.
Supports template snippets. + /// + /// The field to insert the extracted keys into. + /// Defaults to the root of the document. + /// Supports template snippets. + /// /// public KeyValueProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -676,7 +804,11 @@ public KeyValueProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Fie } /// - /// The field to insert the extracted keys into.
Defaults to the root of the document.
Supports template snippets. + /// + /// The field to insert the extracted keys into. + /// Defaults to the root of the document. + /// Supports template snippets. + /// /// public KeyValueProcessorDescriptor TargetField(Expression> targetField) { @@ -685,7 +817,11 @@ public KeyValueProcessorDescriptor TargetField(Expression - /// The field to insert the extracted keys into.
Defaults to the root of the document.
Supports template snippets. + /// + /// The field to insert the extracted keys into. + /// Defaults to the root of the document. + /// Supports template snippets. + /// /// public KeyValueProcessorDescriptor TargetField(Expression> targetField) { @@ -694,7 +830,9 @@ public KeyValueProcessorDescriptor TargetField(Expression - /// String of characters to trim from extracted keys. + /// + /// String of characters to trim from extracted keys. + /// /// public KeyValueProcessorDescriptor TrimKey(string? trimKey) { @@ -703,7 +841,9 @@ public KeyValueProcessorDescriptor TrimKey(string? trimKey) } /// - /// String of characters to trim from extracted values. + /// + /// String of characters to trim from extracted values. + /// /// public KeyValueProcessorDescriptor TrimValue(string? trimValue) { @@ -712,7 +852,9 @@ public KeyValueProcessorDescriptor TrimValue(string? trimValue) } /// - /// Regex pattern to use for splitting the key from the value within a key-value pair. + /// + /// Regex pattern to use for splitting the key from the value within a key-value pair. + /// /// public KeyValueProcessorDescriptor ValueSplit(string valueSplit) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/LowercaseProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/LowercaseProcessor.g.cs index 7217dce202c..37c80274049 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/LowercaseProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/LowercaseProcessor.g.cs @@ -30,49 +30,68 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class LowercaseProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to make lowercase. + /// + /// The field to make lowercase. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } @@ -101,7 +120,10 @@ public LowercaseProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public LowercaseProcessorDescriptor Description(string? description) { @@ -110,7 +132,9 @@ public LowercaseProcessorDescriptor Description(string? description) } /// - /// The field to make lowercase. + /// + /// The field to make lowercase. + /// /// public LowercaseProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -119,7 +143,9 @@ public LowercaseProcessorDescriptor Field(Elastic.Clients.Elasticsear } /// - /// The field to make lowercase. + /// + /// The field to make lowercase. + /// /// public LowercaseProcessorDescriptor Field(Expression> field) { @@ -128,7 +154,9 @@ public LowercaseProcessorDescriptor Field(Expression - /// The field to make lowercase. + /// + /// The field to make lowercase. + /// /// public LowercaseProcessorDescriptor Field(Expression> field) { @@ -137,7 +165,9 @@ public LowercaseProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public LowercaseProcessorDescriptor If(string? value) { @@ -146,7 +176,9 @@ public LowercaseProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public LowercaseProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -155,7 +187,9 @@ public LowercaseProcessorDescriptor IgnoreFailure(bool? ignoreFailure } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public LowercaseProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -164,7 +198,9 @@ public LowercaseProcessorDescriptor IgnoreMissing(bool? ignoreMissing } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public LowercaseProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -203,7 +239,10 @@ public LowercaseProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public LowercaseProcessorDescriptor Tag(string? tag) { @@ -212,7 +251,10 @@ public LowercaseProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public LowercaseProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -221,7 +263,10 @@ public LowercaseProcessorDescriptor TargetField(Elastic.Clients.Elast } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public LowercaseProcessorDescriptor TargetField(Expression> targetField) { @@ -230,7 +275,10 @@ public LowercaseProcessorDescriptor TargetField(Expression - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public LowercaseProcessorDescriptor TargetField(Expression> targetField) { @@ -335,7 +383,10 @@ public LowercaseProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public LowercaseProcessorDescriptor Description(string? description) { @@ -344,7 +395,9 @@ public LowercaseProcessorDescriptor Description(string? description) } /// - /// The field to make lowercase. + /// + /// The field to make lowercase. + /// /// public LowercaseProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -353,7 +406,9 @@ public LowercaseProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field fi } /// - /// The field to make lowercase. + /// + /// The field to make lowercase. + /// /// public LowercaseProcessorDescriptor Field(Expression> field) { @@ -362,7 +417,9 @@ public LowercaseProcessorDescriptor Field(Expression - /// The field to make lowercase. + /// + /// The field to make lowercase. + /// /// public LowercaseProcessorDescriptor Field(Expression> field) { @@ -371,7 +428,9 @@ public LowercaseProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public LowercaseProcessorDescriptor If(string? value) { @@ -380,7 +439,9 @@ public LowercaseProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public LowercaseProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -389,7 +450,9 @@ public LowercaseProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public LowercaseProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -398,7 +461,9 @@ public LowercaseProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public LowercaseProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -437,7 +502,10 @@ public LowercaseProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public LowercaseProcessorDescriptor Tag(string? tag) { @@ -446,7 +514,10 @@ public LowercaseProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public LowercaseProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -455,7 +526,10 @@ public LowercaseProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Fi } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public LowercaseProcessorDescriptor TargetField(Expression> targetField) { @@ -464,7 +538,10 @@ public LowercaseProcessorDescriptor TargetField(Expression - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public LowercaseProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Pipeline.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Pipeline.g.cs index cda3da98740..70279bc35bc 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Pipeline.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Pipeline.g.cs @@ -30,31 +30,42 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class Pipeline { /// - /// Description of the ingest pipeline. + /// + /// Description of the ingest pipeline. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// Arbitrary metadata about the ingest pipeline. This map is not automatically generated by Elasticsearch. + /// + /// Arbitrary metadata about the ingest pipeline. This map is not automatically generated by Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("_meta")] public IDictionary? Meta { get; set; } /// - /// Processors to run immediately after a processor failure. + /// + /// Processors to run immediately after a processor failure. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Processors used to perform transformations on documents before indexing.
Processors run sequentially in the order specified. + /// + /// Processors used to perform transformations on documents before indexing. + /// Processors run sequentially in the order specified. + /// /// [JsonInclude, JsonPropertyName("processors")] public ICollection? Processors { get; set; } /// - /// Version number used by external systems to track ingest pipelines. + /// + /// Version number used by external systems to track ingest pipelines. + /// /// [JsonInclude, JsonPropertyName("version")] public long? Version { get; set; } @@ -81,7 +92,9 @@ public PipelineDescriptor() : base() private long? VersionValue { get; set; } /// - /// Description of the ingest pipeline. + /// + /// Description of the ingest pipeline. + /// /// public PipelineDescriptor Description(string? description) { @@ -90,7 +103,9 @@ public PipelineDescriptor Description(string? description) } /// - /// Arbitrary metadata about the ingest pipeline. This map is not automatically generated by Elasticsearch. + /// + /// Arbitrary metadata about the ingest pipeline. This map is not automatically generated by Elasticsearch. + /// /// public PipelineDescriptor Meta(Func, FluentDictionary> selector) { @@ -99,7 +114,9 @@ public PipelineDescriptor Meta(Func, } /// - /// Processors to run immediately after a processor failure. + /// + /// Processors to run immediately after a processor failure. + /// /// public PipelineDescriptor OnFailure(ICollection? onFailure) { @@ -138,7 +155,10 @@ public PipelineDescriptor OnFailure(params Action - /// Processors used to perform transformations on documents before indexing.
Processors run sequentially in the order specified. + /// + /// Processors used to perform transformations on documents before indexing. + /// Processors run sequentially in the order specified. + /// /// public PipelineDescriptor Processors(ICollection? processors) { @@ -177,7 +197,9 @@ public PipelineDescriptor Processors(params Action - /// Version number used by external systems to track ingest pipelines. + /// + /// Version number used by external systems to track ingest pipelines. + /// /// public PipelineDescriptor Version(long? version) { @@ -293,7 +315,9 @@ public PipelineDescriptor() : base() private long? VersionValue { get; set; } /// - /// Description of the ingest pipeline. + /// + /// Description of the ingest pipeline. + /// /// public PipelineDescriptor Description(string? description) { @@ -302,7 +326,9 @@ public PipelineDescriptor Description(string? description) } /// - /// Arbitrary metadata about the ingest pipeline. This map is not automatically generated by Elasticsearch. + /// + /// Arbitrary metadata about the ingest pipeline. This map is not automatically generated by Elasticsearch. + /// /// public PipelineDescriptor Meta(Func, FluentDictionary> selector) { @@ -311,7 +337,9 @@ public PipelineDescriptor Meta(Func, FluentDict } /// - /// Processors to run immediately after a processor failure. + /// + /// Processors to run immediately after a processor failure. + /// /// public PipelineDescriptor OnFailure(ICollection? onFailure) { @@ -350,7 +378,10 @@ public PipelineDescriptor OnFailure(params Action - /// Processors used to perform transformations on documents before indexing.
Processors run sequentially in the order specified. + /// + /// Processors used to perform transformations on documents before indexing. + /// Processors run sequentially in the order specified. + /// /// public PipelineDescriptor Processors(ICollection? processors) { @@ -389,7 +420,9 @@ public PipelineDescriptor Processors(params Action - /// Version number used by external systems to track ingest pipelines. + /// + /// Version number used by external systems to track ingest pipelines. + /// /// public PipelineDescriptor Version(long? version) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/PipelineProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/PipelineProcessor.g.cs index 2230f3cd42d..294980689cd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/PipelineProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/PipelineProcessor.g.cs @@ -30,43 +30,60 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class PipelineProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// Whether to ignore missing pipelines instead of failing. + /// + /// Whether to ignore missing pipelines instead of failing. + /// /// [JsonInclude, JsonPropertyName("ignore_missing_pipeline")] public bool? IgnoreMissingPipeline { get; set; } /// - /// The name of the pipeline to execute.
Supports template snippets. + /// + /// The name of the pipeline to execute. + /// Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("name")] public Elastic.Clients.Elasticsearch.Name Name { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } @@ -94,7 +111,10 @@ public PipelineProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public PipelineProcessorDescriptor Description(string? description) { @@ -103,7 +123,9 @@ public PipelineProcessorDescriptor Description(string? description) } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public PipelineProcessorDescriptor If(string? value) { @@ -112,7 +134,9 @@ public PipelineProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public PipelineProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -121,7 +145,9 @@ public PipelineProcessorDescriptor IgnoreFailure(bool? ignoreFailure } /// - /// Whether to ignore missing pipelines instead of failing. + /// + /// Whether to ignore missing pipelines instead of failing. + /// /// public PipelineProcessorDescriptor IgnoreMissingPipeline(bool? ignoreMissingPipeline = true) { @@ -130,7 +156,10 @@ public PipelineProcessorDescriptor IgnoreMissingPipeline(bool? ignore } /// - /// The name of the pipeline to execute.
Supports template snippets. + /// + /// The name of the pipeline to execute. + /// Supports template snippets. + /// /// public PipelineProcessorDescriptor Name(Elastic.Clients.Elasticsearch.Name name) { @@ -139,7 +168,9 @@ public PipelineProcessorDescriptor Name(Elastic.Clients.Elasticsearch } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public PipelineProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -178,7 +209,10 @@ public PipelineProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public PipelineProcessorDescriptor Tag(string? tag) { @@ -276,7 +310,10 @@ public PipelineProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public PipelineProcessorDescriptor Description(string? description) { @@ -285,7 +322,9 @@ public PipelineProcessorDescriptor Description(string? description) } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public PipelineProcessorDescriptor If(string? value) { @@ -294,7 +333,9 @@ public PipelineProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public PipelineProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -303,7 +344,9 @@ public PipelineProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// Whether to ignore missing pipelines instead of failing. + /// + /// Whether to ignore missing pipelines instead of failing. + /// /// public PipelineProcessorDescriptor IgnoreMissingPipeline(bool? ignoreMissingPipeline = true) { @@ -312,7 +355,10 @@ public PipelineProcessorDescriptor IgnoreMissingPipeline(bool? ignoreMissingPipe } /// - /// The name of the pipeline to execute.
Supports template snippets. + /// + /// The name of the pipeline to execute. + /// Supports template snippets. + /// /// public PipelineProcessorDescriptor Name(Elastic.Clients.Elasticsearch.Name name) { @@ -321,7 +367,9 @@ public PipelineProcessorDescriptor Name(Elastic.Clients.Elasticsearch.Name name) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public PipelineProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -360,7 +408,10 @@ public PipelineProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public PipelineProcessorDescriptor Tag(string? tag) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/RemoveProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/RemoveProcessor.g.cs index 6d6fef74731..33124de7f4a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/RemoveProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/RemoveProcessor.g.cs @@ -30,51 +30,69 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class RemoveProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// Fields to be removed. Supports template snippets. + /// + /// Fields to be removed. Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("field")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] public Elastic.Clients.Elasticsearch.Fields Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Fields to be kept. When set, all fields other than those specified are removed. + /// + /// Fields to be kept. When set, all fields other than those specified are removed. + /// /// [JsonInclude, JsonPropertyName("keep")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] public Elastic.Clients.Elasticsearch.Fields? Keep { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } @@ -103,7 +121,10 @@ public RemoveProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public RemoveProcessorDescriptor Description(string? description) { @@ -112,7 +133,9 @@ public RemoveProcessorDescriptor Description(string? description) } /// - /// Fields to be removed. Supports template snippets. + /// + /// Fields to be removed. Supports template snippets. + /// /// public RemoveProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Fields field) { @@ -121,7 +144,9 @@ public RemoveProcessorDescriptor Field(Elastic.Clients.Elasticsearch. } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public RemoveProcessorDescriptor If(string? value) { @@ -130,7 +155,9 @@ public RemoveProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public RemoveProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -139,7 +166,9 @@ public RemoveProcessorDescriptor IgnoreFailure(bool? ignoreFailure = } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public RemoveProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -148,7 +177,9 @@ public RemoveProcessorDescriptor IgnoreMissing(bool? ignoreMissing = } /// - /// Fields to be kept. When set, all fields other than those specified are removed. + /// + /// Fields to be kept. When set, all fields other than those specified are removed. + /// /// public RemoveProcessorDescriptor Keep(Elastic.Clients.Elasticsearch.Fields? keep) { @@ -157,7 +188,9 @@ public RemoveProcessorDescriptor Keep(Elastic.Clients.Elasticsearch.F } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public RemoveProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -196,7 +229,10 @@ public RemoveProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public RemoveProcessorDescriptor Tag(string? tag) { @@ -301,7 +337,10 @@ public RemoveProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public RemoveProcessorDescriptor Description(string? description) { @@ -310,7 +349,9 @@ public RemoveProcessorDescriptor Description(string? description) } /// - /// Fields to be removed. Supports template snippets. + /// + /// Fields to be removed. Supports template snippets. + /// /// public RemoveProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Fields field) { @@ -319,7 +360,9 @@ public RemoveProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Fields fiel } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public RemoveProcessorDescriptor If(string? value) { @@ -328,7 +371,9 @@ public RemoveProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public RemoveProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -337,7 +382,9 @@ public RemoveProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public RemoveProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -346,7 +393,9 @@ public RemoveProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Fields to be kept. When set, all fields other than those specified are removed. + /// + /// Fields to be kept. When set, all fields other than those specified are removed. + /// /// public RemoveProcessorDescriptor Keep(Elastic.Clients.Elasticsearch.Fields? keep) { @@ -355,7 +404,9 @@ public RemoveProcessorDescriptor Keep(Elastic.Clients.Elasticsearch.Fields? keep } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public RemoveProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -394,7 +445,10 @@ public RemoveProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public RemoveProcessorDescriptor Tag(string? tag) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/RenameProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/RenameProcessor.g.cs index 926ebfefe60..38111549a4b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/RenameProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/RenameProcessor.g.cs @@ -30,49 +30,69 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class RenameProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to be renamed.
Supports template snippets. + /// + /// The field to be renamed. + /// Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The new name of the field.
Supports template snippets. + /// + /// The new name of the field. + /// Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field TargetField { get; set; } @@ -101,7 +121,10 @@ public RenameProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public RenameProcessorDescriptor Description(string? description) { @@ -110,7 +133,10 @@ public RenameProcessorDescriptor Description(string? description) } /// - /// The field to be renamed.
Supports template snippets. + /// + /// The field to be renamed. + /// Supports template snippets. + /// /// public RenameProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -119,7 +145,10 @@ public RenameProcessorDescriptor Field(Elastic.Clients.Elasticsearch. } /// - /// The field to be renamed.
Supports template snippets. + /// + /// The field to be renamed. + /// Supports template snippets. + /// /// public RenameProcessorDescriptor Field(Expression> field) { @@ -128,7 +157,10 @@ public RenameProcessorDescriptor Field(Expression - /// The field to be renamed.
Supports template snippets. + /// + /// The field to be renamed. + /// Supports template snippets. + /// /// public RenameProcessorDescriptor Field(Expression> field) { @@ -137,7 +169,9 @@ public RenameProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public RenameProcessorDescriptor If(string? value) { @@ -146,7 +180,9 @@ public RenameProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public RenameProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -155,7 +191,9 @@ public RenameProcessorDescriptor IgnoreFailure(bool? ignoreFailure = } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public RenameProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -164,7 +202,9 @@ public RenameProcessorDescriptor IgnoreMissing(bool? ignoreMissing = } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public RenameProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -203,7 +243,10 @@ public RenameProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public RenameProcessorDescriptor Tag(string? tag) { @@ -212,7 +255,10 @@ public RenameProcessorDescriptor Tag(string? tag) } /// - /// The new name of the field.
Supports template snippets. + /// + /// The new name of the field. + /// Supports template snippets. + /// /// public RenameProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field targetField) { @@ -221,7 +267,10 @@ public RenameProcessorDescriptor TargetField(Elastic.Clients.Elastics } /// - /// The new name of the field.
Supports template snippets. + /// + /// The new name of the field. + /// Supports template snippets. + /// /// public RenameProcessorDescriptor TargetField(Expression> targetField) { @@ -230,7 +279,10 @@ public RenameProcessorDescriptor TargetField(Expression - /// The new name of the field.
Supports template snippets. + /// + /// The new name of the field. + /// Supports template snippets. + /// /// public RenameProcessorDescriptor TargetField(Expression> targetField) { @@ -331,7 +383,10 @@ public RenameProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public RenameProcessorDescriptor Description(string? description) { @@ -340,7 +395,10 @@ public RenameProcessorDescriptor Description(string? description) } /// - /// The field to be renamed.
Supports template snippets. + /// + /// The field to be renamed. + /// Supports template snippets. + /// /// public RenameProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -349,7 +407,10 @@ public RenameProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field } /// - /// The field to be renamed.
Supports template snippets. + /// + /// The field to be renamed. + /// Supports template snippets. + /// /// public RenameProcessorDescriptor Field(Expression> field) { @@ -358,7 +419,10 @@ public RenameProcessorDescriptor Field(Expression - /// The field to be renamed.
Supports template snippets. + /// + /// The field to be renamed. + /// Supports template snippets. + /// /// public RenameProcessorDescriptor Field(Expression> field) { @@ -367,7 +431,9 @@ public RenameProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public RenameProcessorDescriptor If(string? value) { @@ -376,7 +442,9 @@ public RenameProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public RenameProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -385,7 +453,9 @@ public RenameProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public RenameProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -394,7 +464,9 @@ public RenameProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public RenameProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -433,7 +505,10 @@ public RenameProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public RenameProcessorDescriptor Tag(string? tag) { @@ -442,7 +517,10 @@ public RenameProcessorDescriptor Tag(string? tag) } /// - /// The new name of the field.
Supports template snippets. + /// + /// The new name of the field. + /// Supports template snippets. + /// /// public RenameProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field targetField) { @@ -451,7 +529,10 @@ public RenameProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field } /// - /// The new name of the field.
Supports template snippets. + /// + /// The new name of the field. + /// Supports template snippets. + /// /// public RenameProcessorDescriptor TargetField(Expression> targetField) { @@ -460,7 +541,10 @@ public RenameProcessorDescriptor TargetField(Expression - /// The new name of the field.
Supports template snippets. + /// + /// The new name of the field. + /// Supports template snippets. + /// /// public RenameProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/RerouteProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/RerouteProcessor.g.cs index 8e564e4de81..2f92c5c108e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/RerouteProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/RerouteProcessor.g.cs @@ -30,55 +30,88 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class RerouteProcessor { /// - /// Field references or a static value for the dataset part of the data stream name.
In addition to the criteria for index names, cannot contain - and must be no longer than 100 characters.
Example values are nginx.access and nginx.error. - /// Supports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces).
When resolving field references, the processor replaces invalid characters with _. Uses the part
of the index name as a fallback if all field references resolve to a null, missing, or non-string value. - /// default {{data_stream.dataset}} + /// + /// Field references or a static value for the dataset part of the data stream name. + /// In addition to the criteria for index names, cannot contain - and must be no longer than 100 characters. + /// Example values are nginx.access and nginx.error. + /// + /// + /// Supports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces). + /// When resolving field references, the processor replaces invalid characters with _. Uses the <dataset> part + /// of the index name as a fallback if all field references resolve to a null, missing, or non-string value. + /// + /// + /// default {{data_stream.dataset}} + /// /// [JsonInclude, JsonPropertyName("dataset")] [SingleOrManyCollectionConverter(typeof(string))] public ICollection? Dataset { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// A static value for the target. Can’t be set when the dataset or namespace option is set. + /// + /// A static value for the target. Can’t be set when the dataset or namespace option is set. + /// /// [JsonInclude, JsonPropertyName("destination")] public string? Destination { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// Field references or a static value for the namespace part of the data stream name. See the criteria for
index names for allowed characters. Must be no longer than 100 characters. - /// Supports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces).
When resolving field references, the processor replaces invalid characters with _. Uses the part
of the index name as a fallback if all field references resolve to a null, missing, or non-string value. - /// default {{data_stream.namespace}} + /// + /// Field references or a static value for the namespace part of the data stream name. See the criteria for + /// index names for allowed characters. Must be no longer than 100 characters. + /// + /// + /// Supports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces). + /// When resolving field references, the processor replaces invalid characters with _. Uses the <namespace> part + /// of the index name as a fallback if all field references resolve to a null, missing, or non-string value. + /// + /// + /// default {{data_stream.namespace}} + /// /// [JsonInclude, JsonPropertyName("namespace")] [SingleOrManyCollectionConverter(typeof(string))] public ICollection? Namespace { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } @@ -107,9 +140,19 @@ public RerouteProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Field references or a static value for the dataset part of the data stream name.
In addition to the criteria for index names, cannot contain - and must be no longer than 100 characters.
Example values are nginx.access and nginx.error. - /// Supports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces).
When resolving field references, the processor replaces invalid characters with _. Uses the part
of the index name as a fallback if all field references resolve to a null, missing, or non-string value. - /// default {{data_stream.dataset}} + /// + /// Field references or a static value for the dataset part of the data stream name. + /// In addition to the criteria for index names, cannot contain - and must be no longer than 100 characters. + /// Example values are nginx.access and nginx.error. + /// + /// + /// Supports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces). + /// When resolving field references, the processor replaces invalid characters with _. Uses the <dataset> part + /// of the index name as a fallback if all field references resolve to a null, missing, or non-string value. + /// + /// + /// default {{data_stream.dataset}} + /// /// public RerouteProcessorDescriptor Dataset(ICollection? dataset) { @@ -118,7 +161,10 @@ public RerouteProcessorDescriptor Dataset(ICollection? datase } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public RerouteProcessorDescriptor Description(string? description) { @@ -127,7 +173,9 @@ public RerouteProcessorDescriptor Description(string? description) } /// - /// A static value for the target. Can’t be set when the dataset or namespace option is set. + /// + /// A static value for the target. Can’t be set when the dataset or namespace option is set. + /// /// public RerouteProcessorDescriptor Destination(string? destination) { @@ -136,7 +184,9 @@ public RerouteProcessorDescriptor Destination(string? destination) } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public RerouteProcessorDescriptor If(string? value) { @@ -145,7 +195,9 @@ public RerouteProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public RerouteProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -154,9 +206,18 @@ public RerouteProcessorDescriptor IgnoreFailure(bool? ignoreFailure = } /// - /// Field references or a static value for the namespace part of the data stream name. See the criteria for
index names for allowed characters. Must be no longer than 100 characters. - /// Supports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces).
When resolving field references, the processor replaces invalid characters with _. Uses the part
of the index name as a fallback if all field references resolve to a null, missing, or non-string value. - /// default {{data_stream.namespace}} + /// + /// Field references or a static value for the namespace part of the data stream name. See the criteria for + /// index names for allowed characters. Must be no longer than 100 characters. + /// + /// + /// Supports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces). + /// When resolving field references, the processor replaces invalid characters with _. Uses the <namespace> part + /// of the index name as a fallback if all field references resolve to a null, missing, or non-string value. + /// + /// + /// default {{data_stream.namespace}} + /// /// public RerouteProcessorDescriptor Namespace(ICollection? value) { @@ -165,7 +226,9 @@ public RerouteProcessorDescriptor Namespace(ICollection? valu } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public RerouteProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -204,7 +267,10 @@ public RerouteProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public RerouteProcessorDescriptor Tag(string? tag) { @@ -313,9 +379,19 @@ public RerouteProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Field references or a static value for the dataset part of the data stream name.
In addition to the criteria for index names, cannot contain - and must be no longer than 100 characters.
Example values are nginx.access and nginx.error. - /// Supports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces).
When resolving field references, the processor replaces invalid characters with _. Uses the part
of the index name as a fallback if all field references resolve to a null, missing, or non-string value. - /// default {{data_stream.dataset}} + /// + /// Field references or a static value for the dataset part of the data stream name. + /// In addition to the criteria for index names, cannot contain - and must be no longer than 100 characters. + /// Example values are nginx.access and nginx.error. + /// + /// + /// Supports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces). + /// When resolving field references, the processor replaces invalid characters with _. Uses the <dataset> part + /// of the index name as a fallback if all field references resolve to a null, missing, or non-string value. + /// + /// + /// default {{data_stream.dataset}} + /// /// public RerouteProcessorDescriptor Dataset(ICollection? dataset) { @@ -324,7 +400,10 @@ public RerouteProcessorDescriptor Dataset(ICollection? dataset) } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public RerouteProcessorDescriptor Description(string? description) { @@ -333,7 +412,9 @@ public RerouteProcessorDescriptor Description(string? description) } /// - /// A static value for the target. Can’t be set when the dataset or namespace option is set. + /// + /// A static value for the target. Can’t be set when the dataset or namespace option is set. + /// /// public RerouteProcessorDescriptor Destination(string? destination) { @@ -342,7 +423,9 @@ public RerouteProcessorDescriptor Destination(string? destination) } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public RerouteProcessorDescriptor If(string? value) { @@ -351,7 +434,9 @@ public RerouteProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public RerouteProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -360,9 +445,18 @@ public RerouteProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// Field references or a static value for the namespace part of the data stream name. See the criteria for
index names for allowed characters. Must be no longer than 100 characters. - /// Supports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces).
When resolving field references, the processor replaces invalid characters with _. Uses the part
of the index name as a fallback if all field references resolve to a null, missing, or non-string value. - /// default {{data_stream.namespace}} + /// + /// Field references or a static value for the namespace part of the data stream name. See the criteria for + /// index names for allowed characters. Must be no longer than 100 characters. + /// + /// + /// Supports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces). + /// When resolving field references, the processor replaces invalid characters with _. Uses the <namespace> part + /// of the index name as a fallback if all field references resolve to a null, missing, or non-string value. + /// + /// + /// default {{data_stream.namespace}} + /// /// public RerouteProcessorDescriptor Namespace(ICollection? value) { @@ -371,7 +465,9 @@ public RerouteProcessorDescriptor Namespace(ICollection? value) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public RerouteProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -410,7 +506,10 @@ public RerouteProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public RerouteProcessorDescriptor Tag(string? tag) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/ScriptProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/ScriptProcessor.g.cs index e90bab7a002..d337108d136 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/ScriptProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/ScriptProcessor.g.cs @@ -30,55 +30,77 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class ScriptProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// ID of a stored script.
If no `source` is specified, this parameter is required. + /// + /// ID of a stored script. + /// If no source is specified, this parameter is required. + /// /// [JsonInclude, JsonPropertyName("id")] public Elastic.Clients.Elasticsearch.Id? Id { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// Script language. + /// + /// Script language. + /// /// [JsonInclude, JsonPropertyName("lang")] public string? Lang { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Object containing parameters for the script. + /// + /// Object containing parameters for the script. + /// /// [JsonInclude, JsonPropertyName("params")] public IDictionary? Params { get; set; } /// - /// Inline script.
If no `id` is specified, this parameter is required. + /// + /// Inline script. + /// If no id is specified, this parameter is required. + /// /// [JsonInclude, JsonPropertyName("source")] public string? Source { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } @@ -108,7 +130,10 @@ public ScriptProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public ScriptProcessorDescriptor Description(string? description) { @@ -117,7 +142,10 @@ public ScriptProcessorDescriptor Description(string? description) } /// - /// ID of a stored script.
If no `source` is specified, this parameter is required. + /// + /// ID of a stored script. + /// If no source is specified, this parameter is required. + /// /// public ScriptProcessorDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) { @@ -126,7 +154,9 @@ public ScriptProcessorDescriptor Id(Elastic.Clients.Elasticsearch.Id? } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public ScriptProcessorDescriptor If(string? value) { @@ -135,7 +165,9 @@ public ScriptProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public ScriptProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -144,7 +176,9 @@ public ScriptProcessorDescriptor IgnoreFailure(bool? ignoreFailure = } /// - /// Script language. + /// + /// Script language. + /// /// public ScriptProcessorDescriptor Lang(string? lang) { @@ -153,7 +187,9 @@ public ScriptProcessorDescriptor Lang(string? lang) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public ScriptProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -192,7 +228,9 @@ public ScriptProcessorDescriptor OnFailure(params Action - /// Object containing parameters for the script. + /// + /// Object containing parameters for the script. + /// /// public ScriptProcessorDescriptor Params(Func, FluentDictionary> selector) { @@ -201,7 +239,10 @@ public ScriptProcessorDescriptor Params(Func - /// Inline script.
If no `id` is specified, this parameter is required. + /// + /// Inline script. + /// If no id is specified, this parameter is required. + /// /// public ScriptProcessorDescriptor Source(string? source) { @@ -210,7 +251,10 @@ public ScriptProcessorDescriptor Source(string? source) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public ScriptProcessorDescriptor Tag(string? tag) { @@ -326,7 +370,10 @@ public ScriptProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public ScriptProcessorDescriptor Description(string? description) { @@ -335,7 +382,10 @@ public ScriptProcessorDescriptor Description(string? description) } /// - /// ID of a stored script.
If no `source` is specified, this parameter is required. + /// + /// ID of a stored script. + /// If no source is specified, this parameter is required. + /// /// public ScriptProcessorDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) { @@ -344,7 +394,9 @@ public ScriptProcessorDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public ScriptProcessorDescriptor If(string? value) { @@ -353,7 +405,9 @@ public ScriptProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public ScriptProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -362,7 +416,9 @@ public ScriptProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// Script language. + /// + /// Script language. + /// /// public ScriptProcessorDescriptor Lang(string? lang) { @@ -371,7 +427,9 @@ public ScriptProcessorDescriptor Lang(string? lang) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public ScriptProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -410,7 +468,9 @@ public ScriptProcessorDescriptor OnFailure(params Action - /// Object containing parameters for the script. + /// + /// Object containing parameters for the script. + /// /// public ScriptProcessorDescriptor Params(Func, FluentDictionary> selector) { @@ -419,7 +479,10 @@ public ScriptProcessorDescriptor Params(Func, F } /// - /// Inline script.
If no `id` is specified, this parameter is required. + /// + /// Inline script. + /// If no id is specified, this parameter is required. + /// /// public ScriptProcessorDescriptor Source(string? source) { @@ -428,7 +491,10 @@ public ScriptProcessorDescriptor Source(string? source) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public ScriptProcessorDescriptor Tag(string? tag) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SetProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SetProcessor.g.cs index 47860e13b4c..c858bd62a5b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SetProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SetProcessor.g.cs @@ -30,67 +30,98 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class SetProcessor { /// - /// The origin field which will be copied to `field`, cannot set `value` simultaneously.
Supported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc. + /// + /// The origin field which will be copied to field, cannot set value simultaneously. + /// Supported data types are boolean, number, array, object, string, date, etc. + /// /// [JsonInclude, JsonPropertyName("copy_from")] public Elastic.Clients.Elasticsearch.Field? CopyFrom { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to insert, upsert, or update.
Supports template snippets. + /// + /// The field to insert, upsert, or update. + /// Supports template snippets. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// If `true` and `value` is a template snippet that evaluates to `null` or the empty string, the processor quietly exits without modifying the document. + /// + /// If true and value is a template snippet that evaluates to null or the empty string, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_empty_value")] public bool? IgnoreEmptyValue { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// The media type for encoding `value`.
Applies only when value is a template snippet.
Must be one of `application/json`, `text/plain`, or `application/x-www-form-urlencoded`. + /// + /// The media type for encoding value. + /// Applies only when value is a template snippet. + /// Must be one of application/json, text/plain, or application/x-www-form-urlencoded. + /// /// [JsonInclude, JsonPropertyName("media_type")] public string? MediaType { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// If `true` processor will update fields with pre-existing non-null-valued field.
When set to `false`, such fields will not be touched. + /// + /// If true processor will update fields with pre-existing non-null-valued field. + /// When set to false, such fields will not be touched. + /// /// [JsonInclude, JsonPropertyName("override")] public bool? Override { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The value to be set for the field.
Supports template snippets.
May specify only one of `value` or `copy_from`. + /// + /// The value to be set for the field. + /// Supports template snippets. + /// May specify only one of value or copy_from. + /// /// [JsonInclude, JsonPropertyName("value")] public object? Value { get; set; } @@ -122,7 +153,10 @@ public SetProcessorDescriptor() : base() private object? ValueValue { get; set; } /// - /// The origin field which will be copied to `field`, cannot set `value` simultaneously.
Supported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc. + /// + /// The origin field which will be copied to field, cannot set value simultaneously. + /// Supported data types are boolean, number, array, object, string, date, etc. + /// /// public SetProcessorDescriptor CopyFrom(Elastic.Clients.Elasticsearch.Field? copyFrom) { @@ -131,7 +165,10 @@ public SetProcessorDescriptor CopyFrom(Elastic.Clients.Elasticsearch. } /// - /// The origin field which will be copied to `field`, cannot set `value` simultaneously.
Supported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc. + /// + /// The origin field which will be copied to field, cannot set value simultaneously. + /// Supported data types are boolean, number, array, object, string, date, etc. + /// /// public SetProcessorDescriptor CopyFrom(Expression> copyFrom) { @@ -140,7 +177,10 @@ public SetProcessorDescriptor CopyFrom(Expression - /// The origin field which will be copied to `field`, cannot set `value` simultaneously.
Supported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc. + /// + /// The origin field which will be copied to field, cannot set value simultaneously. + /// Supported data types are boolean, number, array, object, string, date, etc. + /// /// public SetProcessorDescriptor CopyFrom(Expression> copyFrom) { @@ -149,7 +189,10 @@ public SetProcessorDescriptor CopyFrom(Expression - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public SetProcessorDescriptor Description(string? description) { @@ -158,7 +201,10 @@ public SetProcessorDescriptor Description(string? description) } /// - /// The field to insert, upsert, or update.
Supports template snippets. + /// + /// The field to insert, upsert, or update. + /// Supports template snippets. + /// /// public SetProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -167,7 +213,10 @@ public SetProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Fie } /// - /// The field to insert, upsert, or update.
Supports template snippets. + /// + /// The field to insert, upsert, or update. + /// Supports template snippets. + /// /// public SetProcessorDescriptor Field(Expression> field) { @@ -176,7 +225,10 @@ public SetProcessorDescriptor Field(Expression - /// The field to insert, upsert, or update.
Supports template snippets. + /// + /// The field to insert, upsert, or update. + /// Supports template snippets. + /// /// public SetProcessorDescriptor Field(Expression> field) { @@ -185,7 +237,9 @@ public SetProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public SetProcessorDescriptor If(string? value) { @@ -194,7 +248,9 @@ public SetProcessorDescriptor If(string? value) } /// - /// If `true` and `value` is a template snippet that evaluates to `null` or the empty string, the processor quietly exits without modifying the document. + /// + /// If true and value is a template snippet that evaluates to null or the empty string, the processor quietly exits without modifying the document. + /// /// public SetProcessorDescriptor IgnoreEmptyValue(bool? ignoreEmptyValue = true) { @@ -203,7 +259,9 @@ public SetProcessorDescriptor IgnoreEmptyValue(bool? ignoreEmptyValue } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public SetProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -212,7 +270,11 @@ public SetProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tru } /// - /// The media type for encoding `value`.
Applies only when value is a template snippet.
Must be one of `application/json`, `text/plain`, or `application/x-www-form-urlencoded`. + /// + /// The media type for encoding value. + /// Applies only when value is a template snippet. + /// Must be one of application/json, text/plain, or application/x-www-form-urlencoded. + /// /// public SetProcessorDescriptor MediaType(string? mediaType) { @@ -221,7 +283,9 @@ public SetProcessorDescriptor MediaType(string? mediaType) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public SetProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -260,7 +324,10 @@ public SetProcessorDescriptor OnFailure(params Action - /// If `true` processor will update fields with pre-existing non-null-valued field.
When set to `false`, such fields will not be touched. + /// + /// If true processor will update fields with pre-existing non-null-valued field. + /// When set to false, such fields will not be touched. + /// /// public SetProcessorDescriptor Override(bool? value = true) { @@ -269,7 +336,10 @@ public SetProcessorDescriptor Override(bool? value = true) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public SetProcessorDescriptor Tag(string? tag) { @@ -278,7 +348,11 @@ public SetProcessorDescriptor Tag(string? tag) } /// - /// The value to be set for the field.
Supports template snippets.
May specify only one of `value` or `copy_from`. + /// + /// The value to be set for the field. + /// Supports template snippets. + /// May specify only one of value or copy_from. + /// /// public SetProcessorDescriptor Value(object? value) { @@ -404,7 +478,10 @@ public SetProcessorDescriptor() : base() private object? ValueValue { get; set; } /// - /// The origin field which will be copied to `field`, cannot set `value` simultaneously.
Supported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc. + /// + /// The origin field which will be copied to field, cannot set value simultaneously. + /// Supported data types are boolean, number, array, object, string, date, etc. + /// /// public SetProcessorDescriptor CopyFrom(Elastic.Clients.Elasticsearch.Field? copyFrom) { @@ -413,7 +490,10 @@ public SetProcessorDescriptor CopyFrom(Elastic.Clients.Elasticsearch.Field? copy } /// - /// The origin field which will be copied to `field`, cannot set `value` simultaneously.
Supported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc. + /// + /// The origin field which will be copied to field, cannot set value simultaneously. + /// Supported data types are boolean, number, array, object, string, date, etc. + /// /// public SetProcessorDescriptor CopyFrom(Expression> copyFrom) { @@ -422,7 +502,10 @@ public SetProcessorDescriptor CopyFrom(Expression - /// The origin field which will be copied to `field`, cannot set `value` simultaneously.
Supported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc. + /// + /// The origin field which will be copied to field, cannot set value simultaneously. + /// Supported data types are boolean, number, array, object, string, date, etc. + /// /// public SetProcessorDescriptor CopyFrom(Expression> copyFrom) { @@ -431,7 +514,10 @@ public SetProcessorDescriptor CopyFrom(Expression - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public SetProcessorDescriptor Description(string? description) { @@ -440,7 +526,10 @@ public SetProcessorDescriptor Description(string? description) } /// - /// The field to insert, upsert, or update.
Supports template snippets. + /// + /// The field to insert, upsert, or update. + /// Supports template snippets. + /// /// public SetProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -449,7 +538,10 @@ public SetProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) } /// - /// The field to insert, upsert, or update.
Supports template snippets. + /// + /// The field to insert, upsert, or update. + /// Supports template snippets. + /// /// public SetProcessorDescriptor Field(Expression> field) { @@ -458,7 +550,10 @@ public SetProcessorDescriptor Field(Expression - /// The field to insert, upsert, or update.
Supports template snippets. + /// + /// The field to insert, upsert, or update. + /// Supports template snippets. + /// /// public SetProcessorDescriptor Field(Expression> field) { @@ -467,7 +562,9 @@ public SetProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public SetProcessorDescriptor If(string? value) { @@ -476,7 +573,9 @@ public SetProcessorDescriptor If(string? value) } /// - /// If `true` and `value` is a template snippet that evaluates to `null` or the empty string, the processor quietly exits without modifying the document. + /// + /// If true and value is a template snippet that evaluates to null or the empty string, the processor quietly exits without modifying the document. + /// /// public SetProcessorDescriptor IgnoreEmptyValue(bool? ignoreEmptyValue = true) { @@ -485,7 +584,9 @@ public SetProcessorDescriptor IgnoreEmptyValue(bool? ignoreEmptyValue = true) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public SetProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -494,7 +595,11 @@ public SetProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// The media type for encoding `value`.
Applies only when value is a template snippet.
Must be one of `application/json`, `text/plain`, or `application/x-www-form-urlencoded`. + /// + /// The media type for encoding value. + /// Applies only when value is a template snippet. + /// Must be one of application/json, text/plain, or application/x-www-form-urlencoded. + /// /// public SetProcessorDescriptor MediaType(string? mediaType) { @@ -503,7 +608,9 @@ public SetProcessorDescriptor MediaType(string? mediaType) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public SetProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -542,7 +649,10 @@ public SetProcessorDescriptor OnFailure(params Action - /// If `true` processor will update fields with pre-existing non-null-valued field.
When set to `false`, such fields will not be touched. + /// + /// If true processor will update fields with pre-existing non-null-valued field. + /// When set to false, such fields will not be touched. + /// /// public SetProcessorDescriptor Override(bool? value = true) { @@ -551,7 +661,10 @@ public SetProcessorDescriptor Override(bool? value = true) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public SetProcessorDescriptor Tag(string? tag) { @@ -560,7 +673,11 @@ public SetProcessorDescriptor Tag(string? tag) } /// - /// The value to be set for the field.
Supports template snippets.
May specify only one of `value` or `copy_from`. + /// + /// The value to be set for the field. + /// Supports template snippets. + /// May specify only one of value or copy_from. + /// /// public SetProcessorDescriptor Value(object? value) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SetSecurityUserProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SetSecurityUserProcessor.g.cs index b22df385471..b5ffe1a8ec9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SetSecurityUserProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SetSecurityUserProcessor.g.cs @@ -30,43 +30,59 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class SetSecurityUserProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to store the user information into. + /// + /// The field to store the user information into. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Controls what user related properties are added to the field. + /// + /// Controls what user related properties are added to the field. + /// /// [JsonInclude, JsonPropertyName("properties")] public ICollection? Properties { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } @@ -94,7 +110,10 @@ public SetSecurityUserProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public SetSecurityUserProcessorDescriptor Description(string? description) { @@ -103,7 +122,9 @@ public SetSecurityUserProcessorDescriptor Description(string? descrip } /// - /// The field to store the user information into. + /// + /// The field to store the user information into. + /// /// public SetSecurityUserProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -112,7 +133,9 @@ public SetSecurityUserProcessorDescriptor Field(Elastic.Clients.Elast } /// - /// The field to store the user information into. + /// + /// The field to store the user information into. + /// /// public SetSecurityUserProcessorDescriptor Field(Expression> field) { @@ -121,7 +144,9 @@ public SetSecurityUserProcessorDescriptor Field(Expression - /// The field to store the user information into. + /// + /// The field to store the user information into. + /// /// public SetSecurityUserProcessorDescriptor Field(Expression> field) { @@ -130,7 +155,9 @@ public SetSecurityUserProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public SetSecurityUserProcessorDescriptor If(string? value) { @@ -139,7 +166,9 @@ public SetSecurityUserProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public SetSecurityUserProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -148,7 +177,9 @@ public SetSecurityUserProcessorDescriptor IgnoreFailure(bool? ignoreF } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public SetSecurityUserProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -187,7 +218,9 @@ public SetSecurityUserProcessorDescriptor OnFailure(params Action - /// Controls what user related properties are added to the field. + /// + /// Controls what user related properties are added to the field. + /// /// public SetSecurityUserProcessorDescriptor Properties(ICollection? properties) { @@ -196,7 +229,10 @@ public SetSecurityUserProcessorDescriptor Properties(ICollection - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public SetSecurityUserProcessorDescriptor Tag(string? tag) { @@ -294,7 +330,10 @@ public SetSecurityUserProcessorDescriptor() : base() private string? TagValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public SetSecurityUserProcessorDescriptor Description(string? description) { @@ -303,7 +342,9 @@ public SetSecurityUserProcessorDescriptor Description(string? description) } /// - /// The field to store the user information into. + /// + /// The field to store the user information into. + /// /// public SetSecurityUserProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -312,7 +353,9 @@ public SetSecurityUserProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Fi } /// - /// The field to store the user information into. + /// + /// The field to store the user information into. + /// /// public SetSecurityUserProcessorDescriptor Field(Expression> field) { @@ -321,7 +364,9 @@ public SetSecurityUserProcessorDescriptor Field(Expression - /// The field to store the user information into. + /// + /// The field to store the user information into. + /// /// public SetSecurityUserProcessorDescriptor Field(Expression> field) { @@ -330,7 +375,9 @@ public SetSecurityUserProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public SetSecurityUserProcessorDescriptor If(string? value) { @@ -339,7 +386,9 @@ public SetSecurityUserProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public SetSecurityUserProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -348,7 +397,9 @@ public SetSecurityUserProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tr } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public SetSecurityUserProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -387,7 +438,9 @@ public SetSecurityUserProcessorDescriptor OnFailure(params Action - /// Controls what user related properties are added to the field. + /// + /// Controls what user related properties are added to the field. + /// /// public SetSecurityUserProcessorDescriptor Properties(ICollection? properties) { @@ -396,7 +449,10 @@ public SetSecurityUserProcessorDescriptor Properties(ICollection? proper } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public SetSecurityUserProcessorDescriptor Tag(string? tag) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SortProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SortProcessor.g.cs index 5154e11a21d..a332228c4f9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SortProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SortProcessor.g.cs @@ -30,49 +30,69 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class SortProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to be sorted. + /// + /// The field to be sorted. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// The sort order to use.
Accepts `"asc"` or `"desc"`. + /// + /// The sort order to use. + /// Accepts "asc" or "desc". + /// /// [JsonInclude, JsonPropertyName("order")] public Elastic.Clients.Elasticsearch.SortOrder? Order { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field to assign the sorted value to.
By default, the field is updated in-place. + /// + /// The field to assign the sorted value to. + /// By default, the field is updated in-place. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } @@ -101,7 +121,10 @@ public SortProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public SortProcessorDescriptor Description(string? description) { @@ -110,7 +133,9 @@ public SortProcessorDescriptor Description(string? description) } /// - /// The field to be sorted. + /// + /// The field to be sorted. + /// /// public SortProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -119,7 +144,9 @@ public SortProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Fi } /// - /// The field to be sorted. + /// + /// The field to be sorted. + /// /// public SortProcessorDescriptor Field(Expression> field) { @@ -128,7 +155,9 @@ public SortProcessorDescriptor Field(Expression - /// The field to be sorted. + /// + /// The field to be sorted. + /// /// public SortProcessorDescriptor Field(Expression> field) { @@ -137,7 +166,9 @@ public SortProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public SortProcessorDescriptor If(string? value) { @@ -146,7 +177,9 @@ public SortProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public SortProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -155,7 +188,9 @@ public SortProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tr } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public SortProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -194,7 +229,10 @@ public SortProcessorDescriptor OnFailure(params Action - /// The sort order to use.
Accepts `"asc"` or `"desc"`. + /// + /// The sort order to use. + /// Accepts "asc" or "desc". + /// /// public SortProcessorDescriptor Order(Elastic.Clients.Elasticsearch.SortOrder? order) { @@ -203,7 +241,10 @@ public SortProcessorDescriptor Order(Elastic.Clients.Elasticsearch.So } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public SortProcessorDescriptor Tag(string? tag) { @@ -212,7 +253,10 @@ public SortProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the sorted value to.
By default, the field is updated in-place. + /// + /// The field to assign the sorted value to. + /// By default, the field is updated in-place. + /// /// public SortProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -221,7 +265,10 @@ public SortProcessorDescriptor TargetField(Elastic.Clients.Elasticsea } /// - /// The field to assign the sorted value to.
By default, the field is updated in-place. + /// + /// The field to assign the sorted value to. + /// By default, the field is updated in-place. + /// /// public SortProcessorDescriptor TargetField(Expression> targetField) { @@ -230,7 +277,10 @@ public SortProcessorDescriptor TargetField(Expression - /// The field to assign the sorted value to.
By default, the field is updated in-place. + /// + /// The field to assign the sorted value to. + /// By default, the field is updated in-place. + /// /// public SortProcessorDescriptor TargetField(Expression> targetField) { @@ -335,7 +385,10 @@ public SortProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public SortProcessorDescriptor Description(string? description) { @@ -344,7 +397,9 @@ public SortProcessorDescriptor Description(string? description) } /// - /// The field to be sorted. + /// + /// The field to be sorted. + /// /// public SortProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -353,7 +408,9 @@ public SortProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) } /// - /// The field to be sorted. + /// + /// The field to be sorted. + /// /// public SortProcessorDescriptor Field(Expression> field) { @@ -362,7 +419,9 @@ public SortProcessorDescriptor Field(Expression - /// The field to be sorted. + /// + /// The field to be sorted. + /// /// public SortProcessorDescriptor Field(Expression> field) { @@ -371,7 +430,9 @@ public SortProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public SortProcessorDescriptor If(string? value) { @@ -380,7 +441,9 @@ public SortProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public SortProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -389,7 +452,9 @@ public SortProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public SortProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -428,7 +493,10 @@ public SortProcessorDescriptor OnFailure(params Action - /// The sort order to use.
Accepts `"asc"` or `"desc"`. + /// + /// The sort order to use. + /// Accepts "asc" or "desc". + /// /// public SortProcessorDescriptor Order(Elastic.Clients.Elasticsearch.SortOrder? order) { @@ -437,7 +505,10 @@ public SortProcessorDescriptor Order(Elastic.Clients.Elasticsearch.SortOrder? or } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public SortProcessorDescriptor Tag(string? tag) { @@ -446,7 +517,10 @@ public SortProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the sorted value to.
By default, the field is updated in-place. + /// + /// The field to assign the sorted value to. + /// By default, the field is updated in-place. + /// /// public SortProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -455,7 +529,10 @@ public SortProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? } /// - /// The field to assign the sorted value to.
By default, the field is updated in-place. + /// + /// The field to assign the sorted value to. + /// By default, the field is updated in-place. + /// /// public SortProcessorDescriptor TargetField(Expression> targetField) { @@ -464,7 +541,10 @@ public SortProcessorDescriptor TargetField(Expression - /// The field to assign the sorted value to.
By default, the field is updated in-place. + /// + /// The field to assign the sorted value to. + /// By default, the field is updated in-place. + /// /// public SortProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SplitProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SplitProcessor.g.cs index cfe7325c8d9..898d5a4ca31 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SplitProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SplitProcessor.g.cs @@ -30,61 +30,84 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class SplitProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to split. + /// + /// The field to split. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Preserves empty trailing fields, if any. + /// + /// Preserves empty trailing fields, if any. + /// /// [JsonInclude, JsonPropertyName("preserve_trailing")] public bool? PreserveTrailing { get; set; } /// - /// A regex which matches the separator, for example, `,` or `\s+`. + /// + /// A regex which matches the separator, for example, , or \s+. + /// /// [JsonInclude, JsonPropertyName("separator")] public string Separator { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field to assign the split value to.
By default, the field is updated in-place. + /// + /// The field to assign the split value to. + /// By default, the field is updated in-place. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } @@ -115,7 +138,10 @@ public SplitProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public SplitProcessorDescriptor Description(string? description) { @@ -124,7 +150,9 @@ public SplitProcessorDescriptor Description(string? description) } /// - /// The field to split. + /// + /// The field to split. + /// /// public SplitProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -133,7 +161,9 @@ public SplitProcessorDescriptor Field(Elastic.Clients.Elasticsearch.F } /// - /// The field to split. + /// + /// The field to split. + /// /// public SplitProcessorDescriptor Field(Expression> field) { @@ -142,7 +172,9 @@ public SplitProcessorDescriptor Field(Expression - /// The field to split. + /// + /// The field to split. + /// /// public SplitProcessorDescriptor Field(Expression> field) { @@ -151,7 +183,9 @@ public SplitProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public SplitProcessorDescriptor If(string? value) { @@ -160,7 +194,9 @@ public SplitProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public SplitProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -169,7 +205,9 @@ public SplitProcessorDescriptor IgnoreFailure(bool? ignoreFailure = t } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public SplitProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -178,7 +216,9 @@ public SplitProcessorDescriptor IgnoreMissing(bool? ignoreMissing = t } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public SplitProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -217,7 +257,9 @@ public SplitProcessorDescriptor OnFailure(params Action - /// Preserves empty trailing fields, if any. + /// + /// Preserves empty trailing fields, if any. + /// /// public SplitProcessorDescriptor PreserveTrailing(bool? preserveTrailing = true) { @@ -226,7 +268,9 @@ public SplitProcessorDescriptor PreserveTrailing(bool? preserveTraili } /// - /// A regex which matches the separator, for example, `,` or `\s+`. + /// + /// A regex which matches the separator, for example, , or \s+. + /// /// public SplitProcessorDescriptor Separator(string separator) { @@ -235,7 +279,10 @@ public SplitProcessorDescriptor Separator(string separator) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public SplitProcessorDescriptor Tag(string? tag) { @@ -244,7 +291,10 @@ public SplitProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the split value to.
By default, the field is updated in-place. + /// + /// The field to assign the split value to. + /// By default, the field is updated in-place. + /// /// public SplitProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -253,7 +303,10 @@ public SplitProcessorDescriptor TargetField(Elastic.Clients.Elasticse } /// - /// The field to assign the split value to.
By default, the field is updated in-place. + /// + /// The field to assign the split value to. + /// By default, the field is updated in-place. + /// /// public SplitProcessorDescriptor TargetField(Expression> targetField) { @@ -262,7 +315,10 @@ public SplitProcessorDescriptor TargetField(Expression - /// The field to assign the split value to.
By default, the field is updated in-place. + /// + /// The field to assign the split value to. + /// By default, the field is updated in-place. + /// /// public SplitProcessorDescriptor TargetField(Expression> targetField) { @@ -377,7 +433,10 @@ public SplitProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public SplitProcessorDescriptor Description(string? description) { @@ -386,7 +445,9 @@ public SplitProcessorDescriptor Description(string? description) } /// - /// The field to split. + /// + /// The field to split. + /// /// public SplitProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -395,7 +456,9 @@ public SplitProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) } /// - /// The field to split. + /// + /// The field to split. + /// /// public SplitProcessorDescriptor Field(Expression> field) { @@ -404,7 +467,9 @@ public SplitProcessorDescriptor Field(Expression - /// The field to split. + /// + /// The field to split. + /// /// public SplitProcessorDescriptor Field(Expression> field) { @@ -413,7 +478,9 @@ public SplitProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public SplitProcessorDescriptor If(string? value) { @@ -422,7 +489,9 @@ public SplitProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public SplitProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -431,7 +500,9 @@ public SplitProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public SplitProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -440,7 +511,9 @@ public SplitProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public SplitProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -479,7 +552,9 @@ public SplitProcessorDescriptor OnFailure(params Action - /// Preserves empty trailing fields, if any. + /// + /// Preserves empty trailing fields, if any. + /// /// public SplitProcessorDescriptor PreserveTrailing(bool? preserveTrailing = true) { @@ -488,7 +563,9 @@ public SplitProcessorDescriptor PreserveTrailing(bool? preserveTrailing = true) } /// - /// A regex which matches the separator, for example, `,` or `\s+`. + /// + /// A regex which matches the separator, for example, , or \s+. + /// /// public SplitProcessorDescriptor Separator(string separator) { @@ -497,7 +574,10 @@ public SplitProcessorDescriptor Separator(string separator) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public SplitProcessorDescriptor Tag(string? tag) { @@ -506,7 +586,10 @@ public SplitProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the split value to.
By default, the field is updated in-place. + /// + /// The field to assign the split value to. + /// By default, the field is updated in-place. + /// /// public SplitProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -515,7 +598,10 @@ public SplitProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? } /// - /// The field to assign the split value to.
By default, the field is updated in-place. + /// + /// The field to assign the split value to. + /// By default, the field is updated in-place. + /// /// public SplitProcessorDescriptor TargetField(Expression> targetField) { @@ -524,7 +610,10 @@ public SplitProcessorDescriptor TargetField(Expression - /// The field to assign the split value to.
By default, the field is updated in-place. + /// + /// The field to assign the split value to. + /// By default, the field is updated in-place. + /// /// public SplitProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/TrimProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/TrimProcessor.g.cs index a0b542d2823..aba47b0f834 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/TrimProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/TrimProcessor.g.cs @@ -30,49 +30,68 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class TrimProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The string-valued field to trim whitespace from. + /// + /// The string-valued field to trim whitespace from. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field to assign the trimmed value to.
By default, the field is updated in-place. + /// + /// The field to assign the trimmed value to. + /// By default, the field is updated in-place. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } @@ -101,7 +120,10 @@ public TrimProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public TrimProcessorDescriptor Description(string? description) { @@ -110,7 +132,9 @@ public TrimProcessorDescriptor Description(string? description) } /// - /// The string-valued field to trim whitespace from. + /// + /// The string-valued field to trim whitespace from. + /// /// public TrimProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -119,7 +143,9 @@ public TrimProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Fi } /// - /// The string-valued field to trim whitespace from. + /// + /// The string-valued field to trim whitespace from. + /// /// public TrimProcessorDescriptor Field(Expression> field) { @@ -128,7 +154,9 @@ public TrimProcessorDescriptor Field(Expression - /// The string-valued field to trim whitespace from. + /// + /// The string-valued field to trim whitespace from. + /// /// public TrimProcessorDescriptor Field(Expression> field) { @@ -137,7 +165,9 @@ public TrimProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public TrimProcessorDescriptor If(string? value) { @@ -146,7 +176,9 @@ public TrimProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public TrimProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -155,7 +187,9 @@ public TrimProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tr } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public TrimProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -164,7 +198,9 @@ public TrimProcessorDescriptor IgnoreMissing(bool? ignoreMissing = tr } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public TrimProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -203,7 +239,10 @@ public TrimProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public TrimProcessorDescriptor Tag(string? tag) { @@ -212,7 +251,10 @@ public TrimProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the trimmed value to.
By default, the field is updated in-place. + /// + /// The field to assign the trimmed value to. + /// By default, the field is updated in-place. + /// /// public TrimProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -221,7 +263,10 @@ public TrimProcessorDescriptor TargetField(Elastic.Clients.Elasticsea } /// - /// The field to assign the trimmed value to.
By default, the field is updated in-place. + /// + /// The field to assign the trimmed value to. + /// By default, the field is updated in-place. + /// /// public TrimProcessorDescriptor TargetField(Expression> targetField) { @@ -230,7 +275,10 @@ public TrimProcessorDescriptor TargetField(Expression - /// The field to assign the trimmed value to.
By default, the field is updated in-place. + /// + /// The field to assign the trimmed value to. + /// By default, the field is updated in-place. + /// /// public TrimProcessorDescriptor TargetField(Expression> targetField) { @@ -335,7 +383,10 @@ public TrimProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public TrimProcessorDescriptor Description(string? description) { @@ -344,7 +395,9 @@ public TrimProcessorDescriptor Description(string? description) } /// - /// The string-valued field to trim whitespace from. + /// + /// The string-valued field to trim whitespace from. + /// /// public TrimProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -353,7 +406,9 @@ public TrimProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) } /// - /// The string-valued field to trim whitespace from. + /// + /// The string-valued field to trim whitespace from. + /// /// public TrimProcessorDescriptor Field(Expression> field) { @@ -362,7 +417,9 @@ public TrimProcessorDescriptor Field(Expression - /// The string-valued field to trim whitespace from. + /// + /// The string-valued field to trim whitespace from. + /// /// public TrimProcessorDescriptor Field(Expression> field) { @@ -371,7 +428,9 @@ public TrimProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public TrimProcessorDescriptor If(string? value) { @@ -380,7 +439,9 @@ public TrimProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public TrimProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -389,7 +450,9 @@ public TrimProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public TrimProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -398,7 +461,9 @@ public TrimProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public TrimProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -437,7 +502,10 @@ public TrimProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public TrimProcessorDescriptor Tag(string? tag) { @@ -446,7 +514,10 @@ public TrimProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the trimmed value to.
By default, the field is updated in-place. + /// + /// The field to assign the trimmed value to. + /// By default, the field is updated in-place. + /// /// public TrimProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -455,7 +526,10 @@ public TrimProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? } /// - /// The field to assign the trimmed value to.
By default, the field is updated in-place. + /// + /// The field to assign the trimmed value to. + /// By default, the field is updated in-place. + /// /// public TrimProcessorDescriptor TargetField(Expression> targetField) { @@ -464,7 +538,10 @@ public TrimProcessorDescriptor TargetField(Expression - /// The field to assign the trimmed value to.
By default, the field is updated in-place. + /// + /// The field to assign the trimmed value to. + /// By default, the field is updated in-place. + /// /// public TrimProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/UppercaseProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/UppercaseProcessor.g.cs index 34d6b6123d3..0b519e7e494 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/UppercaseProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/UppercaseProcessor.g.cs @@ -30,49 +30,68 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class UppercaseProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to make uppercase. + /// + /// The field to make uppercase. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } @@ -101,7 +120,10 @@ public UppercaseProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public UppercaseProcessorDescriptor Description(string? description) { @@ -110,7 +132,9 @@ public UppercaseProcessorDescriptor Description(string? description) } /// - /// The field to make uppercase. + /// + /// The field to make uppercase. + /// /// public UppercaseProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -119,7 +143,9 @@ public UppercaseProcessorDescriptor Field(Elastic.Clients.Elasticsear } /// - /// The field to make uppercase. + /// + /// The field to make uppercase. + /// /// public UppercaseProcessorDescriptor Field(Expression> field) { @@ -128,7 +154,9 @@ public UppercaseProcessorDescriptor Field(Expression - /// The field to make uppercase. + /// + /// The field to make uppercase. + /// /// public UppercaseProcessorDescriptor Field(Expression> field) { @@ -137,7 +165,9 @@ public UppercaseProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public UppercaseProcessorDescriptor If(string? value) { @@ -146,7 +176,9 @@ public UppercaseProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public UppercaseProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -155,7 +187,9 @@ public UppercaseProcessorDescriptor IgnoreFailure(bool? ignoreFailure } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public UppercaseProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -164,7 +198,9 @@ public UppercaseProcessorDescriptor IgnoreMissing(bool? ignoreMissing } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public UppercaseProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -203,7 +239,10 @@ public UppercaseProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public UppercaseProcessorDescriptor Tag(string? tag) { @@ -212,7 +251,10 @@ public UppercaseProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public UppercaseProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -221,7 +263,10 @@ public UppercaseProcessorDescriptor TargetField(Elastic.Clients.Elast } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public UppercaseProcessorDescriptor TargetField(Expression> targetField) { @@ -230,7 +275,10 @@ public UppercaseProcessorDescriptor TargetField(Expression - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public UppercaseProcessorDescriptor TargetField(Expression> targetField) { @@ -335,7 +383,10 @@ public UppercaseProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public UppercaseProcessorDescriptor Description(string? description) { @@ -344,7 +395,9 @@ public UppercaseProcessorDescriptor Description(string? description) } /// - /// The field to make uppercase. + /// + /// The field to make uppercase. + /// /// public UppercaseProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -353,7 +406,9 @@ public UppercaseProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field fi } /// - /// The field to make uppercase. + /// + /// The field to make uppercase. + /// /// public UppercaseProcessorDescriptor Field(Expression> field) { @@ -362,7 +417,9 @@ public UppercaseProcessorDescriptor Field(Expression - /// The field to make uppercase. + /// + /// The field to make uppercase. + /// /// public UppercaseProcessorDescriptor Field(Expression> field) { @@ -371,7 +428,9 @@ public UppercaseProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public UppercaseProcessorDescriptor If(string? value) { @@ -380,7 +439,9 @@ public UppercaseProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public UppercaseProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -389,7 +450,9 @@ public UppercaseProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public UppercaseProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -398,7 +461,9 @@ public UppercaseProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public UppercaseProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -437,7 +502,10 @@ public UppercaseProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public UppercaseProcessorDescriptor Tag(string? tag) { @@ -446,7 +514,10 @@ public UppercaseProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public UppercaseProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -455,7 +526,10 @@ public UppercaseProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Fi } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public UppercaseProcessorDescriptor TargetField(Expression> targetField) { @@ -464,7 +538,10 @@ public UppercaseProcessorDescriptor TargetField(Expression - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public UppercaseProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/UrlDecodeProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/UrlDecodeProcessor.g.cs index cf145fbd071..c851950f904 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/UrlDecodeProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/UrlDecodeProcessor.g.cs @@ -30,49 +30,68 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class UrlDecodeProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field to decode. + /// + /// The field to decode. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } @@ -101,7 +120,10 @@ public UrlDecodeProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public UrlDecodeProcessorDescriptor Description(string? description) { @@ -110,7 +132,9 @@ public UrlDecodeProcessorDescriptor Description(string? description) } /// - /// The field to decode. + /// + /// The field to decode. + /// /// public UrlDecodeProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -119,7 +143,9 @@ public UrlDecodeProcessorDescriptor Field(Elastic.Clients.Elasticsear } /// - /// The field to decode. + /// + /// The field to decode. + /// /// public UrlDecodeProcessorDescriptor Field(Expression> field) { @@ -128,7 +154,9 @@ public UrlDecodeProcessorDescriptor Field(Expression - /// The field to decode. + /// + /// The field to decode. + /// /// public UrlDecodeProcessorDescriptor Field(Expression> field) { @@ -137,7 +165,9 @@ public UrlDecodeProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public UrlDecodeProcessorDescriptor If(string? value) { @@ -146,7 +176,9 @@ public UrlDecodeProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public UrlDecodeProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -155,7 +187,9 @@ public UrlDecodeProcessorDescriptor IgnoreFailure(bool? ignoreFailure } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public UrlDecodeProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -164,7 +198,9 @@ public UrlDecodeProcessorDescriptor IgnoreMissing(bool? ignoreMissing } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public UrlDecodeProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -203,7 +239,10 @@ public UrlDecodeProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public UrlDecodeProcessorDescriptor Tag(string? tag) { @@ -212,7 +251,10 @@ public UrlDecodeProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public UrlDecodeProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -221,7 +263,10 @@ public UrlDecodeProcessorDescriptor TargetField(Elastic.Clients.Elast } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public UrlDecodeProcessorDescriptor TargetField(Expression> targetField) { @@ -230,7 +275,10 @@ public UrlDecodeProcessorDescriptor TargetField(Expression - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public UrlDecodeProcessorDescriptor TargetField(Expression> targetField) { @@ -335,7 +383,10 @@ public UrlDecodeProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public UrlDecodeProcessorDescriptor Description(string? description) { @@ -344,7 +395,9 @@ public UrlDecodeProcessorDescriptor Description(string? description) } /// - /// The field to decode. + /// + /// The field to decode. + /// /// public UrlDecodeProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -353,7 +406,9 @@ public UrlDecodeProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field fi } /// - /// The field to decode. + /// + /// The field to decode. + /// /// public UrlDecodeProcessorDescriptor Field(Expression> field) { @@ -362,7 +417,9 @@ public UrlDecodeProcessorDescriptor Field(Expression - /// The field to decode. + /// + /// The field to decode. + /// /// public UrlDecodeProcessorDescriptor Field(Expression> field) { @@ -371,7 +428,9 @@ public UrlDecodeProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public UrlDecodeProcessorDescriptor If(string? value) { @@ -380,7 +439,9 @@ public UrlDecodeProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public UrlDecodeProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -389,7 +450,9 @@ public UrlDecodeProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist or is null, the processor quietly exits without modifying the document. + /// /// public UrlDecodeProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -398,7 +461,9 @@ public UrlDecodeProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public UrlDecodeProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -437,7 +502,10 @@ public UrlDecodeProcessorDescriptor OnFailure(params Action - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public UrlDecodeProcessorDescriptor Tag(string? tag) { @@ -446,7 +514,10 @@ public UrlDecodeProcessorDescriptor Tag(string? tag) } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public UrlDecodeProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -455,7 +526,10 @@ public UrlDecodeProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Fi } /// - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public UrlDecodeProcessorDescriptor TargetField(Expression> targetField) { @@ -464,7 +538,10 @@ public UrlDecodeProcessorDescriptor TargetField(Expression - /// The field to assign the converted value to.
By default, the field is updated in-place. + /// + /// The field to assign the converted value to. + /// By default, the field is updated in-place. + /// /// public UrlDecodeProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/UserAgentProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/UserAgentProcessor.g.cs index d8c4fbf32a3..d1ea59a81d4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/UserAgentProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/UserAgentProcessor.g.cs @@ -30,37 +30,50 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class UserAgentProcessor { /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } /// - /// The field containing the user agent string. + /// + /// The field containing the user agent string. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } @@ -68,19 +81,26 @@ public sealed partial class UserAgentProcessor public ICollection? Options { get; set; } /// - /// The name of the file in the `config/ingest-user-agent` directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Elasticsearch. If not specified, ingest-user-agent will use the `regexes.yaml` from uap-core it ships with. + /// + /// The name of the file in the config/ingest-user-agent directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Elasticsearch. If not specified, ingest-user-agent will use the regexes.yaml from uap-core it ships with. + /// /// [JsonInclude, JsonPropertyName("regex_file")] public string? RegexFile { get; set; } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } /// - /// The field that will be filled with the user agent details. + /// + /// The field that will be filled with the user agent details. + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } @@ -111,7 +131,10 @@ public UserAgentProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public UserAgentProcessorDescriptor Description(string? description) { @@ -120,7 +143,9 @@ public UserAgentProcessorDescriptor Description(string? description) } /// - /// The field containing the user agent string. + /// + /// The field containing the user agent string. + /// /// public UserAgentProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -129,7 +154,9 @@ public UserAgentProcessorDescriptor Field(Elastic.Clients.Elasticsear } /// - /// The field containing the user agent string. + /// + /// The field containing the user agent string. + /// /// public UserAgentProcessorDescriptor Field(Expression> field) { @@ -138,7 +165,9 @@ public UserAgentProcessorDescriptor Field(Expression - /// The field containing the user agent string. + /// + /// The field containing the user agent string. + /// /// public UserAgentProcessorDescriptor Field(Expression> field) { @@ -147,7 +176,9 @@ public UserAgentProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public UserAgentProcessorDescriptor If(string? value) { @@ -156,7 +187,9 @@ public UserAgentProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public UserAgentProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -165,7 +198,9 @@ public UserAgentProcessorDescriptor IgnoreFailure(bool? ignoreFailure } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public UserAgentProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -174,7 +209,9 @@ public UserAgentProcessorDescriptor IgnoreMissing(bool? ignoreMissing } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public UserAgentProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -219,7 +256,9 @@ public UserAgentProcessorDescriptor Options(ICollection - /// The name of the file in the `config/ingest-user-agent` directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Elasticsearch. If not specified, ingest-user-agent will use the `regexes.yaml` from uap-core it ships with. + /// + /// The name of the file in the config/ingest-user-agent directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Elasticsearch. If not specified, ingest-user-agent will use the regexes.yaml from uap-core it ships with. + /// /// public UserAgentProcessorDescriptor RegexFile(string? regexFile) { @@ -228,7 +267,10 @@ public UserAgentProcessorDescriptor RegexFile(string? regexFile) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public UserAgentProcessorDescriptor Tag(string? tag) { @@ -237,7 +279,9 @@ public UserAgentProcessorDescriptor Tag(string? tag) } /// - /// The field that will be filled with the user agent details. + /// + /// The field that will be filled with the user agent details. + /// /// public UserAgentProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -246,7 +290,9 @@ public UserAgentProcessorDescriptor TargetField(Elastic.Clients.Elast } /// - /// The field that will be filled with the user agent details. + /// + /// The field that will be filled with the user agent details. + /// /// public UserAgentProcessorDescriptor TargetField(Expression> targetField) { @@ -255,7 +301,9 @@ public UserAgentProcessorDescriptor TargetField(Expression - /// The field that will be filled with the user agent details. + /// + /// The field that will be filled with the user agent details. + /// /// public UserAgentProcessorDescriptor TargetField(Expression> targetField) { @@ -374,7 +422,10 @@ public UserAgentProcessorDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } /// - /// Description of the processor.
Useful for describing the purpose of the processor or its configuration. + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// /// public UserAgentProcessorDescriptor Description(string? description) { @@ -383,7 +434,9 @@ public UserAgentProcessorDescriptor Description(string? description) } /// - /// The field containing the user agent string. + /// + /// The field containing the user agent string. + /// /// public UserAgentProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -392,7 +445,9 @@ public UserAgentProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field fi } /// - /// The field containing the user agent string. + /// + /// The field containing the user agent string. + /// /// public UserAgentProcessorDescriptor Field(Expression> field) { @@ -401,7 +456,9 @@ public UserAgentProcessorDescriptor Field(Expression - /// The field containing the user agent string. + /// + /// The field containing the user agent string. + /// /// public UserAgentProcessorDescriptor Field(Expression> field) { @@ -410,7 +467,9 @@ public UserAgentProcessorDescriptor Field(Expression - /// Conditionally execute the processor. + /// + /// Conditionally execute the processor. + /// /// public UserAgentProcessorDescriptor If(string? value) { @@ -419,7 +478,9 @@ public UserAgentProcessorDescriptor If(string? value) } /// - /// Ignore failures for the processor. + /// + /// Ignore failures for the processor. + /// /// public UserAgentProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) { @@ -428,7 +489,9 @@ public UserAgentProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) } /// - /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// /// public UserAgentProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { @@ -437,7 +500,9 @@ public UserAgentProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) } /// - /// Handle failures for the processor. + /// + /// Handle failures for the processor. + /// /// public UserAgentProcessorDescriptor OnFailure(ICollection? onFailure) { @@ -482,7 +547,9 @@ public UserAgentProcessorDescriptor Options(ICollection - /// The name of the file in the `config/ingest-user-agent` directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Elasticsearch. If not specified, ingest-user-agent will use the `regexes.yaml` from uap-core it ships with. + /// + /// The name of the file in the config/ingest-user-agent directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Elasticsearch. If not specified, ingest-user-agent will use the regexes.yaml from uap-core it ships with. + /// /// public UserAgentProcessorDescriptor RegexFile(string? regexFile) { @@ -491,7 +558,10 @@ public UserAgentProcessorDescriptor RegexFile(string? regexFile) } /// - /// Identifier for the processor.
Useful for debugging and metrics. + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// /// public UserAgentProcessorDescriptor Tag(string? tag) { @@ -500,7 +570,9 @@ public UserAgentProcessorDescriptor Tag(string? tag) } /// - /// The field that will be filled with the user agent details. + /// + /// The field that will be filled with the user agent details. + /// /// public UserAgentProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -509,7 +581,9 @@ public UserAgentProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Fi } /// - /// The field that will be filled with the user agent details. + /// + /// The field that will be filled with the user agent details. + /// /// public UserAgentProcessorDescriptor TargetField(Expression> targetField) { @@ -518,7 +592,9 @@ public UserAgentProcessorDescriptor TargetField(Expression - /// The field that will be filled with the user agent details. + /// + /// The field that will be filled with the user agent details. + /// /// public UserAgentProcessorDescriptor TargetField(Expression> targetField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/InlineGet.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/InlineGet.g.cs index 9be338fb787..8a7a7d95cd3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/InlineGet.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/InlineGet.g.cs @@ -103,7 +103,9 @@ public sealed partial class InlineGet public bool Found { get; init; } /// - /// Document metadata + /// + /// Document metadata + /// /// public IReadOnlyDictionary Metadata { get; init; } public long? PrimaryTerm { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/KnnQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/KnnQuery.g.cs index 70484f24595..5634711eafa 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/KnnQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/KnnQuery.g.cs @@ -30,26 +30,37 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class KnnQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// The name of the vector field to search against + /// + /// The name of the vector field to search against + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Filters for the kNN search query + /// + /// Filters for the kNN search query + /// /// [JsonInclude, JsonPropertyName("filter")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.QueryDsl.Query))] public ICollection? Filter { get; set; } /// - /// The number of nearest neighbor candidates to consider per shard + /// + /// The number of nearest neighbor candidates to consider per shard + /// /// [JsonInclude, JsonPropertyName("num_candidates")] public int? NumCandidates { get; set; } @@ -57,19 +68,25 @@ public sealed partial class KnnQuery public string? QueryName { get; set; } /// - /// The query vector + /// + /// The query vector + /// /// [JsonInclude, JsonPropertyName("query_vector")] public ICollection? QueryVector { get; set; } /// - /// The query vector builder. You must provide a query_vector_builder or query_vector, but not both. + /// + /// The query vector builder. You must provide a query_vector_builder or query_vector, but not both. + /// /// [JsonInclude, JsonPropertyName("query_vector_builder")] public Elastic.Clients.Elasticsearch.QueryVectorBuilder? QueryVectorBuilder { get; set; } /// - /// The minimum similarity for a vector to be considered a match + /// + /// The minimum similarity for a vector to be considered a match + /// /// [JsonInclude, JsonPropertyName("similarity")] public float? Similarity { get; set; } @@ -100,7 +117,12 @@ public KnnQueryDescriptor() : base() private float? SimilarityValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public KnnQueryDescriptor Boost(float? boost) { @@ -109,7 +131,9 @@ public KnnQueryDescriptor Boost(float? boost) } /// - /// The name of the vector field to search against + /// + /// The name of the vector field to search against + /// /// public KnnQueryDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -118,7 +142,9 @@ public KnnQueryDescriptor Field(Elastic.Clients.Elasticsearch.Field f } /// - /// The name of the vector field to search against + /// + /// The name of the vector field to search against + /// /// public KnnQueryDescriptor Field(Expression> field) { @@ -127,7 +153,9 @@ public KnnQueryDescriptor Field(Expression - /// The name of the vector field to search against + /// + /// The name of the vector field to search against + /// /// public KnnQueryDescriptor Field(Expression> field) { @@ -136,7 +164,9 @@ public KnnQueryDescriptor Field(Expression> f } /// - /// Filters for the kNN search query + /// + /// Filters for the kNN search query + /// /// public KnnQueryDescriptor Filter(ICollection? filter) { @@ -175,7 +205,9 @@ public KnnQueryDescriptor Filter(params Action - /// The number of nearest neighbor candidates to consider per shard + /// + /// The number of nearest neighbor candidates to consider per shard + /// /// public KnnQueryDescriptor NumCandidates(int? numCandidates) { @@ -190,7 +222,9 @@ public KnnQueryDescriptor QueryName(string? queryName) } /// - /// The query vector + /// + /// The query vector + /// /// public KnnQueryDescriptor QueryVector(ICollection? queryVector) { @@ -199,7 +233,9 @@ public KnnQueryDescriptor QueryVector(ICollection? queryVector } /// - /// The query vector builder. You must provide a query_vector_builder or query_vector, but not both. + /// + /// The query vector builder. You must provide a query_vector_builder or query_vector, but not both. + /// /// public KnnQueryDescriptor QueryVectorBuilder(Elastic.Clients.Elasticsearch.QueryVectorBuilder? queryVectorBuilder) { @@ -226,7 +262,9 @@ public KnnQueryDescriptor QueryVectorBuilder(Action - /// The minimum similarity for a vector to be considered a match + /// + /// The minimum similarity for a vector to be considered a match + /// /// public KnnQueryDescriptor Similarity(float? similarity) { @@ -341,7 +379,12 @@ public KnnQueryDescriptor() : base() private float? SimilarityValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public KnnQueryDescriptor Boost(float? boost) { @@ -350,7 +393,9 @@ public KnnQueryDescriptor Boost(float? boost) } /// - /// The name of the vector field to search against + /// + /// The name of the vector field to search against + /// /// public KnnQueryDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -359,7 +404,9 @@ public KnnQueryDescriptor Field(Elastic.Clients.Elasticsearch.Field field) } /// - /// The name of the vector field to search against + /// + /// The name of the vector field to search against + /// /// public KnnQueryDescriptor Field(Expression> field) { @@ -368,7 +415,9 @@ public KnnQueryDescriptor Field(Expression - /// The name of the vector field to search against + /// + /// The name of the vector field to search against + /// /// public KnnQueryDescriptor Field(Expression> field) { @@ -377,7 +426,9 @@ public KnnQueryDescriptor Field(Expression> f } /// - /// Filters for the kNN search query + /// + /// Filters for the kNN search query + /// /// public KnnQueryDescriptor Filter(ICollection? filter) { @@ -416,7 +467,9 @@ public KnnQueryDescriptor Filter(params Action - /// The number of nearest neighbor candidates to consider per shard + /// + /// The number of nearest neighbor candidates to consider per shard + /// /// public KnnQueryDescriptor NumCandidates(int? numCandidates) { @@ -431,7 +484,9 @@ public KnnQueryDescriptor QueryName(string? queryName) } /// - /// The query vector + /// + /// The query vector + /// /// public KnnQueryDescriptor QueryVector(ICollection? queryVector) { @@ -440,7 +495,9 @@ public KnnQueryDescriptor QueryVector(ICollection? queryVector) } /// - /// The query vector builder. You must provide a query_vector_builder or query_vector, but not both. + /// + /// The query vector builder. You must provide a query_vector_builder or query_vector, but not both. + /// /// public KnnQueryDescriptor QueryVectorBuilder(Elastic.Clients.Elasticsearch.QueryVectorBuilder? queryVectorBuilder) { @@ -467,7 +524,9 @@ public KnnQueryDescriptor QueryVectorBuilder(Action - /// The minimum similarity for a vector to be considered a match + /// + /// The minimum similarity for a vector to be considered a match + /// /// public KnnQueryDescriptor Similarity(float? similarity) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/KnnRetriever.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/KnnRetriever.g.cs index d4e4c54d709..bd289b0d994 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/KnnRetriever.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/KnnRetriever.g.cs @@ -30,44 +30,58 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class KnnRetriever { /// - /// The name of the vector field to search against. + /// + /// The name of the vector field to search against. + /// /// [JsonInclude, JsonPropertyName("field")] public string Field { get; set; } /// - /// Query to filter the documents that can match. + /// + /// Query to filter the documents that can match. + /// /// [JsonInclude, JsonPropertyName("filter")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.QueryDsl.Query))] public ICollection? Filter { get; set; } /// - /// Number of nearest neighbors to return as top hits. + /// + /// Number of nearest neighbors to return as top hits. + /// /// [JsonInclude, JsonPropertyName("k")] public int k { get; set; } /// - /// Number of nearest neighbor candidates to consider per shard. + /// + /// Number of nearest neighbor candidates to consider per shard. + /// /// [JsonInclude, JsonPropertyName("num_candidates")] public int NumCandidates { get; set; } /// - /// Query vector. Must have the same number of dimensions as the vector field you are searching against. You must provide a query_vector_builder or query_vector, but not both. + /// + /// Query vector. Must have the same number of dimensions as the vector field you are searching against. You must provide a query_vector_builder or query_vector, but not both. + /// /// [JsonInclude, JsonPropertyName("query_vector")] public ICollection? QueryVector { get; set; } /// - /// Defines a model to build a query vector. + /// + /// Defines a model to build a query vector. + /// /// [JsonInclude, JsonPropertyName("query_vector_builder")] public Elastic.Clients.Elasticsearch.QueryVectorBuilder? QueryVectorBuilder { get; set; } /// - /// The minimum similarity required for a document to be considered a match. + /// + /// The minimum similarity required for a document to be considered a match. + /// /// [JsonInclude, JsonPropertyName("similarity")] public float? Similarity { get; set; } @@ -97,7 +111,9 @@ public KnnRetrieverDescriptor() : base() private float? SimilarityValue { get; set; } /// - /// The name of the vector field to search against. + /// + /// The name of the vector field to search against. + /// /// public KnnRetrieverDescriptor Field(string field) { @@ -106,7 +122,9 @@ public KnnRetrieverDescriptor Field(string field) } /// - /// Query to filter the documents that can match. + /// + /// Query to filter the documents that can match. + /// /// public KnnRetrieverDescriptor Filter(ICollection? filter) { @@ -145,7 +163,9 @@ public KnnRetrieverDescriptor Filter(params Action - /// Number of nearest neighbors to return as top hits. + /// + /// Number of nearest neighbors to return as top hits. + /// /// public KnnRetrieverDescriptor k(int k) { @@ -154,7 +174,9 @@ public KnnRetrieverDescriptor k(int k) } /// - /// Number of nearest neighbor candidates to consider per shard. + /// + /// Number of nearest neighbor candidates to consider per shard. + /// /// public KnnRetrieverDescriptor NumCandidates(int numCandidates) { @@ -163,7 +185,9 @@ public KnnRetrieverDescriptor NumCandidates(int numCandidates) } /// - /// Query vector. Must have the same number of dimensions as the vector field you are searching against. You must provide a query_vector_builder or query_vector, but not both. + /// + /// Query vector. Must have the same number of dimensions as the vector field you are searching against. You must provide a query_vector_builder or query_vector, but not both. + /// /// public KnnRetrieverDescriptor QueryVector(ICollection? queryVector) { @@ -172,7 +196,9 @@ public KnnRetrieverDescriptor QueryVector(ICollection? queryVe } /// - /// Defines a model to build a query vector. + /// + /// Defines a model to build a query vector. + /// /// public KnnRetrieverDescriptor QueryVectorBuilder(Elastic.Clients.Elasticsearch.QueryVectorBuilder? queryVectorBuilder) { @@ -199,7 +225,9 @@ public KnnRetrieverDescriptor QueryVectorBuilder(Action - /// The minimum similarity required for a document to be considered a match. + /// + /// The minimum similarity required for a document to be considered a match. + /// /// public KnnRetrieverDescriptor Similarity(float? similarity) { @@ -299,7 +327,9 @@ public KnnRetrieverDescriptor() : base() private float? SimilarityValue { get; set; } /// - /// The name of the vector field to search against. + /// + /// The name of the vector field to search against. + /// /// public KnnRetrieverDescriptor Field(string field) { @@ -308,7 +338,9 @@ public KnnRetrieverDescriptor Field(string field) } /// - /// Query to filter the documents that can match. + /// + /// Query to filter the documents that can match. + /// /// public KnnRetrieverDescriptor Filter(ICollection? filter) { @@ -347,7 +379,9 @@ public KnnRetrieverDescriptor Filter(params Action - /// Number of nearest neighbors to return as top hits. + /// + /// Number of nearest neighbors to return as top hits. + /// /// public KnnRetrieverDescriptor k(int k) { @@ -356,7 +390,9 @@ public KnnRetrieverDescriptor k(int k) } /// - /// Number of nearest neighbor candidates to consider per shard. + /// + /// Number of nearest neighbor candidates to consider per shard. + /// /// public KnnRetrieverDescriptor NumCandidates(int numCandidates) { @@ -365,7 +401,9 @@ public KnnRetrieverDescriptor NumCandidates(int numCandidates) } /// - /// Query vector. Must have the same number of dimensions as the vector field you are searching against. You must provide a query_vector_builder or query_vector, but not both. + /// + /// Query vector. Must have the same number of dimensions as the vector field you are searching against. You must provide a query_vector_builder or query_vector, but not both. + /// /// public KnnRetrieverDescriptor QueryVector(ICollection? queryVector) { @@ -374,7 +412,9 @@ public KnnRetrieverDescriptor QueryVector(ICollection? queryVector) } /// - /// Defines a model to build a query vector. + /// + /// Defines a model to build a query vector. + /// /// public KnnRetrieverDescriptor QueryVectorBuilder(Elastic.Clients.Elasticsearch.QueryVectorBuilder? queryVectorBuilder) { @@ -401,7 +441,9 @@ public KnnRetrieverDescriptor QueryVectorBuilder(Action - /// The minimum similarity required for a document to be considered a match. + /// + /// The minimum similarity required for a document to be considered a match. + /// /// public KnnRetrieverDescriptor Similarity(float? similarity) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/KnnSearch.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/KnnSearch.g.cs index b83a98fa2f7..a3a664f8101 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/KnnSearch.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/KnnSearch.g.cs @@ -30,56 +30,74 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class KnnSearch { /// - /// Boost value to apply to kNN scores + /// + /// Boost value to apply to kNN scores + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// The name of the vector field to search against + /// + /// The name of the vector field to search against + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Filters for the kNN search query + /// + /// Filters for the kNN search query + /// /// [JsonInclude, JsonPropertyName("filter")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.QueryDsl.Query))] public ICollection? Filter { get; set; } /// - /// If defined, each search hit will contain inner hits. + /// + /// If defined, each search hit will contain inner hits. + /// /// [JsonInclude, JsonPropertyName("inner_hits")] public Elastic.Clients.Elasticsearch.Core.Search.InnerHits? InnerHits { get; set; } /// - /// The final number of nearest neighbors to return as top hits + /// + /// The final number of nearest neighbors to return as top hits + /// /// [JsonInclude, JsonPropertyName("k")] public int? k { get; set; } /// - /// The number of nearest neighbor candidates to consider per shard + /// + /// The number of nearest neighbor candidates to consider per shard + /// /// [JsonInclude, JsonPropertyName("num_candidates")] public int? NumCandidates { get; set; } /// - /// The query vector + /// + /// The query vector + /// /// [JsonInclude, JsonPropertyName("query_vector")] public ICollection? QueryVector { get; set; } /// - /// The query vector builder. You must provide a query_vector_builder or query_vector, but not both. + /// + /// The query vector builder. You must provide a query_vector_builder or query_vector, but not both. + /// /// [JsonInclude, JsonPropertyName("query_vector_builder")] public Elastic.Clients.Elasticsearch.QueryVectorBuilder? QueryVectorBuilder { get; set; } /// - /// The minimum similarity for a vector to be considered a match + /// + /// The minimum similarity for a vector to be considered a match + /// /// [JsonInclude, JsonPropertyName("similarity")] public float? Similarity { get; set; } @@ -111,7 +129,9 @@ public KnnSearchDescriptor() : base() private float? SimilarityValue { get; set; } /// - /// Boost value to apply to kNN scores + /// + /// Boost value to apply to kNN scores + /// /// public KnnSearchDescriptor Boost(float? boost) { @@ -120,7 +140,9 @@ public KnnSearchDescriptor Boost(float? boost) } /// - /// The name of the vector field to search against + /// + /// The name of the vector field to search against + /// /// public KnnSearchDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -129,7 +151,9 @@ public KnnSearchDescriptor Field(Elastic.Clients.Elasticsearch.Field } /// - /// The name of the vector field to search against + /// + /// The name of the vector field to search against + /// /// public KnnSearchDescriptor Field(Expression> field) { @@ -138,7 +162,9 @@ public KnnSearchDescriptor Field(Expression - /// The name of the vector field to search against + /// + /// The name of the vector field to search against + /// /// public KnnSearchDescriptor Field(Expression> field) { @@ -147,7 +173,9 @@ public KnnSearchDescriptor Field(Expression> } /// - /// Filters for the kNN search query + /// + /// Filters for the kNN search query + /// /// public KnnSearchDescriptor Filter(ICollection? filter) { @@ -186,7 +214,9 @@ public KnnSearchDescriptor Filter(params Action - /// If defined, each search hit will contain inner hits. + /// + /// If defined, each search hit will contain inner hits. + /// /// public KnnSearchDescriptor InnerHits(Elastic.Clients.Elasticsearch.Core.Search.InnerHits? innerHits) { @@ -213,7 +243,9 @@ public KnnSearchDescriptor InnerHits(Action - /// The final number of nearest neighbors to return as top hits + /// + /// The final number of nearest neighbors to return as top hits + /// /// public KnnSearchDescriptor k(int? k) { @@ -222,7 +254,9 @@ public KnnSearchDescriptor k(int? k) } /// - /// The number of nearest neighbor candidates to consider per shard + /// + /// The number of nearest neighbor candidates to consider per shard + /// /// public KnnSearchDescriptor NumCandidates(int? numCandidates) { @@ -231,7 +265,9 @@ public KnnSearchDescriptor NumCandidates(int? numCandidates) } /// - /// The query vector + /// + /// The query vector + /// /// public KnnSearchDescriptor QueryVector(ICollection? queryVector) { @@ -240,7 +276,9 @@ public KnnSearchDescriptor QueryVector(ICollection? queryVecto } /// - /// The query vector builder. You must provide a query_vector_builder or query_vector, but not both. + /// + /// The query vector builder. You must provide a query_vector_builder or query_vector, but not both. + /// /// public KnnSearchDescriptor QueryVectorBuilder(Elastic.Clients.Elasticsearch.QueryVectorBuilder? queryVectorBuilder) { @@ -267,7 +305,9 @@ public KnnSearchDescriptor QueryVectorBuilder(Action - /// The minimum similarity for a vector to be considered a match + /// + /// The minimum similarity for a vector to be considered a match + /// /// public KnnSearchDescriptor Similarity(float? similarity) { @@ -401,7 +441,9 @@ public KnnSearchDescriptor() : base() private float? SimilarityValue { get; set; } /// - /// Boost value to apply to kNN scores + /// + /// Boost value to apply to kNN scores + /// /// public KnnSearchDescriptor Boost(float? boost) { @@ -410,7 +452,9 @@ public KnnSearchDescriptor Boost(float? boost) } /// - /// The name of the vector field to search against + /// + /// The name of the vector field to search against + /// /// public KnnSearchDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -419,7 +463,9 @@ public KnnSearchDescriptor Field(Elastic.Clients.Elasticsearch.Field field) } /// - /// The name of the vector field to search against + /// + /// The name of the vector field to search against + /// /// public KnnSearchDescriptor Field(Expression> field) { @@ -428,7 +474,9 @@ public KnnSearchDescriptor Field(Expression - /// The name of the vector field to search against + /// + /// The name of the vector field to search against + /// /// public KnnSearchDescriptor Field(Expression> field) { @@ -437,7 +485,9 @@ public KnnSearchDescriptor Field(Expression> } /// - /// Filters for the kNN search query + /// + /// Filters for the kNN search query + /// /// public KnnSearchDescriptor Filter(ICollection? filter) { @@ -476,7 +526,9 @@ public KnnSearchDescriptor Filter(params Action - /// If defined, each search hit will contain inner hits. + /// + /// If defined, each search hit will contain inner hits. + /// /// public KnnSearchDescriptor InnerHits(Elastic.Clients.Elasticsearch.Core.Search.InnerHits? innerHits) { @@ -503,7 +555,9 @@ public KnnSearchDescriptor InnerHits(Action - /// The final number of nearest neighbors to return as top hits + /// + /// The final number of nearest neighbors to return as top hits + /// /// public KnnSearchDescriptor k(int? k) { @@ -512,7 +566,9 @@ public KnnSearchDescriptor k(int? k) } /// - /// The number of nearest neighbor candidates to consider per shard + /// + /// The number of nearest neighbor candidates to consider per shard + /// /// public KnnSearchDescriptor NumCandidates(int? numCandidates) { @@ -521,7 +577,9 @@ public KnnSearchDescriptor NumCandidates(int? numCandidates) } /// - /// The query vector + /// + /// The query vector + /// /// public KnnSearchDescriptor QueryVector(ICollection? queryVector) { @@ -530,7 +588,9 @@ public KnnSearchDescriptor QueryVector(ICollection? queryVector) } /// - /// The query vector builder. You must provide a query_vector_builder or query_vector, but not both. + /// + /// The query vector builder. You must provide a query_vector_builder or query_vector, but not both. + /// /// public KnnSearchDescriptor QueryVectorBuilder(Elastic.Clients.Elasticsearch.QueryVectorBuilder? queryVectorBuilder) { @@ -557,7 +617,9 @@ public KnnSearchDescriptor QueryVectorBuilder(Action - /// The minimum similarity for a vector to be considered a match + /// + /// The minimum similarity for a vector to be considered a match + /// /// public KnnSearchDescriptor Similarity(float? similarity) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/LatLonGeoLocation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/LatLonGeoLocation.g.cs index e0ee166ad6b..16a92d27141 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/LatLonGeoLocation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/LatLonGeoLocation.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class LatLonGeoLocation { /// - /// Latitude + /// + /// Latitude + /// /// [JsonInclude, JsonPropertyName("lat")] public double Lat { get; set; } /// - /// Longitude + /// + /// Longitude + /// /// [JsonInclude, JsonPropertyName("lon")] public double Lon { get; set; } @@ -54,7 +58,9 @@ public LatLonGeoLocationDescriptor() : base() private double LonValue { get; set; } /// - /// Latitude + /// + /// Latitude + /// /// public LatLonGeoLocationDescriptor Lat(double lat) { @@ -63,7 +69,9 @@ public LatLonGeoLocationDescriptor Lat(double lat) } /// - /// Longitude + /// + /// Longitude + /// /// public LatLonGeoLocationDescriptor Lon(double lon) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/AnalysisConfig.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/AnalysisConfig.g.cs index befb521e2d1..317b1ad5cbb 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/AnalysisConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/AnalysisConfig.g.cs @@ -30,68 +30,91 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class AnalysisConfig { /// - /// The size of the interval that the analysis is aggregated into, typically between `5m` and `1h`. This value should be either a whole number of days or equate to a
whole number of buckets in one day. If the anomaly detection job uses a datafeed with aggregations, this value must also be divisible by the interval of the date histogram aggregation. + /// + /// The size of the interval that the analysis is aggregated into, typically between 5m and 1h. This value should be either a whole number of days or equate to a + /// whole number of buckets in one day. If the anomaly detection job uses a datafeed with aggregations, this value must also be divisible by the interval of the date histogram aggregation. + /// /// [JsonInclude, JsonPropertyName("bucket_span")] public Elastic.Clients.Elasticsearch.Duration? BucketSpan { get; set; } /// - /// If `categorization_field_name` is specified, you can also define the analyzer that is used to interpret the categorization field. This property cannot be used at the same time as `categorization_filters`. The categorization analyzer specifies how the `categorization_field` is interpreted by the categorization process. The `categorization_analyzer` field can be specified either as a string or as an object. If it is a string, it must refer to a built-in analyzer or one added by another plugin. + /// + /// If categorization_field_name is specified, you can also define the analyzer that is used to interpret the categorization field. This property cannot be used at the same time as categorization_filters. The categorization analyzer specifies how the categorization_field is interpreted by the categorization process. The categorization_analyzer field can be specified either as a string or as an object. If it is a string, it must refer to a built-in analyzer or one added by another plugin. + /// /// [JsonInclude, JsonPropertyName("categorization_analyzer")] public Elastic.Clients.Elasticsearch.MachineLearning.CategorizationAnalyzer? CategorizationAnalyzer { get; set; } /// - /// If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`. + /// + /// If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting by_field_name, over_field_name, or partition_field_name to the keyword mlcategory. + /// /// [JsonInclude, JsonPropertyName("categorization_field_name")] public Elastic.Clients.Elasticsearch.Field? CategorizationFieldName { get; set; } /// - /// If `categorization_field_name` is specified, you can also define optional filters. This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as `categorization_analyzer`. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the `categorization_analyzer` property instead and include the filters as pattern_replace character filters. The effect is exactly the same. + /// + /// If categorization_field_name is specified, you can also define optional filters. This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as categorization_analyzer. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the categorization_analyzer property instead and include the filters as pattern_replace character filters. The effect is exactly the same. + /// /// [JsonInclude, JsonPropertyName("categorization_filters")] public ICollection? CategorizationFilters { get; set; } /// - /// Detector configuration objects specify which data fields a job analyzes. They also specify which analytical functions are used. You can specify multiple detectors for a job. If the detectors array does not contain at least one detector, no analysis can occur and an error is returned. + /// + /// Detector configuration objects specify which data fields a job analyzes. They also specify which analytical functions are used. You can specify multiple detectors for a job. If the detectors array does not contain at least one detector, no analysis can occur and an error is returned. + /// /// [JsonInclude, JsonPropertyName("detectors")] public ICollection Detectors { get; set; } /// - /// A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration. You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity. + /// + /// A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration. You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity. + /// /// [JsonInclude, JsonPropertyName("influencers")] [JsonConverter(typeof(FieldsConverter))] public Elastic.Clients.Elasticsearch.Fields? Influencers { get; set; } /// - /// The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second. NOTE: Latency is applicable only when you send data by using the post data API. + /// + /// The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second. NOTE: Latency is applicable only when you send data by using the post data API. + /// /// [JsonInclude, JsonPropertyName("latency")] public Elastic.Clients.Elasticsearch.Duration? Latency { get; set; } /// - /// Advanced configuration option. Affects the pruning of models that have not been updated for the given time duration. The value must be set to a multiple of the `bucket_span`. If set too low, important information may be removed from the model. For jobs created in 8.1 and later, the default value is the greater of `30d` or 20 times `bucket_span`. + /// + /// Advanced configuration option. Affects the pruning of models that have not been updated for the given time duration. The value must be set to a multiple of the bucket_span. If set too low, important information may be removed from the model. For jobs created in 8.1 and later, the default value is the greater of 30d or 20 times bucket_span. + /// /// [JsonInclude, JsonPropertyName("model_prune_window")] public Elastic.Clients.Elasticsearch.Duration? ModelPruneWindow { get; set; } /// - /// This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features. If set to `true`, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. For example, suppose CPU and memory usage on host A is usually highly correlated with the same metrics on host B. Perhaps this correlation occurs because they are running a load-balanced application. If you enable this property, anomalies will be reported when, for example, CPU usage on host A is high and the value of CPU usage on host B is low. That is to say, you’ll see an anomaly when the CPU of host A is unusual given the CPU of host B. To use the `multivariate_by_fields` property, you must also specify `by_field_name` in your detector. + /// + /// This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features. If set to true, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. For example, suppose CPU and memory usage on host A is usually highly correlated with the same metrics on host B. Perhaps this correlation occurs because they are running a load-balanced application. If you enable this property, anomalies will be reported when, for example, CPU usage on host A is high and the value of CPU usage on host B is low. That is to say, you’ll see an anomaly when the CPU of host A is unusual given the CPU of host B. To use the multivariate_by_fields property, you must also specify by_field_name in your detector. + /// /// [JsonInclude, JsonPropertyName("multivariate_by_fields")] public bool? MultivariateByFields { get; set; } /// - /// Settings related to how categorization interacts with partition fields. + /// + /// Settings related to how categorization interacts with partition fields. + /// /// [JsonInclude, JsonPropertyName("per_partition_categorization")] public Elastic.Clients.Elasticsearch.MachineLearning.PerPartitionCategorization? PerPartitionCategorization { get; set; } /// - /// If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same `summary_count_field_name` applies to all detectors in the job. NOTE: The `summary_count_field_name` property cannot be used with the `metric` function. + /// + /// If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same summary_count_field_name applies to all detectors in the job. NOTE: The summary_count_field_name property cannot be used with the metric function. + /// /// [JsonInclude, JsonPropertyName("summary_count_field_name")] public Elastic.Clients.Elasticsearch.Field? SummaryCountFieldName { get; set; } @@ -123,7 +146,10 @@ public AnalysisConfigDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? SummaryCountFieldNameValue { get; set; } /// - /// The size of the interval that the analysis is aggregated into, typically between `5m` and `1h`. This value should be either a whole number of days or equate to a
whole number of buckets in one day. If the anomaly detection job uses a datafeed with aggregations, this value must also be divisible by the interval of the date histogram aggregation. + /// + /// The size of the interval that the analysis is aggregated into, typically between 5m and 1h. This value should be either a whole number of days or equate to a + /// whole number of buckets in one day. If the anomaly detection job uses a datafeed with aggregations, this value must also be divisible by the interval of the date histogram aggregation. + /// /// public AnalysisConfigDescriptor BucketSpan(Elastic.Clients.Elasticsearch.Duration? bucketSpan) { @@ -132,7 +158,9 @@ public AnalysisConfigDescriptor BucketSpan(Elastic.Clients.Elasticsea } /// - /// If `categorization_field_name` is specified, you can also define the analyzer that is used to interpret the categorization field. This property cannot be used at the same time as `categorization_filters`. The categorization analyzer specifies how the `categorization_field` is interpreted by the categorization process. The `categorization_analyzer` field can be specified either as a string or as an object. If it is a string, it must refer to a built-in analyzer or one added by another plugin. + /// + /// If categorization_field_name is specified, you can also define the analyzer that is used to interpret the categorization field. This property cannot be used at the same time as categorization_filters. The categorization analyzer specifies how the categorization_field is interpreted by the categorization process. The categorization_analyzer field can be specified either as a string or as an object. If it is a string, it must refer to a built-in analyzer or one added by another plugin. + /// /// public AnalysisConfigDescriptor CategorizationAnalyzer(Elastic.Clients.Elasticsearch.MachineLearning.CategorizationAnalyzer? categorizationAnalyzer) { @@ -141,7 +169,9 @@ public AnalysisConfigDescriptor CategorizationAnalyzer(Elastic.Client } /// - /// If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`. + /// + /// If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting by_field_name, over_field_name, or partition_field_name to the keyword mlcategory. + /// /// public AnalysisConfigDescriptor CategorizationFieldName(Elastic.Clients.Elasticsearch.Field? categorizationFieldName) { @@ -150,7 +180,9 @@ public AnalysisConfigDescriptor CategorizationFieldName(Elastic.Clien } /// - /// If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`. + /// + /// If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting by_field_name, over_field_name, or partition_field_name to the keyword mlcategory. + /// /// public AnalysisConfigDescriptor CategorizationFieldName(Expression> categorizationFieldName) { @@ -159,7 +191,9 @@ public AnalysisConfigDescriptor CategorizationFieldName(Expre } /// - /// If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`. + /// + /// If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting by_field_name, over_field_name, or partition_field_name to the keyword mlcategory. + /// /// public AnalysisConfigDescriptor CategorizationFieldName(Expression> categorizationFieldName) { @@ -168,7 +202,9 @@ public AnalysisConfigDescriptor CategorizationFieldName(Expression - /// If `categorization_field_name` is specified, you can also define optional filters. This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as `categorization_analyzer`. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the `categorization_analyzer` property instead and include the filters as pattern_replace character filters. The effect is exactly the same. + /// + /// If categorization_field_name is specified, you can also define optional filters. This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as categorization_analyzer. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the categorization_analyzer property instead and include the filters as pattern_replace character filters. The effect is exactly the same. + /// /// public AnalysisConfigDescriptor CategorizationFilters(ICollection? categorizationFilters) { @@ -177,7 +213,9 @@ public AnalysisConfigDescriptor CategorizationFilters(ICollection - /// Detector configuration objects specify which data fields a job analyzes. They also specify which analytical functions are used. You can specify multiple detectors for a job. If the detectors array does not contain at least one detector, no analysis can occur and an error is returned. + /// + /// Detector configuration objects specify which data fields a job analyzes. They also specify which analytical functions are used. You can specify multiple detectors for a job. If the detectors array does not contain at least one detector, no analysis can occur and an error is returned. + /// /// public AnalysisConfigDescriptor Detectors(ICollection detectors) { @@ -216,7 +254,9 @@ public AnalysisConfigDescriptor Detectors(params Action - /// A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration. You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity. + /// + /// A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration. You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity. + /// /// public AnalysisConfigDescriptor Influencers(Elastic.Clients.Elasticsearch.Fields? influencers) { @@ -225,7 +265,9 @@ public AnalysisConfigDescriptor Influencers(Elastic.Clients.Elasticse } /// - /// The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second. NOTE: Latency is applicable only when you send data by using the post data API. + /// + /// The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second. NOTE: Latency is applicable only when you send data by using the post data API. + /// /// public AnalysisConfigDescriptor Latency(Elastic.Clients.Elasticsearch.Duration? latency) { @@ -234,7 +276,9 @@ public AnalysisConfigDescriptor Latency(Elastic.Clients.Elasticsearch } /// - /// Advanced configuration option. Affects the pruning of models that have not been updated for the given time duration. The value must be set to a multiple of the `bucket_span`. If set too low, important information may be removed from the model. For jobs created in 8.1 and later, the default value is the greater of `30d` or 20 times `bucket_span`. + /// + /// Advanced configuration option. Affects the pruning of models that have not been updated for the given time duration. The value must be set to a multiple of the bucket_span. If set too low, important information may be removed from the model. For jobs created in 8.1 and later, the default value is the greater of 30d or 20 times bucket_span. + /// /// public AnalysisConfigDescriptor ModelPruneWindow(Elastic.Clients.Elasticsearch.Duration? modelPruneWindow) { @@ -243,7 +287,9 @@ public AnalysisConfigDescriptor ModelPruneWindow(Elastic.Clients.Elas } /// - /// This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features. If set to `true`, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. For example, suppose CPU and memory usage on host A is usually highly correlated with the same metrics on host B. Perhaps this correlation occurs because they are running a load-balanced application. If you enable this property, anomalies will be reported when, for example, CPU usage on host A is high and the value of CPU usage on host B is low. That is to say, you’ll see an anomaly when the CPU of host A is unusual given the CPU of host B. To use the `multivariate_by_fields` property, you must also specify `by_field_name` in your detector. + /// + /// This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features. If set to true, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. For example, suppose CPU and memory usage on host A is usually highly correlated with the same metrics on host B. Perhaps this correlation occurs because they are running a load-balanced application. If you enable this property, anomalies will be reported when, for example, CPU usage on host A is high and the value of CPU usage on host B is low. That is to say, you’ll see an anomaly when the CPU of host A is unusual given the CPU of host B. To use the multivariate_by_fields property, you must also specify by_field_name in your detector. + /// /// public AnalysisConfigDescriptor MultivariateByFields(bool? multivariateByFields = true) { @@ -252,7 +298,9 @@ public AnalysisConfigDescriptor MultivariateByFields(bool? multivaria } /// - /// Settings related to how categorization interacts with partition fields. + /// + /// Settings related to how categorization interacts with partition fields. + /// /// public AnalysisConfigDescriptor PerPartitionCategorization(Elastic.Clients.Elasticsearch.MachineLearning.PerPartitionCategorization? perPartitionCategorization) { @@ -279,7 +327,9 @@ public AnalysisConfigDescriptor PerPartitionCategorization(Action - /// If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same `summary_count_field_name` applies to all detectors in the job. NOTE: The `summary_count_field_name` property cannot be used with the `metric` function. + /// + /// If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same summary_count_field_name applies to all detectors in the job. NOTE: The summary_count_field_name property cannot be used with the metric function. + /// /// public AnalysisConfigDescriptor SummaryCountFieldName(Elastic.Clients.Elasticsearch.Field? summaryCountFieldName) { @@ -288,7 +338,9 @@ public AnalysisConfigDescriptor SummaryCountFieldName(Elastic.Clients } /// - /// If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same `summary_count_field_name` applies to all detectors in the job. NOTE: The `summary_count_field_name` property cannot be used with the `metric` function. + /// + /// If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same summary_count_field_name applies to all detectors in the job. NOTE: The summary_count_field_name property cannot be used with the metric function. + /// /// public AnalysisConfigDescriptor SummaryCountFieldName(Expression> summaryCountFieldName) { @@ -297,7 +349,9 @@ public AnalysisConfigDescriptor SummaryCountFieldName(Express } /// - /// If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same `summary_count_field_name` applies to all detectors in the job. NOTE: The `summary_count_field_name` property cannot be used with the `metric` function. + /// + /// If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same summary_count_field_name applies to all detectors in the job. NOTE: The summary_count_field_name property cannot be used with the metric function. + /// /// public AnalysisConfigDescriptor SummaryCountFieldName(Expression> summaryCountFieldName) { @@ -439,7 +493,10 @@ public AnalysisConfigDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? SummaryCountFieldNameValue { get; set; } /// - /// The size of the interval that the analysis is aggregated into, typically between `5m` and `1h`. This value should be either a whole number of days or equate to a
whole number of buckets in one day. If the anomaly detection job uses a datafeed with aggregations, this value must also be divisible by the interval of the date histogram aggregation. + /// + /// The size of the interval that the analysis is aggregated into, typically between 5m and 1h. This value should be either a whole number of days or equate to a + /// whole number of buckets in one day. If the anomaly detection job uses a datafeed with aggregations, this value must also be divisible by the interval of the date histogram aggregation. + /// /// public AnalysisConfigDescriptor BucketSpan(Elastic.Clients.Elasticsearch.Duration? bucketSpan) { @@ -448,7 +505,9 @@ public AnalysisConfigDescriptor BucketSpan(Elastic.Clients.Elasticsearch.Duratio } /// - /// If `categorization_field_name` is specified, you can also define the analyzer that is used to interpret the categorization field. This property cannot be used at the same time as `categorization_filters`. The categorization analyzer specifies how the `categorization_field` is interpreted by the categorization process. The `categorization_analyzer` field can be specified either as a string or as an object. If it is a string, it must refer to a built-in analyzer or one added by another plugin. + /// + /// If categorization_field_name is specified, you can also define the analyzer that is used to interpret the categorization field. This property cannot be used at the same time as categorization_filters. The categorization analyzer specifies how the categorization_field is interpreted by the categorization process. The categorization_analyzer field can be specified either as a string or as an object. If it is a string, it must refer to a built-in analyzer or one added by another plugin. + /// /// public AnalysisConfigDescriptor CategorizationAnalyzer(Elastic.Clients.Elasticsearch.MachineLearning.CategorizationAnalyzer? categorizationAnalyzer) { @@ -457,7 +516,9 @@ public AnalysisConfigDescriptor CategorizationAnalyzer(Elastic.Clients.Elasticse } /// - /// If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`. + /// + /// If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting by_field_name, over_field_name, or partition_field_name to the keyword mlcategory. + /// /// public AnalysisConfigDescriptor CategorizationFieldName(Elastic.Clients.Elasticsearch.Field? categorizationFieldName) { @@ -466,7 +527,9 @@ public AnalysisConfigDescriptor CategorizationFieldName(Elastic.Clients.Elastics } /// - /// If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`. + /// + /// If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting by_field_name, over_field_name, or partition_field_name to the keyword mlcategory. + /// /// public AnalysisConfigDescriptor CategorizationFieldName(Expression> categorizationFieldName) { @@ -475,7 +538,9 @@ public AnalysisConfigDescriptor CategorizationFieldName(Expre } /// - /// If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`. + /// + /// If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting by_field_name, over_field_name, or partition_field_name to the keyword mlcategory. + /// /// public AnalysisConfigDescriptor CategorizationFieldName(Expression> categorizationFieldName) { @@ -484,7 +549,9 @@ public AnalysisConfigDescriptor CategorizationFieldName(Expression - /// If `categorization_field_name` is specified, you can also define optional filters. This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as `categorization_analyzer`. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the `categorization_analyzer` property instead and include the filters as pattern_replace character filters. The effect is exactly the same. + /// + /// If categorization_field_name is specified, you can also define optional filters. This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as categorization_analyzer. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the categorization_analyzer property instead and include the filters as pattern_replace character filters. The effect is exactly the same. + /// /// public AnalysisConfigDescriptor CategorizationFilters(ICollection? categorizationFilters) { @@ -493,7 +560,9 @@ public AnalysisConfigDescriptor CategorizationFilters(ICollection? categ } /// - /// Detector configuration objects specify which data fields a job analyzes. They also specify which analytical functions are used. You can specify multiple detectors for a job. If the detectors array does not contain at least one detector, no analysis can occur and an error is returned. + /// + /// Detector configuration objects specify which data fields a job analyzes. They also specify which analytical functions are used. You can specify multiple detectors for a job. If the detectors array does not contain at least one detector, no analysis can occur and an error is returned. + /// /// public AnalysisConfigDescriptor Detectors(ICollection detectors) { @@ -532,7 +601,9 @@ public AnalysisConfigDescriptor Detectors(params Action - /// A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration. You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity. + /// + /// A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration. You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity. + /// /// public AnalysisConfigDescriptor Influencers(Elastic.Clients.Elasticsearch.Fields? influencers) { @@ -541,7 +612,9 @@ public AnalysisConfigDescriptor Influencers(Elastic.Clients.Elasticsearch.Fields } /// - /// The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second. NOTE: Latency is applicable only when you send data by using the post data API. + /// + /// The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second. NOTE: Latency is applicable only when you send data by using the post data API. + /// /// public AnalysisConfigDescriptor Latency(Elastic.Clients.Elasticsearch.Duration? latency) { @@ -550,7 +623,9 @@ public AnalysisConfigDescriptor Latency(Elastic.Clients.Elasticsearch.Duration? } /// - /// Advanced configuration option. Affects the pruning of models that have not been updated for the given time duration. The value must be set to a multiple of the `bucket_span`. If set too low, important information may be removed from the model. For jobs created in 8.1 and later, the default value is the greater of `30d` or 20 times `bucket_span`. + /// + /// Advanced configuration option. Affects the pruning of models that have not been updated for the given time duration. The value must be set to a multiple of the bucket_span. If set too low, important information may be removed from the model. For jobs created in 8.1 and later, the default value is the greater of 30d or 20 times bucket_span. + /// /// public AnalysisConfigDescriptor ModelPruneWindow(Elastic.Clients.Elasticsearch.Duration? modelPruneWindow) { @@ -559,7 +634,9 @@ public AnalysisConfigDescriptor ModelPruneWindow(Elastic.Clients.Elasticsearch.D } /// - /// This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features. If set to `true`, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. For example, suppose CPU and memory usage on host A is usually highly correlated with the same metrics on host B. Perhaps this correlation occurs because they are running a load-balanced application. If you enable this property, anomalies will be reported when, for example, CPU usage on host A is high and the value of CPU usage on host B is low. That is to say, you’ll see an anomaly when the CPU of host A is unusual given the CPU of host B. To use the `multivariate_by_fields` property, you must also specify `by_field_name` in your detector. + /// + /// This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features. If set to true, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. For example, suppose CPU and memory usage on host A is usually highly correlated with the same metrics on host B. Perhaps this correlation occurs because they are running a load-balanced application. If you enable this property, anomalies will be reported when, for example, CPU usage on host A is high and the value of CPU usage on host B is low. That is to say, you’ll see an anomaly when the CPU of host A is unusual given the CPU of host B. To use the multivariate_by_fields property, you must also specify by_field_name in your detector. + /// /// public AnalysisConfigDescriptor MultivariateByFields(bool? multivariateByFields = true) { @@ -568,7 +645,9 @@ public AnalysisConfigDescriptor MultivariateByFields(bool? multivariateByFields } /// - /// Settings related to how categorization interacts with partition fields. + /// + /// Settings related to how categorization interacts with partition fields. + /// /// public AnalysisConfigDescriptor PerPartitionCategorization(Elastic.Clients.Elasticsearch.MachineLearning.PerPartitionCategorization? perPartitionCategorization) { @@ -595,7 +674,9 @@ public AnalysisConfigDescriptor PerPartitionCategorization(Action - /// If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same `summary_count_field_name` applies to all detectors in the job. NOTE: The `summary_count_field_name` property cannot be used with the `metric` function. + /// + /// If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same summary_count_field_name applies to all detectors in the job. NOTE: The summary_count_field_name property cannot be used with the metric function. + /// /// public AnalysisConfigDescriptor SummaryCountFieldName(Elastic.Clients.Elasticsearch.Field? summaryCountFieldName) { @@ -604,7 +685,9 @@ public AnalysisConfigDescriptor SummaryCountFieldName(Elastic.Clients.Elasticsea } /// - /// If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same `summary_count_field_name` applies to all detectors in the job. NOTE: The `summary_count_field_name` property cannot be used with the `metric` function. + /// + /// If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same summary_count_field_name applies to all detectors in the job. NOTE: The summary_count_field_name property cannot be used with the metric function. + /// /// public AnalysisConfigDescriptor SummaryCountFieldName(Expression> summaryCountFieldName) { @@ -613,7 +696,9 @@ public AnalysisConfigDescriptor SummaryCountFieldName(Express } /// - /// If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same `summary_count_field_name` applies to all detectors in the job. NOTE: The `summary_count_field_name` property cannot be used with the `metric` function. + /// + /// If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same summary_count_field_name applies to all detectors in the job. NOTE: The summary_count_field_name property cannot be used with the metric function. + /// /// public AnalysisConfigDescriptor SummaryCountFieldName(Expression> summaryCountFieldName) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/AnalysisConfigRead.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/AnalysisConfigRead.g.cs index 16ae4256233..d474fce980b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/AnalysisConfigRead.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/AnalysisConfigRead.g.cs @@ -30,67 +30,112 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class AnalysisConfigRead { /// - /// The size of the interval that the analysis is aggregated into, typically between `5m` and `1h`. + /// + /// The size of the interval that the analysis is aggregated into, typically between 5m and 1h. + /// /// [JsonInclude, JsonPropertyName("bucket_span")] public Elastic.Clients.Elasticsearch.Duration BucketSpan { get; init; } /// - /// If `categorization_field_name` is specified, you can also define the analyzer that is used to interpret the categorization field.
This property cannot be used at the same time as `categorization_filters`.
The categorization analyzer specifies how the `categorization_field` is interpreted by the categorization process. + /// + /// If categorization_field_name is specified, you can also define the analyzer that is used to interpret the categorization field. + /// This property cannot be used at the same time as categorization_filters. + /// The categorization analyzer specifies how the categorization_field is interpreted by the categorization process. + /// /// [JsonInclude, JsonPropertyName("categorization_analyzer")] public Elastic.Clients.Elasticsearch.MachineLearning.CategorizationAnalyzer? CategorizationAnalyzer { get; init; } /// - /// If this property is specified, the values of the specified field will be categorized.
The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`. + /// + /// If this property is specified, the values of the specified field will be categorized. + /// The resulting categories must be used in a detector by setting by_field_name, over_field_name, or partition_field_name to the keyword mlcategory. + /// /// [JsonInclude, JsonPropertyName("categorization_field_name")] public string? CategorizationFieldName { get; init; } /// - /// If `categorization_field_name` is specified, you can also define optional filters.
This property expects an array of regular expressions.
The expressions are used to filter out matching sequences from the categorization field values. + /// + /// If categorization_field_name is specified, you can also define optional filters. + /// This property expects an array of regular expressions. + /// The expressions are used to filter out matching sequences from the categorization field values. + /// /// [JsonInclude, JsonPropertyName("categorization_filters")] public IReadOnlyCollection? CategorizationFilters { get; init; } /// - /// An array of detector configuration objects.
Detector configuration objects specify which data fields a job analyzes.
They also specify which analytical functions are used.
You can specify multiple detectors for a job. + /// + /// An array of detector configuration objects. + /// Detector configuration objects specify which data fields a job analyzes. + /// They also specify which analytical functions are used. + /// You can specify multiple detectors for a job. + /// /// [JsonInclude, JsonPropertyName("detectors")] public IReadOnlyCollection Detectors { get; init; } /// - /// A comma separated list of influencer field names.
Typically these can be the by, over, or partition fields that are used in the detector configuration.
You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data.
When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity. + /// + /// A comma separated list of influencer field names. + /// Typically these can be the by, over, or partition fields that are used in the detector configuration. + /// You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. + /// When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity. + /// /// [JsonInclude, JsonPropertyName("influencers")] public IReadOnlyCollection Influencers { get; init; } /// - /// The size of the window in which to expect data that is out of time order.
Defaults to no latency.
If you specify a non-zero value, it must be greater than or equal to one second. + /// + /// The size of the window in which to expect data that is out of time order. + /// Defaults to no latency. + /// If you specify a non-zero value, it must be greater than or equal to one second. + /// /// [JsonInclude, JsonPropertyName("latency")] public Elastic.Clients.Elasticsearch.Duration? Latency { get; init; } /// - /// Advanced configuration option.
Affects the pruning of models that have not been updated for the given time duration.
The value must be set to a multiple of the `bucket_span`.
If set too low, important information may be removed from the model.
Typically, set to `30d` or longer.
If not set, model pruning only occurs if the model memory status reaches the soft limit or the hard limit.
For jobs created in 8.1 and later, the default value is the greater of `30d` or 20 times `bucket_span`. + /// + /// Advanced configuration option. + /// Affects the pruning of models that have not been updated for the given time duration. + /// The value must be set to a multiple of the bucket_span. + /// If set too low, important information may be removed from the model. + /// Typically, set to 30d or longer. + /// If not set, model pruning only occurs if the model memory status reaches the soft limit or the hard limit. + /// For jobs created in 8.1 and later, the default value is the greater of 30d or 20 times bucket_span. + /// /// [JsonInclude, JsonPropertyName("model_prune_window")] public Elastic.Clients.Elasticsearch.Duration? ModelPruneWindow { get; init; } /// - /// This functionality is reserved for internal use.
It is not supported for use in customer environments and is not subject to the support SLA of official GA features.
If set to `true`, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. + /// + /// This functionality is reserved for internal use. + /// It is not supported for use in customer environments and is not subject to the support SLA of official GA features. + /// If set to true, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. + /// /// [JsonInclude, JsonPropertyName("multivariate_by_fields")] public bool? MultivariateByFields { get; init; } /// - /// Settings related to how categorization interacts with partition fields. + /// + /// Settings related to how categorization interacts with partition fields. + /// /// [JsonInclude, JsonPropertyName("per_partition_categorization")] public Elastic.Clients.Elasticsearch.MachineLearning.PerPartitionCategorization? PerPartitionCategorization { get; init; } /// - /// If this property is specified, the data that is fed to the job is expected to be pre-summarized.
This property value is the name of the field that contains the count of raw data points that have been summarized.
The same `summary_count_field_name` applies to all detectors in the job. + /// + /// If this property is specified, the data that is fed to the job is expected to be pre-summarized. + /// This property value is the name of the field that contains the count of raw data points that have been summarized. + /// The same summary_count_field_name applies to all detectors in the job. + /// /// [JsonInclude, JsonPropertyName("summary_count_field_name")] public string? SummaryCountFieldName { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/AnalysisLimits.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/AnalysisLimits.g.cs index f4a40589710..dc6af2774f9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/AnalysisLimits.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/AnalysisLimits.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class AnalysisLimits { /// - /// The maximum number of examples stored per category in memory and in the results data store. If you increase this value, more examples are available, however it requires that you have more storage available. If you set this value to 0, no examples are stored. NOTE: The `categorization_examples_limit` applies only to analysis that uses categorization. + /// + /// The maximum number of examples stored per category in memory and in the results data store. If you increase this value, more examples are available, however it requires that you have more storage available. If you set this value to 0, no examples are stored. NOTE: The categorization_examples_limit applies only to analysis that uses categorization. + /// /// [JsonInclude, JsonPropertyName("categorization_examples_limit")] public long? CategorizationExamplesLimit { get; set; } /// - /// The approximate maximum amount of memory resources that are required for analytical processing. Once this limit is approached, data pruning becomes more aggressive. Upon exceeding this limit, new entities are not modeled. If the `xpack.ml.max_model_memory_limit` setting has a value greater than 0 and less than 1024mb, that value is used instead of the default. The default value is relatively small to ensure that high resource usage is a conscious decision. If you have jobs that are expected to analyze high cardinality fields, you will likely need to use a higher value. If you specify a number instead of a string, the units are assumed to be MiB. Specifying a string is recommended for clarity. If you specify a byte size unit of `b` or `kb` and the number does not equate to a discrete number of megabytes, it is rounded down to the closest MiB. The minimum valid value is 1 MiB. If you specify a value less than 1 MiB, an error occurs. If you specify a value for the `xpack.ml.max_model_memory_limit` setting, an error occurs when you try to create jobs that have `model_memory_limit` values greater than that setting value. + /// + /// The approximate maximum amount of memory resources that are required for analytical processing. Once this limit is approached, data pruning becomes more aggressive. Upon exceeding this limit, new entities are not modeled. If the xpack.ml.max_model_memory_limit setting has a value greater than 0 and less than 1024mb, that value is used instead of the default. The default value is relatively small to ensure that high resource usage is a conscious decision. If you have jobs that are expected to analyze high cardinality fields, you will likely need to use a higher value. If you specify a number instead of a string, the units are assumed to be MiB. Specifying a string is recommended for clarity. If you specify a byte size unit of b or kb and the number does not equate to a discrete number of megabytes, it is rounded down to the closest MiB. The minimum valid value is 1 MiB. If you specify a value less than 1 MiB, an error occurs. If you specify a value for the xpack.ml.max_model_memory_limit setting, an error occurs when you try to create jobs that have model_memory_limit values greater than that setting value. + /// /// [JsonInclude, JsonPropertyName("model_memory_limit")] public string? ModelMemoryLimit { get; set; } @@ -54,7 +58,9 @@ public AnalysisLimitsDescriptor() : base() private string? ModelMemoryLimitValue { get; set; } /// - /// The maximum number of examples stored per category in memory and in the results data store. If you increase this value, more examples are available, however it requires that you have more storage available. If you set this value to 0, no examples are stored. NOTE: The `categorization_examples_limit` applies only to analysis that uses categorization. + /// + /// The maximum number of examples stored per category in memory and in the results data store. If you increase this value, more examples are available, however it requires that you have more storage available. If you set this value to 0, no examples are stored. NOTE: The categorization_examples_limit applies only to analysis that uses categorization. + /// /// public AnalysisLimitsDescriptor CategorizationExamplesLimit(long? categorizationExamplesLimit) { @@ -63,7 +69,9 @@ public AnalysisLimitsDescriptor CategorizationExamplesLimit(long? categorization } /// - /// The approximate maximum amount of memory resources that are required for analytical processing. Once this limit is approached, data pruning becomes more aggressive. Upon exceeding this limit, new entities are not modeled. If the `xpack.ml.max_model_memory_limit` setting has a value greater than 0 and less than 1024mb, that value is used instead of the default. The default value is relatively small to ensure that high resource usage is a conscious decision. If you have jobs that are expected to analyze high cardinality fields, you will likely need to use a higher value. If you specify a number instead of a string, the units are assumed to be MiB. Specifying a string is recommended for clarity. If you specify a byte size unit of `b` or `kb` and the number does not equate to a discrete number of megabytes, it is rounded down to the closest MiB. The minimum valid value is 1 MiB. If you specify a value less than 1 MiB, an error occurs. If you specify a value for the `xpack.ml.max_model_memory_limit` setting, an error occurs when you try to create jobs that have `model_memory_limit` values greater than that setting value. + /// + /// The approximate maximum amount of memory resources that are required for analytical processing. Once this limit is approached, data pruning becomes more aggressive. Upon exceeding this limit, new entities are not modeled. If the xpack.ml.max_model_memory_limit setting has a value greater than 0 and less than 1024mb, that value is used instead of the default. The default value is relatively small to ensure that high resource usage is a conscious decision. If you have jobs that are expected to analyze high cardinality fields, you will likely need to use a higher value. If you specify a number instead of a string, the units are assumed to be MiB. Specifying a string is recommended for clarity. If you specify a byte size unit of b or kb and the number does not equate to a discrete number of megabytes, it is rounded down to the closest MiB. The minimum valid value is 1 MiB. If you specify a value less than 1 MiB, an error occurs. If you specify a value for the xpack.ml.max_model_memory_limit setting, an error occurs when you try to create jobs that have model_memory_limit values greater than that setting value. + /// /// public AnalysisLimitsDescriptor ModelMemoryLimit(string? modelMemoryLimit) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/AnalysisMemoryLimit.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/AnalysisMemoryLimit.g.cs index 4cd5136d0a4..60063d4c66d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/AnalysisMemoryLimit.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/AnalysisMemoryLimit.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class AnalysisMemoryLimit { /// - /// Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes. + /// + /// Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes. + /// /// [JsonInclude, JsonPropertyName("model_memory_limit")] public string ModelMemoryLimit { get; set; } @@ -47,7 +49,9 @@ public AnalysisMemoryLimitDescriptor() : base() private string ModelMemoryLimitValue { get; set; } /// - /// Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes. + /// + /// Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes. + /// /// public AnalysisMemoryLimitDescriptor ModelMemoryLimit(string modelMemoryLimit) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Anomaly.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Anomaly.g.cs index f4f01e5b5b9..8c006610d5e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Anomaly.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Anomaly.g.cs @@ -30,145 +30,193 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class Anomaly { /// - /// The actual value for the bucket. + /// + /// The actual value for the bucket. + /// /// [JsonInclude, JsonPropertyName("actual")] public IReadOnlyCollection? Actual { get; init; } /// - /// Information about the factors impacting the initial anomaly score. + /// + /// Information about the factors impacting the initial anomaly score. + /// /// [JsonInclude, JsonPropertyName("anomaly_score_explanation")] public Elastic.Clients.Elasticsearch.MachineLearning.AnomalyExplanation? AnomalyScoreExplanation { get; init; } /// - /// The length of the bucket in seconds. This value matches the `bucket_span` that is specified in the job. + /// + /// The length of the bucket in seconds. This value matches the bucket_span that is specified in the job. + /// /// [JsonInclude, JsonPropertyName("bucket_span")] public long BucketSpan { get; init; } /// - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// /// [JsonInclude, JsonPropertyName("by_field_name")] public string? ByFieldName { get; init; } /// - /// The value of `by_field_name`. + /// + /// The value of by_field_name. + /// /// [JsonInclude, JsonPropertyName("by_field_value")] public string? ByFieldValue { get; init; } /// - /// For population analysis, an over field must be specified in the detector. This property contains an array of anomaly records that are the causes for the anomaly that has been identified for the over field. This sub-resource contains the most anomalous records for the `over_field_name`. For scalability reasons, a maximum of the 10 most significant causes of the anomaly are returned. As part of the core analytical modeling, these low-level anomaly records are aggregated for their parent over field record. The `causes` resource contains similar elements to the record resource, namely `actual`, `typical`, `geo_results.actual_point`, `geo_results.typical_point`, `*_field_name` and `*_field_value`. Probability and scores are not applicable to causes. + /// + /// For population analysis, an over field must be specified in the detector. This property contains an array of anomaly records that are the causes for the anomaly that has been identified for the over field. This sub-resource contains the most anomalous records for the over_field_name. For scalability reasons, a maximum of the 10 most significant causes of the anomaly are returned. As part of the core analytical modeling, these low-level anomaly records are aggregated for their parent over field record. The causes resource contains similar elements to the record resource, namely actual, typical, geo_results.actual_point, geo_results.typical_point, *_field_name and *_field_value. Probability and scores are not applicable to causes. + /// /// [JsonInclude, JsonPropertyName("causes")] public IReadOnlyCollection? Causes { get; init; } /// - /// A unique identifier for the detector. + /// + /// A unique identifier for the detector. + /// /// [JsonInclude, JsonPropertyName("detector_index")] public int DetectorIndex { get; init; } /// - /// Certain functions require a field to operate on, for example, `sum()`. For those functions, this value is the name of the field to be analyzed. + /// + /// Certain functions require a field to operate on, for example, sum(). For those functions, this value is the name of the field to be analyzed. + /// /// [JsonInclude, JsonPropertyName("field_name")] public string? FieldName { get; init; } /// - /// The function in which the anomaly occurs, as specified in the detector configuration. For example, `max`. + /// + /// The function in which the anomaly occurs, as specified in the detector configuration. For example, max. + /// /// [JsonInclude, JsonPropertyName("function")] public string? Function { get; init; } /// - /// The description of the function in which the anomaly occurs, as specified in the detector configuration. + /// + /// The description of the function in which the anomaly occurs, as specified in the detector configuration. + /// /// [JsonInclude, JsonPropertyName("function_description")] public string? FunctionDescription { get; init; } /// - /// If the detector function is `lat_long`, this object contains comma delimited strings for the latitude and longitude of the actual and typical values. + /// + /// If the detector function is lat_long, this object contains comma delimited strings for the latitude and longitude of the actual and typical values. + /// /// [JsonInclude, JsonPropertyName("geo_results")] public Elastic.Clients.Elasticsearch.MachineLearning.GeoResults? GeoResults { get; init; } /// - /// If influencers were specified in the detector configuration, this array contains influencers that contributed to or were to blame for an anomaly. + /// + /// If influencers were specified in the detector configuration, this array contains influencers that contributed to or were to blame for an anomaly. + /// /// [JsonInclude, JsonPropertyName("influencers")] public IReadOnlyCollection? Influencers { get; init; } /// - /// A normalized score between 0-100, which is based on the probability of the anomalousness of this record. This is the initial value that was calculated at the time the bucket was processed. + /// + /// A normalized score between 0-100, which is based on the probability of the anomalousness of this record. This is the initial value that was calculated at the time the bucket was processed. + /// /// [JsonInclude, JsonPropertyName("initial_record_score")] public double InitialRecordScore { get; init; } /// - /// If true, this is an interim result. In other words, the results are calculated based on partial input data. + /// + /// If true, this is an interim result. In other words, the results are calculated based on partial input data. + /// /// [JsonInclude, JsonPropertyName("is_interim")] public bool IsInterim { get; init; } /// - /// Identifier for the anomaly detection job. + /// + /// Identifier for the anomaly detection job. + /// /// [JsonInclude, JsonPropertyName("job_id")] public string JobId { get; init; } /// - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// /// [JsonInclude, JsonPropertyName("over_field_name")] public string? OverFieldName { get; init; } /// - /// The value of `over_field_name`. + /// + /// The value of over_field_name. + /// /// [JsonInclude, JsonPropertyName("over_field_value")] public string? OverFieldValue { get; init; } /// - /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// + /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// /// [JsonInclude, JsonPropertyName("partition_field_name")] public string? PartitionFieldName { get; init; } /// - /// The value of `partition_field_name`. + /// + /// The value of partition_field_name. + /// /// [JsonInclude, JsonPropertyName("partition_field_value")] public string? PartitionFieldValue { get; init; } /// - /// The probability of the individual anomaly occurring, in the range 0 to 1. For example, `0.0000772031`. This value can be held to a high precision of over 300 decimal places, so the `record_score` is provided as a human-readable and friendly interpretation of this. + /// + /// The probability of the individual anomaly occurring, in the range 0 to 1. For example, 0.0000772031. This value can be held to a high precision of over 300 decimal places, so the record_score is provided as a human-readable and friendly interpretation of this. + /// /// [JsonInclude, JsonPropertyName("probability")] public double Probability { get; init; } /// - /// A normalized score between 0-100, which is based on the probability of the anomalousness of this record. Unlike `initial_record_score`, this value will be updated by a re-normalization process as new data is analyzed. + /// + /// A normalized score between 0-100, which is based on the probability of the anomalousness of this record. Unlike initial_record_score, this value will be updated by a re-normalization process as new data is analyzed. + /// /// [JsonInclude, JsonPropertyName("record_score")] public double RecordScore { get; init; } /// - /// Internal. This is always set to `record`. + /// + /// Internal. This is always set to record. + /// /// [JsonInclude, JsonPropertyName("result_type")] public string ResultType { get; init; } /// - /// The start time of the bucket for which these results were calculated. + /// + /// The start time of the bucket for which these results were calculated. + /// /// [JsonInclude, JsonPropertyName("timestamp")] public long Timestamp { get; init; } /// - /// The typical value for the bucket, according to analytical modeling. + /// + /// The typical value for the bucket, according to analytical modeling. + /// /// [JsonInclude, JsonPropertyName("typical")] public IReadOnlyCollection? Typical { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/AnomalyExplanation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/AnomalyExplanation.g.cs index 186bee8154a..14920cc8f36 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/AnomalyExplanation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/AnomalyExplanation.g.cs @@ -30,61 +30,81 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class AnomalyExplanation { /// - /// Impact from the duration and magnitude of the detected anomaly relative to the historical average. + /// + /// Impact from the duration and magnitude of the detected anomaly relative to the historical average. + /// /// [JsonInclude, JsonPropertyName("anomaly_characteristics_impact")] public int? AnomalyCharacteristicsImpact { get; init; } /// - /// Length of the detected anomaly in the number of buckets. + /// + /// Length of the detected anomaly in the number of buckets. + /// /// [JsonInclude, JsonPropertyName("anomaly_length")] public int? AnomalyLength { get; init; } /// - /// Type of the detected anomaly: `spike` or `dip`. + /// + /// Type of the detected anomaly: spike or dip. + /// /// [JsonInclude, JsonPropertyName("anomaly_type")] public string? AnomalyType { get; init; } /// - /// Indicates reduction of anomaly score for the bucket with large confidence intervals. If a bucket has large confidence intervals, the score is reduced. + /// + /// Indicates reduction of anomaly score for the bucket with large confidence intervals. If a bucket has large confidence intervals, the score is reduced. + /// /// [JsonInclude, JsonPropertyName("high_variance_penalty")] public bool? HighVariancePenalty { get; init; } /// - /// If the bucket contains fewer samples than expected, the score is reduced. + /// + /// If the bucket contains fewer samples than expected, the score is reduced. + /// /// [JsonInclude, JsonPropertyName("incomplete_bucket_penalty")] public bool? IncompleteBucketPenalty { get; init; } /// - /// Lower bound of the 95% confidence interval. + /// + /// Lower bound of the 95% confidence interval. + /// /// [JsonInclude, JsonPropertyName("lower_confidence_bound")] public double? LowerConfidenceBound { get; init; } /// - /// Impact of the deviation between actual and typical values in the past 12 buckets. + /// + /// Impact of the deviation between actual and typical values in the past 12 buckets. + /// /// [JsonInclude, JsonPropertyName("multi_bucket_impact")] public int? MultiBucketImpact { get; init; } /// - /// Impact of the deviation between actual and typical values in the current bucket. + /// + /// Impact of the deviation between actual and typical values in the current bucket. + /// /// [JsonInclude, JsonPropertyName("single_bucket_impact")] public int? SingleBucketImpact { get; init; } /// - /// Typical (expected) value for this bucket. + /// + /// Typical (expected) value for this bucket. + /// /// [JsonInclude, JsonPropertyName("typical_value")] public double? TypicalValue { get; init; } /// - /// Upper bound of the 95% confidence interval. + /// + /// Upper bound of the 95% confidence interval. + /// /// [JsonInclude, JsonPropertyName("upper_confidence_bound")] public double? UpperConfidenceBound { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ApiKeyAuthorization.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ApiKeyAuthorization.g.cs index aaadda81645..bf97fc9d3ed 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ApiKeyAuthorization.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ApiKeyAuthorization.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class ApiKeyAuthorization { /// - /// The identifier for the API key. + /// + /// The identifier for the API key. + /// /// [JsonInclude, JsonPropertyName("id")] public string Id { get; init; } /// - /// The name of the API key. + /// + /// The name of the API key. + /// /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/BucketInfluencer.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/BucketInfluencer.g.cs index 1ec42f1e6d6..30fe60c787c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/BucketInfluencer.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/BucketInfluencer.g.cs @@ -30,67 +30,93 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class BucketInfluencer { /// - /// A normalized score between 0-100, which is calculated for each bucket influencer. This score might be updated as
newer data is analyzed. + /// + /// A normalized score between 0-100, which is calculated for each bucket influencer. This score might be updated as + /// newer data is analyzed. + /// /// [JsonInclude, JsonPropertyName("anomaly_score")] public double AnomalyScore { get; init; } /// - /// The length of the bucket in seconds. This value matches the bucket span that is specified in the job. + /// + /// The length of the bucket in seconds. This value matches the bucket span that is specified in the job. + /// /// [JsonInclude, JsonPropertyName("bucket_span")] public long BucketSpan { get; init; } /// - /// The field name of the influencer. + /// + /// The field name of the influencer. + /// /// [JsonInclude, JsonPropertyName("influencer_field_name")] public string InfluencerFieldName { get; init; } /// - /// The score between 0-100 for each bucket influencer. This score is the initial value that was calculated at the
time the bucket was processed. + /// + /// The score between 0-100 for each bucket influencer. This score is the initial value that was calculated at the + /// time the bucket was processed. + /// /// [JsonInclude, JsonPropertyName("initial_anomaly_score")] public double InitialAnomalyScore { get; init; } /// - /// If true, this is an interim result. In other words, the results are calculated based on partial input data. + /// + /// If true, this is an interim result. In other words, the results are calculated based on partial input data. + /// /// [JsonInclude, JsonPropertyName("is_interim")] public bool IsInterim { get; init; } /// - /// Identifier for the anomaly detection job. + /// + /// Identifier for the anomaly detection job. + /// /// [JsonInclude, JsonPropertyName("job_id")] public string JobId { get; init; } /// - /// The probability that the bucket has this behavior, in the range 0 to 1. This value can be held to a high precision
of over 300 decimal places, so the `anomaly_score` is provided as a human-readable and friendly interpretation of
this. + /// + /// The probability that the bucket has this behavior, in the range 0 to 1. This value can be held to a high precision + /// of over 300 decimal places, so the anomaly_score is provided as a human-readable and friendly interpretation of + /// this. + /// /// [JsonInclude, JsonPropertyName("probability")] public double Probability { get; init; } /// - /// Internal. + /// + /// Internal. + /// /// [JsonInclude, JsonPropertyName("raw_anomaly_score")] public double RawAnomalyScore { get; init; } /// - /// Internal. This value is always set to `bucket_influencer`. + /// + /// Internal. This value is always set to bucket_influencer. + /// /// [JsonInclude, JsonPropertyName("result_type")] public string ResultType { get; init; } /// - /// The start time of the bucket for which these results were calculated. + /// + /// The start time of the bucket for which these results were calculated. + /// /// [JsonInclude, JsonPropertyName("timestamp")] public long Timestamp { get; init; } /// - /// The start time of the bucket for which these results were calculated. + /// + /// The start time of the bucket for which these results were calculated. + /// /// [JsonInclude, JsonPropertyName("timestamp_string")] public DateTimeOffset? TimestampString { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/BucketSummary.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/BucketSummary.g.cs index 50fbd94a493..b90c1d498af 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/BucketSummary.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/BucketSummary.g.cs @@ -30,7 +30,11 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class BucketSummary { /// - /// The maximum anomaly score, between 0-100, for any of the bucket influencers. This is an overall, rate-limited
score for the job. All the anomaly records in the bucket contribute to this score. This value might be updated as
new data is analyzed. + /// + /// The maximum anomaly score, between 0-100, for any of the bucket influencers. This is an overall, rate-limited + /// score for the job. All the anomaly records in the bucket contribute to this score. This value might be updated as + /// new data is analyzed. + /// /// [JsonInclude, JsonPropertyName("anomaly_score")] public double AnomalyScore { get; init; } @@ -38,55 +42,76 @@ public sealed partial class BucketSummary public IReadOnlyCollection BucketInfluencers { get; init; } /// - /// The length of the bucket in seconds. This value matches the bucket span that is specified in the job. + /// + /// The length of the bucket in seconds. This value matches the bucket span that is specified in the job. + /// /// [JsonInclude, JsonPropertyName("bucket_span")] public long BucketSpan { get; init; } /// - /// The number of input data records processed in this bucket. + /// + /// The number of input data records processed in this bucket. + /// /// [JsonInclude, JsonPropertyName("event_count")] public long EventCount { get; init; } /// - /// The maximum anomaly score for any of the bucket influencers. This is the initial value that was calculated at the
time the bucket was processed. + /// + /// The maximum anomaly score for any of the bucket influencers. This is the initial value that was calculated at the + /// time the bucket was processed. + /// /// [JsonInclude, JsonPropertyName("initial_anomaly_score")] public double InitialAnomalyScore { get; init; } /// - /// If true, this is an interim result. In other words, the results are calculated based on partial input data. + /// + /// If true, this is an interim result. In other words, the results are calculated based on partial input data. + /// /// [JsonInclude, JsonPropertyName("is_interim")] public bool IsInterim { get; init; } /// - /// Identifier for the anomaly detection job. + /// + /// Identifier for the anomaly detection job. + /// /// [JsonInclude, JsonPropertyName("job_id")] public string JobId { get; init; } /// - /// The amount of time, in milliseconds, that it took to analyze the bucket contents and calculate results. + /// + /// The amount of time, in milliseconds, that it took to analyze the bucket contents and calculate results. + /// /// [JsonInclude, JsonPropertyName("processing_time_ms")] public long ProcessingTimeMs { get; init; } /// - /// Internal. This value is always set to bucket. + /// + /// Internal. This value is always set to bucket. + /// /// [JsonInclude, JsonPropertyName("result_type")] public string ResultType { get; init; } /// - /// The start time of the bucket. This timestamp uniquely identifies the bucket. Events that occur exactly at the
timestamp of the bucket are included in the results for the bucket. + /// + /// The start time of the bucket. This timestamp uniquely identifies the bucket. Events that occur exactly at the + /// timestamp of the bucket are included in the results for the bucket. + /// /// [JsonInclude, JsonPropertyName("timestamp")] public long Timestamp { get; init; } /// - /// The start time of the bucket. This timestamp uniquely identifies the bucket. Events that occur exactly at the
timestamp of the bucket are included in the results for the bucket. + /// + /// The start time of the bucket. This timestamp uniquely identifies the bucket. Events that occur exactly at the + /// timestamp of the bucket are included in the results for the bucket. + /// /// [JsonInclude, JsonPropertyName("timestamp_string")] public DateTimeOffset? TimestampString { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Calendar.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Calendar.g.cs index 82546040a95..1b8cb82b44e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Calendar.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Calendar.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class Calendar { /// - /// A string that uniquely identifies a calendar. + /// + /// A string that uniquely identifies a calendar. + /// /// [JsonInclude, JsonPropertyName("calendar_id")] public string CalendarId { get; init; } /// - /// A description of the calendar. + /// + /// A description of the calendar. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; init; } /// - /// An array of anomaly detection job identifiers. + /// + /// An array of anomaly detection job identifiers. + /// /// [JsonInclude, JsonPropertyName("job_ids")] public IReadOnlyCollection JobIds { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/CalendarEvent.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/CalendarEvent.g.cs index 36db5c535c4..a0e178429e7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/CalendarEvent.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/CalendarEvent.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class CalendarEvent { /// - /// A string that uniquely identifies a calendar. + /// + /// A string that uniquely identifies a calendar. + /// /// [JsonInclude, JsonPropertyName("calendar_id")] public Elastic.Clients.Elasticsearch.Id? CalendarId { get; set; } /// - /// A description of the scheduled event. + /// + /// A description of the scheduled event. + /// /// [JsonInclude, JsonPropertyName("description")] public string Description { get; set; } /// - /// The timestamp for the end of the scheduled event in milliseconds since the epoch or ISO 8601 format. + /// + /// The timestamp for the end of the scheduled event in milliseconds since the epoch or ISO 8601 format. + /// /// [JsonInclude, JsonPropertyName("end_time")] public DateTimeOffset EndTime { get; set; } @@ -50,7 +56,9 @@ public sealed partial class CalendarEvent public Elastic.Clients.Elasticsearch.Id? EventId { get; set; } /// - /// The timestamp for the beginning of the scheduled event in milliseconds since the epoch or ISO 8601 format. + /// + /// The timestamp for the beginning of the scheduled event in milliseconds since the epoch or ISO 8601 format. + /// /// [JsonInclude, JsonPropertyName("start_time")] public DateTimeOffset StartTime { get; set; } @@ -71,7 +79,9 @@ public CalendarEventDescriptor() : base() private DateTimeOffset StartTimeValue { get; set; } /// - /// A string that uniquely identifies a calendar. + /// + /// A string that uniquely identifies a calendar. + /// /// public CalendarEventDescriptor CalendarId(Elastic.Clients.Elasticsearch.Id? calendarId) { @@ -80,7 +90,9 @@ public CalendarEventDescriptor CalendarId(Elastic.Clients.Elasticsearch.Id? cale } /// - /// A description of the scheduled event. + /// + /// A description of the scheduled event. + /// /// public CalendarEventDescriptor Description(string description) { @@ -89,7 +101,9 @@ public CalendarEventDescriptor Description(string description) } /// - /// The timestamp for the end of the scheduled event in milliseconds since the epoch or ISO 8601 format. + /// + /// The timestamp for the end of the scheduled event in milliseconds since the epoch or ISO 8601 format. + /// /// public CalendarEventDescriptor EndTime(DateTimeOffset endTime) { @@ -104,7 +118,9 @@ public CalendarEventDescriptor EventId(Elastic.Clients.Elasticsearch.Id? eventId } /// - /// The timestamp for the beginning of the scheduled event in milliseconds since the epoch or ISO 8601 format. + /// + /// The timestamp for the beginning of the scheduled event in milliseconds since the epoch or ISO 8601 format. + /// /// public CalendarEventDescriptor StartTime(DateTimeOffset startTime) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/CategorizationAnalyzerDefinition.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/CategorizationAnalyzerDefinition.g.cs index 515940cab43..ee670a7e365 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/CategorizationAnalyzerDefinition.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/CategorizationAnalyzerDefinition.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class CategorizationAnalyzerDefinition { /// - /// One or more character filters. In addition to the built-in character filters, other plugins can provide more character filters. If this property is not specified, no character filters are applied prior to categorization. If you are customizing some other aspect of the analyzer and you need to achieve the equivalent of `categorization_filters` (which are not permitted when some other aspect of the analyzer is customized), add them here as pattern replace character filters. + /// + /// One or more character filters. In addition to the built-in character filters, other plugins can provide more character filters. If this property is not specified, no character filters are applied prior to categorization. If you are customizing some other aspect of the analyzer and you need to achieve the equivalent of categorization_filters (which are not permitted when some other aspect of the analyzer is customized), add them here as pattern replace character filters. + /// /// [JsonInclude, JsonPropertyName("char_filter")] public ICollection? CharFilter { get; set; } /// - /// One or more token filters. In addition to the built-in token filters, other plugins can provide more token filters. If this property is not specified, no token filters are applied prior to categorization. + /// + /// One or more token filters. In addition to the built-in token filters, other plugins can provide more token filters. If this property is not specified, no token filters are applied prior to categorization. + /// /// [JsonInclude, JsonPropertyName("filter")] public ICollection? Filter { get; set; } /// - /// The name or definition of the tokenizer to use after character filters are applied. This property is compulsory if `categorization_analyzer` is specified as an object. Machine learning provides a tokenizer called `ml_standard` that tokenizes in a way that has been determined to produce good categorization results on a variety of log file formats for logs in English. If you want to use that tokenizer but change the character or token filters, specify "tokenizer": "ml_standard" in your `categorization_analyzer`. Additionally, the `ml_classic` tokenizer is available, which tokenizes in the same way as the non-customizable tokenizer in old versions of the product (before 6.2). `ml_classic` was the default categorization tokenizer in versions 6.2 to 7.13, so if you need categorization identical to the default for jobs created in these versions, specify "tokenizer": "ml_classic" in your `categorization_analyzer`. + /// + /// The name or definition of the tokenizer to use after character filters are applied. This property is compulsory if categorization_analyzer is specified as an object. Machine learning provides a tokenizer called ml_standard that tokenizes in a way that has been determined to produce good categorization results on a variety of log file formats for logs in English. If you want to use that tokenizer but change the character or token filters, specify "tokenizer": "ml_standard" in your categorization_analyzer. Additionally, the ml_classic tokenizer is available, which tokenizes in the same way as the non-customizable tokenizer in old versions of the product (before 6.2). ml_classic was the default categorization tokenizer in versions 6.2 to 7.13, so if you need categorization identical to the default for jobs created in these versions, specify "tokenizer": "ml_classic" in your categorization_analyzer. + /// /// [JsonInclude, JsonPropertyName("tokenizer")] public Elastic.Clients.Elasticsearch.Analysis.ITokenizer? Tokenizer { get; set; } @@ -61,7 +67,9 @@ public CategorizationAnalyzerDefinitionDescriptor() : base() private Elastic.Clients.Elasticsearch.Analysis.ITokenizer? TokenizerValue { get; set; } /// - /// One or more character filters. In addition to the built-in character filters, other plugins can provide more character filters. If this property is not specified, no character filters are applied prior to categorization. If you are customizing some other aspect of the analyzer and you need to achieve the equivalent of `categorization_filters` (which are not permitted when some other aspect of the analyzer is customized), add them here as pattern replace character filters. + /// + /// One or more character filters. In addition to the built-in character filters, other plugins can provide more character filters. If this property is not specified, no character filters are applied prior to categorization. If you are customizing some other aspect of the analyzer and you need to achieve the equivalent of categorization_filters (which are not permitted when some other aspect of the analyzer is customized), add them here as pattern replace character filters. + /// /// public CategorizationAnalyzerDefinitionDescriptor CharFilter(ICollection? charFilter) { @@ -70,7 +78,9 @@ public CategorizationAnalyzerDefinitionDescriptor CharFilter(ICollection - /// One or more token filters. In addition to the built-in token filters, other plugins can provide more token filters. If this property is not specified, no token filters are applied prior to categorization. + /// + /// One or more token filters. In addition to the built-in token filters, other plugins can provide more token filters. If this property is not specified, no token filters are applied prior to categorization. + /// /// public CategorizationAnalyzerDefinitionDescriptor Filter(ICollection? filter) { @@ -79,7 +89,9 @@ public CategorizationAnalyzerDefinitionDescriptor Filter(ICollection - /// The name or definition of the tokenizer to use after character filters are applied. This property is compulsory if `categorization_analyzer` is specified as an object. Machine learning provides a tokenizer called `ml_standard` that tokenizes in a way that has been determined to produce good categorization results on a variety of log file formats for logs in English. If you want to use that tokenizer but change the character or token filters, specify "tokenizer": "ml_standard" in your `categorization_analyzer`. Additionally, the `ml_classic` tokenizer is available, which tokenizes in the same way as the non-customizable tokenizer in old versions of the product (before 6.2). `ml_classic` was the default categorization tokenizer in versions 6.2 to 7.13, so if you need categorization identical to the default for jobs created in these versions, specify "tokenizer": "ml_classic" in your `categorization_analyzer`. + /// + /// The name or definition of the tokenizer to use after character filters are applied. This property is compulsory if categorization_analyzer is specified as an object. Machine learning provides a tokenizer called ml_standard that tokenizes in a way that has been determined to produce good categorization results on a variety of log file formats for logs in English. If you want to use that tokenizer but change the character or token filters, specify "tokenizer": "ml_standard" in your categorization_analyzer. Additionally, the ml_classic tokenizer is available, which tokenizes in the same way as the non-customizable tokenizer in old versions of the product (before 6.2). ml_classic was the default categorization tokenizer in versions 6.2 to 7.13, so if you need categorization identical to the default for jobs created in these versions, specify "tokenizer": "ml_classic" in your categorization_analyzer. + /// /// public CategorizationAnalyzerDefinitionDescriptor Tokenizer(Elastic.Clients.Elasticsearch.Analysis.ITokenizer? tokenizer) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Category.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Category.g.cs index 82af9a810d8..7068e74f17d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Category.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Category.g.cs @@ -30,31 +30,41 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class Category { /// - /// A unique identifier for the category. category_id is unique at the job level, even when per-partition categorization is enabled. + /// + /// A unique identifier for the category. category_id is unique at the job level, even when per-partition categorization is enabled. + /// /// [JsonInclude, JsonPropertyName("category_id")] public long CategoryId { get; init; } /// - /// A list of examples of actual values that matched the category. + /// + /// A list of examples of actual values that matched the category. + /// /// [JsonInclude, JsonPropertyName("examples")] public IReadOnlyCollection Examples { get; init; } /// - /// [experimental] A Grok pattern that could be used in Logstash or an ingest pipeline to extract fields from messages that match the category. This field is experimental and may be changed or removed in a future release. The Grok patterns that are found are not optimal, but are often a good starting point for manual tweaking. + /// + /// [experimental] A Grok pattern that could be used in Logstash or an ingest pipeline to extract fields from messages that match the category. This field is experimental and may be changed or removed in a future release. The Grok patterns that are found are not optimal, but are often a good starting point for manual tweaking. + /// /// [JsonInclude, JsonPropertyName("grok_pattern")] public string? GrokPattern { get; init; } /// - /// Identifier for the anomaly detection job. + /// + /// Identifier for the anomaly detection job. + /// /// [JsonInclude, JsonPropertyName("job_id")] public string JobId { get; init; } /// - /// The maximum length of the fields that matched the category. The value is increased by 10% to enable matching for similar fields that have not been analyzed. + /// + /// The maximum length of the fields that matched the category. The value is increased by 10% to enable matching for similar fields that have not been analyzed. + /// /// [JsonInclude, JsonPropertyName("max_matching_length")] public long MaxMatchingLength { get; init; } @@ -62,7 +72,9 @@ public sealed partial class Category public string Mlcategory { get; init; } /// - /// The number of messages that have been matched by this category. This is only guaranteed to have the latest accurate count after a job _flush or _close + /// + /// The number of messages that have been matched by this category. This is only guaranteed to have the latest accurate count after a job _flush or _close + /// /// [JsonInclude, JsonPropertyName("num_matches")] public long? NumMatches { get; init; } @@ -70,25 +82,33 @@ public sealed partial class Category public string? p { get; init; } /// - /// If per-partition categorization is enabled, this property identifies the field used to segment the categorization. It is not present when per-partition categorization is disabled. + /// + /// If per-partition categorization is enabled, this property identifies the field used to segment the categorization. It is not present when per-partition categorization is disabled. + /// /// [JsonInclude, JsonPropertyName("partition_field_name")] public string? PartitionFieldName { get; init; } /// - /// If per-partition categorization is enabled, this property identifies the value of the partition_field_name for the category. It is not present when per-partition categorization is disabled. + /// + /// If per-partition categorization is enabled, this property identifies the value of the partition_field_name for the category. It is not present when per-partition categorization is disabled. + /// /// [JsonInclude, JsonPropertyName("partition_field_value")] public string? PartitionFieldValue { get; init; } /// - /// A list of category_id entries that this current category encompasses. Any new message that is processed by the categorizer will match against this category and not any of the categories in this list. This is only guaranteed to have the latest accurate list of categories after a job _flush or _close + /// + /// A list of category_id entries that this current category encompasses. Any new message that is processed by the categorizer will match against this category and not any of the categories in this list. This is only guaranteed to have the latest accurate list of categories after a job _flush or _close + /// /// [JsonInclude, JsonPropertyName("preferred_to_categories")] public IReadOnlyCollection? PreferredToCategories { get; init; } /// - /// A regular expression that is used to search for values that match the category. + /// + /// A regular expression that is used to search for values that match the category. + /// /// [JsonInclude, JsonPropertyName("regex")] public string Regex { get; init; } @@ -96,7 +116,9 @@ public sealed partial class Category public string ResultType { get; init; } /// - /// A space separated list of the common tokens that are matched in values of the category. + /// + /// A space separated list of the common tokens that are matched in values of the category. + /// /// [JsonInclude, JsonPropertyName("terms")] public string Terms { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ChunkingConfig.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ChunkingConfig.g.cs index 7c1bd56c6ce..be00153c687 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ChunkingConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ChunkingConfig.g.cs @@ -30,13 +30,20 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class ChunkingConfig { /// - /// If the mode is `auto`, the chunk size is dynamically calculated;
this is the recommended value when the datafeed does not use aggregations.
If the mode is `manual`, chunking is applied according to the specified `time_span`;
use this mode when the datafeed uses aggregations. If the mode is `off`, no chunking is applied. + /// + /// If the mode is auto, the chunk size is dynamically calculated; + /// this is the recommended value when the datafeed does not use aggregations. + /// If the mode is manual, chunking is applied according to the specified time_span; + /// use this mode when the datafeed uses aggregations. If the mode is off, no chunking is applied. + /// /// [JsonInclude, JsonPropertyName("mode")] public Elastic.Clients.Elasticsearch.MachineLearning.ChunkingMode Mode { get; set; } /// - /// The time span that each search will be querying. This setting is applicable only when the `mode` is set to `manual`. + /// + /// The time span that each search will be querying. This setting is applicable only when the mode is set to manual. + /// /// [JsonInclude, JsonPropertyName("time_span")] public Elastic.Clients.Elasticsearch.Duration? TimeSpan { get; set; } @@ -54,7 +61,12 @@ public ChunkingConfigDescriptor() : base() private Elastic.Clients.Elasticsearch.Duration? TimeSpanValue { get; set; } /// - /// If the mode is `auto`, the chunk size is dynamically calculated;
this is the recommended value when the datafeed does not use aggregations.
If the mode is `manual`, chunking is applied according to the specified `time_span`;
use this mode when the datafeed uses aggregations. If the mode is `off`, no chunking is applied. + /// + /// If the mode is auto, the chunk size is dynamically calculated; + /// this is the recommended value when the datafeed does not use aggregations. + /// If the mode is manual, chunking is applied according to the specified time_span; + /// use this mode when the datafeed uses aggregations. If the mode is off, no chunking is applied. + /// /// public ChunkingConfigDescriptor Mode(Elastic.Clients.Elasticsearch.MachineLearning.ChunkingMode mode) { @@ -63,7 +75,9 @@ public ChunkingConfigDescriptor Mode(Elastic.Clients.Elasticsearch.MachineLearni } /// - /// The time span that each search will be querying. This setting is applicable only when the `mode` is set to `manual`. + /// + /// The time span that each search will be querying. This setting is applicable only when the mode is set to manual. + /// /// public ChunkingConfigDescriptor TimeSpan(Elastic.Clients.Elasticsearch.Duration? timeSpan) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ClassificationInferenceOptions.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ClassificationInferenceOptions.g.cs index 60aacf79e09..459ed12623c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ClassificationInferenceOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ClassificationInferenceOptions.g.cs @@ -30,31 +30,41 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class ClassificationInferenceOptions { /// - /// Specifies the number of top class predictions to return. Defaults to 0. + /// + /// Specifies the number of top class predictions to return. Defaults to 0. + /// /// [JsonInclude, JsonPropertyName("num_top_classes")] public int? NumTopClasses { get; set; } /// - /// Specifies the maximum number of feature importance values per document. + /// + /// Specifies the maximum number of feature importance values per document. + /// /// [JsonInclude, JsonPropertyName("num_top_feature_importance_values")] public int? NumTopFeatureImportanceValues { get; set; } /// - /// Specifies the type of the predicted field to write. Acceptable values are: string, number, boolean. When boolean is provided 1.0 is transformed to true and 0.0 to false. + /// + /// Specifies the type of the predicted field to write. Acceptable values are: string, number, boolean. When boolean is provided 1.0 is transformed to true and 0.0 to false. + /// /// [JsonInclude, JsonPropertyName("prediction_field_type")] public string? PredictionFieldType { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } /// - /// Specifies the field to which the top classes are written. Defaults to top_classes. + /// + /// Specifies the field to which the top classes are written. Defaults to top_classes. + /// /// [JsonInclude, JsonPropertyName("top_classes_results_field")] public string? TopClassesResultsField { get; set; } @@ -79,7 +89,9 @@ public ClassificationInferenceOptionsDescriptor() : base() private string? TopClassesResultsFieldValue { get; set; } /// - /// Specifies the number of top class predictions to return. Defaults to 0. + /// + /// Specifies the number of top class predictions to return. Defaults to 0. + /// /// public ClassificationInferenceOptionsDescriptor NumTopClasses(int? numTopClasses) { @@ -88,7 +100,9 @@ public ClassificationInferenceOptionsDescriptor NumTopClasses(int? numTopClasses } /// - /// Specifies the maximum number of feature importance values per document. + /// + /// Specifies the maximum number of feature importance values per document. + /// /// public ClassificationInferenceOptionsDescriptor NumTopFeatureImportanceValues(int? numTopFeatureImportanceValues) { @@ -97,7 +111,9 @@ public ClassificationInferenceOptionsDescriptor NumTopFeatureImportanceValues(in } /// - /// Specifies the type of the predicted field to write. Acceptable values are: string, number, boolean. When boolean is provided 1.0 is transformed to true and 0.0 to false. + /// + /// Specifies the type of the predicted field to write. Acceptable values are: string, number, boolean. When boolean is provided 1.0 is transformed to true and 0.0 to false. + /// /// public ClassificationInferenceOptionsDescriptor PredictionFieldType(string? predictionFieldType) { @@ -106,7 +122,9 @@ public ClassificationInferenceOptionsDescriptor PredictionFieldType(string? pred } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public ClassificationInferenceOptionsDescriptor ResultsField(string? resultsField) { @@ -115,7 +133,9 @@ public ClassificationInferenceOptionsDescriptor ResultsField(string? resultsFiel } /// - /// Specifies the field to which the top classes are written. Defaults to top_classes. + /// + /// Specifies the field to which the top classes are written. Defaults to top_classes. + /// /// public ClassificationInferenceOptionsDescriptor TopClassesResultsField(string? topClassesResultsField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ConfusionMatrixThreshold.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ConfusionMatrixThreshold.g.cs index 1a6e08fd696..c4bd30a85f9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ConfusionMatrixThreshold.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ConfusionMatrixThreshold.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class ConfusionMatrixThreshold { /// - /// False Negative + /// + /// False Negative + /// /// [JsonInclude, JsonPropertyName("fn")] public int FalseNegative { get; init; } /// - /// False Positive + /// + /// False Positive + /// /// [JsonInclude, JsonPropertyName("fp")] public int FalsePositive { get; init; } /// - /// True Negative + /// + /// True Negative + /// /// [JsonInclude, JsonPropertyName("tn")] public int TrueNegative { get; init; } /// - /// True Positive + /// + /// True Positive + /// /// [JsonInclude, JsonPropertyName("tp")] public int TruePositive { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataDescription.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataDescription.g.cs index 7df6db241f3..c2f8ff09348 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataDescription.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataDescription.g.cs @@ -33,19 +33,25 @@ public sealed partial class DataDescription public string? FieldDelimiter { get; set; } /// - /// Only JSON format is supported at this time. + /// + /// Only JSON format is supported at this time. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// The name of the field that contains the timestamp. + /// + /// The name of the field that contains the timestamp. + /// /// [JsonInclude, JsonPropertyName("time_field")] public Elastic.Clients.Elasticsearch.Field? TimeField { get; set; } /// - /// The time format, which can be `epoch`, `epoch_ms`, or a custom pattern. The value `epoch` refers to UNIX or Epoch time (the number of seconds since 1 Jan 1970). The value `epoch_ms` indicates that time is measured in milliseconds since the epoch. The `epoch` and `epoch_ms` time formats accept either integer or real values. Custom patterns must conform to the Java DateTimeFormatter class. When you use date-time formatting patterns, it is recommended that you provide the full date, time and time zone. For example: `yyyy-MM-dd'T'HH:mm:ssX`. If the pattern that you specify is not sufficient to produce a complete timestamp, job creation fails. + /// + /// The time format, which can be epoch, epoch_ms, or a custom pattern. The value epoch refers to UNIX or Epoch time (the number of seconds since 1 Jan 1970). The value epoch_ms indicates that time is measured in milliseconds since the epoch. The epoch and epoch_ms time formats accept either integer or real values. Custom patterns must conform to the Java DateTimeFormatter class. When you use date-time formatting patterns, it is recommended that you provide the full date, time and time zone. For example: yyyy-MM-dd'T'HH:mm:ssX. If the pattern that you specify is not sufficient to produce a complete timestamp, job creation fails. + /// /// [JsonInclude, JsonPropertyName("time_format")] public string? TimeFormat { get; set; } @@ -71,7 +77,9 @@ public DataDescriptionDescriptor FieldDelimiter(string? fieldDelimite } /// - /// Only JSON format is supported at this time. + /// + /// Only JSON format is supported at this time. + /// /// public DataDescriptionDescriptor Format(string? format) { @@ -80,7 +88,9 @@ public DataDescriptionDescriptor Format(string? format) } /// - /// The name of the field that contains the timestamp. + /// + /// The name of the field that contains the timestamp. + /// /// public DataDescriptionDescriptor TimeField(Elastic.Clients.Elasticsearch.Field? timeField) { @@ -89,7 +99,9 @@ public DataDescriptionDescriptor TimeField(Elastic.Clients.Elasticsea } /// - /// The name of the field that contains the timestamp. + /// + /// The name of the field that contains the timestamp. + /// /// public DataDescriptionDescriptor TimeField(Expression> timeField) { @@ -98,7 +110,9 @@ public DataDescriptionDescriptor TimeField(Expression - /// The name of the field that contains the timestamp. + /// + /// The name of the field that contains the timestamp. + /// /// public DataDescriptionDescriptor TimeField(Expression> timeField) { @@ -107,7 +121,9 @@ public DataDescriptionDescriptor TimeField(Expression - /// The time format, which can be `epoch`, `epoch_ms`, or a custom pattern. The value `epoch` refers to UNIX or Epoch time (the number of seconds since 1 Jan 1970). The value `epoch_ms` indicates that time is measured in milliseconds since the epoch. The `epoch` and `epoch_ms` time formats accept either integer or real values. Custom patterns must conform to the Java DateTimeFormatter class. When you use date-time formatting patterns, it is recommended that you provide the full date, time and time zone. For example: `yyyy-MM-dd'T'HH:mm:ssX`. If the pattern that you specify is not sufficient to produce a complete timestamp, job creation fails. + /// + /// The time format, which can be epoch, epoch_ms, or a custom pattern. The value epoch refers to UNIX or Epoch time (the number of seconds since 1 Jan 1970). The value epoch_ms indicates that time is measured in milliseconds since the epoch. The epoch and epoch_ms time formats accept either integer or real values. Custom patterns must conform to the Java DateTimeFormatter class. When you use date-time formatting patterns, it is recommended that you provide the full date, time and time zone. For example: yyyy-MM-dd'T'HH:mm:ssX. If the pattern that you specify is not sufficient to produce a complete timestamp, job creation fails. + /// /// public DataDescriptionDescriptor TimeFormat(string? timeFormat) { @@ -166,7 +182,9 @@ public DataDescriptionDescriptor FieldDelimiter(string? fieldDelimiter) } /// - /// Only JSON format is supported at this time. + /// + /// Only JSON format is supported at this time. + /// /// public DataDescriptionDescriptor Format(string? format) { @@ -175,7 +193,9 @@ public DataDescriptionDescriptor Format(string? format) } /// - /// The name of the field that contains the timestamp. + /// + /// The name of the field that contains the timestamp. + /// /// public DataDescriptionDescriptor TimeField(Elastic.Clients.Elasticsearch.Field? timeField) { @@ -184,7 +204,9 @@ public DataDescriptionDescriptor TimeField(Elastic.Clients.Elasticsearch.Field? } /// - /// The name of the field that contains the timestamp. + /// + /// The name of the field that contains the timestamp. + /// /// public DataDescriptionDescriptor TimeField(Expression> timeField) { @@ -193,7 +215,9 @@ public DataDescriptionDescriptor TimeField(Expression - /// The name of the field that contains the timestamp. + /// + /// The name of the field that contains the timestamp. + /// /// public DataDescriptionDescriptor TimeField(Expression> timeField) { @@ -202,7 +226,9 @@ public DataDescriptionDescriptor TimeField(Expression - /// The time format, which can be `epoch`, `epoch_ms`, or a custom pattern. The value `epoch` refers to UNIX or Epoch time (the number of seconds since 1 Jan 1970). The value `epoch_ms` indicates that time is measured in milliseconds since the epoch. The `epoch` and `epoch_ms` time formats accept either integer or real values. Custom patterns must conform to the Java DateTimeFormatter class. When you use date-time formatting patterns, it is recommended that you provide the full date, time and time zone. For example: `yyyy-MM-dd'T'HH:mm:ssX`. If the pattern that you specify is not sufficient to produce a complete timestamp, job creation fails. + /// + /// The time format, which can be epoch, epoch_ms, or a custom pattern. The value epoch refers to UNIX or Epoch time (the number of seconds since 1 Jan 1970). The value epoch_ms indicates that time is measured in milliseconds since the epoch. The epoch and epoch_ms time formats accept either integer or real values. Custom patterns must conform to the Java DateTimeFormatter class. When you use date-time formatting patterns, it is recommended that you provide the full date, time and time zone. For example: yyyy-MM-dd'T'HH:mm:ssX. If the pattern that you specify is not sufficient to produce a complete timestamp, job creation fails. + /// /// public DataDescriptionDescriptor TimeFormat(string? timeFormat) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Datafeed.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Datafeed.g.cs index 6253b74ce2b..399bbc72bc7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Datafeed.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Datafeed.g.cs @@ -167,7 +167,9 @@ public sealed partial class Datafeed public IReadOnlyDictionary? Aggregations { get; init; } /// - /// The security privileges that the datafeed uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the datafeed, this property is omitted. + /// + /// The security privileges that the datafeed uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the datafeed, this property is omitted. + /// /// public Elastic.Clients.Elasticsearch.MachineLearning.DatafeedAuthorization? Authorization { get; init; } public Elastic.Clients.Elasticsearch.MachineLearning.ChunkingConfig? ChunkingConfig { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DatafeedAuthorization.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DatafeedAuthorization.g.cs index 7117939781d..966bab43c78 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DatafeedAuthorization.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DatafeedAuthorization.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DatafeedAuthorization { /// - /// If an API key was used for the most recent update to the datafeed, its name and identifier are listed in the response. + /// + /// If an API key was used for the most recent update to the datafeed, its name and identifier are listed in the response. + /// /// [JsonInclude, JsonPropertyName("api_key")] public Elastic.Clients.Elasticsearch.MachineLearning.ApiKeyAuthorization? ApiKey { get; init; } /// - /// If a user ID was used for the most recent update to the datafeed, its roles at the time of the update are listed in the response. + /// + /// If a user ID was used for the most recent update to the datafeed, its roles at the time of the update are listed in the response. + /// /// [JsonInclude, JsonPropertyName("roles")] public IReadOnlyCollection? Roles { get; init; } /// - /// If a service account was used for the most recent update to the datafeed, the account name is listed in the response. + /// + /// If a service account was used for the most recent update to the datafeed, the account name is listed in the response. + /// /// [JsonInclude, JsonPropertyName("service_account")] public string? ServiceAccount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DatafeedConfig.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DatafeedConfig.g.cs index f882d7f0478..0402dcefb43 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DatafeedConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DatafeedConfig.g.cs @@ -223,68 +223,94 @@ public override void Write(Utf8JsonWriter writer, DatafeedConfig value, JsonSeri public sealed partial class DatafeedConfig { /// - /// If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data. + /// + /// If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data. + /// /// public IDictionary? Aggregations { get; set; } /// - /// Datafeeds might be required to search over long time periods, for several months or years. This search is split into time chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of these time chunks are calculated and is an advanced configuration option. + /// + /// Datafeeds might be required to search over long time periods, for several months or years. This search is split into time chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of these time chunks are calculated and is an advanced configuration option. + /// /// public Elastic.Clients.Elasticsearch.MachineLearning.ChunkingConfig? ChunkingConfig { get; set; } /// - /// A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. The default value is the job identifier. + /// + /// A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. The default value is the job identifier. + /// /// public Elastic.Clients.Elasticsearch.Id? DatafeedId { get; set; } /// - /// Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally search over indices that have already been read in an effort to determine whether any data has subsequently been added to the index. If missing data is found, it is a good indication that the `query_delay` option is set too low and the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time datafeeds. + /// + /// Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally search over indices that have already been read in an effort to determine whether any data has subsequently been added to the index. If missing data is found, it is a good indication that the query_delay option is set too low and the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time datafeeds. + /// /// public Elastic.Clients.Elasticsearch.MachineLearning.DelayedDataCheckConfig? DelayedDataCheckConfig { get; set; } /// - /// The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. For example: `150s`. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation. + /// + /// The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. For example: 150s. When frequency is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation. + /// /// public Elastic.Clients.Elasticsearch.Duration? Frequency { get; set; } /// - /// An array of index names. Wildcards are supported. If any indices are in remote clusters, the machine learning nodes must have the `remote_cluster_client` role. + /// + /// An array of index names. Wildcards are supported. If any indices are in remote clusters, the machine learning nodes must have the remote_cluster_client role. + /// /// public Elastic.Clients.Elasticsearch.Indices? Indices { get; set; } /// - /// Specifies index expansion options that are used during search. + /// + /// Specifies index expansion options that are used during search. + /// /// public Elastic.Clients.Elasticsearch.IndicesOptions? IndicesOptions { get; set; } public Elastic.Clients.Elasticsearch.Id? JobId { get; set; } /// - /// If a real-time datafeed has never seen any data (including during any initial training period) then it will automatically stop itself and close its associated job after this many real-time searches that return no documents. In other words, it will stop after `frequency` times `max_empty_searches` of real-time operation. If not set then a datafeed with no end time that sees no data will remain started until it is explicitly stopped. + /// + /// If a real-time datafeed has never seen any data (including during any initial training period) then it will automatically stop itself and close its associated job after this many real-time searches that return no documents. In other words, it will stop after frequency times max_empty_searches of real-time operation. If not set then a datafeed with no end time that sees no data will remain started until it is explicitly stopped. + /// /// public int? MaxEmptySearches { get; set; } /// - /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. + /// + /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. + /// /// public Elastic.Clients.Elasticsearch.QueryDsl.Query? Query { get; set; } /// - /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default value is randomly selected between `60s` and `120s`. This randomness improves the query performance when there are multiple jobs running on the same node. + /// + /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default value is randomly selected between 60s and 120s. This randomness improves the query performance when there are multiple jobs running on the same node. + /// /// public Elastic.Clients.Elasticsearch.Duration? QueryDelay { get; set; } /// - /// Specifies runtime fields for the datafeed search. + /// + /// Specifies runtime fields for the datafeed search. + /// /// public IDictionary? RuntimeMappings { get; set; } /// - /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. The detector configuration objects in a job can contain functions that use these script fields. + /// + /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. The detector configuration objects in a job can contain functions that use these script fields. + /// /// public IDictionary? ScriptFields { get; set; } /// - /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. The maximum value is the value of `index.max_result_window`, which is 10,000 by default. + /// + /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. The maximum value is the value of index.max_result_window, which is 10,000 by default. + /// /// public int? ScrollSize { get; set; } } @@ -321,7 +347,9 @@ public DatafeedConfigDescriptor() : base() private int? ScrollSizeValue { get; set; } /// - /// If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data. + /// + /// If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data. + /// /// public DatafeedConfigDescriptor Aggregations(Func>, FluentDescriptorDictionary>> selector) { @@ -330,7 +358,9 @@ public DatafeedConfigDescriptor Aggregations(Func - /// Datafeeds might be required to search over long time periods, for several months or years. This search is split into time chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of these time chunks are calculated and is an advanced configuration option. + /// + /// Datafeeds might be required to search over long time periods, for several months or years. This search is split into time chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of these time chunks are calculated and is an advanced configuration option. + /// /// public DatafeedConfigDescriptor ChunkingConfig(Elastic.Clients.Elasticsearch.MachineLearning.ChunkingConfig? chunkingConfig) { @@ -357,7 +387,9 @@ public DatafeedConfigDescriptor ChunkingConfig(Action - /// A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. The default value is the job identifier. + /// + /// A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. The default value is the job identifier. + /// /// public DatafeedConfigDescriptor DatafeedId(Elastic.Clients.Elasticsearch.Id? datafeedId) { @@ -366,7 +398,9 @@ public DatafeedConfigDescriptor DatafeedId(Elastic.Clients.Elasticsea } /// - /// Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally search over indices that have already been read in an effort to determine whether any data has subsequently been added to the index. If missing data is found, it is a good indication that the `query_delay` option is set too low and the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time datafeeds. + /// + /// Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally search over indices that have already been read in an effort to determine whether any data has subsequently been added to the index. If missing data is found, it is a good indication that the query_delay option is set too low and the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time datafeeds. + /// /// public DatafeedConfigDescriptor DelayedDataCheckConfig(Elastic.Clients.Elasticsearch.MachineLearning.DelayedDataCheckConfig? delayedDataCheckConfig) { @@ -393,7 +427,9 @@ public DatafeedConfigDescriptor DelayedDataCheckConfig(Action - /// The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. For example: `150s`. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation. + /// + /// The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. For example: 150s. When frequency is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation. + /// /// public DatafeedConfigDescriptor Frequency(Elastic.Clients.Elasticsearch.Duration? frequency) { @@ -402,7 +438,9 @@ public DatafeedConfigDescriptor Frequency(Elastic.Clients.Elasticsear } /// - /// An array of index names. Wildcards are supported. If any indices are in remote clusters, the machine learning nodes must have the `remote_cluster_client` role. + /// + /// An array of index names. Wildcards are supported. If any indices are in remote clusters, the machine learning nodes must have the remote_cluster_client role. + /// /// public DatafeedConfigDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? indices) { @@ -411,7 +449,9 @@ public DatafeedConfigDescriptor Indices(Elastic.Clients.Elasticsearch } /// - /// Specifies index expansion options that are used during search. + /// + /// Specifies index expansion options that are used during search. + /// /// public DatafeedConfigDescriptor IndicesOptions(Elastic.Clients.Elasticsearch.IndicesOptions? indicesOptions) { @@ -444,7 +484,9 @@ public DatafeedConfigDescriptor JobId(Elastic.Clients.Elasticsearch.I } /// - /// If a real-time datafeed has never seen any data (including during any initial training period) then it will automatically stop itself and close its associated job after this many real-time searches that return no documents. In other words, it will stop after `frequency` times `max_empty_searches` of real-time operation. If not set then a datafeed with no end time that sees no data will remain started until it is explicitly stopped. + /// + /// If a real-time datafeed has never seen any data (including during any initial training period) then it will automatically stop itself and close its associated job after this many real-time searches that return no documents. In other words, it will stop after frequency times max_empty_searches of real-time operation. If not set then a datafeed with no end time that sees no data will remain started until it is explicitly stopped. + /// /// public DatafeedConfigDescriptor MaxEmptySearches(int? maxEmptySearches) { @@ -453,7 +495,9 @@ public DatafeedConfigDescriptor MaxEmptySearches(int? maxEmptySearche } /// - /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. + /// + /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. + /// /// public DatafeedConfigDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -480,7 +524,9 @@ public DatafeedConfigDescriptor Query(Action - /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default value is randomly selected between `60s` and `120s`. This randomness improves the query performance when there are multiple jobs running on the same node. + /// + /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default value is randomly selected between 60s and 120s. This randomness improves the query performance when there are multiple jobs running on the same node. + /// /// public DatafeedConfigDescriptor QueryDelay(Elastic.Clients.Elasticsearch.Duration? queryDelay) { @@ -489,7 +535,9 @@ public DatafeedConfigDescriptor QueryDelay(Elastic.Clients.Elasticsea } /// - /// Specifies runtime fields for the datafeed search. + /// + /// Specifies runtime fields for the datafeed search. + /// /// public DatafeedConfigDescriptor RuntimeMappings(Func>, FluentDescriptorDictionary>> selector) { @@ -498,7 +546,9 @@ public DatafeedConfigDescriptor RuntimeMappings(Func - /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. The detector configuration objects in a job can contain functions that use these script fields. + /// + /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. The detector configuration objects in a job can contain functions that use these script fields. + /// /// public DatafeedConfigDescriptor ScriptFields(Func, FluentDescriptorDictionary> selector) { @@ -507,7 +557,9 @@ public DatafeedConfigDescriptor ScriptFields(Func - /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. The maximum value is the value of `index.max_result_window`, which is 10,000 by default. + /// + /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. The maximum value is the value of index.max_result_window, which is 10,000 by default. + /// /// public DatafeedConfigDescriptor ScrollSize(int? scrollSize) { @@ -678,7 +730,9 @@ public DatafeedConfigDescriptor() : base() private int? ScrollSizeValue { get; set; } /// - /// If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data. + /// + /// If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data. + /// /// public DatafeedConfigDescriptor Aggregations(Func, FluentDescriptorDictionary> selector) { @@ -687,7 +741,9 @@ public DatafeedConfigDescriptor Aggregations(Func - /// Datafeeds might be required to search over long time periods, for several months or years. This search is split into time chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of these time chunks are calculated and is an advanced configuration option. + /// + /// Datafeeds might be required to search over long time periods, for several months or years. This search is split into time chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of these time chunks are calculated and is an advanced configuration option. + /// /// public DatafeedConfigDescriptor ChunkingConfig(Elastic.Clients.Elasticsearch.MachineLearning.ChunkingConfig? chunkingConfig) { @@ -714,7 +770,9 @@ public DatafeedConfigDescriptor ChunkingConfig(Action - /// A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. The default value is the job identifier. + /// + /// A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. The default value is the job identifier. + /// /// public DatafeedConfigDescriptor DatafeedId(Elastic.Clients.Elasticsearch.Id? datafeedId) { @@ -723,7 +781,9 @@ public DatafeedConfigDescriptor DatafeedId(Elastic.Clients.Elasticsearch.Id? dat } /// - /// Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally search over indices that have already been read in an effort to determine whether any data has subsequently been added to the index. If missing data is found, it is a good indication that the `query_delay` option is set too low and the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time datafeeds. + /// + /// Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally search over indices that have already been read in an effort to determine whether any data has subsequently been added to the index. If missing data is found, it is a good indication that the query_delay option is set too low and the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time datafeeds. + /// /// public DatafeedConfigDescriptor DelayedDataCheckConfig(Elastic.Clients.Elasticsearch.MachineLearning.DelayedDataCheckConfig? delayedDataCheckConfig) { @@ -750,7 +810,9 @@ public DatafeedConfigDescriptor DelayedDataCheckConfig(Action - /// The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. For example: `150s`. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation. + /// + /// The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. For example: 150s. When frequency is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation. + /// /// public DatafeedConfigDescriptor Frequency(Elastic.Clients.Elasticsearch.Duration? frequency) { @@ -759,7 +821,9 @@ public DatafeedConfigDescriptor Frequency(Elastic.Clients.Elasticsearch.Duration } /// - /// An array of index names. Wildcards are supported. If any indices are in remote clusters, the machine learning nodes must have the `remote_cluster_client` role. + /// + /// An array of index names. Wildcards are supported. If any indices are in remote clusters, the machine learning nodes must have the remote_cluster_client role. + /// /// public DatafeedConfigDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? indices) { @@ -768,7 +832,9 @@ public DatafeedConfigDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? i } /// - /// Specifies index expansion options that are used during search. + /// + /// Specifies index expansion options that are used during search. + /// /// public DatafeedConfigDescriptor IndicesOptions(Elastic.Clients.Elasticsearch.IndicesOptions? indicesOptions) { @@ -801,7 +867,9 @@ public DatafeedConfigDescriptor JobId(Elastic.Clients.Elasticsearch.Id? jobId) } /// - /// If a real-time datafeed has never seen any data (including during any initial training period) then it will automatically stop itself and close its associated job after this many real-time searches that return no documents. In other words, it will stop after `frequency` times `max_empty_searches` of real-time operation. If not set then a datafeed with no end time that sees no data will remain started until it is explicitly stopped. + /// + /// If a real-time datafeed has never seen any data (including during any initial training period) then it will automatically stop itself and close its associated job after this many real-time searches that return no documents. In other words, it will stop after frequency times max_empty_searches of real-time operation. If not set then a datafeed with no end time that sees no data will remain started until it is explicitly stopped. + /// /// public DatafeedConfigDescriptor MaxEmptySearches(int? maxEmptySearches) { @@ -810,7 +878,9 @@ public DatafeedConfigDescriptor MaxEmptySearches(int? maxEmptySearches) } /// - /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. + /// + /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. + /// /// public DatafeedConfigDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -837,7 +907,9 @@ public DatafeedConfigDescriptor Query(Action - /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default value is randomly selected between `60s` and `120s`. This randomness improves the query performance when there are multiple jobs running on the same node. + /// + /// The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default value is randomly selected between 60s and 120s. This randomness improves the query performance when there are multiple jobs running on the same node. + /// /// public DatafeedConfigDescriptor QueryDelay(Elastic.Clients.Elasticsearch.Duration? queryDelay) { @@ -846,7 +918,9 @@ public DatafeedConfigDescriptor QueryDelay(Elastic.Clients.Elasticsearch.Duratio } /// - /// Specifies runtime fields for the datafeed search. + /// + /// Specifies runtime fields for the datafeed search. + /// /// public DatafeedConfigDescriptor RuntimeMappings(Func, FluentDescriptorDictionary> selector) { @@ -855,7 +929,9 @@ public DatafeedConfigDescriptor RuntimeMappings(Func - /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. The detector configuration objects in a job can contain functions that use these script fields. + /// + /// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. The detector configuration objects in a job can contain functions that use these script fields. + /// /// public DatafeedConfigDescriptor ScriptFields(Func, FluentDescriptorDictionary> selector) { @@ -864,7 +940,9 @@ public DatafeedConfigDescriptor ScriptFields(Func - /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. The maximum value is the value of `index.max_result_window`, which is 10,000 by default. + /// + /// The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. The maximum value is the value of index.max_result_window, which is 10,000 by default. + /// /// public DatafeedConfigDescriptor ScrollSize(int? scrollSize) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DatafeedRunningState.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DatafeedRunningState.g.cs index d1ec9342e35..c73e1ee16ce 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DatafeedRunningState.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DatafeedRunningState.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DatafeedRunningState { /// - /// Indicates if the datafeed is "real-time"; meaning that the datafeed has no configured `end` time. + /// + /// Indicates if the datafeed is "real-time"; meaning that the datafeed has no configured end time. + /// /// [JsonInclude, JsonPropertyName("real_time_configured")] public bool RealTimeConfigured { get; init; } /// - /// Indicates whether the datafeed has finished running on the available past data.
For datafeeds without a configured `end` time, this means that the datafeed is now running on "real-time" data. + /// + /// Indicates whether the datafeed has finished running on the available past data. + /// For datafeeds without a configured end time, this means that the datafeed is now running on "real-time" data. + /// /// [JsonInclude, JsonPropertyName("real_time_running")] public bool RealTimeRunning { get; init; } /// - /// Provides the latest time interval the datafeed has searched. + /// + /// Provides the latest time interval the datafeed has searched. + /// /// [JsonInclude, JsonPropertyName("search_interval")] public Elastic.Clients.Elasticsearch.MachineLearning.RunningStateSearchInterval? SearchInterval { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DatafeedStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DatafeedStats.g.cs index b24bacfa320..201c27455b9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DatafeedStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DatafeedStats.g.cs @@ -30,37 +30,52 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DatafeedStats { /// - /// For started datafeeds only, contains messages relating to the selection of a node. + /// + /// For started datafeeds only, contains messages relating to the selection of a node. + /// /// [JsonInclude, JsonPropertyName("assignment_explanation")] public string? AssignmentExplanation { get; init; } /// - /// A numerical character string that uniquely identifies the datafeed.
This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
It must start and end with alphanumeric characters. + /// + /// A numerical character string that uniquely identifies the datafeed. + /// This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. + /// It must start and end with alphanumeric characters. + /// /// [JsonInclude, JsonPropertyName("datafeed_id")] public string DatafeedId { get; init; } /// - /// For started datafeeds only, this information pertains to the node upon which the datafeed is started. + /// + /// For started datafeeds only, this information pertains to the node upon which the datafeed is started. + /// /// [JsonInclude, JsonPropertyName("node")] public Elastic.Clients.Elasticsearch.MachineLearning.DiscoveryNode? Node { get; init; } /// - /// An object containing the running state for this datafeed.
It is only provided if the datafeed is started. + /// + /// An object containing the running state for this datafeed. + /// It is only provided if the datafeed is started. + /// /// [JsonInclude, JsonPropertyName("running_state")] public Elastic.Clients.Elasticsearch.MachineLearning.DatafeedRunningState? RunningState { get; init; } /// - /// The status of the datafeed, which can be one of the following values: `starting`, `started`, `stopping`, `stopped`. + /// + /// The status of the datafeed, which can be one of the following values: starting, started, stopping, stopped. + /// /// [JsonInclude, JsonPropertyName("state")] public Elastic.Clients.Elasticsearch.MachineLearning.DatafeedState State { get; init; } /// - /// An object that provides statistical information about timing aspect of this datafeed. + /// + /// An object that provides statistical information about timing aspect of this datafeed. + /// /// [JsonInclude, JsonPropertyName("timing_stats")] public Elastic.Clients.Elasticsearch.MachineLearning.DatafeedTimingStats TimingStats { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DatafeedTimingStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DatafeedTimingStats.g.cs index 2ba4a239983..cb452a08436 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DatafeedTimingStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DatafeedTimingStats.g.cs @@ -30,37 +30,49 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DatafeedTimingStats { /// - /// The average search time per bucket, in milliseconds. + /// + /// The average search time per bucket, in milliseconds. + /// /// [JsonInclude, JsonPropertyName("average_search_time_per_bucket_ms")] public double? AverageSearchTimePerBucketMs { get; init; } /// - /// The number of buckets processed. + /// + /// The number of buckets processed. + /// /// [JsonInclude, JsonPropertyName("bucket_count")] public long BucketCount { get; init; } /// - /// The exponential average search time per hour, in milliseconds. + /// + /// The exponential average search time per hour, in milliseconds. + /// /// [JsonInclude, JsonPropertyName("exponential_average_search_time_per_hour_ms")] public double ExponentialAverageSearchTimePerHourMs { get; init; } /// - /// Identifier for the anomaly detection job. + /// + /// Identifier for the anomaly detection job. + /// /// [JsonInclude, JsonPropertyName("job_id")] public string JobId { get; init; } /// - /// The number of searches run by the datafeed. + /// + /// The number of searches run by the datafeed. + /// /// [JsonInclude, JsonPropertyName("search_count")] public long SearchCount { get; init; } /// - /// The total time the datafeed spent searching, in milliseconds. + /// + /// The total time the datafeed spent searching, in milliseconds. + /// /// [JsonInclude, JsonPropertyName("total_search_time_ms")] public double TotalSearchTimeMs { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisAnalyzedFields.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisAnalyzedFields.g.cs index ce7f87efc88..0ceb9b0f4e9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisAnalyzedFields.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisAnalyzedFields.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DataframeAnalysisAnalyzedFields { /// - /// An array of strings that defines the fields that will be included in the analysis. + /// + /// An array of strings that defines the fields that will be included in the analysis. + /// /// [JsonInclude, JsonPropertyName("excludes")] public ICollection Excludes { get; set; } /// - /// An array of strings that defines the fields that will be excluded from the analysis. You do not need to add fields with unsupported data types to excludes, these fields are excluded from the analysis automatically. + /// + /// An array of strings that defines the fields that will be excluded from the analysis. You do not need to add fields with unsupported data types to excludes, these fields are excluded from the analysis automatically. + /// /// [JsonInclude, JsonPropertyName("includes")] public ICollection Includes { get; set; } @@ -54,7 +58,9 @@ public DataframeAnalysisAnalyzedFieldsDescriptor() : base() private ICollection IncludesValue { get; set; } /// - /// An array of strings that defines the fields that will be included in the analysis. + /// + /// An array of strings that defines the fields that will be included in the analysis. + /// /// public DataframeAnalysisAnalyzedFieldsDescriptor Excludes(ICollection excludes) { @@ -63,7 +69,9 @@ public DataframeAnalysisAnalyzedFieldsDescriptor Excludes(ICollection ex } /// - /// An array of strings that defines the fields that will be excluded from the analysis. You do not need to add fields with unsupported data types to excludes, these fields are excluded from the analysis automatically. + /// + /// An array of strings that defines the fields that will be excluded from the analysis. You do not need to add fields with unsupported data types to excludes, these fields are excluded from the analysis automatically. + /// /// public DataframeAnalysisAnalyzedFieldsDescriptor Includes(ICollection includes) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisClassification.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisClassification.g.cs index 262f70e6ca1..06504695f4c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisClassification.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisClassification.g.cs @@ -291,98 +291,138 @@ public override void Write(Utf8JsonWriter writer, DataframeAnalysisClassificatio public sealed partial class DataframeAnalysisClassification { /// - /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero. + /// + /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero. + /// /// public double? Alpha { get; set; } public string? ClassAssignmentObjective { get; set; } /// - /// Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable.
For classification analysis, the data type of the field must be numeric (`integer`, `short`, `long`, `byte`), categorical (`ip` or `keyword`), or `boolean`. There must be no more than 30 different values in this field.
For regression analysis, the data type of the field must be numeric. + /// + /// Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable. + /// For classification analysis, the data type of the field must be numeric (integer, short, long, byte), categorical (ip or keyword), or boolean. There must be no more than 30 different values in this field. + /// For regression analysis, the data type of the field must be numeric. + /// /// public string DependentVariable { get; set; } /// - /// Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1. + /// + /// Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1. + /// /// public double? DownsampleFactor { get; set; } /// - /// Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable. + /// + /// Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable. + /// /// public bool? EarlyStoppingEnabled { get; set; } /// - /// Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1. + /// + /// Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1. + /// /// public double? Eta { get; set; } /// - /// Advanced configuration option. Specifies the rate at which `eta` increases for each new tree that is added to the forest. For example, a rate of 1.05 increases `eta` by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2. + /// + /// Advanced configuration option. Specifies the rate at which eta increases for each new tree that is added to the forest. For example, a rate of 1.05 increases eta by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2. + /// /// public double? EtaGrowthRatePerTree { get; set; } /// - /// Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization. + /// /// public double? FeatureBagFraction { get; set; } /// - /// Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple `feature_processors` entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields. + /// + /// Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple feature_processors entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields. + /// /// public ICollection? FeatureProcessors { get; set; } /// - /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// + /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// /// public double? Gamma { get; set; } /// - /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// + /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// /// public double? Lambda { get; set; } /// - /// Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization. + /// /// public int? MaxOptimizationRoundsPerHyperparameter { get; set; } /// - /// Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization. + /// /// public int? MaxTrees { get; set; } /// - /// Defines the number of categories for which the predicted probabilities are reported. It must be non-negative or -1. If it is -1 or greater than the total number of categories, probabilities are reported for all categories; if you have a large number of categories, there could be a significant effect on the size of your destination index. NOTE: To use the AUC ROC evaluation method, `num_top_classes` must be set to -1 or a value greater than or equal to the total number of categories. + /// + /// Defines the number of categories for which the predicted probabilities are reported. It must be non-negative or -1. If it is -1 or greater than the total number of categories, probabilities are reported for all categories; if you have a large number of categories, there could be a significant effect on the size of your destination index. NOTE: To use the AUC ROC evaluation method, num_top_classes must be set to -1 or a value greater than or equal to the total number of categories. + /// /// public int? NumTopClasses { get; set; } /// - /// Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs. + /// + /// Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs. + /// /// public int? NumTopFeatureImportanceValues { get; set; } /// - /// Defines the name of the prediction field in the results. Defaults to `_prediction`. + /// + /// Defines the name of the prediction field in the results. Defaults to <dependent_variable>_prediction. + /// /// public Elastic.Clients.Elasticsearch.Field? PredictionFieldName { get; set; } /// - /// Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as `source` and `analyzed_fields` are the same). + /// + /// Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as source and analyzed_fields are the same). + /// /// public double? RandomizeSeed { get; set; } /// - /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the `soft_tree_depth_tolerance` to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0. + /// + /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the soft_tree_depth_tolerance to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0. + /// /// public int? SoftTreeDepthLimit { get; set; } /// - /// Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds `soft_tree_depth_limit`. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01. + /// + /// Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds soft_tree_depth_limit. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01. + /// /// public double? SoftTreeDepthTolerance { get; set; } /// - /// Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage. + /// + /// Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage. + /// /// public double? TrainingPercent { get; set; } @@ -422,7 +462,9 @@ public DataframeAnalysisClassificationDescriptor() : base() private double? TrainingPercentValue { get; set; } /// - /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero. + /// + /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero. + /// /// public DataframeAnalysisClassificationDescriptor Alpha(double? alpha) { @@ -437,7 +479,11 @@ public DataframeAnalysisClassificationDescriptor ClassAssignmentObjec } /// - /// Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable.
For classification analysis, the data type of the field must be numeric (`integer`, `short`, `long`, `byte`), categorical (`ip` or `keyword`), or `boolean`. There must be no more than 30 different values in this field.
For regression analysis, the data type of the field must be numeric. + /// + /// Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable. + /// For classification analysis, the data type of the field must be numeric (integer, short, long, byte), categorical (ip or keyword), or boolean. There must be no more than 30 different values in this field. + /// For regression analysis, the data type of the field must be numeric. + /// /// public DataframeAnalysisClassificationDescriptor DependentVariable(string dependentVariable) { @@ -446,7 +492,9 @@ public DataframeAnalysisClassificationDescriptor DependentVariable(st } /// - /// Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1. + /// + /// Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1. + /// /// public DataframeAnalysisClassificationDescriptor DownsampleFactor(double? downsampleFactor) { @@ -455,7 +503,9 @@ public DataframeAnalysisClassificationDescriptor DownsampleFactor(dou } /// - /// Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable. + /// + /// Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable. + /// /// public DataframeAnalysisClassificationDescriptor EarlyStoppingEnabled(bool? earlyStoppingEnabled = true) { @@ -464,7 +514,9 @@ public DataframeAnalysisClassificationDescriptor EarlyStoppingEnabled } /// - /// Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1. + /// + /// Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1. + /// /// public DataframeAnalysisClassificationDescriptor Eta(double? eta) { @@ -473,7 +525,9 @@ public DataframeAnalysisClassificationDescriptor Eta(double? eta) } /// - /// Advanced configuration option. Specifies the rate at which `eta` increases for each new tree that is added to the forest. For example, a rate of 1.05 increases `eta` by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2. + /// + /// Advanced configuration option. Specifies the rate at which eta increases for each new tree that is added to the forest. For example, a rate of 1.05 increases eta by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2. + /// /// public DataframeAnalysisClassificationDescriptor EtaGrowthRatePerTree(double? etaGrowthRatePerTree) { @@ -482,7 +536,9 @@ public DataframeAnalysisClassificationDescriptor EtaGrowthRatePerTree } /// - /// Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization. + /// /// public DataframeAnalysisClassificationDescriptor FeatureBagFraction(double? featureBagFraction) { @@ -491,7 +547,9 @@ public DataframeAnalysisClassificationDescriptor FeatureBagFraction(d } /// - /// Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple `feature_processors` entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields. + /// + /// Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple feature_processors entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields. + /// /// public DataframeAnalysisClassificationDescriptor FeatureProcessors(ICollection? featureProcessors) { @@ -530,7 +588,9 @@ public DataframeAnalysisClassificationDescriptor FeatureProcessors(pa } /// - /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// + /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// /// public DataframeAnalysisClassificationDescriptor Gamma(double? gamma) { @@ -539,7 +599,9 @@ public DataframeAnalysisClassificationDescriptor Gamma(double? gamma) } /// - /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// + /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// /// public DataframeAnalysisClassificationDescriptor Lambda(double? lambda) { @@ -548,7 +610,9 @@ public DataframeAnalysisClassificationDescriptor Lambda(double? lambd } /// - /// Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization. + /// /// public DataframeAnalysisClassificationDescriptor MaxOptimizationRoundsPerHyperparameter(int? maxOptimizationRoundsPerHyperparameter) { @@ -557,7 +621,9 @@ public DataframeAnalysisClassificationDescriptor MaxOptimizationRound } /// - /// Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization. + /// /// public DataframeAnalysisClassificationDescriptor MaxTrees(int? maxTrees) { @@ -566,7 +632,9 @@ public DataframeAnalysisClassificationDescriptor MaxTrees(int? maxTre } /// - /// Defines the number of categories for which the predicted probabilities are reported. It must be non-negative or -1. If it is -1 or greater than the total number of categories, probabilities are reported for all categories; if you have a large number of categories, there could be a significant effect on the size of your destination index. NOTE: To use the AUC ROC evaluation method, `num_top_classes` must be set to -1 or a value greater than or equal to the total number of categories. + /// + /// Defines the number of categories for which the predicted probabilities are reported. It must be non-negative or -1. If it is -1 or greater than the total number of categories, probabilities are reported for all categories; if you have a large number of categories, there could be a significant effect on the size of your destination index. NOTE: To use the AUC ROC evaluation method, num_top_classes must be set to -1 or a value greater than or equal to the total number of categories. + /// /// public DataframeAnalysisClassificationDescriptor NumTopClasses(int? numTopClasses) { @@ -575,7 +643,9 @@ public DataframeAnalysisClassificationDescriptor NumTopClasses(int? n } /// - /// Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs. + /// + /// Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs. + /// /// public DataframeAnalysisClassificationDescriptor NumTopFeatureImportanceValues(int? numTopFeatureImportanceValues) { @@ -584,7 +654,9 @@ public DataframeAnalysisClassificationDescriptor NumTopFeatureImporta } /// - /// Defines the name of the prediction field in the results. Defaults to `_prediction`. + /// + /// Defines the name of the prediction field in the results. Defaults to <dependent_variable>_prediction. + /// /// public DataframeAnalysisClassificationDescriptor PredictionFieldName(Elastic.Clients.Elasticsearch.Field? predictionFieldName) { @@ -593,7 +665,9 @@ public DataframeAnalysisClassificationDescriptor PredictionFieldName( } /// - /// Defines the name of the prediction field in the results. Defaults to `_prediction`. + /// + /// Defines the name of the prediction field in the results. Defaults to <dependent_variable>_prediction. + /// /// public DataframeAnalysisClassificationDescriptor PredictionFieldName(Expression> predictionFieldName) { @@ -602,7 +676,9 @@ public DataframeAnalysisClassificationDescriptor PredictionFieldName< } /// - /// Defines the name of the prediction field in the results. Defaults to `_prediction`. + /// + /// Defines the name of the prediction field in the results. Defaults to <dependent_variable>_prediction. + /// /// public DataframeAnalysisClassificationDescriptor PredictionFieldName(Expression> predictionFieldName) { @@ -611,7 +687,9 @@ public DataframeAnalysisClassificationDescriptor PredictionFieldName( } /// - /// Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as `source` and `analyzed_fields` are the same). + /// + /// Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as source and analyzed_fields are the same). + /// /// public DataframeAnalysisClassificationDescriptor RandomizeSeed(double? randomizeSeed) { @@ -620,7 +698,9 @@ public DataframeAnalysisClassificationDescriptor RandomizeSeed(double } /// - /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the `soft_tree_depth_tolerance` to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0. + /// + /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the soft_tree_depth_tolerance to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0. + /// /// public DataframeAnalysisClassificationDescriptor SoftTreeDepthLimit(int? softTreeDepthLimit) { @@ -629,7 +709,9 @@ public DataframeAnalysisClassificationDescriptor SoftTreeDepthLimit(i } /// - /// Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds `soft_tree_depth_limit`. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01. + /// + /// Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds soft_tree_depth_limit. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01. + /// /// public DataframeAnalysisClassificationDescriptor SoftTreeDepthTolerance(double? softTreeDepthTolerance) { @@ -638,7 +720,9 @@ public DataframeAnalysisClassificationDescriptor SoftTreeDepthToleran } /// - /// Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage. + /// + /// Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage. + /// /// public DataframeAnalysisClassificationDescriptor TrainingPercent(double? trainingPercent) { @@ -827,7 +911,9 @@ public DataframeAnalysisClassificationDescriptor() : base() private double? TrainingPercentValue { get; set; } /// - /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero. + /// + /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero. + /// /// public DataframeAnalysisClassificationDescriptor Alpha(double? alpha) { @@ -842,7 +928,11 @@ public DataframeAnalysisClassificationDescriptor ClassAssignmentObjective(string } /// - /// Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable.
For classification analysis, the data type of the field must be numeric (`integer`, `short`, `long`, `byte`), categorical (`ip` or `keyword`), or `boolean`. There must be no more than 30 different values in this field.
For regression analysis, the data type of the field must be numeric. + /// + /// Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable. + /// For classification analysis, the data type of the field must be numeric (integer, short, long, byte), categorical (ip or keyword), or boolean. There must be no more than 30 different values in this field. + /// For regression analysis, the data type of the field must be numeric. + /// /// public DataframeAnalysisClassificationDescriptor DependentVariable(string dependentVariable) { @@ -851,7 +941,9 @@ public DataframeAnalysisClassificationDescriptor DependentVariable(string depend } /// - /// Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1. + /// + /// Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1. + /// /// public DataframeAnalysisClassificationDescriptor DownsampleFactor(double? downsampleFactor) { @@ -860,7 +952,9 @@ public DataframeAnalysisClassificationDescriptor DownsampleFactor(double? downsa } /// - /// Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable. + /// + /// Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable. + /// /// public DataframeAnalysisClassificationDescriptor EarlyStoppingEnabled(bool? earlyStoppingEnabled = true) { @@ -869,7 +963,9 @@ public DataframeAnalysisClassificationDescriptor EarlyStoppingEnabled(bool? earl } /// - /// Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1. + /// + /// Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1. + /// /// public DataframeAnalysisClassificationDescriptor Eta(double? eta) { @@ -878,7 +974,9 @@ public DataframeAnalysisClassificationDescriptor Eta(double? eta) } /// - /// Advanced configuration option. Specifies the rate at which `eta` increases for each new tree that is added to the forest. For example, a rate of 1.05 increases `eta` by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2. + /// + /// Advanced configuration option. Specifies the rate at which eta increases for each new tree that is added to the forest. For example, a rate of 1.05 increases eta by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2. + /// /// public DataframeAnalysisClassificationDescriptor EtaGrowthRatePerTree(double? etaGrowthRatePerTree) { @@ -887,7 +985,9 @@ public DataframeAnalysisClassificationDescriptor EtaGrowthRatePerTree(double? et } /// - /// Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization. + /// /// public DataframeAnalysisClassificationDescriptor FeatureBagFraction(double? featureBagFraction) { @@ -896,7 +996,9 @@ public DataframeAnalysisClassificationDescriptor FeatureBagFraction(double? feat } /// - /// Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple `feature_processors` entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields. + /// + /// Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple feature_processors entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields. + /// /// public DataframeAnalysisClassificationDescriptor FeatureProcessors(ICollection? featureProcessors) { @@ -935,7 +1037,9 @@ public DataframeAnalysisClassificationDescriptor FeatureProcessors(params Action } /// - /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// + /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// /// public DataframeAnalysisClassificationDescriptor Gamma(double? gamma) { @@ -944,7 +1048,9 @@ public DataframeAnalysisClassificationDescriptor Gamma(double? gamma) } /// - /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// + /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// /// public DataframeAnalysisClassificationDescriptor Lambda(double? lambda) { @@ -953,7 +1059,9 @@ public DataframeAnalysisClassificationDescriptor Lambda(double? lambda) } /// - /// Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization. + /// /// public DataframeAnalysisClassificationDescriptor MaxOptimizationRoundsPerHyperparameter(int? maxOptimizationRoundsPerHyperparameter) { @@ -962,7 +1070,9 @@ public DataframeAnalysisClassificationDescriptor MaxOptimizationRoundsPerHyperpa } /// - /// Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization. + /// /// public DataframeAnalysisClassificationDescriptor MaxTrees(int? maxTrees) { @@ -971,7 +1081,9 @@ public DataframeAnalysisClassificationDescriptor MaxTrees(int? maxTrees) } /// - /// Defines the number of categories for which the predicted probabilities are reported. It must be non-negative or -1. If it is -1 or greater than the total number of categories, probabilities are reported for all categories; if you have a large number of categories, there could be a significant effect on the size of your destination index. NOTE: To use the AUC ROC evaluation method, `num_top_classes` must be set to -1 or a value greater than or equal to the total number of categories. + /// + /// Defines the number of categories for which the predicted probabilities are reported. It must be non-negative or -1. If it is -1 or greater than the total number of categories, probabilities are reported for all categories; if you have a large number of categories, there could be a significant effect on the size of your destination index. NOTE: To use the AUC ROC evaluation method, num_top_classes must be set to -1 or a value greater than or equal to the total number of categories. + /// /// public DataframeAnalysisClassificationDescriptor NumTopClasses(int? numTopClasses) { @@ -980,7 +1092,9 @@ public DataframeAnalysisClassificationDescriptor NumTopClasses(int? numTopClasse } /// - /// Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs. + /// + /// Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs. + /// /// public DataframeAnalysisClassificationDescriptor NumTopFeatureImportanceValues(int? numTopFeatureImportanceValues) { @@ -989,7 +1103,9 @@ public DataframeAnalysisClassificationDescriptor NumTopFeatureImportanceValues(i } /// - /// Defines the name of the prediction field in the results. Defaults to `_prediction`. + /// + /// Defines the name of the prediction field in the results. Defaults to <dependent_variable>_prediction. + /// /// public DataframeAnalysisClassificationDescriptor PredictionFieldName(Elastic.Clients.Elasticsearch.Field? predictionFieldName) { @@ -998,7 +1114,9 @@ public DataframeAnalysisClassificationDescriptor PredictionFieldName(Elastic.Cli } /// - /// Defines the name of the prediction field in the results. Defaults to `_prediction`. + /// + /// Defines the name of the prediction field in the results. Defaults to <dependent_variable>_prediction. + /// /// public DataframeAnalysisClassificationDescriptor PredictionFieldName(Expression> predictionFieldName) { @@ -1007,7 +1125,9 @@ public DataframeAnalysisClassificationDescriptor PredictionFieldName - /// Defines the name of the prediction field in the results. Defaults to `_prediction`. + /// + /// Defines the name of the prediction field in the results. Defaults to <dependent_variable>_prediction. + /// /// public DataframeAnalysisClassificationDescriptor PredictionFieldName(Expression> predictionFieldName) { @@ -1016,7 +1136,9 @@ public DataframeAnalysisClassificationDescriptor PredictionFieldName( } /// - /// Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as `source` and `analyzed_fields` are the same). + /// + /// Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as source and analyzed_fields are the same). + /// /// public DataframeAnalysisClassificationDescriptor RandomizeSeed(double? randomizeSeed) { @@ -1025,7 +1147,9 @@ public DataframeAnalysisClassificationDescriptor RandomizeSeed(double? randomize } /// - /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the `soft_tree_depth_tolerance` to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0. + /// + /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the soft_tree_depth_tolerance to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0. + /// /// public DataframeAnalysisClassificationDescriptor SoftTreeDepthLimit(int? softTreeDepthLimit) { @@ -1034,7 +1158,9 @@ public DataframeAnalysisClassificationDescriptor SoftTreeDepthLimit(int? softTre } /// - /// Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds `soft_tree_depth_limit`. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01. + /// + /// Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds soft_tree_depth_limit. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01. + /// /// public DataframeAnalysisClassificationDescriptor SoftTreeDepthTolerance(double? softTreeDepthTolerance) { @@ -1043,7 +1169,9 @@ public DataframeAnalysisClassificationDescriptor SoftTreeDepthTolerance(double? } /// - /// Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage. + /// + /// Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage. + /// /// public DataframeAnalysisClassificationDescriptor TrainingPercent(double? trainingPercent) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorFrequencyEncoding.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorFrequencyEncoding.g.cs index f3c9ccd8645..68bceea4f8d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorFrequencyEncoding.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorFrequencyEncoding.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DataframeAnalysisFeatureProcessorFrequencyEncoding { /// - /// The resulting feature name. + /// + /// The resulting feature name. + /// /// [JsonInclude, JsonPropertyName("feature_name")] public Elastic.Clients.Elasticsearch.Name FeatureName { get; set; } @@ -38,7 +40,9 @@ public sealed partial class DataframeAnalysisFeatureProcessorFrequencyEncoding public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// The resulting frequency map for the field value. If the field value is missing from the frequency_map, the resulting value is 0. + /// + /// The resulting frequency map for the field value. If the field value is missing from the frequency_map, the resulting value is 0. + /// /// [JsonInclude, JsonPropertyName("frequency_map")] public IDictionary FrequencyMap { get; set; } @@ -59,7 +63,9 @@ public DataframeAnalysisFeatureProcessorFrequencyEncodingDescriptor() : base() private IDictionary FrequencyMapValue { get; set; } /// - /// The resulting feature name. + /// + /// The resulting feature name. + /// /// public DataframeAnalysisFeatureProcessorFrequencyEncodingDescriptor FeatureName(Elastic.Clients.Elasticsearch.Name featureName) { @@ -86,7 +92,9 @@ public DataframeAnalysisFeatureProcessorFrequencyEncodingDescriptor F } /// - /// The resulting frequency map for the field value. If the field value is missing from the frequency_map, the resulting value is 0. + /// + /// The resulting frequency map for the field value. If the field value is missing from the frequency_map, the resulting value is 0. + /// /// public DataframeAnalysisFeatureProcessorFrequencyEncodingDescriptor FrequencyMap(Func, FluentDictionary> selector) { @@ -120,7 +128,9 @@ public DataframeAnalysisFeatureProcessorFrequencyEncodingDescriptor() : base() private IDictionary FrequencyMapValue { get; set; } /// - /// The resulting feature name. + /// + /// The resulting feature name. + /// /// public DataframeAnalysisFeatureProcessorFrequencyEncodingDescriptor FeatureName(Elastic.Clients.Elasticsearch.Name featureName) { @@ -147,7 +157,9 @@ public DataframeAnalysisFeatureProcessorFrequencyEncodingDescriptor Field - /// The resulting frequency map for the field value. If the field value is missing from the frequency_map, the resulting value is 0. + /// + /// The resulting frequency map for the field value. If the field value is missing from the frequency_map, the resulting value is 0. + /// /// public DataframeAnalysisFeatureProcessorFrequencyEncodingDescriptor FrequencyMap(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorMultiEncoding.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorMultiEncoding.g.cs index 739bc8b0b60..845758fd8ca 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorMultiEncoding.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorMultiEncoding.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DataframeAnalysisFeatureProcessorMultiEncoding { /// - /// The ordered array of custom processors to execute. Must be more than 1. + /// + /// The ordered array of custom processors to execute. Must be more than 1. + /// /// [JsonInclude, JsonPropertyName("processors")] public ICollection Processors { get; set; } @@ -49,7 +51,9 @@ public DataframeAnalysisFeatureProcessorMultiEncodingDescriptor() : base() private ICollection ProcessorsValue { get; set; } /// - /// The ordered array of custom processors to execute. Must be more than 1. + /// + /// The ordered array of custom processors to execute. Must be more than 1. + /// /// public DataframeAnalysisFeatureProcessorMultiEncodingDescriptor Processors(ICollection processors) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorNGramEncoding.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorNGramEncoding.g.cs index 93b00d0838f..b534f8f9a44 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorNGramEncoding.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorNGramEncoding.g.cs @@ -33,31 +33,41 @@ public sealed partial class DataframeAnalysisFeatureProcessorNGramEncoding public bool? Custom { get; set; } /// - /// The feature name prefix. Defaults to ngram__. + /// + /// The feature name prefix. Defaults to ngram_<start>_<length>. + /// /// [JsonInclude, JsonPropertyName("feature_prefix")] public string? FeaturePrefix { get; set; } /// - /// The name of the text field to encode. + /// + /// The name of the text field to encode. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Specifies the length of the n-gram substring. Defaults to 50. Must be greater than 0. + /// + /// Specifies the length of the n-gram substring. Defaults to 50. Must be greater than 0. + /// /// [JsonInclude, JsonPropertyName("length")] public int? Length { get; set; } /// - /// Specifies which n-grams to gather. It’s an array of integer values where the minimum value is 1, and a maximum value is 5. + /// + /// Specifies which n-grams to gather. It’s an array of integer values where the minimum value is 1, and a maximum value is 5. + /// /// [JsonInclude, JsonPropertyName("n_grams")] public ICollection NGrams { get; set; } /// - /// Specifies the zero-indexed start of the n-gram substring. Negative values are allowed for encoding n-grams of string suffixes. Defaults to 0. + /// + /// Specifies the zero-indexed start of the n-gram substring. Negative values are allowed for encoding n-grams of string suffixes. Defaults to 0. + /// /// [JsonInclude, JsonPropertyName("start")] public int? Start { get; set; } @@ -87,7 +97,9 @@ public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Custo } /// - /// The feature name prefix. Defaults to ngram__. + /// + /// The feature name prefix. Defaults to ngram_<start>_<length>. + /// /// public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor FeaturePrefix(string? featurePrefix) { @@ -96,7 +108,9 @@ public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Featu } /// - /// The name of the text field to encode. + /// + /// The name of the text field to encode. + /// /// public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -105,7 +119,9 @@ public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Field } /// - /// The name of the text field to encode. + /// + /// The name of the text field to encode. + /// /// public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Field(Expression> field) { @@ -114,7 +130,9 @@ public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Field } /// - /// The name of the text field to encode. + /// + /// The name of the text field to encode. + /// /// public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Field(Expression> field) { @@ -123,7 +141,9 @@ public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Field } /// - /// Specifies the length of the n-gram substring. Defaults to 50. Must be greater than 0. + /// + /// Specifies the length of the n-gram substring. Defaults to 50. Must be greater than 0. + /// /// public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Length(int? length) { @@ -132,7 +152,9 @@ public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Lengt } /// - /// Specifies which n-grams to gather. It’s an array of integer values where the minimum value is 1, and a maximum value is 5. + /// + /// Specifies which n-grams to gather. It’s an array of integer values where the minimum value is 1, and a maximum value is 5. + /// /// public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor NGrams(ICollection nGrams) { @@ -141,7 +163,9 @@ public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor NGram } /// - /// Specifies the zero-indexed start of the n-gram substring. Negative values are allowed for encoding n-grams of string suffixes. Defaults to 0. + /// + /// Specifies the zero-indexed start of the n-gram substring. Negative values are allowed for encoding n-grams of string suffixes. Defaults to 0. + /// /// public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Start(int? start) { @@ -206,7 +230,9 @@ public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Custom(bool? cus } /// - /// The feature name prefix. Defaults to ngram__. + /// + /// The feature name prefix. Defaults to ngram_<start>_<length>. + /// /// public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor FeaturePrefix(string? featurePrefix) { @@ -215,7 +241,9 @@ public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor FeaturePrefix(st } /// - /// The name of the text field to encode. + /// + /// The name of the text field to encode. + /// /// public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -224,7 +252,9 @@ public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Field(Elastic.Cl } /// - /// The name of the text field to encode. + /// + /// The name of the text field to encode. + /// /// public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Field(Expression> field) { @@ -233,7 +263,9 @@ public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Field - /// The name of the text field to encode. + /// + /// The name of the text field to encode. + /// /// public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Field(Expression> field) { @@ -242,7 +274,9 @@ public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Field } /// - /// Specifies the length of the n-gram substring. Defaults to 50. Must be greater than 0. + /// + /// Specifies the length of the n-gram substring. Defaults to 50. Must be greater than 0. + /// /// public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Length(int? length) { @@ -251,7 +285,9 @@ public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Length(int? leng } /// - /// Specifies which n-grams to gather. It’s an array of integer values where the minimum value is 1, and a maximum value is 5. + /// + /// Specifies which n-grams to gather. It’s an array of integer values where the minimum value is 1, and a maximum value is 5. + /// /// public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor NGrams(ICollection nGrams) { @@ -260,7 +296,9 @@ public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor NGrams(ICollecti } /// - /// Specifies the zero-indexed start of the n-gram substring. Negative values are allowed for encoding n-grams of string suffixes. Defaults to 0. + /// + /// Specifies the zero-indexed start of the n-gram substring. Negative values are allowed for encoding n-grams of string suffixes. Defaults to 0. + /// /// public DataframeAnalysisFeatureProcessorNGramEncodingDescriptor Start(int? start) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorOneHotEncoding.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorOneHotEncoding.g.cs index 1dbfa56068d..511740a107d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorOneHotEncoding.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorOneHotEncoding.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DataframeAnalysisFeatureProcessorOneHotEncoding { /// - /// The name of the field to encode. + /// + /// The name of the field to encode. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// The one hot map mapping the field value with the column name. + /// + /// The one hot map mapping the field value with the column name. + /// /// [JsonInclude, JsonPropertyName("hot_map")] public string HotMap { get; set; } @@ -56,7 +60,9 @@ public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor() : base() private string HotMapValue { get; set; } /// - /// The name of the field to encode. + /// + /// The name of the field to encode. + /// /// public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -65,7 +71,9 @@ public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor Fiel } /// - /// The name of the field to encode. + /// + /// The name of the field to encode. + /// /// public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor Field(Expression> field) { @@ -74,7 +82,9 @@ public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor Fiel } /// - /// The name of the field to encode. + /// + /// The name of the field to encode. + /// /// public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor Field(Expression> field) { @@ -83,7 +93,9 @@ public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor Fiel } /// - /// The one hot map mapping the field value with the column name. + /// + /// The one hot map mapping the field value with the column name. + /// /// public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor HotMap(string hotMap) { @@ -114,7 +126,9 @@ public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor() : base() private string HotMapValue { get; set; } /// - /// The name of the field to encode. + /// + /// The name of the field to encode. + /// /// public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -123,7 +137,9 @@ public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor Field(Elastic.C } /// - /// The name of the field to encode. + /// + /// The name of the field to encode. + /// /// public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor Field(Expression> field) { @@ -132,7 +148,9 @@ public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor Field - /// The name of the field to encode. + /// + /// The name of the field to encode. + /// /// public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor Field(Expression> field) { @@ -141,7 +159,9 @@ public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor Field - /// The one hot map mapping the field value with the column name. + /// + /// The one hot map mapping the field value with the column name. + /// /// public DataframeAnalysisFeatureProcessorOneHotEncodingDescriptor HotMap(string hotMap) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorTargetMeanEncoding.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorTargetMeanEncoding.g.cs index 472fc51f75c..c1383aedb32 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorTargetMeanEncoding.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisFeatureProcessorTargetMeanEncoding.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DataframeAnalysisFeatureProcessorTargetMeanEncoding { /// - /// The default value if field value is not found in the target_map. + /// + /// The default value if field value is not found in the target_map. + /// /// [JsonInclude, JsonPropertyName("default_value")] public int DefaultValue { get; set; } /// - /// The resulting feature name. + /// + /// The resulting feature name. + /// /// [JsonInclude, JsonPropertyName("feature_name")] public Elastic.Clients.Elasticsearch.Name FeatureName { get; set; } /// - /// The name of the field to encode. + /// + /// The name of the field to encode. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// The field value to target mean transition map. + /// + /// The field value to target mean transition map. + /// /// [JsonInclude, JsonPropertyName("target_map")] public IDictionary TargetMap { get; set; } @@ -70,7 +78,9 @@ public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor() : base() private IDictionary TargetMapValue { get; set; } /// - /// The default value if field value is not found in the target_map. + /// + /// The default value if field value is not found in the target_map. + /// /// public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor DefaultValue(int defaultValue) { @@ -79,7 +89,9 @@ public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor } /// - /// The resulting feature name. + /// + /// The resulting feature name. + /// /// public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor FeatureName(Elastic.Clients.Elasticsearch.Name featureName) { @@ -88,7 +100,9 @@ public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor } /// - /// The name of the field to encode. + /// + /// The name of the field to encode. + /// /// public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -97,7 +111,9 @@ public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor } /// - /// The name of the field to encode. + /// + /// The name of the field to encode. + /// /// public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor Field(Expression> field) { @@ -106,7 +122,9 @@ public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor } /// - /// The name of the field to encode. + /// + /// The name of the field to encode. + /// /// public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor Field(Expression> field) { @@ -115,7 +133,9 @@ public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor } /// - /// The field value to target mean transition map. + /// + /// The field value to target mean transition map. + /// /// public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor TargetMap(Func, FluentDictionary> selector) { @@ -152,7 +172,9 @@ public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor() : base() private IDictionary TargetMapValue { get; set; } /// - /// The default value if field value is not found in the target_map. + /// + /// The default value if field value is not found in the target_map. + /// /// public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor DefaultValue(int defaultValue) { @@ -161,7 +183,9 @@ public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor DefaultValu } /// - /// The resulting feature name. + /// + /// The resulting feature name. + /// /// public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor FeatureName(Elastic.Clients.Elasticsearch.Name featureName) { @@ -170,7 +194,9 @@ public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor FeatureName } /// - /// The name of the field to encode. + /// + /// The name of the field to encode. + /// /// public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -179,7 +205,9 @@ public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor Field(Elast } /// - /// The name of the field to encode. + /// + /// The name of the field to encode. + /// /// public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor Field(Expression> field) { @@ -188,7 +216,9 @@ public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor Field - /// The name of the field to encode. + /// + /// The name of the field to encode. + /// /// public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor Field(Expression> field) { @@ -197,7 +227,9 @@ public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor Field - /// The field value to target mean transition map. + /// + /// The field value to target mean transition map. + /// /// public DataframeAnalysisFeatureProcessorTargetMeanEncodingDescriptor TargetMap(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisOutlierDetection.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisOutlierDetection.g.cs index 9230ae6366d..5c976d32f09 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisOutlierDetection.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisOutlierDetection.g.cs @@ -30,37 +30,49 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DataframeAnalysisOutlierDetection { /// - /// Specifies whether the feature influence calculation is enabled. + /// + /// Specifies whether the feature influence calculation is enabled. + /// /// [JsonInclude, JsonPropertyName("compute_feature_influence")] public bool? ComputeFeatureInfluence { get; set; } /// - /// The minimum outlier score that a document needs to have in order to calculate its feature influence score. Value range: 0-1. + /// + /// The minimum outlier score that a document needs to have in order to calculate its feature influence score. Value range: 0-1. + /// /// [JsonInclude, JsonPropertyName("feature_influence_threshold")] public double? FeatureInfluenceThreshold { get; set; } /// - /// The method that outlier detection uses. Available methods are `lof`, `ldof`, `distance_kth_nn`, `distance_knn`, and `ensemble`. The default value is ensemble, which means that outlier detection uses an ensemble of different methods and normalises and combines their individual outlier scores to obtain the overall outlier score. + /// + /// The method that outlier detection uses. Available methods are lof, ldof, distance_kth_nn, distance_knn, and ensemble. The default value is ensemble, which means that outlier detection uses an ensemble of different methods and normalises and combines their individual outlier scores to obtain the overall outlier score. + /// /// [JsonInclude, JsonPropertyName("method")] public string? Method { get; set; } /// - /// Defines the value for how many nearest neighbors each method of outlier detection uses to calculate its outlier score. When the value is not set, different values are used for different ensemble members. This default behavior helps improve the diversity in the ensemble; only override it if you are confident that the value you choose is appropriate for the data set. + /// + /// Defines the value for how many nearest neighbors each method of outlier detection uses to calculate its outlier score. When the value is not set, different values are used for different ensemble members. This default behavior helps improve the diversity in the ensemble; only override it if you are confident that the value you choose is appropriate for the data set. + /// /// [JsonInclude, JsonPropertyName("n_neighbors")] public int? NNeighbors { get; set; } /// - /// The proportion of the data set that is assumed to be outlying prior to outlier detection. For example, 0.05 means it is assumed that 5% of values are real outliers and 95% are inliers. + /// + /// The proportion of the data set that is assumed to be outlying prior to outlier detection. For example, 0.05 means it is assumed that 5% of values are real outliers and 95% are inliers. + /// /// [JsonInclude, JsonPropertyName("outlier_fraction")] public double? OutlierFraction { get; set; } /// - /// If true, the following operation is performed on the columns before computing outlier scores: `(x_i - mean(x_i)) / sd(x_i)`. + /// + /// If true, the following operation is performed on the columns before computing outlier scores: (x_i - mean(x_i)) / sd(x_i). + /// /// [JsonInclude, JsonPropertyName("standardization_enabled")] public bool? StandardizationEnabled { get; set; } @@ -84,7 +96,9 @@ public DataframeAnalysisOutlierDetectionDescriptor() : base() private bool? StandardizationEnabledValue { get; set; } /// - /// Specifies whether the feature influence calculation is enabled. + /// + /// Specifies whether the feature influence calculation is enabled. + /// /// public DataframeAnalysisOutlierDetectionDescriptor ComputeFeatureInfluence(bool? computeFeatureInfluence = true) { @@ -93,7 +107,9 @@ public DataframeAnalysisOutlierDetectionDescriptor ComputeFeatureInfluence(bool? } /// - /// The minimum outlier score that a document needs to have in order to calculate its feature influence score. Value range: 0-1. + /// + /// The minimum outlier score that a document needs to have in order to calculate its feature influence score. Value range: 0-1. + /// /// public DataframeAnalysisOutlierDetectionDescriptor FeatureInfluenceThreshold(double? featureInfluenceThreshold) { @@ -102,7 +118,9 @@ public DataframeAnalysisOutlierDetectionDescriptor FeatureInfluenceThreshold(dou } /// - /// The method that outlier detection uses. Available methods are `lof`, `ldof`, `distance_kth_nn`, `distance_knn`, and `ensemble`. The default value is ensemble, which means that outlier detection uses an ensemble of different methods and normalises and combines their individual outlier scores to obtain the overall outlier score. + /// + /// The method that outlier detection uses. Available methods are lof, ldof, distance_kth_nn, distance_knn, and ensemble. The default value is ensemble, which means that outlier detection uses an ensemble of different methods and normalises and combines their individual outlier scores to obtain the overall outlier score. + /// /// public DataframeAnalysisOutlierDetectionDescriptor Method(string? method) { @@ -111,7 +129,9 @@ public DataframeAnalysisOutlierDetectionDescriptor Method(string? method) } /// - /// Defines the value for how many nearest neighbors each method of outlier detection uses to calculate its outlier score. When the value is not set, different values are used for different ensemble members. This default behavior helps improve the diversity in the ensemble; only override it if you are confident that the value you choose is appropriate for the data set. + /// + /// Defines the value for how many nearest neighbors each method of outlier detection uses to calculate its outlier score. When the value is not set, different values are used for different ensemble members. This default behavior helps improve the diversity in the ensemble; only override it if you are confident that the value you choose is appropriate for the data set. + /// /// public DataframeAnalysisOutlierDetectionDescriptor NNeighbors(int? nNeighbors) { @@ -120,7 +140,9 @@ public DataframeAnalysisOutlierDetectionDescriptor NNeighbors(int? nNeighbors) } /// - /// The proportion of the data set that is assumed to be outlying prior to outlier detection. For example, 0.05 means it is assumed that 5% of values are real outliers and 95% are inliers. + /// + /// The proportion of the data set that is assumed to be outlying prior to outlier detection. For example, 0.05 means it is assumed that 5% of values are real outliers and 95% are inliers. + /// /// public DataframeAnalysisOutlierDetectionDescriptor OutlierFraction(double? outlierFraction) { @@ -129,7 +151,9 @@ public DataframeAnalysisOutlierDetectionDescriptor OutlierFraction(double? outli } /// - /// If true, the following operation is performed on the columns before computing outlier scores: `(x_i - mean(x_i)) / sd(x_i)`. + /// + /// If true, the following operation is performed on the columns before computing outlier scores: (x_i - mean(x_i)) / sd(x_i). + /// /// public DataframeAnalysisOutlierDetectionDescriptor StandardizationEnabled(bool? standardizationEnabled = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisRegression.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisRegression.g.cs index 4bf2fc5e751..33f1f359972 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisRegression.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalysisRegression.g.cs @@ -291,102 +291,144 @@ public override void Write(Utf8JsonWriter writer, DataframeAnalysisRegression va public sealed partial class DataframeAnalysisRegression { /// - /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero. + /// + /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero. + /// /// public double? Alpha { get; set; } /// - /// Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable.
For classification analysis, the data type of the field must be numeric (`integer`, `short`, `long`, `byte`), categorical (`ip` or `keyword`), or `boolean`. There must be no more than 30 different values in this field.
For regression analysis, the data type of the field must be numeric. + /// + /// Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable. + /// For classification analysis, the data type of the field must be numeric (integer, short, long, byte), categorical (ip or keyword), or boolean. There must be no more than 30 different values in this field. + /// For regression analysis, the data type of the field must be numeric. + /// /// public string DependentVariable { get; set; } /// - /// Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1. + /// + /// Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1. + /// /// public double? DownsampleFactor { get; set; } /// - /// Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable. + /// + /// Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable. + /// /// public bool? EarlyStoppingEnabled { get; set; } /// - /// Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1. + /// + /// Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1. + /// /// public double? Eta { get; set; } /// - /// Advanced configuration option. Specifies the rate at which `eta` increases for each new tree that is added to the forest. For example, a rate of 1.05 increases `eta` by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2. + /// + /// Advanced configuration option. Specifies the rate at which eta increases for each new tree that is added to the forest. For example, a rate of 1.05 increases eta by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2. + /// /// public double? EtaGrowthRatePerTree { get; set; } /// - /// Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization. + /// /// public double? FeatureBagFraction { get; set; } /// - /// Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple `feature_processors` entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields. + /// + /// Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple feature_processors entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields. + /// /// public ICollection? FeatureProcessors { get; set; } /// - /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// + /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// /// public double? Gamma { get; set; } /// - /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// + /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// /// public double? Lambda { get; set; } /// - /// The loss function used during regression. Available options are `mse` (mean squared error), `msle` (mean squared logarithmic error), `huber` (Pseudo-Huber loss). + /// + /// The loss function used during regression. Available options are mse (mean squared error), msle (mean squared logarithmic error), huber (Pseudo-Huber loss). + /// /// public string? LossFunction { get; set; } /// - /// A positive number that is used as a parameter to the `loss_function`. + /// + /// A positive number that is used as a parameter to the loss_function. + /// /// public double? LossFunctionParameter { get; set; } /// - /// Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization. + /// /// public int? MaxOptimizationRoundsPerHyperparameter { get; set; } /// - /// Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization. + /// /// public int? MaxTrees { get; set; } /// - /// Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs. + /// + /// Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs. + /// /// public int? NumTopFeatureImportanceValues { get; set; } /// - /// Defines the name of the prediction field in the results. Defaults to `_prediction`. + /// + /// Defines the name of the prediction field in the results. Defaults to <dependent_variable>_prediction. + /// /// public Elastic.Clients.Elasticsearch.Field? PredictionFieldName { get; set; } /// - /// Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as `source` and `analyzed_fields` are the same). + /// + /// Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as source and analyzed_fields are the same). + /// /// public double? RandomizeSeed { get; set; } /// - /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the `soft_tree_depth_tolerance` to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0. + /// + /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the soft_tree_depth_tolerance to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0. + /// /// public int? SoftTreeDepthLimit { get; set; } /// - /// Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds `soft_tree_depth_limit`. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01. + /// + /// Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds soft_tree_depth_limit. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01. + /// /// public double? SoftTreeDepthTolerance { get; set; } /// - /// Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage. + /// + /// Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage. + /// /// public double? TrainingPercent { get; set; } @@ -426,7 +468,9 @@ public DataframeAnalysisRegressionDescriptor() : base() private double? TrainingPercentValue { get; set; } /// - /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero. + /// + /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero. + /// /// public DataframeAnalysisRegressionDescriptor Alpha(double? alpha) { @@ -435,7 +479,11 @@ public DataframeAnalysisRegressionDescriptor Alpha(double? alpha) } /// - /// Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable.
For classification analysis, the data type of the field must be numeric (`integer`, `short`, `long`, `byte`), categorical (`ip` or `keyword`), or `boolean`. There must be no more than 30 different values in this field.
For regression analysis, the data type of the field must be numeric. + /// + /// Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable. + /// For classification analysis, the data type of the field must be numeric (integer, short, long, byte), categorical (ip or keyword), or boolean. There must be no more than 30 different values in this field. + /// For regression analysis, the data type of the field must be numeric. + /// /// public DataframeAnalysisRegressionDescriptor DependentVariable(string dependentVariable) { @@ -444,7 +492,9 @@ public DataframeAnalysisRegressionDescriptor DependentVariable(string } /// - /// Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1. + /// + /// Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1. + /// /// public DataframeAnalysisRegressionDescriptor DownsampleFactor(double? downsampleFactor) { @@ -453,7 +503,9 @@ public DataframeAnalysisRegressionDescriptor DownsampleFactor(double? } /// - /// Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable. + /// + /// Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable. + /// /// public DataframeAnalysisRegressionDescriptor EarlyStoppingEnabled(bool? earlyStoppingEnabled = true) { @@ -462,7 +514,9 @@ public DataframeAnalysisRegressionDescriptor EarlyStoppingEnabled(boo } /// - /// Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1. + /// + /// Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1. + /// /// public DataframeAnalysisRegressionDescriptor Eta(double? eta) { @@ -471,7 +525,9 @@ public DataframeAnalysisRegressionDescriptor Eta(double? eta) } /// - /// Advanced configuration option. Specifies the rate at which `eta` increases for each new tree that is added to the forest. For example, a rate of 1.05 increases `eta` by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2. + /// + /// Advanced configuration option. Specifies the rate at which eta increases for each new tree that is added to the forest. For example, a rate of 1.05 increases eta by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2. + /// /// public DataframeAnalysisRegressionDescriptor EtaGrowthRatePerTree(double? etaGrowthRatePerTree) { @@ -480,7 +536,9 @@ public DataframeAnalysisRegressionDescriptor EtaGrowthRatePerTree(dou } /// - /// Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization. + /// /// public DataframeAnalysisRegressionDescriptor FeatureBagFraction(double? featureBagFraction) { @@ -489,7 +547,9 @@ public DataframeAnalysisRegressionDescriptor FeatureBagFraction(doubl } /// - /// Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple `feature_processors` entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields. + /// + /// Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple feature_processors entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields. + /// /// public DataframeAnalysisRegressionDescriptor FeatureProcessors(ICollection? featureProcessors) { @@ -528,7 +588,9 @@ public DataframeAnalysisRegressionDescriptor FeatureProcessors(params } /// - /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// + /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// /// public DataframeAnalysisRegressionDescriptor Gamma(double? gamma) { @@ -537,7 +599,9 @@ public DataframeAnalysisRegressionDescriptor Gamma(double? gamma) } /// - /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// + /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// /// public DataframeAnalysisRegressionDescriptor Lambda(double? lambda) { @@ -546,7 +610,9 @@ public DataframeAnalysisRegressionDescriptor Lambda(double? lambda) } /// - /// The loss function used during regression. Available options are `mse` (mean squared error), `msle` (mean squared logarithmic error), `huber` (Pseudo-Huber loss). + /// + /// The loss function used during regression. Available options are mse (mean squared error), msle (mean squared logarithmic error), huber (Pseudo-Huber loss). + /// /// public DataframeAnalysisRegressionDescriptor LossFunction(string? lossFunction) { @@ -555,7 +621,9 @@ public DataframeAnalysisRegressionDescriptor LossFunction(string? los } /// - /// A positive number that is used as a parameter to the `loss_function`. + /// + /// A positive number that is used as a parameter to the loss_function. + /// /// public DataframeAnalysisRegressionDescriptor LossFunctionParameter(double? lossFunctionParameter) { @@ -564,7 +632,9 @@ public DataframeAnalysisRegressionDescriptor LossFunctionParameter(do } /// - /// Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization. + /// /// public DataframeAnalysisRegressionDescriptor MaxOptimizationRoundsPerHyperparameter(int? maxOptimizationRoundsPerHyperparameter) { @@ -573,7 +643,9 @@ public DataframeAnalysisRegressionDescriptor MaxOptimizationRoundsPer } /// - /// Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization. + /// /// public DataframeAnalysisRegressionDescriptor MaxTrees(int? maxTrees) { @@ -582,7 +654,9 @@ public DataframeAnalysisRegressionDescriptor MaxTrees(int? maxTrees) } /// - /// Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs. + /// + /// Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs. + /// /// public DataframeAnalysisRegressionDescriptor NumTopFeatureImportanceValues(int? numTopFeatureImportanceValues) { @@ -591,7 +665,9 @@ public DataframeAnalysisRegressionDescriptor NumTopFeatureImportanceV } /// - /// Defines the name of the prediction field in the results. Defaults to `_prediction`. + /// + /// Defines the name of the prediction field in the results. Defaults to <dependent_variable>_prediction. + /// /// public DataframeAnalysisRegressionDescriptor PredictionFieldName(Elastic.Clients.Elasticsearch.Field? predictionFieldName) { @@ -600,7 +676,9 @@ public DataframeAnalysisRegressionDescriptor PredictionFieldName(Elas } /// - /// Defines the name of the prediction field in the results. Defaults to `_prediction`. + /// + /// Defines the name of the prediction field in the results. Defaults to <dependent_variable>_prediction. + /// /// public DataframeAnalysisRegressionDescriptor PredictionFieldName(Expression> predictionFieldName) { @@ -609,7 +687,9 @@ public DataframeAnalysisRegressionDescriptor PredictionFieldName - /// Defines the name of the prediction field in the results. Defaults to `_prediction`. + /// + /// Defines the name of the prediction field in the results. Defaults to <dependent_variable>_prediction. + /// /// public DataframeAnalysisRegressionDescriptor PredictionFieldName(Expression> predictionFieldName) { @@ -618,7 +698,9 @@ public DataframeAnalysisRegressionDescriptor PredictionFieldName(Expr } /// - /// Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as `source` and `analyzed_fields` are the same). + /// + /// Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as source and analyzed_fields are the same). + /// /// public DataframeAnalysisRegressionDescriptor RandomizeSeed(double? randomizeSeed) { @@ -627,7 +709,9 @@ public DataframeAnalysisRegressionDescriptor RandomizeSeed(double? ra } /// - /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the `soft_tree_depth_tolerance` to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0. + /// + /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the soft_tree_depth_tolerance to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0. + /// /// public DataframeAnalysisRegressionDescriptor SoftTreeDepthLimit(int? softTreeDepthLimit) { @@ -636,7 +720,9 @@ public DataframeAnalysisRegressionDescriptor SoftTreeDepthLimit(int? } /// - /// Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds `soft_tree_depth_limit`. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01. + /// + /// Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds soft_tree_depth_limit. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01. + /// /// public DataframeAnalysisRegressionDescriptor SoftTreeDepthTolerance(double? softTreeDepthTolerance) { @@ -645,7 +731,9 @@ public DataframeAnalysisRegressionDescriptor SoftTreeDepthTolerance(d } /// - /// Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage. + /// + /// Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage. + /// /// public DataframeAnalysisRegressionDescriptor TrainingPercent(double? trainingPercent) { @@ -834,7 +922,9 @@ public DataframeAnalysisRegressionDescriptor() : base() private double? TrainingPercentValue { get; set; } /// - /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero. + /// + /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero. + /// /// public DataframeAnalysisRegressionDescriptor Alpha(double? alpha) { @@ -843,7 +933,11 @@ public DataframeAnalysisRegressionDescriptor Alpha(double? alpha) } /// - /// Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable.
For classification analysis, the data type of the field must be numeric (`integer`, `short`, `long`, `byte`), categorical (`ip` or `keyword`), or `boolean`. There must be no more than 30 different values in this field.
For regression analysis, the data type of the field must be numeric. + /// + /// Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable. + /// For classification analysis, the data type of the field must be numeric (integer, short, long, byte), categorical (ip or keyword), or boolean. There must be no more than 30 different values in this field. + /// For regression analysis, the data type of the field must be numeric. + /// /// public DataframeAnalysisRegressionDescriptor DependentVariable(string dependentVariable) { @@ -852,7 +946,9 @@ public DataframeAnalysisRegressionDescriptor DependentVariable(string dependentV } /// - /// Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1. + /// + /// Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1. + /// /// public DataframeAnalysisRegressionDescriptor DownsampleFactor(double? downsampleFactor) { @@ -861,7 +957,9 @@ public DataframeAnalysisRegressionDescriptor DownsampleFactor(double? downsample } /// - /// Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable. + /// + /// Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable. + /// /// public DataframeAnalysisRegressionDescriptor EarlyStoppingEnabled(bool? earlyStoppingEnabled = true) { @@ -870,7 +968,9 @@ public DataframeAnalysisRegressionDescriptor EarlyStoppingEnabled(bool? earlySto } /// - /// Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1. + /// + /// Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1. + /// /// public DataframeAnalysisRegressionDescriptor Eta(double? eta) { @@ -879,7 +979,9 @@ public DataframeAnalysisRegressionDescriptor Eta(double? eta) } /// - /// Advanced configuration option. Specifies the rate at which `eta` increases for each new tree that is added to the forest. For example, a rate of 1.05 increases `eta` by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2. + /// + /// Advanced configuration option. Specifies the rate at which eta increases for each new tree that is added to the forest. For example, a rate of 1.05 increases eta by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2. + /// /// public DataframeAnalysisRegressionDescriptor EtaGrowthRatePerTree(double? etaGrowthRatePerTree) { @@ -888,7 +990,9 @@ public DataframeAnalysisRegressionDescriptor EtaGrowthRatePerTree(double? etaGro } /// - /// Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization. + /// /// public DataframeAnalysisRegressionDescriptor FeatureBagFraction(double? featureBagFraction) { @@ -897,7 +1001,9 @@ public DataframeAnalysisRegressionDescriptor FeatureBagFraction(double? featureB } /// - /// Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple `feature_processors` entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields. + /// + /// Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple feature_processors entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields. + /// /// public DataframeAnalysisRegressionDescriptor FeatureProcessors(ICollection? featureProcessors) { @@ -936,7 +1042,9 @@ public DataframeAnalysisRegressionDescriptor FeatureProcessors(params Action - /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// + /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// /// public DataframeAnalysisRegressionDescriptor Gamma(double? gamma) { @@ -945,7 +1053,9 @@ public DataframeAnalysisRegressionDescriptor Gamma(double? gamma) } /// - /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// + /// Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + /// /// public DataframeAnalysisRegressionDescriptor Lambda(double? lambda) { @@ -954,7 +1064,9 @@ public DataframeAnalysisRegressionDescriptor Lambda(double? lambda) } /// - /// The loss function used during regression. Available options are `mse` (mean squared error), `msle` (mean squared logarithmic error), `huber` (Pseudo-Huber loss). + /// + /// The loss function used during regression. Available options are mse (mean squared error), msle (mean squared logarithmic error), huber (Pseudo-Huber loss). + /// /// public DataframeAnalysisRegressionDescriptor LossFunction(string? lossFunction) { @@ -963,7 +1075,9 @@ public DataframeAnalysisRegressionDescriptor LossFunction(string? lossFunction) } /// - /// A positive number that is used as a parameter to the `loss_function`. + /// + /// A positive number that is used as a parameter to the loss_function. + /// /// public DataframeAnalysisRegressionDescriptor LossFunctionParameter(double? lossFunctionParameter) { @@ -972,7 +1086,9 @@ public DataframeAnalysisRegressionDescriptor LossFunctionParameter(double? lossF } /// - /// Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization. + /// /// public DataframeAnalysisRegressionDescriptor MaxOptimizationRoundsPerHyperparameter(int? maxOptimizationRoundsPerHyperparameter) { @@ -981,7 +1097,9 @@ public DataframeAnalysisRegressionDescriptor MaxOptimizationRoundsPerHyperparame } /// - /// Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization. + /// + /// Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization. + /// /// public DataframeAnalysisRegressionDescriptor MaxTrees(int? maxTrees) { @@ -990,7 +1108,9 @@ public DataframeAnalysisRegressionDescriptor MaxTrees(int? maxTrees) } /// - /// Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs. + /// + /// Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs. + /// /// public DataframeAnalysisRegressionDescriptor NumTopFeatureImportanceValues(int? numTopFeatureImportanceValues) { @@ -999,7 +1119,9 @@ public DataframeAnalysisRegressionDescriptor NumTopFeatureImportanceValues(int? } /// - /// Defines the name of the prediction field in the results. Defaults to `_prediction`. + /// + /// Defines the name of the prediction field in the results. Defaults to <dependent_variable>_prediction. + /// /// public DataframeAnalysisRegressionDescriptor PredictionFieldName(Elastic.Clients.Elasticsearch.Field? predictionFieldName) { @@ -1008,7 +1130,9 @@ public DataframeAnalysisRegressionDescriptor PredictionFieldName(Elastic.Clients } /// - /// Defines the name of the prediction field in the results. Defaults to `_prediction`. + /// + /// Defines the name of the prediction field in the results. Defaults to <dependent_variable>_prediction. + /// /// public DataframeAnalysisRegressionDescriptor PredictionFieldName(Expression> predictionFieldName) { @@ -1017,7 +1141,9 @@ public DataframeAnalysisRegressionDescriptor PredictionFieldName - /// Defines the name of the prediction field in the results. Defaults to `_prediction`. + /// + /// Defines the name of the prediction field in the results. Defaults to <dependent_variable>_prediction. + /// /// public DataframeAnalysisRegressionDescriptor PredictionFieldName(Expression> predictionFieldName) { @@ -1026,7 +1152,9 @@ public DataframeAnalysisRegressionDescriptor PredictionFieldName(Expr } /// - /// Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as `source` and `analyzed_fields` are the same). + /// + /// Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as source and analyzed_fields are the same). + /// /// public DataframeAnalysisRegressionDescriptor RandomizeSeed(double? randomizeSeed) { @@ -1035,7 +1163,9 @@ public DataframeAnalysisRegressionDescriptor RandomizeSeed(double? randomizeSeed } /// - /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the `soft_tree_depth_tolerance` to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0. + /// + /// Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the soft_tree_depth_tolerance to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0. + /// /// public DataframeAnalysisRegressionDescriptor SoftTreeDepthLimit(int? softTreeDepthLimit) { @@ -1044,7 +1174,9 @@ public DataframeAnalysisRegressionDescriptor SoftTreeDepthLimit(int? softTreeDep } /// - /// Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds `soft_tree_depth_limit`. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01. + /// + /// Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds soft_tree_depth_limit. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01. + /// /// public DataframeAnalysisRegressionDescriptor SoftTreeDepthTolerance(double? softTreeDepthTolerance) { @@ -1053,7 +1185,9 @@ public DataframeAnalysisRegressionDescriptor SoftTreeDepthTolerance(double? soft } /// - /// Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage. + /// + /// Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage. + /// /// public DataframeAnalysisRegressionDescriptor TrainingPercent(double? trainingPercent) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalytics.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalytics.g.cs index 4ecc568d97e..8bbbde9a90b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalytics.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalytics.g.cs @@ -30,43 +30,57 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DataframeAnalytics { /// - /// For running jobs only, contains messages relating to the selection of a node to run the job. + /// + /// For running jobs only, contains messages relating to the selection of a node to run the job. + /// /// [JsonInclude, JsonPropertyName("assignment_explanation")] public string? AssignmentExplanation { get; init; } /// - /// An object that provides counts for the quantity of documents skipped, used in training, or available for testing. + /// + /// An object that provides counts for the quantity of documents skipped, used in training, or available for testing. + /// /// [JsonInclude, JsonPropertyName("data_counts")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalyticsStatsDataCounts DataCounts { get; init; } /// - /// The unique identifier of the data frame analytics job. + /// + /// The unique identifier of the data frame analytics job. + /// /// [JsonInclude, JsonPropertyName("id")] public string Id { get; init; } /// - /// An object describing memory usage of the analytics. It is present only after the job is started and memory usage is reported. + /// + /// An object describing memory usage of the analytics. It is present only after the job is started and memory usage is reported. + /// /// [JsonInclude, JsonPropertyName("memory_usage")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalyticsStatsMemoryUsage MemoryUsage { get; init; } /// - /// Contains properties for the node that runs the job. This information is available only for running jobs. + /// + /// Contains properties for the node that runs the job. This information is available only for running jobs. + /// /// [JsonInclude, JsonPropertyName("node")] public Elastic.Clients.Elasticsearch.NodeAttributes? Node { get; init; } /// - /// The progress report of the data frame analytics job by phase. + /// + /// The progress report of the data frame analytics job by phase. + /// /// [JsonInclude, JsonPropertyName("progress")] public IReadOnlyCollection Progress { get; init; } /// - /// The status of the data frame analytics job, which can be one of the following values: failed, started, starting, stopping, stopped. + /// + /// The status of the data frame analytics job, which can be one of the following values: failed, started, starting, stopping, stopped. + /// /// [JsonInclude, JsonPropertyName("state")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeState State { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsAuthorization.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsAuthorization.g.cs index 46a414603a3..62c5d3ba6d5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsAuthorization.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsAuthorization.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DataframeAnalyticsAuthorization { /// - /// If an API key was used for the most recent update to the job, its name and identifier are listed in the response. + /// + /// If an API key was used for the most recent update to the job, its name and identifier are listed in the response. + /// /// [JsonInclude, JsonPropertyName("api_key")] public Elastic.Clients.Elasticsearch.MachineLearning.ApiKeyAuthorization? ApiKey { get; init; } /// - /// If a user ID was used for the most recent update to the job, its roles at the time of the update are listed in the response. + /// + /// If a user ID was used for the most recent update to the job, its roles at the time of the update are listed in the response. + /// /// [JsonInclude, JsonPropertyName("roles")] public IReadOnlyCollection? Roles { get; init; } /// - /// If a service account was used for the most recent update to the job, the account name is listed in the response. + /// + /// If a service account was used for the most recent update to the job, the account name is listed in the response. + /// /// [JsonInclude, JsonPropertyName("service_account")] public string? ServiceAccount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsDestination.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsDestination.g.cs index b4421538614..b353378f8c8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsDestination.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsDestination.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DataframeAnalyticsDestination { /// - /// Defines the destination index to store the results of the data frame analytics job. + /// + /// Defines the destination index to store the results of the data frame analytics job. + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.IndexName Index { get; set; } /// - /// Defines the name of the field in which to store the results of the analysis. Defaults to `ml`. + /// + /// Defines the name of the field in which to store the results of the analysis. Defaults to ml. + /// /// [JsonInclude, JsonPropertyName("results_field")] public Elastic.Clients.Elasticsearch.Field? ResultsField { get; set; } @@ -54,7 +58,9 @@ public DataframeAnalyticsDestinationDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? ResultsFieldValue { get; set; } /// - /// Defines the destination index to store the results of the data frame analytics job. + /// + /// Defines the destination index to store the results of the data frame analytics job. + /// /// public DataframeAnalyticsDestinationDescriptor Index(Elastic.Clients.Elasticsearch.IndexName index) { @@ -63,7 +69,9 @@ public DataframeAnalyticsDestinationDescriptor Index(Elastic.Clients. } /// - /// Defines the name of the field in which to store the results of the analysis. Defaults to `ml`. + /// + /// Defines the name of the field in which to store the results of the analysis. Defaults to ml. + /// /// public DataframeAnalyticsDestinationDescriptor ResultsField(Elastic.Clients.Elasticsearch.Field? resultsField) { @@ -72,7 +80,9 @@ public DataframeAnalyticsDestinationDescriptor ResultsField(Elastic.C } /// - /// Defines the name of the field in which to store the results of the analysis. Defaults to `ml`. + /// + /// Defines the name of the field in which to store the results of the analysis. Defaults to ml. + /// /// public DataframeAnalyticsDestinationDescriptor ResultsField(Expression> resultsField) { @@ -81,7 +91,9 @@ public DataframeAnalyticsDestinationDescriptor ResultsField(E } /// - /// Defines the name of the field in which to store the results of the analysis. Defaults to `ml`. + /// + /// Defines the name of the field in which to store the results of the analysis. Defaults to ml. + /// /// public DataframeAnalyticsDestinationDescriptor ResultsField(Expression> resultsField) { @@ -116,7 +128,9 @@ public DataframeAnalyticsDestinationDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? ResultsFieldValue { get; set; } /// - /// Defines the destination index to store the results of the data frame analytics job. + /// + /// Defines the destination index to store the results of the data frame analytics job. + /// /// public DataframeAnalyticsDestinationDescriptor Index(Elastic.Clients.Elasticsearch.IndexName index) { @@ -125,7 +139,9 @@ public DataframeAnalyticsDestinationDescriptor Index(Elastic.Clients.Elasticsear } /// - /// Defines the name of the field in which to store the results of the analysis. Defaults to `ml`. + /// + /// Defines the name of the field in which to store the results of the analysis. Defaults to ml. + /// /// public DataframeAnalyticsDestinationDescriptor ResultsField(Elastic.Clients.Elasticsearch.Field? resultsField) { @@ -134,7 +150,9 @@ public DataframeAnalyticsDestinationDescriptor ResultsField(Elastic.Clients.Elas } /// - /// Defines the name of the field in which to store the results of the analysis. Defaults to `ml`. + /// + /// Defines the name of the field in which to store the results of the analysis. Defaults to ml. + /// /// public DataframeAnalyticsDestinationDescriptor ResultsField(Expression> resultsField) { @@ -143,7 +161,9 @@ public DataframeAnalyticsDestinationDescriptor ResultsField(E } /// - /// Defines the name of the field in which to store the results of the analysis. Defaults to `ml`. + /// + /// Defines the name of the field in which to store the results of the analysis. Defaults to ml. + /// /// public DataframeAnalyticsDestinationDescriptor ResultsField(Expression> resultsField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsFieldSelection.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsFieldSelection.g.cs index 9ace2f1a2e4..331e606604f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsFieldSelection.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsFieldSelection.g.cs @@ -30,37 +30,49 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DataframeAnalyticsFieldSelection { /// - /// The feature type of this field for the analysis. May be categorical or numerical. + /// + /// The feature type of this field for the analysis. May be categorical or numerical. + /// /// [JsonInclude, JsonPropertyName("feature_type")] public string? FeatureType { get; init; } /// - /// Whether the field is selected to be included in the analysis. + /// + /// Whether the field is selected to be included in the analysis. + /// /// [JsonInclude, JsonPropertyName("is_included")] public bool IsIncluded { get; init; } /// - /// Whether the field is required. + /// + /// Whether the field is required. + /// /// [JsonInclude, JsonPropertyName("is_required")] public bool IsRequired { get; init; } /// - /// The mapping types of the field. + /// + /// The mapping types of the field. + /// /// [JsonInclude, JsonPropertyName("mapping_types")] public IReadOnlyCollection MappingTypes { get; init; } /// - /// The field name. + /// + /// The field name. + /// /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } /// - /// The reason a field is not selected to be included in the analysis. + /// + /// The reason a field is not selected to be included in the analysis. + /// /// [JsonInclude, JsonPropertyName("reason")] public string? Reason { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsMemoryEstimation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsMemoryEstimation.g.cs index 982f9c11c84..c2e75b6aea1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsMemoryEstimation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsMemoryEstimation.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DataframeAnalyticsMemoryEstimation { /// - /// Estimated memory usage under the assumption that overflowing to disk is allowed during data frame analytics. expected_memory_with_disk is usually smaller than expected_memory_without_disk as using disk allows to limit the main memory needed to perform data frame analytics. + /// + /// Estimated memory usage under the assumption that overflowing to disk is allowed during data frame analytics. expected_memory_with_disk is usually smaller than expected_memory_without_disk as using disk allows to limit the main memory needed to perform data frame analytics. + /// /// [JsonInclude, JsonPropertyName("expected_memory_with_disk")] public string ExpectedMemoryWithDisk { get; init; } /// - /// Estimated memory usage under the assumption that the whole data frame analytics should happen in memory (i.e. without overflowing to disk). + /// + /// Estimated memory usage under the assumption that the whole data frame analytics should happen in memory (i.e. without overflowing to disk). + /// /// [JsonInclude, JsonPropertyName("expected_memory_without_disk")] public string ExpectedMemoryWithoutDisk { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsSource.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsSource.g.cs index 20bbb7ebd75..76b55d521f2 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsSource.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsSource.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DataframeAnalyticsSource { /// - /// Index or indices on which to perform the analysis. It can be a single index or index pattern as well as an array of indices or patterns. NOTE: If your source indices contain documents with the same IDs, only the document that is indexed last appears in the destination index. + /// + /// Index or indices on which to perform the analysis. It can be a single index or index pattern as well as an array of indices or patterns. NOTE: If your source indices contain documents with the same IDs, only the document that is indexed last appears in the destination index. + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.Indices Indices { get; set; } /// - /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: {"match_all": {}}. + /// + /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: {"match_all": {}}. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Query { get; set; } /// - /// Definitions of runtime fields that will become part of the mapping of the destination index. + /// + /// Definitions of runtime fields that will become part of the mapping of the destination index. + /// /// [JsonInclude, JsonPropertyName("runtime_mappings")] public IDictionary? RuntimeMappings { get; set; } /// - /// Specify `includes` and/or `excludes patterns to select which fields will be present in the destination. Fields that are excluded cannot be included in the analysis. + /// + /// Specify includes and/or `excludes patterns to select which fields will be present in the destination. Fields that are excluded cannot be included in the analysis. + /// /// [JsonInclude, JsonPropertyName("_source")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalysisAnalyzedFields? Source { get; set; } @@ -72,7 +80,9 @@ public DataframeAnalyticsSourceDescriptor() : base() private Action SourceDescriptorAction { get; set; } /// - /// Index or indices on which to perform the analysis. It can be a single index or index pattern as well as an array of indices or patterns. NOTE: If your source indices contain documents with the same IDs, only the document that is indexed last appears in the destination index. + /// + /// Index or indices on which to perform the analysis. It can be a single index or index pattern as well as an array of indices or patterns. NOTE: If your source indices contain documents with the same IDs, only the document that is indexed last appears in the destination index. + /// /// public DataframeAnalyticsSourceDescriptor Indices(Elastic.Clients.Elasticsearch.Indices indices) { @@ -81,7 +91,9 @@ public DataframeAnalyticsSourceDescriptor Indices(Elastic.Clients.Ela } /// - /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: {"match_all": {}}. + /// + /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: {"match_all": {}}. + /// /// public DataframeAnalyticsSourceDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -108,7 +120,9 @@ public DataframeAnalyticsSourceDescriptor Query(Action - /// Definitions of runtime fields that will become part of the mapping of the destination index. + /// + /// Definitions of runtime fields that will become part of the mapping of the destination index. + /// /// public DataframeAnalyticsSourceDescriptor RuntimeMappings(Func>, FluentDescriptorDictionary>> selector) { @@ -117,7 +131,9 @@ public DataframeAnalyticsSourceDescriptor RuntimeMappings(Func - /// Specify `includes` and/or `excludes patterns to select which fields will be present in the destination. Fields that are excluded cannot be included in the analysis. + /// + /// Specify includes and/or `excludes patterns to select which fields will be present in the destination. Fields that are excluded cannot be included in the analysis. + /// /// public DataframeAnalyticsSourceDescriptor Source(Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalysisAnalyzedFields? source) { @@ -208,7 +224,9 @@ public DataframeAnalyticsSourceDescriptor() : base() private Action SourceDescriptorAction { get; set; } /// - /// Index or indices on which to perform the analysis. It can be a single index or index pattern as well as an array of indices or patterns. NOTE: If your source indices contain documents with the same IDs, only the document that is indexed last appears in the destination index. + /// + /// Index or indices on which to perform the analysis. It can be a single index or index pattern as well as an array of indices or patterns. NOTE: If your source indices contain documents with the same IDs, only the document that is indexed last appears in the destination index. + /// /// public DataframeAnalyticsSourceDescriptor Indices(Elastic.Clients.Elasticsearch.Indices indices) { @@ -217,7 +235,9 @@ public DataframeAnalyticsSourceDescriptor Indices(Elastic.Clients.Elasticsearch. } /// - /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: {"match_all": {}}. + /// + /// The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: {"match_all": {}}. + /// /// public DataframeAnalyticsSourceDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -244,7 +264,9 @@ public DataframeAnalyticsSourceDescriptor Query(Action - /// Definitions of runtime fields that will become part of the mapping of the destination index. + /// + /// Definitions of runtime fields that will become part of the mapping of the destination index. + /// /// public DataframeAnalyticsSourceDescriptor RuntimeMappings(Func, FluentDescriptorDictionary> selector) { @@ -253,7 +275,9 @@ public DataframeAnalyticsSourceDescriptor RuntimeMappings(Func - /// Specify `includes` and/or `excludes patterns to select which fields will be present in the destination. Fields that are excluded cannot be included in the analysis. + /// + /// Specify includes and/or `excludes patterns to select which fields will be present in the destination. Fields that are excluded cannot be included in the analysis. + /// /// public DataframeAnalyticsSourceDescriptor Source(Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalysisAnalyzedFields? source) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsStatsDataCounts.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsStatsDataCounts.g.cs index 35d62c44544..be8a4a23b11 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsStatsDataCounts.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsStatsDataCounts.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DataframeAnalyticsStatsDataCounts { /// - /// The number of documents that are skipped during the analysis because they contained values that are not supported by the analysis. For example, outlier detection does not support missing fields so it skips documents with missing fields. Likewise, all types of analysis skip documents that contain arrays with more than one element. + /// + /// The number of documents that are skipped during the analysis because they contained values that are not supported by the analysis. For example, outlier detection does not support missing fields so it skips documents with missing fields. Likewise, all types of analysis skip documents that contain arrays with more than one element. + /// /// [JsonInclude, JsonPropertyName("skipped_docs_count")] public int SkippedDocsCount { get; init; } /// - /// The number of documents that are not used for training the model and can be used for testing. + /// + /// The number of documents that are not used for training the model and can be used for testing. + /// /// [JsonInclude, JsonPropertyName("test_docs_count")] public int TestDocsCount { get; init; } /// - /// The number of documents that are used for training the model. + /// + /// The number of documents that are used for training the model. + /// /// [JsonInclude, JsonPropertyName("training_docs_count")] public int TrainingDocsCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsStatsMemoryUsage.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsStatsMemoryUsage.g.cs index 236caf76c5e..53e45c571df 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsStatsMemoryUsage.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsStatsMemoryUsage.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DataframeAnalyticsStatsMemoryUsage { /// - /// This value is present when the status is hard_limit and it is a new estimate of how much memory the job needs. + /// + /// This value is present when the status is hard_limit and it is a new estimate of how much memory the job needs. + /// /// [JsonInclude, JsonPropertyName("memory_reestimate_bytes")] public long? MemoryReestimateBytes { get; init; } /// - /// The number of bytes used at the highest peak of memory usage. + /// + /// The number of bytes used at the highest peak of memory usage. + /// /// [JsonInclude, JsonPropertyName("peak_usage_bytes")] public long PeakUsageBytes { get; init; } /// - /// The memory usage status. + /// + /// The memory usage status. + /// /// [JsonInclude, JsonPropertyName("status")] public string Status { get; init; } /// - /// The timestamp when memory usage was calculated. + /// + /// The timestamp when memory usage was calculated. + /// /// [JsonInclude, JsonPropertyName("timestamp")] public long? Timestamp { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsStatsProgress.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsStatsProgress.g.cs index 1ce9c8604aa..8731ecaf8d8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsStatsProgress.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsStatsProgress.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DataframeAnalyticsStatsProgress { /// - /// Defines the phase of the data frame analytics job. + /// + /// Defines the phase of the data frame analytics job. + /// /// [JsonInclude, JsonPropertyName("phase")] public string Phase { get; init; } /// - /// The progress that the data frame analytics job has made expressed in percentage. + /// + /// The progress that the data frame analytics job has made expressed in percentage. + /// /// [JsonInclude, JsonPropertyName("progress_percent")] public int ProgressPercent { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsSummary.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsSummary.g.cs index 46d369bb8da..22e36e83cb9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsSummary.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsSummary.g.cs @@ -37,7 +37,9 @@ public sealed partial class DataframeAnalyticsSummary public Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalysisAnalyzedFields? AnalyzedFields { get; init; } /// - /// The security privileges that the job uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the job, this property is omitted. + /// + /// The security privileges that the job uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the job, this property is omitted. + /// /// [JsonInclude, JsonPropertyName("authorization")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalyticsAuthorization? Authorization { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeClassificationSummary.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeClassificationSummary.g.cs index 814f0b4ca7d..b231268d838 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeClassificationSummary.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeClassificationSummary.g.cs @@ -30,31 +30,42 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DataframeClassificationSummary { /// - /// Accuracy of predictions (per-class and overall). + /// + /// Accuracy of predictions (per-class and overall). + /// /// [JsonInclude, JsonPropertyName("accuracy")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeClassificationSummaryAccuracy? Accuracy { get; init; } /// - /// The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve.
It is calculated for a specific class (provided as "class_name") treated as positive. + /// + /// The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. + /// It is calculated for a specific class (provided as "class_name") treated as positive. + /// /// [JsonInclude, JsonPropertyName("auc_roc")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeEvaluationSummaryAucRoc? AucRoc { get; init; } /// - /// Multiclass confusion matrix. + /// + /// Multiclass confusion matrix. + /// /// [JsonInclude, JsonPropertyName("multiclass_confusion_matrix")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeClassificationSummaryMulticlassConfusionMatrix? MulticlassConfusionMatrix { get; init; } /// - /// Precision of predictions (per-class and average). + /// + /// Precision of predictions (per-class and average). + /// /// [JsonInclude, JsonPropertyName("precision")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeClassificationSummaryPrecision? Precision { get; init; } /// - /// Recall of predictions (per-class and average). + /// + /// Recall of predictions (per-class and average). + /// /// [JsonInclude, JsonPropertyName("recall")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeClassificationSummaryRecall? Recall { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationClassification.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationClassification.g.cs index 6c399078751..506c353f166 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationClassification.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationClassification.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DataframeEvaluationClassification { /// - /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// + /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// /// [JsonInclude, JsonPropertyName("actual_field")] public Elastic.Clients.Elasticsearch.Field ActualField { get; set; } /// - /// Specifies the metrics that are used for the evaluation. + /// + /// Specifies the metrics that are used for the evaluation. + /// /// [JsonInclude, JsonPropertyName("metrics")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeEvaluationClassificationMetrics? Metrics { get; set; } /// - /// The field in the index which contains the predicted value, in other words the results of the classification analysis. + /// + /// The field in the index which contains the predicted value, in other words the results of the classification analysis. + /// /// [JsonInclude, JsonPropertyName("predicted_field")] public Elastic.Clients.Elasticsearch.Field? PredictedField { get; set; } /// - /// The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }. This field must be defined as nested in the mappings. + /// + /// The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }. This field must be defined as nested in the mappings. + /// /// [JsonInclude, JsonPropertyName("top_classes_field")] public Elastic.Clients.Elasticsearch.Field? TopClassesField { get; set; } @@ -72,7 +80,9 @@ public DataframeEvaluationClassificationDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TopClassesFieldValue { get; set; } /// - /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// + /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// /// public DataframeEvaluationClassificationDescriptor ActualField(Elastic.Clients.Elasticsearch.Field actualField) { @@ -81,7 +91,9 @@ public DataframeEvaluationClassificationDescriptor ActualField(Elasti } /// - /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// + /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// /// public DataframeEvaluationClassificationDescriptor ActualField(Expression> actualField) { @@ -90,7 +102,9 @@ public DataframeEvaluationClassificationDescriptor ActualField - /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// + /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// /// public DataframeEvaluationClassificationDescriptor ActualField(Expression> actualField) { @@ -99,7 +113,9 @@ public DataframeEvaluationClassificationDescriptor ActualField(Expres } /// - /// Specifies the metrics that are used for the evaluation. + /// + /// Specifies the metrics that are used for the evaluation. + /// /// public DataframeEvaluationClassificationDescriptor Metrics(Elastic.Clients.Elasticsearch.MachineLearning.DataframeEvaluationClassificationMetrics? metrics) { @@ -126,7 +142,9 @@ public DataframeEvaluationClassificationDescriptor Metrics(Action - /// The field in the index which contains the predicted value, in other words the results of the classification analysis. + /// + /// The field in the index which contains the predicted value, in other words the results of the classification analysis. + /// /// public DataframeEvaluationClassificationDescriptor PredictedField(Elastic.Clients.Elasticsearch.Field? predictedField) { @@ -135,7 +153,9 @@ public DataframeEvaluationClassificationDescriptor PredictedField(Ela } /// - /// The field in the index which contains the predicted value, in other words the results of the classification analysis. + /// + /// The field in the index which contains the predicted value, in other words the results of the classification analysis. + /// /// public DataframeEvaluationClassificationDescriptor PredictedField(Expression> predictedField) { @@ -144,7 +164,9 @@ public DataframeEvaluationClassificationDescriptor PredictedField - /// The field in the index which contains the predicted value, in other words the results of the classification analysis. + /// + /// The field in the index which contains the predicted value, in other words the results of the classification analysis. + /// /// public DataframeEvaluationClassificationDescriptor PredictedField(Expression> predictedField) { @@ -153,7 +175,9 @@ public DataframeEvaluationClassificationDescriptor PredictedField(Exp } /// - /// The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }. This field must be defined as nested in the mappings. + /// + /// The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }. This field must be defined as nested in the mappings. + /// /// public DataframeEvaluationClassificationDescriptor TopClassesField(Elastic.Clients.Elasticsearch.Field? topClassesField) { @@ -162,7 +186,9 @@ public DataframeEvaluationClassificationDescriptor TopClassesField(El } /// - /// The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }. This field must be defined as nested in the mappings. + /// + /// The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }. This field must be defined as nested in the mappings. + /// /// public DataframeEvaluationClassificationDescriptor TopClassesField(Expression> topClassesField) { @@ -171,7 +197,9 @@ public DataframeEvaluationClassificationDescriptor TopClassesField - /// The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }. This field must be defined as nested in the mappings. + /// + /// The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }. This field must be defined as nested in the mappings. + /// /// public DataframeEvaluationClassificationDescriptor TopClassesField(Expression> topClassesField) { @@ -232,7 +260,9 @@ public DataframeEvaluationClassificationDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TopClassesFieldValue { get; set; } /// - /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// + /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// /// public DataframeEvaluationClassificationDescriptor ActualField(Elastic.Clients.Elasticsearch.Field actualField) { @@ -241,7 +271,9 @@ public DataframeEvaluationClassificationDescriptor ActualField(Elastic.Clients.E } /// - /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// + /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// /// public DataframeEvaluationClassificationDescriptor ActualField(Expression> actualField) { @@ -250,7 +282,9 @@ public DataframeEvaluationClassificationDescriptor ActualField - /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// + /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// /// public DataframeEvaluationClassificationDescriptor ActualField(Expression> actualField) { @@ -259,7 +293,9 @@ public DataframeEvaluationClassificationDescriptor ActualField(Expres } /// - /// Specifies the metrics that are used for the evaluation. + /// + /// Specifies the metrics that are used for the evaluation. + /// /// public DataframeEvaluationClassificationDescriptor Metrics(Elastic.Clients.Elasticsearch.MachineLearning.DataframeEvaluationClassificationMetrics? metrics) { @@ -286,7 +322,9 @@ public DataframeEvaluationClassificationDescriptor Metrics(Action - /// The field in the index which contains the predicted value, in other words the results of the classification analysis. + /// + /// The field in the index which contains the predicted value, in other words the results of the classification analysis. + /// /// public DataframeEvaluationClassificationDescriptor PredictedField(Elastic.Clients.Elasticsearch.Field? predictedField) { @@ -295,7 +333,9 @@ public DataframeEvaluationClassificationDescriptor PredictedField(Elastic.Client } /// - /// The field in the index which contains the predicted value, in other words the results of the classification analysis. + /// + /// The field in the index which contains the predicted value, in other words the results of the classification analysis. + /// /// public DataframeEvaluationClassificationDescriptor PredictedField(Expression> predictedField) { @@ -304,7 +344,9 @@ public DataframeEvaluationClassificationDescriptor PredictedField - /// The field in the index which contains the predicted value, in other words the results of the classification analysis. + /// + /// The field in the index which contains the predicted value, in other words the results of the classification analysis. + /// /// public DataframeEvaluationClassificationDescriptor PredictedField(Expression> predictedField) { @@ -313,7 +355,9 @@ public DataframeEvaluationClassificationDescriptor PredictedField(Exp } /// - /// The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }. This field must be defined as nested in the mappings. + /// + /// The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }. This field must be defined as nested in the mappings. + /// /// public DataframeEvaluationClassificationDescriptor TopClassesField(Elastic.Clients.Elasticsearch.Field? topClassesField) { @@ -322,7 +366,9 @@ public DataframeEvaluationClassificationDescriptor TopClassesField(Elastic.Clien } /// - /// The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }. This field must be defined as nested in the mappings. + /// + /// The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }. This field must be defined as nested in the mappings. + /// /// public DataframeEvaluationClassificationDescriptor TopClassesField(Expression> topClassesField) { @@ -331,7 +377,9 @@ public DataframeEvaluationClassificationDescriptor TopClassesField - /// The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }. This field must be defined as nested in the mappings. + /// + /// The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY }. This field must be defined as nested in the mappings. + /// /// public DataframeEvaluationClassificationDescriptor TopClassesField(Expression> topClassesField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationClassificationMetrics.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationClassificationMetrics.g.cs index 561d5cb44dd..545ba7f9664 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationClassificationMetrics.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationClassificationMetrics.g.cs @@ -30,31 +30,41 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DataframeEvaluationClassificationMetrics { /// - /// Accuracy of predictions (per-class and overall). + /// + /// Accuracy of predictions (per-class and overall). + /// /// [JsonInclude, JsonPropertyName("accuracy")] public IDictionary? Accuracy { get; set; } /// - /// The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. It is calculated for a specific class (provided as "class_name") treated as positive. + /// + /// The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. It is calculated for a specific class (provided as "class_name") treated as positive. + /// /// [JsonInclude, JsonPropertyName("auc_roc")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeEvaluationClassificationMetricsAucRoc? AucRoc { get; set; } /// - /// Multiclass confusion matrix. + /// + /// Multiclass confusion matrix. + /// /// [JsonInclude, JsonPropertyName("multiclass_confusion_matrix")] public IDictionary? MulticlassConfusionMatrix { get; set; } /// - /// Precision of predictions (per-class and average). + /// + /// Precision of predictions (per-class and average). + /// /// [JsonInclude, JsonPropertyName("precision")] public IDictionary? Precision { get; set; } /// - /// Recall of predictions (per-class and average). + /// + /// Recall of predictions (per-class and average). + /// /// [JsonInclude, JsonPropertyName("recall")] public IDictionary? Recall { get; set; } @@ -77,7 +87,9 @@ public DataframeEvaluationClassificationMetricsDescriptor() : base() private IDictionary? RecallValue { get; set; } /// - /// Accuracy of predictions (per-class and overall). + /// + /// Accuracy of predictions (per-class and overall). + /// /// public DataframeEvaluationClassificationMetricsDescriptor Accuracy(Func, FluentDictionary> selector) { @@ -86,7 +98,9 @@ public DataframeEvaluationClassificationMetricsDescriptor Accuracy(Func - /// The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. It is calculated for a specific class (provided as "class_name") treated as positive. + /// + /// The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. It is calculated for a specific class (provided as "class_name") treated as positive. + /// /// public DataframeEvaluationClassificationMetricsDescriptor AucRoc(Elastic.Clients.Elasticsearch.MachineLearning.DataframeEvaluationClassificationMetricsAucRoc? aucRoc) { @@ -113,7 +127,9 @@ public DataframeEvaluationClassificationMetricsDescriptor AucRoc(Action - /// Multiclass confusion matrix. + /// + /// Multiclass confusion matrix. + /// /// public DataframeEvaluationClassificationMetricsDescriptor MulticlassConfusionMatrix(Func, FluentDictionary> selector) { @@ -122,7 +138,9 @@ public DataframeEvaluationClassificationMetricsDescriptor MulticlassConfusionMat } /// - /// Precision of predictions (per-class and average). + /// + /// Precision of predictions (per-class and average). + /// /// public DataframeEvaluationClassificationMetricsDescriptor Precision(Func, FluentDictionary> selector) { @@ -131,7 +149,9 @@ public DataframeEvaluationClassificationMetricsDescriptor Precision(Func - /// Recall of predictions (per-class and average). + /// + /// Recall of predictions (per-class and average). + /// /// public DataframeEvaluationClassificationMetricsDescriptor Recall(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationClassificationMetricsAucRoc.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationClassificationMetricsAucRoc.g.cs index f4cefa988b4..2fed2d49533 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationClassificationMetricsAucRoc.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationClassificationMetricsAucRoc.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DataframeEvaluationClassificationMetricsAucRoc { /// - /// Name of the only class that is treated as positive during AUC ROC calculation. Other classes are treated as negative ("one-vs-all" strategy). All the evaluated documents must have class_name in the list of their top classes. + /// + /// Name of the only class that is treated as positive during AUC ROC calculation. Other classes are treated as negative ("one-vs-all" strategy). All the evaluated documents must have class_name in the list of their top classes. + /// /// [JsonInclude, JsonPropertyName("class_name")] public Elastic.Clients.Elasticsearch.Name? ClassName { get; set; } /// - /// Whether or not the curve should be returned in addition to the score. Default value is false. + /// + /// Whether or not the curve should be returned in addition to the score. Default value is false. + /// /// [JsonInclude, JsonPropertyName("include_curve")] public bool? IncludeCurve { get; set; } @@ -54,7 +58,9 @@ public DataframeEvaluationClassificationMetricsAucRocDescriptor() : base() private bool? IncludeCurveValue { get; set; } /// - /// Name of the only class that is treated as positive during AUC ROC calculation. Other classes are treated as negative ("one-vs-all" strategy). All the evaluated documents must have class_name in the list of their top classes. + /// + /// Name of the only class that is treated as positive during AUC ROC calculation. Other classes are treated as negative ("one-vs-all" strategy). All the evaluated documents must have class_name in the list of their top classes. + /// /// public DataframeEvaluationClassificationMetricsAucRocDescriptor ClassName(Elastic.Clients.Elasticsearch.Name? className) { @@ -63,7 +69,9 @@ public DataframeEvaluationClassificationMetricsAucRocDescriptor ClassName(Elasti } /// - /// Whether or not the curve should be returned in addition to the score. Default value is false. + /// + /// Whether or not the curve should be returned in addition to the score. Default value is false. + /// /// public DataframeEvaluationClassificationMetricsAucRocDescriptor IncludeCurve(bool? includeCurve = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationOutlierDetection.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationOutlierDetection.g.cs index c159a929756..ff32e4ff559 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationOutlierDetection.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationOutlierDetection.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DataframeEvaluationOutlierDetection { /// - /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// + /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// /// [JsonInclude, JsonPropertyName("actual_field")] public Elastic.Clients.Elasticsearch.Field ActualField { get; set; } /// - /// Specifies the metrics that are used for the evaluation. + /// + /// Specifies the metrics that are used for the evaluation. + /// /// [JsonInclude, JsonPropertyName("metrics")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeEvaluationOutlierDetectionMetrics? Metrics { get; set; } /// - /// The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis. + /// + /// The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis. + /// /// [JsonInclude, JsonPropertyName("predicted_probability_field")] public Elastic.Clients.Elasticsearch.Field PredictedProbabilityField { get; set; } @@ -65,7 +71,9 @@ public DataframeEvaluationOutlierDetectionDescriptor() : base() private Elastic.Clients.Elasticsearch.Field PredictedProbabilityFieldValue { get; set; } /// - /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// + /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// /// public DataframeEvaluationOutlierDetectionDescriptor ActualField(Elastic.Clients.Elasticsearch.Field actualField) { @@ -74,7 +82,9 @@ public DataframeEvaluationOutlierDetectionDescriptor ActualField(Elas } /// - /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// + /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// /// public DataframeEvaluationOutlierDetectionDescriptor ActualField(Expression> actualField) { @@ -83,7 +93,9 @@ public DataframeEvaluationOutlierDetectionDescriptor ActualField - /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// + /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// /// public DataframeEvaluationOutlierDetectionDescriptor ActualField(Expression> actualField) { @@ -92,7 +104,9 @@ public DataframeEvaluationOutlierDetectionDescriptor ActualField(Expr } /// - /// Specifies the metrics that are used for the evaluation. + /// + /// Specifies the metrics that are used for the evaluation. + /// /// public DataframeEvaluationOutlierDetectionDescriptor Metrics(Elastic.Clients.Elasticsearch.MachineLearning.DataframeEvaluationOutlierDetectionMetrics? metrics) { @@ -119,7 +133,9 @@ public DataframeEvaluationOutlierDetectionDescriptor Metrics(Action - /// The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis. + /// + /// The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis. + /// /// public DataframeEvaluationOutlierDetectionDescriptor PredictedProbabilityField(Elastic.Clients.Elasticsearch.Field predictedProbabilityField) { @@ -128,7 +144,9 @@ public DataframeEvaluationOutlierDetectionDescriptor PredictedProbabi } /// - /// The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis. + /// + /// The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis. + /// /// public DataframeEvaluationOutlierDetectionDescriptor PredictedProbabilityField(Expression> predictedProbabilityField) { @@ -137,7 +155,9 @@ public DataframeEvaluationOutlierDetectionDescriptor PredictedProbabi } /// - /// The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis. + /// + /// The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis. + /// /// public DataframeEvaluationOutlierDetectionDescriptor PredictedProbabilityField(Expression> predictedProbabilityField) { @@ -187,7 +207,9 @@ public DataframeEvaluationOutlierDetectionDescriptor() : base() private Elastic.Clients.Elasticsearch.Field PredictedProbabilityFieldValue { get; set; } /// - /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// + /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// /// public DataframeEvaluationOutlierDetectionDescriptor ActualField(Elastic.Clients.Elasticsearch.Field actualField) { @@ -196,7 +218,9 @@ public DataframeEvaluationOutlierDetectionDescriptor ActualField(Elastic.Clients } /// - /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// + /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// /// public DataframeEvaluationOutlierDetectionDescriptor ActualField(Expression> actualField) { @@ -205,7 +229,9 @@ public DataframeEvaluationOutlierDetectionDescriptor ActualField - /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// + /// The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). + /// /// public DataframeEvaluationOutlierDetectionDescriptor ActualField(Expression> actualField) { @@ -214,7 +240,9 @@ public DataframeEvaluationOutlierDetectionDescriptor ActualField(Expr } /// - /// Specifies the metrics that are used for the evaluation. + /// + /// Specifies the metrics that are used for the evaluation. + /// /// public DataframeEvaluationOutlierDetectionDescriptor Metrics(Elastic.Clients.Elasticsearch.MachineLearning.DataframeEvaluationOutlierDetectionMetrics? metrics) { @@ -241,7 +269,9 @@ public DataframeEvaluationOutlierDetectionDescriptor Metrics(Action - /// The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis. + /// + /// The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis. + /// /// public DataframeEvaluationOutlierDetectionDescriptor PredictedProbabilityField(Elastic.Clients.Elasticsearch.Field predictedProbabilityField) { @@ -250,7 +280,9 @@ public DataframeEvaluationOutlierDetectionDescriptor PredictedProbabilityField(E } /// - /// The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis. + /// + /// The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis. + /// /// public DataframeEvaluationOutlierDetectionDescriptor PredictedProbabilityField(Expression> predictedProbabilityField) { @@ -259,7 +291,9 @@ public DataframeEvaluationOutlierDetectionDescriptor PredictedProbabilityField - /// The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis. + /// + /// The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis. + /// /// public DataframeEvaluationOutlierDetectionDescriptor PredictedProbabilityField(Expression> predictedProbabilityField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationOutlierDetectionMetrics.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationOutlierDetectionMetrics.g.cs index 2b23a7319df..b5f6efcb923 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationOutlierDetectionMetrics.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationOutlierDetectionMetrics.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DataframeEvaluationOutlierDetectionMetrics { /// - /// The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. It is calculated for a specific class (provided as "class_name") treated as positive. + /// + /// The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. It is calculated for a specific class (provided as "class_name") treated as positive. + /// /// [JsonInclude, JsonPropertyName("auc_roc")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeEvaluationClassificationMetricsAucRoc? AucRoc { get; set; } /// - /// Accuracy of predictions (per-class and overall). + /// + /// Accuracy of predictions (per-class and overall). + /// /// [JsonInclude, JsonPropertyName("confusion_matrix")] public IDictionary? ConfusionMatrix { get; set; } /// - /// Precision of predictions (per-class and average). + /// + /// Precision of predictions (per-class and average). + /// /// [JsonInclude, JsonPropertyName("precision")] public IDictionary? Precision { get; set; } /// - /// Recall of predictions (per-class and average). + /// + /// Recall of predictions (per-class and average). + /// /// [JsonInclude, JsonPropertyName("recall")] public IDictionary? Recall { get; set; } @@ -70,7 +78,9 @@ public DataframeEvaluationOutlierDetectionMetricsDescriptor() : base() private IDictionary? RecallValue { get; set; } /// - /// The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. It is calculated for a specific class (provided as "class_name") treated as positive. + /// + /// The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. It is calculated for a specific class (provided as "class_name") treated as positive. + /// /// public DataframeEvaluationOutlierDetectionMetricsDescriptor AucRoc(Elastic.Clients.Elasticsearch.MachineLearning.DataframeEvaluationClassificationMetricsAucRoc? aucRoc) { @@ -97,7 +107,9 @@ public DataframeEvaluationOutlierDetectionMetricsDescriptor AucRoc(Action - /// Accuracy of predictions (per-class and overall). + /// + /// Accuracy of predictions (per-class and overall). + /// /// public DataframeEvaluationOutlierDetectionMetricsDescriptor ConfusionMatrix(Func, FluentDictionary> selector) { @@ -106,7 +118,9 @@ public DataframeEvaluationOutlierDetectionMetricsDescriptor ConfusionMatrix(Func } /// - /// Precision of predictions (per-class and average). + /// + /// Precision of predictions (per-class and average). + /// /// public DataframeEvaluationOutlierDetectionMetricsDescriptor Precision(Func, FluentDictionary> selector) { @@ -115,7 +129,9 @@ public DataframeEvaluationOutlierDetectionMetricsDescriptor Precision(Func - /// Recall of predictions (per-class and average). + /// + /// Recall of predictions (per-class and average). + /// /// public DataframeEvaluationOutlierDetectionMetricsDescriptor Recall(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationRegression.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationRegression.g.cs index 872dd808c8e..dcac1f28c36 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationRegression.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationRegression.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DataframeEvaluationRegression { /// - /// The field of the index which contains the ground truth. The data type of this field must be numerical. + /// + /// The field of the index which contains the ground truth. The data type of this field must be numerical. + /// /// [JsonInclude, JsonPropertyName("actual_field")] public Elastic.Clients.Elasticsearch.Field ActualField { get; set; } /// - /// Specifies the metrics that are used for the evaluation. For more information on mse, msle, and huber, consult the Jupyter notebook on regression loss functions. + /// + /// Specifies the metrics that are used for the evaluation. For more information on mse, msle, and huber, consult the Jupyter notebook on regression loss functions. + /// /// [JsonInclude, JsonPropertyName("metrics")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeEvaluationRegressionMetrics? Metrics { get; set; } /// - /// The field in the index that contains the predicted value, in other words the results of the regression analysis. + /// + /// The field in the index that contains the predicted value, in other words the results of the regression analysis. + /// /// [JsonInclude, JsonPropertyName("predicted_field")] public Elastic.Clients.Elasticsearch.Field PredictedField { get; set; } @@ -65,7 +71,9 @@ public DataframeEvaluationRegressionDescriptor() : base() private Elastic.Clients.Elasticsearch.Field PredictedFieldValue { get; set; } /// - /// The field of the index which contains the ground truth. The data type of this field must be numerical. + /// + /// The field of the index which contains the ground truth. The data type of this field must be numerical. + /// /// public DataframeEvaluationRegressionDescriptor ActualField(Elastic.Clients.Elasticsearch.Field actualField) { @@ -74,7 +82,9 @@ public DataframeEvaluationRegressionDescriptor ActualField(Elastic.Cl } /// - /// The field of the index which contains the ground truth. The data type of this field must be numerical. + /// + /// The field of the index which contains the ground truth. The data type of this field must be numerical. + /// /// public DataframeEvaluationRegressionDescriptor ActualField(Expression> actualField) { @@ -83,7 +93,9 @@ public DataframeEvaluationRegressionDescriptor ActualField(Ex } /// - /// The field of the index which contains the ground truth. The data type of this field must be numerical. + /// + /// The field of the index which contains the ground truth. The data type of this field must be numerical. + /// /// public DataframeEvaluationRegressionDescriptor ActualField(Expression> actualField) { @@ -92,7 +104,9 @@ public DataframeEvaluationRegressionDescriptor ActualField(Expression } /// - /// Specifies the metrics that are used for the evaluation. For more information on mse, msle, and huber, consult the Jupyter notebook on regression loss functions. + /// + /// Specifies the metrics that are used for the evaluation. For more information on mse, msle, and huber, consult the Jupyter notebook on regression loss functions. + /// /// public DataframeEvaluationRegressionDescriptor Metrics(Elastic.Clients.Elasticsearch.MachineLearning.DataframeEvaluationRegressionMetrics? metrics) { @@ -119,7 +133,9 @@ public DataframeEvaluationRegressionDescriptor Metrics(Action - /// The field in the index that contains the predicted value, in other words the results of the regression analysis. + /// + /// The field in the index that contains the predicted value, in other words the results of the regression analysis. + /// /// public DataframeEvaluationRegressionDescriptor PredictedField(Elastic.Clients.Elasticsearch.Field predictedField) { @@ -128,7 +144,9 @@ public DataframeEvaluationRegressionDescriptor PredictedField(Elastic } /// - /// The field in the index that contains the predicted value, in other words the results of the regression analysis. + /// + /// The field in the index that contains the predicted value, in other words the results of the regression analysis. + /// /// public DataframeEvaluationRegressionDescriptor PredictedField(Expression> predictedField) { @@ -137,7 +155,9 @@ public DataframeEvaluationRegressionDescriptor PredictedField } /// - /// The field in the index that contains the predicted value, in other words the results of the regression analysis. + /// + /// The field in the index that contains the predicted value, in other words the results of the regression analysis. + /// /// public DataframeEvaluationRegressionDescriptor PredictedField(Expression> predictedField) { @@ -187,7 +207,9 @@ public DataframeEvaluationRegressionDescriptor() : base() private Elastic.Clients.Elasticsearch.Field PredictedFieldValue { get; set; } /// - /// The field of the index which contains the ground truth. The data type of this field must be numerical. + /// + /// The field of the index which contains the ground truth. The data type of this field must be numerical. + /// /// public DataframeEvaluationRegressionDescriptor ActualField(Elastic.Clients.Elasticsearch.Field actualField) { @@ -196,7 +218,9 @@ public DataframeEvaluationRegressionDescriptor ActualField(Elastic.Clients.Elast } /// - /// The field of the index which contains the ground truth. The data type of this field must be numerical. + /// + /// The field of the index which contains the ground truth. The data type of this field must be numerical. + /// /// public DataframeEvaluationRegressionDescriptor ActualField(Expression> actualField) { @@ -205,7 +229,9 @@ public DataframeEvaluationRegressionDescriptor ActualField(Ex } /// - /// The field of the index which contains the ground truth. The data type of this field must be numerical. + /// + /// The field of the index which contains the ground truth. The data type of this field must be numerical. + /// /// public DataframeEvaluationRegressionDescriptor ActualField(Expression> actualField) { @@ -214,7 +240,9 @@ public DataframeEvaluationRegressionDescriptor ActualField(Expression } /// - /// Specifies the metrics that are used for the evaluation. For more information on mse, msle, and huber, consult the Jupyter notebook on regression loss functions. + /// + /// Specifies the metrics that are used for the evaluation. For more information on mse, msle, and huber, consult the Jupyter notebook on regression loss functions. + /// /// public DataframeEvaluationRegressionDescriptor Metrics(Elastic.Clients.Elasticsearch.MachineLearning.DataframeEvaluationRegressionMetrics? metrics) { @@ -241,7 +269,9 @@ public DataframeEvaluationRegressionDescriptor Metrics(Action - /// The field in the index that contains the predicted value, in other words the results of the regression analysis. + /// + /// The field in the index that contains the predicted value, in other words the results of the regression analysis. + /// /// public DataframeEvaluationRegressionDescriptor PredictedField(Elastic.Clients.Elasticsearch.Field predictedField) { @@ -250,7 +280,9 @@ public DataframeEvaluationRegressionDescriptor PredictedField(Elastic.Clients.El } /// - /// The field in the index that contains the predicted value, in other words the results of the regression analysis. + /// + /// The field in the index that contains the predicted value, in other words the results of the regression analysis. + /// /// public DataframeEvaluationRegressionDescriptor PredictedField(Expression> predictedField) { @@ -259,7 +291,9 @@ public DataframeEvaluationRegressionDescriptor PredictedField } /// - /// The field in the index that contains the predicted value, in other words the results of the regression analysis. + /// + /// The field in the index that contains the predicted value, in other words the results of the regression analysis. + /// /// public DataframeEvaluationRegressionDescriptor PredictedField(Expression> predictedField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationRegressionMetrics.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationRegressionMetrics.g.cs index 9bd3e2f6931..b51e1bbb650 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationRegressionMetrics.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationRegressionMetrics.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DataframeEvaluationRegressionMetrics { /// - /// Pseudo Huber loss function. + /// + /// Pseudo Huber loss function. + /// /// [JsonInclude, JsonPropertyName("huber")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeEvaluationRegressionMetricsHuber? Huber { get; set; } /// - /// Average squared difference between the predicted values and the actual (ground truth) value. For more information, read this wiki article. + /// + /// Average squared difference between the predicted values and the actual (ground truth) value. For more information, read this wiki article. + /// /// [JsonInclude, JsonPropertyName("mse")] public IDictionary? Mse { get; set; } /// - /// Average squared difference between the logarithm of the predicted values and the logarithm of the actual (ground truth) value. + /// + /// Average squared difference between the logarithm of the predicted values and the logarithm of the actual (ground truth) value. + /// /// [JsonInclude, JsonPropertyName("msle")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeEvaluationRegressionMetricsMsle? Msle { get; set; } /// - /// Proportion of the variance in the dependent variable that is predictable from the independent variables. + /// + /// Proportion of the variance in the dependent variable that is predictable from the independent variables. + /// /// [JsonInclude, JsonPropertyName("r_squared")] public IDictionary? RSquared { get; set; } @@ -72,7 +80,9 @@ public DataframeEvaluationRegressionMetricsDescriptor() : base() private IDictionary? RSquaredValue { get; set; } /// - /// Pseudo Huber loss function. + /// + /// Pseudo Huber loss function. + /// /// public DataframeEvaluationRegressionMetricsDescriptor Huber(Elastic.Clients.Elasticsearch.MachineLearning.DataframeEvaluationRegressionMetricsHuber? huber) { @@ -99,7 +109,9 @@ public DataframeEvaluationRegressionMetricsDescriptor Huber(Action - /// Average squared difference between the predicted values and the actual (ground truth) value. For more information, read this wiki article. + /// + /// Average squared difference between the predicted values and the actual (ground truth) value. For more information, read this wiki article. + /// /// public DataframeEvaluationRegressionMetricsDescriptor Mse(Func, FluentDictionary> selector) { @@ -108,7 +120,9 @@ public DataframeEvaluationRegressionMetricsDescriptor Mse(Func - /// Average squared difference between the logarithm of the predicted values and the logarithm of the actual (ground truth) value. + /// + /// Average squared difference between the logarithm of the predicted values and the logarithm of the actual (ground truth) value. + /// /// public DataframeEvaluationRegressionMetricsDescriptor Msle(Elastic.Clients.Elasticsearch.MachineLearning.DataframeEvaluationRegressionMetricsMsle? msle) { @@ -135,7 +149,9 @@ public DataframeEvaluationRegressionMetricsDescriptor Msle(Action - /// Proportion of the variance in the dependent variable that is predictable from the independent variables. + /// + /// Proportion of the variance in the dependent variable that is predictable from the independent variables. + /// /// public DataframeEvaluationRegressionMetricsDescriptor RSquared(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationRegressionMetricsHuber.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationRegressionMetricsHuber.g.cs index ae3eb286196..6d769206db2 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationRegressionMetricsHuber.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationRegressionMetricsHuber.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DataframeEvaluationRegressionMetricsHuber { /// - /// Approximates 1/2 (prediction - actual)2 for values much less than delta and approximates a straight line with slope delta for values much larger than delta. Defaults to 1. Delta needs to be greater than 0. + /// + /// Approximates 1/2 (prediction - actual)2 for values much less than delta and approximates a straight line with slope delta for values much larger than delta. Defaults to 1. Delta needs to be greater than 0. + /// /// [JsonInclude, JsonPropertyName("delta")] public double? Delta { get; set; } @@ -47,7 +49,9 @@ public DataframeEvaluationRegressionMetricsHuberDescriptor() : base() private double? DeltaValue { get; set; } /// - /// Approximates 1/2 (prediction - actual)2 for values much less than delta and approximates a straight line with slope delta for values much larger than delta. Defaults to 1. Delta needs to be greater than 0. + /// + /// Approximates 1/2 (prediction - actual)2 for values much less than delta and approximates a straight line with slope delta for values much larger than delta. Defaults to 1. Delta needs to be greater than 0. + /// /// public DataframeEvaluationRegressionMetricsHuberDescriptor Delta(double? delta) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationRegressionMetricsMsle.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationRegressionMetricsMsle.g.cs index 2ec5941a541..6b8c57abcc7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationRegressionMetricsMsle.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeEvaluationRegressionMetricsMsle.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DataframeEvaluationRegressionMetricsMsle { /// - /// Defines the transition point at which you switch from minimizing quadratic error to minimizing quadratic log error. Defaults to 1. + /// + /// Defines the transition point at which you switch from minimizing quadratic error to minimizing quadratic log error. Defaults to 1. + /// /// [JsonInclude, JsonPropertyName("offset")] public double? Offset { get; set; } @@ -47,7 +49,9 @@ public DataframeEvaluationRegressionMetricsMsleDescriptor() : base() private double? OffsetValue { get; set; } /// - /// Defines the transition point at which you switch from minimizing quadratic error to minimizing quadratic log error. Defaults to 1. + /// + /// Defines the transition point at which you switch from minimizing quadratic error to minimizing quadratic log error. Defaults to 1. + /// /// public DataframeEvaluationRegressionMetricsMsleDescriptor Offset(double? offset) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeOutlierDetectionSummary.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeOutlierDetectionSummary.g.cs index d4fab44a979..aa926f5bca4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeOutlierDetectionSummary.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeOutlierDetectionSummary.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DataframeOutlierDetectionSummary { /// - /// The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. + /// + /// The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. + /// /// [JsonInclude, JsonPropertyName("auc_roc")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeEvaluationSummaryAucRoc? AucRoc { get; init; } /// - /// Set the different thresholds of the outlier score at where the metrics (`tp` - true positive, `fp` - false positive, `tn` - true negative, `fn` - false negative) are calculated. + /// + /// Set the different thresholds of the outlier score at where the metrics (tp - true positive, fp - false positive, tn - true negative, fn - false negative) are calculated. + /// /// [JsonInclude, JsonPropertyName("confusion_matrix")] public IReadOnlyDictionary? ConfusionMatrix { get; init; } /// - /// Set the different thresholds of the outlier score at where the metric is calculated. + /// + /// Set the different thresholds of the outlier score at where the metric is calculated. + /// /// [JsonInclude, JsonPropertyName("precision")] public IReadOnlyDictionary? Precision { get; init; } /// - /// Set the different thresholds of the outlier score at where the metric is calculated. + /// + /// Set the different thresholds of the outlier score at where the metric is calculated. + /// /// [JsonInclude, JsonPropertyName("recall")] public IReadOnlyDictionary? Recall { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeRegressionSummary.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeRegressionSummary.g.cs index fc4c98815ff..dc727132b26 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeRegressionSummary.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeRegressionSummary.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DataframeRegressionSummary { /// - /// Pseudo Huber loss function. + /// + /// Pseudo Huber loss function. + /// /// [JsonInclude, JsonPropertyName("huber")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeEvaluationValue? Huber { get; init; } /// - /// Average squared difference between the predicted values and the actual (`ground truth`) value. + /// + /// Average squared difference between the predicted values and the actual (ground truth) value. + /// /// [JsonInclude, JsonPropertyName("mse")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeEvaluationValue? Mse { get; init; } /// - /// Average squared difference between the logarithm of the predicted values and the logarithm of the actual (`ground truth`) value. + /// + /// Average squared difference between the logarithm of the predicted values and the logarithm of the actual (ground truth) value. + /// /// [JsonInclude, JsonPropertyName("msle")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeEvaluationValue? Msle { get; init; } /// - /// Proportion of the variance in the dependent variable that is predictable from the independent variables. + /// + /// Proportion of the variance in the dependent variable that is predictable from the independent variables. + /// /// [JsonInclude, JsonPropertyName("r_squared")] public Elastic.Clients.Elasticsearch.MachineLearning.DataframeEvaluationValue? RSquared { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Definition.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Definition.g.cs index 330d4d21bef..66f2ca47873 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Definition.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Definition.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class Definition { /// - /// Collection of preprocessors + /// + /// Collection of preprocessors + /// /// [JsonInclude, JsonPropertyName("preprocessors")] public ICollection? Preprocessors { get; set; } /// - /// The definition of the trained model. + /// + /// The definition of the trained model. + /// /// [JsonInclude, JsonPropertyName("trained_model")] public Elastic.Clients.Elasticsearch.MachineLearning.TrainedModel TrainedModel { get; set; } @@ -59,7 +63,9 @@ public DefinitionDescriptor() : base() private Action TrainedModelDescriptorAction { get; set; } /// - /// Collection of preprocessors + /// + /// Collection of preprocessors + /// /// public DefinitionDescriptor Preprocessors(ICollection? preprocessors) { @@ -98,7 +104,9 @@ public DefinitionDescriptor Preprocessors(params Action - /// The definition of the trained model. + /// + /// The definition of the trained model. + /// /// public DefinitionDescriptor TrainedModel(Elastic.Clients.Elasticsearch.MachineLearning.TrainedModel trainedModel) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DelayedDataCheckConfig.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DelayedDataCheckConfig.g.cs index 73bd7ef0845..d391e614ac7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DelayedDataCheckConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DelayedDataCheckConfig.g.cs @@ -30,13 +30,19 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DelayedDataCheckConfig { /// - /// The window of time that is searched for late data. This window of time ends with the latest finalized bucket.
It defaults to null, which causes an appropriate `check_window` to be calculated when the real-time datafeed runs.
In particular, the default `check_window` span calculation is based on the maximum of `2h` or `8 * bucket_span`. + /// + /// The window of time that is searched for late data. This window of time ends with the latest finalized bucket. + /// It defaults to null, which causes an appropriate check_window to be calculated when the real-time datafeed runs. + /// In particular, the default check_window span calculation is based on the maximum of 2h or 8 * bucket_span. + /// /// [JsonInclude, JsonPropertyName("check_window")] public Elastic.Clients.Elasticsearch.Duration? CheckWindow { get; set; } /// - /// Specifies whether the datafeed periodically checks for delayed data. + /// + /// Specifies whether the datafeed periodically checks for delayed data. + /// /// [JsonInclude, JsonPropertyName("enabled")] public bool Enabled { get; set; } @@ -54,7 +60,11 @@ public DelayedDataCheckConfigDescriptor() : base() private bool EnabledValue { get; set; } /// - /// The window of time that is searched for late data. This window of time ends with the latest finalized bucket.
It defaults to null, which causes an appropriate `check_window` to be calculated when the real-time datafeed runs.
In particular, the default `check_window` span calculation is based on the maximum of `2h` or `8 * bucket_span`. + /// + /// The window of time that is searched for late data. This window of time ends with the latest finalized bucket. + /// It defaults to null, which causes an appropriate check_window to be calculated when the real-time datafeed runs. + /// In particular, the default check_window span calculation is based on the maximum of 2h or 8 * bucket_span. + /// /// public DelayedDataCheckConfigDescriptor CheckWindow(Elastic.Clients.Elasticsearch.Duration? checkWindow) { @@ -63,7 +73,9 @@ public DelayedDataCheckConfigDescriptor CheckWindow(Elastic.Clients.Elasticsearc } /// - /// Specifies whether the datafeed periodically checks for delayed data. + /// + /// Specifies whether the datafeed periodically checks for delayed data. + /// /// public DelayedDataCheckConfigDescriptor Enabled(bool enabled = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DetectionRule.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DetectionRule.g.cs index 36edb40584d..2753259aa9e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DetectionRule.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DetectionRule.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DetectionRule { /// - /// The set of actions to be triggered when the rule applies. If more than one action is specified the effects of all actions are combined. + /// + /// The set of actions to be triggered when the rule applies. If more than one action is specified the effects of all actions are combined. + /// /// [JsonInclude, JsonPropertyName("actions")] public ICollection? Actions { get; set; } /// - /// An array of numeric conditions when the rule applies. A rule must either have a non-empty scope or at least one condition. Multiple conditions are combined together with a logical AND. + /// + /// An array of numeric conditions when the rule applies. A rule must either have a non-empty scope or at least one condition. Multiple conditions are combined together with a logical AND. + /// /// [JsonInclude, JsonPropertyName("conditions")] public ICollection? Conditions { get; set; } /// - /// A scope of series where the rule applies. A rule must either have a non-empty scope or at least one condition. By default, the scope includes all series. Scoping is allowed for any of the fields that are also specified in `by_field_name`, `over_field_name`, or `partition_field_name`. + /// + /// A scope of series where the rule applies. A rule must either have a non-empty scope or at least one condition. By default, the scope includes all series. Scoping is allowed for any of the fields that are also specified in by_field_name, over_field_name, or partition_field_name. + /// /// [JsonInclude, JsonPropertyName("scope")] public IDictionary? Scope { get; set; } @@ -64,7 +70,9 @@ public DetectionRuleDescriptor() : base() private IDictionary ScopeValue { get; set; } /// - /// The set of actions to be triggered when the rule applies. If more than one action is specified the effects of all actions are combined. + /// + /// The set of actions to be triggered when the rule applies. If more than one action is specified the effects of all actions are combined. + /// /// public DetectionRuleDescriptor Actions(ICollection? actions) { @@ -73,7 +81,9 @@ public DetectionRuleDescriptor Actions(ICollection - /// An array of numeric conditions when the rule applies. A rule must either have a non-empty scope or at least one condition. Multiple conditions are combined together with a logical AND. + /// + /// An array of numeric conditions when the rule applies. A rule must either have a non-empty scope or at least one condition. Multiple conditions are combined together with a logical AND. + /// /// public DetectionRuleDescriptor Conditions(ICollection? conditions) { @@ -112,7 +122,9 @@ public DetectionRuleDescriptor Conditions(params Action - /// A scope of series where the rule applies. A rule must either have a non-empty scope or at least one condition. By default, the scope includes all series. Scoping is allowed for any of the fields that are also specified in `by_field_name`, `over_field_name`, or `partition_field_name`. + /// + /// A scope of series where the rule applies. A rule must either have a non-empty scope or at least one condition. By default, the scope includes all series. Scoping is allowed for any of the fields that are also specified in by_field_name, over_field_name, or partition_field_name. + /// /// public DetectionRuleDescriptor Scope(Func, FluentDescriptorDictionary> selector) { @@ -186,7 +198,9 @@ public DetectionRuleDescriptor() : base() private IDictionary ScopeValue { get; set; } /// - /// The set of actions to be triggered when the rule applies. If more than one action is specified the effects of all actions are combined. + /// + /// The set of actions to be triggered when the rule applies. If more than one action is specified the effects of all actions are combined. + /// /// public DetectionRuleDescriptor Actions(ICollection? actions) { @@ -195,7 +209,9 @@ public DetectionRuleDescriptor Actions(ICollection - /// An array of numeric conditions when the rule applies. A rule must either have a non-empty scope or at least one condition. Multiple conditions are combined together with a logical AND. + /// + /// An array of numeric conditions when the rule applies. A rule must either have a non-empty scope or at least one condition. Multiple conditions are combined together with a logical AND. + /// /// public DetectionRuleDescriptor Conditions(ICollection? conditions) { @@ -234,7 +250,9 @@ public DetectionRuleDescriptor Conditions(params Action - /// A scope of series where the rule applies. A rule must either have a non-empty scope or at least one condition. By default, the scope includes all series. Scoping is allowed for any of the fields that are also specified in `by_field_name`, `over_field_name`, or `partition_field_name`. + /// + /// A scope of series where the rule applies. A rule must either have a non-empty scope or at least one condition. By default, the scope includes all series. Scoping is allowed for any of the fields that are also specified in by_field_name, over_field_name, or partition_field_name. + /// /// public DetectionRuleDescriptor Scope(Func, FluentDescriptorDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Detector.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Detector.g.cs index ac2bcabca56..82ad7bed40d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Detector.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Detector.g.cs @@ -30,61 +30,81 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class Detector { /// - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// /// [JsonInclude, JsonPropertyName("by_field_name")] public Elastic.Clients.Elasticsearch.Field? ByFieldName { get; set; } /// - /// Custom rules enable you to customize the way detectors operate. For example, a rule may dictate conditions under which results should be skipped. Kibana refers to custom rules as job rules. + /// + /// Custom rules enable you to customize the way detectors operate. For example, a rule may dictate conditions under which results should be skipped. Kibana refers to custom rules as job rules. + /// /// [JsonInclude, JsonPropertyName("custom_rules")] public ICollection? CustomRules { get; set; } /// - /// A description of the detector. + /// + /// A description of the detector. + /// /// [JsonInclude, JsonPropertyName("detector_description")] public string? DetectorDescription { get; set; } /// - /// A unique identifier for the detector. This identifier is based on the order of the detectors in the `analysis_config`, starting at zero. If you specify a value for this property, it is ignored. + /// + /// A unique identifier for the detector. This identifier is based on the order of the detectors in the analysis_config, starting at zero. If you specify a value for this property, it is ignored. + /// /// [JsonInclude, JsonPropertyName("detector_index")] public int? DetectorIndex { get; set; } /// - /// If set, frequent entities are excluded from influencing the anomaly results. Entities can be considered frequent over time or frequent in a population. If you are working with both over and by fields, you can set `exclude_frequent` to `all` for both fields, or to `by` or `over` for those specific fields. + /// + /// If set, frequent entities are excluded from influencing the anomaly results. Entities can be considered frequent over time or frequent in a population. If you are working with both over and by fields, you can set exclude_frequent to all for both fields, or to by or over for those specific fields. + /// /// [JsonInclude, JsonPropertyName("exclude_frequent")] public Elastic.Clients.Elasticsearch.MachineLearning.ExcludeFrequent? ExcludeFrequent { get; set; } /// - /// The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The `field_name` cannot contain double quotes or backslashes. + /// + /// The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The field_name cannot contain double quotes or backslashes. + /// /// [JsonInclude, JsonPropertyName("field_name")] public Elastic.Clients.Elasticsearch.Field? FieldName { get; set; } /// - /// The analysis function that is used. For example, `count`, `rare`, `mean`, `min`, `max`, or `sum`. + /// + /// The analysis function that is used. For example, count, rare, mean, min, max, or sum. + /// /// [JsonInclude, JsonPropertyName("function")] public string? Function { get; set; } /// - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// /// [JsonInclude, JsonPropertyName("over_field_name")] public Elastic.Clients.Elasticsearch.Field? OverFieldName { get; set; } /// - /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// + /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// /// [JsonInclude, JsonPropertyName("partition_field_name")] public Elastic.Clients.Elasticsearch.Field? PartitionFieldName { get; set; } /// - /// Defines whether a new series is used as the null series when there is no value for the by or partition fields. + /// + /// Defines whether a new series is used as the null series when there is no value for the by or partition fields. + /// /// [JsonInclude, JsonPropertyName("use_null")] public bool? UseNull { get; set; } @@ -113,7 +133,9 @@ public DetectorDescriptor() : base() private bool? UseNullValue { get; set; } /// - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// /// public DetectorDescriptor ByFieldName(Elastic.Clients.Elasticsearch.Field? byFieldName) { @@ -122,7 +144,9 @@ public DetectorDescriptor ByFieldName(Elastic.Clients.Elasticsearch.F } /// - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// /// public DetectorDescriptor ByFieldName(Expression> byFieldName) { @@ -131,7 +155,9 @@ public DetectorDescriptor ByFieldName(Expression - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// /// public DetectorDescriptor ByFieldName(Expression> byFieldName) { @@ -140,7 +166,9 @@ public DetectorDescriptor ByFieldName(Expression - /// Custom rules enable you to customize the way detectors operate. For example, a rule may dictate conditions under which results should be skipped. Kibana refers to custom rules as job rules. + /// + /// Custom rules enable you to customize the way detectors operate. For example, a rule may dictate conditions under which results should be skipped. Kibana refers to custom rules as job rules. + /// /// public DetectorDescriptor CustomRules(ICollection? customRules) { @@ -179,7 +207,9 @@ public DetectorDescriptor CustomRules(params Action - /// A description of the detector. + /// + /// A description of the detector. + /// /// public DetectorDescriptor DetectorDescription(string? detectorDescription) { @@ -188,7 +218,9 @@ public DetectorDescriptor DetectorDescription(string? detectorDescrip } /// - /// A unique identifier for the detector. This identifier is based on the order of the detectors in the `analysis_config`, starting at zero. If you specify a value for this property, it is ignored. + /// + /// A unique identifier for the detector. This identifier is based on the order of the detectors in the analysis_config, starting at zero. If you specify a value for this property, it is ignored. + /// /// public DetectorDescriptor DetectorIndex(int? detectorIndex) { @@ -197,7 +229,9 @@ public DetectorDescriptor DetectorIndex(int? detectorIndex) } /// - /// If set, frequent entities are excluded from influencing the anomaly results. Entities can be considered frequent over time or frequent in a population. If you are working with both over and by fields, you can set `exclude_frequent` to `all` for both fields, or to `by` or `over` for those specific fields. + /// + /// If set, frequent entities are excluded from influencing the anomaly results. Entities can be considered frequent over time or frequent in a population. If you are working with both over and by fields, you can set exclude_frequent to all for both fields, or to by or over for those specific fields. + /// /// public DetectorDescriptor ExcludeFrequent(Elastic.Clients.Elasticsearch.MachineLearning.ExcludeFrequent? excludeFrequent) { @@ -206,7 +240,9 @@ public DetectorDescriptor ExcludeFrequent(Elastic.Clients.Elasticsear } /// - /// The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The `field_name` cannot contain double quotes or backslashes. + /// + /// The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The field_name cannot contain double quotes or backslashes. + /// /// public DetectorDescriptor FieldName(Elastic.Clients.Elasticsearch.Field? fieldName) { @@ -215,7 +251,9 @@ public DetectorDescriptor FieldName(Elastic.Clients.Elasticsearch.Fie } /// - /// The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The `field_name` cannot contain double quotes or backslashes. + /// + /// The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The field_name cannot contain double quotes or backslashes. + /// /// public DetectorDescriptor FieldName(Expression> fieldName) { @@ -224,7 +262,9 @@ public DetectorDescriptor FieldName(Expression - /// The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The `field_name` cannot contain double quotes or backslashes. + /// + /// The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The field_name cannot contain double quotes or backslashes. + /// /// public DetectorDescriptor FieldName(Expression> fieldName) { @@ -233,7 +273,9 @@ public DetectorDescriptor FieldName(Expression - /// The analysis function that is used. For example, `count`, `rare`, `mean`, `min`, `max`, or `sum`. + /// + /// The analysis function that is used. For example, count, rare, mean, min, max, or sum. + /// /// public DetectorDescriptor Function(string? function) { @@ -242,7 +284,9 @@ public DetectorDescriptor Function(string? function) } /// - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// /// public DetectorDescriptor OverFieldName(Elastic.Clients.Elasticsearch.Field? overFieldName) { @@ -251,7 +295,9 @@ public DetectorDescriptor OverFieldName(Elastic.Clients.Elasticsearch } /// - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// /// public DetectorDescriptor OverFieldName(Expression> overFieldName) { @@ -260,7 +306,9 @@ public DetectorDescriptor OverFieldName(Expression - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// /// public DetectorDescriptor OverFieldName(Expression> overFieldName) { @@ -269,7 +317,9 @@ public DetectorDescriptor OverFieldName(Expression - /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// + /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// /// public DetectorDescriptor PartitionFieldName(Elastic.Clients.Elasticsearch.Field? partitionFieldName) { @@ -278,7 +328,9 @@ public DetectorDescriptor PartitionFieldName(Elastic.Clients.Elastics } /// - /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// + /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// /// public DetectorDescriptor PartitionFieldName(Expression> partitionFieldName) { @@ -287,7 +339,9 @@ public DetectorDescriptor PartitionFieldName(Expression - /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// + /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// /// public DetectorDescriptor PartitionFieldName(Expression> partitionFieldName) { @@ -296,7 +350,9 @@ public DetectorDescriptor PartitionFieldName(Expression - /// Defines whether a new series is used as the null series when there is no value for the by or partition fields. + /// + /// Defines whether a new series is used as the null series when there is no value for the by or partition fields. + /// /// public DetectorDescriptor UseNull(bool? useNull = true) { @@ -419,7 +475,9 @@ public DetectorDescriptor() : base() private bool? UseNullValue { get; set; } /// - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// /// public DetectorDescriptor ByFieldName(Elastic.Clients.Elasticsearch.Field? byFieldName) { @@ -428,7 +486,9 @@ public DetectorDescriptor ByFieldName(Elastic.Clients.Elasticsearch.Field? byFie } /// - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// /// public DetectorDescriptor ByFieldName(Expression> byFieldName) { @@ -437,7 +497,9 @@ public DetectorDescriptor ByFieldName(Expression - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. + /// /// public DetectorDescriptor ByFieldName(Expression> byFieldName) { @@ -446,7 +508,9 @@ public DetectorDescriptor ByFieldName(Expression - /// Custom rules enable you to customize the way detectors operate. For example, a rule may dictate conditions under which results should be skipped. Kibana refers to custom rules as job rules. + /// + /// Custom rules enable you to customize the way detectors operate. For example, a rule may dictate conditions under which results should be skipped. Kibana refers to custom rules as job rules. + /// /// public DetectorDescriptor CustomRules(ICollection? customRules) { @@ -485,7 +549,9 @@ public DetectorDescriptor CustomRules(params Action - /// A description of the detector. + /// + /// A description of the detector. + /// /// public DetectorDescriptor DetectorDescription(string? detectorDescription) { @@ -494,7 +560,9 @@ public DetectorDescriptor DetectorDescription(string? detectorDescription) } /// - /// A unique identifier for the detector. This identifier is based on the order of the detectors in the `analysis_config`, starting at zero. If you specify a value for this property, it is ignored. + /// + /// A unique identifier for the detector. This identifier is based on the order of the detectors in the analysis_config, starting at zero. If you specify a value for this property, it is ignored. + /// /// public DetectorDescriptor DetectorIndex(int? detectorIndex) { @@ -503,7 +571,9 @@ public DetectorDescriptor DetectorIndex(int? detectorIndex) } /// - /// If set, frequent entities are excluded from influencing the anomaly results. Entities can be considered frequent over time or frequent in a population. If you are working with both over and by fields, you can set `exclude_frequent` to `all` for both fields, or to `by` or `over` for those specific fields. + /// + /// If set, frequent entities are excluded from influencing the anomaly results. Entities can be considered frequent over time or frequent in a population. If you are working with both over and by fields, you can set exclude_frequent to all for both fields, or to by or over for those specific fields. + /// /// public DetectorDescriptor ExcludeFrequent(Elastic.Clients.Elasticsearch.MachineLearning.ExcludeFrequent? excludeFrequent) { @@ -512,7 +582,9 @@ public DetectorDescriptor ExcludeFrequent(Elastic.Clients.Elasticsearch.MachineL } /// - /// The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The `field_name` cannot contain double quotes or backslashes. + /// + /// The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The field_name cannot contain double quotes or backslashes. + /// /// public DetectorDescriptor FieldName(Elastic.Clients.Elasticsearch.Field? fieldName) { @@ -521,7 +593,9 @@ public DetectorDescriptor FieldName(Elastic.Clients.Elasticsearch.Field? fieldNa } /// - /// The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The `field_name` cannot contain double quotes or backslashes. + /// + /// The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The field_name cannot contain double quotes or backslashes. + /// /// public DetectorDescriptor FieldName(Expression> fieldName) { @@ -530,7 +604,9 @@ public DetectorDescriptor FieldName(Expression - /// The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The `field_name` cannot contain double quotes or backslashes. + /// + /// The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The field_name cannot contain double quotes or backslashes. + /// /// public DetectorDescriptor FieldName(Expression> fieldName) { @@ -539,7 +615,9 @@ public DetectorDescriptor FieldName(Expression - /// The analysis function that is used. For example, `count`, `rare`, `mean`, `min`, `max`, or `sum`. + /// + /// The analysis function that is used. For example, count, rare, mean, min, max, or sum. + /// /// public DetectorDescriptor Function(string? function) { @@ -548,7 +626,9 @@ public DetectorDescriptor Function(string? function) } /// - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// /// public DetectorDescriptor OverFieldName(Elastic.Clients.Elasticsearch.Field? overFieldName) { @@ -557,7 +637,9 @@ public DetectorDescriptor OverFieldName(Elastic.Clients.Elasticsearch.Field? ove } /// - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// /// public DetectorDescriptor OverFieldName(Expression> overFieldName) { @@ -566,7 +648,9 @@ public DetectorDescriptor OverFieldName(Expression - /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// + /// The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. + /// /// public DetectorDescriptor OverFieldName(Expression> overFieldName) { @@ -575,7 +659,9 @@ public DetectorDescriptor OverFieldName(Expression - /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// + /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// /// public DetectorDescriptor PartitionFieldName(Elastic.Clients.Elasticsearch.Field? partitionFieldName) { @@ -584,7 +670,9 @@ public DetectorDescriptor PartitionFieldName(Elastic.Clients.Elasticsearch.Field } /// - /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// + /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// /// public DetectorDescriptor PartitionFieldName(Expression> partitionFieldName) { @@ -593,7 +681,9 @@ public DetectorDescriptor PartitionFieldName(Expression - /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// + /// The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. + /// /// public DetectorDescriptor PartitionFieldName(Expression> partitionFieldName) { @@ -602,7 +692,9 @@ public DetectorDescriptor PartitionFieldName(Expression - /// Defines whether a new series is used as the null series when there is no value for the by or partition fields. + /// + /// Defines whether a new series is used as the null series when there is no value for the by or partition fields. + /// /// public DetectorDescriptor UseNull(bool? useNull = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DetectorRead.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DetectorRead.g.cs index df4105bd1a8..fb201c57572 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DetectorRead.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DetectorRead.g.cs @@ -30,61 +30,94 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class DetectorRead { /// - /// The field used to split the data.
In particular, this property is used for analyzing the splits with respect to their own history.
It is used for finding unusual values in the context of the split. + /// + /// The field used to split the data. + /// In particular, this property is used for analyzing the splits with respect to their own history. + /// It is used for finding unusual values in the context of the split. + /// /// [JsonInclude, JsonPropertyName("by_field_name")] public string? ByFieldName { get; init; } /// - /// An array of custom rule objects, which enable you to customize the way detectors operate.
For example, a rule may dictate to the detector conditions under which results should be skipped.
Kibana refers to custom rules as job rules. + /// + /// An array of custom rule objects, which enable you to customize the way detectors operate. + /// For example, a rule may dictate to the detector conditions under which results should be skipped. + /// Kibana refers to custom rules as job rules. + /// /// [JsonInclude, JsonPropertyName("custom_rules")] public IReadOnlyCollection? CustomRules { get; init; } /// - /// A description of the detector. + /// + /// A description of the detector. + /// /// [JsonInclude, JsonPropertyName("detector_description")] public string? DetectorDescription { get; init; } /// - /// A unique identifier for the detector.
This identifier is based on the order of the detectors in the `analysis_config`, starting at zero. + /// + /// A unique identifier for the detector. + /// This identifier is based on the order of the detectors in the analysis_config, starting at zero. + /// /// [JsonInclude, JsonPropertyName("detector_index")] public int? DetectorIndex { get; init; } /// - /// Contains one of the following values: `all`, `none`, `by`, or `over`.
If set, frequent entities are excluded from influencing the anomaly results.
Entities can be considered frequent over time or frequent in a population.
If you are working with both over and by fields, then you can set `exclude_frequent` to all for both fields, or to `by` or `over` for those specific fields. + /// + /// Contains one of the following values: all, none, by, or over. + /// If set, frequent entities are excluded from influencing the anomaly results. + /// Entities can be considered frequent over time or frequent in a population. + /// If you are working with both over and by fields, then you can set exclude_frequent to all for both fields, or to by or over for those specific fields. + /// /// [JsonInclude, JsonPropertyName("exclude_frequent")] public Elastic.Clients.Elasticsearch.MachineLearning.ExcludeFrequent? ExcludeFrequent { get; init; } /// - /// The field that the detector uses in the function.
If you use an event rate function such as `count` or `rare`, do not specify this field. + /// + /// The field that the detector uses in the function. + /// If you use an event rate function such as count or rare, do not specify this field. + /// /// [JsonInclude, JsonPropertyName("field_name")] public string? FieldName { get; init; } /// - /// The analysis function that is used.
For example, `count`, `rare`, `mean`, `min`, `max`, and `sum`. + /// + /// The analysis function that is used. + /// For example, count, rare, mean, min, max, and sum. + /// /// [JsonInclude, JsonPropertyName("function")] public string Function { get; init; } /// - /// The field used to split the data.
In particular, this property is used for analyzing the splits with respect to the history of all splits.
It is used for finding unusual values in the population of all splits. + /// + /// The field used to split the data. + /// In particular, this property is used for analyzing the splits with respect to the history of all splits. + /// It is used for finding unusual values in the population of all splits. + /// /// [JsonInclude, JsonPropertyName("over_field_name")] public string? OverFieldName { get; init; } /// - /// The field used to segment the analysis.
When you use this property, you have completely independent baselines for each value of this field. + /// + /// The field used to segment the analysis. + /// When you use this property, you have completely independent baselines for each value of this field. + /// /// [JsonInclude, JsonPropertyName("partition_field_name")] public string? PartitionFieldName { get; init; } /// - /// Defines whether a new series is used as the null series when there is no value for the by or partition fields. + /// + /// Defines whether a new series is used as the null series when there is no value for the by or partition fields. + /// /// [JsonInclude, JsonPropertyName("use_null")] public bool? UseNull { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/FillMaskInferenceOptions.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/FillMaskInferenceOptions.g.cs index 6cbace7f11a..c0ee3c334ae 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/FillMaskInferenceOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/FillMaskInferenceOptions.g.cs @@ -28,30 +28,44 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; /// -/// Fill mask inference options +/// +/// Fill mask inference options +/// /// public sealed partial class FillMaskInferenceOptions { /// - /// The string/token which will be removed from incoming documents and replaced with the inference prediction(s).
In a response, this field contains the mask token for the specified model/tokenizer. Each model and tokenizer
has a predefined mask token which cannot be changed. Thus, it is recommended not to set this value in requests.
However, if this field is present in a request, its value must match the predefined value for that model/tokenizer,
otherwise the request will fail. + /// + /// The string/token which will be removed from incoming documents and replaced with the inference prediction(s). + /// In a response, this field contains the mask token for the specified model/tokenizer. Each model and tokenizer + /// has a predefined mask token which cannot be changed. Thus, it is recommended not to set this value in requests. + /// However, if this field is present in a request, its value must match the predefined value for that model/tokenizer, + /// otherwise the request will fail. + /// /// [JsonInclude, JsonPropertyName("mask_token")] public string? MaskToken { get; set; } /// - /// Specifies the number of top class predictions to return. Defaults to 0. + /// + /// Specifies the number of top class predictions to return. Defaults to 0. + /// /// [JsonInclude, JsonPropertyName("num_top_classes")] public int? NumTopClasses { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.MachineLearning.TokenizationConfig? Tokenization { get; set; } @@ -60,7 +74,9 @@ public sealed partial class FillMaskInferenceOptions } /// -/// Fill mask inference options +/// +/// Fill mask inference options +/// /// public sealed partial class FillMaskInferenceOptionsDescriptor : SerializableDescriptor { @@ -78,7 +94,13 @@ public FillMaskInferenceOptionsDescriptor() : base() private Action TokenizationDescriptorAction { get; set; } /// - /// The string/token which will be removed from incoming documents and replaced with the inference prediction(s).
In a response, this field contains the mask token for the specified model/tokenizer. Each model and tokenizer
has a predefined mask token which cannot be changed. Thus, it is recommended not to set this value in requests.
However, if this field is present in a request, its value must match the predefined value for that model/tokenizer,
otherwise the request will fail. + /// + /// The string/token which will be removed from incoming documents and replaced with the inference prediction(s). + /// In a response, this field contains the mask token for the specified model/tokenizer. Each model and tokenizer + /// has a predefined mask token which cannot be changed. Thus, it is recommended not to set this value in requests. + /// However, if this field is present in a request, its value must match the predefined value for that model/tokenizer, + /// otherwise the request will fail. + /// /// public FillMaskInferenceOptionsDescriptor MaskToken(string? maskToken) { @@ -87,7 +109,9 @@ public FillMaskInferenceOptionsDescriptor MaskToken(string? maskToken) } /// - /// Specifies the number of top class predictions to return. Defaults to 0. + /// + /// Specifies the number of top class predictions to return. Defaults to 0. + /// /// public FillMaskInferenceOptionsDescriptor NumTopClasses(int? numTopClasses) { @@ -96,7 +120,9 @@ public FillMaskInferenceOptionsDescriptor NumTopClasses(int? numTopClasses) } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public FillMaskInferenceOptionsDescriptor ResultsField(string? resultsField) { @@ -105,7 +131,9 @@ public FillMaskInferenceOptionsDescriptor ResultsField(string? resultsField) } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// public FillMaskInferenceOptionsDescriptor Tokenization(Elastic.Clients.Elasticsearch.MachineLearning.TokenizationConfig? tokenization) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/FillMaskInferenceUpdateOptions.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/FillMaskInferenceUpdateOptions.g.cs index 380bfdf6d12..d1664f2c7f0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/FillMaskInferenceUpdateOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/FillMaskInferenceUpdateOptions.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class FillMaskInferenceUpdateOptions { /// - /// Specifies the number of top class predictions to return. Defaults to 0. + /// + /// Specifies the number of top class predictions to return. Defaults to 0. + /// /// [JsonInclude, JsonPropertyName("num_top_classes")] public int? NumTopClasses { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.MachineLearning.NlpTokenizationUpdateOptions? Tokenization { get; set; } @@ -65,7 +71,9 @@ public FillMaskInferenceUpdateOptionsDescriptor() : base() private Action TokenizationDescriptorAction { get; set; } /// - /// Specifies the number of top class predictions to return. Defaults to 0. + /// + /// Specifies the number of top class predictions to return. Defaults to 0. + /// /// public FillMaskInferenceUpdateOptionsDescriptor NumTopClasses(int? numTopClasses) { @@ -74,7 +82,9 @@ public FillMaskInferenceUpdateOptionsDescriptor NumTopClasses(int? numTopClasses } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public FillMaskInferenceUpdateOptionsDescriptor ResultsField(string? resultsField) { @@ -83,7 +93,9 @@ public FillMaskInferenceUpdateOptionsDescriptor ResultsField(string? resultsFiel } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// public FillMaskInferenceUpdateOptionsDescriptor Tokenization(Elastic.Clients.Elasticsearch.MachineLearning.NlpTokenizationUpdateOptions? tokenization) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Filter.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Filter.g.cs index b39c33320bb..a998d01f78e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Filter.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Filter.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class Filter { /// - /// A description of the filter. + /// + /// A description of the filter. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; init; } /// - /// A string that uniquely identifies a filter. + /// + /// A string that uniquely identifies a filter. + /// /// [JsonInclude, JsonPropertyName("filter_id")] public string FilterId { get; init; } /// - /// An array of strings which is the filter item list. + /// + /// An array of strings which is the filter item list. + /// /// [JsonInclude, JsonPropertyName("items")] public IReadOnlyCollection Items { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/FilterRef.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/FilterRef.g.cs index 3e9f06271c7..b5dd20cc056 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/FilterRef.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/FilterRef.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class FilterRef { /// - /// The identifier for the filter. + /// + /// The identifier for the filter. + /// /// [JsonInclude, JsonPropertyName("filter_id")] public Elastic.Clients.Elasticsearch.Id FilterId { get; set; } /// - /// If set to `include`, the rule applies for values in the filter. If set to `exclude`, the rule applies for values not in the filter. + /// + /// If set to include, the rule applies for values in the filter. If set to exclude, the rule applies for values not in the filter. + /// /// [JsonInclude, JsonPropertyName("filter_type")] public Elastic.Clients.Elasticsearch.MachineLearning.FilterType? FilterType { get; set; } @@ -54,7 +58,9 @@ public FilterRefDescriptor() : base() private Elastic.Clients.Elasticsearch.MachineLearning.FilterType? FilterTypeValue { get; set; } /// - /// The identifier for the filter. + /// + /// The identifier for the filter. + /// /// public FilterRefDescriptor FilterId(Elastic.Clients.Elasticsearch.Id filterId) { @@ -63,7 +69,9 @@ public FilterRefDescriptor FilterId(Elastic.Clients.Elasticsearch.Id filterId) } /// - /// If set to `include`, the rule applies for values in the filter. If set to `exclude`, the rule applies for values not in the filter. + /// + /// If set to include, the rule applies for values in the filter. If set to exclude, the rule applies for values not in the filter. + /// /// public FilterRefDescriptor FilterType(Elastic.Clients.Elasticsearch.MachineLearning.FilterType? filterType) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/GeoResults.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/GeoResults.g.cs index ad19f50aff6..f3edb0a1949 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/GeoResults.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/GeoResults.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class GeoResults { /// - /// The actual value for the bucket formatted as a `geo_point`. + /// + /// The actual value for the bucket formatted as a geo_point. + /// /// [JsonInclude, JsonPropertyName("actual_point")] public string ActualPoint { get; init; } /// - /// The typical value for the bucket formatted as a `geo_point`. + /// + /// The typical value for the bucket formatted as a geo_point. + /// /// [JsonInclude, JsonPropertyName("typical_point")] public string TypicalPoint { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Hyperparameter.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Hyperparameter.g.cs index 16ed21a5221..dbb7f9071db 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Hyperparameter.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Hyperparameter.g.cs @@ -30,31 +30,41 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class Hyperparameter { /// - /// A positive number showing how much the parameter influences the variation of the loss function. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization. + /// + /// A positive number showing how much the parameter influences the variation of the loss function. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization. + /// /// [JsonInclude, JsonPropertyName("absolute_importance")] public double? AbsoluteImportance { get; init; } /// - /// Name of the hyperparameter. + /// + /// Name of the hyperparameter. + /// /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } /// - /// A number between 0 and 1 showing the proportion of influence on the variation of the loss function among all tuned hyperparameters. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization. + /// + /// A number between 0 and 1 showing the proportion of influence on the variation of the loss function among all tuned hyperparameters. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization. + /// /// [JsonInclude, JsonPropertyName("relative_importance")] public double? RelativeImportance { get; init; } /// - /// Indicates if the hyperparameter is specified by the user (true) or optimized (false). + /// + /// Indicates if the hyperparameter is specified by the user (true) or optimized (false). + /// /// [JsonInclude, JsonPropertyName("supplied")] public bool Supplied { get; init; } /// - /// The value of the hyperparameter, either optimized or specified by the user. + /// + /// The value of the hyperparameter, either optimized or specified by the user. + /// /// [JsonInclude, JsonPropertyName("value")] public double Value { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/InferenceConfigCreate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/InferenceConfigCreate.g.cs index 6f5ec39feb7..7521192e9fc 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/InferenceConfigCreate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/InferenceConfigCreate.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; /// -/// Inference configuration provided when storing the model config +/// +/// Inference configuration provided when storing the model config +/// /// [JsonConverter(typeof(InferenceConfigCreateConverter))] public sealed partial class InferenceConfigCreate diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/InferenceResponseResult.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/InferenceResponseResult.g.cs index eebe075625e..afa959c72f1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/InferenceResponseResult.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/InferenceResponseResult.g.cs @@ -30,56 +30,84 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class InferenceResponseResult { /// - /// If the model is trained for named entity recognition (NER) tasks, the response contains the recognized entities. + /// + /// If the model is trained for named entity recognition (NER) tasks, the response contains the recognized entities. + /// /// [JsonInclude, JsonPropertyName("entities")] public IReadOnlyCollection? Entities { get; init; } /// - /// The feature importance for the inference results. Relevant only for classification or regression models + /// + /// The feature importance for the inference results. Relevant only for classification or regression models + /// /// [JsonInclude, JsonPropertyName("feature_importance")] public IReadOnlyCollection? FeatureImportance { get; init; } /// - /// Indicates whether the input text was truncated to meet the model's maximum sequence length limit. This property
is present only when it is true. + /// + /// Indicates whether the input text was truncated to meet the model's maximum sequence length limit. This property + /// is present only when it is true. + /// /// [JsonInclude, JsonPropertyName("is_truncated")] public bool? IsTruncated { get; init; } /// - /// If the model is trained for a text classification or zero shot classification task, the response is the
predicted class.
For named entity recognition (NER) tasks, it contains the annotated text output.
For fill mask tasks, it contains the top prediction for replacing the mask token.
For text embedding tasks, it contains the raw numerical text embedding values.
For regression models, its a numerical value
For classification models, it may be an integer, double, boolean or string depending on prediction type + /// + /// If the model is trained for a text classification or zero shot classification task, the response is the + /// predicted class. + /// For named entity recognition (NER) tasks, it contains the annotated text output. + /// For fill mask tasks, it contains the top prediction for replacing the mask token. + /// For text embedding tasks, it contains the raw numerical text embedding values. + /// For regression models, its a numerical value + /// For classification models, it may be an integer, double, boolean or string depending on prediction type + /// /// [JsonInclude, JsonPropertyName("predicted_value")] [SingleOrManyCollectionConverter(typeof(object))] public IReadOnlyCollection? PredictedValue { get; init; } /// - /// For fill mask tasks, the response contains the input text sequence with the mask token replaced by the predicted
value.
Additionally + /// + /// For fill mask tasks, the response contains the input text sequence with the mask token replaced by the predicted + /// value. + /// Additionally + /// /// [JsonInclude, JsonPropertyName("predicted_value_sequence")] public string? PredictedValueSequence { get; init; } /// - /// Specifies a probability for the predicted value. + /// + /// Specifies a probability for the predicted value. + /// /// [JsonInclude, JsonPropertyName("prediction_probability")] public double? PredictionProbability { get; init; } /// - /// Specifies a confidence score for the predicted value. + /// + /// Specifies a confidence score for the predicted value. + /// /// [JsonInclude, JsonPropertyName("prediction_score")] public double? PredictionScore { get; init; } /// - /// For fill mask, text classification, and zero shot classification tasks, the response contains a list of top
class entries. + /// + /// For fill mask, text classification, and zero shot classification tasks, the response contains a list of top + /// class entries. + /// /// [JsonInclude, JsonPropertyName("top_classes")] public IReadOnlyCollection? TopClasses { get; init; } /// - /// If the request failed, the response contains the reason for the failure. + /// + /// If the request failed, the response contains the reason for the failure. + /// /// [JsonInclude, JsonPropertyName("warning")] public string? Warning { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Influencer.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Influencer.g.cs index 913a137812c..cb85dcef0e6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Influencer.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Influencer.g.cs @@ -30,67 +30,96 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class Influencer { /// - /// The length of the bucket in seconds. This value matches the bucket span that is specified in the job. + /// + /// The length of the bucket in seconds. This value matches the bucket span that is specified in the job. + /// /// [JsonInclude, JsonPropertyName("bucket_span")] public long BucketSpan { get; init; } /// - /// Additional influencer properties are added, depending on the fields being analyzed. For example, if it’s
analyzing `user_name` as an influencer, a field `user_name` is added to the result document. This
information enables you to filter the anomaly results more easily. + /// + /// Additional influencer properties are added, depending on the fields being analyzed. For example, if it’s + /// analyzing user_name as an influencer, a field user_name is added to the result document. This + /// information enables you to filter the anomaly results more easily. + /// /// [JsonInclude, JsonPropertyName("foo")] public string? Foo { get; init; } /// - /// The field name of the influencer. + /// + /// The field name of the influencer. + /// /// [JsonInclude, JsonPropertyName("influencer_field_name")] public string InfluencerFieldName { get; init; } /// - /// The entity that influenced, contributed to, or was to blame for the anomaly. + /// + /// The entity that influenced, contributed to, or was to blame for the anomaly. + /// /// [JsonInclude, JsonPropertyName("influencer_field_value")] public string InfluencerFieldValue { get; init; } /// - /// A normalized score between 0-100, which is based on the probability of the influencer in this bucket aggregated
across detectors. Unlike `initial_influencer_score`, this value is updated by a re-normalization process as new
data is analyzed. + /// + /// A normalized score between 0-100, which is based on the probability of the influencer in this bucket aggregated + /// across detectors. Unlike initial_influencer_score, this value is updated by a re-normalization process as new + /// data is analyzed. + /// /// [JsonInclude, JsonPropertyName("influencer_score")] public double InfluencerScore { get; init; } /// - /// A normalized score between 0-100, which is based on the probability of the influencer aggregated across detectors.
This is the initial value that was calculated at the time the bucket was processed. + /// + /// A normalized score between 0-100, which is based on the probability of the influencer aggregated across detectors. + /// This is the initial value that was calculated at the time the bucket was processed. + /// /// [JsonInclude, JsonPropertyName("initial_influencer_score")] public double InitialInfluencerScore { get; init; } /// - /// If true, this is an interim result. In other words, the results are calculated based on partial input data. + /// + /// If true, this is an interim result. In other words, the results are calculated based on partial input data. + /// /// [JsonInclude, JsonPropertyName("is_interim")] public bool IsInterim { get; init; } /// - /// Identifier for the anomaly detection job. + /// + /// Identifier for the anomaly detection job. + /// /// [JsonInclude, JsonPropertyName("job_id")] public string JobId { get; init; } /// - /// The probability that the influencer has this behavior, in the range 0 to 1. This value can be held to a high
precision of over 300 decimal places, so the `influencer_score` is provided as a human-readable and friendly
interpretation of this value. + /// + /// The probability that the influencer has this behavior, in the range 0 to 1. This value can be held to a high + /// precision of over 300 decimal places, so the influencer_score is provided as a human-readable and friendly + /// interpretation of this value. + /// /// [JsonInclude, JsonPropertyName("probability")] public double Probability { get; init; } /// - /// Internal. This value is always set to `influencer`. + /// + /// Internal. This value is always set to influencer. + /// /// [JsonInclude, JsonPropertyName("result_type")] public string ResultType { get; init; } /// - /// The start time of the bucket for which these results were calculated. + /// + /// The start time of the bucket for which these results were calculated. + /// /// [JsonInclude, JsonPropertyName("timestamp")] public long Timestamp { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Job.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Job.g.cs index 95686e9bcac..2c4568b96af 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Job.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Job.g.cs @@ -30,25 +30,40 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class Job { /// - /// Advanced configuration option.
Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. + /// + /// Advanced configuration option. + /// Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. + /// /// [JsonInclude, JsonPropertyName("allow_lazy_open")] public bool AllowLazyOpen { get; init; } /// - /// The analysis configuration, which specifies how to analyze the data.
After you create a job, you cannot change the analysis configuration; all the properties are informational. + /// + /// The analysis configuration, which specifies how to analyze the data. + /// After you create a job, you cannot change the analysis configuration; all the properties are informational. + /// /// [JsonInclude, JsonPropertyName("analysis_config")] public Elastic.Clients.Elasticsearch.MachineLearning.AnalysisConfig AnalysisConfig { get; init; } /// - /// Limits can be applied for the resources required to hold the mathematical models in memory.
These limits are approximate and can be set per job.
They do not control the memory used by other processes, for example the Elasticsearch Java processes. + /// + /// Limits can be applied for the resources required to hold the mathematical models in memory. + /// These limits are approximate and can be set per job. + /// They do not control the memory used by other processes, for example the Elasticsearch Java processes. + /// /// [JsonInclude, JsonPropertyName("analysis_limits")] public Elastic.Clients.Elasticsearch.MachineLearning.AnalysisLimits? AnalysisLimits { get; init; } /// - /// Advanced configuration option.
The time between each periodic persistence of the model.
The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time.
The smallest allowed value is 1 hour. + /// + /// Advanced configuration option. + /// The time between each periodic persistence of the model. + /// The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. + /// The smallest allowed value is 1 hour. + /// /// [JsonInclude, JsonPropertyName("background_persist_interval")] public Elastic.Clients.Elasticsearch.Duration? BackgroundPersistInterval { get; init; } @@ -58,73 +73,112 @@ public sealed partial class Job public DateTimeOffset? CreateTime { get; init; } /// - /// Advanced configuration option.
Contains custom metadata about the job. + /// + /// Advanced configuration option. + /// Contains custom metadata about the job. + /// /// [JsonInclude, JsonPropertyName("custom_settings")] public object? CustomSettings { get; init; } /// - /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job.
It specifies a period of time (in days) after which only the first snapshot per day is retained.
This period is relative to the timestamp of the most recent snapshot for this job.
Valid values range from 0 to `model_snapshot_retention_days`. + /// + /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job. + /// It specifies a period of time (in days) after which only the first snapshot per day is retained. + /// This period is relative to the timestamp of the most recent snapshot for this job. + /// Valid values range from 0 to model_snapshot_retention_days. + /// /// [JsonInclude, JsonPropertyName("daily_model_snapshot_retention_after_days")] public long? DailyModelSnapshotRetentionAfterDays { get; init; } /// - /// The data description defines the format of the input data when you send data to the job by using the post data API.
Note that when configuring a datafeed, these properties are automatically set.
When data is received via the post data API, it is not stored in Elasticsearch.
Only the results for anomaly detection are retained. + /// + /// The data description defines the format of the input data when you send data to the job by using the post data API. + /// Note that when configuring a datafeed, these properties are automatically set. + /// When data is received via the post data API, it is not stored in Elasticsearch. + /// Only the results for anomaly detection are retained. + /// /// [JsonInclude, JsonPropertyName("data_description")] public Elastic.Clients.Elasticsearch.MachineLearning.DataDescription DataDescription { get; init; } /// - /// The datafeed, which retrieves data from Elasticsearch for analysis by the job.
You can associate only one datafeed with each anomaly detection job. + /// + /// The datafeed, which retrieves data from Elasticsearch for analysis by the job. + /// You can associate only one datafeed with each anomaly detection job. + /// /// [JsonInclude, JsonPropertyName("datafeed_config")] public Elastic.Clients.Elasticsearch.MachineLearning.Datafeed? DatafeedConfig { get; init; } /// - /// Indicates that the process of deleting the job is in progress but not yet completed.
It is only reported when `true`. + /// + /// Indicates that the process of deleting the job is in progress but not yet completed. + /// It is only reported when true. + /// /// [JsonInclude, JsonPropertyName("deleting")] public bool? Deleting { get; init; } /// - /// A description of the job. + /// + /// A description of the job. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; init; } /// - /// If the job closed or failed, this is the time the job finished, otherwise it is `null`.
This property is informational; you cannot change its value. + /// + /// If the job closed or failed, this is the time the job finished, otherwise it is null. + /// This property is informational; you cannot change its value. + /// /// [JsonInclude, JsonPropertyName("finished_time")] public DateTimeOffset? FinishedTime { get; init; } /// - /// A list of job groups.
A job can belong to no groups or many. + /// + /// A list of job groups. + /// A job can belong to no groups or many. + /// /// [JsonInclude, JsonPropertyName("groups")] public IReadOnlyCollection? Groups { get; init; } /// - /// Identifier for the anomaly detection job.
This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
It must start and end with alphanumeric characters. + /// + /// Identifier for the anomaly detection job. + /// This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. + /// It must start and end with alphanumeric characters. + /// /// [JsonInclude, JsonPropertyName("job_id")] public string JobId { get; init; } /// - /// Reserved for future use, currently set to `anomaly_detector`. + /// + /// Reserved for future use, currently set to anomaly_detector. + /// /// [JsonInclude, JsonPropertyName("job_type")] public string? JobType { get; init; } /// - /// The machine learning configuration version number at which the the job was created. + /// + /// The machine learning configuration version number at which the the job was created. + /// /// [JsonInclude, JsonPropertyName("job_version")] public string? JobVersion { get; init; } /// - /// This advanced configuration option stores model information along with the results.
It provides a more detailed view into anomaly detection.
Model plot provides a simplified and indicative view of the model and its bounds. + /// + /// This advanced configuration option stores model information along with the results. + /// It provides a more detailed view into anomaly detection. + /// Model plot provides a simplified and indicative view of the model and its bounds. + /// /// [JsonInclude, JsonPropertyName("model_plot_config")] public Elastic.Clients.Elasticsearch.MachineLearning.ModelPlotConfig? ModelPlotConfig { get; init; } @@ -132,25 +186,45 @@ public sealed partial class Job public string? ModelSnapshotId { get; init; } /// - /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job.
It specifies the maximum period of time (in days) that snapshots are retained.
This period is relative to the timestamp of the most recent snapshot for this job.
By default, snapshots ten days older than the newest snapshot are deleted. + /// + /// Advanced configuration option, which affects the automatic removal of old model snapshots for this job. + /// It specifies the maximum period of time (in days) that snapshots are retained. + /// This period is relative to the timestamp of the most recent snapshot for this job. + /// By default, snapshots ten days older than the newest snapshot are deleted. + /// /// [JsonInclude, JsonPropertyName("model_snapshot_retention_days")] public long ModelSnapshotRetentionDays { get; init; } /// - /// Advanced configuration option.
The period over which adjustments to the score are applied, as new data is seen.
The default value is the longer of 30 days or 100 `bucket_spans`. + /// + /// Advanced configuration option. + /// The period over which adjustments to the score are applied, as new data is seen. + /// The default value is the longer of 30 days or 100 bucket_spans. + /// /// [JsonInclude, JsonPropertyName("renormalization_window_days")] public long? RenormalizationWindowDays { get; init; } /// - /// A text string that affects the name of the machine learning results index.
The default value is `shared`, which generates an index named `.ml-anomalies-shared`. + /// + /// A text string that affects the name of the machine learning results index. + /// The default value is shared, which generates an index named .ml-anomalies-shared. + /// /// [JsonInclude, JsonPropertyName("results_index_name")] public string ResultsIndexName { get; init; } /// - /// Advanced configuration option.
The period of time (in days) that results are retained.
Age is calculated relative to the timestamp of the latest bucket result.
If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch.
The default value is null, which means all results are retained.
Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results.
Annotations added by users are retained forever. + /// + /// Advanced configuration option. + /// The period of time (in days) that results are retained. + /// Age is calculated relative to the timestamp of the latest bucket result. + /// If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. + /// The default value is null, which means all results are retained. + /// Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. + /// Annotations added by users are retained forever. + /// /// [JsonInclude, JsonPropertyName("results_retention_days")] public long? ResultsRetentionDays { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/JobStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/JobStats.g.cs index 3b5801b1dae..c8dae4de397 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/JobStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/JobStats.g.cs @@ -30,61 +30,85 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class JobStats { /// - /// For open anomaly detection jobs only, contains messages relating to the selection of a node to run the job. + /// + /// For open anomaly detection jobs only, contains messages relating to the selection of a node to run the job. + /// /// [JsonInclude, JsonPropertyName("assignment_explanation")] public string? AssignmentExplanation { get; init; } /// - /// An object that describes the quantity of input to the job and any related error counts.
The `data_count` values are cumulative for the lifetime of a job.
If a model snapshot is reverted or old results are deleted, the job counts are not reset. + /// + /// An object that describes the quantity of input to the job and any related error counts. + /// The data_count values are cumulative for the lifetime of a job. + /// If a model snapshot is reverted or old results are deleted, the job counts are not reset. + /// /// [JsonInclude, JsonPropertyName("data_counts")] public Elastic.Clients.Elasticsearch.MachineLearning.DataCounts DataCounts { get; init; } /// - /// Indicates that the process of deleting the job is in progress but not yet completed. It is only reported when `true`. + /// + /// Indicates that the process of deleting the job is in progress but not yet completed. It is only reported when true. + /// /// [JsonInclude, JsonPropertyName("deleting")] public bool? Deleting { get; init; } /// - /// An object that provides statistical information about forecasts belonging to this job.
Some statistics are omitted if no forecasts have been made. + /// + /// An object that provides statistical information about forecasts belonging to this job. + /// Some statistics are omitted if no forecasts have been made. + /// /// [JsonInclude, JsonPropertyName("forecasts_stats")] public Elastic.Clients.Elasticsearch.MachineLearning.JobForecastStatistics ForecastsStats { get; init; } /// - /// Identifier for the anomaly detection job. + /// + /// Identifier for the anomaly detection job. + /// /// [JsonInclude, JsonPropertyName("job_id")] public string JobId { get; init; } /// - /// An object that provides information about the size and contents of the model. + /// + /// An object that provides information about the size and contents of the model. + /// /// [JsonInclude, JsonPropertyName("model_size_stats")] public Elastic.Clients.Elasticsearch.MachineLearning.ModelSizeStats ModelSizeStats { get; init; } /// - /// Contains properties for the node that runs the job.
This information is available only for open jobs. + /// + /// Contains properties for the node that runs the job. + /// This information is available only for open jobs. + /// /// [JsonInclude, JsonPropertyName("node")] public Elastic.Clients.Elasticsearch.MachineLearning.DiscoveryNode? Node { get; init; } /// - /// For open jobs only, the elapsed time for which the job has been open. + /// + /// For open jobs only, the elapsed time for which the job has been open. + /// /// [JsonInclude, JsonPropertyName("open_time")] public DateTimeOffset? OpenTime { get; init; } /// - /// The status of the anomaly detection job, which can be one of the following values: `closed`, `closing`, `failed`, `opened`, `opening`. + /// + /// The status of the anomaly detection job, which can be one of the following values: closed, closing, failed, opened, opening. + /// /// [JsonInclude, JsonPropertyName("state")] public Elastic.Clients.Elasticsearch.MachineLearning.JobState State { get; init; } /// - /// An object that provides statistical information about timing aspect of this job. + /// + /// An object that provides statistical information about timing aspect of this job. + /// /// [JsonInclude, JsonPropertyName("timing_stats")] public Elastic.Clients.Elasticsearch.MachineLearning.JobTimingStats TimingStats { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/JvmStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/JvmStats.g.cs index bfbe30b4921..5764fc527ab 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/JvmStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/JvmStats.g.cs @@ -30,37 +30,49 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class JvmStats { /// - /// Maximum amount of memory available for use by the heap. + /// + /// Maximum amount of memory available for use by the heap. + /// /// [JsonInclude, JsonPropertyName("heap_max")] public Elastic.Clients.Elasticsearch.ByteSize? HeapMax { get; init; } /// - /// Maximum amount of memory, in bytes, available for use by the heap. + /// + /// Maximum amount of memory, in bytes, available for use by the heap. + /// /// [JsonInclude, JsonPropertyName("heap_max_in_bytes")] public int HeapMaxInBytes { get; init; } /// - /// Amount of Java heap currently being used for caching inference models. + /// + /// Amount of Java heap currently being used for caching inference models. + /// /// [JsonInclude, JsonPropertyName("java_inference")] public Elastic.Clients.Elasticsearch.ByteSize? JavaInference { get; init; } /// - /// Amount of Java heap, in bytes, currently being used for caching inference models. + /// + /// Amount of Java heap, in bytes, currently being used for caching inference models. + /// /// [JsonInclude, JsonPropertyName("java_inference_in_bytes")] public int JavaInferenceInBytes { get; init; } /// - /// Maximum amount of Java heap to be used for caching inference models. + /// + /// Maximum amount of Java heap to be used for caching inference models. + /// /// [JsonInclude, JsonPropertyName("java_inference_max")] public Elastic.Clients.Elasticsearch.ByteSize? JavaInferenceMax { get; init; } /// - /// Maximum amount of Java heap, in bytes, to be used for caching inference models. + /// + /// Maximum amount of Java heap, in bytes, to be used for caching inference models. + /// /// [JsonInclude, JsonPropertyName("java_inference_max_in_bytes")] public int JavaInferenceMaxInBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/MemMlStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/MemMlStats.g.cs index 8951ce05d70..5f3ac1ed87f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/MemMlStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/MemMlStats.g.cs @@ -30,61 +30,81 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class MemMlStats { /// - /// Amount of native memory set aside for anomaly detection jobs. + /// + /// Amount of native memory set aside for anomaly detection jobs. + /// /// [JsonInclude, JsonPropertyName("anomaly_detectors")] public Elastic.Clients.Elasticsearch.ByteSize? AnomalyDetectors { get; init; } /// - /// Amount of native memory, in bytes, set aside for anomaly detection jobs. + /// + /// Amount of native memory, in bytes, set aside for anomaly detection jobs. + /// /// [JsonInclude, JsonPropertyName("anomaly_detectors_in_bytes")] public int AnomalyDetectorsInBytes { get; init; } /// - /// Amount of native memory set aside for data frame analytics jobs. + /// + /// Amount of native memory set aside for data frame analytics jobs. + /// /// [JsonInclude, JsonPropertyName("data_frame_analytics")] public Elastic.Clients.Elasticsearch.ByteSize? DataFrameAnalytics { get; init; } /// - /// Amount of native memory, in bytes, set aside for data frame analytics jobs. + /// + /// Amount of native memory, in bytes, set aside for data frame analytics jobs. + /// /// [JsonInclude, JsonPropertyName("data_frame_analytics_in_bytes")] public int DataFrameAnalyticsInBytes { get; init; } /// - /// Maximum amount of native memory (separate to the JVM heap) that may be used by machine learning native processes. + /// + /// Maximum amount of native memory (separate to the JVM heap) that may be used by machine learning native processes. + /// /// [JsonInclude, JsonPropertyName("max")] public Elastic.Clients.Elasticsearch.ByteSize? Max { get; init; } /// - /// Maximum amount of native memory (separate to the JVM heap), in bytes, that may be used by machine learning native processes. + /// + /// Maximum amount of native memory (separate to the JVM heap), in bytes, that may be used by machine learning native processes. + /// /// [JsonInclude, JsonPropertyName("max_in_bytes")] public int MaxInBytes { get; init; } /// - /// Amount of native memory set aside for loading machine learning native code shared libraries. + /// + /// Amount of native memory set aside for loading machine learning native code shared libraries. + /// /// [JsonInclude, JsonPropertyName("native_code_overhead")] public Elastic.Clients.Elasticsearch.ByteSize? NativeCodeOverhead { get; init; } /// - /// Amount of native memory, in bytes, set aside for loading machine learning native code shared libraries. + /// + /// Amount of native memory, in bytes, set aside for loading machine learning native code shared libraries. + /// /// [JsonInclude, JsonPropertyName("native_code_overhead_in_bytes")] public int NativeCodeOverheadInBytes { get; init; } /// - /// Amount of native memory set aside for trained models that have a PyTorch model_type. + /// + /// Amount of native memory set aside for trained models that have a PyTorch model_type. + /// /// [JsonInclude, JsonPropertyName("native_inference")] public Elastic.Clients.Elasticsearch.ByteSize? NativeInference { get; init; } /// - /// Amount of native memory, in bytes, set aside for trained models that have a PyTorch model_type. + /// + /// Amount of native memory, in bytes, set aside for trained models that have a PyTorch model_type. + /// /// [JsonInclude, JsonPropertyName("native_inference_in_bytes")] public int NativeInferenceInBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/MemStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/MemStats.g.cs index 78414335cfa..3d749746cf3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/MemStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/MemStats.g.cs @@ -30,31 +30,43 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class MemStats { /// - /// If the amount of physical memory has been overridden using the es.total_memory_bytes system property
then this reports the overridden value. Otherwise it reports the same value as total. + /// + /// If the amount of physical memory has been overridden using the es.total_memory_bytes system property + /// then this reports the overridden value. Otherwise it reports the same value as total. + /// /// [JsonInclude, JsonPropertyName("adjusted_total")] public Elastic.Clients.Elasticsearch.ByteSize? AdjustedTotal { get; init; } /// - /// If the amount of physical memory has been overridden using the `es.total_memory_bytes` system property
then this reports the overridden value in bytes. Otherwise it reports the same value as `total_in_bytes`. + /// + /// If the amount of physical memory has been overridden using the es.total_memory_bytes system property + /// then this reports the overridden value in bytes. Otherwise it reports the same value as total_in_bytes. + /// /// [JsonInclude, JsonPropertyName("adjusted_total_in_bytes")] public int AdjustedTotalInBytes { get; init; } /// - /// Contains statistics about machine learning use of native memory on the node. + /// + /// Contains statistics about machine learning use of native memory on the node. + /// /// [JsonInclude, JsonPropertyName("ml")] public Elastic.Clients.Elasticsearch.MachineLearning.MemMlStats Ml { get; init; } /// - /// Total amount of physical memory. + /// + /// Total amount of physical memory. + /// /// [JsonInclude, JsonPropertyName("total")] public Elastic.Clients.Elasticsearch.ByteSize? Total { get; init; } /// - /// Total amount of physical memory in bytes. + /// + /// Total amount of physical memory in bytes. + /// /// [JsonInclude, JsonPropertyName("total_in_bytes")] public int TotalInBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Memory.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Memory.g.cs index 634924f57c3..b71e5a755fd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Memory.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Memory.g.cs @@ -35,31 +35,41 @@ public sealed partial class Memory public string EphemeralId { get; init; } /// - /// Contains Java Virtual Machine (JVM) statistics for the node. + /// + /// Contains Java Virtual Machine (JVM) statistics for the node. + /// /// [JsonInclude, JsonPropertyName("jvm")] public Elastic.Clients.Elasticsearch.MachineLearning.JvmStats Jvm { get; init; } /// - /// Contains statistics about memory usage for the node. + /// + /// Contains statistics about memory usage for the node. + /// /// [JsonInclude, JsonPropertyName("mem")] public Elastic.Clients.Elasticsearch.MachineLearning.MemStats Mem { get; init; } /// - /// Human-readable identifier for the node. Based on the Node name setting setting. + /// + /// Human-readable identifier for the node. Based on the Node name setting setting. + /// /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } /// - /// Roles assigned to the node. + /// + /// Roles assigned to the node. + /// /// [JsonInclude, JsonPropertyName("roles")] public IReadOnlyCollection Roles { get; init; } /// - /// The host and port where transport HTTP connections are accepted. + /// + /// The host and port where transport HTTP connections are accepted. + /// /// [JsonInclude, JsonPropertyName("transport_address")] public string TransportAddress { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ModelPlotConfig.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ModelPlotConfig.g.cs index 66efee0e942..3201aa9ff69 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ModelPlotConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ModelPlotConfig.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class ModelPlotConfig { /// - /// If true, enables calculation and storage of the model change annotations for each entity that is being analyzed. + /// + /// If true, enables calculation and storage of the model change annotations for each entity that is being analyzed. + /// /// [JsonInclude, JsonPropertyName("annotations_enabled")] public bool? AnnotationsEnabled { get; set; } /// - /// If true, enables calculation and storage of the model bounds for each entity that is being analyzed. + /// + /// If true, enables calculation and storage of the model bounds for each entity that is being analyzed. + /// /// [JsonInclude, JsonPropertyName("enabled")] public bool? Enabled { get; set; } /// - /// Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer. + /// + /// Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer. + /// /// [JsonInclude, JsonPropertyName("terms")] public Elastic.Clients.Elasticsearch.Field? Terms { get; set; } @@ -61,7 +67,9 @@ public ModelPlotConfigDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TermsValue { get; set; } /// - /// If true, enables calculation and storage of the model change annotations for each entity that is being analyzed. + /// + /// If true, enables calculation and storage of the model change annotations for each entity that is being analyzed. + /// /// public ModelPlotConfigDescriptor AnnotationsEnabled(bool? annotationsEnabled = true) { @@ -70,7 +78,9 @@ public ModelPlotConfigDescriptor AnnotationsEnabled(bool? annotations } /// - /// If true, enables calculation and storage of the model bounds for each entity that is being analyzed. + /// + /// If true, enables calculation and storage of the model bounds for each entity that is being analyzed. + /// /// public ModelPlotConfigDescriptor Enabled(bool? enabled = true) { @@ -79,7 +89,9 @@ public ModelPlotConfigDescriptor Enabled(bool? enabled = true) } /// - /// Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer. + /// + /// Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer. + /// /// public ModelPlotConfigDescriptor Terms(Elastic.Clients.Elasticsearch.Field? terms) { @@ -88,7 +100,9 @@ public ModelPlotConfigDescriptor Terms(Elastic.Clients.Elasticsearch. } /// - /// Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer. + /// + /// Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer. + /// /// public ModelPlotConfigDescriptor Terms(Expression> terms) { @@ -97,7 +111,9 @@ public ModelPlotConfigDescriptor Terms(Expression - /// Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer. + /// + /// Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer. + /// /// public ModelPlotConfigDescriptor Terms(Expression> terms) { @@ -143,7 +159,9 @@ public ModelPlotConfigDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? TermsValue { get; set; } /// - /// If true, enables calculation and storage of the model change annotations for each entity that is being analyzed. + /// + /// If true, enables calculation and storage of the model change annotations for each entity that is being analyzed. + /// /// public ModelPlotConfigDescriptor AnnotationsEnabled(bool? annotationsEnabled = true) { @@ -152,7 +170,9 @@ public ModelPlotConfigDescriptor AnnotationsEnabled(bool? annotationsEnabled = t } /// - /// If true, enables calculation and storage of the model bounds for each entity that is being analyzed. + /// + /// If true, enables calculation and storage of the model bounds for each entity that is being analyzed. + /// /// public ModelPlotConfigDescriptor Enabled(bool? enabled = true) { @@ -161,7 +181,9 @@ public ModelPlotConfigDescriptor Enabled(bool? enabled = true) } /// - /// Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer. + /// + /// Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer. + /// /// public ModelPlotConfigDescriptor Terms(Elastic.Clients.Elasticsearch.Field? terms) { @@ -170,7 +192,9 @@ public ModelPlotConfigDescriptor Terms(Elastic.Clients.Elasticsearch.Field? term } /// - /// Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer. + /// + /// Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer. + /// /// public ModelPlotConfigDescriptor Terms(Expression> terms) { @@ -179,7 +203,9 @@ public ModelPlotConfigDescriptor Terms(Expression - /// Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer. + /// + /// Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer. + /// /// public ModelPlotConfigDescriptor Terms(Expression> terms) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ModelSnapshot.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ModelSnapshot.g.cs index a8d6d371352..7b4f7aa1c74 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ModelSnapshot.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ModelSnapshot.g.cs @@ -30,61 +30,81 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class ModelSnapshot { /// - /// An optional description of the job. + /// + /// An optional description of the job. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; init; } /// - /// A numerical character string that uniquely identifies the job that the snapshot was created for. + /// + /// A numerical character string that uniquely identifies the job that the snapshot was created for. + /// /// [JsonInclude, JsonPropertyName("job_id")] public string JobId { get; init; } /// - /// The timestamp of the latest processed record. + /// + /// The timestamp of the latest processed record. + /// /// [JsonInclude, JsonPropertyName("latest_record_time_stamp")] public int? LatestRecordTimeStamp { get; init; } /// - /// The timestamp of the latest bucket result. + /// + /// The timestamp of the latest bucket result. + /// /// [JsonInclude, JsonPropertyName("latest_result_time_stamp")] public int? LatestResultTimeStamp { get; init; } /// - /// The minimum version required to be able to restore the model snapshot. + /// + /// The minimum version required to be able to restore the model snapshot. + /// /// [JsonInclude, JsonPropertyName("min_version")] public string MinVersion { get; init; } /// - /// Summary information describing the model. + /// + /// Summary information describing the model. + /// /// [JsonInclude, JsonPropertyName("model_size_stats")] public Elastic.Clients.Elasticsearch.MachineLearning.ModelSizeStats? ModelSizeStats { get; init; } /// - /// If true, this snapshot will not be deleted during automatic cleanup of snapshots older than model_snapshot_retention_days. However, this snapshot will be deleted when the job is deleted. The default value is false. + /// + /// If true, this snapshot will not be deleted during automatic cleanup of snapshots older than model_snapshot_retention_days. However, this snapshot will be deleted when the job is deleted. The default value is false. + /// /// [JsonInclude, JsonPropertyName("retain")] public bool Retain { get; init; } /// - /// For internal use only. + /// + /// For internal use only. + /// /// [JsonInclude, JsonPropertyName("snapshot_doc_count")] public long SnapshotDocCount { get; init; } /// - /// A numerical character string that uniquely identifies the model snapshot. + /// + /// A numerical character string that uniquely identifies the model snapshot. + /// /// [JsonInclude, JsonPropertyName("snapshot_id")] public string SnapshotId { get; init; } /// - /// The creation timestamp for the snapshot. + /// + /// The creation timestamp for the snapshot. + /// /// [JsonInclude, JsonPropertyName("timestamp")] public long Timestamp { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/NerInferenceOptions.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/NerInferenceOptions.g.cs index 33028e2527c..23a58807b46 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/NerInferenceOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/NerInferenceOptions.g.cs @@ -28,24 +28,32 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; /// -/// Named entity recognition options +/// +/// Named entity recognition options +/// /// public sealed partial class NerInferenceOptions { /// - /// The token classification labels. Must be IOB formatted tags + /// + /// The token classification labels. Must be IOB formatted tags + /// /// [JsonInclude, JsonPropertyName("classification_labels")] public ICollection? ClassificationLabels { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } /// - /// The tokenization options + /// + /// The tokenization options + /// /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.MachineLearning.TokenizationConfig? Tokenization { get; set; } @@ -56,7 +64,9 @@ public sealed partial class NerInferenceOptions } /// -/// Named entity recognition options +/// +/// Named entity recognition options +/// /// public sealed partial class NerInferenceOptionsDescriptor : SerializableDescriptor { @@ -76,7 +86,9 @@ public NerInferenceOptionsDescriptor() : base() private Action VocabularyDescriptorAction { get; set; } /// - /// The token classification labels. Must be IOB formatted tags + /// + /// The token classification labels. Must be IOB formatted tags + /// /// public NerInferenceOptionsDescriptor ClassificationLabels(ICollection? classificationLabels) { @@ -85,7 +97,9 @@ public NerInferenceOptionsDescriptor ClassificationLabels(ICollection? c } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public NerInferenceOptionsDescriptor ResultsField(string? resultsField) { @@ -94,7 +108,9 @@ public NerInferenceOptionsDescriptor ResultsField(string? resultsField) } /// - /// The tokenization options + /// + /// The tokenization options + /// /// public NerInferenceOptionsDescriptor Tokenization(Elastic.Clients.Elasticsearch.MachineLearning.TokenizationConfig? tokenization) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/NerInferenceUpdateOptions.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/NerInferenceUpdateOptions.g.cs index 45736382831..2e91e884414 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/NerInferenceUpdateOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/NerInferenceUpdateOptions.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class NerInferenceUpdateOptions { /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.MachineLearning.NlpTokenizationUpdateOptions? Tokenization { get; set; } @@ -58,7 +62,9 @@ public NerInferenceUpdateOptionsDescriptor() : base() private Action TokenizationDescriptorAction { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public NerInferenceUpdateOptionsDescriptor ResultsField(string? resultsField) { @@ -67,7 +73,9 @@ public NerInferenceUpdateOptionsDescriptor ResultsField(string? resultsField) } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// public NerInferenceUpdateOptionsDescriptor Tokenization(Elastic.Clients.Elasticsearch.MachineLearning.NlpTokenizationUpdateOptions? tokenization) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/NlpBertTokenizationConfig.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/NlpBertTokenizationConfig.g.cs index 1718927e417..558ae372f55 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/NlpBertTokenizationConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/NlpBertTokenizationConfig.g.cs @@ -28,43 +28,57 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; /// -/// BERT and MPNet tokenization configuration options +/// +/// BERT and MPNet tokenization configuration options +/// /// public sealed partial class NlpBertTokenizationConfig { /// - /// Should the tokenizer lower case the text + /// + /// Should the tokenizer lower case the text + /// /// [JsonInclude, JsonPropertyName("do_lower_case")] public bool? DoLowerCase { get; set; } /// - /// Maximum input sequence length for the model + /// + /// Maximum input sequence length for the model + /// /// [JsonInclude, JsonPropertyName("max_sequence_length")] public int? MaxSequenceLength { get; set; } /// - /// Tokenization spanning options. Special value of -1 indicates no spanning takes place + /// + /// Tokenization spanning options. Special value of -1 indicates no spanning takes place + /// /// [JsonInclude, JsonPropertyName("span")] public int? Span { get; set; } /// - /// Should tokenization input be automatically truncated before sending to the model for inference + /// + /// Should tokenization input be automatically truncated before sending to the model for inference + /// /// [JsonInclude, JsonPropertyName("truncate")] public Elastic.Clients.Elasticsearch.MachineLearning.TokenizationTruncate? Truncate { get; set; } /// - /// Is tokenization completed with special tokens + /// + /// Is tokenization completed with special tokens + /// /// [JsonInclude, JsonPropertyName("with_special_tokens")] public bool? WithSpecialTokens { get; set; } } /// -/// BERT and MPNet tokenization configuration options +/// +/// BERT and MPNet tokenization configuration options +/// /// public sealed partial class NlpBertTokenizationConfigDescriptor : SerializableDescriptor { @@ -81,7 +95,9 @@ public NlpBertTokenizationConfigDescriptor() : base() private bool? WithSpecialTokensValue { get; set; } /// - /// Should the tokenizer lower case the text + /// + /// Should the tokenizer lower case the text + /// /// public NlpBertTokenizationConfigDescriptor DoLowerCase(bool? doLowerCase = true) { @@ -90,7 +106,9 @@ public NlpBertTokenizationConfigDescriptor DoLowerCase(bool? doLowerCase = true) } /// - /// Maximum input sequence length for the model + /// + /// Maximum input sequence length for the model + /// /// public NlpBertTokenizationConfigDescriptor MaxSequenceLength(int? maxSequenceLength) { @@ -99,7 +117,9 @@ public NlpBertTokenizationConfigDescriptor MaxSequenceLength(int? maxSequenceLen } /// - /// Tokenization spanning options. Special value of -1 indicates no spanning takes place + /// + /// Tokenization spanning options. Special value of -1 indicates no spanning takes place + /// /// public NlpBertTokenizationConfigDescriptor Span(int? span) { @@ -108,7 +128,9 @@ public NlpBertTokenizationConfigDescriptor Span(int? span) } /// - /// Should tokenization input be automatically truncated before sending to the model for inference + /// + /// Should tokenization input be automatically truncated before sending to the model for inference + /// /// public NlpBertTokenizationConfigDescriptor Truncate(Elastic.Clients.Elasticsearch.MachineLearning.TokenizationTruncate? truncate) { @@ -117,7 +139,9 @@ public NlpBertTokenizationConfigDescriptor Truncate(Elastic.Clients.Elasticsearc } /// - /// Is tokenization completed with special tokens + /// + /// Is tokenization completed with special tokens + /// /// public NlpBertTokenizationConfigDescriptor WithSpecialTokens(bool? withSpecialTokens = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/NlpRobertaTokenizationConfig.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/NlpRobertaTokenizationConfig.g.cs index 7671fcbf8d7..bc199d9985d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/NlpRobertaTokenizationConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/NlpRobertaTokenizationConfig.g.cs @@ -28,36 +28,48 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; /// -/// RoBERTa tokenization configuration options +/// +/// RoBERTa tokenization configuration options +/// /// public sealed partial class NlpRobertaTokenizationConfig { /// - /// Should the tokenizer prefix input with a space character + /// + /// Should the tokenizer prefix input with a space character + /// /// [JsonInclude, JsonPropertyName("add_prefix_space")] public bool? AddPrefixSpace { get; set; } /// - /// Maximum input sequence length for the model + /// + /// Maximum input sequence length for the model + /// /// [JsonInclude, JsonPropertyName("max_sequence_length")] public int? MaxSequenceLength { get; set; } /// - /// Tokenization spanning options. Special value of -1 indicates no spanning takes place + /// + /// Tokenization spanning options. Special value of -1 indicates no spanning takes place + /// /// [JsonInclude, JsonPropertyName("span")] public int? Span { get; set; } /// - /// Should tokenization input be automatically truncated before sending to the model for inference + /// + /// Should tokenization input be automatically truncated before sending to the model for inference + /// /// [JsonInclude, JsonPropertyName("truncate")] public Elastic.Clients.Elasticsearch.MachineLearning.TokenizationTruncate? Truncate { get; set; } /// - /// Is tokenization completed with special tokens + /// + /// Is tokenization completed with special tokens + /// /// [JsonInclude, JsonPropertyName("with_special_tokens")] public bool? WithSpecialTokens { get; set; } @@ -66,7 +78,9 @@ public sealed partial class NlpRobertaTokenizationConfig } /// -/// RoBERTa tokenization configuration options +/// +/// RoBERTa tokenization configuration options +/// /// public sealed partial class NlpRobertaTokenizationConfigDescriptor : SerializableDescriptor { @@ -83,7 +97,9 @@ public NlpRobertaTokenizationConfigDescriptor() : base() private bool? WithSpecialTokensValue { get; set; } /// - /// Should the tokenizer prefix input with a space character + /// + /// Should the tokenizer prefix input with a space character + /// /// public NlpRobertaTokenizationConfigDescriptor AddPrefixSpace(bool? addPrefixSpace = true) { @@ -92,7 +108,9 @@ public NlpRobertaTokenizationConfigDescriptor AddPrefixSpace(bool? addPrefixSpac } /// - /// Maximum input sequence length for the model + /// + /// Maximum input sequence length for the model + /// /// public NlpRobertaTokenizationConfigDescriptor MaxSequenceLength(int? maxSequenceLength) { @@ -101,7 +119,9 @@ public NlpRobertaTokenizationConfigDescriptor MaxSequenceLength(int? maxSequence } /// - /// Tokenization spanning options. Special value of -1 indicates no spanning takes place + /// + /// Tokenization spanning options. Special value of -1 indicates no spanning takes place + /// /// public NlpRobertaTokenizationConfigDescriptor Span(int? span) { @@ -110,7 +130,9 @@ public NlpRobertaTokenizationConfigDescriptor Span(int? span) } /// - /// Should tokenization input be automatically truncated before sending to the model for inference + /// + /// Should tokenization input be automatically truncated before sending to the model for inference + /// /// public NlpRobertaTokenizationConfigDescriptor Truncate(Elastic.Clients.Elasticsearch.MachineLearning.TokenizationTruncate? truncate) { @@ -119,7 +141,9 @@ public NlpRobertaTokenizationConfigDescriptor Truncate(Elastic.Clients.Elasticse } /// - /// Is tokenization completed with special tokens + /// + /// Is tokenization completed with special tokens + /// /// public NlpRobertaTokenizationConfigDescriptor WithSpecialTokens(bool? withSpecialTokens = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/NlpTokenizationUpdateOptions.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/NlpTokenizationUpdateOptions.g.cs index 932586037a6..35b07f64f17 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/NlpTokenizationUpdateOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/NlpTokenizationUpdateOptions.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class NlpTokenizationUpdateOptions { /// - /// Span options to apply + /// + /// Span options to apply + /// /// [JsonInclude, JsonPropertyName("span")] public int? Span { get; set; } /// - /// Truncate options to apply + /// + /// Truncate options to apply + /// /// [JsonInclude, JsonPropertyName("truncate")] public Elastic.Clients.Elasticsearch.MachineLearning.TokenizationTruncate? Truncate { get; set; } @@ -54,7 +58,9 @@ public NlpTokenizationUpdateOptionsDescriptor() : base() private Elastic.Clients.Elasticsearch.MachineLearning.TokenizationTruncate? TruncateValue { get; set; } /// - /// Span options to apply + /// + /// Span options to apply + /// /// public NlpTokenizationUpdateOptionsDescriptor Span(int? span) { @@ -63,7 +69,9 @@ public NlpTokenizationUpdateOptionsDescriptor Span(int? span) } /// - /// Truncate options to apply + /// + /// Truncate options to apply + /// /// public NlpTokenizationUpdateOptionsDescriptor Truncate(Elastic.Clients.Elasticsearch.MachineLearning.TokenizationTruncate? truncate) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/OverallBucket.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/OverallBucket.g.cs index 6aab4655594..0807784d1c1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/OverallBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/OverallBucket.g.cs @@ -30,43 +30,57 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class OverallBucket { /// - /// The length of the bucket in seconds. Matches the job with the longest bucket_span value. + /// + /// The length of the bucket in seconds. Matches the job with the longest bucket_span value. + /// /// [JsonInclude, JsonPropertyName("bucket_span")] public long BucketSpan { get; init; } /// - /// If true, this is an interim result. In other words, the results are calculated based on partial input data. + /// + /// If true, this is an interim result. In other words, the results are calculated based on partial input data. + /// /// [JsonInclude, JsonPropertyName("is_interim")] public bool IsInterim { get; init; } /// - /// An array of objects that contain the max_anomaly_score per job_id. + /// + /// An array of objects that contain the max_anomaly_score per job_id. + /// /// [JsonInclude, JsonPropertyName("jobs")] public IReadOnlyCollection Jobs { get; init; } /// - /// The top_n average of the maximum bucket anomaly_score per job. + /// + /// The top_n average of the maximum bucket anomaly_score per job. + /// /// [JsonInclude, JsonPropertyName("overall_score")] public double OverallScore { get; init; } /// - /// Internal. This is always set to overall_bucket. + /// + /// Internal. This is always set to overall_bucket. + /// /// [JsonInclude, JsonPropertyName("result_type")] public string ResultType { get; init; } /// - /// The start time of the bucket for which these results were calculated. + /// + /// The start time of the bucket for which these results were calculated. + /// /// [JsonInclude, JsonPropertyName("timestamp")] public long Timestamp { get; init; } /// - /// The start time of the bucket for which these results were calculated. + /// + /// The start time of the bucket for which these results were calculated. + /// /// [JsonInclude, JsonPropertyName("timestamp_string")] public DateTimeOffset TimestampString { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Page.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Page.g.cs index 5f32488edfe..43f81ff7dce 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Page.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Page.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class Page { /// - /// Skips the specified number of items. + /// + /// Skips the specified number of items. + /// /// [JsonInclude, JsonPropertyName("from")] public int? From { get; set; } /// - /// Specifies the maximum number of items to obtain. + /// + /// Specifies the maximum number of items to obtain. + /// /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } @@ -54,7 +58,9 @@ public PageDescriptor() : base() private int? SizeValue { get; set; } /// - /// Skips the specified number of items. + /// + /// Skips the specified number of items. + /// /// public PageDescriptor From(int? from) { @@ -63,7 +69,9 @@ public PageDescriptor From(int? from) } /// - /// Specifies the maximum number of items to obtain. + /// + /// Specifies the maximum number of items to obtain. + /// /// public PageDescriptor Size(int? size) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/PassThroughInferenceOptions.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/PassThroughInferenceOptions.g.cs index 743a8a82dc7..59ddfeeda9d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/PassThroughInferenceOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/PassThroughInferenceOptions.g.cs @@ -28,18 +28,24 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; /// -/// Pass through configuration options +/// +/// Pass through configuration options +/// /// public sealed partial class PassThroughInferenceOptions { /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } /// - /// The tokenization options + /// + /// The tokenization options + /// /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.MachineLearning.TokenizationConfig? Tokenization { get; set; } @@ -50,7 +56,9 @@ public sealed partial class PassThroughInferenceOptions } /// -/// Pass through configuration options +/// +/// Pass through configuration options +/// /// public sealed partial class PassThroughInferenceOptionsDescriptor : SerializableDescriptor { @@ -69,7 +77,9 @@ public PassThroughInferenceOptionsDescriptor() : base() private Action VocabularyDescriptorAction { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public PassThroughInferenceOptionsDescriptor ResultsField(string? resultsField) { @@ -78,7 +88,9 @@ public PassThroughInferenceOptionsDescriptor ResultsField(string? resultsField) } /// - /// The tokenization options + /// + /// The tokenization options + /// /// public PassThroughInferenceOptionsDescriptor Tokenization(Elastic.Clients.Elasticsearch.MachineLearning.TokenizationConfig? tokenization) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/PassThroughInferenceUpdateOptions.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/PassThroughInferenceUpdateOptions.g.cs index ea6d0a06c33..b06353c9a57 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/PassThroughInferenceUpdateOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/PassThroughInferenceUpdateOptions.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class PassThroughInferenceUpdateOptions { /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.MachineLearning.NlpTokenizationUpdateOptions? Tokenization { get; set; } @@ -58,7 +62,9 @@ public PassThroughInferenceUpdateOptionsDescriptor() : base() private Action TokenizationDescriptorAction { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public PassThroughInferenceUpdateOptionsDescriptor ResultsField(string? resultsField) { @@ -67,7 +73,9 @@ public PassThroughInferenceUpdateOptionsDescriptor ResultsField(string? resultsF } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// public PassThroughInferenceUpdateOptionsDescriptor Tokenization(Elastic.Clients.Elasticsearch.MachineLearning.NlpTokenizationUpdateOptions? tokenization) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/PerPartitionCategorization.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/PerPartitionCategorization.g.cs index e33f7ce6e92..027651a57dd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/PerPartitionCategorization.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/PerPartitionCategorization.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class PerPartitionCategorization { /// - /// To enable this setting, you must also set the `partition_field_name` property to the same value in every detector that uses the keyword `mlcategory`. Otherwise, job creation fails. + /// + /// To enable this setting, you must also set the partition_field_name property to the same value in every detector that uses the keyword mlcategory. Otherwise, job creation fails. + /// /// [JsonInclude, JsonPropertyName("enabled")] public bool? Enabled { get; set; } /// - /// This setting can be set to true only if per-partition categorization is enabled. If true, both categorization and subsequent anomaly detection stops for partitions where the categorization status changes to warn. This setting makes it viable to have a job where it is expected that categorization works well for some partitions but not others; you do not pay the cost of bad categorization forever in the partitions where it works badly. + /// + /// This setting can be set to true only if per-partition categorization is enabled. If true, both categorization and subsequent anomaly detection stops for partitions where the categorization status changes to warn. This setting makes it viable to have a job where it is expected that categorization works well for some partitions but not others; you do not pay the cost of bad categorization forever in the partitions where it works badly. + /// /// [JsonInclude, JsonPropertyName("stop_on_warn")] public bool? StopOnWarn { get; set; } @@ -54,7 +58,9 @@ public PerPartitionCategorizationDescriptor() : base() private bool? StopOnWarnValue { get; set; } /// - /// To enable this setting, you must also set the `partition_field_name` property to the same value in every detector that uses the keyword `mlcategory`. Otherwise, job creation fails. + /// + /// To enable this setting, you must also set the partition_field_name property to the same value in every detector that uses the keyword mlcategory. Otherwise, job creation fails. + /// /// public PerPartitionCategorizationDescriptor Enabled(bool? enabled = true) { @@ -63,7 +69,9 @@ public PerPartitionCategorizationDescriptor Enabled(bool? enabled = true) } /// - /// This setting can be set to true only if per-partition categorization is enabled. If true, both categorization and subsequent anomaly detection stops for partitions where the categorization status changes to warn. This setting makes it viable to have a job where it is expected that categorization works well for some partitions but not others; you do not pay the cost of bad categorization forever in the partitions where it works badly. + /// + /// This setting can be set to true only if per-partition categorization is enabled. If true, both categorization and subsequent anomaly detection stops for partitions where the categorization status changes to warn. This setting makes it viable to have a job where it is expected that categorization works well for some partitions but not others; you do not pay the cost of bad categorization forever in the partitions where it works badly. + /// /// public PerPartitionCategorizationDescriptor StopOnWarn(bool? stopOnWarn = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/QuestionAnsweringInferenceOptions.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/QuestionAnsweringInferenceOptions.g.cs index 82f5453c514..6b03df7f95d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/QuestionAnsweringInferenceOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/QuestionAnsweringInferenceOptions.g.cs @@ -28,30 +28,40 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; /// -/// Question answering inference options +/// +/// Question answering inference options +/// /// public sealed partial class QuestionAnsweringInferenceOptions { /// - /// The maximum answer length to consider + /// + /// The maximum answer length to consider + /// /// [JsonInclude, JsonPropertyName("max_answer_length")] public int? MaxAnswerLength { get; set; } /// - /// Specifies the number of top class predictions to return. Defaults to 0. + /// + /// Specifies the number of top class predictions to return. Defaults to 0. + /// /// [JsonInclude, JsonPropertyName("num_top_classes")] public int? NumTopClasses { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.MachineLearning.TokenizationConfig? Tokenization { get; set; } @@ -60,7 +70,9 @@ public sealed partial class QuestionAnsweringInferenceOptions } /// -/// Question answering inference options +/// +/// Question answering inference options +/// /// public sealed partial class QuestionAnsweringInferenceOptionsDescriptor : SerializableDescriptor { @@ -78,7 +90,9 @@ public QuestionAnsweringInferenceOptionsDescriptor() : base() private Action TokenizationDescriptorAction { get; set; } /// - /// The maximum answer length to consider + /// + /// The maximum answer length to consider + /// /// public QuestionAnsweringInferenceOptionsDescriptor MaxAnswerLength(int? maxAnswerLength) { @@ -87,7 +101,9 @@ public QuestionAnsweringInferenceOptionsDescriptor MaxAnswerLength(int? maxAnswe } /// - /// Specifies the number of top class predictions to return. Defaults to 0. + /// + /// Specifies the number of top class predictions to return. Defaults to 0. + /// /// public QuestionAnsweringInferenceOptionsDescriptor NumTopClasses(int? numTopClasses) { @@ -96,7 +112,9 @@ public QuestionAnsweringInferenceOptionsDescriptor NumTopClasses(int? numTopClas } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public QuestionAnsweringInferenceOptionsDescriptor ResultsField(string? resultsField) { @@ -105,7 +123,9 @@ public QuestionAnsweringInferenceOptionsDescriptor ResultsField(string? resultsF } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// public QuestionAnsweringInferenceOptionsDescriptor Tokenization(Elastic.Clients.Elasticsearch.MachineLearning.TokenizationConfig? tokenization) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/QuestionAnsweringInferenceUpdateOptions.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/QuestionAnsweringInferenceUpdateOptions.g.cs index a7263fa3f1d..59ab9ece332 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/QuestionAnsweringInferenceUpdateOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/QuestionAnsweringInferenceUpdateOptions.g.cs @@ -30,31 +30,41 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class QuestionAnsweringInferenceUpdateOptions { /// - /// The maximum answer length to consider for extraction + /// + /// The maximum answer length to consider for extraction + /// /// [JsonInclude, JsonPropertyName("max_answer_length")] public int? MaxAnswerLength { get; set; } /// - /// Specifies the number of top class predictions to return. Defaults to 0. + /// + /// Specifies the number of top class predictions to return. Defaults to 0. + /// /// [JsonInclude, JsonPropertyName("num_top_classes")] public int? NumTopClasses { get; set; } /// - /// The question to answer given the inference context + /// + /// The question to answer given the inference context + /// /// [JsonInclude, JsonPropertyName("question")] public string Question { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.MachineLearning.NlpTokenizationUpdateOptions? Tokenization { get; set; } @@ -79,7 +89,9 @@ public QuestionAnsweringInferenceUpdateOptionsDescriptor() : base() private Action TokenizationDescriptorAction { get; set; } /// - /// The maximum answer length to consider for extraction + /// + /// The maximum answer length to consider for extraction + /// /// public QuestionAnsweringInferenceUpdateOptionsDescriptor MaxAnswerLength(int? maxAnswerLength) { @@ -88,7 +100,9 @@ public QuestionAnsweringInferenceUpdateOptionsDescriptor MaxAnswerLength(int? ma } /// - /// Specifies the number of top class predictions to return. Defaults to 0. + /// + /// Specifies the number of top class predictions to return. Defaults to 0. + /// /// public QuestionAnsweringInferenceUpdateOptionsDescriptor NumTopClasses(int? numTopClasses) { @@ -97,7 +111,9 @@ public QuestionAnsweringInferenceUpdateOptionsDescriptor NumTopClasses(int? numT } /// - /// The question to answer given the inference context + /// + /// The question to answer given the inference context + /// /// public QuestionAnsweringInferenceUpdateOptionsDescriptor Question(string question) { @@ -106,7 +122,9 @@ public QuestionAnsweringInferenceUpdateOptionsDescriptor Question(string questio } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public QuestionAnsweringInferenceUpdateOptionsDescriptor ResultsField(string? resultsField) { @@ -115,7 +133,9 @@ public QuestionAnsweringInferenceUpdateOptionsDescriptor ResultsField(string? re } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// public QuestionAnsweringInferenceUpdateOptionsDescriptor Tokenization(Elastic.Clients.Elasticsearch.MachineLearning.NlpTokenizationUpdateOptions? tokenization) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/RegressionInferenceOptions.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/RegressionInferenceOptions.g.cs index 5158c6afba9..97fe7e673b3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/RegressionInferenceOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/RegressionInferenceOptions.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class RegressionInferenceOptions { /// - /// Specifies the maximum number of feature importance values per document. + /// + /// Specifies the maximum number of feature importance values per document. + /// /// [JsonInclude, JsonPropertyName("num_top_feature_importance_values")] public int? NumTopFeatureImportanceValues { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public Elastic.Clients.Elasticsearch.Field? ResultsField { get; set; } @@ -58,7 +62,9 @@ public RegressionInferenceOptionsDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? ResultsFieldValue { get; set; } /// - /// Specifies the maximum number of feature importance values per document. + /// + /// Specifies the maximum number of feature importance values per document. + /// /// public RegressionInferenceOptionsDescriptor NumTopFeatureImportanceValues(int? numTopFeatureImportanceValues) { @@ -67,7 +73,9 @@ public RegressionInferenceOptionsDescriptor NumTopFeatureImportanceVa } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public RegressionInferenceOptionsDescriptor ResultsField(Elastic.Clients.Elasticsearch.Field? resultsField) { @@ -76,7 +84,9 @@ public RegressionInferenceOptionsDescriptor ResultsField(Elastic.Clie } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public RegressionInferenceOptionsDescriptor ResultsField(Expression> resultsField) { @@ -85,7 +95,9 @@ public RegressionInferenceOptionsDescriptor ResultsField(Expr } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public RegressionInferenceOptionsDescriptor ResultsField(Expression> resultsField) { @@ -124,7 +136,9 @@ public RegressionInferenceOptionsDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? ResultsFieldValue { get; set; } /// - /// Specifies the maximum number of feature importance values per document. + /// + /// Specifies the maximum number of feature importance values per document. + /// /// public RegressionInferenceOptionsDescriptor NumTopFeatureImportanceValues(int? numTopFeatureImportanceValues) { @@ -133,7 +147,9 @@ public RegressionInferenceOptionsDescriptor NumTopFeatureImportanceValues(int? n } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public RegressionInferenceOptionsDescriptor ResultsField(Elastic.Clients.Elasticsearch.Field? resultsField) { @@ -142,7 +158,9 @@ public RegressionInferenceOptionsDescriptor ResultsField(Elastic.Clients.Elastic } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public RegressionInferenceOptionsDescriptor ResultsField(Expression> resultsField) { @@ -151,7 +169,9 @@ public RegressionInferenceOptionsDescriptor ResultsField(Expr } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public RegressionInferenceOptionsDescriptor ResultsField(Expression> resultsField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/RuleCondition.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/RuleCondition.g.cs index 713cd3316a0..77554d4e4f8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/RuleCondition.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/RuleCondition.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class RuleCondition { /// - /// Specifies the result property to which the condition applies. If your detector uses `lat_long`, `metric`, `rare`, or `freq_rare` functions, you can only specify conditions that apply to time. + /// + /// Specifies the result property to which the condition applies. If your detector uses lat_long, metric, rare, or freq_rare functions, you can only specify conditions that apply to time. + /// /// [JsonInclude, JsonPropertyName("applies_to")] public Elastic.Clients.Elasticsearch.MachineLearning.AppliesTo AppliesTo { get; set; } /// - /// Specifies the condition operator. The available options are greater than, greater than or equals, less than, and less than or equals. + /// + /// Specifies the condition operator. The available options are greater than, greater than or equals, less than, and less than or equals. + /// /// [JsonInclude, JsonPropertyName("operator")] public Elastic.Clients.Elasticsearch.MachineLearning.ConditionOperator Operator { get; set; } /// - /// The value that is compared against the `applies_to` field using the operator. + /// + /// The value that is compared against the applies_to field using the operator. + /// /// [JsonInclude, JsonPropertyName("value")] public double Value { get; set; } @@ -61,7 +67,9 @@ public RuleConditionDescriptor() : base() private double ValueValue { get; set; } /// - /// Specifies the result property to which the condition applies. If your detector uses `lat_long`, `metric`, `rare`, or `freq_rare` functions, you can only specify conditions that apply to time. + /// + /// Specifies the result property to which the condition applies. If your detector uses lat_long, metric, rare, or freq_rare functions, you can only specify conditions that apply to time. + /// /// public RuleConditionDescriptor AppliesTo(Elastic.Clients.Elasticsearch.MachineLearning.AppliesTo appliesTo) { @@ -70,7 +78,9 @@ public RuleConditionDescriptor AppliesTo(Elastic.Clients.Elasticsearch.MachineLe } /// - /// Specifies the condition operator. The available options are greater than, greater than or equals, less than, and less than or equals. + /// + /// Specifies the condition operator. The available options are greater than, greater than or equals, less than, and less than or equals. + /// /// public RuleConditionDescriptor Operator(Elastic.Clients.Elasticsearch.MachineLearning.ConditionOperator value) { @@ -79,7 +89,9 @@ public RuleConditionDescriptor Operator(Elastic.Clients.Elasticsearch.MachineLea } /// - /// The value that is compared against the `applies_to` field using the operator. + /// + /// The value that is compared against the applies_to field using the operator. + /// /// public RuleConditionDescriptor Value(double value) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/RunningStateSearchInterval.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/RunningStateSearchInterval.g.cs index 17960b7b598..f551b5a9d8e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/RunningStateSearchInterval.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/RunningStateSearchInterval.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class RunningStateSearchInterval { /// - /// The end time. + /// + /// The end time. + /// /// [JsonInclude, JsonPropertyName("end")] public Elastic.Clients.Elasticsearch.Duration? End { get; init; } /// - /// The end time as an epoch in milliseconds. + /// + /// The end time as an epoch in milliseconds. + /// /// [JsonInclude, JsonPropertyName("end_ms")] public long EndMs { get; init; } /// - /// The start time. + /// + /// The start time. + /// /// [JsonInclude, JsonPropertyName("start")] public Elastic.Clients.Elasticsearch.Duration? Start { get; init; } /// - /// The start time as an epoch in milliseconds. + /// + /// The start time as an epoch in milliseconds. + /// /// [JsonInclude, JsonPropertyName("start_ms")] public long StartMs { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextClassificationInferenceOptions.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextClassificationInferenceOptions.g.cs index d70f2aa62b6..9532c4a0e49 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextClassificationInferenceOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextClassificationInferenceOptions.g.cs @@ -28,30 +28,40 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; /// -/// Text classification configuration options +/// +/// Text classification configuration options +/// /// public sealed partial class TextClassificationInferenceOptions { /// - /// Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels + /// + /// Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels + /// /// [JsonInclude, JsonPropertyName("classification_labels")] public ICollection? ClassificationLabels { get; set; } /// - /// Specifies the number of top class predictions to return. Defaults to 0. + /// + /// Specifies the number of top class predictions to return. Defaults to 0. + /// /// [JsonInclude, JsonPropertyName("num_top_classes")] public int? NumTopClasses { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } /// - /// The tokenization options + /// + /// The tokenization options + /// /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.MachineLearning.TokenizationConfig? Tokenization { get; set; } @@ -60,7 +70,9 @@ public sealed partial class TextClassificationInferenceOptions } /// -/// Text classification configuration options +/// +/// Text classification configuration options +/// /// public sealed partial class TextClassificationInferenceOptionsDescriptor : SerializableDescriptor { @@ -78,7 +90,9 @@ public TextClassificationInferenceOptionsDescriptor() : base() private Action TokenizationDescriptorAction { get; set; } /// - /// Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels + /// + /// Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels + /// /// public TextClassificationInferenceOptionsDescriptor ClassificationLabels(ICollection? classificationLabels) { @@ -87,7 +101,9 @@ public TextClassificationInferenceOptionsDescriptor ClassificationLabels(ICollec } /// - /// Specifies the number of top class predictions to return. Defaults to 0. + /// + /// Specifies the number of top class predictions to return. Defaults to 0. + /// /// public TextClassificationInferenceOptionsDescriptor NumTopClasses(int? numTopClasses) { @@ -96,7 +112,9 @@ public TextClassificationInferenceOptionsDescriptor NumTopClasses(int? numTopCla } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public TextClassificationInferenceOptionsDescriptor ResultsField(string? resultsField) { @@ -105,7 +123,9 @@ public TextClassificationInferenceOptionsDescriptor ResultsField(string? results } /// - /// The tokenization options + /// + /// The tokenization options + /// /// public TextClassificationInferenceOptionsDescriptor Tokenization(Elastic.Clients.Elasticsearch.MachineLearning.TokenizationConfig? tokenization) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextClassificationInferenceUpdateOptions.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextClassificationInferenceUpdateOptions.g.cs index d98446d119a..d35725e43fe 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextClassificationInferenceUpdateOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextClassificationInferenceUpdateOptions.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class TextClassificationInferenceUpdateOptions { /// - /// Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels + /// + /// Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels + /// /// [JsonInclude, JsonPropertyName("classification_labels")] public ICollection? ClassificationLabels { get; set; } /// - /// Specifies the number of top class predictions to return. Defaults to 0. + /// + /// Specifies the number of top class predictions to return. Defaults to 0. + /// /// [JsonInclude, JsonPropertyName("num_top_classes")] public int? NumTopClasses { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.MachineLearning.NlpTokenizationUpdateOptions? Tokenization { get; set; } @@ -72,7 +80,9 @@ public TextClassificationInferenceUpdateOptionsDescriptor() : base() private Action TokenizationDescriptorAction { get; set; } /// - /// Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels + /// + /// Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels + /// /// public TextClassificationInferenceUpdateOptionsDescriptor ClassificationLabels(ICollection? classificationLabels) { @@ -81,7 +91,9 @@ public TextClassificationInferenceUpdateOptionsDescriptor ClassificationLabels(I } /// - /// Specifies the number of top class predictions to return. Defaults to 0. + /// + /// Specifies the number of top class predictions to return. Defaults to 0. + /// /// public TextClassificationInferenceUpdateOptionsDescriptor NumTopClasses(int? numTopClasses) { @@ -90,7 +102,9 @@ public TextClassificationInferenceUpdateOptionsDescriptor NumTopClasses(int? num } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public TextClassificationInferenceUpdateOptionsDescriptor ResultsField(string? resultsField) { @@ -99,7 +113,9 @@ public TextClassificationInferenceUpdateOptionsDescriptor ResultsField(string? r } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// public TextClassificationInferenceUpdateOptionsDescriptor Tokenization(Elastic.Clients.Elasticsearch.MachineLearning.NlpTokenizationUpdateOptions? tokenization) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextEmbeddingInferenceOptions.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextEmbeddingInferenceOptions.g.cs index 41817db88ec..bb082b6b6c9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextEmbeddingInferenceOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextEmbeddingInferenceOptions.g.cs @@ -28,24 +28,32 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; /// -/// Text embedding inference options +/// +/// Text embedding inference options +/// /// public sealed partial class TextEmbeddingInferenceOptions { /// - /// The number of dimensions in the embedding output + /// + /// The number of dimensions in the embedding output + /// /// [JsonInclude, JsonPropertyName("embedding_size")] public int? EmbeddingSize { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } /// - /// The tokenization options + /// + /// The tokenization options + /// /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.MachineLearning.TokenizationConfig? Tokenization { get; set; } @@ -54,7 +62,9 @@ public sealed partial class TextEmbeddingInferenceOptions } /// -/// Text embedding inference options +/// +/// Text embedding inference options +/// /// public sealed partial class TextEmbeddingInferenceOptionsDescriptor : SerializableDescriptor { @@ -71,7 +81,9 @@ public TextEmbeddingInferenceOptionsDescriptor() : base() private Action TokenizationDescriptorAction { get; set; } /// - /// The number of dimensions in the embedding output + /// + /// The number of dimensions in the embedding output + /// /// public TextEmbeddingInferenceOptionsDescriptor EmbeddingSize(int? embeddingSize) { @@ -80,7 +92,9 @@ public TextEmbeddingInferenceOptionsDescriptor EmbeddingSize(int? embeddingSize) } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public TextEmbeddingInferenceOptionsDescriptor ResultsField(string? resultsField) { @@ -89,7 +103,9 @@ public TextEmbeddingInferenceOptionsDescriptor ResultsField(string? resultsField } /// - /// The tokenization options + /// + /// The tokenization options + /// /// public TextEmbeddingInferenceOptionsDescriptor Tokenization(Elastic.Clients.Elasticsearch.MachineLearning.TokenizationConfig? tokenization) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextEmbeddingInferenceUpdateOptions.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextEmbeddingInferenceUpdateOptions.g.cs index a15383089cb..0c7719ffe79 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextEmbeddingInferenceUpdateOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextEmbeddingInferenceUpdateOptions.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class TextEmbeddingInferenceUpdateOptions { /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } @@ -54,7 +56,9 @@ public TextEmbeddingInferenceUpdateOptionsDescriptor() : base() private Action TokenizationDescriptorAction { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public TextEmbeddingInferenceUpdateOptionsDescriptor ResultsField(string? resultsField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextExpansionInferenceOptions.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextExpansionInferenceOptions.g.cs index 13a52cc09a2..c0184e60758 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextExpansionInferenceOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextExpansionInferenceOptions.g.cs @@ -28,18 +28,24 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; /// -/// Text expansion inference options +/// +/// Text expansion inference options +/// /// public sealed partial class TextExpansionInferenceOptions { /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } /// - /// The tokenization options + /// + /// The tokenization options + /// /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.MachineLearning.TokenizationConfig? Tokenization { get; set; } @@ -48,7 +54,9 @@ public sealed partial class TextExpansionInferenceOptions } /// -/// Text expansion inference options +/// +/// Text expansion inference options +/// /// public sealed partial class TextExpansionInferenceOptionsDescriptor : SerializableDescriptor { @@ -64,7 +72,9 @@ public TextExpansionInferenceOptionsDescriptor() : base() private Action TokenizationDescriptorAction { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public TextExpansionInferenceOptionsDescriptor ResultsField(string? resultsField) { @@ -73,7 +83,9 @@ public TextExpansionInferenceOptionsDescriptor ResultsField(string? resultsField } /// - /// The tokenization options + /// + /// The tokenization options + /// /// public TextExpansionInferenceOptionsDescriptor Tokenization(Elastic.Clients.Elasticsearch.MachineLearning.TokenizationConfig? tokenization) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextExpansionInferenceUpdateOptions.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextExpansionInferenceUpdateOptions.g.cs index a9c8ead16af..033183f8f70 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextExpansionInferenceUpdateOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextExpansionInferenceUpdateOptions.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class TextExpansionInferenceUpdateOptions { /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } @@ -54,7 +56,9 @@ public TextExpansionInferenceUpdateOptionsDescriptor() : base() private Action TokenizationDescriptorAction { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public TextExpansionInferenceUpdateOptionsDescriptor ResultsField(string? resultsField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TokenizationConfig.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TokenizationConfig.g.cs index 054fb10015d..9b0056364e7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TokenizationConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TokenizationConfig.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; /// -/// Tokenization options stored in inference configuration +/// +/// Tokenization options stored in inference configuration +/// /// [JsonConverter(typeof(TokenizationConfigConverter))] public sealed partial class TokenizationConfig diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TotalFeatureImportance.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TotalFeatureImportance.g.cs index 779f83f6b77..01bb1eae32d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TotalFeatureImportance.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TotalFeatureImportance.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class TotalFeatureImportance { /// - /// If the trained model is a classification model, feature importance statistics are gathered per target class value. + /// + /// If the trained model is a classification model, feature importance statistics are gathered per target class value. + /// /// [JsonInclude, JsonPropertyName("classes")] public IReadOnlyCollection Classes { get; init; } /// - /// The feature for which this importance was calculated. + /// + /// The feature for which this importance was calculated. + /// /// [JsonInclude, JsonPropertyName("feature_name")] public string FeatureName { get; init; } /// - /// A collection of feature importance statistics related to the training data set for this particular feature. + /// + /// A collection of feature importance statistics related to the training data set for this particular feature. + /// /// [JsonInclude, JsonPropertyName("importance")] public IReadOnlyCollection Importance { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TotalFeatureImportanceClass.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TotalFeatureImportanceClass.g.cs index 8e13475dc9b..c56d9982740 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TotalFeatureImportanceClass.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TotalFeatureImportanceClass.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class TotalFeatureImportanceClass { /// - /// The target class value. Could be a string, boolean, or number. + /// + /// The target class value. Could be a string, boolean, or number. + /// /// [JsonInclude, JsonPropertyName("class_name")] public string ClassName { get; init; } /// - /// A collection of feature importance statistics related to the training data set for this particular feature. + /// + /// A collection of feature importance statistics related to the training data set for this particular feature. + /// /// [JsonInclude, JsonPropertyName("importance")] public IReadOnlyCollection Importance { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TotalFeatureImportanceStatistics.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TotalFeatureImportanceStatistics.g.cs index 8c16f4f9873..dfc44ddb0af 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TotalFeatureImportanceStatistics.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TotalFeatureImportanceStatistics.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class TotalFeatureImportanceStatistics { /// - /// The maximum importance value across all the training data for this feature. + /// + /// The maximum importance value across all the training data for this feature. + /// /// [JsonInclude, JsonPropertyName("max")] public int Max { get; init; } /// - /// The average magnitude of this feature across all the training data. This value is the average of the absolute values of the importance for this feature. + /// + /// The average magnitude of this feature across all the training data. This value is the average of the absolute values of the importance for this feature. + /// /// [JsonInclude, JsonPropertyName("mean_magnitude")] public double MeanMagnitude { get; init; } /// - /// The minimum importance value across all the training data for this feature. + /// + /// The minimum importance value across all the training data for this feature. + /// /// [JsonInclude, JsonPropertyName("min")] public int Min { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModel.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModel.g.cs index df5a3d8ad4d..51214bbbb67 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModel.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModel.g.cs @@ -30,19 +30,38 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class TrainedModel { /// - /// The definition for an ensemble model + /// + /// The definition for an ensemble model + /// /// [JsonInclude, JsonPropertyName("ensemble")] public Elastic.Clients.Elasticsearch.MachineLearning.Ensemble? Ensemble { get; set; } /// - /// The definition for a binary decision tree. + /// + /// The definition for a binary decision tree. + /// /// [JsonInclude, JsonPropertyName("tree")] public Elastic.Clients.Elasticsearch.MachineLearning.TrainedModelTree? Tree { get; set; } /// - /// The definition of a node in a tree.
There are two major types of nodes: leaf nodes and not-leaf nodes.
- Leaf nodes only need node_index and leaf_value defined.
- All other nodes need split_feature, left_child, right_child, threshold, decision_type, and default_left defined. + /// + /// The definition of a node in a tree. + /// There are two major types of nodes: leaf nodes and not-leaf nodes. + /// + /// + /// + /// + /// Leaf nodes only need node_index and leaf_value defined. + /// + /// + /// + /// + /// All other nodes need split_feature, left_child, right_child, threshold, decision_type, and default_left defined. + /// + /// + /// /// [JsonInclude, JsonPropertyName("tree_node")] public Elastic.Clients.Elasticsearch.MachineLearning.TrainedModelTreeNode? TreeNode { get; set; } @@ -67,7 +86,9 @@ public TrainedModelDescriptor() : base() private Action TreeNodeDescriptorAction { get; set; } /// - /// The definition for an ensemble model + /// + /// The definition for an ensemble model + /// /// public TrainedModelDescriptor Ensemble(Elastic.Clients.Elasticsearch.MachineLearning.Ensemble? ensemble) { @@ -94,7 +115,9 @@ public TrainedModelDescriptor Ensemble(Action - /// The definition for a binary decision tree. + /// + /// The definition for a binary decision tree. + /// /// public TrainedModelDescriptor Tree(Elastic.Clients.Elasticsearch.MachineLearning.TrainedModelTree? tree) { @@ -121,7 +144,22 @@ public TrainedModelDescriptor Tree(Action - /// The definition of a node in a tree.
There are two major types of nodes: leaf nodes and not-leaf nodes.
- Leaf nodes only need node_index and leaf_value defined.
- All other nodes need split_feature, left_child, right_child, threshold, decision_type, and default_left defined. + /// + /// The definition of a node in a tree. + /// There are two major types of nodes: leaf nodes and not-leaf nodes. + /// + /// + /// + /// + /// Leaf nodes only need node_index and leaf_value defined. + /// + /// + /// + /// + /// All other nodes need split_feature, left_child, right_child, threshold, decision_type, and default_left defined. + /// + /// + /// /// public TrainedModelDescriptor TreeNode(Elastic.Clients.Elasticsearch.MachineLearning.TrainedModelTreeNode? treeNode) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelAssignment.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelAssignment.g.cs index 1a91d2d7ec4..9f78ed9ab12 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelAssignment.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelAssignment.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class TrainedModelAssignment { /// - /// The overall assignment state. + /// + /// The overall assignment state. + /// /// [JsonInclude, JsonPropertyName("assignment_state")] public Elastic.Clients.Elasticsearch.MachineLearning.DeploymentAssignmentState AssignmentState { get; init; } @@ -38,13 +40,17 @@ public sealed partial class TrainedModelAssignment public int? MaxAssignedAllocations { get; init; } /// - /// The allocation state for each node. + /// + /// The allocation state for each node. + /// /// [JsonInclude, JsonPropertyName("routing_table")] public IReadOnlyDictionary RoutingTable { get; init; } /// - /// The timestamp when the deployment started. + /// + /// The timestamp when the deployment started. + /// /// [JsonInclude, JsonPropertyName("start_time")] public DateTimeOffset StartTime { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelAssignmentRoutingTable.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelAssignmentRoutingTable.g.cs index 77db1bb2faf..c058b16e852 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelAssignmentRoutingTable.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelAssignmentRoutingTable.g.cs @@ -30,25 +30,34 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class TrainedModelAssignmentRoutingTable { /// - /// Current number of allocations. + /// + /// Current number of allocations. + /// /// [JsonInclude, JsonPropertyName("current_allocations")] public int CurrentAllocations { get; init; } /// - /// The reason for the current state. It is usually populated only when the
`routing_state` is `failed`. + /// + /// The reason for the current state. It is usually populated only when the + /// routing_state is failed. + /// /// [JsonInclude, JsonPropertyName("reason")] public string Reason { get; init; } /// - /// The current routing state. + /// + /// The current routing state. + /// /// [JsonInclude, JsonPropertyName("routing_state")] public Elastic.Clients.Elasticsearch.MachineLearning.RoutingState RoutingState { get; init; } /// - /// Target number of allocations. + /// + /// Target number of allocations. + /// /// [JsonInclude, JsonPropertyName("target_allocations")] public int TargetAllocations { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelAssignmentTaskParameters.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelAssignmentTaskParameters.g.cs index ffcdf9cbfff..064ca46487f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelAssignmentTaskParameters.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelAssignmentTaskParameters.g.cs @@ -30,31 +30,41 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class TrainedModelAssignmentTaskParameters { /// - /// The size of the trained model cache. + /// + /// The size of the trained model cache. + /// /// [JsonInclude, JsonPropertyName("cache_size")] public Elastic.Clients.Elasticsearch.ByteSize CacheSize { get; init; } /// - /// The unique identifier for the trained model deployment. + /// + /// The unique identifier for the trained model deployment. + /// /// [JsonInclude, JsonPropertyName("deployment_id")] public string DeploymentId { get; init; } /// - /// The size of the trained model in bytes. + /// + /// The size of the trained model in bytes. + /// /// [JsonInclude, JsonPropertyName("model_bytes")] public int ModelBytes { get; init; } /// - /// The unique identifier for the trained model. + /// + /// The unique identifier for the trained model. + /// /// [JsonInclude, JsonPropertyName("model_id")] public string ModelId { get; init; } /// - /// The total number of allocations this model is assigned across ML nodes. + /// + /// The total number of allocations this model is assigned across ML nodes. + /// /// [JsonInclude, JsonPropertyName("number_of_allocations")] public int NumberOfAllocations { get; init; } @@ -62,13 +72,17 @@ public sealed partial class TrainedModelAssignmentTaskParameters public Elastic.Clients.Elasticsearch.MachineLearning.TrainingPriority Priority { get; init; } /// - /// Number of inference requests are allowed in the queue at a time. + /// + /// Number of inference requests are allowed in the queue at a time. + /// /// [JsonInclude, JsonPropertyName("queue_capacity")] public int QueueCapacity { get; init; } /// - /// Number of threads per allocation. + /// + /// Number of threads per allocation. + /// /// [JsonInclude, JsonPropertyName("threads_per_allocation")] public int ThreadsPerAllocation { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelConfig.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelConfig.g.cs index 5dcaeacd2b4..138c6aeec82 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelConfig.g.cs @@ -33,61 +33,81 @@ public sealed partial class TrainedModelConfig public string? CompressedDefinition { get; init; } /// - /// Information on the creator of the trained model. + /// + /// Information on the creator of the trained model. + /// /// [JsonInclude, JsonPropertyName("created_by")] public string? CreatedBy { get; init; } /// - /// The time when the trained model was created. + /// + /// The time when the trained model was created. + /// /// [JsonInclude, JsonPropertyName("create_time")] public DateTimeOffset? CreateTime { get; init; } /// - /// Any field map described in the inference configuration takes precedence. + /// + /// Any field map described in the inference configuration takes precedence. + /// /// [JsonInclude, JsonPropertyName("default_field_map")] public IReadOnlyDictionary? DefaultFieldMap { get; init; } /// - /// The free-text description of the trained model. + /// + /// The free-text description of the trained model. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; init; } /// - /// The estimated heap usage in bytes to keep the trained model in memory. + /// + /// The estimated heap usage in bytes to keep the trained model in memory. + /// /// [JsonInclude, JsonPropertyName("estimated_heap_memory_usage_bytes")] public int? EstimatedHeapMemoryUsageBytes { get; init; } /// - /// The estimated number of operations to use the trained model. + /// + /// The estimated number of operations to use the trained model. + /// /// [JsonInclude, JsonPropertyName("estimated_operations")] public int? EstimatedOperations { get; init; } /// - /// True if the full model definition is present. + /// + /// True if the full model definition is present. + /// /// [JsonInclude, JsonPropertyName("fully_defined")] public bool? FullyDefined { get; init; } /// - /// The default configuration for inference. This can be either a regression, classification, or one of the many NLP focused configurations. It must match the underlying definition.trained_model's target_type. For pre-packaged models such as ELSER the config is not required. + /// + /// The default configuration for inference. This can be either a regression, classification, or one of the many NLP focused configurations. It must match the underlying definition.trained_model's target_type. For pre-packaged models such as ELSER the config is not required. + /// /// [JsonInclude, JsonPropertyName("inference_config")] public Elastic.Clients.Elasticsearch.MachineLearning.InferenceConfigCreate? InferenceConfig { get; init; } /// - /// The input field names for the model definition. + /// + /// The input field names for the model definition. + /// /// [JsonInclude, JsonPropertyName("input")] public Elastic.Clients.Elasticsearch.MachineLearning.TrainedModelConfigInput Input { get; init; } /// - /// The license level of the trained model. + /// + /// The license level of the trained model. + /// /// [JsonInclude, JsonPropertyName("license_level")] public string? LicenseLevel { get; init; } @@ -95,13 +115,17 @@ public sealed partial class TrainedModelConfig public Elastic.Clients.Elasticsearch.MachineLearning.TrainedModelLocation? Location { get; init; } /// - /// An object containing metadata about the trained model. For example, models created by data frame analytics contain analysis_config and input objects. + /// + /// An object containing metadata about the trained model. For example, models created by data frame analytics contain analysis_config and input objects. + /// /// [JsonInclude, JsonPropertyName("metadata")] public Elastic.Clients.Elasticsearch.MachineLearning.TrainedModelConfigMetadata? Metadata { get; init; } /// - /// Identifier for the trained model. + /// + /// Identifier for the trained model. + /// /// [JsonInclude, JsonPropertyName("model_id")] public string ModelId { get; init; } @@ -109,7 +133,9 @@ public sealed partial class TrainedModelConfig public Elastic.Clients.Elasticsearch.ByteSize? ModelSizeBytes { get; init; } /// - /// The model type + /// + /// The model type + /// /// [JsonInclude, JsonPropertyName("model_type")] public Elastic.Clients.Elasticsearch.MachineLearning.TrainedModelType? ModelType { get; init; } @@ -117,13 +143,17 @@ public sealed partial class TrainedModelConfig public Elastic.Clients.Elasticsearch.MachineLearning.TrainedModelPrefixStrings? PrefixStrings { get; init; } /// - /// A comma delimited string of tags. A trained model can have many tags, or none. + /// + /// A comma delimited string of tags. A trained model can have many tags, or none. + /// /// [JsonInclude, JsonPropertyName("tags")] public IReadOnlyCollection Tags { get; init; } /// - /// The Elasticsearch version number in which the trained model was created. + /// + /// The Elasticsearch version number in which the trained model was created. + /// /// [JsonInclude, JsonPropertyName("version")] public string? Version { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelConfigInput.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelConfigInput.g.cs index 36e3acd3c03..381a787e0fa 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelConfigInput.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelConfigInput.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class TrainedModelConfigInput { /// - /// An array of input field names for the model. + /// + /// An array of input field names for the model. + /// /// [JsonInclude, JsonPropertyName("field_names")] public IReadOnlyCollection FieldNames { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelConfigMetadata.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelConfigMetadata.g.cs index 4bc5c9a095f..f53c2df3bd2 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelConfigMetadata.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelConfigMetadata.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class TrainedModelConfigMetadata { /// - /// An object that contains the baseline for feature importance values. For regression analysis, it is a single value. For classification analysis, there is a value for each class. + /// + /// An object that contains the baseline for feature importance values. For regression analysis, it is a single value. For classification analysis, there is a value for each class. + /// /// [JsonInclude, JsonPropertyName("feature_importance_baseline")] public IReadOnlyDictionary? FeatureImportanceBaseline { get; init; } /// - /// List of the available hyperparameters optimized during the fine_parameter_tuning phase as well as specified by the user. + /// + /// List of the available hyperparameters optimized during the fine_parameter_tuning phase as well as specified by the user. + /// /// [JsonInclude, JsonPropertyName("hyperparameters")] public IReadOnlyCollection? Hyperparameters { get; init; } @@ -44,7 +48,9 @@ public sealed partial class TrainedModelConfigMetadata public IReadOnlyCollection? ModelAliases { get; init; } /// - /// An array of the total feature importance for each feature used from the training data set. This array of objects is returned if data frame analytics trained the model and the request includes total_feature_importance in the include request parameter. + /// + /// An array of the total feature importance for each feature used from the training data set. This array of objects is returned if data frame analytics trained the model and the request includes total_feature_importance in the include request parameter. + /// /// [JsonInclude, JsonPropertyName("total_feature_importance")] public IReadOnlyCollection? TotalFeatureImportance { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelDeploymentAllocationStatus.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelDeploymentAllocationStatus.g.cs index b380686ff0e..3eba4c44990 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelDeploymentAllocationStatus.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelDeploymentAllocationStatus.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class TrainedModelDeploymentAllocationStatus { /// - /// The current number of nodes where the model is allocated. + /// + /// The current number of nodes where the model is allocated. + /// /// [JsonInclude, JsonPropertyName("allocation_count")] public int AllocationCount { get; init; } /// - /// The detailed allocation state related to the nodes. + /// + /// The detailed allocation state related to the nodes. + /// /// [JsonInclude, JsonPropertyName("state")] public Elastic.Clients.Elasticsearch.MachineLearning.DeploymentAllocationState State { get; init; } /// - /// The desired number of nodes for model allocation. + /// + /// The desired number of nodes for model allocation. + /// /// [JsonInclude, JsonPropertyName("target_allocation_count")] public int TargetAllocationCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelDeploymentNodesStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelDeploymentNodesStats.g.cs index 10d6e8bde1f..71824251d6b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelDeploymentNodesStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelDeploymentNodesStats.g.cs @@ -30,73 +30,97 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class TrainedModelDeploymentNodesStats { /// - /// The average time for each inference call to complete on this node. + /// + /// The average time for each inference call to complete on this node. + /// /// [JsonInclude, JsonPropertyName("average_inference_time_ms")] public double AverageInferenceTimeMs { get; init; } /// - /// The number of errors when evaluating the trained model. + /// + /// The number of errors when evaluating the trained model. + /// /// [JsonInclude, JsonPropertyName("error_count")] public int ErrorCount { get; init; } /// - /// The total number of inference calls made against this node for this model. + /// + /// The total number of inference calls made against this node for this model. + /// /// [JsonInclude, JsonPropertyName("inference_count")] public int InferenceCount { get; init; } /// - /// The epoch time stamp of the last inference call for the model on this node. + /// + /// The epoch time stamp of the last inference call for the model on this node. + /// /// [JsonInclude, JsonPropertyName("last_access")] public long LastAccess { get; init; } /// - /// Information pertaining to the node. + /// + /// Information pertaining to the node. + /// /// [JsonInclude, JsonPropertyName("node")] public Elastic.Clients.Elasticsearch.MachineLearning.DiscoveryNode Node { get; init; } /// - /// The number of allocations assigned to this node. + /// + /// The number of allocations assigned to this node. + /// /// [JsonInclude, JsonPropertyName("number_of_allocations")] public int NumberOfAllocations { get; init; } /// - /// The number of inference requests queued to be processed. + /// + /// The number of inference requests queued to be processed. + /// /// [JsonInclude, JsonPropertyName("number_of_pending_requests")] public int NumberOfPendingRequests { get; init; } /// - /// The number of inference requests that were not processed because the queue was full. + /// + /// The number of inference requests that were not processed because the queue was full. + /// /// [JsonInclude, JsonPropertyName("rejection_execution_count")] public int RejectionExecutionCount { get; init; } /// - /// The current routing state and reason for the current routing state for this allocation. + /// + /// The current routing state and reason for the current routing state for this allocation. + /// /// [JsonInclude, JsonPropertyName("routing_state")] public Elastic.Clients.Elasticsearch.MachineLearning.TrainedModelAssignmentRoutingTable RoutingState { get; init; } /// - /// The epoch timestamp when the allocation started. + /// + /// The epoch timestamp when the allocation started. + /// /// [JsonInclude, JsonPropertyName("start_time")] public long StartTime { get; init; } /// - /// The number of threads used by each allocation during inference. + /// + /// The number of threads used by each allocation during inference. + /// /// [JsonInclude, JsonPropertyName("threads_per_allocation")] public int ThreadsPerAllocation { get; init; } /// - /// The number of inference requests that timed out before being processed. + /// + /// The number of inference requests that timed out before being processed. + /// /// [JsonInclude, JsonPropertyName("timeout_count")] public int TimeoutCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelDeploymentStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelDeploymentStats.g.cs index b8936f544fe..574d5e31fc4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelDeploymentStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelDeploymentStats.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class TrainedModelDeploymentStats { /// - /// The detailed allocation status for the deployment. + /// + /// The detailed allocation status for the deployment. + /// /// [JsonInclude, JsonPropertyName("allocation_status")] public Elastic.Clients.Elasticsearch.MachineLearning.TrainedModelDeploymentAllocationStatus AllocationStatus { get; init; } @@ -38,79 +40,110 @@ public sealed partial class TrainedModelDeploymentStats public Elastic.Clients.Elasticsearch.ByteSize? CacheSize { get; init; } /// - /// The unique identifier for the trained model deployment. + /// + /// The unique identifier for the trained model deployment. + /// /// [JsonInclude, JsonPropertyName("deployment_id")] public string DeploymentId { get; init; } /// - /// The sum of `error_count` for all nodes in the deployment. + /// + /// The sum of error_count for all nodes in the deployment. + /// /// [JsonInclude, JsonPropertyName("error_count")] public int ErrorCount { get; init; } /// - /// The sum of `inference_count` for all nodes in the deployment. + /// + /// The sum of inference_count for all nodes in the deployment. + /// /// [JsonInclude, JsonPropertyName("inference_count")] public int InferenceCount { get; init; } /// - /// The unique identifier for the trained model. + /// + /// The unique identifier for the trained model. + /// /// [JsonInclude, JsonPropertyName("model_id")] public string ModelId { get; init; } /// - /// The deployment stats for each node that currently has the model allocated.
In serverless, stats are reported for a single unnamed virtual node. + /// + /// The deployment stats for each node that currently has the model allocated. + /// In serverless, stats are reported for a single unnamed virtual node. + /// /// [JsonInclude, JsonPropertyName("nodes")] public IReadOnlyCollection Nodes { get; init; } /// - /// The number of allocations requested. + /// + /// The number of allocations requested. + /// /// [JsonInclude, JsonPropertyName("number_of_allocations")] public int NumberOfAllocations { get; init; } /// - /// The number of inference requests that can be queued before new requests are rejected. + /// + /// The number of inference requests that can be queued before new requests are rejected. + /// /// [JsonInclude, JsonPropertyName("queue_capacity")] public int QueueCapacity { get; init; } /// - /// The reason for the current deployment state. Usually only populated when
the model is not deployed to a node. + /// + /// The reason for the current deployment state. Usually only populated when + /// the model is not deployed to a node. + /// /// [JsonInclude, JsonPropertyName("reason")] public string Reason { get; init; } /// - /// The sum of `rejected_execution_count` for all nodes in the deployment.
Individual nodes reject an inference request if the inference queue is full.
The queue size is controlled by the `queue_capacity` setting in the start
trained model deployment API. + /// + /// The sum of rejected_execution_count for all nodes in the deployment. + /// Individual nodes reject an inference request if the inference queue is full. + /// The queue size is controlled by the queue_capacity setting in the start + /// trained model deployment API. + /// /// [JsonInclude, JsonPropertyName("rejected_execution_count")] public int RejectedExecutionCount { get; init; } /// - /// The epoch timestamp when the deployment started. + /// + /// The epoch timestamp when the deployment started. + /// /// [JsonInclude, JsonPropertyName("start_time")] public long StartTime { get; init; } /// - /// The overall state of the deployment. + /// + /// The overall state of the deployment. + /// /// [JsonInclude, JsonPropertyName("state")] public Elastic.Clients.Elasticsearch.MachineLearning.DeploymentState State { get; init; } /// - /// The number of threads used be each allocation during inference. + /// + /// The number of threads used be each allocation during inference. + /// /// [JsonInclude, JsonPropertyName("threads_per_allocation")] public int ThreadsPerAllocation { get; init; } /// - /// The sum of `timeout_count` for all nodes in the deployment. + /// + /// The sum of timeout_count for all nodes in the deployment. + /// /// [JsonInclude, JsonPropertyName("timeout_count")] public int TimeoutCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelInferenceStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelInferenceStats.g.cs index d33c7e33a13..2d95a8bd78f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelInferenceStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelInferenceStats.g.cs @@ -30,31 +30,45 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class TrainedModelInferenceStats { /// - /// The number of times the model was loaded for inference and was not retrieved from the cache.
If this number is close to the `inference_count`, the cache is not being appropriately used.
This can be solved by increasing the cache size or its time-to-live (TTL).
Refer to general machine learning settings for the appropriate settings. + /// + /// The number of times the model was loaded for inference and was not retrieved from the cache. + /// If this number is close to the inference_count, the cache is not being appropriately used. + /// This can be solved by increasing the cache size or its time-to-live (TTL). + /// Refer to general machine learning settings for the appropriate settings. + /// /// [JsonInclude, JsonPropertyName("cache_miss_count")] public int CacheMissCount { get; init; } /// - /// The number of failures when using the model for inference. + /// + /// The number of failures when using the model for inference. + /// /// [JsonInclude, JsonPropertyName("failure_count")] public int FailureCount { get; init; } /// - /// The total number of times the model has been called for inference.
This is across all inference contexts, including all pipelines. + /// + /// The total number of times the model has been called for inference. + /// This is across all inference contexts, including all pipelines. + /// /// [JsonInclude, JsonPropertyName("inference_count")] public int InferenceCount { get; init; } /// - /// The number of inference calls where all the training features for the model were missing. + /// + /// The number of inference calls where all the training features for the model were missing. + /// /// [JsonInclude, JsonPropertyName("missing_all_fields_count")] public int MissingAllFieldsCount { get; init; } /// - /// The time when the statistics were last updated. + /// + /// The time when the statistics were last updated. + /// /// [JsonInclude, JsonPropertyName("timestamp")] public long Timestamp { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelPrefixStrings.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelPrefixStrings.g.cs index fe03bea4662..65407e2243c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelPrefixStrings.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelPrefixStrings.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class TrainedModelPrefixStrings { /// - /// String prepended to input at ingest + /// + /// String prepended to input at ingest + /// /// [JsonInclude, JsonPropertyName("ingest")] public string? Ingest { get; set; } /// - /// String prepended to input at search + /// + /// String prepended to input at search + /// /// [JsonInclude, JsonPropertyName("search")] public string? Search { get; set; } @@ -54,7 +58,9 @@ public TrainedModelPrefixStringsDescriptor() : base() private string? SearchValue { get; set; } /// - /// String prepended to input at ingest + /// + /// String prepended to input at ingest + /// /// public TrainedModelPrefixStringsDescriptor Ingest(string? ingest) { @@ -63,7 +69,9 @@ public TrainedModelPrefixStringsDescriptor Ingest(string? ingest) } /// - /// String prepended to input at search + /// + /// String prepended to input at search + /// /// public TrainedModelPrefixStringsDescriptor Search(string? search) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelSizeStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelSizeStats.g.cs index e72cd54c8b5..7048a148aa7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelSizeStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelSizeStats.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class TrainedModelSizeStats { /// - /// The size of the model in bytes. + /// + /// The size of the model in bytes. + /// /// [JsonInclude, JsonPropertyName("model_size_bytes")] public Elastic.Clients.Elasticsearch.ByteSize ModelSizeBytes { get; init; } /// - /// The amount of memory required to load the model in bytes. + /// + /// The amount of memory required to load the model in bytes. + /// /// [JsonInclude, JsonPropertyName("required_native_memory_bytes")] public Elastic.Clients.Elasticsearch.ByteSize RequiredNativeMemoryBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelStats.g.cs index 86303dea7e3..71aee4afa81 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelStats.g.cs @@ -30,37 +30,51 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class TrainedModelStats { /// - /// A collection of deployment stats, which is present when the models are deployed. + /// + /// A collection of deployment stats, which is present when the models are deployed. + /// /// [JsonInclude, JsonPropertyName("deployment_stats")] public Elastic.Clients.Elasticsearch.MachineLearning.TrainedModelDeploymentStats? DeploymentStats { get; init; } /// - /// A collection of inference stats fields. + /// + /// A collection of inference stats fields. + /// /// [JsonInclude, JsonPropertyName("inference_stats")] public Elastic.Clients.Elasticsearch.MachineLearning.TrainedModelInferenceStats? InferenceStats { get; init; } /// - /// A collection of ingest stats for the model across all nodes.
The values are summations of the individual node statistics.
The format matches the ingest section in the nodes stats API. + /// + /// A collection of ingest stats for the model across all nodes. + /// The values are summations of the individual node statistics. + /// The format matches the ingest section in the nodes stats API. + /// /// [JsonInclude, JsonPropertyName("ingest")] public IReadOnlyDictionary? Ingest { get; init; } /// - /// The unique identifier of the trained model. + /// + /// The unique identifier of the trained model. + /// /// [JsonInclude, JsonPropertyName("model_id")] public string ModelId { get; init; } /// - /// A collection of model size stats. + /// + /// A collection of model size stats. + /// /// [JsonInclude, JsonPropertyName("model_size_stats")] public Elastic.Clients.Elasticsearch.MachineLearning.TrainedModelSizeStats ModelSizeStats { get; init; } /// - /// The number of ingest pipelines that currently refer to the model. + /// + /// The number of ingest pipelines that currently refer to the model. + /// /// [JsonInclude, JsonPropertyName("pipeline_count")] public int PipelineCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TransformAuthorization.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TransformAuthorization.g.cs index 1fce308f268..c21114cb7a3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TransformAuthorization.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TransformAuthorization.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class TransformAuthorization { /// - /// If an API key was used for the most recent update to the transform, its name and identifier are listed in the response. + /// + /// If an API key was used for the most recent update to the transform, its name and identifier are listed in the response. + /// /// [JsonInclude, JsonPropertyName("api_key")] public Elastic.Clients.Elasticsearch.MachineLearning.ApiKeyAuthorization? ApiKey { get; init; } /// - /// If a user ID was used for the most recent update to the transform, its roles at the time of the update are listed in the response. + /// + /// If a user ID was used for the most recent update to the transform, its roles at the time of the update are listed in the response. + /// /// [JsonInclude, JsonPropertyName("roles")] public IReadOnlyCollection? Roles { get; init; } /// - /// If a service account was used for the most recent update to the transform, the account name is listed in the response. + /// + /// If a service account was used for the most recent update to the transform, the account name is listed in the response. + /// /// [JsonInclude, JsonPropertyName("service_account")] public string? ServiceAccount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ZeroShotClassificationInferenceOptions.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ZeroShotClassificationInferenceOptions.g.cs index 6960aa6a361..92693735a72 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ZeroShotClassificationInferenceOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ZeroShotClassificationInferenceOptions.g.cs @@ -28,42 +28,57 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; /// -/// Zero shot classification configuration options +/// +/// Zero shot classification configuration options +/// /// public sealed partial class ZeroShotClassificationInferenceOptions { /// - /// The zero shot classification labels indicating entailment, neutral, and contradiction
Must contain exactly and only entailment, neutral, and contradiction + /// + /// The zero shot classification labels indicating entailment, neutral, and contradiction + /// Must contain exactly and only entailment, neutral, and contradiction + /// /// [JsonInclude, JsonPropertyName("classification_labels")] public ICollection ClassificationLabels { get; set; } /// - /// Hypothesis template used when tokenizing labels for prediction + /// + /// Hypothesis template used when tokenizing labels for prediction + /// /// [JsonInclude, JsonPropertyName("hypothesis_template")] public string? HypothesisTemplate { get; set; } /// - /// The labels to predict. + /// + /// The labels to predict. + /// /// [JsonInclude, JsonPropertyName("labels")] public ICollection? Labels { get; set; } /// - /// Indicates if more than one true label exists. + /// + /// Indicates if more than one true label exists. + /// /// [JsonInclude, JsonPropertyName("multi_label")] public bool? MultiLabel { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.MachineLearning.TokenizationConfig? Tokenization { get; set; } @@ -72,7 +87,9 @@ public sealed partial class ZeroShotClassificationInferenceOptions } /// -/// Zero shot classification configuration options +/// +/// Zero shot classification configuration options +/// /// public sealed partial class ZeroShotClassificationInferenceOptionsDescriptor : SerializableDescriptor { @@ -92,7 +109,10 @@ public ZeroShotClassificationInferenceOptionsDescriptor() : base() private Action TokenizationDescriptorAction { get; set; } /// - /// The zero shot classification labels indicating entailment, neutral, and contradiction
Must contain exactly and only entailment, neutral, and contradiction + /// + /// The zero shot classification labels indicating entailment, neutral, and contradiction + /// Must contain exactly and only entailment, neutral, and contradiction + /// /// public ZeroShotClassificationInferenceOptionsDescriptor ClassificationLabels(ICollection classificationLabels) { @@ -101,7 +121,9 @@ public ZeroShotClassificationInferenceOptionsDescriptor ClassificationLabels(ICo } /// - /// Hypothesis template used when tokenizing labels for prediction + /// + /// Hypothesis template used when tokenizing labels for prediction + /// /// public ZeroShotClassificationInferenceOptionsDescriptor HypothesisTemplate(string? hypothesisTemplate) { @@ -110,7 +132,9 @@ public ZeroShotClassificationInferenceOptionsDescriptor HypothesisTemplate(strin } /// - /// The labels to predict. + /// + /// The labels to predict. + /// /// public ZeroShotClassificationInferenceOptionsDescriptor Labels(ICollection? labels) { @@ -119,7 +143,9 @@ public ZeroShotClassificationInferenceOptionsDescriptor Labels(ICollection - /// Indicates if more than one true label exists. + /// + /// Indicates if more than one true label exists. + /// /// public ZeroShotClassificationInferenceOptionsDescriptor MultiLabel(bool? multiLabel = true) { @@ -128,7 +154,9 @@ public ZeroShotClassificationInferenceOptionsDescriptor MultiLabel(bool? multiLa } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public ZeroShotClassificationInferenceOptionsDescriptor ResultsField(string? resultsField) { @@ -137,7 +165,9 @@ public ZeroShotClassificationInferenceOptionsDescriptor ResultsField(string? res } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// public ZeroShotClassificationInferenceOptionsDescriptor Tokenization(Elastic.Clients.Elasticsearch.MachineLearning.TokenizationConfig? tokenization) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ZeroShotClassificationInferenceUpdateOptions.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ZeroShotClassificationInferenceUpdateOptions.g.cs index 611d5254469..d42a5777652 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ZeroShotClassificationInferenceUpdateOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ZeroShotClassificationInferenceUpdateOptions.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class ZeroShotClassificationInferenceUpdateOptions { /// - /// The labels to predict. + /// + /// The labels to predict. + /// /// [JsonInclude, JsonPropertyName("labels")] public ICollection Labels { get; set; } /// - /// Update the configured multi label option. Indicates if more than one true label exists. Defaults to the configured value. + /// + /// Update the configured multi label option. Indicates if more than one true label exists. Defaults to the configured value. + /// /// [JsonInclude, JsonPropertyName("multi_label")] public bool? MultiLabel { get; set; } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// [JsonInclude, JsonPropertyName("results_field")] public string? ResultsField { get; set; } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.MachineLearning.NlpTokenizationUpdateOptions? Tokenization { get; set; } @@ -72,7 +80,9 @@ public ZeroShotClassificationInferenceUpdateOptionsDescriptor() : base() private Action TokenizationDescriptorAction { get; set; } /// - /// The labels to predict. + /// + /// The labels to predict. + /// /// public ZeroShotClassificationInferenceUpdateOptionsDescriptor Labels(ICollection labels) { @@ -81,7 +91,9 @@ public ZeroShotClassificationInferenceUpdateOptionsDescriptor Labels(ICollection } /// - /// Update the configured multi label option. Indicates if more than one true label exists. Defaults to the configured value. + /// + /// Update the configured multi label option. Indicates if more than one true label exists. Defaults to the configured value. + /// /// public ZeroShotClassificationInferenceUpdateOptionsDescriptor MultiLabel(bool? multiLabel = true) { @@ -90,7 +102,9 @@ public ZeroShotClassificationInferenceUpdateOptionsDescriptor MultiLabel(bool? m } /// - /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// + /// The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + /// /// public ZeroShotClassificationInferenceUpdateOptionsDescriptor ResultsField(string? resultsField) { @@ -99,7 +113,9 @@ public ZeroShotClassificationInferenceUpdateOptionsDescriptor ResultsField(strin } /// - /// The tokenization options to update when inferring + /// + /// The tokenization options to update when inferring + /// /// public ZeroShotClassificationInferenceUpdateOptionsDescriptor Tokenization(Elastic.Clients.Elasticsearch.MachineLearning.NlpTokenizationUpdateOptions? tokenization) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/AggregateMetricDoubleProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/AggregateMetricDoubleProperty.g.cs index dd81037948b..b9d6ba63c8b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/AggregateMetricDoubleProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/AggregateMetricDoubleProperty.g.cs @@ -39,7 +39,9 @@ public sealed partial class AggregateMetricDoubleProperty : IProperty public int? IgnoreAbove { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -110,7 +112,9 @@ public AggregateMetricDoublePropertyDescriptor IgnoreAbove(int? ignor } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public AggregateMetricDoublePropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -267,7 +271,9 @@ public AggregateMetricDoublePropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public AggregateMetricDoublePropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/BinaryProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/BinaryProperty.g.cs index a7e917b0c28..22981021119 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/BinaryProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/BinaryProperty.g.cs @@ -42,7 +42,9 @@ public sealed partial class BinaryProperty : IProperty public int? IgnoreAbove { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -120,7 +122,9 @@ public BinaryPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public BinaryPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -299,7 +303,9 @@ public BinaryPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public BinaryPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/BooleanProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/BooleanProperty.g.cs index 61eacc24813..605c2858d33 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/BooleanProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/BooleanProperty.g.cs @@ -48,7 +48,9 @@ public sealed partial class BooleanProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -170,7 +172,9 @@ public BooleanPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public BooleanPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -459,7 +463,9 @@ public BooleanPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public BooleanPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/ByteNumberProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/ByteNumberProperty.g.cs index 13dde451e02..826436403cd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/ByteNumberProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/ByteNumberProperty.g.cs @@ -50,7 +50,9 @@ public sealed partial class ByteNumberProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -68,13 +70,17 @@ public sealed partial class ByteNumberProperty : IProperty public bool? Store { get; set; } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// [JsonInclude, JsonPropertyName("time_series_dimension")] public bool? TimeSeriesDimension { get; set; } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// [JsonInclude, JsonPropertyName("time_series_metric")] public Elastic.Clients.Elasticsearch.Mapping.TimeSeriesMetricType? TimeSeriesMetric { get; set; } @@ -181,7 +187,9 @@ public ByteNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public ByteNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -258,7 +266,9 @@ public ByteNumberPropertyDescriptor Store(bool? store = true) } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public ByteNumberPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimension = true) { @@ -267,7 +277,9 @@ public ByteNumberPropertyDescriptor TimeSeriesDimension(bool? timeSer } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public ByteNumberPropertyDescriptor TimeSeriesMetric(Elastic.Clients.Elasticsearch.Mapping.TimeSeriesMetricType? timeSeriesMetric) { @@ -546,7 +558,9 @@ public ByteNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public ByteNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -623,7 +637,9 @@ public ByteNumberPropertyDescriptor Store(bool? store = true) } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public ByteNumberPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimension = true) { @@ -632,7 +648,9 @@ public ByteNumberPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimensio } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public ByteNumberPropertyDescriptor TimeSeriesMetric(Elastic.Clients.Elasticsearch.Mapping.TimeSeriesMetricType? timeSeriesMetric) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/CompletionProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/CompletionProperty.g.cs index 76d33e5ce91..1c9c659c93c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/CompletionProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/CompletionProperty.g.cs @@ -48,7 +48,9 @@ public sealed partial class CompletionProperty : IProperty public int? MaxInputLength { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -189,7 +191,9 @@ public CompletionPropertyDescriptor MaxInputLength(int? maxInputLengt } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public CompletionPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -534,7 +538,9 @@ public CompletionPropertyDescriptor MaxInputLength(int? maxInputLength) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public CompletionPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/ConstantKeywordProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/ConstantKeywordProperty.g.cs index e0da25347f8..aa3097fd7bf 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/ConstantKeywordProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/ConstantKeywordProperty.g.cs @@ -37,7 +37,9 @@ public sealed partial class ConstantKeywordProperty : IProperty public int? IgnoreAbove { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -99,7 +101,9 @@ public ConstantKeywordPropertyDescriptor IgnoreAbove(int? ignoreAbove } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public ConstantKeywordPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -236,7 +240,9 @@ public ConstantKeywordPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public ConstantKeywordPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/DateNanosProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/DateNanosProperty.g.cs index 1837edc57bc..8ee6c4ee1ce 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/DateNanosProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/DateNanosProperty.g.cs @@ -50,7 +50,9 @@ public sealed partial class DateNanosProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -162,7 +164,9 @@ public DateNanosPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public DateNanosPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -425,7 +429,9 @@ public DateNanosPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public DateNanosPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/DateProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/DateProperty.g.cs index 731360bb852..b776931d1b0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/DateProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/DateProperty.g.cs @@ -54,7 +54,9 @@ public sealed partial class DateProperty : IProperty public string? Locale { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -200,7 +202,9 @@ public DatePropertyDescriptor Locale(string? locale) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public DatePropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -545,7 +549,9 @@ public DatePropertyDescriptor Locale(string? locale) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public DatePropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/DateRangeProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/DateRangeProperty.g.cs index fb55e5a8407..e2ffd332a6b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/DateRangeProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/DateRangeProperty.g.cs @@ -50,7 +50,9 @@ public sealed partial class DateRangeProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -156,7 +158,9 @@ public DateRangePropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public DateRangePropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -391,7 +395,9 @@ public DateRangePropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public DateRangePropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/DenseVectorProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/DenseVectorProperty.g.cs index 5234147736b..4484f144eef 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/DenseVectorProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/DenseVectorProperty.g.cs @@ -45,7 +45,9 @@ public sealed partial class DenseVectorProperty : IProperty public Elastic.Clients.Elasticsearch.Mapping.DenseVectorIndexOptions? IndexOptions { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -154,7 +156,9 @@ public DenseVectorPropertyDescriptor IndexOptions(Action - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public DenseVectorPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -401,7 +405,9 @@ public DenseVectorPropertyDescriptor IndexOptions(Action - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public DenseVectorPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/DoubleNumberProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/DoubleNumberProperty.g.cs index ddd63ad6d5a..0d27abf2227 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/DoubleNumberProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/DoubleNumberProperty.g.cs @@ -50,7 +50,9 @@ public sealed partial class DoubleNumberProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -68,13 +70,17 @@ public sealed partial class DoubleNumberProperty : IProperty public bool? Store { get; set; } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// [JsonInclude, JsonPropertyName("time_series_dimension")] public bool? TimeSeriesDimension { get; set; } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// [JsonInclude, JsonPropertyName("time_series_metric")] public Elastic.Clients.Elasticsearch.Mapping.TimeSeriesMetricType? TimeSeriesMetric { get; set; } @@ -181,7 +187,9 @@ public DoubleNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public DoubleNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -258,7 +266,9 @@ public DoubleNumberPropertyDescriptor Store(bool? store = true) } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public DoubleNumberPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimension = true) { @@ -267,7 +277,9 @@ public DoubleNumberPropertyDescriptor TimeSeriesDimension(bool? timeS } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public DoubleNumberPropertyDescriptor TimeSeriesMetric(Elastic.Clients.Elasticsearch.Mapping.TimeSeriesMetricType? timeSeriesMetric) { @@ -546,7 +558,9 @@ public DoubleNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public DoubleNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -623,7 +637,9 @@ public DoubleNumberPropertyDescriptor Store(bool? store = true) } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public DoubleNumberPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimension = true) { @@ -632,7 +648,9 @@ public DoubleNumberPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimens } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public DoubleNumberPropertyDescriptor TimeSeriesMetric(Elastic.Clients.Elasticsearch.Mapping.TimeSeriesMetricType? timeSeriesMetric) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/DoubleRangeProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/DoubleRangeProperty.g.cs index d6f3d36ffb8..e9d60d93793 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/DoubleRangeProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/DoubleRangeProperty.g.cs @@ -48,7 +48,9 @@ public sealed partial class DoubleRangeProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -147,7 +149,9 @@ public DoubleRangePropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public DoubleRangePropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -368,7 +372,9 @@ public DoubleRangePropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public DoubleRangePropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/DynamicProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/DynamicProperty.g.cs index 5c141eef8e9..1e1608e925b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/DynamicProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/DynamicProperty.g.cs @@ -66,7 +66,9 @@ public sealed partial class DynamicProperty : IProperty public string? Locale { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -280,7 +282,9 @@ public DynamicPropertyDescriptor Locale(string? locale) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public DynamicPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -875,7 +879,9 @@ public DynamicPropertyDescriptor Locale(string? locale) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public DynamicPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/FieldAliasProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/FieldAliasProperty.g.cs index c00f33df9c4..3aaabb1fbea 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/FieldAliasProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/FieldAliasProperty.g.cs @@ -37,7 +37,9 @@ public sealed partial class FieldAliasProperty : IProperty public int? IgnoreAbove { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -98,7 +100,9 @@ public FieldAliasPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public FieldAliasPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -247,7 +251,9 @@ public FieldAliasPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public FieldAliasPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/FlattenedProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/FlattenedProperty.g.cs index 1a5dc436108..baaab885f59 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/FlattenedProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/FlattenedProperty.g.cs @@ -49,7 +49,9 @@ public sealed partial class FlattenedProperty : IProperty public Elastic.Clients.Elasticsearch.Mapping.IndexOptions? IndexOptions { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -158,7 +160,9 @@ public FlattenedPropertyDescriptor IndexOptions(Elastic.Clients.Elast } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public FlattenedPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -407,7 +411,9 @@ public FlattenedPropertyDescriptor IndexOptions(Elastic.Clients.Elasticsearch.Ma } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public FlattenedPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/FloatNumberProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/FloatNumberProperty.g.cs index c45b1d4ffba..36c1706ac20 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/FloatNumberProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/FloatNumberProperty.g.cs @@ -50,7 +50,9 @@ public sealed partial class FloatNumberProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -68,13 +70,17 @@ public sealed partial class FloatNumberProperty : IProperty public bool? Store { get; set; } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// [JsonInclude, JsonPropertyName("time_series_dimension")] public bool? TimeSeriesDimension { get; set; } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// [JsonInclude, JsonPropertyName("time_series_metric")] public Elastic.Clients.Elasticsearch.Mapping.TimeSeriesMetricType? TimeSeriesMetric { get; set; } @@ -181,7 +187,9 @@ public FloatNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public FloatNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -258,7 +266,9 @@ public FloatNumberPropertyDescriptor Store(bool? store = true) } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public FloatNumberPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimension = true) { @@ -267,7 +277,9 @@ public FloatNumberPropertyDescriptor TimeSeriesDimension(bool? timeSe } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public FloatNumberPropertyDescriptor TimeSeriesMetric(Elastic.Clients.Elasticsearch.Mapping.TimeSeriesMetricType? timeSeriesMetric) { @@ -546,7 +558,9 @@ public FloatNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public FloatNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -623,7 +637,9 @@ public FloatNumberPropertyDescriptor Store(bool? store = true) } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public FloatNumberPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimension = true) { @@ -632,7 +648,9 @@ public FloatNumberPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimensi } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public FloatNumberPropertyDescriptor TimeSeriesMetric(Elastic.Clients.Elasticsearch.Mapping.TimeSeriesMetricType? timeSeriesMetric) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/FloatRangeProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/FloatRangeProperty.g.cs index 8c3df0eb6b0..ce30a7edea1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/FloatRangeProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/FloatRangeProperty.g.cs @@ -48,7 +48,9 @@ public sealed partial class FloatRangeProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -147,7 +149,9 @@ public FloatRangePropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public FloatRangePropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -368,7 +372,9 @@ public FloatRangePropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public FloatRangePropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/GeoPointProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/GeoPointProperty.g.cs index f56e859059d..94a27702164 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/GeoPointProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/GeoPointProperty.g.cs @@ -48,7 +48,9 @@ public sealed partial class GeoPointProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -158,7 +160,9 @@ public GeoPointPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public GeoPointPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -475,7 +479,9 @@ public GeoPointPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public GeoPointPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/GeoShapeProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/GeoShapeProperty.g.cs index bd8c6c3bc01..b62fefd471e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/GeoShapeProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/GeoShapeProperty.g.cs @@ -28,7 +28,10 @@ namespace Elastic.Clients.Elasticsearch.Mapping; /// -/// The `geo_shape` data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles
and polygons. +/// +/// The geo_shape data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles +/// and polygons. +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class GeoShapeProperty : IProperty @@ -52,7 +55,9 @@ public sealed partial class GeoShapeProperty : IProperty public bool? IgnoreZValue { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -72,7 +77,10 @@ public sealed partial class GeoShapeProperty : IProperty } /// -/// The `geo_shape` data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles
and polygons. +/// +/// The geo_shape data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles +/// and polygons. +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class GeoShapePropertyDescriptor : SerializableDescriptor>, IBuildableDescriptor @@ -161,7 +169,9 @@ public GeoShapePropertyDescriptor IgnoreZValue(bool? ignoreZValue = t } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public GeoShapePropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -325,7 +335,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// The `geo_shape` data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles
and polygons. +/// +/// The geo_shape data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles +/// and polygons. +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class GeoShapePropertyDescriptor : SerializableDescriptor, IBuildableDescriptor @@ -414,7 +427,9 @@ public GeoShapePropertyDescriptor IgnoreZValue(bool? ignoreZValue = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public GeoShapePropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/HalfFloatNumberProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/HalfFloatNumberProperty.g.cs index ae1942c1865..d9e22bbeff4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/HalfFloatNumberProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/HalfFloatNumberProperty.g.cs @@ -50,7 +50,9 @@ public sealed partial class HalfFloatNumberProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -68,13 +70,17 @@ public sealed partial class HalfFloatNumberProperty : IProperty public bool? Store { get; set; } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// [JsonInclude, JsonPropertyName("time_series_dimension")] public bool? TimeSeriesDimension { get; set; } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// [JsonInclude, JsonPropertyName("time_series_metric")] public Elastic.Clients.Elasticsearch.Mapping.TimeSeriesMetricType? TimeSeriesMetric { get; set; } @@ -181,7 +187,9 @@ public HalfFloatNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public HalfFloatNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -258,7 +266,9 @@ public HalfFloatNumberPropertyDescriptor Store(bool? store = true) } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public HalfFloatNumberPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimension = true) { @@ -267,7 +277,9 @@ public HalfFloatNumberPropertyDescriptor TimeSeriesDimension(bool? ti } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public HalfFloatNumberPropertyDescriptor TimeSeriesMetric(Elastic.Clients.Elasticsearch.Mapping.TimeSeriesMetricType? timeSeriesMetric) { @@ -546,7 +558,9 @@ public HalfFloatNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public HalfFloatNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -623,7 +637,9 @@ public HalfFloatNumberPropertyDescriptor Store(bool? store = true) } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public HalfFloatNumberPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimension = true) { @@ -632,7 +648,9 @@ public HalfFloatNumberPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDim } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public HalfFloatNumberPropertyDescriptor TimeSeriesMetric(Elastic.Clients.Elasticsearch.Mapping.TimeSeriesMetricType? timeSeriesMetric) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/HistogramProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/HistogramProperty.g.cs index 5910340dddc..dcdc5b0b0e8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/HistogramProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/HistogramProperty.g.cs @@ -39,7 +39,9 @@ public sealed partial class HistogramProperty : IProperty public bool? IgnoreMalformed { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -104,7 +106,9 @@ public HistogramPropertyDescriptor IgnoreMalformed(bool? ignoreMalfor } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public HistogramPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -241,7 +245,9 @@ public HistogramPropertyDescriptor IgnoreMalformed(bool? ignoreMalformed = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public HistogramPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/IcuCollationProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/IcuCollationProperty.g.cs index 60d03fa1abd..8e24f7b8840 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/IcuCollationProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/IcuCollationProperty.g.cs @@ -54,7 +54,9 @@ public sealed partial class IcuCollationProperty : IProperty public int? IgnoreAbove { get; set; } /// - /// Should the field be searchable? + /// + /// Should the field be searchable? + /// /// [JsonInclude, JsonPropertyName("index")] public bool? Index { get; set; } @@ -64,7 +66,9 @@ public sealed partial class IcuCollationProperty : IProperty public string? Language { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -72,7 +76,9 @@ public sealed partial class IcuCollationProperty : IProperty public bool? Norms { get; set; } /// - /// Accepts a string value which is substituted for any explicit null values. Defaults to null, which means the field is treated as missing. + /// + /// Accepts a string value which is substituted for any explicit null values. Defaults to null, which means the field is treated as missing. + /// /// [JsonInclude, JsonPropertyName("null_value")] public string? NullValue { get; set; } @@ -213,7 +219,9 @@ public IcuCollationPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Should the field be searchable? + /// + /// Should the field be searchable? + /// /// public IcuCollationPropertyDescriptor Index(bool? index = true) { @@ -234,7 +242,9 @@ public IcuCollationPropertyDescriptor Language(string? language) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public IcuCollationPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -249,7 +259,9 @@ public IcuCollationPropertyDescriptor Norms(bool? norms = true) } /// - /// Accepts a string value which is substituted for any explicit null values. Defaults to null, which means the field is treated as missing. + /// + /// Accepts a string value which is substituted for any explicit null values. Defaults to null, which means the field is treated as missing. + /// /// public IcuCollationPropertyDescriptor NullValue(string? nullValue) { @@ -622,7 +634,9 @@ public IcuCollationPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Should the field be searchable? + /// + /// Should the field be searchable? + /// /// public IcuCollationPropertyDescriptor Index(bool? index = true) { @@ -643,7 +657,9 @@ public IcuCollationPropertyDescriptor Language(string? language) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public IcuCollationPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -658,7 +674,9 @@ public IcuCollationPropertyDescriptor Norms(bool? norms = true) } /// - /// Accepts a string value which is substituted for any explicit null values. Defaults to null, which means the field is treated as missing. + /// + /// Accepts a string value which is substituted for any explicit null values. Defaults to null, which means the field is treated as missing. + /// /// public IcuCollationPropertyDescriptor NullValue(string? nullValue) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/IntegerNumberProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/IntegerNumberProperty.g.cs index a0cb9d2dcf2..6317c6dc0e6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/IntegerNumberProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/IntegerNumberProperty.g.cs @@ -50,7 +50,9 @@ public sealed partial class IntegerNumberProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -68,13 +70,17 @@ public sealed partial class IntegerNumberProperty : IProperty public bool? Store { get; set; } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// [JsonInclude, JsonPropertyName("time_series_dimension")] public bool? TimeSeriesDimension { get; set; } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// [JsonInclude, JsonPropertyName("time_series_metric")] public Elastic.Clients.Elasticsearch.Mapping.TimeSeriesMetricType? TimeSeriesMetric { get; set; } @@ -181,7 +187,9 @@ public IntegerNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public IntegerNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -258,7 +266,9 @@ public IntegerNumberPropertyDescriptor Store(bool? store = true) } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public IntegerNumberPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimension = true) { @@ -267,7 +277,9 @@ public IntegerNumberPropertyDescriptor TimeSeriesDimension(bool? time } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public IntegerNumberPropertyDescriptor TimeSeriesMetric(Elastic.Clients.Elasticsearch.Mapping.TimeSeriesMetricType? timeSeriesMetric) { @@ -546,7 +558,9 @@ public IntegerNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public IntegerNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -623,7 +637,9 @@ public IntegerNumberPropertyDescriptor Store(bool? store = true) } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public IntegerNumberPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimension = true) { @@ -632,7 +648,9 @@ public IntegerNumberPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimen } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public IntegerNumberPropertyDescriptor TimeSeriesMetric(Elastic.Clients.Elasticsearch.Mapping.TimeSeriesMetricType? timeSeriesMetric) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/IntegerRangeProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/IntegerRangeProperty.g.cs index 2cb1dcddc61..c2e2f0dcafe 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/IntegerRangeProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/IntegerRangeProperty.g.cs @@ -48,7 +48,9 @@ public sealed partial class IntegerRangeProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -147,7 +149,9 @@ public IntegerRangePropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public IntegerRangePropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -368,7 +372,9 @@ public IntegerRangePropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public IntegerRangePropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/IpProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/IpProperty.g.cs index 3d6957d0e30..5bf94249fcf 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/IpProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/IpProperty.g.cs @@ -48,7 +48,9 @@ public sealed partial class IpProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -66,7 +68,9 @@ public sealed partial class IpProperty : IProperty public bool? Store { get; set; } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// [JsonInclude, JsonPropertyName("time_series_dimension")] public bool? TimeSeriesDimension { get; set; } @@ -165,7 +169,9 @@ public IpPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public IpPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -242,7 +248,9 @@ public IpPropertyDescriptor Store(bool? store = true) } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public IpPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimension = true) { @@ -499,7 +507,9 @@ public IpPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public IpPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -576,7 +586,9 @@ public IpPropertyDescriptor Store(bool? store = true) } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public IpPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimension = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/IpRangeProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/IpRangeProperty.g.cs index 4162fa65fe1..02cadaea30d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/IpRangeProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/IpRangeProperty.g.cs @@ -48,7 +48,9 @@ public sealed partial class IpRangeProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -147,7 +149,9 @@ public IpRangePropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public IpRangePropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -368,7 +372,9 @@ public IpRangePropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public IpRangePropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/JoinProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/JoinProperty.g.cs index b82a61189b2..6585e14e662 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/JoinProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/JoinProperty.g.cs @@ -39,7 +39,9 @@ public sealed partial class JoinProperty : IProperty public int? IgnoreAbove { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -107,7 +109,9 @@ public JoinPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public JoinPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -258,7 +262,9 @@ public JoinPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public JoinPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/KeywordProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/KeywordProperty.g.cs index f21555f66d6..8b3f61ce264 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/KeywordProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/KeywordProperty.g.cs @@ -50,7 +50,9 @@ public sealed partial class KeywordProperty : IProperty public Elastic.Clients.Elasticsearch.Mapping.IndexOptions? IndexOptions { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -74,7 +76,9 @@ public sealed partial class KeywordProperty : IProperty public bool? Store { get; set; } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// [JsonInclude, JsonPropertyName("time_series_dimension")] public bool? TimeSeriesDimension { get; set; } @@ -183,7 +187,9 @@ public KeywordPropertyDescriptor IndexOptions(Elastic.Clients.Elastic } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public KeywordPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -278,7 +284,9 @@ public KeywordPropertyDescriptor Store(bool? store = true) } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public KeywordPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimension = true) { @@ -573,7 +581,9 @@ public KeywordPropertyDescriptor IndexOptions(Elastic.Clients.Elasticsearch.Mapp } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public KeywordPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -668,7 +678,9 @@ public KeywordPropertyDescriptor Store(bool? store = true) } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public KeywordPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimension = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/LongNumberProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/LongNumberProperty.g.cs index d4b58cb97c5..4477d6fe958 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/LongNumberProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/LongNumberProperty.g.cs @@ -50,7 +50,9 @@ public sealed partial class LongNumberProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -68,13 +70,17 @@ public sealed partial class LongNumberProperty : IProperty public bool? Store { get; set; } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// [JsonInclude, JsonPropertyName("time_series_dimension")] public bool? TimeSeriesDimension { get; set; } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// [JsonInclude, JsonPropertyName("time_series_metric")] public Elastic.Clients.Elasticsearch.Mapping.TimeSeriesMetricType? TimeSeriesMetric { get; set; } @@ -181,7 +187,9 @@ public LongNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public LongNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -258,7 +266,9 @@ public LongNumberPropertyDescriptor Store(bool? store = true) } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public LongNumberPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimension = true) { @@ -267,7 +277,9 @@ public LongNumberPropertyDescriptor TimeSeriesDimension(bool? timeSer } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public LongNumberPropertyDescriptor TimeSeriesMetric(Elastic.Clients.Elasticsearch.Mapping.TimeSeriesMetricType? timeSeriesMetric) { @@ -546,7 +558,9 @@ public LongNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public LongNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -623,7 +637,9 @@ public LongNumberPropertyDescriptor Store(bool? store = true) } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public LongNumberPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimension = true) { @@ -632,7 +648,9 @@ public LongNumberPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimensio } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public LongNumberPropertyDescriptor TimeSeriesMetric(Elastic.Clients.Elasticsearch.Mapping.TimeSeriesMetricType? timeSeriesMetric) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/LongRangeProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/LongRangeProperty.g.cs index e999b768698..e14b9e1f335 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/LongRangeProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/LongRangeProperty.g.cs @@ -48,7 +48,9 @@ public sealed partial class LongRangeProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -147,7 +149,9 @@ public LongRangePropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public LongRangePropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -368,7 +372,9 @@ public LongRangePropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public LongRangePropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/MatchOnlyTextProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/MatchOnlyTextProperty.g.cs index aaadecbb80e..4f7566ec1b8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/MatchOnlyTextProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/MatchOnlyTextProperty.g.cs @@ -28,25 +28,39 @@ namespace Elastic.Clients.Elasticsearch.Mapping; /// -/// A variant of text that trades scoring and efficiency of positional queries for space efficiency. This field
effectively stores data the same way as a text field that only indexes documents (index_options: docs) and
disables norms (norms: false). Term queries perform as fast if not faster as on text fields, however queries
that need positions such as the match_phrase query perform slower as they need to look at the _source document
to verify whether a phrase matches. All queries return constant scores that are equal to 1.0. +/// +/// A variant of text that trades scoring and efficiency of positional queries for space efficiency. This field +/// effectively stores data the same way as a text field that only indexes documents (index_options: docs) and +/// disables norms (norms: false). Term queries perform as fast if not faster as on text fields, however queries +/// that need positions such as the match_phrase query perform slower as they need to look at the _source document +/// to verify whether a phrase matches. All queries return constant scores that are equal to 1.0. +/// /// public sealed partial class MatchOnlyTextProperty : IProperty { /// - /// Allows you to copy the values of multiple fields into a group
field, which can then be queried as a single field. + /// + /// Allows you to copy the values of multiple fields into a group + /// field, which can then be queried as a single field. + /// /// [JsonInclude, JsonPropertyName("copy_to")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] public Elastic.Clients.Elasticsearch.Fields? CopyTo { get; set; } /// - /// Multi-fields allow the same string value to be indexed in multiple ways for different purposes, such as one
field for search and a multi-field for sorting and aggregations, or the same string value analyzed by different analyzers. + /// + /// Multi-fields allow the same string value to be indexed in multiple ways for different purposes, such as one + /// field for search and a multi-field for sorting and aggregations, or the same string value analyzed by different analyzers. + /// /// [JsonInclude, JsonPropertyName("fields")] public Elastic.Clients.Elasticsearch.Mapping.Properties? Fields { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -56,7 +70,13 @@ public sealed partial class MatchOnlyTextProperty : IProperty } /// -/// A variant of text that trades scoring and efficiency of positional queries for space efficiency. This field
effectively stores data the same way as a text field that only indexes documents (index_options: docs) and
disables norms (norms: false). Term queries perform as fast if not faster as on text fields, however queries
that need positions such as the match_phrase query perform slower as they need to look at the _source document
to verify whether a phrase matches. All queries return constant scores that are equal to 1.0. +/// +/// A variant of text that trades scoring and efficiency of positional queries for space efficiency. This field +/// effectively stores data the same way as a text field that only indexes documents (index_options: docs) and +/// disables norms (norms: false). Term queries perform as fast if not faster as on text fields, however queries +/// that need positions such as the match_phrase query perform slower as they need to look at the _source document +/// to verify whether a phrase matches. All queries return constant scores that are equal to 1.0. +/// /// public sealed partial class MatchOnlyTextPropertyDescriptor : SerializableDescriptor>, IBuildableDescriptor { @@ -71,7 +91,10 @@ public MatchOnlyTextPropertyDescriptor() : base() private IDictionary? MetaValue { get; set; } /// - /// Allows you to copy the values of multiple fields into a group
field, which can then be queried as a single field. + /// + /// Allows you to copy the values of multiple fields into a group + /// field, which can then be queried as a single field. + /// /// public MatchOnlyTextPropertyDescriptor CopyTo(Elastic.Clients.Elasticsearch.Fields? copyTo) { @@ -80,7 +103,10 @@ public MatchOnlyTextPropertyDescriptor CopyTo(Elastic.Clients.Elastic } /// - /// Multi-fields allow the same string value to be indexed in multiple ways for different purposes, such as one
field for search and a multi-field for sorting and aggregations, or the same string value analyzed by different analyzers. + /// + /// Multi-fields allow the same string value to be indexed in multiple ways for different purposes, such as one + /// field for search and a multi-field for sorting and aggregations, or the same string value analyzed by different analyzers. + /// /// public MatchOnlyTextPropertyDescriptor Fields(Elastic.Clients.Elasticsearch.Mapping.Properties? fields) { @@ -103,7 +129,9 @@ public MatchOnlyTextPropertyDescriptor Fields(Action - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public MatchOnlyTextPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -146,7 +174,13 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// A variant of text that trades scoring and efficiency of positional queries for space efficiency. This field
effectively stores data the same way as a text field that only indexes documents (index_options: docs) and
disables norms (norms: false). Term queries perform as fast if not faster as on text fields, however queries
that need positions such as the match_phrase query perform slower as they need to look at the _source document
to verify whether a phrase matches. All queries return constant scores that are equal to 1.0. +/// +/// A variant of text that trades scoring and efficiency of positional queries for space efficiency. This field +/// effectively stores data the same way as a text field that only indexes documents (index_options: docs) and +/// disables norms (norms: false). Term queries perform as fast if not faster as on text fields, however queries +/// that need positions such as the match_phrase query perform slower as they need to look at the _source document +/// to verify whether a phrase matches. All queries return constant scores that are equal to 1.0. +/// /// public sealed partial class MatchOnlyTextPropertyDescriptor : SerializableDescriptor, IBuildableDescriptor { @@ -161,7 +195,10 @@ public MatchOnlyTextPropertyDescriptor() : base() private IDictionary? MetaValue { get; set; } /// - /// Allows you to copy the values of multiple fields into a group
field, which can then be queried as a single field. + /// + /// Allows you to copy the values of multiple fields into a group + /// field, which can then be queried as a single field. + /// /// public MatchOnlyTextPropertyDescriptor CopyTo(Elastic.Clients.Elasticsearch.Fields? copyTo) { @@ -170,7 +207,10 @@ public MatchOnlyTextPropertyDescriptor CopyTo(Elastic.Clients.Elasticsearch.Fiel } /// - /// Multi-fields allow the same string value to be indexed in multiple ways for different purposes, such as one
field for search and a multi-field for sorting and aggregations, or the same string value analyzed by different analyzers. + /// + /// Multi-fields allow the same string value to be indexed in multiple ways for different purposes, such as one + /// field for search and a multi-field for sorting and aggregations, or the same string value analyzed by different analyzers. + /// /// public MatchOnlyTextPropertyDescriptor Fields(Elastic.Clients.Elasticsearch.Mapping.Properties? fields) { @@ -193,7 +233,9 @@ public MatchOnlyTextPropertyDescriptor Fields(Action - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public MatchOnlyTextPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/Murmur3HashProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/Murmur3HashProperty.g.cs index 314b5a74efa..1ba163262b5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/Murmur3HashProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/Murmur3HashProperty.g.cs @@ -42,7 +42,9 @@ public sealed partial class Murmur3HashProperty : IProperty public int? IgnoreAbove { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -120,7 +122,9 @@ public Murmur3HashPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public Murmur3HashPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -299,7 +303,9 @@ public Murmur3HashPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public Murmur3HashPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/NestedProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/NestedProperty.g.cs index 8157ffa16d7..8eb2380d393 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/NestedProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/NestedProperty.g.cs @@ -46,7 +46,9 @@ public sealed partial class NestedProperty : IProperty public bool? IncludeInRoot { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -138,7 +140,9 @@ public NestedPropertyDescriptor IncludeInRoot(bool? includeInRoot = t } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public NestedPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -345,7 +349,9 @@ public NestedPropertyDescriptor IncludeInRoot(bool? includeInRoot = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public NestedPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/ObjectProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/ObjectProperty.g.cs index 426174af751..f80e8cad9c8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/ObjectProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/ObjectProperty.g.cs @@ -42,7 +42,9 @@ public sealed partial class ObjectProperty : IProperty public int? IgnoreAbove { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -123,7 +125,9 @@ public ObjectPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public ObjectPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -316,7 +320,9 @@ public ObjectPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public ObjectPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/PercolatorProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/PercolatorProperty.g.cs index 37eb93acaf4..5861ca10580 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/PercolatorProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/PercolatorProperty.g.cs @@ -37,7 +37,9 @@ public sealed partial class PercolatorProperty : IProperty public int? IgnoreAbove { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -95,7 +97,9 @@ public PercolatorPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public PercolatorPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -218,7 +222,9 @@ public PercolatorPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public PercolatorPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/PointProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/PointProperty.g.cs index 02c94ce9291..64234cd9b75 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/PointProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/PointProperty.g.cs @@ -46,7 +46,9 @@ public sealed partial class PointProperty : IProperty public bool? IgnoreZValue { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -141,7 +143,9 @@ public PointPropertyDescriptor IgnoreZValue(bool? ignoreZValue = true } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public PointPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -362,7 +366,9 @@ public PointPropertyDescriptor IgnoreZValue(bool? ignoreZValue = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public PointPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/RankFeatureProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/RankFeatureProperty.g.cs index a4a878fb926..3ee3c6d40c8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/RankFeatureProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/RankFeatureProperty.g.cs @@ -37,7 +37,9 @@ public sealed partial class RankFeatureProperty : IProperty public int? IgnoreAbove { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -98,7 +100,9 @@ public RankFeaturePropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public RankFeaturePropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -235,7 +239,9 @@ public RankFeaturePropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public RankFeaturePropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/RankFeaturesProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/RankFeaturesProperty.g.cs index 4034a2482fb..9fd6d23aad5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/RankFeaturesProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/RankFeaturesProperty.g.cs @@ -37,7 +37,9 @@ public sealed partial class RankFeaturesProperty : IProperty public int? IgnoreAbove { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -98,7 +100,9 @@ public RankFeaturesPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public RankFeaturesPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -235,7 +239,9 @@ public RankFeaturesPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public RankFeaturesPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/RuntimeField.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/RuntimeField.g.cs index 9e57ee26775..1413b04569e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/RuntimeField.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/RuntimeField.g.cs @@ -30,43 +30,57 @@ namespace Elastic.Clients.Elasticsearch.Mapping; public sealed partial class RuntimeField { /// - /// For type `lookup` + /// + /// For type lookup + /// /// [JsonInclude, JsonPropertyName("fetch_fields")] public ICollection? FetchFields { get; set; } /// - /// A custom format for `date` type runtime fields. + /// + /// A custom format for date type runtime fields. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } /// - /// For type `lookup` + /// + /// For type lookup + /// /// [JsonInclude, JsonPropertyName("input_field")] public Elastic.Clients.Elasticsearch.Field? InputField { get; set; } /// - /// Painless script executed at query time. + /// + /// Painless script executed at query time. + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Script? Script { get; set; } /// - /// For type `lookup` + /// + /// For type lookup + /// /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } /// - /// For type `lookup` + /// + /// For type lookup + /// /// [JsonInclude, JsonPropertyName("target_index")] public Elastic.Clients.Elasticsearch.IndexName? TargetIndex { get; set; } /// - /// Field type, which can be: `boolean`, `composite`, `date`, `double`, `geo_point`, `ip`,`keyword`, `long`, or `lookup`. + /// + /// Field type, which can be: boolean, composite, date, double, geo_point, ip,keyword, long, or lookup. + /// /// [JsonInclude, JsonPropertyName("type")] public Elastic.Clients.Elasticsearch.Mapping.RuntimeFieldType Type { get; set; } @@ -94,7 +108,9 @@ public RuntimeFieldDescriptor() : base() private Elastic.Clients.Elasticsearch.Mapping.RuntimeFieldType TypeValue { get; set; } /// - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor FetchFields(ICollection? fetchFields) { @@ -133,7 +149,9 @@ public RuntimeFieldDescriptor FetchFields(params Action - /// A custom format for `date` type runtime fields. + /// + /// A custom format for date type runtime fields. + /// /// public RuntimeFieldDescriptor Format(string? format) { @@ -142,7 +160,9 @@ public RuntimeFieldDescriptor Format(string? format) } /// - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor InputField(Elastic.Clients.Elasticsearch.Field? inputField) { @@ -151,7 +171,9 @@ public RuntimeFieldDescriptor InputField(Elastic.Clients.Elasticsearc } /// - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor InputField(Expression> inputField) { @@ -160,7 +182,9 @@ public RuntimeFieldDescriptor InputField(Expression - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor InputField(Expression> inputField) { @@ -169,7 +193,9 @@ public RuntimeFieldDescriptor InputField(Expression - /// Painless script executed at query time. + /// + /// Painless script executed at query time. + /// /// public RuntimeFieldDescriptor Script(Elastic.Clients.Elasticsearch.Script? script) { @@ -196,7 +222,9 @@ public RuntimeFieldDescriptor Script(Action - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -205,7 +233,9 @@ public RuntimeFieldDescriptor TargetField(Elastic.Clients.Elasticsear } /// - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor TargetField(Expression> targetField) { @@ -214,7 +244,9 @@ public RuntimeFieldDescriptor TargetField(Expression - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor TargetField(Expression> targetField) { @@ -223,7 +255,9 @@ public RuntimeFieldDescriptor TargetField(Expression - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor TargetIndex(Elastic.Clients.Elasticsearch.IndexName? targetIndex) { @@ -232,7 +266,9 @@ public RuntimeFieldDescriptor TargetIndex(Elastic.Clients.Elasticsear } /// - /// Field type, which can be: `boolean`, `composite`, `date`, `double`, `geo_point`, `ip`,`keyword`, `long`, or `lookup`. + /// + /// Field type, which can be: boolean, composite, date, double, geo_point, ip,keyword, long, or lookup. + /// /// public RuntimeFieldDescriptor Type(Elastic.Clients.Elasticsearch.Mapping.RuntimeFieldType type) { @@ -342,7 +378,9 @@ public RuntimeFieldDescriptor() : base() private Elastic.Clients.Elasticsearch.Mapping.RuntimeFieldType TypeValue { get; set; } /// - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor FetchFields(ICollection? fetchFields) { @@ -381,7 +419,9 @@ public RuntimeFieldDescriptor FetchFields(params Action - /// A custom format for `date` type runtime fields. + /// + /// A custom format for date type runtime fields. + /// /// public RuntimeFieldDescriptor Format(string? format) { @@ -390,7 +430,9 @@ public RuntimeFieldDescriptor Format(string? format) } /// - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor InputField(Elastic.Clients.Elasticsearch.Field? inputField) { @@ -399,7 +441,9 @@ public RuntimeFieldDescriptor InputField(Elastic.Clients.Elasticsearch.Field? in } /// - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor InputField(Expression> inputField) { @@ -408,7 +452,9 @@ public RuntimeFieldDescriptor InputField(Expression - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor InputField(Expression> inputField) { @@ -417,7 +463,9 @@ public RuntimeFieldDescriptor InputField(Expression - /// Painless script executed at query time. + /// + /// Painless script executed at query time. + /// /// public RuntimeFieldDescriptor Script(Elastic.Clients.Elasticsearch.Script? script) { @@ -444,7 +492,9 @@ public RuntimeFieldDescriptor Script(Action - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { @@ -453,7 +503,9 @@ public RuntimeFieldDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? t } /// - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor TargetField(Expression> targetField) { @@ -462,7 +514,9 @@ public RuntimeFieldDescriptor TargetField(Expression - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor TargetField(Expression> targetField) { @@ -471,7 +525,9 @@ public RuntimeFieldDescriptor TargetField(Expression - /// For type `lookup` + /// + /// For type lookup + /// /// public RuntimeFieldDescriptor TargetIndex(Elastic.Clients.Elasticsearch.IndexName? targetIndex) { @@ -480,7 +536,9 @@ public RuntimeFieldDescriptor TargetIndex(Elastic.Clients.Elasticsearch.IndexNam } /// - /// Field type, which can be: `boolean`, `composite`, `date`, `double`, `geo_point`, `ip`,`keyword`, `long`, or `lookup`. + /// + /// Field type, which can be: boolean, composite, date, double, geo_point, ip,keyword, long, or lookup. + /// /// public RuntimeFieldDescriptor Type(Elastic.Clients.Elasticsearch.Mapping.RuntimeFieldType type) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/ScaledFloatNumberProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/ScaledFloatNumberProperty.g.cs index b805d465c5b..c32c2f20aa6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/ScaledFloatNumberProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/ScaledFloatNumberProperty.g.cs @@ -50,7 +50,9 @@ public sealed partial class ScaledFloatNumberProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -70,13 +72,17 @@ public sealed partial class ScaledFloatNumberProperty : IProperty public bool? Store { get; set; } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// [JsonInclude, JsonPropertyName("time_series_dimension")] public bool? TimeSeriesDimension { get; set; } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// [JsonInclude, JsonPropertyName("time_series_metric")] public Elastic.Clients.Elasticsearch.Mapping.TimeSeriesMetricType? TimeSeriesMetric { get; set; } @@ -184,7 +190,9 @@ public ScaledFloatNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public ScaledFloatNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -267,7 +275,9 @@ public ScaledFloatNumberPropertyDescriptor Store(bool? store = true) } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public ScaledFloatNumberPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimension = true) { @@ -276,7 +286,9 @@ public ScaledFloatNumberPropertyDescriptor TimeSeriesDimension(bool? } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public ScaledFloatNumberPropertyDescriptor TimeSeriesMetric(Elastic.Clients.Elasticsearch.Mapping.TimeSeriesMetricType? timeSeriesMetric) { @@ -563,7 +575,9 @@ public ScaledFloatNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public ScaledFloatNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -646,7 +660,9 @@ public ScaledFloatNumberPropertyDescriptor Store(bool? store = true) } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public ScaledFloatNumberPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimension = true) { @@ -655,7 +671,9 @@ public ScaledFloatNumberPropertyDescriptor TimeSeriesDimension(bool? timeSeriesD } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public ScaledFloatNumberPropertyDescriptor TimeSeriesMetric(Elastic.Clients.Elasticsearch.Mapping.TimeSeriesMetricType? timeSeriesMetric) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/SearchAsYouTypeProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/SearchAsYouTypeProperty.g.cs index 99ee3774a20..01869286d25 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/SearchAsYouTypeProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/SearchAsYouTypeProperty.g.cs @@ -48,7 +48,9 @@ public sealed partial class SearchAsYouTypeProperty : IProperty public int? MaxShingleSize { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -159,7 +161,9 @@ public SearchAsYouTypePropertyDescriptor MaxShingleSize(int? maxShing } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public SearchAsYouTypePropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -436,7 +440,9 @@ public SearchAsYouTypePropertyDescriptor MaxShingleSize(int? maxShingleSize) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public SearchAsYouTypePropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/ShapeProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/ShapeProperty.g.cs index 3e288ecb8d8..82b0be2b913 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/ShapeProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/ShapeProperty.g.cs @@ -28,7 +28,10 @@ namespace Elastic.Clients.Elasticsearch.Mapping; /// -/// The `shape` data type facilitates the indexing of and searching with arbitrary `x, y` cartesian shapes such as
rectangles and polygons. +/// +/// The shape data type facilitates the indexing of and searching with arbitrary x, y cartesian shapes such as +/// rectangles and polygons. +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class ShapeProperty : IProperty @@ -52,7 +55,9 @@ public sealed partial class ShapeProperty : IProperty public bool? IgnoreZValue { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -70,7 +75,10 @@ public sealed partial class ShapeProperty : IProperty } /// -/// The `shape` data type facilitates the indexing of and searching with arbitrary `x, y` cartesian shapes such as
rectangles and polygons. +/// +/// The shape data type facilitates the indexing of and searching with arbitrary x, y cartesian shapes such as +/// rectangles and polygons. +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class ShapePropertyDescriptor : SerializableDescriptor>, IBuildableDescriptor @@ -158,7 +166,9 @@ public ShapePropertyDescriptor IgnoreZValue(bool? ignoreZValue = true } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public ShapePropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -309,7 +319,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// The `shape` data type facilitates the indexing of and searching with arbitrary `x, y` cartesian shapes such as
rectangles and polygons. +/// +/// The shape data type facilitates the indexing of and searching with arbitrary x, y cartesian shapes such as +/// rectangles and polygons. +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class ShapePropertyDescriptor : SerializableDescriptor, IBuildableDescriptor @@ -397,7 +410,9 @@ public ShapePropertyDescriptor IgnoreZValue(bool? ignoreZValue = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public ShapePropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/ShortNumberProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/ShortNumberProperty.g.cs index 88c3755c3e9..57a26810175 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/ShortNumberProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/ShortNumberProperty.g.cs @@ -50,7 +50,9 @@ public sealed partial class ShortNumberProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -68,13 +70,17 @@ public sealed partial class ShortNumberProperty : IProperty public bool? Store { get; set; } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// [JsonInclude, JsonPropertyName("time_series_dimension")] public bool? TimeSeriesDimension { get; set; } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// [JsonInclude, JsonPropertyName("time_series_metric")] public Elastic.Clients.Elasticsearch.Mapping.TimeSeriesMetricType? TimeSeriesMetric { get; set; } @@ -181,7 +187,9 @@ public ShortNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public ShortNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -258,7 +266,9 @@ public ShortNumberPropertyDescriptor Store(bool? store = true) } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public ShortNumberPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimension = true) { @@ -267,7 +277,9 @@ public ShortNumberPropertyDescriptor TimeSeriesDimension(bool? timeSe } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public ShortNumberPropertyDescriptor TimeSeriesMetric(Elastic.Clients.Elasticsearch.Mapping.TimeSeriesMetricType? timeSeriesMetric) { @@ -546,7 +558,9 @@ public ShortNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public ShortNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -623,7 +637,9 @@ public ShortNumberPropertyDescriptor Store(bool? store = true) } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public ShortNumberPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimension = true) { @@ -632,7 +648,9 @@ public ShortNumberPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimensi } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public ShortNumberPropertyDescriptor TimeSeriesMetric(Elastic.Clients.Elasticsearch.Mapping.TimeSeriesMetricType? timeSeriesMetric) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/SparseVectorProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/SparseVectorProperty.g.cs index 50497331563..421e6a48fc4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/SparseVectorProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/SparseVectorProperty.g.cs @@ -37,7 +37,9 @@ public sealed partial class SparseVectorProperty : IProperty public int? IgnoreAbove { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -95,7 +97,9 @@ public SparseVectorPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public SparseVectorPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -218,7 +222,9 @@ public SparseVectorPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public SparseVectorPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/TextProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/TextProperty.g.cs index 361df3fb774..507e09126cc 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/TextProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/TextProperty.g.cs @@ -58,7 +58,9 @@ public sealed partial class TextProperty : IProperty public Elastic.Clients.Elasticsearch.Mapping.TextIndexPrefixes? IndexPrefixes { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -247,7 +249,9 @@ public TextPropertyDescriptor IndexPrefixes(Action - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public TextPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -716,7 +720,9 @@ public TextPropertyDescriptor IndexPrefixes(Action - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public TextPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/TokenCountProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/TokenCountProperty.g.cs index 0d2b18067bd..3e57ba267ff 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/TokenCountProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/TokenCountProperty.g.cs @@ -50,7 +50,9 @@ public sealed partial class TokenCountProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -159,7 +161,9 @@ public TokenCountPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public TokenCountPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -408,7 +412,9 @@ public TokenCountPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public TokenCountPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/UnsignedLongNumberProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/UnsignedLongNumberProperty.g.cs index 3274c8bdd07..85d7217531e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/UnsignedLongNumberProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/UnsignedLongNumberProperty.g.cs @@ -50,7 +50,9 @@ public sealed partial class UnsignedLongNumberProperty : IProperty public bool? Index { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -68,13 +70,17 @@ public sealed partial class UnsignedLongNumberProperty : IProperty public bool? Store { get; set; } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// [JsonInclude, JsonPropertyName("time_series_dimension")] public bool? TimeSeriesDimension { get; set; } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// [JsonInclude, JsonPropertyName("time_series_metric")] public Elastic.Clients.Elasticsearch.Mapping.TimeSeriesMetricType? TimeSeriesMetric { get; set; } @@ -181,7 +187,9 @@ public UnsignedLongNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public UnsignedLongNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -258,7 +266,9 @@ public UnsignedLongNumberPropertyDescriptor Store(bool? store = true) } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public UnsignedLongNumberPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimension = true) { @@ -267,7 +277,9 @@ public UnsignedLongNumberPropertyDescriptor TimeSeriesDimension(bool? } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public UnsignedLongNumberPropertyDescriptor TimeSeriesMetric(Elastic.Clients.Elasticsearch.Mapping.TimeSeriesMetricType? timeSeriesMetric) { @@ -546,7 +558,9 @@ public UnsignedLongNumberPropertyDescriptor Index(bool? index = true) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public UnsignedLongNumberPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -623,7 +637,9 @@ public UnsignedLongNumberPropertyDescriptor Store(bool? store = true) } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public UnsignedLongNumberPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimension = true) { @@ -632,7 +648,9 @@ public UnsignedLongNumberPropertyDescriptor TimeSeriesDimension(bool? timeSeries } /// - /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// + /// For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. + /// /// public UnsignedLongNumberPropertyDescriptor TimeSeriesMetric(Elastic.Clients.Elasticsearch.Mapping.TimeSeriesMetricType? timeSeriesMetric) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/VersionProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/VersionProperty.g.cs index a8f66f2a807..5eadc49075b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/VersionProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/VersionProperty.g.cs @@ -42,7 +42,9 @@ public sealed partial class VersionProperty : IProperty public int? IgnoreAbove { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -120,7 +122,9 @@ public VersionPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public VersionPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -299,7 +303,9 @@ public VersionPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public VersionPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/WildcardProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/WildcardProperty.g.cs index e4bff5cfb5a..40a82c96795 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/WildcardProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/WildcardProperty.g.cs @@ -42,7 +42,9 @@ public sealed partial class WildcardProperty : IProperty public int? IgnoreAbove { get; set; } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// [JsonInclude, JsonPropertyName("meta")] public IDictionary? Meta { get; set; } @@ -123,7 +125,9 @@ public WildcardPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public WildcardPropertyDescriptor Meta(Func, FluentDictionary> selector) { @@ -316,7 +320,9 @@ public WildcardPropertyDescriptor IgnoreAbove(int? ignoreAbove) } /// - /// Metadata about the field. + /// + /// Metadata about the field. + /// /// public WildcardPropertyDescriptor Meta(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/NodeAttributes.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/NodeAttributes.g.cs index d30ea20b9dc..06177d3adae 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/NodeAttributes.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/NodeAttributes.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class NodeAttributes { /// - /// Lists node attributes. + /// + /// Lists node attributes. + /// /// [JsonInclude, JsonPropertyName("attributes")] public IReadOnlyDictionary Attributes { get; init; } /// - /// The ephemeral ID of the node. + /// + /// The ephemeral ID of the node. + /// /// [JsonInclude, JsonPropertyName("ephemeral_id")] public string EphemeralId { get; init; } @@ -44,13 +48,17 @@ public sealed partial class NodeAttributes public string? ExternalId { get; init; } /// - /// The unique identifier of the node. + /// + /// The unique identifier of the node. + /// /// [JsonInclude, JsonPropertyName("id")] public string? Id { get; init; } /// - /// The unique identifier of the node. + /// + /// The unique identifier of the node. + /// /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } @@ -58,7 +66,9 @@ public sealed partial class NodeAttributes public IReadOnlyCollection? Roles { get; init; } /// - /// The host and port where transport HTTP connections are accepted. + /// + /// The host and port where transport HTTP connections are accepted. + /// /// [JsonInclude, JsonPropertyName("transport_address")] public string TransportAddress { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/NodeStatistics.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/NodeStatistics.g.cs index 542e306582b..22d8be00e59 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/NodeStatistics.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/NodeStatistics.g.cs @@ -28,12 +28,16 @@ namespace Elastic.Clients.Elasticsearch; /// -/// Contains statistics about the number of nodes selected by the request. +/// +/// Contains statistics about the number of nodes selected by the request. +/// /// public sealed partial class NodeStatistics { /// - /// Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response. + /// + /// Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response. + /// /// [JsonInclude, JsonPropertyName("failed")] public int Failed { get; init; } @@ -41,13 +45,17 @@ public sealed partial class NodeStatistics public IReadOnlyCollection? Failures { get; init; } /// - /// Number of nodes that responded successfully to the request. + /// + /// Number of nodes that responded successfully to the request. + /// /// [JsonInclude, JsonPropertyName("successful")] public int Successful { get; init; } /// - /// Total number of nodes selected by the request. + /// + /// Total number of nodes selected by the request. + /// /// [JsonInclude, JsonPropertyName("total")] public int Total { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/AdaptiveSelection.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/AdaptiveSelection.g.cs index 105ffb588c6..b186d569db0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/AdaptiveSelection.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/AdaptiveSelection.g.cs @@ -30,43 +30,57 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class AdaptiveSelection { /// - /// The exponentially weighted moving average queue size of search requests on the keyed node. + /// + /// The exponentially weighted moving average queue size of search requests on the keyed node. + /// /// [JsonInclude, JsonPropertyName("avg_queue_size")] public long? AvgQueueSize { get; init; } /// - /// The exponentially weighted moving average response time of search requests on the keyed node. + /// + /// The exponentially weighted moving average response time of search requests on the keyed node. + /// /// [JsonInclude, JsonPropertyName("avg_response_time")] public Elastic.Clients.Elasticsearch.Duration? AvgResponseTime { get; init; } /// - /// The exponentially weighted moving average response time, in nanoseconds, of search requests on the keyed node. + /// + /// The exponentially weighted moving average response time, in nanoseconds, of search requests on the keyed node. + /// /// [JsonInclude, JsonPropertyName("avg_response_time_ns")] public long? AvgResponseTimeNs { get; init; } /// - /// The exponentially weighted moving average service time of search requests on the keyed node. + /// + /// The exponentially weighted moving average service time of search requests on the keyed node. + /// /// [JsonInclude, JsonPropertyName("avg_service_time")] public Elastic.Clients.Elasticsearch.Duration? AvgServiceTime { get; init; } /// - /// The exponentially weighted moving average service time, in nanoseconds, of search requests on the keyed node. + /// + /// The exponentially weighted moving average service time, in nanoseconds, of search requests on the keyed node. + /// /// [JsonInclude, JsonPropertyName("avg_service_time_ns")] public long? AvgServiceTimeNs { get; init; } /// - /// The number of outstanding search requests to the keyed node from the node these stats are for. + /// + /// The number of outstanding search requests to the keyed node from the node these stats are for. + /// /// [JsonInclude, JsonPropertyName("outgoing_searches")] public long? OutgoingSearches { get; init; } /// - /// The rank of this node; used for shard selection when routing search requests. + /// + /// The rank of this node; used for shard selection when routing search requests. + /// /// [JsonInclude, JsonPropertyName("rank")] public string? Rank { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Breaker.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Breaker.g.cs index b6f17421a7c..b12d1045956 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Breaker.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Breaker.g.cs @@ -30,37 +30,49 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class Breaker { /// - /// Estimated memory used for the operation. + /// + /// Estimated memory used for the operation. + /// /// [JsonInclude, JsonPropertyName("estimated_size")] public string? EstimatedSize { get; init; } /// - /// Estimated memory used, in bytes, for the operation. + /// + /// Estimated memory used, in bytes, for the operation. + /// /// [JsonInclude, JsonPropertyName("estimated_size_in_bytes")] public long? EstimatedSizeInBytes { get; init; } /// - /// Memory limit for the circuit breaker. + /// + /// Memory limit for the circuit breaker. + /// /// [JsonInclude, JsonPropertyName("limit_size")] public string? LimitSize { get; init; } /// - /// Memory limit, in bytes, for the circuit breaker. + /// + /// Memory limit, in bytes, for the circuit breaker. + /// /// [JsonInclude, JsonPropertyName("limit_size_in_bytes")] public long? LimitSizeInBytes { get; init; } /// - /// A constant that all estimates for the circuit breaker are multiplied with to calculate a final estimate. + /// + /// A constant that all estimates for the circuit breaker are multiplied with to calculate a final estimate. + /// /// [JsonInclude, JsonPropertyName("overhead")] public float? Overhead { get; init; } /// - /// Total number of times the circuit breaker has been triggered and prevented an out of memory error. + /// + /// Total number of times the circuit breaker has been triggered and prevented an out of memory error. + /// /// [JsonInclude, JsonPropertyName("tripped")] public float? Tripped { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Cgroup.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Cgroup.g.cs index 620c586977d..dbdd1a0c9e8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Cgroup.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Cgroup.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class Cgroup { /// - /// Contains statistics about `cpu` control group for the node. + /// + /// Contains statistics about cpu control group for the node. + /// /// [JsonInclude, JsonPropertyName("cpu")] public Elastic.Clients.Elasticsearch.Nodes.CgroupCpu? Cpu { get; init; } /// - /// Contains statistics about `cpuacct` control group for the node. + /// + /// Contains statistics about cpuacct control group for the node. + /// /// [JsonInclude, JsonPropertyName("cpuacct")] public Elastic.Clients.Elasticsearch.Nodes.CpuAcct? Cpuacct { get; init; } /// - /// Contains statistics about the memory control group for the node. + /// + /// Contains statistics about the memory control group for the node. + /// /// [JsonInclude, JsonPropertyName("memory")] public Elastic.Clients.Elasticsearch.Nodes.CgroupMemory? Memory { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/CgroupCpu.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/CgroupCpu.g.cs index c3bc00e45bd..5573b0965ef 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/CgroupCpu.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/CgroupCpu.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class CgroupCpu { /// - /// The period of time, in microseconds, for how regularly all tasks in the same cgroup as the Elasticsearch process should have their access to CPU resources reallocated. + /// + /// The period of time, in microseconds, for how regularly all tasks in the same cgroup as the Elasticsearch process should have their access to CPU resources reallocated. + /// /// [JsonInclude, JsonPropertyName("cfs_period_micros")] public int? CfsPeriodMicros { get; init; } /// - /// The total amount of time, in microseconds, for which all tasks in the same cgroup as the Elasticsearch process can run during one period `cfs_period_micros`. + /// + /// The total amount of time, in microseconds, for which all tasks in the same cgroup as the Elasticsearch process can run during one period cfs_period_micros. + /// /// [JsonInclude, JsonPropertyName("cfs_quota_micros")] public int? CfsQuotaMicros { get; init; } /// - /// The `cpu` control group to which the Elasticsearch process belongs. + /// + /// The cpu control group to which the Elasticsearch process belongs. + /// /// [JsonInclude, JsonPropertyName("control_group")] public string? ControlGroup { get; init; } /// - /// Contains CPU statistics for the node. + /// + /// Contains CPU statistics for the node. + /// /// [JsonInclude, JsonPropertyName("stat")] public Elastic.Clients.Elasticsearch.Nodes.CgroupCpuStat? Stat { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/CgroupCpuStat.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/CgroupCpuStat.g.cs index 1788bf6f558..ed250976749 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/CgroupCpuStat.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/CgroupCpuStat.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class CgroupCpuStat { /// - /// The number of reporting periods (as specified by `cfs_period_micros`) that have elapsed. + /// + /// The number of reporting periods (as specified by cfs_period_micros) that have elapsed. + /// /// [JsonInclude, JsonPropertyName("number_of_elapsed_periods")] public long? NumberOfElapsedPeriods { get; init; } /// - /// The number of times all tasks in the same cgroup as the Elasticsearch process have been throttled. + /// + /// The number of times all tasks in the same cgroup as the Elasticsearch process have been throttled. + /// /// [JsonInclude, JsonPropertyName("number_of_times_throttled")] public long? NumberOfTimesThrottled { get; init; } /// - /// The total amount of time, in nanoseconds, for which all tasks in the same cgroup as the Elasticsearch process have been throttled. + /// + /// The total amount of time, in nanoseconds, for which all tasks in the same cgroup as the Elasticsearch process have been throttled. + /// /// [JsonInclude, JsonPropertyName("time_throttled_nanos")] public long? TimeThrottledNanos { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/CgroupMemory.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/CgroupMemory.g.cs index 4841426b25f..49c8355d6c0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/CgroupMemory.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/CgroupMemory.g.cs @@ -30,19 +30,28 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class CgroupMemory { /// - /// The `memory` control group to which the Elasticsearch process belongs. + /// + /// The memory control group to which the Elasticsearch process belongs. + /// /// [JsonInclude, JsonPropertyName("control_group")] public string? ControlGroup { get; init; } /// - /// The maximum amount of user memory (including file cache) allowed for all tasks in the same cgroup as the Elasticsearch process.
This value can be too big to store in a `long`, so is returned as a string so that the value returned can exactly match what the underlying operating system interface returns.
Any value that is too large to parse into a `long` almost certainly means no limit has been set for the cgroup. + /// + /// The maximum amount of user memory (including file cache) allowed for all tasks in the same cgroup as the Elasticsearch process. + /// This value can be too big to store in a long, so is returned as a string so that the value returned can exactly match what the underlying operating system interface returns. + /// Any value that is too large to parse into a long almost certainly means no limit has been set for the cgroup. + /// /// [JsonInclude, JsonPropertyName("limit_in_bytes")] public string? LimitInBytes { get; init; } /// - /// The total current memory usage by processes in the cgroup, in bytes, by all tasks in the same cgroup as the Elasticsearch process.
This value is stored as a string for consistency with `limit_in_bytes`. + /// + /// The total current memory usage by processes in the cgroup, in bytes, by all tasks in the same cgroup as the Elasticsearch process. + /// This value is stored as a string for consistency with limit_in_bytes. + /// /// [JsonInclude, JsonPropertyName("usage_in_bytes")] public string? UsageInBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Client.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Client.g.cs index db12ac86d73..0e92f7c3396 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Client.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Client.g.cs @@ -30,67 +30,91 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class Client { /// - /// Reported agent for the HTTP client.
If unavailable, this property is not included in the response. + /// + /// Reported agent for the HTTP client. + /// If unavailable, this property is not included in the response. + /// /// [JsonInclude, JsonPropertyName("agent")] public string? Agent { get; init; } /// - /// Time at which the client closed the connection if the connection is closed. + /// + /// Time at which the client closed the connection if the connection is closed. + /// /// [JsonInclude, JsonPropertyName("closed_time_millis")] public long? ClosedTimeMillis { get; init; } /// - /// Unique ID for the HTTP client. + /// + /// Unique ID for the HTTP client. + /// /// [JsonInclude, JsonPropertyName("id")] public long? Id { get; init; } /// - /// Time of the most recent request from this client. + /// + /// Time of the most recent request from this client. + /// /// [JsonInclude, JsonPropertyName("last_request_time_millis")] public long? LastRequestTimeMillis { get; init; } /// - /// The URI of the client’s most recent request. + /// + /// The URI of the client’s most recent request. + /// /// [JsonInclude, JsonPropertyName("last_uri")] public string? LastUri { get; init; } /// - /// Local address for the HTTP connection. + /// + /// Local address for the HTTP connection. + /// /// [JsonInclude, JsonPropertyName("local_address")] public string? LocalAddress { get; init; } /// - /// Time at which the client opened the connection. + /// + /// Time at which the client opened the connection. + /// /// [JsonInclude, JsonPropertyName("opened_time_millis")] public long? OpenedTimeMillis { get; init; } /// - /// Remote address for the HTTP connection. + /// + /// Remote address for the HTTP connection. + /// /// [JsonInclude, JsonPropertyName("remote_address")] public string? RemoteAddress { get; init; } /// - /// Number of requests from this client. + /// + /// Number of requests from this client. + /// /// [JsonInclude, JsonPropertyName("request_count")] public long? RequestCount { get; init; } /// - /// Cumulative size in bytes of all requests from this client. + /// + /// Cumulative size in bytes of all requests from this client. + /// /// [JsonInclude, JsonPropertyName("request_size_bytes")] public long? RequestSizeBytes { get; init; } /// - /// Value from the client’s `x-opaque-id` HTTP header.
If unavailable, this property is not included in the response. + /// + /// Value from the client’s x-opaque-id HTTP header. + /// If unavailable, this property is not included in the response. + /// /// [JsonInclude, JsonPropertyName("x_opaque_id")] public string? XOpaqueId { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/ClusterStateQueue.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/ClusterStateQueue.g.cs index 79e05da95f2..0c83ff282b1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/ClusterStateQueue.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/ClusterStateQueue.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class ClusterStateQueue { /// - /// Number of committed cluster states in queue. + /// + /// Number of committed cluster states in queue. + /// /// [JsonInclude, JsonPropertyName("committed")] public long? Committed { get; init; } /// - /// Number of pending cluster states in queue. + /// + /// Number of pending cluster states in queue. + /// /// [JsonInclude, JsonPropertyName("pending")] public long? Pending { get; init; } /// - /// Total number of cluster states in queue. + /// + /// Total number of cluster states in queue. + /// /// [JsonInclude, JsonPropertyName("total")] public long? Total { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/ClusterStateUpdate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/ClusterStateUpdate.g.cs index f06209c153c..3a675dc1145 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/ClusterStateUpdate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/ClusterStateUpdate.g.cs @@ -30,91 +30,125 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class ClusterStateUpdate { /// - /// The cumulative amount of time spent waiting for a successful cluster state update to commit, which measures the time from the start of each publication until a majority of the master-eligible nodes have written the state to disk and confirmed the write to the elected master. + /// + /// The cumulative amount of time spent waiting for a successful cluster state update to commit, which measures the time from the start of each publication until a majority of the master-eligible nodes have written the state to disk and confirmed the write to the elected master. + /// /// [JsonInclude, JsonPropertyName("commit_time")] public Elastic.Clients.Elasticsearch.Duration? CommitTime { get; init; } /// - /// The cumulative amount of time, in milliseconds, spent waiting for a successful cluster state update to commit, which measures the time from the start of each publication until a majority of the master-eligible nodes have written the state to disk and confirmed the write to the elected master. + /// + /// The cumulative amount of time, in milliseconds, spent waiting for a successful cluster state update to commit, which measures the time from the start of each publication until a majority of the master-eligible nodes have written the state to disk and confirmed the write to the elected master. + /// /// [JsonInclude, JsonPropertyName("commit_time_millis")] public long? CommitTimeMillis { get; init; } /// - /// The cumulative amount of time spent waiting for a successful cluster state update to complete, which measures the time from the start of each publication until all the other nodes have notified the elected master that they have applied the cluster state. + /// + /// The cumulative amount of time spent waiting for a successful cluster state update to complete, which measures the time from the start of each publication until all the other nodes have notified the elected master that they have applied the cluster state. + /// /// [JsonInclude, JsonPropertyName("completion_time")] public Elastic.Clients.Elasticsearch.Duration? CompletionTime { get; init; } /// - /// The cumulative amount of time, in milliseconds, spent waiting for a successful cluster state update to complete, which measures the time from the start of each publication until all the other nodes have notified the elected master that they have applied the cluster state. + /// + /// The cumulative amount of time, in milliseconds, spent waiting for a successful cluster state update to complete, which measures the time from the start of each publication until all the other nodes have notified the elected master that they have applied the cluster state. + /// /// [JsonInclude, JsonPropertyName("completion_time_millis")] public long? CompletionTimeMillis { get; init; } /// - /// The cumulative amount of time spent computing no-op cluster state updates since the node started. + /// + /// The cumulative amount of time spent computing no-op cluster state updates since the node started. + /// /// [JsonInclude, JsonPropertyName("computation_time")] public Elastic.Clients.Elasticsearch.Duration? ComputationTime { get; init; } /// - /// The cumulative amount of time, in milliseconds, spent computing no-op cluster state updates since the node started. + /// + /// The cumulative amount of time, in milliseconds, spent computing no-op cluster state updates since the node started. + /// /// [JsonInclude, JsonPropertyName("computation_time_millis")] public long? ComputationTimeMillis { get; init; } /// - /// The cumulative amount of time spent constructing a publication context since the node started for publications that ultimately succeeded.
This statistic includes the time spent computing the difference between the current and new cluster state preparing a serialized representation of this difference. + /// + /// The cumulative amount of time spent constructing a publication context since the node started for publications that ultimately succeeded. + /// This statistic includes the time spent computing the difference between the current and new cluster state preparing a serialized representation of this difference. + /// /// [JsonInclude, JsonPropertyName("context_construction_time")] public Elastic.Clients.Elasticsearch.Duration? ContextConstructionTime { get; init; } /// - /// The cumulative amount of time, in milliseconds, spent constructing a publication context since the node started for publications that ultimately succeeded.
This statistic includes the time spent computing the difference between the current and new cluster state preparing a serialized representation of this difference. + /// + /// The cumulative amount of time, in milliseconds, spent constructing a publication context since the node started for publications that ultimately succeeded. + /// This statistic includes the time spent computing the difference between the current and new cluster state preparing a serialized representation of this difference. + /// /// [JsonInclude, JsonPropertyName("context_construction_time_millis")] public long? ContextConstructionTimeMillis { get; init; } /// - /// The number of cluster state update attempts that did not change the cluster state since the node started. + /// + /// The number of cluster state update attempts that did not change the cluster state since the node started. + /// /// [JsonInclude, JsonPropertyName("count")] public long Count { get; init; } /// - /// The cumulative amount of time spent successfully applying cluster state updates on the elected master since the node started. + /// + /// The cumulative amount of time spent successfully applying cluster state updates on the elected master since the node started. + /// /// [JsonInclude, JsonPropertyName("master_apply_time")] public Elastic.Clients.Elasticsearch.Duration? MasterApplyTime { get; init; } /// - /// The cumulative amount of time, in milliseconds, spent successfully applying cluster state updates on the elected master since the node started. + /// + /// The cumulative amount of time, in milliseconds, spent successfully applying cluster state updates on the elected master since the node started. + /// /// [JsonInclude, JsonPropertyName("master_apply_time_millis")] public long? MasterApplyTimeMillis { get; init; } /// - /// The cumulative amount of time spent notifying listeners of a no-op cluster state update since the node started. + /// + /// The cumulative amount of time spent notifying listeners of a no-op cluster state update since the node started. + /// /// [JsonInclude, JsonPropertyName("notification_time")] public Elastic.Clients.Elasticsearch.Duration? NotificationTime { get; init; } /// - /// The cumulative amount of time, in milliseconds, spent notifying listeners of a no-op cluster state update since the node started. + /// + /// The cumulative amount of time, in milliseconds, spent notifying listeners of a no-op cluster state update since the node started. + /// /// [JsonInclude, JsonPropertyName("notification_time_millis")] public long? NotificationTimeMillis { get; init; } /// - /// The cumulative amount of time spent publishing cluster state updates which ultimately succeeded, which includes everything from the start of the publication (just after the computation of the new cluster state) until the publication has finished and the master node is ready to start processing the next state update.
This includes the time measured by `context_construction_time`, `commit_time`, `completion_time` and `master_apply_time`. + /// + /// The cumulative amount of time spent publishing cluster state updates which ultimately succeeded, which includes everything from the start of the publication (just after the computation of the new cluster state) until the publication has finished and the master node is ready to start processing the next state update. + /// This includes the time measured by context_construction_time, commit_time, completion_time and master_apply_time. + /// /// [JsonInclude, JsonPropertyName("publication_time")] public Elastic.Clients.Elasticsearch.Duration? PublicationTime { get; init; } /// - /// The cumulative amount of time, in milliseconds, spent publishing cluster state updates which ultimately succeeded, which includes everything from the start of the publication (just after the computation of the new cluster state) until the publication has finished and the master node is ready to start processing the next state update.
This includes the time measured by `context_construction_time`, `commit_time`, `completion_time` and `master_apply_time`. + /// + /// The cumulative amount of time, in milliseconds, spent publishing cluster state updates which ultimately succeeded, which includes everything from the start of the publication (just after the computation of the new cluster state) until the publication has finished and the master node is ready to start processing the next state update. + /// This includes the time measured by context_construction_time, commit_time, completion_time and master_apply_time. + /// /// [JsonInclude, JsonPropertyName("publication_time_millis")] public long? PublicationTimeMillis { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/CpuAcct.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/CpuAcct.g.cs index a9952445cf7..7be66a203e6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/CpuAcct.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/CpuAcct.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class CpuAcct { /// - /// The `cpuacct` control group to which the Elasticsearch process belongs. + /// + /// The cpuacct control group to which the Elasticsearch process belongs. + /// /// [JsonInclude, JsonPropertyName("control_group")] public string? ControlGroup { get; init; } /// - /// The total CPU time, in nanoseconds, consumed by all tasks in the same cgroup as the Elasticsearch process. + /// + /// The total CPU time, in nanoseconds, consumed by all tasks in the same cgroup as the Elasticsearch process. + /// /// [JsonInclude, JsonPropertyName("usage_nanos")] public long? UsageNanos { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/DataPathStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/DataPathStats.g.cs index 24497306b61..051acae57e8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/DataPathStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/DataPathStats.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class DataPathStats { /// - /// Total amount of disk space available to this Java virtual machine on this file store. + /// + /// Total amount of disk space available to this Java virtual machine on this file store. + /// /// [JsonInclude, JsonPropertyName("available")] public string? Available { get; init; } /// - /// Total number of bytes available to this Java virtual machine on this file store. + /// + /// Total number of bytes available to this Java virtual machine on this file store. + /// /// [JsonInclude, JsonPropertyName("available_in_bytes")] public long? AvailableInBytes { get; init; } @@ -56,43 +60,57 @@ public sealed partial class DataPathStats public long? DiskWriteSizeInBytes { get; init; } /// - /// Total amount of unallocated disk space in the file store. + /// + /// Total amount of unallocated disk space in the file store. + /// /// [JsonInclude, JsonPropertyName("free")] public string? Free { get; init; } /// - /// Total number of unallocated bytes in the file store. + /// + /// Total number of unallocated bytes in the file store. + /// /// [JsonInclude, JsonPropertyName("free_in_bytes")] public long? FreeInBytes { get; init; } /// - /// Mount point of the file store (for example: `/dev/sda2`). + /// + /// Mount point of the file store (for example: /dev/sda2). + /// /// [JsonInclude, JsonPropertyName("mount")] public string? Mount { get; init; } /// - /// Path to the file store. + /// + /// Path to the file store. + /// /// [JsonInclude, JsonPropertyName("path")] public string? Path { get; init; } /// - /// Total size of the file store. + /// + /// Total size of the file store. + /// /// [JsonInclude, JsonPropertyName("total")] public string? Total { get; init; } /// - /// Total size of the file store in bytes. + /// + /// Total size of the file store in bytes. + /// /// [JsonInclude, JsonPropertyName("total_in_bytes")] public long? TotalInBytes { get; init; } /// - /// Type of the file store (ex: ext4). + /// + /// Type of the file store (ex: ext4). + /// /// [JsonInclude, JsonPropertyName("type")] public string? Type { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Discovery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Discovery.g.cs index b76b08f3157..67c3e3b670a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Discovery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Discovery.g.cs @@ -33,19 +33,28 @@ public sealed partial class Discovery public Elastic.Clients.Elasticsearch.Nodes.ClusterAppliedStats? ClusterApplierStats { get; init; } /// - /// Contains statistics for the cluster state queue of the node. + /// + /// Contains statistics for the cluster state queue of the node. + /// /// [JsonInclude, JsonPropertyName("cluster_state_queue")] public Elastic.Clients.Elasticsearch.Nodes.ClusterStateQueue? ClusterStateQueue { get; init; } /// - /// Contains low-level statistics about how long various activities took during cluster state updates while the node was the elected master.
Omitted if the node is not master-eligible.
Every field whose name ends in `_time` within this object is also represented as a raw number of milliseconds in a field whose name ends in `_time_millis`.
The human-readable fields with a `_time` suffix are only returned if requested with the `?human=true` query parameter. + /// + /// Contains low-level statistics about how long various activities took during cluster state updates while the node was the elected master. + /// Omitted if the node is not master-eligible. + /// Every field whose name ends in _time within this object is also represented as a raw number of milliseconds in a field whose name ends in _time_millis. + /// The human-readable fields with a _time suffix are only returned if requested with the ?human=true query parameter. + /// /// [JsonInclude, JsonPropertyName("cluster_state_update")] public IReadOnlyDictionary? ClusterStateUpdate { get; init; } /// - /// Contains statistics for the published cluster states of the node. + /// + /// Contains statistics for the published cluster states of the node. + /// /// [JsonInclude, JsonPropertyName("published_cluster_states")] public Elastic.Clients.Elasticsearch.Nodes.PublishedClusterStates? PublishedClusterStates { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/ExtendedMemoryStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/ExtendedMemoryStats.g.cs index f12a133b96f..38aa4ffd6ad 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/ExtendedMemoryStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/ExtendedMemoryStats.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class ExtendedMemoryStats { /// - /// If the amount of physical memory has been overridden using the `es`.`total_memory_bytes` system property then this reports the overridden value in bytes.
Otherwise it reports the same value as `total_in_bytes`. + /// + /// If the amount of physical memory has been overridden using the es.total_memory_bytes system property then this reports the overridden value in bytes. + /// Otherwise it reports the same value as total_in_bytes. + /// /// [JsonInclude, JsonPropertyName("adjusted_total_in_bytes")] public long? AdjustedTotalInBytes { get; init; } /// - /// Amount of free physical memory in bytes. + /// + /// Amount of free physical memory in bytes. + /// /// [JsonInclude, JsonPropertyName("free_in_bytes")] public long? FreeInBytes { get; init; } /// - /// Percentage of free memory. + /// + /// Percentage of free memory. + /// /// [JsonInclude, JsonPropertyName("free_percent")] public int? FreePercent { get; init; } @@ -56,7 +63,9 @@ public sealed partial class ExtendedMemoryStats public long? ShareInBytes { get; init; } /// - /// Total amount of physical memory in bytes. + /// + /// Total amount of physical memory in bytes. + /// /// [JsonInclude, JsonPropertyName("total_in_bytes")] public long? TotalInBytes { get; init; } @@ -66,13 +75,17 @@ public sealed partial class ExtendedMemoryStats public long? TotalVirtualInBytes { get; init; } /// - /// Amount of used physical memory in bytes. + /// + /// Amount of used physical memory in bytes. + /// /// [JsonInclude, JsonPropertyName("used_in_bytes")] public long? UsedInBytes { get; init; } /// - /// Percentage of used memory. + /// + /// Percentage of used memory. + /// /// [JsonInclude, JsonPropertyName("used_percent")] public int? UsedPercent { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/FileSystem.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/FileSystem.g.cs index d08d5047a24..49c11657ba0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/FileSystem.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/FileSystem.g.cs @@ -30,25 +30,34 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class FileSystem { /// - /// List of all file stores. + /// + /// List of all file stores. + /// /// [JsonInclude, JsonPropertyName("data")] public IReadOnlyCollection? Data { get; init; } /// - /// Contains I/O statistics for the node. + /// + /// Contains I/O statistics for the node. + /// /// [JsonInclude, JsonPropertyName("io_stats")] public Elastic.Clients.Elasticsearch.Nodes.IoStats? IoStats { get; init; } /// - /// Last time the file stores statistics were refreshed.
Recorded in milliseconds since the Unix Epoch. + /// + /// Last time the file stores statistics were refreshed. + /// Recorded in milliseconds since the Unix Epoch. + /// /// [JsonInclude, JsonPropertyName("timestamp")] public long? Timestamp { get; init; } /// - /// Contains statistics for all file stores of the node. + /// + /// Contains statistics for all file stores of the node. + /// /// [JsonInclude, JsonPropertyName("total")] public Elastic.Clients.Elasticsearch.Nodes.FileSystemTotal? Total { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/FileSystemTotal.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/FileSystemTotal.g.cs index c59517edcdc..2e297dcc9bf 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/FileSystemTotal.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/FileSystemTotal.g.cs @@ -30,37 +30,53 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class FileSystemTotal { /// - /// Total disk space available to this Java virtual machine on all file stores.
Depending on OS or process level restrictions, this might appear less than `free`.
This is the actual amount of free disk space the Elasticsearch node can utilise. + /// + /// Total disk space available to this Java virtual machine on all file stores. + /// Depending on OS or process level restrictions, this might appear less than free. + /// This is the actual amount of free disk space the Elasticsearch node can utilise. + /// /// [JsonInclude, JsonPropertyName("available")] public string? Available { get; init; } /// - /// Total number of bytes available to this Java virtual machine on all file stores.
Depending on OS or process level restrictions, this might appear less than `free_in_bytes`.
This is the actual amount of free disk space the Elasticsearch node can utilise. + /// + /// Total number of bytes available to this Java virtual machine on all file stores. + /// Depending on OS or process level restrictions, this might appear less than free_in_bytes. + /// This is the actual amount of free disk space the Elasticsearch node can utilise. + /// /// [JsonInclude, JsonPropertyName("available_in_bytes")] public long? AvailableInBytes { get; init; } /// - /// Total unallocated disk space in all file stores. + /// + /// Total unallocated disk space in all file stores. + /// /// [JsonInclude, JsonPropertyName("free")] public string? Free { get; init; } /// - /// Total number of unallocated bytes in all file stores. + /// + /// Total number of unallocated bytes in all file stores. + /// /// [JsonInclude, JsonPropertyName("free_in_bytes")] public long? FreeInBytes { get; init; } /// - /// Total size of all file stores. + /// + /// Total size of all file stores. + /// /// [JsonInclude, JsonPropertyName("total")] public string? Total { get; init; } /// - /// Total size of all file stores in bytes. + /// + /// Total size of all file stores in bytes. + /// /// [JsonInclude, JsonPropertyName("total_in_bytes")] public long? TotalInBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/GarbageCollector.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/GarbageCollector.g.cs index b3ac6237096..44cb1134a22 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/GarbageCollector.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/GarbageCollector.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class GarbageCollector { /// - /// Contains statistics about JVM garbage collectors for the node. + /// + /// Contains statistics about JVM garbage collectors for the node. + /// /// [JsonInclude, JsonPropertyName("collectors")] public IReadOnlyDictionary? Collectors { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/GarbageCollectorTotal.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/GarbageCollectorTotal.g.cs index 96cea5fcc94..5597b632c34 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/GarbageCollectorTotal.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/GarbageCollectorTotal.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class GarbageCollectorTotal { /// - /// Total number of JVM garbage collectors that collect objects. + /// + /// Total number of JVM garbage collectors that collect objects. + /// /// [JsonInclude, JsonPropertyName("collection_count")] public long? CollectionCount { get; init; } /// - /// Total time spent by JVM collecting objects. + /// + /// Total time spent by JVM collecting objects. + /// /// [JsonInclude, JsonPropertyName("collection_time")] public string? CollectionTime { get; init; } /// - /// Total time, in milliseconds, spent by JVM collecting objects. + /// + /// Total time, in milliseconds, spent by JVM collecting objects. + /// /// [JsonInclude, JsonPropertyName("collection_time_in_millis")] public long? CollectionTimeInMillis { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Http.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Http.g.cs index 34df5d0074c..26dad0d1a8f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Http.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Http.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class Http { /// - /// Information on current and recently-closed HTTP client connections.
Clients that have been closed longer than the `http.client_stats.closed_channels.max_age` setting will not be represented here. + /// + /// Information on current and recently-closed HTTP client connections. + /// Clients that have been closed longer than the http.client_stats.closed_channels.max_age setting will not be represented here. + /// /// [JsonInclude, JsonPropertyName("clients")] public IReadOnlyCollection? Clients { get; init; } /// - /// Current number of open HTTP connections for the node. + /// + /// Current number of open HTTP connections for the node. + /// /// [JsonInclude, JsonPropertyName("current_open")] public int? CurrentOpen { get; init; } /// - /// Total number of HTTP connections opened for the node. + /// + /// Total number of HTTP connections opened for the node. + /// /// [JsonInclude, JsonPropertyName("total_opened")] public long? TotalOpened { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/IndexingPressure.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/IndexingPressure.g.cs index fa323ab808e..b8f86f7d675 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/IndexingPressure.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/IndexingPressure.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class IndexingPressure { /// - /// Contains statistics for memory consumption from indexing load. + /// + /// Contains statistics for memory consumption from indexing load. + /// /// [JsonInclude, JsonPropertyName("memory")] public Elastic.Clients.Elasticsearch.Nodes.IndexingPressureMemory? Memory { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/IndexingPressureMemory.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/IndexingPressureMemory.g.cs index 9cb87559847..5b13bd2eba6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/IndexingPressureMemory.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/IndexingPressureMemory.g.cs @@ -30,25 +30,35 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class IndexingPressureMemory { /// - /// Contains statistics for current indexing load. + /// + /// Contains statistics for current indexing load. + /// /// [JsonInclude, JsonPropertyName("current")] public Elastic.Clients.Elasticsearch.Nodes.PressureMemory? Current { get; init; } /// - /// Configured memory limit for the indexing requests.
Replica requests have an automatic limit that is 1.5x this value. + /// + /// Configured memory limit for the indexing requests. + /// Replica requests have an automatic limit that is 1.5x this value. + /// /// [JsonInclude, JsonPropertyName("limit")] public Elastic.Clients.Elasticsearch.ByteSize? Limit { get; init; } /// - /// Configured memory limit, in bytes, for the indexing requests.
Replica requests have an automatic limit that is 1.5x this value. + /// + /// Configured memory limit, in bytes, for the indexing requests. + /// Replica requests have an automatic limit that is 1.5x this value. + /// /// [JsonInclude, JsonPropertyName("limit_in_bytes")] public long? LimitInBytes { get; init; } /// - /// Contains statistics for the cumulative indexing load since the node started. + /// + /// Contains statistics for the cumulative indexing load since the node started. + /// /// [JsonInclude, JsonPropertyName("total")] public Elastic.Clients.Elasticsearch.Nodes.PressureMemory? Total { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Ingest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Ingest.g.cs index 35c707a3545..c006508a460 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Ingest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Ingest.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class Ingest { /// - /// Contains statistics about ingest pipelines for the node. + /// + /// Contains statistics about ingest pipelines for the node. + /// /// [JsonInclude, JsonPropertyName("pipelines")] public IReadOnlyDictionary? Pipelines { get; init; } /// - /// Contains statistics about ingest operations for the node. + /// + /// Contains statistics about ingest operations for the node. + /// /// [JsonInclude, JsonPropertyName("total")] public Elastic.Clients.Elasticsearch.Nodes.IngestTotal? Total { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/IngestTotal.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/IngestTotal.g.cs index 341a68b1d31..36be833970c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/IngestTotal.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/IngestTotal.g.cs @@ -30,31 +30,41 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class IngestTotal { /// - /// Total number of documents ingested during the lifetime of this node. + /// + /// Total number of documents ingested during the lifetime of this node. + /// /// [JsonInclude, JsonPropertyName("count")] public long? Count { get; init; } /// - /// Total number of documents currently being ingested. + /// + /// Total number of documents currently being ingested. + /// /// [JsonInclude, JsonPropertyName("current")] public long? Current { get; init; } /// - /// Total number of failed ingest operations during the lifetime of this node. + /// + /// Total number of failed ingest operations during the lifetime of this node. + /// /// [JsonInclude, JsonPropertyName("failed")] public long? Failed { get; init; } /// - /// Total number of ingest processors. + /// + /// Total number of ingest processors. + /// /// [JsonInclude, JsonPropertyName("processors")] public IReadOnlyCollection>? Processors { get; init; } /// - /// Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node. + /// + /// Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node. + /// /// [JsonInclude, JsonPropertyName("time_in_millis")] public long? TimeInMillis { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/IoStatDevice.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/IoStatDevice.g.cs index d8f676bd24b..4491afcdce6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/IoStatDevice.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/IoStatDevice.g.cs @@ -30,37 +30,49 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class IoStatDevice { /// - /// The Linux device name. + /// + /// The Linux device name. + /// /// [JsonInclude, JsonPropertyName("device_name")] public string? DeviceName { get; init; } /// - /// The total number of read and write operations for the device completed since starting Elasticsearch. + /// + /// The total number of read and write operations for the device completed since starting Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("operations")] public long? Operations { get; init; } /// - /// The total number of kilobytes read for the device since starting Elasticsearch. + /// + /// The total number of kilobytes read for the device since starting Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("read_kilobytes")] public long? ReadKilobytes { get; init; } /// - /// The total number of read operations for the device completed since starting Elasticsearch. + /// + /// The total number of read operations for the device completed since starting Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("read_operations")] public long? ReadOperations { get; init; } /// - /// The total number of kilobytes written for the device since starting Elasticsearch. + /// + /// The total number of kilobytes written for the device since starting Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("write_kilobytes")] public long? WriteKilobytes { get; init; } /// - /// The total number of write operations for the device completed since starting Elasticsearch. + /// + /// The total number of write operations for the device completed since starting Elasticsearch. + /// /// [JsonInclude, JsonPropertyName("write_operations")] public long? WriteOperations { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/IoStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/IoStats.g.cs index 2fe727493b5..d855273dd20 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/IoStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/IoStats.g.cs @@ -30,13 +30,18 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class IoStats { /// - /// Array of disk metrics for each device that is backing an Elasticsearch data path.
These disk metrics are probed periodically and averages between the last probe and the current probe are computed. + /// + /// Array of disk metrics for each device that is backing an Elasticsearch data path. + /// These disk metrics are probed periodically and averages between the last probe and the current probe are computed. + /// /// [JsonInclude, JsonPropertyName("devices")] public IReadOnlyCollection? Devices { get; init; } /// - /// The sum of the disk metrics for all devices that back an Elasticsearch data path. + /// + /// The sum of the disk metrics for all devices that back an Elasticsearch data path. + /// /// [JsonInclude, JsonPropertyName("total")] public Elastic.Clients.Elasticsearch.Nodes.IoStatDevice? Total { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Jvm.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Jvm.g.cs index 6f9a26a0998..c4697505562 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Jvm.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Jvm.g.cs @@ -30,49 +30,66 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class Jvm { /// - /// Contains statistics about JVM buffer pools for the node. + /// + /// Contains statistics about JVM buffer pools for the node. + /// /// [JsonInclude, JsonPropertyName("buffer_pools")] public IReadOnlyDictionary? BufferPools { get; init; } /// - /// Contains statistics about classes loaded by JVM for the node. + /// + /// Contains statistics about classes loaded by JVM for the node. + /// /// [JsonInclude, JsonPropertyName("classes")] public Elastic.Clients.Elasticsearch.Nodes.JvmClasses? Classes { get; init; } /// - /// Contains statistics about JVM garbage collectors for the node. + /// + /// Contains statistics about JVM garbage collectors for the node. + /// /// [JsonInclude, JsonPropertyName("gc")] public Elastic.Clients.Elasticsearch.Nodes.GarbageCollector? Gc { get; init; } /// - /// Contains JVM memory usage statistics for the node. + /// + /// Contains JVM memory usage statistics for the node. + /// /// [JsonInclude, JsonPropertyName("mem")] public Elastic.Clients.Elasticsearch.Nodes.JvmMemoryStats? Mem { get; init; } /// - /// Contains statistics about JVM thread usage for the node. + /// + /// Contains statistics about JVM thread usage for the node. + /// /// [JsonInclude, JsonPropertyName("threads")] public Elastic.Clients.Elasticsearch.Nodes.JvmThreads? Threads { get; init; } /// - /// Last time JVM statistics were refreshed. + /// + /// Last time JVM statistics were refreshed. + /// /// [JsonInclude, JsonPropertyName("timestamp")] public long? Timestamp { get; init; } /// - /// Human-readable JVM uptime.
Only returned if the `human` query parameter is `true`. + /// + /// Human-readable JVM uptime. + /// Only returned if the human query parameter is true. + /// /// [JsonInclude, JsonPropertyName("uptime")] public string? Uptime { get; init; } /// - /// JVM uptime in milliseconds. + /// + /// JVM uptime in milliseconds. + /// /// [JsonInclude, JsonPropertyName("uptime_in_millis")] public long? UptimeInMillis { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/JvmClasses.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/JvmClasses.g.cs index 77153bc70ca..ad88dabff74 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/JvmClasses.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/JvmClasses.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class JvmClasses { /// - /// Number of classes currently loaded by JVM. + /// + /// Number of classes currently loaded by JVM. + /// /// [JsonInclude, JsonPropertyName("current_loaded_count")] public long? CurrentLoadedCount { get; init; } /// - /// Total number of classes loaded since the JVM started. + /// + /// Total number of classes loaded since the JVM started. + /// /// [JsonInclude, JsonPropertyName("total_loaded_count")] public long? TotalLoadedCount { get; init; } /// - /// Total number of classes unloaded since the JVM started. + /// + /// Total number of classes unloaded since the JVM started. + /// /// [JsonInclude, JsonPropertyName("total_unloaded_count")] public long? TotalUnloadedCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/JvmMemoryStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/JvmMemoryStats.g.cs index 6809efc55d4..e7caecef5c5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/JvmMemoryStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/JvmMemoryStats.g.cs @@ -30,43 +30,57 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class JvmMemoryStats { /// - /// Amount of memory, in bytes, available for use by the heap. + /// + /// Amount of memory, in bytes, available for use by the heap. + /// /// [JsonInclude, JsonPropertyName("heap_committed_in_bytes")] public long? HeapCommittedInBytes { get; init; } /// - /// Maximum amount of memory, in bytes, available for use by the heap. + /// + /// Maximum amount of memory, in bytes, available for use by the heap. + /// /// [JsonInclude, JsonPropertyName("heap_max_in_bytes")] public long? HeapMaxInBytes { get; init; } /// - /// Memory, in bytes, currently in use by the heap. + /// + /// Memory, in bytes, currently in use by the heap. + /// /// [JsonInclude, JsonPropertyName("heap_used_in_bytes")] public long? HeapUsedInBytes { get; init; } /// - /// Percentage of memory currently in use by the heap. + /// + /// Percentage of memory currently in use by the heap. + /// /// [JsonInclude, JsonPropertyName("heap_used_percent")] public long? HeapUsedPercent { get; init; } /// - /// Amount of non-heap memory available, in bytes. + /// + /// Amount of non-heap memory available, in bytes. + /// /// [JsonInclude, JsonPropertyName("non_heap_committed_in_bytes")] public long? NonHeapCommittedInBytes { get; init; } /// - /// Non-heap memory used, in bytes. + /// + /// Non-heap memory used, in bytes. + /// /// [JsonInclude, JsonPropertyName("non_heap_used_in_bytes")] public long? NonHeapUsedInBytes { get; init; } /// - /// Contains statistics about heap memory usage for the node. + /// + /// Contains statistics about heap memory usage for the node. + /// /// [JsonInclude, JsonPropertyName("pools")] public IReadOnlyDictionary? Pools { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/JvmThreads.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/JvmThreads.g.cs index ff3fc323221..6fc0a88632f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/JvmThreads.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/JvmThreads.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class JvmThreads { /// - /// Number of active threads in use by JVM. + /// + /// Number of active threads in use by JVM. + /// /// [JsonInclude, JsonPropertyName("count")] public long? Count { get; init; } /// - /// Highest number of threads used by JVM. + /// + /// Highest number of threads used by JVM. + /// /// [JsonInclude, JsonPropertyName("peak_count")] public long? PeakCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/MemoryStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/MemoryStats.g.cs index 9b6c205af7f..6bc1ce8f4c5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/MemoryStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/MemoryStats.g.cs @@ -30,13 +30,18 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class MemoryStats { /// - /// If the amount of physical memory has been overridden using the `es`.`total_memory_bytes` system property then this reports the overridden value in bytes.
Otherwise it reports the same value as `total_in_bytes`. + /// + /// If the amount of physical memory has been overridden using the es.total_memory_bytes system property then this reports the overridden value in bytes. + /// Otherwise it reports the same value as total_in_bytes. + /// /// [JsonInclude, JsonPropertyName("adjusted_total_in_bytes")] public long? AdjustedTotalInBytes { get; init; } /// - /// Amount of free physical memory in bytes. + /// + /// Amount of free physical memory in bytes. + /// /// [JsonInclude, JsonPropertyName("free_in_bytes")] public long? FreeInBytes { get; init; } @@ -50,7 +55,9 @@ public sealed partial class MemoryStats public long? ShareInBytes { get; init; } /// - /// Total amount of physical memory in bytes. + /// + /// Total amount of physical memory in bytes. + /// /// [JsonInclude, JsonPropertyName("total_in_bytes")] public long? TotalInBytes { get; init; } @@ -60,7 +67,9 @@ public sealed partial class MemoryStats public long? TotalVirtualInBytes { get; init; } /// - /// Amount of used physical memory in bytes. + /// + /// Amount of used physical memory in bytes. + /// /// [JsonInclude, JsonPropertyName("used_in_bytes")] public long? UsedInBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/NodeBufferPool.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/NodeBufferPool.g.cs index ef9f23d75f4..8e389d0f344 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/NodeBufferPool.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/NodeBufferPool.g.cs @@ -30,31 +30,41 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class NodeBufferPool { /// - /// Number of buffer pools. + /// + /// Number of buffer pools. + /// /// [JsonInclude, JsonPropertyName("count")] public long? Count { get; init; } /// - /// Total capacity of buffer pools. + /// + /// Total capacity of buffer pools. + /// /// [JsonInclude, JsonPropertyName("total_capacity")] public string? TotalCapacity { get; init; } /// - /// Total capacity of buffer pools in bytes. + /// + /// Total capacity of buffer pools in bytes. + /// /// [JsonInclude, JsonPropertyName("total_capacity_in_bytes")] public long? TotalCapacityInBytes { get; init; } /// - /// Size of buffer pools. + /// + /// Size of buffer pools. + /// /// [JsonInclude, JsonPropertyName("used")] public string? Used { get; init; } /// - /// Size of buffer pools in bytes. + /// + /// Size of buffer pools in bytes. + /// /// [JsonInclude, JsonPropertyName("used_in_bytes")] public long? UsedInBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/NodeInfo.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/NodeInfo.g.cs index fb19295124f..95bc018a1a3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/NodeInfo.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/NodeInfo.g.cs @@ -37,7 +37,9 @@ public sealed partial class NodeInfo public string BuildFlavor { get; init; } /// - /// Short hash of the last git commit in this release. + /// + /// Short hash of the last git commit in this release. + /// /// [JsonInclude, JsonPropertyName("build_hash")] public string BuildHash { get; init; } @@ -45,7 +47,9 @@ public sealed partial class NodeInfo public string BuildType { get; init; } /// - /// The node’s host name. + /// + /// The node’s host name. + /// /// [JsonInclude, JsonPropertyName("host")] public string Host { get; init; } @@ -55,7 +59,9 @@ public sealed partial class NodeInfo public Elastic.Clients.Elasticsearch.Nodes.NodeInfoIngest? Ingest { get; init; } /// - /// The node’s IP address. + /// + /// The node’s IP address. + /// /// [JsonInclude, JsonPropertyName("ip")] public string Ip { get; init; } @@ -65,7 +71,9 @@ public sealed partial class NodeInfo public IReadOnlyCollection? Modules { get; init; } /// - /// The node's name + /// + /// The node's name + /// /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } @@ -85,13 +93,17 @@ public sealed partial class NodeInfo public IReadOnlyDictionary? ThreadPool { get; init; } /// - /// Total heap allowed to be used to hold recently indexed documents before they must be written to disk. This size is a shared pool across all shards on this node, and is controlled by Indexing Buffer settings. + /// + /// Total heap allowed to be used to hold recently indexed documents before they must be written to disk. This size is a shared pool across all shards on this node, and is controlled by Indexing Buffer settings. + /// /// [JsonInclude, JsonPropertyName("total_indexing_buffer")] public long? TotalIndexingBuffer { get; init; } /// - /// Same as total_indexing_buffer, but expressed in bytes. + /// + /// Same as total_indexing_buffer, but expressed in bytes. + /// /// [JsonInclude, JsonPropertyName("total_indexing_buffer_in_bytes")] public Elastic.Clients.Elasticsearch.ByteSize? TotalIndexingBufferInBytes { get; init; } @@ -99,13 +111,17 @@ public sealed partial class NodeInfo public Elastic.Clients.Elasticsearch.Nodes.NodeInfoTransport? Transport { get; init; } /// - /// Host and port where transport HTTP connections are accepted. + /// + /// Host and port where transport HTTP connections are accepted. + /// /// [JsonInclude, JsonPropertyName("transport_address")] public string TransportAddress { get; init; } /// - /// Elasticsearch version running on this node. + /// + /// Elasticsearch version running on this node. + /// /// [JsonInclude, JsonPropertyName("version")] public string Version { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/NodeInfoDiscover.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/NodeInfoDiscover.g.cs index 34de7e15206..82482a861f6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/NodeInfoDiscover.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/NodeInfoDiscover.g.cs @@ -82,7 +82,9 @@ public sealed partial class NodeInfoDiscover public IReadOnlyCollection? SeedProviders { get; init; } /// - /// Additional or alternative settings + /// + /// Additional or alternative settings + /// /// public IReadOnlyDictionary Settings { get; init; } public string? Type { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/NodeOperatingSystemInfo.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/NodeOperatingSystemInfo.g.cs index 59ad7f2154c..c620a9ad5c5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/NodeOperatingSystemInfo.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/NodeOperatingSystemInfo.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class NodeOperatingSystemInfo { /// - /// The number of processors actually used to calculate thread pool size. This number can be set with the node.processors setting of a node and defaults to the number of processors reported by the OS. + /// + /// The number of processors actually used to calculate thread pool size. This number can be set with the node.processors setting of a node and defaults to the number of processors reported by the OS. + /// /// [JsonInclude, JsonPropertyName("allocated_processors")] public int? AllocatedProcessors { get; init; } /// - /// Name of the JVM architecture (ex: amd64, x86) + /// + /// Name of the JVM architecture (ex: amd64, x86) + /// /// [JsonInclude, JsonPropertyName("arch")] public string Arch { get; init; } /// - /// Number of processors available to the Java virtual machine + /// + /// Number of processors available to the Java virtual machine + /// /// [JsonInclude, JsonPropertyName("available_processors")] public int AvailableProcessors { get; init; } @@ -52,7 +58,9 @@ public sealed partial class NodeOperatingSystemInfo public Elastic.Clients.Elasticsearch.Nodes.NodeInfoMemory? Mem { get; init; } /// - /// Name of the operating system (ex: Linux, Windows, Mac OS X) + /// + /// Name of the operating system (ex: Linux, Windows, Mac OS X) + /// /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } @@ -60,7 +68,9 @@ public sealed partial class NodeOperatingSystemInfo public string PrettyName { get; init; } /// - /// Refresh interval for the OS statistics + /// + /// Refresh interval for the OS statistics + /// /// [JsonInclude, JsonPropertyName("refresh_interval_in_millis")] public long RefreshIntervalInMillis { get; init; } @@ -68,7 +78,9 @@ public sealed partial class NodeOperatingSystemInfo public Elastic.Clients.Elasticsearch.Nodes.NodeInfoMemory? Swap { get; init; } /// - /// Version of the operating system + /// + /// Version of the operating system + /// /// [JsonInclude, JsonPropertyName("version")] public string Version { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/NodeProcessInfo.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/NodeProcessInfo.g.cs index 4a8ea6f643a..58ee8e44bed 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/NodeProcessInfo.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/NodeProcessInfo.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class NodeProcessInfo { /// - /// Process identifier (PID) + /// + /// Process identifier (PID) + /// /// [JsonInclude, JsonPropertyName("id")] public long Id { get; init; } /// - /// Indicates if the process address space has been successfully locked in memory + /// + /// Indicates if the process address space has been successfully locked in memory + /// /// [JsonInclude, JsonPropertyName("mlockall")] public bool Mlockall { get; init; } /// - /// Refresh interval for the process statistics + /// + /// Refresh interval for the process statistics + /// /// [JsonInclude, JsonPropertyName("refresh_interval_in_millis")] public long RefreshIntervalInMillis { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Pool.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Pool.g.cs index ad9cafc9119..44a46846cdf 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Pool.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Pool.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class Pool { /// - /// Maximum amount of memory, in bytes, available for use by the heap. + /// + /// Maximum amount of memory, in bytes, available for use by the heap. + /// /// [JsonInclude, JsonPropertyName("max_in_bytes")] public long? MaxInBytes { get; init; } /// - /// Largest amount of memory, in bytes, historically used by the heap. + /// + /// Largest amount of memory, in bytes, historically used by the heap. + /// /// [JsonInclude, JsonPropertyName("peak_max_in_bytes")] public long? PeakMaxInBytes { get; init; } /// - /// Largest amount of memory, in bytes, historically used by the heap. + /// + /// Largest amount of memory, in bytes, historically used by the heap. + /// /// [JsonInclude, JsonPropertyName("peak_used_in_bytes")] public long? PeakUsedInBytes { get; init; } /// - /// Memory, in bytes, used by the heap. + /// + /// Memory, in bytes, used by the heap. + /// /// [JsonInclude, JsonPropertyName("used_in_bytes")] public long? UsedInBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/PressureMemory.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/PressureMemory.g.cs index 7e631d4d913..fdc693758e6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/PressureMemory.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/PressureMemory.g.cs @@ -30,79 +30,107 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class PressureMemory { /// - /// Memory consumed by indexing requests in the coordinating, primary, or replica stage. + /// + /// Memory consumed by indexing requests in the coordinating, primary, or replica stage. + /// /// [JsonInclude, JsonPropertyName("all")] public Elastic.Clients.Elasticsearch.ByteSize? All { get; init; } /// - /// Memory consumed, in bytes, by indexing requests in the coordinating, primary, or replica stage. + /// + /// Memory consumed, in bytes, by indexing requests in the coordinating, primary, or replica stage. + /// /// [JsonInclude, JsonPropertyName("all_in_bytes")] public long? AllInBytes { get; init; } /// - /// Memory consumed by indexing requests in the coordinating or primary stage.
This value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally. + /// + /// Memory consumed by indexing requests in the coordinating or primary stage. + /// This value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally. + /// /// [JsonInclude, JsonPropertyName("combined_coordinating_and_primary")] public Elastic.Clients.Elasticsearch.ByteSize? CombinedCoordinatingAndPrimary { get; init; } /// - /// Memory consumed, in bytes, by indexing requests in the coordinating or primary stage.
This value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally. + /// + /// Memory consumed, in bytes, by indexing requests in the coordinating or primary stage. + /// This value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally. + /// /// [JsonInclude, JsonPropertyName("combined_coordinating_and_primary_in_bytes")] public long? CombinedCoordinatingAndPrimaryInBytes { get; init; } /// - /// Memory consumed by indexing requests in the coordinating stage. + /// + /// Memory consumed by indexing requests in the coordinating stage. + /// /// [JsonInclude, JsonPropertyName("coordinating")] public Elastic.Clients.Elasticsearch.ByteSize? Coordinating { get; init; } /// - /// Memory consumed, in bytes, by indexing requests in the coordinating stage. + /// + /// Memory consumed, in bytes, by indexing requests in the coordinating stage. + /// /// [JsonInclude, JsonPropertyName("coordinating_in_bytes")] public long? CoordinatingInBytes { get; init; } /// - /// Number of indexing requests rejected in the coordinating stage. + /// + /// Number of indexing requests rejected in the coordinating stage. + /// /// [JsonInclude, JsonPropertyName("coordinating_rejections")] public long? CoordinatingRejections { get; init; } /// - /// Memory consumed by indexing requests in the primary stage. + /// + /// Memory consumed by indexing requests in the primary stage. + /// /// [JsonInclude, JsonPropertyName("primary")] public Elastic.Clients.Elasticsearch.ByteSize? Primary { get; init; } /// - /// Memory consumed, in bytes, by indexing requests in the primary stage. + /// + /// Memory consumed, in bytes, by indexing requests in the primary stage. + /// /// [JsonInclude, JsonPropertyName("primary_in_bytes")] public long? PrimaryInBytes { get; init; } /// - /// Number of indexing requests rejected in the primary stage. + /// + /// Number of indexing requests rejected in the primary stage. + /// /// [JsonInclude, JsonPropertyName("primary_rejections")] public long? PrimaryRejections { get; init; } /// - /// Memory consumed by indexing requests in the replica stage. + /// + /// Memory consumed by indexing requests in the replica stage. + /// /// [JsonInclude, JsonPropertyName("replica")] public Elastic.Clients.Elasticsearch.ByteSize? Replica { get; init; } /// - /// Memory consumed, in bytes, by indexing requests in the replica stage. + /// + /// Memory consumed, in bytes, by indexing requests in the replica stage. + /// /// [JsonInclude, JsonPropertyName("replica_in_bytes")] public long? ReplicaInBytes { get; init; } /// - /// Number of indexing requests rejected in the replica stage. + /// + /// Number of indexing requests rejected in the replica stage. + /// /// [JsonInclude, JsonPropertyName("replica_rejections")] public long? ReplicaRejections { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Process.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Process.g.cs index 28ba1b4628b..b84d136121e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Process.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Process.g.cs @@ -30,31 +30,42 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class Process { /// - /// Contains CPU statistics for the node. + /// + /// Contains CPU statistics for the node. + /// /// [JsonInclude, JsonPropertyName("cpu")] public Elastic.Clients.Elasticsearch.Nodes.Cpu? Cpu { get; init; } /// - /// Maximum number of file descriptors allowed on the system, or `-1` if not supported. + /// + /// Maximum number of file descriptors allowed on the system, or -1 if not supported. + /// /// [JsonInclude, JsonPropertyName("max_file_descriptors")] public int? MaxFileDescriptors { get; init; } /// - /// Contains virtual memory statistics for the node. + /// + /// Contains virtual memory statistics for the node. + /// /// [JsonInclude, JsonPropertyName("mem")] public Elastic.Clients.Elasticsearch.Nodes.MemoryStats? Mem { get; init; } /// - /// Number of opened file descriptors associated with the current or `-1` if not supported. + /// + /// Number of opened file descriptors associated with the current or -1 if not supported. + /// /// [JsonInclude, JsonPropertyName("open_file_descriptors")] public int? OpenFileDescriptors { get; init; } /// - /// Last time the statistics were refreshed.
Recorded in milliseconds since the Unix Epoch. + /// + /// Last time the statistics were refreshed. + /// Recorded in milliseconds since the Unix Epoch. + /// /// [JsonInclude, JsonPropertyName("timestamp")] public long? Timestamp { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Processor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Processor.g.cs index 8ec057d8201..04f8de05d1a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Processor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Processor.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class Processor { /// - /// Number of documents transformed by the processor. + /// + /// Number of documents transformed by the processor. + /// /// [JsonInclude, JsonPropertyName("count")] public long? Count { get; init; } /// - /// Number of documents currently being transformed by the processor. + /// + /// Number of documents currently being transformed by the processor. + /// /// [JsonInclude, JsonPropertyName("current")] public long? Current { get; init; } /// - /// Number of failed operations for the processor. + /// + /// Number of failed operations for the processor. + /// /// [JsonInclude, JsonPropertyName("failed")] public long? Failed { get; init; } /// - /// Time, in milliseconds, spent by the processor transforming documents. + /// + /// Time, in milliseconds, spent by the processor transforming documents. + /// /// [JsonInclude, JsonPropertyName("time_in_millis")] public long? TimeInMillis { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/PublishedClusterStates.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/PublishedClusterStates.g.cs index c3bc6c4616f..dfa95da252d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/PublishedClusterStates.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/PublishedClusterStates.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class PublishedClusterStates { /// - /// Number of compatible differences between published cluster states. + /// + /// Number of compatible differences between published cluster states. + /// /// [JsonInclude, JsonPropertyName("compatible_diffs")] public long? CompatibleDiffs { get; init; } /// - /// Number of published cluster states. + /// + /// Number of published cluster states. + /// /// [JsonInclude, JsonPropertyName("full_states")] public long? FullStates { get; init; } /// - /// Number of incompatible differences between published cluster states. + /// + /// Number of incompatible differences between published cluster states. + /// /// [JsonInclude, JsonPropertyName("incompatible_diffs")] public long? IncompatibleDiffs { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/RepositoryLocation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/RepositoryLocation.g.cs index 7c0f76e6541..7869dcef892 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/RepositoryLocation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/RepositoryLocation.g.cs @@ -33,13 +33,17 @@ public sealed partial class RepositoryLocation public string BasePath { get; init; } /// - /// Bucket name (GCP, S3) + /// + /// Bucket name (GCP, S3) + /// /// [JsonInclude, JsonPropertyName("bucket")] public string? Bucket { get; init; } /// - /// Container name (Azure) + /// + /// Container name (Azure) + /// /// [JsonInclude, JsonPropertyName("container")] public string? Container { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/RepositoryMeteringInformation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/RepositoryMeteringInformation.g.cs index 76f30c825c3..2d07c149965 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/RepositoryMeteringInformation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/RepositoryMeteringInformation.g.cs @@ -30,55 +30,78 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class RepositoryMeteringInformation { /// - /// A flag that tells whether or not this object has been archived. When a repository is closed or updated the
repository metering information is archived and kept for a certain period of time. This allows retrieving the
repository metering information of previous repository instantiations. + /// + /// A flag that tells whether or not this object has been archived. When a repository is closed or updated the + /// repository metering information is archived and kept for a certain period of time. This allows retrieving the + /// repository metering information of previous repository instantiations. + /// /// [JsonInclude, JsonPropertyName("archived")] public bool Archived { get; init; } /// - /// The cluster state version when this object was archived, this field can be used as a logical timestamp to delete
all the archived metrics up to an observed version. This field is only present for archived repository metering
information objects. The main purpose of this field is to avoid possible race conditions during repository metering
information deletions, i.e. deleting archived repositories metering information that we haven’t observed yet. + /// + /// The cluster state version when this object was archived, this field can be used as a logical timestamp to delete + /// all the archived metrics up to an observed version. This field is only present for archived repository metering + /// information objects. The main purpose of this field is to avoid possible race conditions during repository metering + /// information deletions, i.e. deleting archived repositories metering information that we haven’t observed yet. + /// /// [JsonInclude, JsonPropertyName("cluster_version")] public long? ClusterVersion { get; init; } /// - /// An identifier that changes every time the repository is updated. + /// + /// An identifier that changes every time the repository is updated. + /// /// [JsonInclude, JsonPropertyName("repository_ephemeral_id")] public string RepositoryEphemeralId { get; init; } /// - /// Represents an unique location within the repository. + /// + /// Represents an unique location within the repository. + /// /// [JsonInclude, JsonPropertyName("repository_location")] public Elastic.Clients.Elasticsearch.Nodes.RepositoryLocation RepositoryLocation { get; init; } /// - /// Repository name. + /// + /// Repository name. + /// /// [JsonInclude, JsonPropertyName("repository_name")] public string RepositoryName { get; init; } /// - /// Time the repository was created or updated. Recorded in milliseconds since the Unix Epoch. + /// + /// Time the repository was created or updated. Recorded in milliseconds since the Unix Epoch. + /// /// [JsonInclude, JsonPropertyName("repository_started_at")] public long RepositoryStartedAt { get; init; } /// - /// Time the repository was deleted or updated. Recorded in milliseconds since the Unix Epoch. + /// + /// Time the repository was deleted or updated. Recorded in milliseconds since the Unix Epoch. + /// /// [JsonInclude, JsonPropertyName("repository_stopped_at")] public long? RepositoryStoppedAt { get; init; } /// - /// Repository type. + /// + /// Repository type. + /// /// [JsonInclude, JsonPropertyName("repository_type")] public string RepositoryType { get; init; } /// - /// An object with the number of request performed against the repository grouped by request type. + /// + /// An object with the number of request performed against the repository grouped by request type. + /// /// [JsonInclude, JsonPropertyName("request_counts")] public Elastic.Clients.Elasticsearch.Nodes.RequestCounts RequestCounts { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/RequestCounts.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/RequestCounts.g.cs index d7be465f1f3..0fde25b366b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/RequestCounts.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/RequestCounts.g.cs @@ -30,67 +30,91 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class RequestCounts { /// - /// Number of Get Blob requests (Azure) + /// + /// Number of Get Blob requests (Azure) + /// /// [JsonInclude, JsonPropertyName("GetBlob")] public long? Getblob { get; init; } /// - /// Number of Get Blob Properties requests (Azure) + /// + /// Number of Get Blob Properties requests (Azure) + /// /// [JsonInclude, JsonPropertyName("GetBlobProperties")] public long? Getblobproperties { get; init; } /// - /// Number of get object requests (GCP, S3) + /// + /// Number of get object requests (GCP, S3) + /// /// [JsonInclude, JsonPropertyName("GetObject")] public long? Getobject { get; init; } /// - /// Number of insert object requests, including simple, multipart and resumable uploads. Resumable uploads
can perform multiple http requests to insert a single object but they are considered as a single request
since they are billed as an individual operation. (GCP) + /// + /// Number of insert object requests, including simple, multipart and resumable uploads. Resumable uploads + /// can perform multiple http requests to insert a single object but they are considered as a single request + /// since they are billed as an individual operation. (GCP) + /// /// [JsonInclude, JsonPropertyName("InsertObject")] public long? Insertobject { get; init; } /// - /// Number of List Blobs requests (Azure) + /// + /// Number of List Blobs requests (Azure) + /// /// [JsonInclude, JsonPropertyName("ListBlobs")] public long? Listblobs { get; init; } /// - /// Number of list objects requests (GCP, S3) + /// + /// Number of list objects requests (GCP, S3) + /// /// [JsonInclude, JsonPropertyName("ListObjects")] public long? Listobjects { get; init; } /// - /// Number of Put Blob requests (Azure) + /// + /// Number of Put Blob requests (Azure) + /// /// [JsonInclude, JsonPropertyName("PutBlob")] public long? Putblob { get; init; } /// - /// Number of Put Block (Azure) + /// + /// Number of Put Block (Azure) + /// /// [JsonInclude, JsonPropertyName("PutBlock")] public long? Putblock { get; init; } /// - /// Number of Put Block List requests + /// + /// Number of Put Block List requests + /// /// [JsonInclude, JsonPropertyName("PutBlockList")] public long? Putblocklist { get; init; } /// - /// Number of Multipart requests, including CreateMultipartUpload, UploadPart and CompleteMultipartUpload requests (S3) + /// + /// Number of Multipart requests, including CreateMultipartUpload, UploadPart and CompleteMultipartUpload requests (S3) + /// /// [JsonInclude, JsonPropertyName("PutMultipartObject")] public long? Putmultipartobject { get; init; } /// - /// Number of PutObject requests (S3) + /// + /// Number of PutObject requests (S3) + /// /// [JsonInclude, JsonPropertyName("PutObject")] public long? Putobject { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/ScriptCache.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/ScriptCache.g.cs index 6cfec7766ca..7f5a4870972 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/ScriptCache.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/ScriptCache.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class ScriptCache { /// - /// Total number of times the script cache has evicted old data. + /// + /// Total number of times the script cache has evicted old data. + /// /// [JsonInclude, JsonPropertyName("cache_evictions")] public long? CacheEvictions { get; init; } /// - /// Total number of times the script compilation circuit breaker has limited inline script compilations. + /// + /// Total number of times the script compilation circuit breaker has limited inline script compilations. + /// /// [JsonInclude, JsonPropertyName("compilation_limit_triggered")] public long? CompilationLimitTriggered { get; init; } /// - /// Total number of inline script compilations performed by the node. + /// + /// Total number of inline script compilations performed by the node. + /// /// [JsonInclude, JsonPropertyName("compilations")] public long? Compilations { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Scripting.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Scripting.g.cs index 53d764b7307..d1228beda2a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Scripting.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Scripting.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class Scripting { /// - /// Total number of times the script cache has evicted old data. + /// + /// Total number of times the script cache has evicted old data. + /// /// [JsonInclude, JsonPropertyName("cache_evictions")] public long? CacheEvictions { get; init; } /// - /// Total number of times the script compilation circuit breaker has limited inline script compilations. + /// + /// Total number of times the script compilation circuit breaker has limited inline script compilations. + /// /// [JsonInclude, JsonPropertyName("compilation_limit_triggered")] public long? CompilationLimitTriggered { get; init; } /// - /// Total number of inline script compilations performed by the node. + /// + /// Total number of inline script compilations performed by the node. + /// /// [JsonInclude, JsonPropertyName("compilations")] public long? Compilations { get; init; } /// - /// Contains this recent history of script compilations. + /// + /// Contains this recent history of script compilations. + /// /// [JsonInclude, JsonPropertyName("compilations_history")] public IReadOnlyDictionary? CompilationsHistory { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/SerializedClusterState.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/SerializedClusterState.g.cs index 71cd3ae3181..b8f005db9e4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/SerializedClusterState.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/SerializedClusterState.g.cs @@ -33,7 +33,9 @@ public sealed partial class SerializedClusterState public Elastic.Clients.Elasticsearch.Nodes.SerializedClusterStateDetail? Diffs { get; init; } /// - /// Number of published cluster states. + /// + /// Number of published cluster states. + /// /// [JsonInclude, JsonPropertyName("full_states")] public Elastic.Clients.Elasticsearch.Nodes.SerializedClusterStateDetail? FullStates { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Stats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Stats.g.cs index 45bf89b1a33..069731edd49 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Stats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Stats.g.cs @@ -30,105 +30,140 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class Stats { /// - /// Statistics about adaptive replica selection. + /// + /// Statistics about adaptive replica selection. + /// /// [JsonInclude, JsonPropertyName("adaptive_selection")] public IReadOnlyDictionary? AdaptiveSelection { get; init; } /// - /// Contains a list of attributes for the node. + /// + /// Contains a list of attributes for the node. + /// /// [JsonInclude, JsonPropertyName("attributes")] [ReadOnlyFieldDictionaryConverter(typeof(string))] public IReadOnlyDictionary? Attributes { get; init; } /// - /// Statistics about the field data circuit breaker. + /// + /// Statistics about the field data circuit breaker. + /// /// [JsonInclude, JsonPropertyName("breakers")] public IReadOnlyDictionary? Breakers { get; init; } /// - /// Contains node discovery statistics for the node. + /// + /// Contains node discovery statistics for the node. + /// /// [JsonInclude, JsonPropertyName("discovery")] public Elastic.Clients.Elasticsearch.Nodes.Discovery? Discovery { get; init; } /// - /// File system information, data path, free disk space, read/write stats. + /// + /// File system information, data path, free disk space, read/write stats. + /// /// [JsonInclude, JsonPropertyName("fs")] public Elastic.Clients.Elasticsearch.Nodes.FileSystem? Fs { get; init; } /// - /// Network host for the node, based on the network host setting. + /// + /// Network host for the node, based on the network host setting. + /// /// [JsonInclude, JsonPropertyName("host")] public string? Host { get; init; } /// - /// HTTP connection information. + /// + /// HTTP connection information. + /// /// [JsonInclude, JsonPropertyName("http")] public Elastic.Clients.Elasticsearch.Nodes.Http? Http { get; init; } /// - /// Contains indexing pressure statistics for the node. + /// + /// Contains indexing pressure statistics for the node. + /// /// [JsonInclude, JsonPropertyName("indexing_pressure")] public Elastic.Clients.Elasticsearch.Nodes.IndexingPressure? IndexingPressure { get; init; } /// - /// Indices stats about size, document count, indexing and deletion times, search times, field cache size, merges and flushes. + /// + /// Indices stats about size, document count, indexing and deletion times, search times, field cache size, merges and flushes. + /// /// [JsonInclude, JsonPropertyName("indices")] public Elastic.Clients.Elasticsearch.IndexManagement.ShardStats? Indices { get; init; } /// - /// Statistics about ingest preprocessing. + /// + /// Statistics about ingest preprocessing. + /// /// [JsonInclude, JsonPropertyName("ingest")] public Elastic.Clients.Elasticsearch.Nodes.Ingest? Ingest { get; init; } /// - /// IP address and port for the node. + /// + /// IP address and port for the node. + /// /// [JsonInclude, JsonPropertyName("ip")] [SingleOrManyCollectionConverter(typeof(string))] public IReadOnlyCollection? Ip { get; init; } /// - /// JVM stats, memory pool information, garbage collection, buffer pools, number of loaded/unloaded classes. + /// + /// JVM stats, memory pool information, garbage collection, buffer pools, number of loaded/unloaded classes. + /// /// [JsonInclude, JsonPropertyName("jvm")] public Elastic.Clients.Elasticsearch.Nodes.Jvm? Jvm { get; init; } /// - /// Human-readable identifier for the node.
Based on the node name setting. + /// + /// Human-readable identifier for the node. + /// Based on the node name setting. + /// /// [JsonInclude, JsonPropertyName("name")] public string? Name { get; init; } /// - /// Operating system stats, load average, mem, swap. + /// + /// Operating system stats, load average, mem, swap. + /// /// [JsonInclude, JsonPropertyName("os")] public Elastic.Clients.Elasticsearch.Nodes.OperatingSystem? Os { get; init; } /// - /// Process statistics, memory consumption, cpu usage, open file descriptors. + /// + /// Process statistics, memory consumption, cpu usage, open file descriptors. + /// /// [JsonInclude, JsonPropertyName("process")] public Elastic.Clients.Elasticsearch.Nodes.Process? Process { get; init; } /// - /// Roles assigned to the node. + /// + /// Roles assigned to the node. + /// /// [JsonInclude, JsonPropertyName("roles")] public IReadOnlyCollection? Roles { get; init; } /// - /// Contains script statistics for the node. + /// + /// Contains script statistics for the node. + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Nodes.Scripting? Script { get; init; } @@ -136,7 +171,9 @@ public sealed partial class Stats public IReadOnlyDictionary>>? ScriptCache { get; init; } /// - /// Statistics about each thread pool, including current size, queue and rejected tasks. + /// + /// Statistics about each thread pool, including current size, queue and rejected tasks. + /// /// [JsonInclude, JsonPropertyName("thread_pool")] public IReadOnlyDictionary? ThreadPool { get; init; } @@ -144,13 +181,17 @@ public sealed partial class Stats public long? Timestamp { get; init; } /// - /// Transport statistics about sent and received bytes in cluster communication. + /// + /// Transport statistics about sent and received bytes in cluster communication. + /// /// [JsonInclude, JsonPropertyName("transport")] public Elastic.Clients.Elasticsearch.Nodes.Transport? Transport { get; init; } /// - /// Host and port for the transport layer, used for internal communication between nodes in a cluster. + /// + /// Host and port for the transport layer, used for internal communication between nodes in a cluster. + /// /// [JsonInclude, JsonPropertyName("transport_address")] public string? TransportAddress { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/ThreadCount.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/ThreadCount.g.cs index 503b3357906..5f29e71f522 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/ThreadCount.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/ThreadCount.g.cs @@ -30,37 +30,49 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class ThreadCount { /// - /// Number of active threads in the thread pool. + /// + /// Number of active threads in the thread pool. + /// /// [JsonInclude, JsonPropertyName("active")] public long? Active { get; init; } /// - /// Number of tasks completed by the thread pool executor. + /// + /// Number of tasks completed by the thread pool executor. + /// /// [JsonInclude, JsonPropertyName("completed")] public long? Completed { get; init; } /// - /// Highest number of active threads in the thread pool. + /// + /// Highest number of active threads in the thread pool. + /// /// [JsonInclude, JsonPropertyName("largest")] public long? Largest { get; init; } /// - /// Number of tasks in queue for the thread pool. + /// + /// Number of tasks in queue for the thread pool. + /// /// [JsonInclude, JsonPropertyName("queue")] public long? Queue { get; init; } /// - /// Number of tasks rejected by the thread pool executor. + /// + /// Number of tasks rejected by the thread pool executor. + /// /// [JsonInclude, JsonPropertyName("rejected")] public long? Rejected { get; init; } /// - /// Number of threads in the thread pool. + /// + /// Number of threads in the thread pool. + /// /// [JsonInclude, JsonPropertyName("threads")] public long? Threads { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Transport.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Transport.g.cs index a40e860a816..a21a0c3b5e6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Transport.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/Transport.g.cs @@ -30,61 +30,83 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class Transport { /// - /// The distribution of the time spent handling each inbound message on a transport thread, represented as a histogram. + /// + /// The distribution of the time spent handling each inbound message on a transport thread, represented as a histogram. + /// /// [JsonInclude, JsonPropertyName("inbound_handling_time_histogram")] public IReadOnlyCollection? InboundHandlingTimeHistogram { get; init; } /// - /// The distribution of the time spent sending each outbound transport message on a transport thread, represented as a histogram. + /// + /// The distribution of the time spent sending each outbound transport message on a transport thread, represented as a histogram. + /// /// [JsonInclude, JsonPropertyName("outbound_handling_time_histogram")] public IReadOnlyCollection? OutboundHandlingTimeHistogram { get; init; } /// - /// Total number of RX (receive) packets received by the node during internal cluster communication. + /// + /// Total number of RX (receive) packets received by the node during internal cluster communication. + /// /// [JsonInclude, JsonPropertyName("rx_count")] public long? RxCount { get; init; } /// - /// Size of RX packets received by the node during internal cluster communication. + /// + /// Size of RX packets received by the node during internal cluster communication. + /// /// [JsonInclude, JsonPropertyName("rx_size")] public string? RxSize { get; init; } /// - /// Size, in bytes, of RX packets received by the node during internal cluster communication. + /// + /// Size, in bytes, of RX packets received by the node during internal cluster communication. + /// /// [JsonInclude, JsonPropertyName("rx_size_in_bytes")] public long? RxSizeInBytes { get; init; } /// - /// Current number of inbound TCP connections used for internal communication between nodes. + /// + /// Current number of inbound TCP connections used for internal communication between nodes. + /// /// [JsonInclude, JsonPropertyName("server_open")] public int? ServerOpen { get; init; } /// - /// The cumulative number of outbound transport connections that this node has opened since it started.
Each transport connection may comprise multiple TCP connections but is only counted once in this statistic.
Transport connections are typically long-lived so this statistic should remain constant in a stable cluster. + /// + /// The cumulative number of outbound transport connections that this node has opened since it started. + /// Each transport connection may comprise multiple TCP connections but is only counted once in this statistic. + /// Transport connections are typically long-lived so this statistic should remain constant in a stable cluster. + /// /// [JsonInclude, JsonPropertyName("total_outbound_connections")] public long? TotalOutboundConnections { get; init; } /// - /// Total number of TX (transmit) packets sent by the node during internal cluster communication. + /// + /// Total number of TX (transmit) packets sent by the node during internal cluster communication. + /// /// [JsonInclude, JsonPropertyName("tx_count")] public long? TxCount { get; init; } /// - /// Size of TX packets sent by the node during internal cluster communication. + /// + /// Size of TX packets sent by the node during internal cluster communication. + /// /// [JsonInclude, JsonPropertyName("tx_size")] public string? TxSize { get; init; } /// - /// Size, in bytes, of TX packets sent by the node during internal cluster communication. + /// + /// Size, in bytes, of TX packets sent by the node during internal cluster communication. + /// /// [JsonInclude, JsonPropertyName("tx_size_in_bytes")] public long? TxSizeInBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/TransportHistogram.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/TransportHistogram.g.cs index 7b03c900508..281b2412ac0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/TransportHistogram.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/TransportHistogram.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class TransportHistogram { /// - /// The number of times a transport thread took a period of time within the bounds of this bucket to handle an inbound message. + /// + /// The number of times a transport thread took a period of time within the bounds of this bucket to handle an inbound message. + /// /// [JsonInclude, JsonPropertyName("count")] public long? Count { get; init; } /// - /// The inclusive lower bound of the bucket in milliseconds. May be omitted on the first bucket if this bucket has no lower bound. + /// + /// The inclusive lower bound of the bucket in milliseconds. May be omitted on the first bucket if this bucket has no lower bound. + /// /// [JsonInclude, JsonPropertyName("ge_millis")] public long? GeMillis { get; init; } /// - /// The exclusive upper bound of the bucket in milliseconds.
May be omitted on the last bucket if this bucket has no upper bound. + /// + /// The exclusive upper bound of the bucket in milliseconds. + /// May be omitted on the last bucket if this bucket has no upper bound. + /// /// [JsonInclude, JsonPropertyName("lt_millis")] public long? LtMillis { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryCacheStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryCacheStats.g.cs index 11fb80f3e46..f4f41c034f5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryCacheStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryCacheStats.g.cs @@ -30,49 +30,66 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class QueryCacheStats { /// - /// Total number of entries added to the query cache across all shards assigned to selected nodes.
This number includes current and evicted entries. + /// + /// Total number of entries added to the query cache across all shards assigned to selected nodes. + /// This number includes current and evicted entries. + /// /// [JsonInclude, JsonPropertyName("cache_count")] public long CacheCount { get; init; } /// - /// Total number of entries currently in the query cache across all shards assigned to selected nodes. + /// + /// Total number of entries currently in the query cache across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("cache_size")] public long CacheSize { get; init; } /// - /// Total number of query cache evictions across all shards assigned to selected nodes. + /// + /// Total number of query cache evictions across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("evictions")] public long Evictions { get; init; } /// - /// Total count of query cache hits across all shards assigned to selected nodes. + /// + /// Total count of query cache hits across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("hit_count")] public long HitCount { get; init; } /// - /// Total amount of memory used for the query cache across all shards assigned to selected nodes. + /// + /// Total amount of memory used for the query cache across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("memory_size")] public Elastic.Clients.Elasticsearch.ByteSize? MemorySize { get; init; } /// - /// Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes. + /// + /// Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("memory_size_in_bytes")] public long MemorySizeInBytes { get; init; } /// - /// Total count of query cache misses across all shards assigned to selected nodes. + /// + /// Total count of query cache misses across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("miss_count")] public long MissCount { get; init; } /// - /// Total count of hits and misses in the query cache across all shards assigned to selected nodes. + /// + /// Total count of hits and misses in the query cache across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("total_count")] public long TotalCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/BoolQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/BoolQuery.g.cs index 93620586055..5993edf9a97 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/BoolQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/BoolQuery.g.cs @@ -30,33 +30,48 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class BoolQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// The clause (query) must appear in matching documents.
However, unlike `must`, the score of the query will be ignored. + /// + /// The clause (query) must appear in matching documents. + /// However, unlike must, the score of the query will be ignored. + /// /// [JsonInclude, JsonPropertyName("filter")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.QueryDsl.Query))] public ICollection? Filter { get; set; } /// - /// Specifies the number or percentage of `should` clauses returned documents must match. + /// + /// Specifies the number or percentage of should clauses returned documents must match. + /// /// [JsonInclude, JsonPropertyName("minimum_should_match")] public Elastic.Clients.Elasticsearch.MinimumShouldMatch? MinimumShouldMatch { get; set; } /// - /// The clause (query) must appear in matching documents and will contribute to the score. + /// + /// The clause (query) must appear in matching documents and will contribute to the score. + /// /// [JsonInclude, JsonPropertyName("must")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.QueryDsl.Query))] public ICollection? Must { get; set; } /// - /// The clause (query) must not appear in the matching documents.
Because scoring is ignored, a score of `0` is returned for all documents. + /// + /// The clause (query) must not appear in the matching documents. + /// Because scoring is ignored, a score of 0 is returned for all documents. + /// /// [JsonInclude, JsonPropertyName("must_not")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.QueryDsl.Query))] @@ -65,7 +80,9 @@ public sealed partial class BoolQuery public string? QueryName { get; set; } /// - /// The clause (query) should appear in the matching document. + /// + /// The clause (query) should appear in the matching document. + /// /// [JsonInclude, JsonPropertyName("should")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.QueryDsl.Query))] @@ -103,7 +120,12 @@ public BoolQueryDescriptor() : base() private Action>[] ShouldDescriptorActions { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public BoolQueryDescriptor Boost(float? boost) { @@ -112,7 +134,10 @@ public BoolQueryDescriptor Boost(float? boost) } /// - /// The clause (query) must appear in matching documents.
However, unlike `must`, the score of the query will be ignored. + /// + /// The clause (query) must appear in matching documents. + /// However, unlike must, the score of the query will be ignored. + /// /// public BoolQueryDescriptor Filter(ICollection? filter) { @@ -151,7 +176,9 @@ public BoolQueryDescriptor Filter(params Action - /// Specifies the number or percentage of `should` clauses returned documents must match. + /// + /// Specifies the number or percentage of should clauses returned documents must match. + /// /// public BoolQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { @@ -160,7 +187,9 @@ public BoolQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elastic } /// - /// The clause (query) must appear in matching documents and will contribute to the score. + /// + /// The clause (query) must appear in matching documents and will contribute to the score. + /// /// public BoolQueryDescriptor Must(ICollection? must) { @@ -199,7 +228,10 @@ public BoolQueryDescriptor Must(params Action - /// The clause (query) must not appear in the matching documents.
Because scoring is ignored, a score of `0` is returned for all documents. + /// + /// The clause (query) must not appear in the matching documents. + /// Because scoring is ignored, a score of 0 is returned for all documents. + /// /// public BoolQueryDescriptor MustNot(ICollection? mustNot) { @@ -244,7 +276,9 @@ public BoolQueryDescriptor QueryName(string? queryName) } /// - /// The clause (query) should appear in the matching document. + /// + /// The clause (query) should appear in the matching document. + /// /// public BoolQueryDescriptor Should(ICollection? should) { @@ -452,7 +486,12 @@ public BoolQueryDescriptor() : base() private Action[] ShouldDescriptorActions { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public BoolQueryDescriptor Boost(float? boost) { @@ -461,7 +500,10 @@ public BoolQueryDescriptor Boost(float? boost) } /// - /// The clause (query) must appear in matching documents.
However, unlike `must`, the score of the query will be ignored. + /// + /// The clause (query) must appear in matching documents. + /// However, unlike must, the score of the query will be ignored. + /// /// public BoolQueryDescriptor Filter(ICollection? filter) { @@ -500,7 +542,9 @@ public BoolQueryDescriptor Filter(params Action - /// Specifies the number or percentage of `should` clauses returned documents must match. + /// + /// Specifies the number or percentage of should clauses returned documents must match. + /// /// public BoolQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { @@ -509,7 +553,9 @@ public BoolQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.Mini } /// - /// The clause (query) must appear in matching documents and will contribute to the score. + /// + /// The clause (query) must appear in matching documents and will contribute to the score. + /// /// public BoolQueryDescriptor Must(ICollection? must) { @@ -548,7 +594,10 @@ public BoolQueryDescriptor Must(params Action - /// The clause (query) must not appear in the matching documents.
Because scoring is ignored, a score of `0` is returned for all documents. + /// + /// The clause (query) must not appear in the matching documents. + /// Because scoring is ignored, a score of 0 is returned for all documents. + /// /// public BoolQueryDescriptor MustNot(ICollection? mustNot) { @@ -593,7 +642,9 @@ public BoolQueryDescriptor QueryName(string? queryName) } /// - /// The clause (query) should appear in the matching document. + /// + /// The clause (query) should appear in the matching document. + /// /// public BoolQueryDescriptor Should(ICollection? should) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/BoostingQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/BoostingQuery.g.cs index a0c4bc869d9..a88e559cafb 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/BoostingQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/BoostingQuery.g.cs @@ -30,25 +30,36 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class BoostingQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Query used to decrease the relevance score of matching documents. + /// + /// Query used to decrease the relevance score of matching documents. + /// /// [JsonInclude, JsonPropertyName("negative")] public Elastic.Clients.Elasticsearch.QueryDsl.Query Negative { get; set; } /// - /// Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the `negative` query. + /// + /// Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the negative query. + /// /// [JsonInclude, JsonPropertyName("negative_boost")] public double NegativeBoost { get; set; } /// - /// Any returned documents must match this query. + /// + /// Any returned documents must match this query. + /// /// [JsonInclude, JsonPropertyName("positive")] public Elastic.Clients.Elasticsearch.QueryDsl.Query Positive { get; set; } @@ -77,7 +88,12 @@ public BoostingQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public BoostingQueryDescriptor Boost(float? boost) { @@ -86,7 +102,9 @@ public BoostingQueryDescriptor Boost(float? boost) } /// - /// Query used to decrease the relevance score of matching documents. + /// + /// Query used to decrease the relevance score of matching documents. + /// /// public BoostingQueryDescriptor Negative(Elastic.Clients.Elasticsearch.QueryDsl.Query negative) { @@ -113,7 +131,9 @@ public BoostingQueryDescriptor Negative(Action - /// Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the `negative` query. + /// + /// Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the negative query. + /// /// public BoostingQueryDescriptor NegativeBoost(double negativeBoost) { @@ -122,7 +142,9 @@ public BoostingQueryDescriptor NegativeBoost(double negativeBoost) } /// - /// Any returned documents must match this query. + /// + /// Any returned documents must match this query. + /// /// public BoostingQueryDescriptor Positive(Elastic.Clients.Elasticsearch.QueryDsl.Query positive) { @@ -226,7 +248,12 @@ public BoostingQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public BoostingQueryDescriptor Boost(float? boost) { @@ -235,7 +262,9 @@ public BoostingQueryDescriptor Boost(float? boost) } /// - /// Query used to decrease the relevance score of matching documents. + /// + /// Query used to decrease the relevance score of matching documents. + /// /// public BoostingQueryDescriptor Negative(Elastic.Clients.Elasticsearch.QueryDsl.Query negative) { @@ -262,7 +291,9 @@ public BoostingQueryDescriptor Negative(Action - /// Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the `negative` query. + /// + /// Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the negative query. + /// /// public BoostingQueryDescriptor NegativeBoost(double negativeBoost) { @@ -271,7 +302,9 @@ public BoostingQueryDescriptor NegativeBoost(double negativeBoost) } /// - /// Any returned documents must match this query. + /// + /// Any returned documents must match this query. + /// /// public BoostingQueryDescriptor Positive(Elastic.Clients.Elasticsearch.QueryDsl.Query positive) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/CombinedFieldsQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/CombinedFieldsQuery.g.cs index 600e97989e3..387ff96f3a0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/CombinedFieldsQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/CombinedFieldsQuery.g.cs @@ -30,38 +30,54 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class CombinedFieldsQuery { /// - /// If true, match phrase queries are automatically created for multi-term synonyms. + /// + /// If true, match phrase queries are automatically created for multi-term synonyms. + /// /// [JsonInclude, JsonPropertyName("auto_generate_synonyms_phrase_query")] public bool? AutoGenerateSynonymsPhraseQuery { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// List of fields to search. Field wildcard patterns are allowed. Only `text` fields are supported, and they must all have the same search `analyzer`. + /// + /// List of fields to search. Field wildcard patterns are allowed. Only text fields are supported, and they must all have the same search analyzer. + /// /// [JsonInclude, JsonPropertyName("fields")] [JsonConverter(typeof(FieldsConverter))] public Elastic.Clients.Elasticsearch.Fields Fields { get; set; } /// - /// Minimum number of clauses that must match for a document to be returned. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// /// [JsonInclude, JsonPropertyName("minimum_should_match")] public Elastic.Clients.Elasticsearch.MinimumShouldMatch? MinimumShouldMatch { get; set; } /// - /// Boolean logic used to interpret text in the query value. + /// + /// Boolean logic used to interpret text in the query value. + /// /// [JsonInclude, JsonPropertyName("operator")] public Elastic.Clients.Elasticsearch.QueryDsl.CombinedFieldsOperator? Operator { get; set; } /// - /// Text to search for in the provided `fields`.
The `combined_fields` query analyzes the provided text before performing a search. + /// + /// Text to search for in the provided fields. + /// The combined_fields query analyzes the provided text before performing a search. + /// /// [JsonInclude, JsonPropertyName("query")] public string Query { get; set; } @@ -69,7 +85,9 @@ public sealed partial class CombinedFieldsQuery public string? QueryName { get; set; } /// - /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter. + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter. + /// /// [JsonInclude, JsonPropertyName("zero_terms_query")] public Elastic.Clients.Elasticsearch.QueryDsl.CombinedFieldsZeroTerms? ZeroTermsQuery { get; set; } @@ -95,7 +113,9 @@ public CombinedFieldsQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.QueryDsl.CombinedFieldsZeroTerms? ZeroTermsQueryValue { get; set; } /// - /// If true, match phrase queries are automatically created for multi-term synonyms. + /// + /// If true, match phrase queries are automatically created for multi-term synonyms. + /// /// public CombinedFieldsQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSynonymsPhraseQuery = true) { @@ -104,7 +124,12 @@ public CombinedFieldsQueryDescriptor AutoGenerateSynonymsPhraseQuery( } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public CombinedFieldsQueryDescriptor Boost(float? boost) { @@ -113,7 +138,9 @@ public CombinedFieldsQueryDescriptor Boost(float? boost) } /// - /// List of fields to search. Field wildcard patterns are allowed. Only `text` fields are supported, and they must all have the same search `analyzer`. + /// + /// List of fields to search. Field wildcard patterns are allowed. Only text fields are supported, and they must all have the same search analyzer. + /// /// public CombinedFieldsQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Fields fields) { @@ -122,7 +149,9 @@ public CombinedFieldsQueryDescriptor Fields(Elastic.Clients.Elasticse } /// - /// Minimum number of clauses that must match for a document to be returned. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// /// public CombinedFieldsQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { @@ -131,7 +160,9 @@ public CombinedFieldsQueryDescriptor MinimumShouldMatch(Elastic.Clien } /// - /// Boolean logic used to interpret text in the query value. + /// + /// Boolean logic used to interpret text in the query value. + /// /// public CombinedFieldsQueryDescriptor Operator(Elastic.Clients.Elasticsearch.QueryDsl.CombinedFieldsOperator? value) { @@ -140,7 +171,10 @@ public CombinedFieldsQueryDescriptor Operator(Elastic.Clients.Elastic } /// - /// Text to search for in the provided `fields`.
The `combined_fields` query analyzes the provided text before performing a search. + /// + /// Text to search for in the provided fields. + /// The combined_fields query analyzes the provided text before performing a search. + /// /// public CombinedFieldsQueryDescriptor Query(string query) { @@ -155,7 +189,9 @@ public CombinedFieldsQueryDescriptor QueryName(string? queryName) } /// - /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter. + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter. + /// /// public CombinedFieldsQueryDescriptor ZeroTermsQuery(Elastic.Clients.Elasticsearch.QueryDsl.CombinedFieldsZeroTerms? zeroTermsQuery) { @@ -228,7 +264,9 @@ public CombinedFieldsQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.QueryDsl.CombinedFieldsZeroTerms? ZeroTermsQueryValue { get; set; } /// - /// If true, match phrase queries are automatically created for multi-term synonyms. + /// + /// If true, match phrase queries are automatically created for multi-term synonyms. + /// /// public CombinedFieldsQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSynonymsPhraseQuery = true) { @@ -237,7 +275,12 @@ public CombinedFieldsQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoG } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public CombinedFieldsQueryDescriptor Boost(float? boost) { @@ -246,7 +289,9 @@ public CombinedFieldsQueryDescriptor Boost(float? boost) } /// - /// List of fields to search. Field wildcard patterns are allowed. Only `text` fields are supported, and they must all have the same search `analyzer`. + /// + /// List of fields to search. Field wildcard patterns are allowed. Only text fields are supported, and they must all have the same search analyzer. + /// /// public CombinedFieldsQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Fields fields) { @@ -255,7 +300,9 @@ public CombinedFieldsQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Fields } /// - /// Minimum number of clauses that must match for a document to be returned. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// /// public CombinedFieldsQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { @@ -264,7 +311,9 @@ public CombinedFieldsQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elastics } /// - /// Boolean logic used to interpret text in the query value. + /// + /// Boolean logic used to interpret text in the query value. + /// /// public CombinedFieldsQueryDescriptor Operator(Elastic.Clients.Elasticsearch.QueryDsl.CombinedFieldsOperator? value) { @@ -273,7 +322,10 @@ public CombinedFieldsQueryDescriptor Operator(Elastic.Clients.Elasticsearch.Quer } /// - /// Text to search for in the provided `fields`.
The `combined_fields` query analyzes the provided text before performing a search. + /// + /// Text to search for in the provided fields. + /// The combined_fields query analyzes the provided text before performing a search. + /// /// public CombinedFieldsQueryDescriptor Query(string query) { @@ -288,7 +340,9 @@ public CombinedFieldsQueryDescriptor QueryName(string? queryName) } /// - /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter. + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter. + /// /// public CombinedFieldsQueryDescriptor ZeroTermsQuery(Elastic.Clients.Elasticsearch.QueryDsl.CombinedFieldsZeroTerms? zeroTermsQuery) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ConstantScoreQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ConstantScoreQuery.g.cs index bfe6de3a8f3..2c41c2aefd3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ConstantScoreQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ConstantScoreQuery.g.cs @@ -30,13 +30,22 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class ConstantScoreQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Filter query you wish to run. Any returned documents must match this query.
Filter queries do not calculate relevance scores.
To speed up performance, Elasticsearch automatically caches frequently used filter queries. + /// + /// Filter query you wish to run. Any returned documents must match this query. + /// Filter queries do not calculate relevance scores. + /// To speed up performance, Elasticsearch automatically caches frequently used filter queries. + /// /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.QueryDsl.Query Filter { get; set; } @@ -61,7 +70,12 @@ public ConstantScoreQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public ConstantScoreQueryDescriptor Boost(float? boost) { @@ -70,7 +84,11 @@ public ConstantScoreQueryDescriptor Boost(float? boost) } /// - /// Filter query you wish to run. Any returned documents must match this query.
Filter queries do not calculate relevance scores.
To speed up performance, Elasticsearch automatically caches frequently used filter queries. + /// + /// Filter query you wish to run. Any returned documents must match this query. + /// Filter queries do not calculate relevance scores. + /// To speed up performance, Elasticsearch automatically caches frequently used filter queries. + /// /// public ConstantScoreQueryDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.Query filter) { @@ -152,7 +170,12 @@ public ConstantScoreQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public ConstantScoreQueryDescriptor Boost(float? boost) { @@ -161,7 +184,11 @@ public ConstantScoreQueryDescriptor Boost(float? boost) } /// - /// Filter query you wish to run. Any returned documents must match this query.
Filter queries do not calculate relevance scores.
To speed up performance, Elasticsearch automatically caches frequently used filter queries. + /// + /// Filter query you wish to run. Any returned documents must match this query. + /// Filter queries do not calculate relevance scores. + /// To speed up performance, Elasticsearch automatically caches frequently used filter queries. + /// /// public ConstantScoreQueryDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.Query filter) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DateDecayFunction.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DateDecayFunction.g.cs index 243f63141e1..2694b98502b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DateDecayFunction.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DateDecayFunction.g.cs @@ -85,7 +85,9 @@ public sealed partial class DateDecayFunction public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// + /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// /// public Elastic.Clients.Elasticsearch.QueryDsl.MultiValueMode? MultiValueMode { get; set; } public Elastic.Clients.Elasticsearch.QueryDsl.DecayPlacement Placement { get; set; } @@ -122,7 +124,9 @@ public DateDecayFunctionDescriptor Field(Expression - /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// + /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// /// public DateDecayFunctionDescriptor MultiValueMode(Elastic.Clients.Elasticsearch.QueryDsl.MultiValueMode? multiValueMode) { @@ -187,7 +191,9 @@ public DateDecayFunctionDescriptor Field(Expression - /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// + /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// /// public DateDecayFunctionDescriptor MultiValueMode(Elastic.Clients.Elasticsearch.QueryDsl.MultiValueMode? multiValueMode) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DateDistanceFeatureQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DateDistanceFeatureQuery.g.cs index 7cc3037b694..bfa49e3ec4b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DateDistanceFeatureQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DateDistanceFeatureQuery.g.cs @@ -30,25 +30,43 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class DateDistanceFeatureQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Date or point of origin used to calculate distances.
If the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.
Date Math, such as `now-1h`, is supported.
If the field value is a `geo_point` field, the `origin` value must be a geopoint. + /// + /// Date or point of origin used to calculate distances. + /// If the field value is a date or date_nanos field, the origin value must be a date. + /// Date Math, such as now-1h, is supported. + /// If the field value is a geo_point field, the origin value must be a geopoint. + /// /// [JsonInclude, JsonPropertyName("origin")] public Elastic.Clients.Elasticsearch.DateMath Origin { get; set; } /// - /// Distance from the `origin` at which relevance scores receive half of the `boost` value.
If the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`. + /// + /// Distance from the origin at which relevance scores receive half of the boost value. + /// If the field value is a date or date_nanos field, the pivot value must be a time unit, such as 1h or 10d. If the field value is a geo_point field, the pivot value must be a distance unit, such as 1km or 12m. + /// /// [JsonInclude, JsonPropertyName("pivot")] public Elastic.Clients.Elasticsearch.Duration Pivot { get; set; } @@ -71,7 +89,12 @@ public DateDistanceFeatureQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public DateDistanceFeatureQueryDescriptor Boost(float? boost) { @@ -80,7 +103,12 @@ public DateDistanceFeatureQueryDescriptor Boost(float? boost) } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public DateDistanceFeatureQueryDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -89,7 +117,12 @@ public DateDistanceFeatureQueryDescriptor Field(Elastic.Clients.Elast } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public DateDistanceFeatureQueryDescriptor Field(Expression> field) { @@ -98,7 +131,12 @@ public DateDistanceFeatureQueryDescriptor Field(Expression - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public DateDistanceFeatureQueryDescriptor Field(Expression> field) { @@ -107,7 +145,12 @@ public DateDistanceFeatureQueryDescriptor Field(Expression - /// Date or point of origin used to calculate distances.
If the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.
Date Math, such as `now-1h`, is supported.
If the field value is a `geo_point` field, the `origin` value must be a geopoint. + /// + /// Date or point of origin used to calculate distances. + /// If the field value is a date or date_nanos field, the origin value must be a date. + /// Date Math, such as now-1h, is supported. + /// If the field value is a geo_point field, the origin value must be a geopoint. + /// /// public DateDistanceFeatureQueryDescriptor Origin(Elastic.Clients.Elasticsearch.DateMath origin) { @@ -116,7 +159,10 @@ public DateDistanceFeatureQueryDescriptor Origin(Elastic.Clients.Elas } /// - /// Distance from the `origin` at which relevance scores receive half of the `boost` value.
If the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`. + /// + /// Distance from the origin at which relevance scores receive half of the boost value. + /// If the field value is a date or date_nanos field, the pivot value must be a time unit, such as 1h or 10d. If the field value is a geo_point field, the pivot value must be a distance unit, such as 1km or 12m. + /// /// public DateDistanceFeatureQueryDescriptor Pivot(Elastic.Clients.Elasticsearch.Duration pivot) { @@ -170,7 +216,12 @@ public DateDistanceFeatureQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public DateDistanceFeatureQueryDescriptor Boost(float? boost) { @@ -179,7 +230,12 @@ public DateDistanceFeatureQueryDescriptor Boost(float? boost) } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public DateDistanceFeatureQueryDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -188,7 +244,12 @@ public DateDistanceFeatureQueryDescriptor Field(Elastic.Clients.Elasticsearch.Fi } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public DateDistanceFeatureQueryDescriptor Field(Expression> field) { @@ -197,7 +258,12 @@ public DateDistanceFeatureQueryDescriptor Field(Expression - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public DateDistanceFeatureQueryDescriptor Field(Expression> field) { @@ -206,7 +272,12 @@ public DateDistanceFeatureQueryDescriptor Field(Expression - /// Date or point of origin used to calculate distances.
If the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.
Date Math, such as `now-1h`, is supported.
If the field value is a `geo_point` field, the `origin` value must be a geopoint. + /// + /// Date or point of origin used to calculate distances. + /// If the field value is a date or date_nanos field, the origin value must be a date. + /// Date Math, such as now-1h, is supported. + /// If the field value is a geo_point field, the origin value must be a geopoint. + /// /// public DateDistanceFeatureQueryDescriptor Origin(Elastic.Clients.Elasticsearch.DateMath origin) { @@ -215,7 +286,10 @@ public DateDistanceFeatureQueryDescriptor Origin(Elastic.Clients.Elasticsearch.D } /// - /// Distance from the `origin` at which relevance scores receive half of the `boost` value.
If the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`. + /// + /// Distance from the origin at which relevance scores receive half of the boost value. + /// If the field value is a date or date_nanos field, the pivot value must be a time unit, such as 1h or 10d. If the field value is a geo_point field, the pivot value must be a distance unit, such as 1km or 12m. + /// /// public DateDistanceFeatureQueryDescriptor Pivot(Elastic.Clients.Elasticsearch.Duration pivot) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DateRangeQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DateRangeQuery.g.cs index ac9aa353d68..a5616c21d2d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DateRangeQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DateRangeQuery.g.cs @@ -205,45 +205,64 @@ public DateRangeQuery(Elastic.Clients.Elasticsearch.Field field) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Date format used to convert `date` values in the query. + /// + /// Date format used to convert date values in the query. + /// /// public string? Format { get; set; } public Elastic.Clients.Elasticsearch.DateMath? From { get; set; } /// - /// Greater than. + /// + /// Greater than. + /// /// public Elastic.Clients.Elasticsearch.DateMath? Gt { get; set; } /// - /// Greater than or equal to. + /// + /// Greater than or equal to. + /// /// public Elastic.Clients.Elasticsearch.DateMath? Gte { get; set; } /// - /// Less than. + /// + /// Less than. + /// /// public Elastic.Clients.Elasticsearch.DateMath? Lt { get; set; } /// - /// Less than or equal to. + /// + /// Less than or equal to. + /// /// public Elastic.Clients.Elasticsearch.DateMath? Lte { get; set; } public string? QueryName { get; set; } /// - /// Indicates how the range query matches values for `range` fields. + /// + /// Indicates how the range query matches values for range fields. + /// /// public Elastic.Clients.Elasticsearch.QueryDsl.RangeRelation? Relation { get; set; } /// - /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC. + /// + /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query to UTC. + /// /// public string? TimeZone { get; set; } public Elastic.Clients.Elasticsearch.DateMath? To { get; set; } @@ -271,7 +290,12 @@ public DateRangeQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.DateMath? ToValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public DateRangeQueryDescriptor Boost(float? boost) { @@ -298,7 +322,9 @@ public DateRangeQueryDescriptor Field(Expression - /// Date format used to convert `date` values in the query. + /// + /// Date format used to convert date values in the query. + /// /// public DateRangeQueryDescriptor Format(string? format) { @@ -313,7 +339,9 @@ public DateRangeQueryDescriptor From(Elastic.Clients.Elasticsearch.Da } /// - /// Greater than. + /// + /// Greater than. + /// /// public DateRangeQueryDescriptor Gt(Elastic.Clients.Elasticsearch.DateMath? gt) { @@ -322,7 +350,9 @@ public DateRangeQueryDescriptor Gt(Elastic.Clients.Elasticsearch.Date } /// - /// Greater than or equal to. + /// + /// Greater than or equal to. + /// /// public DateRangeQueryDescriptor Gte(Elastic.Clients.Elasticsearch.DateMath? gte) { @@ -331,7 +361,9 @@ public DateRangeQueryDescriptor Gte(Elastic.Clients.Elasticsearch.Dat } /// - /// Less than. + /// + /// Less than. + /// /// public DateRangeQueryDescriptor Lt(Elastic.Clients.Elasticsearch.DateMath? lt) { @@ -340,7 +372,9 @@ public DateRangeQueryDescriptor Lt(Elastic.Clients.Elasticsearch.Date } /// - /// Less than or equal to. + /// + /// Less than or equal to. + /// /// public DateRangeQueryDescriptor Lte(Elastic.Clients.Elasticsearch.DateMath? lte) { @@ -355,7 +389,9 @@ public DateRangeQueryDescriptor QueryName(string? queryName) } /// - /// Indicates how the range query matches values for `range` fields. + /// + /// Indicates how the range query matches values for range fields. + /// /// public DateRangeQueryDescriptor Relation(Elastic.Clients.Elasticsearch.QueryDsl.RangeRelation? relation) { @@ -364,7 +400,9 @@ public DateRangeQueryDescriptor Relation(Elastic.Clients.Elasticsearc } /// - /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC. + /// + /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query to UTC. + /// /// public DateRangeQueryDescriptor TimeZone(string? timeZone) { @@ -478,7 +516,12 @@ public DateRangeQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.DateMath? ToValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public DateRangeQueryDescriptor Boost(float? boost) { @@ -505,7 +548,9 @@ public DateRangeQueryDescriptor Field(Expression - /// Date format used to convert `date` values in the query. + /// + /// Date format used to convert date values in the query. + /// /// public DateRangeQueryDescriptor Format(string? format) { @@ -520,7 +565,9 @@ public DateRangeQueryDescriptor From(Elastic.Clients.Elasticsearch.DateMath? fro } /// - /// Greater than. + /// + /// Greater than. + /// /// public DateRangeQueryDescriptor Gt(Elastic.Clients.Elasticsearch.DateMath? gt) { @@ -529,7 +576,9 @@ public DateRangeQueryDescriptor Gt(Elastic.Clients.Elasticsearch.DateMath? gt) } /// - /// Greater than or equal to. + /// + /// Greater than or equal to. + /// /// public DateRangeQueryDescriptor Gte(Elastic.Clients.Elasticsearch.DateMath? gte) { @@ -538,7 +587,9 @@ public DateRangeQueryDescriptor Gte(Elastic.Clients.Elasticsearch.DateMath? gte) } /// - /// Less than. + /// + /// Less than. + /// /// public DateRangeQueryDescriptor Lt(Elastic.Clients.Elasticsearch.DateMath? lt) { @@ -547,7 +598,9 @@ public DateRangeQueryDescriptor Lt(Elastic.Clients.Elasticsearch.DateMath? lt) } /// - /// Less than or equal to. + /// + /// Less than or equal to. + /// /// public DateRangeQueryDescriptor Lte(Elastic.Clients.Elasticsearch.DateMath? lte) { @@ -562,7 +615,9 @@ public DateRangeQueryDescriptor QueryName(string? queryName) } /// - /// Indicates how the range query matches values for `range` fields. + /// + /// Indicates how the range query matches values for range fields. + /// /// public DateRangeQueryDescriptor Relation(Elastic.Clients.Elasticsearch.QueryDsl.RangeRelation? relation) { @@ -571,7 +626,9 @@ public DateRangeQueryDescriptor Relation(Elastic.Clients.Elasticsearch.QueryDsl. } /// - /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC. + /// + /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query to UTC. + /// /// public DateRangeQueryDescriptor TimeZone(string? timeZone) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DecayPlacement.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DecayPlacement.g.cs index b3e8bf77522..cd6e15ce644 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DecayPlacement.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DecayPlacement.g.cs @@ -30,27 +30,35 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class DecayPlacement { /// - /// Defines how documents are scored at the distance given at scale. + /// + /// Defines how documents are scored at the distance given at scale. + /// /// [JsonInclude, JsonPropertyName("decay")] public double? Decay { get; set; } /// - /// If defined, the decay function will only compute the decay function for documents with a distance greater than the defined `offset`. + /// + /// If defined, the decay function will only compute the decay function for documents with a distance greater than the defined offset. + /// /// [JsonInclude, JsonPropertyName("offset")] [SourceConverter] public TScale? Offset { get; set; } /// - /// The point of origin used for calculating distance. Must be given as a number for numeric field, date for date fields and geo point for geo fields. + /// + /// The point of origin used for calculating distance. Must be given as a number for numeric field, date for date fields and geo point for geo fields. + /// /// [JsonInclude, JsonPropertyName("origin")] [SourceConverter] public TOrigin? Origin { get; set; } /// - /// Defines the distance from origin + offset at which the computed score will equal `decay` parameter. + /// + /// Defines the distance from origin + offset at which the computed score will equal decay parameter. + /// /// [JsonInclude, JsonPropertyName("scale")] [SourceConverter] diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DisMaxQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DisMaxQuery.g.cs index 52f2bfe27ce..56f0f2a6188 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DisMaxQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DisMaxQuery.g.cs @@ -30,13 +30,22 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class DisMaxQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// One or more query clauses.
Returned documents must match one or more of these queries.
If a document matches multiple queries, Elasticsearch uses the highest relevance score. + /// + /// One or more query clauses. + /// Returned documents must match one or more of these queries. + /// If a document matches multiple queries, Elasticsearch uses the highest relevance score. + /// /// [JsonInclude, JsonPropertyName("queries")] public ICollection Queries { get; set; } @@ -44,7 +53,9 @@ public sealed partial class DisMaxQuery public string? QueryName { get; set; } /// - /// Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses. + /// + /// Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses. + /// /// [JsonInclude, JsonPropertyName("tie_breaker")] public double? TieBreaker { get; set; } @@ -69,7 +80,12 @@ public DisMaxQueryDescriptor() : base() private double? TieBreakerValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public DisMaxQueryDescriptor Boost(float? boost) { @@ -78,7 +94,11 @@ public DisMaxQueryDescriptor Boost(float? boost) } /// - /// One or more query clauses.
Returned documents must match one or more of these queries.
If a document matches multiple queries, Elasticsearch uses the highest relevance score. + /// + /// One or more query clauses. + /// Returned documents must match one or more of these queries. + /// If a document matches multiple queries, Elasticsearch uses the highest relevance score. + /// /// public DisMaxQueryDescriptor Queries(ICollection queries) { @@ -123,7 +143,9 @@ public DisMaxQueryDescriptor QueryName(string? queryName) } /// - /// Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses. + /// + /// Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses. + /// /// public DisMaxQueryDescriptor TieBreaker(double? tieBreaker) { @@ -204,7 +226,12 @@ public DisMaxQueryDescriptor() : base() private double? TieBreakerValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public DisMaxQueryDescriptor Boost(float? boost) { @@ -213,7 +240,11 @@ public DisMaxQueryDescriptor Boost(float? boost) } /// - /// One or more query clauses.
Returned documents must match one or more of these queries.
If a document matches multiple queries, Elasticsearch uses the highest relevance score. + /// + /// One or more query clauses. + /// Returned documents must match one or more of these queries. + /// If a document matches multiple queries, Elasticsearch uses the highest relevance score. + /// /// public DisMaxQueryDescriptor Queries(ICollection queries) { @@ -258,7 +289,9 @@ public DisMaxQueryDescriptor QueryName(string? queryName) } /// - /// Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses. + /// + /// Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses. + /// /// public DisMaxQueryDescriptor TieBreaker(double? tieBreaker) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ExistsQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ExistsQuery.g.cs index b597b33ba4b..747a1048d9f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ExistsQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ExistsQuery.g.cs @@ -30,13 +30,20 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class ExistsQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Name of the field you wish to search. + /// + /// Name of the field you wish to search. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } @@ -59,7 +66,12 @@ public ExistsQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public ExistsQueryDescriptor Boost(float? boost) { @@ -68,7 +80,9 @@ public ExistsQueryDescriptor Boost(float? boost) } /// - /// Name of the field you wish to search. + /// + /// Name of the field you wish to search. + /// /// public ExistsQueryDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -77,7 +91,9 @@ public ExistsQueryDescriptor Field(Elastic.Clients.Elasticsearch.Fiel } /// - /// Name of the field you wish to search. + /// + /// Name of the field you wish to search. + /// /// public ExistsQueryDescriptor Field(Expression> field) { @@ -86,7 +102,9 @@ public ExistsQueryDescriptor Field(Expression - /// Name of the field you wish to search. + /// + /// Name of the field you wish to search. + /// /// public ExistsQueryDescriptor Field(Expression> field) { @@ -134,7 +152,12 @@ public ExistsQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public ExistsQueryDescriptor Boost(float? boost) { @@ -143,7 +166,9 @@ public ExistsQueryDescriptor Boost(float? boost) } /// - /// Name of the field you wish to search. + /// + /// Name of the field you wish to search. + /// /// public ExistsQueryDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -152,7 +177,9 @@ public ExistsQueryDescriptor Field(Elastic.Clients.Elasticsearch.Field field) } /// - /// Name of the field you wish to search. + /// + /// Name of the field you wish to search. + /// /// public ExistsQueryDescriptor Field(Expression> field) { @@ -161,7 +188,9 @@ public ExistsQueryDescriptor Field(Expression - /// Name of the field you wish to search. + /// + /// Name of the field you wish to search. + /// /// public ExistsQueryDescriptor Field(Expression> field) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FieldAndFormat.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FieldAndFormat.g.cs index ba8d91a5502..16db583ecbe 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FieldAndFormat.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FieldAndFormat.g.cs @@ -28,18 +28,24 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; /// -/// A reference to a field with formatting instructions on how to return the value +/// +/// A reference to a field with formatting instructions on how to return the value +/// /// public sealed partial class FieldAndFormat { /// - /// Wildcard pattern. The request returns values for field names matching this pattern. + /// + /// Wildcard pattern. The request returns values for field names matching this pattern. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Format in which the values are returned. + /// + /// Format in which the values are returned. + /// /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } @@ -48,7 +54,9 @@ public sealed partial class FieldAndFormat } /// -/// A reference to a field with formatting instructions on how to return the value +/// +/// A reference to a field with formatting instructions on how to return the value +/// /// public sealed partial class FieldAndFormatDescriptor : SerializableDescriptor> { @@ -63,7 +71,9 @@ public FieldAndFormatDescriptor() : base() private bool? IncludeUnmappedValue { get; set; } /// - /// Wildcard pattern. The request returns values for field names matching this pattern. + /// + /// Wildcard pattern. The request returns values for field names matching this pattern. + /// /// public FieldAndFormatDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -72,7 +82,9 @@ public FieldAndFormatDescriptor Field(Elastic.Clients.Elasticsearch.F } /// - /// Wildcard pattern. The request returns values for field names matching this pattern. + /// + /// Wildcard pattern. The request returns values for field names matching this pattern. + /// /// public FieldAndFormatDescriptor Field(Expression> field) { @@ -81,7 +93,9 @@ public FieldAndFormatDescriptor Field(Expression - /// Wildcard pattern. The request returns values for field names matching this pattern. + /// + /// Wildcard pattern. The request returns values for field names matching this pattern. + /// /// public FieldAndFormatDescriptor Field(Expression> field) { @@ -90,7 +104,9 @@ public FieldAndFormatDescriptor Field(Expression - /// Format in which the values are returned. + /// + /// Format in which the values are returned. + /// /// public FieldAndFormatDescriptor Format(string? format) { @@ -126,7 +142,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// A reference to a field with formatting instructions on how to return the value +/// +/// A reference to a field with formatting instructions on how to return the value +/// /// public sealed partial class FieldAndFormatDescriptor : SerializableDescriptor { @@ -141,7 +159,9 @@ public FieldAndFormatDescriptor() : base() private bool? IncludeUnmappedValue { get; set; } /// - /// Wildcard pattern. The request returns values for field names matching this pattern. + /// + /// Wildcard pattern. The request returns values for field names matching this pattern. + /// /// public FieldAndFormatDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -150,7 +170,9 @@ public FieldAndFormatDescriptor Field(Elastic.Clients.Elasticsearch.Field field) } /// - /// Wildcard pattern. The request returns values for field names matching this pattern. + /// + /// Wildcard pattern. The request returns values for field names matching this pattern. + /// /// public FieldAndFormatDescriptor Field(Expression> field) { @@ -159,7 +181,9 @@ public FieldAndFormatDescriptor Field(Expression - /// Wildcard pattern. The request returns values for field names matching this pattern. + /// + /// Wildcard pattern. The request returns values for field names matching this pattern. + /// /// public FieldAndFormatDescriptor Field(Expression> field) { @@ -168,7 +192,9 @@ public FieldAndFormatDescriptor Field(Expression - /// Format in which the values are returned. + /// + /// Format in which the values are returned. + /// /// public FieldAndFormatDescriptor Format(string? format) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FieldLookup.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FieldLookup.g.cs index e8f66714d9e..157f53f5c02 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FieldLookup.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FieldLookup.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class FieldLookup { /// - /// `id` of the document. + /// + /// id of the document. + /// /// [JsonInclude, JsonPropertyName("id")] public Elastic.Clients.Elasticsearch.Id Id { get; set; } /// - /// Index from which to retrieve the document. + /// + /// Index from which to retrieve the document. + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.IndexName? Index { get; set; } /// - /// Name of the field. + /// + /// Name of the field. + /// /// [JsonInclude, JsonPropertyName("path")] public Elastic.Clients.Elasticsearch.Field? Path { get; set; } /// - /// Custom routing value. + /// + /// Custom routing value. + /// /// [JsonInclude, JsonPropertyName("routing")] public Elastic.Clients.Elasticsearch.Routing? Routing { get; set; } @@ -68,7 +76,9 @@ public FieldLookupDescriptor() : base() private Elastic.Clients.Elasticsearch.Routing? RoutingValue { get; set; } /// - /// `id` of the document. + /// + /// id of the document. + /// /// public FieldLookupDescriptor Id(Elastic.Clients.Elasticsearch.Id id) { @@ -77,7 +87,9 @@ public FieldLookupDescriptor Id(Elastic.Clients.Elasticsearch.Id id) } /// - /// Index from which to retrieve the document. + /// + /// Index from which to retrieve the document. + /// /// public FieldLookupDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? index) { @@ -86,7 +98,9 @@ public FieldLookupDescriptor Index(Elastic.Clients.Elasticsearch.Inde } /// - /// Name of the field. + /// + /// Name of the field. + /// /// public FieldLookupDescriptor Path(Elastic.Clients.Elasticsearch.Field? path) { @@ -95,7 +109,9 @@ public FieldLookupDescriptor Path(Elastic.Clients.Elasticsearch.Field } /// - /// Name of the field. + /// + /// Name of the field. + /// /// public FieldLookupDescriptor Path(Expression> path) { @@ -104,7 +120,9 @@ public FieldLookupDescriptor Path(Expression - /// Name of the field. + /// + /// Name of the field. + /// /// public FieldLookupDescriptor Path(Expression> path) { @@ -113,7 +131,9 @@ public FieldLookupDescriptor Path(Expression> } /// - /// Custom routing value. + /// + /// Custom routing value. + /// /// public FieldLookupDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? routing) { @@ -162,7 +182,9 @@ public FieldLookupDescriptor() : base() private Elastic.Clients.Elasticsearch.Routing? RoutingValue { get; set; } /// - /// `id` of the document. + /// + /// id of the document. + /// /// public FieldLookupDescriptor Id(Elastic.Clients.Elasticsearch.Id id) { @@ -171,7 +193,9 @@ public FieldLookupDescriptor Id(Elastic.Clients.Elasticsearch.Id id) } /// - /// Index from which to retrieve the document. + /// + /// Index from which to retrieve the document. + /// /// public FieldLookupDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? index) { @@ -180,7 +204,9 @@ public FieldLookupDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? inde } /// - /// Name of the field. + /// + /// Name of the field. + /// /// public FieldLookupDescriptor Path(Elastic.Clients.Elasticsearch.Field? path) { @@ -189,7 +215,9 @@ public FieldLookupDescriptor Path(Elastic.Clients.Elasticsearch.Field? path) } /// - /// Name of the field. + /// + /// Name of the field. + /// /// public FieldLookupDescriptor Path(Expression> path) { @@ -198,7 +226,9 @@ public FieldLookupDescriptor Path(Expression - /// Name of the field. + /// + /// Name of the field. + /// /// public FieldLookupDescriptor Path(Expression> path) { @@ -207,7 +237,9 @@ public FieldLookupDescriptor Path(Expression> } /// - /// Custom routing value. + /// + /// Custom routing value. + /// /// public FieldLookupDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? routing) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FieldValueFactorScoreFunction.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FieldValueFactorScoreFunction.g.cs index edffdcb767b..0e09903ac26 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FieldValueFactorScoreFunction.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FieldValueFactorScoreFunction.g.cs @@ -30,25 +30,34 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class FieldValueFactorScoreFunction { /// - /// Optional factor to multiply the field value with. + /// + /// Optional factor to multiply the field value with. + /// /// [JsonInclude, JsonPropertyName("factor")] public double? Factor { get; set; } /// - /// Field to be extracted from the document. + /// + /// Field to be extracted from the document. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Value used if the document doesn’t have that field.
The modifier and factor are still applied to it as though it were read from the document. + /// + /// Value used if the document doesn’t have that field. + /// The modifier and factor are still applied to it as though it were read from the document. + /// /// [JsonInclude, JsonPropertyName("missing")] public double? Missing { get; set; } /// - /// Modifier to apply to the field value. + /// + /// Modifier to apply to the field value. + /// /// [JsonInclude, JsonPropertyName("modifier")] public Elastic.Clients.Elasticsearch.QueryDsl.FieldValueFactorModifier? Modifier { get; set; } @@ -70,7 +79,9 @@ public FieldValueFactorScoreFunctionDescriptor() : base() private Elastic.Clients.Elasticsearch.QueryDsl.FieldValueFactorModifier? ModifierValue { get; set; } /// - /// Optional factor to multiply the field value with. + /// + /// Optional factor to multiply the field value with. + /// /// public FieldValueFactorScoreFunctionDescriptor Factor(double? factor) { @@ -79,7 +90,9 @@ public FieldValueFactorScoreFunctionDescriptor Factor(double? factor) } /// - /// Field to be extracted from the document. + /// + /// Field to be extracted from the document. + /// /// public FieldValueFactorScoreFunctionDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -88,7 +101,9 @@ public FieldValueFactorScoreFunctionDescriptor Field(Elastic.Clients. } /// - /// Field to be extracted from the document. + /// + /// Field to be extracted from the document. + /// /// public FieldValueFactorScoreFunctionDescriptor Field(Expression> field) { @@ -97,7 +112,9 @@ public FieldValueFactorScoreFunctionDescriptor Field(Expressi } /// - /// Field to be extracted from the document. + /// + /// Field to be extracted from the document. + /// /// public FieldValueFactorScoreFunctionDescriptor Field(Expression> field) { @@ -106,7 +123,10 @@ public FieldValueFactorScoreFunctionDescriptor Field(Expression - /// Value used if the document doesn’t have that field.
The modifier and factor are still applied to it as though it were read from the document. + /// + /// Value used if the document doesn’t have that field. + /// The modifier and factor are still applied to it as though it were read from the document. + /// /// public FieldValueFactorScoreFunctionDescriptor Missing(double? missing) { @@ -115,7 +135,9 @@ public FieldValueFactorScoreFunctionDescriptor Missing(double? missin } /// - /// Modifier to apply to the field value. + /// + /// Modifier to apply to the field value. + /// /// public FieldValueFactorScoreFunctionDescriptor Modifier(Elastic.Clients.Elasticsearch.QueryDsl.FieldValueFactorModifier? modifier) { @@ -164,7 +186,9 @@ public FieldValueFactorScoreFunctionDescriptor() : base() private Elastic.Clients.Elasticsearch.QueryDsl.FieldValueFactorModifier? ModifierValue { get; set; } /// - /// Optional factor to multiply the field value with. + /// + /// Optional factor to multiply the field value with. + /// /// public FieldValueFactorScoreFunctionDescriptor Factor(double? factor) { @@ -173,7 +197,9 @@ public FieldValueFactorScoreFunctionDescriptor Factor(double? factor) } /// - /// Field to be extracted from the document. + /// + /// Field to be extracted from the document. + /// /// public FieldValueFactorScoreFunctionDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -182,7 +208,9 @@ public FieldValueFactorScoreFunctionDescriptor Field(Elastic.Clients.Elasticsear } /// - /// Field to be extracted from the document. + /// + /// Field to be extracted from the document. + /// /// public FieldValueFactorScoreFunctionDescriptor Field(Expression> field) { @@ -191,7 +219,9 @@ public FieldValueFactorScoreFunctionDescriptor Field(Expressi } /// - /// Field to be extracted from the document. + /// + /// Field to be extracted from the document. + /// /// public FieldValueFactorScoreFunctionDescriptor Field(Expression> field) { @@ -200,7 +230,10 @@ public FieldValueFactorScoreFunctionDescriptor Field(Expression - /// Value used if the document doesn’t have that field.
The modifier and factor are still applied to it as though it were read from the document. + /// + /// Value used if the document doesn’t have that field. + /// The modifier and factor are still applied to it as though it were read from the document. + /// /// public FieldValueFactorScoreFunctionDescriptor Missing(double? missing) { @@ -209,7 +242,9 @@ public FieldValueFactorScoreFunctionDescriptor Missing(double? missing) } /// - /// Modifier to apply to the field value. + /// + /// Modifier to apply to the field value. + /// /// public FieldValueFactorScoreFunctionDescriptor Modifier(Elastic.Clients.Elasticsearch.QueryDsl.FieldValueFactorModifier? modifier) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FunctionScoreQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FunctionScoreQuery.g.cs index 42a50d3ac4d..0b27f35c415 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FunctionScoreQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FunctionScoreQuery.g.cs @@ -30,37 +30,52 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class FunctionScoreQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Defines how he newly computed score is combined with the score of the query + /// + /// Defines how he newly computed score is combined with the score of the query + /// /// [JsonInclude, JsonPropertyName("boost_mode")] public Elastic.Clients.Elasticsearch.QueryDsl.FunctionBoostMode? BoostMode { get; set; } /// - /// One or more functions that compute a new score for each document returned by the query. + /// + /// One or more functions that compute a new score for each document returned by the query. + /// /// [JsonInclude, JsonPropertyName("functions")] public ICollection? Functions { get; set; } /// - /// Restricts the new score to not exceed the provided limit. + /// + /// Restricts the new score to not exceed the provided limit. + /// /// [JsonInclude, JsonPropertyName("max_boost")] public double? MaxBoost { get; set; } /// - /// Excludes documents that do not meet the provided score threshold. + /// + /// Excludes documents that do not meet the provided score threshold. + /// /// [JsonInclude, JsonPropertyName("min_score")] public double? MinScore { get; set; } /// - /// A query that determines the documents for which a new score is computed. + /// + /// A query that determines the documents for which a new score is computed. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Query { get; set; } @@ -68,7 +83,9 @@ public sealed partial class FunctionScoreQuery public string? QueryName { get; set; } /// - /// Specifies how the computed scores are combined + /// + /// Specifies how the computed scores are combined + /// /// [JsonInclude, JsonPropertyName("score_mode")] public Elastic.Clients.Elasticsearch.QueryDsl.FunctionScoreMode? ScoreMode { get; set; } @@ -99,7 +116,12 @@ public FunctionScoreQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.QueryDsl.FunctionScoreMode? ScoreModeValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public FunctionScoreQueryDescriptor Boost(float? boost) { @@ -108,7 +130,9 @@ public FunctionScoreQueryDescriptor Boost(float? boost) } /// - /// Defines how he newly computed score is combined with the score of the query + /// + /// Defines how he newly computed score is combined with the score of the query + /// /// public FunctionScoreQueryDescriptor BoostMode(Elastic.Clients.Elasticsearch.QueryDsl.FunctionBoostMode? boostMode) { @@ -117,7 +141,9 @@ public FunctionScoreQueryDescriptor BoostMode(Elastic.Clients.Elastic } /// - /// One or more functions that compute a new score for each document returned by the query. + /// + /// One or more functions that compute a new score for each document returned by the query. + /// /// public FunctionScoreQueryDescriptor Functions(ICollection? functions) { @@ -156,7 +182,9 @@ public FunctionScoreQueryDescriptor Functions(params Action - /// Restricts the new score to not exceed the provided limit. + /// + /// Restricts the new score to not exceed the provided limit. + /// /// public FunctionScoreQueryDescriptor MaxBoost(double? maxBoost) { @@ -165,7 +193,9 @@ public FunctionScoreQueryDescriptor MaxBoost(double? maxBoost) } /// - /// Excludes documents that do not meet the provided score threshold. + /// + /// Excludes documents that do not meet the provided score threshold. + /// /// public FunctionScoreQueryDescriptor MinScore(double? minScore) { @@ -174,7 +204,9 @@ public FunctionScoreQueryDescriptor MinScore(double? minScore) } /// - /// A query that determines the documents for which a new score is computed. + /// + /// A query that determines the documents for which a new score is computed. + /// /// public FunctionScoreQueryDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -207,7 +239,9 @@ public FunctionScoreQueryDescriptor QueryName(string? queryName) } /// - /// Specifies how the computed scores are combined + /// + /// Specifies how the computed scores are combined + /// /// public FunctionScoreQueryDescriptor ScoreMode(Elastic.Clients.Elasticsearch.QueryDsl.FunctionScoreMode? scoreMode) { @@ -328,7 +362,12 @@ public FunctionScoreQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.QueryDsl.FunctionScoreMode? ScoreModeValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public FunctionScoreQueryDescriptor Boost(float? boost) { @@ -337,7 +376,9 @@ public FunctionScoreQueryDescriptor Boost(float? boost) } /// - /// Defines how he newly computed score is combined with the score of the query + /// + /// Defines how he newly computed score is combined with the score of the query + /// /// public FunctionScoreQueryDescriptor BoostMode(Elastic.Clients.Elasticsearch.QueryDsl.FunctionBoostMode? boostMode) { @@ -346,7 +387,9 @@ public FunctionScoreQueryDescriptor BoostMode(Elastic.Clients.Elasticsearch.Quer } /// - /// One or more functions that compute a new score for each document returned by the query. + /// + /// One or more functions that compute a new score for each document returned by the query. + /// /// public FunctionScoreQueryDescriptor Functions(ICollection? functions) { @@ -385,7 +428,9 @@ public FunctionScoreQueryDescriptor Functions(params Action - /// Restricts the new score to not exceed the provided limit. + /// + /// Restricts the new score to not exceed the provided limit. + /// /// public FunctionScoreQueryDescriptor MaxBoost(double? maxBoost) { @@ -394,7 +439,9 @@ public FunctionScoreQueryDescriptor MaxBoost(double? maxBoost) } /// - /// Excludes documents that do not meet the provided score threshold. + /// + /// Excludes documents that do not meet the provided score threshold. + /// /// public FunctionScoreQueryDescriptor MinScore(double? minScore) { @@ -403,7 +450,9 @@ public FunctionScoreQueryDescriptor MinScore(double? minScore) } /// - /// A query that determines the documents for which a new score is computed. + /// + /// A query that determines the documents for which a new score is computed. + /// /// public FunctionScoreQueryDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -436,7 +485,9 @@ public FunctionScoreQueryDescriptor QueryName(string? queryName) } /// - /// Specifies how the computed scores are combined + /// + /// Specifies how the computed scores are combined + /// /// public FunctionScoreQueryDescriptor ScoreMode(Elastic.Clients.Elasticsearch.QueryDsl.FunctionScoreMode? scoreMode) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FuzzyQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FuzzyQuery.g.cs index 5f052468199..511e2e5009d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FuzzyQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FuzzyQuery.g.cs @@ -165,39 +165,56 @@ public FuzzyQuery(Elastic.Clients.Elasticsearch.Field field) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Maximum edit distance allowed for matching. + /// + /// Maximum edit distance allowed for matching. + /// /// public Elastic.Clients.Elasticsearch.Fuzziness? Fuzziness { get; set; } /// - /// Maximum number of variations created. + /// + /// Maximum number of variations created. + /// /// public int? MaxExpansions { get; set; } /// - /// Number of beginning characters left unchanged when creating expansions. + /// + /// Number of beginning characters left unchanged when creating expansions. + /// /// public int? PrefixLength { get; set; } public string? QueryName { get; set; } /// - /// Number of beginning characters left unchanged when creating expansions. + /// + /// Number of beginning characters left unchanged when creating expansions. + /// /// public string? Rewrite { get; set; } /// - /// Indicates whether edits include transpositions of two adjacent characters (for example `ab` to `ba`). + /// + /// Indicates whether edits include transpositions of two adjacent characters (for example ab to ba). + /// /// public bool? Transpositions { get; set; } /// - /// Term you wish to find in the provided field. + /// + /// Term you wish to find in the provided field. + /// /// public object Value { get; set; } @@ -223,7 +240,12 @@ public FuzzyQueryDescriptor() : base() private object ValueValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public FuzzyQueryDescriptor Boost(float? boost) { @@ -250,7 +272,9 @@ public FuzzyQueryDescriptor Field(Expression> } /// - /// Maximum edit distance allowed for matching. + /// + /// Maximum edit distance allowed for matching. + /// /// public FuzzyQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzziness? fuzziness) { @@ -259,7 +283,9 @@ public FuzzyQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.F } /// - /// Maximum number of variations created. + /// + /// Maximum number of variations created. + /// /// public FuzzyQueryDescriptor MaxExpansions(int? maxExpansions) { @@ -268,7 +294,9 @@ public FuzzyQueryDescriptor MaxExpansions(int? maxExpansions) } /// - /// Number of beginning characters left unchanged when creating expansions. + /// + /// Number of beginning characters left unchanged when creating expansions. + /// /// public FuzzyQueryDescriptor PrefixLength(int? prefixLength) { @@ -283,7 +311,9 @@ public FuzzyQueryDescriptor QueryName(string? queryName) } /// - /// Number of beginning characters left unchanged when creating expansions. + /// + /// Number of beginning characters left unchanged when creating expansions. + /// /// public FuzzyQueryDescriptor Rewrite(string? rewrite) { @@ -292,7 +322,9 @@ public FuzzyQueryDescriptor Rewrite(string? rewrite) } /// - /// Indicates whether edits include transpositions of two adjacent characters (for example `ab` to `ba`). + /// + /// Indicates whether edits include transpositions of two adjacent characters (for example ab to ba). + /// /// public FuzzyQueryDescriptor Transpositions(bool? transpositions = true) { @@ -301,7 +333,9 @@ public FuzzyQueryDescriptor Transpositions(bool? transpositions = tru } /// - /// Term you wish to find in the provided field. + /// + /// Term you wish to find in the provided field. + /// /// public FuzzyQueryDescriptor Value(object value) { @@ -384,7 +418,12 @@ public FuzzyQueryDescriptor() : base() private object ValueValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public FuzzyQueryDescriptor Boost(float? boost) { @@ -411,7 +450,9 @@ public FuzzyQueryDescriptor Field(Expression> } /// - /// Maximum edit distance allowed for matching. + /// + /// Maximum edit distance allowed for matching. + /// /// public FuzzyQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzziness? fuzziness) { @@ -420,7 +461,9 @@ public FuzzyQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzziness? f } /// - /// Maximum number of variations created. + /// + /// Maximum number of variations created. + /// /// public FuzzyQueryDescriptor MaxExpansions(int? maxExpansions) { @@ -429,7 +472,9 @@ public FuzzyQueryDescriptor MaxExpansions(int? maxExpansions) } /// - /// Number of beginning characters left unchanged when creating expansions. + /// + /// Number of beginning characters left unchanged when creating expansions. + /// /// public FuzzyQueryDescriptor PrefixLength(int? prefixLength) { @@ -444,7 +489,9 @@ public FuzzyQueryDescriptor QueryName(string? queryName) } /// - /// Number of beginning characters left unchanged when creating expansions. + /// + /// Number of beginning characters left unchanged when creating expansions. + /// /// public FuzzyQueryDescriptor Rewrite(string? rewrite) { @@ -453,7 +500,9 @@ public FuzzyQueryDescriptor Rewrite(string? rewrite) } /// - /// Indicates whether edits include transpositions of two adjacent characters (for example `ab` to `ba`). + /// + /// Indicates whether edits include transpositions of two adjacent characters (for example ab to ba). + /// /// public FuzzyQueryDescriptor Transpositions(bool? transpositions = true) { @@ -462,7 +511,9 @@ public FuzzyQueryDescriptor Transpositions(bool? transpositions = true) } /// - /// Term you wish to find in the provided field. + /// + /// Term you wish to find in the provided field. + /// /// public FuzzyQueryDescriptor Value(object value) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoBoundingBoxQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoBoundingBoxQuery.g.cs index 91da280854c..8833c66c219 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoBoundingBoxQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoBoundingBoxQuery.g.cs @@ -119,20 +119,31 @@ public override void Write(Utf8JsonWriter writer, GeoBoundingBoxQuery value, Jso public sealed partial class GeoBoundingBoxQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.GeoBounds BoundingBox { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Set to `true` to ignore an unmapped field and not match any documents for this query.
Set to `false` to throw an exception if the field is not mapped. + /// + /// Set to true to ignore an unmapped field and not match any documents for this query. + /// Set to false to throw an exception if the field is not mapped. + /// /// public bool? IgnoreUnmapped { get; set; } public string? QueryName { get; set; } /// - /// Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.
Set to `COERCE` to also try to infer correct latitude or longitude. + /// + /// Set to IGNORE_MALFORMED to accept geo points with invalid latitude or longitude. + /// Set to COERCE to also try to infer correct latitude or longitude. + /// /// public Elastic.Clients.Elasticsearch.QueryDsl.GeoValidationMethod? ValidationMethod { get; set; } @@ -155,7 +166,12 @@ public GeoBoundingBoxQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.QueryDsl.GeoValidationMethod? ValidationMethodValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public GeoBoundingBoxQueryDescriptor Boost(float? boost) { @@ -188,7 +204,10 @@ public GeoBoundingBoxQueryDescriptor Field(Expression - /// Set to `true` to ignore an unmapped field and not match any documents for this query.
Set to `false` to throw an exception if the field is not mapped. + /// + /// Set to true to ignore an unmapped field and not match any documents for this query. + /// Set to false to throw an exception if the field is not mapped. + /// /// public GeoBoundingBoxQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { @@ -203,7 +222,10 @@ public GeoBoundingBoxQueryDescriptor QueryName(string? queryName) } /// - /// Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.
Set to `COERCE` to also try to infer correct latitude or longitude. + /// + /// Set to IGNORE_MALFORMED to accept geo points with invalid latitude or longitude. + /// Set to COERCE to also try to infer correct latitude or longitude. + /// /// public GeoBoundingBoxQueryDescriptor ValidationMethod(Elastic.Clients.Elasticsearch.QueryDsl.GeoValidationMethod? validationMethod) { @@ -265,7 +287,12 @@ public GeoBoundingBoxQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.QueryDsl.GeoValidationMethod? ValidationMethodValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public GeoBoundingBoxQueryDescriptor Boost(float? boost) { @@ -298,7 +325,10 @@ public GeoBoundingBoxQueryDescriptor Field(Expression - /// Set to `true` to ignore an unmapped field and not match any documents for this query.
Set to `false` to throw an exception if the field is not mapped. + /// + /// Set to true to ignore an unmapped field and not match any documents for this query. + /// Set to false to throw an exception if the field is not mapped. + /// /// public GeoBoundingBoxQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { @@ -313,7 +343,10 @@ public GeoBoundingBoxQueryDescriptor QueryName(string? queryName) } /// - /// Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.
Set to `COERCE` to also try to infer correct latitude or longitude. + /// + /// Set to IGNORE_MALFORMED to accept geo points with invalid latitude or longitude. + /// Set to COERCE to also try to infer correct latitude or longitude. + /// /// public GeoBoundingBoxQueryDescriptor ValidationMethod(Elastic.Clients.Elasticsearch.QueryDsl.GeoValidationMethod? validationMethod) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoDecayFunction.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoDecayFunction.g.cs index 05087127468..446768423be 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoDecayFunction.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoDecayFunction.g.cs @@ -85,7 +85,9 @@ public sealed partial class GeoDecayFunction public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// + /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// /// public Elastic.Clients.Elasticsearch.QueryDsl.MultiValueMode? MultiValueMode { get; set; } public Elastic.Clients.Elasticsearch.QueryDsl.DecayPlacement Placement { get; set; } @@ -122,7 +124,9 @@ public GeoDecayFunctionDescriptor Field(Expression - /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// + /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// /// public GeoDecayFunctionDescriptor MultiValueMode(Elastic.Clients.Elasticsearch.QueryDsl.MultiValueMode? multiValueMode) { @@ -187,7 +191,9 @@ public GeoDecayFunctionDescriptor Field(Expression - /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// + /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// /// public GeoDecayFunctionDescriptor MultiValueMode(Elastic.Clients.Elasticsearch.QueryDsl.MultiValueMode? multiValueMode) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoDistanceFeatureQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoDistanceFeatureQuery.g.cs index 1c98556dfcb..5c04cad4816 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoDistanceFeatureQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoDistanceFeatureQuery.g.cs @@ -30,25 +30,43 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class GeoDistanceFeatureQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Date or point of origin used to calculate distances.
If the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.
Date Math, such as `now-1h`, is supported.
If the field value is a `geo_point` field, the `origin` value must be a geopoint. + /// + /// Date or point of origin used to calculate distances. + /// If the field value is a date or date_nanos field, the origin value must be a date. + /// Date Math, such as now-1h, is supported. + /// If the field value is a geo_point field, the origin value must be a geopoint. + /// /// [JsonInclude, JsonPropertyName("origin")] public Elastic.Clients.Elasticsearch.GeoLocation Origin { get; set; } /// - /// Distance from the `origin` at which relevance scores receive half of the `boost` value.
If the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`. + /// + /// Distance from the origin at which relevance scores receive half of the boost value. + /// If the field value is a date or date_nanos field, the pivot value must be a time unit, such as 1h or 10d. If the field value is a geo_point field, the pivot value must be a distance unit, such as 1km or 12m. + /// /// [JsonInclude, JsonPropertyName("pivot")] public string Pivot { get; set; } @@ -71,7 +89,12 @@ public GeoDistanceFeatureQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public GeoDistanceFeatureQueryDescriptor Boost(float? boost) { @@ -80,7 +103,12 @@ public GeoDistanceFeatureQueryDescriptor Boost(float? boost) } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public GeoDistanceFeatureQueryDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -89,7 +117,12 @@ public GeoDistanceFeatureQueryDescriptor Field(Elastic.Clients.Elasti } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public GeoDistanceFeatureQueryDescriptor Field(Expression> field) { @@ -98,7 +131,12 @@ public GeoDistanceFeatureQueryDescriptor Field(Expression - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public GeoDistanceFeatureQueryDescriptor Field(Expression> field) { @@ -107,7 +145,12 @@ public GeoDistanceFeatureQueryDescriptor Field(Expression - /// Date or point of origin used to calculate distances.
If the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.
Date Math, such as `now-1h`, is supported.
If the field value is a `geo_point` field, the `origin` value must be a geopoint. + /// + /// Date or point of origin used to calculate distances. + /// If the field value is a date or date_nanos field, the origin value must be a date. + /// Date Math, such as now-1h, is supported. + /// If the field value is a geo_point field, the origin value must be a geopoint. + /// /// public GeoDistanceFeatureQueryDescriptor Origin(Elastic.Clients.Elasticsearch.GeoLocation origin) { @@ -116,7 +159,10 @@ public GeoDistanceFeatureQueryDescriptor Origin(Elastic.Clients.Elast } /// - /// Distance from the `origin` at which relevance scores receive half of the `boost` value.
If the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`. + /// + /// Distance from the origin at which relevance scores receive half of the boost value. + /// If the field value is a date or date_nanos field, the pivot value must be a time unit, such as 1h or 10d. If the field value is a geo_point field, the pivot value must be a distance unit, such as 1km or 12m. + /// /// public GeoDistanceFeatureQueryDescriptor Pivot(string pivot) { @@ -170,7 +216,12 @@ public GeoDistanceFeatureQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public GeoDistanceFeatureQueryDescriptor Boost(float? boost) { @@ -179,7 +230,12 @@ public GeoDistanceFeatureQueryDescriptor Boost(float? boost) } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public GeoDistanceFeatureQueryDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -188,7 +244,12 @@ public GeoDistanceFeatureQueryDescriptor Field(Elastic.Clients.Elasticsearch.Fie } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public GeoDistanceFeatureQueryDescriptor Field(Expression> field) { @@ -197,7 +258,12 @@ public GeoDistanceFeatureQueryDescriptor Field(Expression - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public GeoDistanceFeatureQueryDescriptor Field(Expression> field) { @@ -206,7 +272,12 @@ public GeoDistanceFeatureQueryDescriptor Field(Expression - /// Date or point of origin used to calculate distances.
If the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.
Date Math, such as `now-1h`, is supported.
If the field value is a `geo_point` field, the `origin` value must be a geopoint. + /// + /// Date or point of origin used to calculate distances. + /// If the field value is a date or date_nanos field, the origin value must be a date. + /// Date Math, such as now-1h, is supported. + /// If the field value is a geo_point field, the origin value must be a geopoint. + /// /// public GeoDistanceFeatureQueryDescriptor Origin(Elastic.Clients.Elasticsearch.GeoLocation origin) { @@ -215,7 +286,10 @@ public GeoDistanceFeatureQueryDescriptor Origin(Elastic.Clients.Elasticsearch.Ge } /// - /// Distance from the `origin` at which relevance scores receive half of the `boost` value.
If the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`. + /// + /// Distance from the origin at which relevance scores receive half of the boost value. + /// If the field value is a date or date_nanos field, the pivot value must be a time unit, such as 1h or 10d. If the field value is a geo_point field, the pivot value must be a distance unit, such as 1km or 12m. + /// /// public GeoDistanceFeatureQueryDescriptor Pivot(string pivot) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoDistanceQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoDistanceQuery.g.cs index 90ac78371ee..04dae04ae98 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoDistanceQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoDistanceQuery.g.cs @@ -139,30 +139,47 @@ public override void Write(Utf8JsonWriter writer, GeoDistanceQuery value, JsonSe public sealed partial class GeoDistanceQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } /// - /// The radius of the circle centred on the specified location.
Points which fall into this circle are considered to be matches. + /// + /// The radius of the circle centred on the specified location. + /// Points which fall into this circle are considered to be matches. + /// /// public string Distance { get; set; } /// - /// How to compute the distance.
Set to `plane` for a faster calculation that's inaccurate on long distances and close to the poles. + /// + /// How to compute the distance. + /// Set to plane for a faster calculation that's inaccurate on long distances and close to the poles. + /// /// public Elastic.Clients.Elasticsearch.GeoDistanceType? DistanceType { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Set to `true` to ignore an unmapped field and not match any documents for this query.
Set to `false` to throw an exception if the field is not mapped. + /// + /// Set to true to ignore an unmapped field and not match any documents for this query. + /// Set to false to throw an exception if the field is not mapped. + /// /// public bool? IgnoreUnmapped { get; set; } public Elastic.Clients.Elasticsearch.GeoLocation Location { get; set; } public string? QueryName { get; set; } /// - /// Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.
Set to `COERCE` to also try to infer correct latitude or longitude. + /// + /// Set to IGNORE_MALFORMED to accept geo points with invalid latitude or longitude. + /// Set to COERCE to also try to infer correct latitude or longitude. + /// /// public Elastic.Clients.Elasticsearch.QueryDsl.GeoValidationMethod? ValidationMethod { get; set; } @@ -187,7 +204,12 @@ public GeoDistanceQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.QueryDsl.GeoValidationMethod? ValidationMethodValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public GeoDistanceQueryDescriptor Boost(float? boost) { @@ -196,7 +218,10 @@ public GeoDistanceQueryDescriptor Boost(float? boost) } /// - /// The radius of the circle centred on the specified location.
Points which fall into this circle are considered to be matches. + /// + /// The radius of the circle centred on the specified location. + /// Points which fall into this circle are considered to be matches. + /// /// public GeoDistanceQueryDescriptor Distance(string distance) { @@ -205,7 +230,10 @@ public GeoDistanceQueryDescriptor Distance(string distance) } /// - /// How to compute the distance.
Set to `plane` for a faster calculation that's inaccurate on long distances and close to the poles. + /// + /// How to compute the distance. + /// Set to plane for a faster calculation that's inaccurate on long distances and close to the poles. + /// /// public GeoDistanceQueryDescriptor DistanceType(Elastic.Clients.Elasticsearch.GeoDistanceType? distanceType) { @@ -232,7 +260,10 @@ public GeoDistanceQueryDescriptor Field(Expression - /// Set to `true` to ignore an unmapped field and not match any documents for this query.
Set to `false` to throw an exception if the field is not mapped. + /// + /// Set to true to ignore an unmapped field and not match any documents for this query. + /// Set to false to throw an exception if the field is not mapped. + /// /// public GeoDistanceQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { @@ -253,7 +284,10 @@ public GeoDistanceQueryDescriptor QueryName(string? queryName) } /// - /// Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.
Set to `COERCE` to also try to infer correct latitude or longitude. + /// + /// Set to IGNORE_MALFORMED to accept geo points with invalid latitude or longitude. + /// Set to COERCE to also try to infer correct latitude or longitude. + /// /// public GeoDistanceQueryDescriptor ValidationMethod(Elastic.Clients.Elasticsearch.QueryDsl.GeoValidationMethod? validationMethod) { @@ -325,7 +359,12 @@ public GeoDistanceQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.QueryDsl.GeoValidationMethod? ValidationMethodValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public GeoDistanceQueryDescriptor Boost(float? boost) { @@ -334,7 +373,10 @@ public GeoDistanceQueryDescriptor Boost(float? boost) } /// - /// The radius of the circle centred on the specified location.
Points which fall into this circle are considered to be matches. + /// + /// The radius of the circle centred on the specified location. + /// Points which fall into this circle are considered to be matches. + /// /// public GeoDistanceQueryDescriptor Distance(string distance) { @@ -343,7 +385,10 @@ public GeoDistanceQueryDescriptor Distance(string distance) } /// - /// How to compute the distance.
Set to `plane` for a faster calculation that's inaccurate on long distances and close to the poles. + /// + /// How to compute the distance. + /// Set to plane for a faster calculation that's inaccurate on long distances and close to the poles. + /// /// public GeoDistanceQueryDescriptor DistanceType(Elastic.Clients.Elasticsearch.GeoDistanceType? distanceType) { @@ -370,7 +415,10 @@ public GeoDistanceQueryDescriptor Field(Expression - /// Set to `true` to ignore an unmapped field and not match any documents for this query.
Set to `false` to throw an exception if the field is not mapped. + /// + /// Set to true to ignore an unmapped field and not match any documents for this query. + /// Set to false to throw an exception if the field is not mapped. + /// /// public GeoDistanceQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { @@ -391,7 +439,10 @@ public GeoDistanceQueryDescriptor QueryName(string? queryName) } /// - /// Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.
Set to `COERCE` to also try to infer correct latitude or longitude. + /// + /// Set to IGNORE_MALFORMED to accept geo points with invalid latitude or longitude. + /// Set to COERCE to also try to infer correct latitude or longitude. + /// /// public GeoDistanceQueryDescriptor ValidationMethod(Elastic.Clients.Elasticsearch.QueryDsl.GeoValidationMethod? validationMethod) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoShapeFieldQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoShapeFieldQuery.g.cs index f47c962d317..061f17eee7c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoShapeFieldQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoShapeFieldQuery.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class GeoShapeFieldQuery { /// - /// Query using an indexed shape retrieved from the the specified document and path. + /// + /// Query using an indexed shape retrieved from the the specified document and path. + /// /// [JsonInclude, JsonPropertyName("indexed_shape")] public Elastic.Clients.Elasticsearch.QueryDsl.FieldLookup? IndexedShape { get; set; } /// - /// Spatial relation operator used to search a geo field. + /// + /// Spatial relation operator used to search a geo field. + /// /// [JsonInclude, JsonPropertyName("relation")] public Elastic.Clients.Elasticsearch.GeoShapeRelation? Relation { get; set; } @@ -59,7 +63,9 @@ public GeoShapeFieldQueryDescriptor() : base() private object? ShapeValue { get; set; } /// - /// Query using an indexed shape retrieved from the the specified document and path. + /// + /// Query using an indexed shape retrieved from the the specified document and path. + /// /// public GeoShapeFieldQueryDescriptor IndexedShape(Elastic.Clients.Elasticsearch.QueryDsl.FieldLookup? indexedShape) { @@ -86,7 +92,9 @@ public GeoShapeFieldQueryDescriptor IndexedShape(Action - /// Spatial relation operator used to search a geo field. + /// + /// Spatial relation operator used to search a geo field. + /// /// public GeoShapeFieldQueryDescriptor Relation(Elastic.Clients.Elasticsearch.GeoShapeRelation? relation) { @@ -150,7 +158,9 @@ public GeoShapeFieldQueryDescriptor() : base() private object? ShapeValue { get; set; } /// - /// Query using an indexed shape retrieved from the the specified document and path. + /// + /// Query using an indexed shape retrieved from the the specified document and path. + /// /// public GeoShapeFieldQueryDescriptor IndexedShape(Elastic.Clients.Elasticsearch.QueryDsl.FieldLookup? indexedShape) { @@ -177,7 +187,9 @@ public GeoShapeFieldQueryDescriptor IndexedShape(Action - /// Spatial relation operator used to search a geo field. + /// + /// Spatial relation operator used to search a geo field. + /// /// public GeoShapeFieldQueryDescriptor Relation(Elastic.Clients.Elasticsearch.GeoShapeRelation? relation) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoShapeQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoShapeQuery.g.cs index 6923111330c..ec6e5429145 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoShapeQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoShapeQuery.g.cs @@ -107,13 +107,21 @@ public override void Write(Utf8JsonWriter writer, GeoShapeQuery value, JsonSeria public sealed partial class GeoShapeQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Set to `true` to ignore an unmapped field and not match any documents for this query.
Set to `false` to throw an exception if the field is not mapped. + /// + /// Set to true to ignore an unmapped field and not match any documents for this query. + /// Set to false to throw an exception if the field is not mapped. + /// /// public bool? IgnoreUnmapped { get; set; } public string? QueryName { get; set; } @@ -139,7 +147,12 @@ public GeoShapeQueryDescriptor() : base() private Action> ShapeDescriptorAction { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public GeoShapeQueryDescriptor Boost(float? boost) { @@ -166,7 +179,10 @@ public GeoShapeQueryDescriptor Field(Expression - /// Set to `true` to ignore an unmapped field and not match any documents for this query.
Set to `false` to throw an exception if the field is not mapped. + /// + /// Set to true to ignore an unmapped field and not match any documents for this query. + /// Set to false to throw an exception if the field is not mapped. + /// /// public GeoShapeQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { @@ -253,7 +269,12 @@ public GeoShapeQueryDescriptor() : base() private Action ShapeDescriptorAction { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public GeoShapeQueryDescriptor Boost(float? boost) { @@ -280,7 +301,10 @@ public GeoShapeQueryDescriptor Field(Expression - /// Set to `true` to ignore an unmapped field and not match any documents for this query.
Set to `false` to throw an exception if the field is not mapped. + /// + /// Set to true to ignore an unmapped field and not match any documents for this query. + /// Set to false to throw an exception if the field is not mapped. + /// /// public GeoShapeQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/HasChildQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/HasChildQuery.g.cs index a426f03fde5..4402b2d7c9c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/HasChildQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/HasChildQuery.g.cs @@ -30,37 +30,55 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class HasChildQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. + /// + /// Indicates whether to ignore an unmapped type and not return any documents instead of an error. + /// /// [JsonInclude, JsonPropertyName("ignore_unmapped")] public bool? IgnoreUnmapped { get; set; } /// - /// If defined, each search hit will contain inner hits. + /// + /// If defined, each search hit will contain inner hits. + /// /// [JsonInclude, JsonPropertyName("inner_hits")] public Elastic.Clients.Elasticsearch.Core.Search.InnerHits? InnerHits { get; set; } /// - /// Maximum number of child documents that match the query allowed for a returned parent document.
If the parent document exceeds this limit, it is excluded from the search results. + /// + /// Maximum number of child documents that match the query allowed for a returned parent document. + /// If the parent document exceeds this limit, it is excluded from the search results. + /// /// [JsonInclude, JsonPropertyName("max_children")] public int? MaxChildren { get; set; } /// - /// Minimum number of child documents that match the query required to match the query for a returned parent document.
If the parent document does not meet this limit, it is excluded from the search results. + /// + /// Minimum number of child documents that match the query required to match the query for a returned parent document. + /// If the parent document does not meet this limit, it is excluded from the search results. + /// /// [JsonInclude, JsonPropertyName("min_children")] public int? MinChildren { get; set; } /// - /// Query you wish to run on child documents of the `type` field.
If a child document matches the search, the query returns the parent document. + /// + /// Query you wish to run on child documents of the type field. + /// If a child document matches the search, the query returns the parent document. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query Query { get; set; } @@ -68,13 +86,17 @@ public sealed partial class HasChildQuery public string? QueryName { get; set; } /// - /// Indicates how scores for matching child documents affect the root parent document’s relevance score. + /// + /// Indicates how scores for matching child documents affect the root parent document’s relevance score. + /// /// [JsonInclude, JsonPropertyName("score_mode")] public Elastic.Clients.Elasticsearch.QueryDsl.ChildScoreMode? ScoreMode { get; set; } /// - /// Name of the child relationship mapped for the `join` field. + /// + /// Name of the child relationship mapped for the join field. + /// /// [JsonInclude, JsonPropertyName("type")] public string Type { get; set; } @@ -105,7 +127,12 @@ public HasChildQueryDescriptor() : base() private string TypeValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public HasChildQueryDescriptor Boost(float? boost) { @@ -114,7 +141,9 @@ public HasChildQueryDescriptor Boost(float? boost) } /// - /// Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. + /// + /// Indicates whether to ignore an unmapped type and not return any documents instead of an error. + /// /// public HasChildQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { @@ -123,7 +152,9 @@ public HasChildQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = } /// - /// If defined, each search hit will contain inner hits. + /// + /// If defined, each search hit will contain inner hits. + /// /// public HasChildQueryDescriptor InnerHits(Elastic.Clients.Elasticsearch.Core.Search.InnerHits? innerHits) { @@ -150,7 +181,10 @@ public HasChildQueryDescriptor InnerHits(Action - /// Maximum number of child documents that match the query allowed for a returned parent document.
If the parent document exceeds this limit, it is excluded from the search results. + /// + /// Maximum number of child documents that match the query allowed for a returned parent document. + /// If the parent document exceeds this limit, it is excluded from the search results. + /// /// public HasChildQueryDescriptor MaxChildren(int? maxChildren) { @@ -159,7 +193,10 @@ public HasChildQueryDescriptor MaxChildren(int? maxChildren) } /// - /// Minimum number of child documents that match the query required to match the query for a returned parent document.
If the parent document does not meet this limit, it is excluded from the search results. + /// + /// Minimum number of child documents that match the query required to match the query for a returned parent document. + /// If the parent document does not meet this limit, it is excluded from the search results. + /// /// public HasChildQueryDescriptor MinChildren(int? minChildren) { @@ -168,7 +205,10 @@ public HasChildQueryDescriptor MinChildren(int? minChildren) } /// - /// Query you wish to run on child documents of the `type` field.
If a child document matches the search, the query returns the parent document. + /// + /// Query you wish to run on child documents of the type field. + /// If a child document matches the search, the query returns the parent document. + /// /// public HasChildQueryDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query query) { @@ -201,7 +241,9 @@ public HasChildQueryDescriptor QueryName(string? queryName) } /// - /// Indicates how scores for matching child documents affect the root parent document’s relevance score. + /// + /// Indicates how scores for matching child documents affect the root parent document’s relevance score. + /// /// public HasChildQueryDescriptor ScoreMode(Elastic.Clients.Elasticsearch.QueryDsl.ChildScoreMode? scoreMode) { @@ -210,7 +252,9 @@ public HasChildQueryDescriptor ScoreMode(Elastic.Clients.Elasticsearc } /// - /// Name of the child relationship mapped for the `join` field. + /// + /// Name of the child relationship mapped for the join field. + /// /// public HasChildQueryDescriptor Type(string type) { @@ -318,7 +362,12 @@ public HasChildQueryDescriptor() : base() private string TypeValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public HasChildQueryDescriptor Boost(float? boost) { @@ -327,7 +376,9 @@ public HasChildQueryDescriptor Boost(float? boost) } /// - /// Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. + /// + /// Indicates whether to ignore an unmapped type and not return any documents instead of an error. + /// /// public HasChildQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { @@ -336,7 +387,9 @@ public HasChildQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) } /// - /// If defined, each search hit will contain inner hits. + /// + /// If defined, each search hit will contain inner hits. + /// /// public HasChildQueryDescriptor InnerHits(Elastic.Clients.Elasticsearch.Core.Search.InnerHits? innerHits) { @@ -363,7 +416,10 @@ public HasChildQueryDescriptor InnerHits(Action - /// Maximum number of child documents that match the query allowed for a returned parent document.
If the parent document exceeds this limit, it is excluded from the search results. + /// + /// Maximum number of child documents that match the query allowed for a returned parent document. + /// If the parent document exceeds this limit, it is excluded from the search results. + /// /// public HasChildQueryDescriptor MaxChildren(int? maxChildren) { @@ -372,7 +428,10 @@ public HasChildQueryDescriptor MaxChildren(int? maxChildren) } /// - /// Minimum number of child documents that match the query required to match the query for a returned parent document.
If the parent document does not meet this limit, it is excluded from the search results. + /// + /// Minimum number of child documents that match the query required to match the query for a returned parent document. + /// If the parent document does not meet this limit, it is excluded from the search results. + /// /// public HasChildQueryDescriptor MinChildren(int? minChildren) { @@ -381,7 +440,10 @@ public HasChildQueryDescriptor MinChildren(int? minChildren) } /// - /// Query you wish to run on child documents of the `type` field.
If a child document matches the search, the query returns the parent document. + /// + /// Query you wish to run on child documents of the type field. + /// If a child document matches the search, the query returns the parent document. + /// /// public HasChildQueryDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query query) { @@ -414,7 +476,9 @@ public HasChildQueryDescriptor QueryName(string? queryName) } /// - /// Indicates how scores for matching child documents affect the root parent document’s relevance score. + /// + /// Indicates how scores for matching child documents affect the root parent document’s relevance score. + /// /// public HasChildQueryDescriptor ScoreMode(Elastic.Clients.Elasticsearch.QueryDsl.ChildScoreMode? scoreMode) { @@ -423,7 +487,9 @@ public HasChildQueryDescriptor ScoreMode(Elastic.Clients.Elasticsearch.QueryDsl. } /// - /// Name of the child relationship mapped for the `join` field. + /// + /// Name of the child relationship mapped for the join field. + /// /// public HasChildQueryDescriptor Type(string type) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/HasParentQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/HasParentQuery.g.cs index 303edbfab81..a7ef01711c0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/HasParentQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/HasParentQuery.g.cs @@ -30,31 +30,46 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class HasParentQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Indicates whether to ignore an unmapped `parent_type` and not return any documents instead of an error.
You can use this parameter to query multiple indices that may not contain the `parent_type`. + /// + /// Indicates whether to ignore an unmapped parent_type and not return any documents instead of an error. + /// You can use this parameter to query multiple indices that may not contain the parent_type. + /// /// [JsonInclude, JsonPropertyName("ignore_unmapped")] public bool? IgnoreUnmapped { get; set; } /// - /// If defined, each search hit will contain inner hits. + /// + /// If defined, each search hit will contain inner hits. + /// /// [JsonInclude, JsonPropertyName("inner_hits")] public Elastic.Clients.Elasticsearch.Core.Search.InnerHits? InnerHits { get; set; } /// - /// Name of the parent relationship mapped for the `join` field. + /// + /// Name of the parent relationship mapped for the join field. + /// /// [JsonInclude, JsonPropertyName("parent_type")] public string ParentType { get; set; } /// - /// Query you wish to run on parent documents of the `parent_type` field.
If a parent document matches the search, the query returns its child documents. + /// + /// Query you wish to run on parent documents of the parent_type field. + /// If a parent document matches the search, the query returns its child documents. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query Query { get; set; } @@ -62,7 +77,9 @@ public sealed partial class HasParentQuery public string? QueryName { get; set; } /// - /// Indicates whether the relevance score of a matching parent document is aggregated into its child documents. + /// + /// Indicates whether the relevance score of a matching parent document is aggregated into its child documents. + /// /// [JsonInclude, JsonPropertyName("score")] public bool? Score { get; set; } @@ -91,7 +108,12 @@ public HasParentQueryDescriptor() : base() private bool? ScoreValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public HasParentQueryDescriptor Boost(float? boost) { @@ -100,7 +122,10 @@ public HasParentQueryDescriptor Boost(float? boost) } /// - /// Indicates whether to ignore an unmapped `parent_type` and not return any documents instead of an error.
You can use this parameter to query multiple indices that may not contain the `parent_type`. + /// + /// Indicates whether to ignore an unmapped parent_type and not return any documents instead of an error. + /// You can use this parameter to query multiple indices that may not contain the parent_type. + /// /// public HasParentQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { @@ -109,7 +134,9 @@ public HasParentQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = } /// - /// If defined, each search hit will contain inner hits. + /// + /// If defined, each search hit will contain inner hits. + /// /// public HasParentQueryDescriptor InnerHits(Elastic.Clients.Elasticsearch.Core.Search.InnerHits? innerHits) { @@ -136,7 +163,9 @@ public HasParentQueryDescriptor InnerHits(Action - /// Name of the parent relationship mapped for the `join` field. + /// + /// Name of the parent relationship mapped for the join field. + /// /// public HasParentQueryDescriptor ParentType(string parentType) { @@ -145,7 +174,10 @@ public HasParentQueryDescriptor ParentType(string parentType) } /// - /// Query you wish to run on parent documents of the `parent_type` field.
If a parent document matches the search, the query returns its child documents. + /// + /// Query you wish to run on parent documents of the parent_type field. + /// If a parent document matches the search, the query returns its child documents. + /// /// public HasParentQueryDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query query) { @@ -178,7 +210,9 @@ public HasParentQueryDescriptor QueryName(string? queryName) } /// - /// Indicates whether the relevance score of a matching parent document is aggregated into its child documents. + /// + /// Indicates whether the relevance score of a matching parent document is aggregated into its child documents. + /// /// public HasParentQueryDescriptor Score(bool? score = true) { @@ -272,7 +306,12 @@ public HasParentQueryDescriptor() : base() private bool? ScoreValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public HasParentQueryDescriptor Boost(float? boost) { @@ -281,7 +320,10 @@ public HasParentQueryDescriptor Boost(float? boost) } /// - /// Indicates whether to ignore an unmapped `parent_type` and not return any documents instead of an error.
You can use this parameter to query multiple indices that may not contain the `parent_type`. + /// + /// Indicates whether to ignore an unmapped parent_type and not return any documents instead of an error. + /// You can use this parameter to query multiple indices that may not contain the parent_type. + /// /// public HasParentQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { @@ -290,7 +332,9 @@ public HasParentQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) } /// - /// If defined, each search hit will contain inner hits. + /// + /// If defined, each search hit will contain inner hits. + /// /// public HasParentQueryDescriptor InnerHits(Elastic.Clients.Elasticsearch.Core.Search.InnerHits? innerHits) { @@ -317,7 +361,9 @@ public HasParentQueryDescriptor InnerHits(Action - /// Name of the parent relationship mapped for the `join` field. + /// + /// Name of the parent relationship mapped for the join field. + /// /// public HasParentQueryDescriptor ParentType(string parentType) { @@ -326,7 +372,10 @@ public HasParentQueryDescriptor ParentType(string parentType) } /// - /// Query you wish to run on parent documents of the `parent_type` field.
If a parent document matches the search, the query returns its child documents. + /// + /// Query you wish to run on parent documents of the parent_type field. + /// If a parent document matches the search, the query returns its child documents. + /// /// public HasParentQueryDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query query) { @@ -359,7 +408,9 @@ public HasParentQueryDescriptor QueryName(string? queryName) } /// - /// Indicates whether the relevance score of a matching parent document is aggregated into its child documents. + /// + /// Indicates whether the relevance score of a matching parent document is aggregated into its child documents. + /// /// public HasParentQueryDescriptor Score(bool? score = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IdsQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IdsQuery.g.cs index ebf4235e555..2750b276048 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IdsQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IdsQuery.g.cs @@ -30,7 +30,12 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class IdsQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } @@ -38,7 +43,9 @@ public sealed partial class IdsQuery public string? QueryName { get; set; } /// - /// An array of document IDs. + /// + /// An array of document IDs. + /// /// [JsonInclude, JsonPropertyName("values")] public Elastic.Clients.Elasticsearch.Ids? Values { get; set; } @@ -59,7 +66,12 @@ public IdsQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Ids? ValuesValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public IdsQueryDescriptor Boost(float? boost) { @@ -74,7 +86,9 @@ public IdsQueryDescriptor QueryName(string? queryName) } /// - /// An array of document IDs. + /// + /// An array of document IDs. + /// /// public IdsQueryDescriptor Values(Elastic.Clients.Elasticsearch.Ids? values) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsAllOf.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsAllOf.g.cs index 0e9df82b831..b23b4fe152a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsAllOf.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsAllOf.g.cs @@ -30,25 +30,34 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class IntervalsAllOf { /// - /// Rule used to filter returned intervals. + /// + /// Rule used to filter returned intervals. + /// /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.QueryDsl.IntervalsFilter? Filter { get; set; } /// - /// An array of rules to combine. All rules must produce a match in a document for the overall source to match. + /// + /// An array of rules to combine. All rules must produce a match in a document for the overall source to match. + /// /// [JsonInclude, JsonPropertyName("intervals")] public ICollection Intervals { get; set; } /// - /// Maximum number of positions between the matching terms.
Intervals produced by the rules further apart than this are not considered matches. + /// + /// Maximum number of positions between the matching terms. + /// Intervals produced by the rules further apart than this are not considered matches. + /// /// [JsonInclude, JsonPropertyName("max_gaps")] public int? MaxGaps { get; set; } /// - /// If `true`, intervals produced by the rules should appear in the order in which they are specified. + /// + /// If true, intervals produced by the rules should appear in the order in which they are specified. + /// /// [JsonInclude, JsonPropertyName("ordered")] public bool? Ordered { get; set; } @@ -76,7 +85,9 @@ public IntervalsAllOfDescriptor() : base() private bool? OrderedValue { get; set; } /// - /// Rule used to filter returned intervals. + /// + /// Rule used to filter returned intervals. + /// /// public IntervalsAllOfDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.IntervalsFilter? filter) { @@ -103,7 +114,9 @@ public IntervalsAllOfDescriptor Filter(Action - /// An array of rules to combine. All rules must produce a match in a document for the overall source to match. + /// + /// An array of rules to combine. All rules must produce a match in a document for the overall source to match. + /// /// public IntervalsAllOfDescriptor Intervals(ICollection intervals) { @@ -142,7 +155,10 @@ public IntervalsAllOfDescriptor Intervals(params Action - /// Maximum number of positions between the matching terms.
Intervals produced by the rules further apart than this are not considered matches. + /// + /// Maximum number of positions between the matching terms. + /// Intervals produced by the rules further apart than this are not considered matches. + /// /// public IntervalsAllOfDescriptor MaxGaps(int? maxGaps) { @@ -151,7 +167,9 @@ public IntervalsAllOfDescriptor MaxGaps(int? maxGaps) } /// - /// If `true`, intervals produced by the rules should appear in the order in which they are specified. + /// + /// If true, intervals produced by the rules should appear in the order in which they are specified. + /// /// public IntervalsAllOfDescriptor Ordered(bool? ordered = true) { @@ -244,7 +262,9 @@ public IntervalsAllOfDescriptor() : base() private bool? OrderedValue { get; set; } /// - /// Rule used to filter returned intervals. + /// + /// Rule used to filter returned intervals. + /// /// public IntervalsAllOfDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.IntervalsFilter? filter) { @@ -271,7 +291,9 @@ public IntervalsAllOfDescriptor Filter(Action - /// An array of rules to combine. All rules must produce a match in a document for the overall source to match. + /// + /// An array of rules to combine. All rules must produce a match in a document for the overall source to match. + /// /// public IntervalsAllOfDescriptor Intervals(ICollection intervals) { @@ -310,7 +332,10 @@ public IntervalsAllOfDescriptor Intervals(params Action - /// Maximum number of positions between the matching terms.
Intervals produced by the rules further apart than this are not considered matches. + /// + /// Maximum number of positions between the matching terms. + /// Intervals produced by the rules further apart than this are not considered matches. + /// /// public IntervalsAllOfDescriptor MaxGaps(int? maxGaps) { @@ -319,7 +344,9 @@ public IntervalsAllOfDescriptor MaxGaps(int? maxGaps) } /// - /// If `true`, intervals produced by the rules should appear in the order in which they are specified. + /// + /// If true, intervals produced by the rules should appear in the order in which they are specified. + /// /// public IntervalsAllOfDescriptor Ordered(bool? ordered = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsAnyOf.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsAnyOf.g.cs index f2ffde78570..3507d232dac 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsAnyOf.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsAnyOf.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class IntervalsAnyOf { /// - /// Rule used to filter returned intervals. + /// + /// Rule used to filter returned intervals. + /// /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.QueryDsl.IntervalsFilter? Filter { get; set; } /// - /// An array of rules to match. + /// + /// An array of rules to match. + /// /// [JsonInclude, JsonPropertyName("intervals")] public ICollection Intervals { get; set; } @@ -62,7 +66,9 @@ public IntervalsAnyOfDescriptor() : base() private Action>[] IntervalsDescriptorActions { get; set; } /// - /// Rule used to filter returned intervals. + /// + /// Rule used to filter returned intervals. + /// /// public IntervalsAnyOfDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.IntervalsFilter? filter) { @@ -89,7 +95,9 @@ public IntervalsAnyOfDescriptor Filter(Action - /// An array of rules to match. + /// + /// An array of rules to match. + /// /// public IntervalsAnyOfDescriptor Intervals(ICollection intervals) { @@ -198,7 +206,9 @@ public IntervalsAnyOfDescriptor() : base() private Action[] IntervalsDescriptorActions { get; set; } /// - /// Rule used to filter returned intervals. + /// + /// Rule used to filter returned intervals. + /// /// public IntervalsAnyOfDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.IntervalsFilter? filter) { @@ -225,7 +235,9 @@ public IntervalsAnyOfDescriptor Filter(Action - /// An array of rules to match. + /// + /// An array of rules to match. + /// /// public IntervalsAnyOfDescriptor Intervals(ICollection intervals) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsFuzzy.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsFuzzy.g.cs index 647253b4e60..d89f5c56adf 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsFuzzy.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsFuzzy.g.cs @@ -30,37 +30,50 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class IntervalsFuzzy { /// - /// Analyzer used to normalize the term. + /// + /// Analyzer used to normalize the term. + /// /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } /// - /// Maximum edit distance allowed for matching. + /// + /// Maximum edit distance allowed for matching. + /// /// [JsonInclude, JsonPropertyName("fuzziness")] public Elastic.Clients.Elasticsearch.Fuzziness? Fuzziness { get; set; } /// - /// Number of beginning characters left unchanged when creating expansions. + /// + /// Number of beginning characters left unchanged when creating expansions. + /// /// [JsonInclude, JsonPropertyName("prefix_length")] public int? PrefixLength { get; set; } /// - /// The term to match. + /// + /// The term to match. + /// /// [JsonInclude, JsonPropertyName("term")] public string Term { get; set; } /// - /// Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// + /// Indicates whether edits include transpositions of two adjacent characters (for example, ab to ba). + /// /// [JsonInclude, JsonPropertyName("transpositions")] public bool? Transpositions { get; set; } /// - /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The term is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// [JsonInclude, JsonPropertyName("use_field")] public Elastic.Clients.Elasticsearch.Field? UseField { get; set; } @@ -85,7 +98,9 @@ public IntervalsFuzzyDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? UseFieldValue { get; set; } /// - /// Analyzer used to normalize the term. + /// + /// Analyzer used to normalize the term. + /// /// public IntervalsFuzzyDescriptor Analyzer(string? analyzer) { @@ -94,7 +109,9 @@ public IntervalsFuzzyDescriptor Analyzer(string? analyzer) } /// - /// Maximum edit distance allowed for matching. + /// + /// Maximum edit distance allowed for matching. + /// /// public IntervalsFuzzyDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzziness? fuzziness) { @@ -103,7 +120,9 @@ public IntervalsFuzzyDescriptor Fuzziness(Elastic.Clients.Elasticsear } /// - /// Number of beginning characters left unchanged when creating expansions. + /// + /// Number of beginning characters left unchanged when creating expansions. + /// /// public IntervalsFuzzyDescriptor PrefixLength(int? prefixLength) { @@ -112,7 +131,9 @@ public IntervalsFuzzyDescriptor PrefixLength(int? prefixLength) } /// - /// The term to match. + /// + /// The term to match. + /// /// public IntervalsFuzzyDescriptor Term(string term) { @@ -121,7 +142,9 @@ public IntervalsFuzzyDescriptor Term(string term) } /// - /// Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// + /// Indicates whether edits include transpositions of two adjacent characters (for example, ab to ba). + /// /// public IntervalsFuzzyDescriptor Transpositions(bool? transpositions = true) { @@ -130,7 +153,10 @@ public IntervalsFuzzyDescriptor Transpositions(bool? transpositions = } /// - /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The term is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsFuzzyDescriptor UseField(Elastic.Clients.Elasticsearch.Field? useField) { @@ -139,7 +165,10 @@ public IntervalsFuzzyDescriptor UseField(Elastic.Clients.Elasticsearc } /// - /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The term is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsFuzzyDescriptor UseField(Expression> useField) { @@ -148,7 +177,10 @@ public IntervalsFuzzyDescriptor UseField(Expression - /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The term is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsFuzzyDescriptor UseField(Expression> useField) { @@ -211,7 +243,9 @@ public IntervalsFuzzyDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? UseFieldValue { get; set; } /// - /// Analyzer used to normalize the term. + /// + /// Analyzer used to normalize the term. + /// /// public IntervalsFuzzyDescriptor Analyzer(string? analyzer) { @@ -220,7 +254,9 @@ public IntervalsFuzzyDescriptor Analyzer(string? analyzer) } /// - /// Maximum edit distance allowed for matching. + /// + /// Maximum edit distance allowed for matching. + /// /// public IntervalsFuzzyDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzziness? fuzziness) { @@ -229,7 +265,9 @@ public IntervalsFuzzyDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzzines } /// - /// Number of beginning characters left unchanged when creating expansions. + /// + /// Number of beginning characters left unchanged when creating expansions. + /// /// public IntervalsFuzzyDescriptor PrefixLength(int? prefixLength) { @@ -238,7 +276,9 @@ public IntervalsFuzzyDescriptor PrefixLength(int? prefixLength) } /// - /// The term to match. + /// + /// The term to match. + /// /// public IntervalsFuzzyDescriptor Term(string term) { @@ -247,7 +287,9 @@ public IntervalsFuzzyDescriptor Term(string term) } /// - /// Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// + /// Indicates whether edits include transpositions of two adjacent characters (for example, ab to ba). + /// /// public IntervalsFuzzyDescriptor Transpositions(bool? transpositions = true) { @@ -256,7 +298,10 @@ public IntervalsFuzzyDescriptor Transpositions(bool? transpositions = true) } /// - /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The term is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsFuzzyDescriptor UseField(Elastic.Clients.Elasticsearch.Field? useField) { @@ -265,7 +310,10 @@ public IntervalsFuzzyDescriptor UseField(Elastic.Clients.Elasticsearch.Field? us } /// - /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The term is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsFuzzyDescriptor UseField(Expression> useField) { @@ -274,7 +322,10 @@ public IntervalsFuzzyDescriptor UseField(Expression - /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The term is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsFuzzyDescriptor UseField(Expression> useField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsMatch.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsMatch.g.cs index c812a3f1e4f..1303252ac15 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsMatch.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsMatch.g.cs @@ -30,37 +30,51 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class IntervalsMatch { /// - /// Analyzer used to analyze terms in the query. + /// + /// Analyzer used to analyze terms in the query. + /// /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } /// - /// An optional interval filter. + /// + /// An optional interval filter. + /// /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.QueryDsl.IntervalsFilter? Filter { get; set; } /// - /// Maximum number of positions between the matching terms.
Terms further apart than this are not considered matches. + /// + /// Maximum number of positions between the matching terms. + /// Terms further apart than this are not considered matches. + /// /// [JsonInclude, JsonPropertyName("max_gaps")] public int? MaxGaps { get; set; } /// - /// If `true`, matching terms must appear in their specified order. + /// + /// If true, matching terms must appear in their specified order. + /// /// [JsonInclude, JsonPropertyName("ordered")] public bool? Ordered { get; set; } /// - /// Text you wish to find in the provided field. + /// + /// Text you wish to find in the provided field. + /// /// [JsonInclude, JsonPropertyName("query")] public string Query { get; set; } /// - /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The term is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// [JsonInclude, JsonPropertyName("use_field")] public Elastic.Clients.Elasticsearch.Field? UseField { get; set; } @@ -87,7 +101,9 @@ public IntervalsMatchDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? UseFieldValue { get; set; } /// - /// Analyzer used to analyze terms in the query. + /// + /// Analyzer used to analyze terms in the query. + /// /// public IntervalsMatchDescriptor Analyzer(string? analyzer) { @@ -96,7 +112,9 @@ public IntervalsMatchDescriptor Analyzer(string? analyzer) } /// - /// An optional interval filter. + /// + /// An optional interval filter. + /// /// public IntervalsMatchDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.IntervalsFilter? filter) { @@ -123,7 +141,10 @@ public IntervalsMatchDescriptor Filter(Action - /// Maximum number of positions between the matching terms.
Terms further apart than this are not considered matches. + /// + /// Maximum number of positions between the matching terms. + /// Terms further apart than this are not considered matches. + /// /// public IntervalsMatchDescriptor MaxGaps(int? maxGaps) { @@ -132,7 +153,9 @@ public IntervalsMatchDescriptor MaxGaps(int? maxGaps) } /// - /// If `true`, matching terms must appear in their specified order. + /// + /// If true, matching terms must appear in their specified order. + /// /// public IntervalsMatchDescriptor Ordered(bool? ordered = true) { @@ -141,7 +164,9 @@ public IntervalsMatchDescriptor Ordered(bool? ordered = true) } /// - /// Text you wish to find in the provided field. + /// + /// Text you wish to find in the provided field. + /// /// public IntervalsMatchDescriptor Query(string query) { @@ -150,7 +175,10 @@ public IntervalsMatchDescriptor Query(string query) } /// - /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The term is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsMatchDescriptor UseField(Elastic.Clients.Elasticsearch.Field? useField) { @@ -159,7 +187,10 @@ public IntervalsMatchDescriptor UseField(Elastic.Clients.Elasticsearc } /// - /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The term is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsMatchDescriptor UseField(Expression> useField) { @@ -168,7 +199,10 @@ public IntervalsMatchDescriptor UseField(Expression - /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The term is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsMatchDescriptor UseField(Expression> useField) { @@ -243,7 +277,9 @@ public IntervalsMatchDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? UseFieldValue { get; set; } /// - /// Analyzer used to analyze terms in the query. + /// + /// Analyzer used to analyze terms in the query. + /// /// public IntervalsMatchDescriptor Analyzer(string? analyzer) { @@ -252,7 +288,9 @@ public IntervalsMatchDescriptor Analyzer(string? analyzer) } /// - /// An optional interval filter. + /// + /// An optional interval filter. + /// /// public IntervalsMatchDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.IntervalsFilter? filter) { @@ -279,7 +317,10 @@ public IntervalsMatchDescriptor Filter(Action - /// Maximum number of positions between the matching terms.
Terms further apart than this are not considered matches. + /// + /// Maximum number of positions between the matching terms. + /// Terms further apart than this are not considered matches. + /// /// public IntervalsMatchDescriptor MaxGaps(int? maxGaps) { @@ -288,7 +329,9 @@ public IntervalsMatchDescriptor MaxGaps(int? maxGaps) } /// - /// If `true`, matching terms must appear in their specified order. + /// + /// If true, matching terms must appear in their specified order. + /// /// public IntervalsMatchDescriptor Ordered(bool? ordered = true) { @@ -297,7 +340,9 @@ public IntervalsMatchDescriptor Ordered(bool? ordered = true) } /// - /// Text you wish to find in the provided field. + /// + /// Text you wish to find in the provided field. + /// /// public IntervalsMatchDescriptor Query(string query) { @@ -306,7 +351,10 @@ public IntervalsMatchDescriptor Query(string query) } /// - /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The term is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsMatchDescriptor UseField(Elastic.Clients.Elasticsearch.Field? useField) { @@ -315,7 +363,10 @@ public IntervalsMatchDescriptor UseField(Elastic.Clients.Elasticsearch.Field? us } /// - /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The term is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsMatchDescriptor UseField(Expression> useField) { @@ -324,7 +375,10 @@ public IntervalsMatchDescriptor UseField(Expression - /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The term is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsMatchDescriptor UseField(Expression> useField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsPrefix.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsPrefix.g.cs index 1cc18122447..118a55188ec 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsPrefix.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsPrefix.g.cs @@ -30,19 +30,26 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class IntervalsPrefix { /// - /// Analyzer used to analyze the `prefix`. + /// + /// Analyzer used to analyze the prefix. + /// /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } /// - /// Beginning characters of terms you wish to find in the top-level field. + /// + /// Beginning characters of terms you wish to find in the top-level field. + /// /// [JsonInclude, JsonPropertyName("prefix")] public string Prefix { get; set; } /// - /// If specified, match intervals from this field rather than the top-level field.
The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The prefix is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// [JsonInclude, JsonPropertyName("use_field")] public Elastic.Clients.Elasticsearch.Field? UseField { get; set; } @@ -64,7 +71,9 @@ public IntervalsPrefixDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? UseFieldValue { get; set; } /// - /// Analyzer used to analyze the `prefix`. + /// + /// Analyzer used to analyze the prefix. + /// /// public IntervalsPrefixDescriptor Analyzer(string? analyzer) { @@ -73,7 +82,9 @@ public IntervalsPrefixDescriptor Analyzer(string? analyzer) } /// - /// Beginning characters of terms you wish to find in the top-level field. + /// + /// Beginning characters of terms you wish to find in the top-level field. + /// /// public IntervalsPrefixDescriptor Prefix(string prefix) { @@ -82,7 +93,10 @@ public IntervalsPrefixDescriptor Prefix(string prefix) } /// - /// If specified, match intervals from this field rather than the top-level field.
The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The prefix is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsPrefixDescriptor UseField(Elastic.Clients.Elasticsearch.Field? useField) { @@ -91,7 +105,10 @@ public IntervalsPrefixDescriptor UseField(Elastic.Clients.Elasticsear } /// - /// If specified, match intervals from this field rather than the top-level field.
The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The prefix is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsPrefixDescriptor UseField(Expression> useField) { @@ -100,7 +117,10 @@ public IntervalsPrefixDescriptor UseField(Expression - /// If specified, match intervals from this field rather than the top-level field.
The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The prefix is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsPrefixDescriptor UseField(Expression> useField) { @@ -142,7 +162,9 @@ public IntervalsPrefixDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? UseFieldValue { get; set; } /// - /// Analyzer used to analyze the `prefix`. + /// + /// Analyzer used to analyze the prefix. + /// /// public IntervalsPrefixDescriptor Analyzer(string? analyzer) { @@ -151,7 +173,9 @@ public IntervalsPrefixDescriptor Analyzer(string? analyzer) } /// - /// Beginning characters of terms you wish to find in the top-level field. + /// + /// Beginning characters of terms you wish to find in the top-level field. + /// /// public IntervalsPrefixDescriptor Prefix(string prefix) { @@ -160,7 +184,10 @@ public IntervalsPrefixDescriptor Prefix(string prefix) } /// - /// If specified, match intervals from this field rather than the top-level field.
The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The prefix is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsPrefixDescriptor UseField(Elastic.Clients.Elasticsearch.Field? useField) { @@ -169,7 +196,10 @@ public IntervalsPrefixDescriptor UseField(Elastic.Clients.Elasticsearch.Field? u } /// - /// If specified, match intervals from this field rather than the top-level field.
The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The prefix is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsPrefixDescriptor UseField(Expression> useField) { @@ -178,7 +208,10 @@ public IntervalsPrefixDescriptor UseField(Expression - /// If specified, match intervals from this field rather than the top-level field.
The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The prefix is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsPrefixDescriptor UseField(Expression> useField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsQuery.g.cs index 55627c70adc..bf1ea817e74 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsQuery.g.cs @@ -54,7 +54,12 @@ internal IntervalsQuery(string variantName, object variant) public static IntervalsQuery Wildcard(Elastic.Clients.Elasticsearch.QueryDsl.IntervalsWildcard intervalsWildcard) => new IntervalsQuery("wildcard", intervalsWildcard); /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } @@ -259,7 +264,12 @@ private IntervalsQueryDescriptor Set(object variant, string variantNa private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public IntervalsQueryDescriptor Boost(float? boost) { @@ -377,7 +387,12 @@ private IntervalsQueryDescriptor Set(object variant, string variantName) private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public IntervalsQueryDescriptor Boost(float? boost) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsWildcard.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsWildcard.g.cs index 1426a036f2c..aab99b10389 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsWildcard.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsWildcard.g.cs @@ -30,19 +30,27 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class IntervalsWildcard { /// - /// Analyzer used to analyze the `pattern`.
Defaults to the top-level field's analyzer. + /// + /// Analyzer used to analyze the pattern. + /// Defaults to the top-level field's analyzer. + /// /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } /// - /// Wildcard pattern used to find matching terms. + /// + /// Wildcard pattern used to find matching terms. + /// /// [JsonInclude, JsonPropertyName("pattern")] public string Pattern { get; set; } /// - /// If specified, match intervals from this field rather than the top-level field.
The `pattern` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The pattern is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// [JsonInclude, JsonPropertyName("use_field")] public Elastic.Clients.Elasticsearch.Field? UseField { get; set; } @@ -64,7 +72,10 @@ public IntervalsWildcardDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? UseFieldValue { get; set; } /// - /// Analyzer used to analyze the `pattern`.
Defaults to the top-level field's analyzer. + /// + /// Analyzer used to analyze the pattern. + /// Defaults to the top-level field's analyzer. + /// /// public IntervalsWildcardDescriptor Analyzer(string? analyzer) { @@ -73,7 +84,9 @@ public IntervalsWildcardDescriptor Analyzer(string? analyzer) } /// - /// Wildcard pattern used to find matching terms. + /// + /// Wildcard pattern used to find matching terms. + /// /// public IntervalsWildcardDescriptor Pattern(string pattern) { @@ -82,7 +95,10 @@ public IntervalsWildcardDescriptor Pattern(string pattern) } /// - /// If specified, match intervals from this field rather than the top-level field.
The `pattern` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The pattern is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsWildcardDescriptor UseField(Elastic.Clients.Elasticsearch.Field? useField) { @@ -91,7 +107,10 @@ public IntervalsWildcardDescriptor UseField(Elastic.Clients.Elasticse } /// - /// If specified, match intervals from this field rather than the top-level field.
The `pattern` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The pattern is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsWildcardDescriptor UseField(Expression> useField) { @@ -100,7 +119,10 @@ public IntervalsWildcardDescriptor UseField(Expression - /// If specified, match intervals from this field rather than the top-level field.
The `pattern` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The pattern is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsWildcardDescriptor UseField(Expression> useField) { @@ -142,7 +164,10 @@ public IntervalsWildcardDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? UseFieldValue { get; set; } /// - /// Analyzer used to analyze the `pattern`.
Defaults to the top-level field's analyzer. + /// + /// Analyzer used to analyze the pattern. + /// Defaults to the top-level field's analyzer. + /// /// public IntervalsWildcardDescriptor Analyzer(string? analyzer) { @@ -151,7 +176,9 @@ public IntervalsWildcardDescriptor Analyzer(string? analyzer) } /// - /// Wildcard pattern used to find matching terms. + /// + /// Wildcard pattern used to find matching terms. + /// /// public IntervalsWildcardDescriptor Pattern(string pattern) { @@ -160,7 +187,10 @@ public IntervalsWildcardDescriptor Pattern(string pattern) } /// - /// If specified, match intervals from this field rather than the top-level field.
The `pattern` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The pattern is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsWildcardDescriptor UseField(Elastic.Clients.Elasticsearch.Field? useField) { @@ -169,7 +199,10 @@ public IntervalsWildcardDescriptor UseField(Elastic.Clients.Elasticsearch.Field? } /// - /// If specified, match intervals from this field rather than the top-level field.
The `pattern` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The pattern is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsWildcardDescriptor UseField(Expression> useField) { @@ -178,7 +211,10 @@ public IntervalsWildcardDescriptor UseField(Expression - /// If specified, match intervals from this field rather than the top-level field.
The `pattern` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// + /// If specified, match intervals from this field rather than the top-level field. + /// The pattern is normalized using the search analyzer from this field, unless analyzer is specified separately. + /// /// public IntervalsWildcardDescriptor UseField(Expression> useField) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/Like.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/Like.g.cs index deb118d02d0..05bde5e6950 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/Like.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/Like.g.cs @@ -31,7 +31,9 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; /// -/// Text that we want similar documents for or a lookup to a document's field for the text. +/// +/// Text that we want similar documents for or a lookup to a document's field for the text. +/// /// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class Like : Union diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/LikeDocument.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/LikeDocument.g.cs index 935866319d6..181ce211247 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/LikeDocument.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/LikeDocument.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class LikeDocument { /// - /// A document not present in the index. + /// + /// A document not present in the index. + /// /// [JsonInclude, JsonPropertyName("doc")] public object? Doc { get; set; } @@ -39,19 +41,25 @@ public sealed partial class LikeDocument public Elastic.Clients.Elasticsearch.Fields? Fields { get; set; } /// - /// ID of a document. + /// + /// ID of a document. + /// /// [JsonInclude, JsonPropertyName("_id")] public Elastic.Clients.Elasticsearch.Id? Id { get; set; } /// - /// Index of a document. + /// + /// Index of a document. + /// /// [JsonInclude, JsonPropertyName("_index")] public Elastic.Clients.Elasticsearch.IndexName? Index { get; set; } /// - /// Overrides the default analyzer. + /// + /// Overrides the default analyzer. + /// /// [JsonInclude, JsonPropertyName("per_field_analyzer")] public IDictionary? PerFieldAnalyzer { get; set; } @@ -81,7 +89,9 @@ public LikeDocumentDescriptor() : base() private Elastic.Clients.Elasticsearch.VersionType? VersionTypeValue { get; set; } /// - /// A document not present in the index. + /// + /// A document not present in the index. + /// /// public LikeDocumentDescriptor Doc(object? doc) { @@ -96,7 +106,9 @@ public LikeDocumentDescriptor Fields(Elastic.Clients.Elasticsearch.Fi } /// - /// ID of a document. + /// + /// ID of a document. + /// /// public LikeDocumentDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) { @@ -105,7 +117,9 @@ public LikeDocumentDescriptor Id(Elastic.Clients.Elasticsearch.Id? id } /// - /// Index of a document. + /// + /// Index of a document. + /// /// public LikeDocumentDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? index) { @@ -114,7 +128,9 @@ public LikeDocumentDescriptor Index(Elastic.Clients.Elasticsearch.Ind } /// - /// Overrides the default analyzer. + /// + /// Overrides the default analyzer. + /// /// public LikeDocumentDescriptor PerFieldAnalyzer(Func, FluentDictionary> selector) { @@ -213,7 +229,9 @@ public LikeDocumentDescriptor() : base() private Elastic.Clients.Elasticsearch.VersionType? VersionTypeValue { get; set; } /// - /// A document not present in the index. + /// + /// A document not present in the index. + /// /// public LikeDocumentDescriptor Doc(object? doc) { @@ -228,7 +246,9 @@ public LikeDocumentDescriptor Fields(Elastic.Clients.Elasticsearch.Fields? field } /// - /// ID of a document. + /// + /// ID of a document. + /// /// public LikeDocumentDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) { @@ -237,7 +257,9 @@ public LikeDocumentDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) } /// - /// Index of a document. + /// + /// Index of a document. + /// /// public LikeDocumentDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? index) { @@ -246,7 +268,9 @@ public LikeDocumentDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? ind } /// - /// Overrides the default analyzer. + /// + /// Overrides the default analyzer. + /// /// public LikeDocumentDescriptor PerFieldAnalyzer(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchAllQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchAllQuery.g.cs index a8974a0b226..d5aa761e15d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchAllQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchAllQuery.g.cs @@ -30,7 +30,12 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class MatchAllQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } @@ -52,7 +57,12 @@ public MatchAllQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public MatchAllQueryDescriptor Boost(float? boost) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchBoolPrefixQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchBoolPrefixQuery.g.cs index 21550b2de21..4d56cdd27b8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchBoolPrefixQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchBoolPrefixQuery.g.cs @@ -201,53 +201,84 @@ public MatchBoolPrefixQuery(Elastic.Clients.Elasticsearch.Field field) } /// - /// Analyzer used to convert the text in the query value into tokens. + /// + /// Analyzer used to convert the text in the query value into tokens. + /// /// public string? Analyzer { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Maximum edit distance allowed for matching.
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// Maximum edit distance allowed for matching. + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public Elastic.Clients.Elasticsearch.Fuzziness? Fuzziness { get; set; } /// - /// Method used to rewrite the query.
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// Method used to rewrite the query. + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public string? FuzzyRewrite { get; set; } /// - /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public bool? FuzzyTranspositions { get; set; } /// - /// Maximum number of terms to which the query will expand.
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// Maximum number of terms to which the query will expand. + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public int? MaxExpansions { get; set; } /// - /// Minimum number of clauses that must match for a document to be returned.
Applied to the constructed bool query. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// Applied to the constructed bool query. + /// /// public Elastic.Clients.Elasticsearch.MinimumShouldMatch? MinimumShouldMatch { get; set; } /// - /// Boolean logic used to interpret text in the query value.
Applied to the constructed bool query. + /// + /// Boolean logic used to interpret text in the query value. + /// Applied to the constructed bool query. + /// /// public Elastic.Clients.Elasticsearch.QueryDsl.Operator? Operator { get; set; } /// - /// Number of beginning characters left unchanged for fuzzy matching.
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public int? PrefixLength { get; set; } /// - /// Terms you wish to find in the provided field.
The last term is used in a prefix query. + /// + /// Terms you wish to find in the provided field. + /// The last term is used in a prefix query. + /// /// public string Query { get; set; } public string? QueryName { get; set; } @@ -277,7 +308,9 @@ public MatchBoolPrefixQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Analyzer used to convert the text in the query value into tokens. + /// + /// Analyzer used to convert the text in the query value into tokens. + /// /// public MatchBoolPrefixQueryDescriptor Analyzer(string? analyzer) { @@ -286,7 +319,12 @@ public MatchBoolPrefixQueryDescriptor Analyzer(string? analyzer) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public MatchBoolPrefixQueryDescriptor Boost(float? boost) { @@ -313,7 +351,10 @@ public MatchBoolPrefixQueryDescriptor Field(Expression - /// Maximum edit distance allowed for matching.
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// Maximum edit distance allowed for matching. + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public MatchBoolPrefixQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzziness? fuzziness) { @@ -322,7 +363,10 @@ public MatchBoolPrefixQueryDescriptor Fuzziness(Elastic.Clients.Elast } /// - /// Method used to rewrite the query.
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// Method used to rewrite the query. + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public MatchBoolPrefixQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) { @@ -331,7 +375,10 @@ public MatchBoolPrefixQueryDescriptor FuzzyRewrite(string? fuzzyRewri } /// - /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public MatchBoolPrefixQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true) { @@ -340,7 +387,10 @@ public MatchBoolPrefixQueryDescriptor FuzzyTranspositions(bool? fuzzy } /// - /// Maximum number of terms to which the query will expand.
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// Maximum number of terms to which the query will expand. + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public MatchBoolPrefixQueryDescriptor MaxExpansions(int? maxExpansions) { @@ -349,7 +399,10 @@ public MatchBoolPrefixQueryDescriptor MaxExpansions(int? maxExpansion } /// - /// Minimum number of clauses that must match for a document to be returned.
Applied to the constructed bool query. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// Applied to the constructed bool query. + /// /// public MatchBoolPrefixQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { @@ -358,7 +411,10 @@ public MatchBoolPrefixQueryDescriptor MinimumShouldMatch(Elastic.Clie } /// - /// Boolean logic used to interpret text in the query value.
Applied to the constructed bool query. + /// + /// Boolean logic used to interpret text in the query value. + /// Applied to the constructed bool query. + /// /// public MatchBoolPrefixQueryDescriptor Operator(Elastic.Clients.Elasticsearch.QueryDsl.Operator? value) { @@ -367,7 +423,10 @@ public MatchBoolPrefixQueryDescriptor Operator(Elastic.Clients.Elasti } /// - /// Number of beginning characters left unchanged for fuzzy matching.
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public MatchBoolPrefixQueryDescriptor PrefixLength(int? prefixLength) { @@ -376,7 +435,10 @@ public MatchBoolPrefixQueryDescriptor PrefixLength(int? prefixLength) } /// - /// Terms you wish to find in the provided field.
The last term is used in a prefix query. + /// + /// Terms you wish to find in the provided field. + /// The last term is used in a prefix query. + /// /// public MatchBoolPrefixQueryDescriptor Query(string query) { @@ -486,7 +548,9 @@ public MatchBoolPrefixQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Analyzer used to convert the text in the query value into tokens. + /// + /// Analyzer used to convert the text in the query value into tokens. + /// /// public MatchBoolPrefixQueryDescriptor Analyzer(string? analyzer) { @@ -495,7 +559,12 @@ public MatchBoolPrefixQueryDescriptor Analyzer(string? analyzer) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public MatchBoolPrefixQueryDescriptor Boost(float? boost) { @@ -522,7 +591,10 @@ public MatchBoolPrefixQueryDescriptor Field(Expression - /// Maximum edit distance allowed for matching.
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// Maximum edit distance allowed for matching. + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public MatchBoolPrefixQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzziness? fuzziness) { @@ -531,7 +603,10 @@ public MatchBoolPrefixQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fu } /// - /// Method used to rewrite the query.
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// Method used to rewrite the query. + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public MatchBoolPrefixQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) { @@ -540,7 +615,10 @@ public MatchBoolPrefixQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) } /// - /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public MatchBoolPrefixQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true) { @@ -549,7 +627,10 @@ public MatchBoolPrefixQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositi } /// - /// Maximum number of terms to which the query will expand.
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// Maximum number of terms to which the query will expand. + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public MatchBoolPrefixQueryDescriptor MaxExpansions(int? maxExpansions) { @@ -558,7 +639,10 @@ public MatchBoolPrefixQueryDescriptor MaxExpansions(int? maxExpansions) } /// - /// Minimum number of clauses that must match for a document to be returned.
Applied to the constructed bool query. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// Applied to the constructed bool query. + /// /// public MatchBoolPrefixQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { @@ -567,7 +651,10 @@ public MatchBoolPrefixQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elastic } /// - /// Boolean logic used to interpret text in the query value.
Applied to the constructed bool query. + /// + /// Boolean logic used to interpret text in the query value. + /// Applied to the constructed bool query. + /// /// public MatchBoolPrefixQueryDescriptor Operator(Elastic.Clients.Elasticsearch.QueryDsl.Operator? value) { @@ -576,7 +663,10 @@ public MatchBoolPrefixQueryDescriptor Operator(Elastic.Clients.Elasticsearch.Que } /// - /// Number of beginning characters left unchanged for fuzzy matching.
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public MatchBoolPrefixQueryDescriptor PrefixLength(int? prefixLength) { @@ -585,7 +675,10 @@ public MatchBoolPrefixQueryDescriptor PrefixLength(int? prefixLength) } /// - /// Terms you wish to find in the provided field.
The last term is used in a prefix query. + /// + /// Terms you wish to find in the provided field. + /// The last term is used in a prefix query. + /// /// public MatchBoolPrefixQueryDescriptor Query(string query) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchNoneQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchNoneQuery.g.cs index 693a06f70b3..df46a139f4c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchNoneQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchNoneQuery.g.cs @@ -30,7 +30,12 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class MatchNoneQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } @@ -52,7 +57,12 @@ public MatchNoneQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public MatchNoneQueryDescriptor Boost(float? boost) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchPhrasePrefixQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchPhrasePrefixQuery.g.cs index b84011f6afd..3a1f22002b6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchPhrasePrefixQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchPhrasePrefixQuery.g.cs @@ -153,34 +153,49 @@ public MatchPhrasePrefixQuery(Elastic.Clients.Elasticsearch.Field field) } /// - /// Analyzer used to convert text in the query value into tokens. + /// + /// Analyzer used to convert text in the query value into tokens. + /// /// public string? Analyzer { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Maximum number of terms to which the last provided term of the query value will expand. + /// + /// Maximum number of terms to which the last provided term of the query value will expand. + /// /// public int? MaxExpansions { get; set; } /// - /// Text you wish to find in the provided field. + /// + /// Text you wish to find in the provided field. + /// /// public string Query { get; set; } public string? QueryName { get; set; } /// - /// Maximum number of positions allowed between matching tokens. + /// + /// Maximum number of positions allowed between matching tokens. + /// /// public int? Slop { get; set; } /// - /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter. + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter. + /// /// public Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? ZeroTermsQuery { get; set; } @@ -205,7 +220,9 @@ public MatchPhrasePrefixQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? ZeroTermsQueryValue { get; set; } /// - /// Analyzer used to convert text in the query value into tokens. + /// + /// Analyzer used to convert text in the query value into tokens. + /// /// public MatchPhrasePrefixQueryDescriptor Analyzer(string? analyzer) { @@ -214,7 +231,12 @@ public MatchPhrasePrefixQueryDescriptor Analyzer(string? analyzer) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public MatchPhrasePrefixQueryDescriptor Boost(float? boost) { @@ -241,7 +263,9 @@ public MatchPhrasePrefixQueryDescriptor Field(Expression - /// Maximum number of terms to which the last provided term of the query value will expand. + /// + /// Maximum number of terms to which the last provided term of the query value will expand. + /// /// public MatchPhrasePrefixQueryDescriptor MaxExpansions(int? maxExpansions) { @@ -250,7 +274,9 @@ public MatchPhrasePrefixQueryDescriptor MaxExpansions(int? maxExpansi } /// - /// Text you wish to find in the provided field. + /// + /// Text you wish to find in the provided field. + /// /// public MatchPhrasePrefixQueryDescriptor Query(string query) { @@ -265,7 +291,9 @@ public MatchPhrasePrefixQueryDescriptor QueryName(string? queryName) } /// - /// Maximum number of positions allowed between matching tokens. + /// + /// Maximum number of positions allowed between matching tokens. + /// /// public MatchPhrasePrefixQueryDescriptor Slop(int? slop) { @@ -274,7 +302,9 @@ public MatchPhrasePrefixQueryDescriptor Slop(int? slop) } /// - /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter. + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter. + /// /// public MatchPhrasePrefixQueryDescriptor ZeroTermsQuery(Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? zeroTermsQuery) { @@ -350,7 +380,9 @@ public MatchPhrasePrefixQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? ZeroTermsQueryValue { get; set; } /// - /// Analyzer used to convert text in the query value into tokens. + /// + /// Analyzer used to convert text in the query value into tokens. + /// /// public MatchPhrasePrefixQueryDescriptor Analyzer(string? analyzer) { @@ -359,7 +391,12 @@ public MatchPhrasePrefixQueryDescriptor Analyzer(string? analyzer) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public MatchPhrasePrefixQueryDescriptor Boost(float? boost) { @@ -386,7 +423,9 @@ public MatchPhrasePrefixQueryDescriptor Field(Expression - /// Maximum number of terms to which the last provided term of the query value will expand. + /// + /// Maximum number of terms to which the last provided term of the query value will expand. + /// /// public MatchPhrasePrefixQueryDescriptor MaxExpansions(int? maxExpansions) { @@ -395,7 +434,9 @@ public MatchPhrasePrefixQueryDescriptor MaxExpansions(int? maxExpansions) } /// - /// Text you wish to find in the provided field. + /// + /// Text you wish to find in the provided field. + /// /// public MatchPhrasePrefixQueryDescriptor Query(string query) { @@ -410,7 +451,9 @@ public MatchPhrasePrefixQueryDescriptor QueryName(string? queryName) } /// - /// Maximum number of positions allowed between matching tokens. + /// + /// Maximum number of positions allowed between matching tokens. + /// /// public MatchPhrasePrefixQueryDescriptor Slop(int? slop) { @@ -419,7 +462,9 @@ public MatchPhrasePrefixQueryDescriptor Slop(int? slop) } /// - /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter. + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter. + /// /// public MatchPhrasePrefixQueryDescriptor ZeroTermsQuery(Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? zeroTermsQuery) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchPhraseQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchPhraseQuery.g.cs index 3632479eb15..ff6632c7399 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchPhraseQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchPhraseQuery.g.cs @@ -141,29 +141,42 @@ public MatchPhraseQuery(Elastic.Clients.Elasticsearch.Field field) } /// - /// Analyzer used to convert the text in the query value into tokens. + /// + /// Analyzer used to convert the text in the query value into tokens. + /// /// public string? Analyzer { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Query terms that are analyzed and turned into a phrase query. + /// + /// Query terms that are analyzed and turned into a phrase query. + /// /// public string Query { get; set; } public string? QueryName { get; set; } /// - /// Maximum number of positions allowed between matching tokens. + /// + /// Maximum number of positions allowed between matching tokens. + /// /// public int? Slop { get; set; } /// - /// Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter. + /// /// public Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? ZeroTermsQuery { get; set; } @@ -187,7 +200,9 @@ public MatchPhraseQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? ZeroTermsQueryValue { get; set; } /// - /// Analyzer used to convert the text in the query value into tokens. + /// + /// Analyzer used to convert the text in the query value into tokens. + /// /// public MatchPhraseQueryDescriptor Analyzer(string? analyzer) { @@ -196,7 +211,12 @@ public MatchPhraseQueryDescriptor Analyzer(string? analyzer) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public MatchPhraseQueryDescriptor Boost(float? boost) { @@ -223,7 +243,9 @@ public MatchPhraseQueryDescriptor Field(Expression - /// Query terms that are analyzed and turned into a phrase query. + /// + /// Query terms that are analyzed and turned into a phrase query. + /// /// public MatchPhraseQueryDescriptor Query(string query) { @@ -238,7 +260,9 @@ public MatchPhraseQueryDescriptor QueryName(string? queryName) } /// - /// Maximum number of positions allowed between matching tokens. + /// + /// Maximum number of positions allowed between matching tokens. + /// /// public MatchPhraseQueryDescriptor Slop(int? slop) { @@ -247,7 +271,9 @@ public MatchPhraseQueryDescriptor Slop(int? slop) } /// - /// Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter. + /// /// public MatchPhraseQueryDescriptor ZeroTermsQuery(Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? zeroTermsQuery) { @@ -316,7 +342,9 @@ public MatchPhraseQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? ZeroTermsQueryValue { get; set; } /// - /// Analyzer used to convert the text in the query value into tokens. + /// + /// Analyzer used to convert the text in the query value into tokens. + /// /// public MatchPhraseQueryDescriptor Analyzer(string? analyzer) { @@ -325,7 +353,12 @@ public MatchPhraseQueryDescriptor Analyzer(string? analyzer) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public MatchPhraseQueryDescriptor Boost(float? boost) { @@ -352,7 +385,9 @@ public MatchPhraseQueryDescriptor Field(Expression - /// Query terms that are analyzed and turned into a phrase query. + /// + /// Query terms that are analyzed and turned into a phrase query. + /// /// public MatchPhraseQueryDescriptor Query(string query) { @@ -367,7 +402,9 @@ public MatchPhraseQueryDescriptor QueryName(string? queryName) } /// - /// Maximum number of positions allowed between matching tokens. + /// + /// Maximum number of positions allowed between matching tokens. + /// /// public MatchPhraseQueryDescriptor Slop(int? slop) { @@ -376,7 +413,9 @@ public MatchPhraseQueryDescriptor Slop(int? slop) } /// - /// Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter. + /// /// public MatchPhraseQueryDescriptor ZeroTermsQuery(Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? zeroTermsQuery) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchQuery.g.cs index 5ccecdf76f8..6f79abe2a2a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchQuery.g.cs @@ -237,69 +237,98 @@ public MatchQuery(Elastic.Clients.Elasticsearch.Field field) } /// - /// Analyzer used to convert the text in the query value into tokens. + /// + /// Analyzer used to convert the text in the query value into tokens. + /// /// public string? Analyzer { get; set; } /// - /// If `true`, match phrase queries are automatically created for multi-term synonyms. + /// + /// If true, match phrase queries are automatically created for multi-term synonyms. + /// /// public bool? AutoGenerateSynonymsPhraseQuery { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Maximum edit distance allowed for matching. + /// + /// Maximum edit distance allowed for matching. + /// /// public Elastic.Clients.Elasticsearch.Fuzziness? Fuzziness { get; set; } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public string? FuzzyRewrite { get; set; } /// - /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// + /// If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). + /// /// public bool? FuzzyTranspositions { get; set; } /// - /// If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. + /// + /// If true, format-based errors, such as providing a text query value for a numeric field, are ignored. + /// /// public bool? Lenient { get; set; } /// - /// Maximum number of terms to which the query will expand. + /// + /// Maximum number of terms to which the query will expand. + /// /// public int? MaxExpansions { get; set; } /// - /// Minimum number of clauses that must match for a document to be returned. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// /// public Elastic.Clients.Elasticsearch.MinimumShouldMatch? MinimumShouldMatch { get; set; } /// - /// Boolean logic used to interpret text in the query value. + /// + /// Boolean logic used to interpret text in the query value. + /// /// public Elastic.Clients.Elasticsearch.QueryDsl.Operator? Operator { get; set; } /// - /// Number of beginning characters left unchanged for fuzzy matching. + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// /// public int? PrefixLength { get; set; } /// - /// Text, number, boolean value or date you wish to find in the provided field. + /// + /// Text, number, boolean value or date you wish to find in the provided field. + /// /// public object Query { get; set; } public string? QueryName { get; set; } /// - /// Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter. + /// /// public Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? ZeroTermsQuery { get; set; } @@ -331,7 +360,9 @@ public MatchQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? ZeroTermsQueryValue { get; set; } /// - /// Analyzer used to convert the text in the query value into tokens. + /// + /// Analyzer used to convert the text in the query value into tokens. + /// /// public MatchQueryDescriptor Analyzer(string? analyzer) { @@ -340,7 +371,9 @@ public MatchQueryDescriptor Analyzer(string? analyzer) } /// - /// If `true`, match phrase queries are automatically created for multi-term synonyms. + /// + /// If true, match phrase queries are automatically created for multi-term synonyms. + /// /// public MatchQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSynonymsPhraseQuery = true) { @@ -349,7 +382,12 @@ public MatchQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? aut } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public MatchQueryDescriptor Boost(float? boost) { @@ -376,7 +414,9 @@ public MatchQueryDescriptor Field(Expression> } /// - /// Maximum edit distance allowed for matching. + /// + /// Maximum edit distance allowed for matching. + /// /// public MatchQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzziness? fuzziness) { @@ -385,7 +425,9 @@ public MatchQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.F } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public MatchQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) { @@ -394,7 +436,9 @@ public MatchQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) } /// - /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// + /// If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). + /// /// public MatchQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true) { @@ -403,7 +447,9 @@ public MatchQueryDescriptor FuzzyTranspositions(bool? fuzzyTransposit } /// - /// If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. + /// + /// If true, format-based errors, such as providing a text query value for a numeric field, are ignored. + /// /// public MatchQueryDescriptor Lenient(bool? lenient = true) { @@ -412,7 +458,9 @@ public MatchQueryDescriptor Lenient(bool? lenient = true) } /// - /// Maximum number of terms to which the query will expand. + /// + /// Maximum number of terms to which the query will expand. + /// /// public MatchQueryDescriptor MaxExpansions(int? maxExpansions) { @@ -421,7 +469,9 @@ public MatchQueryDescriptor MaxExpansions(int? maxExpansions) } /// - /// Minimum number of clauses that must match for a document to be returned. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// /// public MatchQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { @@ -430,7 +480,9 @@ public MatchQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasti } /// - /// Boolean logic used to interpret text in the query value. + /// + /// Boolean logic used to interpret text in the query value. + /// /// public MatchQueryDescriptor Operator(Elastic.Clients.Elasticsearch.QueryDsl.Operator? value) { @@ -439,7 +491,9 @@ public MatchQueryDescriptor Operator(Elastic.Clients.Elasticsearch.Qu } /// - /// Number of beginning characters left unchanged for fuzzy matching. + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// /// public MatchQueryDescriptor PrefixLength(int? prefixLength) { @@ -448,7 +502,9 @@ public MatchQueryDescriptor PrefixLength(int? prefixLength) } /// - /// Text, number, boolean value or date you wish to find in the provided field. + /// + /// Text, number, boolean value or date you wish to find in the provided field. + /// /// public MatchQueryDescriptor Query(object query) { @@ -463,7 +519,9 @@ public MatchQueryDescriptor QueryName(string? queryName) } /// - /// Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter. + /// /// public MatchQueryDescriptor ZeroTermsQuery(Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? zeroTermsQuery) { @@ -588,7 +646,9 @@ public MatchQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? ZeroTermsQueryValue { get; set; } /// - /// Analyzer used to convert the text in the query value into tokens. + /// + /// Analyzer used to convert the text in the query value into tokens. + /// /// public MatchQueryDescriptor Analyzer(string? analyzer) { @@ -597,7 +657,9 @@ public MatchQueryDescriptor Analyzer(string? analyzer) } /// - /// If `true`, match phrase queries are automatically created for multi-term synonyms. + /// + /// If true, match phrase queries are automatically created for multi-term synonyms. + /// /// public MatchQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSynonymsPhraseQuery = true) { @@ -606,7 +668,12 @@ public MatchQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSy } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public MatchQueryDescriptor Boost(float? boost) { @@ -633,7 +700,9 @@ public MatchQueryDescriptor Field(Expression> } /// - /// Maximum edit distance allowed for matching. + /// + /// Maximum edit distance allowed for matching. + /// /// public MatchQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzziness? fuzziness) { @@ -642,7 +711,9 @@ public MatchQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzziness? f } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public MatchQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) { @@ -651,7 +722,9 @@ public MatchQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) } /// - /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// + /// If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). + /// /// public MatchQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true) { @@ -660,7 +733,9 @@ public MatchQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true } /// - /// If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. + /// + /// If true, format-based errors, such as providing a text query value for a numeric field, are ignored. + /// /// public MatchQueryDescriptor Lenient(bool? lenient = true) { @@ -669,7 +744,9 @@ public MatchQueryDescriptor Lenient(bool? lenient = true) } /// - /// Maximum number of terms to which the query will expand. + /// + /// Maximum number of terms to which the query will expand. + /// /// public MatchQueryDescriptor MaxExpansions(int? maxExpansions) { @@ -678,7 +755,9 @@ public MatchQueryDescriptor MaxExpansions(int? maxExpansions) } /// - /// Minimum number of clauses that must match for a document to be returned. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// /// public MatchQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { @@ -687,7 +766,9 @@ public MatchQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.Min } /// - /// Boolean logic used to interpret text in the query value. + /// + /// Boolean logic used to interpret text in the query value. + /// /// public MatchQueryDescriptor Operator(Elastic.Clients.Elasticsearch.QueryDsl.Operator? value) { @@ -696,7 +777,9 @@ public MatchQueryDescriptor Operator(Elastic.Clients.Elasticsearch.QueryDsl.Oper } /// - /// Number of beginning characters left unchanged for fuzzy matching. + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// /// public MatchQueryDescriptor PrefixLength(int? prefixLength) { @@ -705,7 +788,9 @@ public MatchQueryDescriptor PrefixLength(int? prefixLength) } /// - /// Text, number, boolean value or date you wish to find in the provided field. + /// + /// Text, number, boolean value or date you wish to find in the provided field. + /// /// public MatchQueryDescriptor Query(object query) { @@ -720,7 +805,9 @@ public MatchQueryDescriptor QueryName(string? queryName) } /// - /// Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter. + /// /// public MatchQueryDescriptor ZeroTermsQuery(Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? zeroTermsQuery) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MoreLikeThisQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MoreLikeThisQuery.g.cs index 972fa3f37b8..30e777edcfb 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MoreLikeThisQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MoreLikeThisQuery.g.cs @@ -30,87 +30,123 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class MoreLikeThisQuery { /// - /// The analyzer that is used to analyze the free form text.
Defaults to the analyzer associated with the first field in fields. + /// + /// The analyzer that is used to analyze the free form text. + /// Defaults to the analyzer associated with the first field in fields. + /// /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Each term in the formed query could be further boosted by their tf-idf score.
This sets the boost factor to use when using this feature.
Defaults to deactivated (0). + /// + /// Each term in the formed query could be further boosted by their tf-idf score. + /// This sets the boost factor to use when using this feature. + /// Defaults to deactivated (0). + /// /// [JsonInclude, JsonPropertyName("boost_terms")] public double? BoostTerms { get; set; } /// - /// Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (`text` or `keyword`). + /// + /// Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (text or keyword). + /// /// [JsonInclude, JsonPropertyName("fail_on_unsupported_field")] public bool? FailOnUnsupportedField { get; set; } /// - /// A list of fields to fetch and analyze the text from.
Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + /// + /// A list of fields to fetch and analyze the text from. + /// Defaults to the index.query.default_field index setting, which has a default value of *. + /// /// [JsonInclude, JsonPropertyName("fields")] [JsonConverter(typeof(FieldsConverter))] public Elastic.Clients.Elasticsearch.Fields? Fields { get; set; } /// - /// Specifies whether the input documents should also be included in the search results returned. + /// + /// Specifies whether the input documents should also be included in the search results returned. + /// /// [JsonInclude, JsonPropertyName("include")] public bool? Include { get; set; } /// - /// Specifies free form text and/or a single or multiple documents for which you want to find similar documents. + /// + /// Specifies free form text and/or a single or multiple documents for which you want to find similar documents. + /// /// [JsonInclude, JsonPropertyName("like")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.QueryDsl.Like))] public ICollection Like { get; set; } /// - /// The maximum document frequency above which the terms are ignored from the input document. + /// + /// The maximum document frequency above which the terms are ignored from the input document. + /// /// [JsonInclude, JsonPropertyName("max_doc_freq")] public int? MaxDocFreq { get; set; } /// - /// The maximum number of query terms that can be selected. + /// + /// The maximum number of query terms that can be selected. + /// /// [JsonInclude, JsonPropertyName("max_query_terms")] public int? MaxQueryTerms { get; set; } /// - /// The maximum word length above which the terms are ignored.
Defaults to unbounded (`0`). + /// + /// The maximum word length above which the terms are ignored. + /// Defaults to unbounded (0). + /// /// [JsonInclude, JsonPropertyName("max_word_length")] public int? MaxWordLength { get; set; } /// - /// The minimum document frequency below which the terms are ignored from the input document. + /// + /// The minimum document frequency below which the terms are ignored from the input document. + /// /// [JsonInclude, JsonPropertyName("min_doc_freq")] public int? MinDocFreq { get; set; } /// - /// After the disjunctive query has been formed, this parameter controls the number of terms that must match. + /// + /// After the disjunctive query has been formed, this parameter controls the number of terms that must match. + /// /// [JsonInclude, JsonPropertyName("minimum_should_match")] public Elastic.Clients.Elasticsearch.MinimumShouldMatch? MinimumShouldMatch { get; set; } /// - /// The minimum term frequency below which the terms are ignored from the input document. + /// + /// The minimum term frequency below which the terms are ignored from the input document. + /// /// [JsonInclude, JsonPropertyName("min_term_freq")] public int? MinTermFreq { get; set; } /// - /// The minimum word length below which the terms are ignored. + /// + /// The minimum word length below which the terms are ignored. + /// /// [JsonInclude, JsonPropertyName("min_word_length")] public int? MinWordLength { get; set; } @@ -120,14 +156,19 @@ public sealed partial class MoreLikeThisQuery public Elastic.Clients.Elasticsearch.Routing? Routing { get; set; } /// - /// An array of stop words.
Any word in this set is ignored. + /// + /// An array of stop words. + /// Any word in this set is ignored. + /// /// [JsonInclude, JsonPropertyName("stop_words")] [SingleOrManyCollectionConverter(typeof(string))] public ICollection? StopWords { get; set; } /// - /// Used in combination with `like` to exclude documents that match a set of terms. + /// + /// Used in combination with like to exclude documents that match a set of terms. + /// /// [JsonInclude, JsonPropertyName("unlike")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.QueryDsl.Like))] @@ -170,7 +211,10 @@ public MoreLikeThisQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.VersionType? VersionTypeValue { get; set; } /// - /// The analyzer that is used to analyze the free form text.
Defaults to the analyzer associated with the first field in fields. + /// + /// The analyzer that is used to analyze the free form text. + /// Defaults to the analyzer associated with the first field in fields. + /// /// public MoreLikeThisQueryDescriptor Analyzer(string? analyzer) { @@ -179,7 +223,12 @@ public MoreLikeThisQueryDescriptor Analyzer(string? analyzer) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public MoreLikeThisQueryDescriptor Boost(float? boost) { @@ -188,7 +237,11 @@ public MoreLikeThisQueryDescriptor Boost(float? boost) } /// - /// Each term in the formed query could be further boosted by their tf-idf score.
This sets the boost factor to use when using this feature.
Defaults to deactivated (0). + /// + /// Each term in the formed query could be further boosted by their tf-idf score. + /// This sets the boost factor to use when using this feature. + /// Defaults to deactivated (0). + /// /// public MoreLikeThisQueryDescriptor BoostTerms(double? boostTerms) { @@ -197,7 +250,9 @@ public MoreLikeThisQueryDescriptor BoostTerms(double? boostTerms) } /// - /// Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (`text` or `keyword`). + /// + /// Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (text or keyword). + /// /// public MoreLikeThisQueryDescriptor FailOnUnsupportedField(bool? failOnUnsupportedField = true) { @@ -206,7 +261,10 @@ public MoreLikeThisQueryDescriptor FailOnUnsupportedField(bool? failO } /// - /// A list of fields to fetch and analyze the text from.
Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + /// + /// A list of fields to fetch and analyze the text from. + /// Defaults to the index.query.default_field index setting, which has a default value of *. + /// /// public MoreLikeThisQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Fields? fields) { @@ -215,7 +273,9 @@ public MoreLikeThisQueryDescriptor Fields(Elastic.Clients.Elasticsear } /// - /// Specifies whether the input documents should also be included in the search results returned. + /// + /// Specifies whether the input documents should also be included in the search results returned. + /// /// public MoreLikeThisQueryDescriptor Include(bool? include = true) { @@ -224,7 +284,9 @@ public MoreLikeThisQueryDescriptor Include(bool? include = true) } /// - /// Specifies free form text and/or a single or multiple documents for which you want to find similar documents. + /// + /// Specifies free form text and/or a single or multiple documents for which you want to find similar documents. + /// /// public MoreLikeThisQueryDescriptor Like(ICollection like) { @@ -233,7 +295,9 @@ public MoreLikeThisQueryDescriptor Like(ICollection - /// The maximum document frequency above which the terms are ignored from the input document. + /// + /// The maximum document frequency above which the terms are ignored from the input document. + /// /// public MoreLikeThisQueryDescriptor MaxDocFreq(int? maxDocFreq) { @@ -242,7 +306,9 @@ public MoreLikeThisQueryDescriptor MaxDocFreq(int? maxDocFreq) } /// - /// The maximum number of query terms that can be selected. + /// + /// The maximum number of query terms that can be selected. + /// /// public MoreLikeThisQueryDescriptor MaxQueryTerms(int? maxQueryTerms) { @@ -251,7 +317,10 @@ public MoreLikeThisQueryDescriptor MaxQueryTerms(int? maxQueryTerms) } /// - /// The maximum word length above which the terms are ignored.
Defaults to unbounded (`0`). + /// + /// The maximum word length above which the terms are ignored. + /// Defaults to unbounded (0). + /// /// public MoreLikeThisQueryDescriptor MaxWordLength(int? maxWordLength) { @@ -260,7 +329,9 @@ public MoreLikeThisQueryDescriptor MaxWordLength(int? maxWordLength) } /// - /// The minimum document frequency below which the terms are ignored from the input document. + /// + /// The minimum document frequency below which the terms are ignored from the input document. + /// /// public MoreLikeThisQueryDescriptor MinDocFreq(int? minDocFreq) { @@ -269,7 +340,9 @@ public MoreLikeThisQueryDescriptor MinDocFreq(int? minDocFreq) } /// - /// After the disjunctive query has been formed, this parameter controls the number of terms that must match. + /// + /// After the disjunctive query has been formed, this parameter controls the number of terms that must match. + /// /// public MoreLikeThisQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { @@ -278,7 +351,9 @@ public MoreLikeThisQueryDescriptor MinimumShouldMatch(Elastic.Clients } /// - /// The minimum term frequency below which the terms are ignored from the input document. + /// + /// The minimum term frequency below which the terms are ignored from the input document. + /// /// public MoreLikeThisQueryDescriptor MinTermFreq(int? minTermFreq) { @@ -287,7 +362,9 @@ public MoreLikeThisQueryDescriptor MinTermFreq(int? minTermFreq) } /// - /// The minimum word length below which the terms are ignored. + /// + /// The minimum word length below which the terms are ignored. + /// /// public MoreLikeThisQueryDescriptor MinWordLength(int? minWordLength) { @@ -308,7 +385,10 @@ public MoreLikeThisQueryDescriptor Routing(Elastic.Clients.Elasticsea } /// - /// An array of stop words.
Any word in this set is ignored. + /// + /// An array of stop words. + /// Any word in this set is ignored. + /// /// public MoreLikeThisQueryDescriptor StopWords(ICollection? stopWords) { @@ -317,7 +397,9 @@ public MoreLikeThisQueryDescriptor StopWords(ICollection? sto } /// - /// Used in combination with `like` to exclude documents that match a set of terms. + /// + /// Used in combination with like to exclude documents that match a set of terms. + /// /// public MoreLikeThisQueryDescriptor Unlike(ICollection? unlike) { @@ -490,7 +572,10 @@ public MoreLikeThisQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.VersionType? VersionTypeValue { get; set; } /// - /// The analyzer that is used to analyze the free form text.
Defaults to the analyzer associated with the first field in fields. + /// + /// The analyzer that is used to analyze the free form text. + /// Defaults to the analyzer associated with the first field in fields. + /// /// public MoreLikeThisQueryDescriptor Analyzer(string? analyzer) { @@ -499,7 +584,12 @@ public MoreLikeThisQueryDescriptor Analyzer(string? analyzer) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public MoreLikeThisQueryDescriptor Boost(float? boost) { @@ -508,7 +598,11 @@ public MoreLikeThisQueryDescriptor Boost(float? boost) } /// - /// Each term in the formed query could be further boosted by their tf-idf score.
This sets the boost factor to use when using this feature.
Defaults to deactivated (0). + /// + /// Each term in the formed query could be further boosted by their tf-idf score. + /// This sets the boost factor to use when using this feature. + /// Defaults to deactivated (0). + /// /// public MoreLikeThisQueryDescriptor BoostTerms(double? boostTerms) { @@ -517,7 +611,9 @@ public MoreLikeThisQueryDescriptor BoostTerms(double? boostTerms) } /// - /// Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (`text` or `keyword`). + /// + /// Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (text or keyword). + /// /// public MoreLikeThisQueryDescriptor FailOnUnsupportedField(bool? failOnUnsupportedField = true) { @@ -526,7 +622,10 @@ public MoreLikeThisQueryDescriptor FailOnUnsupportedField(bool? failOnUnsupporte } /// - /// A list of fields to fetch and analyze the text from.
Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + /// + /// A list of fields to fetch and analyze the text from. + /// Defaults to the index.query.default_field index setting, which has a default value of *. + /// /// public MoreLikeThisQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Fields? fields) { @@ -535,7 +634,9 @@ public MoreLikeThisQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Fields? } /// - /// Specifies whether the input documents should also be included in the search results returned. + /// + /// Specifies whether the input documents should also be included in the search results returned. + /// /// public MoreLikeThisQueryDescriptor Include(bool? include = true) { @@ -544,7 +645,9 @@ public MoreLikeThisQueryDescriptor Include(bool? include = true) } /// - /// Specifies free form text and/or a single or multiple documents for which you want to find similar documents. + /// + /// Specifies free form text and/or a single or multiple documents for which you want to find similar documents. + /// /// public MoreLikeThisQueryDescriptor Like(ICollection like) { @@ -553,7 +656,9 @@ public MoreLikeThisQueryDescriptor Like(ICollection - /// The maximum document frequency above which the terms are ignored from the input document. + /// + /// The maximum document frequency above which the terms are ignored from the input document. + /// /// public MoreLikeThisQueryDescriptor MaxDocFreq(int? maxDocFreq) { @@ -562,7 +667,9 @@ public MoreLikeThisQueryDescriptor MaxDocFreq(int? maxDocFreq) } /// - /// The maximum number of query terms that can be selected. + /// + /// The maximum number of query terms that can be selected. + /// /// public MoreLikeThisQueryDescriptor MaxQueryTerms(int? maxQueryTerms) { @@ -571,7 +678,10 @@ public MoreLikeThisQueryDescriptor MaxQueryTerms(int? maxQueryTerms) } /// - /// The maximum word length above which the terms are ignored.
Defaults to unbounded (`0`). + /// + /// The maximum word length above which the terms are ignored. + /// Defaults to unbounded (0). + /// /// public MoreLikeThisQueryDescriptor MaxWordLength(int? maxWordLength) { @@ -580,7 +690,9 @@ public MoreLikeThisQueryDescriptor MaxWordLength(int? maxWordLength) } /// - /// The minimum document frequency below which the terms are ignored from the input document. + /// + /// The minimum document frequency below which the terms are ignored from the input document. + /// /// public MoreLikeThisQueryDescriptor MinDocFreq(int? minDocFreq) { @@ -589,7 +701,9 @@ public MoreLikeThisQueryDescriptor MinDocFreq(int? minDocFreq) } /// - /// After the disjunctive query has been formed, this parameter controls the number of terms that must match. + /// + /// After the disjunctive query has been formed, this parameter controls the number of terms that must match. + /// /// public MoreLikeThisQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { @@ -598,7 +712,9 @@ public MoreLikeThisQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsea } /// - /// The minimum term frequency below which the terms are ignored from the input document. + /// + /// The minimum term frequency below which the terms are ignored from the input document. + /// /// public MoreLikeThisQueryDescriptor MinTermFreq(int? minTermFreq) { @@ -607,7 +723,9 @@ public MoreLikeThisQueryDescriptor MinTermFreq(int? minTermFreq) } /// - /// The minimum word length below which the terms are ignored. + /// + /// The minimum word length below which the terms are ignored. + /// /// public MoreLikeThisQueryDescriptor MinWordLength(int? minWordLength) { @@ -628,7 +746,10 @@ public MoreLikeThisQueryDescriptor Routing(Elastic.Clients.Elasticsearch.Routing } /// - /// An array of stop words.
Any word in this set is ignored. + /// + /// An array of stop words. + /// Any word in this set is ignored. + /// /// public MoreLikeThisQueryDescriptor StopWords(ICollection? stopWords) { @@ -637,7 +758,9 @@ public MoreLikeThisQueryDescriptor StopWords(ICollection? stopWords) } /// - /// Used in combination with `like` to exclude documents that match a set of terms. + /// + /// Used in combination with like to exclude documents that match a set of terms. + /// /// public MoreLikeThisQueryDescriptor Unlike(ICollection? unlike) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MultiMatchQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MultiMatchQuery.g.cs index d16ab8d4aac..8a01d0b1f4c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MultiMatchQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MultiMatchQuery.g.cs @@ -30,80 +30,111 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class MultiMatchQuery { /// - /// Analyzer used to convert the text in the query value into tokens. + /// + /// Analyzer used to convert the text in the query value into tokens. + /// /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } /// - /// If `true`, match phrase queries are automatically created for multi-term synonyms. + /// + /// If true, match phrase queries are automatically created for multi-term synonyms. + /// /// [JsonInclude, JsonPropertyName("auto_generate_synonyms_phrase_query")] public bool? AutoGenerateSynonymsPhraseQuery { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// The fields to be queried.
Defaults to the `index.query.default_field` index settings, which in turn defaults to `*`. + /// + /// The fields to be queried. + /// Defaults to the index.query.default_field index settings, which in turn defaults to *. + /// /// [JsonInclude, JsonPropertyName("fields")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] public Elastic.Clients.Elasticsearch.Fields? Fields { get; set; } /// - /// Maximum edit distance allowed for matching. + /// + /// Maximum edit distance allowed for matching. + /// /// [JsonInclude, JsonPropertyName("fuzziness")] public Elastic.Clients.Elasticsearch.Fuzziness? Fuzziness { get; set; } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// [JsonInclude, JsonPropertyName("fuzzy_rewrite")] public string? FuzzyRewrite { get; set; } /// - /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// [JsonInclude, JsonPropertyName("fuzzy_transpositions")] public bool? FuzzyTranspositions { get; set; } /// - /// If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. + /// + /// If true, format-based errors, such as providing a text query value for a numeric field, are ignored. + /// /// [JsonInclude, JsonPropertyName("lenient")] public bool? Lenient { get; set; } /// - /// Maximum number of terms to which the query will expand. + /// + /// Maximum number of terms to which the query will expand. + /// /// [JsonInclude, JsonPropertyName("max_expansions")] public int? MaxExpansions { get; set; } /// - /// Minimum number of clauses that must match for a document to be returned. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// /// [JsonInclude, JsonPropertyName("minimum_should_match")] public Elastic.Clients.Elasticsearch.MinimumShouldMatch? MinimumShouldMatch { get; set; } /// - /// Boolean logic used to interpret text in the query value. + /// + /// Boolean logic used to interpret text in the query value. + /// /// [JsonInclude, JsonPropertyName("operator")] public Elastic.Clients.Elasticsearch.QueryDsl.Operator? Operator { get; set; } /// - /// Number of beginning characters left unchanged for fuzzy matching. + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// /// [JsonInclude, JsonPropertyName("prefix_length")] public int? PrefixLength { get; set; } /// - /// Text, number, boolean value or date you wish to find in the provided field. + /// + /// Text, number, boolean value or date you wish to find in the provided field. + /// /// [JsonInclude, JsonPropertyName("query")] public string Query { get; set; } @@ -111,25 +142,33 @@ public sealed partial class MultiMatchQuery public string? QueryName { get; set; } /// - /// Maximum number of positions allowed between matching tokens. + /// + /// Maximum number of positions allowed between matching tokens. + /// /// [JsonInclude, JsonPropertyName("slop")] public int? Slop { get; set; } /// - /// Determines how scores for each per-term blended query and scores across groups are combined. + /// + /// Determines how scores for each per-term blended query and scores across groups are combined. + /// /// [JsonInclude, JsonPropertyName("tie_breaker")] public double? TieBreaker { get; set; } /// - /// How `the` multi_match query is executed internally. + /// + /// How the multi_match query is executed internally. + /// /// [JsonInclude, JsonPropertyName("type")] public Elastic.Clients.Elasticsearch.QueryDsl.TextQueryType? Type { get; set; } /// - /// Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter. + /// /// [JsonInclude, JsonPropertyName("zero_terms_query")] public Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? ZeroTermsQuery { get; set; } @@ -165,7 +204,9 @@ public MultiMatchQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? ZeroTermsQueryValue { get; set; } /// - /// Analyzer used to convert the text in the query value into tokens. + /// + /// Analyzer used to convert the text in the query value into tokens. + /// /// public MultiMatchQueryDescriptor Analyzer(string? analyzer) { @@ -174,7 +215,9 @@ public MultiMatchQueryDescriptor Analyzer(string? analyzer) } /// - /// If `true`, match phrase queries are automatically created for multi-term synonyms. + /// + /// If true, match phrase queries are automatically created for multi-term synonyms. + /// /// public MultiMatchQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSynonymsPhraseQuery = true) { @@ -183,7 +226,12 @@ public MultiMatchQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public MultiMatchQueryDescriptor Boost(float? boost) { @@ -192,7 +240,10 @@ public MultiMatchQueryDescriptor Boost(float? boost) } /// - /// The fields to be queried.
Defaults to the `index.query.default_field` index settings, which in turn defaults to `*`. + /// + /// The fields to be queried. + /// Defaults to the index.query.default_field index settings, which in turn defaults to *. + /// /// public MultiMatchQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Fields? fields) { @@ -201,7 +252,9 @@ public MultiMatchQueryDescriptor Fields(Elastic.Clients.Elasticsearch } /// - /// Maximum edit distance allowed for matching. + /// + /// Maximum edit distance allowed for matching. + /// /// public MultiMatchQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzziness? fuzziness) { @@ -210,7 +263,9 @@ public MultiMatchQueryDescriptor Fuzziness(Elastic.Clients.Elasticsea } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public MultiMatchQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) { @@ -219,7 +274,10 @@ public MultiMatchQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) } /// - /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public MultiMatchQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true) { @@ -228,7 +286,9 @@ public MultiMatchQueryDescriptor FuzzyTranspositions(bool? fuzzyTrans } /// - /// If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. + /// + /// If true, format-based errors, such as providing a text query value for a numeric field, are ignored. + /// /// public MultiMatchQueryDescriptor Lenient(bool? lenient = true) { @@ -237,7 +297,9 @@ public MultiMatchQueryDescriptor Lenient(bool? lenient = true) } /// - /// Maximum number of terms to which the query will expand. + /// + /// Maximum number of terms to which the query will expand. + /// /// public MultiMatchQueryDescriptor MaxExpansions(int? maxExpansions) { @@ -246,7 +308,9 @@ public MultiMatchQueryDescriptor MaxExpansions(int? maxExpansions) } /// - /// Minimum number of clauses that must match for a document to be returned. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// /// public MultiMatchQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { @@ -255,7 +319,9 @@ public MultiMatchQueryDescriptor MinimumShouldMatch(Elastic.Clients.E } /// - /// Boolean logic used to interpret text in the query value. + /// + /// Boolean logic used to interpret text in the query value. + /// /// public MultiMatchQueryDescriptor Operator(Elastic.Clients.Elasticsearch.QueryDsl.Operator? value) { @@ -264,7 +330,9 @@ public MultiMatchQueryDescriptor Operator(Elastic.Clients.Elasticsear } /// - /// Number of beginning characters left unchanged for fuzzy matching. + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// /// public MultiMatchQueryDescriptor PrefixLength(int? prefixLength) { @@ -273,7 +341,9 @@ public MultiMatchQueryDescriptor PrefixLength(int? prefixLength) } /// - /// Text, number, boolean value or date you wish to find in the provided field. + /// + /// Text, number, boolean value or date you wish to find in the provided field. + /// /// public MultiMatchQueryDescriptor Query(string query) { @@ -288,7 +358,9 @@ public MultiMatchQueryDescriptor QueryName(string? queryName) } /// - /// Maximum number of positions allowed between matching tokens. + /// + /// Maximum number of positions allowed between matching tokens. + /// /// public MultiMatchQueryDescriptor Slop(int? slop) { @@ -297,7 +369,9 @@ public MultiMatchQueryDescriptor Slop(int? slop) } /// - /// Determines how scores for each per-term blended query and scores across groups are combined. + /// + /// Determines how scores for each per-term blended query and scores across groups are combined. + /// /// public MultiMatchQueryDescriptor TieBreaker(double? tieBreaker) { @@ -306,7 +380,9 @@ public MultiMatchQueryDescriptor TieBreaker(double? tieBreaker) } /// - /// How `the` multi_match query is executed internally. + /// + /// How the multi_match query is executed internally. + /// /// public MultiMatchQueryDescriptor Type(Elastic.Clients.Elasticsearch.QueryDsl.TextQueryType? type) { @@ -315,7 +391,9 @@ public MultiMatchQueryDescriptor Type(Elastic.Clients.Elasticsearch.Q } /// - /// Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter. + /// /// public MultiMatchQueryDescriptor ZeroTermsQuery(Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? zeroTermsQuery) { @@ -462,7 +540,9 @@ public MultiMatchQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? ZeroTermsQueryValue { get; set; } /// - /// Analyzer used to convert the text in the query value into tokens. + /// + /// Analyzer used to convert the text in the query value into tokens. + /// /// public MultiMatchQueryDescriptor Analyzer(string? analyzer) { @@ -471,7 +551,9 @@ public MultiMatchQueryDescriptor Analyzer(string? analyzer) } /// - /// If `true`, match phrase queries are automatically created for multi-term synonyms. + /// + /// If true, match phrase queries are automatically created for multi-term synonyms. + /// /// public MultiMatchQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSynonymsPhraseQuery = true) { @@ -480,7 +562,12 @@ public MultiMatchQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGener } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public MultiMatchQueryDescriptor Boost(float? boost) { @@ -489,7 +576,10 @@ public MultiMatchQueryDescriptor Boost(float? boost) } /// - /// The fields to be queried.
Defaults to the `index.query.default_field` index settings, which in turn defaults to `*`. + /// + /// The fields to be queried. + /// Defaults to the index.query.default_field index settings, which in turn defaults to *. + /// /// public MultiMatchQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Fields? fields) { @@ -498,7 +588,9 @@ public MultiMatchQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Fields? fi } /// - /// Maximum edit distance allowed for matching. + /// + /// Maximum edit distance allowed for matching. + /// /// public MultiMatchQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzziness? fuzziness) { @@ -507,7 +599,9 @@ public MultiMatchQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzzine } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public MultiMatchQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) { @@ -516,7 +610,10 @@ public MultiMatchQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) } /// - /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).
Can be applied to the term subqueries constructed for all terms but the final term. + /// + /// If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). + /// Can be applied to the term subqueries constructed for all terms but the final term. + /// /// public MultiMatchQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true) { @@ -525,7 +622,9 @@ public MultiMatchQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = } /// - /// If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. + /// + /// If true, format-based errors, such as providing a text query value for a numeric field, are ignored. + /// /// public MultiMatchQueryDescriptor Lenient(bool? lenient = true) { @@ -534,7 +633,9 @@ public MultiMatchQueryDescriptor Lenient(bool? lenient = true) } /// - /// Maximum number of terms to which the query will expand. + /// + /// Maximum number of terms to which the query will expand. + /// /// public MultiMatchQueryDescriptor MaxExpansions(int? maxExpansions) { @@ -543,7 +644,9 @@ public MultiMatchQueryDescriptor MaxExpansions(int? maxExpansions) } /// - /// Minimum number of clauses that must match for a document to be returned. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// /// public MultiMatchQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { @@ -552,7 +655,9 @@ public MultiMatchQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearc } /// - /// Boolean logic used to interpret text in the query value. + /// + /// Boolean logic used to interpret text in the query value. + /// /// public MultiMatchQueryDescriptor Operator(Elastic.Clients.Elasticsearch.QueryDsl.Operator? value) { @@ -561,7 +666,9 @@ public MultiMatchQueryDescriptor Operator(Elastic.Clients.Elasticsearch.QueryDsl } /// - /// Number of beginning characters left unchanged for fuzzy matching. + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// /// public MultiMatchQueryDescriptor PrefixLength(int? prefixLength) { @@ -570,7 +677,9 @@ public MultiMatchQueryDescriptor PrefixLength(int? prefixLength) } /// - /// Text, number, boolean value or date you wish to find in the provided field. + /// + /// Text, number, boolean value or date you wish to find in the provided field. + /// /// public MultiMatchQueryDescriptor Query(string query) { @@ -585,7 +694,9 @@ public MultiMatchQueryDescriptor QueryName(string? queryName) } /// - /// Maximum number of positions allowed between matching tokens. + /// + /// Maximum number of positions allowed between matching tokens. + /// /// public MultiMatchQueryDescriptor Slop(int? slop) { @@ -594,7 +705,9 @@ public MultiMatchQueryDescriptor Slop(int? slop) } /// - /// Determines how scores for each per-term blended query and scores across groups are combined. + /// + /// Determines how scores for each per-term blended query and scores across groups are combined. + /// /// public MultiMatchQueryDescriptor TieBreaker(double? tieBreaker) { @@ -603,7 +716,9 @@ public MultiMatchQueryDescriptor TieBreaker(double? tieBreaker) } /// - /// How `the` multi_match query is executed internally. + /// + /// How the multi_match query is executed internally. + /// /// public MultiMatchQueryDescriptor Type(Elastic.Clients.Elasticsearch.QueryDsl.TextQueryType? type) { @@ -612,7 +727,9 @@ public MultiMatchQueryDescriptor Type(Elastic.Clients.Elasticsearch.QueryDsl.Tex } /// - /// Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter. + /// /// public MultiMatchQueryDescriptor ZeroTermsQuery(Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? zeroTermsQuery) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/NestedQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/NestedQuery.g.cs index e7744e59d46..0f79c2ce37f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/NestedQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/NestedQuery.g.cs @@ -30,31 +30,44 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class NestedQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Indicates whether to ignore an unmapped path and not return any documents instead of an error. + /// + /// Indicates whether to ignore an unmapped path and not return any documents instead of an error. + /// /// [JsonInclude, JsonPropertyName("ignore_unmapped")] public bool? IgnoreUnmapped { get; set; } /// - /// If defined, each search hit will contain inner hits. + /// + /// If defined, each search hit will contain inner hits. + /// /// [JsonInclude, JsonPropertyName("inner_hits")] public Elastic.Clients.Elasticsearch.Core.Search.InnerHits? InnerHits { get; set; } /// - /// Path to the nested object you wish to search. + /// + /// Path to the nested object you wish to search. + /// /// [JsonInclude, JsonPropertyName("path")] public Elastic.Clients.Elasticsearch.Field Path { get; set; } /// - /// Query you wish to run on nested objects in the path. + /// + /// Query you wish to run on nested objects in the path. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query Query { get; set; } @@ -62,7 +75,9 @@ public sealed partial class NestedQuery public string? QueryName { get; set; } /// - /// How scores for matching child objects affect the root parent document’s relevance score. + /// + /// How scores for matching child objects affect the root parent document’s relevance score. + /// /// [JsonInclude, JsonPropertyName("score_mode")] public Elastic.Clients.Elasticsearch.QueryDsl.ChildScoreMode? ScoreMode { get; set; } @@ -91,7 +106,12 @@ public NestedQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.QueryDsl.ChildScoreMode? ScoreModeValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public NestedQueryDescriptor Boost(float? boost) { @@ -100,7 +120,9 @@ public NestedQueryDescriptor Boost(float? boost) } /// - /// Indicates whether to ignore an unmapped path and not return any documents instead of an error. + /// + /// Indicates whether to ignore an unmapped path and not return any documents instead of an error. + /// /// public NestedQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { @@ -109,7 +131,9 @@ public NestedQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = tr } /// - /// If defined, each search hit will contain inner hits. + /// + /// If defined, each search hit will contain inner hits. + /// /// public NestedQueryDescriptor InnerHits(Elastic.Clients.Elasticsearch.Core.Search.InnerHits? innerHits) { @@ -136,7 +160,9 @@ public NestedQueryDescriptor InnerHits(Action - /// Path to the nested object you wish to search. + /// + /// Path to the nested object you wish to search. + /// /// public NestedQueryDescriptor Path(Elastic.Clients.Elasticsearch.Field path) { @@ -145,7 +171,9 @@ public NestedQueryDescriptor Path(Elastic.Clients.Elasticsearch.Field } /// - /// Path to the nested object you wish to search. + /// + /// Path to the nested object you wish to search. + /// /// public NestedQueryDescriptor Path(Expression> path) { @@ -154,7 +182,9 @@ public NestedQueryDescriptor Path(Expression - /// Path to the nested object you wish to search. + /// + /// Path to the nested object you wish to search. + /// /// public NestedQueryDescriptor Path(Expression> path) { @@ -163,7 +193,9 @@ public NestedQueryDescriptor Path(Expression> } /// - /// Query you wish to run on nested objects in the path. + /// + /// Query you wish to run on nested objects in the path. + /// /// public NestedQueryDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query query) { @@ -196,7 +228,9 @@ public NestedQueryDescriptor QueryName(string? queryName) } /// - /// How scores for matching child objects affect the root parent document’s relevance score. + /// + /// How scores for matching child objects affect the root parent document’s relevance score. + /// /// public NestedQueryDescriptor ScoreMode(Elastic.Clients.Elasticsearch.QueryDsl.ChildScoreMode? scoreMode) { @@ -290,7 +324,12 @@ public NestedQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.QueryDsl.ChildScoreMode? ScoreModeValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public NestedQueryDescriptor Boost(float? boost) { @@ -299,7 +338,9 @@ public NestedQueryDescriptor Boost(float? boost) } /// - /// Indicates whether to ignore an unmapped path and not return any documents instead of an error. + /// + /// Indicates whether to ignore an unmapped path and not return any documents instead of an error. + /// /// public NestedQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { @@ -308,7 +349,9 @@ public NestedQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) } /// - /// If defined, each search hit will contain inner hits. + /// + /// If defined, each search hit will contain inner hits. + /// /// public NestedQueryDescriptor InnerHits(Elastic.Clients.Elasticsearch.Core.Search.InnerHits? innerHits) { @@ -335,7 +378,9 @@ public NestedQueryDescriptor InnerHits(Action - /// Path to the nested object you wish to search. + /// + /// Path to the nested object you wish to search. + /// /// public NestedQueryDescriptor Path(Elastic.Clients.Elasticsearch.Field path) { @@ -344,7 +389,9 @@ public NestedQueryDescriptor Path(Elastic.Clients.Elasticsearch.Field path) } /// - /// Path to the nested object you wish to search. + /// + /// Path to the nested object you wish to search. + /// /// public NestedQueryDescriptor Path(Expression> path) { @@ -353,7 +400,9 @@ public NestedQueryDescriptor Path(Expression - /// Path to the nested object you wish to search. + /// + /// Path to the nested object you wish to search. + /// /// public NestedQueryDescriptor Path(Expression> path) { @@ -362,7 +411,9 @@ public NestedQueryDescriptor Path(Expression> } /// - /// Query you wish to run on nested objects in the path. + /// + /// Query you wish to run on nested objects in the path. + /// /// public NestedQueryDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query query) { @@ -395,7 +446,9 @@ public NestedQueryDescriptor QueryName(string? queryName) } /// - /// How scores for matching child objects affect the root parent document’s relevance score. + /// + /// How scores for matching child objects affect the root parent document’s relevance score. + /// /// public NestedQueryDescriptor ScoreMode(Elastic.Clients.Elasticsearch.QueryDsl.ChildScoreMode? scoreMode) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/NumberRangeQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/NumberRangeQuery.g.cs index 5c7d25201f2..f9d5f0d2b2d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/NumberRangeQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/NumberRangeQuery.g.cs @@ -181,35 +181,50 @@ public NumberRangeQuery(Elastic.Clients.Elasticsearch.Field field) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } public double? From { get; set; } /// - /// Greater than. + /// + /// Greater than. + /// /// public double? Gt { get; set; } /// - /// Greater than or equal to. + /// + /// Greater than or equal to. + /// /// public double? Gte { get; set; } /// - /// Less than. + /// + /// Less than. + /// /// public double? Lt { get; set; } /// - /// Less than or equal to. + /// + /// Less than or equal to. + /// /// public double? Lte { get; set; } public string? QueryName { get; set; } /// - /// Indicates how the range query matches values for `range` fields. + /// + /// Indicates how the range query matches values for range fields. + /// /// public Elastic.Clients.Elasticsearch.QueryDsl.RangeRelation? Relation { get; set; } public double? To { get; set; } @@ -235,7 +250,12 @@ public NumberRangeQueryDescriptor() : base() private double? ToValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public NumberRangeQueryDescriptor Boost(float? boost) { @@ -268,7 +288,9 @@ public NumberRangeQueryDescriptor From(double? from) } /// - /// Greater than. + /// + /// Greater than. + /// /// public NumberRangeQueryDescriptor Gt(double? gt) { @@ -277,7 +299,9 @@ public NumberRangeQueryDescriptor Gt(double? gt) } /// - /// Greater than or equal to. + /// + /// Greater than or equal to. + /// /// public NumberRangeQueryDescriptor Gte(double? gte) { @@ -286,7 +310,9 @@ public NumberRangeQueryDescriptor Gte(double? gte) } /// - /// Less than. + /// + /// Less than. + /// /// public NumberRangeQueryDescriptor Lt(double? lt) { @@ -295,7 +321,9 @@ public NumberRangeQueryDescriptor Lt(double? lt) } /// - /// Less than or equal to. + /// + /// Less than or equal to. + /// /// public NumberRangeQueryDescriptor Lte(double? lte) { @@ -310,7 +338,9 @@ public NumberRangeQueryDescriptor QueryName(string? queryName) } /// - /// Indicates how the range query matches values for `range` fields. + /// + /// Indicates how the range query matches values for range fields. + /// /// public NumberRangeQueryDescriptor Relation(Elastic.Clients.Elasticsearch.QueryDsl.RangeRelation? relation) { @@ -410,7 +440,12 @@ public NumberRangeQueryDescriptor() : base() private double? ToValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public NumberRangeQueryDescriptor Boost(float? boost) { @@ -443,7 +478,9 @@ public NumberRangeQueryDescriptor From(double? from) } /// - /// Greater than. + /// + /// Greater than. + /// /// public NumberRangeQueryDescriptor Gt(double? gt) { @@ -452,7 +489,9 @@ public NumberRangeQueryDescriptor Gt(double? gt) } /// - /// Greater than or equal to. + /// + /// Greater than or equal to. + /// /// public NumberRangeQueryDescriptor Gte(double? gte) { @@ -461,7 +500,9 @@ public NumberRangeQueryDescriptor Gte(double? gte) } /// - /// Less than. + /// + /// Less than. + /// /// public NumberRangeQueryDescriptor Lt(double? lt) { @@ -470,7 +511,9 @@ public NumberRangeQueryDescriptor Lt(double? lt) } /// - /// Less than or equal to. + /// + /// Less than or equal to. + /// /// public NumberRangeQueryDescriptor Lte(double? lte) { @@ -485,7 +528,9 @@ public NumberRangeQueryDescriptor QueryName(string? queryName) } /// - /// Indicates how the range query matches values for `range` fields. + /// + /// Indicates how the range query matches values for range fields. + /// /// public NumberRangeQueryDescriptor Relation(Elastic.Clients.Elasticsearch.QueryDsl.RangeRelation? relation) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/NumericDecayFunction.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/NumericDecayFunction.g.cs index 81edd496472..7b69411a236 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/NumericDecayFunction.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/NumericDecayFunction.g.cs @@ -85,7 +85,9 @@ public sealed partial class NumericDecayFunction public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// + /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// /// public Elastic.Clients.Elasticsearch.QueryDsl.MultiValueMode? MultiValueMode { get; set; } public Elastic.Clients.Elasticsearch.QueryDsl.DecayPlacement Placement { get; set; } @@ -122,7 +124,9 @@ public NumericDecayFunctionDescriptor Field(Expression - /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// + /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// /// public NumericDecayFunctionDescriptor MultiValueMode(Elastic.Clients.Elasticsearch.QueryDsl.MultiValueMode? multiValueMode) { @@ -187,7 +191,9 @@ public NumericDecayFunctionDescriptor Field(Expression - /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// + /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// /// public NumericDecayFunctionDescriptor MultiValueMode(Elastic.Clients.Elasticsearch.QueryDsl.MultiValueMode? multiValueMode) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ParentIdQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ParentIdQuery.g.cs index 61ef3a4c0f5..baa18ceeb38 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ParentIdQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ParentIdQuery.g.cs @@ -30,19 +30,28 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class ParentIdQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// ID of the parent document. + /// + /// ID of the parent document. + /// /// [JsonInclude, JsonPropertyName("id")] public Elastic.Clients.Elasticsearch.Id? Id { get; set; } /// - /// Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. + /// + /// Indicates whether to ignore an unmapped type and not return any documents instead of an error. + /// /// [JsonInclude, JsonPropertyName("ignore_unmapped")] public bool? IgnoreUnmapped { get; set; } @@ -50,7 +59,9 @@ public sealed partial class ParentIdQuery public string? QueryName { get; set; } /// - /// Name of the child relationship mapped for the `join` field. + /// + /// Name of the child relationship mapped for the join field. + /// /// [JsonInclude, JsonPropertyName("type")] public string? Type { get; set; } @@ -73,7 +84,12 @@ public ParentIdQueryDescriptor() : base() private string? TypeValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public ParentIdQueryDescriptor Boost(float? boost) { @@ -82,7 +98,9 @@ public ParentIdQueryDescriptor Boost(float? boost) } /// - /// ID of the parent document. + /// + /// ID of the parent document. + /// /// public ParentIdQueryDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) { @@ -91,7 +109,9 @@ public ParentIdQueryDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) } /// - /// Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. + /// + /// Indicates whether to ignore an unmapped type and not return any documents instead of an error. + /// /// public ParentIdQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { @@ -106,7 +126,9 @@ public ParentIdQueryDescriptor QueryName(string? queryName) } /// - /// Name of the child relationship mapped for the `join` field. + /// + /// Name of the child relationship mapped for the join field. + /// /// public ParentIdQueryDescriptor Type(string? type) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PercolateQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PercolateQuery.g.cs index c676eabb891..c20798d7bb4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PercolateQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PercolateQuery.g.cs @@ -30,49 +30,68 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class PercolateQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// The source of the document being percolated. + /// + /// The source of the document being percolated. + /// /// [JsonInclude, JsonPropertyName("document")] public object? Document { get; set; } /// - /// An array of sources of the documents being percolated. + /// + /// An array of sources of the documents being percolated. + /// /// [JsonInclude, JsonPropertyName("documents")] public ICollection? Documents { get; set; } /// - /// Field that holds the indexed queries. The field must use the `percolator` mapping type. + /// + /// Field that holds the indexed queries. The field must use the percolator mapping type. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// The ID of a stored document to percolate. + /// + /// The ID of a stored document to percolate. + /// /// [JsonInclude, JsonPropertyName("id")] public Elastic.Clients.Elasticsearch.Id? Id { get; set; } /// - /// The index of a stored document to percolate. + /// + /// The index of a stored document to percolate. + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.IndexName? Index { get; set; } /// - /// The suffix used for the `_percolator_document_slot` field when multiple `percolate` queries are specified. + /// + /// The suffix used for the _percolator_document_slot field when multiple percolate queries are specified. + /// /// [JsonInclude, JsonPropertyName("name")] public string? Name { get; set; } /// - /// Preference used to fetch document to percolate. + /// + /// Preference used to fetch document to percolate. + /// /// [JsonInclude, JsonPropertyName("preference")] public string? Preference { get; set; } @@ -80,13 +99,17 @@ public sealed partial class PercolateQuery public string? QueryName { get; set; } /// - /// Routing used to fetch document to percolate. + /// + /// Routing used to fetch document to percolate. + /// /// [JsonInclude, JsonPropertyName("routing")] public Elastic.Clients.Elasticsearch.Routing? Routing { get; set; } /// - /// The expected version of a stored document to percolate. + /// + /// The expected version of a stored document to percolate. + /// /// [JsonInclude, JsonPropertyName("version")] public long? Version { get; set; } @@ -115,7 +138,12 @@ public PercolateQueryDescriptor() : base() private long? VersionValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public PercolateQueryDescriptor Boost(float? boost) { @@ -124,7 +152,9 @@ public PercolateQueryDescriptor Boost(float? boost) } /// - /// The source of the document being percolated. + /// + /// The source of the document being percolated. + /// /// public PercolateQueryDescriptor Document(object? document) { @@ -133,7 +163,9 @@ public PercolateQueryDescriptor Document(object? document) } /// - /// An array of sources of the documents being percolated. + /// + /// An array of sources of the documents being percolated. + /// /// public PercolateQueryDescriptor Documents(ICollection? documents) { @@ -142,7 +174,9 @@ public PercolateQueryDescriptor Documents(ICollection? docume } /// - /// Field that holds the indexed queries. The field must use the `percolator` mapping type. + /// + /// Field that holds the indexed queries. The field must use the percolator mapping type. + /// /// public PercolateQueryDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -151,7 +185,9 @@ public PercolateQueryDescriptor Field(Elastic.Clients.Elasticsearch.F } /// - /// Field that holds the indexed queries. The field must use the `percolator` mapping type. + /// + /// Field that holds the indexed queries. The field must use the percolator mapping type. + /// /// public PercolateQueryDescriptor Field(Expression> field) { @@ -160,7 +196,9 @@ public PercolateQueryDescriptor Field(Expression - /// Field that holds the indexed queries. The field must use the `percolator` mapping type. + /// + /// Field that holds the indexed queries. The field must use the percolator mapping type. + /// /// public PercolateQueryDescriptor Field(Expression> field) { @@ -169,7 +207,9 @@ public PercolateQueryDescriptor Field(Expression - /// The ID of a stored document to percolate. + /// + /// The ID of a stored document to percolate. + /// /// public PercolateQueryDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) { @@ -178,7 +218,9 @@ public PercolateQueryDescriptor Id(Elastic.Clients.Elasticsearch.Id? } /// - /// The index of a stored document to percolate. + /// + /// The index of a stored document to percolate. + /// /// public PercolateQueryDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? index) { @@ -187,7 +229,9 @@ public PercolateQueryDescriptor Index(Elastic.Clients.Elasticsearch.I } /// - /// The suffix used for the `_percolator_document_slot` field when multiple `percolate` queries are specified. + /// + /// The suffix used for the _percolator_document_slot field when multiple percolate queries are specified. + /// /// public PercolateQueryDescriptor Name(string? name) { @@ -196,7 +240,9 @@ public PercolateQueryDescriptor Name(string? name) } /// - /// Preference used to fetch document to percolate. + /// + /// Preference used to fetch document to percolate. + /// /// public PercolateQueryDescriptor Preference(string? preference) { @@ -211,7 +257,9 @@ public PercolateQueryDescriptor QueryName(string? queryName) } /// - /// Routing used to fetch document to percolate. + /// + /// Routing used to fetch document to percolate. + /// /// public PercolateQueryDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? routing) { @@ -220,7 +268,9 @@ public PercolateQueryDescriptor Routing(Elastic.Clients.Elasticsearch } /// - /// The expected version of a stored document to percolate. + /// + /// The expected version of a stored document to percolate. + /// /// public PercolateQueryDescriptor Version(long? version) { @@ -318,7 +368,12 @@ public PercolateQueryDescriptor() : base() private long? VersionValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public PercolateQueryDescriptor Boost(float? boost) { @@ -327,7 +382,9 @@ public PercolateQueryDescriptor Boost(float? boost) } /// - /// The source of the document being percolated. + /// + /// The source of the document being percolated. + /// /// public PercolateQueryDescriptor Document(object? document) { @@ -336,7 +393,9 @@ public PercolateQueryDescriptor Document(object? document) } /// - /// An array of sources of the documents being percolated. + /// + /// An array of sources of the documents being percolated. + /// /// public PercolateQueryDescriptor Documents(ICollection? documents) { @@ -345,7 +404,9 @@ public PercolateQueryDescriptor Documents(ICollection? documents) } /// - /// Field that holds the indexed queries. The field must use the `percolator` mapping type. + /// + /// Field that holds the indexed queries. The field must use the percolator mapping type. + /// /// public PercolateQueryDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -354,7 +415,9 @@ public PercolateQueryDescriptor Field(Elastic.Clients.Elasticsearch.Field field) } /// - /// Field that holds the indexed queries. The field must use the `percolator` mapping type. + /// + /// Field that holds the indexed queries. The field must use the percolator mapping type. + /// /// public PercolateQueryDescriptor Field(Expression> field) { @@ -363,7 +426,9 @@ public PercolateQueryDescriptor Field(Expression - /// Field that holds the indexed queries. The field must use the `percolator` mapping type. + /// + /// Field that holds the indexed queries. The field must use the percolator mapping type. + /// /// public PercolateQueryDescriptor Field(Expression> field) { @@ -372,7 +437,9 @@ public PercolateQueryDescriptor Field(Expression - /// The ID of a stored document to percolate. + /// + /// The ID of a stored document to percolate. + /// /// public PercolateQueryDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) { @@ -381,7 +448,9 @@ public PercolateQueryDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) } /// - /// The index of a stored document to percolate. + /// + /// The index of a stored document to percolate. + /// /// public PercolateQueryDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? index) { @@ -390,7 +459,9 @@ public PercolateQueryDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? i } /// - /// The suffix used for the `_percolator_document_slot` field when multiple `percolate` queries are specified. + /// + /// The suffix used for the _percolator_document_slot field when multiple percolate queries are specified. + /// /// public PercolateQueryDescriptor Name(string? name) { @@ -399,7 +470,9 @@ public PercolateQueryDescriptor Name(string? name) } /// - /// Preference used to fetch document to percolate. + /// + /// Preference used to fetch document to percolate. + /// /// public PercolateQueryDescriptor Preference(string? preference) { @@ -414,7 +487,9 @@ public PercolateQueryDescriptor QueryName(string? queryName) } /// - /// Routing used to fetch document to percolate. + /// + /// Routing used to fetch document to percolate. + /// /// public PercolateQueryDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? routing) { @@ -423,7 +498,9 @@ public PercolateQueryDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? r } /// - /// The expected version of a stored document to percolate. + /// + /// The expected version of a stored document to percolate. + /// /// public PercolateQueryDescriptor Version(long? version) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PinnedDoc.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PinnedDoc.g.cs index 230c586db5d..41e1d42111d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PinnedDoc.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PinnedDoc.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class PinnedDoc { /// - /// The unique document ID. + /// + /// The unique document ID. + /// /// [JsonInclude, JsonPropertyName("_id")] public Elastic.Clients.Elasticsearch.Id Id { get; set; } /// - /// The index that contains the document. + /// + /// The index that contains the document. + /// /// [JsonInclude, JsonPropertyName("_index")] public Elastic.Clients.Elasticsearch.IndexName Index { get; set; } @@ -54,7 +58,9 @@ public PinnedDocDescriptor() : base() private Elastic.Clients.Elasticsearch.IndexName IndexValue { get; set; } /// - /// The unique document ID. + /// + /// The unique document ID. + /// /// public PinnedDocDescriptor Id(Elastic.Clients.Elasticsearch.Id id) { @@ -63,7 +69,9 @@ public PinnedDocDescriptor Id(Elastic.Clients.Elasticsearch.Id id) } /// - /// The index that contains the document. + /// + /// The index that contains the document. + /// /// public PinnedDocDescriptor Index(Elastic.Clients.Elasticsearch.IndexName index) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PinnedQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PinnedQuery.g.cs index 95322e3031c..26dd33fbbfb 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PinnedQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PinnedQuery.g.cs @@ -50,13 +50,20 @@ internal PinnedQuery(string variantName, object variant) public static PinnedQuery Ids(IReadOnlyCollection id) => new PinnedQuery("ids", id); /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Any choice of query used to rank documents which will be ranked below the "pinned" documents. + /// + /// Any choice of query used to rank documents which will be ranked below the "pinned" documents. + /// /// [JsonInclude, JsonPropertyName("organic")] public Elastic.Clients.Elasticsearch.QueryDsl.Query Organic { get; set; } @@ -221,7 +228,12 @@ private PinnedQueryDescriptor Set(object variant, string variantName) private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public PinnedQueryDescriptor Boost(float? boost) { @@ -230,7 +242,9 @@ public PinnedQueryDescriptor Boost(float? boost) } /// - /// Any choice of query used to rank documents which will be ranked below the "pinned" documents. + /// + /// Any choice of query used to rank documents which will be ranked below the "pinned" documents. + /// /// public PinnedQueryDescriptor Organic(Elastic.Clients.Elasticsearch.QueryDsl.Query organic) { @@ -322,7 +336,12 @@ private PinnedQueryDescriptor Set(object variant, string variantName) private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public PinnedQueryDescriptor Boost(float? boost) { @@ -331,7 +350,9 @@ public PinnedQueryDescriptor Boost(float? boost) } /// - /// Any choice of query used to rank documents which will be ranked below the "pinned" documents. + /// + /// Any choice of query used to rank documents which will be ranked below the "pinned" documents. + /// /// public PinnedQueryDescriptor Organic(Elastic.Clients.Elasticsearch.QueryDsl.Query organic) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PrefixQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PrefixQuery.g.cs index ebd1b475d64..34776d67825 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PrefixQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PrefixQuery.g.cs @@ -129,24 +129,36 @@ public PrefixQuery(Elastic.Clients.Elasticsearch.Field field) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } /// - /// Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.
Default is `false` which means the case sensitivity of matching depends on the underlying field’s mapping. + /// + /// Allows ASCII case insensitive matching of the value with the indexed field values when set to true. + /// Default is false which means the case sensitivity of matching depends on the underlying field’s mapping. + /// /// public bool? CaseInsensitive { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } public string? QueryName { get; set; } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public string? Rewrite { get; set; } /// - /// Beginning characters of terms you wish to find in the provided field. + /// + /// Beginning characters of terms you wish to find in the provided field. + /// /// public string Value { get; set; } @@ -169,7 +181,12 @@ public PrefixQueryDescriptor() : base() private string ValueValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public PrefixQueryDescriptor Boost(float? boost) { @@ -178,7 +195,10 @@ public PrefixQueryDescriptor Boost(float? boost) } /// - /// Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.
Default is `false` which means the case sensitivity of matching depends on the underlying field’s mapping. + /// + /// Allows ASCII case insensitive matching of the value with the indexed field values when set to true. + /// Default is false which means the case sensitivity of matching depends on the underlying field’s mapping. + /// /// public PrefixQueryDescriptor CaseInsensitive(bool? caseInsensitive = true) { @@ -211,7 +231,9 @@ public PrefixQueryDescriptor QueryName(string? queryName) } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public PrefixQueryDescriptor Rewrite(string? rewrite) { @@ -220,7 +242,9 @@ public PrefixQueryDescriptor Rewrite(string? rewrite) } /// - /// Beginning characters of terms you wish to find in the provided field. + /// + /// Beginning characters of terms you wish to find in the provided field. + /// /// public PrefixQueryDescriptor Value(string value) { @@ -282,7 +306,12 @@ public PrefixQueryDescriptor() : base() private string ValueValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public PrefixQueryDescriptor Boost(float? boost) { @@ -291,7 +320,10 @@ public PrefixQueryDescriptor Boost(float? boost) } /// - /// Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.
Default is `false` which means the case sensitivity of matching depends on the underlying field’s mapping. + /// + /// Allows ASCII case insensitive matching of the value with the indexed field values when set to true. + /// Default is false which means the case sensitivity of matching depends on the underlying field’s mapping. + /// /// public PrefixQueryDescriptor CaseInsensitive(bool? caseInsensitive = true) { @@ -324,7 +356,9 @@ public PrefixQueryDescriptor QueryName(string? queryName) } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public PrefixQueryDescriptor Rewrite(string? rewrite) { @@ -333,7 +367,9 @@ public PrefixQueryDescriptor Rewrite(string? rewrite) } /// - /// Beginning characters of terms you wish to find in the provided field. + /// + /// Beginning characters of terms you wish to find in the provided field. + /// /// public PrefixQueryDescriptor Value(string value) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/QueryStringQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/QueryStringQuery.g.cs index 680ad490729..c805604bc93 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/QueryStringQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/QueryStringQuery.g.cs @@ -30,49 +30,70 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class QueryStringQuery { /// - /// If `true`, the wildcard characters `*` and `?` are allowed as the first character of the query string. + /// + /// If true, the wildcard characters * and ? are allowed as the first character of the query string. + /// /// [JsonInclude, JsonPropertyName("allow_leading_wildcard")] public bool? AllowLeadingWildcard { get; set; } /// - /// Analyzer used to convert text in the query string into tokens. + /// + /// Analyzer used to convert text in the query string into tokens. + /// /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } /// - /// If `true`, the query attempts to analyze wildcard terms in the query string. + /// + /// If true, the query attempts to analyze wildcard terms in the query string. + /// /// [JsonInclude, JsonPropertyName("analyze_wildcard")] public bool? AnalyzeWildcard { get; set; } /// - /// If `true`, match phrase queries are automatically created for multi-term synonyms. + /// + /// If true, match phrase queries are automatically created for multi-term synonyms. + /// /// [JsonInclude, JsonPropertyName("auto_generate_synonyms_phrase_query")] public bool? AutoGenerateSynonymsPhraseQuery { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Default field to search if no field is provided in the query string.
Supports wildcards (`*`).
Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + /// + /// Default field to search if no field is provided in the query string. + /// Supports wildcards (*). + /// Defaults to the index.query.default_field index setting, which has a default value of *. + /// /// [JsonInclude, JsonPropertyName("default_field")] public Elastic.Clients.Elasticsearch.Field? DefaultField { get; set; } /// - /// Default boolean logic used to interpret text in the query string if no operators are specified. + /// + /// Default boolean logic used to interpret text in the query string if no operators are specified. + /// /// [JsonInclude, JsonPropertyName("default_operator")] public Elastic.Clients.Elasticsearch.QueryDsl.Operator? DefaultOperator { get; set; } /// - /// If `true`, enable position increments in queries constructed from a `query_string` search. + /// + /// If true, enable position increments in queries constructed from a query_string search. + /// /// [JsonInclude, JsonPropertyName("enable_position_increments")] public bool? EnablePositionIncrements { get; set; } @@ -80,68 +101,90 @@ public sealed partial class QueryStringQuery public bool? Escape { get; set; } /// - /// Array of fields to search. Supports wildcards (`*`). + /// + /// Array of fields to search. Supports wildcards (*). + /// /// [JsonInclude, JsonPropertyName("fields")] [JsonConverter(typeof(FieldsConverter))] public Elastic.Clients.Elasticsearch.Fields? Fields { get; set; } /// - /// Maximum edit distance allowed for fuzzy matching. + /// + /// Maximum edit distance allowed for fuzzy matching. + /// /// [JsonInclude, JsonPropertyName("fuzziness")] public Elastic.Clients.Elasticsearch.Fuzziness? Fuzziness { get; set; } /// - /// Maximum number of terms to which the query expands for fuzzy matching. + /// + /// Maximum number of terms to which the query expands for fuzzy matching. + /// /// [JsonInclude, JsonPropertyName("fuzzy_max_expansions")] public int? FuzzyMaxExpansions { get; set; } /// - /// Number of beginning characters left unchanged for fuzzy matching. + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// /// [JsonInclude, JsonPropertyName("fuzzy_prefix_length")] public int? FuzzyPrefixLength { get; set; } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// [JsonInclude, JsonPropertyName("fuzzy_rewrite")] public string? FuzzyRewrite { get; set; } /// - /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// + /// If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). + /// /// [JsonInclude, JsonPropertyName("fuzzy_transpositions")] public bool? FuzzyTranspositions { get; set; } /// - /// If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. + /// + /// If true, format-based errors, such as providing a text value for a numeric field, are ignored. + /// /// [JsonInclude, JsonPropertyName("lenient")] public bool? Lenient { get; set; } /// - /// Maximum number of automaton states required for the query. + /// + /// Maximum number of automaton states required for the query. + /// /// [JsonInclude, JsonPropertyName("max_determinized_states")] public int? MaxDeterminizedStates { get; set; } /// - /// Minimum number of clauses that must match for a document to be returned. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// /// [JsonInclude, JsonPropertyName("minimum_should_match")] public Elastic.Clients.Elasticsearch.MinimumShouldMatch? MinimumShouldMatch { get; set; } /// - /// Maximum number of positions allowed between matching tokens for phrases. + /// + /// Maximum number of positions allowed between matching tokens for phrases. + /// /// [JsonInclude, JsonPropertyName("phrase_slop")] public double? PhraseSlop { get; set; } /// - /// Query string you wish to parse and use for search. + /// + /// Query string you wish to parse and use for search. + /// /// [JsonInclude, JsonPropertyName("query")] public string Query { get; set; } @@ -149,37 +192,51 @@ public sealed partial class QueryStringQuery public string? QueryName { get; set; } /// - /// Analyzer used to convert quoted text in the query string into tokens.
For quoted text, this parameter overrides the analyzer specified in the `analyzer` parameter. + /// + /// Analyzer used to convert quoted text in the query string into tokens. + /// For quoted text, this parameter overrides the analyzer specified in the analyzer parameter. + /// /// [JsonInclude, JsonPropertyName("quote_analyzer")] public string? QuoteAnalyzer { get; set; } /// - /// Suffix appended to quoted text in the query string.
You can use this suffix to use a different analysis method for exact matches. + /// + /// Suffix appended to quoted text in the query string. + /// You can use this suffix to use a different analysis method for exact matches. + /// /// [JsonInclude, JsonPropertyName("quote_field_suffix")] public string? QuoteFieldSuffix { get; set; } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// [JsonInclude, JsonPropertyName("rewrite")] public string? Rewrite { get; set; } /// - /// How to combine the queries generated from the individual search terms in the resulting `dis_max` query. + /// + /// How to combine the queries generated from the individual search terms in the resulting dis_max query. + /// /// [JsonInclude, JsonPropertyName("tie_breaker")] public double? TieBreaker { get; set; } /// - /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query string to UTC. + /// + /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query string to UTC. + /// /// [JsonInclude, JsonPropertyName("time_zone")] public string? TimeZone { get; set; } /// - /// Determines how the query matches and scores documents. + /// + /// Determines how the query matches and scores documents. + /// /// [JsonInclude, JsonPropertyName("type")] public Elastic.Clients.Elasticsearch.QueryDsl.TextQueryType? Type { get; set; } @@ -224,7 +281,9 @@ public QueryStringQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.QueryDsl.TextQueryType? TypeValue { get; set; } /// - /// If `true`, the wildcard characters `*` and `?` are allowed as the first character of the query string. + /// + /// If true, the wildcard characters * and ? are allowed as the first character of the query string. + /// /// public QueryStringQueryDescriptor AllowLeadingWildcard(bool? allowLeadingWildcard = true) { @@ -233,7 +292,9 @@ public QueryStringQueryDescriptor AllowLeadingWildcard(bool? allowLea } /// - /// Analyzer used to convert text in the query string into tokens. + /// + /// Analyzer used to convert text in the query string into tokens. + /// /// public QueryStringQueryDescriptor Analyzer(string? analyzer) { @@ -242,7 +303,9 @@ public QueryStringQueryDescriptor Analyzer(string? analyzer) } /// - /// If `true`, the query attempts to analyze wildcard terms in the query string. + /// + /// If true, the query attempts to analyze wildcard terms in the query string. + /// /// public QueryStringQueryDescriptor AnalyzeWildcard(bool? analyzeWildcard = true) { @@ -251,7 +314,9 @@ public QueryStringQueryDescriptor AnalyzeWildcard(bool? analyzeWildca } /// - /// If `true`, match phrase queries are automatically created for multi-term synonyms. + /// + /// If true, match phrase queries are automatically created for multi-term synonyms. + /// /// public QueryStringQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSynonymsPhraseQuery = true) { @@ -260,7 +325,12 @@ public QueryStringQueryDescriptor AutoGenerateSynonymsPhraseQuery(boo } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public QueryStringQueryDescriptor Boost(float? boost) { @@ -269,7 +339,11 @@ public QueryStringQueryDescriptor Boost(float? boost) } /// - /// Default field to search if no field is provided in the query string.
Supports wildcards (`*`).
Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + /// + /// Default field to search if no field is provided in the query string. + /// Supports wildcards (*). + /// Defaults to the index.query.default_field index setting, which has a default value of *. + /// /// public QueryStringQueryDescriptor DefaultField(Elastic.Clients.Elasticsearch.Field? defaultField) { @@ -278,7 +352,11 @@ public QueryStringQueryDescriptor DefaultField(Elastic.Clients.Elasti } /// - /// Default field to search if no field is provided in the query string.
Supports wildcards (`*`).
Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + /// + /// Default field to search if no field is provided in the query string. + /// Supports wildcards (*). + /// Defaults to the index.query.default_field index setting, which has a default value of *. + /// /// public QueryStringQueryDescriptor DefaultField(Expression> defaultField) { @@ -287,7 +365,11 @@ public QueryStringQueryDescriptor DefaultField(Expression - /// Default field to search if no field is provided in the query string.
Supports wildcards (`*`).
Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + /// + /// Default field to search if no field is provided in the query string. + /// Supports wildcards (*). + /// Defaults to the index.query.default_field index setting, which has a default value of *. + /// /// public QueryStringQueryDescriptor DefaultField(Expression> defaultField) { @@ -296,7 +378,9 @@ public QueryStringQueryDescriptor DefaultField(Expression - /// Default boolean logic used to interpret text in the query string if no operators are specified. + /// + /// Default boolean logic used to interpret text in the query string if no operators are specified. + /// /// public QueryStringQueryDescriptor DefaultOperator(Elastic.Clients.Elasticsearch.QueryDsl.Operator? defaultOperator) { @@ -305,7 +389,9 @@ public QueryStringQueryDescriptor DefaultOperator(Elastic.Clients.Ela } /// - /// If `true`, enable position increments in queries constructed from a `query_string` search. + /// + /// If true, enable position increments in queries constructed from a query_string search. + /// /// public QueryStringQueryDescriptor EnablePositionIncrements(bool? enablePositionIncrements = true) { @@ -320,7 +406,9 @@ public QueryStringQueryDescriptor Escape(bool? escape = true) } /// - /// Array of fields to search. Supports wildcards (`*`). + /// + /// Array of fields to search. Supports wildcards (*). + /// /// public QueryStringQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Fields? fields) { @@ -329,7 +417,9 @@ public QueryStringQueryDescriptor Fields(Elastic.Clients.Elasticsearc } /// - /// Maximum edit distance allowed for fuzzy matching. + /// + /// Maximum edit distance allowed for fuzzy matching. + /// /// public QueryStringQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzziness? fuzziness) { @@ -338,7 +428,9 @@ public QueryStringQueryDescriptor Fuzziness(Elastic.Clients.Elasticse } /// - /// Maximum number of terms to which the query expands for fuzzy matching. + /// + /// Maximum number of terms to which the query expands for fuzzy matching. + /// /// public QueryStringQueryDescriptor FuzzyMaxExpansions(int? fuzzyMaxExpansions) { @@ -347,7 +439,9 @@ public QueryStringQueryDescriptor FuzzyMaxExpansions(int? fuzzyMaxExp } /// - /// Number of beginning characters left unchanged for fuzzy matching. + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// /// public QueryStringQueryDescriptor FuzzyPrefixLength(int? fuzzyPrefixLength) { @@ -356,7 +450,9 @@ public QueryStringQueryDescriptor FuzzyPrefixLength(int? fuzzyPrefixL } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public QueryStringQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) { @@ -365,7 +461,9 @@ public QueryStringQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) } /// - /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// + /// If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). + /// /// public QueryStringQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true) { @@ -374,7 +472,9 @@ public QueryStringQueryDescriptor FuzzyTranspositions(bool? fuzzyTran } /// - /// If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. + /// + /// If true, format-based errors, such as providing a text value for a numeric field, are ignored. + /// /// public QueryStringQueryDescriptor Lenient(bool? lenient = true) { @@ -383,7 +483,9 @@ public QueryStringQueryDescriptor Lenient(bool? lenient = true) } /// - /// Maximum number of automaton states required for the query. + /// + /// Maximum number of automaton states required for the query. + /// /// public QueryStringQueryDescriptor MaxDeterminizedStates(int? maxDeterminizedStates) { @@ -392,7 +494,9 @@ public QueryStringQueryDescriptor MaxDeterminizedStates(int? maxDeter } /// - /// Minimum number of clauses that must match for a document to be returned. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// /// public QueryStringQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { @@ -401,7 +505,9 @@ public QueryStringQueryDescriptor MinimumShouldMatch(Elastic.Clients. } /// - /// Maximum number of positions allowed between matching tokens for phrases. + /// + /// Maximum number of positions allowed between matching tokens for phrases. + /// /// public QueryStringQueryDescriptor PhraseSlop(double? phraseSlop) { @@ -410,7 +516,9 @@ public QueryStringQueryDescriptor PhraseSlop(double? phraseSlop) } /// - /// Query string you wish to parse and use for search. + /// + /// Query string you wish to parse and use for search. + /// /// public QueryStringQueryDescriptor Query(string query) { @@ -425,7 +533,10 @@ public QueryStringQueryDescriptor QueryName(string? queryName) } /// - /// Analyzer used to convert quoted text in the query string into tokens.
For quoted text, this parameter overrides the analyzer specified in the `analyzer` parameter. + /// + /// Analyzer used to convert quoted text in the query string into tokens. + /// For quoted text, this parameter overrides the analyzer specified in the analyzer parameter. + /// /// public QueryStringQueryDescriptor QuoteAnalyzer(string? quoteAnalyzer) { @@ -434,7 +545,10 @@ public QueryStringQueryDescriptor QuoteAnalyzer(string? quoteAnalyzer } /// - /// Suffix appended to quoted text in the query string.
You can use this suffix to use a different analysis method for exact matches. + /// + /// Suffix appended to quoted text in the query string. + /// You can use this suffix to use a different analysis method for exact matches. + /// /// public QueryStringQueryDescriptor QuoteFieldSuffix(string? quoteFieldSuffix) { @@ -443,7 +557,9 @@ public QueryStringQueryDescriptor QuoteFieldSuffix(string? quoteField } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public QueryStringQueryDescriptor Rewrite(string? rewrite) { @@ -452,7 +568,9 @@ public QueryStringQueryDescriptor Rewrite(string? rewrite) } /// - /// How to combine the queries generated from the individual search terms in the resulting `dis_max` query. + /// + /// How to combine the queries generated from the individual search terms in the resulting dis_max query. + /// /// public QueryStringQueryDescriptor TieBreaker(double? tieBreaker) { @@ -461,7 +579,9 @@ public QueryStringQueryDescriptor TieBreaker(double? tieBreaker) } /// - /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query string to UTC. + /// + /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query string to UTC. + /// /// public QueryStringQueryDescriptor TimeZone(string? timeZone) { @@ -470,7 +590,9 @@ public QueryStringQueryDescriptor TimeZone(string? timeZone) } /// - /// Determines how the query matches and scores documents. + /// + /// Determines how the query matches and scores documents. + /// /// public QueryStringQueryDescriptor Type(Elastic.Clients.Elasticsearch.QueryDsl.TextQueryType? type) { @@ -680,7 +802,9 @@ public QueryStringQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.QueryDsl.TextQueryType? TypeValue { get; set; } /// - /// If `true`, the wildcard characters `*` and `?` are allowed as the first character of the query string. + /// + /// If true, the wildcard characters * and ? are allowed as the first character of the query string. + /// /// public QueryStringQueryDescriptor AllowLeadingWildcard(bool? allowLeadingWildcard = true) { @@ -689,7 +813,9 @@ public QueryStringQueryDescriptor AllowLeadingWildcard(bool? allowLeadingWildcar } /// - /// Analyzer used to convert text in the query string into tokens. + /// + /// Analyzer used to convert text in the query string into tokens. + /// /// public QueryStringQueryDescriptor Analyzer(string? analyzer) { @@ -698,7 +824,9 @@ public QueryStringQueryDescriptor Analyzer(string? analyzer) } /// - /// If `true`, the query attempts to analyze wildcard terms in the query string. + /// + /// If true, the query attempts to analyze wildcard terms in the query string. + /// /// public QueryStringQueryDescriptor AnalyzeWildcard(bool? analyzeWildcard = true) { @@ -707,7 +835,9 @@ public QueryStringQueryDescriptor AnalyzeWildcard(bool? analyzeWildcard = true) } /// - /// If `true`, match phrase queries are automatically created for multi-term synonyms. + /// + /// If true, match phrase queries are automatically created for multi-term synonyms. + /// /// public QueryStringQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSynonymsPhraseQuery = true) { @@ -716,7 +846,12 @@ public QueryStringQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGene } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public QueryStringQueryDescriptor Boost(float? boost) { @@ -725,7 +860,11 @@ public QueryStringQueryDescriptor Boost(float? boost) } /// - /// Default field to search if no field is provided in the query string.
Supports wildcards (`*`).
Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + /// + /// Default field to search if no field is provided in the query string. + /// Supports wildcards (*). + /// Defaults to the index.query.default_field index setting, which has a default value of *. + /// /// public QueryStringQueryDescriptor DefaultField(Elastic.Clients.Elasticsearch.Field? defaultField) { @@ -734,7 +873,11 @@ public QueryStringQueryDescriptor DefaultField(Elastic.Clients.Elasticsearch.Fie } /// - /// Default field to search if no field is provided in the query string.
Supports wildcards (`*`).
Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + /// + /// Default field to search if no field is provided in the query string. + /// Supports wildcards (*). + /// Defaults to the index.query.default_field index setting, which has a default value of *. + /// /// public QueryStringQueryDescriptor DefaultField(Expression> defaultField) { @@ -743,7 +886,11 @@ public QueryStringQueryDescriptor DefaultField(Expression - /// Default field to search if no field is provided in the query string.
Supports wildcards (`*`).
Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + /// + /// Default field to search if no field is provided in the query string. + /// Supports wildcards (*). + /// Defaults to the index.query.default_field index setting, which has a default value of *. + /// /// public QueryStringQueryDescriptor DefaultField(Expression> defaultField) { @@ -752,7 +899,9 @@ public QueryStringQueryDescriptor DefaultField(Expression - /// Default boolean logic used to interpret text in the query string if no operators are specified. + /// + /// Default boolean logic used to interpret text in the query string if no operators are specified. + /// /// public QueryStringQueryDescriptor DefaultOperator(Elastic.Clients.Elasticsearch.QueryDsl.Operator? defaultOperator) { @@ -761,7 +910,9 @@ public QueryStringQueryDescriptor DefaultOperator(Elastic.Clients.Elasticsearch. } /// - /// If `true`, enable position increments in queries constructed from a `query_string` search. + /// + /// If true, enable position increments in queries constructed from a query_string search. + /// /// public QueryStringQueryDescriptor EnablePositionIncrements(bool? enablePositionIncrements = true) { @@ -776,7 +927,9 @@ public QueryStringQueryDescriptor Escape(bool? escape = true) } /// - /// Array of fields to search. Supports wildcards (`*`). + /// + /// Array of fields to search. Supports wildcards (*). + /// /// public QueryStringQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Fields? fields) { @@ -785,7 +938,9 @@ public QueryStringQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Fields? f } /// - /// Maximum edit distance allowed for fuzzy matching. + /// + /// Maximum edit distance allowed for fuzzy matching. + /// /// public QueryStringQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzziness? fuzziness) { @@ -794,7 +949,9 @@ public QueryStringQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzzin } /// - /// Maximum number of terms to which the query expands for fuzzy matching. + /// + /// Maximum number of terms to which the query expands for fuzzy matching. + /// /// public QueryStringQueryDescriptor FuzzyMaxExpansions(int? fuzzyMaxExpansions) { @@ -803,7 +960,9 @@ public QueryStringQueryDescriptor FuzzyMaxExpansions(int? fuzzyMaxExpansions) } /// - /// Number of beginning characters left unchanged for fuzzy matching. + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// /// public QueryStringQueryDescriptor FuzzyPrefixLength(int? fuzzyPrefixLength) { @@ -812,7 +971,9 @@ public QueryStringQueryDescriptor FuzzyPrefixLength(int? fuzzyPrefixLength) } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public QueryStringQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) { @@ -821,7 +982,9 @@ public QueryStringQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) } /// - /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// + /// If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). + /// /// public QueryStringQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true) { @@ -830,7 +993,9 @@ public QueryStringQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions } /// - /// If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. + /// + /// If true, format-based errors, such as providing a text value for a numeric field, are ignored. + /// /// public QueryStringQueryDescriptor Lenient(bool? lenient = true) { @@ -839,7 +1004,9 @@ public QueryStringQueryDescriptor Lenient(bool? lenient = true) } /// - /// Maximum number of automaton states required for the query. + /// + /// Maximum number of automaton states required for the query. + /// /// public QueryStringQueryDescriptor MaxDeterminizedStates(int? maxDeterminizedStates) { @@ -848,7 +1015,9 @@ public QueryStringQueryDescriptor MaxDeterminizedStates(int? maxDeterminizedStat } /// - /// Minimum number of clauses that must match for a document to be returned. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// /// public QueryStringQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { @@ -857,7 +1026,9 @@ public QueryStringQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsear } /// - /// Maximum number of positions allowed between matching tokens for phrases. + /// + /// Maximum number of positions allowed between matching tokens for phrases. + /// /// public QueryStringQueryDescriptor PhraseSlop(double? phraseSlop) { @@ -866,7 +1037,9 @@ public QueryStringQueryDescriptor PhraseSlop(double? phraseSlop) } /// - /// Query string you wish to parse and use for search. + /// + /// Query string you wish to parse and use for search. + /// /// public QueryStringQueryDescriptor Query(string query) { @@ -881,7 +1054,10 @@ public QueryStringQueryDescriptor QueryName(string? queryName) } /// - /// Analyzer used to convert quoted text in the query string into tokens.
For quoted text, this parameter overrides the analyzer specified in the `analyzer` parameter. + /// + /// Analyzer used to convert quoted text in the query string into tokens. + /// For quoted text, this parameter overrides the analyzer specified in the analyzer parameter. + /// /// public QueryStringQueryDescriptor QuoteAnalyzer(string? quoteAnalyzer) { @@ -890,7 +1066,10 @@ public QueryStringQueryDescriptor QuoteAnalyzer(string? quoteAnalyzer) } /// - /// Suffix appended to quoted text in the query string.
You can use this suffix to use a different analysis method for exact matches. + /// + /// Suffix appended to quoted text in the query string. + /// You can use this suffix to use a different analysis method for exact matches. + /// /// public QueryStringQueryDescriptor QuoteFieldSuffix(string? quoteFieldSuffix) { @@ -899,7 +1078,9 @@ public QueryStringQueryDescriptor QuoteFieldSuffix(string? quoteFieldSuffix) } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public QueryStringQueryDescriptor Rewrite(string? rewrite) { @@ -908,7 +1089,9 @@ public QueryStringQueryDescriptor Rewrite(string? rewrite) } /// - /// How to combine the queries generated from the individual search terms in the resulting `dis_max` query. + /// + /// How to combine the queries generated from the individual search terms in the resulting dis_max query. + /// /// public QueryStringQueryDescriptor TieBreaker(double? tieBreaker) { @@ -917,7 +1100,9 @@ public QueryStringQueryDescriptor TieBreaker(double? tieBreaker) } /// - /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query string to UTC. + /// + /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query string to UTC. + /// /// public QueryStringQueryDescriptor TimeZone(string? timeZone) { @@ -926,7 +1111,9 @@ public QueryStringQueryDescriptor TimeZone(string? timeZone) } /// - /// Determines how the query matches and scores documents. + /// + /// Determines how the query matches and scores documents. + /// /// public QueryStringQueryDescriptor Type(Elastic.Clients.Elasticsearch.QueryDsl.TextQueryType? type) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureFunctionLogarithm.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureFunctionLogarithm.g.cs index 48de8b00f02..87715f57f1b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureFunctionLogarithm.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureFunctionLogarithm.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class RankFeatureFunctionLogarithm { /// - /// Configurable scaling factor. + /// + /// Configurable scaling factor. + /// /// [JsonInclude, JsonPropertyName("scaling_factor")] public float ScalingFactor { get; set; } @@ -47,7 +49,9 @@ public RankFeatureFunctionLogarithmDescriptor() : base() private float ScalingFactorValue { get; set; } /// - /// Configurable scaling factor. + /// + /// Configurable scaling factor. + /// /// public RankFeatureFunctionLogarithmDescriptor ScalingFactor(float scalingFactor) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureFunctionSaturation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureFunctionSaturation.g.cs index dcccf522bba..30dfde4ff0b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureFunctionSaturation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureFunctionSaturation.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class RankFeatureFunctionSaturation { /// - /// Configurable pivot value so that the result will be less than 0.5. + /// + /// Configurable pivot value so that the result will be less than 0.5. + /// /// [JsonInclude, JsonPropertyName("pivot")] public float? Pivot { get; set; } @@ -47,7 +49,9 @@ public RankFeatureFunctionSaturationDescriptor() : base() private float? PivotValue { get; set; } /// - /// Configurable pivot value so that the result will be less than 0.5. + /// + /// Configurable pivot value so that the result will be less than 0.5. + /// /// public RankFeatureFunctionSaturationDescriptor Pivot(float? pivot) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureFunctionSigmoid.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureFunctionSigmoid.g.cs index 27afda9e52b..e14d8ecdf3f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureFunctionSigmoid.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureFunctionSigmoid.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class RankFeatureFunctionSigmoid { /// - /// Configurable Exponent. + /// + /// Configurable Exponent. + /// /// [JsonInclude, JsonPropertyName("exponent")] public float Exponent { get; set; } /// - /// Configurable pivot value so that the result will be less than 0.5. + /// + /// Configurable pivot value so that the result will be less than 0.5. + /// /// [JsonInclude, JsonPropertyName("pivot")] public float Pivot { get; set; } @@ -54,7 +58,9 @@ public RankFeatureFunctionSigmoidDescriptor() : base() private float PivotValue { get; set; } /// - /// Configurable Exponent. + /// + /// Configurable Exponent. + /// /// public RankFeatureFunctionSigmoidDescriptor Exponent(float exponent) { @@ -63,7 +69,9 @@ public RankFeatureFunctionSigmoidDescriptor Exponent(float exponent) } /// - /// Configurable pivot value so that the result will be less than 0.5. + /// + /// Configurable pivot value so that the result will be less than 0.5. + /// /// public RankFeatureFunctionSigmoidDescriptor Pivot(float pivot) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureQuery.g.cs index 9a9027700e8..465f5e088ec 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureQuery.g.cs @@ -30,25 +30,36 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class RankFeatureQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// `rank_feature` or `rank_features` field used to boost relevance scores. + /// + /// rank_feature or rank_features field used to boost relevance scores. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Linear function used to boost relevance scores based on the value of the rank feature `field`. + /// + /// Linear function used to boost relevance scores based on the value of the rank feature field. + /// /// [JsonInclude, JsonPropertyName("linear")] public Elastic.Clients.Elasticsearch.QueryDsl.RankFeatureFunctionLinear? Linear { get; set; } /// - /// Logarithmic function used to boost relevance scores based on the value of the rank feature `field`. + /// + /// Logarithmic function used to boost relevance scores based on the value of the rank feature field. + /// /// [JsonInclude, JsonPropertyName("log")] public Elastic.Clients.Elasticsearch.QueryDsl.RankFeatureFunctionLogarithm? Log { get; set; } @@ -56,13 +67,17 @@ public sealed partial class RankFeatureQuery public string? QueryName { get; set; } /// - /// Saturation function used to boost relevance scores based on the value of the rank feature `field`. + /// + /// Saturation function used to boost relevance scores based on the value of the rank feature field. + /// /// [JsonInclude, JsonPropertyName("saturation")] public Elastic.Clients.Elasticsearch.QueryDsl.RankFeatureFunctionSaturation? Saturation { get; set; } /// - /// Sigmoid function used to boost relevance scores based on the value of the rank feature `field`. + /// + /// Sigmoid function used to boost relevance scores based on the value of the rank feature field. + /// /// [JsonInclude, JsonPropertyName("sigmoid")] public Elastic.Clients.Elasticsearch.QueryDsl.RankFeatureFunctionSigmoid? Sigmoid { get; set; } @@ -95,7 +110,12 @@ public RankFeatureQueryDescriptor() : base() private Action SigmoidDescriptorAction { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public RankFeatureQueryDescriptor Boost(float? boost) { @@ -104,7 +124,9 @@ public RankFeatureQueryDescriptor Boost(float? boost) } /// - /// `rank_feature` or `rank_features` field used to boost relevance scores. + /// + /// rank_feature or rank_features field used to boost relevance scores. + /// /// public RankFeatureQueryDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -113,7 +135,9 @@ public RankFeatureQueryDescriptor Field(Elastic.Clients.Elasticsearch } /// - /// `rank_feature` or `rank_features` field used to boost relevance scores. + /// + /// rank_feature or rank_features field used to boost relevance scores. + /// /// public RankFeatureQueryDescriptor Field(Expression> field) { @@ -122,7 +146,9 @@ public RankFeatureQueryDescriptor Field(Expression - /// `rank_feature` or `rank_features` field used to boost relevance scores. + /// + /// rank_feature or rank_features field used to boost relevance scores. + /// /// public RankFeatureQueryDescriptor Field(Expression> field) { @@ -131,7 +157,9 @@ public RankFeatureQueryDescriptor Field(Expression - /// Linear function used to boost relevance scores based on the value of the rank feature `field`. + /// + /// Linear function used to boost relevance scores based on the value of the rank feature field. + /// /// public RankFeatureQueryDescriptor Linear(Elastic.Clients.Elasticsearch.QueryDsl.RankFeatureFunctionLinear? linear) { @@ -158,7 +186,9 @@ public RankFeatureQueryDescriptor Linear(Action - /// Logarithmic function used to boost relevance scores based on the value of the rank feature `field`. + /// + /// Logarithmic function used to boost relevance scores based on the value of the rank feature field. + /// /// public RankFeatureQueryDescriptor Log(Elastic.Clients.Elasticsearch.QueryDsl.RankFeatureFunctionLogarithm? log) { @@ -191,7 +221,9 @@ public RankFeatureQueryDescriptor QueryName(string? queryName) } /// - /// Saturation function used to boost relevance scores based on the value of the rank feature `field`. + /// + /// Saturation function used to boost relevance scores based on the value of the rank feature field. + /// /// public RankFeatureQueryDescriptor Saturation(Elastic.Clients.Elasticsearch.QueryDsl.RankFeatureFunctionSaturation? saturation) { @@ -218,7 +250,9 @@ public RankFeatureQueryDescriptor Saturation(Action - /// Sigmoid function used to boost relevance scores based on the value of the rank feature `field`. + /// + /// Sigmoid function used to boost relevance scores based on the value of the rank feature field. + /// /// public RankFeatureQueryDescriptor Sigmoid(Elastic.Clients.Elasticsearch.QueryDsl.RankFeatureFunctionSigmoid? sigmoid) { @@ -354,7 +388,12 @@ public RankFeatureQueryDescriptor() : base() private Action SigmoidDescriptorAction { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public RankFeatureQueryDescriptor Boost(float? boost) { @@ -363,7 +402,9 @@ public RankFeatureQueryDescriptor Boost(float? boost) } /// - /// `rank_feature` or `rank_features` field used to boost relevance scores. + /// + /// rank_feature or rank_features field used to boost relevance scores. + /// /// public RankFeatureQueryDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -372,7 +413,9 @@ public RankFeatureQueryDescriptor Field(Elastic.Clients.Elasticsearch.Field fiel } /// - /// `rank_feature` or `rank_features` field used to boost relevance scores. + /// + /// rank_feature or rank_features field used to boost relevance scores. + /// /// public RankFeatureQueryDescriptor Field(Expression> field) { @@ -381,7 +424,9 @@ public RankFeatureQueryDescriptor Field(Expression - /// `rank_feature` or `rank_features` field used to boost relevance scores. + /// + /// rank_feature or rank_features field used to boost relevance scores. + /// /// public RankFeatureQueryDescriptor Field(Expression> field) { @@ -390,7 +435,9 @@ public RankFeatureQueryDescriptor Field(Expression - /// Linear function used to boost relevance scores based on the value of the rank feature `field`. + /// + /// Linear function used to boost relevance scores based on the value of the rank feature field. + /// /// public RankFeatureQueryDescriptor Linear(Elastic.Clients.Elasticsearch.QueryDsl.RankFeatureFunctionLinear? linear) { @@ -417,7 +464,9 @@ public RankFeatureQueryDescriptor Linear(Action - /// Logarithmic function used to boost relevance scores based on the value of the rank feature `field`. + /// + /// Logarithmic function used to boost relevance scores based on the value of the rank feature field. + /// /// public RankFeatureQueryDescriptor Log(Elastic.Clients.Elasticsearch.QueryDsl.RankFeatureFunctionLogarithm? log) { @@ -450,7 +499,9 @@ public RankFeatureQueryDescriptor QueryName(string? queryName) } /// - /// Saturation function used to boost relevance scores based on the value of the rank feature `field`. + /// + /// Saturation function used to boost relevance scores based on the value of the rank feature field. + /// /// public RankFeatureQueryDescriptor Saturation(Elastic.Clients.Elasticsearch.QueryDsl.RankFeatureFunctionSaturation? saturation) { @@ -477,7 +528,9 @@ public RankFeatureQueryDescriptor Saturation(Action - /// Sigmoid function used to boost relevance scores based on the value of the rank feature `field`. + /// + /// Sigmoid function used to boost relevance scores based on the value of the rank feature field. + /// /// public RankFeatureQueryDescriptor Sigmoid(Elastic.Clients.Elasticsearch.QueryDsl.RankFeatureFunctionSigmoid? sigmoid) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RegexpQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RegexpQuery.g.cs index 1360294e7f0..4d47a0cbec5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RegexpQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RegexpQuery.g.cs @@ -153,34 +153,50 @@ public RegexpQuery(Elastic.Clients.Elasticsearch.Field field) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } /// - /// Allows case insensitive matching of the regular expression value with the indexed field values when set to `true`.
When `false`, case sensitivity of matching depends on the underlying field’s mapping. + /// + /// Allows case insensitive matching of the regular expression value with the indexed field values when set to true. + /// When false, case sensitivity of matching depends on the underlying field’s mapping. + /// /// public bool? CaseInsensitive { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Enables optional operators for the regular expression. + /// + /// Enables optional operators for the regular expression. + /// /// public string? Flags { get; set; } /// - /// Maximum number of automaton states required for the query. + /// + /// Maximum number of automaton states required for the query. + /// /// public int? MaxDeterminizedStates { get; set; } public string? QueryName { get; set; } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public string? Rewrite { get; set; } /// - /// Regular expression for terms you wish to find in the provided field. + /// + /// Regular expression for terms you wish to find in the provided field. + /// /// public string Value { get; set; } @@ -205,7 +221,12 @@ public RegexpQueryDescriptor() : base() private string ValueValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public RegexpQueryDescriptor Boost(float? boost) { @@ -214,7 +235,10 @@ public RegexpQueryDescriptor Boost(float? boost) } /// - /// Allows case insensitive matching of the regular expression value with the indexed field values when set to `true`.
When `false`, case sensitivity of matching depends on the underlying field’s mapping. + /// + /// Allows case insensitive matching of the regular expression value with the indexed field values when set to true. + /// When false, case sensitivity of matching depends on the underlying field’s mapping. + /// /// public RegexpQueryDescriptor CaseInsensitive(bool? caseInsensitive = true) { @@ -241,7 +265,9 @@ public RegexpQueryDescriptor Field(Expression } /// - /// Enables optional operators for the regular expression. + /// + /// Enables optional operators for the regular expression. + /// /// public RegexpQueryDescriptor Flags(string? flags) { @@ -250,7 +276,9 @@ public RegexpQueryDescriptor Flags(string? flags) } /// - /// Maximum number of automaton states required for the query. + /// + /// Maximum number of automaton states required for the query. + /// /// public RegexpQueryDescriptor MaxDeterminizedStates(int? maxDeterminizedStates) { @@ -265,7 +293,9 @@ public RegexpQueryDescriptor QueryName(string? queryName) } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public RegexpQueryDescriptor Rewrite(string? rewrite) { @@ -274,7 +304,9 @@ public RegexpQueryDescriptor Rewrite(string? rewrite) } /// - /// Regular expression for terms you wish to find in the provided field. + /// + /// Regular expression for terms you wish to find in the provided field. + /// /// public RegexpQueryDescriptor Value(string value) { @@ -350,7 +382,12 @@ public RegexpQueryDescriptor() : base() private string ValueValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public RegexpQueryDescriptor Boost(float? boost) { @@ -359,7 +396,10 @@ public RegexpQueryDescriptor Boost(float? boost) } /// - /// Allows case insensitive matching of the regular expression value with the indexed field values when set to `true`.
When `false`, case sensitivity of matching depends on the underlying field’s mapping. + /// + /// Allows case insensitive matching of the regular expression value with the indexed field values when set to true. + /// When false, case sensitivity of matching depends on the underlying field’s mapping. + /// /// public RegexpQueryDescriptor CaseInsensitive(bool? caseInsensitive = true) { @@ -386,7 +426,9 @@ public RegexpQueryDescriptor Field(Expression } /// - /// Enables optional operators for the regular expression. + /// + /// Enables optional operators for the regular expression. + /// /// public RegexpQueryDescriptor Flags(string? flags) { @@ -395,7 +437,9 @@ public RegexpQueryDescriptor Flags(string? flags) } /// - /// Maximum number of automaton states required for the query. + /// + /// Maximum number of automaton states required for the query. + /// /// public RegexpQueryDescriptor MaxDeterminizedStates(int? maxDeterminizedStates) { @@ -410,7 +454,9 @@ public RegexpQueryDescriptor QueryName(string? queryName) } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public RegexpQueryDescriptor Rewrite(string? rewrite) { @@ -419,7 +465,9 @@ public RegexpQueryDescriptor Rewrite(string? rewrite) } /// - /// Regular expression for terms you wish to find in the provided field. + /// + /// Regular expression for terms you wish to find in the provided field. + /// /// public RegexpQueryDescriptor Value(string value) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RuleQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RuleQuery.g.cs index af6daf97bd6..36f59b913f3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RuleQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RuleQuery.g.cs @@ -30,7 +30,12 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class RuleQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } @@ -63,7 +68,12 @@ public RuleQueryDescriptor() : base() private ICollection RulesetIdsValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public RuleQueryDescriptor Boost(float? boost) { @@ -169,7 +179,12 @@ public RuleQueryDescriptor() : base() private ICollection RulesetIdsValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public RuleQueryDescriptor Boost(float? boost) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ScriptQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ScriptQuery.g.cs index 6b8b02e46fe..1e152a3caae 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ScriptQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ScriptQuery.g.cs @@ -30,7 +30,12 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class ScriptQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } @@ -38,7 +43,10 @@ public sealed partial class ScriptQuery public string? QueryName { get; set; } /// - /// Contains a script to run as a query.
This script must return a boolean value, `true` or `false`. + /// + /// Contains a script to run as a query. + /// This script must return a boolean value, true or false. + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Script Script { get; set; } @@ -61,7 +69,12 @@ public ScriptQueryDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public ScriptQueryDescriptor Boost(float? boost) { @@ -76,7 +89,10 @@ public ScriptQueryDescriptor QueryName(string? queryName) } /// - /// Contains a script to run as a query.
This script must return a boolean value, `true` or `false`. + /// + /// Contains a script to run as a query. + /// This script must return a boolean value, true or false. + /// /// public ScriptQueryDescriptor Script(Elastic.Clients.Elasticsearch.Script script) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ScriptScoreFunction.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ScriptScoreFunction.g.cs index a158a2176f6..a6df27b8a0b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ScriptScoreFunction.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ScriptScoreFunction.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class ScriptScoreFunction { /// - /// A script that computes a score. + /// + /// A script that computes a score. + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Script Script { get; set; } @@ -51,7 +53,9 @@ public ScriptScoreFunctionDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// A script that computes a score. + /// + /// A script that computes a score. + /// /// public ScriptScoreFunctionDescriptor Script(Elastic.Clients.Elasticsearch.Script script) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ScriptScoreQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ScriptScoreQuery.g.cs index f3563a0d307..351a940d4f8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ScriptScoreQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ScriptScoreQuery.g.cs @@ -30,19 +30,28 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class ScriptScoreQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Documents with a score lower than this floating point number are excluded from the search results. + /// + /// Documents with a score lower than this floating point number are excluded from the search results. + /// /// [JsonInclude, JsonPropertyName("min_score")] public float? MinScore { get; set; } /// - /// Query used to return documents. + /// + /// Query used to return documents. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query Query { get; set; } @@ -50,7 +59,10 @@ public sealed partial class ScriptScoreQuery public string? QueryName { get; set; } /// - /// Script used to compute the score of documents returned by the query.
Important: final relevance scores from the `script_score` query cannot be negative. + /// + /// Script used to compute the score of documents returned by the query. + /// Important: final relevance scores from the script_score query cannot be negative. + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Script Script { get; set; } @@ -77,7 +89,12 @@ public ScriptScoreQueryDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public ScriptScoreQueryDescriptor Boost(float? boost) { @@ -86,7 +103,9 @@ public ScriptScoreQueryDescriptor Boost(float? boost) } /// - /// Documents with a score lower than this floating point number are excluded from the search results. + /// + /// Documents with a score lower than this floating point number are excluded from the search results. + /// /// public ScriptScoreQueryDescriptor MinScore(float? minScore) { @@ -95,7 +114,9 @@ public ScriptScoreQueryDescriptor MinScore(float? minScore) } /// - /// Query used to return documents. + /// + /// Query used to return documents. + /// /// public ScriptScoreQueryDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query query) { @@ -128,7 +149,10 @@ public ScriptScoreQueryDescriptor QueryName(string? queryName) } /// - /// Script used to compute the score of documents returned by the query.
Important: final relevance scores from the `script_score` query cannot be negative. + /// + /// Script used to compute the score of documents returned by the query. + /// Important: final relevance scores from the script_score query cannot be negative. + /// /// public ScriptScoreQueryDescriptor Script(Elastic.Clients.Elasticsearch.Script script) { @@ -230,7 +254,12 @@ public ScriptScoreQueryDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public ScriptScoreQueryDescriptor Boost(float? boost) { @@ -239,7 +268,9 @@ public ScriptScoreQueryDescriptor Boost(float? boost) } /// - /// Documents with a score lower than this floating point number are excluded from the search results. + /// + /// Documents with a score lower than this floating point number are excluded from the search results. + /// /// public ScriptScoreQueryDescriptor MinScore(float? minScore) { @@ -248,7 +279,9 @@ public ScriptScoreQueryDescriptor MinScore(float? minScore) } /// - /// Query used to return documents. + /// + /// Query used to return documents. + /// /// public ScriptScoreQueryDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query query) { @@ -281,7 +314,10 @@ public ScriptScoreQueryDescriptor QueryName(string? queryName) } /// - /// Script used to compute the score of documents returned by the query.
Important: final relevance scores from the `script_score` query cannot be negative. + /// + /// Script used to compute the score of documents returned by the query. + /// Important: final relevance scores from the script_score query cannot be negative. + /// /// public ScriptScoreQueryDescriptor Script(Elastic.Clients.Elasticsearch.Script script) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ShapeFieldQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ShapeFieldQuery.g.cs index bf0cd8eb497..1b2ce8fb269 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ShapeFieldQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ShapeFieldQuery.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class ShapeFieldQuery { /// - /// Queries using a pre-indexed shape. + /// + /// Queries using a pre-indexed shape. + /// /// [JsonInclude, JsonPropertyName("indexed_shape")] public Elastic.Clients.Elasticsearch.QueryDsl.FieldLookup? IndexedShape { get; set; } /// - /// Spatial relation between the query shape and the document shape. + /// + /// Spatial relation between the query shape and the document shape. + /// /// [JsonInclude, JsonPropertyName("relation")] public Elastic.Clients.Elasticsearch.GeoShapeRelation? Relation { get; set; } /// - /// Queries using an inline shape definition in GeoJSON or Well Known Text (WKT) format. + /// + /// Queries using an inline shape definition in GeoJSON or Well Known Text (WKT) format. + /// /// [JsonInclude, JsonPropertyName("shape")] public object? Shape { get; set; } @@ -63,7 +69,9 @@ public ShapeFieldQueryDescriptor() : base() private object? ShapeValue { get; set; } /// - /// Queries using a pre-indexed shape. + /// + /// Queries using a pre-indexed shape. + /// /// public ShapeFieldQueryDescriptor IndexedShape(Elastic.Clients.Elasticsearch.QueryDsl.FieldLookup? indexedShape) { @@ -90,7 +98,9 @@ public ShapeFieldQueryDescriptor IndexedShape(Action - /// Spatial relation between the query shape and the document shape. + /// + /// Spatial relation between the query shape and the document shape. + /// /// public ShapeFieldQueryDescriptor Relation(Elastic.Clients.Elasticsearch.GeoShapeRelation? relation) { @@ -99,7 +109,9 @@ public ShapeFieldQueryDescriptor Relation(Elastic.Clients.Elasticsear } /// - /// Queries using an inline shape definition in GeoJSON or Well Known Text (WKT) format. + /// + /// Queries using an inline shape definition in GeoJSON or Well Known Text (WKT) format. + /// /// public ShapeFieldQueryDescriptor Shape(object? shape) { @@ -157,7 +169,9 @@ public ShapeFieldQueryDescriptor() : base() private object? ShapeValue { get; set; } /// - /// Queries using a pre-indexed shape. + /// + /// Queries using a pre-indexed shape. + /// /// public ShapeFieldQueryDescriptor IndexedShape(Elastic.Clients.Elasticsearch.QueryDsl.FieldLookup? indexedShape) { @@ -184,7 +198,9 @@ public ShapeFieldQueryDescriptor IndexedShape(Action - /// Spatial relation between the query shape and the document shape. + /// + /// Spatial relation between the query shape and the document shape. + /// /// public ShapeFieldQueryDescriptor Relation(Elastic.Clients.Elasticsearch.GeoShapeRelation? relation) { @@ -193,7 +209,9 @@ public ShapeFieldQueryDescriptor Relation(Elastic.Clients.Elasticsearch.GeoShape } /// - /// Queries using an inline shape definition in GeoJSON or Well Known Text (WKT) format. + /// + /// Queries using an inline shape definition in GeoJSON or Well Known Text (WKT) format. + /// /// public ShapeFieldQueryDescriptor Shape(object? shape) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ShapeQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ShapeQuery.g.cs index 22ee5128a20..9b313e9a20a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ShapeQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ShapeQuery.g.cs @@ -107,13 +107,20 @@ public override void Write(Utf8JsonWriter writer, ShapeQuery value, JsonSerializ public sealed partial class ShapeQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// When set to `true` the query ignores an unmapped field and will not match any documents. + /// + /// When set to true the query ignores an unmapped field and will not match any documents. + /// /// public bool? IgnoreUnmapped { get; set; } public string? QueryName { get; set; } @@ -139,7 +146,12 @@ public ShapeQueryDescriptor() : base() private Action> ShapeDescriptorAction { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public ShapeQueryDescriptor Boost(float? boost) { @@ -166,7 +178,9 @@ public ShapeQueryDescriptor Field(Expression> } /// - /// When set to `true` the query ignores an unmapped field and will not match any documents. + /// + /// When set to true the query ignores an unmapped field and will not match any documents. + /// /// public ShapeQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { @@ -253,7 +267,12 @@ public ShapeQueryDescriptor() : base() private Action ShapeDescriptorAction { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public ShapeQueryDescriptor Boost(float? boost) { @@ -280,7 +299,9 @@ public ShapeQueryDescriptor Field(Expression> } /// - /// When set to `true` the query ignores an unmapped field and will not match any documents. + /// + /// When set to true the query ignores an unmapped field and will not match any documents. + /// /// public ShapeQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SimpleQueryStringQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SimpleQueryStringQuery.g.cs index 9a3ebf84ee1..99c7c81fcd0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SimpleQueryStringQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SimpleQueryStringQuery.g.cs @@ -30,80 +30,112 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class SimpleQueryStringQuery { /// - /// Analyzer used to convert text in the query string into tokens. + /// + /// Analyzer used to convert text in the query string into tokens. + /// /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } /// - /// If `true`, the query attempts to analyze wildcard terms in the query string. + /// + /// If true, the query attempts to analyze wildcard terms in the query string. + /// /// [JsonInclude, JsonPropertyName("analyze_wildcard")] public bool? AnalyzeWildcard { get; set; } /// - /// If `true`, the parser creates a match_phrase query for each multi-position token. + /// + /// If true, the parser creates a match_phrase query for each multi-position token. + /// /// [JsonInclude, JsonPropertyName("auto_generate_synonyms_phrase_query")] public bool? AutoGenerateSynonymsPhraseQuery { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Default boolean logic used to interpret text in the query string if no operators are specified. + /// + /// Default boolean logic used to interpret text in the query string if no operators are specified. + /// /// [JsonInclude, JsonPropertyName("default_operator")] public Elastic.Clients.Elasticsearch.QueryDsl.Operator? DefaultOperator { get; set; } /// - /// Array of fields you wish to search.
Accepts wildcard expressions.
You also can boost relevance scores for matches to particular fields using a caret (`^`) notation.
Defaults to the `index.query.default_field index` setting, which has a default value of `*`. + /// + /// Array of fields you wish to search. + /// Accepts wildcard expressions. + /// You also can boost relevance scores for matches to particular fields using a caret (^) notation. + /// Defaults to the index.query.default_field index setting, which has a default value of *. + /// /// [JsonInclude, JsonPropertyName("fields")] [JsonConverter(typeof(FieldsConverter))] public Elastic.Clients.Elasticsearch.Fields? Fields { get; set; } /// - /// List of enabled operators for the simple query string syntax. + /// + /// List of enabled operators for the simple query string syntax. + /// /// [JsonInclude, JsonPropertyName("flags")] public Elastic.Clients.Elasticsearch.QueryDsl.SimpleQueryStringFlag? Flags { get; set; } /// - /// Maximum number of terms to which the query expands for fuzzy matching. + /// + /// Maximum number of terms to which the query expands for fuzzy matching. + /// /// [JsonInclude, JsonPropertyName("fuzzy_max_expansions")] public int? FuzzyMaxExpansions { get; set; } /// - /// Number of beginning characters left unchanged for fuzzy matching. + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// /// [JsonInclude, JsonPropertyName("fuzzy_prefix_length")] public int? FuzzyPrefixLength { get; set; } /// - /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// + /// If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). + /// /// [JsonInclude, JsonPropertyName("fuzzy_transpositions")] public bool? FuzzyTranspositions { get; set; } /// - /// If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. + /// + /// If true, format-based errors, such as providing a text value for a numeric field, are ignored. + /// /// [JsonInclude, JsonPropertyName("lenient")] public bool? Lenient { get; set; } /// - /// Minimum number of clauses that must match for a document to be returned. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// /// [JsonInclude, JsonPropertyName("minimum_should_match")] public Elastic.Clients.Elasticsearch.MinimumShouldMatch? MinimumShouldMatch { get; set; } /// - /// Query string in the simple query string syntax you wish to parse and use for search. + /// + /// Query string in the simple query string syntax you wish to parse and use for search. + /// /// [JsonInclude, JsonPropertyName("query")] public string Query { get; set; } @@ -111,7 +143,9 @@ public sealed partial class SimpleQueryStringQuery public string? QueryName { get; set; } /// - /// Suffix appended to quoted text in the query string. + /// + /// Suffix appended to quoted text in the query string. + /// /// [JsonInclude, JsonPropertyName("quote_field_suffix")] public string? QuoteFieldSuffix { get; set; } @@ -144,7 +178,9 @@ public SimpleQueryStringQueryDescriptor() : base() private string? QuoteFieldSuffixValue { get; set; } /// - /// Analyzer used to convert text in the query string into tokens. + /// + /// Analyzer used to convert text in the query string into tokens. + /// /// public SimpleQueryStringQueryDescriptor Analyzer(string? analyzer) { @@ -153,7 +189,9 @@ public SimpleQueryStringQueryDescriptor Analyzer(string? analyzer) } /// - /// If `true`, the query attempts to analyze wildcard terms in the query string. + /// + /// If true, the query attempts to analyze wildcard terms in the query string. + /// /// public SimpleQueryStringQueryDescriptor AnalyzeWildcard(bool? analyzeWildcard = true) { @@ -162,7 +200,9 @@ public SimpleQueryStringQueryDescriptor AnalyzeWildcard(bool? analyze } /// - /// If `true`, the parser creates a match_phrase query for each multi-position token. + /// + /// If true, the parser creates a match_phrase query for each multi-position token. + /// /// public SimpleQueryStringQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSynonymsPhraseQuery = true) { @@ -171,7 +211,12 @@ public SimpleQueryStringQueryDescriptor AutoGenerateSynonymsPhraseQue } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SimpleQueryStringQueryDescriptor Boost(float? boost) { @@ -180,7 +225,9 @@ public SimpleQueryStringQueryDescriptor Boost(float? boost) } /// - /// Default boolean logic used to interpret text in the query string if no operators are specified. + /// + /// Default boolean logic used to interpret text in the query string if no operators are specified. + /// /// public SimpleQueryStringQueryDescriptor DefaultOperator(Elastic.Clients.Elasticsearch.QueryDsl.Operator? defaultOperator) { @@ -189,7 +236,12 @@ public SimpleQueryStringQueryDescriptor DefaultOperator(Elastic.Clien } /// - /// Array of fields you wish to search.
Accepts wildcard expressions.
You also can boost relevance scores for matches to particular fields using a caret (`^`) notation.
Defaults to the `index.query.default_field index` setting, which has a default value of `*`. + /// + /// Array of fields you wish to search. + /// Accepts wildcard expressions. + /// You also can boost relevance scores for matches to particular fields using a caret (^) notation. + /// Defaults to the index.query.default_field index setting, which has a default value of *. + /// /// public SimpleQueryStringQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Fields? fields) { @@ -198,7 +250,9 @@ public SimpleQueryStringQueryDescriptor Fields(Elastic.Clients.Elasti } /// - /// List of enabled operators for the simple query string syntax. + /// + /// List of enabled operators for the simple query string syntax. + /// /// public SimpleQueryStringQueryDescriptor Flags(Elastic.Clients.Elasticsearch.QueryDsl.SimpleQueryStringFlag? flags) { @@ -207,7 +261,9 @@ public SimpleQueryStringQueryDescriptor Flags(Elastic.Clients.Elastic } /// - /// Maximum number of terms to which the query expands for fuzzy matching. + /// + /// Maximum number of terms to which the query expands for fuzzy matching. + /// /// public SimpleQueryStringQueryDescriptor FuzzyMaxExpansions(int? fuzzyMaxExpansions) { @@ -216,7 +272,9 @@ public SimpleQueryStringQueryDescriptor FuzzyMaxExpansions(int? fuzzy } /// - /// Number of beginning characters left unchanged for fuzzy matching. + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// /// public SimpleQueryStringQueryDescriptor FuzzyPrefixLength(int? fuzzyPrefixLength) { @@ -225,7 +283,9 @@ public SimpleQueryStringQueryDescriptor FuzzyPrefixLength(int? fuzzyP } /// - /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// + /// If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). + /// /// public SimpleQueryStringQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true) { @@ -234,7 +294,9 @@ public SimpleQueryStringQueryDescriptor FuzzyTranspositions(bool? fuz } /// - /// If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. + /// + /// If true, format-based errors, such as providing a text value for a numeric field, are ignored. + /// /// public SimpleQueryStringQueryDescriptor Lenient(bool? lenient = true) { @@ -243,7 +305,9 @@ public SimpleQueryStringQueryDescriptor Lenient(bool? lenient = true) } /// - /// Minimum number of clauses that must match for a document to be returned. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// /// public SimpleQueryStringQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { @@ -252,7 +316,9 @@ public SimpleQueryStringQueryDescriptor MinimumShouldMatch(Elastic.Cl } /// - /// Query string in the simple query string syntax you wish to parse and use for search. + /// + /// Query string in the simple query string syntax you wish to parse and use for search. + /// /// public SimpleQueryStringQueryDescriptor Query(string query) { @@ -267,7 +333,9 @@ public SimpleQueryStringQueryDescriptor QueryName(string? queryName) } /// - /// Suffix appended to quoted text in the query string. + /// + /// Suffix appended to quoted text in the query string. + /// /// public SimpleQueryStringQueryDescriptor QuoteFieldSuffix(string? quoteFieldSuffix) { @@ -393,7 +461,9 @@ public SimpleQueryStringQueryDescriptor() : base() private string? QuoteFieldSuffixValue { get; set; } /// - /// Analyzer used to convert text in the query string into tokens. + /// + /// Analyzer used to convert text in the query string into tokens. + /// /// public SimpleQueryStringQueryDescriptor Analyzer(string? analyzer) { @@ -402,7 +472,9 @@ public SimpleQueryStringQueryDescriptor Analyzer(string? analyzer) } /// - /// If `true`, the query attempts to analyze wildcard terms in the query string. + /// + /// If true, the query attempts to analyze wildcard terms in the query string. + /// /// public SimpleQueryStringQueryDescriptor AnalyzeWildcard(bool? analyzeWildcard = true) { @@ -411,7 +483,9 @@ public SimpleQueryStringQueryDescriptor AnalyzeWildcard(bool? analyzeWildcard = } /// - /// If `true`, the parser creates a match_phrase query for each multi-position token. + /// + /// If true, the parser creates a match_phrase query for each multi-position token. + /// /// public SimpleQueryStringQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSynonymsPhraseQuery = true) { @@ -420,7 +494,12 @@ public SimpleQueryStringQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? au } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SimpleQueryStringQueryDescriptor Boost(float? boost) { @@ -429,7 +508,9 @@ public SimpleQueryStringQueryDescriptor Boost(float? boost) } /// - /// Default boolean logic used to interpret text in the query string if no operators are specified. + /// + /// Default boolean logic used to interpret text in the query string if no operators are specified. + /// /// public SimpleQueryStringQueryDescriptor DefaultOperator(Elastic.Clients.Elasticsearch.QueryDsl.Operator? defaultOperator) { @@ -438,7 +519,12 @@ public SimpleQueryStringQueryDescriptor DefaultOperator(Elastic.Clients.Elastics } /// - /// Array of fields you wish to search.
Accepts wildcard expressions.
You also can boost relevance scores for matches to particular fields using a caret (`^`) notation.
Defaults to the `index.query.default_field index` setting, which has a default value of `*`. + /// + /// Array of fields you wish to search. + /// Accepts wildcard expressions. + /// You also can boost relevance scores for matches to particular fields using a caret (^) notation. + /// Defaults to the index.query.default_field index setting, which has a default value of *. + /// /// public SimpleQueryStringQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Fields? fields) { @@ -447,7 +533,9 @@ public SimpleQueryStringQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Fie } /// - /// List of enabled operators for the simple query string syntax. + /// + /// List of enabled operators for the simple query string syntax. + /// /// public SimpleQueryStringQueryDescriptor Flags(Elastic.Clients.Elasticsearch.QueryDsl.SimpleQueryStringFlag? flags) { @@ -456,7 +544,9 @@ public SimpleQueryStringQueryDescriptor Flags(Elastic.Clients.Elasticsearch.Quer } /// - /// Maximum number of terms to which the query expands for fuzzy matching. + /// + /// Maximum number of terms to which the query expands for fuzzy matching. + /// /// public SimpleQueryStringQueryDescriptor FuzzyMaxExpansions(int? fuzzyMaxExpansions) { @@ -465,7 +555,9 @@ public SimpleQueryStringQueryDescriptor FuzzyMaxExpansions(int? fuzzyMaxExpansio } /// - /// Number of beginning characters left unchanged for fuzzy matching. + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// /// public SimpleQueryStringQueryDescriptor FuzzyPrefixLength(int? fuzzyPrefixLength) { @@ -474,7 +566,9 @@ public SimpleQueryStringQueryDescriptor FuzzyPrefixLength(int? fuzzyPrefixLength } /// - /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// + /// If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). + /// /// public SimpleQueryStringQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true) { @@ -483,7 +577,9 @@ public SimpleQueryStringQueryDescriptor FuzzyTranspositions(bool? fuzzyTransposi } /// - /// If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. + /// + /// If true, format-based errors, such as providing a text value for a numeric field, are ignored. + /// /// public SimpleQueryStringQueryDescriptor Lenient(bool? lenient = true) { @@ -492,7 +588,9 @@ public SimpleQueryStringQueryDescriptor Lenient(bool? lenient = true) } /// - /// Minimum number of clauses that must match for a document to be returned. + /// + /// Minimum number of clauses that must match for a document to be returned. + /// /// public SimpleQueryStringQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { @@ -501,7 +599,9 @@ public SimpleQueryStringQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elast } /// - /// Query string in the simple query string syntax you wish to parse and use for search. + /// + /// Query string in the simple query string syntax you wish to parse and use for search. + /// /// public SimpleQueryStringQueryDescriptor Query(string query) { @@ -516,7 +616,9 @@ public SimpleQueryStringQueryDescriptor QueryName(string? queryName) } /// - /// Suffix appended to quoted text in the query string. + /// + /// Suffix appended to quoted text in the query string. + /// /// public SimpleQueryStringQueryDescriptor QuoteFieldSuffix(string? quoteFieldSuffix) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanContainingQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanContainingQuery.g.cs index 39eb753ccee..a5390343656 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanContainingQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanContainingQuery.g.cs @@ -30,19 +30,30 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class SpanContainingQuery { /// - /// Can be any span query.
Matching spans from `big` that contain matches from `little` are returned. + /// + /// Can be any span query. + /// Matching spans from big that contain matches from little are returned. + /// /// [JsonInclude, JsonPropertyName("big")] public Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery Big { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Can be any span query.
Matching spans from `big` that contain matches from `little` are returned. + /// + /// Can be any span query. + /// Matching spans from big that contain matches from little are returned. + /// /// [JsonInclude, JsonPropertyName("little")] public Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery Little { get; set; } @@ -71,7 +82,10 @@ public SpanContainingQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Can be any span query.
Matching spans from `big` that contain matches from `little` are returned. + /// + /// Can be any span query. + /// Matching spans from big that contain matches from little are returned. + /// /// public SpanContainingQueryDescriptor Big(Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery big) { @@ -98,7 +112,12 @@ public SpanContainingQueryDescriptor Big(Action - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanContainingQueryDescriptor Boost(float? boost) { @@ -107,7 +126,10 @@ public SpanContainingQueryDescriptor Boost(float? boost) } /// - /// Can be any span query.
Matching spans from `big` that contain matches from `little` are returned. + /// + /// Can be any span query. + /// Matching spans from big that contain matches from little are returned. + /// /// public SpanContainingQueryDescriptor Little(Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery little) { @@ -208,7 +230,10 @@ public SpanContainingQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Can be any span query.
Matching spans from `big` that contain matches from `little` are returned. + /// + /// Can be any span query. + /// Matching spans from big that contain matches from little are returned. + /// /// public SpanContainingQueryDescriptor Big(Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery big) { @@ -235,7 +260,12 @@ public SpanContainingQueryDescriptor Big(Action - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanContainingQueryDescriptor Boost(float? boost) { @@ -244,7 +274,10 @@ public SpanContainingQueryDescriptor Boost(float? boost) } /// - /// Can be any span query.
Matching spans from `big` that contain matches from `little` are returned. + /// + /// Can be any span query. + /// Matching spans from big that contain matches from little are returned. + /// /// public SpanContainingQueryDescriptor Little(Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery little) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanFieldMaskingQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanFieldMaskingQuery.g.cs index 02cd992f530..3d39f8c88de 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanFieldMaskingQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanFieldMaskingQuery.g.cs @@ -30,7 +30,12 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class SpanFieldMaskingQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } @@ -61,7 +66,12 @@ public SpanFieldMaskingQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanFieldMaskingQueryDescriptor Boost(float? boost) { @@ -170,7 +180,12 @@ public SpanFieldMaskingQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanFieldMaskingQueryDescriptor Boost(float? boost) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanFirstQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanFirstQuery.g.cs index 73652791045..297e674249e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanFirstQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanFirstQuery.g.cs @@ -30,19 +30,28 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class SpanFirstQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Controls the maximum end position permitted in a match. + /// + /// Controls the maximum end position permitted in a match. + /// /// [JsonInclude, JsonPropertyName("end")] public int End { get; set; } /// - /// Can be any other span type query. + /// + /// Can be any other span type query. + /// /// [JsonInclude, JsonPropertyName("match")] public Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery Match { get; set; } @@ -69,7 +78,12 @@ public SpanFirstQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanFirstQueryDescriptor Boost(float? boost) { @@ -78,7 +92,9 @@ public SpanFirstQueryDescriptor Boost(float? boost) } /// - /// Controls the maximum end position permitted in a match. + /// + /// Controls the maximum end position permitted in a match. + /// /// public SpanFirstQueryDescriptor End(int end) { @@ -87,7 +103,9 @@ public SpanFirstQueryDescriptor End(int end) } /// - /// Can be any other span type query. + /// + /// Can be any other span type query. + /// /// public SpanFirstQueryDescriptor Match(Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery match) { @@ -172,7 +190,12 @@ public SpanFirstQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanFirstQueryDescriptor Boost(float? boost) { @@ -181,7 +204,9 @@ public SpanFirstQueryDescriptor Boost(float? boost) } /// - /// Controls the maximum end position permitted in a match. + /// + /// Controls the maximum end position permitted in a match. + /// /// public SpanFirstQueryDescriptor End(int end) { @@ -190,7 +215,9 @@ public SpanFirstQueryDescriptor End(int end) } /// - /// Can be any other span type query. + /// + /// Can be any other span type query. + /// /// public SpanFirstQueryDescriptor Match(Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery match) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanMultiTermQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanMultiTermQuery.g.cs index a8da29b32ea..5f9210cd9c0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanMultiTermQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanMultiTermQuery.g.cs @@ -30,13 +30,20 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class SpanMultiTermQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Should be a multi term query (one of `wildcard`, `fuzzy`, `prefix`, `range`, or `regexp` query). + /// + /// Should be a multi term query (one of wildcard, fuzzy, prefix, range, or regexp query). + /// /// [JsonInclude, JsonPropertyName("match")] public Elastic.Clients.Elasticsearch.QueryDsl.Query Match { get; set; } @@ -62,7 +69,12 @@ public SpanMultiTermQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanMultiTermQueryDescriptor Boost(float? boost) { @@ -71,7 +83,9 @@ public SpanMultiTermQueryDescriptor Boost(float? boost) } /// - /// Should be a multi term query (one of `wildcard`, `fuzzy`, `prefix`, `range`, or `regexp` query). + /// + /// Should be a multi term query (one of wildcard, fuzzy, prefix, range, or regexp query). + /// /// public SpanMultiTermQueryDescriptor Match(Elastic.Clients.Elasticsearch.QueryDsl.Query match) { @@ -153,7 +167,12 @@ public SpanMultiTermQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanMultiTermQueryDescriptor Boost(float? boost) { @@ -162,7 +181,9 @@ public SpanMultiTermQueryDescriptor Boost(float? boost) } /// - /// Should be a multi term query (one of `wildcard`, `fuzzy`, `prefix`, `range`, or `regexp` query). + /// + /// Should be a multi term query (one of wildcard, fuzzy, prefix, range, or regexp query). + /// /// public SpanMultiTermQueryDescriptor Match(Elastic.Clients.Elasticsearch.QueryDsl.Query match) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanNearQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanNearQuery.g.cs index dc808aacc87..27110703b6d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanNearQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanNearQuery.g.cs @@ -30,19 +30,28 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class SpanNearQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Array of one or more other span type queries. + /// + /// Array of one or more other span type queries. + /// /// [JsonInclude, JsonPropertyName("clauses")] public ICollection Clauses { get; set; } /// - /// Controls whether matches are required to be in-order. + /// + /// Controls whether matches are required to be in-order. + /// /// [JsonInclude, JsonPropertyName("in_order")] public bool? InOrder { get; set; } @@ -50,7 +59,9 @@ public sealed partial class SpanNearQuery public string? QueryName { get; set; } /// - /// Controls the maximum number of intervening unmatched positions permitted. + /// + /// Controls the maximum number of intervening unmatched positions permitted. + /// /// [JsonInclude, JsonPropertyName("slop")] public int? Slop { get; set; } @@ -77,7 +88,12 @@ public SpanNearQueryDescriptor() : base() private int? SlopValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanNearQueryDescriptor Boost(float? boost) { @@ -86,7 +102,9 @@ public SpanNearQueryDescriptor Boost(float? boost) } /// - /// Array of one or more other span type queries. + /// + /// Array of one or more other span type queries. + /// /// public SpanNearQueryDescriptor Clauses(ICollection clauses) { @@ -125,7 +143,9 @@ public SpanNearQueryDescriptor Clauses(params Action - /// Controls whether matches are required to be in-order. + /// + /// Controls whether matches are required to be in-order. + /// /// public SpanNearQueryDescriptor InOrder(bool? inOrder = true) { @@ -140,7 +160,9 @@ public SpanNearQueryDescriptor QueryName(string? queryName) } /// - /// Controls the maximum number of intervening unmatched positions permitted. + /// + /// Controls the maximum number of intervening unmatched positions permitted. + /// /// public SpanNearQueryDescriptor Slop(int? slop) { @@ -228,7 +250,12 @@ public SpanNearQueryDescriptor() : base() private int? SlopValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanNearQueryDescriptor Boost(float? boost) { @@ -237,7 +264,9 @@ public SpanNearQueryDescriptor Boost(float? boost) } /// - /// Array of one or more other span type queries. + /// + /// Array of one or more other span type queries. + /// /// public SpanNearQueryDescriptor Clauses(ICollection clauses) { @@ -276,7 +305,9 @@ public SpanNearQueryDescriptor Clauses(params Action - /// Controls whether matches are required to be in-order. + /// + /// Controls whether matches are required to be in-order. + /// /// public SpanNearQueryDescriptor InOrder(bool? inOrder = true) { @@ -291,7 +322,9 @@ public SpanNearQueryDescriptor QueryName(string? queryName) } /// - /// Controls the maximum number of intervening unmatched positions permitted. + /// + /// Controls the maximum number of intervening unmatched positions permitted. + /// /// public SpanNearQueryDescriptor Slop(int? slop) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanNotQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanNotQuery.g.cs index d625fb4552c..8f27f83982c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanNotQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanNotQuery.g.cs @@ -30,37 +30,53 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class SpanNotQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// The number of tokens from within the include span that can’t have overlap with the exclude span.
Equivalent to setting both `pre` and `post`. + /// + /// The number of tokens from within the include span that can’t have overlap with the exclude span. + /// Equivalent to setting both pre and post. + /// /// [JsonInclude, JsonPropertyName("dist")] public int? Dist { get; set; } /// - /// Span query whose matches must not overlap those returned. + /// + /// Span query whose matches must not overlap those returned. + /// /// [JsonInclude, JsonPropertyName("exclude")] public Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery Exclude { get; set; } /// - /// Span query whose matches are filtered. + /// + /// Span query whose matches are filtered. + /// /// [JsonInclude, JsonPropertyName("include")] public Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery Include { get; set; } /// - /// The number of tokens after the include span that can’t have overlap with the exclude span. + /// + /// The number of tokens after the include span that can’t have overlap with the exclude span. + /// /// [JsonInclude, JsonPropertyName("post")] public int? Post { get; set; } /// - /// The number of tokens before the include span that can’t have overlap with the exclude span. + /// + /// The number of tokens before the include span that can’t have overlap with the exclude span. + /// /// [JsonInclude, JsonPropertyName("pre")] public int? Pre { get; set; } @@ -92,7 +108,12 @@ public SpanNotQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanNotQueryDescriptor Boost(float? boost) { @@ -101,7 +122,10 @@ public SpanNotQueryDescriptor Boost(float? boost) } /// - /// The number of tokens from within the include span that can’t have overlap with the exclude span.
Equivalent to setting both `pre` and `post`. + /// + /// The number of tokens from within the include span that can’t have overlap with the exclude span. + /// Equivalent to setting both pre and post. + /// /// public SpanNotQueryDescriptor Dist(int? dist) { @@ -110,7 +134,9 @@ public SpanNotQueryDescriptor Dist(int? dist) } /// - /// Span query whose matches must not overlap those returned. + /// + /// Span query whose matches must not overlap those returned. + /// /// public SpanNotQueryDescriptor Exclude(Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery exclude) { @@ -137,7 +163,9 @@ public SpanNotQueryDescriptor Exclude(Action - /// Span query whose matches are filtered. + /// + /// Span query whose matches are filtered. + /// /// public SpanNotQueryDescriptor Include(Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery include) { @@ -164,7 +192,9 @@ public SpanNotQueryDescriptor Include(Action - /// The number of tokens after the include span that can’t have overlap with the exclude span. + /// + /// The number of tokens after the include span that can’t have overlap with the exclude span. + /// /// public SpanNotQueryDescriptor Post(int? post) { @@ -173,7 +203,9 @@ public SpanNotQueryDescriptor Post(int? post) } /// - /// The number of tokens before the include span that can’t have overlap with the exclude span. + /// + /// The number of tokens before the include span that can’t have overlap with the exclude span. + /// /// public SpanNotQueryDescriptor Pre(int? pre) { @@ -277,7 +309,12 @@ public SpanNotQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanNotQueryDescriptor Boost(float? boost) { @@ -286,7 +323,10 @@ public SpanNotQueryDescriptor Boost(float? boost) } /// - /// The number of tokens from within the include span that can’t have overlap with the exclude span.
Equivalent to setting both `pre` and `post`. + /// + /// The number of tokens from within the include span that can’t have overlap with the exclude span. + /// Equivalent to setting both pre and post. + /// /// public SpanNotQueryDescriptor Dist(int? dist) { @@ -295,7 +335,9 @@ public SpanNotQueryDescriptor Dist(int? dist) } /// - /// Span query whose matches must not overlap those returned. + /// + /// Span query whose matches must not overlap those returned. + /// /// public SpanNotQueryDescriptor Exclude(Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery exclude) { @@ -322,7 +364,9 @@ public SpanNotQueryDescriptor Exclude(Action - /// Span query whose matches are filtered. + /// + /// Span query whose matches are filtered. + /// /// public SpanNotQueryDescriptor Include(Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery include) { @@ -349,7 +393,9 @@ public SpanNotQueryDescriptor Include(Action - /// The number of tokens after the include span that can’t have overlap with the exclude span. + /// + /// The number of tokens after the include span that can’t have overlap with the exclude span. + /// /// public SpanNotQueryDescriptor Post(int? post) { @@ -358,7 +404,9 @@ public SpanNotQueryDescriptor Post(int? post) } /// - /// The number of tokens before the include span that can’t have overlap with the exclude span. + /// + /// The number of tokens before the include span that can’t have overlap with the exclude span. + /// /// public SpanNotQueryDescriptor Pre(int? pre) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanOrQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanOrQuery.g.cs index ef0c00e2297..e48d9a01f09 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanOrQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanOrQuery.g.cs @@ -30,13 +30,20 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class SpanOrQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Array of one or more other span type queries. + /// + /// Array of one or more other span type queries. + /// /// [JsonInclude, JsonPropertyName("clauses")] public ICollection Clauses { get; set; } @@ -63,7 +70,12 @@ public SpanOrQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanOrQueryDescriptor Boost(float? boost) { @@ -72,7 +84,9 @@ public SpanOrQueryDescriptor Boost(float? boost) } /// - /// Array of one or more other span type queries. + /// + /// Array of one or more other span type queries. + /// /// public SpanOrQueryDescriptor Clauses(ICollection clauses) { @@ -182,7 +196,12 @@ public SpanOrQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanOrQueryDescriptor Boost(float? boost) { @@ -191,7 +210,9 @@ public SpanOrQueryDescriptor Boost(float? boost) } /// - /// Array of one or more other span type queries. + /// + /// Array of one or more other span type queries. + /// /// public SpanOrQueryDescriptor Clauses(ICollection clauses) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanTermQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanTermQuery.g.cs index 47c64889c2f..80695af511c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanTermQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanTermQuery.g.cs @@ -105,7 +105,12 @@ public SpanTermQuery(Elastic.Clients.Elasticsearch.Field field) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } @@ -130,7 +135,12 @@ public SpanTermQueryDescriptor() : base() private string ValueValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanTermQueryDescriptor Boost(float? boost) { @@ -208,7 +218,12 @@ public SpanTermQueryDescriptor() : base() private string ValueValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanTermQueryDescriptor Boost(float? boost) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanWithinQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanWithinQuery.g.cs index e2aaba8ef39..db21c718441 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanWithinQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanWithinQuery.g.cs @@ -30,19 +30,30 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class SpanWithinQuery { /// - /// Can be any span query.
Matching spans from `little` that are enclosed within `big` are returned. + /// + /// Can be any span query. + /// Matching spans from little that are enclosed within big are returned. + /// /// [JsonInclude, JsonPropertyName("big")] public Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery Big { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Can be any span query.
Matching spans from `little` that are enclosed within `big` are returned. + /// + /// Can be any span query. + /// Matching spans from little that are enclosed within big are returned. + /// /// [JsonInclude, JsonPropertyName("little")] public Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery Little { get; set; } @@ -71,7 +82,10 @@ public SpanWithinQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Can be any span query.
Matching spans from `little` that are enclosed within `big` are returned. + /// + /// Can be any span query. + /// Matching spans from little that are enclosed within big are returned. + /// /// public SpanWithinQueryDescriptor Big(Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery big) { @@ -98,7 +112,12 @@ public SpanWithinQueryDescriptor Big(Action - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanWithinQueryDescriptor Boost(float? boost) { @@ -107,7 +126,10 @@ public SpanWithinQueryDescriptor Boost(float? boost) } /// - /// Can be any span query.
Matching spans from `little` that are enclosed within `big` are returned. + /// + /// Can be any span query. + /// Matching spans from little that are enclosed within big are returned. + /// /// public SpanWithinQueryDescriptor Little(Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery little) { @@ -208,7 +230,10 @@ public SpanWithinQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Can be any span query.
Matching spans from `little` that are enclosed within `big` are returned. + /// + /// Can be any span query. + /// Matching spans from little that are enclosed within big are returned. + /// /// public SpanWithinQueryDescriptor Big(Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery big) { @@ -235,7 +260,12 @@ public SpanWithinQueryDescriptor Big(Action - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public SpanWithinQueryDescriptor Boost(float? boost) { @@ -244,7 +274,10 @@ public SpanWithinQueryDescriptor Boost(float? boost) } /// - /// Can be any span query.
Matching spans from `little` that are enclosed within `big` are returned. + /// + /// Can be any span query. + /// Matching spans from little that are enclosed within big are returned. + /// /// public SpanWithinQueryDescriptor Little(Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery little) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermQuery.g.cs index d77735afed0..caeecdb5658 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermQuery.g.cs @@ -117,19 +117,29 @@ public TermQuery(Elastic.Clients.Elasticsearch.Field field) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } /// - /// Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.
When `false`, the case sensitivity of matching depends on the underlying field’s mapping. + /// + /// Allows ASCII case insensitive matching of the value with the indexed field values when set to true. + /// When false, the case sensitivity of matching depends on the underlying field’s mapping. + /// /// public bool? CaseInsensitive { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } public string? QueryName { get; set; } /// - /// Term you wish to find in the provided field. + /// + /// Term you wish to find in the provided field. + /// /// public Elastic.Clients.Elasticsearch.FieldValue Value { get; set; } @@ -151,7 +161,12 @@ public TermQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.FieldValue ValueValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public TermQueryDescriptor Boost(float? boost) { @@ -160,7 +175,10 @@ public TermQueryDescriptor Boost(float? boost) } /// - /// Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.
When `false`, the case sensitivity of matching depends on the underlying field’s mapping. + /// + /// Allows ASCII case insensitive matching of the value with the indexed field values when set to true. + /// When false, the case sensitivity of matching depends on the underlying field’s mapping. + /// /// public TermQueryDescriptor CaseInsensitive(bool? caseInsensitive = true) { @@ -193,7 +211,9 @@ public TermQueryDescriptor QueryName(string? queryName) } /// - /// Term you wish to find in the provided field. + /// + /// Term you wish to find in the provided field. + /// /// public TermQueryDescriptor Value(Elastic.Clients.Elasticsearch.FieldValue value) { @@ -248,7 +268,12 @@ public TermQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.FieldValue ValueValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public TermQueryDescriptor Boost(float? boost) { @@ -257,7 +282,10 @@ public TermQueryDescriptor Boost(float? boost) } /// - /// Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.
When `false`, the case sensitivity of matching depends on the underlying field’s mapping. + /// + /// Allows ASCII case insensitive matching of the value with the indexed field values when set to true. + /// When false, the case sensitivity of matching depends on the underlying field’s mapping. + /// /// public TermQueryDescriptor CaseInsensitive(bool? caseInsensitive = true) { @@ -290,7 +318,9 @@ public TermQueryDescriptor QueryName(string? queryName) } /// - /// Term you wish to find in the provided field. + /// + /// Term you wish to find in the provided field. + /// /// public TermQueryDescriptor Value(Elastic.Clients.Elasticsearch.FieldValue value) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermRangeQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermRangeQuery.g.cs index 9f1bae14a88..71f3ccffc82 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermRangeQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermRangeQuery.g.cs @@ -181,35 +181,50 @@ public TermRangeQuery(Elastic.Clients.Elasticsearch.Field field) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } public string? From { get; set; } /// - /// Greater than. + /// + /// Greater than. + /// /// public string? Gt { get; set; } /// - /// Greater than or equal to. + /// + /// Greater than or equal to. + /// /// public string? Gte { get; set; } /// - /// Less than. + /// + /// Less than. + /// /// public string? Lt { get; set; } /// - /// Less than or equal to. + /// + /// Less than or equal to. + /// /// public string? Lte { get; set; } public string? QueryName { get; set; } /// - /// Indicates how the range query matches values for `range` fields. + /// + /// Indicates how the range query matches values for range fields. + /// /// public Elastic.Clients.Elasticsearch.QueryDsl.RangeRelation? Relation { get; set; } public string? To { get; set; } @@ -235,7 +250,12 @@ public TermRangeQueryDescriptor() : base() private string? ToValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public TermRangeQueryDescriptor Boost(float? boost) { @@ -268,7 +288,9 @@ public TermRangeQueryDescriptor From(string? from) } /// - /// Greater than. + /// + /// Greater than. + /// /// public TermRangeQueryDescriptor Gt(string? gt) { @@ -277,7 +299,9 @@ public TermRangeQueryDescriptor Gt(string? gt) } /// - /// Greater than or equal to. + /// + /// Greater than or equal to. + /// /// public TermRangeQueryDescriptor Gte(string? gte) { @@ -286,7 +310,9 @@ public TermRangeQueryDescriptor Gte(string? gte) } /// - /// Less than. + /// + /// Less than. + /// /// public TermRangeQueryDescriptor Lt(string? lt) { @@ -295,7 +321,9 @@ public TermRangeQueryDescriptor Lt(string? lt) } /// - /// Less than or equal to. + /// + /// Less than or equal to. + /// /// public TermRangeQueryDescriptor Lte(string? lte) { @@ -310,7 +338,9 @@ public TermRangeQueryDescriptor QueryName(string? queryName) } /// - /// Indicates how the range query matches values for `range` fields. + /// + /// Indicates how the range query matches values for range fields. + /// /// public TermRangeQueryDescriptor Relation(Elastic.Clients.Elasticsearch.QueryDsl.RangeRelation? relation) { @@ -410,7 +440,12 @@ public TermRangeQueryDescriptor() : base() private string? ToValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public TermRangeQueryDescriptor Boost(float? boost) { @@ -443,7 +478,9 @@ public TermRangeQueryDescriptor From(string? from) } /// - /// Greater than. + /// + /// Greater than. + /// /// public TermRangeQueryDescriptor Gt(string? gt) { @@ -452,7 +489,9 @@ public TermRangeQueryDescriptor Gt(string? gt) } /// - /// Greater than or equal to. + /// + /// Greater than or equal to. + /// /// public TermRangeQueryDescriptor Gte(string? gte) { @@ -461,7 +500,9 @@ public TermRangeQueryDescriptor Gte(string? gte) } /// - /// Less than. + /// + /// Less than. + /// /// public TermRangeQueryDescriptor Lt(string? lt) { @@ -470,7 +511,9 @@ public TermRangeQueryDescriptor Lt(string? lt) } /// - /// Less than or equal to. + /// + /// Less than or equal to. + /// /// public TermRangeQueryDescriptor Lte(string? lte) { @@ -485,7 +528,9 @@ public TermRangeQueryDescriptor QueryName(string? queryName) } /// - /// Indicates how the range query matches values for `range` fields. + /// + /// Indicates how the range query matches values for range fields. + /// /// public TermRangeQueryDescriptor Relation(Elastic.Clients.Elasticsearch.QueryDsl.RangeRelation? relation) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermsQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermsQuery.g.cs index f2708c15610..e536d0cb43d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermsQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermsQuery.g.cs @@ -95,7 +95,12 @@ public override void Write(Utf8JsonWriter writer, TermsQuery value, JsonSerializ public sealed partial class TermsQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } @@ -119,7 +124,12 @@ public TermsQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.QueryDsl.TermsQueryField TermValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public TermsQueryDescriptor Boost(float? boost) { @@ -197,7 +207,12 @@ public TermsQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.QueryDsl.TermsQueryField TermValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public TermsQueryDescriptor Boost(float? boost) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermsSetQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermsSetQuery.g.cs index 3baf59f9b0d..288028f159a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermsSetQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermsSetQuery.g.cs @@ -129,24 +129,35 @@ public TermsSetQuery(Elastic.Clients.Elasticsearch.Field field) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Numeric field containing the number of matching terms required to return a document. + /// + /// Numeric field containing the number of matching terms required to return a document. + /// /// public Elastic.Clients.Elasticsearch.Field? MinimumShouldMatchField { get; set; } /// - /// Custom script containing the number of matching terms required to return a document. + /// + /// Custom script containing the number of matching terms required to return a document. + /// /// public Elastic.Clients.Elasticsearch.Script? MinimumShouldMatchScript { get; set; } public string? QueryName { get; set; } /// - /// Array of terms you wish to find in the provided field. + /// + /// Array of terms you wish to find in the provided field. + /// /// public ICollection Terms { get; set; } @@ -171,7 +182,12 @@ public TermsSetQueryDescriptor() : base() private ICollection TermsValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public TermsSetQueryDescriptor Boost(float? boost) { @@ -198,7 +214,9 @@ public TermsSetQueryDescriptor Field(Expression - /// Numeric field containing the number of matching terms required to return a document. + /// + /// Numeric field containing the number of matching terms required to return a document. + /// /// public TermsSetQueryDescriptor MinimumShouldMatchField(Elastic.Clients.Elasticsearch.Field? minimumShouldMatchField) { @@ -207,7 +225,9 @@ public TermsSetQueryDescriptor MinimumShouldMatchField(Elastic.Client } /// - /// Numeric field containing the number of matching terms required to return a document. + /// + /// Numeric field containing the number of matching terms required to return a document. + /// /// public TermsSetQueryDescriptor MinimumShouldMatchField(Expression> minimumShouldMatchField) { @@ -216,7 +236,9 @@ public TermsSetQueryDescriptor MinimumShouldMatchField(Expres } /// - /// Numeric field containing the number of matching terms required to return a document. + /// + /// Numeric field containing the number of matching terms required to return a document. + /// /// public TermsSetQueryDescriptor MinimumShouldMatchField(Expression> minimumShouldMatchField) { @@ -225,7 +247,9 @@ public TermsSetQueryDescriptor MinimumShouldMatchField(Expression - /// Custom script containing the number of matching terms required to return a document. + /// + /// Custom script containing the number of matching terms required to return a document. + /// /// public TermsSetQueryDescriptor MinimumShouldMatchScript(Elastic.Clients.Elasticsearch.Script? minimumShouldMatchScript) { @@ -258,7 +282,9 @@ public TermsSetQueryDescriptor QueryName(string? queryName) } /// - /// Array of terms you wish to find in the provided field. + /// + /// Array of terms you wish to find in the provided field. + /// /// public TermsSetQueryDescriptor Terms(ICollection terms) { @@ -332,7 +358,12 @@ public TermsSetQueryDescriptor() : base() private ICollection TermsValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public TermsSetQueryDescriptor Boost(float? boost) { @@ -359,7 +390,9 @@ public TermsSetQueryDescriptor Field(Expression - /// Numeric field containing the number of matching terms required to return a document. + /// + /// Numeric field containing the number of matching terms required to return a document. + /// /// public TermsSetQueryDescriptor MinimumShouldMatchField(Elastic.Clients.Elasticsearch.Field? minimumShouldMatchField) { @@ -368,7 +401,9 @@ public TermsSetQueryDescriptor MinimumShouldMatchField(Elastic.Clients.Elasticse } /// - /// Numeric field containing the number of matching terms required to return a document. + /// + /// Numeric field containing the number of matching terms required to return a document. + /// /// public TermsSetQueryDescriptor MinimumShouldMatchField(Expression> minimumShouldMatchField) { @@ -377,7 +412,9 @@ public TermsSetQueryDescriptor MinimumShouldMatchField(Expres } /// - /// Numeric field containing the number of matching terms required to return a document. + /// + /// Numeric field containing the number of matching terms required to return a document. + /// /// public TermsSetQueryDescriptor MinimumShouldMatchField(Expression> minimumShouldMatchField) { @@ -386,7 +423,9 @@ public TermsSetQueryDescriptor MinimumShouldMatchField(Expression - /// Custom script containing the number of matching terms required to return a document. + /// + /// Custom script containing the number of matching terms required to return a document. + /// /// public TermsSetQueryDescriptor MinimumShouldMatchScript(Elastic.Clients.Elasticsearch.Script? minimumShouldMatchScript) { @@ -419,7 +458,9 @@ public TermsSetQueryDescriptor QueryName(string? queryName) } /// - /// Array of terms you wish to find in the provided field. + /// + /// Array of terms you wish to find in the provided field. + /// /// public TermsSetQueryDescriptor Terms(ICollection terms) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TextExpansionQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TextExpansionQuery.g.cs index bc2c5666b24..abe905037fd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TextExpansionQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TextExpansionQuery.g.cs @@ -125,23 +125,34 @@ public TextExpansionQuery(Elastic.Clients.Elasticsearch.Field field) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// The text expansion NLP model to use + /// + /// The text expansion NLP model to use + /// /// public string ModelId { get; set; } /// - /// The query text + /// + /// The query text + /// /// public string ModelText { get; set; } /// - /// Token pruning configurations + /// + /// Token pruning configurations + /// /// public Elastic.Clients.Elasticsearch.QueryDsl.TokenPruningConfig? PruningConfig { get; set; } public string? QueryName { get; set; } @@ -167,7 +178,12 @@ public TextExpansionQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public TextExpansionQueryDescriptor Boost(float? boost) { @@ -194,7 +210,9 @@ public TextExpansionQueryDescriptor Field(Expression - /// The text expansion NLP model to use + /// + /// The text expansion NLP model to use + /// /// public TextExpansionQueryDescriptor ModelId(string modelId) { @@ -203,7 +221,9 @@ public TextExpansionQueryDescriptor ModelId(string modelId) } /// - /// The query text + /// + /// The query text + /// /// public TextExpansionQueryDescriptor ModelText(string modelText) { @@ -212,7 +232,9 @@ public TextExpansionQueryDescriptor ModelText(string modelText) } /// - /// Token pruning configurations + /// + /// Token pruning configurations + /// /// public TextExpansionQueryDescriptor PruningConfig(Elastic.Clients.Elasticsearch.QueryDsl.TokenPruningConfig? pruningConfig) { @@ -306,7 +328,12 @@ public TextExpansionQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public TextExpansionQueryDescriptor Boost(float? boost) { @@ -333,7 +360,9 @@ public TextExpansionQueryDescriptor Field(Expression - /// The text expansion NLP model to use + /// + /// The text expansion NLP model to use + /// /// public TextExpansionQueryDescriptor ModelId(string modelId) { @@ -342,7 +371,9 @@ public TextExpansionQueryDescriptor ModelId(string modelId) } /// - /// The query text + /// + /// The query text + /// /// public TextExpansionQueryDescriptor ModelText(string modelText) { @@ -351,7 +382,9 @@ public TextExpansionQueryDescriptor ModelText(string modelText) } /// - /// Token pruning configurations + /// + /// Token pruning configurations + /// /// public TextExpansionQueryDescriptor PruningConfig(Elastic.Clients.Elasticsearch.QueryDsl.TokenPruningConfig? pruningConfig) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TokenPruningConfig.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TokenPruningConfig.g.cs index a7300a7f415..01f8b4e9499 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TokenPruningConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TokenPruningConfig.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class TokenPruningConfig { /// - /// Whether to only score pruned tokens, vs only scoring kept tokens. + /// + /// Whether to only score pruned tokens, vs only scoring kept tokens. + /// /// [JsonInclude, JsonPropertyName("only_score_pruned_tokens")] public bool? OnlyScorePrunedTokens { get; set; } /// - /// Tokens whose frequency is more than this threshold times the average frequency of all tokens in the specified field are considered outliers and pruned. + /// + /// Tokens whose frequency is more than this threshold times the average frequency of all tokens in the specified field are considered outliers and pruned. + /// /// [JsonInclude, JsonPropertyName("tokens_freq_ratio_threshold")] public int? TokensFreqRatioThreshold { get; set; } /// - /// Tokens whose weight is less than this threshold are considered nonsignificant and pruned. + /// + /// Tokens whose weight is less than this threshold are considered nonsignificant and pruned. + /// /// [JsonInclude, JsonPropertyName("tokens_weight_threshold")] public float? TokensWeightThreshold { get; set; } @@ -61,7 +67,9 @@ public TokenPruningConfigDescriptor() : base() private float? TokensWeightThresholdValue { get; set; } /// - /// Whether to only score pruned tokens, vs only scoring kept tokens. + /// + /// Whether to only score pruned tokens, vs only scoring kept tokens. + /// /// public TokenPruningConfigDescriptor OnlyScorePrunedTokens(bool? onlyScorePrunedTokens = true) { @@ -70,7 +78,9 @@ public TokenPruningConfigDescriptor OnlyScorePrunedTokens(bool? onlyScorePrunedT } /// - /// Tokens whose frequency is more than this threshold times the average frequency of all tokens in the specified field are considered outliers and pruned. + /// + /// Tokens whose frequency is more than this threshold times the average frequency of all tokens in the specified field are considered outliers and pruned. + /// /// public TokenPruningConfigDescriptor TokensFreqRatioThreshold(int? tokensFreqRatioThreshold) { @@ -79,7 +89,9 @@ public TokenPruningConfigDescriptor TokensFreqRatioThreshold(int? tokensFreqRati } /// - /// Tokens whose weight is less than this threshold are considered nonsignificant and pruned. + /// + /// Tokens whose weight is less than this threshold are considered nonsignificant and pruned. + /// /// public TokenPruningConfigDescriptor TokensWeightThreshold(float? tokensWeightThreshold) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/UntypedDecayFunction.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/UntypedDecayFunction.g.cs index c5b78cb2793..0972c6b4a4a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/UntypedDecayFunction.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/UntypedDecayFunction.g.cs @@ -85,7 +85,9 @@ public sealed partial class UntypedDecayFunction public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// + /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// /// public Elastic.Clients.Elasticsearch.QueryDsl.MultiValueMode? MultiValueMode { get; set; } public Elastic.Clients.Elasticsearch.QueryDsl.DecayPlacement Placement { get; set; } @@ -122,7 +124,9 @@ public UntypedDecayFunctionDescriptor Field(Expression - /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// + /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// /// public UntypedDecayFunctionDescriptor MultiValueMode(Elastic.Clients.Elasticsearch.QueryDsl.MultiValueMode? multiValueMode) { @@ -187,7 +191,9 @@ public UntypedDecayFunctionDescriptor Field(Expression - /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// + /// Determines how the distance is calculated when a field used for computing the decay contains multiple values. + /// /// public UntypedDecayFunctionDescriptor MultiValueMode(Elastic.Clients.Elasticsearch.QueryDsl.MultiValueMode? multiValueMode) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/UntypedDistanceFeatureQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/UntypedDistanceFeatureQuery.g.cs index d0c3928421f..728ae35facf 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/UntypedDistanceFeatureQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/UntypedDistanceFeatureQuery.g.cs @@ -30,25 +30,43 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class UntypedDistanceFeatureQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Date or point of origin used to calculate distances.
If the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.
Date Math, such as `now-1h`, is supported.
If the field value is a `geo_point` field, the `origin` value must be a geopoint. + /// + /// Date or point of origin used to calculate distances. + /// If the field value is a date or date_nanos field, the origin value must be a date. + /// Date Math, such as now-1h, is supported. + /// If the field value is a geo_point field, the origin value must be a geopoint. + /// /// [JsonInclude, JsonPropertyName("origin")] public object Origin { get; set; } /// - /// Distance from the `origin` at which relevance scores receive half of the `boost` value.
If the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`. + /// + /// Distance from the origin at which relevance scores receive half of the boost value. + /// If the field value is a date or date_nanos field, the pivot value must be a time unit, such as 1h or 10d. If the field value is a geo_point field, the pivot value must be a distance unit, such as 1km or 12m. + /// /// [JsonInclude, JsonPropertyName("pivot")] public object Pivot { get; set; } @@ -71,7 +89,12 @@ public UntypedDistanceFeatureQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public UntypedDistanceFeatureQueryDescriptor Boost(float? boost) { @@ -80,7 +103,12 @@ public UntypedDistanceFeatureQueryDescriptor Boost(float? boost) } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public UntypedDistanceFeatureQueryDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -89,7 +117,12 @@ public UntypedDistanceFeatureQueryDescriptor Field(Elastic.Clients.El } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public UntypedDistanceFeatureQueryDescriptor Field(Expression> field) { @@ -98,7 +131,12 @@ public UntypedDistanceFeatureQueryDescriptor Field(Expression } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public UntypedDistanceFeatureQueryDescriptor Field(Expression> field) { @@ -107,7 +145,12 @@ public UntypedDistanceFeatureQueryDescriptor Field(Expression - /// Date or point of origin used to calculate distances.
If the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.
Date Math, such as `now-1h`, is supported.
If the field value is a `geo_point` field, the `origin` value must be a geopoint. + /// + /// Date or point of origin used to calculate distances. + /// If the field value is a date or date_nanos field, the origin value must be a date. + /// Date Math, such as now-1h, is supported. + /// If the field value is a geo_point field, the origin value must be a geopoint. + /// /// public UntypedDistanceFeatureQueryDescriptor Origin(object origin) { @@ -116,7 +159,10 @@ public UntypedDistanceFeatureQueryDescriptor Origin(object origin) } /// - /// Distance from the `origin` at which relevance scores receive half of the `boost` value.
If the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`. + /// + /// Distance from the origin at which relevance scores receive half of the boost value. + /// If the field value is a date or date_nanos field, the pivot value must be a time unit, such as 1h or 10d. If the field value is a geo_point field, the pivot value must be a distance unit, such as 1km or 12m. + /// /// public UntypedDistanceFeatureQueryDescriptor Pivot(object pivot) { @@ -170,7 +216,12 @@ public UntypedDistanceFeatureQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public UntypedDistanceFeatureQueryDescriptor Boost(float? boost) { @@ -179,7 +230,12 @@ public UntypedDistanceFeatureQueryDescriptor Boost(float? boost) } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public UntypedDistanceFeatureQueryDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -188,7 +244,12 @@ public UntypedDistanceFeatureQueryDescriptor Field(Elastic.Clients.Elasticsearch } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public UntypedDistanceFeatureQueryDescriptor Field(Expression> field) { @@ -197,7 +258,12 @@ public UntypedDistanceFeatureQueryDescriptor Field(Expression } /// - /// Name of the field used to calculate distances. This field must meet the following criteria:
be a `date`, `date_nanos` or `geo_point` field;
have an `index` mapping parameter value of `true`, which is the default;
have an `doc_values` mapping parameter value of `true`, which is the default. + /// + /// Name of the field used to calculate distances. This field must meet the following criteria: + /// be a date, date_nanos or geo_point field; + /// have an index mapping parameter value of true, which is the default; + /// have an doc_values mapping parameter value of true, which is the default. + /// /// public UntypedDistanceFeatureQueryDescriptor Field(Expression> field) { @@ -206,7 +272,12 @@ public UntypedDistanceFeatureQueryDescriptor Field(Expression - /// Date or point of origin used to calculate distances.
If the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.
Date Math, such as `now-1h`, is supported.
If the field value is a `geo_point` field, the `origin` value must be a geopoint. + /// + /// Date or point of origin used to calculate distances. + /// If the field value is a date or date_nanos field, the origin value must be a date. + /// Date Math, such as now-1h, is supported. + /// If the field value is a geo_point field, the origin value must be a geopoint. + /// /// public UntypedDistanceFeatureQueryDescriptor Origin(object origin) { @@ -215,7 +286,10 @@ public UntypedDistanceFeatureQueryDescriptor Origin(object origin) } /// - /// Distance from the `origin` at which relevance scores receive half of the `boost` value.
If the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`. + /// + /// Distance from the origin at which relevance scores receive half of the boost value. + /// If the field value is a date or date_nanos field, the pivot value must be a time unit, such as 1h or 10d. If the field value is a geo_point field, the pivot value must be a distance unit, such as 1km or 12m. + /// /// public UntypedDistanceFeatureQueryDescriptor Pivot(object pivot) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/UntypedRangeQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/UntypedRangeQuery.g.cs index 74f784dc5bb..3a45d04d350 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/UntypedRangeQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/UntypedRangeQuery.g.cs @@ -205,45 +205,64 @@ public UntypedRangeQuery(Elastic.Clients.Elasticsearch.Field field) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Date format used to convert `date` values in the query. + /// + /// Date format used to convert date values in the query. + /// /// public string? Format { get; set; } public object? From { get; set; } /// - /// Greater than. + /// + /// Greater than. + /// /// public object? Gt { get; set; } /// - /// Greater than or equal to. + /// + /// Greater than or equal to. + /// /// public object? Gte { get; set; } /// - /// Less than. + /// + /// Less than. + /// /// public object? Lt { get; set; } /// - /// Less than or equal to. + /// + /// Less than or equal to. + /// /// public object? Lte { get; set; } public string? QueryName { get; set; } /// - /// Indicates how the range query matches values for `range` fields. + /// + /// Indicates how the range query matches values for range fields. + /// /// public Elastic.Clients.Elasticsearch.QueryDsl.RangeRelation? Relation { get; set; } /// - /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC. + /// + /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query to UTC. + /// /// public string? TimeZone { get; set; } public object? To { get; set; } @@ -271,7 +290,12 @@ public UntypedRangeQueryDescriptor() : base() private object? ToValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public UntypedRangeQueryDescriptor Boost(float? boost) { @@ -298,7 +322,9 @@ public UntypedRangeQueryDescriptor Field(Expression - /// Date format used to convert `date` values in the query. + /// + /// Date format used to convert date values in the query. + /// /// public UntypedRangeQueryDescriptor Format(string? format) { @@ -313,7 +339,9 @@ public UntypedRangeQueryDescriptor From(object? from) } /// - /// Greater than. + /// + /// Greater than. + /// /// public UntypedRangeQueryDescriptor Gt(object? gt) { @@ -322,7 +350,9 @@ public UntypedRangeQueryDescriptor Gt(object? gt) } /// - /// Greater than or equal to. + /// + /// Greater than or equal to. + /// /// public UntypedRangeQueryDescriptor Gte(object? gte) { @@ -331,7 +361,9 @@ public UntypedRangeQueryDescriptor Gte(object? gte) } /// - /// Less than. + /// + /// Less than. + /// /// public UntypedRangeQueryDescriptor Lt(object? lt) { @@ -340,7 +372,9 @@ public UntypedRangeQueryDescriptor Lt(object? lt) } /// - /// Less than or equal to. + /// + /// Less than or equal to. + /// /// public UntypedRangeQueryDescriptor Lte(object? lte) { @@ -355,7 +389,9 @@ public UntypedRangeQueryDescriptor QueryName(string? queryName) } /// - /// Indicates how the range query matches values for `range` fields. + /// + /// Indicates how the range query matches values for range fields. + /// /// public UntypedRangeQueryDescriptor Relation(Elastic.Clients.Elasticsearch.QueryDsl.RangeRelation? relation) { @@ -364,7 +400,9 @@ public UntypedRangeQueryDescriptor Relation(Elastic.Clients.Elasticse } /// - /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC. + /// + /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query to UTC. + /// /// public UntypedRangeQueryDescriptor TimeZone(string? timeZone) { @@ -478,7 +516,12 @@ public UntypedRangeQueryDescriptor() : base() private object? ToValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public UntypedRangeQueryDescriptor Boost(float? boost) { @@ -505,7 +548,9 @@ public UntypedRangeQueryDescriptor Field(Expression - /// Date format used to convert `date` values in the query. + /// + /// Date format used to convert date values in the query. + /// /// public UntypedRangeQueryDescriptor Format(string? format) { @@ -520,7 +565,9 @@ public UntypedRangeQueryDescriptor From(object? from) } /// - /// Greater than. + /// + /// Greater than. + /// /// public UntypedRangeQueryDescriptor Gt(object? gt) { @@ -529,7 +576,9 @@ public UntypedRangeQueryDescriptor Gt(object? gt) } /// - /// Greater than or equal to. + /// + /// Greater than or equal to. + /// /// public UntypedRangeQueryDescriptor Gte(object? gte) { @@ -538,7 +587,9 @@ public UntypedRangeQueryDescriptor Gte(object? gte) } /// - /// Less than. + /// + /// Less than. + /// /// public UntypedRangeQueryDescriptor Lt(object? lt) { @@ -547,7 +598,9 @@ public UntypedRangeQueryDescriptor Lt(object? lt) } /// - /// Less than or equal to. + /// + /// Less than or equal to. + /// /// public UntypedRangeQueryDescriptor Lte(object? lte) { @@ -562,7 +615,9 @@ public UntypedRangeQueryDescriptor QueryName(string? queryName) } /// - /// Indicates how the range query matches values for `range` fields. + /// + /// Indicates how the range query matches values for range fields. + /// /// public UntypedRangeQueryDescriptor Relation(Elastic.Clients.Elasticsearch.QueryDsl.RangeRelation? relation) { @@ -571,7 +626,9 @@ public UntypedRangeQueryDescriptor Relation(Elastic.Clients.Elasticsearch.QueryD } /// - /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC. + /// + /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query to UTC. + /// /// public UntypedRangeQueryDescriptor TimeZone(string? timeZone) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/WeightedTokensQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/WeightedTokensQuery.g.cs index 8c705034ed4..dccca3386fb 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/WeightedTokensQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/WeightedTokensQuery.g.cs @@ -117,19 +117,28 @@ public WeightedTokensQuery(Elastic.Clients.Elasticsearch.Field field) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Token pruning configurations + /// + /// Token pruning configurations + /// /// public Elastic.Clients.Elasticsearch.QueryDsl.TokenPruningConfig? PruningConfig { get; set; } public string? QueryName { get; set; } /// - /// The tokens representing this query + /// + /// The tokens representing this query + /// /// public IDictionary Tokens { get; set; } @@ -153,7 +162,12 @@ public WeightedTokensQueryDescriptor() : base() private IDictionary TokensValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public WeightedTokensQueryDescriptor Boost(float? boost) { @@ -180,7 +194,9 @@ public WeightedTokensQueryDescriptor Field(Expression - /// Token pruning configurations + /// + /// Token pruning configurations + /// /// public WeightedTokensQueryDescriptor PruningConfig(Elastic.Clients.Elasticsearch.QueryDsl.TokenPruningConfig? pruningConfig) { @@ -213,7 +229,9 @@ public WeightedTokensQueryDescriptor QueryName(string? queryName) } /// - /// The tokens representing this query + /// + /// The tokens representing this query + /// /// public WeightedTokensQueryDescriptor Tokens(Func, FluentDictionary> selector) { @@ -280,7 +298,12 @@ public WeightedTokensQueryDescriptor() : base() private IDictionary TokensValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public WeightedTokensQueryDescriptor Boost(float? boost) { @@ -307,7 +330,9 @@ public WeightedTokensQueryDescriptor Field(Expression - /// Token pruning configurations + /// + /// Token pruning configurations + /// /// public WeightedTokensQueryDescriptor PruningConfig(Elastic.Clients.Elasticsearch.QueryDsl.TokenPruningConfig? pruningConfig) { @@ -340,7 +365,9 @@ public WeightedTokensQueryDescriptor QueryName(string? queryName) } /// - /// The tokens representing this query + /// + /// The tokens representing this query + /// /// public WeightedTokensQueryDescriptor Tokens(Func, FluentDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/WildcardQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/WildcardQuery.g.cs index 640e55fc6b5..3059637d5d3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/WildcardQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/WildcardQuery.g.cs @@ -145,29 +145,42 @@ public WildcardQuery(Elastic.Clients.Elasticsearch.Field field) } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public float? Boost { get; set; } /// - /// Allows case insensitive matching of the pattern with the indexed field values when set to true. Default is false which means the case sensitivity of matching depends on the underlying field’s mapping. + /// + /// Allows case insensitive matching of the pattern with the indexed field values when set to true. Default is false which means the case sensitivity of matching depends on the underlying field’s mapping. + /// /// public bool? CaseInsensitive { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } public string? QueryName { get; set; } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public string? Rewrite { get; set; } /// - /// Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set. + /// + /// Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set. + /// /// public string? Value { get; set; } /// - /// Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set. + /// + /// Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set. + /// /// public string? Wildcard { get; set; } @@ -191,7 +204,12 @@ public WildcardQueryDescriptor() : base() private string? WildcardValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public WildcardQueryDescriptor Boost(float? boost) { @@ -200,7 +218,9 @@ public WildcardQueryDescriptor Boost(float? boost) } /// - /// Allows case insensitive matching of the pattern with the indexed field values when set to true. Default is false which means the case sensitivity of matching depends on the underlying field’s mapping. + /// + /// Allows case insensitive matching of the pattern with the indexed field values when set to true. Default is false which means the case sensitivity of matching depends on the underlying field’s mapping. + /// /// public WildcardQueryDescriptor CaseInsensitive(bool? caseInsensitive = true) { @@ -233,7 +253,9 @@ public WildcardQueryDescriptor QueryName(string? queryName) } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public WildcardQueryDescriptor Rewrite(string? rewrite) { @@ -242,7 +264,9 @@ public WildcardQueryDescriptor Rewrite(string? rewrite) } /// - /// Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set. + /// + /// Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set. + /// /// public WildcardQueryDescriptor Value(string? value) { @@ -251,7 +275,9 @@ public WildcardQueryDescriptor Value(string? value) } /// - /// Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set. + /// + /// Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set. + /// /// public WildcardQueryDescriptor Wildcard(string? wildcard) { @@ -324,7 +350,12 @@ public WildcardQueryDescriptor() : base() private string? WildcardValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public WildcardQueryDescriptor Boost(float? boost) { @@ -333,7 +364,9 @@ public WildcardQueryDescriptor Boost(float? boost) } /// - /// Allows case insensitive matching of the pattern with the indexed field values when set to true. Default is false which means the case sensitivity of matching depends on the underlying field’s mapping. + /// + /// Allows case insensitive matching of the pattern with the indexed field values when set to true. Default is false which means the case sensitivity of matching depends on the underlying field’s mapping. + /// /// public WildcardQueryDescriptor CaseInsensitive(bool? caseInsensitive = true) { @@ -366,7 +399,9 @@ public WildcardQueryDescriptor QueryName(string? queryName) } /// - /// Method used to rewrite the query. + /// + /// Method used to rewrite the query. + /// /// public WildcardQueryDescriptor Rewrite(string? rewrite) { @@ -375,7 +410,9 @@ public WildcardQueryDescriptor Rewrite(string? rewrite) } /// - /// Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set. + /// + /// Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set. + /// /// public WildcardQueryDescriptor Value(string? value) { @@ -384,7 +421,9 @@ public WildcardQueryDescriptor Value(string? value) } /// - /// Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set. + /// + /// Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set. + /// /// public WildcardQueryDescriptor Wildcard(string? wildcard) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/WrapperQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/WrapperQuery.g.cs index 72d06554a4f..f946f834295 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/WrapperQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/WrapperQuery.g.cs @@ -30,13 +30,21 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class WrapperQuery { /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } /// - /// A base64 encoded query.
The binary data format can be any of JSON, YAML, CBOR or SMILE encodings + /// + /// A base64 encoded query. + /// The binary data format can be any of JSON, YAML, CBOR or SMILE encodings + /// /// [JsonInclude, JsonPropertyName("query")] public string Query { get; set; } @@ -59,7 +67,12 @@ public WrapperQueryDescriptor() : base() private string? QueryNameValue { get; set; } /// - /// Floating point number used to decrease or increase the relevance scores of the query.
Boost values are relative to the default value of 1.0.
A boost value between 0 and 1.0 decreases the relevance score.
A value greater than 1.0 increases the relevance score. + /// + /// Floating point number used to decrease or increase the relevance scores of the query. + /// Boost values are relative to the default value of 1.0. + /// A boost value between 0 and 1.0 decreases the relevance score. + /// A value greater than 1.0 increases the relevance score. + /// /// public WrapperQueryDescriptor Boost(float? boost) { @@ -68,7 +81,10 @@ public WrapperQueryDescriptor Boost(float? boost) } /// - /// A base64 encoded query.
The binary data format can be any of JSON, YAML, CBOR or SMILE encodings + /// + /// A base64 encoded query. + /// The binary data format can be any of JSON, YAML, CBOR or SMILE encodings + /// /// public WrapperQueryDescriptor Query(string query) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryRules/QueryRulesetListItem.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryRules/QueryRulesetListItem.g.cs index 5de513530a3..92c8db94d10 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryRules/QueryRulesetListItem.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryRules/QueryRulesetListItem.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.QueryRules; public sealed partial class QueryRulesetListItem { /// - /// A map of criteria type to the number of rules of that type + /// + /// A map of criteria type to the number of rules of that type + /// /// [JsonInclude, JsonPropertyName("rule_criteria_types_counts")] public IReadOnlyDictionary RuleCriteriaTypesCounts { get; init; } /// - /// Ruleset unique identifier + /// + /// Ruleset unique identifier + /// /// [JsonInclude, JsonPropertyName("ruleset_id")] public string RulesetId { get; init; } /// - /// The number of rules associated with this ruleset + /// + /// The number of rules associated with this ruleset + /// /// [JsonInclude, JsonPropertyName("rule_total_count")] public int RuleTotalCount { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/RRFRetriever.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/RRFRetriever.g.cs index e5557750d43..c3a1b401dab 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/RRFRetriever.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/RRFRetriever.g.cs @@ -30,26 +30,34 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class RRFRetriever { /// - /// Query to filter the documents that can match. + /// + /// Query to filter the documents that can match. + /// /// [JsonInclude, JsonPropertyName("filter")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.QueryDsl.Query))] public ICollection? Filter { get; set; } /// - /// This value determines how much influence documents in individual result sets per query have over the final ranked result set. + /// + /// This value determines how much influence documents in individual result sets per query have over the final ranked result set. + /// /// [JsonInclude, JsonPropertyName("rank_constant")] public int? RankConstant { get; set; } /// - /// This value determines the size of the individual result sets per query. + /// + /// This value determines the size of the individual result sets per query. + /// /// [JsonInclude, JsonPropertyName("rank_window_size")] public int? RankWindowSize { get; set; } /// - /// A list of child retrievers to specify which sets of returned top documents will have the RRF formula applied to them. + /// + /// A list of child retrievers to specify which sets of returned top documents will have the RRF formula applied to them. + /// /// [JsonInclude, JsonPropertyName("retrievers")] public ICollection Retrievers { get; set; } @@ -77,7 +85,9 @@ public RRFRetrieverDescriptor() : base() private Action>[] RetrieversDescriptorActions { get; set; } /// - /// Query to filter the documents that can match. + /// + /// Query to filter the documents that can match. + /// /// public RRFRetrieverDescriptor Filter(ICollection? filter) { @@ -116,7 +126,9 @@ public RRFRetrieverDescriptor Filter(params Action - /// This value determines how much influence documents in individual result sets per query have over the final ranked result set. + /// + /// This value determines how much influence documents in individual result sets per query have over the final ranked result set. + /// /// public RRFRetrieverDescriptor RankConstant(int? rankConstant) { @@ -125,7 +137,9 @@ public RRFRetrieverDescriptor RankConstant(int? rankConstant) } /// - /// This value determines the size of the individual result sets per query. + /// + /// This value determines the size of the individual result sets per query. + /// /// public RRFRetrieverDescriptor RankWindowSize(int? rankWindowSize) { @@ -134,7 +148,9 @@ public RRFRetrieverDescriptor RankWindowSize(int? rankWindowSize) } /// - /// A list of child retrievers to specify which sets of returned top documents will have the RRF formula applied to them. + /// + /// A list of child retrievers to specify which sets of returned top documents will have the RRF formula applied to them. + /// /// public RRFRetrieverDescriptor Retrievers(ICollection retrievers) { @@ -271,7 +287,9 @@ public RRFRetrieverDescriptor() : base() private Action[] RetrieversDescriptorActions { get; set; } /// - /// Query to filter the documents that can match. + /// + /// Query to filter the documents that can match. + /// /// public RRFRetrieverDescriptor Filter(ICollection? filter) { @@ -310,7 +328,9 @@ public RRFRetrieverDescriptor Filter(params Action - /// This value determines how much influence documents in individual result sets per query have over the final ranked result set. + /// + /// This value determines how much influence documents in individual result sets per query have over the final ranked result set. + /// /// public RRFRetrieverDescriptor RankConstant(int? rankConstant) { @@ -319,7 +339,9 @@ public RRFRetrieverDescriptor RankConstant(int? rankConstant) } /// - /// This value determines the size of the individual result sets per query. + /// + /// This value determines the size of the individual result sets per query. + /// /// public RRFRetrieverDescriptor RankWindowSize(int? rankWindowSize) { @@ -328,7 +350,9 @@ public RRFRetrieverDescriptor RankWindowSize(int? rankWindowSize) } /// - /// A list of child retrievers to specify which sets of returned top documents will have the RRF formula applied to them. + /// + /// A list of child retrievers to specify which sets of returned top documents will have the RRF formula applied to them. + /// /// public RRFRetrieverDescriptor Retrievers(ICollection retrievers) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Rollup/DateHistogramGrouping.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Rollup/DateHistogramGrouping.g.cs index 4d3075b3918..e9d3eb82d8d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Rollup/DateHistogramGrouping.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Rollup/DateHistogramGrouping.g.cs @@ -30,25 +30,37 @@ namespace Elastic.Clients.Elasticsearch.Rollup; public sealed partial class DateHistogramGrouping { /// - /// The interval of time buckets to be generated when rolling up. + /// + /// The interval of time buckets to be generated when rolling up. + /// /// [JsonInclude, JsonPropertyName("calendar_interval")] public Elastic.Clients.Elasticsearch.Duration? CalendarInterval { get; set; } /// - /// How long to wait before rolling up new documents.
By default, the indexer attempts to roll up all data that is available.
However, it is not uncommon for data to arrive out of order.
The indexer is unable to deal with data that arrives after a time-span has been rolled up.
You need to specify a delay that matches the longest period of time you expect out-of-order data to arrive. + /// + /// How long to wait before rolling up new documents. + /// By default, the indexer attempts to roll up all data that is available. + /// However, it is not uncommon for data to arrive out of order. + /// The indexer is unable to deal with data that arrives after a time-span has been rolled up. + /// You need to specify a delay that matches the longest period of time you expect out-of-order data to arrive. + /// /// [JsonInclude, JsonPropertyName("delay")] public Elastic.Clients.Elasticsearch.Duration? Delay { get; set; } /// - /// The date field that is to be rolled up. + /// + /// The date field that is to be rolled up. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// The interval of time buckets to be generated when rolling up. + /// + /// The interval of time buckets to be generated when rolling up. + /// /// [JsonInclude, JsonPropertyName("fixed_interval")] public Elastic.Clients.Elasticsearch.Duration? FixedInterval { get; set; } @@ -58,7 +70,11 @@ public sealed partial class DateHistogramGrouping public Elastic.Clients.Elasticsearch.Duration? Interval { get; set; } /// - /// Defines what `time_zone` the rollup documents are stored as.
Unlike raw data, which can shift timezones on the fly, rolled documents have to be stored with a specific timezone.
By default, rollup documents are stored in `UTC`. + /// + /// Defines what time_zone the rollup documents are stored as. + /// Unlike raw data, which can shift timezones on the fly, rolled documents have to be stored with a specific timezone. + /// By default, rollup documents are stored in UTC. + /// /// [JsonInclude, JsonPropertyName("time_zone")] public string? TimeZone { get; set; } @@ -81,7 +97,9 @@ public DateHistogramGroupingDescriptor() : base() private string? TimeZoneValue { get; set; } /// - /// The interval of time buckets to be generated when rolling up. + /// + /// The interval of time buckets to be generated when rolling up. + /// /// public DateHistogramGroupingDescriptor CalendarInterval(Elastic.Clients.Elasticsearch.Duration? calendarInterval) { @@ -90,7 +108,13 @@ public DateHistogramGroupingDescriptor CalendarInterval(Elastic.Clien } /// - /// How long to wait before rolling up new documents.
By default, the indexer attempts to roll up all data that is available.
However, it is not uncommon for data to arrive out of order.
The indexer is unable to deal with data that arrives after a time-span has been rolled up.
You need to specify a delay that matches the longest period of time you expect out-of-order data to arrive. + /// + /// How long to wait before rolling up new documents. + /// By default, the indexer attempts to roll up all data that is available. + /// However, it is not uncommon for data to arrive out of order. + /// The indexer is unable to deal with data that arrives after a time-span has been rolled up. + /// You need to specify a delay that matches the longest period of time you expect out-of-order data to arrive. + /// /// public DateHistogramGroupingDescriptor Delay(Elastic.Clients.Elasticsearch.Duration? delay) { @@ -99,7 +123,9 @@ public DateHistogramGroupingDescriptor Delay(Elastic.Clients.Elastics } /// - /// The date field that is to be rolled up. + /// + /// The date field that is to be rolled up. + /// /// public DateHistogramGroupingDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -108,7 +134,9 @@ public DateHistogramGroupingDescriptor Field(Elastic.Clients.Elastics } /// - /// The date field that is to be rolled up. + /// + /// The date field that is to be rolled up. + /// /// public DateHistogramGroupingDescriptor Field(Expression> field) { @@ -117,7 +145,9 @@ public DateHistogramGroupingDescriptor Field(Expression - /// The date field that is to be rolled up. + /// + /// The date field that is to be rolled up. + /// /// public DateHistogramGroupingDescriptor Field(Expression> field) { @@ -126,7 +156,9 @@ public DateHistogramGroupingDescriptor Field(Expression - /// The interval of time buckets to be generated when rolling up. + /// + /// The interval of time buckets to be generated when rolling up. + /// /// public DateHistogramGroupingDescriptor FixedInterval(Elastic.Clients.Elasticsearch.Duration? fixedInterval) { @@ -147,7 +179,11 @@ public DateHistogramGroupingDescriptor Interval(Elastic.Clients.Elast } /// - /// Defines what `time_zone` the rollup documents are stored as.
Unlike raw data, which can shift timezones on the fly, rolled documents have to be stored with a specific timezone.
By default, rollup documents are stored in `UTC`. + /// + /// Defines what time_zone the rollup documents are stored as. + /// Unlike raw data, which can shift timezones on the fly, rolled documents have to be stored with a specific timezone. + /// By default, rollup documents are stored in UTC. + /// /// public DateHistogramGroupingDescriptor TimeZone(string? timeZone) { @@ -217,7 +253,9 @@ public DateHistogramGroupingDescriptor() : base() private string? TimeZoneValue { get; set; } /// - /// The interval of time buckets to be generated when rolling up. + /// + /// The interval of time buckets to be generated when rolling up. + /// /// public DateHistogramGroupingDescriptor CalendarInterval(Elastic.Clients.Elasticsearch.Duration? calendarInterval) { @@ -226,7 +264,13 @@ public DateHistogramGroupingDescriptor CalendarInterval(Elastic.Clients.Elastics } /// - /// How long to wait before rolling up new documents.
By default, the indexer attempts to roll up all data that is available.
However, it is not uncommon for data to arrive out of order.
The indexer is unable to deal with data that arrives after a time-span has been rolled up.
You need to specify a delay that matches the longest period of time you expect out-of-order data to arrive. + /// + /// How long to wait before rolling up new documents. + /// By default, the indexer attempts to roll up all data that is available. + /// However, it is not uncommon for data to arrive out of order. + /// The indexer is unable to deal with data that arrives after a time-span has been rolled up. + /// You need to specify a delay that matches the longest period of time you expect out-of-order data to arrive. + /// /// public DateHistogramGroupingDescriptor Delay(Elastic.Clients.Elasticsearch.Duration? delay) { @@ -235,7 +279,9 @@ public DateHistogramGroupingDescriptor Delay(Elastic.Clients.Elasticsearch.Durat } /// - /// The date field that is to be rolled up. + /// + /// The date field that is to be rolled up. + /// /// public DateHistogramGroupingDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -244,7 +290,9 @@ public DateHistogramGroupingDescriptor Field(Elastic.Clients.Elasticsearch.Field } /// - /// The date field that is to be rolled up. + /// + /// The date field that is to be rolled up. + /// /// public DateHistogramGroupingDescriptor Field(Expression> field) { @@ -253,7 +301,9 @@ public DateHistogramGroupingDescriptor Field(Expression - /// The date field that is to be rolled up. + /// + /// The date field that is to be rolled up. + /// /// public DateHistogramGroupingDescriptor Field(Expression> field) { @@ -262,7 +312,9 @@ public DateHistogramGroupingDescriptor Field(Expression - /// The interval of time buckets to be generated when rolling up. + /// + /// The interval of time buckets to be generated when rolling up. + /// /// public DateHistogramGroupingDescriptor FixedInterval(Elastic.Clients.Elasticsearch.Duration? fixedInterval) { @@ -283,7 +335,11 @@ public DateHistogramGroupingDescriptor Interval(Elastic.Clients.Elasticsearch.Du } /// - /// Defines what `time_zone` the rollup documents are stored as.
Unlike raw data, which can shift timezones on the fly, rolled documents have to be stored with a specific timezone.
By default, rollup documents are stored in `UTC`. + /// + /// Defines what time_zone the rollup documents are stored as. + /// Unlike raw data, which can shift timezones on the fly, rolled documents have to be stored with a specific timezone. + /// By default, rollup documents are stored in UTC. + /// /// public DateHistogramGroupingDescriptor TimeZone(string? timeZone) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Rollup/FieldMetric.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Rollup/FieldMetric.g.cs index c9aacd09467..724b1020dd8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Rollup/FieldMetric.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Rollup/FieldMetric.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Rollup; public sealed partial class FieldMetric { /// - /// The field to collect metrics for. This must be a numeric of some kind. + /// + /// The field to collect metrics for. This must be a numeric of some kind. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// An array of metrics to collect for the field. At least one metric must be configured. + /// + /// An array of metrics to collect for the field. At least one metric must be configured. + /// /// [JsonInclude, JsonPropertyName("metrics")] public ICollection Metrics { get; set; } @@ -54,7 +58,9 @@ public FieldMetricDescriptor() : base() private ICollection MetricsValue { get; set; } /// - /// The field to collect metrics for. This must be a numeric of some kind. + /// + /// The field to collect metrics for. This must be a numeric of some kind. + /// /// public FieldMetricDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -63,7 +69,9 @@ public FieldMetricDescriptor Field(Elastic.Clients.Elasticsearch.Fiel } /// - /// The field to collect metrics for. This must be a numeric of some kind. + /// + /// The field to collect metrics for. This must be a numeric of some kind. + /// /// public FieldMetricDescriptor Field(Expression> field) { @@ -72,7 +80,9 @@ public FieldMetricDescriptor Field(Expression - /// The field to collect metrics for. This must be a numeric of some kind. + /// + /// The field to collect metrics for. This must be a numeric of some kind. + /// /// public FieldMetricDescriptor Field(Expression> field) { @@ -81,7 +91,9 @@ public FieldMetricDescriptor Field(Expression } /// - /// An array of metrics to collect for the field. At least one metric must be configured. + /// + /// An array of metrics to collect for the field. At least one metric must be configured. + /// /// public FieldMetricDescriptor Metrics(ICollection metrics) { @@ -112,7 +124,9 @@ public FieldMetricDescriptor() : base() private ICollection MetricsValue { get; set; } /// - /// The field to collect metrics for. This must be a numeric of some kind. + /// + /// The field to collect metrics for. This must be a numeric of some kind. + /// /// public FieldMetricDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -121,7 +135,9 @@ public FieldMetricDescriptor Field(Elastic.Clients.Elasticsearch.Field field) } /// - /// The field to collect metrics for. This must be a numeric of some kind. + /// + /// The field to collect metrics for. This must be a numeric of some kind. + /// /// public FieldMetricDescriptor Field(Expression> field) { @@ -130,7 +146,9 @@ public FieldMetricDescriptor Field(Expression - /// The field to collect metrics for. This must be a numeric of some kind. + /// + /// The field to collect metrics for. This must be a numeric of some kind. + /// /// public FieldMetricDescriptor Field(Expression> field) { @@ -139,7 +157,9 @@ public FieldMetricDescriptor Field(Expression } /// - /// An array of metrics to collect for the field. At least one metric must be configured. + /// + /// An array of metrics to collect for the field. At least one metric must be configured. + /// /// public FieldMetricDescriptor Metrics(ICollection metrics) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Rollup/Groupings.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Rollup/Groupings.g.cs index d1d306bbfff..b484b891d30 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Rollup/Groupings.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Rollup/Groupings.g.cs @@ -30,19 +30,28 @@ namespace Elastic.Clients.Elasticsearch.Rollup; public sealed partial class Groupings { /// - /// A date histogram group aggregates a date field into time-based buckets.
This group is mandatory; you currently cannot roll up documents without a timestamp and a `date_histogram` group. + /// + /// A date histogram group aggregates a date field into time-based buckets. + /// This group is mandatory; you currently cannot roll up documents without a timestamp and a date_histogram group. + /// /// [JsonInclude, JsonPropertyName("date_histogram")] public Elastic.Clients.Elasticsearch.Rollup.DateHistogramGrouping? DateHistogram { get; set; } /// - /// The histogram group aggregates one or more numeric fields into numeric histogram intervals. + /// + /// The histogram group aggregates one or more numeric fields into numeric histogram intervals. + /// /// [JsonInclude, JsonPropertyName("histogram")] public Elastic.Clients.Elasticsearch.Rollup.HistogramGrouping? Histogram { get; set; } /// - /// The terms group can be used on keyword or numeric fields to allow bucketing via the terms aggregation at a later point.
The indexer enumerates and stores all values of a field for each time-period.
This can be potentially costly for high-cardinality groups such as IP addresses, especially if the time-bucket is particularly sparse. + /// + /// The terms group can be used on keyword or numeric fields to allow bucketing via the terms aggregation at a later point. + /// The indexer enumerates and stores all values of a field for each time-period. + /// This can be potentially costly for high-cardinality groups such as IP addresses, especially if the time-bucket is particularly sparse. + /// /// [JsonInclude, JsonPropertyName("terms")] public Elastic.Clients.Elasticsearch.Rollup.TermsGrouping? Terms { get; set; } @@ -67,7 +76,10 @@ public GroupingsDescriptor() : base() private Action> TermsDescriptorAction { get; set; } /// - /// A date histogram group aggregates a date field into time-based buckets.
This group is mandatory; you currently cannot roll up documents without a timestamp and a `date_histogram` group. + /// + /// A date histogram group aggregates a date field into time-based buckets. + /// This group is mandatory; you currently cannot roll up documents without a timestamp and a date_histogram group. + /// /// public GroupingsDescriptor DateHistogram(Elastic.Clients.Elasticsearch.Rollup.DateHistogramGrouping? dateHistogram) { @@ -94,7 +106,9 @@ public GroupingsDescriptor DateHistogram(Action - /// The histogram group aggregates one or more numeric fields into numeric histogram intervals. + /// + /// The histogram group aggregates one or more numeric fields into numeric histogram intervals. + /// /// public GroupingsDescriptor Histogram(Elastic.Clients.Elasticsearch.Rollup.HistogramGrouping? histogram) { @@ -121,7 +135,11 @@ public GroupingsDescriptor Histogram(Action - /// The terms group can be used on keyword or numeric fields to allow bucketing via the terms aggregation at a later point.
The indexer enumerates and stores all values of a field for each time-period.
This can be potentially costly for high-cardinality groups such as IP addresses, especially if the time-bucket is particularly sparse. + /// + /// The terms group can be used on keyword or numeric fields to allow bucketing via the terms aggregation at a later point. + /// The indexer enumerates and stores all values of a field for each time-period. + /// This can be potentially costly for high-cardinality groups such as IP addresses, especially if the time-bucket is particularly sparse. + /// /// public GroupingsDescriptor Terms(Elastic.Clients.Elasticsearch.Rollup.TermsGrouping? terms) { @@ -221,7 +239,10 @@ public GroupingsDescriptor() : base() private Action TermsDescriptorAction { get; set; } /// - /// A date histogram group aggregates a date field into time-based buckets.
This group is mandatory; you currently cannot roll up documents without a timestamp and a `date_histogram` group. + /// + /// A date histogram group aggregates a date field into time-based buckets. + /// This group is mandatory; you currently cannot roll up documents without a timestamp and a date_histogram group. + /// /// public GroupingsDescriptor DateHistogram(Elastic.Clients.Elasticsearch.Rollup.DateHistogramGrouping? dateHistogram) { @@ -248,7 +269,9 @@ public GroupingsDescriptor DateHistogram(Action - /// The histogram group aggregates one or more numeric fields into numeric histogram intervals. + /// + /// The histogram group aggregates one or more numeric fields into numeric histogram intervals. + /// /// public GroupingsDescriptor Histogram(Elastic.Clients.Elasticsearch.Rollup.HistogramGrouping? histogram) { @@ -275,7 +298,11 @@ public GroupingsDescriptor Histogram(Action - /// The terms group can be used on keyword or numeric fields to allow bucketing via the terms aggregation at a later point.
The indexer enumerates and stores all values of a field for each time-period.
This can be potentially costly for high-cardinality groups such as IP addresses, especially if the time-bucket is particularly sparse. + /// + /// The terms group can be used on keyword or numeric fields to allow bucketing via the terms aggregation at a later point. + /// The indexer enumerates and stores all values of a field for each time-period. + /// This can be potentially costly for high-cardinality groups such as IP addresses, especially if the time-bucket is particularly sparse. + /// /// public GroupingsDescriptor Terms(Elastic.Clients.Elasticsearch.Rollup.TermsGrouping? terms) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Rollup/HistogramGrouping.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Rollup/HistogramGrouping.g.cs index e84b8e738a1..01f81c216af 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Rollup/HistogramGrouping.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Rollup/HistogramGrouping.g.cs @@ -30,14 +30,22 @@ namespace Elastic.Clients.Elasticsearch.Rollup; public sealed partial class HistogramGrouping { /// - /// The set of fields that you wish to build histograms for.
All fields specified must be some kind of numeric.
Order does not matter. + /// + /// The set of fields that you wish to build histograms for. + /// All fields specified must be some kind of numeric. + /// Order does not matter. + /// /// [JsonInclude, JsonPropertyName("fields")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] public Elastic.Clients.Elasticsearch.Fields Fields { get; set; } /// - /// The interval of histogram buckets to be generated when rolling up.
For example, a value of `5` creates buckets that are five units wide (`0-5`, `5-10`, etc).
Note that only one interval can be specified in the histogram group, meaning that all fields being grouped via the histogram must share the same interval. + /// + /// The interval of histogram buckets to be generated when rolling up. + /// For example, a value of 5 creates buckets that are five units wide (0-5, 5-10, etc). + /// Note that only one interval can be specified in the histogram group, meaning that all fields being grouped via the histogram must share the same interval. + /// /// [JsonInclude, JsonPropertyName("interval")] public long Interval { get; set; } @@ -55,7 +63,11 @@ public HistogramGroupingDescriptor() : base() private long IntervalValue { get; set; } /// - /// The set of fields that you wish to build histograms for.
All fields specified must be some kind of numeric.
Order does not matter. + /// + /// The set of fields that you wish to build histograms for. + /// All fields specified must be some kind of numeric. + /// Order does not matter. + /// /// public HistogramGroupingDescriptor Fields(Elastic.Clients.Elasticsearch.Fields fields) { @@ -64,7 +76,11 @@ public HistogramGroupingDescriptor Fields(Elastic.Clients.Elasticsear } /// - /// The interval of histogram buckets to be generated when rolling up.
For example, a value of `5` creates buckets that are five units wide (`0-5`, `5-10`, etc).
Note that only one interval can be specified in the histogram group, meaning that all fields being grouped via the histogram must share the same interval. + /// + /// The interval of histogram buckets to be generated when rolling up. + /// For example, a value of 5 creates buckets that are five units wide (0-5, 5-10, etc). + /// Note that only one interval can be specified in the histogram group, meaning that all fields being grouped via the histogram must share the same interval. + /// /// public HistogramGroupingDescriptor Interval(long interval) { @@ -95,7 +111,11 @@ public HistogramGroupingDescriptor() : base() private long IntervalValue { get; set; } /// - /// The set of fields that you wish to build histograms for.
All fields specified must be some kind of numeric.
Order does not matter. + /// + /// The set of fields that you wish to build histograms for. + /// All fields specified must be some kind of numeric. + /// Order does not matter. + /// /// public HistogramGroupingDescriptor Fields(Elastic.Clients.Elasticsearch.Fields fields) { @@ -104,7 +124,11 @@ public HistogramGroupingDescriptor Fields(Elastic.Clients.Elasticsearch.Fields f } /// - /// The interval of histogram buckets to be generated when rolling up.
For example, a value of `5` creates buckets that are five units wide (`0-5`, `5-10`, etc).
Note that only one interval can be specified in the histogram group, meaning that all fields being grouped via the histogram must share the same interval. + /// + /// The interval of histogram buckets to be generated when rolling up. + /// For example, a value of 5 creates buckets that are five units wide (0-5, 5-10, etc). + /// Note that only one interval can be specified in the histogram group, meaning that all fields being grouped via the histogram must share the same interval. + /// /// public HistogramGroupingDescriptor Interval(long interval) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Rollup/TermsGrouping.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Rollup/TermsGrouping.g.cs index 66264bbb8ba..5a0659a009a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Rollup/TermsGrouping.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Rollup/TermsGrouping.g.cs @@ -30,7 +30,11 @@ namespace Elastic.Clients.Elasticsearch.Rollup; public sealed partial class TermsGrouping { /// - /// The set of fields that you wish to collect terms for.
This array can contain fields that are both keyword and numerics.
Order does not matter. + /// + /// The set of fields that you wish to collect terms for. + /// This array can contain fields that are both keyword and numerics. + /// Order does not matter. + /// /// [JsonInclude, JsonPropertyName("fields")] [JsonConverter(typeof(SingleOrManyFieldsConverter))] @@ -48,7 +52,11 @@ public TermsGroupingDescriptor() : base() private Elastic.Clients.Elasticsearch.Fields FieldsValue { get; set; } /// - /// The set of fields that you wish to collect terms for.
This array can contain fields that are both keyword and numerics.
Order does not matter. + /// + /// The set of fields that you wish to collect terms for. + /// This array can contain fields that are both keyword and numerics. + /// Order does not matter. + /// /// public TermsGroupingDescriptor Fields(Elastic.Clients.Elasticsearch.Fields fields) { @@ -76,7 +84,11 @@ public TermsGroupingDescriptor() : base() private Elastic.Clients.Elasticsearch.Fields FieldsValue { get; set; } /// - /// The set of fields that you wish to collect terms for.
This array can contain fields that are both keyword and numerics.
Order does not matter. + /// + /// The set of fields that you wish to collect terms for. + /// This array can contain fields that are both keyword and numerics. + /// Order does not matter. + /// /// public TermsGroupingDescriptor Fields(Elastic.Clients.Elasticsearch.Fields fields) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/RrfRank.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/RrfRank.g.cs index 0ea1d4115f5..d2ab09e6875 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/RrfRank.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/RrfRank.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class RrfRank { /// - /// How much influence documents in individual result sets per query have over the final ranked result set + /// + /// How much influence documents in individual result sets per query have over the final ranked result set + /// /// [JsonInclude, JsonPropertyName("rank_constant")] public long? RankConstant { get; set; } /// - /// Size of the individual result sets per query + /// + /// Size of the individual result sets per query + /// /// [JsonInclude, JsonPropertyName("rank_window_size")] public long? RankWindowSize { get; set; } @@ -56,7 +60,9 @@ public RrfRankDescriptor() : base() private long? RankWindowSizeValue { get; set; } /// - /// How much influence documents in individual result sets per query have over the final ranked result set + /// + /// How much influence documents in individual result sets per query have over the final ranked result set + /// /// public RrfRankDescriptor RankConstant(long? rankConstant) { @@ -65,7 +71,9 @@ public RrfRankDescriptor RankConstant(long? rankConstant) } /// - /// Size of the individual result sets per query + /// + /// Size of the individual result sets per query + /// /// public RrfRankDescriptor RankWindowSize(long? rankWindowSize) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Script.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Script.g.cs index 81a1f05b241..bb90104b52e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Script.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Script.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class Script { /// - /// The `id` for a stored script. + /// + /// The id for a stored script. + /// /// [JsonInclude, JsonPropertyName("id")] public Elastic.Clients.Elasticsearch.Id? Id { get; set; } /// - /// Specifies the language the script is written in. + /// + /// Specifies the language the script is written in. + /// /// [JsonInclude, JsonPropertyName("lang")] public Elastic.Clients.Elasticsearch.ScriptLanguage? Lang { get; set; } @@ -44,13 +48,18 @@ public sealed partial class Script public IDictionary? Options { get; set; } /// - /// Specifies any named parameters that are passed into the script as variables.
Use parameters instead of hard-coded values to decrease compile time. + /// + /// Specifies any named parameters that are passed into the script as variables. + /// Use parameters instead of hard-coded values to decrease compile time. + /// /// [JsonInclude, JsonPropertyName("params")] public IDictionary? Params { get; set; } /// - /// The script source. + /// + /// The script source. + /// /// [JsonInclude, JsonPropertyName("source")] public string? Source { get; set; } @@ -73,7 +82,9 @@ public ScriptDescriptor() : base() private string? SourceValue { get; set; } /// - /// The `id` for a stored script. + /// + /// The id for a stored script. + /// /// public ScriptDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) { @@ -82,7 +93,9 @@ public ScriptDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) } /// - /// Specifies the language the script is written in. + /// + /// Specifies the language the script is written in. + /// /// public ScriptDescriptor Lang(Elastic.Clients.Elasticsearch.ScriptLanguage? lang) { @@ -97,7 +110,10 @@ public ScriptDescriptor Options(Func, FluentDic } /// - /// Specifies any named parameters that are passed into the script as variables.
Use parameters instead of hard-coded values to decrease compile time. + /// + /// Specifies any named parameters that are passed into the script as variables. + /// Use parameters instead of hard-coded values to decrease compile time. + /// /// public ScriptDescriptor Params(Func, FluentDictionary> selector) { @@ -106,7 +122,9 @@ public ScriptDescriptor Params(Func, FluentDict } /// - /// The script source. + /// + /// The script source. + /// /// public ScriptDescriptor Source(string? source) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/SearchApplication/AnalyticsCollection.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/SearchApplication/AnalyticsCollection.g.cs index 9ef84ef0e41..80c6a216325 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/SearchApplication/AnalyticsCollection.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/SearchApplication/AnalyticsCollection.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.SearchApplication; public sealed partial class AnalyticsCollection { /// - /// Data stream for the collection. + /// + /// Data stream for the collection. + /// /// [JsonInclude, JsonPropertyName("event_data_stream")] public Elastic.Clients.Elasticsearch.SearchApplication.EventDataStream EventDataStream { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/SearchApplication/SearchApplication.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/SearchApplication/SearchApplication.g.cs index 30b5379020b..645430c37b4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/SearchApplication/SearchApplication.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/SearchApplication/SearchApplication.g.cs @@ -30,31 +30,41 @@ namespace Elastic.Clients.Elasticsearch.SearchApplication; public sealed partial class SearchApplication { /// - /// Analytics collection associated to the Search Application. + /// + /// Analytics collection associated to the Search Application. + /// /// [JsonInclude, JsonPropertyName("analytics_collection_name")] public Elastic.Clients.Elasticsearch.Name? AnalyticsCollectionName { get; set; } /// - /// Indices that are part of the Search Application. + /// + /// Indices that are part of the Search Application. + /// /// [JsonInclude, JsonPropertyName("indices")] public ICollection Indices { get; set; } /// - /// Search Application name. + /// + /// Search Application name. + /// /// [JsonInclude, JsonPropertyName("name")] public Elastic.Clients.Elasticsearch.Name Name { get; set; } /// - /// Search template to use on search operations. + /// + /// Search template to use on search operations. + /// /// [JsonInclude, JsonPropertyName("template")] public Elastic.Clients.Elasticsearch.SearchApplication.SearchApplicationTemplate? Template { get; set; } /// - /// Last time the Search Application was updated. + /// + /// Last time the Search Application was updated. + /// /// [JsonInclude, JsonPropertyName("updated_at_millis")] public long UpdatedAtMillis { get; set; } @@ -77,7 +87,9 @@ public SearchApplicationDescriptor() : base() private long UpdatedAtMillisValue { get; set; } /// - /// Analytics collection associated to the Search Application. + /// + /// Analytics collection associated to the Search Application. + /// /// public SearchApplicationDescriptor AnalyticsCollectionName(Elastic.Clients.Elasticsearch.Name? analyticsCollectionName) { @@ -86,7 +98,9 @@ public SearchApplicationDescriptor AnalyticsCollectionName(Elastic.Clients.Elast } /// - /// Indices that are part of the Search Application. + /// + /// Indices that are part of the Search Application. + /// /// public SearchApplicationDescriptor Indices(ICollection indices) { @@ -95,7 +109,9 @@ public SearchApplicationDescriptor Indices(ICollection - /// Search Application name. + /// + /// Search Application name. + /// /// public SearchApplicationDescriptor Name(Elastic.Clients.Elasticsearch.Name name) { @@ -104,7 +120,9 @@ public SearchApplicationDescriptor Name(Elastic.Clients.Elasticsearch.Name name) } /// - /// Search template to use on search operations. + /// + /// Search template to use on search operations. + /// /// public SearchApplicationDescriptor Template(Elastic.Clients.Elasticsearch.SearchApplication.SearchApplicationTemplate? template) { @@ -131,7 +149,9 @@ public SearchApplicationDescriptor Template(Action - /// Last time the Search Application was updated. + /// + /// Last time the Search Application was updated. + /// /// public SearchApplicationDescriptor UpdatedAtMillis(long updatedAtMillis) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/SearchApplication/SearchApplicationListItem.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/SearchApplication/SearchApplicationListItem.g.cs index 24ad41c93b6..f660ec1cfd7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/SearchApplication/SearchApplicationListItem.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/SearchApplication/SearchApplicationListItem.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.SearchApplication; public sealed partial class SearchApplicationListItem { /// - /// Analytics collection associated to the Search Application + /// + /// Analytics collection associated to the Search Application + /// /// [JsonInclude, JsonPropertyName("analytics_collection_name")] public string? AnalyticsCollectionName { get; init; } /// - /// Indices that are part of the Search Application + /// + /// Indices that are part of the Search Application + /// /// [JsonInclude, JsonPropertyName("indices")] public IReadOnlyCollection Indices { get; init; } /// - /// Search Application name + /// + /// Search Application name + /// /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } /// - /// Last time the Search Application was updated + /// + /// Last time the Search Application was updated + /// /// [JsonInclude, JsonPropertyName("updated_at_millis")] public long UpdatedAtMillis { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/SearchApplication/SearchApplicationTemplate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/SearchApplication/SearchApplicationTemplate.g.cs index 63b7682fb46..3bbc380fe78 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/SearchApplication/SearchApplicationTemplate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/SearchApplication/SearchApplicationTemplate.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch.SearchApplication; public sealed partial class SearchApplicationTemplate { /// - /// The associated mustache template. + /// + /// The associated mustache template. + /// /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Script Script { get; set; } @@ -49,7 +51,9 @@ public SearchApplicationTemplateDescriptor() : base() private Action ScriptDescriptorAction { get; set; } /// - /// The associated mustache template. + /// + /// The associated mustache template. + /// /// public SearchApplicationTemplateDescriptor Script(Elastic.Clients.Elasticsearch.Script script) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/SegmentsStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/SegmentsStats.g.cs index 13fa6dae98b..6f46a8cd60d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/SegmentsStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/SegmentsStats.g.cs @@ -30,37 +30,51 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class SegmentsStats { /// - /// Total number of segments across all shards assigned to selected nodes. + /// + /// Total number of segments across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("count")] public int Count { get; init; } /// - /// Total amount of memory used for doc values across all shards assigned to selected nodes. + /// + /// Total amount of memory used for doc values across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("doc_values_memory")] public Elastic.Clients.Elasticsearch.ByteSize? DocValuesMemory { get; init; } /// - /// Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes. + /// + /// Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("doc_values_memory_in_bytes")] public long DocValuesMemoryInBytes { get; init; } /// - /// This object is not populated by the cluster stats API.
To get information on segment files, use the node stats API. + /// + /// This object is not populated by the cluster stats API. + /// To get information on segment files, use the node stats API. + /// /// [JsonInclude, JsonPropertyName("file_sizes")] public IReadOnlyDictionary FileSizes { get; init; } /// - /// Total amount of memory used by fixed bit sets across all shards assigned to selected nodes.
Fixed bit sets are used for nested object field types and type filters for join fields. + /// + /// Total amount of memory used by fixed bit sets across all shards assigned to selected nodes. + /// Fixed bit sets are used for nested object field types and type filters for join fields. + /// /// [JsonInclude, JsonPropertyName("fixed_bit_set")] public Elastic.Clients.Elasticsearch.ByteSize? FixedBitSet { get; init; } /// - /// Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes. + /// + /// Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("fixed_bit_set_memory_in_bytes")] public long FixedBitSetMemoryInBytes { get; init; } @@ -68,61 +82,81 @@ public sealed partial class SegmentsStats public long? IndexWriterMaxMemoryInBytes { get; init; } /// - /// Total amount of memory used by all index writers across all shards assigned to selected nodes. + /// + /// Total amount of memory used by all index writers across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("index_writer_memory")] public Elastic.Clients.Elasticsearch.ByteSize? IndexWriterMemory { get; init; } /// - /// Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes. + /// + /// Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("index_writer_memory_in_bytes")] public long IndexWriterMemoryInBytes { get; init; } /// - /// Unix timestamp, in milliseconds, of the most recently retried indexing request. + /// + /// Unix timestamp, in milliseconds, of the most recently retried indexing request. + /// /// [JsonInclude, JsonPropertyName("max_unsafe_auto_id_timestamp")] public long MaxUnsafeAutoIdTimestamp { get; init; } /// - /// Total amount of memory used for segments across all shards assigned to selected nodes. + /// + /// Total amount of memory used for segments across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("memory")] public Elastic.Clients.Elasticsearch.ByteSize? Memory { get; init; } /// - /// Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes. + /// + /// Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("memory_in_bytes")] public long MemoryInBytes { get; init; } /// - /// Total amount of memory used for normalization factors across all shards assigned to selected nodes. + /// + /// Total amount of memory used for normalization factors across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("norms_memory")] public Elastic.Clients.Elasticsearch.ByteSize? NormsMemory { get; init; } /// - /// Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes. + /// + /// Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("norms_memory_in_bytes")] public long NormsMemoryInBytes { get; init; } /// - /// Total amount of memory used for points across all shards assigned to selected nodes. + /// + /// Total amount of memory used for points across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("points_memory")] public Elastic.Clients.Elasticsearch.ByteSize? PointsMemory { get; init; } /// - /// Total amount, in bytes, of memory used for points across all shards assigned to selected nodes. + /// + /// Total amount, in bytes, of memory used for points across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("points_memory_in_bytes")] public long PointsMemoryInBytes { get; init; } /// - /// Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes. + /// + /// Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("stored_fields_memory_in_bytes")] public long StoredFieldsMemoryInBytes { get; init; } @@ -130,37 +164,49 @@ public sealed partial class SegmentsStats public Elastic.Clients.Elasticsearch.ByteSize? StoredMemory { get; init; } /// - /// Total amount of memory used for terms across all shards assigned to selected nodes. + /// + /// Total amount of memory used for terms across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("terms_memory")] public Elastic.Clients.Elasticsearch.ByteSize? TermsMemory { get; init; } /// - /// Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes. + /// + /// Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("terms_memory_in_bytes")] public long TermsMemoryInBytes { get; init; } /// - /// Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes. + /// + /// Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("term_vectors_memory_in_bytes")] public long TermVectorsMemoryInBytes { get; init; } /// - /// Total amount of memory used for term vectors across all shards assigned to selected nodes. + /// + /// Total amount of memory used for term vectors across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("term_vectory_memory")] public Elastic.Clients.Elasticsearch.ByteSize? TermVectoryMemory { get; init; } /// - /// Total amount of memory used by all version maps across all shards assigned to selected nodes. + /// + /// Total amount of memory used by all version maps across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("version_map_memory")] public Elastic.Clients.Elasticsearch.ByteSize? VersionMapMemory { get; init; } /// - /// Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes. + /// + /// Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("version_map_memory_in_bytes")] public long VersionMapMemoryInBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/ShardStatistics.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/ShardStatistics.g.cs index 7929de45240..81e8acb34b8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/ShardStatistics.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/ShardStatistics.g.cs @@ -37,13 +37,17 @@ public sealed partial class ShardStatistics public int? Skipped { get; init; } /// - /// Indicates how many shards have successfully run the search. + /// + /// Indicates how many shards have successfully run the search. + /// /// [JsonInclude, JsonPropertyName("successful")] public int Successful { get; init; } /// - /// Indicates how many shards the search will run on overall. + /// + /// Indicates how many shards the search will run on overall. + /// /// [JsonInclude, JsonPropertyName("total")] public int Total { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Slices.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Slices.g.cs index 7d1cbaf4684..3feca1bb407 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Slices.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Slices.g.cs @@ -31,7 +31,9 @@ namespace Elastic.Clients.Elasticsearch; /// -/// Slices configuration used to parallelize a process. +/// +/// Slices configuration used to parallelize a process. +/// /// public sealed partial class Slices : Union { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Snapshot/CleanupRepositoryResults.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Snapshot/CleanupRepositoryResults.g.cs index bb920aa8d5f..d4f7a7f3738 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Snapshot/CleanupRepositoryResults.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Snapshot/CleanupRepositoryResults.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Snapshot; public sealed partial class CleanupRepositoryResults { /// - /// Number of binary large objects (blobs) removed during cleanup. + /// + /// Number of binary large objects (blobs) removed during cleanup. + /// /// [JsonInclude, JsonPropertyName("deleted_blobs")] public long DeletedBlobs { get; init; } /// - /// Number of bytes freed by cleanup operations. + /// + /// Number of bytes freed by cleanup operations. + /// /// [JsonInclude, JsonPropertyName("deleted_bytes")] public long DeletedBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/SnapshotLifecycleManagement/Retention.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/SnapshotLifecycleManagement/Retention.g.cs index 34bce79ce51..5fd8b5dceba 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/SnapshotLifecycleManagement/Retention.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/SnapshotLifecycleManagement/Retention.g.cs @@ -30,19 +30,25 @@ namespace Elastic.Clients.Elasticsearch.SnapshotLifecycleManagement; public sealed partial class Retention { /// - /// Time period after which a snapshot is considered expired and eligible for deletion. SLM deletes expired snapshots based on the slm.retention_schedule. + /// + /// Time period after which a snapshot is considered expired and eligible for deletion. SLM deletes expired snapshots based on the slm.retention_schedule. + /// /// [JsonInclude, JsonPropertyName("expire_after")] public Elastic.Clients.Elasticsearch.Duration ExpireAfter { get; set; } /// - /// Maximum number of snapshots to retain, even if the snapshots have not yet expired. If the number of snapshots in the repository exceeds this limit, the policy retains the most recent snapshots and deletes older snapshots. + /// + /// Maximum number of snapshots to retain, even if the snapshots have not yet expired. If the number of snapshots in the repository exceeds this limit, the policy retains the most recent snapshots and deletes older snapshots. + /// /// [JsonInclude, JsonPropertyName("max_count")] public int MaxCount { get; set; } /// - /// Minimum number of snapshots to retain, even if the snapshots have expired. + /// + /// Minimum number of snapshots to retain, even if the snapshots have expired. + /// /// [JsonInclude, JsonPropertyName("min_count")] public int MinCount { get; set; } @@ -61,7 +67,9 @@ public RetentionDescriptor() : base() private int MinCountValue { get; set; } /// - /// Time period after which a snapshot is considered expired and eligible for deletion. SLM deletes expired snapshots based on the slm.retention_schedule. + /// + /// Time period after which a snapshot is considered expired and eligible for deletion. SLM deletes expired snapshots based on the slm.retention_schedule. + /// /// public RetentionDescriptor ExpireAfter(Elastic.Clients.Elasticsearch.Duration expireAfter) { @@ -70,7 +78,9 @@ public RetentionDescriptor ExpireAfter(Elastic.Clients.Elasticsearch.Duration ex } /// - /// Maximum number of snapshots to retain, even if the snapshots have not yet expired. If the number of snapshots in the repository exceeds this limit, the policy retains the most recent snapshots and deletes older snapshots. + /// + /// Maximum number of snapshots to retain, even if the snapshots have not yet expired. If the number of snapshots in the repository exceeds this limit, the policy retains the most recent snapshots and deletes older snapshots. + /// /// public RetentionDescriptor MaxCount(int maxCount) { @@ -79,7 +89,9 @@ public RetentionDescriptor MaxCount(int maxCount) } /// - /// Minimum number of snapshots to retain, even if the snapshots have expired. + /// + /// Minimum number of snapshots to retain, even if the snapshots have expired. + /// /// public RetentionDescriptor MinCount(int minCount) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/SnapshotLifecycleManagement/SlmConfiguration.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/SnapshotLifecycleManagement/SlmConfiguration.g.cs index 1fb8f0f1d0b..9d69d1752a0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/SnapshotLifecycleManagement/SlmConfiguration.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/SnapshotLifecycleManagement/SlmConfiguration.g.cs @@ -30,37 +30,51 @@ namespace Elastic.Clients.Elasticsearch.SnapshotLifecycleManagement; public sealed partial class SlmConfiguration { /// - /// A list of feature states to be included in this snapshot. A list of features available for inclusion in the snapshot and their descriptions be can be retrieved using the get features API.
Each feature state includes one or more system indices containing data necessary for the function of that feature. Providing an empty array will include no feature states in the snapshot, regardless of the value of include_global_state. By default, all available feature states will be included in the snapshot if include_global_state is true, or no feature states if include_global_state is false. + /// + /// A list of feature states to be included in this snapshot. A list of features available for inclusion in the snapshot and their descriptions be can be retrieved using the get features API. + /// Each feature state includes one or more system indices containing data necessary for the function of that feature. Providing an empty array will include no feature states in the snapshot, regardless of the value of include_global_state. By default, all available feature states will be included in the snapshot if include_global_state is true, or no feature states if include_global_state is false. + /// /// [JsonInclude, JsonPropertyName("feature_states")] public ICollection? FeatureStates { get; set; } /// - /// If false, the snapshot fails if any data stream or index in indices is missing or closed. If true, the snapshot ignores missing or closed data streams and indices. + /// + /// If false, the snapshot fails if any data stream or index in indices is missing or closed. If true, the snapshot ignores missing or closed data streams and indices. + /// /// [JsonInclude, JsonPropertyName("ignore_unavailable")] public bool? IgnoreUnavailable { get; set; } /// - /// If true, the current global state is included in the snapshot. + /// + /// If true, the current global state is included in the snapshot. + /// /// [JsonInclude, JsonPropertyName("include_global_state")] public bool? IncludeGlobalState { get; set; } /// - /// A comma-separated list of data streams and indices to include in the snapshot. Multi-index syntax is supported.
By default, a snapshot includes all data streams and indices in the cluster. If this argument is provided, the snapshot only includes the specified data streams and clusters. + /// + /// A comma-separated list of data streams and indices to include in the snapshot. Multi-index syntax is supported. + /// By default, a snapshot includes all data streams and indices in the cluster. If this argument is provided, the snapshot only includes the specified data streams and clusters. + /// /// [JsonInclude, JsonPropertyName("indices")] public Elastic.Clients.Elasticsearch.Indices? Indices { get; set; } /// - /// Attaches arbitrary metadata to the snapshot, such as a record of who took the snapshot, why it was taken, or any other useful data. Metadata must be less than 1024 bytes. + /// + /// Attaches arbitrary metadata to the snapshot, such as a record of who took the snapshot, why it was taken, or any other useful data. Metadata must be less than 1024 bytes. + /// /// [JsonInclude, JsonPropertyName("metadata")] public IDictionary? Metadata { get; set; } /// - /// If false, the entire snapshot will fail if one or more indices included in the snapshot do not have all primary shards available. + /// + /// If false, the entire snapshot will fail if one or more indices included in the snapshot do not have all primary shards available. + /// /// [JsonInclude, JsonPropertyName("partial")] public bool? Partial { get; set; } @@ -82,7 +96,10 @@ public SlmConfigurationDescriptor() : base() private bool? PartialValue { get; set; } /// - /// A list of feature states to be included in this snapshot. A list of features available for inclusion in the snapshot and their descriptions be can be retrieved using the get features API.
Each feature state includes one or more system indices containing data necessary for the function of that feature. Providing an empty array will include no feature states in the snapshot, regardless of the value of include_global_state. By default, all available feature states will be included in the snapshot if include_global_state is true, or no feature states if include_global_state is false. + /// + /// A list of feature states to be included in this snapshot. A list of features available for inclusion in the snapshot and their descriptions be can be retrieved using the get features API. + /// Each feature state includes one or more system indices containing data necessary for the function of that feature. Providing an empty array will include no feature states in the snapshot, regardless of the value of include_global_state. By default, all available feature states will be included in the snapshot if include_global_state is true, or no feature states if include_global_state is false. + /// /// public SlmConfigurationDescriptor FeatureStates(ICollection? featureStates) { @@ -91,7 +108,9 @@ public SlmConfigurationDescriptor FeatureStates(ICollection? featureStat } /// - /// If false, the snapshot fails if any data stream or index in indices is missing or closed. If true, the snapshot ignores missing or closed data streams and indices. + /// + /// If false, the snapshot fails if any data stream or index in indices is missing or closed. If true, the snapshot ignores missing or closed data streams and indices. + /// /// public SlmConfigurationDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) { @@ -100,7 +119,9 @@ public SlmConfigurationDescriptor IgnoreUnavailable(bool? ignoreUnavailable = tr } /// - /// If true, the current global state is included in the snapshot. + /// + /// If true, the current global state is included in the snapshot. + /// /// public SlmConfigurationDescriptor IncludeGlobalState(bool? includeGlobalState = true) { @@ -109,7 +130,10 @@ public SlmConfigurationDescriptor IncludeGlobalState(bool? includeGlobalState = } /// - /// A comma-separated list of data streams and indices to include in the snapshot. Multi-index syntax is supported.
By default, a snapshot includes all data streams and indices in the cluster. If this argument is provided, the snapshot only includes the specified data streams and clusters. + /// + /// A comma-separated list of data streams and indices to include in the snapshot. Multi-index syntax is supported. + /// By default, a snapshot includes all data streams and indices in the cluster. If this argument is provided, the snapshot only includes the specified data streams and clusters. + /// /// public SlmConfigurationDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? indices) { @@ -118,7 +142,9 @@ public SlmConfigurationDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? } /// - /// Attaches arbitrary metadata to the snapshot, such as a record of who took the snapshot, why it was taken, or any other useful data. Metadata must be less than 1024 bytes. + /// + /// Attaches arbitrary metadata to the snapshot, such as a record of who took the snapshot, why it was taken, or any other useful data. Metadata must be less than 1024 bytes. + /// /// public SlmConfigurationDescriptor Metadata(Func, FluentDictionary> selector) { @@ -127,7 +153,9 @@ public SlmConfigurationDescriptor Metadata(Func } /// - /// If false, the entire snapshot will fail if one or more indices included in the snapshot do not have all primary shards available. + /// + /// If false, the entire snapshot will fail if one or more indices included in the snapshot do not have all primary shards available. + /// /// public SlmConfigurationDescriptor Partial(bool? partial = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/SpecUtils/OverloadOf.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/SpecUtils/OverloadOf.g.cs index 811443b107f..3ad5c752f4e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/SpecUtils/OverloadOf.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/SpecUtils/OverloadOf.g.cs @@ -28,7 +28,11 @@ namespace Elastic.Clients.Elasticsearch.SpecUtils; /// -/// A class that implements `OverloadOf` should have the exact same properties with the same types.
It can change if a property is required or not. There is no need to port the descriptions
and js doc tags, the compiler will do that for you. +/// +/// A class that implements OverloadOf should have the exact same properties with the same types. +/// It can change if a property is required or not. There is no need to port the descriptions +/// and js doc tags, the compiler will do that for you. +/// /// public sealed partial class OverloadOf { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/StandardRetriever.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/StandardRetriever.g.cs index f7d818ab545..2cac0294e41 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/StandardRetriever.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/StandardRetriever.g.cs @@ -30,45 +30,59 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class StandardRetriever { /// - /// Collapses the top documents by a specified key into a single top document per key. + /// + /// Collapses the top documents by a specified key into a single top document per key. + /// /// [JsonInclude, JsonPropertyName("collapse")] public Elastic.Clients.Elasticsearch.Core.Search.FieldCollapse? Collapse { get; set; } /// - /// Query to filter the documents that can match. + /// + /// Query to filter the documents that can match. + /// /// [JsonInclude, JsonPropertyName("filter")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.QueryDsl.Query))] public ICollection? Filter { get; set; } /// - /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// + /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// /// [JsonInclude, JsonPropertyName("min_score")] public float? MinScore { get; set; } /// - /// Defines a query to retrieve a set of top documents. + /// + /// Defines a query to retrieve a set of top documents. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Query { get; set; } /// - /// Defines a search after object parameter used for pagination. + /// + /// Defines a search after object parameter used for pagination. + /// /// [JsonInclude, JsonPropertyName("search_after")] public ICollection? SearchAfter { get; set; } /// - /// A sort object that that specifies the order of matching documents. + /// + /// A sort object that that specifies the order of matching documents. + /// /// [JsonInclude, JsonPropertyName("sort")] [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.SortOptions))] public ICollection? Sort { get; set; } /// - /// Maximum number of documents to collect for each shard. + /// + /// Maximum number of documents to collect for each shard. + /// /// [JsonInclude, JsonPropertyName("terminate_after")] public int? TerminateAfter { get; set; } @@ -103,7 +117,9 @@ public StandardRetrieverDescriptor() : base() private int? TerminateAfterValue { get; set; } /// - /// Collapses the top documents by a specified key into a single top document per key. + /// + /// Collapses the top documents by a specified key into a single top document per key. + /// /// public StandardRetrieverDescriptor Collapse(Elastic.Clients.Elasticsearch.Core.Search.FieldCollapse? collapse) { @@ -130,7 +146,9 @@ public StandardRetrieverDescriptor Collapse(Action - /// Query to filter the documents that can match. + /// + /// Query to filter the documents that can match. + /// /// public StandardRetrieverDescriptor Filter(ICollection? filter) { @@ -169,7 +187,9 @@ public StandardRetrieverDescriptor Filter(params Action - /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// + /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// /// public StandardRetrieverDescriptor MinScore(float? minScore) { @@ -178,7 +198,9 @@ public StandardRetrieverDescriptor MinScore(float? minScore) } /// - /// Defines a query to retrieve a set of top documents. + /// + /// Defines a query to retrieve a set of top documents. + /// /// public StandardRetrieverDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -205,7 +227,9 @@ public StandardRetrieverDescriptor Query(Action - /// Defines a search after object parameter used for pagination. + /// + /// Defines a search after object parameter used for pagination. + /// /// public StandardRetrieverDescriptor SearchAfter(ICollection? searchAfter) { @@ -214,7 +238,9 @@ public StandardRetrieverDescriptor SearchAfter(ICollection - /// A sort object that that specifies the order of matching documents. + /// + /// A sort object that that specifies the order of matching documents. + /// /// public StandardRetrieverDescriptor Sort(ICollection? sort) { @@ -253,7 +279,9 @@ public StandardRetrieverDescriptor Sort(params Action - /// Maximum number of documents to collect for each shard. + /// + /// Maximum number of documents to collect for each shard. + /// /// public StandardRetrieverDescriptor TerminateAfter(int? terminateAfter) { @@ -403,7 +431,9 @@ public StandardRetrieverDescriptor() : base() private int? TerminateAfterValue { get; set; } /// - /// Collapses the top documents by a specified key into a single top document per key. + /// + /// Collapses the top documents by a specified key into a single top document per key. + /// /// public StandardRetrieverDescriptor Collapse(Elastic.Clients.Elasticsearch.Core.Search.FieldCollapse? collapse) { @@ -430,7 +460,9 @@ public StandardRetrieverDescriptor Collapse(Action - /// Query to filter the documents that can match. + /// + /// Query to filter the documents that can match. + /// /// public StandardRetrieverDescriptor Filter(ICollection? filter) { @@ -469,7 +501,9 @@ public StandardRetrieverDescriptor Filter(params Action - /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// + /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// /// public StandardRetrieverDescriptor MinScore(float? minScore) { @@ -478,7 +512,9 @@ public StandardRetrieverDescriptor MinScore(float? minScore) } /// - /// Defines a query to retrieve a set of top documents. + /// + /// Defines a query to retrieve a set of top documents. + /// /// public StandardRetrieverDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -505,7 +541,9 @@ public StandardRetrieverDescriptor Query(Action - /// Defines a search after object parameter used for pagination. + /// + /// Defines a search after object parameter used for pagination. + /// /// public StandardRetrieverDescriptor SearchAfter(ICollection? searchAfter) { @@ -514,7 +552,9 @@ public StandardRetrieverDescriptor SearchAfter(ICollection - /// A sort object that that specifies the order of matching documents. + /// + /// A sort object that that specifies the order of matching documents. + /// /// public StandardRetrieverDescriptor Sort(ICollection? sort) { @@ -553,7 +593,9 @@ public StandardRetrieverDescriptor Sort(params Action - /// Maximum number of documents to collect for each shard. + /// + /// Maximum number of documents to collect for each shard. + /// /// public StandardRetrieverDescriptor TerminateAfter(int? terminateAfter) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/StoreStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/StoreStats.g.cs index ab0f70ca2a5..34ee7e0f00d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/StoreStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/StoreStats.g.cs @@ -30,37 +30,51 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class StoreStats { /// - /// A prediction of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities. + /// + /// A prediction of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities. + /// /// [JsonInclude, JsonPropertyName("reserved")] public Elastic.Clients.Elasticsearch.ByteSize? Reserved { get; init; } /// - /// A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities. + /// + /// A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities. + /// /// [JsonInclude, JsonPropertyName("reserved_in_bytes")] public long ReservedInBytes { get; init; } /// - /// Total size of all shards assigned to selected nodes. + /// + /// Total size of all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("size")] public Elastic.Clients.Elasticsearch.ByteSize? Size { get; init; } /// - /// Total size, in bytes, of all shards assigned to selected nodes. + /// + /// Total size, in bytes, of all shards assigned to selected nodes. + /// /// [JsonInclude, JsonPropertyName("size_in_bytes")] public long SizeInBytes { get; init; } /// - /// Total data set size of all shards assigned to selected nodes.
This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices. + /// + /// Total data set size of all shards assigned to selected nodes. + /// This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices. + /// /// [JsonInclude, JsonPropertyName("total_data_set_size")] public Elastic.Clients.Elasticsearch.ByteSize? TotalDataSetSize { get; init; } /// - /// Total data set size, in bytes, of all shards assigned to selected nodes.
This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices. + /// + /// Total data set size, in bytes, of all shards assigned to selected nodes. + /// This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices. + /// /// [JsonInclude, JsonPropertyName("total_data_set_size_in_bytes")] public long? TotalDataSetSizeInBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/StoredScript.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/StoredScript.g.cs index 98887ee43c8..d7551125245 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/StoredScript.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/StoredScript.g.cs @@ -30,7 +30,9 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class StoredScript { /// - /// Specifies the language the script is written in. + /// + /// Specifies the language the script is written in. + /// /// [JsonInclude, JsonPropertyName("lang")] public Elastic.Clients.Elasticsearch.ScriptLanguage Language { get; set; } @@ -38,7 +40,9 @@ public sealed partial class StoredScript public IDictionary? Options { get; set; } /// - /// The script source. + /// + /// The script source. + /// /// [JsonInclude, JsonPropertyName("source")] public string Source { get; set; } @@ -57,7 +61,9 @@ public StoredScriptDescriptor() : base() private string SourceValue { get; set; } /// - /// Specifies the language the script is written in. + /// + /// Specifies the language the script is written in. + /// /// public StoredScriptDescriptor Language(Elastic.Clients.Elasticsearch.ScriptLanguage language) { @@ -72,7 +78,9 @@ public StoredScriptDescriptor Options(Func, Flu } /// - /// The script source. + /// + /// The script source. + /// /// public StoredScriptDescriptor Source(string source) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Synonyms/SynonymRule.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Synonyms/SynonymRule.g.cs index 3f0990a34f4..91bfd2db8bd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Synonyms/SynonymRule.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Synonyms/SynonymRule.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Synonyms; public sealed partial class SynonymRule { /// - /// Synonym Rule identifier + /// + /// Synonym Rule identifier + /// /// [JsonInclude, JsonPropertyName("id")] public Elastic.Clients.Elasticsearch.Id? Id { get; set; } /// - /// Synonyms, in Solr format, that conform the synonym rule. See https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#_solr_synonyms_2 + /// + /// Synonyms, in Solr format, that conform the synonym rule. See https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#_solr_synonyms_2 + /// /// [JsonInclude, JsonPropertyName("synonyms")] public string Synonyms { get; set; } @@ -54,7 +58,9 @@ public SynonymRuleDescriptor() : base() private string SynonymsValue { get; set; } /// - /// Synonym Rule identifier + /// + /// Synonym Rule identifier + /// /// public SynonymRuleDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) { @@ -63,7 +69,9 @@ public SynonymRuleDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) } /// - /// Synonyms, in Solr format, that conform the synonym rule. See https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#_solr_synonyms_2 + /// + /// Synonyms, in Solr format, that conform the synonym rule. See https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#_solr_synonyms_2 + /// /// public SynonymRuleDescriptor Synonyms(string synonyms) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Synonyms/SynonymRuleRead.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Synonyms/SynonymRuleRead.g.cs index d691c217aa3..2161b1d30d7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Synonyms/SynonymRuleRead.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Synonyms/SynonymRuleRead.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Synonyms; public sealed partial class SynonymRuleRead { /// - /// Synonym Rule identifier + /// + /// Synonym Rule identifier + /// /// [JsonInclude, JsonPropertyName("id")] public string Id { get; init; } /// - /// Synonyms, in Solr format, that conform the synonym rule. See https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#_solr_synonyms_2 + /// + /// Synonyms, in Solr format, that conform the synonym rule. See https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#_solr_synonyms_2 + /// /// [JsonInclude, JsonPropertyName("synonyms")] public string Synonyms { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Synonyms/SynonymsSetItem.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Synonyms/SynonymsSetItem.g.cs index e6e3aef8af4..520b247c814 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Synonyms/SynonymsSetItem.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Synonyms/SynonymsSetItem.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Synonyms; public sealed partial class SynonymsSetItem { /// - /// Number of synonym rules that the synonym set contains + /// + /// Number of synonym rules that the synonym set contains + /// /// [JsonInclude, JsonPropertyName("count")] public int Count { get; init; } /// - /// Synonyms set identifier + /// + /// Synonyms set identifier + /// /// [JsonInclude, JsonPropertyName("synonyms_set")] public string SynonymsSet { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Tasks/ParentTaskInfo.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Tasks/ParentTaskInfo.g.cs index 3af81683aee..f5b0374f997 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Tasks/ParentTaskInfo.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Tasks/ParentTaskInfo.g.cs @@ -55,7 +55,9 @@ public sealed partial class ParentTaskInfo public long StartTimeInMillis { get; init; } /// - /// Task status information can vary wildly from task to task. + /// + /// Task status information can vary wildly from task to task. + /// /// [JsonInclude, JsonPropertyName("status")] public object? Status { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Tasks/TaskInfo.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Tasks/TaskInfo.g.cs index 74ad3b1b281..d8fb4dc6ccd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Tasks/TaskInfo.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Tasks/TaskInfo.g.cs @@ -53,7 +53,9 @@ public sealed partial class TaskInfo public long StartTimeInMillis { get; init; } /// - /// Task status information can vary wildly from task to task. + /// + /// Task status information can vary wildly from task to task. + /// /// [JsonInclude, JsonPropertyName("status")] public object? Status { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/Destination.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/Destination.g.cs index f5cfe612803..704be64863c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/Destination.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/Destination.g.cs @@ -30,13 +30,19 @@ namespace Elastic.Clients.Elasticsearch.TransformManagement; public sealed partial class Destination { /// - /// The destination index for the transform. The mappings of the destination index are deduced based on the source
fields when possible. If alternate mappings are required, use the create index API prior to starting the
transform. + /// + /// The destination index for the transform. The mappings of the destination index are deduced based on the source + /// fields when possible. If alternate mappings are required, use the create index API prior to starting the + /// transform. + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.IndexName? Index { get; set; } /// - /// The unique identifier for an ingest pipeline. + /// + /// The unique identifier for an ingest pipeline. + /// /// [JsonInclude, JsonPropertyName("pipeline")] public string? Pipeline { get; set; } @@ -54,7 +60,11 @@ public DestinationDescriptor() : base() private string? PipelineValue { get; set; } /// - /// The destination index for the transform. The mappings of the destination index are deduced based on the source
fields when possible. If alternate mappings are required, use the create index API prior to starting the
transform. + /// + /// The destination index for the transform. The mappings of the destination index are deduced based on the source + /// fields when possible. If alternate mappings are required, use the create index API prior to starting the + /// transform. + /// /// public DestinationDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? index) { @@ -63,7 +73,9 @@ public DestinationDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? inde } /// - /// The unique identifier for an ingest pipeline. + /// + /// The unique identifier for an ingest pipeline. + /// /// public DestinationDescriptor Pipeline(string? pipeline) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/Latest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/Latest.g.cs index ff72c818747..825a95aa3d9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/Latest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/Latest.g.cs @@ -30,13 +30,17 @@ namespace Elastic.Clients.Elasticsearch.TransformManagement; public sealed partial class Latest { /// - /// Specifies the date field that is used to identify the latest documents. + /// + /// Specifies the date field that is used to identify the latest documents. + /// /// [JsonInclude, JsonPropertyName("sort")] public Elastic.Clients.Elasticsearch.Field Sort { get; set; } /// - /// Specifies an array of one or more fields that are used to group the data. + /// + /// Specifies an array of one or more fields that are used to group the data. + /// /// [JsonInclude, JsonPropertyName("unique_key")] [JsonConverter(typeof(FieldsConverter))] @@ -55,7 +59,9 @@ public LatestDescriptor() : base() private Elastic.Clients.Elasticsearch.Fields UniqueKeyValue { get; set; } /// - /// Specifies the date field that is used to identify the latest documents. + /// + /// Specifies the date field that is used to identify the latest documents. + /// /// public LatestDescriptor Sort(Elastic.Clients.Elasticsearch.Field sort) { @@ -64,7 +70,9 @@ public LatestDescriptor Sort(Elastic.Clients.Elasticsearch.Field sort } /// - /// Specifies the date field that is used to identify the latest documents. + /// + /// Specifies the date field that is used to identify the latest documents. + /// /// public LatestDescriptor Sort(Expression> sort) { @@ -73,7 +81,9 @@ public LatestDescriptor Sort(Expression - /// Specifies the date field that is used to identify the latest documents. + /// + /// Specifies the date field that is used to identify the latest documents. + /// /// public LatestDescriptor Sort(Expression> sort) { @@ -82,7 +92,9 @@ public LatestDescriptor Sort(Expression> sort } /// - /// Specifies an array of one or more fields that are used to group the data. + /// + /// Specifies an array of one or more fields that are used to group the data. + /// /// public LatestDescriptor UniqueKey(Elastic.Clients.Elasticsearch.Fields uniqueKey) { @@ -113,7 +125,9 @@ public LatestDescriptor() : base() private Elastic.Clients.Elasticsearch.Fields UniqueKeyValue { get; set; } /// - /// Specifies the date field that is used to identify the latest documents. + /// + /// Specifies the date field that is used to identify the latest documents. + /// /// public LatestDescriptor Sort(Elastic.Clients.Elasticsearch.Field sort) { @@ -122,7 +136,9 @@ public LatestDescriptor Sort(Elastic.Clients.Elasticsearch.Field sort) } /// - /// Specifies the date field that is used to identify the latest documents. + /// + /// Specifies the date field that is used to identify the latest documents. + /// /// public LatestDescriptor Sort(Expression> sort) { @@ -131,7 +147,9 @@ public LatestDescriptor Sort(Expression - /// Specifies the date field that is used to identify the latest documents. + /// + /// Specifies the date field that is used to identify the latest documents. + /// /// public LatestDescriptor Sort(Expression> sort) { @@ -140,7 +158,9 @@ public LatestDescriptor Sort(Expression> sort } /// - /// Specifies an array of one or more fields that are used to group the data. + /// + /// Specifies an array of one or more fields that are used to group the data. + /// /// public LatestDescriptor UniqueKey(Elastic.Clients.Elasticsearch.Fields uniqueKey) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/Pivot.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/Pivot.g.cs index 9e1c6a6251f..446ea9688d1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/Pivot.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/Pivot.g.cs @@ -79,12 +79,20 @@ public override void Write(Utf8JsonWriter writer, Pivot value, JsonSerializerOpt public sealed partial class Pivot { /// - /// Defines how to aggregate the grouped data. The following aggregations are currently supported: average, bucket
script, bucket selector, cardinality, filter, geo bounds, geo centroid, geo line, max, median absolute deviation,
min, missing, percentiles, rare terms, scripted metric, stats, sum, terms, top metrics, value count, weighted
average. + /// + /// Defines how to aggregate the grouped data. The following aggregations are currently supported: average, bucket + /// script, bucket selector, cardinality, filter, geo bounds, geo centroid, geo line, max, median absolute deviation, + /// min, missing, percentiles, rare terms, scripted metric, stats, sum, terms, top metrics, value count, weighted + /// average. + /// /// public IDictionary? Aggregations { get; set; } /// - /// Defines how to group the data. More than one grouping can be defined per pivot. The following groupings are
currently supported: date histogram, geotile grid, histogram, terms. + /// + /// Defines how to group the data. More than one grouping can be defined per pivot. The following groupings are + /// currently supported: date histogram, geotile grid, histogram, terms. + /// /// public IDictionary? GroupBy { get; set; } } @@ -101,7 +109,12 @@ public PivotDescriptor() : base() private IDictionary> GroupByValue { get; set; } /// - /// Defines how to aggregate the grouped data. The following aggregations are currently supported: average, bucket
script, bucket selector, cardinality, filter, geo bounds, geo centroid, geo line, max, median absolute deviation,
min, missing, percentiles, rare terms, scripted metric, stats, sum, terms, top metrics, value count, weighted
average. + /// + /// Defines how to aggregate the grouped data. The following aggregations are currently supported: average, bucket + /// script, bucket selector, cardinality, filter, geo bounds, geo centroid, geo line, max, median absolute deviation, + /// min, missing, percentiles, rare terms, scripted metric, stats, sum, terms, top metrics, value count, weighted + /// average. + /// /// public PivotDescriptor Aggregations(Func>, FluentDescriptorDictionary>> selector) { @@ -110,7 +123,10 @@ public PivotDescriptor Aggregations(Func - /// Defines how to group the data. More than one grouping can be defined per pivot. The following groupings are
currently supported: date histogram, geotile grid, histogram, terms. + /// + /// Defines how to group the data. More than one grouping can be defined per pivot. The following groupings are + /// currently supported: date histogram, geotile grid, histogram, terms. + /// /// public PivotDescriptor GroupBy(Func>, FluentDescriptorDictionary>> selector) { @@ -149,7 +165,12 @@ public PivotDescriptor() : base() private IDictionary GroupByValue { get; set; } /// - /// Defines how to aggregate the grouped data. The following aggregations are currently supported: average, bucket
script, bucket selector, cardinality, filter, geo bounds, geo centroid, geo line, max, median absolute deviation,
min, missing, percentiles, rare terms, scripted metric, stats, sum, terms, top metrics, value count, weighted
average. + /// + /// Defines how to aggregate the grouped data. The following aggregations are currently supported: average, bucket + /// script, bucket selector, cardinality, filter, geo bounds, geo centroid, geo line, max, median absolute deviation, + /// min, missing, percentiles, rare terms, scripted metric, stats, sum, terms, top metrics, value count, weighted + /// average. + /// /// public PivotDescriptor Aggregations(Func, FluentDescriptorDictionary> selector) { @@ -158,7 +179,10 @@ public PivotDescriptor Aggregations(Func - /// Defines how to group the data. More than one grouping can be defined per pivot. The following groupings are
currently supported: date histogram, geotile grid, histogram, terms. + /// + /// Defines how to group the data. More than one grouping can be defined per pivot. The following groupings are + /// currently supported: date histogram, geotile grid, histogram, terms. + /// /// public PivotDescriptor GroupBy(Func, FluentDescriptorDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/Settings.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/Settings.g.cs index db3d066654e..5933b35214d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/Settings.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/Settings.g.cs @@ -28,49 +28,74 @@ namespace Elastic.Clients.Elasticsearch.TransformManagement; /// -/// The source of the data for the transform. +/// +/// The source of the data for the transform. +/// /// public sealed partial class Settings { /// - /// Specifies whether the transform checkpoint ranges should be optimized for performance. Such optimization can align
checkpoint ranges with the date histogram interval when date histogram is specified as a group source in the
transform config. As a result, less document updates in the destination index will be performed thus improving
overall performance. + /// + /// Specifies whether the transform checkpoint ranges should be optimized for performance. Such optimization can align + /// checkpoint ranges with the date histogram interval when date histogram is specified as a group source in the + /// transform config. As a result, less document updates in the destination index will be performed thus improving + /// overall performance. + /// /// [JsonInclude, JsonPropertyName("align_checkpoints")] public bool? AlignCheckpoints { get; set; } /// - /// Defines if dates in the ouput should be written as ISO formatted string or as millis since epoch. epoch_millis was
the default for transforms created before version 7.11. For compatible output set this value to `true`. + /// + /// Defines if dates in the ouput should be written as ISO formatted string or as millis since epoch. epoch_millis was + /// the default for transforms created before version 7.11. For compatible output set this value to true. + /// /// [JsonInclude, JsonPropertyName("dates_as_epoch_millis")] public bool? DatesAsEpochMillis { get; set; } /// - /// Specifies whether the transform should deduce the destination index mappings from the transform configuration. + /// + /// Specifies whether the transform should deduce the destination index mappings from the transform configuration. + /// /// [JsonInclude, JsonPropertyName("deduce_mappings")] public bool? DeduceMappings { get; set; } /// - /// Specifies a limit on the number of input documents per second. This setting throttles the transform by adding a
wait time between search requests. The default value is null, which disables throttling. + /// + /// Specifies a limit on the number of input documents per second. This setting throttles the transform by adding a + /// wait time between search requests. The default value is null, which disables throttling. + /// /// [JsonInclude, JsonPropertyName("docs_per_second")] public float? DocsPerSecond { get; set; } /// - /// Defines the initial page size to use for the composite aggregation for each checkpoint. If circuit breaker
exceptions occur, the page size is dynamically adjusted to a lower value. The minimum value is `10` and the
maximum is `65,536`. + /// + /// Defines the initial page size to use for the composite aggregation for each checkpoint. If circuit breaker + /// exceptions occur, the page size is dynamically adjusted to a lower value. The minimum value is 10 and the + /// maximum is 65,536. + /// /// [JsonInclude, JsonPropertyName("max_page_search_size")] public int? MaxPageSearchSize { get; set; } /// - /// If `true`, the transform runs in unattended mode. In unattended mode, the transform retries indefinitely in case
of an error which means the transform never fails. Setting the number of retries other than infinite fails in
validation. + /// + /// If true, the transform runs in unattended mode. In unattended mode, the transform retries indefinitely in case + /// of an error which means the transform never fails. Setting the number of retries other than infinite fails in + /// validation. + /// /// [JsonInclude, JsonPropertyName("unattended")] public bool? Unattended { get; set; } } /// -/// The source of the data for the transform. +/// +/// The source of the data for the transform. +/// /// public sealed partial class SettingsDescriptor : SerializableDescriptor { @@ -88,7 +113,12 @@ public SettingsDescriptor() : base() private bool? UnattendedValue { get; set; } /// - /// Specifies whether the transform checkpoint ranges should be optimized for performance. Such optimization can align
checkpoint ranges with the date histogram interval when date histogram is specified as a group source in the
transform config. As a result, less document updates in the destination index will be performed thus improving
overall performance. + /// + /// Specifies whether the transform checkpoint ranges should be optimized for performance. Such optimization can align + /// checkpoint ranges with the date histogram interval when date histogram is specified as a group source in the + /// transform config. As a result, less document updates in the destination index will be performed thus improving + /// overall performance. + /// /// public SettingsDescriptor AlignCheckpoints(bool? alignCheckpoints = true) { @@ -97,7 +127,10 @@ public SettingsDescriptor AlignCheckpoints(bool? alignCheckpoints = true) } /// - /// Defines if dates in the ouput should be written as ISO formatted string or as millis since epoch. epoch_millis was
the default for transforms created before version 7.11. For compatible output set this value to `true`. + /// + /// Defines if dates in the ouput should be written as ISO formatted string or as millis since epoch. epoch_millis was + /// the default for transforms created before version 7.11. For compatible output set this value to true. + /// /// public SettingsDescriptor DatesAsEpochMillis(bool? datesAsEpochMillis = true) { @@ -106,7 +139,9 @@ public SettingsDescriptor DatesAsEpochMillis(bool? datesAsEpochMillis = true) } /// - /// Specifies whether the transform should deduce the destination index mappings from the transform configuration. + /// + /// Specifies whether the transform should deduce the destination index mappings from the transform configuration. + /// /// public SettingsDescriptor DeduceMappings(bool? deduceMappings = true) { @@ -115,7 +150,10 @@ public SettingsDescriptor DeduceMappings(bool? deduceMappings = true) } /// - /// Specifies a limit on the number of input documents per second. This setting throttles the transform by adding a
wait time between search requests. The default value is null, which disables throttling. + /// + /// Specifies a limit on the number of input documents per second. This setting throttles the transform by adding a + /// wait time between search requests. The default value is null, which disables throttling. + /// /// public SettingsDescriptor DocsPerSecond(float? docsPerSecond) { @@ -124,7 +162,11 @@ public SettingsDescriptor DocsPerSecond(float? docsPerSecond) } /// - /// Defines the initial page size to use for the composite aggregation for each checkpoint. If circuit breaker
exceptions occur, the page size is dynamically adjusted to a lower value. The minimum value is `10` and the
maximum is `65,536`. + /// + /// Defines the initial page size to use for the composite aggregation for each checkpoint. If circuit breaker + /// exceptions occur, the page size is dynamically adjusted to a lower value. The minimum value is 10 and the + /// maximum is 65,536. + /// /// public SettingsDescriptor MaxPageSearchSize(int? maxPageSearchSize) { @@ -133,7 +175,11 @@ public SettingsDescriptor MaxPageSearchSize(int? maxPageSearchSize) } /// - /// If `true`, the transform runs in unattended mode. In unattended mode, the transform retries indefinitely in case
of an error which means the transform never fails. Setting the number of retries other than infinite fails in
validation. + /// + /// If true, the transform runs in unattended mode. In unattended mode, the transform retries indefinitely in case + /// of an error which means the transform never fails. Setting the number of retries other than infinite fails in + /// validation. + /// /// public SettingsDescriptor Unattended(bool? unattended = true) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/Source.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/Source.g.cs index beaa76ae71e..031a5d987af 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/Source.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/Source.g.cs @@ -30,19 +30,29 @@ namespace Elastic.Clients.Elasticsearch.TransformManagement; public sealed partial class Source { /// - /// The source indices for the transform. It can be a single index, an index pattern (for example, `"my-index-*""`), an
array of indices (for example, `["my-index-000001", "my-index-000002"]`), or an array of index patterns (for
example, `["my-index-*", "my-other-index-*"]`. For remote indices use the syntax `"remote_name:index_name"`. If
any indices are in remote clusters then the master node and at least one transform node must have the `remote_cluster_client` node role. + /// + /// The source indices for the transform. It can be a single index, an index pattern (for example, "my-index-*""), an + /// array of indices (for example, ["my-index-000001", "my-index-000002"]), or an array of index patterns (for + /// example, ["my-index-*", "my-other-index-*"]. For remote indices use the syntax "remote_name:index_name". If + /// any indices are in remote clusters then the master node and at least one transform node must have the remote_cluster_client node role. + /// /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.Indices Indices { get; set; } /// - /// A query clause that retrieves a subset of data from the source index. + /// + /// A query clause that retrieves a subset of data from the source index. + /// /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Query { get; set; } /// - /// Definitions of search-time runtime fields that can be used by the transform. For search runtime fields all data
nodes, including remote nodes, must be 7.12 or later. + /// + /// Definitions of search-time runtime fields that can be used by the transform. For search runtime fields all data + /// nodes, including remote nodes, must be 7.12 or later. + /// /// [JsonInclude, JsonPropertyName("runtime_mappings")] public IDictionary? RuntimeMappings { get; set; } @@ -63,7 +73,12 @@ public SourceDescriptor() : base() private IDictionary> RuntimeMappingsValue { get; set; } /// - /// The source indices for the transform. It can be a single index, an index pattern (for example, `"my-index-*""`), an
array of indices (for example, `["my-index-000001", "my-index-000002"]`), or an array of index patterns (for
example, `["my-index-*", "my-other-index-*"]`. For remote indices use the syntax `"remote_name:index_name"`. If
any indices are in remote clusters then the master node and at least one transform node must have the `remote_cluster_client` node role. + /// + /// The source indices for the transform. It can be a single index, an index pattern (for example, "my-index-*""), an + /// array of indices (for example, ["my-index-000001", "my-index-000002"]), or an array of index patterns (for + /// example, ["my-index-*", "my-other-index-*"]. For remote indices use the syntax "remote_name:index_name". If + /// any indices are in remote clusters then the master node and at least one transform node must have the remote_cluster_client node role. + /// /// public SourceDescriptor Indices(Elastic.Clients.Elasticsearch.Indices indices) { @@ -72,7 +87,9 @@ public SourceDescriptor Indices(Elastic.Clients.Elasticsearch.Indices } /// - /// A query clause that retrieves a subset of data from the source index. + /// + /// A query clause that retrieves a subset of data from the source index. + /// /// public SourceDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -99,7 +116,10 @@ public SourceDescriptor Query(Action - /// Definitions of search-time runtime fields that can be used by the transform. For search runtime fields all data
nodes, including remote nodes, must be 7.12 or later. + /// + /// Definitions of search-time runtime fields that can be used by the transform. For search runtime fields all data + /// nodes, including remote nodes, must be 7.12 or later. + /// /// public SourceDescriptor RuntimeMappings(Func>, FluentDescriptorDictionary>> selector) { @@ -153,7 +173,12 @@ public SourceDescriptor() : base() private IDictionary RuntimeMappingsValue { get; set; } /// - /// The source indices for the transform. It can be a single index, an index pattern (for example, `"my-index-*""`), an
array of indices (for example, `["my-index-000001", "my-index-000002"]`), or an array of index patterns (for
example, `["my-index-*", "my-other-index-*"]`. For remote indices use the syntax `"remote_name:index_name"`. If
any indices are in remote clusters then the master node and at least one transform node must have the `remote_cluster_client` node role. + /// + /// The source indices for the transform. It can be a single index, an index pattern (for example, "my-index-*""), an + /// array of indices (for example, ["my-index-000001", "my-index-000002"]), or an array of index patterns (for + /// example, ["my-index-*", "my-other-index-*"]. For remote indices use the syntax "remote_name:index_name". If + /// any indices are in remote clusters then the master node and at least one transform node must have the remote_cluster_client node role. + /// /// public SourceDescriptor Indices(Elastic.Clients.Elasticsearch.Indices indices) { @@ -162,7 +187,9 @@ public SourceDescriptor Indices(Elastic.Clients.Elasticsearch.Indices indices) } /// - /// A query clause that retrieves a subset of data from the source index. + /// + /// A query clause that retrieves a subset of data from the source index. + /// /// public SourceDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { @@ -189,7 +216,10 @@ public SourceDescriptor Query(Action - /// Definitions of search-time runtime fields that can be used by the transform. For search runtime fields all data
nodes, including remote nodes, must be 7.12 or later. + /// + /// Definitions of search-time runtime fields that can be used by the transform. For search runtime fields all data + /// nodes, including remote nodes, must be 7.12 or later. + /// /// public SourceDescriptor RuntimeMappings(Func, FluentDescriptorDictionary> selector) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/TimeRetentionPolicy.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/TimeRetentionPolicy.g.cs index bf35fe6c1bf..d2c1e7e3346 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/TimeRetentionPolicy.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/TimeRetentionPolicy.g.cs @@ -30,13 +30,18 @@ namespace Elastic.Clients.Elasticsearch.TransformManagement; public sealed partial class TimeRetentionPolicy { /// - /// The date field that is used to calculate the age of the document. + /// + /// The date field that is used to calculate the age of the document. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } /// - /// Specifies the maximum age of a document in the destination index. Documents that are older than the configured
value are removed from the destination index. + /// + /// Specifies the maximum age of a document in the destination index. Documents that are older than the configured + /// value are removed from the destination index. + /// /// [JsonInclude, JsonPropertyName("max_age")] public Elastic.Clients.Elasticsearch.Duration MaxAge { get; set; } @@ -56,7 +61,9 @@ public TimeRetentionPolicyDescriptor() : base() private Elastic.Clients.Elasticsearch.Duration MaxAgeValue { get; set; } /// - /// The date field that is used to calculate the age of the document. + /// + /// The date field that is used to calculate the age of the document. + /// /// public TimeRetentionPolicyDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -65,7 +72,9 @@ public TimeRetentionPolicyDescriptor Field(Elastic.Clients.Elasticsea } /// - /// The date field that is used to calculate the age of the document. + /// + /// The date field that is used to calculate the age of the document. + /// /// public TimeRetentionPolicyDescriptor Field(Expression> field) { @@ -74,7 +83,9 @@ public TimeRetentionPolicyDescriptor Field(Expression - /// The date field that is used to calculate the age of the document. + /// + /// The date field that is used to calculate the age of the document. + /// /// public TimeRetentionPolicyDescriptor Field(Expression> field) { @@ -83,7 +94,10 @@ public TimeRetentionPolicyDescriptor Field(Expression - /// Specifies the maximum age of a document in the destination index. Documents that are older than the configured
value are removed from the destination index. + /// + /// Specifies the maximum age of a document in the destination index. Documents that are older than the configured + /// value are removed from the destination index. + /// /// public TimeRetentionPolicyDescriptor MaxAge(Elastic.Clients.Elasticsearch.Duration maxAge) { @@ -114,7 +128,9 @@ public TimeRetentionPolicyDescriptor() : base() private Elastic.Clients.Elasticsearch.Duration MaxAgeValue { get; set; } /// - /// The date field that is used to calculate the age of the document. + /// + /// The date field that is used to calculate the age of the document. + /// /// public TimeRetentionPolicyDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -123,7 +139,9 @@ public TimeRetentionPolicyDescriptor Field(Elastic.Clients.Elasticsearch.Field f } /// - /// The date field that is used to calculate the age of the document. + /// + /// The date field that is used to calculate the age of the document. + /// /// public TimeRetentionPolicyDescriptor Field(Expression> field) { @@ -132,7 +150,9 @@ public TimeRetentionPolicyDescriptor Field(Expression - /// The date field that is used to calculate the age of the document. + /// + /// The date field that is used to calculate the age of the document. + /// /// public TimeRetentionPolicyDescriptor Field(Expression> field) { @@ -141,7 +161,10 @@ public TimeRetentionPolicyDescriptor Field(Expression - /// Specifies the maximum age of a document in the destination index. Documents that are older than the configured
value are removed from the destination index. + /// + /// Specifies the maximum age of a document in the destination index. Documents that are older than the configured + /// value are removed from the destination index. + /// /// public TimeRetentionPolicyDescriptor MaxAge(Elastic.Clients.Elasticsearch.Duration maxAge) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/TimeSync.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/TimeSync.g.cs index 7795e561dae..b768bac425c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/TimeSync.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/TimeSync.g.cs @@ -30,13 +30,19 @@ namespace Elastic.Clients.Elasticsearch.TransformManagement; public sealed partial class TimeSync { /// - /// The time delay between the current time and the latest input data time. + /// + /// The time delay between the current time and the latest input data time. + /// /// [JsonInclude, JsonPropertyName("delay")] public Elastic.Clients.Elasticsearch.Duration? Delay { get; set; } /// - /// The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field
that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it
accounts for data transmission delays. + /// + /// The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field + /// that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it + /// accounts for data transmission delays. + /// /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } @@ -56,7 +62,9 @@ public TimeSyncDescriptor() : base() private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } /// - /// The time delay between the current time and the latest input data time. + /// + /// The time delay between the current time and the latest input data time. + /// /// public TimeSyncDescriptor Delay(Elastic.Clients.Elasticsearch.Duration? delay) { @@ -65,7 +73,11 @@ public TimeSyncDescriptor Delay(Elastic.Clients.Elasticsearch.Duratio } /// - /// The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field
that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it
accounts for data transmission delays. + /// + /// The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field + /// that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it + /// accounts for data transmission delays. + /// /// public TimeSyncDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -74,7 +86,11 @@ public TimeSyncDescriptor Field(Elastic.Clients.Elasticsearch.Field f } /// - /// The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field
that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it
accounts for data transmission delays. + /// + /// The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field + /// that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it + /// accounts for data transmission delays. + /// /// public TimeSyncDescriptor Field(Expression> field) { @@ -83,7 +99,11 @@ public TimeSyncDescriptor Field(Expression - /// The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field
that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it
accounts for data transmission delays. + /// + /// The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field + /// that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it + /// accounts for data transmission delays. + /// /// public TimeSyncDescriptor Field(Expression> field) { @@ -118,7 +138,9 @@ public TimeSyncDescriptor() : base() private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } /// - /// The time delay between the current time and the latest input data time. + /// + /// The time delay between the current time and the latest input data time. + /// /// public TimeSyncDescriptor Delay(Elastic.Clients.Elasticsearch.Duration? delay) { @@ -127,7 +149,11 @@ public TimeSyncDescriptor Delay(Elastic.Clients.Elasticsearch.Duration? delay) } /// - /// The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field
that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it
accounts for data transmission delays. + /// + /// The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field + /// that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it + /// accounts for data transmission delays. + /// /// public TimeSyncDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -136,7 +162,11 @@ public TimeSyncDescriptor Field(Elastic.Clients.Elasticsearch.Field field) } /// - /// The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field
that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it
accounts for data transmission delays. + /// + /// The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field + /// that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it + /// accounts for data transmission delays. + /// /// public TimeSyncDescriptor Field(Expression> field) { @@ -145,7 +175,11 @@ public TimeSyncDescriptor Field(Expression - /// The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field
that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it
accounts for data transmission delays. + /// + /// The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field + /// that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it + /// accounts for data transmission delays. + /// /// public TimeSyncDescriptor Field(Expression> field) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/TransformSummary.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/TransformSummary.g.cs index 7acfca87ac9..264bced8522 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/TransformSummary.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/TransformManagement/TransformSummary.g.cs @@ -30,25 +30,33 @@ namespace Elastic.Clients.Elasticsearch.TransformManagement; public sealed partial class TransformSummary { /// - /// The security privileges that the transform uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the transform, this property is omitted. + /// + /// The security privileges that the transform uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the transform, this property is omitted. + /// /// [JsonInclude, JsonPropertyName("authorization")] public Elastic.Clients.Elasticsearch.MachineLearning.TransformAuthorization? Authorization { get; init; } /// - /// The time the transform was created. + /// + /// The time the transform was created. + /// /// [JsonInclude, JsonPropertyName("create_time")] public long? CreateTime { get; init; } /// - /// Free text description of the transform. + /// + /// Free text description of the transform. + /// /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; init; } /// - /// The destination for the transform. + /// + /// The destination for the transform. + /// /// [JsonInclude, JsonPropertyName("dest")] public Elastic.Clients.Elasticsearch.Core.Reindex.Destination Dest { get; init; } @@ -62,7 +70,9 @@ public sealed partial class TransformSummary public IReadOnlyDictionary? Meta { get; init; } /// - /// The pivot method transforms the data by aggregating and grouping it. + /// + /// The pivot method transforms the data by aggregating and grouping it. + /// /// [JsonInclude, JsonPropertyName("pivot")] public Elastic.Clients.Elasticsearch.TransformManagement.Pivot? Pivot { get; init; } @@ -70,25 +80,33 @@ public sealed partial class TransformSummary public Elastic.Clients.Elasticsearch.TransformManagement.RetentionPolicy? RetentionPolicy { get; init; } /// - /// Defines optional transform settings. + /// + /// Defines optional transform settings. + /// /// [JsonInclude, JsonPropertyName("settings")] public Elastic.Clients.Elasticsearch.TransformManagement.Settings? Settings { get; init; } /// - /// The source of the data for the transform. + /// + /// The source of the data for the transform. + /// /// [JsonInclude, JsonPropertyName("source")] public Elastic.Clients.Elasticsearch.TransformManagement.Source Source { get; init; } /// - /// Defines the properties transforms require to run continuously. + /// + /// Defines the properties transforms require to run continuously. + /// /// [JsonInclude, JsonPropertyName("sync")] public Elastic.Clients.Elasticsearch.TransformManagement.Sync? Sync { get; init; } /// - /// The version of Elasticsearch that existed on the node when the transform was created. + /// + /// The version of Elasticsearch that existed on the node when the transform was created. + /// /// [JsonInclude, JsonPropertyName("version")] public string? Version { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Xpack/MachineLearning.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Xpack/MachineLearning.g.cs index 0717410db5d..7dda0c6f6c4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Xpack/MachineLearning.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Xpack/MachineLearning.g.cs @@ -41,7 +41,9 @@ public sealed partial class MachineLearning public Elastic.Clients.Elasticsearch.Xpack.MlInference Inference { get; init; } /// - /// Job usage statistics. The `_all` entry is always present and gathers statistics for all jobs. + /// + /// Job usage statistics. The _all entry is always present and gathers statistics for all jobs. + /// /// [JsonInclude, JsonPropertyName("jobs")] public IReadOnlyDictionary Jobs { get; init; }